@vizzly/services 0.15.0-dev-dfdff442d54d270df03c337679ae904243a831b6 → 0.15.0-dev-f576f0918251ec7901abbda943caec672e40c29c

package/dist/types/shared-logic/src/Translations/translations.d.ts

@@ -0,0 +1,9 @@
+import { VizzlyTranslations } from './translation.types';
+import { TranslationOptions, TranslationInterpolation } from './types';
+export type VizzlyTranslationKey = keyof VizzlyTranslations;
+export declare function getTranslation(translations: Partial<VizzlyTranslations>, key: string): string | TranslationInterpolation | undefined;
+export declare const defaultText: (key: string, defaultValue: string, variables?: TranslationOptions, developerMode?: boolean) => string;
+export declare const generateTranslation: (key: string, defaultValue: string, variables?: TranslationOptions, translations?: Partial<VizzlyTranslations>, developerMode?: boolean) => string;
+export declare function buildTextOverrides(translations?: Partial<VizzlyTranslations>, developerMode?: boolean): {
+    textOverride: (key: string, value: string, options?: TranslationOptions) => string;
+};

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

@@ -0,0 +1,13 @@
+export type TextOverride = (key: string, defaultValue: string, options?: TranslationOptions) => string;
+export type TranslationOptions = {
+    [key: string]: string | number | Pluralised;
+};
+export type Pluralised = {
+    count: number;
+    singular: string;
+    plural: string;
+};
+export type TranslationInterpolation = {
+    sentence: string;
+    [key: string]: string;
+};

package/dist/types/shared-logic/src/Translations/validation.d.ts

@@ -0,0 +1 @@
+export declare const isValidFormattedText: (text: string) => boolean;

package/dist/types/shared-logic/src/Trends/trendsSchema.d.ts

@@ -0,0 +1,2 @@
+import Joi from '@vizzly/joi';
+export declare const trendsSchema: () => Joi.ArraySchema<any[]>;

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

@@ -0,0 +1,9 @@
+export declare enum TrendType {
+    Forecast = "Forecast",
+    MovingAverage = "Moving Average",
+    Trend = "Trend"
+}
+export type MovingAverage = {
+    value: number;
+};
+export type SupportedTimeFunctions = 'week' | 'quarter' | 'year' | 'month';

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

@@ -0,0 +1,7 @@
+import { AdditionalFilter } from '../AdditionalFilter/types';
+import { ValueAlias } from './types';
+export declare const build: (value: string | number | null, valueAlias?: ValueAlias, options?: {
+    fieldId?: string | null;
+    filter?: AdditionalFilter;
+    dataSetId?: string;
+}) => string | number | null | undefined;

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

@@ -0,0 +1,10 @@
+import { Component } from '../Component/types';
+export type ValueAlias = {
+    [id: string]: string | number;
+} | ValueAliasFunction;
+export type ValueAliasFunction = (options?: Component.ValueAliasOptions) => string | number | undefined;
+export type ValueAliasFunctionV2 = (params: {
+    fieldId: string;
+    value: any;
+    function: string;
+}) => string | undefined;

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

@@ -0,0 +1,8 @@
+import { VariableList, VariablesCallback } from './types';
+export declare const defaultVariables: {};
+export declare const detect: (input: string) => string[] | undefined;
+export declare const build: (variables?: VariablesCallback) => VariableList;
+export declare const findVariable: (value: string, detect: (input: string) => string[] | undefined, variableList?: VariableList) => string[] | undefined;
+export declare const useValue: (value: any, variables?: VariableList) => any;
+export declare const validate: (value: string, variables?: VariableList) => boolean;
+export declare function extractValue(variables: VariableList, key: string): import("./types").VariableTypes;

package/dist/types/shared-logic/src/Variables/index.d.ts

@@ -0,0 +1 @@
+export * from './Variables';

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

@@ -0,0 +1,9 @@
+export type VariablesCallback = () => VariableList;
+export type VariableList = {
+    [key: string]: Variable;
+};
+export type Variable = {
+    value: VariableTypes;
+    description?: string;
+};
+export type VariableTypes = string | number | string[] | number[];

package/dist/types/shared-logic/src/WaterfallChart/attributesSchema.d.ts

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

package/dist/types/shared-logic/src/WaterfallChart/constants.d.ts

@@ -0,0 +1,3 @@
+import { ViewConstants } from '../ComponentInterface/types/namespaces.types';
+declare const CONSTANTS: ViewConstants;
+export default CONSTANTS;

