@quatrain/core 1.0.0-beta1 → 1.0.0-beta11

package/lib/backends/index.d.ts

@@ -1,10 +1,12 @@
-import { AbstractAdapter, BackendInterface, BackendParameters } from './AbstractAdapter';
+import { AbstractAdapter } from './AbstractAdapter';
 import { MockAdapter } from './MockAdapter';
 import { BackendError } from './BackendError';
-import { Query } from './Query';
+import { BackendInterface } from './types/BackendInterface';
+import * as CollectionHierarchy from './types/CollectionHierarchy';
+import { Query, QueryResultType, QueryMetaType } from './Query';
 import { Filter } from './Filter';
 import { Filters } from './Filters';
 import { Sorting } from './Sorting';
 import { Limits } from './Limits';
 import { SortAndLimit } from './SortAndLimit';
-export { AbstractAdapter, BackendInterface, BackendParameters, BackendError, MockAdapter, Query, Filter, Filters, Sorting, Limits, SortAndLimit, };
+export { BackendInterface, AbstractAdapter, BackendError, MockAdapter, Query, QueryResultType, QueryMetaType, Filter, Filters, Sorting, Limits, SortAndLimit, CollectionHierarchy, };

package/lib/backends/index.js

@@ -1,12 +1,37 @@
 "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.SortAndLimit = exports.Limits = exports.Sorting = exports.Filters = exports.Filter = exports.Query = exports.MockAdapter = exports.BackendError = exports.AbstractAdapter = void 0;
+exports.CollectionHierarchy = exports.SortAndLimit = exports.Limits = exports.Sorting = exports.Filters = exports.Filter = exports.Query = exports.MockAdapter = exports.BackendError = exports.AbstractAdapter = void 0;
 const AbstractAdapter_1 = require("./AbstractAdapter");
 Object.defineProperty(exports, "AbstractAdapter", { enumerable: true, get: function () { return AbstractAdapter_1.AbstractAdapter; } });
 const MockAdapter_1 = require("./MockAdapter");
 Object.defineProperty(exports, "MockAdapter", { enumerable: true, get: function () { return MockAdapter_1.MockAdapter; } });
 const BackendError_1 = require("./BackendError");
 Object.defineProperty(exports, "BackendError", { enumerable: true, get: function () { return BackendError_1.BackendError; } });
+const CollectionHierarchy = __importStar(require("./types/CollectionHierarchy"));
+exports.CollectionHierarchy = CollectionHierarchy;
 const Query_1 = require("./Query");
 Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return Query_1.Query; } });
 const Filter_1 = require("./Filter");

package/lib/backends/middlewares/InjectKeywordsMiddleware.d.ts

@@ -0,0 +1,9 @@
+import { DataObjectClass } from '../../components';
+import { BackendAction } from '../../Backend';
+import BackendMiddleware from './Middleware';
+export interface InjectKeywordsMiddlewareParams {
+}
+export declare class InjectKeywordsMiddleware implements BackendMiddleware {
+    execute(dataObject: DataObjectClass<any>, action: BackendAction): void;
+    protected _createKeywords(dataObject: DataObjectClass<any>): string[];
+}

package/lib/backends/middlewares/InjectKeywordsMiddleware.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InjectKeywordsMiddleware = void 0;
+const Backend_1 = require("../../Backend");
+const properties_1 = require("../../properties");
+class InjectKeywordsMiddleware {
+    execute(dataObject, action) {
+        if (!dataObject.has('keywords')) {
+            dataObject.addProperty(new properties_1.ArrayProperty({ name: 'keywords' }));
+        }
+        switch (action) {
+            case Backend_1.BackendAction.CREATE:
+            case Backend_1.BackendAction.UPDATE:
+                dataObject.set('keywords', this._createKeywords(dataObject));
+                break;
+            default:
+                break;
+        }
+        return;
+    }
+    _createKeywords(dataObject) {
+        const keywords = [];
+        Object.keys(dataObject.properties)
+            .filter((key) => dataObject.get(key).fullSearch === true)
+            .forEach((key) => {
+            const val = dataObject.val(key);
+            if (val) {
+                val.toLowerCase()
+                    .split(' ')
+                    .forEach((word) => {
+                    let seq = '';
+                    word
+                        .split('')
+                        .splice(0, 15)
+                        .forEach((letter) => {
+                        seq += letter;
+                        if (seq.length > 1) {
+                            keywords.push(seq);
+                        }
+                    });
+                });
+            }
+        });
+        return [...new Set(keywords)];
+    }
+}
+exports.InjectKeywordsMiddleware = InjectKeywordsMiddleware;

package/lib/backends/middlewares/InjectMetaMiddleware.d.ts

@@ -1,12 +1,13 @@
 import { DataObjectClass } from '../../components';
 import { BackendAction } from '../../Backend';
