@disy/cadenza.js 10.4.2 → 10.4.4

package/cadenza.js

@@ -9,10 +9,11 @@
  *   This is required if Cadenza and your application are not running on the same origin.
  *   Please ensure that the user has view privilege for that link!
  * @property {boolean} [options.debug] - Whether to enable debug logging
+ * @property {boolean} [options.skipGuest] - Whether a configured guest authenticator should be ignored
  */
 // This placeholder is replaced when Cadenza JS is released,
 // i.e. during development, the version is not available.
-const CADENZAJS_VERSION = '10.4.2';
+const CADENZAJS_VERSION = '10.4.4';
 /**
  * Creates an instance of the Cadenza JS client.
  *
@@ -95,12 +96,15 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
  */
 /** @typedef {'normal'|'simplified'} OperationMode - The mode in which a workbook should be operated */
 /**
- * @typedef {'workbook-design'|'workbook-map-add-layer'|'workbook-view-management'} UiFeature - The name of a Cadenza UI feature
+ * @typedef {'workbook-design'|'workbook-map-add-layer'|'workbook-view-management'|'embedded-dialog-footer-buttons'|'embedded-dialog-apply-button'|'embedded-dialog-cancel-button'} UiFeature - The name of a Cadenza UI feature
  *
  * _Note:_ Supported features are:
  * * `"workbook-design"` - The workbook designer
  * * `"workbook-map-add-layer"`- Add layers to the map
  * * `"workbook-view-management"` - Add/Edit/Remove workbook views (Is included in 'workbook-design'.)
+ * * `"embedded-dialog-footer-buttons"` - All footer buttons for Create/Edit Geometries and Select Objects dialogs
+ * * `"embedded-dialog-apply-button"` - Apply button for Create/Edit Geometries and Select Objects dialogs
+ * * `"embedded-dialog-cancel-button"` - Cancel button for Create/Edit Geometries and Select Objects dialogs
  * */
 /**
  * @typedef LayerDefinition
@@ -250,6 +254,8 @@ export class CadenzaClient {
     #iframeElement;
     /** @readonly */
     #debug;
+    /** @readonly */
+    #skipGuest;
     /** @type {[ CadenzaEventType | string, (event: CadenzaEvent<never>) => void ][]} */
     #subscriptions = [];
     /**
@@ -257,7 +263,7 @@ export class CadenzaClient {
      * @hidden
      * @param {CadenzaClientOptions} [__namedParameters]
      */
-    constructor({ baseUrl, debug = false, iframe, webApplication } = {}) {
+    constructor({ baseUrl, debug = false, skipGuest = false, iframe, webApplication, } = {}) {
         if (webApplication) {
             assert(validExternalLinkKey(webApplication), `Invalid webApplication parameter: ${webApplication}`);
         }
@@ -277,6 +283,7 @@ export class CadenzaClient {
             this.#log('Create Cadenza client for parent Cadenza');
         }
         this.#debug = debug;
+        this.#skipGuest = skipGuest;
         this.#webApplication = webApplication;
     }
     /** The base URL of the Cadenza server this client is requesting */
@@ -343,7 +350,7 @@ export class CadenzaClient {
                 'page' in source &&
                 source.page === 'welcome', 'labelSet is only supported on the welcome page');
         }
