@vizzly/dashboard 0.11.0 → 0.12.0-dev-e9cb501d005236550d32fd4ffe3eaeb1307996b1

package/dist/results-driver/src/driver/VizzlyQuery/AreaChart/toQueries.d.ts

@@ -1,4 +1,4 @@
-export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
+export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/dashboard/src").QueryEngineConfig) => {
     queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
     resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
 };

package/dist/results-driver/src/driver/VizzlyQuery/BarChart/toQueries.d.ts

@@ -1,4 +1,4 @@
-export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
+export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/dashboard/src").QueryEngineConfig) => {
     queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
     resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
 };

package/dist/results-driver/src/driver/VizzlyQuery/BasicTable/toQueries.d.ts

@@ -1,4 +1,4 @@
-export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
+export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/dashboard/src").QueryEngineConfig) => {
     queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
     resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
 };

package/dist/results-driver/src/driver/VizzlyQuery/HorizontalBarChart/toQueries.d.ts

@@ -1,4 +1,4 @@
-export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
+export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/dashboard/src").QueryEngineConfig) => {
     queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
     resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
 };

package/dist/results-driver/src/driver/VizzlyQuery/LineChart/toQueries.d.ts

@@ -1,4 +1,4 @@
-export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
+export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/dashboard/src").QueryEngineConfig) => {
     queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
     resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
 };

package/dist/results-driver/src/driver/VizzlyQuery/PieChart/toQueries.d.ts

@@ -1,4 +1,4 @@
-export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
+export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/dashboard/src").QueryEngineConfig) => {
     queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
     resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
 };

package/dist/results-driver/src/driver/VizzlyQuery/PivotTable/toQueries.d.ts

@@ -1,4 +1,4 @@
-export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("../../../../../shared-logic/src/QueryEngineConfig/types").QueryEngineConfig) => {
+export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/dashboard/src").QueryEngineConfig) => {
     queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
     resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
 };

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

@@ -0,0 +1,65 @@
+import { AdditionalFilter } from '../../../shared-logic/src/AdditionalFilter/types';
+import { AnyView } from './View';
+/**
+ * Represents a CellAttributes type.
+ * @param component - The component contained within the cell. Optional.
+ * @param colSpan - The span of the cell in terms of columns. Defaults to 12.
+ * @param localFilters - The local filters of the cell. Optional.
+ */
+export declare type CellAttributes = {
+    component?: AnyView;
+    colSpan?: number;
+    localFilters?: AdditionalFilter[];
+};
+/**
+ * Represents a cell in a layout, which can contain a component and has a specified column span.
+ */
+export declare class Cell {
+    /**
+     * The component contained within the cell. It's optional and can be undefined.
+     */
+    component: AnyView | undefined;
+    /**
+     * The span of the cell in terms of columns. Defaults to 12.
+     */
+    colSpan: number;
+    /**
+     * The local filters of the cell. Optional.
+     */
+    localFilters: AdditionalFilter[] | undefined;
+    /**
+     * Indicates whether the cell is empty. It's either true or undefined.
+     */
+    isEmpty: boolean | undefined;
+    /**
+     * Constructs a new Cell instance.
+     *
+     * @param attributes The attributes of the cell.
+     */
+    constructor(attributes?: CellAttributes);
+    /**
+     * Sets or updates the cell's component and column span.
+     *
+     * @param attributes The attributes to be set in the cell.
+     */
+    set(attributes: CellAttributes): void;
+    /**
+     * Sets the column span of the cell.
+     *
+     * @param colSpan The new column span for the cell. Number should be between 1 and 12.
+     */
+    setColSpan(colSpan: number): void;
+    /**
+     * Sets the component of the cell.
+     *
+     * @param component The component to be set in the cell.
+     */
+    setComponent(component: AnyView): void;
+    /**
+     * Clears the component from the cell and optionally sets a new column span.
+     * Marks the cell as empty.
+     *
+     * @param colSpan The new column span for the cell. If not provided, defaults to 12.
+     */
+    emptyCell(colSpan?: number): void;
+}

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