-import { UserCore } from '../../components/User';
-import Middleware from './Middleware';
+import { User } from '../../components/User';
+import BackendMiddleware from './Middleware';
+import { MiddlewareParams } from './types/MiddlewareParams';
 export interface InjectMetaMiddlewareParams {
-    user: UserCore;
+    user: User;
 }
-export declare class InjectMetaMiddleware implements Middleware {
-    protected _user: UserCore;
+export declare class InjectMetaMiddleware implements BackendMiddleware {
+    protected _user: User;
     constructor(params: InjectMetaMiddlewareParams);
-    execute(dataObject: DataObjectClass<any>, action: BackendAction): void;
+    execute(dataObject: DataObjectClass<any>, action: BackendAction, params?: MiddlewareParams): void;
 }

package/lib/backends/middlewares/InjectMetaMiddleware.js

@@ -2,24 +2,27 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InjectMetaMiddleware = void 0;
 const Backend_1 = require("../../Backend");
+const Core_1 = require("../../Core");
 class InjectMetaMiddleware {
     constructor(params) {
         this._user = params.user;
     }
-    execute(dataObject, action) {
+    execute(dataObject, action, params) {
+        Core_1.Core.log(`[MDW] Executing Middleware ${this.constructor.name}`);
+        const date = params && params.useDateFormat ? (new Date()).toISOString() : Date.now();
         switch (action) {
             // add properties existence validation
             case Backend_1.BackendAction.CREATE:
                 dataObject.set('createdBy', this._user);
-                dataObject.set('createdAt', Date.now());
+                dataObject.set('createdAt', date);
                 break;
             case Backend_1.BackendAction.UPDATE:
                 dataObject.set('updatedBy', this._user);
-                dataObject.set('updatedAt', Date.now());
+                dataObject.set('updatedAt', date);
                 break;
             case Backend_1.BackendAction.DELETE:
                 dataObject.set('deletedBy', this._user);
-                dataObject.set('deletedAt', Date.now());
+                dataObject.set('deletedAt', date);
                 break;
             default:
                 break;

package/lib/backends/middlewares/Middleware.d.ts

@@ -1,5 +1,5 @@
 import { BackendAction } from '../../Backend';
 import { DataObjectClass } from '../../components';
-export default interface Middleware {
-    execute: (dataObject: DataObjectClass<any>, action: BackendAction) => void;
+export default interface BackendMiddleware {
+    execute: (dataObject: DataObjectClass<any>, action: BackendAction, params?: any) => void;
 }

package/lib/backends/middlewares/types/MiddlewareParams.d.ts

@@ -0,0 +1,3 @@
+export type MiddlewareParams = {
+    useDateFormat?: boolean;
+};

package/lib/backends/middlewares/types/MiddlewareParams.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/backends/types/BackendInterface.d.ts

@@ -0,0 +1,13 @@
+import { DataObjectClass } from '../../components';
+import { Filter } from '../Filter';
+import { Filters } from '../Filters';
+import { Query, QueryResultType } from '../Query';
+import { SortAndLimit } from '../SortAndLimit';
+export interface BackendInterface {
+    create(dataObject: DataObjectClass<any>, desiredUid: string | undefined): Promise<DataObjectClass<any>>;
+    read(param: string | DataObjectClass<any>): Promise<DataObjectClass<any>>;
+    update(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
+    delete(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
+    query(query: Query<any>): Promise<QueryResultType<DataObjectClass<any>>>;
+    find(dataObject: DataObjectClass<any>, filters: Filters | Filter[] | undefined, pagination: SortAndLimit | undefined, parent: any): Promise<QueryResultType<DataObjectClass<any>>>;
+}

package/lib/backends/types/BackendInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/backends/types/CollectionHierarchy.d.ts

@@ -0,0 +1,3 @@
+export declare const STANDARD = 1;
+export declare const SUBCOLLECTION = 2;
+export declare const SUBCOLLECTION_GROUP = 3;

package/lib/backends/types/CollectionHierarchy.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUBCOLLECTION_GROUP = exports.SUBCOLLECTION = exports.STANDARD = void 0;
+exports.STANDARD = 1;
+exports.SUBCOLLECTION = 2;
+exports.SUBCOLLECTION_GROUP = 3;

package/lib/common/statuses.d.ts

@@ -2,11 +2,13 @@ export declare const CREATED = "created";
 export declare const PENDING = "pending";
 export declare const QUEUED = "queued";
 export declare const ACTIVE = "active";
+export declare const COMPLETED = "completed";
 export declare const ERROR = "error";
 export declare const TEST = "test";
 export declare const SUSPENDED = "suspended";
 export declare const DELETABLE = "deletable";
 export declare const DELETED = "deleted";
+export declare const DISABLED = "disabled";
 export declare const DONE = "done";
 export declare const MAINTENANCE = "maintenance";
 export declare const UNKNOWN = "unknown";

package/lib/common/statuses.js

@@ -1,15 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UNKNOWN = exports.MAINTENANCE = exports.DONE = exports.DELETED = exports.DELETABLE = exports.SUSPENDED = exports.TEST = exports.ERROR = exports.ACTIVE = exports.QUEUED = exports.PENDING = exports.CREATED = void 0;
+exports.UNKNOWN = exports.MAINTENANCE = exports.DONE = exports.DISABLED = exports.DELETED = exports.DELETABLE = exports.SUSPENDED = exports.TEST = exports.ERROR = exports.COMPLETED = exports.ACTIVE = exports.QUEUED = exports.PENDING = exports.CREATED = void 0;
 exports.CREATED = 'created';
 exports.PENDING = 'pending';
 exports.QUEUED = 'queued';
 exports.ACTIVE = 'active';
+exports.COMPLETED = 'completed';
 exports.ERROR = 'error';
 exports.TEST = 'test';
 exports.SUSPENDED = 'suspended';
 exports.DELETABLE = 'deletable';
 exports.DELETED = 'deleted';
+exports.DISABLED = 'disabled';
 exports.DONE = 'done';
 exports.MAINTENANCE = 'maintenance';
 exports.UNKNOWN = 'unknown';

package/lib/components/AbstractObject.d.ts

@@ -1,8 +1,10 @@
 import { DataObjectClass } from './types/DataObjectClass';
-import { DataObjectProperties } from '../properties/';
+import { DataObjectProperties } from '../properties';
 export declare abstract class AbstractObject {
     static PROPS_DEFINITION: DataObjectProperties;
     static COLLECTION: string | undefined;
+    static PARENT_PROP: string | undefined;
+    static DEFAULT_BACKEND: string;
     static LABEL_KEY: string;
     protected _dataObject: DataObjectClass<any>;
     constructor(dao: DataObjectClass<any>);

package/lib/components/AbstractObject.js

@@ -70,5 +70,6 @@ class AbstractObject {
 }
 exports.AbstractObject = AbstractObject;
 AbstractObject.PROPS_DEFINITION = [];
+AbstractObject.DEFAULT_BACKEND = 'default';
 // Which property's value to use in backend as label for object reference
 AbstractObject.LABEL_KEY = 'name';

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

@@ -37,6 +37,7 @@ exports.BaseObjectProperties = [
         type: StringProperty_1.StringProperty.TYPE,
         minLength: 1,
         maxLength: 100,
+        fullSearch: true,
         htmlType: htmlType.NAME,
     },
     {

package/lib/components/BaseObjectCore.d.ts

@@ -59,6 +59,15 @@ export declare class BaseObjectCore extends AbstractObject implements BaseObject
      */
     protected toProxy<T extends BaseObject>(): Proxy<Proxy<T>>;
     asReference(): any;
-    query(): Query<any>;
+    /**
+     * Create a query based on given class where parent is current instance
+     * @param obj
+     * @returns Query
+     */
+    query(obj: any): Query<any>;
+    /**
+     * Create a query based on current class
+     * @returns Query
+     */
     static query(): Query<typeof BaseObjectCore>;
 }

package/lib/components/BaseObjectCore.js

@@ -33,7 +33,10 @@ class BaseObjectCore extends AbstractObject_1.AbstractObject {
                 base.push(property);
             }
         });
-        const dao = DataObject_1.DataObject.factory({ properties: base });
+        const dao = DataObject_1.DataObject.factory({
+            properties: base,
+            parentProp: this.PARENT_PROP,
+        });
         dao.uri.class = child;
         return dao;
     }
@@ -63,7 +66,7 @@ class BaseObjectCore extends AbstractObject_1.AbstractObject {
         dao.uri.class = child;
         dao.populateFromData(src);
         const obj = new this(dao);
-        return obj; //.toProxy() as Proxy<T>
+        return obj;
     }
     static factory(src = undefined, child = this) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -144,12 +147,20 @@ class BaseObjectCore extends AbstractObject_1.AbstractObject {
         });
     }
     asReference() {
-        console.log(this._dataObject.toReference());
         return this._dataObject.toReference();
     }
-    query() {
-        return new Query_1.Query(this.constructor.prototype);
+    /**
+     * Create a query based on given class where parent is current instance
+     * @param obj
+     * @returns Query
+     */
+    query(obj) {
+        return new Query_1.Query(obj, this);
     }
+    /**
+     * Create a query based on current class
+     * @returns Query
+     */
     static query() {
         return new Query_1.Query(this);
     }

package/lib/components/BaseRepository.d.ts

@@ -1,11 +1,8 @@
-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 { 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
@@ -15,9 +12,14 @@ export default class BaseRepository<T extends BaseObject> {
     backendAdapter: BackendInterface;
     constructor(model: typeof BaseObjectCore, backendAdapter?: BackendInterface);
     protected getDataObjectFromUid(uid: string): Promise<DataObjectClass<any>>;
+    protected getDataObjectFromPath(path: string): Promise<DataObjectClass<any>>;
     create<B extends BaseObjectCore>(obj: B, uid?: string): Promise<any>;
     read(key: string): Promise<any>;
-    update(obj: Proxy<T>): Promise<Persisted<T>>;
-    delete(uid: string): Promise<void>;
-    query(query: Query<typeof BaseObjectCore>): Promise<Payload<Persisted<T>>>;
+    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

@@ -58,17 +58,35 @@ class BaseRepository {
             return dataObject;
         });
     }
+    getDataObjectFromPath(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const dataObject = DataObject_1.DataObject.factory({
+                properties: this._model.PROPS_DEFINITION,
+                uri: path,
+            });
+            dataObject.uid = path.substring(path.lastIndexOf('/') + 1);
+            return dataObject;
+        });
+    }
     create(obj, uid) {
         return __awaiter(this, void 0, void 0, function* () {
             const savedObj = yield this.backendAdapter.create(obj.dataObject, uid);
-            return this._model.fromDataObject(savedObj); //as Persisted<T>
+            return this._model.fromDataObject(savedObj);
         });
     }
     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);
+                let dataObject;
+                if (key.split('/').length <= 2) {
+                    const uid = key.indexOf('/') !== -1
+                        ? key.substring(key.lastIndexOf('/') + 1)
+                        : key;
+                    dataObject = yield this.getDataObjectFromUid(uid);
+                }
+                else {
+                    dataObject = yield this.getDataObjectFromPath(key);
+                }
                 const response = yield this.backendAdapter.read(dataObject);
                 const obj = this._model.fromDataObject(response);
                 // TODO should be moved to the backend middleware
@@ -90,27 +108,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);
         });
     }
