@orion-js/schema 3.11.6 → 4.0.0-alpha.2

package/package.json

@@ -1,20 +1,21 @@
 {
   "name": "@orion-js/schema",
-  "version": "3.11.6",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "version": "4.0.0-alpha.2",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
   "files": [
-    "/lib"
+    "dist"
   ],
   "author": "nicolaslopezj",
   "license": "MIT",
   "scripts": {
     "prepare": "yarn run build",
-    "clean": "rm -rf ./lib",
-    "build": "yarn run clean && tsc",
+    "clean": "rm -rf ./dist",
+    "build": "bun run build.ts",
     "watch": "tsc -w",
     "upgrade-interactive": "yarn upgrade-interactive",
-    "test": "jest --config jest.config.js"
+    "test": "bun test",
+    "dev": "bun --watch src/index.ts"
   },
   "dependencies": {
     "dot-object": "^2.1.4",
@@ -22,14 +23,19 @@
   },
   "devDependencies": {
     "@types/dot-object": "^2.1.2",
-    "@types/jest": "^27.4.1",
     "@types/lodash": "4.14.181",
-    "jest": "27.3.1",
-    "ts-jest": "27.0.7",
-    "typescript": "^4.6.3"
+    "typescript": "^5.4.5",
+    "@types/bun": "^1.2.4"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "04323e40315251064616cece5fba54bf378917aa"
-}
+  "gitHead": "9d85ab24776533db109843c277324e42c65ddedd",
+  "type": "module",
+  "module": "./dist/index.js",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  }
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Orionjs Team
-
-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/lib/Errors.d.ts

@@ -1,21 +0,0 @@
-declare const _default: {
-    NOT_IN_SCHEMA: string;
-    REQUIRED: string;
-    UNKNOWN_FIELD_TYPE: string;
-    NOT_AN_ARRAY: string;
-    NOT_AN_OBJECT: string;
-    NOT_A_STRING: string;
-    NOT_A_DATE: string;
-    NOT_AN_INTEGER: string;
-    NOT_A_NUMBER: string;
-    NOT_AN_ID: string;
-    STRING_TOO_SHORT: string;
-    STRING_TOO_LONG: string;
-    NUMBER_TOO_SMALL: string;
-    NUMBER_TOO_BIG: string;
-    NOT_A_BOOLEAN: string;
-    NOT_AN_EMAIL: string;
-    NOT_UNIQUE: string;
-    NOT_AN_ALLOWED_VALUE: string;
-};
-export default _default;

package/lib/Errors.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    NOT_IN_SCHEMA: 'notInSchema',
-    REQUIRED: 'required',
-    UNKNOWN_FIELD_TYPE: 'unknownFieldType',
-    NOT_AN_ARRAY: 'notAnArray',
-    NOT_AN_OBJECT: 'notAnObject',
-    NOT_A_STRING: 'notAString',
-    NOT_A_DATE: 'notADate',
-    NOT_AN_INTEGER: 'notAnInteger',
-    NOT_A_NUMBER: 'notANumber',
-    NOT_AN_ID: 'notAnId',
-    STRING_TOO_SHORT: 'stringTooShort',
-    STRING_TOO_LONG: 'stringTooLong',
-    NUMBER_TOO_SMALL: 'numberTooSmall',
-    NUMBER_TOO_BIG: 'numberTooBig',
-    NOT_A_BOOLEAN: 'notABoolean',
-    NOT_AN_EMAIL: 'notAnEmail',
-    NOT_UNIQUE: 'notUnique',
-    NOT_AN_ALLOWED_VALUE: 'notAnAllowedValue'
-};

package/lib/ValidationError.d.ts

@@ -1,14 +0,0 @@
-export interface ValidationErrorInfo {
-    error: string;
-    message: string;
-    validationErrors: object;
-}
-export default class ValidationError extends Error {
-    code: string;
-    isValidationError: boolean;
-    isOrionError: boolean;
-    validationErrors: object;
-    constructor(validationErrors: object);
-    getInfo: () => ValidationErrorInfo;
-    prependKey: (prepend: any) => ValidationError;
-}

package/lib/ValidationError.js

@@ -1,45 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const isPlainObject_1 = __importDefault(require("lodash/isPlainObject"));
-const getPrintableError = (validationErrors) => {
-    const printableErrors = Object.keys(validationErrors)
-        .map(key => {
-        return `${key}: ${validationErrors[key]}`;
-    })
-        .join(', ');
-    const message = `Validation Error: {${printableErrors}}`;
-    return message;
-};
-class ValidationError extends Error {
-    constructor(validationErrors) {
-        super(getPrintableError(validationErrors));
-        this.getInfo = () => {
-            return {
-                error: 'validationError',
-                message: 'Validation Error',
-                validationErrors: this.validationErrors
-            };
-        };
-        this.prependKey = prepend => {
-            const newErrors = {};
-            const keys = Object.keys(this.validationErrors);
-            for (const key of keys) {
-                newErrors[`${prepend}.${key}`] = this.validationErrors[key];
-            }
-            return new ValidationError(newErrors);
-        };
-        if (!(0, isPlainObject_1.default)(validationErrors)) {
-            throw new Error('ValidationError must be initialized with an errors object');
-        }
-        Error.captureStackTrace(this, this.constructor);
-        this.code = 'validationError';
-        this.isValidationError = true;
-        this.isOrionError = true;
-        this.validationErrors = validationErrors;
-        this.getInfo;
-    }
-}
-exports.default = ValidationError;

package/lib/ValidationError.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/ValidationError.test.js

