Class RestDataSource<EntityType>

Type Parameters

EntityType extends BaseEntity = DefaultEntity

Hierarchy

AbstractDataSource<EntityType>
- RestDataSource

Index

Constructors

constructor

new RestDataSource<EntityType>(uri, id?): RestDataSource<EntityType>
Constructor
Type Parameters
- EntityType extends BaseEntity = DefaultEntity
Parameters
- uri: string
  
  The base URI of the REST API. for example https://groupoffice.com/api
- Optional id: string
  
  The Data source ID. Will be appended to the base uri above. for Example if the ID is "users" the uri will be: "https://groupoffice.com/api/users"
Returns RestDataSource<EntityType>
Overrides AbstractDataSource.constructor
- Defined in data/RestDataSource.ts:24

Properties

commitBaseParams

commitBaseParams: {} = {}

Extra parameters to send to the Foo/set

Type declaration

`Protected` creates

creates: Record<string, SaveData<EntityType>> = {}

`Protected` data

data: Record<string, EntityType> = {}

`Protected` destroys

destroys: Record<string, DestroyData> = {}

`Protected` getIds

getIds: Record<string, GetData> = {}

`Readonly` id

id: string

persist

persist: boolean = true

Store data in the browser storage so it will persist across sessions

setParams

setParams: {
[key: string]: any;
} = {}

Extra /set parameters that will reset after commit

Type declaration

[key: string]: any

`Protected` updates

updates: Record<string, SaveData<EntityType>> = {}

`Readonly` uri

uri: string

The base URI of the REST API. for example https://groupoffice.com/api

Accessors

`Private` browserStore

get browserStore(): BrowserStore
Private
Get the browser storage object to save state to the browser

Returns BrowserStore
Inherited from AbstractDataSource.browserStore
- Defined in data/AbstractDataSource.ts:289

Methods

`Protected` add

add(data): Promise<EntityType>
Parameters
- data: EntityType
Returns Promise<EntityType>
Inherited from AbstractDataSource.add
- Defined in data/AbstractDataSource.ts:362

`Private` checkState

checkState<T>(serverState, retVal): Promise<T>
Private
Check's if we are up-to-date with the server and fetches updates if needed.

If no state is returned by the data source this function will ignore states and the data source should then always refresh data.
Type Parameters
- T
Parameters
- serverState: undefined | string
- retVal: T
Returns Promise<T>
Inherited from AbstractDataSource.checkState
- Defined in data/AbstractDataSource.ts:845

clearCache

clearCache(): Promise<null | void>
Returns Promise<null | void>
Inherited from AbstractDataSource.clearCache
- Defined in data/AbstractDataSource.ts:280

confirmDestroy

confirmDestroy(ids): Promise<false | unknown[]>

Ask for confirmation and delete entities by ID

Parameters

ids: string[]

The ID's to delete

Returns Promise<false | unknown[]>

Example

const tbl = this.projectTable!,
    ids = tbl.rowSelection!.selected.map(index => tbl.store.get(index)!.id);

const result = await jmapds("Project3")
    .confirmDestroy(ids);

if(result != false) {
    btn.parent!.hide();
}

create

create(data, createId?): Promise<EntityType>
Create entity

Multiple calls will be joined together in a single call on the next event loop
Parameters
- data: Partial<EntityType>
- Optional createId: string
  
  The create ID to use when committing this entity to the server
Returns Promise<EntityType>
Inherited from AbstractDataSource.create
- Defined in data/AbstractDataSource.ts:499

destroy

destroy(id): Promise<unknown>
Destroy an entity

Multiple calls will be joined together in a single call on the next event loop
Parameters
- id: string
Returns Promise<unknown>
Inherited from AbstractDataSource.destroy
- Defined in data/AbstractDataSource.ts:566

`Protected` doGet

doGet(): Promise<void>
Protected
Does the actual getting of entities. First checks if present in this onbject, otherwise it will be requested from the remote source.

Returns Promise<void>
Inherited from AbstractDataSource.doGet
- Defined in data/AbstractDataSource.ts:427

doRequest

