@forge/bridge 3.4.0 → 3.5.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @forge/bridge
 
+## 3.5.0-next.0
+
+### Minor Changes
+
+- ef55008: Add frame.onPropsUpdate to consume property changes for custom props enabled Frame components
+
+  For more information, see the [Frame component documentation](https://developer.atlassian.com/platform/forge/ui-kit/components/frame).
+
 ## 3.4.0
 
 ### Minor Changes

package/out/internal/index.d.ts

@@ -0,0 +1,3 @@
+declare const getFrameId: () => Promise<string | null>;
+export { getFrameId };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":"AAIA,QAAA,MAAM,UAAU,8BAEf,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/out/internal/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFrameId = void 0;
+const bridge_1 = require("../bridge");
+const callBridge = (0, bridge_1.getCallBridge)();
+const getFrameId = () => {
+    return callBridge('getFrameId');
+};
+exports.getFrameId = getFrameId;

package/out/view/frame.d.ts

@@ -0,0 +1,7 @@
+declare type OnFramePropsUpdateHandler<TFrameProps> = (props: TFrameProps) => void;
+declare type Unsubscribe = () => Promise<void>;
+export declare const frame: {
+    onPropsUpdate: <TFrameProps extends Record<string, unknown>>(handler: OnFramePropsUpdateHandler<TFrameProps>) => Promise<Unsubscribe>;
+};
+export {};
+//# sourceMappingURL=frame.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"frame.d.ts","sourceRoot":"","sources":["../../src/view/frame.ts"],"names":[],"mappings":"AAKA,aAAK,yBAAyB,CAAC,WAAW,IAAI,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAC;AAC3E,aAAK,WAAW,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AA6BvC,eAAO,MAAM,KAAK;qHAjBf,QAAQ,WAAW,CAAC;CAmBtB,CAAC"}

package/out/view/frame.js

@@ -0,0 +1,25 @@
+"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)();
+    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;
+        subscription.unsubscribe();
+    });
+    void events_1.events.emit(frameEventKey(EVENT_KEY_FRAME_LOADED, frameId), { loaded: true });
+    return unsubscribe;
+});
+exports.frame = {
+    onPropsUpdate
+};

package/out/view/view.d.ts

@@ -7,5 +7,8 @@ export declare const view: {
     theme: {
         enable: () => Promise<void>;
     };
+    frame: {
+        onPropsUpdate: <TFrameProps extends Record<string, unknown>>(handler: (props: TFrameProps) => void) => Promise<() => 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":"AAOA,eAAO,MAAM,IAAI;;;;;;;;;CAOhB,CAAC"}
+{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/view/view.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,IAAI;;;;;;;;;;;;CAQhB,CAAC"}

package/out/view/view.js

@@ -7,11 +7,13 @@ const refresh_1 = require("./refresh");
 const createHistory_1 = require("./createHistory");
 const getContext_1 = require("./getContext");
 const theme_1 = require("./theme");
+const frame_1 = require("./frame");
 exports.view = {
     submit: submit_1.submit,
     close: close_1.close,
     refresh: refresh_1.refresh,
     createHistory: createHistory_1.createHistory,
     getContext: getContext_1.getContext,
-    theme: theme_1.theme
+    theme: theme_1.theme,
+    frame: frame_1.frame
 };

package/package.json

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