@zlens/notebook 0.0.0-stage → 0.2.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.
@@ -0,0 +1,287 @@
1
+ import { NodeKind, blockSemanticRuntimeBindings, parse, } from '@zlens/core';
2
+ import { resolveSemanticRefs, hasSemanticRefs } from './semantic-refs.js';
3
+ export function buildExecutionPlan(cell, options) {
4
+ if (cell.type === 'markdown' || cell.type === 'chart') {
5
+ return null;
6
+ }
7
+ if (cell.type === 'sql') {
8
+ // Resolve @metric(name) and @dim(name) references in SQL cells
9
+ let resolvedSql = cell.source;
10
+ if (options?.semanticLayer && hasSemanticRefs(cell.source)) {
11
+ const resolution = resolveSemanticRefs(cell.source, options.semanticLayer, {
12
+ tableMapping: options.tableMapping,
13
+ });
14
+ if (resolution.unresolvedRefs.length > 0) {
15
+ throw new Error(`Unresolved semantic references in SQL cell: ${resolution.unresolvedRefs.join(', ')}. ` +
16
+ 'Check that these metrics/dimensions exist in your semantic layer.');
17
+ }
18
+ resolvedSql = resolution.resolvedSql;
19
+ }
20
+ return {
21
+ title: cell.title || 'SQL cell',
22
+ sql: resolvedSql,
23
+ sqlParams: [],
24
+ variables: {},
25
+ chartConfig: cell.config,
26
+ tests: [],
27
+ };
28
+ }
29
+ const program = parse(cell.source);
30
+ const block = program.statements.find((statement) => statement.kind === NodeKind.BlockDecl);
31
+ if (!block) {
32
+ throw new Error('ZLens notebook cells must contain a block declaration.');
33
+ }
34
+ // Semantic blocks: compose SQL from the semantic layer
35
+ if (block.blockType === 'semantic') {
36
+ return buildSemanticPlan(block, options?.semanticLayer, options?.driver, options?.tableMapping, options?.parameters, options?.semanticSql);
37
+ }
38
+ if (block.blockType !== 'custom') {
39
+ throw new Error(`Unsupported block type "${block.blockType}". Only "custom" and "semantic" blocks can run in the notebook.`);
40
+ }
41
+ if (!block.query) {
42
+ throw new Error('ZLens notebook block is missing a query field.');
43
+ }
44
+ const processed = applyRLSDecorators(block.decorators, processSQL(block.query.rawSQL, block.query.interpolations));
45
+ const chartConfig = block.visualization ? lowerChartConfig(block.visualization.properties) : undefined;
46
+ const variables = Object.fromEntries((block.params?.params ?? [])
47
+ .filter((param) => param.initializer)
48
+ .map((param) => [param.name, evaluateExpression(param.initializer)]));
49
+ return {
50
+ title: block.name,
51
+ sql: processed.sql,
52
+ sqlParams: processed.params,
53
+ variables,
54
+ chartConfig,
55
+ tests: (block.tests ?? []).map((test) => ({
56
+ field: test.field,
57
+ operator: test.operator,
58
+ expected: evaluateExpression(test.expected),
59
+ })),
60
+ };
61
+ }
62
+ function lowerChartConfig(properties) {
63
+ const config = {};
64
+ for (const property of properties) {
65
+ const value = evaluateExpression(property.value);
66
+ switch (property.name) {
67
+ case 'chart':
68
+ config.chart = String(value);
69
+ break;
70
+ case 'x':
71
+ config.x = String(value);
72
+ break;
73
+ case 'y':
74
+ config.y = String(value);
75
+ break;
76
+ case 'y2':
77
+ config.y2 = String(value);
78
+ break;
79
+ case 'color':
80
+ config.color = String(value);
81
+ break;
82
+ }
83
+ }
84
+ return config;
85
+ }
86
+ function processSQL(rawSQL, interpolations) {
87
+ if (interpolations.length === 0) {
88
+ return { sql: rawSQL, params: [] };
89
+ }
90
+ let sql = rawSQL;
91
+ const params = [];
92
+ const sorted = [...interpolations].sort((a, b) => b.offsetInSQL - a.offsetInSQL);
93
+ let position = interpolations.length;
94
+ for (const interpolation of sorted) {
95
+ const placeholder = `$${position}`;
96
+ const from = interpolation.offsetInSQL;
97
+ const rest = sql.slice(from);
98
+ const pattern = new RegExp(`^\\$\\{${interpolation.variableName}\\}|^\\{${interpolation.variableName}\\}`);
99
+ const match = rest.match(pattern);
100
+ if (!match) {
101
+ position -= 1;
102
+ continue;
103
+ }
104
+ sql = sql.slice(0, from) + placeholder + sql.slice(from + match[0].length);
105
+ params.unshift({ name: interpolation.variableName, position });
106
+ position -= 1;
107
+ }
108
+ return { sql, params };
109
+ }
110
+ function buildSemanticPlan(block, semanticLayer, driver, tableMapping, parameters, semanticSql) {
111
+ if (!semanticLayer) {
112
+ throw new Error('Semantic block requires a semantic-layer/ configuration. ' +
113
+ 'Add metric and dimension YAML files to your project\'s semantic-layer/ directory.');
114
+ }
115
+ // Extract metric references: metricsRef (array) takes precedence over metricRef (single)
116
+ const metrics = [];
117
+ const dimensions = [];
118
+ if (block.metricsRef && block.metricsRef.length > 0) {
119
+ metrics.push(...block.metricsRef);
120
+ }
121
+ else if (block.metricRef) {
122
+ metrics.push(block.metricRef);
123
+ }
124
+ if (block.dimensionsRef && block.dimensionsRef.length > 0) {
125
+ dimensions.push(...block.dimensionsRef);
126
+ }
127
+ // Also extract dimensions/metrics from block params if they reference names
128
+ for (const param of block.params?.params ?? []) {
129
+ if (!param.initializer)
130
+ continue;
131
+ const val = evaluateExpression(param.initializer);
132
+ if (param.name === 'dimensions' && Array.isArray(val)) {
133
+ dimensions.push(...val.map(String));
134
+ }
135
+ else if (param.name === 'metrics' && Array.isArray(val)) {
136
+ metrics.push(...val.map(String));
137
+ }
138
+ }
139
+ if (metrics.length === 0) {
140
+ throw new Error(`Semantic block "${block.name}" has no metric references. ` +
141
+ 'Add metrics = ["metric1", "metric2"] to your block declaration.');
142
+ }
143
+ const runtimeBindings = blockSemanticRuntimeBindings(block, parameters);
144
+ const composed = semanticSql
145
+ ? { sql: semanticSql }
146
+ : semanticLayer.composeQuery({
147
+ metrics,
148
+ dimensions,
149
+ ...(block.timeDimension && block.granularity
150
+ ? { timeDimension: { name: block.timeDimension, granularity: block.granularity } }
151
+ : {}),
152
+ ...(runtimeBindings.filters.length > 0 ? { filters: runtimeBindings.filters } : {}),
153
+ ...((runtimeBindings.limit ?? block.limit) !== undefined
154
+ ? { limit: runtimeBindings.limit ?? block.limit }
155
+ : {}),
156
+ driver,
157
+ tableMapping,
158
+ });
159
+ if (!composed) {
160
+ // Distinguish the three real causes instead of sending users to check
161
+ // definitions that are usually fine: (a) the metric genuinely is not
162
+ // defined, (b) it exists but is a derived/ratio/cumulative metric DQL
163
+ // cannot compose natively (needs dbt Cloud Semantic Layer or local
164
+ // MetricFlow), (c) everything resolves but the dimension set is unjoinable.
165
+ const reasons = metrics.map((name) => {
166
+ if (semanticLayer.canComposeMetric(name))
167
+ return null;
168
+ const metric = semanticLayer.getMetric(name);
169
+ if (!metric)
170
+ return `metric "${name}" is not defined in the semantic layer`;
171
+ const kind = metric.metricType || metric.type || 'metric';
172
+ return `metric "${name}" exists but is a ${kind} metric ZLens cannot compose natively — run it through a full semantic runtime (dbt Cloud Semantic Layer or local MetricFlow)`;
173
+ }).filter((reason) => Boolean(reason));
174
+ throw new Error(reasons.length > 0
175
+ ? `Could not compose SQL for semantic block "${block.name}": ${reasons.join('; ')}.`
176
+ : `Could not compose SQL for semantic block "${block.name}". The metrics resolved, but the selected dimensions do not share a governed join path with them — remove or replace the unjoinable dimension.`);
177
+ }
178
+ const chartConfig = block.visualization ? lowerChartConfig(block.visualization.properties) : undefined;
179
+ const variables = Object.fromEntries((block.params?.params ?? [])
180
+ .filter((param) => param.initializer)
181
+ .map((param) => [param.name, evaluateExpression(param.initializer)]));
182
+ const processed = applyRLSDecorators(block.decorators, { sql: composed.sql, params: [] });
183
+ return {
184
+ title: block.name,
185
+ sql: processed.sql,
186
+ sqlParams: processed.params,
187
+ variables,
188
+ chartConfig,
189
+ tests: (block.tests ?? []).map((test) => ({
190
+ field: test.field,
191
+ operator: test.operator,
192
+ expected: evaluateExpression(test.expected),
193
+ })),
194
+ };
195
+ }
196
+ const SAFE_RLS_COLUMN = /^[A-Za-z_][A-Za-z0-9_]*(?:\.[A-Za-z_][A-Za-z0-9_]*)*$/;
197
+ const RLS_TEMPLATE_VARIABLE = /^\{([A-Za-z_][A-Za-z0-9_.]*)\}$/;
198
+ function applyRLSDecorators(decorators, processed) {
199
+ const rlsDecorators = decorators.filter((d) => d.name === 'rls');
200
+ if (rlsDecorators.length === 0)
201
+ return processed;
202
+ const clauses = [];
203
+ const params = [...processed.params];
204
+ let nextPosition = params.reduce((max, p) => Math.max(max, p.position), 0);
205
+ let literalCounter = 0;
206
+ for (const rls of rlsDecorators) {
207
+ if (rls.arguments.length < 2)
208
+ continue;
209
+ const column = normalizeRLSColumn(rls.arguments[0]);
210
+ if (!column)
211
+ continue;
212
+ const binding = resolveRLSValueBinding(rls.arguments[1]);
213
+ if (!binding)
214
+ continue;
215
+ nextPosition += 1;
216
+ if (binding.type === 'variable') {
217
+ params.push({ name: binding.variableName, position: nextPosition });
218
+ }
219
+ else {
220
+ literalCounter += 1;
221
+ params.push({
222
+ name: `__rls_literal_${literalCounter}`,
223
+ position: nextPosition,
224
+ literalValue: binding.literalValue,
225
+ });
226
+ }
227
+ clauses.push(`${column} = COALESCE($${nextPosition}, ${column})`);
228
+ }
229
+ if (clauses.length === 0)
230
+ return { sql: processed.sql, params };
231
+ return {
232
+ sql: `SELECT * FROM (${processed.sql}) _dql_rls WHERE ${clauses.join(' AND ')}`,
233
+ params,
234
+ };
235
+ }
236
+ function normalizeRLSColumn(arg) {
237
+ const raw = arg.kind === NodeKind.StringLiteral
238
+ ? arg.value
239
+ : arg.kind === NodeKind.Identifier
240
+ ? arg.name
241
+ : evaluateExpression(arg);
242
+ if (typeof raw !== 'string')
243
+ return null;
244
+ const trimmed = raw.trim();
245
+ return SAFE_RLS_COLUMN.test(trimmed) ? trimmed : null;
246
+ }
247
+ function resolveRLSValueBinding(arg) {
248
+ if (arg.kind === NodeKind.StringLiteral) {
249
+ const raw = String(arg.value ?? '');
250
+ const match = raw.trim().match(RLS_TEMPLATE_VARIABLE);
251
+ if (match)
252
+ return { type: 'variable', variableName: match[1] };
253
+ return { type: 'literal', literalValue: raw };
254
+ }
255
+ if (arg.kind === NodeKind.Identifier)
256
+ return { type: 'variable', variableName: arg.name };
257
+ if (arg.kind === NodeKind.NumberLiteral || arg.kind === NodeKind.BooleanLiteral) {
258
+ return { type: 'literal', literalValue: arg.value };
259
+ }
260
+ const value = evaluateExpression(arg);
261
+ if (value !== undefined)
262
+ return { type: 'literal', literalValue: value };
263
+ return null;
264
+ }
265
+ function evaluateExpression(node) {
266
+ switch (node.kind) {
267
+ case NodeKind.StringLiteral:
268
+ return node.value;
269
+ case NodeKind.NumberLiteral:
270
+ return node.value;
271
+ case NodeKind.BooleanLiteral:
272
+ return node.value;
273
+ case NodeKind.Identifier:
274
+ return node.name;
275
+ case NodeKind.ArrayLiteral:
276
+ return node.elements.map((element) => evaluateExpression(element));
277
+ case NodeKind.IntervalExpr:
278
+ return node.value;
279
+ case NodeKind.BinaryExpr:
280
+ return `${evaluateExpression(node.left)} ${node.operator} ${evaluateExpression(node.right)}`;
281
+ case NodeKind.FunctionCall:
282
+ return node.callee;
283
+ case NodeKind.TemplateString:
284
+ return node.parts.map((part) => (typeof part === 'string' ? part : String(evaluateExpression(part)))).join('');
285
+ }
286
+ }
287
+ //# sourceMappingURL=execute.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"execute.js","sourceRoot":"","sources":["../src/execute.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,4BAA4B,EAC5B,KAAK,GAMN,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AA2B1E,MAAM,UAAU,kBAAkB,CAChC,IAAkB,EAClB,OAAmC;IAEnC,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QACxB,+DAA+D;QAC/D,IAAI,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;QAC9B,IAAI,OAAO,EAAE,aAAa,IAAI,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3D,MAAM,UAAU,GAAG,mBAAmB,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,EAAE;gBACzE,YAAY,EAAE,OAAO,CAAC,YAAY;aACnC,CAAC,CAAC;YACH,IAAI,UAAU,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CACb,+CAA+C,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;oBACvF,mEAAmE,CACpE,CAAC;YACJ,CAAC;YACD,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,UAAU;YAC/B,GAAG,EAAE,WAAW;YAChB,SAAS,EAAE,EAAE;YACb,SAAS,EAAE,EAAE;YACb,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,KAAK,EAAE,EAAE;SACV,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,QAAQ,CAAC,SAAS,CAA8B,CAAC;IAEzH,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IAED,uDAAuD;IACvD,IAAI,KAAK,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;QACnC,OAAO,iBAAiB,CACtB,KAAK,EACL,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,UAAU,EACnB,OAAO,EAAE,WAAW,CACrB,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,2BAA2B,KAAK,CAAC,SAAS,iEAAiE,CAAC,CAAC;IAC/H,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,SAAS,GAAG,kBAAkB,CAClC,KAAK,CAAC,UAAU,EAChB,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAC3D,CAAC;IACF,MAAM,WAAW,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvG,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAClC,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,IAAI,EAAE,CAAC;SACzB,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC;SACpC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,WAAY,CAAC,CAAC,CAAC,CACxE,CAAC;IAEF,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,IAAI;QACjB,GAAG,EAAE,SAAS,CAAC,GAAG;QAClB,SAAS,EAAE,SAAS,CAAC,MAAM;QAC3B,SAAS;QACT,WAAW;QACX,KAAK,EAAE,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACxC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC;SAC5C,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,UAA0B;IAClD,MAAM,MAAM,GAAwB,EAAE,CAAC;IAEvC,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACjD,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;YACtB,KAAK,OAAO;gBACV,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC7B,MAAM;YACR,KAAK,GAAG;gBACN,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBACzB,MAAM;YACR,KAAK,GAAG;gBACN,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBACzB,MAAM;YACR,KAAK,IAAI;gBACP,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC1B,MAAM;YACR,KAAK,OAAO;gBACV,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC7B,MAAM;QACV,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,UAAU,CACjB,MAAc,EACd,cAAoE;IAEpE,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IACrC,CAAC;IAED,IAAI,GAAG,GAAG,MAAM,CAAC;IACjB,MAAM,MAAM,GAAmB,EAAE,CAAC;IAClC,MAAM,MAAM,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC;IACjF,IAAI,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC;IAErC,KAAK,MAAM,aAAa,IAAI,MAAM,EAAE,CAAC;QACnC,MAAM,WAAW,GAAG,IAAI,QAAQ,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,aAAa,CAAC,WAAW,CAAC;QACvC,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,UAAU,aAAa,CAAC,YAAY,WAAW,aAAa,CAAC,YAAY,KAAK,CAAC,CAAC;QAC3G,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,QAAQ,IAAI,CAAC,CAAC;YACd,SAAS;QACX,CAAC;QAED,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAC3E,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,aAAa,CAAC,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/D,QAAQ,IAAI,CAAC,CAAC;IAChB,CAAC;IAED,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;AACzB,CAAC;AAED,SAAS,iBAAiB,CACxB,KAAoB,EACpB,aAA6B,EAC7B,MAAe,EACf,YAAqC,EACrC,UAAoC,EACpC,WAAoB;IAEpB,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CACb,2DAA2D;YAC3D,mFAAmF,CACpF,CAAC;IACJ,CAAC;IAED,yFAAyF;IACzF,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,UAAU,GAAa,EAAE,CAAC;IAEhC,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpD,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IACpC,CAAC;SAAM,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAChC,CAAC;IACD,IAAI,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1D,UAAU,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IAED,4EAA4E;IAC5E,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,MAAM,IAAI,EAAE,EAAE,CAAC;QAC/C,IAAI,CAAC,KAAK,CAAC,WAAW;YAAE,SAAS;QACjC,MAAM,GAAG,GAAG,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAClD,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACtD,UAAU,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QACtC,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1D,OAAO,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CACb,mBAAmB,KAAK,CAAC,IAAI,8BAA8B;YAC3D,iEAAiE,CAClE,CAAC;IACJ,CAAC;IAED,MAAM,eAAe,GAAG,4BAA4B,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IACxE,MAAM,QAAQ,GAAG,WAAW;QAC1B,CAAC,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE;QACtB,CAAC,CAAC,aAAa,CAAC,YAAY,CAAC;YACzB,OAAO;YACP,UAAU;YACV,GAAG,CAAC,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,WAAW;gBAC1C,CAAC,CAAC,EAAE,aAAa,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,aAAa,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,EAAE;gBAClF,CAAC,CAAC,EAAE,CAAC;YACP,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnF,GAAG,CAAC,CAAC,eAAe,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,SAAS;gBACtD,CAAC,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE;gBACjD,CAAC,CAAC,EAAE,CAAC;YACP,MAAM;YACN,YAAY;SACb,CAAC,CAAC;IACP,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,sEAAsE;QACtE,qEAAqE;QACrE,sEAAsE;QACtE,mEAAmE;QACnE,4EAA4E;QAC5E,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACnC,IAAI,aAAa,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBAAE,OAAO,IAAI,CAAC;YACtD,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC,MAAM;gBAAE,OAAO,WAAW,IAAI,wCAAwC,CAAC;YAC5E,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,IAAI,QAAQ,CAAC;YAC1D,OAAO,WAAW,IAAI,qBAAqB,IAAI,+HAA+H,CAAC;QACjL,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAoB,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QACzD,MAAM,IAAI,KAAK,CACb,OAAO,CAAC,MAAM,GAAG,CAAC;YAChB,CAAC,CAAC,6CAA6C,KAAK,CAAC,IAAI,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;YACpF,CAAC,CAAC,6CAA6C,KAAK,CAAC,IAAI,gJAAgJ,CAC5M,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvG,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAClC,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,IAAI,EAAE,CAAC;SACzB,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC;SACpC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,WAAY,CAAC,CAAC,CAAC,CACxE,CAAC;IAEF,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;IAE1F,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,IAAI;QACjB,GAAG,EAAE,SAAS,CAAC,GAAG;QAClB,SAAS,EAAE,SAAS,CAAC,MAAM;QAC3B,SAAS;QACT,WAAW;QACX,KAAK,EAAE,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACxC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC;SAC5C,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAED,MAAM,eAAe,GAAG,uDAAuD,CAAC;AAChF,MAAM,qBAAqB,GAAG,iCAAiC,CAAC;AAEhE,SAAS,kBAAkB,CACzB,UAA2B,EAC3B,SAAkD;IAElD,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC;IACjE,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAEjD,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IACrC,IAAI,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3E,IAAI,cAAc,GAAG,CAAC,CAAC;IAEvB,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;QAChC,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS;QACvC,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,IAAI,CAAC,MAAM;YAAE,SAAS;QACtB,MAAM,OAAO,GAAG,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACzD,IAAI,CAAC,OAAO;YAAE,SAAS;QACvB,YAAY,IAAI,CAAC,CAAC;QAClB,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,YAAY,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;QACtE,CAAC;aAAM,CAAC;YACN,cAAc,IAAI,CAAC,CAAC;YACpB,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,iBAAiB,cAAc,EAAE;gBACvC,QAAQ,EAAE,YAAY;gBACtB,YAAY,EAAE,OAAO,CAAC,YAAY;aACnC,CAAC,CAAC;QACL,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,gBAAgB,YAAY,KAAK,MAAM,GAAG,CAAC,CAAC;IACpE,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC;IAChE,OAAO;QACL,GAAG,EAAE,kBAAkB,SAAS,CAAC,GAAG,oBAAoB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QAC/E,MAAM;KACP,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,GAAmB;IAC7C,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,aAAa;QAC7C,CAAC,CAAC,GAAG,CAAC,KAAK;QACX,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,UAAU;YAChC,CAAC,CAAC,GAAG,CAAC,IAAI;YACV,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACzC,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IAC3B,OAAO,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;AACxD,CAAC;AAED,SAAS,sBAAsB,CAC7B,GAAmB;IAEnB,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,aAAa,EAAE,CAAC;QACxC,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;QACpC,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACtD,IAAI,KAAK;YAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC;IAChD,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,UAAU;QAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC;IAC1F,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,aAAa,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,cAAc,EAAE,CAAC;QAChF,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC;IACtD,CAAC;IACD,MAAM,KAAK,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;IACzE,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAoB;IAC9C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ,CAAC,aAAa;YACzB,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,KAAK,QAAQ,CAAC,aAAa;YACzB,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,KAAK,QAAQ,CAAC,cAAc;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,KAAK,QAAQ,CAAC,UAAU;YACtB,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,KAAK,QAAQ,CAAC,YAAY;YACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;QACrE,KAAK,QAAQ,CAAC,YAAY;YACxB,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,KAAK,QAAQ,CAAC,UAAU;YACtB,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,IAAI,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/F,KAAK,QAAQ,CAAC,YAAY;YACxB,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,KAAK,QAAQ,CAAC,cAAc;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnH,CAAC;AACH,CAAC"}
@@ -0,0 +1,5 @@
1
+ export * from './document.js';
2
+ export * from './execute.js';
3
+ export * from './connector-forms.js';
4
+ export * from './semantic-refs.js';
5
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,5 @@
1
+ export * from './document.js';
2
+ export * from './execute.js';
3
+ export * from './connector-forms.js';
4
+ export * from './semantic-refs.js';
5
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}
@@ -0,0 +1,54 @@
1
+ /**
2
+ * Semantic reference resolver for SQL cells.
3
+ *
4
+ * Resolves `@metric(name)` and `@dim(name)` references in plain SQL strings
5
+ * by looking up the metric/dimension definition in the SemanticLayer and
6
+ * inlining the SQL expression.
7
+ *
8
+ * Example:
9
+ * Input: SELECT @dim(segment), @metric(total_revenue) FROM fct_revenue GROUP BY @dim(segment)
10
+ * Output: SELECT segment_tier AS segment, SUM(amount) AS total_revenue FROM fct_revenue GROUP BY segment_tier
11
+ */
12
+ import type { SemanticLayer } from '@zlens/core';
13
+ export interface SemanticRefResolutionOptions {
14
+ /** Maps semantic model names to live, schema-qualified database relations. */
15
+ tableMapping?: Record<string, string>;
16
+ /** Maximum rows returned when a standalone dimension is explored. */
17
+ standaloneDimensionLimit?: number;
18
+ }
19
+ export interface SemanticRefResolution {
20
+ /** The resolved SQL with all semantic references expanded. */
21
+ resolvedSql: string;
22
+ /** Names of metrics that were resolved. */
23
+ resolvedMetrics: string[];
24
+ /** Names of dimensions that were resolved. */
25
+ resolvedDimensions: string[];
26
+ /** Any references that could not be resolved. */
27
+ unresolvedRefs: string[];
28
+ }
29
+ /**
30
+ * Check if a SQL string contains any semantic references.
31
+ */
32
+ export declare function hasSemanticRefs(sql: string): boolean;
33
+ /** Check whether the entire SQL cell is one semantic reference. */
34
+ export declare function hasStandaloneSemanticRef(sql: string): boolean;
35
+ /**
36
+ * Resolve all `@metric(name)` and `@dim(name)` references in a SQL string.
37
+ *
38
+ * - `@metric(total_revenue)` → expands to the metric's SQL expression with an alias
39
+ * - `@dim(segment)` or `@dimension(segment)` → expands to the dimension's SQL expression with an alias
40
+ *
41
+ * If a reference can't be found in the semantic layer, it is left as-is and
42
+ * added to `unresolvedRefs` so the caller can report a helpful error.
43
+ */
44
+ export declare function resolveSemanticRefs(sql: string, semanticLayer: SemanticLayer | undefined, options?: SemanticRefResolutionOptions): SemanticRefResolution;
45
+ /**
46
+ * Get a list of available semantic references for autocomplete.
47
+ */
48
+ export declare function getSemanticRefCompletions(semanticLayer: SemanticLayer | undefined): Array<{
49
+ type: 'metric' | 'dimension';
50
+ name: string;
51
+ label: string;
52
+ description: string;
53
+ }>;
54
+ //# sourceMappingURL=semantic-refs.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"semantic-refs.d.ts","sourceRoot":"","sources":["../src/semantic-refs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAyC,aAAa,EAAE,MAAM,aAAa,CAAC;AAMxF,MAAM,WAAW,4BAA4B;IAC3C,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,qEAAqE;IACrE,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IACpC,8DAA8D;IAC9D,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,8CAA8C;IAC9C,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,iDAAiD;IACjD,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAIpD;AAED,mEAAmE;AACnE,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE7D;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,MAAM,EACX,aAAa,EAAE,aAAa,GAAG,SAAS,EACxC,OAAO,CAAC,EAAE,4BAA4B,GACrC,qBAAqB,CA2EvB;AAgHD;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,aAAa,EAAE,aAAa,GAAG,SAAS,GACvC,KAAK,CAAC;IAAE,IAAI,EAAE,QAAQ,GAAG,WAAW,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC,CAwB3F"}
@@ -0,0 +1,216 @@
1
+ /**
2
+ * Semantic reference resolver for SQL cells.
3
+ *
4
+ * Resolves `@metric(name)` and `@dim(name)` references in plain SQL strings
5
+ * by looking up the metric/dimension definition in the SemanticLayer and
6
+ * inlining the SQL expression.
7
+ *
8
+ * Example:
9
+ * Input: SELECT @dim(segment), @metric(total_revenue) FROM fct_revenue GROUP BY @dim(segment)
10
+ * Output: SELECT segment_tier AS segment, SUM(amount) AS total_revenue FROM fct_revenue GROUP BY segment_tier
11
+ */
12
+ /** Pattern to match @metric(name) or @dim(name) references. */
13
+ const SEMANTIC_REF_PATTERN = /@(metric|dim|dimension)\(\s*([a-zA-Z_][a-zA-Z0-9_.]*)\s*\)/g;
14
+ const STANDALONE_SEMANTIC_REF_PATTERN = /^\s*@(metric|dim|dimension)\(\s*([a-zA-Z_][a-zA-Z0-9_.]*)\s*\)\s*;?\s*$/;
15
+ /**
16
+ * Check if a SQL string contains any semantic references.
17
+ */
18
+ export function hasSemanticRefs(sql) {
19
+ // New regex each call — the module-level /g pattern carries lastIndex state
20
+ // across calls and would return false on every second call for the same SQL.
21
+ return /@(metric|dim|dimension)\(\s*[a-zA-Z_][a-zA-Z0-9_.]*\s*\)/.test(sql);
22
+ }
23
+ /** Check whether the entire SQL cell is one semantic reference. */
24
+ export function hasStandaloneSemanticRef(sql) {
25
+ return STANDALONE_SEMANTIC_REF_PATTERN.test(sql);
26
+ }
27
+ /**
28
+ * Resolve all `@metric(name)` and `@dim(name)` references in a SQL string.
29
+ *
30
+ * - `@metric(total_revenue)` → expands to the metric's SQL expression with an alias
31
+ * - `@dim(segment)` or `@dimension(segment)` → expands to the dimension's SQL expression with an alias
32
+ *
33
+ * If a reference can't be found in the semantic layer, it is left as-is and
34
+ * added to `unresolvedRefs` so the caller can report a helpful error.
35
+ */
36
+ export function resolveSemanticRefs(sql, semanticLayer, options) {
37
+ const resolvedMetrics = [];
38
+ const resolvedDimensions = [];
39
+ const unresolvedRefs = [];
40
+ if (!semanticLayer) {
41
+ // No semantic layer — check if there are refs that need resolving
42
+ const refs = [];
43
+ sql.replace(SEMANTIC_REF_PATTERN, (_match, _type, name) => {
44
+ refs.push(name);
45
+ return _match;
46
+ });
47
+ if (refs.length > 0) {
48
+ return {
49
+ resolvedSql: sql,
50
+ resolvedMetrics: [],
51
+ resolvedDimensions: [],
52
+ unresolvedRefs: refs,
53
+ };
54
+ }
55
+ return { resolvedSql: sql, resolvedMetrics: [], resolvedDimensions: [], unresolvedRefs: [] };
56
+ }
57
+ // The notebook library lets users drag a semantic item into the canvas to
58
+ // create a cell whose complete source is `@dim(...)` or `@metric(...)`.
59
+ // Those references are expressions inside normal SQL, but a standalone cell
60
+ // needs a complete query. Compile it from semantic ownership plus the live
61
+ // table mapping so this works for any project/schema, not a fixture-specific
62
+ // relation name.
63
+ const standalone = sql.match(STANDALONE_SEMANTIC_REF_PATTERN);
64
+ if (standalone) {
65
+ return resolveStandaloneSemanticRef(standalone[1], standalone[2], semanticLayer, options);
66
+ }
67
+ // Track which position in the SQL each ref appears to handle GROUP BY correctly
68
+ // (in GROUP BY, we should NOT include the alias or aggregation wrapper)
69
+ const resolvedSql = sql.replace(SEMANTIC_REF_PATTERN, (match, refType, name) => {
70
+ if (refType === 'metric') {
71
+ const metric = semanticLayer.getMetric(name);
72
+ if (!metric) {
73
+ unresolvedRefs.push(`metric:${name}`);
74
+ return match;
75
+ }
76
+ resolvedMetrics.push(name);
77
+ // In SELECT context: wrap with aggregation and alias
78
+ // In GROUP BY / WHERE context: just the raw expression
79
+ // We use a heuristic: check if this ref appears after GROUP BY, ORDER BY, WHERE, HAVING
80
+ return `${metric.sql} AS ${sanitizeAlias(name)}`;
81
+ }
82
+ // dim or dimension
83
+ const dim = semanticLayer.getDimension(name);
84
+ if (!dim) {
85
+ unresolvedRefs.push(`dimension:${name}`);
86
+ return match;
87
+ }
88
+ resolvedDimensions.push(name);
89
+ return `${dim.sql} AS ${sanitizeAlias(name)}`;
90
+ });
91
+ // Second pass: fix GROUP BY / ORDER BY / WHERE / HAVING clauses
92
+ // In these clauses, we should use just the raw SQL without alias
93
+ const fixedSql = fixClauseRefs(resolvedSql, semanticLayer);
94
+ return {
95
+ resolvedSql: fixedSql,
96
+ resolvedMetrics,
97
+ resolvedDimensions,
98
+ unresolvedRefs,
99
+ };
100
+ }
101
+ function resolveStandaloneSemanticRef(refType, name, semanticLayer, options) {
102
+ if (refType === 'metric') {
103
+ const metric = semanticLayer.getMetric(name);
104
+ if (!metric)
105
+ return unresolvedStandalone(`metric:${name}`, `@metric(${name})`);
106
+ const composed = composeStandaloneMetric(metric, semanticLayer, options?.tableMapping);
107
+ if (!composed) {
108
+ return unresolvedStandalone(`metric:${name} (requires a full semantic query or MetricFlow)`, `@metric(${name})`);
109
+ }
110
+ return {
111
+ resolvedSql: composed,
112
+ resolvedMetrics: [name],
113
+ resolvedDimensions: [],
114
+ unresolvedRefs: [],
115
+ };
116
+ }
117
+ const dimension = semanticLayer.getDimension(name);
118
+ if (!dimension?.table || !dimension.sql.trim()) {
119
+ return unresolvedStandalone(`dimension:${name}`, `@dim(${name})`);
120
+ }
121
+ const limit = clampStandaloneDimensionLimit(options?.standaloneDimensionLimit);
122
+ const table = options?.tableMapping?.[dimension.table] ?? dimension.table;
123
+ const alias = sanitizeAlias(name);
124
+ const tableAlias = sanitizeAlias(dimension.table.split('.').pop() ?? dimension.table);
125
+ const expression = qualifyDimensionExpression(dimension, tableAlias);
126
+ return {
127
+ resolvedSql: [
128
+ `SELECT DISTINCT ${expression} AS ${alias}`,
129
+ `FROM ${table} AS ${tableAlias}`,
130
+ `ORDER BY ${alias}`,
131
+ `LIMIT ${limit}`,
132
+ ].join('\n'),
133
+ resolvedMetrics: [],
134
+ resolvedDimensions: [name],
135
+ unresolvedRefs: [],
136
+ };
137
+ }
138
+ function composeStandaloneMetric(metric, semanticLayer, tableMapping) {
139
+ return semanticLayer.composeQuery({
140
+ metrics: [metric.name],
141
+ dimensions: [],
142
+ tableMapping,
143
+ })?.sql ?? null;
144
+ }
145
+ function qualifyDimensionExpression(dimension, tableAlias) {
146
+ if (!tableAlias)
147
+ return dimension.sql;
148
+ const prefix = `${dimension.table}.`;
149
+ return dimension.sql.startsWith(prefix)
150
+ ? `${tableAlias}.${dimension.sql.slice(prefix.length)}`
151
+ : dimension.sql;
152
+ }
153
+ function clampStandaloneDimensionLimit(value) {
154
+ if (!Number.isFinite(value))
155
+ return 200;
156
+ return Math.max(1, Math.min(1000, Math.trunc(value)));
157
+ }
158
+ function unresolvedStandalone(ref, sql) {
159
+ return {
160
+ resolvedSql: sql,
161
+ resolvedMetrics: [],
162
+ resolvedDimensions: [],
163
+ unresolvedRefs: [ref],
164
+ };
165
+ }
166
+ /**
167
+ * In GROUP BY, ORDER BY, WHERE, HAVING clauses, replace "expr AS alias" with just "expr".
168
+ * This is needed because SQL doesn't allow aliases in GROUP BY for most databases.
169
+ */
170
+ function fixClauseRefs(sql, semanticLayer) {
171
+ // Find all "expression AS alias" patterns that appear after GROUP BY, ORDER BY, WHERE, HAVING
172
+ const clausePattern = /\b(GROUP\s+BY|ORDER\s+BY|WHERE|HAVING)\b/gi;
173
+ const match = clausePattern.exec(sql);
174
+ if (!match)
175
+ return sql;
176
+ const clauseStart = match.index;
177
+ const beforeClause = sql.substring(0, clauseStart);
178
+ const clauseAndAfter = sql.substring(clauseStart);
179
+ // In the clause portion, strip " AS alias" from resolved refs
180
+ const fixed = clauseAndAfter.replace(/(\S+)\s+AS\s+([a-zA-Z_][a-zA-Z0-9_]*)/g, (_m, expr, _alias) => {
181
+ return expr;
182
+ });
183
+ return beforeClause + fixed;
184
+ }
185
+ /**
186
+ * Sanitize a name to be a valid SQL alias.
187
+ */
188
+ function sanitizeAlias(name) {
189
+ return name.replace(/\./g, '_').replace(/[^a-zA-Z0-9_]/g, '');
190
+ }
191
+ /**
192
+ * Get a list of available semantic references for autocomplete.
193
+ */
194
+ export function getSemanticRefCompletions(semanticLayer) {
195
+ if (!semanticLayer)
196
+ return [];
197
+ const completions = [];
198
+ for (const metric of semanticLayer.listMetrics()) {
199
+ completions.push({
200
+ type: 'metric',
201
+ name: metric.name,
202
+ label: metric.label,
203
+ description: metric.description ?? '',
204
+ });
205
+ }
206
+ for (const dim of semanticLayer.listDimensions()) {
207
+ completions.push({
208
+ type: 'dimension',
209
+ name: dim.name,
210
+ label: dim.label,
211
+ description: dim.description ?? '',
212
+ });
213
+ }
214
+ return completions;
215
+ }
216
+ //# sourceMappingURL=semantic-refs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"semantic-refs.js","sourceRoot":"","sources":["../src/semantic-refs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH,+DAA+D;AAC/D,MAAM,oBAAoB,GAAG,6DAA6D,CAAC;AAC3F,MAAM,+BAA+B,GAAG,yEAAyE,CAAC;AAoBlH;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,4EAA4E;IAC5E,6EAA6E;IAC7E,OAAO,0DAA0D,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC9E,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,wBAAwB,CAAC,GAAW;IAClD,OAAO,+BAA+B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnD,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CACjC,GAAW,EACX,aAAwC,EACxC,OAAsC;IAEtC,MAAM,eAAe,GAAa,EAAE,CAAC;IACrC,MAAM,kBAAkB,GAAa,EAAE,CAAC;IACxC,MAAM,cAAc,GAAa,EAAE,CAAC;IAEpC,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,kEAAkE;QAClE,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACxD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChB,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,OAAO;gBACL,WAAW,EAAE,GAAG;gBAChB,eAAe,EAAE,EAAE;gBACnB,kBAAkB,EAAE,EAAE;gBACtB,cAAc,EAAE,IAAI;aACrB,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,EAAE,EAAE,EAAE,kBAAkB,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;IAC/F,CAAC;IAED,0EAA0E;IAC1E,wEAAwE;IACxE,4EAA4E;IAC5E,2EAA2E;IAC3E,6EAA6E;IAC7E,iBAAiB;IACjB,MAAM,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAC9D,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,4BAA4B,CACjC,UAAU,CAAC,CAAC,CAAmC,EAC/C,UAAU,CAAC,CAAC,CAAC,EACb,aAAa,EACb,OAAO,CACR,CAAC;IACJ,CAAC;IAED,gFAAgF;IAChF,wEAAwE;IACxE,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC,KAAK,EAAE,OAAe,EAAE,IAAY,EAAE,EAAE;QAC7F,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;YACzB,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,cAAc,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;gBACtC,OAAO,KAAK,CAAC;YACf,CAAC;YACD,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3B,qDAAqD;YACrD,uDAAuD;YACvD,wFAAwF;YACxF,OAAO,GAAG,MAAM,CAAC,GAAG,OAAO,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACnD,CAAC;QAED,mBAAmB;QACnB,MAAM,GAAG,GAAG,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,cAAc,CAAC,IAAI,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC;YACzC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,GAAG,GAAG,CAAC,GAAG,OAAO,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,gEAAgE;IAChE,iEAAiE;IACjE,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAE3D,OAAO;QACL,WAAW,EAAE,QAAQ;QACrB,eAAe;QACf,kBAAkB;QAClB,cAAc;KACf,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,CACnC,OAAuC,EACvC,IAAY,EACZ,aAA4B,EAC5B,OAAsC;IAEtC,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM;YAAE,OAAO,oBAAoB,CAAC,UAAU,IAAI,EAAE,EAAE,WAAW,IAAI,GAAG,CAAC,CAAC;QAE/E,MAAM,QAAQ,GAAG,uBAAuB,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;QACvF,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,oBAAoB,CACzB,UAAU,IAAI,iDAAiD,EAC/D,WAAW,IAAI,GAAG,CACnB,CAAC;QACJ,CAAC;QACD,OAAO;YACL,WAAW,EAAE,QAAQ;YACrB,eAAe,EAAE,CAAC,IAAI,CAAC;YACvB,kBAAkB,EAAE,EAAE;YACtB,cAAc,EAAE,EAAE;SACnB,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACnD,IAAI,CAAC,SAAS,EAAE,KAAK,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;QAC/C,OAAO,oBAAoB,CAAC,aAAa,IAAI,EAAE,EAAE,QAAQ,IAAI,GAAG,CAAC,CAAC;IACpE,CAAC;IACD,MAAM,KAAK,GAAG,6BAA6B,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;IAC/E,MAAM,KAAK,GAAG,OAAO,EAAE,YAAY,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC;IAC1E,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAClC,MAAM,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;IACtF,MAAM,UAAU,GAAG,0BAA0B,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACrE,OAAO;QACL,WAAW,EAAE;YACX,mBAAmB,UAAU,OAAO,KAAK,EAAE;YAC3C,QAAQ,KAAK,OAAO,UAAU,EAAE;YAChC,YAAY,KAAK,EAAE;YACnB,SAAS,KAAK,EAAE;SACjB,CAAC,IAAI,CAAC,IAAI,CAAC;QACZ,eAAe,EAAE,EAAE;QACnB,kBAAkB,EAAE,CAAC,IAAI,CAAC;QAC1B,cAAc,EAAE,EAAE;KACnB,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAC9B,MAAwB,EACxB,aAA4B,EAC5B,YAAqC;IAErC,OAAO,aAAa,CAAC,YAAY,CAAC;QAChC,OAAO,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;QACtB,UAAU,EAAE,EAAE;QACd,YAAY;KACb,CAAC,EAAE,GAAG,IAAI,IAAI,CAAC;AAClB,CAAC;AAED,SAAS,0BAA0B,CAAC,SAA8B,EAAE,UAAkB;IACpF,IAAI,CAAC,UAAU;QAAE,OAAO,SAAS,CAAC,GAAG,CAAC;IACtC,MAAM,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,GAAG,CAAC;IACrC,OAAO,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC;QACrC,CAAC,CAAC,GAAG,UAAU,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;QACvD,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;AACpB,CAAC;AAED,SAAS,6BAA6B,CAAC,KAAyB;IAC9D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC;IACxC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,oBAAoB,CAAC,GAAW,EAAE,GAAW;IACpD,OAAO;QACL,WAAW,EAAE,GAAG;QAChB,eAAe,EAAE,EAAE;QACnB,kBAAkB,EAAE,EAAE;QACtB,cAAc,EAAE,CAAC,GAAG,CAAC;KACtB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CAAC,GAAW,EAAE,aAA4B;IAC9D,8FAA8F;IAC9F,MAAM,aAAa,GAAG,4CAA4C,CAAC;IACnE,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,CAAC,KAAK;QAAE,OAAO,GAAG,CAAC;IAEvB,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC;IAChC,MAAM,YAAY,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;IACnD,MAAM,cAAc,GAAG,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAElD,8DAA8D;IAC9D,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,wCAAwC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;QAClG,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IAEH,OAAO,YAAY,GAAG,KAAK,CAAC;AAC9B,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,IAAY;IACjC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;AAChE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB,CACvC,aAAwC;IAExC,IAAI,CAAC,aAAa;QAAE,OAAO,EAAE,CAAC;IAE9B,MAAM,WAAW,GAA8F,EAAE,CAAC;IAElH,KAAK,MAAM,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,EAAE,CAAC;QACjD,WAAW,CAAC,IAAI,CAAC;YACf,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,EAAE;SACtC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,aAAa,CAAC,cAAc,EAAE,EAAE,CAAC;QACjD,WAAW,CAAC,IAAI,CAAC;YACf,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,WAAW,EAAE,GAAG,CAAC,WAAW,IAAI,EAAE;SACnC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC"}