@forge/resolver 1.6.16 → 1.7.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @forge/resolver
 
+## 1.7.0-next.1
+
+### Minor Changes
+
+- 1a5bad3: Typed interface for invoking resolvers
+
+## 1.6.17-next.0
+
+### Patch Changes
+
+- Updated dependencies [518c490]
+  - @forge/api@6.1.0-next.0
+
 ## 1.6.16
 
 ### Patch Changes

package/out/index.d.ts

@@ -1,34 +1,28 @@
-interface InvokePayload {
+import type { Context, DefArgument, DefResult, Definitions, Request } from './shared';
+export { Request };
+declare type InvokePayload<Argument> = {
     call: {
         functionKey: string;
-        payload?: {
-            [key in number | string]: any;
-        };
+        payload?: Argument;
         jobId?: string;
     };
-    context: {
-        [key: string]: any;
-    };
-}
-export interface Request {
-    payload: {
-        [key in number | string]: any;
-    };
-    context: InvokePayload['context'];
-}
-interface ResponseObject {
+    context: Context;
+};
+export declare type Response = {
     [key: string]: any;
-}
-export declare type Response = ResponseObject | string | void;
-export declare type ResolverFunction = (request: Request) => Promise<Response> | Response;
-declare type DefinitionsHandler = (payload: InvokePayload, backendRuntimePayload?: Request['payload']) => Promise<ReturnType<ResolverFunction>>;
+} | string | void;
+export declare type ResolverFunction<Argument = any, Result = Response> = (request: Request<Argument>) => Promise<Result> | Result;
+declare type DefinitionsHandler = (payload: InvokePayload<unknown>, backendRuntimePayload?: Record<string, any>) => Promise<unknown>;
 export default class Resolver {
     private functions;
     constructor();
-    define(functionKey: string, cb: ResolverFunction): this;
+    define(functionKey: string, cb: ResolverFunction<never, unknown>): this;
     private getFunction;
     private sanitizeObject;
     getDefinitions(): DefinitionsHandler;
 }
-export {};
+export declare type Handlers<D extends Definitions> = {
+    [Def in keyof D & string]: ResolverFunction<DefArgument<D, Def>, DefResult<D, Def>>;
+};
+export declare function makeResolver<D extends Definitions>(handlers: Handlers<D>): DefinitionsHandler;
 //# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,UAAU,aAAa;IACrB,IAAI,EAAE;QACJ,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE;aAAG,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;SAAE,CAAC;QAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,EAAE;QACP,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED,MAAM,WAAW,OAAO;IACtB,OAAO,EAAE;SACN,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;KAC9B,CAAC;IACF,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;CACnC;AAED,UAAU,cAAc;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,oBAAY,QAAQ,GAAG,cAAc,GAAG,MAAM,GAAG,IAAI,CAAC;AAEtD,oBAAY,gBAAgB,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;AAElF,aAAK,kBAAkB,GAAG,CACxB,OAAO,EAAE,aAAa,EACtB,qBAAqB,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,KACvC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC;AAsC3C,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,SAAS,CAAmC;;IAQ7C,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,gBAAgB,GAAG,IAAI;IAW9D,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,cAAc;IAIf,cAAc,IAAI,kBAAkB;CA2B5C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEtF,OAAO,EAAE,OAAO,EAAE,CAAC;AAEnB,aAAK,aAAa,CAAC,QAAQ,IAAI;IAC7B,IAAI,EAAE;QACJ,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,QAAQ,CAAC;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,oBAAY,QAAQ,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,GAAG,MAAM,GAAG,IAAI,CAAC;AAE9D,oBAAY,gBAAgB,CAAC,QAAQ,GAAG,GAAG,EAAE,MAAM,GAAG,QAAQ,IAAI,CAChE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,KACvB,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;AAE9B,aAAK,kBAAkB,GAAG,CACxB,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,EAC/B,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KACxC,OAAO,CAAC,OAAO,CAAC,CAAC;AAEtB,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,SAAS,CAAqD;;IAM/D,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,IAAI;IAa9E,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,cAAc;IAIf,cAAc,IAAI,kBAAkB;CAyB5C;AAOD,oBAAY,QAAQ,CAAC,CAAC,SAAS,WAAW,IAAI;KAC3C,GAAG,IAAI,MAAM,CAAC,GAAG,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;CACpF,CAAC;AAQF,wBAAgB,YAAY,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAM7F"}

package/out/index.js

