@vizzly/services 0.7.0 → 0.7.1-dev-b20a0c09c1eedef43690cbdff448965dfea9c70a

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 (108) hide show
  1. package/dist/index.js +1 -1
  2. package/dist/services/src/Services/APIServices.d.ts +153 -0
  3. package/dist/services/src/Services/CellServices.d.ts +4 -4
  4. package/dist/services/src/Services/ComponentLibraryServices.d.ts +4 -4
  5. package/dist/services/src/Services/DashboardServices.d.ts +1 -1
  6. package/dist/services/src/Services/ViewServices.d.ts +61 -0
  7. package/dist/services/src/index.d.ts +17 -13
  8. package/dist/shared-logic/src/AI/types.d.ts +12 -0
  9. package/dist/shared-logic/src/ApiResource/index.d.ts +7 -0
  10. package/dist/shared-logic/src/AreaChart/attributesSchema.d.ts +1 -1
  11. package/dist/shared-logic/src/BarChart/attributesSchema.d.ts +1 -1
  12. package/dist/shared-logic/src/Base64/index.d.ts +3 -0
  13. package/dist/shared-logic/src/BasicTable/attributesSchema.d.ts +1 -1
  14. package/dist/shared-logic/src/ComboChart/attributesSchema.d.ts +1 -1
  15. package/dist/shared-logic/src/Component/Component.d.ts +1 -3
  16. package/dist/shared-logic/src/Component/attributesSchema.d.ts +2 -2
  17. package/dist/shared-logic/src/Component/constants.d.ts +4 -0
  18. package/dist/shared-logic/src/Component/setAttributes.d.ts +1 -1
  19. package/dist/shared-logic/src/Component/sharedSchemas.d.ts +8 -7
  20. package/dist/shared-logic/src/Component/types.d.ts +30 -2
  21. package/dist/shared-logic/src/ComponentInterface/types.d.ts +3 -1
  22. package/dist/shared-logic/src/DashboardAPI/dashboardAPI/creating.d.ts +18 -0
  23. package/dist/shared-logic/src/DashboardAPI/dashboardAPI/updating.d.ts +16 -0
  24. package/dist/shared-logic/src/DashboardAPI/dashboardAPI.d.ts +17 -0
  25. package/dist/shared-logic/src/DashboardAPI/dashboardManager.d.ts +6 -0
  26. package/dist/shared-logic/src/DashboardAPI/dataConfigurationAndIdentity.d.ts +7 -0
  27. package/dist/shared-logic/src/DashboardAPI/dataSets.d.ts +12 -0
  28. package/dist/shared-logic/src/DashboardAPI/getDashboardAdminOverride.d.ts +1 -0
  29. package/dist/shared-logic/src/DashboardAPI/types.d.ts +17 -0
  30. package/dist/shared-logic/src/DashboardPermission/index.d.ts +7 -0
  31. package/dist/shared-logic/src/DashboardPermission/types.d.ts +12 -0
  32. package/dist/shared-logic/src/DataPanelConfig/types.d.ts +8 -1
  33. package/dist/shared-logic/src/DataTable/attributesSchema.d.ts +1 -1
  34. package/dist/shared-logic/src/DataTable/types.d.ts +1 -0
  35. package/dist/shared-logic/src/Documentation/index.d.ts +2 -0
  36. package/dist/shared-logic/src/Documentation/joiToDocumentation.d.ts +4 -0
  37. package/dist/shared-logic/src/Documentation/joiToSchemaDefinition.d.ts +2 -0
  38. package/dist/shared-logic/src/FormatPanelConfig/types.d.ts +5 -1
  39. package/dist/shared-logic/src/IdentityConfig/IdentityConfig.d.ts +4 -0
  40. package/dist/shared-logic/src/IdentityConfig/index.d.ts +1 -0
  41. package/dist/shared-logic/src/JWT/JWT.d.ts +2 -0
  42. package/dist/shared-logic/src/LineChart/attributesSchema.d.ts +1 -1
  43. package/dist/shared-logic/src/MercatorMap/attributesSchema.d.ts +1 -1
  44. package/dist/shared-logic/src/PieChart/attributesSchema.d.ts +1 -1
  45. package/dist/shared-logic/src/Progress/attributesSchema.d.ts +3 -0
  46. package/dist/shared-logic/src/Progress/index.d.ts +5 -0
  47. package/dist/shared-logic/src/Progress/types.d.ts +2 -0
  48. package/dist/shared-logic/src/Project/types.d.ts +67 -0
  49. package/dist/shared-logic/src/Query/validate.d.ts +6 -6
  50. package/dist/shared-logic/src/ScatterChart/attributesSchema.d.ts +1 -1
  51. package/dist/shared-logic/src/SingleStat/attributesSchema.d.ts +1 -1
  52. package/dist/shared-logic/src/SingleStat/upcastSingleValueAttributes.d.ts +4 -0
  53. package/dist/shared-logic/src/Table/attributesSchema.d.ts +1 -1
  54. package/dist/shared-logic/src/Theme/types.d.ts +7 -0
  55. package/dist/shared-logic/src/api/httpClient.d.ts +1 -0
  56. package/dist/shared-logic/src/api/index.d.ts +71 -0
  57. package/dist/shared-logic/src/api/queryEngine/createDashboard.d.ts +18 -0
  58. package/dist/shared-logic/src/api/queryEngine/fetchDataSets.d.ts +4 -0
  59. package/dist/shared-logic/src/api/queryEngine/multiGetDashboards.d.ts +7 -0
  60. package/dist/shared-logic/src/api/queryEngine/updateDashboard.d.ts +13 -0
  61. package/dist/shared-logic/src/api/types.d.ts +1 -0
  62. package/dist/shared-logic/src/api/vizzly/askAi/types.d.ts +2 -0
  63. package/dist/shared-logic/src/api/vizzly/askAi/validateAndUpcast.d.ts +5 -0
  64. package/dist/shared-logic/src/api/vizzly/askAi.d.ts +12 -0
  65. package/dist/shared-logic/src/api/vizzly/createDashboard.d.ts +18 -0
  66. package/dist/shared-logic/src/api/vizzly/createDashboardAccess.d.ts +8 -0
  67. package/dist/shared-logic/src/api/vizzly/createProjectApiKey.d.ts +2 -0
  68. package/dist/shared-logic/src/api/vizzly/createQueryEngineUser.d.ts +2 -0
  69. package/dist/shared-logic/src/api/vizzly/createSelfHostedDynamicQueryEngine.d.ts +3 -0
  70. package/dist/shared-logic/src/api/vizzly/createSelfHostedInBrowserQueryEngineProject.d.ts +3 -0
  71. package/dist/shared-logic/src/api/vizzly/createSelfHostedQueryEngineProject.d.ts +3 -0
  72. package/dist/shared-logic/src/api/vizzly/createVizzlyConfigVersion.d.ts +2 -0
  73. package/dist/shared-logic/src/api/vizzly/getConnection.d.ts +7 -0
  74. package/dist/shared-logic/src/api/vizzly/getManagedQueryEngineKeyPair.d.ts +5 -0
  75. package/dist/shared-logic/src/api/vizzly/getParentDashboards.d.ts +9 -0
  76. package/dist/shared-logic/src/api/vizzly/getProject.d.ts +3 -0
  77. package/dist/shared-logic/src/api/vizzly/getQueryEngineUser.d.ts +3 -0
  78. package/dist/shared-logic/src/api/vizzly/getTeamMembers.d.ts +11 -0
  79. package/dist/shared-logic/src/api/vizzly/getVizzlyConfig.d.ts +4 -0
  80. package/dist/shared-logic/src/api/vizzly/multiGetDashboards.d.ts +7 -0
  81. package/dist/shared-logic/src/api/vizzly/multiGetEncryptedDashboards.d.ts +7 -0
  82. package/dist/shared-logic/src/api/vizzly/saveConnection.d.ts +2 -0
  83. package/dist/shared-logic/src/api/vizzly/saveEncryptedProjectEncryptionSecret.d.ts +2 -0
  84. package/dist/shared-logic/src/api/vizzly/saveScheduledReport.d.ts +6 -0
  85. package/dist/shared-logic/src/api/vizzly/updateDashboard.d.ts +18 -0
  86. package/dist/shared-logic/src/api/vizzly/updateProjectApiKey.d.ts +6 -0
  87. package/dist/shared-logic/src/errors/AIUsageLimitReached.d.ts +4 -0
  88. package/dist/shared-logic/src/errors/CorruptedView.d.ts +1 -1
  89. package/dist/shared-logic/src/errors/DashboardQuotaReached.d.ts +4 -0
  90. package/dist/shared-logic/src/errors/EncryptedProjectSecretAlreadyExists.d.ts +4 -0
  91. package/dist/shared-logic/src/errors/FailedToCreateDashboard.d.ts +4 -0
  92. package/dist/shared-logic/src/errors/FailedToCreateDashboardAccess.d.ts +4 -0
  93. package/dist/shared-logic/src/errors/FailedToGetDashboard.d.ts +4 -0
  94. package/dist/shared-logic/src/errors/FailedToLoadIdentity.d.ts +4 -0
  95. package/dist/shared-logic/src/errors/FailedToResolveDataSets.d.ts +4 -0
  96. package/dist/shared-logic/src/errors/FailedToSaveVizzlyConfigVersion.d.ts +3 -0
  97. package/dist/shared-logic/src/errors/FailedToUpdateDashboard.d.ts +4 -0
  98. package/dist/shared-logic/src/errors/InvalidDataSetsPropType.d.ts +4 -0
  99. package/dist/shared-logic/src/errors/InvalidIdentityReturn.d.ts +4 -0
  100. package/dist/shared-logic/src/errors/ProjectEncryptedSecretAlreadySaved.d.ts +4 -0
  101. package/dist/shared-logic/src/errors/ReadOnlyPermissionNotFound.d.ts +4 -0
  102. package/dist/shared-logic/src/errors/ReadPermissionNotFound.d.ts +4 -0
  103. package/dist/shared-logic/src/errors/VizzlyApiCallErrorFailedToSetupProject.d.ts +4 -0
  104. package/dist/shared-logic/src/errors/WritePermissionNotFound.d.ts +4 -0
  105. package/dist/shared-logic/src/getComponentInterface.d.ts +1 -0
  106. package/package.json +1 -1
  107. package/dist/services/src/Services/ComponentServices.d.ts +0 -58
  108. package/dist/shared-logic/src/SingleStat/upcastSingleStatAttributes.d.ts +0 -3
