@verisoft/store 20.0.0 → 20.1.0

package/src/lib/table-state/effects.ts

@@ -0,0 +1,99 @@
+import { Actions, createEffect, ofType } from '@ngrx/effects';
+import {  createFeatureSelector, createSelector, Store } from '@ngrx/store';
+import { BaseHttpService, DEFAULT_SEARCH_LIMIT, Page, RequestParams } from '@verisoft/core';
+import { catchError, map, Observable, of, switchMap, withLatestFrom } from 'rxjs';
+import {
+  createGetPageTableAction,
+  createDataLoadSuccessTableAction,
+  createDataLoadErrorTableAction,
+  createRemoveRangeTableAction,
+} from './actions';
+import { TableState } from './models';
+
+export interface CreateGetPageActionConfig<T> {
+  service?: BaseHttpService<T>;
+  fetchList?: (requestParams: RequestParams<any>) => Observable<Page<T>>;
+  snackbar?: any;
+  ngrxFeatureKey?: string;
+  requireFilters?: boolean;
+}
+
+export function createGetPageTableEffect<T>(
+  tableRepository: string,
+  actions$: Actions,
+  config: CreateGetPageActionConfig<T>
+) {
+  return createEffect(() => {
+    return actions$.pipe(
+      ofType(createGetPageTableAction(tableRepository)),
+      switchMap(({ page, filter, sort, size }) => {
+        const requestParams: RequestParams<any> = {
+          offset: page * size,
+          limit: size,
+          sort,
+          filter,
+        };
+
+        const params = config.service?.createParams(requestParams) ?? requestParams;
+
+        const fetchList$: Observable<Page<T>> = (config.service?.fetchList(
+          params
+        ) ?? config.fetchList?.(params)) as Observable<Page<T>>;
+        if (!fetchList$) {
+          throw new Error('Service or fetchList$ must by defined.');
+        }
+
+        return fetchList$.pipe(
+          map((gPage) => {
+            const p = { ...gPage, number: page };
+            return createDataLoadSuccessTableAction(tableRepository)({
+              gPage: p,
+            });
+          }),
+          catchError((error) => {
+            config.snackbar?.showError(error.message);
+            return of(
+              createDataLoadErrorTableAction(tableRepository)({ error })
+            );
+          })
+        );
+      })
+    );
+  });
+}
+
+export function createRemoveRangeTableEffect<T>(
+  tableRepository: string,
+  ngrxFeatureKey: string,
+  actions$: Actions,
+  store$: Store<any>,
+  config: CreateGetPageActionConfig<T>
+) {
+  return createEffect(() => {
+    if(!config?.service) {
+      throw new Error('Service must be defined!');
+    }
+
+    const selectedItems = createSelector(
+      createFeatureSelector<any>(ngrxFeatureKey),
+      (state: any) => {
+        return (state?.[tableRepository] as TableState<any>)?.selectedItems as any;
+      }
+    );
+
+    return actions$.pipe(
+      ofType(createRemoveRangeTableAction(tableRepository)),
+      withLatestFrom(selectedItems),
+      switchMap(([, { selectedItems }]) => {
+        return config.service!.removeRange(selectedItems).pipe(
+          map(() => {
+            return createGetPageTableAction(tableRepository)({ page: 0, size: DEFAULT_SEARCH_LIMIT })
+          }),
+          catchError(error => {
+            return of(createDataLoadErrorTableAction(tableRepository)({ error }))
+          })
+        );
+      })
+    );
+  });
+}

package/src/lib/table-state/models.ts

@@ -0,0 +1,20 @@
+import { DEFAULT_SEARCH_LIMIT, DEFAULT_SEARCH_PARAMS, Page, RequestParams } from "@verisoft/core";
+
+export interface TableState<T> {
+  dataLoading: boolean;
+  requestParams: RequestParams<T>;
+  gPage?: Page<T>;
+  error?: string | null;
+  selectedItems?: T[];
+}
+
+export const INITIAL_TABLE_STATE: TableState<any> = {
+  gPage: {
+    data: [],
+    size: DEFAULT_SEARCH_LIMIT,
+    total: 0.
+  } as unknown as Page<any>,
+  dataLoading: false,
+  requestParams: DEFAULT_SEARCH_PARAMS,
+  selectedItems: []
+};

package/src/lib/table-state/reducers.ts

