@api-client/ui 0.5.57 → 0.6.0

package/build/src/help/help_service_controller.d.ts

@@ -0,0 +1,108 @@
+import type { HelpTopic } from './help_topic.js';
+export interface HelpServiceInit {
+    /**
+     * Mapping of help categories to their respective JSON or YAML file URLs.
+     *
+     * Example:
+     * ```typescript
+     * {
+     *   property: '/help/property.yaml',
+     *   entity: '/help/entity.yaml',
+     *   // ...
+     * }
+     * ```
+     */
+    categories: Record<string, string>;
+    /**
+     * Current version of the help data.
+     * Used to determine if an update is needed.
+     * Should follow semantic versioning (e.g., "1.0.0").
+     * By convention it should be the version of the app.
+     */
+    version: string;
+}
+/**
+ * HelpServiceController manages help topics stored in IndexedDB.
+ * It supports loading topics from JSON or YAML files, querying, and searching.
+ */
+export declare class HelpServiceController {
+    private db;
+    private initPromise;
+    /**
+     * The current version of the help data.
+     * Used to determine if an update is needed.
+     */
+    private currentVersion;
+    /**
+     * The available help categories and their corresponding files.
+     */
+    private categories;
+    private static readonly DB_NAME;
+    private static readonly DB_VERSION;
+    private _initialized;
+    /**
+     * Indicates whether the help service has been initialized.
+     * Initialization includes setting up the IndexedDB and loading help data if necessary.
+     */
+    get initialized(): boolean;
+    /**
+     * Promise that resolves when the help service is fully initialized.
+     * If the service is already initialized, it resolves immediately.
+     */
+    get untilReady(): Promise<void>;
+    constructor(init: HelpServiceInit);
+    /**
+     * Initialize the help service
+     */
+    private initialize;
+    private doInitialize;
+    /**
+     * Initialize IndexedDB database
+     */
+    private initDatabase;
+    /**
+     * Check if help data needs to be updated and update if necessary
+     */
+    private checkAndUpdateHelpData;
+    /**
+     * Load help data from JSON files and store in IndexedDB
+     */
+    private loadHelpDataFromFiles;
+    /**
+     * Load topics from a JSON or YAML file
+     */
+    private loadTopicsFromFile;
+    /**
+     * Generate a unique key for a topic
+     */
+    private getTopicKey;
+    /**
+     * Get a specific help topic
+     */
+    getTopic(category: string, id: string): Promise<HelpTopic | undefined>;
+    /**
+     * Get all topics for a specific category
+     */
+    getTopicsByCategory(category: string): Promise<HelpTopic[]>;
+    /**
+     * Search topics by title or content
+     */
+    searchTopics(query: string): Promise<HelpTopic[]>;
+    /**
+     * Get all available topics
+     */
+    getAllTopics(): Promise<HelpTopic[]>;
+    /**
+     * Get current version
+     */
+    getVersion(): string | null;
+    /**
+     * Force refresh of help data (useful for development)
+     */
+    forceRefresh(): Promise<void>;
+    /**
+     * Clear all help data from IndexedDB
+     */
+    clearAllData(): Promise<void>;
+}
+//# sourceMappingURL=help_service_controller.d.ts.map

package/build/src/help/help_service_controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"help_service_controller.d.ts","sourceRoot":"","sources":["../../../src/help/help_service_controller.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAe,MAAM,iBAAiB,CAAA;AAgB7D,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;GAGG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,EAAE,CAAoC;IAC9C,OAAO,CAAC,WAAW,CAA6B;IAChD;;;OAGG;IACH,OAAO,CAAC,cAAc,CAAQ;IAE9B;;OAEG;IACH,OAAO,CAAC,UAAU,CAAwB;IAE1C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAiB;IAChD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAI;IAEtC,OAAO,CAAC,YAAY,CAAQ;IAE5B;;;OAGG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;OAGG;IACH,IAAI,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAE9B;gBAEW,IAAI,EAAE,eAAe;IAMjC;;OAEG;YACW,UAAU;YAQV,YAAY;IAa1B;;OAEG;YACW,YAAY;IAoB1B;;OAEG;YACW,sBAAsB;IAyBpC;;OAEG;YACW,qBAAqB;IAiCnC;;OAEG;YACW,kBAAkB;IAgBhC;;OAEG;IACH,OAAO,CAAC,WAAW;IAInB;;OAEG;IACU,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAanF;;OAEG;IACU,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAWxE;;OAEG;IACU,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAgC9D;;OAEG;IACU,YAAY,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAUjD;;OAEG;IACI,UAAU,IAAI,MAAM,GAAG,IAAI;IAIlC;;OAEG;IACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAa1C;;OAEG;IACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAW3C"}

package/build/src/help/help_service_controller.js

