@lightdash/common 2.37.0 → 2.38.0

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 (62) hide show
  1. package/dist/cjs/.tsbuildinfo +1 -1
  2. package/dist/cjs/authorization/roleToScopeMapping.testUtils.d.ts +98 -98
  3. package/dist/cjs/index.d.ts +1 -0
  4. package/dist/cjs/index.d.ts.map +1 -1
  5. package/dist/cjs/index.js +1 -0
  6. package/dist/cjs/index.js.map +1 -1
  7. package/dist/cjs/types/queryHistory.d.ts +4 -0
  8. package/dist/cjs/types/queryHistory.d.ts.map +1 -1
  9. package/dist/cjs/types/queryHistory.js.map +1 -1
  10. package/dist/cjs/utils/formatting.d.ts +1 -0
  11. package/dist/cjs/utils/formatting.d.ts.map +1 -1
  12. package/dist/cjs/utils/formatting.js +8 -2
  13. package/dist/cjs/utils/formatting.js.map +1 -1
  14. package/dist/cjs/utils/resultColumns.d.ts +13 -0
  15. package/dist/cjs/utils/resultColumns.d.ts.map +1 -0
  16. package/dist/cjs/utils/resultColumns.js +77 -0
  17. package/dist/cjs/utils/resultColumns.js.map +1 -0
  18. package/dist/cjs/utils/resultColumns.test.d.ts +2 -0
  19. package/dist/cjs/utils/resultColumns.test.d.ts.map +1 -0
  20. package/dist/cjs/utils/resultColumns.test.js +162 -0
  21. package/dist/cjs/utils/resultColumns.test.js.map +1 -0
  22. package/dist/esm/.tsbuildinfo +1 -1
  23. package/dist/esm/index.d.ts +1 -0
  24. package/dist/esm/index.d.ts.map +1 -1
  25. package/dist/esm/index.js +1 -0
  26. package/dist/esm/index.js.map +1 -1
  27. package/dist/esm/types/queryHistory.d.ts +4 -0
  28. package/dist/esm/types/queryHistory.d.ts.map +1 -1
  29. package/dist/esm/types/queryHistory.js.map +1 -1
  30. package/dist/esm/utils/formatting.d.ts +1 -0
  31. package/dist/esm/utils/formatting.d.ts.map +1 -1
  32. package/dist/esm/utils/formatting.js +7 -2
  33. package/dist/esm/utils/formatting.js.map +1 -1
  34. package/dist/esm/utils/resultColumns.d.ts +13 -0
  35. package/dist/esm/utils/resultColumns.d.ts.map +1 -0
  36. package/dist/esm/utils/resultColumns.js +74 -0
  37. package/dist/esm/utils/resultColumns.js.map +1 -0
  38. package/dist/esm/utils/resultColumns.test.d.ts +2 -0
  39. package/dist/esm/utils/resultColumns.test.d.ts.map +1 -0
  40. package/dist/esm/utils/resultColumns.test.js +160 -0
  41. package/dist/esm/utils/resultColumns.test.js.map +1 -0
  42. package/dist/types/.tsbuildinfo +1 -1
  43. package/dist/types/index.d.ts +1 -0
  44. package/dist/types/index.d.ts.map +1 -1
  45. package/dist/types/index.js +1 -0
  46. package/dist/types/index.js.map +1 -1
  47. package/dist/types/types/queryHistory.d.ts +4 -0
  48. package/dist/types/types/queryHistory.d.ts.map +1 -1
  49. package/dist/types/types/queryHistory.js.map +1 -1
  50. package/dist/types/utils/formatting.d.ts +1 -0
  51. package/dist/types/utils/formatting.d.ts.map +1 -1
  52. package/dist/types/utils/formatting.js +7 -2
  53. package/dist/types/utils/formatting.js.map +1 -1
  54. package/dist/types/utils/resultColumns.d.ts +13 -0
  55. package/dist/types/utils/resultColumns.d.ts.map +1 -0
  56. package/dist/types/utils/resultColumns.js +74 -0
  57. package/dist/types/utils/resultColumns.js.map +1 -0
  58. package/dist/types/utils/resultColumns.test.d.ts +2 -0
  59. package/dist/types/utils/resultColumns.test.d.ts.map +1 -0
  60. package/dist/types/utils/resultColumns.test.js +160 -0
  61. package/dist/types/utils/resultColumns.test.js.map +1 -0
  62. package/package.json +1 -1