+    /**
+     * 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

@@ -3,6 +3,7 @@ import { PropertyClassType } from '../properties/types/PropertyClassType';
 import { AbstractObject } from './AbstractObject';
 import { ObjectUri } from './ObjectUri';
 import { DataObjectClass } from './types/DataObjectClass';
+import { toJSONParams } from './types/toJSONParams';
 export type CoreObject<T extends AbstractObject> = T;
 export type Properties = {
     [x: string]: PropertyClassType;
@@ -14,6 +15,7 @@ export interface DataObjectFactoryType {
 export interface DataObjectParams {
     uri?: string | ObjectUri;
     properties: DataObjectProperties;
+    parentProp?: string;
 }
 /**
  * Data objects constitute the agnostic glue between objects and backends.
@@ -26,6 +28,7 @@ export declare class DataObject implements DataObjectClass<any> {
     protected _properties: Properties;
     protected _persisted: boolean;
     protected _populated: boolean;
+    protected _parentProp: string | undefined;
     protected _proxied: any;
     /**
      * Has data been modified since last backend operation?
@@ -43,6 +46,13 @@ export declare class DataObject implements DataObjectClass<any> {
      */
     asProxy(): this;
     setProperties(properties: Properties): void;
+    /**
+     * Return a map of all propoerties or only those matching the provided type
+     * @param type
+     * @returns
+     */
+    getProperties(type?: string): {};
+    addProperty(property: PropertyClassType): void;
     /**
      * Populate data object from instant data or backend query
      * @param data
@@ -74,6 +84,7 @@ export declare class DataObject implements DataObjectClass<any> {
     set uri(uri: ObjectUri);
     get uri(): ObjectUri;
     get class(): any;
+    get parentProp(): string | undefined;
     has(key: string): boolean;
     /**
      * Returns property matching key or throw
@@ -88,7 +99,7 @@ export declare class DataObject implements DataObjectClass<any> {
      * @returns any
      */
     val(key: string, transform?: string | undefined): any;
-    toJSON(objectsAsReferences?: boolean): {
+    toJSON(params?: boolean | toJSONParams): {
         [x: string]: any;
     };
     toReference(): {
@@ -96,7 +107,7 @@ export declare class DataObject implements DataObjectClass<any> {
         ref: string;
         uri: string;
     };
-    protected _dataToJSON(objectsAsReferences?: boolean): {};
+    protected _dataToJSON(objectsAsReferences?: boolean, ignoreUnchanged?: boolean, converters?: {}): {};
     read(): Promise<DataObjectClass<any>>;
     save(): Promise<DataObjectClass<any>>;
     delete(): Promise<DataObjectClass<any>>;