Class: AspectDataFacade

@flyze/lib-data-store 3.0.0-alpha.55· latest

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:23

Abstract class representing a facade for interacting with assets through the Flyze API. This class provides common methods for checking loading, creating, updating, and deleting states and errors.

Extends

AbstractStatefulFacade<"aspectData", AspectDataQueryBuilder, AspectData>

Constructors

Constructor

new AspectDataFacade(instance, facadeStore): AspectDataFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:28

Parameters

instance

ApiStoreInstance

facadeStore

FacadeStore

Returns

AspectDataFacade

Overrides

AbstractStatefulFacade.constructor

Properties

_selectors

protected _selectors: object

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.stateful-facade.ts:77

Gets the base selectors from the superclass. No tag filtering is applied.

canExecuteQuery()

canExecuteQuery: (q) => CanExecuteResult<string, "aspectTypes" | "assets" | "assetTypes" | "aspects">

Parameters

q

ExecutableQuery

Returns

CanExecuteResult<string, "aspectTypes" | "assets" | "assetTypes" | "aspects">

select()

select: (q) => DistinctSelector<RootStore, [number | AspectData<any> | AspectData<any>[] | undefined, number | AspectData<any>[], number | AspectData<any>[], number | AspectData<any>[], AspectData<any>[]], AspectData<any>[]>

Parameters

q

aspectId?

string | string[]

aspectName?

string

assetFullName?

string

id?

string | string[]

Returns

selectAll()

selectAll: () => MemoizedSelector<RootStore, AspectData<any>[], (s1) => AspectData<any>[]> | MemoizedSelector<RootStore, AspectData<any>[], (s1) => AspectData<any>[]>

Returns

MemoizedSelector<RootStore, AspectData<any>[], (s1) => AspectData<any>[]> | MemoizedSelector<RootStore, AspectData<any>[], (s1) => AspectData<any>[]>

selectByAspectId()

selectByAspectId: (aspectId) => MemoizedSelector<RootStore, AspectData<any>[], (s1) => AspectData<any>[]>

Parameters

aspectId

string | string[]

Returns

MemoizedSelector<RootStore, AspectData<any>[], (s1) => AspectData<any>[]>

selectByExecutableQuery()

selectByExecutableQuery: (q) => MemoizedSelector<RootStore, AspectData<any>[], any>

Parameters

q

ExecutableQuery

Returns

MemoizedSelector<RootStore, AspectData<any>[], any>

selectByFilter()

selectByFilter: (filterFn) => MemoizedSelector<RootStore, AspectData<any>[], (s1) => AspectData<any>[]>

Parameters

filterFn

(entity) => boolean

Returns

MemoizedSelector<RootStore, AspectData<any>[], (s1) => AspectData<any>[]>

selectById()

selectById: (id) => MemoizedSelector<RootStore, AspectData<any> | undefined, (s1) => AspectData<any> | undefined>

Parameters

id

string

Returns

MemoizedSelector<RootStore, AspectData<any> | undefined, (s1) => AspectData<any> | undefined>

selectByIds()

selectByIds: (ids) => MemoizedSelector<RootStore, AspectData<any>[], (s1) => AspectData<any>[]>

Parameters

ids

string[]

Returns

MemoizedSelector<RootStore, AspectData<any>[], (s1) => AspectData<any>[]>

selectByPath()

selectByPath: (path) => DistinctSelector<RootStore, [AspectData<any>[]], AspectData<any>[]>

Parameters

path

string | string[]

Returns

DistinctSelector<RootStore, [AspectData<any>[]], AspectData<any>[]>

selectCountByExecutableQuery()

selectCountByExecutableQuery: (q) => MemoizedSelector<RootStore, { items: AspectData<any>[]; totalCount: number; }, any>

Parameters

q

ExecutableQuery

Returns

MemoizedSelector<RootStore, { items: AspectData<any>[]; totalCount: number; }, any>

