@sap/ux-specification 1.96.87 → 1.96.89

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

@@ -9,22 +9,27 @@ export interface CustomExtensions {
     [key: string]: CustomExtension;
 }
 /**
- * Adds extension at the right position of the sorted array of annotation-based nodes
+ * Adds extension at the right position of the sorted array of annotation-based nodes.
+ *
  * @param extensions - list of extensions in manifest
  * @param sortedExtensionsArray - sorted array of annotation-based nodes, to be enhanced by extensions
  * @param extensionDefinitionName - extension definition name, different in LR and OP
+ * @param templatePropertyName - The name of the property in the template to be used for processing.
  * @param logger - logger for error messages
  * @param ignoreAnnotationAnchors - calculation should ignore anchors referenced to annotation nodes. Used when annotations sections are merged.
+ * @returns Sorted array of annotation-based nodes, enhanced by extensions
  */
 export declare function addExtensionToArray(extensions: CustomExtensions, sortedExtensionsArray: [string, unknown][], extensionDefinitionName: string, templatePropertyName?: string, logger?: ExtensionLogger, ignoreAnnotationAnchors?: boolean): [string, unknown][];
 /**
- * Adds enum values to the properties definition of a custom column
+ * Adds enum values to the properties definition of a custom column.
+ *
  * @param lineItems - current lineItems definition, with all records
  * @param customColumnDefinition - current custom column definition, in the app schema
  */
 export declare function addEnumForProperties(lineItems: boolean | Definition, customColumnDefinition: Definition): void;
 /**
- * Common function for enhancing the LineItems definition of app schema by custom columns
+ * Common function for enhancing the LineItems definition of app schema by custom columns.
+ *
  * @param appSchema - app-specific JSON schema
  * @param v4Page - actual page in the manifest
  * @param logger - logger for error messages
@@ -43,8 +48,9 @@ export type LineItemDataForSchema = {
     entitySet?: string;
 };
 /**
- * Appends line item columns and actions to the app schema (for the list report, custom page or an object page section comprising a table)
- * @param {LineItemDataForSchema} data: structure comprising
+ * Appends line item columns and actions to the app schema (for the list report, custom page or an object page section comprising a table).
+ *
+ * @param {LineItemDataForSchema} data structure comprising
  * - appSchema - the app specific schema that shall get enhanced
  * - lineItemAnnotation - the UI.LineItem annotation, comprising all records
  * - entityType - the entity type as part of the AVT ConvertedMetadata
@@ -58,8 +64,9 @@ export type LineItemDataForSchema = {
  */
 export declare function appendLineItemsToSchema(data: LineItemDataForSchema, actions: Definition, lineItemPath: string, lineItemDefinition?: Definition, columnDefinitionName?: string): void;
 /**
- * Adds the line item definition, columns and actions to the app schema (for the list report, custom page or an object page section comprising a table
- * @param {LineItemDataForSchema} data: structure comprising
+ * Adds the line item definition, columns and actions to the app schema (for the list report, custom page or an object page section comprising a table.
+ *
+ * @param data structure comprising
  * - isObjectPage - indicates that the page is an object page
  * - appSchema - the app specific schema that shall get enhanced
  * - lineItemAnnotation - the UI.LineItem annotation, comprising all records
@@ -67,13 +74,14 @@ export declare function appendLineItemsToSchema(data: LineItemDataForSchema, act
  * - oDataServiceAVT - complete service information, as returned by Annotation Vocabularies Tool
  * - lineItemId - in case of OP the parameter must be passed to distinguish the OP tables;
  *                in case of LR or ALP 'LineItems' is passed.
- * @param {string} columnDefinitionName - name of the column definition, i.e. TableColumn or ObjectPageTableColumn
- * @param {string} customColumnDefinitionName - name of the custom column definition
- * @param {string} customColumnDefinitionName - name of the custom action definition
+ * @param columnDefinitionName - name of the column definition, i.e. TableColumn or ObjectPageTableColumn
+ * @param customColumnDefinitionName - name of the custom column definition
+ * @param customActionDefinitionName - name of the custom action definition
  */
 export declare function addLineItemsTypeToSchema(data: LineItemDataForSchema, columnDefinitionName?: string, customColumnDefinitionName?: string, customActionDefinitionName?: string): void;
 /**
- * Adds an enum or value help to position > anchor of custom column
+ * Adds an enum or value help to position > anchor of custom column.
+ *
  * @param appSchema - app specific JSON schema
  * @param lineItemId - ID of the current line item in schema
  * @param v4Page - current page in manifest
@@ -82,30 +90,34 @@ export declare function addLineItemsTypeToSchema(data: LineItemDataForSchema, co
  */
 export declare function addFragmentEnumForAnchor(appSchema: Definition, lineItemId: string, v4Page: v4.SapUiAppPageV4, positionName?: string, sectionIdInManifest?: string): void;
 /**
- * Adds an enum or value help to position > anchor of custom column or custom action
+ * Adds an enum or value help to position > anchor of custom column or custom action.
+ *
  * @param appSchema - app specific JSON schema
  * @param definitionId - definition key of actions
  * @param positionName - target definition to update
  */
 export declare function addEnumForActionAnchor(appSchema: Definition, definitionId: string, positionName?: string): void;
 /**
- * Find the relevant V4 page under the routing targets of manifest,json
+ * Find the relevant V4 page under the routing targets of manifest,json.
+ *
  * @param pages - list of all pages in manifest
- * @param pageName - search criterion: page name
+ * @param templateName - search criterion: template name
  * @param entitySet - search criterion: entity set object from AVT
  * @param contextPath - search criterion: contextPath
  * @returns the page definition in manifest (if found)
  */
