@forge/bridge 4.0.0 → 4.1.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @forge/bridge
 
+## 4.1.0-next.1
+
+### Minor Changes
+
+- 02b6246: added changeWindowTitle in the `view` module
+
+## 4.0.1-next.0
+
+### Patch Changes
+
+- 04ef35e: Upgrade target to ES2018
+
 ## 4.0.0
 
 ### Major Changes

package/out/fetch/fetch.js

@@ -1,15 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.productFetchApi = void 0;
-const tslib_1 = require("tslib");
 const blobParser_1 = require("../utils/blobParser");
-const parseFormData = (form) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+const parseFormData = async (form) => {
     const parsed = {};
     for (const [key, value] of form.entries()) {
         if (key === 'file') {
             const fileName = value.name;
             const fileType = value.type;
-            parsed['file'] = yield (0, blobParser_1.blobToBase64)(value);
+            parsed['file'] = await (0, blobParser_1.blobToBase64)(value);
             parsed['__fileName'] = fileName;
             parsed['__fileType'] = fileType;
         }
@@ -18,35 +17,39 @@ const parseFormData = (form) => tslib_1.__awaiter(void 0, void 0, void 0, functi
         }
     }
     return JSON.stringify(parsed);
-});
-const parseRequest = (init) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+};
+const parseRequest = async (init) => {
     const isFormData = (init === null || init === void 0 ? void 0 : init.body) instanceof FormData ? true : false;
-    const requestBody = isFormData ? yield parseFormData(init === null || init === void 0 ? void 0 : init.body) : init === null || init === void 0 ? void 0 : init.body;
+    const requestBody = isFormData ? await parseFormData(init === null || init === void 0 ? void 0 : init.body) : init === null || init === void 0 ? void 0 : init.body;
     const req = new Request('', { body: requestBody, method: init === null || init === void 0 ? void 0 : init.method, headers: init === null || init === void 0 ? void 0 : init.headers });
     const headers = Object.fromEntries(req.headers.entries());
-    const body = req.method !== 'GET' ? yield req.text() : null;
+    const body = req.method !== 'GET' ? await req.text() : null;
     return {
         body,
         headers: new Headers(headers),
         isMultipartFormData: isFormData
     };
-});
+};
 const productFetchApi = (callBridge) => {
-    const fetch = (product, restPath, init) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-        const { body: requestBody, headers: requestHeaders, isMultipartFormData } = yield parseRequest(init);
+    const fetch = async (product, restPath, init) => {
+        const { body: requestBody, headers: requestHeaders, isMultipartFormData } = await parseRequest(init);
         if (!requestHeaders.has('X-Atlassian-Token')) {
             requestHeaders.set('X-Atlassian-Token', 'no-check');
         }
         const fetchPayload = {
             product,
             restPath,
-            fetchRequestInit: Object.assign(Object.assign({}, init), { body: requestBody, headers: [...requestHeaders.entries()] }),
+            fetchRequestInit: {
+                ...init,
+                body: requestBody,
+                headers: [...requestHeaders.entries()]
+            },
             isMultipartFormData
         };
-        const { body, headers, statusText, status, isAttachment } = yield callBridge('fetchProduct', fetchPayload);
+        const { body, headers, statusText, status, isAttachment } = await callBridge('fetchProduct', fetchPayload);
         const responseBody = isAttachment ? (0, blobParser_1.base64ToBlob)(body, headers['content-type']) : body;
         return new Response(responseBody || null, { headers, status, statusText });
-    });
+    };
     return {
         requestConfluence: (restPath, fetchOptions) => fetch('confluence', restPath, fetchOptions),
         requestJira: (restPath, fetchOptions) => fetch('jira', restPath, fetchOptions),

package/out/flag/flag.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.showFlag = void 0;
-const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
 const errors_1 = require("../errors");
 const callBridge = (0, bridge_1.getCallBridge)();
@@ -10,12 +9,15 @@ const showFlag = (options) => {
     if (!options.id) {
         throw new errors_1.BridgeAPIError('"id" must be defined in flag options');
     }
-    const result = callBridge('showFlag', Object.assign(Object.assign({}, options), { type: (_a = options.type) !== null && _a !== void 0 ? _a : 'info' }));
+    const result = callBridge('showFlag', {
+        ...options,
+        type: (_a = options.type) !== null && _a !== void 0 ? _a : 'info'
+    });
     return {
-        close: () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-            yield result;
+        close: async () => {
+            await result;
             return callBridge('closeFlag', { id: options.id });
-        })
+        }
     };
 };
 exports.showFlag = showFlag;