@@ -0,0 +1,55 @@
+import * as DashboardTypes from '../../../shared-logic/src/Dashboard/types';
+import { Row } from './Row';
+import { CustomField } from '../../../shared-logic/src/CustomField/types';
+import { Header } from './Header';
+import { Library } from './Library';
+/** Custom fields for a dashboard */
+export declare type CustomFields = {
+    [dataSetId: string]: Array<CustomField>;
+};
+/**
+ * Represents a DashboardAttributes type.
+ * @param display - The display configuration for the dashboard.
+ * @param customFields - The custom fields of the dashboard.
+ * @param library - The component library of the dashboard.
+ */
+export declare type DashboardAttributes = {
+    display?: (Row | Header)[];
+    customFields?: CustomFields;
+    library?: Library;
+};
+/**
+ * Represents a Dashboard class.
+ */
+export declare class Dashboard {
+    private dashboard;
+    /**
+     * Constructs a new instance of the Dashboard class.
+     * @param id - The id of the dashboard.
+     * @param attributes - The attributes of the dashboard.
+     * @throws Error if the dashboard id is undefined.
+     */
+    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
+     *                  display configuration for the dashboard.
+     * @throws Error if the dashboard instance is undefined.
+     */
+    setDisplay(display: (Row | Header)[]): void;
+    /**
+     * Sets the custom fields of the dashboard.
+     * @param customFields
+     */
+    setCustomFields(customFields: CustomFields): void;
+    /**
+     * Sets the component library of the dashboard.
+     * @param library
+     */
+    setLibrary(library: Library): void;
+    /**
+     * Builds a partial DashboardType object.
+     * @returns A partial DashboardType object.
+     */
+    build(): DashboardTypes.SaveableDashboardDefinition;
+}

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

@@ -0,0 +1,19 @@
+import { DisplayRow } from '../../../shared-logic/src/Display/types';
+export declare type HeaderRow = DisplayRow[];
+/**
+ * Represents a Header class.
+ */
+export declare class Header {
+    /** The header component. */
+    component: HeaderRow | undefined;
+    /**
+     * Constructs a new instance of the HeaderServices class.
+     * @param title - An optional title for the header.
+     */
+    constructor(title?: string);
+    /**
+     * Sets the title of the header.
+     * @param title - The title to set.
+     */
+    setTitle(title: string): void;
+}

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

@@ -0,0 +1,43 @@
+import { AdditionalFilter } from '../../../shared-logic/src/AdditionalFilter/types';
+import { Cell } from './Cell';
+import * as Views from './View';
+/**
+ * Represents a Library class.
+ * @param components The `component` instance to be added to the library. `uniqueViewId` of the component, should always be the same and not auto-generated.
+ */
+export declare type LibraryView = {
+    component: Views.AnyView;
+    uniqueViewId: string;
+};
+export declare class Library {
+    /**
+     * An array of Cell instances representing the cells in the library.
+     */
+    library: Cell[] | undefined;
+    /**
+     * Creates a new instance of a Library.
+     * @param attributes An optional object containing the attributes of the library.
+     * @param components The `component` instance to be added to the library. `uniqueViewId` of the component, should always be the same and not auto-generated.
+     */
+    constructor(attributes?: {
+        components?: LibraryView[];
+    });
+    /**
+     * Adds a cell to the library at a specified position or appends it at the end if no position is specified.
+     * @param component The Component instance to be added to the library.
+     * @param uniqueViewId The unique view id of the component, should always be the same and not auto-generated. The `uniqueViewId` will become the `viewId` of the component.
+     * @param attributes An optional object containing the attributes of the cell.
+     * @example library.addComponent(Vizzly.AreaChart, "uniqueViewId");
+     * @example library.addComponent(Vizzly.AreaChart, "uniqueViewId", { position: 0 });
+     */
+    addComponent(component: Views.AnyView, uniqueViewId: string, attributes?: {
+        position?: number;
+        localFilters?: AdditionalFilter[];
+    }): void;
+    /**
+     *  Adds an array of cells to the library.
+     * @param components The `component` instance to be added to the library. `uniqueViewId` of the component, should always be the same and not auto-generated.
+     */
+    addComponents(components: LibraryView[]): void;
+}
+export declare const mergeInViewId: (component: Views.AnyView, uniqueViewId: string) => Views.AnyView;

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

