@sap/ux-specification 1.120.35 → 1.120.37

package/dist/specification/src/sync/v2/generate/utils.d.ts

@@ -7,13 +7,16 @@ import type * as Edm from '@sap-ux/vocabularies-types/Edm';
 import type { EntityTypeAnnotations_UI } from '@sap-ux/vocabularies-types/vocabularies/UI_Edm';
 import { ActionTypeV2 } from '../types';
 import type { FacetBase } from '../../../../../types/src/common/types';
-import type { ExtensionLogger } from '../../..';
 /**
- * Processes a LineItem record of type DataFieldForAction and DataFieldForIntentBasedNavigation during app schema generation
+ * Processes a LineItem record of type DataFieldForAction and DataFieldForIntentBasedNavigation during app schema generation.
+ *
  * @param appSchema - the app specific schema that shall get enhanced
- * @param entityType - the entity type as part of the AVT ConvertedMetadata
  * @param actions - actions definition in schema, parent object
- * @param lineItemProperties - properties of the line item collection: lineItemPath, lineItemRecord, lineItemId
+ * @param lineItemProps - properties of the line item collection: lineItemPath, lineItemRecord, lineItemId
+ * @param lineItemProps.lineItemPath - The path to the line item in the schema.
+ * @param lineItemProps.lineItemRecord - The record of the line item in the collection.
+ * @param lineItemProps.lineItemId - The identifier of the line item.
+ * @param lineItemProps.entityType - the entity type as part of the AVT ConvertedMetadata
  * @param actionType - type of action
  * @param recordIndex - record index in the collection
  */
