@forge/bridge 4.5.3 → 4.6.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/bridge
 
+## 4.6.0-next.0
+
+### Minor Changes
+
+- b8299ae: Add invokeService to forge/bridge
+
 ## 4.5.3
 
 ### Patch Changes

package/out/index.d.ts

@@ -1,6 +1,6 @@
 export { NavigationTarget } from './router/targets';
 export * from './invoke';
-export * from './invoke-remote';
+export * from './invoke-endpoint';
 export * from './view';
 export * from './router';
 export * from './modal';

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC"}

package/out/index.js

@@ -5,7 +5,7 @@ const tslib_1 = require("tslib");
 var targets_1 = require("./router/targets");
 Object.defineProperty(exports, "NavigationTarget", { enumerable: true, get: function () { return targets_1.NavigationTarget; } });
 tslib_1.__exportStar(require("./invoke"), exports);
-tslib_1.__exportStar(require("./invoke-remote"), exports);
+tslib_1.__exportStar(require("./invoke-endpoint"), exports);
 tslib_1.__exportStar(require("./view"), exports);
 tslib_1.__exportStar(require("./router"), exports);
 tslib_1.__exportStar(require("./modal"), exports);

package/out/invoke-endpoint/index.d.ts

@@ -0,0 +1,3 @@
+export * from './invoke-remote';
+export * from './invoke-service';
+//# sourceMappingURL=index.d.ts.map

package/out/invoke-endpoint/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/invoke-endpoint/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC"}

package/out/{invoke-remote → invoke-endpoint}/index.js

@@ -2,3 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./invoke-remote"), exports);
+tslib_1.__exportStar(require("./invoke-service"), exports);

package/out/invoke-endpoint/invoke-endpoint.d.ts

@@ -0,0 +1,18 @@
+import { InvokeResponse } from '../types';
+declare type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+export interface InvokeEndpointInput {
+    path: string;
+    method: HttpMethod;
+    headers?: Record<string, string>;
+    body?: unknown;
+}
+export declare enum InvokeType {
+    REMOTE = "Remote",
+    SERVICE = "Container"
+}
+export interface CallBridgePayload extends InvokeEndpointInput {
+    invokeType: string;
+}
+export declare const _invokeEndpointFn: (invokeType: InvokeType) => (input: InvokeEndpointInput) => Promise<InvokeResponse>;
+export {};
+//# sourceMappingURL=invoke-endpoint.d.ts.map

package/out/invoke-endpoint/invoke-endpoint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invoke-endpoint.d.ts","sourceRoot":"","sources":["../../src/invoke-endpoint/invoke-endpoint.ts"],"names":[],"mappings":"AAEA,OAAO,EAAiB,cAAc,EAAE,MAAM,UAAU,CAAC;AAOzD,aAAK,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE9D,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,OAAO,cAAc;CACtB;AAED,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D,UAAU,EAAE,MAAM,CAAC;CACpB;AAoCD,eAAO,MAAM,iBAAiB,eAChB,UAAU,aACZ,mBAAmB,KAAK,QAAQ,cAAc,CASzD,CAAC"}

package/out/invoke-endpoint/invoke-endpoint.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._invokeEndpointFn = exports.InvokeType = void 0;
+const bridge_1 = require("../bridge");
+const errors_1 = require("../errors");
+const utils_1 = require("../utils");
+const MAX_NUM_OPERATIONS = 500;
+const OPERATION_INTERVAL_SEC = 25;
+const OPERATION_INTERVAL_MS = 1000 * OPERATION_INTERVAL_SEC;
+var InvokeType;
+(function (InvokeType) {
+    InvokeType["REMOTE"] = "Remote";
+    InvokeType["SERVICE"] = "Container";
+})(InvokeType = exports.InvokeType || (exports.InvokeType = {}));
+const callBridge = (0, bridge_1.getCallBridge)();
+const validatePayload = (payload) => {
+    if (!payload)
+        return;
+    if (Object.values(payload).some((val) => typeof val === 'function')) {
+        throw new errors_1.BridgeAPIError('Passing functions as part of the payload is not supported!');
+    }
+};
+const _setupInvokeEndpointFn = (invokeType) => async (input) => {
+    validatePayload(input);
+    const callBridgePayload = {
+        ...input,
+        invokeType: `ui-${invokeType.toLowerCase()}-fetch`
+    };
+    const bridgeResponse = await callBridge('invoke', callBridgePayload);
+    const { success, payload, error } = bridgeResponse !== null && bridgeResponse !== void 0 ? bridgeResponse : {};
+    const response = { ...(success ? payload : error) };
+    if (response && response.headers) {
+        for (const header in response.headers) {
+            if (Array.isArray(response.headers[header])) {
+                response.headers[header] = response.headers[header].join(',');
+            }
+        }
+    }
+    return response;
+};
+const _invokeEndpointFn = (invokeType) => {
+    const invokeEndpointFn = _setupInvokeEndpointFn(invokeType);
+    return (0, utils_1.withRateLimiter)(invokeEndpointFn, MAX_NUM_OPERATIONS, OPERATION_INTERVAL_MS, `${invokeType} invocation calls are rate limited at ${MAX_NUM_OPERATIONS}/${OPERATION_INTERVAL_SEC}s`);
+};
+exports._invokeEndpointFn = _invokeEndpointFn;

