@sinequa/atomic-angular 0.0.146 → 0.1.3

package/lib/web-services/preview.service.d.ts

@@ -1,283 +0,0 @@
-import { HttpClient } from "@angular/common/http";
-import { EventEmitter, Injector, OnDestroy } from "@angular/core";
-import { DomSanitizer } from "@angular/platform-browser";
-import { Observable, Subject } from "rxjs";
-import { Article, AuditEvents, CustomHighlights, PreviewData, Query } from "@sinequa/atomic";
-import { SearchService } from "../services/search.service";
-import { Extract } from "../stores";
-import { PreviewHighlight } from "../tokens";
-import { InlineWorker } from "../utils";
-import { AuditService } from "./audit.service";
-import { QueryService } from "./query.service";
-import * as i0 from "@angular/core";
-export type ExtractsEvents = 'fetching' | 'fetched' | 'error';
-export declare class PreviewService implements OnDestroy {
-    highlights: PreviewHighlight[];
-    protected readonly http: HttpClient;
-    protected readonly injector: Injector;
-    protected readonly API_URL: string;
-    protected readonly applicationStore: {
-        assistantReady: import("@angular/core").Signal<boolean>;
-        ready: import("@angular/core").Signal<boolean>;
-        hasLabelsAccess: import("@angular/core").Signal<boolean>;
-        extracts: import("@angular/core").Signal<Map<string, Extract[]>>;
-        extractsCount: import("@angular/core").Signal<number>;
-        updateAssistantReady: () => void;
-        updateReadyState: (value?: boolean) => void;
-        updateHasLabelsAccess: (value?: boolean) => void;
-        updateExtracts: (id: string, extracts: Extract[]) => void;
-        getExtracts: (id: string) => Extract[] | undefined;
-    } & import("@ngrx/signals").WritableStateSource<{
-        assistantReady: boolean;
-        ready: boolean;
-        hasLabelsAccess: boolean;
-        extracts: Map<string, Extract[]>;
-    }>;
-    protected readonly selectionStore: {
-        article: import("@ngrx/signals").DeepSignal<Article>;
-        id: import("@angular/core").Signal<string>;
-        queryText: import("@angular/core").Signal<string>;
-        previewHighlights: import("@ngrx/signals").DeepSignal<import("../stores").PreviewHighlights>;
-        update: (newState: Partial<import("../stores").SelectionState>) => void;
-        clear: () => void;
-    } & import("@ngrx/signals").StateSource<{
-        article: Article;
-        id: string;
-        queryText: string;
-        previewHighlights: import("../stores").PreviewHighlights;
-    }>;
-    protected readonly queryParamsStore: {
-        name?: import("@angular/core").Signal<string | undefined> | undefined;
-        text?: import("@angular/core").Signal<string | undefined> | undefined;
-        aggregations?: import("@angular/core").Signal<string[] | Record<string, import("@sinequa/atomic").AggregationOptions> | undefined> | undefined;
-        sort?: import("@angular/core").Signal<string | undefined> | undefined;
-        action?: import("@angular/core").Signal<"" | "open" | "search" | "aggregate" | undefined> | undefined;
-        select?: import("@angular/core").Signal<import("@sinequa/atomic").Select[] | undefined> | undefined;
-        open?: import("@angular/core").Signal<import("@sinequa/atomic").Open[] | undefined> | undefined;
-        page?: import("@angular/core").Signal<number | undefined> | undefined;
-        pageSize?: import("@angular/core").Signal<number | undefined> | undefined;
-        tab?: import("@angular/core").Signal<string | undefined> | undefined;
-        scope?: import("@angular/core").Signal<string | undefined> | undefined;
-        basket?: import("@angular/core").Signal<string | undefined> | undefined;
-        isFirstPage?: import("@angular/core").Signal<boolean | undefined> | undefined;
-        strictRefine?: import("@angular/core").Signal<boolean | undefined> | undefined;
-        globalRelevance?: import("@angular/core").Signal<number | undefined> | undefined;
-        questionLanguage?: import("@angular/core").Signal<string | undefined> | undefined;
-        questionDefaultLanguage?: import("@angular/core").Signal<string | undefined> | undefined;
-        spellingCorrectionMode?: import("@angular/core").Signal<import("@sinequa/atomic").SpellingCorrectionMode | undefined> | undefined;
-        spellingCorrectionFilter?: import("@angular/core").Signal<string | undefined> | undefined;
-        documentWeight?: import("@angular/core").Signal<string | undefined> | undefined;
-        textPartWeights?: import("@angular/core").Signal<string | undefined> | undefined;
-        relevanceTransforms?: import("@angular/core").Signal<string | undefined> | undefined;
-        removeDuplicates?: import("@angular/core").Signal<boolean | undefined> | undefined;
-        queryId?: import("@angular/core").Signal<string | undefined> | undefined;
-        orderBy?: import("@angular/core").Signal<string | undefined> | undefined;
-        groupBy?: import("@angular/core").Signal<string | undefined> | undefined;
-        neuralSearch?: import("@angular/core").Signal<boolean | undefined> | undefined;
-        path?: import("@angular/core").Signal<string | undefined> | undefined;
-        filters?: import("@angular/core").Signal<import("@sinequa/atomic").LegacyFilter[] | undefined> | undefined;
-        id?: import("@angular/core").Signal<string | undefined> | undefined;
-        setFromUrl: (url: string) => void;
-        addFilter: (filter: import("@sinequa/atomic").LegacyFilter) => void;
-        updateFilter: (filter: import("@sinequa/atomic").LegacyFilter) => void;
-        removeFilter: (field?: string) => void;
-        removeFilterByName: (name?: string) => void;
-        clearFilters: () => void;
-        patch: (params: Partial<import("../stores").QueryParamsState>) => void;
-        getFilter: (fieldOrName?: string) => Partial<import("@sinequa/atomic").LegacyFilter & {
-            count: number;
-        }> | null;
-        getQuery: () => Query;
-    } & import("@ngrx/signals").StateSource<{
-        name?: string | undefined;
-        text?: string | undefined;
-        aggregations?: (Record<string, import("@sinequa/atomic").AggregationOptions> | string[]) | undefined;
-        sort?: string | undefined;
-        action?: ("" | "search" | "open" | "aggregate") | undefined;
-        select?: import("@sinequa/atomic").Select[] | undefined;
-        open?: import("@sinequa/atomic").Open[] | undefined;
-        page?: number | undefined;
-        pageSize?: number | undefined;
-        tab?: string | undefined;
-        scope?: string | undefined;
-        basket?: string | undefined;
-        isFirstPage?: boolean | undefined;
-        strictRefine?: boolean | undefined;
-        globalRelevance?: number | undefined;
-        questionLanguage?: string | undefined;
-        questionDefaultLanguage?: string | undefined;
-        spellingCorrectionMode?: import("@sinequa/atomic").SpellingCorrectionMode | undefined;
-        spellingCorrectionFilter?: string | undefined;
-        documentWeight?: string | undefined;
-        textPartWeights?: string | undefined;
-        relevanceTransforms?: string | undefined;
-        removeDuplicates?: boolean | undefined;
-        queryId?: string | undefined;
-        orderBy?: string | undefined;
-        groupBy?: string | undefined;
-        neuralSearch?: boolean | undefined;
-        path?: string | undefined;
-        filters?: import("@sinequa/atomic").LegacyFilter[] | undefined;
-        id?: string | undefined;
-    }>;
-    protected readonly appStore: {
-        webServices: import("@ngrx/signals").DeepSignal<{}>;
-        queries: import("@ngrx/signals").DeepSignal<{}>;
-        customJSONs: import("@angular/core").Signal<import("@sinequa/atomic-angular").SideCJson[]>;
-        data: import("@ngrx/signals").DeepSignal<{}>;
-        customizationJson: import("@angular/core").Signal<import("@sinequa/atomic-angular").CJsonMint>;
-        sources: import("@angular/core").Signal<any>;
-        filters: import("@angular/core").Signal<any>;
-        initialize: () => Promise<void>;
-        initializeWithAppName: (appName: string) => Promise<void>;
-        update: (app: import("@sinequa/atomic").CCApp) => void;
-        getWebServiceByType: (type: import("@sinequa/atomic").CCWebService["webServiceType"]) => import("@sinequa/atomic").CCWebService | undefined;
-        getLabels: () => {
-            private: string;
-            public: string;
-        };
-        getQueryByName: (name: string) => import("@sinequa/atomic").CCQuery | undefined;
-        getQueryByIndex: (index: number) => import("@sinequa/atomic").CCQuery | undefined;
-        getDefaultQuery: () => import("@sinequa/atomic").CCQuery | undefined;
-        allowEmptySearch: (queryName: string) => boolean;
-        getColumnAlias: (column: string) => string;
-        getAuthorizedFilters: (route: import("@angular/router").ActivatedRoute) => import("@sinequa/atomic").Aggregation[];
-        getNamedCustomizationJson: (name: string) => any | undefined;
-        getAggregationIcon: (column: string) => string | undefined;
-        getAggregationItemsCustomization: (column: string) => import("@sinequa/atomic-angular").CFilterItem[] | undefined;
-        getAggregationCustomization: (column: string) => import("@sinequa/atomic-angular").CFilter | undefined;
-    } & import("@ngrx/signals").StateSource<{
-        webServices: {};
-        queries: {};
-        customJSONs: import("@sinequa/atomic-angular").SideCJson[];
-        data: {};
-    }>;
-    protected readonly sanitizer: DomSanitizer;
-    protected readonly queryService: QueryService;
-    protected readonly searchService: SearchService;
-    protected readonly auditService: AuditService;
-    events: EventEmitter<ExtractsEvents>;
-    onMessage: Subject<unknown>;
-    worker: InlineWorker | undefined;
-    allowWoker: boolean;
-    protected previewData: PreviewData | undefined;
-    protected iframe: Window | null | undefined;
-    protected highlightCategory: string;
-    extracts: string[];
-    entities: string[];
-    constructor(highlights: PreviewHighlight[]);
-    ngOnDestroy(): void;
-    /**
-     * Handles incoming messages from a MessageEvent.
-     *
-     * @param event - The MessageEvent containing the message data.
-     *
-     * The function processes messages of type 'ready' and 'get-html-results'.
-     *
-     * - For 'ready' messages:
-     *   - Initializes the preview iframe with the app name and highlights.
-     *   - If preview data is available, retrieves HTML content based on the current selection.
-     *
-     * - For 'get-html-results' messages:
-     *   - Updates the application store with the extracted HTML results.
-     *   - If no extracts are found, updates the application store with an empty array.
-     */
-    receiveMessage(event: MessageEvent): void;
-    /**
-     * Generates a preview of the document with the given ID, applying the specified query parameters,
-     * custom highlights, and audit events.
-     *
-     * @param id - The unique identifier of the document to preview.
-     * @param q - Partial query parameters to customize the preview request.
-     * @param customHighlights - Optional array of custom highlights to apply to the preview.
-     * @param audit - Optional audit events to merge with the default audit record.
-     * @returns An Observable that emits the preview data.
-     */
-    preview(id: string, q: Partial<Query>, customHighlights?: CustomHighlights[], audit?: AuditEvents): Observable<PreviewData>;
-    /**
-     * Closes the preview with the specified ID and updates the audit log.
-     *
-     * @param id - The ID of the preview to close.
-     * @param query - The partial query object used to retrieve the preview detail.
-     */
-    close(id: string, query: Partial<Query>): void;
-    /**
-     * Previews an article in a new browser's tab.
-     *
-     * @param article - The article to preview.
-     */
-    openExternal(article: Article): void;
-    /**
-     * Sets the iframe window object.
-     *
-     * @param iframe - The window object of the iframe or null to unset.
-     */
-    setIframe(iframe: Window | null): void;
-    /**
-     * Sets the preview data and updates the highlight category based on the provided data.
-     *
-     * @param data - The preview data to be set.
-     *
-     * If the provided data contains highlights per category with 'matchingpassages' having values,
-     * the highlight category is set to "matchingpassages". Otherwise, it is set to "extractslocations".
-     */
-    setPreviewData(data: PreviewData): void;
-    /**
-     * Sends a message to the iframe if it exists.
-     *
-     * @param message - The message to be sent. It can be of any type.
-     */
-    sendMessage(message: unknown): void;
-    /**
-     * Get preview id for an entity value for an index
-     * @param entity the entity type (i.e. "geo")
-     * @param value the entity value (i.e. "AUSTRALIA")
-     * @param index the entity index from its list
-     * @returns the html id
-     */
-    getEntityId(entity: string, value: string, index: number): number | undefined;
-    /**
-     * Send a message to the prewiew iFrame with the required data to retrieve HTML content for a specific highlight category
-     *
-     * @param id - The unique identifier for the request.
-     * @param highlightCategory - The category of highlights to retrieve.
-     * @param previewData - The data containing highlights and their locations.
-     */
-    retrieveHtmlContent(id: string, highlightCategory: string, previewData: PreviewData): void;
-    /**
-     * Sends a message to zoom in.
-     *
-     * This method triggers a "zoom-in" action by sending a message
-     * with the specified action type.
-     */
-    zoomIn(): void;
-    /**
-     * Sends a message to zoom out the preview.
-     *
-     * This method triggers a "zoom-out" action by sending a message
-     * to the relevant service or component.
-     */
-    zoomOut(): void;
-    /**
-     * Toggles the highlights based on the provided flags for extracts and entities.
-     *
-     * @param extracts - A boolean flag indicating whether to include extracts highlights.
-     * @param entities - A boolean flag indicating whether to include entities highlights.
-     */
-    toggle(extracts: boolean, entities: boolean): void;
-    getAuditPreviewDetail(id: string, q: Partial<Query>): {
-        docid: string;
-        rank: number;
-        collection: string;
-        source: string;
-        resultid: string;
-        querylang: string | undefined;
-        querytext: string | undefined;
-        filename: string | undefined;
-        fileext: string | undefined;
-        score: number | undefined;
-    };
-    private fetchExtracts;
-    static ɵfac: i0.ɵɵFactoryDeclaration<PreviewService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<PreviewService>;
-}