@@ -31,7 +34,8 @@ export declare function handleActionRecord(appSchema: Definition, actions: Defin
  */
 export declare function retrieveNameWithoutVocabularyFromVisualization(annotationTerm: FacetBase, visualization: Edm.AnnotationPath<Chart | DataPoint | LineItem>): string;
 /**
- * Adds the line item records to the app schema (for the list report or an object page section comprising a table)
+ * Adds the line item records to the app schema (for the list report or an object page section comprising a table).
+ *
  * @param isObjectPage - indicates that the page is an object page
  * @param appSchema - the app specific schema that shall get enhanced
  * @param lineItemAnnotation - the UI.LineItem annotation, comprising all records
@@ -43,6 +47,7 @@ export declare function retrieveNameWithoutVocabularyFromVisualization(annotatio
 export declare function addLineItemsType(isObjectPage: boolean, appSchema: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, lineItemId?: string, customColumnRef?: string): void;
 /**
  * Adds enum entries of possible leading properties for 'leadingProperty' property in TableCustomColumn properties.
+ *
  * @param appSchema - the app specific schema that shall get enhanced
  * @param entityType - the entity type as part of the AVT ConvertedMetadata
  * @param definitionName - definition name of CustomColumn definition
@@ -50,14 +55,16 @@ export declare function addLineItemsType(isObjectPage: boolean, appSchema: Defin
 export declare function addListReportLeadingProperties(appSchema: Definition, entityType: EntityType, definitionName: string): void;
 /**
  * Adds enum entries of posible tabKey properties for 'leadingProperty' property in TableCustomColumn properties.
+ *
  * @param appSchema - the app specific schema that shall get enhanced
  * @param definitionName - definition name of CustomColumn definition
  * @param page - sapui5 page object
- * @param {string} facet ID -  The facet ID
+ * @param facetID -  The facet ID
  */
 export declare function addTabkeyEnum(appSchema: Definition, definitionName: string, page?: v2.SapUiAppPageV2, facetID?: string): void;
 /**
  * Adds enum entries of posible fragment entries.
+ *
  * @param {object} appSchema The app specific schema that shall get enhanced.
  * @param {FileData[]} fragments Array of fragments.
  * @param {string[]} appId Application id.
@@ -67,20 +74,23 @@ export declare function addTabkeyEnum(appSchema: Definition, definitionName: str
 export declare function addFragmentEnum(appSchema: Definition, fragments: FileData[], appId: string, property: string, definitionName: string): void;
 /**
  * Adds the custom columns to the line item records of the app schema (for the list report comprising a table).
- * @param {object} appSchema The app specific schema that shall get enhanced.
- * @param {EntityType} entityType The entity type as part of the AVT ConvertedMetadata.
- * @param {SapUiAppPageV2} page Sapui5 page object.
- * @param {object} manifest Application manifest.
- * @param {FileData[]} [fragments] Array of fragments.
- * @param {string} [customColumnsDefinitionName=DefinitionName.CustomColumns] Definition name of Custom Columns definition.
- * @param {string} [customColumnDefinitionName=DefinitionName.CustomColumn] Definition name of Custom Column definition.
- * @param {string} facetID -  Facet ID
+ *
+ * @param appSchema The app specific schema that shall get enhanced.
+ * @param entityType The entity type as part of the AVT ConvertedMetadata.
+ * @param page Sapui5 page object.
+ * @param manifest Application manifest.
+ * @param [fragments] Array of fragments.
+ * @param [customColumnsDefinitionName] Definition name of Custom Columns definition.
+ * @param [customColumnDefinitionName] Definition name of Custom Column definition.
+ * @param facetID -  Facet ID
  */
 export declare function addTableColumnExtensions(appSchema: object, entityType: EntityType, page: v2.SapUiAppPageV2, manifest: object, fragments?: FileData[], customColumnsDefinitionName?: string, customColumnDefinitionName?: string, facetID?: string): void;
 /**
- * Apply post-processing rules as specified in form of "generate" at the syncRule
+ * Apply post-processing rules as specified in form of "generate" at the syncRule.
+ *
  * @param schema - given app schema, to be adapted
  * @param schemaDefinition - the current entry point or definition in the app schema
+ * @param metaDataDefinition - the current entry point or definition in the metadata
  * @param pageType - page type
  * @param factory - factory for creating metadata instances
  * @param processedRefs - array of already processed refs which used to avoid cycling recursion
@@ -91,57 +101,71 @@ export declare function processMetadata(schema: object, schemaDefinition: object
 }, pageType: PageTypeV2 | PageTypeV4, factory: MetadataInstanceInterface, processedRefs: string[], ref?: string): void;
 /**
  * Method updates passed 'enum' array by removing passed matching entries.
+ *
  * @param {Array<unknown>} values Array of values.
  * @param {Array<unknown>} valuesToRemove Array of values to remove.
  */
 export declare function removeElementsFromEnum(values: Array<unknown>, valuesToRemove: Array<unknown>): void;
 /**
- * Adds the selection fields to the app schema, as properties of the Filterbar
- * @param entityType - the entity type as part of the AVT ConvertedMetadata
+ * Adds the selection fields to the app schema, as properties of the Filterbar.
+ *
  * @param appSchema - the app specific schema that shall get enhanced
  * @param selectionFieldsAnnotation - the UI.SelectionField annotation
+ * @param entityType - the entity type as part of the AVT ConvertedMetadata
  */
 export declare function addSelectionFields(appSchema: Definition, selectionFieldsAnnotation: AnnotationTerm<SelectionFields>, entityType: EntityType): void;
 /**
- * Add entityProperties to passed a passed enum entry
+ * Add entityProperties to passed a passed enum entry.
+ *
  * @param {string[]} appSchemaEnum - Enum to be enhanced
  * @param {EntityType} entityType - Given entity type for which entries shall get generated
  */
 export declare function addEntityPropertiesToEnum(appSchemaEnum: string[], entityType: EntityType): void;
 /**
- * Checks if an entity supports draft capabilities
+ * Checks if an entity supports draft capabilities.
+ *
  * @param {EntitySet} entitySet Entity Set
  * @returns true if the entity supports draft
  */
 export declare function isDraftEnabled(entitySet: EntitySet): boolean;
 /**
  * Function to determine if the entity is deletable.
+ *
  * @param {EntitySet} entitySet - current entity set
  * returns {boolean} return true if the Entity is deletable
  */
+/**
+ * Checks if an entity supports draft capabilities.
+ *
+ * @param entitySet - The entity set to check for draft capabilities.
+ * @returns {boolean} True if the entity supports draft capabilities, otherwise false.
+ */
 export declare function isEntityDeletable(entitySet: EntitySet): boolean;
 /**
  * Function to determine if the entity is updatable.
+ *
  * @param {EntitySet} entitySet - current entity set
  * @returns returns true if the Entity is updatable
  */
 export declare function isEntityUpdatable(entitySet: EntitySet): boolean;
 /**
- * Adds standard header actions to schema (LR, ALP or OP)
+ * Adds standard header actions to schema (LR, ALP or OP).
+ *
  * @param {Definition} appSchema - app-specific JSON schema
  * @param {boolean} isOP - flag to add to either LR/ALP or OP definition
  * @param {Definition} actions - optional standard actions definition
  */
 export declare function addStandardHeaderActions(appSchema: Definition, isOP?: boolean, actions?: Definition): void;
 /**
- * Adds standard footer actions to schema of Object Page
+ * Adds standard footer actions to schema of Object Page.
+ *
  * @param {Definition} appSchema - app-specific JSON schema
- * @param {EntityType} entityType Entity Type of the page
  * @param {Definition} actions - optional standard actions definition
  */
 export declare function addStandardFooterActionsOP(appSchema: Definition, actions: Definition): void;
 /**
- * Extract entity type and ui annotations for a entity set and log an error in case that either of these objects does not exist
+ * Extract entity type and ui annotations for a entity set and log an error in case that either of these objects does not exist.
+ *
  * @param {GenerateAppSchemaParameters} generateParameters list of API input parameters
  * @returns the entity type and the ui annotations for the given entity set
  */
@@ -149,17 +173,4 @@ export declare function getUIAnnotationForEntitySet(generateParameters: Generate
     entityType?: Edm.EntityType;
     uIAnnotations?: EntityTypeAnnotations_UI;
 };
-/**
- * Type check for properties coming from the manifest.
- *
- * @param parent - the parent object in manifest which may contain the property.
- * @param propertyName - name of the property name to be checked
- * @param logger - a logger which may receive the error message in case a type error is detected
- * @param expectedType - the expected type of the value of the property (if it is not undefined)
- * @param mandatory - specifies handling handling of null and undefined: If parent is null this is always considered an error.
- * undefined value for parent or its specified property is considered an error when parameter mandatory is true.
- * null value for the specified property is considered an error when mandatory is true or the expected type is not 'object'.
- * @returns the information whether a type error was detected.
- */
-export declare function hasPropertyTypeError(parent: unknown, propertyName: string, logger?: ExtensionLogger, expectedType?: string, mandatory?: boolean): boolean;
 //# sourceMappingURL=utils.d.ts.map

package/dist/specification/src/sync/v2/generate/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../../src/sync/v2/generate/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,KAAK,EACR,EAAE,EACF,UAAU,EACV,UAAU,EACV,QAAQ,EAER,2BAA2B,EAC9B,MAAM,6BAA6B,CAAC;AAUrC,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxF,OAAO,KAAK,EACR,KAAK,EACL,SAAS,EAET,QAAQ,EACR,eAAe,EAClB,MAAM,4CAA4C,CAAC;AACpD,OAAO,KAAK,KAAK,GAAG,MAAM,gCAAgC,CAAC;AAC3D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gDAAgD,CAAC;AAoB/F,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAkEhD;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAC9B,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,UAAU,EACnB,aAAa,EAAE;IAAE,YAAY,MAAC;IAAC,cAAc,MAAC;IAAC,UAAU,MAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,EACnF,UAAU,EAAE,YAAY,EACxB,WAAW,EAAE,MAAM,GACpB,IAAI,CAiDN;AA8HD;;;;;GAKG;AACH,wBAAgB,8CAA8C,CAC1D,cAAc,EAAE,SAAS,EACzB,aAAa,EAAE,GAAG,CAAC,cAAc,CAAC,KAAK,GAAG,SAAS,GAAG,QAAQ,CAAC,GAChE,MAAM,CAMR;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC5B,YAAY,EAAE,OAAO,EACrB,SAAS,EAAE,UAAU,EACrB,kBAAkB,EAAE,cAAc,CAAC,QAAQ,CAAC,EAC5C,UAAU,EAAE,UAAU,EACtB,UAAU,CAAC,EAAE,MAAM,EACnB,eAAe,CAAC,EAAE,MAAM,GACzB,IAAI,CAwCN;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAC1C,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,MAAM,GACvB,IAAI,CAmBN;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CACzB,SAAS,EAAE,UAAU,EACrB,cAAc,EAAE,MAAM,EACtB,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EACxB,OAAO,CAAC,EAAE,MAAM,GACjB,IAAI,CAqBN;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC3B,SAAS,EAAE,UAAU,EACrB,SAAS,EAAE,QAAQ,EAAE,EACrB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,GACvB,IAAI,CA+BN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CACpC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,EAAE,CAAC,cAAc,EACvB,QAAQ,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,QAAQ,EAAE,EACtB,2BAA2B,GAAE,MAAqC,EAClE,0BAA0B,GAAE,MAAoC,EAChE,OAAO,CAAC,EAAE,MAAM,GACjB,IAAI,CAcN;AA8LD;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC3B,MAAM,EAAE,MAAM,EACd,gBAAgB,EAAE,MAAM,EACxB,kBAAkB,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,EAC1C,QAAQ,EAAE,UAAU,GAAG,UAAU,EACjC,OAAO,EAAE,yBAAyB,EAClC,aAAa,EAAE,MAAM,EAAE,EACvB,GAAG,CAAC,EAAE,MAAM,GACb,IAAI,CA0BN;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAQnG;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAC9B,SAAS,EAAE,UAAU,EACrB,yBAAyB,EAAE,cAAc,CAAC,eAAe,CAAC,EAC1D,UAAU,EAAE,UAAU,GACvB,IAAI,CAgDN;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,aAAa,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI,CAI/F;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAE5D;AAED;;;;GAIG;AAEH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAE/D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAE/D;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,UAAQ,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAmBxG;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI,CAS3F;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,kBAAkB,EAAE,2BAA2B,GAAG;IAC1F,UAAU,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC;IAC5B,aAAa,CAAC,EAAE,wBAAwB,CAAC;CAC5C,CAaA;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAChC,MAAM,EAAE,OAAO,EACf,YAAY,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,eAAe,EACxB,YAAY,GAAE,MAAiB,EAC/B,SAAS,GAAE,OAAe,GAC3B,OAAO,CAqBT"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../../src/sync/v2/generate/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,KAAK,EACR,EAAE,EACF,UAAU,EACV,UAAU,EACV,QAAQ,EAER,2BAA2B,EAC9B,MAAM,6BAA6B,CAAC;AAUrC,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxF,OAAO,KAAK,EACR,KAAK,EACL,SAAS,EAET,QAAQ,EACR,eAAe,EAClB,MAAM,4CAA4C,CAAC;AACpD,OAAO,KAAK,KAAK,GAAG,MAAM,gCAAgC,CAAC;AAC3D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gDAAgD,CAAC;AAoB/F,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AAwEvE;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAC9B,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,UAAU,EACnB,aAAa,EAAE;IAAE,YAAY,MAAC;IAAC,cAAc,MAAC;IAAC,UAAU,MAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,EACnF,UAAU,EAAE,YAAY,EACxB,WAAW,EAAE,MAAM,GACpB,IAAI,CAiDN;AAmJD;;;;;GAKG;AACH,wBAAgB,8CAA8C,CAC1D,cAAc,EAAE,SAAS,EACzB,aAAa,EAAE,GAAG,CAAC,cAAc,CAAC,KAAK,GAAG,SAAS,GAAG,QAAQ,CAAC,GAChE,MAAM,CAMR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC5B,YAAY,EAAE,OAAO,EACrB,SAAS,EAAE,UAAU,EACrB,kBAAkB,EAAE,cAAc,CAAC,QAAQ,CAAC,EAC5C,UAAU,EAAE,UAAU,EACtB,UAAU,CAAC,EAAE,MAAM,EACnB,eAAe,CAAC,EAAE,MAAM,GACzB,IAAI,CAwCN;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC1C,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,MAAM,GACvB,IAAI,CAmBN;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CACzB,SAAS,EAAE,UAAU,EACrB,cAAc,EAAE,MAAM,EACtB,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EACxB,OAAO,CAAC,EAAE,MAAM,GACjB,IAAI,CAqBN;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC3B,SAAS,EAAE,UAAU,EACrB,SAAS,EAAE,QAAQ,EAAE,EACrB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,GACvB,IAAI,CA+BN;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,wBAAwB,CACpC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,EAAE,CAAC,cAAc,EACvB,QAAQ,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,QAAQ,EAAE,EACtB,2BAA2B,GAAE,MAAqC,EAClE,0BAA0B,GAAE,MAAoC,EAChE,OAAO,CAAC,EAAE,MAAM,GACjB,IAAI,CAcN;AAqMD;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC3B,MAAM,EAAE,MAAM,EACd,gBAAgB,EAAE,MAAM,EACxB,kBAAkB,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,EAC1C,QAAQ,EAAE,UAAU,GAAG,UAAU,EACjC,OAAO,EAAE,yBAAyB,EAClC,aAAa,EAAE,MAAM,EAAE,EACvB,GAAG,CAAC,EAAE,MAAM,GACb,IAAI,CA0BN;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAQnG;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAC9B,SAAS,EAAE,UAAU,EACrB,yBAAyB,EAAE,cAAc,CAAC,eAAe,CAAC,EAC1D,UAAU,EAAE,UAAU,GACvB,IAAI,CAgDN;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,aAAa,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI,CAI/F;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAE5D;AAED;;;;;GAKG;AAEH;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAE/D;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAE/D;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,UAAQ,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAmBxG;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI,CAS3F;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,kBAAkB,EAAE,2BAA2B,GAAG;IAC1F,UAAU,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC;IAC5B,aAAa,CAAC,EAAE,wBAAwB,CAAC;CAC5C,CAaA"}

