@quatrain/core 0.5.6 → 1.0.0-beta2

package/lib/components/AbstractObject.d.ts

@@ -6,6 +6,11 @@ export declare abstract class AbstractObject {
     static LABEL_KEY: string;
     protected _dataObject: DataObjectClass<any>;
     constructor(dao: DataObjectClass<any>);
+    /**
+     * Return property object matching key
+     * @param key string
+     * @returns
+     */
     get(key: string): any;
     set(key: string, val: any): any;
     val(key: string): any;
@@ -13,6 +18,7 @@ export declare abstract class AbstractObject {
     get path(): string;
     get uid(): any;
     get dataObject(): DataObjectClass<any>;
+    get _(): any;
     get uri(): import("./ObjectUri").ObjectUri;
     toJSON(): {
         backend: string;

package/lib/components/AbstractObject.js

@@ -14,6 +14,11 @@ class AbstractObject {
     constructor(dao) {
         this._dataObject = dao;
     }
+    /**
+     * Return property object matching key
+     * @param key string
+     * @returns
+     */
     get(key) {
         return this._dataObject.get(key);
     }
@@ -41,6 +46,9 @@ class AbstractObject {
     get dataObject() {
         return this._dataObject;
     }
+    get _() {
+        return this._dataObject.asProxy();
+    }
     get uri() {
         return this._dataObject.uri;
     }

package/lib/components/BaseObject.d.ts

@@ -4,10 +4,10 @@ export interface BaseObject {
     name: string;
     status: string;
     createdBy?: User | ObjectUri;
-    createdAt?: number;
+    createdAt?: number | string;
     updatedBy?: User | ObjectUri;
-    updatedAt?: number;
+    updatedAt?: number | string;
     deletedBy?: User | ObjectUri;
-    deletedAt?: number;
+    deletedAt?: number | string;
 }
 export declare const BaseObjectProperties: any;

package/lib/components/BaseObject.js

@@ -51,6 +51,8 @@ exports.BaseObjectProperties = [
         ],
         defaultValue: statuses.CREATED,
     },
+    // the following properties may be optionally
+    // populated with a backend middleware
     {
         name: 'createdBy',
         type: ObjectProperty_1.ObjectProperty.TYPE,

package/lib/components/BaseObjectCore.d.ts

@@ -39,7 +39,7 @@ export declare class BaseObjectCore extends AbstractObject implements BaseObject
      * @param child
      * @returns
      */
-    static fromObject<T extends BaseObject>(src: T, child?: any): Proxy<T>;
+    static fromObject<T extends BaseObject>(src: T, child?: any): any;
     static factory(src?: string | ObjectUri | BaseObject | undefined, child?: any): Promise<any>;
     /**
      * Fetches an object from its backend path
@@ -52,7 +52,11 @@ export declare class BaseObjectCore extends AbstractObject implements BaseObject
      * @param dao
      * @returns
      */
-    static fromDataObject<T extends BaseObject>(dao: DataObjectClass<any>): T;
+    static fromDataObject<T extends BaseObject>(dao: DataObjectClass<any>): any;
+    /**
+     * Wrap instance into proxy to get access to properties
+     * @returns Proxy
+     */
     protected toProxy<T extends BaseObject>(): Proxy<Proxy<T>>;
     asReference(): any;
     query(): Query<any>;

package/lib/components/BaseObjectCore.js

@@ -63,7 +63,7 @@ class BaseObjectCore extends AbstractObject_1.AbstractObject {
         dao.uri.class = child;
         dao.populateFromData(src);
         const obj = new this(dao);
-        return obj.toProxy();
+        return obj;
     }
     static factory(src = undefined, child = this) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -100,8 +100,12 @@ class BaseObjectCore extends AbstractObject_1.AbstractObject {
      */
     static fromDataObject(dao) {
         const obj = new this(dao);
-        return obj.toProxy();
+        return obj; //.toProxy()
     }
+    /**
+     * Wrap instance into proxy to get access to properties
+     * @returns Proxy
+     */
     toProxy() {
         return new ProxyConstructor_1.ProxyConstructor(this, {
             get: (target, prop) => {

package/lib/components/BaseObjectProperties.d.ts

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,87 @@
+"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/BaseRepository.d.ts

@@ -1,24 +1,24 @@
-import { BackendInterface } from '../backends/AbstractAdapter';
-import { Query } from '../backends/Query';
+import { Query, QueryResultType } from '../backends/Query';
 import { BaseObjectCore } from './BaseObjectCore';
 import { DataObjectClass } from './types/DataObjectClass';
-import Payload from './types/Payload';
-import RepositoryClass from './types/RepositoryClass';
 import { BaseObject } from './BaseObject';
-import { Persisted } from './types/Persisted';
-import { Proxy } from './types/ProxyConstructor';
+import { BackendInterface } from '../backends/types/BackendInterface';
 /**
  * CRUD methods for models/entities inheriting from BaseObject
  * Extend this by passing the typeof of the desired class to the constructor
  */
-export default class BaseRepository<T extends BaseObject> implements RepositoryClass<T> {
-    protected model: typeof BaseObjectCore;
+export default class BaseRepository<T extends BaseObject> {
+    protected _model: typeof BaseObjectCore;
     backendAdapter: BackendInterface;
     constructor(model: typeof BaseObjectCore, backendAdapter?: BackendInterface);
     protected getDataObjectFromUid(uid: string): Promise<DataObjectClass<any>>;
-    create(obj: Proxy<T>, uid?: string): Promise<Persisted<T>>;
-    read(uid: string): Promise<Persisted<T>>;
-    update(obj: Proxy<T>): Promise<Persisted<T>>;
-    delete(uid: string): Promise<void>;
-    query(query: Query<typeof BaseObjectCore>): Promise<Payload<Persisted<T>>>;
+    create<B extends BaseObjectCore>(obj: B, uid?: string): Promise<any>;
+    read(key: string): Promise<any>;
+    update(obj: BaseObjectCore): Promise<any>;
+    /**
+     * delete object in its backend
+     * @param uid string
+     */
+    delete(uid: string): Promise<DataObjectClass<any>>;
+    query(query: Query<any>): Promise<QueryResultType<T>>;
 }

package/lib/components/BaseRepository.js

@@ -43,15 +43,15 @@ const RESOURCE_GONE_ERROR = `The resource you are trying to access has been dele
  */
 class BaseRepository {
     constructor(model, backendAdapter = Core_1.Core.getBackend()) {
-        this.model = model;
+        this._model = model;
         this.backendAdapter = backendAdapter;
     }
     getDataObjectFromUid(uid) {
         return __awaiter(this, void 0, void 0, function* () {
-            const collection = this.model.COLLECTION || this.model.name.toLowerCase();
+            const collection = this._model.COLLECTION || this._model.name.toLowerCase();
             const path = `${collection}/${uid}`;
-            const dataObject = yield DataObject_1.DataObject.factory({
-                properties: this.model.PROPS_DEFINITION,
+            const dataObject = DataObject_1.DataObject.factory({
+                properties: this._model.PROPS_DEFINITION,
                 uri: path,
             });
             dataObject.uid = uid;
@@ -60,17 +60,18 @@ class BaseRepository {
     }
     create(obj, uid) {
         return __awaiter(this, void 0, void 0, function* () {
-            const dataObject = obj.core.dataObject;
-            const savedObj = yield this.backendAdapter.create(dataObject, uid);
-            return this.model.fromDataObject(savedObj);
+            const savedObj = yield this.backendAdapter.create(obj.dataObject, uid);
+            return this._model.fromDataObject(savedObj); //as Persisted<T>
         });
     }
-    read(uid) {
+    read(key) {
         return __awaiter(this, void 0, void 0, function* () {
+            const uid = key.indexOf('/') !== -1 ? key.substring(key.lastIndexOf('/') + 1) : key;
             try {
                 const dataObject = yield this.getDataObjectFromUid(uid);
                 const response = yield this.backendAdapter.read(dataObject);
-                const obj = this.model.fromDataObject(response);
+                const obj = this._model.fromDataObject(response);
+                // TODO should be moved to the backend middleware
                 if (obj.status === statuses.DELETED) {
                     throw new ResourcesErrors_1.GoneError(RESOURCE_GONE_ERROR);
                 }
@@ -89,27 +90,24 @@ class BaseRepository {
     }
     update(obj) {
         return __awaiter(this, void 0, void 0, function* () {
-            const dataObject = obj.core.dataObject;
+            const dataObject = obj.dataObject;
             const savedObj = yield this.backendAdapter.update(dataObject);
-            return this.model.fromDataObject(savedObj);
+            return this._model.fromDataObject(savedObj);
         });
     }
+    /**
+     * delete object in its backend
+     * @param uid string
+     */
     delete(uid) {
         return __awaiter(this, void 0, void 0, function* () {
             const dataObject = yield this.getDataObjectFromUid(uid);
-            yield this.backendAdapter.delete(dataObject);
+            return yield this.backendAdapter.delete(dataObject);
         });
     }
     query(query) {
         return __awaiter(this, void 0, void 0, function* () {
-            const items = (yield query.fetchAsInstances(this.backendAdapter));
-            const count = yield this.backendAdapter.count(query);
-            const meta = {
-                count,
-                updatedAt: new Date().getTime(),
-            };
-            const payload = { items, meta };
-            return payload;
+            return yield query.fetchAsInstances(this.backendAdapter);
         });
     }
 }

package/lib/components/DataObject.d.ts

@@ -26,6 +26,7 @@ export declare class DataObject implements DataObjectClass<any> {
     protected _properties: Properties;
     protected _persisted: boolean;
     protected _populated: boolean;
+    protected _proxied: any;
     /**
      * Has data been modified since last backend operation?
      */
@@ -36,7 +37,13 @@ export declare class DataObject implements DataObjectClass<any> {
      */
     protected constructor(params: DataObjectParams | undefined);
     protected _init(properties: any[]): void;
+    /**
+     * Wrap instance into proxy to get access to properties
+     * @returns Proxy
+     */
+    asProxy(): this;
     setProperties(properties: Properties): void;
+    addProperty(property: PropertyClassType): void;
     /**
      * Populate data object from instant data or backend query
      * @param data
@@ -81,7 +88,7 @@ export declare class DataObject implements DataObjectClass<any> {
      * @param key string
      * @returns any
      */
-    val(key: string): any;
+    val(key: string, transform?: string | undefined): any;
     toJSON(objectsAsReferences?: boolean): {
         [x: string]: any;
     };

package/lib/components/DataObject.js

@@ -13,6 +13,7 @@ exports.DataObject = void 0;
 const Core_1 = require("../Core");
 const Property_1 = require("../properties/Property");
 const ObjectUri_1 = require("./ObjectUri");
+const ResourcesErrors_1 = require("../common/ResourcesErrors");
 /**
  * Data objects constitute the agnostic glue between objects and backends.
  * They handle data and identifiers in a protected registry
@@ -52,10 +53,34 @@ class DataObject {
             this._properties[prop.name] = Property_1.Property.factory(prop, this);
         });
     }
+    /**
+     * Wrap instance into proxy to get access to properties
+     * @returns Proxy
+     */
+    asProxy() {
+        return new Proxy(this, {
+            get: (target, prop) => {
+                return target.val(prop);
+            },
+            set(target, prop, newValue) {
+                if (prop === 'uid' || prop === 'core') {
+                    throw new Error(`Property '${prop}' is readonly`);
+                }
+                target.set(prop, newValue);
+                return true;
+            },
+        });
+    }
     setProperties(properties) {
         // TODO check if doable
         this._properties = properties;
     }
+    addProperty(property) {
+        if (Object.keys(this._properties).includes(property.name)) {
+            throw new Error(`Property ${name} already exists`);
+        }
+        this._properties[property.name] = property;
+    }
     /**
      * Populate data object from instant data or backend query
      * @param data
@@ -174,12 +199,10 @@ class DataObject {
      * @returns BaseProperty
      */
     get(key) {
-        try {
-            return this._properties[key];
-        }
-        catch (err) {
-            throw new Error(err.message);
+        if (!Reflect.has(this._properties, key)) {
+            throw new ResourcesErrors_1.NotFoundError(`No property matching key ${key}`);
         }
+        return Reflect.get(this._properties, key);
     }
     set(key, val) {
         if (!this.has(key)) {
@@ -195,16 +218,16 @@ class DataObject {
      * @param key string
      * @returns any
      */
-    val(key) {
+    val(key, transform = undefined) {
         if (this.has(key)) {
-            return Reflect.get(this._properties, key).val();
+            return Reflect.get(this._properties, key).val(transform);
         }
         else {
             throw new Error(`Unknown property '${key}'`);
         }
     }
     toJSON(objectsAsReferences = false) {
-        return Object.assign(Object.assign({}, (this._uid && { uid: this._uid })), this._dataToJSON(objectsAsReferences));
+        return Object.assign(Object.assign({}, (this.uri && { uid: this.uri.uid, path: this.uri.path })), this._dataToJSON(objectsAsReferences));
     }
     toReference() {
         return Object.assign(Object.assign({}, this._objectUri.toReference()), { label: this.val('name') || '' });
@@ -221,7 +244,7 @@ class DataObject {
                     const value = prop.val();
                     Reflect.set(data, key, value
                         ? objectsAsReferences && !(value instanceof ObjectUri_1.ObjectUri)
-                            ? value.core.asReference()
+                            ? value.asReference()
                             : value.toJSON
                                 ? value.toJSON()
                                 : value

package/lib/components/Entity.d.ts

@@ -1,6 +1,6 @@
 import { BaseObjectCore } from './BaseObjectCore';
 import { BaseObject } from './BaseObject';
-import { User, UserCore } from './User';
+import { User } from './User';
 import { EntityClass } from './types/EntityClass';
 export declare const EntityProperties: any;
 export interface Entity extends BaseObject {
@@ -8,19 +8,5 @@ export interface Entity extends BaseObject {
 }
 export declare class EntityCore extends BaseObjectCore implements EntityClass {
     static COLLECTION: string;
-    static PROPS_DEFINITION: ({
-        name: string;
-        type: string;
-        mandatory: boolean;
-        minLength: number;
-        instanceOf?: undefined;
-        parentKey?: undefined;
-    } | {
-        name: string;
-        mandatory: boolean;
-        type: string;
-        instanceOf: typeof UserCore;
-        parentKey: string;
-        minLength?: undefined;
-    })[];
+    static PROPS_DEFINITION: any[];
 }

package/lib/components/Entity.js

@@ -25,6 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EntityCore = exports.EntityProperties = void 0;
 const BaseObjectCore_1 = require("./BaseObjectCore");
+const BaseObject_1 = require("./BaseObject");
 const User_1 = require("./User");
 const CollectionProperty_1 = require("../properties/CollectionProperty");
 const StringProperty_1 = require("../properties/StringProperty");
@@ -49,15 +50,16 @@ exports.EntityProperties = [
 class EntityCore extends BaseObjectCore_1.BaseObjectCore {
 }
 exports.EntityCore = EntityCore;
-EntityCore.COLLECTION = 'entity';
+EntityCore.COLLECTION = 'entities';
 EntityCore.PROPS_DEFINITION = [
+    ...BaseObject_1.BaseObjectProperties,
     {
         // surcharge property minLength and htmlType
         name: 'name',
         type: StringProperty_1.StringProperty.TYPE,
         mandatory: true,
         minLength: 1,
-        //htmlType: htmlType.ORG,
+        htmlType: htmlType.ORG,
     },
     {
         name: 'users',

package/lib/components/EntityProperties.d.ts

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

package/lib/components/EntityProperties.js

@@ -0,0 +1,54 @@
+"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.EntityProperties = void 0;
+const CollectionProperty_1 = require("../properties/CollectionProperty");
+const StringProperty_1 = require("../properties/StringProperty");
+const htmlType = __importStar(require("../properties/types/PropertyHTMLType"));
+const User_1 = require("./User");
+exports.EntityProperties = [
+    {
+        // surcharge property minLength and htmlType
+        name: 'name',
+        type: StringProperty_1.StringProperty.TYPE,
+        mandatory: true,
+        minLength: 1,
+        htmlType: htmlType.ORG,
+    },
+    {
+        name: 'bogus',
+        type: StringProperty_1.StringProperty.TYPE,
+        mandatory: true,
+        minLength: 1,
+        htmlType: htmlType.ORG,
+    },
+    {
+        name: 'users',
+        mandatory: true,
+        type: CollectionProperty_1.CollectionProperty.TYPE,
+        instanceOf: User_1.User,
+        parentKey: 'entity',
+    },
+];

package/lib/components/EntityRepository.d.ts

@@ -1,4 +1,4 @@
-import { BackendInterface } from '../backends';
+import { BackendInterface } from '../backends/types/BackendInterface';
 import BaseRepository from './BaseRepository';
 import { Entity } from './Entity';
 export default class EntityRepository extends BaseRepository<Entity> {

package/lib/components/ObjectUri.js

@@ -48,7 +48,7 @@ class ObjectUri {
             this._label = label || this._uid;
         }
         else {
-            throw new Error('Path parts number must be 1 or even');
+            throw new Error(`Path parts number must be 1 or even, received: '${str}'`);
         }
     }
     set class(objClass) {

package/lib/components/User.d.ts

@@ -1,8 +1,7 @@
 import { BaseObjectCore } from './BaseObjectCore';
 import { BaseObject } from './BaseObject';
-import { Persisted } from './types/Persisted';
-import { Proxy } from './types/ProxyConstructor';
 export interface User extends BaseObject {
+    name: string;
     firstname: string;
     lastname: string;
     gender?: 'male' | 'female' | 'nonbinary';
@@ -14,5 +13,5 @@ export declare const UserProperties: any;
 export declare class UserCore extends BaseObjectCore {
     static PROPS_DEFINITION: any;
     static COLLECTION: string;
-    static factory(src?: any): Promise<Proxy<User> | Persisted<User>>;
+    static factory(src?: any): Promise<UserCore>;
 }

package/lib/components/User.js

@@ -39,6 +39,7 @@ const HashProperty_1 = require("../properties/HashProperty");
 const StringProperty_1 = require("../properties/StringProperty");
 const htmlType = __importStar(require("../properties/types/PropertyHTMLType"));
 const BaseObject_1 = require("./BaseObject");
+const Entity_1 = require("./Entity");
 /**
  * Callback function to populate the 'name' property
  * @param dao DataObject
@@ -52,7 +53,6 @@ exports.UserProperties = [
         name: 'name',
         type: StringProperty_1.StringProperty.TYPE,
         minLength: 0,
-        fullSearch: true,
         htmlType: htmlType.NAME,
     },
     {
@@ -61,6 +61,7 @@ exports.UserProperties = [
         type: StringProperty_1.StringProperty.TYPE,
         minLength: 1,
         maxLength: 100,
+        fullSearch: true,
         htmlType: htmlType.GIVEN_NAME,
         onChange,
     },
@@ -70,6 +71,7 @@ exports.UserProperties = [
         type: StringProperty_1.StringProperty.TYPE,
         minLength: 1,
         maxLength: 100,
+        fullSearch: true,
         htmlType: htmlType.FAMILY_NAME,
         onChange,
     },
@@ -109,7 +111,7 @@ exports.UserProperties = [
         name: 'entity',
         mandatory: false,
         type: properties_1.ObjectProperty.TYPE,
-        instanceOf: BaseObjectCore_1.BaseObjectCore,
+        instanceOf: Entity_1.EntityCore,
     },
 ];
 class UserCore extends BaseObjectCore_1.BaseObjectCore {

package/lib/components/UserProperties.d.ts

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