@disy/cadenza.js 2.9.0 → 2.10.1

package/cadenza.js

@@ -190,12 +190,11 @@ export class CadenzaClient {
         return this.#iframeElement;
     }
     get #targetWindow() {
-        if (this.#iframe) {
-            return /** @type {WindowProxy} */ (this.#requiredIframe.contentWindow);
-        }
-        const targetWindow = window.opener ?? window.parent;
-        assert(targetWindow !== window, 'Cannot find target window');
-        return /** @type {WindowProxy} */ targetWindow;
+        const targetWindow = this.#iframe
+            ? this.iframe?.contentWindow
+            : // If a window does not have a parent, its parent property is a reference to itself.
+                window.opener ?? (window.parent !== window ? window.parent : null);
+        return /** @type {WindowProxy | null} */ targetWindow;
     }
     get #requiredIframe() {
         const iframe = /** @type {HTMLIFrameElement} */ (this.iframe);
@@ -611,6 +610,15 @@ export class CadenzaClient {
             }
         });
     };
+    /**
+     * Remove all subscriptions.
+     *
+     * @see {@link CadenzaClient#on}
+     */
+    destroy() {
+        this.#subscriptions = [];
+        window.removeEventListener('message', this.#onMessage);
+    }
     /**
      * Posts an event to Cadenza and returns a `Promise` for the response.
      *
@@ -646,7 +654,9 @@ export class CadenzaClient {
     #postEvent(type, detail, transfer) {
         const cadenzaEvent = { type, detail };
         this.#log('postMessage', cadenzaEvent);
-        this.#targetWindow.postMessage(cadenzaEvent, {
+        const targetWindow = this.#targetWindow;
+        assert(targetWindow != null, 'Cannot find target window');
+        targetWindow.postMessage(cadenzaEvent, {
             targetOrigin: this.#origin,
             transfer,
         });
@@ -926,6 +936,7 @@ function array(/** @type unknown */ value) {
  * | 'objectInfo'
  * | 'selectObjects:ok'
  * | 'selectObjects:cancel'
+ * | 'reload'
  * } CadenzaEventType - An event type to subscribe to using {@link CadenzaClient#on}
  */
 /**
@@ -938,6 +949,7 @@ function array(/** @type unknown */ value) {
  *  : T extends 'objectInfo' ? CadenzaObjectInfoEvent
  *  : T extends 'selectObjects:ok' ? CadenzaSelectObjectsOkEvent
  *  : T extends 'selectObjects:cancel' ? CadenzaSelectObjectsCancelEvent
+ *  : T extends 'reload' ? CadenzaReloadEvent
  *  : never
  * } CadenzaEventByType
  */
@@ -978,6 +990,13 @@ function array(/** @type unknown */ value) {
  * For a selection in a workbook map view with activated feature info, the values also include the simplified geometries of the selected objects.
  */
 /** @typedef {CadenzaEvent<'selectObjects:cancel'>} CadenzaSelectObjectsCancelEvent - When the user cancelled the selection. */
+/**
+ * @typedef {CadenzaEvent<'reload'>} CadenzaReloadEvent - When the user clicked on the 'reload' button in the embedding standby page
+ *
+ * If a user does not interact with the iframe displaying the Cadenza content for a while, a standby embed page is displayed
+ * and the user can click a reload button there. Then the application using Cadenza JS can re-trigger the loading of the iframe
+ * with the correct original URL and parameters and do what was originally done when displaying that iframe.
+ */
 export class AbortError extends DOMException {
     constructor() {
         super('Aborted', 'AbortError');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@disy/cadenza.js",
-  "version": "2.9.0",
+  "version": "2.10.1",
   "license": "Apache-2.0",
   "repository": "github:DisyInformationssysteme/cadenza.js",
   "type": "module",