@thoughtspot/ts-chart-sdk 0.0.1-alpha.9 → 0.0.2-alpha.10

package/src/utils/date-formatting.spec.ts

@@ -0,0 +1,168 @@
+/**
+ * @file: Date Formatting Spec
+ *
+ * @author Yashvardhan Nehra <yashvardhan.nehra@thoughtspot.com>
+ *
+ * Copyright: ThoughtSpot Inc. 2023
+ */
+
+import {
+    ChartColumn,
+    ChartSpecificColumnType,
+    ColumnTimeBucket,
+    ColumnType,
+    DataType,
+} from '../types/answer-column.types';
+import {
+    CustomCalendarDate,
+    dateFormatter,
+    getCustomCalendarGuidFromColumn,
+    getDisplayString,
+    getStartEpoch,
+    hasCustomCalendar,
+    isAttribute,
+    isDateColumn,
+    isDateFamilyColumn,
+    isDateNumColumn,
+    isTimeColumn,
+} from './date-formatting';
+
+describe('date-formatting', () => {
+    let col: ChartColumn;
+    beforeEach(() => {
+        col = {
+            id: 'testId',
+            name: 'test',
+            type: ColumnType.MEASURE,
+            chartSpecificColumnType: ChartSpecificColumnType.UNKNOWN,
+            timeBucket: ColumnTimeBucket.AUTO,
+            dataType: DataType.UNKNOWN,
+            calenderGuid: '12345',
+        };
+    });
+    test('isDateColumn should return true for DATE data type', () => {
+        col.dataType = DataType.DATE;
+        expect(isDateColumn(col)).toBe(true);
+    });
+
+    test('isDateColumn should return true for DATE_TIME data type', () => {
+        col.dataType = DataType.DATE_TIME;
+        expect(isDateColumn(col)).toBe(true);
+    });
+
+    test('isAttribute should return true for ATTRIBUTE column type', () => {
+        col.type = ColumnType.ATTRIBUTE;
+        expect(isAttribute(col)).toBe(true);
+    });
+
+    test('isAttribute should return false for non-ATTRIBUTE column type', () => {
+        col.type = ColumnType.MEASURE;
+        expect(isAttribute(col)).toBe(false);
+    });
+
+    test('getCustomCalendarGuidFromColumn should return the calendarGuid', () => {
+        col.calenderGuid = '12345';
+        expect(getCustomCalendarGuidFromColumn(col)).toBe('12345');
+    });
+
+    test('isDateNumColumn should return true for ATTRIBUTE type with specific time buckets', () => {
+        col.type = ColumnType.ATTRIBUTE;
+        col.timeBucket = ColumnTimeBucket.HOUR_OF_DAY;
+        expect(isDateNumColumn(col)).toBe(true);
+    });
+
+    test('isDateNumColumn should return false for non-ATTRIBUTE type', () => {
+        col.type = ColumnType.MEASURE;
+        col.timeBucket = ColumnTimeBucket.DAY_OF_WEEK;
+        expect(isDateNumColumn(col)).toBe(false);
+    });
+
+    test('isDateFamilyColumn should return true for DATE data type', () => {
+        col.dataType = DataType.DATE;
+        expect(isDateFamilyColumn(col)).toBe(true);
+    });
+
+    test('isDateFamilyColumn should return true for DATE_NUM column', () => {
+        col.type = ColumnType.ATTRIBUTE;
+        col.timeBucket = ColumnTimeBucket.DAY_OF_WEEK;
+        expect(isDateFamilyColumn(col)).toBe(true);
+    });
+
+    test('isTimeColumn should return true for TIME data type', () => {
+        col.dataType = DataType.TIME;
+        expect(isTimeColumn(col)).toBe(true);
+    });
+
+    test('hasCustomCalendar should return true for date family columns with custom calendar', () => {
+        col.dataType = DataType.DATE;
+        col.calenderGuid = '12345';
+        expect(hasCustomCalendar(col)).toBe(true);
+    });
+
+    test('getStartEpoch should return the start epoch from CustomCalendarDate', () => {
+        const date = {
+            v: { s: 12345, e: 12346 },
+            d: 'Custom_Date',
+        } as CustomCalendarDate;
+        expect(getStartEpoch(date)).toBe(date.v.s);
+    });
+
+    test('getStartEpoch should return null if start epoch is not present', () => {
+        const date = { v: {}, d: '01-07-2021' } as CustomCalendarDate;
+        expect(getStartEpoch(date)).toBe(null);
+    });
+
+    test('getDisplayString should return display string if present', () => {
+        const date = { v: { s: 1625097600, e: 1625184000 }, d: '01-07-2021' };
+        expect(getDisplayString(date)).toBe('01-07-2021');
+    });
+
+    test('getDisplayString should return null if display string is not present', () => {
+        const date = {
+            v: { s: 1625097600, e: 1625184000 },
+        } as CustomCalendarDate;
+        expect(getDisplayString(date)).toBe(null);
+    });
+
+    test('dateFormatter should return custom calendar display string if present', () => {
+        const dataValue = {
+            v: { s: 1625097600, e: 1625184000 },
+            d: '01-07-2021',
+        } as CustomCalendarDate;
+        col.dataType = DataType.DATE;
+        col.calenderGuid = '12345';
+        expect(dateFormatter(dataValue, col)).toBe('01-07-2021');
+    });
+
+    test('dateFormatter should return formatted date from start epoch if custom calendar display string is not present', () => {
+        const dataValue = {
+            v: { s: 1625097600, e: 1625184000 },
+        } as CustomCalendarDate;
+        col.dataType = DataType.DATE;
+        col.calenderGuid = '12345';
+        expect(dateFormatter(dataValue, col)).toBe('01-07-2021');
+    });
+
+    test('dateFormatter should return null if start epoch is not present', () => {
+        const dataValue = { v: { e: 1625184000 } } as CustomCalendarDate;
+        col.dataType = DataType.DATE;
+        col.calenderGuid = '12345';
+        expect(dateFormatter(dataValue, col)).toBe(null);
+    });
+
+    test('dateFormatter should return formatted date for non-custom calendar column', () => {
+        const dataValue = 1625097600;
+        col.dataType = DataType.DATE;
+        col.calenderGuid = undefined;
+        expect(dateFormatter(dataValue, col)).toBe('01-07-2021');
+    });
+    test('dateFormatter should format the date based on custom calendar', () => {
+        col.dataType = DataType.DATE;
+        col.calenderGuid = '12345';
+        const date = {
+            v: { s: 12345, e: 12346 },
+            d: 'Custom_Date',
+        } as CustomCalendarDate;
+        expect(dateFormatter(date, col)).toBe(date.d);
+    });
+});

