@orion-js/graphql 3.11.8 → 4.0.0-alpha.2

package/dist/index.d.ts

@@ -0,0 +1,570 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { ApolloServerOptions } from '@apollo/server';
+import express from 'express';
+import * as GraphQL from 'graphql';
+import { PubSubEngine } from 'graphql-subscriptions';
+
+// 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 OrionSubscription<TParams = any, ReturnType = any> {
+	name: string;
+	params: object;
+	subscribe: (callParams: object, viewer: object) => {};
+	returns: ReturnType;
+	publish: (params: TParams, data: ReturnType) => Promise<void>;
+}
+export type CreateOrionSubscriptionFunction = <T = any, ReturnType = any>(options: OrionSubscriptionOptions) => OrionSubscription<T, ReturnType>;
+export interface OrionSubscriptionsMap {
+	[key: string]: OrionSubscription;
+}
+export interface OrionSubscriptionOptions extends Omit<ResolverOptions, "resolve"> {
+	name?: string;
+}
+declare const createSubscription: CreateOrionSubscriptionFunction;
+interface StoredCacheData$1 {
+	value: any;
+	expires?: Date;
+}
+interface SetCacheOptions$1 {
+	ttl?: number;
+}
+interface GetCacheOptions$1 {
+	ttl?: number;
+	fallback?(): Promise<any>;
+}
+interface OrionCache$1 {
+	/**
+	 * Save data in the cache
+	 */
+	set(key: string, value: any, options?: SetCacheOptions$1): Promise<void> | void;
+	/**
+	 * Get data from the cache
+	 */
+	get(key: string, options?: GetCacheOptions$1): Promise<StoredCacheData$1>;
+	/**
+	 * Removes data from the cache
+	 */
+	invalidate(key: string): Promise<void> | void;
+}
+type Blackbox$1 = {
+	[name: string]: any;
+};
+type GlobalResolverResolve$1 = (params: any, viewer: any, info?: any) => Promise<any>;
+type ModelResolverResolve$1 = (item: any, params: any, viewer: any, info?: any) => Promise<any>;
+type GlobalCheckPermissions$1 = (params: any, viewer: any, info?: any) => Promise<string | void>;
+type ModelCheckPermissions$1 = (parent: any, params: any, viewer: any, info?: any) => Promise<string | void>;
+type GlobalGetCacheKey$1 = (params: any, viewer: any, info: any) => Promise<any>;
+type ModelGetCacheKey$1 = (parent: any, params: any, viewer: any, info: any) => Promise<any>;
+interface ExecuteOptions$1 {
+	params: Blackbox$1;
+	viewer: any;
+	parent?: any;
+	info?: any;
+	options: ResolverOptions$1;
+}
+type Parameters$1$1<T> = T extends (...args: infer P) => any ? P : never;
+type ReturnType$1$1<T> = T extends (...args: any) => infer R ? R : any;
+type ResolverParams$1<Resolve, IsModel> = IsModel extends undefined ? Parameters$1$1<Resolve>[0] : Parameters$1$1<Resolve>[1];
+interface ExecuteParams$1<Resolve = Function, IsModel = undefined> {
+	params?: ResolverParams$1<Resolve, IsModel>;
+	viewer?: any;
+	parent?: IsModel extends undefined ? undefined : Parameters$1$1<Resolve>[0];
+	info?: any;
+}
+type Execute$1<Resolve = Function, IsModel = undefined> = (executeOptions: ExecuteParams$1<Resolve, IsModel>) => ReturnType$1$1<Resolve>;
+interface SharedResolverOptions$1 {
+	resolverId?: string;
+	params?: any;
+	returns?: any;
+	mutation?: boolean;
+	private?: boolean;
+	checkPermission?: GlobalCheckPermissions$1 | ModelCheckPermissions$1;
+	getCacheKey?: GlobalGetCacheKey$1 | ModelGetCacheKey$1;
+	cache?: number;
+	cacheProvider?: OrionCache$1;
+	permissionsOptions?: any;
+	middlewares?: ResolverMiddleware$1[];
+}
+interface ResolverOptions$1<Resolve = Function> extends SharedResolverOptions$1 {
+	resolve: Resolve;
+}
+type OmitFirstArg$1<F> = F extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
+interface Resolver$1<Resolve = Function, IsModel = undefined> extends SharedResolverOptions$1 {
+	execute: Execute$1<Resolve, IsModel>;
+	resolve: Resolve;
+	modelResolve: IsModel extends undefined ? undefined : OmitFirstArg$1<Resolve>;
+}
+type ModelResolver$1<Resolve = Function> = Resolver$1<Resolve, true>;
+type ResolverMiddleware$1 = (executeOptions: ExecuteOptions$1, 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 ModelResolversMap {
+	[key: string]: ModelResolver$1<ModelResolverResolve$1>;
+}
+export interface GlobalResolversMap {
+	[key: string]: Resolver$1<GlobalResolverResolve$1>;
+}
+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 ExecuteGraphQLCache = (req: express.Request, res: express.Response, viewer: object, executeQuery: () => Promise<string>) => Promise<string>;
+export interface ModelsResolversMap {
+	[key: string]: ModelResolversMap;
+}
+export type SchemaOmits = "schema" | "schemaHash" | "context" | "useGraphiql";
+export interface StartGraphQLOptions extends Omit<ApolloServerOptions<any>, SchemaOmits> {
+	/**
+	 * A map with all the global resolvers
+	 */
+	resolvers: GlobalResolversMap;
+	/**
+	 * A map with all the model resolvers. You must only add the models that you want to extend with resolvers.
+	 */
+	modelResolvers?: ModelsResolversMap;
+	/**
+	 * A Map with all global subscriptions
+	 */
+	subscriptions?: OrionSubscriptionsMap;
+	/**
+	 * A function that executes the http level cache of graphql queries
+	 */
+	/**
+	 * Should use GraphiQL. Default to true
+	 */
+	useGraphiql?: boolean;
+	/**
+	 * Pass another express app
+	 */
+	app?: express.Application;
+	/**
+	 * The pubsub provider to use. Default to the single server pubsub.
+	 * If you are using multiple servers you must pass a pubsub provider like RedisPubSub
+	 */
+	pubsub?: PubSubEngine;
+}
+declare function _default(options: StartGraphQLOptions): Promise<void>;
+declare function _default$1(apolloOptions: ApolloServerOptions<any>, options: StartGraphQLOptions): void;
+declare const _default$2: {
+	params: Resolver<({ mutation, name }: any, viewer: any) => Promise<{
+		resolver: Resolver$1<GlobalResolverResolve$1, undefined>;
+		name: any;
+	}>, undefined>;
+};
+declare const _default$3: Model<any>;
+interface FieldType$1 {
+	name: string;
+	validate: ValidateFunction$1;
+	clean: CleanFunction$1;
+	meta?: any;
+	toGraphQLType?: (GraphQL: any) => any;
+	_isFieldType: boolean;
+}
+type Constructor$1<T> = new (...args: any[]) => T;
+type FieldTypesList$1 = "string" | "date" | "integer" | "number" | "ID" | "boolean" | "email" | "blackbox" | "any";
+type TypedModelOnSchema$1 = Function;
+type ConstructorsTypesList$1 = Constructor$1<String> | Constructor$1<Number> | Constructor$1<Boolean> | Constructor$1<Date>;
+type SchemaRecursiveNodeTypeExtras$1 = {
+	_isFieldType?: boolean;
+	__clean?: CleanFunction$1;
+	__validate?: ValidateFunction$1;
+	__skipChildValidation?: (value: any, info: CurrentNodeInfo$1) => Promise<boolean>;
+};
+interface Schema$1 {
+	[key: string]: SchemaNode$1 | Function;
+}
+type SchemaRecursiveNodeType$1 = Schema$1 & SchemaRecursiveNodeTypeExtras$1;
+type SchemaMetaFieldTypeSingle$1 = FieldTypesList$1 | ConstructorsTypesList$1 | SchemaRecursiveNodeType$1 | FieldType$1 | TypedModelOnSchema$1;
+type SchemaMetaFieldType$1 = SchemaMetaFieldTypeSingle$1 | SchemaMetaFieldTypeSingle$1[];
+type ValidateFunction$1 = (value: any, info?: Partial<CurrentNodeInfo$1>, ...args: any[]) => object | string | void | Promise<object | string | void>;
+type CleanFunction$1 = (value: any, info?: Partial<CurrentNodeInfo$1>, ...args: any[]) => any | Promise<any>;
+interface SchemaNode$1 {
+	/**
+	 * The type of the field. Used for type validations. Can also contain a subschema.
+	 */
+	type: SchemaMetaFieldType$1;
+	/**
+	 * Defaults to false
+	 */
+	optional?: boolean;
+	allowedValues?: Array<any>;
+	defaultValue?: ((info: CurrentNodeInfo$1, ...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$1;
+	/**
+	 * Function that preprocesses a value before it is set.
+	 */
+	clean?: CleanFunction$1;
+	autoValue?: (value: any, info: CurrentNodeInfo$1, ...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$1;
+	/**
+	 * 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;
+}
+interface CurrentNodeInfoOptions$1 {
+	autoConvert?: boolean;
+	filter?: boolean;
+	trimStrings?: boolean;
+	removeEmptyStrings?: boolean;
+	forceDoc?: any;
+	omitRequired?: boolean;
+}
+interface CurrentNodeInfo$1 {
+	/**
+	 * The global schema, prefaced by {type: {...}} to be compatible with subschemas
+	 * Sometimes it's given without {type: {...}}. TODO: Normalize this.
+	 */
+	schema?: SchemaNode$1 | Schema$1;
+	/**
+	 * The current node subschema
+	 */
+	currentSchema?: Partial<SchemaNode$1>;
+	value: any;
+	doc?: any;
+	currentDoc?: any;
+	options?: CurrentNodeInfoOptions$1;
+	args?: any[];
+	type?: SchemaMetaFieldType$1;
+	keys?: string[];
+	addError?: (keys: string[], code: string | object) => void;
+}
+export function serializeSchema(params: any): Promise<Schema$1>;
+declare function getBasicQuery(field: any): Promise<any>;
+export declare function Resolvers(): ClassDecorator;
+export interface GlobalResolverPropertyDescriptor extends Omit<PropertyDecorator, "value"> {
+	value?: GlobalResolverResolve;
+}
+export declare function Query(options?: Omit<ResolverOptions<any>, "resolve" | "mutation">): (target: any, propertyKey: string, descriptor: GlobalResolverPropertyDescriptor) => void;
+export declare function Mutation(options?: Omit<ResolverOptions<any>, "resolve" | "mutation">): (target: any, propertyKey: string, descriptor: GlobalResolverPropertyDescriptor) => void;
+export declare function getServiceResolvers(target: any): {
+	[key: string]: Resolver<GlobalResolverResolve>;
+};
+export interface ModelResolverPropertyDescriptor extends Omit<PropertyDecorator, "value"> {
+	value?: ModelResolverResolve;
+}
+declare function ModelResolver$2(options?: Omit<ResolverOptions<any>, "resolve" | "middlewares">): (target: any, propertyKey: string, descriptor: ModelResolverPropertyDescriptor) => void;
+export interface ModelResolversOptions {
+	modelName?: string;
+}
+export declare function ModelResolvers(typedSchema: any, options?: ModelResolversOptions): ClassDecorator;
+export declare function getServiceModelResolvers(target: any): {
+	[key: string]: {
+		[key: string]: ModelResolver<GlobalResolverResolve>;
+	};
+};
+export declare function Subscriptions(): ClassDecorator;
+export declare function Subscription<T = any, ReturnType = any>(options: OrionSubscriptionOptions): (object: any, propertyName: string, index?: number) => void;
+export declare function getServiceSubscriptions(target: any): {
+	[key: string]: OrionSubscription;
+};
+export declare function getTargetMetadata(target: any, propertyKey: string, metadataKey: string): any;
+export declare const UseMiddleware: (metadata: ResolverMiddleware) => (target: any, propertyKey: string, descriptor: GlobalResolverPropertyDescriptor | ModelResolverPropertyDescriptor) => void;
+declare const ResolverParams$2: (metadata: any) => (target: any, propertyKey: string, descriptor: GlobalResolverPropertyDescriptor | ModelResolverPropertyDescriptor) => void;
+export declare const ResolverReturns: (metadata: any) => (target: any, propertyKey: string, descriptor: GlobalResolverPropertyDescriptor | ModelResolverPropertyDescriptor) => void;
+export declare const getWebsockerViewer: (connectionParams: any) => Promise<any>;
+export declare const setGetWebsockerViewer: (getViewerFunc: (connectionParams: any) => any) => void;
+
+export {
+	GraphQL,
+	ModelResolver$2 as ModelResolver,
+	ResolverParams$2 as ResolverParams,
+	_default as startGraphQL,
+	_default$1 as startGraphiQL,
+	_default$2 as resolversSchemas,
+	_default$3 as ResolverParamsInfo,
+	createSubscription as subscription,
+	getBasicQuery as getBasicResultQuery,
+};
+
+export {};