@vizzly/api-client 0.0.71 → 0.0.73

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.
@@ -1,8 +1,8 @@
1
- import { Api } from './Api';
2
- import { Authentication } from './Authentication';
3
- import { nVizzlyQueryEngine, Request, extraHeaders, CreateDashboardParams, UpdateDashboardParams, UpdateGlobalLibraryParams, GlobalLibrary, CreateGlobalLibraryParams, GlobalLibraryPermissionFromAPI, RequestParams, DataOptimiser } from '../types';
4
1
  import { nSemanticLayer } from '@vizzly/semantic-layer-public';
5
2
  import { HighLevelSQLSchema, SQLSchema } from '@vizzly/sqlbuilder-public';
3
+ import { CreateDashboardParams, CreateGlobalLibraryParams, DataOptimiser, extraHeaders, GlobalLibrary, GlobalLibraryPermissionFromAPI, nVizzlyQueryEngine, Request, RequestParams, UpdateDashboardParams, UpdateGlobalLibraryParams } from '../types';
4
+ import { Api } from './Api';
5
+ import { Authentication } from './Authentication';
6
6
  export declare class VizzlyQueryEngineApi extends Api {
7
7
  constructor(auth: Authentication, host: string, extraHeaders?: extraHeaders);
8
8
  buildCreateDashboardRequest(params: RequestParams<CreateDashboardParams>): Request<CreateDashboardParams & {
@@ -231,4 +231,47 @@ export declare class VizzlyQueryEngineApi extends Api {
231
231
  }>;
232
232
  }>>>;
233
233
  private buildCreateSubsnapRequest;
234
+ ingestFromUpload(params: RequestParams<{
235
+ dataSourceId: string;
236
+ ingestFields: DataOptimiser.EphemeralDataSourceFields;
237
+ transformations: Array<{
238
+ columnName: string;
239
+ function: string;
240
+ }>;
241
+ previousWorkflowResults: Partial<DataOptimiser.IngestFromUploadExecuteResponse['workflowResults']>;
242
+ }>): Promise<import("../types").Response<DataOptimiser.IngestFromUploadExecuteResponse>>;
243
+ getIngestFromUploadStatus(params: RequestParams<{
244
+ dataSourceId: string;
245
+ ingestFields: DataOptimiser.EphemeralDataSourceFields;
246
+ transformations: Array<{
247
+ columnName: string;
248
+ function: string;
249
+ }>;
250
+ previousWorkflowResults: Partial<DataOptimiser.IngestFromUploadExecuteResponse['workflowResults']>;
251
+ }>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
252
+ move_table_from_upload_to_ingest: DataOptimiser.ActionStatus<{
253
+ destinationAddress: string[];
254
+ destinationFields: DataOptimiser.DataSourceFields;
255
+ }>;
256
+ }>>>;
257
+ private buildIngestFromUploadRequest;
258
+ /** Send request to create upload table */
259
+ createUploadTable(params: RequestParams<{
260
+ dataSourceId: string;
261
+ locationName: string;
262
+ folderPath: string;
263
+ fileName: string;
264
+ previousWorkflowResults: Partial<DataOptimiser.CreateUploadTableExecuteResponse['workflowResults']>;
265
+ }>): Promise<import("../types").Response<DataOptimiser.CreateUploadTableExecuteResponse>>;
266
+ /** Get the status of a create upload table call */
267
+ getCreateUploadTableStatus(params: RequestParams<{
268
+ dataSourceId: string;
269
+ locationName: string;
270
+ folderPath: string;
271
+ fileName: string;
272
+ previousWorkflowResults: Partial<DataOptimiser.CreateUploadTableExecuteResponse['workflowResults']>;
273
+ }>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
274
+ create_upload_table: DataOptimiser.ActionStatus<{}>;
275
+ }>>>;
276
+ private buildCreateUploadTableRequest;
234
277
  }
@@ -10,11 +10,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
10
10
  };
11
11
  Object.defineProperty(exports, "__esModule", { value: true });
12
12
  exports.VizzlyQueryEngineApi = void 0;
13
- const Api_1 = require("./Api");
14
- const SQLPreviewError_1 = require("../errors/SQLPreviewError");
13
+ const errors_1 = require("../errors");
15
14
  const FailedToResolveDataSets_1 = require("../errors/FailedToResolveDataSets");
16
15
  const FailedToSetupProject_1 = require("../errors/FailedToSetupProject");
17
- const errors_1 = require("../errors");
16
+ const SQLPreviewError_1 = require("../errors/SQLPreviewError");
17
+ const Api_1 = require("./Api");
18
18
  const DashboardRepository_1 = require("./DashboardRepository");
19
19
  const Path_1 = require("./Path");
20
20
  class VizzlyQueryEngineApi extends Api_1.Api {
@@ -587,5 +587,58 @@ class VizzlyQueryEngineApi extends Api_1.Api {
587
587
  acceptedAuthParams: ['queryEngineApiKey'],
588
588
  };
589
589
  }
