@forge/bridge 2.4.0 → 2.5.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/bridge
 
+## 2.5.0-next.0
+
+### Minor Changes
+
+- 6269d73d: Fix return type for getContext method
+
 ## 2.4.0
 
 ### Minor Changes

package/out/bridge.js

@@ -5,7 +5,7 @@ const errors_1 = require("./errors");
 function isBridgeAvailable(bridge) {
     return !!(bridge === null || bridge === void 0 ? void 0 : bridge.callBridge);
 }
-exports.getCallBridge = () => {
+const getCallBridge = () => {
     if (!isBridgeAvailable(window.__bridge)) {
         throw new errors_1.BridgeAPIError(`
       Unable to establish a connection with the Custom UI bridge.
@@ -14,3 +14,4 @@ exports.getCallBridge = () => {
     }
     return window.__bridge.callBridge;
 };
+exports.getCallBridge = getCallBridge;

package/out/events/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAYxC,eAAO,MAAM,MAAM;kBARE,MAAM,YAAY,GAAG,KAAG,OAAO,CAAC,IAAI,CAAC;gBAIvC,MAAM,uBAAuB,GAAG,KAAK,GAAG,KAAG,OAAO,CAAC,YAAY,CAAC;CAOlF,CAAC"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAYxC,eAAO,MAAM,MAAM;kBARE,MAAM,YAAY,GAAG,KAAG,QAAQ,IAAI,CAAC;gBAIvC,MAAM,uBAAuB,GAAG,KAAK,GAAG,KAAG,QAAQ,YAAY,CAAC;CAOlF,CAAC"}

package/out/events/events.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.events = void 0;
 const bridge_1 = require("../bridge");
-const callBridge = bridge_1.getCallBridge();
+const callBridge = (0, bridge_1.getCallBridge)();
 const emit = (event, payload) => {
     return callBridge('emit', { event, payload });
 };

package/out/fetch/fetch.d.ts

@@ -1,6 +1,6 @@
 import { getCallBridge } from '../bridge';
 export declare const productFetchApi: (callBridge: ReturnType<typeof getCallBridge>) => {
-    requestConfluence: (restPath: string, fetchOptions?: RequestInit | undefined) => Promise<Response>;
-    requestJira: (restPath: string, fetchOptions?: RequestInit | undefined) => Promise<Response>;
+    requestConfluence: (restPath: string, fetchOptions?: RequestInit) => Promise<Response>;
+    requestJira: (restPath: string, fetchOptions?: RequestInit) => Promise<Response>;
 };
 //# sourceMappingURL=fetch.d.ts.map

package/out/fetch/fetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/fetch/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAqB1C,eAAO,MAAM,eAAe,eAAgB,UAAU,CAAC,OAAO,aAAa,CAAC;kCAuB1C,MAAM,6CAA+B,OAAO,CAAC,QAAQ,CAAC;4BAG5D,MAAM,6CAA+B,OAAO,CAAC,QAAQ,CAAC;CAGjF,CAAC"}
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/fetch/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAqB1C,eAAO,MAAM,eAAe,eAAgB,WAAW,oBAAoB,CAAC;kCAuB1C,MAAM,iBAAiB,WAAW,KAAG,QAAQ,QAAQ,CAAC;4BAG5D,MAAM,iBAAiB,WAAW,KAAG,QAAQ,QAAQ,CAAC;CAGjF,CAAC"}

package/out/fetch/fetch.js

@@ -11,7 +11,7 @@ const parseBodyAndHeaders = (init) => tslib_1.__awaiter(void 0, void 0, void 0,
         headers: new Headers(headers)
     };
 });
-exports.productFetchApi = (callBridge) => {
+const productFetchApi = (callBridge) => {
     const fetch = (product, restPath, init) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
         const { body: requestBody, headers: requestHeaders } = yield parseBodyAndHeaders(init);
         if (!requestHeaders.has('X-Atlassian-Token')) {
@@ -30,3 +30,4 @@ exports.productFetchApi = (callBridge) => {
         requestJira: (restPath, fetchOptions) => fetch('jira', restPath, fetchOptions)
     };
 };
+exports.productFetchApi = productFetchApi;

package/out/fetch/index.d.ts

@@ -1,2 +1,2 @@
-export declare const requestConfluence: (restPath: string, fetchOptions?: RequestInit | undefined) => Promise<Response>, requestJira: (restPath: string, fetchOptions?: RequestInit | undefined) => Promise<Response>;
+export declare const requestConfluence: (restPath: string, fetchOptions?: RequestInit) => Promise<Response>, requestJira: (restPath: string, fetchOptions?: RequestInit) => Promise<Response>;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fetch/index.ts"],"names":[],"mappings":"AAQA,eAAO,MAAQ,iBAAiB,aAJA,MAAM,6CAAiC,OAAO,CAAC,QAAQ,CAAC,EAItD,WAAW,aAHnB,MAAM,6CAAiC,OAAO,CAAC,QAAQ,CAGoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fetch/index.ts"],"names":[],"mappings":"AAQA,eAAO,MAAQ,iBAAiB,aAJA,MAAM,iBAAiB,WAAW,KAAK,QAAQ,QAAQ,CAAC,EAItD,WAAW,aAHnB,MAAM,iBAAiB,WAAW,KAAK,QAAQ,QAAQ,CAGoB,CAAC"}

package/out/fetch/index.js

@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.requestJira = exports.requestConfluence = void 0;
 const bridge_1 = require("../bridge");
 const fetch_1 = require("./fetch");
-_a = fetch_1.productFetchApi(bridge_1.getCallBridge()), exports.requestConfluence = _a.requestConfluence, exports.requestJira = _a.requestJira;
+_a = (0, fetch_1.productFetchApi)((0, bridge_1.getCallBridge)()), exports.requestConfluence = _a.requestConfluence, exports.requestJira = _a.requestJira;

package/out/flag/flag.js

@@ -4,8 +4,8 @@ exports.showFlag = void 0;
 const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
 const errors_1 = require("../errors");
-const callBridge = bridge_1.getCallBridge();
-exports.showFlag = (options) => {
+const callBridge = (0, bridge_1.getCallBridge)();
+const showFlag = (options) => {
     var _a;
     if (!options.id) {
         throw new errors_1.BridgeAPIError('"id" must be defined in flag options');
@@ -18,3 +18,4 @@ exports.showFlag = (options) => {
         })
     };
 };
+exports.showFlag = showFlag;

package/out/flag/index.js

@@ -1,4 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.showFlag = void 0;
 var flag_1 = require("./flag");
 Object.defineProperty(exports, "showFlag", { enumerable: true, get: function () { return flag_1.showFlag; } });

package/out/invoke/invoke.js

@@ -4,7 +4,7 @@ exports.invoke = void 0;
 const bridge_1 = require("../bridge");
 const errors_1 = require("../errors");
 const utils_1 = require("../utils");
-const callBridge = bridge_1.getCallBridge();
+const callBridge = (0, bridge_1.getCallBridge)();
 const validatePayload = (payload) => {
     if (!payload)
         return;
@@ -19,4 +19,4 @@ const _invoke = (functionKey, payload) => {
     validatePayload(payload);
     return callBridge('invoke', { functionKey, payload });
 };
-exports.invoke = utils_1.withRateLimiter(_invoke, 20, 2000, 'Resolver calls are rate limited at 20req/2s');
+exports.invoke = (0, utils_1.withRateLimiter)(_invoke, 20, 2000, 'Resolver calls are rate limited at 20req/2s');

package/out/modal/modal.js

@@ -4,7 +4,7 @@ exports.Modal = void 0;
 const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
 const errors_1 = require("../errors");
-const callBridge = bridge_1.getCallBridge();
+const callBridge = (0, bridge_1.getCallBridge)();
 const noop = () => { };
 class Modal {
     constructor(opts) {

package/out/router/router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/router/router.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,MAAM;oBANG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;gBAE5B,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;kBAEtB,OAAO,CAAC,IAAI,CAAC;CAMhC,CAAC"}
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/router/router.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,MAAM;oBANG,MAAM,KAAK,QAAQ,IAAI,CAAC;gBAE5B,MAAM,KAAK,QAAQ,IAAI,CAAC;kBAEtB,QAAQ,IAAI,CAAC;CAMhC,CAAC"}

package/out/router/router.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.router = void 0;
 const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
-const callBridge = bridge_1.getCallBridge();
+const callBridge = (0, bridge_1.getCallBridge)();
 const navigate = (url) => tslib_1.__awaiter(void 0, void 0, void 0, function* () { return callBridge('navigate', { url, type: 'same-tab' }); });
 const open = (url) => tslib_1.__awaiter(void 0, void 0, void 0, function* () { return callBridge('navigate', { url, type: 'new-tab' }); });
 const reload = () => tslib_1.__awaiter(void 0, void 0, void 0, function* () { return callBridge('reload'); });

package/out/types.d.ts

@@ -5,8 +5,25 @@ export declare type InvokeResponse = Record<string, any> | void;
 export declare type ProductFetchResponse = {
     body?: string;
 } & Pick<ResponseInit, 'headers' | 'status' | 'statusText'>;
-export declare type FullContext = {};
+export interface FullContext {
+    accountId?: string;
+    cloudId?: string;
+    extension: ExtensionData;
+    license?: LicenseState;
+    localId: string;
+    locale: string;
+    moduleKey: string;
+    siteUrl: string;
+    timezone: string;
+}
+interface ExtensionData {
+    [k: string]: any;
+}
+interface LicenseState {
+    isActive?: boolean;
+}
 export declare type Subscription = {
     unsubscribe: () => void;
 };
+export {};
 //# sourceMappingURL=types.d.ts.map

package/out/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,aAAa,GAAG;KACzB,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;CAC9B,CAAC;AAEF,oBAAY,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;AAExD,oBAAY,oBAAoB,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,YAAY,EAAE,SAAS,GAAG,QAAQ,GAAG,YAAY,CAAC,CAAC;AAE/G,oBAAY,WAAW,GAAG,EAAE,CAAC;AAE7B,oBAAY,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,aAAa,GAAG;KACzB,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;CAC9B,CAAC;AAEF,oBAAY,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;AAExD,oBAAY,oBAAoB,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,YAAY,EAAE,SAAS,GAAG,QAAQ,GAAG,YAAY,CAAC,CAAC;AAE/G,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,oBAAY,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB,CAAC"}

package/out/utils/index.d.ts

@@ -1,2 +1,2 @@
-export declare const withRateLimiter: <Fn extends (...args: any[]) => any>(wrappedFn: Fn, maxOps: number, intervalInMs: number, exceededErrorMessage?: string | undefined) => <T>(...args: Parameters<Fn>) => Promise<T>;
+export declare const withRateLimiter: <Fn extends (...args: any[]) => any>(wrappedFn: Fn, maxOps: number, intervalInMs: number, exceededErrorMessage?: string) => <T>(...args: Parameters<Fn>) => Promise<T>;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe,wBAAyB,GAAG,EAAE,KAAK,GAAG,yBAExD,MAAM,gBACA,MAAM,0FAsBrB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe,wBAAyB,GAAG,EAAE,KAAK,GAAG,yBAExD,MAAM,gBACA,MAAM,yBACG,MAAM,+CAqB9B,CAAC"}

package/out/utils/index.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.withRateLimiter = void 0;
 const tslib_1 = require("tslib");
 const errors_1 = require("../errors");
-exports.withRateLimiter = (wrappedFn, maxOps, intervalInMs, exceededErrorMessage) => {
+const withRateLimiter = (wrappedFn, maxOps, intervalInMs, exceededErrorMessage) => {
     let start = Date.now();
     let numOps = 0;
     return (...args) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
@@ -20,3 +20,4 @@ exports.withRateLimiter = (wrappedFn, maxOps, intervalInMs, exceededErrorMessage
         return wrappedFn(...args);
     });
 };
+exports.withRateLimiter = withRateLimiter;

package/out/view/close.js

@@ -4,8 +4,8 @@ exports.close = void 0;
 const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
 const errors_1 = require("../errors");
-const callBridge = bridge_1.getCallBridge();
-exports.close = (payload) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+const callBridge = (0, bridge_1.getCallBridge)();
+const close = (payload) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
     try {
         const success = yield callBridge('close', payload);
         if (success === false) {
@@ -16,3 +16,4 @@ exports.close = (payload) => tslib_1.__awaiter(void 0, void 0, void 0, function*
         throw new errors_1.BridgeAPIError("this resource's view is not closable.");
     }
 });
+exports.close = close;

package/out/view/createHistory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createHistory.d.ts","sourceRoot":"","sources":["../../src/view/createHistory.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAIvC,eAAO,MAAM,aAAa,QAAa,OAAO,CAAC,OAAO,CAOrD,CAAC"}
+{"version":3,"file":"createHistory.d.ts","sourceRoot":"","sources":["../../src/view/createHistory.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAIvC,eAAO,MAAM,aAAa,QAAa,QAAQ,OAAO,CAOrD,CAAC"}

package/out/view/createHistory.js

@@ -3,11 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createHistory = void 0;
 const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
-const callBridge = bridge_1.getCallBridge();
-exports.createHistory = () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+const callBridge = (0, bridge_1.getCallBridge)();
+const createHistory = () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
     const history = yield callBridge('createHistory');
     history.listen((location) => {
         history.location = location;
     });
     return history;
 });
+exports.createHistory = createHistory;

package/out/view/getContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getContext.d.ts","sourceRoot":"","sources":["../../src/view/getContext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAIvC,eAAO,MAAM,UAAU,QAAO,OAAO,CAAC,WAAW,CAEhD,CAAC"}
+{"version":3,"file":"getContext.d.ts","sourceRoot":"","sources":["../../src/view/getContext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAIvC,eAAO,MAAM,UAAU,QAAO,QAAQ,WAAW,CAEhD,CAAC"}

package/out/view/getContext.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getContext = void 0;
 const bridge_1 = require("../bridge");
-const callBridge = bridge_1.getCallBridge();
-exports.getContext = () => {
+const callBridge = (0, bridge_1.getCallBridge)();
+const getContext = () => {
     return callBridge('getContext');
 };
+exports.getContext = getContext;

package/out/view/refresh.js

@@ -4,10 +4,11 @@ exports.refresh = void 0;
 const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
 const errors_1 = require("../errors");
-const callBridge = bridge_1.getCallBridge();
-exports.refresh = (payload) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+const callBridge = (0, bridge_1.getCallBridge)();
+const refresh = (payload) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
     const success = yield callBridge('refresh', payload);
     if (success === false) {
         throw new errors_1.BridgeAPIError("this resource's view is not refreshable.");
     }
 });
+exports.refresh = refresh;

package/out/view/submit.js

@@ -4,10 +4,11 @@ exports.submit = void 0;
 const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
 const errors_1 = require("../errors");
-const callBridge = bridge_1.getCallBridge();
-exports.submit = (payload) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+const callBridge = (0, bridge_1.getCallBridge)();
+const submit = (payload) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
     const success = yield callBridge('submit', payload);
     if (success === false) {
         throw new errors_1.BridgeAPIError("this resource's view is not submittable.");
     }
 });
+exports.submit = submit;

package/package.json

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