@@ -0,0 +1,18 @@
1
+ import * as Dashboard from '../../Dashboard/Dashboard';
2
+ import { RawDashboard, SaveableDashboardDefinition } from '../../Dashboard';
3
+ import { HttpClient } from '../types';
4
+ export type EncryptedDashboardUpdateResponse = {
5
+ dashboard: RawDashboard<string>;
6
+ };
7
+ export type UnEncryptedDashboardUpdateResponse = {
8
+ dashboard: RawDashboard<Dashboard.RawDefinition>;
9
+ };
10
+ type UpdateDashboardResponse = EncryptedDashboardUpdateResponse | UnEncryptedDashboardUpdateResponse;
11
+ export type UpdateDashboardParams = {
12
+ dashboardSessionToken: string;
13
+ definition?: SaveableDashboardDefinition;
14
+ meta?: any;
15
+ deleted?: boolean;
16
+ };
17
+ export declare const updateDashboard: (httpClient: HttpClient) => (params: UpdateDashboardParams) => Promise<UpdateDashboardResponse>;
18
+ export {};
@@ -0,0 +1,6 @@
1
+ import { HttpClient } from '../types';
2
+ type UpdateParams = {
3
+ disabled: boolean;
4
+ };
5
+ export declare const updateProjectApiKey: (httpClient: HttpClient) => (projectId: string, projectApiKeyId: string, updateParams: UpdateParams) => Promise<string>;
6
+ export {};
@@ -0,0 +1,4 @@
1
+ declare class AIUsageLimitReached extends Error {
2
+ constructor();
3
+ }
4
+ export default AIUsageLimitReached;
@@ -1,5 +1,5 @@
1
1
  import ValidationError from './ValidationError';