-export declare function findPageV4(pages: v4.SapUiAppPageV4[], pageName: string, entitySet: EntitySet, contextPath: string): v4.SapUiAppPageV4 | undefined;
+export declare function findPageV4(pages: v4.SapUiAppPageV4[], templateName: string, entitySet?: EntitySet, contextPath?: string): v4.SapUiAppPageV4 | undefined;
 /**
- * Depending on the template type, strip down the app schema so that only the relevant views are part of it
+ * Depending on the template type, strip down the app schema so that only the relevant views are part of it.
+ *
  * @param {Definition} appSchema - app specific JSON schema, to be adjusted
  * @param {GenerateAppSchemaParameters} generateParameters - object comprising all input parameters
  * @returns the right definition name for the table in the schema
  */
 export declare function alignSchemaWithTemplateType(appSchema: Definition, generateParameters: GenerateAppSchemaParameters): DefinitionName.Table | DefinitionName.ALPTableView;
 /**
- * Common function for enhancing LineItems, FieldGroups and Custom Section definitions of app schema by custom action definitions
+ * Common function for enhancing LineItems, FieldGroups and Custom Section definitions of app schema by custom action definitions.
+ *
  * @param appSchema - app-specific JSON schema
  * @param v4Page - actual page in the manifest
  * @param logger - logger for error messages
@@ -115,7 +127,8 @@ export declare function alignSchemaWithTemplateType(appSchema: Definition, gener
  */
 export declare function addCustomActionDefinition(appSchema: Definition, v4Page: v4.SapUiAppPageV4, logger: ExtensionLogger, customActionDefinitionName?: string, sectionDefinitionName?: string, sectionIdInManifest?: string): void;
 /**
- * Common function for enhancing header and footer definitions of app schema by custom action definitions
+ * Common function for enhancing header and footer definitions of app schema by custom action definitions.
+ *
  * @param appSchema - app-specific JSON schema
  * @param v4Page - actual page in the manifest
  * @param logger - logger for error messages
@@ -125,6 +138,7 @@ export declare function addCustomActionDefinition(appSchema: Definition, v4Page:
 export declare function addHeaderFooterCustomActionDefinition(appSchema: Definition, v4Page: v4.SapUiAppPageV4, logger: ExtensionLogger, customActionDefinitionName?: DefinitionName, sectionId?: string): void;
 /**
  * Method returns page from manifest by passed page key.
+ *
  * @param manifest Object from manifest.json.
  * @param pageId Page id.
  * @param logger Logger to report error of unexisting page.
@@ -133,8 +147,9 @@ export declare function addHeaderFooterCustomActionDefinition(appSchema: Definit
 export declare function getManifestPage(manifest: Manifest, pageId: string, logger?: ExtensionLogger): v4.RoutingTargetOptions | undefined;
 /**
  * Method finds custom view/section XML file for passed page.
+ *
  * @param files All extension files.
- * @param pageId Page id.
+ * @param page - the page object containing routing target options
  * @param manifest Object from manifest.json.
  * @param xmlType XML file type - view or fragment.
  * @param extensionName Extension namespace or path to extension name in page object.
@@ -143,6 +158,7 @@ export declare function getManifestPage(manifest: Manifest, pageId: string, logg
 export declare function getPageCustomExtensionFile(files: FileData[], page: v4.RoutingTargetOptions, manifest: Manifest, xmlType: 'view' | 'fragment', extensionName: string): ExtensionFileData | undefined;
 /**
  * Method finds view XML file for passed page.
+ *
  * @param files All view files.
  * @param pageId Page id.
  * @param manifest Object from manifest.json.
@@ -151,7 +167,8 @@ export declare function getPageCustomExtensionFile(files: FileData[], page: v4.R
  */
 export declare function getPageCustomViewFile(files: FileData[], pageId: string, manifest: Manifest, logger?: ExtensionLogger): ExtensionFileData | undefined;
 /**
- * Adds custom section or custom sub section definitions to app schema
+ * Adds custom section or custom sub section definitions to app schema.
+ *
  * @param appSchema - app-specific JSON schema
  * @param definition - sections definition
  * @param v4Page - actual page in the manifest
@@ -163,6 +180,7 @@ export declare function getPageCustomViewFile(files: FileData[], pageId: string,
 export declare function addCustomSectionDefinition(appSchema: Definition, definition: Definition, v4Page: v4.SapUiAppPageV4, customSectionRef: string, isMergedSections: boolean, facetKey?: string, logger?: ExtensionLogger): void;
 /**
  * Method adds custom filter fields from manifest to schema properties.
+ *
  * @param appSchema - app-specific JSON schema
  * @param definition - filter fields definition
  * @param v4Page - actual page in the manifest

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

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../../src/sync/v4/utils/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,QAAQ,EAGX,MAAM,4CAA4C,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAkB3G,OAAO,KAAK,EAAE,UAAU,EAAuB,MAAM,wBAAwB,CAAC;AAC9E,OAAO,KAAK,EACR,eAAe,EACf,2BAA2B,EAC3B,QAAQ,EACR,QAAQ,EAEX,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACH,EAAE,EAMF,cAAc,EAIjB,MAAM,6BAA6B,CAAC;AAErC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD,MAAM,MAAM,eAAe,GACrB,EAAE,CAAC,iBAAiB,GACpB,EAAE,CAAC,YAAY,GACf,EAAE,CAAC,iCAAiC,GACpC,EAAE,CAAC,oCAAoC,CAAC;AAE9C,MAAM,WAAW,gBAAgB;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC;CAClC;AA2TD;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAC/B,UAAU,EAAE,gBAAgB,EAC5B,qBAAqB,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAC1C,uBAAuB,EAAE,MAAM,EAC/B,oBAAoB,SAAa,EACjC,MAAM,CAAC,EAAE,eAAe,EACxB,uBAAuB,UAAQ,GAChC,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CA4DrB;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,OAAO,GAAG,UAAU,EAAE,sBAAsB,EAAE,UAAU,QAQvG;AAgCD;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACrC,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,EAAE,CAAC,cAAc,EACzB,MAAM,EAAE,eAAe,EACvB,0BAA0B,GAAE,MAAoC,EAChE,SAAS,CAAC,EAAE,MAAM,EAClB,mBAAmB,CAAC,EAAE,MAAM,GAC7B,IAAI,CA0BN;AAkJD,MAAM,MAAM,qBAAqB,GAAG;IAChC,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,UAAU,CAAC;IACtB,kBAAkB,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC7C,UAAU,EAAE,UAAU,CAAC;IACvB,eAAe,EAAE,iBAAiB,CAAC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,uBAAuB,CACnC,IAAI,EAAE,qBAAqB,EAC3B,OAAO,EAAE,UAAU,EACnB,YAAY,EAAE,MAAM,EACpB,kBAAkB,CAAC,EAAE,UAAU,EAC/B,oBAAoB,GAAE,MAAmC,GAC1D,IAAI,CAsBN;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,wBAAwB,CACpC,IAAI,EAAE,qBAAqB,EAC3B,oBAAoB,GAAE,MAAmC,EACzD,0BAA0B,GAAE,MAAoC,EAChE,0BAA0B,GAAE,MAAyC,GACtE,IAAI,CAYN;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACpC,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,EAAE,CAAC,cAAc,EACzB,YAAY,GAAE,MAAgC,EAC9C,mBAAmB,CAAC,EAAE,MAAM,GAC7B,IAAI,CAuBN;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAClC,SAAS,EAAE,UAAU,EACrB,YAAY,EAAE,MAAM,EACpB,YAAY,GAAE,MAA4C,GAC3D,IAAI,CAYN;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACtB,KAAK,EAAE,EAAE,CAAC,cAAc,EAAE,EAC1B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,SAAS,EACpB,WAAW,EAAE,MAAM,GACpB,EAAE,CAAC,cAAc,GAAG,SAAS,CAe/B;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACvC,SAAS,EAAE,UAAU,EACrB,kBAAkB,EAAE,2BAA2B,GAChD,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,YAAY,CAwBpD;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACrC,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,EAAE,CAAC,cAAc,EACzB,MAAM,EAAE,eAAe,EACvB,0BAA0B,GAAE,MAAyC,EACrE,qBAAqB,SAAK,EAC1B,mBAAmB,SAAK,GACzB,IAAI,CA8CN;AAED;;;;;;;GAOG;AACH,wBAAgB,qCAAqC,CACjD,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,EAAE,CAAC,cAAc,EACzB,MAAM,EAAE,eAAe,EACvB,0BAA0B,GAAE,cAAoD,EAChF,SAAS,SAAK,GACf,IAAI,CA+BN;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC3B,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,eAAe,GACzB,EAAE,CAAC,oBAAoB,GAAG,SAAS,CA8BrC;AAED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACtC,KAAK,EAAE,QAAQ,EAAE,EACjB,IAAI,EAAE,EAAE,CAAC,oBAAoB,EAC7B,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,MAAM,GAAG,UAAU,EAC5B,aAAa,EAAE,MAAM,GACtB,iBAAiB,GAAG,SAAS,CA0B/B;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACjC,KAAK,EAAE,QAAQ,EAAE,EACjB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,QAAQ,EAClB,MAAM,CAAC,EAAE,eAAe,GACzB,iBAAiB,GAAG,SAAS,CAM/B;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CACtC,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,EAAE,CAAC,cAAc,EACzB,gBAAgB,EAAE,MAAM,EACxB,gBAAgB,EAAE,OAAO,EACzB,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,eAAe,GACzB,IAAI,CAiEN;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAC1C,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,EAAE,CAAC,cAAc,GAC1B,IAAI,CAkCN"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../../src/sync/v4/utils/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,QAAQ,EAGX,MAAM,4CAA4C,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAmB3G,OAAO,KAAK,EAAE,UAAU,EAAuB,MAAM,wBAAwB,CAAC;AAC9E,OAAO,KAAK,EACR,eAAe,EACf,2BAA2B,EAC3B,QAAQ,EACR,QAAQ,EAEX,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACH,EAAE,EAMF,cAAc,EAIjB,MAAM,6BAA6B,CAAC;AAErC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD,MAAM,MAAM,eAAe,GACrB,EAAE,CAAC,iBAAiB,GACpB,EAAE,CAAC,YAAY,GACf,EAAE,CAAC,iCAAiC,GACpC,EAAE,CAAC,oCAAoC,CAAC;AAE9C,MAAM,WAAW,gBAAgB;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC;CAClC;AAoVD;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAC/B,UAAU,EAAE,gBAAgB,EAC5B,qBAAqB,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAC1C,uBAAuB,EAAE,MAAM,EAC/B,oBAAoB,SAAa,EACjC,MAAM,CAAC,EAAE,eAAe,EACxB,uBAAuB,UAAQ,GAChC,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CA4DrB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,OAAO,GAAG,UAAU,EAAE,sBAAsB,EAAE,UAAU,QAQvG;AAgCD;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACrC,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,EAAE,CAAC,cAAc,EACzB,MAAM,EAAE,eAAe,EACvB,0BAA0B,GAAE,MAAoC,EAChE,SAAS,CAAC,EAAE,MAAM,EAClB,mBAAmB,CAAC,EAAE,MAAM,GAC7B,IAAI,CA0BN;AAoJD,MAAM,MAAM,qBAAqB,GAAG;IAChC,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,UAAU,CAAC;IACtB,kBAAkB,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC7C,UAAU,EAAE,UAAU,CAAC;IACvB,eAAe,EAAE,iBAAiB,CAAC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,uBAAuB,CACnC,IAAI,EAAE,qBAAqB,EAC3B,OAAO,EAAE,UAAU,EACnB,YAAY,EAAE,MAAM,EACpB,kBAAkB,CAAC,EAAE,UAAU,EAC/B,oBAAoB,GAAE,MAAmC,GAC1D,IAAI,CAsBN;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,wBAAwB,CACpC,IAAI,EAAE,qBAAqB,EAC3B,oBAAoB,GAAE,MAAmC,EACzD,0BAA0B,GAAE,MAAoC,EAChE,0BAA0B,GAAE,MAAyC,GACtE,IAAI,CAYN;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACpC,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,EAAE,CAAC,cAAc,EACzB,YAAY,GAAE,MAAgC,EAC9C,mBAAmB,CAAC,EAAE,MAAM,GAC7B,IAAI,CAuBN;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAClC,SAAS,EAAE,UAAU,EACrB,YAAY,EAAE,MAAM,EACpB,YAAY,GAAE,MAA4C,GAC3D,IAAI,CAYN;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CACtB,KAAK,EAAE,EAAE,CAAC,cAAc,EAAE,EAC1B,YAAY,EAAE,MAAM,EACpB,SAAS,CAAC,EAAE,SAAS,EACrB,WAAW,CAAC,EAAE,MAAM,GACrB,EAAE,CAAC,cAAc,GAAG,SAAS,CAkB/B;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACvC,SAAS,EAAE,UAAU,EACrB,kBAAkB,EAAE,2BAA2B,GAChD,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,YAAY,CAwBpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACrC,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,EAAE,CAAC,cAAc,EACzB,MAAM,EAAE,eAAe,EACvB,0BAA0B,GAAE,MAAyC,EACrE,qBAAqB,SAAK,EAC1B,mBAAmB,SAAK,GACzB,IAAI,CA8CN;AAED;;;;;;;;GAQG;AACH,wBAAgB,qCAAqC,CACjD,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,EAAE,CAAC,cAAc,EACzB,MAAM,EAAE,eAAe,EACvB,0BAA0B,GAAE,cAAoD,EAChF,SAAS,SAAK,GACf,IAAI,CA+BN;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC3B,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,eAAe,GACzB,EAAE,CAAC,oBAAoB,GAAG,SAAS,CA8BrC;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CACtC,KAAK,EAAE,QAAQ,EAAE,EACjB,IAAI,EAAE,EAAE,CAAC,oBAAoB,EAC7B,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,MAAM,GAAG,UAAU,EAC5B,aAAa,EAAE,MAAM,GACtB,iBAAiB,GAAG,SAAS,CA0B/B;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACjC,KAAK,EAAE,QAAQ,EAAE,EACjB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,QAAQ,EAClB,MAAM,CAAC,EAAE,eAAe,GACzB,iBAAiB,GAAG,SAAS,CAM/B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,0BAA0B,CACtC,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,EAAE,CAAC,cAAc,EACzB,gBAAgB,EAAE,MAAM,EACxB,gBAAgB,EAAE,OAAO,EACzB,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,eAAe,GACzB,IAAI,CAiEN;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC1C,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,EAAE,CAAC,cAAc,GAC1B,IAAI,CAkCN"}

package/dist/specification/src/sync/v4/utils/utils.js

@@ -26,11 +26,17 @@ const i18next_1 = __importDefault(require("i18next"));
 const __1 = require("../../..");
 const ux_specification_types_1 = require("@sap/ux-specification-types");
 const path_1 = require("path");
+/**
+ * Returns a comparator function to sort objects by their property index.
+ *
+ * @returns A comparator function that compares two objects based on their property index.
+ */
 function sortByPropertyIndex() {
     return ([_key1, value1], [_key2, value2]) => value1[ux_specification_types_1.SchemaTag.propertyIndex] - value2[ux_specification_types_1.SchemaTag.propertyIndex];
 }
 /**
  * Sort function for properties in schema definitions.
+ *
  * @param definition - definition which contains list of properties, unsorted
  * @returns - list of properties, sorted by property index
  */
