@quatrain/core 1.0.0-beta1 → 1.0.0-beta3

package/README.md

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

package/lib/components/BaseObjectProperties.d.ts

@@ -1,13 +0,0 @@
-import { UserClass } from './types/UserClass';
-import { ObjectUri } from './ObjectUri';
-export interface BaseObjectType {
-    name: string;
-    status: string;
-    createdBy?: UserClass | ObjectUri;
-    createdAt?: number;
-    updatedBy?: UserClass | ObjectUri;
-    updatedAt?: number;
-    deletedBy?: UserClass | ObjectUri;
-    deletedAt?: number;
-}
-export declare const BaseObjectProperties: any;

package/lib/components/BaseObjectProperties.js

@@ -1,87 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseObjectProperties = void 0;
-const statuses = __importStar(require("../statuses"));
-const StringProperty_1 = require("../properties/StringProperty");
-const ObjectProperty_1 = require("../properties/ObjectProperty");
-const EnumProperty_1 = require("../properties/EnumProperty");
-const DateTimeProperty_1 = require("../properties/DateTimeProperty");
-const htmlType = __importStar(require("../properties/types/PropertyHTMLType"));
-exports.BaseObjectProperties = [
-    {
-        name: 'name',
-        mandatory: true,
-        type: StringProperty_1.StringProperty.TYPE,
-        minLength: 1,
-        maxLength: 100,
-        htmlType: htmlType.NAME,
-    },
-    {
-        name: 'status',
-        mandatory: true,
-        type: EnumProperty_1.EnumProperty.TYPE,
-        values: [
-            statuses.CREATED,
-            statuses.PENDING,
-            statuses.ACTIVE,
-            statuses.DELETED,
-        ],
-        defaultValue: statuses.CREATED,
-    },
-    {
-        name: 'createdBy',
-        type: ObjectProperty_1.ObjectProperty.TYPE,
-        instanceOf: 'User',
-        mandatory: true,
-        protected: true,
-    },
-    {
-        name: 'createdAt',
-        type: DateTimeProperty_1.DateTimeProperty.TYPE,
-        mandatory: true,
-        protected: true,
-    },
-    {
-        name: 'updatedBy',
-        type: ObjectProperty_1.ObjectProperty.TYPE,
-        instanceOf: 'User',
-    },
-    {
-        name: 'updatedAt',
-        type: DateTimeProperty_1.DateTimeProperty.TYPE,
-    },
-    {
-        name: 'deletedBy',
-        type: ObjectProperty_1.ObjectProperty.TYPE,
-        instanceOf: 'User',
-        protected: true,
-    },
-    {
-        name: 'deletedAt',
-        type: DateTimeProperty_1.DateTimeProperty.TYPE,
-        protected: true,
-    },
-];

package/lib/components/EntityProperties.d.ts

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

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 {
-}