@forge/bridge 3.0.0 → 3.1.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/bridge
 
+## 3.1.0-next.0
+
+### Minor Changes
+
+- baffae7: Add invokeRemote API to @forge/bridge
+
 ## 3.0.0
 
 ### Major Changes

package/out/index.d.ts

@@ -1,4 +1,5 @@
 export * from './invoke';
+export * from './invoke-remote';
 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,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,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"}

package/out/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./invoke"), exports);
+tslib_1.__exportStar(require("./invoke-remote"), exports);
 tslib_1.__exportStar(require("./view"), exports);
 tslib_1.__exportStar(require("./router"), exports);
 tslib_1.__exportStar(require("./modal"), exports);

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

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

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

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

package/out/invoke-remote/index.js

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

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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invokeRemote = void 0;
+const tslib_1 = require("tslib");
+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 = (input) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    validatePayload(input);
+    const { success, payload, error } = (_a = (yield callBridge('invoke', input))) !== null && _a !== void 0 ? _a : {};
+    const response = Object.assign({}, (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');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "3.0.0",
+  "version": "3.1.0-next.0",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "UNLICENSED",