@vizzly/dashboard 0.6.4 → 0.7.0-dev-7b5bf5e024980d82456b6acf6f46ada82ca4f6e7

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

@@ -0,0 +1,3 @@
+import { DashboardProps } from '../../types';
+import { VizzlyComponents } from '../../../../shared-ui/src/types';
+export declare const buildImplementationMeta: (props: DashboardProps) => VizzlyComponents.ImplementationMeta;

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

@@ -57,12 +57,20 @@ export declare const useGlobalContext: () => ({
     parentDashboardId?: string | undefined;
     dashboardId?: string | undefined;
     cascadeFilterSelection?: boolean | undefined;
+    parentDashboard?: ((dataSets: import("../../../../shared-logic/src/DataSet/types").DataSet[]) => Promise<Partial<import("../../../../shared-logic/src/Dashboard").SaveableDashboardDefinition>[]>) | undefined;
 } & Partial<import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides> & {
     identity: import("../../../../shared-logic/src/Callbacks/types").identityCallback;
     dataSets: (identityConfig: import("../../../../shared-logic/src/IdentityConfig/types").IdentityConfig) => Promise<import("../../../../shared-logic/src/DataSet/types").DataSet[] | null>;
     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;
 }) | ({
@@ -118,6 +126,7 @@ export declare const useGlobalContext: () => ({
     parentDashboardId?: string | undefined;
     dashboardId?: string | undefined;
     cascadeFilterSelection?: boolean | undefined;
+    parentDashboard?: ((dataSets: import("../../../../shared-logic/src/DataSet/types").DataSet[]) => Promise<Partial<import("../../../../shared-logic/src/Dashboard").SaveableDashboardDefinition>[]>) | undefined;
 } & Partial<import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides> & {
     queryEngineEndpoint?: string | {
         endpoint: string;
@@ -128,7 +137,7 @@ export declare const useGlobalContext: () => ({
     } | undefined;
     identity: import("../../../../shared-logic/src/Callbacks/types").identityCallback;
     runQueries?: undefined;
-    dataSets?: undefined;
+    dataSets?: ((identityConfig: import("../../../../shared-logic/src/IdentityConfig/types").IdentityConfig) => Promise<import("../../../../shared-logic/src/DataSet/types").DataSet[] | null>) | undefined;
     data?: undefined;
     queryEngineConfig?: undefined;
 } & {
@@ -186,6 +195,7 @@ export declare const useGlobalContext: () => ({
     parentDashboardId?: string | undefined;
     dashboardId?: string | undefined;
     cascadeFilterSelection?: boolean | undefined;
+    parentDashboard?: ((dataSets: import("../../../../shared-logic/src/DataSet/types").DataSet[]) => Promise<Partial<import("../../../../shared-logic/src/Dashboard").SaveableDashboardDefinition>[]>) | 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[];
@@ -197,6 +207,13 @@ export declare const useGlobalContext: () => ({
     dataSets: (identityConfig: import("../../../../shared-logic/src/IdentityConfig/types").IdentityConfig) => Promise<import("../../../../shared-logic/src/DataSet/types").DataSet[] | null>;
     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;
@@ -253,12 +270,20 @@ export declare const GlobalContext: import("react").Context<({
     parentDashboardId?: string | undefined;
     dashboardId?: string | undefined;
     cascadeFilterSelection?: boolean | undefined;
+    parentDashboard?: ((dataSets: import("../../../../shared-logic/src/DataSet/types").DataSet[]) => Promise<Partial<import("../../../../shared-logic/src/Dashboard").SaveableDashboardDefinition>[]>) | undefined;
 } & Partial<import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides> & {
     identity: import("../../../../shared-logic/src/Callbacks/types").identityCallback;
     dataSets: (identityConfig: import("../../../../shared-logic/src/IdentityConfig/types").IdentityConfig) => Promise<import("../../../../shared-logic/src/DataSet/types").DataSet[] | null>;
     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;
 }) | ({
@@ -314,6 +339,7 @@ export declare const GlobalContext: import("react").Context<({
     parentDashboardId?: string | undefined;
     dashboardId?: string | undefined;
     cascadeFilterSelection?: boolean | undefined;
+    parentDashboard?: ((dataSets: import("../../../../shared-logic/src/DataSet/types").DataSet[]) => Promise<Partial<import("../../../../shared-logic/src/Dashboard").SaveableDashboardDefinition>[]>) | undefined;
 } & Partial<import("../../../../shared-ui/src").VizzlyComponents.ComponentOverrides> & {
     queryEngineEndpoint?: string | {
         endpoint: string;
@@ -324,7 +350,7 @@ export declare const GlobalContext: import("react").Context<({
     } | undefined;
     identity: import("../../../../shared-logic/src/Callbacks/types").identityCallback;
     runQueries?: undefined;
-    dataSets?: undefined;
+    dataSets?: ((identityConfig: import("../../../../shared-logic/src/IdentityConfig/types").IdentityConfig) => Promise<import("../../../../shared-logic/src/DataSet/types").DataSet[] | null>) | undefined;
     data?: undefined;
     queryEngineConfig?: undefined;
 } & {
@@ -382,6 +408,7 @@ export declare const GlobalContext: import("react").Context<({
     parentDashboardId?: string | undefined;
     dashboardId?: string | undefined;
     cascadeFilterSelection?: boolean | undefined;
+    parentDashboard?: ((dataSets: import("../../../../shared-logic/src/DataSet/types").DataSet[]) => Promise<Partial<import("../../../../shared-logic/src/Dashboard").SaveableDashboardDefinition>[]>) | 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[];
@@ -393,6 +420,13 @@ export declare const GlobalContext: import("react").Context<({
     dataSets: (identityConfig: import("../../../../shared-logic/src/IdentityConfig/types").IdentityConfig) => Promise<import("../../../../shared-logic/src/DataSet/types").DataSet[] | null>;
     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/contexts/SessionContext/useSessionContext.d.ts

@@ -1,10 +1,12 @@
 import { useDataConfigurationAndIdentity } from '../useDataConfigurationAndIdentity';
 import { IdentityConfig } from '../../../../shared-logic/src/IdentityConfig/types';
-import { Dashboard } from '../../../../shared-logic/src/Dashboard/types';
+import { Dashboard, SaveableDashboardDefinition } from '../../../../shared-logic/src/Dashboard/types';
 import { QueryEngineConfig } from '../../../../shared-logic/src/QueryEngineConfig/types';
 import { api } from '../../../../shared-logic/src/api';
 import { VizzlyComponents } from '../../../../shared-ui/src/types';
 import { DashboardApiInterface } from '../useDashboardAPI';
+import { DataSet } from '../../../../shared-logic/src/DataSet/types';
+import { Mode, Scope } from '../useDashboardStrategy/types';
 declare type Params = {
     parentDashboardId: string | undefined;
     identityCallback: VizzlyComponents.identityCallback;
@@ -13,19 +15,21 @@ declare type Params = {
     dashboardId?: string;
     implementationMeta: VizzlyComponents.ImplementationMeta;
     loadQueryEngineConfigCallback: VizzlyComponents.loadQueryEngineConfigCallback;
+    programmaticDashboard?: (dataSets: DataSet[]) => Promise<Array<Partial<SaveableDashboardDefinition>>>;
 };
 export declare type StillLoading = null;
 export declare type ErrorProvided = {
     error: ReturnType<typeof useDataConfigurationAndIdentity>['error'];
 };
 export declare type SessionSuccessProvidedValues = {
-    mode: 'admin' | 'endUser';
-    scope: 'read' | 'read_write';
+    mode: Mode;
+    scope: Scope;
     identityConfig: IdentityConfig;
     dashboard: Dashboard | null;
     vizzlyApiConfig: VizzlyComponents.ApiConfig;
     queryEngineConfig: QueryEngineConfig;
     dashboardAPI: DashboardApiInterface;
+    isProgrammaticParent: boolean;
 };
 export declare const useSessionContext: (params: Params) => ErrorProvided | SessionSuccessProvidedValues | StillLoading;
 export {};

package/dist/dashboard/src/contexts/useDashboardAPI.d.ts

@@ -7,7 +7,9 @@ import FailedToGetDashboard from '../../../shared-logic/src/errors/FailedToGetDa
 import NewVizzlyImplementation from '../../../shared-logic/src/errors/NewVizzlyImplementation';
 import { IdentityConfig as IdentityConfigType } from '../../../shared-logic/src/IdentityConfig/types';
 import { DataSet } from '../../../shared-logic/src/DataSet/types';
+import * as Dashboard from '../../../shared-logic/src/Dashboard';
 import { api } from '../../../shared-logic/src/api';
+import { QueryEngineConfig, QueryEngineEndpoint } from '../../../shared-logic/src/QueryEngineConfig/types';
 export declare type DashboardApiInterface = {
     childDashboardCount: number;
     defaultParentDashboardId: string;
@@ -29,5 +31,12 @@ export declare type LoadingDashboardApiInterface = {
     isLoading: true;
     error: DashboardApiInterface['error'];
 };
-declare const useDashboardAPI: (identityConfig: IdentityConfigType | undefined, dataSets: DataSet[] | undefined, vizzlyAPI: ReturnType<typeof api>, parentDashboardId?: string | undefined) => DashboardApiInterface | LoadingDashboardApiInterface;
+declare type DashboardStorageStrategy = {
+    strategy: 'vizzlyApi';
+} | {
+    strategy: 'queryEngine';
+    endpoint: QueryEngineEndpoint;
+};
+export declare const getDashboardStorageStrategy: (queryEngineEndpoint: Function | QueryEngineEndpoint | undefined, queryEngineConfig: QueryEngineConfig | undefined) => DashboardStorageStrategy;
+declare const useDashboardAPI: (identityConfig: IdentityConfigType | undefined, dataSets: DataSet[] | undefined, vizzlyAPI: ReturnType<typeof api>, parentDashboardId: string | undefined, dashboardStorageStrategy: DashboardStorageStrategy, programmaticDashboard?: ((dataSets: DataSet[]) => Promise<Array<Partial<Dashboard.SaveableDashboardDefinition>>>) | undefined) => DashboardApiInterface | LoadingDashboardApiInterface;
 export default useDashboardAPI;

package/dist/dashboard/src/contexts/useDashboardStrategy/runStrategy.d.ts

@@ -1,7 +1,7 @@
-import { Strategy } from './types';
+import { Mode, Scope, Strategy } from './types';
 import { DashboardApiInterface } from '../useDashboardAPI';
 export declare const runStrategy: (strategy: Strategy, dashboardAPI: DashboardApiInterface) => Promise<{
     dashboardId: string;
-    mode: 'admin' | 'endUser';
-    scope: 'read' | 'read_write';
+    mode: Mode;
+    scope: Scope;
 }>;

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

@@ -0,0 +1,25 @@
+import { Dashboard } from '../../../../shared-logic/src/Dashboard/types';
+declare type ExactStrategy = {
+    type: 'exact';
+    dashboardId: string;
+};
+declare type InstantCopyOf = {
+    type: 'instantCopyOf';
+    parentDashboardId: string;
+};
+export declare type Strategy = ExactStrategy | InstantCopyOf;
+export declare enum Mode {
+    Admin = "admin",
+    EndUser = "endUser"
+}
+export declare enum Scope {
+    Read = "read",
+    ReadWrite = "read_write"
+}
+export declare type ProvidedValues = {
+    dashboard: Dashboard | null;
+    mode: Mode;
+    scope: Scope;
+    isProgrammaticParent: boolean;
+};
+export {};

package/dist/dashboard/src/contexts/useDashboardStrategy.d.ts

@@ -1,4 +1,6 @@
 import useDashboardAPI from './useDashboardAPI';
 import { ProvidedValues, Strategy } from './useDashboardStrategy/types';
-declare const useDashboardStrategy: (strategy: Strategy | undefined, dashboardAPI: ReturnType<typeof useDashboardAPI>) => ProvidedValues | null;
+import { SaveableDashboardDefinition } from '../../../shared-logic/src/Dashboard';
+import { DataSet } from '../../../shared-logic/src/DataSet/types';
+declare const useDashboardStrategy: (strategy: Strategy | undefined, dashboardAPI: ReturnType<typeof useDashboardAPI>, programmaticDashboard?: ((dataSets: DataSet[]) => Promise<Array<Partial<SaveableDashboardDefinition>>>) | undefined) => ProvidedValues | null;
 export default useDashboardStrategy;

package/dist/dashboard/src/contexts/useDataConfigurationAndIdentity.d.ts

@@ -2,11 +2,17 @@ import { VizzlyComponents } from '../../../shared-ui/src/types';
 import FailedToLoadIdentity from '../../../shared-logic/src/errors/FailedToLoadIdentity';
 import FailedToLoadQueryEngineConfig from '../../../shared-logic/src/errors/FailedToLoadQueryEngineConfig';
 import { DataSet } from '../../../shared-logic/src/DataSet/types';
-import { QueryEngineConfig } from '../../../shared-logic/src/QueryEngineConfig/types';
+import { QueryEngineConfig, QueryEngineEndpoint } from '../../../shared-logic/src/QueryEngineConfig/types';
 import { IdentityConfig as IdentityConfigType } from '../../../shared-logic/src/IdentityConfig/types';
 import IdentityMustBeCallback from '../../../shared-logic/src/errors/IdentityMustBeCallback';
 import NoDataSetResolved from '../../../shared-logic/src/errors/NoDataSetResolved';
-export declare const useDataConfigurationAndIdentity: (identityCallback: import("../../../shared-logic/src/Callbacks/types").identityCallback, loadDataSetsCallback: import("../../../shared-logic/src/Callbacks/types").loadDataSetsCallback, loadQueryEngineConfigCallback: string | import("../../../shared-logic/src/Callbacks/types").loadQueryEngineConfigCallback) => {
+export declare const useDataConfigurationAndIdentity: (identityCallback: import("../../../shared-logic/src/Callbacks/types").identityCallback, loadDataSetsCallback: import("../../../shared-logic/src/Callbacks/types").loadDataSetsCallback, loadQueryEngineConfigCallback: string | import("../../../shared-logic/src/Callbacks/types").loadQueryEngineConfigCallback | {
+    endpoint: string;
+    dynamicConfig?: Object | undefined;
+    customHeaders?: (() => {
+        [headerKey: string]: string;
+    }) | undefined;
+}) => {
     error: FailedToLoadIdentity | FailedToLoadQueryEngineConfig | IdentityMustBeCallback | NoDataSetResolved | undefined;
     dataSets: DataSet[] | undefined;
     queryEngineConfig: QueryEngineConfig | undefined;

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

@@ -11,7 +11,13 @@ import './developerTools';
 declare const Dashboard: (props: DashboardProps) => JSX.Element;
 declare const _default: {
     Dashboard: (props: DashboardProps) => JSX.Element;
-    useDashboardManager: (identity: import("../../shared-logic/src/Callbacks/types").identityCallback, loadQueryEngineConfig: string | import("../../shared-logic/src/Callbacks/types").loadQueryEngineConfigCallback, defaultParentDashboardId?: string | undefined, vizzlyApiConfigOverride?: import("../../shared-logic/src/ApiConfig").ApiConfig | undefined) => {
+    useDashboardManager: (identity: import("../../shared-logic/src/Callbacks/types").identityCallback, loadQueryEngineConfig: string | import("../../shared-logic/src/Callbacks/types").loadQueryEngineConfigCallback | {
+        endpoint: string;
+        dynamicConfig?: Object | undefined;
+        customHeaders?: (() => {
+            [headerKey: string]: string;
+        }) | undefined;
+    }, defaultParentDashboardId?: string | undefined, vizzlyApiConfigOverride?: import("../../shared-logic/src/ApiConfig").ApiConfig | undefined) => {
         VizzlySDK: {
             displayPositions: {
                 FIRST_ROW: number;

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

@@ -48,6 +48,7 @@ export declare type SharedDashboardProps = {
      */
     dashboardId?: string;
     cascadeFilterSelection?: boolean;
+    parentDashboard?: DashboardBehaviour['parentDashboard'];
 } & Partial<VizzlyComponents.ComponentOverrides>;
 export declare type CustomDashboardProps = SharedDashboardProps & {
     runQueries: CustomDriver['runQueries'];
@@ -55,6 +56,7 @@ export declare type CustomDashboardProps = SharedDashboardProps & {
     dataSets: (identityConfig: IdentityConfig) => Promise<Array<DataSet> | null>;
     queryEngineConfig: VizzlyComponents.loadQueryEngineConfigCallback;
     data?: never;
+    queryEngineEndpoint?: QueryEngineEndpoint;
 };
 export declare type InBrowserDashboardProps = SharedDashboardProps & {
     identity: VizzlyComponents.identityCallback;
@@ -62,12 +64,13 @@ export declare type InBrowserDashboardProps = SharedDashboardProps & {
     data: VizzlyComponents.loadDataCallback;
     runQueries?: never;
     queryEngineConfig?: never;
+    queryEngineEndpoint?: QueryEngineEndpoint;
 };
 export declare type SelfHostedDashboardProps = SharedDashboardProps & {
     queryEngineEndpoint?: QueryEngineEndpoint;
     identity: VizzlyComponents.identityCallback;
     runQueries?: never;
-    dataSets?: never;
+    dataSets?: (identityConfig: IdentityConfig) => Promise<Array<DataSet> | null>;
     data?: never;
     queryEngineConfig?: never;
 };

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

@@ -5,6 +5,7 @@ import deleteDashboard from './useDashboardManager/deleteDashboard';
 import updateDashboardMeta from './useDashboardManager/updateDashboardMeta';
 import { identityCallback, loadQueryEngineConfigCallback } from '../../shared-logic/src/Callbacks/types';
 import { ApiConfig } from '../../shared-logic/src/ApiConfig';
+import { QueryEngineEndpoint } from '../../shared-logic/src/QueryEngineConfig/types';
 declare type BaseProvides<Loading extends boolean, VizzlySDK, ParentDashboardIdType> = {
     VizzlySDK: VizzlySDK;
     loading: Loading;
@@ -30,6 +31,6 @@ declare type BaseProvides<Loading extends boolean, VizzlySDK, ParentDashboardIdT
 export declare type DashboardManagerLoadedState = BaseProvides<false, ReturnType<typeof loadVizzlySDK>, string>;
 export declare type DashboardManagerLoadingState = BaseProvides<true, null, null>;
 declare type Provides = DashboardManagerLoadedState | DashboardManagerLoadingState;
-declare const useDashboardManager: (identity: identityCallback, loadQueryEngineConfig: loadQueryEngineConfigCallback | string, defaultParentDashboardId?: string | undefined, vizzlyApiConfigOverride?: ApiConfig | undefined) => Provides;
+declare const useDashboardManager: (identity: identityCallback, loadQueryEngineConfig: loadQueryEngineConfigCallback | QueryEngineEndpoint, defaultParentDashboardId?: string | undefined, vizzlyApiConfigOverride?: ApiConfig | undefined) => Provides;
 declare const useInBrowserDashboardManager: (identity: identityCallback, defaultParentDashboardId?: string | undefined, vizzlyApiConfigOverride?: ApiConfig | undefined) => Provides;
 export { useDashboardManager, useInBrowserDashboardManager };