@ngdux/data-model-common 1.4.0 → 3.0.0

package/lib/models/filtering-options.model.d.ts

@@ -1,34 +1,34 @@
-export declare enum FilteringLogic {
-    AND = "and",
-    OR = "or"
-}
-export declare const DEFAULT_FILTERING_LOGIC = FilteringLogic.AND;
-export declare enum FilteringOperator {
-    Equal = "eq",
-    NotEqual = "neq",
-    LessThan = "lt",
-    LessThanOrEqual = "lte",
-    GreaterThan = "gt",
-    GreaterThanOrEqual = "gte",
-    StartsWith = "startswith",
-    EndsWith = "endswith",
-    Contains = "contains"
-}
-export declare const DEFAULT_FILTERING_OPERATOR = FilteringOperator.Equal;
-/**
- * Defines the filter criterion for a single resource field.
- * Field, filter value and operator are required.
- */
-export interface FilteringField {
-    field: string;
-    value: string;
-    operator: FilteringOperator;
-}
-/**
- * The options required to filter resources by one or multiple fields.
- * Defines which fields to filter the resources by.
- */
-export interface FilteringOptions {
-    filters: Array<FilteringField | FilteringOptions>;
-    logic: FilteringLogic;
-}
+export declare enum FilteringLogic {
+    AND = "and",
+    OR = "or"
+}
+export declare const DEFAULT_FILTERING_LOGIC = FilteringLogic.AND;
+export declare enum FilteringOperator {
+    Equal = "eq",
+    NotEqual = "neq",
+    LessThan = "lt",
+    LessThanOrEqual = "lte",
+    GreaterThan = "gt",
+    GreaterThanOrEqual = "gte",
+    StartsWith = "startswith",
+    EndsWith = "endswith",
+    Contains = "contains"
+}
+export declare const DEFAULT_FILTERING_OPERATOR = FilteringOperator.Equal;
+/**
+ * Defines the filter criterion for a single resource field.
+ * Field, filter value and operator are required.
+ */
+export interface FilteringField {
+    field: string;
+    value: string;
+    operator: FilteringOperator;
+}
+/**
+ * The options required to filter resources by one or multiple fields.
+ * Defines which fields to filter the resources by.
+ */
+export interface FilteringOptions {
+    filters: Array<FilteringField | FilteringOptions>;
+    logic: FilteringLogic;
+}

package/lib/models/form-service.model.d.ts

@@ -1,20 +1,20 @@
-import { ValidationErrors } from '@angular/forms';
-import { Observable } from 'rxjs';
-export interface FieldError {
-    errors: ValidationErrors;
-    fieldName: string;
-    fieldIndex?: number;
-}
-export interface FieldErrors {
-    [key: string]: FieldError[] | FieldErrors;
-}
-export interface FormService<DTO, CREATE_DTO = DTO> {
-    loadResource(id: string): Observable<DTO>;
-    saveResource?(resource: DTO): Observable<DTO>;
-    deleteResource?(id: string): Observable<DTO>;
-    createResource?(resource: CREATE_DTO): Observable<DTO>;
-}
-export interface FormNotificationService<ERROR> {
-    onFormErrors: (errors: ERROR) => void;
-    onFormDelete: (id: string) => void;
-}
+import { ValidationErrors } from '@angular/forms';
+import { Observable } from 'rxjs';
+export interface FieldError {
+    errors: ValidationErrors;
+    fieldName: string;
+    fieldIndex?: number;
+}
+export interface FieldErrors {
+    [key: string]: FieldError[] | FieldErrors;
+}
+export interface FormService<DTO, CREATE_DTO = DTO> {
+    loadResource(id: string): Observable<DTO>;
+    saveResource?(resource: DTO): Observable<DTO>;
+    deleteResource?(id: string): Observable<DTO>;
+    createResource?(resource: CREATE_DTO): Observable<DTO>;
+}
+export interface FormNotificationService<ERROR> {
+    onFormErrors: (errors: ERROR) => void;
+    onFormDelete: (id: string) => void;
+}

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

