@decaf-ts/db-decorators 0.1.0

package/lib/operations/decorators.d.ts

@@ -0,0 +1,166 @@
+import { IdOperationHandler, OperationHandler, StandardOperationHandler, UpdateOperationHandler } from "./types";
+import { OperationKeys } from "./constants";
+/**
+ * @summary Defines a behaviour to set on the defined {@link DBOperations.CREATE_UPDATE}
+ *
+ * @param {OnOperationHandler<any>} handler The method called upon the operation
+ * @param data
+ * @param {any[]} [args] Arguments that will be passed in order to the handler method
+ *
+ * @see on
+ *
+ * @function onCreateUpdate
+ *
+ * @category Decorators
+ */
+export declare function onCreateUpdate<T>(handler: StandardOperationHandler<any, any, T> | UpdateOperationHandler<any, any, T>, data?: T): (target: object, propertyKey: string | symbol) => void;
+/**
+ * @summary Defines a behaviour to set on the defined {@link DBOperations.UPDATE}
+ *
+ * @param {OnOperationHandler<any>} handler The method called upon the operation
+ * @param data
+ * @param {any[]} [args] Arguments that will be passed in order to the handler method
+ *
+ * @see on
+ *
+ * @function onUpdate
+ *
+ * @category Decorators
+ */
+export declare function onUpdate<T>(handler: UpdateOperationHandler<any, any, T>, data?: T): (target: object, propertyKey: string | symbol) => void;
+/**
+ * @summary Defines a behaviour to set on the defined {@link DBOperations.CREATE}
+ *
+ * @param {OnOperationHandler<any>} handler The method called upon the operation
+ * @param data?
+ *
+ * @see on
+ *
+ * @function onCreate
+ *
+ * @category Decorators
+ */
+export declare function onCreate<T>(handler: StandardOperationHandler<any, any, T>, data?: T): (target: object, propertyKey: string | symbol) => void;
+/**
+ * @summary Defines a behaviour to set on the defined {@link DBOperations.READ}
+ *
+ * @param {OnOperationHandler<any>} handler The method called upon the operation
+ * @param data
+ *
+ * @see on
+ *
+ * @function onRead
+ *
+ * @category Decorators
+ */
+export declare function onRead<T>(handler: IdOperationHandler<any, any, T>, data: T): (target: object, propertyKey: string | symbol) => void;
+/**
+ * @summary Defines a behaviour to set on the defined {@link DBOperations.DELETE}
+ *
+ * @param {OnOperationHandler<any>} handler The method called upon the operation
+ * @param data
+ *
+ * @see on
+ *
+ * @function onDelete
+ *
+ * @category Decorators
+ */
+export declare function onDelete<T>(handler: IdOperationHandler<any, any, T>, data: T): (target: object, propertyKey: string | symbol) => void;
+/**
+ * @summary Defines a behaviour to set on the defined {@link DBOperations}
+ *
+ * @param {OperationKeys[] | DBOperations} op One of {@link DBOperations}
+ * @param {OnOperationHandler<any>} handler The method called upon the operation
+ * @param data
+ *
+ * ex: handler(...args, ...props.map(p => target[p]))
+ *
+ * @function on
+ *
+ * @category Decorators
+ */
+export declare function on<T>(op: OperationKeys[] | undefined, handler: OperationHandler<any, any, T>, data?: T): (target: object, propertyKey: string | symbol) => void;
+/**
+ * @summary Defines a behaviour to set after the defined {@link DBOperations.CREATE_UPDATE}
+ *
+ * @param {AfterOperationHandler<any>} handler The method called upon the operation
+ * @param data
+ *
+ * @see after
+ *
+ * @function afterCreateUpdate
+ *
+ * @category Decorators
+ */
+export declare function afterCreateUpdate<T>(handler: StandardOperationHandler<any, any, T> | UpdateOperationHandler<any, any, T>, data: T): (target: object, propertyKey: string | symbol) => void;
+/**
+ * @summary Defines a behaviour to set after the defined {@link DBOperations.UPDATE}
+ *
+ * @param {AfterOperationHandler<any>} handler The method called upon the operation
+ * @param data
+ *
+ * @see after
+ *
+ * @function afterUpdate
+ *
+ * @category Decorators
+ */
+export declare function afterUpdate<T>(handler: UpdateOperationHandler<any, any, T>, data: T): (target: object, propertyKey: string | symbol) => void;
+/**
+ * @summary Defines a behaviour to set after the defined {@link DBOperations.CREATE}
+ *
+ * @param {AfterOperationHandler<any>} handler The method called upon the operation
+ * @param data
+ *
+ * @see after
+ *
+ * @function afterCreate
+ *
+ * @category Decorators
+ */
+export declare function afterCreate<T>(handler: StandardOperationHandler<any, any, T>, data: T): (target: object, propertyKey: string | symbol) => void;
+/**
+ * @summary Defines a behaviour to set after the defined {@link DBOperations.READ}
+ *
+ * @param {AfterOperationHandler<any>} handler The method called upon the operation
+ * @param data
+ * @param {any[]} [args] Arguments that will be passed in order to the handler method
+ *
+ * @see after
+ *
+ * @function afterRead
+ *
+ * @category Decorators
+ */
+export declare function afterRead<T>(handler: StandardOperationHandler<any, any, T>, data?: T): (target: object, propertyKey: string | symbol) => void;
+/**
+ * @summary Defines a behaviour to set after the defined {@link DBOperations.DELETE}
+ *
+ * @param {AfterOperationHandler<any>} handler The method called upon the operation
+ * @param data
+ * @param {any[]} [args] Arguments that will be passed in order to the handler method
+ *
+ * @see after
+ *
+ * @function afterDelete
+ *
+ * @category Decorators
+ */
+export declare function afterDelete<T>(handler: StandardOperationHandler<any, any, T>, data?: T): (target: object, propertyKey: string | symbol) => void;
+/**
+ * @summary Defines a behaviour to set on the defined {@link DBOperations}
+ *
+ * @param {OperationKeys[] | DBOperations} op One of {@link DBOperations}
+ * @param {AfterOperationHandler<any>} handler The method called upon the operation
+ *
+ * ex: handler(...args, ...props.map(p => target[p]))
+ *
+ * @param data
+ * @param args
+ * @function after
+ *
+ * @category Decorators
+ */
+export declare function after<T>(op: OperationKeys[] | undefined, handler: OperationHandler<any, any, T>, data?: T): (target: object, propertyKey: string | symbol) => void;
+export declare function operation<T>(baseOp: OperationKeys.ON | OperationKeys.AFTER, operation: OperationKeys[] | undefined, handler: OperationHandler<any, any, T>, dataToAdd?: T): (target: object, propertyKey: string | symbol) => void;

