npm - @thoughtspot/ts-chart-sdk - Versions diffs - 0.0.2-alpha.6 → 0.0.2-alpha.8 - Mend

@thoughtspot/ts-chart-sdk 0.0.2-alpha.6 → 0.0.2-alpha.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (32) hide show

package/dist/ts-chart-sdk.d.ts +20 -1
package/lib/index.d.ts +1 -0
package/lib/index.d.ts.map +1 -1
package/lib/index.js +1 -0
package/lib/index.js.map +1 -1
package/lib/main/custom-chart-context.spec.js +53 -2
package/lib/main/custom-chart-context.spec.js.map +1 -1
package/lib/react/use-custom-chart-context.spec.js +54 -2
package/lib/react/use-custom-chart-context.spec.js.map +1 -1
package/lib/types/answer-column.types.d.ts +1 -0
package/lib/types/answer-column.types.d.ts.map +1 -1
package/lib/types/common.types.d.ts +1 -1
package/lib/types/common.types.d.ts.map +1 -1
package/lib/utils/conditional-formatting/conditional-formatting.spec.js +20 -1
package/lib/utils/conditional-formatting/conditional-formatting.spec.js.map +1 -1
package/lib/utils/date-formatting.d.ts +19 -0
package/lib/utils/date-formatting.d.ts.map +1 -0
package/lib/utils/date-formatting.js +56 -0
package/lib/utils/date-formatting.js.map +1 -0
package/lib/utils/date-formatting.spec.d.ts +2 -0
package/lib/utils/date-formatting.spec.d.ts.map +1 -0
package/lib/utils/date-formatting.spec.js +123 -0
package/lib/utils/date-formatting.spec.js.map +1 -0
package/package.json +3 -1
package/src/index.ts +1 -0
package/src/main/custom-chart-context.spec.ts +64 -4
package/src/react/use-custom-chart-context.spec.tsx +65 -2
package/src/types/answer-column.types.ts +7 -0
package/src/types/common.types.ts +9 -3
package/src/utils/conditional-formatting/conditional-formatting.spec.ts +52 -0
package/src/utils/date-formatting.spec.ts +166 -0
package/src/utils/date-formatting.ts +109 -0

package/lib/utils/date-formatting.spec.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"date-formatting.spec.d.ts","sourceRoot":"","sources":["../../src/utils/date-formatting.spec.ts"],"names":[],"mappings":""}

package/lib/utils/date-formatting.spec.js ADDED Viewed

@@ -0,0 +1,123 @@
+import { ColumnTimeBucket, ColumnType, DataType, } from '../types/answer-column.types';
+import { dateFormatter, getCustomCalendarGuidFromColumn, getDisplayString, getStartEpoch, hasCustomCalendar, isAttribute, isDateColumn, isDateFamilyColumn, isDateNumColumn, isTimeColumn, } from './date-formatting';
+describe('date-formatting', () => {
+    let col;
+    beforeEach(() => {
+        col = {
+            id: 'testId',
+            name: 'test',
+            type: ColumnType.MEASURE,
+            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',
+        };
+        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' };
+        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 },
+        };
+        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',
+        };
+        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 },
+        };
+        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 } };
+        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',
+        };
+        expect(dateFormatter(date, col)).toBe(date.d);
+    });
+});
+//# sourceMappingURL=date-formatting.spec.js.map

