@ngdux/list 3.0.1 → 4.0.0

package/lib/+state/state.service.d.ts

@@ -1,22 +0,0 @@
-import { ReducerManager } from '@ngrx/store';
-import { ListActions, ListSelectors } from '../models/list.model';
-import * as i0 from "@angular/core";
-export declare class ListStateService<T extends {
-    [key: string]: any;
-}, Error = unknown, S extends {
-    [key: string]: any;
-} = T, Params = Record<string, string>> {
-    private readonly reducerManager;
-    protected actions: Record<string, ListActions<T, Error, S, Params>>;
-    protected selectors: Record<string, ListSelectors<S, Error, Params>>;
-    private entityAdapter;
-    constructor(reducerManager: ReducerManager, featureKeys: string[]);
-    protected getActions(featureKey: string): ListActions<T, Error, S, Params>;
-    private getEntityAdapter;
-    protected addReducer(featureKey: string, actions: ListActions<T, Error, S, Params>): void;
-    protected getSelectors(featureKey: string): ListSelectors<S, Error, Params>;
-    getFeatureActions(featureKey: string): ListActions<T, Error, S, Params>;
-    getFeatureSelectors(featureKey: string): ListSelectors<S, Error, Params>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ListStateService<any, any, any, any>, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ListStateService<any, any, any, any>>;
-}

package/lib/models/list.model.d.ts

