@vizzly/api-client 0.0.43 → 0.0.44

package/dist/models/DashboardRepository.d.ts

@@ -4,6 +4,12 @@ export declare class DashboardRepository {
     private vizzly;
     private repo;
     constructor(vizzly: Vizzly);
+    static EmptyDashboardDefinition(): {
+        componentLibrary: never[];
+        customFields: {};
+        display: never[];
+        globalFilters: never[];
+    };
     createDashboard(createParams: CreateDashboardParams): Promise<{
         dashboard: Dashboard;
         permissions: DashboardPermission[];

package/dist/models/DashboardRepository.js

@@ -23,6 +23,14 @@ class DashboardRepository {
         this.vizzly = vizzly;
         this.repo = new Repository_1.Repository('id');
     }
+    static EmptyDashboardDefinition() {
+        return {
+            componentLibrary: [],
+            customFields: {},
+            display: [],
+            globalFilters: [],
+        };
+    }
     createDashboard(createParams) {
         return __awaiter(this, void 0, void 0, function* () {
             let builtDashboard;

package/dist/models/VizzlyApi.js

@@ -19,6 +19,7 @@ const FailedToFetchProject_1 = require("../errors/FailedToFetchProject");
 const FailedToUpdateQueryEngineUser_1 = require("../errors/FailedToUpdateQueryEngineUser");
 const FailedToSaveProjectEncryptedEncryptionSecret_1 = require("../errors/FailedToSaveProjectEncryptedEncryptionSecret");
 const ProjectEncryptedSecretAlreadySaved_1 = require("../errors/ProjectEncryptedSecretAlreadySaved");
+const DashboardRepository_1 = require("./DashboardRepository");
 class VizzlyApi extends Api_1.Api {
     constructor(auth, host = 'https://api.vizzly.co') {
         super(auth, host);
@@ -71,7 +72,7 @@ class VizzlyApi extends Api_1.Api {
             method: 'post',
             body: {
                 dashboardAccessToken: this.auth.getDashboardAccessToken(),
-                definition: params.definition,
+                definition: params.definition || DashboardRepository_1.DashboardRepository.EmptyDashboardDefinition(),
                 meta: params.metadata || params.meta || {},
                 parentDashboardId: params.parentDashboardId,
                 permissions: params.permissions,
@@ -100,7 +101,8 @@ class VizzlyApi extends Api_1.Api {
             method: 'post',
             body: {
                 projectId: params.projectId,
-                definition: params.definition,
+                definition: params.definition || DashboardRepository_1.DashboardRepository.EmptyDashboardDefinition(),
+                name: params.name,
             },
             abortSignal: params.abortSignal,
         };
@@ -468,6 +470,7 @@ class VizzlyApi extends Api_1.Api {
                 definition: params.definition,
                 meta: params.metadata || params.meta || {},
                 deleted: params.deleted,
+                name: params.name,
             },
             abortSignal: params.abortSignal,
         };

package/dist/models/VizzlyQueryEngineApi.js

@@ -15,6 +15,7 @@ const SQLPreviewError_1 = require("../errors/SQLPreviewError");
 const FailedToResolveDataSets_1 = require("../errors/FailedToResolveDataSets");
 const FailedToSetupProject_1 = require("../errors/FailedToSetupProject");
 const errors_1 = require("../errors");
+const DashboardRepository_1 = require("./DashboardRepository");
 class VizzlyQueryEngineApi extends Api_1.Api {
     constructor(auth, host, extraHeaders) {
         super(auth, host, extraHeaders);
@@ -26,7 +27,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
             abortSignal: params.abortSignal,
             body: {
                 dashboardAccessToken: this.auth.getDashboardAccessToken(),
-                definition: params.definition,
+                definition: params.definition || DashboardRepository_1.DashboardRepository.EmptyDashboardDefinition(),
                 meta: params.metadata || params.meta || {},
                 parentDashboardId: params.parentDashboardId,
                 permissions: params.permissions,
@@ -375,6 +376,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
                 definition: params.definition,
                 meta: params.metadata || params.meta || {},
                 deleted: params.deleted,
+                name: params.name,
             },
         };
     }

package/dist/types.d.ts

@@ -48,7 +48,7 @@ export type CreateGlobalLibraryParams = {
     }>;
 };
 export type CreateDashboardParams = {
-    definition: DashboardDefinition | string;
+    definition?: DashboardDefinition | string;
     /** @deprecated - use `metadata` instead */
     meta?: any;
     metadata?: any;
@@ -65,6 +65,7 @@ export type UpdateDashboardParams = {
     meta?: any;
     metadata?: any;
     deleted?: boolean;
+    name?: string;
 };
 export type APIs = {
     vizzlyApi: VizzlyApi;
@@ -138,8 +139,10 @@ export declare namespace nVizzlyApi {
         dashboardAccessToken: string;
     };
     type CreateParentDashboardParams = {
-        definition: any;
-        projectId: string;
+        definition?: any;
+        name?: string;
+        /** Optional, only when using project API key for auth. */
+        projectId?: string;
     };
     type CreateParentGlobalLibraryParams = {
         library: any;

package/package.json

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