@@ -0,0 +1,45 @@
+import { Cell } from './Cell';
+/**
+ * Represents a Row class.
+ */
+export declare class Row {
+    /**
+     * An array of Cell instances representing the cells in the row.
+     */
+    components: Cell[];
+    /**
+     * The height of the row, defaulting to 350.
+     */
+    height: number | undefined;
+    /**
+     * Creates a new instance of a Row.
+     * @param components An optional array of Cell instances to initialize the row.
+     * @param height An optional height for the row, defaults to 350.
+     */
+    constructor(components?: Cell[], height?: number);
+    /**
+     * Adds a cell to the row at a specified position or appends it at the end if no position is specified.
+     *
+     * @param component The Cell instance to be added to the row.
+     * @param position (Optional) The zero-based index at which to add the cell.
+     *                 If omitted, the cell is added at the end of the row.
+     */
+    addCell(component: Cell, position?: number): void;
+    /**
+     * Sets the height of the row.
+     * @param height The height to set for the row.
+     */
+    setHeight(height: number): void;
+    /**
+     * Sets the cells and optionally the height of the row.
+     * @param components An array of Cell instances.
+     */
+    setRow(components: Cell[]): void;
+    /**
+     * Sets the cells and optionally the height of the row.
+     * @param components An array of Cell instances.
+     * @param height An optional height to set for the row.
+     */
+    set(components: Cell[], height?: number): void;
+    private validateTotalColSpan;
+}

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

@@ -0,0 +1,65 @@
+import type { Component } from '../../../shared-logic/src/Component/types';
+import { ViewConfiguration as ViewConfigurationImported } from '../../../shared-logic/src/ViewConfiguration/types';
+import { Vizzly } from '..';
+export declare type ViewConfiguration = ViewConfigurationImported;
+declare type RequiredAttributes<T extends Component.Attributes> = {
+    dataSetId: T['dataSetId'];
+};
+export declare class View<T extends Component.Attributes> {
+    attributes: T;
+    protected vizzly: Vizzly;
+    constructor(attributes: Partial<T> & {
+        type: T['type'];
+    } & RequiredAttributes<T>);
+    updateAttributes(newAttributes: Partial<T>): void;
+}
+export declare type AnyView = AreaChart | LineChart | BarChart | PieChart | ScatterChart | ComboChart | PivotTable | BasicTable | HorizontalBarChart | MercatorMap | SingleStat | Progress;
+export declare class AreaChart extends View<Component.AreaChartAttributes> {
+    constructor(attributes: Partial<Component.AreaChartAttributes> & RequiredAttributes<Component.AreaChartAttributes>);
+    static type(): Component.AreaChartAttributes['type'];
+}
+export declare class LineChart extends View<Component.LineChartAttributes> {
+    constructor(attributes: Partial<Component.LineChartAttributes> & RequiredAttributes<Component.LineChartAttributes>);
+    static type(): Component.LineChartAttributes['type'];
+}
+export declare class BarChart extends View<Component.BarChartAttributes> {
+    constructor(attributes: Partial<Component.BarChartAttributes> & RequiredAttributes<Component.BarChartAttributes>);
+    static type(): Component.BarChartAttributes['type'];
+}
+export declare class PieChart extends View<Component.PieChartAttributes> {
+    constructor(attributes: Partial<Component.PieChartAttributes> & RequiredAttributes<Component.PieChartAttributes>);
+    static type(): Component.PieChartAttributes['type'];
+}
+export declare class ScatterChart extends View<Component.ScatterChartAttributes> {
+    constructor(attributes: Partial<Component.ScatterChartAttributes> & RequiredAttributes<Component.ScatterChartAttributes>);
+    static type(): Component.ScatterChartAttributes['type'];
+}
+export declare class ComboChart extends View<Component.ComboChartAttributes> {
+    constructor(attributes: Partial<Component.ComboChartAttributes> & RequiredAttributes<Component.ComboChartAttributes>);
+    static type(): Component.ComboChartAttributes['type'];
+}
+export declare class PivotTable extends View<Component.DataTableAttributes> {
+    constructor(attributes: Partial<Component.DataTableAttributes> & RequiredAttributes<Component.DataTableAttributes>);
+    static type(): Component.DataTableAttributes['type'];
+}
+export declare class BasicTable extends View<Component.BasicTableAttributes> {
+    constructor(attributes: Partial<Component.BasicTableAttributes> & RequiredAttributes<Component.BasicTableAttributes>);
+    static type(): Component.BasicTableAttributes['type'];
+}
+export declare class HorizontalBarChart extends View<Component.HorizontalBarChartAttributes> {
+    constructor(attributes: Partial<Component.HorizontalBarChartAttributes> & RequiredAttributes<Component.HorizontalBarChartAttributes>);
+    static type(): Component.HorizontalBarChartAttributes['type'];
+}
+export declare class MercatorMap extends View<Component.MercatorMapAttributes> {
+    constructor(attributes: Partial<Component.MercatorMapAttributes> & RequiredAttributes<Component.MercatorMapAttributes>);
+    static type(): Component.MercatorMapAttributes['type'];
+}
+export declare class SingleStat extends View<Component.SingleStatAttributes> {
+    constructor(attributes: Partial<Component.SingleStatAttributes> & RequiredAttributes<Component.SingleStatAttributes>);
+    static type(): Component.SingleStatAttributes['type'];
+}
+export declare class Progress extends View<Component.ProgressAttributes> {
+    constructor(attributes: Partial<Component.ProgressAttributes> & RequiredAttributes<Component.ProgressAttributes>);
+    static type(): Component.ProgressAttributes['type'];
+}
+export {};

