@sinequa/atomic 0.0.61

package/dist/utils/concepts.d.ts

@@ -0,0 +1,72 @@
+export type FullTextPattern = {
+    type: 'group' | 'adjacent' | 'exact' | 'regex' | 'token';
+    value: string;
+    op?: '+' | '-';
+};
+/**
+ * Parses the given text and returns an array of FullTextPattern objects.
+ * @param text - The text to parse.
+ * @returns An array of FullTextPattern objects.
+ */
+export declare function parseText(text: string): FullTextPattern[];
+/**
+ * Rewrites the text based on the provided patterns.
+ * @param patterns An array of FullTextPattern objects representing the patterns to be applied.
+ * @returns The rewritten text.
+ */
+export declare function rewriteText(patterns: FullTextPattern[]): string;
+/**
+ * Adds concepts to the given text by modifying the patterns.
+ * @param text - The input text to which the concepts will be added.
+ * @param concepts - An array of concepts to be added to the text.
+ * @param op - An optional parameter specifying the operation to be performed on the concepts.
+ *             If '+' is provided, the concepts will be added adjacent to the text.
+ *             If '-' is provided, the concepts will be removed from the text.
+ * @returns The modified text after adding or removing the concepts.
+ *
+ * @example
+ * // Example 1:
+ * const text = "This is a +[test] +[sentence].";
+ * const result = addConcepts(text, ["example"]);
+ * // Output: "This is a +[test] +[sentence] +[example]."
+ */
+export declare function addConcepts(text: string, concepts: string[], op?: '+' | '-'): string;
+/**
+ * Removes a concept from the given text.
+ *
+ * @param concept - The concept to be removed.
+ * @param text - The text from which the concept should be removed.
+ * @returns The updated text with the concept removed, or the original text if the concept was not found.
+ *
+ * @example
+ * // Example 1:
+ * const text = "This is a +test +sentence.";
+ * const result = removeConcept("test", text);
+ * // Output: "This is a +sentence."
+ */
+export declare function removeConcept(concept: string, text: string): string;
+/**
+ * Removes concepts from the given text.
+ * @param text - The input text.
+ * @returns The text with concepts removed.
+ *
+ * @example
+ * // Example 1:
+ * const text = "This is a +[test] +[sentence].";
+ * const result = removeConcepts(text);
+ * // Output: "This is a ."
+ */
+export declare function removeConcepts(text: string): string;
+/**
+ * Retrieves the concepts from the given text.
+ * @param text - The text to parse and extract concepts from.
+ * @returns An array of concepts extracted from the text.
+ *
+ * @example
+ * // Example 1:
+ * const text = "This is a +[test] +[sentence].";
+ * const concepts = getConcepts(text);
+ * // Output: ["test", "sentence"]
+ */
+export declare function getConcepts(text: string): string[];
+//# sourceMappingURL=concepts.d.ts.map

package/dist/utils/concepts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"concepts.d.ts","sourceRoot":"","sources":["../../src/utils/concepts.ts"],"names":[],"mappings":"AAYA,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,GAAG,GAAG,GAAG,CAAA;CACf,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAC,MAAM,GAAG,eAAe,EAAE,CAYxD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,eAAe,EAAE,GAAG,MAAM,CAW/D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,GAAG,GAAC,GAAG,GAAG,MAAM,CAMjF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,GAAG,MAAM,CAQlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAC,MAAM,GAAG,MAAM,CAIlD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAC,MAAM,GAAG,MAAM,EAAE,CAIjD"}

package/dist/utils/date.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Relative date object to represent the difference between two dates
+ * @typedef {Object} RelativeDate
+ * @property {number} offset - The difference between two dates
+ * @property {Intl.RelativeTimeFormatUnit} unit - The unit of the difference
+ * @property {boolean} isFuture - If the target date is in the future
+ */
+export type RelativeDate = {
+    offset: number;
+    unit: Intl.RelativeTimeFormatUnit;
+    isFuture: boolean;
+};
+/**
+ * Get the relative date between two dates, in most cases the base date is the current date
+ * @param locale Locale to use for the relative date
+ * @param target Target date to compare
+ * @param base Base date to compare
+ * @returns Relative date string as a human readable format using {@link Intl.RelativeTimeFormat}
+ */
+export declare function getRelativeDate(locale: string, target: string, base?: string): string;
+/**
+ * Get the relative date between two dates, in most cases the base date is the current date
+ * and the target date is the the future date to compare, if the base date is not provided
+ * the current date will be used.
+ * RelativeDate.offset is return in day unit.
+ * @param target Target date to compare
+ * @param base Base date to compare
+ * @returns RelativeDate object with offset, unit and isFuture
+ */
+export declare function getOffsetFromDates(target: string, base?: string): RelativeDate;
+//# sourceMappingURL=date.d.ts.map

