@forge/bridge 5.16.3-next.0-experimental-4a332af → 5.17.0-next.10

package/CHANGELOG.md

@@ -1,13 +1,73 @@
 # @forge/bridge
 
-## 5.16.3-next.0-experimental-4a332af
+## 5.17.0-next.10
 
 ### Patch Changes
 
-- aa757af: Module add
-- dba5074: Send adf doc when ready for createAdfRendererIframeProps
-- Updated dependencies [aa757af]
-  - @forge/manifest@12.8.0-experimental-4a332af
+- Updated dependencies [ee691bf]
+  - @forge/manifest@12.9.0-next.6
+
+## 5.17.0-next.9
+
+### Patch Changes
+
+- Updated dependencies [8197e66]
+  - @forge/manifest@12.9.0-next.5
+
+## 5.17.0-next.8
+
+### Patch Changes
+
+- Updated dependencies [4493006]
+  - @forge/manifest@12.9.0-next.4
+
+## 5.17.0-next.7
+
+### Patch Changes
+
+- Updated dependencies [723fab8]
+- Updated dependencies [9f3add6]
+  - @forge/manifest@12.9.0-next.3
+
+## 5.17.0-next.6
+
+### Minor Changes
+
+- fc55c83: Add `getFrameDispatch` method to `view` module. The method fetches the dispatch prop passed to Frame inside the frame resource.
+
+## 5.17.0-next.5
+
+### Patch Changes
+
+- Updated dependencies [b7b1f36]
+  - @forge/manifest@12.8.1-next.2
+
+## 5.17.0-next.4
+
+### Minor Changes
+
+- f7f06c8: Add resizable to modal named sizes type
+
+## 5.17.0-next.3
+
+### Patch Changes
+
+- Updated dependencies [5beb8ad]
+- Updated dependencies [f1f11f0]
+  - @forge/manifest@12.8.1-next.1
+
+## 5.17.0-next.2
+
+### Patch Changes
+
+- Updated dependencies [ccdcfc3]
+  - @forge/manifest@12.8.1-next.0
+
+## 5.17.0-next.1
+
+### Minor Changes
+
+- 3cf97c3: Extend forge/bridge modal types with custom dimensions
 
 ## 5.16.3-next.0
 

package/out/modal/modal.d.ts