@@ -1,191 +0,0 @@
-import { InjectionToken, Type } from '@angular/core';
-import { ErrorDto, FilteringOptions, ListNotificationService, ListService, PagingOptions, RequestOptions, RequestState, SortingField } from '@ngdux/data-model-common';
-import { ApiRequestState, LoadingState } from '@ngdux/store-common';
-import { EntityState } from '@ngrx/entity';
-import { ActionCreator, MemoizedSelector } from '@ngrx/store';
-import { TypedAction } from '@ngrx/store/src/models';
-export declare const LIST_FEATURE_KEY: InjectionToken<string>;
-export declare const LIST_FEATURE_KEYS: InjectionToken<string>;
-export declare const LIST_SERVICES: InjectionToken<string>;
-export declare const LIST_NOTIFICATION_SERVICES: InjectionToken<string>;
-export interface ListState<T, E = unknown, Params = Record<string, string>> extends EntityState<T>, RequestOptions<Params>, ApiRequestState<E>, LoadingState {
-    selectedResourceIds: string[];
-    lastPageNumber?: number;
-}
-export interface ListSelectors<T, E = unknown, Params = Record<string, string>> {
-    getAll: MemoizedSelector<object, T[]>;
-    getRequestOptions: MemoizedSelector<object, RequestOptions>;
-    isLastPage: MemoizedSelector<object, boolean>;
-    getCurrentPageData: MemoizedSelector<object, T[]>;
-    getPagingOptions: MemoizedSelector<object, PagingOptions>;
-    getSortingOptions: MemoizedSelector<object, SortingField[]>;
-    getFilteringOptions: MemoizedSelector<object, FilteringOptions>;
-    getRequestParameters: MemoizedSelector<object, Params | undefined>;
-    getCurrentPageNumber: MemoizedSelector<object, number>;
-    getLastPageNumber: MemoizedSelector<object, number | undefined>;
-    getLoadingState: MemoizedSelector<object, RequestState>;
-    getSelectedResourceIds: MemoizedSelector<object, string[]>;
-    getSelectedItems: MemoizedSelector<object, T[]>;
-    getSelectionRecord: MemoizedSelector<object, Record<string, T>>;
-    getRequestState: MemoizedSelector<object, RequestState>;
-    getErrors: MemoizedSelector<object, E | undefined>;
-    areSelectedReady: MemoizedSelector<object, boolean>;
-    isReady: MemoizedSelector<object, boolean>;
-    isDeleteDisabled: MemoizedSelector<object, boolean>;
-    isCopyDisabled: MemoizedSelector<object, boolean>;
-    getTotalCount: MemoizedSelector<object, number>;
-}
-export interface ListActions<Entity, Error = unknown, Summary = Entity, Params = Record<string, string>> {
-    /**
-     * Set the page size without reloading the list
-     */
-    setPageSize: ActionCreator<string, (props: {
-        pageSize: number;
-    }) => {
-        pageSize: number;
-    } & TypedAction<string>>;
-    /**
-     * Set the sorting options without reloading the list
-     */
-    setSorting: ActionCreator<string, (props: {
-        sortingOptions: SortingField[];
-    }) => {
-        sortingOptions: SortingField[];
-    } & TypedAction<string>>;
-    /**
-     * Set the filtering options without reloading the list
-     */
-    setFiltering: ActionCreator<string, (props: {
-        filteringOptions: FilteringOptions;
-    }) => {
-        filteringOptions: FilteringOptions;
-    } & TypedAction<string>>;
-    /**
-     * Set the request parameters without reloading the list
-     */
-    setRequestParams: ActionCreator<string, (props: {
-        params: Params;
-    }) => {
-        params: Params;
-    } & TypedAction<string>>;
-    /**
-     * Change the paging options and reload the list
-     */
-    changePagingOptions: ActionCreator<string, (props: {
-        pagingOptions: PagingOptions;
-    }) => {
-        pagingOptions: PagingOptions;
-    } & TypedAction<string>>;
-    /**
-     * Change the page number and reload the list
-     */
-    changePageNumber: ActionCreator<string, (props: {
-        pageNumber: number;
-    }) => {
-        pageNumber: number;
-    } & TypedAction<string>>;
-    /**
-     * Change the page size and reload the list
-     */
-    changePageSize: ActionCreator<string, (props: {
-        pageSize: number;
-    }) => {
-        pageSize: number;
-    } & TypedAction<string>>;
-    /**
-     * Change the sorting options and reload the list
-     */
-    changeSorting: ActionCreator<string, (props: {
-        sortingOptions: SortingField[];
-    }) => {
-        sortingOptions: SortingField[];
-    } & TypedAction<string>>;
-    /**
-     * Change the filtering options and reload the list
-     */
-    changeFiltering: ActionCreator<string, (props: {
-        filteringOptions: FilteringOptions;
-    }) => {
-        filteringOptions: FilteringOptions;
-    } & TypedAction<string>>;
-    /**
-     * Change the request parameters and reload the list
-     */
-    changeRequestParams: ActionCreator<string, (props: {
-        params: Params;
-    }) => {
-        params: Params;
-    } & TypedAction<string>>;
-    changeSelectedResources: ActionCreator<string, (props: {
-        selectedResourceIds: string[];
-    }) => {
-        selectedResourceIds: string[];
-    } & TypedAction<string>>;
-    loadPage: ActionCreator<string, () => TypedAction<string>>;
-    loadPageSuccess: ActionCreator<string, (props: {
-        resources: Summary[];
-        pagingOptions: PagingOptions;
-    }) => {
-        resources: Summary[];
-        pagingOptions: PagingOptions;
-    } & TypedAction<string>>;
-    loadPageFailure: ActionCreator<string, (props: {
-        errors: Error;
-    }) => {
-        errors: Error;
-    } & TypedAction<string>>;
-    delete: ActionCreator<string, (props: {
-        resourceIds: string[];
-    }) => {
-        resourceIds: string[];
-    } & TypedAction<string>>;
-    deleteSuccess: ActionCreator<string, (props: {
-        resourceIds: string[];
-    }) => {
-        resourceIds: string[];
-    } & TypedAction<string>>;
-    deleteFailure: ActionCreator<string, (props: {
-        errors: Error;
-    }) => {
-        errors: Error;
-    } & TypedAction<string>>;
-    patch: ActionCreator<string, (props: {
-        resourceIds: string[];
-        resource: Partial<Entity>;
-    }) => {
-        resourceIds: string[];
-        resource: Partial<Entity>;
-    } & TypedAction<string>>;
-    patchSuccess: ActionCreator<string, (props: {
-        resources: (Entity | ErrorDto)[];
-    }) => {
-        resources: (Entity | ErrorDto)[];
-    } & TypedAction<string>>;
-    patchFailure: ActionCreator<string, (props: {
-        errors: Error;
-    }) => {
-        errors: Error;
-    } & TypedAction<string>>;
-    loadNextPage: ActionCreator<string, () => TypedAction<string>>;
-    /**
-     * Remove the current data, set the page number to 1 and deselect resources.
-     * Keep all the rest, like filteringOptions and sortingOptions
-     */
-    initialize: ActionCreator<string, () => TypedAction<string>>;
-    /**
-     * Reset to the initial state
-     */
-    reset: ActionCreator<string, () => TypedAction<string>>;
-    loadPreviousPage: ActionCreator<string, () => TypedAction<string>>;
-    loadFirstPage: ActionCreator<string, () => TypedAction<string>>;
-    /**
-     * Reset the request state to idle
-     */
-    resetRequestState: ActionCreator<string, () => TypedAction<string>>;
-}
-export interface NgduxListStateModuleConfig<T extends {
-    [key: string]: any;
-}, E, S = T, Params = Record<string, string>> {
-    service: Type<ListService<T, S, Params>>;
-    notificationService?: Type<ListNotificationService<E>>;
-}