@@ -1,34 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const api_1 = require("@forge/api");
-const isRequestPayload = (request) => {
-    return typeof request.payload === 'object' && request.payload.product && request.payload.fetchUrl;
-};
-const defaultFunctions = {
-    __request: async (request) => {
-        if (!isRequestPayload(request)) {
-            throw new Error('Invalid payload specified for request');
-        }
-        const { payload } = request;
-        const productApis = {
-            jira: (0, api_1.asUser)().requestJira,
-            confluence: (0, api_1.asUser)().requestConfluence
-        };
-        const response = await productApis[payload.product]((0, api_1.assumeTrustedRoute)(payload.fetchUrl), payload.fetchOptions);
-        let body = await response.text();
-        try {
-            body = JSON.parse(body);
-        }
-        catch (e) { }
-        return { ...response, body };
-    }
-};
+exports.makeResolver = void 0;
 class Resolver {
     functions;
     constructor() {
-        this.functions = {
-            ...defaultFunctions
-        };
+        this.functions = {};
     }
     define(functionKey, cb) {
         if (!cb || typeof cb !== 'function') {
@@ -50,10 +26,10 @@ class Resolver {
         return JSON.parse(JSON.stringify(object));
     }
     getDefinitions() {
-        const resolve = async ({ call: { functionKey, payload: callPayload, jobId }, context }, backendRuntimePayload) => {
+        return async ({ call: { functionKey, payload, jobId }, context }, backendRuntimePayload) => {
             const cb = this.getFunction(functionKey);
             const result = await cb({
-                payload: callPayload || {},
+                payload: payload || {},
                 context: {
                     ...context,
                     installContext: backendRuntimePayload?.installContext,
@@ -68,7 +44,14 @@ class Resolver {
             }
             return result;
         };
-        return resolve;
     }
 }
 exports.default = Resolver;
+function makeResolver(handlers) {
+    const resolver = new Resolver();
+    for (const key of Object.keys(handlers)) {
+        resolver.define(key, handlers[key]);
+    }
+    return resolver.getDefinitions();
+}
+exports.makeResolver = makeResolver;

package/out/shared/index.d.ts

@@ -0,0 +1,12 @@
+export declare type Context = {
+    [key: string]: any;
+};
+export declare type Request<Argument = any> = {
+    payload: Argument;
+    context: Context;
+};
+export declare type Definitions = Record<string, (i: never) => unknown>;
+export declare type DefArguments<D extends Definitions, Def extends keyof D & string> = Parameters<D[Def]> extends [] ? [] : [Parameters<D[Def]>[0]];
+export declare type DefArgument<D extends Definitions, Def extends keyof D & string> = DefArguments<D, Def>[0];
+export declare type DefResult<D extends Definitions, Def extends keyof D & string> = Awaited<ReturnType<D[Def]>>;
+//# sourceMappingURL=index.d.ts.map

package/out/shared/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/shared/index.ts"],"names":[],"mappings":"AAIA,oBAAY,OAAO,GAAG;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAEF,oBAAY,OAAO,CAAC,QAAQ,GAAG,GAAG,IAAI;IACpC,OAAO,EAAE,QAAQ,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAIF,oBAAY,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,OAAO,CAAC,CAAC;AAIhE,oBAAY,YAAY,CAAC,CAAC,SAAS,WAAW,EAAE,GAAG,SAAS,MAAM,CAAC,GAAG,MAAM,IAC1E,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/D,oBAAY,WAAW,CAAC,CAAC,SAAS,WAAW,EAAE,GAAG,SAAS,MAAM,CAAC,GAAG,MAAM,IAAI,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACvG,oBAAY,SAAS,CAAC,CAAC,SAAS,WAAW,EAAE,GAAG,SAAS,MAAM,CAAC,GAAG,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC"}

package/out/shared/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,19 +1,22 @@
 {
   "name": "@forge/resolver",
-  "version": "1.6.16",
+  "version": "1.7.0-next.1",
   "description": "Forge function resolver",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "out/index.js",
   "types": "out/index.d.ts",
+  "exports": {
+    "./shared": {
+      "types": "./out/shared/index.d.ts",
+      "default": "./out/shared/index.js"
+    }
+  },
   "scripts": {
     "build": "yarn run clean && yarn run compile",
     "clean": "rm -rf ./out && rm -f tsconfig.tsbuildinfo",
     "compile": "tsc -b -v"
   },
-  "dependencies": {
-    "@forge/api": "6.0.3"
-  },
   "publishConfig": {
     "registry": "https://packages.atlassian.com/api/npm/npm-public/"
   }