package/lib/operations/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("./constants.cjs"),exports),__exportStar(require("./decorators.cjs"),exports),__exportStar(require("./Operations.cjs"),exports),__exportStar(require("./OperationsRegistry.cjs"),exports),__exportStar(require("./types.cjs"),exports);

package/lib/operations/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./constants";
+export * from "./decorators";
+export * from "./Operations";
+export * from "./OperationsRegistry";
+export * from "./types";

package/lib/operations/types.cjs

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

package/lib/operations/types.d.ts

@@ -0,0 +1,28 @@
+import { DBModel } from "../model/DBModel";
+import { OperationKeys } from "./constants";
+import { IRepository } from "../interfaces/IRepository";
+export type OperationMetadata<T> = {
+    operation: OperationKeys;
+    handler: string;
+    metadata?: T;
+};
+/**
+ * @typedef OperationHandler
+ * @memberOf db-decorators.operations
+ */
+export type OperationHandler<T extends DBModel, Y extends IRepository<T>, V> = StandardOperationHandler<T, Y, V> | UpdateOperationHandler<T, Y, V> | IdOperationHandler<T, Y, V>;
+/**
+ * @typedef OnOperationHandler
+ * @memberOf db-decorators.operations
+ */
+export type StandardOperationHandler<T extends DBModel, Y extends IRepository<T>, V> = (this: Y, metadata: V, key: any, model: T) => Promise<void> | void;
+/**
+ * @typedef IdOperationHandler
+ * @memberOf db-decorators.operations
+ */
+export type IdOperationHandler<T extends DBModel, Y extends IRepository<T>, V> = (this: Y, decorator: V, key: any, id: string) => Promise<void> | void;
+/**
+ * @typedef AfterOperationHandler
+ * @memberOf db-decorators.operations
+ */
+export type UpdateOperationHandler<T extends DBModel, Y extends IRepository<T>, V> = (this: Y, decorator: V, key: any, model: T, oldModel: T) => Promise<void> | void;

