@gooddata/sdk-code-schemas 11.56.0-alpha.6 → 11.56.0-alpha.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/esm/sdk-code-schemas.d.ts +340 -47
  2. package/esm/v1/metadata.d.ts +163 -39
  3. package/esm/v1/metadata.d.ts.map +1 -1
  4. package/esm/v1/metadata.json +208 -32
  5. package/esm/v1/schema.d.ts +131 -8
  6. package/esm/v1/schema.d.ts.map +1 -1
  7. package/package.json +3 -3
package/esm/v1/metadata.json CHANGED
@@ -463,9 +463,59 @@
463
463
  "description": "Define MAQL syntax for the computed attribute. Values are assigned with break points written as CASE WHEN branches over a metric, and the first matching branch wins.",
464
464
  "$semantic": { "type": "maql" }
465
465
  },
466
- "locale": {
466
+ "format": {
467
+ "type": "string",
468
+ "description": "An optional Excel-like format string applied to the computed values."
469
+ },
470
+ "metric_type": {
471
+ "type": "string",
472
+ "enum": ["UNSPECIFIED", "CURRENCY"],
473
+ "description": "An optional categorization of the computed values semantics, for example currency."
474
+ },
475
+ "data_type": {
476
+ "type": "string",
477
+ "enum": [
478
+ "INT",
479
+ "STRING",
480
+ "DATE",
481
+ "NUMERIC",
482
+ "TIMESTAMP",
483
+ "TIMESTAMP_TZ",
484
+ "BOOLEAN",
485
+ "HLL"
486
+ ],
487
+ "description": "An optional data type of the computed values. Defaults to STRING on the backend."
488
+ },
489
+ "value_type": {
490
+ "type": "string",
491
+ "enum": [
492
+ "TEXT",
493
+ "HYPERLINK",
494
+ "GEO",
495
+ "GEO_LONGITUDE",
496
+ "GEO_LATITUDE",
497
+ "GEO_AREA",
498
+ "GEO_ICON",
499
+ "IMAGE",
500
+ "HYPERLOGLOG"
501
+ ],
502
+ "description": "An optional specific type of the computed values. Defaults to TEXT on the backend."
503
+ },
504
+ "is_nullable": {
505
+ "type": "boolean",
506
+ "description": "Optional flag to indicate if the computed attribute can contain null values."
507
+ },
508
+ "null_value_join_replacement": {
467
509
  "type": "string",
468
- "description": "An optional locale whose collation order the computed values are sorted by."
510
+ "description": "Optional value which can be used as replacement for NULL in join conditions."
511
+ },
512
+ "show_in_ai_results": {
513
+ "type": "boolean",
514
+ "description": "Optional flag to indicate if the computed attribute should be shown in AI results. When omitted, the computed attribute is visible."
515
+ },
516
+ "locale": {
517
+ "$ref": "#/$global/gaac/locale",
518
+ "description": "An optional locale in BCP 47 format (for example en-US) whose collation order the computed values are sorted by."
469
519
  }
470
520
  },
471
521
  "$semantic": { "type": "snippet", "snippets": ["computed_attribute"] },
@@ -2565,6 +2615,12 @@
2565
2615
  "pattern": "^attribute/(?!\\.)[.A-Za-z0-9_-]{1,255}$",
2566
2616
  "$semantic": { "type": "reference", "source": "attribute.id", "typePrefix": true }
2567
2617
  },
2618
+ "locale": {
2619
+ "title": "Locale",
2620
+ "type": "string",
2621
+ "pattern": "^[a-zA-Z]{2,3}(-[a-zA-Z0-9]{1,8})*$",
2622
+ "description": "Locale string in BCP 47 format (for example en-US or cs-CZ-u-kn-true)."
2623
+ },
2568
2624
  "dashboardFilters": {
2569
2625
  "title": "Dashboard Filters",
2570
2626
  "type": "object",
@@ -2646,6 +2702,13 @@
2646
2702
  "pattern": "^label/(?!\\.)[.A-Za-z0-9_-]{1,255}$",
2647
2703
  "$semantic": { "type": "reference", "source": "label.id", "typePrefix": true }
2648
2704
  },
