@sisense/sdk-ai-core 0.15.1 → 0.17.0

package/dist/services/data-sources/data-sources-service.d.ts

@@ -1,6 +1,18 @@
 import { DataSourceField, JaqlDataSourceForDto } from '@sisense/sdk-data';
 import { HttpClient } from '@sisense/sdk-rest-client';
 export declare const DATA_SOURCES_API_URL_PATH = "api/datasources";
+/**
+ * Mirrors CSDK {@link DisplayNameConfig} from `@sisense/sdk-query-client/dispatcher`
+ * without re-exporting that package (keeps consumer `.d.ts` portable).
+ */
+export type DisplayNameConfig = {
+    enabled?: boolean;
+    useNewSearchByDisplayNameApi?: boolean;
+};
+export type GetDataSourceFieldsOptions = {
+    httpClient?: HttpClient;
+    displayNameConfig?: DisplayNameConfig;
+};
 export type DataSourceFieldWithDescription = DataSourceField & {
     description?: string;
     tableDescription?: string;
@@ -26,17 +38,19 @@ export type DataSourceWithStatus = JaqlDataSourceForDto & {
 };
 export declare function getDataSources(httpClient?: HttpClient): Promise<DataSourceWithStatus[]>;
 /**
- * Get a data source by title
+ * Get a data source by title in a viewer-safe way (list + local filter).
+ * Prefer this over GET api/datasources/{title}, which requires manage/viewschema.
  */
 export declare function getDataSourceByTitle(dataSourceTitle: string, httpClient?: HttpClient): Promise<JaqlDataSourceForDto | null>;
 /**
- * Get data source fields
+ * Get data source fields via CSDK QueryApiDispatcher.
+ * Omit displayNameConfig (or leave flags false) → viewer-safe fields/search.
  */
-export declare function getDataSourceFields(dataSourceTitle: string, httpClient?: HttpClient): Promise<DataSourceField[] | null>;
+export declare function getDataSourceFields(dataSourceTitle: string, options?: GetDataSourceFieldsOptions): Promise<DataSourceField[] | null>;
 /**
  * Get data source fields with descriptions from schema
  */
-export declare function getDataSourceFieldsWithDescriptions(dataSourceTitle: string, httpClient?: HttpClient): Promise<DataSourceFieldWithDescription[] | DataSourceField[]>;
+export declare function getDataSourceFieldsWithDescriptions(dataSourceTitle: string, options?: GetDataSourceFieldsOptions): Promise<DataSourceFieldWithDescription[] | DataSourceField[]>;
 /**
  * Normalize data source fields (pure function - easily testable)
  */
@@ -45,5 +59,6 @@ export declare function normalizeFields(fields: DataSourceFieldWithDescription[]
  * Get normalized data source fields
  * @param dataSourceTitle - The title of the data source
  * @param getFieldsFn - Optional function to get fields (for testing)
+ * @param options - Optional httpClient and displayNameConfig
  */
-export declare function getNormalizedDataSourceFields(dataSourceTitle: string, getFieldsFn?: (title: string, client?: HttpClient) => Promise<DataSourceFieldWithDescription[] | DataSourceField[]>, httpClient?: HttpClient): Promise<NormalizedDataSourceField[]>;
+export declare function getNormalizedDataSourceFields(dataSourceTitle: string, getFieldsFn?: (title: string, options?: GetDataSourceFieldsOptions) => Promise<DataSourceFieldWithDescription[] | DataSourceField[]>, options?: GetDataSourceFieldsOptions): Promise<NormalizedDataSourceField[]>;

package/dist/services/llm/llm-models-service.d.ts

@@ -1,4 +1,5 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
+/** POST api/v2/ai/llm/models body. */
 export interface LlmModelPayload {
     name: string;
     provider: string;
@@ -6,9 +7,16 @@ export interface LlmModelPayload {
     region?: string;
     config: Record<string, unknown>;
 }
-export interface LlmModel extends LlmModelPayload {
+/** Item of GET api/v2/ai/llm/models — no config (write-only). */
+export interface LlmModel {
     id: string;
+    name: string;
+    model: string;
+    provider: string;
+    scope?: string;
 }
 export declare function getActiveLlmModels(httpClient?: HttpClient): Promise<LlmModel[]>;
 export declare function deleteLlmModel(id: string, httpClient?: HttpClient): Promise<void>;
-export declare function registerLlmModel(payload: LlmModelPayload, testConnection?: boolean, httpClient?: HttpClient): Promise<LlmModel>;
+export declare function registerLlmModel(payload: LlmModelPayload, testConnection?: boolean, httpClient?: HttpClient): Promise<{
+    id: string;
+}>;

package/dist/services/llm/llm-settings-service.d.ts

@@ -13,5 +13,34 @@ export interface LlmSettings {
     model: string;
     apiKey?: string;
 }
+/** AI terms & conditions accepted status (`api/v2/settings/ai/terms`). */
+export interface AiTerms {
+    accepted: boolean;
+}
+/**
+ * AI settings slice (`api/v2/settings/ai`) — the tenant-level AI configuration that is
+ * separate from the LLM provider config (`.../ai/llm`). Forward-compatible: only the
+ * fields we consume are typed; the endpoint returns more (narration, etc.).
+ *
+ * Note: unlike {@link LlmSettings}, this slice carries NO provider credentials, so
+ * reading/writing it never touches the LLM `apiKey`.
+ */
+export interface AiSettings {
+    aiAssistant?: {
+        enabled?: boolean;
+    };
+}
 export declare function getLlmSettings(): Promise<LlmSettings>;
+export declare function getAiTerms(): Promise<AiTerms>;
+/** Updates the AI terms & conditions accepted status (admins only). */
+export declare function setAiTerms(accepted: boolean): Promise<void>;
+/** Reads the AI settings slice (`api/v2/settings/ai`) — no LLM credentials involved. */
+export declare function getAiSettings(): Promise<AiSettings>;
+/**
+ * Enables or disables the AI assistant via a partial PATCH to the AI-settings slice
+ * (`api/v2/settings/ai`, admins only). Sends ONLY the `aiAssistant.enabled` field, so
+ * it never round-trips the LLM provider config (provider/baseUrl/apiKey), which lives
+ * on `api/v2/settings/ai/llm` and must not be clobbered.
+ */
+export declare function setAiAssistantEnabled(enabled: boolean): Promise<void>;
 export declare function updateLlmSettings(settings: LlmSettings): Promise<LlmSettings>;

package/dist/utils/llm-model-override.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Per-request LLM model override (test/debug only).
+ *
+ * Holds the model identifier sent as the `x-llm-model-override` header on every
+ * LLM-bound request. Kept separate from user-action tracking on purpose: tracking
+ * headers are observability (traceparent, quota, attribution), while the override
+ * is request routing — mirroring ai-integration's own header taxonomy, where
+ * `llmModelOverrideHeader` lives outside the tracking group and is consumed by the
+ * LLM resolution funnel instead of the tracing pipeline.
+ *
+ * The state is PROCESS-GLOBAL (module singleton): the last `setLlmModelOverride`
+ * wins for every subsequent request in the process. Test suites that need different
+ * overrides must run sequentially, each setting its model in `beforeAll` and
+ * clearing it in `afterAll` (see `describeForEachModel` in the e2e utils) — vitest's
+ * per-file `forks` isolation resets the state between test files.
+ */
+/**
+ * Sets a per-request LLM model override (test/debug only) carried on every subsequent
+ * LLM request as the `x-llm-model-override` header — both tool-loop completion calls
+ * (via the custom fetch) and REST calls built with `withTrackingHeaders`.
+ *
+ * ai-integration honors the header only when the `ai.featureFlags.llmOverride`
+ * base-config flag is ON and the caller is an admin; the model must already be
+ * registered (see `registerLlmModel`) and is referenced by its llm-gw `model`
+ * identifier.
+ *
+ * The override is session-scoped: it survives `startUserAction`/`endUserAction`
+ * cycles. Pass `null` to clear it (the header is then omitted entirely — required for
+ * cross-origin browser embeds, where an empty custom header still triggers a CORS
+ * preflight that Sisense does not allow).
+ * @param modelName - Registered llm-gw model identifier to force, or `null` to clear
+ */
+export declare function setLlmModelOverride(modelName: string | null): void;
+/** Returns the current override model identifier, or `null` when none is set. */
+export declare function getLlmModelOverride(): string | null;
+/**
+ * The `x-llm-model-override` header entry for outgoing LLM-bound requests, as a
+ * spreadable fragment. Returns `{}` when unset so egress points omit the header —
+ * browsers treat any custom header (even empty) as non-simple and CORS-preflight it.
+ */
+export declare function getLlmModelOverrideHeader(): Record<string, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-ai-core",
-  "version": "0.15.1",
+  "version": "0.17.0",
   "main": "./dist/index.js",
   "type": "module",
   "types": "./dist/index.d.ts",
@@ -25,8 +25,9 @@
   "dependencies": {
     "@faker-js/faker": "^9.9.0",
     "@ai-sdk/openai": "^3.0.64",
-    "@sisense/sdk-data": "^2.31.1",
-    "@sisense/sdk-rest-client": "^2.31.1",
+    "@sisense/sdk-data": "^2.32.0",
+    "@sisense/sdk-query-client": "^2.32.0",
+    "@sisense/sdk-rest-client": "^2.32.0",
     "ai": "^6.0.188",
     "deepmerge": "^4.3.1",
     "fast-deep-equal": "^3.1.3",
@@ -39,7 +40,7 @@
     "zod-to-json-schema": "^3.25.2"
   },
   "devDependencies": {
-    "@sisense/sdk-ui": "^2.31.1",
+    "@sisense/sdk-ui": "^2.32.0",
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^22.19.17",
     "@vitest/coverage-v8": "^4.1.0",
@@ -49,7 +50,7 @@
     "vitest": "~4.1.7"
   },
   "peerDependencies": {
-    "@sisense/sdk-ui": "^2.31.1"
+    "@sisense/sdk-ui": "^2.32.0"
   },
   "peerDependenciesMeta": {
     "@sisense/sdk-ui": {