@orion-js/schema 3.11.8 → 3.12.0

package/lib/types/fieldValidators.d.ts

@@ -1,2 +0,0 @@
-import fieldTypes from '../fieldTypes';
-export type FieldValidatorType = keyof typeof fieldTypes | 'custom' | 'plainObject';

package/lib/types/fieldValidators.js

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

package/lib/types/index.d.ts

@@ -1,2 +0,0 @@
-export * from './schema';
-export * from './fieldValidators';

package/lib/types/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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("./schema"), exports);
-__exportStar(require("./fieldValidators"), exports);

package/lib/types/schema.d.ts

@@ -1,118 +0,0 @@
-import { FieldType } from '../fieldType';
-export type Constructor<T> = new (...args: any[]) => T;
-export type Blackbox = {
-    [name: string]: any;
-};
-export type FieldTypesList = 'string' | 'date' | 'integer' | 'number' | 'ID' | 'boolean' | 'email' | 'blackbox' | 'any';
-export type TypedModelOnSchema = Function;
-export type ConstructorsTypesList = Constructor<String> | Constructor<Number> | Constructor<Boolean> | Constructor<Date>;
-export type SchemaRecursiveNodeTypeExtras = {
-    _isFieldType?: boolean;
-    __clean?: CleanFunction;
-    __validate?: ValidateFunction;
-    __skipChildValidation?: (value: any, info: CurrentNodeInfo) => Promise<boolean>;
-};
-export interface Schema {
-    [key: string]: SchemaNode | Function;
-}
-export type SchemaRecursiveNodeType = Schema & SchemaRecursiveNodeTypeExtras;
-export type SchemaMetaFieldTypeSingle = FieldTypesList | ConstructorsTypesList | SchemaRecursiveNodeType | FieldType | TypedModelOnSchema;
-export type SchemaMetaFieldType = SchemaMetaFieldTypeSingle | SchemaMetaFieldTypeSingle[];
-export type ValidateFunction = (value: any, info?: Partial<CurrentNodeInfo>, ...args: any[]) => object | string | void | Promise<object | string | void>;
-export type CleanFunction = (value: any, info?: Partial<CurrentNodeInfo>, ...args: any[]) => any | Promise<any>;
-export interface SchemaNode {
-    /**
-     * The type of the field. Used for type validations. Can also contain a subschema.
-     */
-    type: SchemaMetaFieldType;
-    /**
-     * Defaults to false
-     */
-    optional?: boolean;
-    allowedValues?: Array<any>;
-    defaultValue?: ((info: CurrentNodeInfo, ...args: any[]) => any | Promise<any>) | any;
-    /**
-     * Function that takes a value and returns an error message if there are any errors. Must return null or undefined otherwise.
-     */
-    validate?: ValidateFunction;
-    /**
-     * Function that preprocesses a value before it is set.
-     */
-    clean?: CleanFunction;
-    autoValue?: (value: any, info: CurrentNodeInfo, ...args: any[]) => any | Promise<any>;
-    /**
-     * The minimum value if it's a number, the minimum length if it's a string or array.
-     */
-    min?: number;
-    /**
-     * The maximum value if it's a number, the maximum length if it's a string or array.
-     */
-    max?: number;
-    /**
-     * Internal use only.
-     */
-    isBlackboxChild?: boolean;
-    /**
-     * @deprecated
-     */
-    custom?: ValidateFunction;
-    /**
-     * Used in GraphQL. If true, the field will be omitted from the schema.
-     */
-    private?: boolean;
-    /**
-     * Used in GraphQL. When in GraphQL, this resolver will replace the static field.
-     */
-    graphQLResolver?: (...args: any) => any;
-    /**
-     * Used in GraphQL. Sets the key of the field in the GraphQL schema. You must set this value when building your schema.
-     */
-    key?: string;
-    /**
-     * The name that would be displayed in a front-end form
-     */
-    label?: string;
-    /**
-     * The description that would be displayed in a front-end form
-     */
-    description?: string;
-    /**
-     * The placeholder that would be displayed in a front-end form
-     */
-    placeholder?: string;
-    /**
-     * The field type that would be used in a front-end form
-     */
-    fieldType?: string;
-    /**
-     * The field options that will be passed as props to the front-end field
-     */
-    fieldOptions?: any;
-}
-export interface CurrentNodeInfoOptions {
-    autoConvert?: boolean;
-    filter?: boolean;
-    trimStrings?: boolean;
-    removeEmptyStrings?: boolean;
-    forceDoc?: any;
-    omitRequired?: boolean;
-}
-export interface CurrentNodeInfo {
-    /**
-     * The global schema, prefaced by {type: {...}} to be compatible with subschemas
-     * Sometimes it's given without {type: {...}}. TODO: Normalize this.
-     */
-    schema?: SchemaNode | Schema;
-    /**
-     * The current node subschema
-     */
-    currentSchema?: Partial<SchemaNode>;
-    value: any;
-    doc?: any;
-    currentDoc?: any;
-    options?: CurrentNodeInfoOptions;
-    args?: any[];
-    type?: SchemaMetaFieldType;
-    keys?: string[];
-    addError?: (keys: string[], code: string | object) => void;
-}

