@disy/cadenza.js 10.5.1 → 10.5.2

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.1';
+const CADENZAJS_VERSION = '10.5.2';
 /**
  * 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
@@ -219,6 +219,9 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
  * @property {'FeatureCollection'} type - The object's type
  * @property {Feature[]} features - The features within this collection
  */
+/**
+ * @typedef {Record<string, string>} WorksheetPlaceholders - Maps the worksheet placeholder IDs in report embeddings to the print names of the worksheets to replace them with.
+ */
 /**
  * @typedef AreaIntersectionsResult - Result object of function fetchAreaIntersections
  * @property {FeatureCollection} results - Results of the geometry intersection
@@ -348,6 +351,7 @@ export class CadenzaClient {
      * @param {GlobalId} [__namedParameters.highlightGlobalId] - The ID of an item to highlight / expand in the navigator
      * @param {String} [__namedParameters.labelSet] - The name of a label set defined in the `basicweb-config.xml` (only supported for the welcome page)
      * @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {WorksheetPlaceholders} [__namedParameters.worksheetPlaceholders] - Maps the worksheet placeholder IDs in report embeddings to the print names of the worksheets to replace them with.
      * @param {Layout} [__namedParameters.layout] - The layout to be used; the dashboard layout is used by default or the linear layout if there is not enough space.
      * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
@@ -357,7 +361,7 @@ export class CadenzaClient {
      * - {@link CadenzaActionEvent}
      * @embed
      */
