@sap/ux-specification 1.90.9 → 1.90.13

package/dist/src/sync/common/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/sync/common/types.ts"],"names":[],"mappings":";;AAGA,IAAY,eAGX;AAHD,WAAY,eAAe;IACvB,gCAAa,CAAA;IACb,wCAAqB,CAAA;AACzB,CAAC,EAHW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAG1B;AACD,IAAY,OAGX;AAHD,WAAY,OAAO;IACf,+BAAoB,CAAA;IACpB,0BAAe,CAAA;AACnB,CAAC,EAHW,OAAO,GAAP,eAAO,KAAP,eAAO,QAGlB;AACD,IAAY,QAEX;AAFD,WAAY,QAAQ;IAChB,4BAAgB,CAAA;AACpB,CAAC,EAFW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAEnB;AACY,QAAA,gBAAgB,GAAG,YAAY,CAAC;AAQ7C,IAAY,WAGX;AAHD,WAAY,WAAW;IACnB,kCAAmB,CAAA;IACnB,8CAA+B,CAAA;AACnC,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AAED,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,qCAAqB,CAAA;IACrB,yCAAyB,CAAA;IACzB,yCAAyB,CAAA;AAC7B,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAED,IAAY,WAgBX;AAhBD,WAAY,WAAW;IACnB,oCAAqB,CAAA;IACrB,2CAA4B,CAAA;IAC5B,+DAAgD,CAAA;IAChD,2EAA4D,CAAA;IAC5D,+DAAgD,CAAA;IAChD,sCAAuB,CAAA;IACvB,4DAA6C,CAAA;IAC7C,sCAAuB,CAAA;IACvB,qFAAsE,CAAA;IACtE,kEAAmD,CAAA;IACnD,6DAA8C,CAAA;IAC9C,6DAA8C,CAAA;IAC9C,gDAAiC,CAAA;IACjC,0CAA2B,CAAA;IAC3B,gDAAiC,CAAA;AACrC,CAAC,EAhBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAgBtB;AA4HD,IAAY,SAUX;AAVD,WAAY,SAAS;IACjB,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;IACnC,4BAAe,CAAA;IACf,0BAAa,CAAA;IACb,8CAAiC,CAAA;IACjC,oCAAuB,CAAA;IACvB,gCAAmB,CAAA;IACnB,gCAAmB,CAAA;IACnB,yBAAY,CAAA;AAChB,CAAC,EAVW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAUpB;AAgDY,QAAA,4BAA4B,GAAG,6CAA6C,CAAC;AAE1F,IAAY,gBAMX;AAND,WAAY,gBAAgB;IACxB,uFAAmE,CAAA;IACnE,uFAAmE,CAAA;IACnE,2EAAuD,CAAA;IACvD,2EAAuD,CAAA;IACvD,mFAA+D,CAAA;AACnE,CAAC,EANW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAM3B;AAEY,QAAA,YAAY,GAAG,kCAAkC,CAAC;AAClD,QAAA,YAAY,GAAG,sBAAsB,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/sync/common/types.ts"],"names":[],"mappings":";;AAIA,IAAY,eAGX;AAHD,WAAY,eAAe;IACvB,gCAAa,CAAA;IACb,wCAAqB,CAAA;AACzB,CAAC,EAHW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAG1B;AACD,IAAY,OAGX;AAHD,WAAY,OAAO;IACf,+BAAoB,CAAA;IACpB,0BAAe,CAAA;AACnB,CAAC,EAHW,OAAO,GAAP,eAAO,KAAP,eAAO,QAGlB;AACD,IAAY,QAEX;AAFD,WAAY,QAAQ;IAChB,4BAAgB,CAAA;AACpB,CAAC,EAFW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAEnB;AACY,QAAA,gBAAgB,GAAG,YAAY,CAAC;AAQ7C,IAAY,WAGX;AAHD,WAAY,WAAW;IACnB,kCAAmB,CAAA;IACnB,8CAA+B,CAAA;AACnC,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AAED,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,qCAAqB,CAAA;IACrB,yCAAyB,CAAA;IACzB,yCAAyB,CAAA;AAC7B,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAED,IAAY,WAoBX;AApBD,WAAY,WAAW;IACnB,oCAAqB,CAAA;IACrB,2CAA4B,CAAA;IAC5B,+DAAgD,CAAA;IAChD,2EAA4D,CAAA;IAC5D,+DAAgD,CAAA;IAChD,8DAA+C,CAAA;IAC/C,sCAAuB,CAAA;IACvB,4DAA6C,CAAA;IAC7C,sCAAuB,CAAA;IACvB,qFAAsE,CAAA;IACtE,kEAAmD,CAAA;IACnD,6DAA8C,CAAA;IAC9C,6DAA8C,CAAA;IAC9C,qEAAsD,CAAA;IACtD,gDAAiC,CAAA;IACjC,0CAA2B,CAAA;IAC3B,gDAAiC,CAAA;IACjC,qDAAsC,CAAA;IACtC,2DAA4C,CAAA;AAChD,CAAC,EApBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAoBtB;AA0HD,IAAY,SAUX;AAVD,WAAY,SAAS;IACjB,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;IACnC,4BAAe,CAAA;IACf,0BAAa,CAAA;IACb,8CAAiC,CAAA;IACjC,oCAAuB,CAAA;IACvB,gCAAmB,CAAA;IACnB,gCAAmB,CAAA;IACnB,yBAAY,CAAA;AAChB,CAAC,EAVW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAUpB;AAgDY,QAAA,4BAA4B,GAAG,6CAA6C,CAAC;AAE1F,IAAY,gBAMX;AAND,WAAY,gBAAgB;IACxB,uFAAmE,CAAA;IACnE,uFAAmE,CAAA;IACnE,2EAAuD,CAAA;IACvD,2EAAuD,CAAA;IACvD,mFAA+D,CAAA;AACnE,CAAC,EANW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAM3B;AAEY,QAAA,YAAY,GAAG,kCAAkC,CAAC;AAClD,QAAA,YAAY,GAAG,sBAAsB,CAAC;AACtC,QAAA,YAAY,GAAG,wBAAwB,CAAC;AACxC,QAAA,aAAa,GAAG,yBAAyB,CAAC;AAC1C,QAAA,YAAY,GAAG,4BAA4B,CAAC;AAC5C,QAAA,YAAY,GAAG,wBAAwB,CAAC;AACxC,QAAA,aAAa,GAAG,yBAAyB,CAAC;AAC1C,QAAA,gBAAgB,GAAG,8BAA8B,CAAC;AAClD,QAAA,OAAO,GAAG,oBAAoB,CAAC;AAC/B,QAAA,gBAAgB,GAAG,YAAY,CAAC"}

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

