@orion-js/schema 4.3.1 → 4.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+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/dist/Errors.d.ts

@@ -0,0 +1,21 @@
+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/dist/ValidationError.d.ts

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

package/dist/clean/cleanType.d.ts

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

package/dist/clean/getObjectNode.d.ts

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

package/dist/clean/index.d.ts

@@ -0,0 +1,3 @@
+import { InferSchemaType } from '../types';
+import { CurrentNodeInfoOptions, SchemaFieldType } from '../types/schema';
+export default function clean<TSchema extends SchemaFieldType>(schema: TSchema, doc: InferSchemaType<TSchema>, opts?: CurrentNodeInfoOptions, ...args: any[]): Promise<InferSchemaType<TSchema>>;

package/dist/clean/recursiveClean.d.ts

@@ -0,0 +1,3 @@
+import { CurrentNodeInfo } from '../types/schema';
+declare const clean: (info: CurrentNodeInfo) => Promise<any>;
+export default clean;

package/dist/cleanAndValidate.d.ts

@@ -0,0 +1,2 @@
+import { InferSchemaType, SchemaFieldType } from './types';
+export declare function cleanAndValidate<TSchema extends SchemaFieldType>(schema: TSchema, doc: InferSchemaType<TSchema>): Promise<InferSchemaType<TSchema>>;

package/dist/cleanKey.d.ts

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

package/dist/clone.d.ts

@@ -0,0 +1 @@
+export declare function clone<T>(value: T): T;

package/dist/cloneSchema.d.ts

@@ -0,0 +1,35 @@
+import { Schema, SchemaNode } from './types';
+export type CloneSchemaOptions<TSchema extends Schema, TExtendFields extends Schema | undefined = undefined, TPickFields extends (keyof TSchema)[] | undefined = undefined, TOmitFields extends (keyof TSchema)[] | undefined = undefined> = {
+    /**
+     * The schema to clone
+     */
+    schema: TSchema;
+    /**
+     * The name of the cloned schema
+     */
+    name?: string;
+    /**
+     * The schema to extend the cloned schema with
+     */
+    extendSchema?: TExtendFields;
+    /**
+     * A function to map the fields of the cloned schema.
+     * Warning: This function will not be applied to the typescript types of this schema.
+     */
+    mapFields?: (field: TSchema[keyof TSchema], key: keyof TSchema) => SchemaNode;
+    /**
+     * The fields to pick from the cloned schema
+     */
+    pickFields?: TPickFields;
+    /**
+     * The fields to omit from the cloned schema
+     */
+    omitFields?: TOmitFields;
+};
+type ExtendFields<TSchema extends Schema, TExtendFields extends Schema | undefined> = TExtendFields extends undefined ? TSchema : {
+    [key in keyof (TSchema & TExtendFields)]: key extends keyof TExtendFields ? TExtendFields[key] : key extends keyof TSchema ? TSchema[key] : never;
+};
+type PickOrOmit<TSchema extends Schema, TPickFields extends (keyof TSchema)[] | undefined = undefined, TOmitFields extends (keyof TSchema)[] | undefined = undefined> = TPickFields extends undefined ? TOmitFields extends undefined ? TSchema : Omit<TSchema, TOmitFields[number]> : Pick<TSchema, TPickFields[number]>;
+export type ClonedSchema<TSchema extends Schema, TExtendFields extends Schema | undefined = undefined, TPickFields extends (keyof TSchema)[] | undefined = undefined, TOmitFields extends (keyof TSchema)[] | undefined = undefined> = ExtendFields<PickOrOmit<TSchema, TPickFields, TOmitFields>, TExtendFields>;
+export declare function cloneSchema<TSchema extends Schema, TExtendFields extends Schema | undefined = undefined, TPickFields extends (keyof TSchema)[] | undefined = undefined, TOmitFields extends (keyof TSchema)[] | undefined = undefined>(options: CloneSchemaOptions<TSchema, TExtendFields, TPickFields, TOmitFields>): ClonedSchema<TSchema, TExtendFields, TPickFields, TOmitFields>;
+export {};

package/dist/dotGetSchema.d.ts

@@ -0,0 +1,2 @@
+import dotGetSchema from './validateKey/dotGetSchema';
+export default dotGetSchema;

package/dist/fieldType.d.ts

@@ -0,0 +1,19 @@
+import { CleanFunction, SchemaFieldType, SchemaNode, ValidateFunction } from './types/schema';
+export interface FieldTypeOpts<TType = any> {
+    name: string;
+    validate?: ValidateFunction<TType>;
+    clean?: CleanFunction<TType>;
+    toGraphQLType?: (GraphQL: any) => any;
+    meta?: any;
+}
+export interface FieldType<TType = any> {
+    name: string;
+    validate: ValidateFunction;
+    clean: CleanFunction;
+    meta?: any;
+    toGraphQLType?: (GraphQL: any) => any;
+    toSerializedType?: (node: SchemaNode) => Promise<SchemaFieldType>;
+    __tsFieldType: TType;
+    __isFieldType: boolean;
+}
+export default function fieldType<TType>(opts: FieldTypeOpts<TType>): FieldType<TType>;

