@vizzly/api-client 0.0.13 → 0.0.15

package/dist/errors/ConnectionDoesNotExistOnProject.d.ts

@@ -0,0 +1,3 @@
+export declare class ConnectionDoesNotExistOnProject extends Error {
+    constructor(message: string);
+}

package/dist/errors/ConnectionDoesNotExistOnProject.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionDoesNotExistOnProject = void 0;
+class ConnectionDoesNotExistOnProject extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'ConnectionDoesNotExistOnProject';
+    }
+}
+exports.ConnectionDoesNotExistOnProject = ConnectionDoesNotExistOnProject;

package/dist/errors/FailedToFetchConnection.d.ts

@@ -0,0 +1,3 @@
+export declare class FailedToFetchConnection extends Error {
+    constructor(message: string);
+}

package/dist/errors/FailedToFetchConnection.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FailedToFetchConnection = void 0;
+class FailedToFetchConnection extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'FailedToFetchConnection';
+    }
+}
+exports.FailedToFetchConnection = FailedToFetchConnection;

package/dist/errors/FailedToFetchVizzlyConfig.d.ts

@@ -0,0 +1,3 @@
+export declare class FailedToFetchVizzlyConfig extends Error {
+    constructor(message: string);
+}

package/dist/errors/FailedToFetchVizzlyConfig.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FailedToFetchVizzlyConfig = void 0;
+class FailedToFetchVizzlyConfig extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'FailedToFetchVizzlyConfig';
+    }
+}
+exports.FailedToFetchVizzlyConfig = FailedToFetchVizzlyConfig;

package/dist/errors/index.d.ts

@@ -11,3 +11,6 @@ export * from './FailedToResolveDataSets';
 export * from './FailedToCreateGlobalLibrary';
 export * from './FailedToDecryptDashboardBeforeClient';
 export * from './FailedToUpdateDashboard';
+export * from './FailedToFetchVizzlyConfig';
+export * from './ConnectionDoesNotExistOnProject';
+export * from './FailedToFetchConnection';

package/dist/errors/index.js

@@ -27,3 +27,6 @@ __exportStar(require("./FailedToResolveDataSets"), exports);
 __exportStar(require("./FailedToCreateGlobalLibrary"), exports);
 __exportStar(require("./FailedToDecryptDashboardBeforeClient"), exports);
 __exportStar(require("./FailedToUpdateDashboard"), exports);
+__exportStar(require("./FailedToFetchVizzlyConfig"), exports);
+__exportStar(require("./ConnectionDoesNotExistOnProject"), exports);
+__exportStar(require("./FailedToFetchConnection"), exports);

package/dist/models/Authentication.d.ts

@@ -3,6 +3,7 @@ export declare class Authentication {
     private authParams;
     constructor(authParams: AuthParams);
     updateAuthParams(authParams: Partial<AuthParams>): void;
+    clearAuthParams(): void;
     getQueryEngineAccessToken(): string;
     getProjectAdminOverrideToken(): string | undefined;
     getDashboardAccessToken(): string;

package/dist/models/Authentication.js

@@ -9,6 +9,9 @@ class Authentication {
     updateAuthParams(authParams) {
         this.authParams = Object.assign(Object.assign({}, this.authParams), authParams);
     }
+    clearAuthParams() {
+        this.authParams = {};
+    }
     getQueryEngineAccessToken() {
         if (!this.authParams.queryEngineAccessToken)
             throw new MissingAuthParameter_1.MissingAuthParameter('queryEngineAccessToken');
@@ -64,30 +67,6 @@ class Authentication {
                 auth: `Bearer ${this.authParams.appSessionToken}`,
             };
         }
-        // Try without this extra logic to fetch the project tokens...
-        // else if (request.preFetchProjectAccessTokens && (config.useCookieAuth || !!config.appSessionAuthToken)) {
-        //   logDebug(
-        //     'Fetching project access token from the Vizzly API',
-        //     request.preFetchProjectAccessTokens.projectId,
-        //     'Filtering by',
-        //     request.preFetchProjectAccessTokens.resourceFilters
-        //   );
-        //   const accessToken = await getProjectAccessToken(httpClient(config))(
-        //     request.preFetchProjectAccessTokens.projectId,
-        //     config.appSessionAuthToken,
-        //     request.preFetchProjectAccessTokens.resourceFilters
-        //   );
-        //   if (accessToken) {
-        //     logDebug('Project access token received.');
-        //     return {
-        //       auth: `Bearer ${accessToken}`,
-        //     };
-        //   } else {
-        //     logDebug('Failed to receive project access token.');
-        //   }
-        // } else {
-        //   logDebug('Not pre-fetching project access token.');
-        // }
         return {};
     }
 }

package/dist/models/VizzlyApi.d.ts