package/dist/utils/date.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../src/utils/date.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,IAAI,CAAC,sBAAsB,CAAC;IAClC,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAKrF;AAGD;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,YAAY,CAY9E"}

package/dist/utils/index.d.ts

@@ -0,0 +1,7 @@
+export * from './aggregations';
+export * from './array/bisect';
+export * from './concepts';
+export * from './date';
+export * from './query-params';
+export * from './syslang';
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC"}

package/dist/utils/query-params.d.ts

@@ -0,0 +1,72 @@
+import { LegacyFilter, Query } from "../types";
+/**
+ * `path`: hash of the search without the bang in form of `/search/all`
+ * `filters`: filters associated to the query
+ * `id`: document id if there's one opened,
+ * `queryName`: name of the query
+ */
+export type QueryParams = Query & {
+    path?: string;
+    filters?: LegacyFilter[];
+    id?: string;
+    queryName?: string;
+};
+/**
+ * Get {@link QueryParams} from url string
+ *
+ * @param url string to parse
+ * @returns {@link QueryParams} or undefined
+ */
+export declare function getQueryParamsFromUrl(url: string | undefined): QueryParams | undefined;
+/**
+ * Get {@link Filter} array from query params string
+ *
+ * @param queryParams string to parse
+ * @returns {@link Filter} array
+ */
+export declare function getFiltersFromUrl(url: string | undefined): LegacyFilter[];
+/**
+ * Get {@link Filter} array from uri string
+ *
+ * @param uri string to parse
+ * @returns {@link Filter} array
+ */
+export declare function getFiltersFromURI(uri: string): LegacyFilter[];
+/**
+ * Returns the object query parameters from the given URL
+ *
+ * @param url
+ * @returns
+ *
+ * @example
+ * ```typescript
+ * const url = 'https://example.com/search?q=hello&f=type:document';
+ * const rawQueryParams = queryParamsFromUrl(url);
+ *
+ * console.log(rawQueryParams);
+ *
+ * ^// Output: {q:'hello', f:'type:document', ...}
+ * ```
+ */
+export declare function queryParamsFromUrl(url: string): Record<string, string>;
+/**
+ * Retrieves the query text from a URL.
+ * @param url - The URL containing the query text.
+ * @returns The decoded query text.
+ */
+export declare function getQueryTextFromUrl(url: string): string;
+/**
+ * Retrieves the ID from the given URL.
+ * @param url - The URL from which to extract the ID.
+ * @returns The decoded ID.
+ */
+export declare function getIdFromUrl(url: string): string;
+/**
+ * Retrieves the page number from the given URL query string.
+ *
+ * @param url - The URL containing the query string.
+ * @returns The page number parsed from the query string.
+ */
+export declare function getQueryPageFromUrl(url: string): number;
+export declare function getQueryTabFromUrl(url: string): string;
+//# sourceMappingURL=query-params.d.ts.map

package/dist/utils/query-params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../../src/utils/query-params.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,CAetF;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,YAAY,EAAE,CAKzE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,EAAE,CAK7D;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAOtE;AAGD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAGvD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIhD;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIvD;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAItD"}

package/dist/utils/syslang.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Translates a system language formatted text to the specified locale.
+ * If a matching language is found, returns the translated text.
+ * If no matching language is found, returns the default language text.
+ * If the input text is empty, returns an empty string.
+ *
+ * @param text - The system language formatted text to translate.
+ * @param currentLocale - The locale to translate the text to.
+ * @returns The translated text or the default language text.
+ *
+ * @example
+ * // Example 1:
+ * const translatedText = sysLang("all[fr]tous[de]alle", "en-US");
+ * // Output: "all"
+ *
+ * @example
+ * // Example 2:
+ * const translatedText = sysLang("all[fr]tous[de]alle", "fr-FR");
+ * // Output: "tous"
+ *
+ * @example
+ * // Example 2:
+ * const translatedText = sysLang("all[fr]tous[de]alle", "fr");
+ * // Output: "tous"
+ */
+export declare function sysLang(text: string, currentLocale: string): string;
+//# sourceMappingURL=syslang.d.ts.map

