@orion-js/schema 4.0.0-next.7 → 4.0.1

package/dist/index.d.ts

@@ -1,20 +1,3 @@
-interface FieldTypeOpts<TType = any> {
-    name: string;
-    validate?: ValidateFunction<TType>;
-    clean?: CleanFunction<TType>;
-    toGraphQLType?: (GraphQL: any) => any;
-    meta?: any;
-}
-interface FieldType<TType = any> {
-    name: string;
-    validate: ValidateFunction;
-    clean: CleanFunction;
-    meta?: any;
-    toGraphQLType?: (GraphQL: any) => any;
-    __tsFieldType: TType;
-    __isFieldType: boolean;
-}
-
 type Constructor<T> = new (...args: any[]) => T;
 type Blackbox = {
     [name: string]: any;
@@ -23,8 +6,10 @@ type FieldTypesList = 'string' | 'date' | 'integer' | 'number' | 'ID' | 'boolean
 type AClass$1 = abstract new (...args: any) => any;
 type TypedSchemaOnSchema = AClass$1;
 type ConstructorsTypesList = Constructor<String> | Constructor<Number> | Constructor<Boolean> | Constructor<Date> | StringConstructor | NumberConstructor | BooleanConstructor | DateConstructor | String | Number | Boolean | Date;
-type SchemaMetaFieldTypeSingle = FieldTypesList | ConstructorsTypesList | Schema | FieldType | TypedSchemaOnSchema;
+type SchemaMetaFieldTypeSingleNonSchema = FieldTypesList | ConstructorsTypesList | FieldType;
+type SchemaMetaFieldTypeSingle = SchemaMetaFieldTypeSingleNonSchema | Schema | TypedSchemaOnSchema;
 type SchemaFieldType = SchemaMetaFieldTypeSingle | SchemaMetaFieldTypeSingle[];
+type SchemaFieldTypeNonSchema = SchemaMetaFieldTypeSingleNonSchema | SchemaMetaFieldTypeSingleNonSchema[];
 type ValidateFunction<TType = any> = (value: TType, info?: Partial<CurrentNodeInfo>, ...args: any[]) => object | string | null | undefined | void | Promise<object | string | null | undefined | void>;
 type CleanFunction<TType = any> = (value: TType, info?: Partial<CurrentNodeInfo>, ...args: any[]) => TType | Promise<TType>;
 type SchemaRecursiveNodeTypeExtras = {
@@ -104,22 +89,22 @@ interface CurrentNodeInfoOptions {
     forceDoc?: any;
     omitRequired?: boolean;
 }
-interface CurrentNodeInfo<TType extends SchemaFieldType = any> {
+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;
+    schema?: SchemaFieldType;
     /**
      * The current node subschema
      */
-    currentSchema?: Partial<SchemaNode<TType>>;
-    value: TType;
+    currentSchema?: Partial<SchemaNode<SchemaFieldType>>;
+    value: InferSchemaType<SchemaFieldType>;
     doc?: any;
     currentDoc?: any;
     options?: CurrentNodeInfoOptions;
     args?: any[];
-    type?: TType;
+    type?: SchemaFieldType;
     keys?: string[];
     addError?: (keys: string[], code: string | object) => void;
 }
@@ -140,41 +125,70 @@ type SchemaMetadata = {
 type Schema = {
     [K: string]: SchemaNode;
 };
+type SingleLevelSchema = {
+    [K: string]: SchemaNode<SchemaFieldTypeNonSchema>;
+};
+type SchemaInAnyOrionForm = Schema | TypedSchemaOnSchema;
 type SchemaWithMetadata = {
     [K: string]: SchemaNode | SchemaMetadata[keyof SchemaMetadata];
 } & SchemaMetadata;
 
+interface FieldTypeOpts<TType = any> {
+    name: string;
+    validate?: ValidateFunction<TType>;
+    clean?: CleanFunction<TType>;
+    toGraphQLType?: (GraphQL: any) => any;
+    meta?: any;
+}
+interface FieldType<TType = any> {
+    name: string;
+    validate: ValidateFunction;
+    clean: CleanFunction;
+    meta?: any;
+    toGraphQLType?: (GraphQL: any) => any;
+    __tsFieldType: TType;
+    __isFieldType: boolean;
+}
+
 type InferSchemaTypeForFieldType<T> = T extends {
     __tsFieldType: infer U;
 } ? U : T extends 'string' ? string : T extends 'date' ? Date : T extends 'integer' ? number : T extends 'number' ? number : T extends 'ID' ? string : T extends 'boolean' ? boolean : T extends 'email' ? string : T extends 'blackbox' ? Blackbox : T extends 'any' ? any : T extends String ? string : T extends Number ? number : T extends Boolean ? boolean : T extends Date ? Date : T extends StringConstructor ? string : T extends NumberConstructor ? number : T extends BooleanConstructor ? boolean : T extends DateConstructor ? Date : T extends Array<infer U> ? InferSchemaTypeForFieldType<U>[] : T extends Record<string, any> ? InferSchemaTypeForSchema<T> : T;
-type SchemaKeysNotOfSchemaItems = keyof SchemaRecursiveNodeTypeExtras;
+type SchemaKeysNotOfSchemaItems = '__isFieldType' | '__GraphQLType' | '__skipChildValidation';
 type NodeIsOptional<TNode> = TNode extends {
     optional: true;
-} ? true : TNode extends {
-    defaultValue: any;
 } ? true : false;
-type InferSchemaTypeForSchema<TSchema extends Record<string, any>> = Omit<{
-    -readonly [K in keyof TSchema as NodeIsOptional<TSchema[K]> extends true ? never : K]: InferSchemaTypeForFieldType<TSchema[K]['type']>;
+type Simplifed<T> = {
+    [K in keyof T]: T[K] extends object ? Simplifed<T[K]> : T[K];
+};
+type WithoutNotSchemaItems<T extends Record<string, any>> = T extends {
+    [key in SchemaKeysNotOfSchemaItems]: any;
+} & Record<string, any> ? Omit<T, SchemaKeysNotOfSchemaItems> : T;
+type InferSchemaTypeForSchema<TSchema extends Record<string, any>> = Simplifed<WithoutNotSchemaItems<{
+    -readonly [K in keyof TSchema as NodeIsOptional<TSchema[K]> extends true ? never : K]: InferSchemaType<TSchema[K]['type']>;
 } & {
-    -readonly [K in keyof TSchema as NodeIsOptional<TSchema[K]> extends true ? K : never]?: InferSchemaTypeForFieldType<TSchema[K]['type']>;
-}, SchemaKeysNotOfSchemaItems>;
-type IsPossiblyASchema<TType> = TType extends Record<string, any> ? keyof {
+    -readonly [K in keyof TSchema as NodeIsOptional<TSchema[K]> extends true ? K : never]?: InferSchemaType<TSchema[K]['type']>;
+}>>;
+type IsPossiblyASchema<TType> = TType extends FieldType ? false : TType extends Record<string, any> ? keyof {
     [K in keyof TType as 'type' extends keyof TType[K] ? K : never]: TType[K];
 } extends never ? false : true : false;
-type AClass = abstract new (...args: any) => any;
+type AClass<T = any> = abstract new (...args: any) => T;
 /**
  * Returns the type of the schema
  */
 type InferSchemaType<TType> = TType extends {
     __isModel: true;
     type: infer U;
-} ? InferSchemaTypeForSchema<U> : TType extends AClass ? InstanceType<TType> : IsPossiblyASchema<TType> extends true ? InferSchemaTypeForSchema<TType> : InferSchemaTypeForFieldType<TType>;
+} ? InferSchemaTypeForSchema<U> : TType extends SchemaMetaFieldTypeSingleNonSchema ? InferSchemaTypeForFieldType<TType> : TType extends AClass<infer U> ? U : IsPossiblyASchema<TType> extends true ? InferSchemaTypeForSchema<TType> : InferSchemaTypeForFieldType<TType>;
 /**
  * Returns the type of the schema but only if its a schema
  */
 type StrictInferSchemaType<TSchema extends Schema> = InferSchemaTypeForSchema<TSchema>;
+/**
+ * Returns the type of the schema but only if its a schema
+ */
+type InferSchemaTypeFromTypedSchema<TTypedSchema extends TypedSchemaOnSchema> = TTypedSchema;
 
-declare function validate<TSchema extends Schema = Schema>(schema: TSchema | Function, doc: InferSchemaType<TSchema>, passedOptions?: {}, ...args: any[]): Promise<void>;
+declare function validate<TSchema extends SchemaFieldType>(schema: TSchema, doc: InferSchemaType<TSchema>, passedOptions?: {}, ...args: any[]): Promise<void>;
 
 interface ValidationErrorInfo {
     error: string;
@@ -191,10 +205,6 @@ declare class ValidationError extends Error {
     prependKey: (prepend: any) => ValidationError;
 }
 
-declare function getValidationErrors(schema: Schema | Function, doc: any, passedOptions?: {}, ...args: any[]): Promise<any>;
-
-declare function isValid(schema: Schema, doc: any, passedOptions?: {}, ...args: any[]): Promise<boolean>;
-
 declare const _default: {
     array: FieldType<any[]>;
     plainObject: FieldType<Blackbox>;
@@ -211,11 +221,15 @@ declare const _default: {
 
 type FieldValidatorType = keyof typeof _default | 'custom' | 'plainObject';
 
-declare function getFieldType(type: SchemaFieldType | FieldValidatorType | any): FieldType;
-
 type MergeSchemas<SchemaA extends Schema, SchemaB extends Schema> = SchemaA & SchemaB;
 
-declare function clean<TSchema extends Schema = Schema>(schema: TSchema | Function, doc: InferSchemaType<TSchema>, opts?: CurrentNodeInfoOptions, ...args: any[]): Promise<InferSchemaType<TSchema>>;
+declare function getValidationErrors<TSchema extends SchemaFieldType>(schema: TSchema, doc: InferSchemaType<TSchema>, passedOptions?: {}, ...args: any[]): Promise<any>;
+
+declare function isValid<TSchema extends Schema>(schema: TSchema, doc: InferSchemaType<TSchema>, passedOptions?: {}, ...args: any[]): Promise<boolean>;
+
+declare function getFieldType(type: SchemaFieldType | FieldValidatorType | any): FieldType;
+
+declare function clean<TSchema extends SchemaFieldType>(schema: TSchema, doc: InferSchemaType<TSchema>, opts?: CurrentNodeInfoOptions, ...args: any[]): Promise<InferSchemaType<TSchema>>;
 
 declare function export_default$2(schema: any, key: any, value: any, passedOptions?: {}, ...args: any[]): Promise<any>;
 
@@ -223,16 +237,17 @@ declare function export_default$1(schema: Schema, key: string, value: any, passe
 
 declare function export_default(schema: Schema, path: string): SchemaNode;
 
-declare function createEnum<const TValues extends readonly string[]>(name: string, values: TValues): FieldType<TValues[number]> & {
-    type: TValues[number];
-};
+declare function createEnum<const TValues extends readonly string[]>(name: string, values: TValues): FieldType<TValues[number]>;
 
 declare function isSchemaLike(type: any): boolean;
+declare function isStrictSchemaLike<TType extends Schema | SchemaFieldTypeNonSchema>(type: TType): TType extends Schema ? true : false;
 declare function isSchemaOrFieldLike(type: any): boolean;
 declare function getSchemaModelName(type: any): string | null;
-declare function getSchemaFromAnyOrionForm(type: any): Schema;
+declare function getSchemaFromAnyOrionForm(type: any): SchemaFieldType;
 declare function getSchemaWithMetadataFromAnyOrionForm(type: any): SchemaWithMetadata;
 
+declare function cleanAndValidate<TSchema extends SchemaFieldType>(schema: TSchema, doc: InferSchemaType<TSchema>): Promise<InferSchemaType<TSchema>>;
+
 /**
  * Assigns a name to a schema for GraphQL type generation.
  *
@@ -248,4 +263,4 @@ declare function getSchemaWithMetadataFromAnyOrionForm(type: any): SchemaWithMet
  */
 declare function schemaWithName<TModelName extends string, TSchema extends Schema>(name: TModelName, schema: TSchema): TSchema;
 
-export { type Blackbox, type CleanFunction, type Constructor, type ConstructorsTypesList, type CurrentNodeInfo, type CurrentNodeInfoOptions, type FieldType, type FieldTypeOpts, type FieldTypesList, type FieldValidatorType, type InferSchemaType, type MergeSchemas, type Schema, type SchemaFieldType, type SchemaMetaFieldTypeSingle, type SchemaMetadata, type SchemaNode, type SchemaRecursiveNodeTypeExtras, type SchemaWithMetadata, type StrictInferSchemaType, type TypedSchemaOnSchema, type ValidateFunction, ValidationError, clean, export_default$2 as cleanKey, createEnum, export_default as dotGetSchema, _default as fieldTypes, getFieldType, getSchemaFromAnyOrionForm, getSchemaModelName, getSchemaWithMetadataFromAnyOrionForm, getValidationErrors, isSchemaLike, isSchemaOrFieldLike, isValid, schemaWithName, validate, export_default$1 as validateKey };
+export { type Blackbox, type CleanFunction, type Constructor, type ConstructorsTypesList, type CurrentNodeInfo, type CurrentNodeInfoOptions, type FieldType, type FieldTypeOpts, type FieldTypesList, type FieldValidatorType, type InferSchemaType, type InferSchemaTypeFromTypedSchema, type MergeSchemas, type Schema, type SchemaFieldType, type SchemaFieldTypeNonSchema, type SchemaInAnyOrionForm, type SchemaMetaFieldTypeSingle, type SchemaMetaFieldTypeSingleNonSchema, type SchemaMetadata, type SchemaNode, type SchemaRecursiveNodeTypeExtras, type SchemaWithMetadata, type Simplifed, type SingleLevelSchema, type StrictInferSchemaType, type TypedSchemaOnSchema, type ValidateFunction, ValidationError, clean, cleanAndValidate, export_default$2 as cleanKey, createEnum, export_default as dotGetSchema, _default as fieldTypes, getFieldType, getSchemaFromAnyOrionForm, getSchemaModelName, getSchemaWithMetadataFromAnyOrionForm, getValidationErrors, isSchemaLike, isSchemaOrFieldLike, isStrictSchemaLike, isValid, schemaWithName, validate, export_default$1 as validateKey };