@quatrain/core 1.0.0-beta2 → 1.0.0-beta21

package/lib/storages/types/FileResponseUrl.d.ts

@@ -0,0 +1,4 @@
+export type FileResponseUrl = {
+    url: string;
+    expiresIn: number;
+};

package/lib/storages/types/FileResponseUrl.js

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

package/lib/storages/types/FileType.d.ts

@@ -0,0 +1,15 @@
+export interface FileType {
+    bucket: string;
+    ref: string;
+    label?: string;
+    contentType?: string;
+    size?: number;
+    framerate?: number;
+    duration?: number;
+    bitrate?: number;
+    width?: number;
+    height?: number;
+    thumb128?: string;
+    thumb256?: string;
+    [x: string]: any;
+}

package/lib/storages/types/FileType.js

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

package/lib/storages/types.d.ts

@@ -0,0 +1,5 @@
+export type APIMoveFile = {
+    cloud: string;
+    ref: string;
+    bucket: string;
+};

package/lib/storages/types.js

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

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/lib/wrappers/cloud/types/DatabaseTriggerType.d.ts

@@ -0,0 +1,8 @@
+import { BackendAction } from '../../../Backend';
+export type DatabaseTriggerType = {
+    name: string;
+    event: BackendAction;
+    model: string;
+    path: string;
+    script: Function;
+};

package/lib/wrappers/cloud/types/DatabaseTriggerType.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@quatrain/core",
-   "version": "1.0.0-beta2",
+   "version": "1.0.0-beta21",
    "description": "Core objects for business apps",
    "main": "lib/index.js",
    "types": "lib/index.d.ts",
@@ -13,6 +13,7 @@
    "devDependencies": {
       "@tsconfig/recommended": "^1.0.1",
       "@types/jest": "^27.0.3",
+      "@types/node-persist": "^3.1.8",
       "jest": "^27.4.7",
       "jest-node-exports-resolver": "^1.1.6",
       "trace-unhandled": "^2.0.1",
@@ -21,7 +22,8 @@
       "typescript": "^5.1.5"
    },
    "dependencies": {
-      "@faker-js/faker": "^7.6.0"
+      "@faker-js/faker": "^7.6.0",
+      "node-persist": "^4.0.3"
    },
    "scripts": {
       "test": "tsc && jest --verbose",
@@ -30,4 +32,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/backends/BackendInterface.d.ts

@@ -1,13 +0,0 @@
-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): Promise<QueryResultType<DataObjectClass<any>>>;
-}

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

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

package/lib/backends/middlewares/InjectMetaMiddleware copy.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InjectMetaMiddleware = void 0;
-const Backend_1 = require("../../Backend");
-class InjectMetaMiddleware {
-    constructor(params) {
-        this._user = params.user;
-    }
-    execute(dataObject, action) {
-        switch (action) {
-            // add properties existence validation
-            case Backend_1.BackendAction.CREATE:
-                dataObject.set('createdBy', this._user);
-                dataObject.set('createdAt', Date.now());
-                break;
-            case Backend_1.BackendAction.UPDATE:
-                dataObject.set('updatedBy', this._user);
-                dataObject.set('updatedAt', Date.now());
-                break;
-            case Backend_1.BackendAction.DELETE:
-                dataObject.set('deletedBy', this._user);
-                dataObject.set('deletedAt', Date.now());
-                break;
-            default:
-                break;
-        }
-        return;
-    }
-}
-exports.InjectMetaMiddleware = InjectMetaMiddleware;

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;

package/lib/components/EntityProperties.js

@@ -1,54 +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.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/UserProperties.d.ts

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

package/lib/components/UserProperties.js

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

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

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