@lightdash/common 0.2045.0 → 0.2047.0

package/dist/esm/ee/AiAgent/schemas/tableCalcs/tableCalcs.js

@@ -0,0 +1,120 @@
+import { z } from 'zod';
+import { CustomFormatType, NumberSeparator, TableCalculationTemplateType, TableCalculationType, } from '../../../../types/field';
+import assertUnreachable from '../../../../utils/assertUnreachable';
+import { tableCalcPercentChangeFromPreviousSchema } from './tableCalcPercentChangeFromPrevious';
+import { tableCalcPercentOfColumnTotalSchema } from './tableCalcPercentOfColumnTotal';
+import { tableCalcPercentOfPreviousValueSchema } from './tableCalcPercentOfPreviousValue';
+import { tableCalcRankInColumnSchema } from './tableCalcRankInColumn';
+import { tableCalcRunningTotalSchema } from './tableCalcRunningTotal';
+const tableCalcSchema = z.discriminatedUnion('type', [
+    tableCalcPercentChangeFromPreviousSchema,
+    tableCalcPercentOfPreviousValueSchema,
+    tableCalcPercentOfColumnTotalSchema,
+    tableCalcRankInColumnSchema,
+    tableCalcRunningTotalSchema,
+]);
+// TODO improve description
+export const tableCalcsSchema = z.array(tableCalcSchema).nullable().describe(`
+Table calculations are a way to perform calculations across row sets without collapsing rows. You can think of them like SQL Window Functions.
+
+Create table calculations when:
+
+- User requests percentage change between columns
+  Examples: "Show revenue growth from last month", "Calculate MoY/Month-over-month, YoY/Year-over-year sales change"
+  Recommended visualization type: Table, bar chart
+
+- User requests percentage of column compared to previous row
+  Examples: "Show revenue as % of previous month", "What percent is each quarter vs the prior quarter"
+  Recommended visualization type: Table, bar chart
+
+- User requests percentage of column total
+  Examples: "Show each product as % of total sales", "What percentage does each region contribute to overall revenue"
+  Recommended visualization type: Table, Bar chart
+
+- User requests rank within a column
+  Examples: "Rank customers by revenue", "Show top performing sales reps by deal count"
+  Recommended visualization type: Table, Bar chart
+
+- User requests running total
+  Examples: "Show cumulative revenue over time", "Running sum of orders by month"
+  Recommended visualization type: Line chart for the table calculation as Y axis and time as X axis
+`);
+function convertTableCalcSchemaToTableCalc(tableCalc) {
+    const { type, name, displayName, fieldId } = tableCalc;
+    // Build the template
+    const baseCalc = {
+        name,
+        displayName,
+        type: TableCalculationType.NUMBER,
+    };
+    switch (type) {
+        case 'percent_change_from_previous':
+            return {
+                ...baseCalc,
+                template: {
+                    type: TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS,
+                    fieldId,
+                    orderBy: tableCalc.orderBy,
+                },
+                format: {
+                    type: CustomFormatType.PERCENT,
+                    separator: NumberSeparator.DEFAULT,
+                },
+            };
+        case 'percent_of_previous_value':
+            return {
+                ...baseCalc,
+                template: {
+                    type: TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE,
+                    fieldId,
+                    orderBy: tableCalc.orderBy,
+                },
+                format: {
+                    type: CustomFormatType.PERCENT,
+                    separator: NumberSeparator.DEFAULT,
+                },
+            };
+        case 'percent_of_column_total':
+            return {
+                ...baseCalc,
+                template: {
+                    type: TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL,
+                    fieldId,
+                },
+                format: {
+                    type: CustomFormatType.PERCENT,
+                    separator: NumberSeparator.DEFAULT,
+                },
+            };
+        case 'rank_in_column':
+            return {
+                ...baseCalc,
+                template: {
+                    type: TableCalculationTemplateType.RANK_IN_COLUMN,
+                    fieldId,
+                },
+                format: {
+                    type: CustomFormatType.NUMBER,
+                    separator: NumberSeparator.DEFAULT,
+                },
+            };
+        case 'running_total':
+            return {
+                ...baseCalc,
+                template: {
+                    type: TableCalculationTemplateType.RUNNING_TOTAL,
+                    fieldId,
+                },
+                format: {
+                    type: CustomFormatType.NUMBER,
+                    separator: NumberSeparator.DEFAULT,
+                },
+            };
+        default:
+            return assertUnreachable(type, 'Unknown table calc type');
+    }
+}
+export function convertAiTableCalcsSchemaToTableCalcs(tableCalcs) {
+    return tableCalcs?.map((tc) => convertTableCalcSchemaToTableCalc(tc)) ?? [];
+}
+//# sourceMappingURL=tableCalcs.js.map

