fix: receiving and returning StorePropertyValue now works correctly

packages/api/src/platforms/vtex/clients/commerce/types/OrderForm.ts

@@ -54,6 +54,7 @@ export interface OrderFormItem {
     sellingPrices: SellingPrice[]
     total: number
   }
+  attachments: Attachment[]
 }
 
 export interface SKUSpecification {

packages/api/src/platforms/vtex/index.ts

@@ -13,6 +13,7 @@ import { Query } from './resolvers/query'
 import { StoreReview } from './resolvers/review'
 import { StoreSearchResult } from './resolvers/searchResult'
 import { StoreSeo } from './resolvers/seo'
+import { ObjectOrString } from './resolvers/objectOrString'
 import type { Loaders } from './loaders'
 import type { Clients } from './clients'
 import type { Channel } from './utils/channel'
@@ -67,6 +68,7 @@ const Resolvers = {
   StoreReview,
   StoreProductGroup,
   StoreSearchResult,
+  ObjectOrString,
   Query,
   Mutation,
 }

packages/api/src/platforms/vtex/resolvers/objectOrString.ts

@@ -0,0 +1,46 @@
+import type { GraphQLScalarSerializer } from 'graphql'
+import { GraphQLScalarType } from 'graphql'
+import { Kind } from 'graphql/language'
+
+export const ObjectOrString = new GraphQLScalarType({
+  name: 'ObjectOrString',
+  description:
+    'A string or the string representation of an object (a stringified object).',
+  parseValue: toObjectOrString,
+  serialize: stringify,
+  parseLiteral(ast) {
+    if (ast.kind === Kind.STRING) {
+      try {
+        return JSON.parse(ast.value)
+      } catch (e) {
+        return ast.value
+      }
+    }
+
+    return null
+  },
+})
+
+function toObjectOrString(value: GraphQLScalarSerializer<any>) {
+  if (typeof value === 'string') {
+    try {
+      return JSON.parse(value)
+    } catch (e) {
+      return value
+    }
+  }
+
+  return null
+}
+
+function stringify(value: GraphQLScalarSerializer<any>) {
+  if (typeof value === 'object') {
+    return JSON.stringify(value)
+  }
+
+  if (typeof value === 'string') {
+    return value
+  }
+
+  return null
+}

packages/api/src/platforms/vtex/resolvers/offer.ts

@@ -96,7 +96,17 @@ export const StoreOffer: Record<string, Resolver<Root>> = {
 
     return null
   },
-  itemOffered: ({ product }) => product,
+  itemOffered: async (root) => {
+    if (isSearchItem(root)) {
+      return root.product
+    }
+
+    if (isOrderFormItem(root)) {
+      return { ...(await root.product), attachmentsValues: root.attachments }
+    }
+
+    return null
+  },
   quantity: (root) => {
     if (isSearchItem(root)) {
       return root.AvailableQuantity ?? 0

packages/api/src/platforms/vtex/resolvers/product.ts

@@ -9,12 +9,10 @@ import type { Attachment } from '../clients/commerce/types/OrderForm'
 
 type QueryProduct = PromiseType<ReturnType<typeof Query.product>>
 
-type Root = Omit<QueryProduct, 'attachments'> & {
-  attachments: AttachmentDefinition[] | Attachment[]
+type Root = QueryProduct & {
+  attachmentsValues?: Attachment[]
 }
 
-type AttachmentDefinition = QueryProduct['attachments'][number]
-
 const DEFAULT_IMAGE = {
   imageText: 'image',
   imageUrl:
@@ -26,10 +24,6 @@ const getPath = (link: string, id: string) => `/${getSlug(link, id)}/p`
 const nonEmptyArray = <T>(array: T[] | null | undefined) =>
   Array.isArray(array) && array.length > 0 ? array : null
 
-const isAttachmentDefinition = (
-  attachment: Root['attachments'][number]
-): attachment is AttachmentDefinition => 'id' in attachment
-
 export const StoreProduct: Record<string, Resolver<Root>> & {
   offers: Resolver<
     Root,
@@ -94,7 +88,7 @@ export const StoreProduct: Record<string, Resolver<Root>> & {
       )
       .sort(bestOfferFirst),
   isVariantOf: (root) => root,
-  additionalProperty: ({ variations = [], attachments }) => {
+  additionalProperty: ({ variations = [], attachmentsValues }) => {
     const propertyValueVariations = variations.flatMap(({ name, values }) =>
       values.map((value) => ({
         name,
@@ -103,22 +97,13 @@ export const StoreProduct: Record<string, Resolver<Root>> & {
       }))
     )
 
-    // Typescript don't understand (A[] | B[]) as an array, only Array<A | B>
-    const propertyValueAttachments = (attachments as Array<
-      Root['attachments'][number]
-    >)
-      .map((attachment: Root['attachments'][number]) => {
-        if (isAttachmentDefinition(attachment)) {
-          return
-        }
-
-        return {
-          name: attachment.name,
-          value: attachment.content,
-          valueReference: VALUE_REFERENCES.attachment,
-        }
+    const propertyValueAttachments = (attachmentsValues ?? []).map(
+      (attachment) => ({
+        name: attachment.name,
+        value: attachment.content,
+        valueReference: VALUE_REFERENCES.attachment,
       })
-      .filter(Boolean)
+    )
 
     return [...propertyValueVariations, ...propertyValueAttachments]
   },

packages/api/src/typeDefs/index.ts

@@ -22,6 +22,7 @@ import Cart from './cart.graphql'
 import Status from './status.graphql'
 import PropertyValue from './propertyValue.graphql'
 import Person from './person.graphql'
+import ObjectOrString from './objectOrString.graphql'
 
 export const typeDefs = [
   Query,
@@ -46,6 +47,7 @@ export const typeDefs = [
   Status,
   PropertyValue,
   Person,
+  ObjectOrString,
 ]
   .map(print)
   .join('\n')

packages/api/src/typeDefs/objectOrString.graphql

@@ -0,0 +1 @@
+scalar ObjectOrString

packages/api/src/typeDefs/propertyValue.graphql

@@ -3,38 +3,30 @@ Properties that can be associated with products and products groups.
 """
 type StorePropertyValue {
   """
-  Property value.
+  Property value. May hold a string or the string representation of an object.
   """
-  value: String!
+  value: ObjectOrString!
   """
   Property name.
   """
   name: String!
   """
-  Property value reference.
+  Specifies the nature of the value
   """
-  valueReference: ValueReference!
+  valueReference: String!
 }
 
-enum ValueReference {
-  ATTRIBUTE
-  ATTACHMENT
-  PROPERTY
-}
-
-scalar Object
-
 input IStorePropertyValue {
   """
-  Property value.
+  Property value. May hold a string or the string representation of an object.
   """
-  value: Object!
+  value: ObjectOrString!
   """
   Property name.
   """
   name: String!
   """
-  Property value reference.
+  Specifies the nature of the value
   """
-  valueReference: ValueReference!
+  valueReference: String!
 }