selectCreated()

selectCreated: (actionId?) => MemoizedSelector<RootStore, flowSuccess<AspectData<any>> | null, (s1) => flowSuccess<AspectData<any>> | null>

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowSuccess<AspectData<any>> | null, (s1) => flowSuccess<AspectData<any>> | null>

selectCreatedEntity()

selectCreatedEntity: () => MemoizedSelector<RootStore, AspectData<any> | undefined, (s1) => AspectData<any> | undefined>

Returns

MemoizedSelector<RootStore, AspectData<any> | undefined, (s1) => AspectData<any> | undefined>

selectCreateError()

selectCreateError: (actionId?) => MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

selectCreateFinished()

selectCreateFinished: (actionId) => MemoizedSelector<any, FinishedSelectorResponse<AspectData<any>>, (s1, s2) => FinishedSelectorResponse>

Parameters

actionId

string

Returns

MemoizedSelector<any, FinishedSelectorResponse<AspectData<any>>, (s1, s2) => FinishedSelectorResponse>

selectCreating()

selectCreating: () => MemoizedSelector<RootStore, boolean, (s1) => boolean>

Returns

MemoizedSelector<RootStore, boolean, (s1) => boolean>

selectDeleted()

selectDeleted: (actionId?) => MemoizedSelector<RootStore, flowSuccess<AspectData<any>> | null, (s1) => flowSuccess<AspectData<any>> | null>

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowSuccess<AspectData<any>> | null, (s1) => flowSuccess<AspectData<any>> | null>

selectDeletedEntity()

selectDeletedEntity: () => MemoizedSelector<RootStore, AspectData<any> | undefined, (s1) => AspectData<any> | undefined>

Returns

MemoizedSelector<RootStore, AspectData<any> | undefined, (s1) => AspectData<any> | undefined>

selectDeleteError()

selectDeleteError: (actionId?) => MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

selectDeleteFinished()

selectDeleteFinished: (actionId) => MemoizedSelector<any, FinishedSelectorResponse<AspectData<any>>, (s1, s2) => FinishedSelectorResponse>

Parameters

actionId

string

Returns

MemoizedSelector<any, FinishedSelectorResponse<AspectData<any>>, (s1, s2) => FinishedSelectorResponse>

selectDeleting()

selectDeleting: () => MemoizedSelector<RootStore, boolean, (s1) => boolean>

Returns

MemoizedSelector<RootStore, boolean, (s1) => boolean>

selectEntities()

selectEntities: () => MemoizedSelector<RootStore, Dictionary<AspectData<any>>, (s1) => Dictionary> | MemoizedSelector<RootStore, Dictionary<AspectData<any>>, (s1) => Dictionary>

Returns

MemoizedSelector<RootStore, Dictionary<AspectData<any>>, (s1) => Dictionary> | MemoizedSelector<RootStore, Dictionary<AspectData<any>>, (s1) => Dictionary>

selectEtag()

selectEtag: (ids) => MemoizedSelector<RootStore, IEtag[], (s1) => IEtag[]>

Parameters

ids

string[]

Returns

MemoizedSelector<RootStore, IEtag[], (s1) => IEtag[]>

selectEtags()

selectEtags: () => MemoizedSelector<RootStore, Record<string, IEtag>, (s1) => Result>

Returns

MemoizedSelector<RootStore, Record<string, IEtag>, (s1) => Result>

selectIds()

selectIds: () => MemoizedSelector<RootStore, string[] | number[], (s1) => string[] | number[]> | MemoizedSelector<RootStore, string[], (s1) => string[]>

Returns

MemoizedSelector<RootStore, string[] | number[], (s1) => string[] | number[]> | MemoizedSelector<RootStore, string[], (s1) => string[]>

selectLastLoadedData()

selectLastLoadedData: () => MemoizedSelector<RootStore, AspectData<any>[] | null, (s1) => AspectData<any>[] | null>

