@vizzly/api-client - npm Package Compare versions

Comparing version 0.0.21 to 0.0.23

dist/errors/index.d.ts

@@ -17,1 +17,8 @@ export * from './DashboardQuotaReached';
 export * from './FailedToFetchConnection';
+export * from './FailedToFetchProject';
+export * from './FailedToFetchProjects';
+export * from './FailedToFetchTeamMembers';
+export * from './FailedToCreateQueryEngineUser';
+export * from './FailedToFetchQueryEngineUser';
+export * from './ProjectEncryptedSecretAlreadySaved';
+export * from './FailedToSaveProjectEncryptedEncryptionSecret';

dist/errors/index.js

@@ -33,1 +33,8 @@ "use strict";
 __exportStar(require("./FailedToFetchConnection"), exports);
+__exportStar(require("./FailedToFetchProject"), exports);
+__exportStar(require("./FailedToFetchProjects"), exports);
+__exportStar(require("./FailedToFetchTeamMembers"), exports);
+__exportStar(require("./FailedToCreateQueryEngineUser"), exports);
+__exportStar(require("./FailedToFetchQueryEngineUser"), exports);
+__exportStar(require("./ProjectEncryptedSecretAlreadySaved"), exports);
+__exportStar(require("./FailedToSaveProjectEncryptedEncryptionSecret"), exports);

dist/models/VizzlyApi.d.ts

 import { Api } from './Api';
 import { Authentication } from './Authentication';
-import { CreateDashboardParams, CreateGlobalLibraryParams, GlobalLibrary, GlobalLibraryPermission, GlobalLibraryPermissionFromAPI, Request, RequestParams, UpdateDashboardParams, UpdateDashboardResponseBody, UpdateGlobalLibraryParams } from '../types';
+import { CreateDashboardParams, CreateGlobalLibraryParams, GlobalLibrary, GlobalLibraryPermission, GlobalLibraryPermissionFromAPI, QueryEngineUserFromAPI, Request, RequestParams, TeamMemberFromAPI, UpdateDashboardParams, UpdateDashboardResponseBody, UpdateGlobalLibraryParams } from '../types';
 import { nVizzlyApi } from '../types';