package/lib/web-services/principal.service.d.ts

@@ -1,28 +0,0 @@
-import { HttpClient } from "@angular/common/http";
-import { Observable } from "rxjs";
-import { Principal } from "@sinequa/atomic";
-import * as i0 from "@angular/core";
-export declare class PrincipalService {
-    protected readonly http: HttpClient;
-    protected readonly API_URL: string;
-    /**
-     * Retrieves the principal information from the server.
-     *
-     * @returns Observable<Principal> An observable that emits the principal information.
-     *
-     * @remarks
-     * This method sends a GET request to the API endpoint to fetch the principal data.
-     * It includes query parameters to specify the action and to indicate that no authentication is required.
-     * In case of an error, it logs the error to the console and returns an empty observable.
-     *
-     * @example
-     * ```typescript
-     * principalService.getPrincipal().subscribe(principal => {
-     *   console.log(principal);
-     * });
-     * ```
-     */
-    getPrincipal(): Observable<Principal>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<PrincipalService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<PrincipalService>;
-}

package/lib/web-services/query.service.d.ts

@@ -1,29 +0,0 @@
-import { HttpClient } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import { AuditEvents, Query, Result } from '@sinequa/atomic';
-import * as i0 from "@angular/core";
-export declare class QueryService {
-    protected readonly http: HttpClient;
-    private readonly appStore;
-    private readonly queryParamsStore;
-    protected readonly API_URL: string;
-    /**
-     * Performs a search query.
-     *
-     * @param q - The partial query object.
-     * @param includeQueryParams - Indicates whether to include query parameters automatically in the request.
-     * @param audit - The audit events object.
-     * @returns An observable that emits the search results.
-     */
-    search(q?: Partial<Query>, includeQueryParams?: boolean, audit?: AuditEvents): Observable<Result>;
-    /**
-     * Performs a bulk search operation.
-     *
-     * @param q An array of Query objects representing the search queries.
-     * @param audit An optional AuditEvents object for auditing purposes.
-     * @returns An Observable that emits an array of Result objects.
-     */
-    bulkSearch(q: Query[], audit?: AuditEvents): Observable<Result[]>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<QueryService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<QueryService>;
-}

