@forge/bridge 2.1.2 → 2.2.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @forge/bridge
 
+## 2.2.0-next.0
+
+### Minor Changes
+
+- 6fe60823: Ability to disable close on escape and overlay click for modals
+
+## 2.1.3
+
+### Patch Changes
+
+- 7c11b22: Improve error message for when the Custom UI bridge is not available
+
+## 2.1.3-next.0
+
+### Patch Changes
+
+- 7c11b22: Improve error message for when the Custom UI bridge is not available
+
 ## 2.1.2
 
 ### Patch Changes

package/out/bridge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bridge.d.ts","sourceRoot":"","sources":["../src/bridge.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,QAAO,MAAM,CAAC,UAAU,CAAC,CAAC,YAAY,CAE/D,CAAC"}
+{"version":3,"file":"bridge.d.ts","sourceRoot":"","sources":["../src/bridge.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,aAAa,QAAO,MAAM,CAAC,UAAU,CAAC,CAAC,YAAY,CAS/D,CAAC"}

package/out/bridge.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCallBridge = void 0;
+const errors_1 = require("./errors");
+function isBridgeAvailable(bridge) {
+    return !!(bridge === null || bridge === void 0 ? void 0 : bridge.callBridge);
+}
 exports.getCallBridge = () => {
+    if (!isBridgeAvailable(window.__bridge)) {
+        throw new errors_1.BridgeAPIError(`
+      Unable to establish a connection with the Custom UI bridge.
+      If you are trying to run your app locally, Forge apps only work in the context of Atlassian products. Refer to https://go.atlassian.com/forge-tunneling-with-custom-ui for how to tunnel when using a local development server.
+    `);
+    }
     return window.__bridge.callBridge;
 };

package/out/modal/modal.d.ts

@@ -3,12 +3,16 @@ export interface ModalOptions {
     onClose?: (payload: any) => any;
     size?: string;
     context?: any;
+    closeOnEscape?: boolean;
+    closeOnOverlayClick?: boolean;
 }
 export declare class Modal {
     resource: string | null;
     onClose: NonNullable<ModalOptions['onClose']>;
     size: string;
     context: any;
+    closeOnEscape: boolean;
+    closeOnOverlayClick: boolean;
     constructor(opts?: ModalOptions);
     open(): Promise<void>;
 }

package/out/modal/modal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"modal.d.ts","sourceRoot":"","sources":["../../src/modal/modal.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,GAAG,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;CACf;AAKD,qBAAa,KAAK;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,GAAG,CAAC;gBACD,IAAI,CAAC,EAAE,YAAY;IAOzB,IAAI;CAgBX"}
+{"version":3,"file":"modal.d.ts","sourceRoot":"","sources":["../../src/modal/modal.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,GAAG,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAKD,qBAAa,KAAK;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,GAAG,CAAC;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;gBACjB,IAAI,CAAC,EAAE,YAAY;IASzB,IAAI;CAkBX"}

package/out/modal/modal.js

@@ -8,10 +8,13 @@ const callBridge = bridge_1.getCallBridge();
 const noop = () => { };
 class Modal {
     constructor(opts) {
+        var _a, _b;
         this.resource = (opts === null || opts === void 0 ? void 0 : opts.resource) || null;
         this.onClose = (opts === null || opts === void 0 ? void 0 : opts.onClose) || noop;
         this.size = (opts === null || opts === void 0 ? void 0 : opts.size) || 'medium';
         this.context = (opts === null || opts === void 0 ? void 0 : opts.context) || {};
+        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* () {
@@ -20,7 +23,9 @@ class Modal {
                     resource: this.resource,
                     onClose: this.onClose,
                     size: this.size,
-                    context: this.context
+                    context: this.context,
+                    closeOnEscape: this.closeOnEscape,
+                    closeOnOverlayClick: this.closeOnOverlayClick
                 });
                 if (success === false) {
                     throw new errors_1.BridgeAPIError('Unable to open modal.');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "2.1.2",
+  "version": "2.2.0-next.0",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -16,7 +16,7 @@
   },
   "devDependencies": {
     "history": "4.10.1",
-    "jest-date-mock": "^1.0.8",
-    "isomorphic-fetch": "^3.0.0"
+    "isomorphic-fetch": "^3.0.0",
+    "jest-date-mock": "^1.0.8"
   }
 }