@@ -1,7 +1,14 @@
+declare const NAMED_MODAL_SIZES: readonly ["small", "medium", "large", "xlarge", "max", "fullscreen", "resizable"];
+declare type NamedModalSize = (typeof NAMED_MODAL_SIZES)[number];
+declare type CustomModalSize = {
+    width: string;
+    height?: string;
+};
+export declare type ModalSizes = NamedModalSize | CustomModalSize;
 export interface ModalOptions {
     resource?: string | null;
     onClose?: (payload: any) => any;
-    size?: string;
+    size?: ModalSizes;
     context?: any;
     closeOnEscape?: boolean;
     closeOnOverlayClick?: boolean;
@@ -11,7 +18,7 @@ export interface ModalOptions {
 export declare class Modal {
     resource: string | null;
     onClose: NonNullable<ModalOptions['onClose']>;
-    size: string;
+    size: ModalSizes;
     context: any;
     closeOnEscape: boolean;
     closeOnOverlayClick: boolean;
@@ -20,4 +27,5 @@ export declare class Modal {
     constructor(opts?: ModalOptions);
     open(): Promise<void>;
 }
+export {};
 //# sourceMappingURL=modal.d.ts.map

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;IACd,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,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;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;gBACD,IAAI,CAAC,EAAE,YAAY;IAWzB,IAAI;CAoBX"}
+{"version":3,"file":"modal.d.ts","sourceRoot":"","sources":["../../src/modal/modal.ts"],"names":[],"mappings":"AAKA,QAAA,MAAM,iBAAiB,mFAAoF,CAAC;AAC5G,aAAK,cAAc,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzD,aAAK,eAAe,GAAG;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,oBAAY,UAAU,GAAG,cAAc,GAAG,eAAe,CAAC;AAE1D,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,UAAU,CAAC;IAClB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAmBD,qBAAa,KAAK;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9C,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,GAAG,CAAC;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;gBACD,IAAI,CAAC,EAAE,YAAY;IAWzB,IAAI;CA0BX"}

package/out/modal/modal.js

@@ -4,8 +4,21 @@ exports.Modal = void 0;
 const bridge_1 = require("../bridge");
 const errors_1 = require("../errors");
 const callBridge = (0, bridge_1.getCallBridge)();
+const NAMED_MODAL_SIZES = ['small', 'medium', 'large', 'xlarge', 'max', 'fullscreen', 'resizable'];
 // eslint-disable-next-line @typescript-eslint/no-empty-function
 const noop = () => { };
+function isNamedModalSize(size) {
+    return typeof size === 'string' && NAMED_MODAL_SIZES.includes(size);
+}
+function isCustomModalSize(size) {
+    if (typeof size !== 'object' || size === null)
+        return false;
+    const s = size;
+    return typeof s.width === 'string' && (s.height === undefined || typeof s.height === 'string');
+}
+function isValidModalSize(size) {
+    return isNamedModalSize(size) || isCustomModalSize(size);
+}
 class Modal {
     constructor(opts) {
         var _a, _b;
@@ -19,6 +32,9 @@ class Modal {
         this.icon = (opts === null || opts === void 0 ? void 0 : opts.icon) || '';
     }
     async open() {
+        if (!isValidModalSize(this.size)) {
+            throw new errors_1.BridgeAPIError(`Invalid modal size: ${JSON.stringify(this.size)}. Must be one of the named sizes (${NAMED_MODAL_SIZES.join(', ')}) or a custom dimensions object with a "width" string property and an optional "height" string property.`);
+        }
         try {
             const success = await callBridge('openModal', {
                 resource: this.resource,

package/out/view/getFrameDispatch.d.ts

@@ -0,0 +1,4 @@
+declare type DispatchFunction = (...args: any[]) => any;
+export declare const getFrameDispatch: <T extends DispatchFunction>() => Promise<T | undefined>;
+export {};
+//# sourceMappingURL=getFrameDispatch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getFrameDispatch.d.ts","sourceRoot":"","sources":["../../src/view/getFrameDispatch.ts"],"names":[],"mappings":"AAEA,aAAK,gBAAgB,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAIhD,eAAO,MAAM,gBAAgB,0DAE5B,CAAC"}

package/out/view/getFrameDispatch.js

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

package/out/view/view.d.ts

@@ -6,6 +6,7 @@ export declare const view: {
     refresh: (payload?: any) => Promise<void>;
     createHistory: () => Promise<import("history").History>;
     getContext: () => Promise<import("../types").FullContext>;
+    getFrameDispatch: <T extends (...args: any[]) => any>() => Promise<T | undefined>;
     theme: {
         enable: () => Promise<void>;
     };

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

@@ -1 +1 @@
-{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/view/view.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;CAYhB,CAAC"}
+{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/view/view.ts"],"names":[],"mappings":"AAaA,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;CAahB,CAAC"}

package/out/view/view.js

@@ -12,6 +12,7 @@ const theme_1 = require("./theme");
 const emitReadyEvent_1 = require("./emitReadyEvent");
 const adf_renderer_1 = require("./adf-renderer");
 const onClose_1 = require("./onClose");
+const getFrameDispatch_1 = require("./getFrameDispatch");
 exports.view = {
     submit: submit_1.submit,
     close: close_1.close,
@@ -20,6 +21,7 @@ exports.view = {
     refresh: refresh_1.refresh,
     createHistory: createHistory_1.createHistory,
     getContext: getContext_1.getContext,
+    getFrameDispatch: getFrameDispatch_1.getFrameDispatch,
     theme: theme_1.theme,
     changeWindowTitle: changeWindowTitle_1.changeWindowTitle,
     emitReadyEvent: emitReadyEvent_1.emitReadyEvent,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "5.16.3-next.0-experimental-4a332af",
+  "version": "5.17.0-next.10",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -19,7 +19,7 @@
     "@forge/i18n": "0.0.7",
     "@forge/resolver": "1.8.0",
     "@types/history": "^4.7.11",
-    "@forge/manifest": "12.8.0-experimental-4a332af",
+    "@forge/manifest": "12.9.0-next.6",
     "@types/iframe-resizer": "^3.5.8",
     "iframe-resizer": "^4.4.5"
   },