package/lib/types/schema.js

@@ -1,3 +0,0 @@
-"use strict";
-/* eslint-disable @typescript-eslint/ban-types */
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/types.test.d.ts

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

package/lib/types/types.test.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const __1 = require("..");
-test('check ts types for schema', async () => {
-    const schema = {
-        numbers: {
-            type: [Number]
-        },
-        string: {
-            type: 'string',
-            optional: true,
-            private: true
-        }
-    };
-    const result = await (0, __1.clean)(schema, { numbers: ['2'], string: 1 });
-    expect(result).toEqual({ numbers: [2], string: '1' });
-});

package/lib/validate.d.ts

@@ -1,2 +0,0 @@
-import { Schema } from './types/schema';
-export default function validate(schema: Schema | Function, doc: any, passedOptions?: {}, ...args: any[]): Promise<void>;

package/lib/validate.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 ValidationError_1 = __importDefault(require("./ValidationError"));
-const getValidationErrors_1 = __importDefault(require("./getValidationErrors"));
-async function validate(schema, doc, passedOptions = {}, ...args) {
-    const validationErrors = await (0, getValidationErrors_1.default)(schema, doc, passedOptions, ...args);
-    if (validationErrors) {
-        throw new ValidationError_1.default(validationErrors);
-    }
-}
-exports.default = validate;

package/lib/validate.test.d.ts

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

package/lib/validate.test.js

@@ -1,29 +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 validate_1 = __importDefault(require("./validate"));
-const schema = {
-    firstName: {
-        type: String
-    },
-    lastName: {
-        type: String,
-        optional: true
-    }
-};
-const validObject = { firstName: 'Nicolás', lastName: 'López' };
-const invalidObject = { lastName: 'López' };
-test("doesn't throw any error when object is valid", async () => {
-    await (0, validate_1.default)(schema, validObject);
-});
-test('throws validation error when object is invalid', async () => {
-    expect.assertions(1);
-    try {
-        await (0, validate_1.default)(schema, invalidObject);
-    }
-    catch (error) {
-        expect(error.code).toBe('validationError');
-    }
-});

package/lib/validateKey/dotGetSchema.d.ts

@@ -1,2 +0,0 @@
-import { Schema } from '..';
-export default function (schema: Schema, path: string): any;

package/lib/validateKey/dotGetSchema.js

@@ -1,32 +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 isNil_1 = __importDefault(require("lodash/isNil"));
-const dotGet = function dotGet(object, path) {
-    if (path === '')
-        return object;
-    const pathParts = path.split('.');
-    const first = pathParts.shift();
-    const remainingPath = pathParts.join('.');
-    const levelObject = object.type;
-    if (first === '$' || /^[0-9]+$/.test(first)) {
-        return dotGet({ type: levelObject[0] }, remainingPath);
-    }
-    else if ((0, isPlainObject_1.default)(levelObject[first])) {
-        return dotGet(levelObject[first], remainingPath);
-    }
-    if (levelObject === 'blackbox') {
-        return { type: 'blackbox', optional: true, isBlackboxChild: true };
-    }
-    return null;
-};
-function default_1(schema, path) {
-    if ((0, isNil_1.default)(schema)) {
-        throw new Error('You need to pass a schema');
-    }
-    return dotGet({ type: schema }, path);
-}
-exports.default = default_1;

package/lib/validateKey/dotGetSchema.test.d.ts

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

package/lib/validateKey/dotGetSchema.test.js

@@ -1,65 +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 dotGetSchema_1 = __importDefault(require("./dotGetSchema"));
-const tag = {
-    name: {
-        type: String
-    },
-    other: {
-        type: 'string'
-    }
-};
-const car = {
-    brand: {
-        type: String
-    },
-    tags: {
-        type: [tag]
-    }
-};
-const schema = {
-    name: {
-        type: String
-    },
-    car: {
-        type: car
-    }
-};
-test('handle deep schemas', async () => {
-    const value = (0, dotGetSchema_1.default)(schema, 'car.brand');
-    expect(value).toBe(schema.car.type.brand);
-});
-test('throw error when no schema is passed', async () => {
-    expect.assertions(1);
-    try {
-        (0, dotGetSchema_1.default)(null, 'car.brand');
-    }
-    catch (error) {
-        expect(error.message).toBe('You need to pass a schema');
-    }
-});
-test('handle invalid paths', async () => {
-    const value = (0, dotGetSchema_1.default)(schema, 'car.brand.name');
-    expect(value).toBeNull();
-});
-test('finds array first item when $ is passed', async () => {
-    const value = (0, dotGetSchema_1.default)(schema, 'car.tags.$.name');
-    expect(value).toBe(tag.name);
-});
-test('replaces numbers to $', async () => {
-    expect((0, dotGetSchema_1.default)(schema, 'car.tags.0.name')).toBe(tag.name);
-    expect((0, dotGetSchema_1.default)(schema, 'car.tags.1123.name')).toBe(tag.name);
-});
-test('returns information when is blackbox child', async () => {
-    const schema = {
-        services: {
-            type: 'blackbox'
-        }
-    };
-    expect((0, dotGetSchema_1.default)(schema, 'services')).toBe(schema.services);
-    expect((0, dotGetSchema_1.default)(schema, 'services').isBlackboxChild).toBeUndefined();
-    expect((0, dotGetSchema_1.default)(schema, 'services.phoneVerification').isBlackboxChild).toBe(true);
-});

