@vizzly/services 0.7.0-rc.0.14 → 0.7.0-rc.0.16

package/dist/services/src/Services/APIServices.d.ts

@@ -2,6 +2,7 @@ import { identityCallback } from 'shared-logic/src/Callbacks/types';
 import { Dashboard as DashboardType } from 'shared-logic/src/Dashboard';
 import * as Dashboard from 'shared-logic/src/Dashboard';
 import { ApiConfig } from 'shared-logic/src/ApiConfig';
+import * as dataSetsProperty from 'shared-logic/src/DashboardAPI/dataSets';
 /**
  * Represents a Vizzly dashboard.
  */
@@ -53,6 +54,10 @@ type APIOptions = {
      * @default { host: 'https://api.vizzly.co' }
      */
     vizzlyAPIConfig?: ApiConfig;
+    /**
+     * The function to use when loading the data sets.
+     */
+    dataSets?: dataSetsProperty.DataSetsCallback;
 };
 /**
  * Represents an API class for interacting with the services.
@@ -64,6 +69,7 @@ export declare class API {
     private permissions;
     private identityConfig;
     private dashboardStorageStrategy;
+    private loadDataSetsCallback;
     private dashboards;
     private vizzlyAPI;
     private parentDashboardId;
@@ -85,7 +91,7 @@ export declare class API {
      * @returns A promise that resolves to an array of client-facing dashboards.
      * @throws {Error} If an error occurs during the retrieval process.
      */
-    getDashboards(retryCount?: number): Promise<import("shared-logic/src/DashboardAPI/types").VizzlyDashboard[] | undefined>;
+    getDashboards(): Promise<import("shared-logic/src/DashboardAPI/types").VizzlyDashboard[] | undefined>;
     /**
      * Retrieves all child dashboards.
      *
@@ -93,7 +99,7 @@ export declare class API {
      * @throws {Error} If an error occurs while retrieving the child dashboards.
      */
     getAllChildDashboards(): Promise<import("shared-logic/src/DashboardAPI/types").VizzlyDashboard[] | undefined>;
-    getDataSets(): Promise<void>;
+    getDataSets(): Promise<import("shared-logic/src/DataSet/types").DataSet[] | undefined>;
     /**
      * Retrieves the parent dashboards.
      * @returns A promise that resolves to an array of parent dashboards.

package/dist/shared-logic/src/DashboardAPI/dataSets.d.ts

@@ -0,0 +1,12 @@
+import Joi from 'joi';
+import { loadDataSetsCallback } from 'shared-logic/src/Callbacks/types';
+import { IdentityConfig } from 'shared-logic/src/IdentityConfig/types';
+import { QueryEngineEndpoint } from 'shared-logic/src/QueryEngineConfig/types';
+import { DataSet } from '../DataSet/types';
+export type DataSetsCallback = (identityConfig: IdentityConfig) => Promise<Array<DataSet> | null>;
+export interface Property {
+    schema: Joi.Schema;
+}
+declare const dataSets: Property;
+export default dataSets;
+export declare const withReturnValidation: (dataSets?: DataSetsCallback, querEngineEndpoint?: QueryEngineEndpoint) => loadDataSetsCallback;

package/dist/shared-logic/src/FeatureToggle/types.d.ts

@@ -0,0 +1,29 @@
+export type FeatureToggles = {
+    showGlobalFilters: boolean;
+    showResetButton: boolean;
+    parameters: boolean;
+    canManageGlobalFilters: boolean;
+    disableAutoSave: boolean;
+    canEditComponentLibrary: boolean;
+    canUseComponentLibrary: boolean;
+    canCreateStandaloneComponents: boolean;
+    canDownloadComponentData: boolean;
+    canEditComponentsOnDashboard: boolean;
+    canRemoveComponentsFromDashboard: boolean;
+    canConfigureLocalFilters: boolean;
+    canAddNewRows: boolean;
+    canAddNewCells: boolean;
+    canEditCustomMetrics: boolean;
+    allowSimpleMathsCustomField: boolean;
+    allowAggregateMathsCustomField: boolean;
+    allowRoundedNumberCustomField: boolean;
+    allowPercentagesCustomField: boolean;
+    allowRulesCustomField: boolean;
+    /** Show/Hide the Date and Time Filter
+     * @default false */
+    showDateAndTimeFilter: boolean;
+    /** Show/Hide the Date Filter
+     * @default true */
+    showDateFilter: boolean;
+    canSeeEmptyState: boolean;
+};

