@alanszp/validations 4.0.13

package/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+*.log
+dist

package/.npmignore

@@ -0,0 +1,3 @@
+node_modules
+src
+*.log

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Alan Szpigiel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/BaseModel.d.ts

@@ -0,0 +1,6 @@
+/**
+ * BaseModel represents a va
+ */
+export declare abstract class BaseModel {
+    validate(): Promise<void>;
+}

package/dist/BaseModel.js

@@ -0,0 +1,31 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseModel = void 0;
+const class_validator_1 = require("class-validator");
+const ModelValidationError_1 = require("./ModelValidationError");
+/**
+ * BaseModel represents a va
+ */
+class BaseModel {
+    // TODO: This model is shared between baseEntity and baseModel. Do a mixin.
+    validate() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const validationResult = yield (0, class_validator_1.validate)(this);
+            if (validationResult.length > 0) {
+                return Promise.reject(new ModelValidationError_1.ModelValidationError(validationResult));
+            }
+            return Promise.resolve();
+        });
+    }
+}
+exports.BaseModel = BaseModel;
+//# sourceMappingURL=BaseModel.js.map

package/dist/BaseModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseModel.js","sourceRoot":"","sources":["../src/BaseModel.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA2C;AAC3C,iEAA8D;AAE9D;;GAEG;AACH,MAAsB,SAAS;IAC7B,2EAA2E;IAC9D,QAAQ;;YACnB,MAAM,gBAAgB,GAAG,MAAM,IAAA,0BAAQ,EAAC,IAAI,CAAC,CAAC;YAE9C,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC/B,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,2CAAoB,CAAC,gBAAgB,CAAC,CAAC,CAAC;aACnE;YACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;KAAA;CACF;AAVD,8BAUC"}

package/dist/ModelValidationError.d.ts

@@ -0,0 +1,16 @@
+import { ValidationError } from "class-validator";
+import { BaseError, RenderableError, RenderableContext } from "@alanszp/errors";
+export interface ValidationObject {
+    property: string;
+    constraints: {
+        [type: string]: string;
+    };
+}
+export declare class ModelValidationError extends BaseError implements RenderableError {
+    errors: ValidationError[];
+    constructor(errors: ValidationError[]);
+    static from(objects: ValidationObject | ValidationObject[]): ModelValidationError;
+    renderMessage(): string;
+    code(): string;
+    context(): RenderableContext;
+}

package/dist/ModelValidationError.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelValidationError = void 0;
+const class_validator_1 = require("class-validator");
+const lodash_1 = require("lodash");
+const errors_1 = require("@alanszp/errors");
+class ModelValidationError extends errors_1.BaseError {
+    constructor(errors) {
+        super("Model Validation Error");
+        this.errors = errors;
+    }
+    static from(objects) {
+        const arrayObjects = (0, lodash_1.isArray)(objects) ? objects : [objects];
+        const validationErrors = arrayObjects.map((o) => {
+            const validationError = new class_validator_1.ValidationError();
+            validationError.property = o.property;
+            validationError.children = [];
+            validationError.constraints = o.constraints;
+            return validationError;
+        });
+        return new ModelValidationError(validationErrors);
+    }
+    renderMessage() {
+        return "Model validation error";
+    }
+    code() {
+        return "model_validation_error";
+    }
+    context() {
+        return {
+            errors: this.errors.map((e) => ({
+                property: e.property,
+                errors: e.constraints,
+                children: e.children,
+            })),
+        };
+    }
+}
+exports.ModelValidationError = ModelValidationError;
+//# sourceMappingURL=ModelValidationError.js.map

package/dist/ModelValidationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelValidationError.js","sourceRoot":"","sources":["../src/ModelValidationError.ts"],"names":[],"mappings":";;;AAAA,qDAAkD;AAClD,mCAAiC;AACjC,4CAAgF;AAOhF,MAAa,oBAAqB,SAAQ,kBAAS;IAGjD,YAAY,MAAyB;QACnC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,IAAI,CAChB,OAA8C;QAE9C,MAAM,YAAY,GAAG,IAAA,gBAAO,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAE5D,MAAM,gBAAgB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC9C,MAAM,eAAe,GAAG,IAAI,iCAAe,EAAE,CAAC;YAE9C,eAAe,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;YACtC,eAAe,CAAC,QAAQ,GAAG,EAAE,CAAC;YAC9B,eAAe,CAAC,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;YAE5C,OAAO,eAAe,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;IACpD,CAAC;IAEM,aAAa;QAClB,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAEM,IAAI;QACT,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAEM,OAAO;QACZ,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC9B,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,MAAM,EAAE,CAAC,CAAC,WAAW;gBACrB,QAAQ,EAAE,CAAC,CAAC,QAAQ;aACrB,CAAC,CAAC;SACJ,CAAC;IACJ,CAAC;CACF;AA3CD,oDA2CC"}