+import { ProjectFromAPI } from '../types/project';
 export declare class VizzlyApi extends Api {
@@ -45,3 +46,5 @@ constructor(auth: Authentication, host?: string);
     buildCreateGlobalLibraryRequest(params: RequestParams<CreateGlobalLibraryParams>): Request<{}>;
-    getProjects(params?: RequestParams): Promise<import("../types").Response<unknown>>;
+    getProjects(params?: RequestParams): Promise<{
+        projects: Array<ProjectFromAPI>;
+    }>;
     buildGetProjectsRequest(params?: RequestParams): Request<{}>;
@@ -52,3 +55,3 @@ createProjectApiKey(params: RequestParams<nVizzlyApi.CreateProjectApiKeyParams>): Promise<import("../types").Response<{
     buildCreateProjectApiKeyRequest(params: RequestParams<nVizzlyApi.CreateProjectApiKeyParams>): Request<{}>;
-    createQueryEngineUser(params: RequestParams<nVizzlyApi.CreateQueryEngineUserParams>): Promise<import("../types").Response<unknown>>;
+    createQueryEngineUser(params: RequestParams<nVizzlyApi.CreateQueryEngineUserParams>): Promise<QueryEngineUserFromAPI>;
     buildCreateQueryEngineUserRequest(params: RequestParams<nVizzlyApi.CreateQueryEngineUserParams>): Request<{}>;
@@ -70,3 +73,5 @@ buildCreateSelfHostedDynamicQueryEngineProjectRequest(params?: RequestParams): Request<{}>;
     buildGetManagedQueryEngineKeyPairRequest(params: RequestParams<nVizzlyApi.GetManagedQueryEngineKeyPairParams>): Request<{}>;
-    getProject(params: RequestParams<nVizzlyApi.GetProjectParams>): Promise<import("../types").Response<unknown>>;
+    getProject(params: RequestParams<nVizzlyApi.GetProjectParams>): Promise<{
+        project: ProjectFromAPI;
+    }>;
     buildGetProjectRequest(params: RequestParams<nVizzlyApi.GetProjectParams>): Request<{}>;
@@ -80,5 +85,7 @@ getProjectAccessToken(params: RequestParams<nVizzlyApi.GetProjectAccessTokenParams>): Promise<import("../types").Response<{
     buildGetProjectAccessTokenRequest(params: RequestParams<nVizzlyApi.GetProjectAccessTokenParams>): Request<{}>;
-    getQueryEngineUser(params: RequestParams<nVizzlyApi.GetQueryEngineUserParams>): Promise<import("../types").Response<unknown>>;
+    getQueryEngineUser(params: RequestParams<nVizzlyApi.GetQueryEngineUserParams>): Promise<QueryEngineUserFromAPI>;
     buildGetQueryEngineUserRequest(params: RequestParams<nVizzlyApi.GetQueryEngineUserParams>): Request<{}>;
-    getTeamMembers(params: RequestParams<nVizzlyApi.GetTeamMembers>): Promise<import("../types").Response<unknown>>;
+    getTeamMembers(params: RequestParams<nVizzlyApi.GetTeamMembers>): Promise<{
+        team_members: Array<TeamMemberFromAPI>;
+    }>;
     buildGetTeamMembersRequest(params: RequestParams<nVizzlyApi.GetTeamMembers>): Request<{}>;
@@ -91,2 +98,3 @@ getVizzlyConfig(params: RequestParams<nVizzlyApi.GetVizzlyConfigParams>): Promise<{
     buildSaveConnectionRequest(params: RequestParams<nVizzlyApi.SaveConnectionParams>): Request<{}>;
+    saveEncryptedProjectEncryptionSecret(params: RequestParams<nVizzlyApi.SaveEncryptedProjectEncryptionSecretParams>): Promise<boolean>;
     buildSaveEncryptedProjectEncryptionSecretRequest(params: RequestParams<nVizzlyApi.SaveEncryptedProjectEncryptionSecretParams>): Request<{}>;
@@ -105,4 +113,4 @@ saveScheduledReport(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Promise<import("../types").Response<unknown>>;
     buildUpdateProjectApiKeyRequest(params: RequestParams<nVizzlyApi.UpdateProjectApiKeyParams>): Request<{}>;
-    updateQueryEngineUser(params: RequestParams<nVizzlyApi.UpdateQueryEngineUserParams>): Promise<import("../types").Response<unknown>>;
+    updateQueryEngineUser(params: RequestParams<nVizzlyApi.UpdateQueryEngineUserParams>): Promise<boolean>;
     buildUpdateQueryEngineUserRequest(params: RequestParams<nVizzlyApi.UpdateQueryEngineUserParams>): Request<{}>;
 }

dist/models/VizzlyApi.js

@@ -18,2 +18,6 @@ "use strict";
 const FailedToFetchConnection_1 = require("../errors/FailedToFetchConnection");
+const FailedToFetchProject_1 = require("../errors/FailedToFetchProject");
+const FailedToUpdateQueryEngineUser_1 = require("../errors/FailedToUpdateQueryEngineUser");
+const FailedToSaveProjectEncryptedEncryptionSecret_1 = require("../errors/FailedToSaveProjectEncryptedEncryptionSecret");
+const ProjectEncryptedSecretAlreadySaved_1 = require("../errors/ProjectEncryptedSecretAlreadySaved");
 class VizzlyApi extends Api_1.Api {
@@ -144,3 +148,6 @@ constructor(auth, host = 'https://api.vizzly.co') {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.execute(this.buildGetProjectsRequest(params));
+            const response = yield this.execute(this.buildGetProjectsRequest(params));
+            if (response.status === 200)
+                return { projects: response.body.projects };
+            throw new errors_1.FailedToFetchProjects(`Failed to fetch projects. Got status ${response.status}`);
         });
@@ -173,3 +180,6 @@ }
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.execute(this.buildCreateQueryEngineUserRequest(params));
+            const response = yield this.execute(this.buildCreateQueryEngineUserRequest(params));
+            if (response.status === 200)
+                return response.body.query_engine_user;
+            throw new errors_1.FailedToCreateQueryEngineUser(`Failed to create query engine user. Got status ${response.status}`);
         });
@@ -293,3 +303,6 @@ }
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.execute(this.buildGetProjectRequest(params));
+            const getProjectResponse = yield this.execute(this.buildGetProjectRequest(params));
+            if (getProjectResponse.status === 200)
+                return getProjectResponse.body;
+            throw new FailedToFetchProject_1.FailedToFetchProject(`Failed to fetch project. Got status ${getProjectResponse.status}`);
         });