package/dist/services/src/errors/ServicesValidationError.d.ts

@@ -0,0 +1,2 @@
+export declare class ServicesValidationError extends Error {
+}

package/dist/services/src/errors/TimeoutWaitingForVizzlyInstance.d.ts

@@ -0,0 +1,3 @@
+export declare class TimeoutWaitingForVizzlyInstance extends Error {
+    constructor(instanceId: string, timeout: number);
+}

package/dist/services/src/errors/VizzlyInstanceNotLoaded.d.ts

@@ -0,0 +1,3 @@
+export declare class VizzlyInstanceNotLoaded extends Error {
+    constructor(instanceId: string);
+}

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

@@ -0,0 +1,125 @@
+import { QueryEngineConfig, QueryEngineEndpoint } from '../../shared-logic/src/QueryEngineConfig/types';
+import { identityCallback, loadDataSetsCallback, loadQueryEngineConfigCallback, programmaticDashboardCallback } from '../../shared-logic/src/Callbacks/types';
+import { IdentityConfig } from '../../shared-logic/src/IdentityConfig/types';
+import { DashboardStorageStrategy } from '../../shared-logic/src/DashboardAPI/types';
+import { DataSet } from '../../shared-logic/src/DataSet/types';
+import { Dashboard as DashboardFromAPI } from '@vizzly/api-client';
+import * as DashboardLogic from '../../shared-logic/src/Dashboard';
+import * as GlobalLibraryLogic from '../../shared-logic/src/GlobalLibrary';
+import { LoaderOptions } from './VizzlyLoader';
+import { Row } from './Services/Row';
+import { Cell } from './Services/Cell';
+import { Dashboard } from './Services/Dashboard';
+import { Header } from './Services/Header';
+import { Library } from './Services/Library';
+import * as Views from './Services/View';
+import { ViewConfiguration } from '../../shared-logic/src/ViewConfiguration/types';
+export type { ViewConfiguration } from '../../shared-logic/src/ViewConfiguration/types';
+export { VizzlyInstanceNotLoaded } from './errors/VizzlyInstanceNotLoaded';
+export declare type Options = {
+    apiHost: string;
+};
+export declare type FilterDashboardOptions = {
+    onlyAllowScope?: 'read' | 'read_write';
+    onlyChildDashboardsForParent?: string;
+    onlyChildDashboards?: boolean;
+    onlyParentDashboards?: boolean;
+    onlyDashboardsIncludingMetadata?: DashboardLogic.Dashboard['metadata'];
+};
+export declare type VizzlyServicesProperties = {
+    queryEngine: 'in-browser' | QueryEngineEndpoint | loadQueryEngineConfigCallback | undefined;
+    identity: identityCallback;
+    programmaticDashboard?: programmaticDashboardCallback;
+    dataSets?: loadDataSetsCallback;
+};
+declare class VizzlyServices {
+    private queryEngineConfig;
+    private dataSets;
+    private identityConfig;
+    private vizzlyAPIClient;
+    private programmaticDashboard;
+    static _instanceStore: {
+        [instanceId: string]: VizzlyServices;
+    };
+    static DEFAULT_INSTANCE_ID: string;
+    constructor(identityConfig: IdentityConfig, queryEngineConfig: QueryEngineConfig, dataSets: DataSet[], dashboardStorageStrategy: DashboardStorageStrategy, programmaticDashboard: programmaticDashboardCallback | undefined, options: {
+        host: string;
+    });
+    /**
+     * @param properties
+     * @param options
+     * @returns Vizzly instance for programmatically managing dashboards.
+     */
+    static load(properties: VizzlyServicesProperties, options?: LoaderOptions): Promise<VizzlyServices>;
+    static use(instanceId?: string): VizzlyServices;
+    static waitToUse(instanceId?: string, timeoutMs?: number): Promise<any>;
+    static clearInstances(): void;
+    /**
+     * Use the dashboard API to create the dashboard, upcast
+     * and return the dashboard with the data sets.
+     */
+    createDashboard(params: CreateDashboardParams): Promise<DashboardLogic.Dashboard>;
+    updateDashboard(params: UpdateDashboardParams): Promise<DashboardLogic.Dashboard>;
+    getDashboards(params?: {
+        abortController?: AbortController;
+    }): Promise<DashboardLogic.Dashboard[]>;
+    getGlobalLibraries(params?: {
+        abortController?: AbortController;
+    }): Promise<GlobalLibraryLogic.GlobalLibrary[]>;
+    /**
+     * Provides the configuration needed for each Vizzly view.
+     */
+    getViewConfiguration(): ViewConfiguration;
+    getIdentityConfig(): IdentityConfig;
+    static upcastDashboard(dashboard: DashboardFromAPI, dataSets: DataSet[], queryEngineConfig: QueryEngineConfig): Array<DashboardLogic.Dashboard>;
+    static filterDashboards(dashboards: DashboardLogic.Dashboard[], options: FilterDashboardOptions): DashboardLogic.Dashboard[];
+    static validateDashboard(dashboard: unknown): void;
+    static Row: typeof Row;
+    static Cell: typeof Cell;
+    static Dashboard: typeof Dashboard;
+    static Header: typeof Header;
+    static Library: typeof Library;
+    static AreaChart: typeof Views.AreaChart;
+    static LineChart: typeof Views.LineChart;
+    static BarChart: typeof Views.BarChart;
+    static PieChart: typeof Views.PieChart;
+    static ScatterChart: typeof Views.ScatterChart;
+    static ComboChart: typeof Views.ComboChart;
+    static PivotTable: typeof Views.PivotTable;
+    static BasicTable: typeof Views.BasicTable;
+    static HorizontalBarChart: typeof Views.HorizontalBarChart;
+    static MercatorMap: typeof Views.MercatorMap;
+    static SingleStat: typeof Views.SingleStat;
+    static Progress: typeof Views.Progress;
+}
+export declare type UpdateDashboardParams = {
+    dashboardId: string;
+    definition?: DashboardLogic.SaveableDashboardDefinition;
+    deleted?: boolean;
+    metadata?: Object;
+    /** @deprecated Use metadata instead. */
+    meta?: Object;
+    abortSignal?: AbortSignal;
+};
+export declare type CreateDashboardParams = {
+    definition: DashboardLogic.SaveableDashboardDefinition;
+    /** @deprecated - use `metadata` instead */
+    meta?: Object;
+    /**
+     * The metadata for the dashboard.
+     *
+     * @property {any} meta - The metadata for the dashboard can be set to anything you require.
+     *
+     */
+    metadata?: Object;
+    /**
+     * The ID of the parent dashboard.
+     *
+     * @property {string} parentDashboardId - The ID of the parent dashboard.
+     * @default The default parent dashboard ID.
+     */
+    parentDashboardId: string;
+    abortSignal?: AbortSignal;
+};
+export declare type Vizzly = VizzlyServices;
+export declare const Vizzly: typeof VizzlyServices;