package/lib/validateKey/index.d.ts

@@ -1,2 +0,0 @@
-import { CurrentNodeInfoOptions, Schema } from '..';
-export default function (schema: Schema, key: string, value: any, passedOptions?: CurrentNodeInfoOptions, ...args: any[]): Promise<any>;

package/lib/validateKey/index.js

@@ -1,31 +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 dotGetSchema_1 = __importDefault(require("./dotGetSchema"));
-const getValidationErrors_1 = __importDefault(require("../getValidationErrors"));
-const Errors_1 = __importDefault(require("../Errors"));
-const defaultOptions = {
-    filter: false
-};
-async function default_1(schema, key, value, passedOptions = {}, ...args) {
-    const options = { ...defaultOptions, ...passedOptions };
-    const keySchema = (0, dotGetSchema_1.default)(schema, key);
-    if (!keySchema) {
-        if (options.filter) {
-            return Errors_1.default.NOT_IN_SCHEMA;
-        }
-        else {
-            return null;
-        }
-    }
-    if (keySchema.isBlackboxChild) {
-        return null;
-    }
-    const result = await (0, getValidationErrors_1.default)({ validate: keySchema }, { validate: value }, options, ...args);
-    if (!result)
-        return null;
-    return result.validate;
-}
-exports.default = default_1;

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

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

package/lib/validateKey/index.test.js

@@ -1,84 +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 index_1 = __importDefault(require("./index"));
-const Errors_1 = __importDefault(require("../Errors"));
-test('autoconvert value', async () => {
-    const schema = {
-        number: {
-            type: Number
-        }
-    };
-    const errors = await (0, index_1.default)(schema, 'number', '12');
-    expect(errors).toEqual(Errors_1.default.NOT_A_NUMBER);
-});
-test('deep validate fields', async () => {
-    const tag = {
-        name: {
-            type: 'string'
-        }
-    };
-    const car = {
-        brand: {
-            type: 'string'
-        },
-        tags: {
-            type: [tag]
-        }
-    };
-    const schema = {
-        name: {
-            type: 'string'
-        },
-        car: {
-            type: car
-        }
-    };
-    expect(await (0, index_1.default)(schema, 'car.brand', 'Nissan')).toBeNull();
-    expect(await (0, index_1.default)(schema, 'car.tags', 'Nice')).toBe(Errors_1.default.NOT_AN_ARRAY);
-    expect(await (0, index_1.default)(schema, 'name', null)).toBe(Errors_1.default.REQUIRED);
-    expect(await (0, index_1.default)(schema, 'car', null)).toBe(Errors_1.default.REQUIRED);
-    expect(await (0, index_1.default)(schema, 'car.tags.$.name', 12)).toBe(Errors_1.default.NOT_A_STRING);
-    expect(await (0, index_1.default)(schema, 'car.tags.100.name', 12)).toBe(Errors_1.default.NOT_A_STRING);
-});
-test('filters keys not in schema', async () => {
-    const schema = {
-        services: {
-            type: 'blackbox'
-        }
-    };
-    expect(await (0, index_1.default)(schema, 'person.name', 'Nicolás')).toBeNull();
-});
-test('dont filter keys not in schema if specified', async () => {
-    const schema = {
-        services: {
-            type: 'blackbox'
-        }
-    };
-    expect(await (0, index_1.default)(schema, 'person.name', 'Nicolás', { filter: true })).toBe(Errors_1.default.NOT_IN_SCHEMA);
-});
-test('should handle $ correctly', async () => {
-    const Email = {
-        address: {
-            type: String
-        },
-        verified: {
-            type: Boolean
-        }
-    };
-    const user = {
-        emails: {
-            type: [Email]
-        }
-    };
-    expect(await (0, index_1.default)(user, 'emails.$.verified', true)).toBeNull();
-});
-test('validate blackbox child', async () => {
-    const schema = {
-        _id: { type: 'ID' },
-        services: { type: 'blackbox' }
-    };
-    expect(await (0, index_1.default)(schema, 'services.phoneVerification.tries', 1)).toBeNull();
-});