@lightdash/common 0.2046.0 → 0.2047.0

package/dist/cjs/ee/AiAgent/schemas/tableCalcs/tableCalcs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tableCalcs.d.ts","sourceRoot":"","sources":["../../../../../../src/ee/AiAgent/schemas/tableCalcs/tableCalcs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAKH,KAAK,gBAAgB,EACxB,MAAM,yBAAyB,CAAC;AAQjC,QAAA,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAMnB,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAE9D,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAwB3B,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAkFhE,wBAAgB,qCAAqC,CACjD,UAAU,EAAE,gBAAgB,GAC7B,gBAAgB,EAAE,CAEpB"}

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

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tableCalcsSchema = void 0;
+exports.convertAiTableCalcsSchemaToTableCalcs = convertAiTableCalcsSchemaToTableCalcs;
+const tslib_1 = require("tslib");
+const zod_1 = require("zod");
+const field_1 = require("../../../../types/field");
+const assertUnreachable_1 = tslib_1.__importDefault(require("../../../../utils/assertUnreachable"));
+const tableCalcPercentChangeFromPrevious_1 = require("./tableCalcPercentChangeFromPrevious");
+const tableCalcPercentOfColumnTotal_1 = require("./tableCalcPercentOfColumnTotal");
+const tableCalcPercentOfPreviousValue_1 = require("./tableCalcPercentOfPreviousValue");
+const tableCalcRankInColumn_1 = require("./tableCalcRankInColumn");
+const tableCalcRunningTotal_1 = require("./tableCalcRunningTotal");
+const tableCalcSchema = zod_1.z.discriminatedUnion('type', [
+    tableCalcPercentChangeFromPrevious_1.tableCalcPercentChangeFromPreviousSchema,
+    tableCalcPercentOfPreviousValue_1.tableCalcPercentOfPreviousValueSchema,
+    tableCalcPercentOfColumnTotal_1.tableCalcPercentOfColumnTotalSchema,
+    tableCalcRankInColumn_1.tableCalcRankInColumnSchema,
+    tableCalcRunningTotal_1.tableCalcRunningTotalSchema,
+]);
+// TODO improve description
+exports.tableCalcsSchema = zod_1.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: field_1.TableCalculationType.NUMBER,
+    };
+    switch (type) {
+        case 'percent_change_from_previous':
+            return {
+                ...baseCalc,
+                template: {
+                    type: field_1.TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS,
+                    fieldId,
+                    orderBy: tableCalc.orderBy,
+                },
+                format: {
+                    type: field_1.CustomFormatType.PERCENT,
+                    separator: field_1.NumberSeparator.DEFAULT,
+                },
+            };
+        case 'percent_of_previous_value':
+            return {
+                ...baseCalc,
+                template: {
+                    type: field_1.TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE,
+                    fieldId,
+                    orderBy: tableCalc.orderBy,
+                },
+                format: {
+                    type: field_1.CustomFormatType.PERCENT,
+                    separator: field_1.NumberSeparator.DEFAULT,
+                },
+            };
+        case 'percent_of_column_total':
+            return {
+                ...baseCalc,
+                template: {
+                    type: field_1.TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL,
+                    fieldId,
+                },
+                format: {
+                    type: field_1.CustomFormatType.PERCENT,
+                    separator: field_1.NumberSeparator.DEFAULT,
+                },
+            };
+        case 'rank_in_column':
+            return {
+                ...baseCalc,
+                template: {
+                    type: field_1.TableCalculationTemplateType.RANK_IN_COLUMN,
+                    fieldId,
+                },
+                format: {
+                    type: field_1.CustomFormatType.NUMBER,
+                    separator: field_1.NumberSeparator.DEFAULT,
+                },
+            };
+        case 'running_total':
+            return {
+                ...baseCalc,
+                template: {
+                    type: field_1.TableCalculationTemplateType.RUNNING_TOTAL,
+                    fieldId,
+                },
+                format: {
+                    type: field_1.CustomFormatType.NUMBER,
+                    separator: field_1.NumberSeparator.DEFAULT,
+                },
+            };
+        default:
+            return (0, assertUnreachable_1.default)(type, 'Unknown table calc type');
+    }
+}
+function convertAiTableCalcsSchemaToTableCalcs(tableCalcs) {
+    return tableCalcs?.map((tc) => convertTableCalcSchemaToTableCalc(tc)) ?? [];
+}
+//# sourceMappingURL=tableCalcs.js.map