package/dist/services/src/schemaValidations/cell.d.ts

@@ -0,0 +1 @@
+export declare function validateColSpan(colSpan: number): any;

package/dist/services/src/schemaValidations/dashboard.d.ts

@@ -0,0 +1,4 @@
+import { QueryEngineConfig } from '../../../shared-logic/src/QueryEngineConfig/types';
+import { CreateDashboardParams, UpdateDashboardParams } from '..';
+export declare const validateCreateDashboardParams: (params: CreateDashboardParams, queryEngineConfig: QueryEngineConfig | undefined) => void;
+export declare const validateUpdateDashboardParams: (params: UpdateDashboardParams, queryEngineConfig: QueryEngineConfig) => void;

package/dist/services/src/schemaValidations/filters.d.ts

@@ -0,0 +1,3 @@
+import { AdditionalFilter } from '../../../shared-logic/src/AdditionalFilter/types';
+import { QueryEngineConfig } from '../../../shared-logic/src/QueryEngineConfig/types';
+export declare function validateAndSetLocalFilters(localFilters: AdditionalFilter[], queryEngineConfig: QueryEngineConfig): AdditionalFilter[];

package/dist/services/src/schemaValidations/library.d.ts

@@ -0,0 +1,2 @@
+import { LibraryView } from '../Services/Library';
+export declare function validateLibraryComponent(item: LibraryView): void;

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

