@quatrain/core 1.0.0-beta2 → 1.0.0-beta3

package/lib/Auth.d.ts

@@ -0,0 +1,25 @@
+import Middleware from './authentication/middlewares/Middleware';
+export declare enum AuthAction {
+    SIGNIN = "signin",
+    SIGNUP = "signup",
+    SIGNOUT = "signout"
+}
+/**
+ * Authentication Parameters acceptable keys
+ */
+export type AuthParametersKeys = 'host' | 'alias' | 'mapping' | 'middlewares' | 'config' | 'fixtures' | 'debug';
+/**
+ * Backend parameters interface
+ */
+export interface AuthParameters {
+    host?: string;
+    alias?: string;
+    mapping?: {
+        [x: string]: any;
+    };
+    middlewares?: Middleware[];
+    config?: any;
+    fixtures?: any;
+    softDelete?: boolean;
+    debug?: boolean;
+}

package/lib/Auth.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthAction = void 0;
+var AuthAction;
+(function (AuthAction) {
+    AuthAction["SIGNIN"] = "signin";
+    AuthAction["SIGNUP"] = "signup";
+    AuthAction["SIGNOUT"] = "signout";
+})(AuthAction || (exports.AuthAction = AuthAction = {}));

package/lib/Core.d.ts

@@ -1,16 +1,18 @@
+import { AbstractAuthAdapter } from './authentication';
 import { AbstractAdapter } from './backends/AbstractAdapter';
-import { UserCore } from './components/User';
+import { User } from './components/User';
 import { DataObjectClass } from './components/types/DataObjectClass';
 export type BackendRegistry<T extends AbstractAdapter> = {
     [x: string]: T;
 };
 export declare class Core {
     static defaultBackend: string;
-    static userClass: typeof UserCore;
+    static userClass: typeof User;
     static classRegistry: {
         [key: string]: any;
     };
     static logger: Console;
+    static auth: AbstractAuthAdapter;
     static timestamp: () => string;
     protected static _backends: BackendRegistry<any>;
     static definition(key: string): {

package/lib/Core.js

@@ -52,7 +52,7 @@ class Core {
 }
 exports.Core = Core;
 Core.defaultBackend = '@default';
-Core.userClass = User_1.UserCore;
+Core.userClass = User_1.User;
 Core.classRegistry = {};
 Core.logger = console;
 // How timestamp are formatted

package/lib/authentication/AbstractAuthAdapter.d.ts

@@ -0,0 +1,21 @@
+import { AuthParameters, AuthParametersKeys } from '../Auth';
+import { User } from '../components/User';
+import Middleware from './middlewares/Middleware';
+import { AuthInterface } from './types/AuthInterface';
+export declare abstract class AbstractAuthAdapter implements AuthInterface {
+    protected _alias: string;
+    protected _params: AuthParameters;
+    protected _middlewares: any[];
+    constructor(params?: AuthParameters);
+    setParam(key: AuthParametersKeys, value: any): void;
+    getParam(key: AuthParametersKeys): any;
+    addMiddleware(middleware: Middleware): void;
+    set alias(alias: string);
+    get alias(): string;
+    abstract register(user: User): Promise<any>;
+    abstract signup(login: string, password: string): Promise<any>;
+    abstract signout(user: User): Promise<any>;
+    abstract update(user: User, updatable: any): Promise<any>;
+    abstract delete(user: User): Promise<any>;
+    abstract getAuthToken(token: string): any;
+}

package/lib/authentication/AbstractAuthAdapter.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractAuthAdapter = void 0;
+class AbstractAuthAdapter {
+    constructor(params = {}) {
+        this._alias = '';
+        this._params = {};
+        this._middlewares = [];
+        this._alias = params.alias || '';
+        this._middlewares = params.middlewares || [];
+    }
+    setParam(key, value) {
+        this._params[key] = value;
+    }
+    getParam(key) {
+        return this._params[key];
+    }
+    addMiddleware(middleware) {
+        this._middlewares.push(middleware);
+    }
+    set alias(alias) {
+        this._alias = alias;
+    }
+    get alias() {
+        return this._alias;
+    }
+}
+exports.AbstractAuthAdapter = AbstractAuthAdapter;

package/lib/authentication/AuthenticationError.d.ts

@@ -0,0 +1,2 @@
+export declare class AuthenticationError extends Error {
+}

package/lib/authentication/AuthenticationError.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthenticationError = void 0;
+class AuthenticationError extends Error {
+}
+exports.AuthenticationError = AuthenticationError;

package/lib/authentication/index.d.ts

@@ -0,0 +1,4 @@
+import { AbstractAuthAdapter } from './AbstractAuthAdapter';
+import { AuthInterface } from './types/AuthInterface';
+import { AuthenticationError } from './AuthenticationError';
+export { AuthInterface, AbstractAuthAdapter, AuthenticationError };

package/lib/authentication/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthenticationError = exports.AbstractAuthAdapter = void 0;
+const AbstractAuthAdapter_1 = require("./AbstractAuthAdapter");
+Object.defineProperty(exports, "AbstractAuthAdapter", { enumerable: true, get: function () { return AbstractAuthAdapter_1.AbstractAuthAdapter; } });
+const AuthenticationError_1 = require("./AuthenticationError");
+Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return AuthenticationError_1.AuthenticationError; } });