package/dist/common-validators/IsJustEditable.d.ts

@@ -0,0 +1,2 @@
+import { ValidationOptions } from "class-validator";
+export declare function IsJustEditable(validationOptions?: ValidationOptions): (object: object, propertyName: string) => void;

package/dist/common-validators/IsJustEditable.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IsJustEditable = void 0;
+const class_validator_1 = require("class-validator");
+function IsJustEditable(validationOptions) {
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    return function justEditableDecorator(object, propertyName) {
+        (0, class_validator_1.registerDecorator)({
+            name: class_validator_1.ValidationTypes.CONDITIONAL_VALIDATION,
+            target: object.constructor,
+            propertyName,
+            constraints: [(_object, value) => value !== undefined],
+            options: validationOptions,
+            validator: {
+                validate(value) {
+                    return value !== null;
+                },
+                defaultMessage() {
+                    return `${propertyName} should not be defined or different than null`;
+                },
+            },
+        });
+    };
+}
+exports.IsJustEditable = IsJustEditable;
+//# sourceMappingURL=IsJustEditable.js.map

package/dist/common-validators/IsJustEditable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IsJustEditable.js","sourceRoot":"","sources":["../../src/common-validators/IsJustEditable.ts"],"names":[],"mappings":";;;AAAA,qDAAwF;AAExF,SAAgB,cAAc,CAAC,iBAAqC;IAClE,wDAAwD;IACxD,OAAO,SAAS,qBAAqB,CAAC,MAAc,EAAE,YAAoB;QACxE,IAAA,mCAAiB,EAAC;YAChB,IAAI,EAAE,iCAAe,CAAC,sBAAsB;YAC5C,MAAM,EAAE,MAAM,CAAC,WAAW;YAC1B,YAAY;YACZ,WAAW,EAAE,CAAC,CAAC,OAAgB,EAAE,KAAc,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC;YACxE,OAAO,EAAE,iBAAiB;YAC1B,SAAS,EAAE;gBACT,QAAQ,CAAC,KAAc;oBACrB,OAAO,KAAK,KAAK,IAAI,CAAC;gBACxB,CAAC;gBACD,cAAc;oBACZ,OAAO,GAAG,YAAY,+CAA+C,CAAC;gBACxE,CAAC;aACF;SACF,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAnBD,wCAmBC"}

package/dist/common-validators/index.d.ts

@@ -0,0 +1 @@
+export * from "./IsJustEditable";

package/dist/common-validators/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./IsJustEditable"), exports);
+//# sourceMappingURL=index.js.map

package/dist/common-validators/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common-validators/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mDAAiC"}

package/dist/entityOrValidationError.d.ts

@@ -0,0 +1 @@
+export declare function entityOrValidationError<T>(entity: T | undefined, property: string): T;

package/dist/entityOrValidationError.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.entityOrValidationError = void 0;
+const ModelValidationError_1 = require("./ModelValidationError");
+function entityOrValidationError(entity, property) {
+    if (!entity) {
+        throw ModelValidationError_1.ModelValidationError.from({
+            property,
+            constraints: {
+                mustBePresent: `${property} is not present`,
+            },
+        });
+    }
+    return entity;
+}
+exports.entityOrValidationError = entityOrValidationError;
+//# sourceMappingURL=entityOrValidationError.js.map

