@orion-js/schema 3.2.53 → 3.3.9

package/lib/fieldType.d.ts

@@ -3,11 +3,15 @@ export interface FieldTypeOpts {
     name: string;
     validate?: ValidateFunction;
     clean?: CleanFunction;
+    toGraphQLType?: (GraphQL: any) => any;
+    meta?: any;
 }
 export interface FieldType {
     name: string;
     validate: ValidateFunction;
     clean: CleanFunction;
+    meta?: any;
+    toGraphQLType?: (GraphQL: any) => any;
     _isFieldType: boolean;
 }
 export default function fieldType(opts: FieldTypeOpts): FieldType;

package/lib/fieldTypes/enum.d.ts

@@ -0,0 +1,4 @@
+import { FieldType } from '../fieldType';
+export default function createEnum<TValues extends readonly string[]>(name: string, values: TValues): FieldType & {
+    type: TValues[number];
+};

package/lib/fieldTypes/enum.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fieldType_1 = __importDefault(require("../fieldType"));
+const isString_1 = __importDefault(require("lodash/isString"));
+const Errors_1 = __importDefault(require("../Errors"));
+const includes_1 = __importDefault(require("lodash/includes"));
+function createEnum(name, values) {
+    return {
+        type: values[0],
+        ...(0, fieldType_1.default)({
+            name: 'enum',
+            meta: {
+                enumName: name,
+                enumValues: values
+            },
+            toGraphQLType: GraphQL => {
+                return new GraphQL.GraphQLEnumType({
+                    name,
+                    values: values.reduce((result, value) => {
+                        result[value] = { value };
+                        return result;
+                    }, {})
+                });
+            },
+            validate(value, { currentSchema }) {
+                if (!(0, isString_1.default)(value))
+                    return Errors_1.default.NOT_A_STRING;
+                if (!(0, includes_1.default)(values, value)) {
+                    return Errors_1.default.NOT_AN_ALLOWED_VALUE;
+                }
+                if (value === '' && !currentSchema.optional) {
+                    return Errors_1.default.REQUIRED;
+                }
+            },
+            clean(value, { options: { autoConvert, trimStrings, removeEmptyStrings } }) {
+                if (autoConvert) {
+                    value = String(value);
+                }
+                if (trimStrings) {
+                    value = value.trim();
+                }
+                if (removeEmptyStrings && value === '') {
+                    return undefined;
+                }
+                return value;
+            }
+        })
+    };
+}
+exports.default = createEnum;

package/lib/fieldTypes/enum.test.d.ts

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

package/lib/fieldTypes/enum.test.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const enum_1 = __importDefault(require("./enum"));
+const Errors_1 = __importDefault(require("../Errors"));
+const getValidationErrors_1 = __importDefault(require("../getValidationErrors"));
+test('return an error when the value is incorrect', async () => {
+    expect((0, enum_1.default)('hello', ['hello']).validate(['Hello'])).toBe(Errors_1.default.NOT_A_STRING);
+    expect((0, enum_1.default)('hello', ['hello']).validate({ name: 'Nicolás' })).toBe(Errors_1.default.NOT_A_STRING);
+    expect((0, enum_1.default)('hello', ['hello']).validate(new Date())).toBe(Errors_1.default.NOT_A_STRING);
+});
+test('enum typescript helpers', async () => {
+    const myEnum = (0, enum_1.default)('HelloEnum', ['hello', 'hi']);
+    const string = 'hello';
+});
+test('return no error when the value is correct', async () => {
+    const info = { currentSchema: { optional: true } };
+    expect((0, enum_1.default)('hello', ['hello']).validate('', info)).toBe(Errors_1.default.NOT_AN_ALLOWED_VALUE);
+    expect((0, enum_1.default)('hello', ['hello']).validate('hello')).toBeFalsy();
+});
+test('validate correctly allowed values', async () => {
+    expect((0, enum_1.default)('hello', ['hello']).validate('hello')).toBeFalsy();
+    expect((0, enum_1.default)('hello', ['hello']).validate('hi')).toBe(Errors_1.default.NOT_AN_ALLOWED_VALUE);
+});
+test('Full schema with enum', async () => {
+    const schema = {
+        color: {
+            type: (0, enum_1.default)('colors', ['red', 'blue', 'green'])
+        }
+    };
+    expect(await (0, getValidationErrors_1.default)(schema, {
+        color: 'red'
+    })).toBeNull();
+    expect(await (0, getValidationErrors_1.default)(schema, {
+        color: 'yellow'
+    })).toEqual({
+        color: Errors_1.default.NOT_AN_ALLOWED_VALUE
+    });
+});

package/lib/getValidationErrors/doValidation.js