package/dist/esm/ee/AiAgent/schemas/tableCalcs/tableCalcs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tableCalcs.js","sourceRoot":"","sources":["../../../../../../src/ee/AiAgent/schemas/tableCalcs/tableCalcs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACH,gBAAgB,EAChB,eAAe,EACf,4BAA4B,EAC5B,oBAAoB,GAEvB,MAAM,yBAAyB,CAAC;AACjC,OAAO,iBAAiB,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,wCAAwC,EAAE,MAAM,sCAAsC,CAAC;AAChG,OAAO,EAAE,mCAAmC,EAAE,MAAM,iCAAiC,CAAC;AACtF,OAAO,EAAE,qCAAqC,EAAE,MAAM,mCAAmC,CAAC;AAC1F,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AAEtE,MAAM,eAAe,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IACjD,wCAAwC;IACxC,qCAAqC;IACrC,mCAAmC;IACnC,2BAA2B;IAC3B,2BAA2B;CAC9B,CAAC,CAAC;AAGH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;;;;;;CAwB5E,CAAC,CAAC;AAIH,SAAS,iCAAiC,CACtC,SAA0B;IAE1B,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC;IAEvD,qBAAqB;IACrB,MAAM,QAAQ,GAAqC;QAC/C,IAAI;QACJ,WAAW;QACX,IAAI,EAAE,oBAAoB,CAAC,MAAM;KACpC,CAAC;IAEF,QAAQ,IAAI,EAAE,CAAC;QACX,KAAK,8BAA8B;YAC/B,OAAO;gBACH,GAAG,QAAQ;gBACX,QAAQ,EAAE;oBACN,IAAI,EAAE,4BAA4B,CAAC,4BAA4B;oBAC/D,OAAO;oBACP,OAAO,EAAE,SAAS,CAAC,OAAO;iBAC7B;gBACD,MAAM,EAAE;oBACJ,IAAI,EAAE,gBAAgB,CAAC,OAAO;oBAC9B,SAAS,EAAE,eAAe,CAAC,OAAO;iBACrC;aACJ,CAAC;QACN,KAAK,2BAA2B;YAC5B,OAAO;gBACH,GAAG,QAAQ;gBACX,QAAQ,EAAE;oBACN,IAAI,EAAE,4BAA4B,CAAC,yBAAyB;oBAC5D,OAAO;oBACP,OAAO,EAAE,SAAS,CAAC,OAAO;iBAC7B;gBACD,MAAM,EAAE;oBACJ,IAAI,EAAE,gBAAgB,CAAC,OAAO;oBAC9B,SAAS,EAAE,eAAe,CAAC,OAAO;iBACrC;aACJ,CAAC;QACN,KAAK,yBAAyB;YAC1B,OAAO;gBACH,GAAG,QAAQ;gBACX,QAAQ,EAAE;oBACN,IAAI,EAAE,4BAA4B,CAAC,uBAAuB;oBAC1D,OAAO;iBACV;gBACD,MAAM,EAAE;oBACJ,IAAI,EAAE,gBAAgB,CAAC,OAAO;oBAC9B,SAAS,EAAE,eAAe,CAAC,OAAO;iBACrC;aACJ,CAAC;QACN,KAAK,gBAAgB;YACjB,OAAO;gBACH,GAAG,QAAQ;gBACX,QAAQ,EAAE;oBACN,IAAI,EAAE,4BAA4B,CAAC,cAAc;oBACjD,OAAO;iBACV;gBACD,MAAM,EAAE;oBACJ,IAAI,EAAE,gBAAgB,CAAC,MAAM;oBAC7B,SAAS,EAAE,eAAe,CAAC,OAAO;iBACrC;aACJ,CAAC;QACN,KAAK,eAAe;YAChB,OAAO;gBACH,GAAG,QAAQ;gBACX,QAAQ,EAAE;oBACN,IAAI,EAAE,4BAA4B,CAAC,aAAa;oBAChD,OAAO;iBACV;gBACD,MAAM,EAAE;oBACJ,IAAI,EAAE,gBAAgB,CAAC,MAAM;oBAC7B,SAAS,EAAE,eAAe,CAAC,OAAO;iBACrC;aACJ,CAAC;QACN;YACI,OAAO,iBAAiB,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC;IAClE,CAAC;AACL,CAAC;AAED,MAAM,UAAU,qCAAqC,CACjD,UAA4B;IAE5B,OAAO,UAAU,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,iCAAiC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAChF,CAAC"}

package/dist/esm/ee/AiAgent/schemas/tableCalcs/tableCalcs.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=tableCalcs.test.d.ts.map

package/dist/esm/ee/AiAgent/schemas/tableCalcs/tableCalcs.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tableCalcs.test.d.ts","sourceRoot":"","sources":["../../../../../../src/ee/AiAgent/schemas/tableCalcs/tableCalcs.test.ts"],"names":[],"mappings":""}

