@disy/cadenza.js 10.5.3 → 10.5.5

package/cadenza.d.ts

@@ -121,6 +121,8 @@ export class CadenzaClient {
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
+     * - {@link CadenzaChangeExtentEvent}
+     * - {@link CadenzaChangeSelectionEvent}
      * - {@link CadenzaDrillThroughEvent}
      * - {@link CadenzaActionEvent}
      * @embed
@@ -168,7 +170,6 @@ export class CadenzaClient {
     /**
      * Set filter variables in the currently shown workbook.
      *
-     * @hidden
      * @param {FilterVariables} filter - The variable values
      * @return {Promise<void>} A `Promise` for when the filter variables were set.
      * @postMessage
@@ -180,7 +181,6 @@ export class CadenzaClient {
      * When making a layer visible, its ancestors will be made visible, too.
      * When hiding a layer, the ancestors are not affected.
      *
-     * @hidden
      * @param {WorkbookLayerPath | string} layer - The layer to show or hide
      *   (identified using a layer path or a print name)
      * @param {boolean} visible - The visibility state of the layer
@@ -191,7 +191,6 @@ export class CadenzaClient {
     /**
      * Set the selection in the currently shown workbook map view.
      *
-     * @hidden
      * @param {WorkbookLayerPath | string} layer - The data view layer to set the selection in
      * @param {unknown[][]} values - The IDs of the objects to select
      * @param {object} [__namedParameters]
@@ -205,7 +204,6 @@ export class CadenzaClient {
     /**
      * Add to the selection in the currently shown workbook map view.
      *
-     * @hidden
      * @param {WorkbookLayerPath | string} layer - The data view layer to change the selection in
      * @param {unknown[][]} values - The IDs of the objects to select
      * @param {object} [__namedParameters]
@@ -219,7 +217,6 @@ export class CadenzaClient {
     /**
      * Remove from the selection in the currently shown workbook map view.
      *
-     * @hidden
      * @param {WorkbookLayerPath | string} layer - The data view layer to change the selection in
      * @param {unknown[][]} values - The IDs of the objects to unselect
      * @param {object} [__namedParameters]
@@ -241,6 +238,8 @@ export class CadenzaClient {
      * @param {CommonEditGeometryOptions} [editGeometryOptions] - Options for the initialization of the geometry editor.
      * @throws For invalid arguments
      * @fires
+     * - {@link CadenzaChangeExtentEvent}
+     * - {@link CadenzaChangeSelectionEvent}
      * - {@link CadenzaEditGeometryUpdateEvent}
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
@@ -256,6 +255,8 @@ export class CadenzaClient {
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
+     * - {@link CadenzaChangeExtentEvent}
+     * - {@link CadenzaChangeSelectionEvent}
      * - {@link CadenzaEditGeometryUpdateEvent}
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
@@ -271,6 +272,8 @@ export class CadenzaClient {
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
+     * - {@link CadenzaChangeExtentEvent}
+     * - {@link CadenzaChangeSelectionEvent}
      * - {@link CadenzaEditGeometryUpdateEvent}
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCreateEvent}
@@ -289,6 +292,8 @@ export class CadenzaClient {
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
+     * - {@link CadenzaChangeExtentEvent}
+     * - {@link CadenzaChangeSelectionEvent}
      * - {@link CadenzaEditGeometryUpdateEvent}
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCreateEvent}
@@ -444,6 +449,7 @@ export class CadenzaClient {
 }
 /**
  * @typedef {'action'
+ * | 'change:extent'
  * | 'change:selection'
  * | 'drillThrough'
  * | 'editGeometry:ok'
@@ -460,6 +466,7 @@ export class CadenzaClient {
 /**
  * @template {CadenzaEventType} T
  * @typedef {T extends 'action' ? CadenzaActionEvent
+ *  : T extends 'change:extent' ? CadenzaChangeExtentEvent
  *  : T extends 'change:selection' ? CadenzaChangeSelectionEvent
  *  : T extends 'drillThrough' ? CadenzaDrillThroughEvent
  *  : T extends 'editGeometry:update' ? CadenzaEditGeometryUpdateEvent
@@ -484,6 +491,10 @@ export class CadenzaClient {
 /**
  * @typedef {CadenzaEvent<'action', {context: string}>} CadenzaActionEvent - When the user executed a POST message action, which is defined on an external link in the Cadenza management center.
  */
+/**
+ * @typedef {CadenzaEvent<'change:extent', {extent: Extent}>} CadenzaChangeExtentEvent - When the user moved the map.
+ *   The extent is transformed according to the `useMapSrs` option.
+ */
 /**
  * @typedef {CadenzaEvent<'change:selection', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaChangeSelectionEvent - When the user changed the selection. `undefined` if no objects were selected.
  *
@@ -502,7 +513,7 @@ export class CadenzaClient {
 /** @typedef {CadenzaEvent<'editGeometry:ok', FeatureCollection | Feature>} CadenzaEditGeometryOkEvent - When the user submitted the geometry. `FeatureCollection` if batch editing is enabled. */
 /** @typedef {CadenzaEvent<'editGeometry:create', FeatureCollection | Feature>} CadenzaEditGeometryCreateEvent - Whenever new geometry features were created. `Feature` if only one feature was created. Only available in batch mode */
 /** @typedef {CadenzaEvent<'editGeometry:edit', Feature>} CadenzaEditGeometryEditEvent - Whenever a geometry feature was edited. Only available in batch mode */
-/** @typedef {CadenzaEvent<'editGeometry:delete', {featureIds: any[][]}>} CadenzaEditGeometryDeleteEvent - Whenever geometry features were deleted. Only available in batch mode */
+/** @typedef {CadenzaEvent<'editGeometry:delete', {objectIds: any[][]}>} CadenzaEditGeometryDeleteEvent - Whenever geometry features were deleted. Only available in batch mode */
 /** @typedef {CadenzaEvent<'editGeometry:cancel'>} CadenzaEditGeometryCancelEvent - When the user cancelled the geometry editing. */
 /** @typedef {CadenzaEvent<'error', {type: string, message?: string}>} CadenzaErrorEvent - An error event that is mapped to a {@link CadenzaError} */
 /**
@@ -934,8 +945,8 @@ export type Layout = 'dashboard' | 'linear';
 /**
  * - An event type to subscribe to using {@link CadenzaClienton }
  */
-export type CadenzaEventType = 'action' | 'change:selection' | 'drillThrough' | 'editGeometry:ok' | 'editGeometry:create' | 'editGeometry:edit' | 'editGeometry:delete' | 'editGeometry:update' | 'editGeometry:cancel' | 'reload' | 'selectObjects:ok' | 'selectObjects:cancel';
-export type CadenzaEventByType<T extends CadenzaEventType> = T extends 'action' ? CadenzaActionEvent : T extends 'change:selection' ? CadenzaChangeSelectionEvent : T extends 'drillThrough' ? CadenzaDrillThroughEvent : T extends 'editGeometry:update' ? CadenzaEditGeometryUpdateEvent : T extends 'editGeometry:ok' ? CadenzaEditGeometryOkEvent : T extends 'editGeometry:create' ? CadenzaEditGeometryCreateEvent : T extends 'editGeometry:edit' ? CadenzaEditGeometryEditEvent : T extends 'editGeometry:delete' ? CadenzaEditGeometryDeleteEvent : T extends 'editGeometry:cancel' ? CadenzaEditGeometryCancelEvent : T extends 'reload' ? CadenzaReloadEvent : T extends 'selectObjects:ok' ? CadenzaSelectObjectsOkEvent : T extends 'selectObjects:cancel' ? CadenzaSelectObjectsCancelEvent : never;
+export type CadenzaEventType = 'action' | 'change:extent' | 'change:selection' | 'drillThrough' | 'editGeometry:ok' | 'editGeometry:create' | 'editGeometry:edit' | 'editGeometry:delete' | 'editGeometry:update' | 'editGeometry:cancel' | 'reload' | 'selectObjects:ok' | 'selectObjects:cancel';
+export type CadenzaEventByType<T extends CadenzaEventType> = T extends 'action' ? CadenzaActionEvent : T extends 'change:extent' ? CadenzaChangeExtentEvent : T extends 'change:selection' ? CadenzaChangeSelectionEvent : T extends 'drillThrough' ? CadenzaDrillThroughEvent : T extends 'editGeometry:update' ? CadenzaEditGeometryUpdateEvent : T extends 'editGeometry:ok' ? CadenzaEditGeometryOkEvent : T extends 'editGeometry:create' ? CadenzaEditGeometryCreateEvent : T extends 'editGeometry:edit' ? CadenzaEditGeometryEditEvent : T extends 'editGeometry:delete' ? CadenzaEditGeometryDeleteEvent : T extends 'editGeometry:cancel' ? CadenzaEditGeometryCancelEvent : T extends 'reload' ? CadenzaReloadEvent : T extends 'selectObjects:ok' ? CadenzaSelectObjectsOkEvent : T extends 'selectObjects:cancel' ? CadenzaSelectObjectsCancelEvent : never;
 /**
  * - A Cadenza `postMessage()` event
  */
@@ -955,6 +966,13 @@ export type CadenzaEvent<TYPE extends string, DETAIL = unknown> = {
 export type CadenzaActionEvent = CadenzaEvent<'action', {
     context: string;
 }>;
+/**
+ * - When the user moved the map.
+ *   The extent is transformed according to the `useMapSrs` option.
+ */
+export type CadenzaChangeExtentEvent = CadenzaEvent<'change:extent', {
+    extent: [number, number, number, number];
+}>;
 /**
  * - When the user changed the selection. `undefined` if no objects were selected.
  *
@@ -997,7 +1015,7 @@ export type CadenzaEditGeometryEditEvent = CadenzaEvent<'editGeometry:edit', Fea
  * - Whenever geometry features were deleted. Only available in batch mode
  */
 export type CadenzaEditGeometryDeleteEvent = CadenzaEvent<'editGeometry:delete', {
-    featureIds: any[][];
+    objectIds: any[][];
 }>;
 /**
  * - When the user cancelled the geometry editing.

package/cadenza.js

@@ -18,7 +18,7 @@
  */
 // This placeholder is replaced when Cadenza JS is released,
 // i.e. during development, the version is not available.
-const CADENZAJS_VERSION = '10.5.3';
+const CADENZAJS_VERSION = '10.5.5';
 /**
  * Creates an instance of the Cadenza JS client.
  *
@@ -427,6 +427,8 @@ export class CadenzaClient {
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
+     * - {@link CadenzaChangeExtentEvent}
+     * - {@link CadenzaChangeSelectionEvent}
      * - {@link CadenzaDrillThroughEvent}
      * - {@link CadenzaActionEvent}
      * @embed
@@ -497,7 +499,6 @@ export class CadenzaClient {
     /**
      * Set filter variables in the currently shown workbook.
      *
-     * @hidden
      * @param {FilterVariables} filter - The variable values
      * @return {Promise<void>} A `Promise` for when the filter variables were set.
      * @postMessage
@@ -513,7 +514,6 @@ export class CadenzaClient {
      * When making a layer visible, its ancestors will be made visible, too.
      * When hiding a layer, the ancestors are not affected.
      *
-     * @hidden
      * @param {WorkbookLayerPath | string} layer - The layer to show or hide
      *   (identified using a layer path or a print name)
      * @param {boolean} visible - The visibility state of the layer
@@ -530,7 +530,6 @@ export class CadenzaClient {
     /**
      * Set the selection in the currently shown workbook map view.
      *
-     * @hidden
      * @param {WorkbookLayerPath | string} layer - The data view layer to set the selection in
      * @param {unknown[][]} values - The IDs of the objects to select
      * @param {object} [__namedParameters]
@@ -550,7 +549,6 @@ export class CadenzaClient {
     /**
      * Add to the selection in the currently shown workbook map view.
      *
-     * @hidden
      * @param {WorkbookLayerPath | string} layer - The data view layer to change the selection in
      * @param {unknown[][]} values - The IDs of the objects to select
      * @param {object} [__namedParameters]
@@ -570,7 +568,6 @@ export class CadenzaClient {
     /**
      * Remove from the selection in the currently shown workbook map view.
      *
-     * @hidden
      * @param {WorkbookLayerPath | string} layer - The data view layer to change the selection in
      * @param {unknown[][]} values - The IDs of the objects to unselect
      * @param {object} [__namedParameters]
@@ -598,6 +595,8 @@ export class CadenzaClient {
      * @param {CommonEditGeometryOptions} [editGeometryOptions] - Options for the initialization of the geometry editor.
      * @throws For invalid arguments
      * @fires
+     * - {@link CadenzaChangeExtentEvent}
+     * - {@link CadenzaChangeSelectionEvent}
      * - {@link CadenzaEditGeometryUpdateEvent}
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
@@ -635,6 +634,8 @@ export class CadenzaClient {
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
+     * - {@link CadenzaChangeExtentEvent}
+     * - {@link CadenzaChangeSelectionEvent}
      * - {@link CadenzaEditGeometryUpdateEvent}
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
@@ -676,6 +677,8 @@ export class CadenzaClient {
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
+     * - {@link CadenzaChangeExtentEvent}
+     * - {@link CadenzaChangeSelectionEvent}
      * - {@link CadenzaEditGeometryUpdateEvent}
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCreateEvent}
@@ -718,6 +721,8 @@ export class CadenzaClient {
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
+     * - {@link CadenzaChangeExtentEvent}
+     * - {@link CadenzaChangeSelectionEvent}
      * - {@link CadenzaEditGeometryUpdateEvent}
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCreateEvent}
@@ -749,8 +754,8 @@ export class CadenzaClient {
         await this.#setupEditorViaPostRequests({
             additionalLayers,
             validExtentStrategy,
-            features,
         });
+        await this.#createFeaturesAndEditLastCreatedFeature(features);
         await this.#setEditorStateToReady();
     }
     /**
@@ -758,10 +763,9 @@ export class CadenzaClient {
      * @param [__namedParameters.geometry] {Geometry} - The geometry to edit
      * @param [__namedParameters.additionalLayers] {LayerDefinition[]} - Layer definitions to be imported and shown in the background, as a basis for the drawing. IMPORTANT: The Cadenza referenced with `cadenzaClient` must be configured to support the import of GeoJSON, and the (system) privileges of the corresponding user must also be set in such a way that the import of GeoJSON is possible.
      * @param [__namedParameters.validExtentStrategy] {ExtentStrategy} - Defines the initial map extent; If not given, Cadenza's default logic is used.
-     * @param [__namedParameters.features] {FeatureCollection} - The features to edit. The last feature in this collection is directly set up for editing.
      * @returns {Promise<Awaited<unknown>[]>}
      */
-    #setupEditorViaPostRequests({ geometry, additionalLayers, validExtentStrategy, features, }) {
+    #setupEditorViaPostRequests({ geometry, additionalLayers, validExtentStrategy, }) {
         const postRequests = [];
         postRequests.push(this.#setExtentStrategy(validExtentStrategy));
         if (geometry) {
@@ -774,11 +778,41 @@ export class CadenzaClient {
                 postRequests.push(this.#postRequest('importLayer', layer));
             }
         }
-        if (features) {
-            postRequests.push(this.#postRequest('addFeatures', features));
-        }
         return Promise.all(postRequests);
     }
+    /**
+     * @param {FeatureCollection} features - The features to edit.
+     */
+    async #createFeaturesAndEditLastCreatedFeature(features) {
+        const editFeaturePromise = new Promise((resolve) => {
+            this.#once('editGeometry:create', 
+            /** @param {CadenzaEditGeometryCreateEvent} event */ async (event) => {
+                const featureOrCollection = event.detail;
+                let lastAddedFeature;
+                if (featureOrCollection.type === 'Feature') {
+                    lastAddedFeature = featureOrCollection;
+                }
+                else {
+                    const addedFeatures = featureOrCollection.features;
+                    lastAddedFeature = addedFeatures[addedFeatures.length - 1];
+                }
+                await this.#setEditFeature(lastAddedFeature.objectId);
+                resolve(undefined);
+            });
+        });
+        await this.#postRequest('createFeatures', features);
+        return editFeaturePromise;
+    }
+    /**
+     * Send a request to the geometry editor to edit the feature with the given ID.
+     * If another feature is currently being edited or created,
+     * the user is prompted to save (if possible), discard the current changes, or to abort the request.
+     *
+     * @param {any[]} objectId - The id of the feature
+     */
+    #setEditFeature(objectId) {
+        return this.#postRequest('requestEditFeature', objectId);
+    }
     #setEditorStateToReady() {
         return this.#postRequest('setEditorState', 'READY');
     }
@@ -953,6 +987,20 @@ export class CadenzaClient {
             }
         };
     }
