@quatrain/core 0.3.0 → 0.4.0

package/lib/index.js

@@ -23,11 +23,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SortAndLimit = exports.Sorting = exports.Limits = exports.Filters = exports.Filter = exports.Query = exports.BackendError = exports.BaseObjectProperties = exports.BaseObject = exports.AbstractObject = exports.DataObject = exports.ObjectUri = exports.MockAdapter = exports.AbstractAdapter = exports.StringProperty = exports.ObjectProperty = exports.HashProperty = exports.EnumProperty = exports.DateTimeProperty = exports.BooleanProperty = exports.BaseProperty = exports.Property = exports.Core = exports.statuses = void 0;
+exports.Entity = exports.User = exports.SortAndLimit = exports.Sorting = exports.Limits = exports.Filters = exports.Filter = exports.Query = exports.BackendError = exports.BaseObjectProperties = exports.BaseObject = exports.AbstractObject = exports.DataObject = exports.ObjectUri = exports.MockAdapter = exports.AbstractAdapter = exports.StringProperty = exports.ObjectProperty = exports.HashProperty = exports.EnumProperty = exports.DateTimeProperty = exports.BooleanProperty = exports.BaseProperty = exports.Property = exports.Core = exports.utils = exports.statuses = void 0;
 const Core_1 = require("./Core");
 Object.defineProperty(exports, "Core", { enumerable: true, get: function () { return Core_1.Core; } });
 const statuses = __importStar(require("./common/statuses"));
 exports.statuses = statuses;
+const utils = __importStar(require("./utils"));
+exports.utils = utils;
 const Property_1 = require("./properties/Property");
 Object.defineProperty(exports, "Property", { enumerable: true, get: function () { return Property_1.Property; } });
 const BaseProperty_1 = require("./properties/BaseProperty");
@@ -54,6 +56,10 @@ const BaseObject_1 = require("./components/BaseObject");
 Object.defineProperty(exports, "BaseObject", { enumerable: true, get: function () { return BaseObject_1.BaseObject; } });
 const BaseObjectProperties_1 = require("./components/BaseObjectProperties");
 Object.defineProperty(exports, "BaseObjectProperties", { enumerable: true, get: function () { return BaseObjectProperties_1.BaseObjectProperties; } });
+const User_1 = require("./components/User");
+Object.defineProperty(exports, "User", { enumerable: true, get: function () { return User_1.User; } });
+const Entity_1 = require("./components/Entity");
+Object.defineProperty(exports, "Entity", { enumerable: true, get: function () { return Entity_1.Entity; } });
 const backends_1 = require("./backends");
 Object.defineProperty(exports, "AbstractAdapter", { enumerable: true, get: function () { return backends_1.AbstractAdapter; } });
 Object.defineProperty(exports, "MockAdapter", { enumerable: true, get: function () { return backends_1.MockAdapter; } });

package/lib/properties/BaseProperty.d.ts

