@orion-js/schema 3.11.8 → 4.0.0-alpha.3

package/dist/index.d.ts

@@ -0,0 +1,185 @@
+// Generated by dts-bundle-generator v9.5.1
+
+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 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;
+}
+export function validate(schema: Schema | Function, doc: any, passedOptions?: {}, ...args: any[]): Promise<void>;
+export interface ValidationErrorInfo {
+	error: string;
+	message: string;
+	validationErrors: object;
+}
+export declare class ValidationError extends Error {
+	code: string;
+	isValidationError: boolean;
+	isOrionError: boolean;
+	validationErrors: object;
+	constructor(validationErrors: object);
+	getInfo: () => ValidationErrorInfo;
+	prependKey: (prepend: any) => ValidationError;
+}
+export function getValidationErrors(schema: Schema | Function, doc: any, passedOptions?: {}, ...args: any[]): Promise<any>;
+export function isValid(schema: Schema, doc: any, passedOptions?: {}, ...args: any[]): Promise<boolean>;
+declare const _default: {
+	array: FieldType;
+	plainObject: FieldType;
+	string: FieldType;
+	date: FieldType;
+	integer: FieldType;
+	number: FieldType;
+	ID: FieldType;
+	boolean: FieldType;
+	email: FieldType;
+	blackbox: FieldType;
+	any: FieldType;
+};
+export type FieldValidatorType = keyof typeof _default | "custom" | "plainObject";
+export function getFieldType(type: SchemaMetaFieldType | FieldValidatorType | any): FieldType;
+export function clean<TDoc = Blackbox>(schema: Schema | Function, doc: TDoc, opts?: CurrentNodeInfoOptions, ...args: any[]): Promise<TDoc>;
+declare function _default$1(schema: any, key: any, value: any, passedOptions?: {}, ...args: any[]): Promise<any>;
+declare function _default$2(schema: Schema, key: string, value: any, passedOptions?: CurrentNodeInfoOptions, ...args: any[]): Promise<any>;
+declare function _default$3(schema: Schema, path: string): SchemaNode | {
+	type: string;
+	optional: boolean;
+	isBlackboxChild: boolean;
+};
+export function createEnum<TValues extends readonly string[]>(name: string, values: TValues): FieldType & {
+	type: TValues[number];
+};
+
+export {
+	_default$1 as cleanKey,
+	_default$2 as validateKey,
+	_default$3 as dotGetSchema,
+};
+
+export {};