@vizzly/api-client 0.0.4 → 0.0.6

package/dist/errors/FailedToCreateGlobalLibrary.d.ts

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

package/dist/errors/FailedToCreateGlobalLibrary.js

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

package/dist/errors/FailedToDecryptDashboardBeforeClient.d.ts

@@ -0,0 +1,3 @@
+export declare class FailedToDecryptDashboardBeforeClient extends Error {
+    constructor();
+}

package/dist/errors/FailedToDecryptDashboardBeforeClient.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FailedToDecryptDashboardBeforeClient = void 0;
+class FailedToDecryptDashboardBeforeClient extends Error {
+    constructor() {
+        super(`Vizzly offers dashboard encryption to keep your dashboard configurations secure.
+Please ensure your Vizzly Query Engine is still setup to manage encrypted dashboards.`);
+        this.name = 'FailedToDecryptDashboardBeforeClient';
+    }
+}
+exports.FailedToDecryptDashboardBeforeClient = FailedToDecryptDashboardBeforeClient;

package/dist/errors/index.d.ts

@@ -8,3 +8,5 @@ export * from './ValidationError';
 export * from './SQLPreviewError';
 export * from './FailedToSetupProject';
 export * from './FailedToResolveDataSets';
+export * from './FailedToCreateGlobalLibrary';
+export * from './FailedToDecryptDashboardBeforeClient';

package/dist/errors/index.js

@@ -24,3 +24,5 @@ __exportStar(require("./ValidationError"), exports);
 __exportStar(require("./SQLPreviewError"), exports);
 __exportStar(require("./FailedToSetupProject"), exports);
 __exportStar(require("./FailedToResolveDataSets"), exports);
+__exportStar(require("./FailedToCreateGlobalLibrary"), exports);
+__exportStar(require("./FailedToDecryptDashboardBeforeClient"), exports);

package/dist/models/DashboardManager.js

