@quatrain/core 0.4.3 → 0.5.0

package/lib/properties/BaseProperty.d.ts

@@ -2,7 +2,7 @@ import { DataObjectClass } from '../components/types/DataObjectClass';
 import { AbstractPropertyType } from './types/AbstractPropertyType';
 import { PropertyClassType } from './types/PropertyClassType';
 import { PropertyHTMLType } from './types/PropertyHTMLType';
-export declare type EventTypes = typeof BaseProperty.EVENT_ONCHANGE | typeof BaseProperty.EVENT_ONDELETE;
+export type EventTypes = typeof BaseProperty.EVENT_ONCHANGE | typeof BaseProperty.EVENT_ONDELETE;
 export interface BasePropertyType extends AbstractPropertyType {
     parent?: DataObjectClass<any>;
     protected?: boolean;
@@ -37,4 +37,5 @@ export declare class BaseProperty implements PropertyClassType {
     val(transform?: any): any;
     protected _enable(value: boolean | undefined): boolean;
     toJSON(): any;
+    clone(): any;
 }

package/lib/properties/BaseProperty.js

@@ -43,7 +43,7 @@ class BaseProperty {
             this._value !== null &&
             this._value !== this._defaultValue &&
             this._protected === true) {
-            throw new Error(`Value already defined as '${this._value}' and protected from change`);
+            throw new Error(`Value '${this._name}' already defined as '${this._value}' and protected from change`);
         }
         this._value = value;
         if (this._events[BaseProperty.EVENT_ONCHANGE]) {
@@ -60,6 +60,10 @@ class BaseProperty {
     toJSON() {
         return this._value;
     }
+    clone() {
+        const cloned = Object.create(Object.getPrototypeOf(this), Object.getOwnPropertyDescriptors(this));
+        return cloned;
+    }
 }
 exports.BaseProperty = BaseProperty;
 BaseProperty.TYPE = 'any';

package/lib/properties/CollectionProperty.d.ts

@@ -4,21 +4,22 @@ import { Filter } from '../backends/Filter';
 import { ObjectUri } from '../components/ObjectUri';
 import { returnAs } from '../backends/Query';
 import { DataObjectClass } from '../components/types/DataObjectClass';
+import { BaseObjectCore } from '../components';
 export interface CollectionPropertyType extends BasePropertyType {
-    instanceOf?: Function | string | Object;
+    instanceOf: typeof BaseObjectCore;
     backend?: any;
     parentKey?: string;
 }
 export declare class CollectionProperty extends BaseProperty {
     static TYPE: string;
     protected _value: Array<any> | Array<DataObjectClass<any>> | Array<ObjectUri> | undefined;
-    protected _instanceOf: any;
+    protected _instanceOf: typeof BaseObjectCore;
     protected _backend: any;
     protected _parentKey: string;
     protected _query: Query<any>;
     protected _filters: Filter[] | Filter | undefined;
     constructor(config: CollectionPropertyType);
-    protected _setQuery(filters?: Filter[]): any;
+    protected _setQuery(filters?: Filter[]): Query<typeof BaseObjectCore>;
     set(value: Array<any>): this;
     /**
      * get objects matching collection class and filters

package/lib/properties/HashProperty.d.ts

@@ -1,5 +1,5 @@
 import { StringProperty, StringPropertyType } from './StringProperty';
-export declare type HashPropertyAlgos = typeof HashProperty.ALGORITHM_MD5 | typeof HashProperty.ALGORITHM_SHA1 | typeof HashProperty.ALGORITHM_SHA256;
+export type HashPropertyAlgos = typeof HashProperty.ALGORITHM_MD5 | typeof HashProperty.ALGORITHM_SHA1 | typeof HashProperty.ALGORITHM_SHA256;
 export interface HashPropertyType extends StringPropertyType {
     algorithm?: HashPropertyAlgos;
     salt?: string;

package/lib/properties/NumberProperty.d.ts

@@ -1,6 +1,6 @@
 import { BaseProperty, BasePropertyType } from './BaseProperty';
-export declare type NumberSign = typeof NumberProperty.TYPE_SIGNED | typeof NumberProperty.TYPE_UNSIGNED;
-export declare type NumberType = typeof NumberProperty.TYPE_INTEGER | typeof NumberProperty.TYPE_FLOAT;
+export type NumberSign = typeof NumberProperty.TYPE_SIGNED | typeof NumberProperty.TYPE_UNSIGNED;
+export type NumberType = typeof NumberProperty.TYPE_INTEGER | typeof NumberProperty.TYPE_FLOAT;
 export interface NumberPropertyType extends BasePropertyType {
     minVal?: number;
     maxVal?: number;

package/lib/properties/ObjectProperty.d.ts

@@ -1,13 +1,15 @@
-import { BaseObjectClass } from '../components/types/BaseObjectClass';
+import { BaseObject } from '../components/BaseObject';
+import { ObjectUri } from '../components/ObjectUri';
 import { BaseProperty, BasePropertyType } from './BaseProperty';
+import { Proxy } from '../components/types/ProxyConstructor';
 export interface ObjectPropertyType extends BasePropertyType {
     instanceOf?: Function | string | Object;
 }
 export declare class ObjectProperty extends BaseProperty {
     static TYPE: string;
-    _value: BaseObjectClass | undefined;
+    _value: Proxy<BaseObject> | ObjectUri | undefined;
     _instanceOf: Function | string | Object;
     constructor(config: ObjectPropertyType);
-    set(value: any): this;
+    set(value: object): this;
     toJSON(): any;
 }

package/lib/properties/ObjectProperty.js

@@ -19,9 +19,13 @@ class ObjectProperty extends BaseProperty_1.BaseProperty {
         return super.set(value);
     }
     toJSON() {
-        return this._value && this._value.dataObject
-            ? this._value.dataObject.toReference()
-            : undefined;
+        if (this._value instanceof ObjectUri_1.ObjectUri) {
+            return this._value.toJSON();
+        }
+        return this._value &&
+            (this._value.core.dataObject || this._value instanceof DataObject_1.DataObject)
+            ? this._value.core.dataObject.toReference()
+            : null;
     }
 }
 exports.ObjectProperty = ObjectProperty;

package/lib/properties/Property.js

@@ -10,6 +10,7 @@ const StringProperty_1 = require("./StringProperty");
 const NumberProperty_1 = require("./NumberProperty");
 const ObjectProperty_1 = require("./ObjectProperty");
 const CollectionProperty_1 = require("./CollectionProperty");
+const ArrayProperty_1 = require("./ArrayProperty");
 class Property {
     static factory(params, parent) {
         params.parent = parent;
@@ -31,7 +32,12 @@ class Property {
             case DateTimeProperty_1.DateTimeProperty.TYPE:
                 return new DateTimeProperty_1.DateTimeProperty(params);
             case CollectionProperty_1.CollectionProperty.TYPE:
+                if (!('instanceOf' in params)) {
+                    throw new Error('Missing property instanceOf!');
+                }
                 return new CollectionProperty_1.CollectionProperty(params);
+            case ArrayProperty_1.ArrayProperty.TYPE:
+                return new ArrayProperty_1.ArrayProperty(params);
             default:
                 throw new Error(`Unknown property type ${params.type}`);
         }

package/lib/properties/index.d.ts

@@ -12,7 +12,7 @@ import { MapProperty, MapPropertyType } from './MapProperty';
 import { CollectionProperty, CollectionPropertyType } from './CollectionProperty';
 import { PropertyTypes } from './types/PropertyTypes';
 export { Property, BaseProperty, BasePropertyType, ArrayProperty, ArrayPropertyType, NumberProperty, NumberPropertyType, BooleanProperty, BooleanPropertyType, DateTimeProperty, DateTimePropertyType, EnumProperty, EnumPropertyType, ObjectProperty, ObjectPropertyType, StringProperty, StringPropertyType, HashProperty, HashPropertyType, MapProperty, MapPropertyType, CollectionProperty, CollectionPropertyType, };
-declare type BaseType = {
+type BaseType = {
     type: PropertyTypes;
 };
-export declare type DataObjectProperties = ((NumberPropertyType & BaseType) | (BooleanPropertyType & BaseType) | (EnumPropertyType & BaseType) | (ObjectPropertyType & BaseType) | (StringPropertyType & BaseType) | (HashPropertyType & BaseType) | (DateTimeProperty & BaseType) | (ArrayPropertyType & BaseType) | (MapPropertyType & BaseType) | (CollectionPropertyType & BaseType))[];
+export type DataObjectProperties = ((NumberPropertyType & BaseType) | (BooleanPropertyType & BaseType) | (EnumPropertyType & BaseType) | (ObjectPropertyType & BaseType) | (StringPropertyType & BaseType) | (HashPropertyType & BaseType) | (DateTimeProperty & BaseType) | (ArrayPropertyType & BaseType) | (MapPropertyType & BaseType) | (CollectionPropertyType & BaseType))[];

package/lib/properties/types/PropertyClassType.d.ts

@@ -1,6 +1,7 @@
-import { AbstractPropertyType } from "./AbstractPropertyType";
+import { AbstractPropertyType } from './AbstractPropertyType';
 export interface PropertyClassType {
     set(value: any): AbstractPropertyType;
     val(transform?: any): any;
     toJSON(): any;
+    clone(): PropertyClassType;
 }

package/lib/properties/types/PropertyHTMLType.d.ts

@@ -7,4 +7,4 @@ export declare const PASSWORD = "password";
 export declare const BIRTHDAY = "bday";
 export declare const GENDER = "sex";
 export declare const ORG = "organization";
-export declare type PropertyHTMLType = typeof OFF | typeof NAME | typeof GIVEN_NAME | typeof FAMILY_NAME | typeof EMAIL | typeof PASSWORD | typeof BIRTHDAY | typeof GENDER | typeof ORG;
+export type PropertyHTMLType = typeof OFF | typeof NAME | typeof GIVEN_NAME | typeof FAMILY_NAME | typeof EMAIL | typeof PASSWORD | typeof BIRTHDAY | typeof GENDER | typeof ORG;

package/lib/properties/types/PropertyTypes.d.ts

@@ -1,5 +1,5 @@
 import { Property } from '..';
-export declare type PropertyTypes = typeof Property.TYPE_STRING | typeof Property.TYPE_NUMBER | typeof Property.TYPE_ENUM | typeof Property.TYPE_BOOLEAN | typeof Property.TYPE_OBJECT | typeof Property.TYPE_DATETIME | typeof Property.TYPE_HASH | typeof Property.TYPE_ARRAY;
-export declare type BaseType = {
+export type PropertyTypes = typeof Property.TYPE_STRING | typeof Property.TYPE_NUMBER | typeof Property.TYPE_ENUM | typeof Property.TYPE_BOOLEAN | typeof Property.TYPE_OBJECT | typeof Property.TYPE_DATETIME | typeof Property.TYPE_HASH | typeof Property.TYPE_ARRAY;
+export type BaseType = {
     type: PropertyTypes;
 };

package/lib/utils/DataGenerator.d.ts

@@ -1,4 +1,5 @@
-import { BaseObject } from '../components';
+import { BaseObject } from '../components/BaseObject';
+import { Proxy } from '../components/types/ProxyConstructor';
 /**
  * Generate data from model of object and save it in default backend
  * @param model
@@ -6,4 +7,4 @@ import { BaseObject } from '../components';
  * @param forcedValues
  * @returns
  */
-export declare const DataGenerator: <T extends BaseObject>(model: T, qty?: number, forcedValues?: any) => Promise<any>;
+export declare const DataGenerator: <T extends BaseObject>(model: Proxy<T>, qty?: number, forcedValues?: any) => Promise<any>;

package/lib/utils/DataGenerator.js

@@ -47,7 +47,7 @@ const DataGenerator = (model, qty = 5, forcedValues = {}) => __awaiter(void 0, v
     const promises = [];
     Core_1.Core.log(`Starting to create ${qty} ${model.constructor.name} records`);
     for (let i = 0; i < qty; i++) {
-        const dao = yield model.dataObject.clone(); //model.dataObject.toJSON())
+        const dao = yield model.core.dataObject.clone(); //model.dataObject.toJSON())
         Object.keys(dao.properties).forEach((key) => {
             const property = dao.get(key);
             if (forcedValues[key]) {
@@ -93,8 +93,9 @@ const DataGenerator = (model, qty = 5, forcedValues = {}) => __awaiter(void 0, v
                     break;
             }
         });
-        promises.push(dao.save());
+        yield dao.save();
+        promises.push(dao);
     }
-    return Promise.all(promises);
+    return promises;
 });
 exports.DataGenerator = DataGenerator;

package/package.json

@@ -1,30 +1,32 @@
 {
-  "name": "@quatrain/core",
-  "version": "0.4.3",
-  "description": "Core objects for business apps",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": [
-    "lib/",
-    "README.md"
-  ],
-  "author": "Quatrain Développement SAS <developers@quatrain.com>",
-  "license": "MIT",
-  "devDependencies": {
-    "@faker-js/faker": "^7.6.0",
-    "@tsconfig/recommended": "^1.0.1",
-    "@types/jest": "^27.0.3",
-    "jest": "^27.4.7",
-    "jest-node-exports-resolver": "^1.1.6",
-    "trace-unhandled": "^2.0.1",
-    "ts-jest": "^27.1.2",
-    "ts-node": "^10.4.0",
-    "typescript": "^4.7.4"
-  },
-  "scripts": {
-    "test": "tsc && jest --verbose",
-    "build": "tsc --watch",
-    "push": "yarn version --patch --no-git-tag-version ; yarn publish --access public",
-    "prepublish": "tsc"
-  }
-}
+   "name": "@quatrain/core",
+   "version": "0.5.0",
+   "description": "Core objects for business apps",
+   "main": "lib/index.js",
+   "types": "lib/index.d.ts",
+   "files": [
+      "lib/",
+      "README.md"
+   ],
+   "author": "Quatrain Développement SAS <developers@quatrain.com>",
+   "license": "MIT",
+   "devDependencies": {
+      "@tsconfig/recommended": "^1.0.1",
+      "@types/jest": "^27.0.3",
+      "jest": "^27.4.7",
+      "jest-node-exports-resolver": "^1.1.6",
+      "trace-unhandled": "^2.0.1",
+      "ts-jest": "^27.1.2",
+      "ts-node": "^10.4.0",
+      "typescript": "^5.1.5"
+   },
+   "dependencies": {
+      "@faker-js/faker": "^7.6.0"
+   },
+   "scripts": {
+      "test": "tsc && jest --verbose",
+      "build": "tsc --watch",
+      "push": "yarn version --patch --no-git-tag-version ; yarn publish --access public",
+      "prepublish": "tsc"
+   }
+}

package/lib/components/BaseObjectProperties.d.ts

@@ -1,13 +0,0 @@
-import { UserClass } from './types/UserClass';
-import { ObjectUri } from './ObjectUri';
-export interface BaseObjectType {
-    name: string;
-    status: string;
-    createdBy?: UserClass | ObjectUri;
-    createdAt?: number;
-    updatedBy?: UserClass | ObjectUri;
-    updatedAt?: number;
-    deletedBy?: UserClass | ObjectUri;
-    deletedAt?: number;
-}
-export declare const BaseObjectProperties: any;

package/lib/components/BaseObjectProperties.js

@@ -1,87 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseObjectProperties = void 0;
-const statuses = __importStar(require("../statuses"));
-const StringProperty_1 = require("../properties/StringProperty");
-const ObjectProperty_1 = require("../properties/ObjectProperty");
-const EnumProperty_1 = require("../properties/EnumProperty");
-const DateTimeProperty_1 = require("../properties/DateTimeProperty");
-const htmlType = __importStar(require("../properties/types/PropertyHTMLType"));
-exports.BaseObjectProperties = [
-    {
-        name: 'name',
-        mandatory: true,
-        type: StringProperty_1.StringProperty.TYPE,
-        minLength: 1,
-        maxLength: 100,
-        htmlType: htmlType.NAME,
-    },
-    {
-        name: 'status',
-        mandatory: true,
-        type: EnumProperty_1.EnumProperty.TYPE,
-        values: [
-            statuses.CREATED,
-            statuses.PENDING,
-            statuses.ACTIVE,
-            statuses.DELETED,
-        ],
-        defaultValue: statuses.CREATED,
-    },
-    {
-        name: 'createdBy',
-        type: ObjectProperty_1.ObjectProperty.TYPE,
-        instanceOf: 'User',
-        mandatory: true,
-        protected: true,
-    },
-    {
-        name: 'createdAt',
-        type: DateTimeProperty_1.DateTimeProperty.TYPE,
-        mandatory: true,
-        protected: true,
-    },
-    {
-        name: 'updatedBy',
-        type: ObjectProperty_1.ObjectProperty.TYPE,
-        instanceOf: 'User',
-    },
-    {
-        name: 'updatedAt',
-        type: DateTimeProperty_1.DateTimeProperty.TYPE,
-    },
-    {
-        name: 'deletedBy',
-        type: ObjectProperty_1.ObjectProperty.TYPE,
-        instanceOf: 'User',
-        protected: true,
-    },
-    {
-        name: 'deletedAt',
-        type: DateTimeProperty_1.DateTimeProperty.TYPE,
-        protected: true,
-    },
-];

package/lib/components/UserProperties.d.ts

@@ -1 +0,0 @@
-export declare const UserProperties: any;

package/lib/components/UserProperties.js

@@ -1,103 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserProperties = void 0;
-const properties_1 = require("../properties");
-const HashProperty_1 = require("../properties/HashProperty");
-const StringProperty_1 = require("../properties/StringProperty");
-const Entity_1 = require("./Entity");
-const htmlType = __importStar(require("../properties/types/PropertyHTMLType"));
-/**
- * Callback function to populate the 'name' property
- * @param dao DataObject
- * @returns
- */
-const onChange = (dao) => dao.set('name', `${dao.val('firstname')} ${dao.val('lastname')}`);
-exports.UserProperties = [
-    {
-        // change name property minLength
-        name: 'name',
-        type: StringProperty_1.StringProperty.TYPE,
-        minLength: 0,
-        fullSearch: true,
-        htmlType: htmlType.NAME,
-    },
-    {
-        name: 'firstname',
-        mandatory: true,
-        type: StringProperty_1.StringProperty.TYPE,
-        minLength: 1,
-        maxLength: 100,
-        htmlType: htmlType.GIVEN_NAME,
-        onChange,
-    },
-    {
-        name: 'lastname',
-        mandatory: true,
-        type: StringProperty_1.StringProperty.TYPE,
-        minLength: 1,
-        maxLength: 100,
-        htmlType: htmlType.FAMILY_NAME,
-        onChange,
-    },
-    {
-        name: 'gender',
-        mandatory: false,
-        type: properties_1.EnumProperty.TYPE,
-        values: ['male', 'female', 'nonbinary'],
-        htmlType: htmlType.GENDER,
-    },
-    {
-        name: 'birthday',
-        mandatory: false,
-        type: properties_1.DateTimeProperty.TYPE,
-        htmlType: htmlType.BIRTHDAY,
-    },
-    {
-        name: 'email',
-        mandatory: true,
-        type: StringProperty_1.StringProperty.TYPE,
-        minLength: 1,
-        maxLength: 100,
-        fullSearch: true,
-        htmlType: htmlType.EMAIL,
-    },
-    {
-        name: 'password',
-        mandatory: true,
-        type: HashProperty_1.HashProperty.TYPE,
-        algorithm: HashProperty_1.HashProperty.ALGORITHM_SHA256,
-        salt: '',
-        minLength: 5,
-        maxLength: 20,
-        htmlType: htmlType.PASSWORD,
-    },
-    {
-        name: 'entity',
-        mandatory: false,
-        type: properties_1.ObjectProperty.TYPE,
-        instanceof: Entity_1.Entity,
-    },
-];

package/lib/components/types/UserClass.d.ts

@@ -1,3 +0,0 @@
-import { BaseObjectClass } from './BaseObjectClass';
-export interface UserClass extends BaseObjectClass {
-}