Returns

MemoizedSelector<RootStore, AspectData<any>[] | null, (s1) => AspectData<any>[] | null>

selectLoaded()

selectLoaded: (actionId?) => MemoizedSelector<RootStore, flowSuccess<AspectData<any>[]> | null, (s1) => flowSuccess<AspectData<any>[]> | null>

Get the loaded from the state. If a specific actionId is provided, only return the loaded prop if it matches the actionId.

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowSuccess<AspectData<any>[]> | null, (s1) => flowSuccess<AspectData<any>[]> | null>

selectLoadError()

selectLoadError: (actionId?) => MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

Get the load error from the state. If a specific actionId is provided, only return the error if it matches the actionId.

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

selectLoadFinished()

selectLoadFinished: (actionId) => MemoizedSelector<any, FinishedSelectorResponse<AspectData<any>[]>, (s1, s2) => FinishedSelectorResponse>

Parameters

actionId

string

Returns

MemoizedSelector<any, FinishedSelectorResponse<AspectData<any>[]>, (s1, s2) => FinishedSelectorResponse>

selectLoading()

selectLoading: () => MemoizedSelector<RootStore, boolean, (s1) => boolean>

Returns

MemoizedSelector<RootStore, boolean, (s1) => boolean>

selectRequestCacheEntry()

selectRequestCacheEntry: (key) => MemoizedSelector<RootStore, RequestCacheEntry | undefined, (s1) => RequestCacheEntry | undefined>

Cached conditional-request entry for a request key, or undefined when not cached / when persistData is off (feature disabled — there would be no entities to rebuild a 304 result from).

Parameters

key

string

Returns

MemoizedSelector<RootStore, RequestCacheEntry | undefined, (s1) => RequestCacheEntry | undefined>

selectUpdated()

selectUpdated: (actionId?) => MemoizedSelector<RootStore, flowSuccess<AspectData<any>> | null, (s1) => flowSuccess<AspectData<any>> | null>

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowSuccess<AspectData<any>> | null, (s1) => flowSuccess<AspectData<any>> | null>

selectUpdatedEntity()

selectUpdatedEntity: () => MemoizedSelector<RootStore, AspectData<any> | undefined, (s1) => AspectData<any> | undefined>

Returns

MemoizedSelector<RootStore, AspectData<any> | undefined, (s1) => AspectData<any> | undefined>

selectUpdateError()

selectUpdateError: (actionId?) => MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

selectUpdateFinished()

selectUpdateFinished: (actionId) => MemoizedSelector<any, FinishedSelectorResponse<AspectData<any>>, (s1, s2) => FinishedSelectorResponse>

Parameters

actionId

string

Returns

MemoizedSelector<any, FinishedSelectorResponse<AspectData<any>>, (s1, s2) => FinishedSelectorResponse>

selectUpdating()

selectUpdating: () => MemoizedSelector<RootStore, boolean, (s1) => boolean>

Returns

MemoizedSelector<RootStore, boolean, (s1) => boolean>

Inherited from

AbstractStatefulFacade._selectors

dispatch()

readonly dispatch: <V>(action) => void

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:36

Dispatches an action to the store.

Type Parameters

V

V extends Action = Action

Parameters

action

V & FunctionIsNotAllowed<V, "Functions are not allowed to be dispatched. Did you forget to call the action creator function?">

Returns

void

Inherited from

AbstractStatefulFacade.dispatch

facadeStore

protected facadeStore: FacadeStore

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.stateful-facade.ts:80

Inherited from

AbstractStatefulFacade.facadeStore

instance

protected instance: ApiStoreInstance

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:29

Inherited from

AbstractStatefulFacade.instance

section

protected section: "aspectData"

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:50

Inherited from

AbstractStatefulFacade.section

select()

readonly select: <T, K>(selector) => Observable<K>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:34

Selects a slice of state from the store using the provided selector.

Type Parameters

T

T

