@orion-js/models 4.0.0-alpha.3 → 4.0.0-next.2

package/dist/index.d.ts

@@ -1,309 +1,111 @@
-// Generated by dts-bundle-generator v9.5.1
+import { ModelResolver, ModelResolverResolve, Resolver, GlobalResolverResolve } from '@orion-js/resolvers';
+import { SchemaNode, Schema, SchemaMetaFieldType } from '@orion-js/schema';
 
-// Generated by dts-bundle-generator v9.5.1
-// Generated by dts-bundle-generator v9.5.1
-export interface StoredCacheData {
-	value: any;
-	expires?: Date;
-}
-export interface SetCacheOptions {
-	ttl?: number;
-}
-export interface GetCacheOptions {
-	ttl?: number;
-	fallback?(): Promise<any>;
-}
-export interface OrionCache {
-	/**
-	 * Save data in the cache
-	 */
-	set(key: string, value: any, options?: SetCacheOptions): Promise<void> | void;
-	/**
-	 * Get data from the cache
-	 */
-	get(key: string, options?: GetCacheOptions): Promise<StoredCacheData>;
-	/**
-	 * Removes data from the cache
-	 */
-	invalidate(key: string): Promise<void> | void;
-}
-export type Blackbox = {
-	[name: string]: any;
-};
-export type GlobalResolverResolve = (params: any, viewer: any, info?: any) => Promise<any>;
-export type ModelResolverResolve = (item: any, params: any, viewer: any, info?: any) => Promise<any>;
-export type GlobalCheckPermissions = (params: any, viewer: any, info?: any) => Promise<string | void>;
-export type ModelCheckPermissions = (parent: any, params: any, viewer: any, info?: any) => Promise<string | void>;
-export type GlobalGetCacheKey = (params: any, viewer: any, info: any) => Promise<any>;
-export type ModelGetCacheKey = (parent: any, params: any, viewer: any, info: any) => Promise<any>;
-export interface ExecuteOptions {
-	params: Blackbox;
-	viewer: any;
-	parent?: any;
-	info?: any;
-	options: ResolverOptions;
-}
-export type Parameters$1<T> = T extends (...args: infer P) => any ? P : never;
-export type ReturnType$1<T> = T extends (...args: any) => infer R ? R : any;
-export type ResolverParams<Resolve, IsModel> = IsModel extends undefined ? Parameters$1<Resolve>[0] : Parameters$1<Resolve>[1];
-export interface ExecuteParams<Resolve = Function, IsModel = undefined> {
-	params?: ResolverParams<Resolve, IsModel>;
-	viewer?: any;
-	parent?: IsModel extends undefined ? undefined : Parameters$1<Resolve>[0];
-	info?: any;
-}
-export type Execute<Resolve = Function, IsModel = undefined> = (executeOptions: ExecuteParams<Resolve, IsModel>) => ReturnType$1<Resolve>;
-export interface SharedResolverOptions {
-	resolverId?: string;
-	params?: any;
-	returns?: any;
-	mutation?: boolean;
-	private?: boolean;
-	checkPermission?: GlobalCheckPermissions | ModelCheckPermissions;
-	getCacheKey?: GlobalGetCacheKey | ModelGetCacheKey;
-	cache?: number;
-	cacheProvider?: OrionCache;
-	permissionsOptions?: any;
-	middlewares?: ResolverMiddleware[];
-}
-export interface ResolverOptions<Resolve = Function> extends SharedResolverOptions {
-	resolve: Resolve;
-}
-export type OmitFirstArg<F> = F extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
-export interface Resolver<Resolve = Function, IsModel = undefined> extends SharedResolverOptions {
-	execute: Execute<Resolve, IsModel>;
-	resolve: Resolve;
-	modelResolve: IsModel extends undefined ? undefined : OmitFirstArg<Resolve>;
-}
-export type ModelResolver<Resolve = Function> = Resolver<Resolve, true>;
-export type ResolverMiddleware = (executeOptions: ExecuteOptions, next: () => Promise<any>) => Promise<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 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 interface ModelsSchemaNode extends Omit<SchemaNode, "type"> {
-	type: Model | [
-		Model
-	] | SchemaMetaFieldType;
-}
-export interface ModelSchema {
-	[key: string]: ModelsSchemaNode;
-}
-export interface CreateModelOptions {
-	/**
-	 * The name of the model, used for example for GraphQL
-	 */
-	name: string;
-	/**
-	 * Pass a function that returns the schema. For example: () => require('./schema').
-	 * This is used like this to allow circular dependencies
-	 */
-	schema?: ModelSchema | (() => {
-		default: ModelSchema;
-	});
-	/**
-	 * Pass a function that returns the resolvers. For example: () => require('./resolvers')
-	 * This is used like this to allow circular dependencies
-	 */
-	resolvers?: ModelResolversMap | (() => {
-		default: ModelResolversMap;
-	});
-	/**
-	 * Optional function that will process the document before being returned.
-	 * @param doc The current document
-	 * @return The processed document promise
-	 */
-	clean?: (doc: any) => Promise<any> | any;
-	/**
-	 * Optional function that will validate the document before being returned.
-	 * @param doc The current document
-	 */
-	validate?: (doc: any) => Promise<void> | void;
-}
-export interface ModelResolversMap {
-	[key: string]: ModelResolver<ModelResolverResolve>;
-}
-export interface GlobalResolversMap {
-	[key: string]: Resolver<GlobalResolverResolve>;
-}
-export interface CloneOptions {
-	name: string;
-	omitFields?: string[];
-	pickFields?: string[];
-	mapFields?: (field: any, key: string) => any;
-	extendSchema?: Schema;
-	extendResolvers?: ModelResolversMap;
-}
-export interface Model<TSchema = any> {
-	__isModel: boolean;
-	/**
-	 * The name of the model, used for example for GraphQL
-	 */
-	name: string;
-	/**
-	 * Returns the schema of the model
-	 */
-	getSchema: () => Schema & {
-		__model: Model;
-	};
-	/**
-	 * Returns the schema without adding __model to the schema
-	 */
-	getCleanSchema: () => Schema;
-	/**
-	 * Returns the model resolvers
-	 */
-	getResolvers: () => ModelResolversMap;
-	/**
-	 * Adds the model resolvers to a item
-	 */
-	initItem: (item: any) => any;
-	/**
-	 * Validates an item using @orion-js/schema
-	 */
-	validate: (item: any) => Promise<any>;
-	/**
-	 * Cleans an item using @orion-js/schema
-	 */
-	clean: (item: any) => Promise<TSchema>;
-	/**
-	 * Cleans and validates an item using @orion-js/schema
-	 */
-	cleanAndValidate: (item: any) => Promise<TSchema>;
-	/**
-	 * Creates a new model using this one as a base
-	 */
-	clone: (cloneOptions: CloneOptions) => Model;
-	/**
-	 * The type of the model. Only use this in typescript
-	 */
-	type: TSchema;
-}
-export type CreateModel<TSchema = any> = (options: CreateModelOptions) => Model<TSchema>;
-export function createModel<TSchema = any>(modelOptions: CreateModelOptions): Model<TSchema>;
-export declare function modelToSchema(modelSchema: ModelSchema, { cleanSchema }?: {
-	cleanSchema?: boolean;
+interface ModelsSchemaNode extends Omit<SchemaNode, 'type'> {
+    type: Model | [Model] | SchemaMetaFieldType;
+}
+interface ModelSchema {
+    [key: string]: ModelsSchemaNode;
+}
+interface CreateModelOptions {
+    /**
+     * The name of the model, used for example for GraphQL
+     */
+    name: string;
+    /**
+     * Pass a function that returns the schema. For example: () => require('./schema').
+     * This is used like this to allow circular dependencies
+     */
+    schema?: ModelSchema | (() => {
+        default: ModelSchema;
+    });
+    /**
+     * Pass a function that returns the resolvers. For example: () => require('./resolvers')
+     * This is used like this to allow circular dependencies
+     */
+    resolvers?: ModelResolversMap | (() => {
+        default: ModelResolversMap;
+    });
+    /**
+     * Optional function that will process the document before being returned.
+     * @param doc The current document
+     * @return The processed document promise
+     */
+    clean?: (doc: any) => Promise<any> | any;
+    /**
+     * Optional function that will validate the document before being returned.
+     * @param doc The current document
+     */
+    validate?: (doc: any) => Promise<void> | void;
+}
+interface ModelResolversMap {
+    [key: string]: ModelResolver<ModelResolverResolve>;
+}
+interface GlobalResolversMap {
+    [key: string]: Resolver<GlobalResolverResolve>;
+}
+interface CloneOptions {
+    name: string;
+    omitFields?: string[];
+    pickFields?: string[];
+    mapFields?: (field: any, key: string) => any;
+    extendSchema?: Schema;
+    extendResolvers?: ModelResolversMap;
+}
+interface Model<TSchema = any> {
+    __isModel: boolean;
+    /**
+     * The name of the model, used for example for GraphQL
+     */
+    name: string;
+    /**
+     * Returns the schema of the model
+     */
+    getSchema: () => Schema & {
+        __model: Model;
+    };
+    /**
+     * Returns the schema without adding __model to the schema
+     */
+    getCleanSchema: () => Schema;
+    /**
+     * Returns the model resolvers
+     */
+    getResolvers: () => ModelResolversMap;
+    /**
+     * Adds the model resolvers to a item
+     */
+    initItem: (item: any) => any;
+    /**
+     * Validates an item using @orion-js/schema
+     */
+    validate: (item: any) => Promise<any>;
+    /**
+     * Cleans an item using @orion-js/schema
+     */
+    clean: (item: any) => Promise<TSchema>;
+    /**
+     * Cleans and validates an item using @orion-js/schema
+     */
+    cleanAndValidate: (item: any) => Promise<TSchema>;
+    /**
+     * Creates a new model using this one as a base
+     */
+    clone: (cloneOptions: CloneOptions) => Model;
+    /**
+     * The type of the model. Only use this in typescript
+     */
+    type: TSchema;
+}
+type CreateModel<TSchema = any> = (options: CreateModelOptions) => Model<TSchema>;
+
+declare function createModel<TSchema = any>(modelOptions: CreateModelOptions): Model<TSchema>;
+
+declare function modelToSchema(modelSchema: ModelSchema, { cleanSchema }?: {
+    cleanSchema?: boolean;
 }): Schema;
-export declare function modelToSchemaWithModel(modelSchema: ModelSchema, model?: Model): Schema | {
-	__model: Model<any>;
+declare function modelToSchemaWithModel(modelSchema: ModelSchema, model?: Model): Schema | {
+    __model: Model<any>;
 };
 
-export {};
+export { type CloneOptions, type CreateModel, type CreateModelOptions, type GlobalResolversMap, type Model, type ModelResolversMap, type ModelSchema, type ModelsSchemaNode, createModel, modelToSchema, modelToSchemaWithModel };