+    /**
+     * @template {CadenzaEventType | string} TYPE
+     * @template [DETAIL=unknown]
+     * @param {TYPE} type
+     * @param {(event: CadenzaEvent<TYPE, DETAIL>) => void} subscriber
+     * @return {() => void} An unsubscribe function
+     */
+    #once(type, subscriber) {
+        const unsubscribe = this.#on(type, (event) => {
+            subscriber(/** @type {CadenzaEvent<TYPE, DETAIL>} */ (event));
+            unsubscribe();
+        });
+        return unsubscribe;
+    }
     // Use arrow function so that it's bound to this.
     #onMessage = (
     /** @type MessageEvent<CadenzaEvent<never, never>> */ event) => {
@@ -1467,6 +1515,7 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
 // Please do not add internal event types like 'ready' here.
 /**
  * @typedef {'action'
+ * | 'change:extent'
  * | 'change:selection'
  * | 'drillThrough'
  * | 'editGeometry:ok'
@@ -1483,6 +1532,7 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
 /**
  * @template {CadenzaEventType} T
  * @typedef {T extends 'action' ? CadenzaActionEvent
+ *  : T extends 'change:extent' ? CadenzaChangeExtentEvent
  *  : T extends 'change:selection' ? CadenzaChangeSelectionEvent
  *  : T extends 'drillThrough' ? CadenzaDrillThroughEvent
  *  : T extends 'editGeometry:update' ? CadenzaEditGeometryUpdateEvent
@@ -1507,8 +1557,7 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
 /**
  * @typedef {CadenzaEvent<'action', {context: string}>} CadenzaActionEvent - When the user executed a POST message action, which is defined on an external link in the Cadenza management center.
  */
-/*
- * @hidden
+/**
  * @typedef {CadenzaEvent<'change:extent', {extent: Extent}>} CadenzaChangeExtentEvent - When the user moved the map.
  *   The extent is transformed according to the `useMapSrs` option.
  */
@@ -1530,7 +1579,7 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
 /** @typedef {CadenzaEvent<'editGeometry:ok', FeatureCollection | Feature>} CadenzaEditGeometryOkEvent - When the user submitted the geometry. `FeatureCollection` if batch editing is enabled. */
 /** @typedef {CadenzaEvent<'editGeometry:create', FeatureCollection | Feature>} CadenzaEditGeometryCreateEvent - Whenever new geometry features were created. `Feature` if only one feature was created. Only available in batch mode */
 /** @typedef {CadenzaEvent<'editGeometry:edit', Feature>} CadenzaEditGeometryEditEvent - Whenever a geometry feature was edited. Only available in batch mode */
-/** @typedef {CadenzaEvent<'editGeometry:delete', {featureIds: any[][]}>} CadenzaEditGeometryDeleteEvent - Whenever geometry features were deleted. Only available in batch mode */
+/** @typedef {CadenzaEvent<'editGeometry:delete', {objectIds: any[][]}>} CadenzaEditGeometryDeleteEvent - Whenever geometry features were deleted. Only available in batch mode */
 /** @typedef {CadenzaEvent<'editGeometry:cancel'>} CadenzaEditGeometryCancelEvent - When the user cancelled the geometry editing. */
 /** @typedef {CadenzaEvent<'error', {type: string, message?: string}>} CadenzaErrorEvent - An error event that is mapped to a {@link CadenzaError} */
 /**

package/package.json

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