@forge/bridge 2.1.2 → 2.1.3-next.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/bridge
 
+## 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "2.1.2",
+  "version": "2.1.3-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"
   }
 }