package/lib/ngdux-list-state.module.d.ts

@@ -1,23 +0,0 @@
-import { ModuleWithProviders } from '@angular/core';
-import { ListNotificationService, ListService } from '@ngdux/data-model-common';
-import { RegisterEffectsService } from '@ngdux/store-common';
-import { Actions } from '@ngrx/effects';
-import { Store } from '@ngrx/store';
-import { ListStateService } from './+state/state.service';
-import { NgduxListStateModuleConfig } from './models/list.model';
-import * as i0 from "@angular/core";
-export declare class NgduxListStateModule<T extends {
-    [key: string]: any;
-}, Error = unknown, S extends {
-    [key: string]: any;
-} = T, Params = Record<string, string>> {
-    constructor(registerEffectsService: RegisterEffectsService, actions$: Actions, store: Store, listStateService: ListStateService<T, Error, S, Params>, featureKeys: string[], services: ListService<T, S, Params>[], notificationServices: ListNotificationService<Error>[]);
-    static config<T extends {
-        [key: string]: any;
-    }, Error = unknown, S extends {
-        [key: string]: any;
-    } = T, Params = Record<string, string>>(config: NgduxListStateModuleConfig<T, Error, S, Params>): ModuleWithProviders<NgduxListStateModule<T, Error, S, Params>>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgduxListStateModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<NgduxListStateModule, never, never, never>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<NgduxListStateModule>;
-}

package/lib/services/list-notification-service.d.ts

@@ -1,13 +0,0 @@
-import { ErrorDto, ListNotificationService } from '@ngdux/data-model-common';
-import { Observable } from 'rxjs';
-import * as i0 from "@angular/core";
-export declare class NotificationServicePlaceholder implements ListNotificationService<ErrorDto> {
-    onListErrors(errors: ErrorDto): void;
-    onListDelete(ids: string[]): void;
-    openConfirmationDialog(data: {
-        message: string;
-        title: string;
-    }): Observable<boolean>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NotificationServicePlaceholder, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<NotificationServicePlaceholder>;
-}

package/lib/state-generator/abstract-list-effects.d.ts

@@ -1,49 +0,0 @@
-import { ListNotificationService, ListService } from '@ngdux/data-model-common';
-import { Actions } from '@ngrx/effects';
-import { Store } from '@ngrx/store';
-import { ListActions, ListSelectors } from '../models/list.model';
-export declare abstract class AbstractListEffects<T, E = unknown, S = T, Params = Record<string, string>> {
-    protected readonly actions$: Actions;
-    protected readonly store: Store;
-    protected readonly service: ListService<T, S, Params>;
-    protected readonly listActions: ListActions<T, E, S, Params>;
-    protected readonly listSelectors: ListSelectors<S, E, Params>;
-    protected readonly notificationService?: ListNotificationService<E> | undefined;
-    reload$: import("rxjs").Observable<import("@ngrx/store/src/models").TypedAction<string>> & import("@ngrx/effects").CreateEffectMetadata;
-    loadFirstPage$: import("rxjs").Observable<{
-        pageNumber: number;
-    } & import("@ngrx/store/src/models").TypedAction<string>> & import("@ngrx/effects").CreateEffectMetadata;
-    loadPreviousPage$: import("rxjs").Observable<{
-        pageNumber: number;
-    } & import("@ngrx/store/src/models").TypedAction<string>> & import("@ngrx/effects").CreateEffectMetadata;
-    loadNextPage$: import("rxjs").Observable<{
-        pageNumber: number;
-    } & import("@ngrx/store/src/models").TypedAction<string>> & import("@ngrx/effects").CreateEffectMetadata;
-    loadPage$: import("rxjs").Observable<({
-        resources: S[];
-        pagingOptions: import("@ngdux/data-model-common").PagingOptions;
-    } & import("@ngrx/store/src/models").TypedAction<string>) | ({
-        errors: E;
-    } & import("@ngrx/store/src/models").TypedAction<string>)> & import("@ngrx/effects").CreateEffectMetadata;
-    patch$: import("rxjs").Observable<({
-        resources: (import("@ngdux/data-model-common").ErrorDto | T)[];
-    } & import("@ngrx/store/src/models").TypedAction<string>) | ({
-        errors: E;
-    } & import("@ngrx/store/src/models").TypedAction<string>)> & import("@ngrx/effects").CreateEffectMetadata;
-    delete$: import("rxjs").Observable<({
-        resourceIds: string[];
-    } & import("@ngrx/store/src/models").TypedAction<string>) | ({
-        errors: E;
-    } & import("@ngrx/store/src/models").TypedAction<string>)> & import("@ngrx/effects").CreateEffectMetadata;
-    deleteSuccess$: import("rxjs").Observable<{
-        resourceIds: string[];
-    } & import("@ngrx/store/src/models").TypedAction<string>> & import("@ngrx/effects").CreateEffectMetadata;
-    errorsHandler$: import("rxjs").Observable<({
-        errors: E;
-    } & import("@ngrx/store/src/models").TypedAction<string>) | ({
-        errors: E;
-    } & import("@ngrx/store/src/models").TypedAction<string>) | ({
-        errors: E;
-    } & import("@ngrx/store/src/models").TypedAction<string>)> & import("@ngrx/effects").CreateEffectMetadata;
-    protected constructor(actions$: Actions, store: Store, service: ListService<T, S, Params>, listActions: ListActions<T, E, S, Params>, listSelectors: ListSelectors<S, E, Params>, notificationService?: ListNotificationService<E> | undefined);
-}