package/dist/specification/src/sync/v2/generate/utils.js

@@ -20,7 +20,6 @@ exports.isEntityUpdatable = isEntityUpdatable;
 exports.addStandardHeaderActions = addStandardHeaderActions;
 exports.addStandardFooterActionsOP = addStandardFooterActionsOP;
 exports.getUIAnnotationForEntitySet = getUIAnnotationForEntitySet;
-exports.hasPropertyTypeError = hasPropertyTypeError;
 const ux_specification_types_1 = require("@sap/ux-specification-types");
 const common_1 = require("../../common");
 const decorators_1 = require("../../common/decoration/decorators");
@@ -30,7 +29,8 @@ const types_1 = require("../types");
 const extensionLogger_1 = require("../../../extensionLogger");
 const i18next_1 = __importDefault(require("i18next"));
 /**
- * Common function for enhancing the LineItems definiton 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 customColumnsDefinitionName - custom column definition name (plural)
  * @param customColumnDefinitionName - custom column definition name (singular)
@@ -55,9 +55,14 @@ function addCustomColumnDefinition(appSchema, customColumnsDefinitionName, custo
     }
 }
 /**
- * Prepares and returns id of action for further use and reference
+ * Prepares and returns id of action for further use and reference.
+ *
  * @param actionType - type of action
  * @param lineItemProperties - properties of the line item collection: lineItemPath, lineItemRecord, lineItemId
+ * @param lineItemProperties.lineItemPath - The path to the line item in the schema.
+ * @param lineItemProperties.lineItemRecord - The record of the line item in the collection.
+ * @param lineItemProperties.lineItemId - The identifier of the line item.
+ * @param lineItemProperties.entityType - The entity type as part of the AVT ConvertedMetadata.
  * @returns {string} actionId
  */
 function getActionId(actionType, lineItemProperties) {
@@ -83,11 +88,15 @@ function getActionId(actionType, lineItemProperties) {
     }
 }
 /**
- * Processes a LineItem record of type DataFieldForAction and DataFieldForIntentBasedNavigation during app schema generation
+ * Processes a LineItem record of type DataFieldForAction and DataFieldForIntentBasedNavigation during app schema generation.
+ *
  * @param appSchema - the app specific schema that shall get enhanced
- * @param entityType - the entity type as part of the AVT ConvertedMetadata
  * @param actions - actions definition in schema, parent object
- * @param lineItemProperties - properties of the line item collection: lineItemPath, lineItemRecord, lineItemId
+ * @param lineItemProps - properties of the line item collection: lineItemPath, lineItemRecord, lineItemId
+ * @param lineItemProps.lineItemPath - The path to the line item in the schema.
+ * @param lineItemProps.lineItemRecord - The record of the line item in the collection.
+ * @param lineItemProps.lineItemId - The identifier of the line item.
+ * @param lineItemProps.entityType - the entity type as part of the AVT ConvertedMetadata
  * @param actionType - type of action
  * @param recordIndex - record index in the collection
  */
