Class BaseRestStore<ItemType, IDType>

Base Store implementation for simple rest services. Provides get and query methods.

Type Parameters

ItemType extends IndexableThing
IDType extends string | number

Hierarchy

BaseRestStore
- BaseWriteableRestStore

Implements

AsyncStore<ItemType, IDType>

Constructors

constructor

new BaseRestStore<ItemType, IDType>(options?, fetch?): BaseRestStore<ItemType, IDType>
Create the store.
Type Parameters
- ItemType extends Readonly<Record<string, any>>
- IDType extends string | number
Parameters
- options: Partial<Pick<BaseRestStore<ItemType, IDType>, keyof BaseRestStore<ItemType, IDType>>> = {}
  allows overwrite of any property
- fetch: ((url, options) => Promise<any>) = apprt_request
  the fetch method to use. Provided to customize in the constructor to make tests easier.
  - - (url, options): Promise<any>
    - Parameters
      url: string
      options: Record<string, any>
      Returns Promise<any>
Returns BaseRestStore<ItemType, IDType>
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:134

Properties

accepts

accepts: string = "application/javascript, application/json"

Defines the Accept header to use on HTTP requests

callbackParam

callbackParam: string = "callback"

The jsonp request parameter

filterParam

filterParam: string = "filter"

The filter param transporting the query.

headers

headers: {} = {}

Additional headers to pass in all requests to the server. These can be overridden by passing additional headers to calls to the store.

Type declaration

id

id: string = ""

The id of this store.

idProperty

idProperty: string = "id"

Indicates the property to use as the identity property. The values of this property should be unique.

itemProperty

itemProperty: string = "items"

Identifies the item array in query responses

jsonp

jsonp: boolean = false

Shall jsonp used for get and query

metadata

metadata: undefined | Partial<Metadata> = undefined

Configuration option for getMetadata method.

rangeParam

rangeParam: string = "range"

Range parameter transporting item range definitions.

sortParam

sortParam: string = "sort"

The query parameter to used for holding sort information. If this is omitted, than the sort information is included in a functional query token to avoid colliding with the set of name/value pairs.

supportsPostSwitching

supportsPostSwitching: boolean = true

Flag which indicates that an switching to POST is allowed when GET requests are to long. This is true by default for backwards compatibility.

target

target: string = ""

The target base URL to use for all requests to the server. This string will be prepended to the id to generate the URL (relative or absolute) for requests sent to the server

totalProperty

totalProperty: string = "total"

Identifies the total property in query responses

`Protected` _metadata

_metadata: undefined | Partial<Metadata> = undefined

Property for sub classes which provide static pre-configured metadata template.

Methods

get

get(id, options?): Promise<ItemType>
Retrieves an item from this store.
Parameters
- id: IDType
  the id.
- options: RetrievalOptions & AbortOptions & Readonly<Record<string, any>> & RequestOptions = {}
  customization options.
Returns Promise<ItemType>
an item.
Implementation of AsyncStore.get
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:165

getIdentity

getIdentity(item): undefined | IDType
Gets identity of given item.
Parameters
- item: Partial<ItemType>
  an item of this store.
Returns undefined | IDType
id or undefined if no id is found.
Implementation of AsyncStore.getIdentity
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:147

getMetadata

getMetadata(): Promise<Metadata>
Gets metadata of the store.

Returns Promise<Metadata>
metadata.
Implementation of AsyncStore.getMetadata
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:155

query

query(query?, options?): AsyncQueryResult<ItemType>
Queries the store for objects.
Parameters
- Optional query: ComplexQueryExpression
- options: QueryOptions = {}
Returns AsyncQueryResult<ItemType>
Implementation of AsyncStore.query
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:182

`Protected` _appendQueryToRequest

_appendQueryToRequest(requestParameters, query, options): void
Hook for subclasses to convert ComplexQueryExpression into request parameters.
Parameters
- requestParameters: Record<string, any>
  prepared request parameters
- query: undefined | ComplexQueryExpression
  the complex query
- options: QueryOptions
  the query options
Returns void
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:219

`Protected` _appendRangeToRequest

