@graphcommerce/magento-graphql 8.1.0-canary.9 → 9.0.0-canary.101

package/CHANGELOG.md

@@ -1,5 +1,199 @@
 # Change Log
 
+## 9.0.0-canary.101
+
+## 9.0.0-canary.100
+
+## 9.0.0-canary.99
+
+### Minor Changes
+
+- [#2416](https://github.com/graphcommerce-org/graphcommerce/pull/2416) [`651eea0`](https://github.com/graphcommerce-org/graphcommerce/commit/651eea0bdda1ed0f46f4c73d7edf52c8c1da5b54) - Created a new field for products: `custom_attribute(attribute_code: "attribute_code")` to retrieve attribute option value labels. This field is only available in Magento 2.4.7 and up. ([@paales](https://github.com/paales))
+
+- [#2416](https://github.com/graphcommerce-org/graphcommerce/pull/2416) [`53af256`](https://github.com/graphcommerce-org/graphcommerce/commit/53af25671d3aca7f3daa2dd45ccd2237697e9254) - Added an `attribute`-field to `AttributeValueInterface` to be able to retrieve attribute metadata from the value of an attribute. ([@paales](https://github.com/paales))
+
+## 9.0.0-canary.98
+
+## 9.0.0-canary.97
+
+## 9.0.0-canary.96
+
+## 9.0.0-canary.95
+
+## 9.0.0-canary.94
+
+## 9.0.0-canary.93
+
+## 9.0.0-canary.92
+
+## 9.0.0-canary.91
+
+## 9.0.0-canary.90
+
+## 9.0.0-canary.89
+
+## 9.0.0-canary.88
+
+## 9.0.0-canary.87
+
+## 9.0.0-canary.86
+
+## 9.0.0-canary.85
+
+## 9.0.0-canary.84
+
+## 9.0.0-canary.83
+
+## 9.0.0-canary.82
+
+## 9.0.0-canary.81
+
+## 9.0.0-canary.80
+
+## 9.0.0-canary.79
+
+## 9.0.0-canary.78
+
+## 9.0.0-canary.77
+
+## 9.0.0-canary.76
+
+## 9.0.0-canary.75
+
+## 9.0.0-canary.74
+
+## 9.0.0-canary.73
+
+## 9.0.0-canary.72
+
+## 9.0.0-canary.71
+
+## 9.0.0-canary.70
+
+## 9.0.0-canary.69
+
+## 9.0.0-canary.68
+
+## 9.0.0-canary.67
+
+## 9.0.0-canary.66
+
+## 9.0.0-canary.65
+
+## 9.0.0-canary.64
+
+## 9.0.0-canary.63
+
+## 9.0.0-canary.62
+
+## 9.0.0-canary.61
+
+## 9.0.0-canary.60
+
+## 9.0.0-canary.59
+
+## 9.0.0-canary.58
+
+## 9.0.0-canary.57
+
+## 9.0.0-canary.56
+
+## 9.0.0-canary.55
+
+## 9.0.0-canary.54
+
+## 8.1.0-canary.53
+
+## 8.1.0-canary.52
+
+## 8.1.0-canary.51
+
+## 8.1.0-canary.50
+
+## 8.1.0-canary.49
+
+## 8.1.0-canary.48
+
+## 8.1.0-canary.47
+
+## 8.1.0-canary.46
+
+## 8.1.0-canary.45
+
+## 8.1.0-canary.44
+
+## 8.1.0-canary.43
+
+## 8.1.0-canary.42
+
+## 8.1.0-canary.41
+
+## 8.1.0-canary.40
+
+## 8.1.0-canary.39
+
+## 8.1.0-canary.38
+
+## 8.1.0-canary.37
+
+## 8.1.0-canary.36
+
+## 8.1.0-canary.35
+
+## 8.1.0-canary.34
+
+## 8.1.0-canary.33
+
+## 8.1.0-canary.32
+
+### Patch Changes
+
+- [#2299](https://github.com/graphcommerce-org/graphcommerce/pull/2299) [`c6ac45b`](https://github.com/graphcommerce-org/graphcommerce/commit/c6ac45b8ff41dcaa47f1e5d40d04e120990870aa) - Added a magentoVersion configuration value to be able to differentiate features based on the Magento version ([@paales](https://github.com/paales))
+
+## 8.1.0-canary.31
+
+## 8.1.0-canary.30
+
+## 8.1.0-canary.29
+
+## 8.1.0-canary.28
+
+## 8.1.0-canary.27
+
+## 8.1.0-canary.26
+
+## 8.1.0-canary.25
+
+## 8.1.0-canary.24
+
+## 8.1.0-canary.23
+
+## 8.1.0-canary.22
+
+## 8.1.0-canary.21
+
+## 8.1.0-canary.20
+
+## 8.1.0-canary.19
+
+## 8.1.0-canary.18
+
+## 8.1.0-canary.17
+
+## 8.1.0-canary.16
+
+## 8.1.0-canary.15
+
+## 8.1.0-canary.14
+
+## 8.1.0-canary.13
+
+## 8.1.0-canary.12
+
+## 8.1.0-canary.11
+
+## 8.1.0-canary.10
+
 ## 8.1.0-canary.9
 
 ## 8.1.0-canary.8

package/Config.graphqls

@@ -6,6 +6,13 @@ extend input GraphCommerceConfig {
   - https://magento2.test/graphql
   """
   magentoEndpoint: String!
+
+  """
+  Version of the Magento backend.
+
+  Values: 245, 246, 247 for Magento 2.4.5, 2.4.6, 2.4.7 respectively.
+  """
+  magentoVersion: Int!
 }
 
 extend input GraphCommerceStorefrontConfig {

package/graphqlErrorByCategory.ts

@@ -1,5 +1,5 @@
 import { ApolloError } from '@graphcommerce/graphql'
-import type { GraphQLError } from 'graphql'
+import type { GraphQLError, GraphQLFormattedError } from 'graphql'
 
 export type ErrorCategory =
   | 'internal'
@@ -28,14 +28,15 @@ export type GraphQLErrorByCategoryPropsNoExtract = Omit<GraphQLErrorByCategoryPr
  */
 export function graphqlErrorByCategory(
   props: GraphQLErrorByCategoryPropsNoExtract,
-): [ApolloError, GraphQLError | undefined]
+): [ApolloError, GraphQLFormattedError | undefined]
 export function graphqlErrorByCategory(
   props: GraphQLErrorByCategoryProps,
-): [ApolloError | undefined, GraphQLError | undefined]
+): [ApolloError | undefined, GraphQLFormattedError | undefined]
 export function graphqlErrorByCategory(
   props: GraphQLErrorByCategoryProps | GraphQLErrorByCategoryPropsNoExtract,
-): [ApolloError | undefined, GraphQLError | undefined] {
+): [ApolloError | undefined, GraphQLFormattedError | undefined] {
   const { category, error, extract = true, mask } = props
+
   if (!error) return [error, undefined]
 
   const newError = new ApolloError({
@@ -45,10 +46,9 @@ export function graphqlErrorByCategory(
     ),
   })
 
-  const graphqlError = error.graphQLErrors.find((err) => err?.extensions?.category === category)
+  let graphqlError = error.graphQLErrors.find((err) => err?.extensions?.category === category)
   if (mask && graphqlError) {
-    if (graphqlError.extensions?.category) graphqlError.extensions.category = 'masked'
-    graphqlError.message = mask
+    graphqlError = { ...graphqlError, message: mask }
   }
 
   return newError.graphQLErrors.length === 0 && !newError.networkError

package/mesh/attributeValueResolver.ts

@@ -0,0 +1,31 @@
+import fragments from '@graphcommerce/graphql/generated/fragments.json'
+import type {
+  AttributeValueInterfaceResolvers,
+  MeshContext,
+  Resolvers,
+} from '@graphcommerce/graphql-mesh'
+import { customAttributeMetadataV2 } from './customAttributeMetadataV2'
+
+type AttributeValueResolver = Pick<AttributeValueInterfaceResolvers<MeshContext>, 'attribute'>
+
+const attributeValueResolver: AttributeValueResolver = {
+  attribute: {
+    selectionSet: `{ code }`,
+    resolve: async (root, _, context) =>
+      root.attribute ??
+      (await customAttributeMetadataV2(
+        { attribute_code: root.code, entity_type: 'catalog_product' },
+        context,
+      )),
+  },
+}
+
+type AttributeValueTypes = NonNullable<
+  Awaited<ReturnType<AttributeValueInterfaceResolvers['__resolveType']>>
+>
+const attributeValueTypes = fragments.possibleTypes.AttributeValueInterface as AttributeValueTypes[]
+const resolvers: Resolvers = {}
+attributeValueTypes.forEach((attributeValueType) => {
+  if (!resolvers[attributeValueType]) resolvers[attributeValueType] = attributeValueResolver
+})
+export default resolvers

package/mesh/customAttributeMetadataV2.ts

@@ -0,0 +1,68 @@
+import type { MeshContext, CustomAttributeMetadataInterface } from '@graphcommerce/graphql-mesh'
+
+export type CustomAttributeInput = { attribute_code: string; entity_type: 'catalog_product' }
+
+export async function customAttributeMetadataV2(
+  input: CustomAttributeInput,
+  context: MeshContext,
+): Promise<CustomAttributeMetadataInterface | null> {
+  const cacheKey = `customAttributeMetadata-${input.entity_type}-${input.attribute_code}`
+  const cached = await context.cache.get(cacheKey)
+  if (cached) return cached
+
+  if (input.entity_type !== 'catalog_product')
+    throw Error('Only catalog_product is supported at this moment')
+
+  if (
+    !('customAttributeMetadataV2' in context.m2.Query) ||
+    typeof context.m2.Query.customAttributeMetadataV2 !== 'function'
+  )
+    throw Error('This field is only available in Magento 2.4.7 and up')
+
+  const attribute = await context.m2.Query.customAttributeMetadataV2({
+    context,
+    key: input,
+    argsFromKeys: (attributes) => ({ attributes }),
+    selectionSet: /* GraphQL */ `
+      {
+        items {
+          __typename
+          code
+          label
+          default_value
+          entity_type
+          frontend_class
+          frontend_input
+          is_required
+          is_unique
+          label
+          ... on CatalogAttributeMetadata {
+            apply_to
+            is_comparable
+            is_filterable
+            is_filterable_in_search
+            is_html_allowed_on_front
+            is_searchable
+            is_used_for_price_rules
+            is_used_for_promo_rules
+            is_visible_in_advanced_search
+            is_visible_on_front
+            is_wysiwyg_enabled
+            used_in_product_listing
+          }
+          options {
+            label
+            is_default
+            value
+          }
+        }
+      }
+    `,
+    valuesFromResults: (res, attributes) =>
+      attributes.map((attr) => res.items?.find((v) => v?.code === attr.attribute_code)),
+  })
+
+  // Cache for 1 hour
+  await context.cache.set(cacheKey, attribute, { ttl: 60 * 60 })
+  return attribute ?? null
+}

package/mesh/customAttributeV2Resolver.ts

@@ -0,0 +1,47 @@
+import fragments from '@graphcommerce/graphql/generated/fragments.json'
+import type { MeshContext, ProductInterfaceResolvers, Resolvers } from '@graphcommerce/graphql-mesh'
+import { Kind } from 'graphql'
+import { CustomAttributeInput, customAttributeMetadataV2 } from './customAttributeMetadataV2'
+
+type CustomAttributeV2Resolver = Pick<ProductInterfaceResolvers<MeshContext>, 'custom_attributeV2'>
+
+const customAttributeV2Resolver: CustomAttributeV2Resolver = {
+  custom_attributeV2: {
+    selectionSet: (fieldNode) => ({
+      kind: Kind.SELECTION_SET,
+      selections: (fieldNode.arguments ?? [])
+        .map((arg) => arg.value)
+        .filter((value) => value.kind === Kind.STRING)
+        .map((value) => ({ kind: Kind.FIELD, name: { kind: Kind.NAME, value: value.value } })),
+    }),
+    resolve: async (root, { attribute_code: code }, context) => {
+      const value = String(root[code] ?? '')
+      const input: CustomAttributeInput = { attribute_code: code, entity_type: 'catalog_product' }
+      const attribute = await customAttributeMetadataV2(input, context)
+
+      if (!attribute || !value) return null
+
+      if (
+        attribute?.frontend_input &&
+        ['SELECT', 'MULTISELECT'].includes(attribute.frontend_input)
+      ) {
+        const values = attribute.frontend_input === 'SELECT' ? [value] : value.split(',')
+        const selected_options = values.map((v) => {
+          const found = attribute.options?.find((o) => o?.value === v || o?.label === v)
+          if (!found) return null
+          return { ...found, __typename: 'AttributeSelectedOption' }
+        })
+        return { __typename: 'AttributeSelectedOptions', code, selected_options, attribute }
+      }
+      return { __typename: 'AttributeValue', code, value, attribute }
+    },
+  },
+}
+
+type ProductTypes = NonNullable<Awaited<ReturnType<ProductInterfaceResolvers['__resolveType']>>>
+const productInterfaceTypes = fragments.possibleTypes.ProductInterface as ProductTypes[]
+const resolvers: Resolvers = {}
+productInterfaceTypes.forEach((productType) => {
+  if (!resolvers[productType]) resolvers[productType] = customAttributeV2Resolver
+})
+export default resolvers

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/magento-graphql",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "8.1.0-canary.9",
+  "version": "9.0.0-canary.101",
   "sideEffects": false,
   "main": "index.ts",
   "prettier": "@graphcommerce/prettier-config-pwa",
@@ -13,10 +13,11 @@
     }
   },
   "peerDependencies": {
-    "@graphcommerce/eslint-config-pwa": "^8.1.0-canary.9",
-    "@graphcommerce/graphql": "^8.1.0-canary.9",
-    "@graphcommerce/prettier-config-pwa": "^8.1.0-canary.9",
-    "@graphcommerce/typescript-config-pwa": "^8.1.0-canary.9",
+    "@graphcommerce/eslint-config-pwa": "^9.0.0-canary.101",
+    "@graphcommerce/graphql": "^9.0.0-canary.101",
+    "@graphcommerce/prettier-config-pwa": "^9.0.0-canary.101",
+    "@graphcommerce/typescript-config-pwa": "^9.0.0-canary.101",
+    "graphql": "^16.0.0",
     "next": "*",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

package/plugins/magentoGraphqlConfig.ts

@@ -1,13 +1,13 @@
-import { graphqlConfig } from '@graphcommerce/graphql'
-import type { FunctionPlugin } from '@graphcommerce/next-config'
+import { graphqlConfig as graphqlConfigType } from '@graphcommerce/graphql'
+import type { FunctionPlugin, PluginConfig } from '@graphcommerce/next-config'
 import { magentoTypePolicies } from '../typePolicies'
 
-export const func = 'graphqlConfig'
-export const exported = '@graphcommerce/graphql/config'
+export const config: PluginConfig = {
+  type: 'function',
+  module: '@graphcommerce/graphql',
+}
 
-const magentoGraphqlConfig: FunctionPlugin<typeof graphqlConfig> = (prev, config) => {
+export const graphqlConfig: FunctionPlugin<typeof graphqlConfigType> = (prev, config) => {
   const results = prev(config)
   return { ...results, policies: [magentoTypePolicies, ...results.policies] }
 }
-
-export const plugin = magentoGraphqlConfig

package/plugins/meshConfigAttrValue.ts

@@ -0,0 +1,24 @@
+import type { meshConfig as meshConfigBase } from '@graphcommerce/graphql-mesh/meshConfig'
+import type { FunctionPlugin, PluginConfig } from '@graphcommerce/next-config'
+
+export const config: PluginConfig = {
+  module: '@graphcommerce/graphql-mesh/meshConfig',
+  type: 'function',
+}
+
+export const meshConfig: FunctionPlugin<typeof meshConfigBase> = (
+  prev,
+  baseConfig,
+  graphCommerceConfig,
+) =>
+  prev(
+    {
+      ...baseConfig,
+      additionalResolvers: [
+        ...(baseConfig.additionalResolvers ?? []),
+        '@graphcommerce/magento-graphql/mesh/customAttributeV2Resolver.ts',
+        '@graphcommerce/magento-graphql/mesh/attributeValueResolver.ts',
+      ],
+    },
+    graphCommerceConfig,
+  )

package/schema/AttributeValueInterface-attribute.graphqls

@@ -0,0 +1,9 @@
+extend interface AttributeValueInterface {
+  attribute: CustomAttributeMetadataInterface
+}
+extend type AttributeValue {
+  attribute: CustomAttributeMetadataInterface
+}
+extend type AttributeSelectedOptions {
+  attribute: CustomAttributeMetadataInterface
+}

package/schema/ProductInterface-custom_attribute.graphqls

@@ -0,0 +1,49 @@
+extend interface ProductInterface {
+  """
+  This is the singular version of the custom_attributesV2 and allows selecting a single attribute option value.
+  Available only after Magento 2.4.7 as it relies on the customAttributesV2 query.
+  """
+  custom_attributeV2(attribute_code: String!): AttributeValueInterface
+}
+extend type SimpleProduct {
+  """
+  This is the singular version of the custom_attributesV2 and allows selecting a single attribute option value.
+  Available only after Magento 2.4.7 as it relies on the customAttributesV2 query.
+  """
+  custom_attributeV2(attribute_code: String!): AttributeValueInterface
+}
+extend type ConfigurableProduct {
+  """
+  This is the singular version of the custom_attributesV2 and allows selecting a single attribute option value.
+  Available only after Magento 2.4.7 as it relies on the customAttributesV2 query.
+  """
+  custom_attributeV2(attribute_code: String!): AttributeValueInterface
+}
+extend type BundleProduct {
+  """
+  This is the singular version of the custom_attributesV2 and allows selecting a single attribute option value.
+  Available only after Magento 2.4.7 as it relies on the customAttributesV2 query.
+  """
+  custom_attributeV2(attribute_code: String!): AttributeValueInterface
+}
+extend type DownloadableProduct {
+  """
+  This is the singular version of the custom_attributesV2 and allows selecting a single attribute option value.
+  Available only after Magento 2.4.7 as it relies on the customAttributesV2 query.
+  """
+  custom_attributeV2(attribute_code: String!): AttributeValueInterface
+}
+extend type VirtualProduct {
+  """
+  This is the singular version of the custom_attributesV2 and allows selecting a single attribute option value.
+  Available only after Magento 2.4.7 as it relies on the customAttributesV2 query.
+  """
+  custom_attributeV2(attribute_code: String!): AttributeValueInterface
+}
+extend type GroupedProduct {
+  """
+  This is the singular version of the custom_attributesV2 and allows selecting a single attribute option value.
+  Available only after Magento 2.4.7 as it relies on the customAttributesV2 query.
+  """
+  custom_attributeV2(attribute_code: String!): AttributeValueInterface
+}

package/schema-246/CartAddressInput-vat_id.graphqls

@@ -0,0 +1,15 @@
+input CartAddressInput {
+  vat_id: String @deprecated(reason: "Magento >= 2.4.6")
+}
+
+interface CartAddressInterface {
+  vat_id: String @deprecated(reason: "Magento >= 2.4.6")
+}
+
+type ShippingCartAddress implements CartAddressInterface {
+  vat_id: String @deprecated(reason: "Magento >= 2.4.6")
+}
+
+type BillingCartAddress {
+  vat_id: String @deprecated(reason: "Magento >= 2.4.6")
+}

package/schema-246/Mutation-deleteCustomer.graphqls

@@ -0,0 +1,6 @@
+type Mutation {
+  """
+  Delete customer account
+  """
+  deleteCustomer: Boolean @deprecated(reason: "Magento >= 2.4.6")
+}

package/schema-246/OrderItem-gift_message.graphqls

@@ -0,0 +1,27 @@
+interface OrderItemInterface {
+  """
+  The selected gift message for the order item
+  """
+  gift_message: GiftMessage @deprecated(reason: "Magento >= 2.4.6")
+}
+
+type OrderItem {
+  """
+  The selected gift message for the order item
+  """
+  gift_message: GiftMessage @deprecated(reason: "Magento >= 2.4.6")
+}
+
+type BundleOrderItem {
+  """
+  The selected gift message for the order item
+  """
+  gift_message: GiftMessage @deprecated(reason: "Magento >= 2.4.6")
+}
+
+type DownloadableOrderItem {
+  """
+  The selected gift message for the order item
+  """
+  gift_message: GiftMessage @deprecated(reason: "Magento >= 2.4.6")
+}

package/schema-246/SelectedShippingMethod.graphqls

@@ -0,0 +1,4 @@
+type SelectedShippingMethod {
+  price_excl_tax: Money @deprecated(reason: "Magento >= 2.4.6")
+  price_incl_tax: Money @deprecated(reason: "Magento >= 2.4.6")
+}

package/schema-247/Cart-itemsV2.graphqls

@@ -0,0 +1,72 @@
+type CartItems {
+  """
+  An array of products that have been added to the cart.
+  """
+  items: [CartItemInterface]!
+  """
+  Metadata for pagination rendering.
+  """
+  page_info: SearchResultPageInfo
+  """
+  The number of returned cart items.
+  """
+  total_count: Int!
+}
+
+"""
+Specifies the field to use for sorting quote items
+"""
+enum SortQuoteItemsEnum {
+  ITEM_ID
+  CREATED_AT
+  UPDATED_AT
+  PRODUCT_ID
+  SKU
+  NAME
+  DESCRIPTION
+  WEIGHT
+  QTY
+  PRICE
+  BASE_PRICE
+  CUSTOM_PRICE
+  DISCOUNT_PERCENT
+  DISCOUNT_AMOUNT
+  BASE_DISCOUNT_AMOUNT
+  TAX_PERCENT
+  TAX_AMOUNT
+  BASE_TAX_AMOUNT
+  ROW_TOTAL
+  BASE_ROW_TOTAL
+  ROW_TOTAL_WITH_DISCOUNT
+  ROW_WEIGHT
+  PRODUCT_TYPE
+  BASE_TAX_BEFORE_DISCOUNT
+  TAX_BEFORE_DISCOUNT
+  ORIGINAL_CUSTOM_PRICE
+  PRICE_INC_TAX
+  BASE_PRICE_INC_TAX
+  ROW_TOTAL_INC_TAX
+  BASE_ROW_TOTAL_INC_TAX
+  DISCOUNT_TAX_COMPENSATION_AMOUNT
+  BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT
+  FREE_SHIPPING
+}
+
+"""
+Specifies the field to use for sorting quote items
+"""
+input QuoteItemsSortInput {
+  """
+  Specifies the quote items field to sort by
+  """
+  field: SortQuoteItemsEnum!
+  """
+  Specifies the order of quote items' sorting
+  """
+  order: SortEnum!
+}
+
+type Cart {
+  itemsV2(pageSize: Int = 20, currentPage: Int = 1, sort: QuoteItemsSortInput): CartItems
+    @deprecated(reason: "Magento >= 2.4.7")
+}