@sap/ux-specification 1.96.10 → 1.96.11
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 +40 -15
- 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/v4/ListReportConfig.json +22 -2
- 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/v4/controls/ObjectPageSection.d.ts +22 -1
- package/dist/src/specification/v4/controls/Table.d.ts +4 -0
- package/dist/src/sync/common/generate/utils.d.ts +39 -8
- package/dist/src/sync/common/types.d.ts +57 -8
- package/dist/src/sync/common/utils.d.ts +16 -11
- package/dist/src/sync/v2/export/controls/Table.d.ts +1 -0
- package/dist/src/sync/v2/export/export.d.ts +0 -1
- package/dist/src/sync/v2/export/manifest.d.ts +6 -0
- package/dist/src/sync/v2/export/pages/OverviewPage.d.ts +1 -1
- package/dist/src/sync/v2/generate/utils.d.ts +5 -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/Table.d.ts +5 -1
- 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 +3 -4
- package/package.json +3 -3
|
@@ -653,6 +653,14 @@
|
|
|
653
653
|
"isViewNode": true,
|
|
654
654
|
"type": "object",
|
|
655
655
|
"properties": {
|
|
656
|
+
"key": {
|
|
657
|
+
"type": "string",
|
|
658
|
+
"artifactType": "Manifest"
|
|
659
|
+
},
|
|
660
|
+
"index": {
|
|
661
|
+
"type": "number",
|
|
662
|
+
"artifactType": "Manifest"
|
|
663
|
+
},
|
|
656
664
|
"annotationPath": {
|
|
657
665
|
"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.",
|
|
658
666
|
"type": "string",
|
|
@@ -670,7 +678,9 @@
|
|
|
670
678
|
},
|
|
671
679
|
"additionalProperties": false,
|
|
672
680
|
"required": [
|
|
673
|
-
"annotationPath"
|
|
681
|
+
"annotationPath",
|
|
682
|
+
"index",
|
|
683
|
+
"key"
|
|
674
684
|
]
|
|
675
685
|
},
|
|
676
686
|
"LRTableView": {
|
|
@@ -678,6 +688,14 @@
|
|
|
678
688
|
"isViewNode": true,
|
|
679
689
|
"type": "object",
|
|
680
690
|
"properties": {
|
|
691
|
+
"key": {
|
|
692
|
+
"type": "string",
|
|
693
|
+
"artifactType": "Manifest"
|
|
694
|
+
},
|
|
695
|
+
"index": {
|
|
696
|
+
"type": "number",
|
|
697
|
+
"artifactType": "Manifest"
|
|
698
|
+
},
|
|
681
699
|
"annotationPath": {
|
|
682
700
|
"description": "The annotation path can be either UI.LineItem, UI.PresentationVariant, or UI.SelectionPresentationVariant.",
|
|
683
701
|
"type": "string",
|
|
@@ -748,7 +766,9 @@
|
|
|
748
766
|
},
|
|
749
767
|
"additionalProperties": false,
|
|
750
768
|
"required": [
|
|
751
|
-
"annotationPath"
|
|
769
|
+
"annotationPath",
|
|
770
|
+
"index",
|
|
771
|
+
"key"
|
|
752
772
|
]
|
|
753
773
|
},
|
|
754
774
|
"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.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
|
};
|
|
@@ -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
|
*/
|
|
@@ -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
|
|
@@ -25,7 +28,7 @@ export declare function addEnumForSingleTabVariant(entityType: EntityType, appSc
|
|
|
25
28
|
*/
|
|
26
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
|
|
@@ -39,14 +42,14 @@ export declare function addEnumForVariantEntitySet(oDataServiceAVT: ConverterOut
|
|
|
39
42
|
*/
|
|
40
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(appSchema:
|
|
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
|
|
@@ -58,8 +61,8 @@ export declare function addDefinitionForRelatedFacetKeys(appSchema: object, sect
|
|
|
58
61
|
* @returns the actions definition plus the annotation path to the given line item
|
|
59
62
|
*/
|
|
60
63
|
export declare function addCommonLineItemDefinitions(appSchema: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, lineItemId: string, customColumnDefinitionName?: string): {
|
|
61
|
-
actions:
|
|
62
|
-
footerActions:
|
|
64
|
+
actions: Definition;
|
|
65
|
+
footerActions: Definition;
|
|
63
66
|
lineItemPath: string;
|
|
64
67
|
};
|
|
65
68
|
/**
|
|
@@ -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;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { Manifest } from '../../specification/common/webapp/manifest';
|
|
2
|
-
import type { EntityType } from '@sap-ux/vocabularies-types';
|
|
2
|
+
import type { AnnotationTerm, CollectionFacet, EntityType, ReferenceFacet, ReferenceURLFacet } from '@sap-ux/vocabularies-types';
|
|
3
3
|
import type { ManifestSettingsType } from '../../specification/common/types';
|
|
4
|
+
export declare type anyFacetType = AnnotationTerm<CollectionFacet> | AnnotationTerm<ReferenceFacet> | AnnotationTerm<ReferenceURLFacet>;
|
|
4
5
|
export declare enum ExportArtifacts {
|
|
5
6
|
flex = "flex",
|
|
6
7
|
manifest = "manifest"
|
|
@@ -109,12 +110,13 @@ export interface FlexAdapter {
|
|
|
109
110
|
importFlexValue?: importFlexValue;
|
|
110
111
|
}
|
|
111
112
|
export declare type ManifestPath = (pageKeys?: string[], manifest?: Manifest, ...pathParts: string[]) => string;
|
|
113
|
+
export declare type ExportHandlerFunction = (manifestSection: unknown, configObject: unknown, key: string, manifestKey?: string, ...pathParts: string[]) => unknown;
|
|
112
114
|
export interface ManifestConverter {
|
|
113
115
|
path: ManifestPath;
|
|
114
116
|
key?: string;
|
|
115
117
|
import?: ((manifestSection: unknown, sectionId?: string, propertyKey?: string, breadcrumbs?: string[]) => unknown) | boolean;
|
|
116
|
-
export?:
|
|
117
|
-
delete?: (manifestSection: unknown, configObject: unknown, key: string, manifestKey: string) => unknown;
|
|
118
|
+
export?: ExportHandlerFunction | boolean;
|
|
119
|
+
delete?: ((manifestSection: unknown, configObject: unknown, key: string, manifestKey: string, syncRuleKey?: string) => unknown) | boolean;
|
|
118
120
|
}
|
|
119
121
|
export interface SyncRule {
|
|
120
122
|
flex?: FlexAdapter;
|
|
@@ -168,6 +170,7 @@ export declare enum FacetBase {
|
|
|
168
170
|
DataPoint = "DataPoint",
|
|
169
171
|
Address = "Address",
|
|
170
172
|
Contact = "Contact",
|
|
173
|
+
PresentationVariant = "PresentationVariant",
|
|
171
174
|
Unknown = ""
|
|
172
175
|
}
|
|
173
176
|
export interface FacetConfig {
|
|
@@ -230,31 +233,65 @@ export declare enum DefinitionName {
|
|
|
230
233
|
AnalyticalListPageFilterBar = "AnalyticalListPageFilterBar",
|
|
231
234
|
AnnotationPathAsObject = "AnnotationPathAsObject",
|
|
232
235
|
ChartToolBarAction = "ChartToolBarAction",
|
|
236
|
+
CommonHeaderFacetSettings = "CommonHeaderFacetSettings",
|
|
233
237
|
CustomColumn = "TableCustomColumn",
|
|
234
238
|
CustomColumnOP = "TableCustomColumnOP",
|
|
235
239
|
CustomColumns = "TableCustomColumns",
|
|
240
|
+
CustomSections = "CustomSections",
|
|
241
|
+
FieldPath = "FieldPath",
|
|
236
242
|
Fields = "Fields",
|
|
243
|
+
Fields4Dialog = "Fields4Dialog",
|
|
244
|
+
Footer = "Footer",
|
|
237
245
|
FooterActions = "FooterActions",
|
|
238
246
|
Form = "Form",
|
|
239
247
|
FormAction = "FormAction",
|
|
240
248
|
GenericActions = "GenericActions",
|
|
249
|
+
GenericColumnsOP = "GenericColumnsOP",
|
|
250
|
+
GenericFooter = "GenericFooter",
|
|
251
|
+
GenericSections = "GenericSections",
|
|
241
252
|
HeaderActions = "HeaderActions",
|
|
253
|
+
HeaderSections = "HeaderSections",
|
|
242
254
|
LineItems = "LineItems",
|
|
243
255
|
LineItemsOfView = "LineItemsOfView",
|
|
244
256
|
ListReportFilterBar = "ListReportFilterBar",
|
|
245
257
|
LRTableView = "LRTableView",
|
|
246
258
|
LRChartView = "LRChartView",
|
|
247
259
|
MultiTableModeV4 = "MultiTableModeV4",
|
|
260
|
+
ObjectPageChart = "ObjectPageChart",
|
|
261
|
+
ObjectPageCustomSectionFragment = "ObjectPageCustomSectionFragment",
|
|
248
262
|
ObjectPageFooter = "ObjectPageFooter",
|
|
249
263
|
ObjectPageFooterAction = "ObjectPageFooterAction",
|
|
250
264
|
ObjectPageFooterActions = "ObjectPageFooterActions",
|
|
251
265
|
ObjectPageHeader = "ObjectPageHeader",
|
|
266
|
+
ObjectPageHeaderSectionForm = "ObjectPageHeaderSectionForm",
|
|
267
|
+
ObjectPageHeaderSectionChart = "ObjectPageHeaderSectionChart",
|
|
268
|
+
ObjectPageHeaderSectionDataPoint = "ObjectPageHeaderSectionDataPoint",
|
|
269
|
+
ObjectPageHeaderSectionContact = "ObjectPageHeaderSectionContact",
|
|
270
|
+
ObjectPageHeaderSectionAddress = "ObjectPageHeaderSectionAddress",
|
|
271
|
+
ObjectPageLayout = "ObjectPageLayout",
|
|
272
|
+
ObjectPagePresentationVariant = "ObjectPagePresentationVariant",
|
|
273
|
+
ObjectPageSectionAddress = "ObjectPageSectionAddress",
|
|
274
|
+
ObjectPageSectionChart = "ObjectPageSectionChart",
|
|
275
|
+
ObjectPageSectionContact = "ObjectPageSectionContact",
|
|
276
|
+
ObjectPageSectionDataPoint = "ObjectPageSectionDataPoint",
|
|
277
|
+
ObjectPageSectionForm = "ObjectPageSectionForm",
|
|
278
|
+
ObjectPageSectionPresentationVariant = "ObjectPageSectionPresentationVariant",
|
|
279
|
+
ObjectPageSectionTableV4 = "ObjectPageSectionTableV4",
|
|
280
|
+
ObjectPageSubSections = "ObjectPageSubSections",
|
|
252
281
|
ObjectPageTable = "ObjectPageTable",
|
|
253
282
|
ObjectPageTableColumn = "ObjectPageTableColumn",
|
|
283
|
+
ObjectPageToolBar = "ObjectPageToolBar",
|
|
254
284
|
ObjectPageToolBarAction = "ObjectPageToolBarAction",
|
|
285
|
+
ObjectPageToolBarActions = "ObjectPageToolBarActions",
|
|
255
286
|
Position = "Position",
|
|
256
287
|
PositionOP = "PositionOP",
|
|
288
|
+
QuickVariant = "QuickVariant",
|
|
289
|
+
QuickVariantSelectionOP = "QuickVariantSelectionOP",
|
|
290
|
+
QuickVariantSelectionV4OP = "QuickVariantSelectionV4OP",
|
|
291
|
+
RelatedFacetKeys = "RelatedFacetKeys",
|
|
292
|
+
Sections = "Sections",
|
|
257
293
|
Table = "Table",
|
|
294
|
+
TableSPV = "TableSPV",
|
|
258
295
|
TableColumn = "TableColumn",
|
|
259
296
|
ToolBarAction = "ToolBarAction",
|
|
260
297
|
ToolBarLR = "ToolBar<LineItems>",
|
|
@@ -264,21 +301,33 @@ export declare enum DefinitionName {
|
|
|
264
301
|
ViewChartToolBar = "ViewChartToolBar",
|
|
265
302
|
ViewToolBarAction = "ViewToolBarAction"
|
|
266
303
|
}
|
|
304
|
+
export declare enum PropertyName {
|
|
305
|
+
actions = "actions",
|
|
306
|
+
annotationPath = "annotationPath",
|
|
307
|
+
chart = "chart",
|
|
308
|
+
defaultPath = "defaultPath",
|
|
309
|
+
defaultTemplateAnnotationPath = "defaultTemplateAnnotationPath",
|
|
310
|
+
sections = "sections",
|
|
311
|
+
table = "table",
|
|
312
|
+
views = "views"
|
|
313
|
+
}
|
|
267
314
|
export declare enum SchemaTag {
|
|
268
|
-
hidden = "hidden",
|
|
269
|
-
isViewNode = "isViewNode",
|
|
270
315
|
annotationPath = "annotationPath",
|
|
271
316
|
annotationType = "annotationType",
|
|
272
|
-
dataType = "dataType",
|
|
273
|
-
propertyIndex = "propertyIndex",
|
|
274
317
|
artifactType = "artifactType",
|
|
275
|
-
|
|
318
|
+
dataType = "dataType",
|
|
319
|
+
fullyQualifiedName = "fullyQualifiedName",
|
|
320
|
+
hidden = "hidden",
|
|
321
|
+
isViewNode = "isViewNode",
|
|
322
|
+
key = "key",
|
|
323
|
+
propertyIndex = "propertyIndex"
|
|
276
324
|
}
|
|
277
325
|
export declare const METADATAPATH = "webapp/localService/metadata.xml";
|
|
278
326
|
export declare const MANIFESTPATH = "webapp/manifest.json";
|
|
279
327
|
export declare const VOCWITHSLASH = "/@com.sap.vocabularies";
|
|
280
328
|
export declare const VOCWITHCOLONS = "::@com.sap.vocabularies";
|
|
281
329
|
export declare const UIVOCABULARY = "com.sap.vocabularies.UI.v1";
|
|
330
|
+
export declare const UIVOCABULARYDOT = "com.sap.vocabularies.UI.v1.";
|
|
282
331
|
export declare const QUICKVARPATH = "/quickVariantSelection";
|
|
283
332
|
export declare const QUICKVARPATHX = "/quickVariantSelectionX";
|
|
284
333
|
export declare const DATESETTINGSPATH = "/filterSettings/dateSettings";
|
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
1
|
+
import type { Definition } from 'typescript-json-schema';
|
|
2
|
+
import type { ExtensionLogger } from '../../apiTypes';
|
|
3
|
+
import type { FacetConfigs, FileData, FacetConfig, FacetSection, SchemaFilePath, anyFacetType } from './types';
|
|
3
4
|
import type { Manifest } from '../../specification/common';
|
|
5
|
+
import type { MetadataInstanceInterface } from './decoration/factory';
|
|
6
|
+
import type { ConverterOutput, DataFieldAbstractTypes, EntityType, PropertyAnnotations, PropertyPath } from '@sap-ux/vocabularies-types';
|
|
4
7
|
import { FioriElementsVersion, PageType, PageTypeV4 } from '../../specification/common';
|
|
5
8
|
import { SchemaType } from '../../specification/schemaAccess';
|
|
6
|
-
import type { ExtensionLogger } from '../../apiTypes';
|
|
7
|
-
import type { MetadataInstanceInterface } from './decoration/factory';
|
|
8
9
|
export declare enum TemplateType {
|
|
9
10
|
ListReportObjectPageV2 = "ListReportObjectPageV2",
|
|
10
11
|
ListReportObjectPageV4 = "ListReportObjectPageV4",
|
|
@@ -54,7 +55,13 @@ export declare function getLabelForDataField(field: DataFieldAbstractTypes, enti
|
|
|
54
55
|
* @param dataFieldAbstract - the given record of the line item annotation
|
|
55
56
|
* @param entityType - the entity type as part of the AVT ConverterOutput
|
|
56
57
|
*/
|
|
57
|
-
export declare function
|
|
58
|
+
export declare function getDataFieldDescription(dataFieldAbstract: DataFieldAbstractTypes, entityType: EntityType): string;
|
|
59
|
+
/**
|
|
60
|
+
* Prepare string for reference use in schema
|
|
61
|
+
* @param refInput string to be character checked and replaced
|
|
62
|
+
* @returns string with replaced characters
|
|
63
|
+
*/
|
|
64
|
+
export declare function prepareRef(refInput: string): string;
|
|
58
65
|
/**
|
|
59
66
|
* Return the page type for a given V2 page in manifest
|
|
60
67
|
* @param name - page component name
|
|
@@ -81,7 +88,7 @@ export declare function findAlias(namespace: string, oDataServiceAVT: ConverterO
|
|
|
81
88
|
* @param {ExtensionLogger} logger - Logger class for logging messages
|
|
82
89
|
* @returns {FacetSection} - object comprising the relevant facet information
|
|
83
90
|
*/
|
|
84
|
-
export declare function getSectionFacet(facetDefinition:
|
|
91
|
+
export declare function getSectionFacet(facetDefinition: anyFacetType, sourceEntityType: EntityType, oDataServiceAVT: ConverterOutput, logger?: ExtensionLogger, oDataVersion?: FioriElementsVersion, keyForRelatedFacetKeys?: boolean): FacetSection | undefined;
|
|
85
92
|
/**
|
|
86
93
|
* Finds the alias for a given namespace in the references' section of the converted service metadata.
|
|
87
94
|
* An empty object is created if the path element does not exist yet.
|
|
@@ -144,7 +151,7 @@ export declare function getTemplateTypeFromManifest(manifest: Manifest, fioriEle
|
|
|
144
151
|
* @param section - section in the app schema
|
|
145
152
|
* @param facetKey - key of the facet
|
|
146
153
|
*/
|
|
147
|
-
export declare function addSectionTitleAndDescription(facet: FacetConfig, section:
|
|
154
|
+
export declare function addSectionTitleAndDescription(facet: FacetConfig, section: Definition, facetKey: string): void;
|
|
148
155
|
/**
|
|
149
156
|
* Adds target title or description to a section or header section in an app schema
|
|
150
157
|
* @param facet - intermediate facet structure comprising annotation information
|
|
@@ -157,7 +164,7 @@ export declare function addTargetTitleAndSectionDescription(facet: FacetConfig,
|
|
|
157
164
|
* @param facet Facet configuration, to be analyzed
|
|
158
165
|
* @returns the new section object
|
|
159
166
|
*/
|
|
160
|
-
export declare function createSectionWithoutProperties(facet: FacetConfig, facetKey: string):
|
|
167
|
+
export declare function createSectionWithoutProperties(facet: FacetConfig, facetKey: string): Definition;
|
|
161
168
|
/**
|
|
162
169
|
* Retrieve page section data(so far id/key and label/description).
|
|
163
170
|
* @param {EntityType} entityType The actual entityType
|
|
@@ -188,11 +195,10 @@ export declare const getSchemaFilePath: (schemaType: PageType | PageTypeV4 | Sch
|
|
|
188
195
|
* @param appVersion - Fiori Elements version - V2 or V4.
|
|
189
196
|
* @param pageType - Page type.
|
|
190
197
|
* @param entitySet - Entity Set.
|
|
191
|
-
* @param navigationProperty - Navigation property (optional).
|
|
192
198
|
* @param viewId - Custom page's viewId (optional).
|
|
193
199
|
* @returns {string} Generated page id
|
|
194
200
|
*/
|
|
195
|
-
export declare function generatePageId(pageType: PageType | PageTypeV4, entitySet: string,
|
|
201
|
+
export declare function generatePageId(pageType: PageType | PageTypeV4, entitySet: string, viewId?: string): string;
|
|
196
202
|
export declare type NextDefinition = {
|
|
197
203
|
configObject?: object;
|
|
198
204
|
targetDefinition?: object;
|
|
@@ -209,7 +215,6 @@ export declare type NextDefinition = {
|
|
|
209
215
|
* @param pageType - page type
|
|
210
216
|
*/
|
|
211
217
|
export declare function getNextTargetDefinition(appSchema: object, title: string, currentConfigObject: object, propertyDefinition: object, key: string, factory: MetadataInstanceInterface, pageType: PageType | PageTypeV4): NextDefinition;
|
|
212
|
-
export declare function prepareRef(refInput: string): string;
|
|
213
218
|
/**
|
|
214
219
|
* Custom array merge function called by deepmerge's merge function
|
|
215
220
|
*
|
|
@@ -9,6 +9,7 @@ export declare class CreateWithFilters {
|
|
|
9
9
|
strategy: Strategy;
|
|
10
10
|
}
|
|
11
11
|
export declare function exportType(manifestSection: unknown, configPart: object): void;
|
|
12
|
+
export declare function deleteType(manifestSection: unknown): void;
|
|
12
13
|
export declare class DataLoadSettings {
|
|
13
14
|
loadDataOnAppLaunch: LoadDataOnAppLaunchSettings;
|
|
14
15
|
}
|
|
@@ -15,7 +15,6 @@ export declare function transferManifestEntriesOVP(configObject: {
|
|
|
15
15
|
}, exportResults: ExportResults, jsonSchema: object, targetDefinition: object, factory: MetadataInstanceInterface, pathHierarchy?: string[]): void;
|
|
16
16
|
/**
|
|
17
17
|
* Assign sync rules to {currentObject}
|
|
18
|
-
*
|
|
19
18
|
* @param {string} structureName - name of the complex structure in schema
|
|
20
19
|
* @param {object} currentObject - the given part of the configuration
|
|
21
20
|
* @param {string} defaultTypeName - name of the default type that shall be taken if no class is registered for structureName
|
|
@@ -17,4 +17,10 @@ export declare const ensureManifestSectionByPathV2: (manifest: object, path: str
|
|
|
17
17
|
*/
|
|
18
18
|
export declare const getManifestSectionByPathV2: (manifest: object, path: string) => object;
|
|
19
19
|
export declare const deleteManifestSectionByPathV2: (manifest: object, path: string) => void;
|
|
20
|
+
/**
|
|
21
|
+
* Transfers pages and routings from manifest to the config pages
|
|
22
|
+
* @param pageId - page ID
|
|
23
|
+
* @param configPages - config definitions of each page
|
|
24
|
+
* @param manifestPage - top page definition in manifest
|
|
25
|
+
*/
|
|
20
26
|
export declare function transformPageToNewManifestV2(pageId: string, configPages: Pages, manifestPage: object): void;
|
|
@@ -2,7 +2,7 @@ import type { OverviewPageConfig, ContainerLayoutType, ChartSettingsType, Filter
|
|
|
2
2
|
import type { ListCard, AnalyticalCard, StackCard, LinklistCard, TableCard, CustomCard } from '../controls/Card';
|
|
3
3
|
export declare function importDateSettingsOVP(manifestSection: object): DateRange;
|
|
4
4
|
export declare function importFilterSettings(manifestSection: object): object;
|
|
5
|
-
export declare function exportFilterSettings(manifestSection:
|
|
5
|
+
export declare function exportFilterSettings(manifestSection: object, configPart: FilterSettingsType): void;
|
|
6
6
|
declare type CardClassType = ListCard | AnalyticalCard | StackCard | LinklistCard | TableCard | CustomCard;
|
|
7
7
|
export declare class OverviewPage implements OverviewPageConfig {
|
|
8
8
|
globalFilterModel?: string;
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
+
import type { Definition } from 'typescript-json-schema';
|
|
1
2
|
import type { FileData } from '../../common';
|
|
2
|
-
import type { AnnotationTerm, EntityType, LineItem, SelectionFields } from '@sap-ux/vocabularies-types';
|
|
3
|
-
import type { SapUiAppPageV2 } from '../../../specification/v2';
|
|
4
3
|
import type { MetadataInstanceInterface } from '../../common/decoration/factory';
|
|
5
4
|
import type { PageType, PageTypeV4 } from '../../../specification/common';
|
|
5
|
+
import type { SapUiAppPageV2 } from '../../../specification/v2';
|
|
6
|
+
import type { AnnotationTerm, EntityType, LineItem, SelectionFields } from '@sap-ux/vocabularies-types';
|
|
6
7
|
import { ActionTypeV2 } from '../types';
|
|
7
8
|
/**
|
|
8
9
|
* Processes a LineItem record of type DataFieldForAction and DataFieldForIntentBasedNavigation during app schema generation
|
|
@@ -28,7 +29,7 @@ export declare function handleActionRecord(appSchema: object, actions: object, l
|
|
|
28
29
|
* in case of LR or ALP no ID is passed, 'LineItems' is taken then.
|
|
29
30
|
* @param customColumnRef - schema reference to custom column definition.
|
|
30
31
|
*/
|
|
31
|
-
export declare function addLineItemsType(appSchema:
|
|
32
|
+
export declare function addLineItemsType(appSchema: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, lineItemId?: string, customColumnRef?: string): void;
|
|
32
33
|
/**
|
|
33
34
|
* Adds enum entries of possible leading properties for 'leadingProperty' property in TableCustomColumn properties.
|
|
34
35
|
* @param appSchema - the app specific schema that shall get enhanced
|
|
@@ -51,7 +52,7 @@ export declare function addTabkeyEnum(appSchema: object, definitionName: string,
|
|
|
51
52
|
* @param {string} property Property name.
|
|
52
53
|
* @param {string} definitionName Definition name of CustomColumn definition.
|
|
53
54
|
*/
|
|
54
|
-
export declare function addFragmentEnum(appSchema:
|
|
55
|
+
export declare function addFragmentEnum(appSchema: Definition, fragments: FileData[], appId: string, property: string, definitionName: string): void;
|
|
55
56
|
/**
|
|
56
57
|
* Adds the custom columns to the line item records of the app schema (for the list report comprising a table).
|
|
57
58
|
* @param {object} appSchema The app specific schema that shall get enhanced.
|
|
@@ -3,7 +3,16 @@ import type { Manifest } from '../../../../specification/common';
|
|
|
3
3
|
import { AppProvider } from '../../../common/appProvider';
|
|
4
4
|
import type { FileData, Files } from '../../../common';
|
|
5
5
|
import type { ExtensionLogger } from '../../../../v2';
|
|
6
|
+
/**
|
|
7
|
+
* The V2AppProvider collects all the app information for a Fiori Elements V2 app
|
|
8
|
+
*/
|
|
6
9
|
export declare class V2AppProvider extends AppProvider {
|
|
7
10
|
constructor(manifest: Manifest, changes: string[], schemas: Files, fragments?: FileData[], logger?: ExtensionLogger);
|
|
8
11
|
}
|
|
12
|
+
/**
|
|
13
|
+
* Collects all pages of a V2 app from the manifest, by traversing the V2 page hierarchy.
|
|
14
|
+
* @param v2Pages - entry point = complex page definition in manifest
|
|
15
|
+
* @param componentName - Component name
|
|
16
|
+
* @returns index table of pages
|
|
17
|
+
*/
|
|
9
18
|
export declare function getPages(v2Pages: SapUiAppPagesV2, componentName: string): Pages;
|