@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,160 @@
1
+ import { Compact, CustomFormatType, DimensionType, FieldType, Format, MetricType, NumberSeparator, } from '../types/field';
2
+ import { TimeFrames } from '../types/timeFrames';
3
+ import { getResultColumnMetadataFromItem } from './resultColumns';
4
+ const dimension = {
5
+ fieldType: FieldType.DIMENSION,
6
+ type: DimensionType.STRING,
7
+ name: 'status',
8
+ label: 'Status',
9
+ table: 'orders',
10
+ tableLabel: 'Orders',
11
+ sql: '${TABLE}.status',
12
+ hidden: false,
13
+ groups: [],
14
+ };
15
+ const metric = {
16
+ fieldType: FieldType.METRIC,
17
+ type: MetricType.SUM,
18
+ name: 'revenue',
19
+ label: 'Revenue',
20
+ table: 'orders',
21
+ tableLabel: 'Orders',
22
+ sql: '${TABLE}.revenue',
23
+ hidden: false,
24
+ groups: [],
25
+ };
26
+ const tableCalculation = {
27
+ name: 'calc',
28
+ displayName: 'My calc',
29
+ sql: '${orders.revenue} * 2',
30
+ };
31
+ describe('getResultColumnMetadataFromItem', () => {
32
+ test('returns empty metadata when there is no item behind the column', () => {
33
+ expect(getResultColumnMetadataFromItem(undefined, 'orders_x')).toEqual({});
34
+ });
35
+ test('enriches a plain dimension with label and provenance', () => {
36
+ expect(getResultColumnMetadataFromItem(dimension, 'orders_status')).toEqual({
37
+ label: 'Orders Status',
38
+ provenance: { fieldId: 'orders_status' },
39
+ });
40
+ });
41
+ test('numeric metrics carry the default format expression', () => {
42
+ expect(getResultColumnMetadataFromItem(metric, 'orders_revenue')).toEqual({
43
+ label: 'Orders Revenue',
44
+ provenance: { fieldId: 'orders_revenue' },
45
+ format: '#,##0.###',
46
+ });
47
+ });
48
+ test('legacy formats compile to expressions with their separator carried beside', () => {
49
+ const percentMetric = {
50
+ ...metric,
51
+ format: Format.PERCENT,
52
+ separator: NumberSeparator.PERIOD_COMMA,
53
+ };
54
+ expect(getResultColumnMetadataFromItem(percentMetric, 'orders_revenue')).toEqual({
55
+ label: 'Orders Revenue',
56
+ provenance: { fieldId: 'orders_revenue' },
57
+ format: '#,##0.###%',
58
+ separator: NumberSeparator.PERIOD_COMMA,
59
+ });
60
+ });
61
+ test('a stored format expression is carried as-is', () => {
62
+ const formatted = { ...metric, format: '[$$]#,##0.00' };
63
+ expect(getResultColumnMetadataFromItem(formatted, 'orders_revenue').format).toEqual('[$$]#,##0.00');
64
+ });
65
+ test('parameter-dependent format expressions interpolate against used parameter values', () => {
66
+ const parameterised = {
67
+ ...metric,
68
+ format: '${ld.parameters.currency=="usd"?"$":"€"}0.00',
69
+ };
70
+ expect(getResultColumnMetadataFromItem(parameterised, 'orders_revenue', {
71
+ currency: 'usd',
72
+ })).toEqual({
73
+ label: 'Orders Revenue',
74
+ provenance: { fieldId: 'orders_revenue' },
75
+ format: '$0.00',
76
+ });
77
+ expect(getResultColumnMetadataFromItem(parameterised, 'orders_revenue', {
78
+ currency: 'eur',
79
+ }).format).toEqual('€0.00');
80
+ });
81
+ test('parameter-dependent formats are omitted when values are missing', () => {
82
+ const parameterised = {
83
+ ...metric,
84
+ format: '${ld.parameters.currency=="usd"?"$":"€"}0.00',
85
+ };
86
+ // No parameter values at all.
87
+ expect(getResultColumnMetadataFromItem(parameterised, 'orders_revenue')).toEqual({
88
+ label: 'Orders Revenue',
89
+ provenance: { fieldId: 'orders_revenue' },
90
+ });
91
+ // Values that leave the placeholder unresolved.
92
+ expect(getResultColumnMetadataFromItem({ ...metric, format: '"${ld.parameters.suffix}"0.00' }, 'orders_revenue', {}).format).toBeUndefined();
93
+ });
94
+ test('non-expressible structured formats ride the formatOptions escape hatch', () => {
95
+ const autoCompact = {
96
+ ...metric,
97
+ formatOptions: {
98
+ type: CustomFormatType.NUMBER,
99
+ compact: Compact.AUTO,
100
+ },
101
+ };
102
+ expect(getResultColumnMetadataFromItem(autoCompact, 'orders_revenue')).toEqual({
103
+ label: 'Orders Revenue',
104
+ provenance: { fieldId: 'orders_revenue' },
105
+ formatOptions: {
106
+ type: CustomFormatType.NUMBER,
107
+ compact: Compact.AUTO,
108
+ },
109
+ });
110
+ });
111
+ test('timestamp dimensions carry timeInterval and shiftsTimezone', () => {
112
+ const timestampDimension = {
113
+ ...dimension,
114
+ type: DimensionType.TIMESTAMP,
115
+ timeInterval: TimeFrames.SECOND,
116
+ };
117
+ expect(getResultColumnMetadataFromItem(timestampDimension, 'orders_created_at')).toEqual({
118
+ label: 'Orders Status',
119
+ provenance: { fieldId: 'orders_created_at' },
120
+ timeInterval: TimeFrames.SECOND,
121
+ shiftsTimezone: true,
122
+ });
123
+ });
124
+ test('date dimensions carry timeInterval without shifting', () => {
125
+ const dateDimension = {
126
+ ...dimension,
127
+ type: DimensionType.DATE,
128
+ timeInterval: TimeFrames.MONTH,
129
+ };
130
+ const metadata = getResultColumnMetadataFromItem(dateDimension, 'orders_created_month');
131
+ expect(metadata.timeInterval).toEqual(TimeFrames.MONTH);
132
+ expect(metadata.shiftsTimezone).toBeUndefined();
133
+ });
134
+ test('year-number dimensions carry no format at all', () => {
135
+ const yearNumDimension = {
136
+ ...dimension,
137
+ type: DimensionType.NUMBER,
138
+ timeInterval: TimeFrames.YEAR_NUM,
139
+ };
140
+ expect(getResultColumnMetadataFromItem(yearNumDimension, 'orders_created_year_num')).toEqual({
141
+ label: 'Orders Status',
142
+ provenance: { fieldId: 'orders_created_year_num' },
143
+ timeInterval: TimeFrames.YEAR_NUM,
144
+ });
145
+ });
146
+ test('table calculations get label and format but never provenance', () => {
147
+ expect(getResultColumnMetadataFromItem(tableCalculation, 'calc')).toEqual({
148
+ label: 'My calc',
149
+ });
150
+ const formattedTableCalculation = {
151
+ ...tableCalculation,
152
+ format: { type: CustomFormatType.PERCENT, round: 1 },
153
+ };
154
+ expect(getResultColumnMetadataFromItem(formattedTableCalculation, 'calc')).toEqual({
155
+ label: 'My calc',
156
+ format: '#,##0.0%',
157
+ });
158
+ });
159
+ });
160
+ //# 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,OAAO,EACH,OAAO,EACP,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,MAAM,EACN,UAAU,EACV,eAAe,GAIlB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,+BAA+B,EAAE,MAAM,iBAAiB,CAAC;AAElE,MAAM,SAAS,GAAc;IACzB,SAAS,EAAE,SAAS,CAAC,SAAS;IAC9B,IAAI,EAAE,aAAa,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,SAAS,CAAC,MAAM;IAC3B,IAAI,EAAE,UAAU,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,+BAA+B,CAAC,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,+BAA+B,CAAC,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,+BAA+B,CAAC,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,MAAM,CAAC,OAAO;YACtB,SAAS,EAAE,eAAe,CAAC,YAAY;SAC1C,CAAC;QACF,MAAM,CACF,+BAA+B,CAAC,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,eAAe,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,+BAA+B,CAAC,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,+BAA+B,CAAC,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,+BAA+B,CAAC,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,+BAA+B,CAAC,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,+BAA+B,CAC3B,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,gBAAgB,CAAC,MAAM;gBAC7B,OAAO,EAAE,OAAO,CAAC,IAAI;aACxB;SACJ,CAAC;QACF,MAAM,CACF,+BAA+B,CAAC,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,gBAAgB,CAAC,MAAM;gBAC7B,OAAO,EAAE,OAAO,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,aAAa,CAAC,SAAS;YAC7B,YAAY,EAAE,UAAU,CAAC,MAAM;SAClC,CAAC;QACF,MAAM,CACF,+BAA+B,CAC3B,kBAAkB,EAClB,mBAAmB,CACtB,CACJ,CAAC,OAAO,CAAC;YACN,KAAK,EAAE,eAAe;YACtB,UAAU,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE;YAC5C,YAAY,EAAE,UAAU,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,aAAa,CAAC,IAAI;YACxB,YAAY,EAAE,UAAU,CAAC,KAAK;SACjC,CAAC;QACF,MAAM,QAAQ,GAAG,+BAA+B,CAC5C,aAAa,EACb,sBAAsB,CACzB,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,UAAU,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,aAAa,CAAC,MAAM;YAC1B,YAAY,EAAE,UAAU,CAAC,QAAQ;SACpC,CAAC;QACF,MAAM,CACF,+BAA+B,CAC3B,gBAAgB,EAChB,yBAAyB,CAC5B,CACJ,CAAC,OAAO,CAAC;YACN,KAAK,EAAE,eAAe;YACtB,UAAU,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE;YAClD,YAAY,EAAE,UAAU,CAAC,QAAQ;SACpC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,MAAM,CACF,+BAA+B,CAAC,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,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE;SACvD,CAAC;QACF,MAAM,CACF,+BAA+B,CAAC,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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lightdash/common",
3
- "version": "2.37.0",
3
+ "version": "2.38.0",
4
4
  "license": "MIT",
5
5
  "repository": {
6
6
  "type": "git",