@@ -1,35 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const ValidationError_1 = __importDefault(require("./ValidationError"));
-const Errors_1 = __importDefault(require("./Errors"));
-test("don't allow to create a ValidationError with no error", () => {
-    expect(() => {
-        // @ts-ignore
-        new ValidationError_1.default();
-    }).toThrow();
-});
-test('ValidationError is instance of Error', () => {
-    const error = new ValidationError_1.default({ name: Errors_1.default.REQUIRED });
-    expect(error).toBeInstanceOf(Error);
-});
-test('message to be show error information', () => {
-    const error = new ValidationError_1.default({ name: Errors_1.default.REQUIRED });
-    expect(error.message).toBe('Validation Error: {name: required}');
-});
-test('prepends keys', () => {
-    const error = new ValidationError_1.default({ name: Errors_1.default.REQUIRED });
-    expect(error.prependKey('person').message).toBe('Validation Error: {person.name: required}');
-});
-test('getInfo to return error information in correct format', () => {
-    const validationError = { name: Errors_1.default.REQUIRED };
-    const error = new ValidationError_1.default(validationError);
-    const info = {
-        error: 'validationError',
-        message: 'Validation Error',
-        validationErrors: { name: Errors_1.default.REQUIRED }
-    };
-    expect(error.getInfo()).toEqual(info);
-});

package/lib/clean/cleanType.d.ts

@@ -1,3 +0,0 @@
-import { CurrentNodeInfo, SchemaMetaFieldType, SchemaNode } from '../types/schema';
-import { FieldValidatorType } from '../types/fieldValidators';
-export default function cleanType(type: SchemaMetaFieldType | FieldValidatorType, fieldSchema: Partial<SchemaNode>, value: any, info: CurrentNodeInfo, ...args: any[]): Promise<any>;

package/lib/clean/cleanType.js

@@ -1,49 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getFieldType_1 = __importDefault(require("../getValidationErrors/getError/getFieldType"));
-const isNil_1 = __importDefault(require("lodash/isNil"));
-const getObjectNode_1 = __importDefault(require("./getObjectNode"));
-async function cleanType(type, fieldSchema, value, info, ...args) {
-    info.type = fieldSchema.type;
-    if (!info.type) {
-        throw new Error('Cleaning field with no type');
-    }
-    const { clean: rootFieldClean } = await (0, getFieldType_1.default)(type);
-    if (rootFieldClean && !(0, isNil_1.default)(value)) {
-        value = await rootFieldClean(value, info, ...args);
-    }
-    let needReClean = false;
-    const objectTypeSchema = (0, getObjectNode_1.default)(fieldSchema, value);
-    if (objectTypeSchema && objectTypeSchema.type.__clean) {
-        needReClean = true;
-        value = await objectTypeSchema.type.__clean(value, info, ...args);
-    }
-    const { defaultValue } = fieldSchema;
-    if ((0, isNil_1.default)(value) && !(0, isNil_1.default)(defaultValue)) {
-        needReClean = true;
-        if (typeof defaultValue === 'function') {
-            value = await defaultValue(info, ...args);
-        }
-        else {
-            value = defaultValue;
-        }
-    }
-    const { autoValue } = fieldSchema;
-    if (autoValue) {
-        needReClean = true;
-        value = await autoValue(value, info, ...args);
-    }
-    const { clean } = fieldSchema;
-    if (clean) {
-        needReClean = true;
-        value = await clean(value, info, ...args);
-    }
-    if (needReClean && rootFieldClean && !(0, isNil_1.default)(value)) {
-        value = await rootFieldClean(value, info, ...args);
-    }
-    return value;
-}
-exports.default = cleanType;

package/lib/clean/getObjectNode.d.ts

@@ -1,2 +0,0 @@
-import { SchemaNode } from '../types/schema';
-export default function getObjectNode(schema: Partial<SchemaNode>, value: any): SchemaNode | void;

package/lib/clean/getObjectNode.js

@@ -1,14 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const isPlainObject_1 = __importDefault(require("lodash/isPlainObject"));
-function getObjectNode(schema, value) {
-    if ((0, isPlainObject_1.default)(schema.type) && (0, isPlainObject_1.default)(value)) {
-        const result = schema;
-        return result;
-    }
-    return null;
-}
-exports.default = getObjectNode;

package/lib/clean/index.d.ts

@@ -1,2 +0,0 @@
-import { Blackbox, CurrentNodeInfoOptions, Schema } from '../types/schema';
-export default function clean<TDoc = Blackbox>(schema: Schema | Function, doc: TDoc, opts?: CurrentNodeInfoOptions, ...args: any[]): Promise<TDoc>;

package/lib/clean/index.js

@@ -1,30 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getSchemaFromTypedModel_1 = require("../getSchemaFromTypedModel");
-const recursiveClean_1 = __importDefault(require("./recursiveClean"));
-const defaultOptions = {
-    autoConvert: true,
-    filter: true,
-    trimStrings: true,
-    removeEmptyStrings: false
-};
-async function clean(schema, doc, opts = {}, ...args) {
-    if (!doc)
-        return doc;
-    schema = (0, getSchemaFromTypedModel_1.getSchemaFromTypedModel)(schema);
-    const options = { ...defaultOptions, ...opts };
-    const params = {
-        schema: { type: schema },
-        value: doc,
-        doc: options.forceDoc || doc,
-        currentDoc: doc,
-        options,
-        args
-    };
-    const cleanedResult = await (0, recursiveClean_1.default)(params);
-    return cleanedResult;
-}
-exports.default = clean;

package/lib/clean/index.test.d.ts

@@ -1 +0,0 @@
-export {};