package/lib/repository/BaseRepository.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.BaseRepository=void 0;const decorator_validation_1=require("@decaf-ts/decorator-validation"),utils_1=require("./utils.cjs"),constants_1=require("../operations/constants.cjs"),errors_1=require("./errors.cjs"),DataCache_1=require("./DataCache.cjs"),wrappers_1=require("./wrappers.cjs"),identity_1=require("../identity/index.cjs");class BaseRepository{get class(){if(this._class)return this._class;throw new errors_1.InternalError("No class definition found for this repository")}get cache(){return this._cache||(this._cache=new DataCache_1.DataCache),this._cache}constructor(){const s=this;[this.create,this.read,this.update,this.delete].forEach(t=>{var e=t.name;(0,wrappers_1.wrapMethod)(s,s[e+"Prefix"],t,s[e+"Suffix"])})}async create(t){throw new Error("Child classes must implement this.")}async createPrefix(t,...e){return t=new this.class(t),await(0,utils_1.enforceDBDecorators)(this,t,constants_1.OperationKeys.CREATE,constants_1.OperationKeys.ON),[t,...e]}async createSuffix(t){return await(0,utils_1.enforceDBDecorators)(this,t,constants_1.OperationKeys.CREATE,constants_1.OperationKeys.AFTER),t}async read(t){throw new Error("Child classes must implement this")}async readSuffix(t){return await(0,utils_1.enforceDBDecorators)(this,t,constants_1.OperationKeys.READ,constants_1.OperationKeys.AFTER),t}async readPrefix(t,...e){var s=new this.class;return await(0,utils_1.enforceDBDecorators)(this,s,constants_1.OperationKeys.READ,constants_1.OperationKeys.ON),[t,...e]}async update(t){throw new Error("Child classes must implement this")}async updateSuffix(t){return t=new this.class(t),await(0,utils_1.enforceDBDecorators)(this,t,constants_1.OperationKeys.UPDATE,constants_1.OperationKeys.AFTER),t}async updatePrefix(t,...e){var s=(0,identity_1.findModelId)(t),s=await this.read(s);return await(0,utils_1.enforceDBDecorators)(this,t,constants_1.OperationKeys.UPDATE,constants_1.OperationKeys.ON,s),[t,...e]}async delete(t){throw new Error("Child classes must implement this")}async deleteSuffix(t){return await(0,utils_1.enforceDBDecorators)(this,t,constants_1.OperationKeys.DELETE,constants_1.OperationKeys.AFTER),t}async deletePrefix(t,...e){var s=await this.read(t,...e);return await(0,utils_1.enforceDBDecorators)(this,s,constants_1.OperationKeys.DELETE,constants_1.OperationKeys.ON),[t,...e]}toString(){return(0,decorator_validation_1.sf)("[{0}] - Repository for {1}",this.constructor.name,this.class.name)}}exports.BaseRepository=BaseRepository;

package/lib/repository/BaseRepository.d.ts

@@ -0,0 +1,24 @@
+import { IRepository } from "../interfaces/IRepository";
+import { DBModel } from "../model/DBModel";
+import { Constructor } from "@decaf-ts/decorator-validation";
+import { DataCache } from "./DataCache";
+export declare abstract class BaseRepository<T extends DBModel> implements IRepository<T> {
+    private readonly _class;
+    private _cache?;
+    get class(): Constructor<T>;
+    get cache(): DataCache;
+    protected constructor();
+    create(model: T, ...args: any[]): Promise<T>;
+    protected createPrefix(model: T, ...args: any[]): Promise<any[]>;
+    protected createSuffix(model: T): Promise<T>;
+    read(key: string, ...args: any[]): Promise<T>;
+    protected readSuffix(model: T): Promise<T>;
+    protected readPrefix(key: string, ...args: any[]): Promise<any[]>;
+    update(model: T, ...args: any[]): Promise<T>;
+    protected updateSuffix(model: T): Promise<T>;
+    protected updatePrefix(model: T, ...args: any[]): Promise<any[]>;
+    delete(key: string, ...args: any[]): Promise<T>;
+    protected deleteSuffix(model: T): Promise<T>;
+    protected deletePrefix(key: any, ...args: any[]): Promise<any[]>;
+    toString(): string;
+}

package/lib/repository/DataCache.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.DataCache=void 0;const errors_1=require("./errors.cjs");class DataCache{constructor(){this.cache={}}async get(e){if(e in this.cache)return this.cache[e];throw new errors_1.NotFoundError(`Key ${e} not in dataStore`)}async push(e,t){if(e in this.cache)throw new errors_1.ConflictError(`Key ${e} already in dataStore`);this.cache[e]=t}async put(e,t){this.cache[e]=t}async pop(e){var t=this.get(e);return delete this.cache[e],t}async purge(e){e?await this.pop(e):this.cache={}}}exports.DataCache=DataCache;

package/lib/repository/DataCache.d.ts

@@ -0,0 +1,8 @@
+export declare class DataCache {
+    private cache;
+    get(key: string): Promise<any>;
+    push(key: string, value: any): Promise<void>;
+    put(key: string, value: any): Promise<void>;
+    pop(key: string): Promise<any>;
+    purge(key?: string): Promise<void>;
+}

