@katerai/sdk 0.10.0 → 0.11.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/CHANGELOG.md +31 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts.map +1 -1
- package/client.js +7 -0
- package/client.js.map +1 -1
- package/client.mjs +7 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/v1/compiler/cache.d.mts +0 -35
- package/resources/v1/compiler/cache.d.mts.map +1 -1
- package/resources/v1/compiler/cache.d.ts +0 -35
- package/resources/v1/compiler/cache.d.ts.map +1 -1
- package/resources/v1/compiler/cache.js +0 -9
- package/resources/v1/compiler/cache.js.map +1 -1
- package/resources/v1/compiler/cache.mjs +0 -9
- package/resources/v1/compiler/cache.mjs.map +1 -1
- package/resources/v1/compiler/combination.d.mts +120 -0
- package/resources/v1/compiler/combination.d.mts.map +1 -0
- package/resources/v1/compiler/combination.d.ts +120 -0
- package/resources/v1/compiler/combination.d.ts.map +1 -0
- package/resources/v1/compiler/combination.js +30 -0
- package/resources/v1/compiler/combination.js.map +1 -0
- package/resources/v1/compiler/combination.mjs +26 -0
- package/resources/v1/compiler/combination.mjs.map +1 -0
- package/resources/v1/compiler/compiler.d.mts +482 -84
- package/resources/v1/compiler/compiler.d.mts.map +1 -1
- package/resources/v1/compiler/compiler.d.ts +482 -84
- package/resources/v1/compiler/compiler.d.ts.map +1 -1
- package/resources/v1/compiler/compiler.js +26 -0
- package/resources/v1/compiler/compiler.js.map +1 -1
- package/resources/v1/compiler/compiler.mjs +26 -0
- package/resources/v1/compiler/compiler.mjs.map +1 -1
- package/resources/v1/compiler/index.d.mts +4 -2
- package/resources/v1/compiler/index.d.mts.map +1 -1
- package/resources/v1/compiler/index.d.ts +4 -2
- package/resources/v1/compiler/index.d.ts.map +1 -1
- package/resources/v1/compiler/index.js +3 -1
- package/resources/v1/compiler/index.js.map +1 -1
- package/resources/v1/compiler/index.mjs +1 -0
- package/resources/v1/compiler/index.mjs.map +1 -1
- package/resources/v1/compiler/manifest.d.mts +52 -0
- package/resources/v1/compiler/manifest.d.mts.map +1 -0
- package/resources/v1/compiler/manifest.d.ts +52 -0
- package/resources/v1/compiler/manifest.d.ts.map +1 -0
- package/resources/v1/compiler/manifest.js +29 -0
- package/resources/v1/compiler/manifest.js.map +1 -0
- package/resources/v1/compiler/manifest.mjs +25 -0
- package/resources/v1/compiler/manifest.mjs.map +1 -0
- package/resources/v1/index.d.mts +1 -1
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +1 -1
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/tenants/tenants.d.mts +66 -10
- package/resources/v1/tenants/tenants.d.mts.map +1 -1
- package/resources/v1/tenants/tenants.d.ts +66 -10
- package/resources/v1/tenants/tenants.d.ts.map +1 -1
- package/resources/v1/tenants/tenants.js +27 -4
- package/resources/v1/tenants/tenants.js.map +1 -1
- package/resources/v1/tenants/tenants.mjs +27 -4
- package/resources/v1/tenants/tenants.mjs.map +1 -1
- package/resources/v1/v1.d.mts +2 -2
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +2 -2
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs.map +1 -1
- package/src/client.ts +8 -0
- package/src/resources/v1/compiler/cache.ts +1 -47
- package/src/resources/v1/compiler/combination.ts +157 -0
- package/src/resources/v1/compiler/compiler.ts +633 -190
- package/src/resources/v1/compiler/index.ts +8 -1
- package/src/resources/v1/compiler/manifest.ts +80 -0
- package/src/resources/v1/index.ts +2 -0
- package/src/resources/v1/tenants/tenants.ts +99 -12
- package/src/resources/v1/v1.ts +4 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.mjs";
|
|
2
2
|
import * as CompilerAPI from "./compiler.mjs";
|
|
3
3
|
import * as CacheAPI from "./cache.mjs";
|
|
4
|
-
import { Cache
|
|
4
|
+
import { Cache } from "./cache.mjs";
|
|
5
|
+
import * as CombinationAPI from "./combination.mjs";
|
|
6
|
+
import { Combination as CombinationAPICombination, CombinationPreviewParams, CombinationPreviewResponse } from "./combination.mjs";
|
|
7
|
+
import * as ManifestAPI from "./manifest.mjs";
|
|
8
|
+
import { ManifestRegenerateAndCreatePrParams, ManifestRegenerateAndCreatePrResponse } from "./manifest.mjs";
|
|
5
9
|
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
6
10
|
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
7
11
|
export declare class Compiler extends APIResource {
|
|
8
12
|
cache: CacheAPI.Cache;
|
|
13
|
+
combination: CombinationAPI.Combination;
|
|
14
|
+
manifest: ManifestAPI.Manifest;
|
|
9
15
|
/**
|
|
10
16
|
* Compile a resolved query to SQL.
|
|
11
17
|
*
|
|
@@ -15,6 +21,15 @@ export declare class Compiler extends APIResource {
|
|
|
15
21
|
* RLS: Filtered to current client (ClientRLSDB).
|
|
16
22
|
*/
|
|
17
23
|
compile(params: CompilerCompileParams, options?: RequestOptions): APIPromise<CompilerCompileResponse>;
|
|
24
|
+
/**
|
|
25
|
+
* Compile a dashboard YAML file into fully resolved widget data.
|
|
26
|
+
*
|
|
27
|
+
* Reads a dashboard YAML from the client repo, resolves all data slots, executes
|
|
28
|
+
* queries, applies filters, and returns renderable widget data.
|
|
29
|
+
*
|
|
30
|
+
* RLS: Filtered to current client (ClientRLSDB).
|
|
31
|
+
*/
|
|
32
|
+
compileDashboard(params: CompilerCompileDashboardParams, options?: RequestOptions): APIPromise<CompilerCompileDashboardResponse>;
|
|
18
33
|
/**
|
|
19
34
|
* Enumerate every valid query configuration for a connection.
|
|
20
35
|
*
|
|
@@ -215,6 +230,10 @@ export interface CompilerCompileResponse {
|
|
|
215
230
|
* Compilation metadata from the compiler.
|
|
216
231
|
*/
|
|
217
232
|
metadata?: CompilerCompileResponse.Metadata | null;
|
|
233
|
+
/**
|
|
234
|
+
* Write-back request ID. Non-null when files were dispatched to CLI via WebSocket.
|
|
235
|
+
*/
|
|
236
|
+
request_id?: string | null;
|
|
218
237
|
/**
|
|
219
238
|
* Generated SQL statement
|
|
220
239
|
*/
|
|
@@ -277,6 +296,244 @@ export declare namespace CompilerCompileResponse {
|
|
|
277
296
|
views_used?: Array<string>;
|
|
278
297
|
}
|
|
279
298
|
}
|
|
299
|
+
/**
|
|
300
|
+
* Response from dashboard compilation — fully resolved dashboard.
|
|
301
|
+
*/
|
|
302
|
+
export interface CompilerCompileDashboardResponse {
|
|
303
|
+
/**
|
|
304
|
+
* Dashboard context for widgets
|
|
305
|
+
*/
|
|
306
|
+
context: CompilerCompileDashboardResponse.Context;
|
|
307
|
+
/**
|
|
308
|
+
* Dashboard metadata
|
|
309
|
+
*/
|
|
310
|
+
dashboard: CompilerCompileDashboardResponse.Dashboard;
|
|
311
|
+
/**
|
|
312
|
+
* Dashboard-level compilation errors
|
|
313
|
+
*/
|
|
314
|
+
errors?: Array<CompilerErrorItem>;
|
|
315
|
+
/**
|
|
316
|
+
* Resolved filter definitions with current values
|
|
317
|
+
*/
|
|
318
|
+
filters?: Array<CompilerCompileDashboardResponse.Filter>;
|
|
319
|
+
/**
|
|
320
|
+
* Fully resolved widgets with data + config
|
|
321
|
+
*/
|
|
322
|
+
widgets?: Array<CompilerCompileDashboardResponse.Widget>;
|
|
323
|
+
}
|
|
324
|
+
export declare namespace CompilerCompileDashboardResponse {
|
|
325
|
+
/**
|
|
326
|
+
* Dashboard context for widgets
|
|
327
|
+
*/
|
|
328
|
+
interface Context {
|
|
329
|
+
/**
|
|
330
|
+
* Active filter values: {name: {value, label}}
|
|
331
|
+
*/
|
|
332
|
+
filters?: {
|
|
333
|
+
[key: string]: {
|
|
334
|
+
[key: string]: unknown;
|
|
335
|
+
};
|
|
336
|
+
} | null;
|
|
337
|
+
/**
|
|
338
|
+
* Active timeframe: {label, start, end}
|
|
339
|
+
*/
|
|
340
|
+
timeframe?: {
|
|
341
|
+
[key: string]: string;
|
|
342
|
+
} | null;
|
|
343
|
+
/**
|
|
344
|
+
* Dashboard topic: {label, time_dimension}
|
|
345
|
+
*/
|
|
346
|
+
topic?: {
|
|
347
|
+
[key: string]: string;
|
|
348
|
+
} | null;
|
|
349
|
+
}
|
|
350
|
+
/**
|
|
351
|
+
* Dashboard metadata
|
|
352
|
+
*/
|
|
353
|
+
interface Dashboard {
|
|
354
|
+
/**
|
|
355
|
+
* Dashboard name
|
|
356
|
+
*/
|
|
357
|
+
name: string;
|
|
358
|
+
/**
|
|
359
|
+
* Dashboard description
|
|
360
|
+
*/
|
|
361
|
+
description?: string | null;
|
|
362
|
+
/**
|
|
363
|
+
* Dashboard kater_id
|
|
364
|
+
*/
|
|
365
|
+
kater_id?: string | null;
|
|
366
|
+
/**
|
|
367
|
+
* Dashboard display label
|
|
368
|
+
*/
|
|
369
|
+
label?: string | null;
|
|
370
|
+
/**
|
|
371
|
+
* Dashboard topic reference
|
|
372
|
+
*/
|
|
373
|
+
topic?: string | null;
|
|
374
|
+
}
|
|
375
|
+
/**
|
|
376
|
+
* A resolved dashboard filter with current value and presets.
|
|
377
|
+
*/
|
|
378
|
+
interface Filter {
|
|
379
|
+
/**
|
|
380
|
+
* Filter type: date_range, multi_select, select
|
|
381
|
+
*/
|
|
382
|
+
filter_type: string;
|
|
383
|
+
/**
|
|
384
|
+
* Filter name
|
|
385
|
+
*/
|
|
386
|
+
name: string;
|
|
387
|
+
/**
|
|
388
|
+
* Whether null (All) is allowed
|
|
389
|
+
*/
|
|
390
|
+
allow_null?: boolean;
|
|
391
|
+
/**
|
|
392
|
+
* Whether filter auto-applies to queries
|
|
393
|
+
*/
|
|
394
|
+
auto_apply?: boolean;
|
|
395
|
+
/**
|
|
396
|
+
* Current filter value
|
|
397
|
+
*/
|
|
398
|
+
current_value?: string | Array<string> | null;
|
|
399
|
+
/**
|
|
400
|
+
* Default value specification
|
|
401
|
+
*/
|
|
402
|
+
default?: {
|
|
403
|
+
[key: string]: string;
|
|
404
|
+
} | null;
|
|
405
|
+
/**
|
|
406
|
+
* Field reference for data-driven filters
|
|
407
|
+
*/
|
|
408
|
+
field?: string | null;
|
|
409
|
+
/**
|
|
410
|
+
* Label for null/All option
|
|
411
|
+
*/
|
|
412
|
+
null_label?: string | null;
|
|
413
|
+
/**
|
|
414
|
+
* Available presets
|
|
415
|
+
*/
|
|
416
|
+
presets?: Array<{
|
|
417
|
+
[key: string]: string;
|
|
418
|
+
}> | null;
|
|
419
|
+
}
|
|
420
|
+
/**
|
|
421
|
+
* A fully resolved widget ready for rendering.
|
|
422
|
+
*/
|
|
423
|
+
interface Widget {
|
|
424
|
+
/**
|
|
425
|
+
* Column metadata (single or multi-query)
|
|
426
|
+
*/
|
|
427
|
+
column_map: Array<Widget.UnionMember0> | Array<Array<Widget.UnionMember1>>;
|
|
428
|
+
/**
|
|
429
|
+
* Fully resolved WidgetConfig
|
|
430
|
+
*/
|
|
431
|
+
config: {
|
|
432
|
+
[key: string]: unknown;
|
|
433
|
+
};
|
|
434
|
+
/**
|
|
435
|
+
* Query result data (single or multi-query)
|
|
436
|
+
*/
|
|
437
|
+
data: Array<{
|
|
438
|
+
[key: string]: unknown;
|
|
439
|
+
}> | Array<Array<{
|
|
440
|
+
[key: string]: unknown;
|
|
441
|
+
}>>;
|
|
442
|
+
/**
|
|
443
|
+
* Grid position
|
|
444
|
+
*/
|
|
445
|
+
grid: Widget.Grid;
|
|
446
|
+
/**
|
|
447
|
+
* Widget unique identifier
|
|
448
|
+
*/
|
|
449
|
+
kater_id: string;
|
|
450
|
+
/**
|
|
451
|
+
* Widget name
|
|
452
|
+
*/
|
|
453
|
+
name: string;
|
|
454
|
+
/**
|
|
455
|
+
* Display mode for multi-query: 'tabs' or 'grid'
|
|
456
|
+
*/
|
|
457
|
+
display_mode?: string | null;
|
|
458
|
+
/**
|
|
459
|
+
* Per-widget compilation errors
|
|
460
|
+
*/
|
|
461
|
+
errors?: Array<CompilerAPI.CompilerErrorItem>;
|
|
462
|
+
/**
|
|
463
|
+
* Per-slot configs for multi-query containers
|
|
464
|
+
*/
|
|
465
|
+
slot_configs?: Array<{
|
|
466
|
+
[key: string]: unknown;
|
|
467
|
+
}> | null;
|
|
468
|
+
/**
|
|
469
|
+
* Resolved widget type
|
|
470
|
+
*/
|
|
471
|
+
widget_type?: string | null;
|
|
472
|
+
}
|
|
473
|
+
namespace Widget {
|
|
474
|
+
/**
|
|
475
|
+
* Maps a UUID column alias to its human-readable name and type.
|
|
476
|
+
*/
|
|
477
|
+
interface UnionMember0 {
|
|
478
|
+
/**
|
|
479
|
+
* Field type: dimension, measure, or calculation
|
|
480
|
+
*/
|
|
481
|
+
field_type: string;
|
|
482
|
+
/**
|
|
483
|
+
* UUID string used as SQL column alias
|
|
484
|
+
*/
|
|
485
|
+
kater_id: string;
|
|
486
|
+
/**
|
|
487
|
+
* Human-readable column name
|
|
488
|
+
*/
|
|
489
|
+
name: string;
|
|
490
|
+
/**
|
|
491
|
+
* Aggregation type for measures: sum, count, min, max, avg, unknown. None for
|
|
492
|
+
* non-measures.
|
|
493
|
+
*/
|
|
494
|
+
aggregation?: string | null;
|
|
495
|
+
/**
|
|
496
|
+
* Display label
|
|
497
|
+
*/
|
|
498
|
+
label?: string | null;
|
|
499
|
+
}
|
|
500
|
+
/**
|
|
501
|
+
* Maps a UUID column alias to its human-readable name and type.
|
|
502
|
+
*/
|
|
503
|
+
interface UnionMember1 {
|
|
504
|
+
/**
|
|
505
|
+
* Field type: dimension, measure, or calculation
|
|
506
|
+
*/
|
|
507
|
+
field_type: string;
|
|
508
|
+
/**
|
|
509
|
+
* UUID string used as SQL column alias
|
|
510
|
+
*/
|
|
511
|
+
kater_id: string;
|
|
512
|
+
/**
|
|
513
|
+
* Human-readable column name
|
|
514
|
+
*/
|
|
515
|
+
name: string;
|
|
516
|
+
/**
|
|
517
|
+
* Aggregation type for measures: sum, count, min, max, avg, unknown. None for
|
|
518
|
+
* non-measures.
|
|
519
|
+
*/
|
|
520
|
+
aggregation?: string | null;
|
|
521
|
+
/**
|
|
522
|
+
* Display label
|
|
523
|
+
*/
|
|
524
|
+
label?: string | null;
|
|
525
|
+
}
|
|
526
|
+
/**
|
|
527
|
+
* Grid position
|
|
528
|
+
*/
|
|
529
|
+
interface Grid {
|
|
530
|
+
h?: number;
|
|
531
|
+
w?: number;
|
|
532
|
+
x?: number;
|
|
533
|
+
y?: number;
|
|
534
|
+
}
|
|
535
|
+
}
|
|
536
|
+
}
|
|
280
537
|
/**
|
|
281
538
|
* Response model for query combination enumeration.
|
|
282
539
|
*/
|
|
@@ -303,10 +560,20 @@ export declare namespace CompilerEnumerateResponse {
|
|
|
303
560
|
* Widget category (e.g. 'axis', 'table')
|
|
304
561
|
*/
|
|
305
562
|
widget_category: string;
|
|
563
|
+
/**
|
|
564
|
+
* Deterministic UUID v5 for this combination
|
|
565
|
+
*/
|
|
566
|
+
combination_id?: string | null;
|
|
306
567
|
/**
|
|
307
568
|
* Human-readable label for the query
|
|
308
569
|
*/
|
|
309
570
|
query_label?: string | null;
|
|
571
|
+
/**
|
|
572
|
+
* Field-to-role mapping (e.g. {'due_month': 'x_axis'})
|
|
573
|
+
*/
|
|
574
|
+
roles?: {
|
|
575
|
+
[key: string]: string;
|
|
576
|
+
};
|
|
310
577
|
/**
|
|
311
578
|
* Selected optional calculation names
|
|
312
579
|
*/
|
|
@@ -329,6 +596,10 @@ export declare namespace CompilerEnumerateResponse {
|
|
|
329
596
|
variable_assignments?: {
|
|
330
597
|
[key: string]: unknown;
|
|
331
598
|
};
|
|
599
|
+
/**
|
|
600
|
+
* Resolved widget type (e.g. 'axis_metric_by_dimensiondate')
|
|
601
|
+
*/
|
|
602
|
+
widget_type?: string | null;
|
|
332
603
|
}
|
|
333
604
|
}
|
|
334
605
|
/**
|
|
@@ -451,6 +722,15 @@ export interface CompilerResolveResponse {
|
|
|
451
722
|
* Compilation manifest with all named objects.
|
|
452
723
|
*/
|
|
453
724
|
manifest?: Manifest | null;
|
|
725
|
+
/**
|
|
726
|
+
* Files auto-fixed due to renamed refs. None when no renames detected.
|
|
727
|
+
*/
|
|
728
|
+
ref_fixes?: Array<CompilerResolveResponse.RefFix> | null;
|
|
729
|
+
/**
|
|
730
|
+
* Write-back request ID. Non-null when ref-fix files were dispatched to CLI via
|
|
731
|
+
* WebSocket.
|
|
732
|
+
*/
|
|
733
|
+
request_id?: string | null;
|
|
454
734
|
}
|
|
455
735
|
export declare namespace CompilerResolveResponse {
|
|
456
736
|
/**
|
|
@@ -477,7 +757,7 @@ export declare namespace CompilerResolveResponse {
|
|
|
477
757
|
/**
|
|
478
758
|
* Widget category that determines data shape constraints
|
|
479
759
|
*/
|
|
480
|
-
widget_category: 'axis' | '
|
|
760
|
+
widget_category: 'axis' | 'funnel' | 'heatmap' | 'image' | 'kpi_card' | 'pie' | 'table' | 'text';
|
|
481
761
|
/**
|
|
482
762
|
* Usage guidance for AI processing
|
|
483
763
|
*/
|
|
@@ -507,11 +787,11 @@ export declare namespace CompilerResolveResponse {
|
|
|
507
787
|
/**
|
|
508
788
|
* Widget types within the declared widget_category that must NOT render this query
|
|
509
789
|
*/
|
|
510
|
-
disallowed_widget_types?: Array<'
|
|
790
|
+
disallowed_widget_types?: Array<'axis_metric_by_dimension' | 'axis_metric_by_dimensiondate' | 'axis_metric_by_dimensiondate_sliced_by_dimension' | 'axis_scatter_plot' | 'funnel_funnel_chart' | 'heatmap_heatmap' | 'image_image_grid' | 'image_single_image' | 'kpi_measure_with_dimension_expression' | 'kpi_measure_with_secondary_metric' | 'kpi_single_measure_compared_to_prev_period_sparkline' | 'kpi_single_value' | 'pie_pie_chart' | 'table_data_table' | 'table_fancy_subtotal_table' | 'table_key_value_list' | 'table_styled_table' | 'text_data_readout_with_sparkline' | 'text_narrative_text'> | null;
|
|
511
791
|
/**
|
|
512
792
|
* Merged required + selected optional filters
|
|
513
793
|
*/
|
|
514
|
-
filters?: Array<ResolvedQuery.
|
|
794
|
+
filters?: Array<ResolvedQuery.InlineFormulaFilter | string | ResolvedQuery.InlineExistsFilter1 | ResolvedQuery.InlineExistsFilter2> | null;
|
|
515
795
|
/**
|
|
516
796
|
* Ordered list of query refs that were merged during inheritance resolution
|
|
517
797
|
*/
|
|
@@ -533,10 +813,6 @@ export declare namespace CompilerResolveResponse {
|
|
|
533
813
|
* (highest/newest first) and asc for ascending (lowest/oldest first).
|
|
534
814
|
*/
|
|
535
815
|
order_by?: ResolvedQuery.OrderBy | null;
|
|
536
|
-
/**
|
|
537
|
-
* Access grants required to use this query
|
|
538
|
-
*/
|
|
539
|
-
required_access_grants?: Array<string> | null;
|
|
540
816
|
/**
|
|
541
817
|
* The matched chart recommendation after evaluating chart hints
|
|
542
818
|
*/
|
|
@@ -590,29 +866,17 @@ export declare namespace CompilerResolveResponse {
|
|
|
590
866
|
}
|
|
591
867
|
}
|
|
592
868
|
/**
|
|
593
|
-
* An inline filter using
|
|
869
|
+
* An inline filter using a SQL/expression formula
|
|
594
870
|
*/
|
|
595
|
-
interface
|
|
596
|
-
/**
|
|
597
|
-
* Reference to the field to filter on
|
|
598
|
-
*/
|
|
599
|
-
field: string;
|
|
871
|
+
interface InlineFormulaFilter {
|
|
600
872
|
/**
|
|
601
873
|
* Name of the inline filter
|
|
602
874
|
*/
|
|
603
875
|
name: string;
|
|
604
876
|
/**
|
|
605
|
-
*
|
|
606
|
-
*/
|
|
607
|
-
operator: 'equals' | 'not_equals' | 'in' | 'not_in' | 'greater_than' | 'less_than' | 'greater_than_or_equals' | 'less_than_or_equals' | 'between' | 'in_the_last' | 'in_the_next' | 'contains' | 'not_contains' | 'starts_with' | 'ends_with' | 'is_null' | 'is_not_null';
|
|
608
|
-
/**
|
|
609
|
-
* SQL expression for the filter value
|
|
877
|
+
* SQL expression for the filter condition
|
|
610
878
|
*/
|
|
611
|
-
|
|
612
|
-
/**
|
|
613
|
-
* Fixed values for the filter
|
|
614
|
-
*/
|
|
615
|
-
static_values?: Array<string | number | boolean> | null;
|
|
879
|
+
sql: string;
|
|
616
880
|
}
|
|
617
881
|
/**
|
|
618
882
|
* An inline filter using EXISTS or NOT EXISTS with a subquery
|
|
@@ -698,11 +962,15 @@ export declare namespace CompilerResolveResponse {
|
|
|
698
962
|
/**
|
|
699
963
|
* The concrete value bound for this resolution
|
|
700
964
|
*/
|
|
701
|
-
bound_value: string | number | boolean
|
|
965
|
+
bound_value: string | number | boolean | Array<string | number | boolean>;
|
|
702
966
|
/**
|
|
703
967
|
* Default value for this variable
|
|
704
968
|
*/
|
|
705
|
-
default: string | number | boolean
|
|
969
|
+
default: string | number | boolean | Array<string | number | boolean>;
|
|
970
|
+
/**
|
|
971
|
+
* Unique identifier for this variable
|
|
972
|
+
*/
|
|
973
|
+
kater_id: string;
|
|
706
974
|
/**
|
|
707
975
|
* Variable name identifier
|
|
708
976
|
*/
|
|
@@ -710,7 +978,7 @@ export declare namespace CompilerResolveResponse {
|
|
|
710
978
|
/**
|
|
711
979
|
* Data type of the variable
|
|
712
980
|
*/
|
|
713
|
-
type: 'STRING' | 'INT' | 'FLOAT' | 'DATE' | 'TIMESTAMP' | 'BOOL' | 'DIMENSION' | 'MEASURE' | 'CALCULATION' | 'FILTER';
|
|
981
|
+
type: 'STRING' | 'INT' | 'FLOAT' | 'DATE' | 'TIMESTAMP' | 'BOOL' | 'STRING[]' | 'INT[]' | 'FLOAT[]' | 'DATE[]' | 'DIMENSION' | 'MEASURE' | 'CALCULATION' | 'FILTER';
|
|
714
982
|
/**
|
|
715
983
|
* Allowed values configuration
|
|
716
984
|
*/
|
|
@@ -727,6 +995,12 @@ export declare namespace CompilerResolveResponse {
|
|
|
727
995
|
* True if bound_value equals the default value
|
|
728
996
|
*/
|
|
729
997
|
is_default?: boolean | null;
|
|
998
|
+
/**
|
|
999
|
+
* True if this is a runtime variable (not resolved at compile time). Runtime
|
|
1000
|
+
* variables have var() placeholders left in compiled SQL for literal substitution
|
|
1001
|
+
* at execution time.
|
|
1002
|
+
*/
|
|
1003
|
+
is_runtime?: boolean | null;
|
|
730
1004
|
/**
|
|
731
1005
|
* Human-readable label for the variable
|
|
732
1006
|
*/
|
|
@@ -839,7 +1113,7 @@ export declare namespace CompilerResolveResponse {
|
|
|
839
1113
|
/**
|
|
840
1114
|
* Original type of the field in the source query
|
|
841
1115
|
*/
|
|
842
|
-
source_type: 'dimension' | 'measure' | 'calculation';
|
|
1116
|
+
source_type: 'dimension' | 'dimension_date' | 'measure' | 'calculation';
|
|
843
1117
|
}
|
|
844
1118
|
}
|
|
845
1119
|
}
|
|
@@ -893,6 +1167,46 @@ export declare namespace CompilerResolveResponse {
|
|
|
893
1167
|
column?: number;
|
|
894
1168
|
}
|
|
895
1169
|
}
|
|
1170
|
+
/**
|
|
1171
|
+
* A file that was modified by auto-fix with its replacements.
|
|
1172
|
+
*/
|
|
1173
|
+
interface RefFix {
|
|
1174
|
+
/**
|
|
1175
|
+
* Path to the modified file
|
|
1176
|
+
*/
|
|
1177
|
+
file_path: string;
|
|
1178
|
+
/**
|
|
1179
|
+
* Full updated file content after fixes
|
|
1180
|
+
*/
|
|
1181
|
+
new_content: string;
|
|
1182
|
+
/**
|
|
1183
|
+
* Individual ref replacements made in this file
|
|
1184
|
+
*/
|
|
1185
|
+
replacements: Array<RefFix.Replacement>;
|
|
1186
|
+
}
|
|
1187
|
+
namespace RefFix {
|
|
1188
|
+
/**
|
|
1189
|
+
* A single ref replacement within a file.
|
|
1190
|
+
*/
|
|
1191
|
+
interface Replacement {
|
|
1192
|
+
/**
|
|
1193
|
+
* Path to the file containing the replaced ref
|
|
1194
|
+
*/
|
|
1195
|
+
file_path: string;
|
|
1196
|
+
/**
|
|
1197
|
+
* Line number where the replacement occurred
|
|
1198
|
+
*/
|
|
1199
|
+
line_number: number;
|
|
1200
|
+
/**
|
|
1201
|
+
* Updated reference string
|
|
1202
|
+
*/
|
|
1203
|
+
new_ref: string;
|
|
1204
|
+
/**
|
|
1205
|
+
* Original reference string
|
|
1206
|
+
*/
|
|
1207
|
+
old_ref: string;
|
|
1208
|
+
}
|
|
1209
|
+
}
|
|
896
1210
|
}
|
|
897
1211
|
/**
|
|
898
1212
|
* Response model for schema validation.
|
|
@@ -910,6 +1224,10 @@ export interface CompilerValidateResponse {
|
|
|
910
1224
|
* Validation errors
|
|
911
1225
|
*/
|
|
912
1226
|
errors?: Array<CompilerErrorItem>;
|
|
1227
|
+
/**
|
|
1228
|
+
* Write-back request ID. Non-null when files were dispatched to CLI via WebSocket.
|
|
1229
|
+
*/
|
|
1230
|
+
request_id?: string | null;
|
|
913
1231
|
/**
|
|
914
1232
|
* Validation warnings
|
|
915
1233
|
*/
|
|
@@ -940,6 +1258,14 @@ export declare namespace CompilerValidateResponse {
|
|
|
940
1258
|
* Validation errors for this connection
|
|
941
1259
|
*/
|
|
942
1260
|
errors?: Array<CompilerAPI.CompilerErrorItem>;
|
|
1261
|
+
/**
|
|
1262
|
+
* Compilation manifest with all named objects.
|
|
1263
|
+
*/
|
|
1264
|
+
manifest?: CompilerAPI.Manifest | null;
|
|
1265
|
+
/**
|
|
1266
|
+
* Files auto-fixed due to renamed refs. None when no renames detected.
|
|
1267
|
+
*/
|
|
1268
|
+
ref_fixes?: Array<ConnectionResult.RefFix> | null;
|
|
943
1269
|
/**
|
|
944
1270
|
* Validation warnings for this connection
|
|
945
1271
|
*/
|
|
@@ -996,6 +1322,46 @@ export declare namespace CompilerValidateResponse {
|
|
|
996
1322
|
column?: number;
|
|
997
1323
|
}
|
|
998
1324
|
}
|
|
1325
|
+
/**
|
|
1326
|
+
* A file that was modified by auto-fix with its replacements.
|
|
1327
|
+
*/
|
|
1328
|
+
interface RefFix {
|
|
1329
|
+
/**
|
|
1330
|
+
* Path to the modified file
|
|
1331
|
+
*/
|
|
1332
|
+
file_path: string;
|
|
1333
|
+
/**
|
|
1334
|
+
* Full updated file content after fixes
|
|
1335
|
+
*/
|
|
1336
|
+
new_content: string;
|
|
1337
|
+
/**
|
|
1338
|
+
* Individual ref replacements made in this file
|
|
1339
|
+
*/
|
|
1340
|
+
replacements: Array<RefFix.Replacement>;
|
|
1341
|
+
}
|
|
1342
|
+
namespace RefFix {
|
|
1343
|
+
/**
|
|
1344
|
+
* A single ref replacement within a file.
|
|
1345
|
+
*/
|
|
1346
|
+
interface Replacement {
|
|
1347
|
+
/**
|
|
1348
|
+
* Path to the file containing the replaced ref
|
|
1349
|
+
*/
|
|
1350
|
+
file_path: string;
|
|
1351
|
+
/**
|
|
1352
|
+
* Line number where the replacement occurred
|
|
1353
|
+
*/
|
|
1354
|
+
line_number: number;
|
|
1355
|
+
/**
|
|
1356
|
+
* Updated reference string
|
|
1357
|
+
*/
|
|
1358
|
+
new_ref: string;
|
|
1359
|
+
/**
|
|
1360
|
+
* Original reference string
|
|
1361
|
+
*/
|
|
1362
|
+
old_ref: string;
|
|
1363
|
+
}
|
|
1364
|
+
}
|
|
999
1365
|
}
|
|
1000
1366
|
}
|
|
1001
1367
|
export interface CompilerCompileParams {
|
|
@@ -1046,7 +1412,7 @@ export declare namespace CompilerCompileParams {
|
|
|
1046
1412
|
/**
|
|
1047
1413
|
* Widget category that determines data shape constraints
|
|
1048
1414
|
*/
|
|
1049
|
-
widget_category: 'axis' | '
|
|
1415
|
+
widget_category: 'axis' | 'funnel' | 'heatmap' | 'image' | 'kpi_card' | 'pie' | 'table' | 'text';
|
|
1050
1416
|
/**
|
|
1051
1417
|
* Usage guidance for AI processing
|
|
1052
1418
|
*/
|
|
@@ -1076,11 +1442,11 @@ export declare namespace CompilerCompileParams {
|
|
|
1076
1442
|
/**
|
|
1077
1443
|
* Widget types within the declared widget_category that must NOT render this query
|
|
1078
1444
|
*/
|
|
1079
|
-
disallowed_widget_types?: Array<'
|
|
1445
|
+
disallowed_widget_types?: Array<'axis_metric_by_dimension' | 'axis_metric_by_dimensiondate' | 'axis_metric_by_dimensiondate_sliced_by_dimension' | 'axis_scatter_plot' | 'funnel_funnel_chart' | 'heatmap_heatmap' | 'image_image_grid' | 'image_single_image' | 'kpi_measure_with_dimension_expression' | 'kpi_measure_with_secondary_metric' | 'kpi_single_measure_compared_to_prev_period_sparkline' | 'kpi_single_value' | 'pie_pie_chart' | 'table_data_table' | 'table_fancy_subtotal_table' | 'table_key_value_list' | 'table_styled_table' | 'text_data_readout_with_sparkline' | 'text_narrative_text'> | null;
|
|
1080
1446
|
/**
|
|
1081
1447
|
* Merged required + selected optional filters
|
|
1082
1448
|
*/
|
|
1083
|
-
filters?: Array<ResolvedQuery.
|
|
1449
|
+
filters?: Array<ResolvedQuery.InlineFormulaFilter | string | ResolvedQuery.InlineExistsFilter1 | ResolvedQuery.InlineExistsFilter2> | null;
|
|
1084
1450
|
/**
|
|
1085
1451
|
* Ordered list of query refs that were merged during inheritance resolution
|
|
1086
1452
|
*/
|
|
@@ -1102,10 +1468,6 @@ export declare namespace CompilerCompileParams {
|
|
|
1102
1468
|
* (highest/newest first) and asc for ascending (lowest/oldest first).
|
|
1103
1469
|
*/
|
|
1104
1470
|
order_by?: ResolvedQuery.OrderBy | null;
|
|
1105
|
-
/**
|
|
1106
|
-
* Access grants required to use this query
|
|
1107
|
-
*/
|
|
1108
|
-
required_access_grants?: Array<string> | null;
|
|
1109
1471
|
/**
|
|
1110
1472
|
* The matched chart recommendation after evaluating chart hints
|
|
1111
1473
|
*/
|
|
@@ -1159,29 +1521,17 @@ export declare namespace CompilerCompileParams {
|
|
|
1159
1521
|
}
|
|
1160
1522
|
}
|
|
1161
1523
|
/**
|
|
1162
|
-
* An inline filter using
|
|
1524
|
+
* An inline filter using a SQL/expression formula
|
|
1163
1525
|
*/
|
|
1164
|
-
interface
|
|
1165
|
-
/**
|
|
1166
|
-
* Reference to the field to filter on
|
|
1167
|
-
*/
|
|
1168
|
-
field: string;
|
|
1526
|
+
interface InlineFormulaFilter {
|
|
1169
1527
|
/**
|
|
1170
1528
|
* Name of the inline filter
|
|
1171
1529
|
*/
|
|
1172
1530
|
name: string;
|
|
1173
1531
|
/**
|
|
1174
|
-
*
|
|
1532
|
+
* SQL expression for the filter condition
|
|
1175
1533
|
*/
|
|
1176
|
-
|
|
1177
|
-
/**
|
|
1178
|
-
* SQL expression for the filter value
|
|
1179
|
-
*/
|
|
1180
|
-
sql_value?: string | null;
|
|
1181
|
-
/**
|
|
1182
|
-
* Fixed values for the filter
|
|
1183
|
-
*/
|
|
1184
|
-
static_values?: Array<string | number | boolean> | null;
|
|
1534
|
+
sql: string;
|
|
1185
1535
|
}
|
|
1186
1536
|
/**
|
|
1187
1537
|
* An inline filter using EXISTS or NOT EXISTS with a subquery
|
|
@@ -1267,11 +1617,15 @@ export declare namespace CompilerCompileParams {
|
|
|
1267
1617
|
/**
|
|
1268
1618
|
* The concrete value bound for this resolution
|
|
1269
1619
|
*/
|
|
1270
|
-
bound_value: string | number | boolean
|
|
1620
|
+
bound_value: string | number | boolean | Array<string | number | boolean>;
|
|
1271
1621
|
/**
|
|
1272
1622
|
* Default value for this variable
|
|
1273
1623
|
*/
|
|
1274
|
-
default: string | number | boolean
|
|
1624
|
+
default: string | number | boolean | Array<string | number | boolean>;
|
|
1625
|
+
/**
|
|
1626
|
+
* Unique identifier for this variable
|
|
1627
|
+
*/
|
|
1628
|
+
kater_id: string;
|
|
1275
1629
|
/**
|
|
1276
1630
|
* Variable name identifier
|
|
1277
1631
|
*/
|
|
@@ -1279,7 +1633,7 @@ export declare namespace CompilerCompileParams {
|
|
|
1279
1633
|
/**
|
|
1280
1634
|
* Data type of the variable
|
|
1281
1635
|
*/
|
|
1282
|
-
type: 'STRING' | 'INT' | 'FLOAT' | 'DATE' | 'TIMESTAMP' | 'BOOL' | 'DIMENSION' | 'MEASURE' | 'CALCULATION' | 'FILTER';
|
|
1636
|
+
type: 'STRING' | 'INT' | 'FLOAT' | 'DATE' | 'TIMESTAMP' | 'BOOL' | 'STRING[]' | 'INT[]' | 'FLOAT[]' | 'DATE[]' | 'DIMENSION' | 'MEASURE' | 'CALCULATION' | 'FILTER';
|
|
1283
1637
|
/**
|
|
1284
1638
|
* Allowed values configuration
|
|
1285
1639
|
*/
|
|
@@ -1296,6 +1650,12 @@ export declare namespace CompilerCompileParams {
|
|
|
1296
1650
|
* True if bound_value equals the default value
|
|
1297
1651
|
*/
|
|
1298
1652
|
is_default?: boolean | null;
|
|
1653
|
+
/**
|
|
1654
|
+
* True if this is a runtime variable (not resolved at compile time). Runtime
|
|
1655
|
+
* variables have var() placeholders left in compiled SQL for literal substitution
|
|
1656
|
+
* at execution time.
|
|
1657
|
+
*/
|
|
1658
|
+
is_runtime?: boolean | null;
|
|
1299
1659
|
/**
|
|
1300
1660
|
* Human-readable label for the variable
|
|
1301
1661
|
*/
|
|
@@ -1408,11 +1768,40 @@ export declare namespace CompilerCompileParams {
|
|
|
1408
1768
|
/**
|
|
1409
1769
|
* Original type of the field in the source query
|
|
1410
1770
|
*/
|
|
1411
|
-
source_type: 'dimension' | 'measure' | 'calculation';
|
|
1771
|
+
source_type: 'dimension' | 'dimension_date' | 'measure' | 'calculation';
|
|
1412
1772
|
}
|
|
1413
1773
|
}
|
|
1414
1774
|
}
|
|
1415
1775
|
}
|
|
1776
|
+
export interface CompilerCompileDashboardParams {
|
|
1777
|
+
/**
|
|
1778
|
+
* Body param: Connection to compile against
|
|
1779
|
+
*/
|
|
1780
|
+
connection_id: string;
|
|
1781
|
+
/**
|
|
1782
|
+
* Body param: Relative path within the connection (e.g.
|
|
1783
|
+
* 'dashboards/compliance_overview')
|
|
1784
|
+
*/
|
|
1785
|
+
dashboard_path: string;
|
|
1786
|
+
/**
|
|
1787
|
+
* Query param
|
|
1788
|
+
*/
|
|
1789
|
+
source?: string | null;
|
|
1790
|
+
/**
|
|
1791
|
+
* Body param: Optional filter overrides from UI
|
|
1792
|
+
*/
|
|
1793
|
+
filters?: {
|
|
1794
|
+
[key: string]: string | Array<string> | null;
|
|
1795
|
+
} | null;
|
|
1796
|
+
/**
|
|
1797
|
+
* Body param: Optional tenant key for multi-tenant execution
|
|
1798
|
+
*/
|
|
1799
|
+
tenant_key?: string | null;
|
|
1800
|
+
/**
|
|
1801
|
+
* Header param
|
|
1802
|
+
*/
|
|
1803
|
+
'X-Kater-CLI-ID'?: string;
|
|
1804
|
+
}
|
|
1416
1805
|
export interface CompilerEnumerateParams {
|
|
1417
1806
|
/**
|
|
1418
1807
|
* Body param: Connection to enumerate against
|
|
@@ -1427,6 +1816,11 @@ export interface CompilerEnumerateParams {
|
|
|
1427
1816
|
* queries.
|
|
1428
1817
|
*/
|
|
1429
1818
|
query_refs?: Array<string> | null;
|
|
1819
|
+
/**
|
|
1820
|
+
* Body param: Tenant key for multi-tenant clients. Required when the client uses
|
|
1821
|
+
* row or database tenancy.
|
|
1822
|
+
*/
|
|
1823
|
+
tenant_key?: string | null;
|
|
1430
1824
|
/**
|
|
1431
1825
|
* Header param
|
|
1432
1826
|
*/
|
|
@@ -1479,7 +1873,7 @@ export declare namespace CompilerExecuteParams {
|
|
|
1479
1873
|
/**
|
|
1480
1874
|
* Widget category that determines data shape constraints
|
|
1481
1875
|
*/
|
|
1482
|
-
widget_category: 'axis' | '
|
|
1876
|
+
widget_category: 'axis' | 'funnel' | 'heatmap' | 'image' | 'kpi_card' | 'pie' | 'table' | 'text';
|
|
1483
1877
|
/**
|
|
1484
1878
|
* Usage guidance for AI processing
|
|
1485
1879
|
*/
|
|
@@ -1509,11 +1903,11 @@ export declare namespace CompilerExecuteParams {
|
|
|
1509
1903
|
/**
|
|
1510
1904
|
* Widget types within the declared widget_category that must NOT render this query
|
|
1511
1905
|
*/
|
|
1512
|
-
disallowed_widget_types?: Array<'
|
|
1906
|
+
disallowed_widget_types?: Array<'axis_metric_by_dimension' | 'axis_metric_by_dimensiondate' | 'axis_metric_by_dimensiondate_sliced_by_dimension' | 'axis_scatter_plot' | 'funnel_funnel_chart' | 'heatmap_heatmap' | 'image_image_grid' | 'image_single_image' | 'kpi_measure_with_dimension_expression' | 'kpi_measure_with_secondary_metric' | 'kpi_single_measure_compared_to_prev_period_sparkline' | 'kpi_single_value' | 'pie_pie_chart' | 'table_data_table' | 'table_fancy_subtotal_table' | 'table_key_value_list' | 'table_styled_table' | 'text_data_readout_with_sparkline' | 'text_narrative_text'> | null;
|
|
1513
1907
|
/**
|
|
1514
1908
|
* Merged required + selected optional filters
|
|
1515
1909
|
*/
|
|
1516
|
-
filters?: Array<ResolvedQuery.
|
|
1910
|
+
filters?: Array<ResolvedQuery.InlineFormulaFilter | string | ResolvedQuery.InlineExistsFilter1 | ResolvedQuery.InlineExistsFilter2> | null;
|
|
1517
1911
|
/**
|
|
1518
1912
|
* Ordered list of query refs that were merged during inheritance resolution
|
|
1519
1913
|
*/
|
|
@@ -1535,10 +1929,6 @@ export declare namespace CompilerExecuteParams {
|
|
|
1535
1929
|
* (highest/newest first) and asc for ascending (lowest/oldest first).
|
|
1536
1930
|
*/
|
|
1537
1931
|
order_by?: ResolvedQuery.OrderBy | null;
|
|
1538
|
-
/**
|
|
1539
|
-
* Access grants required to use this query
|
|
1540
|
-
*/
|
|
1541
|
-
required_access_grants?: Array<string> | null;
|
|
1542
1932
|
/**
|
|
1543
1933
|
* The matched chart recommendation after evaluating chart hints
|
|
1544
1934
|
*/
|
|
@@ -1592,29 +1982,17 @@ export declare namespace CompilerExecuteParams {
|
|
|
1592
1982
|
}
|
|
1593
1983
|
}
|
|
1594
1984
|
/**
|
|
1595
|
-
* An inline filter using
|
|
1985
|
+
* An inline filter using a SQL/expression formula
|
|
1596
1986
|
*/
|
|
1597
|
-
interface
|
|
1598
|
-
/**
|
|
1599
|
-
* Reference to the field to filter on
|
|
1600
|
-
*/
|
|
1601
|
-
field: string;
|
|
1987
|
+
interface InlineFormulaFilter {
|
|
1602
1988
|
/**
|
|
1603
1989
|
* Name of the inline filter
|
|
1604
1990
|
*/
|
|
1605
1991
|
name: string;
|
|
1606
1992
|
/**
|
|
1607
|
-
*
|
|
1608
|
-
*/
|
|
1609
|
-
operator: 'equals' | 'not_equals' | 'in' | 'not_in' | 'greater_than' | 'less_than' | 'greater_than_or_equals' | 'less_than_or_equals' | 'between' | 'in_the_last' | 'in_the_next' | 'contains' | 'not_contains' | 'starts_with' | 'ends_with' | 'is_null' | 'is_not_null';
|
|
1610
|
-
/**
|
|
1611
|
-
* SQL expression for the filter value
|
|
1612
|
-
*/
|
|
1613
|
-
sql_value?: string | null;
|
|
1614
|
-
/**
|
|
1615
|
-
* Fixed values for the filter
|
|
1993
|
+
* SQL expression for the filter condition
|
|
1616
1994
|
*/
|
|
1617
|
-
|
|
1995
|
+
sql: string;
|
|
1618
1996
|
}
|
|
1619
1997
|
/**
|
|
1620
1998
|
* An inline filter using EXISTS or NOT EXISTS with a subquery
|
|
@@ -1700,11 +2078,15 @@ export declare namespace CompilerExecuteParams {
|
|
|
1700
2078
|
/**
|
|
1701
2079
|
* The concrete value bound for this resolution
|
|
1702
2080
|
*/
|
|
1703
|
-
bound_value: string | number | boolean
|
|
2081
|
+
bound_value: string | number | boolean | Array<string | number | boolean>;
|
|
1704
2082
|
/**
|
|
1705
2083
|
* Default value for this variable
|
|
1706
2084
|
*/
|
|
1707
|
-
default: string | number | boolean
|
|
2085
|
+
default: string | number | boolean | Array<string | number | boolean>;
|
|
2086
|
+
/**
|
|
2087
|
+
* Unique identifier for this variable
|
|
2088
|
+
*/
|
|
2089
|
+
kater_id: string;
|
|
1708
2090
|
/**
|
|
1709
2091
|
* Variable name identifier
|
|
1710
2092
|
*/
|
|
@@ -1712,7 +2094,7 @@ export declare namespace CompilerExecuteParams {
|
|
|
1712
2094
|
/**
|
|
1713
2095
|
* Data type of the variable
|
|
1714
2096
|
*/
|
|
1715
|
-
type: 'STRING' | 'INT' | 'FLOAT' | 'DATE' | 'TIMESTAMP' | 'BOOL' | 'DIMENSION' | 'MEASURE' | 'CALCULATION' | 'FILTER';
|
|
2097
|
+
type: 'STRING' | 'INT' | 'FLOAT' | 'DATE' | 'TIMESTAMP' | 'BOOL' | 'STRING[]' | 'INT[]' | 'FLOAT[]' | 'DATE[]' | 'DIMENSION' | 'MEASURE' | 'CALCULATION' | 'FILTER';
|
|
1716
2098
|
/**
|
|
1717
2099
|
* Allowed values configuration
|
|
1718
2100
|
*/
|
|
@@ -1729,6 +2111,12 @@ export declare namespace CompilerExecuteParams {
|
|
|
1729
2111
|
* True if bound_value equals the default value
|
|
1730
2112
|
*/
|
|
1731
2113
|
is_default?: boolean | null;
|
|
2114
|
+
/**
|
|
2115
|
+
* True if this is a runtime variable (not resolved at compile time). Runtime
|
|
2116
|
+
* variables have var() placeholders left in compiled SQL for literal substitution
|
|
2117
|
+
* at execution time.
|
|
2118
|
+
*/
|
|
2119
|
+
is_runtime?: boolean | null;
|
|
1732
2120
|
/**
|
|
1733
2121
|
* Human-readable label for the variable
|
|
1734
2122
|
*/
|
|
@@ -1841,7 +2229,7 @@ export declare namespace CompilerExecuteParams {
|
|
|
1841
2229
|
/**
|
|
1842
2230
|
* Original type of the field in the source query
|
|
1843
2231
|
*/
|
|
1844
|
-
source_type: 'dimension' | 'measure' | 'calculation';
|
|
2232
|
+
source_type: 'dimension' | 'dimension_date' | 'measure' | 'calculation';
|
|
1845
2233
|
}
|
|
1846
2234
|
}
|
|
1847
2235
|
}
|
|
@@ -1859,6 +2247,10 @@ export interface CompilerResolveParams {
|
|
|
1859
2247
|
* Query param
|
|
1860
2248
|
*/
|
|
1861
2249
|
source?: string | null;
|
|
2250
|
+
/**
|
|
2251
|
+
* Body param: Automatically fix broken refs caused by renames. Defaults to True.
|
|
2252
|
+
*/
|
|
2253
|
+
auto_fix?: boolean;
|
|
1862
2254
|
/**
|
|
1863
2255
|
* Body param: Comma-separated slot selections and variable assignments. Reserved
|
|
1864
2256
|
* keys: measure, dimension, filter, calculation. All other keys are variable
|
|
@@ -1876,6 +2268,10 @@ export interface CompilerValidateParams {
|
|
|
1876
2268
|
* Query param
|
|
1877
2269
|
*/
|
|
1878
2270
|
source?: string | null;
|
|
2271
|
+
/**
|
|
2272
|
+
* Body param: Automatically fix broken refs caused by renames. Defaults to True.
|
|
2273
|
+
*/
|
|
2274
|
+
auto_fix?: boolean;
|
|
1879
2275
|
/**
|
|
1880
2276
|
* Body param: Optional connection IDs to validate. If omitted, validates all
|
|
1881
2277
|
* connections.
|
|
@@ -1887,7 +2283,9 @@ export interface CompilerValidateParams {
|
|
|
1887
2283
|
'X-Kater-CLI-ID'?: string;
|
|
1888
2284
|
}
|
|
1889
2285
|
export declare namespace Compiler {
|
|
1890
|
-
export { type ChartConfig as ChartConfig, type CompilerErrorItem as CompilerErrorItem, type InlineField as InlineField, type Manifest as Manifest, type ManifestEntry as ManifestEntry, type RefWithLabel as RefWithLabel, type SubqueryCondition as SubqueryCondition, type CompilerCompileResponse as CompilerCompileResponse, type CompilerEnumerateResponse as CompilerEnumerateResponse, type CompilerExecuteResponse as CompilerExecuteResponse, type CompilerResolveResponse as CompilerResolveResponse, type CompilerValidateResponse as CompilerValidateResponse, type CompilerCompileParams as CompilerCompileParams, type CompilerEnumerateParams as CompilerEnumerateParams, type CompilerExecuteParams as CompilerExecuteParams, type CompilerResolveParams as CompilerResolveParams, type CompilerValidateParams as CompilerValidateParams, };
|
|
1891
|
-
export { Cache as Cache
|
|
2286
|
+
export { type ChartConfig as ChartConfig, type CompilerErrorItem as CompilerErrorItem, type InlineField as InlineField, type Manifest as Manifest, type ManifestEntry as ManifestEntry, type RefWithLabel as RefWithLabel, type SubqueryCondition as SubqueryCondition, type CompilerCompileResponse as CompilerCompileResponse, type CompilerCompileDashboardResponse as CompilerCompileDashboardResponse, type CompilerEnumerateResponse as CompilerEnumerateResponse, type CompilerExecuteResponse as CompilerExecuteResponse, type CompilerResolveResponse as CompilerResolveResponse, type CompilerValidateResponse as CompilerValidateResponse, type CompilerCompileParams as CompilerCompileParams, type CompilerCompileDashboardParams as CompilerCompileDashboardParams, type CompilerEnumerateParams as CompilerEnumerateParams, type CompilerExecuteParams as CompilerExecuteParams, type CompilerResolveParams as CompilerResolveParams, type CompilerValidateParams as CompilerValidateParams, };
|
|
2287
|
+
export { Cache as Cache };
|
|
2288
|
+
export { CombinationAPICombination as Combination, type CombinationPreviewResponse as CombinationPreviewResponse, type CombinationPreviewParams as CombinationPreviewParams, };
|
|
2289
|
+
export { type ManifestRegenerateAndCreatePrResponse as ManifestRegenerateAndCreatePrResponse, type ManifestRegenerateAndCreatePrParams as ManifestRegenerateAndCreatePrParams, };
|
|
1892
2290
|
}
|
|
1893
2291
|
//# sourceMappingURL=compiler.d.mts.map
|