K

K

Parameters

selector

MemoizedSelector<T, K>

Returns

Observable<K>

Inherited from

AbstractStatefulFacade.select

selectSignal()

readonly selectSignal: <K>(selector) => Signal<K>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:38

Returns a signal of the provided selector.

Type Parameters

K

K

Parameters

selector

MemoizedSelector<any, K>

Returns

Signal<K>

Inherited from

AbstractStatefulFacade.selectSignal

Accessors

actions

Get Signature

get actions(): object & object[SECTION]

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:58

Returns

object & object[SECTION]

Inherited from

AbstractStatefulFacade.actions

instanceId

Get Signature

get instanceId(): string

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:44

Gets the instance ID of the underlying ApiStoreInstance.

Returns

string

Inherited from

AbstractStatefulFacade.instanceId

selectors

Get Signature

get selectors(): object & object[SECTION]

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.stateful-facade.ts:61

Gets the selectors for the specified section of the API store, extended with tag selection filters.

Returns

object & object[SECTION]

Inherited from

AbstractStatefulFacade.selectors

Methods

_dispatchWithId()

protected _dispatchWithId<PROPS>(action, props): string

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:92

Dispatches an action with a newly generated actionId.

Type Parameters

PROPS

PROPS extends object & object

Parameters

action

ActionCreator<string, (props) => TypedAction<string>>

The action creator to dispatch. It has to accept a props object that includes an actionId of type string.

props

Omit<PROPS, "actionId">

The properties to pass to the action creator, excluding the actionId.

Returns

string

The generated actionId.

Inherited from

AbstractStatefulFacade._dispatchWithId

_dispatchWithResult$()

protected _dispatchWithResult$<PROPS, TYPE, DATA>(action, props, finishSelector): Observable<FacadeFinished<DATA>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:108

Extends the _dispatchWithId method to return an observable that emits when the action is finished.

Type Parameters

PROPS

PROPS extends object & object

TYPE

TYPE

DATA

DATA

Parameters

action

ActionCreator<string, (props) => TypedAction<string>>

The action creator to dispatch. It has to accept a props object that includes an actionId of type string.

props

Omit<PROPS, "actionId">

The properties to pass to the action creator, excluding the actionId.

finishSelector

(actionId) => MemoizedSelector<any, FinishedSelectorResponse<DATA>>

A selector function that takes an actionId and returns a FinishSelector for the action.

Returns

Observable<FacadeFinished<DATA>>

An observable that emits when the action is finished.

Inherited from

AbstractStatefulFacade._dispatchWithResult$

create()

create(arg): Observable<FacadeFinished<AspectData<any>>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:227

Creates a new aspectData.

Parameters

arg

AspectDataCreateBody

Returns

Observable<FacadeFinished<AspectData<any>>>

createAsync()

createAsync(arg): Promise<FacadeFinished<AspectData<any>>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:241

A awaitable implementation of the

Parameters

arg

AspectDataCreateBody

Returns

Promise<FacadeFinished<AspectData<any>>>

See

create method.

delete()

delete(arg): Observable<FacadeFinished<AspectData<any>>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:288

Deletes an existing aspectData.

Parameters

arg

AspectDataDeleteBody

Returns

Observable<FacadeFinished<AspectData<any>>>

deleteAsync()

deleteAsync(arg): Promise<FacadeFinished<AspectData<any>>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:311

A awaitable implementation of the

Parameters

arg

AspectDataDeleteBody

Returns

Promise<FacadeFinished<AspectData<any>>>

See

delete method.

extendQueryWithSelectedTags()

protected extendQueryWithSelectedTags<QB>(queryBuilder): QB

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.stateful-facade.ts:91

given a query builder, extend it with filters for the currently selected tags in the facade store.

Type Parameters

QB

QB extends AbstractQueryBuilder<any, any>

Parameters

queryBuilder

QB

Returns

QB

the extended query builder

