@smartsoft001/models 2.21.0 → 2.23.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@smartsoft001/models",
   "type": "commonjs",
   "dependencies": {
-    "@smartsoft001/utils": "2.21.0",
+    "@smartsoft001/utils": "^2.23.0",
     "flatted": "3.2.9",
     "guid-typescript": "^1.0.9",
     "lodash": "4.17.21",
@@ -11,7 +11,7 @@
     "rxjs": "^7.8.1",
     "tslib": "^2.3.0"
   },
-  "version": "2.21.0",
-  "main": "./index.cjs",
+  "version": "2.23.0",
+  "main": "./src/index.js",
   "typings": "./src/index.d.ts"
-}
+}

package/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./lib/symbols";
+export * from './lib/interfaces';
+export * from './lib/decorators';
+export * from './lib/utils';

package/src/lib/decorators/field/field.decorator.d.ts

@@ -0,0 +1,4 @@
+import 'reflect-metadata';
+import { IFieldOptions } from "../../interfaces";
+export declare const Field: typeof FieldDecorator;
+export declare function FieldDecorator(options?: IFieldOptions): <T>(target: T, key: string) => void;

package/src/lib/decorators/index.d.ts

@@ -0,0 +1,2 @@
+export * from './model/model.decorator';
+export * from './field/field.decorator';

package/src/lib/decorators/model/model.decorator.d.ts

@@ -0,0 +1,4 @@
+import 'reflect-metadata';
+import { IModelOptions } from "../../interfaces";
+export declare const Model: typeof ModelDecorator;
+export declare function ModelDecorator(options?: IModelOptions): <T>(target: any) => void;

package/src/lib/interfaces.d.ts

@@ -0,0 +1,141 @@
+import { Observable } from "rxjs";
+export declare enum FieldTypeDef {
+    address = "address",
+    currency = "currency",
+    date = "date",
+    dateTime = "dateTime",
+    dateWithEdit = "dateWithEdit",
+    email = "email",
+    enum = "enum",
+    file = "file",
+    flag = "flag",
+    int = "int",
+    nip = "nip",
+    object = "object",
+    array = "array",
+    password = "password",
+    radio = "radio",
+    text = "text",
+    strings = "strings",
+    ints = "ints",
+    longText = "longText",
+    color = "color",
+    logo = "logo",
+    check = "check",
+    phoneNumber = "phoneNumber",
+    phoneNumberPl = "phoneNumberPl",
+    pesel = "pesel",
+    pdf = "pdf",
+    video = "video",
+    attachment = "attachment",
+    dateRange = "dateRange",
+    image = "image",
+    float = "float"
+}
+export declare const FieldType: typeof FieldTypeDef;
+export interface ISpecification {
+    criteria: any;
+}
+export interface IModelFilter {
+    label?: string;
+    fieldType?: FieldTypeDef;
+    key: string;
+    type: '=' | '!=' | '>=' | '<=' | '<' | '>' | '~=';
+    possibilities$?: Observable<{
+        id: any;
+        text: string;
+    }[]>;
+}
+export interface IModelStep {
+    number: number;
+    name: string;
+}
+export interface IModelMetadata {
+    titleKey?: string;
+    permissions?: Array<string>;
+    filters?: Array<IModelFilter>;
+}
+export interface IFieldMetadata extends IFieldModifyMetadata {
+    type?: FieldTypeDef;
+    classType?: any;
+    possibilities?: Array<any> | any;
+}
+export interface IFieldModifyMetadata {
+    required?: boolean;
+    focused?: boolean;
+    confirm?: boolean;
+    permissions?: Array<string>;
+    unique?: boolean | IFieldUniqueMetadata;
+    defaltValue?: () => any;
+    enabled?: ISpecification;
+    hide?: boolean;
+    /**
+     * @desc - Model step configuration
+     */
+    step?: IModelStep;
+}
+export interface IFieldEditMetadata extends IFieldModifyMetadata {
+    multi?: boolean;
+}
+export interface IFieldListMetadata {
+    order?: number;
+    filter?: boolean;
+    permissions?: Array<string>;
+    /**
+     * Configuration for dynamic list table data
+     * @param {string} dynamic.headerKey - column header object key
+     * @param {string} dynamic.rowKey - column row value object key
+     */
+    dynamic?: {
+        headerKey: string;
+        rowKey: string;
+    };
+}
+export interface IFieldDetailsMetadata {
+    order?: number;
+    permissions?: Array<string>;
+    enabled?: ISpecification;
+}
+export interface IModelOptions {
+    titleKey?: string;
+    filters?: Array<IModelFilter>;
+    create?: IModelModeOptions;
+    update?: IModelModeOptions;
+    list?: IModelModeOptions;
+    details?: IModelModeOptions;
+    remove?: IModelModeOptions;
+    customs?: Array<IModelModeOptionsCustom>;
+    /**
+     * @desc - Allow export field data
+     */
+    export?: boolean;
+    /**
+     * @desc - Allow import field data
+     */
+    import?: boolean;
+}
+export interface IModelModeOptions {
+    permissions?: Array<string>;
+    enabled?: ISpecification;
+}
+export interface IModelModeOptionsCustom extends IModelModeOptions {
+    mode: string;
+}
+export interface IFieldOptions extends IFieldMetadata {
+    create?: IFieldModifyMetadata | boolean;
+    update?: IFieldEditMetadata | boolean;
+    list?: IFieldListMetadata | boolean;
+    details?: IFieldDetailsMetadata | boolean;
+    customs?: Array<IModelMetadataCustom>;
+    search?: boolean;
+    info?: string;
+}
+export interface IModelMetadataCustom extends IModelMetadata {
+    mode: string;
+}
+export interface IFieldUniqueMetadata {
+    withFields?: Array<string>;
+}
+export interface IFieldCustomMetadata extends IFieldModifyMetadata, IFieldListMetadata {
+    mode: string;
+}

package/src/lib/symbols.d.ts

@@ -0,0 +1,2 @@
+export declare const SYMBOL_MODEL: unique symbol;
+export declare const SYMBOL_FIELD: unique symbol;

package/src/lib/utils.d.ts

@@ -0,0 +1,11 @@
+import { IFieldOptions, IModelOptions } from "./interfaces";
+export declare function getModelFieldKeys<T>(type: T): Array<string>;
+export declare function getModelFieldOptions<T>(instance: T, fieldKey: string): IFieldOptions;
+export declare function getModelFieldsWithOptions<T>(instance: T): Array<{
+    key: string;
+    options: IFieldOptions;
+}>;
+export declare function getModelOptions(type: any): IModelOptions;
+export declare function isModel<T>(instance: T): boolean;
+export declare function getInvalidFields<T>(instance: T, mode: "create" | "update" | string, permissions: Array<string>): Array<string>;
+export declare function castModel<T>(instance: T, mode: "create" | "update" | string, permissions: Array<string>): void;