package/dist/shared-logic/src/PivotConfig/types.d.ts

@@ -0,0 +1,5 @@
+import { QueryAttributes } from '../QueryAttributes/types';
+export type PivotConfig = {
+    x: QueryAttributes.Field[];
+    y: (QueryAttributes.Field | 'measures')[];
+};

package/dist/shared-logic/src/api/queryEngine/fetchDataSets.d.ts

@@ -0,0 +1,4 @@
+import { DataSet } from '../../DataSet/types';
+import { QueryEngineEndpoint } from '../../QueryEngineConfig/types';
+declare const _default: (queryEngineEndpoint: QueryEngineEndpoint, accessToken: string, abortSignal?: AbortSignal) => Promise<DataSet[]>;
+export default _default;

package/dist/shared-logic/src/errors/FailedToResolveDataSets.d.ts

@@ -0,0 +1,4 @@
+declare class FailedToResolveDataSets extends Error {
+    constructor(message: string);
+}
+export default FailedToResolveDataSets;

package/dist/shared-logic/src/errors/InvalidDataSetsPropType.d.ts

@@ -0,0 +1,4 @@
+declare class InvalidDataSetsPropType extends Error {
+    constructor();
+}
+export default InvalidDataSetsPropType;

package/dist/shared-ui/src/base/Select/Select.types.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export type SelectOption = {
+    label: string | number | Function;
+    value: any;
+    testId?: string;
+    icon?: JSX.Element;
+};

package/dist/shared-ui/src/base/Select/types.d.ts

@@ -0,0 +1,2 @@
+import { SelectOption } from '../Select/Select.types';
+export type AsyncSelectOptions = (abortSignal: AbortSignal) => Promise<SelectOption[] | null>;

package/dist/shared-ui/src/components/GlobalFilters/types.d.ts

@@ -0,0 +1,7 @@
+import { AsyncSelectOptions } from '../../base/Select/types';
+import { Dashboard } from 'shared-logic/src/Dashboard/types';
+export type GlobalFilterViewProps = {
+    setupAsyncOptionLoader: (globalFilterIndex: number) => AsyncSelectOptions;
+    globalFilters: Dashboard['globalFilters'];
+    setGlobalFilters: (globalFilters: Dashboard['globalFilters']) => void;
+};

package/dist/shared-ui/src/types.d.ts

