Fix Metafield generated type (#978)

* Merge equal fragment interfaces * Changesets * Fix tests
Shopify · Jun 6, 2023 · d3817b9 · d3817b9
1 parent b9ab8eb
commit d3817b9
Show file tree

Hide file tree

Showing 4 changed files with 100 additions and 246 deletions.
diff --git a/.changeset/shiny-days-search.md b/.changeset/shiny-days-search.md
@@ -0,0 +1,5 @@
+---
+'@shopify/hydrogen-codegen': patch
+---
+
+Merge equal fragment interfaces in one to avoid adding `| {}` to the Metaobject types.
diff --git a/packages/hydrogen-codegen/src/preset.ts b/packages/hydrogen-codegen/src/preset.ts
@@ -110,6 +110,7 @@ export const preset: Types.OutputPreset<HydrogenPresetConfig> = {
         [`typescript-operations`]: {
           useTypeImports: true, // Use `import type` instead of `import`
           preResolveTypes: false, // Use Pick<...> instead of primitives
+          mergeFragmentTypes: true, // Merge equal fragment interfaces. Avoids adding `| {}` to Metaobject
           skipTypename: options.presetConfig.skipTypenameInOperations ?? true, // Skip __typename fields
           namespacedImportName: importTypes ? namespacedImportName : undefined,
         },

diff --git a/packages/hydrogen-codegen/tests/codegen.test.ts b/packages/hydrogen-codegen/tests/codegen.test.ts
@@ -153,15 +153,15 @@ describe('Hydrogen Codegen', async () => {
             { __typename: 'Video' }
             & Pick<StorefrontAPI.Video, 'id' | 'mediaContentType' | 'alt'>
             & { sources: Array<Pick<StorefrontAPI.VideoSource, 'mimeType' | 'url'>>, previewImage?: StorefrontAPI.Maybe<Pick<StorefrontAPI.Image, 'url'>> }
-          ) | {}> }>, spreadSecondary?: StorefrontAPI.Maybe<{ reference?: StorefrontAPI.Maybe<(
+          )> }>, spreadSecondary?: StorefrontAPI.Maybe<{ reference?: StorefrontAPI.Maybe<(
             { __typename: 'MediaImage' }
             & Pick<StorefrontAPI.MediaImage, 'id' | 'mediaContentType' | 'alt'>
             & { image?: StorefrontAPI.Maybe<Pick<StorefrontAPI.Image, 'url' | 'width' | 'height'>>, previewImage?: StorefrontAPI.Maybe<Pick<StorefrontAPI.Image, 'url'>> }
           ) | (
             { __typename: 'Video' }
             & Pick<StorefrontAPI.Video, 'id' | 'mediaContentType' | 'alt'>
             & { sources: Array<Pick<StorefrontAPI.VideoSource, 'mimeType' | 'url'>>, previewImage?: StorefrontAPI.Maybe<Pick<StorefrontAPI.Image, 'url'>> }
-          ) | {}> }> }
+          )> }> }
       );
 
       export type CollectionContentTestQueryVariables = StorefrontAPI.Exact<{
@@ -181,15 +181,15 @@ describe('Hydrogen Codegen', async () => {
               { __typename: 'Video' }
               & Pick<StorefrontAPI.Video, 'id' | 'mediaContentType' | 'alt'>
               & { sources: Array<Pick<StorefrontAPI.VideoSource, 'mimeType' | 'url'>>, previewImage?: StorefrontAPI.Maybe<Pick<StorefrontAPI.Image, 'url'>> }
-            ) | {}> }>, spreadSecondary?: StorefrontAPI.Maybe<{ reference?: StorefrontAPI.Maybe<(
+            )> }>, spreadSecondary?: StorefrontAPI.Maybe<{ reference?: StorefrontAPI.Maybe<(
               { __typename: 'MediaImage' }
               & Pick<StorefrontAPI.MediaImage, 'id' | 'mediaContentType' | 'alt'>
               & { image?: StorefrontAPI.Maybe<Pick<StorefrontAPI.Image, 'url' | 'width' | 'height'>>, previewImage?: StorefrontAPI.Maybe<Pick<StorefrontAPI.Image, 'url'>> }
             ) | (
               { __typename: 'Video' }
               & Pick<StorefrontAPI.Video, 'id' | 'mediaContentType' | 'alt'>
               & { sources: Array<Pick<StorefrontAPI.VideoSource, 'mimeType' | 'url'>>, previewImage?: StorefrontAPI.Maybe<Pick<StorefrontAPI.Image, 'url'>> }
-            ) | {}> }> }
+            )> }> }
         )>, shop: Pick<StorefrontAPI.Shop, 'name' | 'description'> };
 
       interface GeneratedQueryTypes {