package/lib/authentication/middlewares/AbstractAuthMiddleware.js

@@ -0,0 +1 @@
+"use strict";

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

@@ -0,0 +1,5 @@
+import { AuthAction } from '../../Auth';
+import { User } from '../../components/User';
+export default interface Middleware {
+    execute: (user: User, action: AuthAction) => void;
+}

package/lib/authentication/types/AuthInterface.d.ts

@@ -0,0 +1,9 @@
+import { User } from '../../components/User';
+export interface AuthInterface {
+    register(user: User): Promise<any>;
+    signup(login: string, password: string): Promise<any>;
+    signout(user: User): Promise<any>;
+    update(user: User, updatable: any): Promise<any>;
+    delete(user: User): Promise<any>;
+    getAuthToken(token: string): any;
+}

package/lib/backends/AbstractAdapter.d.ts

@@ -14,6 +14,12 @@ export declare abstract class AbstractAdapter implements BackendInterface {
     setParam(key: BackendParametersKeys, value: any): void;
     getParam(key: BackendParametersKeys): any;
     addMiddleware(middleware: Middleware): void;
+    /**
+     * Returns true if a given middleware is attached
+     * @param className
+     * @returns boolean
+     */
+    hasMiddleware(className: string): boolean;
     set alias(alias: string);
     get alias(): string;
     getCollection(dao: DataObjectClass<any>): string | undefined;

package/lib/backends/AbstractAdapter.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractAdapter = void 0;
+const BackendError_1 = require("./BackendError");
 class AbstractAdapter {
     constructor(params = {}) {
         this._alias = '';
@@ -25,8 +26,25 @@ class AbstractAdapter {
         return this._params[key];
     }
     addMiddleware(middleware) {
+        if (this.hasMiddleware(middleware.constructor.name)) {
+            throw new BackendError_1.BackendError(`Middleware '${middleware.constructor.name}' is already attached`);
+        }
         this._middlewares.push(middleware);
     }
+    /**
+     * Returns true if a given middleware is attached
+     * @param className
+     * @returns boolean
+     */
+    hasMiddleware(className) {
+        let has = false;
+        this._middlewares.forEach((middleware) => {
+            if (middleware.constructor.name === className) {
+                has = true;
+            }
+        });
+        return has;
+    }
     set alias(alias) {
         this._alias = alias;
     }

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

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

package/lib/components/AbstractObject.d.ts

@@ -1,5 +1,5 @@
 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;

package/lib/components/DataObject.js

@@ -242,6 +242,7 @@ class DataObject {
                     break;
                 case 'ObjectProperty':
                     const value = prop.val();
+                    console.log(value, typeof value);
                     Reflect.set(data, key, value
                         ? objectsAsReferences && !(value instanceof ObjectUri_1.ObjectUri)
                             ? value.asReference()

package/lib/components/Entity.d.ts

@@ -3,10 +3,10 @@ import { BaseObject } from './BaseObject';
 import { User } from './User';
 import { EntityClass } from './types/EntityClass';
 export declare const EntityProperties: any;
-export interface Entity extends BaseObject {
-    users: User;
+export interface EntityType extends BaseObject {
+    users?: User[];
 }
-export declare class EntityCore extends BaseObjectCore implements EntityClass {
+export declare class Entity extends BaseObjectCore implements EntityClass {
     static COLLECTION: string;
     static PROPS_DEFINITION: any[];
 }

package/lib/components/Entity.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntityCore = exports.EntityProperties = void 0;
+exports.Entity = exports.EntityProperties = void 0;
 const BaseObjectCore_1 = require("./BaseObjectCore");
 const BaseObject_1 = require("./BaseObject");
 const User_1 = require("./User");
@@ -47,11 +47,11 @@ exports.EntityProperties = [
         parentKey: 'entity',
     },
 ];
-class EntityCore extends BaseObjectCore_1.BaseObjectCore {
+class Entity extends BaseObjectCore_1.BaseObjectCore {
 }
-exports.EntityCore = EntityCore;
-EntityCore.COLLECTION = 'entities';
-EntityCore.PROPS_DEFINITION = [
+exports.Entity = Entity;
+Entity.COLLECTION = 'entities';
+Entity.PROPS_DEFINITION = [
     ...BaseObject_1.BaseObjectProperties,
     {
         // surcharge property minLength and htmlType
@@ -65,7 +65,7 @@ EntityCore.PROPS_DEFINITION = [
         name: 'users',
         mandatory: true,
         type: CollectionProperty_1.CollectionProperty.TYPE,
-        instanceOf: User_1.UserCore,
+        instanceOf: User_1.User,
         parentKey: 'entity',
     },
 ];

package/lib/components/EntityRepository.d.ts

@@ -1,6 +1,6 @@
 import { BackendInterface } from '../backends/types/BackendInterface';
 import BaseRepository from './BaseRepository';
-import { Entity } from './Entity';
-export default class EntityRepository extends BaseRepository<Entity> {
+import { EntityType } from './Entity';
+export default class EntityRepository extends BaseRepository<EntityType> {
     constructor(backendAdapter?: BackendInterface);
 }

package/lib/components/EntityRepository.js

@@ -8,7 +8,7 @@ const BaseRepository_1 = __importDefault(require("./BaseRepository"));
 const Entity_1 = require("./Entity");
 class EntityRepository extends BaseRepository_1.default {
     constructor(backendAdapter = Core_1.Core.getBackend()) {
-        super(Entity_1.EntityCore, backendAdapter);
+        super(Entity_1.Entity, backendAdapter);
     }
 }
 exports.default = EntityRepository;

package/lib/components/ObjectUri.js

@@ -52,10 +52,9 @@ class ObjectUri {
         }
     }
     set class(objClass) {
-        var _a;
         this._objClass = objClass;
         if (objClass) {
-            this._collection = objClass.COLLECTION || ((_a = objClass.name) === null || _a === void 0 ? void 0 : _a.toLowerCase());
+            this._collection = objClass.COLLECTION || objClass.name && objClass.name.toLowerCase();
         }
         else {
             this._collection = undefined;

package/lib/components/User.d.ts

@@ -1,6 +1,6 @@
 import { BaseObjectCore } from './BaseObjectCore';
 import { BaseObject } from './BaseObject';
-export interface User extends BaseObject {
+export interface UserType extends BaseObject {
     name: string;
     firstname: string;
     lastname: string;
@@ -10,8 +10,8 @@ export interface User extends BaseObject {
     email: string;
 }
 export declare const UserProperties: any;
-export declare class UserCore extends BaseObjectCore {
+export declare class User extends BaseObjectCore {
     static PROPS_DEFINITION: any;
     static COLLECTION: string;
-    static factory(src?: any): Promise<UserCore>;
+    static factory(src?: any): Promise<User>;
 }

package/lib/components/User.js

@@ -32,7 +32,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserCore = exports.UserProperties = void 0;
+exports.User = exports.UserProperties = void 0;
 const BaseObjectCore_1 = require("./BaseObjectCore");
 const properties_1 = require("../properties");
 const HashProperty_1 = require("../properties/HashProperty");
@@ -97,33 +97,40 @@ exports.UserProperties = [
         fullSearch: true,
         htmlType: htmlType.EMAIL,
     },
+    {
+        name: 'phone',
+        type: StringProperty_1.StringProperty.TYPE,
+        minLength: 1,
+        maxLength: 100,
+        htmlType: htmlType.OFF,
+    },
     {
         name: 'password',
         mandatory: true,
         type: HashProperty_1.HashProperty.TYPE,
         algorithm: HashProperty_1.HashProperty.ALGORITHM_SHA256,
-        salt: '',
+        salt: '', // you should override it in your code
         minLength: 5,
-        maxLength: 20,
+        maxLength: 20, // this is for the clear password
         htmlType: htmlType.PASSWORD,
     },
     {
         name: 'entity',
         mandatory: false,
         type: properties_1.ObjectProperty.TYPE,
-        instanceOf: Entity_1.EntityCore,
+        instanceOf: Entity_1.Entity,
     },
 ];
-class UserCore extends BaseObjectCore_1.BaseObjectCore {
+class User extends BaseObjectCore_1.BaseObjectCore {
     static factory(src = undefined) {
         const _super = Object.create(null, {
             factory: { get: () => super.factory }
         });
         return __awaiter(this, void 0, void 0, function* () {
-            return _super.factory.call(this, src, UserCore);
+            return _super.factory.call(this, src, User);
         });
     }
 }
-exports.UserCore = UserCore;
-UserCore.PROPS_DEFINITION = exports.UserProperties;
-UserCore.COLLECTION = 'user';
+exports.User = User;
+User.PROPS_DEFINITION = exports.UserProperties;
+User.COLLECTION = 'user';

package/lib/components/UserRepository.d.ts

@@ -1,7 +1,7 @@
 import { BackendInterface } from '../backends/types/BackendInterface';
 import BaseRepository from './BaseRepository';
-import { User } from './User';
-export default class UserRepository extends BaseRepository<User> {
+import { UserType } from './User';
+export default class UserRepository extends BaseRepository<UserType> {
     constructor(backendAdapter?: BackendInterface);
-    getFromEmail(email: string): Promise<User>;
+    getFromEmail(email: string): Promise<UserType>;
 }

package/lib/components/UserRepository.js

@@ -19,11 +19,11 @@ const User_1 = require("./User");
 const UNAUTHORIZED_ERROR = `Wrong password or email`;
 class UserRepository extends BaseRepository_1.default {
     constructor(backendAdapter) {
-        super(User_1.UserCore, backendAdapter);
+        super(User_1.User, backendAdapter);
     }
     getFromEmail(email) {
         return __awaiter(this, void 0, void 0, function* () {
-            const query = new backends_1.Query(User_1.UserCore);
+            const query = new backends_1.Query(User_1.User);
             query.where('email', email).batch(1);
             const { items } = yield this.query(query);
             if (items.length == 0) {

package/lib/components/index.d.ts

@@ -5,6 +5,6 @@ import { AbstractObject } from './AbstractObject';
 import { BaseObjectCore } from './BaseObjectCore';
 import { BaseObjectProperties } from './BaseObject';
 import BaseRepository from './BaseRepository';
-import { UserCore, UserProperties } from './User';
+import { User, UserProperties } from './User';
 import { Entity } from './Entity';
-export { DataObject, DataObjectParams, DataObjectClass, ObjectUri, AbstractObject, BaseObjectCore, BaseRepository, UserCore, Entity, BaseObjectProperties, UserProperties, };
+export { DataObject, DataObjectParams, DataObjectClass, ObjectUri, AbstractObject, BaseObjectCore, BaseRepository, User, Entity, BaseObjectProperties, UserProperties, };

package/lib/components/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserProperties = exports.BaseObjectProperties = exports.UserCore = exports.BaseRepository = exports.BaseObjectCore = exports.AbstractObject = exports.ObjectUri = exports.DataObject = void 0;
+exports.UserProperties = exports.BaseObjectProperties = exports.Entity = exports.User = exports.BaseRepository = exports.BaseObjectCore = exports.AbstractObject = exports.ObjectUri = exports.DataObject = void 0;
 const DataObject_1 = require("./DataObject");
 Object.defineProperty(exports, "DataObject", { enumerable: true, get: function () { return DataObject_1.DataObject; } });
 const ObjectUri_1 = require("./ObjectUri");
@@ -17,5 +17,7 @@ Object.defineProperty(exports, "BaseObjectProperties", { enumerable: true, get:
 const BaseRepository_1 = __importDefault(require("./BaseRepository"));
 exports.BaseRepository = BaseRepository_1.default;
 const User_1 = require("./User");
-Object.defineProperty(exports, "UserCore", { enumerable: true, get: function () { return User_1.UserCore; } });
+Object.defineProperty(exports, "User", { enumerable: true, get: function () { return User_1.User; } });
 Object.defineProperty(exports, "UserProperties", { enumerable: true, get: function () { return User_1.UserProperties; } });
+const Entity_1 = require("./Entity");
+Object.defineProperty(exports, "Entity", { enumerable: true, get: function () { return Entity_1.Entity; } });

package/lib/index.d.ts

@@ -22,10 +22,12 @@ import RepositoryClass from './components/types/RepositoryClass';
 import BaseRepository from './components/BaseRepository';
 import { BackendAction, BackendParameters, BackendParametersKeys, BackendRecordType } from './Backend';
 import Middleware from './backends/middlewares/Middleware';
-import { User } from './components/User';
+import { UserType, User } from './components/User';
 import UserRepository from './components/UserRepository';
 import { Entity } from './components/Entity';
 import EntityRepository from './components/EntityRepository';
+import { AuthAction, AuthParameters, AuthParametersKeys } from './Auth';
+import { AuthInterface, AbstractAuthAdapter, AuthenticationError } from './authentication';
 import { AbstractAdapter, MockAdapter, BackendError, Query, QueryMetaType, QueryResultType, Filter, Filters, Limits, Sorting, SortAndLimit } from './backends';
 import { BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, GoneError } from './common/ResourcesErrors';
-export { statuses, utils, Core, Property, BaseProperty, BasePropertyType, BooleanProperty, BooleanPropertyType, DateTimeProperty, DateTimePropertyType, EnumProperty, EnumPropertyType, HashProperty, HashPropertyType, ObjectProperty, ObjectPropertyType, StringProperty, StringPropertyType, AbstractAdapter, RepositoryClass, MockAdapter, ObjectUri, DataObjectClass, DataObject, AbstractObject, BaseObject, BaseObjectCore, BaseObjectProperties, BackendParameters, BackendParametersKeys, BackendRecordType, BackendAction, BaseRepository, BackendError, Query, QueryMetaType, QueryResultType, Filter, Filters, Limits, Sorting, SortAndLimit, Middleware, InjectMetaMiddleware, InjectKeywordsMiddleware, User, Proxy, UserRepository, Entity, EntityRepository, BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, GoneError, };
+export { statuses, utils, Core, Property, BaseProperty, BasePropertyType, BooleanProperty, BooleanPropertyType, DateTimeProperty, DateTimePropertyType, EnumProperty, EnumPropertyType, HashProperty, HashPropertyType, ObjectProperty, ObjectPropertyType, StringProperty, StringPropertyType, AbstractAdapter, RepositoryClass, MockAdapter, ObjectUri, DataObjectClass, DataObject, AbstractObject, BaseObject, BaseObjectCore, BaseObjectProperties, AuthAction, AuthParameters, AuthParametersKeys, AuthInterface, AbstractAuthAdapter, AuthenticationError, BackendParameters, BackendParametersKeys, BackendRecordType, BackendAction, BaseRepository, BackendError, Query, QueryMetaType, QueryResultType, Filter, Filters, Limits, Sorting, SortAndLimit, Middleware, InjectMetaMiddleware, InjectKeywordsMiddleware, User, UserType, Proxy, UserRepository, Entity, EntityRepository, BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, GoneError, };

package/lib/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GoneError = exports.NotFoundError = exports.ForbiddenError = exports.UnauthorizedError = exports.BadRequestError = exports.EntityRepository = exports.UserRepository = exports.InjectKeywordsMiddleware = exports.InjectMetaMiddleware = exports.SortAndLimit = exports.Sorting = exports.Limits = exports.Filters = exports.Filter = exports.Query = exports.BackendError = exports.BaseRepository = exports.BackendAction = exports.BaseObjectProperties = exports.BaseObjectCore = 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;
+exports.GoneError = exports.NotFoundError = exports.ForbiddenError = exports.UnauthorizedError = exports.BadRequestError = exports.EntityRepository = exports.Entity = exports.UserRepository = exports.User = exports.InjectKeywordsMiddleware = exports.InjectMetaMiddleware = exports.SortAndLimit = exports.Sorting = exports.Limits = exports.Filters = exports.Filter = exports.Query = exports.BackendError = exports.BaseRepository = exports.BackendAction = exports.AuthenticationError = exports.AbstractAuthAdapter = exports.AuthAction = exports.BaseObjectProperties = exports.BaseObjectCore = 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"));
@@ -67,10 +67,19 @@ const BaseRepository_1 = __importDefault(require("./components/BaseRepository"))
 exports.BaseRepository = BaseRepository_1.default;
 const Backend_1 = require("./Backend");
 Object.defineProperty(exports, "BackendAction", { enumerable: true, get: function () { return Backend_1.BackendAction; } });
+const User_1 = require("./components/User");
+Object.defineProperty(exports, "User", { enumerable: true, get: function () { return User_1.User; } });
 const UserRepository_1 = __importDefault(require("./components/UserRepository"));
 exports.UserRepository = UserRepository_1.default;
+const Entity_1 = require("./components/Entity");
+Object.defineProperty(exports, "Entity", { enumerable: true, get: function () { return Entity_1.Entity; } });
 const EntityRepository_1 = __importDefault(require("./components/EntityRepository"));
 exports.EntityRepository = EntityRepository_1.default;
+const Auth_1 = require("./Auth");
+Object.defineProperty(exports, "AuthAction", { enumerable: true, get: function () { return Auth_1.AuthAction; } });
+const authentication_1 = require("./authentication");
+Object.defineProperty(exports, "AbstractAuthAdapter", { enumerable: true, get: function () { return authentication_1.AbstractAuthAdapter; } });
+Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return authentication_1.AuthenticationError; } });
 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/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@quatrain/core",
-   "version": "1.0.0-beta2",
+   "version": "1.0.0-beta3",
    "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/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 {
-}