package/dist/types/shared-logic/src/WaterfallChart/index.d.ts

@@ -0,0 +1,4 @@
+import { Component } from '../Component/types';
+import { LoadComponentInterface } from '../ComponentInterface/types';
+declare const WaterfallChart: LoadComponentInterface<Component.WaterfallChartAttributes, Component.WaterfallChartAttributes>;
+export default WaterfallChart;

package/dist/types/shared-logic/src/WaterfallChart/setAttributes.d.ts

@@ -0,0 +1,4 @@
+import { Component } from '../Component/types';
+import { ComponentInterfaceConfig } from '../ComponentInterface/types';
+declare const _default: (config: ComponentInterfaceConfig) => (waterfallChart: Component.WaterfallChartAttributes, partial: Partial<Component.WaterfallChartAttributes>) => Component.WaterfallChartAttributes;
+export default _default;

package/dist/types/shared-logic/src/errors/CorruptedView.d.ts

@@ -0,0 +1,5 @@
+import ValidationError from './ValidationError';
+import Joi from '@vizzly/joi';
+export default class CorruptedView extends ValidationError {
+    constructor(joiValidationError: Joi.ValidationError);
+}

package/dist/types/shared-logic/src/errors/DataSetNotFound.d.ts

@@ -0,0 +1,5 @@
+import { DataSet } from '../DataSet/types';
+import ValidationError from './ValidationError';
+export default class DataSetNotFound extends ValidationError {
+    constructor(dataSets: Array<DataSet>, missingDataSetId: string);
+}

package/dist/types/shared-logic/src/errors/FieldNotFoundInDataSet.d.ts

@@ -0,0 +1,7 @@
+import { DataSet } from '../DataSet/types';
+import ValidationError from './ValidationError';
+export default class FieldNotFoundInDataSet extends ValidationError {
+    private missingFieldId;
+    constructor(dataSet: DataSet, missingFieldId: string);
+    getMissingFieldId(): string;
+}

package/dist/types/shared-logic/src/errors/ValidationError.d.ts

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

package/dist/types/shared-logic/src/errors/VariableNotFoundForVariables.d.ts

@@ -0,0 +1,7 @@
+import { VariableList } from '../Variables/types';
+import ValidationError from './ValidationError';
+export default class VariableNotFoundForVariables extends ValidationError {
+    private missingVariableId;
+    constructor(variableList: VariableList, missingVariableId: string);
+    getMissingFieldId(): string;
+}

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

