@decaf-ts/db-decorators 0.1.0

package/lib/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/validation/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("./validators/index.cjs"),exports),__exportStar(require("./constants.cjs"),exports),__exportStar(require("./decorators.cjs"),exports);

package/lib/validation/index.d.ts

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

package/lib/validation/validators/ReadOnlyValidator.cjs

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

package/lib/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/validation/validators/TimestampValidator.cjs

@@ -0,0 +1 @@
+"use strict";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)};Object.defineProperty(exports,"__esModule",{value:!0}),exports.TimestampValidator=void 0;const decorator_validation_1=require("@decaf-ts/decorator-validation"),constants_1=require("../constants.cjs");let TimestampValidator=class extends decorator_validation_1.Validator{constructor(){super(constants_1.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}}};exports.TimestampValidator=TimestampValidator,exports.TimestampValidator=TimestampValidator=__decorate([(0,decorator_validation_1.validator)(constants_1.UpdateValidationKeys.TIMESTAMP),__metadata("design:paramtypes",[])],TimestampValidator);

package/lib/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/validation/validators/UpdateValidator.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.UpdateValidator=void 0;const decorator_validation_1=require("@decaf-ts/decorator-validation");class UpdateValidator extends decorator_validation_1.Validator{constructor(a=decorator_validation_1.DEFAULT_ERROR_MESSAGES.DEFAULT,...t){super(a,...t)}}exports.UpdateValidator=UpdateValidator;

package/lib/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/validation/validators/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("./ReadOnlyValidator.cjs"),exports),__exportStar(require("./TimestampValidator.cjs"),exports),__exportStar(require("./UpdateValidator.cjs"),exports);

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

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

package/package.json

@@ -0,0 +1,107 @@
+{
+  "name": "@decaf-ts/db-decorators",
+  "version": "0.1.0",
+  "description": "Agnostic database decorators and repository",
+  "type": "module",
+  "exports": {
+    "require": "./lib/index.cjs",
+    "import": "./lib/esm/index.js"
+  },
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "do-install": "TOKEN=$(cat .token) npm install",
+    "update-dependencies": "rimraf node_modules/@decaf-ts package-lock.json && npm run do-install",
+    "flash-forward": "npx npm-check-updates -u && npm run do-install",
+    "reset": "rm -rf * && git checkout . && git pull && npm run do-install",
+    "build": "rimraf ./lib && rimraf ./dist && gulp dev",
+    "build:prod": "rimraf ./lib && rimraf ./dist && gulp prod",
+    "test": "jest --coverage --testPathPattern=\"/tests/unit\" --passWithNoTests --detectOpenHandles",
+    "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/*",
+    "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",
+    "clean-publish": "npx clean-publish",
+    "coverage": "npm run test:all && jest-coverage-badges --input \"./workdocs/coverage/coverage-summary.json\" --output \"./workdocs/badges\"",
+    "docs": "npx rimraf ./docs && mkdir docs && npm run do-install -- better-docs taffydb && gulp docs; npm remove better-docs taffydb"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/decaf-ts/db-decorators.git"
+  },
+  "engines": {
+    "node": ">=20.0.0",
+    "npm": ">=10.0.0"
+  },
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "keywords": [
+    "CRUD",
+    "hooks",
+    "create",
+    "read",
+    "update",
+    "delete",
+    "database",
+    "decorator",
+    "validation",
+    "model",
+    "orm",
+    "custom",
+    "extensible",
+    "lightweight",
+    "decaf-ts",
+    "javascript",
+    "typescript",
+    "ts"
+  ],
+  "author": "Tiago Venceslau",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/decaf-ts/db-decorators/issues"
+  },
+  "homepage": "https://github.com/decaf-ts/db-decorators#readme",
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@typescript-eslint/eslint-plugin": "^7.1.1",
+    "clean-publish": "^4.3.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "gulp": "^4.0.2",
+    "gulp-if": "^3.0.0",
+    "gulp-rename": "^2.0.0",
+    "gulp-replace": "^1.1.4",
+    "gulp-run-command": "^0.0.10",
+    "gulp-sourcemaps": "^3.0.0",
+    "gulp-typescript": "^6.0.0-alpha.1",
+    "gulp-uglify": "^3.0.2",
+    "jest": "^29.7.0",
+    "jest-coverage-badges": "^1.1.2",
+    "jest-junit": "^16.0.0",
+    "jsdoc": "^4.0.2",
+    "jsdoc-mermaid": "^1.0.0",
+    "markdown-include": "^0.4.3",
+    "merge-stream": "^2.0.0",
+    "nodemon": "^3.1.0",
+    "npm-check-updates": "^16.14.15",
+    "prettier": "^3.2.5",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.2",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.2",
+    "vinyl-named": "^1.1.0",
+    "webpack-stream": "^7.0.0"
+  },
+  "peerDependencies": {
+    "@decaf-ts/decorator-validation": "latest",
+    "@decaf-ts/injectable-decorators": "latest",
+    "@decaf-ts/reflection": "latest",
+    "reflect-metadata": "^0.2.1"
+  }
+}