@lightdash/common 2.174.0 → 2.175.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.
- package/dist/cjs/.tsbuildinfo +1 -1
- package/dist/cjs/compiler/compileLightdashModels.d.ts +11 -0
- package/dist/cjs/compiler/compileLightdashModels.d.ts.map +1 -0
- package/dist/cjs/compiler/compileLightdashModels.js +8 -0
- package/dist/cjs/compiler/compileLightdashModels.js.map +1 -0
- package/dist/cjs/compiler/lightdashModelConverter.d.ts +1 -1
- package/dist/cjs/compiler/lightdashModelConverter.d.ts.map +1 -1
- package/dist/cjs/compiler/lightdashModelConverter.js +4 -4
- package/dist/cjs/compiler/lightdashModelConverter.js.map +1 -1
- package/dist/cjs/ee/AiAgent/schemas/tools/toolDefinitions.js +1 -1
- package/dist/cjs/ee/AiAgent/schemas/tools/toolDefinitions.js.map +1 -1
- package/dist/cjs/ee/AiAgent/schemas/tools/toolEditDbtProjectArgs.js +5 -5
- package/dist/cjs/ee/AiAgent/schemas/tools/toolEditDbtProjectArgs.js.map +1 -1
- package/dist/cjs/index.d.ts +3 -0
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +3 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/lightdash/LightdashModelEditor.d.ts +23 -0
- package/dist/cjs/lightdash/LightdashModelEditor.d.ts.map +1 -0
- package/dist/cjs/lightdash/LightdashModelEditor.js +168 -0
- package/dist/cjs/lightdash/LightdashModelEditor.js.map +1 -0
- package/dist/cjs/lightdash/LightdashModelEditor.test.d.ts +2 -0
- package/dist/cjs/lightdash/LightdashModelEditor.test.d.ts.map +1 -0
- package/dist/cjs/lightdash/LightdashModelEditor.test.js +195 -0
- package/dist/cjs/lightdash/LightdashModelEditor.test.js.map +1 -0
- package/dist/cjs/lightdash/convertCustomMetricToLightdash.d.ts +4 -0
- package/dist/cjs/lightdash/convertCustomMetricToLightdash.d.ts.map +1 -0
- package/dist/cjs/lightdash/convertCustomMetricToLightdash.js +37 -0
- package/dist/cjs/lightdash/convertCustomMetricToLightdash.js.map +1 -0
- package/dist/cjs/lightdash/loader.d.ts +5 -0
- package/dist/cjs/lightdash/loader.d.ts.map +1 -0
- package/dist/cjs/lightdash/loader.js +100 -0
- package/dist/cjs/lightdash/loader.js.map +1 -0
- package/dist/cjs/lightdash/loader.test.d.ts +2 -0
- package/dist/cjs/lightdash/loader.test.d.ts.map +1 -0
- package/dist/cjs/lightdash/loader.test.js +75 -0
- package/dist/cjs/lightdash/loader.test.js.map +1 -0
- package/dist/cjs/packageExports.test.js +1 -0
- package/dist/cjs/packageExports.test.js.map +1 -1
- package/dist/cjs/schemas/json/model-as-code-1.0.json +1 -1
- package/dist/cjs/types/lightdashModel.d.ts +4 -0
- package/dist/cjs/types/lightdashModel.d.ts.map +1 -1
- package/dist/cjs/types/projects.d.ts +2 -0
- package/dist/cjs/types/projects.d.ts.map +1 -1
- package/dist/cjs/types/projects.js.map +1 -1
- package/dist/cjs/utils/convertCustomDimensionsToYaml.d.ts +1 -1
- package/dist/cjs/utils/convertCustomDimensionsToYaml.d.ts.map +1 -1
- package/dist/cjs/utils/convertCustomDimensionsToYaml.js +1 -1
- package/dist/cjs/utils/convertCustomDimensionsToYaml.js.map +1 -1
- package/dist/esm/.tsbuildinfo +1 -1
- package/dist/esm/authorization/roleToScopeMapping.testUtils.d.ts +98 -98
- package/dist/esm/compiler/compileLightdashModels.d.ts +11 -0
- package/dist/esm/compiler/compileLightdashModels.d.ts.map +1 -0
- package/dist/esm/compiler/compileLightdashModels.js +4 -0
- package/dist/esm/compiler/compileLightdashModels.js.map +1 -0
- package/dist/esm/compiler/lightdashModelConverter.d.ts +1 -1
- package/dist/esm/compiler/lightdashModelConverter.d.ts.map +1 -1
- package/dist/esm/compiler/lightdashModelConverter.js +4 -4
- package/dist/esm/compiler/lightdashModelConverter.js.map +1 -1
- package/dist/esm/ee/AiAgent/schemas/tools/toolDefinitions.js +1 -1
- package/dist/esm/ee/AiAgent/schemas/tools/toolDefinitions.js.map +1 -1
- package/dist/esm/ee/AiAgent/schemas/tools/toolEditDbtProjectArgs.js +5 -5
- package/dist/esm/ee/AiAgent/schemas/tools/toolEditDbtProjectArgs.js.map +1 -1
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +3 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/lightdash/LightdashModelEditor.d.ts +23 -0
- package/dist/esm/lightdash/LightdashModelEditor.d.ts.map +1 -0
- package/dist/esm/lightdash/LightdashModelEditor.js +163 -0
- package/dist/esm/lightdash/LightdashModelEditor.js.map +1 -0
- package/dist/esm/lightdash/LightdashModelEditor.test.d.ts +2 -0
- package/dist/esm/lightdash/LightdashModelEditor.test.d.ts.map +1 -0
- package/dist/esm/lightdash/LightdashModelEditor.test.js +193 -0
- package/dist/esm/lightdash/LightdashModelEditor.test.js.map +1 -0
- package/dist/esm/lightdash/convertCustomMetricToLightdash.d.ts +4 -0
- package/dist/esm/lightdash/convertCustomMetricToLightdash.d.ts.map +1 -0
- package/dist/esm/lightdash/convertCustomMetricToLightdash.js +33 -0
- package/dist/esm/lightdash/convertCustomMetricToLightdash.js.map +1 -0
- package/dist/esm/lightdash/loader.d.ts +5 -0
- package/dist/esm/lightdash/loader.d.ts.map +1 -0
- package/dist/esm/lightdash/loader.js +94 -0
- package/dist/esm/lightdash/loader.js.map +1 -0
- package/dist/esm/lightdash/loader.test.d.ts +2 -0
- package/dist/esm/lightdash/loader.test.d.ts.map +1 -0
- package/dist/esm/lightdash/loader.test.js +72 -0
- package/dist/esm/lightdash/loader.test.js.map +1 -0
- package/dist/esm/packageExports.test.js +1 -0
- package/dist/esm/packageExports.test.js.map +1 -1
- package/dist/esm/schemas/json/model-as-code-1.0.json +1 -1
- package/dist/esm/types/lightdashModel.d.ts +4 -0
- package/dist/esm/types/lightdashModel.d.ts.map +1 -1
- package/dist/esm/types/projects.d.ts +2 -0
- package/dist/esm/types/projects.d.ts.map +1 -1
- package/dist/esm/types/projects.js.map +1 -1
- package/dist/esm/utils/convertCustomDimensionsToYaml.d.ts +1 -1
- package/dist/esm/utils/convertCustomDimensionsToYaml.d.ts.map +1 -1
- package/dist/esm/utils/convertCustomDimensionsToYaml.js +1 -1
- package/dist/esm/utils/convertCustomDimensionsToYaml.js.map +1 -1
- package/dist/types/.tsbuildinfo +1 -1
- package/dist/types/authorization/roleToScopeMapping.testUtils.d.ts +98 -98
- package/dist/types/compiler/compileLightdashModels.d.ts +11 -0
- package/dist/types/compiler/compileLightdashModels.d.ts.map +1 -0
- package/dist/types/compiler/compileLightdashModels.js +4 -0
- package/dist/types/compiler/compileLightdashModels.js.map +1 -0
- package/dist/types/compiler/lightdashModelConverter.d.ts +1 -1
- package/dist/types/compiler/lightdashModelConverter.d.ts.map +1 -1
- package/dist/types/compiler/lightdashModelConverter.js +4 -4
- package/dist/types/compiler/lightdashModelConverter.js.map +1 -1
- package/dist/types/ee/AiAgent/schemas/tools/toolDefinitions.js +1 -1
- package/dist/types/ee/AiAgent/schemas/tools/toolDefinitions.js.map +1 -1
- package/dist/types/ee/AiAgent/schemas/tools/toolEditDbtProjectArgs.js +5 -5
- package/dist/types/ee/AiAgent/schemas/tools/toolEditDbtProjectArgs.js.map +1 -1
- package/dist/types/index.d.ts +3 -0
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +3 -0
- package/dist/types/index.js.map +1 -1
- package/dist/types/lightdash/LightdashModelEditor.d.ts +23 -0
- package/dist/types/lightdash/LightdashModelEditor.d.ts.map +1 -0
- package/dist/types/lightdash/LightdashModelEditor.js +163 -0
- package/dist/types/lightdash/LightdashModelEditor.js.map +1 -0
- package/dist/types/lightdash/LightdashModelEditor.test.d.ts +2 -0
- package/dist/types/lightdash/LightdashModelEditor.test.d.ts.map +1 -0
- package/dist/types/lightdash/LightdashModelEditor.test.js +193 -0
- package/dist/types/lightdash/LightdashModelEditor.test.js.map +1 -0
- package/dist/types/lightdash/convertCustomMetricToLightdash.d.ts +4 -0
- package/dist/types/lightdash/convertCustomMetricToLightdash.d.ts.map +1 -0
- package/dist/types/lightdash/convertCustomMetricToLightdash.js +33 -0
- package/dist/types/lightdash/convertCustomMetricToLightdash.js.map +1 -0
- package/dist/types/lightdash/loader.d.ts +5 -0
- package/dist/types/lightdash/loader.d.ts.map +1 -0
- package/dist/types/lightdash/loader.js +94 -0
- package/dist/types/lightdash/loader.js.map +1 -0
- package/dist/types/lightdash/loader.test.d.ts +2 -0
- package/dist/types/lightdash/loader.test.d.ts.map +1 -0
- package/dist/types/lightdash/loader.test.js +72 -0
- package/dist/types/lightdash/loader.test.js.map +1 -0
- package/dist/types/packageExports.test.js +1 -0
- package/dist/types/packageExports.test.js.map +1 -1
- package/dist/types/schemas/json/model-as-code-1.0.json +1 -1
- package/dist/types/types/lightdashModel.d.ts +4 -0
- package/dist/types/types/lightdashModel.d.ts.map +1 -1
- package/dist/types/types/projects.d.ts +2 -0
- package/dist/types/types/projects.d.ts.map +1 -1
- package/dist/types/types/projects.js.map +1 -1
- package/dist/types/utils/convertCustomDimensionsToYaml.d.ts +1 -1
- package/dist/types/utils/convertCustomDimensionsToYaml.d.ts.map +1 -1
- package/dist/types/utils/convertCustomDimensionsToYaml.js +1 -1
- package/dist/types/utils/convertCustomDimensionsToYaml.js.map +1 -1
- package/package.json +8 -1
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.LightdashModelEditor = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const ajv_1 = tslib_1.__importDefault(require("ajv"));
|
|
6
|
+
const yaml_1 = require("yaml");
|
|
7
|
+
const model_as_code_1_0_json_1 = tslib_1.__importDefault(require("../schemas/json/model-as-code-1.0.json"));
|
|
8
|
+
const errors_1 = require("../types/errors");
|
|
9
|
+
const field_1 = require("../types/field");
|
|
10
|
+
const convertCustomDimensionsToYaml_1 = require("../utils/convertCustomDimensionsToYaml");
|
|
11
|
+
const convertCustomMetricToLightdash_1 = require("./convertCustomMetricToLightdash");
|
|
12
|
+
const ajv = new ajv_1.default({ allErrors: true, strict: false });
|
|
13
|
+
const validate = ajv.compile(model_as_code_1_0_json_1.default);
|
|
14
|
+
/** Edits the original native model document, preserving comments and unrelated nodes. */
|
|
15
|
+
class LightdashModelEditor {
|
|
16
|
+
constructor(contents, filename) {
|
|
17
|
+
this.contents = contents;
|
|
18
|
+
this.filename = filename;
|
|
19
|
+
this.changedDimensions = new Set();
|
|
20
|
+
this.newDimensions = [];
|
|
21
|
+
this.doc = (0, yaml_1.parseDocument)(contents);
|
|
22
|
+
this.validate();
|
|
23
|
+
}
|
|
24
|
+
validate() {
|
|
25
|
+
const model = this.doc.toJS();
|
|
26
|
+
if (this.doc.errors.length > 0 || !validate(model)) {
|
|
27
|
+
throw new errors_1.ParseError(`Invalid Lightdash model in ${this.filename}: ${this.doc.errors.map((error) => error.message).join('; ') || ajv.errorsText(validate.errors)}`);
|
|
28
|
+
}
|
|
29
|
+
return model;
|
|
30
|
+
}
|
|
31
|
+
assertModelName(name) {
|
|
32
|
+
if (this.doc.get('name') !== name) {
|
|
33
|
+
throw new errors_1.ParameterError(`Model ${name} no longer matches ${this.filename}. Refresh the project before writing back.`);
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
assertFieldDoesNotExist(name) {
|
|
37
|
+
const model = this.validate();
|
|
38
|
+
const names = [
|
|
39
|
+
...Object.keys(model.metrics ?? {}),
|
|
40
|
+
...model.dimensions.flatMap((dimension) => [
|
|
41
|
+
dimension.name,
|
|
42
|
+
...Object.keys(dimension.metrics ?? {}),
|
|
43
|
+
...Object.keys(dimension.additional_dimensions ?? {}),
|
|
44
|
+
]),
|
|
45
|
+
];
|
|
46
|
+
if (names.some((existing) => existing.toLowerCase() === name.toLowerCase())) {
|
|
47
|
+
throw new errors_1.ParameterError(`Field ${name} already exists in ${this.filename}. Choose a different name to preserve the existing definition.`);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
addCustomMetrics(metrics) {
|
|
51
|
+
metrics.forEach((metric) => {
|
|
52
|
+
this.assertModelName(metric.table);
|
|
53
|
+
this.assertFieldDoesNotExist(metric.name);
|
|
54
|
+
const definition = (0, convertCustomMetricToLightdash_1.convertCustomMetricToLightdash)(metric);
|
|
55
|
+
const dimensions = this.doc.get('dimensions');
|
|
56
|
+
const dimension = (0, yaml_1.isSeq)(dimensions)
|
|
57
|
+
? dimensions.items.find((item) => (0, yaml_1.isMap)(item) &&
|
|
58
|
+
item.get('name') === metric.baseDimensionName)
|
|
59
|
+
: undefined;
|
|
60
|
+
if (!(0, yaml_1.isMap)(dimension)) {
|
|
61
|
+
throw new errors_1.ParameterError(`Native dimension ${metric.baseDimensionName} not found in ${this.filename}. Refresh the project before writing back.`);
|
|
62
|
+
}
|
|
63
|
+
dimension.setIn(['metrics', metric.name], definition);
|
|
64
|
+
this.changedDimensions.add(dimension);
|
|
65
|
+
});
|
|
66
|
+
this.validate();
|
|
67
|
+
return this;
|
|
68
|
+
}
|
|
69
|
+
getCustomDimensionDefinition(dimension, warehouseSqlBuilder) {
|
|
70
|
+
this.assertModelName(dimension.table);
|
|
71
|
+
this.assertFieldDoesNotExist(dimension.id);
|
|
72
|
+
const error = (0, convertCustomDimensionsToYaml_1.getCustomDimensionWriteBackError)(dimension);
|
|
73
|
+
if (error)
|
|
74
|
+
throw new errors_1.ParameterError(error);
|
|
75
|
+
if ((0, field_1.isCustomSqlDimension)(dimension)) {
|
|
76
|
+
return {
|
|
77
|
+
name: dimension.id,
|
|
78
|
+
label: (0, field_1.friendlyName)(dimension.name),
|
|
79
|
+
type: dimension.dimensionType,
|
|
80
|
+
sql: dimension.sql,
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
const model = this.validate();
|
|
84
|
+
const prefix = `${dimension.table}_`;
|
|
85
|
+
const baseName = dimension.dimensionId.startsWith(prefix)
|
|
86
|
+
? dimension.dimensionId.slice(prefix.length)
|
|
87
|
+
: dimension.dimensionId;
|
|
88
|
+
const base = model.dimensions.find((item) => item.name === baseName);
|
|
89
|
+
if (!base) {
|
|
90
|
+
throw new errors_1.ParameterError(`Native dimension ${baseName} not found in ${this.filename}. Refresh the project before writing back.`);
|
|
91
|
+
}
|
|
92
|
+
const definition = (0, convertCustomDimensionsToYaml_1.convertCustomBinDimensionToDbt)({
|
|
93
|
+
customDimension: dimension,
|
|
94
|
+
baseDimensionSql: base.sql,
|
|
95
|
+
warehouseSqlBuilder,
|
|
96
|
+
});
|
|
97
|
+
return {
|
|
98
|
+
...definition,
|
|
99
|
+
name: dimension.id,
|
|
100
|
+
type: field_1.DimensionType.STRING,
|
|
101
|
+
sql: definition.sql,
|
|
102
|
+
};
|
|
103
|
+
}
|
|
104
|
+
addCustomDimensions(dimensions, warehouseSqlBuilder) {
|
|
105
|
+
dimensions.forEach((dimension) => {
|
|
106
|
+
const definition = this.getCustomDimensionDefinition(dimension, warehouseSqlBuilder);
|
|
107
|
+
this.doc.addIn(['dimensions'], definition);
|
|
108
|
+
this.newDimensions.push(definition);
|
|
109
|
+
});
|
|
110
|
+
this.validate();
|
|
111
|
+
return this;
|
|
112
|
+
}
|
|
113
|
+
toString(options) {
|
|
114
|
+
// Replace only changed dimension nodes. Serializing the whole document
|
|
115
|
+
// would reindent every list and reflow unrelated model SQL/descriptions.
|
|
116
|
+
let result = this.contents;
|
|
117
|
+
const changes = [];
|
|
118
|
+
for (const node of this.changedDimensions) {
|
|
119
|
+
const [start, , end] = node.range;
|
|
120
|
+
const lineStart = this.contents.lastIndexOf('\n', start - 1) + 1;
|
|
121
|
+
const prefix = this.contents.slice(lineStart, start);
|
|
122
|
+
if (!/^ *-? *$/.test(prefix) || node.flow) {
|
|
123
|
+
throw new errors_1.ParameterError(`Native write-back requires block-style dimensions in ${this.filename}. Expand flow-style YAML before writing back.`);
|
|
124
|
+
}
|
|
125
|
+
const clone = node.clone();
|
|
126
|
+
// A leading comment lies before range[0] and remains in the source.
|
|
127
|
+
clone.commentBefore = undefined;
|
|
128
|
+
const text = new yaml_1.Document(clone)
|
|
129
|
+
.toString({
|
|
130
|
+
singleQuote: options?.quoteChar === "'" ? true : null,
|
|
131
|
+
lineWidth: 0,
|
|
132
|
+
})
|
|
133
|
+
.trimEnd()
|
|
134
|
+
.split('\n')
|
|
135
|
+
.join(`\n${' '.repeat(prefix.length)}`);
|
|
136
|
+
changes.push({ start, end, text: `${text}\n` });
|
|
137
|
+
}
|
|
138
|
+
if (this.newDimensions.length > 0) {
|
|
139
|
+
const dimensions = this.doc.get('dimensions');
|
|
140
|
+
if (!(0, yaml_1.isSeq)(dimensions) || dimensions.flow || !dimensions.range) {
|
|
141
|
+
throw new errors_1.ParameterError(`Native write-back requires block-style dimensions in ${this.filename}. Expand flow-style YAML before writing back.`);
|
|
142
|
+
}
|
|
143
|
+
const [start, end] = dimensions.range;
|
|
144
|
+
const lineStart = this.contents.lastIndexOf('\n', start - 1) + 1;
|
|
145
|
+
const indent = ' '.repeat(start - lineStart);
|
|
146
|
+
const text = new yaml_1.Document(this.newDimensions)
|
|
147
|
+
.toString({
|
|
148
|
+
singleQuote: options?.quoteChar === "'" ? true : null,
|
|
149
|
+
lineWidth: 0,
|
|
150
|
+
})
|
|
151
|
+
.trimEnd()
|
|
152
|
+
.split('\n')
|
|
153
|
+
.map((line) => indent + line)
|
|
154
|
+
.join('\n');
|
|
155
|
+
changes.push({
|
|
156
|
+
start: end,
|
|
157
|
+
end,
|
|
158
|
+
text: `${this.contents[end - 1] === '\n' ? '' : '\n'}${text}\n`,
|
|
159
|
+
});
|
|
160
|
+
}
|
|
161
|
+
for (const { start, end, text } of changes.sort((a, b) => b.start - a.start)) {
|
|
162
|
+
result = result.slice(0, start) + text + result.slice(end);
|
|
163
|
+
}
|
|
164
|
+
return result;
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
exports.LightdashModelEditor = LightdashModelEditor;
|
|
168
|
+
//# sourceMappingURL=LightdashModelEditor.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"LightdashModelEditor.js","sourceRoot":"","sources":["../../../src/lightdash/LightdashModelEditor.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,+BAA2E;AAC3E,4GAAiE;AACjE,4CAA6D;AAC7D,0CAKwB;AAOxB,0FAGgD;AAChD,qFAAkF;AAElF,MAAM,GAAG,GAAG,IAAI,aAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;AACxD,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAiB,gCAAW,CAAC,CAAC;AAE1D,yFAAyF;AACzF;IAOI,YACqB,QAAgB,EAChB,QAAgB;QADhB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,aAAQ,GAAR,QAAQ,CAAQ;QANpB,sBAAiB,GAAG,IAAI,GAAG,EAAW,CAAC;QAEvC,kBAAa,GAA8B,EAAE,CAAC;QAM3D,IAAI,CAAC,GAAG,GAAG,IAAA,oBAAa,EAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,CAAC,QAAQ,EAAE,CAAC;IACpB,CAAC;IAEO,QAAQ;QACZ,MAAM,KAAK,GAAY,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACvC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,mBAAU,CAChB,8BAA8B,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAChJ,CAAC;QACN,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAEO,eAAe,CAAC,IAAY;QAChC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;YAChC,MAAM,IAAI,uBAAc,CACpB,SAAS,IAAI,sBAAsB,IAAI,CAAC,QAAQ,4CAA4C,CAC/F,CAAC;QACN,CAAC;IACL,CAAC;IAEO,uBAAuB,CAAC,IAAY;QACxC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG;YACV,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;YACnC,GAAG,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvC,SAAS,CAAC,IAAI;gBACd,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,IAAI,EAAE,CAAC;gBACvC,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,qBAAqB,IAAI,EAAE,CAAC;aACxD,CAAC;SACL,CAAC;QACF,IACI,KAAK,CAAC,IAAI,CACN,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAC9D,EACH,CAAC;YACC,MAAM,IAAI,uBAAc,CACpB,SAAS,IAAI,sBAAsB,IAAI,CAAC,QAAQ,gEAAgE,CACnH,CAAC;QACN,CAAC;IACL,CAAC;IAED,gBAAgB,CAAC,OAA2B;QACxC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACvB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC1C,MAAM,UAAU,GAAG,IAAA,+DAA8B,EAAC,MAAM,CAAC,CAAC;YAC1D,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC9C,MAAM,SAAS,GAAG,IAAA,YAAK,EAAC,UAAU,CAAC;gBAC/B,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CACjB,CAAC,IAAI,EAAE,EAAE,CACL,IAAA,YAAK,EAAC,IAAI,CAAC;oBACX,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,iBAAiB,CACpD;gBACH,CAAC,CAAC,SAAS,CAAC;YAChB,IAAI,CAAC,IAAA,YAAK,EAAC,SAAS,CAAC,EAAE,CAAC;gBACpB,MAAM,IAAI,uBAAc,CACpB,oBAAoB,MAAM,CAAC,iBAAiB,iBAAiB,IAAI,CAAC,QAAQ,4CAA4C,CACzH,CAAC;YACN,CAAC;YACD,SAAS,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,CAAC;YACtD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,4BAA4B,CACxB,SAA0B,EAC1B,mBAAwC;QAExC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC3C,MAAM,KAAK,GAAG,IAAA,gEAAgC,EAAC,SAAS,CAAC,CAAC;QAC1D,IAAI,KAAK;YAAE,MAAM,IAAI,uBAAc,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,IAAA,4BAAoB,EAAC,SAAS,CAAC,EAAE,CAAC;YAClC,OAAO;gBACH,IAAI,EAAE,SAAS,CAAC,EAAE;gBAClB,KAAK,EAAE,IAAA,oBAAY,EAAC,SAAS,CAAC,IAAI,CAAC;gBACnC,IAAI,EAAE,SAAS,CAAC,aAAa;gBAC7B,GAAG,EAAE,SAAS,CAAC,GAAG;aACrB,CAAC;QACN,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,GAAG,CAAC;QACrC,MAAM,QAAQ,GAAG,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC;YACrD,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;YAC5C,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC;QAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;QACrE,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,MAAM,IAAI,uBAAc,CACpB,oBAAoB,QAAQ,iBAAiB,IAAI,CAAC,QAAQ,4CAA4C,CACzG,CAAC;QACN,CAAC;QACD,MAAM,UAAU,GAAG,IAAA,8DAA8B,EAAC;YAC9C,eAAe,EAAE,SAAS;YAC1B,gBAAgB,EAAE,IAAI,CAAC,GAAG;YAC1B,mBAAmB;SACtB,CAAC,CAAC;QACH,OAAO;YACH,GAAG,UAAU;YACb,IAAI,EAAE,SAAS,CAAC,EAAE;YAClB,IAAI,EAAE,qBAAa,CAAC,MAAM;YAC1B,GAAG,EAAE,UAAU,CAAC,GAAI;SACvB,CAAC;IACN,CAAC;IAED,mBAAmB,CACf,UAA6B,EAC7B,mBAAwC;QAExC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC7B,MAAM,UAAU,GAAG,IAAI,CAAC,4BAA4B,CAChD,SAAS,EACT,mBAAmB,CACtB,CAAC;YACF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,EAAE,UAAU,CAAC,CAAC;YAC3C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,QAAQ,CAAC,OAAmC;QACxC,uEAAuE;QACvE,yEAAyE;QACzE,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC3B,MAAM,OAAO,GAAmD,EAAE,CAAC;QACnE,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACxC,MAAM,CAAC,KAAK,EAAE,AAAD,EAAG,GAAG,CAAC,GAAG,IAAI,CAAC,KAAM,CAAC;YACnC,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACjE,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACrD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACxC,MAAM,IAAI,uBAAc,CACpB,wDAAwD,IAAI,CAAC,QAAQ,+CAA+C,CACvH,CAAC;YACN,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;YAC3B,oEAAoE;YACpE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YAChC,MAAM,IAAI,GAAG,IAAI,eAAQ,CAAC,KAAK,CAAC;iBAC3B,QAAQ,CAAC;gBACN,WAAW,EAAE,OAAO,EAAE,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI;gBACrD,SAAS,EAAE,CAAC;aACf,CAAC;iBACD,OAAO,EAAE;iBACT,KAAK,CAAC,IAAI,CAAC;iBACX,IAAI,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC5C,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC9C,IAAI,CAAC,IAAA,YAAK,EAAC,UAAU,CAAC,IAAI,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;gBAC7D,MAAM,IAAI,uBAAc,CACpB,wDAAwD,IAAI,CAAC,QAAQ,+CAA+C,CACvH,CAAC;YACN,CAAC;YACD,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC;YACtC,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACjE,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;YAC7C,MAAM,IAAI,GAAG,IAAI,eAAQ,CAAC,IAAI,CAAC,aAAa,CAAC;iBACxC,QAAQ,CAAC;gBACN,WAAW,EAAE,OAAO,EAAE,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI;gBACrD,SAAS,EAAE,CAAC;aACf,CAAC;iBACD,OAAO,EAAE;iBACT,KAAK,CAAC,IAAI,CAAC;iBACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,GAAG,IAAI,CAAC;iBAC5B,IAAI,CAAC,IAAI,CAAC,CAAC;YAChB,OAAO,CAAC,IAAI,CAAC;gBACT,KAAK,EAAE,GAAG;gBACV,GAAG;gBACH,IAAI,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,IAAI;aAClE,CAAC,CAAC;QACP,CAAC;QACD,KAAK,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,OAAO,CAAC,IAAI,CAC3C,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAC9B,EAAE,CAAC;YACA,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"LightdashModelEditor.test.d.ts","sourceRoot":"","sources":["../../../src/lightdash/LightdashModelEditor.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const yaml_1 = require("yaml");
|
|
4
|
+
const compileLightdashModels_1 = require("../compiler/compileLightdashModels");
|
|
5
|
+
const exploreCompiler_mock_1 = require("../compiler/exploreCompiler.mock");
|
|
6
|
+
const explore_1 = require("../types/explore");
|
|
7
|
+
const field_1 = require("../types/field");
|
|
8
|
+
const filter_1 = require("../types/filter");
|
|
9
|
+
const lightdashProjectConfig_1 = require("../types/lightdashProjectConfig");
|
|
10
|
+
const LightdashModelEditor_1 = require("./LightdashModelEditor");
|
|
11
|
+
const source = `# Keep this model comment
|
|
12
|
+
type: model
|
|
13
|
+
name: orders
|
|
14
|
+
sql_from: public.orders
|
|
15
|
+
metrics:
|
|
16
|
+
existing_count: # Keep this metric comment
|
|
17
|
+
type: count
|
|
18
|
+
sql: '1'
|
|
19
|
+
dimensions:
|
|
20
|
+
- name: amount
|
|
21
|
+
type: number
|
|
22
|
+
sql: \${TABLE}.amount * 2 # Keep the original expression
|
|
23
|
+
- name: status
|
|
24
|
+
type: string
|
|
25
|
+
sql: \${TABLE}.status
|
|
26
|
+
`;
|
|
27
|
+
const metric = {
|
|
28
|
+
name: 'paid_revenue',
|
|
29
|
+
label: 'Paid Revenue',
|
|
30
|
+
description: 'Revenue for paid orders',
|
|
31
|
+
table: 'orders',
|
|
32
|
+
baseDimensionName: 'amount',
|
|
33
|
+
sql: '${TABLE}.amount * 2',
|
|
34
|
+
type: field_1.MetricType.SUM,
|
|
35
|
+
filters: [
|
|
36
|
+
{
|
|
37
|
+
id: 'paid',
|
|
38
|
+
target: { fieldRef: 'orders.status' },
|
|
39
|
+
operator: filter_1.FilterOperator.EQUALS,
|
|
40
|
+
values: ['paid'],
|
|
41
|
+
},
|
|
42
|
+
],
|
|
43
|
+
};
|
|
44
|
+
describe('native model write-back', () => {
|
|
45
|
+
it('preserves existing YAML and compiles the metric with its SQL, filters and base dimension identity', async () => {
|
|
46
|
+
const output = new LightdashModelEditor_1.LightdashModelEditor(source, 'models/nested/sales.yaml')
|
|
47
|
+
.addCustomMetrics([metric])
|
|
48
|
+
.toString();
|
|
49
|
+
expect(output.split('dimensions:')[0]).toBe(source.split('dimensions:')[0]);
|
|
50
|
+
expect(output).toContain('# Keep this model comment');
|
|
51
|
+
expect(output).toContain('# Keep this metric comment');
|
|
52
|
+
expect(output).toContain('# Keep the original expression');
|
|
53
|
+
const original = (0, yaml_1.parse)(source);
|
|
54
|
+
const updated = (0, yaml_1.parse)(output);
|
|
55
|
+
expect(updated.metrics).toEqual(original.metrics);
|
|
56
|
+
expect(updated.dimensions[1]).toEqual(original.dimensions[1]);
|
|
57
|
+
expect(updated).not.toHaveProperty('models');
|
|
58
|
+
const [explore] = await (0, compileLightdashModels_1.compileLightdashModels)({
|
|
59
|
+
models: [{ ...updated, sourcePath: 'models/nested/sales.yaml' }],
|
|
60
|
+
warehouseSqlBuilder: exploreCompiler_mock_1.warehouseClientMock,
|
|
61
|
+
lightdashProjectConfig: { spotlight: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG },
|
|
62
|
+
});
|
|
63
|
+
if (!explore || (0, explore_1.isExploreError)(explore))
|
|
64
|
+
throw new Error('Expected compiled native explore');
|
|
65
|
+
expect(explore.tables.orders.metrics.paid_revenue).toMatchObject({
|
|
66
|
+
label: metric.label,
|
|
67
|
+
description: metric.description,
|
|
68
|
+
type: field_1.MetricType.SUM,
|
|
69
|
+
sql: metric.sql,
|
|
70
|
+
dimensionReference: 'orders_amount',
|
|
71
|
+
filters: [
|
|
72
|
+
expect.objectContaining({
|
|
73
|
+
target: { fieldRef: 'status' },
|
|
74
|
+
values: ['paid'],
|
|
75
|
+
}),
|
|
76
|
+
],
|
|
77
|
+
});
|
|
78
|
+
expect(explore.ymlPath).toBe('models/nested/sales.yaml');
|
|
79
|
+
});
|
|
80
|
+
it.each([
|
|
81
|
+
{ ...metric, name: 'existing_count' },
|
|
82
|
+
{ ...metric, name: 'status' },
|
|
83
|
+
{ ...metric, table: 'renamed_orders' },
|
|
84
|
+
{ ...metric, baseDimensionName: 'missing' },
|
|
85
|
+
{ ...metric, generationType: 'periodOverPeriod' },
|
|
86
|
+
{ ...metric, baseDimensionName: undefined },
|
|
87
|
+
])('rejects collisions, stale sources and unsupported metric definitions ($name)', (field) => {
|
|
88
|
+
expect(() => new LightdashModelEditor_1.LightdashModelEditor(source, 'models/orders.yml').addCustomMetrics([field])).toThrow();
|
|
89
|
+
});
|
|
90
|
+
const customDimensions = [
|
|
91
|
+
{
|
|
92
|
+
id: 'amount_times_ten',
|
|
93
|
+
name: 'Amount times ten',
|
|
94
|
+
table: 'orders',
|
|
95
|
+
type: field_1.CustomDimensionType.SQL,
|
|
96
|
+
dimensionType: field_1.DimensionType.NUMBER,
|
|
97
|
+
sql: '${orders.amount} * 10',
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
id: 'amount_band',
|
|
101
|
+
name: 'Amount band',
|
|
102
|
+
table: 'orders',
|
|
103
|
+
type: field_1.CustomDimensionType.BIN,
|
|
104
|
+
dimensionId: 'orders_amount',
|
|
105
|
+
binType: field_1.BinType.FIXED_WIDTH,
|
|
106
|
+
binWidth: 10,
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
id: 'amount_range',
|
|
110
|
+
name: 'Amount range',
|
|
111
|
+
table: 'orders',
|
|
112
|
+
type: field_1.CustomDimensionType.BIN,
|
|
113
|
+
dimensionId: 'orders_amount',
|
|
114
|
+
binType: field_1.BinType.CUSTOM_RANGE,
|
|
115
|
+
customRange: [
|
|
116
|
+
{ from: undefined, to: 10 },
|
|
117
|
+
{ from: 10, to: undefined },
|
|
118
|
+
],
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
id: 'amount_group',
|
|
122
|
+
name: 'Amount group',
|
|
123
|
+
table: 'orders',
|
|
124
|
+
type: field_1.CustomDimensionType.BIN,
|
|
125
|
+
dimensionId: 'orders_amount',
|
|
126
|
+
binType: field_1.BinType.CUSTOM_GROUP,
|
|
127
|
+
customGroups: [
|
|
128
|
+
{
|
|
129
|
+
name: 'Twenty',
|
|
130
|
+
values: [
|
|
131
|
+
{ matchType: field_1.GroupValueMatchType.EXACT, value: '20' },
|
|
132
|
+
],
|
|
133
|
+
},
|
|
134
|
+
],
|
|
135
|
+
},
|
|
136
|
+
];
|
|
137
|
+
it.each(customDimensions)('appends and compiles native $id while preserving the original document', async (dimension) => {
|
|
138
|
+
const output = new LightdashModelEditor_1.LightdashModelEditor(source, 'models/orders.yml')
|
|
139
|
+
.addCustomDimensions([dimension], exploreCompiler_mock_1.warehouseClientMock)
|
|
140
|
+
.toString();
|
|
141
|
+
expect(output.startsWith(source)).toBe(true);
|
|
142
|
+
const model = (0, yaml_1.parse)(output);
|
|
143
|
+
const added = model.dimensions.at(-1);
|
|
144
|
+
expect(added.name).toBe(dimension.id);
|
|
145
|
+
expect(added.sql).toContain(dimension.type === field_1.CustomDimensionType.SQL
|
|
146
|
+
? '${orders.amount}'
|
|
147
|
+
: '${TABLE}.amount * 2');
|
|
148
|
+
expect(model).not.toHaveProperty('models');
|
|
149
|
+
const [explore] = await (0, compileLightdashModels_1.compileLightdashModels)({
|
|
150
|
+
models: [{ ...model, sourcePath: 'models/orders.yml' }],
|
|
151
|
+
warehouseSqlBuilder: exploreCompiler_mock_1.warehouseClientMock,
|
|
152
|
+
lightdashProjectConfig: { spotlight: lightdashProjectConfig_1.DEFAULT_SPOTLIGHT_CONFIG },
|
|
153
|
+
});
|
|
154
|
+
if (!explore || (0, explore_1.isExploreError)(explore))
|
|
155
|
+
throw new Error('Expected compiled native explore');
|
|
156
|
+
expect(explore.tables.orders.dimensions[dimension.id].compiledSql).toContain('amount');
|
|
157
|
+
});
|
|
158
|
+
it('keeps trailing model properties and comments when appending dimensions', () => {
|
|
159
|
+
const footer = '# Keep this root property\nprimary_key: amount\n';
|
|
160
|
+
const output = new LightdashModelEditor_1.LightdashModelEditor(source + footer, 'models/orders.yml')
|
|
161
|
+
.addCustomDimensions([customDimensions[0]], exploreCompiler_mock_1.warehouseClientMock)
|
|
162
|
+
.toString();
|
|
163
|
+
expect(output).toContain(footer);
|
|
164
|
+
expect((0, yaml_1.parse)(output).primary_key).toBe('amount');
|
|
165
|
+
expect((0, yaml_1.parse)(output).dimensions.at(-1).name).toBe('amount_times_ten');
|
|
166
|
+
});
|
|
167
|
+
it('rejects fixed-number bins instead of persisting query-dependent boundaries', () => {
|
|
168
|
+
expect(() => new LightdashModelEditor_1.LightdashModelEditor(source, 'models/orders.yml').addCustomDimensions([
|
|
169
|
+
{
|
|
170
|
+
id: 'unsupported',
|
|
171
|
+
name: 'Unsupported',
|
|
172
|
+
table: 'orders',
|
|
173
|
+
type: field_1.CustomDimensionType.BIN,
|
|
174
|
+
dimensionId: 'orders_amount',
|
|
175
|
+
binType: field_1.BinType.FIXED_NUMBER,
|
|
176
|
+
binNumber: 4,
|
|
177
|
+
},
|
|
178
|
+
], exploreCompiler_mock_1.warehouseClientMock)).toThrow('Fixed-number bins cannot be written back');
|
|
179
|
+
});
|
|
180
|
+
it('rejects filters that the YAML serializer would otherwise drop', () => {
|
|
181
|
+
expect(() => new LightdashModelEditor_1.LightdashModelEditor(source, 'models/orders.yml').addCustomMetrics([
|
|
182
|
+
{
|
|
183
|
+
...metric,
|
|
184
|
+
filters: [{ ...metric.filters[0], includeNull: true }],
|
|
185
|
+
},
|
|
186
|
+
])).toThrow('without changing its meaning');
|
|
187
|
+
});
|
|
188
|
+
it('rejects a second metric with the same name rather than overwriting the first', () => {
|
|
189
|
+
expect(() => new LightdashModelEditor_1.LightdashModelEditor(source, 'models/orders.yml').addCustomMetrics([
|
|
190
|
+
metric,
|
|
191
|
+
{ ...metric, label: 'Different meaning' },
|
|
192
|
+
])).toThrow('already exists');
|
|
193
|
+
});
|
|
194
|
+
});
|
|
195
|
+
//# sourceMappingURL=LightdashModelEditor.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"LightdashModelEditor.test.js","sourceRoot":"","sources":["../../../src/lightdash/LightdashModelEditor.test.ts"],"names":[],"mappings":";;AAAA,+BAA6B;AAC7B,+EAA4E;AAC5E,2EAAuE;AACvE,8CAAkD;AAClD,0CAOwB;AACxB,4CAAiD;AACjD,4EAA2E;AAE3E,iEAA8D;AAE9D,MAAM,MAAM,GAAG;;;;;;;;;;;;;;;CAed,CAAC;AACF,MAAM,MAAM,GAAqB;IAC7B,IAAI,EAAE,cAAc;IACpB,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,yBAAyB;IACtC,KAAK,EAAE,QAAQ;IACf,iBAAiB,EAAE,QAAQ;IAC3B,GAAG,EAAE,qBAAqB;IAC1B,IAAI,EAAE,kBAAU,CAAC,GAAG;IACpB,OAAO,EAAE;QACL;YACI,EAAE,EAAE,MAAM;YACV,MAAM,EAAE,EAAE,QAAQ,EAAE,eAAe,EAAE;YACrC,QAAQ,EAAE,uBAAc,CAAC,MAAM;YAC/B,MAAM,EAAE,CAAC,MAAM,CAAC;SACnB;KACJ;CACJ,CAAC;AAEF,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACrC,EAAE,CAAC,mGAAmG,EAAE,KAAK,IAAI,EAAE;QAC/G,MAAM,MAAM,GAAG,IAAI,2CAAoB,CACnC,MAAM,EACN,0BAA0B,CAC7B;aACI,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;aAC1B,QAAQ,EAAE,CAAC;QAChB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CACvC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CACjC,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;QACvD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAG,IAAA,YAAK,EAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,OAAO,GAAG,IAAA,YAAK,EAAC,MAAM,CAAC,CAAC;QAC9B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAClD,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,IAAA,+CAAsB,EAAC;YAC3C,MAAM,EAAE,CAAC,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,0BAA0B,EAAE,CAAC;YAChE,mBAAmB,EAAE,0CAAmB;YACxC,sBAAsB,EAAE,EAAE,SAAS,EAAE,iDAAwB,EAAE;SAClE,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,IAAI,IAAA,wBAAc,EAAC,OAAO,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACxD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC;YAC7D,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,IAAI,EAAE,kBAAU,CAAC,GAAG;YACpB,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,kBAAkB,EAAE,eAAe;YACnC,OAAO,EAAE;gBACL,MAAM,CAAC,gBAAgB,CAAC;oBACpB,MAAM,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE;oBAC9B,MAAM,EAAE,CAAC,MAAM,CAAC;iBACnB,CAAC;aACL;SACJ,CAAC,CAAC;QACH,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACJ,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE;QACrC,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7B,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE;QACtC,EAAE,GAAG,MAAM,EAAE,iBAAiB,EAAE,SAAS,EAAE;QAC3C,EAAE,GAAG,MAAM,EAAE,cAAc,EAAE,kBAA2B,EAAE;QAC1D,EAAE,GAAG,MAAM,EAAE,iBAAiB,EAAE,SAAS,EAAE;KAC9C,CAAC,CACE,8EAA8E,EAC9E,CAAC,KAAK,EAAE,EAAE;QACN,MAAM,CAAC,GAAG,EAAE,CACR,IAAI,2CAAoB,CACpB,MAAM,EACN,mBAAmB,CACtB,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC,CAC9B,CAAC,OAAO,EAAE,CAAC;IAChB,CAAC,CACJ,CAAC;IAEF,MAAM,gBAAgB,GAAsB;QACxC;YACI,EAAE,EAAE,kBAAkB;YACtB,IAAI,EAAE,kBAAkB;YACxB,KAAK,EAAE,QAAQ;YACf,IAAI,EAAE,2BAAmB,CAAC,GAAG;YAC7B,aAAa,EAAE,qBAAa,CAAC,MAAM;YACnC,GAAG,EAAE,uBAAuB;SAC/B;QACD;YACI,EAAE,EAAE,aAAa;YACjB,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE,QAAQ;YACf,IAAI,EAAE,2BAAmB,CAAC,GAAG;YAC7B,WAAW,EAAE,eAAe;YAC5B,OAAO,EAAE,eAAO,CAAC,WAAW;YAC5B,QAAQ,EAAE,EAAE;SACf;QACD;YACI,EAAE,EAAE,cAAc;YAClB,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,QAAQ;YACf,IAAI,EAAE,2BAAmB,CAAC,GAAG;YAC7B,WAAW,EAAE,eAAe;YAC5B,OAAO,EAAE,eAAO,CAAC,YAAY;YAC7B,WAAW,EAAE;gBACT,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE;gBAC3B,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE;aAC9B;SACJ;QACD;YACI,EAAE,EAAE,cAAc;YAClB,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,QAAQ;YACf,IAAI,EAAE,2BAAmB,CAAC,GAAG;YAC7B,WAAW,EAAE,eAAe;YAC5B,OAAO,EAAE,eAAO,CAAC,YAAY;YAC7B,YAAY,EAAE;gBACV;oBACI,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE;wBACJ,EAAE,SAAS,EAAE,2BAAmB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE;qBACxD;iBACJ;aACJ;SACJ;KACJ,CAAC;IAEF,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,CACrB,wEAAwE,EACxE,KAAK,EAAE,SAAS,EAAE,EAAE;QAChB,MAAM,MAAM,GAAG,IAAI,2CAAoB,CAAC,MAAM,EAAE,mBAAmB,CAAC;aAC/D,mBAAmB,CAAC,CAAC,SAAS,CAAC,EAAE,0CAAmB,CAAC;aACrD,QAAQ,EAAE,CAAC;QAChB,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,MAAM,KAAK,GAAG,IAAA,YAAK,EAAC,MAAM,CAAC,CAAC;QAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACtC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,CACvB,SAAS,CAAC,IAAI,KAAK,2BAAmB,CAAC,GAAG;YACtC,CAAC,CAAC,kBAAkB;YACpB,CAAC,CAAC,qBAAqB,CAC9B,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,IAAA,+CAAsB,EAAC;YAC3C,MAAM,EAAE,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,mBAAmB,EAAE,CAAC;YACvD,mBAAmB,EAAE,0CAAmB;YACxC,sBAAsB,EAAE,EAAE,SAAS,EAAE,iDAAwB,EAAE;SAClE,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,IAAI,IAAA,wBAAc,EAAC,OAAO,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACxD,MAAM,CACF,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,WAAW,CAC7D,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC,CACJ,CAAC;IAEF,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAC9E,MAAM,MAAM,GAAG,kDAAkD,CAAC;QAClE,MAAM,MAAM,GAAG,IAAI,2CAAoB,CACnC,MAAM,GAAG,MAAM,EACf,mBAAmB,CACtB;aACI,mBAAmB,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,0CAAmB,CAAC;aAC/D,QAAQ,EAAE,CAAC;QAChB,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,CAAC,IAAA,YAAK,EAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjD,MAAM,CAAC,IAAA,YAAK,EAAC,MAAM,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,GAAG,EAAE;QAClF,MAAM,CAAC,GAAG,EAAE,CACR,IAAI,2CAAoB,CACpB,MAAM,EACN,mBAAmB,CACtB,CAAC,mBAAmB,CACjB;YACI;gBACI,EAAE,EAAE,aAAa;gBACjB,IAAI,EAAE,aAAa;gBACnB,KAAK,EAAE,QAAQ;gBACf,IAAI,EAAE,2BAAmB,CAAC,GAAG;gBAC7B,WAAW,EAAE,eAAe;gBAC5B,OAAO,EAAE,eAAO,CAAC,YAAY;gBAC7B,SAAS,EAAE,CAAC;aACf;SACJ,EACD,0CAAmB,CACtB,CACJ,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACrE,MAAM,CAAC,GAAG,EAAE,CACR,IAAI,2CAAoB,CACpB,MAAM,EACN,mBAAmB,CACtB,CAAC,gBAAgB,CAAC;YACf;gBACI,GAAG,MAAM;gBACT,OAAO,EAAE,CAAC,EAAE,GAAG,MAAM,CAAC,OAAQ,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;aAC1D;SACJ,CAAC,CACL,CAAC,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8EAA8E,EAAE,GAAG,EAAE;QACpF,MAAM,CAAC,GAAG,EAAE,CACR,IAAI,2CAAoB,CACpB,MAAM,EACN,mBAAmB,CACtB,CAAC,gBAAgB,CAAC;YACf,MAAM;YACN,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,mBAAmB,EAAE;SAC5C,CAAC,CACL,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { type LightdashModelMetric } from '../types/lightdashModel';
|
|
2
|
+
import { type AdditionalMetric } from '../types/metricQuery';
|
|
3
|
+
export declare const convertCustomMetricToLightdash: (metric: AdditionalMetric) => LightdashModelMetric;
|
|
4
|
+
//# sourceMappingURL=convertCustomMetricToLightdash.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"convertCustomMetricToLightdash.d.ts","sourceRoot":"","sources":["../../../src/lightdash/convertCustomMetricToLightdash.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAG7D,eAAO,MAAM,8BAA8B,WAC/B,gBAAgB,KACzB,oBAoCF,CAAC"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.convertCustomMetricToLightdash = void 0;
|
|
4
|
+
const errors_1 = require("../types/errors");
|
|
5
|
+
const filter_1 = require("../types/filter");
|
|
6
|
+
const convertCustomMetricsToYaml_1 = require("../utils/convertCustomMetricsToYaml");
|
|
7
|
+
const convertCustomMetricToLightdash = (metric) => {
|
|
8
|
+
if (metric.generationType ||
|
|
9
|
+
!metric.baseDimensionName ||
|
|
10
|
+
!metric.sql.trim()) {
|
|
11
|
+
throw new errors_1.ParameterError(`Metric ${metric.name} cannot be written back to native YAML. Only metrics based on a native dimension are supported; generated period comparisons and metrics without a base dimension are not supported.`);
|
|
12
|
+
}
|
|
13
|
+
for (const filter of metric.filters ?? []) {
|
|
14
|
+
const noValues = [
|
|
15
|
+
filter_1.FilterOperator.NULL,
|
|
16
|
+
filter_1.FilterOperator.NOT_NULL,
|
|
17
|
+
].includes(filter.operator);
|
|
18
|
+
const parts = filter.target.fieldRef.split('.');
|
|
19
|
+
if (filter.includeNull ||
|
|
20
|
+
(!noValues && !filter.values?.length) ||
|
|
21
|
+
(!noValues &&
|
|
22
|
+
filter.operator !== filter_1.FilterOperator.EQUALS &&
|
|
23
|
+
filter.values.length !== 1) ||
|
|
24
|
+
(parts.length > 1 &&
|
|
25
|
+
(parts.length !== 2 || parts[0] !== metric.table))) {
|
|
26
|
+
throw new errors_1.ParameterError(`Filter ${filter.id} on metric ${metric.name} cannot be represented in native YAML without changing its meaning.`);
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
return {
|
|
30
|
+
...(0, convertCustomMetricsToYaml_1.convertCustomMetricToDbt)(metric),
|
|
31
|
+
sql: metric.sql,
|
|
32
|
+
hidden: metric.hidden,
|
|
33
|
+
distinct_keys: metric.distinctKeys,
|
|
34
|
+
};
|
|
35
|
+
};
|
|
36
|
+
exports.convertCustomMetricToLightdash = convertCustomMetricToLightdash;
|
|
37
|
+
//# sourceMappingURL=convertCustomMetricToLightdash.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"convertCustomMetricToLightdash.js","sourceRoot":"","sources":["../../../src/lightdash/convertCustomMetricToLightdash.ts"],"names":[],"mappings":";;;AAAA,4CAAiD;AACjD,4CAAiD;AAGjD,oFAA+E;AAExE,MAAM,8BAA8B,GAAG,CAC1C,MAAwB,EACJ,EAAE;IACtB,IACI,MAAM,CAAC,cAAc;QACrB,CAAC,MAAM,CAAC,iBAAiB;QACzB,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EACpB,CAAC;QACC,MAAM,IAAI,uBAAc,CACpB,UAAU,MAAM,CAAC,IAAI,sLAAsL,CAC9M,CAAC;IACN,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG;YACb,uBAAc,CAAC,IAAI;YACnB,uBAAc,CAAC,QAAQ;SAC1B,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChD,IACI,MAAM,CAAC,WAAW;YAClB,CAAC,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;YACrC,CAAC,CAAC,QAAQ;gBACN,MAAM,CAAC,QAAQ,KAAK,uBAAc,CAAC,MAAM;gBACzC,MAAM,CAAC,MAAO,CAAC,MAAM,KAAK,CAAC,CAAC;YAChC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBACb,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC,CAAC,EACxD,CAAC;YACC,MAAM,IAAI,uBAAc,CACpB,UAAU,MAAM,CAAC,EAAE,cAAc,MAAM,CAAC,IAAI,qEAAqE,CACpH,CAAC;QACN,CAAC;IACL,CAAC;IACD,OAAO;QACH,GAAG,IAAA,qDAAwB,EAAC,MAAM,CAAC;QACnC,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,aAAa,EAAE,MAAM,CAAC,YAAY;KACrC,CAAC;AACN,CAAC,CAAC;AAtCW,QAAA,8BAA8B,GAA9B,8BAA8B,CAsCzC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { type LightdashModel, type LightdashModelWithSource } from '../types/lightdashModel';
|
|
2
|
+
export declare function loadLightdashModel(filePath: string): Promise<LightdashModel>;
|
|
3
|
+
export declare function findLightdashModelFiles(projectDir: string): Promise<string[]>;
|
|
4
|
+
export declare function loadLightdashModels(projectDir: string): Promise<LightdashModelWithSource[]>;
|
|
5
|
+
//# sourceMappingURL=loader.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../../../src/lightdash/loader.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,KAAK,cAAc,EACnB,KAAK,wBAAwB,EAChC,MAAM,yBAAyB,CAAC;AAgBjC,wBAAsB,kBAAkB,CACpC,QAAQ,EAAE,MAAM,GACjB,OAAO,CAAC,cAAc,CAAC,CAQzB;AAED,wBAAsB,uBAAuB,CACzC,UAAU,EAAE,MAAM,GACnB,OAAO,CAAC,MAAM,EAAE,CAAC,CA8DnB;AAED,wBAAsB,mBAAmB,CACrC,UAAU,EAAE,MAAM,GACnB,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAmBrC"}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.loadLightdashModel = loadLightdashModel;
|
|
4
|
+
exports.findLightdashModelFiles = findLightdashModelFiles;
|
|
5
|
+
exports.loadLightdashModels = loadLightdashModels;
|
|
6
|
+
const tslib_1 = require("tslib");
|
|
7
|
+
const ajv_1 = tslib_1.__importDefault(require("ajv"));
|
|
8
|
+
const promises_1 = tslib_1.__importDefault(require("fs/promises"));
|
|
9
|
+
const yaml = tslib_1.__importStar(require("js-yaml"));
|
|
10
|
+
const path_1 = tslib_1.__importDefault(require("path"));
|
|
11
|
+
const model_as_code_1_0_json_1 = tslib_1.__importDefault(require("../schemas/json/model-as-code-1.0.json"));
|
|
12
|
+
const errors_1 = require("../types/errors");
|
|
13
|
+
const ajv = new ajv_1.default({ allErrors: true, strict: false });
|
|
14
|
+
const validateModel = ajv.compile(model_as_code_1_0_json_1.default);
|
|
15
|
+
const modelTypes = new Set(['model', 'model/v1beta', 'model/v1']);
|
|
16
|
+
async function readYaml(filePath) {
|
|
17
|
+
try {
|
|
18
|
+
return yaml.load(await promises_1.default.readFile(filePath, 'utf8'));
|
|
19
|
+
}
|
|
20
|
+
catch (error) {
|
|
21
|
+
throw new errors_1.ParseError(`Failed to read YAML from ${filePath}: ${error instanceof Error ? error.message : String(error)}`);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
async function loadLightdashModel(filePath) {
|
|
25
|
+
const parsed = await readYaml(filePath);
|
|
26
|
+
if (!validateModel(parsed)) {
|
|
27
|
+
throw new errors_1.ParseError(`Invalid Lightdash model in ${filePath}: ${ajv.errorsText(validateModel.errors)}`);
|
|
28
|
+
}
|
|
29
|
+
return parsed;
|
|
30
|
+
}
|
|
31
|
+
async function findLightdashModelFiles(projectDir) {
|
|
32
|
+
const possibleDirs = [
|
|
33
|
+
path_1.default.join(projectDir, 'models'),
|
|
34
|
+
path_1.default.join(projectDir, 'lightdash', 'models'),
|
|
35
|
+
];
|
|
36
|
+
let modelsDir;
|
|
37
|
+
for await (const dir of possibleDirs) {
|
|
38
|
+
try {
|
|
39
|
+
if ((await promises_1.default.stat(dir)).isDirectory()) {
|
|
40
|
+
modelsDir = dir;
|
|
41
|
+
break;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
catch (error) {
|
|
45
|
+
if (!(error instanceof Error &&
|
|
46
|
+
'code' in error &&
|
|
47
|
+
error.code === 'ENOENT'))
|
|
48
|
+
throw error;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
if (!modelsDir)
|
|
52
|
+
return [];
|
|
53
|
+
const relativeModelsDir = path_1.default.relative(await promises_1.default.realpath(projectDir), await promises_1.default.realpath(modelsDir));
|
|
54
|
+
if (relativeModelsDir === '..' ||
|
|
55
|
+
relativeModelsDir.startsWith(`..${path_1.default.sep}`) ||
|
|
56
|
+
path_1.default.isAbsolute(relativeModelsDir)) {
|
|
57
|
+
throw new errors_1.ParseError('Native models directory must stay within the project directory');
|
|
58
|
+
}
|
|
59
|
+
const files = [];
|
|
60
|
+
async function walk(dir) {
|
|
61
|
+
const entries = await promises_1.default.readdir(dir, { withFileTypes: true });
|
|
62
|
+
entries.sort((a, b) => a.name.localeCompare(b.name));
|
|
63
|
+
for await (const entry of entries) {
|
|
64
|
+
const filePath = path_1.default.join(dir, entry.name);
|
|
65
|
+
if (entry.isDirectory()) {
|
|
66
|
+
await walk(filePath);
|
|
67
|
+
}
|
|
68
|
+
else if (entry.isFile() && /\.ya?ml$/.test(entry.name)) {
|
|
69
|
+
const parsed = await readYaml(filePath);
|
|
70
|
+
if (parsed &&
|
|
71
|
+
typeof parsed === 'object' &&
|
|
72
|
+
'type' in parsed &&
|
|
73
|
+
typeof parsed.type === 'string' &&
|
|
74
|
+
modelTypes.has(parsed.type))
|
|
75
|
+
files.push(filePath);
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
await walk(modelsDir);
|
|
80
|
+
return files;
|
|
81
|
+
}
|
|
82
|
+
async function loadLightdashModels(projectDir) {
|
|
83
|
+
const files = await findLightdashModelFiles(projectDir);
|
|
84
|
+
const models = [];
|
|
85
|
+
const names = new Map();
|
|
86
|
+
for await (const filePath of files) {
|
|
87
|
+
const model = await loadLightdashModel(filePath);
|
|
88
|
+
const sourcePath = path_1.default
|
|
89
|
+
.relative(projectDir, filePath)
|
|
90
|
+
.split(path_1.default.sep)
|
|
91
|
+
.join('/');
|
|
92
|
+
const previousPath = names.get(model.name);
|
|
93
|
+
if (previousPath !== undefined)
|
|
94
|
+
throw new errors_1.ParseError(`Duplicate Lightdash model "${model.name}" in ${previousPath} and ${sourcePath}`);
|
|
95
|
+
names.set(model.name, sourcePath);
|
|
96
|
+
models.push({ ...model, sourcePath });
|
|
97
|
+
}
|
|
98
|
+
return models;
|
|
99
|
+
}
|
|
100
|
+
//# sourceMappingURL=loader.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"loader.js","sourceRoot":"","sources":["../../../src/lightdash/loader.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAsB;AACtB,mEAA6B;AAC7B,MAAY,IAAI,4CAAgB;AAChC,wDAAwB;AACxB,4GAAiE;AACjE,4CAA6C;AAM7C,MAAM,GAAG,GAAG,IAAI,aAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;AACxD,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAiB,gCAAW,CAAC,CAAC;AAC/D,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC,CAAC;AAElE,KAAK,UAAU,QAAQ,CAAC,QAAgB;IACpC,IAAI,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,kBAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,mBAAU,CAChB,4BAA4B,QAAQ,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACpG,CAAC;IACN,CAAC;AACL,CAAC;AAEM,KAAK,6BACR,QAAgB;IAEhB,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACxC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,mBAAU,CAChB,8BAA8B,QAAQ,KAAK,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CACpF,CAAC;IACN,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAEM,KAAK,kCACR,UAAkB;IAElB,MAAM,YAAY,GAAG;QACjB,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC;QAC/B,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,QAAQ,CAAC;KAC/C,CAAC;IACF,IAAI,SAA6B,CAAC;IAClC,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;QACnC,IAAI,CAAC;YACD,IAAI,CAAC,MAAM,kBAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;gBACrC,SAAS,GAAG,GAAG,CAAC;gBAChB,MAAM;YACV,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IACI,CAAC,CACG,KAAK,YAAY,KAAK;gBACtB,MAAM,IAAI,KAAK;gBACf,KAAK,CAAC,IAAI,KAAK,QAAQ,CAC1B;gBAED,MAAM,KAAK,CAAC;QACpB,CAAC;IACL,CAAC;IACD,IAAI,CAAC,SAAS;QAAE,OAAO,EAAE,CAAC;IAE1B,MAAM,iBAAiB,GAAG,cAAI,CAAC,QAAQ,CACnC,MAAM,kBAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAC7B,MAAM,kBAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAC/B,CAAC;IACF,IACI,iBAAiB,KAAK,IAAI;QAC1B,iBAAiB,CAAC,UAAU,CAAC,KAAK,cAAI,CAAC,GAAG,EAAE,CAAC;QAC7C,cAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,EACpC,CAAC;QACC,MAAM,IAAI,mBAAU,CAChB,gEAAgE,CACnE,CAAC;IACN,CAAC;IAED,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,UAAU,IAAI,CAAC,GAAW;QAC3B,MAAM,OAAO,GAAG,MAAM,kBAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACrD,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAChC,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;gBACtB,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzB,CAAC;iBAAM,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACxC,IACI,MAAM;oBACN,OAAO,MAAM,KAAK,QAAQ;oBAC1B,MAAM,IAAI,MAAM;oBAChB,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;oBAC/B,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;oBAE3B,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7B,CAAC;QACL,CAAC;IACL,CAAC;IACD,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC;IACtB,OAAO,KAAK,CAAC;AACjB,CAAC;AAEM,KAAK,8BACR,UAAkB;IAElB,MAAM,KAAK,GAAG,MAAM,uBAAuB,CAAC,UAAU,CAAC,CAAC;IACxD,MAAM,MAAM,GAA+B,EAAE,CAAC;IAC9C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,KAAK,EAAE,CAAC;QACjC,MAAM,KAAK,GAAG,MAAM,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACjD,MAAM,UAAU,GAAG,cAAI;aAClB,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC;aAC9B,KAAK,CAAC,cAAI,CAAC,GAAG,CAAC;aACf,IAAI,CAAC,GAAG,CAAC,CAAC;QACf,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,YAAY,KAAK,SAAS;YAC1B,MAAM,IAAI,mBAAU,CAChB,8BAA8B,KAAK,CAAC,IAAI,QAAQ,YAAY,QAAQ,UAAU,EAAE,CACnF,CAAC;QACN,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAClC,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"loader.test.d.ts","sourceRoot":"","sources":["../../../src/lightdash/loader.test.ts"],"names":[],"mappings":""}
|