@vizzly/api-client 0.0.12 → 0.0.14

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,4 @@ export * from './FailedToResolveDataSets';
 export * from './FailedToCreateGlobalLibrary';
 export * from './FailedToDecryptDashboardBeforeClient';
 export * from './FailedToUpdateDashboard';
+export * from './FailedToFetchVizzlyConfig';

package/dist/errors/index.js

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

package/dist/index.d.ts

@@ -4,5 +4,6 @@ export * from './models/VizzlyAppApi';
 export * from './models/VizzlyQueryEngineApi';
 export * from './models/Authentication';
 export * from './models/ImplementationStrategy';
+export * from './models/VizzlyApiClientLogger';
 export * from './types';
 export * as Errors from './errors';

package/dist/index.js

@@ -33,5 +33,6 @@ __exportStar(require("./models/VizzlyAppApi"), exports);
 __exportStar(require("./models/VizzlyQueryEngineApi"), exports);
 __exportStar(require("./models/Authentication"), exports);
 __exportStar(require("./models/ImplementationStrategy"), exports);
+__exportStar(require("./models/VizzlyApiClientLogger"), exports);
 __exportStar(require("./types"), exports);
 exports.Errors = __importStar(require("./errors"));

package/dist/models/Api.js

@@ -14,6 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Api = void 0;
 const isomorphic_fetch_1 = __importDefault(require("isomorphic-fetch"));
+const Monitor_1 = require("./Monitor");
 class Api {
     constructor(auth, host, extraHeaders = () => ({})) {
         this.host = host;
@@ -26,8 +27,8 @@ class Api {
             const authHeaders = this.auth.buildAuthHeaders();
             const customHeaders = Object.assign(Object.assign({}, (request.headers || {})), (this.extraHeaders() || {}));
             const path = `${this.host}${request.path}`;
-            console.debug(`[REQUEST] ${path}`);
-            const res = yield (0, isomorphic_fetch_1.default)(path, {
+            const timedFetch = Monitor_1.Monitor.timeRequest(request.method, path, isomorphic_fetch_1.default);
+            const res = yield timedFetch(path, {
                 method: request.method,
                 headers: Object.assign(Object.assign({ 'Content-Type': 'application/json', Accept: 'application/json' }, authHeaders), customHeaders),
                 redirect: 'follow',

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/Monitor.d.ts

@@ -0,0 +1,3 @@
+export declare class Monitor {
+    static timeRequest<T extends (...args: any[]) => Promise<any>>(method: string, path: string, asyncFunction: T): T;
+}

package/dist/models/Monitor.js

@@ -0,0 +1,28 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Monitor = void 0;
+const VizzlyApiClientLogger_1 = require("./VizzlyApiClientLogger");
+class Monitor {
+    static timeRequest(method, path, asyncFunction) {
+        return function (...args) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const start = performance.now();
+                const result = yield asyncFunction(...args);
+                const stop = performance.now();
+                const duration = stop - start;
+                VizzlyApiClientLogger_1.VizzlyApiClientLogger.debug(`[@vizzly/api-client timing] ${method.toUpperCase()} ${path} - ${duration.toFixed(2)}ms`);
+                return result;
+            });
+        };
+    }
+}
+exports.Monitor = Monitor;

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<{}>;
@@ -61,13 +63,20 @@ export declare class VizzlyApi extends Api {
     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,7 @@ 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");
 class VizzlyApi extends Api_1.Api {
     constructor(auth, host = 'https://api.vizzly.co') {
         super(auth, host);
@@ -303,7 +304,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/dist/models/VizzlyApiClientLogger.d.ts

@@ -0,0 +1,15 @@
+type LoggerBackend = {
+    debug: (...args: any) => void;
+    info: (...args: any) => void;
+    warning: (...args: any) => void;
+    error: (...args: any) => void;
+};
+export declare class VizzlyApiClientLogger {
+    private static backend;
+    static setBackend(backend: LoggerBackend): void;
+    static debug(...args: any): void;
+    static info(...args: any): void;
+    static warning(...args: any): void;
+    static error(...args: any): void;
+}
+export {};

package/dist/models/VizzlyApiClientLogger.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VizzlyApiClientLogger = void 0;
+class VizzlyApiClientLogger {
+    static setBackend(backend) {
+        this.backend = backend;
+    }
+    static debug(...args) {
+        if (VizzlyApiClientLogger.backend) {
+            VizzlyApiClientLogger.backend.debug(...args);
+        }
+    }
+    static info(...args) {
+        if (VizzlyApiClientLogger.backend) {
+            VizzlyApiClientLogger.backend.info(...args);
+        }
+    }
+    static warning(...args) {
+        if (VizzlyApiClientLogger.backend) {
+            VizzlyApiClientLogger.backend.warning(...args);
+        }
+    }
+    static error(...args) {
+        if (VizzlyApiClientLogger.backend) {
+            VizzlyApiClientLogger.backend.error(...args);
+        }
+    }
+}
+exports.VizzlyApiClientLogger = VizzlyApiClientLogger;

package/package.json

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