package/lib/web-services/text-chunck.service.d.ts

@@ -1,22 +0,0 @@
-import { HttpClient } from "@angular/common/http";
-import { Query, TextChunk, TextLocation } from "@sinequa/atomic";
-import { Observable } from "rxjs";
-import * as i0 from "@angular/core";
-export declare class TextChunkService {
-    protected readonly http: HttpClient;
-    protected readonly API_URL: string;
-    /**
-     * Retrieves text chunks based on the provided parameters.
-     *
-     * @param id - The ID of the record.
-     * @param textChunks - An array of TextLocation objects representing the location of the text chunks.
-     * @param highlights - An array of strings representing the highlights to be applied to the text chunks.
-     * @param query - The query used to retrieve the text chunks.
-     * @param leftSentencesCount - The number of sentences to include before the text chunks.
-     * @param rightSentencesCount - The number of sentences to include after the text chunks.
-     * @returns An Observable that emits an array of TextChunk objects.
-     */
-    getTextChunks(id: string, textChunks: TextLocation[], highlights: string[], query: Query, leftSentencesCount: number, rightSentencesCount: number): Observable<TextChunk[]>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TextChunkService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<TextChunkService>;
-}

package/public-api.d.ts

@@ -1 +0,0 @@
-export * from "./lib/public-api";