@vizzly/services 0.15.0-dev-2ac2b2368a7d8a0435fd154136da3d92544f1457 → 0.15.0-dev-bc6f19593aed01265451bf653c609179437c2ef0

package/dist/results-driver/src/types.d.ts

@@ -1,42 +0,0 @@
-import { QueryEngineConfig, QueryEngineEndpoint } from '../../shared-logic/src/QueryEngineConfig/types';
-import { DataSet, DataSet as DataSetType } from '../../shared-logic/src/DataSet/types';
-import { TimeRangeOptions, FilterConfig } from '../../shared-logic/src/AdditionalFilter/types';
-import { loadDataCallback } from '../../shared-logic/src/Callbacks/types';
-import { Query } from '../../shared-logic/src/Query/types';
-import { Result } from '../../shared-logic/src/Result/types';
-import { VariableList } from '../../shared-logic/src/Variables/types';
-import { AliasFields } from '../../shared-logic/src/AliasFields/types';
-export declare type VizzlyQueryEngineDriver = {
-    type: 'vizzlyQueryEngine';
-    queryEngineConfig: QueryEngineConfig;
-    queryEngineEndpoint: QueryEngineEndpoint;
-    dataAccessToken: string;
-    cacheKeyNamespace: string;
-};
-export declare type CustomDriver = {
-    type: 'custom';
-    queryEngineConfig: QueryEngineConfig;
-    dataAccessToken?: string;
-    cacheKeyNamespace: string;
-    runQueries: (queries: Query[], params: {
-        dataSets: DataSet[];
-        abortSignal?: AbortSignal;
-        dataAccessToken?: string;
-        filterConfig?: FilterConfig;
-    }) => Promise<Array<Result | Result['content'] | null> | null>;
-};
-export declare type VizzlyJsQueryEngineDriver = {
-    type: 'vizzlyJsQueryEngine';
-    loadData: loadDataCallback;
-    cacheKeyNamespace: string;
-};
-export declare type Driver = VizzlyQueryEngineDriver | VizzlyJsQueryEngineDriver | CustomDriver;
-export declare type Params = {
-    dataSets: Array<DataSetType>;
-    filterConfig: FilterConfig;
-    abortSignal?: AbortSignal;
-    timeRangeOptions: TimeRangeOptions;
-    timeZone?: string;
-    variables: VariableList;
-    aliasFields: AliasFields;
-};

package/dist/results-driver/src/utils/browserCache.d.ts

@@ -1,3 +0,0 @@
-export declare const set: (cacheKey: any, item: any, expiryInSeconds: number) => void;
-export declare const get: <T>(cacheKey: any) => T | null;
-export declare const clear: () => void;

package/dist/results-driver/src/utils/runWithValidationAndCaching.d.ts

@@ -1,6 +0,0 @@
-import { PreparedQuery } from '../../../shared-logic/src/Query/types';
-/** A generic function to validate a list of queries, and then only run the ones which are valid. */
-declare const runWithValidationAndCaching: <Query, Result>(queries: (PreparedQuery | Query)[], isRunnable: (query: PreparedQuery | Query) => boolean, run: (queries: (PreparedQuery | Query)[]) => Promise<{
-    results: (Result | null)[] | null;
-} | null>, cacheKey: (query: PreparedQuery | Query) => any) => Promise<(Result | null)[] | null>;
-export default runWithValidationAndCaching;

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

@@ -1,65 +0,0 @@
-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

@@ -1,55 +0,0 @@
-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/Editor.d.ts

@@ -1,25 +0,0 @@
-import type { Component } from '../../../shared-logic/src/Component/types';
-import { AnyView } from './View';
-export declare type EditorAttributes = {
-    component?: AnyView;
-};
-/**
- * Represents a Editor class.
- */
-export declare class Editor {
-    private editor;
-    /**
-     * Constructs a new instance of the Editor class.
-     * @param attributes - The attributes of the Editor.
-     */
-    constructor(attributes?: EditorAttributes);
-    /**
-     * Sets the view of the Editor.
-     */
-    setComponent(component: AnyView): void;
-    /**
-     * Builds a partial Component object.
-     * @returns A Component for the Editor.
-     */
-    build(): Component;
-}

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

@@ -1,19 +0,0 @@
-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

@@ -1,43 +0,0 @@
-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

@@ -1,45 +0,0 @@
-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