package/src/utils/date-formatting.ts

@@ -0,0 +1,109 @@
+/**
+ * @file: Date Formatting Utils
+ *
+ * @author Yashvardhan Nehra <yashvardhan.nehra@thoughtspot.com>
+ *
+ * Copyright: ThoughtSpot Inc. 2023
+ */
+
+import _ from 'lodash';
+import { DateTime } from 'luxon';
+import {
+    ChartColumn,
+    ColumnTimeBucket,
+    ColumnType,
+    DataType,
+} from '../types/answer-column.types';
+
+export interface CustomCalendarDate {
+    v: {
+        s: number;
+        e: number;
+    };
+    d: string;
+}
+
+export const isDateColumn = (col: ChartColumn) =>
+    DataType[col.dataType] === 'DATE' || DataType[col.dataType] === 'DATE_TIME';
+
+export const isAttribute = (col: ChartColumn) =>
+    col.type === ColumnType.ATTRIBUTE;
+
+export const getCustomCalendarGuidFromColumn = (col: ChartColumn) =>
+    col.calenderGuid;
+
+const isDateNumTimeBucket = (col: ChartColumn): boolean => {
+    return [
+        ColumnTimeBucket.HOUR_OF_DAY,
+        ColumnTimeBucket.DAY_OF_WEEK,
+        ColumnTimeBucket.DAY_OF_MONTH,
+        ColumnTimeBucket.DAY_OF_QUARTER,
+        ColumnTimeBucket.DAY_OF_YEAR,
+        ColumnTimeBucket.WEEK_OF_MONTH,
+        ColumnTimeBucket.WEEK_OF_QUARTER,
+        ColumnTimeBucket.WEEK_OF_YEAR,
+        ColumnTimeBucket.MONTH_OF_QUARTER,
+        ColumnTimeBucket.MONTH_OF_YEAR,
+        ColumnTimeBucket.QUARTER_OF_YEAR,
+    ].includes(col.timeBucket);
+};
+export const isDateNumColumn = (col: ChartColumn): boolean => {
+    return isAttribute(col) && isDateNumTimeBucket(col);
+};
+
+export const isDateFamilyColumn = (col: ChartColumn): boolean => {
+    return isDateColumn(col) || isDateNumColumn(col);
+};
+
+export const isTimeColumn = (col: ChartColumn) => {
+    return DataType[col.dataType] === 'TIME';
+};
+
+/**
+ * Determines if the given column has a custom calendar.
+ *
+ * @param col - The chart column to check.
+ * @returns True if the column is a date family column and has a custom calendar GUID, false otherwise.
+ */
+export const hasCustomCalendar = (col: ChartColumn): boolean =>
+    isDateFamilyColumn(col) && !!getCustomCalendarGuidFromColumn(col);
+
+/**
+ * Retrieves the start epoch from a custom calendar date.
+ *
+ * @param date - The custom calendar date object.
+ * @returns The start epoch time if present, null otherwise.
+ */
+export function getStartEpoch(date: CustomCalendarDate): number | null {
+    if (_.has(date, 'v') && _.has(date.v, 's')) {
+        return date.v.s;
+    }
+    return null;
+}
+
+export function getDisplayString(date: CustomCalendarDate): string | null {
+    if (_.has(date, 'd')) {
+        return date.d;
+    }
+    return null;
+}
+
+/**
+ * Formats the date value based on the column's properties and custom calendar settings.
+ *
+ * @param dataValue - The date value to format.
+ * @param col - The chart column.
+ * @returns The formatted date string.
+ */
+export function dateFormatter(dataValue: any, col: ChartColumn) {
+    if (hasCustomCalendar(col)) {
+        if (getDisplayString(dataValue)) {
+            return getDisplayString(dataValue);
+        }
+        const startEpoch = getStartEpoch(dataValue);
+        return startEpoch !== null
+            ? DateTime.fromMillis(startEpoch * 1000).toFormat('dd-MM-yyyy')
+            : null;
+    }
+    return DateTime.fromMillis(dataValue * 1000).toFormat('dd-MM-yyyy');
+}