@@ -7,7 +7,6 @@ import { MetadataInstanceInterface } from './decoration/factory';
 export declare enum TemplateType {
     ListReportObjectPageV2 = "ListReportObjectPageV2",
     ListReportObjectPageV4 = "ListReportObjectPageV4",
-    FormPageV4 = "FormPageV4",
     OverviewPageV2 = "OverviewPageV2",
     AnalyticalListPageV2 = "AnalyticalListPageV2",
     AnalyticalListPageV4 = "AnalyticalListPageV4"
@@ -59,12 +58,12 @@ export declare function getDatafieldDescription(dataFieldAbstract: DataFieldAbst
  * Return the page type for a given V2 page in manifest
  * @param name - page component name
  */
-export declare function getPageTypeV2(name: string): PageType;
+export declare function getPageTypeV2(name: string): PageType | undefined;
 /**
  * Return the page type for a given V4 page in manifest
  * @param name - page component name
  */
-export declare function getPageTypeV4(name: string): PageTypeV4;
+export declare function getPageTypeV4(name: string): PageTypeV4 | undefined;
 /**
  * Finds the alias for a given namespace in the references' section of the converted service metadata
  * @param {string} namespace - complete namespace, e.g. 'com.sap.vocabularies.UI.v1'
@@ -81,7 +80,7 @@ export declare function findAlias(namespace: string, oDataServiceAVT: ConverterO
  * @param {ExtensionLogger} logger - Logger class for logging messages
  * @returns {FacetSection} - object comprising the relevant facet information
  */
-export declare function getSectionFacet(facetDefinition: AnnotationTerm<CollectionFacet> | AnnotationTerm<ReferenceFacet> | AnnotationTerm<ReferenceURLFacet>, keyForRelatedFacetKeys: boolean, oDataVersion: FioriElementsVersion, sourceEntityType: EntityType, oDataServiceAVT: ConverterOutput, logger?: ExtensionLogger): FacetSection | undefined;
+export declare function getSectionFacet(facetDefinition: AnnotationTerm<CollectionFacet> | AnnotationTerm<ReferenceFacet> | AnnotationTerm<ReferenceURLFacet>, sourceEntityType: EntityType, oDataServiceAVT: ConverterOutput, logger?: ExtensionLogger, oDataVersion?: FioriElementsVersion, keyForRelatedFacetKeys?: boolean): FacetSection | undefined;
 /**
  * Finds the alias for a given namespace in the references' section of the converted service metadata
  * @param {object} exportResultManifest - manifest that is being modified during export
@@ -99,7 +98,7 @@ export declare function getSchemaKeyOfLineItemRecord(lineItemRecord: DataFieldAb
  * @param {FioriElementsVersion} oDataVersion - OData version
  * @param {ExtensionLogger} logger - Logger class for logging messages
  */
-export declare function getObjectPageHeaderFacets(entityType: EntityType, oDataServiceAVT: ConverterOutput, oDataVersion?: FioriElementsVersion, logger?: ExtensionLogger): FacetConfigs;
+export declare function getObjectPageHeaderFacets(entityType: EntityType, oDataServiceAVT: ConverterOutput, oDataVersion?: FioriElementsVersion, logger?: ExtensionLogger): FacetConfigs | undefined;
 /**
  * Retrieve facet configurations that can be used to generate ObjectPage schemas
  * @param {QualifiedName} entityTypeName - the name of the actual entity type
@@ -107,19 +106,47 @@ export declare function getObjectPageHeaderFacets(entityType: EntityType, oDataS
  * @param {FioriElementsVersion} oDataVersion - OData version
  * @param {ExtensionLogger} logger - Logger class for logging messages
  */
-export declare function getObjectPageFacets(entityType: EntityType, oDataServiceAVT: ConverterOutput, oDataVersion?: FioriElementsVersion, logger?: ExtensionLogger): FacetConfigs;
+export declare function getObjectPageFacets(entityType: EntityType, oDataServiceAVT: ConverterOutput, oDataVersion?: FioriElementsVersion, logger?: ExtensionLogger): FacetConfigs | undefined;
 /**
  * Returns the version of Fiori elements (v2/v4) from a given manifest
  * @param manifest - the manifest.json file
  */
 export declare function getVersionFromManifest(manifest: Manifest): FioriElementsVersion;
-export declare function getTemplateTypeFromManifest(manifest: Manifest, fioriElementsVersion: FioriElementsVersion, logger: ExtensionLogger): TemplateType;
+/**
+ * Determines the template type of a V2 app
+ * @param manifest - the manifest.json file
+ * @param {ExtensionLogger} logger - Logger class for logging messages
+ * @returns {TemplateType} the template type
+ */
+export declare function determineV2Template(manifest: Manifest, logger: ExtensionLogger): TemplateType | undefined;
+/**
+ * Determines the template type of a V4 app
+ * @param manifest - the manifest.json file
+ * @param {ExtensionLogger} logger - Logger class for logging messages
+ * @returns {TemplateType} the template type
+ */
+export declare function determineV4Template(manifest: Manifest, logger: ExtensionLogger): TemplateType | undefined;
+/**
+ * Determines the template type, based on the given manifest entries of the app
+ * @param manifest - the manifest.json file
+ * @param {FioriElementsVersion} fioriElementsVersion - OData or FE version
+ * @param {ExtensionLogger} logger - Logger class for logging messages
+ * @returns {TemplateType} the template type
+ */
+export declare function getTemplateTypeFromManifest(manifest: Manifest, fioriElementsVersion: FioriElementsVersion, logger: ExtensionLogger): TemplateType | undefined;
+/**
+ * Adds title and description to a section or header section in an app schema
+ * @param facet - intermediate facet structure comprising annotation information
+ * @param section - section in the app schema
+ * @param facetKey - key of the facet
+ */
+export declare function addSectionTitleAndDescription(facet: FacetConfig, section: object, facetKey: string): void;
 /**
  * Creates a default object for a new section or subsection, and adds the ID as title if present.
  * @param facet Facet configuration, to be analyzed
  * @returns the new section object
  */
-export declare function createSectionWithoutProperties(facet?: FacetConfig): object;
+export declare function createSectionWithoutProperties(facet: FacetConfig, facetKey: string): object;
 /**
  * Retrieve page section data(so far id/key and label/description).
  * @param {EntityType} entityType The actual entityType
@@ -144,7 +171,7 @@ export declare const deleteEmptyStructure: (manifest: object, path: string, targ
  * @param {string} [entitySet] Entity set string.
  * @return {SchemaFilePath} File path info.
  */
-export declare const getSchemaFilePath: (schemaType: SchemaType | PageType | PageTypeV4, entitySet?: string) => SchemaFilePath;
+export declare const getSchemaFilePath: (schemaType: PageType | PageTypeV4 | SchemaType, entitySet?: string) => SchemaFilePath;
 /**
  * Method which generates id of page according to passed parameters.
  * @param appVersion - Fiori Elements version - V2 or V4.
@@ -162,21 +189,22 @@ export declare type NextDefinition = {
 };
 /**
  * Recursive function to determine the next config part, next definition in the app schema and the title
- * @param appSchema - app schema
+ * @param appSchema - app-spcific JSON schema
  * @param title - default title
  * @param currentConfigObject - current part of the configuration that gets traversed
  * @param propertyDefinition - definition of a given property in the app schema
  * @param key - actual key
- * @param factory - factory for creating metadata instances
+ * @param {MetadataInstanceInterface} factory - factory for creating metadata instances
  * @param pageType - page type
  */
 export declare function getNextTargetDefinition(appSchema: object, title: string, currentConfigObject: object, propertyDefinition: object, key: string, factory: MetadataInstanceInterface, pageType: PageType | PageTypeV4): NextDefinition;
 /**
  * Add schema definitions for fields of createWithParameterDialog
  * @param {object} appSchema - Application-specific schema, to be enhanced
- * @param {EntityType} entityType - Given entity type for which entries shall get generated.
+ * @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): void;
+export declare function addFieldsType(appSchema: object, entityType: EntityType, floorplanSuffix?: string): 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