crumb-widget 1.5.0 → 1.5.2

package/dist/module.d.ts

@@ -1,21 +1,61 @@
-import { CrumbWidgetConfig, Column } from './types';
-export type { CrumbWidgetConfig, Column };
+import { CrumbWidgetConfig, Column, TilesConfig, MarkerConfig } from './types';
+export type { CrumbWidgetConfig, Column, TilesConfig, MarkerConfig };
+/**
+ * Options accepted by {@link mountCrumbWidget}. Extends {@link CrumbWidgetConfig}
+ * with the two fields that are required up-front in library mode:
+ *
+ * - `serverUrl` — the BMLT root server to query (required).
+ * - `serviceBodyIds` — optional list of service bodies to scope the query to;
+ *    when omitted, the widget queries all meetings on the server.
+ *
+ * All inherited fields from {@link CrumbWidgetConfig} are optional and follow
+ * the same defaults as the IIFE bundle.
+ */
 export interface MountOptions extends CrumbWidgetConfig {
-    /** URL of the BMLT server (required) */
+    /** URL of the BMLT root server (required), e.g. `https://bmlt.example.org/main_server/`. */
     serverUrl: string;
-    /** Service body IDs to filter by (defaults to all) */
+    /**
+     * Service body IDs to filter by. Defaults to all (every meeting on the
+     * server). The search is recursive — child service bodies are included.
+     */
     serviceBodyIds?: number[];
 }
 /**
- * Mount the Crumb Widget into the given element.
+ * Mount the Crumb Widget into the given DOM element.
+ *
+ * The element should be empty — the widget renders its full UI into it. The
+ * element's `id` (or `"crumb-widget"` if it has none) is used as a stable
+ * identifier for in-page anchors and routing.
+ *
+ * Calling this function:
+ *
+ * 1. Validates and stores the supplied options into the shared config store.
+ * 2. Resolves the active language (explicit `options.language` →
+ *    `navigator.language` → `"en"`) and initializes the i18n store.
+ * 3. Applies the dark-mode class to the element when `darkMode` is `true` or
+ *    `'auto'`.
+ * 4. Mounts the root Svelte component, which kicks off the BMLT data load.
  *
- * @example
+ * The function returns synchronously — meeting data loads asynchronously
+ * after mount and the widget shows a loading state until it arrives.
+ *
+ * @param el - The host element to render the widget into.
+ * @param options - Configuration. See {@link MountOptions}.
+ *
+ * @example Minimal mount
  * ```ts
- * import { mountCrumbWidget } from 'crumb-widget';
+ * mountCrumbWidget(document.getElementById('widget')!, {
+ *   serverUrl: 'https://bmlt.example.org/main_server/',
+ * });
+ * ```
  *
- * mountCrumbWidget(document.getElementById('my-widget'), {
+ * @example With service bodies and custom view
+ * ```ts
+ * mountCrumbWidget(document.getElementById('widget')!, {
  *   serverUrl: 'https://bmlt.example.org/main_server/',
  *   serviceBodyIds: [1, 2, 3],
+ *   view: 'both',
+ *   darkMode: 'auto',
  * });
  * ```
  */