@api-client/ui 0.5.58 → 0.6.1

package/build/src/events/Events.d.ts

@@ -11,10 +11,10 @@ export declare const Events: Readonly<{
             delete: (key: string, target?: EventTarget) => Promise<void>;
         }>;
         Telemetry: Readonly<{
-            set: (config: import("@api-client/core/browser.js").TelemetryConfig, target?: EventTarget) => Promise<void>;
-            read: (target?: EventTarget) => Promise<import("@api-client/core/browser.js").TelemetryConfig>;
+            set: (config: import("@api-client/core").TelemetryConfig, target?: EventTarget) => Promise<void>;
+            read: (target?: EventTarget) => Promise<import("@api-client/core").TelemetryConfig>;
             State: Readonly<{
-                set: (config: import("@api-client/core/browser.js").TelemetryConfig, target?: EventTarget) => void;
+                set: (config: import("@api-client/core").TelemetryConfig, target?: EventTarget) => void;
             }>;
         }>;
     }>;
@@ -31,27 +31,27 @@ export declare const Events: Readonly<{
     }>;
     Store: Readonly<{
         File: Readonly<{
-            list: (kinds?: import("@api-client/core/browser.js").ListFileKind[], options?: import("@api-client/core/browser.js").ContextListOptions, target?: EventTarget) => Promise<import("@api-client/core/browser.js").ContextListResult<import("@api-client/core/browser.js").IFile>>;
-            listShared: (kinds?: import("@api-client/core/browser.js").ListFileKind[], options?: import("@api-client/core/browser.js").ContextListOptions, target?: EventTarget) => Promise<import("@api-client/core/browser.js").ContextListResult<import("@api-client/core/browser.js").IFile>>;
-            create: (meta: import("@api-client/core/browser.js").IFile, media?: unknown, opts?: import("@api-client/core/browser.js").IFileCreateOptions, target?: EventTarget) => Promise<string>;
-            createDefault: (name: string, kind: string, opts?: import("@api-client/core/browser.js").IFileCreateOptions, target?: EventTarget) => Promise<string>;
+            list: (kinds?: import("@api-client/core").ListFileKind[], options?: import("@api-client/core").ContextListOptions, target?: EventTarget) => Promise<import("@api-client/core").ContextListResult<import("@api-client/core").IFile>>;
+            listShared: (kinds?: import("@api-client/core").ListFileKind[], options?: import("@api-client/core").ContextListOptions, target?: EventTarget) => Promise<import("@api-client/core").ContextListResult<import("@api-client/core").IFile>>;
+            create: (meta: import("@api-client/core").IFile, media?: unknown, opts?: import("@api-client/core").IFileCreateOptions, target?: EventTarget) => Promise<string>;
+            createDefault: (name: string, kind: string, opts?: import("@api-client/core").IFileCreateOptions, target?: EventTarget) => Promise<string>;
             read: {
-                (key: string, media: false, target?: EventTarget): Promise<import("@api-client/core/browser.js").IFile>;
+                (key: string, media: false, target?: EventTarget): Promise<import("@api-client/core").IFile>;
                 (key: string, media: true, target?: EventTarget): Promise<unknown>;
             };
             patch: {
-                (key: string, id: string, value: import("@api-client/json/types.js").Operation[], app: import("@api-client/core/browser.js").IApplication, media: false, target?: EventTarget): Promise<import("@api-client/core/browser.js").IPatchRevision>;
-                (key: string, id: string, value: import("@api-client/json/types.js").Operation[], app: import("@api-client/core/browser.js").IApplication, media: true, target?: EventTarget): Promise<import("@api-client/core/browser.js").IPatchRevision>;
+                (key: string, id: string, value: import("@api-client/json/types.js").Operation[], app: import("@api-client/core").IApplication, media: false, target?: EventTarget): Promise<import("@api-client/core").IPatchRevision>;
+                (key: string, id: string, value: import("@api-client/json/types.js").Operation[], app: import("@api-client/core").IApplication, media: true, target?: EventTarget): Promise<import("@api-client/core").IPatchRevision>;
             };
             delete: (key: string, target?: EventTarget) => Promise<string>;
-            patchUsers: (key: string, id: string, value: import("@api-client/core/browser.js").AccessOperation[], app: import("@api-client/core/browser.js").IApplication, target?: EventTarget) => Promise<void>;
-            listUsers: (key: string, target?: EventTarget) => Promise<import("@api-client/core/browser.js").ContextListResult<import("@api-client/core/browser.js").IUser>>;
-            breadcrumbs: (fileOrFolder: string, target?: EventTarget) => Promise<import("@api-client/core/browser.js").ContextListResult<import("@api-client/core/browser.js").FileBreadcrumb>>;
+            patchUsers: (key: string, id: string, value: import("@api-client/core").AccessOperation[], app: import("@api-client/core").IApplication, target?: EventTarget) => Promise<void>;
+            listUsers: (key: string, target?: EventTarget) => Promise<import("@api-client/core").ContextListResult<import("@api-client/core").IUser>>;
+            breadcrumbs: (fileOrFolder: string, target?: EventTarget) => Promise<import("@api-client/core").ContextListResult<import("@api-client/core").FileBreadcrumb>>;
         }>;
         User: Readonly<{
-            me: (target?: EventTarget) => Promise<import("@api-client/core/browser.js").IUser>;
-            read: (organizationId: string, key: string, target?: EventTarget) => Promise<import("@api-client/core/browser.js").IUser | undefined>;
-            list: (organizationId: string, options?: import("@api-client/core/browser.js").ContextListOptions, target?: EventTarget) => Promise<import("@api-client/core/browser.js").ContextListResult<import("@api-client/core/browser.js").IUser>>;
+            me: (target?: EventTarget) => Promise<import("@api-client/core").IUser>;
+            read: (organizationId: string, key: string, target?: EventTarget) => Promise<import("@api-client/core").IUser | undefined>;
+            list: (organizationId: string, options?: import("@api-client/core").ContextListOptions, target?: EventTarget) => Promise<import("@api-client/core").ContextListResult<import("@api-client/core").IUser>>;
         }>;
     }>;
     HttpProject: {
@@ -60,12 +60,12 @@ export declare const Events: Readonly<{
             nameChanged: (key: string, kind: string, target?: HTMLElement) => void;
         }>;
         Ui: Readonly<{
-            delete: (id: string, target?: EventTarget) => Promise<import("@api-client/core/browser.js").ContextDeleteRecord | undefined>;
+            delete: (id: string, target?: EventTarget) => Promise<import("@api-client/core").ContextDeleteRecord | undefined>;
             HttpRequest: Readonly<{
-                set: (pid: string, id: string, meta: import("@api-client/core/browser.js").IRequestUiMeta, target?: EventTarget) => Promise<import("@api-client/core/browser.js").ContextChangeRecord<import("@api-client/core/browser.js").IRequestUiMeta> | undefined>;
-                get: (pid: string, id: string, target?: EventTarget) => Promise<import("@api-client/core/browser.js").IRequestUiMeta | null | undefined>;
-                getBulk: (pid: string, ids: string[], target?: EventTarget) => Promise<import("@api-client/core/browser.js").IBulkOperationResult<import("@api-client/core/browser.js").IRequestUiMeta> | undefined>;
-                delete: (pid: string, id: string, target?: EventTarget) => Promise<import("@api-client/core/browser.js").ContextDeleteRecord | undefined>;
+                set: (pid: string, id: string, meta: import("@api-client/core").IRequestUiMeta, target?: EventTarget) => Promise<import("@api-client/core").ContextChangeRecord<import("@api-client/core").IRequestUiMeta> | undefined>;
+                get: (pid: string, id: string, target?: EventTarget) => Promise<import("@api-client/core").IRequestUiMeta | null | undefined>;
+                getBulk: (pid: string, ids: string[], target?: EventTarget) => Promise<import("@api-client/core").IBulkOperationResult<import("@api-client/core").IRequestUiMeta> | undefined>;
+                delete: (pid: string, id: string, target?: EventTarget) => Promise<import("@api-client/core").ContextDeleteRecord | undefined>;
             }>;
         }>;
     };
