@ui5/manifest 1.28.0 → 1.37.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.
@@ -143,6 +143,8 @@ export type Tag = string[];
143
143
  * via the `patternProperty` "^[a-zA-Z0-9_\.\-]*$".
144
144
  */
145
145
  export type DataSource = DataSourceEnum | DataSourceCustom;
146
+ export type ObjectName = string;
147
+ export type ObjectType = "query" | "cdsprojectionview" | "view" | "inamodel";
146
148
  /**
147
149
  * Represents sapui5 attributes
148
150
  */
@@ -162,7 +164,8 @@ export type JSONSchemaForSAPUI5Namespace = {
162
164
  | "1.9.0"
163
165
  | "1.10.0"
164
166
  | "1.11.0"
165
- | "1.12.0";
167
+ | "1.12.0"
168
+ | "1.13.0";
166
169
  resources?: Resource;
167
170
  /**
168
171
  * Represents the explicit usage declaration for UI5 reuse components
@@ -178,10 +181,6 @@ export type JSONSchemaForSAPUI5Namespace = {
178
181
  * Represents the minimum version of SAP UI5 that your component requires
179
182
  */
180
183
  minUI5Version: string;
181
- /**
182
- * Represents ...
183
- */
184
- incompatibleLimitation?: boolean;
185
184
  /**
186
185
  * Represents the id (namespace) of the libraries that should be loaded by UI5 Core to be used in your component
187
186
  */
@@ -430,6 +429,10 @@ export type RootViewDef =
430
429
  async?: boolean;
431
430
  [k: string]: unknown;
432
431
  };
432
+ /**
433
+ * Represents a binding string to indicate, how the reuse component should be bound relative to the containing page or absolute
434
+ */
435
+ export type ComponentBindingDef = string;
433
436
  /**
434
437
  * Represents the card default grid size in columns and rows
435
438
  */
@@ -464,104 +467,9 @@ export type LevelsDef = unknown[];
464
467
  /**
465
468
  * Represents general card attributes
466
469
  */
467
- export type JSONSchemaForSAPCARDNamespace =
468
- | ({
469
- type?: "List";
470
- [k: string]: unknown;
471
- } & {
472
- content?: ContentType;
473
- [k: string]: unknown;
474
- })
475
- | ({
476
- type?: "Analytical";
477
- [k: string]: unknown;
478
- } & {
479
- content?: ContentType1;
480
- [k: string]: unknown;
481
- })
482
- | ({
483
- type?: "Timeline";
484
- [k: string]: unknown;
485
- } & {
486
- content?: ContentType2;
487
- [k: string]: unknown;
488
- })
489
- | ({
490
- type?: "Table";
491
- [k: string]: unknown;
492
- } & {
493
- content?: ContentType3;
494
- [k: string]: unknown;
495
- })
496
- | ({
497
- type?: "Object";
498
- [k: string]: unknown;
499
- } & {
500
- content?: ContentType4;
501
- [k: string]: unknown;
502
- })
503
- | ({
504
- type?: "Component";
505
- [k: string]: unknown;
506
- } & {
507
- content?: "null";
508
- [k: string]: unknown;
509
- })
510
- | ({
511
- type?: "Calendar";
512
- [k: string]: unknown;
513
- } & {
514
- content?: ContentType5;
515
- [k: string]: unknown;
516
- })
517
- | ({
518
- type?: "AdaptiveCard";
519
- [k: string]: unknown;
520
- } & {
521
- content?: ContentType6;
522
- [k: string]: unknown;
523
- });
524
- export type SimpleBinding = string;
525
- /**
526
- * Represents state of an entity
527
- */
528
- export type State = "Error" | "Success" | "Warning" | "None" | "Information";
529
- export type IconBackgroundColor =
530
- | (
531
- | "Accent1"
532
- | "Accent2"
533
- | "Accent3"
534
- | "Accent4"
535
- | "Accent5"
536
- | "Accent6"
537
- | "Accent7"
538
- | "Accent8"
539
- | "Accent9"
540
- | "Accent10"
541
- | "Placeholder"
542
- | "Random"
543
- | "TileIcon"
544
- | "Transparent"
545
- )
546
- | SimpleBinding;
547
- /**
548
- * [Experimental] Describes Microchart attributes
549
- */
550
- export type Microchart = Microchart1 | Microchart2;
551
- export type EnumsValueColor = "Critical" | "Error" | "Good" | "Neutral";
552
- /**
553
- * Represents options for text alignments
554
- */
555
- export type TextAlign = "Begin" | "Center" | "End" | "Initial" | "Left" | "Right";
556
- /**
557
- * Represents identifier
558
- */
559
- export type Identifier =
560
- | boolean
561
- | {
562
- url?: string;
563
- target?: Target;
564
- };
470
+ export type JSONSchemaForSAPCARDNamespace = {
471
+ [k: string]: unknown;
472
+ };
565
473
  /**
566
474
  * The version number of the schema in major.minor.patch format.
567
475
  */
