@orion-js/resolvers 3.4.9 → 3.5.3

package/lib/createResolverMiddleware.d.ts

@@ -0,0 +1,2 @@
+import { ResolverMiddleware } from './resolver/types';
+export declare function createResolverMiddleware(middleware: ResolverMiddleware): ResolverMiddleware;

package/lib/createResolverMiddleware.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createResolverMiddleware = void 0;
+function createResolverMiddleware(middleware) {
+    return middleware;
+}
+exports.createResolverMiddleware = createResolverMiddleware;

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 import { resolver, modelResolver } from './resolver';
 export * from './resolver/types';
+export * from './createResolverMiddleware';
 import checkPermissions from './resolver/getExecute/checkPermissions';
 import { addPermissionChecker } from './resolver/permisionsCheckers';
 import cleanParams from './resolver/cleanParams';

package/lib/index.js

@@ -18,6 +18,7 @@ const resolver_1 = require("./resolver");
 Object.defineProperty(exports, "resolver", { enumerable: true, get: function () { return resolver_1.resolver; } });
 Object.defineProperty(exports, "modelResolver", { enumerable: true, get: function () { return resolver_1.modelResolver; } });
 __exportStar(require("./resolver/types"), exports);
+__exportStar(require("./createResolverMiddleware"), exports);
 const checkPermissions_1 = __importDefault(require("./resolver/getExecute/checkPermissions"));
 exports.checkPermissions = checkPermissions_1.default;
 const permisionsCheckers_1 = require("./resolver/permisionsCheckers");

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

@@ -0,0 +1,2 @@
+import { ExecuteOptions, ResolverOptions } from '../types';
+export declare function getResultWithMiddlewares(options: ResolverOptions, executeOptions: ExecuteOptions): Promise<any>;

package/lib/resolver/getExecute/getResultWithMiddlewares.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getResultWithMiddlewares = void 0;
+const helpers_1 = require("@orion-js/helpers");
+const createResolverMiddleware_1 = require("../../createResolverMiddleware");
+const getResult_1 = __importDefault(require("./getResult"));
+async function getResultWithMiddlewares(options, executeOptions) {
+    const resolveMiddleware = (0, createResolverMiddleware_1.createResolverMiddleware)(async (executeOptions, next) => {
+        return await (0, getResult_1.default)(options, executeOptions);
+    });
+    const composedMiddlewares = (0, helpers_1.composeMiddlewares)([
+        ...(options.middlewares || []),
+        resolveMiddleware
+    ]);
+    return await composedMiddlewares(executeOptions);
+}
+exports.getResultWithMiddlewares = getResultWithMiddlewares;

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

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

package/lib/resolver/getExecute/index.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const checkPermissions_1 = __importDefault(require("./checkPermissions"));
 const cleanAndValidate_1 = __importDefault(require("./cleanAndValidate"));
 const initResult_1 = __importDefault(require("./initResult"));