package/lib/repository/Repository.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Repository=void 0;const decorator_validation_1=require("@decaf-ts/decorator-validation"),utils_1=require("./utils.cjs"),constants_1=require("../operations/constants.cjs"),errors_1=require("./errors.cjs"),BaseRepository_1=require("./BaseRepository.cjs"),identity_1=require("../identity/index.cjs");class Repository extends BaseRepository_1.BaseRepository{constructor(){super()}async create(r){throw new Error("Child classes must implement this.")}async createPrefix(e,...t){e=new this.class(e),await(0,utils_1.enforceDBDecorators)(this,e,constants_1.OperationKeys.CREATE,constants_1.OperationKeys.ON);var r=e.hasErrors();if(r)throw new errors_1.ValidationError(r.toString());let s;try{if(!(s=(0,identity_1.findModelId)(e,!0)))return[e,...t];s&&await this.read(s.toString())}catch(r){if(r instanceof errors_1.NotFoundError)return[e,...t];throw r}throw new errors_1.ConflictError((0,decorator_validation_1.sf)("Model with id {0} already exists",s))}async delete(r){throw new Error("Child classes must implement this.")}async deletePrefix(r,...e){var t=new this.class;return await(0,utils_1.enforceDBDecorators)(this,t,constants_1.OperationKeys.DELETE,constants_1.OperationKeys.ON),await this.read(r),[r,...e]}async read(r){throw new Error("Child classes must implement this.")}async update(r){throw new Error("Child classes must implement this.")}async updatePrefix(r,...e){r=new this.class(r);var t=(0,identity_1.findModelId)(r),t=await this.read(t),t=(await(0,utils_1.enforceDBDecorators)(this,r,constants_1.OperationKeys.UPDATE,constants_1.OperationKeys.ON,t),r.hasErrors(t));if(t)throw new errors_1.ValidationError(t.toString());return[r,...e]}}exports.Repository=Repository;

package/lib/repository/Repository.d.ts

@@ -0,0 +1,12 @@
+import { DBModel } from "../model/DBModel";
+import { BaseRepository } from "./BaseRepository";
+export declare abstract class Repository<T extends DBModel> extends BaseRepository<T> {
+    protected constructor();
+    create(model: T): Promise<T>;
+    protected createPrefix(model: T, ...args: any[]): Promise<[T, ...any[]]>;
+    delete(key: string | number): Promise<T>;
+    protected deletePrefix(key: string | number, ...args: any[]): Promise<[string | number, ...any[]]>;
+    read(key: string | number): Promise<T>;
+    update(model: T): Promise<T>;
+    protected updatePrefix(model: T, ...args: any[]): Promise<[T, ...args: any[]]>;
+}

package/lib/repository/constants.cjs

@@ -0,0 +1 @@
+"use strict";var Cascade;Object.defineProperty(exports,"__esModule",{value:!0}),exports.DefaultCascade=exports.Cascade=void 0,function(e){e.CASCADE="cascade",e.NONE="none"}(Cascade||(exports.Cascade=Cascade={})),exports.DefaultCascade={update:Cascade.CASCADE,delete:Cascade.NONE};

package/lib/repository/constants.d.ts

@@ -0,0 +1,6 @@
+import { CascadeMetadata } from "./types";
+export declare enum Cascade {
+    CASCADE = "cascade",
+    NONE = "none"
+}
+export declare const DefaultCascade: CascadeMetadata;

package/lib/repository/decorators.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.repository=void 0;const injectable_decorators_1=require("@decaf-ts/injectable-decorators"),reflection_1=require("@decaf-ts/reflection"),decorators_1=require("../model/decorators.cjs"),constants_1=require("../model/constants.cjs"),errors_1=require("./errors.cjs");function repository(o,s){return(e,r)=>{if(r){var t=Reflect.getMetadata((0,decorators_1.getDBKey)(constants_1.DBKeys.REPOSITORY),o);if(t)return(0,injectable_decorators_1.inject)(t)(e,r);throw new errors_1.InternalError("Could not find repository for "+o.name)}return(0,reflection_1.metadata)((0,decorators_1.getDBKey)(constants_1.DBKeys.REPOSITORY),s||e.name)(o),(0,injectable_decorators_1.injectable)(s,!0,e=>{Object.defineProperty(e,constants_1.DBKeys.CLASS,{enumerable:!1,configurable:!1,writable:!1,value:o})})(e)}}exports.repository=repository;

package/lib/repository/decorators.d.ts

@@ -0,0 +1,3 @@
+import { Constructor } from "@decaf-ts/decorator-validation";
+import { DBModel } from "../model/DBModel";
+export declare function repository<T extends DBModel>(model: Constructor<T>, nameOverride?: string): (original: any, propertyKey?: string) => any;

