@quatrain/core 1.0.0-beta1 → 1.0.0-beta11

package/lib/properties/BaseProperty.js

@@ -10,11 +10,13 @@ class BaseProperty {
         this._htmlType = 'off';
         this._events = {};
         this._parent = config.parent;
+        this._id = config.id || config.name.toLowerCase();
         this._name = config.name;
         this._protected = config.protected || false;
         this._mandatory = config.mandatory || false;
         this._defaultValue = config.defaultValue;
         this._value = config.defaultValue;
+        this._hasChanged = false;
         this._htmlType = config.htmlType || 'off';
         if (typeof config.onChange === 'function') {
             this._events.onChange = config.onChange;
@@ -38,21 +40,31 @@ class BaseProperty {
     get htmlType() {
         return this._htmlType;
     }
-    set(value) {
+    get hasChanged() {
+        return this._hasChanged;
+    }
+    set(value, setChanged = true) {
         if (this._value !== undefined &&
             this._value !== null &&
             this._value !== this._defaultValue &&
             this._protected === true) {
             throw new Error(`Value '${this._name}' already defined as '${this._value}' and protected from change`);
         }
-        this._value = value;
+        if (value !== this._value) {
+            // console.log(this.name, value, this._value)
+            this._value = value;
+            this._hasChanged = setChanged;
+        }
         if (this._events[BaseProperty.EVENT_ONCHANGE]) {
             this._events[BaseProperty.EVENT_ONCHANGE](this._parent);
         }
         return this;
     }
     val(transform = undefined) {
-        return transform ? transform(this._value) : this._value || this._defaultValue;
+        // console.log(transform && transform(this._value), typeof transform);
+        return typeof transform === 'function'
+            ? transform(this._value)
+            : this._value || this._defaultValue;
     }
     _enable(value) {
         return value === undefined || value === true;

package/lib/properties/BooleanProperty.d.ts

@@ -3,5 +3,5 @@ export interface BooleanPropertyType extends BasePropertyType {
 }
 export declare class BooleanProperty extends BaseProperty {
     static TYPE: string;
-    set(value: boolean): this;
+    set(value: boolean, setChanged?: boolean): this;
 }

package/lib/properties/BooleanProperty.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BooleanProperty = void 0;
 const BaseProperty_1 = require("./BaseProperty");
 class BooleanProperty extends BaseProperty_1.BaseProperty {
-    set(value) {
-        return super.set(value);
+    set(value, setChanged = true) {
+        return super.set(value, setChanged);
     }
 }
 exports.BooleanProperty = BooleanProperty;

package/lib/properties/CollectionProperty.d.ts

@@ -1,5 +1,5 @@
 import { BaseProperty, BasePropertyType } from './BaseProperty';
-import { Query } from '../backends/Query';
+import { Query, QueryResultType } from '../backends/Query';
 import { Filter } from '../backends/Filter';
 import { ObjectUri } from '../components/ObjectUri';
 import { returnAs } from '../backends/Query';
@@ -20,7 +20,7 @@ export declare class CollectionProperty extends BaseProperty {
     protected _filters: Filter[] | Filter | undefined;
     constructor(config: CollectionPropertyType);
     protected _setQuery(filters?: Filter[]): Query<typeof BaseObjectCore>;
-    set(value: Array<any>): this;
+    set(value: Array<any>, setChanged?: boolean): this;
     /**
      * get objects matching collection class and filters
      * in the requested format
@@ -28,6 +28,6 @@ export declare class CollectionProperty extends BaseProperty {
      * @returns
      */
     get(filters?: Filter[] | undefined): Query<any>;
-    val(transform?: returnAs): Promise<Array<any> | Array<DataObjectClass<any>> | Array<ObjectUri>>;
+    val(transform?: returnAs): Promise<QueryResultType<any>>;
     toJSON(): any[] | DataObjectClass<any>[] | ObjectUri[] | undefined;
 }

package/lib/properties/CollectionProperty.js

@@ -19,8 +19,9 @@ class CollectionProperty extends BaseProperty_1.BaseProperty {
         super(config);
         this._value = undefined;
         this._filters = undefined;
+        // console.log(config)
         if (!config.instanceOf) {
-            throw new Error('Parameter instanceOf is mandatory');
+            throw new Error(`Parameter 'instanceOf' is mandatory`);
         }
         this._instanceOf =
             typeof config.instanceOf === 'string'
@@ -41,8 +42,8 @@ class CollectionProperty extends BaseProperty_1.BaseProperty {
         }
         return query;
     }
-    set(value) {
-        return super.set(value);
+    set(value, setChanged = true) {
+        return super.set(value, setChanged);
     }
     /**
      * get objects matching collection class and filters

package/lib/properties/DateTimeProperty.d.ts

@@ -6,6 +6,6 @@ export declare class DateTimeProperty extends BaseProperty {
     static TYPE: string;
     protected _timezone: string;
     constructor(config: DateTimePropertyType);
-    set(value: string | Date): this;
+    set(value: string | Date, setChanged?: boolean): this;
     get timezone(): string;
 }

package/lib/properties/DateTimeProperty.js

@@ -7,8 +7,8 @@ class DateTimeProperty extends BaseProperty_1.BaseProperty {
         super(config);
         this._timezone = config.timezone || 'Z';
     }
-    set(value) {
-        return super.set(value);
+    set(value, setChanged = true) {
+        return super.set(value, setChanged);
     }
     get timezone() {
         return this._timezone;

package/lib/properties/EnumProperty.d.ts

@@ -6,6 +6,6 @@ export declare class EnumProperty extends BaseProperty {
     static TYPE: string;
     protected _values: string[];
     constructor(config: EnumPropertyType);
-    set(value: string): this;
+    set(value: string, setChanged?: boolean): this;
     get values(): string[];
 }

package/lib/properties/EnumProperty.js

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

package/lib/properties/HashProperty.d.ts

@@ -16,6 +16,12 @@ export declare class HashProperty extends StringProperty {
     protected _prefixed: boolean;
     constructor(config: HashPropertyType);
     _hash(value: string): string;
-    set(value: string): this;
+    /**
+     * Never return the password which is hashed anyway
+     * @param transform
+     * @returns
+     */
+    get(transform?: string | undefined): string | undefined;
+    set(value: string, setChanged?: boolean): this;
     compare(value: string): boolean;
 }

package/lib/properties/HashProperty.js

@@ -34,8 +34,16 @@ class HashProperty extends StringProperty_1.StringProperty {
         this._rawValue = false; // don't test some constraints after hashing
         return hash;
     }
-    set(value) {
-        return super.set(this._hash(value));
+    /**
+     * Never return the password which is hashed anyway
+     * @param transform
+     * @returns
+     */
+    get(transform) {
+        return;
+    }
+    set(value, setChanged = true) {
+        return super.set(this._hash(value), setChanged);
     }
     compare(value) {
         return this._hash(value) === this._value;

package/lib/properties/MapProperty.d.ts

@@ -3,6 +3,6 @@ export interface MapPropertyType extends BasePropertyType {
 }
 export declare class MapProperty extends BaseProperty {
     static TYPE: string;
-    set(value: any): this;
+    set(value: any, setChanged?: boolean): this;
     toJSON(): {};
 }

package/lib/properties/MapProperty.js

@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MapProperty = void 0;
 const BaseProperty_1 = require("./BaseProperty");
 class MapProperty extends BaseProperty_1.BaseProperty {
-    set(value) {
+    set(value, setChanged = true) {
         if (typeof value !== 'object') {
             throw new Error(`value ${JSON.stringify(value)} is not an object`);
         }
-        return super.set(value);
+        return super.set(value, setChanged);
     }
     toJSON() {
         return this._value ? JSON.stringify(this._value) : {};

package/lib/properties/NumberProperty.d.ts

@@ -27,7 +27,7 @@ export declare class NumberProperty extends BaseProperty {
     protected _precision: number;
     protected _value: number | undefined;
     constructor(config: NumberPropertyType);
-    set(value: number): this;
+    set(value: number, setChanged?: boolean): this;
     val(transform?: string | undefined): string | number | undefined;
     set minVal(min: number | undefined);
     get minVal(): number | undefined;

package/lib/properties/NumberProperty.js

@@ -27,7 +27,7 @@ class NumberProperty extends BaseProperty_1.BaseProperty {
             this._sign = config.sign;
         }
     }
-    set(value) {
+    set(value, setChanged = true) {
         if (this._sign === NumberProperty.TYPE_UNSIGNED && value < 0) {
             throw new Error(`Value must be unsigned`);
         }
@@ -40,7 +40,7 @@ class NumberProperty extends BaseProperty_1.BaseProperty {
         if (this._type === NumberProperty.TYPE_INTEGER) {
             value = Math.floor(value);
         }
-        return super.set(value);
+        return super.set(value, setChanged);
     }
     val(transform = undefined) {
         switch (transform) {

package/lib/properties/ObjectProperty.d.ts

@@ -10,6 +10,6 @@ export declare class ObjectProperty extends BaseProperty {
     _instanceOf: any;
     constructor(config: ObjectPropertyType);
     val(transform?: string | undefined): any;
-    set(value: object): this;
+    set(value: object, setChanged?: boolean): this;
     toJSON(): any;
 }

package/lib/properties/ObjectProperty.js

@@ -14,7 +14,7 @@ class ObjectProperty extends BaseProperty_1.BaseProperty {
     }
     val(transform = undefined) {
         if (typeof this._instanceOf === 'string') {
-            console.log(`Getting instance from string ${this._instanceOf}`);
+            //console.log(`Getting instance from string ${this._instanceOf}`)
             this._instanceOf = Core_1.Core.getClass(this._instanceOf);
             //throw new Error(`Parameter 'instanceOf' was not properly setted`)
         }
@@ -44,9 +44,9 @@ class ObjectProperty extends BaseProperty_1.BaseProperty {
                     return Reflect.construct(this._instanceOf, [this._value]);
                 }
                 else if (this._value instanceof ObjectUri_1.ObjectUri) {
-                    console.log('ObjectProperty', this);
+                    // console.log('ObjectProperty', this)
                     console.log(`Converting objectUri -> dataObject -> instance`);
-                    console.log(this._instanceOf);
+                    // console.log(this._instanceOf)
                     const dao = DataObject_1.DataObject.factory({
                         properties: Reflect.get(this._instanceOf, 'PROPS_DEFINITION'),
                         uri: this._value,
@@ -57,19 +57,18 @@ class ObjectProperty extends BaseProperty_1.BaseProperty {
                     console.log(`Returning already existing instance`);
                     return this._value;
                 }
-                return this._value;
             case Query_1.returnAs.AS_OBJECTURIS:
             default:
                 return this._value;
         }
     }
-    set(value) {
+    set(value, setChanged = true) {
         if (value instanceof ObjectUri_1.ObjectUri &&
             value instanceof DataObject_1.DataObject &&
             value.constructor.name !== this._instanceOf.constructor.name) {
             throw new Error(`value ${JSON.stringify(value)} is not an instance of ${this._instanceOf.constructor.name}`);
         }
-        return super.set(value);
+        return super.set(value, setChanged);
     }
     toJSON() {
         if (this._value instanceof ObjectUri_1.ObjectUri) {

package/lib/properties/StringProperty.d.ts

@@ -26,7 +26,7 @@ export declare class StringProperty extends BaseProperty {
      */
     protected _rawValue: boolean;
     constructor(config: StringPropertyType);
-    set(value: any): this;
+    set(value: any, setChanged?: boolean): this;
     get(transform?: string | undefined): string | undefined;
     set minLength(min: number);
     get minLength(): number;

package/lib/properties/StringProperty.js

@@ -27,7 +27,7 @@ class StringProperty extends BaseProperty_1.BaseProperty {
             this._allows.push(StringProperty.ALLOW_LETTERS);
         }
     }
-    set(value) {
+    set(value, setChanged = true) {
         if (value !== null && value !== undefined) {
             if (this._allows.includes(StringProperty.ALLOW_DIGITS) === false &&
                 /\d/.test(value)) {
@@ -52,7 +52,7 @@ class StringProperty extends BaseProperty_1.BaseProperty {
                 throw new Error(`${this._name}: value '${value}' is too long`);
             }
         }
-        return super.set(value);
+        return super.set(value, setChanged);
     }
     get(transform = undefined) {
         switch (transform) {

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

@@ -1,5 +1,6 @@
 import { PropertyTypes } from './PropertyTypes';
 export interface AbstractPropertyType {
     name: string;
+    id?: string;
     type?: PropertyTypes;
 }

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

@@ -1,7 +1,10 @@
 import { AbstractPropertyType } from './AbstractPropertyType';
 export interface PropertyClassType {
-    set(value: any): AbstractPropertyType;
+    id?: string;
+    name: string;
+    set(value: any, setCahnged?: boolean): AbstractPropertyType;
     val(transform?: any): any;
     toJSON(): any;
     clone(): PropertyClassType;
+    hasChanged?: boolean;
 }

package/lib/utils/DataGenerator.d.ts

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

package/lib/utils/DataGenerator.js

@@ -47,8 +47,9 @@ 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.core.dataObject.clone(); //model.dataObject.toJSON())
+        const dao = yield model.dataObject.clone();
         Object.keys(dao.properties).forEach((key) => {
+            console.log(`Getting property for '${key}'`);
             const property = dao.get(key);
             if (forcedValues[key]) {
                 property.set(forcedValues[key]);

package/lib/wrappers/cloud/AbstractCloudWrapper.d.ts

@@ -0,0 +1,4 @@
+export declare class AbstractCloudWrapper {
+    protected _params: any;
+    constructor(params: any);
+}

package/lib/wrappers/cloud/AbstractCloudWrapper.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractCloudWrapper = void 0;
+class AbstractCloudWrapper {
+    constructor(params) {
+        this._params = params;
+    }
+}
+exports.AbstractCloudWrapper = AbstractCloudWrapper;

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@quatrain/core",
-   "version": "1.0.0-beta1",
+   "version": "1.0.0-beta11",
    "description": "Core objects for business apps",
    "main": "lib/index.js",
    "types": "lib/index.d.ts",
@@ -30,4 +30,4 @@
       "push": "yarn publish --access public",
       "prepublish": "tsc"
    }
-}
+}

package/README.md

@@ -1,124 +0,0 @@
-# Quatrain Core
-
-## Why
-
-Quatrain Core is an abstraction layer designed to accelerate and simplify the development
-of applications using many models and various data stores, being database or APIs.
-
-With Quatrain Core and peer packages, one may develop robust applications based on
-Oriented Object Programming with a clear separation of concerns between logic, data
-and storage.
-
-## How to install
-
-```bash
-yarn install @quatrain/core
-```
-
-Quatrain Core comes with a built-in Mock backend adapter. Other adapters are available in
-different packages. For example, a Google Firestore adapter is available:
-
-```bash
-yarn install @quatrain/backend-firestore
-```
-
-## How to use
-
-### Setup
-
-```ts
-import { Core } from '@quatrain/core'
-
-Core.addBackend(myAdapter, 'myDB', true)
-```
-
-### Create a model
-
-```ts
-import { BaseObjectCore } from '@quatrain/core'
-
-export type Cat = {
-   name: string
-   color: `#${string}`
-}
-
-export class CatCore extends BaseObjectCore {
-   static COLLECTION = 'cats'
-
-   static PROPERTIES = [
-      {
-         name: 'name',
-         type: Property.STRING,
-         minLength: 1,
-         maxLength: 32,
-      },
-      {
-         name: 'color',
-         type: Property.STRING,
-         minLength: 4,
-         maxLength: 7,
-      },
-   ]
-}
-```
-
-### Instantiate a model
-
-```ts
-const catData: Cat = {
-   name: 'Garfield',
-   color: '#ffa502',
-}
-
-const garfield = CatCore.fromObject(catData)
-
-console.log(garfield.name)
-// > "Garfield"
-console.log(garfield.color)
-// > "#ffa502"
-console.log(garfield.core)
-// > CatCore { ... }
-```
-
-### Interact with backend
-
-```ts
-// Let's save Garfield in our database
-garfield.core.save()
-
-// Now, let's retrieve Garfield in the database
-const persistedGarfield = await CatCore.fromBackend('garfield')
-```
-
-### Using repositories
-
-You can use repositories as an alternative way to persist and retrieve models in your backend.
-
-This module provides a BaseRepository class that you can extend and override to apply your business logic when doing backend operations.
-
-Let's create a repository for our Cat model, that prevents us from deleting a cat.
-
-```ts
-import { Core, BackendInterface, BaseRepository } from '@quatrain/core'
-
-export default class CatRepository extends BaseRepository<Cat> {
-   constructor(backendAdapter: BackendInterface = Core.getBackend()) {
-      super(CatCore, backendAdapter)
-   }
-
-   async delete(uid: string) {
-      throw Error("Don't delete the cats!")
-   }
-}
-```
-
-Now, let's use our new CatRepository.
-
-```ts
-const repository = new CatRepository()
-
-repository.create(garfield)
-repository.read('garfield')
-repository.update(persistedGarfield)
-repository.delete('garfield') // Will throw "Don't delete the cats!"
-```

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/EntityProperties.d.ts

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