_appendRangeToRequest(requestParameters, options): void
Converts the options.start and options.count values to request parameters. By default the headers "Range" and "X-Range" are calculated and the request parameter 'range' is added. A range is an string like '5..20' == ${start}-${start+count-1}.
Parameters
- requestParameters: Record<string, any>
  request parameters will be changed
- options: QueryOptions
  the query options, with start + count.
Returns void
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:237

`Protected` _appendSortToRequest

_appendSortToRequest(requestParameters, options): void
Converts the options.sort to request parameters. By default the sort options are converted into 'sort' request parameter, like '-id,+name,+title'.
Parameters
- requestParameters: Record<string, any>
  request parameters to change.
- options: QueryOptions
  the query options.
Returns void
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:265

`Protected` _executeRequest

_executeRequest<T>(method, options): Promise<T>
Helper method which checks the query options and delegates to fetch.
Type Parameters
- T
Parameters
- method: string
  http method to execute.
- options: Record<string, any>
  the request options.
Returns Promise<T>
result of the request.
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:327

`Protected` _filterMetadata

_filterMetadata(metadata): Metadata
Overwrite this method to change the filter behavior.
Parameters
- metadata: Partial<Metadata>
Returns Metadata
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:307

`Protected` _filterParams

_filterParams(invokedFromMethod, requestParameters, originalMethodParameters): Record<string, any>
Hook for sub classes to add/change request parameters.
Parameters
- invokedFromMethod: string
- requestParameters: Record<string, any>
- originalMethodParameters: MethodParameters<ItemType, IDType>
Returns Record<string, any>
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:205

`Protected` _getMetadata

_getMetadata(): Partial<Metadata> | Promise<Partial<Metadata>>
Overwrite this method to provide your own metadata! The method can return Promises! Here you can implement http requests to dynamically resolve metadata.

Returns Partial<Metadata> | Promise<Partial<Metadata>>
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:317

`Protected` _processQueryResponse

_processQueryResponse(result): ResultItems<ItemType>
Transforms server responses into ResultItems. The default implementation expects a server response of this format:
```
 {
   total : <count>,
   items: [...]
 }
```
Parameters
- result: Record<string, any>
  json server response
Returns ResultItems<ItemType>
ResultItems.
- Defined in src/main/js/search/store-api/rest/BaseRestStore.ts:295

Class BaseRestStore<ItemType, IDType>

Type Parameters

ItemType extends IndexableThing

IDType extends string | number

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

ItemType extends Readonly<Record<string, any>>

IDType extends string | number

Parameters

options: Partial<Pick<BaseRestStore<ItemType, IDType>, keyof BaseRestStore<ItemType, IDType>>> = {}

fetch: ((url, options) => Promise<any>) = apprt_request

Parameters

url: string

options: Record<string, any>

Returns Promise<any>

Returns BaseRestStore<ItemType, IDType>

Properties

accepts

callbackParam

filterParam

headers

Type declaration

id

idProperty

itemProperty

jsonp

metadata

rangeParam

sortParam

supportsPostSwitching

target

totalProperty

Protected _metadata

Methods

get

Parameters

id: IDType

options: RetrievalOptions & AbortOptions & Readonly<Record<string, any>> & RequestOptions = {}

Returns Promise<ItemType>

getIdentity

Parameters

item: Partial<ItemType>

Returns undefined | IDType

getMetadata

Returns Promise<Metadata>

query

Parameters

Optional query: ComplexQueryExpression

options: QueryOptions = {}

Returns AsyncQueryResult<ItemType>

Protected _appendQueryToRequest

Parameters

requestParameters: Record<string, any>

query: undefined | ComplexQueryExpression

options: QueryOptions

Returns void

Protected _appendRangeToRequest

Parameters

requestParameters: Record<string, any>

options: QueryOptions

Returns void

Protected _appendSortToRequest

Parameters

requestParameters: Record<string, any>

options: QueryOptions

Returns void

Protected _executeRequest

Type Parameters

T

Parameters

method: string

options: Record<string, any>

Returns Promise<T>

`Protected` _metadata

`Optional` query: ComplexQueryExpression

`Protected` _appendQueryToRequest

`Protected` _appendRangeToRequest

`Protected` _appendSortToRequest

`Protected` _executeRequest

`Protected` _filterMetadata

`Protected` _filterParams

`Protected` _getMetadata

`Protected` _processQueryResponse