package/cjs/index.d.ts

@@ -1,9 +0,0 @@
-export * from './types/common.types';
-export * from './types/configurator.types';
-export * from './types/visual-prop.types';
-export * from './types/answer-column.types';
-export * from './types/chart-to-ts-event.types';
-export * from './types/ts-to-chart-event.types';
-export * from './main/custom-chart-context';
-export * from './react/use-custom-chart-context';
-//# sourceMappingURL=index.d.ts.map

package/cjs/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC"}

package/cjs/index.js

@@ -1,25 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types/common.types"), exports);
-__exportStar(require("./types/configurator.types"), exports);
-__exportStar(require("./types/visual-prop.types"), exports);
-__exportStar(require("./types/answer-column.types"), exports);
-__exportStar(require("./types/chart-to-ts-event.types"), exports);
-__exportStar(require("./types/ts-to-chart-event.types"), exports);
-__exportStar(require("./main/custom-chart-context"), exports);
-__exportStar(require("./react/use-custom-chart-context"), exports);
-//# sourceMappingURL=index.js.map

package/cjs/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,6DAA2C;AAC3C,4DAA0C;AAC1C,8DAA4C;AAC5C,kEAAgD;AAChD,kEAAgD;AAChD,8DAA4C;AAC5C,mEAAiD"}