package/lib/utils/date-formatting.spec.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"date-formatting.spec.js","sourceRoot":"","sources":["../../src/utils/date-formatting.spec.ts"],"names":[],"mappings":"AAQA,OAAO,EAEH,gBAAgB,EAChB,UAAU,EACV,QAAQ,GACX,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAEH,aAAa,EACb,+BAA+B,EAC/B,gBAAgB,EAChB,aAAa,EACb,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,kBAAkB,EAClB,eAAe,EACf,YAAY,GACf,MAAM,mBAAmB,CAAC;AAE3B,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC7B,IAAI,GAAgB,CAAC;IACrB,UAAU,CAAC,GAAG,EAAE;QACZ,GAAG,GAAG;YACF,EAAE,EAAE,QAAQ;YACZ,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,UAAU,CAAC,OAAO;YACxB,UAAU,EAAE,gBAAgB,CAAC,IAAI;YACjC,QAAQ,EAAE,QAAQ,CAAC,OAAO;YAC1B,YAAY,EAAE,OAAO;SACxB,CAAC;IACN,CAAC,CAAC,CAAC;IACH,IAAI,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC7B,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC;QAClC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,GAAG,CAAC,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC;QAChC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,GAAG,CAAC,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC;QAC9B,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC;QAC3B,MAAM,CAAC,+BAA+B,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kFAAkF,EAAE,GAAG,EAAE;QAC1F,GAAG,CAAC,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC;QAChC,GAAG,CAAC,UAAU,GAAG,gBAAgB,CAAC,WAAW,CAAC;QAC9C,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,GAAG,CAAC,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC;QAC9B,GAAG,CAAC,UAAU,GAAG,gBAAgB,CAAC,WAAW,CAAC;QAC9C,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC7B,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,GAAG,CAAC,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC;QAChC,GAAG,CAAC,UAAU,GAAG,gBAAgB,CAAC,WAAW,CAAC;QAC9C,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC7B,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mFAAmF,EAAE,GAAG,EAAE;QAC3F,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC7B,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC;QAC3B,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qEAAqE,EAAE,GAAG,EAAE;QAC7E,MAAM,IAAI,GAAG;YACT,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE;YACzB,CAAC,EAAE,aAAa;SACG,CAAC;QACxB,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,IAAI,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,YAAY,EAAwB,CAAC;QAC9D,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,MAAM,IAAI,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC;QACtE,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sEAAsE,EAAE,GAAG,EAAE;QAC9E,MAAM,IAAI,GAAG;YACT,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE;SAChB,CAAC;QACxB,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC/E,MAAM,SAAS,GAAG;YACd,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE;YACnC,CAAC,EAAE,YAAY;SACI,CAAC;QACxB,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC7B,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC;QAC3B,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8GAA8G,EAAE,GAAG,EAAE;QACtH,MAAM,SAAS,GAAG;YACd,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE;SAChB,CAAC;QACxB,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC7B,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC;QAC3B,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,EAAwB,CAAC;QACjE,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC7B,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC;QAC3B,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACnF,MAAM,SAAS,GAAG,UAAU,CAAC;QAC7B,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC7B,GAAG,CAAC,YAAY,GAAG,SAAS,CAAC;QAC7B,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IACH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC7B,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC;QAC3B,MAAM,IAAI,GAAG;YACT,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE;YACzB,CAAC,EAAE,aAAa;SACG,CAAC;QACxB,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
     "name": "@thoughtspot/ts-chart-sdk",
     "private": false,
-    "version": "0.0.2-alpha.6",
+    "version": "0.0.2-alpha.8",
     "module": "lib/index",
     "main": "lib/index",
     "types": "lib/index",
@@ -36,6 +36,7 @@
         "@testing-library/react-hooks": "^7.0.2",
         "@types/jest": "^27.0.3",
         "@types/lodash": "4.14.175",
+        "@types/luxon": "^3.4.2",
         "@types/node": "18.16.3",
         "@types/react": "^17.0.2",
         "@types/react-dom": "^17.0.11",