@@ -73,22 +73,22 @@ export declare const Events: Readonly<{
         Model: Readonly<{
             UrlHistory: Readonly<{
                 add: (url: string, target?: EventTarget) => Promise<void>;
-                query: (q: string, target?: EventTarget) => Promise<import("@api-client/core/browser.js").IQueryResponse<import("@api-client/core/browser.js").IUrl> | undefined>;
+                query: (q: string, target?: EventTarget) => Promise<import("@api-client/core").IQueryResponse<import("@api-client/core").IUrl> | undefined>;
                 delete: (url: string, target?: EventTarget) => Promise<void>;
                 clear: (target?: EventTarget) => Promise<void>;
                 State: Readonly<{
-                    add: (entity: import("@api-client/core/browser.js").IUrl, target?: EventTarget) => void;
+                    add: (entity: import("@api-client/core").IUrl, target?: EventTarget) => void;
                     clear: (target?: EventTarget) => void;
                     delete: (url: string, target?: EventTarget) => void;
                 }>;
             }>;
             WsHistory: Readonly<{
                 add: (url: string, target?: EventTarget) => Promise<void>;
-                query: (q: string, target?: EventTarget) => Promise<import("@api-client/core/browser.js").IQueryResponse<import("@api-client/core/browser.js").IUrl> | undefined>;
+                query: (q: string, target?: EventTarget) => Promise<import("@api-client/core").IQueryResponse<import("@api-client/core").IUrl> | undefined>;
                 delete: (url: string, target?: EventTarget) => Promise<void>;
                 clear: (target?: EventTarget) => Promise<void>;
                 State: Readonly<{
-                    add: (entity: import("@api-client/core/browser.js").IUrl, target?: EventTarget) => void;
+                    add: (entity: import("@api-client/core").IUrl, target?: EventTarget) => void;
                     clear: (target?: EventTarget) => void;
                     delete: (url: string, target?: EventTarget) => void;
                 }>;
@@ -115,5 +115,12 @@ export declare const Events: Readonly<{
         startActivity: (intent: import("../core/ActivityManager.js").Intent, target?: EventTarget) => void;
         startActivityForResult: (intent: import("../core/ActivityManager.js").Intent, onResult: (result: import("../core/ActivityManager.js").IntentResult, intent: import("../core/ActivityManager.js").Intent) => void, target?: EventTarget) => void;
     };
+    Domain: {
+        rename: (key: string, namespace: string, kind: string, name: string, target?: HTMLElement) => void;
+        Browse: {
+            recent: (domain: string, allowed: import("../modeling/types.js").DomainBrowserPickItem[] | undefined, target?: HTMLElement) => Promise<import("../modeling/types.js").DomainBrowseRecentItem[] | undefined>;
+            browse: (init: import("../modeling/types.js").DomainBrowseInit, target?: HTMLElement) => Promise<import("../modeling/types.js").DomainBrowseResult | undefined>;
+        };
+    };
 }>;
 //# sourceMappingURL=Events.d.ts.map

package/build/src/events/Events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Events.d.ts","sourceRoot":"","sources":["../../../src/events/Events.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASjB,CAAA"}
+{"version":3,"file":"Events.d.ts","sourceRoot":"","sources":["../../../src/events/Events.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUjB,CAAA"}

package/build/src/events/Events.js

@@ -6,6 +6,7 @@ import SchemaDesignEvents from './SchemaDesignEvents.js';
 import HttpClientEvents from './HttpClientEvents.js';
 import HttpEvents from './HttpEvents.js';
 import IntentEvents from './IntentEvents.js';
+import DomainEvents from './DomainEvents.js';
 export const Events = Object.freeze({
     Config: ConfigEvents,
     Navigation: NavigationEvents,
@@ -15,5 +16,6 @@ export const Events = Object.freeze({
     SchemaDesign: SchemaDesignEvents,
     Http: HttpEvents,
     Intent: IntentEvents,
+    Domain: DomainEvents,
 });
 //# sourceMappingURL=Events.js.map

package/build/src/events/Events.js.map

@@ -1 +1 @@
-{"version":3,"file":"Events.js","sourceRoot":"","sources":["../../../src/events/Events.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,mBAAmB,CAAA;AAC5C,OAAO,gBAAgB,MAAM,uBAAuB,CAAA;AACpD,OAAO,WAAW,MAAM,kBAAkB,CAAA;AAC1C,OAAO,iBAAiB,MAAM,wBAAwB,CAAA;AACtD,OAAO,kBAAkB,MAAM,yBAAyB,CAAA;AACxD,OAAO,gBAAgB,MAAM,uBAAuB,CAAA;AACpD,OAAO,UAAU,MAAM,iBAAiB,CAAA;AACxC,OAAO,YAAY,MAAM,mBAAmB,CAAA;AAE5C,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAClC,MAAM,EAAE,YAAY;IACpB,UAAU,EAAE,gBAAgB;IAC5B,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,iBAAiB;IAC9B,UAAU,EAAE,gBAAgB;IAC5B,YAAY,EAAE,kBAAkB;IAChC,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,YAAY;CACrB,CAAC,CAAA","sourcesContent":["import ConfigEvents from './ConfigEvents.js'\nimport NavigationEvents from './NavigationEvents.js'\nimport StoreEvents from './StoreEvents.js'\nimport HttpProjectEvents from './HttpProjectEvents.js'\nimport SchemaDesignEvents from './SchemaDesignEvents.js'\nimport HttpClientEvents from './HttpClientEvents.js'\nimport HttpEvents from './HttpEvents.js'\nimport IntentEvents from './IntentEvents.js'\n\nexport const Events = Object.freeze({\n  Config: ConfigEvents,\n  Navigation: NavigationEvents,\n  Store: StoreEvents,\n  HttpProject: HttpProjectEvents,\n  HttpClient: HttpClientEvents,\n  SchemaDesign: SchemaDesignEvents,\n  Http: HttpEvents,\n  Intent: IntentEvents,\n})\n"]}
+{"version":3,"file":"Events.js","sourceRoot":"","sources":["../../../src/events/Events.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,mBAAmB,CAAA;AAC5C,OAAO,gBAAgB,MAAM,uBAAuB,CAAA;AACpD,OAAO,WAAW,MAAM,kBAAkB,CAAA;AAC1C,OAAO,iBAAiB,MAAM,wBAAwB,CAAA;AACtD,OAAO,kBAAkB,MAAM,yBAAyB,CAAA;AACxD,OAAO,gBAAgB,MAAM,uBAAuB,CAAA;AACpD,OAAO,UAAU,MAAM,iBAAiB,CAAA;AACxC,OAAO,YAAY,MAAM,mBAAmB,CAAA;AAC5C,OAAO,YAAY,MAAM,mBAAmB,CAAA;AAE5C,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAClC,MAAM,EAAE,YAAY;IACpB,UAAU,EAAE,gBAAgB;IAC5B,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,iBAAiB;IAC9B,UAAU,EAAE,gBAAgB;IAC5B,YAAY,EAAE,kBAAkB;IAChC,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,YAAY;IACpB,MAAM,EAAE,YAAY;CACrB,CAAC,CAAA","sourcesContent":["import ConfigEvents from './ConfigEvents.js'\nimport NavigationEvents from './NavigationEvents.js'\nimport StoreEvents from './StoreEvents.js'\nimport HttpProjectEvents from './HttpProjectEvents.js'\nimport SchemaDesignEvents from './SchemaDesignEvents.js'\nimport HttpClientEvents from './HttpClientEvents.js'\nimport HttpEvents from './HttpEvents.js'\nimport IntentEvents from './IntentEvents.js'\nimport DomainEvents from './DomainEvents.js'\n\nexport const Events = Object.freeze({\n  Config: ConfigEvents,\n  Navigation: NavigationEvents,\n  Store: StoreEvents,\n  HttpProject: HttpProjectEvents,\n  HttpClient: HttpClientEvents,\n  SchemaDesign: SchemaDesignEvents,\n  Http: HttpEvents,\n  Intent: IntentEvents,\n  Domain: DomainEvents,\n})\n"]}

package/build/src/exceptions/builder.d.ts

@@ -0,0 +1,11 @@
+import { Exception } from '@api-client/core/exceptions/exception.js';
+/**
+ * Converts a standard Error object into an Exception instance.
+ * This function extracts relevant properties from the Error object
+ * and sets them on the Exception instance, allowing for a more
+ * consistent error handling experience across the application.
+ * @param error The Error object to convert.
+ * @returns An Exception instance with properties set from the Error object.
+ */
+export declare function fromError(error: Error): Exception;
+//# sourceMappingURL=builder.d.ts.map

package/build/src/exceptions/builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../../../src/exceptions/builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAA;AACpE;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,CAkBjD"}

package/build/src/exceptions/builder.js

@@ -0,0 +1,29 @@
+import { Exception } from '@api-client/core/exceptions/exception.js';
+/**
+ * Converts a standard Error object into an Exception instance.
+ * This function extracts relevant properties from the Error object
+ * and sets them on the Exception instance, allowing for a more
+ * consistent error handling experience across the application.
+ * @param error The Error object to convert.
+ * @returns An Exception instance with properties set from the Error object.
+ */
+export function fromError(error) {
+    // The SDK error most likely is an instance of an Exception, so we can process it as one.
+    // If not (some other error), we create a new Exception instance.
+    const e = new Exception(error.message || 'An error occurred');
+    const typed = error;
+    if (typed.code) {
+        e.code = typed.code;
+    }
+    if (typed.status) {
+        e.status = Number(typed.status);
+    }
+    if (typed.help) {
+        e.setHelp(typed.help);
+    }
+    if (typed.name) {
+        e.name = typed.name;
+    }
+    return e;
+}
+//# sourceMappingURL=builder.js.map

package/build/src/exceptions/builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.js","sourceRoot":"","sources":["../../../src/exceptions/builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAA;AACpE;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CAAC,KAAY;IACpC,yFAAyF;IACzF,iEAAiE;IACjE,MAAM,CAAC,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,OAAO,IAAI,mBAAmB,CAAC,CAAA;IAC7D,MAAM,KAAK,GAAG,KAAmD,CAAA;IACjE,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACf,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,IAAc,CAAA;IAC/B,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IACjC,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACf,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAc,CAAC,CAAA;IACjC,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACf,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,IAAc,CAAA;IAC/B,CAAC;IACD,OAAO,CAAC,CAAA;AACV,CAAC","sourcesContent":["import { Exception } from '@api-client/core/exceptions/exception.js'\n/**\n * Converts a standard Error object into an Exception instance.\n * This function extracts relevant properties from the Error object\n * and sets them on the Exception instance, allowing for a more\n * consistent error handling experience across the application.\n * @param error The Error object to convert.\n * @returns An Exception instance with properties set from the Error object.\n */\nexport function fromError(error: Error): Exception {\n  // The SDK error most likely is an instance of an Exception, so we can process it as one.\n  // If not (some other error), we create a new Exception instance.\n  const e = new Exception(error.message || 'An error occurred')\n  const typed = error as unknown as Record<string, string | number>\n  if (typed.code) {\n    e.code = typed.code as string\n  }\n  if (typed.status) {\n    e.status = Number(typed.status)\n  }\n  if (typed.help) {\n    e.setHelp(typed.help as string)\n  }\n  if (typed.name) {\n    e.name = typed.name as string\n  }\n  return e\n}\n"]}

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

@@ -0,0 +1,82 @@
+import { LitElement, type TemplateResult } from 'lit';
+import type { HelpServiceController } from './help_service_controller.js';
+import type { HelpTopic } from './help_topic.js';
+import './help_panel.js';
+export interface HelpRequestDetail {
+    /**
+     * The category of the help request, which determines where to look for help content.
+     */
+    category: string;
+    /**
+     * The ID of the help request, which identifies the specific help topic.
+     */
+    id: string;
+    /**
+     * The target element that triggered the help request.
+     * This can be used to position the help panel relative to the element.
+     */
+    target: HTMLElement;
+}
+/**
+ * The main coordinator for the help system.
+ * This element should be placed once in your application root and will:
+ * - Listen for help requests from anywhere in the DOM
+ * - Show/hide the help panel
+ * - Coordinate between the help service and UI components
+ *
+ * It relies on the `HelpServiceController` to fetch and manage help topics.
+ * Make sure to configure the `helpService` property with an instance of `HelpServiceController`.
+ *
+ * Usage:
+ * ```ts
+ * const helpServiceInstance = new HelpServiceController({
+ *   categories: {
+ *     property: '/help/property.yaml',
+ *     entity: '/help/entity.yaml',
+ *   },
+ *   version: '1.0.0',
+ * })
+ * ```
+ * ```html
+ * <help-coordinator .helpService="${helpServiceInstance}"></help-coordinator>
+ * ```
+ */
+export declare class HelpCoordinator extends LitElement {
+    /**
+     * The help category of the current help request.
+     * @attribute
+     */
+    accessor category: string | undefined;
+    /**
+     * The help ID of the current help request.
+     * @attribute
+     */
+    accessor helpId: string | undefined;
+    accessor topic: HelpTopic | undefined;
+    private accessor opened;
+    /**
+     * The element that triggered the help request.
+     * This is used to position the help panel relative to the triggering element.
+     * Might not always be set, depending on how the help request is triggered.
+     */
+    private accessor trigger;
+    /**
+     * The help service controller instance.
+     * This should be configured with the appropriate categories and version.
+     */
+    accessor helpService: HelpServiceController | undefined;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private handleHelpRequest;
+    requestTopic(category: string, id: string, trigger: HTMLElement): Promise<void>;
+    private trackHelpUsage;
+    private showHelpNotAvailable;
+    protected handleClose(): void;
+    render(): TemplateResult;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'help-coordinator': HelpCoordinator;
+    }
+}
+//# sourceMappingURL=help_coordinator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"help_coordinator.d.ts","sourceRoot":"","sources":["../../../src/help/help_coordinator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAQ,KAAK,cAAc,EAAE,MAAM,KAAK,CAAA;AAG3D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAA;AACzE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,iBAAiB,CAAA;AAExB,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;OAGG;IACH,MAAM,EAAE,WAAW,CAAA;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBACa,eAAgB,SAAQ,UAAU;IAC7C;;;OAGG;IACyB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IACjE;;;OAGG;IACyB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAEnC,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,CAAA;IAExD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IACxC;;;;OAIG;IACM,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IAE1D;;;OAGG;IACyB,QAAQ,CAAC,WAAW,EAAE,qBAAqB,GAAG,SAAS,CAAA;IAE1E,iBAAiB,IAAI,IAAI;IAOzB,oBAAoB,IAAI,IAAI;YAMvB,iBAAiB;IAiBzB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBrF,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,oBAAoB;IAgB5B,SAAS,CAAC,WAAW,IAAI,IAAI;IAIpB,MAAM,IAAI,cAAc;CASlC;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,kBAAkB,EAAE,eAAe,CAAA;KACpC;CACF"}

package/build/src/help/help_coordinator.js

@@ -0,0 +1,206 @@
+import { __esDecorate, __runInitializers } from "tslib";
+import { LitElement, html } from 'lit';
+import { customElement, property, state } from 'lit/decorators.js';
+import { bound } from '../decorators/bound.js';
+import './help_panel.js';
+/**
+ * The main coordinator for the help system.
+ * This element should be placed once in your application root and will:
+ * - Listen for help requests from anywhere in the DOM
+ * - Show/hide the help panel
+ * - Coordinate between the help service and UI components
+ *
+ * It relies on the `HelpServiceController` to fetch and manage help topics.
+ * Make sure to configure the `helpService` property with an instance of `HelpServiceController`.
+ *
+ * Usage:
+ * ```ts
+ * const helpServiceInstance = new HelpServiceController({
+ *   categories: {
+ *     property: '/help/property.yaml',
+ *     entity: '/help/entity.yaml',
+ *   },
+ *   version: '1.0.0',
+ * })
+ * ```
+ * ```html
+ * <help-coordinator .helpService="${helpServiceInstance}"></help-coordinator>
+ * ```
+ */
+let HelpCoordinator = (() => {
+    let _classDecorators = [customElement('help-coordinator')];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    let _classSuper = LitElement;
+    let _instanceExtraInitializers = [];
+    let _category_decorators;
+    let _category_initializers = [];
+    let _category_extraInitializers = [];
+    let _helpId_decorators;
+    let _helpId_initializers = [];
+    let _helpId_extraInitializers = [];
+    let _topic_decorators;
+    let _topic_initializers = [];
+    let _topic_extraInitializers = [];
+    let _opened_decorators;
+    let _opened_initializers = [];
+    let _opened_extraInitializers = [];
+    let _trigger_decorators;
+    let _trigger_initializers = [];
+    let _trigger_extraInitializers = [];
+    let _helpService_decorators;
+    let _helpService_initializers = [];
+    let _helpService_extraInitializers = [];
+    let _handleHelpRequest_decorators;
+    var HelpCoordinator = class extends _classSuper {
+        static { _classThis = this; }
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _category_decorators = [property({ type: String })];
+            _helpId_decorators = [property({ type: String })];
+            _topic_decorators = [property({ type: Object })];
+            _opened_decorators = [state()];
+            _trigger_decorators = [state()];
+            _helpService_decorators = [property({ type: Object })];
+            _handleHelpRequest_decorators = [bound];
+            __esDecorate(this, null, _category_decorators, { kind: "accessor", name: "category", static: false, private: false, access: { has: obj => "category" in obj, get: obj => obj.category, set: (obj, value) => { obj.category = value; } }, metadata: _metadata }, _category_initializers, _category_extraInitializers);
+            __esDecorate(this, null, _helpId_decorators, { kind: "accessor", name: "helpId", static: false, private: false, access: { has: obj => "helpId" in obj, get: obj => obj.helpId, set: (obj, value) => { obj.helpId = value; } }, metadata: _metadata }, _helpId_initializers, _helpId_extraInitializers);
+            __esDecorate(this, null, _topic_decorators, { kind: "accessor", name: "topic", static: false, private: false, access: { has: obj => "topic" in obj, get: obj => obj.topic, set: (obj, value) => { obj.topic = value; } }, metadata: _metadata }, _topic_initializers, _topic_extraInitializers);
+            __esDecorate(this, null, _opened_decorators, { kind: "accessor", name: "opened", static: false, private: false, access: { has: obj => "opened" in obj, get: obj => obj.opened, set: (obj, value) => { obj.opened = value; } }, metadata: _metadata }, _opened_initializers, _opened_extraInitializers);
+            __esDecorate(this, null, _trigger_decorators, { kind: "accessor", name: "trigger", static: false, private: false, access: { has: obj => "trigger" in obj, get: obj => obj.trigger, set: (obj, value) => { obj.trigger = value; } }, metadata: _metadata }, _trigger_initializers, _trigger_extraInitializers);
+            __esDecorate(this, null, _helpService_decorators, { kind: "accessor", name: "helpService", static: false, private: false, access: { has: obj => "helpService" in obj, get: obj => obj.helpService, set: (obj, value) => { obj.helpService = value; } }, metadata: _metadata }, _helpService_initializers, _helpService_extraInitializers);
+            __esDecorate(this, null, _handleHelpRequest_decorators, { kind: "method", name: "handleHelpRequest", static: false, private: false, access: { has: obj => "handleHelpRequest" in obj, get: obj => obj.handleHelpRequest }, metadata: _metadata }, null, _instanceExtraInitializers);
+            __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+            HelpCoordinator = _classThis = _classDescriptor.value;
+            if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+            __runInitializers(_classThis, _classExtraInitializers);
+        }
+        #category_accessor_storage = (__runInitializers(this, _instanceExtraInitializers), __runInitializers(this, _category_initializers, void 0));
+        /**
+         * The help category of the current help request.
+         * @attribute
+         */
+        get category() { return this.#category_accessor_storage; }
+        set category(value) { this.#category_accessor_storage = value; }
+        #helpId_accessor_storage = (__runInitializers(this, _category_extraInitializers), __runInitializers(this, _helpId_initializers, void 0));
+        /**
+         * The help ID of the current help request.
+         * @attribute
+         */
+        get helpId() { return this.#helpId_accessor_storage; }
+        set helpId(value) { this.#helpId_accessor_storage = value; }
+        #topic_accessor_storage = (__runInitializers(this, _helpId_extraInitializers), __runInitializers(this, _topic_initializers, void 0));
+        get topic() { return this.#topic_accessor_storage; }
+        set topic(value) { this.#topic_accessor_storage = value; }
+        #opened_accessor_storage = (__runInitializers(this, _topic_extraInitializers), __runInitializers(this, _opened_initializers, false
+        /**
+         * The element that triggered the help request.
+         * This is used to position the help panel relative to the triggering element.
+         * Might not always be set, depending on how the help request is triggered.
+         */
+        ));
+        get opened() { return this.#opened_accessor_storage; }
+        set opened(value) { this.#opened_accessor_storage = value; }
+        #trigger_accessor_storage = (__runInitializers(this, _opened_extraInitializers), __runInitializers(this, _trigger_initializers, void 0));
+        /**
+         * The element that triggered the help request.
+         * This is used to position the help panel relative to the triggering element.
+         * Might not always be set, depending on how the help request is triggered.
+         */
+        get trigger() { return this.#trigger_accessor_storage; }
+        set trigger(value) { this.#trigger_accessor_storage = value; }
+        #helpService_accessor_storage = (__runInitializers(this, _trigger_extraInitializers), __runInitializers(this, _helpService_initializers, void 0));
+        /**
+         * The help service controller instance.
+         * This should be configured with the appropriate categories and version.
+         */
+        get helpService() { return this.#helpService_accessor_storage; }
+        set helpService(value) { this.#helpService_accessor_storage = value; }
+        connectedCallback() {
+            super.connectedCallback();
+            // Listen for help requests from anywhere in the application
+            document.addEventListener('request-help', this.handleHelpRequest);
+            // Note: Escape key handling is now automatic with popover API
+        }
+        disconnectedCallback() {
+            super.disconnectedCallback();
+            document.removeEventListener('request-help', this.handleHelpRequest);
+        }
+        async handleHelpRequest(event) {
+            if (event.defaultPrevented) {
+                return;
+            }
+            const service = this.helpService;
+            if (!service) {
+                // eslint-disable-next-line no-console
+                console.warn('Help service not configured');
+                return;
+            }
+            const customEvent = event;
+            const { category, id, target } = customEvent.detail;
+            this.requestTopic(category, id, target);
+            // Prevent further propagation to avoid multiple handlers
+            event.stopPropagation();
+        }
+        async requestTopic(category, id, trigger) {
+            const service = this.helpService;
+            if (!service) {
+                // eslint-disable-next-line no-console
+                console.warn('Help service not configured');
+                return;
+            }
+            if (!service.initialized) {
+                await service.untilReady;
+            }
+            const topic = await service.getTopic(category, id);
+            if (topic) {
+                this.topic = topic;
+                this.opened = true;
+                this.trigger = trigger;
+            }
+            else {
+                this.showHelpNotAvailable(category, id);
+            }
+            this.trackHelpUsage(category, id);
+        }
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        trackHelpUsage(category, id) {
+            // TODO: Implement analytics tracking here
+        }
+        showHelpNotAvailable(category, id) {
+            this.topic = {
+                id: 'not-found',
+                category: 'general',
+                title: 'Help Not Available',
+                body: `Sorry, help content for **${category}::${id}** is not available yet.
+
+Please check back later or contact support if you need assistance with this feature.`,
+                links: [
+                    { text: 'Contact Support', url: '/support' },
+                    { text: 'Documentation', url: '/docs' },
+                ],
+            };
+            this.opened = true;
+        }
+        handleClose() {
+            this.opened = false;
+        }
+        render() {
+            return html `<help-panel
+      class="panel"
+      .opened="${this.opened}"
+      .topic="${this.topic}"
+      .trigger="${this.trigger}"
+      @close="${this.handleClose}"
+    ></help-panel>`;
+        }
+        constructor() {
+            super(...arguments);
+            __runInitializers(this, _helpService_extraInitializers);
+        }
+    };
+    return HelpCoordinator = _classThis;
+})();
+export { HelpCoordinator };
+//# sourceMappingURL=help_coordinator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"help_coordinator.js","sourceRoot":"","sources":["../../../src/help/help_coordinator.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAuB,MAAM,KAAK,CAAA;AAC3D,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAClE,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AAG9C,OAAO,iBAAiB,CAAA;AAkBxB;;;;;;;;;;;;;;;;;;;;;;;GAuBG;IAEU,eAAe;4BAD3B,aAAa,CAAC,kBAAkB,CAAC;;;;sBACG,UAAU;;;;;;;;;;;;;;;;;;;;;+BAAlB,SAAQ,WAAU;;;;oCAK5C,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;kCAK1B,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;iCAE1B,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;kCAE1B,KAAK,EAAE;mCAMP,KAAK,EAAE;uCAMP,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;6CAc1B,KAAK;YAnCsB,6KAAS,QAAQ,6BAAR,QAAQ,2FAAoB;YAKrC,uKAAS,MAAM,6BAAN,MAAM,uFAAoB;YAEnC,oKAAS,KAAK,6BAAL,KAAK,qFAAuB;YAExD,uKAAiB,MAAM,6BAAN,MAAM,uFAAQ;YAM/B,0KAAiB,OAAO,6BAAP,OAAO,yFAAyB;YAM9B,sLAAS,WAAW,6BAAX,WAAW,iGAAmC;YAenF,sMAAc,iBAAiB,6DAe9B;YAxDH,6KAiHC;;;YAjHY,uDAAe;;QAKE,8BALjB,mDAAe,2DAKuC;QAJjE;;;WAGG;QACyB,IAAS,QAAQ,8CAAoB;QAArC,IAAS,QAAQ,oDAAoB;QAKrC,yIAAmC;QAJ/D;;;WAGG;QACyB,IAAS,MAAM,4CAAoB;QAAnC,IAAS,MAAM,kDAAoB;QAEnC,qIAAqC;QAArC,IAAS,KAAK,2CAAuB;QAArC,IAAS,KAAK,iDAAuB;QAExD,6HAA0B,KAAK;QACxC;;;;WAIG;WALqC;QAA/B,IAAiB,MAAM,4CAAQ;QAA/B,IAAiB,MAAM,kDAAQ;QAM/B,yIAAiD;QAL1D;;;;WAIG;QACM,IAAiB,OAAO,6CAAyB;QAAjD,IAAiB,OAAO,mDAAyB;QAM9B,kJAAuD;QAJnF;;;WAGG;QACyB,IAAS,WAAW,iDAAmC;QAAvD,IAAS,WAAW,uDAAmC;QAE1E,iBAAiB;YACxB,KAAK,CAAC,iBAAiB,EAAE,CAAA;YACzB,4DAA4D;YAC5D,QAAQ,CAAC,gBAAgB,CAAC,cAAc,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;YACjE,8DAA8D;QAChE,CAAC;QAEQ,oBAAoB;YAC3B,KAAK,CAAC,oBAAoB,EAAE,CAAA;YAC5B,QAAQ,CAAC,mBAAmB,CAAC,cAAc,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;QACtE,CAAC;QAGO,KAAK,CAAC,iBAAiB,CAAC,KAAY;YAC1C,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC;gBAC3B,OAAM;YACR,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAA;YAChC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,sCAAsC;gBACtC,OAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAA;gBAC3C,OAAM;YACR,CAAC;YACD,MAAM,WAAW,GAAG,KAAuC,CAAA;YAC3D,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAA;YACnD,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,CAAC,CAAA;YACvC,yDAAyD;YACzD,KAAK,CAAC,eAAe,EAAE,CAAA;QACzB,CAAC;QAED,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,EAAU,EAAE,OAAoB;YACnE,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAA;YAChC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,sCAAsC;gBACtC,OAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAA;gBAC3C,OAAM;YACR,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;gBACzB,MAAM,OAAO,CAAC,UAAU,CAAA;YAC1B,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;YAClD,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;gBAClB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;gBAClB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;YACxB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;YACzC,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;QACnC,CAAC;QAED,6DAA6D;QACrD,cAAc,CAAC,QAAgB,EAAE,EAAU;YACjD,0CAA0C;QAC5C,CAAC;QAEO,oBAAoB,CAAC,QAAgB,EAAE,EAAU;YACvD,IAAI,CAAC,KAAK,GAAG;gBACX,EAAE,EAAE,WAAW;gBACf,QAAQ,EAAE,SAAS;gBACnB,KAAK,EAAE,oBAAoB;gBAC3B,IAAI,EAAE,6BAA6B,QAAQ,KAAK,EAAE;;qFAE6B;gBAC/E,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,EAAE,UAAU,EAAE;oBAC5C,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,EAAE,OAAO,EAAE;iBACxC;aACF,CAAA;YACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;QACpB,CAAC;QAES,WAAW;YACnB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACrB,CAAC;QAEQ,MAAM;YACb,OAAO,IAAI,CAAA;;iBAEE,IAAI,CAAC,MAAM;gBACZ,IAAI,CAAC,KAAK;kBACR,IAAI,CAAC,OAAO;gBACd,IAAI,CAAC,WAAW;mBACb,CAAA;QACjB,CAAC;;;;;;;;SAhHU,eAAe","sourcesContent":["import { LitElement, html, type TemplateResult } from 'lit'\nimport { customElement, property, state } from 'lit/decorators.js'\nimport { bound } from '../decorators/bound.js'\nimport type { HelpServiceController } from './help_service_controller.js'\nimport type { HelpTopic } from './help_topic.js'\nimport './help_panel.js'\n\nexport interface HelpRequestDetail {\n  /**\n   * The category of the help request, which determines where to look for help content.\n   */\n  category: string\n  /**\n   * The ID of the help request, which identifies the specific help topic.\n   */\n  id: string\n  /**\n   * The target element that triggered the help request.\n   * This can be used to position the help panel relative to the element.\n   */\n  target: HTMLElement\n}\n\n/**\n * The main coordinator for the help system.\n * This element should be placed once in your application root and will:\n * - Listen for help requests from anywhere in the DOM\n * - Show/hide the help panel\n * - Coordinate between the help service and UI components\n *\n * It relies on the `HelpServiceController` to fetch and manage help topics.\n * Make sure to configure the `helpService` property with an instance of `HelpServiceController`.\n *\n * Usage:\n * ```ts\n * const helpServiceInstance = new HelpServiceController({\n *   categories: {\n *     property: '/help/property.yaml',\n *     entity: '/help/entity.yaml',\n *   },\n *   version: '1.0.0',\n * })\n * ```\n * ```html\n * <help-coordinator .helpService=\"${helpServiceInstance}\"></help-coordinator>\n * ```\n */\n@customElement('help-coordinator')\nexport class HelpCoordinator extends LitElement {\n  /**\n   * The help category of the current help request.\n   * @attribute\n   */\n  @property({ type: String }) accessor category: string | undefined\n  /**\n   * The help ID of the current help request.\n   * @attribute\n   */\n  @property({ type: String }) accessor helpId: string | undefined\n\n  @property({ type: Object }) accessor topic: HelpTopic | undefined\n\n  @state() private accessor opened = false\n  /**\n   * The element that triggered the help request.\n   * This is used to position the help panel relative to the triggering element.\n   * Might not always be set, depending on how the help request is triggered.\n   */\n  @state() private accessor trigger: HTMLElement | undefined\n\n  /**\n   * The help service controller instance.\n   * This should be configured with the appropriate categories and version.\n   */\n  @property({ type: Object }) accessor helpService: HelpServiceController | undefined\n\n  override connectedCallback(): void {\n    super.connectedCallback()\n    // Listen for help requests from anywhere in the application\n    document.addEventListener('request-help', this.handleHelpRequest)\n    // Note: Escape key handling is now automatic with popover API\n  }\n\n  override disconnectedCallback(): void {\n    super.disconnectedCallback()\n    document.removeEventListener('request-help', this.handleHelpRequest)\n  }\n\n  @bound\n  private async handleHelpRequest(event: Event): Promise<void> {\n    if (event.defaultPrevented) {\n      return\n    }\n    const service = this.helpService\n    if (!service) {\n      // eslint-disable-next-line no-console\n      console.warn('Help service not configured')\n      return\n    }\n    const customEvent = event as CustomEvent<HelpRequestDetail>\n    const { category, id, target } = customEvent.detail\n    this.requestTopic(category, id, target)\n    // Prevent further propagation to avoid multiple handlers\n    event.stopPropagation()\n  }\n\n  async requestTopic(category: string, id: string, trigger: HTMLElement): Promise<void> {\n    const service = this.helpService\n    if (!service) {\n      // eslint-disable-next-line no-console\n      console.warn('Help service not configured')\n      return\n    }\n    if (!service.initialized) {\n      await service.untilReady\n    }\n    const topic = await service.getTopic(category, id)\n    if (topic) {\n      this.topic = topic\n      this.opened = true\n      this.trigger = trigger\n    } else {\n      this.showHelpNotAvailable(category, id)\n    }\n    this.trackHelpUsage(category, id)\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  private trackHelpUsage(category: string, id: string): void {\n    // TODO: Implement analytics tracking here\n  }\n\n  private showHelpNotAvailable(category: string, id: string): void {\n    this.topic = {\n      id: 'not-found',\n      category: 'general',\n      title: 'Help Not Available',\n      body: `Sorry, help content for **${category}::${id}** is not available yet.\n\nPlease check back later or contact support if you need assistance with this feature.`,\n      links: [\n        { text: 'Contact Support', url: '/support' },\n        { text: 'Documentation', url: '/docs' },\n      ],\n    }\n    this.opened = true\n  }\n\n  protected handleClose(): void {\n    this.opened = false\n  }\n\n  override render(): TemplateResult {\n    return html`<help-panel\n      class=\"panel\"\n      .opened=\"${this.opened}\"\n      .topic=\"${this.topic}\"\n      .trigger=\"${this.trigger}\"\n      @close=\"${this.handleClose}\"\n    ></help-panel>`\n  }\n}\n\ndeclare global {\n  interface HTMLElementTagNameMap {\n    'help-coordinator': HelpCoordinator\n  }\n}\n"]}

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

@@ -0,0 +1,88 @@
+import { LitElement, PropertyValues, nothing, type TemplateResult } from 'lit';
+import type { HelpTopic } from './help_topic.js';
+import '../md/icons/ui-icon.js';
+import '../md/icon-button/ui-icon-button.js';
+import '../elements/highlight/marked-highlight.js';
+/**
+ * A panel that displays help content for a specific topic.
+ * This component is used by the HelpCoordinator to show help information.
+ * Uses the popover API to ensure it appears in the top layer.
+ * @fires close - Dispatched when the panel is closed.
+ */
+export declare class HelpPanel extends LitElement {
+    static styles: import("lit").CSSResult[];
+    /**
+     * The help topic to display in the panel.
+     * This should be set by the HelpCoordinator when a help request is made.
+     */
+    accessor topic: HelpTopic | undefined;
+    /**
+     * The element that triggered the help request.
+     * This is used to position the help panel relative to the triggering element.
+     * Might not always be set, depending on how the help request is triggered.
+     */
+    accessor trigger: HTMLElement | undefined;
+    /**
+     * Whether the panel is currently opened.
+     * This is controlled by the HelpCoordinator and reflects the current state of the panel.
+     */
+    accessor opened: boolean;
+    private accessor isDragging;
+    private accessor position;
+    private dragOffset;
+    /**
+     * Duration of the opening/closing animation in ms.
+     * This is defined in the css file.
+     */
+    protected animationDuration: number;
+    constructor();
+    protected updated(cp: PropertyValues<this>): void;
+    /**
+     * Handles the popover toggle event
+     */
+    private handlePopoverToggle;
+    resetPositionAfterAnimation(): void;
+    private renderMarkdown;
+    /**
+     * Handles the close event for the help panel.
+     * Dispatches a custom 'close' event and sets the opened state to false.
+     * The event informs the help coordinator or any parent component that the panel has been closed.
+     */
+    protected handleClose(): void;
+    /**
+     * Handles the start of a drag operation.
+     * Only initiates drag if not clicking on interactive elements or text content.
+     */
+    protected handleMouseDown(event: MouseEvent): void;
+    /**
+     * Checks if the click is on padding area (not on text content)
+     */
+    private isClickOnPadding;
+    /**
+     * Handles mouse movement during drag operation.
+     */
+    private handleMouseMove;
+    /**
+     * Handles the end of a drag operation.
+     */
+    private handleMouseUp;
+    connectedCallback(): void;
+    firstUpdated(): void;
+    /**
+     * Updates scroll shadow opacity based on scroll position
+     */
+    private handleScroll;
+    private updateScrollShadows;
+    disconnectedCallback(): void;
+    render(): TemplateResult<1> | typeof nothing;
+    /**
+     * Renders examples section, handling both string and array formats
+     */
+    private renderExamples;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'help-panel': HelpPanel;
+    }
+}
+//# sourceMappingURL=help_panel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"help_panel.d.ts","sourceRoot":"","sources":["../../../src/help/help_panel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAQ,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,KAAK,CAAA;AAEpF,OAAO,KAAK,EAAE,SAAS,EAAe,MAAM,iBAAiB,CAAA;AAI7D,OAAO,wBAAwB,CAAA;AAC/B,OAAO,qCAAqC,CAAA;AAC5C,OAAO,2CAA2C,CAAA;AAQlD;;;;;GAKG;AACH,qBACa,SAAU,SAAQ,UAAU;IACvC,OAAgB,MAAM,4BAAqB;IAE3C;;;OAGG;IACyB,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,CAAA;IACjE;;;;OAIG;IACyB,QAAQ,CAAC,OAAO,EAAE,WAAW,GAAG,SAAS,CAAA;IACrE;;;OAGG;IACyC,QAAQ,CAAC,MAAM,UAAQ;IAE1D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAErD,OAAO,CAAC,UAAU,CAAiB;IACnC;;;OAGG;IACH,SAAS,CAAC,iBAAiB,SAAM;;cAOd,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI;IAW1D;;OAEG;IACH,OAAO,CAAC,mBAAmB,CAG1B;IAED,2BAA2B,IAAI,IAAI;IASnC,OAAO,CAAC,cAAc;IAOtB;;;;OAIG;IACH,SAAS,CAAC,WAAW,IAAI,IAAI;IAK7B;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAmClD;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAexB;;OAEG;IACH,OAAO,CAAC,eAAe,CAqBtB;IAED;;OAEG;IACH,OAAO,CAAC,aAAa,CASpB;IAEQ,iBAAiB,IAAI,IAAI;IASzB,YAAY,IAAI,IAAI;IAS7B;;OAEG;IACH,OAAO,CAAC,YAAY,CAGnB;IAED,OAAO,CAAC,mBAAmB;IAuBlB,oBAAoB,IAAI,IAAI;IAQ5B,MAAM;IAqCf;;OAEG;IACH,OAAO,CAAC,cAAc;CAyBvB;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,YAAY,EAAE,SAAS,CAAA;KACxB;CACF"}