@sinequa/atomic 0.0.62

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"}

package/dist/web-api/fetch-user-settings.d.ts

@@ -0,0 +1,28 @@
+import { AuditEvents } from "../types";
+/**
+ * Fetches the user settings from the backend API.
+ * @returns A promise that resolves to the user settings.
+ */
+export declare function fetchUserSettings<T>(): Promise<T>;
+/**
+ * Saves the user settings to the backend API.
+ * @param userSettings - The user settings to be saved.
+ * @param audit - Optional audit event to be recorded with the save action.
+ * @returns A promise that resolves when the settings are saved successfully.
+ */
+export declare function saveUserSettings<T>(userSettings: T, audit?: AuditEvents): Promise<void>;
+/**
+ * Patches the user settings in the backend API.
+ * @param userSettings - Partial user settings to be patched.
+ * @param audit - Optional audit event to be recorded with the patch action.
+ * @returns A promise that resolves to the updated user settings.
+ */
+export declare function patchUserSettings<T>(userSettings: Partial<T>, audit?: AuditEvents): Promise<T>;
+/**
+ * Deletes all user settings by saving an empty object.
+ * This effectively resets the user settings to their default state.
+ *
+ * @returns A promise that resolves when the settings are successfully deleted.
+ */
+export declare function deleteUserSettings(): Promise<void>;
+//# sourceMappingURL=fetch-user-settings.d.ts.map

package/dist/web-api/fetch-user-settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-user-settings.d.ts","sourceRoot":"","sources":["../../src/web-api/fetch-user-settings.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAKvC;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAQvD;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAU7F;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,CAYpG;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAExD"}

package/dist/web-api/helpers.d.ts

@@ -0,0 +1,35 @@
+import { API_ENDPOINTS } from "../types";
+/**
+ * Creates headers for a web API request.
+ * @returns {Headers} The headers object.
+ */
+export declare function createHeaders(headers?: Headers): Headers;
+/**
+ * Handles the response from the web API.
+ *
+ * @param response - The response from the web API.
+ * @returns A promise that resolves to the response data of type T.
+ */
+export declare function handleResponse<T>(response: Response): Promise<T>;
+/**
+ * Makes a POST request to the specified API endpoint.
+ * `app` and `locale` are added automatically to the request body.
+ *
+ * @param endpoint - The API endpoint to send the request to.
+ * @param body - The request body as a record of key-value pairs.
+ * @returns A promise that resolves to the response data of type T.
+ */
+export declare function post<T>(endpoint: API_ENDPOINTS, body: Record<string, unknown>, options?: {
+    headers?: Headers;
+}): Promise<T>;
+/**
+ * Makes a GET request to the specified API endpoint with the given parameters.
+ *
+ * @param endpoint - The API endpoint to send the GET request to.
+ * @param params - The URL parameters to include in the request.
+ * @returns A Promise that resolves to the response data of type T.
+ */
+export declare function get<T>(endpoint: API_ENDPOINTS, params?: URLSearchParams, options?: {
+    headers?: Headers;
+}): Promise<T>;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/web-api/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/web-api/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAIzC;;;GAGG;AACH,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAiBxD;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,CAgCtE;AAED;;;;;;;GAOG;AACH,wBAAsB,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAoBjI;AAED;;;;;;GAMG;AACH,wBAAsB,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAa3H"}

package/dist/web-api/helpers.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=helpers.test.d.ts.map

package/dist/web-api/helpers.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.test.d.ts","sourceRoot":"","sources":["../../src/web-api/helpers.test.ts"],"names":[],"mappings":""}

package/dist/web-api/index.d.ts

@@ -0,0 +1,15 @@
+export * from "./fetch-query";
+export * from "./fetch-preview";
+export * from "./fetch-principal";
+export * from "./fetch-app";
+export * from "./fetch-aggregation";
+export * from "./fetch-user-settings";
+export * from "./fetch-suggest";
+export * from "./fetch-sponsored-links";
+export * from "./fetch-text-chunk";
+export * from "./fetch-audit";
+export * from "./fetch-dataset";
+export * from "./fetch-labels";
+export * from "./fetch-query-intent";
+export * from "./helpers";
+//# sourceMappingURL=index.d.ts.map

package/dist/web-api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/web-api/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AAErC,cAAc,WAAW,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@sinequa/atomic",
+  "private": false,
+  "version": "0.0.62",
+  "type": "module",
+  "main": "./dist/atomic.umd.cjs",
+  "module": "./dist/atomic.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/atomic.js",
+      "require": "./dist/atomic.umd.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build && tsc",
+    "build:patch": "npm run build",
+    "build:minor": "npm run build",
+    "build:major": "npm run build",
+    "dev:pack": "npm run build && npm pack --pack-destination=package",
+    "prebuild:patch": "npm version patch",
+    "prebuild:minor": "npm version minor",
+    "prebuild:major": "npm version major",
+    "preview": "vite preview",
+    "test": "vitest",
+    "v:publish": "npm publish --registry https://npm.sinequa.com",
+    "v:unpublish": "npm unpublish --registry https://npm.sinequa.com --force"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "jsdom": "^23.2.0",
+    "typescript": "^5.2.2",
+    "vite": "^5.0.8",
+    "vite-plugin-dts": "^4.2.4",
+    "vitest": "^1.1.3"
+  }
+}