package/out/i18n/index.js

@@ -1,50 +1,49 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createTranslationFunction = exports.getTranslations = exports.resetTranslationsCache = void 0;
-const tslib_1 = require("tslib");
 const i18n_1 = require("@forge/i18n");
 const view_1 = require("../view");
 const frontendResourcesAccessor = {
-    getI18nInfoConfig: () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-        const resp = yield fetch(`./${i18n_1.I18N_BUNDLE_FOLDER_NAME}/${i18n_1.I18N_INFO_FILE_NAME}`);
+    getI18nInfoConfig: async () => {
+        const resp = await fetch(`./${i18n_1.I18N_BUNDLE_FOLDER_NAME}/${i18n_1.I18N_INFO_FILE_NAME}`);
         if (!resp.ok) {
             throw new Error('Failed to get i18n info config: ' + resp.statusText);
         }
-        const info = (yield resp.json());
+        const info = (await resp.json());
         return info.config;
-    }),
-    getTranslationResource: (locale) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-        const resp = yield fetch(`./${i18n_1.I18N_BUNDLE_FOLDER_NAME}/${locale}.json`);
+    },
+    getTranslationResource: async (locale) => {
+        const resp = await fetch(`./${i18n_1.I18N_BUNDLE_FOLDER_NAME}/${locale}.json`);
         if (!resp.ok) {
             throw new Error(`Failed to get translation resource for locale: ${locale}`);
         }
         return resp.json();
-    })
+    }
 };
 const translationsGetter = new i18n_1.TranslationsGetter(frontendResourcesAccessor);
 const resetTranslationsCache = () => {
     translationsGetter.reset();
 };
 exports.resetTranslationsCache = resetTranslationsCache;
-const getTranslations = (locale = null, options = {
+const getTranslations = async (locale = null, options = {
     fallback: true
-}) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+}) => {
     let targetLocale = locale;
     if (!targetLocale) {
-        const context = yield view_1.view.getContext();
+        const context = await view_1.view.getContext();
         targetLocale = context.locale;
     }
-    return yield translationsGetter.getTranslations(targetLocale, options);
-});
+    return await translationsGetter.getTranslations(targetLocale, options);
+};
 exports.getTranslations = getTranslations;
-const createTranslationFunction = (locale = null) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+const createTranslationFunction = async (locale = null) => {
     let targetLocale = locale;
     if (!targetLocale) {
-        const context = yield view_1.view.getContext();
+        const context = await view_1.view.getContext();
         targetLocale = context.locale;
     }
     const translator = new i18n_1.Translator(targetLocale, translationsGetter);
-    yield translator.init();
+    await translator.init();
     return (i18nKey, defaultValue) => { var _a, _b; return (_b = (_a = translator.translate(i18nKey)) !== null && _a !== void 0 ? _a : defaultValue) !== null && _b !== void 0 ? _b : i18nKey; };
-});
+};
 exports.createTranslationFunction = createTranslationFunction;

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

@@ -1,7 +1,6 @@
 "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");
@@ -15,11 +14,11 @@ const validatePayload = (payload) => {
         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* () {
+const _invokeRemote = async (input) => {
     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));
+    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])) {
@@ -28,5 +27,5 @@ const _invokeRemote = (input) => tslib_1.__awaiter(void 0, void 0, void 0, funct
         }
     }
     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/out/modal/modal.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Modal = void 0;
