@sap/ux-specification 1.96.9 → 1.100.1
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 +21 -154
- package/dist/documentation/v2/v2-AnalyticalListPage.html +1 -1
- package/dist/documentation/v2/v2-ApplicationV2.html +1 -1
- package/dist/documentation/v2/v2-ListReport.html +1 -1
- package/dist/documentation/v2/v2-ObjectPage.html +1 -1
- package/dist/documentation/v2/v2-OverviewPage.html +1 -1
- package/dist/documentation/v4/v4-ApplicationV4.html +1 -1
- package/dist/documentation/v4/v4-ListReport.html +1 -1
- package/dist/documentation/v4/v4-ObjectPage.html +1 -1
- package/dist/index-min.js +1 -1
- package/dist/schemas/v2/ListReportConfig.json +37 -0
- package/dist/schemas/v4/ListReportConfig.json +38 -3
- package/dist/schemas/v4/ObjectPageConfig.json +36 -0
- package/dist/specification/v2/index-min.js +1 -1
- package/dist/src/apiTypes.d.ts +2 -1
- package/dist/src/specification/v2/controls/Table.d.ts +21 -0
- package/dist/src/specification/v4/controls/FilterBar.d.ts +4 -0
- package/dist/src/specification/v4/controls/ObjectPageSection.d.ts +22 -1
- package/dist/src/specification/v4/controls/Table.d.ts +8 -0
- package/dist/src/specification/v4/pages/ListReportConfig.d.ts +6 -1
- package/dist/src/specification/v4/webapp/manifest/sapUiPageV4.d.ts +1 -0
- package/dist/src/sync/common/generate/objectPage.d.ts +5 -4
- package/dist/src/sync/common/generate/utils.d.ts +44 -13
- package/dist/src/sync/common/types.d.ts +101 -26
- package/dist/src/sync/common/utils.d.ts +23 -11
- package/dist/src/sync/v2/export/controls/FilterBar.d.ts +0 -1
- package/dist/src/sync/v2/export/controls/Table.d.ts +8 -1
- package/dist/src/sync/v2/export/export.d.ts +0 -1
- package/dist/src/sync/v2/export/manifest.d.ts +22 -0
- package/dist/src/sync/v2/export/pages/OverviewPage.d.ts +1 -1
- package/dist/src/sync/v2/generate/utils.d.ts +11 -4
- package/dist/src/sync/v2/import/app/appProvider.d.ts +9 -0
- package/dist/src/sync/v4/application.d.ts +22 -10
- package/dist/src/sync/v4/export/controls/FilterBar.d.ts +1 -0
- package/dist/src/sync/v4/export/controls/Table.d.ts +6 -1
- package/dist/src/sync/v4/export/pages/ListReport.d.ts +1 -0
- package/dist/src/sync/v4/export/types.d.ts +5 -5
- package/dist/src/sync/v4/generate/objectPage.d.ts +1 -1
- package/dist/src/sync/v4/import/pages/objectPage.d.ts +13 -0
- package/dist/src/sync/v4/import/utils.d.ts +2 -1
- package/dist/src/sync/v4/types.d.ts +2 -0
- package/dist/src/sync/v4/utils/utils.d.ts +9 -10
- package/dist/test/unit/export/manifest.test.d.ts +1 -0
- package/package.json +3 -3
|
@@ -93,6 +93,11 @@
|
|
|
93
93
|
"artifactType": "FlexChange",
|
|
94
94
|
"controlType": "sap.m.Table"
|
|
95
95
|
},
|
|
96
|
+
"multiEdit": {
|
|
97
|
+
"$ref": "#/definitions/MultiEdit",
|
|
98
|
+
"description": "Allows you to edit a single object or multiple objects using a dialog in the list report page.",
|
|
99
|
+
"artifactType": "Manifest"
|
|
100
|
+
},
|
|
96
101
|
"createWithParameterDialog": {
|
|
97
102
|
"$ref": "#/definitions/Fields4Dialog",
|
|
98
103
|
"description": "You can enable the creation of objects that have a maximum of 8 data fields through a dialog in the list report page.",
|
|
@@ -193,6 +198,33 @@
|
|
|
193
198
|
"strategy"
|
|
194
199
|
]
|
|
195
200
|
},
|
|
201
|
+
"MultiEdit": {
|
|
202
|
+
"type": "object",
|
|
203
|
+
"properties": {
|
|
204
|
+
"enabled": {
|
|
205
|
+
"description": "When multiEdit is enabled, by default the dialog displays editable fields corresponding to columns that are currently displayed in the table.",
|
|
206
|
+
"type": "boolean",
|
|
207
|
+
"artifactType": "Manifest"
|
|
208
|
+
},
|
|
209
|
+
"annotationPath": {
|
|
210
|
+
"description": "Use annotationPath to define a mass edit dialog that points to a FieldGroup annotation with a qualifier.",
|
|
211
|
+
"type": "string",
|
|
212
|
+
"artifactType": "Manifest"
|
|
213
|
+
},
|
|
214
|
+
"ignoredFields": {
|
|
215
|
+
"description": "You can choose to hide certain fields from being displayed in key user adaptation and restrict them from being added to the Mass Edit dialog.",
|
|
216
|
+
"type": "array",
|
|
217
|
+
"items": {
|
|
218
|
+
"type": "string",
|
|
219
|
+
"enum": [
|
|
220
|
+
"GENERICPROPERTY"
|
|
221
|
+
]
|
|
222
|
+
},
|
|
223
|
+
"artifactType": "Manifest"
|
|
224
|
+
}
|
|
225
|
+
},
|
|
226
|
+
"additionalProperties": false
|
|
227
|
+
},
|
|
196
228
|
"Fields4Dialog": {
|
|
197
229
|
"type": "object",
|
|
198
230
|
"properties": {
|
|
@@ -692,6 +724,11 @@
|
|
|
692
724
|
"artifactType": "FlexChange",
|
|
693
725
|
"controlType": "sap.m.Table"
|
|
694
726
|
},
|
|
727
|
+
"multiEdit": {
|
|
728
|
+
"$ref": "#/definitions/MultiEdit",
|
|
729
|
+
"description": "Allows you to edit a single object or multiple objects using a dialog in the list report page.",
|
|
730
|
+
"artifactType": "Manifest"
|
|
731
|
+
},
|
|
695
732
|
"createWithParameterDialog": {
|
|
696
733
|
"$ref": "#/definitions/Fields4Dialog",
|
|
697
734
|
"description": "You can enable the creation of objects that have a maximum of 8 data fields through a dialog in the list report page.",
|
|
@@ -26,9 +26,14 @@
|
|
|
26
26
|
}
|
|
27
27
|
]
|
|
28
28
|
},
|
|
29
|
+
"defaultTemplateAnnotationPath": {
|
|
30
|
+
"description": "defaultTemplateAnnotationPath must be a reference to a SelectionPresentationVariant.\nYou use the SelectionPresentationVariant to configure the default visualizations and default filter values of the main content area.",
|
|
31
|
+
"type": "string",
|
|
32
|
+
"artifactType": "Manifest"
|
|
33
|
+
},
|
|
29
34
|
"defaultPath": {
|
|
30
35
|
"$ref": "#/definitions/DefaultPathType",
|
|
31
|
-
"description": "
|
|
36
|
+
"description": "defaultPath can be \"primary\", \"secondary\", or \"both\". If it is \"primary\", SAP Fiori elements loads the app in chart-only view. If it is \"secondary\", SAP Fiori elements loads the app in table-only view. If it is \"both\", SAP Fiori elements loads the app in hybrid view.",
|
|
32
37
|
"artifactType": "Manifest"
|
|
33
38
|
},
|
|
34
39
|
"$schema": {
|
|
@@ -52,6 +57,11 @@
|
|
|
52
57
|
"properties": {
|
|
53
58
|
"selectionFields": {
|
|
54
59
|
"$ref": "#/definitions/SelectionFields"
|
|
60
|
+
},
|
|
61
|
+
"hideFilterBar": {
|
|
62
|
+
"description": "To disable the filter bar, set hideFilterBar to true",
|
|
63
|
+
"type": "boolean",
|
|
64
|
+
"artifactType": "Manifest"
|
|
55
65
|
}
|
|
56
66
|
},
|
|
57
67
|
"additionalProperties": false
|
|
@@ -513,6 +523,11 @@
|
|
|
513
523
|
"isViewNode": true,
|
|
514
524
|
"type": "object",
|
|
515
525
|
"properties": {
|
|
526
|
+
"annotationPath": {
|
|
527
|
+
"description": "The secondary annotation path can be either UI.LineItem, UI.PresentationVariant, or UI.SelectionPresentationVariant.",
|
|
528
|
+
"type": "string",
|
|
529
|
+
"artifactType": "Manifest"
|
|
530
|
+
},
|
|
516
531
|
"initialLoad": {
|
|
517
532
|
"$ref": "#/definitions/InitialLoadType",
|
|
518
533
|
"description": "initialLoad defines whether or not the data in the table is automatically loaded.\n- Disabled - Data is never loaded when opening the app without an app state.\n- Enabled - Data is always loaded when opening the app.\n- Auto - Data is only loaded, if initial/preset filters are available (e.g. defined by \"SelectionVariant\" definition, URL parameters or user defaults).",
|
|
@@ -643,6 +658,14 @@
|
|
|
643
658
|
"isViewNode": true,
|
|
644
659
|
"type": "object",
|
|
645
660
|
"properties": {
|
|
661
|
+
"key": {
|
|
662
|
+
"type": "string",
|
|
663
|
+
"artifactType": "Manifest"
|
|
664
|
+
},
|
|
665
|
+
"index": {
|
|
666
|
+
"type": "number",
|
|
667
|
+
"artifactType": "Manifest"
|
|
668
|
+
},
|
|
646
669
|
"annotationPath": {
|
|
647
670
|
"description": "To use charts in multiple table mode, define a UI.Chart annotation, including a qualifier.\nReference the UI.Chart annotation in your SelectionPresentationVariant or PresentationVariant for your view.",
|
|
648
671
|
"type": "string",
|
|
@@ -660,7 +683,9 @@
|
|
|
660
683
|
},
|
|
661
684
|
"additionalProperties": false,
|
|
662
685
|
"required": [
|
|
663
|
-
"annotationPath"
|
|
686
|
+
"annotationPath",
|
|
687
|
+
"index",
|
|
688
|
+
"key"
|
|
664
689
|
]
|
|
665
690
|
},
|
|
666
691
|
"LRTableView": {
|
|
@@ -668,6 +693,14 @@
|
|
|
668
693
|
"isViewNode": true,
|
|
669
694
|
"type": "object",
|
|
670
695
|
"properties": {
|
|
696
|
+
"key": {
|
|
697
|
+
"type": "string",
|
|
698
|
+
"artifactType": "Manifest"
|
|
699
|
+
},
|
|
700
|
+
"index": {
|
|
701
|
+
"type": "number",
|
|
702
|
+
"artifactType": "Manifest"
|
|
703
|
+
},
|
|
671
704
|
"annotationPath": {
|
|
672
705
|
"description": "The annotation path can be either UI.LineItem, UI.PresentationVariant, or UI.SelectionPresentationVariant.",
|
|
673
706
|
"type": "string",
|
|
@@ -738,7 +771,9 @@
|
|
|
738
771
|
},
|
|
739
772
|
"additionalProperties": false,
|
|
740
773
|
"required": [
|
|
741
|
-
"annotationPath"
|
|
774
|
+
"annotationPath",
|
|
775
|
+
"index",
|
|
776
|
+
"key"
|
|
742
777
|
]
|
|
743
778
|
},
|
|
744
779
|
"GenericColumns": {
|
|
@@ -234,6 +234,9 @@
|
|
|
234
234
|
},
|
|
235
235
|
{
|
|
236
236
|
"$ref": "#/definitions/ObjectPageSectionAddress"
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
"$ref": "#/definitions/ObjectPageSectionPresentationVariant"
|
|
237
240
|
}
|
|
238
241
|
]
|
|
239
242
|
}
|
|
@@ -679,6 +682,39 @@
|
|
|
679
682
|
},
|
|
680
683
|
"additionalProperties": false
|
|
681
684
|
},
|
|
685
|
+
"ObjectPageSectionPresentationVariant": {
|
|
686
|
+
"type": "object",
|
|
687
|
+
"additionalProperties": {
|
|
688
|
+
"anyOf": [
|
|
689
|
+
{
|
|
690
|
+
"$ref": "#/definitions/ObjectPageSectionTableV4"
|
|
691
|
+
},
|
|
692
|
+
{
|
|
693
|
+
"$ref": "#/definitions/ObjectPageSectionChart"
|
|
694
|
+
}
|
|
695
|
+
]
|
|
696
|
+
}
|
|
697
|
+
},
|
|
698
|
+
"ObjectPageSectionChart": {
|
|
699
|
+
"type": "object",
|
|
700
|
+
"properties": {
|
|
701
|
+
"chart": {
|
|
702
|
+
"$ref": "#/definitions/ObjectPageChart",
|
|
703
|
+
"description": "Chart"
|
|
704
|
+
}
|
|
705
|
+
},
|
|
706
|
+
"additionalProperties": false
|
|
707
|
+
},
|
|
708
|
+
"ObjectPageChart": {
|
|
709
|
+
"type": "object",
|
|
710
|
+
"properties": {
|
|
711
|
+
"toolBar": {
|
|
712
|
+
"$ref": "#/definitions/ObjectPageToolBar",
|
|
713
|
+
"description": "Chart Toolbar"
|
|
714
|
+
}
|
|
715
|
+
},
|
|
716
|
+
"additionalProperties": false
|
|
717
|
+
},
|
|
682
718
|
"CustomSections": {
|
|
683
719
|
"description": "Custom Sections",
|
|
684
720
|
"isViewNode": true,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={3846:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.Top="Top",e.Middle="Middle",e.Bottom="Bottom"}(a.TableColumnVerticalAlignment||(a.TableColumnVerticalAlignment={})),function(e){e.persistence="persistence",e.discovery="discovery"}(a.StatePreservationMode||(a.StatePreservationMode={})),function(e){e.restricted="restricted"}(a.DraftDiscardEnabledSettings||(a.DraftDiscardEnabledSettings={}))},2387:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.bar="bar",e.column="column",e.line="line",e.combination="combination",e.pie="pie",e.donut="donut",e.scatter="scatter",e.bubble="bubble",e.heatmap="heatmap",e.bullet="bullet",e.verticalBullet="vertical_bullet",e.stackedBar="stacked_bar",e.stackedColumn="stacked_column",e.stackedCombination="stacked_combination",e.horizontalStackedCombination="horizontal_stacked_combination",e.dualBar="dual_bar",e.dualColumn="dual_column",e.dualLine="dual_line",e.dualStackedBar="dual_stacked_bar",e.dualStackedColumn="dual_stacked_column",e.dualCombination="dual_combination",e.dualStackedCombination="dual_stacked_combination",e.dualHorizontalCombination="dual_horizontal_combination",e.dualHorizontalStackedCombination="dual_horizontal_stacked_combination",e.hundredStackedBar="100_stacked_bar",e.hundredStackedColumn="100_stacked_column",e.hundredDualStackedBar="100_dual_stacked_bar",e.hundredDualStackedColumn="100_dual_stacked_column",e.waterfall="waterfall",e.horizontalWaterfall="horizontal_waterfall"}(a.ChartType||(a.ChartType={}))},6745:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.cardBubble="cardBubble",e.cardchartsline="cardchartsline",e.cardchartsdonut="cardchartsdonut"}(a.ChartCardType||(a.ChartCardType={})),function(e){e.analytical="sap.ovp.cards.charts.analytical",e.analyticalv4="sap.ovp.cards.v4.charts.analytical",e.list="sap.ovp.cards.list",e.listv4="sap.ovp.cards.v4.list",e.linklist="sap.ovp.cards.linklist",e.linklistv4="sap.ovp.cards.v4.linklist",e.table="sap.ovp.cards.table",e.tablev4="sap.ovp.cards.v4.table",e.stack="sap.ovp.cards.stack"}(a.CardTemplateType||(a.CardTemplateType={})),a.cardTemplateTypeMap={"sap.ovp.cards.charts.analytical":"AnalyticalCard","sap.ovp.cards.v4.charts.analytical":"AnalyticalCard","sap.ovp.cards.list":"ListCard","sap.ovp.cards.v4.list":"ListCard","sap.ovp.cards.linklist":"LinklistCard","sap.ovp.cards.v4.linklist":"LinklistCard","sap.ovp.cards.table":"TableCard","sap.ovp.cards.v4.table":"TableCard","sap.ovp.cards.stack":"StackCard"},function(e){e.analyticalCardSettings="analyticalCardSettings",e.analyticalCardSettingsv4="analyticalCardSettingsv4",e.listCardSettings="listCardSettings",e.listCardSettingsv4="listCardSettingsv4",e.stackCardSettings="stackCardSettings",e.linkListCardSettings="linkListCardSettings",e.tableCardSettings="tableCardSettings",e.tableCardSettingsv4="tableCardSettingsv4"}(a.CardSettingsType||(a.CardSettingsType={})),function(e){e.average="average",e.max="max",e.min="min",e.sum="sum",e.count="$count"}(a.MeasureAggregateValues||(a.MeasureAggregateValues={})),function(e){e.standard="standard",e.bar="bar",e.carousel="carousel"}(a.ListFlavorType||(a.ListFlavorType={})),function(e){e.extended="extended",e.condensed="condensed"}(a.ListTypeType||(a.ListTypeType={})),function(e){e.ascending="ascending",e.descending="descending"}(a.SortOrderType||(a.SortOrderType={})),function(e){e.standard="standard",e.carousel="carousel"}(a.LinkListFlavorType||(a.LinkListFlavorType={}))},2922:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.DATERANGE="DATERANGE",e.DATE="DATE",e.FROM="FROM",e.TO="TO",e.DAYS="DAYS",e.LASTDAYS="LASTDAYS",e.LASTWEEKS="LASTWEEKS",e.WEEK="WEEK",e.LASTMONTHS="LASTMONTHS",e.MONTH="MONTH",e.QUARTER="QUARTER",e.LASTQUARTERS="LASTQUARTERS",e.LASTYEARS="LASTYEARS",e.LASTYEAR="LASTYEAR",e.YEAR="YEAR",e.NEXTDAYS="NEXTDAYS",e.NEXTWEEKS="NEXTWEEKS",e.NEXTMONTHS="NEXTMONTHS",e.NEXTQUARTERS="NEXTQUARTERS",e.NEXTYEARS="NEXTYEARS",e.NEXT="NEXT",e.SPECIFICMONTH="SPECIFICMONTH",e.YESTERDAY="YESTERDAY",e.YEARTODATE="YEARTODATE",e.TODAY="TODAY",e.TOMORROW="TOMORROW",e.THISWEEK="THISWEEK",e.LASTWEEK="LASTWEEK",e.LAST2WEEKS="LAST2WEEKS",e.LAST3WEEKS="LAST3WEEKS",e.LAST4WEEKS="LAST4WEEKS",e.LAST5WEEKS="LAST5WEEKS",e.NEXTWEEK="NEXTWEEK",e.NEXT2WEEKS="NEXT2WEEKS",e.NEXT3WEEKS="NEXT3WEEKS",e.NEXT4WEEKS="NEXT4WEEKS",e.NEXT5WEEKS="NEXT5WEEKS",e.THISMONTH="THISMONTH",e.LASTMONTH="LASTMONTH",e.NEXTMONTH="NEXTMONTH",e.THISQUARTER="THISQUARTER",e.LASTQUARTER="LASTQUARTER",e.NEXTQUARTER="NEXTQUARTER",e.QUARTER1="QUARTER1",e.QUARTER2="QUARTER2",e.QUARTER3="QUARTER3",e.QUARTER4="QUARTER4",e.TODAYFROMTO="TODAYFROMTO"}(a.DateRangeType||(a.DateRangeType={})),function(e){e.YESTERDAY="YESTERDAY",e.TODAY="TODAY",e.THISWEEK="THISWEEK",e.LASTWEEK="LASTWEEK",e.THISMONTH="THISMONTH",e.TOMORROW="TOMORROW",e.LASTMONTH="LASTMONTH",e.THISQUARTER="THISQUARTER",e.LASTQUARTER="LASTQUARTER",e.THISYEAR="THISYEAR",e.LASTYEAR="LASTYEAR",e.LAST2WEEKS="LAST2WEEKS",e.LAST3WEEKS="LAST3WEEKS",e.LAST4WEEKS="LAST4WEEKS",e.LAST5WEEKS="LAST5WEEKS",e.YEARTODATE="YEARTODATE",e.QUARTER1="QUARTER1",e.QUARTER2="QUARTER2",e.QUARTER3="QUARTER3",e.QUARTER4="QUARTER4",e.DATETOYEAR="DATETOYEAR"}(a.DefaultDateRangeValueType||(a.DefaultDateRangeValueType={}))},7876:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.AfterFacet="AfterFacet",e.BeforeFacet="BeforeFacet",e.ReplaceFacet="ReplaceFacet"}(a.SectionPosition||(a.SectionPosition={})),function(e){e.XML="XML"}(a.ExtensionFragmentTypes||(a.ExtensionFragmentTypes={}))},9649:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.inline="inline"}(a.CreateMode||(a.CreateMode={}))},2906:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.XML="XML"}(a.customColumnViewTypes||(a.customColumnViewTypes={})),function(e){e.ResponsiveTable="ResponsiveTable",e.GridTable="GridTable",e.AnalyticalTable="AnalyticalTable",e.TreeTable="TreeTable"}(a.TableTypeV2||(a.TableTypeV2={})),function(e){e.ResponsiveTableColumnsExtension="ResponsiveTableColumnsExtension",e.AnalyticalTableColumnsExtension="AnalyticalTableColumnsExtension",e.TreeTableColumnsExtension="TreeTableColumnsExtension",e.GridTableColumnsExtension="GridTableColumnsExtension"}(a.TableColumnExtensionTypeV2||(a.TableColumnExtensionTypeV2={})),function(e){e.extension="extension"}(a.Strategy||(a.Strategy={})),function(e){e.charttable="charttable",e.chart="chart",e.table="table"}(a.DefaultContentView||(a.DefaultContentView={})),function(e){e.visual="visual",e.compact="compact"}(a.DefaultFilterMode||(a.DefaultFilterMode={})),function(e){e.always="always",e.never="never",e.ifAnyFilterExist="ifAnyFilterExist"}(a.LoadDataOnAppLaunchSettings||(a.LoadDataOnAppLaunchSettings={}))},6402:(e,a,t)=>{function n(e){for(var t in e)a.hasOwnProperty(t)||(a[t]=e[t])}Object.defineProperty(a,"__esModule",{value:!0}),n(t(6745)),n(t(2922)),n(t(2906)),n(t(2387)),n(t(7876)),n(t(9649))},390:(e,a,t)=>{function n(e){for(var t in e)a.hasOwnProperty(t)||(a[t]=e[t])}Object.defineProperty(a,"__esModule",{value:!0}),n(t(
|
|
1
|
+
(()=>{"use strict";var e={3846:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.Top="Top",e.Middle="Middle",e.Bottom="Bottom"}(a.TableColumnVerticalAlignment||(a.TableColumnVerticalAlignment={})),function(e){e.persistence="persistence",e.discovery="discovery"}(a.StatePreservationMode||(a.StatePreservationMode={})),function(e){e.restricted="restricted"}(a.DraftDiscardEnabledSettings||(a.DraftDiscardEnabledSettings={}))},2387:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.bar="bar",e.column="column",e.line="line",e.combination="combination",e.pie="pie",e.donut="donut",e.scatter="scatter",e.bubble="bubble",e.heatmap="heatmap",e.bullet="bullet",e.verticalBullet="vertical_bullet",e.stackedBar="stacked_bar",e.stackedColumn="stacked_column",e.stackedCombination="stacked_combination",e.horizontalStackedCombination="horizontal_stacked_combination",e.dualBar="dual_bar",e.dualColumn="dual_column",e.dualLine="dual_line",e.dualStackedBar="dual_stacked_bar",e.dualStackedColumn="dual_stacked_column",e.dualCombination="dual_combination",e.dualStackedCombination="dual_stacked_combination",e.dualHorizontalCombination="dual_horizontal_combination",e.dualHorizontalStackedCombination="dual_horizontal_stacked_combination",e.hundredStackedBar="100_stacked_bar",e.hundredStackedColumn="100_stacked_column",e.hundredDualStackedBar="100_dual_stacked_bar",e.hundredDualStackedColumn="100_dual_stacked_column",e.waterfall="waterfall",e.horizontalWaterfall="horizontal_waterfall"}(a.ChartType||(a.ChartType={}))},6745:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.cardBubble="cardBubble",e.cardchartsline="cardchartsline",e.cardchartsdonut="cardchartsdonut"}(a.ChartCardType||(a.ChartCardType={})),function(e){e.analytical="sap.ovp.cards.charts.analytical",e.analyticalv4="sap.ovp.cards.v4.charts.analytical",e.list="sap.ovp.cards.list",e.listv4="sap.ovp.cards.v4.list",e.linklist="sap.ovp.cards.linklist",e.linklistv4="sap.ovp.cards.v4.linklist",e.table="sap.ovp.cards.table",e.tablev4="sap.ovp.cards.v4.table",e.stack="sap.ovp.cards.stack"}(a.CardTemplateType||(a.CardTemplateType={})),a.cardTemplateTypeMap={"sap.ovp.cards.charts.analytical":"AnalyticalCard","sap.ovp.cards.v4.charts.analytical":"AnalyticalCard","sap.ovp.cards.list":"ListCard","sap.ovp.cards.v4.list":"ListCard","sap.ovp.cards.linklist":"LinklistCard","sap.ovp.cards.v4.linklist":"LinklistCard","sap.ovp.cards.table":"TableCard","sap.ovp.cards.v4.table":"TableCard","sap.ovp.cards.stack":"StackCard"},function(e){e.analyticalCardSettings="analyticalCardSettings",e.analyticalCardSettingsv4="analyticalCardSettingsv4",e.listCardSettings="listCardSettings",e.listCardSettingsv4="listCardSettingsv4",e.stackCardSettings="stackCardSettings",e.linkListCardSettings="linkListCardSettings",e.tableCardSettings="tableCardSettings",e.tableCardSettingsv4="tableCardSettingsv4"}(a.CardSettingsType||(a.CardSettingsType={})),function(e){e.average="average",e.max="max",e.min="min",e.sum="sum",e.count="$count"}(a.MeasureAggregateValues||(a.MeasureAggregateValues={})),function(e){e.standard="standard",e.bar="bar",e.carousel="carousel"}(a.ListFlavorType||(a.ListFlavorType={})),function(e){e.extended="extended",e.condensed="condensed"}(a.ListTypeType||(a.ListTypeType={})),function(e){e.ascending="ascending",e.descending="descending"}(a.SortOrderType||(a.SortOrderType={})),function(e){e.standard="standard",e.carousel="carousel"}(a.LinkListFlavorType||(a.LinkListFlavorType={}))},2922:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.DATERANGE="DATERANGE",e.DATE="DATE",e.FROM="FROM",e.TO="TO",e.DAYS="DAYS",e.LASTDAYS="LASTDAYS",e.LASTWEEKS="LASTWEEKS",e.WEEK="WEEK",e.LASTMONTHS="LASTMONTHS",e.MONTH="MONTH",e.QUARTER="QUARTER",e.LASTQUARTERS="LASTQUARTERS",e.LASTYEARS="LASTYEARS",e.LASTYEAR="LASTYEAR",e.YEAR="YEAR",e.NEXTDAYS="NEXTDAYS",e.NEXTWEEKS="NEXTWEEKS",e.NEXTMONTHS="NEXTMONTHS",e.NEXTQUARTERS="NEXTQUARTERS",e.NEXTYEARS="NEXTYEARS",e.NEXT="NEXT",e.SPECIFICMONTH="SPECIFICMONTH",e.YESTERDAY="YESTERDAY",e.YEARTODATE="YEARTODATE",e.TODAY="TODAY",e.TOMORROW="TOMORROW",e.THISWEEK="THISWEEK",e.LASTWEEK="LASTWEEK",e.LAST2WEEKS="LAST2WEEKS",e.LAST3WEEKS="LAST3WEEKS",e.LAST4WEEKS="LAST4WEEKS",e.LAST5WEEKS="LAST5WEEKS",e.NEXTWEEK="NEXTWEEK",e.NEXT2WEEKS="NEXT2WEEKS",e.NEXT3WEEKS="NEXT3WEEKS",e.NEXT4WEEKS="NEXT4WEEKS",e.NEXT5WEEKS="NEXT5WEEKS",e.THISMONTH="THISMONTH",e.LASTMONTH="LASTMONTH",e.NEXTMONTH="NEXTMONTH",e.THISQUARTER="THISQUARTER",e.LASTQUARTER="LASTQUARTER",e.NEXTQUARTER="NEXTQUARTER",e.QUARTER1="QUARTER1",e.QUARTER2="QUARTER2",e.QUARTER3="QUARTER3",e.QUARTER4="QUARTER4",e.TODAYFROMTO="TODAYFROMTO"}(a.DateRangeType||(a.DateRangeType={})),function(e){e.YESTERDAY="YESTERDAY",e.TODAY="TODAY",e.THISWEEK="THISWEEK",e.LASTWEEK="LASTWEEK",e.THISMONTH="THISMONTH",e.TOMORROW="TOMORROW",e.LASTMONTH="LASTMONTH",e.THISQUARTER="THISQUARTER",e.LASTQUARTER="LASTQUARTER",e.THISYEAR="THISYEAR",e.LASTYEAR="LASTYEAR",e.LAST2WEEKS="LAST2WEEKS",e.LAST3WEEKS="LAST3WEEKS",e.LAST4WEEKS="LAST4WEEKS",e.LAST5WEEKS="LAST5WEEKS",e.YEARTODATE="YEARTODATE",e.QUARTER1="QUARTER1",e.QUARTER2="QUARTER2",e.QUARTER3="QUARTER3",e.QUARTER4="QUARTER4",e.DATETOYEAR="DATETOYEAR"}(a.DefaultDateRangeValueType||(a.DefaultDateRangeValueType={}))},7876:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.AfterFacet="AfterFacet",e.BeforeFacet="BeforeFacet",e.ReplaceFacet="ReplaceFacet"}(a.SectionPosition||(a.SectionPosition={})),function(e){e.XML="XML"}(a.ExtensionFragmentTypes||(a.ExtensionFragmentTypes={}))},9649:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.inline="inline"}(a.CreateMode||(a.CreateMode={}))},2906:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.XML="XML"}(a.customColumnViewTypes||(a.customColumnViewTypes={})),function(e){e.ResponsiveTable="ResponsiveTable",e.GridTable="GridTable",e.AnalyticalTable="AnalyticalTable",e.TreeTable="TreeTable"}(a.TableTypeV2||(a.TableTypeV2={})),function(e){e.ResponsiveTableColumnsExtension="ResponsiveTableColumnsExtension",e.AnalyticalTableColumnsExtension="AnalyticalTableColumnsExtension",e.TreeTableColumnsExtension="TreeTableColumnsExtension",e.GridTableColumnsExtension="GridTableColumnsExtension"}(a.TableColumnExtensionTypeV2||(a.TableColumnExtensionTypeV2={})),function(e){e.extension="extension"}(a.Strategy||(a.Strategy={})),function(e){e.GENERICPROPERTY="GENERICPROPERTY"}(a.IgnoredFieldsType||(a.IgnoredFieldsType={})),function(e){e.charttable="charttable",e.chart="chart",e.table="table"}(a.DefaultContentView||(a.DefaultContentView={})),function(e){e.visual="visual",e.compact="compact"}(a.DefaultFilterMode||(a.DefaultFilterMode={})),function(e){e.always="always",e.never="never",e.ifAnyFilterExist="ifAnyFilterExist"}(a.LoadDataOnAppLaunchSettings||(a.LoadDataOnAppLaunchSettings={}))},6402:(e,a,t)=>{function n(e){for(var t in e)a.hasOwnProperty(t)||(a[t]=e[t])}Object.defineProperty(a,"__esModule",{value:!0}),n(t(6745)),n(t(2922)),n(t(2906)),n(t(2387)),n(t(7876)),n(t(9649))},390:(e,a,t)=>{function n(e){for(var t in e)a.hasOwnProperty(t)||(a[t]=e[t])}Object.defineProperty(a,"__esModule",{value:!0}),n(t(4350)),n(t(6402)),n(t(9809)),n(t(3846))},2505:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){e.fixed="fixed",e.resizable="resizable"}(a.ContainerLayoutType||(a.ContainerLayoutType={}))},4350:(e,a,t)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){for(var t in e)a.hasOwnProperty(t)||(a[t]=e[t])}(t(2505))},9809:(e,a,t)=>{Object.defineProperty(a,"__esModule",{value:!0}),function(e){for(var t in e)a.hasOwnProperty(t)||(a[t]=e[t])}(t(4149))},4149:(e,a,t)=>{function n(e){for(var t in e)a.hasOwnProperty(t)||(a[t]=e[t])}Object.defineProperty(a,"__esModule",{value:!0}),n(t(4867)),n(t(1374))},1374:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),a.SAPUI5_VIEW_EXTENSION="sap.ui.viewExtensions",a.SAPUI5_CONTROLLER_EXTENSION="sap.ui.controllerExtensions",a.SAPUI5_VIEW_EXTENSION_OBJECT_PAGE="sap.suite.ui.generic.template.ObjectPage.view.Details",a.SAPUI5_VIEW_EXTENSION_LIST_REPORT="sap.suite.ui.generic.template.ListReport.view.ListReport",a.SAPUI5_VIEW_EXTENSION_ANALYTICAL_LIST_PAGE="sap.suite.ui.generic.template.AnalyticalListPage.view.AnalyticalListPage"},4867:(e,a)=>{Object.defineProperty(a,"__esModule",{value:!0}),a.FE_TEMPLATE_V2="sap.suite.ui.generic.template",a.FE_TEMPLATE_V2_OBJECT_PAGE="sap.suite.ui.generic.template.ObjectPage",a.FE_TEMPLATE_V2_LIST_REPORT="sap.suite.ui.generic.template.ListReport",a.FE_TEMPLATE_V2_ALP="sap.suite.ui.generic.template.AnalyticalListPage"}},a={};var t=function t(n){var i=a[n];if(void 0!==i)return i.exports;var l=a[n]={exports:{}};return e[n](l,l.exports,t),l.exports}(390);module.exports=t})();
|
package/dist/src/apiTypes.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { Definition } from 'typescript-json-schema';
|
|
1
2
|
import type { SchemaType } from './specification/schemaAccess';
|
|
2
3
|
import type { FioriElementsVersion } from './specification/common/page';
|
|
3
4
|
import type { Page as PageV2 } from './specification/v2/page';
|
|
@@ -247,7 +248,7 @@ export declare type ImportListReportV4 = {
|
|
|
247
248
|
};
|
|
248
249
|
export declare type ImportObjectPageV4Parameters = {
|
|
249
250
|
manifest: object;
|
|
250
|
-
jsonSchema:
|
|
251
|
+
jsonSchema: Definition;
|
|
251
252
|
routingId: string;
|
|
252
253
|
logger?: ExtensionLogger;
|
|
253
254
|
};
|
|
@@ -165,6 +165,23 @@ export interface CreateWithFilters {
|
|
|
165
165
|
export declare enum Strategy {
|
|
166
166
|
extension = "extension"
|
|
167
167
|
}
|
|
168
|
+
export interface MultiEdit {
|
|
169
|
+
/**
|
|
170
|
+
* When multiEdit is enabled, by default the dialog displays editable fields corresponding to columns that are currently displayed in the table.
|
|
171
|
+
*/
|
|
172
|
+
enabled?: boolean;
|
|
173
|
+
/**
|
|
174
|
+
* Use annotationPath to define a mass edit dialog that points to a FieldGroup annotation with a qualifier.
|
|
175
|
+
*/
|
|
176
|
+
annotationPath?: string;
|
|
177
|
+
/**
|
|
178
|
+
* You can choose to hide certain fields from being displayed in key user adaptation and restrict them from being added to the Mass Edit dialog.
|
|
179
|
+
*/
|
|
180
|
+
ignoredFields?: IgnoredFieldsType[];
|
|
181
|
+
}
|
|
182
|
+
export declare const enum IgnoredFieldsType {
|
|
183
|
+
GENERICPROPERTY = "GENERICPROPERTY"
|
|
184
|
+
}
|
|
168
185
|
export declare enum DefaultContentView {
|
|
169
186
|
charttable = "charttable",
|
|
170
187
|
chart = "chart",
|
|
@@ -280,6 +297,10 @@ export interface ResponsiveTableCommonSettings extends CommonTableSettings {
|
|
|
280
297
|
* growingThreshold defines the number of items to be requested from the model for each grow. This property can only be used if the growing property is set to true.
|
|
281
298
|
*/
|
|
282
299
|
growingThreshold?: number;
|
|
300
|
+
/**
|
|
301
|
+
* Allows you to edit a single object or multiple objects using a dialog in the list report page.
|
|
302
|
+
*/
|
|
303
|
+
multiEdit?: MultiEdit;
|
|
283
304
|
}
|
|
284
305
|
/**
|
|
285
306
|
* Table
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { ObjectPageSectionTableV4 } from '../controls/ObjectPageTable';
|
|
2
2
|
import type { SAPUI5_FRAGMENT_CLASS } from '../../common/webapp/manifest/sapUi5';
|
|
3
|
+
import type { ObjectPageToolBar } from './ObjectPageToolBar';
|
|
3
4
|
export interface ObjectPageSectionForm {
|
|
4
5
|
/**
|
|
5
6
|
* Form
|
|
@@ -28,8 +29,28 @@ export interface ObjectPageSectionAddress {
|
|
|
28
29
|
*/
|
|
29
30
|
address?: object;
|
|
30
31
|
}
|
|
32
|
+
export interface ObjectPageChart {
|
|
33
|
+
/**
|
|
34
|
+
* Chart Toolbar
|
|
35
|
+
* @isViewNode true
|
|
36
|
+
*/
|
|
37
|
+
toolBar?: ObjectPageToolBar;
|
|
38
|
+
}
|
|
39
|
+
export interface ObjectPageSectionChart {
|
|
40
|
+
/**
|
|
41
|
+
* Chart
|
|
42
|
+
* @isViewNode true
|
|
43
|
+
*/
|
|
44
|
+
chart?: ObjectPageChart;
|
|
45
|
+
}
|
|
46
|
+
export interface ObjectPageSectionPresentationVariant {
|
|
47
|
+
/**
|
|
48
|
+
* Presentation Variant
|
|
49
|
+
*/
|
|
50
|
+
[key: string]: ObjectPageSectionTableV4 | ObjectPageSectionChart;
|
|
51
|
+
}
|
|
31
52
|
export interface GenericSections {
|
|
32
|
-
[key: string]: ObjectPageSectionTableV4 | ObjectPageSectionForm | ObjectPageSectionDataPoint | ObjectPageSectionContact | ObjectPageSectionAddress;
|
|
53
|
+
[key: string]: ObjectPageSectionTableV4 | ObjectPageSectionForm | ObjectPageSectionDataPoint | ObjectPageSectionContact | ObjectPageSectionAddress | ObjectPageSectionPresentationVariant;
|
|
33
54
|
}
|
|
34
55
|
/**
|
|
35
56
|
* Subsections
|
|
@@ -179,6 +179,8 @@ export interface ALPChartView {
|
|
|
179
179
|
* @isViewNode true
|
|
180
180
|
*/
|
|
181
181
|
export interface LRChartView {
|
|
182
|
+
key: string;
|
|
183
|
+
index: number;
|
|
182
184
|
/**
|
|
183
185
|
* To use charts in multiple table mode, define a UI.Chart annotation, including a qualifier.
|
|
184
186
|
* Reference the UI.Chart annotation in your SelectionPresentationVariant or PresentationVariant for your view.
|
|
@@ -231,6 +233,8 @@ export interface ALPTableView extends TableSettings {
|
|
|
231
233
|
* @isViewNode true
|
|
232
234
|
*/
|
|
233
235
|
export interface LRTableView extends TableSettings {
|
|
236
|
+
key: string;
|
|
237
|
+
index: number;
|
|
234
238
|
/**
|
|
235
239
|
* The annotation path can be either UI.LineItem, UI.PresentationVariant, or UI.SelectionPresentationVariant.
|
|
236
240
|
*/
|
|
@@ -264,6 +268,10 @@ export interface LRTableView extends TableSettings {
|
|
|
264
268
|
* @isViewNode true
|
|
265
269
|
*/
|
|
266
270
|
export interface Table extends TableSettings {
|
|
271
|
+
/**
|
|
272
|
+
* The secondary annotation path can be either UI.LineItem, UI.PresentationVariant, or UI.SelectionPresentationVariant.
|
|
273
|
+
*/
|
|
274
|
+
annotationPath?: string;
|
|
267
275
|
/**
|
|
268
276
|
* initialLoad defines whether or not the data in the table is automatically loaded.
|
|
269
277
|
* - Disabled - Data is never loaded when opening the app without an app state.
|
|
@@ -25,7 +25,12 @@ export interface ListReportConfig extends PageConfig {
|
|
|
25
25
|
*/
|
|
26
26
|
table?: Table | ALPTableView;
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* defaultTemplateAnnotationPath must be a reference to a SelectionPresentationVariant.
|
|
29
|
+
* You use the SelectionPresentationVariant to configure the default visualizations and default filter values of the main content area.
|
|
30
|
+
*/
|
|
31
|
+
defaultTemplateAnnotationPath?: string;
|
|
32
|
+
/**
|
|
33
|
+
* defaultPath can be "primary", "secondary", or "both". If it is "primary", SAP Fiori elements loads the app in chart-only view. If it is "secondary", SAP Fiori elements loads the app in table-only view. If it is "both", SAP Fiori elements loads the app in hybrid view.
|
|
29
34
|
*/
|
|
30
35
|
defaultPath?: DefaultPathType;
|
|
31
36
|
}
|
|
@@ -38,6 +38,7 @@ export declare type SapUiPageSettingsV4 = SapUiGenericAppPageSettings & {
|
|
|
38
38
|
controlConfiguration?: SapUiGenericAppPageSettings;
|
|
39
39
|
content?: SapUi5RoutingTargetContent;
|
|
40
40
|
views?: SapUi5Views;
|
|
41
|
+
defaultTemplateAnnotationPath?: string;
|
|
41
42
|
};
|
|
42
43
|
export interface SapUiAppPageV4 {
|
|
43
44
|
type: string;
|
|
@@ -3,6 +3,7 @@ import { FioriElementsVersion } from '../../../specification/common';
|
|
|
3
3
|
import type { FacetConfig } from '..';
|
|
4
4
|
import { SectionType } from '..';
|
|
5
5
|
import type { EntitySet } from '@sap-ux/annotation-converter';
|
|
6
|
+
import type { Definition } from 'typescript-json-schema';
|
|
6
7
|
/**
|
|
7
8
|
* Adds definitions for forms in object page sections to the app schema
|
|
8
9
|
* @param {SectionType} sectionType - prefix to distinguish Section and HeaderSection
|
|
@@ -11,7 +12,7 @@ import type { EntitySet } from '@sap-ux/annotation-converter';
|
|
|
11
12
|
* @param {object} appSchema - app specific schema that gets enhanced
|
|
12
13
|
* @param {FioriElementsVersion} version - Fiori Elements version
|
|
13
14
|
*/
|
|
14
|
-
export declare function handleForm(sectionType: SectionType, section: FacetConfig, appSchemaSection:
|
|
15
|
+
export declare function handleForm(sectionType: SectionType, section: FacetConfig, appSchemaSection: Definition, appSchema: Definition, version: FioriElementsVersion, withActions?: boolean): void;
|
|
15
16
|
/**
|
|
16
17
|
* Replaces an alias in an annotation ID or reference, based on the AVT references' list
|
|
17
18
|
* @param annotationIdentifier - annotation ID or reference
|
|
@@ -36,20 +37,20 @@ export declare function getActionNameAndId(action: string, entityType: EntityTyp
|
|
|
36
37
|
* @param {EntityType} entityType - current entity type
|
|
37
38
|
* @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
|
|
38
39
|
*/
|
|
39
|
-
export declare function addFooterActions(appSchema:
|
|
40
|
+
export declare function addFooterActions(appSchema: Definition, entityType: EntityType, oDataServiceAVT: ConverterOutput): void;
|
|
40
41
|
/**
|
|
41
42
|
* Add Object Page Header Action Buttons to app-specific schema
|
|
42
43
|
* @param {object} appSchema Schema of the app
|
|
43
44
|
* @param {EntityType} entityType - current entity type
|
|
44
45
|
* @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
|
|
45
46
|
*/
|
|
46
|
-
export declare function addHeaderActions(appSchema:
|
|
47
|
+
export declare function addHeaderActions(appSchema: Definition, entityType: EntityType, oDataServiceAVT: ConverterOutput, addHeaderActionCallBack: any): void;
|
|
47
48
|
/**
|
|
48
49
|
* Adds common Object Page Header definitions to the app schema
|
|
49
50
|
* @param appSchema - app-specific JSOn schema
|
|
50
51
|
* @param entityType - current entity Type
|
|
51
52
|
*/
|
|
52
|
-
export declare function addCommonHeaderSchema(appSchema:
|
|
53
|
+
export declare function addCommonHeaderSchema(appSchema: Definition, entityType: EntityType): void;
|
|
53
54
|
/**
|
|
54
55
|
* Common logic to determine the EntitySet of a facet
|
|
55
56
|
* @param facet - current facet or section
|
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
import type { EntitySet, EntityType } from '@sap-ux/annotation-converter';
|
|
2
2
|
import type { AnnotationTerm, ConverterOutput, LineItem } from '@sap-ux/vocabularies-types';
|
|
3
|
-
import { UIAnnotationTerms } from '@sap-ux/vocabularies-types';
|
|
4
3
|
import type { Definition } from 'typescript-json-schema';
|
|
5
|
-
import type { FacetSection } from '..';
|
|
4
|
+
import type { FacetConfig, FacetSection } from '..';
|
|
5
|
+
import type { SectionTypeV2 } from '../../v2/types';
|
|
6
|
+
import type { PresentationVariantV4 } from '../../v4/types';
|
|
7
|
+
import { UIAnnotationTerms } from '@sap-ux/vocabularies-types';
|
|
8
|
+
import { DefinitionName } from '..';
|
|
6
9
|
/**
|
|
7
10
|
* Adds an enum filled with existing UI annotations of the given list (validAnnotations)
|
|
8
11
|
* @param {EntityType} entityType
|
|
@@ -23,30 +26,30 @@ export declare function addEnumForSingleTabVariant(entityType: EntityType, appSc
|
|
|
23
26
|
* @param definitionName - name of the definition in the app schema
|
|
24
27
|
* @param {EntitySet} entitySet - current entity set of the page or view
|
|
25
28
|
*/
|
|
26
|
-
export declare function addEnumForMultiTabVariant(appSchema:
|
|
29
|
+
export declare function addEnumForMultiTabVariant(appSchema: Definition, definitionName: string, entitySet: EntitySet): void;
|
|
27
30
|
/**
|
|
28
|
-
* Adds the
|
|
31
|
+
* Adds the enum values for entitySet as part of the multiple view scenario
|
|
29
32
|
* @param {ConverterOutput} oDataServiceAVT - combined service metadata, as returned by annotation vocabularies tools
|
|
30
33
|
* @param appSchema - app specific JSOn schema
|
|
31
34
|
* @param definitionName - name of the definition in the app schema
|
|
32
35
|
*/
|
|
33
|
-
export declare function addEnumForVariantEntitySet(oDataServiceAVT: ConverterOutput, appSchema:
|
|
36
|
+
export declare function addEnumForVariantEntitySet(oDataServiceAVT: ConverterOutput, appSchema: Definition, definitionName: string): void;
|
|
34
37
|
/**
|
|
35
38
|
* Adds an enum filled with existing UI annotations for annotationPath property in FilterBar
|
|
36
39
|
* @param {EntityType} entityType
|
|
37
40
|
* @param appSchema - app specific JSOn schema
|
|
38
41
|
* @param definitionName - name of the definition in the app schema
|
|
39
42
|
*/
|
|
40
|
-
export declare function addEnumForFilterBarAnnotationPath(entityType: EntityType, appSchema:
|
|
43
|
+
export declare function addEnumForFilterBarAnnotationPath(entityType: EntityType, appSchema: Definition, definitionName: string): void;
|
|
41
44
|
/**
|
|
42
|
-
* Method adds definition for 'RelatedFacetKeys' as enum with
|
|
43
|
-
* @param {
|
|
45
|
+
* Method adds definition for 'RelatedFacetKeys' as enum with description and adds references to 'RelatedFacetKeys' for custom section definitions.
|
|
46
|
+
* @param {Definition} appSchema App specific schema that potentially gets enhanced
|
|
44
47
|
* @param {string[]>} sectionDefinitions array of section definitions which should be updated with new reference to 'RelatedFacetKeys' enum.
|
|
45
48
|
* @param {FacetSection[]} facetSections Array of facet section objects which is used to generate enum values.
|
|
46
49
|
* @param {Array<keyof Omit<FacetSection, 'custom'>>} idProperties Array of property names which should be looked up in 'FacetSection' object.
|
|
47
50
|
* Please note that method depends on order and takes first non empty value associated to passed properties.
|
|
48
51
|
*/
|
|
49
|
-
export declare function addDefinitionForRelatedFacetKeys(
|
|
52
|
+
export declare function addDefinitionForRelatedFacetKeys(appSchema: Definition, sectionDefinitions: string[], facetSections: FacetSection[], idProperties: Array<keyof Omit<FacetSection, 'custom'>>): void;
|
|
50
53
|
/**
|
|
51
54
|
* Functions used both by V2 and V4 to add the common definitions for a line item to the app schema
|
|
52
55
|
* @param appSchema - the app specific schema that shall get enhanced
|
|
@@ -57,9 +60,9 @@ export declare function addDefinitionForRelatedFacetKeys(schema: object, section
|
|
|
57
60
|
* Passed in the V4 case, then additional properties of this type will be allowed.
|
|
58
61
|
* @returns the actions definition plus the annotation path to the given line item
|
|
59
62
|
*/
|
|
60
|
-
export declare function addCommonLineItemDefinitions(appSchema:
|
|
61
|
-
actions:
|
|
62
|
-
footerActions:
|
|
63
|
+
export declare function addCommonLineItemDefinitions(appSchema: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, lineItemId: string, customColumnDefinitionName?: string): {
|
|
64
|
+
actions: Definition;
|
|
65
|
+
footerActions: Definition;
|
|
63
66
|
lineItemPath: string;
|
|
64
67
|
};
|
|
65
68
|
/**
|
|
@@ -68,7 +71,7 @@ export declare function addCommonLineItemDefinitions(appSchema: object, lineItem
|
|
|
68
71
|
* @param {EntityType} entityType - Given entity type for which entries shall get generated
|
|
69
72
|
* @param {string=} floorplanSuffix - floorplan specific suffix (optional)
|
|
70
73
|
*/
|
|
71
|
-
export declare function addFieldsType(appSchema:
|
|
74
|
+
export declare function addFieldsType(appSchema: Definition, entityType: EntityType, floorplanSuffix?: string): void;
|
|
72
75
|
export declare enum DataType {
|
|
73
76
|
String = "String",
|
|
74
77
|
Rating = "Rating",
|
|
@@ -101,3 +104,31 @@ export declare function determineDataType(field: object): string | undefined;
|
|
|
101
104
|
* @param field - given field definition = annotation property, at AVT
|
|
102
105
|
*/
|
|
103
106
|
export declare function addDataTypeToDefinition(definition: object, field: object): void;
|
|
107
|
+
/**
|
|
108
|
+
* Receives a facet key and returns the key as used in schema
|
|
109
|
+
* @param facetKey - key of the facet, as used in annotation
|
|
110
|
+
* @returns facetKeyInSchema - key of the facet, as used in schema
|
|
111
|
+
*/
|
|
112
|
+
export declare function getFacetKeyInSchema(facetKey: string): string;
|
|
113
|
+
/**
|
|
114
|
+
* Adds an existing schema definition to a new definition in the app schema
|
|
115
|
+
* @param definition name of definition, as used in schema
|
|
116
|
+
* @param facetKey - key of the facet, as used in annotation
|
|
117
|
+
* @param {Definition} appSchema App schema in general
|
|
118
|
+
* @param {boolean} useDefinitionAsKey If set to false, facet key will solely be used as key, else encapsulated within definition key `definition<facetKey>`
|
|
119
|
+
* @returns {Definition} part of app schema that has been added and filled
|
|
120
|
+
*/
|
|
121
|
+
export declare function parseSchemaDefinition(definition: DefinitionName | SectionTypeV2, facetKey: string, appSchema: Definition, useDefinitionAsKey?: boolean): Definition;
|
|
122
|
+
/**
|
|
123
|
+
* Creates a definition link for a facet and definition name
|
|
124
|
+
* @param definition name of definition, as used in schema
|
|
125
|
+
* @param facetKey - key of the facet, as used in annotation
|
|
126
|
+
* @returns definition link of facet, as used in definition
|
|
127
|
+
*/
|
|
128
|
+
export declare function getFacetDefinitionLink(definition: DefinitionName | SectionTypeV2, facetKey: string): string;
|
|
129
|
+
/**
|
|
130
|
+
* Extracts annotationPath from facet or Chart/LineItem fullyQualifiedName
|
|
131
|
+
* @param facet facet or Chart/LineItem
|
|
132
|
+
* @returns {string} annotationPath
|
|
133
|
+
*/
|
|
134
|
+
export declare function getFacetAnnotationPath(facet: FacetConfig | PresentationVariantV4 | object): string | undefined;
|