@decaf-ts/db-decorators 0.1.0

package/lib/esm/validation/decorators.d.ts

@@ -0,0 +1,70 @@
+import { OperationKeys } from "../operations/constants";
+import { IRepository } from "../interfaces/IRepository";
+import { DBModel } from "../model/DBModel";
+import { CustomDecorator } from "@decaf-ts/reflection";
+export declare function getDBUpdateKey(str: string): string;
+/**
+ * Marks the property as readonly.
+ *
+ * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES.READONLY.INVALID}
+ *
+ * @decorator readonly
+ *
+ * @category Decorators
+ */
+export declare function readonly(message?: string): CustomDecorator<V>;
+export declare function timestampHandler<T extends DBModel, V extends IRepository<T>, Y = any>(this: V, data: Y, key: string, model: T): void;
+/**
+ * Marks the property as timestamp.
+ * Makes it {@link required}
+ * Makes it a {@link date}
+ *
+ * Date Format:
+ *
+ * <pre>
+ *      Using similar formatting as Moment.js, Class DateTimeFormatter (Java), and Class SimpleDateFormat (Java),
+ *      I implemented a comprehensive solution formatDate(date, patternStr) where the code is easy to read and modify.
+ *      You can display date, time, AM/PM, etc.
+ *
+ *      Date and Time Patterns
+ *      yy = 2-digit year; yyyy = full year
+ *      M = digit month; MM = 2-digit month; MMM = short month name; MMMM = full month name
+ *      EEEE = full weekday name; EEE = short weekday name
+ *      d = digit day; dd = 2-digit day
+ *      h = hours am/pm; hh = 2-digit hours am/pm; H = hours; HH = 2-digit hours
+ *      m = minutes; mm = 2-digit minutes; aaa = AM/PM
+ *      s = seconds; ss = 2-digit seconds
+ *      S = miliseconds
+ * </pre>
+ *
+ * @param {string[]} operation The {@link DBOperations} to act on. Defaults to {@link DBOperations.CREATE_UPDATE}
+ * @param {string} [format] The TimeStamp format. defaults to {@link DEFAULT_TIMESTAMP_FORMAT}
+ * @param {{new: UpdateValidator}} [validator] defaults to {@link TimestampValidator}
+ *
+ * @decorator timestamp
+ *
+ * @category Decorators
+ */
+export declare function timestamp(operation?: OperationKeys[], format?: string): <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;
+export declare function uniqueOnCreateUpdate<T extends DBModel, V extends IRepository<T>, Y = any>(this: V, data: Y, key: string, model: T): Promise<void>;
+/**
+ * @summary Unique Decorator
+ * @description Tags a property as unique.
+ *  No other elements in that table can have the same property value
+ *
+ * @function unique
+ *
+ * @memberOf module:wallet-db.Decorators
+ */
+export declare function unique(): <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;
+export declare function serializeOnCreateUpdate<T extends DBModel, V extends IRepository<T>, Y = any>(this: V, data: Y, key: string, model: T, oldModel: T): Promise<void>;
+export declare function serializeAfterAll<T extends DBModel, V extends IRepository<T>, Y = any>(this: V, data: Y, key: string, model: T): Promise<void>;
+/**
+ * @summary Serialize Decorator
+ * @description properties decorated will the serialized before stored in the db
+ *
+ * @function serialize
+ *
+ * @memberOf module:wallet-db.Decorators
+ */
+export declare function serialize(): <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;

package/lib/esm/validation/decorators.js

@@ -0,0 +1 @@
+import{date,required,sf,type}from"@decaf-ts/decorator-validation";import{DBKeys,DEFAULT_TIMESTAMP_FORMAT}from"../model/constants";import{DEFAULT_ERROR_MESSAGES,UpdateValidationKeys}from"./constants";import{DBOperations,OperationKeys}from"../operations/constants";import{after,on,onCreateUpdate}from"../operations/decorators";import{ConflictError,NotFoundError,SerializationError}from"../repository/errors";import{apply,metadata}from"@decaf-ts/reflection";import{getDBKey}from"../model/decorators";function getDBUpdateKey(e){return UpdateValidationKeys.REFLECT+e}function readonly(e=DEFAULT_ERROR_MESSAGES.READONLY.INVALID){return metadata(getDBUpdateKey(DBKeys.READONLY),{message:e})}function timestampHandler(e,t,r){r[t]=new Date}function timestamp(e=DBOperations.CREATE_UPDATE,t=DEFAULT_TIMESTAMP_FORMAT){t=[date(t,DEFAULT_ERROR_MESSAGES.TIMESTAMP.DATE),required(DEFAULT_ERROR_MESSAGES.TIMESTAMP.REQUIRED),on(e,timestampHandler)];return-1!==e.indexOf(OperationKeys.UPDATE)&&t.push(metadata(getDBUpdateKey(DBKeys.TIMESTAMP),{message:DEFAULT_ERROR_MESSAGES.TIMESTAMP.INVALID})),apply(...t)}async function uniqueOnCreateUpdate(e,t,r){if(r[t]){try{await this.read(r[t])}catch(e){if(e instanceof NotFoundError)return}throw new ConflictError(`model already exists with ${t} equal to `+JSON.stringify(r[t],void 0,2))}}function unique(){return apply(onCreateUpdate(uniqueOnCreateUpdate),metadata(getDBKey(DBKeys.UNIQUE),{}))}async function serializeOnCreateUpdate(e,t,r,a){if(r[t])try{r[t]=JSON.stringify(r[t])}catch(e){throw new SerializationError(sf("Failed to serialize {0} property on {0} model",t,r.constructor.name))}}async function serializeAfterAll(e,t,r){if(r[t]&&"string"==typeof r[t])try{r[t]=JSON.parse(r[t])}catch(e){throw new SerializationError(sf("Failed to deserialize {0} property on {0} model",t,r.constructor.name))}}function serialize(){return apply(onCreateUpdate(serializeOnCreateUpdate),after(DBOperations.ALL,serializeAfterAll),type([String.name,Object.name]),metadata(getDBKey(DBKeys.SERIALIZE),{}))}export{getDBUpdateKey,readonly,timestampHandler,timestamp,uniqueOnCreateUpdate,unique,serializeOnCreateUpdate,serializeAfterAll,serialize};