@@ -74,6 +75,7 @@
     },
     "dependencies": {
         "lodash": "^4.17.21",
+        "luxon": "^3.4.4",
         "promise-postmessage": "^3.5.0",
         "react": "^17.0.2",
         "react-dom": "^17.0.2"

package/src/index.ts CHANGED Viewed

@@ -7,4 +7,5 @@ export * from './types/ts-to-chart-event.types';
 export * from './main/custom-chart-context';
 export * from './react/use-custom-chart-context';
 export * from './types/conditional-formatting.types';
+export * from './utils/date-formatting';
 export * from './utils/conditional-formatting/conditional-formatting';

package/src/main/custom-chart-context.spec.ts CHANGED Viewed

@@ -112,23 +112,83 @@ describe('CustomChartContext', () => {
             expect(mockPostMessageToHost).not.toHaveBeenCalled();
         });
-        test('multiple intializations should throw an error', async () => {
+        test('type check string for visualProps on initialize payload should not throw an error.', async () => {
+            expect(mockInitMessage).toHaveBeenCalled();
             // Call the initialize function and wait for it to resolve
             const promise = customChartContext.initialize();
             // Check that the hasInitializedPromise has resolved
-            eventProcessor({
-                payload: mockInitializeContextPayload,
+            const mockInitializeContextPayloadWithVisualProps = {
+                ...mockInitializeContextPayload,
+                chartModel: {
+                    ...mockInitializeContextPayload.chartModel,
+                    visualProps: 'visualPropStringPayload',
+                },
+            };
+            await eventProcessor({
+                payload: mockInitializeContextPayloadWithVisualProps,
                 eventType: TSToChartEvent.Initialize,
             });
             eventProcessor({
                 payload: {},
                 eventType: TSToChartEvent.InitializeComplete,
             });
+            await expect(promise).resolves.toBeUndefined();
+            const chartModel = customChartContext.getChartModel();
+            expect(typeof chartModel.visualProps).toEqual('string');
+            expect(chartModel.visualProps).toEqual('visualPropStringPayload');
+            expect(mockPostMessageToHost).not.toHaveBeenCalled();
+        });
+        test('type check object for visualProps on initialize payload should not throw an error.', async () => {
+            expect(mockInitMessage).toHaveBeenCalled();
+            // Call the initialize function and wait for it to resolve
+            const promise = customChartContext.initialize();
+            // Check that the hasInitializedPromise has resolved
+            const mockInitializeContextPayloadWithVisualProps = {
+                ...mockInitializeContextPayload,
+                chartModel: {
+                    ...mockInitializeContextPayload.chartModel,
+                    visualProps: {
+                        data: 'sample data',
+                    },
+                },
+            };
+            await eventProcessor({
+                payload: mockInitializeContextPayloadWithVisualProps,
+                eventType: TSToChartEvent.Initialize,
+            });
+            eventProcessor({
+                payload: {},
+                eventType: TSToChartEvent.InitializeComplete,
+            });
             await expect(promise).resolves.toBeUndefined();
+            const chartModel = customChartContext.getChartModel();
+            expect(typeof chartModel.visualProps).toEqual('object');
+            expect(chartModel.visualProps).toEqual({
+                data: 'sample data',
+            });
+            expect(mockPostMessageToHost).not.toHaveBeenCalled();
+        });
+        test('multiple intializations should throw an error', async () => {
+            // Call the initialize function and wait for it to resolve
+            getChartContext({
+                getDefaultChartConfig,
+                getQueriesFromChartConfig,
+                renderChart,
+            });
+            eventProcessor({
+                payload: {},
+                eventType: TSToChartEvent.InitializeComplete,
+            });
             let error;
             try {
                 customChartContext = new CustomChartContext({

package/src/react/use-custom-chart-context.spec.tsx CHANGED Viewed

@@ -3,6 +3,7 @@ import { renderHook } from '@testing-library/react-hooks';
 import React from 'react';
 import * as PostMessageEventBridge from '../main/post-message-event-bridge';
 import { mockInitializeContextPayload } from '../test/test-utils';
+import { ColumnType } from '../types/answer-column.types';
 import { ChartToTSEvent } from '../types/chart-to-ts-event.types';
 import { TSToChartEvent } from '../types/ts-to-chart-event.types';
 import { contextChartProps } from './mocks/custom-chart-context-mock';
@@ -12,7 +13,10 @@ describe('useChartContext initialization', () => {
     let eventProcessor: any;
     let mockInitMessage;
     let mockPostMessageToHost;
-    const mockedChartModel = { columns: [], config: {} };
+    const mockedChartModel = {
+        columns: [{ type: ColumnType.MEASURE }, { type: ColumnType.ATTRIBUTE }],
+        config: {},
+    };
     beforeEach(() => {
         mockInitMessage = jest.spyOn(
             PostMessageEventBridge,
@@ -67,6 +71,66 @@ describe('useChartContext initialization', () => {
         });
     });
+    test('should trigger getDataQuery and fetch correct query response', async () => {
+        // Render the hook with the custom chart context props
+        const { result, waitFor } = renderHook(() =>
+            useChartContext(contextChartProps),
+        );
+        // Assert that the context is not initialized initially
+        expect(result.current.hasInitialized).toBe(false);
+        expect(result.current.chartModel).toBeUndefined();
+        await eventProcessor({
+            payload: {
+                componentId: 'COMPONENT_ID',
+                hostUrl: 'https://some.chart.app',
+                chartModel: mockedChartModel,
+            },
+            eventType: TSToChartEvent.Initialize,
+        });
+        const response = await eventProcessor({
+            payload: {
+                config: [
+                    {
+                        key: 'column',
+                        dimensions: [
+                            {
+                                key: 'x',
+                                columns: [mockedChartModel.columns[0]],
+                            },
+                            {
+                                key: 'y',
+                                columns: [mockedChartModel.columns[1]],
+                            },
+                        ],
+                    },
+                ],
+            },
+            eventType: TSToChartEvent.GetDataQuery,
+            source: 'ts-host-app',
+        });
+        await eventProcessor({
+            payload: {},
+            eventType: TSToChartEvent.TriggerRenderChart,
+            source: 'ts-host-app',
+        });
+        await eventProcessor({
+            payload: {},
+            eventType: TSToChartEvent.InitializeComplete,
+            source: 'ts-host-app',
+        });
+        await waitFor(() => {
+            expect(response.queries[0].queryColumns[0]).toBe(
+                mockedChartModel.columns[0],
+            );
+            expect(response.queries[0].queryColumns[1]).toBe(
+                mockedChartModel.columns[1],
+            );
+            expect(result.current.hasInitialized).toBeTruthy();
+        });
+    });
     test('should make sure hasInitialized to remain false when context initialization failed', async () => {
         jest.mock('../main/custom-chart-context', () => ({
             CustomChartContext: jest.fn().mockImplementation(() => ({
@@ -76,7 +140,6 @@ describe('useChartContext initialization', () => {
                 emitEvent: jest.fn(),
                 on: jest.fn(),
                 getChartModel: jest.fn(),
-                renderChart: jest.fn(),
                 destroy: jest.fn(),
             })),
         }));

package/src/types/answer-column.types.ts CHANGED Viewed

@@ -242,4 +242,11 @@ export interface ChartColumn {
      * @version SDK: 0.1 | ThoughtSpot:
      */
     customOrder?: Array<string>;
+    /**
+     * Guid of Custom calender for the column if defined in worksheet else null
+     *
+     * @version SDK: 0.1 | ThoughtSpot: sdcwdc
+     */
+    calenderGuid?: string;
 }

package/src/types/common.types.ts CHANGED Viewed

@@ -179,15 +179,21 @@ export type ValidationResponse = {
 /**
  * Custom Visual props is the stored metadata for the visual props definition
  * configured by the user in the visual prop editor
- * The JSON is defined by the visual prop types. See VisualPropEditorDefinition.
- *
+ * The object is defined by the visual prop types. See VisualPropEditorDefinition.
+ * If there is any local state specific to charts needs to be maintained on save answer, store it
+ * in VisualProps, with visualProps.clientState variable. The clientState variable should be a
+ * string, preferrably a result of JSON.stringify(<yourlocalClientState>).
+ * @remark
+ * only values stored in clientSate variable will be preserved on changing the
+ * visualPropeditorDefinition, any other variable store would not be preserved
  * @group Chart Model
  * @version SDK: 0.1 | ThoughtSpot:
  */
-export type VisualProps = JSON;
+export type VisualProps = unknown;
 /**
  * Custom Font Faces type from TS.
+ *
  */
 export type CustomFontFaces = {

package/src/utils/conditional-formatting/conditional-formatting.spec.ts CHANGED Viewed

@@ -21,7 +21,9 @@ import { DataPointsArray } from '../../types/common.types';
 import {
     ConditionalFormatting,
     ConditionalFormattingComparisonTypes,
+    FalconDataType,
     Operators,
+    ParameterValueType,
 } from '../../types/conditional-formatting.types';
 import {
     applicableConditionalFormatting,
@@ -64,12 +66,26 @@ const doesNotContainOperator = createAttributeOperator(
 const startsWithOperator = createAttributeOperator(Operators.StartsWith);
 const endsWithOperator = createAttributeOperator(Operators.EndsWith);
+const invalidOperator = createMetricOperator('invalid-operator' as any);
 const parameter = undefined;
 const mockConditionalFormatting: ConditionalFormatting = {
     rows: [lessThanOperator, greaterThanOperator, isBetweenOperator],
 };
+const parameters = [
+    {
+        id: 'parameter1',
+        defaultValue: 'abc',
+        dataType: FalconDataType.Char,
+        description: '',
+        owner: null as any,
+        valueType: ParameterValueType.Any,
+        name: 'parameter1',
+    },
+];
 describe('validateCfCondition', () => {
     test('verify validateCfCondition util', () => {
         expect(
@@ -115,6 +131,19 @@ describe('validateCfCondition', () => {
         expect(
             validateCfCondition(isBetweenOperator, 4, 'col1', mockDataAttr),
         ).toBe(false);
+        expect(
+            validateCfCondition(invalidOperator, 4, 'col1', mockDataAttr),
+        ).toBe(false);
+        const operatorWithColId = createMetricOperator(
+            Operators.LessThan,
+            'col1',
+            'col2',
+        );
+        expect(
+            validateCfCondition(operatorWithColId, 4, '', mockDataAttr),
+        ).toBe(false);
     });
 });
@@ -220,6 +249,9 @@ describe('isConditionSatisfied', () => {
         expect(isConditionSatisfied(notEqualToOperator, parameter, 200)).toBe(
             false,
         );
+        expect(isConditionSatisfied(notEqualToOperator, parameter, null)).toBe(
+            true,
+        );
         expect(isConditionSatisfied(isBetweenOperator, parameter, 200)).toBe(
             true,
         );
@@ -232,6 +264,9 @@ describe('isConditionSatisfied', () => {
         expect(isConditionSatisfied(isBetweenOperator, parameter, 50)).toBe(
             false,
         );
+        expect(isConditionSatisfied(isBetweenOperator, parameter, 50)).toBe(
+            false,
+        );
         expect(
             isConditionSatisfied(
@@ -411,5 +446,22 @@ describe('isConditionSatisfied', () => {
         expect(
             isConditionSatisfied(columnBasedOperator, undefined, 'abc', 'def'),
         ).toBe(false);
+        // Parameter Based
+        const parameterBasedOperator = createMetricOperator(
+            Operators.EqualTo,
+            'col1',
+            'col2',
+            'parameter1',
+            ConditionalFormattingComparisonTypes.ParameterBased,
+        );
+        expect(
+            isConditionSatisfied(
+                parameterBasedOperator,
+                parameters,
+                'abc',
+                'abc',
+            ),
+        ).toBe(true);
     });
 });

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

@@ -0,0 +1,166 @@
+/**
+ * @file: Date Formatting Spec
+ *
+ * @author Yashvardhan Nehra <yashvardhan.nehra@thoughtspot.com>
+ *
+ * Copyright: ThoughtSpot Inc. 2023
+ */
+import {
+    ChartColumn,
+    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,
+            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);
+    });
+});