Inherited from

AbstractStatefulFacade.extendQueryWithSelectedTags

filterById()

filterById(id): Observable<AspectData<any> | undefined>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:60

Filters aspectDatas by specified ID.

Parameters

id

string

Returns

Observable<AspectData<any> | undefined>

Deprecated

use a selector directly from the store, e.g. facade.select(facade.selectors.selectById(id))

getAll()

getAll(): Observable<AspectData<any>[]>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:70

Returns

Observable<AspectData<any>[]>

Deprecated

use selectAll()

See

selectAll

getFinishedObservable()

protected getFinishedObservable<T, D>(selector): Observable<FacadeFinished<D>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:77

Type Parameters

T

T

D

D

Parameters

selector

MemoizedSelector<any, FinishedSelectorResponse<D>>

Returns

Observable<FacadeFinished<D>>

Inherited from

AbstractStatefulFacade.getFinishedObservable

getNewId()

protected getNewId(): string

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:73

utility method to generate a new GUID. This is used to track actions.

Returns

string

A new GUID.

Inherited from

AbstractStatefulFacade.getNewId

getQueryBuilder()

getQueryBuilder(…args): AspectDataQueryBuilder

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:38

Get a new instance of the AspectDataQueryBuilder.

Parameters

args

…[AbstractQueryBuilderOptions<AspectDataQueryFilterKeys, AspectDataQuery>]

Returns

AspectDataQueryBuilder

Overrides

AbstractStatefulFacade.getQueryBuilder

lastLoadedData()

lastLoadedData(): Observable<AspectData<any>[] | null>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:49

Returns

Observable<AspectData<any>[] | null>

Deprecated

Gets the last loaded data of aspectDatas.

load()

load(query?): Observable<FacadeFinished<AspectData<any>[]>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:173

Loads AspectData based on the provided filter.

Parameters

query?

FacadeAspectDataLoad

The query to filter AspectData.

Returns

Observable<FacadeFinished<AspectData<any>[]>>

Examples

load({ fyzFacadeType: 'page', page: 1, pageSize: 10 });

load();
load({ fyzFacadeType: 'page' });

load({ fyzFacadeType: 'get', filter: 'id = aaa-bbb-ccc' });

loadAll()

loadAll(query): Observable<FacadeFinished<AspectData<any>[]>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:97

Load all AspectData based on the provided query - handles pagination internally and loads all. NOTE! providing a empty query will load ALL Data.

Parameters

query

FacadeAspectData_LoadAll

Returns

Observable<FacadeFinished<AspectData<any>[]>>

loadAllAsync()

loadAllAsync(query): Promise<FacadeFinished<AspectData<any>[]>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:151

A awaitable impl. of the

Parameters

query

FacadeAspectData_LoadAll

Returns

Promise<FacadeFinished<AspectData<any>[]>>

See

loadAll method.

loadAsync()

loadAsync(query?): Promise<FacadeFinished<AspectData<any>[]>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:218

A awaitable implementation of the

Parameters

query?

FacadeAspectDataLoad

Returns

Promise<FacadeFinished<AspectData<any>[]>>

See

load method.

selectAll()

selectAll(): Observable<AspectData<any>[]>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:82

select all aspectData in the store.

Returns

Observable<AspectData<any>[]>

An Observable that resolves to all aspects.

Deprecated

use a selector directly from the store, e.g. facade.select(facade.selectors.selectAll())

update()

update(arg): Observable<FacadeFinished<AspectData<any>>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:250

Updates an existing aspectData.

Parameters

arg

AspectDataUpdateBody

Returns

Observable<FacadeFinished<AspectData<any>>>

updateAsync()

updateAsync(arg): Promise<FacadeFinished<AspectData<any>>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data.facade.ts:279

A awaitable implementation of the

Parameters

arg

AspectDataUpdateBody

Returns

Promise<FacadeFinished<AspectData<any>>>

See

update method.