fix: type mismatch (#900)

* fix: type mismatch * chore: fix lint error * chore: fix lint error * chore: remove autogenerated comments * chore: add changesets
SAP · Dec 5, 2024 · d581d62 · d581d62
1 parent c499009
commit d581d62
Show file tree

Hide file tree

Showing 7 changed files with 64 additions and 16 deletions.
diff --git a/.changeset/angry-berries-cheer.md b/.changeset/angry-berries-cheer.md
@@ -0,0 +1,5 @@
+---
+'@sap-ux/vocabularies-types': patch
+---
+
+Export `ArrayWithType` type definition.
diff --git a/.changeset/many-lemons-cheat.md b/.changeset/many-lemons-cheat.md
@@ -0,0 +1,6 @@
+---
+'@sap-ux/annotation-converter': minor
+'@sap-ux/edmx-parser': minor
+---
+
+**BREAKING CHANGE**: parser and writeback no longer incorrectly convert string Collections entries as `string`. Now returned values correctly match the `StringExpression` type and function signatures.
diff --git a/packages/annotation-converter/src/writeback.ts b/packages/annotation-converter/src/writeback.ts
@@ -7,7 +7,8 @@ import type {
     PathExpression,
     PropertyPathExpression,
     RawAnnotation,
-    Reference
+    Reference,
+    StringExpression
 } from '@sap-ux/vocabularies-types';
 import { unalias } from './utils';
 
@@ -213,14 +214,17 @@ function revertCollectionItemToRawType(
     collectionItem: any
 ):
     | AnnotationRecord
-    | string
+    | StringExpression
     | PropertyPathExpression
     | PathExpression
     | NavigationPropertyPathExpression
     | AnnotationPathExpression
     | undefined {
     if (typeof collectionItem === 'string') {
-        return collectionItem;
+        return {
+            type: 'String',
+            String: collectionItem
+        };
     } else if (typeof collectionItem === 'object') {
         if (collectionItem.hasOwnProperty('$Type')) {
             // Annotation Record

diff --git a/packages/annotation-converter/test/__snapshots__/writeback.spec.ts.snap b/packages/annotation-converter/test/__snapshots__/writeback.spec.ts.snap
@@ -1890,7 +1890,10 @@ exports[`Writeback capabilities can revert further SideEffects definition 1`] =
         "name": "TargetProperties",
         "value": {
           "Collection": [
-            "WarrantyYear",
+            {
+              "String": "WarrantyYear",
+              "type": "String",
+            },
           ],
           "type": "Collection",
         },

diff --git a/packages/edmx-parser/src/parser.ts b/packages/edmx-parser/src/parser.ts
@@ -4,6 +4,7 @@ import type {
     AnnotationList,
     AnnotationPathExpression,
     AnnotationRecord,
+    ArrayWithType,
     Expression,
     FullyQualifiedName,
     NavigationPropertyPathExpression,
@@ -705,9 +706,14 @@ function parseCollection(
         (navPropertyPathArray as any).type = 'NavigationPropertyPath';
         return navPropertyPathArray;
     } else if (isExpressionOfType<EDMX.StringCollectionWrapper>(collection, 'String')) {
-        const stringArray = ensureArray(collection.String).map((stringValue) => stringValue._text);
-        (stringArray as any).type = 'String';
-        return stringArray as unknown as StringExpression[];
+        const stringArray: ArrayWithType<StringExpression, 'String'> = ensureArray(collection.String).map(
+            (stringValue): StringExpression => ({
+                type: 'String',
+                String: stringValue._text
+            })
+        );
+        stringArray.type = 'String';
+        return stringArray;
     } else if (isExpressionOfType<EDMX.AnnotationPathCollectionWrapper>(collection, 'AnnotationPath')) {
         const annotationPathArray = ensureArray(collection.AnnotationPath).map(
             (annotationPath) => parseModelPath(annotationPath, 'AnnotationPath') as AnnotationPathExpression

diff --git a/packages/edmx-parser/test/__snapshots__/parser.spec.ts.snap b/packages/edmx-parser/test/__snapshots__/parser.spec.ts.snap
@@ -13425,7 +13425,10 @@ RawMetadataInstance {
             },
             {
               "collection": [
-                "SEPMRA_PROD_MAN.SEPMRA_PROD_MAN_Entities/SEPMRA_C_PD_Product",
+                {
+                  "String": "SEPMRA_PROD_MAN.SEPMRA_PROD_MAN_Entities/SEPMRA_C_PD_Product",
+                  "type": "String",
+                },
               ],
               "qualifier": undefined,
               "term": "com.sap.vocabularies.Common.v1.DraftActivationVia",
@@ -13566,7 +13569,10 @@ RawMetadataInstance {
             },
             {
               "collection": [
-                "SEPMRA_PROD_MAN.SEPMRA_PROD_MAN_Entities/SEPMRA_C_PD_Product",
+                {
+                  "String": "SEPMRA_PROD_MAN.SEPMRA_PROD_MAN_Entities/SEPMRA_C_PD_Product",
+                  "type": "String",
+                },
               ],
               "qualifier": undefined,
               "term": "com.sap.vocabularies.Common.v1.DraftActivationVia",
@@ -28808,7 +28814,10 @@ RawMetadataInstance {
             },
             {
               "collection": [
-                "SEPMRA_PROD_MAN.SEPMRA_PROD_MAN_Entities/SEPMRA_C_PD_Product",
+                {
+                  "String": "SEPMRA_PROD_MAN.SEPMRA_PROD_MAN_Entities/SEPMRA_C_PD_Product",
+                  "type": "String",
+                },
               ],
               "qualifier": undefined,
               "term": "com.sap.vocabularies.Common.v1.DraftActivationVia",
@@ -28843,7 +28852,10 @@ RawMetadataInstance {
             },
             {
               "collection": [
-                "SEPMRA_PROD_MAN.SEPMRA_PROD_MAN_Entities/SEPMRA_C_PD_Product",
+                {
+                  "String": "SEPMRA_PROD_MAN.SEPMRA_PROD_MAN_Entities/SEPMRA_C_PD_Product",
+                  "type": "String",
+                },
               ],
               "qualifier": undefined,
               "term": "com.sap.vocabularies.Common.v1.DraftActivationVia",
@@ -35603,7 +35615,10 @@ RawMetadataInstance {
           "annotations": [
             {
               "collection": [
-                undefined,
+                {
+                  "String": undefined,
+                  "type": "String",
+                },
               ],
               "qualifier": undefined,
               "term": "com.sap.vocabularies.Common.v1.ValueListRelevantQualifiers",
@@ -111901,9 +111916,18 @@ RawMetadataInstance {
                     "name": "Transformations",
                     "value": {
                       "Collection": [
-                        "aggregate",
-                        "groupby",
-                        "filter",
+                        {
+                          "String": "aggregate",
+                          "type": "String",
+                        },
+                        {
+                          "String": "groupby",
+                          "type": "String",
+                        },
+                        {
+                          "String": "filter",
+                          "type": "String",
+                        },
                       ],
                       "type": "Collection",
                     },

diff --git a/packages/vocabularies-types/src/BaseEdm.ts b/packages/vocabularies-types/src/BaseEdm.ts
@@ -6,7 +6,7 @@ type GenericExpression<K extends keyof any, T> = {
 } & {
     type: K;
 };
-type ArrayWithType<T, K> = T[] & { type?: K };
+export type ArrayWithType<T, K> = T[] & { type?: K };
 
 export type Apply = any;
 export type If = any;