@vizzly/dashboard 0.11.0 → 0.12.0-dev-e9cb501d005236550d32fd4ffe3eaeb1307996b1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/dist/charts/src/ScatterChart/ScatterChart.d.ts +1 -1
  2. package/dist/dashboard/src/contexts/GlobalProvider/useGlobalProvider.d.ts +30 -30
  3. package/dist/dashboard/src/contexts/SessionContext/getStrategy.d.ts +2 -3
  4. package/dist/dashboard/src/contexts/SessionContext/useSessionContext.d.ts +11 -12
  5. package/dist/dashboard/src/contexts/useDashboardStrategy/runStrategy.d.ts +2 -2
  6. package/dist/dashboard/src/contexts/useDashboardStrategy.d.ts +3 -4
  7. package/dist/dashboard/src/index.d.ts +3 -214
  8. package/dist/dashboard/src/sdk.d.ts +0 -79
  9. package/dist/dashboard/src/types.d.ts +4 -4
  10. package/dist/index.js +1 -1
  11. package/dist/results-driver/src/driver/VizzlyQuery/AreaChart/toQueries.d.ts +1 -1
  12. package/dist/results-driver/src/driver/VizzlyQuery/BarChart/toQueries.d.ts +1 -1
  13. package/dist/results-driver/src/driver/VizzlyQuery/BasicTable/toQueries.d.ts +1 -1
  14. package/dist/results-driver/src/driver/VizzlyQuery/HorizontalBarChart/toQueries.d.ts +1 -1
  15. package/dist/results-driver/src/driver/VizzlyQuery/LineChart/toQueries.d.ts +1 -1
  16. package/dist/results-driver/src/driver/VizzlyQuery/PieChart/toQueries.d.ts +1 -1
  17. package/dist/results-driver/src/driver/VizzlyQuery/PivotTable/toQueries.d.ts +1 -1
  18. package/dist/services/src/Services/Cell.d.ts +65 -0
  19. package/dist/services/src/Services/Dashboard.d.ts +55 -0
  20. package/dist/services/src/Services/Header.d.ts +19 -0
  21. package/dist/services/src/Services/Library.d.ts +43 -0
  22. package/dist/services/src/Services/Row.d.ts +45 -0
  23. package/dist/services/src/Services/View.d.ts +65 -0
  24. package/dist/services/src/errors/ServicesValidationError.d.ts +2 -0
  25. package/dist/services/src/errors/TimeoutWaitingForVizzlyInstance.d.ts +3 -0
  26. package/dist/services/src/errors/VizzlyInstanceNotLoaded.d.ts +3 -0
  27. package/dist/services/src/index.d.ts +125 -0
  28. package/dist/services/src/schemaValidations/cell.d.ts +1 -0
  29. package/dist/services/src/schemaValidations/dashboard.d.ts +4 -0
  30. package/dist/services/src/schemaValidations/filters.d.ts +3 -0
  31. package/dist/services/src/schemaValidations/library.d.ts +2 -0
  32. package/dist/shared-logic/src/Callbacks/types.d.ts +2 -0
  33. package/dist/shared-logic/src/Dashboard/fromRaw.d.ts +4 -0
  34. package/dist/shared-logic/src/Dashboard/types.d.ts +8 -0
  35. package/dist/shared-logic/src/DashboardAPI/dashboardAPI.d.ts +0 -10
  36. package/dist/shared-logic/src/DashboardAPI/dataSets.d.ts +3 -11
  37. package/dist/shared-logic/src/FeatureToggle/types.d.ts +1 -0
  38. package/dist/shared-logic/src/GlobalLibrary/GlobalLibrary.d.ts +1 -0
  39. package/dist/shared-logic/src/GlobalLibrary/fromRaw.d.ts +10 -0
  40. package/dist/shared-logic/src/GlobalLibrary/index.d.ts +2 -0
  41. package/dist/shared-logic/src/GlobalLibrary/types.d.ts +16 -0
  42. package/dist/shared-logic/src/PDFGenerator/generatePNG.d.ts +3 -0
  43. package/dist/shared-logic/src/PDFGenerator/pageBreaks.d.ts +5 -0
  44. package/dist/shared-logic/src/QueryEngineConfig/loadQueryEngineConfig.d.ts +2 -2
  45. package/dist/shared-logic/src/Theme/types.d.ts +1 -0
  46. package/dist/shared-logic/src/Translations/translation.types.d.ts +43 -8
  47. package/dist/shared-logic/src/ViewConfiguration/types.d.ts +4 -0
  48. package/dist/shared-logic/src/api/index.d.ts +15 -35
  49. package/dist/shared-logic/src/api/queryEngine/getTeamMembers.d.ts +2 -2
  50. package/dist/shared-logic/src/errors/LoadingAborted.d.ts +4 -0
  51. package/dist/shared-logic/src/errors/index.d.ts +2 -1
  52. package/dist/shared-logic/src/getVizzly.d.ts +5 -0
  53. package/dist/shared-ui/src/api/useQueryEffect/download.d.ts +1 -1
  54. package/dist/shared-ui/src/base/explorer/Code.d.ts +49 -0
  55. package/dist/shared-ui/src/base/explorer/ExplorerPanel.d.ts +19 -0
  56. package/dist/shared-ui/src/base/explorer/ListOfFeatures.d.ts +25 -0
  57. package/dist/shared-ui/src/base/explorer/MoreIcon.d.ts +2 -0
  58. package/dist/shared-ui/src/base/explorer/ProgrammaticSection/DashboardFiltersSection.d.ts +3 -0
  59. package/dist/shared-ui/src/base/explorer/ProgrammaticSection/OtherSection.d.ts +3 -0
  60. package/dist/shared-ui/src/base/explorer/ProgrammaticSection/ProgrammaticSection.d.ts +10 -0
  61. package/dist/shared-ui/src/base/explorer/StudioWithExplorer.d.ts +11 -0
  62. package/dist/shared-ui/src/base/explorer/ThemeSection/ButtonsExplorer.d.ts +3 -0
  63. package/dist/shared-ui/src/base/explorer/ThemeSection/ChartsExplorer.d.ts +3 -0
  64. package/dist/shared-ui/src/base/explorer/ThemeSection/DashboardExplorer.d.ts +3 -0
  65. package/dist/shared-ui/src/base/explorer/ThemeSection/PanelsSection.d.ts +3 -0
  66. package/dist/shared-ui/src/base/explorer/ThemeSection/ThemeSection.d.ts +10 -0
  67. package/dist/shared-ui/src/base/explorer/ThemeSection/utils.funcs.d.ts +6 -0
  68. package/dist/shared-ui/src/base/explorer/Toggles/DeveloperToolsSection.d.ts +3 -0
  69. package/dist/shared-ui/src/base/explorer/Toggles/FeatureTogglesSection.d.ts +3 -0
  70. package/dist/shared-ui/src/base/explorer/Toggles/TogglesSection.d.ts +13 -0
  71. package/dist/shared-ui/src/base/explorer/functions/index.d.ts +7 -0
  72. package/dist/shared-ui/src/base/explorer/functions/index.test.d.ts +1 -0
  73. package/dist/shared-ui/src/components/Editor/EditorApp.d.ts +3 -0
  74. package/dist/shared-ui/src/components/Modals/ConfirmAddToLibraryModal.d.ts +5 -0
  75. package/dist/shared-ui/src/components/Modals/deleteModal.funcs.d.ts +1 -1
  76. package/dist/shared-ui/src/components/Studio/StudioApp/ComponentOptions.d.ts +2 -0
  77. package/dist/shared-ui/src/components/Studio/constants.d.ts +1 -1
  78. package/dist/shared-ui/src/contexts/DashboardBehaviour/types.d.ts +4 -3
  79. package/dist/shared-ui/src/contexts/DashboardContext/types.d.ts +15 -1
  80. package/dist/shared-ui/src/hooks/useVizzly.d.ts +32 -0
  81. package/dist/shared-ui/src/library/DataPanel/CustomFieldInput/PercentageModal/buildGroupedFilterValue.d.ts +3 -0
  82. package/dist/shared-ui/src/library/DataPanel/CustomFieldInput/PercentageModal/usePercentageModal.d.ts +2 -0
  83. package/dist/shared-ui/src/library/DataPanel/FilterInput/FilterInputForm.d.ts +1 -0
  84. package/dist/shared-ui/src/library/DataPanel/FilterInput/IndividualFilter.d.ts +1 -0
  85. package/dist/shared-ui/src/library/Editor/EditorComponent.d.ts +10 -0
  86. package/dist/shared-ui/src/library/Editor/useEditor.d.ts +2 -2
  87. package/dist/shared-ui/src/library/EditorModal.d.ts +4 -0
  88. package/dist/shared-ui/src/library/Library/types.d.ts +1 -0
  89. package/dist/shared-ui/src/library/ResizableRow.d.ts +1 -0
  90. package/dist/shared-ui/src/styles/global.styles.d.ts +2 -0
  91. package/dist/shared-ui/src/styles/styles.fn.d.ts +12 -0
  92. package/package.json +7 -6
  93. package/dist/dashboard/src/contexts/useDashboardAPI.d.ts +0 -36
  94. package/dist/dashboard/src/contexts/useDataConfigurationAndIdentity.d.ts +0 -21
  95. package/dist/dashboard/src/properties/queryEngineConfig.d.ts +0 -3
  96. package/dist/dashboard/src/sdk/Dashboard.d.ts +0 -15
  97. package/dist/dashboard/src/useDashboardManager/createDashboard.d.ts +0 -12
  98. package/dist/dashboard/src/useDashboardManager/deleteDashboard.d.ts +0 -4
  99. package/dist/dashboard/src/useDashboardManager/updateDashboardMeta.d.ts +0 -5
  100. package/dist/dashboard/src/useDashboardManager.d.ts +0 -36
  101. package/dist/shared-logic/src/DashboardAPI/clientDashboardSchema.d.ts +0 -3
  102. package/dist/shared-logic/src/DashboardAPI/dashboardAPI/creating.d.ts +0 -19
  103. package/dist/shared-logic/src/DashboardAPI/dashboardAPI/updating.d.ts +0 -19
  104. package/dist/shared-logic/src/DashboardAPI/dashboardManager.d.ts +0 -9
  105. package/dist/shared-logic/src/api/queryEngine/createDashboard.d.ts +0 -20
  106. package/dist/shared-logic/src/api/queryEngine/multiGetDashboards.d.ts +0 -7
  107. package/dist/shared-logic/src/api/queryEngine/updateDashboard.d.ts +0 -13
  108. package/dist/shared-logic/src/api/vizzly/createDashboard.d.ts +0 -20
  109. package/dist/shared-logic/src/api/vizzly/createDashboardAccess.d.ts +0 -8
  110. package/dist/shared-logic/src/api/vizzly/createQueryEngineUser.d.ts +0 -2
  111. package/dist/shared-logic/src/api/vizzly/getConnection.d.ts +0 -7
  112. package/dist/shared-logic/src/api/vizzly/getProject.d.ts +0 -3
  113. package/dist/shared-logic/src/api/vizzly/getProjects.d.ts +0 -3
  114. package/dist/shared-logic/src/api/vizzly/getQueryEngineUser.d.ts +0 -3
  115. package/dist/shared-logic/src/api/vizzly/getTeamMembers.d.ts +0 -11
  116. package/dist/shared-logic/src/api/vizzly/getVizzlyConfig.d.ts +0 -4
  117. package/dist/shared-logic/src/api/vizzly/multiGetDashboards.d.ts +0 -7
  118. package/dist/shared-logic/src/api/vizzly/multiGetEncryptedDashboards.d.ts +0 -7
  119. package/dist/shared-logic/src/api/vizzly/saveConnection.d.ts +0 -2
  120. package/dist/shared-logic/src/api/vizzly/saveEncryptedProjectEncryptionSecret.d.ts +0 -2
  121. package/dist/shared-logic/src/api/vizzly/updateDashboard.d.ts +0 -20
  122. package/dist/shared-logic/src/api/vizzly/updateQueryEngineUser.d.ts +0 -2
  123. package/dist/shared-ui/src/library/Editor.d.ts +0 -5
