@disy/cadenza.js 10.4.6 → 10.4.8

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.4.6';
+const CADENZAJS_VERSION = '10.4.8';
 /**
  * Creates an instance of the Cadenza JS client.
  *
@@ -169,7 +169,7 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
  */
 /**
  * @typedef CommonEditGeometryOptions - Common options for the initialization of the geometry editor.
- * @property {LayerDefinition[]} [additionalLayers] - Layer definitions to be imported and shown in the background, as a basis for the drawing.
+ * @property {LayerDefinition[]} [additionalLayers] - 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.
  * @property {UiFeature[]} [disabledUiFeatures] - Cadenza UI features to disable
  * @property {ExtentStrategy} [extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
  * @property {FilterVariables} [filter] - Filter variables
@@ -407,7 +407,7 @@ export class CadenzaClient {
      *
      * @param {EmbeddingTargetId} mapView - The workbook map view to show
      * @param {object} [__namedParameters] - Options
-     * @param {LayerDefinition[]} [__namedParameters.additionalLayers] - Layer definitions to be imported and shown in the background, as a basis for the drawing.
+     * @param {LayerDefinition[]} [__namedParameters.additionalLayers] - 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 {UiFeature[]} [__namedParameters.disabledUiFeatures] - Cadenza UI features to disable
      * @param {boolean} [__namedParameters.expandNavigator] - Indicates if the navigator should be expanded.
      * @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
@@ -673,6 +673,9 @@ export class CadenzaClient {
      * @fires
      * - {@link CadenzaEditGeometryUpdateEvent}
      * - {@link CadenzaEditGeometryOkEvent}
+     * - {@link CadenzaEditGeometryCreateEvent}
+     * - {@link CadenzaEditGeometryEditEvent}
+     * - {@link CadenzaEditGeometryDeleteEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
@@ -712,6 +715,9 @@ export class CadenzaClient {
      * @fires
      * - {@link CadenzaEditGeometryUpdateEvent}
      * - {@link CadenzaEditGeometryOkEvent}
+     * - {@link CadenzaEditGeometryCreateEvent}
+     * - {@link CadenzaEditGeometryEditEvent}
+     * - {@link CadenzaEditGeometryDeleteEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
@@ -745,7 +751,7 @@ export class CadenzaClient {
     /**
      * @param {object} __namedParameters - Options
      * @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.
+     * @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>[]>}
@@ -1444,6 +1450,9 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
  * | 'change:selection'
  * | 'drillThrough'
  * | 'editGeometry:ok'
+ * | 'editGeometry:create'
+ * | 'editGeometry:edit'
+ * | 'editGeometry:delete'
  * | 'editGeometry:update'
  * | 'editGeometry:cancel'
  * | 'reload'
@@ -1458,6 +1467,9 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
  *  : 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
@@ -1496,6 +1508,9 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
  */
 /** @typedef {CadenzaEvent<'editGeometry:update', FeatureCollection | Feature | undefined>} CadenzaEditGeometryUpdateEvent - When the user changed the geometry. `FeatureCollection` if multiple features are present on the edit layer, but the original defined type is not multi-geometry. This is also the case if the dialog was instantiated from a geometry and the original defined type is inherited. `undefined` if no feature is present on the edit layer. */
 /** @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', {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.4.6",
+  "version": "10.4.8",
   "license": "Apache-2.0",
   "repository": "github:DisyInformationssysteme/cadenza.js",
   "type": "module",