package/lib/repository/errors.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ConflictError=exports.NotFoundError=exports.SerializationError=exports.InternalError=exports.ValidationError=exports.BaseError=void 0;class BaseError extends Error{constructor(r,o){if(o instanceof BaseError)return o;super(`[${r}] `+(o instanceof Error?o.message:o)),o instanceof Error&&(this.stack=o.stack)}}class ValidationError extends(exports.BaseError=BaseError){constructor(r){super(ValidationError.name,r)}}exports.ValidationError=ValidationError;class InternalError extends BaseError{constructor(r){super(InternalError.name,r)}}exports.InternalError=InternalError;class SerializationError extends BaseError{constructor(r){super(SerializationError.name,r)}}exports.SerializationError=SerializationError;class NotFoundError extends BaseError{constructor(r){super(NotFoundError.name,r)}}exports.NotFoundError=NotFoundError;class ConflictError extends BaseError{constructor(r){super(ConflictError.name,r)}}exports.ConflictError=ConflictError;

package/lib/repository/errors.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @summary Base Error
+ *
+ * @param {string} msg the error message
+ *
+ * @class BaseDLTError
+ * @extends Error
+ */
+export declare abstract class BaseError extends Error {
+    protected constructor(name: string, msg: string | Error);
+}
+/**
+ * @summary Represents a failure in the Model details
+ *
+ * @param {string} msg the error message
+ *
+ * @class ValidationError
+ * @extends BaseError
+ */
+export declare class ValidationError extends BaseError {
+    constructor(msg: string | Error);
+}
+/**
+ * @summary Represents an internal failure (should mean an error in code)
+ *
+ * @param {string} msg the error message
+ *
+ * @class InternalError
+ * @extends BaseError
+ */
+export declare class InternalError extends BaseError {
+    constructor(msg: string | Error);
+}
+/**
+ * @summary Represents a failure in the Model de/serialization
+ *
+ * @param {string} msg the error message
+ *
+ * @class SerializationError
+ * @extends BaseError
+ *
+ */
+export declare class SerializationError extends BaseError {
+    constructor(msg: string | Error);
+}
+/**
+ * @summary Represents a failure in finding a model
+ *
+ * @param {string} msg the error message
+ *
+ * @class NotFoundError
+ * @extends BaseError
+ *
+ */
+export declare class NotFoundError extends BaseError {
+    constructor(msg: string | Error);
+}
+/**
+ * @summary Represents a conflict in the storage
+ *
+ * @param {string} msg the error message
+ *
+ * @class ConflictError
+ * @extends BaseError
+ *
+ */
+export declare class ConflictError extends BaseError {
+    constructor(msg: string | Error);
+}

package/lib/repository/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("./BaseRepository.cjs"),exports),__exportStar(require("./constants.cjs"),exports),__exportStar(require("./DataCache.cjs"),exports),__exportStar(require("./decorators.cjs"),exports),__exportStar(require("./errors.cjs"),exports),__exportStar(require("./Repository.cjs"),exports),__exportStar(require("./types.cjs"),exports),__exportStar(require("./utils.cjs"),exports),__exportStar(require("./wrappers.cjs"),exports);

package/lib/repository/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./BaseRepository";
+export * from "./constants";
+export * from "./DataCache";
+export * from "./decorators";
+export * from "./errors";
+export * from "./Repository";
+export * from "./types";
+export * from "./utils";
+export * from "./wrappers";

package/lib/repository/types.cjs

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

package/lib/repository/types.d.ts

@@ -0,0 +1,13 @@
+import { Cascade } from "./constants";
+import { OrderDirection } from "../validation/constants";
+/**
+ * @summary defines the cascading behaviour
+ */
+export type CascadeMetadata = {
+    update: Cascade;
+    delete: Cascade;
+};
+export type IndexMetadata = {
+    directions?: OrderDirection[2];
+    compositions?: string[];
+};

