Merge pull request #2289 from graphcommerce-org/feature/injectable-fr…

…agments2 Feature/injectable fragments2
graphcommerce-org · Jun 5, 2024 · 0f44bfe · 0f44bfe
2 parents 3eca112 + cd97bc7
commit 0f44bfe
Show file tree

Hide file tree

Showing 45 changed files with 55 additions and 54 deletions.
diff --git a/.changeset/sharp-seahorses-deny.md b/.changeset/sharp-seahorses-deny.md
@@ -0,0 +1,5 @@
+---
+"@graphcommerce/graphql-codegen-near-operation-file": patch
+---
+
+Do not require fragments to be marked @injectable but always accept @inject directives.
diff --git a/docs/framework/plugins-graphql.md b/docs/framework/plugins-graphql.md
@@ -41,7 +41,7 @@ query ProductList(
 }
 
 # Fragment used for a ProductListItem used when rendering any listing
-fragment ProductListItem on ProductInterface @injectable {
+fragment ProductListItem on ProductInterface {
   uid
   ...ProductLink
   sku
@@ -59,8 +59,8 @@ fragment ProductListItem on ProductInterface @injectable {
 
 ## How to modify an existing query?
 
-Some Fragments inside GraphCommerce have been marked as `@injectable` which
-allows you to inject our own fields in the fragments.
+Fragments inside GraphCommerce allows you to inject our own fields in the
+fragments.
 
 ```graphql
 fragment MyCustomFragment on ProductInterface

diff --git a/packages/hygraph-dynamic-rows/graphql/DynamicRow.graphql b/packages/hygraph-dynamic-rows/graphql/DynamicRow.graphql
@@ -1,4 +1,4 @@
-fragment DynamicRow on DynamicRow @injectable {
+fragment DynamicRow on DynamicRow {
   placement
   target {
     ... on Node {

diff --git a/packages/hygraph-ui/components/Asset/Asset.graphql b/packages/hygraph-ui/components/Asset/Asset.graphql
@@ -1,4 +1,4 @@
-fragment Asset on Asset @injectable {
+fragment Asset on Asset {
   url
   width
   height

diff --git a/packages/hygraph-ui/graphql/HygraphPage.graphql b/packages/hygraph-ui/graphql/HygraphPage.graphql
@@ -1,4 +1,4 @@
-fragment HygraphPage on Page @injectable {
+fragment HygraphPage on Page {
   title
   metaTitle
   metaDescription

diff --git a/packages/hygraph-ui/graphql/PageLink.graphql b/packages/hygraph-ui/graphql/PageLink.graphql
@@ -1,4 +1,4 @@
-fragment PageLink on PageLink @injectable {
+fragment PageLink on PageLink {
   title
   url
   description {

diff --git a/packages/magento-cart-billing-address/Api/CartBillingAddress.graphql b/packages/magento-cart-billing-address/Api/CartBillingAddress.graphql
@@ -1,4 +1,4 @@
-fragment CartBillingAddress on Cart @injectable {
+fragment CartBillingAddress on Cart {
   id
   __typename
   billing_address {

diff --git a/packages/magento-cart-checkout/queries/CartPageFragment.graphql b/packages/magento-cart-checkout/queries/CartPageFragment.graphql
@@ -1,4 +1,4 @@
-fragment CartPageFragment on Cart @injectable {
+fragment CartPageFragment on Cart {
   id
   __typename
   email

diff --git a/packages/magento-cart-checkout/queries/ShippingPageFragment.graphql b/packages/magento-cart-checkout/queries/ShippingPageFragment.graphql
@@ -1,4 +1,4 @@
-fragment ShippingPageFragment on Cart @injectable {
+fragment ShippingPageFragment on Cart {
   ...BillingAddress
   ...ShippingAddress
   ...CartSummary

diff --git a/packages/magento-cart-coupon/Api/Coupon.graphql b/packages/magento-cart-coupon/Api/Coupon.graphql
@@ -1,4 +1,4 @@
-fragment Coupon on Cart @injectable {
+fragment Coupon on Cart {
   id
   __typename
   applied_coupons {

diff --git a/packages/magento-cart-email/Api/GuestEmailChanged.graphql b/packages/magento-cart-email/Api/GuestEmailChanged.graphql
@@ -1,3 +1,3 @@
-fragment GuestEmailChanged on Cart @injectable {
+fragment GuestEmailChanged on Cart {
   id
 }
diff --git a/packages/magento-cart-items/Api/CartItem.graphql b/packages/magento-cart-items/Api/CartItem.graphql
@@ -1,4 +1,4 @@
-fragment CartItem on CartItemInterface @injectable {
+fragment CartItem on CartItemInterface {
   uid
   quantity
   __typename

diff --git a/packages/magento-cart-items/Api/CartItems.graphql b/packages/magento-cart-items/Api/CartItems.graphql
@@ -1,4 +1,4 @@
-fragment CartItems on Cart @injectable {
+fragment CartItems on Cart {
   id
   items {
     uid

diff --git a/...ges/magento-cart-payment-method/Api/AvailablePaymentMethod/AvailablePaymentMethod.graphql b/...ges/magento-cart-payment-method/Api/AvailablePaymentMethod/AvailablePaymentMethod.graphql
@@ -1,4 +1,4 @@
-fragment AvailablePaymentMethod on AvailablePaymentMethod @injectable {
+fragment AvailablePaymentMethod on AvailablePaymentMethod {
   code
   title
 }
diff --git a/packages/magento-cart-payment-method/Api/PaymentMethodContext.graphql b/packages/magento-cart-payment-method/Api/PaymentMethodContext.graphql
@@ -1,4 +1,4 @@
-fragment PaymentMethodContext on Cart @injectable {
+fragment PaymentMethodContext on Cart {
   id
   available_payment_methods {
     ...AvailablePaymentMethod

diff --git a/packages/magento-cart-payment-method/Api/PaymentMethodUpdated.graphql b/packages/magento-cart-payment-method/Api/PaymentMethodUpdated.graphql
@@ -1,4 +1,4 @@
-fragment PaymentMethodUpdated on Cart @injectable {
+fragment PaymentMethodUpdated on Cart {
   id
   selected_payment_method {
     ...SelectedPaymentMethod

diff --git a/packages/magento-cart-payment-method/Api/SelectedPaymentMethod/SelectedPaymentMethod.graphql b/packages/magento-cart-payment-method/Api/SelectedPaymentMethod/SelectedPaymentMethod.graphql
@@ -1,4 +1,4 @@
-fragment SelectedPaymentMethod on SelectedPaymentMethod @injectable {
+fragment SelectedPaymentMethod on SelectedPaymentMethod {
   code
   title
 }
diff --git a/packages/magento-cart-shipping-address/Api/BillingAddress.graphql b/packages/magento-cart-shipping-address/Api/BillingAddress.graphql
@@ -1,4 +1,4 @@
-fragment BillingAddress on Cart @injectable {
+fragment BillingAddress on Cart {
   id
   billing_address {
     ...CartAddress

diff --git a/packages/magento-cart-shipping-address/Api/ShippingAddress.graphql b/packages/magento-cart-shipping-address/Api/ShippingAddress.graphql
@@ -1,4 +1,4 @@
-fragment ShippingAddress on Cart @injectable {
+fragment ShippingAddress on Cart {
   id
   is_virtual
   shipping_addresses {

diff --git a/packages/magento-cart-shipping-method/Api/AvailableShippingMethods.graphql b/packages/magento-cart-shipping-method/Api/AvailableShippingMethods.graphql
@@ -1,4 +1,4 @@
-fragment AvailableShippingMethods on Cart @injectable @inject(into: ["ShippingAddress"]) {
+fragment AvailableShippingMethods on Cart @inject(into: ["ShippingAddress"]) {
   shipping_addresses {
     available_shipping_methods {
       ...AvailableShippingMethod

diff --git a/packages/magento-cart-shipping-method/Api/ShippingMethodSelected.graphql b/packages/magento-cart-shipping-method/Api/ShippingMethodSelected.graphql
@@ -1,4 +1,4 @@
-fragment ShippingMethodSelected on Cart @injectable {
+fragment ShippingMethodSelected on Cart {
   id
   shipping_addresses {
     selected_shipping_method {

diff --git a/packages/magento-cart/Api/CartItemCountChanged.graphql b/packages/magento-cart/Api/CartItemCountChanged.graphql
@@ -1,4 +1,4 @@
-fragment CartItemCountChanged on Cart @injectable {
+fragment CartItemCountChanged on Cart {
   __typename
   id
   total_quantity

diff --git a/packages/magento-cart/components/CartStartCheckout/CartStartCheckout.graphql b/packages/magento-cart/components/CartStartCheckout/CartStartCheckout.graphql
@@ -1,4 +1,4 @@
-fragment CartStartCheckout on Cart @injectable {
+fragment CartStartCheckout on Cart {
   prices {
     grand_total {
       ...Money

diff --git a/packages/magento-cart/components/CartTotals/CartTotals.graphql b/packages/magento-cart/components/CartTotals/CartTotals.graphql
@@ -1,6 +1,4 @@
-fragment CartTotals on Cart
-@injectable
-@inject(into: ["CartItemCountChanged", "PaymentMethodUpdated"]) {
+fragment CartTotals on Cart @inject(into: ["CartItemCountChanged", "PaymentMethodUpdated"]) {
   shipping_addresses {
     selected_shipping_method {
       carrier_code

diff --git a/packages/magento-cart/components/OrderSucces/OrderSuccesPage.graphql b/packages/magento-cart/components/OrderSucces/OrderSuccesPage.graphql
@@ -1,4 +1,4 @@
-fragment OrderSuccesPage on Cart @injectable {
+fragment OrderSuccesPage on Cart {
   ...CartItems
   ...CartTotals
 }
diff --git a/packages/magento-category/components/CategoryDescription/CategoryDescription.graphql b/packages/magento-category/components/CategoryDescription/CategoryDescription.graphql
@@ -1,4 +1,4 @@
-fragment CategoryDescription on CategoryTree @injectable {
+fragment CategoryDescription on CategoryTree {
   uid
   description
   name

diff --git a/packages/magento-category/components/CategoryHeroNav/CategoryHeroNav.graphql b/packages/magento-category/components/CategoryHeroNav/CategoryHeroNav.graphql
@@ -1,4 +1,4 @@
-fragment CategoryHeroNav on CategoryTree @injectable {
+fragment CategoryHeroNav on CategoryTree {
   uid
   level
   is_anchor

diff --git a/packages/magento-category/queries/CategoryPathFragment.graphql b/packages/magento-category/queries/CategoryPathFragment.graphql
@@ -1,4 +1,4 @@
-fragment CategoryPathFragment on CategoryTree @injectable {
+fragment CategoryPathFragment on CategoryTree {
   uid
   url_path
   children {

diff --git a/packages/magento-category/queries/NavigationItem.graphql b/packages/magento-category/queries/NavigationItem.graphql
@@ -1,4 +1,4 @@
-fragment NavigationItem on CategoryTree @injectable {
+fragment NavigationItem on CategoryTree {
   uid
   include_in_menu
   name

diff --git a/packages/magento-cms/CmsPageContent.graphql b/packages/magento-cms/CmsPageContent.graphql
@@ -1,4 +1,4 @@
-fragment CmsPageContent on CmsPage @injectable {
+fragment CmsPageContent on CmsPage {
   content_heading
   content
 }
diff --git a/packages/magento-customer/graphql/AccountDashboardCustomer.graphql b/packages/magento-customer/graphql/AccountDashboardCustomer.graphql
@@ -1,3 +1,3 @@
-fragment AccountDashboardCustomer on Customer @injectable {
+fragment AccountDashboardCustomer on Customer {
   email
 }
diff --git a/packages/magento-customer/hooks/CustomerTokenFragment.graphql b/packages/magento-customer/hooks/CustomerTokenFragment.graphql
@@ -1,4 +1,4 @@
-fragment CustomerTokenFragment on CustomerToken @injectable {
+fragment CustomerTokenFragment on CustomerToken {
   __typename
   token
 }
diff --git a/packages/magento-product-configurable/graphql/ConfigurableOptions.graphql b/packages/magento-product-configurable/graphql/ConfigurableOptions.graphql
@@ -1,4 +1,4 @@
-fragment ConfigurableOptions on ConfigurableProduct @injectable {
+fragment ConfigurableOptions on ConfigurableProduct {
   __typename
   uid
   sku

diff --git a/packages/magento-product-configurable/graphql/ConfigurableOptionsSelection.graphql b/packages/magento-product-configurable/graphql/ConfigurableOptionsSelection.graphql
@@ -1,4 +1,4 @@
-fragment ConfigurableOptionsSelection on ConfigurableProduct @injectable {
+fragment ConfigurableOptionsSelection on ConfigurableProduct {
   configurable_product_options_selection(configurableOptionValueUids: $selectedOptions) {
     __typename
     configurable_options {

diff --git a/packages/magento-product/Api/ProductListItem.graphql b/packages/magento-product/Api/ProductListItem.graphql
@@ -1,4 +1,4 @@
-fragment ProductListItem on ProductInterface @injectable {
+fragment ProductListItem on ProductInterface {
   uid
   ...ProductLink
   sku

diff --git a/packages/magento-product/Api/ProductPageItem.graphql b/packages/magento-product/Api/ProductPageItem.graphql
@@ -1,4 +1,4 @@
-fragment ProductPageItem on ProductInterface @injectable {
+fragment ProductPageItem on ProductInterface {
   __typename
   uid
   ...ProductListItem

diff --git a/packages/magento-product/components/AddProductsToCart/UseAddProductsToCartAction.graphql b/packages/magento-product/components/AddProductsToCart/UseAddProductsToCartAction.graphql
@@ -1,4 +1,4 @@
-fragment UseAddProductsToCartAction on ProductInterface @injectable {
+fragment UseAddProductsToCartAction on ProductInterface {
   uid
   sku
   only_x_left_in_stock

diff --git a/packages/magento-product/components/JsonLdProduct/JsonLdProduct.graphql b/packages/magento-product/components/JsonLdProduct/JsonLdProduct.graphql
@@ -1,4 +1,4 @@
-fragment JsonLdProduct on ProductInterface @inject(into: ["ProductPageItem"]) @injectable {
+fragment JsonLdProduct on ProductInterface @inject(into: ["ProductPageItem"]) {
   uid
   name
   sku

diff --git a/packages/magento-product/components/ProductCustomizable/ProductCustomizable.graphql b/packages/magento-product/components/ProductCustomizable/ProductCustomizable.graphql
@@ -1,4 +1,4 @@
-fragment ProductCustomizable on CustomizableProductInterface @injectable {
+fragment ProductCustomizable on CustomizableProductInterface {
   options {
     uid
     __typename

diff --git a/packages/magento-product/components/ProductPageDescription/ComplexTextValue.graphql b/packages/magento-product/components/ProductPageDescription/ComplexTextValue.graphql
@@ -1,4 +1,4 @@
-fragment ComplexTextValue on ComplexTextValue @injectable {
+fragment ComplexTextValue on ComplexTextValue {
   html
   __typename
 }
diff --git a/packages/magento-product/components/ProductPageMeta/ProductPageMeta.graphql b/packages/magento-product/components/ProductPageMeta/ProductPageMeta.graphql
@@ -1,4 +1,4 @@
-fragment ProductPageMeta on ProductInterface @injectable {
+fragment ProductPageMeta on ProductInterface {
   ...ProductLink
   sku
   name

diff --git a/packages/magento-store/StoreConfigFragment.graphql b/packages/magento-store/StoreConfigFragment.graphql
@@ -1,4 +1,4 @@
-fragment StoreConfigFragment on StoreConfig @injectable {
+fragment StoreConfigFragment on StoreConfig {
   website_name
   store_code
   store_name

diff --git a/packagesDev/graphql-codegen-near-operation-file/dist/directive/injectable.js b/packagesDev/graphql-codegen-near-operation-file/dist/directive/injectable.js
@@ -97,14 +97,14 @@ function injectInjectable(injectables, injector) {
             });
         });
         if (!found)
-            throwInjectError(injectVal, `fragment ${target} @injectable { ... } can not be found or isn't injectable`);
+            throwInjectError(injectVal, `fragment ${target} { ... } can not be found`);
     });
 }
 function injectableDirective(documentFiles) {
     const documents = documentFiles
         .map(({ document }) => document)
         .filter((doc) => doc);
-    const injectables = documents.filter((d) => isFragment(d) && hasInjectableDirective(d));
+    const injectables = documents.filter((d) => isFragment(d));
     const injectors = documents.filter((d) => isFragment(d) && hasInjectDirective(d));
     injectors.forEach((d) => injectInjectable(injectables, d));
     return documentFiles;

diff --git a/packagesDev/graphql-codegen-near-operation-file/src/directive/injectable.graphqls b/packagesDev/graphql-codegen-near-operation-file/src/directive/injectable.graphqls
@@ -1,4 +1,6 @@
 """
+DEPRECATED, CAN BE COMPLETELY OMITTED
+
 Defines wheter a Fragment can be injected
 
 ```graphql
@@ -10,7 +12,7 @@ fragment MyInjectableFragment on Model @injectable {
 directive @injectable on FRAGMENT_DEFINITION
 
 """
-Defines whether a Fragment injects into an @injectable
+Defines whether a Fragment injects into another Fragment
 
 ```graphql
 fragment MyFragment on Model @inject(into ["MyInjectableFragment"]) {

diff --git a/packagesDev/graphql-codegen-near-operation-file/src/directive/injectable.ts b/packagesDev/graphql-codegen-near-operation-file/src/directive/injectable.ts
@@ -104,11 +104,7 @@ function injectInjectable(injectables: DocumentNode[], injector: DocumentNode) {
         },
       })
     })
-    if (!found)
-      throwInjectError(
-        injectVal,
-        `fragment ${target} @injectable { ... } can not be found or isn't injectable`,
-      )
+    if (!found) throwInjectError(injectVal, `fragment ${target} { ... } can not be found`)
   })
 }
 
@@ -117,7 +113,7 @@ export function injectableDirective(documentFiles: Types.DocumentFile[]) {
     .map(({ document }) => document)
     .filter((doc) => doc) as DocumentNode[]
 
-  const injectables = documents.filter((d) => isFragment(d) && hasInjectableDirective(d))
+  const injectables = documents.filter((d) => isFragment(d))
 
   const injectors = documents.filter((d) => isFragment(d) && hasInjectDirective(d))