@disy/cadenza.js 2.3.0 → 2.3.2

package/cadenza.js

@@ -96,6 +96,9 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
  * _Note:_ Since numbers in JavaScript are Double values ([more info on MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number#number_encoding)),
  * for Long variables, the API is currently limited to the Double value range.
  */
+let hasCadenzaSession = false;
+/** @type {Promise<void> | undefined} */
+let firstEmbeddingTargetShown;
 /**
  * _Notes:_
  * * Most public methods can be aborted using an [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal).
@@ -442,10 +445,24 @@ export class CadenzaClient {
         });
         return this.#show(resolvePath(backgroundMapView), params, signal);
     }
-    #show(
-    /** @type string */ path, 
-    /** @type URLSearchParams */ params, 
-    /** @type AbortSignal | undefined */ signal) {
+    /**
+     * @param {string} path
+     * @param {URLSearchParams} params
+     * @param {AbortSignal} [signal]
+     * @return {Promise<void>}
+     */
+    #show(path, params, signal) {
+        const waitForFirstEmbeddingTargetShown = !(hasCadenzaSession || isTest());
+        /*
+         * If we show multiple embedding targets at the same time,
+         * there's a race condition in the session creation for guest users.
+         * To work around that, we wait for the first embedding target to be shown
+         * (which implicitly creates the session for all embedding targets).
+         * Note: We do not wait in tests to keep them simple.
+         */
+        if (waitForFirstEmbeddingTargetShown && firstEmbeddingTargetShown != null) {
+            return firstEmbeddingTargetShown.finally(() => this.#show(path, params, signal));
+        }
         const webApplication = this.#webApplication;
         if (webApplication) {
             params.set('webApplicationLink', webApplication.externalLinkId);
@@ -454,7 +471,15 @@ export class CadenzaClient {
         const url = this.#createUrl(path, params);
         this.#log('Load iframe', url.toString());
         this.#requiredIframe.src = url.toString();
-        return this.#getIframePromise(signal);
+        const promise = this.#getIframePromise(signal);
+        if (waitForFirstEmbeddingTargetShown) {
+            // Use Promise.allSettled() to handle Promise rejections.
+            firstEmbeddingTargetShown ??= Promise.allSettled([promise]).then(([{ status }]) => {
+                firstEmbeddingTargetShown = undefined;
+                hasCadenzaSession = status === 'fulfilled';
+            });
+        }
+        return promise;
     }
     #getIframePromise(/** @type AbortSignal | undefined */ signal) {
         const iframe = this.#requiredIframe;
@@ -594,7 +619,7 @@ export class CadenzaClient {
      *   Currently only table and indicator views are supported.
      * @param {DataType} dataType - The data type you want to get back from the server.
      *   Currently, `"csv"`, `"excel"` and `"json"` are supported.
-     * @param {object} options - Options
+     * @param {object} [options] - Options
      * @param {TablePart[]} [options.parts] - Table parts to export; If not specified, all parts are exported.
      * @param {AbortSignal} [options.signal] - A signal to abort the data fetching
      * @return {Promise<Response>} A `Promise` for the fetch response
@@ -632,12 +657,12 @@ export class CadenzaClient {
      *   Currently only table and indicator views are supported.
      * @param {DataType} dataType - The data type you want to get back from the server.
      *   Currently, `"csv"`, `"excel"` and `"json"` are supported.
-     * @param {object} options - Options
+     * @param {object} [options] - Options
      * @param {string} [options.fileName] - The file name to use; The file extension is appended by Cadenza.
      * @param {TablePart[]} [options.parts] - Table parts to export; If not specified, all parts are exported.
      * @throws For invalid arguments
      */
-    downloadData(source, dataType, { fileName, parts }) {
+    downloadData(source, dataType, { fileName, parts } = {}) {
         this.#log('CadenzaClient#downloadData', ...arguments);
         assertSupportedDataType(dataType, ['csv', 'excel', 'json']);
         const params = createParams({ dataType, fileName, parts });
@@ -882,7 +907,7 @@ function array(/** @type unknown */ value) {
 /** @typedef {CadenzaEvent<'editGeometry:ok', {geometry: Geometry}>} CadenzaEditGeometryOkEvent - When the user submitted the geometry. */
 /** @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, formattedValues: Record<string, string>}[]}>} CadenzaObjectInfoEvent - When the user opened the object info flyout. */
+/** @typedef {CadenzaEvent<'objectInfo', {layer: WorkbookLayerPath, objectInfos: {selectionIndex: number, elements: {attributePrintName: string, formattedValue: string}[]}}>} CadenzaObjectInfoEvent - When the user opened the object info flyout. */
 /** @typedef {CadenzaEvent<'selectObjects:ok', {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection. */
 /** @typedef {CadenzaEvent<'selectObjects:cancel'>} CadenzaSelectObjectsCancelEvent - When the user cancelled the selection. */
 export class AbortError extends DOMException {
@@ -909,3 +934,6 @@ export class CadenzaError extends Error {
         return this.#type;
     }
 }
+function isTest() {
+    return location.href === 'test';
+}

package/package.json

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

package/sandbox.html

@@ -291,18 +291,19 @@
 </footer>
 
 <template id="common-show">
-  <div>
-    <label>
-      <input type="checkbox" name="expandNavigator">
-      Expand navigator tree
-    </label>
-  </div>
   <div>
     <label>
       <input type="checkbox" name="hideMainHeaderAndFooter">
       Hide main header and footer
     </label>
   </div>
+  <div>
+    <label for="highlightGlobalId">Highlighted Global ID</label>
+    <input name="highlightGlobalId" id="highlightGlobalId">
+  </div>
+</template>
+
+<template id="common-showWorkbook">
   <div>
     <label>
       <input type="checkbox" name="hideWorkbookToolBar">
@@ -315,10 +316,6 @@
       Simplified operation mode
     </label>
   </div>
-  <div>
-    <label for="highlightGlobalId">Highlighted Global ID</label>
-    <input name="highlightGlobalId" id="highlightGlobalId">
-  </div>
   <div>
     <label for="disabledUiFeatures">Disabled UI features</label>
     <input name="disabledUiFeatures" id="disabledUiFeatures" placeholder="feature1,feature2,...">
@@ -343,6 +340,12 @@
       <p>Pass <code>null</code> to unset a variable.</p>
     </small>
   </div>
+  <div>
+    <label>
+      <input type="checkbox" name="expandNavigator">
+      Expand navigator tree
+    </label>
+  </div>
 </template>
 
 <template id="common-map">
@@ -385,7 +388,7 @@
   </div>
 </template>
 
-<template data-action="show" data-common="show">
+<template data-action="show" data-common="showWorkbook,show">
   <div>
     <label for="embeddingTargetId">Embedding target ID *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>
@@ -421,7 +424,7 @@
   </div>
 </template>
 
-<template data-action="showMap" data-common="map,show">
+<template data-action="showMap" data-common="map,showWorkbook,show">
   <div>
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>