package/dist/utils/syslang.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"syslang.d.ts","sourceRoot":"","sources":["../../src/utils/syslang.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM,CAsCnE"}

package/dist/web-api/fetch-aggregation.d.ts

@@ -0,0 +1,11 @@
+import { Aggregation, AuditEvents, Query } from "../types";
+/**
+ * Fetches an aggregation from the server.
+ *
+ * @param aggregation - The aggregation to fetch.
+ * @param query - The query parameters.
+ * @param audit - Optional audit events.
+ * @returns A promise that resolves to the fetched aggregation.
+ */
+export declare function fetchAggregation(aggregation: Aggregation, query: Query, audit?: AuditEvents): Promise<Aggregation>;
+//# sourceMappingURL=fetch-aggregation.d.ts.map

package/dist/web-api/fetch-aggregation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-aggregation.d.ts","sourceRoot":"","sources":["../../src/web-api/fetch-aggregation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAU,MAAM,UAAU,CAAC;AAGnE;;;;;;;GAOG;AACH,wBAAsB,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAkBxH"}

package/dist/web-api/fetch-app.d.ts

@@ -0,0 +1,17 @@
+import { CCApp, CCAppPreLogin } from "../types";
+/**
+ * Fetches the CCApp object.
+ * @returns A promise that resolves to the CCApp object.
+ */
+export declare function fetchApp(): Promise<CCApp>;
+/**
+ * Fetches the pre-login information for the app.
+ * @returns A promise that resolves to the pre-login information of the app.
+ */
+export declare function fetchAppPreLogin(): Promise<CCAppPreLogin>;
+/**
+ * Initializes the application by setting the global configuration and fetching app pre-login data.
+ * @returns A promise that resolves when the initialization is complete.
+ */
+export declare function appInitializerFn(): Promise<any>;
+//# sourceMappingURL=fetch-app.d.ts.map

package/dist/web-api/fetch-app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-app.d.ts","sourceRoot":"","sources":["../../src/web-api/fetch-app.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAIhD;;;GAGG;AACH,wBAAsB,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,CAK/C;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC,CAQ/D;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,CA8C/C"}

package/dist/web-api/fetch-audit.d.ts

@@ -0,0 +1,33 @@
+import { AuditEvents, AuditRecord } from "../types";
+/**
+* Adds additional audit information to the provided body object.
+*
+* @param body - The body object to add audit information to.
+*/
+export declare function addAuditAdditionalInfo(body: unknown): void;
+/**
+ * Adds a session ID to the audit record.
+ *
+ * @param auditRecord - The audit record to modify.
+ * @returns The modified audit record with the session ID added.
+ */
+export declare function addSessionId(auditRecord: AuditRecord): AuditRecord;
+/**
+ * Adds the current URL to the audit record.
+ *
+ * @param auditRecord - The audit record to update.
+ * @returns The updated audit record.
+ */
+export declare function addUrl(auditRecord: AuditRecord): AuditRecord;
+/**
+ * Notifies the server about audit events.
+ *
+ * @param auditEvents - The audit events to be sent to the server.
+ * @returns A promise that resolves to the updated audit events.
+ */
+declare function notify(auditEvents: AuditEvents): Promise<AuditEvents>;
+export declare const Audit: {
+    notify: typeof notify;
+};
+export {};
+//# sourceMappingURL=fetch-audit.d.ts.map

package/dist/web-api/fetch-audit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-audit.d.ts","sourceRoot":"","sources":["../../src/web-api/fetch-audit.ts"],"names":[],"mappings":"AACA,OAAO,EAAc,WAAW,EAAkB,WAAW,EAAE,MAAM,UAAU,CAAC;AAOhF;;;;EAIE;AACF,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,OAAO,QAOlD;AA6BD;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,WAAW,eASpD;AAGD;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,WAAW,EAAE,WAAW,eAS9C;AAwBF;;;;;GAKG;AACH,iBAAe,MAAM,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CASpE;AAED,eAAO,MAAM,KAAK;;CAAa,CAAA"}

package/dist/web-api/fetch-dataset.d.ts

