npm - @disy/cadenza.js - Versions diffs - 0.0.1 - Mend

@disy/cadenza.js 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (29) hide show

package/CHANGELOG.md +15 -0
package/LICENSE +21 -0
package/README.md +189 -0
package/apidoc/.nojekyll +1 -0
package/apidoc/assets/highlight.css +120 -0
package/apidoc/assets/main.js +58 -0
package/apidoc/assets/search.js +1 -0
package/apidoc/assets/style.css +1367 -0
package/apidoc/classes/AbortError.html +541 -0
package/apidoc/classes/CadenzaClient.html +569 -0
package/apidoc/classes/CadenzaError.html +227 -0
package/apidoc/functions/cadenza.html +90 -0
package/apidoc/index.html +137 -0
package/apidoc/interfaces/CadenzaEvent.html +104 -0
package/apidoc/interfaces/Geometry.html +88 -0
package/apidoc/interfaces/WorkbookKey.html +98 -0
package/apidoc/interfaces/WorkbookViewKey.html +108 -0
package/apidoc/interfaces/WorksheetKey.html +108 -0
package/apidoc/modules.html +82 -0
package/apidoc/types/CadenzaErrorEvent.html +67 -0
package/apidoc/types/EmbeddingTargetId.html +60 -0
package/apidoc/types/Extent.html +60 -0
package/apidoc/types/GeometryType.html +61 -0
package/apidoc/types/WorkbookSource.html +60 -0
package/apidoc/types/WorkbookViewSource.html +60 -0
package/apidoc/types/WorksheetSource.html +60 -0
package/cadenza.d.ts +296 -0
package/cadenza.js +446 -0
package/package.json +41 -0

package/apidoc/types/WorksheetSource.html ADDED Viewed

@@ -0,0 +1,60 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorksheetSource | Cadenza JS</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<div class="tsd-toolbar-contents container">
+<div class="table-cell" id="tsd-search" data-base="..">
+<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
+<div class="field">
+<div id="tsd-toolbar-links"></div></div>
+<ul class="results">
+<li class="state loading">Preparing search index...</li>
+<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS</a></div>
+<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
+<div class="container container-main">
+<div class="col-content">
+<div class="tsd-page-title">
+<ul class="tsd-breadcrumb">
+<li><a href="../modules.html">Cadenza JS</a></li>
+<li><a href="WorksheetSource.html">WorksheetSource</a></li></ul>
+<h1>Type alias WorksheetSource</h1></div>
+<div class="tsd-signature"><span class="tsd-kind-type-alias">Worksheet<wbr/>Source</span><span class="tsd-signature-symbol">:</span> <a href="EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/WorksheetKey.html" class="tsd-signature-type tsd-kind-interface">WorksheetKey</a></div>
+<div class="tsd-comment tsd-typography"><p>A worksheet source</p>
+</div>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/68d655f/src/cadenza.js#L48">src/cadenza.js:48</a></li></ul></aside></div>
+<div class="col-sidebar">
+<div class="page-menu">
+<div class="tsd-navigation settings">
+<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
+<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
+<div class="tsd-accordion-details">
+<div class="tsd-filter-visibility">
+<h4 class="uppercase">Member Visibility</h4><form>
+<ul id="tsd-filter-options">
+<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
+<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
+<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
+<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
+<div class="tsd-theme-toggle">
+<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
+<div class="site-menu">
+<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Cadenza JS</span></a>
+<ul class="tsd-small-nested-navigation">
+<li><a href="../classes/AbortError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Abort<wbr/>Error</span></a></li>
+<li><a href="../classes/CadenzaClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Client</span></a></li>
+<li><a href="../classes/CadenzaError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Error</span></a></li>
+<li><a href="../interfaces/CadenzaEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Cadenza<wbr/>Event</span></a></li>
+<li><a href="../interfaces/Geometry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Geometry</span></a></li>
+<li><a href="../interfaces/WorkbookKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workbook<wbr/>Key</span></a></li>
+<li><a href="../interfaces/WorkbookViewKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workbook<wbr/>View<wbr/>Key</span></a></li>
+<li><a href="../interfaces/WorksheetKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worksheet<wbr/>Key</span></a></li>
+<li><a href="CadenzaErrorEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Cadenza<wbr/>Error<wbr/>Event</span></a></li>
+<li><a href="EmbeddingTargetId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Embedding<wbr/>Target<wbr/>Id</span></a></li>
+<li><a href="Extent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Extent</span></a></li>
+<li><a href="GeometryType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Geometry<wbr/>Type</span></a></li>
+<li><a href="WorkbookSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Workbook<wbr/>Source</span></a></li>
+<li><a href="WorkbookViewSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Workbook<wbr/>View<wbr/>Source</span></a></li>
+<li><a href="WorksheetSource.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worksheet<wbr/>Source</span></a></li>
+<li><a href="../functions/cadenza.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>cadenza</span></a></li></ul></nav></div></div></div>
+<div class="tsd-generator">
+<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
+<div class="overlay"></div></body></html>