@@ -1,24 +1,16 @@
-import { Observable } from 'rxjs';
-import { ErrorDto } from './error.dto';
-import { RequestOptions } from './request-options.model';
-export interface BulkOperationSuccess {
-    index: number;
-    response: unknown;
-}
-export interface ListService<T, S = T, Params = Record<string, string>> {
-    loadResources(options: RequestOptions<Params>): Observable<S[]>;
-    deleteResources?(resourceIds: string[]): Observable<Array<T | ErrorDto>>;
-    patchResources?(resourceIds: string[], resource: Partial<T>): Observable<Array<T | ErrorDto>>;
-}
-export interface ListNotificationService<E> {
-    /**
-     * @deprecated
-     * This method will be removed from this interface and the abstract effects will not call it anymore
-     */
-    openConfirmationDialog?: (data: {
-        message: string;
-        title: string;
-    }) => Observable<boolean>;
-    onListErrors: (errors: E) => void;
-    onListDelete: (ids: string[]) => void;
-}
+import { Observable } from 'rxjs';
+import { ErrorDto } from './error.dto';
+import { RequestOptions } from './request-options.model';
+export interface BulkOperationSuccess {
+    index: number;
+    response: unknown;
+}
+export interface ListService<T, S = T, Params = Record<string, string>> {
+    loadResources(options: RequestOptions<Params>): Observable<S[]>;
+    deleteResources?(resourceIds: string[]): Observable<Array<T | ErrorDto>>;
+    patchResources?(resourceIds: string[], resource: Partial<T>): Observable<Array<T | ErrorDto>>;
+}
+export interface ListNotificationService<E> {
+    onListErrors: (errors: E) => void;
+    onListDelete: (ids: string[]) => void;
+}

package/lib/models/paging-options.model.d.ts

@@ -1,11 +1,11 @@
-export declare const DEFAULT_PAGE = 1;
-export declare const DEFAULT_PAGE_SIZE = 10;
-export declare const DEFAULT_STORED_PAGES = 3;
-/**
- * The options required to make a resource request for paged resources.
- * This defines which page and how many resources per page to return.
- */
-export interface PagingOptions {
-    page: number;
-    pageSize: number;
-}
+export declare const DEFAULT_PAGE = 1;
+export declare const DEFAULT_PAGE_SIZE = 10;
+export declare const DEFAULT_STORED_PAGES = 3;
+/**
+ * The options required to make a resource request for paged resources.
+ * This defines which page and how many resources per page to return.
+ */
+export interface PagingOptions {
+    page: number;
+    pageSize: number;
+}

package/lib/models/request-options.model.d.ts

@@ -1,16 +1,16 @@
-import { FilteringOptions } from './filtering-options.model';
-import { PagingOptions } from './paging-options.model';
-import { SortingField, SortingOptions } from './sorting-options.model';
-export interface RequestOptions<Params = Record<string, string>> {
-    requestParameters?: Params;
-    pagingOptions: PagingOptions;
-    sortingOptions: SortingOptions;
-    filteringOptions: FilteringOptions;
-}
-export interface QueryOptionsDto {
-    filter?: FilteringOptions;
-    sort?: SortingField[];
-    page?: number;
-    pageSize?: number;
-}
-export declare function getDefaultRequestOptions<Params = Record<string, string>>(): RequestOptions<Params>;
+import { FilteringOptions } from './filtering-options.model';
+import { PagingOptions } from './paging-options.model';
+import { SortingField } from './sorting-options.model';
+export interface RequestOptions<Params = Record<string, string>> {
+    requestParameters?: Params;
+    pagingOptions: PagingOptions;
+    sortingOptions: SortingField[];
+    filteringOptions: FilteringOptions;
+}
+export interface QueryOptionsDto {
+    filter?: FilteringOptions;
+    sort?: SortingField[];
+    page?: number;
+    pageSize?: number;
+}
+export declare function getDefaultRequestOptions<Params = Record<string, string>>(): RequestOptions<Params>;

package/lib/models/request-state.model.d.ts