package/dist/esm/ee/AiAgent/schemas/tableCalcs/tableCalcs.test.js

@@ -0,0 +1,54 @@
+import { TableCalculationTemplateType } from '../../../../types/field';
+import { convertAiTableCalcsSchemaToTableCalcs, } from './tableCalcs';
+describe('convertAiTableCalcsSchemaToTableCalcs', () => {
+    it('creates template for percent_of_column_total', () => {
+        const tableCalcs = [
+            {
+                type: 'percent_of_column_total',
+                name: 'percent_total_sales',
+                displayName: 'Percent of total sales',
+                fieldId: 'orders_revenue',
+            },
+        ];
+        const [tableCalc] = convertAiTableCalcsSchemaToTableCalcs(tableCalcs);
+        if (!('template' in tableCalc)) {
+            throw new Error('Table calculation is not a template');
+        }
+        expect(tableCalc.template).toBeDefined();
+        expect(tableCalc.template?.type).toBe(TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL);
+        expect(tableCalc.template?.fieldId).toBe('orders_revenue');
+    });
+    it('creates template with orderBy for percent_change_from_previous', () => {
+        const tableCalcs = [
+            {
+                type: 'percent_change_from_previous',
+                name: 'percent_change_sales',
+                displayName: 'Percent change sales',
+                fieldId: 'orders_revenue',
+                orderBy: [
+                    {
+                        fieldId: 'percent_change_sales',
+                        order: 'asc',
+                    },
+                    {
+                        fieldId: 'orders_revenue',
+                        order: 'desc',
+                    },
+                ],
+            },
+        ];
+        const [tableCalc] = convertAiTableCalcsSchemaToTableCalcs(tableCalcs);
+        if (!('template' in tableCalc)) {
+            throw new Error('Table calculation is not a template');
+        }
+        expect(tableCalc.template).toBeDefined();
+        expect(tableCalc.template.type).toBe(TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS);
+        if ('orderBy' in tableCalc.template) {
+            expect(tableCalc.template.orderBy).toEqual([
+                { fieldId: 'percent_change_sales', order: 'asc' },
+                { fieldId: 'orders_revenue', order: 'desc' },
+            ]);
+        }
+    });
+});
+//# sourceMappingURL=tableCalcs.test.js.map

package/dist/esm/ee/AiAgent/schemas/tableCalcs/tableCalcs.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tableCalcs.test.js","sourceRoot":"","sources":["../../../../../../src/ee/AiAgent/schemas/tableCalcs/tableCalcs.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EACH,qCAAqC,GAExC,MAAM,cAAc,CAAC;AAEtB,QAAQ,CAAC,uCAAuC,EAAE,GAAG,EAAE;IACnD,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,UAAU,GAAqB;YACjC;gBACI,IAAI,EAAE,yBAAyB;gBAC/B,IAAI,EAAE,qBAAqB;gBAC3B,WAAW,EAAE,wBAAwB;gBACrC,OAAO,EAAE,gBAAgB;aAC5B;SACJ,CAAC;QAEF,MAAM,CAAC,SAAS,CAAC,GAAG,qCAAqC,CAAC,UAAU,CAAC,CAAC;QAEtE,IAAI,CAAC,CAAC,UAAU,IAAI,SAAS,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QACzC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,CACjC,4BAA4B,CAAC,uBAAuB,CACvD,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,UAAU,GAAqB;YACjC;gBACI,IAAI,EAAE,8BAA8B;gBACpC,IAAI,EAAE,sBAAsB;gBAC5B,WAAW,EAAE,sBAAsB;gBACnC,OAAO,EAAE,gBAAgB;gBACzB,OAAO,EAAE;oBACL;wBACI,OAAO,EAAE,sBAAsB;wBAC/B,KAAK,EAAE,KAAK;qBACf;oBACD;wBACI,OAAO,EAAE,gBAAgB;wBACzB,KAAK,EAAE,MAAM;qBAChB;iBACJ;aACJ;SACJ,CAAC;QAEF,MAAM,CAAC,SAAS,CAAC,GAAG,qCAAqC,CAAC,UAAU,CAAC,CAAC;QAEtE,IAAI,CAAC,CAAC,UAAU,IAAI,SAAS,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QACzC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAChC,4BAA4B,CAAC,4BAA4B,CAC5D,CAAC;QACF,IAAI,SAAS,IAAI,SAAS,CAAC,QAAS,EAAE,CAAC;YACnC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;gBACvC,EAAE,OAAO,EAAE,sBAAsB,EAAE,KAAK,EAAE,KAAK,EAAE;gBACjD,EAAE,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE;aAC/C,CAAC,CAAC;QACP,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}