@sisense/sdk-ai-core 0.2.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/README.md +51 -0
  2. package/dist/constants.d.ts +9 -0
  3. package/dist/constants.d.ts.map +1 -0
  4. package/dist/engines/chart-builder/chart-builder-engine.d.ts +14 -0
  5. package/dist/engines/chart-builder/chart-builder-engine.d.ts.map +1 -0
  6. package/dist/engines/chart-builder/chart-builder-service.d.ts +7 -0
  7. package/dist/engines/chart-builder/chart-builder-service.d.ts.map +1 -0
  8. package/dist/engines/chart-builder/create-chart/create-chart.d.ts +14 -0
  9. package/dist/engines/chart-builder/create-chart/create-chart.d.ts.map +1 -0
  10. package/dist/engines/chart-builder/create-chart/generate-chart-recommendations.d.ts +5 -0
  11. package/dist/engines/chart-builder/create-chart/generate-chart-recommendations.d.ts.map +1 -0
  12. package/dist/engines/chart-builder/create-chart/generate-chart-table.d.ts +3 -0
  13. package/dist/engines/chart-builder/create-chart/generate-chart-table.d.ts.map +1 -0
  14. package/dist/engines/chart-builder/types.d.ts +612 -0
  15. package/dist/engines/chart-builder/types.d.ts.map +1 -0
  16. package/dist/engines/chart-builder/update-chart/chart-options-schemas.d.ts +8629 -0
  17. package/dist/engines/chart-builder/update-chart/chart-options-schemas.d.ts.map +1 -0
  18. package/dist/engines/chart-builder/update-chart/schemas.d.ts +1136 -0
  19. package/dist/engines/chart-builder/update-chart/schemas.d.ts.map +1 -0
  20. package/dist/engines/chart-builder/update-chart/update-chart-data-options.d.ts +18 -0
  21. package/dist/engines/chart-builder/update-chart/update-chart-data-options.d.ts.map +1 -0
  22. package/dist/engines/chart-builder/update-chart/update-chart-style-options.d.ts +18 -0
  23. package/dist/engines/chart-builder/update-chart/update-chart-style-options.d.ts.map +1 -0
  24. package/dist/engines/chart-builder/update-chart/update-chart-title.d.ts +12 -0
  25. package/dist/engines/chart-builder/update-chart/update-chart-title.d.ts.map +1 -0
  26. package/dist/engines/chart-builder/update-chart/update-chart-type.d.ts +14 -0
  27. package/dist/engines/chart-builder/update-chart/update-chart-type.d.ts.map +1 -0
  28. package/dist/engines/index.d.ts +6 -0
  29. package/dist/engines/index.d.ts.map +1 -0
  30. package/dist/index.d.ts +18 -0
  31. package/dist/index.d.ts.map +1 -0
  32. package/dist/index.js +5035 -0
  33. package/dist/index.js.map +1 -0
  34. package/dist/services/dashboards/dashboards-service.d.ts +47 -0
  35. package/dist/services/dashboards/dashboards-service.d.ts.map +1 -0
  36. package/dist/services/dashboards/fusion-dashboards-service.d.ts +71 -0
  37. package/dist/services/dashboards/fusion-dashboards-service.d.ts.map +1 -0
  38. package/dist/services/data-models/data-models-service.d.ts +6 -0
  39. package/dist/services/data-models/data-models-service.d.ts.map +1 -0
  40. package/dist/services/data-models/ecm-service.d.ts +497 -0
  41. package/dist/services/data-models/ecm-service.d.ts.map +1 -0
  42. package/dist/services/data-sources/data-sources-service.d.ts +41 -0
  43. package/dist/services/data-sources/data-sources-service.d.ts.map +1 -0
  44. package/dist/services/globals/globals-service.d.ts +2 -0
  45. package/dist/services/globals/globals-service.d.ts.map +1 -0
  46. package/dist/services/llm/llm-settings-service.d.ts +18 -0
  47. package/dist/services/llm/llm-settings-service.d.ts.map +1 -0
  48. package/dist/services/nlq/nlq-service.d.ts +33 -0
  49. package/dist/services/nlq/nlq-service.d.ts.map +1 -0
  50. package/dist/singleton-clients.d.ts +48 -0
  51. package/dist/singleton-clients.d.ts.map +1 -0
  52. package/dist/utils/chat-completion-utils.d.ts +55 -0
  53. package/dist/utils/chat-completion-utils.d.ts.map +1 -0
  54. package/dist/utils/http-client.d.ts +33 -0
  55. package/dist/utils/http-client.d.ts.map +1 -0
  56. package/dist/utils/id-utils.d.ts +9 -0
  57. package/dist/utils/id-utils.d.ts.map +1 -0
  58. package/dist/utils/openai-client.d.ts +11 -0
  59. package/dist/utils/openai-client.d.ts.map +1 -0
  60. package/dist/utils/proxy-utils.d.ts +5 -0
  61. package/dist/utils/proxy-utils.d.ts.map +1 -0
  62. package/dist/utils/utils.d.ts +12 -0
  63. package/dist/utils/utils.d.ts.map +1 -0
  64. package/dist/utils/zod-utils.d.ts +60 -0
  65. package/dist/utils/zod-utils.d.ts.map +1 -0
  66. package/package.json +62 -0