2705
+ "computedAttributeIdentifier": {
2706
+ "title": "Computed Attribute Identifier",
2707
+ "description": "A computed attribute identifier in the form of computed_attribute/{id}.",
2708
+ "type": "string",
2709
+ "pattern": "^computed_attribute/(?!\\.)[.A-Za-z0-9_-]{1,255}$",
2710
+ "$semantic": { "type": "reference", "source": "computedAttribute.id", "typePrefix": true }
2711
+ },
2649
2712
  "queryFilters": {
2650
2713
  "title": "Query Filters",
2651
2714
  "type": "object",
@@ -3243,6 +3306,13 @@
3243
3306
  "pattern": "^label/(?!\\.)[.A-Za-z0-9_-]{1,255}$",
3244
3307
  "$semantic": { "type": "reference", "source": "label.id", "typePrefix": true }
3245
3308
  },
3309
+ "computedAttributeIdentifier": {
3310
+ "title": "Computed Attribute Identifier",
3311
+ "description": "A computed attribute identifier in the form of computed_attribute/{id}.",
3312
+ "type": "string",
3313
+ "pattern": "^computed_attribute/(?!\\.)[.A-Za-z0-9_-]{1,255}$",
3314
+ "$semantic": { "type": "reference", "source": "computedAttribute.id", "typePrefix": true }
3315
+ },
3246
3316
  "displayAsLabelIdentifier": {
3247
3317
  "title": "Display As Label Identifier",
3248
3318
  "description": "Configures the label used for representing attribute filter elements in UI.",
@@ -3423,7 +3493,8 @@
3423
3493
  "description": "Attribute or label to use in this filter.",
3424
3494
  "oneOf": [
3425
3495
  { "$ref": "#/$defs/attributeIdentifier" },
3426
- { "$ref": "#/$defs/labelIdentifier" }
3496
+ { "$ref": "#/$defs/labelIdentifier" },
3497
+ { "$ref": "#/$defs/computedAttributeIdentifier" }
3427
3498
  ],
3428
3499
  "$semantic": { "type": "one_attribute_item_only" }
3429
3500
  },
@@ -3501,7 +3572,8 @@
3501
3572
  "description": "Attribute or label to use in this filter.",
3502
3573
  "oneOf": [
3503
3574
  { "$ref": "#/$defs/attributeIdentifier" },
3504
- { "$ref": "#/$defs/labelIdentifier" }
3575
+ { "$ref": "#/$defs/labelIdentifier" },
3576
+ { "$ref": "#/$defs/computedAttributeIdentifier" }
3505
3577
  ]
3506
3578
  },
3507
3579
  "multiselect": {
@@ -3595,7 +3667,8 @@
3595
3667
  "description": "Attribute or label to use in this filter.",
3596
3668
  "oneOf": [
3597
3669
  { "$ref": "#/$defs/attributeIdentifier" },
3598
- { "$ref": "#/$defs/labelIdentifier" }
3670
+ { "$ref": "#/$defs/labelIdentifier" },
3671
+ { "$ref": "#/$defs/computedAttributeIdentifier" }
3599
3672
  ]
3600
3673
  },
3601
3674
  "multiselect": {
@@ -3700,7 +3773,8 @@
3700
3773
  "description": "Attribute or label to use in this filter.",
3701
3774
  "oneOf": [
3702
3775
  { "$ref": "#/$defs/attributeIdentifier" },
3703
- { "$ref": "#/$defs/labelIdentifier" }
3776
+ { "$ref": "#/$defs/labelIdentifier" },
3777
+ { "$ref": "#/$defs/computedAttributeIdentifier" }
3704
3778
  ],
3705
3779
  "$semantic": { "type": "one_attribute_item_only" }
3706
3780
  },
@@ -3789,7 +3863,8 @@
3789
3863
  "description": "Attribute or label to use in this filter.",
3790
3864
  "oneOf": [
3791
3865
  { "$ref": "#/$defs/attributeIdentifier" },
3792
- { "$ref": "#/$defs/labelIdentifier" }
3866
+ { "$ref": "#/$defs/labelIdentifier" },
3867
+ { "$ref": "#/$defs/computedAttributeIdentifier" }
3793
3868
  ],