@@ -0,0 +1,43 @@
+import { Result } from "../types";
+export type DatasetError = {
+    errorCode: number;
+    errorMessage: string;
+};
+export type DatasetDescription = {
+    name: string;
+    description?: string;
+};
+export type DataSet<T extends Result = Result> = Record<string, T | DatasetError>;
+/**
+ * Fetches a dataset from the specified web service and query name.
+ *
+ * @template T - The type of the dataset, defaults to `Article`.
+ * @param {string} webserviceName - The name of the web service to fetch the dataset from.
+ * @param {string} queryName - The name of the query to execute.
+ * @param {object} [parameters={}] - Optional parameters to pass to the query.
+ * @returns {Promise<T>} A promise that resolves to the fetched dataset.
+ * @throws {Error} If the dataset contains an error code and message.
+ */
+export declare function fetchDataset<T extends Result = Result>(webserviceName: string, queryName: string, parameters?: {}): Promise<T>;
+/**
+ * Fetches datasets from a specified web service.
+ *
+ * @template T - The type of the articles in the dataset, defaults to `Article`.
+ * @param {string} webserviceName - The name of the web service to fetch datasets from.
+ * @param {Object} options - The options for the request.
+ * @param {Object} [options.body] - The body of the request, defaults to an empty object.
+ * @param {string[]} [options.datasets] - An array of dataset names to fetch, defaults to an empty array.
+ * @returns {Promise<DataSet<T>>} - A promise that resolves to the fetched datasets.
+ */
+export declare function fetchDatasets<T extends Result = Result>(webserviceName: string, options: {
+    parameters?: {};
+    datasets?: string[];
+}): Promise<DataSet<T>>;
+/**
+ * Fetches a list of dataset descriptions from the specified web service.
+ *
+ * @param webserviceName - The name of the web service to fetch the dataset list from.
+ * @returns A promise that resolves to an array of `DatasetDescription` objects.
+ */
+export declare function fetchDatasetList(webserviceName: string): Promise<DatasetDescription[]>;
+//# sourceMappingURL=fetch-dataset.d.ts.map

package/dist/web-api/fetch-dataset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-dataset.d.ts","sourceRoot":"","sources":["../../src/web-api/fetch-dataset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGlC,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAA;AAED,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,GAAC,YAAY,CAAC,CAAC;AAEhF;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CASpI;AAED;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE;IAAE,UAAU,CAAC,EAAE,EAAE,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,GAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAO7J;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAG5F"}

package/dist/web-api/fetch-labels.d.ts