package/cjs/main/custom-chart-context.d.ts

@@ -1,47 +0,0 @@
-import { ChartToTSEventsPayloadMap, OpenAxisMenuEventPayload, OpenContextMenuEventPayload } from '../types/chart-to-ts-event.types';
-import { AppConfig, ChartConfig, ChartModel, ValidationResponse, VisualProps } from '../types/common.types';
-import { ChartConfigEditorDefinition } from '../types/configurator.types';
-import { Query, TSToChartEventsPayloadMap } from '../types/ts-to-chart-event.types';
-import { VisualPropEditorDefinition } from '../types/visual-prop.types';
-export type CustomChartContextProps = {
-    getDefaultChartConfig: (chartModel: ChartModel) => ChartConfig[];
-    getQueriesFromChartConfig: (chartConfig: ChartConfig[]) => Query[];
-    renderChart: (ctx: CustomChartContext) => Promise<void>;
-    validateConfig?: (updatedConfig: ChartConfig[], chartModel: ChartModel) => ValidationResponse;
-    validateVisualProps?: (updatedVisualProps: VisualProps, chartModel: ChartModel) => ValidationResponse;
-    chartConfigEditorDefinition?: ChartConfigEditorDefinition[];
-    visualPropEditorDefinition?: VisualPropEditorDefinition;
-};
-export declare class CustomChartContext {
-    private componentId;
-    private hostUrl;
-    private chartModel;
-    private appConfig;
-    private chartContextProps;
-    private eventListeners;
-    private hasInitializedPromise;
-    private triggerInitResolve;
-    private contextMenuActionHandler;
-    private axisMenuActionHandler;
-    constructor(chartContextProps: CustomChartContextProps);
-    initialize: () => Promise<void>;
-    on<T extends keyof TSToChartEventsPayloadMap>(eventType: T, callbackFn: TSToChartEventsPayloadMap[T]): void;
-    off<T extends keyof TSToChartEventsPayloadMap>(eventType: T): void;
-    private onInternal;
-    destroy(): void;
-    getChartModel: () => ChartModel;
-    getAppConfig: () => AppConfig;
-    contextMenuCustomActionPreProcessor(eventPayload: [OpenContextMenuEventPayload]): [OpenContextMenuEventPayload];
-    axisMenuCustomActionPreProcessor(eventPayload: [OpenAxisMenuEventPayload]): [OpenAxisMenuEventPayload];
-    private eventPayloadPreProcessor;
-    emitEvent<T extends keyof ChartToTSEventsPayloadMap>(eventType: T, ...eventPayload: ChartToTSEventsPayloadMap[T]): Promise<any>;
-    private registerEventProcessor;
-    private eventProcessor;
-    private registerEvents;
-    private initializeContext;
-    private initializationComplete;
-    private publishChartContextPropsToHost;
-    private executeEventListenerCBs;
-}
-export declare const getChartContext: (customChartConfig: CustomChartContextProps) => Promise<CustomChartContext>;
-//# sourceMappingURL=custom-chart-context.d.ts.map

