@vizzly/api-client 0.0.38 → 0.0.41

package/dist/errors/PermissionDenied.d.ts

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

package/dist/errors/PermissionDenied.js

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

package/dist/errors/index.d.ts

@@ -21,3 +21,4 @@ export * from './FailedToCreateQueryEngineUser';
 export * from './FailedToFetchQueryEngineUser';
 export * from './ProjectEncryptedSecretAlreadySaved';
 export * from './FailedToSaveProjectEncryptedEncryptionSecret';
+export * from './PermissionDenied';

package/dist/errors/index.js

@@ -37,3 +37,4 @@ __exportStar(require("./FailedToCreateQueryEngineUser"), exports);
 __exportStar(require("./FailedToFetchQueryEngineUser"), exports);
 __exportStar(require("./ProjectEncryptedSecretAlreadySaved"), exports);
 __exportStar(require("./FailedToSaveProjectEncryptedEncryptionSecret"), exports);
+__exportStar(require("./PermissionDenied"), exports);

package/dist/models/DashboardManager.js

@@ -25,7 +25,7 @@ class DashboardManager {
     }
     update(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
+            var _a;
             const dashboardRepository = this.vizzly.getDashboardRepository();
             const globalLibraryRepository = this.vizzly.getGlobalLibraryRepository();
             const [{ global_libraries: globalLibraries, permissions: globalLibraryPermissions }, { dashboards, permissions: dashboardPermissions },] = yield Promise.all([
@@ -60,22 +60,22 @@ class DashboardManager {
             const librariesToUpdate = dashboardToUpdate.parent_dashboard_id === null ? parentGlobalLibraries : childGlobalLibraries;
             // If it's not a parent dashboard, and there are views or custom fields to save, but there are no libraries
             // then create one first.
-            const isParent = dashboardToUpdate.parent_dashboard_id === null;
-            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) {
-                yield globalLibraryRepository.createGlobalLibrary({
-                    library: {
-                        views: libraryViewsToSave,
-                        // No concept of being protected, so only option is to save them all
-                        customFields: ((_c = params.definition) === null || _c === void 0 ? void 0 : _c.customFields) || {},
-                    },
-                    parentGlobalLibraryId: parentGlobalLibrary.id,
-                    permissions: [{ scope: 'read_write' }],
-                });
-            }
+            // const isParent = dashboardToUpdate.parent_dashboard_id === null;
+            // const hasThingsToSaveInLibrary = libraryViewsToSave.length > 0 || !!params.definition?.customFields;
+            // const parentGlobalLibrary = globalLibraries.find((gL) => gL.parent_global_library_id === null);
+            // if (!isParent && parentGlobalLibrary && hasThingsToSaveInLibrary && librariesToUpdate.length === 0) {
+            //   await globalLibraryRepository.createGlobalLibrary({
+            //     library: {
+            //       views: libraryViewsToSave,
+            //       // No concept of being protected, so only option is to save them all
+            //       customFields: params.definition?.customFields || {},
+            //     },
+            //     parentGlobalLibraryId: parentGlobalLibrary!.id,
+            //     permissions: [{ scope: 'read_write' }],
+            //   });
+            // }
             const updatePromises = librariesToUpdate.map((gL) => __awaiter(this, void 0, void 0, function* () {
-                var _d;
+                var _b;
                 const writePermission = globalLibraryPermissions.find((permission) => permission.globalLibraryId === gL.id && permission.scope === 'read_write');
                 if (!writePermission)
                     VizzlyApiClientLogger_1.VizzlyApiClientLogger.error('No write permission found.');
@@ -85,7 +85,7 @@ class DashboardManager {
                         library: {
                             views: libraryViewsToSave,
                             // No concept of being protected, so only option is to save them all
-                            customFields: ((_d = params.definition) === null || _d === void 0 ? void 0 : _d.customFields) || {},
+                            customFields: ((_b = params.definition) === null || _b === void 0 ? void 0 : _b.customFields) || {},
                         },
                     });
                 }

package/dist/models/GlobalLibraryManager.d.ts

@@ -5,8 +5,8 @@ export declare class GlobalLibraryManager {
     private vizzly;
     constructor(vizzly: Vizzly);
     create(params: RequestParams<CreateGlobalLibraryParams>): Promise<{
-        permissions: import("../types").GlobalLibraryPermission[];
         global_library: GlobalLibrary;
+        permissions: import("../types").GlobalLibraryPermission[];
     }>;
     update(params: RequestParams<UpdateGlobalLibraryParams & {
         globalLibraryId: string;

package/dist/models/GlobalLibraryRepository.d.ts

@@ -5,8 +5,8 @@ export declare class GlobalLibraryRepository {
     private repo;
     constructor(vizzly: Vizzly);
     createGlobalLibrary(createParams: CreateGlobalLibraryParams): Promise<{
-        permissions: GlobalLibraryPermission[];
         global_library: GlobalLibrary;
+        permissions: GlobalLibraryPermission[];
     }>;
     fetchGlobalLibraries(params?: RequestParams): Promise<{
         global_libraries: GlobalLibrary[];

package/dist/models/GlobalLibraryRepository.js

@@ -15,6 +15,7 @@ const Permission_1 = require("./Permission");
 const FailedToFetchGlobalLibraryAccessTokens_1 = require("../errors/FailedToFetchGlobalLibraryAccessTokens");
 const Repository_1 = require("./Repository");
 const FailedToUpdateGlobalLibrary_1 = require("../errors/FailedToUpdateGlobalLibrary");
+const errors_1 = require("../errors");
 class GlobalLibraryRepository {
     constructor(vizzly) {
         this.vizzly = vizzly;
@@ -31,15 +32,49 @@ class GlobalLibraryRepository {
             else {
                 globalLibrary = yield vizzlyApi.createGlobalLibrary(createParams);
             }
-            globalLibrary.global_library = GlobalLibraryRepository.upcast(globalLibrary.global_library);
-            this.repo.addItem(globalLibrary.global_library, globalLibrary.permissions);
-            return globalLibrary;
+            const upcastedLibrary = GlobalLibraryRepository.upcast(globalLibrary.global_library);
+            const formattedPermissions = globalLibrary.permissions.map(Permission_1.Permission.formatGlobalLibraryPermission);
+            this.repo.addItem(upcastedLibrary, formattedPermissions);
+            return {
+                global_library: upcastedLibrary,
+                permissions: formattedPermissions,
+            };
         });
     }
     fetchGlobalLibraries(params) {
         return __awaiter(this, void 0, void 0, function* () {
             // Now, we fetch the libraries and the access tokens from the access call.
-            return yield this.fetchGlobalLibraryAccessTokens(params);
+            let libs = yield this.fetchGlobalLibraryAccessTokens(params);
+            // Find the parent library.
+            const parentLibrary = libs.global_libraries.find((l) => l.parent_global_library_id === null);
+            // Find any child library.
+            const childLibrary = libs.global_libraries.find((l) => l.parent_global_library_id != null);
+            // If libraries have been returned, but no child library exists
+            // then create the first and only one.
+            if (libs.global_libraries.length > 0 && parentLibrary && !childLibrary) {
+                try {
+                    const created = yield this.createGlobalLibrary({
+                        parentGlobalLibraryId: parentLibrary.id,
+                        library: {
+                            customFields: {},
+                            views: [],
+                        },
+                        permissions: [{ scope: 'read_write' }],
+                    });
+                    libs = {
+                        global_libraries: [...libs.global_libraries, created.global_library],
+                        permissions: [...libs.permissions, ...created.permissions],
+                    };
+                }
+                catch (e) {
+                    // Only throw if the error is not a permission denied. A permission denied
+                    // is expected if the user only has `read` access on their identity JWT token.
+                    if (!(e instanceof errors_1.PermissionDenied)) {
+                        throw e;
+                    }
+                }
+            }
+            return libs;
         });
     }
     fetchGlobalLibraryAccessTokens(params) {
@@ -56,7 +91,7 @@ class GlobalLibraryRepository {
                 }
                 if (accessTokens.status === 200) {
                     const formattedPermissions = accessTokens.body.permissions.map(Permission_1.Permission.formatGlobalLibraryPermission);
-                    this.repo.initRepo(accessTokens.body.global_libraries.map(GlobalLibraryRepository.upcast), formattedPermissions);
+                    this.repo.initRepo(accessTokens.body.global_libraries, formattedPermissions);
                 }
                 else {
                     throw new FailedToFetchGlobalLibraryAccessTokens_1.FailedToFetchGlobalLibraryAccessTokens('Failed to load access tokens for the global library.');

package/dist/models/VizzlyApi.d.ts

@@ -1,6 +1,6 @@
 import { Api } from './Api';
 import { Authentication } from './Authentication';
-import { CreateDashboardParams, CreateGlobalLibraryParams, GlobalLibrary, GlobalLibraryPermission, GlobalLibraryPermissionFromAPI, QueryEngineUserFromAPI, Request, RequestParams, TeamMemberFromAPI, UpdateDashboardParams, UpdateDashboardResponseBody, UpdateGlobalLibraryParams } from '../types';
+import { CreateDashboardParams, CreateGlobalLibraryParams, GlobalLibrary, GlobalLibraryPermissionFromAPI, PersistedReport, QueryEngineUserFromAPI, Request, RequestParams, TeamMemberFromAPI, UpdateDashboardParams, UpdateDashboardResponseBody, UpdateGlobalLibraryParams } from '../types';
 import { nVizzlyApi } from '../types';
 import { ProjectFromAPI } from '../types/project';
 export declare class VizzlyApi extends Api {
@@ -40,7 +40,7 @@ export declare class VizzlyApi extends Api {
     buildCreateParentGlobalLibraryRequest(params: RequestParams<nVizzlyApi.CreateParentGlobalLibraryParams>): Request<{}>;
     createGlobalLibrary(params: RequestParams<CreateGlobalLibraryParams>): Promise<{
         global_library: GlobalLibrary;
-        permissions: Array<GlobalLibraryPermission>;
+        permissions: Array<GlobalLibraryPermissionFromAPI>;
     }>;
     buildCreateGlobalLibraryRequest(params: RequestParams<CreateGlobalLibraryParams>): Request<{}>;
     getProjects(params?: RequestParams): Promise<{
@@ -93,7 +93,13 @@ export declare class VizzlyApi extends Api {
     buildSaveConnectionRequest(params: RequestParams<nVizzlyApi.SaveConnectionParams>): Request<{}>;
     saveEncryptedProjectEncryptionSecret(params: RequestParams<nVizzlyApi.SaveEncryptedProjectEncryptionSecretParams>): Promise<boolean>;
     buildSaveEncryptedProjectEncryptionSecretRequest(params: RequestParams<nVizzlyApi.SaveEncryptedProjectEncryptionSecretParams>): Request<{}>;
-    saveScheduledReport(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Promise<import("../types").Response<unknown>>;
+    getScheduledReports(params: RequestParams<nVizzlyApi.GetScheduledReportParams>): Promise<import("../types").Response<{
+        reports: Array<PersistedReport>;
+    }>>;
+    buildGetScheduledReports(params: RequestParams<nVizzlyApi.GetScheduledReportParams>): Request<{}>;
+    saveScheduledReport(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Promise<import("../types").Response<{
+        report: PersistedReport;
+    }>>;
     buildSaveScheduledReportRequest(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Request<{}>;
     updateDashboard(params: RequestParams<UpdateDashboardParams>): Promise<import("../types").Response<UpdateDashboardResponseBody>>;
     buildUpdateDashboardRequest(params: RequestParams<UpdateDashboardParams>): Request<{}>;

package/dist/models/VizzlyApi.js

@@ -126,7 +126,9 @@ class VizzlyApi extends Api_1.Api {
             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');
+            if (result.status === 403)
+                throw new errors_1.PermissionDenied('Permission denied when creating a global library via the Vizzly API.');
+            throw new errors_1.FailedToCreateGlobalLibrary(`Failed to create global library, got status ${result.status}`);
         });
     }
     buildCreateGlobalLibraryRequest(params) {
@@ -420,6 +422,21 @@ class VizzlyApi extends Api_1.Api {
             acceptedAuthParams: ['projectApiKey', 'projectAccessToken'],
         };
     }
+    getScheduledReports(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildGetScheduledReports(params));
+        });
+    }
+    buildGetScheduledReports(params) {
+        return {
+            path: '/api/scheduled-report/collect',
+            method: 'post',
+            body: {
+                dashboardAccessToken: params.dashboardAccessToken,
+            },
+            abortSignal: params.abortSignal,
+        };
+    }
     saveScheduledReport(params) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.execute(this.buildSaveScheduledReportRequest(params));
@@ -431,7 +448,7 @@ class VizzlyApi extends Api_1.Api {
             method: 'post',
             body: {
                 cronSchedule: params.cronSchedule,
-                dashboardAccessToken: this.auth.getDashboardAccessToken(),
+                dashboardAccessToken: params.dashboardAccessToken,
                 scheduledReportId: params.scheduledReportId,
             },
             abortSignal: params.abortSignal,

package/dist/models/VizzlyAppApi.d.ts

@@ -41,6 +41,19 @@ export declare class VizzlyAppApi extends Api {
     buildStartSignInRequest(params: nVizzlyAppApi.StartSignInParams): Request<{}>;
     completeSignIn(params: nVizzlyAppApi.CompleteSignInParams): Promise<import("../types").Response<unknown>>;
     buildCompleteSignInRequest(params: nVizzlyAppApi.CompleteSignInParams): Request<{}>;
+    searchUserDashboards(params: nVizzlyAppApi.SearchUserDashboardsParams): Promise<import("../types").Response<{
+        search_results: Array<{
+            id: string;
+            parent_dashboard_id: string | null;
+            parent_dashboard_name: string | null;
+            scope: 'read' | 'read_write';
+            user_reference: string;
+            permission_created_at: string;
+            dashboard_created_at: string;
+            dashboard_updated_at: string;
+        }>;
+    }>>;
+    buildSearchUserDashboardsRequest(params: nVizzlyAppApi.SearchUserDashboardsParams): Request<{}>;
     signUp(params: nVizzlyAppApi.SignUpParams): Promise<import("../types").Response<unknown>>;
     buildSignUpRequest(params: nVizzlyAppApi.SignUpParams): Request<{}>;
     switchOrganisation(params: nVizzlyAppApi.SwitchOrganisationParams): Promise<import("../types").Response<unknown>>;

package/dist/models/VizzlyAppApi.js

@@ -266,6 +266,17 @@ class VizzlyAppApi extends Api_1.Api {
             },
         };
     }
+    searchUserDashboards(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildSearchUserDashboardsRequest(params));
+        });
+    }
+    buildSearchUserDashboardsRequest(params) {
+        return {
+            path: `/api/v2/project/${params.projectId}/search-user-dashboards?user_reference=${params.userReference}`,
+            method: 'get',
+        };
+    }
     signUp(params) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.execute(this.buildSignUpRequest(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, UpdateGlobalLibraryParams, GlobalLibrary, CreateGlobalLibraryParams, GlobalLibraryPermission, GlobalLibraryPermissionFromAPI, RequestParams } from '../types';
+import { nVizzlyQueryEngine, Request, extraHeaders, CreateDashboardParams, UpdateDashboardParams, UpdateGlobalLibraryParams, GlobalLibrary, CreateGlobalLibraryParams, GlobalLibraryPermissionFromAPI, RequestParams } from '../types';
 export declare class VizzlyQueryEngineApi extends Api {
     constructor(auth: Authentication, host: string, extraHeaders?: extraHeaders);
     buildCreateDashboardRequest(params: RequestParams<CreateDashboardParams>): Request<CreateDashboardParams & {
@@ -57,7 +57,7 @@ export declare class VizzlyQueryEngineApi extends Api {
     buildStatusRequest(params?: RequestParams): Request<{}>;
     createGlobalLibrary(params: RequestParams<CreateGlobalLibraryParams>): Promise<{
         global_library: GlobalLibrary;
-        permissions: Array<GlobalLibraryPermission>;
+        permissions: Array<GlobalLibraryPermissionFromAPI>;
     }>;
     buildCreateGlobalLibraryRequest(params: RequestParams<CreateGlobalLibraryParams>): Request<{}>;
     fetchGlobalLibraries(params: RequestParams<{

package/dist/models/VizzlyQueryEngineApi.js

@@ -310,6 +310,8 @@ class VizzlyQueryEngineApi extends Api_1.Api {
             const result = yield this.execute(this.buildCreateGlobalLibraryRequest(params));
             if (result.status === 200)
                 return result.body;
+            if (result.status === 403)
+                throw new errors_1.PermissionDenied('Permission denied when creating a global library via the Vizzly Query Engine.');
             throw new errors_1.FailedToCreateGlobalLibrary(`Failed to create a global library. Got status ${result.status}`);
         });
     }

package/dist/types.d.ts

@@ -11,6 +11,14 @@ export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 export type UpdateDashboardResponseBody = {
     dashboard: DashboardFromAPI;
 };
+export type PersistedReport = {
+    id: string;
+    dashboard_id: string;
+    organisation_id: string;
+    schedule: string;
+    type: 'scheduled';
+    user_reference: string;
+};
 export type Response<T> = {
     status: number;
     headers: Headers;
@@ -126,6 +134,9 @@ export declare namespace nVizzlyQueryEngine {
     };
 }
 export declare namespace nVizzlyApi {
+    type GetScheduledReportParams = {
+        dashboardAccessToken: string;
+    };
     type CreateParentDashboardParams = {
         definition: any;
         projectId: string;
@@ -155,7 +166,8 @@ export declare namespace nVizzlyApi {
         name?: string;
     };
     type SaveScheduledReportParams = {
-        cronSchedule: string;
+        dashboardAccessToken: string;
+        cronSchedule: string | null;
         scheduledReportId: string;
     };
     type SaveEncryptedProjectEncryptionSecretParams = {
@@ -204,6 +216,10 @@ export declare namespace nVizzlyApi {
     };
 }
 export declare namespace nVizzlyAppApi {
+    type SearchUserDashboardsParams = {
+        projectId: string;
+        userReference: string;
+    };
     type CreateInstantDashboardParams = {
         definition: Object;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vizzly/api-client",
-  "version": "0.0.38",
+  "version": "0.0.41",
   "private": false,
   "license": "NONE",
   "source": "src/index.ts",
@@ -25,7 +25,8 @@
     "uuid": "^9.0.1"
   },
   "scripts": {
-    "test": "jest",
+    "test": ". ./secrets.env && jest",
+    "test:ci": "jest",
     "build": "rm -rf ./dist && tsc",
     "dev": "tsc -w",
     "format": "prettier --write ./src/** ./__tests__/**",