@@ -28,6 +28,7 @@ export declare type FeatureToggles = {
28
28
  canSeeEmptyState: boolean;
29
29
  canDownloadPDF: boolean;
30
30
  canDownloadViewData: boolean;
31
+ canDownloadViewAsPNG: boolean;
31
32
  canDownloadDataSet: boolean;
32
33
  forceMobile: boolean;
33
34
  };
@@ -0,0 +1 @@
1
+ export * from './fromRaw';
@@ -0,0 +1,10 @@
1
+ import { GlobalLibrary, GlobalLibraryLibrary } from './types';
2
+ export declare type RawGlobalLibrary = {
3
+ id: string;
4
+ name: string;
5
+ library: GlobalLibraryLibrary;
6
+ created_at: string;
7
+ updated_at: string;
8
+ parent_global_library_id: string;
9
+ };
10
+ export declare const fromRaw: (rawGlobalLibrary: RawGlobalLibrary) => GlobalLibrary;
@@ -0,0 +1,2 @@
1
+ export * from './GlobalLibrary';
2
+ export * from './types';
@@ -0,0 +1,16 @@
1
+ import { Component } from '../Component/types';
2
+ import { CustomField } from '../CustomField/types';
3
+ export declare type GlobalLibraryLibrary = {
4
+ views?: Component[];
5
+ customFields?: {
6
+ [dataSetId: string]: Array<CustomField>;
7
+ };
8
+ };
9
+ export declare type GlobalLibrary = {
10
+ id: string;
11
+ name: string;
12
+ library: GlobalLibraryLibrary;
13
+ createdAt: Date;
14
+ updatedAt: Date;
15
+ parentGlobalLibraryId: string;
16
+ };
@@ -0,0 +1,3 @@
1
+ import { TargetElementFinder, Options } from './types';
2
+ export declare const generatePNG: (targetRefOrFunction: TargetElementFinder, customOptions?: Options | undefined) => Promise<void>;
3
+ export default generatePNG;
@@ -0,0 +1,5 @@
1
+ import { DisplayRow } from '../Display/types';
2
+ export declare const getPDFGeneratorHeader: () => number;
3
+ export declare const insertPageBreaks: (display: DisplayRow[], headerHeight: number) => {
4
+ [rowIndex: number]: number;
5
+ };
@@ -1,3 +1,3 @@
1
1
  import { QueryEngineConfig, QueryEngineEndpoint } from '../QueryEngineConfig/types';