package/lib/repository/utils.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getAllPropertyDecoratorsRecursive=exports.getDbDecorators=exports.enforceDBDecorators=exports.getHandlerArgs=void 0;const Operations_1=require("../operations/Operations.cjs"),constants_1=require("../operations/constants.cjs"),reflection_1=require("@decaf-ts/reflection"),errors_1=require("./errors.cjs"),decorator_validation_1=require("@decaf-ts/decorator-validation"),getHandlerArgs=function(e,r,t,o){var n=t.constructor.name;if(!n)throw new errors_1.InternalError("Could not determine model class");o=o||{},e.props.handlers[n]&&e.props.handlers[n][r]&&(o={...e.props.handlers[n][r],...o});let s=Object.getPrototypeOf(t);return s===Object.prototype?o:(s.constructor.name===n&&(s=Object.getPrototypeOf(s)),(0,exports.getHandlerArgs)(e,r,s,o))};async function enforceDBDecorators(r,t,o,e,n){var s=getDbDecorators(t,o,e);if(s)for(const d in s)for(const f of s[d]){var a=f["key"],c=Operations_1.Operations.get(t,d,e+a);if(!c||!c.length)throw new errors_1.InternalError(`Could not find registered handler for the operation ${e+a} under property `+d);var i=(0,exports.getHandlerArgs)(f,d,t);if(!i||Object.values(i).length!==c.length)throw new errors_1.InternalError((0,decorator_validation_1.sf)("Args and handlers length do not match"));for(let e=0;e<c.length;e++){var p=c[e],l=[Object.values(i)[e].data,d,t];if(o===constants_1.OperationKeys.UPDATE){if(!n)throw new errors_1.InternalError("Missing old model for update operation");l.push(n)}await p.apply(r,l)}}}function getDbDecorators(e,o,r){const n=(0,reflection_1.getAllPropertyDecorators)(e,constants_1.OperationKeys.REFLECT+(r||""));if(n)return Object.keys(n).reduce((e,r)=>{var t=n[r].filter(e=>e.key===o);return t&&t.length&&((e=e||{})[r]=t),e},void 0)}exports.getHandlerArgs=getHandlerArgs,exports.enforceDBDecorators=enforceDBDecorators,exports.getDbDecorators=getDbDecorators;const getAllPropertyDecoratorsRecursive=function(e,r,...t){const a=r||{};function o(e){Object.entries(e).forEach(([e,r])=>{var s;a[e]=a[e]||[],[s,...e]=[e,...r],e.forEach(r=>{var e;if((e=a[s].find(e=>e.key===r.key))&&e.props.operation===r.props.operation){if(r.key!==decorator_validation_1.ModelKeys.TYPE){var{handlers:t,operation:o}=r.props;if(o&&o.match(new RegExp(`^(:?${constants_1.OperationKeys.ON}|${constants_1.OperationKeys.AFTER})(:?${constants_1.OperationKeys.CREATE}|${constants_1.OperationKeys.READ}|${constants_1.OperationKeys.UPDATE}|${constants_1.OperationKeys.DELETE})$`))){const n=e.props.handlers;Object.entries(t).forEach(([o,e])=>{o in n?Object.entries(e).forEach(([t,e])=>{t in n[o]?Object.entries(e).forEach(([e,r])=>{e in n[o][t]?console.warn((0,decorator_validation_1.sf)("Skipping handler registration for {0} under prop {0} because handler is the same",o,t)):n[o][t][e]=r}):n[o][t]=e}):n[o]=e})}else a[s].push(r)}}else a[s].push(r)})})}var r=(0,reflection_1.getAllPropertyDecorators)(e,...t);return r&&o(r),Object.getPrototypeOf(e)!==Object.prototype&&(r=Object.getPrototypeOf(e))?(0,exports.getAllPropertyDecoratorsRecursive)(r,a,...t):a};exports.getAllPropertyDecoratorsRecursive=getAllPropertyDecoratorsRecursive;

package/lib/repository/utils.d.ts

@@ -0,0 +1,57 @@
+import { DBModel } from "../model/DBModel";
+import { IRepository } from "../interfaces/IRepository";
+import { DecoratorMetadata } from "@decaf-ts/reflection";
+import { Constructor } from "@decaf-ts/decorator-validation";
+/**
+ * @summary retrieves the arguments for the handler
+ * @param {any} dec the decorator
+ * @param {string} prop the property name
+ * @param {{}} m the model
+ * @param {{}} [accum] accumulator used for internal recursiveness
+ *
+ * @function getHandlerArgs
+ * @memberOf module:db-decorators.Repository
+ */
+export declare const getHandlerArgs: (dec: any, prop: string, m: Constructor<any>, accum?: Record<string, {
+    args: string[];
+}>) => Record<string, {
+    args: string[];
+}> | void;
+/**
+ *
+ * @param {IRepository<T>} repo
+ * @param {T} model
+ * @param operation
+ * @param prefix
+ *
+ * @param oldModel
+ * @function enforceDBPropertyDecoratorsAsync
+ *
+ * @memberOf db-decorators.utils
+ */
+export declare function enforceDBDecorators<T extends DBModel, Y extends IRepository<T>, V>(repo: Y, model: T, operation: string, prefix: string, oldModel?: T): Promise<void>;
+/**
+ * Specific for DB Decorators
+ * @param {T} model
+ * @param {string} operation CRUD {@link OperationKeys}
+ * @param {string} [extraPrefix]
+ *
+ * @function getDbPropertyDecorators
+ *
+ * @memberOf db-decorators.utils
+ */
+export declare function getDbDecorators<T extends DBModel>(model: T, operation: string, extraPrefix?: string): Record<string, DecoratorMetadata[]> | undefined;
+/**
+ * @summary Retrieves the decorators for an object's properties prefixed by {@param prefixes} recursively
+ * @param model
+ * @param accum
+ * @param prefixes
+ *
+ * @function getAllPropertyDecoratorsRecursive
+ * @memberOf module:db-decorators.Repository
+ */
+export declare const getAllPropertyDecoratorsRecursive: <T extends DBModel>(model: T, accum: {
+    [indexer: string]: any[];
+} | undefined, ...prefixes: string[]) => {
+    [indexer: string]: any[];
+} | undefined;