package/lib/esm/validation/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./validators";
+export * from "./constants";
+export * from "./decorators";

package/lib/esm/validation/index.js

@@ -0,0 +1 @@
+export*from"./validators";export*from"./constants";export*from"./decorators";

package/lib/esm/validation/validators/ReadOnlyValidator.d.ts

@@ -0,0 +1,23 @@
+import { Validator } from "@decaf-ts/decorator-validation";
+/**
+ * @summary Validator for the {@link readonly} decorator
+ *
+ * @class ReadOnlyValidator
+ * @extends Validator
+ *
+ * @category Validators
+ */
+export declare class ReadOnlyValidator extends Validator {
+    constructor();
+    /**
+     * @inheritDoc
+     */
+    hasErrors(value: any, ...args: any[]): string | undefined;
+    /**
+     * @summary Validates a value has not changed
+     * @param {any} value
+     * @param {any} oldValue
+     * @param {string} [message] the error message override
+     */
+    updateHasErrors(value: any, oldValue: any, message?: string): string | undefined;
+}

package/lib/esm/validation/validators/ReadOnlyValidator.js

@@ -0,0 +1 @@
+var __decorate=this&&this.__decorate||function(t,e,a,r){var o,i=arguments.length,d=i<3?e:null===r?r=Object.getOwnPropertyDescriptor(e,a):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)d=Reflect.decorate(t,e,a,r);else for(var l=t.length-1;0<=l;l--)(o=t[l])&&(d=(i<3?o(d):3<i?o(e,a,d):o(e,a))||d);return 3<i&&d&&Object.defineProperty(e,a,d),d},__metadata=this&&this.__metadata||function(t,e){if("object"==typeof Reflect&&"function"==typeof Reflect.metadata)return Reflect.metadata(t,e)};import{validator,Validator}from"@decaf-ts/decorator-validation";import{DEFAULT_ERROR_MESSAGES,UpdateValidationKeys}from"../constants";import{isEqual}from"@decaf-ts/reflection";let ReadOnlyValidator=class extends Validator{constructor(){super(DEFAULT_ERROR_MESSAGES.READONLY.INVALID)}hasErrors(t){}updateHasErrors(t,e,a){return void 0===t||isEqual(t,e)?void 0:this.getMessage(a||this.message)}};ReadOnlyValidator=__decorate([validator(UpdateValidationKeys.READONLY),__metadata("design:paramtypes",[])],ReadOnlyValidator);export{ReadOnlyValidator};

package/lib/esm/validation/validators/TimestampValidator.d.ts

@@ -0,0 +1,14 @@
+import { Validator } from "@decaf-ts/decorator-validation";
+/**
+ * @summary Validates the update of a timestamp
+ *
+ * @class TimestampValidator
+ * @extends Validator
+ *
+ * @category Validators
+ */
+export declare class TimestampValidator extends Validator {
+    constructor();
+    hasErrors(value: any, ...args: any[]): string | undefined;
+    updateHasErrors(value: Date | string | number, oldValue: Date | string | number, message?: string): string | undefined;
+}

package/lib/esm/validation/validators/TimestampValidator.js

@@ -0,0 +1 @@
+var __decorate=this&&this.__decorate||function(t,e,a,r){var o,i=arguments.length,s=i<3?e:null===r?r=Object.getOwnPropertyDescriptor(e,a):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)s=Reflect.decorate(t,e,a,r);else for(var d=t.length-1;0<=d;d--)(o=t[d])&&(s=(i<3?o(s):3<i?o(e,a,s):o(e,a))||s);return 3<i&&s&&Object.defineProperty(e,a,s),s},__metadata=this&&this.__metadata||function(t,e){if("object"==typeof Reflect&&"function"==typeof Reflect.metadata)return Reflect.metadata(t,e)};import{validator,Validator}from"@decaf-ts/decorator-validation";import{DEFAULT_ERROR_MESSAGES,UpdateValidationKeys}from"../constants";let TimestampValidator=class extends Validator{constructor(){super(DEFAULT_ERROR_MESSAGES.TIMESTAMP.INVALID)}hasErrors(t){}updateHasErrors(t,e,a){if(void 0!==t){a=a||this.getMessage(a||this.message);try{t=new Date(t),e=new Date(e)}catch(t){return a}return t<=e?a:void 0}}};TimestampValidator=__decorate([validator(UpdateValidationKeys.TIMESTAMP),__metadata("design:paramtypes",[])],TimestampValidator);export{TimestampValidator};

