@sap/ux-specification 1.108.28 → 1.108.30

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

@@ -0,0 +1,226 @@
+import type { AnnotationTerm, ConvertedMetadata, EntitySet, EntityType } from '@sap-ux/vocabularies-types';
+import type { LineItem } from '@sap-ux/vocabularies-types/vocabularies/UI';
+import { UIAnnotationTerms } from '@sap-ux/vocabularies-types/vocabularies/UI';
+import type { Definition, DefinitionOrBoolean } from 'typescript-json-schema';
+import type { SectionTypeV2 } from '../../v2/types';
+import type { PresentationVariantV4 } from '../../v4/types';
+import type { FacetConfig, FacetSection, SectionType, SchemaDefinition } from '@sap/ux-specification-types';
+import { DefinitionName, SchemaKeyName } from '@sap/ux-specification-types';
+interface PropertyInDefinition {
+    definition?: string;
+    property?: string;
+    schema?: Definition;
+}
+interface EnumDefinitionParsingOptions {
+    excludeKey?: string;
+    resolveDefinition?: boolean;
+    keyProperties?: SchemaKeyName[];
+    descriptionAsFallback?: boolean;
+}
+/**
+ * Adds enum values to the app schema. Either as 'enum' -  if multiple entries exist,
+ * or as 'const', if it is only a single value
+ * @param enumEntries - array of strings for setting up the enum definition
+ * @param currentDefinition - currentDefinition in the schema
+ */
+export declare function addEnumToSchema(enumEntries: string[], currentDefinition: Definition): void;
+/**
+ * Adds an enum filled with existing UI annotations of the given list (validAnnotations)
+ * @param {EntityType} entityType
+ * @param {UIAnnotationTerms[]} validAnnotations
+ * @param {Definition} annoPath - the annotation path property in the app schema where the enum shall be added
+ */
+export declare function addEnumForValidAnnotations(entityType: EntityType, validAnnotations: UIAnnotationTerms[], annoPath: Definition): void;
+/**
+ * Adds an enum filled with existing UI annotations for single-tab variants of a table
+ * @param {EntityType} entityType
+ * @param {Definition} appSchema - app specific JSON schema
+ * @param definitionName - name of the definition in the app schema
+ */
+export declare function addEnumForSingleTabVariant(entityType: EntityType, appSchema: Definition, definitionName: string): void;
+/**
+ * Adds an enum filled with existing UI annotations for multi-tab variants of a table
+ * @param appSchema - app specific JSOn schema
+ * @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: Definition, definitionName: string, entitySet: EntitySet): void;
+/**
+ * Adds the enum values for entitySet as part of the multiple view scenario
+ * @param {ConvertedMetadata} 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: ConvertedMetadata, appSchema: Definition, definitionName: string): void;
+/**
+ * Adds an enum filled with existing UI FieldGroup annotations for annotationPath property in MultiEdit
+ * @param {EntityType} entityType
+ * @param appSchema - app specific JSOn schema
+ * @param definitionName - name of the definition in the app schema
+ */
+export declare function addEnumFieldGroupAnnotationPath(entityType: EntityType, appSchema: Definition, definitionName: string): void;
+/**
+ * Method adds definition for 'RelatedFacetKeys' as enum with description and adds references to 'RelatedFacetKeys' for custom section definitions.
+ * @param {Definition} 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(appSchema: Definition, sectionDefinitions: string[], facetSections: FacetSection[], idProperties: Array<keyof Omit<FacetSection, 'custom'>>): void;
+/**
+ * Receives a facet key and returns the key as used in schema
+ * @param facetKey - key of the facet, as used in annotation
+ * @returns facetKeyInSchema - key of the facet, as used in schema
+ */
+export declare function getFacetKeyInSchema(facetKey: string): string;
+/**
+ * Adds an existing schema definition to a new definition in the app schema
+ * @param definition name of definition, as used in schema
+ * @param facetKey - key of the facet, as used in annotation
+ * @param {Definition} appSchema App schema in general
+ * @param {boolean} useDefinitionAsKey If set to false, facet key will solely be used as key, else encapsulated within definition key `definition<facetKey>`
+ * @param subDefinitionName - sub definition, if different from the definition (e.g. subsection vs. section)
+ * @returns {Definition} part of app schema that has been added and filled
+ */
+export declare function parseSchemaDefinition(definition: string, facetKey: string, appSchema: Definition, useDefinitionAsKey?: boolean, subDefinitionName?: DefinitionName): Definition;
+/**
+ * Method receives custom extension base definition name and detect if it should be combined with lineItemId.
+ * @param appSchema - the app specific schema that shall get enhanced
+ * @param lineItemId - line item ID, as comprise in stable ID
+ * @param customColumnDefinitionName - (optional) definition name of custom extension.
+ * @returns $ref path for definition.
+ */
+export declare function getCustomExtensionDefinitionName(appSchema: Definition, lineItemId: string, customExtensionDefinitionName: string): string;
+/**
+ * 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
+ * @param lineItemAnnotation - the UI.LineItem annotation, comprising all records
+ * @param entityType - the entity type as part of the AVT ConvertedMetadata
+ * @param lineItemId - line item ID, as comprise in stable ID
+ * @param customColumnDefinitionName - (optional) definition name of custom column.
+ *        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: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, lineItemId: string, customColumnDefinitionName?: string, customActionDefinitionName?: string): {
+    actions: Definition;
+    footerActions: Definition;
+    lineItemPath: string;
+};
+export declare enum DataType {
+    String = "String",
+    Rating = "Rating",
+    Progress = "Progress",
+    DataPoint = "DataPoint",
+    Contact = "Contact",
+    Address = "Address",
+    Chart = "Chart",
+    FieldGroup = "FieldGroup",
+    IntentBasedNavigation = "IntentBasedNavigation"
+}
+/**
+ * Common logic to build the dataType tag from an annotation type
+ * @param {string} annotation - the annotation type
+ * @returns the dataType as string
+ */
+export declare function getDataTypeFromAnnotation(annotation: string): string;
+/**
+ * Determines the dataType of the target that shall be added to a property in schema
+ * @param target - the given target
+ * @returns - the dataType as string
+ */
+export declare function determineDataTypeOfTarget(target: any): string | undefined;
+/**
+ * Determines the dataType that shall be added to a property in schema, for any kind of field like
+ * - field of a field group
+ * - line item record
+ * - selection field
+ * @param field - the given field
+ * @returns - the dataType as string
+ */
+export declare function determineDataType(field: object): string | undefined;
+/**
+ * Adds the dataType to the given schema field definition, if the data type cane be determined
+ * @param definition - given schema definition
+ * @param field - given field definition = annotation property, at AVT
+ */
+export declare function addDataTypeToDefinition(definition: object, field: object): void;
+/**
+ * Creates a definition link for a facet and definition name
+ * @param {DefinitionName} definition - name of definition, as used in schema
+ * @param {string} facetKey - key of the facet, as used in annotation
+ * @returns definition link of facet, as used in definition
+ */
+export declare function getFacetDefinitionLink(definition: DefinitionName | SectionTypeV2, facetKey: string): string;
+/**
+ * Creates and adds a reference link to a definition
+ * @param {Definition} schemaPart - part of schema to add $ref to
+ * @param {string} schemaRef - reference to be added
+ * @param {string} schemaKey - key to be encapsulated within reference as `schemaRef<schemaKey>`
+ * @returns reference link of facet, as used in definition
+ */
+export declare function addDefinitionRef(schemaPart: Definition, schemaRef: string, schemaKey?: string): void;
+/**
+ * Extracts annotationPath from facet or Chart/LineItem fullyQualifiedName
+ * @param facet facet or Chart/LineItem
+ * @returns {string} annotationPath
+ */
+export declare function getFacetAnnotationPath(facet: FacetConfig | PresentationVariantV4 | object): string | undefined;
+/**
+ * Adds definitions for Address and Contact items in object page sections to the app schema
+ * @param {FacetConfig} facet - current facet.
+ * @param {string} facetKey - facet key.
+ * @param {object} sections - schema of current sections definition.
+ * @param {object} appSchema - app specific schema that potentially gets enhanced.
+ * @param {SectionType} sectionPrefix - prefix to distinguish Section and HeaderSection
+ */
+export declare function handleAddressContact(facet: FacetConfig, facetKey: string, sections: Definition, appSchema: Definition, sectionPrefix: SectionType, subSectionPrefix?: SectionType, versionPostfix?: string): void;
+/**
+ * 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 {string=} suffix - floorplan specific suffix (optional)
+ */
+export declare function addFieldsType(appSchema: Definition, entityType: EntityType, suffix?: string): void;
+/**
+ * Method returns enum entry for passed schema definition.
+ * @param {Definition} appSchema App specific JSON schema
+ * @param {SchemaDefinition} definition Target definition to resolve description.
+ * @param {string} key Default enum key.
+ * @param {EnumDefinitionParsingOptions} [options] Additional parsing options.
+ * @returns {string | undefined} Enum entry of passed definition.
+ */
+export declare function getEnumEntry(appSchema: Definition, definition: SchemaDefinition, key: string, options?: EnumDefinitionParsingOptions): {
+    const: string;
+    description: string | undefined;
+    custom?: boolean;
+};
+/**
+ * Method adds enum with key and description to schema definition.
+ * Description can be easily used by UI to describe enum value/key.
+ * @param {Definition} appSchema App specific JSON schema
+ * @param {DefinitionOrBoolean} origin Origin schema object containing key and description.
+ * @param {PropertyInDefinition} target Target to update with enum.
+ * @param {EnumDefinitionParsingOptions} [options] Additional parsing options.
+ * @param {boolean} resolveDefinition Should logic use fallback to look into reference definition.
+ */
+export declare function addDescriptiveEnumDefinition(appSchema: Definition, origin: DefinitionOrBoolean, target: PropertyInDefinition, options?: EnumDefinitionParsingOptions): void;
+/**
+ * Extracts the key of an action that shall be added to schema as SchemaTag.keys
+ * @param action - full-blown action ID
+ * @param isAction - indicates an action
+ * @returns action ID stripped down to the last key part
+ */
+export declare function getActionKey(action: string, isAction: boolean): {
+    key: string;
+    ns: string;
+};
+/**
+ * Adds the schema tag key to a line item record or property in schema
+ * @param lineItemRecord - the given line item record
+ * @param properties - list of all properties in schema
+ * @param schemaKey - key of the given property
+ */
+export declare function addKeyToDefinition(lineItemRecord: object, properties: object, schemaKey: string): void;
+export {};
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../../src/sync/common/generate/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC3G,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,4CAA4C,CAAC;AAC3E,OAAO,EAAqB,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,KAAK,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAS5D,OAAO,KAAK,EACR,WAAW,EACX,YAAY,EACZ,WAAW,EACX,gBAAgB,EAEnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,cAAc,EAAa,aAAa,EAAgB,MAAM,6BAA6B,CAAC;AAGrG,UAAU,oBAAoB;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,CAAC;CACvB;AAED,UAAU,4BAA4B;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,aAAa,CAAC,EAAE,aAAa,EAAE,CAAC;IAEhC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,UAAU,QAWnF;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACtC,UAAU,EAAE,UAAU,EACtB,gBAAgB,EAAE,iBAAiB,EAAE,EACrC,QAAQ,EAAE,UAAU,GACrB,IAAI,CAkBN;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACtC,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,UAAU,EACrB,cAAc,EAAE,MAAM,GACvB,IAAI,CAIN;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,CAInH;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACtC,eAAe,EAAE,iBAAiB,EAClC,SAAS,EAAE,UAAU,EACrB,cAAc,EAAE,MAAM,GACvB,IAAI,CAQN;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAC3C,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,UAAU,EACrB,cAAc,EAAE,MAAM,GACvB,IAAI,CAIN;AAED;;;;;;;GAOG;AACH,wBAAgB,gCAAgC,CAC5C,SAAS,EAAE,UAAU,EACrB,kBAAkB,EAAE,MAAM,EAAE,EAC5B,aAAa,EAAE,YAAY,EAAE,EAC7B,YAAY,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,GACxD,IAAI,CAoCN;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAE5D;AAYD;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACjC,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,UAAU,EACrB,kBAAkB,UAAO,EACzB,iBAAiB,CAAC,EAAE,cAAc,GACnC,UAAU,CAUZ;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC5C,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,MAAM,EAClB,6BAA6B,EAAE,MAAM,GACtC,MAAM,CAaR;AAED;;;;;;;;;GASG;AACH,wBAAgB,4BAA4B,CACxC,SAAS,EAAE,UAAU,EACrB,kBAAkB,EAAE,cAAc,CAAC,QAAQ,CAAC,EAC5C,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,MAAM,EAClB,0BAA0B,CAAC,EAAE,MAAM,EACnC,0BAA0B,CAAC,EAAE,MAAM,GACpC;IAAE,OAAO,EAAE,UAAU,CAAC;IAAC,aAAa,EAAE,UAAU,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CA8E1E;AAED,oBAAY,QAAQ;IAChB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,UAAU,eAAe;IACzB,qBAAqB,0BAA0B;CAClD;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAGpE;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAiBzE;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAsBnE;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAK/E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,cAAc,GAAG,aAAa,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAE3G;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAGpG;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,WAAW,GAAG,qBAAqB,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAS9G;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAChC,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,UAAU,EACpB,SAAS,EAAE,UAAU,EACrB,aAAa,EAAE,WAAW,EAC1B,gBAAgB,CAAC,EAAE,WAAW,EAC9B,cAAc,SAAK,QAiBtB;AAcD;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,SAAiB,GAAG,IAAI,CAI1G;AAuBD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CACxB,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,gBAAgB,EAC5B,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,4BAA4B,GACvC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAmCtE;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CACxC,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,4BAA4B,GACvC,IAAI,CAwBN;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAgB3F;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAsCtG"}