@vizzly/services 0.7.0 → 0.7.1-dev-b20a0c09c1eedef43690cbdff448965dfea9c70a

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

@@ -0,0 +1,153 @@
+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 { DashboardStorageStrategy } from 'shared-logic/src/DashboardAPI/types';
+import * as dataSetsProperty from 'shared-logic/src/DashboardAPI/dataSets';
+/**
+ * Represents a Vizzly dashboard.
+ */
+export type VizzlyDashboard = {
+    id: DashboardType['id'];
+    parentDashboardId: DashboardType['parentDashboardId'] | undefined;
+    display: DashboardType['display'];
+    componentLibrary: DashboardType['componentLibrary'];
+    createdAt: DashboardType['createdAt'];
+    updatedAt: DashboardType['updatedAt'];
+    metadata: DashboardType['metadata'];
+};
+/**
+ * Represents the payload for creating a dashboard.
+ */
+export type CreateDashboard = {
+    definition: Dashboard.SaveableDashboardDefinition;
+    /**
+     * The metadata for the dashboard.
+     *
+     * @property {any} meta - The metadata for the dashboard can be set to anything you require.
+     *
+     */
+    meta: any;
+    /**
+     * The ID of the parent dashboard.
+     *
+     * @property {string} parentDashboardId - The ID of the parent dashboard.
+     * @default The default parent dashboard ID.
+     */
+    parentDashboardId?: string | null;
+};
+/**
+ * Options for updating a dashboard.
+ *
+ * @property {VizzlyDashboard['metadata']} metadata - The metadata to update the dashboard with.
+ */
+type UpdateDashboardOptions = {
+    metadata?: VizzlyDashboard['metadata'];
+};
+type APIOptions = {
+    /**
+     * The parent dashboard ID to use when creating a child dashboard.
+     */
+    parentDashboardId?: string;
+    /**
+     * The API config to use when making requests to the Vizzly API.
+     *
+     * @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.
+ */
+export declare class API {
+    private abortController;
+    private identity;
+    private identityTokens;
+    private permissions;
+    private identityConfig;
+    private dashboardStorageStrategy;
+    private loadDataSetsCallback;
+    private dashboards;
+    private vizzlyAPI;
+    private parentDashboardId;
+    /**
+     * Whether the API is currently loading.
+     * @default false
+     */
+    loading: boolean;
+    /**
+     *
+     * @param identity  The identity callback to use when retrieving the identity.
+     * @param loadQueryEngineConfig  The function to use when loading the query engine config.
+     * @param options  The options for the API.
+     */
+    constructor(identity: identityCallback, options?: APIOptions);
+    /**
+     * Retrieves the dashboards from the API.
+     *
+     * @returns A promise that resolves to an array of client-facing dashboards.
+     * @throws {Error} If an error occurs during the retrieval process.
+     */
+    getDashboards(): Promise<import("shared-logic/src/DashboardAPI/types").VizzlyDashboard[] | undefined>;
+    /**
+     * Retrieves all child dashboards.
+     *
+     * @returns A promise that resolves to an array of child dashboards.
+     * @throws {Error} If an error occurs while retrieving the child dashboards.
+     */
+    getAllChildDashboards(): Promise<import("shared-logic/src/DashboardAPI/types").VizzlyDashboard[] | undefined>;
+    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.
+     */
+    getParentDashboards(): Promise<import("shared-logic/src/DashboardAPI/types").VizzlyDashboard[] | undefined>;
+    /**
+     * Retrieves the child dashboards for a given parent dashboard.
+     * @param parentDashboardId The ID of the parent dashboard.
+     * @returns An array of child dashboards.
+     */
+    getChildDashboards(parentDashboardId: string): Promise<import("shared-logic/src/DashboardAPI/types").VizzlyDashboard[] | undefined>;
+    /**
+     * Creates a dashboard with the specified parameters.
+     *
+     * @param params - The parameters for creating the dashboard.
+     * @returns The created dashboard.
+     * @throws If there is an error during the creation process.
+     */
+    createDashboard(params: CreateDashboard): Promise<DashboardType | undefined>;
+    /**
+     * Updates a dashboard with the specified ID using the provided options.
+     * @param dashboardId - The ID of the dashboard to update.
+     * @param options - The options for updating the dashboard.
+     * @returns The updated dashboard.
+     */
+    updateDashboard(dashboardId: string, options: UpdateDashboardOptions): Promise<DashboardType | undefined>;
+    /**
+     * Deletes a dashboard.
+     * @param dashboardId The ID of the dashboard to delete.
+     * @returns The updated dashboard after deletion.
+     */
+    deleteDashboard(dashboardId: string): Promise<DashboardType | undefined>;
+    /**
+     * Checks if the user is an admin.
+     * @returns A promise that resolves to a string representing the user's access level ('admin' or 'user').
+     */
+    isAdmin(): Promise<"admin" | "standard" | undefined>;
+    /**
+     * Retrieves the default parent dashboard ID.
+     *
+     * @returns {Promise<string>} A promise that resolves to the default parent dashboard ID.
+     */
+    getDefaultParentDashboardId(): Promise<string>;
+    private checkEverythingIsDefined;
+    private fetchIdentityConfig;
+    private setPermissions;
+    private getDefaultParentDashboardIdBase;
+    getDashboardStorageStrategy(): DashboardStorageStrategy;
+}
+export {};

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

@@ -1,4 +1,4 @@
-import * as ComponentServices from './ComponentServices';
+import * as ViewServices from './ViewServices';
 import { AdditionalFilter } from 'shared-logic/src/AdditionalFilter/types';
 /**
  * Represents a CellAttributes type.
@@ -7,7 +7,7 @@ import { AdditionalFilter } from 'shared-logic/src/AdditionalFilter/types';
  * @param localFilters - The local filters of the cell. Optional.
  */
 export type CellAttributes = {
-    component?: ComponentServices.ComponentClasses;
+    component?: ViewServices.View;
     colSpan?: number;
     localFilters?: AdditionalFilter[];
 };
@@ -18,7 +18,7 @@ export declare class Cell {
     /**
      * The component contained within the cell. It's optional and can be undefined.
      */
-    component: ComponentServices.ComponentClasses | undefined;
+    component: ViewServices.View | undefined;
     /**
      * The span of the cell in terms of columns. Defaults to 12.
      */
@@ -54,7 +54,7 @@ export declare class Cell {
      *
      * @param component The component to be set in the cell.
      */
-    setComponent(component: ComponentServices.ComponentClasses): void;
+    setComponent(component: ViewServices.View): void;
     /**
      * Clears the component from the cell and optionally sets a new column span.
      * Marks the cell as empty.

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

@@ -1,6 +1,6 @@
 import { AdditionalFilter } from 'shared-logic/src/AdditionalFilter/types';
 import { Cell } from './CellServices';
-import * as ComponentServices from './ComponentServices';
+import * as ViewServices from './ViewServices';
 /**
  * Represents a Library class.
  * @param components An optional array of Component instances to initialize the library.
@@ -15,7 +15,7 @@ export declare class Library {
      * @param attributes An optional object containing the attributes of the library.
      */
     constructor(attributes?: {
-        components?: ComponentServices.ComponentClasses[];
+        components?: ViewServices.View[];
     });
     /**
      * Adds a cell to the library at a specified position or appends it at the end if no position is specified.
@@ -24,7 +24,7 @@ export declare class Library {
      * @example library.addComponent(Vizzly.AreaChart);
      * @example library.addComponent(Vizzly.AreaChart, { position: 0 });
      */
-    addComponent(component: ComponentServices.ComponentClasses, attributes?: {
+    addComponent(component: ViewServices.View, attributes?: {
         position?: number;
         localFilters?: AdditionalFilter[];
     }): void;
@@ -32,5 +32,5 @@ export declare class Library {
      *  Adds an array of cells to the library.
      * @param components An array of Component instances.
      */
-    addComponents(components: ComponentServices.ComponentClasses[]): void;
+    addComponents(components: ViewServices.View[]): void;
 }

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

@@ -28,7 +28,7 @@ export declare class Dashboard<T> {
      * @param attributes - The attributes of the dashboard.
      * @throws Error if the dashboard id is undefined.
      */
-    constructor(id: string, attributes?: DashboardAttributes);
+    constructor(id?: string | undefined, attributes?: DashboardAttributes);
     /**
      * Sets the display configuration for the dashboard.
      * @param display - An array of Row or Header objects representing the new

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

@@ -0,0 +1,61 @@
+import type { Component as VizzlyComponentType } from 'shared-logic/src/Component/types';
+import type { DataSet } from 'shared-logic/src/DataSet/types';
+interface ViewAttributes {
+    areaChart: VizzlyComponentType.AreaChartAttributes;
+    lineChart: VizzlyComponentType.LineChartAttributes;
+    barChart: VizzlyComponentType.BarChartAttributes;
+    pieChart: VizzlyComponentType.PieChartAttributes;
+    scatterChart: VizzlyComponentType.ScatterChartAttributes;
+    comboChart: VizzlyComponentType.ComboChartAttributes;
+    dataTable: VizzlyComponentType.DataTableAttributes;
+    basicTable: VizzlyComponentType.BasicTableAttributes;
+    horizontalBarChart: VizzlyComponentType.HorizontalBarChartAttributes;
+    mercatorMap: VizzlyComponentType.MercatorMapAttributes;
+    singleStat: VizzlyComponentType.SingleStatAttributes;
+    progress: VizzlyComponentType.ProgressAttributes;
+}
+export declare class ViewServices<T extends keyof ViewAttributes> {
+    componentType: T;
+    attributes: ViewAttributes[T] | undefined;
+    private dataSet;
+    constructor(componentType: T, dataSet: DataSet, attributes?: Partial<ViewAttributes[T]>);
+    updateAttributes(newAttributes: Partial<ViewAttributes[T]>): void;
+}
+export type View = AreaChart | LineChart | BarChart | PieChart | ScatterChart | ComboChart | PivotTable | BasicTable | HorizontalBarChart | MercatorMap | SingleStat | Progress;
+export declare class AreaChart extends ViewServices<'areaChart'> {
+    constructor(dataSet: DataSet, attributes?: Partial<ViewAttributes['areaChart']>);
+}
+export declare class LineChart extends ViewServices<'lineChart'> {
+    constructor(dataSet: DataSet, attributes?: Partial<ViewAttributes['lineChart']>);
+}
+export declare class BarChart extends ViewServices<'barChart'> {
+    constructor(dataSet: DataSet, attributes?: Partial<ViewAttributes['barChart']>);
+}
+export declare class PieChart extends ViewServices<'pieChart'> {
+    constructor(dataSet: DataSet, attributes?: Partial<ViewAttributes['pieChart']>);
+}
+export declare class ScatterChart extends ViewServices<'scatterChart'> {
+    constructor(dataSet: DataSet, attributes?: Partial<ViewAttributes['scatterChart']>);
+}
+export declare class ComboChart extends ViewServices<'comboChart'> {
+    constructor(dataSet: DataSet, attributes?: Partial<ViewAttributes['comboChart']>);
+}
+export declare class PivotTable extends ViewServices<'dataTable'> {
+    constructor(dataSet: DataSet, attributes?: Partial<ViewAttributes['dataTable']>);
+}
+export declare class BasicTable extends ViewServices<'basicTable'> {
+    constructor(dataSet: DataSet, attributes?: Partial<ViewAttributes['basicTable']>);
+}
+export declare class HorizontalBarChart extends ViewServices<'horizontalBarChart'> {
+    constructor(dataSet: DataSet, attributes?: Partial<ViewAttributes['horizontalBarChart']>);
+}
+export declare class MercatorMap extends ViewServices<'mercatorMap'> {
+    constructor(dataSet: DataSet, attributes?: Partial<ViewAttributes['mercatorMap']>);
+}
+export declare class SingleStat extends ViewServices<'singleStat'> {
+    constructor(dataSet: DataSet, attributes?: Partial<ViewAttributes['singleStat']>);
+}
+export declare class Progress extends ViewServices<'progress'> {
+    constructor(dataSet: DataSet, attributes?: Partial<ViewAttributes['progress']>);
+}
+export {};

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

@@ -1,28 +1,32 @@
 import { QueryEngineConfig, QueryEngineEndpoint } from '../../shared-logic/src/QueryEngineConfig/types';
-import * as ComponentServices from './Services/ComponentServices';
+import * as ViewServices from './Services/ViewServices';
 import { Cell } from './Services/CellServices';
 import { Row } from './Services/RowServices';
 import { Dashboard } from './Services/DashboardServices';
 import { Header } from './Services/HeaderServices';
 import { Library } from './Services/ComponentLibraryServices';
 import { loadQueryEngineConfigCallback } from '../../shared-logic/src/Callbacks/types';
+import { API } from './Services/APIServices';
 export declare class Vizzly {
-    static queryEngineConfig: QueryEngineConfig | null;
+    static queryEngineConfig: QueryEngineConfig | undefined;
+    static queryEngineEndpoint: QueryEngineEndpoint | loadQueryEngineConfigCallback | 'in-browser' | undefined;
     static load(configUrl: QueryEngineEndpoint | loadQueryEngineConfigCallback | 'in-browser'): Promise<QueryEngineConfig | null>;
     static get Dashboard(): typeof Dashboard;
     static get Library(): typeof Library;
     static get Cell(): typeof Cell;
     static get Row(): typeof Row;
     static get Header(): typeof Header;
-    static AreaChart: typeof ComponentServices.AreaChartClass;
-    static LineChart: typeof ComponentServices.LineChartClass;
-    static BarChart: typeof ComponentServices.BarChartClass;
-    static PieChart: typeof ComponentServices.PieChartClass;
-    static ScatterChart: typeof ComponentServices.ScatterChartClass;
-    static ComboChart: typeof ComponentServices.ComboChartClass;
-    static PivotTable: typeof ComponentServices.PivotTableClass;
-    static BasicTable: typeof ComponentServices.BasicTableClass;
-    static HorizontalBarChart: typeof ComponentServices.HorizontalBarChartClass;
-    static MercatorMap: typeof ComponentServices.MercatorMapClass;
-    static SingleStat: typeof ComponentServices.SingleStatClass;
+    static get API(): typeof API;
+    static AreaChart: typeof ViewServices.AreaChart;
+    static LineChart: typeof ViewServices.LineChart;
+    static BarChart: typeof ViewServices.BarChart;
+    static PieChart: typeof ViewServices.PieChart;
+    static ScatterChart: typeof ViewServices.ScatterChart;
+    static ComboChart: typeof ViewServices.ComboChart;
+    static PivotTable: typeof ViewServices.PivotTable;
+    static BasicTable: typeof ViewServices.BasicTable;
+    static HorizontalBarChart: typeof ViewServices.HorizontalBarChart;
+    static MercatorMap: typeof ViewServices.MercatorMap;
+    static SingleStat: typeof ViewServices.SingleStat;
+    static Progress: typeof ViewServices.Progress;
 }

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

@@ -0,0 +1,12 @@
+type MessageHistory = Array<{
+    content: string;
+    sender_type: 'user' | 'ai';
+    status: 'active';
+}>;
+export type ConversationState = {
+    message: string;
+    conversationId: string | undefined;
+    messageState: 'waitingForMessage' | 'thinking';
+    messageHistory: MessageHistory;
+};
+export {};

package/dist/shared-logic/src/ApiResource/index.d.ts

@@ -0,0 +1,7 @@
+export declare enum ApiResourcePrefix {
+    ConfigStore = "cnf_",
+    Project = "prj_",
+    KeyPair = "kyp_",
+    Dashboard = "dsh_",
+    ProjectApiKey = "vizzly_project_api_key_"
+}

package/dist/shared-logic/src/AreaChart/attributesSchema.d.ts

@@ -1,3 +1,3 @@
-import Joi from 'joi';
+import Joi from '@vizzly/joi';
 import { ComponentInterfaceConfig } from '../ComponentInterface/types';
 export declare const attributesSchema: (config: ComponentInterfaceConfig) => Joi.ObjectSchema<any>;

package/dist/shared-logic/src/BarChart/attributesSchema.d.ts

@@ -1,3 +1,3 @@
-import Joi from 'joi';
+import Joi from '@vizzly/joi';
 import { ComponentInterfaceConfig } from '../ComponentInterface/types';
 export declare const attributesSchema: (config: ComponentInterfaceConfig) => Joi.ObjectSchema<any>;

package/dist/shared-logic/src/Base64/index.d.ts

@@ -0,0 +1,3 @@
+export declare const encode: (str: string) => string;
+export declare const decode: (str: string) => string;
+export declare const isBase64: (str: string) => boolean;

package/dist/shared-logic/src/BasicTable/attributesSchema.d.ts

@@ -1,3 +1,3 @@
-import Joi from 'joi';
+import Joi from '@vizzly/joi';
 import { ComponentInterfaceConfig } from '../ComponentInterface/types';
 export declare const attributesSchema: (config: ComponentInterfaceConfig) => Joi.ObjectSchema<any>;

package/dist/shared-logic/src/ComboChart/attributesSchema.d.ts

@@ -1,3 +1,3 @@
-import Joi from 'joi';
+import Joi from '@vizzly/joi';
 import { ComponentInterfaceConfig } from '../ComponentInterface/types';
 export declare const attributesSchema: (config: ComponentInterfaceConfig) => Joi.ObjectSchema<any>;

package/dist/shared-logic/src/Component/Component.d.ts

@@ -1,8 +1,6 @@
 import { ComponentType, Component } from './types';
 import { EmptyCell, HeaderComponent } from '../Display/types';
-export declare const TIME_SERIES_CHARTS: ('areaChart' | 'lineChart' | 'horizontalBarChart' | 'barChart')[];
-export declare const ALL_COMPONENT_TYPES: ComponentType[];
-export declare const ALL_VIZZLY_COMPONENT_TYPES: ComponentType[];
+export * from './constants';
 export declare const initialCustomComponent: (componentId: string, dataSetId: string) => Component<Component.CustomComponentAttributes>;
 export declare const initial: <T extends Component.Attributes>(attributes: T) => Component<T>;
 export declare const initialFromType: (type: ComponentType, dataSetId: string, viewId: string) => Component;

package/dist/shared-logic/src/Component/attributesSchema.d.ts

@@ -1,3 +1,3 @@
-import Joi from 'joi';
+import Joi from '@vizzly/joi';
 import { ComponentInterfaceConfig } from '../ComponentInterface/types';
-export declare const attributesSchema: (config: ComponentInterfaceConfig) => Joi.AlternativesSchema<any>;
+export declare const attributesSchema: (config: ComponentInterfaceConfig) => Joi.AlternativesSchema<unknown>;

package/dist/shared-logic/src/Component/constants.d.ts

@@ -0,0 +1,4 @@
+import { ComponentType } from './types';
+export declare const TIME_SERIES_CHARTS: ('areaChart' | 'lineChart' | 'horizontalBarChart' | 'barChart')[];
+export declare const ALL_COMPONENT_TYPES: ComponentType[];
+export declare const ALL_VIZZLY_COMPONENT_TYPES: ComponentType[];

package/dist/shared-logic/src/Component/setAttributes.d.ts

@@ -1,4 +1,4 @@
-import Joi from 'joi';
+import Joi from '@vizzly/joi';
 import { QueryAttributes } from '../QueryAttributes/types';
 import { Component } from './types';
 export declare const removeUnusedOrderFieldsFromTimeSeriesComponent: <T extends {

package/dist/shared-logic/src/Component/sharedSchemas.d.ts

@@ -1,4 +1,4 @@
-import Joi from 'joi';
+import Joi from '@vizzly/joi';
 import { SupportedAggregates } from '../Aggregate';
 import { QueryEngineConfig } from '../QueryEngineConfig/types';
 import { SupportedTimeTruncFunctions } from '../TimeDimension/types';
@@ -17,11 +17,11 @@ export declare const baseAttributesSchema: {
     dataSetId: Joi.StringSchema<string>;
     protectedByOrganisation: Joi.BooleanSchema<boolean>;
 };
-export declare const approxAxisLabelCountSchema: Joi.Schema<any>;
+export declare const approxAxisLabelCountSchema: Joi.AnySchema<any>;
 export declare const timeDimensionQuerySchema: (queryEngineConfig: QueryEngineConfig) => {
     measure: Joi.ArraySchema<any[]>;
     dimension: Joi.ArraySchema<any[]>;
-    drilldown: Joi.AlternativesSchema<any>;
+    drilldown: Joi.AlternativesSchema<string | any[]>;
     order: Joi.ArraySchema<any[]>;
     timeDimension: Joi.AlternativesSchema<any>;
     limit: Joi.NumberSchema<number>;
@@ -33,14 +33,15 @@ export declare const timeDimensionQuerySchema: (queryEngineConfig: QueryEngineCo
     yAxisPostfix: Joi.StringSchema<string>;
     yAxisFormat: Joi.AlternativesSchema<any>;
     xAxisFormat: Joi.AlternativesSchema<any>;
-    approxYAxisLabelCount: Joi.Schema<any>;
-    approxXAxisLabelCount: Joi.Schema<any>;
+    approxYAxisLabelCount: Joi.AnySchema<any>;
+    approxXAxisLabelCount: Joi.AnySchema<any>;
 };
 export declare const lineCurveSchema: Joi.StringSchema<string>;
-export declare const protectedFieldsMeasure: () => Joi.ArraySchema<any[]>;
-export declare const protectedFieldsDimension: () => Joi.ArraySchema<any[]>;
+export declare const protectedFieldsMeasure: (queryEngineConfig: QueryEngineConfig) => Joi.ArraySchema<any[]>;
+export declare const protectedFieldsDimension: (queryEngineConfig: QueryEngineConfig) => Joi.ArraySchema<any[]>;
 export declare const parametersSchema: (queryEngineConfig: QueryEngineConfig) => Joi.ObjectSchema<any>;
 export declare const goalLineSchema: () => Joi.ObjectSchema<any>;
 export declare const goalLinesSchema: () => Joi.ArraySchema<any[]>;
 export declare const axisTitleSchema: () => Joi.ObjectSchema<any>;
 export declare const sizingSchema: Joi.ObjectSchema<any>;
+export declare const conditionalFormattingRulesSchema: (queryEngineConfig: QueryEngineConfig) => Joi.ArraySchema<any[]>;

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

@@ -9,7 +9,7 @@ import { TableFieldsV2 } from '../DataTable/types';
 export type getNumberFormatter = (formatterId: string | undefined | null) => (number: number) => string;
 export type FormatType = string | null;
 export type ApproxAxisLabelCount = 'auto' | number;
-export type ComponentType = 'barChart' | 'horizontalBarChart' | 'areaChart' | 'lineChart' | 'scatterChart' | 'pieChart' | 'singleStat' | 'dataTable' | 'basicTable' | 'comboChart' | 'mercatorMap' | 'custom';
+export type ComponentType = 'barChart' | 'horizontalBarChart' | 'areaChart' | 'lineChart' | 'scatterChart' | 'pieChart' | 'singleStat' | 'dataTable' | 'basicTable' | 'comboChart' | 'mercatorMap' | 'custom' | 'progress';
 export declare namespace Component {
     export type LineCurve = 'natural' | 'straight' | 'step' | 'stepBefore' | 'stepAfter';
     export type RawComponent = Omit<Component, 'queries' | 'results' | 'span'> & {
@@ -218,6 +218,22 @@ export declare namespace Component {
         deltaTimeDimension: QueryAttributes.TimeDimension | null;
         parameters?: Parameters;
     };
+    export type ProgressAttributes = BaseAttributes & Omit<BaseQueryAttributes, 'dimension' | 'timeDimension' | 'order'> & {
+        type: 'progress';
+        conditionalFormattingRules: Array<ConditionalFormatting.Rule>;
+        parameters?: Parameters;
+        goals?: ProgressGoal[];
+        progressType?: ProgressTypes[];
+        prefixes: {
+            [fieldIdAndAggregate: string]: string;
+        };
+        postfixes: {
+            [fieldIdAndAggregate: string]: string;
+        };
+        formatter: {
+            [fieldIdAndAggregate: string]: string;
+        };
+    };
     export type ScatterChartAttributes = BaseAttributes & Omit<BaseQueryAttributes, 'measure'> & {
         type: 'scatterChart';
         xMeasure: QueryAttributes.Measure | null;
@@ -234,7 +250,7 @@ export declare namespace Component {
         goalLines?: Array<Component.GoalLine.Rule>;
         axisTitles?: AxisTitles;
     };
-    export type Attributes = ScatterChartAttributes | LineChartAttributes | AreaChartAttributes | BarChartAttributes | PieChartAttributes | SingleStatAttributes | DataTableAttributes | BasicTableAttributes | ComboChartAttributes | HorizontalBarChartAttributes | MercatorMapAttributes | CustomComponentAttributes;
+    export type Attributes = ScatterChartAttributes | LineChartAttributes | AreaChartAttributes | BarChartAttributes | PieChartAttributes | SingleStatAttributes | DataTableAttributes | BasicTableAttributes | ComboChartAttributes | HorizontalBarChartAttributes | MercatorMapAttributes | CustomComponentAttributes | ProgressAttributes;
     type BaseOnViewClick = {
         viewId: string;
     };
@@ -315,3 +331,15 @@ export type Component<Attrs = Component.Attributes> = {
     colSpan: number;
     reports: Array<Report>;
 };
+export declare enum ProgressType {
+    Linear = "linear",
+    Circular = "circular"
+}
+export type ProgressGoal = {
+    field: string;
+    value: number;
+};
+export type ProgressTypes = {
+    field: string;
+    value: ProgressType;
+};

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

@@ -1,4 +1,4 @@
-import Joi from 'joi';
+import Joi from '@vizzly/joi';
 import { Dumpable } from '../Dumpable';
 import { QueryEngineConfig } from '../QueryEngineConfig/types';
 import { DataSet } from '../DataSet/types';
@@ -12,6 +12,8 @@ export type ComponentInterfaceConfig = {
 };
 export interface ComponentInterface<Hydrated = any, Dumped = any> extends Dumpable<Hydrated, Dumped> {
     title: string;
+    description: string;
+    servicesClass: string;
     setDataAttributesFromPreAggregatedDataSet?: (attributes: Hydrated, dataSet: DataSet) => Hydrated;
     removeField: (hydrated: Hydrated, fieldId: string) => Hydrated;
     init: (dataSetId: string, overrides?: Partial<Hydrated>) => Hydrated;

package/dist/shared-logic/src/DashboardAPI/dashboardAPI/creating.d.ts

@@ -0,0 +1,18 @@
+import { DataSet } from '../../DataSet/types';
+import * as Dashboard from 'shared-logic/src/Dashboard';
+import { api } from '../../api';
+import { IdentityConfig as IdentityConfigType } from 'shared-logic/src/IdentityConfig/types';
+import { CreateDashboardParams } from '../../api/vizzly/createDashboard';
+import { DashboardPermission as DashboardPermissionType, RawDashboardPermission } from 'shared-logic/src/DashboardPermission/types';
+import { DashboardStorageStrategy } from '../types';
+export declare function prepareCreateResponseForAdding(createdDashboardResponse: {
+    dashboard: Dashboard.RawDashboard;
+    permissions: RawDashboardPermission[];
+}, dataSets: DataSet[]): {
+    createdDashboard: Dashboard.Dashboard;
+    formattedPermissions: DashboardPermissionType[];
+};
+export declare function postCreateDashboard(params: Omit<CreateDashboardParams, 'dashboardAccessToken'>, identityConfig: IdentityConfigType, dashboardStorageStrategy: DashboardStorageStrategy, vizzlyAPI: ReturnType<typeof api>): Promise<{
+    dashboard: Dashboard.RawDashboard;
+    permissions: RawDashboardPermission[];
+}>;

package/dist/shared-logic/src/DashboardAPI/dashboardAPI/updating.d.ts

@@ -0,0 +1,16 @@
+import { DataSet } from '../../DataSet/types';
+import { Dashboard as DashboardType } from 'shared-logic/src/Dashboard/types';
+import * as Dashboard from 'shared-logic/src/Dashboard';
+import { api } from '../../api';
+import { UnEncryptedDashboardUpdateResponse, UpdateDashboardParams } from '../../api/vizzly/updateDashboard';
+import { DashboardStorageStrategy } from '../types';
+export declare function postUpdateDashboard(dashboardStorageStrategy: DashboardStorageStrategy, vizzlyAPI: ReturnType<typeof api>, updateParams: {
+    dashboardSessionToken: string;
+    definition?: Dashboard.SaveableDashboardDefinition;
+    meta?: any;
+    deleted?: boolean;
+}): Promise<UnEncryptedDashboardUpdateResponse>;
+export declare function updateDashboardFromUpdateResponse(updatedDashboardResponse: UnEncryptedDashboardUpdateResponse, dataSets: DataSet[], dashboards: DashboardType[], params: Omit<UpdateDashboardParams, 'dashboardSessionToken'>): {
+    newDashboards: DashboardType[];
+    updatedDashboard: DashboardType;
+};

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

@@ -0,0 +1,17 @@
+import { DataSet } from '../DataSet/types';
+import { DashboardPermission as DashboardPermissionType } from 'shared-logic/src/DashboardPermission/types';
+import { Dashboard as DashboardType } from 'shared-logic/src/Dashboard/types';
+import { QueryEngineConfig, QueryEngineEndpoint } from '../QueryEngineConfig/types';
+import { api } from '../api';
+import { IdentityConfig as IdentityConfigType } from 'shared-logic/src/IdentityConfig/types';
+import { DashboardStorageStrategy } from './types';
+export * from './dashboardAPI/creating';
+export * from './dashboardAPI/updating';
+export declare function getDashboards<T extends {
+    found?: any[];
+}>(dashboardsResponse: T, dataSets: DataSet[]): DashboardType[];
+export declare function fetchDashboards(dashboardStorageStrategy: DashboardStorageStrategy, vizzlyAPI: ReturnType<typeof api>, dashboardAccessTokens: string[], abortController: AbortController): Promise<import("../api/vizzly/multiGetDashboards").Response>;
+export declare const DEFAULT_STRATEGY: DashboardStorageStrategy;
+export declare const getDashboardStorageStrategy: (queryEngineEndpoint: Function | QueryEngineEndpoint | undefined, queryEngineConfig: QueryEngineConfig | undefined) => DashboardStorageStrategy;
+export declare const getDefaultParentDashboardId: (parentDashboardId: string | undefined, parentDashboardIdOnDashboardAccessToken: IdentityConfigType['dashboardAccess']['dashboardId'], dashboards: Array<DashboardType>) => string;
+export declare function buildDashboardAccessTokens(permissions: DashboardPermissionType[]): string[];

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

@@ -0,0 +1,6 @@
+import { Dashboard } from '../Dashboard/types';
+import { VizzlyDashboard } from './types';
+export declare function buildClientFacingDashboards(dashboards: Dashboard[]): VizzlyDashboard[];
+export declare const getChildDashboards: (parentDashboardId: string, clientFacingDash: VizzlyDashboard[]) => VizzlyDashboard[];
+export declare function getAllClientFacingChildDashboards(clientFacingDash: VizzlyDashboard[]): VizzlyDashboard[];
+export declare function getParentDashboards(clientFacingDash: VizzlyDashboard[]): VizzlyDashboard[];

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

@@ -0,0 +1,7 @@
+import { IdentityTokens } from '../Callbacks/types';
+import { identityCallback as identityCallbackImported } from 'shared-logic/src/Callbacks/types';
+export type identityCallback = identityCallbackImported;
+export declare const fetchIdentityConfig: (identityCallback: identityCallbackImported) => Promise<{
+    identityConfig: import("../IdentityConfig/types").IdentityConfig;
+    tokens: IdentityTokens;
+}>;

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

@@ -0,0 +1,12 @@
+import Joi from '@vizzly/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/DashboardAPI/getDashboardAdminOverride.d.ts

@@ -0,0 +1 @@
+export declare const getDashboardAdminOverride: (url: string) => string | null;