@vizzly/services 0.15.0-dev-a9cfd8f38d3df28a319ca965d6e9d29e227fe3fe → 0.15.0-dev-89f22e757a24a3586c300b3ebb6b29827e8cc0e8

package/dist/types/shared-logic/src/tests/exampleDataSet.d.ts

@@ -0,0 +1,95 @@
+export declare const testingDataSet: {
+    id: string;
+    name: string;
+    fields: ({
+        id: string;
+        dataType: string;
+        publicName: string;
+        dashboardRequiredFilterGroups: never[];
+        canBeDimension: boolean;
+        canBeMeasure: boolean;
+        allowedOperators: string[];
+        allowedGranularities: string[];
+        rules?: undefined;
+        denominatorAggregate?: undefined;
+        denominatorFieldId?: undefined;
+        numeratorFilter?: undefined;
+        numeratorAggregate?: undefined;
+        numeratorFieldId?: undefined;
+    } | {
+        allowedOperators: string[];
+        canBeDimension: boolean;
+        canBeMeasure: boolean;
+        dataType: string;
+        id: string;
+        publicName: string;
+        rules: {
+            name: string;
+            rule: {
+                field: string;
+                op: string;
+                value: string;
+            }[][];
+        }[];
+        dashboardRequiredFilterGroups?: undefined;
+        allowedGranularities?: undefined;
+        denominatorAggregate?: undefined;
+        denominatorFieldId?: undefined;
+        numeratorFilter?: undefined;
+        numeratorAggregate?: undefined;
+        numeratorFieldId?: undefined;
+    } | {
+        allowedOperators: string[];
+        canBeDimension: boolean;
+        canBeMeasure: boolean;
+        dataType: string;
+        denominatorAggregate: string;
+        denominatorFieldId: string;
+        id: string;
+        numeratorFilter: {
+            field: string;
+            op: string;
+            value: number;
+        }[][];
+        publicName: string;
+        dashboardRequiredFilterGroups?: undefined;
+        allowedGranularities?: undefined;
+        rules?: undefined;
+        numeratorAggregate?: undefined;
+        numeratorFieldId?: undefined;
+    } | {
+        allowedOperators: string[];
+        canBeDimension: boolean;
+        canBeMeasure: boolean;
+        dataType: string;
+        denominatorAggregate: string;
+        denominatorFieldId: string;
+        id: string;
+        numeratorAggregate: string;
+        numeratorFieldId: string;
+        publicName: string;
+        dashboardRequiredFilterGroups?: undefined;
+        allowedGranularities?: undefined;
+        rules?: undefined;
+        numeratorFilter?: undefined;
+    } | {
+        allowedOperators: string[];
+        canBeDimension: boolean;
+        canBeMeasure: boolean;
+        dataType: string;
+        denominatorAggregate: string;
+        denominatorFieldId: string;
+        id: string;
+        numeratorFilter: {
+            field: string;
+            op: string;
+            value: string;
+        }[][];
+        publicName: string;
+        dashboardRequiredFilterGroups?: undefined;
+        allowedGranularities?: undefined;
+        rules?: undefined;
+        numeratorAggregate?: undefined;
+        numeratorFieldId?: undefined;
+    })[];
+};

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/DateTime.d.ts

@@ -0,0 +1,19 @@
+import { DateTimeFormat } from '../Field/types';
+import { QueryAttributes } from '../QueryAttributes/types';
+export declare const currentTimezone: () => string;
+export declare const formatShortDate: (date: Date | null, timezone?: string | null) => string;
+export declare const formatTime: (date: Date, withSeconds?: boolean) => string;
+export declare const formatLongDateAndTime: (date: Date | null) => string | null;
+export declare const formatShortDateAndTime: (date: Date | null) => string | null;
+export declare const addMinutes: (date: Date, minutes: number) => Date;
+export declare const isDateBetween: (now: Date, before: Date, after: Date) => boolean;
+export declare const format: (value: Date | string | number, format: DateTimeFormat) => string | null;
+export declare const _formatDate: (date: Date, format: DateTimeFormat) => string | null;
+export declare const fillTruncatedDatesBetween: (start: Date, end: Date, interval: QueryAttributes.TimeDimension.Truncate) => Date[];
+export declare const truncateDateTime: (dateTime: Date, truncate: QueryAttributes.TimeDimension.Truncate) => Date;
+export declare const subtractDays: (date: Date, days: number) => Date;
+export declare const startOfDay: (date: Date) => Date;
+export declare function endOfDay(after: Date): Date;
+export declare const getQuarter: (date: Date) => 1 | 2 | 3 | 4;
+export declare const getWeek: (date: Date) => number;
+export declare const getWeekStartDate: (date: Date) => Date;

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