-const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
 const errors_1 = require("../errors");
 const callBridge = (0, bridge_1.getCallBridge)();
@@ -16,25 +15,23 @@ class Modal {
         this.closeOnEscape = (_a = opts === null || opts === void 0 ? void 0 : opts.closeOnEscape) !== null && _a !== void 0 ? _a : true;
         this.closeOnOverlayClick = (_b = opts === null || opts === void 0 ? void 0 : opts.closeOnOverlayClick) !== null && _b !== void 0 ? _b : true;
     }
-    open() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            try {
-                const success = yield callBridge('openModal', {
-                    resource: this.resource,
-                    onClose: this.onClose,
-                    size: this.size,
-                    context: this.context,
-                    closeOnEscape: this.closeOnEscape,
-                    closeOnOverlayClick: this.closeOnOverlayClick
-                });
-                if (success === false) {
-                    throw new errors_1.BridgeAPIError('Unable to open modal.');
-                }
-            }
-            catch (err) {
+    async open() {
+        try {
+            const success = await callBridge('openModal', {
+                resource: this.resource,
+                onClose: this.onClose,
+                size: this.size,
+                context: this.context,
+                closeOnEscape: this.closeOnEscape,
+                closeOnOverlayClick: this.closeOnOverlayClick
+            });
+            if (success === false) {
                 throw new errors_1.BridgeAPIError('Unable to open modal.');
             }
-        });
+        }
+        catch (err) {
+            throw new errors_1.BridgeAPIError('Unable to open modal.');
+        }
     }
 }
 exports.Modal = Modal;

package/out/router/router.js

@@ -1,12 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.router = void 0;
-const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
 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'); });
+const navigate = async (url) => callBridge('navigate', { url, type: 'same-tab' });
+const open = async (url) => callBridge('navigate', { url, type: 'new-tab' });
+const reload = async () => callBridge('reload');
 exports.router = {
     navigate,
     open,

package/out/utils/index.js

@@ -1,12 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withRateLimiter = void 0;
-const tslib_1 = require("tslib");
 const errors_1 = require("../errors");
 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* () {
+    return async (...args) => {
         const now = Date.now();
         const elapsed = now - start;
         if (elapsed > intervalInMs) {
@@ -18,6 +17,6 @@ const withRateLimiter = (wrappedFn, maxOps, intervalInMs, exceededErrorMessage)
         }
         numOps = numOps + 1;
         return wrappedFn(...args);
-    });
+    };
 };
 exports.withRateLimiter = withRateLimiter;

package/out/view/changeWindowTitle.d.ts

@@ -0,0 +1,2 @@
+export declare const changeWindowTitle: (title: string) => Promise<void>;
+//# sourceMappingURL=changeWindowTitle.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"changeWindowTitle.d.ts","sourceRoot":"","sources":["../../src/view/changeWindowTitle.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,iBAAiB,UAAiB,MAAM,kBAMpD,CAAC"}

package/out/view/changeWindowTitle.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.changeWindowTitle = void 0;
+const bridge_1 = require("../bridge");
+const errors_1 = require("../errors");
+const callBridge = (0, bridge_1.getCallBridge)();
+const changeWindowTitle = async (title) => {
+    try {
+        await callBridge('changeWindowTitle', title);
+    }
+    catch (e) {
+        throw new errors_1.BridgeAPIError("the window title wasn't changed due to error.");
+    }
+};
+exports.changeWindowTitle = changeWindowTitle;

package/out/view/close.js

@@ -1,13 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.close = void 0;
-const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
 const errors_1 = require("../errors");
 const callBridge = (0, bridge_1.getCallBridge)();
