@vizzly/api-client 0.0.70 → 0.0.72

package/dist/models/VizzlyQueryEngineApi.d.ts

@@ -1,8 +1,8 @@
-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 { HighLevelSQLSchema, SQLSchema } from '@vizzly/sqlbuilder-public';
+import { CreateDashboardParams, CreateGlobalLibraryParams, DataOptimiser, extraHeaders, GlobalLibrary, GlobalLibraryPermissionFromAPI, nVizzlyQueryEngine, Request, RequestParams, UpdateDashboardParams, UpdateGlobalLibraryParams } from '../types';
+import { Api } from './Api';
+import { Authentication } from './Authentication';
 export declare class VizzlyQueryEngineApi extends Api {
     constructor(auth: Authentication, host: string, extraHeaders?: extraHeaders);
     buildCreateDashboardRequest(params: RequestParams<CreateDashboardParams>): Request<CreateDashboardParams & {
@@ -29,6 +29,10 @@ export declare class VizzlyQueryEngineApi extends Api {
         results: Array<nSemanticLayer.Result>;
     }>>;
     private buildCreateResultsRequest;
+    collectTreePartInstructions(params: RequestParams<nVizzlyQueryEngine.CollectTreePartInstructionsParams>): Promise<import("../types").Response<{
+        treeParts: DataOptimiser.TreePartInstruction[];
+    }>>;
+    private buildCollectTreePartInstructionsRequest;
     collectTableSchema(params: RequestParams<nVizzlyQueryEngine.CollectTableSchemaParams>): Promise<import("../types").Response<{
         tableSchemaByConnection: {
             [connectionId: string]: {
@@ -227,4 +231,45 @@ export declare class VizzlyQueryEngineApi extends Api {
         }>;
     }>>>;
     private buildCreateSubsnapRequest;
+    ingestFromUpload(params: RequestParams<{
+        dataSourceId: string;
+        ingestFields: DataOptimiser.EphemeralDataSourceFields;
+        transformations: Array<{
+            columnName: string;
+            function: string;
+        }>;
+        previousWorkflowResults: Partial<DataOptimiser.IngestFromUploadExecuteResponse['workflowResults']>;
+    }>): Promise<import("../types").Response<DataOptimiser.IngestFromUploadExecuteResponse>>;
+    getIngestFromUploadStatus(params: RequestParams<{
+        dataSourceId: string;
+        ingestFields: DataOptimiser.EphemeralDataSourceFields;
+        transformations: Array<{
+            columnName: string;
+            function: string;
+        }>;
+        previousWorkflowResults: Partial<DataOptimiser.IngestFromUploadExecuteResponse['workflowResults']>;
+    }>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{}>>>;
+    private buildIngestFromUploadRequest;
+    /** Send request to create upload table */
+    createUploadTable(params: RequestParams<{
+        dataSourceId: string;
+        locationName: string;
+        folderPath: string;
+        fileName: string;
+        previousWorkflowResults: Partial<DataOptimiser.CreateUploadTableExecuteResponse['workflowResults']>;
+    }>): Promise<import("../types").Response<DataOptimiser.CreateUploadTableExecuteResponse>>;
+    /** Get the status of a create upload table call */
+    getCreateUploadTableStatus(params: RequestParams<{
+        dataSourceId: string;
+        locationName: string;
+        folderPath: string;
+        fileName: string;
+        previousWorkflowResults: Partial<DataOptimiser.CreateUploadTableExecuteResponse['workflowResults']>;
+    }>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
+        create_upload_table: DataOptimiser.ActionStatus<{
+            destinationAddress: string[];
+            destinationFields: DataOptimiser.DataSourceFields;
+        }>;
+    }>>>;
+    private buildCreateUploadTableRequest;
 }

package/dist/models/VizzlyQueryEngineApi.js

@@ -10,11 +10,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VizzlyQueryEngineApi = void 0;
-const Api_1 = require("./Api");
-const SQLPreviewError_1 = require("../errors/SQLPreviewError");
+const errors_1 = require("../errors");
 const FailedToResolveDataSets_1 = require("../errors/FailedToResolveDataSets");
 const FailedToSetupProject_1 = require("../errors/FailedToSetupProject");
-const errors_1 = require("../errors");
+const SQLPreviewError_1 = require("../errors/SQLPreviewError");
+const Api_1 = require("./Api");
 const DashboardRepository_1 = require("./DashboardRepository");
 const Path_1 = require("./Path");
 class VizzlyQueryEngineApi extends Api_1.Api {
@@ -110,6 +110,23 @@ class VizzlyQueryEngineApi extends Api_1.Api {
             acceptedAuthParams: ['queryEngineApiKey', 'dashboardAccessToken'],
         };
     }
+    collectTreePartInstructions(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildCollectTreePartInstructionsRequest(params));
+        });
+    }
+    buildCollectTreePartInstructionsRequest(params) {
+        return {
+            path: `/api/v1/data-optimiser/tree-part-instructions`,
+            method: 'post',
+            abortSignal: params.abortSignal,
+            body: {
+                company: { id: params.companyId },
+                treeTableAddress: params.treeTableAddress,
+            },
+            acceptedAuthParams: ['queryEngineApiKey'],
+        };
+    }
     collectTableSchema(params) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.execute(this.buildCollectTableSchemaRequest(params));
@@ -122,7 +139,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
             abortSignal: params.abortSignal,
             body: {
                 allowedConfigOrigins: params.allowedConfigOrigins,
-                dynamicConfig: params.dynamicConfig
+                dynamicConfig: params.dynamicConfig,
             },
             acceptedAuthParams: ['queryEngineApiKey'],
         };