-        const params = createParams({
+        const params = this.#createParams({
             dataType,
             disabledUiFeatures,
             expandNavigator,
@@ -411,7 +418,7 @@ export class CadenzaClient {
             extentStrategy,
             geometry,
         });
-        const params = createParams({
+        const params = this.#createParams({
             disabledUiFeatures,
             expandNavigator,
             filter,
@@ -579,7 +586,7 @@ export class CadenzaClient {
         const validExtentStrategy = sanitizeExtentStrategy({
             extentStrategy,
         });
-        const params = createParams({
+        const params = this.#createParams({
             action: 'editGeometry',
             disabledUiFeatures,
             filter,
@@ -619,7 +626,7 @@ export class CadenzaClient {
             extentStrategy,
             geometry,
         });
-        const params = createParams({
+        const params = this.#createParams({
             action: 'editGeometry',
             disabledUiFeatures,
             filter,
@@ -658,7 +665,7 @@ export class CadenzaClient {
         const validExtentStrategy = sanitizeExtentStrategy({
             extentStrategy,
         });
-        const params = createParams({
+        const params = this.#createParams({
             action: 'editGeometry',
             batchModeEnabled: true,
             disabledUiFeatures,
@@ -698,7 +705,7 @@ export class CadenzaClient {
             extentStrategy,
             geometry: features.features[features.features.length - 1].geometry,
         });
-        const params = createParams({
+        const params = this.#createParams({
             action: 'editGeometry',
             batchModeEnabled: true,
             disabledUiFeatures,
@@ -765,6 +772,7 @@ export class CadenzaClient {
      *
      * @param {EmbeddingTargetId} backgroundMapView - The workbook map view
      * @param {object} [__namedParameters] - Options
+     * @param {UiFeature[]} [__namedParameters.disabledUiFeatures] - Cadenza UI features to disable
      * @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
      * @param {FilterVariables} [__namedParameters.filter] - Filter variables
      * @param {(WorkbookLayerPath | string)[]} [__namedParameters.layers] - Layers to restrict the selection to
@@ -781,13 +789,14 @@ export class CadenzaClient {
      * - {@link CadenzaSelectObjectsCancelEvent}
      * @embed
      */
-    async selectObjects(backgroundMapView, { extentStrategy, filter, layers, useMapSrs, operationMode, signal } = {}) {
+    async selectObjects(backgroundMapView, { disabledUiFeatures, extentStrategy, filter, layers, useMapSrs, operationMode, signal, } = {}) {
         this.#log('CadenzaClient#selectObjects', ...arguments);
         const validExtentStrategy = sanitizeExtentStrategy({
             extentStrategy,
         });
-        const params = createParams({
+        const params = this.#createParams({
             action: 'selectObjects',
+            disabledUiFeatures,
             filter,
             layers: layers?.map(array),
             useMapSrs,
@@ -1001,7 +1010,7 @@ export class CadenzaClient {
     fetchData(source, dataType, { filter, parts, signal } = {}) {
         this.#log('CadenzaClient#fetchData', ...arguments);
         assertSupportedDataType(dataType, ['csv', 'excel', 'json', 'pdf']);
-        const params = createParams({ dataType, filter, parts });
+        const params = this.#createParams({ dataType, filter, parts });
         return this.#fetch(resolvePath(source), params, signal);
     }
     /**
@@ -1021,7 +1030,7 @@ export class CadenzaClient {
      */
     fetchObjectInfo(source, layerPath, objectIds, { filter, signal, fullGeometries, useMapSrs } = {}) {
         this.#log('CadenzaClient#fetchObjectInfo', ...arguments);
-        const params = createParams({
+        const params = this.#createParams({
             filter,
         });
         return this.#fetch(resolvePath(source) + '/objectinfo', params, signal, JSON.stringify({
@@ -1047,7 +1056,7 @@ export class CadenzaClient {
      */
     fetchAreaIntersections(source, layerPath, geometry, { buffer, signal, useMapSrs } = {}) {
         this.#log('CadenzaClient#areaIntersections', ...arguments);
-        const params = createParams({});
+        const params = this.#createParams({});
         return this.#fetch(resolvePath(source) + '/area-intersections', params, signal, JSON.stringify({
             buffer,
             layerPath: array(layerPath),
@@ -1104,7 +1113,7 @@ export class CadenzaClient {
     downloadData(source, dataType, { fileName, filter, parts } = {}) {
         this.#log('CadenzaClient#downloadData', ...arguments);
         assertSupportedDataType(dataType, ['csv', 'excel', 'json', 'pdf']);
-        const params = createParams({ dataType, fileName, filter, parts });
+        const params = this.#createParams({ dataType, fileName, filter, parts });
         this.#download(resolvePath(source), params);
     }
     #download(/** @type string */ path, /** @type URLSearchParams */ params) {
@@ -1128,6 +1137,93 @@ export class CadenzaClient {
         }
         return url;
     }
+    /**
+     * @param {object} params
+     * @param {string} [params.action]
+     * @param {boolean} [params.batchModeEnabled]
+     * @param {DataType} [params.dataType]
+     * @param {UiFeature[]} [params.disabledUiFeatures]
+     * @param {boolean} [params.expandNavigator]
+     * @param {string} [params.fileName]
+     * @param {FilterVariables} [params.filter]
+     * @param {GeometryType} [params.geometryType]
+     * @param {boolean} [params.hideMainHeaderAndFooter]
+     * @param {boolean} [params.hideWorkbookToolBar]
+     * @param {GlobalId} [params.highlightGlobalId]
+     * @param {string} [params.labelSet]
+     * @param {WorkbookLayerPath[]} [params.layers]
+     * @param {number} [params.minScale]
+     * @param {OperationMode} [params.operationMode]
+     * @param {TablePart[]} [params.parts]
+     * @param {'MAP'} [params.targetType]
+     * @param {SnappingOptions} [params.snapping]
+     * @param {boolean} [params.useMapSrs]
+     * @param {ExtentStrategy} [params.validExtentStrategy]
+     * @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, }) {
+        if (disabledUiFeatures) {
+            disabledUiFeatures.forEach((feature) => assert(validUiFeature(feature), `Invalid UI feature: ${feature}`));
+        }
+        if (filter) {
+            assertValidFilterVariables(filter);
+        }
+        if (geometryType) {
+            assertValidGeometryType(geometryType);
+        }
+        if (operationMode) {
+            assert(validOperationMode(operationMode), `Invalid operation mode: ${operationMode}`);
+        }
+        if (layout) {
+            assert(validLayout(layout), `Invalid layout: ${layout}`);
+        }
+        if (parts) {
+            parts.forEach((part) => assert(validTablePart(part), `Invalid table part: ${part}`));
+        }
+        let locationFinder;
+        let mapExtent;
+        if (validExtentStrategy) {
+            if (validExtentStrategy.type === 'static') {
+                mapExtent = validExtentStrategy.extent;
+            }
+            else if (validExtentStrategy.type === 'locationFinder') {
+                locationFinder = validExtentStrategy.query;
+            }
+        }
+        return new URLSearchParams({
+            ...(action && { action }),
+            ...(batchModeEnabled && { batchModeEnabled: 'true' }),
+            ...(dataType && { dataType }),
+            ...(disabledUiFeatures && {
+                disabledUiFeatures: disabledUiFeatures.join(),
+            }),
+            ...(expandNavigator && { expandNavigator: 'true' }),
+            ...(fileName && { fileName }),
+            ...(filter &&
+                Object.fromEntries(Object.entries(filter).map(([variable, value]) => [
+                    `filter.${variable}`,
+                    JSON.stringify(value instanceof Date ? value.toISOString() : value),
+                ]))),
+            ...(geometryType && { geometryType }),
+            ...(hideMainHeaderAndFooter && { hideMainHeaderAndFooter: 'true' }),
+            ...(hideWorkbookToolBar && { hideWorkbookToolBar: 'true' }),
+            ...(highlightGlobalId && { highlightGlobalId }),
+            ...(labelSet && { labelSet }),
+            ...(layers?.length && { layers: JSON.stringify(layers) }),
+            ...(locationFinder && { locationFinder }),
+            ...(mapExtent && { mapExtent: mapExtent.join() }),
+            ...(minScale && { minScale: String(minScale) }),
+            ...(operationMode && { operationMode }),
+            ...(parts && { parts: parts.join() }),
+            ...(snapping && { snappingLayer: JSON.stringify(array(snapping.layer)) }),
+            ...(snapping?.types?.length && { snappingTypes: snapping.types.join() }),
+            ...(targetType && { targetType }),
+            ...(useMapSrs && { useMapSrs: 'true' }),
+            ...(layout && { layout }),
+            ...(this.#skipGuest && { skipGuestAccess: 'true' }),
+        });
+    }
     #log(/** @type unknown[] */ ...args) {
         if (this.#debug) {
             /** @type {unknown[]} */
@@ -1223,6 +1319,9 @@ function validUiFeature(/** @type string */ value) {
         'workbook-design',
         'workbook-map-add-layer',
         'workbook-view-management',
+        'embedded-dialog-footer-buttons',
+        'embedded-dialog-apply-button',
+        'embedded-dialog-cancel-button',
     ].includes(value);
 }
 function assertSupportedDataType(
@@ -1252,92 +1351,6 @@ 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}`));
 }
-/**
- * @param {object} params
- * @param {string} [params.action]
- * @param {boolean} [params.batchModeEnabled]
- * @param {DataType} [params.dataType]
- * @param {UiFeature[]} [params.disabledUiFeatures]
- * @param {boolean} [params.expandNavigator]
- * @param {string} [params.fileName]
- * @param {FilterVariables} [params.filter]
- * @param {GeometryType} [params.geometryType]
- * @param {boolean} [params.hideMainHeaderAndFooter]
- * @param {boolean} [params.hideWorkbookToolBar]
- * @param {GlobalId} [params.highlightGlobalId]
- * @param {string} [params.labelSet]
- * @param {WorkbookLayerPath[]} [params.layers]
- * @param {number} [params.minScale]
- * @param {OperationMode} [params.operationMode]
- * @param {TablePart[]} [params.parts]
- * @param {'MAP'} [params.targetType]
- * @param {SnappingOptions} [params.snapping]
- * @param {boolean} [params.useMapSrs]
- * @param {ExtentStrategy | undefined} [params.validExtentStrategy]
- * @param {Layout | undefined} [params.layout]
- * @return {URLSearchParams}
- */
-function createParams({ action, batchModeEnabled, dataType, disabledUiFeatures, expandNavigator, fileName, filter, geometryType, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, layers, minScale, operationMode, parts, targetType, snapping, useMapSrs, validExtentStrategy, layout, }) {
-    if (disabledUiFeatures) {
-        disabledUiFeatures.forEach((feature) => assert(validUiFeature(feature), `Invalid UI feature: ${feature}`));
-    }
-    if (filter) {
-        assertValidFilterVariables(filter);
-    }
-    if (geometryType) {
-        assertValidGeometryType(geometryType);
-    }
-    if (operationMode) {
-        assert(validOperationMode(operationMode), `Invalid operation mode: ${operationMode}`);
-    }
-    if (layout) {
-        assert(validLayout(layout), `Invalid layout: ${layout}`);
-    }
-    if (parts) {
-        parts.forEach((part) => assert(validTablePart(part), `Invalid table part: ${part}`));
-    }
-    let locationFinder;
-    let mapExtent;
-    if (validExtentStrategy) {
-        if (validExtentStrategy.type === 'static') {
-            mapExtent = validExtentStrategy.extent;
-        }
-        else if (validExtentStrategy.type === 'locationFinder') {
-            locationFinder = validExtentStrategy.query;
-        }
-    }
-    return new URLSearchParams({
-        ...(action && { action }),
-        ...(batchModeEnabled && { batchModeEnabled: 'true' }),
-        ...(dataType && { dataType }),
-        ...(disabledUiFeatures && {
-            disabledUiFeatures: disabledUiFeatures.join(),
-        }),
-        ...(expandNavigator && { expandNavigator: 'true' }),
-        ...(fileName && { fileName }),
-        ...(filter &&
-            Object.fromEntries(Object.entries(filter).map(([variable, value]) => [
-                `filter.${variable}`,
-                JSON.stringify(value instanceof Date ? value.toISOString() : value),
-            ]))),
-        ...(geometryType && { geometryType }),
-        ...(hideMainHeaderAndFooter && { hideMainHeaderAndFooter: 'true' }),
-        ...(hideWorkbookToolBar && { hideWorkbookToolBar: 'true' }),
-        ...(highlightGlobalId && { highlightGlobalId }),
-        ...(labelSet && { labelSet }),
-        ...(layers?.length && { layers: JSON.stringify(layers) }),
-        ...(locationFinder && { locationFinder }),
-        ...(mapExtent && { mapExtent: mapExtent.join() }),
-        ...(minScale && { minScale: String(minScale) }),
-        ...(operationMode && { operationMode }),
-        ...(parts && { parts: parts.join() }),
-        ...(snapping && { snappingLayer: JSON.stringify(array(snapping.layer)) }),
-        ...(snapping?.types?.length && { snappingTypes: snapping.types.join() }),
-        ...(targetType && { targetType }),
-        ...(useMapSrs && { useMapSrs: 'true' }),
-        ...(layout && { layout }),
-    });
-}
 function array(/** @type unknown */ value) {
     return Array.isArray(value) ? value : [value];
 }
@@ -1455,7 +1468,7 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
  * See also: <a href="../index.html#md:json-representation-of-cadenza-object-data">JSON Representation of Cadenza Object Data</a>
  */
 /** @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', Feature>} CadenzaEditGeometryOkEvent - When the user submitted the geometry. */
+/** @typedef {CadenzaEvent<'editGeometry:ok', FeatureCollection | Feature>} CadenzaEditGeometryOkEvent - When the user submitted the geometry. `FeatureCollection` if batch editing is enabled. */
 /** @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} */
 /** @typedef {CadenzaEvent<'objectInfo', {layer: WorkbookLayerPath, objectInfos: {selectionIndex: number, elements: {attributePrintName: string, formattedValue: string}[]}}>} CadenzaObjectInfoEvent - When the user opened the object info flyout. */

package/package.json

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

package/sandbox.html

@@ -304,11 +304,11 @@
           <optgroup label="Interact With Shown Content">
             <option value="expandNavigator">Expand Navigator</option>
             <option value="getData">Get Data (Get Map Image)</option>
-            <option value="setFilter" class="unpublished">Set Filter</option>
-            <option value="setLayerVisibility" class="unpublished">Set Layer Visibility</option>
-            <option value="setSelection" class="unpublished">Set Selection</option>
-            <option value="addSelection" class="unpublished">Add Selection</option>
-            <option value="removeSelection" class="unpublished">Remove Selection</option>
+            <option value="setFilter">Set Filter</option>
+            <option value="setLayerVisibility">Set Layer Visibility</option>
+            <option value="setSelection">Set Selection</option>
+            <option value="addSelection">Add Selection</option>
+            <option value="removeSelection">Remove Selection</option>
             <option value="reload">Reload worksheet views</option>
             <option value="closeMe">Close me</option>
           </optgroup>
@@ -400,6 +400,9 @@
         <li>workbook-design</li>
         <li>workbook-map-add-layer</li>
         <li>workbook-view-management</li>
+        <li>embedded-dialog-footer-buttons</li>
+        <li>embedded-dialog-apply-button</li>
+        <li>embedded-dialog-cancel-button</li>
       </ul>
     </small>
   </div>
@@ -654,7 +657,7 @@
   </div>
 </template>
 
-<template data-action="selectObjects" data-common="simplifiedOperationMode,extentStrategy,map,filter">
+<template data-action="selectObjects" data-common="extentStrategy,map,disabledUiFeatures,filter">
   <div>
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>