package/dist/entityOrValidationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entityOrValidationError.js","sourceRoot":"","sources":["../src/entityOrValidationError.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAE9D,SAAgB,uBAAuB,CACrC,MAAqB,EACrB,QAAgB;IAEhB,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,2CAAoB,CAAC,IAAI,CAAC;YAC9B,QAAQ;YACR,WAAW,EAAE;gBACX,aAAa,EAAE,GAAG,QAAQ,iBAAiB;aAC5C;SACF,CAAC,CAAC;KACJ;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAbD,0DAaC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./BaseModel";
+export * from "./ModelValidationError";
+export * from "./entityOrValidationError";
+export * from "./common-validators";

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./BaseModel"), exports);
+__exportStar(require("./ModelValidationError"), exports);
+__exportStar(require("./entityOrValidationError"), exports);
+__exportStar(require("./common-validators"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B;AAC5B,yDAAuC;AACvC,4DAA0C;AAC1C,sDAAoC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@alanszp/validations",
+  "version": "4.0.13",
+  "description": "Alan's validation utils.",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "license": "MIT",
+  "files": [
+    "**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "compile": "rm -rf ./dist && tsc --declaration",
+    "compile-watch": "tsc -w",
+    "build": "yarn run compile",
+    "prepack": "yarn run build",
+    "yalc-publish": "yarn run yalc publish"
+  },
+  "devDependencies": {
+    "@types/node": "^15.12.3",
+    "class-validator": "^0.13.1",
+    "ts-node": "^10.0.0",
+    "tslint": "^6.1.3",
+    "typescript": "^4.3.4"
+  },
+  "peerDependencies": {
+    "class-validator": "^0.13.1"
+  },
+  "dependencies": {
+    "@alanszp/errors": "^4.0.5"
+  },
+  "gitHead": "71a7bfa562fe5cfc52262f6bb4cadd6b977c6a4c"
+}

package/src/BaseModel.ts

@@ -0,0 +1,17 @@
+import { validate } from "class-validator";
+import { ModelValidationError } from "./ModelValidationError";
+
+/**
+ * BaseModel represents a va
+ */
+export abstract class BaseModel {
+  // TODO: This model is shared between baseEntity and baseModel. Do a mixin.
+  public async validate(): Promise<void> {
+    const validationResult = await validate(this);
+
+    if (validationResult.length > 0) {
+      return Promise.reject(new ModelValidationError(validationResult));
+    }
+    return Promise.resolve();
+  }
+}

package/src/ModelValidationError.ts

@@ -0,0 +1,53 @@
+import { ValidationError } from "class-validator";
+import { isArray } from "lodash";
+import { BaseError, RenderableError, RenderableContext } from "@alanszp/errors";
+
+export interface ValidationObject {
+  property: string;
+  constraints: { [type: string]: string };
+}
+
+export class ModelValidationError extends BaseError implements RenderableError {
+  public errors: ValidationError[];
+
+  constructor(errors: ValidationError[]) {
+    super("Model Validation Error");
+    this.errors = errors;
+  }
+
+  public static from(
+    objects: ValidationObject | ValidationObject[]
+  ): ModelValidationError {
+    const arrayObjects = isArray(objects) ? objects : [objects];
+
+    const validationErrors = arrayObjects.map((o) => {
+      const validationError = new ValidationError();
+
+      validationError.property = o.property;
+      validationError.children = [];
+      validationError.constraints = o.constraints;
+
+      return validationError;
+    });
+
+    return new ModelValidationError(validationErrors);
+  }
+
+  public renderMessage(): string {
+    return "Model validation error";
+  }
+
+  public code(): string {
+    return "model_validation_error";
+  }
+
+  public context(): RenderableContext {
+    return {
+      errors: this.errors.map((e) => ({
+        property: e.property,
+        errors: e.constraints,
+        children: e.children,
+      })),
+    };
+  }
+}

package/src/common-validators/IsJustEditable.ts

@@ -0,0 +1,22 @@
+import { registerDecorator, ValidationOptions, ValidationTypes } from "class-validator";
+
+export function IsJustEditable(validationOptions?: ValidationOptions) {
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  return function justEditableDecorator(object: object, propertyName: string): void {
+    registerDecorator({
+      name: ValidationTypes.CONDITIONAL_VALIDATION,
+      target: object.constructor,
+      propertyName,
+      constraints: [(_object: unknown, value: unknown) => value !== undefined],
+      options: validationOptions,
+      validator: {
+        validate(value: unknown): boolean {
+          return value !== null;
+        },
+        defaultMessage() {
+          return `${propertyName} should not be defined or different than null`;
+        },
+      },
+    });
+  };
+}

package/src/common-validators/index.ts

@@ -0,0 +1 @@
+export * from "./IsJustEditable";

package/src/entityOrValidationError.ts

@@ -0,0 +1,16 @@
+import { ModelValidationError } from "./ModelValidationError";
+
+export function entityOrValidationError<T>(
+  entity: T | undefined,
+  property: string
+): T {
+  if (!entity) {
+    throw ModelValidationError.from({
+      property,
+      constraints: {
+        mustBePresent: `${property} is not present`,
+      },
+    });
+  }
+  return entity;
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from "./BaseModel";
+export * from "./ModelValidationError";
+export * from "./entityOrValidationError";
+export * from "./common-validators";

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist",
+    "module": "commonjs",
+    "target": "es6",
+    "types": ["node"],
+    "esModuleInterop": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+
+    "alwaysStrict": true,
+    "strictNullChecks": true
+  },
+  "exclude": ["node_modules"]
+}