reveal-sdk-node-ai 1.2.0 → 1.2.2-rc.1

package/index.d.ts

@@ -192,7 +192,8 @@ export interface MetadataManagerCallbacks {
     getDatasourceList?: (userContext: any) => Promise<any[]>;
     getMetadata?: (userContext: any, datasourceId: string, datasourceItemId: string | null, database: string, tables: string[], currentModel?: string | null) => Promise<any>;
     getMetadataIndex?: (userContext: any, datasourceId: string, datasourceItemId?: string | null) => Promise<any>;
-    getTableSummaries?: (userContext: any, datasourceId: string, datasourceItemId: string | null, database: string, currentModel?: string | null) => Promise<Array<{ name: string; description?: string | null }>>;
+    /** `alias` (optional) is the friendly table name the AI is shown instead of `name`. */
+    getTableSummaries?: (userContext: any, datasourceId: string, datasourceItemId: string | null, database: string, currentModel?: string | null) => Promise<Array<{ name: string; alias?: string | null; description?: string | null }>>;
     deleteMetadata?: (userContext: any, datasourceId: string, datasourceItemId?: string | null) => Promise<void>;
     getProgress?: (userContext: any, datasourceId: string, datasourceItemId?: string | null) => Promise<any>;
     hasMetadata?: (userContext: any, datasourceId: string, datasourceItemId?: string | null) => Promise<boolean>;
@@ -207,16 +208,60 @@ export interface MetadataManagerCallbacks {
     rankDatasourcesForPrompt?: (userContext: any, userPrompt: string, maxResults?: number) => Promise<any>;
 }
 
+/**
+ * One field (column) definition in the metadata catalog. Mirrors the C# `FieldSchema`.
+ * `Alias` is shown to the AI INSTEAD of `Name`; `expression` / `expressionType` / `dataType`
+ * define a virtual (calculated) field.
+ */
+export interface FieldSchemaJson {
+    Name: string;
+    Alias?: string | null;
+    Description?: string | null;
+    expression?: string | null;
+    expressionType?: 'CalculatedField' | 'PostCalculatedField';
+    dataType?: string | null;
+}
+
+/**
+ * One table (or cube) definition in the metadata catalog. Mirrors the C# `TableSchema`.
+ * `Alias` is the friendly name the AI is shown instead of `Name` (the SDK maps the AI's
+ * answer back to the real name).
+ */
+export interface TableSchemaJson {
+    Name: string;
+    Alias?: string | null;
+    Description?: string | null;
+    Fields?: FieldSchemaJson[] | null;
+}
+
+/**
+ * One database (or XMLA catalog) definition in the metadata catalog. Mirrors the C#
+ * `DatabaseSchema`. `Name` accepts a single name or an array of names sharing the same
+ * configuration; `Alias` / `Description` then apply to each of them. `DiscoveryMode`
+ * 'Restricted' exposes only the listed tables.
+ */
+export interface DatabaseSchemaJson {
+    Name: string | string[];
+    Alias?: string | null;
+    Description?: string | null;
+    DiscoveryMode?: 'Default' | 'Restricted';
+    Tables?: TableSchemaJson[] | null;
+}
+
 /**
  * One datasource definition in the metadata catalog. Property names match the C#
  * `DatasourceSchema` (PascalCase); `Provider` is a Reveal provider enum name (e.g.
- * 'SQLServer', 'PostgreSQL', 'MySQL', 'REST').
+ * 'SQLServer', 'PostgreSQL', 'MySQL', 'REST'). `Alias` is the friendly name the AI is
+ * shown instead of `Id` in ranking / selection prompts (useful when ids are opaque);
+ * `Description` is printed next to it.
  */
 export interface DatasourceSchemaJson {
     Id: string;
     ItemId?: string | null;
     Provider: string;
-    Databases?: any[] | null;
+    Alias?: string | null;
+    Description?: string | null;
+    Databases?: DatabaseSchemaJson[] | null;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reveal-sdk-node-ai",
-  "version": "1.2.0",
+  "version": "1.2.2-rc.1",
   "description": "Reveal SDK AI plugin for Node.js — adds AI capabilities to Reveal BI dashboards",
   "main": "index.js",
   "types": "index.d.ts",
@@ -23,6 +23,6 @@
     "node": ">=16.0.0"
   },
   "dependencies": {
-    "reveal-sdk-node": ">=2.2.0"
+    "reveal-sdk-node": ">=2.2.1"
   }
 }