@@ -1,8 +1,10 @@
+import { SaveableDashboardDefinition } from '../Dashboard/types';
 import { DataSet } from '../DataSet/types';
 import { IdentityConfig } from '../IdentityConfig/types';
 import { DataMap } from '../JSQueryEngine/types';
 import { QueryEngineConfig } from '../QueryEngineConfig/types';
 declare type CallbackError = null;
+export declare type programmaticDashboardCallback = (dataSets: DataSet[]) => Promise<Array<Partial<SaveableDashboardDefinition>>>;
 export declare type loadDataSetsCallback = (identityConfig: IdentityConfig, queryEngineConfig: QueryEngineConfig) => Promise<Array<DataSet>>;
 export declare type IdentityTokens = {
     dashboardAccessToken: string;

package/dist/shared-logic/src/Dashboard/fromRaw.d.ts

@@ -14,5 +14,9 @@ export declare type RawDashboard<Definition = RawDefinition> = {
     updated_at: string;
     metadata?: Dashboard.ExternalMetadata;
     webhook_id: string | null;
+    permission: {
+        scope: 'read' | 'read_write';
+        token: string;
+    };
 };
 export declare const fromRaw: (rawDashboard: RawDashboard, queryEngineConfig: QueryEngineConfig | undefined) => Omit<Dashboard, 'dataSets'>;

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

@@ -13,6 +13,9 @@ export declare type Dashboard = {
     id: string;
     parentDashboardId: string | null;
     metadata: Dashboard.ExternalMetadata;
+    /**
+     * @deprecated
+     */
     theme: StoredTheme;
     display: Display;
     webhookId: string | null;
@@ -23,8 +26,13 @@ export declare type Dashboard = {
     isPlayground: boolean;
     createdAt: Date;
     updatedAt: Date;
+    /** @deprecated */
     protectedByOrganisation?: boolean;
     isProgrammatic?: boolean;
+    permission?: {
+        scope: 'read' | 'read_write';
+        token: string;
+    };
 };
 export declare type SaveableDashboardDefinition = {
     display: DisplayDumped;

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

@@ -1,17 +1,7 @@
-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[], queryEngineConfig: QueryEngineConfig | undefined): 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/dataSets.d.ts

@@ -1,17 +1,9 @@
 import Joi from '@vizzly/joi';
-import { loadDataSetsCallback } from '../../../shared-logic/src/Callbacks/types';
-import { IdentityConfig } from '../../../shared-logic/src/IdentityConfig/types';
-import { DataSet } from '../DataSet/types';
-export declare type DataSetsCallback = (identityConfig: IdentityConfig) => Promise<Array<DataSet> | null>;
+import { loadDataSetsCallback, loadQueryEngineConfigCallback } from '../../../shared-logic/src/Callbacks/types';
+import { QueryEngineEndpoint } from '../../../shared-logic/src/QueryEngineConfig/types';
 export interface Property {
     schema: Joi.Schema;
 }
 declare const dataSets: Property;
 export default dataSets;
-export declare const withReturnValidation: (dataSets?: DataSetsCallback | undefined, querEngineEndpoint?: string | {
-    endpoint: string;
-    dynamicConfig?: Object | undefined;
-    customHeaders?: (() => {
-        [headerKey: string]: string;
-    }) | undefined;
-} | undefined) => loadDataSetsCallback;
+export declare const withReturnValidation: (dataSets: loadDataSetsCallback | undefined, queryEngineEndpoint: QueryEngineEndpoint | loadQueryEngineConfigCallback | undefined) => loadDataSetsCallback;