@ngdux/list 0.1.6

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

@@ -0,0 +1,122 @@
+import { ErrorDto, FilteringOptions, PagingOptions, RequestOptions, RequestState, SortingField, SortingOptions } 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 interface ListState<T, E> extends EntityState<T>, RequestOptions, ApiRequestState<E>, LoadingState {
+    selectedResourceIds: string[];
+    lastPageNumber: number;
+}
+export interface ListSelectors<T, E> {
+    getAll: MemoizedSelector<object, T[]>;
+    getRequestOptions: MemoizedSelector<object, RequestOptions>;
+    isLastPage: MemoizedSelector<object, boolean>;
+    getCurrentPageData: MemoizedSelector<object, T[]>;
+    getPagingOptions: MemoizedSelector<object, PagingOptions>;
+    getSortingOptions: MemoizedSelector<object, SortingOptions>;
+    getFilteringOptions: MemoizedSelector<object, FilteringOptions>;
+    getCurrentPageNumber: MemoizedSelector<object, number>;
+    getLastPageNumber: MemoizedSelector<object, number>;
+    getLoadingState: MemoizedSelector<object, RequestState>;
+    getSelectedResourceIds: MemoizedSelector<object, string[]>;
+    getSelected: MemoizedSelector<object, T[]>;
+    getSelectionRecord: MemoizedSelector<object, Record<string, T>>;
+    getRequestState: MemoizedSelector<object, RequestState>;
+    getErrors: MemoizedSelector<object, E>;
+    areSelectedReady: MemoizedSelector<object, boolean>;
+    isReady: MemoizedSelector<object, boolean>;
+    isDeleteDisabled: MemoizedSelector<object, boolean>;
+    isCopyDisabled: MemoizedSelector<object, boolean>;
+    getTotalCount: MemoizedSelector<object, number>;
+}
+export interface ListActions<T, E, S = T> {
+    initializeRequestOptions: ActionCreator<string, () => TypedAction<string>>;
+    changePagingOptions: ActionCreator<string, (props: {
+        pagingOptions: PagingOptions;
+    }) => {
+        pagingOptions: PagingOptions;
+    } & TypedAction<string>>;
+    changePageSize: ActionCreator<string, (props: {
+        pageSize: number;
+    }) => {
+        pageSize: number;
+    } & TypedAction<string>>;
+    changeSorting: ActionCreator<string, (props: {
+        sortingField: SortingField;
+    }) => {
+        sortingField: SortingField;
+    } & TypedAction<string>>;
+    changeFiltering: ActionCreator<string, (props: {
+        filteringOptions: FilteringOptions;
+    }) => {
+        filteringOptions: FilteringOptions;
+    } & TypedAction<string>>;
+    changeSelected: ActionCreator<string, (props: {
+        selectedResourceIds: string[];
+    }) => {
+        selectedResourceIds: string[];
+    } & TypedAction<string>>;
+    loadPage: ActionCreator<string, (props: {
+        pageNumber: number;
+    }) => {
+        pageNumber: number;
+    } & TypedAction<string>>;
+    loadPageSuccess: ActionCreator<string, (props: {
+        resources: S[];
+        pagingOptions: PagingOptions;
+    }) => {
+        resources: S[];
+        pagingOptions: PagingOptions;
+    } & TypedAction<string>>;
+    loadPageFailure: ActionCreator<string, (props: {
+        errors: E;
+    }) => {
+        errors: E;
+    } & 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: E;
+    }) => {
+        errors: E;
+    } & TypedAction<string>>;
+    patch: ActionCreator<string, (props: {
+        resourceIds: string[];
+        resource: Partial<T>;
+    }) => {
+        resourceIds: string[];
+        resource: Partial<T>;
+    } & TypedAction<string>>;
+    patchSuccess: ActionCreator<string, (props: {
+        resources: (T | ErrorDto)[];
+    }) => {
+        resources: (T | ErrorDto)[];
+    } & TypedAction<string>>;
+    patchFailure: ActionCreator<string, (props: {
+        errors: E;
+    }) => {
+        errors: E;
+    } & TypedAction<string>>;
+    loadNextPage: ActionCreator<string, () => TypedAction<string>>;
+    refresh: ActionCreator<string, () => TypedAction<string>>;
+    initialize: ActionCreator<string, () => TypedAction<string>>;
+    reinitialize: ActionCreator<string, () => TypedAction<string>>;
+    loadPreviousPage: ActionCreator<string, () => TypedAction<string>>;
+    loadFirstPage: ActionCreator<string, () => TypedAction<string>>;
+    resetRequestState: ActionCreator<string, () => TypedAction<string>>;
+    copySelected: ActionCreator<string, () => TypedAction<string>>;
+    navigateToSelected: ActionCreator<string, (props: {
+        resourceId: string;
+    }) => {
+        resourceId: string;
+    } & TypedAction<string>>;
+    showRemovalsConfirmation: ActionCreator<string, () => TypedAction<string>>;
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@ngdux/list",
+  "version": "0.1.6",
+  "peerDependencies": {
+    "@angular/common": "^14.2.0",
+    "@angular/core": "^14.2.0",
+    "@angular/router": "14.2.6",
+    "@ngdux/data-model-common": "0.1.6",
+    "@ngdux/store-common": "0.1.6",
+    "@ngrx/effects": "14.0.2",
+    "@angular/material": "14.2.5",
+    "@ngrx/entity": "14.0.2"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:allanartuso/ngdux.git",
+    "directory": "/libs/ngdux/util/store/list"
+  },
+  "homepage": "https://github.com/allanartuso/ngdux/tree/master/libs/ngdux/util/store/list#readme",
+  "module": "fesm2015/ngdux-list.mjs",
+  "es2020": "fesm2020/ngdux-list.mjs",
+  "esm2020": "esm2020/ngdux-list.mjs",
+  "fesm2020": "fesm2020/ngdux-list.mjs",
+  "fesm2015": "fesm2015/ngdux-list.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2020": "./esm2020/ngdux-list.mjs",
+      "es2020": "./fesm2020/ngdux-list.mjs",
+      "es2015": "./fesm2015/ngdux-list.mjs",
+      "node": "./fesm2015/ngdux-list.mjs",
+      "default": "./fesm2020/ngdux-list.mjs"
+    }
+  },
+  "sideEffects": false
+}