@sinequa/atomic-angular 1.10.0 → 1.11.0

package/elements/index.d.ts

@@ -0,0 +1,250 @@
+import { UpdateContainerInput } from '@sinequa/atomic';
+import { EnvironmentProviders } from '@angular/core';
+
+type TooltipPlacement = 'top' | 'right' | 'left' | 'bottom';
+interface TooltipController {
+    attach(el: HTMLElement, text: string, placement?: TooltipPlacement, condition?: () => boolean): void;
+    position(trigger: HTMLElement, placement?: TooltipPlacement): void;
+    el: HTMLSpanElement;
+}
+interface MobileSheetController {
+    open(panelEl: HTMLElement, titleText: string, originEl?: HTMLElement | null): void;
+    close(): void;
+}
+
+type ContainerRole = 'creator' | 'owner' | 'reader';
+interface Collection {
+    id: string;
+    name: string;
+    icon: string;
+    desc: string;
+    tags: string[];
+    docs: number;
+    creatorId: string;
+    ownerIds: string[];
+    readerIds: string[];
+    currentUserRole: ContainerRole;
+    favorited: boolean;
+}
+interface CollectionDocument {
+    _id: string;
+    name: string;
+    containerId?: string;
+    type: string;
+    date: string;
+    size?: string;
+    source?: string;
+    status?: 'uploading' | 'indexing' | 'error' | null;
+    uploadedBy?: string;
+}
+declare class CollectionsStore extends EventTarget {
+    collections: Collection[];
+    documents: Record<string, CollectionDocument[]>;
+    selectedIds: Set<string>;
+    private _loaded;
+    private _loadingPromise;
+    private _page;
+    private _total;
+    private _documentsState;
+    private _emit;
+    getAll(): Collection[];
+    get(id: string): Collection | null;
+    fetchContainer(id: string): Promise<Collection>;
+    get hasMoreCollections(): boolean;
+    ensureLoaded(): Promise<Collection[]>;
+    load(): Promise<Collection[]>;
+    loadMore(): Promise<Collection[]>;
+    create({ name, desc, tags }: {
+        name: string;
+        desc?: string;
+        tags?: string[];
+    }): Promise<Collection>;
+    update(id: string, patch: UpdateContainerInput): Promise<Collection | null>;
+    remove(ids: string[]): Promise<{
+        succeeded: string[];
+        failed: {
+            id: string;
+            error: string;
+        }[];
+    }>;
+    toggleFavorite(id: string): boolean | undefined;
+    getDocuments(collectionId: string): CollectionDocument[];
+    hasMoreDocuments(collectionId: string): boolean;
+    loadDocuments(collectionId: string): Promise<CollectionDocument[]>;
+    loadMoreDocuments(collectionId: string): Promise<CollectionDocument[]>;
+    addDocuments(collectionId: string, docs: CollectionDocument[]): void;
+    saveDocuments(collectionId: string, docs: CollectionDocument[]): Promise<CollectionDocument[]>;
+    removeDocuments(collectionId: string, docIds: string[]): Promise<void>;
+    moveDocuments(fromCollectionId: string, toCollectionId: string, docIds: string[]): Promise<void>;
+    toggleSelected(id: string, checked: boolean): void;
+    get selectedCount(): number;
+}
+declare const store: CollectionsStore;
+
+interface TrackerFileInput {
+    id: string;
+    name: string;
+    type: string;
+}
+interface UploadTrackerController {
+    addFiles(trackerDocs: TrackerFileInput[], colId: string, colName: string): void;
+    onProgress(docId: string, pct: number): void;
+    onIndexing(docId: string): void;
+    onComplete(docId: string): void;
+    onError(docId: string): void;
+}
+
+interface CollectionsHost extends HTMLElement {
+    readonly shadowRoot: ShadowRoot;
+    _pickerContainer: HTMLDivElement;
+    _tooltip: TooltipController;
+    _colCurrentView: 'grid' | 'list';
+    _colGridBuilt: boolean;
+    _colListBuilt: boolean;
+    _showList(): Promise<void>;
+    _hideList(): void;
+    _buildCollectionCard(col: Collection): HTMLElement;
+    _updateColTabCounts(): void;
+    _applyColFilters?(): void;
+    _exitColSelection(): void;
+    _updateColSelCount(): void;
+    _closeColDeleteModal(): void;
+    _currentCol: Collection | null;
+    _currentDocs: CollectionDocument[];
+    _cdvCurrentView: 'grid' | 'list';
+    _cdvListBuilt: boolean;
+    _openColDetail(col: Collection): void;
+    _closeColDetail(): void;
+    _refreshCdvEmpty(): void;
+    _buildDocCard(doc: CollectionDocument): HTMLElement;
+    _buildDocListView(docs: CollectionDocument[]): void;
+    _resetDetailSearch?(): void;
+    _exitDocSelection(): void;
+    openAddCollectionModal?(): void;
+    _openRefDocPreview(docRef: RefDocument): void;
+    _closeColDocPreview(): void;
+    _syncColDocPreviewView(): void;
+    _uploadTracker: UploadTrackerController;
+}
+
+interface Passage {
+    page: number;
+    text: string;
+}
+interface RefDocument {
+    title: string;
+    date: string;
+    path: string;
+    passages?: Passage[];
+}
+
+declare class LexiqCollectionsElement extends HTMLElement implements CollectionsHost {
+    readonly shadowRoot: ShadowRoot;
+    _initialized: boolean;
+    _pickerContainer: HTMLDivElement;
+    _tooltip: TooltipController;
+    _colCurrentView: 'grid' | 'list';
+    _colGridBuilt: boolean;
+    _colListBuilt: boolean;
+    _showList: () => Promise<void>;
+    _hideList: () => void;
+    _buildCollectionCard: (col: Collection) => HTMLElement;
+    _updateColTabCounts: () => void;
+    _exitColSelection: () => void;
+    _updateColSelCount: () => void;
+    _closeColDeleteModal: () => void;
+    _currentCol: Collection | null;
+    _currentDocs: CollectionDocument[];
+    _cdvCurrentView: 'grid' | 'list';
+    _cdvListBuilt: boolean;
+    _openColDetail: (col: Collection) => void;
+    _closeColDetail: () => void;
+    _refreshCdvEmpty: () => void;
+    _buildDocCard: (doc: CollectionDocument) => HTMLElement;
+    _buildDocListView: (docs: CollectionDocument[]) => void;
+    _exitDocSelection: () => void;
+    _openRefDocPreview: (docRef: RefDocument) => void;
+    _closeColDocPreview: () => void;
+    _syncColDocPreviewView: () => void;
+    _uploadTracker: UploadTrackerController;
+    constructor();
+    connectedCallback(): void;
+    showList(): Promise<void>;
+    hideList(): void;
+    showDetail(collectionId: string): Promise<void>;
+    hideDetail(): void;
+    openDocumentPreview(docRef: RefDocument): void;
+    closeDocumentPreview(): void;
+    get collections(): Collection[];
+}
+
+type IncomingDocument = Partial<Pick<CollectionDocument, '_id'>> & Omit<CollectionDocument, '_id'>;
+interface PickerOptions {
+    mobileSheet?: MobileSheetController | null;
+    root?: ShadowRoot | null;
+    container?: HTMLElement | null;
+    documents?: IncomingDocument[];
+    onSave?: ((name: string) => void) | null;
+    onUnsave?: (() => void) | null;
+    scrollContainer?: EventTarget | null;
+    fromCollectionId?: string | null;
+    onMoved?: (() => void) | null;
+}
+
+declare class LexiqCollectionPickerElement extends HTMLElement {
+    private _initialized;
+    private _container;
+    constructor();
+    connectedCallback(): void;
+    private _withEvents;
+    openSaveCard(anchorEl: HTMLElement, opts?: Partial<PickerOptions>): void;
+    closeSaveCard(anchorEl?: HTMLElement | null): void;
+    triggerSaveFeedback(anchorEl: HTMLElement, opts?: Partial<PickerOptions>): void;
+    openMoveMenu(anchorEl: HTMLElement, targetItems: HTMLElement[], opts?: Partial<PickerOptions>): void;
+    closeMoveMenu(): void;
+}
+
+declare class LexiqCollectionMentionListElement extends HTMLElement {
+    private _initialized;
+    private _list;
+    private _onSelectionChanged;
+    private _onCreated;
+    private _onCollectionsLoaded;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private _renderMessage;
+    private _build;
+    private _buildRow;
+    private _syncChecks;
+    private _dispatchSelectionChanged;
+    get items(): {
+        id: string;
+        icon: string;
+        name: string;
+        desc: string;
+    }[];
+    selectById(id: string): void;
+}
+
+declare function defineLexiqCollections(tagName?: string): void;
+declare function defineLexiqCollectionPicker(tagName?: string): void;
+declare function defineLexiqCollectionMentionList(tagName?: string): void;
+declare function registerLexiqCollectionsElements(): void;
+
+/**
+ * Registers the LexiQ Collections native Custom Elements when the Angular
+ * application environment initializes. Add to an app/route `providers` array:
+ *
+ * ```ts
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [provideLexiqCollectionsElements()],
+ * };
+ * ```
+ *
+ * Components using the tags still need `schemas: [CUSTOM_ELEMENTS_SCHEMA]`.
+ */
+declare function provideLexiqCollectionsElements(): EnvironmentProviders;
+
+export { LexiqCollectionMentionListElement, LexiqCollectionPickerElement, LexiqCollectionsElement, store as collectionsStore, defineLexiqCollectionMentionList, defineLexiqCollectionPicker, defineLexiqCollections, provideLexiqCollectionsElements, registerLexiqCollectionsElements };
+export type { Collection, CollectionDocument, ContainerRole, PickerOptions, RefDocument };