590
+ ingestFromUpload(params) {
591
+ return __awaiter(this, void 0, void 0, function* () {
592
+ return yield this.execute(this.buildIngestFromUploadRequest(params, { statusOnly: false }));
593
+ });
594
+ }
595
+ getIngestFromUploadStatus(params) {
596
+ return __awaiter(this, void 0, void 0, function* () {
597
+ return yield this.execute(this.buildIngestFromUploadRequest(params, { statusOnly: true }));
598
+ });
599
+ }
600
+ buildIngestFromUploadRequest(params, options) {
601
+ const maybeStatusRoutePath = (options === null || options === void 0 ? void 0 : options.statusOnly) ? '/status' : '';
602
+ return {
603
+ path: Path_1.Path.buildPath(`/api/v1/data-optimiser/ingest-from-upload`, maybeStatusRoutePath),
604
+ method: 'post',
605
+ abortSignal: params.abortSignal,
606
+ body: {
607
+ dataSourceId: params.dataSourceId,
608
+ ingestFields: params.ingestFields,
609
+ transformations: params.transformations,
610
+ previousWorkflowResults: params.previousWorkflowResults,
611
+ },
612
+ acceptedAuthParams: ['queryEngineApiKey'],
613
+ };
614
+ }
615
+ /** Send request to create upload table */
616
+ createUploadTable(params) {
617
+ return __awaiter(this, void 0, void 0, function* () {
618
+ return yield this.execute(this.buildCreateUploadTableRequest(params, { statusOnly: false }));
619
+ });
620
+ }
621
+ /** Get the status of a create upload table call */
622
+ getCreateUploadTableStatus(params) {
623
+ return __awaiter(this, void 0, void 0, function* () {
624
+ return yield this.execute(this.buildCreateUploadTableRequest(params, { statusOnly: true }));
625
+ });
626
+ }
627
+ buildCreateUploadTableRequest(params, options) {
628
+ const maybeStatusRoutePath = (options === null || options === void 0 ? void 0 : options.statusOnly) ? '/status' : '';
629
+ return {
630
+ path: Path_1.Path.buildPath(`/api/v1/data-optimiser/upload`, maybeStatusRoutePath),
631
+ method: 'post',
632
+ abortSignal: params.abortSignal,
633
+ body: {
634
+ dataSourceId: params.dataSourceId,
635
+ locationName: params.locationName,
636
+ folderPath: params.folderPath,
637
+ fileName: params.fileName,
638
+ previousWorkflowResults: params.previousWorkflowResults,
639
+ },
640
+ acceptedAuthParams: ['queryEngineApiKey'],
641
+ };
642
+ }
590
643
  }
591
644
  exports.VizzlyQueryEngineApi = VizzlyQueryEngineApi;
package/dist/types.d.ts CHANGED
@@ -1,15 +1,15 @@
1
- import { VizzlyQueryEngineApi } from './models/VizzlyQueryEngineApi';
1
+ import { DataAccessConfig } from '@vizzly/auth';
2
+ import { nSemanticLayer, OriginId } from '@vizzly/semantic-layer-public';
3
+ import { DatabaseColumn, SnowflakeConnection } from '@vizzly/sqlbuilder-public';
2
4
  import { VizzlyApi } from './models/VizzlyApi';
3
5
  import { VizzlyAppApi } from './models/VizzlyAppApi';
6
+ import { VizzlyQueryEngineApi } from './models/VizzlyQueryEngineApi';
4
7
  import { DashboardDefinition, DashboardFromAPI } from './types/dashboard';
5
8
  import { UserFromAPI } from './types/user';
6
9
  export * from './types/dashboard';
7
10
  export * from './types/project';
8
11
  export * from './types/team';
9
12
  export * from './types/user';
10
- import { DataAccessConfig } from '@vizzly/auth';
11
- import { nSemanticLayer, OriginId } from '@vizzly/semantic-layer-public';
12
- import { DatabaseColumn, SnowflakeConnection } from '@vizzly/sqlbuilder-public';
13
13
  export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
14
14
  export type UpdateDashboardResponseBody = {
15
15
  dashboard: DashboardFromAPI;
@@ -593,5 +593,15 @@ export declare namespace DataOptimiser {
593
593
  snapshotFields: DataOptimiser.DataSourceFields;
594
594
  }>;
595
595
  }>;
596
+ export type IngestFromUploadExecuteResponse = DataOptimiser.ExecuteResponse<{
597
+ move_table_from_upload_to_ingest: DataOptimiser.ActionResult<{
598
+ success: boolean;
599
+ }>;
600
+ }>;
601
+ export type CreateUploadTableExecuteResponse = DataOptimiser.ExecuteResponse<{
602
+ create_upload_table: DataOptimiser.ActionResult<{
603
+ destinationAddress: string[];
604
+ }>;
605
+ }>;
596
606
  export {};
597
607
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vizzly/api-client",
3
- "version": "0.0.71",
3
+ "version": "0.0.73",
4
4
  "private": false,
5
5
  "license": "NONE",
6
6
  "source": "src/index.ts",