@decaf-ts/db-decorators 0.1.0 → 0.1.2

package/lib/model/decorators.d.ts

@@ -1,4 +1,3 @@
-import { OrderDirection } from "../validation/constants";
 import { DBModel } from "./DBModel";
 import { IRepository } from "../interfaces/IRepository";
 /**
@@ -7,17 +6,6 @@ import { IRepository } from "../interfaces/IRepository";
  * @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;

package/lib/repository/index.cjs

@@ -1 +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);
+"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("./DataCache.cjs"),exports),__exportStar(require("./decorators.cjs"),exports),__exportStar(require("./errors.cjs"),exports),__exportStar(require("./Repository.cjs"),exports),__exportStar(require("./utils.cjs"),exports),__exportStar(require("./wrappers.cjs"),exports);

package/lib/repository/index.d.ts

@@ -1,9 +1,7 @@
 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/validation/constants.cjs

@@ -1 +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={}));
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.UpdateValidationKeys=exports.DEFAULT_ERROR_MESSAGES=void 0;const constants_1=require("../model/constants.cjs");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};

package/lib/validation/constants.d.ts

@@ -28,22 +28,3 @@ export declare const UpdateValidationKeys: {
     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

@@ -1 +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;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.serialize=exports.serializeAfterAll=exports.serializeOnCreateUpdate=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 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.serializeOnCreateUpdate=serializeOnCreateUpdate,exports.serializeAfterAll=serializeAfterAll,exports.serialize=serialize;

package/lib/validation/decorators.d.ts

@@ -46,17 +46,6 @@ export declare function timestampHandler<T extends DBModel, V extends IRepositor
  * @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>;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/db-decorators",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Agnostic database decorators and repository",
   "type": "module",
   "exports": {
@@ -19,7 +19,7 @@
     "test:integration": "jest --coverage --testPathPattern=\"/tests/(integration)\" --passWithNoTests --detectOpenHandles",
     "test:all": "jest --coverage --testPathPattern=\"/tests/(unit|integration)\" --passWithNoTests --detectOpenHandles",
     "lint": "eslint .",
-    "lint-fix": "eslint . && eslint --fix ./src/*",
+    "lint-fix": "eslint --fix ./src/*",
     "test:circular": "dpdm -T --no-warning --no-tree ./src/index.ts",
     "prepare-release": "npm run lint-fix && npm run build:prod && npm run test && npm run docs",
     "release": "./bin/tag-release.sh",

package/lib/esm/repository/constants.d.ts

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

package/lib/esm/repository/constants.js

@@ -1 +0,0 @@
-var Cascade;!function(a){a.CASCADE="cascade",a.NONE="none"}(Cascade=Cascade||{});const DefaultCascade={update:Cascade.CASCADE,delete:Cascade.NONE};export{Cascade,DefaultCascade};

package/lib/esm/repository/types.d.ts

@@ -1,13 +0,0 @@
-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/constants.cjs

@@ -1 +0,0 @@
-"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

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

package/lib/repository/types.cjs

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

package/lib/repository/types.d.ts

@@ -1,13 +0,0 @@
-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[];
-};