package/lib/esm/validation/validators/UpdateValidator.d.ts

@@ -0,0 +1,23 @@
+import { Validator } from "@decaf-ts/decorator-validation";
+/**
+ * @summary Base class for an Update validator
+ *
+ * @param {string} [message] error message. defaults to {@link DecoratorMessages#DEFAULT}
+ * @param {string[]} [acceptedTypes] the accepted value types by the decorator
+ *
+ * @class UpdateValidator
+ * @abstract
+ * @extends Validator
+ *
+ * @category Validators
+ */
+export declare abstract class UpdateValidator extends Validator {
+    protected constructor(message?: string, ...acceptedTypes: string[]);
+    /**
+     * @summary validates a value by comparing to its old version
+     * @param {any} value
+     * @param {any} oldValue
+     * @param {any[]} args
+     */
+    abstract updateHasErrors(value: any, oldValue: any, ...args: any[]): string | undefined;
+}

package/lib/esm/validation/validators/UpdateValidator.js

@@ -0,0 +1 @@
+import{DEFAULT_ERROR_MESSAGES as DecoratorMessages,Validator}from"@decaf-ts/decorator-validation";class UpdateValidator extends Validator{constructor(a=DecoratorMessages.DEFAULT,...o){super(a,...o)}}export{UpdateValidator};

package/lib/esm/validation/validators/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./ReadOnlyValidator";
+export * from "./TimestampValidator";
+export * from "./UpdateValidator";

package/lib/esm/validation/validators/index.js

@@ -0,0 +1 @@
+export*from"./ReadOnlyValidator";export*from"./TimestampValidator";export*from"./UpdateValidator";

package/lib/identity/decorators.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.id=void 0;const decorator_validation_1=require("@decaf-ts/decorator-validation"),reflection_1=require("@decaf-ts/reflection"),decorators_1=require("../model/decorators.cjs"),decorators_2=require("../validation/decorators.cjs"),constants_1=require("../model/constants.cjs");function id(){return(0,reflection_1.apply)((0,decorators_1.index)(),(0,decorator_validation_1.required)(),(0,decorators_2.readonly)(),(0,reflection_1.metadata)((0,decorators_1.getDBKey)(constants_1.DBKeys.ID),{}))}exports.id=id;

package/lib/identity/decorators.d.ts

@@ -0,0 +1 @@
+export declare function id(): <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;