@@ -0,0 +1,252 @@
+import { openDB } from 'idb';
+import { parse as parseYaml } from 'yaml';
+/**
+ * HelpServiceController manages help topics stored in IndexedDB.
+ * It supports loading topics from JSON or YAML files, querying, and searching.
+ */
+export class HelpServiceController {
+    db = null;
+    initPromise = null;
+    /**
+     * The current version of the help data.
+     * Used to determine if an update is needed.
+     */
+    currentVersion;
+    /**
+     * The available help categories and their corresponding files.
+     */
+    categories;
+    static DB_NAME = 'help-service';
+    static DB_VERSION = 1;
+    _initialized = false;
+    /**
+     * Indicates whether the help service has been initialized.
+     * Initialization includes setting up the IndexedDB and loading help data if necessary.
+     */
+    get initialized() {
+        return this._initialized;
+    }
+    /**
+     * Promise that resolves when the help service is fully initialized.
+     * If the service is already initialized, it resolves immediately.
+     */
+    get untilReady() {
+        return this.initPromise ?? Promise.resolve();
+    }
+    constructor(init) {
+        this.currentVersion = init.version;
+        this.categories = Object.freeze(init.categories);
+        this.initialize();
+    }
+    /**
+     * Initialize the help service
+     */
+    async initialize() {
+        if (this.initPromise) {
+            return this.initPromise;
+        }
+        this.initPromise = this.doInitialize();
+        return this.initPromise;
+    }
+    async doInitialize() {
+        try {
+            // Initialize IndexedDB
+            await this.initDatabase();
+            // Check if we need to update the help data
+            await this.checkAndUpdateHelpData();
+            this._initialized = true;
+        }
+        catch (error) {
+            console.error('Failed to initialize help service:', error);
+            throw error;
+        }
+    }
+    /**
+     * Initialize IndexedDB database
+     */
+    async initDatabase() {
+        this.db = await openDB(HelpServiceController.DB_NAME, HelpServiceController.DB_VERSION, {
+            upgrade(db) {
+                // Create topics store
+                if (!db.objectStoreNames.contains('topics')) {
+                    const topicsStore = db.createObjectStore('topics', { keyPath: 'id' });
+                    // Single field index for category queries
+                    topicsStore.createIndex('category', 'category', { unique: false });
+                    // Composite index for potential future complex queries
+                    topicsStore.createIndex('category_id', ['category', 'id'], { unique: false });
+                }
+                // Create metadata store
+                if (!db.objectStoreNames.contains('metadata')) {
+                    db.createObjectStore('metadata', { keyPath: 'key' });
+                }
+            },
+        });
+    }
+    /**
+     * Check if help data needs to be updated and update if necessary
+     */
+    async checkAndUpdateHelpData() {
+        if (!this.db || !this.currentVersion) {
+            throw new Error('Database or version not initialized');
+        }
+        // Get stored version
+        const storedMetadata = await this.db.get('metadata', 'version');
+        const storedVersion = storedMetadata?.version;
+        // If versions match, no update needed
+        if (storedVersion === this.currentVersion) {
+            return;
+        }
+        // Load and store help data from JSON files
+        await this.loadHelpDataFromFiles();
+        // Update stored version
+        await this.db.put('metadata', {
+            key: 'version',
+            version: this.currentVersion,
+            lastUpdated: Date.now(),
+        });
+    }
+    /**
+     * Load help data from JSON files and store in IndexedDB
+     */
+    async loadHelpDataFromFiles() {
+        if (!this.db) {
+            throw new Error('Database not initialized');
+        }
+        // Download all files first
+        const allTopics = [];
+        for (const filePath of Object.values(this.categories)) {
+            const topics = await this.loadTopicsFromFile(filePath);
+            // Prepare topics for insertion
+            for (const topic of topics) {
+                const topicKey = this.getTopicKey(topic.category, topic.id);
+                allTopics.push({
+                    ...topic,
+                    id: topicKey,
+                });
+            }
+        }
+        // Insert all topics in a single transaction
+        const topicsStore = this.db.transaction('topics', 'readwrite').objectStore('topics');
+        // Clear existing topics
+        await topicsStore.clear();
+        // Insert all topics
+        for (const topic of allTopics) {
+            await topicsStore.put(topic);
+        }
+    }
+    /**
+     * Load topics from a JSON or YAML file
+     */
+    async loadTopicsFromFile(filePath) {
+        const response = await fetch(filePath);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch ${filePath}: ${response.status}`);
+        }
+        const text = await response.text();
+        // Determine file type and parse accordingly
+        if (filePath.endsWith('.yaml') || filePath.endsWith('.yml')) {
+            return parseYaml(text);
+        }
+        else {
+            return JSON.parse(text);
+        }
+    }
+    /**
+     * Generate a unique key for a topic
+     */
+    getTopicKey(category, id) {
+        return `${category}::${id}`;
+    }
+    /**
+     * Get a specific help topic
+     */
+    async getTopic(category, id) {
+        await this.initialize();
+        if (!this.db) {
+            throw new Error('Database not initialized');
+        }
+        const topicKey = this.getTopicKey(category, id);
+        const topic = await this.db.get('topics', topicKey);
+        return topic || undefined;
+    }
+    /**
+     * Get all topics for a specific category
+     */
+    async getTopicsByCategory(category) {
+        await this.initialize();
+        if (!this.db) {
+            throw new Error('Database not initialized');
+        }
+        const topics = await this.db.getAllFromIndex('topics', 'category', category);
+        return topics;
+    }
+    /**
+     * Search topics by title or content
+     */
+    async searchTopics(query) {
+        await this.initialize();
+        if (!this.db) {
+            throw new Error('Database not initialized');
+        }
+        const allTopics = await this.db.getAll('topics');
+        const searchTerm = query.toLowerCase();
+        return allTopics.filter((topic) => {
+            const titleMatch = topic.title.toLowerCase().includes(searchTerm);
+            const bodyMatch = topic.body.toLowerCase().includes(searchTerm);
+            // Handle examples search for both string and array formats
+            let examplesMatch = false;
+            if (topic.examples) {
+                if (typeof topic.examples === 'string') {
+                    examplesMatch = topic.examples.toLowerCase().includes(searchTerm);
+                }
+                else if (Array.isArray(topic.examples)) {
+                    examplesMatch = topic.examples.some((example) => example.value.toLowerCase().includes(searchTerm) ||
+                        (example.title && example.title.toLowerCase().includes(searchTerm)));
+                }
+            }
+            return titleMatch || bodyMatch || examplesMatch;
+        });
+    }
+    /**
+     * Get all available topics
+     */
+    async getAllTopics() {
+        await this.initialize();
+        if (!this.db) {
+            throw new Error('Database not initialized');
+        }
+        return await this.db.getAll('topics');
+    }
+    /**
+     * Get current version
+     */
+    getVersion() {
+        return this.currentVersion;
+    }
+    /**
+     * Force refresh of help data (useful for development)
+     */
+    async forceRefresh() {
+        if (!this.db) {
+            throw new Error('Database not initialized');
+        }
+        // Clear stored version to force update
+        await this.db.delete('metadata', 'version');
+        // Re-initialize
+        this.initPromise = null;
+        await this.initialize();
+    }
+    /**
+     * Clear all help data from IndexedDB
+     */
+    async clearAllData() {
+        if (!this.db) {
+            throw new Error('Database not initialized');
+        }
+        const topicsStore = this.db.transaction('topics', 'readwrite').objectStore('topics');
+        const metadataStore = this.db.transaction('metadata', 'readwrite').objectStore('metadata');
+        await topicsStore.clear();
+        await metadataStore.clear();
+    }
+}
+//# sourceMappingURL=help_service_controller.js.map

package/build/src/help/help_service_controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"help_service_controller.js","sourceRoot":"","sources":["../../../src/help/help_service_controller.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAqB,MAAM,KAAK,CAAA;AAC/C,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,MAAM,CAAA;AAqCzC;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IACxB,EAAE,GAAgC,IAAI,CAAA;IACtC,WAAW,GAAyB,IAAI,CAAA;IAChD;;;OAGG;IACK,cAAc,CAAQ;IAE9B;;OAEG;IACK,UAAU,CAAwB;IAElC,MAAM,CAAU,OAAO,GAAG,cAAc,CAAA;IACxC,MAAM,CAAU,UAAU,GAAG,CAAC,CAAA;IAE9B,YAAY,GAAG,KAAK,CAAA;IAE5B;;;OAGG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAA;IAC1B,CAAC;IAED;;;OAGG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;IAC9C,CAAC;IAED,YAAY,IAAqB;QAC/B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAA;QAClC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAChD,IAAI,CAAC,UAAU,EAAE,CAAA;IACnB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,UAAU;QACtB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC,WAAW,CAAA;QACzB,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,EAAE,CAAA;QACtC,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAEO,KAAK,CAAC,YAAY;QACxB,IAAI,CAAC;YACH,uBAAuB;YACvB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAA;YACzB,2CAA2C;YAC3C,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAA;YACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAA;YAC1D,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,YAAY;QACxB,IAAI,CAAC,EAAE,GAAG,MAAM,MAAM,CAAS,qBAAqB,CAAC,OAAO,EAAE,qBAAqB,CAAC,UAAU,EAAE;YAC9F,OAAO,CAAC,EAAE;gBACR,sBAAsB;gBACtB,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC5C,MAAM,WAAW,GAAG,EAAE,CAAC,iBAAiB,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;oBACrE,0CAA0C;oBAC1C,WAAW,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAA;oBAClE,uDAAuD;oBACvD,WAAW,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAA;gBAC/E,CAAC;gBAED,wBAAwB;gBACxB,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC9C,EAAE,CAAC,iBAAiB,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAA;gBACtD,CAAC;YACH,CAAC;SACF,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,sBAAsB;QAClC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACxD,CAAC;QAED,qBAAqB;QACrB,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;QAC/D,MAAM,aAAa,GAAG,cAAc,EAAE,OAAO,CAAA;QAE7C,sCAAsC;QACtC,IAAI,aAAa,KAAK,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1C,OAAM;QACR,CAAC;QAED,2CAA2C;QAC3C,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAA;QAElC,wBAAwB;QACxB,MAAM,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,EAAE;YAC5B,GAAG,EAAE,SAAS;YACd,OAAO,EAAE,IAAI,CAAC,cAAc;YAC5B,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE;SACxB,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,qBAAqB;QACjC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QAED,2BAA2B;QAC3B,MAAM,SAAS,GAAmC,EAAE,CAAA;QAEpD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACtD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAA;YAEtD,+BAA+B;YAC/B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC,CAAA;gBAC3D,SAAS,CAAC,IAAI,CAAC;oBACb,GAAG,KAAK;oBACR,EAAE,EAAE,QAAQ;iBACb,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,4CAA4C;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;QAEpF,wBAAwB;QACxB,MAAM,WAAW,CAAC,KAAK,EAAE,CAAA;QAEzB,oBAAoB;QACpB,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;YAC9B,MAAM,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAC9B,CAAC;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,kBAAkB,CAAC,QAAgB;QAC/C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAA;QACtC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,mBAAmB,QAAQ,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;QACpE,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QAElC,4CAA4C;QAC5C,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5D,OAAO,SAAS,CAAC,IAAI,CAAC,CAAA;QACxB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACzB,CAAC;IACH,CAAC;IAED;;OAEG;IACK,WAAW,CAAC,QAAgB,EAAE,EAAU;QAC9C,OAAO,GAAG,QAAQ,KAAK,EAAE,EAAE,CAAA;IAC7B,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ,CAAC,QAAgB,EAAE,EAAU;QAChD,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QAEvB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;QAC/C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;QAEnD,OAAO,KAAK,IAAI,SAAS,CAAA;IAC3B,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,mBAAmB,CAAC,QAAgB;QAC/C,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QAEvB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,QAAQ,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAA;QAC5E,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,KAAa;QACrC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QAEvB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAChD,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAA;QAEtC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YAChC,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YACjE,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YAE/D,2DAA2D;YAC3D,IAAI,aAAa,GAAG,KAAK,CAAA;YACzB,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACnB,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;oBACvC,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;gBACnE,CAAC;qBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACzC,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CACjC,CAAC,OAAoB,EAAE,EAAE,CACvB,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC;wBAChD,CAAC,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CACtE,CAAA;gBACH,CAAC;YACH,CAAC;YAED,OAAO,UAAU,IAAI,SAAS,IAAI,aAAa,CAAA;QACjD,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY;QACvB,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QAEvB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACvC,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC,cAAc,CAAA;IAC5B,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY;QACvB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QAED,uCAAuC;QACvC,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;QAE3C,gBAAgB;QAChB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;QACvB,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;IACzB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY;QACvB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;QACpF,MAAM,aAAa,GAAG,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,CAAA;QAE1F,MAAM,WAAW,CAAC,KAAK,EAAE,CAAA;QACzB,MAAM,aAAa,CAAC,KAAK,EAAE,CAAA;IAC7B,CAAC","sourcesContent":["/* eslint-disable no-console */\nimport type { HelpTopic, HelpExample } from './help_topic.js'\nimport { openDB, type IDBPDatabase } from 'idb'\nimport { parse as parseYaml } from 'yaml'\n\n// Database schema for IndexedDB\ninterface HelpDB extends IDBPDatabase {\n  topics: {\n    key: string\n    value: HelpTopic\n  }\n  metadata: {\n    key: string\n    value: { version: string; lastUpdated: number }\n  }\n}\n\nexport interface HelpServiceInit {\n  /**\n   * Mapping of help categories to their respective JSON or YAML file URLs.\n   *\n   * Example:\n   * ```typescript\n   * {\n   *   property: '/help/property.yaml',\n   *   entity: '/help/entity.yaml',\n   *   // ...\n   * }\n   * ```\n   */\n  categories: Record<string, string>\n  /**\n   * Current version of the help data.\n   * Used to determine if an update is needed.\n   * Should follow semantic versioning (e.g., \"1.0.0\").\n   * By convention it should be the version of the app.\n   */\n  version: string\n}\n\n/**\n * HelpServiceController manages help topics stored in IndexedDB.\n * It supports loading topics from JSON or YAML files, querying, and searching.\n */\nexport class HelpServiceController {\n  private db: IDBPDatabase<HelpDB> | null = null\n  private initPromise: Promise<void> | null = null\n  /**\n   * The current version of the help data.\n   * Used to determine if an update is needed.\n   */\n  private currentVersion: string\n\n  /**\n   * The available help categories and their corresponding files.\n   */\n  private categories: Record<string, string>\n\n  private static readonly DB_NAME = 'help-service'\n  private static readonly DB_VERSION = 1\n\n  private _initialized = false\n\n  /**\n   * Indicates whether the help service has been initialized.\n   * Initialization includes setting up the IndexedDB and loading help data if necessary.\n   */\n  get initialized(): boolean {\n    return this._initialized\n  }\n\n  /**\n   * Promise that resolves when the help service is fully initialized.\n   * If the service is already initialized, it resolves immediately.\n   */\n  get untilReady(): Promise<void> {\n    return this.initPromise ?? Promise.resolve()\n  }\n\n  constructor(init: HelpServiceInit) {\n    this.currentVersion = init.version\n    this.categories = Object.freeze(init.categories)\n    this.initialize()\n  }\n\n  /**\n   * Initialize the help service\n   */\n  private async initialize(): Promise<void> {\n    if (this.initPromise) {\n      return this.initPromise\n    }\n    this.initPromise = this.doInitialize()\n    return this.initPromise\n  }\n\n  private async doInitialize(): Promise<void> {\n    try {\n      // Initialize IndexedDB\n      await this.initDatabase()\n      // Check if we need to update the help data\n      await this.checkAndUpdateHelpData()\n      this._initialized = true\n    } catch (error) {\n      console.error('Failed to initialize help service:', error)\n      throw error\n    }\n  }\n\n  /**\n   * Initialize IndexedDB database\n   */\n  private async initDatabase(): Promise<void> {\n    this.db = await openDB<HelpDB>(HelpServiceController.DB_NAME, HelpServiceController.DB_VERSION, {\n      upgrade(db) {\n        // Create topics store\n        if (!db.objectStoreNames.contains('topics')) {\n          const topicsStore = db.createObjectStore('topics', { keyPath: 'id' })\n          // Single field index for category queries\n          topicsStore.createIndex('category', 'category', { unique: false })\n          // Composite index for potential future complex queries\n          topicsStore.createIndex('category_id', ['category', 'id'], { unique: false })\n        }\n\n        // Create metadata store\n        if (!db.objectStoreNames.contains('metadata')) {\n          db.createObjectStore('metadata', { keyPath: 'key' })\n        }\n      },\n    })\n  }\n\n  /**\n   * Check if help data needs to be updated and update if necessary\n   */\n  private async checkAndUpdateHelpData(): Promise<void> {\n    if (!this.db || !this.currentVersion) {\n      throw new Error('Database or version not initialized')\n    }\n\n    // Get stored version\n    const storedMetadata = await this.db.get('metadata', 'version')\n    const storedVersion = storedMetadata?.version\n\n    // If versions match, no update needed\n    if (storedVersion === this.currentVersion) {\n      return\n    }\n\n    // Load and store help data from JSON files\n    await this.loadHelpDataFromFiles()\n\n    // Update stored version\n    await this.db.put('metadata', {\n      key: 'version',\n      version: this.currentVersion,\n      lastUpdated: Date.now(),\n    })\n  }\n\n  /**\n   * Load help data from JSON files and store in IndexedDB\n   */\n  private async loadHelpDataFromFiles(): Promise<void> {\n    if (!this.db) {\n      throw new Error('Database not initialized')\n    }\n\n    // Download all files first\n    const allTopics: (HelpTopic & { id: string })[] = []\n\n    for (const filePath of Object.values(this.categories)) {\n      const topics = await this.loadTopicsFromFile(filePath)\n\n      // Prepare topics for insertion\n      for (const topic of topics) {\n        const topicKey = this.getTopicKey(topic.category, topic.id)\n        allTopics.push({\n          ...topic,\n          id: topicKey,\n        })\n      }\n    }\n\n    // Insert all topics in a single transaction\n    const topicsStore = this.db.transaction('topics', 'readwrite').objectStore('topics')\n\n    // Clear existing topics\n    await topicsStore.clear()\n\n    // Insert all topics\n    for (const topic of allTopics) {\n      await topicsStore.put(topic)\n    }\n  }\n\n  /**\n   * Load topics from a JSON or YAML file\n   */\n  private async loadTopicsFromFile(filePath: string): Promise<HelpTopic[]> {\n    const response = await fetch(filePath)\n    if (!response.ok) {\n      throw new Error(`Failed to fetch ${filePath}: ${response.status}`)\n    }\n\n    const text = await response.text()\n\n    // Determine file type and parse accordingly\n    if (filePath.endsWith('.yaml') || filePath.endsWith('.yml')) {\n      return parseYaml(text)\n    } else {\n      return JSON.parse(text)\n    }\n  }\n\n  /**\n   * Generate a unique key for a topic\n   */\n  private getTopicKey(category: string, id: string): string {\n    return `${category}::${id}`\n  }\n\n  /**\n   * Get a specific help topic\n   */\n  public async getTopic(category: string, id: string): Promise<HelpTopic | undefined> {\n    await this.initialize()\n\n    if (!this.db) {\n      throw new Error('Database not initialized')\n    }\n\n    const topicKey = this.getTopicKey(category, id)\n    const topic = await this.db.get('topics', topicKey)\n\n    return topic || undefined\n  }\n\n  /**\n   * Get all topics for a specific category\n   */\n  public async getTopicsByCategory(category: string): Promise<HelpTopic[]> {\n    await this.initialize()\n\n    if (!this.db) {\n      throw new Error('Database not initialized')\n    }\n\n    const topics = await this.db.getAllFromIndex('topics', 'category', category)\n    return topics\n  }\n\n  /**\n   * Search topics by title or content\n   */\n  public async searchTopics(query: string): Promise<HelpTopic[]> {\n    await this.initialize()\n\n    if (!this.db) {\n      throw new Error('Database not initialized')\n    }\n\n    const allTopics = await this.db.getAll('topics')\n    const searchTerm = query.toLowerCase()\n\n    return allTopics.filter((topic) => {\n      const titleMatch = topic.title.toLowerCase().includes(searchTerm)\n      const bodyMatch = topic.body.toLowerCase().includes(searchTerm)\n\n      // Handle examples search for both string and array formats\n      let examplesMatch = false\n      if (topic.examples) {\n        if (typeof topic.examples === 'string') {\n          examplesMatch = topic.examples.toLowerCase().includes(searchTerm)\n        } else if (Array.isArray(topic.examples)) {\n          examplesMatch = topic.examples.some(\n            (example: HelpExample) =>\n              example.value.toLowerCase().includes(searchTerm) ||\n              (example.title && example.title.toLowerCase().includes(searchTerm))\n          )\n        }\n      }\n\n      return titleMatch || bodyMatch || examplesMatch\n    })\n  }\n\n  /**\n   * Get all available topics\n   */\n  public async getAllTopics(): Promise<HelpTopic[]> {\n    await this.initialize()\n\n    if (!this.db) {\n      throw new Error('Database not initialized')\n    }\n\n    return await this.db.getAll('topics')\n  }\n\n  /**\n   * Get current version\n   */\n  public getVersion(): string | null {\n    return this.currentVersion\n  }\n\n  /**\n   * Force refresh of help data (useful for development)\n   */\n  public async forceRefresh(): Promise<void> {\n    if (!this.db) {\n      throw new Error('Database not initialized')\n    }\n\n    // Clear stored version to force update\n    await this.db.delete('metadata', 'version')\n\n    // Re-initialize\n    this.initPromise = null\n    await this.initialize()\n  }\n\n  /**\n   * Clear all help data from IndexedDB\n   */\n  public async clearAllData(): Promise<void> {\n    if (!this.db) {\n      throw new Error('Database not initialized')\n    }\n\n    const topicsStore = this.db.transaction('topics', 'readwrite').objectStore('topics')\n    const metadataStore = this.db.transaction('metadata', 'readwrite').objectStore('metadata')\n\n    await topicsStore.clear()\n    await metadataStore.clear()\n  }\n}\n"]}

package/build/src/help/help_topic.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Represents a link in the help topic, typically used for additional resources or documentation.
+ * Each link has a text label and a URL.
+ */
+export interface HelpLink {
+    /**
+     * Text to display for the link
+     */
+    text: string;
+    /**
+     * URL to navigate to when the link is clicked
+     */
+    url: string;
+}
+/**
+ * Represents an example in a help topic with optional title and content.
+ */
+export interface HelpExample {
+    /**
+     * Optional title for the example
+     */
+    title?: string;
+    /**
+     * The example content, typically in Markdown format
+     */
+    value: string;
+}
+/**
+ * Represents a help topic with structured content for user assistance.
+ * Each topic is categorized and can include examples and related links.
+ */
+export interface HelpTopic {
+    /**
+     * Identifier within the category, e.g., "name-input"
+     */
+    id: string;
+    /**
+     * Category of the help topic, used for grouping and filtering
+     */
+    category: string;
+    /**
+     * Title for the help panel header
+     */
+    title: string;
+    /**
+     * Body content for the help topic, typically in Markdown format.
+     */
+    body: string;
+    /**
+     * Optional examples content. Can be either:
+     * - A single string (legacy format for backward compatibility)
+     * - An array of objects with optional title and value properties
+     */
+    examples?: string | HelpExample[];
+    /**
+     * Optional array of related links, each with text and URL
+     */
+    links?: HelpLink[];
+}
+//# sourceMappingURL=help_topic.d.ts.map

package/build/src/help/help_topic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"help_topic.d.ts","sourceRoot":"","sources":["../../../src/help/help_topic.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,EAAE,CAAA;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAA;CACnB"}

package/build/src/help/help_topic.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=help_topic.js.map

package/build/src/help/help_topic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"help_topic.js","sourceRoot":"","sources":["../../../src/help/help_topic.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Represents a link in the help topic, typically used for additional resources or documentation.\n * Each link has a text label and a URL.\n */\nexport interface HelpLink {\n  /**\n   * Text to display for the link\n   */\n  text: string\n  /**\n   * URL to navigate to when the link is clicked\n   */\n  url: string\n}\n\n/**\n * Represents an example in a help topic with optional title and content.\n */\nexport interface HelpExample {\n  /**\n   * Optional title for the example\n   */\n  title?: string\n  /**\n   * The example content, typically in Markdown format\n   */\n  value: string\n}\n\n/**\n * Represents a help topic with structured content for user assistance.\n * Each topic is categorized and can include examples and related links.\n */\nexport interface HelpTopic {\n  /**\n   * Identifier within the category, e.g., \"name-input\"\n   */\n  id: string\n  /**\n   * Category of the help topic, used for grouping and filtering\n   */\n  category: string\n  /**\n   * Title for the help panel header\n   */\n  title: string\n  /**\n   * Body content for the help topic, typically in Markdown format.\n   */\n  body: string\n  /**\n   * Optional examples content. Can be either:\n   * - A single string (legacy format for backward compatibility)\n   * - An array of objects with optional title and value properties\n   */\n  examples?: string | HelpExample[]\n  /**\n   * Optional array of related links, each with text and URL\n   */\n  links?: HelpLink[]\n}\n"]}

package/build/src/help/index.d.ts

@@ -0,0 +1,6 @@
+export { renderHelp } from './render.js';
+export { HelpServiceController } from './help_service_controller.js';
+export { HelpCoordinator } from './help_coordinator.js';
+export { HelpPanel } from './help_panel.js';
+export type { HelpTopic, HelpLink } from './help_topic.js';
+//# sourceMappingURL=index.d.ts.map

package/build/src/help/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/help/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAG3C,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA"}

package/build/src/help/index.js

@@ -0,0 +1,6 @@
+// Main help system exports
+export { renderHelp } from './render.js';
+export { HelpServiceController } from './help_service_controller.js';
+export { HelpCoordinator } from './help_coordinator.js';
+export { HelpPanel } from './help_panel.js';
+//# sourceMappingURL=index.js.map

package/build/src/help/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/help/index.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA","sourcesContent":["// Main help system exports\nexport { renderHelp } from './render.js'\nexport { HelpServiceController } from './help_service_controller.js'\nexport { HelpCoordinator } from './help_coordinator.js'\nexport { HelpPanel } from './help_panel.js'\n\n// Type exports\nexport type { HelpTopic, HelpLink } from './help_topic.js'\n"]}

package/build/src/help/render.d.ts

@@ -0,0 +1,14 @@
+import { type TemplateResult } from 'lit';
+import '../md/icons/ui-icon.js';
+import '../md/icon-button/ui-icon-button.js';
+/**
+ * Renders a help icon with a button that can be used to trigger help functionality.
+ * The help system lives outside the application and renders the help content in a node controlled
+ * by the help system.
+ *
+ * @param category The category of the help content, which determines where to look for the help content.
+ * @param id The identifier for the specific help content within the category.
+ * @returns The template result containing the help icon button.
+ */
+export declare function renderHelp(category: string, id: string): TemplateResult;
+//# sourceMappingURL=render.d.ts.map

package/build/src/help/render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../../src/help/render.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAQ,MAAM,KAAK,CAAA;AAG/C,OAAO,wBAAwB,CAAA;AAC/B,OAAO,qCAAqC,CAAA;AAE5C;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,cAAc,CAyBvE"}

package/build/src/help/render.js

@@ -0,0 +1,37 @@
+import { html } from 'lit';
+import '../md/icons/ui-icon.js';
+import '../md/icon-button/ui-icon-button.js';
+/**
+ * Renders a help icon with a button that can be used to trigger help functionality.
+ * The help system lives outside the application and renders the help content in a node controlled
+ * by the help system.
+ *
+ * @param category The category of the help content, which determines where to look for the help content.
+ * @param id The identifier for the specific help content within the category.
+ * @returns The template result containing the help icon button.
+ */
+export function renderHelp(category, id) {
+    const handleClick = (event) => {
+        const button = event.currentTarget;
+        const { category, id } = button.dataset;
+        if (!category || !id) {
+            return;
+        }
+        const detail = {
+            category,
+            id,
+            target: button,
+        };
+        button.dispatchEvent(new CustomEvent('request-help', {
+            bubbles: true,
+            composed: true,
+            detail,
+        }));
+    };
+    return html `<span class="help"
+    ><ui-icon-button type="button" data-category="${category}" data-id="${id}" @click="${handleClick}"
+      ><ui-icon>help</ui-icon></ui-icon-button
+    ></span
+  >`;
+}
+//# sourceMappingURL=render.js.map

package/build/src/help/render.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.js","sourceRoot":"","sources":["../../../src/help/render.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,IAAI,EAAE,MAAM,KAAK,CAAA;AAG/C,OAAO,wBAAwB,CAAA;AAC/B,OAAO,qCAAqC,CAAA;AAE5C;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CAAC,QAAgB,EAAE,EAAU;IACrD,MAAM,WAAW,GAAG,CAAC,KAAY,EAAE,EAAE;QACnC,MAAM,MAAM,GAAG,KAAK,CAAC,aAA4B,CAAA;QACjD,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC,OAAO,CAAA;QACvC,IAAI,CAAC,QAAQ,IAAI,CAAC,EAAE,EAAE,CAAC;YACrB,OAAM;QACR,CAAC;QACD,MAAM,MAAM,GAAsB;YAChC,QAAQ;YACR,EAAE;YACF,MAAM,EAAE,MAAM;SACf,CAAA;QACD,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAAC,cAAc,EAAE;YAC9B,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;YACd,MAAM;SACP,CAAC,CACH,CAAA;IACH,CAAC,CAAA;IACD,OAAO,IAAI,CAAA;oDACuC,QAAQ,cAAc,EAAE,aAAa,WAAW;;;IAGhG,CAAA;AACJ,CAAC","sourcesContent":["import { type TemplateResult, html } from 'lit'\nimport type { HelpRequestDetail } from './help_coordinator.js'\n\nimport '../md/icons/ui-icon.js'\nimport '../md/icon-button/ui-icon-button.js'\n\n/**\n * Renders a help icon with a button that can be used to trigger help functionality.\n * The help system lives outside the application and renders the help content in a node controlled\n * by the help system.\n *\n * @param category The category of the help content, which determines where to look for the help content.\n * @param id The identifier for the specific help content within the category.\n * @returns The template result containing the help icon button.\n */\nexport function renderHelp(category: string, id: string): TemplateResult {\n  const handleClick = (event: Event) => {\n    const button = event.currentTarget as HTMLElement\n    const { category, id } = button.dataset\n    if (!category || !id) {\n      return\n    }\n    const detail: HelpRequestDetail = {\n      category,\n      id,\n      target: button,\n    }\n    button.dispatchEvent(\n      new CustomEvent('request-help', {\n        bubbles: true,\n        composed: true,\n        detail,\n      })\n    )\n  }\n  return html`<span class=\"help\"\n    ><ui-icon-button type=\"button\" data-category=\"${category}\" data-id=\"${id}\" @click=\"${handleClick}\"\n      ><ui-icon>help</ui-icon></ui-icon-button\n    ></span\n  >`\n}\n"]}

package/build/src/lib/Dom.d.ts

@@ -1,5 +1,12 @@
+import { CSSResultOrNative } from 'lit';
 /**
  * Searches for an element with the given ID in parent shadow roots
  */
 export declare function findElementInShadowRoots(id: string, from: HTMLElement): HTMLElement | null;
+/**
+ * Adopts the provided styles into the document.
+ *
+ * @param styles - The styles to adopt.
+ */
+export declare function adoptStyles(...styles: CSSResultOrNative[]): void;
 //# sourceMappingURL=Dom.d.ts.map

package/build/src/lib/Dom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Dom.d.ts","sourceRoot":"","sources":["../../../src/lib/Dom.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,WAAW,GAAG,IAAI,CAqC1F"}
+{"version":3,"file":"Dom.d.ts","sourceRoot":"","sources":["../../../src/lib/Dom.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,KAAK,CAAA;AAEvC;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,WAAW,GAAG,IAAI,CAqC1F;AAID;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAyBhE"}

package/build/src/lib/Dom.js

@@ -37,4 +37,37 @@ export function findElementInShadowRoots(id, from) {
     }
     return null;
 }
+const adoptedStyles = new WeakSet();
+/**
+ * Adopts the provided styles into the document.
+ *
+ * @param styles - The styles to adopt.
+ */
+export function adoptStyles(...styles) {
+    if (typeof document === 'undefined' || !('adoptedStyleSheets' in document)) {
+        // Constructable stylesheets are not supported in this environment.
+        return;
+    }
+    const sheets = [];
+    for (const style of styles) {
+        if (adoptedStyles.has(style)) {
+            continue;
+        }
+        if (style instanceof CSSStyleSheet) {
+            adoptedStyles.add(style);
+            sheets.push(style);
+        }
+        else if (style && typeof style === 'object' && 'styleSheet' in style) {
+            const styleSheet = style.styleSheet;
+            if (styleSheet instanceof CSSStyleSheet) {
+                adoptedStyles.add(style);
+                sheets.push(styleSheet);
+            }
+        }
+    }
+    if (sheets.length === 0) {
+        return;
+    }
+    document.adoptedStyleSheets = [...document.adoptedStyleSheets, ...sheets];
+}
 //# sourceMappingURL=Dom.js.map

package/build/src/lib/Dom.js.map

@@ -1 +1 @@
-{"version":3,"file":"Dom.js","sourceRoot":"","sources":["../../../src/lib/Dom.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,EAAU,EAAE,IAAiB;IACpE,gCAAgC;IAChC,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,CAAA;IAC3C,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,0DAA0D;IAC1D,IAAI,OAAO,GAAuB,IAAI,CAAA;IACtC,MAAM,OAAO,GAAG,IAAI,EAAE,EAAE,CAAA;IAExB,OAAO,OAAO,EAAE,CAAC;QACf,kEAAkE;QAClE,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;YACzD,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,OAAsB,CAAA;YAC/B,CAAC;QACH,CAAC;QAED,uBAAuB;QACvB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,IAAI,OAAO,CAAC,UAAU,CAAC,QAAQ,KAAK,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBAChE,sDAAsD;gBACtD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAwB,CAAA;gBACnD,OAAO,GAAG,UAAU,CAAC,IAAmB,CAAA;YAC1C,CAAC;iBAAM,CAAC;gBACN,wBAAwB;gBACxB,OAAO,GAAG,OAAO,CAAC,aAAa,CAAA;YACjC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,kBAAkB;YAClB,OAAO,GAAG,IAAI,CAAA;QAChB,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC","sourcesContent":["/**\n * Searches for an element with the given ID in parent shadow roots\n */\nexport function findElementInShadowRoots(id: string, from: HTMLElement): HTMLElement | null {\n  // First try to find in document\n  const rootElm = document.getElementById(id)\n  if (rootElm) {\n    return rootElm\n  }\n\n  // If not found in document, search in parent shadow roots\n  let current: HTMLElement | null = from\n  const queryId = `#${id}`\n\n  while (current) {\n    // Check if current element has a shadow root and search within it\n    if (current.shadowRoot) {\n      const element = current.shadowRoot.querySelector(queryId)\n      if (element) {\n        return element as HTMLElement\n      }\n    }\n\n    // Move up the DOM tree\n    if (current.parentNode) {\n      if (current.parentNode.nodeType === Node.DOCUMENT_FRAGMENT_NODE) {\n        // We're inside a shadow root, move to the shadow host\n        const shadowRoot = current.parentNode as ShadowRoot\n        current = shadowRoot.host as HTMLElement\n      } else {\n        // Regular DOM traversal\n        current = current.parentElement\n      }\n    } else {\n      // No more parents\n      current = null\n    }\n  }\n\n  return null\n}\n"]}
+{"version":3,"file":"Dom.js","sourceRoot":"","sources":["../../../src/lib/Dom.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,EAAU,EAAE,IAAiB;IACpE,gCAAgC;IAChC,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,CAAA;IAC3C,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,0DAA0D;IAC1D,IAAI,OAAO,GAAuB,IAAI,CAAA;IACtC,MAAM,OAAO,GAAG,IAAI,EAAE,EAAE,CAAA;IAExB,OAAO,OAAO,EAAE,CAAC;QACf,kEAAkE;QAClE,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;YACzD,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,OAAsB,CAAA;YAC/B,CAAC;QACH,CAAC;QAED,uBAAuB;QACvB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,IAAI,OAAO,CAAC,UAAU,CAAC,QAAQ,KAAK,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBAChE,sDAAsD;gBACtD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAwB,CAAA;gBACnD,OAAO,GAAG,UAAU,CAAC,IAAmB,CAAA;YAC1C,CAAC;iBAAM,CAAC;gBACN,wBAAwB;gBACxB,OAAO,GAAG,OAAO,CAAC,aAAa,CAAA;YACjC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,kBAAkB;YAClB,OAAO,GAAG,IAAI,CAAA;QAChB,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED,MAAM,aAAa,GAAG,IAAI,OAAO,EAAqB,CAAA;AAEtD;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,GAAG,MAA2B;IACxD,IAAI,OAAO,QAAQ,KAAK,WAAW,IAAI,CAAC,CAAC,oBAAoB,IAAI,QAAQ,CAAC,EAAE,CAAC;QAC3E,mEAAmE;QACnE,OAAM;IACR,CAAC;IACD,MAAM,MAAM,GAAoB,EAAE,CAAA;IAClC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,SAAQ;QACV,CAAC;QACD,IAAI,KAAK,YAAY,aAAa,EAAE,CAAC;YACnC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YACxB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACpB,CAAC;aAAM,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,YAAY,IAAI,KAAK,EAAE,CAAC;YACvE,MAAM,UAAU,GAAI,KAAwC,CAAC,UAAU,CAAA;YACvE,IAAI,UAAU,YAAY,aAAa,EAAE,CAAC;gBACxC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;gBACxB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACzB,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAM;IACR,CAAC;IACD,QAAQ,CAAC,kBAAkB,GAAG,CAAC,GAAG,QAAQ,CAAC,kBAAkB,EAAE,GAAG,MAAM,CAAC,CAAA;AAC3E,CAAC","sourcesContent":["import { CSSResultOrNative } from 'lit'\n\n/**\n * Searches for an element with the given ID in parent shadow roots\n */\nexport function findElementInShadowRoots(id: string, from: HTMLElement): HTMLElement | null {\n  // First try to find in document\n  const rootElm = document.getElementById(id)\n  if (rootElm) {\n    return rootElm\n  }\n\n  // If not found in document, search in parent shadow roots\n  let current: HTMLElement | null = from\n  const queryId = `#${id}`\n\n  while (current) {\n    // Check if current element has a shadow root and search within it\n    if (current.shadowRoot) {\n      const element = current.shadowRoot.querySelector(queryId)\n      if (element) {\n        return element as HTMLElement\n      }\n    }\n\n    // Move up the DOM tree\n    if (current.parentNode) {\n      if (current.parentNode.nodeType === Node.DOCUMENT_FRAGMENT_NODE) {\n        // We're inside a shadow root, move to the shadow host\n        const shadowRoot = current.parentNode as ShadowRoot\n        current = shadowRoot.host as HTMLElement\n      } else {\n        // Regular DOM traversal\n        current = current.parentElement\n      }\n    } else {\n      // No more parents\n      current = null\n    }\n  }\n\n  return null\n}\n\nconst adoptedStyles = new WeakSet<CSSResultOrNative>()\n\n/**\n * Adopts the provided styles into the document.\n *\n * @param styles - The styles to adopt.\n */\nexport function adoptStyles(...styles: CSSResultOrNative[]): void {\n  if (typeof document === 'undefined' || !('adoptedStyleSheets' in document)) {\n    // Constructable stylesheets are not supported in this environment.\n    return\n  }\n  const sheets: CSSStyleSheet[] = []\n  for (const style of styles) {\n    if (adoptedStyles.has(style)) {\n      continue\n    }\n    if (style instanceof CSSStyleSheet) {\n      adoptedStyles.add(style)\n      sheets.push(style)\n    } else if (style && typeof style === 'object' && 'styleSheet' in style) {\n      const styleSheet = (style as { styleSheet?: CSSStyleSheet }).styleSheet\n      if (styleSheet instanceof CSSStyleSheet) {\n        adoptedStyles.add(style)\n        sheets.push(styleSheet)\n      }\n    }\n  }\n  if (sheets.length === 0) {\n    return\n  }\n  document.adoptedStyleSheets = [...document.adoptedStyleSheets, ...sheets]\n}\n"]}

package/build/src/lib/files/Utils.d.ts

@@ -1,7 +1,17 @@
+import { SVGTemplateResult } from 'lit';
+import type { IFile } from '@api-client/core/models/store/File.js';
+import type { TrashEntry } from '@api-client/core/models/TrashEntry.js';
 /**
  * Reads the last segment of the file path and returns it as a file name.
  *
  * @param path THe file path.
  */
 export declare function getFileName(path: string): string;
+/**
+ * Sorts files on the list.
+ *
+ * Folders are always on top.
+ */
+export declare function filesSortFunction(a: IFile, b: IFile): number;
+export declare function fileIcon(item: IFile | TrashEntry): SVGTemplateResult | undefined;
 //# sourceMappingURL=Utils.d.ts.map