@@ -65,7 +65,7 @@ class DashboardManager {
             const hasThingsToSaveInLibrary = libraryViewsToSave.length > 0 || !!((_b = params.definition) === null || _b === void 0 ? void 0 : _b.customFields);
             const parentGlobalLibrary = globalLibraries.find((gL) => gL.parent_global_library_id === null);
             if (!isParent && parentGlobalLibrary && hasThingsToSaveInLibrary && librariesToUpdate.length === 0) {
-                const createdChildGlobalLibrary = yield globalLibraryRepository.createGlobalLibrary({
+                yield globalLibraryRepository.createGlobalLibrary({
                     library: {
                         views: libraryViewsToSave,
                         // No concept of being protected, so only option is to save them all
@@ -74,8 +74,6 @@ class DashboardManager {
                     parentGlobalLibraryId: parentGlobalLibrary.id,
                     permissions: [{ scope: 'read_write' }],
                 });
-                if (createdChildGlobalLibrary.status != 200)
-                    throw new Error(`Failed to create first child library for user. ${createdChildGlobalLibrary.status}`);
             }
             const updatePromises = librariesToUpdate.map((gL) => __awaiter(this, void 0, void 0, function* () {
                 var _d;

package/dist/models/DashboardRepository.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DashboardRepository = void 0;
 const DashboardQuotaReached_1 = require("../errors/DashboardQuotaReached");
 const FailedToCreateDashboard_1 = require("../errors/FailedToCreateDashboard");
+const FailedToDecryptDashboardBeforeClient_1 = require("../errors/FailedToDecryptDashboardBeforeClient");
 const FailedToFetchDashboardAccessTokens_1 = require("../errors/FailedToFetchDashboardAccessTokens");
 const FailedToFetchDashboards_1 = require("../errors/FailedToFetchDashboards");
 const Permission_1 = require("./Permission");
@@ -71,8 +72,14 @@ class DashboardRepository {
                 const vizzlyApi = this.vizzly.getVizzlyAPI();
                 dashboardResponse = yield vizzlyApi.execute(vizzlyApi.buildFetchDashboardsRequest(permissions.map((p) => p.token)));
             }
-            if (dashboardResponse.status === 200)
+            if (dashboardResponse.status === 200) {
+                dashboardResponse.body.found.forEach((dashboard) => {
+                    if (typeof dashboard.definition === 'string') {
+                        throw new FailedToDecryptDashboardBeforeClient_1.FailedToDecryptDashboardBeforeClient();
+                    }
+                });
                 return dashboardResponse.body;
+            }
             throw new FailedToFetchDashboards_1.FailedToFetchDashboards(`Failed to fetch dashboards. Got status code ${dashboardResponse.status}.`);
         });
     }

package/dist/models/GlobalLibraryRepository.d.ts

@@ -1,20 +1,22 @@
-import { GlobalLibrary, GlobalLibraryPermission, UpdateGlobalLibraryParams, nVizzlyApi } from '../types';
+import { CreateGlobalLibraryParams, GlobalLibrary, GlobalLibraryPermission, UpdateGlobalLibraryParams } from '../types';
 import { Vizzly } from './Vizzly';
 export declare class GlobalLibraryRepository {
     private vizzly;
     private cachedPermissions;
     constructor(vizzly: Vizzly);
-    createGlobalLibrary(createParams: nVizzlyApi.CreateGlobalLibraryParams): Promise<import("../types").Response<{
+    createGlobalLibrary(createParams: CreateGlobalLibraryParams): Promise<{
         global_library: GlobalLibrary;
         permissions: GlobalLibraryPermission[];
-    }>>;
+    }>;
     fetchGlobalLibraries(): Promise<{
         found: GlobalLibrary[];
     }>;
     fetchGlobalLibraryAccessTokens(): Promise<{
         permissions: GlobalLibraryPermission[];
     }>;
-    updateGlobalLibrary(params: UpdateGlobalLibraryParams): Promise<import("../types").Response<unknown>>;
+    updateGlobalLibrary(params: UpdateGlobalLibraryParams): Promise<import("../types").Response<{
+        global_library: GlobalLibrary;
+    }>>;
     getChildGlobalLibrariesByParentGlobalLibraryId(parentGlobalLibraryId: string): Promise<GlobalLibrary[]>;
     static splitParentAndChildGlobalLibraries(globalLibraries: GlobalLibrary[]): {
         childGlobalLibraries: GlobalLibrary[];

package/dist/models/GlobalLibraryRepository.js

@@ -22,8 +22,13 @@ class GlobalLibraryRepository {
     createGlobalLibrary(createParams) {
         return __awaiter(this, void 0, void 0, function* () {
             const vizzlyApi = this.vizzly.getVizzlyAPI();
-            const result = yield vizzlyApi.createGlobalLibrary(createParams);
-            return result;
+            if (this.vizzly.implementationStrategy.shouldPersistViaQueryEngine()) {
+                const vizzlyQueryEngineApi = this.vizzly.getVizzlyQueryEngineAPI();
+                return yield vizzlyQueryEngineApi.createGlobalLibrary(createParams);
+            }
+            else {
+                return yield vizzlyApi.createGlobalLibrary(createParams);
+            }
         });
     }
     fetchGlobalLibraries() {
@@ -53,7 +58,13 @@ class GlobalLibraryRepository {
     updateGlobalLibrary(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const vizzlyApi = this.vizzly.getVizzlyAPI();
-            return yield vizzlyApi.updateGlobalLibrary(params);
+            if (this.vizzly.implementationStrategy.shouldPersistViaQueryEngine()) {
+                const vizzlyQueryEngineApi = this.vizzly.getVizzlyQueryEngineAPI();
+                return yield vizzlyQueryEngineApi.updateGlobalLibrary(params);
+            }
+            else {
+                return yield vizzlyApi.updateGlobalLibrary(params);
+            }
         });
     }
     getChildGlobalLibrariesByParentGlobalLibraryId(parentGlobalLibraryId) {

package/dist/models/VizzlyApi.d.ts

@@ -1,6 +1,6 @@
 import { Api } from './Api';
 import { Authentication } from './Authentication';
-import { CreateDashboardParams, GlobalLibrary, GlobalLibraryPermission, Request, UpdateDashboardParams, UpdateGlobalLibraryParams } from '../types';
+import { CreateDashboardParams, CreateGlobalLibraryParams, GlobalLibrary, GlobalLibraryPermission, Request, UpdateDashboardParams, UpdateGlobalLibraryParams } from '../types';
 import { nVizzlyApi } from '../types';
 export declare class VizzlyApi extends Api {
     constructor(auth: Authentication, host?: string);
@@ -8,6 +8,12 @@ export declare class VizzlyApi extends Api {
         projectAdminOverrideToken: string | undefined;
         dashboardAccessToken: string;
     }>;
+    fetchGlobalLibraries(params: {
+        globalLibraryAccessTokens: string[];
+    }): Promise<import("../types").Response<{
+        found: GlobalLibrary[];
+        not_found: string[];
+    }>>;
     buildFetchGlobalLibrariesRequest(params: {
         globalLibraryAccessTokens: string[];
     }): Request<{
@@ -25,11 +31,11 @@ export declare class VizzlyApi extends Api {
     buildCreateParentDashboardRequest(params: nVizzlyApi.CreateParentDashboardParams): Request<{}>;
     createParentGlobalLibrary(params: nVizzlyApi.CreateParentGlobalLibraryParams): Promise<import("../types").Response<unknown>>;
     buildCreateParentGlobalLibraryRequest(params: nVizzlyApi.CreateParentGlobalLibraryParams): Request<{}>;
-    createGlobalLibrary(params: nVizzlyApi.CreateGlobalLibraryParams): Promise<import("../types").Response<{
+    createGlobalLibrary(params: CreateGlobalLibraryParams): Promise<{
         global_library: GlobalLibrary;
         permissions: Array<GlobalLibraryPermission>;
-    }>>;
-    buildCreateGlobalLibraryRequest(params: nVizzlyApi.CreateGlobalLibraryParams): Request<{}>;
+    }>;
+    buildCreateGlobalLibraryRequest(params: CreateGlobalLibraryParams): Request<{}>;
     getProjects(): Promise<import("../types").Response<unknown>>;
     buildGetProjectsRequest(): Request<{}>;
     createProjectApiKey(params: nVizzlyApi.CreateProjectApiKeyParams): Promise<import("../types").Response<unknown>>;
@@ -68,7 +74,9 @@ export declare class VizzlyApi extends Api {
     buildUpdateDashboardRequest(params: UpdateDashboardParams): Request<{}>;
     updateParentGlobalLibrary(params: nVizzlyApi.UpdateParentGlobalLibraryParams): Promise<import("../types").Response<unknown>>;
     buildUpdateParentGlobalLibraryRequest(params: nVizzlyApi.UpdateParentGlobalLibraryParams): Request<{}>;
-    updateGlobalLibrary(params: UpdateGlobalLibraryParams): Promise<import("../types").Response<unknown>>;
+    updateGlobalLibrary(params: UpdateGlobalLibraryParams): Promise<import("../types").Response<{
+        global_library: GlobalLibrary;
+    }>>;
     buildUpdateGlobalLibraryRequest(params: UpdateGlobalLibraryParams): Request<{}>;
     updateProjectApiKey(params: nVizzlyApi.UpdateProjectApiKeyParams): Promise<import("../types").Response<unknown>>;
     buildUpdateProjectApiKeyRequest(params: nVizzlyApi.UpdateProjectApiKeyParams): Request<{}>;

package/dist/models/VizzlyApi.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VizzlyApi = void 0;
 const Api_1 = require("./Api");
+const errors_1 = require("../errors");
 class VizzlyApi extends Api_1.Api {
     constructor(auth, host = 'https://api.vizzly.co') {
         super(auth, host);
@@ -25,6 +26,11 @@ class VizzlyApi extends Api_1.Api {
             },
         };
     }
+    fetchGlobalLibraries(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildFetchGlobalLibrariesRequest(params));
+        });
+    }
     buildFetchGlobalLibrariesRequest(params) {
         return {
             path: '/api/v2/multi-get-global-library',
@@ -98,7 +104,10 @@ class VizzlyApi extends Api_1.Api {
     }
     createGlobalLibrary(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.execute(this.buildCreateGlobalLibraryRequest(params));
+            const result = yield this.execute(this.buildCreateGlobalLibraryRequest(params));
+            if (result.status === 200)
+                return result.body;
+            throw new errors_1.FailedToCreateGlobalLibrary('Failed to create global library');
         });
     }
     buildCreateGlobalLibraryRequest(params) {

package/dist/models/VizzlyQueryEngineApi.d.ts

@@ -1,6 +1,6 @@
 import { Api } from './Api';
 import { Authentication } from './Authentication';
-import { nVizzlyQueryEngine, Request, extraHeaders, CreateDashboardParams, UpdateDashboardParams } from '../types';
+import { nVizzlyQueryEngine, Request, extraHeaders, CreateDashboardParams, UpdateDashboardParams, UpdateGlobalLibraryParams, GlobalLibrary, CreateGlobalLibraryParams, GlobalLibraryPermission } from '../types';
 export declare class VizzlyQueryEngineApi extends Api {
     constructor(auth: Authentication, host: string, extraHeaders?: extraHeaders);
     buildCreateDashboardRequest(params: CreateDashboardParams): Request<CreateDashboardParams & {
@@ -41,6 +41,15 @@ export declare class VizzlyQueryEngineApi extends Api {
     buildSignInWithEmailAndPasswordRequest(params: nVizzlyQueryEngine.SignInWithEmailAndPasswordParams): Request<{}>;
     status(): Promise<import("../types").Response<unknown>>;
     buildStatusRequest(): Request<{}>;
+    createGlobalLibrary(params: CreateGlobalLibraryParams): Promise<{
+        global_library: GlobalLibrary;
+        permissions: Array<GlobalLibraryPermission>;
+    }>;
+    buildCreateGlobalLibraryRequest(params: CreateGlobalLibraryParams): Request<{}>;
+    updateGlobalLibrary(params: UpdateGlobalLibraryParams): Promise<import("../types").Response<{
+        global_library: GlobalLibrary;
+    }>>;
+    buildUpdateGlobalLibraryRequest(params: UpdateGlobalLibraryParams): Request<{}>;
     updateDashboard(params: UpdateDashboardParams): Promise<import("../types").Response<unknown>>;
     buildUpdateDashboardRequest(params: UpdateDashboardParams): Request<{}>;
     updateQueryEngineUser(params: nVizzlyQueryEngine.UpdateQueryEngineUserParams): Promise<import("../types").Response<unknown>>;

package/dist/models/VizzlyQueryEngineApi.js

@@ -14,6 +14,7 @@ const Api_1 = require("./Api");
 const SQLPreviewError_1 = require("../errors/SQLPreviewError");
 const FailedToResolveDataSets_1 = require("../errors/FailedToResolveDataSets");
 const FailedToSetupProject_1 = require("../errors/FailedToSetupProject");
+const errors_1 = require("../errors");
 class VizzlyQueryEngineApi extends Api_1.Api {
     constructor(auth, host, extraHeaders) {
         super(auth, host, extraHeaders);
@@ -260,6 +261,42 @@ class VizzlyQueryEngineApi extends Api_1.Api {
             body: {},
         };
     }
+    createGlobalLibrary(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.execute(this.buildCreateGlobalLibraryRequest(params));
+            if (result.status === 200)
+                return result.body;
+            throw new errors_1.FailedToCreateGlobalLibrary(`Failed to create a global library. Got status ${result.status}`);
+        });
+    }
+    buildCreateGlobalLibraryRequest(params) {
+        return {
+            path: '/api/v1/global-library',
+            method: 'post',
+            body: {
+                dashboardAccessToken: this.auth.getDashboardAccessToken(),
+                parentGlobalLibraryId: params.parentGlobalLibraryId,
+                library: params.library,
+                permissions: params.permissions,
+            },
+        };
+    }
+    updateGlobalLibrary(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildUpdateGlobalLibraryRequest(params));
+        });
+    }
+    buildUpdateGlobalLibraryRequest(params) {
+        return {
+            path: '/api/v1/global-library',
+            method: 'put',
+            body: {
+                globalLibrarySessionToken: params.globalLibrarySessionToken,
+                deleted: params.deleted,
+                library: params.library,
+            },
+        };
+    }
     updateDashboard(params) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.execute(this.buildUpdateDashboardRequest(params));

package/dist/types.d.ts

@@ -23,6 +23,14 @@ export type UpdateGlobalLibraryParams = {
     deleted?: boolean;
     library: GlobalLibrary['library'] | string;
 };
+export type CreateGlobalLibraryParams = {
+    parentGlobalLibraryId: string;
+    library: GlobalLibrary['library'] | string;
+    permissions: Array<{
+        user_reference?: string;
+        scope: 'read' | 'read_write';
+    }>;
+};
 export type CreateDashboardParams = {
     definition: DashboardDefinition | string;
     /** @deprecated - use `metadata` instead */
@@ -111,14 +119,6 @@ export declare namespace nVizzlyApi {
         definition: any;
         projectId: string;
     };
-    type CreateGlobalLibraryParams = {
-        parentGlobalLibraryId: string;
-        library: any;
-        permissions: Array<{
-            user_reference?: string;
-            scope: 'read' | 'read_write';
-        }>;
-    };
     type CreateParentGlobalLibraryParams = {
         library: any;
         projectId: string;

package/package.json

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