@@ -1,24 +1,27 @@
 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 interface BasePropertyType extends AbstractPropertyType {
-    parent?: DataObjectClass;
+    parent?: DataObjectClass<any>;
     protected?: boolean;
     mandatory?: boolean;
     defaultValue?: any;
-    onChange?: (dao: DataObjectClass) => DataObjectClass;
+    htmlType?: PropertyHTMLType;
+    onChange?: (dao: DataObjectClass<any>) => DataObjectClass<any>;
 }
 export declare class BaseProperty implements PropertyClassType {
     static TYPE: string;
     static EVENT_ONCHANGE: string;
     static EVENT_ONDELETE: string;
-    protected _parent: DataObjectClass | undefined;
+    protected _parent: DataObjectClass<any> | undefined;
     protected _name: string;
     protected _value: any;
     protected _mandatory: boolean;
     protected _protected: boolean;
     protected _allows: String[];
+    protected _htmlType: PropertyHTMLType;
     protected _defaultValue: any;
     protected _events: {
         [key: EventTypes]: Function;
@@ -28,6 +31,8 @@ export declare class BaseProperty implements PropertyClassType {
     get mandatory(): boolean;
     get protected(): boolean;
     get allows(): String[];
+    set htmlType(type: PropertyHTMLType);
+    get htmlType(): PropertyHTMLType;
     set(value: any): this;
     val(transform?: any): any;
     protected _enable(value: boolean | undefined): boolean;

package/lib/properties/BaseProperty.js

@@ -7,6 +7,7 @@ class BaseProperty {
         this._mandatory = false;
         this._protected = false;
         this._allows = [];
+        this._htmlType = 'off';
         this._events = {};
         this._parent = config.parent;
         this._name = config.name;
@@ -14,6 +15,7 @@ class BaseProperty {
         this._mandatory = config.mandatory || false;
         this._defaultValue = config.defaultValue;
         this._value = config.defaultValue;
+        this._htmlType = config.htmlType || 'off';
         if (typeof config.onChange === 'function') {
             this._events.onChange = config.onChange;
         }
@@ -30,8 +32,15 @@ class BaseProperty {
     get allows() {
         return this._allows;
     }
+    set htmlType(type) {
+        this._htmlType = type;
+    }
+    get htmlType() {
+        return this._htmlType;
+    }
     set(value) {
         if (this._value !== undefined &&
+            this._value !== null &&
             this._value !== this._defaultValue &&
             this._protected === true) {
             throw new Error(`Value already defined as '${this._value}' and protected from change`);
@@ -43,7 +52,7 @@ class BaseProperty {
         return this;
     }
     val(transform = undefined) {
-        return this._value;
+        return transform ? transform(this._value) : this._value;
     }
     _enable(value) {
         return value === undefined || value === true;

package/lib/properties/CollectionProperty.d.ts

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

package/lib/properties/CollectionProperty.js

@@ -11,7 +11,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CollectionProperty = void 0;
 const BaseProperty_1 = require("./BaseProperty");
-const backends_1 = require("../backends");
 const Core_1 = require("../Core");
 const Query_1 = require("../backends/Query");
 class CollectionProperty extends BaseProperty_1.BaseProperty {
@@ -19,7 +18,6 @@ class CollectionProperty extends BaseProperty_1.BaseProperty {
         var _a, _b;
         super(config);
         this._value = undefined;
-        this._query = undefined;
         this._filters = undefined;
         this._instanceOf = config.instanceOf;
         this._backend = config.backend
@@ -27,6 +25,15 @@ class CollectionProperty extends BaseProperty_1.BaseProperty {
             : undefined;
         this._parentKey =
             config.parentKey || ((_b = (_a = this._parent) === null || _a === void 0 ? void 0 : _a.uri) === null || _b === void 0 ? void 0 : _b.collection) || 'unknown';
+        this._query = this._setQuery();
+    }
+    _setQuery(filters) {
+        const query = this._instanceOf.query();
+        query.where(this._parentKey, this._parent ? this._parent.uri : 'unknown');
+        if (filters) {
+            query.filters = filters;
+        }
+        return query;
     }
     set(value) {
         return super.set(value);
@@ -39,13 +46,7 @@ class CollectionProperty extends BaseProperty_1.BaseProperty {
      */
     get(filters = undefined) {
         if (!this._query || this._filters !== filters) {
-            this._query = new backends_1.Query(this._instanceOf);
-            if (this._parent) {
-                this._query.where(this._parentKey, this._parent.uri);
-            }
-            if (filters) {
-                this._query.filters = filters;
-            }
+            this._query = this._setQuery(filters);
         }
         return this._query;
     }

package/lib/properties/EnumProperty.d.ts

@@ -7,4 +7,5 @@ export declare class EnumProperty extends BaseProperty {
     protected _values: string[];
     constructor(config: EnumPropertyType);
     set(value: string): this;
+    get values(): string[];
 }

package/lib/properties/EnumProperty.js

@@ -9,11 +9,14 @@ class EnumProperty extends BaseProperty_1.BaseProperty {
         this._values = config.values || [];
     }
     set(value) {
-        if (!this._values.includes(value)) {
+        if (value !== null && !this._values.includes(value)) {
             throw new Error(`Value '${value}' is not acceptable`);
         }
         return super.set(value);
     }
+    get values() {
+        return this._values;
+    }
 }
 exports.EnumProperty = EnumProperty;
 EnumProperty.TYPE = 'enum';

package/lib/properties/Property.d.ts

@@ -10,5 +10,5 @@ export declare class Property {
     static TYPE_HASH: string;
     static TYPE_DATETIME: string;
     static TYPE_ARRAY: string;
-    static factory<P extends BasePropertyType>(params: P, parent: DataObjectClass): BaseProperty;
+    static factory<P extends BasePropertyType>(params: P, parent: DataObjectClass<any>): BaseProperty;
 }

package/lib/properties/StringProperty.d.ts

@@ -6,6 +6,7 @@ export interface StringPropertyType extends BasePropertyType {
     allowDigits?: boolean;
     allowLetters?: boolean;
     allowPattern?: String;
+    fullSearch?: boolean;
 }
 export declare class StringProperty extends BaseProperty {
     static TYPE: string;
@@ -18,6 +19,7 @@ export declare class StringProperty extends BaseProperty {
     static ALLOW_NUMBERS: string;
     protected _minLength: number;
     protected _maxLength: number;
+    protected _fullSearch: boolean;
     protected _value: string | undefined;
     /**
      * Set to false to bypass some rules
@@ -30,4 +32,6 @@ export declare class StringProperty extends BaseProperty {
     get minLength(): number;
     set maxLength(max: number);
     get maxLength(): number;
+    set fullSearch(mode: boolean);
+    get fullSearch(): boolean;
 }

package/lib/properties/StringProperty.js

@@ -8,12 +8,15 @@ class StringProperty extends BaseProperty_1.BaseProperty {
         super(config);
         this._minLength = 0;
         this._maxLength = 0;
+        this._fullSearch = false;
         /**
          * Set to false to bypass some rules
          */
         this._rawValue = true;
         this.minLength = config.minLength || 0;
         this.maxLength = config.maxLength || 0;
+        this.fullSearch = config.fullSearch || false;
+        this._htmlType = config.htmlType || 'off';
         if (this._enable(config.allowSpaces)) {
             this._allows.push(StringProperty.ALLOW_SPACES);
         }
@@ -25,23 +28,29 @@ class StringProperty extends BaseProperty_1.BaseProperty {
         }
     }
     set(value) {
-        if (this._allows.includes(StringProperty.ALLOW_DIGITS) === false &&
-            /\d/.test(value)) {
-            throw new Error(`Digits are not allowed in value`);
-        }
-        if (this._allows.includes(StringProperty.ALLOW_SPACES) === false &&
-            /\s/g.test(value)) {
-            throw new Error(`Spaces are not allowed in value`);
-        }
-        if (this._allows.includes(StringProperty.ALLOW_LETTERS) === false &&
-            /[a-zA-Z]/.test(value)) {
-            throw new Error(`Letters are not allowed in value`);
-        }
-        if (this._rawValue && this._minLength > 0 && value.length < this._minLength) {
-            throw new Error(`Value is too short`);
-        }
-        if (this._rawValue && this._maxLength > 0 && value.length > this._maxLength) {
-            throw new Error(`${this._name}: value '${value}' is too long`);
+        if (value !== null && value !== undefined) {
+            if (this._allows.includes(StringProperty.ALLOW_DIGITS) === false &&
+                /\d/.test(value)) {
+                throw new Error(`Digits are not allowed in value`);
+            }
+            if (this._allows.includes(StringProperty.ALLOW_SPACES) === false &&
+                /\s/g.test(value)) {
+                throw new Error(`Spaces are not allowed in value`);
+            }
+            if (this._allows.includes(StringProperty.ALLOW_LETTERS) === false &&
+                /[a-zA-Z]/.test(value)) {
+                throw new Error(`Letters are not allowed in value`);
+            }
+            if (this._rawValue &&
+                this._minLength > 0 &&
+                value.length < this._minLength) {
+                throw new Error(`Value is too short`);
+            }
+            if (this._rawValue &&
+                this._maxLength > 0 &&
+                value.length > this._maxLength) {
+                throw new Error(`${this._name}: value '${value}' is too long`);
+            }
         }
         return super.set(value);
     }
@@ -67,6 +76,12 @@ class StringProperty extends BaseProperty_1.BaseProperty {
     get maxLength() {
         return this._maxLength;
     }
+    set fullSearch(mode) {
+        this._fullSearch = mode;
+    }
+    get fullSearch() {
+        return this._fullSearch;
+    }
 }
 exports.StringProperty = StringProperty;
 StringProperty.TYPE = 'string';

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

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

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

@@ -0,0 +1,10 @@
+export declare const OFF = "off";
+export declare const NAME = "name";
+export declare const GIVEN_NAME = "given-name";
+export declare const FAMILY_NAME = "family-name";
+export declare const EMAIL = "email";
+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;

package/lib/properties/types/PropertyHTMLType.js

@@ -0,0 +1,14 @@
+"use strict";
+// @see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete
+// @see https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ORG = exports.GENDER = exports.BIRTHDAY = exports.PASSWORD = exports.EMAIL = exports.FAMILY_NAME = exports.GIVEN_NAME = exports.NAME = exports.OFF = void 0;
+exports.OFF = 'off';
+exports.NAME = 'name';
+exports.GIVEN_NAME = 'given-name';
+exports.FAMILY_NAME = 'family-name';
+exports.EMAIL = 'email';
+exports.PASSWORD = 'password';
+exports.BIRTHDAY = 'bday';
+exports.GENDER = 'sex';
+exports.ORG = 'organization';

package/lib/utils/DataGenerator.d.ts

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

package/lib/utils/DataGenerator.js

@@ -0,0 +1,98 @@
+"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;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataGenerator = void 0;
+const htmlType = __importStar(require("../properties/types/PropertyHTMLType"));
+const faker_1 = require("@faker-js/faker");
+/**
+ * Generate data from model of object and save it in default backend
+ * @param model
+ * @param qty
+ * @param forcedValues
+ * @returns
+ */
+const DataGenerator = (model, qty = 5, forcedValues = {}) => __awaiter(void 0, void 0, void 0, function* () {
+    const promises = [];
+    for (let i = 0; i < qty; i++) {
+        const dao = yield model.dataObject.clone(model.dataObject.toJSON());
+        Object.keys(dao.properties).forEach((key) => {
+            const property = dao.get(key);
+            if (forcedValues[key]) {
+                property.set(forcedValues[key]);
+                return;
+            }
+            switch (property.constructor.name) {
+                case 'StringProperty':
+                    switch (property.htmlType) {
+                        case htmlType.GIVEN_NAME:
+                            property.set(faker_1.faker.name.firstName());
+                            break;
+                        case htmlType.FAMILY_NAME:
+                            property.set(faker_1.faker.name.lastName());
+                            break;
+                        case htmlType.EMAIL:
+                            property.set(faker_1.faker.helpers.unique(faker_1.faker.internet.email));
+                            break;
+                        case htmlType.ORG:
+                            property.set(faker_1.faker.company.name());
+                        default:
+                            property.set(faker_1.faker.word.noun());
+                            break;
+                    }
+                    break;
+                case 'EnumProperty':
+                    property.set(faker_1.faker.helpers.arrayElement(property.values));
+                    break;
+                case 'HashProperty':
+                    property.set(faker_1.faker.random.alphaNumeric(16));
+                    break;
+                case 'DateTimeProperty':
+                    switch (property.htmlType) {
+                        case htmlType.BIRTHDAY:
+                            property.set(faker_1.faker.date.birthdate());
+                            break;
+                        default:
+                            //property.set(faker.date.future())
+                            break;
+                    }
+                    break;
+                default:
+                    break;
+            }
+        });
+        promises.push(dao.save());
+    }
+    return Promise.all(promises);
+});
+exports.DataGenerator = DataGenerator;

package/lib/utils/index.d.ts

@@ -0,0 +1,2 @@
+import { DataGenerator } from './DataGenerator';
+export { DataGenerator };

package/lib/utils/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataGenerator = void 0;
+const DataGenerator_1 = require("./DataGenerator");
+Object.defineProperty(exports, "DataGenerator", { enumerable: true, get: function () { return DataGenerator_1.DataGenerator; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/core",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Core objects for business apps",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",