@@ -28,6 +28,9 @@ async function doValidation(params) {
     if ((0, isPlainObject_1.default)(currentSchema.type)) {
         const type = currentSchema.type;
         if (type) {
+            if (type._isFieldType) {
+                return;
+            }
             if (typeof type.__skipChildValidation === 'function') {
                 if (await type.__skipChildValidation(value, info)) {
                     return;

package/lib/index.d.ts

@@ -8,5 +8,6 @@ import clean from './clean';
 import cleanKey from './cleanKey';
 import validateKey from './validateKey';
 import dotGetSchema from './dotGetSchema';
-export { validate, ValidationError, getValidationErrors, isValid, getFieldType, fieldType, clean, cleanKey, dotGetSchema, validateKey };
+import createEnum from './fieldTypes/enum';
+export { validate, ValidationError, getValidationErrors, isValid, getFieldType, fieldType, clean, cleanKey, dotGetSchema, validateKey, createEnum };
 export * from './types';

package/lib/index.js

@@ -1,7 +1,11 @@
 "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]; } });
+    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];
@@ -13,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateKey = exports.dotGetSchema = exports.cleanKey = exports.clean = exports.fieldType = exports.getFieldType = exports.isValid = exports.getValidationErrors = exports.ValidationError = exports.validate = void 0;
+exports.createEnum = exports.validateKey = exports.dotGetSchema = exports.cleanKey = exports.clean = exports.fieldType = exports.getFieldType = exports.isValid = exports.getValidationErrors = exports.ValidationError = exports.validate = void 0;
 const validate_1 = __importDefault(require("./validate"));
 exports.validate = validate_1.default;
 const ValidationError_1 = __importDefault(require("./ValidationError"));
@@ -34,4 +38,6 @@ const validateKey_1 = __importDefault(require("./validateKey"));
 exports.validateKey = validateKey_1.default;
 const dotGetSchema_1 = __importDefault(require("./dotGetSchema"));
 exports.dotGetSchema = dotGetSchema_1.default;
+const enum_1 = __importDefault(require("./fieldTypes/enum"));
+exports.createEnum = enum_1.default;
 __exportStar(require("./types"), exports);

package/lib/types/fieldValidators.d.ts

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

package/lib/types/index.js

@@ -1,7 +1,11 @@
 "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]; } });
+    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];

package/lib/types/schema.d.ts

@@ -1,12 +1,13 @@
 import { FieldType } from '../fieldType';
-export declare type Constructor<T> = new (...args: any[]) => T;
-export declare type Blackbox = {
+export type Constructor<T> = new (...args: any[]) => T;
+export type Blackbox = {
     [name: string]: any;
 };
-export declare type FieldTypesList = 'string' | 'date' | 'integer' | 'number' | 'ID' | 'boolean' | 'email' | 'blackbox';
-export declare type TypedModelOnSchema = Function;
-export declare type ConstructorsTypesList = Constructor<String> | Constructor<Number> | Constructor<Boolean> | Constructor<Date>;
-export declare type SchemaRecursiveNodeTypeExtras = {
+export type FieldTypesList = 'string' | 'date' | 'integer' | 'number' | 'ID' | 'boolean' | 'email' | 'blackbox';
+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>;
@@ -14,11 +15,11 @@ export declare type SchemaRecursiveNodeTypeExtras = {
 export interface Schema {
     [key: string]: SchemaNode | Function;
 }
-export declare type SchemaRecursiveNodeType = Schema & SchemaRecursiveNodeTypeExtras;
-export declare type SchemaMetaFieldTypeSingle = FieldTypesList | ConstructorsTypesList | SchemaRecursiveNodeType | FieldType | TypedModelOnSchema;
-export declare type SchemaMetaFieldType = SchemaMetaFieldTypeSingle | SchemaMetaFieldTypeSingle[];
-export declare type ValidateFunction = (value: any, info?: Partial<CurrentNodeInfo>, ...args: any[]) => object | string | void | Promise<object | string | void>;
-export declare type CleanFunction = (value: any, info?: Partial<CurrentNodeInfo>, ...args: any[]) => any | Promise<any>;
+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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/schema",
-  "version": "3.2.53",
+  "version": "3.3.9",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -21,20 +21,15 @@
     "lodash": "^4.17.10"
   },
   "devDependencies": {
-    "@types/eslint": "^7.29.0",
-    "@types/jest": "27.0.2",
-    "@types/lodash": "4.14.176",
-    "@types/node": "16.11.7",
-    "@typescript-eslint/eslint-plugin": "5.3.1",
-    "@typescript-eslint/parser": "5.3.1",
-    "eslint": "8.2.0",
-    "eslint-plugin-import": "2.25.3",
+    "@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.4.4"
+    "typescript": "^4.6.3"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "4fea736e98ac00e92f0d0f0ff9ba26ffbc7ff6c7"
+  "gitHead": "c9591d61fe15eb98c6b6d5c3773afab11c412e42"
 }