@sap/ux-specification 1.84.43 → 1.84.46

package/dist/types/sync/common/generate/index.d.ts

@@ -0,0 +1,3 @@
+export * from './objectPage';
+export * from './utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/sync/common/generate/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/sync/common/generate/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}

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

@@ -0,0 +1,61 @@
+import type { ConvertedMetadata, EntitySet, EntityType } from '@sap-ux/vocabularies-types';
+import { FioriElementsVersion } from '../../../specification/common';
+import type { FacetConfig } from '..';
+import { SectionType } from '..';
+import type { Definition } from 'typescript-json-schema';
+import type { GenerateAppSchemaParameters } from '../../../apiTypes';
+/**
+ * Adds definitions for forms in object page sections to the app schema
+ * @param {SectionType} sectionType - prefix to distinguish Section and HeaderSection
+ * @param {FacetConfig} section - facet or section in the FE core model
+ * @param {object} appSchemaSection - current definition of facet or section in the JSON schema
+ * @param {object} appSchema - app specific schema that gets enhanced
+ * @param {FioriElementsVersion} version - Fiori Elements version
+ */
+export declare function handleForm(sectionType: SectionType, section: FacetConfig, appSchemaSection: Definition, appSchema: Definition, version: FioriElementsVersion, withActions?: boolean): void;
+/**
+ * Replaces an alias in an annotation ID or reference, based on the AVT references' list
+ * @param annotationIdentifier - annotation ID or reference
+ * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
+ * @returns the converted string
+ */
+export declare function replaceAlias(annotationIdentifier: string, oDataServiceAVT: ConvertedMetadata): string;
+/**
+ * Common routine to determine the name and the ID of a header action
+ * @param action - action as given by AVT
+ * @param entityType - entity type by AVT
+ * @returns an object comprising action name and action id
+ */
+export declare function getActionNameAndId(action: string, entityType: EntityType): {
+    actionName: string;
+    actionId: string;
+};
+/**
+ * Add Object Page Footer Action Buttons to app-specific schema
+ *
+ * @param {object} appSchema Schema of the app
+ * @param {EntityType} entityType - current entity type
+ * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
+ */
+export declare function addFooterActions(appSchema: Definition, generateParameters: GenerateAppSchemaParameters): void;
+/**
+ * Add Object Page Header Action Buttons to app-specific schema
+ * @param {object} appSchema Schema of the app
+ * @param {EntityType} entityType - current entity type
+ * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
+ */
+export declare function addHeaderActions(appSchema: Definition, entityType: EntityType, oDataServiceAVT: ConvertedMetadata, addHeaderActionCallBack: any): void;
+/**
+ * Adds common Object Page Header definitions to the app schema
+ * @param appSchema - app-specific JSOn schema
+ * @param entityType - current entity Type
+ */
+export declare function addCommonHeaderSchema(appSchema: Definition, entityType: EntityType): void;
+/**
+ * Common logic to determine the EntitySet of a facet
+ * @param facet - current facet or section
+ * @param serviceAVT - AVT converter output, comprising all annotation information
+ * @returns the entity set as defined in AVT, if found
+ */
+export declare function determineEntitySetOfFacet(facet: FacetConfig, serviceAVT: ConvertedMetadata): EntitySet | undefined;
+//# sourceMappingURL=objectPage.d.ts.map

package/dist/types/sync/common/generate/objectPage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objectPage.d.ts","sourceRoot":"","sources":["../../../../../src/sync/common/generate/objectPage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAI3F,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AACtC,OAAO,EAOH,WAAW,EAMd,MAAM,IAAI,CAAC;AACZ,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,mBAAmB,CAAC;AA8JrE;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,WAAW,EACpB,gBAAgB,EAAE,UAAU,EAC5B,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,oBAAoB,EAC7B,WAAW,UAAO,GACnB,IAAI,CAyEN;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,oBAAoB,EAAE,MAAM,EAAE,eAAe,EAAE,iBAAiB,GAAG,MAAM,CAarG;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAenH;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,UAAU,EAAE,kBAAkB,EAAE,2BAA2B,GAAG,IAAI,CA+D7G;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC5B,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,UAAU,EACtB,eAAe,EAAE,iBAAiB,EAClC,uBAAuB,KAAA,GACxB,IAAI,CAoCN;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI,CAUzF;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,iBAAiB,GAAG,SAAS,GAAG,SAAS,CAMlH"}

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