2
- import Joi from 'joi';
2
+ import Joi from '@vizzly/joi';
3
3
  export default class CorruptedView extends ValidationError {
4
4
  constructor(joiValidationError: Joi.ValidationError);
5
5
  }
@@ -0,0 +1,4 @@
1
+ declare class DashboardQuotaReached extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export default DashboardQuotaReached;
@@ -0,0 +1,4 @@
1
+ import ValidationError from './ValidationError';
2
+ export default class FailedToSaveProjectEncryptedEncryptionSecret extends ValidationError {
3
+ constructor(projectId: string);
4
+ }
@@ -0,0 +1,4 @@
1
+ declare class FailedToCreateDashboard extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export default FailedToCreateDashboard;
@@ -0,0 +1,4 @@
1
+ declare class FailedToCreateDashboardAccess extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export default FailedToCreateDashboardAccess;
@@ -0,0 +1,4 @@
1
+ declare class FailedToGetDashboard extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export default FailedToGetDashboard;
@@ -0,0 +1,4 @@
1
+ declare class FailedToLoadIdentity extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export default FailedToLoadIdentity;
@@ -0,0 +1,4 @@
1
+ declare class FailedToResolveDataSets extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export default FailedToResolveDataSets;
@@ -0,0 +1,3 @@
1
+ export default class FailedToSaveVizzlyConfigVersion extends Error {
2
+ constructor(statusCode: number);
3
+ }
@@ -0,0 +1,4 @@
1
+ declare class FailedToUpdateDashboard extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export default FailedToUpdateDashboard;
@@ -0,0 +1,4 @@
1
+ declare class InvalidDataSetsPropType extends Error {
2
+ constructor();
3
+ }
4
+ export default InvalidDataSetsPropType;
@@ -0,0 +1,4 @@
1
+ declare class InvalidIdentityReturn extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export default InvalidIdentityReturn;
@@ -0,0 +1,4 @@
1
+ import ValidationError from './ValidationError';
2
+ export default class ProjectEncryptedSecretAlreadySaved extends ValidationError {
3
+ constructor(projectId: string);
4
+ }
@@ -0,0 +1,4 @@
1
+ declare class ReadOnlyPermissionNotFound extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export default ReadOnlyPermissionNotFound;
@@ -0,0 +1,4 @@
1
+ declare class ReadPermissionNotFound extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export default ReadPermissionNotFound;
@@ -0,0 +1,4 @@
1
+ export default class VizzlyApiCallErrorFailedToSetupProject extends Error {
2
+ statusCode: number;
3
+ constructor(statusCode: number);
4
+ }
@@ -0,0 +1,4 @@
1
+ declare class WritePermissionNotFound extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export default WritePermissionNotFound;
@@ -6,6 +6,7 @@ declare function getComponentInterface(type: 'pieChart', config?: ComponentInter
6
6
  declare function getComponentInterface(type: 'scatterChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.ScatterChartAttributes>;
7
7
  declare function getComponentInterface(type: 'mercatorMap', config?: ComponentInterfaceConfig): ComponentInterface<Component.MercatorMapAttributes>;
8
8
  declare function getComponentInterface(type: 'singleStat', config?: ComponentInterfaceConfig): ComponentInterface<Component.SingleStatAttributes>;
9
+ declare function getComponentInterface(type: 'progress', config?: ComponentInterfaceConfig): ComponentInterface<Component.ProgressAttributes>;
9
10
  declare function getComponentInterface(type: 'comboChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.ComboChartAttributes>;
10
11
  declare function getComponentInterface(type: 'dataTable', config?: ComponentInterfaceConfig): ComponentInterface<Component.DataTableAttributes>;
11
12
  declare function getComponentInterface(type: 'basicTable', config?: ComponentInterfaceConfig): BasicTableComponentInterface;
package/package.json CHANGED
@@ -22,5 +22,5 @@
22
22
  "test": "jest",
23
23
  "prepare": "yarn build"
24
24
  },
25
- "version": "0.7.0"
25
+ "version": "0.7.1-dev-b20a0c09c1eedef43690cbdff448965dfea9c70a"
26
26
  }
@@ -1,58 +0,0 @@
1
- import type { Component as VizzlyComponentType } from '../../../shared-logic/src/Component/types';
2
- import type { DataSet } from '../../../shared-logic/src/DataSet/types';
3
- type ComponentType = 'areaChart' | 'lineChart' | 'barChart' | 'pieChart' | 'scatterChart' | 'comboChart' | 'dataTable' | 'basicTable' | 'horizontalBarChart' | 'mercatorMap' | 'singleStat';
4
- export interface ComponentAttribute {
5
- areaChart: VizzlyComponentType.AreaChartAttributes;
6
- lineChart: VizzlyComponentType.LineChartAttributes;
7
- barChart: VizzlyComponentType.BarChartAttributes;
8
- pieChart: VizzlyComponentType.PieChartAttributes;
9
- scatterChart: VizzlyComponentType.ScatterChartAttributes;
10
- comboChart: VizzlyComponentType.ComboChartAttributes;
11
- dataTable: VizzlyComponentType.DataTableAttributes;
12
- basicTable: VizzlyComponentType.BasicTableAttributes;
13
- horizontalBarChart: VizzlyComponentType.HorizontalBarChartAttributes;
14
- mercatorMap: VizzlyComponentType.MercatorMapAttributes;
15
- singleStat: VizzlyComponentType.SingleStatAttributes;
16
- }
17
- export declare class ComponentServices<T extends ComponentType> {
18
- componentType: T;
19
- attributes: ComponentAttribute[T] | undefined;
20
- private dataSet;
21
- constructor(componentType: T, dataSet: DataSet, attributes?: Partial<ComponentAttribute[T]>);
22
- updateAttributes(newAttributes: Partial<ComponentAttribute[T]>): void;
23
- }
24
- export type ComponentClasses = AreaChartClass | LineChartClass | BarChartClass | PieChartClass | ScatterChartClass | ComboChartClass | PivotTableClass | BasicTableClass | HorizontalBarChartClass | MercatorMapClass | SingleStatClass;
25
- export declare class AreaChartClass extends ComponentServices<'areaChart'> {
26
- constructor(dataSet: DataSet, attributes?: Partial<ComponentAttribute['areaChart']>);
27
- }
28
- export declare class LineChartClass extends ComponentServices<'lineChart'> {
29
- constructor(dataSet: DataSet, attributes?: Partial<ComponentAttribute['lineChart']>);
30
- }
31
- export declare class BarChartClass extends ComponentServices<'barChart'> {
32
- constructor(dataSet: DataSet, attributes?: Partial<ComponentAttribute['barChart']>);
33
- }
34
- export declare class PieChartClass extends ComponentServices<'pieChart'> {
35
- constructor(dataSet: DataSet, attributes?: Partial<ComponentAttribute['pieChart']>);
36
- }
37
- export declare class ScatterChartClass extends ComponentServices<'scatterChart'> {
38
- constructor(dataSet: DataSet, attributes?: Partial<ComponentAttribute['scatterChart']>);
39
- }
40
- export declare class ComboChartClass extends ComponentServices<'comboChart'> {
41
- constructor(dataSet: DataSet, attributes?: Partial<ComponentAttribute['comboChart']>);
42
- }
43
- export declare class PivotTableClass extends ComponentServices<'dataTable'> {
44
- constructor(dataSet: DataSet, attributes?: Partial<ComponentAttribute['dataTable']>);
45
- }
46
- export declare class BasicTableClass extends ComponentServices<'basicTable'> {
47
- constructor(dataSet: DataSet, attributes?: Partial<ComponentAttribute['basicTable']>);
48
- }
49
- export declare class HorizontalBarChartClass extends ComponentServices<'horizontalBarChart'> {
50
- constructor(dataSet: DataSet, attributes?: Partial<ComponentAttribute['horizontalBarChart']>);
51
- }
52
- export declare class MercatorMapClass extends ComponentServices<'mercatorMap'> {
53
- constructor(dataSet: DataSet, attributes?: Partial<ComponentAttribute['mercatorMap']>);
54
- }
55
- export declare class SingleStatClass extends ComponentServices<'singleStat'> {
56
- constructor(dataSet: DataSet, attributes?: Partial<ComponentAttribute['singleStat']>);
57
- }
58
- export {};
@@ -1,3 +0,0 @@
1
- import { Component } from '../Component/types';
2
- import { DumpedSingleStatAttributes } from './types';
3
- export declare const upcastSingleStatAttributes: (dumped: DumpedSingleStatAttributes) => Component.SingleStatAttributes;