@@ -0,0 +1,162 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const field_1 = require("../types/field");
4
+ const timeFrames_1 = require("../types/timeFrames");
5
+ const resultColumns_1 = require("./resultColumns");
6
+ const dimension = {
7
+ fieldType: field_1.FieldType.DIMENSION,
8
+ type: field_1.DimensionType.STRING,
9
+ name: 'status',
10
+ label: 'Status',
11
+ table: 'orders',
12
+ tableLabel: 'Orders',
13
+ sql: '${TABLE}.status',
14
+ hidden: false,
15
+ groups: [],
16
+ };
17
+ const metric = {
18
+ fieldType: field_1.FieldType.METRIC,
19
+ type: field_1.MetricType.SUM,
20
+ name: 'revenue',
21
+ label: 'Revenue',
22
+ table: 'orders',
23
+ tableLabel: 'Orders',
24
+ sql: '${TABLE}.revenue',
25
+ hidden: false,
26
+ groups: [],
27
+ };
28
+ const tableCalculation = {
29
+ name: 'calc',
30
+ displayName: 'My calc',
31
+ sql: '${orders.revenue} * 2',
32
+ };
33
+ describe('getResultColumnMetadataFromItem', () => {
34
+ test('returns empty metadata when there is no item behind the column', () => {
35
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(undefined, 'orders_x')).toEqual({});
36
+ });
37
+ test('enriches a plain dimension with label and provenance', () => {
38
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(dimension, 'orders_status')).toEqual({
39
+ label: 'Orders Status',
40
+ provenance: { fieldId: 'orders_status' },
41
+ });
42
+ });
43
+ test('numeric metrics carry the default format expression', () => {
44
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(metric, 'orders_revenue')).toEqual({
45
+ label: 'Orders Revenue',
46
+ provenance: { fieldId: 'orders_revenue' },
47
+ format: '#,##0.###',
48
+ });
49
+ });
50
+ test('legacy formats compile to expressions with their separator carried beside', () => {
51
+ const percentMetric = {
52
+ ...metric,
53
+ format: field_1.Format.PERCENT,
54
+ separator: field_1.NumberSeparator.PERIOD_COMMA,
55
+ };
56
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(percentMetric, 'orders_revenue')).toEqual({
57
+ label: 'Orders Revenue',
58
+ provenance: { fieldId: 'orders_revenue' },
59
+ format: '#,##0.###%',
60
+ separator: field_1.NumberSeparator.PERIOD_COMMA,
61
+ });
62
+ });
63
+ test('a stored format expression is carried as-is', () => {
64
+ const formatted = { ...metric, format: '[$$]#,##0.00' };
65
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(formatted, 'orders_revenue').format).toEqual('[$$]#,##0.00');
66
+ });
67
+ test('parameter-dependent format expressions interpolate against used parameter values', () => {
68
+ const parameterised = {
69
+ ...metric,
70
+ format: '${ld.parameters.currency=="usd"?"$":"€"}0.00',
71
+ };
72
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(parameterised, 'orders_revenue', {
73
+ currency: 'usd',
74
+ })).toEqual({
75
+ label: 'Orders Revenue',
76
+ provenance: { fieldId: 'orders_revenue' },
77
+ format: '$0.00',
78
+ });
79
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(parameterised, 'orders_revenue', {
80
+ currency: 'eur',
81
+ }).format).toEqual('€0.00');
82
+ });
83
+ test('parameter-dependent formats are omitted when values are missing', () => {
84
+ const parameterised = {
85
+ ...metric,
86
+ format: '${ld.parameters.currency=="usd"?"$":"€"}0.00',
87
+ };
88
+ // No parameter values at all.
89
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(parameterised, 'orders_revenue')).toEqual({
90
+ label: 'Orders Revenue',
91
+ provenance: { fieldId: 'orders_revenue' },
92
+ });
93
+ // Values that leave the placeholder unresolved.
94
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)({ ...metric, format: '"${ld.parameters.suffix}"0.00' }, 'orders_revenue', {}).format).toBeUndefined();
95
+ });
96
+ test('non-expressible structured formats ride the formatOptions escape hatch', () => {
97
+ const autoCompact = {
98
+ ...metric,
99
+ formatOptions: {
100
+ type: field_1.CustomFormatType.NUMBER,
101
+ compact: field_1.Compact.AUTO,
102
+ },
103
+ };
104
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(autoCompact, 'orders_revenue')).toEqual({
105
+ label: 'Orders Revenue',
106
+ provenance: { fieldId: 'orders_revenue' },
107
+ formatOptions: {
108
+ type: field_1.CustomFormatType.NUMBER,
109
+ compact: field_1.Compact.AUTO,
110
+ },
111
+ });
112
+ });
113
+ test('timestamp dimensions carry timeInterval and shiftsTimezone', () => {
114
+ const timestampDimension = {
115
+ ...dimension,
116
+ type: field_1.DimensionType.TIMESTAMP,
117
+ timeInterval: timeFrames_1.TimeFrames.SECOND,
118
+ };
119
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(timestampDimension, 'orders_created_at')).toEqual({
120
+ label: 'Orders Status',
121
+ provenance: { fieldId: 'orders_created_at' },
122
+ timeInterval: timeFrames_1.TimeFrames.SECOND,
123
+ shiftsTimezone: true,
124
+ });
125
+ });
126
+ test('date dimensions carry timeInterval without shifting', () => {
127
+ const dateDimension = {
128
+ ...dimension,
129
+ type: field_1.DimensionType.DATE,
130
+ timeInterval: timeFrames_1.TimeFrames.MONTH,
131
+ };
132
+ const metadata = (0, resultColumns_1.getResultColumnMetadataFromItem)(dateDimension, 'orders_created_month');
133
+ expect(metadata.timeInterval).toEqual(timeFrames_1.TimeFrames.MONTH);
134
+ expect(metadata.shiftsTimezone).toBeUndefined();
135
+ });
136
+ test('year-number dimensions carry no format at all', () => {
137
+ const yearNumDimension = {
138
+ ...dimension,
139
+ type: field_1.DimensionType.NUMBER,
140
+ timeInterval: timeFrames_1.TimeFrames.YEAR_NUM,
141
+ };
142
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(yearNumDimension, 'orders_created_year_num')).toEqual({
143
+ label: 'Orders Status',
144
+ provenance: { fieldId: 'orders_created_year_num' },
145
+ timeInterval: timeFrames_1.TimeFrames.YEAR_NUM,
146
+ });
147
+ });
148
+ test('table calculations get label and format but never provenance', () => {
149
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(tableCalculation, 'calc')).toEqual({
150
+ label: 'My calc',
151
+ });
152
+ const formattedTableCalculation = {
153
+ ...tableCalculation,
154
+ format: { type: field_1.CustomFormatType.PERCENT, round: 1 },
155
+ };
156
+ expect((0, resultColumns_1.getResultColumnMetadataFromItem)(formattedTableCalculation, 'calc')).toEqual({
157
+ label: 'My calc',
158
+ format: '#,##0.0%',
159
+ });
160
+ });
161
+ });
162
+ //# sourceMappingURL=resultColumns.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"resultColumns.test.js","sourceRoot":"","sources":["../../../src/utils/resultColumns.test.ts"],"names":[],"mappings":";;AAAA,0CAWwB;AACxB,oDAAiD;AACjD,mDAAkE;AAElE,MAAM,SAAS,GAAc;IACzB,SAAS,EAAE,iBAAS,CAAC,SAAS;IAC9B,IAAI,EAAE,qBAAa,CAAC,MAAM;IAC1B,IAAI,EAAE,QAAQ;IACd,KAAK,EAAE,QAAQ;IACf,KAAK,EAAE,QAAQ;IACf,UAAU,EAAE,QAAQ;IACpB,GAAG,EAAE,iBAAiB;IACtB,MAAM,EAAE,KAAK;IACb,MAAM,EAAE,EAAE;CACb,CAAC;AAEF,MAAM,MAAM,GAAW;IACnB,SAAS,EAAE,iBAAS,CAAC,MAAM;IAC3B,IAAI,EAAE,kBAAU,CAAC,GAAG;IACpB,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,SAAS;IAChB,KAAK,EAAE,QAAQ;IACf,UAAU,EAAE,QAAQ;IACpB,GAAG,EAAE,kBAAkB;IACvB,MAAM,EAAE,KAAK;IACb,MAAM,EAAE,EAAE;CACb,CAAC;AAEF,MAAM,gBAAgB,GAAqB;IACvC,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,SAAS;IACtB,GAAG,EAAE,uBAAuB;CAC/B,CAAC;AAEF,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC7C,IAAI,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,CAAC,IAAA,+CAA+B,EAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAClE,EAAE,CACL,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,CACF,IAAA,+CAA+B,EAAC,SAAS,EAAE,eAAe,CAAC,CAC9D,CAAC,OAAO,CAAC;YACN,KAAK,EAAE,eAAe;YACtB,UAAU,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;SAC3C,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,CACF,IAAA,+CAA+B,EAAC,MAAM,EAAE,gBAAgB,CAAC,CAC5D,CAAC,OAAO,CAAC;YACN,KAAK,EAAE,gBAAgB;YACvB,UAAU,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;YACzC,MAAM,EAAE,WAAW;SACtB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACnF,MAAM,aAAa,GAAW;YAC1B,GAAG,MAAM;YACT,MAAM,EAAE,cAAM,CAAC,OAAO;YACtB,SAAS,EAAE,uBAAe,CAAC,YAAY;SAC1C,CAAC;QACF,MAAM,CACF,IAAA,+CAA+B,EAAC,aAAa,EAAE,gBAAgB,CAAC,CACnE,CAAC,OAAO,CAAC;YACN,KAAK,EAAE,gBAAgB;YACvB,UAAU,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;YACzC,MAAM,EAAE,YAAY;YACpB,SAAS,EAAE,uBAAe,CAAC,YAAY;SAC1C,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,SAAS,GAAW,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QAChE,MAAM,CACF,IAAA,+CAA+B,EAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC,MAAM,CACtE,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kFAAkF,EAAE,GAAG,EAAE;QAC1F,MAAM,aAAa,GAAW;YAC1B,GAAG,MAAM;YACT,MAAM,EAAE,8CAA8C;SACzD,CAAC;QACF,MAAM,CACF,IAAA,+CAA+B,EAAC,aAAa,EAAE,gBAAgB,EAAE;YAC7D,QAAQ,EAAE,KAAK;SAClB,CAAC,CACL,CAAC,OAAO,CAAC;YACN,KAAK,EAAE,gBAAgB;YACvB,UAAU,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;YACzC,MAAM,EAAE,OAAO;SAClB,CAAC,CAAC;QACH,MAAM,CACF,IAAA,+CAA+B,EAAC,aAAa,EAAE,gBAAgB,EAAE;YAC7D,QAAQ,EAAE,KAAK;SAClB,CAAC,CAAC,MAAM,CACZ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,aAAa,GAAW;YAC1B,GAAG,MAAM;YACT,MAAM,EAAE,8CAA8C;SACzD,CAAC;QACF,8BAA8B;QAC9B,MAAM,CACF,IAAA,+CAA+B,EAAC,aAAa,EAAE,gBAAgB,CAAC,CACnE,CAAC,OAAO,CAAC;YACN,KAAK,EAAE,gBAAgB;YACvB,UAAU,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;SAC5C,CAAC,CAAC;QACH,gDAAgD;QAChD,MAAM,CACF,IAAA,+CAA+B,EAC3B,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,+BAA+B,EAAE,EACtD,gBAAgB,EAChB,EAAE,CACL,CAAC,MAAM,CACX,CAAC,aAAa,EAAE,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAChF,MAAM,WAAW,GAAW;YACxB,GAAG,MAAM;YACT,aAAa,EAAE;gBACX,IAAI,EAAE,wBAAgB,CAAC,MAAM;gBAC7B,OAAO,EAAE,eAAO,CAAC,IAAI;aACxB;SACJ,CAAC;QACF,MAAM,CACF,IAAA,+CAA+B,EAAC,WAAW,EAAE,gBAAgB,CAAC,CACjE,CAAC,OAAO,CAAC;YACN,KAAK,EAAE,gBAAgB;YACvB,UAAU,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;YACzC,aAAa,EAAE;gBACX,IAAI,EAAE,wBAAgB,CAAC,MAAM;gBAC7B,OAAO,EAAE,eAAO,CAAC,IAAI;aACxB;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,kBAAkB,GAAc;YAClC,GAAG,SAAS;YACZ,IAAI,EAAE,qBAAa,CAAC,SAAS;YAC7B,YAAY,EAAE,uBAAU,CAAC,MAAM;SAClC,CAAC;QACF,MAAM,CACF,IAAA,+CAA+B,EAC3B,kBAAkB,EAClB,mBAAmB,CACtB,CACJ,CAAC,OAAO,CAAC;YACN,KAAK,EAAE,eAAe;YACtB,UAAU,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE;YAC5C,YAAY,EAAE,uBAAU,CAAC,MAAM;YAC/B,cAAc,EAAE,IAAI;SACvB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,aAAa,GAAc;YAC7B,GAAG,SAAS;YACZ,IAAI,EAAE,qBAAa,CAAC,IAAI;YACxB,YAAY,EAAE,uBAAU,CAAC,KAAK;SACjC,CAAC;QACF,MAAM,QAAQ,GAAG,IAAA,+CAA+B,EAC5C,aAAa,EACb,sBAAsB,CACzB,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,uBAAU,CAAC,KAAK,CAAC,CAAC;QACxD,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,aAAa,EAAE,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,gBAAgB,GAAc;YAChC,GAAG,SAAS;YACZ,IAAI,EAAE,qBAAa,CAAC,MAAM;YAC1B,YAAY,EAAE,uBAAU,CAAC,QAAQ;SACpC,CAAC;QACF,MAAM,CACF,IAAA,+CAA+B,EAC3B,gBAAgB,EAChB,yBAAyB,CAC5B,CACJ,CAAC,OAAO,CAAC;YACN,KAAK,EAAE,eAAe;YACtB,UAAU,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE;YAClD,YAAY,EAAE,uBAAU,CAAC,QAAQ;SACpC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,MAAM,CACF,IAAA,+CAA+B,EAAC,gBAAgB,EAAE,MAAM,CAAC,CAC5D,CAAC,OAAO,CAAC;YACN,KAAK,EAAE,SAAS;SACnB,CAAC,CAAC;QAEH,MAAM,yBAAyB,GAAqB;YAChD,GAAG,gBAAgB;YACnB,MAAM,EAAE,EAAE,IAAI,EAAE,wBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE;SACvD,CAAC;QACF,MAAM,CACF,IAAA,+CAA+B,EAAC,yBAAyB,EAAE,MAAM,CAAC,CACrE,CAAC,OAAO,CAAC;YACN,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,UAAU;SACrB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}