package/out/invoke-endpoint/invoke-remote.d.ts

@@ -0,0 +1,4 @@
+import { InvokeEndpointInput } from './invoke-endpoint';
+export declare type InvokeRemoteInput = InvokeEndpointInput;
+export declare const invokeRemote: (input: InvokeRemoteInput) => Promise<import("../types").InvokeResponse>;
+//# sourceMappingURL=invoke-remote.d.ts.map

package/out/invoke-endpoint/invoke-remote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invoke-remote.d.ts","sourceRoot":"","sources":["../../src/invoke-endpoint/invoke-remote.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,mBAAmB,EAAc,MAAM,mBAAmB,CAAC;AAEvF,oBAAY,iBAAiB,GAAG,mBAAmB,CAAC;AAEpD,eAAO,MAAM,YAAY,UAAW,iBAAiB,+CAIpD,CAAC"}

package/out/invoke-endpoint/invoke-remote.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invokeRemote = void 0;
+const invoke_endpoint_1 = require("./invoke-endpoint");
+const invokeRemote = (input) => {
+    const invokeEndpoint = (0, invoke_endpoint_1._invokeEndpointFn)(invoke_endpoint_1.InvokeType.REMOTE);
+    return invokeEndpoint(input);
+};
+exports.invokeRemote = invokeRemote;

package/out/invoke-endpoint/invoke-service.d.ts

@@ -0,0 +1,4 @@
+import { InvokeEndpointInput } from './invoke-endpoint';
+export declare type InvokeServiceInput = InvokeEndpointInput;
+export declare const invokeService: (input: InvokeServiceInput) => Promise<import("../types").InvokeResponse>;
+//# sourceMappingURL=invoke-service.d.ts.map

package/out/invoke-endpoint/invoke-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invoke-service.d.ts","sourceRoot":"","sources":["../../src/invoke-endpoint/invoke-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,mBAAmB,EAAc,MAAM,mBAAmB,CAAC;AAEvF,oBAAY,kBAAkB,GAAG,mBAAmB,CAAC;AAErD,eAAO,MAAM,aAAa,UAAW,kBAAkB,+CAItD,CAAC"}

package/out/invoke-endpoint/invoke-service.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invokeService = void 0;
+const invoke_endpoint_1 = require("./invoke-endpoint");
+const invokeService = (input) => {
+    const invokeEndpoint = (0, invoke_endpoint_1._invokeEndpointFn)(invoke_endpoint_1.InvokeType.SERVICE);
+    return invokeEndpoint(input);
+};
+exports.invokeService = invokeService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "4.5.3",
+  "version": "4.6.0-next.0",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",

package/out/invoke-remote/index.d.ts

@@ -1,2 +0,0 @@
-export * from './invoke-remote';
-//# sourceMappingURL=index.d.ts.map

package/out/invoke-remote/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/invoke-remote/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}

package/out/invoke-remote/invoke-remote.d.ts

@@ -1,8 +0,0 @@
-export interface InvokeRemoteInput {
-    path: string;
-    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
-    headers?: Record<string, string>;
-    body?: unknown;
-}
-export declare const invokeRemote: <T>(input: InvokeRemoteInput) => Promise<T>;
-//# sourceMappingURL=invoke-remote.d.ts.map

package/out/invoke-remote/invoke-remote.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"invoke-remote.d.ts","sourceRoot":"","sources":["../../src/invoke-remote/invoke-remote.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AA6BD,eAAO,MAAM,YAAY,6CAKxB,CAAC"}

package/out/invoke-remote/invoke-remote.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.invokeRemote = void 0;
-const bridge_1 = require("../bridge");
-const errors_1 = require("../errors");
-const utils_1 = require("../utils");
-const MAX_NUM_OPERATIONS = 500;
-const OPERATION_INTERVAL_MS = 1000 * 25;
-const callBridge = (0, bridge_1.getCallBridge)();
-const validatePayload = (payload) => {
-    if (!payload)
-        return;
-    if (Object.values(payload).some((val) => typeof val === 'function')) {
-        throw new errors_1.BridgeAPIError('Passing functions as part of the payload is not supported!');
-    }
-};
-const _invokeRemote = async (input) => {
-    var _a;
-    validatePayload(input);
-    const { success, payload, error } = (_a = (await callBridge('invoke', input))) !== null && _a !== void 0 ? _a : {};
-    const response = { ...(success ? payload : error) };
-    if (response && response.headers) {
-        for (const header in response.headers) {
-            if (Array.isArray(response.headers[header])) {
-                response.headers[header] = response.headers[header].join(',');
-            }
-        }
-    }
-    return response;
-};
-exports.invokeRemote = (0, utils_1.withRateLimiter)(_invokeRemote, MAX_NUM_OPERATIONS, OPERATION_INTERVAL_MS, 'Remote invocation calls are rate limited at 500req/25s');