3794
3869
  "$semantic": { "type": "one_attribute_item_only" }
3795
3870
  },
@@ -3884,7 +3959,8 @@
3884
3959
  "description": "Attribute or label to use in this filter.",
3885
3960
  "oneOf": [
3886
3961
  { "$ref": "#/$defs/attributeIdentifier" },
3887
- { "$ref": "#/$defs/labelIdentifier" }
3962
+ { "$ref": "#/$defs/labelIdentifier" },
3963
+ { "$ref": "#/$defs/computedAttributeIdentifier" }
3888
3964
  ],
3889
3965
  "$semantic": { "type": "one_attribute_item_only" }
3890
3966
  },
@@ -3947,8 +4023,13 @@
3947
4023
  },
3948
4024
  "dimensionality": {
3949
4025
  "type": "array",
3950
- "description": "Optional array of label references to apply dimensionality to the filter.",
3951
- "items": { "$ref": "#/$defs/labelIdentifier" }
4026
+ "description": "Optional array of label or computed attribute references to apply dimensionality to the filter.",
4027
+ "items": {
4028
+ "oneOf": [
4029
+ { "$ref": "#/$defs/labelIdentifier" },
4030
+ { "$ref": "#/$defs/computedAttributeIdentifier" }
4031
+ ]
4032
+ }
3952
4033
  },
3953
4034
  "null_values_as_zero": {
3954
4035
  "type": "boolean",
@@ -4393,7 +4474,8 @@
4393
4474
  "description": "Attribute or label to use in this filter.",
4394
4475
  "oneOf": [
4395
4476
  { "$ref": "#/$defs/attributeIdentifier" },
4396
- { "$ref": "#/$defs/labelIdentifier" }
4477
+ { "$ref": "#/$defs/labelIdentifier" },
4478
+ { "$ref": "#/$defs/computedAttributeIdentifier" }
4397
4479
  ]
4398
4480
  },
4399
4481
  "display_as": {
@@ -4446,7 +4528,8 @@
4446
4528
  "description": "Attribute or label to use in this filter.",
4447
4529
  "oneOf": [
4448
4530
  { "$ref": "#/$defs/attributeIdentifier" },
4449
- { "$ref": "#/$defs/labelIdentifier" }
4531
+ { "$ref": "#/$defs/labelIdentifier" },
4532
+ { "$ref": "#/$defs/computedAttributeIdentifier" }
4450
4533
  ]
4451
4534
  },
4452
4535
  "case_sensitive": { "type": "boolean" },
@@ -4464,7 +4547,8 @@
4464
4547
  "description": "Attribute or label to use in this filter.",
4465
4548
  "oneOf": [
4466
4549
  { "$ref": "#/$defs/attributeIdentifier" },
4467
- { "$ref": "#/$defs/labelIdentifier" }
4550
+ { "$ref": "#/$defs/labelIdentifier" },
4551
+ { "$ref": "#/$defs/computedAttributeIdentifier" }
4468
4552
  ]
4469
4553
  },
4470
4554
  "condition": { "enum": ["is", "isNot"] },
@@ -4485,7 +4569,8 @@
4485
4569
  "description": "Attribute or label to use in this filter.",
4486
4570
  "oneOf": [
4487
4571
  { "$ref": "#/$defs/attributeIdentifier" },
4488
- { "$ref": "#/$defs/labelIdentifier" }
4572
+ { "$ref": "#/$defs/labelIdentifier" },
4573
+ { "$ref": "#/$defs/computedAttributeIdentifier" }
4489
4574
  ]
4490
4575
  },
