@vizzly/services 0.8.1 → 0.8.2-dev-4ac76b0195bc8bd9f3866e4cdcdac08e26caeff3

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

@@ -7,7 +7,7 @@ import * as dataSetsProperty from 'shared-logic/src/DashboardAPI/dataSets';
 /**
  * Represents a Vizzly dashboard.
  */
-export type VizzlyDashboard = {
+export declare type VizzlyDashboard = {
     id: DashboardType['id'];
     parentDashboardId: DashboardType['parentDashboardId'] | undefined;
     display: DashboardType['display'];
@@ -19,15 +19,17 @@ export type VizzlyDashboard = {
 /**
  * Represents the payload for creating a dashboard.
  */
-export type CreateDashboard = {
+export declare type CreateDashboard = {
     definition: Dashboard.SaveableDashboardDefinition;
+    /** @deprecated - use `metadata` instead */
+    meta?: any;
     /**
      * The metadata for the dashboard.
      *
      * @property {any} meta - The metadata for the dashboard can be set to anything you require.
      *
      */
-    meta: any;
+    metadata?: any;
     /**
      * The ID of the parent dashboard.
      *
@@ -41,10 +43,10 @@ export type CreateDashboard = {
  *
  * @property {VizzlyDashboard['metadata']} metadata - The metadata to update the dashboard with.
  */
-type UpdateDashboardOptions = {
+declare type UpdateDashboardOptions = {
     metadata?: VizzlyDashboard['metadata'];
 };
-type APIOptions = {
+declare type APIOptions = {
     /**
      * The parent dashboard ID to use when creating a child dashboard.
      */

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

@@ -6,7 +6,7 @@ import { AdditionalFilter } from 'shared-logic/src/AdditionalFilter/types';
  * @param colSpan - The span of the cell in terms of columns. Defaults to 12.
  * @param localFilters - The local filters of the cell. Optional.
  */
-export type CellAttributes = {
+export declare type CellAttributes = {
     component?: ViewServices.View;
     colSpan?: number;
     localFilters?: AdditionalFilter[];

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

@@ -4,7 +4,7 @@ import { CustomField } from '../../../shared-logic/src/CustomField/types';
 import { Header } from './HeaderServices';
 import { Library } from './ComponentLibraryServices';
 /** Custom fields for a dashboard */
-export type CustomFields = {
+export declare type CustomFields = {
     [dataSetId: string]: Array<CustomField>;
 };
 /**
@@ -13,7 +13,7 @@ export type CustomFields = {
  * @param customFields - The custom fields of the dashboard.
  * @param library - The component library of the dashboard.
  */
-export type DashboardAttributes = {
+export declare type DashboardAttributes = {
     display?: (Row | Header)[];
     customFields?: CustomFields;
     library?: Library;

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

@@ -1,5 +1,5 @@
 import { DisplayRow } from '../../../shared-logic/src/Display/types';
-export type HeaderRow = DisplayRow[];
+export declare type HeaderRow = DisplayRow[];
 /**
  * Represents a Header class.
  */

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

@@ -21,7 +21,7 @@ export declare class ViewServices<T extends keyof ViewAttributes> {
     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 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']>);
 }

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

@@ -10,7 +10,7 @@ export declare enum AIReaction {
     ThumbsUp = "thumbs_up",
     ThumbsDown = "thumbs_down"
 }
-export type Message = {
+export declare type Message = {
     content: string;
     sender_type: SenderType;
     status: 'active';
@@ -18,7 +18,7 @@ export type Message = {
     sent_at: Date;
     reaction: AIReaction | null;
 };
-export type ConversationState = {
+export declare type ConversationState = {
     message: string;
     conversationId: string | undefined;
     messageState: MessageState;

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

@@ -1,19 +1,19 @@
 import { QueryAttributes } from '../QueryAttributes/types';
 import * as FilterType from './constants';
-export type FilterConfig = {
+export declare type FilterConfig = {
     localFilters?: Array<AdditionalFilter>;
     globalFilters?: Array<AdditionalFilter>;
 };
-export type AdditionalFilter = SingleSelectFilter | DateFilter | DateAndTimeFilter | DateTimeFilter | MultiSelectFilter;
-type Field = {
+export declare type AdditionalFilter = SingleSelectFilter | DateFilter | DateAndTimeFilter | DateTimeFilter | MultiSelectFilter;
+declare type Field = {
     dataSetId: string;
     fieldId: QueryAttributes.Field;
 };
-type AdditionalFilterType = typeof FilterType.DATE_FILTER | typeof FilterType.DATE_TIME_FILTER | typeof FilterType.DATE_AND_TIME_FILTER | typeof FilterType.SINGLE_SELECT_FILTER | typeof FilterType.MULTI_SELECT_FILTER;
-export type OptionalFilters = {
+declare type AdditionalFilterType = typeof FilterType.DATE_FILTER | typeof FilterType.DATE_TIME_FILTER | typeof FilterType.DATE_AND_TIME_FILTER | typeof FilterType.SINGLE_SELECT_FILTER | typeof FilterType.MULTI_SELECT_FILTER;
+export declare type OptionalFilters = {
     [dataSetId: string]: Array<QueryAttributes.Filter>;
 };
-type BaseAdditionalFilter<T extends AdditionalFilterType> = {
+declare type BaseAdditionalFilter<T extends AdditionalFilterType> = {
     /**
      * NOTE: The "dateTimeFilter" type value has been deprecated. Use "dateFilter".
      */
@@ -34,36 +34,36 @@ type BaseAdditionalFilter<T extends AdditionalFilterType> = {
     optionsFilters?: OptionalFilters;
     hidden?: boolean;
 };
-type FixedRangeValue = {
+declare type FixedRangeValue = {
     type: 'fixedRange';
     before: Date | null;
     after: Date | null;
 };
-type RelativeValue = {
+declare type RelativeValue = {
     type: 'relative';
     value: string;
 };
-export type DateFilter = BaseAdditionalFilter<typeof FilterType.DATE_FILTER> & {
+export declare type DateFilter = BaseAdditionalFilter<typeof FilterType.DATE_FILTER> & {
     value: FixedRangeValue | RelativeValue | null;
 };
-export type DateAndTimeFilter = BaseAdditionalFilter<typeof FilterType.DATE_AND_TIME_FILTER> & {
+export declare type DateAndTimeFilter = BaseAdditionalFilter<typeof FilterType.DATE_AND_TIME_FILTER> & {
     value: FixedRangeValue | RelativeValue | null;
 };
 /**
  * @deprecated The "dateTimeFilter" has been deprecated. Use "dateFilter".
  */
-export type DateTimeFilter = BaseAdditionalFilter<typeof FilterType.DATE_TIME_FILTER> & {
+export declare type DateTimeFilter = BaseAdditionalFilter<typeof FilterType.DATE_TIME_FILTER> & {
     value: FixedRangeValue | RelativeValue | null;
 };
-export type SingleSelectFilter = BaseAdditionalFilter<typeof FilterType.SINGLE_SELECT_FILTER> & {
+export declare type SingleSelectFilter = BaseAdditionalFilter<typeof FilterType.SINGLE_SELECT_FILTER> & {
     value: string | number | boolean | null;
     optionsPulledFrom?: Array<Field>;
 };
-export type MultiSelectFilter = BaseAdditionalFilter<typeof FilterType.MULTI_SELECT_FILTER> & {
+export declare type MultiSelectFilter = BaseAdditionalFilter<typeof FilterType.MULTI_SELECT_FILTER> & {
     value: string[] | number[] | null;
     optionsPulledFrom?: Array<Field>;
 };
-export type TimeRangeOptions = {
+export declare type TimeRangeOptions = {
     [id: string]: {
         range: {
             after: Date;
@@ -72,7 +72,7 @@ export type TimeRangeOptions = {
         description: string;
     };
 };
-export type DateAndTimeRangeOptions = {
+export declare type DateAndTimeRangeOptions = {
     [id: string]: {
         range: {
             afterDate: Date;

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

@@ -1,7 +1,9 @@
 import { SupportedAggregates } from './types';
+import { DataType } from '../Field/types';
 declare const vizzlyManagedAggregates: SupportedAggregates;
 export declare const supportedAggregates: (keys?: Array<string>) => SupportedAggregates;
 export declare const isSupportedAggregateFunction: (supportedAggregateFunctions: SupportedAggregates, proposedFunction: string) => boolean;
 export declare const isSupportedAggregate: (value: string | undefined, supportedAggregates: SupportedAggregates) => boolean;
 export declare const getPublicName: (id: keyof typeof vizzlyManagedAggregates) => string;
+export declare const hasValidDataType: (fieldDefinitions: SupportedAggregates, fieldName: string, dataType: DataType) => boolean;
 export {};

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

@@ -1,8 +1,8 @@
 import { DataType } from '../Field/types';
-export type SupportedAggregate = {
+export declare type SupportedAggregate = {
     publicName: string;
     validDataTypes: Array<DataType>;
 };
-export type SupportedAggregates = {
+export declare type SupportedAggregates = {
     [id: string]: SupportedAggregate;
 };

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

@@ -1,4 +1,4 @@
-export type ApiConfig = {
+export declare type ApiConfig = {
     dashboardAccessToken?: string;
     projectAccessToken?: string;
     apiKey?: string;

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

@@ -1,7 +1,7 @@
 import { Component } from '../Component/types';
 import { ComponentInterface, ComponentInterfaceConfig } from '../ComponentInterface/types';
 import { DateTimeFormat } from '../Field/types';
-export type BasicTableComponentInterface = ComponentInterface<Component.BasicTableAttributes, Component.BasicTableAttributes> & {
+export declare type BasicTableComponentInterface = ComponentInterface<Component.BasicTableAttributes, Component.BasicTableAttributes> & {
     setFields: (basicTable: Component.BasicTableAttributes, fieldId: Array<string>) => Component.BasicTableAttributes;
     setDateTimeFormat: (basicTable: Component.BasicTableAttributes, dateTimeFormat: DateTimeFormat) => Component.BasicTableAttributes;
 };

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

@@ -2,15 +2,15 @@ import { DataSet } from '../DataSet/types';
 import { IdentityConfig } from '../IdentityConfig/types';
 import { DataMap } from '../JSQueryEngine/types';
 import { QueryEngineConfig } from '../QueryEngineConfig/types';
-type CallbackError = null;
-export type loadDataSetsCallback = (identityConfig: IdentityConfig, queryEngineConfig: QueryEngineConfig) => Promise<Array<DataSet>>;
-export type IdentityTokens = {
+declare type CallbackError = null;
+export declare type loadDataSetsCallback = (identityConfig: IdentityConfig, queryEngineConfig: QueryEngineConfig) => Promise<Array<DataSet>>;
+export declare type IdentityTokens = {
     dashboardAccessToken: string;
     dataAccessToken?: string;
     queryEngineAccessToken?: string;
     projectAccessToken?: string | undefined;
 };
-export type identityCallback = () => Promise<IdentityTokens | CallbackError>;
-export type loadQueryEngineConfigCallback = () => Promise<Omit<QueryEngineConfig, 'supportedTransformationFunctions'> | null>;
-export type loadDataCallback = (dataSet: DataSet) => Promise<DataMap[] | CallbackError>;
+export declare type identityCallback = () => Promise<IdentityTokens | CallbackError>;
+export declare type loadQueryEngineConfigCallback = () => Promise<Omit<QueryEngineConfig, 'supportedTransformationFunctions'> | null>;
+export declare type loadDataCallback = (dataSet: DataSet) => Promise<DataMap[] | CallbackError>;
 export {};

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

@@ -1,11 +1,11 @@
 import { Dumpable } from '../Dumpable';
 import { Component } from './types';
 import { HeaderComponent } from '../Display/types';
-type EmptyComponent = {
+declare type EmptyComponent = {
     isEmpty: true;
     colSpan: number;
 };
-type ComponentDumpable = Dumpable<Component | EmptyComponent | HeaderComponent, Component.RawComponent | EmptyComponent | HeaderComponent>;
+declare type ComponentDumpable = Dumpable<Component | EmptyComponent | HeaderComponent, Component.RawComponent | EmptyComponent | HeaderComponent>;
 export declare const load: ComponentDumpable['load'];
 export declare const dump: ComponentDumpable['dump'];
 export {};

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

@@ -6,10 +6,10 @@ import { Result } from '../Result/types';
 import { AdditionalFilter } from '../AdditionalFilter/types';
 import { UpdatedMetrics } from '../Parameters';
 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' | 'progress';
+export declare type getNumberFormatter = (formatterId: string | undefined | null) => (number: number) => string;
+export declare type FormatType = string | null;
+export declare type ApproxAxisLabelCount = 'auto' | number;
+export declare 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'> & {
@@ -288,6 +288,14 @@ export declare namespace Component {
         };
     }
     export type OnViewClick = TableOnViewClick | ChartOnViewClick;
+    export type LabelFormatOptions = {
+        fieldId: string;
+        func: string;
+        type: ComponentType;
+        defaultLabel: string;
+        viewId: string;
+        values: Array<string>;
+    };
     export type Parameters = {
         measure?: ParameterMeasure;
         group?: ParameterGroup;
@@ -323,15 +331,15 @@ export declare namespace AddOn {
     type Type = 'selectFilter' | 'dateTimeFilter';
 }
 /** @deprecated */
-export type AddOn = AddOn.SelectFilter.Attributes | AddOn.DateTimeFilter.Attributes;
-export type MaybeOldComponent<Attrs = Component.Attributes> = Omit<Component<Omit<Attrs, 'addOns'> & {
+export declare type AddOn = AddOn.SelectFilter.Attributes | AddOn.DateTimeFilter.Attributes;
+export declare type MaybeOldComponent<Attrs = Component.Attributes> = Omit<Component<Omit<Attrs, 'addOns'> & {
     addOns: AddOn[];
 }>, 'localFilters'> & {
     localFilters: {
         [key: number]: QueryAttributes.Filter;
     };
 };
-export type Component<Attrs = Component.Attributes> = {
+export declare type Component<Attrs = Component.Attributes> = {
     attributes: Attrs;
     localFilters: Array<AdditionalFilter>;
     updatesFromParameters: UpdatedMetrics;
@@ -343,11 +351,11 @@ export declare enum ProgressType {
     Linear = "linear",
     Circular = "circular"
 }
-export type ProgressGoal = {
+export declare type ProgressGoal = {
     field: string;
     value: number;
 };
-export type ProgressTypes = {
+export declare type ProgressTypes = {
     field: string;
     value: ProgressType;
 };

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

@@ -1,7 +1,7 @@
 import { DataSet } from '../../DataSet/types';
 import { QueryEngineConfig } from '../../QueryEngineConfig/types';
 import { TextOverride } from '../../Translations/types';
-export type ComponentInterfaceConfig = {
+export declare type ComponentInterfaceConfig = {
     queryEngineConfig: QueryEngineConfig;
     attributesSchemaOptions?: {
         restrictFields?: Array<{

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

@@ -1,20 +1,20 @@
-export type Section<Type> = {
+export declare type Section<Type> = {
     type?: Type;
     title: string;
     description?: string;
     callToAction?: string;
 };
-export type ViewConstants = {
+export declare type ViewConstants = {
     title: string;
     description: string;
     namespace: ComponentNamespace;
     data_panel: DataPanelNamespaces;
     format_panel: FormatPanelNamespaces;
 };
-export type SubSection<Type> = Section<Type> & {
+export declare type SubSection<Type> = Section<Type> & {
     namespace?: string;
 };
-type SubSectionDef = {
+declare type SubSectionDef = {
     line?: SubSection<'metrics'>;
     bar?: SubSection<'metrics'>;
     xAxis?: SubSection<'metrics'>;
@@ -44,7 +44,7 @@ export interface DataPanelNamespaces {
         subSectionDefinition: SubSectionDef;
     };
 }
-export type Namespace = keyof FormatPanelNamespaces | keyof DataPanelNamespaces;
+export declare type Namespace = keyof FormatPanelNamespaces | keyof DataPanelNamespaces;
 export interface FormatPanelNamespaces {
     axis_labels?: Section<'axisLabels'> & {
         subSectionDefinition: {
@@ -102,5 +102,5 @@ export interface FormatPanelNamespaces {
         };
     };
 }
-export type ComponentNamespace = 'pivot_table' | 'horizontal_bar_chart' | 'bar_chart' | 'area_chart' | 'line_chart' | 'scatter_chart' | 'pie_chart' | 'single_stat' | 'basic_table' | 'combo_chart' | 'mercator_map' | 'custom' | 'fields' | 'progress' | 'headline';
+export declare type ComponentNamespace = 'pivot_table' | 'horizontal_bar_chart' | 'bar_chart' | 'area_chart' | 'line_chart' | 'scatter_chart' | 'pie_chart' | 'single_stat' | 'basic_table' | 'combo_chart' | 'mercator_map' | 'custom' | 'fields' | 'progress' | 'headline';
 export {};

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

@@ -38,4 +38,4 @@ export interface ComponentInterface<Hydrated = any, Dumped = any> extends Dumpab
         colorGradient: boolean;
     };
 }
-export type LoadComponentInterface<Hydrated, Dumped> = (config: ComponentInterfaceConfig) => ComponentInterface<Hydrated, Dumped>;
+export declare type LoadComponentInterface<Hydrated, Dumped> = (config: ComponentInterfaceConfig) => ComponentInterface<Hydrated, Dumped>;

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

@@ -1,6 +1,6 @@
 import { Component } from '../Component/types';
 import * as Field from '../Field';
-type OldRules = {
+declare type OldRules = {
     field?: any;
     operator?: any;
     value?: any;

package/dist/shared-logic/src/CustomField/Rules/types.d.ts

@@ -1,5 +1,5 @@
 import { QueryAttributes } from '../../QueryAttributes/types';
-export type Rules = {
+export declare type Rules = {
     name: string;
     rule: QueryAttributes.Filter[][];
 };

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

@@ -1,47 +1,47 @@
 import { QueryAttributes } from '../QueryAttributes/types';
 import { BaseField, DataType, NonDateTimeField } from '../Field/types';
 import { Rules } from './Rules/types';
-type BaseCustomField = Omit<NonDateTimeField, 'dashboardFilterGroups'>;
-export type PercentageField = BaseCustomField & Percentage;
-export type RoundedNumberField = BaseCustomField & RoundedNumber;
-export type OldPercentageField = BaseCustomField & OldPercentage;
-export type SimplePercentageField = BaseCustomField & SimplePercentage;
-export type AggregateMathField = BaseCustomField & AggregateMath;
-export type SimpleMathField = BaseCustomField & SimpleMath & {
+declare type BaseCustomField = Omit<NonDateTimeField, 'dashboardFilterGroups'>;
+export declare type PercentageField = BaseCustomField & Percentage;
+export declare type RoundedNumberField = BaseCustomField & RoundedNumber;
+export declare type OldPercentageField = BaseCustomField & OldPercentage;
+export declare type SimplePercentageField = BaseCustomField & SimplePercentage;
+export declare type AggregateMathField = BaseCustomField & AggregateMath;
+export declare type SimpleMathField = BaseCustomField & SimpleMath & {
     dataType: 'number';
 };
 export interface RulesField extends BaseField {
     rules: Rules[];
     dataType: 'string';
 }
-export type CustomField = PercentageField | SimpleMathField | AggregateMathField | SimplePercentageField | RulesField | RoundedNumberField;
-export type OldPercentage = {
+export declare type CustomField = PercentageField | SimpleMathField | AggregateMathField | SimplePercentageField | RulesField | RoundedNumberField;
+export declare type OldPercentage = {
     numeratorFieldId: string;
     numeratorAggregate: string;
     numeratorFilter: QueryAttributes['filter'];
     dataType: DataType;
 };
-export type Percentage = {
+export declare type Percentage = {
     denominatorFieldId: string;
     denominatorAggregate: string;
     numeratorFilter: QueryAttributes['filter'];
     dataType: DataType;
 };
-export type SimplePercentage = {
+export declare type SimplePercentage = {
     numeratorFieldId: string;
     numeratorAggregate: string;
     denominatorFieldId: string;
     denominatorAggregate: string;
     dataType: DataType;
 };
-export type AggregateNested = {
+export declare type AggregateNested = {
     operator: MathOperator;
     fieldId: string;
     /** @deprecated ignore this outside of upcasting */
     aggregate?: string;
     function: string;
 };
-export type AggregateMath = {
+export declare type AggregateMath = {
     leftFieldId: string;
     leftFunction: string;
     leftNested?: AggregateNested;
@@ -54,16 +54,16 @@ export type AggregateMath = {
     /** @deprecated ignore this outside of upcasting */
     rightAggregate?: string;
 };
-export type SimpleMath = {
+export declare type SimpleMath = {
     leftFieldId: string;
     operator: MathOperator;
     rightFieldId: string;
 };
-export type RoundedNumber = {
+export declare type RoundedNumber = {
     roundToDecimalPlaces: 0 | 2;
     fieldId: string;
 };
-export type MathOperator = '*' | '-' | '/' | '+';
-export type CustomFieldCategory = 'percentage' | 'math' | 'rules' | 'roundedNumber';
-export type MaybeOldCustomField = CustomField | OldPercentage;
+export declare type MathOperator = '*' | '-' | '/' | '+';
+export declare type CustomFieldCategory = 'percentage' | 'math' | 'rules' | 'roundedNumber';
+export declare type MaybeOldCustomField = CustomField | OldPercentage;
 export {};

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

@@ -2,8 +2,8 @@ import { StoredTheme } from '../Theme/types';
 import { Dashboard, SaveableDashboardDefinition } from './types';
 import { PartialBy } from '../typeHelpers';
 import { QueryEngineConfig } from '../QueryEngineConfig/types';
-export type RawDefinition = PartialBy<SaveableDashboardDefinition, 'isPlayground' | 'customFields'>;
-export type RawDashboard<Definition = RawDefinition> = {
+export declare type RawDefinition = PartialBy<SaveableDashboardDefinition, 'isPlayground' | 'customFields'>;
+export declare type RawDashboard<Definition = RawDefinition> = {
     id: string;
     parent_dashboard_id: string;
     definition: Definition;

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

@@ -9,7 +9,7 @@ export declare namespace Dashboard {
         [key: string]: string | number;
     };
 }
-export type Dashboard = {
+export declare type Dashboard = {
     id: string;
     parentDashboardId: string | null;
     metadata: Dashboard.ExternalMetadata;
@@ -26,7 +26,7 @@ export type Dashboard = {
     protectedByOrganisation?: boolean;
     isProgrammatic?: boolean;
 };
-export type SaveableDashboardDefinition = {
+export declare type SaveableDashboardDefinition = {
     display: DisplayDumped;
     componentLibrary: Component.RawComponent[];
     globalFilters: Array<AdditionalFilter>;

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

@@ -14,6 +14,6 @@ export declare function prepareCreateResponseForAdding(createdDashboardResponse:
     formattedPermissions: DashboardPermissionType[];
 };
 export declare function postCreateDashboard(params: Omit<CreateDashboardParams, 'dashboardAccessToken'>, identityConfig: IdentityConfigType, dashboardStorageStrategy: DashboardStorageStrategy, vizzlyAPI: ReturnType<typeof api>): Promise<{
-    dashboard: Dashboard.RawDashboard;
+    dashboard: Dashboard.RawDashboard<Dashboard.RawDefinition>;
     permissions: RawDashboardPermission[];
 }>;

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

@@ -8,7 +8,9 @@ import { QueryEngineConfig } from '../../QueryEngineConfig/types';
 export declare function postUpdateDashboard(dashboardStorageStrategy: DashboardStorageStrategy, vizzlyAPI: ReturnType<typeof api>, updateParams: {
     dashboardSessionToken: string;
     definition?: Dashboard.SaveableDashboardDefinition;
+    /** @deprecated - use `metadata` instead */
     meta?: any;
+    metadata?: any;
     deleted?: boolean;
 }): Promise<UnEncryptedDashboardUpdateResponse>;
 export declare function updateDashboardFromUpdateResponse(updatedDashboardResponse: UnEncryptedDashboardUpdateResponse, dataSets: DataSet[], dashboards: DashboardType[], params: Omit<UpdateDashboardParams, 'dashboardSessionToken'>, queryEngineConfig: QueryEngineConfig | undefined): {

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

@@ -1,6 +1,6 @@
 import { IdentityTokens } from '../Callbacks/types';
 import { identityCallback as identityCallbackImported } from 'shared-logic/src/Callbacks/types';
-export type identityCallback = identityCallbackImported;
+export declare 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

@@ -3,7 +3,7 @@ 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 declare type DataSetsCallback = (identityConfig: IdentityConfig) => Promise<Array<DataSet> | null>;
 export interface Property {
     schema: Joi.Schema;
 }

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

@@ -1,6 +1,6 @@
 import { Dashboard } from 'shared-logic/src/Dashboard/types';
 import { QueryEngineEndpoint } from '../QueryEngineConfig/types';
-export type VizzlyDashboard = {
+export declare type VizzlyDashboard = {
     id: Dashboard['id'];
     parentDashboardId: Dashboard['parentDashboardId'] | undefined;
     display: Dashboard['display'];
@@ -10,7 +10,7 @@ export type VizzlyDashboard = {
     updatedAt: Dashboard['updatedAt'];
     metadata: Dashboard['metadata'];
 };
-export type DashboardStorageStrategy = {
+export declare type DashboardStorageStrategy = {
     strategy: 'vizzlyApi';
 } | {
     strategy: 'queryEngine';

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

@@ -1,10 +1,10 @@
-export type RawDashboardPermission = {
+export declare type RawDashboardPermission = {
     dashboard_id: string;
     scope: 'read' | 'read_write';
     token: string;
     user_reference: '*' | string;
 };
-export type DashboardPermission = {
+export declare type DashboardPermission = {
     dashboardId: string;
     scope: 'read' | 'read_write';
     token: string;