@orion-js/resolvers 3.0.14 → 3.0.24

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Orionjs Team
+Copyright (c) 2021 Orionjs Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/resolver/getExecute/getResult.js

@@ -7,12 +7,11 @@ const getCacheKey_1 = __importDefault(require("./getCacheKey"));
 async function default_1(options, executeOptions) {
     const { parent, params, viewer } = executeOptions;
     const executeResolver = async () => {
+        const resultFunc = options.resolve;
         if (parent) {
-            const resultFunc = options.resolve;
             return await resultFunc(parent, params, viewer);
         }
         else {
-            const resultFunc = options.resolve;
             return await resultFunc(params, viewer);
         }
     };

package/lib/resolver/getExecute/getSchema.js

@@ -11,10 +11,10 @@ function default_1(resolverParams) {
         const field = (0, clone_1.default)(resolverParams[key]);
         const isArrayOfModel = (0, isArray_1.default)(field.type) && field.type[0].__isModel;
         if (isArrayOfModel) {
-            field.type = [field.type[0].schema];
+            field.type = [field.type[0].getSchema()];
         }
         else if (field.type.__isModel) {
-            field.type = field.type.schema;
+            field.type = field.type.getSchema();
         }
         schema[key] = field;
     }

package/lib/resolver/getExecute/index.d.ts

@@ -1,2 +1,2 @@
 import { ResolverOptions, Execute } from '../types';
-export default function (options: ResolverOptions): Execute<object, any, undefined>;
+export default function (options: ResolverOptions): Execute<Function, undefined>;

package/lib/resolver/index.test.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_1 = require("./index");
+const helpers_1 = require("@orion-js/helpers");
 it('should return a function with a resolver id', () => {
     const resolver = (0, index_1.resolver)({
         params: {},
@@ -36,8 +37,8 @@ it('should get from cache', async () => {
             }
         },
         returns: Number,
-        cache: 1000,
-        async resolve() {
+        cache: 100,
+        async resolve(params) {
             return index++;
         }
     });
@@ -51,6 +52,7 @@ it('should get from cache', async () => {
     expect(result4).toBe(2);
     const result5 = await resolver.execute({ params: { value: 3 } }); // 3
     expect(result5).toBe(3);
+    await (0, helpers_1.sleep)(100);
 });
 it('should create typed resolvers', async () => {
     const resolver = (0, index_1.resolver)({
@@ -76,12 +78,16 @@ it('should create typed resolvers', async () => {
 it('should create typed model resolvers', async () => {
     const resolver = (0, index_1.modelResolver)({
         returns: Number,
-        resolve: async function (model) {
-            return model.value * 2;
+        resolve: async function (model, params) {
+            return model.value * params.times;
         }
     });
-    await resolver.resolve({ value: 1 });
+    await resolver.resolve({ value: 1 }, { times: 2 });
     const inModel = resolver.modelResolve;
+    await resolver.execute({
+        parent: { value: 1 },
+        params: { times: 2 }
+    });
 });
 it('should accept a model as params', async () => {
     const aModel = {
@@ -169,3 +175,15 @@ it('should allow calling resolver.resolve', async () => {
     expect(await resolver.resolve({ title: 'test' })).toBe('test');
     expect(await modelResolver.resolve({ title: 'test' })).toBe('test');
 });
+it('only allow compliant resolve function', async () => {
+    const resolver = (0, index_1.resolver)({
+        resolve: async () => {
+            return 'hello';
+        }
+    });
+    const modelResolver = (0, index_1.modelResolver)({
+        resolve: async () => {
+            return 'hello';
+        }
+    });
+});

package/lib/resolver/types.d.ts

@@ -1,6 +1,6 @@
 import { OrionCache } from '@orion-js/cache';
-export declare type GlobalResolverResolve<ParamsType = any, ReturnType = any> = (params: ParamsType, viewer: any) => Promise<ReturnType>;
-export declare type ModelResolverResolve<ModelType = any, ParamsType = any, ReturnType = any> = (item: ModelType, params: ParamsType, viewer: any) => Promise<ReturnType>;
+export declare type GlobalResolverResolve = (params: any, viewer: any) => Promise<any>;
+export declare type ModelResolverResolve = (item: any, params: any, viewer: any) => Promise<any>;
 export declare type GlobalCheckPermissions = (params: any, viewer: any) => Promise<string>;
 export declare type ModelCheckPermissions = (parent: any, params: any, viewer: any) => Promise<string>;
 export declare type GlobalGetCacheKey = (params: any, viewer: any) => Promise<any>;
@@ -10,12 +10,15 @@ export interface ExecuteOptions {
     viewer: any;
     parent?: any;
 }
-export interface ExecuteParams<ParamsType = object, ModelType = undefined> {
-    params?: ParamsType;
+declare type Parameters<T> = T extends (...args: infer P) => any ? P : never;
+declare type ReturnType<T> = T extends (...args: any) => infer R ? R : any;
+declare type ResolverParams<Resolve, IsModel> = IsModel extends undefined ? Parameters<Resolve>[0] : Parameters<Resolve>[1];
+export interface ExecuteParams<Resolve = Function, IsModel = undefined> {
+    params?: ResolverParams<Resolve, IsModel>;
     viewer?: any;
-    parent?: ModelType;
+    parent?: IsModel extends undefined ? undefined : Parameters<Resolve>[0];
 }
-export declare type Execute<ParamsType = object, ReturnType = any, ModelType = undefined> = (executeOptions: ExecuteParams<ParamsType, ModelType>) => Promise<ReturnType>;
+export declare type Execute<Resolve = Function, IsModel = undefined> = (executeOptions: ExecuteParams<Resolve, IsModel>) => ReturnType<Resolve>;
 export interface SharedResolverOptions {
     resolverId?: string;
     params?: any;
@@ -32,13 +35,14 @@ export interface ResolverOptions<Resolve = Function> extends SharedResolverOptio
     resolve: Resolve;
 }
 declare type OmitFirstArg<F> = F extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
-export interface Resolver<Resolve = Function, ModelType = undefined> extends SharedResolverOptions {
-    execute: Execute;
+export interface Resolver<Resolve = Function, IsModel = undefined> extends SharedResolverOptions {
+    execute: Execute<Resolve, IsModel>;
     resolve: Resolve;
-    modelResolve: ModelType extends undefined ? undefined : OmitFirstArg<Resolve>;
+    modelResolve: IsModel extends undefined ? undefined : OmitFirstArg<Resolve>;
 }
-export declare type CreateResolver = <Resolve>(options: ResolverOptions<Resolve>) => Resolver<Resolve>;
-export declare type CreateModelResolver = <ModelType, Resolve>(options: ResolverOptions<Resolve>) => Resolver<Resolve, ModelType>;
+export declare type ModelResolver<Resolve = Function> = Resolver<Resolve, true>;
+export declare type CreateResolver = <Resolve extends GlobalResolverResolve>(options: ResolverOptions<Resolve>) => Resolver<Resolve>;
+export declare type CreateModelResolver = <Resolve extends ModelResolverResolve>(options: ResolverOptions<Resolve>) => ModelResolver<Resolve>;
 export interface PermissionCheckerOptions {
     resolver: ResolverOptions;
     parent: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/resolvers",
-  "version": "3.0.14",
+  "version": "3.0.24",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -13,12 +13,13 @@
     "prepare": "yarn run build",
     "clean": "rm -rf ./lib",
     "build": "yarn run clean && tsc",
-    "watch": "yarn run clean && tsc -w"
+    "watch": "tsc -w",
+    "upgrade-interactive": "yarn upgrade-interactive"
   },
   "dependencies": {
-    "@orion-js/cache": "^3.0.0-alpha.23",
-    "@orion-js/helpers": "^3.0.0",
-    "@orion-js/schema": "^3.0.7"
+    "@orion-js/cache": "^3.0.17",
+    "@orion-js/helpers": "^3.0.17",
+    "@orion-js/schema": "^3.0.17"
   },
   "devDependencies": {
     "@shelf/jest-mongodb": "^2.1.0",
@@ -31,5 +32,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "265f025c5ed42f9de5f46f4ae9eae3589ec77085"
+  "gitHead": "5ac1c68e72af3dbeaf8eb5c2a04d5325da2a7e3f"
 }