@@ -0,0 +1,279 @@
+import React, { CSSProperties, PropsWithChildren } from 'react';
+import { Component } from '../../shared-logic/src/Component/types';
+import { DataSet } from '../../shared-logic/src/DataSet/types';
+import { FeatureToggles } from '../../shared-logic/src/FeatureToggle/types';
+import { PreparedQuery, Query } from '../../shared-logic/src/Query/types';
+import { Result } from '../../shared-logic/src/Result/types';
+import { QueryEngineConfig, QueryEngineEndpoint } from '../../shared-logic/src/QueryEngineConfig/types';
+import { identityCallback as identityCallbackImported, loadDataSetsCallback as loadDataSetsCallbackImported, loadQueryEngineConfigCallback as loadQueryEngineConfigCallbackImported, loadDataCallback as loadDataCallbackImported } from '../../shared-logic/src/Callbacks/types';
+import { PivotConfig as PivotConfigImported } from '../../shared-logic/src/PivotConfig/types';
+import { DataPanelSection } from 'shared-logic/src/DataPanelConfig/types';
+import { FormatPanelSection } from 'shared-logic/src/FormatPanelConfig/types';
+import { Dashboard } from 'shared-logic/src/Dashboard/types';
+import { AdditionalFilter, FilterConfig } from 'shared-logic/src/AdditionalFilter/types';
+import { QueryAttributes } from 'shared-logic/src/QueryAttributes/types';
+import { GlobalFilterViewProps } from './components/GlobalFilters/types';
+declare global {
+    var disableViewCheck: boolean;
+}
+export type { VizzlyTheming } from '../../shared-logic/src/Theme/types';
+export declare namespace VizzlyComponents {
+    export type ApiConfig = {
+        host: string;
+        authToken?: string;
+        useCookieAuth?: boolean;
+    };
+    export type BuilderAttributes<AttributesType> = {
+        attributes: AttributesType;
+        dataSet: DataSet;
+        setAttributes: (attrs: AttributesType) => void;
+        queries: Query[];
+        results: Result[];
+    };
+    export type ManagePartialAttributes<AttributesType> = {
+        attributes: AttributesType;
+        dataSet: DataSet;
+        setPartialAttributes: (attrs: Partial<AttributesType>) => void;
+    };
+    export type PivotConfig = PivotConfigImported;
+    export namespace ComponentOverrides {
+        type CustomComponent = {
+            id: string;
+            title: string;
+            Icon: () => JSX.Element;
+            Component: () => JSX.Element;
+        };
+        namespace Props {
+            type PickDataSet = {
+                previewDataSetId: string;
+                dataSets: DataSet[];
+                setPreviewDataSetId: (dataSetId: string) => void;
+                onSelectDataSet: (dataSetId: string) => void;
+                previewResult: Result | null;
+            };
+            type Select = {
+                subtle?: boolean;
+                dynamicWidth?: boolean;
+                options: SelectOptions[];
+                isLoading?: boolean;
+                /** Pass in the index of the options. */
+                selected: number | null;
+                /** When invoking the onChange callback pass in the index of the option you want to select. */
+                onChange: (index: number | null) => void;
+                placeholder?: string;
+                canBeCleared?: boolean;
+                selectedLabelPrefix?: string;
+                error?: boolean;
+                anchorOptionsLeft?: boolean;
+                setSelectOptionsAreOpen: (isOpen: boolean) => void;
+                selectOptionsAreOpen: boolean;
+                rightAligned?: boolean;
+                id?: string;
+            };
+            type SelectOptions = {
+                label: string | number | Function;
+                value: any;
+                testId?: string;
+                icon?: JSX.Element;
+            };
+            type Button = PropsWithChildren<{
+                primary?: boolean;
+                secondary?: boolean;
+                disabled?: boolean;
+                onClick?: () => Promise<boolean> | void;
+                error?: boolean;
+                isLoading?: boolean;
+                success?: boolean;
+                type?: 'button' | 'submit';
+            }>;
+            type DateTimeInput = {
+                value: string | undefined;
+                onChange: (newDate: Date | null) => void;
+                testId?: string;
+                error?: boolean;
+            };
+            type ManageGlobalFilters = {
+                dataSets: DataSet[];
+                removeGlobalFilter: (index: number) => void;
+                globalFilters: Dashboard['globalFilters'];
+                setGlobalFilters: (globalFilters: Dashboard['globalFilters']) => void;
+                queryEngineConfig: QueryEngineConfig;
+                setFieldForGlobalFilter: (globalFilterIndex: number, dataSetId: string, fieldId: string | null) => void;
+            };
+            namespace ComponentOptions {
+                type CellOption = {
+                    purpose: string;
+                    renderIcon: () => React.ReactNode;
+                    onClick: () => void;
+                    testId?: string;
+                };
+            }
+            type ComponentOptions = {
+                cellOptions: ComponentOptions.CellOption[];
+                onClose: () => void;
+            };
+            type SectionProps<Section extends DataPanelSection | FormatPanelSection = DataPanelSection | FormatPanelSection> = EditorSectionProps<Component.Attributes> & {
+                section: Section;
+            };
+        }
+        type Props<Rest> = Rest & {
+            activeDevToolHighlight: boolean;
+            onClickWithDevToolCheck: (onClick?: (e: any) => Promise<boolean> | void) => (e: any) => Promise<boolean> | void;
+        };
+        type renderGlobalFiltersViewComponent = (props: GlobalFilterViewProps) => JSX.Element | null;
+        type renderManageGlobalFilters = (props: Props.ManageGlobalFilters) => JSX.Element | null;
+        type renderButtonComponent = (props: Props.Button) => JSX.Element;
+        type renderDateTimeInput = (props: Props.DateTimeInput) => JSX.Element;
+        type renderSelectComponent = (props: Props.Select) => JSX.Element;
+        type renderComponentOptions = (props: Props.ComponentOptions) => JSX.Element | null;
+        type renderLoading = (props: {}) => JSX.Element | null;
+        type renderUndoIcon = (props: {}) => JSX.Element;
+        type renderCompletedIcon = (props: {}) => JSX.Element;
+        type renderInProgressIcon = (props: {}) => JSX.Element;
+        type renderDeleteIcon = (props: {
+            purpose: 'removeComponentFromDashboard' | 'removeCellFromDashboard' | 'removeFilter' | 'removeRow';
+        }) => JSX.Element;
+        type renderPlusIcon = (props: {
+            fill?: CSSProperties['fill'];
+        }) => JSX.Element;
+        type renderCloseIcon = (props: {}) => JSX.Element;
+        type renderEditIcon = (props: {}) => JSX.Element;
+        type renderDownloadIcon = (props: {}) => JSX.Element;
+        type renderComponentOptionsMenuIcon = (props: {}) => JSX.Element;
+        type renderMergeCellIcon = (props: {}) => JSX.Element;
+        type renderSplitCellIcon = (props: {}) => JSX.Element;
+        type renderFilterIcon = (props: {
+            active: boolean;
+        }) => JSX.Element;
+        type renderReportIcon = (props: {}) => JSX.Element;
+        type renderParametersIcon = (props: {}) => JSX.Element;
+        type renderInsertRowBelowIcon = (props: {}) => JSX.Element;
+        type renderInsertRowAboveIcon = (props: {}) => JSX.Element;
+        type renderAppendCellIcon = (props: {}) => JSX.Element;
+        type renderLibraryIcon = (props: {}) => JSX.Element;
+        type renderCreateComponentIcon = (props: {}) => JSX.Element;
+        type renderAccordionIcon = (props: {
+            isOpen: boolean;
+        }) => JSX.Element;
+    }
+    export type ComponentOverrides = {
+        renderLoadingComponent: ComponentOverrides.renderLoading | null;
+        /**
+         * @deprecated This property is being deprecated. You can now use the Theme API, see {@link https://docs.vizzly.co/dashboard/properties/theme}.
+         */
+        renderManageGlobalFilters?: ComponentOverrides.renderManageGlobalFilters | null;
+        renderSelectComponent: ComponentOverrides.renderSelectComponent | null;
+        renderButtonComponent: ComponentOverrides.renderButtonComponent | null;
+        renderDateTimeInput: ComponentOverrides.renderDateTimeInput | null;
+        /**
+         * @deprecated This property is being deprecated. You can now use the Theme API, for information see {@link https://docs.vizzly.co/dashboard/properties/theme}.
+         */
+        renderComponentOptions?: ComponentOverrides.renderComponentOptions | null;
+        /**
+         * @deprecated This property is being deprecated. You can now use the Theme API, see {@link https://docs.vizzly.co/dashboard/properties/theme}.
+         */
+        renderGlobalFiltersViewComponent?: ComponentOverrides.renderGlobalFiltersViewComponent | null;
+        /**
+         * @deprecated This property is being deprecated.
+         */
+        renderPickComponentTypeComponent?: never;
+        /**
+         * @deprecated This property is being deprecated.
+         */
+        renderUndoIcon?: ComponentOverrides.renderUndoIcon | null;
+        /**
+         * @deprecated This property is being deprecated.
+         */
+        renderCompletedIcon?: ComponentOverrides.renderCompletedIcon | null;
+        /**
+         * @deprecated This property is being deprecated.
+         */
+        renderInProgressIcon?: ComponentOverrides.renderInProgressIcon | null;
+        renderDeleteIcon: ComponentOverrides.renderDeleteIcon | null;
+        /**
+         * @deprecated This property is being deprecated.
+         */
+        renderPlusIcon?: ComponentOverrides.renderPlusIcon | null;
+        renderCloseIcon: ComponentOverrides.renderCloseIcon | null;
+        renderFilterIcon: ComponentOverrides.renderFilterIcon | null;
+        renderReportIcon: ComponentOverrides.renderReportIcon | null;
+        renderParametersIcon: ComponentOverrides.renderParametersIcon | null;
+        renderEditIcon: ComponentOverrides.renderEditIcon | null;
+        renderLockedIcon: ComponentOverrides.renderEditIcon | null;
+        renderComponentOptionsMenuIcon: ComponentOverrides.renderComponentOptionsMenuIcon | null;
+        /**
+         * @deprecated This property is being deprecated.
+         */
+        renderMergeCellIcon?: ComponentOverrides.renderComponentOptionsMenuIcon | null;
+        /**
+         * @deprecated This property is being deprecated.
+         */
+        renderSplitCellIcon?: ComponentOverrides.renderSplitCellIcon | null;
+        renderDownloadIcon: ComponentOverrides.renderDownloadIcon | null;
+        /**
+         * @deprecated This property is being deprecated.
+         */
+        renderInsertRowBelowIcon?: ComponentOverrides.renderInsertRowBelowIcon | null;
+        /**
+         * @deprecated This property is being deprecated.
+         */
+        renderInsertRowAboveIcon?: ComponentOverrides.renderInsertRowAboveIcon | null;
+        /**
+         * @deprecated This property is being deprecated.
+         */
+        renderAppendCellIcon?: ComponentOverrides.renderAppendCellIcon | null;
+        renderLibraryIcon: ComponentOverrides.renderLibraryIcon | null;
+        /**
+         * @deprecated This property is being deprecated.
+         */
+        renderCreateComponentIcon?: ComponentOverrides.renderCreateComponentIcon | null;
+        renderAccordionIcon: ComponentOverrides.renderAccordionIcon | null;
+    };
+    type CallbackError = null;
+    type VizzlyEvent = 'manageTheme.save' | 'manageTheme.open' | 'manageTheme.close' | 'manageGlobalFilters.open' | 'manageGlobalFilters.close' | 'manageDisplay.newRow' | 'manageDisplay.removeRow' | 'manageDisplay.appendCell' | 'manageDisplay.removeCell' | 'editor.changesCancelled' | 'editor.changesConfirmed' | 'component.removeFromDisplay' | 'component.downloadRawData' | 'component.mergeRight' | 'component.splitRight' | 'component.startEditing' | 'library.open' | 'library.startCreatingNew' | 'library.startEditing' | 'library.close' | 'library.switchSelectedComponent' | 'manageFeatureToggles.open' | 'manageFeatureToggles.close';
+    export type onEventCallback = (event: VizzlyEvent) => void;
+    export type loadQueryEngineConfigCallback = loadQueryEngineConfigCallbackImported;
+    export type loadDataSetsCallback = loadDataSetsCallbackImported;
+    export type runQueriesCallback = (queries: Component.Attributes | AdditionalFilter | QueryAttributes[] | [PreparedQuery], params: {
+        dataSets: DataSet[];
+        abortSignal?: AbortSignal;
+        dataAccessToken?: string;
+        filterConfig?: FilterConfig;
+    }) => Promise<(Result | null)[] | Array<Result['content'] | null> | CallbackError>;
+    export type runQueriesCallbackInternal = (queries: Component.Attributes | AdditionalFilter | Array<QueryAttributes> | [PreparedQuery], abortSignal?: AbortSignal, filterConfig?: FilterConfig) => Promise<Result[] | CallbackError>;
+    export type identityCallback = identityCallbackImported;
+    export type loadDataCallback = loadDataCallbackImported;
+    export type EditorSectionProps<Attributes> = {
+        attributes: Attributes;
+        dataSet: DataSet;
+        dataSets: DataSet[];
+        featureToggles: FeatureToggles;
+        setDataSet: (dataSetId: string) => void;
+        setAttributes: (attributes: Partial<Attributes>) => void;
+        setDataSets: (dataSets: Array<DataSet>) => void;
+        queryEngineConfig: QueryEngineConfig;
+    };
+    export type DataMap = {
+        [key: string]: string | boolean | number | Date | null;
+    };
+    export type ViewProps<Additional> = {
+        result: Result | null | undefined;
+        library?: boolean;
+        id: string;
+        queriesAreChanging: boolean;
+        supportedAggregates: QueryEngineConfig['supportedAggregates'];
+        supportedTimeTruncFunctions: QueryEngineConfig['supportedTimeTruncFunctions'];
+        supportedTransformationFunctions: QueryEngineConfig['supportedTransformationFunctions'];
+        localFilters: Component['localFilters'];
+        setLocalFilters: (localFilters: Component['localFilters']) => void;
+        setParameterUpdate: (payload: Component['updatesFromParameters']) => void;
+        sm?: boolean;
+        dataSet: DataSet;
+    } & Additional;
+    export type ImplementationMeta = {
+        queryEngineEndpoint?: QueryEngineEndpoint;
+        type: 'custom' | 'query-engine' | 'in-browser';
+    };
+    export type OnError = (error: any, errorInfo: any) => void;
+    export {};
+}

package/package.json

@@ -22,5 +22,5 @@
     "test": "jest",
     "prepare": "yarn build"
   },
-  "version": "0.7.0-rc.0.14"
+  "version": "0.7.0-rc.0.16"
 }