@@ -0,0 +1,126 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { ActionCreator, ReducerTypes, createReducer, on } from '@ngrx/store';
+import {
+  createGetPageTableAction,
+  createStaticFilterTableAction,
+  createDataLoadSuccessTableAction,
+  createDataLoadErrorTableAction,
+  createFilterPageTableAction,
+  createDestroyTableAction,
+  createSelectItemsTableAction,
+  createChangePageSizeTableAction,
+  createResetTableFilterAction,
+} from './actions';
+import { INITIAL_TABLE_STATE, TableState } from './models';
+
+export function createTablePageReducers<
+  T = any,
+  TState extends TableState<T> = TableState<T>
+>(
+  tableRepository: string,
+  initialState: TState = INITIAL_TABLE_STATE as unknown as TState,
+  ...ons: ReducerTypes<TState, readonly ActionCreator[]>[]
+) {
+  return createReducer(
+    initialState,
+    on(
+      createGetPageTableAction(tableRepository),
+      (state, { page, id, filter, sort }) => {
+        return {
+          ...state,
+          requestParams: {
+            ...state.requestParams,
+            filter: filter ?? state.requestParams.filter,
+            sort: sort ?? state.requestParams.sort,
+            id: id ?? state.requestParams.id,
+            page,
+          },
+          dataLoading: true,
+          submitted: true,
+        };
+      }
+    ),
+
+    on(createStaticFilterTableAction(tableRepository), (state, { filter }) => {
+      return {
+        ...state,
+        requestParams: {
+          ...state.requestParams,
+          filter: {
+            ...state.requestParams?.filter,
+            filter,
+          },
+        },
+      };
+    }),
+
+    on(createResetTableFilterAction(tableRepository), (state) => {
+      return {
+        ...state,
+        requestParams: {
+          ...state.requestParams,
+          filter: undefined,
+          page: 1
+        },
+      }
+    }),
+
+    on(
+      createDataLoadSuccessTableAction(tableRepository),
+      (state, { gPage }) => {
+        return {
+          ...state,
+          gPage,
+          dataLoading: false,
+        };
+      }
+    ),
+
+    on(createDataLoadErrorTableAction(tableRepository), (state, { error }) => {
+      return {
+        ...state,
+        error,
+        dataLoading: false,
+      };
+    }),
+
+    on(createFilterPageTableAction(tableRepository), (state, { filter }) => {
+      return {
+        ...state,
+        requestParams: {
+          ...state.requestParams,
+          filter: filter,
+          page: 1,
+        },
+        dataLoading: true,
+      };
+    }),
+
+    on(createDestroyTableAction(tableRepository), () => {
+      return {
+        ...(initialState as any),
+      };
+    }),
+
+    on(
+      createSelectItemsTableAction(tableRepository),
+      (state, { selectedItems }) => {
+        return {
+          ...state,
+          selectedItems,
+        };
+      }
+    ),
+
+    on(createChangePageSizeTableAction(tableRepository), (state, { size }) => {
+      return {
+        ...state,
+        requestParams: {
+          ...state.requestParams,
+          size,
+        }
+      }
+    }),
+    ...ons
+  );
+}

package/src/test-setup.ts

@@ -0,0 +1,8 @@
+// @ts-expect-error https://thymikee.github.io/jest-preset-angular/docs/getting-started/test-environment
+globalThis.ngJest = {
+  testEnvironmentOptions: {
+    errorOnUnknownElements: true,
+    errorOnUnknownProperties: true,
+  },
+};
+import 'jest-preset-angular/setup-jest';

package/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "useDefineForClassFields": false,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "extends": "../../../tsconfig.base.json",
+  "angularCompilerOptions": {
+    "enableI18nLegacyMessageIdFormat": false,
+    "strictInjectionParameters": true,
+    "strictInputAccessModifiers": true,
+    "strictTemplates": true
+  }
+}

package/tsconfig.lib.json

@@ -0,0 +1,17 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "types": []
+  },
+  "exclude": [
+    "src/**/*.spec.ts",
+    "src/test-setup.ts",
+    "jest.config.ts",
+    "src/**/*.test.ts"
+  ],
+  "include": ["src/**/*.ts"]
+}

package/tsconfig.lib.prod.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.lib.json",
+  "compilerOptions": {
+    "declarationMap": false
+  },
+  "angularCompilerOptions": {
+    "compilationMode": "partial"
+  }
+}

package/tsconfig.spec.json

@@ -0,0 +1,16 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "module": "commonjs",
+    "target": "es2016",
+    "types": ["jest", "node"]
+  },
+  "files": ["src/test-setup.ts"],
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}