@@ -0,0 +1,95 @@
+import { LabelsRights, Query } from "../types";
+/**
+ * Fetches labels based on the provided prefix and other optional parameters.
+ *
+ * @param {string} prefix - The prefix to filter the labels.
+ * @param {boolean} [publicOnly=true] - Whether to fetch only public labels. Defaults to true.
+ * @param {string} [locale] - Optional locale to filter the labels.
+ * @returns {Promise<Labels>} A promise that resolves to the fetched labels.
+ */
+export declare function fetchLabels(prefix: string, publicOnly?: boolean, locale?: string): Promise<string[]>;
+/**
+ * Fetches the user labels's rights.
+ *
+ * This function constructs a URLSearchParams object with the current application
+ * name and the action "getUserRights". It then calls the `get` function with
+ * the endpoint "labels" and the constructed parameters to retrieve the user labels's rights.
+ *
+ * @returns {Promise<LabelsRights>} A promise that resolves to the user rights for the current application.
+ */
+declare function getUserRights(): Promise<LabelsRights>;
+/**
+ * Adds labels to the specified document IDs.
+ *
+ * @param labels - An array of labels to be added.
+ * @param ids - An array of document IDs to which the labels will be added.
+ * @param publicOnly - A boolean indicating whether the labels should be public. Defaults to true.
+ * @returns A promise that resolves when the labels have been added.
+ */
+declare function add(labels: string[], ids: string[], publicOnly?: boolean): Promise<void>;
+/**
+ * Removes labels from documents.
+ *
+ * @param {string[]} labels - The labels to be removed.
+ * @param {string[]} ids - The IDs of the documents from which the labels will be removed.
+ * @param {boolean} [publicOnly=true] - Indicates whether the operation should be public only.
+ * @returns {Promise<void>} A promise that resolves when the operation is complete.
+ */
+declare function remove(labels: string[], ids: string[], publicOnly?: boolean): Promise<void>;
+/**
+ * Renames a set of labels to a new label.
+ *
+ * @param {string[]} labels - The list of labels to be renamed.
+ * @param {string} newLabel - The new label name to be assigned.
+ * @param {boolean} [publicOnly=true] - Indicates if the operation should be applied to public labels only.
+ * @returns {Promise<void>} A promise that resolves when the operation is complete.
+ */
+declare function rename(labels: string[], newLabel: string, publicOnly?: boolean): Promise<void>;
+/**
+ * Deletes the specified labels.
+ *
+ * @param {string[]} labels - The labels to be deleted.
+ * @param {boolean} [publicOnly=true] - Indicates whether to delete only public labels. Defaults to true.
+ * @returns {Promise<void>} A promise that resolves when the labels have been deleted.
+ */
+declare function deleteLabels(labels: string[], publicOnly?: boolean): Promise<void>;
+/**
+ * Adds multiple labels in bulk to the specified query.
+ *
+ * @param labels - An array of labels to be added.
+ * @param query - The query object to which the labels will be added.
+ * @param publicOnly - A boolean indicating whether the labels should be public. Defaults to true.
+ * @returns A promise that resolves when the labels have been added.
+ */
+declare function bulkAdd(labels: string[], query: Query, publicOnly?: boolean): Promise<void>;
+/**
+ * Removes multiple labels based on the provided query.
+ *
+ * @param labels - An array of label strings to be removed.
+ * @param query - The query object used to filter which labels to remove.
+ * @param publicOnly - A boolean indicating whether to remove only public labels. Defaults to true.
+ * @returns A promise that resolves when the labels have been removed.
+ */
+declare function bulkRemove(labels: string[], query: Query, publicOnly?: boolean): Promise<void>;
+/**
+ * A collection of functions related to label management.
+ *
+ * @property {Function} getUserRights - Retrieves the rights of a user.
+ * @property {Function} add - Adds a new label.
+ * @property {Function} remove - Removes an existing label.
+ * @property {Function} rename - Renames an existing label.
+ * @property {Function} delete - Deletes a label.
+ * @property {Function} bulkAdd - Adds multiple labels at once.
+ * @property {Function} bulkRemove - Removes multiple labels at once.
+ */
+export declare const labels: {
+    getUserRights: typeof getUserRights;
+    add: typeof add;
+    remove: typeof remove;
+    rename: typeof rename;
+    delete: typeof deleteLabels;
+    bulkAdd: typeof bulkAdd;
+    bulkRemove: typeof bulkRemove;
+};
+export {};
+//# sourceMappingURL=fetch-labels.d.ts.map

package/dist/web-api/fetch-labels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-labels.d.ts","sourceRoot":"","sources":["../../src/web-api/fetch-labels.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,YAAY,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAG/D;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,GAAE,OAAc,EAAE,MAAM,CAAC,EAAE,MAAM,qBAW5F;AAED;;;;;;;;GAQG;AACH,iBAAe,aAAa,0BAQ3B;AAED;;;;;;;GAOG;AACH,iBAAe,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,UAAU,GAAE,OAAc,iBA2B7E;AAED;;;;;;;GAOG;AACH,iBAAe,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,UAAU,GAAE,OAAc,iBA2BhF;AAED;;;;;;;GAOG;AACH,iBAAe,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,GAAE,OAAc,iBAiBnF;AAED;;;;;;GAMG;AACH,iBAAe,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,UAAU,GAAE,OAAc,iBAevE;AAED;;;;;;;GAOG;AACH,iBAAe,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,GAAE,OAAc,iBAiBhF;AAED;;;;;;;GAOG;AACH,iBAAe,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,GAAE,OAAc,iBAiBnF;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,MAAM;;;;;;;;CAQlB,CAAA"}

package/dist/web-api/fetch-preview.d.ts

@@ -0,0 +1,17 @@
+import { PreviewData, Query } from "../types";
+/**
+ * Fetches preview data for a given id and query.
+ *
+ * @param id - The identifier for the preview.
+ * @param query - The query parameters for the preview.
+ * @returns A promise that resolves to the PreviewData.
+ */
+export declare function fetchPreview(id: string, q: Query): Promise<PreviewData>;
+/**
+ * Fetches preview document content from a given URL.
+ *
+ * @param url - The URL to fetch the preview document content from.
+ * @returns A promise that resolves to the PreviewData.
+ */
+export declare function fetchPreviewUrl(url: string): Promise<void>;
+//# sourceMappingURL=fetch-preview.d.ts.map