@@ -1,6 +1,6 @@
-export declare enum RequestState {
-    IDLE = "IDLE",
-    IN_PROGRESS = "IN_PROGRESS",
-    FAILURE = "FAILURE",
-    SUCCESS = "SUCCESS"
-}
+export declare enum RequestState {
+    IDLE = "IDLE",
+    IN_PROGRESS = "IN_PROGRESS",
+    FAILURE = "FAILURE",
+    SUCCESS = "SUCCESS"
+}

package/lib/models/sorting-options.model.d.ts

@@ -1,19 +1,14 @@
-export declare enum SortingDirection {
-    ASCENDING = "asc",
-    DESCENDING = "desc",
-    NONE = ""
-}
-export declare const DEFAULT_SORTING_ORDER = SortingDirection.ASCENDING;
-/**
- * Defines the sorting criterion for a single resource field.
- * Name and sorting order are required.
- */
-export interface SortingField {
-    field: string;
-    direction: SortingDirection;
-}
-/**
- * The options required to sort resources by one or multiple fields.
- * Defines which fields to sort the resources by.
- */
-export type SortingOptions = Record<string, SortingField>;
+export declare enum SortingDirection {
+    ASCENDING = "asc",
+    DESCENDING = "desc",
+    NONE = ""
+}
+export declare const DEFAULT_SORTING_ORDER = SortingDirection.ASCENDING;
+/**
+ * Defines the sorting criterion for a single resource field.
+ * Name and sorting order are required.
+ */
+export interface SortingField {
+    field: string;
+    direction: SortingDirection;
+}

package/package.json