package/lib/identity/index.cjs

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var o=Object.getOwnPropertyDescriptor(t,r);o&&("get"in o?t.__esModule:!o.writable&&!o.configurable)||(o={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,o)}:function(e,t,r,i){e[i=void 0===i?r:i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./decorators.cjs"),exports),__exportStar(require("./utils.cjs"),exports);

package/lib/identity/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./decorators";
+export * from "./utils";

package/lib/identity/utils.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.createOrUpdate=exports.findModelId=exports.findPrimaryKey=void 0;const DBModel_1=require("../model/DBModel.cjs"),decorators_1=require("../model/decorators.cjs"),constants_1=require("../model/constants.cjs"),utils_1=require("../repository/utils.cjs"),decorator_validation_1=require("@decaf-ts/decorator-validation"),errors_1=require("../repository/errors.cjs");function findPrimaryKey(e){e=(0,utils_1.getAllPropertyDecoratorsRecursive)(e,void 0,(0,decorators_1.getDBKey)(constants_1.DBKeys.ID)),e=Object.entries(e).reduce((e,[r,o])=>{o=o.filter(e=>e.key!==decorator_validation_1.ModelKeys.TYPE);return o&&o.length&&(e[r]=e[r]||[],e[r].push(...o)),e},{});if(e&&Object.keys(e).length){if(1<Object.keys(e).length)throw new errors_1.InternalError((0,decorator_validation_1.sf)(Object.keys(e).join(", ")));var r=Object.keys(e)[0];if(r)return{id:r,props:e[r][0].props.options}}throw new errors_1.InternalError("Could not find ID decorated Property")}function findModelId(e,r=!1){var o=findPrimaryKey(e).id,e=e[o];if(e||r)return e;throw new errors_1.NotFoundError((0,decorator_validation_1.sf)("No value for the Id is defined under the property {0}",o))}async function createOrUpdate(e,r=void 0,o){return r=r||DBModel_1.DBModel.findRepository(e.constructor),void 0===e[o=o||findPrimaryKey(e).id]?r.create(e):r.update(e)}exports.findPrimaryKey=findPrimaryKey,exports.findModelId=findModelId,exports.createOrUpdate=createOrUpdate;

package/lib/identity/utils.d.ts

@@ -0,0 +1,36 @@
+import { DBModel } from "../model/DBModel";
+import { IRepository } from "../interfaces/IRepository";
+/**
+ * @summary Returns the primary key attribute for a {@link DBModel}
+ * @description searches in all the properties in the object for an {@link id} decorated property
+ *
+ * @param {DBModel} model
+ *
+ * @throws {InternalError} if no property or more than one properties are {@link id} decorated
+ * or no value is set in that property
+ *
+ * @function findPrimaryKey
+ *
+ * @category managers
+ */
+export declare function findPrimaryKey<T extends DBModel>(model: T): {
+    id: string;
+    props: any;
+};
+/**
+ * @summary Returns the primary key value for a {@link DBModel}
+ * @description searches in all the properties in the object for an {@link pk} decorated property
+ *
+ * @param {DBModel} model
+ * @param {boolean} [returnEmpty]
+ * @return {string} primary key
+ *
+ * @throws {InternalError} if no property or more than one properties are {@link pk} decorated
+ * @throws {NotFoundError} returnEmpty is false and no value is set on the {@link pk} decorated property
+ *
+ * @function findModelID
+ *
+ * @category managers
+ */
+export declare function findModelId(model: DBModel, returnEmpty?: boolean): any;
+export declare function createOrUpdate<T extends DBModel>(model: T, manager?: IRepository<T> | undefined, pk?: string): Promise<T>;

package/lib/index.cjs

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,o){void 0===o&&(o=t);var i=Object.getOwnPropertyDescriptor(r,t);i&&("get"in i?r.__esModule:!i.writable&&!i.configurable)||(i={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,o,i)}:function(e,r,t,o){e[o=void 0===o?t:o]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./identity/index.cjs"),exports),__exportStar(require("./interfaces/index.cjs"),exports),__exportStar(require("./model/index.cjs"),exports),__exportStar(require("./operations/index.cjs"),exports),__exportStar(require("./repository/index.cjs"),exports),__exportStar(require("./validation/index.cjs"),exports);

package/lib/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @module db-decorators
+ */
+/**
+ * @namespace Model
+ * @memberOf module:db-decorators
+ */
+/**
+ * @namespace Operations
+ * @memberOf module:db-decorators
+ */
+/**
+ * @namespace Repository
+ * @memberOf module:db-decorators
+ */
+/**
+ * @namespace Validation
+ * @memberOf module:db-decorators
+ */
+/**
+ * @namespace Validators
+ * @memberOf module:db-decorators.Validation
+ */
+/**
+ * @namespace Utils
+ * @memberOf module:db-decorators
+ */
+export * from "./identity";
+export * from "./interfaces";
+export * from "./model";
+export * from "./operations";
+export * from "./repository";
+export * from "./validation";

package/lib/interfaces/CrudOperator.cjs

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

package/lib/interfaces/CrudOperator.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @summary Crud API
+ * @description Exposes a CRUD API
+ *
+ * @interface CrudOperator
+ *
+ * @category Managers
+ */
+export interface CrudOperator<T> {
+    /**
+     * @summary Create a new model
+     * @param {T} model
+     * @param {any[]} [args]
+     *
+     * @method
+     */
+    create(model: T, ...args: any[]): Promise<T>;
+    /**
+     * @summary Read a model
+     * @param {string} key
+     * @param {any[]} [args]
+     *
+     * @method
+     */
+    read(key: string, ...args: any[]): Promise<T>;
+    /**
+     * @summary update a model
+     * @param {T} model
+     * @param {any[]} [args]
+     *
+     * @method
+     */
+    update(model: T, ...args: any[]): Promise<T>;
+    /**
+     * @summary delete a model
+     * @param {string} key
+     * @param {any[]} [args]
+     *
+     * @method
+     */
+    delete(key: string, ...args: any[]): Promise<T>;
+}

package/lib/interfaces/IRepository.cjs

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

package/lib/interfaces/IRepository.d.ts

@@ -0,0 +1,13 @@
+import { DBModel } from "../model/DBModel";
+import { DataCache } from "../repository/DataCache";
+import { Constructor } from "@decaf-ts/decorator-validation";
+import { CrudOperator } from "./CrudOperator";
+/**
+ * @summary Interface holding basic CRUD APIs
+ * @typedef T extends {@link DBModel}
+ * @interface IRepository
+ */
+export interface IRepository<T extends DBModel> extends CrudOperator<T> {
+    readonly cache: DataCache;
+    readonly class: Constructor<T>;
+}

package/lib/interfaces/index.cjs

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var o=Object.getOwnPropertyDescriptor(t,r);o&&("get"in o?t.__esModule:!o.writable&&!o.configurable)||(o={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,o)}:function(e,t,r,i){e[i=void 0===i?r:i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./CrudOperator.cjs"),exports),__exportStar(require("./IRepository.cjs"),exports);

package/lib/interfaces/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./CrudOperator";
+export * from "./IRepository";

package/lib/model/DBModel.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.DBModel=void 0;const decorator_validation_1=require("@decaf-ts/decorator-validation"),decorators_1=require("./decorators.cjs"),constants_1=require("./constants.cjs"),errors_1=require("../repository/errors.cjs"),injectable_decorators_1=require("@decaf-ts/injectable-decorators"),validation_1=require("./validation.cjs");class DBModel extends decorator_validation_1.Model{constructor(r){super(r)}hasErrors(r,...e){!r||r instanceof DBModel||(e.unshift(r),r=void 0);var o=super.hasErrors(...e);return o||!r?o:(0,validation_1.validateCompare)(r,this,...e)}static findRepository(r){var e=Reflect.getMetadata((0,decorators_1.getDBKey)(constants_1.DBKeys.REPOSITORY),r);if(!e)throw new errors_1.InternalError("Could not find any registered repositories for "+r.name);e=injectable_decorators_1.Injectables.get(e);if(e)return e;throw new errors_1.NotFoundError("Could not find repository for "+r.name)}}exports.DBModel=DBModel;

package/lib/model/DBModel.d.ts

@@ -0,0 +1,25 @@
+import { Constructor, Model, ModelArg, ModelErrorDefinition } from "@decaf-ts/decorator-validation";
+import { IRepository } from "../interfaces/IRepository";
+/**
+ * @summary Abstract class representing a Validatable DBModel object
+ *
+ * @param {ModelArg} [arg]
+ *
+ * @see Model
+ *
+ * @class DBModel
+ * @abstract
+ * @extends Model
+ *
+ * @category Model
+ */
+export declare abstract class DBModel extends Model {
+    protected constructor(arg?: ModelArg<DBModel>);
+    /**
+     * @param {DBModel | any} [previousVersion] validates an update via the {@link DBModel} decorators
+     * @param {any[]} [exclusions] {@see Model#hasErrors}
+     * @return {ModelErrorDefinition | undefined}
+     */
+    hasErrors(previousVersion?: DBModel | any, ...exclusions: any[]): ModelErrorDefinition | undefined;
+    static findRepository<V extends DBModel>(model: Constructor<V>): IRepository<V>;
+}

package/lib/model/constants.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.DEFAULT_TIMESTAMP_FORMAT=exports.DefaultSeparator=exports.DBKeys=void 0,exports.DBKeys={REFLECT:"model.db.",REPOSITORY:"repository",CLASS:"_class",ID:"id",INDEX:"index",UNIQUE:"unique",SERIALIZE:"serialize",READONLY:"readonly",TIMESTAMP:"timestamp",HASH:"hash",COMPOSED:"composed",ORIGINAL:"__originalObj"},exports.DefaultSeparator="_",exports.DEFAULT_TIMESTAMP_FORMAT="dd/MM/yyyy HH:mm:ss:S";

package/lib/model/constants.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @summary Holds the DBModel reflection keys
+ * @const DBKeys
+ *
+ * @memberOf module:db-decorators.Model
+ */
+export declare const DBKeys: {
+    REFLECT: string;
+    REPOSITORY: string;
+    CLASS: string;
+    ID: string;
+    INDEX: string;
+    UNIQUE: string;
+    SERIALIZE: string;
+    READONLY: string;
+    TIMESTAMP: string;
+    HASH: string;
+    COMPOSED: string;
+    ORIGINAL: string;
+};
+/**
+ * @summary The default separator when concatenating indexes
+ *
+ * @const DefaultIndexSeparator
+ *
+ * @category Managers
+ * @subcategory Constants
+ */
+export declare const DefaultSeparator = "_";
+/**
+ * @summary Holds the default timestamp date format
+ * @constant DEFAULT_TIMESTAMP_FORMAT
+ *
+ * @memberOf module:db-decorators.Model
+ */
+export declare const DEFAULT_TIMESTAMP_FORMAT = "dd/MM/yyyy HH:mm:ss:S";

package/lib/model/decorators.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.composed=exports.composedFromKeys=exports.composedFromCreateUpdate=exports.hash=exports.hashOnCreateUpdate=exports.index=exports.getDBKey=void 0;const constants_1=require("./constants.cjs"),reflection_1=require("@decaf-ts/reflection"),decorator_validation_1=require("@decaf-ts/decorator-validation"),decorators_1=require("../operations/decorators.cjs"),errors_1=require("../repository/errors.cjs");function getDBKey(e){return constants_1.DBKeys.REFLECT+e}function index(e,o){return(0,reflection_1.metadata)(getDBKey(""+constants_1.DBKeys.INDEX+(e&&e.length?"."+e.join("."):"")),{directions:o,compositions:e})}function hashOnCreateUpdate(e,o,t,r){var a;t[o]&&(a=decorator_validation_1.Hashing.hash(t[o]),r&&t[o]===a||(t[o]=a))}function hash(){return(0,reflection_1.apply)((0,decorators_1.onCreateUpdate)(hashOnCreateUpdate),(0,reflection_1.metadata)(getDBKey(constants_1.DBKeys.HASH),{}))}function composedFromCreateUpdate(r,a=constants_1.DefaultSeparator,s="values",n="",p=""){return function(e,o){try{var t=r.map(e=>{if(!(e in o))throw new errors_1.InternalError((0,decorator_validation_1.sf)("Property {0} not found to compose from",e));if("keys"===s)return e;if(void 0===o[e])throw new errors_1.InternalError((0,decorator_validation_1.sf)("Property {0} does not contain a value to compose from",e));return o[e].toString()});n&&t.unshift(n),p&&t.push(p),o[e]=t.join(a)}catch(e){throw new errors_1.InternalError("Failed to compose value: "+e)}}}function composedFrom(e,o=!1,t=constants_1.DefaultSeparator,r="values",a="",s=""){var n={args:e,hashResult:o,separator:t,type:r,prefix:a,suffix:s},e=[(0,decorators_1.onCreateUpdate)(composedFromCreateUpdate(e,t,r,a,s)),(0,reflection_1.metadata)(getDBKey(constants_1.DBKeys.COMPOSED),n)];return o&&e.push(hash()),(0,reflection_1.apply)(...e)}function composedFromKeys(e,o=!1,t="",r=""){return composedFrom(e,o,constants_1.DefaultSeparator,"keys",t,r)}function composed(e,o=!1,t="",r=""){return composedFrom(e,o,constants_1.DefaultSeparator,"values",t,r)}exports.getDBKey=getDBKey,exports.index=index,exports.hashOnCreateUpdate=hashOnCreateUpdate,exports.hash=hash,exports.composedFromCreateUpdate=composedFromCreateUpdate,exports.composedFromKeys=composedFromKeys,exports.composed=composed;

package/lib/model/decorators.d.ts

@@ -0,0 +1,25 @@
+import { OrderDirection } from "../validation/constants";
+import { DBModel } from "./DBModel";
+import { IRepository } from "../interfaces/IRepository";
+/**
+ *
+ * @param {str} str
+ * @memberOf db-decorators.model
+ */
+export declare function getDBKey(str: string): string;
+/**
+ * @summary Index Decorator
+ * @description properties decorated will the index in the
+ * DB for performance in queries
+ *
+ * @param {OrderDirection[]} [directions]
+ * @param {string[]} [compositions]
+ *
+ * @function index
+ */
+export declare function index(compositions?: string[], directions?: OrderDirection[]): import("@decaf-ts/reflection").CustomDecorator<V>;
+export declare function hashOnCreateUpdate<T extends DBModel, V extends IRepository<T>, Y = any>(this: V, data: Y, key: string, model: T, oldModel?: T): void;
+export declare function hash(): <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;
+export declare function composedFromCreateUpdate(args: string[], separator?: string, type?: "keys" | "values", prefix?: string, suffix?: string): <T extends DBModel, V extends IRepository<T>>(this: V, key: string, model: T) => void;
+export declare function composedFromKeys(args: string[], hash?: boolean, prefix?: string, suffix?: string): <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;
+export declare function composed(args: string[], hash?: boolean, prefix?: string, suffix?: string): <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;

package/lib/model/index.cjs

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,o){void 0===o&&(o=r);var i=Object.getOwnPropertyDescriptor(t,r);i&&("get"in i?t.__esModule:!i.writable&&!i.configurable)||(i={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,o,i)}:function(e,t,r,o){e[o=void 0===o?r:o]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./constants.cjs"),exports),__exportStar(require("./DBModel.cjs"),exports),__exportStar(require("./decorators.cjs"),exports);

package/lib/model/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./constants";
+export * from "./DBModel";
+export * from "./decorators";

package/lib/model/validation.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.validateCompare=void 0;const decorator_validation_1=require("@decaf-ts/decorator-validation"),reflection_1=require("@decaf-ts/reflection"),validation_1=require("../validation/index.cjs"),identity_1=require("../identity/index.cjs");function validateCompare(r,a,...e){var o=[];for(const p in a)a.hasOwnProperty(p)&&-1===e.indexOf(p)&&o.push((0,reflection_1.getPropertyDecorators)(validation_1.UpdateValidationKeys.REFLECT,a,p));let t=void 0;for(const f of o){var{prop:i,decorators:d}=f;if(d.shift(),d&&d.length){let e=void 0;for(const v of d){var n=decorator_validation_1.Validation.get(v.key);n?(n=n.updateHasErrors(a[i.toString()],r[i.toString()],...Object.values(v.props)))&&((e=e||{})[v.key]=n):console.error(`Could not find Matching validator for ${v.key} for property `+String(f.prop))}e&&((t=t||{})[f.prop.toString()]=e)}}for(const y of Object.keys(a).filter(e=>!t||!t[e])){let o;var s=(0,reflection_1.getPropertyDecorators)(decorator_validation_1.ValidationKeys.REFLECT,a,y).decorators,l=(0,reflection_1.getPropertyDecorators)(decorator_validation_1.ValidationKeys.REFLECT,a,y).decorators.filter(e=>-1!==[decorator_validation_1.ModelKeys.TYPE,decorator_validation_1.ValidationKeys.TYPE].indexOf(e.key));if(l&&l.length){var l=l.pop(),l=l.props.name?[l.props.name]:Array.isArray(l.props.customTypes)?l.props.customTypes:[l.props.customTypes],c=Object.values(decorator_validation_1.ReservedModels).map(e=>e.toLowerCase());for(const _ of l){if(-1===c.indexOf(_.toLowerCase()))switch(_){case Array.name:case Set.name:if(s.length)if(s.find(e=>e.key===decorator_validation_1.ValidationKeys.LIST)){let e,t;switch(_){case Array.name:e=a[y],t=r[y];break;case Set.name:e=a[y].values(),t=r[y].values();break;default:throw new Error("Invalid attribute type "+_)}(o=e.map(e=>{const o=(0,identity_1.findModelId)(e,!0);var r;return o?(r=t.find(e=>o===(0,identity_1.findModelId)(e,!0)))?e.hasErrors(r):void 0:"Failed to find model id"}).filter(e=>!!e))?.length||(o=void 0)}break;default:try{a[y]&&r[y]&&(o=a[y].hasErrors(r[y]))}catch(e){console.warn((0,decorator_validation_1.sf)("Model should be validatable but its not"))}}o&&((t=t||{})[y]=o)}}}return t?new decorator_validation_1.ModelErrorDefinition(t):void 0}exports.validateCompare=validateCompare;

package/lib/model/validation.d.ts

@@ -0,0 +1,15 @@
+import { ModelErrorDefinition } from "@decaf-ts/decorator-validation";
+import { DBModel } from "./DBModel";
+/**
+ * @summary Validates the update of a model
+ *
+ * @param {T} oldModel
+ * @param {T} newModel
+ * @param {string[]} [exceptions]
+ *
+ * @function validateCompare
+ * @return {ModelErrorDefinition | undefined}
+ *
+ * @memberOf module:db-decorators.Model
+ */
+export declare function validateCompare<T extends DBModel>(oldModel: T, newModel: T, ...exceptions: string[]): ModelErrorDefinition | undefined;

package/lib/operations/Operations.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Operations=void 0;const decorator_validation_1=require("@decaf-ts/decorator-validation"),OperationsRegistry_1=require("./OperationsRegistry.cjs"),constants_1=require("./constants.cjs");class Operations{constructor(){}static getHandlerName(e){return e.name||(console.warn("Handler name not defined. A name will be generated, but this is not desirable. please avoid using anonymous functions"),decorator_validation_1.Hashing.hash(e.toString()))}static genKey(e){return constants_1.OperationKeys.REFLECT+e}static get(e,t,r){return Operations.registry.get(e,t,r)}static getOpRegistry(){return Operations.registry||(Operations.registry=new OperationsRegistry_1.OperationsRegistry),Operations.registry}static register(e,t,r,s){Operations.getOpRegistry().register(e,t,r,s)}}exports.Operations=Operations;

package/lib/operations/Operations.d.ts

@@ -0,0 +1,19 @@
+import { OperationHandler } from "./types";
+import { DBModel } from "../model/DBModel";
+import { OperationKeys } from "./constants";
+/**
+ * @summary Static class holding common Operation Functionality
+ *
+ * @class Operations
+ *
+ * @category Operations
+ */
+export declare class Operations {
+    private static registry;
+    private constructor();
+    static getHandlerName(handler: OperationHandler<any, any, any>): any;
+    static genKey(str: string): string;
+    static get(targetName: string | Record<string, any>, propKey: string, operation: string): OperationHandler<DBModel, import("..").IRepository<DBModel>, unknown>[] | undefined;
+    private static getOpRegistry;
+    static register<V extends DBModel>(handler: OperationHandler<V, any, any>, operation: OperationKeys, target: V, propKey: string | symbol): void;
+}

package/lib/operations/OperationsRegistry.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.OperationsRegistry=void 0;const Operations_1=require("./Operations.cjs");class OperationsRegistry{constructor(){this.cache={}}get(e,t,r,s){s=s||[];let c;try{c="string"==typeof e?e:e.constructor.name,s.unshift(...Object.values(this.cache[c][t][r]||[]))}catch(t){if("string"==typeof e||e===Object.prototype||Object.getPrototypeOf(e)===Object.prototype)return s}let o=Object.getPrototypeOf(e);return o.constructor.name===c&&(o=Object.getPrototypeOf(o)),this.get(o,t,r,s)}register(t,e,r,s){var r=r.constructor.name,c=Operations_1.Operations.getHandlerName(t);this.cache[r]||(this.cache[r]={}),this.cache[r][s]||(this.cache[r][s]={}),this.cache[r][s][e]||(this.cache[r][s][e]={}),this.cache[r][s][e][c]||(this.cache[r][s][e][c]=t)}}exports.OperationsRegistry=OperationsRegistry;

package/lib/operations/OperationsRegistry.d.ts

@@ -0,0 +1,34 @@
+import { OperationHandler } from "./types";
+import { DBModel } from "../model/DBModel";
+import { OperationKeys } from "./constants";
+import { IRepository } from "../interfaces/IRepository";
+/**
+ * @summary Holds the registered operation handlers
+ *
+ * @class OperationsRegistry
+ * @implements IRegistry<OperationHandler<any>>
+ *
+ * @see OperationHandler
+ *
+ * @category Operations
+ */
+export declare class OperationsRegistry {
+    private readonly cache;
+    /**
+     * @summary retrieves an {@link OperationHandler} if it exists
+     * @param {string} target
+     * @param {string} propKey
+     * @param {string} operation
+     * @param accum
+     * @return {OperationHandler | undefined}
+     */
+    get<T extends DBModel, V extends IRepository<T>, Y>(target: string | Record<string, any>, propKey: string, operation: string, accum?: OperationHandler<T, V, Y>[]): OperationHandler<T, V, Y>[] | undefined;
+    /**
+     * @summary Registers an {@link OperationHandler}
+     * @param {OperationHandler} handler
+     * @param {string} operation
+     * @param {{}} target
+     * @param {string | symbol} propKey
+     */
+    register<T extends DBModel, V extends IRepository<T>, Y>(handler: OperationHandler<T, V, Y>, operation: OperationKeys, target: T, propKey: string | symbol): void;
+}

package/lib/operations/constants.cjs

@@ -0,0 +1 @@
+"use strict";var OperationKeys;Object.defineProperty(exports,"__esModule",{value:!0}),exports.DBOperations=exports.OperationKeys=void 0,function(e){e.REFLECT="operations.db.",e.CREATE="create",e.READ="read",e.UPDATE="update",e.DELETE="delete",e.ON="on.",e.AFTER="after."}(OperationKeys||(exports.OperationKeys=OperationKeys={})),exports.DBOperations={CREATE:[OperationKeys.CREATE],READ:[OperationKeys.READ],UPDATE:[OperationKeys.UPDATE],DELETE:[OperationKeys.DELETE],CREATE_UPDATE:[OperationKeys.CREATE,OperationKeys.UPDATE],READ_CREATE:[OperationKeys.READ,OperationKeys.CREATE],ALL:[OperationKeys.CREATE,OperationKeys.READ,OperationKeys.UPDATE,OperationKeys.DELETE]};

package/lib/operations/constants.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @summary Set of constants to define db CRUD operations and their equivalent 'on' and 'after' phases
+ * @const OperationKeys
+ *
+ * @memberOf module:db-decorators.Operations
+ */
+export declare enum OperationKeys {
+    REFLECT = "operations.db.",
+    CREATE = "create",
+    READ = "read",
+    UPDATE = "update",
+    DELETE = "delete",
+    ON = "on.",
+    AFTER = "after."
+}
+/**
+ * @summary Maps out groups of CRUD operations for easier mapping of decorators
+ *
+ * @constant DBOperations
+ *
+ * @memberOf module:db-decorators.Operations
+ */
+export declare const DBOperations: Record<string, OperationKeys[]>;

package/lib/operations/decorators.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.operation=exports.after=exports.afterDelete=exports.afterRead=exports.afterCreate=exports.afterUpdate=exports.afterCreateUpdate=exports.on=exports.onDelete=exports.onRead=exports.onCreate=exports.onUpdate=exports.onCreateUpdate=void 0;const constants_1=require("./constants.cjs"),Operations_1=require("./Operations.cjs"),reflection_1=require("@decaf-ts/reflection");function handle(r,n){return(e,t)=>{Operations_1.Operations.register(n,r,e,t)}}function onCreateUpdate(e,t){return on(constants_1.DBOperations.CREATE_UPDATE,e,t)}function onUpdate(e,t){return on(constants_1.DBOperations.UPDATE,e,t)}function onCreate(e,t){return on(constants_1.DBOperations.CREATE,e,t)}function onRead(e,t){return on(constants_1.DBOperations.READ,e,t)}function onDelete(e,t){return on(constants_1.DBOperations.DELETE,e,t)}function on(e=constants_1.DBOperations.ALL,t,r){return operation(constants_1.OperationKeys.ON,e,t,r)}function afterCreateUpdate(e,t){return after(constants_1.DBOperations.CREATE_UPDATE,e,t)}function afterUpdate(e,t){return after(constants_1.DBOperations.UPDATE,e,t)}function afterCreate(e,t){return after(constants_1.DBOperations.CREATE,e,t)}function afterRead(e,t){return after(constants_1.DBOperations.READ,e,t)}function afterDelete(e,t){return after(constants_1.DBOperations.DELETE,e,t)}function after(e=constants_1.DBOperations.ALL,t,r){return operation(constants_1.OperationKeys.AFTER,e,t,r)}function operation(p,t=constants_1.DBOperations.ALL,i,f){return(a,o)=>{const s=a.constructor.name;var e=t.reduce((e,t)=>{var r=p+t;let n=Reflect.getMetadata(Operations_1.Operations.genKey(r),a,o);n=n||{operation:t,handlers:{}};t=Operations_1.Operations.getHandlerName(i);return n.handlers[s]&&n.handlers[s][o]&&t in n.handlers[s][o]||(n.handlers[s]=n.handlers[s]||{},n.handlers[s][o]=n.handlers[s][o]||{},n.handlers[s][o][t]={data:f},e.push(handle(r,i),(0,reflection_1.metadata)(Operations_1.Operations.genKey(r),n))),e},[]);return(0,reflection_1.apply)(...e)(a,o)}}exports.onCreateUpdate=onCreateUpdate,exports.onUpdate=onUpdate,exports.onCreate=onCreate,exports.onRead=onRead,exports.onDelete=onDelete,exports.on=on,exports.afterCreateUpdate=afterCreateUpdate,exports.afterUpdate=afterUpdate,exports.afterCreate=afterCreate,exports.afterRead=afterRead,exports.afterDelete=afterDelete,exports.after=after,exports.operation=operation;