@@ -1,85 +0,0 @@
-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 | BubbleChart | ScatterChart | ComboChart | PivotTable | BasicTable | HorizontalBarChart | MercatorMap | SingleStat | Progress | RichText | WaterfallChart;
-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 BubbleChart extends View<Component.BubbleChartAttributes> {
-    constructor(attributes: Partial<Component.BubbleChartAttributes> & RequiredAttributes<Component.BubbleChartAttributes>);
-    static type(): Component.BubbleChartAttributes['type'];
-}
-export declare class SunburstChart extends View<Component.SunburstChartAttributes> {
-    constructor(attributes: Partial<Component.SunburstChartAttributes> & RequiredAttributes<Component.SunburstChartAttributes>);
-    static type(): Component.SunburstChartAttributes['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 declare class RichText extends View<Component.RichTextAttributes> {
-    constructor(attributes: Partial<Component.RichTextAttributes> & RequiredAttributes<Component.RichTextAttributes>);
-    static type(): Component.RichTextAttributes['type'];
-}
-export declare class WaterfallChart extends View<Component.WaterfallChartAttributes> {
-    constructor(attributes: Partial<Component.WaterfallChartAttributes> & RequiredAttributes<Component.WaterfallChartAttributes>);
-    static type(): Component.WaterfallChartAttributes['type'];
-}
-export declare class RadarChart extends View<Component.RadarChartAttributes> {
-    constructor(attributes: Partial<Component.RadarChartAttributes> & RequiredAttributes<Component.RadarChartAttributes>);
-    static type(): Component.RadarChartAttributes['type'];
-}
-export {};

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

@@ -1,7 +0,0 @@
-export { Cell } from './Cell';
-export { Dashboard } from './Dashboard';
-export { Library } from './Library';
-export { Editor } from './Editor';
-export { Header } from './Header';
-export { Row } from './Row';
-export { View } from './View';

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

@@ -1,46 +0,0 @@
-import { QueryEngineConfig, QueryEngineEndpoint } from '../../shared-logic/src/QueryEngineConfig/types';
-import { identityCallback, loadDataSetsCallback, loadQueryEngineConfigCallback } from '../../shared-logic/src/Callbacks/types';
-import { IdentityConfig } from '../../shared-logic/src/IdentityConfig/types';
-import { DashboardStorageStrategy } from '../../shared-logic/src/DashboardAPI/types';
-import { VizzlyTranslations } from '../../shared-logic/src/Translations/translation.types';
-import { DataSet } from '../../shared-logic/src/DataSet/types';
-import { CustomField } from '../../shared-logic/src/CustomField/types';
-export declare type LoaderOptions = {
-    apiHost: string;
-    textOverrides?: Partial<VizzlyTranslations>;
-    developerMode?: boolean;
-};
-declare type AccessTokens = Awaited<ReturnType<identityCallback>>;
-/**
- * A class to manage the up-front setting up of Vizzly.
- * For example, fetching data sets, the query engine config and
- * access tokens used for the identity logic.
- */
-export declare class VizzlyLoader {
-    private queryEngineConfig;
-    private dataSets;
-    private queryEngine;
-    private loadAccessTokens;
-    private loadDataSetsCallback?;
-    private extraCustomFields?;
-    options: LoaderOptions;
-    constructor(queryEngine: 'in-browser' | QueryEngineEndpoint | loadQueryEngineConfigCallback | undefined, loadAccessTokens: identityCallback, loadDataSetsCallback?: loadDataSetsCallback, extraCustomFields?: (dataSet: DataSet) => Array<CustomField>, options?: LoaderOptions);
-    getQueryEngineConfig(): Promise<QueryEngineConfig>;
-    getIdentity(): Promise<{
-        accessTokens: AccessTokens;
-        identityConfig: IdentityConfig;
-    }>;
-    getDataSets(): Promise<DataSet[]>;
-    load(): Promise<{
-        queryEngineConfig: import("@vizzly/semantic-layer-public/dist/types").QueryEngineConfig;
-        dataSets: DataSet<DataSet.Field>[];
-        identityConfig: IdentityConfig;
-        dashboardStorageStrategy: DashboardStorageStrategy;
-    }>;
-    /**
-     * Where should dashboards be fetched and saved from? Via the Query Engine for encryption
-     * or direct to the Vizzly API for non-encrypted storage.
-     */
-    getDashboardStorageStrategy(queryEngineConfig: QueryEngineConfig): DashboardStorageStrategy;
-}
-export {};

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

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

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

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

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

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

package/dist/services/src/eventbus.types.d.ts

@@ -1,28 +0,0 @@
-import { Component } from '../../shared-logic/src/Component/types';
-import { GlobalLibrary } from '../../shared-logic/src/GlobalLibrary';
-export declare type AddComponentToLibraryEvent = {
-    action: 'addComponentToLibrary';
-    component: Component;
-    customFields: GlobalLibrary.CustomFields;
-};
-export declare type DeleteComponentFromLibraryEvent = {
-    action: 'deleteComponentFromLibrary';
-    component: Component;
-};
-export declare type NewViewsInGlobalLibraryEvent = {
-    action: 'newViewsInGlobalLibrary';
-};
-export declare enum GlobalLibraryUpdateStatus {
-    SAVING = "saving",
-    SAVED = "saved",
-    DELETED = "deleted"
-}
-export declare type UpdateToGlobalLibraryStatus = {
-    action: 'updateToGlobalLibraryStatus';
-    state: GlobalLibraryUpdateStatus;
-};
-export declare type EventBus = (event: EventBusParams) => void;
-export declare type EventBusParams = {
-    data: EventBusOptions;
-};
-export declare type EventBusOptions = AddComponentToLibraryEvent | NewViewsInGlobalLibraryEvent | UpdateToGlobalLibraryStatus | DeleteComponentFromLibraryEvent;