-const close = (payload) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+const close = async (payload) => {
     try {
-        const success = yield callBridge('close', payload);
+        const success = await callBridge('close', payload);
         if (success === false) {
             throw new errors_1.BridgeAPIError("this resource's view is not closable.");
         }
@@ -15,5 +14,5 @@ const close = (payload) => tslib_1.__awaiter(void 0, void 0, void 0, function* (
     catch (e) {
         throw new errors_1.BridgeAPIError("this resource's view is not closable.");
     }
-});
+};
 exports.close = close;

package/out/view/createHistory.js

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

package/out/view/frame.js

@@ -1,25 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.frame = void 0;
-const tslib_1 = require("tslib");
 const internal_1 = require("../internal");
 const events_1 = require("../events");
 const frameEventKey = (eventKey, frameId) => `frame:${eventKey}:${frameId}`;
 const EVENT_KEY_FRAME_PROPS = 'props';
 const EVENT_KEY_FRAME_LOADED = 'loaded';
-const onPropsUpdate = (handler) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    const frameId = yield (0, internal_1.getFrameId)();
+const onPropsUpdate = async (handler) => {
+    const frameId = await (0, internal_1.getFrameId)();
     if (!frameId) {
         throw new Error('Frame could not be found, please ensure the custom props enabled Frame component is set up correctly.');
     }
     const sub = events_1.events.on(frameEventKey(EVENT_KEY_FRAME_PROPS, frameId), handler);
-    const unsubscribe = () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-        const subscription = yield sub;
+    const unsubscribe = async () => {
+        const subscription = await sub;
         subscription.unsubscribe();
-    });
+    };
     void events_1.events.emit(frameEventKey(EVENT_KEY_FRAME_LOADED, frameId), { loaded: true });
     return unsubscribe;
-});
+};
 exports.frame = {
     onPropsUpdate
 };

package/out/view/getContext.js

@@ -1,17 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getContext = void 0;
-const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
 const i18n_1 = require("@forge/i18n");
 const callBridge = (0, bridge_1.getCallBridge)();
-const getContext = () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+const getContext = async () => {
     var _a;
-    const context = yield callBridge('getContext');
+    const context = await callBridge('getContext');
     const locale = context === null || context === void 0 ? void 0 : context.locale;
     if (locale) {
         context.locale = (_a = (0, i18n_1.ensureLocale)(locale)) !== null && _a !== void 0 ? _a : locale;
     }
     return context;
-});
+};
 exports.getContext = getContext;

package/out/view/refresh.js

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.refresh = void 0;
-const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
 const errors_1 = require("../errors");
 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);
+const refresh = async (payload) => {
+    const success = await 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

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.submit = void 0;
-const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
 const errors_1 = require("../errors");
 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);
+const submit = async (payload) => {
+    const success = await callBridge('submit', payload);
     if (success === false) {
         throw new errors_1.BridgeAPIError("this resource's view is not submittable.");
     }
-});
+};
 exports.submit = submit;

package/out/view/view.d.ts

@@ -10,5 +10,6 @@ export declare const view: {
     frame: {
         onPropsUpdate: <TFrameProps extends Record<string, unknown>>(handler: (props: TFrameProps) => void) => Promise<() => Promise<void>>;
     };
+    changeWindowTitle: (title: string) => Promise<void>;
 };
 //# sourceMappingURL=view.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/view/view.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,IAAI;;;;;;;;;;;;CAQhB,CAAC"}
+{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/view/view.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,IAAI;;;;;;;;;;;;;CAShB,CAAC"}

package/out/view/view.js

@@ -6,6 +6,7 @@ const close_1 = require("./close");
 const refresh_1 = require("./refresh");
 const createHistory_1 = require("./createHistory");
 const getContext_1 = require("./getContext");
+const changeWindowTitle_1 = require("./changeWindowTitle");
 const theme_1 = require("./theme");
 const frame_1 = require("./frame");
 exports.view = {
@@ -15,5 +16,6 @@ exports.view = {
     createHistory: createHistory_1.createHistory,
     getContext: getContext_1.getContext,
     theme: theme_1.theme,
-    frame: frame_1.frame
+    frame: frame_1.frame,
+    changeWindowTitle: changeWindowTitle_1.changeWindowTitle
 };

package/package.json

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