@disy/cadenza.js 2.5.0 → 2.6.1

package/cadenza.js

@@ -162,6 +162,9 @@ export class CadenzaClient {
         }
         return this.#iframeElement;
     }
+    get #targetWindow() {
+        return /** @type {WindowProxy | null} */ this.iframe?.contentWindow;
+    }
     get #requiredIframe() {
         const iframe = /** @type {HTMLIFrameElement} */ (this.iframe);
         assert(iframe instanceof HTMLIFrameElement, 'Required iframe is not present.');
@@ -358,6 +361,7 @@ export class CadenzaClient {
      * @param {EmbeddingTargetId} backgroundMapView - The workbook map view in the background
      * @param {GeometryType} geometryType - The geometry type
      * @param {object} [options] - Options
+     * @param {FilterVariables} [options.filter] - Filter variables
      * @param {string} [options.locationFinder] - A search query for the location finder
      * @param {Extent} [options.mapExtent] - A map extent to set
      * @param {number} [options.minScale] - The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.
@@ -370,10 +374,11 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
      */
-    createGeometry(backgroundMapView, geometryType, { locationFinder, mapExtent, minScale, useMapSrs, signal } = {}) {
+    createGeometry(backgroundMapView, geometryType, { filter, locationFinder, mapExtent, minScale, useMapSrs, signal } = {}) {
         this.#log('CadenzaClient#createGeometry', ...arguments);
         const params = createParams({
             action: 'editGeometry',
+            filter,
             geometryType,
             locationFinder,
             mapExtent,
@@ -388,6 +393,7 @@ export class CadenzaClient {
      * @param {EmbeddingTargetId} backgroundMapView - The workbook map view in the background
      * @param {Geometry} geometry - The geometry
      * @param {object} [options] - Options
+     * @param {FilterVariables} [options.filter] - Filter variables
      * @param {string} [options.locationFinder] - A search query for the location finder
      * @param {Extent} [options.mapExtent] - A map extent to set
      * @param {number} [options.minScale] - The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.
@@ -400,11 +406,12 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
      */
-    async editGeometry(backgroundMapView, geometry, { locationFinder, mapExtent, minScale, useMapSrs, signal } = {}) {
+    async editGeometry(backgroundMapView, geometry, { filter, locationFinder, mapExtent, minScale, useMapSrs, signal } = {}) {
         this.#log('CadenzaClient#editGeometry', ...arguments);
         assertValidGeometryType(geometry.type);
         const params = createParams({
             action: 'editGeometry',
+            filter,
             locationFinder,
             mapExtent,
             minScale,
@@ -420,6 +427,7 @@ export class CadenzaClient {
      *
      * @param {EmbeddingTargetId} backgroundMapView - The workbook map view
      * @param {object} [options] - Options
+     * @param {FilterVariables} [options.filter] - Filter variables
      * @param {(WorkbookLayerPath | string)[]} [options.layers] - Layers to restrict the selection to
      *  (identified using layer paths or print names)
      * @param {string} [options.locationFinder] - A search query for the location finder
@@ -434,10 +442,11 @@ export class CadenzaClient {
      * - {@link CadenzaSelectObjectsOkEvent}
      * - {@link CadenzaSelectObjectsCancelEvent}
      */
-    selectObjects(backgroundMapView, { layers, locationFinder, mapExtent, useMapSrs, signal } = {}) {
+    selectObjects(backgroundMapView, { filter, layers, locationFinder, mapExtent, useMapSrs, signal } = {}) {
         this.#log('CadenzaClient#selectObjects', ...arguments);
         const params = createParams({
             action: 'selectObjects',
+            filter,
             layers: layers?.map(array),
             locationFinder,
             mapExtent,
@@ -559,8 +568,7 @@ export class CadenzaClient {
     // Use arrow function so that it's bound to this.
     #onMessage = (
     /** @type MessageEvent<CadenzaEvent<never, never>> */ event) => {
-        if (event.origin !== this.#origin ||
-            event.source !== this.#requiredIframe.contentWindow) {
+        if (event.origin !== this.#origin || event.source !== this.#targetWindow) {
             return;
         }
         const cadenzaEvent = event.data;
@@ -571,6 +579,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.
      *
@@ -606,8 +623,9 @@ export class CadenzaClient {
     #postEvent(type, detail, transfer) {
         const cadenzaEvent = { type, detail };
         this.#log('postMessage', cadenzaEvent);
-        const contentWindow = /** @type {WindowProxy} */ (this.#requiredIframe.contentWindow);
-        contentWindow.postMessage(cadenzaEvent, {
+        const targetWindow = this.#targetWindow;
+        assert(targetWindow != null, 'Cannot find target window');
+        /** @type {WindowProxy} */ (targetWindow).postMessage(cadenzaEvent, {
             targetOrigin: this.#origin,
             transfer,
         });

package/package.json

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

package/sandbox.html

@@ -440,7 +440,7 @@
 
 <template data-action="setFilter" data-common="filter"></template>
 
-<template data-action="createGeometry" data-common="map">
+<template data-action="createGeometry" data-common="map,filter">
   <div>
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>
@@ -462,7 +462,7 @@
   </div>
 </template>
 
-<template data-action="editGeometry" data-common="map">
+<template data-action="editGeometry" data-common="map,filter">
   <div>
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>
@@ -477,7 +477,7 @@
   </div>
 </template>
 
-<template data-action="selectObjects" data-common="map">
+<template data-action="selectObjects" data-common="map,filter">
   <div>
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>