package/cjs/main/custom-chart-context.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"custom-chart-context.d.ts","sourceRoot":"","sources":["../../src/main/custom-chart-context.ts"],"names":[],"mappings":"AASA,OAAO,EAGH,yBAAyB,EAIzB,wBAAwB,EACxB,2BAA2B,EAC9B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACH,SAAS,EACT,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,WAAW,EACd,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,EAUH,KAAK,EAEL,yBAAyB,EAI5B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AAKxE,MAAM,MAAM,uBAAuB,GAAG;IAQlC,qBAAqB,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,WAAW,EAAE,CAAC;IAQjE,yBAAyB,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,KAAK,EAAE,CAAC;IAQnE,WAAW,EAAE,CAAC,GAAG,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAUxD,cAAc,CAAC,EAAE,CACb,aAAa,EAAE,WAAW,EAAE,EAC5B,UAAU,EAAE,UAAU,KACrB,kBAAkB,CAAC;IAWxB,mBAAmB,CAAC,EAAE,CAClB,kBAAkB,EAAE,WAAW,EAC/B,UAAU,EAAE,UAAU,KACrB,kBAAkB,CAAC;IAQxB,2BAA2B,CAAC,EAAE,2BAA2B,EAAE,CAAC;IAW5D,0BAA0B,CAAC,EAAE,0BAA0B,CAAC;CAC3D,CAAC;AAWF,qBAAa,kBAAkB;IAU3B,OAAO,CAAC,WAAW,CAAM;IASzB,OAAO,CAAC,OAAO,CAAM;IAQrB,OAAO,CAAC,UAAU,CAAyB;IAO3C,OAAO,CAAC,SAAS,CAAiB;IAOlC,OAAO,CAAC,iBAAiB,CACkC;IAQ3D,OAAO,CAAC,cAAc,CAAoD;IAW1E,OAAO,CAAC,qBAAqB,CAAgB;IAS7C,OAAO,CAAC,kBAAkB,CAAsB;IAQhD,OAAO,CAAC,wBAAwB,CAAgC;IAQhE,OAAO,CAAC,qBAAqB,CAA6B;gBAO9C,iBAAiB,EAAE,uBAAuB;IAkB/C,UAAU,QAAO,QAAQ,IAAI,CAAC,CAGnC;IAUK,EAAE,CAAC,CAAC,SAAS,MAAM,yBAAyB,EAC/C,SAAS,EAAE,CAAC,EACZ,UAAU,EAAE,yBAAyB,CAAC,CAAC,CAAC,GACzC,IAAI;IAeA,GAAG,CAAC,CAAC,SAAS,MAAM,yBAAyB,EAAE,SAAS,EAAE,CAAC,GAAG,IAAI;IAiBzE,OAAO,CAAC,UAAU;IAgBX,OAAO;IAUP,aAAa,QAAO,UAAU,CAAoB;IAOlD,YAAY,QAAO,SAAS,CAAmB;IAQ/C,mCAAmC,CACtC,YAAY,EAAE,CAAC,2BAA2B,CAAC,GAC5C,CAAC,2BAA2B,CAAC;IAiCzB,gCAAgC,CACnC,YAAY,EAAE,CAAC,wBAAwB,CAAC,GACzC,CAAC,wBAAwB,CAAC;IAiC7B,OAAO,CAAC,wBAAwB;IA0BzB,SAAS,CAAC,CAAC,SAAS,MAAM,yBAAyB,EACtD,SAAS,EAAE,CAAC,EACZ,GAAG,YAAY,EAAE,yBAAyB,CAAC,CAAC,CAAC,GAC9C,OAAO,CAAC,GAAG,CAAC;IAuBf,OAAO,CAAC,sBAAsB,CAU5B;IAOF,OAAO,CAAC,cAAc,CAuBpB;IAOF,OAAO,CAAC,cAAc,CAqOpB;IASF,OAAO,CAAC,iBAAiB,CASvB;IAEF,OAAO,CAAC,sBAAsB,CAM5B;IAEF,OAAO,CAAC,8BAA8B,CA6BhC;IAQN,OAAO,CAAC,uBAAuB,CAyB7B;CACL;AAQD,eAAO,MAAM,eAAe,sBACL,uBAAuB,KAC3C,QAAQ,kBAAkB,CAO5B,CAAC"}