@@ -42,7 +42,9 @@ export declare class VizzlyApi extends Api {
     buildCreateGlobalLibraryRequest(params: CreateGlobalLibraryParams): Request<{}>;
     getProjects(): Promise<import("../types").Response<unknown>>;
     buildGetProjectsRequest(): Request<{}>;
-    createProjectApiKey(params: nVizzlyApi.CreateProjectApiKeyParams): Promise<import("../types").Response<unknown>>;
+    createProjectApiKey(params: nVizzlyApi.CreateProjectApiKeyParams): Promise<import("../types").Response<{
+        api_key: string;
+    }>>;
     buildCreateProjectApiKeyRequest(params: nVizzlyApi.CreateProjectApiKeyParams): Request<{}>;
     createQueryEngineUser(params: nVizzlyApi.CreateQueryEngineUserParams): Promise<import("../types").Response<unknown>>;
     buildCreateQueryEngineUserRequest(params: nVizzlyApi.CreateQueryEngineUserParams): Request<{}>;
@@ -55,19 +57,28 @@ export declare class VizzlyApi extends Api {
     buildCreateVizzlyConfigVersionRequest(params: nVizzlyApi.CreateVizzlyConfigVersionParams): Request<{}>;
     duplicateParentDashboard(params: nVizzlyApi.DuplicateParentDashboardParams): Promise<import("../types").Response<unknown>>;
     buildDuplicateParentDashboardRequest(params: nVizzlyApi.DuplicateParentDashboardParams): Request<{}>;
-    getConnection(params: nVizzlyApi.GetConnectionParams): Promise<import("../types").Response<unknown>>;
+    getConnection(params: nVizzlyApi.GetConnectionParams): Promise<{
+        encryptedCredentials: string | null;
+    }>;
     buildGetConnectionRequest(params: nVizzlyApi.GetConnectionParams): Request<{}>;
     getManagedQueryEngineKeyPair(params: nVizzlyApi.GetManagedQueryEngineKeyPairParams): Promise<import("../types").Response<unknown>>;
     buildGetManagedQueryEngineKeyPairRequest(params: nVizzlyApi.GetManagedQueryEngineKeyPairParams): Request<{}>;
     getProject(params: nVizzlyApi.GetProjectParams): Promise<import("../types").Response<unknown>>;
     buildGetProjectRequest(params: nVizzlyApi.GetProjectParams): Request<{}>;
-    getProjectAccessToken(params: nVizzlyApi.GetProjectAccessTokenParams): Promise<import("../types").Response<unknown>>;
+    getProjectAccessToken(params: nVizzlyApi.GetProjectAccessTokenParams): Promise<import("../types").Response<{
+        token: {
+            max_age: number;
+            token: string;
+        };
+    }>>;
     buildGetProjectAccessTokenRequest(params: nVizzlyApi.GetProjectAccessTokenParams): Request<{}>;
     getQueryEngineUser(params: nVizzlyApi.GetQueryEngineUserParams): Promise<import("../types").Response<unknown>>;
     buildGetQueryEngineUserRequest(params: nVizzlyApi.GetQueryEngineUserParams): Request<{}>;
     getTeamMembers(params: nVizzlyApi.GetTeamMembers): Promise<import("../types").Response<unknown>>;
     buildGetTeamMembersRequest(params: nVizzlyApi.GetTeamMembers): Request<{}>;
-    getVizzlyConfig(params: nVizzlyApi.GetVizzlyConfigParams): Promise<import("../types").Response<unknown>>;
+    getVizzlyConfig(params: nVizzlyApi.GetVizzlyConfigParams): Promise<{
+        encryptedConfig: string | null;
+    }>;
     buildGetVizzlyConfigRequest(params: nVizzlyApi.GetVizzlyConfigParams): Request<{}>;
     saveConnection(params: nVizzlyApi.SaveConnectionParams): Promise<import("../types").Response<unknown>>;
     buildSaveConnectionRequest(params: nVizzlyApi.SaveConnectionParams): Request<{}>;

package/dist/models/VizzlyApi.js

@@ -12,6 +12,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VizzlyApi = void 0;
 const Api_1 = require("./Api");
 const errors_1 = require("../errors");
+const FailedToFetchVizzlyConfig_1 = require("../errors/FailedToFetchVizzlyConfig");
+const ConnectionDoesNotExistOnProject_1 = require("../errors/ConnectionDoesNotExistOnProject");
+const FailedToFetchConnection_1 = require("../errors/FailedToFetchConnection");
 class VizzlyApi extends Api_1.Api {
     constructor(auth, host = 'https://api.vizzly.co') {
         super(auth, host);
@@ -234,7 +237,16 @@ class VizzlyApi extends Api_1.Api {
     }
     getConnection(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.execute(this.buildGetConnectionRequest(params));
+            const response = yield this.execute(this.buildGetConnectionRequest(params));
+            if (response.status === 200) {
+                return {
+                    encryptedCredentials: response.body.encrypted_credentials,
+                };
+            }
+            if (response.status == 404) {
+                throw new ConnectionDoesNotExistOnProject_1.ConnectionDoesNotExistOnProject('An active connection does not exist on the project');
+            }
+            throw new FailedToFetchConnection_1.FailedToFetchConnection(`Failed to fetch connection for the project. Got status ${response.status}`);
         });
     }
     buildGetConnectionRequest(params) {
@@ -303,7 +315,13 @@ class VizzlyApi extends Api_1.Api {
     }
     getVizzlyConfig(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.execute(this.buildGetVizzlyConfigRequest(params));
+            const response = yield this.execute(this.buildGetVizzlyConfigRequest(params));
+            if (response.status === 200) {
+                return {
+                    encryptedConfig: response.body.encrypted_config,
+                };
+            }
+            throw new FailedToFetchVizzlyConfig_1.FailedToFetchVizzlyConfig(`Failed to fetch the config containing data sets from the Vizzly API. Got status ${response.status}`);
         });
     }
     buildGetVizzlyConfigRequest(params) {

package/package.json

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