@sinequa/atomic-angular 1.17.0 → 2.0.0

package/types/sinequa-atomic-angular-workspace-elements.d.ts

@@ -0,0 +1,49 @@
+import { ApplicationConfig, ApplicationRef, EnvironmentProviders, Injector } from "@angular/core";
+import { AskFollowUp, MentionSelection, Workspace, WorkspaceDocument } from "@sinequa/atomic-angular/document-workspaces";
+/**
+ * The component of an element, for what `@angular/elements` does not expose: its methods.
+ * `NgElement` keeps the component behind its strategy; this is the one place that reaches for it.
+ */
+declare function instanceOf<T>(element: HTMLElement): T;
+/**
+ * Re-dispatches an output of the component under the name the page knows it by — the
+ * events of this package have always been `lexiq-workspaces:…` or plain names — and so
+ * that it crosses a shadow boundary: `@angular/elements` dispatches with neither `bubbles`
+ * nor `composed`.
+ */
+declare function bridgeEvents(element: HTMLElement, events: Record<string, {
+  name: string;
+  detail?: (payload: unknown) => unknown;
+}>): void;
+export declare function defineLexiqWorkspaces(injector: Injector, tagName?: string): void;
+export declare function defineLexiqWorkspacePicker(injector: Injector, tagName?: string): void;
+export declare function defineLexiqWorkspaceMentionList(injector: Injector, tagName?: string): void;
+export declare function registerLexiqWorkspacesElements(injector: Injector): void;
+/**
+ * For a page that is not an Angular application: starts one — zoneless, with the
+ * providers the page gives it (Transloco and the `@sinequa/atomic` configuration are the page's
+ * to provide) — and registers the three elements on it.
+ *
+ * ```ts
+ * await bootstrapLexiqWorkspacesElements({ providers: [provideTransloco({ … })] });
+ * ```
+ */
+export declare function bootstrapLexiqWorkspacesElements(config?: Partial<ApplicationConfig>): Promise<ApplicationRef>;
+/**
+ * Registers the `lexiq-workspaces`, `lexiq-workspace-picker` and
+ * `lexiq-workspace-mention-list` custom elements when the application starts. Add it to
+ * the `providers` of the app (or of a route):
+ *
+ * ```ts
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [provideTransloco({ … }), provideLexiqWorkspacesElements()]
+ * };
+ * ```
+ *
+ * The elements render through this application's injector, so they share its Transloco
+ * configuration, its `@sinequa/atomic` setup and its `WorkspacesStore` with the rest of the app.
+ * A component that uses the tags in a template needs `schemas: [CUSTOM_ELEMENTS_SCHEMA]` — or,
+ * in Angular, the components themselves (`WorkspacesShell`…).
+ */
+export declare function provideLexiqWorkspacesElements(): EnvironmentProviders;
+export type { AskFollowUp, MentionSelection, Workspace, WorkspaceDocument };