@sap/ux-specification 1.96.9 → 1.96.10

package/dist/schemas/v4/ListReportConfig.json

@@ -26,9 +26,14 @@
         }
       ]
     },
+    "defaultTemplateAnnotationPath": {
+      "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.",
+      "type": "string",
+      "artifactType": "Manifest"
+    },
     "defaultPath": {
       "$ref": "#/definitions/DefaultPathType",
-      "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.",
+      "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.",
       "artifactType": "Manifest"
     },
     "$schema": {
@@ -513,6 +518,11 @@
       "isViewNode": true,
       "type": "object",
       "properties": {
+        "annotationPath": {
+          "description": "The secondary annotation path can be either UI.LineItem, UI.PresentationVariant, or UI.SelectionPresentationVariant.",
+          "type": "string",
+          "artifactType": "Manifest"
+        },
         "initialLoad": {
           "$ref": "#/definitions/InitialLoadType",
           "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).",

package/dist/src/specification/v4/controls/Table.d.ts

@@ -264,6 +264,10 @@ export interface LRTableView extends TableSettings {
  * @isViewNode true
  */
 export interface Table extends TableSettings {
+    /**
+     * The secondary annotation path can be either UI.LineItem, UI.PresentationVariant, or UI.SelectionPresentationVariant.
+     */
+    annotationPath?: string;
     /**
      * initialLoad defines whether or not the data in the table is automatically loaded.
      * - Disabled - Data is never loaded when opening the app without an app state.

package/dist/src/specification/v4/pages/ListReportConfig.d.ts

@@ -25,7 +25,12 @@ export interface ListReportConfig extends PageConfig {
      */
     table?: Table | ALPTableView;
     /**
-     * "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.
+     * defaultTemplateAnnotationPath must be a reference to a SelectionPresentationVariant.
+     * You use the SelectionPresentationVariant to configure the default visualizations and default filter values of the main content area.
+     */
+    defaultTemplateAnnotationPath?: string;
+    /**
+     * 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.
      */
     defaultPath?: DefaultPathType;
 }

package/dist/src/specification/v4/webapp/manifest/sapUiPageV4.d.ts

@@ -38,6 +38,7 @@ export declare type SapUiPageSettingsV4 = SapUiGenericAppPageSettings & {
     controlConfiguration?: SapUiGenericAppPageSettings;
     content?: SapUi5RoutingTargetContent;
     views?: SapUi5Views;
+    defaultTemplateAnnotationPath?: string;
 };
 export interface SapUiAppPageV4 {
     type: string;

package/dist/src/sync/common/generate/objectPage.d.ts

@@ -3,6 +3,7 @@ import { FioriElementsVersion } from '../../../specification/common';
 import type { FacetConfig } from '..';
 import { SectionType } from '..';
 import type { EntitySet } from '@sap-ux/annotation-converter';
+import type { Definition } from 'typescript-json-schema';
 /**
  * Adds definitions for forms in object page sections to the app schema
  * @param {SectionType} sectionType - prefix to distinguish Section and HeaderSection
@@ -11,7 +12,7 @@ import type { EntitySet } from '@sap-ux/annotation-converter';
  * @param {object} appSchema - app specific schema that gets enhanced
  * @param {FioriElementsVersion} version - Fiori Elements version
  */
-export declare function handleForm(sectionType: SectionType, section: FacetConfig, appSchemaSection: object, appSchema: object, version: FioriElementsVersion, withActions?: boolean): void;
+export declare function handleForm(sectionType: SectionType, section: FacetConfig, appSchemaSection: Definition, appSchema: Definition, version: FioriElementsVersion, withActions?: boolean): void;
 /**
  * Replaces an alias in an annotation ID or reference, based on the AVT references' list
  * @param annotationIdentifier - annotation ID or reference
@@ -36,20 +37,20 @@ export declare function getActionNameAndId(action: string, entityType: EntityTyp
  * @param {EntityType} entityType - current entity type
  * @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
  */
-export declare function addFooterActions(appSchema: object, entityType: EntityType, oDataServiceAVT: ConverterOutput): void;
+export declare function addFooterActions(appSchema: Definition, entityType: EntityType, oDataServiceAVT: ConverterOutput): void;
 /**
  * Add Object Page Header Action Buttons to app-specific schema
  * @param {object} appSchema Schema of the app
  * @param {EntityType} entityType - current entity type
  * @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
  */
-export declare function addHeaderActions(appSchema: object, entityType: EntityType, oDataServiceAVT: ConverterOutput, addHeaderActionCallBack: any): void;
+export declare function addHeaderActions(appSchema: Definition, entityType: EntityType, oDataServiceAVT: ConverterOutput, addHeaderActionCallBack: any): void;
 /**
  * Adds common Object Page Header definitions to the app schema
  * @param appSchema - app-specific JSOn schema
  * @param entityType - current entity Type
  */
-export declare function addCommonHeaderSchema(appSchema: object, entityType: EntityType): void;
+export declare function addCommonHeaderSchema(appSchema: Definition, entityType: EntityType): void;
 /**
  * Common logic to determine the EntitySet of a facet
  * @param facet - current facet or section

package/dist/src/sync/common/generate/utils.d.ts

@@ -23,30 +23,30 @@ export declare function addEnumForSingleTabVariant(entityType: EntityType, appSc
  * @param definitionName - name of the definition in the app schema
  * @param {EntitySet} entitySet - current entity set of the page or view
  */
-export declare function addEnumForMultiTabVariant(appSchema: object, definitionName: string, entitySet: EntitySet): void;
+export declare function addEnumForMultiTabVariant(appSchema: Definition, definitionName: string, entitySet: EntitySet): void;
 /**
  * Adds the enume values for entitySet as part of the multiple view scenario
  * @param {ConverterOutput} oDataServiceAVT - combined service metadata, as returned by annotation vocabularies tools
  * @param appSchema - app specific JSOn schema
  * @param definitionName - name of the definition in the app schema
  */
-export declare function addEnumForVariantEntitySet(oDataServiceAVT: ConverterOutput, appSchema: object, definitionName: string): void;
+export declare function addEnumForVariantEntitySet(oDataServiceAVT: ConverterOutput, appSchema: Definition, definitionName: string): void;
 /**
  * Adds an enum filled with existing UI annotations for annotationPath property in FilterBar
  * @param {EntityType} entityType
  * @param appSchema - app specific JSOn schema
  * @param definitionName - name of the definition in the app schema
  */
-export declare function addEnumForFilterBarAnnotationPath(entityType: EntityType, appSchema: object, definitionName: string): void;
+export declare function addEnumForFilterBarAnnotationPath(entityType: EntityType, appSchema: Definition, definitionName: string): void;
 /**
  * Method adds definition for 'RelatedFacetKeys' as enum with describtion and adds references to 'RelatedFacetKeys' for custom section definitions.
- * @param {object} schema App specific schema that potentially gets enhanced
+ * @param {object} appSchema App specific schema that potentially gets enhanced
  * @param {string[]>} sectionDefinitions array of section definitions which should be updated with new reference to 'RelatedFacetKeys' enum.
  * @param {FacetSection[]} facetSections Array of facet section objects which is used to generate enum values.
  * @param {Array<keyof Omit<FacetSection, 'custom'>>} idProperties Array of property names which should be looked up in 'FacetSection' object.
  *  Please note that method depends on order and takes first non empty value associated to passed properties.
  */
-export declare function addDefinitionForRelatedFacetKeys(schema: object, sectionDefinitions: string[], facetSections: FacetSection[], idProperties: Array<keyof Omit<FacetSection, 'custom'>>): void;
+export declare function addDefinitionForRelatedFacetKeys(appSchema: object, sectionDefinitions: string[], facetSections: FacetSection[], idProperties: Array<keyof Omit<FacetSection, 'custom'>>): void;
 /**
  * Functions used both by V2 and V4 to add the common definitions for a line item to the app schema
  * @param appSchema - the app specific schema that shall get enhanced
@@ -57,7 +57,7 @@ export declare function addDefinitionForRelatedFacetKeys(schema: object, section
  *        Passed in the V4 case, then additional properties of this type will be allowed.
  * @returns the actions definition plus the annotation path to the given line item
  */
-export declare function addCommonLineItemDefinitions(appSchema: object, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, lineItemId: string, customColumnDefinitionName?: string): {
+export declare function addCommonLineItemDefinitions(appSchema: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, lineItemId: string, customColumnDefinitionName?: string): {
     actions: object;
     footerActions: object;
     lineItemPath: string;
@@ -68,7 +68,7 @@ export declare function addCommonLineItemDefinitions(appSchema: object, lineItem
  * @param {EntityType} entityType - Given entity type for which entries shall get generated
  * @param {string=} floorplanSuffix - floorplan specific suffix (optional)
  */
-export declare function addFieldsType(appSchema: object, entityType: EntityType, floorplanSuffix?: string): void;
+export declare function addFieldsType(appSchema: Definition, entityType: EntityType, floorplanSuffix?: string): void;
 export declare enum DataType {
     String = "String",
     Rating = "Rating",

package/dist/src/sync/common/types.d.ts

@@ -155,6 +155,10 @@ export interface FileData {
     dataSourceUri: string;
     fileContent: string;
 }
+export declare enum Visualization {
+    LineItem = "LineItem",
+    Chart = "Chart"
+}
 export declare enum FacetBase {
     LineItem = "LineItem",
     CollectionFacet = "CollectionFacet",
@@ -218,35 +222,57 @@ export declare enum ViewTemplateType {
     ResponsiveTableCellsExtension = "ResponsiveTableCellsExtension"
 }
 export declare enum DefinitionName {
-    TableColumn = "TableColumn",
-    ViewTableColumn = "ViewTableColumn",
-    ObjectPageTable = "ObjectPageTable",
-    ObjectPageTableColumn = "ObjectPageTableColumn",
-    ToolBarLR = "ToolBar<LineItems>",
-    ToolBar = "ToolBar",
-    CustomColumns = "TableCustomColumns",
+    Actions = "Actions",
+    ALPChart = "ALPChart",
+    ALPChartView = "ALPChartView",
+    ALPTable = "ALPTable",
+    ALPTableView = "ALPTableView",
+    AnalyticalListPageFilterBar = "AnalyticalListPageFilterBar",
+    AnnotationPathAsObject = "AnnotationPathAsObject",
+    ChartToolBarAction = "ChartToolBarAction",
     CustomColumn = "TableCustomColumn",
-    ViewCustomColumn = "ViewTableCustomColumn",
     CustomColumnOP = "TableCustomColumnOP",
-    Position = "Position",
-    PositionOP = "PositionOP",
+    CustomColumns = "TableCustomColumns",
+    Fields = "Fields",
+    FooterActions = "FooterActions",
+    Form = "Form",
+    FormAction = "FormAction",
+    GenericActions = "GenericActions",
+    HeaderActions = "HeaderActions",
+    LineItems = "LineItems",
+    LineItemsOfView = "LineItemsOfView",
     ListReportFilterBar = "ListReportFilterBar",
-    AnalyticalListPageFilterBar = "AnalyticalListPageFilterBar",
-    ALPChart = "ALPChart",
-    ALPChartView = "ALPChartView",
-    ViewChartToolBar = "ViewChartToolBar",
-    Table = "Table",
     LRTableView = "LRTableView",
     LRChartView = "LRChartView",
-    Actions = "Actions",
-    ViewToolBarAction = "ViewToolBarAction",
-    ChartToolBarAction = "ChartToolBarAction",
-    ToolBarAction = "ToolBarAction",
-    ObjectPageToolBarAction = "ObjectPageToolBarAction",
     MultiTableModeV4 = "MultiTableModeV4",
-    AnnotationPathAsObject = "AnnotationPathAsObject",
-    ALPTable = "ALPTable",
-    ALPTableView = "ALPTableView"
+    ObjectPageFooter = "ObjectPageFooter",
+    ObjectPageFooterAction = "ObjectPageFooterAction",
+    ObjectPageFooterActions = "ObjectPageFooterActions",
+    ObjectPageHeader = "ObjectPageHeader",
+    ObjectPageTable = "ObjectPageTable",
+    ObjectPageTableColumn = "ObjectPageTableColumn",
+    ObjectPageToolBarAction = "ObjectPageToolBarAction",
+    Position = "Position",
+    PositionOP = "PositionOP",
+    Table = "Table",
+    TableColumn = "TableColumn",
+    ToolBarAction = "ToolBarAction",
+    ToolBarLR = "ToolBar<LineItems>",
+    ToolBar = "ToolBar",
+    ViewTableColumn = "ViewTableColumn",
+    ViewCustomColumn = "ViewTableCustomColumn",
+    ViewChartToolBar = "ViewChartToolBar",
+    ViewToolBarAction = "ViewToolBarAction"
+}
+export declare enum SchemaTag {
+    hidden = "hidden",
+    isViewNode = "isViewNode",
+    annotationPath = "annotationPath",
+    annotationType = "annotationType",
+    dataType = "dataType",
+    propertyIndex = "propertyIndex",
+    artifactType = "artifactType",
+    key = "key"
 }
 export declare const METADATAPATH = "webapp/localService/metadata.xml";
 export declare const MANIFESTPATH = "webapp/manifest.json";

package/dist/src/sync/v2/export/manifest.d.ts

@@ -1,4 +1,20 @@
 import type { Pages } from '../../../specification/v2';
+/**
+ * Method searches in manifest object by passed path and returns found value.
+ * If value was not found in manifest object,
+ *   then method created empty object in manifest object within passed path.
+ * @param manifest - target manifest object
+ * @param path - path to lookup in manifest
+ * @returns Found or created value
+ */
+export declare const ensureManifestSectionByPathV2: (manifest: object, path: string) => object;
+/**
+ * Method searches in manifest object by passed path and returns found value.
+ * If value was not found in manifest object, then 'undefined' is returned.
+ * @param manifest - target manifest file
+ * @param path - path to lookup in manifest
+ * @returns Found value
+ */
 export declare const getManifestSectionByPathV2: (manifest: object, path: string) => object;
 export declare const deleteManifestSectionByPathV2: (manifest: object, path: string) => void;
 export declare function transformPageToNewManifestV2(pageId: string, configPages: Pages, manifestPage: object): void;

package/dist/src/sync/v4/export/controls/Table.d.ts

@@ -148,6 +148,7 @@ export declare class MultiTableModeV4 implements MultiTableModeIF {
  * Sync class for Table
  */
 export declare class Table extends TableSettings implements TableInterface {
+    annotationPath?: string;
     views?: MultiTableModeV4;
     initialLoad?: InitialLoadType;
     toolBar?: ToolBar;

package/dist/src/sync/v4/export/pages/ListReport.d.ts

@@ -8,5 +8,6 @@ export declare class ListReport implements ListReportConfigV4 {
     table?: ALPTableView | Table;
     variantManagement?: VariantManagementTypeListReport;
     defaultPath?: DefaultPathType;
+    defaultTemplateAnnotationPath?: string;
     filterbar?: FilterBar;
 }

package/dist/src/sync/v4/utils/utils.d.ts

@@ -15,7 +15,7 @@ import type { Definition } from 'typescript-json-schema';
  */
 export declare function addCustomColumnDefinition(appSchema: object, v4Page: SapUiAppPageV4, logger: ExtensionLogger, customColumnDefinitionName?: string, sectionId?: string, sectionIdInManfest?: string): void;
 /**
- * Processes a LineItem record of type DataFieldForCation during app schema generation
+ * Processes a LineItem record of type DataFieldForAction during app schema generation
  * @param appSchema - the app specific schema that shall get enhanced
  * @param entityType - the entity type as part of the AVT ConverterOutput
  * @param actions - actions definition in schema, parent object
@@ -23,20 +23,20 @@ export declare function addCustomColumnDefinition(appSchema: object, v4Page: Sap
  * @param lineItemRecord - actual record of the line item collection
  * @param recordIndex - record index in the collection
  */
-export declare function handleActionRecord(appSchema: object, entityType: EntityType, actions: object, lineItemPath: string, lineItemRecord: DataFieldForActionAbstractTypes, lineItemId: string, recordIndex: number): void;
+export declare function handleActionRecord(appSchema: Definition, entityType: EntityType, actions: Definition, lineItemPath: string, lineItemRecord: DataFieldForActionAbstractTypes, lineItemId: string, recordIndex: number): void;
 /**
  * Adds the line item definition, columns and actions to the app schema (for the list report or an object page section comprising a table)
  * @param appSchema - the app specific schema that shall get enhanced
  * @param lineItemAnnotation - the UI.LineItem annotation, comprising all records
  * @param entityType - the entity type as part of the AVT ConverterOutput
  * @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by Annotation Vocabularies Tool
- * @param columnDefinitionName - name of the column definition, i.e. TableColumn or ObjectPageTableColumn
  * @param actionDefinitionName - indicates the prefix for the definition, dpending on the page type
- * @param lineItemId - optional: in case of OP the paramter must be passed to distinguish the OP tables;
- *                      in case of LR or ALP no ID is passed, 'LineItems' is taken then.
- * @param customColumnRef - schema reference to custom column definition.
+ * @param lineItemId - in case of OP the paramter must be passed to distinguish the OP tables;
+ *                     in case of LR or ALP 'LineItems' is passed.
+ * @param columnDefinitionName - name of the column definition, i.e. TableColumn or ObjectPageTableColumn
+ * @param customColumnDefinitionName - name of the custom column definition
  */
-export declare function addLineItemsType(appSchema: object, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, oDataServiceAVT: ConverterOutput, columnDefinitionName?: string, customColumnDefinitionName?: string, lineItemId?: string): void;
+export declare function addLineItemsType(appSchema: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, oDataServiceAVT: ConverterOutput, lineItemId: string, columnDefinitionName?: string, customColumnDefinitionName?: string): void;
 /**
  * Adds an enum or value help to position > anchor of custom column
  * @param appSchema - app specific JSON schema
@@ -44,7 +44,7 @@ export declare function addLineItemsType(appSchema: object, lineItemAnnotation:
  * @param v4Page - current page in manifest
  * @param positionName - ID of the definition of custom column position in schema
  */
-export declare function addFragmentEnumForAnchor(appSchema: object, lineItemId: string, v4Page: SapUiAppPageV4, positionName?: DefinitionName, sectionIdInManifest?: string): void;
+export declare function addFragmentEnumForAnchor(appSchema: Definition, lineItemId: string, v4Page: SapUiAppPageV4, positionName?: DefinitionName, sectionIdInManifest?: string): void;
 /**
  * Find the relevant V4 page under the routing targets of manifest,json
  * @param pages - list of all pages in manifest

package/dist/test/unit/export/manifest.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/ux-specification",
-  "version": "1.96.9",
+  "version": "1.96.10",
   "displayName": "SAP Fiori tools - Specification",
   "description": "SAP Fiori tools - Specification",
   "files": [