@@ -140,7 +157,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
             body: {
                 allowedConfigOrigins: params.allowedConfigOrigins,
                 dynamicConfig: params.dynamicConfig,
-                filterColumnsByTable: params.filterColumnsByTable
+                filterColumnsByTable: params.filterColumnsByTable,
             },
             acceptedAuthParams: ['queryEngineApiKey'],
         };
@@ -507,7 +524,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
                 internalCompanyConnection: params.internalCompanyConnection,
                 externalSnowflakeConnection: params.externalSnowflakeConnection,
                 transformations: params.transformations,
-                previousWorkflowResults: params.previousWorkflowResults
+                previousWorkflowResults: params.previousWorkflowResults,
             },
             acceptedAuthParams: ['queryEngineApiKey'],
         };
@@ -538,7 +555,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
                 cascadingInstructions: params.cascadingInstructions,
                 primaryDateFieldId: params.primaryDateFieldId,
                 internalCompanyConnection: params.internalCompanyConnection,
-                previousWorkflowResults: params.previousWorkflowResults
+                previousWorkflowResults: params.previousWorkflowResults,
             },
             acceptedAuthParams: ['queryEngineApiKey'],
         };
@@ -565,7 +582,60 @@ class VizzlyQueryEngineApi extends Api_1.Api {
                 snapshotDataSourceId: params.snapshotDataSourceId,
                 subsnapDataSourceId: params.subsnapDataSourceId,
                 snapshotFields: params.snapshotFields,
-                internalCompanyConnection: params.internalCompanyConnection
+                internalCompanyConnection: params.internalCompanyConnection,
+            },
+            acceptedAuthParams: ['queryEngineApiKey'],
+        };
+    }
+    ingestFromUpload(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildIngestFromUploadRequest(params, { statusOnly: false }));
+        });
+    }
+    getIngestFromUploadStatus(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildIngestFromUploadRequest(params, { statusOnly: true }));
+        });
+    }
+    buildIngestFromUploadRequest(params, options) {
+        const maybeStatusRoutePath = (options === null || options === void 0 ? void 0 : options.statusOnly) ? '/status' : '';
+        return {
+            path: Path_1.Path.buildPath(`/api/v1/data-optimiser/ingest-from-upload`, maybeStatusRoutePath),
+            method: 'post',
+            abortSignal: params.abortSignal,
+            body: {
+                dataSourceId: params.dataSourceId,
+                ingestFields: params.ingestFields,
+                transformations: params.transformations,
+                previousWorkflowResults: params.previousWorkflowResults,
+            },
+            acceptedAuthParams: ['queryEngineApiKey'],
+        };
+    }
+    /** Send request to create upload table */
+    createUploadTable(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildCreateUploadTableRequest(params, { statusOnly: false }));
+        });
+    }
+    /** Get the status of a create upload table call */
+    getCreateUploadTableStatus(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildCreateUploadTableRequest(params, { statusOnly: true }));
+        });
+    }
+    buildCreateUploadTableRequest(params, options) {
+        const maybeStatusRoutePath = (options === null || options === void 0 ? void 0 : options.statusOnly) ? '/status' : '';
+        return {
+            path: Path_1.Path.buildPath(`/api/v1/data-optimiser/upload`, maybeStatusRoutePath),
+            method: 'post',
+            abortSignal: params.abortSignal,
+            body: {
+                dataSourceId: params.dataSourceId,
+                locationName: params.locationName,
+                folderPath: params.folderPath,
+                fileName: params.fileName,
+                previousWorkflowResults: params.previousWorkflowResults,
             },
             acceptedAuthParams: ['queryEngineApiKey'],
         };

package/dist/types.d.ts

@@ -1,15 +1,15 @@
-import { VizzlyQueryEngineApi } from './models/VizzlyQueryEngineApi';
+import { DataAccessConfig } from '@vizzly/auth';
+import { nSemanticLayer, OriginId } from '@vizzly/semantic-layer-public';
+import { DatabaseColumn, SnowflakeConnection } from '@vizzly/sqlbuilder-public';
 import { VizzlyApi } from './models/VizzlyApi';
 import { VizzlyAppApi } from './models/VizzlyAppApi';
+import { VizzlyQueryEngineApi } from './models/VizzlyQueryEngineApi';
 import { DashboardDefinition, DashboardFromAPI } from './types/dashboard';
 import { UserFromAPI } from './types/user';
 export * from './types/dashboard';
 export * from './types/project';
 export * from './types/team';
 export * from './types/user';
-import { DataAccessConfig } from '@vizzly/auth';
-import { nSemanticLayer, OriginId } from '@vizzly/semantic-layer-public';
-import { SnowflakeConnection } from '@vizzly/sqlbuilder-public';
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 export type UpdateDashboardResponseBody = {
     dashboard: DashboardFromAPI;
@@ -113,6 +113,10 @@ export declare namespace nVizzlyQueryEngine {
         dynamicConfig?: nSemanticLayer.Config;
         secureFilters?: DataAccessConfig['secureFilters'];
     };
+    type CollectTreePartInstructionsParams = {
+        companyId: string;
+        treeTableAddress: [string, string, string];
+    };
     type CollectTableSchemaParams = {
         allowedConfigOrigins: OriginId[];
         dynamicConfig?: nSemanticLayer.Config;
@@ -474,14 +478,40 @@ export type GlobalLibraryPermissionFromAPI = {
     scope: 'read' | 'read_write';
 };
 export declare namespace DataOptimiser {
-    type DataSourceFields = Array<{
+    type RenameColumnInstruction = {
+        type: 'rename_column';
+        columnToRename: DatabaseColumn;
+        newColumnName: string;
+    };
+    type RemoveColumnInstruction = {
+        type: 'remove_column';
+        columnToRemove: DatabaseColumn;
+    };
+    type KeepColumnWithoutChangesInstruction = {
+        type: 'keep_column_without_changes';
+        column: DatabaseColumn;
+    };
+    export type ColumnInstruction = RenameColumnInstruction | RemoveColumnInstruction | KeepColumnWithoutChangesInstruction;
+    export type TreePartInstruction = {
+        type: 'branch' | 'trunk';
+        columnInstructions: Array<ColumnInstruction>;
+        filter: Array<{
+            columnName: string;
+            value: any;
+        }>;
+        uniqueDimensionValues: {
+            brands: string[];
+            mediaChannels: string[];
+        };
+    };
+    export type DataSourceFields = Array<{
         id: string;
         address: string[];
         data_type: string;
         normalized_data_type: 'string' | 'number' | 'date_time' | 'boolean';
     }>;
-    type EphemeralDataSourceFields = Array<Omit<DataSourceFields[number], 'id'>>;
-    type DimensionFieldsMapping = Array<{
+    export type EphemeralDataSourceFields = Array<Omit<DataSourceFields[number], 'id'>>;
+    export type DimensionFieldsMapping = Array<{
         field_id: string;
         gti_dimension_key: 'brands' | 'regions' | 'media_channels';
         dimension_values_mappings: Array<{
@@ -502,22 +532,22 @@ export declare namespace DataOptimiser {
      * snapshot in the same request  without doing any logic, and the data
      * optimiser will pick what it needs.
      */
-    type CascadingInstructions = Array<{
+    export type CascadingInstructions = Array<{
         datasourceDimensionFieldMapping: DimensionFieldsMapping;
         dataStartDate: string | null;
         dataEndDate: string | null;
     }>;
-    type ActionResultStatus = 'success' | 'failure' | 'no_action_taken' | 'started_in_background';
-    type ActionStatus<PlannedOutcome> = {
+    export type ActionResultStatus = 'success' | 'failure' | 'no_action_taken' | 'started_in_background';
+    export type ActionStatus<PlannedOutcome> = {
         name: string;
         status: ActionResultStatus;
         plannedOutcome: PlannedOutcome;
     };
-    type ActionResult<Content> = {
+    export type ActionResult<Content> = {
         status: ActionResultStatus;
         content: Content;
     };
-    type StatusResponse<Status extends {
+    export type StatusResponse<Status extends {
         [actionId: string]: {
             name: string;
             status: ActionResultStatus;
@@ -532,7 +562,7 @@ export declare namespace DataOptimiser {
         };
         status: Status;
     };
-    type ExecuteResponse<WorkflowResult extends {
+    export type ExecuteResponse<WorkflowResult extends {
         [actionId: string]: {
             status: ActionResultStatus;
             content: any;
@@ -540,11 +570,11 @@ export declare namespace DataOptimiser {
     }> = {
         workflowResults: WorkflowResult;
     };
-    type QueryEngineConnection = {
+    export type QueryEngineConnection = {
         encryptedCredentials: string;
         unencryptedCredentials?: Partial<SnowflakeConnection>;
     };
-    type IngestExecuteResponse = ExecuteResponse<{
+    export type IngestExecuteResponse = ExecuteResponse<{
         setup_export_data_integration: DataOptimiser.ActionResult<{}>;
         ingest_to_storage: DataOptimiser.ActionResult<{
             toBucket: string;
@@ -557,10 +587,21 @@ export declare namespace DataOptimiser {
             executedInSnowflakeSessionId: string;
         }>;
     }>;
-    type CreateSnapshotExecuteResponse = DataOptimiser.ExecuteResponse<{
+    export type CreateSnapshotExecuteResponse = DataOptimiser.ExecuteResponse<{
         create_snapshot: DataOptimiser.ActionResult<{
             executedInSnowflakeSessionId: string;
             snapshotFields: DataOptimiser.DataSourceFields;
         }>;
     }>;
+    export type IngestFromUploadExecuteResponse = DataOptimiser.ExecuteResponse<{
+        ingest_from_upload: DataOptimiser.ActionResult<{
+            success: boolean;
+        }>;
+    }>;
+    export type CreateUploadTableExecuteResponse = DataOptimiser.ExecuteResponse<{
+        create_upload_table: DataOptimiser.ActionResult<{
+            destinationAddress: string[];
+        }>;
+    }>;
+    export {};
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vizzly/api-client",
-  "version": "0.0.70",
+  "version": "0.0.72",
   "private": false,
   "license": "NONE",
   "source": "src/index.ts",