-const getResult_1 = __importDefault(require("./getResult"));
-function default_1(options) {
+const getResultWithMiddlewares_1 = require("./getResultWithMiddlewares");
+function getExecute(options) {
     const execute = async (executeParams) => {
         const executeOptions = {
             params: await (0, cleanAndValidate_1.default)({
@@ -18,9 +18,9 @@ function default_1(options) {
             parent: executeParams.parent
         };
         await (0, checkPermissions_1.default)(executeOptions, options);
-        const result = await (0, getResult_1.default)(options, executeOptions);
+        const result = await (0, getResultWithMiddlewares_1.getResultWithMiddlewares)(options, executeOptions);
         return (0, initResult_1.default)(options, result);
     };
     return execute;
 }
-exports.default = default_1;
+exports.default = getExecute;

package/lib/resolver/getExecute/middlewares.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/resolver/getExecute/middlewares.test.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("..");
+const createResolverMiddleware_1 = require("../../createResolverMiddleware");
+it('should call middlewares in the correct order', async () => {
+    const order = [];
+    const middleware1 = (0, createResolverMiddleware_1.createResolverMiddleware)(async (executeOptions, next) => {
+        order.push(1);
+        const result = await next();
+        order.push(result);
+        order.push(3);
+        return 'middleware1';
+    });
+    const middleware2 = (0, createResolverMiddleware_1.createResolverMiddleware)(async ({ params, viewer }, next) => {
+        order.push(2);
+        const result = await next();
+        order.push(result);
+        order.push(4);
+        return 'middleware2';
+    });
+    const testResolver = (0, __1.resolver)({
+        params: {},
+        middlewares: [middleware1, middleware2],
+        async resolve() {
+            order.push(5);
+            return 'resolve';
+        }
+    });
+    const finalResult = await testResolver.resolve();
+    expect(finalResult).toEqual('middleware1');
+    expect(order).toEqual([1, 2, 5, 'resolve', 4, 'middleware2', 3]);
+});
+it('should let you throw an error inside a middleware', () => {
+    const middleware1 = (0, createResolverMiddleware_1.createResolverMiddleware)(async (executeOptions, next) => {
+        throw new Error('middleware1');
+    });
+    const testResolver = (0, __1.resolver)({
+        params: {},
+        middlewares: [middleware1],
+        async resolve() {
+            return 'resolve';
+        }
+    });
+    expect(testResolver.resolve()).rejects.toEqual(new Error('middleware1'));
+});
+it('should work with model resolvers and modify its params', async () => {
+    const middleware1 = (0, createResolverMiddleware_1.createResolverMiddleware)(async (executeOptions, next) => {
+        executeOptions.params.number = 2;
+        executeOptions.parent.text = 'middleware';
+        const result = await next();
+        return result;
+    });
+    const testResolver = (0, __1.modelResolver)({
+        params: { number: { type: Number } },
+        middlewares: [middleware1],
+        async resolve(model, params, viewer) {
+            return `${model.text} ${params.number}`;
+        }
+    });
+    const finalResult = await testResolver.execute({
+        params: { number: 1 },
+        parent: { text: 'test' }
+    });
+    expect(finalResult).toEqual('middleware 2');
+});

package/lib/resolver/index.js

@@ -10,7 +10,7 @@ const helpers_1 = require("@orion-js/helpers");
 const cache_1 = require("@orion-js/cache");
 const cleanReturns_1 = __importDefault(require("./cleanReturns"));
 const getArgs_1 = require("./getArgs");
-const createResolver = function (options) {
+function createResolver(options) {
     options.params = (0, cleanParams_1.default)(options.params);
     options.returns = (0, cleanReturns_1.default)(options.returns);
     if (!options.cacheProvider) {
@@ -19,6 +19,9 @@ const createResolver = function (options) {
     if (!options.resolverId) {
         options.resolverId = (0, helpers_1.generateId)();
     }
+    if (!options.middlewares) {
+        options.middlewares = [];
+    }
     const execute = (0, getExecute_1.default)(options);
     const resolve = async (...args) => {
         const params = (0, getArgs_1.getArgs)(...args);
@@ -30,7 +33,7 @@ const createResolver = function (options) {
         execute
     };
     return resolver;
-};
+}
 const resolver = createResolver;
 exports.resolver = resolver;
 const modelResolver = createResolver;

package/lib/resolver/types.d.ts

@@ -1,4 +1,5 @@
 import { OrionCache } from '@orion-js/cache';
+import { Blackbox } from '@orion-js/schema';
 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 | void>;
@@ -6,7 +7,7 @@ export declare type ModelCheckPermissions = (parent: any, params: any, viewer: a
 export declare type GlobalGetCacheKey = (params: any, viewer: any) => Promise<any>;
 export declare type ModelGetCacheKey = (parent: any, params: any, viewer: any) => Promise<any>;
 export interface ExecuteOptions {
-    params: object;
+    params: Blackbox;
     viewer: any;
     parent?: any;
 }
@@ -30,6 +31,7 @@ export interface SharedResolverOptions {
     cache?: number;
     cacheProvider?: OrionCache;
     permissionsOptions?: any;
+    middlewares?: ResolverMiddleware[];
 }
 export interface ResolverOptions<Resolve = Function> extends SharedResolverOptions {
     resolve: Resolve;
@@ -50,4 +52,5 @@ export interface PermissionCheckerOptions {
     viewer: any;
 }
 export declare type PermissionChecker = (options: PermissionCheckerOptions) => Promise<string | void>;
+export declare type ResolverMiddleware = (executeOptions: ExecuteOptions, next: () => Promise<any>) => Promise<any>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/resolvers",
-  "version": "3.4.9",
+  "version": "3.5.3",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -17,9 +17,9 @@
     "upgrade-interactive": "yarn upgrade-interactive"
   },
   "dependencies": {
-    "@orion-js/cache": "^3.4.1",
-    "@orion-js/helpers": "^3.4.1",
-    "@orion-js/schema": "^3.4.9"
+    "@orion-js/cache": "^3.5.3",
+    "@orion-js/helpers": "^3.5.3",
+    "@orion-js/schema": "^3.5.0"
   },
   "devDependencies": {
     "@shelf/jest-mongodb": "^2.1.0",
@@ -33,5 +33,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e9c223e70752b6c613f58e63f8fd9fab471618de"
+  "gitHead": "34430096bb765afdc07b6f3c079915d424491b9c"
 }