@@ -0,0 +1,28 @@
+import { BasicTableComponentInterface } from './BasicTable';
+import { Component, ComponentType } from './Component/types';
+import { ComponentInterface, ComponentInterfaceConfig } from './ComponentInterface/types';
+declare function getComponentInterface(type: 'custom', config?: ComponentInterfaceConfig): ComponentInterface<Component.CustomViewAttributes>;
+declare function getComponentInterface(type: 'pieChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.PieChartAttributes>;
+declare function getComponentInterface(type: 'bubbleChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.BubbleChartAttributes>;
+declare function getComponentInterface(type: 'bubbleChartV2', config?: ComponentInterfaceConfig): ComponentInterface<Component.BubbleChartV2Attributes>;
+declare function getComponentInterface(type: 'sunburstChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.SunburstChartAttributes>;
+declare function getComponentInterface(type: 'scatterChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.ScatterChartAttributes>;
+declare function getComponentInterface(type: 'mercatorMap', config?: ComponentInterfaceConfig): ComponentInterface<Component.MercatorMapAttributes>;
+declare function getComponentInterface(type: 'singleStat', config?: ComponentInterfaceConfig): ComponentInterface<Component.SingleStatAttributes>;
+declare function getComponentInterface(type: 'progress', config?: ComponentInterfaceConfig): ComponentInterface<Component.ProgressAttributes>;
+declare function getComponentInterface(type: 'comboChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.ComboChartAttributes>;
+declare function getComponentInterface(type: 'dataTable', config?: ComponentInterfaceConfig): ComponentInterface<Component.DataTableAttributes>;
+declare function getComponentInterface(type: 'basicTable', config?: ComponentInterfaceConfig): BasicTableComponentInterface;
+declare function getComponentInterface(type: 'horizontalBarChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.HorizontalBarChartAttributes>;
+declare function getComponentInterface(type: 'areaChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.AreaChartAttributes>;
+declare function getComponentInterface(type: 'lineChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.LineChartAttributes>;
+declare function getComponentInterface(type: 'lineChartV2', config?: ComponentInterfaceConfig): ComponentInterface<Component.LineChartV2Attributes>;
+declare function getComponentInterface(type: 'barChartV2', config?: ComponentInterfaceConfig): ComponentInterface<Component.BarChartV2Attributes>;
+declare function getComponentInterface(type: 'areaChartV2', config?: ComponentInterfaceConfig): ComponentInterface<Component.AreaChartV2Attributes>;
+declare function getComponentInterface(type: 'comboChartV2', config?: ComponentInterfaceConfig): ComponentInterface<Component.ComboChartV2Attributes>;
+declare function getComponentInterface(type: 'barChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.BarChartAttributes>;
+declare function getComponentInterface(type: 'funnelChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.FunnelChartAttributes>;
+declare function getComponentInterface(type: 'waterfallChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.WaterfallChartAttributes>;
+declare function getComponentInterface(type: 'radarChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.RadarChartAttributes>;
+declare function getComponentInterface(type: ComponentType, config?: ComponentInterfaceConfig): ComponentInterface<Component.Attributes>;
+export default getComponentInterface;

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

@@ -0,0 +1 @@
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/dist/types/shared-logic/src/utils/feedback.d.ts

@@ -0,0 +1,4 @@
+import { Component } from '../../src/Component/types';
+export declare const getGroupingFeedbackMessage: (attributes: Component.Attributes) => string;
+export declare const chartHasDimensions: (attributes: Component.Attributes) => boolean;
+export declare const createFeedback: (attribute: Component.Attributes) => string | true;

package/dist/types/shared-logic/src/utils/generateId.d.ts

@@ -0,0 +1 @@
+export declare const generateId: () => string;

package/dist/types/shared-logic/src/utils/stringHelper.d.ts

@@ -0,0 +1,10 @@
+import { TextOverride } from '../Translations/types';
+export declare function pluralEnding(num: number, single: string, multiple: string): string;
+export declare function maxLengthString(str: string, length: number): string;
+export declare function plural(num: number, single: string, multiple: string): string;
+export declare function humanReadableList(values: (number | string)[], withQuotes?: boolean, textOverride?: TextOverride): string;
+export declare const hashString: (str: string) => number;
+export declare const capitalise: (word: string) => string;
+export declare const replaceAll: (str: string, lookFor: string, replaceWith: string) => string;
+export declare const snakeCaseToHumanReadable: (str: string) => string;
+export declare const getSecretReplacement: (minLength: number, maxLength: number) => string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vizzly/services",
   "source": "src/index.ts",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/types/services/src/index.d.ts",
   "files": [
     "dist"
   ],
@@ -19,19 +19,19 @@
     "ts-loader": "^9.5.1",
     "tsc-alias": "^1.8.8",
     "typescript": "^5.3.2",
-    "vite": "^5.1.5",
-    "vite-plugin-dts": "^4.5.4"
+    "vite": "^5.1.5"
   },
   "scripts": {
     "validate-ts": "tsc -p ./validate.tsconfig.json --noEmit",
     "set-version": "node ./scripts/setVersion.js",
     "test": "jest --forceExit",
     "build-umd": "rm -rf ./dist && vite build --config ./umdBuild/vite.config.js && rm -rf ./dist/*.mjs",
-    "build": "rm -rf ./dist && vite build --mode=production && yarn fix-type-alias",
-    "fix-type-alias": "tsc-alias -p tsconfig.json",
+    "build-types": "tsc -p tsconfig.types.json && yarn fix-type-alias",
+    "build": "rm -rf ./dist && vite build --mode=production && yarn build-types",
+    "fix-type-alias": "tsc-alias -p tsconfig.types.json",
     "prepare": "yarn build"
   },
-  "version": "0.15.0-dev-dfdff442d54d270df03c337679ae904243a831b6",
+  "version": "0.15.0-dev-f576f0918251ec7901abbda943caec672e40c29c",
   "dependencies": {
     "@vizzly/api-client": "0.0.57",
     "@vizzly/joi": "^17.11.0",

package/dist/types/schemaValidations/cell.d.ts

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

package/dist/types/schemaValidations/filters.d.ts

@@ -1,3 +0,0 @@
-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[];