package/lib/repository/wrappers.cjs

@@ -0,0 +1 @@
+"use strict";function prefixMethod(e,r,t,o){var a=async function(...e){return e=await Promise.resolve(t.call(this,...e)),Promise.resolve(r.apply(this,e))}.bind(e),o=o||r.name;Object.defineProperty(a,"name",{enumerable:!0,configurable:!0,writable:!1,value:o}),e[o]=a}function suffixMethod(e,r,t,o){var a=async function(...e){return e=await Promise.resolve(r.call(this,...e)),t.call(this,...e)}.bind(e),o=o||r.name;Object.defineProperty(a,"name",{enumerable:!0,configurable:!0,writable:!1,value:o}),e[o]=a}function wrapMethod(r,t,o,a,e){var i=async function(...e){return e=await Promise.resolve(t.call(r,...e)),e=await Promise.resolve(o.call(r,...e)),Promise.resolve(a.call(this,e))}.bind(r),e=e||o.name;Object.defineProperty(i,"name",{enumerable:!0,configurable:!0,writable:!1,value:e}),r[e]=i}Object.defineProperty(exports,"__esModule",{value:!0}),exports.wrapMethod=exports.suffixMethod=exports.prefixMethod=void 0,exports.prefixMethod=prefixMethod,exports.suffixMethod=suffixMethod,exports.wrapMethod=wrapMethod;

package/lib/repository/wrappers.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @summary Util method to change a method of an object prefixing it with another
+ * @param {any} obj The Base Object
+ * @param {Function} after The original method
+ * @param {Function} prefix The Prefix method. The output will be used as arguments in the original method
+ * @param {string} [afterName] When the after function anme cannot be extracted, pass it here
+ *
+ * @function prefixMethod
+ *
+ * @memberOf module:db-decorators.Repository
+ */
+export declare function prefixMethod(obj: any, after: (...args: any[]) => any, prefix: (...args: any[]) => any, afterName?: string): void;
+/**
+ * @summary Util method to change a method of an object suffixing it with another
+ * @param {any} obj The Base Object
+ * @param {Function} before The original method
+ * @param {Function} suffix The Prefix method. The output will be used as arguments in the original method
+ * @param {string} [beforeName] When the after function anme cannot be extracted, pass it here
+ *
+ * @function suffixMethod
+ *
+ * @memberOf module:db-decorators.Repository
+ */
+export declare function suffixMethod(obj: any, before: (...args: any[]) => any, suffix: (...args: any[]) => any, beforeName?: string): void;
+/**
+ * @summary Util method to wrap a method of an object with additional logic
+ *
+ * @param {any} obj The Base Object
+ * @param {Function} before the method to be prefixed
+ * @param {Function} method the method to be wrapped
+ * @param {Function} after The method to be suffixed
+ * @param {string} [methodName] When the after function anme cannot be extracted, pass it here
+ *
+ * @function wrapMethod
+ *
+ * @memberOf module:db-decorators.Repository
+ */
+export declare function wrapMethod(obj: any, before: (...args: any[]) => any, method: (...args: any[]) => any, after: (...args: any[]) => any, methodName?: string): void;

package/lib/validation/comparison.cjs

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

package/lib/validation/comparison.d.ts

@@ -0,0 +1 @@
+

package/lib/validation/constants.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.OrderDirection=exports.UpdateValidationKeys=exports.DEFAULT_ERROR_MESSAGES=void 0;const constants_1=require("../model/constants.cjs");var OrderDirection;exports.DEFAULT_ERROR_MESSAGES={ID:{INVALID:"This Id is invalid",REQUIRED:"The Id is mandatory"},READONLY:{INVALID:"This cannot be updated"},TIMESTAMP:{REQUIRED:"Timestamp is Mandatory",DATE:"The Timestamp must the a valid date",INVALID:"This value must always increase"}},exports.UpdateValidationKeys={REFLECT:"db.update.validation.",TIMESTAMP:constants_1.DBKeys.TIMESTAMP,READONLY:constants_1.DBKeys.READONLY},function(e){e.ASC="asc",e.DSC="desc"}(OrderDirection||(exports.OrderDirection=OrderDirection={}));

package/lib/validation/constants.d.ts