@@ -321,3 +334,6 @@ }
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.execute(this.buildGetQueryEngineUserRequest(params));
+            const response = yield this.execute(this.buildGetQueryEngineUserRequest(params));
+            if (response.status === 200)
+                return response.body.query_engine_user;
+            throw new errors_1.FailedToFetchQueryEngineUser(`Failed to fetch query engine user. Got status ${response.status}`);
         });
@@ -334,3 +350,6 @@ }
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.execute(this.buildGetTeamMembersRequest(params));
+            const response = yield this.execute(this.buildGetTeamMembersRequest(params));
+            if (response.status === 200)
+                return response.body;
+            throw new errors_1.FailedToFetchTeamMembers(`Failed to fetch team members. Got status ${response.status}`);
         });
@@ -380,2 +399,15 @@ }
     }
+    saveEncryptedProjectEncryptionSecret(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.execute(this.buildSaveEncryptedProjectEncryptionSecretRequest(params));
+            if (response.status === 200)
+                return true;
+            if (response.status == 400 && !params.allowRotation) {
+                // We're not allowing rotation, so we are trying to set the first encrypted secret, but
+                // one already exists.
+                throw new ProjectEncryptedSecretAlreadySaved_1.ProjectEncryptedSecretAlreadySaved(params.projectId);
+            }
+            throw new FailedToSaveProjectEncryptedEncryptionSecret_1.FailedToSaveProjectEncryptedEncryptionSecret(params.projectId);
+        });
+    }
     buildSaveEncryptedProjectEncryptionSecretRequest(params) {
@@ -479,3 +511,6 @@ return {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.execute(this.buildUpdateQueryEngineUserRequest(params));
+            const response = yield this.execute(this.buildUpdateQueryEngineUserRequest(params));
+            if (response.status === 200)
+                return true;
+            throw new FailedToUpdateQueryEngineUser_1.FailedToUpdateQueryEngineUser(`Failed to update query engine user. Got status ${response.status}`);
         });
@@ -482,0 +517,0 @@ }

dist/types.d.ts

@@ -6,2 +6,5 @@ import { VizzlyQueryEngineApi } from './models/VizzlyQueryEngineApi';
 export * from './types/dashboard';
+export * from './types/project';
+export * from './types/team';
+export * from './types/user';
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
@@ -8,0 +11,0 @@ export type UpdateDashboardResponseBody = {

dist/types.js

@@ -18,1 +18,4 @@ "use strict";
 __exportStar(require("./types/dashboard"), exports);
+__exportStar(require("./types/project"), exports);
+__exportStar(require("./types/team"), exports);
+__exportStar(require("./types/user"), exports);

package.json

 {
   "name": "@vizzly/api-client",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "private": false,
@@ -5,0 +5,0 @@ "license": "NONE",

No alert changes

Improved metrics

Total package byte prevSize

146809

increased by7.52%

Number of package files

98

increased by28.95%

Lines of code

3484

increased by8.37%

No dependency changes