@@ -1,63 +1,11 @@
 {
   "name": "@ngdux/data-model-common",
-  "version": "1.4.0",
+  "version": "3.0.0",
   "peerDependencies": {
-    "@angular/forms": "^15.0.0",
-    "rxjs": "^7.0.0"
+    "@angular/forms": "",
+    "rxjs": ""
   },
-  "default": {
-    "name": "@ngdux/data-model-common",
-    "version": "1.3.2",
-    "peerDependencies": {
-      "@angular/forms": "^15.0.0",
-      "rxjs": "^7.0.0"
-    },
-    "default": {
-      "name": "@ngdux/data-model-common",
-      "version": "1.3.1",
-      "peerDependencies": {
-        "@angular/forms": "^15.0.0",
-        "rxjs": "^7.0.0"
-      },
-      "default": {
-        "name": "@ngdux/data-model-common",
-        "version": "1.3.0",
-        "peerDependencies": {
-          "@angular/forms": "^15.0.0",
-          "rxjs": "^7.0.0"
-        },
-        "default": {
-          "name": "@ngdux/data-model-common",
-          "version": "1.2.1",
-          "peerDependencies": {
-            "@angular/forms": "^15.0.0",
-            "rxjs": "^7.0.0"
-          },
-          "default": {
-            "name": "@ngdux/data-model-common",
-            "version": "1.2.0",
-            "default": {
-              "name": "@ngdux/data-model-common",
-              "version": "1.1.1",
-              "default": {
-                "name": "@ngdux/data-model-common",
-                "version": "1.1.0"
-              }
-            },
-            "peerDependencies": {
-              "@angular/forms": "^15.0.0",
-              "rxjs": "^7.0.0"
-            }
-          }
-        }
-      }
-    }
-  },
-  "module": "fesm2015/ngdux-data-model-common.mjs",
-  "es2020": "fesm2020/ngdux-data-model-common.mjs",
-  "esm2020": "esm2020/ngdux-data-model-common.mjs",
-  "fesm2020": "fesm2020/ngdux-data-model-common.mjs",
-  "fesm2015": "fesm2015/ngdux-data-model-common.mjs",
+  "module": "fesm2022/ngdux-data-model-common.mjs",
   "typings": "index.d.ts",
   "exports": {
     "./package.json": {
@@ -65,19 +13,15 @@
     },
     ".": {
       "types": "./index.d.ts",
-      "esm2020": "./esm2020/ngdux-data-model-common.mjs",
-      "es2020": "./fesm2020/ngdux-data-model-common.mjs",
-      "es2015": "./fesm2015/ngdux-data-model-common.mjs",
-      "node": "./fesm2015/ngdux-data-model-common.mjs",
-      "default": "./fesm2020/ngdux-data-model-common.mjs"
+      "esm2022": "./esm2022/ngdux-data-model-common.mjs",
+      "esm": "./esm2022/ngdux-data-model-common.mjs",
+      "default": "./fesm2022/ngdux-data-model-common.mjs"
     },
     "./test": {
       "types": "./test/index.d.ts",
-      "esm2020": "./esm2020/test/ngdux-data-model-common-test.mjs",
-      "es2020": "./fesm2020/ngdux-data-model-common-test.mjs",
-      "es2015": "./fesm2015/ngdux-data-model-common-test.mjs",
-      "node": "./fesm2015/ngdux-data-model-common-test.mjs",
-      "default": "./fesm2020/ngdux-data-model-common-test.mjs"
+      "esm2022": "./esm2022/test/ngdux-data-model-common-test.mjs",
+      "esm": "./esm2022/test/ngdux-data-model-common-test.mjs",
+      "default": "./fesm2022/ngdux-data-model-common-test.mjs"
     }
   },
   "sideEffects": false,

package/test/index.d.ts

@@ -1,3 +1,3 @@
-import * as commonFixture from './lib/common.fixture';
-import * as errorFixture from './lib/error.fixture';
-export { commonFixture, errorFixture };
+import * as commonFixture from './lib/common.fixture';
+import * as errorFixture from './lib/error.fixture';
+export { commonFixture, errorFixture };

package/test/lib/common.fixture.d.ts

@@ -1,66 +1,67 @@
-import { Casing } from '@faker-js/faker';
-export type RemoveReadonly<T> = {
-    -readonly [P in keyof T]: T[P];
-};
-export declare const DEFAULT_RESOURCE_COLLECTION_SIZE = 50;
-export declare function getBoolean(): boolean;
-export declare function getPositiveNumber(): number;
-export declare function getNumberInRange(from: number, to: number): number;
-export declare function getWord(): string;
-export declare function getUniqueWord(): string;
-export declare function getFirstName(): string;
-export declare function getLastName(): string;
-export declare function getJobTitle(): string;
-export declare function getPhoneNumber(): string;
-export declare function getAvatar(): string;
-export declare function getLogo(): string;
-export declare function getColor(): string;
-export declare function getFont(): string;
-export declare function getGoogleFont(): string;
-export declare function getEmail(firstName?: string, lastName?: string): string;
-export declare function getElementFromArray<T>(array: T[]): T;
-export declare function getElementsFromArray<T>(array: T[], nbOfElements?: number): T[];
-export declare function getElementFromEnum<T>(enumeration: Record<string, T>): T;
-export declare function getElementsFromEnum<T>(enumeration: Record<string, T>, nbOfElements?: number): T[];
-export declare function getEnumValue<T extends Record<keyof T, string>>(enumObj: T): T[keyof T];
-/**
- * Return a random object key or path.
- * Ex.:
- * object = { a: { b: { c: 3 }}}
- * return 'a.b.c'
- * @param object any object
- * @param path string
- */
-export declare function getLatitude(): number;
-export declare function getLongitude(): number;
-export declare function getStreetName(): string;
-export declare function getZipCode(): string;
-export declare function getCity(): string;
-export declare function getCountryCode(): string;
-export declare function getUrl(): string;
-export declare function getDomainName(): string;
-export declare function getCompanyName(): string;
-export declare function getSemverVersion(): string;
-export declare function getLocale(): string;
-export declare function getYear(): number;
-export declare function getIso8601Date(): string;
-export declare function getFutureIso8601Date(): string;
-export declare function getTime(): string;
-export declare function getRecentDate(days?: number, refDate?: Date): Date;
-export declare function getSoonDate(days?: number, refDate?: Date): Date;
-export declare function getFewDaysAgoDate(nbOfDays?: number): Date;
-export declare function getInNextDaysDate(nbOfDays?: number): Date;
-export declare function getUuid(): string;
-export declare function getAlpha(count: number, casing?: Casing): string;
-export declare function getAlphaNumeric(nOfCharacters?: number): string;
-export declare function getCurrencyCode(): string;
-export declare function getFinanceAmount(): number;
-export declare function getSentence(): string;
-export declare function getParagraph(): string;
-export declare function getTag(): string;
-export declare function getTags(n?: number): string[];
-export declare function getVehicleName(): string;
-export declare function getVehicleManufacturer(): string;
-export declare function getVehicleVin(): string;
-export declare function getVehicleColor(): string;
-export declare function getVehicleModel(): string;
+import { Casing } from '@faker-js/faker';
+export type RemoveReadonly<T> = {
+    -readonly [P in keyof T]: T[P];
+};
+export declare const DEFAULT_RESOURCE_COLLECTION_SIZE = 50;
+export declare function getBoolean(): boolean;
+export declare function getPositiveNumber(): number;
+export declare function getNumberInRange(from: number, to: number): number;
+export declare function getWord(): string;
+export declare function getUniqueWord(): string;
+export declare function getFirstName(): string;
+export declare function getLastName(): string;
+export declare function getJobTitle(): string;
+export declare function getPhoneNumber(): string;
+export declare function getAvatar(): string;
+export declare function getLogo(): string;
+export declare function getColor(): string;
+export declare function getHexColor(): string;
+export declare function getFont(): string;
+export declare function getGoogleFont(): string;
+export declare function getEmail(firstName?: string, lastName?: string): string;
+export declare function getElementFromArray<T>(array: T[]): T;
+export declare function getElementsFromArray<T>(array: T[], nbOfElements?: number): T[];
+export declare function getElementFromEnum<T>(enumeration: Record<string, T>): T;
+export declare function getElementsFromEnum<T>(enumeration: Record<string, T>, nbOfElements?: number): T[];
+export declare function getEnumValue<T extends Record<keyof T, string>>(enumObj: T): T[keyof T];
+/**
+ * Return a random object key or path.
+ * Ex.:
+ * object = { a: { b: { c: 3 }}}
+ * return 'a.b.c'
+ * @param object any object
+ * @param path string
+ */
+export declare function getLatitude(): number;
+export declare function getLongitude(): number;
+export declare function getStreetName(): string;
+export declare function getZipCode(): string;
+export declare function getCity(): string;
+export declare function getCountryCode(): string;
+export declare function getUrl(): string;
+export declare function getDomainName(): string;
+export declare function getCompanyName(): string;
+export declare function getSemverVersion(): string;
+export declare function getLocale(): string;
+export declare function getYear(): number;
+export declare function getIso8601Date(): string;
+export declare function getFutureIso8601Date(): string;
+export declare function getTime(): string;
+export declare function getRecentDate(days?: number, refDate?: Date): Date;
+export declare function getSoonDate(days?: number, refDate?: Date): Date;
+export declare function getFewDaysAgoDate(nbOfDays?: number): Date;
+export declare function getInNextDaysDate(nbOfDays?: number): Date;
+export declare function getUuid(): string;
+export declare function getAlpha(count: number, casing?: Casing): string;
+export declare function getAlphaNumeric(nOfCharacters?: number): string;
+export declare function getCurrencyCode(): string;
+export declare function getFinanceAmount(): number;
+export declare function getSentence(): string;
+export declare function getParagraph(): string;
+export declare function getTag(): string;
+export declare function getTags(n?: number): string[];
+export declare function getVehicleName(): string;
+export declare function getVehicleManufacturer(): string;
+export declare function getVehicleVin(): string;
+export declare function getVehicleColor(): string;
+export declare function getVehicleModel(): string;

package/test/lib/error.fixture.d.ts

@@ -1,2 +1,2 @@
-import { ErrorDto } from '@ngdux/data-model-common';
-export declare function createErrorDto(): ErrorDto;
+import { ErrorDto } from '@ngdux/data-model-common';
+export declare function createErrorDto(): ErrorDto;