@@ -0,0 +1,144 @@
+import type { AnnotationTerm, ConvertedMetadata, EntitySet, EntityType } from '@sap-ux/vocabularies-types';
+import type { LineItem } from '@sap-ux/vocabularies-types/vocabularies/UI';
+import type { Definition } from 'typescript-json-schema';
+import type { FacetConfig, FacetSection, SectionType } from '..';
+import type { SectionTypeV2 } from '../../v2/types';
+import type { PresentationVariantV4 } from '../../v4/types';
+import { UIAnnotationTerms } from '@sap-ux/vocabularies-types/vocabularies/UI';
+import { DefinitionName } from '..';
+/**
+ * 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;
+/**
+ * Method adds definition for 'RelatedFacetKeys' as enum with description and adds references to 'RelatedFacetKeys' for custom section definitions.
+ * @param {object} appSchema App specific schema that potentially gets enhanced
+ * @param {string[]>} sectionDefinitions array of section definitions which should be updated with new reference to 'RelatedFacetKeys' enum.
+ * @param {FacetSection[]} facetSections Array of facet section objects which is used to generate enum values.
+ * @param {Array<keyof Omit<FacetSection, 'custom'>>} idProperties Array of property names which should be looked up in 'FacetSection' object.
+ *  Please note that method depends on order and takes first non empty value associated to passed properties.
+ */
+export declare function addDefinitionForRelatedFacetKeys(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;
+/**
+ * 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
+ * @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): {
+    actions: Definition;
+    footerActions: Definition;
+    lineItemPath: string;
+};
+/**
+ * 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=} floorplanSuffix - floorplan specific suffix (optional)
+ */
+export declare function addFieldsType(appSchema: Definition, entityType: EntityType, floorplanSuffix?: string): void;
+export declare enum DataType {
+    String = "String",
+    Rating = "Rating",
+    Progress = "Progress",
+    DataPoint = "DataPoint",
+    Contact = "Contact",
+    Address = "Address",
+    Chart = "Chart",
+    FieldGroup = "FieldGroup",
+    IntentBasedNavigation = "IntentBasedNavigation"
+}
+/**
+ * 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;
+//# sourceMappingURL=utils.d.ts.map

package/dist/types/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,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAC/E,OAAO,EACH,cAAc,EAOjB,MAAM,IAAI,CAAC;AAEZ;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACtC,UAAU,EAAE,UAAU,EACtB,gBAAgB,EAAE,iBAAiB,EAAE,EACrC,QAAQ,EAAE,UAAU,GACrB,IAAI,CAoBN;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,CAUN;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,CAkCN;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;;;;;;;GAOG;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,GACpC;IAAE,OAAO,EAAE,UAAU,CAAC;IAAC,aAAa,EAAE,UAAU,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CA+E1E;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,eAAe,SAAK,GAAG,IAAI,CAyBvG;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,MAAM,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CA0BzE;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAwBnE;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,CAQ9G;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"}

package/dist/types/sync/common/import/utils.d.ts

@@ -0,0 +1,44 @@
+import type { DeprecatedProperties, SyncRule } from '../';
+import type { ExtensionLogger } from '../../../apiTypes';
+import type { Definition } from 'typescript-json-schema';
+/**
+ * Transfers the value of a single manifest setting to the config
+ * @param syncRule - Metadata rule
+ * @param manifestSection - Section in manifest.json
+ * @param propertyKey - Key of the property or setting
+ * @param configPart - Part of the config JSON
+ * @param sectionId - Section or facet ID
+ * @param breadcrumbs - list of breadcrumbs or id's describing the keys of all hierarchy levels
+ */
+export declare function importProperty(syncRule: SyncRule, manifestSection: {}, propertyKey: string, configPart: {
+    [key: string]: any;
+}, sectionId?: string, breadcrumbs?: string[]): void;
+/**
+ * Validation during import: check if properties are marked as deprecated.
+ * If so, log them.
+ * @param deprecatedProperties - existing list, to be actualized
+ * @param manifestSection - Section in manifest.json
+ * @param path - path to the section in manifest
+ * @param {ExtensionLogger} logger - Logger class for logging messages
+ */
+export declare function checkDeprecatedProperties(deprecatedProperties: DeprecatedProperties | undefined, manifestSection: {}, path: string, logger?: ExtensionLogger): void;
+/**
+ * Determines the title of a section representation in the app schema, main aspect is checking the facet ID
+ * @param schemaSection - Section in manifest.json
+ * @param jsonSchema - app specific schema
+ */
+export declare function getSectionTitle(schemaSection: Definition, jsonSchema: Definition): string | undefined;
+/**
+ * Method returns target by resolving custom column reference name.
+ * For example - 'TableCustomColumns<dummyTarget>' is resolved as 'dummyTarget'.
+ * @param {string} ref Reference key.
+ * @returns {string | undefined} Resolved target.
+ */
+export declare function getTargetFromCustomColumnRef(ref: string): string | undefined;
+/**
+ * Removes part of a given config, if empty
+ * @param {object} config - config part
+ * @param {string} structure - part of config to be removed
+ */
+export declare function removeEmptyStructure(config: object, structure: string): void;
+//# sourceMappingURL=utils.d.ts.map

package/dist/types/sync/common/import/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../src/sync/common/import/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC;AAG1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC1B,QAAQ,EAAE,QAAQ,EAClB,eAAe,EAAE,EAAE,EACnB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,EAClC,SAAS,CAAC,EAAE,MAAM,EAClB,WAAW,CAAC,EAAE,MAAM,EAAE,GACvB,IAAI,CAWN;AAED;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CACrC,oBAAoB,EAAE,oBAAoB,GAAG,SAAS,EACtD,eAAe,EAAE,EAAE,EACnB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,eAAe,GACzB,IAAI,CAiBN;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,aAAa,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAarG;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAM5E;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAO5E"}

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

@@ -0,0 +1,15 @@
+import type { ConvertedMetadata, EntitySet } from '@sap-ux/vocabularies-types';
+import type { ImportProjectParameters } from '../../apiTypes';
+import type { File } from './types';
+export declare function getEntitySetByEntitySetName(entitySetName: string, oDataServiceAVT: ConvertedMetadata): EntitySet;
+/**
+ * Import the schema and config files for a given project
+ * @param {ImportProjectParameters} importParameters - files of the project: manifest, flex changes, odata files
+ */
+export declare function importProjectSchema(importProjectParameters: ImportProjectParameters): Promise<File[]>;
+/**
+ * Import the schema and config files for a given project
+ * @param {ImportProjectParameters} importParameters - files of the project: manifest, flex changes, odata files
+ */
+export declare function importProjectSchemaAndConfig(importProjectParameters: ImportProjectParameters): Promise<File[]>;
+//# sourceMappingURL=importProject.d.ts.map

package/dist/types/sync/common/importProject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"importProject.d.ts","sourceRoot":"","sources":["../../../../src/sync/common/importProject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAE/E,OAAO,KAAK,EAAE,uBAAuB,EAA+B,MAAM,gBAAgB,CAAC;AAiB3F,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAoGpC,wBAAgB,2BAA2B,CAAC,aAAa,EAAE,MAAM,EAAE,eAAe,EAAE,iBAAiB,GAAG,SAAS,CAMhH;AA6QD;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,uBAAuB,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAuB3G;AAED;;;GAGG;AACH,wBAAsB,4BAA4B,CAAC,uBAAuB,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAsBpH"}

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

@@ -0,0 +1,8 @@
+export * from './utils';
+export * from './types';
+export * from './decoration';
+export * from './flexUtils';
+export * from './import/utils';
+export * from './generate';
+export { importProjectSchemaAndConfig, importProjectSchema } from './importProject';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/sync/common/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/sync/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,4BAA4B,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC"}

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

@@ -0,0 +1,350 @@
+import type { Manifest } from '../../specification/common/webapp/manifest';
+import type { AnnotationTerm, EntityType } from '@sap-ux/vocabularies-types';
+import type { CollectionFacet, ReferenceFacet, ReferenceURLFacet } from '@sap-ux/vocabularies-types/vocabularies/UI';
+import type { ManifestSettingsType } from '../../specification/common/types';
+export declare type anyFacetType = AnnotationTerm<CollectionFacet> | AnnotationTerm<ReferenceFacet> | AnnotationTerm<ReferenceURLFacet>;
+export declare enum ExportArtifacts {
+    flex = "flex",
+    manifest = "manifest"
+}
+export declare enum ALPViewType {
+    Primary = "primary",
+    Secondary = "secondary"
+}
+export declare enum DirName {
+    Sapux = "src",
+    Schemas = ".schemas",
+    Pages = "pages",
+    Webapp = "webapp",
+    Temp = ".tmp",
+    Changes = "changes",
+    LocalService = "localService",
+    Controller = "controller",
+    View = "view",
+    Fragment = "fragment",
+    Ext = "ext",
+    VSCode = ".vscode"
+}
+export declare enum FileName {
+    App = "app.json"
+}
+export declare const FacetTitlePrefix = "Facet ID: ";
+export declare const ActionTitlePrefix = "Action ID: ";
+export interface ExportResults {
+    flexChanges: string[];
+    manifest: Manifest;
+    fragments: FileData[];
+}
+export declare enum SectionType {
+    Section = "Section",
+    SubSection = "SubSection",
+    HeaderSection = "HeaderSection"
+}
+export declare enum ArtifactType {
+    Manifest = "Manifest",
+    FlexChange = "FlexChange",
+    Annotation = "Annotation"
+}
+export declare enum ControlType {
+    Table = "sap.m.Table",
+    TableColumn = "sap.m.Column",
+    SmartTable = "sap.ui.comp.smarttable.SmartTable",
+    SmartFilterBar = "sap.ui.comp.smartfilterbar.SmartFilterBar",
+    SmartChart = "sap.ui.comp.smartchart.SmartChart",
+    Group = "sap.ui.comp.smartform.Group",
+    GroupElement = "sap.ui.comp.smartform.GroupElement",
+    Button = "sap.m.Button",
+    ToolbarButton = "sap.m.OverflowToolbarButton",
+    Avatar = "sap.f.Avatar",
+    ObjectPageDynamicHeaderTitle = "sap.uxap.ObjectPageDynamicHeaderTitle",
+    ObjectPageGridProperties = "sap.ui.layout.GridData",
+    ObjectPageHeader = "sap.uxap.ObjectPageHeader",
+    ObjectPageLayout = "sap.uxap.ObjectPageLayout",
+    HeaderAction = "sap.uxap.ObjectPageHeaderActionButton",
+    DynamicPage = "sap.f.DynamicPage",
+    Form = "sap.ui.layout.form",
+    Chart = "sap.suite.ui.microchart",
+    Section = "sap.uxap.ObjectPageSection",
+    SubSection = "sap.uxap.ObjectPageSubSection"
+}
+export interface ChangeContent {
+    property: string;
+    newValue?: ManifestSettingsType;
+    newBinding?: string | object;
+}
+/**
+ * Taken over from https://github.com/sap-staging/ui5-flexibility-utils/blob/origin/master/src/changeUtils.js
+ */
+export interface ChangeDefinition {
+    controlId: string;
+    controlType: string;
+    type: string;
+    content: ChangeContent;
+    isCustomer: boolean;
+    sapui5Version: string;
+    creatingTool: string;
+    id: string;
+    reference: string;
+    appVersion: string;
+    creation: string;
+}
+/**
+ * Taken over from https://github.com/sap-staging/ui5-flexibility-utils/blob/origin/master/src/changeUtils.js
+ */
+export interface ChangeDefinitionInCreation {
+    controlId: string;
+    controlType: string;
+    type?: string;
+    content: ChangeContent;
+    isCustomer?: boolean;
+    sapui5Version?: string;
+    creatingTool?: string;
+}
+export declare type CreateFlexChange = (change: ChangeDefinitionInCreation, manifest: Manifest) => string;
+export declare type exportFlexValue = (flexChange: ChangeDefinitionInCreation, configObject: object, key: string) => void;
+export declare type importFlexValue = (flexChange: ChangeDefinitionInCreation, configObject: object, key: string) => void;
+export declare type ControlTypeFunction = () => ControlType;
+export declare type ControlIdFunction = (baseId: string, idBreadcrumbs: string[], breadcrumbs: string[], controlType?: ControlTypeFunction, title?: string) => string;
+export interface FlexAdapter {
+    controlId: ControlIdFunction;
+    controlType: ControlTypeFunction;
+    createFlexChange: CreateFlexChange;
+    exportFlexValue?: exportFlexValue;
+    importFlexValue?: importFlexValue;
+}
+export declare type ManifestPath = (pageKeys?: string[], manifest?: Manifest, ...pathParts: any[]) => string;
+export declare type ExportHandlerFunction = (manifestSection: unknown, configObject: unknown, key: string, manifestKey?: string, ...pathParts: string[]) => unknown;
+export interface ManifestConverter {
+    path: ManifestPath;
+    key?: string;
+    import?: ((manifestSection: unknown, sectionId?: string, propertyKey?: string, breadcrumbs?: string[]) => unknown) | boolean;
+    export?: ExportHandlerFunction | boolean;
+    delete?: ((manifestSection: unknown, configObject: unknown, key: string, manifestKey: string, syncRuleKey?: string) => unknown) | boolean;
+}
+export interface SyncRule {
+    flex?: FlexAdapter;
+    manifest?: ManifestConverter;
+    generate?: (schema: object, definition: object, propertyName: string) => unknown;
+}
+export interface Content {
+    property: string;
+    oldValue?: ManifestSettingsType;
+    newValue: ManifestSettingsType;
+}
+export interface Selector {
+    id: string;
+    type: string;
+    idIsLocal?: boolean;
+}
+export interface PageLayoutInformation {
+    id: string;
+    pageId: string;
+}
+export interface FakeLRepSettings {
+    isKeyUser: boolean;
+    isAtoAvailable: boolean;
+    isProductiveSystem: boolean;
+}
+export interface ValidityInformation {
+    since: string;
+    deprecated?: Deprecated;
+}
+export interface DeprecatedProperties {
+    [key: string]: ValidityInformation;
+}
+export interface Deprecated {
+    since: string;
+    text?: string;
+}
+export interface FileData {
+    dataSourceUri: string;
+    fileContent: string;
+}
+export declare enum Visualization {
+    LineItem = "LineItem",
+    Chart = "Chart"
+}
+export declare enum FacetBase {
+    LineItem = "LineItem",
+    CollectionFacet = "CollectionFacet",
+    Chart = "Chart",
+    Form = "Form",
+    Identification = "Identification",
+    DataPoint = "DataPoint",
+    Address = "Address",
+    Contact = "Contact",
+    PresentationVariant = "PresentationVariant",
+    Unknown = ""
+}
+export interface FacetConfig {
+    base: FacetBase;
+    lineItem?: string[];
+    Label?: string;
+    ID?: string;
+    entityType?: EntityType;
+    annotationPath?: string;
+    target?: object;
+    facets?: FacetConfigs;
+}
+export interface SubSectionConfig {
+    base: FacetBase;
+    Label?: string;
+    ID?: string;
+    facets: FacetConfigs;
+    annotationPath?: string;
+    entityType?: EntityType;
+    target?: object;
+}
+export interface FacetConfigs {
+    [key: string]: FacetConfig | SubSectionConfig;
+}
+export interface File {
+    dataSourceUri: string;
+    fileContent: string;
+}
+export interface Files {
+    [name: string]: object;
+}
+export interface FacetSection {
+    key: string;
+    label?: string;
+    ID?: string;
+    custom?: boolean;
+    entityType?: EntityType;
+}
+export interface SchemaFilePath {
+    filename: string;
+    path: string;
+}
+export interface ObjectPageSectionData {
+    target: string;
+    key?: string;
+}
+export declare const BindingPropertyRegexAsString = "^{[A-Za-z0-9{}&$!@#%? _|,<>'()[\\]\\/:=.]+}$";
+export declare enum ViewTemplateType {
+    ResponsiveTableColumnsExtension = "ResponsiveTableColumnsExtension",
+    AnalyticalTableColumnsExtension = "AnalyticalTableColumnsExtension",
+    TreeTableColumnsExtension = "TreeTableColumnsExtension",
+    GridTableColumnsExtension = "GridTableColumnsExtension",
+    ResponsiveTableCellsExtension = "ResponsiveTableCellsExtension"
+}
+export declare enum DefinitionName {
+    Action = "Action",
+    Actions = "Actions",
+    ActionsLR = "Actions<LineItems>",
+    ALPChart = "ALPChart",
+    ALPChartView = "ALPChartView",
+    ALPTable = "ALPTable",
+    ALPTableView = "ALPTableView",
+    AnalyticalListPageFilterBar = "AnalyticalListPageFilterBar",
+    AnnotationPathAsObject = "AnnotationPathAsObject",
+    ChartToolBarAction = "ChartToolBarAction",
+    CommonHeaderFacetSettings = "CommonHeaderFacetSettings",
+    CustomColumn = "TableCustomColumn",
+    CustomColumnOP = "TableCustomColumnOP",
+    CustomColumns = "TableCustomColumns",
+    CustomSections = "CustomSections",
+    FieldPath = "FieldPath",
+    Field = "Field",
+    Fields = "Fields",
+    Fields4Dialog = "Fields4Dialog",
+    FilterBar = "FilterBar",
+    Footer = "Footer",
+    FooterAction = "FooterAction",
+    FooterActions = "FooterActions",
+    FooterActionsLR = "FooterActions<LineItems>",
+    Form = "Form",
+    FormAction = "FormAction",
+    GenericActions = "GenericActions",
+    GenericColumnsOP = "GenericColumnsOP",
+    GenericFooter = "GenericFooter",
+    GenericSections = "GenericSections",
+    HeaderActions = "HeaderActions",
+    HeaderSections = "HeaderSections",
+    LineItems = "LineItems",
+    LineItemsOfView = "LineItemsOfView",
+    ListReportFilterBar = "ListReportFilterBar",
+    LRTableView = "LRTableView",
+    LRChartView = "LRChartView",
+    MultiTableModeV4 = "MultiTableModeV4",
+    ObjectPageChart = "ObjectPageChart",
+    ObjectPageCustomSectionFragment = "ObjectPageCustomSectionFragment",
+    ObjectPageFooter = "ObjectPageFooter",
+    ObjectPageFooterAction = "ObjectPageFooterAction",
+    ObjectPageFooterActions = "ObjectPageFooterActions",
+    ObjectPageHeader = "ObjectPageHeader",
+    ObjectPageHeaderSectionForm = "ObjectPageHeaderSectionForm",
+    ObjectPageHeaderSectionChart = "ObjectPageHeaderSectionChart",
+    ObjectPageHeaderSectionDataPoint = "ObjectPageHeaderSectionDataPoint",
+    ObjectPageHeaderSectionContact = "ObjectPageHeaderSectionContact",
+    ObjectPageHeaderSectionAddress = "ObjectPageHeaderSectionAddress",
+    ObjectPageLayout = "ObjectPageLayout",
+    ObjectPagePresentationVariant = "ObjectPagePresentationVariant",
+    ObjectPageSectionAddress = "ObjectPageSectionAddress",
+    ObjectPageSectionChart = "ObjectPageSectionChart",
+    ObjectPageSectionContact = "ObjectPageSectionContact",
+    ObjectPageSectionDataPoint = "ObjectPageSectionDataPoint",
+    ObjectPageSectionForm = "ObjectPageSectionForm",
+    ObjectPageSectionPresentationVariant = "ObjectPageSectionPresentationVariant",
+    ObjectPageSectionTableV4 = "ObjectPageSectionTableV4",
+    ObjectPageSubSections = "ObjectPageSubSections",
+    ObjectPageTable = "ObjectPageTable",
+    ObjectPageTableColumn = "ObjectPageTableColumn",
+    ObjectPageToolBar = "ObjectPageToolBar",
+    ObjectPageToolBarAction = "ObjectPageToolBarAction",
+    ObjectPageToolBarActions = "ObjectPageToolBarActions",
+    Position = "Position",
+    PositionOP = "PositionOP",
+    QuickVariant = "QuickVariant",
+    QuickVariantSelectionOP = "QuickVariantSelectionOP",
+    QuickVariantSelectionV4OP = "QuickVariantSelectionV4OP",
+    RelatedFacetKeys = "RelatedFacetKeys",
+    Sections = "Sections",
+    SelectionFields = "SelectionFields",
+    Table = "Table",
+    TableSPV = "TableSPV",
+    TableColumn = "TableColumn",
+    TableViewExtension = "TableViewExtension",
+    ToolBarAction = "ToolBarAction",
+    ToolBarLR = "ToolBar<LineItems>",
+    ToolBar = "ToolBar",
+    ViewTableColumn = "ViewTableColumn",
+    ViewCustomColumn = "ViewTableCustomColumn",
+    ViewChartToolBar = "ViewChartToolBar",
+    ViewToolBarAction = "ViewToolBarAction",
+    ViewPosition = "ViewPosition"
+}
+export declare enum PropertyName {
+    actions = "actions",
+    annotationPath = "annotationPath",
+    chart = "chart",
+    defaultPath = "defaultPath",
+    defaultTemplateAnnotationPath = "defaultTemplateAnnotationPath",
+    sections = "sections",
+    table = "table",
+    views = "views"
+}
+export declare enum SchemaTag {
+    annotationPath = "annotationPath",
+    annotationType = "annotationType",
+    artifactType = "artifactType",
+    controlType = "controlType",
+    dataType = "dataType",
+    fullyQualifiedName = "fullyQualifiedName",
+    hidden = "hidden",
+    isViewNode = "isViewNode",
+    key = "key",
+    propertyIndex = "propertyIndex"
+}
+export declare const METADATAPATH = "webapp/localService/metadata.xml";
+export declare const MANIFESTPATH = "webapp/manifest.json";
+export declare const VOCWITHSLASH = "/@com.sap.vocabularies";
+export declare const VOCWITHCOLONS = "::@com.sap.vocabularies";
+export declare const UIVOCABULARY = "com.sap.vocabularies.UI.v1";
+export declare const UIVOCABULARYDOT = "com.sap.vocabularies.UI.v1.";
+export declare const UIVOCABULARYALPHADOT = "@com.sap.vocabularies.UI.v1.";
+export declare const QUICKVARPATH = "/quickVariantSelection";
+export declare const QUICKVARPATHX = "/quickVariantSelectionX";
+export declare const DATESETTINGSPATH = "/filterSettings/dateSettings";
+export declare const FRAGMENTNAMEPART = ".fragment.";
+//# sourceMappingURL=types.d.ts.map