@@ -0,0 +1,49 @@
+/**
+ * @summary holds the default error messages
+ * @const DEFAULT_ERROR_MESSAGES
+ *
+ * @memberOf module:db-decorators.Model
+ */
+export declare const DEFAULT_ERROR_MESSAGES: {
+    ID: {
+        INVALID: string;
+        REQUIRED: string;
+    };
+    READONLY: {
+        INVALID: string;
+    };
+    TIMESTAMP: {
+        REQUIRED: string;
+        DATE: string;
+        INVALID: string;
+    };
+};
+/**
+ * @summary Update reflection keys
+ * @const UpdateValidationKeys
+ * @memberOf module:db-decorators.Operations
+ */
+export declare const UpdateValidationKeys: {
+    REFLECT: string;
+    TIMESTAMP: string;
+    READONLY: string;
+};
+/**
+ * @summary defines order directions when sorting
+ *
+ * @constant OrderDirection
+ *
+ * @category Query
+ */
+export declare enum OrderDirection {
+    /**
+     * @summary Defines the sort order as ascending
+     * @prop ASC
+     */
+    ASC = "asc",
+    /**
+     * @summary Defines the sort order as descending
+     * @property {string} DSC
+     */
+    DSC = "desc"
+}

package/lib/validation/decorators.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.serialize=exports.serializeAfterAll=exports.serializeOnCreateUpdate=exports.unique=exports.uniqueOnCreateUpdate=exports.timestamp=exports.timestampHandler=exports.readonly=exports.getDBUpdateKey=void 0;const decorator_validation_1=require("@decaf-ts/decorator-validation"),constants_1=require("../model/constants.cjs"),constants_2=require("./constants.cjs"),constants_3=require("../operations/constants.cjs"),decorators_1=require("../operations/decorators.cjs"),errors_1=require("../repository/errors.cjs"),reflection_1=require("@decaf-ts/reflection"),decorators_2=require("../model/decorators.cjs");function getDBUpdateKey(e){return constants_2.UpdateValidationKeys.REFLECT+e}function readonly(e=constants_2.DEFAULT_ERROR_MESSAGES.READONLY.INVALID){return(0,reflection_1.metadata)(getDBUpdateKey(constants_1.DBKeys.READONLY),{message:e})}function timestampHandler(e,t,r){r[t]=new Date}function timestamp(e=constants_3.DBOperations.CREATE_UPDATE,t=constants_1.DEFAULT_TIMESTAMP_FORMAT){t=[(0,decorator_validation_1.date)(t,constants_2.DEFAULT_ERROR_MESSAGES.TIMESTAMP.DATE),(0,decorator_validation_1.required)(constants_2.DEFAULT_ERROR_MESSAGES.TIMESTAMP.REQUIRED),(0,decorators_1.on)(e,timestampHandler)];return-1!==e.indexOf(constants_3.OperationKeys.UPDATE)&&t.push((0,reflection_1.metadata)(getDBUpdateKey(constants_1.DBKeys.TIMESTAMP),{message:constants_2.DEFAULT_ERROR_MESSAGES.TIMESTAMP.INVALID})),(0,reflection_1.apply)(...t)}async function uniqueOnCreateUpdate(e,t,r){if(r[t]){try{await this.read(r[t])}catch(e){if(e instanceof errors_1.NotFoundError)return}throw new errors_1.ConflictError(`model already exists with ${t} equal to `+JSON.stringify(r[t],void 0,2))}}function unique(){return(0,reflection_1.apply)((0,decorators_1.onCreateUpdate)(uniqueOnCreateUpdate),(0,reflection_1.metadata)((0,decorators_2.getDBKey)(constants_1.DBKeys.UNIQUE),{}))}async function serializeOnCreateUpdate(e,t,r,a){if(r[t])try{r[t]=JSON.stringify(r[t])}catch(e){throw new errors_1.SerializationError((0,decorator_validation_1.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 errors_1.SerializationError((0,decorator_validation_1.sf)("Failed to deserialize {0} property on {0} model",t,r.constructor.name))}}function serialize(){return(0,reflection_1.apply)((0,decorators_1.onCreateUpdate)(serializeOnCreateUpdate),(0,decorators_1.after)(constants_3.DBOperations.ALL,serializeAfterAll),(0,decorator_validation_1.type)([String.name,Object.name]),(0,reflection_1.metadata)((0,decorators_2.getDBKey)(constants_1.DBKeys.SERIALIZE),{}))}exports.getDBUpdateKey=getDBUpdateKey,exports.readonly=readonly,exports.timestampHandler=timestampHandler,exports.timestamp=timestamp,exports.uniqueOnCreateUpdate=uniqueOnCreateUpdate,exports.unique=unique,exports.serializeOnCreateUpdate=serializeOnCreateUpdate,exports.serializeAfterAll=serializeAfterAll,exports.serialize=serialize;