@forge/bridge 2.6.1 → 3.0.0-experimental-5c9420a

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @forge/bridge
 
+## 3.0.0-experimental-5c9420a
+
+### Major Changes
+
+- e734722: Add invokeRemote API which is used by Custom UI apps to perform a request against a remote resource
+
+## 3.0.0
+
+### Major Changes
+
+- 1de47d7: The `license` field from an app's context object now has updated properties and returns additional information. Updating the `license` type in this version to reflect these changes.
+
+## 3.0.0-next.0
+
+### Major Changes
+
+- 1de47d7: The `license` field from an app's context object now has updated properties and returns additional information. Updating the `license` type in this version to reflect these changes.
+
 ## 2.6.1
 
 ### Patch Changes

package/out/index.d.ts

@@ -1,4 +1,5 @@
 export * from './invoke';
+export * from './invokeRemote';
 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,gBAAgB,CAAC;AAC/B,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("./invokeRemote"), exports);
 tslib_1.__exportStar(require("./view"), exports);
 tslib_1.__exportStar(require("./router"), exports);
 tslib_1.__exportStar(require("./modal"), exports);

package/out/invokeRemote/index.d.ts

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

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

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

package/out/invokeRemote/index.js

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

package/out/invokeRemote/invokeRemote.d.ts

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

package/out/invokeRemote/invokeRemote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invokeRemote.d.ts","sourceRoot":"","sources":["../../src/invokeRemote/invokeRemote.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;IAChE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAkBD,eAAO,MAAM,YAAY,6CAKxB,CAAC"}

package/out/invokeRemote/invokeRemote.js

@@ -0,0 +1,19 @@
+"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 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) => {
+    validatePayload(input);
+    return callBridge('invoke', input);
+};
+exports.invokeRemote = (0, utils_1.withRateLimiter)(_invokeRemote, 500, 1000 * 25, 'Resolver calls are rate limited at 500req/25s');

package/out/types.d.ts

@@ -13,7 +13,7 @@ export interface FullContext {
     accountId?: string;
     cloudId?: string;
     extension: ExtensionData;
-    license?: LicenseState;
+    license?: LicenseDetails;
     localId: string;
     locale: string;
     moduleKey: string;
@@ -23,8 +23,16 @@ export interface FullContext {
 interface ExtensionData {
     [k: string]: any;
 }
-interface LicenseState {
-    isActive?: boolean;
+export interface LicenseDetails {
+    active: boolean;
+    billingPeriod: string;
+    ccpEntitlementId: string;
+    ccpEntitlementSlug: string;
+    isEvaluation: boolean;
+    subscriptionEndDate: string | null;
+    supportEntitlementNumber: string | null;
+    trialEndDate: string | null;
+    type: string;
 }
 export type Subscription = {
     unsubscribe: () => void;

package/out/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG;KACzB,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;CAC9B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;AAExD,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC;AAEhD,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,aAAa,CAAC;IACzB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,UAAU,aAAa;IACrB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CAClB;AAED,UAAU,YAAY;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG;KACzB,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;CAC9B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;AAExD,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC;AAEhD,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,aAAa,CAAC;IACzB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,UAAU,aAAa;IACrB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "2.6.1",
+  "version": "3.0.0-experimental-5c9420a",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "UNLICENSED",