package/cadenza.d.ts ADDED Viewed

@@ -0,0 +1,296 @@
+/**
+ * Creates a new Cadenza instance of the Cadenza JS client.
+ *
+ * @param {string} baseUrl - The base URL of the Cadenza server
+ * @param {object} [options] - Options
+ * @param {HTMLIFrameElement | string} [options.iframe] - An iframe for embedding Cadenza or the iframe's ID
+ * @param {boolean} [options.debug] - Whether to enable debug logging
+ * @throws For invalid base URL
+ */
+export function cadenza(baseUrl: string, options?: {
+    iframe?: string | HTMLIFrameElement | undefined;
+    debug?: boolean | undefined;
+} | undefined): CadenzaClient;
+/** @typedef {string} EmbeddingTargetId - The ID of an embedding target */
+/**
+ * @typedef WorkbookKey - A tuple qualifying a workbook
+ * @property {string} repositoryName - The name of the workbook's repository
+ * @property {string} workbookId - The ID of the workbook
+ */
+/**
+ * @typedef WorksheetKey - A tuple qualifying a worksheet
+ * @property {string} repositoryName - The name of the workbook's repository
+ * @property {string} workbookId - The ID of the workbook
+ * @property {string} worksheetId - The ID of the worksheet
+ */
+/**
+ * @typedef WorkbookViewKey - A tuple qualifying a workbook view
+ * @property {string} repositoryName - The name of the workbook's repository
+ * @property {string} workbookId - The ID of the workbook
+ * @property {string} viewId - The ID of the view
+ */
+/** @typedef {EmbeddingTargetId | WorkbookKey} WorkbookSource - A workbook source */
+/** @typedef {EmbeddingTargetId | WorksheetKey} WorksheetSource - A worksheet source */
+/** @typedef {EmbeddingTargetId | WorkbookViewKey} WorkbookViewSource - A workbook view source */
+/**
+ * @typedef Geometry - A [GeoJSON](https://geojson.org/) geometry object
+ * @property {GeometryType} type - The type of the geometry
+ */
+/**
+ * @typedef {'Point'|'MultiPoint'|'LineString'|'MultiLineString'|'Polygon'|'MultiPolygon'} GeometryType - A GeoJSON geometry type
+ *
+ * _Note:_ The GeoJSON geometry type "GeometryCollection" is currently not supported.
+ */
+/** @typedef {[number,number,number,number]} Extent - An array of numbers representing an extent: [minx, miny, maxx, maxy] */
+/**
+ * _Notes:_
+ * * Most public methods can be aborted using an [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal).
+ *   When aborted, the result Promise is rejected with an {@link AbortError}.
+ * * If there's another error, the result Promise is rejected with a {@link CadenzaError}.
+ * * For methods that support the `hideMainHeaderAndFooter` and `hideWorkbookToolBar` parameters - the parameters cannot override the configuration of an embedding target.
+ * * For methods that support the `locationFinder` and `mapExtent` parameters - when both are given, the `mapExtent` takes precedence.
+ */
+export class CadenzaClient {
+    /**
+     * @hidden
+     * @param {string} baseUrl
+     * @param {object} [options]
+     * @param {HTMLIFrameElement | string} [options.iframe]
+     * @param {boolean} [options.debug]
+     */
+    constructor(baseUrl: string, { debug, iframe }?: {
+        iframe?: string | HTMLIFrameElement | undefined;
+        debug?: boolean | undefined;
+    } | undefined);
+    /** The base URL of the Cadenza server this client is requesting */
+    get baseUrl(): string;
+    /** The iframe this client is using for embedding Cadenza. */
+    get iframe(): HTMLIFrameElement | undefined;
+    /**
+     * Show a workbook, worksheet or workbook view in an iframe.
+     *
+     * @param {WorkbookSource | WorksheetSource | WorkbookViewSource} source - The source to show
+     * @param {object} [options]
+     * @param {boolean} [options.hideMainHeaderAndFooter] - Whether to hide the main Cadenza header and footer.
+     * @param {boolean} [options.hideWorkbookToolBar] - Whether to hide the workbook toolbar.
+     * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
+     * @return {Promise<void>} A Promise for when the iframe is loaded
+     * @throws For an invalid source
+     */
+    show(source: WorkbookSource | WorksheetSource | WorkbookViewSource, { hideMainHeaderAndFooter, hideWorkbookToolBar, signal }?: {
+        hideMainHeaderAndFooter?: boolean | undefined;
+        hideWorkbookToolBar?: boolean | undefined;
+        signal?: AbortSignal | undefined;
+    } | undefined): Promise<void>;
+    /**
+     * Show a workbook map view in an iframe.
+     *
+     * @param {WorkbookViewSource} mapView - The workbook map view to show
+     * @param {object} [options] - Options
+     * @param {Geometry} [options.geometry] - A geometry to show on the map
+     * @param {boolean} [options.hideMainHeaderAndFooter] - Whether to hide the main Cadenza header and footer.
+     * @param {boolean} [options.hideWorkbookToolBar] - Whether to hide the workbook toolbar.
+     * @param {string} [options.locationFinder] - A search query for the location finder
+     * @param {Extent} [options.mapExtent] - A map extent to set
+     * @param {boolean} [options.useMapSrs] -  Whether the geometry and the extent are in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
+     * @return {Promise<void>} A Promise for when the iframe is loaded
+     * @throws For an invalid workbook view source or geometry type
+     */
+    showMap(mapView: WorkbookViewSource, { geometry, hideMainHeaderAndFooter, hideWorkbookToolBar, locationFinder, mapExtent, useMapSrs, signal, }?: {
+        geometry?: Geometry | undefined;
+        hideMainHeaderAndFooter?: boolean | undefined;
+        hideWorkbookToolBar?: boolean | undefined;
+        locationFinder?: string | undefined;
+        mapExtent?: Extent | undefined;
+        useMapSrs?: boolean | undefined;
+        signal?: AbortSignal | undefined;
+    } | undefined): Promise<void>;
+    /**
+     * Create a geometry.
+     *
+     * _Note:_ Under the hood, creating a geometry is similar to editing a geometry.
+     * That's why the events use the `editGeometry` prefix.
+     *
+     * @param {WorkbookViewSource} backgroundMapView - The workbook map view in the background
+     * @param {GeometryType} geometryType - The geometry type
+     * @param {object} [options] - Options
+     * @param {Extent} [options.mapExtent] - A map extent to set
+     * @param {string} [options.locationFinder] - A search query for the location finder
+     * @param {boolean} [options.useMapSrs] - Whether the created geometry should use the map's SRS (otherwise EPSG:4326 will be used)
+     * @param {number} [options.minScale] - The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.
+     * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
+     * @return {Promise<void>} A Promise for when the iframe is loaded
+     * @throws For an invalid workbook view source or geometry type
+     * @fires `editGeometry:update` - When the user changed the geometry. The event includes the edited geometry.
+     * @fires `editGeometry:ok` - When the user completed the geometry editing. The event includes the edited geometry.
+     * @fires `editGeometry:cancel` - When the user cancelled the geometry editing in Cadenza.
+     */
+    createGeometry(backgroundMapView: WorkbookViewSource, geometryType: GeometryType, { mapExtent, locationFinder, useMapSrs, minScale, signal }?: {
+        mapExtent?: Extent | undefined;
+        locationFinder?: string | undefined;
+        useMapSrs?: boolean | undefined;
+        minScale?: number | undefined;
+        signal?: AbortSignal | undefined;
+    } | undefined): Promise<void>;
+    /**
+     * Edit a geometry.
+     *
+     * @param {WorkbookViewSource} backgroundMapView - The workbook map view in the background
+     * @param {Geometry} geometry - The geometry
+     * @param {object} [options] - Options
+     * @param {string} [options.locationFinder] - A search query for the location finder
+     * @param {Extent} [options.mapExtent] - A map extent to set
+     * @param {boolean} [options.useMapSrs] - Whether the geometry is in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {number} [options.minScale] - The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.
+     * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
+     * @return {Promise<void>} A Promise for when the iframe is loaded
+     * @throws For an invalid workbook view source
+     * @fires `editGeometry:update` - When the user changed the geometry. The event includes the edited geometry.
+     * @fires `editGeometry:ok` - When the user completed the geometry editing. The event includes the edited geometry.
+     * @fires `editGeometry:cancel` - When the user cancelled the geometry editing in Cadenza.
+     */
+    editGeometry(backgroundMapView: WorkbookViewSource, geometry: Geometry, { mapExtent, locationFinder, useMapSrs, minScale, signal }?: {
+        locationFinder?: string | undefined;
+        mapExtent?: Extent | undefined;
+        useMapSrs?: boolean | undefined;
+        minScale?: number | undefined;
+        signal?: AbortSignal | undefined;
+    } | undefined): Promise<void>;
+    /**
+     * Subscribe to a `postMessage()` event.
+     *
+     * @template [T=unknown]
+     * @param {string} type - The event type
+     * @param {(event: CadenzaEvent<T>) => void} subscriber - The subscriber function
+     * @return {() => void} An unsubscribe function
+     */
+    on<T = unknown>(type: string, subscriber: (event: CadenzaEvent<T>) => void): () => void;
+    #private;
+}
+/**
+ * @template [T=unknown]
+ * @typedef CadenzaEvent - A Cadenza `postMessage()` event
+ * @property {string} type - The event type
+ * @property {T} detail - Optional event details (depending on the event type)
+ */
+/** @typedef {CadenzaEvent<{type: string, message?: string}>} CadenzaErrorEvent - An error event that is mapped to a {@link CadenzaError} */
+export class AbortError extends DOMException {
+    constructor();
+}
+/**
+ * An `Error` implementation for errors in the communication with Cadenza.
+ *
+ * _Note:_ For invalid parameters, the Cadenza client will throw "normal" `Error`s.
+ */
+export class CadenzaError extends Error {
+    /**
+     * @param {string} type - The technical identifier of the error
+     * @param {string} message - A description of the error
+     */
+    constructor(type: string, message: string);
+    get type(): string;
+    #private;
+}
+/**
+ * - The ID of an embedding target
+ */
+export type EmbeddingTargetId = string;
+/**
+ * - A tuple qualifying a workbook
+ */
+export type WorkbookKey = {
+    /**
+     * - The name of the workbook's repository
+     */
+    repositoryName: string;
+    /**
+     * - The ID of the workbook
+     */
+    workbookId: string;
+};
+/**
+ * - A tuple qualifying a worksheet
+ */
+export type WorksheetKey = {
+    /**
+     * - The name of the workbook's repository
+     */
+    repositoryName: string;
+    /**
+     * - The ID of the workbook
+     */
+    workbookId: string;
+    /**
+     * - The ID of the worksheet
+     */
+    worksheetId: string;
+};
+/**
+ * - A tuple qualifying a workbook view
+ */
+export type WorkbookViewKey = {
+    /**
+     * - The name of the workbook's repository
+     */
+    repositoryName: string;
+    /**
+     * - The ID of the workbook
+     */
+    workbookId: string;
+    /**
+     * - The ID of the view
+     */
+    viewId: string;
+};
+/**
+ * - A workbook source
+ */
+export type WorkbookSource = EmbeddingTargetId | WorkbookKey;
+/**
+ * - A worksheet source
+ */
+export type WorksheetSource = EmbeddingTargetId | WorksheetKey;
+/**
+ * - A workbook view source
+ */
+export type WorkbookViewSource = EmbeddingTargetId | WorkbookViewKey;
+/**
+ * - A [GeoJSON](https://geojson.org/) geometry object
+ */
+export type Geometry = {
+    /**
+     * - The type of the geometry
+     */
+    type: GeometryType;
+};
+/**
+ * - A GeoJSON geometry type
+ *
+ * _Note:_ The GeoJSON geometry type "GeometryCollection" is currently not supported.
+ */
+export type GeometryType = 'Point' | 'MultiPoint' | 'LineString' | 'MultiLineString' | 'Polygon' | 'MultiPolygon';
+/**
+ * - An array of numbers representing an extent: [minx, miny, maxx, maxy]
+ */
+export type Extent = [number, number, number, number];
+/**
+ * - A Cadenza `postMessage()` event
+ */
+export type CadenzaEvent<T = unknown> = {
+    /**
+     * - The event type
+     */
+    type: string;
+    /**
+     * - Optional event details (depending on the event type)
+     */
+    detail: T;
+};
+/**
+ * - An error event that is mapped to a {@link CadenzaError }
+ */
+export type CadenzaErrorEvent = CadenzaEvent<{
+    type: string;
+    message?: string;
+}>;