package/dist/fieldTypes/ID.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("..").FieldType<string>;
+export default _default;

package/dist/fieldTypes/any.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("..").FieldType<any>;
+export default _default;

package/dist/fieldTypes/array.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("..").FieldType<any[]>;
+export default _default;

package/dist/fieldTypes/blackbox.d.ts

@@ -0,0 +1,3 @@
+import { Blackbox } from '../types';
+declare const _default: import("..").FieldType<Blackbox>;
+export default _default;

package/dist/fieldTypes/boolean.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("..").FieldType<boolean>;
+export default _default;

package/dist/fieldTypes/date.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("..").FieldType<Date>;
+export default _default;

package/dist/fieldTypes/email.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("..").FieldType<string>;
+export default _default;

package/dist/fieldTypes/enum.d.ts

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

package/dist/fieldTypes/index.d.ts

@@ -0,0 +1,14 @@
+declare const _default: {
+    array: import("..").FieldType<any[]>;
+    plainObject: import("..").FieldType<import("..").Blackbox>;
+    string: import("..").FieldType<string>;
+    date: import("..").FieldType<Date>;
+    integer: import("..").FieldType<number>;
+    number: import("..").FieldType<number>;
+    ID: import("..").FieldType<string>;
+    boolean: import("..").FieldType<boolean>;
+    email: import("..").FieldType<string>;
+    blackbox: import("..").FieldType<import("..").Blackbox>;
+    any: import("..").FieldType<any>;
+};
+export default _default;

package/dist/fieldTypes/integer.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("..").FieldType<number>;
+export default _default;

package/dist/fieldTypes/number.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("..").FieldType<number>;
+export default _default;

package/dist/fieldTypes/plainObject.d.ts

@@ -0,0 +1,3 @@
+import { Blackbox } from '../types';
+declare const _default: import("..").FieldType<Blackbox>;
+export default _default;

package/dist/fieldTypes/string.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("..").FieldType<string>;
+export default _default;

package/dist/getValidationErrors/convertTypedSchema.d.ts

@@ -0,0 +1,2 @@
+import { CurrentNodeInfo } from '../types/schema';
+export declare const convertTypedSchema: (info: CurrentNodeInfo) => void;

package/dist/getValidationErrors/doValidation.d.ts

@@ -0,0 +1,2 @@
+import { CurrentNodeInfo } from '../types/schema';
+export default function doValidation(params: CurrentNodeInfo): Promise<void>;

package/dist/getValidationErrors/getError/getFieldType.d.ts

@@ -0,0 +1,4 @@
+import { SchemaFieldType } from '../../types/schema';
+import { FieldValidatorType } from '../../types/fieldValidators';
+import { FieldType } from '../../fieldType';
+export default function getFieldType(type: SchemaFieldType | FieldValidatorType | any): FieldType;

package/dist/getValidationErrors/getError/getFieldValidator.d.ts

@@ -0,0 +1,3 @@
+import { FieldValidatorType } from '../../types/fieldValidators';
+import { SchemaFieldType } from '../../types';
+export default function getFieldValidator(type: SchemaFieldType): FieldValidatorType;

package/dist/getValidationErrors/getError/index.d.ts

@@ -0,0 +1,2 @@
+import { CurrentNodeInfo } from '../../types/schema';
+export default function getValidationErrors(params: CurrentNodeInfo): Promise<object | string | void>;

package/dist/getValidationErrors/getFieldLabels.d.ts

@@ -0,0 +1,6 @@
+import { SchemaFieldType } from '../types/schema';
+/**
+ * Extracts field labels from a schema, creating a flat object with dot-notation keys
+ * matching the validation error keys and their corresponding labels.
+ */
+export default function getFieldLabels(schema: SchemaFieldType, currentKey?: string): Record<string, string>;

package/dist/getValidationErrors/getValidationErrorsObject.d.ts

@@ -0,0 +1,4 @@
+export default function getValidationErrorsObject(validationErrors: {
+    key: string;
+    code: string;
+}[]): any;

package/dist/getValidationErrors/index.d.ts

@@ -0,0 +1,3 @@
+import { InferSchemaType } from '../types';
+import { SchemaFieldType } from '../types/schema';
+export default function getValidationErrors<TSchema extends SchemaFieldType>(schema: TSchema, doc: InferSchemaType<TSchema>, passedOptions?: {}, ...args: any[]): Promise<any>;

package/dist/index.cjs

@@ -915,7 +915,8 @@ function getArrayNode(schema2, value) {
 var clean = async (info) => {
   convertTypedSchema(info);
   const { schema: schema2, args = [], value } = info;
-  const currSchema = schema2.type === void 0 ? { type: schema2 } : schema2;
+  const schemaValue = schema2;
+  const currSchema = typeof schemaValue === "object" && schemaValue !== null && "type" in schemaValue ? schemaValue : { type: schemaValue };
   const objectSchema = getObjectNode(currSchema, value);
   if (objectSchema) {
     const newDoc = await cleanObjectFields({