package/dist/web-api/fetch-preview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-preview.d.ts","sourceRoot":"","sources":["../../src/web-api/fetch-preview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAG9C;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,CAY7E;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,GAAG,EAAE,MAAM,iBAYhD"}

package/dist/web-api/fetch-principal.d.ts

@@ -0,0 +1,13 @@
+import { Principal } from "../types";
+/**
+ * Fetches the principal (current user) information from the backend API.
+ *
+ * This function sends a GET request to the "principal" endpoint with specific
+ * query parameters to retrieve the current user's data without triggering
+ * automatic authentication.
+ *
+ * @returns A promise that resolves to the Principal object, representing
+ *          the current user's information.
+ */
+export declare function fetchPrincipal(): Promise<Principal>;
+//# sourceMappingURL=fetch-principal.d.ts.map

package/dist/web-api/fetch-principal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-principal.d.ts","sourceRoot":"","sources":["../../src/web-api/fetch-principal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAGrC;;;;;;;;;GASG;AACH,wBAAsB,cAAc,IAAI,OAAO,CAAC,SAAS,CAAC,CAOzD"}

package/dist/web-api/fetch-query.d.ts

@@ -0,0 +1,27 @@
+import { AuditEvents, Query, QueryIntentData, Result, TreeAggregation, TreeAggregationNode } from "../types";
+/**
+ * Fetches data from the backend using the specified query.
+ * @param query The query to be sent to the backend.
+ * @returns A promise that resolves to the fetched data.
+ */
+export declare function fetchQuery(query: Query, audit?: AuditEvents, queryIntentData?: QueryIntentData): Promise<Result>;
+/**
+ * Fetches multiple queries in bulk.
+ * @param queries - An array of Query objects representing the queries to be fetched.
+ * @param auditEvents - Optional AuditEvents object containing audit events for the request.
+ * @returns A Promise that resolves to an array of Result objects representing the query results.
+ */
+export declare function fetchBulkQuery(queries: Query[], mode?: "parallel", auditEvents?: AuditEvents): Promise<Result[]>;
+/**
+ * Builds an array of paths and levels for a given tree aggregation.
+ *
+ * @param tree - The tree aggregation object.
+ * @param currentPath - The current path (optional, default: '').
+ * @param currentLevel - The current level (optional, default: 0).
+ * @returns An array of objects containing the path and level for each item in the tree.
+ */
+export declare function buildPathsAndLevels(tree: TreeAggregation | TreeAggregationNode, currentPath?: string, currentLevel?: number): {
+    path: string;
+    level: number;
+}[];
+//# sourceMappingURL=fetch-query.d.ts.map

package/dist/web-api/fetch-query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-query.d.ts","sourceRoot":"","sources":["../../src/web-api/fetch-query.ts"],"names":[],"mappings":"AACA,OAAO,EAAwB,WAAW,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAKnI;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,WAAW,EAAE,eAAe,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CA0BtH;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAoDtH;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,eAAe,GAAG,mBAAmB,EAAE,WAAW,SAAK,EAAE,YAAY,SAAI,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,EAAG,CAkBvJ"}

package/dist/web-api/fetch-sponsored-links.d.ts

@@ -0,0 +1,14 @@
+import { LinkResult, Query } from "../types";
+/**
+ * Fetches sponsored links based on the provided webservice and query.
+ *
+ * This function sends a POST request to the "query.links" endpoint with the
+ * specified webservice and query parameters to retrieve sponsored links.
+ *
+ * @param webservice - The name of the webservice to use for fetching sponsored links.
+ * @param query - The query parameters for fetching sponsored links.
+ * @returns A promise that resolves to an array of LinkResult objects, each
+ *          representing a sponsored link with the original query attached.
+ */
+export declare function fetchSponsoredLinks(webservice: string, query: Query): Promise<LinkResult[]>;
+//# sourceMappingURL=fetch-sponsored-links.d.ts.map

package/dist/web-api/fetch-sponsored-links.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-sponsored-links.d.ts","sourceRoot":"","sources":["../../src/web-api/fetch-sponsored-links.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAgB,KAAK,EAAE,MAAM,UAAU,CAAC;AAG3D;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAQjG"}

package/dist/web-api/fetch-suggest.d.ts