@@ -141,7 +150,8 @@ function handleActionRecord(appSchema, actions, lineItemProps, actionType, recor
     }
 }
 /**
- * Returns the type of a column lineItem action
+ * Returns the type of a column lineItem action.
+ *
  * @param lineItemId - optional: in case of OP the parameter must be passed to distinguish the OP tables;
  * @param {object} lineItemRecord - actual record of the line item collection
  * @param actionTypes - array of action types to be filled
@@ -162,8 +172,10 @@ function getColumnActionType(lineItemId, lineItemRecord, actionTypes) {
     }
 }
 /**
- * Returns the type of a lineItem action
+ * Returns the type of a lineItem action.
+ *
  * @param {object} lineItemRecord - actual record of the line item collection
+ * @param lineItemId - The identifier of the line item, used to distinguish between different line item collections.
  * @returns {string[] | undefined } ActionTypeV2[] - action type(s) of the lineItem
  */
 function getActionType(lineItemRecord, lineItemId) {
@@ -192,6 +204,13 @@ function getActionType(lineItemRecord, lineItemId) {
     getColumnActionType(lineItemId, lineItemRecord, actionTypes);
     return actionTypes;
 }
+/**
+ * Generates a generic column for the line item collection.
+ *
+ * @param lineItemProperties - Properties of the line item collection, including path, record, ID, and entity type.
+ * @param appSchema - The app-specific JSON schema to be enhanced.
+ * @param recordIndex - The index of the current record in the line item collection.
+ */
 function generateGenericColumn(lineItemProperties, appSchema, recordIndex) {
     const schemaKey = (0, common_1.getSchemaKeyOfLineItemRecord)(lineItemProperties.lineItemRecord);
     if (schemaKey) {
@@ -208,6 +227,17 @@ function generateGenericColumn(lineItemProperties, appSchema, recordIndex) {
         (0, common_1.addKeyToDefinition)(lineItemProperties.lineItemRecord, lineItemDefinition.properties, schemaKey);
     }
 }
+/**
+ * Handles any action type of a line item record.
+ *
+ * @param actionType - The type of action being processed.
+ * @param appSchema - The app-specific JSON schema to be enhanced.
+ * @param actions - The actions definition in the schema, parent object.
+ * @param lineItemProperties - Properties of the line item collection, including path, record, ID, and entity type.
+ * @param recordIndex - The index of the current record in the line item collection.
+ * @param footerActions - The footer actions definition in the schema, if applicable.
+ * @param lineItemId - The identifier of the line item, used to distinguish between different line item collections.
+ */
 function handleAnyAction(actionType, appSchema, actions, lineItemProperties, recordIndex, footerActions, lineItemId) {
     switch (actionType) {
         case types_1.ActionTypeV2.ToolBar:
@@ -246,7 +276,8 @@ function retrieveNameWithoutVocabularyFromVisualization(annotationTerm, visualiz
         : '';
 }
 /**
- * Adds the line item records to the app schema (for the list report or an object page section comprising a table)
+ * Adds the line item records to the app schema (for the list report or an object page section comprising a table).
+ *
  * @param isObjectPage - indicates that the page is an object page
  * @param appSchema - the app specific schema that shall get enhanced
  * @param lineItemAnnotation - the UI.LineItem annotation, comprising all records
@@ -283,6 +314,7 @@ function addLineItemsType(isObjectPage, appSchema, lineItemAnnotation, entityTyp
 }
 /**
  * Adds enum entries of possible leading properties for 'leadingProperty' property in TableCustomColumn properties.
+ *
  * @param appSchema - the app specific schema that shall get enhanced
  * @param entityType - the entity type as part of the AVT ConvertedMetadata
  * @param definitionName - definition name of CustomColumn definition
@@ -307,10 +339,11 @@ function addListReportLeadingProperties(appSchema, entityType, definitionName) {
 }
 /**
  * Adds enum entries of posible tabKey properties for 'leadingProperty' property in TableCustomColumn properties.
+ *
  * @param appSchema - the app specific schema that shall get enhanced
  * @param definitionName - definition name of CustomColumn definition
  * @param page - sapui5 page object
- * @param {string} facet ID -  The facet ID
+ * @param facetID -  The facet ID
  */
 function addTabkeyEnum(appSchema, definitionName, page, facetID) {
     const tabkeyPropertySchema = appSchema.definitions[definitionName]?.['properties']?.['tabKey'];
@@ -336,6 +369,7 @@ function addTabkeyEnum(appSchema, definitionName, page, facetID) {
 }
 /**
  * Adds enum entries of posible fragment entries.
+ *
  * @param {object} appSchema The app specific schema that shall get enhanced.
  * @param {FileData[]} fragments Array of fragments.
  * @param {string[]} appId Application id.
@@ -372,14 +406,15 @@ function addFragmentEnum(appSchema, fragments, appId, property, definitionName)
 }
 /**
  * Adds the custom columns to the line item records of the app schema (for the list report comprising a table).
- * @param {object} appSchema The app specific schema that shall get enhanced.
- * @param {EntityType} entityType The entity type as part of the AVT ConvertedMetadata.
- * @param {SapUiAppPageV2} page Sapui5 page object.
- * @param {object} manifest Application manifest.
- * @param {FileData[]} [fragments] Array of fragments.
- * @param {string} [customColumnsDefinitionName=DefinitionName.CustomColumns] Definition name of Custom Columns definition.
- * @param {string} [customColumnDefinitionName=DefinitionName.CustomColumn] Definition name of Custom Column definition.
- * @param {string} facetID -  Facet ID
+ *
+ * @param appSchema The app specific schema that shall get enhanced.
+ * @param entityType The entity type as part of the AVT ConvertedMetadata.
+ * @param page Sapui5 page object.
+ * @param manifest Application manifest.
+ * @param [fragments] Array of fragments.
+ * @param [customColumnsDefinitionName] Definition name of Custom Columns definition.
+ * @param [customColumnDefinitionName] Definition name of Custom Column definition.
+ * @param facetID -  Facet ID
  */
 function addTableColumnExtensions(appSchema, entityType, page, manifest, fragments, customColumnsDefinitionName = ux_specification_types_1.DefinitionName.CustomColumns, customColumnDefinitionName = ux_specification_types_1.DefinitionName.CustomColumn, facetID) {
     addCustomColumnDefinition(appSchema, customColumnsDefinitionName, customColumnDefinitionName);
@@ -396,7 +431,8 @@ function addTableColumnExtensions(appSchema, entityType, page, manifest, fragmen
     addFragmentEnum(appSchema, fragments, appId, 'cellsFragmentName', ux_specification_types_1.DefinitionName.CustomColumn);
 }
 /**
- * Processes an anyOf definition of the generic schema
+ * Processes an anyOf definition of the generic schema.
+ *
  * @param propertyDefinition - current definition in the generic schema
  * @param schema - the app-specific schema
  * @param propertyKey - key of the single property
@@ -413,8 +449,9 @@ function processAnyOf(propertyDefinition, schema, propertyKey, factory, pageType
     });
 }
 /**
- * Processes an object reference of the generic schema
- * @param schema
+ * Processes an object reference of the generic schema.
+ *
+ * @param schema - The JSON schema to be processed.
  * @param propertyDefinition - current definition in the generic schema
  * @param propertyKey - key of the single property
  * @param factory - factory for creating metadata instances
@@ -428,7 +465,8 @@ function processObject(schema, propertyDefinition, propertyKey, factory, pageTyp
     }
 }
 /**
- * Determines the artifact type of a property and adds it to the property definition in schema
+ * Determines the artifact type of a property and adds it to the property definition in schema.
+ *
  * @param syncRule - sync rule of the current property
  * @param propertyDefinition - current definition in the generic schema
  */
@@ -449,8 +487,9 @@ function addArtifactType(syncRule, propertyDefinition) {
     }
 }
 /**
- * After the generation of a generic schema, apply post-generation rule to a single property
- * @param metaDataDefinition
+ * After the generation of a generic schema, apply post-generation rule to a single property.
+ *
+ * @param metaDataDefinition - The metadata definition object containing property configurations and rules.
  * @param schema - given app schema, to be adapted
  * @param pageType - page type
  * @param factory - factory for creating metadata instances
@@ -485,9 +524,12 @@ function processSingleProperty(metaDataDefinition, schema, pageType, factory, pr
     }
 }
 /**
- * After the generation of a generic schema, apply rules to a list of properties of the given schema section
+ * After the generation of a generic schema, apply rules to a list of properties of the given schema section.
+ *
  * @param schema - given app schema, to be adapted
  * @param schemaDefinition - the current entry point or definition in the app schema
+ * @param metaDataDefinition - the current entry point or definition in the metadata
+ * @param propertiesSection - the section of the schema containing properties to process (e.g., 'properties', 'additionalProperties', or 'patternProperties')
  * @param pageType - page type
  * @param factory - factory for creating metadata instances
  * @param processedRefs - array of already processed refs which used to avoid cycling recursion
@@ -514,9 +556,11 @@ function processProperties(schema, schemaDefinition, metaDataDefinition, propert
     }
 }
 /**
- * Apply post-processing rules as specified in form of "generate" at the syncRule
+ * Apply post-processing rules as specified in form of "generate" at the syncRule.
+ *
  * @param schema - given app schema, to be adapted
  * @param schemaDefinition - the current entry point or definition in the app schema
+ * @param metaDataDefinition - the current entry point or definition in the metadata
  * @param pageType - page type
  * @param factory - factory for creating metadata instances
  * @param processedRefs - array of already processed refs which used to avoid cycling recursion
@@ -535,6 +579,7 @@ function processMetadata(schema, schemaDefinition, metaDataDefinition, pageType,
 }
 /**
  * Method updates passed 'enum' array by removing passed matching entries.
+ *
  * @param {Array<unknown>} values Array of values.
  * @param {Array<unknown>} valuesToRemove Array of values to remove.
  */
@@ -548,10 +593,11 @@ function removeElementsFromEnum(values, valuesToRemove) {
     }
 }
 /**
- * Adds the selection fields to the app schema, as properties of the Filterbar
- * @param entityType - the entity type as part of the AVT ConvertedMetadata
+ * Adds the selection fields to the app schema, as properties of the Filterbar.
+ *
  * @param appSchema - the app specific schema that shall get enhanced
  * @param selectionFieldsAnnotation - the UI.SelectionField annotation
+ * @param entityType - the entity type as part of the AVT ConvertedMetadata
  */
 function addSelectionFields(appSchema, selectionFieldsAnnotation, entityType) {
     appSchema.definitions.SelectionFields = {
@@ -601,7 +647,8 @@ function addSelectionFields(appSchema, selectionFieldsAnnotation, entityType) {
     });
 }
 /**
- * Add entityProperties to passed a passed enum entry
+ * Add entityProperties to passed a passed enum entry.
+ *
  * @param {string[]} appSchemaEnum - Enum to be enhanced
  * @param {EntityType} entityType - Given entity type for which entries shall get generated
  */
@@ -611,7 +658,8 @@ function addEntityPropertiesToEnum(appSchemaEnum, entityType) {
     }
 }
 /**
- * Checks if an entity supports draft capabilities
+ * Checks if an entity supports draft capabilities.
+ *
  * @param {EntitySet} entitySet Entity Set
  * @returns true if the entity supports draft
  */
@@ -620,14 +668,22 @@ function isDraftEnabled(entitySet) {
 }
 /**
  * Function to determine if the entity is deletable.
+ *
  * @param {EntitySet} entitySet - current entity set
  * returns {boolean} return true if the Entity is deletable
  */
+/**
+ * Checks if an entity supports draft capabilities.
+ *
+ * @param entitySet - The entity set to check for draft capabilities.
+ * @returns {boolean} True if the entity supports draft capabilities, otherwise false.
+ */
 function isEntityDeletable(entitySet) {
     return entitySet.annotations?.Capabilities?.DeleteRestrictions?.Deletable !== false;
 }
 /**
  * Function to determine if the entity is updatable.
+ *
  * @param {EntitySet} entitySet - current entity set
  * @returns returns true if the Entity is updatable
  */
@@ -635,7 +691,8 @@ function isEntityUpdatable(entitySet) {
     return entitySet.annotations?.Capabilities?.UpdateRestrictions?.Updatable !== false;
 }
 /**
- * Adds standard header actions to schema (LR, ALP or OP)
+ * Adds standard header actions to schema (LR, ALP or OP).
+ *
  * @param {Definition} appSchema - app-specific JSON schema
  * @param {boolean} isOP - flag to add to either LR/ALP or OP definition
  * @param {Definition} actions - optional standard actions definition
@@ -661,9 +718,9 @@ function addStandardHeaderActions(appSchema, isOP = false, actions) {
     });
 }
 /**
- * Adds standard footer actions to schema of Object Page
+ * Adds standard footer actions to schema of Object Page.
+ *
  * @param {Definition} appSchema - app-specific JSON schema
- * @param {EntityType} entityType Entity Type of the page
  * @param {Definition} actions - optional standard actions definition
  */
 function addStandardFooterActionsOP(appSchema, actions) {
@@ -677,7 +734,8 @@ function addStandardFooterActionsOP(appSchema, actions) {
     }
 }
 /**
- * Extract entity type and ui annotations for a entity set and log an error in case that either of these objects does not exist
+ * Extract entity type and ui annotations for a entity set and log an error in case that either of these objects does not exist.
+ *
  * @param {GenerateAppSchemaParameters} generateParameters list of API input parameters
  * @returns the entity type and the ui annotations for the given entity set
  */
@@ -695,41 +753,4 @@ function getUIAnnotationForEntitySet(generateParameters) {
     }
     return { entityType, uIAnnotations };
 }
-/**
- * Type check for properties coming from the manifest.
- *
- * @param parent - the parent object in manifest which may contain the property.
- * @param propertyName - name of the property name to be checked
- * @param logger - a logger which may receive the error message in case a type error is detected
- * @param expectedType - the expected type of the value of the property (if it is not undefined)
- * @param mandatory - specifies handling handling of null and undefined: If parent is null this is always considered an error.
- * undefined value for parent or its specified property is considered an error when parameter mandatory is true.
- * null value for the specified property is considered an error when mandatory is true or the expected type is not 'object'.
- * @returns the information whether a type error was detected.
- */
-function hasPropertyTypeError(parent, propertyName, logger, expectedType = 'string', mandatory = false) {
-    let hasTypeError;
-    if (parent === undefined) {
-        hasTypeError = mandatory;
-    }
-    else if (parent === null || typeof parent !== 'object') {
-        hasTypeError = true;
-    }
-    else {
-        const propValue = parent[propertyName];
-        if (propValue === undefined) {
-            hasTypeError = mandatory;
-        }
-        else {
-            hasTypeError = typeof propValue !== expectedType || (propValue === null && mandatory);
-        }
-    }
-    if (hasTypeError) {
-        (0, extensionLogger_1.log)(logger, {
-            severity: "error" /* LogSeverity.Error */,
-            message: i18next_1.default.t('TYPEERROR', { propertyName: propertyName, expectedType: expectedType })
-        });
-    }
-    return hasTypeError;
-}
 //# sourceMappingURL=utils.js.map