@vizzly/api-client 0.0.68 → 0.0.70

package/dist/models/VizzlyQueryEngineApi.d.ts

@@ -2,7 +2,7 @@ import { Api } from './Api';
 import { Authentication } from './Authentication';
 import { nVizzlyQueryEngine, Request, extraHeaders, CreateDashboardParams, UpdateDashboardParams, UpdateGlobalLibraryParams, GlobalLibrary, CreateGlobalLibraryParams, GlobalLibraryPermissionFromAPI, RequestParams, DataOptimiser } from '../types';
 import { nSemanticLayer } from '@vizzly/semantic-layer-public';
-import { SQLSchema } from '@vizzly/sqlbuilder-public';
+import { HighLevelSQLSchema, SQLSchema } from '@vizzly/sqlbuilder-public';
 export declare class VizzlyQueryEngineApi extends Api {
     constructor(auth: Authentication, host: string, extraHeaders?: extraHeaders);
     buildCreateDashboardRequest(params: RequestParams<CreateDashboardParams>): Request<CreateDashboardParams & {
@@ -29,6 +29,15 @@ export declare class VizzlyQueryEngineApi extends Api {
         results: Array<nSemanticLayer.Result>;
     }>>;
     private buildCreateResultsRequest;
+    collectTableSchema(params: RequestParams<nVizzlyQueryEngine.CollectTableSchemaParams>): Promise<import("../types").Response<{
+        tableSchemaByConnection: {
+            [connectionId: string]: {
+                /** ID of the connection */
+                id: string;
+            } & HighLevelSQLSchema;
+        };
+    }>>;
+    private buildCollectTableSchemaRequest;
     collectSchema(params: RequestParams<nVizzlyQueryEngine.CollectSchemaParams>): Promise<import("../types").Response<{
         schemaByConnection: {
             [connectionId: string]: {

package/dist/models/VizzlyQueryEngineApi.js

@@ -110,6 +110,23 @@ class VizzlyQueryEngineApi extends Api_1.Api {
             acceptedAuthParams: ['queryEngineApiKey', 'dashboardAccessToken'],
         };
     }
+    collectTableSchema(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildCollectTableSchemaRequest(params));
+        });
+    }
+    buildCollectTableSchemaRequest(params) {
+        return {
+            path: `/api/v1/schema/tables`,
+            method: 'post',
+            abortSignal: params.abortSignal,
+            body: {
+                allowedConfigOrigins: params.allowedConfigOrigins,
+                dynamicConfig: params.dynamicConfig
+            },
+            acceptedAuthParams: ['queryEngineApiKey'],
+        };
+    }
     collectSchema(params) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.execute(this.buildCollectSchemaRequest(params));
@@ -123,6 +140,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
             body: {
                 allowedConfigOrigins: params.allowedConfigOrigins,
                 dynamicConfig: params.dynamicConfig,
+                filterColumnsByTable: params.filterColumnsByTable
             },
             acceptedAuthParams: ['queryEngineApiKey'],
         };

package/dist/types.d.ts

@@ -113,9 +113,14 @@ export declare namespace nVizzlyQueryEngine {
         dynamicConfig?: nSemanticLayer.Config;
         secureFilters?: DataAccessConfig['secureFilters'];
     };
+    type CollectTableSchemaParams = {
+        allowedConfigOrigins: OriginId[];
+        dynamicConfig?: nSemanticLayer.Config;
+    };
     type CollectSchemaParams = {
         allowedConfigOrigins: OriginId[];
         dynamicConfig?: nSemanticLayer.Config;
+        filterColumnsByTable?: [databaseName: string, schemaName: string, tableName: string];
     };
     type CreateSqlPreviewParams = {
         sql: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vizzly/api-client",
-  "version": "0.0.68",
+  "version": "0.0.70",
   "private": false,
   "license": "NONE",
   "source": "src/index.ts",
@@ -34,7 +34,7 @@
   },
   "dependencies": {
     "@vizzly/semantic-layer-public": ">=0.0.231",
-    "@vizzly/sqlbuilder-public": ">=0.1.41",
+    "@vizzly/sqlbuilder-public": ">=0.1.62",
     "cross-fetch": "^4.0.0"
   }
 }