-    show(source, { dataType, disabledUiFeatures, expandNavigator, filter, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, operationMode, layout, signal, } = {}) {
+    show(source, { dataType, disabledUiFeatures, expandNavigator, filter, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, operationMode, worksheetPlaceholders, layout, signal, } = {}) {
         this.#log('CadenzaClient#show', ...arguments);
         if (dataType) {
             assertSupportedDataType(dataType, ['pdf']);
@@ -378,6 +382,7 @@ export class CadenzaClient {
             labelSet,
             operationMode,
             layout,
+            worksheetPlaceholders,
         });
         return this.#show(resolvePath(source), params, signal);
     }
@@ -407,7 +412,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 +678,9 @@ export class CadenzaClient {
      * @fires
      * - {@link CadenzaEditGeometryUpdateEvent}
      * - {@link CadenzaEditGeometryOkEvent}
+     * - {@link CadenzaEditGeometryCreateEvent}
+     * - {@link CadenzaEditGeometryEditEvent}
+     * - {@link CadenzaEditGeometryDeleteEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
@@ -712,6 +720,9 @@ export class CadenzaClient {
      * @fires
      * - {@link CadenzaEditGeometryUpdateEvent}
      * - {@link CadenzaEditGeometryOkEvent}
+     * - {@link CadenzaEditGeometryCreateEvent}
+     * - {@link CadenzaEditGeometryEditEvent}
+     * - {@link CadenzaEditGeometryDeleteEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
@@ -745,7 +756,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>[]>}
@@ -1181,6 +1192,7 @@ export class CadenzaClient {
      * @param {WorkbookLayerPath[]} [params.layers]
      * @param {number} [params.minScale]
      * @param {OperationMode} [params.operationMode]
+     * @param {WorksheetPlaceholders} [params.worksheetPlaceholders]
      * @param {TablePart[]} [params.parts]
      * @param {'MAP'} [params.targetType]
      * @param {SnappingOptions} [params.snapping]
@@ -1189,7 +1201,7 @@ export class CadenzaClient {
      * @param {Layout} [params.layout]
      * @return {URLSearchParams}
      */
-    #createParams({ action, batchModeEnabled, dataType, disabledUiFeatures, expandNavigator, fileName, filter, geometryType, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, layers, minScale, operationMode, parts, targetType, snapping, useMapSrs, validExtentStrategy, layout, }) {
+    #createParams({ action, batchModeEnabled, dataType, disabledUiFeatures, expandNavigator, fileName, filter, geometryType, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, layers, minScale, operationMode, worksheetPlaceholders, parts, targetType, snapping, useMapSrs, validExtentStrategy, layout, }) {
         if (disabledUiFeatures) {
             disabledUiFeatures.forEach((feature) => assert(validUiFeature(feature), `Invalid UI feature: ${feature}`));
         }
@@ -1208,6 +1220,9 @@ export class CadenzaClient {
         if (parts) {
             parts.forEach((part) => assert(validTablePart(part), `Invalid table part: ${part}`));
         }
+        if (worksheetPlaceholders) {
+            assertValidWorksheetPlaceholdersValues(worksheetPlaceholders);
+        }
         let locationFinder;
         let mapExtent;
         if (validExtentStrategy) {
@@ -1232,6 +1247,11 @@ export class CadenzaClient {
                     `filter.${variable}`,
                     JSON.stringify(value instanceof Date ? value.toISOString() : value),
                 ]))),
+            ...(worksheetPlaceholders &&
+                Object.fromEntries(Object.entries(worksheetPlaceholders).map(([placeholderId, worksheetPrintName]) => [
+                    `worksheetPlaceholder.${placeholderId}`,
+                    JSON.stringify(worksheetPrintName),
+                ]))),
             ...(geometryType && { geometryType }),
             ...(hideMainHeaderAndFooter && { hideMainHeaderAndFooter: 'true' }),
             ...(hideWorkbookToolBar && { hideWorkbookToolBar: 'true' }),
@@ -1380,6 +1400,12 @@ function assertValidFilterVariables(/** @type {FilterVariables} */ filter) {
         validSpatialFilterValue(/** @type {SpatialFilterValue} */ ($spatial)), 'Invalid value for spatial filter value under $spatial property');
     Object.keys(otherFilter).forEach((varName) => assert(validKebabCaseString(varName), `Invalid filter variable name: ${varName}`));
 }
+function assertValidWorksheetPlaceholdersValues(
+/** @type {WorksheetPlaceholders} */ worksheetPlaceholders) {
+    Object.keys(worksheetPlaceholders).forEach((placeholderId) => {
+        assert(validKebabCaseString(placeholderId), `Invalid worksheeet placeholderId value: ${placeholderId}`);
+    });
+}
 function array(/** @type unknown */ value) {
     return Array.isArray(value) ? value : [value];
 }
@@ -1458,6 +1484,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 +1525,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', {featureIds: 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.1",
+  "version": "10.5.2",
   "license": "Apache-2.0",
   "repository": "github:DisyInformationssysteme/cadenza.js",
   "type": "module",

package/sandbox.html

@@ -250,12 +250,12 @@
       layout,
       width,
       withScale,
+      worksheetPlaceholders
     }, formData) {
       return {
         additionalLayers: additionalLayers && JSON.parse(additionalLayers),
         buffer: distance ? { value: Number(distance), lengthUnit: lengthUnit ? lengthUnit : 'm' } : undefined,
-        ...(requestAsPdf === 'on' && { dataType: 'pdf' }),
-        dataType: dataType,
+        dataType: dataType ?? (requestAsPdf === 'on' ? 'pdf' : undefined),
         disabledUiFeatures: disabledUiFeatures && disabledUiFeatures.split(','),
         expandNavigator: (expandNavigator === 'on'),
         extentStrategy: extentStrategy && JSON.parse(extentStrategy),
@@ -282,6 +282,7 @@
         layout: layout || undefined,
         width: Number(width),
         withScale: Boolean(withScale),
+        worksheetPlaceholders: (worksheetPlaceholders && JSON.parse(worksheetPlaceholders.trim())) || undefined,
       };
     }
 
@@ -418,6 +419,26 @@
   </div>
 </template>
 
+<template id="common-worksheetPlaceholders">
+  <div>
+    <label for="worksheetPlaceholders">Worksheet placeholder IDs</label>
+    <textarea name="worksheetPlaceholders" id="worksheetPlaceholders" rows="5"></textarea>
+    <small>
+      <p>A JSON object with a mapping of (placeholderId -> worksheetPrintName).
+        Placeholder ID is defined in the worksheet placeholder element in the report template.
+        The placeholders are then replaced with worksheet elements.</p>
+      <p>Example:</p>
+      <pre>
+{
+  "first": "Informationen zur Arbeitsmappe",
+  "second": "Häufigkeit der Messungen"
+}
+      </pre>
+    </small>
+
+  </div>
+</template>
+
 <template id="common-filter">
   <div>
     <label for="filter">Filter</label>
@@ -496,7 +517,7 @@
   </div>
 </template>
 
-<template data-action="show" data-common="showWorkbook,disabledUiFeatures,filter,show">
+<template data-action="show" data-common="showWorkbook,disabledUiFeatures,worksheetPlaceholders,filter,show">
   <div>
     <label for="embeddingTargetId">Embedding target ID *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>