package/README.md ADDED
@@ -0,0 +1,51 @@
1
+ # @sisense/sdk-ai-core
2
+
3
+ Core AI functionality for Sisense SDK, providing both AI engines (business logic) and browser-based services (APIs).
4
+
5
+ ## Overview
6
+
7
+ This library consolidates AI-related functionality into a single, well-organized package with three main components:
8
+
9
+ - **Engines** (`src/engines/`) - Pure business logic for AI-powered features like chart building
10
+ - **Services** (`src/services/`) - Browser-based API clients and service implementations
11
+ - **Utils** (`src/utils/`) - Shared utilities used across engines and services
12
+
13
+ ## Architecture
14
+
15
+ ```
16
+ src/
17
+ engines/ # Business logic
18
+ chart-builder/ # Chart builder engine
19
+ services/ # Browser APIs
20
+ data-sources/ # Data source services
21
+ data-models/ # Data model services
22
+ dashboards/ # Dashboard services
23
+ utils/ # Shared utilities
24
+ ```
25
+
26
+ ## Usage
27
+
28
+ ```typescript
29
+ import { buildChartEngine, getNlqResultLight, httpClient } from '@sisense/sdk-ai-core';
30
+ ```
31
+
32
+ ## Dependencies
33
+
34
+ - `@sisense/sdk-data` - Data modeling and query building
35
+ - `@sisense/sdk-rest-client` - HTTP client for Sisense API
36
+ - `@sisense/sdk-ui` - UI components and chart types
37
+ - `openai` - OpenAI API client
38
+ - `zod` - Schema validation
39
+
40
+ ## Development
41
+
42
+ ```bash
43
+ # Build the library
44
+ pnpm build
45
+
46
+ # Run tests
47
+ pnpm test
48
+
49
+ # Watch mode
50
+ pnpm test:watch
51
+ ```
@@ -0,0 +1,9 @@
1
+ export declare const TOOL_NAME_CHART_BUILDER = "buildChart";
2
+ export declare const TOOL_NAME_DASHBOARD_BUILDER = "buildDashboard";
3
+ export declare const TOOL_NAME_DATA_MODEL_BUILDER = "buildDataModel";
4
+ export declare const TOOL_NAME_RECOMMEND_QUERIES = "recommendQueries";
5
+ export declare const TOOL_NAME_GET_DASHBOARDS = "getDashboards";
6
+ export declare const TOOL_NAME_GET_DATA_SOURCES = "getDataSources";
7
+ export declare const TOOL_NAME_GET_DATA_SOURCE_FIELDS = "getDataSourceFields";
8
+ export declare const TOOL_CONTEXT_MAX_ASSETS = 10;
9
+ //# sourceMappingURL=constants.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,uBAAuB,eAAe,CAAC;AACpD,eAAO,MAAM,2BAA2B,mBAAmB,CAAC;AAC5D,eAAO,MAAM,4BAA4B,mBAAmB,CAAC;AAC7D,eAAO,MAAM,2BAA2B,qBAAqB,CAAC;AAC9D,eAAO,MAAM,wBAAwB,kBAAkB,CAAC;AACxD,eAAO,MAAM,0BAA0B,mBAAmB,CAAC;AAC3D,eAAO,MAAM,gCAAgC,wBAAwB,CAAC;AAGtE,eAAO,MAAM,uBAAuB,KAAK,CAAC"}
@@ -0,0 +1,14 @@
1
+ import { ChartSummary, BuildChartContext, buildChartSchema } from './types';
2
+ import { default as z } from 'zod';
3
+ /**
4
+ * Build contextual system prompt for chart builder
5
+ */
6
+ export declare function buildContextualSystemPrompt(chartSummaries: ChartSummary[]): string;
7
+ /**
8
+ * Standalone chart builder engine - completely decoupled from any UI or store
9
+ * @param params - The parameters for the chart builder
10
+ * @param context - All external dependencies injected
11
+ * @returns The chart summary
12
+ */
13
+ export declare function buildChartEngine(params: z.infer<typeof buildChartSchema>, context: BuildChartContext): Promise<ChartSummary>;
14
+ //# sourceMappingURL=chart-builder-engine.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"chart-builder-engine.d.ts","sourceRoot":"","sources":["../../../src/engines/chart-builder/chart-builder-engine.ts"],"names":[],"mappings":"AAMA,OAAO,EACN,YAAY,EAUZ,iBAAiB,EACjB,gBAAgB,EAChB,MAAM,SAAS,CAAC;AAYjB,OAAO,CAAC,MAAM,KAAK,CAAC;AAgLpB;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,cAAc,EAAE,YAAY,EAAE,UA4BzE;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CACrC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,EACxC,OAAO,EAAE,iBAAiB,GACxB,OAAO,CAAC,YAAY,CAAC,CAyEvB"}
@@ -0,0 +1,7 @@
1
+ import { ExtendedChartWidgetProps, BaseChartSummary } from './types';
2
+ /**
3
+ * Get a base chart summary from chart props
4
+ * Pure function with no store dependencies
5
+ */
6
+ export declare const getBaseChartSummary: (widgetProps: ExtendedChartWidgetProps, dataSourceTitle: string) => BaseChartSummary;
7
+ //# sourceMappingURL=chart-builder-service.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"chart-builder-service.d.ts","sourceRoot":"","sources":["../../../src/engines/chart-builder/chart-builder-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAErE;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAC/B,aAAa,wBAAwB,EACrC,iBAAiB,MAAM,KACrB,gBASF,CAAC"}
@@ -0,0 +1,14 @@
1
+ import { BuildChartContext, createChartSchema, ExtendedChartWidgetProps, NullableChartType } from '../types';
2
+ import { default as z } from 'zod';
3
+ type GenerateChartParams = {
4
+ dataSourceTitle: string;
5
+ userPrompt: string;
6
+ chartType: NullableChartType;
7
+ chartTitle: string;
8
+ };
9
+ export declare const generateChart: ({ dataSourceTitle, userPrompt, chartType, chartTitle }: GenerateChartParams, context: BuildChartContext) => Promise<ExtendedChartWidgetProps>;
10
+ export declare const createChart: ({ userPrompt, chartType, chartTitle }: z.infer<typeof createChartSchema>, context: BuildChartContext) => Promise<{
11
+ message: string;
12
+ }>;
13
+ export {};
14
+ //# sourceMappingURL=create-chart.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"create-chart.d.ts","sourceRoot":"","sources":["../../../../src/engines/chart-builder/create-chart/create-chart.ts"],"names":[],"mappings":"AAKA,OAAO,EACN,iBAAiB,EACjB,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,EACjB,MAAM,UAAU,CAAC;AAKlB,OAAO,CAAC,MAAM,KAAK,CAAC;AAEpB,KAAK,mBAAmB,GAAG;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,iBAAiB,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,eAAO,MAAM,aAAa,GACzB,wDAAwD,mBAAmB,EAC3E,SAAS,iBAAiB,KACxB,OAAO,CAAC,wBAAwB,CA4ClC,CAAC;AAEF,eAAO,MAAM,WAAW,GACvB,uCAAuC,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,EACxE,SAAS,iBAAiB;;EAyB1B,CAAC"}
@@ -0,0 +1,5 @@
1
+ import { z } from 'zod';
2
+ import { ChartType } from '@sisense/sdk-ui';
3
+ import { chartRecommendationsSchema, ColumnType } from '../types';
4
+ export declare const generateChartRecommendations: (userPrompt: string, columns: ColumnType[] | undefined, chartType: ChartType | undefined) => Promise<z.infer<typeof chartRecommendationsSchema>>;
5
+ //# sourceMappingURL=generate-chart-recommendations.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generate-chart-recommendations.d.ts","sourceRoot":"","sources":["../../../../src/engines/chart-builder/create-chart/generate-chart-recommendations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,0BAA0B,EAAU,UAAU,EAAE,MAAM,UAAU,CAAC;AAgF1E,eAAO,MAAM,4BAA4B,GACxC,YAAY,MAAM,EAClB,SAAS,UAAU,EAAE,YAAK,EAC1B,WAAW,SAAS,GAAG,SAAS,KAC9B,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CA+DpD,CAAC"}
@@ -0,0 +1,3 @@
1
+ import { ExtendedChartWidgetProps } from '../types';
2
+ export declare const generateChartTable: (dataSourceTitle: string, userPrompt: string, isNlqV3Enabled?: boolean) => Promise<ExtendedChartWidgetProps>;
3
+ //# sourceMappingURL=generate-chart-table.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generate-chart-table.d.ts","sourceRoot":"","sources":["../../../../src/engines/chart-builder/create-chart/generate-chart-table.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AA4GpD,eAAO,MAAM,kBAAkB,GAC9B,iBAAiB,MAAM,EACvB,YAAY,MAAM,EAClB,iBAAiB,OAAO,sCASxB,CAAC"}