doRequest(path?, options?): Promise<any>
Parameters
- path: string = ""
- options: RequestInit = {}
Returns Promise<any>
- Defined in data/RestDataSource.ts:44

fire

fire<K>(eventName, ...args): boolean
Fire an event

When a listener returns false this function will return false too.
Type Parameters
- K extends "change"
Parameters
- eventName: K
- Rest ...args: Parameters<DataSourceEventMap<RestDataSource<EntityType>>[K]>
Returns boolean
Inherited from AbstractDataSource.fire
- Defined in data/AbstractDataSource.ts:196

get

get(ids?): Promise<GetResponse<EntityType>>
Get entities from the store

It will return a list of entities ordered by the requested ID's
Parameters
- Optional ids: string[]
Returns Promise<GetResponse<EntityType>>
Inherited from AbstractDataSource.get
- Defined in data/AbstractDataSource.ts:323

`Protected` getState

getState(): Promise<undefined | string>
Protected
Get the local server state ID of the store

Returns Promise<undefined | string>
Inherited from AbstractDataSource.getState
- Defined in data/AbstractDataSource.ts:256

`Protected` internalCommit

internalCommit(params): Promise<CommitResponse<EntityType>>
Implements commit (save and destroy) to the remote source
Parameters
- params: SetRequest<EntityType>
Returns Promise<CommitResponse<EntityType>>
Overrides AbstractDataSource.internalCommit
- Defined in data/RestDataSource.ts:63

`Protected` internalGet

internalGet(ids): Promise<GetResponse<EntityType>>
Implements getting entities from a remote source
Parameters
- ids: string[]
Returns Promise<GetResponse<EntityType>>
Overrides AbstractDataSource.internalGet
- Defined in data/RestDataSource.ts:142

`Protected` internalQuery

internalQuery(params): Promise<QueryResponse>
Handle the query to the remote
Parameters
- params: QueryParams
Returns Promise<QueryResponse>
Overrides AbstractDataSource.internalQuery
- Defined in data/RestDataSource.ts:166

`Protected` internalRemoteChanges

internalRemoteChanges(state): Promise<Changes>
Protected
No sync implemented for REST. States are ignored and data must always be refreshed.
Parameters
- state: undefined | string
Returns Promise<Changes>
Overrides AbstractDataSource.internalRemoteChanges
- Defined in data/RestDataSource.ts:189

on

on<K>(eventName, listener, options?): DataSourceEventMap<RestDataSource<EntityType>>[K]
Add a listener
Type Parameters
- K extends "change"
Parameters
- eventName: K
- listener: DataSourceEventMap<RestDataSource<EntityType>>[K]
- Optional options: ObservableListenerOpts
Returns DataSourceEventMap<RestDataSource<EntityType>>[K]
Inherited from AbstractDataSource.on
- Defined in data/AbstractDataSource.ts:194

`Protected` onFirstListenerAdded

onFirstListenerAdded(eventName): void
Protected
Override this function to lazily initialize events
Parameters
- eventName: string
Returns void
Inherited from AbstractDataSource.onFirstListenerAdded
- Defined in component/Observable.ts:133

query

query(params?): Promise<QueryResponse>
Query the server for a list of entity ID's

It takes filters and sort parameters.
Parameters
- params: QueryParams = {}
Returns Promise<QueryResponse>

Link
https://jmap.io/spec-core.html#query
Inherited from AbstractDataSource.query
- Defined in data/AbstractDataSource.ts:830

read

read(id, path?, options?): Promise<any>
Parameters
- id: number | number[]
- path: string = ""
- options: RequestInit = {}
Returns Promise<any>
- Defined in data/RestDataSource.ts:33

`Protected` relayEvent

relayEvent(comp, type): void
Parameters
- comp: Observable
- type: any
Returns void
Inherited from AbstractDataSource.relayEvent
- Defined in component/Observable.ts:199

`Protected` remove

remove(id): Promise<string>
Parameters
- id: string
Returns Promise<string>
Inherited from AbstractDataSource.remove
- Defined in data/AbstractDataSource.ts:373