package/lib/state-generator/abstract-list-state.service.d.ts

@@ -1,21 +0,0 @@
-import { ReducerManager } from '@ngrx/store';
-import { ListActions, ListSelectors } from '../models/list.model';
-import * as i0 from "@angular/core";
-export declare abstract class AbstractListReducerManager<T extends {
-    [key: string]: any;
-}, E, S extends {
-    [key: string]: any;
-} = T, Params = Record<string, string>> {
-    private readonly reducerManager;
-    private readonly featureKey;
-    actions: ListActions<T, E, S, Params>;
-    selectors: ListSelectors<S, E, Params>;
-    private entityAdapter;
-    constructor(reducerManager: ReducerManager, featureKey: string);
-    protected getActions(): ListActions<T, E, S, Params>;
-    private getEntityAdapter;
-    protected addReducer(): void;
-    protected getSelectors(): ListSelectors<S, E, Params>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AbstractListReducerManager<any, any, any, any>, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AbstractListReducerManager<any, any, any, any>>;
-}

package/lib/state-generator/abstract-list.facade.d.ts

@@ -1,45 +0,0 @@
-import { ActionPayload } from '@ngdux/store-common';
-import { Store } from '@ngrx/store';
-import { ListActions, ListSelectors } from '../models/list.model';
-export declare abstract class AbstractListFacade<T, E, S = T, Params = Record<string, string>> {
-    protected readonly store: Store;
-    private readonly listActions;
-    private readonly listSelectors;
-    readonly resources$: import("rxjs").Observable<S[]>;
-    readonly loadingState$: import("rxjs").Observable<import("@ngdux/data-model-common").RequestState>;
-    readonly requestState$: import("rxjs").Observable<import("@ngdux/data-model-common").RequestState>;
-    readonly errors$: import("rxjs").Observable<E | undefined>;
-    readonly isReady$: import("rxjs").Observable<boolean>;
-    readonly areSelectedReady$: import("rxjs").Observable<boolean>;
-    readonly currentPageData$: import("rxjs").Observable<S[]>;
-    readonly currentPageNumber$: import("rxjs").Observable<number>;
-    readonly filteringOptions$: import("rxjs").Observable<import("@ngdux/data-model-common").FilteringOptions>;
-    readonly requestParameters$: import("rxjs").Observable<Params | undefined>;
-    readonly lastPageNumber$: import("rxjs").Observable<number | undefined>;
-    readonly pagingOptions$: import("rxjs").Observable<import("@ngdux/data-model-common").PagingOptions>;
-    readonly requestOptions$: import("rxjs").Observable<import("@ngdux/data-model-common").RequestOptions<Record<string, string>>>;
-    readonly sortingOptions$: import("rxjs").Observable<import("@ngdux/data-model-common").SortingField[]>;
-    readonly selectedItems$: import("rxjs").Observable<S[]>;
-    readonly totalCount$: import("rxjs").Observable<number>;
-    constructor(store: Store, listActions: ListActions<T, E, S, Params>, listSelectors: ListSelectors<S, E, Params>);
-    setPageSize(props: ActionPayload<ListActions<T, E, S, Params>['setPageSize']>): void;
-    setFiltering(props: ActionPayload<ListActions<T, E, S, Params>['setFiltering']>): void;
-    setSorting(props: ActionPayload<ListActions<T, E, S, Params>['setSorting']>): void;
-    setRequestParameters(props: ActionPayload<ListActions<T, E, S, Params>['setRequestParams']>): void;
-    changeFiltering(props: ActionPayload<ListActions<T, E, S, Params>['changeFiltering']>): void;
-    changePagingOptions(props: ActionPayload<ListActions<T, E, S, Params>['changePagingOptions']>): void;
-    changePageSize(props: ActionPayload<ListActions<T, E, S, Params>['changePageSize']>): void;
-    changePageNumber(props: ActionPayload<ListActions<T, E, S, Params>['changePageNumber']>): void;
-    changeSelectedResources(props: ActionPayload<ListActions<T, E, S, Params>['changeSelectedResources']>): void;
-    changeSorting(props: ActionPayload<ListActions<T, E, S, Params>['changeSorting']>): void;
-    changeRequestParams(props: ActionPayload<ListActions<T, E, S, Params>['changeRequestParams']>): void;
-    loadPage(): void;
-    loadFirstPage(): void;
-    loadNextPage(): void;
-    loadPreviousPage(): void;
-    patch(props: ActionPayload<ListActions<T, E, S, Params>['patch']>): void;
-    delete(props: ActionPayload<ListActions<T, E, S, Params>['delete']>): void;
-    initialize(): void;
-    reinitialize(): void;
-    resetRequestState(): void;
-}