package/dist/cjs/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":";;;AAqIA,sFAIC;;AAzID,6BAAwB;AACxB,mDAMiC;AACjC,oGAAoE;AACpE,6FAAgG;AAChG,mFAAsF;AACtF,uFAA0F;AAC1F,mEAAsE;AACtE,mEAAsE;AAEtE,MAAM,eAAe,GAAG,OAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IACjD,6EAAwC;IACxC,uEAAqC;IACrC,mEAAmC;IACnC,mDAA2B;IAC3B,mDAA2B;CAC9B,CAAC,CAAC;AAGH,2BAA2B;AACd,QAAA,gBAAgB,GAAG,OAAC,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,4BAAoB,CAAC,MAAM;KACpC,CAAC;IAEF,QAAQ,IAAI,EAAE,CAAC;QACX,KAAK,8BAA8B;YAC/B,OAAO;gBACH,GAAG,QAAQ;gBACX,QAAQ,EAAE;oBACN,IAAI,EAAE,oCAA4B,CAAC,4BAA4B;oBAC/D,OAAO;oBACP,OAAO,EAAE,SAAS,CAAC,OAAO;iBAC7B;gBACD,MAAM,EAAE;oBACJ,IAAI,EAAE,wBAAgB,CAAC,OAAO;oBAC9B,SAAS,EAAE,uBAAe,CAAC,OAAO;iBACrC;aACJ,CAAC;QACN,KAAK,2BAA2B;YAC5B,OAAO;gBACH,GAAG,QAAQ;gBACX,QAAQ,EAAE;oBACN,IAAI,EAAE,oCAA4B,CAAC,yBAAyB;oBAC5D,OAAO;oBACP,OAAO,EAAE,SAAS,CAAC,OAAO;iBAC7B;gBACD,MAAM,EAAE;oBACJ,IAAI,EAAE,wBAAgB,CAAC,OAAO;oBAC9B,SAAS,EAAE,uBAAe,CAAC,OAAO;iBACrC;aACJ,CAAC;QACN,KAAK,yBAAyB;YAC1B,OAAO;gBACH,GAAG,QAAQ;gBACX,QAAQ,EAAE;oBACN,IAAI,EAAE,oCAA4B,CAAC,uBAAuB;oBAC1D,OAAO;iBACV;gBACD,MAAM,EAAE;oBACJ,IAAI,EAAE,wBAAgB,CAAC,OAAO;oBAC9B,SAAS,EAAE,uBAAe,CAAC,OAAO;iBACrC;aACJ,CAAC;QACN,KAAK,gBAAgB;YACjB,OAAO;gBACH,GAAG,QAAQ;gBACX,QAAQ,EAAE;oBACN,IAAI,EAAE,oCAA4B,CAAC,cAAc;oBACjD,OAAO;iBACV;gBACD,MAAM,EAAE;oBACJ,IAAI,EAAE,wBAAgB,CAAC,MAAM;oBAC7B,SAAS,EAAE,uBAAe,CAAC,OAAO;iBACrC;aACJ,CAAC;QACN,KAAK,eAAe;YAChB,OAAO;gBACH,GAAG,QAAQ;gBACX,QAAQ,EAAE;oBACN,IAAI,EAAE,oCAA4B,CAAC,aAAa;oBAChD,OAAO;iBACV;gBACD,MAAM,EAAE;oBACJ,IAAI,EAAE,wBAAgB,CAAC,MAAM;oBAC7B,SAAS,EAAE,uBAAe,CAAC,OAAO;iBACrC;aACJ,CAAC;QACN;YACI,OAAO,IAAA,2BAAiB,EAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC;IAClE,CAAC;AACL,CAAC;AAED,SAAgB,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/cjs/ee/AiAgent/schemas/tableCalcs/tableCalcs.test.d.ts

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

package/dist/cjs/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/cjs/ee/AiAgent/schemas/tableCalcs/tableCalcs.test.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const field_1 = require("../../../../types/field");
+const tableCalcs_1 = require("./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] = (0, tableCalcs_1.convertAiTableCalcsSchemaToTableCalcs)(tableCalcs);
+        if (!('template' in tableCalc)) {
+            throw new Error('Table calculation is not a template');
+        }
+        expect(tableCalc.template).toBeDefined();
+        expect(tableCalc.template?.type).toBe(field_1.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] = (0, tableCalcs_1.convertAiTableCalcsSchemaToTableCalcs)(tableCalcs);
+        if (!('template' in tableCalc)) {
+            throw new Error('Table calculation is not a template');
+        }
+        expect(tableCalc.template).toBeDefined();
+        expect(tableCalc.template.type).toBe(field_1.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/cjs/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,mDAAuE;AACvE,6CAGsB;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,IAAA,kDAAqC,EAAC,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,oCAA4B,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,IAAA,kDAAqC,EAAC,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,oCAA4B,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"}