`Private` request

request(path?, options?): Promise<any>
Parameters
- path: string = ""
- options: RequestInit = {}
Returns Promise<any>
- Defined in data/RestDataSource.ts:48

reset

reset(): Promise<undefined | boolean>
Reset the data source.

Clears all data and will resync

Returns Promise<undefined | boolean>
Inherited from AbstractDataSource.reset
- Defined in data/AbstractDataSource.ts:525

`Protected` setState

setState(state): Promise<undefined | boolean>
Protected
Set's the local server state ID

Setting it to undefined will reset the store.
Parameters
- state: undefined | string
Returns Promise<undefined | boolean>
Inherited from AbstractDataSource.setState
- Defined in data/AbstractDataSource.ts:272

single

single(id): Promise<undefined | EntityType>
Get a single entity.

Multiple calls will be buffered and returned together on the next event loop. This way multiple calls can be joined together in a single HTTP request to the server.
Parameters
- id: string
Returns Promise<undefined | EntityType>
Inherited from AbstractDataSource.single
- Defined in data/AbstractDataSource.ts:393

un

un<K>(eventName, listener): boolean
Remove listener
Type Parameters
- K extends "change"
Parameters
- eventName: K
- listener: RouterEventMap<RestDataSource<EntityType>>[K]
Returns boolean
Inherited from AbstractDataSource.un
- Defined in data/AbstractDataSource.ts:195

update

update(id, data): Promise<EntityType>
Update an entity

Multiple calls will be joined together in a single call on the next event loop
Parameters
- id: string
- data: Partial<EntityType>
Returns Promise<EntityType>
Inherited from AbstractDataSource.update
- Defined in data/AbstractDataSource.ts:537

updateFromServer

updateFromServer(): Promise<void>
Fetch updates from remote

Returns Promise<void>
Inherited from AbstractDataSource.updateFromServer
- Defined in data/AbstractDataSource.ts:632

Class RestDataSource<EntityType>

Type Parameters

EntityType extends BaseEntity = DefaultEntity

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

EntityType extends BaseEntity = DefaultEntity

Parameters

uri: string

Optional id: string

Returns RestDataSource<EntityType>

Properties

commitBaseParams

Type declaration

Protected creates

Protected data

Protected destroys

Protected getIds

Readonly id

persist

setParams

Type declaration

[key: string]: any

Protected updates

Readonly uri

Accessors

Private browserStore

Returns BrowserStore

Methods

Protected add

Parameters

data: EntityType

Returns Promise<EntityType>

Private checkState

Type Parameters

T

Parameters

serverState: undefined | string

retVal: T

Returns Promise<T>

clearCache

Returns Promise<null | void>

confirmDestroy

Parameters

ids: string[]

Returns Promise<false | unknown[]>

Example

create

Parameters

data: Partial<EntityType>

Optional createId: string

Returns Promise<EntityType>

destroy

Parameters

id: string

Returns Promise<unknown>

Protected doGet

Returns Promise<void>

doRequest

Parameters

path: string = ""

options: RequestInit = {}

Returns Promise<any>

fire

Type Parameters

K extends "change"

Parameters

eventName: K

Rest ...args: Parameters<DataSourceEventMap<RestDataSource<EntityType>>[K]>

Returns boolean

get

Parameters

Optional ids: string[]

Returns Promise<GetResponse<EntityType>>

`Optional` id: string

`Protected` creates

`Protected` data

`Protected` destroys

`Protected` getIds

`Readonly` id

`Protected` updates

`Readonly` uri

`Private` browserStore

`Protected` add

`Private` checkState

`Optional` createId: string

`Protected` doGet

`Rest` ...args: Parameters<DataSourceEventMap<RestDataSource<EntityType>>[K]>

`Optional` ids: string[]

`Protected` getState

`Protected` internalCommit

`Protected` internalGet

`Protected` internalQuery

`Protected` internalRemoteChanges

`Optional` options: ObservableListenerOpts

`Protected` onFirstListenerAdded

`Protected` relayEvent

`Protected` remove

`Private` request

`Protected` setState