@@ -44,6 +50,7 @@ function sortPropertiesRecords(definition) {
 }
 /**
  * Method receives extension object and returns title/text.
+ *
  * @param extension - custom extension object from manifest.
  * @returns Title/text of custom extension.
  */
@@ -69,12 +76,15 @@ function getExtensionText(extension) {
     return text;
 }
 /**
- * Adds a custom extension to the right position of a sorted array
+ * Adds a custom extension to the right position of a sorted array.
+ *
  * @param extension - custom extension
  * @param sortedExtensionsArray - array of all entries(annotation entries and extensions), to be enhanced
  * @param targetIndex - index of the anchor entry
  * @param extId - ID of the new custom extension
  * @param newExtensionReference - schema reference of the new extension
+ * @param newExtensionReference.$ref - The reference to the schema definition for the new extension.
+ * @param newExtensionReference.description - A description of the new extension.
  */
 function addExtensionToSortedArray(extension, sortedExtensionsArray, targetIndex, extId, newExtensionReference) {
     const placement = extension.position?.placement || ux_specification_types_1.v4.Placement.After;
@@ -86,12 +96,16 @@ function addExtensionToSortedArray(extension, sortedExtensionsArray, targetIndex
     }
 }
 /**
- * Adds remaining custom extensions that might self-reference and were not added in previous steps
+ * Adds remaining custom extensions that might self-reference and were not added in previous steps.
+ *
  * @param {CustomExtensions} remainingExtensions - list of custom extensions that are left for post-processing
  * @param {string} extId - current id of remaining extensions
  * @param {CustomExtension} extension - current extension of remaining custom extensions
  * @param {[string, unknown]} sortedExtArray - sorted array of annotation-based extensions, to be updated
- * @param { $ref, description, key } newCustomExt - description based on extension in manifest
+ * @param newCustomExt - description based on extension in manifest
+ * @param newCustomExt.$ref - The reference to the schema definition for the new extension.
+ * @param newCustomExt.description - A description of the new custom extension.
+ * @param newCustomExt.keys - An array of key objects, each containing a name and value for the custom extension.
  */
 function addRemainingTargetByBefore(remainingExtensions, extId, extension, sortedExtArray, newCustomExt) {
     const targetRemainingIndex = Object.entries(remainingExtensions)
@@ -103,11 +117,13 @@ function addRemainingTargetByBefore(remainingExtensions, extId, extension, sorte
     }
 }
 /**
- * Returns custom extension details like $ref, description, keys and action type
+ * Returns custom extension details like $ref, description, keys and action type.
+ *
  * @param extension - custom extensions config
  * @param extensionDefinitionName - custom extension definition name, different in LR and OP
  * @param extId - custom extension id
  * @param actionType - action type
+ * @returns Custom extension details
  */
 function getExtensionDetails(extension, extensionDefinitionName, extId, actionType) {
     const refDefinition = extensionDefinitionName.includes(ux_specification_types_1.DefinitionName.ObjectPageCustomSectionFragment)
@@ -122,7 +138,8 @@ function getExtensionDetails(extension, extensionDefinitionName, extId, actionTy
     };
 }
 /**
- * Post-processing of custom extensions that are left after the first loop of adding extensions, i.e. custom extensions referring to other custom extensions
+ * Post-processing of custom extensions that are left after the first loop of adding extensions, i.e. custom extensions referring to other custom extensions.
+ *
  * @param remainingExtensions - list of custom extensions that are left for post-processing
  * @param extensionDefinitionName - custom extension definition name, different in LR and OP
  * @param sortedExtArray - sorted array of annotation-based extensions, to be updated
@@ -175,8 +192,10 @@ function adjustCustomExtReferringToCustomExt(remainingExtensions, extensionDefin
  * Returns anchor for extension. Priority:
  * 1. 'anchor' property in extension;
  * 2. When 'anchor' is not defined in extension and does calculation based placement and current list of extension and annotation entries.
+ *
  * @param extension - extension in manifest
  * @param sortedExtensionsArray - sorted array of annotation-based nodes, to be enhanced by extensions
+ * @returns Anchor for extension
  */
 function getExtensionAnchor(extension, sortedExtensionsArray) {
     // Default placement is After
@@ -191,9 +210,11 @@ function getExtensionAnchor(extension, sortedExtensionsArray) {
     return anchor;
 }
 /**
- * Preprocesses and returns list of local extension ids that needs to be skipped from addition
+ * Preprocesses and returns list of local extension ids that needs to be skipped from addition.
+ *
  * @param {CustomExtensions} localExtensions - list of extensions in manifest
  * @param {[string, unknown][]} annotationEntries - sorted array of annotation-based nodes, to be enhanced by extensions
+ * @returns List of local extensions that has no annotation based anchor
  */
 function getLocalExtensionsToSkip(localExtensions, annotationEntries) {
     // collect local extensions that has no annotation based anchor
@@ -210,10 +231,10 @@ function getLocalExtensionsToSkip(localExtensions, annotationEntries) {
 /**
  * Method returns position of passed extension using calculation for merged annotation nodes approach.
  * Currently is used for custom subsections - annotation merges subsection if there is no any child collecation facet.
+ *
  * @param extension - custom extension
  * @param extensions - list of extensions in manifest
  * @param sortedExtensionsArray - array of all entries(annotation entries and extensions), to be enhanced
- *
  * @returns Index of extension using merged annotation nodes approach.
  */
 function getExtensionIndexByMergedApproach(extension, extensions, sortedExtensionsArray) {
@@ -258,7 +279,6 @@ function getExtensionIndexByMergedApproach(extension, extensions, sortedExtensio
  * @param sortedExtensionsArray - array of all entries(annotation entries and extensions), to be enhanced
  * @param anchor - target anchor to check
  * @param ignoreAnnotationAnchors - calculation should ignore anchors referenced to annotation nodes. Used when annotations sections are merged
- *
  * @returns Index of extension using merged annotation nodes approach.
  */
 function getExtensionIndex(extension, extensions, sortedExtensionsArray, anchor, ignoreAnnotationAnchors = false) {
@@ -267,11 +287,16 @@ function getExtensionIndex(extension, extensions, sortedExtensionsArray, anchor,
         : getExtensionIndexByMergedApproach(extension, extensions, sortedExtensionsArray);
 }
 /**
- * Error handler for invalid extensions
+ * Error handler for invalid extensions.
+ *
  * @param logger - logger for error messages
  * @param extensionId - ID of the extension
  * @param sortedExtensionsArray - sorted array of annotation-based nodes, to be enhanced by extensions
  * @param newExtensionReference - schema reference that had been prepared before
+ * @param newExtensionReference.$ref - The reference to the schema definition for the new extension.
+ * @param newExtensionReference.description - A description of the new extension.
+ * @param newExtensionReference.keys - An array of key objects, each containing a name and value for the custom extension.
+ * @param newExtensionReference.actionType - The action type associated with the new extension.
  * @param localExtensions - list of extensions for processing
  */
 function handleInvalidExtension(logger, extensionId, sortedExtensionsArray, newExtensionReference, localExtensions) {
@@ -286,12 +311,15 @@ function handleInvalidExtension(logger, extensionId, sortedExtensionsArray, newE
     delete localExtensions[extensionId];
 }
 /**
- * Adds extension at the right position of the sorted array of annotation-based nodes
+ * Adds extension at the right position of the sorted array of annotation-based nodes.
+ *
  * @param extensions - list of extensions in manifest
  * @param sortedExtensionsArray - sorted array of annotation-based nodes, to be enhanced by extensions
  * @param extensionDefinitionName - extension definition name, different in LR and OP
+ * @param templatePropertyName - The name of the property in the template to be used for processing.
  * @param logger - logger for error messages
  * @param ignoreAnnotationAnchors - calculation should ignore anchors referenced to annotation nodes. Used when annotations sections are merged.
+ * @returns Sorted array of annotation-based nodes, enhanced by extensions
  */
 function addExtensionToArray(extensions, sortedExtensionsArray, extensionDefinitionName, templatePropertyName = 'template', logger, ignoreAnnotationAnchors = false) {
     const annotationEntries = [...sortedExtensionsArray];
@@ -336,7 +364,8 @@ function addExtensionToArray(extensions, sortedExtensionsArray, extensionDefinit
     return sortedExtensionsArray;
 }
 /**
- * Adds enum values to the properties definition of a custom column
+ * Adds enum values to the properties definition of a custom column.
+ *
  * @param lineItems - current lineItems definition, with all records
  * @param customColumnDefinition - current custom column definition, in the app schema
  */
@@ -350,12 +379,12 @@ function addEnumForProperties(lineItems, customColumnDefinition) {
     customColumnDefinition.properties.properties.items['enum'] = columnEnum;
 }
 /**
- * Adds the propertyIndex to each column and adds the enum values for properties of custom columns
+ * Adds the propertyIndex to each column and adds the enum values for properties of custom columns.
+ *
  * @param sortedColumnsArray - sorted array of all columns
  * @param {Definition} appSchema - app specific JSON schema
  * @param lineItems - content of the line item annotation
  * @param {DefinitionName} customColumnDefinitionName - custom column definition name, distinguishes LR from OP
- *
  */
 function addColumnPropertyIndexAndEnum(sortedColumnsArray, appSchema, lineItems, customColumnDefinitionName = ux_specification_types_1.DefinitionName.CustomColumn) {
     if (customColumnDefinitionName === ux_specification_types_1.DefinitionName.CustomColumn ||
@@ -371,7 +400,8 @@ function addColumnPropertyIndexAndEnum(sortedColumnsArray, appSchema, lineItems,
     }
 }
 /**
- * Common function for enhancing the LineItems definition of app schema by custom columns
+ * Common function for enhancing the LineItems definition of app schema by custom columns.
+ *
  * @param appSchema - app-specific JSON schema
  * @param v4Page - actual page in the manifest
  * @param logger - logger for error messages
@@ -399,9 +429,9 @@ function addCustomColumnDefinition(appSchema, v4Page, logger, customColumnDefini
     appSchema.definitions[lineItemId].properties = sortedColumnsAsObject;
 }
 /**
- * Determines the name of the action in schema
- * @param {LineItemDataForSchema} data - data of the the LineItem
+ * Determines the name of the action in schema.
  *
+ * @param {LineItemDataForSchema} data - data of the the LineItem
  * @returns the name of the action
  */
 function determineActionDefinitionName(data) {
@@ -418,7 +448,8 @@ function determineActionDefinitionName(data) {
     return actionDefinitionName;
 }
 /**
- * Adds the schema tags 'keys' and 'target' to the schema definition of an action
+ * Adds the schema tags 'keys' and 'target' to the schema definition of an action.
+ *
  * @param {SchemaDefinition} actionDefinition - current action definition in the app schema
  * @param {DataFieldForActionAbstractTypes} lineItemRecord - actual record of the line item collection
  * @param {string} actionId - ID of the action, according to the lineItem definition
@@ -438,13 +469,14 @@ function addTargetAndKeysOfAction(actionDefinition, lineItemRecord, actionId) {
     }
 }
 /**
- * Processes a LineItem record of type DataFieldForAction during app schema generation
- * @param {LineItemDataForSchema} data: structure of input data
- * @param {Definition} actions - actions definition in schema, parent object
- * @param {string} lineItemPath - annotation path to the line item
- * @param {DataFieldForActionAbstractTypes} lineItemRecord - actual record of the line item collection
- * @param {number} recordIndex - record index in the collection
- * @param {boolean} createRef - defines whether the $ref attribute should be created for the action
+ * Processes a LineItem record of type DataFieldForAction during app schema generation.
+ *
+ * @param data - structure of input data
+ * @param actionsDefinition - actions definition in schema, parent object
+ * @param lineItemPath - annotation path to the line item
+ * @param lineItemRecord - actual record of the line item collection
+ * @param recordIndex - record index in the collection
+ * @param createRef - defines whether the $ref attribute should be created for the action
  */
 function addActionRecordToSchema(data, actionsDefinition, lineItemPath, lineItemRecord, recordIndex, createRef = true) {
     // Action but not inline action
@@ -482,13 +514,13 @@ function addActionRecordToSchema(data, actionsDefinition, lineItemPath, lineItem
     }
 }
 /**
- * Processes a LineItem record of type DataField during app schema generation
- * @param {LineItemDataForSchema} data: structure of input data
- * @param {object} lineItem - object comprising the line item information:
- * { lineItemRecord, lineItemId, lineItemPath }
- * @param {string} columnDefinitionName - Schema definition name for the column
- * @param {number} recordIndex - record index in the collection
- * @param {Definition | undefined} lineItemDefinition - line item definition
+ * Processes a LineItem record of type DataField during app schema generation.
+ *
+ * @param data structure of input data
+ * @param lineItem - object comprising the line item information:
+ * @param columnDefinitionName - Schema definition name for the column
+ * @param recordIndex - record index in the collection
+ * @param lineItemDefinition - line item definition
  */
 function addLineItemRecordToSchema(data, lineItem, columnDefinitionName, recordIndex, lineItemDefinition) {
     const lineItemId = lineItem['lineItemId'];
@@ -524,8 +556,9 @@ function addLineItemRecordToSchema(data, lineItem, columnDefinitionName, recordI
     }
 }
 /**
- * Appends line item columns and actions to the app schema (for the list report, custom page or an object page section comprising a table)
- * @param {LineItemDataForSchema} data: structure comprising
+ * Appends line item columns and actions to the app schema (for the list report, custom page or an object page section comprising a table).
+ *
+ * @param {LineItemDataForSchema} data structure comprising
  * - appSchema - the app specific schema that shall get enhanced
  * - lineItemAnnotation - the UI.LineItem annotation, comprising all records
  * - entityType - the entity type as part of the AVT ConvertedMetadata
@@ -559,8 +592,9 @@ function appendLineItemsToSchema(data, actions, lineItemPath, lineItemDefinition
     });
 }
 /**
- * Adds the line item definition, columns and actions to the app schema (for the list report, custom page or an object page section comprising a table
- * @param {LineItemDataForSchema} data: structure comprising
+ * Adds the line item definition, columns and actions to the app schema (for the list report, custom page or an object page section comprising a table.
+ *
+ * @param data structure comprising
  * - isObjectPage - indicates that the page is an object page
  * - appSchema - the app specific schema that shall get enhanced
  * - lineItemAnnotation - the UI.LineItem annotation, comprising all records
@@ -568,16 +602,17 @@ function appendLineItemsToSchema(data, actions, lineItemPath, lineItemDefinition
  * - oDataServiceAVT - complete service information, as returned by Annotation Vocabularies Tool
  * - lineItemId - in case of OP the parameter must be passed to distinguish the OP tables;
  *                in case of LR or ALP 'LineItems' is passed.
- * @param {string} columnDefinitionName - name of the column definition, i.e. TableColumn or ObjectPageTableColumn
- * @param {string} customColumnDefinitionName - name of the custom column definition
- * @param {string} customColumnDefinitionName - name of the custom action definition
+ * @param columnDefinitionName - name of the column definition, i.e. TableColumn or ObjectPageTableColumn
+ * @param customColumnDefinitionName - name of the custom column definition
+ * @param customActionDefinitionName - name of the custom action definition
  */
 function addLineItemsTypeToSchema(data, columnDefinitionName = ux_specification_types_1.DefinitionName.TableColumn, customColumnDefinitionName = ux_specification_types_1.DefinitionName.CustomColumn, customActionDefinitionName = ux_specification_types_1.DefinitionName.CustomTableAction) {
     const { actions, lineItemPath } = (0, common_1.addCommonLineItemDefinitions)(data.isObjectPage, data.appSchema, data.lineItemAnnotation, data.entityType, data.lineItemId, customColumnDefinitionName, customActionDefinitionName);
     appendLineItemsToSchema(data, actions, lineItemPath, undefined, columnDefinitionName);
 }
 /**
- * Adds an enum or value help to position > anchor of custom column
+ * Adds an enum or value help to position > anchor of custom column.
+ *
  * @param appSchema - app specific JSON schema
  * @param lineItemId - ID of the current line item in schema
  * @param v4Page - current page in manifest
@@ -609,7 +644,8 @@ function addFragmentEnumForAnchor(appSchema, lineItemId, v4Page, positionName =
     }
 }
 /**
- * Adds an enum or value help to position > anchor of custom column or custom action
+ * Adds an enum or value help to position > anchor of custom column or custom action.
+ *
  * @param appSchema - app specific JSON schema
  * @param definitionId - definition key of actions
  * @param positionName - target definition to update
@@ -623,20 +659,23 @@ function addEnumForActionAnchor(appSchema, definitionId, positionName = ux_speci
     });
 }
 /**
- * Find the relevant V4 page under the routing targets of manifest,json
+ * Find the relevant V4 page under the routing targets of manifest,json.
+ *
  * @param pages - list of all pages in manifest
- * @param pageName - search criterion: page name
+ * @param templateName - search criterion: template name
  * @param entitySet - search criterion: entity set object from AVT
  * @param contextPath - search criterion: contextPath
  * @returns the page definition in manifest (if found)
  */
-function findPageV4(pages, pageName, entitySet, contextPath) {
+function findPageV4(pages, templateName, entitySet, contextPath) {
     let v4Page;
     for (const i in pages) {
-        if (((contextPath && pages[i].options?.settings?.contextPath === contextPath) ||
-            pages[i].options?.settings?.entitySet === entitySet?.name) &&
-            (pages[i].name === pageName ||
-                (pageName === ux_specification_types_1.v4.FE_TEMPLATE_V4_ALP && pages[i].name === ux_specification_types_1.v4.FE_TEMPLATE_V4_LIST_REPORT))) {
+        const pageSettings = pages[i].options?.settings || {};
+        const isConnectionMatches = (contextPath && pageSettings.contextPath === contextPath) ||
+            (entitySet?.name && pageSettings.entitySet === entitySet.name);
+        if (isConnectionMatches &&
+            ((0, common_1.compareTemplateNames)(templateName, pages[i].name) ||
+                (templateName === ux_specification_types_1.v4.FE_TEMPLATE_V4_ALP && pages[i].name === ux_specification_types_1.v4.FE_TEMPLATE_V4_LIST_REPORT))) {
             v4Page = pages[i];
             break;
         }
@@ -644,7 +683,8 @@ function findPageV4(pages, pageName, entitySet, contextPath) {
     return v4Page;
 }
 /**
- * Depending on the template type, strip down the app schema so that only the relevant views are part of it
+ * Depending on the template type, strip down the app schema so that only the relevant views are part of it.
+ *
  * @param {Definition} appSchema - app specific JSON schema, to be adjusted
  * @param {GenerateAppSchemaParameters} generateParameters - object comprising all input parameters
  * @returns the right definition name for the table in the schema
@@ -672,7 +712,8 @@ function alignSchemaWithTemplateType(appSchema, generateParameters) {
     return tableDefinitionName;
 }
 /**
- * Common function for enhancing LineItems, FieldGroups and Custom Section definitions of app schema by custom action definitions
+ * Common function for enhancing LineItems, FieldGroups and Custom Section definitions of app schema by custom action definitions.
+ *
  * @param appSchema - app-specific JSON schema
  * @param v4Page - actual page in the manifest
  * @param logger - logger for error messages
@@ -725,7 +766,8 @@ function addCustomActionDefinition(appSchema, v4Page, logger, customActionDefini
     }
 }
 /**
- * Common function for enhancing header and footer definitions of app schema by custom action definitions
+ * Common function for enhancing header and footer definitions of app schema by custom action definitions.
+ *
  * @param appSchema - app-specific JSON schema
  * @param v4Page - actual page in the manifest
  * @param logger - logger for error messages
@@ -761,6 +803,7 @@ function addHeaderFooterCustomActionDefinition(appSchema, v4Page, logger, custom
 }
 /**
  * Method returns page from manifest by passed page key.
+ *
  * @param manifest Object from manifest.json.
  * @param pageId Page id.
  * @param logger Logger to report error of unexisting page.
@@ -799,8 +842,9 @@ function getManifestPage(manifest, pageId, logger) {
 }
 /**
  * Method finds custom view/section XML file for passed page.
+ *
  * @param files All extension files.
- * @param pageId Page id.
+ * @param page - the page object containing routing target options
  * @param manifest Object from manifest.json.
  * @param xmlType XML file type - view or fragment.
  * @param extensionName Extension namespace or path to extension name in page object.
@@ -835,6 +879,7 @@ function getPageCustomExtensionFile(files, page, manifest, xmlType, extensionNam
 }
 /**
  * Method finds view XML file for passed page.
+ *
  * @param files All view files.
  * @param pageId Page id.
  * @param manifest Object from manifest.json.
@@ -849,7 +894,8 @@ function getPageCustomViewFile(files, pageId, manifest, logger) {
         : undefined;
 }
 /**
- * Adds custom section or custom sub section definitions to app schema
+ * Adds custom section or custom sub section definitions to app schema.
+ *
  * @param appSchema - app-specific JSON schema
  * @param definition - sections definition
  * @param v4Page - actual page in the manifest
@@ -907,6 +953,7 @@ function addCustomSectionDefinition(appSchema, definition, v4Page, customSection
 }
 /**
  * Method adds custom filter fields from manifest to schema properties.
+ *
  * @param appSchema - app-specific JSON schema
  * @param definition - filter fields definition
  * @param v4Page - actual page in the manifest