2
- import { loadQueryEngineConfigCallback } from '../Callbacks/types';
3
- export declare const loadQueryEngineConfig: (loadQueryEngineConfig: loadQueryEngineConfigCallback | QueryEngineEndpoint) => Promise<QueryEngineConfig>;
2
+ import { loadQueryEngineConfigCallback, loadDataSetsCallback } from '../Callbacks/types';
3
+ export declare const loadQueryEngineConfig: (loadQueryEngineConfig: loadQueryEngineConfigCallback | QueryEngineEndpoint, userProvidedLoadDataSetsCallback: loadDataSetsCallback | undefined) => Promise<QueryEngineConfig>;
@@ -10,6 +10,7 @@ export declare type Theme = {
10
10
  fontFamily?: string;
11
11
  fontSize?: number | string;
12
12
  rowLimit?: number;
13
+ cellLimit?: number;
13
14
  version?: ThemeVersion;
14
15
  };
15
16
  export declare namespace VizzlyTheming {
@@ -192,6 +192,13 @@ export declare type VizzlyTranslations = {
192
192
  * String containing the translation.
193
193
  */
194
194
  multi_select: string;
195
+ /**
196
+ * @default 'Number comparison'
197
+ *
198
+ * @returns
199
+ * String containing the translation.
200
+ */
201
+ numeric_filter: string;
195
202
  /**
196
203
  * @default 'Date picker'
197
204
  *
@@ -330,6 +337,13 @@ export declare type VizzlyTranslations = {
330
337
  * String containing the translation.
331
338
  */
332
339
  close: string;
340
+ /**
341
+ * @default 'Clear Filter'
342
+ *
343
+ * @returns
344
+ * String containing the translation.
345
+ */
346
+ clear_filter: string;
333
347
  /**
334
348
  * @default 'Click Settings'
335
349
  *
@@ -431,6 +445,13 @@ export declare type VizzlyTranslations = {
431
445
  * String containing the translation.
432
446
  */
433
447
  are_you_sure: string;
448
+ /**
449
+ * @default 'You are adding a View to the Template Library.'
450
+ *
451
+ * @returns
452
+ * String containing the translation.
453
+ */
454
+ add_view_to_the_library: string;
434
455
  /**
435
456
  * @default 'Delete'
436
457
  *
@@ -470,7 +491,21 @@ export declare type VizzlyTranslations = {
470
491
  */
471
492
  view_data_set_description: string;
472
493
  /**
473
- * @default 'Data download'
494
+ * @default 'View as PNG'
495
+ *
496
+ * @returns
497
+ * String containing the translation.
498
+ */
499
+ view_as_png: string;
500
+ /**
501
+ * @default 'Download the view as an image.'
502
+ *
503
+ * @returns
504
+ * String containing the translation.
505
+ */
506
+ view_as_png_description: string;
507
+ /**
508
+ * @default 'View download'
474
509
  *
475
510
  * @returns
476
511
  * String containing the translation.
@@ -811,6 +846,13 @@ export declare type VizzlyTranslations = {
811
846
  * String containing the translation.
812
847
  */
813
848
  manage_reports: string;
849
+ /**
850
+ * @default 'Add to Library'
851
+ *
852
+ * @returns
853
+ * String containing the translation.
854
+ */
855
+ add_to_library: string;
814
856
  /**
815
857
  * @default 'JSON Results'
816
858
  *
@@ -1455,13 +1497,6 @@ export declare type VizzlyTranslations = {
1455
1497
  * String containing the translation.
1456
1498
  */
1457
1499
  ask_ai: string;
1458
- /**
1459
- * @default 'Add to Library'
1460
- *
1461
- * @returns
1462
- * String containing the translation.
1463
- */
1464
- add_to_library: string;
1465
1500
  /**
1466
1501
  * @default 'There are no Views in your template library'
1467
1502
  *
@@ -0,0 +1,4 @@
1
+ import { QueryEngineConfig } from '../QueryEngineConfig/types';
2
+ export declare type ViewConfiguration = {
3
+ queryEngineConfig: QueryEngineConfig;
4
+ };
@@ -1,66 +1,46 @@
1
1
  import { ApiConfig } from '../ApiConfig';
2
+ /** @deprecated Use vizzly/api-client package instead */
2
3
  export declare const api: (config: ApiConfig) => {
4
+ /** @deprecated Use vizzly/api-client package instead */
3
5
  config: ApiConfig;
6
+ /** @deprecated Use vizzly/api-client package instead */
4
7
  getParentDashboards: () => Promise<{
5
8
  id: string;
6
9
  created_at: string;
7
10
  updated_at: string;
8
11
  webhook_id: string | null;
9
12
  }[] | undefined>;
13
+ /** @deprecated Use vizzly/api-client package instead */
10
14
  saveScheduledReport: (params: {
11
15
  dashboardAccessToken: string;
12
16
  scheduledReportId: string;
13
17
  cronSchedule: string | null;
14
18
  }) => Promise<boolean>;
15
- createDashboardAccess: (dashboardAccessToken: string, dashboardAdminOverrideToken: string | undefined, abortSignal: AbortSignal) => Promise<{
16
- permissions: import("../DashboardPermission/types").DashboardPermission[];
17
- }>;
18
- multiGetDashboards: (dashboardAccessTokens: string[], abortSignal: AbortSignal) => Promise<import("./vizzly/multiGetDashboards").Response>;
19
- multiGetEncryptedDashboards: (dashboardAccessTokens: string[]) => Promise<import("./vizzly/multiGetEncryptedDashboards").Response>;
20
- createDashboard: (params: import("./vizzly/createDashboard").CreateDashboardParams) => Promise<{
21
- dashboard: import("../Dashboard").RawDashboard<import("../typeHelpers").PartialBy<import("../Dashboard").SaveableDashboardDefinition, "isPlayground" | "customFields">>;
22
- permissions: import("../DashboardPermission/types").RawDashboardPermission[];
23
- }>;
24
- updateDashboard: (params: import("./vizzly/updateDashboard").UpdateDashboardParams) => Promise<import("./vizzly/updateDashboard").EncryptedDashboardUpdateResponse | import("./vizzly/updateDashboard").UnEncryptedDashboardUpdateResponse>;
19
+ /** @deprecated Use vizzly/api-client package instead */
25
20
  askAi: (conversationId: string | undefined, currentAttributes: import("../Component/types").Component.Attributes, question: string, dashboardAccessToken: string, dataSets: import("../DataSet/types").DataSet[], queryEngineConfig: import("../QueryEngineConfig/types").QueryEngineConfig, abortSignal: AbortSignal) => Promise<import("./vizzly/aiHelpers/types").AiConversation>;
21
+ /** @deprecated Use vizzly/api-client package instead */
26
22
  aiActions: (conversationId: string, messageId: string, dashboardAccessToken: string, options: import("./vizzly/aiActions").AIOptions) => Promise<import("./vizzly/aiActions").AIActionReponse>;
23
+ /** @deprecated Use vizzly/api-client package instead */
27
24
  askAiForQuestionSuggestions: (dashboardAccessToken: string, dataSets: import("../DataSet/types").DataSet[]) => Promise<import("./vizzly/aiHelpers/types").AskAiQuestionSuggestions>;
25
+ /** @deprecated Use vizzly/api-client package instead */
28
26
  createVizzlyConfigVersion: (projectId: string, encryptedVizzlyConfig: string) => Promise<boolean>;
29
- getVizzlyConfig: (projectId: string) => Promise<{
30
- encryptedConfig: string | null;
31
- } | undefined>;
32
- saveConnection: (projectId: string, encryptedConnection: string, encryptedConfig: string) => Promise<boolean>;
33
- getConnection: (projectId: string) => Promise<{
34
- status: number;
35
- encryptedCredentials: string;
36
- } | {
37
- status: number;
38
- }>;
27
+ /** @deprecated Use vizzly/api-client package instead */
39
28
  createProjectApiKey: (projectId: string) => Promise<string>;
29
+ /** @deprecated Use vizzly/api-client package instead */
40
30
  updateProjectApiKey: (projectId: string, projectApiKeyId: string, updateParams: {
41
31
  disabled: boolean;
42
32
  }) => Promise<string>;
33
+ /** @deprecated Use vizzly/api-client package instead */
43
34
  getProjectAccessToken: (projectId: string, appSessionAuthToken?: string | undefined, resourceFilters?: string[] | undefined) => Promise<string | undefined>;
44
- getProject: (projectId: string) => Promise<import("../Project/types").Project | null>;
45
- createQueryEngineUser: (projectId: string, email: string, password: string) => Promise<boolean>;
46
- updateQueryEngineUser: (projectId: string, updateQueryEngineUser: string, password: string) => Promise<boolean>;
47
- getQueryEngineUser: (projectId: string, email: string) => Promise<{
48
- id: string;
49
- password: string | null;
50
- user: {
51
- id: string;
52
- email: string;
53
- first_name: string;
54
- last_name: string;
55
- };
56
- } | undefined>;
57
- getProjectTeamMembers: (projectId: string) => Promise<import("./vizzly/getTeamMembers").TeamMember[] | undefined>;
35
+ /** @deprecated Use vizzly/api-client package instead */
58
36
  createSelfHostedQueryEngineProject: (appSessionToken?: string | undefined) => Promise<import("../Project/types").Project | undefined>;
37
+ /** @deprecated Use vizzly/api-client package instead */
59
38
  createSelfHostedDynamicQueryEngineProject: (appSessionToken?: string | undefined) => Promise<import("../Project/types").Project | undefined>;
39
+ /** @deprecated Use vizzly/api-client package instead */
60
40
  createSelfHostedInBrowserQueryEngineProject: (appSessionToken?: string | undefined) => Promise<import("../Project/types").Project | undefined>;
41
+ /** @deprecated Use vizzly/api-client package instead */
61
42
  getManagedQueryEngineKeyPair: (managedProjectId: string, keyPairId: string, appSessionToken?: string | undefined) => Promise<{
62
43
  publicKey: string;
63
44
  privateKey: string | null;
64
45
  } | undefined>;
65
- saveEncryptedProjectEncryptionSecret: (projectId: string, encryptedProjectEncryptionSecret: string, allowRotation?: boolean) => Promise<boolean>;
66
46
  };
@@ -1,3 +1,3 @@
1
1
  import { QueryEngineEndpoint } from '../../QueryEngineConfig/types';
2
- import { TeamMember } from '../vizzly/getTeamMembers';
3
- export declare const getTeamMembers: (queryEngineEndpoint: QueryEngineEndpoint, abortSignal?: AbortSignal | undefined) => Promise<Array<TeamMember> | undefined>;
2
+ import { TeamMemberFromAPI } from '@vizzly/api-client';
3
+ export declare const getTeamMembers: (queryEngineEndpoint: QueryEngineEndpoint, abortSignal?: AbortSignal | undefined) => Promise<Array<TeamMemberFromAPI> | undefined>;
@@ -0,0 +1,4 @@
1
+ declare class LoadingAborted extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export default LoadingAborted;
@@ -2,4 +2,5 @@ import AIUsageLimitReached from './AIUsageLimitReached';
2
2
  import AIFailedToFetch from '../errors/AIFailedToFetch';
3
3
  import AIContainsErrors from '../errors/AIContainsErrors';
4
4
  import AIAborted from '../errors/AIAborted';
5
- export { AIUsageLimitReached, AIFailedToFetch, AIContainsErrors, AIAborted };
5
+ import LoadingAborted from '../errors/LoadingAborted';
6
+ export { AIUsageLimitReached, AIFailedToFetch, AIContainsErrors, AIAborted, LoadingAborted };
@@ -0,0 +1,5 @@
1
+ import { Vizzly } from '@vizzly/api-client';
2
+ import { ApiConfig } from './ApiConfig';
3
+ import { DashboardStorageStrategy } from './DashboardAPI/types';
4
+ import { IdentityConfig } from './IdentityConfig/types';
5
+ export declare const getVizzlyAPIClient: (identityConfig: IdentityConfig | undefined, dashboardStorageStrategy: DashboardStorageStrategy, apiConfig: ApiConfig) => Vizzly;
@@ -4,7 +4,7 @@ import { FilterConfig } from '../../../../shared-logic/src/AdditionalFilter/type
4
4
  import { DashboardBehaviour } from '../../contexts/DashboardBehaviour/types';
5
5
  import { DataSet as DataSetType } from '../../../../shared-logic/src/DataSet/types';
6
6
  import { TableRepresentation } from '../../../../shared-logic/src/DataTable/types';
7
- export declare type DownloadType = 'data-set-download-type' | 'view-download-type';
7
+ export declare type DownloadType = 'data-set-download-type' | 'view-download-type' | 'view-as-png';
8
8
  declare type OnCSVGenerated = (csvContent: string) => void;
9
9
  export declare const _toCSV: (tableRepresentation: TableRepresentation | null | undefined, onCSVGenerated: OnCSVGenerated) => void;
10
10
  export declare const download: (downloadType: DownloadType, dataSet: DataSetType, runQueriesCallback: VizzlyComponents.runQueriesCallbackInternal, maxCSVDownloadLimit: number, attributes: Component.Attributes, dateTimeFormatOptions: DashboardBehaviour['dateTimeFormatOptions'], numberFormatOptions: DashboardBehaviour['numberFormatOptions'], queryEngineConfig: DashboardBehaviour['queryEngineConfig'], populatedFilterConfig: FilterConfig, onCSVGenerated: ((csvContent: string) => void) | undefined, labelFormat: DashboardBehaviour['labelFormat']) => Promise<void>;
@@ -0,0 +1,49 @@
1
+ import { FunctionComponent, ReactNode } from 'react';
2
+ export declare const CodeBase: FunctionComponent<{
3
+ children: ReactNode;
4
+ }>;
5
+ export declare const Code: FunctionComponent<{
6
+ children: ReactNode;
7
+ }> & {
8
+ Row: FunctionComponent<{
9
+ indent: number;
10
+ children: ReactNode;
11
+ }>;
12
+ Text: FunctionComponent<{}>;
13
+ Input: FunctionComponent<{
14
+ label: string;
15
+ name: string;
16
+ value?: string | undefined;
17
+ onChange: (value: string) => boolean;
18
+ size: 'sm' | 'md';
19
+ }>;
20
+ Select: FunctionComponent<{
21
+ label: string;
22
+ name: string;
23
+ value?: string | undefined;
24
+ options: {
25
+ label: string;
26
+ value: string;
27
+ }[];
28
+ className?: string | undefined;
29
+ onChange: (value: string) => void;
30
+ size: 'sm' | 'md';
31
+ }>;
32
+ };
33
+ export declare const codeStyles: (() => null) & {
34
+ font: {
35
+ (variantOptions: Object): string;
36
+ toString: any;
37
+ };
38
+ inputWrapper: {
39
+ (variantOptions: Object): string;
40
+ toString: any;
41
+ };
42
+ input: {
43
+ (variantOptions: Object): string;
44
+ toString: any;
45
+ };
46
+ };
47
+ export declare const CodeSnippet: FunctionComponent<{
48
+ children: ReactNode;
49
+ }>;
@@ -0,0 +1,19 @@
1
+ import React from 'react';
2
+ import { DataSet } from '@vizzly/dashboard/src';
3
+ import { FeatureToggles } from '../../../../shared-logic/src/FeatureToggle/types';
4
+ import { VizzlyTheming } from '../../../../shared-ui/src';
5
+ import { ExplorerState } from './useExplorer';
6
+ export declare type ExplorerProps = {
7
+ explorerState?: ExplorerState;
8
+ setDashboardFilters: (payload: ExplorerState) => void;
9
+ setFeatureToggles: (payload: Partial<FeatureToggles>) => void;
10
+ setDeveloperTools: (payload: Partial<ExplorerState['developerTools']>) => void;
11
+ setTheme: (payload: Partial<VizzlyTheming.Base>) => void;
12
+ dataSets?: DataSet[];
13
+ initialFeatureToggles: Partial<FeatureToggles>;
14
+ };
15
+ export declare const Explorer: React.FunctionComponent<ExplorerProps>;
16
+ export declare const innerPanel: {
17
+ (variantOptions: Object): string;
18
+ toString: any;
19
+ };
@@ -0,0 +1,25 @@
1
+ import React, { ReactNode } from 'react';
2
+ export declare type SectionType = {
3
+ name: string;
4
+ icon: React.ReactNode;
5
+ hideName?: boolean;
6
+ url?: string;
7
+ docUrl?: string;
8
+ };
9
+ export declare const Feature: React.FunctionComponent<{
10
+ children: ReactNode;
11
+ sections: SectionType[];
12
+ selectedFeature?: SectionType | undefined;
13
+ onChange: (section: SectionType) => void;
14
+ }> & {
15
+ Section: React.FunctionComponent<{
16
+ children: ReactNode;
17
+ title: string;
18
+ tooltip?: string | undefined;
19
+ tooltipUrl?: string | undefined;
20
+ }>;
21
+ Content: React.FunctionComponent<{
22
+ children: ReactNode;
23
+ className?: string | undefined;
24
+ }>;
25
+ };
@@ -0,0 +1,2 @@
1
+ /// <reference types="react" />
2
+ export declare const MoreIcon: () => JSX.Element;
@@ -0,0 +1,3 @@
1
+ import { FunctionComponent } from 'react';
2
+ import { ProgrammaticSectionProps } from './ProgrammaticSection';
3
+ export declare const DashboardFiltersSection: FunctionComponent<ProgrammaticSectionProps>;
@@ -0,0 +1,3 @@
1
+ import { FunctionComponent } from 'react';
2
+ import { ProgrammaticSectionProps } from './ProgrammaticSection';
3
+ export declare const OtherSection: FunctionComponent<ProgrammaticSectionProps>;
@@ -0,0 +1,10 @@
1
+ import { FunctionComponent, ReactNode } from 'react';
2
+ import { DataSet } from '@vizzly/dashboard/src';
3
+ import { ExplorerState } from '../useExplorer';
4
+ export declare type ProgrammaticSectionProps = {
5
+ explorerState: ExplorerState;
6
+ setDashboardFilters: (payload: ExplorerState) => void;
7
+ dataSets?: DataSet[];
8
+ setNoticeContent: (value: ReactNode | undefined) => void;
9
+ };
10
+ export declare const ProgrammaticSection: FunctionComponent<ProgrammaticSectionProps>;
@@ -0,0 +1,11 @@
1
+ import { FunctionComponent, ReactNode } from 'react';
2
+ import { ExplorerProps } from './ExplorerPanel';
3
+ export declare const PANEL_WIDTH = 352;
4
+ export declare const StudioWithExplorer: FunctionComponent<{
5
+ children: ReactNode;
6
+ mobile: boolean;
7
+ } & ExplorerProps>;
8
+ export declare const sidePanel: {
9
+ (variantOptions: Object): string;
10
+ toString: any;
11
+ };
@@ -0,0 +1,3 @@
1
+ import { FunctionComponent } from 'react';
2
+ import { ThemeStateProps } from './ThemeSection';
3
+ export declare const ButtonsSection: FunctionComponent<ThemeStateProps>;
@@ -0,0 +1,3 @@
1
+ import { FunctionComponent } from 'react';
2
+ import { ThemeStateProps } from './ThemeSection';
3
+ export declare const ChartsSection: FunctionComponent<ThemeStateProps>;
@@ -0,0 +1,3 @@
1
+ import { FunctionComponent } from 'react';
2
+ import { ThemeStateProps } from './ThemeSection';
3
+ export declare const DashboardSection: FunctionComponent<ThemeStateProps>;
@@ -0,0 +1,3 @@
1
+ import { FunctionComponent } from 'react';
2
+ import { ThemeStateProps } from './ThemeSection';
3
+ export declare const PanelsSection: FunctionComponent<ThemeStateProps>;
@@ -0,0 +1,10 @@
1
+ import { ReactNode } from 'react';
2
+ import { FunctionComponent } from 'react';
3
+ import { VizzlyTheming } from '../../../../../shared-ui/src';
4
+ import { ExplorerState } from '../useExplorer';
5
+ export declare type ThemeStateProps = {
6
+ explorerState: ExplorerState;
7
+ setTheme: (value: Partial<VizzlyTheming.Base>) => void;
8
+ setNoticeContent: (value: ReactNode | undefined) => void;
9
+ };
10
+ export declare const ThemeSection: FunctionComponent<ThemeStateProps>;
@@ -0,0 +1,6 @@
1
+ export declare function isValidFontSize(fontSize: string): boolean;
2
+ export declare function isValidFontWeight(fontWeight: string): boolean;
3
+ export declare function isValidCssColor(color: string): boolean;
4
+ export declare function isValidBorder(border: string): boolean;
5
+ export declare function isValidPadding(padding: string): boolean;
6
+ export declare function appendPxIfNumber(value: string | number | undefined): string | undefined;
@@ -0,0 +1,3 @@
1
+ import { FunctionComponent } from 'react';
2
+ import { ToggleProps } from './TogglesSection';
3
+ export declare const DeveloperToolsSection: FunctionComponent<ToggleProps>;
@@ -0,0 +1,3 @@
1
+ import { FunctionComponent } from 'react';
2
+ import { ToggleProps } from './TogglesSection';
3
+ export declare const FeatureTogglesSection: FunctionComponent<ToggleProps>;
@@ -0,0 +1,13 @@
1
+ import { FunctionComponent, ReactNode } from 'react';
2
+ import { FeatureToggles } from '../../../../../shared-logic/src/FeatureToggle/types';
3
+ import { ExplorerState } from '../useExplorer';
4
+ import { DeveloperTools } from '../../../contexts/DashboardBehaviour/types';
5
+ export declare type ToggleProps = {
6
+ explorerState: ExplorerState;
7
+ setFeatureToggles: (payload: Partial<FeatureToggles>) => void;
8
+ setDeveloperTools: (payload: Partial<DeveloperTools>) => void;
9
+ initialFeatureToggles: Partial<FeatureToggles>;
10
+ initialDeveloperTools: Partial<DeveloperTools>;
11
+ setNoticeContent: (value: ReactNode | undefined) => void;
12
+ };
13
+ export declare const TogglesSection: FunctionComponent<ToggleProps>;
@@ -0,0 +1,7 @@
1
+ import { AdditionalFilter } from '../../../../../shared-logic/src/AdditionalFilter/types';
2
+ import { DataSet } from '../../../../../shared-logic/src/DataSet/types';
3
+ export declare type ExplorerDashboard = {
4
+ dataSets: DataSet[];
5
+ };
6
+ export declare function areFiltersAvailable(explorerDashboard?: ExplorerDashboard): boolean | undefined;
7
+ export declare function defaultStringFilter(dataSet?: DataSet, dashboardFilter?: AdditionalFilter): AdditionalFilter;
@@ -0,0 +1,3 @@
1
+ import { FunctionComponent } from 'react';
2
+ declare const EditorApp: FunctionComponent;
3
+ export default EditorApp;
@@ -0,0 +1,5 @@
1
+ import { FunctionComponent } from 'react';
2
+ export declare const ConfirmAddToLibraryModal: FunctionComponent<{
3
+ show: boolean;
4
+ onClose: (confirmed: boolean) => void;
5
+ }>;
@@ -1,2 +1,2 @@
1
1
  import { FeatureToggles } from '../../../../shared-logic/src/FeatureToggle/types';
2
- export declare const initialDownloadType: (featureToggles: FeatureToggles) => "data-set-download-type" | "view-download-type" | undefined;
2
+ export declare const initialDownloadType: (featureToggles: FeatureToggles) => "data-set-download-type" | "view-download-type" | "view-as-png" | undefined;
@@ -19,6 +19,7 @@ export declare const PopulatedComponentOptions: (props: {
19
19
  onAddFilter: () => void;
20
20
  onClickSettings: () => void;
21
21
  onSetParameters: () => void;
22
+ onAddToLibrary: () => void;
22
23
  canDownloadComponentData: boolean;
23
24
  canEditComponentsOnDashboard: boolean;
24
25
  canRemoveComponentsFromDashboard: boolean;
@@ -33,3 +34,4 @@ export declare const UnPopulatedComponentOptions: (props: {
33
34
  }) => JSX.Element | null;
34
35
  export declare const DeleteIcon: () => JSX.Element;
35
36
  export declare const EditIcon: () => JSX.Element;
37
+ export declare const AddIcon: () => JSX.Element;
@@ -1,5 +1,5 @@
1
1
  export declare const ACTION_ROW_WIDTH_PX = 32;
2
- export declare const MAXIMUM_CELLS = 6;
2
+ export declare const MAXIMUM_CELLS = 4;
3
3
  export declare const TOTAL_SPAN = 12;
4
4
  export declare const DASHBOARD_GAP = 8;
5
5
  export declare const getScrollbarWidth: () => number;
@@ -7,11 +7,12 @@ import { DataPanelConfig, DataPanelSection } from '../../../../shared-logic/src/
7
7
  import { FormatPanelConfig, FormatPanelSection } from '../../../../shared-logic/src/FormatPanelConfig/types';
8
8
  import { DataSet } from '../../../../shared-logic/src/DataSet/types';
9
9
  import { Component } from '../../../../shared-logic/src/Component/types';
10
- import { Dashboard, SaveableDashboardDefinition } from '../../../../shared-logic/src/Dashboard/types';
10
+ import { Dashboard } from '../../../../shared-logic/src/Dashboard/types';
11
11
  import { AdditionalFilter } from '../../../../shared-logic/src/AdditionalFilter/types';
12
12
  import { DateTimeFilterOptions } from '../../../../shared-logic/src/DateTime/types';
13
13
  import { VizzlyTranslations } from '../../../../shared-logic/src/Translations/translation.types';
14
14
  import { PDFSettings } from '../../../../shared-logic/src/PDFGenerator/types';
15
+ import { programmaticDashboardCallback } from '../../../../shared-logic/src/Callbacks/types';
15
16
  declare type OverrideDeveloperInfo = {
16
17
  overrideKey: string;
17
18
  componentProps: any;
@@ -87,11 +88,11 @@ export declare type DashboardBehaviour = {
87
88
  type: ComponentType;
88
89
  }) => Array<FormatPanelSection | ((sectionProps: VizzlyComponents.EditorSectionProps<Component.Attributes>) => JSX.Element)>;
89
90
  onError?: VizzlyComponents.OnError;
90
- parentDashboard?: (dataSets: DataSet[]) => Promise<Array<Partial<SaveableDashboardDefinition>>>;
91
+ parentDashboard?: programmaticDashboardCallback;
91
92
  onReset: () => Promise<Dashboard | null>;
92
93
  onScheduledReportChange: (reportId: string, newCron: string | null) => Promise<'saved' | 'deleted' | null>;
93
94
  onEditorUpdate: (newAttributes: Component.Attributes, dataSet: DataSet, reason: 'initial' | 'edit') => Partial<Component.Attributes>;
94
- onSave: (dashboard: Dashboard) => void;
95
+ onSave: (dashboard: Dashboard, abortSignal?: AbortSignal) => void;
95
96
  onOpenConfigManagerUi: undefined | (() => void);
96
97
  dashboardFilters: (dataSets: Array<DataSet>, userDefinedDashboardFilters: DashboardFilters) => DashboardFilters;
97
98
  onDashboardFilterChange: (additionalFilters: AdditionalFilter[]) => void;
@@ -158,6 +158,11 @@ export declare type SetAttributesAction = {
158
158
  rowIndex: number;
159
159
  cellIndex: number;
160
160
  };
161
+ export declare type AddComponentToLibrary = {
162
+ type: 'addComponentToLibrary';
163
+ component: Component;
164
+ protectedComponent: boolean;
165
+ };
161
166
  export declare type SetHeaderComponentAction = {
162
167
  type: 'setHeaderComponent';
163
168
  component: HeaderComponent;
@@ -201,7 +206,16 @@ export declare type PickComponentFromLibraryForDisplayAction = {
201
206
  export declare type InitAction = {
202
207
  type: 'init';
203
208
  };
204
- export declare type StudioAction = InitAction | SetDashboardAction | SaveComponentAction | ClearModalAction | InsertRowAction | AppendCellAction | AddHeaderRowAction | SetHeaderComponentAction | RemoveCellAction | ClearCellAction | RemoveRowAction | AddDataSetAction | RemoveDataSetAction | SetDataSetsAction | SetLocalFiltersAction | SetAttributesAction | UpdateEditorComponentAction | SetResultsForComponentInDisplayAction | SetResultsForComponentInEditorAction | SetResultsForComponentInLibraryAction | StartEditingComponentAction | StartPickingComponentFromLibraryForDisplayAction | PickComponentFromLibraryForDisplayAction | SetThemeAction | SetGlobalFiltersAction | ChangePreviewModeAction | UpdateDisplayComponentAttributesAction | UpdateComponentLibraryAttributesAction | RemoveComponentFromLibraryAction | AddCustomComponentAction | SetColSpansAction | SetRowHeightAction | SetComponentReportsAction | SwapComponentsAction | SetParameterBasedUpdateAction;
209
+ export declare type StartEditorAction = {
210
+ type: 'startEditor';
211
+ libraryIndex: number | null;
212
+ component: Component | null;
213
+ };
214
+ export declare type SaveViewToGlobalLibrary = {
215
+ type: 'saveViewToGlobalLibrary';
216
+ globalLibraryId?: string;
217
+ };
218
+ export declare type StudioAction = InitAction | SetDashboardAction | SaveComponentAction | ClearModalAction | InsertRowAction | AppendCellAction | AddHeaderRowAction | SetHeaderComponentAction | RemoveCellAction | ClearCellAction | RemoveRowAction | AddDataSetAction | RemoveDataSetAction | SetDataSetsAction | SetLocalFiltersAction | SetAttributesAction | UpdateEditorComponentAction | SetResultsForComponentInDisplayAction | SetResultsForComponentInEditorAction | SetResultsForComponentInLibraryAction | StartEditingComponentAction | StartPickingComponentFromLibraryForDisplayAction | PickComponentFromLibraryForDisplayAction | SetThemeAction | SetGlobalFiltersAction | ChangePreviewModeAction | UpdateDisplayComponentAttributesAction | UpdateComponentLibraryAttributesAction | RemoveComponentFromLibraryAction | AddCustomComponentAction | SetColSpansAction | SetRowHeightAction | SetComponentReportsAction | SwapComponentsAction | SetParameterBasedUpdateAction | AddComponentToLibrary | StartEditorAction;
205
219
  export declare type PipelineTransformationOptions = {
206
220
  dashboardFilters: DashboardBehaviour['dashboardFilters'];
207
221
  onDashboardFilterChange: DashboardBehaviour['onDashboardFilterChange'];