4491
4576
  "condition": {
@@ -4584,6 +4669,7 @@
4584
4669
  "items": {
4585
4670
  "oneOf": [
4586
4671
  { "$ref": "#/$defs/labelIdentifier" },
4672
+ { "$ref": "#/$defs/computedAttributeIdentifier" },
4587
4673
  {
4588
4674
  "type": "string",
4589
4675
  "$semantic": {
@@ -4658,6 +4744,7 @@
4658
4744
  "items": {
4659
4745
  "oneOf": [
4660
4746
  { "$ref": "#/$defs/labelIdentifier" },
4747
+ { "$ref": "#/$defs/computedAttributeIdentifier" },
4661
4748
  {
4662
4749
  "type": "string",
4663
4750
  "$semantic": {
@@ -4718,6 +4805,7 @@
4718
4805
  "items": {
4719
4806
  "oneOf": [
4720
4807
  { "$ref": "#/$defs/labelIdentifier" },
4808
+ { "$ref": "#/$defs/computedAttributeIdentifier" },
4721
4809
  {
4722
4810
  "type": "string",
4723
4811
  "$semantic": {
@@ -4766,6 +4854,7 @@
4766
4854
  "items": {
4767
4855
  "oneOf": [
4768
4856
  { "$ref": "#/$defs/labelIdentifier" },
4857
+ { "$ref": "#/$defs/computedAttributeIdentifier" },
4769
4858
  {
4770
4859
  "type": "string",
4771
4860
  "$semantic": {
@@ -4808,6 +4897,7 @@
4808
4897
  "description": "Label reference or local identifier to use for this filter.",
4809
4898
  "oneOf": [
4810
4899
  { "$ref": "#/$defs/labelIdentifier" },
4900
+ { "$ref": "#/$defs/computedAttributeIdentifier" },
4811
4901
  {
4812
4902
  "type": "string",
4813
4903
  "$semantic": { "type": "reference", "source": "current.query.attribute.localId" }
@@ -4870,9 +4960,59 @@
4870
4960
  "description": "Define MAQL syntax for the computed attribute. Values are assigned with break points written as CASE WHEN branches over a metric, and the first matching branch wins.",
4871
4961
  "$semantic": { "type": "maql" }
4872
4962
  },
4873
- "locale": {
4963
+ "format": {
4874
4964
  "type": "string",
4875
- "description": "An optional locale whose collation order the computed values are sorted by."
4965
+ "description": "An optional Excel-like format string applied to the computed values."
4966
+ },
4967
+ "metric_type": {
4968
+ "type": "string",
4969
+ "enum": ["UNSPECIFIED", "CURRENCY"],
4970
+ "description": "An optional categorization of the computed values semantics, for example currency."
4971
+ },
4972
+ "data_type": {
4973
+ "type": "string",
4974
+ "enum": [
4975
+ "INT",
4976
+ "STRING",
4977
+ "DATE",
4978
+ "NUMERIC",
4979
+ "TIMESTAMP",
4980
+ "TIMESTAMP_TZ",
4981
+ "BOOLEAN",
4982
+ "HLL"
4983
+ ],
4984
+ "description": "An optional data type of the computed values. Defaults to STRING on the backend."
4985
+ },
4986
+ "value_type": {
4987
+ "type": "string",
4988
+ "enum": [
4989
+ "TEXT",
4990
+ "HYPERLINK",
4991
+ "GEO",
4992
+ "GEO_LONGITUDE",
4993
+ "GEO_LATITUDE",
4994
+ "GEO_AREA",
4995
+ "GEO_ICON",
4996
+ "IMAGE",
4997
+ "HYPERLOGLOG"
4998
+ ],
4999
+ "description": "An optional specific type of the computed values. Defaults to TEXT on the backend."
5000
+ },
5001
+ "is_nullable": {
5002
+ "type": "boolean",
5003
+ "description": "Optional flag to indicate if the computed attribute can contain null values."
5004
+ },
5005
+ "null_value_join_replacement": {
5006
+ "type": "string",
5007
+ "description": "Optional value which can be used as replacement for NULL in join conditions."
5008
+ },
5009
+ "show_in_ai_results": {
5010
+ "type": "boolean",
5011
+ "description": "Optional flag to indicate if the computed attribute should be shown in AI results. When omitted, the computed attribute is visible."
5012
+ },
5013
+ "locale": {
5014
+ "$ref": "#/$global/gaac/locale",
5015
+ "description": "An optional locale in BCP 47 format (for example en-US) whose collation order the computed values are sorted by."
4876
5016
  }
4877
5017
  },
4878
5018
  "$semantic": { "type": "snippet", "snippets": ["computed_attribute"] },
@@ -5572,10 +5712,16 @@
5572
5712
  "description": "A list of dashboard filters to be ignored for this widget",
5573
5713
  "items": {
5574
5714
  "type": "string",
5575
- "description": "An id of the dashboard label, attribute, metric or date to be ignored",
5715
+ "description": "An id of the dashboard label, attribute, computed attribute, metric or date to be ignored",
5576
5716
  "$semantic": {
5577
5717
  "type": "reference",
5578
- "sources": ["dateDataset.id", "attribute.id", "label.id", "metric.id"],
5718
+ "sources": [
5719
+ "dateDataset.id",
5720
+ "attribute.id",
5721
+ "label.id",
5722
+ "computedAttribute.id",
5723
+ "metric.id"
5724
+ ],
5579
5725
  "typePrefix": true
5580
5726
  }
5581
5727
  }
@@ -5628,14 +5774,16 @@
5628
5774
  "description": "An ID of the attribute that holds the url to be opened on interaction",
5629
5775
  "oneOf": [
5630
5776
  { "$ref": "#/$global/gaac/attributeIdentifier" },
5631
- { "$ref": "#/$global/gaac/labelIdentifier" }
5777
+ { "$ref": "#/$global/gaac/labelIdentifier" },
5778
+ { "$ref": "#/$global/gaac/computedAttributeIdentifier" }
5632
5779
  ]
5633
5780
  },
5634
5781
  "label": {
5635
5782
  "description": "An id of the attribute that holds the label for the url to be opened on interaction",
5636
5783
  "oneOf": [
5637
5784
  { "$ref": "#/$global/gaac/attributeIdentifier" },
5638
- { "$ref": "#/$global/gaac/labelIdentifier" }
5785
+ { "$ref": "#/$global/gaac/labelIdentifier" },
5786
+ { "$ref": "#/$global/gaac/computedAttributeIdentifier" }
5639
5787
  ]
5640
5788
  }
5641
5789
  }
@@ -6138,7 +6286,7 @@
6138
6286
  "deprecated": true
6139
6287
  },
6140
6288
  "locale": {
6141
- "$ref": "#/$defs/locale",
6289
+ "$ref": "#/$global/gaac/locale",
6142
6290
  "description": "Locale string in BCP 47 format used for default label sorting."
6143
6291
  },
6144
6292
  "is_nullable": {
@@ -6292,11 +6440,6 @@
6292
6440
  "code": "core.reference.table.column.dataType"
6293
6441
  }
6294
6442
  },
6295
- "locale": {
6296
- "type": "string",
6297
- "pattern": "^[a-zA-Z]{2,3}(-[a-zA-Z0-9]{1,8})*$",
6298
- "description": "Locale string in BCP 47 format (for example en-US or cs-CZ-u-kn-true)."
6299
- },
6300
6443
  "label": {
6301
6444
  "title": "Label",
6302
6445
  "type": "object",
@@ -6350,7 +6493,7 @@
6350
6493
  "deprecated": true
6351
6494
  },
6352
6495
  "locale": {
6353
- "$ref": "#/$defs/locale",
6496
+ "$ref": "#/$global/gaac/locale",
6354
6497
  "description": "Locale string in BCP 47 format used for default label sorting."
6355
6498
  },
6356
6499
  "translations": {
@@ -6403,7 +6546,7 @@
6403
6546
  "description": "Column that stores the localized label values."
6404
6547
  },
6405
6548
  "locale": {
6406
- "$ref": "#/$defs/locale",
6549
+ "$ref": "#/$global/gaac/locale",
6407
6550
  "description": "Locale string in BCP 47 format that identifies the translation."
6408
6551
  }
6409
6552
  },
@@ -6526,14 +6669,18 @@
6526
6669
  },
6527
6670
  "parameterDefinition": {
6528
6671
  "title": "Parameter Definition",
6529
- "description": "A typed parameter definition. Only textual parameters are supported as code.",
6672
+ "description": "A typed parameter definition: textual or numeric.",
6530
6673
  "allOf": [
6531
6674
  {
6532
6675
  "if": { "properties": { "type": { "const": "STRING" } }, "required": ["type"] },
6533
6676
  "then": { "$ref": "#/$defs/stringParameterDefinition" }
6677
+ },
6678
+ {
6679
+ "if": { "properties": { "type": { "const": "NUMBER" } }, "required": ["type"] },
6680
+ "then": { "$ref": "#/$defs/numberParameterDefinition" }
6534
6681
  }
6535
6682
  ],
6536
- "properties": { "type": { "type": "string", "enum": ["STRING"] } },
6683
+ "properties": { "type": { "type": "string", "enum": ["STRING", "NUMBER"] } },
6537
6684
  "required": ["type"]
6538
6685
  },
6539
6686
  "stringParameterDefinition": {
@@ -6581,6 +6728,31 @@
6581
6728
  "required": ["type", "defaultValue"],
6582
6729
  "$semantic": { "type": "parameter_constraints" }
6583
6730
  },
6731
+ "numberParameterDefinition": {
6732
+ "title": "Number Parameter Definition",
6733
+ "description": "A numeric parameter definition. Without 'constraints' the parameter accepts any number.",
6734
+ "type": "object",
6735
+ "additionalProperties": false,
6736
+ "properties": {
6737
+ "type": { "type": "string", "enum": ["NUMBER"] },
6738
+ "defaultValue": {
6739
+ "type": "number",
6740
+ "description": "The value used whenever the parameter is not overridden."
6741
+ },
6742
+ "constraints": {
6743
+ "title": "Number Parameter Constraints",
6744
+ "type": "object",
6745
+ "additionalProperties": false,
6746
+ "description": "Optional bounds the parameter value must satisfy.",
6747
+ "properties": {
6748
+ "min": { "type": "number", "description": "The smallest accepted value, inclusive." },
6749
+ "max": { "type": "number", "description": "The largest accepted value, inclusive." }
6750
+ }
6751
+ }
6752
+ },
6753
+ "required": ["type", "defaultValue"],
6754
+ "$semantic": { "type": "parameter_constraints" }
6755
+ },
6584
6756
  "parameterAllowedValue": {
6585
6757
  "title": "Parameter Allowed Value",
6586
6758
  "type": "object",
@@ -6640,6 +6812,7 @@
6640
6812
  "oneOf": [
6641
6813
  { "$ref": "#/$global/gaac/attributeIdentifier" },
6642
6814
  { "$ref": "#/$global/gaac/labelIdentifier" },
6815
+ { "$ref": "#/$global/gaac/computedAttributeIdentifier" },
6643
6816
  { "$ref": "#/$global/gaac/metricIdentifier" },
6644
6817
  { "$ref": "#/$global/gaac/factIdentifier" },
6645
6818
  {
@@ -6731,6 +6904,7 @@
6731
6904
  "oneOf": [
6732
6905
  { "$ref": "#/$global/gaac/attributeIdentifier" },
6733
6906
  { "$ref": "#/$global/gaac/labelIdentifier" },
6907
+ { "$ref": "#/$global/gaac/computedAttributeIdentifier" },
6734
6908
  { "$ref": "#/$global/gaac/factIdentifier" }
6735
6909
  ]
6736
6910
  }
@@ -7051,7 +7225,8 @@
7051
7225
  "$semantic": { "type": "reference", "source": "current.query.attribute.localId" }
7052
7226
  },
7053
7227
  { "$ref": "#/$global/gaac/attributeIdentifier" },
7054
- { "$ref": "#/$global/gaac/labelIdentifier" }
7228
+ { "$ref": "#/$global/gaac/labelIdentifier" },
7229
+ { "$ref": "#/$global/gaac/computedAttributeIdentifier" }
7055
7230
  ]
7056
7231
  },
7057
7232
  "direction": { "type": "string", "enum": ["ASC", "DESC"], "description": "Sort direction." },
@@ -7094,7 +7269,8 @@
7094
7269
  }
7095
7270
  },
7096
7271
  { "$ref": "#/$global/gaac/attributeIdentifier" },
7097
- { "$ref": "#/$global/gaac/labelIdentifier" }
7272
+ { "$ref": "#/$global/gaac/labelIdentifier" },
7273
+ { "$ref": "#/$global/gaac/computedAttributeIdentifier" }
7098
7274
  ]
7099
7275
  },
7100
7276
  "element": {