@verisoft/core 17.0.0

package/.eslintrc.json

@@ -0,0 +1,43 @@
+{
+  "extends": ["../../../.eslintrc.base.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "extends": [
+        "plugin:@nx/angular",
+        "plugin:@angular-eslint/template/process-inline-templates"
+      ],
+      "rules": {
+        "@angular-eslint/directive-selector": [
+          "error",
+          {
+            "type": "attribute",
+            "prefix": "v",
+            "style": "camelCase"
+          }
+        ],
+        "@angular-eslint/component-selector": [
+          "error",
+          {
+            "type": "element",
+            "prefix": "v",
+            "style": "kebab-case"
+          }
+        ]
+      }
+    },
+    {
+      "files": ["*.html"],
+      "extends": ["plugin:@nx/angular-template"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": "error"
+      }
+    }
+  ]
+}

package/README.md

@@ -0,0 +1,7 @@
+# core
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test core` to execute the unit tests.

package/jest.config.ts

@@ -0,0 +1,22 @@
+/* eslint-disable */
+export default {
+  displayName: 'core',
+  preset: '../../../jest.preset.js',
+  setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
+  coverageDirectory: '../../../coverage/src/libs/core',
+  transform: {
+    '^.+\\.(ts|mjs|js|html)$': [
+      'jest-preset-angular',
+      {
+        tsconfig: '<rootDir>/tsconfig.spec.json',
+        stringifyContentPathRegex: '\\.(html|svg)$',
+      },
+    ],
+  },
+  transformIgnorePatterns: ['node_modules/(?!.*\\.mjs$)'],
+  snapshotSerializers: [
+    'jest-preset-angular/build/serializers/no-ng-attributes',
+    'jest-preset-angular/build/serializers/ng-snapshot',
+    'jest-preset-angular/build/serializers/html-comment',
+  ],
+};

package/ng-package.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "../../../node_modules/ng-packagr/ng-package.schema.json",
+  "dest": "../../../dist/src/libs/core",
+  "lib": {
+    "entryFile": "src/index.ts"
+  }
+}

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@verisoft/core",
+  "version": "17.0.0",
+  "peerDependencies": {
+    "@angular/common": "^17.3.0",
+    "@angular/core": "^17.3.0",
+    "rxjs": "~7.8.0"
+  },
+  "dependencies": {},
+  "sideEffects": false
+}

package/project.json

@@ -0,0 +1,36 @@
+{
+  "name": "core",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "src/libs/core/src",
+  "prefix": "lib",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "build": {
+      "executor": "@nx/angular:package",
+      "outputs": ["{workspaceRoot}/dist/{projectRoot}"],
+      "options": {
+        "project": "src/libs/core/ng-package.json"
+      },
+      "configurations": {
+        "production": {
+          "tsConfig": "src/libs/core/tsconfig.lib.prod.json"
+        },
+        "development": {
+          "tsConfig": "src/libs/core/tsconfig.lib.json"
+        }
+      },
+      "defaultConfiguration": "production"
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "src/libs/core/jest.config.ts"
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint"
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+export * from './lib/base/models/base-http.models';
+export * from './lib/base/models/all-item.datasource';
+export * from './lib/models/lazy-load.model';
+
+export * from './lib/services/base-http.service';
+
+export * from './lib/utils/clear.utils';
+export * from './lib/utils/keyOrFn.utils';

package/src/lib/base/models/all-item.datasource.ts

@@ -0,0 +1,5 @@
+import { Observable } from 'rxjs';
+
+export interface AllItemDatasource<T> {
+  getData$: () => Observable<T[]>
+}

package/src/lib/base/models/base-http.models.ts

@@ -0,0 +1,96 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { HttpParams, HttpResponse } from '@angular/common/http';
+import { InjectionToken } from '@angular/core';
+
+export const BASE_URL_PATH = new InjectionToken("BASE_URL_PATH");
+
+export function requestParamsToHttpParams<T>(
+  requestParams: RequestParams<T>,
+  httpParams: HttpParams = new HttpParams()
+): HttpParams {
+  httpParams = httpParams
+    .append('Limit', requestParams.size.toString())
+    .append('Offset', (requestParams.page * requestParams.size).toString());
+  if (requestParams.id != '' && requestParams.id != undefined) {
+    httpParams = httpParams.append('Id', requestParams.id as any);
+  }
+
+  httpParams = getFilter(requestParams, httpParams);
+  httpParams = getSort(requestParams, httpParams);
+
+  return httpParams;
+}
+
+function getFilter<T>(
+  requestParams: RequestParams<any>,
+  httpParams: HttpParams
+): HttpParams {
+  if (!requestParams.filter) {
+    return httpParams;
+  }
+  Object.keys(requestParams?.filter).forEach((key) => {
+    if (requestParams.filter?.[key as keyof Partial<T>]) {
+      httpParams = httpParams.append(
+        'Filter.' + key,
+        requestParams.filter?.[key as keyof Partial<T>]
+      );
+    }
+  });
+  return httpParams;
+}
+
+function getSort(
+  requestParams: RequestParams<any>,
+  httpParams: HttpParams
+): HttpParams {
+  if (!requestParams.sort) {
+    return httpParams;
+  }
+
+  requestParams.sort?.forEach((sort) => {
+    httpParams = httpParams
+      .append('Sort.Field', sort.field)
+      .append('Sort.Direction', sort.direction === -1 ? 'Desc' : 'Asc');
+  });
+  return httpParams;
+}
+
+export function saveFile(response: HttpResponse<Blob>) {
+  const fileName = response.headers
+    .get('Content-Disposition')
+    ?.split(';')[1]
+    .split('=')[1];
+  const blob: Blob = response.body as Blob;
+  const a = document.createElement('a');
+  a.download = fileName ?? 'undefined';
+  a.href = window.URL.createObjectURL(blob);
+  a.click();
+}
+
+export declare interface Sort<T> {
+  field: string;
+  direction: number;
+}
+
+export interface RequestParams<T> {
+  page: number;
+  size: number;
+  id?: string;
+  filter?: Partial<T>;
+  sort?: Sort<T>[];
+}
+
+export interface Page<T> {
+  data: T[];
+  total: number;
+  size: number;
+  number: number;
+}
+
+export const DEFAULT_SEARCH_LIMIT = 50;
+
+export const DEFAULT_SEARCH_PARAMS: RequestParams<any> = {
+  page: 0,
+  size: DEFAULT_SEARCH_LIMIT,
+  id: '',
+};

package/src/lib/base/models/table-datasource.models.ts

@@ -0,0 +1,9 @@
+import { RequestParams } from "./base-http.models";
+
+export const DEFAULT_SEARCH_LIMIT = 50;
+
+export const DEFAULT_SEARCH_PARAMS: RequestParams<any> = {
+  page: 0,
+  size: DEFAULT_SEARCH_LIMIT,
+  id: '',
+};

package/src/lib/models/lazy-load.model.ts

@@ -0,0 +1,4 @@
+export interface LazyLoad {
+    offset: number;
+    limit: number;
+}

package/src/lib/services/base-http.service.ts

@@ -0,0 +1,104 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { HttpClient } from '@angular/common/http';
+import { Inject, Injectable } from '@angular/core';
+import { map, Observable } from 'rxjs';
+import {
+  BASE_URL_PATH,
+  Page,
+  RequestParams,
+  requestParamsToHttpParams,
+} from '../base/models/base-http.models';
+import { DEFAULT_SEARCH_PARAMS } from '../base/models/table-datasource.models';
+import { LazyLoad } from '../models/lazy-load.model';
+import { ClearUtils } from '../utils/clear.utils';
+
+@Injectable({ providedIn: 'root' })
+export abstract class BaseHttpService<T, TKey = number> {
+  basePath = '';
+  entityName!: string;
+  constructor(
+    readonly http: HttpClient,
+    @Inject(BASE_URL_PATH) basePath: string
+  ) {
+    this.basePath = basePath;
+  }
+  fetchList(requestParams: RequestParams<T>): Observable<Page<T>> {
+    const params = requestParamsToHttpParams<T>(requestParams);
+    return this.http
+      .get<Page<T>>(this.basePath + this.entityName, { params })
+      .pipe(
+        map((response: Page<T>) => {
+          response.size = requestParams.size;
+          return response;
+        })
+      );
+  }
+
+  getData$(
+    entityName: keyof T,
+    searchTerm?: string | undefined,
+    lazyLoad?: LazyLoad
+  ): Observable<T[]> {
+    const filter: Partial<T> = { [entityName]: searchTerm } as Partial<T>;
+    const params = lazyLoad
+      ? requestParamsToHttpParams<T>({
+          ...DEFAULT_SEARCH_PARAMS,
+          page: Math.round(lazyLoad.offset / lazyLoad.limit),
+          size: lazyLoad.limit,
+          filter,
+        })
+      : requestParamsToHttpParams<T>({
+          ...DEFAULT_SEARCH_PARAMS,
+          filter,
+        });
+
+    return this.http.get<T[]>(this.basePath + this.entityName, { params });
+  }
+
+  get(id: TKey, url?: string): Observable<T> {
+    const newUrl = url ? `/${url}/${id}` : `/${id}`;
+    return this.http.get<T>(newUrl);
+  }
+
+  post(entity: Partial<T>, url?: string): Observable<T> {
+    const newUrl = url ? this.basePath + `/${url}` : this.basePath;
+    return this.http.post<T>(newUrl, entity);
+  }
+
+  put(id: TKey, entity: Partial<T>, url?: string): Observable<T> {
+    const newUrl = this.basePath + (url ? `/${url}/${id}` : `/${id}`);
+    return this.http.put<T>(newUrl, entity);
+  }
+
+  removeRange(entity: string[]) {
+    return this.http.delete(this.basePath + this.entityName, {
+      body: entity,
+    });
+  }
+
+  createParams<T>(requestParams: RequestParams<T>): any {
+    const sorter = this.createSorter(requestParams);
+    const filter = JSON.parse(JSON.stringify(requestParams.filter));
+    const transformedFilter = filter;
+    ClearUtils.recursiveObjectAttributesDeletation(transformedFilter);
+    return {
+      paging: {
+        page: requestParams.page,
+        size: requestParams.size,
+      },
+      ...(sorter && { sorting: sorter }),
+      ...(transformedFilter && { filter: transformedFilter }),
+    };
+  }
+
+  private createSorter<T>(requestParams: RequestParams<T>) {
+    if (requestParams?.sort?.length === 1) {
+      const sorter = requestParams.sort[0];
+      return {
+        sortField: sorter.field,
+        sortOrder: sorter.direction,
+      };
+    }
+    return null;
+  }
+}

package/src/lib/utils/clear.utils.ts

@@ -0,0 +1,53 @@
+export class ClearUtils {
+
+  static recursiveObjectAttributesTransformation(obj: any): void {
+    ClearUtils.recursiveObjectAttributesTraversal(
+      obj,
+      ClearUtils.transformEmptyStringToNullStringFn
+    );
+  }
+  static recursiveObjectAttributesDeletation(obj: any): void {
+    ClearUtils.recursiveObjectAttributesTraversal(
+      obj,
+      ClearUtils.deleteEmptyStringToNullStringFn
+    );
+  }
+
+  static transformEmptyStringToNullStringFn(obj: any, key: string) {
+    if (typeof obj[key] === 'string' && obj[key] === '') {
+      obj[key] = null;
+    }
+  }
+  static deleteEmptyStringToNullStringFn(obj: any, key: string) {
+    if (obj[key] === '' || obj[key] === null || obj[key] === undefined) {
+      delete obj[key]
+    }
+  }
+
+
+  static recursiveObjectAttributesTraversal(
+    obj: any,
+    transformationFn: (obj: any, key: string) => void
+  ) {
+    if (
+      obj === null ||
+      transformationFn === null ||
+      typeof transformationFn !== 'function'
+    ) {
+      return;
+    }
+
+    Object.keys(obj).forEach((key) => {
+      transformationFn(obj, key);
+
+      if (typeof obj[key] === 'object') {
+        this.recursiveObjectAttributesTraversal(obj[key], transformationFn);
+
+        if (!Object.keys(obj[key]).length) {
+          delete obj[key];
+        }
+      }
+    });
+  }
+
+}

package/src/lib/utils/keyOrFn.utils.ts

@@ -0,0 +1,15 @@
+export function keyOrFn(keyOrFn: ((row: any) => string | undefined) | string, row: any){
+    if (keyOrFn instanceof Function) {
+        return keyOrFn(row);
+    }
+    else if (typeof keyOrFn === 'string') {
+        const value = row[keyOrFn];
+        if (value){
+            return value;
+        }
+    }
+    else if (typeof keyOrFn === 'boolean') {
+      return keyOrFn;
+  }
+    return '';
+}

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"
+  ]
+}