@forge/bridge 5.16.3-next.0 → 5.17.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @forge/bridge
 
+## 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
 
 ### Patch Changes

package/out/modal/modal.d.ts

@@ -1,7 +1,14 @@
+declare const NAMED_MODAL_SIZES: readonly ["small", "medium", "large", "xlarge", "max", "fullscreen"];
+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,sEAAuE,CAAC;AAC/F,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'];
 // 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/adf-renderer.d.ts

@@ -1,7 +1,19 @@
+import { DocNode } from '@atlaskit/adf-schema';
 import type { FullContext } from '../types';
+interface AdfPostMessageData {
+    type: 'adf-document';
+    document: DocNode;
+    timestamp: number;
+    source: 'forge-adf-renderer';
+    localId: string;
+    isEditing: boolean;
+    contentId: string;
+}
+export declare const sendMessageWhenReady: (iframe: HTMLIFrameElement | null, message: AdfPostMessageData, origin: string) => void;
 export declare const createAdfRendererIframeProps: (context: FullContext, iframeId?: string) => Promise<{
     id: string;
     src: string;
     onLoad: () => void;
 }>;
+export {};
 //# sourceMappingURL=adf-renderer.d.ts.map

package/out/view/adf-renderer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"adf-renderer.d.ts","sourceRoot":"","sources":["../../src/view/adf-renderer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAY5C,eAAO,MAAM,4BAA4B,YAAmB,WAAW,aAAa,MAAM;;;;EA0CzF,CAAC"}
+{"version":3,"file":"adf-renderer.d.ts","sourceRoot":"","sources":["../../src/view/adf-renderer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE5C,UAAU,kBAAkB;IAC1B,IAAI,EAAE,cAAc,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,oBAAoB,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAOD,eAAO,MAAM,oBAAoB,WACvB,iBAAiB,GAAG,IAAI,WACvB,kBAAkB,UACnB,MAAM,KACb,IAgBF,CAAC;AAEF,eAAO,MAAM,4BAA4B,YAAmB,WAAW,aAAa,MAAM;;;;EA0CzF,CAAC"}

package/out/view/adf-renderer.js

@@ -1,6 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAdfRendererIframeProps = void 0;
+exports.createAdfRendererIframeProps = exports.sendMessageWhenReady = void 0;
+/**
+ * Sends the ADF document message to the adf-renderer iframe once it signals readiness.
+ */
+const READY_SIGNAL_FALLBACK_DELAY_MS = 10000;
+const sendMessageWhenReady = (iframe, message, origin) => {
+    const sendMessage = () => { var _a; return (_a = iframe === null || iframe === void 0 ? void 0 : iframe.contentWindow) === null || _a === void 0 ? void 0 : _a.postMessage(message, origin); };
+    const timeoutId = setTimeout(() => {
+        window.removeEventListener('message', handleReady);
+        sendMessage();
+    }, READY_SIGNAL_FALLBACK_DELAY_MS);
+    const handleReady = (event) => {
+        var _a;
+        if (event.source === (iframe === null || iframe === void 0 ? void 0 : iframe.contentWindow) && ((_a = event.data) === null || _a === void 0 ? void 0 : _a.source) === 'forge-adf-renderer-ready') {
+            clearTimeout(timeoutId);
+            window.removeEventListener('message', handleReady);
+            sendMessage();
+        }
+    };
+    window.addEventListener('message', handleReady);
+};
+exports.sendMessageWhenReady = sendMessageWhenReady;
 const createAdfRendererIframeProps = async (context, iframeId) => {
     const IframeResizer = await import('iframe-resizer');
     const IframeResizerModule = IframeResizer.default || IframeResizer;
@@ -8,7 +29,7 @@ const createAdfRendererIframeProps = async (context, iframeId) => {
     const src = `${origin}/forge-apps/adf-renderer`;
     const id = iframeId || `forge-adf-renderer-iframe-${crypto.randomUUID()}`;
     const onLoad = () => {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e;
         const iframe = document.getElementById(id);
         const message = {
             type: 'adf-document',
@@ -27,7 +48,7 @@ const createAdfRendererIframeProps = async (context, iframeId) => {
                 (_a = iframe === null || iframe === void 0 ? void 0 : iframe.iFrameResizer) === null || _a === void 0 ? void 0 : _a.resize();
             }
         }, iframe || '');
-        (_f = iframe === null || iframe === void 0 ? void 0 : iframe.contentWindow) === null || _f === void 0 ? void 0 : _f.postMessage(message, origin);
+        (0, exports.sendMessageWhenReady)(iframe, message, origin);
     };
     setTimeout(() => {
         document.documentElement.style.height = 'auto';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "5.16.3-next.0",
+  "version": "5.17.0-next.2",
   "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",
+    "@forge/manifest": "12.8.1-next.0",
     "@types/iframe-resizer": "^3.5.8",
     "iframe-resizer": "^4.4.5"
   },