package/lib/state-generator/list-actions.d.ts

@@ -1,2 +0,0 @@
-import { ListActions } from '../models/list.model';
-export declare function createListActions<T, E, S = T, Params = Record<string, string>>(featureName: string): ListActions<T, E, S, Params>;

package/lib/state-generator/list-reducer.d.ts

@@ -1,10 +0,0 @@
-import { EntityAdapter } from '@ngrx/entity';
-import { ActionReducer, ReducerTypes } from '@ngrx/store';
-import { ActionCreator } from '@ngrx/store/src/models';
-import { ListActions, ListState } from '../models/list.model';
-export declare function createListEntityAdapter<T extends {
-    [key: string]: any;
-}>(idKey?: string): EntityAdapter<T>;
-export declare function createListReducer<T, E, S = T, Params = Record<string, string>>(entityAdapter: EntityAdapter<S>, actions: ListActions<T, E, S, Params>, actionHandlers?: ReducerTypes<ListState<S, E, Params>, ActionCreator[]>[], initialListState?: {
-    [key: string]: unknown;
-}): ActionReducer<ListState<S, E, Params>>;

package/lib/state-generator/list-selectors.d.ts

@@ -1,4 +0,0 @@
-import { EntityAdapter } from '@ngrx/entity';
-import { DefaultProjectorFn, MemoizedSelector } from '@ngrx/store';
-import { ListSelectors, ListState } from '../models/list.model';
-export declare function createListSelectors<T, E, Params = Record<string, string>>(entityAdapter: EntityAdapter<T>, getListState: MemoizedSelector<object, ListState<T, E, Params>, DefaultProjectorFn<ListState<T, E, Params>>>): ListSelectors<T, E, Params>;

package/lib/state-generator/list-state.d.ts

@@ -1,12 +0,0 @@
-import { Action } from '@ngrx/store';
-import { ListState } from '../models/list.model';
-export declare function createListState<T extends {
-    [key: string]: any;
-}, E, S extends {
-    [key: string]: any;
-} = T, Params = Record<string, string>>(featureName: string, idKey?: string): {
-    actions: import("../models/list.model").ListActions<T, E, S, Params>;
-    reducer: (state: ListState<S, E, Params>, action: Action) => ListState<S, E, Params>;
-    selectors: import("../models/list.model").ListSelectors<S, E, Params>;
-    entityAdapter: import("@ngrx/entity").EntityAdapter<S>;
-};