@@ -0,0 +1,6 @@
+export declare const newArray: (size: number) => any[];
+export declare const moveItem: (arr: Array<any>, oldIndex: number, newIndex: number) => any[];
+export declare const removeFromArray: <T = any>(arr: Array<T>, index: number) => Array<T>;
+export declare function isLength<T>(arr: T[], length: 0): arr is [];
+export declare function isLength<T>(arr: T[], length: 1): arr is [T];
+export declare function isLength<T>(arr: T[], length: 2): arr is [T, T];

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

@@ -0,0 +1,4 @@
+import { DataSet } from '../DataSet/types';
+import { QueryAttributes } from '../QueryAttributes/types';
+import { QueryEngineConfig } from '../QueryEngineConfig/types';
+export declare const sortDateTimeByDefault: (attributes: QueryAttributes, dataSet: DataSet, queryEngineConfig: QueryEngineConfig) => QueryAttributes.Order[];

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/htmlHelper.d.ts

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

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

@@ -0,0 +1,5 @@
+import * as DateTime from './DateTime';
+import * as StringHelper from './stringHelper';
+import * as NumberHelper from './numberHelpers';
+import * as ArrayHelper from './arrayHelpers';
+export { DateTime, StringHelper, NumberHelper, ArrayHelper };

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

@@ -0,0 +1,9 @@
+export declare const findClosestBy: (array: any[], closestTo: number, by: (candidate: any) => number) => any;
+export declare function findClosestNumberIndex(numbers: number[], target: number): number;
+export declare function percentageIncrease(a: number, b: number): number;
+export declare const isPercentageOf: (num: number, total: number) => number;
+export declare const toDp: (number: number, decimalPlaces: number) => string;
+export declare const toCurrency: (number: number, currency: "EUR" | "GBP" | "USD") => string;
+export declare const toPercentage: (number: number, decimalPlaces?: number) => string;
+export declare function formatCompactNumber(number: number): string;
+export declare const numberPostfix: (number: number) => "th" | "st" | "nd" | "rd";

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

@@ -0,0 +1,5 @@
+export declare const buildPath: (basePath: string, route: string) => string;
+export declare const addQueryParam: (absoluteUrl: string, key: string, value: string) => string;
+export declare const hasHashtag: (absoluteUrl: string) => boolean;
+export declare const setVizzlyHashtagValue: (absoluteUrl: string, value: string) => string;
+export declare const getVizzlyHashtagValue: (absoluteUrl: string) => string | null;

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/dist/types/shared-logic/src/validations.d.ts

@@ -0,0 +1,5 @@
+export type JoiOptions = {
+    convert: boolean;
+    stripUnknown: boolean;
+    allowUnknown?: boolean;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vizzly/services",
   "source": "src/index.ts",
-  "types": "dist/services/src/index.d.ts",
+  "types": "dist/types/services/src/index.d.ts",
   "files": [
     "dist"
   ],
@@ -9,8 +9,11 @@
   "main": "./dist/cjs/index.cjs.js",
   "module": "./dist/esm/index.esm.js",
   "exports": {
-    "require": "./dist/cjs/index.cjs.js",
-    "import": "./dist/esm/index.esm.js"
+    ".": {
+      "require": "./dist/cjs/index.cjs.js",
+      "import": "./dist/esm/index.esm.js",
+      "types": "./dist/types/services/src/index.d.ts"
+    }
   },
   "devDependencies": {
     "jest": "^29.6.0",
@@ -26,11 +29,12 @@
     "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",
+    "build": "rm -rf ./dist && vite build --mode=production && yarn build:types && yarn fix-type-alias",
+    "build:types": "tsc --emitDeclarationOnly -p tsconfig.json",
     "fix-type-alias": "tsc-alias -p tsconfig.json",
     "prepare": "yarn build"
   },
-  "version": "0.15.0-dev-a9cfd8f38d3df28a319ca965d6e9d29e227fe3fe",
+  "version": "0.15.0-dev-89f22e757a24a3586c300b3ebb6b29827e8cc0e8",
   "dependencies": {
     "@vizzly/api-client": "0.0.57",
     "@vizzly/joi": "^17.11.0",