@orion-js/resolvers 4.0.0-next.2 → 4.0.0-next.4

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import { OrionCache } from '@orion-js/cache';
-import { Blackbox } from '@orion-js/schema';
+import { Blackbox, InferSchemaType, SchemaFieldType, Schema } from '@orion-js/schema';
 
-type GlobalResolverResolve = (params: any, viewer: any, info?: any) => Promise<any>;
-type ModelResolverResolve = (item: any, params: any, viewer: any, info?: any) => Promise<any>;
-type GlobalCheckPermissions = (params: any, viewer: any, info?: any) => Promise<string | void>;
-type ModelCheckPermissions = (parent: any, params: any, viewer: any, info?: any) => Promise<string | void>;
+type GlobalResolverResolve<TParams = any, TReturns = any, TViewer = any, TInfo = any> = (params?: InferSchemaType<TParams>, viewer?: TViewer, info?: TInfo) => Promise<InferSchemaType<TReturns>>;
+type ModelResolverResolve<TItem = any, TParams = any, TReturns = any, TViewer = any, TInfo = any> = (item?: TItem, params?: InferSchemaType<TParams>, viewer?: TViewer, info?: TInfo) => Promise<InferSchemaType<TReturns>>;
+type GlobalCheckPermissions = (params: any, viewer: any, info?: any) => Promise<string>;
+type ModelCheckPermissions = (parent: any, params: any, viewer: any, info?: any) => Promise<string>;
 type GlobalGetCacheKey = (params: any, viewer: any, info: any) => Promise<any>;
 type ModelGetCacheKey = (parent: any, params: any, viewer: any, info: any) => Promise<any>;
 interface ExecuteOptions {
@@ -12,7 +12,7 @@ interface ExecuteOptions {
     viewer: any;
     parent?: any;
     info?: any;
-    options: ResolverOptions;
+    options: GlobalResolverOptions | ModelResolverOptions;
 }
 type Parameters<T> = T extends (...args: infer P) => any ? P : never;
 type ReturnType<T> = T extends (...args: any) => infer R ? R : any;
@@ -24,10 +24,10 @@ interface ExecuteParams<Resolve = Function, IsModel = undefined> {
     info?: any;
 }
 type Execute<Resolve = Function, IsModel = undefined> = (executeOptions: ExecuteParams<Resolve, IsModel>) => ReturnType<Resolve>;
-interface SharedResolverOptions {
+interface SharedResolverOptions<TParams = any, TReturns = any> {
     resolverId?: string;
-    params?: any;
-    returns?: any;
+    params?: TParams;
+    returns?: TReturns;
     mutation?: boolean;
     private?: boolean;
     checkPermission?: GlobalCheckPermissions | ModelCheckPermissions;
@@ -37,9 +37,13 @@ interface SharedResolverOptions {
     permissionsOptions?: any;
     middlewares?: ResolverMiddleware[];
 }
-interface ResolverOptions<Resolve = Function> extends SharedResolverOptions {
-    resolve: Resolve;
-}
+type GlobalResolverOptions<TParams = any, TReturns = any, TViewer = any, TInfo = any> = SharedResolverOptions<TParams, TReturns> & {
+    resolve: GlobalResolverResolve<TParams, TReturns, TViewer, TInfo>;
+};
+type ModelResolverOptions<TItem = any, TParams = any, TReturns = any, TViewer = any, TInfo = any> = SharedResolverOptions<TParams, TReturns> & {
+    resolve: ModelResolverResolve<TItem, TParams, TReturns, TViewer, TInfo>;
+};
+type ResolverOptions<TParams = any, TReturns = any, TViewer = any, TInfo = any, TItem = any> = GlobalResolverOptions<TParams, TReturns, TViewer, TInfo> | ModelResolverOptions<TItem, TParams, TReturns, TViewer, TInfo>;
 type OmitFirstArg<F> = F extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
 interface Resolver<Resolve = Function, IsModel = undefined> extends SharedResolverOptions {
     execute: Execute<Resolve, IsModel>;
@@ -47,21 +51,16 @@ interface Resolver<Resolve = Function, IsModel = undefined> extends SharedResolv
     modelResolve: IsModel extends undefined ? undefined : OmitFirstArg<Resolve>;
 }
 type ModelResolver<Resolve = Function> = Resolver<Resolve, true>;
-type CreateResolver = <Resolve extends GlobalResolverResolve>(options: ResolverOptions<Resolve>) => Resolver<Resolve>;
-type CreateModelResolver = <Resolve extends ModelResolverResolve>(options: ResolverOptions<Resolve>) => ModelResolver<Resolve>;
 interface PermissionCheckerOptions {
-    resolver: ResolverOptions;
+    resolver: GlobalResolverOptions | ModelResolverOptions;
     parent: any;
     params: any;
     viewer: any;
     info: any;
 }
-type PermissionChecker = (options: PermissionCheckerOptions) => Promise<string | void>;
+type PermissionChecker = (options: PermissionCheckerOptions) => Promise<string>;
 type ResolverMiddleware = (executeOptions: ExecuteOptions, next: () => Promise<any>) => Promise<any>;
 
-declare const resolver: CreateResolver;
-declare const modelResolver: CreateModelResolver;
-
 declare function createResolverMiddleware(middleware: ResolverMiddleware): ResolverMiddleware;
 
 declare function export_default$2(executeOptions: ExecuteOptions, options: ResolverOptions): Promise<void>;
@@ -84,4 +83,33 @@ declare function getResolverArgs(...args: any[]): {
     parent?: undefined;
 };
 
-export { type CreateModelResolver, type CreateResolver, type Execute, type ExecuteOptions, type ExecuteParams, type GlobalCheckPermissions, type GlobalGetCacheKey, type GlobalResolverResolve, type ModelCheckPermissions, type ModelGetCacheKey, type ModelResolver, type ModelResolverResolve, type PermissionChecker, type PermissionCheckerOptions, type Resolver, type ResolverMiddleware, type ResolverOptions, type SharedResolverOptions, addPermissionChecker, export_default$2 as checkPermissions, export_default$1 as cleanParams, export_default as cleanReturns, createResolverMiddleware, getResolverArgs, modelResolver, resolver };
+declare const createResolver: <TParams extends SchemaFieldType = SchemaFieldType, TReturns extends SchemaFieldType = SchemaFieldType, TViewer = any, TInfo = any>(options: GlobalResolverOptions<TParams, TReturns, TViewer, TInfo>) => Resolver<GlobalResolverResolve<TParams, TReturns, TViewer, TInfo>>;
+declare const createModelResolver: <TItem = any, TParams extends SchemaFieldType = SchemaFieldType, TReturns extends SchemaFieldType = SchemaFieldType, TViewer = any, TInfo = any>(options: ModelResolverOptions<TItem, TParams, TReturns, TViewer, TInfo>) => ModelResolver<ModelResolverResolve<TItem, TParams, TReturns, TViewer, TInfo>>;
+/**
+ * @deprecated Use createResolver and createModelResolver instead
+ */
+declare const resolver: <TParams extends SchemaFieldType = SchemaFieldType, TReturns extends SchemaFieldType = SchemaFieldType, TViewer = any, TInfo = any>(options: GlobalResolverOptions<TParams, TReturns, TViewer, TInfo>) => Resolver<GlobalResolverResolve<TParams, TReturns, TViewer, TInfo>>;
+/**
+ * @deprecated Use createResolver and createModelResolver instead
+ */
+declare const modelResolver: <TItem = any, TParams extends SchemaFieldType = SchemaFieldType, TReturns extends SchemaFieldType = SchemaFieldType, TViewer = any, TInfo = any>(options: ModelResolverOptions<TItem, TParams, TReturns, TViewer, TInfo>) => ModelResolver<ModelResolverResolve<TItem, TParams, TReturns, TViewer, TInfo>>;
+
+interface SchemaWithResolversResolversMap<TSchema> {
+    [key: string]: ModelResolver<ModelResolverResolve<TSchema>>;
+}
+interface SchemaWithResolversOptions<TModelName extends string, TSchema extends Schema, TTypeResolvers extends SchemaWithResolversResolversMap<TSchema>> {
+    name: TModelName;
+    schema: TSchema;
+    resolvers?: TTypeResolvers;
+}
+declare function internal_schemaWithResolvers<TModelName extends string, TSchema extends Schema, TTypeResolvers extends SchemaWithResolversResolversMap<TSchema>>(options: SchemaWithResolversOptions<TModelName, TSchema, TTypeResolvers>): {
+    __modelName: TModelName;
+    __resolvers: TTypeResolvers;
+} & TSchema;
+/**
+ * This method is used to give backwards compatibility to models.initItem
+ */
+declare function internal_appendResolversToItem<TItem, TSchema extends Schema, TTypeResolvers extends SchemaWithResolversResolversMap<TSchema>>(item: TItem, resolvers: TTypeResolvers): TItem & { [key in keyof TTypeResolvers]: RemoveFirstArg<TTypeResolvers[key]>; };
+type RemoveFirstArg<T> = T extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
+
+export { type Execute, type ExecuteOptions, type ExecuteParams, type GlobalCheckPermissions, type GlobalGetCacheKey, type GlobalResolverOptions, type GlobalResolverResolve, type ModelCheckPermissions, type ModelGetCacheKey, type ModelResolver, type ModelResolverOptions, type ModelResolverResolve, type PermissionChecker, type PermissionCheckerOptions, type Resolver, type ResolverMiddleware, type ResolverOptions, type SchemaWithResolversOptions, type SchemaWithResolversResolversMap, type SharedResolverOptions, addPermissionChecker, export_default$2 as checkPermissions, export_default$1 as cleanParams, export_default as cleanReturns, createModelResolver, createResolver, createResolverMiddleware, getResolverArgs, internal_appendResolversToItem, internal_schemaWithResolvers, modelResolver, resolver };