@@ -0,0 +1,55 @@
+import { Suggestion } from "../types";
+/**
+ * Fetches suggestions based on the provided parameters.
+ *
+ * @param suggestQueryName - The name of the suggest query.
+ * @param text - The text to be used for suggestions.
+ * @param filter - Optional filter object for additional filtering.
+ *    Contains a list of columns (key/value pairs) to filter.<br>
+ *    The columns used within this parameter must be declared in the Filter columns section options of the suggestion lexicon.<br>
+ *    @example
+ *    {
+ *     "columns":{
+ *      "docformat":"*",
+ *      "authors":"*"
+ *    },
+ *    "filter":{
+ *      "docformat":"doc"
+ *     }
+ *    }
+ *
+ * @param kinds - Optional array of kinds to filter the suggestions.
+ *    Allows overriding the types defined in the suggestion query that are used by default.
+ *    To specify several kinds, use the comma as a separator.
+ *    By default, all kinds defined in the suggestion lexicon are taken into account.
+ *    @example "kinds": ["city", "name"]
+ * @param showSource - Optional flag, when set to true, returns the name of the index column from which the suggested term is extracted.
+ * @returns A promise that resolves to an array of suggestions.
+ */
+export declare function fetchSuggest(suggestQueryName: string, text: string, filter?: Record<string, unknown>, kinds?: string[], showSource?: boolean): Promise<Suggestion[]>;
+/**
+ * @deprecated Use fetchSuggest instead.
+ *
+ * Fetches suggestions based on the provided query parameters.
+ * @param suggestQueryName - The name of the suggest query.
+ * @param text - The text to be used for suggestion.
+ * @param queryName - The name of the query.
+ * @param fields - Optional array of kinds to filter the suggestions.
+ *    Allows overriding the types defined in the suggestion query that are used by default.
+ *    To specify several kinds, use the comma as a separator.
+ *    By default, all kinds defined in the suggestion lexicon are taken into account.
+ *    @example "kinds": ["city", "name"]
+ * @returns A promise that resolves to an array of suggestions.
+ */
+export declare function fetchSuggestQuery(suggestQueryName: string, text: string, queryName: string, fields?: string | string[]): Promise<Suggestion[]>;
+/**
+ * Fetches suggestions for a specific field.
+ *
+ * @param text - The text to search for suggestions.
+ * @param fields - Indicates a list of fields for which suggestions must be returned.
+ * This parameter is required if you set action to **suggests**
+ *
+ * @returns A promise that resolves to an array of suggestions.
+ */
+export declare function fetchSuggestField(text: string, fields: string[]): Promise<Suggestion[]>;
+//# sourceMappingURL=fetch-suggest.d.ts.map

package/dist/web-api/fetch-suggest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-suggest.d.ts","sourceRoot":"","sources":["../../src/web-api/fetch-suggest.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAsB,YAAY,CAAC,gBAAgB,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAC,OAAO,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAazK;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,iBAAiB,CAAC,gBAAgB,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAYpJ;AAGD;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAa7F"}

package/dist/web-api/fetch-text-chunk.d.ts

@@ -0,0 +1,16 @@
+import { Query, TextChunk, TextLocation } from "../types";
+/**
+ * Fetches text chunks from a document based on specified parameters.
+ *
+ * @param id - The unique identifier of the document.
+ * @param textChunks - An array of TextLocation objects representing the chunks to fetch.
+ * @param highlights - An array of strings to highlight within the text chunks.
+ * @param query - The Query object containing search parameters.
+ * @param leftSentencesCount - The number of sentences to include before each chunk.
+ * @param rightSentencesCount - The number of sentences to include after each chunk.
+ * @returns A Promise that resolves to an object containing an array of TextChunk objects.
+ */
+export declare function fetchTextChunks(id: string, textChunks: TextLocation[], highlights: string[], query: Query, leftSentencesCount: number, rightSentencesCount: number): Promise<{
+    chunks: TextChunk[];
+}>;
+//# sourceMappingURL=fetch-text-chunk.d.ts.map

package/dist/web-api/fetch-text-chunk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-text-chunk.d.ts","sourceRoot":"","sources":["../../src/web-api/fetch-text-chunk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAI1D;;;;;;;;;;GAUG;AACH,wBAAsB,eAAe,CACnC,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,YAAY,EAAE,EAC1B,UAAU,EAAE,MAAM,EAAE,EACpB,KAAK,EAAE,KAAK,EACZ,kBAAkB,EAAE,MAAM,EAC1B,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC;IAAC,MAAM,EAAE,SAAS,EAAE,CAAA;CAAC,CAAC,CAW7D"}