@vizzly/dashboard 0.12.0 → 0.12.1-dev-47d3534a0e08d7178d805f0ce84bd1d6e267d9ce

package/dist/dashboard/src/contexts/GlobalProvider/useGlobalProvider.d.ts

@@ -4,7 +4,7 @@ import { Dashboard } from '../../../../shared-logic/src/Dashboard';
 export declare type GlobalContextType = DashboardProps & {
     onSave: (dashboard: Dashboard) => void;
 };
-export declare const useGlobalContext: () => ({
+export declare const useGlobalContext: () => (import("../../types").InBrowserProps & {
     vizzlyApiHost?: string | undefined;
     featureToggles?: Partial<import("../../../../shared-logic/src/FeatureToggle/types").FeatureToggles> | undefined;
     customComponents?: import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides.CustomComponent[] | undefined;
@@ -60,21 +60,8 @@ export declare const useGlobalContext: () => ({
     pdfSettings?: import("../../../../shared-logic/src/PDFGenerator/types").PDFSettings | undefined;
     labelFormat?: import("../../../../shared-ui/src/contexts/DashboardBehaviour/types").LabelFormat | undefined;
 } & Partial<import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides> & {
-    identity: import("../../../../shared-logic/src/Callbacks/types").identityCallback;
-    dataSets: import("../../../../shared-logic/src/Callbacks/types").loadDataSetsCallback;
-    data: import("../../../../shared-logic/src/Callbacks/types").loadDataCallback;
-    runQueries?: undefined;
-    queryEngineConfig?: undefined;
-    queryEngineEndpoint?: string | {
-        endpoint: string;
-        dynamicConfig?: Object | undefined;
-        customHeaders?: (() => {
-            [headerKey: string]: string;
-        }) | undefined;
-    } | undefined;
-} & {
     onSave: (dashboard: Dashboard) => void;
-}) | ({
+}) | (import("../../types").SelfHostedProps & {
     vizzlyApiHost?: string | undefined;
     featureToggles?: Partial<import("../../../../shared-logic/src/FeatureToggle/types").FeatureToggles> | undefined;
     customComponents?: import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides.CustomComponent[] | undefined;
@@ -130,21 +117,8 @@ export declare const useGlobalContext: () => ({
     pdfSettings?: import("../../../../shared-logic/src/PDFGenerator/types").PDFSettings | undefined;
     labelFormat?: import("../../../../shared-ui/src/contexts/DashboardBehaviour/types").LabelFormat | undefined;
 } & Partial<import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides> & {
-    queryEngineEndpoint?: string | {
-        endpoint: string;
-        dynamicConfig?: Object | undefined;
-        customHeaders?: (() => {
-            [headerKey: string]: string;
-        }) | undefined;
-    } | undefined;
-    identity: import("../../../../shared-logic/src/Callbacks/types").identityCallback;
-    runQueries?: undefined;
-    dataSets?: import("../../../../shared-logic/src/Callbacks/types").loadDataSetsCallback | undefined;
-    data?: undefined;
-    queryEngineConfig?: undefined;
-} & {
     onSave: (dashboard: Dashboard) => void;
-}) | ({
+}) | (import("../../types").CustomProps & {
     vizzlyApiHost?: string | undefined;
     featureToggles?: Partial<import("../../../../shared-logic/src/FeatureToggle/types").FeatureToggles> | undefined;
     customComponents?: import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides.CustomComponent[] | undefined;
@@ -200,27 +174,9 @@ export declare const useGlobalContext: () => ({
     pdfSettings?: import("../../../../shared-logic/src/PDFGenerator/types").PDFSettings | undefined;
     labelFormat?: import("../../../../shared-ui/src/contexts/DashboardBehaviour/types").LabelFormat | undefined;
 } & Partial<import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides> & {
-    runQueries: (queries: import("../../../../shared-logic/src/Query/types").Query<string, string, string>[], params: {
-        dataSets: import("../../../../shared-logic/src/DataSet/types").DataSet[];
-        abortSignal?: AbortSignal | undefined;
-        dataAccessToken?: string | undefined;
-        filterConfig?: import("../../../../shared-logic/src/AdditionalFilter/types").FilterConfig | undefined;
-    }) => Promise<(import("../../../../shared-logic/src/Result/types").Result | any[][] | null)[] | null>;
-    identity: import("../../../../shared-logic/src/Callbacks/types").identityCallback;
-    dataSets: import("../../../../shared-logic/src/Callbacks/types").loadDataSetsCallback;
-    queryEngineConfig: import("../../../../shared-logic/src/Callbacks/types").loadQueryEngineConfigCallback;
-    data?: undefined;
-    queryEngineEndpoint?: string | {
-        endpoint: string;
-        dynamicConfig?: Object | undefined;
-        customHeaders?: (() => {
-            [headerKey: string]: string;
-        }) | undefined;
-    } | undefined;
-} & {
     onSave: (dashboard: Dashboard) => void;
 }) | undefined;
-export declare const GlobalContext: import("react").Context<({
+export declare const GlobalContext: import("react").Context<(import("../../types").InBrowserProps & {
     vizzlyApiHost?: string | undefined;
     featureToggles?: Partial<import("../../../../shared-logic/src/FeatureToggle/types").FeatureToggles> | undefined;
     customComponents?: import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides.CustomComponent[] | undefined;
@@ -276,21 +232,8 @@ export declare const GlobalContext: import("react").Context<({
     pdfSettings?: import("../../../../shared-logic/src/PDFGenerator/types").PDFSettings | undefined;
     labelFormat?: import("../../../../shared-ui/src/contexts/DashboardBehaviour/types").LabelFormat | undefined;
 } & Partial<import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides> & {
-    identity: import("../../../../shared-logic/src/Callbacks/types").identityCallback;
-    dataSets: import("../../../../shared-logic/src/Callbacks/types").loadDataSetsCallback;
-    data: import("../../../../shared-logic/src/Callbacks/types").loadDataCallback;
-    runQueries?: undefined;
-    queryEngineConfig?: undefined;
-    queryEngineEndpoint?: string | {
-        endpoint: string;
-        dynamicConfig?: Object | undefined;
-        customHeaders?: (() => {
-            [headerKey: string]: string;
-        }) | undefined;
-    } | undefined;
-} & {
     onSave: (dashboard: Dashboard) => void;
-}) | ({
+}) | (import("../../types").SelfHostedProps & {
     vizzlyApiHost?: string | undefined;
     featureToggles?: Partial<import("../../../../shared-logic/src/FeatureToggle/types").FeatureToggles> | undefined;
     customComponents?: import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides.CustomComponent[] | undefined;
@@ -346,21 +289,8 @@ export declare const GlobalContext: import("react").Context<({
     pdfSettings?: import("../../../../shared-logic/src/PDFGenerator/types").PDFSettings | undefined;
     labelFormat?: import("../../../../shared-ui/src/contexts/DashboardBehaviour/types").LabelFormat | undefined;
 } & Partial<import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides> & {
-    queryEngineEndpoint?: string | {
-        endpoint: string;
-        dynamicConfig?: Object | undefined;
-        customHeaders?: (() => {
-            [headerKey: string]: string;
-        }) | undefined;
-    } | undefined;
-    identity: import("../../../../shared-logic/src/Callbacks/types").identityCallback;
-    runQueries?: undefined;
-    dataSets?: import("../../../../shared-logic/src/Callbacks/types").loadDataSetsCallback | undefined;
-    data?: undefined;
-    queryEngineConfig?: undefined;
-} & {
     onSave: (dashboard: Dashboard) => void;
-}) | ({
+}) | (import("../../types").CustomProps & {
     vizzlyApiHost?: string | undefined;
     featureToggles?: Partial<import("../../../../shared-logic/src/FeatureToggle/types").FeatureToggles> | undefined;
     customComponents?: import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides.CustomComponent[] | undefined;
@@ -416,23 +346,5 @@ export declare const GlobalContext: import("react").Context<({
     pdfSettings?: import("../../../../shared-logic/src/PDFGenerator/types").PDFSettings | undefined;
     labelFormat?: import("../../../../shared-ui/src/contexts/DashboardBehaviour/types").LabelFormat | undefined;
 } & Partial<import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides> & {
-    runQueries: (queries: import("../../../../shared-logic/src/Query/types").Query<string, string, string>[], params: {
-        dataSets: import("../../../../shared-logic/src/DataSet/types").DataSet[];
-        abortSignal?: AbortSignal | undefined;
-        dataAccessToken?: string | undefined;
-        filterConfig?: import("../../../../shared-logic/src/AdditionalFilter/types").FilterConfig | undefined;
-    }) => Promise<(import("../../../../shared-logic/src/Result/types").Result | any[][] | null)[] | null>;
-    identity: import("../../../../shared-logic/src/Callbacks/types").identityCallback;
-    dataSets: import("../../../../shared-logic/src/Callbacks/types").loadDataSetsCallback;
-    queryEngineConfig: import("../../../../shared-logic/src/Callbacks/types").loadQueryEngineConfigCallback;
-    data?: undefined;
-    queryEngineEndpoint?: string | {
-        endpoint: string;
-        dynamicConfig?: Object | undefined;
-        customHeaders?: (() => {
-            [headerKey: string]: string;
-        }) | undefined;
-    } | undefined;
-} & {
     onSave: (dashboard: Dashboard) => void;
 }) | undefined>;

package/dist/dashboard/src/index.d.ts

@@ -5,14 +5,16 @@ import * as DataSetField from './sdk/DataSetField';
 import { Component as ComponentType } from '../../shared-logic/src/Component/types';
 import NewVizzlyImplementation from '../../shared-logic/src/errors/NewVizzlyImplementation';
 import { Result as VizzlyResult } from '../../shared-logic/src/Result/types';
-import { DashboardProps } from './types';
+import { DashboardProps, EditorProps } from './types';
 export * from './types';
 export { vizzlyState, VizzlyState } from '../../shared-logic/src/VizzlyState';
 import './developerTools';
 declare const Dashboard: (props: DashboardProps) => JSX.Element;
+declare const Editor: (props: EditorProps) => JSX.Element;
 export * from '../../shared-ui/src/hooks/useVizzly';
 declare const _default: {
     Dashboard: (props: DashboardProps) => JSX.Element;
+    Editor: (props: EditorProps) => JSX.Element;
     NewVizzlyImplementation: typeof NewVizzlyImplementation;
     displayPositions: {
         FIRST_ROW: number;
@@ -29,7 +31,7 @@ declare const _default: {
     DataSetField: typeof DataSetField;
 };
 export default _default;
-export { Dashboard, NewVizzlyImplementation, displayPositions, DataSetField };
+export { Dashboard, NewVizzlyImplementation, displayPositions, DataSetField, Editor };
 export type { Query } from '../../shared-logic/src/Query/types';
 export declare type Result = VizzlyResult | VizzlyResult['content'];
 export type { DataSet } from '../../shared-logic/src/DataSet/types';

package/dist/dashboard/src/types.d.ts

@@ -4,6 +4,34 @@ import { DashboardBehaviour } from '../../shared-ui/src/contexts/DashboardBehavi
 import { CustomDriver } from '../../results-driver/src/types';
 import { QueryEngineEndpoint } from '../../shared-logic/src/QueryEngineConfig/types';
 import { loadDataSetsCallback } from '../../shared-logic/src/Callbacks/types';
+import { EditorBehaviour } from '../../shared-ui/src/components/Editor/types';
+export declare type SharedEditorProps = {
+    view: EditorBehaviour['view'];
+    onSave?: EditorBehaviour['onSave'];
+    vizzlyApiHost?: string;
+    featureToggles?: Partial<DashboardBehaviour['featureToggles']>;
+    customComponents?: DashboardBehaviour['customComponents'];
+    excludeComponents?: StudioProps['excludeComponents'];
+    includeComponents?: StudioProps['includeComponents'];
+    numberFormatOptions?: DashboardBehaviour['numberFormatOptions'];
+    dateTimeFormatOptions?: DashboardBehaviour['dateTimeFormatOptions'];
+    developerTools?: DashboardBehaviour['developerTools'];
+    textOverrides?: DashboardBehaviour['textOverrides'];
+    dataPanel?: DashboardBehaviour['dataPanel'];
+    id?: string;
+    /**
+     * @deprecated This property is being deprecated. Use dateFilterOptions for dates.
+     */
+    dateTimeFilterOptions?: DashboardBehaviour['dateFilterOptions'];
+    dateFilterOptions?: DashboardBehaviour['dateFilterOptions'];
+    formatPanel?: DashboardBehaviour['formatPanel'];
+    onEditorUpdate?: DashboardBehaviour['onEditorUpdate'];
+    theme?: VizzlyTheming.Base;
+    onError?: VizzlyComponents.OnError;
+    onViewClick?: DashboardBehaviour['onViewClick'];
+    trackEvent?: trackEventCallback;
+    labelFormat?: DashboardBehaviour['labelFormat'];
+} & Partial<VizzlyComponents.ComponentOverrides>;
 export declare type SharedDashboardProps = {
     vizzlyApiHost?: string;
     featureToggles?: Partial<DashboardBehaviour['featureToggles']>;
@@ -37,11 +65,11 @@ export declare type SharedDashboardProps = {
     /**
      * Child Dashboard ID. If your user has multiple copies of a parent dashboard, you
      * will need to specify the ID of the dashboard copy here to render the correct one.
+     * You can use the services functionality to manage your user's dashboards
+     * https://docs.vizzly.co/services
      *
-     * You can use this with the `useDashboardManager` react hook, to manage a user's
-     * collection of dashboards.
-     *
-     * https://docs.vizzly.co/dashboard/management
+     * Or learn more about child dashboards
+     * https://docs.vizzly.co/concepts/parent-and-child-dashboards
      */
     dashboardId?: string;
     cascadeFilterSelection?: boolean;
@@ -50,7 +78,9 @@ export declare type SharedDashboardProps = {
     pdfSettings?: DashboardBehaviour['pdfSettings'];
     labelFormat?: DashboardBehaviour['labelFormat'];
 } & Partial<VizzlyComponents.ComponentOverrides>;
-export declare type CustomDashboardProps = SharedDashboardProps & {
+export declare type CustomDashboardProps = CustomProps & SharedDashboardProps;
+export declare type CustomEditorProps = CustomProps & SharedEditorProps;
+export declare type CustomProps = {
     runQueries: CustomDriver['runQueries'];
     identity: VizzlyComponents.identityCallback;
     dataSets: loadDataSetsCallback;
@@ -58,7 +88,9 @@ export declare type CustomDashboardProps = SharedDashboardProps & {
     data?: never;
     queryEngineEndpoint?: QueryEngineEndpoint;
 };
-export declare type InBrowserDashboardProps = SharedDashboardProps & {
+export declare type InBrowserDashboardProps = InBrowserProps & SharedDashboardProps;
+export declare type InBrowserEditorProps = InBrowserProps & SharedEditorProps;
+export declare type InBrowserProps = {
     identity: VizzlyComponents.identityCallback;
     dataSets: loadDataSetsCallback;
     data: VizzlyComponents.loadDataCallback;
@@ -66,7 +98,9 @@ export declare type InBrowserDashboardProps = SharedDashboardProps & {
     queryEngineConfig?: never;
     queryEngineEndpoint?: QueryEngineEndpoint;
 };
-export declare type SelfHostedDashboardProps = SharedDashboardProps & {
+export declare type SelfHostedDashboardProps = SelfHostedProps & SharedDashboardProps;
+export declare type SelfHostedEditorProps = SelfHostedProps & SharedEditorProps;
+export declare type SelfHostedProps = {
     queryEngineEndpoint?: QueryEngineEndpoint;
     identity: VizzlyComponents.identityCallback;
     runQueries?: never;
@@ -75,3 +109,4 @@ export declare type SelfHostedDashboardProps = SharedDashboardProps & {
     queryEngineConfig?: never;
 };
 export declare type DashboardProps = InBrowserDashboardProps | SelfHostedDashboardProps | CustomDashboardProps;
+export declare type EditorProps = InBrowserEditorProps | SelfHostedEditorProps | CustomEditorProps;