@@ -599,7 +507,16 @@ export interface SAPJSONSchemaForWebApplicationManifestFile {
599
507
  | "1.25.0"
600
508
  | "1.26.0"
601
509
  | "1.27.0"
602
- | "1.28.0";
510
+ | "1.28.0"
511
+ | "1.29.0"
512
+ | "1.30.0"
513
+ | "1.31.0"
514
+ | "1.32.0"
515
+ | "1.33.0"
516
+ | "1.34.0"
517
+ | "1.35.0"
518
+ | "1.36.0"
519
+ | "1.37.0";
603
520
  /**
604
521
  * Represents the URL that the developer would prefer the user agent load when the user launches the web application
605
522
  */
@@ -654,7 +571,10 @@ export interface JSONSchemaForSAPAPPNamespace {
654
571
  | "1.11.0"
655
572
  | "1.12.0"
656
573
  | "1.13.0"
657
- | "1.14.0";
574
+ | "1.14.0"
575
+ | "1.15.0"
576
+ | "1.16.0"
577
+ | "1.17.0";
658
578
  /**
659
579
  * Represents the template from which the app was generated
660
580
  */
@@ -750,23 +670,23 @@ export interface JSONSchemaForSAPAPPNamespace {
750
670
  */
751
671
  embeddedBy?: string;
752
672
  /**
753
- * Represents mandatory title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
673
+ * Represents a title (mandatory); to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
754
674
  */
755
675
  title: string;
756
676
  /**
757
- * Represents subtitle to the title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
677
+ * Represents a subtitle to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
758
678
  */
759
679
  subTitle?: string;
760
680
  /**
761
- * Represents shorter version of the title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
681
+ * Represents a shorter version of the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
762
682
  */
763
683
  shortTitle?: string;
764
684
  /**
765
- * Represents additional information to the title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
685
+ * Represents additional information to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
766
686
  */
767
687
  info?: string;
768
688
  /**
769
- * Represents description; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
689
+ * Represents a description; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
770
690
  */
771
691
  description?: string;
772
692
  /**
@@ -846,9 +766,9 @@ export interface DataSourceEnum {
846
766
  */
847
767
  uri: string;
848
768
  /**
849
- * Represents type of the data source. The supported types are OData, ODataAnnotation, INA, XML, JSON
769
+ * Represents type of the data source. The supported types are OData, ODataAnnotation, INA, XML, JSON, FHIR, WebSocket, http
850
770
  */
851
- type?: "OData" | "ODataAnnotation" | "INA" | "XML" | "JSON" | "FHIR";
771
+ type?: "OData" | "ODataAnnotation" | "INA" | "XML" | "JSON" | "FHIR" | "WebSocket" | "http";
852
772
  settings?: Setting;
853
773
  customType?: false;
854
774
  }
@@ -872,14 +792,29 @@ export interface Setting {
872
792
  * Indicates that the client is unwilling to accept a response whose age is greater than the number of seconds specified in this field
873
793
  */
874
794
  maxAge?: number;
795
+ /**
796
+ * Dictionary of (catalog) objects offered by the datasource
797
+ */
798
+ objects?: {
799
+ /**
800
+ * A (catalog) object of an InA DataSource
801
+ */
802
+ [k: string]: {
803
+ objectName: ObjectName;
804
+ objectType: ObjectType;
805
+ packageName?: string;
806
+ schemaName?: string;
807
+ };
808
+ };
809
+ [k: string]: unknown;
875
810
  }
876
811
  export interface DataSourceCustom {
877
812
  /**
878
- * Represents uri of the data source
813
+ * Represents the uri of the data source, should always be given in lower case
879
814
  */
880
815
  uri: string;
881
816
  /**
882
- * Represents type of the data source. The supported types are OData, ODataAnnotation, INA, XML, JSON
817
+ * Represents type of the data source. The supported types are OData, ODataAnnotation, INA, XML, JSON, FHIR, WebSocket, http
883
818
  */
884
819
  type?: string;
885
820
  settings?: Setting1;
@@ -908,6 +843,21 @@ export interface Setting1 {
908
843
  * Indicates that the client is unwilling to accept a response whose age is greater than the number of seconds specified in this field
909
844
  */
910
845
  maxAge?: number;
846
+ /**
847
+ * Dictionary of (catalog) objects offered by the datasource
848
+ */
849
+ objects?: {
850
+ /**
851
+ * A (catalog) object of an InA DataSource
852
+ */
853
+ [k: string]: {
854
+ objectName: ObjectName;
855
+ objectType: ObjectType;
856
+ packageName?: string;
857
+ schemaName?: string;
858
+ };
859
+ };
860
+ [k: string]: unknown;
911
861
  }
912
862
  export interface OpenSource {
913
863
  /**
@@ -949,19 +899,19 @@ export interface Inbound {
949
899
  */
950
900
  icon?: string;
951
901
  /**
952
- * Represents title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
902
+ * Represents a title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
953
903
  */
954
904
  title?: string;
955
905
  /**
956
- * Represents subtitle; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
906
+ * Represents a subtitle; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
957
907
  */
958
908
  subTitle?: string;
959
909
  /**
960
- * Represents shorter version of the title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
910
+ * Represents a shorter version of the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
961
911
  */
962
912
  shortTitle?: string;
963
913
  /**
964
- * Represents additional information to the title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
914
+ * Represents additional information to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
965
915
  */
966
916
  info?: string;
967
917
  /**
@@ -1774,7 +1724,7 @@ export interface JSONSchemaForSAPFIORINamespace {
1774
1724
  /**
1775
1725
  * Represents attributes format version. It is managed by namespace owner
1776
1726
  */
1777
- _version?: "1.1.0";
1727
+ _version?: "1.1.0" | "1.2.0";
1778
1728
  /**
1779
1729
  * Represents array of registration ids, i.e. for Fiori apps fiori id(s)
1780
1730
  */
@@ -1783,12 +1733,16 @@ export interface JSONSchemaForSAPFIORINamespace {
1783
1733
  * Represents architecture type of an application. The supported types are transactional or analytical or factsheet or reusecomponent or fpmwebdynpro or designstudio
1784
1734
  */
1785
1735
  archeType: "transactional" | "analytical" | "factsheet" | "reusecomponent" | "fpmwebdynpro" | "designstudio";
1736
+ /**
1737
+ * Indicator that app is an abstract (generic) app which may not be used directly, but needs to be specialized in the SAP Fiori launchpad content
1738
+ */
1739
+ abstract?: boolean;
1786
1740
  }
1787
1741
  /**
1788
1742
  * Represents GENERIC APP specific attributes
1789
1743
  */
1790
1744
  export interface JSONSchemaForSAPUIGENERICAPPNamespace {
1791
- _version?: "1.1.0" | "1.2.0" | "1.3.0" | "1.4.0";
1745
+ _version?: "1.1.0" | "1.2.0" | "1.3.0" | "1.4.0" | "1.5.0";
1792
1746
  settings?: SettingDef;
1793
1747
  /**
1794
1748
  * Represents one ore more pages of an application. UI5 routing is created from the definitions in this section
@@ -1818,7 +1772,28 @@ export interface PagesArray {
1818
1772
  navigation?: NavigationDef;
1819
1773
  embeddedComponents?: EmbeddedComponent;
1820
1774
  routingSpec?: RoutingSpecDef;
1821
- implementingComponent?: ImplementingComponentDef;
1775
+ /**
1776
+ * Represents the component to be loaded inside the canvas if sap.suite.ui.generic.template.Canvas is used as component name, and its settings
1777
+ */
1778
+ implementingComponent?:
1779
+ | {
1780
+ /**
1781
+ * Represents the name of the component to be loaded inside the canvas
1782
+ */
1783
+ componentName: string;
1784
+ binding?: ComponentBindingDef;
1785
+ settings?: ComponentSettingDef;
1786
+ pages?: ComponentPagesDef;
1787
+ }
1788
+ | {
1789
+ /**
1790
+ * Represents the reference to the name of the componentUsages defined in sap.ui5/componentUsages for the component to be loaded inside the canvas
1791
+ */
1792
+ componentUsage: string;
1793
+ binding?: ComponentBindingDef;
1794
+ settings?: ComponentSettingDef;
1795
+ pages?: ComponentPagesDef;
1796
+ };
1822
1797
  /**
1823
1798
  * Default layout used to open the corresponding page in FlexibleColumnLayout
1824
1799
  */
@@ -1869,6 +1844,18 @@ export interface ActionPropDef {
1869
1844
  * Represents the pointer to a semantic object
1870
1845
  */
1871
1846
  target: string;
1847
+ refreshStrategyOnAppRestore?: RefreshStrategiesPropDef;
1848
+ }
1849
+ /**
1850
+ * Represents the refresh strategies configured for external display navigation while coming back to the source app
1851
+ */
1852
+ export interface RefreshStrategiesPropDef {
1853
+ /**
1854
+ * Represents the map of entity sets configured for refresh strategies
1855
+ */
1856
+ entitySets?: {
1857
+ [k: string]: unknown;
1858
+ };
1872
1859
  }
1873
1860
  /**
1874
1861
  * Represents an action triggered by the user on UI: the navigation to create an object
@@ -1882,6 +1869,7 @@ export interface ActionPropDef1 {
1882
1869
  * Represents the pointer to a semantic object
1883
1870
  */
1884
1871
  target: string;
1872
+ refreshStrategyOnAppRestore?: RefreshStrategiesPropDef;
1885
1873
  }
1886
1874
  /**
1887
1875
  * Represents an action triggered by the user on UI: the navigation to edit an object
@@ -1895,6 +1883,7 @@ export interface ActionPropDef2 {
1895
1883
  * Represents the pointer to a semantic object
1896
1884
  */
1897
1885
  target: string;
1886
+ refreshStrategyOnAppRestore?: RefreshStrategiesPropDef;
1898
1887
  }
1899
1888
  /**
1900
1889
  * Represent reuse components that should be appended at the end of the template component
@@ -2054,25 +2043,11 @@ export interface RoutingSpecDef {
2054
2043
  */
2055
2044
  noKey?: boolean;
2056
2045
  }
2057
- /**
2058
- * Represents the component to be loaded inside the canvas if sap.suite.ui.generic.template.Canvas is used as component name, and its settings
2059
- */
2060
- export interface ImplementingComponentDef {
2061
- /**
2062
- * Represents the name of the component to be loaded inside the canvas
2063
- */
2064
- componentName: string;
2065
- /**
2066
- * Represents a binding string to indicate, how the reuse component should be bound relative to the containing page or absolute
2067
- */
2068
- binding?: string;
2069
- settings?: ComponentSettingDef;
2070
- pages?: {
2071
- [k: string]: PagesMap;
2072
- };
2046
+ export interface ComponentPagesDef {
2047
+ [k: string]: PagesMap;
2073
2048
  }
2074
2049
  /**
2075
- * This interface was referenced by `undefined`'s JSON-Schema definition
2050
+ * This interface was referenced by `ComponentPagesDef`'s JSON-Schema definition
2076
2051
  * via the `patternProperty` "^[a-zA-Z0-9_\.\-]+[\|]?[a-zA-Z0-9_\.\-]+$".
2077
2052
  *
2078
2053
  * This interface was referenced by `undefined`'s JSON-Schema definition
@@ -2091,7 +2066,28 @@ export interface PagesMap {
2091
2066
  navigation?: NavigationDef1;
2092
2067
  embeddedComponents?: EmbeddedComponent2;
2093
2068
  routingSpec?: RoutingSpecDef1;
2094
- implementingComponent?: ImplementingComponentDef1;
2069
+ /**
2070
+ * Represents the component to be loaded inside the canvas if sap.suite.ui.generic.template.Canvas is used as component name, and its settings
2071
+ */
2072
+ implementingComponent?:
2073
+ | {
2074
+ /**
2075
+ * Represents the name of the component to be loaded inside the canvas
2076
+ */
2077
+ componentName: string;
2078
+ binding?: ComponentBindingDef;
2079
+ settings?: ComponentSettingDef;
2080
+ pages?: ComponentPagesDef;
2081
+ }
2082
+ | {
2083
+ /**
2084
+ * Represents the reference to the name of the componentUsages defined in sap.ui5/componentUsages for the component to be loaded inside the canvas
2085
+ */
2086
+ componentUsage: string;
2087
+ binding?: ComponentBindingDef;
2088
+ settings?: ComponentSettingDef;
2089
+ pages?: ComponentPagesDef;
2090
+ };
2095
2091
  /**
2096
2092
  * Default layout used to open the corresponding page in FlexibleColumnLayout
2097
2093
  */
@@ -2221,23 +2217,6 @@ export interface RoutingSpecDef1 {
2221
2217
  */
2222
2218
  noKey?: boolean;
2223
2219
  }
2224
- /**
2225
- * Represents the component to be loaded inside the canvas if sap.suite.ui.generic.template.Canvas is used as component name, and its settings
2226
- */
2227
- export interface ImplementingComponentDef1 {
2228
- /**
2229
- * Represents the name of the component to be loaded inside the canvas
2230
- */
2231
- componentName: string;
2232
- /**
2233
- * Represents a binding string to indicate, how the reuse component should be bound relative to the containing page or absolute
2234
- */
2235
- binding?: string;
2236
- settings?: ComponentSettingDef;
2237
- pages?: {
2238
- [k: string]: PagesMap;
2239
- };
2240
- }
2241
2220
  /**
2242
2221
  * Represents specific attributes for Fiori Elements
2243
2222
  */
@@ -2295,7 +2274,7 @@ export interface JSONSchemaForSAPOVPNamespace {
2295
2274
  /**
2296
2275
  * Represents attributes format version. It is managed by namespace owner
2297
2276
  */
2298
- _version?: "1.1.0" | "1.2.0" | "1.3.0";
2277
+ _version?: "1.1.0" | "1.2.0" | "1.3.0" | "1.4.0";
2299
2278
  /**
2300
2279
  * Represents the name of global filter OData model, which contains entities definition that are relevant for global filters
2301
2280
  */
@@ -2352,6 +2331,16 @@ export interface JSONSchemaForSAPOVPNamespace {
2352
2331
  * Flag to enable/disable semantic date range control for Smart filter bar
2353
2332
  */
2354
2333
  useDateRangeType?: boolean;
2334
+ /**
2335
+ * Represents the object to store analytical chart settings
2336
+ */
2337
+ chartSettings?: {
2338
+ /**
2339
+ * Flag to enable data labels on analytical charts
2340
+ */
2341
+ showDataLabel?: boolean;
2342
+ [k: string]: unknown;
2343
+ };
2355
2344
  cards: {
2356
2345
  [k: string]: Card;
2357
2346
  };
@@ -2949,845 +2938,6 @@ export interface JSONSchemaForSAPCLOUDNamespace {
2949
2938
  */
2950
2939
  public?: boolean;
2951
2940
  }
2952
- /**
2953
- * Represents list content attributes
2954
- */
2955
- export interface ContentType {
2956
- data?: Data;
2957
- item?: ContentTypeList;
2958
- /**
2959
- * Represents number of items
2960
- */
2961
- maxItems?: number | SimpleBinding;
2962
- }
2963
- /**
2964
- * Represents request and response attributes
2965
- */
2966
- export interface Data {
2967
- request?: Request;
2968
- /**
2969
- * The path from the JSON to be used as root
2970
- */
2971
- path?: string;
2972
- /**
2973
- * The data to be used directly. Without making requests.
2974
- */
2975
- json?:
2976
- | {
2977
- [k: string]: unknown;
2978
- }
2979
- | unknown[];
2980
- service?: Service;
2981
- /**
2982
- * Represents interval in seconds, after which a new data request will be triggered.
2983
- */
2984
- updateInterval?: number | SimpleBinding;
2985
- extension?: Extension;
2986
- }
2987
- /**
2988
- * Represents request attributes
2989
- */
2990
- export interface Request {
2991
- /**
2992
- * The mode of the request
2993
- */
2994
- mode?: (("no-cors" | "same-origin" | "cors") | SimpleBinding) & string;
2995
- /**
2996
- * The URL to make the request to
2997
- */
2998
- url: string;
2999
- /**
3000
- * The HTTP method
3001
- */
3002
- method?: (("GET" | "POST") | SimpleBinding) & string;
3003
- parameters?: Parameters;
3004
- /**
3005
- * Represents HTTP headers
3006
- */
3007
- headers?: {
3008
- [k: string]: unknown;
3009
- };
3010
- /**
3011
- * Indicates whether cross-site requests should be made using credentials.
3012
- */
3013
- withCredentials?: boolean | SimpleBinding;
3014
- }
3015
- /**
3016
- * Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request
3017
- */
3018
- export interface Parameters {
3019
- [k: string]: unknown;
3020
- }
3021
- /**
3022
- * [Experimental] Provides a way to request data via extension.
3023
- */
3024
- export interface Extension {
3025
- /**
3026
- * The method of the extension, which fetches data.
3027
- */
3028
- method: string;
3029
- /**
3030
- * The arguments, with which the method will be called.
3031
- */
3032
- args?: unknown[];
3033
- }
3034
- /**
3035
- * The template for all items
3036
- */
3037
- export interface ContentTypeList {
3038
- /**
3039
- * The title of the item.
3040
- */
3041
- title?: Field | string;
3042
- /**
3043
- * The description of the item.
3044
- */
3045
- description?: Field | string;
3046
- info?: {
3047
- /**
3048
- * The value of the field
3049
- */
3050
- value?: string;
3051
- state?: State | SimpleBinding;
3052
- };
3053
- /**
3054
- * The highlight of the item.
3055
- */
3056
- highlight?: (State | SimpleBinding) & string;
3057
- icon?: Icon;
3058
- /**
3059
- * Defines actions that can be applied on the item.
3060
- */
3061
- actions?: Action[];
3062
- chart?: Microchart;
3063
- }
3064
- export interface Field {
3065
- /**
3066
- * Represents a label of the field; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
3067
- */
3068
- label?: string;
3069
- /**
3070
- * The value of the field
3071
- */
3072
- value?: string;
3073
- }
3074
- /**
3075
- * Represents icon attributes
3076
- */
3077
- export interface Icon {
3078
- /**
3079
- * Represents icon name or source URL
3080
- */
3081
- src?: string;
3082
- /**
3083
- * Alternative text for the icon
3084
- */
3085
- alt?: string;
3086
- /**
3087
- * Represents the shape of the icon
3088
- */
3089
- shape?: (("Square" | "Circle") | SimpleBinding) & string;
3090
- /**
3091
- * Initials for the avatar. Up to 2 symbols. If the image provided to the 'src' property fails to load, then the text will be shown.
3092
- */
3093
- text?: SimpleBinding;
3094
- /**
3095
- * [Experimental] The size of the icon.
3096
- */
3097
- size?: ("XS" | "S" | "M") | SimpleBinding;
3098
- backgroundColor?: IconBackgroundColor;
3099
- }
3100
- /**
3101
- * Represents actions that can be applied on card elements
3102
- */
3103
- export interface Action {
3104
- /**
3105
- * The type of the action
3106
- */
3107
- type: (("Navigation" | "Submit") | SimpleBinding) & string;
3108
- /**
3109
- * Represents the state of the action
3110
- */
3111
- enabled?: boolean | SimpleBinding;
3112
- service?: Service;
3113
- /**
3114
- * Represents the URL that will be used as navigation target if no service is provided
3115
- */
3116
- url?: string;
3117
- parameters?: Parameters1;
3118
- /**
3119
- * Specifies where to open the 'url', if it is provided.
3120
- */
3121
- target?: (Target | SimpleBinding) & string;
3122
- }
3123
- /**
3124
- * Represents parameters that are passed in the actions
3125
- */
3126
- export interface Parameters1 {
3127
- [k: string]: unknown;
3128
- }
3129
- export interface Microchart1 {
3130
- /**
3131
- * Represents the type of the Microchart.
3132
- */
3133
- type: "Bullet";
3134
- /**
3135
- * The actual value shown as a colored horizontal bar
3136
- */
3137
- value?: number | SimpleBinding;
3138
- /**
3139
- * The minimum scale value for the bar chart
3140
- */
3141
- minValue?: number | SimpleBinding;
3142
- /**
3143
- * The maximum scale value for the bar chart
3144
- */
3145
- maxValue?: number | SimpleBinding;
3146
- /**
3147
- * The actual value, which will be displayed as a text next to the bar
3148
- */
3149
- displayValue?: string;
3150
- /**
3151
- * The target value - displayed as a vertical line (marker)
3152
- */
3153
- target?: number | SimpleBinding;
3154
- /**
3155
- * The scaling suffix that is appended to all values
3156
- */
3157
- scale?: string;
3158
- /**
3159
- * The state color of the bar
3160
- */
3161
- color?: (EnumsValueColor | SimpleBinding) & string;
3162
- /**
3163
- * The thresholds indicators of the bar
3164
- */
3165
- thresholds?: MicrochartBullet[];
3166
- }
3167
- export interface MicrochartBullet {
3168
- /**
3169
- * The value of the threshold
3170
- */
3171
- value?: number | SimpleBinding;
3172
- /**
3173
- * The state color of the threshold
3174
- */
3175
- color?: (EnumsValueColor | SimpleBinding) & string;
3176
- }
3177
- export interface Microchart2 {
3178
- /**
3179
- * Represents the type of the Microchart.
3180
- */
3181
- type: "StackedBar";
3182
- /**
3183
- * The maximum scale value for the bar chart
3184
- */
3185
- maxValue?: number | SimpleBinding;
3186
- /**
3187
- * The value, which will be displayed as a text next to the bar
3188
- */
3189
- displayValue?: string;
3190
- /**
3191
- * The bars of the chart.
3192
- */
3193
- bars?: MicrochartStackedBar[];
3194
- }
3195
- export interface MicrochartStackedBar {
3196
- /**
3197
- * The actual value shown as a colored horizontal bar
3198
- */
3199
- value?: number | SimpleBinding;
3200
- /**
3201
- * The value, which will be displayed as a text in the tooltip of the bar
3202
- */
3203
- displayValue?: string;
3204
- /**
3205
- * Title, which will be displayed in the legend
3206
- */
3207
- legendTitle?: string;
3208
- /**
3209
- * The color of the bar
3210
- */
3211
- color?: (EnumsValueColor | string) & string;
3212
- }
3213
- /**
3214
- * Represents analytical content attributes
3215
- */
3216
- export interface ContentType1 {
3217
- data?: Data;
3218
- /**
3219
- * Describes the type of the chart
3220
- */
3221
- chartType?: (("Line" | "StackedColumn" | "StackedBar" | "Donut") | SimpleBinding) & string;
3222
- legend?: ContentTypeAnalytical;
3223
- /**
3224
- * Describes the plotArea properties
3225
- */
3226
- plotArea?: {
3227
- dataLabel?: ContentTypeAnalytical1;
3228
- categoryAxisText?: ContentTypeAnalytical2;
3229
- valueAxisText?: ContentTypeAnalytical2;
3230
- };
3231
- /**
3232
- * Represents title attributes
3233
- */
3234
- title?: {
3235
- /**
3236
- * Represents the visibility state of the title
3237
- */
3238
- visible?: boolean | SimpleBinding;
3239
- /**
3240
- * Represents title text
3241
- */
3242
- text?: string;
3243
- /**
3244
- * Represents the title alignment
3245
- */
3246
- alignment?: ("Left" | "Center" | "Right") | SimpleBinding;
3247
- };
3248
- /**
3249
- * Represents the value set for measure axis
3250
- */
3251
- measureAxis?: string;
3252
- /**
3253
- * Represents the value set for dimension axis
3254
- */
3255
- dimensionAxis?: string;
3256
- dimensions?: Field[];
3257
- measures?: Field[];
3258
- /**
3259
- * Defines actions that can be applied on the content.
3260
- */
3261
- actions?: Action[];
3262
- }
3263
- /**
3264
- * Represents chart legend attributes
3265
- */
3266
- export interface ContentTypeAnalytical {
3267
- /**
3268
- * Represent the visibility state of the legend
3269
- */
3270
- visible?: boolean | SimpleBinding;
3271
- /**
3272
- * Representation of where the legend will be positioned
3273
- */
3274
- position?: (("Top" | "Bottom" | "Left" | "Right") | SimpleBinding) & string;
3275
- /**
3276
- * Representation of how the legend will be aligned
3277
- */
3278
- alignment?: (("TopLeft" | "Center") | SimpleBinding) & string;
3279
- }
3280
- /**
3281
- * Represents value attributes in the plot area
3282
- */
3283
- export interface ContentTypeAnalytical1 {
3284
- /**
3285
- * Represents the visibility state of the dataLabel
3286
- */
3287
- visible?: boolean | SimpleBinding;
3288
- /**
3289
- * Represents the visibility state of 'show total' indicator
3290
- */
3291
- showTotal?: boolean | SimpleBinding;
3292
- }
3293
- /**
3294
- * Represents descriptive text of the axis
3295
- */
3296
- export interface ContentTypeAnalytical2 {
3297
- /**
3298
- * Represents the visibility state of the descriptive axis text
3299
- */
3300
- visible?: boolean | SimpleBinding;
3301
- }
3302
- /**
3303
- * Represents time related content
3304
- */
3305
- export interface ContentType2 {
3306
- data?: Data;
3307
- item?: ContentTypeTimeline;
3308
- /**
3309
- * Represents number of items
3310
- */
3311
- maxItems?: number | SimpleBinding;
3312
- }
3313
- /**
3314
- * Defines the timeline item
3315
- */
3316
- export interface ContentTypeTimeline {
3317
- title?: Field1;
3318
- description?: Field2;
3319
- dateTime?: Field3;
3320
- owner?: Field4;
3321
- /**
3322
- * The owner image of the timeline item.
3323
- */
3324
- ownerImage?: {
3325
- value?: string;
3326
- [k: string]: unknown;
3327
- };
3328
- icon?: SimpleIcon;
3329
- }
3330
- /**
3331
- * The title of the timeline item.
3332
- */
3333
- export interface Field1 {
3334
- /**
3335
- * Represents a label of the field; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
3336
- */
3337
- label?: string;
3338
- /**
3339
- * The value of the field
3340
- */
3341
- value?: string;
3342
- }
3343
- /**
3344
- * The description of the timeline item.
3345
- */
3346
- export interface Field2 {
3347
- /**
3348
- * Represents a label of the field; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
3349
- */
3350
- label?: string;
3351
- /**
3352
- * The value of the field
3353
- */
3354
- value?: string;
3355
- }
3356
- /**
3357
- * The dateTime value of the timeline item.
3358
- */
3359
- export interface Field3 {
3360
- /**
3361
- * Represents a label of the field; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
3362
- */
3363
- label?: string;
3364
- /**
3365
- * The value of the field
3366
- */
3367
- value?: string;
3368
- }
3369
- /**
3370
- * The owner of the timeline item.
3371
- */
3372
- export interface Field4 {
3373
- /**
3374
- * Represents a label of the field; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
3375
- */
3376
- label?: string;
3377
- /**
3378
- * The value of the field
3379
- */
3380
- value?: string;
3381
- }
3382
- /**
3383
- * The icon of the timeline item.
3384
- */
3385
- export interface SimpleIcon {
3386
- /**
3387
- * Represents icon name or source URL
3388
- */
3389
- src?: string;
3390
- }
3391
- /**
3392
- * Represents table content attributes
3393
- */
3394
- export interface ContentType3 {
3395
- data?: Data;
3396
- /**
3397
- * The template for all rows
3398
- */
3399
- row?: {
3400
- /**
3401
- * Defines the columns attributes.
3402
- */
3403
- columns?: ContentTypeTable[];
3404
- /**
3405
- * Defines actions that can be applied on the item.
3406
- */
3407
- actions?: Action[];
3408
- };
3409
- /**
3410
- * Represents number of items
3411
- */
3412
- maxItems?: number | SimpleBinding;
3413
- }
3414
- /**
3415
- * Represents object item attributes
3416
- */
3417
- export interface ContentTypeTable {
3418
- /**
3419
- * Defines a title of the column; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
3420
- */
3421
- title?: string;
3422
- /**
3423
- * Defines the width of the column.
3424
- */
3425
- width?: string;
3426
- /**
3427
- * Defines the horizontal alignment of the column content.
3428
- */
3429
- hAlign?: TextAlign | SimpleBinding;
3430
- /**
3431
- * Represents the text value of the column.
3432
- */
3433
- value?: string;
3434
- icon?: Icon1;
3435
- /**
3436
- * Defines the state of the column.
3437
- */
3438
- state?: State | SimpleBinding;
3439
- /**
3440
- * Defines the URL string.
3441
- */
3442
- url?: string;
3443
- /**
3444
- * Specifies where to open the 'url', if it is provided.
3445
- */
3446
- target?: (Target | SimpleBinding) & string;
3447
- identifier?: Identifier | SimpleBinding;
3448
- progressIndicator?: ProgressIndicator;
3449
- /**
3450
- * Represents the visibility state of the column
3451
- */
3452
- visible?: boolean | SimpleBinding;
3453
- }
3454
- /**
3455
- * Represents icon attributes
3456
- */
3457
- export interface Icon1 {
3458
- /**
3459
- * Represents icon name or source URL
3460
- */
3461
- src?: string;
3462
- /**
3463
- * Alternative text for the icon
3464
- */
3465
- alt?: string;
3466
- shape?: (("Square" | "Circle") | SimpleBinding) & string;
3467
- /**
3468
- * Initials for the avatar. Up to 2 symbols. If the image provided to the 'src' property fails to load, then the text will be shown.
3469
- */
3470
- text?: SimpleBinding;
3471
- /**
3472
- * [Experimental] The size of the icon.
3473
- */
3474
- size?: ("XS" | "S" | "M") | SimpleBinding;
3475
- backgroundColor?: IconBackgroundColor;
3476
- }
3477
- /**
3478
- * Represents progress indicator attributes
3479
- */
3480
- export interface ProgressIndicator {
3481
- /**
3482
- * Represents state color
3483
- */
3484
- state?: State | SimpleBinding;
3485
- /**
3486
- * Represents progress indicator percent value
3487
- */
3488
- percent?: number | SimpleBinding;
3489
- /**
3490
- * Represents progress indicator text
3491
- */
3492
- text?: string;
3493
- }
3494
- /**
3495
- * Represents object content attributes
3496
- */
3497
- export interface ContentType4 {
3498
- data?: Data;
3499
- /**
3500
- * Represents groups of information for an object
3501
- */
3502
- groups?: ContentTypeObject[];
3503
- /**
3504
- * Defines actions that can be applied on the content.
3505
- */
3506
- actions?: Action[];
3507
- }
3508
- /**
3509
- * Represents a group of information for an object
3510
- */
3511
- export interface ContentTypeObject {
3512
- /**
3513
- * Defines a title of the object group; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
3514
- */
3515
- title?: string;
3516
- /**
3517
- * Represents items of information.
3518
- */
3519
- items?: ContentTypeObject1[];
3520
- /**
3521
- * Represents the visibility state of the group
3522
- */
3523
- visible?: boolean | SimpleBinding;
3524
- }
3525
- /**
3526
- * Represents a single item of information. It can contain label, value and image
3527
- */
3528
- export interface ContentTypeObject1 {
3529
- icon?: Icon2;
3530
- /**
3531
- * Defines the label of the item.
3532
- */
3533
- label?: string;
3534
- /**
3535
- * Represents the text, which is associated with the label.
3536
- */
3537
- value?: string;
3538
- /**
3539
- * Defines the type of the displayed information.
3540
- */
3541
- type?: (("phone" | "email" | "link" | "text") | SimpleBinding) & string;
3542
- /**
3543
- * Defines the URL string. Works only with items of type 'link'.
3544
- */
3545
- url?: string;
3546
- /**
3547
- * Specifies the target of the link - it works like the target property of the HTML 'a' tag. Works only with items of type 'link'.
3548
- */
3549
- target?: Target | SimpleBinding;
3550
- /**
3551
- * Represents the subject of the email. Works only with item of type 'email'.
3552
- */
3553
- emailSubject?: string;
3554
- /**
3555
- * Represents the visibility state of the item
3556
- */
3557
- visible?: boolean | SimpleBinding;
3558
- }
3559
- /**
3560
- * Represents icon attributes
3561
- */
3562
- export interface Icon2 {
3563
- /**
3564
- * Represents icon name or source URL
3565
- */
3566
- src?: string;
3567
- /**
3568
- * Alternative text for the icon
3569
- */
3570
- alt?: string;
3571
- shape?: (("Square" | "Circle") | SimpleBinding) & string;
3572
- /**
3573
- * Initials for the avatar. Up to 2 symbols. If the image provided to the 'src' property fails to load, then the text will be shown.
3574
- */
3575
- text?: SimpleBinding;
3576
- /**
3577
- * [Experimental] The size of the icon.
3578
- */
3579
- size?: ("XS" | "S" | "M") | SimpleBinding;
3580
- backgroundColor?: IconBackgroundColor;
3581
- }
3582
- /**
3583
- * The calendar card is used to display a schedule of a single entity (such as person, resource) for a selected time interval.
3584
- */
3585
- export interface ContentType5 {
3586
- data?: Data;
3587
- item?: ContentTypeCalendar;
3588
- legendItem?: ContentTypeCalendar1;
3589
- specialDate?: ContentTypeCalendar2;
3590
- /**
3591
- * The initial date of the calendar which appointments are initially shown. The accepted date format is ISO 8601.
3592
- */
3593
- date?: SimpleBinding;
3594
- /**
3595
- * Represents number of items displayed
3596
- */
3597
- maxItems?: number | SimpleBinding;
3598
- /**
3599
- * Represents number of legendItems displayed
3600
- */
3601
- maxLegendItems?: number | SimpleBinding;
3602
- /**
3603
- * The text shown when there are no items for the selected day
3604
- */
3605
- noItemsText?: SimpleBinding;
3606
- /**
3607
- * Defines actions that can be applied on the button showing there are more items than the shown
3608
- */
3609
- moreItems?: {
3610
- /**
3611
- * Represents an action that can be applied on he button showing there are more items than the shown.
3612
- */
3613
- actions?: Action[];
3614
- [k: string]: unknown;
3615
- };
3616
- }
3617
- /**
3618
- * Describes each item.
3619
- */
3620
- export interface ContentTypeCalendar {
3621
- template?: ContentTypeCalendarItem;
3622
- /**
3623
- * Defines the path to the structure holding the data about the items.
3624
- */
3625
- path?: string;
3626
- }
3627
- /**
3628
- * The template for all items
3629
- */
3630
- export interface ContentTypeCalendarItem {
3631
- /**
3632
- * The start date of the item. The accepted date format is ISO 8601.
3633
- */
3634
- startDate?: string;
3635
- /**
3636
- * The end date of the item. The accepted date format is ISO 8601.
3637
- */
3638
- endDate?: string;
3639
- /**
3640
- * The title of the item.
3641
- */
3642
- title?: string;
3643
- /**
3644
- * The additional information of the item.
3645
- */
3646
- text?: string;
3647
- icon?: SimpleIcon1;
3648
- /**
3649
- * The type of the item - one of the types defined in the legend.
3650
- */
3651
- type?:
3652
- | (
3653
- | "Type01"
3654
- | "Type02"
3655
- | "Type03"
3656
- | "Type04"
3657
- | "Type05"
3658
- | "Type06"
3659
- | "Type07"
3660
- | "Type08"
3661
- | "Type09"
3662
- | "Type10"
3663
- | "Type11"
3664
- | "Type12"
3665
- | "Type13"
3666
- | "Type14"
3667
- | "Type15"
3668
- | "Type16"
3669
- | "Type17"
3670
- | "Type18"
3671
- | "Type19"
3672
- | "Type20"
3673
- )
3674
- | SimpleBinding;
3675
- }
3676
- /**
3677
- * Represents simple icon attributes
3678
- */
3679
- export interface SimpleIcon1 {
3680
- /**
3681
- * Represents icon name or source URL
3682
- */
3683
- src?: string;
3684
- }
3685
- /**
3686
- * Describes each legendItem.
3687
- */
3688
- export interface ContentTypeCalendar1 {
3689
- template?: ContentTypeCalendarLegendItem;
3690
- /**
3691
- * Defines the path to the structure holding the data about the legendItems.
3692
- */
3693
- path?: string;
3694
- }
3695
- /**
3696
- * The template for all legendItems
3697
- */
3698
- export interface ContentTypeCalendarLegendItem {
3699
- /**
3700
- * Defines which card component describes the legend item. Available categories: "calendar" (represented as square) or "appointment" (circle).
3701
- */
3702
- category?: string;
3703
- /**
3704
- * The describing information of the item.
3705
- */
3706
- text?: string;
3707
- /**
3708
- * The type of the legend item corresponding with the described component.
3709
- */
3710
- type?:
3711
- | (
3712
- | "Type01"
3713
- | "Type02"
3714
- | "Type03"
3715
- | "Type04"
3716
- | "Type05"
3717
- | "Type06"
3718
- | "Type07"
3719
- | "Type08"
3720
- | "Type09"
3721
- | "Type10"
3722
- | "Type11"
3723
- | "Type12"
3724
- | "Type13"
3725
- | "Type14"
3726
- | "Type15"
3727
- | "Type16"
3728
- | "Type17"
3729
- | "Type18"
3730
- | "Type19"
3731
- | "Type20"
3732
- )
3733
- | SimpleBinding;
3734
- }
3735
- /**
3736
- * Describes each specialDate.
3737
- */
3738
- export interface ContentTypeCalendar2 {
3739
- template?: ContentTypeCalendarSpecialDate;
3740
- /**
3741
- * Defines the path to the structure holding the data about the specialDates.
3742
- */
3743
- path?: string;
3744
- }
3745
- /**
3746
- * The template for all specialDates
3747
- */
3748
- export interface ContentTypeCalendarSpecialDate {
3749
- /**
3750
- * The start date of the special date. The accepted date format is ISO 8601.
3751
- */
3752
- startDate?: string;
3753
- /**
3754
- * The end date of the special date. The accepted date format is ISO 8601.
3755
- */
3756
- endDate?: string;
3757
- /**
3758
- * The type of the special date - one of the types defined in the legend.
3759
- */
3760
- type?:
3761
- | (
3762
- | "Type01"
3763
- | "Type02"
3764
- | "Type03"
3765
- | "Type04"
3766
- | "Type05"
3767
- | "Type06"
3768
- | "Type07"
3769
- | "Type08"
3770
- | "Type09"
3771
- | "Type10"
3772
- | "Type11"
3773
- | "Type12"
3774
- | "Type13"
3775
- | "Type14"
3776
- | "Type15"
3777
- | "Type16"
3778
- | "Type17"
3779
- | "Type18"
3780
- | "Type19"
3781
- | "Type20"
3782
- )
3783
- | SimpleBinding;
3784
- }
3785
- /**
3786
- * Represents AdaptiveCard content (external reference omitted in generated typings)
3787
- */
3788
- export interface ContentType6 {
3789
- [k: string]: unknown;
3790
- }
3791
2941
  /**
3792
2942
  * Represents general package attributes. Experimental, will be detailed in the future
3793
2943
  */
@@ -3823,23 +2973,23 @@ export interface JSONSchemaForSAPPACKAGENamespace {
3823
2973
  */
3824
2974
  type?: "card" | "workflow" | "workspace-template";
3825
2975
  /**
3826
- * Represents mandatory title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
2976
+ * Represents a title (mandatory); to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3827
2977
  */
3828
2978
  title: string;
3829
2979
  /**
3830
- * Represents subtitle to the title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
2980
+ * Represents a subtitle to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3831
2981
  */
3832
2982
  subTitle?: string;
3833
2983
  /**
3834
- * Represents shorter version of the title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
2984
+ * Represents a shorter version of the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3835
2985
  */
3836
2986
  shortTitle?: string;
3837
2987
  /**
3838
- * Represents additional information to the title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
2988
+ * Represents additional information to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3839
2989
  */
3840
2990
  info?: string;
3841
2991
  /**
3842
- * Represents description; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
2992
+ * Represents a description; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3843
2993
  */
3844
2994
  description: string;
3845
2995
  /**
@@ -3993,23 +3143,23 @@ export interface JSONSchemaForSAPARTIFACTNamespace {
3993
3143
  */
3994
3144
  type: "card" | "workflow" | "workspace-template";
3995
3145
  /**
3996
- * Represents mandatory title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
3146
+ * Represents a title (mandatory); to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3997
3147
  */
3998
3148
  title: string;
3999
3149
  /**
4000
- * Represents subtitle to the title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
3150
+ * Represents a subtitle to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
4001
3151
  */
4002
3152
  subTitle?: string;
4003
3153
  /**
4004
- * Represents shorter version of the title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
3154
+ * Represents a shorter version of the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
4005
3155
  */
4006
3156
  shortTitle?: string;
4007
3157
  /**
4008
- * Represents additional information to the title; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
3158
+ * Represents additional information to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
4009
3159
  */
4010
3160
  info?: string;
4011
3161
  /**
4012
- * Represents description; this property is language dependent and, therefore, a key in double curly brackets '{{key}}' must be used
3162
+ * Represents a description; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
4013
3163
  */
4014
3164
  description: string;
4015
3165
  /**