- + Allow Gift Wrapping on Order Level Magento\Config\Model\Config\Source\Yesno - + Allow Gift Wrapping for Order Items Magento\Config\Model\Config\Source\Yesno From 599fdbfa9a80be34e4fcaf6e665b3d24b983f82d Mon Sep 17 00:00:00 2001 From: Anusha Vattam Date: Thu, 6 Aug 2020 18:10:55 -0500 Subject: [PATCH 233/479] Remove giftwrapping on cart level and on item level changes on schema --- design-documents/graph-ql/coverage/gift-wrapping.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/design-documents/graph-ql/coverage/gift-wrapping.md b/design-documents/graph-ql/coverage/gift-wrapping.md index 68a8468a0..b85fd4927 100644 --- a/design-documents/graph-ql/coverage/gift-wrapping.md +++ b/design-documents/graph-ql/coverage/gift-wrapping.md @@ -196,10 +196,16 @@ type CartItemUpdateInput { gift_wrapping_id: ID @doc(description: "The unique identifier of the gift wrapping to be used for the cart item") gift_message: GiftMessageInput @doc(description: "Gift message details for the cart item") } +type RemoveItemFromCartInput { + gift_wrapping_id: ID @doc(description: "The unique identifier of the gift wrapping to be used for removing from the cart item") +} type Mutation { setGiftOptionsOnCart(cart_id: String!, gift_message: GiftMessageInput, gift_wrapping_id: ID, gift_receipt_included: Boolean, printed_card_included: Boolean): SetGiftOptionsOnCartOutput @doc(description: "Set gift options like gift wrapping or gift message for the entire cart") + removeGiftOptionsOnCart(cart_id: String!, gift_wrapping_id: ID, gift_receipt_included: Boolean, printed_card_included: Boolean): RemoveGiftOptionsOnCartOutput @doc(description: "Remove gift options gift wrapping for the entire cart") } + + ###### End: Extending existing types ###### @@ -207,6 +213,10 @@ type Mutation { type SetGiftOptionsOnCartOutput { cart: Cart! @doc(description: "The modified cart object") } +type RemoveGiftOptionsOnCartOutput { + cart: Cart! @doc(description: "The modified cart object") +} + type GiftMessageInput { to: String! @doc(description: "Recepient name") From 3542972192ba3cf27c46060198c7a9891ed48c38 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Fri, 7 Aug 2020 13:33:15 -0500 Subject: [PATCH 234/479] MC-36365: Schema for B2B purchase order details --- .../graph-ql/coverage/b2b/purchase-order.md | 67 +++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 design-documents/graph-ql/coverage/b2b/purchase-order.md diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md new file mode 100644 index 000000000..e143594ed --- /dev/null +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -0,0 +1,67 @@ +## Use Cases + +### View "My Purchase Orders" list + +### View "Requires My Approval" list of purchase orders + +Should support pagination. + +### View "Company Purchase Orders" list + +Should support pagination. + +### View purchase order details + +Should support pagination. + +#### Items + +Should support pagination. + +#### Basic details +#### Approval Flow +#### Comments +#### History Log +#### Totals +#### Shipping Address +#### Billing Address +#### Payment Method +#### Shipping Method + +### Add items to cart from purchase order + +### Add purchase order comment + +### Reject purchase order + +### Cancel purchase order + +### Approve purchase order + +### Get a list of available actions + +### Store config + +Consider combining the following settings and exposing as a single field: +- Check if purchase order is enabled on global level +- If purchase order enabled on company level +- If comapnies are enabled on global level + +### View a list of approval rules + +Should support pagination. + +### View approval rule details + +### Create new approval rule + +#### Get list of "Applies to" users + +#### Get list of "Requires approval from" users + +### Update approval rule + +### Delete approval rule + + + From cd181bc6ddb6b245bcdad6e271dd3d6a9ef632c4 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Fri, 7 Aug 2020 17:04:12 -0500 Subject: [PATCH 235/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 36 +++++++ .../graph-ql/coverage/b2b/purchase-order.md | 99 ++++++++++++++++++- 2 files changed, 131 insertions(+), 4 deletions(-) create mode 100644 design-documents/graph-ql/coverage/b2b/purchase-order.graphqls diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls new file mode 100644 index 000000000..1a11024f1 --- /dev/null +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -0,0 +1,36 @@ +type Customer { + purchase_orders(filter: PurchaseOrdersFilterInput, currentPage: Int = 1, pageSize: Int = 20): PurchaseOrders +} + +input PurchaseOrdersFilterInput { + status: PurchaseOrderStatus + createdBy: FilterStringTypeInput + createdDate: FilterRangeTypeInput +} + +type PurchaseOrders { + items: [PurchaseOrder]! + page_info: SearchResultPageInfo + total_count: Int +} + +type PurchaseOrder { + uid: ID! + number: String! + order: CustomerOrder + created_at: String! + created_by: String! + status: PurchaseOrderStatus! + total: Money! +} + +enum PurchaseOrderStatus { + PENDING + APPROVAL_REQUIRED + APPROVED + ORDER_IN_PROGRESS + ORDER_PLACED + ORDER_FAILED + REJECTED + CANCELED +} diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index e143594ed..bdd293fea 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -2,14 +2,105 @@ ### View "My Purchase Orders" list +```graphql +{ + customer { + purchase_orders( + filter: {createdBy: {eq: "Active User Name"}}, + currentPage: 1, + pageSize: 10 + ) { + items { + uid + number + order { + number + } + created_at + created_by + status + total { + currency + value + } + } + total_count + page_info { + current_page + page_size + total_pages + } + } + } +} +``` ### View "Requires My Approval" list of purchase orders -Should support pagination. - +```graphql +{ + customer { + purchase_orders( + filter: {status: APPROVAL_REQUIRED}, + currentPage: 1, + pageSize: 10 + ) { + items { + uid + number + order { + number + } + created_at + created_by + status + total { + currency + value + } + } + total_count + page_info { + current_page + page_size + total_pages + } + } + } +} +``` ### View "Company Purchase Orders" list -Should support pagination. - +```graphql +{ + customer { + purchase_orders( + currentPage: 1, + pageSize: 10 + ) { + items { + uid + number + order { + number + } + created_at + created_by + status + total { + currency + value + } + } + total_count + page_info { + current_page + page_size + total_pages + } + } + } +} +``` ### View purchase order details Should support pagination. From 86f6ec524d27bacce77466cbca8af699b79cc947 Mon Sep 17 00:00:00 2001 From: Anusha Vattam Date: Fri, 7 Aug 2020 18:29:25 -0500 Subject: [PATCH 236/479] Cleaned up schema --- .../graph-ql/coverage/gift-wrapping.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/design-documents/graph-ql/coverage/gift-wrapping.md b/design-documents/graph-ql/coverage/gift-wrapping.md index b85fd4927..5e8f200b4 100644 --- a/design-documents/graph-ql/coverage/gift-wrapping.md +++ b/design-documents/graph-ql/coverage/gift-wrapping.md @@ -196,15 +196,18 @@ type CartItemUpdateInput { gift_wrapping_id: ID @doc(description: "The unique identifier of the gift wrapping to be used for the cart item") gift_message: GiftMessageInput @doc(description: "Gift message details for the cart item") } -type RemoveItemFromCartInput { - gift_wrapping_id: ID @doc(description: "The unique identifier of the gift wrapping to be used for removing from the cart item") -} type Mutation { - setGiftOptionsOnCart(cart_id: String!, gift_message: GiftMessageInput, gift_wrapping_id: ID, gift_receipt_included: Boolean, printed_card_included: Boolean): SetGiftOptionsOnCartOutput @doc(description: "Set gift options like gift wrapping or gift message for the entire cart") - removeGiftOptionsOnCart(cart_id: String!, gift_wrapping_id: ID, gift_receipt_included: Boolean, printed_card_included: Boolean): RemoveGiftOptionsOnCartOutput @doc(description: "Remove gift options gift wrapping for the entire cart") + setGiftOptionsOnCart(input: SetGiftOptionsOnCartInput): SetGiftOptionsOnCartOutput @doc(description: "Set gift options like gift wrapping or gift message for the entire cart") } +input SetGiftOptionsOnCartInput{ + cart_id: String! @doc(description:"The unique ID that identifies the shopper's cart") + gift_message: GiftMessageInput @doc(description: "Gift message details for the cart") + gift_wrapping_id: ID @doc(description: "The unique identifier of the gift wrapping to be used for the cart") + printed_card_included: Boolean! @doc(description: "Whether customer requested printed card for the cart") + gift_receipt_included: Boolean! @doc(description: "Whether customer requested gift receipt for the cart") +} ###### End: Extending existing types ###### @@ -213,12 +216,10 @@ type Mutation { type SetGiftOptionsOnCartOutput { cart: Cart! @doc(description: "The modified cart object") } -type RemoveGiftOptionsOnCartOutput { - cart: Cart! @doc(description: "The modified cart object") -} -type GiftMessageInput { + +input GiftMessageInput { to: String! @doc(description: "Recepient name") from: String! @doc(description: "Sender name") message: String! @doc(description: "Gift message text") From e1c7b39ab01fe0b4dc456c28f007f37707ee40a2 Mon Sep 17 00:00:00 2001 From: Anusha Vattam Date: Fri, 7 Aug 2020 18:38:34 -0500 Subject: [PATCH 237/479] removed gift_wrapping from salesItemInterface on schema --- design-documents/graph-ql/coverage/gift-wrapping.md | 1 - 1 file changed, 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/gift-wrapping.md b/design-documents/graph-ql/coverage/gift-wrapping.md index 5e8f200b4..cb5954742 100644 --- a/design-documents/graph-ql/coverage/gift-wrapping.md +++ b/design-documents/graph-ql/coverage/gift-wrapping.md @@ -41,7 +41,6 @@ type GiftCardCartItem { } type SalesItemInterface { - gift_wrapping: GiftWrapping @doc(description: "The selected gift wrapping for the order item") gift_message: GiftMessage @doc(description: "The entered gift message for the order item") } From 665f6002b52199bdc192deeee152733ecfe97919 Mon Sep 17 00:00:00 2001 From: Anusha Vattam Date: Fri, 7 Aug 2020 21:29:36 -0500 Subject: [PATCH 238/479] merge conflicts --- design-documents/graph-ql/coverage/gift-wrapping.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/gift-wrapping.md b/design-documents/graph-ql/coverage/gift-wrapping.md index cb5954742..85ffbc3b6 100644 --- a/design-documents/graph-ql/coverage/gift-wrapping.md +++ b/design-documents/graph-ql/coverage/gift-wrapping.md @@ -48,7 +48,6 @@ interface OrderItemInterface { gift_wrapping: GiftWrapping @resolver(class: "Magento\\GiftWrappingGraphQl\\Model\\Resolver\\Order\\Item\\GiftWrapping") @doc(description: "The selected gift wrapping for the order item") } - type CustomerOrder { gift_wrapping: GiftWrapping @doc(description: "The selected gift wrapping for the order") printed_card_included: Boolean! @doc(description: "Whether customer requested printed card for the order") @@ -216,8 +215,6 @@ type SetGiftOptionsOnCartOutput { cart: Cart! @doc(description: "The modified cart object") } - - input GiftMessageInput { to: String! @doc(description: "Recepient name") from: String! @doc(description: "Sender name") From 6c1ff15c311a0fb57a6a225053f8a164cee76222 Mon Sep 17 00:00:00 2001 From: oleksandrkravchuk Date: Sat, 8 Aug 2020 15:50:05 +0300 Subject: [PATCH 239/479] GraphQl Schema actualization with latest released changes. Add ProductInfo to the schema for intesection search. --- .../graph-ql/coverage/store-pickup.graphqls | 62 ++++++++++++++++--- 1 file changed, 54 insertions(+), 8 deletions(-) diff --git a/design-documents/graph-ql/coverage/store-pickup.graphqls b/design-documents/graph-ql/coverage/store-pickup.graphqls index 772484150..a4db6f882 100644 --- a/design-documents/graph-ql/coverage/store-pickup.graphqls +++ b/design-documents/graph-ql/coverage/store-pickup.graphqls @@ -1,12 +1,15 @@ type Query { pickupLocations ( - filter: PickupLocationFilterInput, + area: AreaInput, + filters: PickupLocationFilterInput, + sort: PickupLocationSortInput, pageSize: Int = 20, - currentPage: Int = 1 + currentPage: Int = 1, + productsInfo: [ProductInfoInput] ): PickupLocations } -input PickupLocationFilterInput { +input AreaInput { # This type is added for extensibility search_term: String! # Depending on the distance calculation algorithm selected in the admin, this field will require ZIP code (for offline mode) or arbitrary part of the address (for Google mode). IMPORTANT: Current mode must be exposed as part of storeConfig query and used on the client to display different hints for the input field radius: Int # This field is not part of MVP and can be added later. IMPORTANT: Radius units must be exposed as part of storeConfig query and displayed on the client @@ -18,12 +21,55 @@ type PickupLocations { total_count: Int } +input PickupLocationFilterInput { + name: FilterTypeInput + pickup_location_code: FilterTypeInput + country_id: FilterTypeInput + postcode: FilterTypeInput + region: FilterTypeInput + region_id: FilterTypeInput + city: FilterTypeInput + street: FilterTypeInput +} + +input PickupLocationSortInput { + name: SortEnum + pickup_location_code: SortEnum + distance: SortEnum + country_id: SortEnum + region: SortEnum + region_id: SortEnum + city: SortEnum + street: SortEnum + postcode: SortEnum + longitude: SortEnum + latitude: SortEnum + email: SortEnum + fax: SortEnum + phone: SortEnum + contact_name: SortEnum + description: SortEnum +} + type PickupLocation { + pickup_location_code: String name: String! # In the admin is called Frontend Name description: String! # In the admin is called Frontend Description - country: String! - region: String! - city: String! - street: String! - postcode: String! + email: String + fax: String + contact_name: String + latitude: Float + longitude: Float + country_id: String + region_id: Int + region: String + city: String + street: String + postcode: String + phone: String +} + +# Used in products assignment intersection search - select Pickup Locations which can be used to deliver all products in the request. +input ProductInfoInput { + sku: String! } From 68e693e6ac00367a06bac32c2f2ca072a3da6476 Mon Sep 17 00:00:00 2001 From: Daniel Renaud Date: Mon, 10 Aug 2020 10:14:22 -0500 Subject: [PATCH 240/479] Add additional product types --- .../graph-ql/coverage/customer-orders.md | 49 ++++++++++++++----- 1 file changed, 36 insertions(+), 13 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer-orders.md b/design-documents/graph-ql/coverage/customer-orders.md index a79db05ad..e6129f034 100644 --- a/design-documents/graph-ql/coverage/customer-orders.md +++ b/design-documents/graph-ql/coverage/customer-orders.md @@ -77,7 +77,7 @@ type CustomerOrder { billing_address: OrderAddress @doc("billing address for the order") carrier: String @doc("shipping carrier for the order delivery") shipping_method: String @doc("shipping method for the order") - comments: [CommentItem] @doc("comments on the order") + comments: [SalesCommentItem] @doc("comments on the order") } ``` @@ -129,20 +129,23 @@ type ItemSelectedBundleOptionValue { } type DownloadableOrderItem implements OrderItemInterface { - downloadable_links: [DownloadableItemsLinks] @doc(description: "A list of downloadable links that are ordered from the downloadable product") @resolver(class: "Magento\\DownloadableGraphQl\\Resolver\\DownloadableOrderItem\\Links") + downloadable_links: [DownloadableItemsLinks] @doc(description: "A list of downloadable links that are ordered from the downloadable product") } + type DownloadableItemsLinks @doc(description: "DownloadableProductLinks defines characteristics of a downloadable product") { title: String @doc(description: "The display name of the link") sort_order: Int @doc(description: "A number indicating the sort order") - uid: ID! @doc(description: "A string that encodes option details.") @resolver(class: "Magento\\DownloadableGraphQl\\Resolver\\Product\\DownloadableLinksValueUid") # A Base64 string that encodes option details. + uid: ID! @doc(description: "A string that encodes option details.") } type GiftCardOrderItem implements OrderItemInterface { - gift_card: GiftCardItem @doc(description: "Selected gift card properties for an order item") @resolver(class: "Magento\\GiftCardGraphQl\\Model\\Resolver\\OrderItem\\GiftCardItem") + gift_card: GiftCardItem @doc(description: "Selected gift card properties for an order item") } type GiftCardItem { - sender_name: String @doc(description: "Entered gift card sender name and email") - recipient_name: String @doc(description: "Entered gift card recipient name and email") + sender_name: String @doc(description: "Entered gift card sender name") + sender_email: String @doc(description: "Entered gift card sender email") + recipient_name: String @doc(description: "Entered gift card recipient name") + recipient_email: String @doc(description: "Entered gift card recipient email") message: String @doc(description: "Entered gift card message intended for the recipient") } @@ -216,7 +219,7 @@ type Invoice { number: String! @doc("sequential invoice number") total: InvoiceTotal @doc("invoice total amount details") items: [InvoiceItemInterface] @doc("invoiced product details") - comments: [CommentItem] @doc("comments on the invoice") + comments: [SalesCommentItem] @doc("comments on the invoice") } @doc("Invoice item details") @@ -237,6 +240,14 @@ type BundleInvoiceItem implements InvoiceItemInterface { bundle_options: [ItemSelectedBundleOption] @doc("A list of bundle options that are assigned to the bundle product") } +type DownloadableInvoiceItem implements InvoiceItemInterface { + downloadable_links: [DownloadableItemsLinks] @doc(description: "A list of downloadable links that are invoiced from the downloadable product") +} + +type GiftCardInvoiceItem implements InvoiceItemInterface { + gift_card: GiftCardItem @doc(description: "Selected gift card properties for an invoice item") +} + @doc("Invoice total amount details") type InvoiceTotal { subtotal: Money! @doc("subtotal amount excluding, shipping, discounts and tax") @@ -253,16 +264,16 @@ type InvoiceTotal { ## Refund Type Schema The credit memo entity will have the similar to the order and invoice schema: -The `id` will be a `base64_encode_encode(increment_id)` which in future can be replaced by UUID. +The `id` will be a `base64encode(increment_id)` which in future can be replaced by UUID. ```graphql @doc("Credit memo details") type CreditMemo { id: ID! @doc("the ID of the credit memo, used for API purposes") number: String! @doc("sequential credit memo number") - items: [CreditMemoItem] @doc("items refunded") + items: [CreditMemoItemInterface] @doc("items refunded") total: CreditMemoTotal @doc("refund total amount details") - comments: [CommentItem] @doc("comments on the credit memo") + comments: [SalesCommentItem] @doc("comments on the credit memo") } @doc("Credit memo item details") @@ -283,6 +294,14 @@ type BundleCreditMemoItem implements CreditMemoIntemInterface { bundle_options: [ItemSelectedBundleOption] } +type DownloadableCreditMemoItem implements CreditMemoItemInterface { + downloadable_links: [DownloadableItemsLinks] @doc(description: "A list of downloadable links that are refunded from the downloadable product") +} + +type GiftCardCreditMemoItem implements CreditMemoItemInterface { + gift_card: GiftCardItem @doc(description: "Selected gift card properties for a credit memo item") +} + @doc("Credit memo price details") type CreditMemoTotal { subtotal: Money! @doc("subtotal amount excluding, shipping, discounts and tax") @@ -302,8 +321,8 @@ type OrderShipment { id: ID! @doc("the ID of the shipment, used for API purposes") number: String! @doc("sequential credit shipment number") tracking: [ShipmentTracking] @doc("shipment tracking details") - items: [ShipmentItem] @doc("items included in the shipment") - comments: [CommentItem] @doc("comments on the shipment") + items: [ShipmentItemInterface] @doc("items included in the shipment") + comments: [SalesCommentItem] @doc("comments on the shipment") } @doc("Order shipment item details") @@ -323,6 +342,10 @@ type BundleShipmentItem implements ShipmentItemInterface { bundle_options: [ItemSelectedBundleOption] } +type GiftCardShipmentItem implements ShipmentItemInterface { + gift_card: GiftCardItem @doc(description: "Selected gift card properties for a shipment item") +} + @doc("Order shipment tracking details") type ShipmentTracking { title: String! @doc("shipment tracking title") @@ -331,7 +354,7 @@ type ShipmentTracking { } ``` -## CommentItem type +## SalesCommentItem type ```graphql type SalesCommentItem { timestamp: String! @doc("The timestamp of the comment") From aabf21febf3f056f6821fa6960c09cb6fb2a54d3 Mon Sep 17 00:00:00 2001 From: Daniel Renaud Date: Mon, 10 Aug 2020 10:44:04 -0500 Subject: [PATCH 241/479] Fix payment_methods field --- design-documents/graph-ql/coverage/customer-orders.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer-orders.md b/design-documents/graph-ql/coverage/customer-orders.md index e6129f034..9242f256c 100644 --- a/design-documents/graph-ql/coverage/customer-orders.md +++ b/design-documents/graph-ql/coverage/customer-orders.md @@ -72,7 +72,7 @@ type CustomerOrder { invoices: [Invoice] @doc("invoice list for the order") credit_memos: [CreditMemo] @doc("credit memo list for the order") shipments: [OrderShipment] @doc("shipment list for the order") - payment_methods: [PaymentMethod] @doc("payment details for the order") + payment_methods: [OrderPaymentMethod] @doc("payment details for the order") shipping_address: OrderAddress @doc("shipping address for the order") billing_address: OrderAddress @doc("billing address for the order") carrier: String @doc("shipping carrier for the order delivery") From f1bedde301c8909190e8f8e4e775658dbb809c03 Mon Sep 17 00:00:00 2001 From: Daniel Renaud Date: Mon, 10 Aug 2020 11:06:54 -0500 Subject: [PATCH 242/479] Fix type for order item id --- design-documents/graph-ql/coverage/customer-orders.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer-orders.md b/design-documents/graph-ql/coverage/customer-orders.md index 9242f256c..2f66f05b4 100644 --- a/design-documents/graph-ql/coverage/customer-orders.md +++ b/design-documents/graph-ql/coverage/customer-orders.md @@ -151,7 +151,7 @@ type GiftCardItem { @doc("Represents order item options like selected or entered") type OrderItemOption { - id: String! @doc("name of the option") + id: ID! @doc("name of the option") value: String! @doc("value of the option") } ``` From 46a863ac45d06cdb094eab332c8615e946223caa Mon Sep 17 00:00:00 2001 From: Daniel Renaud Date: Mon, 10 Aug 2020 11:41:38 -0500 Subject: [PATCH 243/479] Fix order item option type --- design-documents/graph-ql/coverage/customer-orders.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer-orders.md b/design-documents/graph-ql/coverage/customer-orders.md index 2f66f05b4..c11b40e04 100644 --- a/design-documents/graph-ql/coverage/customer-orders.md +++ b/design-documents/graph-ql/coverage/customer-orders.md @@ -151,7 +151,7 @@ type GiftCardItem { @doc("Represents order item options like selected or entered") type OrderItemOption { - id: ID! @doc("name of the option") + label: String! @doc("name of the option") value: String! @doc("value of the option") } ``` From a2d90a0c275826e81d248266db20c6d4f273c92d Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Mon, 10 Aug 2020 12:00:52 -0500 Subject: [PATCH 244/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 49 ++++++++++++++++--- .../graph-ql/coverage/b2b/purchase-order.md | 7 ++- 2 files changed, 47 insertions(+), 9 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index 1a11024f1..02a083ea9 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -15,13 +15,48 @@ type PurchaseOrders { } type PurchaseOrder { - uid: ID! - number: String! - order: CustomerOrder - created_at: String! - created_by: String! - status: PurchaseOrderStatus! - total: Money! + uid: ID! @doc(description: "Unique identifier for the purcahse order") + number: String! @doc(description: "The purchase order number") + order: CustomerOrder @doc(description: "The reference to the order placed based on the purchase order") + purchase_order_date: String! @doc(description: "The date the purchase order was created") + created_by: String! @doc(description: "The name of the user who created the purchase order") + status: PurchaseOrderStatus! @doc(description: "The current status of the purcahse order") + total: PurchaseOrderTotal @doc(description: "Contains details about the calculated totals for the purchase order") + items: [PurchaseOrderItem] @doc(description: "An array containing the items in this purchase order") + payment_methods: [PaymentMethod] @doc(description: "Payment details for the purchase order") + shipping_address: CustomerAddress @doc(description: "The shipping address for the purchase order") + billing_address: CustomerAddress @doc(description: "The billing address for the purchase order") + carrier: String @doc(description: "The shipping carrier for the purchase order delivery") + shipping_method: String @doc(description: "The delivery method for the purchase order") +} + +type PurchaseOrderTotal @doc(description: "Contains details about the sales total amounts used to calculate the final price") { + subtotal: Money! @doc(description: "The subtotal of the purchase order, excluding shipping, discounts, and taxes") + discounts: [Discount] @doc(description: "The applied discounts to the purchase order") + estimated_total_tax: Money! @doc(description: "The amount of tax applied to the purchase order") + estimated_taxes: [TaxItem] @doc(description: "The purchase order tax details") + grand_total: Money! @doc(description: "The final total amount, including shipping, discounts, and taxes") + base_grand_total: Money! @doc(description: "The final base grand total amount in the base currency") + total_shipping: Money! @doc(description: "The shipping amount for the order") + shipping_handling: ShippingHandling @doc(description: "Contains details about the shipping and handling costs for the purchase purchase order") +} + +type PurchaseOrderItem @doc(description: "Purchase order item details") { + uid: ID! @doc(description: "The unique identifier of the purchase order item") + product_name: String @doc(description: "The name of the base product") + product_sku: String! @doc(description: "The SKU of the base product") + product_url_key: String @doc(description: "URL key of the base product") + product_type: String @doc(description: "The type of product, such as simple, configurable, or bundle") + product_sale_price: Money! @doc(description: "The sale price of the base product, including selected options") + discounts: [Discount] @doc(description: "The final discount information for the product") + selected_options: [PurchaseOrderItemOption] @doc(description: "The selected options for the base product, such as color or size") + entered_options: [PurchaseOrderItemOption] @doc(description: "The entered option for the base product, such as a logo or image") + quantity: Float @doc(description: "The number of units for this item") +} + +type PurchaseOrderItemOption @doc(description: "Represents purcahse order item options like selected or entered") { + uid: ID! @doc(description: "The name of the option") + value: String! @doc(description: "The value of the option") } enum PurchaseOrderStatus { diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index bdd293fea..a4deb714b 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -103,8 +103,6 @@ ``` ### View purchase order details -Should support pagination. - #### Items Should support pagination. @@ -155,4 +153,9 @@ Should support pagination. ### Delete approval rule +## Implementation details + +The purchase order GraphQL schema depends on Sales and Customer GraphQL schemas. + + From 6400074dbd6206411e14c9d0545eebbbdcc4c1b0 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Mon, 10 Aug 2020 14:06:27 -0500 Subject: [PATCH 245/479] MC-36365: Schema for B2B purchase order details - Documented existing GraphQL schema for customer --- .../coverage/customer/customer.graphqls | 395 ++++++++++++++++++ 1 file changed, 395 insertions(+) create mode 100644 design-documents/graph-ql/coverage/customer/customer.graphqls diff --git a/design-documents/graph-ql/coverage/customer/customer.graphqls b/design-documents/graph-ql/coverage/customer/customer.graphqls new file mode 100644 index 000000000..2577d29cd --- /dev/null +++ b/design-documents/graph-ql/coverage/customer/customer.graphqls @@ -0,0 +1,395 @@ +# Copyright © Magento, Inc. All rights reserved. +# See COPYING.txt for license details. + +type StoreConfig { + required_character_classes_number : String @doc(description: "The number of different character classes required in a password (lowercase, uppercase, digits, special characters).") + minimum_password_length : String @doc(description: "The minimum number of characters required for a valid password.") + autocomplete_on_storefront : Boolean @doc(description: "Enable autocomplete on login and forgot password forms") +} + +type Query { + customer: Customer @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\Customer") @doc(description: "The customer query returns information about a customer account") @cache(cacheable: false) + isEmailAvailable ( + email: String! @doc(description: "The new customer email") + ): IsEmailAvailableOutput @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\IsEmailAvailable") +} + +type Mutation { + generateCustomerToken(email: String!, password: String!): CustomerToken @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\GenerateCustomerToken") @doc(description:"Retrieve the customer token") + changeCustomerPassword(currentPassword: String!, newPassword: String!): Customer @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\ChangePassword") @doc(description:"Changes the password for the logged-in customer") + createCustomer (input: CustomerInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomer") @doc(description:"Create customer account") + updateCustomer (input: CustomerInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomer") @doc(description:"Update the customer's personal information") + revokeCustomerToken: RevokeCustomerTokenOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\RevokeCustomerToken") @doc(description:"Revoke the customer token") + createCustomerAddress(input: CustomerAddressInput!): CustomerAddress @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomerAddress") @doc(description: "Create customer address") + updateCustomerAddress(id: Int!, input: CustomerAddressInput): CustomerAddress @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomerAddress") @doc(description: "Update customer address") + deleteCustomerAddress(id: Int!): Boolean @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\DeleteCustomerAddress") @doc(description: "Delete customer address") + requestPasswordResetEmail(email: String!): Boolean @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\RequestPasswordResetEmail") @doc(description: "Request an email with a reset password token for the registered customer identified by the specified email.") + resetPassword(email: String!, resetPasswordToken: String!, newPassword: String!): Boolean @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\ResetPassword") @doc(description: "Reset a customer's password using the reset password token that the customer received in an email after requesting it using requestPasswordResetEmail.") +} + +input CustomerAddressInput { + firstname: String @doc(description: "The first name of the person associated with the shipping/billing address") + lastname: String @doc(description: "The family name of the person associated with the shipping/billing address") + company: String @doc(description: "The customer's company") + telephone: String @doc(description: "The telephone number") + street: [String] @doc(description: "An array of strings that define the street number and name") + city: String @doc(description: "The city or town") + region: CustomerAddressRegionInput @doc(description: "An object containing the region name, region code, and region ID") + postcode: String @doc(description: "The customer's ZIP or postal code") + country_id: CountryCodeEnum @doc(description: "Deprecated: use `country_code` instead.") + country_code: CountryCodeEnum @doc(description: "The customer's country") + default_shipping: Boolean @doc(description: "Indicates whether the address is the default shipping address") + default_billing: Boolean @doc(description: "Indicates whether the address is the default billing address") + fax: String @doc(description: "The fax number") + middlename: String @doc(description: "The middle name of the person associated with the shipping/billing address") + prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.") + suffix: String @doc(description: "A value such as Sr., Jr., or III") + vat_id: String @doc(description: "The customer's Tax/VAT number (for corporate customers)") + custom_attributes: [CustomerAddressAttributeInput] @doc(description: "Deprecated: Custom attributes should not be put into container.") +} + +input CustomerAddressRegionInput @doc(description: "CustomerAddressRegionInput defines the customer's state or province") { + region_code: String @doc(description: "The address region code") + region: String @doc(description: "The state or province name") + region_id: Int @doc(description: "The unique ID for a pre-defined region") +} + +input CustomerAddressAttributeInput { + attribute_code: String! @doc(description: "Attribute code") + value: String! @doc(description: "Attribute value") +} + +type CustomerToken { + token: String @doc(description: "The customer token") +} + +input CustomerInput { + prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.") + firstname: String @doc(description: "The customer's first name") + middlename: String @doc(description: "The customer's middle name") + lastname: String @doc(description: "The customer's family name") + suffix: String @doc(description: "A value such as Sr., Jr., or III") + email: String @doc(description: "The customer's email address. Required for customer creation") + dob: String @doc(description: "Deprecated: Use `date_of_birth` instead") + date_of_birth: String @doc(description: "The customer's date of birth") + taxvat: String @doc(description: "The customer's Tax/VAT number (for corporate customers)") + gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2)") + password: String @doc(description: "The customer's password") + is_subscribed: Boolean @doc(description: "Indicates whether the customer is subscribed to the company's newsletter") +} + +type CustomerOutput { + customer: Customer! +} + +type RevokeCustomerTokenOutput { + result: Boolean! +} + +type Customer @doc(description: "Customer defines the customer name and address and other details") { + created_at: String @doc(description: "Timestamp indicating when the account was created") + group_id: Int @deprecated(reason: "Customer group should not be exposed in the storefront scenarios") + prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.") + firstname: String @doc(description: "The customer's first name") + middlename: String @doc(description: "The customer's middle name") + lastname: String @doc(description: "The customer's family name") + suffix: String @doc(description: "A value such as Sr., Jr., or III") + email: String @doc(description: "The customer's email address. Required") + default_billing: String @doc(description: "The ID assigned to the billing address") + default_shipping: String @doc(description: "The ID assigned to the shipping address") + dob: String @doc(description: "The customer's date of birth") @deprecated(reason: "Use `date_of_birth` instead") + date_of_birth: String @doc(description: "The customer's date of birth") + taxvat: String @doc(description: "The customer's Value-added tax (VAT) number (for corporate customers)") + id: Int @doc(description: "The ID assigned to the customer") @deprecated(reason: "id is not needed as part of Customer because on server side it can be identified based on customer token used for authentication. There is no need to know customer ID on the client side.") + is_subscribed: Boolean @doc(description: "Indicates whether the customer is subscribed to the company's newsletter") @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\IsSubscribed") + addresses: [CustomerAddress] @doc(description: "An array containing the customer's shipping and billing addresses") @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CustomerAddresses") + gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2)") +} + +type CustomerAddress @doc(description: "CustomerAddress contains detailed information about a customer's billing and shipping addresses"){ + id: Int @doc(description: "The ID assigned to the address object") + customer_id: Int @doc(description: "The customer ID") @deprecated(reason: "customer_id is not needed as part of CustomerAddress, address ID (id) is unique identifier for the addresses.") + region: CustomerAddressRegion @doc(description: "An object containing the region name, region code, and region ID") + region_id: Int @doc(description: "The unique ID for a pre-defined region") + country_id: String @doc(description: "The customer's country") @deprecated(reason: "Use `country_code` instead.") + country_code: CountryCodeEnum @doc(description: "The customer's country") + street: [String] @doc(description: "An array of strings that define the street number and name") + company: String @doc(description: "The customer's company") + telephone: String @doc(description: "The telephone number") + fax: String @doc(description: "The fax number") + postcode: String @doc(description: "The customer's ZIP or postal code") + city: String @doc(description: "The city or town") + firstname: String @doc(description: "The first name of the person associated with the shipping/billing address") + lastname: String @doc(description: "The family name of the person associated with the shipping/billing address") + middlename: String @doc(description: "The middle name of the person associated with the shipping/billing address") + prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.") + suffix: String @doc(description: "A value such as Sr., Jr., or III") + vat_id: String @doc(description: "The customer's Value-added tax (VAT) number (for corporate customers)") + default_shipping: Boolean @doc(description: "Indicates whether the address is the default shipping address") + default_billing: Boolean @doc(description: "Indicates whether the address is the default billing address") + custom_attributes: [CustomerAddressAttribute] @deprecated(reason: "Custom attributes should not be put into container") + extension_attributes: [CustomerAddressAttribute] @doc(description: "Address extension attributes") +} + +type CustomerAddressRegion @doc(description: "CustomerAddressRegion defines the customer's state or province") { + region_code: String @doc(description: "The address region code") + region: String @doc(description: "The state or province name") + region_id: Int @doc(description: "The unique ID for a pre-defined region") +} + +type CustomerAddressAttribute { + attribute_code: String @doc(description: "Attribute code") + value: String @doc(description: "Attribute value") +} + +type IsEmailAvailableOutput { + is_email_available: Boolean @doc(description: "Is email availabel value") +} + +enum CountryCodeEnum @doc(description: "The list of countries codes") { + AF @doc(description: "Afghanistan") + AX @doc(description: "Åland Islands") + AL @doc(description: "Albania") + DZ @doc(description: "Algeria") + AS @doc(description: "American Samoa") + AD @doc(description: "Andorra") + AO @doc(description: "Angola") + AI @doc(description: "Anguilla") + AQ @doc(description: "Antarctica") + AG @doc(description: "Antigua & Barbuda") + AR @doc(description: "Argentina") + AM @doc(description: "Armenia") + AW @doc(description: "Aruba") + AU @doc(description: "Australia") + AT @doc(description: "Austria") + AZ @doc(description: "Azerbaijan") + BS @doc(description: "Bahamas") + BH @doc(description: "Bahrain") + BD @doc(description: "Bangladesh") + BB @doc(description: "Barbados") + BY @doc(description: "Belarus") + BE @doc(description: "Belgium") + BZ @doc(description: "Belize") + BJ @doc(description: "Benin") + BM @doc(description: "Bermuda") + BT @doc(description: "Bhutan") + BO @doc(description: "Bolivia") + BA @doc(description: "Bosnia & Herzegovina") + BW @doc(description: "Botswana") + BV @doc(description: "Bouvet Island") + BR @doc(description: "Brazil") + IO @doc(description: "British Indian Ocean Territory") + VG @doc(description: "British Virgin Islands") + BN @doc(description: "Brunei") + BG @doc(description: "Bulgaria") + BF @doc(description: "Burkina Faso") + BI @doc(description: "Burundi") + KH @doc(description: "Cambodia") + CM @doc(description: "Cameroon") + CA @doc(description: "Canada") + CV @doc(description: "Cape Verde") + KY @doc(description: "Cayman Islands") + CF @doc(description: "Central African Republic") + TD @doc(description: "Chad") + CL @doc(description: "Chile") + CN @doc(description: "China") + CX @doc(description: "Christmas Island") + CC @doc(description: "Cocos (Keeling) Islands") + CO @doc(description: "Colombia") + KM @doc(description: "Comoros") + CG @doc(description: "Congo-Brazzaville") + CD @doc(description: "Congo-Kinshasa") + CK @doc(description: "Cook Islands") + CR @doc(description: "Costa Rica") + CI @doc(description: "Côte d’Ivoire") + HR @doc(description: "Croatia") + CU @doc(description: "Cuba") + CY @doc(description: "Cyprus") + CZ @doc(description: "Czech Republic") + DK @doc(description: "Denmark") + DJ @doc(description: "Djibouti") + DM @doc(description: "Dominica") + DO @doc(description: "Dominican Republic") + EC @doc(description: "Ecuador") + EG @doc(description: "Egypt") + SV @doc(description: "El Salvador") + GQ @doc(description: "Equatorial Guinea") + ER @doc(description: "Eritrea") + EE @doc(description: "Estonia") + ET @doc(description: "Ethiopia") + FK @doc(description: "Falkland Islands") + FO @doc(description: "Faroe Islands") + FJ @doc(description: "Fiji") + FI @doc(description: "Finland") + FR @doc(description: "France") + GF @doc(description: "French Guiana") + PF @doc(description: "French Polynesia") + TF @doc(description: "French Southern Territories") + GA @doc(description: "Gabon") + GM @doc(description: "Gambia") + GE @doc(description: "Georgia") + DE @doc(description: "Germany") + GH @doc(description: "Ghana") + GI @doc(description: "Gibraltar") + GR @doc(description: "Greece") + GL @doc(description: "Greenland") + GD @doc(description: "Grenada") + GP @doc(description: "Guadeloupe") + GU @doc(description: "Guam") + GT @doc(description: "Guatemala") + GG @doc(description: "Guernsey") + GN @doc(description: "Guinea") + GW @doc(description: "Guinea-Bissau") + GY @doc(description: "Guyana") + HT @doc(description: "Haiti") + HM @doc(description: "Heard & McDonald Islands") + HN @doc(description: "Honduras") + HK @doc(description: "Hong Kong SAR China") + HU @doc(description: "Hungary") + IS @doc(description: "Iceland") + IN @doc(description: "India") + ID @doc(description: "Indonesia") + IR @doc(description: "Iran") + IQ @doc(description: "Iraq") + IE @doc(description: "Ireland") + IM @doc(description: "Isle of Man") + IL @doc(description: "Israel") + IT @doc(description: "Italy") + JM @doc(description: "Jamaica") + JP @doc(description: "Japan") + JE @doc(description: "Jersey") + JO @doc(description: "Jordan") + KZ @doc(description: "Kazakhstan") + KE @doc(description: "Kenya") + KI @doc(description: "Kiribati") + KW @doc(description: "Kuwait") + KG @doc(description: "Kyrgyzstan") + LA @doc(description: "Laos") + LV @doc(description: "Latvia") + LB @doc(description: "Lebanon") + LS @doc(description: "Lesotho") + LR @doc(description: "Liberia") + LY @doc(description: "Libya") + LI @doc(description: "Liechtenstein") + LT @doc(description: "Lithuania") + LU @doc(description: "Luxembourg") + MO @doc(description: "Macau SAR China") + MK @doc(description: "Macedonia") + MG @doc(description: "Madagascar") + MW @doc(description: "Malawi") + MY @doc(description: "Malaysia") + MV @doc(description: "Maldives") + ML @doc(description: "Mali") + MT @doc(description: "Malta") + MH @doc(description: "Marshall Islands") + MQ @doc(description: "Martinique") + MR @doc(description: "Mauritania") + MU @doc(description: "Mauritius") + YT @doc(description: "Mayotte") + MX @doc(description: "Mexico") + FM @doc(description: "Micronesia") + MD @doc(description: "Moldova") + MC @doc(description: "Monaco") + MN @doc(description: "Mongolia") + ME @doc(description: "Montenegro") + MS @doc(description: "Montserrat") + MA @doc(description: "Morocco") + MZ @doc(description: "Mozambique") + MM @doc(description: "Myanmar (Burma)") + NA @doc(description: "Namibia") + NR @doc(description: "Nauru") + NP @doc(description: "Nepal") + NL @doc(description: "Netherlands") + AN @doc(description: "Netherlands Antilles") + NC @doc(description: "New Caledonia") + NZ @doc(description: "New Zealand") + NI @doc(description: "Nicaragua") + NE @doc(description: "Niger") + NG @doc(description: "Nigeria") + NU @doc(description: "Niue") + NF @doc(description: "Norfolk Island") + MP @doc(description: "Northern Mariana Islands") + KP @doc(description: "North Korea") + NO @doc(description: "Norway") + OM @doc(description: "Oman") + PK @doc(description: "Pakistan") + PW @doc(description: "Palau") + PS @doc(description: "Palestinian Territories") + PA @doc(description: "Panama") + PG @doc(description: "Papua New Guinea") + PY @doc(description: "Paraguay") + PE @doc(description: "Peru") + PH @doc(description: "Philippines") + PN @doc(description: "Pitcairn Islands") + PL @doc(description: "Poland") + PT @doc(description: "Portugal") + QA @doc(description: "Qatar") + RE @doc(description: "Réunion") + RO @doc(description: "Romania") + RU @doc(description: "Russia") + RW @doc(description: "Rwanda") + WS @doc(description: "Samoa") + SM @doc(description: "San Marino") + ST @doc(description: "São Tomé & Príncipe") + SA @doc(description: "Saudi Arabia") + SN @doc(description: "Senegal") + RS @doc(description: "Serbia") + SC @doc(description: "Seychelles") + SL @doc(description: "Sierra Leone") + SG @doc(description: "Singapore") + SK @doc(description: "Slovakia") + SI @doc(description: "Slovenia") + SB @doc(description: "Solomon Islands") + SO @doc(description: "Somalia") + ZA @doc(description: "South Africa") + GS @doc(description: "South Georgia & South Sandwich Islands") + KR @doc(description: "South Korea") + ES @doc(description: "Spain") + LK @doc(description: "Sri Lanka") + BL @doc(description: "St. Barthélemy") + SH @doc(description: "St. Helena") + KN @doc(description: "St. Kitts & Nevis") + LC @doc(description: "St. Lucia") + MF @doc(description: "St. Martin") + PM @doc(description: "St. Pierre & Miquelon") + VC @doc(description: "St. Vincent & Grenadines") + SD @doc(description: "Sudan") + SR @doc(description: "Suriname") + SJ @doc(description: "Svalbard & Jan Mayen") + SZ @doc(description: "Swaziland") + SE @doc(description: "Sweden") + CH @doc(description: "Switzerland") + SY @doc(description: "Syria") + TW @doc(description: "Taiwan") + TJ @doc(description: "Tajikistan") + TZ @doc(description: "Tanzania") + TH @doc(description: "Thailand") + TL @doc(description: "Timor-Leste") + TG @doc(description: "Togo") + TK @doc(description: "Tokelau") + TO @doc(description: "Tonga") + TT @doc(description: "Trinidad & Tobago") + TN @doc(description: "Tunisia") + TR @doc(description: "Turkey") + TM @doc(description: "Turkmenistan") + TC @doc(description: "Turks & Caicos Islands") + TV @doc(description: "Tuvalu") + UG @doc(description: "Uganda") + UA @doc(description: "Ukraine") + AE @doc(description: "United Arab Emirates") + GB @doc(description: "United Kingdom") + US @doc(description: "United States") + UY @doc(description: "Uruguay") + UM @doc(description: "U.S. Outlying Islands") + VI @doc(description: "U.S. Virgin Islands") + UZ @doc(description: "Uzbekistan") + VU @doc(description: "Vanuatu") + VA @doc(description: "Vatican City") + VE @doc(description: "Venezuela") + VN @doc(description: "Vietnam") + WF @doc(description: "Wallis & Futuna") + EH @doc(description: "Western Sahara") + YE @doc(description: "Yemen") + ZM @doc(description: "Zambia") + ZW @doc(description: "Zimbabwe") +} From 57f33eac58b74a4bbd1d0e3b744880f8eb3b0598 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Mon, 10 Aug 2020 14:11:34 -0500 Subject: [PATCH 246/479] MC-36365: Schema for B2B purchase order details - Introduced `country` field in `CustomerAddress` to be able to fetch country name from the customer address - Deprecated `region_id` and `country_code` --- .../graph-ql/coverage/customer/customer.graphqls | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/customer.graphqls b/design-documents/graph-ql/coverage/customer/customer.graphqls index 2577d29cd..42075d0f8 100644 --- a/design-documents/graph-ql/coverage/customer/customer.graphqls +++ b/design-documents/graph-ql/coverage/customer/customer.graphqls @@ -110,9 +110,10 @@ type CustomerAddress @doc(description: "CustomerAddress contains detailed inform id: Int @doc(description: "The ID assigned to the address object") customer_id: Int @doc(description: "The customer ID") @deprecated(reason: "customer_id is not needed as part of CustomerAddress, address ID (id) is unique identifier for the addresses.") region: CustomerAddressRegion @doc(description: "An object containing the region name, region code, and region ID") - region_id: Int @doc(description: "The unique ID for a pre-defined region") + region_id: Int @doc(description: "The unique ID for a pre-defined region") @deprecated(reason: "Use `region` instead.") country_id: String @doc(description: "The customer's country") @deprecated(reason: "Use `country_code` instead.") - country_code: CountryCodeEnum @doc(description: "The customer's country") + country_code: CountryCodeEnum @doc(description: "The customer's country") @deprecated(reason: "Use `country` instead.") + country: Country @doc(description: "The customer's country") street: [String] @doc(description: "An array of strings that define the street number and name") company: String @doc(description: "The customer's company") telephone: String @doc(description: "The telephone number") From 34dc68d2b47bd4238f6ae7707d2041a470cf6e8b Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Mon, 10 Aug 2020 14:38:19 -0500 Subject: [PATCH 247/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 6 + .../graph-ql/coverage/b2b/purchase-order.md | 154 +++++++++++++++--- .../catalog/configurable-options-selection.md | 2 +- 3 files changed, 139 insertions(+), 23 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index 02a083ea9..2251bb142 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -1,5 +1,6 @@ type Customer { purchase_orders(filter: PurchaseOrdersFilterInput, currentPage: Int = 1, pageSize: Int = 20): PurchaseOrders + purchase_order(uid: ID!): PurchaseOrder } input PurchaseOrdersFilterInput { @@ -69,3 +70,8 @@ enum PurchaseOrderStatus { REJECTED CANCELED } + +type CustomerAddress { + # This field must be added to the CustomerAddress type definition directly in CustomerGraphQl module + country: Country @doc(description: "The customer's country") +} diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index a4deb714b..130d71220 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -16,12 +16,14 @@ order { number } - created_at + purchase_order_date created_by status total { - currency - value + grand_total { + currency + value + } } } total_count @@ -50,12 +52,14 @@ order { number } - created_at + purchase_order_date created_by status total { - currency - value + grand_total { + currency + value + } } } total_count @@ -83,12 +87,14 @@ order { number } - created_at + purchase_order_date created_by status total { - currency - value + grand_total { + currency + value + } } } total_count @@ -103,19 +109,123 @@ ``` ### View purchase order details -#### Items - -Should support pagination. - -#### Basic details -#### Approval Flow -#### Comments -#### History Log -#### Totals -#### Shipping Address -#### Billing Address -#### Payment Method -#### Shipping Method +The query should allow to fetch the following data: + - Items with pagination + - Basic details + - Approval Flow + - Comments + - History Log + - Totals + - Shipping Address + - Billing Address + - Payment Method + - Shipping Method + +```graphql +{ + customer { + purchase_order(uid: "abc234hsasdfa") { + uid + created_by + purchase_order_date + number + order { + number + } + status + total { + subtotal { + currency + value + } + estimated_taxes { + amount { + currency + value + } + rate + title + } + grand_total { + currency + value + } + shipping_handling { + total_amount { + currency + value + } + } + } + items { + uid + product_name + product_sku + product_url_key + product_type + product_sale_price { + currency + value + } + quantity + selected_options { + uid + value + } + entered_options { + uid + value + } + discounts { + amount { + currency + value + } + label + } + } + payment_methods { + name + type + additional_data { + name + value + } + } + billing_address { + firstname + lastname + street + city + region { + region + } + postcode + country { + full_name_locale + } + telephone + } + carrier + shipping_method + shipping_address { + firstname + lastname + street + city + region { + region + } + postcode + country { + full_name_locale + } + telephone + } + } + } +} +``` ### Add items to cart from purchase order diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md index 74b1c5880..6fdeddf52 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md @@ -178,7 +178,7 @@ In case when the facet filter was used on the category page, for example to sear products(filter: {category_id: {eq: "shorts category ID"}}) { items { name - sku + sku ... on ConfigurableProduct { configurable_options_selection_metadata( selectedConfigurableOptionValues: ["hash from selected red color option"] From cca39016db25fb16eda034d3bab9cb5b248d3f03 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Mon, 10 Aug 2020 14:57:23 -0500 Subject: [PATCH 248/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 8 +++- .../graph-ql/coverage/b2b/purchase-order.md | 48 +++++++++++-------- 2 files changed, 35 insertions(+), 21 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index 2251bb142..a26ddc542 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -23,7 +23,7 @@ type PurchaseOrder { created_by: String! @doc(description: "The name of the user who created the purchase order") status: PurchaseOrderStatus! @doc(description: "The current status of the purcahse order") total: PurchaseOrderTotal @doc(description: "Contains details about the calculated totals for the purchase order") - items: [PurchaseOrderItem] @doc(description: "An array containing the items in this purchase order") + items(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderItems @doc(description: "Items that belong to the purchase order") payment_methods: [PaymentMethod] @doc(description: "Payment details for the purchase order") shipping_address: CustomerAddress @doc(description: "The shipping address for the purchase order") billing_address: CustomerAddress @doc(description: "The billing address for the purchase order") @@ -31,6 +31,12 @@ type PurchaseOrder { shipping_method: String @doc(description: "The delivery method for the purchase order") } +type PurchaseOrderItems { + items: [PurchaseOrderItem]! + page_info: SearchResultPageInfo + total_count: Int +} + type PurchaseOrderTotal @doc(description: "Contains details about the sales total amounts used to calculate the final price") { subtotal: Money! @doc(description: "The subtotal of the purchase order, excluding shipping, discounts, and taxes") discounts: [Discount] @doc(description: "The applied discounts to the purchase order") diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index 130d71220..e2f5c7828 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -157,31 +157,39 @@ The query should allow to fetch the following data: } } } - items { - uid - product_name - product_sku - product_url_key - product_type - product_sale_price { - currency - value + items(currentPage: 1, pageSize: 10) { + total_count + page_info { + current_page + page_size + total_pages } - quantity - selected_options { + items { uid - value - } - entered_options { - uid - value - } - discounts { - amount { + product_name + product_sku + product_url_key + product_type + product_sale_price { currency value } - label + quantity + selected_options { + uid + value + } + entered_options { + uid + value + } + discounts { + amount { + currency + value + } + label + } } } payment_methods { From a2d7f0ee1e79fc0feb0a267690de2836656dc1e8 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Mon, 10 Aug 2020 16:52:12 -0500 Subject: [PATCH 249/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 14 +++++++++++++ .../graph-ql/coverage/b2b/purchase-order.md | 21 ++++++++++++++++--- 2 files changed, 32 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index a26ddc542..0ef8832b0 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -24,6 +24,7 @@ type PurchaseOrder { status: PurchaseOrderStatus! @doc(description: "The current status of the purcahse order") total: PurchaseOrderTotal @doc(description: "Contains details about the calculated totals for the purchase order") items(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderItems @doc(description: "Items that belong to the purchase order") + comments(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderComments @doc(description: "Purchase order comments") payment_methods: [PaymentMethod] @doc(description: "Payment details for the purchase order") shipping_address: CustomerAddress @doc(description: "The shipping address for the purchase order") billing_address: CustomerAddress @doc(description: "The billing address for the purchase order") @@ -31,6 +32,19 @@ type PurchaseOrder { shipping_method: String @doc(description: "The delivery method for the purchase order") } +type PurchaseOrderComments { + items: [PurchaseOrderComment]! + page_info: SearchResultPageInfo + total_count: Int +} + +type PurchaseOrderComment { + uid: ID! + creation_date_and_time: String! @doc(description: "The date and time when the comment was created") + author: String! @doc(description: "The name of the user who left the comment") + text: String! @doc(description: "The text of the comment") +} + type PurchaseOrderItems { items: [PurchaseOrderItem]! page_info: SearchResultPageInfo diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index e2f5c7828..edb46a2af 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -112,14 +112,14 @@ The query should allow to fetch the following data: - Items with pagination - Basic details - - Approval Flow - - Comments - - History Log - Totals - Shipping Address - Billing Address - Payment Method - Shipping Method + - Comments + - History Log + - Approval Flow ```graphql { @@ -230,9 +230,24 @@ The query should allow to fetch the following data: } telephone } + comments(currentPage: 2, pageSize: 10) { + page_info { + current_page + page_size + total_pages + } + total_count + items { + uid + creation_date_and_time + author + text + } + } } } } + ``` ### Add items to cart from purchase order From eae40005c37939891b83a0a78ab9916f61a3649f Mon Sep 17 00:00:00 2001 From: Anton Kaplia Date: Tue, 11 Aug 2020 11:28:23 -0500 Subject: [PATCH 250/479] change of the structure --- .../catalog/product-options-and-variants.md | 22 ++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/design-documents/storefront/catalog/product-options-and-variants.md b/design-documents/storefront/catalog/product-options-and-variants.md index 6f8a48d5d..134ac2f60 100644 --- a/design-documents/storefront/catalog/product-options-and-variants.md +++ b/design-documents/storefront/catalog/product-options-and-variants.md @@ -159,7 +159,6 @@ alter table product_variant_matrix ``` `product_variant_matrix` - Stores the correlation between option values and variants, by using this correlation, we can say which of option combination is real. -Field `product_variant_matrix.weight` - says how many options should match to match the whole variant. The following script models data from the picture above. @@ -196,11 +195,11 @@ set @product_data := ' insert into products (object_id, data) values ('t-shirt', @product_data); -insert into product_variant_matrix (value, object_id, weight) +insert into product_variant_matrix (value, object_id) values - ('t-shirt:options.size.values.l', 'l-red', 2), ('t-shirt:options.color.values.red', 'l-red', 2), - ('t-shirt:options.size.values.m', 'm-red', 2), ('t-shirt:options.color.values.red', 'm-red', 2), - ('t-shirt:options.size.values.m', 'm-green', 2), ('t-shirt:options.color.values.green', 'm-green', 2) + ('t-shirt:options.size.values.l', 'l-red'), ('t-shirt:options.color.values.red', 'l-red'), + ('t-shirt:options.size.values.m', 'm-red'), ('t-shirt:options.color.values.red', 'm-red'), + ('t-shirt:options.size.values.m', 'm-green'), ('t-shirt:options.color.values.green', 'm-green') ; ``` @@ -242,9 +241,12 @@ Starting this point we can look into variants to analyze remaining options. From the proposed example, we have chosen "Size": "M". ```sql -mysql> select - -> object_id, value, weight - -> from product_variant_matrix +mysql> select t.* + -> from ( + -> select + -> object_id, value, count(1) over (partition by object_id) as weight + -> from product_variant_matrix + -> ) as t -> where value in ('t-shirt:options.size.values.m'); +-----------+-------------------------------+--------+ | object_id | value | weight | @@ -252,7 +254,8 @@ mysql> select | m-green | t-shirt:options.size.values.m | 2 | | m-red | t-shirt:options.size.values.m | 2 | +-----------+-------------------------------+--------+ -2 rows in set (0.01 sec) +2 rows in set (0.00 sec) + ``` As you may see, our selection has matched two variants. @@ -332,7 +335,6 @@ With the response API has to return: ```proto message OptionSelection { - string productId = 1; repeated string values = 2; } message OptionResponse { From 221cc85a612d749f0dfb603a7875d15c12bf9ceb Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Tue, 11 Aug 2020 12:00:19 -0500 Subject: [PATCH 251/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 17 +++++++++++++++-- .../graph-ql/coverage/b2b/purchase-order.md | 14 +++++++++++++- 2 files changed, 28 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index 0ef8832b0..254e7d635 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -23,13 +23,14 @@ type PurchaseOrder { created_by: String! @doc(description: "The name of the user who created the purchase order") status: PurchaseOrderStatus! @doc(description: "The current status of the purcahse order") total: PurchaseOrderTotal @doc(description: "Contains details about the calculated totals for the purchase order") - items(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderItems @doc(description: "Items that belong to the purchase order") comments(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderComments @doc(description: "Purchase order comments") payment_methods: [PaymentMethod] @doc(description: "Payment details for the purchase order") shipping_address: CustomerAddress @doc(description: "The shipping address for the purchase order") billing_address: CustomerAddress @doc(description: "The billing address for the purchase order") carrier: String @doc(description: "The shipping carrier for the purchase order delivery") shipping_method: String @doc(description: "The delivery method for the purchase order") + items(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderItems @doc(description: "Items that belong to the purchase order") + history_log(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderHistoryLog @doc(description: "The log of the events related to the purchase order") } type PurchaseOrderComments { @@ -39,12 +40,24 @@ type PurchaseOrderComments { } type PurchaseOrderComment { - uid: ID! + uid: ID! @doc(description: "Unique identifier of the comment.") creation_date_and_time: String! @doc(description: "The date and time when the comment was created") author: String! @doc(description: "The name of the user who left the comment") text: String! @doc(description: "The text of the comment") } +type PurchaseOrderHistoryLog { + items: [PurchaseOrderHistoryItem]! + page_info: SearchResultPageInfo + total_count: Int +} + +type PurchaseOrderHistoryItem { + uid: ID! @doc(description: "Unique identifier of the purchase rder history item.") + date_and_time: String! @doc(description: "The date and time when the event happened.") + description: String! @doc(description: "Description of the event.") +} + type PurchaseOrderItems { items: [PurchaseOrderItem]! page_info: SearchResultPageInfo diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index edb46a2af..c3e7394c8 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -244,10 +244,22 @@ The query should allow to fetch the following data: text } } + history_log(currentPage: 1, pageSize: 10) { + page_info { + current_page + page_size + total_pages + } + total_count + items { + uid + date_and_time + description + } + } } } } - ``` ### Add items to cart from purchase order From 6b3c1a1c9435aeb72abfc76be00dd2d9a37c1860 Mon Sep 17 00:00:00 2001 From: Anton Kaplia Date: Tue, 11 Aug 2020 13:34:55 -0500 Subject: [PATCH 252/479] removed weight --- .../storefront/catalog/product-options-and-variants.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/design-documents/storefront/catalog/product-options-and-variants.md b/design-documents/storefront/catalog/product-options-and-variants.md index 134ac2f60..85abe6ab9 100644 --- a/design-documents/storefront/catalog/product-options-and-variants.md +++ b/design-documents/storefront/catalog/product-options-and-variants.md @@ -122,7 +122,6 @@ message ProductOption { message ProductVariant { repeated string optionValueId = 1; string id = 2; - int32 weight = 3; string productIdentifierInPricing = 500; #* string productIdentifierInInventory = 600; #* } @@ -150,7 +149,6 @@ Table `products` stores registry of products. create table product_variant_matrix ( value_id char(36) not null, object_id char(36) not null, - weight tinyint not null, primary key (value_id, object_id) ); @@ -306,7 +304,7 @@ options: [ ``` *Note: To achieve more advanced behavior, the variants could be "uneven" inside the single product. - They may have different weight. + They may have different "weight". For instance, you would like to track only t-shirts XL: size separately for some reason (a different price or stock). The example above focused on covering the main case scenario. Still, the approach, overall, is meant to support extending the logic of resolving option values onto a variant under the hood.* ![](https://app.lucidchart.com/publicSegments/view/de9972a8-f630-4400-aacb-d3d9858862cf/image.png) From 322585eef7dd1eb6a201639d94e0af6f67ee1fc3 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Tue, 11 Aug 2020 14:00:14 -0500 Subject: [PATCH 253/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 18 ++++++++++++++++++ .../graph-ql/coverage/b2b/purchase-order.md | 8 ++++++++ 2 files changed, 26 insertions(+) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index 254e7d635..70be87d49 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -31,6 +31,24 @@ type PurchaseOrder { shipping_method: String @doc(description: "The delivery method for the purchase order") items(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderItems @doc(description: "Items that belong to the purchase order") history_log(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderHistoryLog @doc(description: "The log of the events related to the purchase order") + approval_flow: PurchaseOrderApprovalFlow @doc(description: "The log of the events related to the purchase order approval flow") +} + +type PurchaseOrderApprovalFlow { + items: [PurchaseOrderApprovalFlowItem]! +} + +type PurchaseOrderApprovalFlowItem { + uid: ID! @doc(description: "Unique identifier of the purchase order flow item.") + title: String! @doc(description: "Summary of the event related to purchase order approval flow") + description: String! @doc(description: "Description of the event related to purchase order approval flow") + status: PurchaseOrderApprovalFlowItemStatus! @doc(description: "Status associated with the event related to purchase order approval flow") +} + +enum PurchaseOrderApprovalFlowItemStatus { + PENDING + APPROVED + REJECTED } type PurchaseOrderComments { diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index c3e7394c8..7cb3ca0b2 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -257,6 +257,14 @@ The query should allow to fetch the following data: description } } + approval_flow { + items { + uid + status + title + description + } + } } } } From 848ac17e3d0db6df70330cebc8f14cffebdf907a Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Tue, 11 Aug 2020 18:07:22 -0500 Subject: [PATCH 254/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 27 ++++- .../graph-ql/coverage/b2b/purchase-order.md | 112 +++++++++++++++++- .../coverage/cart/AddProductsToCart.graphqls | 1 + .../coverage/customer/gift-registry.md | 2 +- 4 files changed, 133 insertions(+), 9 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index 70be87d49..c780b7bc0 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -59,7 +59,7 @@ type PurchaseOrderComments { type PurchaseOrderComment { uid: ID! @doc(description: "Unique identifier of the comment.") - creation_date_and_time: String! @doc(description: "The date and time when the comment was created") + timestamp: String! @doc(description: "The date and time when the comment was created") author: String! @doc(description: "The name of the user who left the comment") text: String! @doc(description: "The text of the comment") } @@ -72,7 +72,7 @@ type PurchaseOrderHistoryLog { type PurchaseOrderHistoryItem { uid: ID! @doc(description: "Unique identifier of the purchase rder history item.") - date_and_time: String! @doc(description: "The date and time when the event happened.") + timestamp: String! @doc(description: "The date and time when the event happened.") description: String! @doc(description: "Description of the event.") } @@ -93,7 +93,7 @@ type PurchaseOrderTotal @doc(description: "Contains details about the sales tota shipping_handling: ShippingHandling @doc(description: "Contains details about the shipping and handling costs for the purchase purchase order") } -type PurchaseOrderItem @doc(description: "Purchase order item details") { +interface PurchaseOrderItemInterface @doc(description: "Purchase order item details") { uid: ID! @doc(description: "The unique identifier of the purchase order item") product_name: String @doc(description: "The name of the base product") product_sku: String! @doc(description: "The SKU of the base product") @@ -103,11 +103,21 @@ type PurchaseOrderItem @doc(description: "Purchase order item details") { discounts: [Discount] @doc(description: "The final discount information for the product") selected_options: [PurchaseOrderItemOption] @doc(description: "The selected options for the base product, such as color or size") entered_options: [PurchaseOrderItemOption] @doc(description: "The entered option for the base product, such as a logo or image") - quantity: Float @doc(description: "The number of units for this item") + quantity: Float! @doc(description: "The number of units for this item") } -type PurchaseOrderItemOption @doc(description: "Represents purcahse order item options like selected or entered") { - uid: ID! @doc(description: "The name of the option") +type PurchaseOrderItem implements PurchaseOrderItemInterface { + +} + +type PurchaseOrderBundleItem implements PurchaseOrderItemInterface { + parent_product_sku: String! @doc(description: "SKU of the bundle itself") + parent_product_quantity: Float! @doc(description: "Quantity of the bundle itself") +} + +type PurchaseOrderItemOption @doc(description: "Represents purcahse order item options") { + uid: ID! @doc(description: "The unique ID of the option") + label: String! @doc(description: "The label of the option") value: String! @doc(description: "The value of the option") } @@ -126,3 +136,8 @@ type CustomerAddress { # This field must be added to the CustomerAddress type definition directly in CustomerGraphQl module country: Country @doc(description: "The customer's country") } + +type CartItemInput { + # This field must be added to the CartItemInput type definition directly in QuoteGraphQl module + parent_quantity: Float @doc(description: "Parent quantity can be used when adding complex product to cart. For example bundle products") +} diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index 7cb3ca0b2..cd073a7bc 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -177,10 +177,12 @@ The query should allow to fetch the following data: quantity selected_options { uid + label value } entered_options { uid + label value } discounts { @@ -239,7 +241,7 @@ The query should allow to fetch the following data: total_count items { uid - creation_date_and_time + timestamp author text } @@ -253,7 +255,7 @@ The query should allow to fetch the following data: total_count items { uid - date_and_time + timestamp description } } @@ -272,6 +274,112 @@ The query should allow to fetch the following data: ### Add items to cart from purchase order +Get details about purchase items order items that need to be added to cart: + +```graphql +{ + customer { + purchase_order(uid: "abc234hsasdfa") { + uid + items(currentPage: 1, pageSize: 1000) { + items { + uid + product_sku + quantity + selected_options { + uid + } + entered_options { + uid + value + } + } + } + } + } +} +``` + +Using the results from the previous request, execute the following mutation to add items to cart. This will work for all product types except for bundle. + +```graphql +mutation { + addProductsToCart( + cartId: "existing-cart-id-id", + cartItems: [ + { + sku: "simple-hat", + quantity: 2, + selected_options: [ + "hash based on custom option for the select type goes here" + ], + entered_options: [ + { + uid: "hash from custom phrase option ID", + value: "Custom Hat" + } + ] + } + ] + ) { + cart { + items { + id + } + } + } +} +``` + +Bundle product is added to cart by specifying `parent_sku` and `parent_quantity`. +`CartItemInput` needs to be extended with a new field `parent_quantity` directly in `QuoteGraphQl` module. + +```graphql +mutation { + addProductsToCart( + cartId: "existing-cart-id-id", + cartItems: [ + { + sku: "fan-kit-hat", + parent_sku: "fan-kit", + quantity: 2, + parent_quantity: 3, + selected_options: [ + "hash based on custom option for the select type goes here. Must be identical for all bundle children" + ], + entered_options: [ + { + uid: "hash based on custom phrase option goes here. Must be identical for all bundle children", + value: "Custom Text" + } + ] + }, + { + sku: "fan-kit-scarf", + parent_sku: "fan-kit", + quantity: 1, + parent_quantity: 3, + selected_options: [ + "hash based on custom option for the select type goes here. Must be identical for all bundle children" + ], + entered_options: [ + { + uid: "hash based on custom phrase option goes here. Must be identical for all bundle children", + value: "Custom Text" + } + ] + } + ] + ) { + cart { + items { + id + } + } + } +} +``` + ### Add purchase order comment ### Reject purchase order diff --git a/design-documents/graph-ql/coverage/cart/AddProductsToCart.graphqls b/design-documents/graph-ql/coverage/cart/AddProductsToCart.graphqls index 329c82e8b..7d64c1882 100644 --- a/design-documents/graph-ql/coverage/cart/AddProductsToCart.graphqls +++ b/design-documents/graph-ql/coverage/cart/AddProductsToCart.graphqls @@ -6,6 +6,7 @@ input CartItemInput { sku: String! # already in use quantity: Float # already in use parent_sku: String, # will not be used in deprecated methods + parent_quantity: Float, # will not be used in deprecated methods selected_options: [ID!] # will not be used in deprecated methods entered_options: [EnteredOptionInput!] # will not be used in deprecated methods } diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.md b/design-documents/graph-ql/coverage/customer/gift-registry.md index 1de1e857c..3e85ada60 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.md +++ b/design-documents/graph-ql/coverage/customer/gift-registry.md @@ -364,7 +364,7 @@ It is critical to have ability to avoid the hash generation on the client, that } ``` -#### Getting details wishlist item which needs to be added to gift registry +#### Getting details about wishlist item which needs to be added to gift registry Note that if the item is not fully configured, the user must be redirected to the product page to complete selections before the item can be added to the gift registry. From 07ba6cca0a74194d8e9b5ecd5dd5f4ad2ed502ee Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Wed, 12 Aug 2020 13:55:01 -0500 Subject: [PATCH 255/479] MC-36365: Schema for B2B purchase order details --- .../graph-ql/coverage/b2b/purchase-order.graphqls | 2 +- design-documents/graph-ql/coverage/b2b/purchase-order.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index c780b7bc0..0430a68cf 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -77,7 +77,7 @@ type PurchaseOrderHistoryItem { } type PurchaseOrderItems { - items: [PurchaseOrderItem]! + items: [PurchaseOrderItemInterface]! page_info: SearchResultPageInfo total_count: Int } diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index cd073a7bc..49091459c 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -293,6 +293,10 @@ Get details about purchase items order items that need to be added to cart: uid value } + ... on PurchaseOrderBundleItem { + parent_product_sku + parent_product_quantity + } } } } From a74ea2a034687224c29cf35172ea3c7d33f780fe Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Wed, 12 Aug 2020 17:17:51 -0500 Subject: [PATCH 256/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 48 +++++++++++++++ .../graph-ql/coverage/b2b/purchase-order.md | 58 ++++++++++++++++++- 2 files changed, 105 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index 0430a68cf..710b7c967 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -1,3 +1,44 @@ +type Mutation { + addPurchaseOrderComment(input: AddPurchaseOrderCommentInput!): AddPurchaseOrderCommentOutput + approvePurchaseOrder(input: ApprovePurchaseOrderInput!): ApprovePurchaseOrderOutput + cancelPurchaseOrder(input: CancelPurchaseOrderInput!): CancelPurchaseOrderOutput + rejectPurchaseOrder(input: RejectPurchaseOrderInput!): RejectPurchaseOrderOutput +} + +input ApprovePurchaseOrderInput { + purchase_order_uid: ID! +} + +type ApprovePurchaseOrderOutput { + purchase_order: PurchaseOrder +} + +input CancelPurchaseOrderInput { + purchase_order_uid: ID! +} + +type CancelPurchaseOrderOutput { + purchase_order: PurchaseOrder +} + +input RejectPurchaseOrderInput { + purchase_order_uid: ID! +} + +type RejectPurchaseOrderOutput { + purchase_order: PurchaseOrder +} + +input AddPurchaseOrderCommentInput { + purchase_order_uid: ID! + comment: String! +} + +type AddPurchaseOrderCommentOutput { + purchase_order: PurchaseOrder + comment: PurchaseOrderComment +} + type Customer { purchase_orders(filter: PurchaseOrdersFilterInput, currentPage: Int = 1, pageSize: Int = 20): PurchaseOrders purchase_order(uid: ID!): PurchaseOrder @@ -32,6 +73,13 @@ type PurchaseOrder { items(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderItems @doc(description: "Items that belong to the purchase order") history_log(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderHistoryLog @doc(description: "The log of the events related to the purchase order") approval_flow: PurchaseOrderApprovalFlow @doc(description: "The log of the events related to the purchase order approval flow") + available_actions: [PurchaseOrderAction] @doc(description: "Purcahse order actions available to the customer. Can be used to display action buttons on the client") +} + +enum PurchaseOrderAction { + REJECT + CANCEL + APPROVE } type PurchaseOrderApprovalFlow { diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index 49091459c..b160d5df7 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -120,6 +120,7 @@ The query should allow to fetch the following data: - Comments - History Log - Approval Flow + - Available actions (actions, customer can execute on purchase order) ```graphql { @@ -267,6 +268,7 @@ The query should allow to fetch the following data: description } } + available_actions } } } @@ -386,13 +388,67 @@ mutation { ### Add purchase order comment +In the mutation response, it is possible to request just created comment, or the whole purchase order, depending on the client needs. + +```graphql +mutation { + addPurchaseOrderComment( + input: { + purchase_order_uid: "h2l1k23gpw", + comment: "Purchase order comment" + } + ) { + comment { + uid + author + text + timestamp + } + purchase_order { + uid + } + } +} +``` + ### Reject purchase order +```graphql +mutation { + rejectPurchaseOrder(input: {purchase_order_uid: "asdghwl324a"}) { + purchase_order { + uid + status + } + } +} +``` + ### Cancel purchase order +```graphql +mutation { + cancelPurchaseOrder(input: {purchase_order_uid: "asdghwl324a"}) { + purchase_order { + uid + status + } + } +} +``` + ### Approve purchase order -### Get a list of available actions +```graphql +mutation { + approvePurchaseOrder(input: {purchase_order_uid: "asdghwl324a"}) { + purchase_order { + uid + status + } + } +} +``` ### Store config From ac9b41a8f33847c16b09b9ac0f9c9fb0becc00b6 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Fri, 14 Aug 2020 10:51:49 -0500 Subject: [PATCH 257/479] MC-36365: Schema for B2B purchase order details --- .../graph-ql/coverage/b2b/purchase-order.graphqls | 1 + .../graph-ql/coverage/b2b/purchase-order.md | 14 +++++++++++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index 710b7c967..08756032a 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -42,6 +42,7 @@ type AddPurchaseOrderCommentOutput { type Customer { purchase_orders(filter: PurchaseOrdersFilterInput, currentPage: Int = 1, pageSize: Int = 20): PurchaseOrders purchase_order(uid: ID!): PurchaseOrder + purchase_orders_enabled: Boolean! @doc(description: "Whether purchase orders functionality is enabled for current customer. Takes into account global and company-level settings.") } input PurchaseOrdersFilterInput { diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index b160d5df7..0b4208184 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -452,10 +452,18 @@ mutation { ### Store config -Consider combining the following settings and exposing as a single field: -- Check if purchase order is enabled on global level +The following settings and combined and exposed as a single customer field: +- If purchase order is enabled on global level - If purchase order enabled on company level -- If comapnies are enabled on global level +- If companies are enabled on global level + +```graphql +{ + customer { + purchase_orders_enabled + } +} +``` ### View a list of approval rules From 5ef23f3aa653135c6302ff2c5099ec20da5cdfc1 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Fri, 14 Aug 2020 14:30:45 -0500 Subject: [PATCH 258/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 32 +++++++++++++++++-- .../graph-ql/coverage/b2b/purchase-order.md | 27 +++++++++++++++- 2 files changed, 56 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index 08756032a..1e6cc43cf 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -40,8 +40,9 @@ type AddPurchaseOrderCommentOutput { } type Customer { - purchase_orders(filter: PurchaseOrdersFilterInput, currentPage: Int = 1, pageSize: Int = 20): PurchaseOrders - purchase_order(uid: ID!): PurchaseOrder + purchase_orders(filter: PurchaseOrdersFilterInput, currentPage: Int = 1, pageSize: Int = 20): PurchaseOrders @doc(description: "A list of purchase orders visible to the customer") + purchase_order(uid: ID!): PurchaseOrder @doc(description: "Purchase order details") + purchase_order_approval_rules(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderApprovalRules @doc(description: "A list of purchase order approval rules visible to the customer") purchase_orders_enabled: Boolean! @doc(description: "Whether purchase orders functionality is enabled for current customer. Takes into account global and company-level settings.") } @@ -57,6 +58,33 @@ type PurchaseOrders { total_count: Int } +type PurchaseOrderApprovalRules { + items: [PurchaseOrderApprovalRule]! + page_info: SearchResultPageInfo + total_count: Int +} + +type PurchaseOrderApprovalRule { + uid: ID! @doc(description: "Unique identifier for the purcahse order approval rule") + name: String! @doc(description: "Name of the purcahse order approval rule") + status: PurchaseOrderApprovalRuleStatus! @doc(description: "Status of the purcahse order approval rule") + type: PurchaseOrderApprovalRuleType! @doc(description: "Type of the purcahse order approval rule") + created_by: String! @doc(description: "The name of the user who created the purcahse order approval rule") + applies_to: String! @doc(description: "The name of the user(s) affected by the the purcahse order approval rule") + approver: String! @doc(description: "The name of the user who needs to approve purchase orders that trigger the approval rule") +} + +enum PurchaseOrderApprovalRuleStatus { + ENABLED + DISABLED +} + +enum PurchaseOrderApprovalRuleType { + ORDER_TOTAL + SHIPPING_COST + NUMBER_OF_SKUS +} + type PurchaseOrder { uid: ID! @doc(description: "Unique identifier for the purcahse order") number: String! @doc(description: "The purchase order number") diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index 0b4208184..96cf8689f 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -467,7 +467,32 @@ The following settings and combined and exposed as a single customer field: ### View a list of approval rules -Should support pagination. +```graphql +{ + customer { + purchase_order_approval_rules( + currentPage: 1, + pageSize: 10 + ) { + items { + uid + name + status + type + created_by + applies_to + approver + } + total_count + page_info { + current_page + page_size + total_pages + } + } + } +} +``` ### View approval rule details From 0442a8142e9260b033b0792ec99f82027e205125 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Fri, 14 Aug 2020 17:13:45 -0500 Subject: [PATCH 259/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 23 ++++++++++++++- .../graph-ql/coverage/b2b/purchase-order.md | 28 +++++++++++++++++++ 2 files changed, 50 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index 1e6cc43cf..58f058c62 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -43,7 +43,8 @@ type Customer { purchase_orders(filter: PurchaseOrdersFilterInput, currentPage: Int = 1, pageSize: Int = 20): PurchaseOrders @doc(description: "A list of purchase orders visible to the customer") purchase_order(uid: ID!): PurchaseOrder @doc(description: "Purchase order details") purchase_order_approval_rules(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderApprovalRules @doc(description: "A list of purchase order approval rules visible to the customer") - purchase_orders_enabled: Boolean! @doc(description: "Whether purchase orders functionality is enabled for current customer. Takes into account global and company-level settings.") + purchase_order_approval_rule(uid: ID!): PurchaseOrderApprovalRule @doc(description: "Purchase order approval rule details") + purchase_orders_enabled: Boolean! @doc(description: "Whether purchase orders functionality is enabled for current customer. Takes into account global and company-level settings") } input PurchaseOrdersFilterInput { @@ -72,6 +73,26 @@ type PurchaseOrderApprovalRule { created_by: String! @doc(description: "The name of the user who created the purcahse order approval rule") applies_to: String! @doc(description: "The name of the user(s) affected by the the purcahse order approval rule") approver: String! @doc(description: "The name of the user who needs to approve purchase orders that trigger the approval rule") + condition: PurchaseOrderApprovalRuleConditionInterface! @doc(description: "Condition which triggers the approval rule") +} + +interface PurchaseOrderApprovalRuleConditionInterface { + operator: PurchaseOrderApprovalRuleConditionOperator! @doc(description: "The operator to be used for evaluation of the approval rule condition") +} + +enum PurchaseOrderApprovalRuleConditionOperator { + MORE_THAN + LESS_THAN + MORE_THAN_OR_EQUAL_TO + LESS_THAN_OR_EQUAL_TO +} + +type PurchaseOrderApprovalRuleConditionAmount implements PurchaseOrderApprovalRuleConditionInterface { + amount: Money! @doc(description: "The amount to be be used for evaluation of the approval rule condition") +} + +type PurchaseOrderApprovalRuleConditionQuantity implements PurchaseOrderApprovalRuleConditionInterface { + quantity: Int! @doc(description: "The quantity to be be used for evaluation of the approval rule condition") } enum PurchaseOrderApprovalRuleStatus { diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index 96cf8689f..1d1f9df10 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -496,6 +496,34 @@ The following settings and combined and exposed as a single customer field: ### View approval rule details +```graphql +{ + customer { + purchase_order_approval_rule(uid: "abc2710fsdlfh") { + uid + name + status + type + created_by + applies_to + approver + condition { + operator + ... on PurchaseOrderApprovalRuleConditionAmount { + amount { + value + currency + } + } + ... on PurchaseOrderApprovalRuleConditionQuantity { + quantity + } + } + } + } +} +``` + ### Create new approval rule #### Get list of "Applies to" users From da5b67b7a7355b3f367b0bd882bbf65f352b26a0 Mon Sep 17 00:00:00 2001 From: Rakesh Jesadiya Date: Mon, 17 Aug 2020 19:45:49 +0530 Subject: [PATCH 260/479] negotiable-quote-graphql-schema-improvement --- .../graph-ql/coverage/negotiableQuotes.graphqls | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls index 0670837ee..2aca8e08a 100644 --- a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls @@ -172,7 +172,7 @@ enum NegotiableQuoteCommentCreatorType { type NegotiableQuote { id: ID! name: String! - items: [NegotiableQuoteItem!] + items: [CartItemInterface!] # Attachment Support is dependent on headless File Upload design # attachments: [AttachmentContent] comments: [NegotiableQuoteComment!] @@ -198,11 +198,6 @@ enum NegotiableQuoteStatus { EXPIRED } -type NegotiableQuoteItem @doc(description: "A line item on a Negotiable Quote") { - id: ID! @doc(description: "ID of the line item (not product) in a Negotiable Quote") - item: CartItemInterface @doc(description: "Product assigned to line item, with selected configurations") -} - input NegotiableQuoteFilterInput { ids: FilterEqualTypeInput @doc(description: "Filter by Negotiable Quote ID(s)") name: FilterMatchTypeInput @doc(description: "Filter by Negotiable Quote name") @@ -247,8 +242,8 @@ type NegotiableQuoteHistoryChanges { # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L40-L73 type NegotiableQuoteHistoryStatusChange { - old_status: NegotiableQuoteStatus @doc(description: "Will be null for the first history entry on a Negotiable Quote") - new_status: NegotiableQuoteStatus! + old_status: String @doc(description: "Will be null for the first history entry on a Negotiable Quote") + new_status: String! @doc(description: "Negotiable Quote History New Status.") } # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L48 From 206b759bf974f0e3ba30635cea77257f786b8c38 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Mon, 17 Aug 2020 10:45:18 -0500 Subject: [PATCH 261/479] MC-36365: Schema for B2B purchase order details --- .../graph-ql/coverage/b2b/purchase-order.graphqls | 7 +++++++ .../graph-ql/coverage/b2b/purchase-order.md | 14 ++++++++++++-- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index 58f058c62..d93aebef6 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -44,9 +44,16 @@ type Customer { purchase_order(uid: ID!): PurchaseOrder @doc(description: "Purchase order details") purchase_order_approval_rules(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderApprovalRules @doc(description: "A list of purchase order approval rules visible to the customer") purchase_order_approval_rule(uid: ID!): PurchaseOrderApprovalRule @doc(description: "Purchase order approval rule details") + purchase_order_approval_rule_metadata: PurchaseOrderApprovalRuleMetadata @doc(description: "Purchase order approval rule metadata which is can be used for rule edit form rendering") purchase_orders_enabled: Boolean! @doc(description: "Whether purchase orders functionality is enabled for current customer. Takes into account global and company-level settings") } +type PurchaseOrderApprovalRuleMetadata { + available_applies_to: [String]! @doc(description: "A list of B2B user roles that the rule can be applied to") + available_condition_currencies: [CurrencyEnum]! @doc(description: "A list of currencies that can be used to create approval rules based on ammounts, for example shipping cost rules") + available_requires_approval_from: [String]! @doc(description: "A list of B2B user roles that can be specified as approvers for the approval rules") +} + input PurchaseOrdersFilterInput { status: PurchaseOrderStatus createdBy: FilterStringTypeInput diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index 1d1f9df10..363f89d2e 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -526,9 +526,19 @@ The following settings and combined and exposed as a single customer field: ### Create new approval rule -#### Get list of "Applies to" users +To render the rule creation and update forms, some metadata is required: -#### Get list of "Requires approval from" users +```graphql +{ + customer { + purchase_order_approval_rule_metadata { + available_applies_to + available_requires_approval_from + available_condition_currencies + } + } +} +``` ### Update approval rule From f77a11eb22d848ca366c44fc10e579e2b6a66ae1 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Mon, 17 Aug 2020 11:58:03 -0500 Subject: [PATCH 262/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 49 +++++++++++++++++-- 1 file changed, 45 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index d93aebef6..3cae0e142 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -1,8 +1,49 @@ type Mutation { - addPurchaseOrderComment(input: AddPurchaseOrderCommentInput!): AddPurchaseOrderCommentOutput - approvePurchaseOrder(input: ApprovePurchaseOrderInput!): ApprovePurchaseOrderOutput - cancelPurchaseOrder(input: CancelPurchaseOrderInput!): CancelPurchaseOrderOutput - rejectPurchaseOrder(input: RejectPurchaseOrderInput!): RejectPurchaseOrderOutput + addPurchaseOrderComment(input: AddPurchaseOrderCommentInput!): AddPurchaseOrderCommentOutput @doc(description: "Add a comment to an existing purchase order") + approvePurchaseOrder(input: ApprovePurchaseOrderInput!): ApprovePurchaseOrderOutput @doc(description: "Approve purchase order") + cancelPurchaseOrder(input: CancelPurchaseOrderInput!): CancelPurchaseOrderOutput @doc(description: "Cancel purchase order") + rejectPurchaseOrder(input: RejectPurchaseOrderInput!): RejectPurchaseOrderOutput @doc(description: "Reject purchase order") + createPurchaseOrderApprovalRule(input: CreatePurchaseOrderApprovalRuleInput!): CreatePurchaseOrderApprovalRuleOutput @doc(description: "Create purchase order approval rule") + updatePurchaseOrderApprovalRule(input: UpdatePurchaseOrderApprovalRuleInput!): UpdatePurchaseOrderApprovalRuleOutput @doc(description: "Update purchase order approval rule") +} + +type CreatePurchaseOrderApprovalRuleOutput { + approval_rule: PurchaseOrderApprovalRule @doc(description: "Created purchase order approval rule") + approval_rules(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderApprovalRules @doc(description: "A list of purchase order approval rules visible to the customer") +} + +type UpdatePurchaseOrderApprovalRuleOutput { + approval_rule: PurchaseOrderApprovalRule @doc(description: "Updated purchase order approval rule") + approval_rules(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderApprovalRules @doc(description: "A list of purchase order approval rules visible to the customer") +} + +input CreatePurchaseOrderApprovalRuleInput { + approval_rule: PurchaseOrderApprovalRuleInput! @doc(description: "Purchase order approval rule data") +} + +input UpdatePurchaseOrderApprovalRuleInput { + approval_rule_uid: ID! @doc(description: "Purchase order approval rule ID") + approval_rule: PurchaseOrderApprovalRuleInput! @doc(description: "Purchase order approval rule data") +} + +input PurchaseOrderApprovalRuleInput { + name: String! @doc(description: "Purchase order approval rule name") + description: String @doc(description: "Purchase order approval rule description") + applies_to: [String!]! @doc(description: "A list of B2B user roles to which this purchase order approval rule should be applied") + type: PurchaseOrderApprovalRuleType! @doc(description: "Purchase order approval rule type") + condition: CreatePurchaseOrderApprovalRuleConditionInput! @doc(description: "Purchase order approval rule condition") + requires_approval_from: [String!]! @doc(description: "A list of B2B user roles that can approve this purchase order approval rule") +} + +input CreatePurchaseOrderApprovalRuleConditionInput { + operator: PurchaseOrderApprovalRuleConditionOperator! @doc(description: "Purchase order approval rule condition operator") + amount: CreatePurchaseOrderApprovalRuleConditionAmountInput @doc(description: "Purchase order approval rule condition ammount. Is mutually exclusive with condition quantity") + quantity: Int @doc(description: "Purchase order approval rule condition quantity. Is mutually exclusive with condition amount") +} + +input CreatePurchaseOrderApprovalRuleConditionAmountInput { + value: Float! @doc(description: "Purchase order approval rule condition ammount value") + currency: CurrencyEnum! @doc(description: "Purchase order approval rule condition ammount currency") } input ApprovePurchaseOrderInput { From c322933dffb5a0cb084d0321d97d451f8f46c14d Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Mon, 17 Aug 2020 13:27:11 -0500 Subject: [PATCH 263/479] MC-35159: Login as Customer Schema Design --- .../coverage/customer/login-as-customer.graphqls | 15 +++++++++++++++ .../coverage/customer/login-as-customer.md | 10 +++++++--- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/login-as-customer.graphqls b/design-documents/graph-ql/coverage/customer/login-as-customer.graphqls index 2da837f62..9437478db 100644 --- a/design-documents/graph-ql/coverage/customer/login-as-customer.graphqls +++ b/design-documents/graph-ql/coverage/customer/login-as-customer.graphqls @@ -11,3 +11,18 @@ type GenerateCustomerTokenAsAdminOutput { customer_token: String! } + +type Customer +{ + allow_remote_shopping_assistance: Boolean! +} + +input CustomerCreateInput +{ + allow_remote_shopping_assistance: Boolean +} + +input CustomerUpdateInput +{ + allow_remote_shopping_assistance: Boolean +} diff --git a/design-documents/graph-ql/coverage/customer/login-as-customer.md b/design-documents/graph-ql/coverage/customer/login-as-customer.md index 3d08d345c..416aa491f 100644 --- a/design-documents/graph-ql/coverage/customer/login-as-customer.md +++ b/design-documents/graph-ql/coverage/customer/login-as-customer.md @@ -1,6 +1,6 @@ ## Use cases -# Admin user obtains customer token +### Admin user obtains customer token Admin user is expected to be authenticated using admin token. While there is no GraphQL Mutation for retrieving the admin token, REST should be used (see [example](https://devdocs.magento.com/guides/v2.4/graphql/queries/index.html#staging)). @@ -18,7 +18,11 @@ mutation { } ``` -### Additional requirements +### Customer can manage and view "Allow remote shopping assistance" flag + +This flag should be added to `Customer`, `CustomerCreateInput` and `CustomerUpdateInput`. + +## Additional requirements 1. A new `LoginAsCustomerGraphQL` module should be created. 2. `Magento_LoginAsCustomer::login` permission must be declared in `LoginAsCustomer` module. 3. The following store config settings must be honored, but should not be exposed as part of `StoreConfig` GraphQL query: @@ -26,7 +30,7 @@ mutation { 0 - 60 ``` + 4. Customer field `allow_remote_shopping_assistance` must be taken into account From b6acd069b7e491602e7d8aa12484d3fd573a0f2b Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Mon, 17 Aug 2020 16:47:39 -0500 Subject: [PATCH 264/479] MC-36365: Schema for B2B purchase order details --- .../coverage/b2b/purchase-order.graphqls | 25 +++-- .../graph-ql/coverage/b2b/purchase-order.md | 96 ++++++++++++++++++- 2 files changed, 108 insertions(+), 13 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index 3cae0e142..a3557f30d 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -4,7 +4,8 @@ type Mutation { cancelPurchaseOrder(input: CancelPurchaseOrderInput!): CancelPurchaseOrderOutput @doc(description: "Cancel purchase order") rejectPurchaseOrder(input: RejectPurchaseOrderInput!): RejectPurchaseOrderOutput @doc(description: "Reject purchase order") createPurchaseOrderApprovalRule(input: CreatePurchaseOrderApprovalRuleInput!): CreatePurchaseOrderApprovalRuleOutput @doc(description: "Create purchase order approval rule") - updatePurchaseOrderApprovalRule(input: UpdatePurchaseOrderApprovalRuleInput!): UpdatePurchaseOrderApprovalRuleOutput @doc(description: "Update purchase order approval rule") + updatePurchaseOrderApprovalRule(input: UpdatePurchaseOrderApprovalRuleInput!): UpdatePurchaseOrderApprovalRuleOutput @doc(description: "Update existing purchase order approval rule") + deletePurchaseOrderApprovalRule(input: DeletePurchaseOrderApprovalRuleInput!): DeletePurchaseOrderApprovalRuleOutput @doc(description: "Delete existing purchase order approval rule") } type CreatePurchaseOrderApprovalRuleOutput { @@ -17,6 +18,10 @@ type UpdatePurchaseOrderApprovalRuleOutput { approval_rules(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderApprovalRules @doc(description: "A list of purchase order approval rules visible to the customer") } +type DeletePurchaseOrderApprovalRuleOutput { + approval_rules(currentPage: Int = 1, pageSize: Int = 20): PurchaseOrderApprovalRules @doc(description: "A list of purchase order approval rules visible to the customer") +} + input CreatePurchaseOrderApprovalRuleInput { approval_rule: PurchaseOrderApprovalRuleInput! @doc(description: "Purchase order approval rule data") } @@ -26,13 +31,17 @@ input UpdatePurchaseOrderApprovalRuleInput { approval_rule: PurchaseOrderApprovalRuleInput! @doc(description: "Purchase order approval rule data") } +input DeletePurchaseOrderApprovalRuleInput { + approval_rule_uid: ID! @doc(description: "Purchase order approval rule ID") +} + input PurchaseOrderApprovalRuleInput { name: String! @doc(description: "Purchase order approval rule name") description: String @doc(description: "Purchase order approval rule description") - applies_to: [String!]! @doc(description: "A list of B2B user roles to which this purchase order approval rule should be applied") + applies_to: [ID]! @doc(description: "A list of B2B user roles to which this purchase order approval rule should be applied. In case when empty array is provided, the rule will be applied to all user roles in the system, including those created in the future") type: PurchaseOrderApprovalRuleType! @doc(description: "Purchase order approval rule type") condition: CreatePurchaseOrderApprovalRuleConditionInput! @doc(description: "Purchase order approval rule condition") - requires_approval_from: [String!]! @doc(description: "A list of B2B user roles that can approve this purchase order approval rule") + requires_approval_from: [ID!]! @doc(description: "A list of B2B user roles that can approve this purchase order approval rule") } input CreatePurchaseOrderApprovalRuleConditionInput { @@ -90,15 +99,15 @@ type Customer { } type PurchaseOrderApprovalRuleMetadata { - available_applies_to: [String]! @doc(description: "A list of B2B user roles that the rule can be applied to") + available_applies_to: [CompanyRole]! @doc(description: "A list of B2B user roles that the rule can be applied to") available_condition_currencies: [CurrencyEnum]! @doc(description: "A list of currencies that can be used to create approval rules based on ammounts, for example shipping cost rules") - available_requires_approval_from: [String]! @doc(description: "A list of B2B user roles that can be specified as approvers for the approval rules") + available_requires_approval_from: [CompanyRole]! @doc(description: "A list of B2B user roles that can be specified as approvers for the approval rules") } input PurchaseOrdersFilterInput { - status: PurchaseOrderStatus - createdBy: FilterStringTypeInput - createdDate: FilterRangeTypeInput + status: PurchaseOrderStatus @doc(description: "Filter by the status of the purchase order") + createdBy: FilterStringTypeInput @doc(description: "Filter by the name of the user who created the purchase order") + createdDate: FilterRangeTypeInput @doc(description: "Filter by the creation date of the purchase order") } type PurchaseOrders { diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index 363f89d2e..df56eafa2 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -532,22 +532,108 @@ To render the rule creation and update forms, some metadata is required: { customer { purchase_order_approval_rule_metadata { - available_applies_to - available_requires_approval_from + available_applies_to { + id + name + } + available_requires_approval_from { + id + name + } available_condition_currencies } } } ``` +Create a new rule with the condition based on shipping cost. In the response it is possible to request the rule just created, or a list of all rules available to the current user for viewing. + +```graphql +mutation { + createPurchaseOrderApprovalRule( + input: { + approval_rule: { + name: "Junior Buyer Orders" + description: "The rule applies to junior buyers" + applies_to: ["vah234gwy3"] + type: SHIPPING_COST + condition: { + operator: MORE_THAN_OR_EQUAL_TO + amount: { + currency: USD + value: 1000.50 + } + } + requires_approval_from: ["ghwldsfh237s", "fhsk23h49kl"] + } + } + ) { + approval_rule { + uid + } + approval_rules(currentPage: 1, pageSize: 10) { + items { + uid + } + } + } +} +``` + ### Update approval rule -### Delete approval rule +Similarly to creation of the rule, metadata for the form rendering needs to be fetched first. +The next mutation demonstrates updating of an existing rule with the condition based on the number of SKUs. -## Implementation details +```graphql +mutation { + updatePurchaseOrderApprovalRule( + input: { + approval_rule_uid: "gasdgfhwlr234sdfla" + approval_rule: { + name: "Junior Buyer Orders" + description: "The rule applies to junior buyers" + applies_to: ["vah234gwy3"] + type: NUMBER_OF_SKUS + condition: { + operator: MORE_THAN + quantity: 100 + } + requires_approval_from: ["ghwldsfh237s"] + } + } + ) { + approval_rule { + uid + } + approval_rules(currentPage: 1, pageSize: 10) { + items { + uid + } + } + } +} +``` -The purchase order GraphQL schema depends on Sales and Customer GraphQL schemas. +### Delete approval rule +```graphql +mutation { + deletePurchaseOrderApprovalRule( + input: { + approval_rule_uid: "gabh572kfhs" + } + ) { + approval_rules(currentPage: 1, pageSize: 10) { + items { + uid + } + } + } +} +``` +## Implementation details +The purchase order GraphQL schema depends on Sales and Customer GraphQL schemas. From 3fd19a2f7f8bde148e0caa7b2ad921203f36bb77 Mon Sep 17 00:00:00 2001 From: Alex Paliarush Date: Mon, 17 Aug 2020 16:58:23 -0500 Subject: [PATCH 265/479] MC-36365: Schema for B2B purchase order details --- .../graph-ql/coverage/b2b/purchase-order.graphqls | 11 ++++++++--- .../graph-ql/coverage/b2b/purchase-order.md | 10 ++++++++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index a3557f30d..b8ab3b243 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -209,16 +209,21 @@ enum PurchaseOrderApprovalFlowItemStatus { type PurchaseOrderComments { items: [PurchaseOrderComment]! page_info: SearchResultPageInfo - total_count: Int + total_count: Int! } type PurchaseOrderComment { uid: ID! @doc(description: "Unique identifier of the comment.") timestamp: String! @doc(description: "The date and time when the comment was created") - author: String! @doc(description: "The name of the user who left the comment") + author: PurchaseOrderCommentAuthor! @doc(description: "The name of the user who left the comment") text: String! @doc(description: "The text of the comment") } +type PurchaseOrderCommentAuthor { + firstname: String! @doc(description: "First name of the user who left the purchase order comment") + lastname: String! @doc(description: "Last name of the user who left the purchase order comment") +} + type PurchaseOrderHistoryLog { items: [PurchaseOrderHistoryItem]! page_info: SearchResultPageInfo @@ -292,7 +297,7 @@ type CustomerAddress { country: Country @doc(description: "The customer's country") } -type CartItemInput { +input CartItemInput { # This field must be added to the CartItemInput type definition directly in QuoteGraphQl module parent_quantity: Float @doc(description: "Parent quantity can be used when adding complex product to cart. For example bundle products") } diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.md b/design-documents/graph-ql/coverage/b2b/purchase-order.md index df56eafa2..13ea3a9c9 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.md +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.md @@ -243,7 +243,10 @@ The query should allow to fetch the following data: items { uid timestamp - author + author { + firstname + lastname + } text } } @@ -400,7 +403,10 @@ mutation { ) { comment { uid - author + author { + firstname + lastname + } text timestamp } From 64c29c3c04982db3a274299cd622ffa83cf50e95 Mon Sep 17 00:00:00 2001 From: Rakesh Jesadiya Date: Tue, 18 Aug 2020 16:11:14 +0530 Subject: [PATCH 266/479] schema file modify --- .../graph-ql/coverage/negotiableQuotes.graphqls | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls index 2aca8e08a..7a4345fd0 100644 --- a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls @@ -242,8 +242,8 @@ type NegotiableQuoteHistoryChanges { # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L40-L73 type NegotiableQuoteHistoryStatusChange { - old_status: String @doc(description: "Will be null for the first history entry on a Negotiable Quote") - new_status: String! @doc(description: "Negotiable Quote History New Status.") + old_status: NegotiableQuoteStatus @doc(description: "Will be null for the first history entry on a Negotiable Quote") + new_status: NegotiableQuoteStatus! @doc(description: "Negotiable Quote History New Status.") } # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L48 @@ -261,8 +261,8 @@ type NegotiableQuoteHistoryCommentChange { # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L259-L294 type NegotiableQuoteHistoryTotalChange { - old_price: Money! - new_price: Money! + old_price: Money + new_price: Money } # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L74-L103 From 3046c6f98d86dcc9eb2c866269197da91f1bc61a Mon Sep 17 00:00:00 2001 From: Rakesh Jesadiya Date: Fri, 21 Aug 2020 14:19:42 +0530 Subject: [PATCH 267/479] remove buyer update item from the storefront schema --- design-documents/graph-ql/coverage/negotiableQuotes.graphqls | 5 ----- 1 file changed, 5 deletions(-) diff --git a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls index 7a4345fd0..0894f5106 100644 --- a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls @@ -42,11 +42,6 @@ type Mutation { input: RemoveNegotiableQuoteItemsInput! ): RemoveNegotiableQuoteItemsOutput @doc(description: "Remove 1 or more products from a Negotiable Quote") - # Covers "buyer can add items" of https://devdocs.magento.com/guides/v2.4/b2b/negotiable-update.html#add-a-new-quote-item-to-the-negotiable-quote - addNegotiableQuoteItems( - input: AddNegotiableQuoteItemsInput! - ): AddNegotiableQuoteItemsOutput @doc(description: "Add 1 or more products to a Negotiable Quote") - # Covers first half of https://docs.magento.com/user-guide/customers/account-dashboard-quotes.html#cancel-a-quote-request closeNegotiableQuotes( input: CloseNegotiableQuotesInput! From 1c77ea3813b692ae5a5832b3bf403686596df7aa Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 21 Aug 2020 14:58:53 -0500 Subject: [PATCH 268/479] Copy over Magento_QuoteGraphQl schema from 2.4-develop --- .../graph-ql/coverage/quote.graphqls | 391 ++++++++++++++++++ 1 file changed, 391 insertions(+) create mode 100644 design-documents/graph-ql/coverage/quote.graphqls diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls new file mode 100644 index 000000000..cf311354d --- /dev/null +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -0,0 +1,391 @@ +# Copyright © Magento, Inc. All rights reserved. +# See COPYING.txt for license details. + +type Query { + cart(cart_id: String!): Cart @resolver (class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\Cart") @doc(description:"Returns information about shopping cart") @cache(cacheable: false) + customerCart: Cart! @resolver (class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CustomerCart") @doc(description:"Returns information about the customer shopping cart") @cache(cacheable: false) +} + +type Mutation { + createEmptyCart(input: createEmptyCartInput): String @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CreateEmptyCart") @doc(description:"Creates an empty shopping cart for a guest or logged in user") + addSimpleProductsToCart(input: AddSimpleProductsToCartInput): AddSimpleProductsToCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddSimpleProductsToCart") + addVirtualProductsToCart(input: AddVirtualProductsToCartInput): AddVirtualProductsToCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddSimpleProductsToCart") + applyCouponToCart(input: ApplyCouponToCartInput): ApplyCouponToCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\ApplyCouponToCart") + removeCouponFromCart(input: RemoveCouponFromCartInput): RemoveCouponFromCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\RemoveCouponFromCart") + updateCartItems(input: UpdateCartItemsInput): UpdateCartItemsOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\UpdateCartItems") + removeItemFromCart(input: RemoveItemFromCartInput): RemoveItemFromCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\RemoveItemFromCart") + setShippingAddressesOnCart(input: SetShippingAddressesOnCartInput): SetShippingAddressesOnCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetShippingAddressesOnCart") + setBillingAddressOnCart(input: SetBillingAddressOnCartInput): SetBillingAddressOnCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetBillingAddressOnCart") + setShippingMethodsOnCart(input: SetShippingMethodsOnCartInput): SetShippingMethodsOnCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetShippingMethodsOnCart") + setPaymentMethodOnCart(input: SetPaymentMethodOnCartInput): SetPaymentMethodOnCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\SetPaymentMethodOnCart") + setGuestEmailOnCart(input: SetGuestEmailOnCartInput): SetGuestEmailOnCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\SetGuestEmailOnCart") + setPaymentMethodAndPlaceOrder(input: SetPaymentMethodAndPlaceOrderInput): PlaceOrderOutput @deprecated(reason: "Should use setPaymentMethodOnCart and placeOrder mutations in single request.") @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetPaymentAndPlaceOrder") + mergeCarts(source_cart_id: String!, destination_cart_id: String!): Cart! @doc(description:"Merges the source cart into the destination cart") @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\MergeCarts") + placeOrder(input: PlaceOrderInput): PlaceOrderOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\PlaceOrder") + addProductsToCart(cartId: String!, cartItems: [CartItemInput!]!): AddProductsToCartOutput @doc(description:"Add any type of product to the cart") @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddProductsToCart") +} + +input createEmptyCartInput { + cart_id: String +} + +input AddSimpleProductsToCartInput { + cart_id: String! + cart_items: [SimpleProductCartItemInput!]! +} + +input SimpleProductCartItemInput { + data: CartItemInput! + customizable_options:[CustomizableOptionInput!] +} + +input AddVirtualProductsToCartInput { + cart_id: String! + cart_items: [VirtualProductCartItemInput!]! +} + +input VirtualProductCartItemInput { + data: CartItemInput! + customizable_options:[CustomizableOptionInput!] +} + +input CartItemInput { + sku: String! + quantity: Float! + parent_sku: String @doc(description: "For child products, the SKU of its parent product") + selected_options: [ID!] @doc(description: "The selected options for the base product, such as color or size") + entered_options: [EnteredOptionInput!] @doc(description: "An array of entered options for the base product, such as personalization text") +} + +input CustomizableOptionInput { + id: Int! + value_string: String! +} + +input ApplyCouponToCartInput { + cart_id: String! + coupon_code: String! +} + +input UpdateCartItemsInput { + cart_id: String! + cart_items: [CartItemUpdateInput!]! +} + +input CartItemUpdateInput { + cart_item_id: Int! + quantity: Float + customizable_options: [CustomizableOptionInput!] +} + +input RemoveItemFromCartInput { + cart_id: String! + cart_item_id: Int! +} + +input SetShippingAddressesOnCartInput { + cart_id: String! + shipping_addresses: [ShippingAddressInput!]! +} + +input ShippingAddressInput { + customer_address_id: Int # If provided then will be used address from address book + address: CartAddressInput + customer_notes: String +} + +input SetBillingAddressOnCartInput { + cart_id: String! + billing_address: BillingAddressInput! +} + +input BillingAddressInput { + customer_address_id: Int + address: CartAddressInput + use_for_shipping: Boolean @doc(description: "Deprecated: use `same_as_shipping` field instead") + same_as_shipping: Boolean @doc(description: "Set billing address same as shipping") +} + +input CartAddressInput { + firstname: String! + lastname: String! + company: String + street: [String!]! + city: String! + region: String + region_id: Int + postcode: String + country_code: String! + telephone: String! + save_in_address_book: Boolean @doc(description: "Determines whether to save the address in the customer's address book. The default value is true") +} + +input SetShippingMethodsOnCartInput { + cart_id: String! + shipping_methods: [ShippingMethodInput!]! +} + +input ShippingMethodInput { + carrier_code: String! + method_code: String! +} + +input SetPaymentMethodAndPlaceOrderInput { + cart_id: String! + payment_method: PaymentMethodInput! +} + +input PlaceOrderInput { + cart_id: String! +} + +input SetPaymentMethodOnCartInput { + cart_id: String! + payment_method: PaymentMethodInput! +} + +input PaymentMethodInput { + code: String! @doc(description:"Payment method code") + purchase_order_number: String @doc(description:"Purchase order number") +} + +input SetGuestEmailOnCartInput { + cart_id: String! + email: String! +} + +type CartPrices { + grand_total: Money + subtotal_including_tax: Money + subtotal_excluding_tax: Money + discount: CartDiscount @deprecated(reason: "Use discounts instead ") + subtotal_with_discount_excluding_tax: Money + applied_taxes: [CartTaxItem] + discounts: [Discount] @doc(description:"An array of applied discounts") @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\Discounts") +} + +type CartTaxItem { + amount: Money! + label: String! +} + +type CartDiscount { + amount: Money! + label: [String!]! +} + +type SetPaymentMethodOnCartOutput { + cart: Cart! +} + +type SetBillingAddressOnCartOutput { + cart: Cart! +} + +type SetShippingAddressesOnCartOutput { + cart: Cart! +} + +type SetShippingMethodsOnCartOutput { + cart: Cart! +} + +type ApplyCouponToCartOutput { + cart: Cart! +} + +type PlaceOrderOutput { + order: Order! +} + +type Cart { + id: ID! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\MaskedCartId") @doc(description: "The ID of the cart.") + items: [CartItemInterface] @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartItems") + applied_coupon: AppliedCoupon @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\AppliedCoupon") @doc(description:"An array of coupons that have been applied to the cart") @deprecated(reason: "Use applied_coupons instead ") + applied_coupons: [AppliedCoupon] @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\AppliedCoupons") @doc(description:"An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code") + email: String @resolver (class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartEmail") + shipping_addresses: [ShippingCartAddress]! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\ShippingAddresses") + billing_address: BillingCartAddress @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\BillingAddress") + available_payment_methods: [AvailablePaymentMethod] @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AvailablePaymentMethods") @doc(description: "Available payment methods") + selected_payment_method: SelectedPaymentMethod @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SelectedPaymentMethod") + prices: CartPrices @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartPrices") + total_quantity: Float! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartTotalQuantity") + is_virtual: Boolean! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartIsVirtual") +} + +interface CartAddressInterface @typeResolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartAddressTypeResolver") { + firstname: String! + lastname: String! + company: String + street: [String!]! + city: String! + region: CartAddressRegion + postcode: String + country: CartAddressCountry! + telephone: String! +} + +type ShippingCartAddress implements CartAddressInterface { + available_shipping_methods: [AvailableShippingMethod] @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\ShippingAddress\\AvailableShippingMethods") + selected_shipping_method: SelectedShippingMethod @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\ShippingAddress\\SelectedShippingMethod") + customer_notes: String + items_weight: Float @deprecated(reason: "This information shoud not be exposed on frontend") + cart_items: [CartItemQuantity] @deprecated(reason: "`cart_items_v2` should be used instead") + cart_items_v2: [CartItemInterface] +} + +type BillingCartAddress implements CartAddressInterface { + customer_notes: String @deprecated (reason: "The field is used only in shipping address") +} + +type CartItemQuantity @doc(description:"Deprecated: `cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`") { + cart_item_id: Int! @deprecated(reason: "`cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`") + quantity: Float! @deprecated(reason: "`cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`") +} + +type CartAddressRegion { + code: String + label: String + region_id: Int +} + +type CartAddressCountry { + code: String! + label: String! +} + +type SelectedShippingMethod { + carrier_code: String! + method_code: String! + carrier_title: String! + method_title: String! + amount: Money! + base_amount: Money @deprecated(reason: "The field should not be used on the storefront") +} + +type AvailableShippingMethod { + carrier_code: String! + carrier_title: String! + method_code: String @doc(description: "Could be null if method is not available") + method_title: String @doc(description: "Could be null if method is not available") + error_message: String + amount: Money! + base_amount: Money @deprecated(reason: "The field should not be used on the storefront") + price_excl_tax: Money! + price_incl_tax: Money! + available: Boolean! +} + +type AvailablePaymentMethod { + code: String! @doc(description: "The payment method code") + title: String! @doc(description: "The payment method title.") +} + +type SelectedPaymentMethod { + code: String! @doc(description: "The payment method code") + title: String! @doc(description: "The payment method title.") + purchase_order_number: String @doc(description: "The purchase order number.") +} + +type AppliedCoupon { + code: String! +} + +input RemoveCouponFromCartInput { + cart_id: String! +} + +type RemoveCouponFromCartOutput { + cart: Cart +} + +type AddSimpleProductsToCartOutput { + cart: Cart! +} + +type AddVirtualProductsToCartOutput { + cart: Cart! +} + +type UpdateCartItemsOutput { + cart: Cart! +} + +type RemoveItemFromCartOutput { + cart: Cart! +} + +type SetGuestEmailOnCartOutput { + cart: Cart! +} + +type SimpleCartItem implements CartItemInterface @doc(description: "Simple Cart Item") { + customizable_options: [SelectedCustomizableOption] @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\CustomizableOptions") +} + +type VirtualCartItem implements CartItemInterface @doc(description: "Virtual Cart Item") { + customizable_options: [SelectedCustomizableOption] @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\CustomizableOptions") +} + +interface CartItemInterface @typeResolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemTypeResolver") { + id: String! + quantity: Float! + prices: CartItemPrices @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemPrices") + product: ProductInterface! +} + +type Discount @doc(description:"Defines an individual discount. A discount can be applied to the cart as a whole or to an item.") { + amount: Money! @doc(description:"The amount of the discount") + label: String! @doc(description:"A description of the discount") +} + +type CartItemPrices { + price: Money! + row_total: Money! + row_total_including_tax: Money! + discounts: [Discount] @doc(description:"An array of discounts to be applied to the cart item") + total_item_discount: Money @doc(description:"The total of all discounts applied to the item") +} + +type SelectedCustomizableOption { + id: Int! + label: String! + is_required: Boolean! + values: [SelectedCustomizableOptionValue!]! + sort_order: Int! +} + +type SelectedCustomizableOptionValue { + id: Int! + label: String! + value: String! + price: CartItemSelectedOptionValuePrice! +} + +type CartItemSelectedOptionValuePrice { + value: Float! + units: String! + type: PriceTypeEnum! +} + +type Order { + order_number: String! + order_id: String @deprecated(reason: "The order_id field is deprecated, use order_number instead.") +} + +type CartUserInputError @doc(description:"An error encountered while adding an item to the the cart.") { + message: String! @doc(description: "A localized error message") + code: CartUserInputErrorType! @doc(description: "Cart-specific error code") +} + +type AddProductsToCartOutput { + cart: Cart! @doc(description: "The cart after products have been added") + user_errors: [CartUserInputError!]! @doc(description: "An error encountered while adding an item to the cart.") +} + +enum CartUserInputErrorType { + PRODUCT_NOT_FOUND + NOT_SALABLE + INSUFFICIENT_STOCK + UNDEFINED +} From 78c4f59840da7f3a5398152ad835f0ee7c57bd05 Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 21 Aug 2020 15:23:04 -0500 Subject: [PATCH 269/479] Copy over Magento_CatalogGraphQl schema from 2.4-develop --- .../graph-ql/coverage/catalog.graphqls | 494 ++++++++++++++++++ 1 file changed, 494 insertions(+) create mode 100644 design-documents/graph-ql/coverage/catalog.graphqls diff --git a/design-documents/graph-ql/coverage/catalog.graphqls b/design-documents/graph-ql/coverage/catalog.graphqls new file mode 100644 index 000000000..f510637f4 --- /dev/null +++ b/design-documents/graph-ql/coverage/catalog.graphqls @@ -0,0 +1,494 @@ +# Copyright © Magento, Inc. All rights reserved. +# See COPYING.txt for license details. + +type Query { + products ( + search: String @doc(description: "Performs a full-text search using the specified key words."), + filter: ProductAttributeFilterInput @doc(description: "Identifies which product attributes to search for and return."), + pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. This attribute is optional."), + currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1."), + sort: ProductAttributeSortInput @doc(description: "Specifies which attributes to sort on, and whether to return the results in ascending or descending order.") + ): Products + @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Products") @doc(description: "The products query searches for products that match the criteria specified in the search and filter attributes.") @cache(cacheIdentity: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\Identity") + category ( + id: Int @doc(description: "Id of the category.") + ): CategoryTree + @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\CategoryTree") @doc(description: "The category query searches for categories that match the criteria specified in the search and filter attributes.") @deprecated(reason: "Use 'categoryList' query instead of 'category' query") @cache(cacheIdentity: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\CategoryTreeIdentity") + categoryList( + filters: CategoryFilterInput @doc(description: "Identifies which Category filter inputs to search for and return.") + ): [CategoryTree] @doc(description: "Returns an array of categories based on the specified filters.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\CategoryList") @cache(cacheIdentity: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\CategoriesIdentity") + categories ( + filters: CategoryFilterInput @doc(description: "Identifies which Category filter inputs to search for and return.") + pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. This attribute is optional.") + currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1.") + ): CategoryResult @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\CategoriesQuery") @cache(cacheIdentity: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\CategoriesIdentity") +} + +type Price @doc(description: "Price is deprecated, replaced by ProductPrice. The Price object defines the price of a product as well as any tax-related adjustments.") { + amount: Money @deprecated(reason: "Price is deprecated, use ProductPrice.") @doc(description: "The price of a product plus a three-letter currency code.") + adjustments: [PriceAdjustment] @deprecated(reason: "Price is deprecated, use ProductPrice.") @doc(description: "An array that provides information about tax, weee, or weee_tax adjustments.") +} + +type PriceAdjustment @doc(description: "PriceAdjustment is deprecated. Taxes will be included or excluded in the price. The PricedAdjustment object defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.") { + amount: Money @doc(description: "The amount of the price adjustment and its currency code.") + code: PriceAdjustmentCodesEnum @deprecated(reason: "PriceAdjustment is deprecated.") @doc(description: "Indicates whether the adjustment involves tax, weee, or weee_tax.") + description: PriceAdjustmentDescriptionEnum @deprecated(reason: "PriceAdjustment is deprecated.") @doc(description: "Indicates whether the entity described by the code attribute is included or excluded from the adjustment.") +} + +enum PriceAdjustmentCodesEnum @doc(description: "PriceAdjustment.code is deprecated. This enumeration contains values defined in modules other than the Catalog module.") { +} + +enum PriceAdjustmentDescriptionEnum @doc(description: "PriceAdjustmentDescriptionEnum is deprecated. This enumeration states whether a price adjustment is included or excluded.") { + INCLUDED + EXCLUDED +} + +enum PriceTypeEnum @doc(description: "This enumeration the price type.") { + FIXED + PERCENT + DYNAMIC +} + +type ProductPrices @doc(description: "ProductPrices is deprecated, replaced by PriceRange. The ProductPrices object contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.") { + minimalPrice: Price @deprecated(reason: "Use PriceRange.minimum_price.") @doc(description: "The lowest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the from value.") + maximalPrice: Price @deprecated(reason: "Use PriceRange.maximum_price.") @doc(description: "The highest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the to value.") + regularPrice: Price @deprecated(reason: "Use regular_price from PriceRange.minimum_price or PriceRange.maximum_price.") @doc(description: "The base price of a product.") +} + +type PriceRange @doc(description: "Price range for a product. If the product has a single price, the minimum and maximum price will be the same."){ + minimum_price: ProductPrice! @doc(description: "The lowest possible price for the product.") + maximum_price: ProductPrice @doc(description: "The highest possible price for the product.") +} + +type ProductPrice @doc(description: "Represents a product price.") { + regular_price: Money! @doc(description: "The regular price of the product.") + final_price: Money! @doc(description: "The final price of the product after discounts applied.") + discount: ProductDiscount @doc(description: "The price discount. Represents the difference between the regular and final price.") +} + +type ProductDiscount @doc(description: "A discount applied to a product price.") { + percent_off: Float @doc(description: "The discount expressed a percentage.") + amount_off: Float @doc(description: "The actual value of the discount.") +} + +type ProductLinks implements ProductLinksInterface @doc(description: "ProductLinks is an implementation of ProductLinksInterface.") { +} + +interface ProductLinksInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\\ProductLinkTypeResolverComposite") @doc(description:"ProductLinks contains information about linked products, including the link type and product type of each item.") { + sku: String @doc(description: "The identifier of the linked product.") + link_type: String @doc(description: "One of related, associated, upsell, or crosssell.") + linked_product_sku: String @doc(description: "The SKU of the linked product.") + linked_product_type: String @doc(description: "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).") + position: Int @doc(description: "The position within the list of product links.") +} + +interface ProductInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\\ProductInterfaceTypeResolverComposite") @doc(description: "The ProductInterface contains attributes that are common to all types of products. Note that descriptions may not be available for custom and EAV attributes.") { + id: Int @doc(description: "The ID number assigned to the product.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\EntityIdToId") + name: String @doc(description: "The product name. Customers use this name to identify the product.") + sku: String @doc(description: "A number or code assigned to a product to identify the product, options, price, and manufacturer.") + description: ComplexTextValue @doc(description: "Detailed information about the product. The value can include simple HTML tags.") @resolver(class: "\\Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\ProductComplexTextAttribute") + short_description: ComplexTextValue @doc(description: "A short description of the product. Its use depends on the theme.") @resolver(class: "\\Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\ProductComplexTextAttribute") + special_price: Float @doc(description: "The discounted price of the product.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\SpecialPrice") + special_from_date: String @doc(description: "The beginning date that a product has a special price.") + special_to_date: String @doc(description: "The end date that a product has a special price.") + attribute_set_id: Int @doc(description: "The attribute set assigned to the product.") + meta_title: String @doc(description: "A string that is displayed in the title bar and tab of the browser and in search results lists.") + meta_keyword: String @doc(description: "A comma-separated list of keywords that are visible only to search engines.") + meta_description: String @doc(description: "A brief overview of the product for search results listings, maximum 255 characters.") + image: ProductImage @doc(description: "The relative path to the main image on the product page.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\ProductImage") + small_image: ProductImage @doc(description: "The relative path to the small image, which is used on catalog pages.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\ProductImage") + thumbnail: ProductImage @doc(description: "The relative path to the product's thumbnail image.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\ProductImage") + new_from_date: String @doc(description: "The beginning date for new product listings, and determines if the product is featured as a new product.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\NewFromTo") + new_to_date: String @doc(description: "The end date for new product listings.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\NewFromTo") + tier_price: Float @deprecated(reason: "Use price_tiers for product tier price information.") @doc(description: "The price when tier pricing is in effect and the items purchased threshold has been reached.") + options_container: String @doc(description: "If the product has multiple options, determines where they appear on the product page.") + created_at: String @doc(description: "Timestamp indicating when the product was created.") + updated_at: String @doc(description: "Timestamp indicating when the product was updated.") + country_of_manufacture: String @doc(description: "The product's country of origin.") + type_id: String @doc(description: "One of simple, virtual, bundle, downloadable, grouped, or configurable.") @deprecated(reason: "Use __typename instead.") + websites: [Website] @doc(description: "An array of websites in which the product is available.") @deprecated(reason: "The field should not be used on the storefront.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\Websites") + product_links: [ProductLinksInterface] @doc(description: "An array of ProductLinks objects.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\BatchProductLinks") + media_gallery_entries: [MediaGalleryEntry] @deprecated(reason: "Use product's `media_gallery` instead") @doc(description: "An array of MediaGalleryEntry objects.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\MediaGalleryEntries") + price: ProductPrices @deprecated(reason: "Use price_range for product price information.") @doc(description: "A ProductPrices object, indicating the price of an item.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\Price") + price_range: PriceRange! @doc(description: "A PriceRange object, indicating the range of prices for the product") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\PriceRange") + gift_message_available: String @doc(description: "Indicates whether a gift message is available.") + manufacturer: Int @doc(description: "A number representing the product's manufacturer.") + categories: [CategoryInterface] @doc(description: "The categories assigned to a product.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Categories") @cache(cacheIdentity: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\CategoriesIdentity") + canonical_url: String @doc(description: "Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\CanonicalUrl") + media_gallery: [MediaGalleryInterface] @doc(description: "An array of Media Gallery objects.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\MediaGallery") +} + +interface PhysicalProductInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\\ProductInterfaceTypeResolverComposite") @doc(description: "PhysicalProductInterface contains attributes specific to tangible products.") { + weight: Float @doc(description: "The weight of the item, in units defined by the store.") +} + +type CustomizableAreaOption implements CustomizableOptionInterface @doc(description: "CustomizableAreaOption contains information about a text area that is defined as part of a customizable option.") { + value: CustomizableAreaValue @doc(description: "An object that defines a text area.") + product_sku: String @doc(description: "The Stock Keeping Unit of the base product.") +} + +type CustomizableAreaValue @doc(description: "CustomizableAreaValue defines the price and sku of a product whose page contains a customized text area.") { + price: Float @doc(description: "The price assigned to this option.") + price_type: PriceTypeEnum @doc(description: "FIXED, PERCENT, or DYNAMIC.") + sku: String @doc(description: "The Stock Keeping Unit for this option.") + max_characters: Int @doc(description: "The maximum number of characters that can be entered for this customizable option.") + uid: ID! @doc(description: "A string that encodes option details.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\CustomizableEnteredOptionValueUid") # A Base64 string that encodes option details. +} + +type CategoryTree implements CategoryInterface @doc(description: "Category Tree implementation.") { + children: [CategoryTree] @doc(description: "Child categories tree.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\CategoryTree") +} + +type CategoryResult @doc(description: "A collection of CategoryTree objects and pagination information.") { + items: [CategoryTree] @doc(description: "A list of categories that match the filter criteria.") + page_info: SearchResultPageInfo @doc(description: "An object that includes the page_info and currentPage values specified in the query.") + total_count: Int @doc(description: "The total number of categories that match the criteria.") +} + +type CustomizableDateOption implements CustomizableOptionInterface @doc(description: "CustomizableDateOption contains information about a date picker that is defined as part of a customizable option.") { + value: CustomizableDateValue @doc(description: "An object that defines a date field in a customizable option.") + product_sku: String @doc(description: "The Stock Keeping Unit of the base product.") +} + +type CustomizableDateValue @doc(description: "CustomizableDateValue defines the price and sku of a product whose page contains a customized date picker.") { + price: Float @doc(description: "The price assigned to this option.") + price_type: PriceTypeEnum @doc(description: "FIXED, PERCENT, or DYNAMIC.") + sku: String @doc(description: "The Stock Keeping Unit for this option.") + uid: ID! @doc(description: "A string that encodes option details.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\CustomizableEnteredOptionValueUid") # A Base64 string that encodes option details. +} + +type CustomizableDropDownOption implements CustomizableOptionInterface @doc(description: "CustomizableDropDownOption contains information about a drop down menu that is defined as part of a customizable option.") { + value: [CustomizableDropDownValue] @doc(description: "An array that defines the set of options for a drop down menu.") +} + +type CustomizableDropDownValue @doc(description: "CustomizableDropDownValue defines the price and sku of a product whose page contains a customized drop down menu.") { + option_type_id: Int @doc(description: "The ID assigned to the value.") + price: Float @doc(description: "The price assigned to this option.") + price_type: PriceTypeEnum @doc(description: "FIXED, PERCENT, or DYNAMIC.") + sku: String @doc(description: "The Stock Keeping Unit for this option.") + title: String @doc(description: "The display name for this option.") + sort_order: Int @doc(description: "The order in which the option is displayed.") + uid: ID! @doc(description: "A string that encodes option details.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\CustomizableSelectedOptionValueUid") # A Base64 string that encodes option details. +} + +type CustomizableMultipleOption implements CustomizableOptionInterface @doc(description: "CustomizableMultipleOption contains information about a multiselect that is defined as part of a customizable option.") { + value: [CustomizableMultipleValue] @doc(description: "An array that defines the set of options for a multiselect.") +} + +type CustomizableMultipleValue @doc(description: "CustomizableMultipleValue defines the price and sku of a product whose page contains a customized multiselect.") { + option_type_id: Int @doc(description: "The ID assigned to the value.") + price: Float @doc(description: "The price assigned to this option.") + price_type: PriceTypeEnum @doc(description: "FIXED, PERCENT, or DYNAMIC.") + sku: String @doc(description: "The Stock Keeping Unit for this option.") + title: String @doc(description: "The display name for this option.") + sort_order: Int @doc(description: "The order in which the option is displayed.") + uid: ID! @doc(description: "A string that encodes option details.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\CustomizableSelectedOptionValueUid") +} + +type CustomizableFieldOption implements CustomizableOptionInterface @doc(description: "CustomizableFieldOption contains information about a text field that is defined as part of a customizable option.") { + value: CustomizableFieldValue @doc(description: "An object that defines a text field.") + product_sku: String @doc(description: "The Stock Keeping Unit of the base product.") +} + +type CustomizableFieldValue @doc(description: "CustomizableFieldValue defines the price and sku of a product whose page contains a customized text field.") { + price: Float @doc(description: "The price of the custom value.") + price_type: PriceTypeEnum @doc(description: "FIXED, PERCENT, or DYNAMIC.") + sku: String @doc(description: "The Stock Keeping Unit for this option.") + max_characters: Int @doc(description: "The maximum number of characters that can be entered for this customizable option.") + uid: ID! @doc(description: "A string that encodes option details.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\CustomizableEnteredOptionValueUid") # A Base64 string that encodes option details. +} + +type CustomizableFileOption implements CustomizableOptionInterface @doc(description: "CustomizableFileOption contains information about a file picker that is defined as part of a customizable option.") { + value: CustomizableFileValue @doc(description: "An object that defines a file value.") + product_sku: String @doc(description: "The Stock Keeping Unit of the base product.") +} + +type CustomizableFileValue @doc(description: "CustomizableFileValue defines the price and sku of a product whose page contains a customized file picker.") { + price: Float @doc(description: "The price assigned to this option.") + price_type: PriceTypeEnum @doc(description: "FIXED, PERCENT, or DYNAMIC.") + sku: String @doc(description: "The Stock Keeping Unit for this option.") + file_extension: String @doc(description: "The file extension to accept.") + image_size_x: Int @doc(description: "The maximum width of an image.") + image_size_y: Int @doc(description: "The maximum height of an image.") + uid: ID! @doc(description: "A string that encodes option details.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\CustomizableEnteredOptionValueUid") # A Base64 string that encodes option details. +} + +interface MediaGalleryInterface @doc(description: "Contains basic information about a product image or video.") @typeResolver(class: "Magento\\CatalogGraphQl\\Model\\MediaGalleryTypeResolver") { + url: String @doc(description: "The URL of the product image or video.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\MediaGallery\\Url") + label: String @doc(description: "The label of the product image or video.") + position: Int @doc(description: "The media item's position after it has been sorted.") + disabled: Boolean @doc(description: "Whether the image is hidden from view.") +} + +type ProductImage implements MediaGalleryInterface @doc(description: "Product image information. Contains the image URL and label.") { +} + +type ProductVideo implements MediaGalleryInterface @doc(description: "Contains information about a product video.") { + video_content: ProductMediaGalleryEntriesVideoContent @doc(description: "Contains a ProductMediaGalleryEntriesVideoContent object.") +} + +interface CustomizableOptionInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\\CustomizableOptionTypeResolver") @doc(description: "The CustomizableOptionInterface contains basic information about a customizable option. It can be implemented by several types of configurable options.") { + title: String @doc(description: "The display name for this option.") + required: Boolean @doc(description: "Indicates whether the option is required.") + sort_order: Int @doc(description: "The order in which the option is displayed.") + option_id: Int @doc(description: "Option ID.") +} + +interface CustomizableProductInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\\ProductInterfaceTypeResolverComposite") @doc(description: "CustomizableProductInterface contains information about customizable product options.") { + options: [CustomizableOptionInterface] @doc(description: "An array of options for a customizable product.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\Options") +} + +interface CategoryInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\\CategoryInterfaceTypeResolver") @doc(description: "CategoryInterface contains the full set of attributes that can be returned in a category search.") { + id: Int @doc(description: "An ID that uniquely identifies the category.") + description: String @doc(description: "An optional description of the category.") @resolver(class: "\\Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\CategoryHtmlAttribute") + name: String @doc(description: "The display name of the category.") + path: String @doc(description: "Category Path.") + path_in_store: String @doc(description: "Category path in store.") + url_key: String @doc(description: "The url key assigned to the category.") + url_path: String @doc(description: "The url path assigned to the category.") + canonical_url: String @doc(description: "Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\CanonicalUrl") + position: Int @doc(description: "The position of the category relative to other categories at the same level in tree.") + level: Int @doc(description: "Indicates the depth of the category within the tree.") + created_at: String @doc(description: "Timestamp indicating when the category was created.") + updated_at: String @doc(description: "Timestamp indicating when the category was updated.") + product_count: Int @doc(description: "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\ProductsCount") + default_sort_by: String @doc(description: "The attribute to use for sorting.") + products( + pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. This attribute is optional."), + currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1."), + sort: ProductAttributeSortInput @doc(description: "Specifies which attributes to sort on, and whether to return the results in ascending or descending order.") + ): CategoryProducts @doc(description: "The list of products assigned to the category.") @cache(cacheIdentity: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\Identity") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\Products") + breadcrumbs: [Breadcrumb] @doc(description: "Breadcrumbs, parent categories info.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\Breadcrumbs") +} + +type Breadcrumb @doc(description: "Breadcrumb item."){ + category_id: Int @doc(description: "Category ID.") + category_name: String @doc(description: "Category name.") + category_level: Int @doc(description: "Category level.") + category_url_key: String @doc(description: "Category URL key.") + category_url_path: String @doc(description: "Category URL path.") +} + +type CustomizableRadioOption implements CustomizableOptionInterface @doc(description: "CustomizableRadioOption contains information about a set of radio buttons that are defined as part of a customizable option.") { + value: [CustomizableRadioValue] @doc(description: "An array that defines a set of radio buttons.") +} + +type CustomizableRadioValue @doc(description: "CustomizableRadioValue defines the price and sku of a product whose page contains a customized set of radio buttons.") { + option_type_id: Int @doc(description: "The ID assigned to the value.") + price: Float @doc(description: "The price assigned to this option.") + price_type: PriceTypeEnum @doc(description: "FIXED, PERCENT, or DYNAMIC.") + sku: String @doc(description: "The Stock Keeping Unit for this option.") + title: String @doc(description: "The display name for this option.") + sort_order: Int @doc(description: "The order in which the radio button is displayed.") + uid: ID! @doc(description: "A string that encodes option details.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\CustomizableSelectedOptionValueUid") # A Base64 string that encodes option details. +} + +type CustomizableCheckboxOption implements CustomizableOptionInterface @doc(description: "CustomizableCheckbbixOption contains information about a set of checkbox values that are defined as part of a customizable option.") { + value: [CustomizableCheckboxValue] @doc(description: "An array that defines a set of checkbox values.") +} + +type CustomizableCheckboxValue @doc(description: "CustomizableCheckboxValue defines the price and sku of a product whose page contains a customized set of checkbox values.") { + option_type_id: Int @doc(description: "The ID assigned to the value.") + price: Float @doc(description: "The price assigned to this option.") + price_type: PriceTypeEnum @doc(description: "FIXED, PERCENT, or DYNAMIC.") + sku: String @doc(description: "The Stock Keeping Unit for this option.") + title: String @doc(description: "The display name for this option.") + sort_order: Int @doc(description: "The order in which the checkbox value is displayed.") + uid: ID! @doc(description: "A string that encodes option details.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\CustomizableSelectedOptionValueUid") # A Base64 string that encodes option details. +} + +type VirtualProduct implements ProductInterface, CustomizableProductInterface @doc(description: "A virtual product is non-tangible product that does not require shipping and is not kept in inventory.") { +} + +type SimpleProduct implements ProductInterface, PhysicalProductInterface, CustomizableProductInterface @doc(description: "A simple product is tangible and are usually sold as single units or in fixed quantities.") +{ +} + +type Products @doc(description: "The Products object is the top-level object returned in a product search.") { + items: [ProductInterface] @doc(description: "An array of products that match the specified search criteria.") + page_info: SearchResultPageInfo @doc(description: "An object that includes the page_info and currentPage values specified in the query.") + total_count: Int @doc(description: "The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.") + filters: [LayerFilter] @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\LayerFilters") @doc(description: "Layered navigation filters array.") @deprecated(reason: "Use aggregations instead") + aggregations: [Aggregation] @doc(description: "Layered navigation aggregations.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Aggregations") + sort_fields: SortFields @doc(description: "An object that includes the default sort field and all available sort fields.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\SortFields") +} + +type CategoryProducts @doc(description: "The category products object returned in the Category query.") { + items: [ProductInterface] @doc(description: "An array of products that are assigned to the category.") + page_info: SearchResultPageInfo @doc(description: "An object that includes the page_info and currentPage values specified in the query.") + total_count: Int @doc(description: "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.") +} + +input ProductAttributeFilterInput @doc(description: "ProductAttributeFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.") { + category_id: FilterEqualTypeInput @doc(description: "Filter product by category id") +} + +input CategoryFilterInput @doc(description: "CategoryFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.") +{ + ids: FilterEqualTypeInput @doc(description: "Filter by category ID that uniquely identifies the category.") + url_key: FilterEqualTypeInput @doc(description: "Filter by the part of the URL that identifies the category.") + name: FilterMatchTypeInput @doc(description: "Filter by the display name of the category.") + url_path: FilterEqualTypeInput @doc(description: "Filter by the URL path for the category.") +} + +input ProductFilterInput @doc(description: "ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.") { + name: FilterTypeInput @doc(description: "The product name. Customers use this name to identify the product.") + sku: FilterTypeInput @doc(description: "A number or code assigned to a product to identify the product, options, price, and manufacturer.") + description: FilterTypeInput @doc(description: "Detailed information about the product. The value can include simple HTML tags.") + short_description: FilterTypeInput @doc(description: "A short description of the product. Its use depends on the theme.") + price: FilterTypeInput @doc(description: "The price of an item.") + special_price: FilterTypeInput @doc(description: "The discounted price of the product. Do not include the currency code.") + special_from_date: FilterTypeInput @doc(description: "The beginning date that a product has a special price.") + special_to_date: FilterTypeInput @doc(description: "The end date that a product has a special price.") + weight: FilterTypeInput @doc(description: "The weight of the item, in units defined by the store.") + manufacturer: FilterTypeInput @doc(description: "A number representing the product's manufacturer.") + meta_title: FilterTypeInput @doc(description: "A string that is displayed in the title bar and tab of the browser and in search results lists.") + meta_keyword: FilterTypeInput @doc(description: "A comma-separated list of keywords that are visible only to search engines.") + meta_description: FilterTypeInput @doc(description: "A brief overview of the product for search results listings, maximum 255 characters.") + image: FilterTypeInput @doc(description: "The relative path to the main image on the product page.") + small_image: FilterTypeInput @doc(description: "The relative path to the small image, which is used on catalog pages.") + thumbnail: FilterTypeInput @doc(description: "The relative path to the product's thumbnail image.") + tier_price: FilterTypeInput @doc(description: "The price when tier pricing is in effect and the items purchased threshold has been reached.") + news_from_date: FilterTypeInput @doc(description: "The beginning date for new product listings, and determines if the product is featured as a new product.") + news_to_date: FilterTypeInput @doc(description: "The end date for new product listings.") + custom_layout_update: FilterTypeInput @doc(description: "XML code that is applied as a layout update to the product page.") + min_price: FilterTypeInput @doc(description:"The numeric minimal price of the product. Do not include the currency code.") + max_price: FilterTypeInput @doc(description:"The numeric maximal price of the product. Do not include the currency code.") + category_id: FilterTypeInput @doc(description: "Category ID the product belongs to.") + options_container: FilterTypeInput @doc(description: "If the product has multiple options, determines where they appear on the product page.") + required_options: FilterTypeInput @doc(description: "Indicates whether the product has required options.") + has_options: FilterTypeInput @doc(description: "Indicates whether additional attributes have been created for the product.") + image_label: FilterTypeInput @doc(description: "The label assigned to a product image.") + small_image_label: FilterTypeInput @doc(description: "The label assigned to a product's small image.") + thumbnail_label: FilterTypeInput @doc(description: "The label assigned to a product's thumbnail image.") + created_at: FilterTypeInput @doc(description: "Timestamp indicating when the product was created.") + updated_at: FilterTypeInput @doc(description: "Timestamp indicating when the product was updated.") + country_of_manufacture: FilterTypeInput @doc(description: "The product's country of origin.") + custom_layout: FilterTypeInput @doc(description: "The name of a custom layout.") + gift_message_available: FilterTypeInput @doc(description: "Indicates whether a gift message is available.") + or: ProductFilterInput @doc(description: "The keyword required to perform a logical OR comparison.") +} + +type ProductMediaGalleryEntriesContent @doc(description: "ProductMediaGalleryEntriesContent contains an image in base64 format and basic information about the image.") { + base64_encoded_data: String @doc(description: "The image in base64 format.") + type: String @doc(description: "The MIME type of the file, such as image/png.") + name: String @doc(description: "The file name of the image.") +} + +type ProductMediaGalleryEntriesVideoContent @doc(description: "ProductMediaGalleryEntriesVideoContent contains a link to a video file and basic information about the video.") { + media_type: String @doc(description: "Must be external-video.") + video_provider: String @doc(description: "Describes the video source.") + video_url: String @doc(description: "The URL to the video.") + video_title: String @doc(description: "The title of the video.") + video_description: String @doc(description: "A description of the video.") + video_metadata: String @doc(description: "Optional data about the video.") +} + +input ProductSortInput @doc(description: "ProductSortInput is deprecated, use @ProductAttributeSortInput instead. ProductSortInput specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.") { + name: SortEnum @doc(description: "The product name. Customers use this name to identify the product.") + sku: SortEnum @doc(description: "A number or code assigned to a product to identify the product, options, price, and manufacturer.") + description: SortEnum @doc(description: "Detailed information about the product. The value can include simple HTML tags.") + short_description: SortEnum @doc(description: "A short description of the product. Its use depends on the theme.") + price: SortEnum @doc(description: "The price of the item.") + special_price: SortEnum @doc(description: "The discounted price of the product.") + special_from_date: SortEnum @doc(description: "The beginning date that a product has a special price.") + special_to_date: SortEnum @doc(description: "The end date that a product has a special price.") + weight: SortEnum @doc(description: "The weight of the item, in units defined by the store.") + manufacturer: SortEnum @doc(description: "A number representing the product's manufacturer.") + meta_title: SortEnum @doc(description: "A string that is displayed in the title bar and tab of the browser and in search results lists.") + meta_keyword: SortEnum @doc(description: "A comma-separated list of keywords that are visible only to search engines.") + meta_description: SortEnum @doc(description: "A brief overview of the product for search results listings, maximum 255 characters.") + image: SortEnum @doc(description: "The relative path to the main image on the product page.") + small_image: SortEnum @doc(description: "The relative path to the small image, which is used on catalog pages.") + thumbnail: SortEnum @doc(description: "The relative path to the product's thumbnail image.") + tier_price: SortEnum @doc(description: "The price when tier pricing is in effect and the items purchased threshold has been reached.") + news_from_date: SortEnum @doc(description: "The beginning date for new product listings, and determines if the product is featured as a new product.") + news_to_date: SortEnum @doc(description: "The end date for new product listings.") + custom_layout_update: SortEnum @doc(description: "XML code that is applied as a layout update to the product page.") + options_container: SortEnum @doc(description: "If the product has multiple options, determines where they appear on the product page.") + required_options: SortEnum @doc(description: "Indicates whether the product has required options.") + has_options: SortEnum @doc(description: "Indicates whether additional attributes have been created for the product.") + image_label: SortEnum @doc(description: "The label assigned to a product image.") + small_image_label: SortEnum @doc(description: "The label assigned to a product's small image.") + thumbnail_label: SortEnum @doc(description: "The label assigned to a product's thumbnail image.") + created_at: SortEnum @doc(description: "Timestamp indicating when the product was created.") + updated_at: SortEnum @doc(description: "Timestamp indicating when the product was updated.") + country_of_manufacture: SortEnum @doc(description: "The product's country of origin.") + custom_layout: SortEnum @doc(description: "The name of a custom layout.") + gift_message_available: SortEnum @doc(description: "Indicates whether a gift message is available.") +} + +input ProductAttributeSortInput @doc(description: "ProductAttributeSortInput specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. It's possible to sort products using searchable attributes with enabled 'Use in Filter Options' option") +{ + relevance: SortEnum @doc(description: "Sort by the search relevance score (default).") + position: SortEnum @doc(description: "Sort by the position assigned to each product.") +} + +type MediaGalleryEntry @doc(description: "MediaGalleryEntry defines characteristics about images and videos associated with a specific product.") { + id: Int @doc(description: "The identifier assigned to the object.") + media_type: String @doc(description: "image or video.") + label: String @doc(description: "The alt text displayed on the UI when the user points to the image.") + position: Int @doc(description: "The media item's position after it has been sorted.") + disabled: Boolean @doc(description: "Whether the image is hidden from view.") + types: [String] @doc(description: "Array of image types. It can have the following values: image, small_image, thumbnail.") + file: String @doc(description: "The path of the image on the server.") + content: ProductMediaGalleryEntriesContent @doc(description: "Contains a ProductMediaGalleryEntriesContent object.") + video_content: ProductMediaGalleryEntriesVideoContent @doc(description: "Contains a ProductMediaGalleryEntriesVideoContent object.") +} + +type LayerFilter { + name: String @doc(description: "Layered navigation filter name.") @deprecated(reason: "Use Aggregation.label instead.") + request_var: String @doc(description: "Request variable name for filter query.") @deprecated(reason: "Use Aggregation.attribute_code instead.") + filter_items_count: Int @doc(description: "Count of filter items in filter group.") @deprecated(reason: "Use Aggregation.count instead.") + filter_items: [LayerFilterItemInterface] @doc(description: "Array of filter items.") @deprecated(reason: "Use Aggregation.options instead.") +} + +interface LayerFilterItemInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\\LayerFilterItemTypeResolverComposite") { + label: String @doc(description: "Filter label.") @deprecated(reason: "Use AggregationOption.label instead.") + value_string: String @doc(description: "Value for filter request variable to be used in query.") @deprecated(reason: "Use AggregationOption.value instead.") + items_count: Int @doc(description: "Count of items by filter.") @deprecated(reason: "Use AggregationOption.count instead.") +} + +type LayerFilterItem implements LayerFilterItemInterface { + +} + +type Aggregation @doc(description: "A bucket that contains information for each filterable option (such as price, category ID, and custom attributes).") { + count: Int @doc(description: "The number of options in the aggregation group.") + label: String @doc(description: "The aggregation display name.") + attribute_code: String! @doc(description: "Attribute code of the aggregation group.") + options: [AggregationOption] @doc(description: "Array of options for the aggregation.") +} + +interface AggregationOptionInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\\AggregationOptionTypeResolverComposite") { + count: Int @doc(description: "The number of items that match the aggregation option.") + label: String @doc(description: "Aggregation option display label.") + value: String! @doc(description: "The internal ID that represents the value of the option.") +} + +type AggregationOption implements AggregationOptionInterface { + +} + +type SortField { + value: String @doc(description: "Attribute code of sort field.") + label: String @doc(description: "Label of sort field.") +} + +type SortFields @doc(description: "SortFields contains a default value for sort fields and all available sort fields.") { + default: String @doc(description: "Default value of sort fields.") + options: [SortField] @doc(description: "Available sort fields.") +} + +type StoreConfig @doc(description: "The type contains information about a store config.") { + product_url_suffix : String @doc(description: "Product URL Suffix.") + category_url_suffix : String @doc(description: "Category URL Suffix.") + title_separator : String @doc(description: "Page Title Separator.") + list_mode : String @doc(description: "List Mode.") + grid_per_page_values : String @doc(description: "Products per Page on Grid Allowed Values.") + list_per_page_values : String @doc(description: "Products per Page on List Allowed Values.") + grid_per_page : Int @doc(description: "Products per Page on Grid Default Value.") + list_per_page : Int @doc(description: "Products per Page on List Default Value.") + catalog_default_sort_by : String @doc(description: "Default Sort By.") + root_category_id: Int @doc(description: "The ID of the root category") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\RootCategoryId") +} \ No newline at end of file From b83b5384e57658ee6e374a23a44b6738d40f9a62 Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 21 Aug 2020 15:36:31 -0500 Subject: [PATCH 270/479] Copy over Magento_CustomerGraphQl schema from 2.4-develop --- .../graph-ql/coverage/customer.graphqls | 426 ++++++++++++++++++ 1 file changed, 426 insertions(+) create mode 100644 design-documents/graph-ql/coverage/customer.graphqls diff --git a/design-documents/graph-ql/coverage/customer.graphqls b/design-documents/graph-ql/coverage/customer.graphqls new file mode 100644 index 000000000..63c5bc6a3 --- /dev/null +++ b/design-documents/graph-ql/coverage/customer.graphqls @@ -0,0 +1,426 @@ +# Copyright © Magento, Inc. All rights reserved. +# See COPYING.txt for license details. + +type StoreConfig { + required_character_classes_number : String @doc(description: "The number of different character classes required in a password (lowercase, uppercase, digits, special characters).") + minimum_password_length : String @doc(description: "The minimum number of characters required for a valid password.") + autocomplete_on_storefront : Boolean @doc(description: "Enable autocomplete on login and forgot password forms") +} + +type Query { + customer: Customer @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\Customer") @doc(description: "The customer query returns information about a customer account") @cache(cacheable: false) + isEmailAvailable ( + email: String! @doc(description: "The new customer email") + ): IsEmailAvailableOutput @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\IsEmailAvailable") +} + +type Mutation { + generateCustomerToken(email: String!, password: String!): CustomerToken @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\GenerateCustomerToken") @doc(description:"Retrieve the customer token") + changeCustomerPassword(currentPassword: String!, newPassword: String!): Customer @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\ChangePassword") @doc(description:"Changes the password for the logged-in customer") + createCustomer (input: CustomerInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomer") @doc(description:"Create customer account") + createCustomerV2 (input: CustomerCreateInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomer") @doc(description:"Create customer account") + updateCustomer (input: CustomerInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomer") @doc(description:"Deprecated. Use UpdateCustomerV2 instead.") + updateCustomerV2 (input: CustomerUpdateInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomer") @doc(description:"Update the customer's personal information") + revokeCustomerToken: RevokeCustomerTokenOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\RevokeCustomerToken") @doc(description:"Revoke the customer token") + createCustomerAddress(input: CustomerAddressInput!): CustomerAddress @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomerAddress") @doc(description: "Create customer address") + updateCustomerAddress(id: Int!, input: CustomerAddressInput): CustomerAddress @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomerAddress") @doc(description: "Update customer address") + deleteCustomerAddress(id: Int!): Boolean @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\DeleteCustomerAddress") @doc(description: "Delete customer address") + requestPasswordResetEmail(email: String!): Boolean @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\RequestPasswordResetEmail") @doc(description: "Request an email with a reset password token for the registered customer identified by the specified email.") + resetPassword(email: String!, resetPasswordToken: String!, newPassword: String!): Boolean @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\ResetPassword") @doc(description: "Reset a customer's password using the reset password token that the customer received in an email after requesting it using requestPasswordResetEmail.") + updateCustomerEmail(email: String!, password: String!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomerEmail") @doc(description: "") +} + +input CustomerAddressInput { + firstname: String @doc(description: "The first name of the person associated with the shipping/billing address") + lastname: String @doc(description: "The family name of the person associated with the shipping/billing address") + company: String @doc(description: "The customer's company") + telephone: String @doc(description: "The telephone number") + street: [String] @doc(description: "An array of strings that define the street number and name") + city: String @doc(description: "The city or town") + region: CustomerAddressRegionInput @doc(description: "An object containing the region name, region code, and region ID") + postcode: String @doc(description: "The customer's ZIP or postal code") + country_id: CountryCodeEnum @doc(description: "Deprecated: use `country_code` instead.") + country_code: CountryCodeEnum @doc(description: "The customer's country") + default_shipping: Boolean @doc(description: "Indicates whether the address is the default shipping address") + default_billing: Boolean @doc(description: "Indicates whether the address is the default billing address") + fax: String @doc(description: "The fax number") + middlename: String @doc(description: "The middle name of the person associated with the shipping/billing address") + prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.") + suffix: String @doc(description: "A value such as Sr., Jr., or III") + vat_id: String @doc(description: "The customer's Tax/VAT number (for corporate customers)") + custom_attributes: [CustomerAddressAttributeInput] @doc(description: "Deprecated: Custom attributes should not be put into container.") +} + +input CustomerAddressRegionInput @doc(description: "CustomerAddressRegionInput defines the customer's state or province") { + region_code: String @doc(description: "The address region code") + region: String @doc(description: "The state or province name") + region_id: Int @doc(description: "The unique ID for a pre-defined region") +} + +input CustomerAddressAttributeInput { + attribute_code: String! @doc(description: "Attribute code") + value: String! @doc(description: "Attribute value") +} + +type CustomerToken { + token: String @doc(description: "The customer token") +} + +input CustomerInput { + prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.") + firstname: String @doc(description: "The customer's first name") + middlename: String @doc(description: "The customer's middle name") + lastname: String @doc(description: "The customer's family name") + suffix: String @doc(description: "A value such as Sr., Jr., or III") + email: String @doc(description: "The customer's email address. Required for customer creation") + dob: String @doc(description: "Deprecated: Use `date_of_birth` instead") + date_of_birth: String @doc(description: "The customer's date of birth") + taxvat: String @doc(description: "The customer's Tax/VAT number (for corporate customers)") + gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2)") + password: String @doc(description: "The customer's password") + is_subscribed: Boolean @doc(description: "Indicates whether the customer is subscribed to the company's newsletter") +} + +input CustomerCreateInput { + prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.") + firstname: String! @doc(description: "The customer's first name") + middlename: String @doc(description: "The customer's middle name") + lastname: String! @doc(description: "The customer's family name") + suffix: String @doc(description: "A value such as Sr., Jr., or III") + email: String! @doc(description: "The customer's email address. Required for customer creation") + dob: String @doc(description: "Deprecated: Use `date_of_birth` instead") + date_of_birth: String @doc(description: "The customer's date of birth") + taxvat: String @doc(description: "The customer's Tax/VAT number (for corporate customers)") + gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2)") + password: String @doc(description: "The customer's password") + is_subscribed: Boolean @doc(description: "Indicates whether the customer is subscribed to the company's newsletter") +} + +input CustomerUpdateInput { + date_of_birth: String @doc(description: "The customer's date of birth") + dob: String @doc(description: "Deprecated: Use `date_of_birth` instead") + firstname: String @doc(description: "The customer's first name") + gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2)") + is_subscribed: Boolean @doc(description: "Indicates whether the customer is subscribed to the company's newsletter") + lastname: String @doc(description: "The customer's family name") + middlename: String @doc(description: "The customer's middle name") + prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.") + suffix: String @doc(description: "A value such as Sr., Jr., or III") + taxvat: String @doc(description: "The customer's Tax/VAT number (for corporate customers)") +} + +type CustomerOutput { + customer: Customer! +} + +type RevokeCustomerTokenOutput { + result: Boolean! +} + +type Customer @doc(description: "Customer defines the customer name and address and other details") { + created_at: String @doc(description: "Timestamp indicating when the account was created") + group_id: Int @deprecated(reason: "Customer group should not be exposed in the storefront scenarios") + prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.") + firstname: String @doc(description: "The customer's first name") + middlename: String @doc(description: "The customer's middle name") + lastname: String @doc(description: "The customer's family name") + suffix: String @doc(description: "A value such as Sr., Jr., or III") + email: String @doc(description: "The customer's email address. Required") + default_billing: String @doc(description: "The ID assigned to the billing address") + default_shipping: String @doc(description: "The ID assigned to the shipping address") + dob: String @doc(description: "The customer's date of birth") @deprecated(reason: "Use `date_of_birth` instead") + date_of_birth: String @doc(description: "The customer's date of birth") + taxvat: String @doc(description: "The customer's Value-added tax (VAT) number (for corporate customers)") + id: Int @doc(description: "The ID assigned to the customer") @deprecated(reason: "id is not needed as part of Customer because on server side it can be identified based on customer token used for authentication. There is no need to know customer ID on the client side.") + is_subscribed: Boolean @doc(description: "Indicates whether the customer is subscribed to the company's newsletter") @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\IsSubscribed") + addresses: [CustomerAddress] @doc(description: "An array containing the customer's shipping and billing addresses") @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CustomerAddresses") + gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2)") +} + +type CustomerAddress @doc(description: "CustomerAddress contains detailed information about a customer's billing and shipping addresses"){ + id: Int @doc(description: "The ID assigned to the address object") + customer_id: Int @doc(description: "The customer ID") @deprecated(reason: "customer_id is not needed as part of CustomerAddress, address ID (id) is unique identifier for the addresses.") + region: CustomerAddressRegion @doc(description: "An object containing the region name, region code, and region ID") + region_id: Int @doc(description: "The unique ID for a pre-defined region") + country_id: String @doc(description: "The customer's country") @deprecated(reason: "Use `country_code` instead.") + country_code: CountryCodeEnum @doc(description: "The customer's country") + street: [String] @doc(description: "An array of strings that define the street number and name") + company: String @doc(description: "The customer's company") + telephone: String @doc(description: "The telephone number") + fax: String @doc(description: "The fax number") + postcode: String @doc(description: "The customer's ZIP or postal code") + city: String @doc(description: "The city or town") + firstname: String @doc(description: "The first name of the person associated with the shipping/billing address") + lastname: String @doc(description: "The family name of the person associated with the shipping/billing address") + middlename: String @doc(description: "The middle name of the person associated with the shipping/billing address") + prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.") + suffix: String @doc(description: "A value such as Sr., Jr., or III") + vat_id: String @doc(description: "The customer's Value-added tax (VAT) number (for corporate customers)") + default_shipping: Boolean @doc(description: "Indicates whether the address is the default shipping address") + default_billing: Boolean @doc(description: "Indicates whether the address is the default billing address") + custom_attributes: [CustomerAddressAttribute] @deprecated(reason: "Custom attributes should not be put into container") + extension_attributes: [CustomerAddressAttribute] @doc(description: "Address extension attributes") +} + +type CustomerAddressRegion @doc(description: "CustomerAddressRegion defines the customer's state or province") { + region_code: String @doc(description: "The address region code") + region: String @doc(description: "The state or province name") + region_id: Int @doc(description: "The unique ID for a pre-defined region") +} + +type CustomerAddressAttribute { + attribute_code: String @doc(description: "Attribute code") + value: String @doc(description: "Attribute value") +} + +type IsEmailAvailableOutput { + is_email_available: Boolean @doc(description: "Is email availabel value") +} + +enum CountryCodeEnum @doc(description: "The list of countries codes") { + AF @doc(description: "Afghanistan") + AX @doc(description: "Åland Islands") + AL @doc(description: "Albania") + DZ @doc(description: "Algeria") + AS @doc(description: "American Samoa") + AD @doc(description: "Andorra") + AO @doc(description: "Angola") + AI @doc(description: "Anguilla") + AQ @doc(description: "Antarctica") + AG @doc(description: "Antigua & Barbuda") + AR @doc(description: "Argentina") + AM @doc(description: "Armenia") + AW @doc(description: "Aruba") + AU @doc(description: "Australia") + AT @doc(description: "Austria") + AZ @doc(description: "Azerbaijan") + BS @doc(description: "Bahamas") + BH @doc(description: "Bahrain") + BD @doc(description: "Bangladesh") + BB @doc(description: "Barbados") + BY @doc(description: "Belarus") + BE @doc(description: "Belgium") + BZ @doc(description: "Belize") + BJ @doc(description: "Benin") + BM @doc(description: "Bermuda") + BT @doc(description: "Bhutan") + BO @doc(description: "Bolivia") + BA @doc(description: "Bosnia & Herzegovina") + BW @doc(description: "Botswana") + BV @doc(description: "Bouvet Island") + BR @doc(description: "Brazil") + IO @doc(description: "British Indian Ocean Territory") + VG @doc(description: "British Virgin Islands") + BN @doc(description: "Brunei") + BG @doc(description: "Bulgaria") + BF @doc(description: "Burkina Faso") + BI @doc(description: "Burundi") + KH @doc(description: "Cambodia") + CM @doc(description: "Cameroon") + CA @doc(description: "Canada") + CV @doc(description: "Cape Verde") + KY @doc(description: "Cayman Islands") + CF @doc(description: "Central African Republic") + TD @doc(description: "Chad") + CL @doc(description: "Chile") + CN @doc(description: "China") + CX @doc(description: "Christmas Island") + CC @doc(description: "Cocos (Keeling) Islands") + CO @doc(description: "Colombia") + KM @doc(description: "Comoros") + CG @doc(description: "Congo-Brazzaville") + CD @doc(description: "Congo-Kinshasa") + CK @doc(description: "Cook Islands") + CR @doc(description: "Costa Rica") + CI @doc(description: "Côte d’Ivoire") + HR @doc(description: "Croatia") + CU @doc(description: "Cuba") + CY @doc(description: "Cyprus") + CZ @doc(description: "Czech Republic") + DK @doc(description: "Denmark") + DJ @doc(description: "Djibouti") + DM @doc(description: "Dominica") + DO @doc(description: "Dominican Republic") + EC @doc(description: "Ecuador") + EG @doc(description: "Egypt") + SV @doc(description: "El Salvador") + GQ @doc(description: "Equatorial Guinea") + ER @doc(description: "Eritrea") + EE @doc(description: "Estonia") + ET @doc(description: "Ethiopia") + FK @doc(description: "Falkland Islands") + FO @doc(description: "Faroe Islands") + FJ @doc(description: "Fiji") + FI @doc(description: "Finland") + FR @doc(description: "France") + GF @doc(description: "French Guiana") + PF @doc(description: "French Polynesia") + TF @doc(description: "French Southern Territories") + GA @doc(description: "Gabon") + GM @doc(description: "Gambia") + GE @doc(description: "Georgia") + DE @doc(description: "Germany") + GH @doc(description: "Ghana") + GI @doc(description: "Gibraltar") + GR @doc(description: "Greece") + GL @doc(description: "Greenland") + GD @doc(description: "Grenada") + GP @doc(description: "Guadeloupe") + GU @doc(description: "Guam") + GT @doc(description: "Guatemala") + GG @doc(description: "Guernsey") + GN @doc(description: "Guinea") + GW @doc(description: "Guinea-Bissau") + GY @doc(description: "Guyana") + HT @doc(description: "Haiti") + HM @doc(description: "Heard & McDonald Islands") + HN @doc(description: "Honduras") + HK @doc(description: "Hong Kong SAR China") + HU @doc(description: "Hungary") + IS @doc(description: "Iceland") + IN @doc(description: "India") + ID @doc(description: "Indonesia") + IR @doc(description: "Iran") + IQ @doc(description: "Iraq") + IE @doc(description: "Ireland") + IM @doc(description: "Isle of Man") + IL @doc(description: "Israel") + IT @doc(description: "Italy") + JM @doc(description: "Jamaica") + JP @doc(description: "Japan") + JE @doc(description: "Jersey") + JO @doc(description: "Jordan") + KZ @doc(description: "Kazakhstan") + KE @doc(description: "Kenya") + KI @doc(description: "Kiribati") + KW @doc(description: "Kuwait") + KG @doc(description: "Kyrgyzstan") + LA @doc(description: "Laos") + LV @doc(description: "Latvia") + LB @doc(description: "Lebanon") + LS @doc(description: "Lesotho") + LR @doc(description: "Liberia") + LY @doc(description: "Libya") + LI @doc(description: "Liechtenstein") + LT @doc(description: "Lithuania") + LU @doc(description: "Luxembourg") + MO @doc(description: "Macau SAR China") + MK @doc(description: "Macedonia") + MG @doc(description: "Madagascar") + MW @doc(description: "Malawi") + MY @doc(description: "Malaysia") + MV @doc(description: "Maldives") + ML @doc(description: "Mali") + MT @doc(description: "Malta") + MH @doc(description: "Marshall Islands") + MQ @doc(description: "Martinique") + MR @doc(description: "Mauritania") + MU @doc(description: "Mauritius") + YT @doc(description: "Mayotte") + MX @doc(description: "Mexico") + FM @doc(description: "Micronesia") + MD @doc(description: "Moldova") + MC @doc(description: "Monaco") + MN @doc(description: "Mongolia") + ME @doc(description: "Montenegro") + MS @doc(description: "Montserrat") + MA @doc(description: "Morocco") + MZ @doc(description: "Mozambique") + MM @doc(description: "Myanmar (Burma)") + NA @doc(description: "Namibia") + NR @doc(description: "Nauru") + NP @doc(description: "Nepal") + NL @doc(description: "Netherlands") + AN @doc(description: "Netherlands Antilles") + NC @doc(description: "New Caledonia") + NZ @doc(description: "New Zealand") + NI @doc(description: "Nicaragua") + NE @doc(description: "Niger") + NG @doc(description: "Nigeria") + NU @doc(description: "Niue") + NF @doc(description: "Norfolk Island") + MP @doc(description: "Northern Mariana Islands") + KP @doc(description: "North Korea") + NO @doc(description: "Norway") + OM @doc(description: "Oman") + PK @doc(description: "Pakistan") + PW @doc(description: "Palau") + PS @doc(description: "Palestinian Territories") + PA @doc(description: "Panama") + PG @doc(description: "Papua New Guinea") + PY @doc(description: "Paraguay") + PE @doc(description: "Peru") + PH @doc(description: "Philippines") + PN @doc(description: "Pitcairn Islands") + PL @doc(description: "Poland") + PT @doc(description: "Portugal") + QA @doc(description: "Qatar") + RE @doc(description: "Réunion") + RO @doc(description: "Romania") + RU @doc(description: "Russia") + RW @doc(description: "Rwanda") + WS @doc(description: "Samoa") + SM @doc(description: "San Marino") + ST @doc(description: "São Tomé & Príncipe") + SA @doc(description: "Saudi Arabia") + SN @doc(description: "Senegal") + RS @doc(description: "Serbia") + SC @doc(description: "Seychelles") + SL @doc(description: "Sierra Leone") + SG @doc(description: "Singapore") + SK @doc(description: "Slovakia") + SI @doc(description: "Slovenia") + SB @doc(description: "Solomon Islands") + SO @doc(description: "Somalia") + ZA @doc(description: "South Africa") + GS @doc(description: "South Georgia & South Sandwich Islands") + KR @doc(description: "South Korea") + ES @doc(description: "Spain") + LK @doc(description: "Sri Lanka") + BL @doc(description: "St. Barthélemy") + SH @doc(description: "St. Helena") + KN @doc(description: "St. Kitts & Nevis") + LC @doc(description: "St. Lucia") + MF @doc(description: "St. Martin") + PM @doc(description: "St. Pierre & Miquelon") + VC @doc(description: "St. Vincent & Grenadines") + SD @doc(description: "Sudan") + SR @doc(description: "Suriname") + SJ @doc(description: "Svalbard & Jan Mayen") + SZ @doc(description: "Swaziland") + SE @doc(description: "Sweden") + CH @doc(description: "Switzerland") + SY @doc(description: "Syria") + TW @doc(description: "Taiwan") + TJ @doc(description: "Tajikistan") + TZ @doc(description: "Tanzania") + TH @doc(description: "Thailand") + TL @doc(description: "Timor-Leste") + TG @doc(description: "Togo") + TK @doc(description: "Tokelau") + TO @doc(description: "Tonga") + TT @doc(description: "Trinidad & Tobago") + TN @doc(description: "Tunisia") + TR @doc(description: "Turkey") + TM @doc(description: "Turkmenistan") + TC @doc(description: "Turks & Caicos Islands") + TV @doc(description: "Tuvalu") + UG @doc(description: "Uganda") + UA @doc(description: "Ukraine") + AE @doc(description: "United Arab Emirates") + GB @doc(description: "United Kingdom") + US @doc(description: "United States") + UY @doc(description: "Uruguay") + UM @doc(description: "U.S. Outlying Islands") + VI @doc(description: "U.S. Virgin Islands") + UZ @doc(description: "Uzbekistan") + VU @doc(description: "Vanuatu") + VA @doc(description: "Vatican City") + VE @doc(description: "Venezuela") + VN @doc(description: "Vietnam") + WF @doc(description: "Wallis & Futuna") + EH @doc(description: "Western Sahara") + YE @doc(description: "Yemen") + ZM @doc(description: "Zambia") + ZW @doc(description: "Zimbabwe") +} \ No newline at end of file From d6cfdb06e806f05554f8fa5e44fd08319ae94283 Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 21 Aug 2020 15:17:31 -0500 Subject: [PATCH 271/479] Add "uid" and deprecate "id" in "CartItemInterface" --- design-documents/graph-ql/coverage/quote.graphqls | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls index cf311354d..5a4977132 100644 --- a/design-documents/graph-ql/coverage/quote.graphqls +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -328,7 +328,8 @@ type VirtualCartItem implements CartItemInterface @doc(description: "Virtual Car } interface CartItemInterface @typeResolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemTypeResolver") { - id: String! + id: String! @deprecated(reason: "Use CartItemInterface.uid instead") + uid: ID! @doc(description: "Unique identifier for a Cart Item") quantity: Float! prices: CartItemPrices @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemPrices") product: ProductInterface! From 12a6c102bc387ff6d008da95deceacbbafe957ee Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 21 Aug 2020 15:03:37 -0500 Subject: [PATCH 272/479] Add "cart_item_uid" and deprecate "cart_item_id" in "CartItemUpdateInput" --- design-documents/graph-ql/coverage/quote.graphqls | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls index 5a4977132..8c5821ff9 100644 --- a/design-documents/graph-ql/coverage/quote.graphqls +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -73,7 +73,10 @@ input UpdateCartItemsInput { } input CartItemUpdateInput { - cart_item_id: Int! + # Implementation Note: The resolver should accept either `cart_item_id` or `cart_item_uid`, + # but _must_ return an error when both fields are provided in a request + cart_item_id: Int! @deprecated(reason: "Use `CartItemUpdateInput.cart_item_uid` instead") + cart_item_uid: ID! @doc(description: "Unique Identifier from objects implementing `CartItemInterface`") quantity: Float customizable_options: [CustomizableOptionInput!] } From 838e4188f7c13ecd9e029178768a42bbb1aa3584 Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 21 Aug 2020 15:05:58 -0500 Subject: [PATCH 273/479] Add "cart_item_uid" and deprecate "cart_item_id" in "RemoveItemFromCartInput" --- design-documents/graph-ql/coverage/quote.graphqls | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls index 8c5821ff9..5e7890d16 100644 --- a/design-documents/graph-ql/coverage/quote.graphqls +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -83,7 +83,10 @@ input CartItemUpdateInput { input RemoveItemFromCartInput { cart_id: String! - cart_item_id: Int! + # Implementation Note: The resolver should accept either `cart_item_id` or `cart_item_uid`, + # but _must_ return an error when both fields are provided in a request + cart_item_id: Int! @deprecated(reason: "Use `RemoveItemFromCartInput.cart_item_uid` instead") + cart_item_uid: ID! @doc(description: "Unique Identifier from objects implementing `CartItemInterface`") } input SetShippingAddressesOnCartInput { From 970fc37c5c8f6c7a67aeba6e786a294ff2039049 Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 21 Aug 2020 15:10:43 -0500 Subject: [PATCH 274/479] Fix incorrect deprecation (wrong directive) for "CartItemQuantity" --- design-documents/graph-ql/coverage/quote.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls index 5e7890d16..4e31845ad 100644 --- a/design-documents/graph-ql/coverage/quote.graphqls +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -244,7 +244,7 @@ type BillingCartAddress implements CartAddressInterface { customer_notes: String @deprecated (reason: "The field is used only in shipping address") } -type CartItemQuantity @doc(description:"Deprecated: `cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`") { +type CartItemQuantity @deprecated(description:"Deprecated: `cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`") { cart_item_id: Int! @deprecated(reason: "`cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`") quantity: Float! @deprecated(reason: "`cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`") } From 7b551cae979a59e2669817b140926b336e075764 Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 21 Aug 2020 15:23:44 -0500 Subject: [PATCH 275/479] Add "uid" and deprecate "id" in "CategoryInterface" --- design-documents/graph-ql/coverage/catalog.graphqls | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog.graphqls b/design-documents/graph-ql/coverage/catalog.graphqls index f510637f4..c1377905c 100644 --- a/design-documents/graph-ql/coverage/catalog.graphqls +++ b/design-documents/graph-ql/coverage/catalog.graphqls @@ -239,7 +239,8 @@ interface CustomizableProductInterface @typeResolver(class: "Magento\\CatalogGra } interface CategoryInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\\CategoryInterfaceTypeResolver") @doc(description: "CategoryInterface contains the full set of attributes that can be returned in a category search.") { - id: Int @doc(description: "An ID that uniquely identifies the category.") + id: Int @deprecated(reason: "Use `CategoryInterface.uid instead") + uid: ID! @doc(description: "Unique identifier for a Category") description: String @doc(description: "An optional description of the category.") @resolver(class: "\\Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\CategoryHtmlAttribute") name: String @doc(description: "The display name of the category.") path: String @doc(description: "Category Path.") From 7a110931234fa7133a66958e62ca99707d29e234 Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 21 Aug 2020 15:29:01 -0500 Subject: [PATCH 276/479] Add "categoryInterfaceUID" argument and deprecate "id" argument in "Query.category" --- design-documents/graph-ql/coverage/catalog.graphqls | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog.graphqls b/design-documents/graph-ql/coverage/catalog.graphqls index c1377905c..901d8bdcd 100644 --- a/design-documents/graph-ql/coverage/catalog.graphqls +++ b/design-documents/graph-ql/coverage/catalog.graphqls @@ -11,7 +11,10 @@ type Query { ): Products @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Products") @doc(description: "The products query searches for products that match the criteria specified in the search and filter attributes.") @cache(cacheIdentity: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\Identity") category ( - id: Int @doc(description: "Id of the category.") + # Implementation Note: The resolver should accept either `id` or `categoryInterfaceUID`, + # but _must_ return an error when both fields are provided in a request + id: Int @deprecated(reason: "Use the `categoryInterfaceUID` argument instead") + categoryInterfaceUID: ID @doc(description: "Unique identifier from objects implementing `CategoryInterface`") ): CategoryTree @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\CategoryTree") @doc(description: "The category query searches for categories that match the criteria specified in the search and filter attributes.") @deprecated(reason: "Use 'categoryList' query instead of 'category' query") @cache(cacheIdentity: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\CategoryTreeIdentity") categoryList( From 6f2c6937d091308a4f7258576d21986fda6291f9 Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 21 Aug 2020 15:32:21 -0500 Subject: [PATCH 277/479] Add "uid" and deprecate "id" in "ProductInterface" --- design-documents/graph-ql/coverage/catalog.graphqls | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog.graphqls b/design-documents/graph-ql/coverage/catalog.graphqls index 901d8bdcd..a0b6c2367 100644 --- a/design-documents/graph-ql/coverage/catalog.graphqls +++ b/design-documents/graph-ql/coverage/catalog.graphqls @@ -86,7 +86,8 @@ interface ProductLinksInterface @typeResolver(class: "Magento\\CatalogGraphQl\\M } interface ProductInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\\ProductInterfaceTypeResolverComposite") @doc(description: "The ProductInterface contains attributes that are common to all types of products. Note that descriptions may not be available for custom and EAV attributes.") { - id: Int @doc(description: "The ID number assigned to the product.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\EntityIdToId") + id: Int @deprecated(description: "Use the `uid` field instead") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\EntityIdToId") + uid: ID! @doc(description: "Unique identifier for objects implementing `ProductInterface`") name: String @doc(description: "The product name. Customers use this name to identify the product.") sku: String @doc(description: "A number or code assigned to a product to identify the product, options, price, and manufacturer.") description: ComplexTextValue @doc(description: "Detailed information about the product. The value can include simple HTML tags.") @resolver(class: "\\Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\ProductComplexTextAttribute") From 00cbb7161a4126bea6610a0e6d47355dcd4bfdfe Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 21 Aug 2020 15:35:00 -0500 Subject: [PATCH 278/479] Add "category_interface_uid" and deprecate "category_id" in "Breadcrumb" --- design-documents/graph-ql/coverage/catalog.graphqls | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog.graphqls b/design-documents/graph-ql/coverage/catalog.graphqls index a0b6c2367..63174c147 100644 --- a/design-documents/graph-ql/coverage/catalog.graphqls +++ b/design-documents/graph-ql/coverage/catalog.graphqls @@ -267,7 +267,8 @@ interface CategoryInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model } type Breadcrumb @doc(description: "Breadcrumb item."){ - category_id: Int @doc(description: "Category ID.") + category_id: Int @deprecated(reason: "Use the `category_interface_uid` field instead") + category_interface_uid: ID! @doc(description: "Unique identifier from objects implementing CategoryInterface") category_name: String @doc(description: "Category name.") category_level: Int @doc(description: "Category level.") category_url_key: String @doc(description: "Category URL key.") From 9846887a5263a58ebf9ce20f4d74e582192365e3 Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 21 Aug 2020 15:38:26 -0500 Subject: [PATCH 279/479] Add "uid" field to "Customer" type --- design-documents/graph-ql/coverage/customer.graphqls | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer.graphqls b/design-documents/graph-ql/coverage/customer.graphqls index 63c5bc6a3..959c93483 100644 --- a/design-documents/graph-ql/coverage/customer.graphqls +++ b/design-documents/graph-ql/coverage/customer.graphqls @@ -131,7 +131,8 @@ type Customer @doc(description: "Customer defines the customer name and address dob: String @doc(description: "The customer's date of birth") @deprecated(reason: "Use `date_of_birth` instead") date_of_birth: String @doc(description: "The customer's date of birth") taxvat: String @doc(description: "The customer's Value-added tax (VAT) number (for corporate customers)") - id: Int @doc(description: "The ID assigned to the customer") @deprecated(reason: "id is not needed as part of Customer because on server side it can be identified based on customer token used for authentication. There is no need to know customer ID on the client side.") + id: Int @deprecated(reason: "id is not needed as part of Customer because on server side it can be identified based on customer token used for authentication. There is no need to know customer ID on the client side.") + uid: ID! @doc(description: "Unique identifier for a Customer") is_subscribed: Boolean @doc(description: "Indicates whether the customer is subscribed to the company's newsletter") @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\IsSubscribed") addresses: [CustomerAddress] @doc(description: "An array containing the customer's shipping and billing addresses") @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CustomerAddresses") gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2)") From 37a84caeaca4948f32cbe780b753aa37443304ae Mon Sep 17 00:00:00 2001 From: Rakesh Jesadiya Date: Sun, 23 Aug 2020 14:08:52 +0530 Subject: [PATCH 280/479] close negotiable quote status change --- design-documents/graph-ql/coverage/negotiableQuotes.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls index 0894f5106..b9b851b16 100644 --- a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls @@ -111,7 +111,7 @@ input CloseNegotiableQuotesInput { } type CloseNegotiableQuotesOutput { - closed_quotes: [NegotiableQuote]! @doc(description: "Quotes that were just closed") + closed_quotes: [NegotiableQuote!] @doc(description: "Quotes that were just closed") negotiable_quotes( filter: NegotiableQuoteFilterInput, pageSize: Int = 20, From 7dbbf50c2805bd25ad758035babe12d8f4082884 Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Mon, 24 Aug 2020 12:50:30 -0500 Subject: [PATCH 281/479] Update GraphQL Object ID Guidance document to use new "uid" --- design-documents/graph-ql/id-fields-object-types.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/id-fields-object-types.md b/design-documents/graph-ql/id-fields-object-types.md index 82f8b6927..a4097fd32 100644 --- a/design-documents/graph-ql/id-fields-object-types.md +++ b/design-documents/graph-ql/id-fields-object-types.md @@ -8,8 +8,9 @@ When a GraphQL Object Type is used to represent an entity that can be referenced - Use the `ID` scalar type - Make the `ID` field non-nullable (syntax: `ID!`) -- Use the field name `id` or `_id` - - Most GraphQL client libs automatically use this field for caching. Any other field name will require manual caching logic on the client +- Use the field name `uid` + - [Historical context for the field name `uid`](id-improvement-plan.md) + - Most GraphQL client libs will need to be made aware of this field name for caching - https://www.apollographql.com/docs/react/caching/cache-configuration/#assigning-unique-identifiers - https://formidable.com/open-source/urql/docs/graphcache/normalized-caching/#key-generation - Include an ID field anytime an Object Type _could_ have an ID field @@ -18,7 +19,7 @@ When a GraphQL Object Type is used to represent an entity that can be referenced - Include info in the client-facing description describing how the field is encoded/decoded (should be opaque) - Example: The client shouldn't know if an `ID` is a base64-encoded integer - Use `String` or `Int` type -- Use duplicate IDs across a concrete type. In other words, if the client wants to produce a cache key, the concatenation of a `__typename` + `id` field should _always_ be unique +- Use duplicate IDs across a concrete type. In other words, if the client wants to produce a cache key, the concatenation of a `__typename` + `uid` field should _always_ be unique ## Examples where an ID is not helpful From 0e26c98f79c108359c3c2059b1faffe1bb6754da Mon Sep 17 00:00:00 2001 From: Rakesh Jesadiya Date: Tue, 25 Aug 2020 19:34:19 +0530 Subject: [PATCH 282/479] negotiable-quote-modify --- .../graph-ql/coverage/negotiableQuotes.graphqls | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls index b9b851b16..192c59271 100644 --- a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls @@ -99,11 +99,7 @@ type DeleteNegotiableQuotesOutput { # Implementation Note: We don't make the deleted quotes accessible # because "deleted" means they're hidden from the storefront UI. They will # still be visible (and labeled as deleted) for a Seller in the admin - negotiable_quotes( - filter: NegotiableQuoteFilterInput, - pageSize: Int = 20, - currentPage: Int = 1 - ): NegotiableQuotesOutput @doc(description: "List of negotiable quotes available to customer") + quote: Boolean } input CloseNegotiableQuotesInput { @@ -112,11 +108,6 @@ input CloseNegotiableQuotesInput { type CloseNegotiableQuotesOutput { closed_quotes: [NegotiableQuote!] @doc(description: "Quotes that were just closed") - negotiable_quotes( - filter: NegotiableQuoteFilterInput, - pageSize: Int = 20, - currentPage: Int = 1 - ): NegotiableQuotesOutput @doc(description: A (optionally filtered) list of Negotiable Quotes viewable by the logged-in customer") } input RemoveNegotiableQuoteItemsInput { From a855d7eff180ba2be223fe715c92512931bc036d Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Tue, 25 Aug 2020 20:19:14 -0500 Subject: [PATCH 283/479] magento2/issues/29251 configurable options corrections --- .../configurable-options-selection.graphqls | 5 ++-- .../catalog/configurable-options-selection.md | 24 +++++++++---------- 2 files changed, 13 insertions(+), 16 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index 2131630b7..01403ec31 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -10,12 +10,11 @@ type ConfigurableOptionsSelectionMetadata @doc(description: "Metadata correspond } type ConfigurableOptionAvailableForSelection @doc(description: "Configurable option available for further selection based on current selection.") { - available_value_ids: [ID!]! @doc(description: "Configurable option values available for further selection.") + option_value_uids: [ID!]! @doc(description: "Configurable option values available for further selection.") attribute_code: String! @doc(description: "Attribute code that uniquely identifies configurable option.") } # Configurable option value type has to be extended to include ID which can be used to uniquely identify the option value across the system. This is consistent with proposal of single mutation for add-to-cart type ConfigurableProductOptionsValues { - id: ID! - is_available_for_selection: Boolean! + uid: ID! } diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md index 74b1c5880..43ca99a18 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md @@ -17,8 +17,7 @@ User navigates to the configurable product page. Option values available for sel attribute_code label values { - id - is_available_for_selection + uid value_index label swatch_data { @@ -29,8 +28,8 @@ User navigates to the configurable product page. Option values available for sel } configurable_options_selection_metadata { options_available_for_selection { + option_value_uids attribute_code - available_value_ids } media_gallery { url @@ -55,11 +54,11 @@ The images and videos relevant for the selection are also updated. items { ... on ConfigurableProduct { configurable_options_selection_metadata( - selectedConfigurableOptionValues: ["hash from selected option value"] + selectedConfigurableOptionValues: ["hash from selected option value compatible with single mutation"] ) { options_available_for_selection { + option_value_uids attribute_code - available_value_ids } media_gallery { url @@ -102,8 +101,7 @@ Then the product data along with available selections can be requested in a sing attribute_code label values { - id - is_available_for_selection + uid value_index label swatch_data { @@ -113,11 +111,11 @@ Then the product data along with available selections can be requested in a sing } } configurable_options_selection_metadata( - selectedConfigurableOptionValues: ["hash from selected option value", "hash from another option value"] + selectedConfigurableOptionValues: ["hash from selected option value compatible with single mutation", "hash from another option value compatible with single mutation"] ) { options_available_for_selection { + option_value_uids attribute_code - available_value_ids } media_gallery { url @@ -145,11 +143,11 @@ After the user makes final selection, the corresponding simple product data beco items { ... on ConfigurableProduct { configurable_options_selection_metadata( - selectedConfigurableOptionValues: ["hash from selected option value", "hash from another option value"] + selectedConfigurableOptionValues: ["hash from selected option value compatible with single mutation", "hash from another option value compatible with single mutation"] ) { options_available_for_selection { + option_value_uids attribute_code - available_value_ids } media_gallery { url @@ -181,11 +179,11 @@ In case when the facet filter was used on the category page, for example to sear sku ... on ConfigurableProduct { configurable_options_selection_metadata( - selectedConfigurableOptionValues: ["hash from selected red color option"] + selectedConfigurableOptionValues: ["hash from selected red color option compatible with single mutation"] ) { options_available_for_selection { + option_value_uids attribute_code - available_value_ids } media_gallery { url From 6c7013bf18320c01d70e498c542cd67bdd87541f Mon Sep 17 00:00:00 2001 From: OMelnyk Date: Thu, 27 Aug 2020 10:53:19 +0300 Subject: [PATCH 284/479] magento2/issues/29479 Returns : graphql implementation --- design-documents/graph-ql/coverage/returns.graphqls | 2 ++ design-documents/graph-ql/coverage/returns.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/design-documents/graph-ql/coverage/returns.graphqls b/design-documents/graph-ql/coverage/returns.graphqls index 5e5f1d690..35b030afc 100644 --- a/design-documents/graph-ql/coverage/returns.graphqls +++ b/design-documents/graph-ql/coverage/returns.graphqls @@ -13,6 +13,8 @@ type Mutation { } input RequestReturnInput { + order_id: ID! + customer_custom_email: String! items: [RequestReturnItemInput!]! comment_text: String } diff --git a/design-documents/graph-ql/coverage/returns.md b/design-documents/graph-ql/coverage/returns.md index 98e2a0c45..79ad46068 100644 --- a/design-documents/graph-ql/coverage/returns.md +++ b/design-documents/graph-ql/coverage/returns.md @@ -211,6 +211,8 @@ Existing schema of `Attribute` and `AttributeOption` must be extended to provide mutation { requestReturn( input: { + order_id: 12345 + customer_custom_email: "returnemail@magento.com" items: [ { order_item_id: "absdfj2l3415", From 2fe91b7373900defa955cd069b8c89a328da2ce3 Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Thu, 27 Aug 2020 11:56:17 -0500 Subject: [PATCH 285/479] categoryInterfaceUID arg changed to uid on Query.category, based on feedback --- design-documents/graph-ql/coverage/catalog.graphqls | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog.graphqls b/design-documents/graph-ql/coverage/catalog.graphqls index 63174c147..562444582 100644 --- a/design-documents/graph-ql/coverage/catalog.graphqls +++ b/design-documents/graph-ql/coverage/catalog.graphqls @@ -11,10 +11,11 @@ type Query { ): Products @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Products") @doc(description: "The products query searches for products that match the criteria specified in the search and filter attributes.") @cache(cacheIdentity: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product\\Identity") category ( - # Implementation Note: The resolver should accept either `id` or `categoryInterfaceUID`, - # but _must_ return an error when both fields are provided in a request - id: Int @deprecated(reason: "Use the `categoryInterfaceUID` argument instead") - categoryInterfaceUID: ID @doc(description: "Unique identifier from objects implementing `CategoryInterface`") + # Implementation Note: For back-compat reasons, this query must: + # - Accept _either_ `uid` or `id` + # - Set a field error when both `uid` or `id` are used + id: Int @deprecated(reason: "Use the `uid` argument instead") + uid: ID @doc(description: "Unique identifier from objects implementing `CategoryInterface`") ): CategoryTree @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\CategoryTree") @doc(description: "The category query searches for categories that match the criteria specified in the search and filter attributes.") @deprecated(reason: "Use 'categoryList' query instead of 'category' query") @cache(cacheIdentity: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\CategoryTreeIdentity") categoryList( From a66f16687c053f43926be93bfed9a288dcf4c13c Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Thu, 27 Aug 2020 12:09:47 -0500 Subject: [PATCH 286/479] Fix bug where non-nullable requirement would fail query at validation time (whoops) --- .../graph-ql/coverage/quote.graphqls | 36 ++++++++++++++----- 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls index 4e31845ad..a76da9fb7 100644 --- a/design-documents/graph-ql/coverage/quote.graphqls +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -73,20 +73,40 @@ input UpdateCartItemsInput { } input CartItemUpdateInput { - # Implementation Note: The resolver should accept either `cart_item_id` or `cart_item_uid`, - # but _must_ return an error when both fields are provided in a request - cart_item_id: Int! @deprecated(reason: "Use `CartItemUpdateInput.cart_item_uid` instead") - cart_item_uid: ID! @doc(description: "Unique Identifier from objects implementing `CartItemInterface`") + # Implementation Note: For back-compat reasons, the following rules should be applied to + # a resolver handling `CartItemUpdateInput` (see https://github.com/magento/architecture/pull/424) + # + # 1. Either `cart_item_id` or `cart_item_uid` _must_ be provided. If both are absent, raise + # a field error advising the client that `cart_item_uid` is required + # 2. If _both_ `cart_item_id` and `cart_item_uid` are provided, raise a field error advising + # the client to only use `cart_item_uid` + # + # GraphQL does not provide a way for an `input` field to allow use of only 1 field or another, + # which is why we're enforcing non-nullability in the resolver, instead of via the schema language. + # When `cart_item_id` is removed in a future version, we can mark `cart_item_uid` as non-nullable + # with minimal disruption + cart_item_id: Int @deprecated(reason: "Use the `cart_item_uid` field instead") + cart_item_uid: ID @doc(description: "Required field. Unique Identifier from objects implementing `CartItemInterface`") quantity: Float customizable_options: [CustomizableOptionInput!] } input RemoveItemFromCartInput { cart_id: String! - # Implementation Note: The resolver should accept either `cart_item_id` or `cart_item_uid`, - # but _must_ return an error when both fields are provided in a request - cart_item_id: Int! @deprecated(reason: "Use `RemoveItemFromCartInput.cart_item_uid` instead") - cart_item_uid: ID! @doc(description: "Unique Identifier from objects implementing `CartItemInterface`") + # Implementation Note: For back-compat reasons, the following rules should be applied to + # a resolver handling `RemoveItemFromCartInput` (see https://github.com/magento/architecture/pull/424) + # + # 1. Either `cart_item_id` or `cart_item_uid` _must_ be provided. If both are absent, raise + # a field error advising the client that `cart_item_uid` is required + # 2. If _both_ `cart_item_id` and `cart_item_uid` are provided, raise a field error advising + # the client to only use `cart_item_uid` + # + # GraphQL does not provide a way for an `input` field to allow use of only 1 field or another, + # which is why we're enforcing non-nullability in the resolver, instead of via the schema language. + # When `cart_item_id` is removed in a future version, we can mark `cart_item_uid` as non-nullable + # with minimal disruption + cart_item_id: Int @deprecated(reason: "Use the `cart_item_uid` field instead") + cart_item_uid: ID @doc(description: "Required field. Unique Identifier from objects implementing `CartItemInterface`") } input SetShippingAddressesOnCartInput { From e74ffbc0347096e0d532343066407b8635888d4e Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Thu, 27 Aug 2020 14:13:49 -0500 Subject: [PATCH 287/479] Document existing GraphQL naming conventions --- .../graph-ql/naming-conventions.md | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 design-documents/graph-ql/naming-conventions.md diff --git a/design-documents/graph-ql/naming-conventions.md b/design-documents/graph-ql/naming-conventions.md new file mode 100644 index 000000000..eed50237d --- /dev/null +++ b/design-documents/graph-ql/naming-conventions.md @@ -0,0 +1,44 @@ +# GraphQL Naming Conventions + +The following naming guidelines should be followed when adding or modifying schemas in the Magento platform. + +These guidelines are based on the conventions already used within the schema. Because of this, there will be places where the style diverges from more common styles found in the GraphQL community. + +## Object/Interface Types + +Object/Interface names should always be _PascalCase_. + +```graphql +# PascalCase +type TwoWords {} +interface TwoWords {} +``` + +## Object/Input Field Names + +Object/Input field names should always be _snake_case_. + +```graphql +type Query { + # snake_case + two_words: String +} + +input Data { + # snake_case + two_words: String +} +``` + +## Arguments + +Argument names should always be _camelCase_. + +```graphql +type Query { + example( + # camelCase + twoWords: String + ): String +} +``` \ No newline at end of file From a091ceba4eddbc079bbec1badfcdb77977be3524 Mon Sep 17 00:00:00 2001 From: Igor Melnikov Date: Thu, 27 Aug 2020 15:14:42 -0500 Subject: [PATCH 288/479] Apply suggestions from code review Co-authored-by: Andrew Levine --- .../graph-ql/coverage/b2b/purchase-order.graphqls | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index b8ab3b243..f12d45816 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -38,7 +38,7 @@ input DeletePurchaseOrderApprovalRuleInput { input PurchaseOrderApprovalRuleInput { name: String! @doc(description: "Purchase order approval rule name") description: String @doc(description: "Purchase order approval rule description") - applies_to: [ID]! @doc(description: "A list of B2B user roles to which this purchase order approval rule should be applied. In case when empty array is provided, the rule will be applied to all user roles in the system, including those created in the future") + applies_to: [ID!]! @doc(description: "A list of B2B user roles to which this purchase order approval rule should be applied. In case when empty array is provided, the rule will be applied to all user roles in the system, including those created in the future") type: PurchaseOrderApprovalRuleType! @doc(description: "Purchase order approval rule type") condition: CreatePurchaseOrderApprovalRuleConditionInput! @doc(description: "Purchase order approval rule condition") requires_approval_from: [ID!]! @doc(description: "A list of B2B user roles that can approve this purchase order approval rule") @@ -214,7 +214,7 @@ type PurchaseOrderComments { type PurchaseOrderComment { uid: ID! @doc(description: "Unique identifier of the comment.") - timestamp: String! @doc(description: "The date and time when the comment was created") + created_at: String! @doc(description: "The date and time when the comment was created") author: PurchaseOrderCommentAuthor! @doc(description: "The name of the user who left the comment") text: String! @doc(description: "The text of the comment") } @@ -232,7 +232,7 @@ type PurchaseOrderHistoryLog { type PurchaseOrderHistoryItem { uid: ID! @doc(description: "Unique identifier of the purchase rder history item.") - timestamp: String! @doc(description: "The date and time when the event happened.") + created_at: String! @doc(description: "The date and time when the event happened.") description: String! @doc(description: "Description of the event.") } From a3627dd9c856ff2fbf341b74dcfd94e22ebe59d7 Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Thu, 27 Aug 2020 15:16:15 -0500 Subject: [PATCH 289/479] Apply suggestions from code review --- .../graph-ql/coverage/b2b/purchase-order.graphqls | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls index b8ab3b243..f6f8c826f 100644 --- a/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls +++ b/design-documents/graph-ql/coverage/b2b/purchase-order.graphqls @@ -1,5 +1,6 @@ type Mutation { addPurchaseOrderComment(input: AddPurchaseOrderCommentInput!): AddPurchaseOrderCommentOutput @doc(description: "Add a comment to an existing purchase order") + validatePurchaseOrder(input: ValidatePurchaseOrderInput!): ValidatePurchaseOrderOutput @doc(description: "Validate purchase order") approvePurchaseOrder(input: ApprovePurchaseOrderInput!): ApprovePurchaseOrderOutput @doc(description: "Approve purchase order") cancelPurchaseOrder(input: CancelPurchaseOrderInput!): CancelPurchaseOrderOutput @doc(description: "Cancel purchase order") rejectPurchaseOrder(input: RejectPurchaseOrderInput!): RejectPurchaseOrderOutput @doc(description: "Reject purchase order") @@ -40,6 +41,7 @@ input PurchaseOrderApprovalRuleInput { description: String @doc(description: "Purchase order approval rule description") applies_to: [ID]! @doc(description: "A list of B2B user roles to which this purchase order approval rule should be applied. In case when empty array is provided, the rule will be applied to all user roles in the system, including those created in the future") type: PurchaseOrderApprovalRuleType! @doc(description: "Purchase order approval rule type") + status: PurchaseOrderApprovalRuleStatus! @doc(description: "Purchase order approval rule status") condition: CreatePurchaseOrderApprovalRuleConditionInput! @doc(description: "Purchase order approval rule condition") requires_approval_from: [ID!]! @doc(description: "A list of B2B user roles that can approve this purchase order approval rule") } @@ -55,6 +57,14 @@ input CreatePurchaseOrderApprovalRuleConditionAmountInput { currency: CurrencyEnum! @doc(description: "Purchase order approval rule condition ammount currency") } +input ValidatePurchaseOrderInput { + purchase_order_uid: ID! +} + +type ValidatePurchaseOrderOutput { + purchase_order: PurchaseOrder +} + input ApprovePurchaseOrderInput { purchase_order_uid: ID! } @@ -186,6 +196,7 @@ type PurchaseOrder { enum PurchaseOrderAction { REJECT CANCEL + VALIDATE APPROVE } @@ -239,7 +250,7 @@ type PurchaseOrderHistoryItem { type PurchaseOrderItems { items: [PurchaseOrderItemInterface]! page_info: SearchResultPageInfo - total_count: Int + total_count: Int! } type PurchaseOrderTotal @doc(description: "Contains details about the sales total amounts used to calculate the final price") { @@ -258,7 +269,6 @@ interface PurchaseOrderItemInterface @doc(description: "Purchase order item deta product_name: String @doc(description: "The name of the base product") product_sku: String! @doc(description: "The SKU of the base product") product_url_key: String @doc(description: "URL key of the base product") - product_type: String @doc(description: "The type of product, such as simple, configurable, or bundle") product_sale_price: Money! @doc(description: "The sale price of the base product, including selected options") discounts: [Discount] @doc(description: "The final discount information for the product") selected_options: [PurchaseOrderItemOption] @doc(description: "The selected options for the base product, such as color or size") @@ -279,6 +289,7 @@ type PurchaseOrderItemOption @doc(description: "Represents purcahse order item o uid: ID! @doc(description: "The unique ID of the option") label: String! @doc(description: "The label of the option") value: String! @doc(description: "The value of the option") + sort_order: Int! @doc(description: "The sort order of the option") } enum PurchaseOrderStatus { From e2927742eb0aabf2de4ff5566e0fce7586ffc5b8 Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Thu, 27 Aug 2020 16:19:42 -0500 Subject: [PATCH 290/479] Apply suggestions from code review --- .../coverage/catalog/configurable-options-selection.graphqls | 1 + 1 file changed, 1 insertion(+) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index 01403ec31..b77985033 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -17,4 +17,5 @@ type ConfigurableOptionAvailableForSelection @doc(description: "Configurable opt # Configurable option value type has to be extended to include ID which can be used to uniquely identify the option value across the system. This is consistent with proposal of single mutation for add-to-cart type ConfigurableProductOptionsValues { uid: ID! + is_available_for_selection: Boolean! } From faf6ae3001a2ac81f5ddddbba8b3fa56f6b90f5c Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Thu, 27 Aug 2020 16:21:53 -0500 Subject: [PATCH 291/479] Apply suggestions from code review --- .../coverage/catalog/configurable-options-selection.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md index 43ca99a18..ca2aa37f0 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md @@ -18,6 +18,7 @@ User navigates to the configurable product page. Option values available for sel label values { uid + is_available_for_selection value_index label swatch_data { @@ -101,7 +102,8 @@ Then the product data along with available selections can be requested in a sing attribute_code label values { - uid + uid + is_available_for_selection value_index label swatch_data { From 3e1031f2b58cb5641b622db192549003cf0bde4a Mon Sep 17 00:00:00 2001 From: OMelnyk Date: Fri, 28 Aug 2020 10:51:49 +0300 Subject: [PATCH 292/479] magento2/issues/29479 Returns : graphql implementation - implemented requested changes --- design-documents/graph-ql/coverage/returns.graphqls | 2 +- design-documents/graph-ql/coverage/returns.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/returns.graphqls b/design-documents/graph-ql/coverage/returns.graphqls index 35b030afc..97957e6c0 100644 --- a/design-documents/graph-ql/coverage/returns.graphqls +++ b/design-documents/graph-ql/coverage/returns.graphqls @@ -14,7 +14,7 @@ type Mutation { input RequestReturnInput { order_id: ID! - customer_custom_email: String! + contact_email: String items: [RequestReturnItemInput!]! comment_text: String } diff --git a/design-documents/graph-ql/coverage/returns.md b/design-documents/graph-ql/coverage/returns.md index 79ad46068..40290236e 100644 --- a/design-documents/graph-ql/coverage/returns.md +++ b/design-documents/graph-ql/coverage/returns.md @@ -212,7 +212,7 @@ mutation { requestReturn( input: { order_id: 12345 - customer_custom_email: "returnemail@magento.com" + contact_email: "returnemail@magento.com" items: [ { order_item_id: "absdfj2l3415", From fd27084fc8da47612d48a28ba6ca2b7c3a326487 Mon Sep 17 00:00:00 2001 From: Rakesh Jesadiya Date: Fri, 28 Aug 2020 17:54:18 +0530 Subject: [PATCH 293/479] schema update graphql --- .../graph-ql/coverage/negotiableQuotes.graphqls | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls index 192c59271..bf5f86be7 100644 --- a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls @@ -99,7 +99,11 @@ type DeleteNegotiableQuotesOutput { # Implementation Note: We don't make the deleted quotes accessible # because "deleted" means they're hidden from the storefront UI. They will # still be visible (and labeled as deleted) for a Seller in the admin - quote: Boolean + negotiableQuotes( + filter: NegotiableQuoteFilterInput, + pageSize: Int = 20, + currentPage: Int = 1 + ): NegotiableQuotesOutput @resolver(class: "\\Magento\\NegotiableQuoteGraphQl\\Model\\Resolver\\GetNegotiableQuotes") @doc(description: "List of negotiable quotes available to customer") } input CloseNegotiableQuotesInput { @@ -108,6 +112,12 @@ input CloseNegotiableQuotesInput { type CloseNegotiableQuotesOutput { closed_quotes: [NegotiableQuote!] @doc(description: "Quotes that were just closed") + #optionally display all negotiable quotes + negotiableQuotes( + filter: NegotiableQuoteFilterInput, + pageSize: Int = 20, + currentPage: Int = 1 + ): NegotiableQuotesOutput @doc(description: "A (optionally filtered) list of Negotiable Quotes viewable by the logged-in customer") } input RemoveNegotiableQuoteItemsInput { From e05a91f9dd5c663950440eeb267990284ba5e4f2 Mon Sep 17 00:00:00 2001 From: Rakesh Jesadiya Date: Fri, 28 Aug 2020 17:55:29 +0530 Subject: [PATCH 294/479] schema update graphql --- design-documents/graph-ql/coverage/negotiableQuotes.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls index bf5f86be7..6a86bc23f 100644 --- a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls @@ -103,7 +103,7 @@ type DeleteNegotiableQuotesOutput { filter: NegotiableQuoteFilterInput, pageSize: Int = 20, currentPage: Int = 1 - ): NegotiableQuotesOutput @resolver(class: "\\Magento\\NegotiableQuoteGraphQl\\Model\\Resolver\\GetNegotiableQuotes") @doc(description: "List of negotiable quotes available to customer") + ): NegotiableQuotesOutput @doc(description: "List of negotiable quotes available to customer") } input CloseNegotiableQuotesInput { From 1588af4fb9da4cc92902f4b3744c1bc19b9c4558 Mon Sep 17 00:00:00 2001 From: Rakesh Jesadiya Date: Fri, 28 Aug 2020 19:12:20 +0530 Subject: [PATCH 295/479] snack case for the negotiable_quote schema --- design-documents/graph-ql/coverage/negotiableQuotes.graphqls | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls index 6a86bc23f..af0ec3dbc 100644 --- a/design-documents/graph-ql/coverage/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/negotiableQuotes.graphqls @@ -99,7 +99,7 @@ type DeleteNegotiableQuotesOutput { # Implementation Note: We don't make the deleted quotes accessible # because "deleted" means they're hidden from the storefront UI. They will # still be visible (and labeled as deleted) for a Seller in the admin - negotiableQuotes( + negotiable_quotes( filter: NegotiableQuoteFilterInput, pageSize: Int = 20, currentPage: Int = 1 @@ -113,7 +113,7 @@ input CloseNegotiableQuotesInput { type CloseNegotiableQuotesOutput { closed_quotes: [NegotiableQuote!] @doc(description: "Quotes that were just closed") #optionally display all negotiable quotes - negotiableQuotes( + negotiable_quotes( filter: NegotiableQuoteFilterInput, pageSize: Int = 20, currentPage: Int = 1 From f13c39759437750046808d45fe22cac8f8427435 Mon Sep 17 00:00:00 2001 From: Igor Melnikov Date: Fri, 28 Aug 2020 08:55:56 -0500 Subject: [PATCH 296/479] Apply suggestions from code review --- design-documents/graph-ql/coverage/returns.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/returns.md b/design-documents/graph-ql/coverage/returns.md index 40290236e..8b75bd040 100644 --- a/design-documents/graph-ql/coverage/returns.md +++ b/design-documents/graph-ql/coverage/returns.md @@ -211,7 +211,7 @@ Existing schema of `Attribute` and `AttributeOption` must be extended to provide mutation { requestReturn( input: { - order_id: 12345 + order_id: 000000001 contact_email: "returnemail@magento.com" items: [ { From 99b83fc8942e5b276ad1b3a1361e3cc41cf5ebaa Mon Sep 17 00:00:00 2001 From: Igor Melnikov Date: Fri, 28 Aug 2020 10:45:47 -0500 Subject: [PATCH 297/479] Revert a change made for the example --- design-documents/graph-ql/coverage/returns.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/returns.md b/design-documents/graph-ql/coverage/returns.md index 8b75bd040..40290236e 100644 --- a/design-documents/graph-ql/coverage/returns.md +++ b/design-documents/graph-ql/coverage/returns.md @@ -211,7 +211,7 @@ Existing schema of `Attribute` and `AttributeOption` must be extended to provide mutation { requestReturn( input: { - order_id: 000000001 + order_id: 12345 contact_email: "returnemail@magento.com" items: [ { From 2be5c8a6723c173d0b79cedd23cd5f49b545c9c7 Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Fri, 28 Aug 2020 11:14:21 -0500 Subject: [PATCH 298/479] Add section on top-level fields on Query and Mutation --- design-documents/graph-ql/naming-conventions.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/naming-conventions.md b/design-documents/graph-ql/naming-conventions.md index eed50237d..55a7f0dae 100644 --- a/design-documents/graph-ql/naming-conventions.md +++ b/design-documents/graph-ql/naming-conventions.md @@ -41,4 +41,18 @@ type Query { twoWords: String ): String } -``` \ No newline at end of file +``` + +## Top-level Fields on Query and Mutation + +Top-level fields on Query and Mutation should always be _camelCase_. + +``` +type Query { + twoWords: TwoWords +} + +type Mutation { + twoWords(input: TwoWordsInput!): TwoWordsOutput +} +``` From 893d41626602b9dda7e51ece9efc3576498a754b Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Fri, 28 Aug 2020 11:52:48 -0500 Subject: [PATCH 299/479] add section about ID fields --- .../graph-ql/naming-conventions.md | 30 ++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/naming-conventions.md b/design-documents/graph-ql/naming-conventions.md index 55a7f0dae..526ce4676 100644 --- a/design-documents/graph-ql/naming-conventions.md +++ b/design-documents/graph-ql/naming-conventions.md @@ -47,12 +47,40 @@ type Query { Top-level fields on Query and Mutation should always be _camelCase_. -``` +```graphql type Query { + # camelCase twoWords: TwoWords } type Mutation { + # camelCase twoWords(input: TwoWordsInput!): TwoWordsOutput } ``` + +## ID Fields + +These rules should apply to any field assigned the scalar type `ID`, both in Object Types and Input Object Types. + +There are two types of `ID` fields: + +- **Primary Identifier** : An ID owned by the current Object Type +- **Foreign Identifier**: An ID referencing another Object Type + +A _Primary Identifier_ should _always_ be given the field name `uid`. +A _Foreign Identifier_ should _always_ be given the field name `source_object_uid`, where `source_object` is a _snake_case_ string referring to the type that owns the `ID` (either an Object or an Interface) + +```graphql +type ProductInterface { + # Good, ProductInterface owns `uid` + uid: ID! +} + +type ConfigurableProductOptions { + # Good, field refers to ID on `ProductInterface` + product_interface_uid: ID! +} +``` + +For additional context on ID naming requirements, see [the ID Improvement Plan](https://github.com/magento/architecture/blob/master/design-documents/graph-ql/id-improvement-plan.md_) \ No newline at end of file From 5d60f8ff64158755c8268596dccfc06ad8abd3e9 Mon Sep 17 00:00:00 2001 From: Anton Kaplia Date: Mon, 31 Aug 2020 16:55:53 -0500 Subject: [PATCH 300/479] Remove dynamic attributes from ProductInterface --- .../catalog/remove-product-attributes.md | 45 +++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 design-documents/graph-ql/coverage/catalog/remove-product-attributes.md diff --git a/design-documents/graph-ql/coverage/catalog/remove-product-attributes.md b/design-documents/graph-ql/coverage/catalog/remove-product-attributes.md new file mode 100644 index 000000000..fc6b032db --- /dev/null +++ b/design-documents/graph-ql/coverage/catalog/remove-product-attributes.md @@ -0,0 +1,45 @@ +# Remove product dynamic attributes from ProductInterface + +## Current state + +Currently, Magento exposes EAV attributes as part of the product schema as top-level fields of ProductInterface. As consequences: +* The merchant can change the GraphQL from the admin, which makes it hard to cache GraphQL schema. +* Regular product interface overloaded with fields and almost unreadable. +* It is quite often practice to create product programmatically, so the number of attributes could be really excessive with tens thousands of attributes. +* Two Magento instances do not have the same GraphQL schema. As a result, it is near impossible to build a simple client/SDK, which could be easily transferred from one instance to another. +* It is impossible to aggregate the several Magento instances behind the common [BFF](https://docs.microsoft.com/en-us/azure/architecture/patterns/backends-for-frontends). + +## Proposed solution + +We should to remove attributes dynamic attributes, +except system attributes which makes sense for the storefront, +from the product top level and use a [dynamic container](https://github.com/magento/architecture/blob/master/design-documents/graph-ql/custom-attributes-container.md) instead. + + +```graphql +## ProductInteface with system EAV attributes +type ProductInterface { + uid: ID + name: String + sku: String + attribute_set_id: Int + description: ComplexTextValue + short_description: ComplexTextValue + meta_title: String + meta_keyword: String + meta_description: String + created_at: String + updated_at: String + custom_attributes: [CustomAttribute] + ... +} +``` + +## System EAV attributes that should be deprecated at the storefront + +* `special_price: Float` These fields should not be used a the source of the discount since the discount also could be caused by group price or rule price, which are not reflected in this field. +The same is true for `special_from_date: String` and `special_to_date`. + +* `options_container: String` - this field just an exposure of `catalog_product_entity` table field, information about product options could be explicitly retrieved from the corresponding field. +* `manufacturer: Int` - just a sample attribute from Magento 1.x, we can move it to the custom attributes container. +the same is true for `country_of_manufacture: String` From c532ad779fedaf1d17fc4055d3cdfac12079d2fc Mon Sep 17 00:00:00 2001 From: Igor Melnikov Date: Mon, 31 Aug 2020 20:17:33 -0500 Subject: [PATCH 301/479] Apply suggestions from code review --- design-documents/graph-ql/coverage/quote.graphqls | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls index a76da9fb7..296f2ee88 100644 --- a/design-documents/graph-ql/coverage/quote.graphqls +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -86,7 +86,7 @@ input CartItemUpdateInput { # When `cart_item_id` is removed in a future version, we can mark `cart_item_uid` as non-nullable # with minimal disruption cart_item_id: Int @deprecated(reason: "Use the `cart_item_uid` field instead") - cart_item_uid: ID @doc(description: "Required field. Unique Identifier from objects implementing `CartItemInterface`") + cart_item_interface_uid: ID @doc(description: "Required field. Unique Identifier from objects implementing `CartItemInterface`") quantity: Float customizable_options: [CustomizableOptionInput!] } @@ -106,7 +106,7 @@ input RemoveItemFromCartInput { # When `cart_item_id` is removed in a future version, we can mark `cart_item_uid` as non-nullable # with minimal disruption cart_item_id: Int @deprecated(reason: "Use the `cart_item_uid` field instead") - cart_item_uid: ID @doc(description: "Required field. Unique Identifier from objects implementing `CartItemInterface`") + cart_item_interface_uid: ID @doc(description: "Required field. Unique Identifier from objects implementing `CartItemInterface`") } input SetShippingAddressesOnCartInput { From 9a1fd86b0d44b0403308aeb592632dcf07f3f46a Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 2 Sep 2020 19:14:03 -0500 Subject: [PATCH 302/479] Updated GraphQl Compare List Proposal --- .../graph-ql/coverage/catalog/compare-list.md | 60 ++++++++++++++++--- 1 file changed, 51 insertions(+), 9 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.md b/design-documents/graph-ql/coverage/catalog/compare-list.md index 1307b54cc..c6cc5a925 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.md +++ b/design-documents/graph-ql/coverage/catalog/compare-list.md @@ -1,11 +1,26 @@ # Use cases -## Guest scenario +## User scenario (Guest/ Logged in) + +Use createCompareList mutation to create a new compare list. The server should create a new list with the items added and return the list_id. The clients can use this list_id for futher operations. + +# Create Compare List +```graphql +{ + mutation { + createCompareList(items: ["100123", "234567", "874321"]) #items optional + } { + list_id + items { + sku + } + } +} +``` +* For a guest user, new list will be created +* For a logged in user, exisiting list_id will be returned (Can be extended in future ee - to support multiple compare list per customer) + -* A buyer can create a new compare list for the selected -products by calling mutation `addItemsToCompareList` with -the list of product ids and ID which will identify the list. -Compare list ID is client generated identifier. ```graphql { mutation { @@ -18,7 +33,7 @@ Compare list ID is client generated identifier. { query { customer { - compare_list { + compare_list(id) { # id filter is optional. Will return an array of compare lists (Future extensibility) list_id items { sku @@ -29,10 +44,11 @@ Compare list ID is client generated identifier. } ``` * If the registered customer does not have an active list then null will be returned. -This means the client has to generate and send a new ID if the compare list functionality requested. -* If the buyer calls addItemsToCompareList with a new ID the previous list will be abandoned. -For the registered user an active compare list will be replaced with a new one. +``` +assignCompareListToCustomer(customerId: ID!, listId: ID!): CompareList +``` +mutation can be used to assign a guest compare list to a registered customer. * A buyer can modify the existing list by calling mutation: * `addItemsToCompareList` to add new items to compare list. @@ -74,6 +90,10 @@ preconfigured at the backoffice. * Compare list could be assigned to the registered customer after login or account creation. +## Removing stale comparison list +* Introduce a mutation to removeComparisonList(id: ID!): Boolean, which clients can use to remove the list once the session expires +* A cron job + ![compare-list.graphqls](compare-list/compare-list.png) # Non functional requirements: @@ -83,3 +103,25 @@ preconfigured at the backoffice. Guest compare list business logic not implemented yet. Additional development required. +## Current limitations + +Existing table structure for compare list +``` +catalog_compare_item +------------------------------------------------------------------------------ +| catalog_compare_item_id | visitor_id | customer_id | product_id | store_id | +============================================================================== +``` +The visitor_id (non nullable) is tied to session \Magento\Customer\Model\Visitor in Luma. GraphQl layer should not be tied to Luma's session. So Compare-lists via GraphQl will have to differ/deviate from Luma. + +This dependency can be solved by managing the compare list state in a new table +``` +catalog_compare_list +------------------------------------------------------------------------------ +| entity_id (int) (primary)| masked_id (varchar)(indexed) | customer_id (int) (nullable)(indexed)| product_ids (json) (non nullable)| store_id (int) (non nullable)| last_modfied (date) +============================================================================== +``` +* On first client request, a row will be populated with an entity_id, server generated masked_id, customer_id (? if logged in), product_id and store_id. +* masked_id will be used for client communications +* product_ids is a json field for reducing storage complexity. +* introducing entity_id for the list will enable customers to have more than one compare list (future extensibility) From d5bac1414bf217a13cdb0bca3cc2f63d7e546621 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 2 Sep 2020 19:32:33 -0500 Subject: [PATCH 303/479] minor fix. --- design-documents/graph-ql/coverage/catalog/compare-list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.md b/design-documents/graph-ql/coverage/catalog/compare-list.md index c6cc5a925..d6fcfeb02 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.md +++ b/design-documents/graph-ql/coverage/catalog/compare-list.md @@ -92,7 +92,7 @@ preconfigured at the backoffice. ## Removing stale comparison list * Introduce a mutation to removeComparisonList(id: ID!): Boolean, which clients can use to remove the list once the session expires -* A cron job +* A cron job to remove staled entries beyond certain time. ![compare-list.graphqls](compare-list/compare-list.png) From d3d26425873fc9ea63c19c583d0eb863629d58d8 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 3 Sep 2020 10:54:19 -0500 Subject: [PATCH 304/479] Removing the additional id field, based on Anton's suggestion. --- design-documents/graph-ql/coverage/catalog/compare-list.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.md b/design-documents/graph-ql/coverage/catalog/compare-list.md index d6fcfeb02..ac9bd6ed4 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.md +++ b/design-documents/graph-ql/coverage/catalog/compare-list.md @@ -118,10 +118,10 @@ This dependency can be solved by managing the compare list state in a new table ``` catalog_compare_list ------------------------------------------------------------------------------ -| entity_id (int) (primary)| masked_id (varchar)(indexed) | customer_id (int) (nullable)(indexed)| product_ids (json) (non nullable)| store_id (int) (non nullable)| last_modfied (date) +| entity_id (int) (primary)| customer_id (int) (nullable)(indexed)| product_ids (json) (non nullable)| store_id (int) (non nullable)| last_modfied (date) ============================================================================== ``` * On first client request, a row will be populated with an entity_id, server generated masked_id, customer_id (? if logged in), product_id and store_id. -* masked_id will be used for client communications +* encoded entity_id will be used for client communications * product_ids is a json field for reducing storage complexity. * introducing entity_id for the list will enable customers to have more than one compare list (future extensibility) From 45fb01d46ad77fdd67a6a0683fa3a4b71c5dfb42 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 3 Sep 2020 13:47:00 -0500 Subject: [PATCH 305/479] Update compare-list.md --- design-documents/graph-ql/coverage/catalog/compare-list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.md b/design-documents/graph-ql/coverage/catalog/compare-list.md index ac9bd6ed4..b59a92162 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.md +++ b/design-documents/graph-ql/coverage/catalog/compare-list.md @@ -118,7 +118,7 @@ This dependency can be solved by managing the compare list state in a new table ``` catalog_compare_list ------------------------------------------------------------------------------ -| entity_id (int) (primary)| customer_id (int) (nullable)(indexed)| product_ids (json) (non nullable)| store_id (int) (non nullable)| last_modfied (date) +| entity_id (int) (primary)| customer_id (int) (nullable)(indexed)| product_ids (json) (non nullable)| store_id (int) (non nullable)| last_modfied (date) | additional_data (json) (nullable) ============================================================================== ``` * On first client request, a row will be populated with an entity_id, server generated masked_id, customer_id (? if logged in), product_id and store_id. From 97fa6b271cd408f44200fa5791feae47e05f874d Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 3 Sep 2020 13:58:33 -0500 Subject: [PATCH 306/479] Reflecting schema changes based on the new proposal. --- .../graph-ql/coverage/catalog/compare-list.graphqls | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index ce856dd26..37371d4ca 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -10,24 +10,25 @@ type ComparableItem { type ComparableAttribute { code: String! @doc(description: "Attribute code ") - title: String! @doc(description: "Addibute display title") + title: String! @doc(description: "Attribute display title") } type CompareList { - list_id: ID! @doc(description: " Compare list id") + list_id: ID! @doc(description: "Compare list id") items: [ComparableItem] @doc(description: "Comparable products") attributes: [ComparableAttribute] @doc(description: "Comparable attributes, provides codes and titles for the attributes") } type Customer { - compare_list: CompareList @doc(description: "Active customers compare list") + compareList(id: ID): [CompareList] @doc(description: "Active customers compare list") #id is optional. Introduces the possibility of more than 1 compare list. } type Query { - compareList(id: ID!): CompareList @doc(description: "Compare list") + compareList(id: ID!): [CompareList] @doc(description: "Compare list") } type Mutation { + createCompareList(items: [ID!]): CompareList @doc(description: "Creates a new compare list. For a logged in user, the created list is assigned to the user") addItemsToCompareList( id: ID! items: [ID!] From 2868872075cfec8d0b206a1dd38c6a16585954f2 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Fri, 4 Sep 2020 10:40:24 -0500 Subject: [PATCH 307/479] Update compare-list.graphqls --- .../coverage/catalog/compare-list.graphqls | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index 37371d4ca..816e1cbb6 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -14,30 +14,35 @@ type ComparableAttribute { } type CompareList { - list_id: ID! @doc(description: "Compare list id") + uid: ID! @doc(description: "Compare list id") items: [ComparableItem] @doc(description: "Comparable products") attributes: [ComparableAttribute] @doc(description: "Comparable attributes, provides codes and titles for the attributes") } type Customer { - compareList(id: ID): [CompareList] @doc(description: "Active customers compare list") #id is optional. Introduces the possibility of more than 1 compare list. + compareList(uid: ID): [CompareList] @doc(description: "Active customers compare list") #id is optional. Introduces the possibility of more than 1 compare list. } type Query { - compareList(id: ID!): [CompareList] @doc(description: "Compare list") + compareList(uid: ID!): CompareList @doc(description: "Compare list") } type Mutation { - createCompareList(items: [ID!]): CompareList @doc(description: "Creates a new compare list. For a logged in user, the created list is assigned to the user") + createCompareList(input: CreateCompareListInput): CompareList @doc(description: "Creates a new compare list. For a logged in user, the created list is assigned to the user") addItemsToCompareList( - id: ID! + uid: ID!, items: [ID!] ): CompareList removeItemsFromCompareList( - id: ID! + uid: ID!, items: [ID!] ): CompareList - assignCompareListToCustomer(customerId: ID!, listId: ID!): Boolean + assignCompareListToCustomer(customerId: ID!, uid: ID!): Boolean! + deleteCompareList(uid: ID!): Boolean! +} + +input CreateCompareListInput { + items: [ID!] } schema { From f36d236e50b6e7052469066653929e78bb06fd14 Mon Sep 17 00:00:00 2001 From: Damien Retzinger Date: Fri, 4 Sep 2020 15:21:48 -0400 Subject: [PATCH 308/479] feat(message-queue): adds design for first-class queue configuration objects --- .../First_Class_Queue_Configuration.md | 73 +++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 design-documents/message-queue/First_Class_Queue_Configuration.md diff --git a/design-documents/message-queue/First_Class_Queue_Configuration.md b/design-documents/message-queue/First_Class_Queue_Configuration.md new file mode 100644 index 000000000..0ff0115be --- /dev/null +++ b/design-documents/message-queue/First_Class_Queue_Configuration.md @@ -0,0 +1,73 @@ +# First Class Queue Configuration + +This proposal exposes a first class "queue" object in `queue_topology.xml` and provides backwards compatability for prior versions of Magento before this change. + +## Overview and Introduction +The Message Broker, RabbitMQ supports arguments that are defined at Queue creation time which dictate certain behaviors of the queue in question. Currently (as of v2.4.0), Magento infers what queues will be created from properties of the `exchange.bindings` defined in any given module's `queue_toplogy.xml`. + +Unfortunately, the current implementation of `queue_topology.xml` doesn't expose a queue object to specify arguments at queue creation time, preventing the configurable behavior of RabbitMQ. + +## Use Cases +* As a developer, I would like to configure my queues with additional arguments. +* As a developer, I would like to achieve High Availability with my message Queueing Behavior. + +### The Scenario +In order to support High Availability message processing, we would like to utilize RabbitMQ's [`x-dead-letter-exchange`](https://www.rabbitmq.com/dlx.html) and [`x-message-ttl`](https://www.rabbitmq.com/ttl.html) argument for queues. This would require two queues: + +1. A main queue which processes messages. +2. A "retry" queue with a defined `x-message-ttl` and a `x-dead-letter-exchange`. + +The first queue's consumers attempt to process its messages, and then upon failure conditions, publish these messsages (via an exchange) into the "retry" queue. + +After the retry queues TTL passes, these messages are then expire (**without being consumed**) and move the messages as a dead-letter to the origin queue. + +In the end, this results in messages being retryable in whatever mechanism a developer wishes, based upon whatever failure conditions a developer desires. + +## How it would work +An additional object would need to be added to the `queue_topology.xml` API, called a `queue`. This `queue` supports the following properties: + +```txt +name +connection +durable +autoDelete +arguments +``` + +These arguments are consistent with the existing arguments for exchanges and bindings, and should feel very familiar to developers accustomed to the current syntax. + +### A Sample Configuration +```xml + + + + + + + + arg-value + my-dlx + + + +``` + +This configuration would result in a single queue: `some-queue` which is configured by the queue object. + +## Backwards Compatability +Backwards compatability is achieved via the following mechanism: + +1. If no `queue`s are defined, behavior is as before. +2. If a `queue` is defined with a connection that is different from the `exchange` that would bind to it, two queues are created, one in each connection. + * We should warn people about this. +3. The older bindings -> queue generator mechansim should not attempt to create queues where the `queue` with the same name and connection exists. + +## Open Questions + +1. What about `autoDelete` differences? + I suspect that connection/name is a sufficient matching pair, so this case may be irrelevant. +2. What about `durable` differences? + I suspect that connection/name is a sufficient matching pair, so this case may be irrelevant. \ No newline at end of file From 6769608543aebd08795de278466422c26779616a Mon Sep 17 00:00:00 2001 From: Damien Retzinger Date: Sun, 6 Sep 2020 13:12:09 -0400 Subject: [PATCH 309/479] style(message-queue): clean up English grammer and include some precision around intended behaviors --- .../First_Class_Queue_Configuration.md | 73 ---------- .../first-class-queue-configuration.md | 132 ++++++++++++++++++ 2 files changed, 132 insertions(+), 73 deletions(-) delete mode 100644 design-documents/message-queue/First_Class_Queue_Configuration.md create mode 100644 design-documents/message-queue/first-class-queue-configuration.md diff --git a/design-documents/message-queue/First_Class_Queue_Configuration.md b/design-documents/message-queue/First_Class_Queue_Configuration.md deleted file mode 100644 index 0ff0115be..000000000 --- a/design-documents/message-queue/First_Class_Queue_Configuration.md +++ /dev/null @@ -1,73 +0,0 @@ -# First Class Queue Configuration - -This proposal exposes a first class "queue" object in `queue_topology.xml` and provides backwards compatability for prior versions of Magento before this change. - -## Overview and Introduction -The Message Broker, RabbitMQ supports arguments that are defined at Queue creation time which dictate certain behaviors of the queue in question. Currently (as of v2.4.0), Magento infers what queues will be created from properties of the `exchange.bindings` defined in any given module's `queue_toplogy.xml`. - -Unfortunately, the current implementation of `queue_topology.xml` doesn't expose a queue object to specify arguments at queue creation time, preventing the configurable behavior of RabbitMQ. - -## Use Cases -* As a developer, I would like to configure my queues with additional arguments. -* As a developer, I would like to achieve High Availability with my message Queueing Behavior. - -### The Scenario -In order to support High Availability message processing, we would like to utilize RabbitMQ's [`x-dead-letter-exchange`](https://www.rabbitmq.com/dlx.html) and [`x-message-ttl`](https://www.rabbitmq.com/ttl.html) argument for queues. This would require two queues: - -1. A main queue which processes messages. -2. A "retry" queue with a defined `x-message-ttl` and a `x-dead-letter-exchange`. - -The first queue's consumers attempt to process its messages, and then upon failure conditions, publish these messsages (via an exchange) into the "retry" queue. - -After the retry queues TTL passes, these messages are then expire (**without being consumed**) and move the messages as a dead-letter to the origin queue. - -In the end, this results in messages being retryable in whatever mechanism a developer wishes, based upon whatever failure conditions a developer desires. - -## How it would work -An additional object would need to be added to the `queue_topology.xml` API, called a `queue`. This `queue` supports the following properties: - -```txt -name -connection -durable -autoDelete -arguments -``` - -These arguments are consistent with the existing arguments for exchanges and bindings, and should feel very familiar to developers accustomed to the current syntax. - -### A Sample Configuration -```xml - - - - - - - - arg-value - my-dlx - - - -``` - -This configuration would result in a single queue: `some-queue` which is configured by the queue object. - -## Backwards Compatability -Backwards compatability is achieved via the following mechanism: - -1. If no `queue`s are defined, behavior is as before. -2. If a `queue` is defined with a connection that is different from the `exchange` that would bind to it, two queues are created, one in each connection. - * We should warn people about this. -3. The older bindings -> queue generator mechansim should not attempt to create queues where the `queue` with the same name and connection exists. - -## Open Questions - -1. What about `autoDelete` differences? - I suspect that connection/name is a sufficient matching pair, so this case may be irrelevant. -2. What about `durable` differences? - I suspect that connection/name is a sufficient matching pair, so this case may be irrelevant. \ No newline at end of file diff --git a/design-documents/message-queue/first-class-queue-configuration.md b/design-documents/message-queue/first-class-queue-configuration.md new file mode 100644 index 000000000..3c19a712c --- /dev/null +++ b/design-documents/message-queue/first-class-queue-configuration.md @@ -0,0 +1,132 @@ +# First Class Queue Configuration + +This proposal intends to expose a first-class "queue" object in `queue_topology.xml` of a module and provides backward compatibility considerations for prior versions of Magento before this change. + +## Overview +The Message Broker, RabbitMQ, supports `arguments` that are defined at queue creation time that dictate certain behaviors of the resulting queue. Currently (as of v2.4.0), Magento infers what queues will be created from properties of the `exchange.binding` defined in any given module's `queue_topology.xml`. + +Unfortunately, the current implementation of `queue_topology.xml` does not expose a queue object to specify arguments at queue creation time, preventing utilization of the configurable behavior of RabbitMQ queues. + +## Use Cases +* As a developer, I would like to configure my queues with additional arguments. +* As a developer, I would like to achieve High Availability with my queueing system. + +### The Scenario +In order to support High Availability message processing, we would like to utilize RabbitMQ's [`x-dead-letter-exchange`](https://www.rabbitmq.com/dlx.html) and [`x-message-ttl`](https://www.rabbitmq.com/ttl.html) arguments for queues. Achieveing High Availabilty with these two arguments would require two queues: + +1. A primary queue that processes messages. +2. A secondary "retry" queue with a defined `x-message-ttl` and `x-dead-letter-exchange` arguments. + +The first queue's consumers attempt to process its messages, and then upon failure conditions, publish "retryable" messages (via an exchange) into the "retry" queue. + +After the retry queue's TTL passes, the now "expired" message is then moved (**without being consumed**) as a dead-letter back to the primary queue (via the x-dead-letter-exchange). + +In the end, this results in messages being retryable in whatever mechanism a developer wishes, based upon whatever failure conditions a developer desires. + +## Design +An additional object would need to be added to the `queue_topology.xml` API, called a `queue`. A `queue` supports the following properties: + +```txt +name +connection +durable +autoDelete +arguments +``` + +These arguments are consistent with the existing arguments for exchanges and bindings and should feel very familiar to developers accustomed to the current syntax. + +### Matching Behavior +Since there is pre-existing behavior defined for queue creation from `exchange.binding` there must be a matching mechanisms which determines which mechanism of queue-creation wins. + +A queue is considered a "match" (and therefore overrules the prior `exchange.binding` behavior) when the first-class queues `name` and `connection` exactly match (string comparison, case-sensitive) a queue which would be created by `exchange.binding`. That is to say, the bindings -> queue generator mechanism should not attempt to create queues where the `queue` with the same name and connection exists. + +### Sample Configurations + +* [A Simple Configuration](./#a-simple-configuration) +* [First-Class Queue Priority](./#first-class-queue-prioritization) +* [Queue-Connection Mismatch](./#queue-connection-mismatch) + +#### A Simple Configuration +This configuration would result in a single queue: `some-queue` which is configured by the queue object. + +```xml + + + + + arg-value + my-dlx + + + +``` + +#### First-Class Queue Priority +When a `queue` and an existing `exchange.binding` collide via the described matching mechanism, a single queue results: `some-queue` as described in the below case. + +```xml + + + + + + + + arg-value + my-dlx + + + +``` + +#### Queue-Connection Mismatch +If a `queue` is defined with a connection that is different from the `exchange` that would bind to it via the old queue-creation mechanism, two queues are created, one in each connection. We should likely warn in this scenario, as likely this is an unintentional behavior. A suggested message (appearing during `setup:upgrade`) is: + +> `some-queue` is defined in two connections: `amqp` and `db`. If this intentional, this message can be ignored. + +```xml + + + + + + + + arg-value + my-dlx + + + +``` + +## Backwards Compatability +Backward compatibility is well-defined and should be as follows: + +### No Queue Defined +If no `queue` is defined, the behavior is as before, a single queue is created in the defined connection. + +```xml + + + + + + +``` + +## Open Questions + +1. What about `autoDelete` differences? + I suspect that connection/name is a sufficient matching pair, so this case may be irrelevant. +2. What about `durable` differences? + I suspect that connection/name is a sufficient matching pair, so this case may be irrelevant. From 28acfd164d0d978597971c77898f50eabd0812f8 Mon Sep 17 00:00:00 2001 From: Damien Retzinger Date: Sun, 6 Sep 2020 13:16:03 -0400 Subject: [PATCH 310/479] style(message-queue): clean up English grammer and include some precision around intended behaviors --- .../first-class-queue-configuration.md | 76 +++++++++++-------- 1 file changed, 43 insertions(+), 33 deletions(-) diff --git a/design-documents/message-queue/first-class-queue-configuration.md b/design-documents/message-queue/first-class-queue-configuration.md index 3c19a712c..691a161b6 100644 --- a/design-documents/message-queue/first-class-queue-configuration.md +++ b/design-documents/message-queue/first-class-queue-configuration.md @@ -3,27 +3,31 @@ This proposal intends to expose a first-class "queue" object in `queue_topology.xml` of a module and provides backward compatibility considerations for prior versions of Magento before this change. ## Overview -The Message Broker, RabbitMQ, supports `arguments` that are defined at queue creation time that dictate certain behaviors of the resulting queue. Currently (as of v2.4.0), Magento infers what queues will be created from properties of the `exchange.binding` defined in any given module's `queue_topology.xml`. + +The Message Broker, RabbitMQ, supports `arguments` that are defined at queue creation time that dictate certain behaviors of the resulting queue. Currently (as of v2.4.0), Magento infers what queues will be created from properties of the `exchange.binding` defined in any given module's `queue_topology.xml`. Unfortunately, the current implementation of `queue_topology.xml` does not expose a queue object to specify arguments at queue creation time, preventing utilization of the configurable behavior of RabbitMQ queues. ## Use Cases -* As a developer, I would like to configure my queues with additional arguments. -* As a developer, I would like to achieve High Availability with my queueing system. + +- As a developer, I would like to configure my queues with additional arguments. +- As a developer, I would like to achieve High Availability with my queueing system. ### The Scenario -In order to support High Availability message processing, we would like to utilize RabbitMQ's [`x-dead-letter-exchange`](https://www.rabbitmq.com/dlx.html) and [`x-message-ttl`](https://www.rabbitmq.com/ttl.html) arguments for queues. Achieveing High Availabilty with these two arguments would require two queues: + +In order to support High Availability message processing, we would like to utilize RabbitMQ's [`x-dead-letter-exchange`](https://www.rabbitmq.com/dlx.html) and [`x-message-ttl`](https://www.rabbitmq.com/ttl.html) arguments for queues. Achieving High Availability with these two arguments would require two queues: 1. A primary queue that processes messages. -2. A secondary "retry" queue with a defined `x-message-ttl` and `x-dead-letter-exchange` arguments. +2. A secondary "retry" queue with a defined `x-message-ttl` and `x-dead-letter-exchange` arguments. -The first queue's consumers attempt to process its messages, and then upon failure conditions, publish "retryable" messages (via an exchange) into the "retry" queue. +The first queue's consumers attempt to process its messages, and then upon failure conditions, publish "retryable" messages (via an exchange) into the "retry" queue. After the retry queue's TTL passes, the now "expired" message is then moved (**without being consumed**) as a dead-letter back to the primary queue (via the x-dead-letter-exchange). In the end, this results in messages being retryable in whatever mechanism a developer wishes, based upon whatever failure conditions a developer desires. -## Design +## Design + An additional object would need to be added to the `queue_topology.xml` API, called a `queue`. A `queue` supports the following properties: ```txt @@ -37,17 +41,19 @@ arguments These arguments are consistent with the existing arguments for exchanges and bindings and should feel very familiar to developers accustomed to the current syntax. ### Matching Behavior -Since there is pre-existing behavior defined for queue creation from `exchange.binding` there must be a matching mechanisms which determines which mechanism of queue-creation wins. + +Since there is pre-existing behavior defined for queue creation from `exchange.binding` there must be a matching mechanism that determines which mechanism of queue-creation wins. A queue is considered a "match" (and therefore overrules the prior `exchange.binding` behavior) when the first-class queues `name` and `connection` exactly match (string comparison, case-sensitive) a queue which would be created by `exchange.binding`. That is to say, the bindings -> queue generator mechanism should not attempt to create queues where the `queue` with the same name and connection exists. ### Sample Configurations -* [A Simple Configuration](./#a-simple-configuration) -* [First-Class Queue Priority](./#first-class-queue-prioritization) -* [Queue-Connection Mismatch](./#queue-connection-mismatch) +- [A Simple Configuration](./#a-simple-configuration) +- [First-Class Queue Priority](./#first-class-queue-prioritization) +- [Queue-Connection Mismatch](./#queue-connection-mismatch) #### A Simple Configuration + This configuration would result in a single queue: `some-queue` which is configured by the queue object. ```xml @@ -63,17 +69,18 @@ This configuration would result in a single queue: `some-queue` which is configu ``` #### First-Class Queue Priority + When a `queue` and an existing `exchange.binding` collide via the described matching mechanism, a single queue results: `some-queue` as described in the below case. ```xml - - - + + + arg-value @@ -81,9 +88,10 @@ When a `queue` and an existing `exchange.binding` collide via the described matc -``` +``` #### Queue-Connection Mismatch + If a `queue` is defined with a connection that is different from the `exchange` that would bind to it via the old queue-creation mechanism, two queues are created, one in each connection. We should likely warn in this scenario, as likely this is an unintentional behavior. A suggested message (appearing during `setup:upgrade`) is: > `some-queue` is defined in two connections: `amqp` and `db`. If this intentional, this message can be ignored. @@ -91,12 +99,12 @@ If a `queue` is defined with a connection that is different from the `exchange` ```xml - - - + + + arg-value @@ -104,29 +112,31 @@ If a `queue` is defined with a connection that is different from the `exchange` -``` +``` ## Backwards Compatability + Backward compatibility is well-defined and should be as follows: ### No Queue Defined + If no `queue` is defined, the behavior is as before, a single queue is created in the defined connection. ```xml - - - + + + ``` ## Open Questions 1. What about `autoDelete` differences? - I suspect that connection/name is a sufficient matching pair, so this case may be irrelevant. + I suspect that connection/name is a sufficient matching pair, so this case may be irrelevant. 2. What about `durable` differences? - I suspect that connection/name is a sufficient matching pair, so this case may be irrelevant. + I suspect that connection/name is a sufficient matching pair, so this case may be irrelevant. From d7b9b29c0c2b63437ed765084be9aa3be11eddb2 Mon Sep 17 00:00:00 2001 From: Damien Retzinger Date: Sun, 6 Sep 2020 13:18:33 -0400 Subject: [PATCH 311/479] style(message-queue): fix links --- .../message-queue/first-class-queue-configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/design-documents/message-queue/first-class-queue-configuration.md b/design-documents/message-queue/first-class-queue-configuration.md index 691a161b6..7d7ae1408 100644 --- a/design-documents/message-queue/first-class-queue-configuration.md +++ b/design-documents/message-queue/first-class-queue-configuration.md @@ -48,9 +48,9 @@ A queue is considered a "match" (and therefore overrules the prior `exchange.bin ### Sample Configurations -- [A Simple Configuration](./#a-simple-configuration) -- [First-Class Queue Priority](./#first-class-queue-prioritization) -- [Queue-Connection Mismatch](./#queue-connection-mismatch) +- [A Simple Configuration](#a-simple-configuration) +- [First-Class Queue Priority](#first-class-queue-priority) +- [Queue-Connection Mismatch](#queue-connection-mismatch) #### A Simple Configuration From 1e94a11dc3982956494061f45d26eb214e2f3bb9 Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Tue, 8 Sep 2020 15:29:51 -0500 Subject: [PATCH 312/479] Apply suggestions from code review --- .../graph-ql/coverage/customer/login-as-customer.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/design-documents/graph-ql/coverage/customer/login-as-customer.md b/design-documents/graph-ql/coverage/customer/login-as-customer.md index 416aa491f..6e410c12c 100644 --- a/design-documents/graph-ql/coverage/customer/login-as-customer.md +++ b/design-documents/graph-ql/coverage/customer/login-as-customer.md @@ -4,6 +4,9 @@ Admin user is expected to be authenticated using admin token. While there is no GraphQL Mutation for retrieving the admin token, REST should be used (see [example](https://devdocs.magento.com/guides/v2.4/graphql/queries/index.html#staging)). +Login as Customer link should contain short-lived and valid once token +Application can exchange this token via POST request to the REST endpoint to receive admin authentication token which can be used to obtain customer authentication token using GraphQL `generateCustomerTokenAsAdmin` query. + Admin bearer token must be provided in the `Authorization` header along with the following mutation. The admin user associated with that token must have `Login as Customer` (`Magento_LoginAsCustomer::login`) permissions. As usual, the store context is determined based on `Store` header in the request. ```graphql From 8d5dbf5061c2265f89906c87973cce160433b25f Mon Sep 17 00:00:00 2001 From: Chris Snedaker Date: Tue, 8 Sep 2020 16:44:45 -0400 Subject: [PATCH 313/479] Correction - AbsractMethod to AbstractMethod --- design-documents/abstract-method-removal.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/abstract-method-removal.md b/design-documents/abstract-method-removal.md index 64d3cc132..dfe991e09 100644 --- a/design-documents/abstract-method-removal.md +++ b/design-documents/abstract-method-removal.md @@ -25,7 +25,7 @@ There are still a few core integrations (Offline payments and PayPal), also some The desired state for 2.4 Magento release: - Core integrations do not use `AbstractMethod` (old integrations marked as deprecated). -- All related to `AbsractMethod` infrastructure code is marked as deprecated (which not marked yet) +- All related to `AbstractMethod` infrastructure code is marked as deprecated (which not marked yet) - All appropriate methods/functions trigger `E_DEPRECATED` warning (https://devdocs.magento.com/guides/v2.3/contributor-guide/backward-compatible-development/#deprecation). @@ -34,4 +34,4 @@ The desired state for 2.5 Magento release: ## Summary -The 3rd party developers will have a full minor-release cycle to rework their integrations. As each payment integration has a lot of specific implementation details, own flow and data set for payment operations, there is no unified approach to provide tools for code migration from `AbstractMethod` to Payment Provider Gateway. \ No newline at end of file +The 3rd party developers will have a full minor-release cycle to rework their integrations. As each payment integration has a lot of specific implementation details, own flow and data set for payment operations, there is no unified approach to provide tools for code migration from `AbstractMethod` to Payment Provider Gateway. From 73aee792b9b6eb1349d2488a72079a906936ffa3 Mon Sep 17 00:00:00 2001 From: Igor Melnikov Date: Tue, 8 Sep 2020 16:10:38 -0500 Subject: [PATCH 314/479] Apply suggestions from code review --- design-documents/graph-ql/mutation-error-design.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/mutation-error-design.md b/design-documents/graph-ql/mutation-error-design.md index 572237b19..3ea6f8f28 100644 --- a/design-documents/graph-ql/mutation-error-design.md +++ b/design-documents/graph-ql/mutation-error-design.md @@ -74,7 +74,7 @@ type AddItemToCartOutput { # can still get the entire state of the cart post-mutation cart: Cart # can directly access errors that a shopper should be notified about - addItemUserErrors: [AddItemUserError!]! + add_item_user_errors: [AddItemUserError!]! } type AddItemUserError { @@ -104,7 +104,7 @@ mutation { } } - addItemUserErrors { + add_item_user_errors { message type } @@ -118,7 +118,7 @@ mutation { "cart": { // cart data here }, - "addItemUserErrors": [{ + "add_item_user_errors": [{ "message": "Item 'cool-hat' not added to cart (Out of Stock)", "type": "OUT_OF_STOCK" }] @@ -150,5 +150,5 @@ Instead, you would likely have your `addItemToCart` function return something th ## Open Questions -1. Should we be consistent with the field name that represents these first-class errors? `userErrors` vs something like `addToCartUserErrors` +1. Should we be consistent with the field name that represents these first-class errors? `user_errors` vs something like `add_to_cart_user_errors` 2. Should there be a basic interface that mutations should implement to enforce the pattern of returning a list of user errors? From 094b51964683f93a629f6fdca3156f554636d198 Mon Sep 17 00:00:00 2001 From: Igor Melnikov Date: Tue, 8 Sep 2020 16:28:05 -0500 Subject: [PATCH 315/479] Apply suggestions from code review --- .../graph-ql/coverage/catalog/compare-list.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index cf07890e5..f20a29d97 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -36,7 +36,7 @@ type Mutation { id: ID! items: [ID!] ): CompareList - assignCompareListToActiveCustomer(listId: ID!): Boolean + assignCompareListToCustomer(listId: ID!): Boolean } schema { From 72f13dd3488af508a80bc85f58994ddd76e31c6b Mon Sep 17 00:00:00 2001 From: Dmitriy Gallyamov Date: Wed, 9 Sep 2020 14:40:08 +0300 Subject: [PATCH 316/479] magento/partners-magento2b2b#308 - Company credit query schema update --- design-documents/graph-ql/coverage/b2b/company-credit.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/company-credit.md b/design-documents/graph-ql/coverage/b2b/company-credit.md index c94094aff..89b52c06a 100644 --- a/design-documents/graph-ql/coverage/b2b/company-credit.md +++ b/design-documents/graph-ql/coverage/b2b/company-credit.md @@ -22,7 +22,7 @@ type CompanyCreditOperation { type: CompanyCreditOperationType! @doc(description: "The type of the company credit operation") amount: Money @doc(description: "The amount fo the company credit operation") balance: CompanyCredit! @doc(description: "Credit balance after the company credit operation") - purchase_order: String @doc(description: "Purchase order number associated with the company credit operation") + custom_reference_number: String @doc(description: "Purchase order number associated with the company credit operation") updated_by: CompanyCreditOperationUser! @doc(description: "The user submitting the company credit operation") } @@ -53,7 +53,7 @@ enum CompanyCreditOperationUserType { input CompanyCreditHistoryFilterInput { operation_type: CompanyCreditOperationType @doc(description: "Enum filter by the type of the company credit operation") - purchase_order: String @doc(description: "Free text filter by the purchase order number associated with the company credit operation") + custom_reference_number: String @doc(description: "Free text filter by the purchase order number associated with the company credit operation") updated_by: String @doc(description: "Free text filter by the name of the person submitting the company credit operation") } ###### End: Defining new types ###### From 9ec797d103e3cf0702ad8338a9fdbf79c549b8c8 Mon Sep 17 00:00:00 2001 From: Nishant Kapoor Date: Wed, 9 Sep 2020 13:07:32 -0500 Subject: [PATCH 317/479] Update company.md --- .../graph-ql/coverage/b2b/company.md | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/company.md b/design-documents/graph-ql/coverage/b2b/company.md index 64d7287ac..c1e377ccb 100644 --- a/design-documents/graph-ql/coverage/b2b/company.md +++ b/design-documents/graph-ql/coverage/b2b/company.md @@ -20,7 +20,7 @@ type Query { } type Company @doc(description: "Company entity output data schema.") { - id: ID! @doc(description: "Company id.") + uid: ID! @doc(description: "Company id.") name: String @doc(description: "Company name.") email: String @doc(description: "Company email address.") legal_name: String @doc(description: "Company legal name.") @@ -35,18 +35,18 @@ type Company @doc(description: "Company entity output data schema.") { pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. Defaults to 20."), currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1."), ): CompanyUsers @doc(description: "Information about the company users.") - user(id: ID!): Customer @doc(description: "Returns company user by id.") + user(uid: ID!): Customer @doc(description: "Returns company user by id.") roles( pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. Optional. Defaults to 20."), currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1."), ): CompanyRoles! @doc(description: "Returns the list of defined roles at Company.") - role(id: ID!): CompanyRole @doc(description: "Returns company role by id.") + role(uid: ID!): CompanyRole @doc(description: "Returns company role by id.") acl_resources: [CompanyAclResource] @doc(description: "Returns the list of all permission resources.") structure( root_id: ID = 0 @doc(description: "Tree depth to begin query") depth: Int = 10 @doc(description: "Specifies how deeply results are fetched") ): CompanyStructure @doc(description: "Company structure of teams and customers in depth-first order") - team(id: ID!): CompanyTeam @doc(description: "Returns company team data by id.") + team(uid: ID!): CompanyTeam @doc(description: "Returns company team data by id.") } type CompanyLegalAddress @doc(description: "Company legal address output data schema.") { @@ -59,7 +59,7 @@ type CompanyLegalAddress @doc(description: "Company legal address output data sc } type CompanyAdmin @doc(description: "Company Administrator (Customer with corresponding privileges) output data schema.") { - id: ID! @doc(description: "Company Administrator's id.") + uid: ID! @doc(description: "Company Administrator's id.") email: String @doc(description: "Company Administrator email address.") firstname: String @doc(description: "Company Administrator first name.") lastname: String @doc(description: "Company Administrator last name.") @@ -86,14 +86,14 @@ type CompanyRoles @doc(description: "Output data schema for an object returned b } type CompanyRole @doc(description: "Company role output data schema returned in response to a query by Role id.") { - id: ID! @doc(description: "Role id.") + uid: ID! @doc(description: "Role id.") name: String @doc(description: "Role name.") users_count: Int @doc(description: "Total number of Users with such Role within Company Structure.") permissions: [CompanyAclResource] @doc(description: "A list of permission resources defined for a Role.") } type CompanyAclResource @doc(description: "Output data schema for an object with Role permission resource information.") { - id: ID! @doc(description: "ACL resource id.") + uid: ID! @doc(description: "ACL resource id.") text: String @doc(description: "ACL resource label.") sortOrder: Int @doc(description: "ACL resource sort order.") children: [CompanyAclResource!] @doc(description: "An array of sub-resources.") @@ -118,7 +118,7 @@ type CompanyEmailCheckResponse @doc(description: "Response object schema for a C union CompanyStructureEntity = CompanyTeam | Customer type CompanyStructureItem @doc(description: "Company Team and Customer structure") { - id: ID! @doc(description: "ID of the item in the hierarchy") + uid: ID! @doc(description: "ID of the item in the hierarchy") parent_id: ID @doc(description: "ID of the parent item in the hierarchy") entity: CompanyStructureEntity } @@ -128,7 +128,7 @@ type CompanyStructure { } type CompanyTeam @doc(description: "Company Team entity output data schema.") { - id: ID! @doc(description: "Team id.") + uid: ID! @doc(description: "Team id.") name: String @doc(description: "Team name.") description: String @doc(description: "Team description.") } @@ -151,14 +151,14 @@ type Mutation { updateCompany(input: CompanyUpdateInput!): UpdateCompanyOutput @doc(description:"Update Company information.") createCompanyUser(input: CompanyUserCreateInput!): CreateCompanyUserOutput @doc(description:"Create new Company User (Customer assigned to Company).") updateCompanyUser(input: CompanyUserUpdateInput!): UpdateCompanyUserOutput @doc(description:"Update Company User information.") - deleteCompanyUser(id: ID!): DeleteCompanyUserOutput @doc(description:"Delete Company User by ID.") + deleteCompanyUser(uid: ID!): DeleteCompanyUserOutput @doc(description:"Delete Company User by ID.") createCompanyRole(input: CompanyRoleCreateInput!): CreateCompanyRoleOutput @doc(description:"Create new Company role.") updateCompanyRole(input: CompanyRoleUpdateInput!): UpdateCompanyRoleOutput @doc(description:"Update Company role data.") - deleteCompanyRole(id: ID!): DeleteCompanyRoleOutput @doc(description:"Delete Company Role by ID.") + deleteCompanyRole(uid: ID!): DeleteCompanyRoleOutput @doc(description:"Delete Company Role by ID.") updateCompanyStructure(input: CompanyStructureUpdateInput!): UpdateCompanyStructureOutput @doc(description:"Update Company Structure element's parent node assignment.") createCompanyTeam(input: CompanyTeamCreateInput!): CreateCompanyTeamOutput @doc(description:"Create Company Team.") updateCompanyTeam(input: CompanyTeamUpdateInput!): UpdateCompanyTeamOutput @doc(description:"Update Company Team data.") - deleteCompanyTeam(id: ID!): DeleteCompanyTeamOutput @doc(description:"Delete Company Team entity by ID.") + deleteCompanyTeam(uid: ID!): DeleteCompanyTeamOutput @doc(description:"Delete Company Team entity by ID.") } type CreateCompanyTeamOutput @doc(description: "Create company team output data schema.") { @@ -267,7 +267,7 @@ input CompanyUserCreateInput @doc(description: "Defines the input data schema fo } input CompanyUserUpdateInput @doc(description: "Defines the input data schema for updating an existing Customer - Company user.") { - id: ID! @doc(description: "Company user's ID (Customer ID). Required.") + uid: ID! @doc(description: "Company user's ID (Customer ID). Required.") role_id: ID @doc(description: "Company user's role ID.") status: Int @doc(description: "Company user's status ID.") job_title: String @doc(description: "Company user's job title.") @@ -283,7 +283,7 @@ input CompanyRoleCreateInput @doc(description: "Defines the input data schema fo } input CompanyRoleUpdateInput @doc(description: "Defines the input data schema for updating an existing Company role.") { - id: ID! @doc(description: "Role ID. Required.") + uid: ID! @doc(description: "Role ID. Required.") name: String @doc(description: "Role name.") permissions: [String!] @doc(description: "A list of Role permission resources. Array value for a field, if provided, should consist only of string values.") } @@ -300,7 +300,7 @@ input CompanyTeamCreateInput @doc(description: "Defines the input data schema fo } input CompanyTeamUpdateInput @doc(description: "Defines the input data schema for updating an existing Company team.") { - id: ID! @doc(description: "Team ID. Required.") + uid: ID! @doc(description: "Team ID. Required.") name: String @doc(description: "Team name.") description: String @doc(description: "Team description.") } From f02d55b5a17f225bed456c3b7cbd8b39adc38074 Mon Sep 17 00:00:00 2001 From: Nishant Kapoor Date: Wed, 9 Sep 2020 13:13:37 -0500 Subject: [PATCH 318/479] Update negotiableQuotes.graphqls --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index af0ec3dbc..4684bbbcb 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -4,7 +4,7 @@ type Query { # in a company can see quotes belonging to their # employees. If `Customer.negotiable_quotes` is desirable for buyer's # that aren't managers, we can always add that on - negotiableQuote(id: ID!): NegotiableQuote @doc(description: "Get a buyer's NegotiableQuote by ID") + negotiableQuote(iud: ID!): NegotiableQuote @doc(description: "Get a buyer's NegotiableQuote by ID") negotiableQuotes( filter: NegotiableQuoteFilterInput, pageSize: Int = 20, @@ -153,7 +153,7 @@ input AddNegotiableQuoteCommentInput { } type NegotiableQuoteComment { - id: ID! + uid: ID! created_at: String! author: NegotiableQuoteUser! creator_type: NegotiableQuoteCommentCreatorType! @@ -166,7 +166,7 @@ enum NegotiableQuoteCommentCreatorType { } type NegotiableQuote { - id: ID! + uid: ID! name: String! items: [CartItemInterface!] # Attachment Support is dependent on headless File Upload design @@ -200,7 +200,7 @@ input NegotiableQuoteFilterInput { } type NegotiableQuoteHistoryEntry { - id: ID! + uid: ID! author: NegotiableQuoteUser! change_type: NegotiableQuoteHistoryEntryChangeType! created_at: String From fe9a3ae6c267dc3c4b6f386ce9bfa378d9e9b39d Mon Sep 17 00:00:00 2001 From: Nishant Kapoor Date: Wed, 9 Sep 2020 13:19:19 -0500 Subject: [PATCH 319/479] Update requisitionList.graphqls --- .../coverage/b2b/requisitionList.graphqls | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls index 273c8e894..05b7ed3a8 100644 --- a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls +++ b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls @@ -39,7 +39,7 @@ type RequisitionLists @doc(description: "Provides Customer's Requisition Lists") } type RequisitionList @doc(description: "Requisition List Type") { - id: ID! @doc(description: "Unique Identifier of Requisition List") + uid: ID! @doc(description: "Unique Identifier of Requisition List") name: String! @doc(description: "Name of the list") description: String @doc(description: "Description of the list") items( @@ -57,14 +57,14 @@ type RequistionListItems { } interface RequisitionListItemInterface @doc(description: "Interface type for Requisition List Item") { - id: ID! @doc(description:"Unique Identifier of Requisition List Item") + uid: ID! @doc(description:"Unique Identifier of Requisition List Item") product: ProductInterface! qty: Float! @doc(description: "Quantity added") } type DefaultRequisitionListItem implements RequisitionListItemInterface @doc(description: "Requisition List Item Implementation that for Simple and Virtual Products") { - id: ID! @doc(description: "Unique Identifier of Requisition List Item") + uid: ID! @doc(description: "Unique Identifier of Requisition List Item") product: ProductInterface! qty: Float! @doc(description: "Quantity added") customizable_options: [SelectedCustomizableOption] @doc(description: "custom Option selected") @@ -72,7 +72,7 @@ type DefaultRequisitionListItem implements RequisitionListItemInterface type DownloadableRequisitionListItem implements RequisitionListItemInterface @doc(description: "Requisition List Item Implementation that for Downloadable Products") { - id: ID! @doc(description: "Unique Identifier of Requisition List Item") + uid: ID! @doc(description: "Unique Identifier of Requisition List Item") product: ProductInterface! qty: Float! @doc(description: "Quantity added") customizable_options: [SelectedCustomizableOption] @doc(description: "custom Option selected") @@ -82,7 +82,7 @@ type DownloadableRequisitionListItem implements RequisitionListItemInterface type BundleRequisitionListItem implements RequisitionListItemInterface @doc(description: "Requisition List Item Implementation that for Bundle Products") { - id: ID! @doc(description: "Unique Identifier of Requisition List Item") + uid: ID! @doc(description: "Unique Identifier of Requisition List Item") product: ProductInterface! qty: Float! @doc(description: "Quantity added") customizable_options: [SelectedCustomizableOption] @doc(description: "custom Option selected") @@ -91,7 +91,7 @@ type BundleRequisitionListItem implements RequisitionListItemInterface type ConfigurableRequisitionListItem implements RequisitionListItemInterface @doc(description: "Requisition List Item Implementation that for Configurable Products") { - id: ID! @doc(description: "Unique Identifier of Requisition List Item") + uid: ID! @doc(description: "Unique Identifier of Requisition List Item") product: ProductInterface! qty: Float! @doc(description: "Quantity added") customizable_options: [SelectedCustomizableOption] @doc(description: "custom Option selected") @@ -105,27 +105,27 @@ type Mutation { ): CreateRequisitionListOutput @doc(description: "Create Empty Requisition List") renameRequisitionList( - id: ID!, @doc(description: "unique Id of requisition list") + uid: ID!, @doc(description: "unique Id of requisition list") name: String!, @doc(description: "new name for list") description: String @doc(description: "new description For the List") ): RenameRequisitionListOutput @doc(description: "Rename a requisition list and change description") deleteRequisitionList( - id: ID! @doc(description: "unique Id of requisition list") + uid: ID! @doc(description: "unique Id of requisition list") ): DeleteRequisitionListOutput @doc(description: "Delete a requisition list with Id") addProductsToRequisitionList( - id: ID!, @doc(description: "unique Id of requisition list") + uid: ID!, @doc(description: "unique Id of requisition list") items: [RequisitionListItemsInput!]! @doc(description: "Products to be added to requisition list") ): AddProductsToRequisitionListOutput @doc(description: "Add items to requisition list") removeRequisitionListItems( - id: ID!, @doc(description: "unique Id of requisition list") + uid: ID!, @doc(description: "unique Id of requisition list") items: [ID!]! @doc(description: "unique Ids of Items to be removed from requisition list") ): RemoveRequisitionListItemsOutput @doc(description: "Remove Items in requisition list") updateRequisitionListItems( - id: ID!, @doc(description: "unique Id of requisition list") + uid: ID!, @doc(description: "unique Id of requisition list") items: [UpdateRequisitionListItemsInput!]! @doc(description: "Items to be updated from requisition list") ): UpdateRequisitionListItemsOutput @doc(description: "Update Items in requisition list") From 97ac25c18ce8dff0ad0e1bae11b0d3c070afd4c8 Mon Sep 17 00:00:00 2001 From: Nishant Kapoor Date: Wed, 9 Sep 2020 13:22:56 -0500 Subject: [PATCH 320/479] Update returns.graphqls --- .../graph-ql/coverage/returns.graphqls | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/design-documents/graph-ql/coverage/returns.graphqls b/design-documents/graph-ql/coverage/returns.graphqls index 97957e6c0..ed6db8eee 100644 --- a/design-documents/graph-ql/coverage/returns.graphqls +++ b/design-documents/graph-ql/coverage/returns.graphqls @@ -27,7 +27,7 @@ input RequestReturnItemInput { } input EnteredCustomAttributeInput { - id: ID! + uid: ID! value: String! } @@ -81,7 +81,7 @@ type Customer { pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. Defaults to 20."), currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1."), ): Returns @doc(description: "Information about the customer returns.") - return(id: ID!): Return @doc(description: "Get customer return details by its ID.") + return(uid: ID!): Return @doc(description: "Get customer return details by its ID.") } type CustomerOrder { @@ -103,7 +103,7 @@ type Returns { } type Return @doc(description: "Customer return") { - id: ID! + uid: ID! number: String! @doc(description: "Human-readable return number") order: CustomerOrder @doc(description: "The order associated with the return.") creation_date: String! @doc(description: "The date when the return was requested.") @@ -117,7 +117,7 @@ type Return @doc(description: "Customer return") { } type ReturnItem { - id: ID! + uid: ID! order_item: OrderItemInterface! @doc(description: "Order item provides access to the product being returned, including selected/entered options information.") custom_attributes: [CustomAttribute] @doc(description: "Return item custom attributes, which are marked by the admin to be visible on the storefront.") request_quantity: Float! @doc(description: "The quantity of the item requested to be returned.") @@ -127,13 +127,13 @@ type ReturnItem { # See https://github.com/magento/architecture/blob/master/design-documents/graph-ql/custom-attributes-container.md type CustomAttribute { - id: ID! + uid: ID! label: String! value: String! @doc(description: "JSON encoded value of the attribute.") } type ReturnComment { - id: ID! @doc(description: "Comment ID.") + uid: ID! @doc(description: "Comment ID.") author_firstname: String! @doc(description: "First name of the user who posted the comment.") author_lastname: String! @doc(description: "Last name of the user who posted the comment.") created_at: String! @doc(description: "The date and time when the comment was posted.") @@ -142,16 +142,16 @@ type ReturnComment { type ReturnShipping { address: ReturnShippingAddress @doc(description: "Return shipping address, which is specified by the admin.") - tracking(id: ID): [ReturnShippingTracking] @doc(description: "Tracking information for all or a single tracking record when ID is provided.") + tracking(uid: ID): [ReturnShippingTracking] @doc(description: "Tracking information for all or a single tracking record when ID is provided.") } type ReturnShippingCarrier { - id: ID! + uid: ID! label: String! } type ReturnShippingTracking { - id: ID! + uid: ID! carrier: ReturnShippingCarrier! tracking_number: String! status: ReturnShippingTrackingStatus @@ -207,9 +207,9 @@ type StoreConfig { } type Attribute { - id: ID! + uid: ID! } type AttributeOption { - id: ID! + uid: ID! } From 8b3565a388f9580ab2dd683218936aa6ec656f6c Mon Sep 17 00:00:00 2001 From: Soumya Unnikrishnan Date: Wed, 9 Sep 2020 18:14:54 -0500 Subject: [PATCH 321/479] MQE-2247: Implement additional

and entity use cases in SVC tool --- .../functional/versioning-and-backward-compatibility-policy.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/design-documents/testing/functional/versioning-and-backward-compatibility-policy.md b/design-documents/testing/functional/versioning-and-backward-compatibility-policy.md index a52710d10..526965ee2 100644 --- a/design-documents/testing/functional/versioning-and-backward-compatibility-policy.md +++ b/design-documents/testing/functional/versioning-and-backward-compatibility-policy.md @@ -82,6 +82,8 @@ It MAY include minor and patch level changes. Patch and minor version MUST be re |Metadata|`` added|MINOR | |`` removed|MAJOR | |`` changed|MINOR +| |`` child element added|MINOR +| |`` child element removed|MAJOR |Page|`` added|MINOR | |`` removed|MAJOR | |`` `

` added|MINOR From bde94bfdf8aafb3212915880ec4034ed659cbdef Mon Sep 17 00:00:00 2001 From: Nishant Kapoor Date: Wed, 9 Sep 2020 19:48:17 -0500 Subject: [PATCH 322/479] Rename all id fields to uid in cart.graphqls --- .../graph-ql/coverage/cart/Cart.graphqls | 33 ++++++++++++------- 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/design-documents/graph-ql/coverage/cart/Cart.graphqls b/design-documents/graph-ql/coverage/cart/Cart.graphqls index 28f54eff8..556c3b411 100644 --- a/design-documents/graph-ql/coverage/cart/Cart.graphqls +++ b/design-documents/graph-ql/coverage/cart/Cart.graphqls @@ -3,7 +3,7 @@ type Query { } input CartQueryInput { - cart_id: String! + cart_id: ID! } type CartQueryOutput { @@ -11,7 +11,8 @@ type CartQueryOutput { } type Cart { - id: ID! @doc(description: "The ID of the cart.") + id: ID! @doc(description: "The ID of the cart.") @deprecated(reason: "use uid") + uid: ID! @doc(description: "The unique ID of the cart.") items: [CartItemInterface] applied_coupons: [AppliedCoupon] @doc(description:"An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. By default Magento supports only one coupon.") email: String @@ -36,7 +37,8 @@ type SelectedPaymentMethod { } interface CartItemInterface @typeResolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemTypeResolver") { - id: String! + id: String! @deprecated(reason: "use uid") + uid: ID! @doc(description: "The unique ID of the cart item.") quantity: Float! prices: CartItemPrices product: ProductInterface! @@ -74,8 +76,9 @@ type GiftCardCartItem implements CartItemInterface { type SelectedConfigurableOption { # Hash which includes option ID, option type and slected values. Can be used to move configurable product to wishlist or gift registry - id_v2: ID! - id: Int! + id_v2: ID! @deprecated(reason: "use uid") + id: Int! @deprecated(reason: "use uid") + uid: ID! @doc(description: "The unique ID of the cart.") option_label: String! value_id: Int! value_label: String! @@ -83,7 +86,8 @@ type SelectedConfigurableOption { type DownloadableProductLink @doc(description: "Defines characteristics of a downloadable product") { # Hash based on option type and slected link. Can be used to move downloadable product to wishlist or gift registry - id: ID! + id: ID! @deprecated(reason: "use uid") + uid: ID! @doc(description: "The unique ID of the cart.") title: String @doc(description: "The display name of the link") sort_order: Int @doc(description: "A number indicating the sort order") price: Float @doc(description: "The price of the downloadable product") @@ -97,14 +101,16 @@ type DownloadableProductSamples @doc(description: "DownloadableProductSamples de } type SelectedBundleOption { - id: Int! + id: Int! @deprecated(reason: "use uid") + uid: ID! @doc(description: "The unique ID of the cart.") label: String! type: String! values: [SelectedBundleOptionValue!]! } type SelectedBundleOptionValue { - id: Int! + id: Int! @deprecated(reason: "use uid") + uid: ID! @doc(description: "The unique ID of the cart.") label: String! price: Float! quantity: Float! @@ -113,8 +119,9 @@ type SelectedBundleOptionValue { type SelectedCustomizableOption { # Hash which includes option ID, option type and slected values. Can be used to move a product to wishlist or gift registry - id_v2: ID! - id: Int! + id_v2: ID! @deprecated(reason: "use uid") + id: Int! @deprecated(reason: "use uid") + uid: ID! @doc(description: "The unique ID of the selected option.") label: String! is_required: Boolean! values: [SelectedCustomizableOptionValue!]! @@ -122,7 +129,8 @@ type SelectedCustomizableOption { } type SelectedCustomizableOptionValue { - id: Int! + id: Int! @deprecated(reason: "use uid") + uid: ID! @doc(description: "The unique ID of the selected option.") label: String! value: String! price: CartItemSelectedOptionValuePrice! @@ -136,7 +144,8 @@ type CartItemSelectedOptionValuePrice { type SelectedGiftCardAmount { # Hash from the type of the option and value - id: ID! + id: ID! @deprecated(reason: "use uid") + uid: ID! @doc(description: "The unique ID of the selected option.") value: Money! } From 3f242fed9e087efc5d78d82f0344d6d1432dc0d6 Mon Sep 17 00:00:00 2001 From: Nishant Kapoor Date: Thu, 10 Sep 2020 07:30:08 -0500 Subject: [PATCH 323/479] Rename all the id fields to uid in compare-list.graphqls Rename all the id fields to uid in compare-list.graphqls --- .../graph-ql/coverage/catalog/compare-list.graphqls | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index f20a29d97..c004a236b 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -14,7 +14,7 @@ type ComparableAttribute { } type CompareList { - list_id: ID! @doc(description: " Compare list id") + uid: ID! @doc(description: " Compare list unique id") items: [ComparableItem] @doc(description: "Comparable products") attributes: [ComparableAttribute] @doc(description: "Comparable attributes, provides codes and titles for the attributes") } @@ -24,19 +24,19 @@ type Customer { } type Query { - compareList(id: ID!): CompareList @doc(description: "Compare list") + compareList(uid: ID!): CompareList @doc(description: "Compare list") } type Mutation { addItemsToCompareList( - id: ID! + uid: ID! items: [ID!] ): CompareList removeItemsFromCompareList( - id: ID! + uid: ID! items: [ID!] ): CompareList - assignCompareListToCustomer(listId: ID!): Boolean + assignCompareListToCustomer(listUid: ID!): Boolean } schema { From 5eac1147cebcf4ae7576ed5f905233c6aa37ab64 Mon Sep 17 00:00:00 2001 From: Anton Kaplia Date: Thu, 10 Sep 2020 23:47:46 -0500 Subject: [PATCH 324/479] added productId to variant --- .../storefront/catalog/product-options-and-variants.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/design-documents/storefront/catalog/product-options-and-variants.md b/design-documents/storefront/catalog/product-options-and-variants.md index 85abe6ab9..9b2b54170 100644 --- a/design-documents/storefront/catalog/product-options-and-variants.md +++ b/design-documents/storefront/catalog/product-options-and-variants.md @@ -80,7 +80,9 @@ Such a decision brings us unseen before the level of the flexibility, since ther We do not have such behaviors either Magento 1 or 2 and as a result, the whole layer of product types such as bundle and downloadable do not support B2B prices or special prices for options. -The link on a product that exists in the same domain could be done through the shared ID, which as for me makes sense since I can see a possible scenario when variation that initially had only a price will be "promoted" to a product. For example due to integration reasons, to pass additional attributes data along with variant to Google Merchant Center. +In most cases, the product variant of configurable and bundle products may represent the child product, and via versa. +But it does not mean that two different variants can not reference the same product. For instance, two different bundle products may contain the same product, refer to the same inventory but have different prices. + ### Enhanced option values @@ -122,6 +124,7 @@ message ProductOption { message ProductVariant { repeated string optionValueId = 1; string id = 2; + string productId = 3; string productIdentifierInPricing = 500; #* string productIdentifierInInventory = 600; #* } From e5481f58e11cbf23343688d6f395ea1ccf0417a3 Mon Sep 17 00:00:00 2001 From: Igor Melnikov Date: Fri, 11 Sep 2020 08:07:49 -0500 Subject: [PATCH 325/479] Apply suggestions from code review Co-authored-by: Alex Paliarush --- .../coverage/deprecate-createEmptyCart-add-createGuestCart.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/deprecate-createEmptyCart-add-createGuestCart.md b/design-documents/graph-ql/coverage/deprecate-createEmptyCart-add-createGuestCart.md index 41cdd2cb1..e8175a5a8 100644 --- a/design-documents/graph-ql/coverage/deprecate-createEmptyCart-add-createGuestCart.md +++ b/design-documents/graph-ql/coverage/deprecate-createEmptyCart-add-createGuestCart.md @@ -28,7 +28,7 @@ Because the UI knows if it has a token for a customer, `Query.cart` should be us type Mutation { + createGuestCart( + input: CreateGuestCartInput -+ ): CreateCartOutput @doc(description: "Create a new shopping cart") ++ ): CreateGuestCartOutput @doc(description: "Create a new shopping cart") createEmptyCart( input: createEmptyCartInput + ): String @deprecated(reason: "Use `Mutation.createGuestCart`, or `Query.cart` for logged-in shoppers") @@ -36,7 +36,7 @@ type Mutation { } +input CreateGuestCartInput { -+ cart_id: String @doc(description: "Optional client-generated ID") ++ cart_uid: ID @doc(description: "Optional client-generated ID") +} + +type CreateGuestCartOutput { From 564a3fac10c315fb80c7945e87d61d880f5965fa Mon Sep 17 00:00:00 2001 From: Anton Kaplia Date: Fri, 11 Sep 2020 12:33:25 -0500 Subject: [PATCH 326/479] added example --- .../catalog/product-options-and-variants.md | 115 ++++++++++++++++++ 1 file changed, 115 insertions(+) diff --git a/design-documents/storefront/catalog/product-options-and-variants.md b/design-documents/storefront/catalog/product-options-and-variants.md index 9b2b54170..859a3bda3 100644 --- a/design-documents/storefront/catalog/product-options-and-variants.md +++ b/design-documents/storefront/catalog/product-options-and-variants.md @@ -356,3 +356,118 @@ This proposal continues the idea of product options unification and aligned with * [Single mutation for adding products to cart](https://github.com/magento/architecture/blob/master/design-documents/graph-ql/coverage/add-items-to-cart-single-mutation.md) * [Configurable options selection](https://github.com/magento/architecture/blob/master/design-documents/graph-ql/coverage/catalog/configurable-options-selection.md) * [Gift Registry](https://github.com/magento/architecture/blob/master/design-documents/graph-ql/coverage/gift-registry.md) + + +## Question & Answers + +### How to express two configurable products that share the same attribute set? + +*Comment: Although this case natively supported by Magento, +it could be less common than we used to think since the two regular t-shorts +from Walmart will have different sets of values for sizes and colors depends +on the manufacturer. proof https://www.walmart.com/search/?query=tshirt* + + +#### Product #1 +```json +{ + "id": "a82deb7a-dee7-48e7-ab34-75026e576fab", + "name": "Fruit of the Loom Men's Short Sleeve Assorted Crew T-Shirt", + "options": { + "color": { + "label": "Color", + "values": { + "red": { + "label": "Red" + }, + "green": { + "label": "Green" + } + } + }, + "size" : { + "label": "Size", + "values": { + "m": { + "label": "M" + }, + "l": { + "label": "L" + } + } + } + } +} +``` + +#### Product 1 variants +```json +[ + { + "variantId": "500d0366-777f-4a45-92b6-8e5197ce9992", + "optionValueIds": [ + "a82deb7a-dee7-48e7-ab34-75026e576fab:color/red", "a82deb7a-dee7-48e7-ab34-75026e576fab:size/l" + ], + "productId": "8b6be8b0-2e21-4763-806c-f383a8591d21" + }, + { + "variantId": "b843e139-aa04-44d0-a9a7-b439a17ce941", + "optionValueIds": [ + "a82deb7a-dee7-48e7-ab34-75026e576fab:color/green", "a82deb7a-dee7-48e7-ab34-75026e576fab:size/m" + ], + "productId": "96a5a8ed-7cfe-4626-be29-f60fe0bf7b33" + } +] +``` + +#### Product 2 +```json +{ + "id": "747d8c9b-e5fc-437a-8263-271dd8352976", + "name": "George Men's Assorted Crew T-Shirt", + "options": { + "color": { + "label": "Color", + "values": { + "red": { + "label": "Red" + }, + "green": { + "label": "Green" + } + } + }, + "size" : { + "label": "Size", + "values": { + "m": { + "label": "M" + }, + "l": { + "label": "L" + } + } + } + } +} +``` + +#### Product 2 variants +```json +[ + { + "variantId": "edbb59fb-f303-4970-9f03-889e71374a90", + "optionValueIds": [ + "747d8c9b-e5fc-437a-8263-271dd8352976:color/green", "747d8c9b-e5fc-437a-8263-271dd8352976:size/l" + ], + "productId": "7f4db047-604f-41ce-8998-a015f578e023" + }, + { + "variantId": "2c865d16-1723-49a3-8fd1-9b46613b5c12", + "optionValueIds": [ + "747d8c9b-e5fc-437a-8263-271dd8352976:color/red", "747d8c9b-e5fc-437a-8263-271dd8352976:size/m" + ], + "productId": "8eab9d67-791a-4c34-bc30-8bd034856ee2" + } +] +``` \ No newline at end of file From 095e5e1a6ad73d6e017b68dbe0affe8b18e9fd8b Mon Sep 17 00:00:00 2001 From: Anton Kaplia Date: Fri, 11 Sep 2020 14:16:19 -0500 Subject: [PATCH 327/479] added rpc --- .../catalog/product-options-and-variants.md | 44 +++++++++++++++++-- 1 file changed, 41 insertions(+), 3 deletions(-) diff --git a/design-documents/storefront/catalog/product-options-and-variants.md b/design-documents/storefront/catalog/product-options-and-variants.md index 859a3bda3..6e7fd2e06 100644 --- a/design-documents/storefront/catalog/product-options-and-variants.md +++ b/design-documents/storefront/catalog/product-options-and-variants.md @@ -324,6 +324,8 @@ As were mentioned previously, options belong to a product, full options list can Variants do not expose at the storefront but help to filter options after one or several variants were selected. + + Such behavior was recently [approved for configurable product](https://github.com/magento/architecture/pull/394). And since the most complex part of designing API was done the main thing we have to do in the scope of this chapter - generalize the behavior to support not only configurable products. @@ -334,7 +336,9 @@ With the response API has to return: * List of images & videos that should be used on PDP. * List of products that were exactly matched by the selected options. ```proto -message OptionSelection +syntax = "proto3"; + +message OptionSelectionRequest { repeated string values = 2; } @@ -344,9 +348,36 @@ message OptionResponse { repeated ProductVarinat matchedVariants = 3; } -service SearchService { +service OptionSearchService { rpc GetOptions(OptionSelection) returns (OptionResponse); } + +``` + +In the perfect world, variants should not appear at the presentation level. Still, the storefront lies under the presentation, so it has to provide a way to retrieve variants depends on the scenario efficiently. +So far, we can imagine the following cases: +* match the variants which correspond, and do not contradict, the merchant selection - such API. +* match the variants which exactly matched with merchant selection. +* get all variants which contain at least one of merchant selection. +* get all variants that belong to a product. This method is code-sugar for the previous one because all the product variants could be retrieved by using the previous method in case of passing all the options values which belong to the product. + +```proto +syntax = "proto3"; + +message VariantResponse { + repeated ProductVarinat matchedVariants = 3; +} + +message ProductRequest { + string productId = 1; +} + +service VaraintSearchService { + rpc GetVariantsMatch(OptionSelection) returns (VariantResponse); + rpc GetVariantsExactlyMatch(OptionSelection) returns (VariantResponse); + rpc GetVariantsInclude(OptionSelection) returns (VariantResponse); + rpc GetProductVariants(ProductRequest) returns (VariantResponse); +} ``` ## Proposal cross references @@ -470,4 +501,11 @@ on the manufacturer. proof https://www.walmart.com/search/?query=tshirt* "productId": "8eab9d67-791a-4c34-bc30-8bd034856ee2" } ] -``` \ No newline at end of file +``` + +## How to return all variants for the product + +*Comment: A client should never request all the variants within a single call +the number of such variants is unpredictable, +and could significantly affect store performance.* + From 3af89f24e105298d1e5f4f76fc9205cfa39cd55e Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Fri, 11 Sep 2020 14:16:26 -0500 Subject: [PATCH 328/479] Patching back updates from code reviews --- .../coverage/customer/Wishlist.graphqls | 46 +++++++++++++++++-- 1 file changed, 41 insertions(+), 5 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index ccd81d0d2..51f41c8d7 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -1,9 +1,12 @@ type Mutation { - createWishlist(name: String!): ID # Multiple wishlists Commerce functionality - removeWishlist(id: ID!): Boolean # Commerce fucntionality - in Opens Source we assume customer always has one wishlist + createWishlist(name: String!, visibility: WishlistVisibilityEnum!): CreateWishlistOutput # Multiple wishlists Commerce functionality + deleteWishlist(wishlistId: ID!): Boolean # Commerce fucntionality - in Opens Source we assume customer always has one wishlist addProductsToWishlist(wishlistId: ID!, wishlistItems: [WishlistItemInput!]!): AddProductsToWishlistOutput removeProductsFromWishlist(wishlistId: ID!, wishlistItemsIds: [ID!]!): RemoveProductsFromWishlistOutput updateProductsInWishlist(wishlistId: ID!, wishlistItems: [WishlistItemUpdateInput!]!): UpdateProductsInWishlistOutput + copyProductsToWishlist(wishlistId: ID!, wishlistItems: [WishlistItemCopyInput!]!): UpdateProductsInWishlistOutput @doc(description: "Copy a product to the wish list") + moveProductsToWishlist(wishlistId: ID!, wishlistItems: [WishlistItemMoveInput!]!): UpdateProductsInWishlistOutput @doc(description: "Move products from one wish list to another") + updateWishlist(wishlistId: ID!, name: String, visibility: WishlistVisibilityEnum): UpdateWishlistOutput @doc(description: "Change the name and visibility of the specified wish list") } type Customer { @@ -23,8 +26,9 @@ type Wishlist { } input WishlistItemUpdateInput { - wishlist_item_id: ID + wishlist_item_id: ID! quantity: Float + description: String selected_options: [ID!] entered_options: [EnteredOptionInput!] } @@ -42,8 +46,8 @@ type UpdateProductsInWishlistOutput { } input WishlistItemInput { - sku: String - quantity: Float + sku: String! + quantity: Float! parent_sku: String, parent_quantity: Float, selected_options: [ID!] @@ -88,3 +92,35 @@ type GiftCardWishlistItem implements WishlistItemInterface { message: String } +enum WishlistVisibilityEnum @doc(description: "This enumeration defines the wish list visibility types") { + PUBLIC + PRIVATE +} + +type CreateWishlistOutput { + uid: ID! @doc(description: "The ID of the new wish list") + name: String! @doc(description: "The wish list name") + visibility: WishlistVisibilityEnum! @doc(description: "The wish list visibility") +} + +input WishlistItemCopyInput { + wishlist_item_id: ID! @doc(description: "The ID of the item to be copied") + quantity: Float @doc(description: "The quantity of this item to copy to the destination wish list. This value can't be greater than the quantity in the source wish list.") +} + +input WishlistItemMoveInput { + wishlist_item_id: ID! @doc(description: "The ID of the item to be moved") + quantity: Float @doc(description: "The quantity of this item to move to the destination wish list. This value can't be greater than the quantity in the source wish list.") +} + +type UpdateWishlistOutput { + uid: ID! @doc(description: "The ID of the updated wish list") + name: String! @doc(description: "The wish list name") + visibility: WishlistVisibilityEnum! @doc(description: "The wish list visibility") +} + +type StoreConfig { + maximum_number_of_wishlists: String @doc(description: "If multiple wish lists are enabled, the maximum number of wish lists the customer can have") + enable_multiple_wishlists: String @doc(description: "Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No)") +} + From 6a8ab76efd17ebc03d875290ffc8e480fb48176e Mon Sep 17 00:00:00 2001 From: Anton Kaplia Date: Fri, 11 Sep 2020 14:17:18 -0500 Subject: [PATCH 329/479] added example --- .../storefront/catalog/product-options-and-variants.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/design-documents/storefront/catalog/product-options-and-variants.md b/design-documents/storefront/catalog/product-options-and-variants.md index 6e7fd2e06..85df9c959 100644 --- a/design-documents/storefront/catalog/product-options-and-variants.md +++ b/design-documents/storefront/catalog/product-options-and-variants.md @@ -509,3 +509,5 @@ on the manufacturer. proof https://www.walmart.com/search/?query=tshirt* the number of such variants is unpredictable, and could significantly affect store performance.* +@see `rpc:GetProductVariants` + From e9a6233d13aa5e11121ac4102267364c20813425 Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Fri, 19 Jun 2020 20:33:02 +0530 Subject: [PATCH 330/479] pagination to support entities in b2b --- .../graph-ql/coverage/cart/Cart.graphqls | 10 ++++++++++ .../customer-address-pagination-change.graphqls | 12 ++++++++++++ .../graph-ql/coverage/customer/customer-orders.md | 15 +++++++++++++++ 3 files changed, 37 insertions(+) create mode 100644 design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls diff --git a/design-documents/graph-ql/coverage/cart/Cart.graphqls b/design-documents/graph-ql/coverage/cart/Cart.graphqls index 556c3b411..7144f489a 100644 --- a/design-documents/graph-ql/coverage/cart/Cart.graphqls +++ b/design-documents/graph-ql/coverage/cart/Cart.graphqls @@ -14,6 +14,10 @@ type Cart { id: ID! @doc(description: "The ID of the cart.") @deprecated(reason: "use uid") uid: ID! @doc(description: "The unique ID of the cart.") items: [CartItemInterface] + items_v2( + currentPage: Int = 1 @doc(description: "current page of the customer cart items. default is 1") + pageSize: Int = 20 @doc(description: "page size for the customer cart items. default is 20") + ): CartItems! @doc(description: "collection of all the items purchased") applied_coupons: [AppliedCoupon] @doc(description:"An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. By default Magento supports only one coupon.") email: String shipping_addresses: [ShippingCartAddress]! @@ -25,6 +29,12 @@ type Cart { is_virtual: Boolean! } +type CartItems { + items: [CartItemInterface] @doc(description: "Cart items list") + page_info: SearchResultPageInfo + total_count: Int +} + type AvailablePaymentMethod { code: String! @doc(description: "The payment method code") title: String! @doc(description: "The payment method title.") diff --git a/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls b/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls new file mode 100644 index 000000000..767f291cd --- /dev/null +++ b/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls @@ -0,0 +1,12 @@ +type Customer { + addresses_v2( + currentPage: Int = 1 @doc(description: "current page of the customer address list. default is 1") + pageSize: Int = 10 @doc(description: "page size for the customer address list. default is 10") + ): CustomerAddresses +} + +type CustomerAddresses { + items: [CustomerAddress] @doc(description: "Customer Address List") + page_info: SearchResultPageInfo + total_count: Int +} diff --git a/design-documents/graph-ql/coverage/customer/customer-orders.md b/design-documents/graph-ql/coverage/customer/customer-orders.md index c11b40e04..db76985dc 100644 --- a/design-documents/graph-ql/coverage/customer/customer-orders.md +++ b/design-documents/graph-ql/coverage/customer/customer-orders.md @@ -68,6 +68,10 @@ type CustomerOrder { status: String! @doc("current status of the order") number: String! @doc("sequential order number") items: [OrderItemInterface] @doc("collection of all the items purchased") + items_v2( + currentPage: Int = 1 @doc("current page of the customer order item list. default is 1") + pageSize: Int = 20 @doc("page size for the customer orders item list. default is 20") + ): OrderItems! @doc("collection of all the items purchased with pagination") total: OrderTotal @doc("total amount details for the order") invoices: [Invoice] @doc("invoice list for the order") credit_memos: [CreditMemo] @doc("credit memo list for the order") @@ -86,6 +90,17 @@ The `id` will be a `base64_encode(increment_id)` which in future can be replaced > The order `status` should be filtered in the same way as for Luma via `Order Status` and `Visible On Storefront` configuration ### Order Item +The order items will be presented as separate interface which will have multiple implementations for invoice, shipment and credit memo types. +The order items will be paginated. + +```graphql +@doc("Grpahql Order Item Output Wrapper") +type OrderItems { + items: [OrderItem] @doc("collection of customer orders items that contains individual order item details.") + page_info: SearchResultPageInfo + total_count: Int +} +``` ```graphql interface OrderItemInterface @doc("Order item details") { From be489da52664ac06808ebef287282784162f67ec Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Wed, 5 Aug 2020 20:46:42 +0530 Subject: [PATCH 331/479] added deprecation notice --- .../graph-ql/coverage/cart/Cart.graphqls | 2 +- .../customer-address-pagination-change.graphqls | 2 ++ .../graph-ql/coverage/customer/Wishlist.graphqls | 14 ++++++++++++-- .../graph-ql/coverage/customer/customer-orders.md | 2 +- 4 files changed, 16 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/cart/Cart.graphqls b/design-documents/graph-ql/coverage/cart/Cart.graphqls index 7144f489a..75fa53dd4 100644 --- a/design-documents/graph-ql/coverage/cart/Cart.graphqls +++ b/design-documents/graph-ql/coverage/cart/Cart.graphqls @@ -13,7 +13,7 @@ type CartQueryOutput { type Cart { id: ID! @doc(description: "The ID of the cart.") @deprecated(reason: "use uid") uid: ID! @doc(description: "The unique ID of the cart.") - items: [CartItemInterface] + items: [CartItemInterface] @deprecated(reason: "The `items` field is deprecated. Use `items_v2` instead.") items_v2( currentPage: Int = 1 @doc(description: "current page of the customer cart items. default is 1") pageSize: Int = 20 @doc(description: "page size for the customer cart items. default is 20") diff --git a/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls b/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls index 767f291cd..1dd8f7167 100644 --- a/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls +++ b/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls @@ -1,4 +1,6 @@ +# type Customer { + addresses: CustomerAddresses @deprecated(reason: "The `address` field is deprecated. Use `addresses_v2` instead.") addresses_v2( currentPage: Int = 1 @doc(description: "current page of the customer address list. default is 1") pageSize: Int = 10 @doc(description: "page size for the customer address list. default is 10") diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index ccd81d0d2..8be8ec69a 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -14,14 +14,24 @@ type Customer { type Wishlist { id: ID - items: [WishlistItem] @deprecated(reason: "Use field `items_v2` from type `Wishlist` instead") - items_v2: [WishlistItemInterface] @doc(description: "An array of items in the customer's wishlist") + items: [WishlistItem] @deprecated(reason: "Use field `items_v3` from type `Wishlist` instead") + items_v2: [WishlistItemInterface] @doc(description: "An array of items in the customer's wishlist") @deprecated(reason: "Use field `items_v3` from type `Wishlist` instead") + items_v3( + currentPage: Int = 1 @doc(description: "current page of the customer wishlist items. default is 1") + pageSize: Int = 20 @doc(description: "page size for the customer wishlist items. default is 20") + ): WishlistItems @doc(description: "An array of items in the customer's wishlist") items_count: Int sharing_code: String updated_at: String name: String @doc(description: "Avaialble in Commerce edition only") } +type WishlistItems { + items: [WishlistItemInterface] + page_info: SearchResultPageInfo + total_count: Int +} + input WishlistItemUpdateInput { wishlist_item_id: ID quantity: Float diff --git a/design-documents/graph-ql/coverage/customer/customer-orders.md b/design-documents/graph-ql/coverage/customer/customer-orders.md index db76985dc..8395814c1 100644 --- a/design-documents/graph-ql/coverage/customer/customer-orders.md +++ b/design-documents/graph-ql/coverage/customer/customer-orders.md @@ -67,7 +67,7 @@ type CustomerOrder { order_date: String! @doc("date when the order was placed") status: String! @doc("current status of the order") number: String! @doc("sequential order number") - items: [OrderItemInterface] @doc("collection of all the items purchased") + items: [OrderItemInterface] @doc("collection of all the items purchased") @deprecated("The `items` field is derecated. Use `items_v2` instead.") items_v2( currentPage: Int = 1 @doc("current page of the customer order item list. default is 1") pageSize: Int = 20 @doc("page size for the customer orders item list. default is 20") From b28e9220ab0270e9474462c16a9d739ecc405bde Mon Sep 17 00:00:00 2001 From: Igor Melnikov Date: Tue, 8 Sep 2020 16:50:46 -0500 Subject: [PATCH 332/479] Apply suggestions from code review --- design-documents/graph-ql/coverage/cart/Cart.graphqls | 6 +++--- .../coverage/customer-address-pagination-change.graphqls | 4 ++-- .../graph-ql/coverage/customer/customer-orders.md | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/design-documents/graph-ql/coverage/cart/Cart.graphqls b/design-documents/graph-ql/coverage/cart/Cart.graphqls index 75fa53dd4..e50fdf455 100644 --- a/design-documents/graph-ql/coverage/cart/Cart.graphqls +++ b/design-documents/graph-ql/coverage/cart/Cart.graphqls @@ -17,7 +17,7 @@ type Cart { items_v2( currentPage: Int = 1 @doc(description: "current page of the customer cart items. default is 1") pageSize: Int = 20 @doc(description: "page size for the customer cart items. default is 20") - ): CartItems! @doc(description: "collection of all the items purchased") + ): CartItems! @doc(description: "Cart items") applied_coupons: [AppliedCoupon] @doc(description:"An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. By default Magento supports only one coupon.") email: String shipping_addresses: [ShippingCartAddress]! @@ -30,9 +30,9 @@ type Cart { } type CartItems { - items: [CartItemInterface] @doc(description: "Cart items list") + items: [CartItemInterface]! @doc(description: "Cart items list") page_info: SearchResultPageInfo - total_count: Int + total_count: Int! } type AvailablePaymentMethod { diff --git a/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls b/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls index 1dd8f7167..ad0e4abde 100644 --- a/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls +++ b/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls @@ -8,7 +8,7 @@ type Customer { } type CustomerAddresses { - items: [CustomerAddress] @doc(description: "Customer Address List") + items: [CustomerAddress]! @doc(description: "List of customer address") page_info: SearchResultPageInfo - total_count: Int + total_count: Int! } diff --git a/design-documents/graph-ql/coverage/customer/customer-orders.md b/design-documents/graph-ql/coverage/customer/customer-orders.md index 8395814c1..6472608fe 100644 --- a/design-documents/graph-ql/coverage/customer/customer-orders.md +++ b/design-documents/graph-ql/coverage/customer/customer-orders.md @@ -71,7 +71,7 @@ type CustomerOrder { items_v2( currentPage: Int = 1 @doc("current page of the customer order item list. default is 1") pageSize: Int = 20 @doc("page size for the customer orders item list. default is 20") - ): OrderItems! @doc("collection of all the items purchased with pagination") + ): OrderItems! @doc("Collection of all of the purchased items") total: OrderTotal @doc("total amount details for the order") invoices: [Invoice] @doc("invoice list for the order") credit_memos: [CreditMemo] @doc("credit memo list for the order") @@ -96,9 +96,9 @@ The order items will be paginated. ```graphql @doc("Grpahql Order Item Output Wrapper") type OrderItems { - items: [OrderItem] @doc("collection of customer orders items that contains individual order item details.") + items: [OrderItem]! @doc("List of orders items") page_info: SearchResultPageInfo - total_count: Int + total_count: Int! } ``` From 4224d7e9ac631c4b92d2e11009e0b0aac7ae07a7 Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Sat, 12 Sep 2020 19:53:50 +0530 Subject: [PATCH 333/479] Update design-documents/graph-ql/coverage/customer/Wishlist.graphqls --- .../graph-ql/coverage/customer/Wishlist.graphqls | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index 8be8ec69a..99911703f 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -27,9 +27,9 @@ type Wishlist { } type WishlistItems { - items: [WishlistItemInterface] + items: [WishlistItemInterface]! page_info: SearchResultPageInfo - total_count: Int + total_count: Int! } input WishlistItemUpdateInput { @@ -97,4 +97,3 @@ type GiftCardWishlistItem implements WishlistItemInterface { amount: SelectedGiftCardAmount message: String } - From 8e91fe84d9fd2d4550c13e8bf0ce14e84c23e1fa Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Sat, 12 Sep 2020 19:55:02 +0530 Subject: [PATCH 334/479] Update design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls --- .../coverage/customer-address-pagination-change.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls b/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls index ad0e4abde..1c5092faa 100644 --- a/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls +++ b/design-documents/graph-ql/coverage/customer-address-pagination-change.graphqls @@ -4,7 +4,7 @@ type Customer { addresses_v2( currentPage: Int = 1 @doc(description: "current page of the customer address list. default is 1") pageSize: Int = 10 @doc(description: "page size for the customer address list. default is 10") - ): CustomerAddresses + ): CustomerAddresses! } type CustomerAddresses { From e454a7da8a5cd156e92f1b09621beb2b549b3152 Mon Sep 17 00:00:00 2001 From: Christopher Daniel Date: Sat, 12 Sep 2020 19:56:10 +0530 Subject: [PATCH 335/479] Update design-documents/graph-ql/coverage/customer/Wishlist.graphqls --- design-documents/graph-ql/coverage/customer/Wishlist.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index 99911703f..dae7e020a 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -19,7 +19,7 @@ type Wishlist { items_v3( currentPage: Int = 1 @doc(description: "current page of the customer wishlist items. default is 1") pageSize: Int = 20 @doc(description: "page size for the customer wishlist items. default is 20") - ): WishlistItems @doc(description: "An array of items in the customer's wishlist") + ): WishlistItems! @doc(description: "An array of items in the customer's wishlist") items_count: Int sharing_code: String updated_at: String From 4f28fde7aa0e24b6e0b834cd35591637b40f60b6 Mon Sep 17 00:00:00 2001 From: Anton Kaplia Date: Tue, 15 Sep 2020 12:37:54 -0500 Subject: [PATCH 336/479] review fixes --- .../storefront/catalog/product-options-and-variants.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/design-documents/storefront/catalog/product-options-and-variants.md b/design-documents/storefront/catalog/product-options-and-variants.md index 85df9c959..e928d88ff 100644 --- a/design-documents/storefront/catalog/product-options-and-variants.md +++ b/design-documents/storefront/catalog/product-options-and-variants.md @@ -122,7 +122,7 @@ message ProductOption { } message ProductVariant { - repeated string optionValueId = 1; + repeated string optionValues = 1; string id = 2; string productId = 3; string productIdentifierInPricing = 500; #* @@ -340,6 +340,7 @@ syntax = "proto3"; message OptionSelectionRequest { + string storeViewId = 1; repeated string values = 2; } message OptionResponse { @@ -363,13 +364,14 @@ So far, we can imagine the following cases: ```proto syntax = "proto3"; - +productId message VariantResponse { repeated ProductVarinat matchedVariants = 3; } message ProductRequest { string productId = 1; + string storeViewId = 2; } service VaraintSearchService { From 52e8c18419a1577bc47a2a383a9bc2a9bf575708 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Tue, 15 Sep 2020 16:00:50 -0500 Subject: [PATCH 337/479] Update compare-list.graphqls --- .../graph-ql/coverage/catalog/compare-list.graphqls | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index 816e1cbb6..0703889b5 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -20,7 +20,7 @@ type CompareList { } type Customer { - compareList(uid: ID): [CompareList] @doc(description: "Active customers compare list") #id is optional. Introduces the possibility of more than 1 compare list. + compare_list: CompareList @doc(description: "Active customers compare list") } type Query { @@ -37,12 +37,12 @@ type Mutation { uid: ID!, items: [ID!] ): CompareList - assignCompareListToCustomer(customerId: ID!, uid: ID!): Boolean! + assignCompareListToCustomer(uid: ID!): CompareList deleteCompareList(uid: ID!): Boolean! } input CreateCompareListInput { - items: [ID!] + products: [ID!] } schema { From 5ca38b94e8851ae2829c81861897ab17cdb739db Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Tue, 15 Sep 2020 17:51:10 -0500 Subject: [PATCH 338/479] Update compare-list.md --- .../graph-ql/coverage/catalog/compare-list.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.md b/design-documents/graph-ql/coverage/catalog/compare-list.md index b59a92162..7fbb657fb 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.md +++ b/design-documents/graph-ql/coverage/catalog/compare-list.md @@ -18,7 +18,7 @@ Use createCompareList mutation to create a new compare list. The server should c } ``` * For a guest user, new list will be created -* For a logged in user, exisiting list_id will be returned (Can be extended in future ee - to support multiple compare list per customer) +* For a logged in user, exisiting list_id will be returned ```graphql @@ -33,7 +33,7 @@ Use createCompareList mutation to create a new compare list. The server should c { query { customer { - compare_list(id) { # id filter is optional. Will return an array of compare lists (Future extensibility) + compare_list { list_id items { sku @@ -46,7 +46,7 @@ Use createCompareList mutation to create a new compare list. The server should c * If the registered customer does not have an active list then null will be returned. ``` -assignCompareListToCustomer(customerId: ID!, listId: ID!): CompareList +assignCompareListToCustomer(uid: ID!): CompareList ``` mutation can be used to assign a guest compare list to a registered customer. @@ -112,16 +112,15 @@ catalog_compare_item | catalog_compare_item_id | visitor_id | customer_id | product_id | store_id | ============================================================================== ``` -The visitor_id (non nullable) is tied to session \Magento\Customer\Model\Visitor in Luma. GraphQl layer should not be tied to Luma's session. So Compare-lists via GraphQl will have to differ/deviate from Luma. This dependency can be solved by managing the compare list state in a new table ``` catalog_compare_list ------------------------------------------------------------------------------ -| entity_id (int) (primary)| customer_id (int) (nullable)(indexed)| product_ids (json) (non nullable)| store_id (int) (non nullable)| last_modfied (date) | additional_data (json) (nullable) +| list_id (varchar) (primary)| additional_data (json) (nullable) ============================================================================== ``` -* On first client request, a row will be populated with an entity_id, server generated masked_id, customer_id (? if logged in), product_id and store_id. -* encoded entity_id will be used for client communications -* product_ids is a json field for reducing storage complexity. -* introducing entity_id for the list will enable customers to have more than one compare list (future extensibility) + +and adding list_id field to catalog_compare_item table. + +* encoded list_id will be used for client communications From 8cf881a254ee648470819428c71fafa1dd27c7bf Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 16 Sep 2020 13:47:24 -0500 Subject: [PATCH 339/479] Update compare-list.md --- design-documents/graph-ql/coverage/catalog/compare-list.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.md b/design-documents/graph-ql/coverage/catalog/compare-list.md index 7fbb657fb..6e70dcd1b 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.md +++ b/design-documents/graph-ql/coverage/catalog/compare-list.md @@ -103,13 +103,13 @@ preconfigured at the backoffice. Guest compare list business logic not implemented yet. Additional development required. -## Current limitations +## DB changes -Existing table structure for compare list +To the existing table structure for compare list, list_id will be added ``` catalog_compare_item ------------------------------------------------------------------------------ -| catalog_compare_item_id | visitor_id | customer_id | product_id | store_id | +| catalog_compare_item_id | visitor_id | customer_id | product_id | store_id | list_id ============================================================================== ``` @@ -124,3 +124,4 @@ catalog_compare_list and adding list_id field to catalog_compare_item table. * encoded list_id will be used for client communications +* For the visitor ids created via GrahQl session will be null. From b6e841a25d83d5681279d0e2440d47c0e6f43e55 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 16 Sep 2020 15:19:29 -0500 Subject: [PATCH 340/479] Update compare-list.graphqls --- .../coverage/catalog/compare-list.graphqls | 31 ++++++++++++------- 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index 0703889b5..1648afb52 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -29,23 +29,30 @@ type Query { type Mutation { createCompareList(input: CreateCompareListInput): CompareList @doc(description: "Creates a new compare list. For a logged in user, the created list is assigned to the user") - addItemsToCompareList( - uid: ID!, - items: [ID!] + addProductsToCompareList( + input: AddProductsToCompareListInput ): CompareList - removeItemsFromCompareList( - uid: ID!, - items: [ID!] + removeProductsFromCompareList( + input: RemoveProductsFromCompareListInput ): CompareList - assignCompareListToCustomer(uid: ID!): CompareList - deleteCompareList(uid: ID!): Boolean! + assignCompareListToCustomer(uid: ID!): CompareList # Customer token needs to be passed + deleteCompareList(uid: ID!): DeleteCompareListOutput } input CreateCompareListInput { - products: [ID!] + products: [ID!]! } -schema { - query: Query, - mutation: Mutation +input AddProductsToCompareListInput { + uid: ID!, + products: [ID!]! +} + +input RemoveProductsFromCompareListInput { + uid: ID!, + products: [ID!]! +} + +type DeleteCompareListOutput { + result: Boolean! } From 28fd8920cf018fe7da18894b2b804159c4c16c9c Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 16 Sep 2020 15:23:41 -0500 Subject: [PATCH 341/479] Update compare-list.graphqls --- .../graph-ql/coverage/catalog/compare-list.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index 1648afb52..a35858b57 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -40,7 +40,7 @@ type Mutation { } input CreateCompareListInput { - products: [ID!]! + products: [ID!] } input AddProductsToCompareListInput { From b5ac23de2bc5dc2d738538a0f4939189bfd4669f Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 16 Sep 2020 15:24:00 -0500 Subject: [PATCH 342/479] Update compare-list.md --- .../graph-ql/coverage/catalog/compare-list.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.md b/design-documents/graph-ql/coverage/catalog/compare-list.md index 6e70dcd1b..d5f4fecfb 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.md +++ b/design-documents/graph-ql/coverage/catalog/compare-list.md @@ -8,7 +8,9 @@ Use createCompareList mutation to create a new compare list. The server should c ```graphql { mutation { - createCompareList(items: ["100123", "234567", "874321"]) #items optional + createCompareList(input: { + products: ["123", "456"] + }) #products optional } { list_id items { @@ -117,11 +119,11 @@ This dependency can be solved by managing the compare list state in a new table ``` catalog_compare_list ------------------------------------------------------------------------------ -| list_id (varchar) (primary)| additional_data (json) (nullable) +| list_id (varchar) (primary)| visitor_id | customer_id ============================================================================== ``` and adding list_id field to catalog_compare_item table. -* encoded list_id will be used for client communications -* For the visitor ids created via GrahQl session will be null. +* encoded list_id will be used for client communications # \Magento\Framework\Math\Random::getUniqueHash can be used for hashes +* For visitorsa created via GraphQl, session will be null. From 036a5f2e5e67f081a4f601ba83eedb89b3f18092 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 16 Sep 2020 15:24:19 -0500 Subject: [PATCH 343/479] Update compare-list.md --- design-documents/graph-ql/coverage/catalog/compare-list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.md b/design-documents/graph-ql/coverage/catalog/compare-list.md index d5f4fecfb..678f478bc 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.md +++ b/design-documents/graph-ql/coverage/catalog/compare-list.md @@ -126,4 +126,4 @@ catalog_compare_list and adding list_id field to catalog_compare_item table. * encoded list_id will be used for client communications # \Magento\Framework\Math\Random::getUniqueHash can be used for hashes -* For visitorsa created via GraphQl, session will be null. +* For visitors created via GraphQl, session will be null. From a42b1469095b94e1406bab7318f8b482c60b1a86 Mon Sep 17 00:00:00 2001 From: rakesh Date: Tue, 22 Sep 2020 19:18:22 +0530 Subject: [PATCH 344/479] uid and label changes --- .../coverage/b2b/negotiableQuotes.graphqls | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 4684bbbcb..71ad69b77 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -4,12 +4,12 @@ type Query { # in a company can see quotes belonging to their # employees. If `Customer.negotiable_quotes` is desirable for buyer's # that aren't managers, we can always add that on - negotiableQuote(iud: ID!): NegotiableQuote @doc(description: "Get a buyer's NegotiableQuote by ID") + negotiableQuote(uid: ID!): NegotiableQuote @doc(description: "Get a buyer's negotiable quote by ID") negotiableQuotes( filter: NegotiableQuoteFilterInput, pageSize: Int = 20, currentPage: Int = 1 - ): NegotiableQuotesOutput @doc(description: "A (optionally filtered) list of Negotiable Quotes viewable by the logged-in customer") + ): NegotiableQuotesOutput @doc(description: "A (optionally filtered) list of negotiable quotes viewable by the logged-in customer") } type NegotiableQuotesOutput { @@ -25,17 +25,17 @@ type Mutation { # https://docs.magento.com/user-guide/sales/quote-request.html requestNegotiableQuote( input: RequestNegotiableQuoteInput! - ): RequestNegotiableQuoteOutput @doc(description: "Request a new Negotiable Quote for a buyer") + ): RequestNegotiableQuoteOutput @doc(description: "Request a new negotiable quote for a buyer") # Covers "Add your Comment" section of https://docs.magento.com/user-guide/customers/account-dashboard-quotes-negotiate.html#shipping-information addNegotiableQuoteComment( input: AddNegotiableQuoteCommentInput! - ): AddNegotiableQuoteCommentOutput @doc(description: "Append a new comment from the buyer to a Negotiable Quote") + ): AddNegotiableQuoteCommentOutput @doc(description: "Append a new comment from the buyer to a negotiable quote") # https://docs.magento.com/user-guide/customers/account-dashboard-quotes-negotiate.html#change-the-quantity updateNegotiableQuoteQuantities( input: UpdateNegotiableQuoteQuantitiesInput! - ): UpdateNegotiableQuoteItemsQuantityOutput @doc(description: "Change the quantity of 1 or more items already in a NegotiableQuote") + ): UpdateNegotiableQuoteItemsQuantityOutput @doc(description: "Change the quantity of 1 or more items already in a negotiable quote") # Covers "Delete Line Item" section of https://docs.magento.com/user-guide/customers/account-dashboard-quotes-negotiate.html#tabbed-sections removeNegotiableQuoteItems( @@ -45,18 +45,18 @@ type Mutation { # Covers first half of https://docs.magento.com/user-guide/customers/account-dashboard-quotes.html#cancel-a-quote-request closeNegotiableQuotes( input: CloseNegotiableQuotesInput! - ): CloseNegotiableQuotesOutput @doc(description: "Mark a Negotiable Quote as closed, leaving it visible in the storefront") + ): CloseNegotiableQuotesOutput @doc(description: "Mark a negotiable quote as closed, leaving it visible in the storefront") # Covers second half of https://docs.magento.com/user-guide/customers/account-dashboard-quotes.html#cancel-a-quote-request deleteNegotiableQuotes( input: DeleteNegotiableQuotesInput! - ): DeleteNegotiableQuotesOutput @doc(description: "Delete a Negotiable Quote, removing it from the display in the storefront") + ): DeleteNegotiableQuotesOutput @doc(description: "Delete a negotiable quote, removing it from the display in the storefront") # Covers "Select Existing Address" in https://docs.magento.com/user-guide/customers/account-dashboard-quotes-negotiate.html#shipping-information # "New Address" flow is covered by Mutation.createCustomerAddress setNegotiableQuoteShippingAddress( input: SetNegotiableQuoteShippingAddressInput! - ): SetNegotiableQuoteShippingAddressOutput @doc(description: "Assign one of buyers' existing addresses to a Negotiable Quote") + ): SetNegotiableQuoteShippingAddressOutput @doc(description: "Assign one of buyers' existing addresses to a negotiable quote") # Pending decision on design of file upload (design doc still pending decisions) # addNegotiableQuoteFiles( @@ -85,14 +85,14 @@ type SetNegotiableQuoteShippingAddressOutput { } input AddNegotiableQuoteItemsInput { - quote_id: ID! @doc(description: "ID from a NegotiableQuote object") + quote_id: ID! @doc(description: "ID from a negotiable quote object") # Implementation Note: This *should* be compatible with the new, single # add to cart mutation. https://github.com/magento/architecture/blob/master/design-documents/graph-ql/coverage/AddProductsToCart.graphqls cart_items: [CartItemInput!]! } input DeleteNegotiableQuotesInput { - quote_ids: [ID!]! @doc(description: "A List of IDs obtained from NegotiableQuote types") + quote_ids: [ID!]! @doc(description: "A List of IDs obtained from negotiable quote types") } type DeleteNegotiableQuotesOutput { @@ -107,7 +107,7 @@ type DeleteNegotiableQuotesOutput { } input CloseNegotiableQuotesInput { - quote_ids: [ID!]! @doc(description: "A List of IDs from NegotiableQuote objects") + quote_ids: [ID!]! @doc(description: "A List of IDs from negotiable quote objects") } type CloseNegotiableQuotesOutput { @@ -117,7 +117,7 @@ type CloseNegotiableQuotesOutput { filter: NegotiableQuoteFilterInput, pageSize: Int = 20, currentPage: Int = 1 - ): NegotiableQuotesOutput @doc(description: "A (optionally filtered) list of Negotiable Quotes viewable by the logged-in customer") + ): NegotiableQuotesOutput @doc(description: "A (optionally filtered) list of negotiable quotes viewable by the logged-in customer") } input RemoveNegotiableQuoteItemsInput { @@ -195,8 +195,8 @@ enum NegotiableQuoteStatus { } input NegotiableQuoteFilterInput { - ids: FilterEqualTypeInput @doc(description: "Filter by Negotiable Quote ID(s)") - name: FilterMatchTypeInput @doc(description: "Filter by Negotiable Quote name") + ids: FilterEqualTypeInput @doc(description: "Filter by negotiable quote ID(s)") + name: FilterMatchTypeInput @doc(description: "Filter by negotiable quote name") } type NegotiableQuoteHistoryEntry { @@ -238,8 +238,8 @@ type NegotiableQuoteHistoryChanges { # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L40-L73 type NegotiableQuoteHistoryStatusChange { - old_status: NegotiableQuoteStatus @doc(description: "Will be null for the first history entry on a Negotiable Quote") - new_status: NegotiableQuoteStatus! @doc(description: "Negotiable Quote History New Status.") + old_status: NegotiableQuoteStatus @doc(description: "Will be null for the first history entry on a negotiable quote") + new_status: NegotiableQuoteStatus! @doc(description: "Negotiable quote history new status.") } # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L48 @@ -276,8 +276,8 @@ type NegotiableQuoteHistoryProductsChange { # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L132-L146 type NegotiableQuoteHistoryProductsRemovedChange { # Open Question: Should `removed_from_catalog` ID type represent the SKU or the product id? - removed_from_catalog: [ID!] @doc(description: "List of product skus removed from Seller's catalog") - removed_from_quote: [ProductInterface!] @doc(description: "List of products removed by a Buyer or Seller") + removed_from_catalog: [ID!] @doc(description: "List of product skus removed from seller's catalog") + removed_from_quote: [ProductInterface!] @doc(description: "List of products removed by a buyer or seller") } # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L148-L169 @@ -323,7 +323,7 @@ type UpdateNegotiableQuoteItemsQuantityOutput { # Implementation Note: We don't want to expose the `Customer` object of the Seller to the client, and we don't # have much of a permissions model in the storefront to limit access by field. We're using a limited view # instead, excluding the ID because a Seller's ID shouldn't be exposed to the client. -type NegotiableQuoteUser @doc(description: "A limited view of a Buyer or Seller in the Negotiable Quote Process") { +type NegotiableQuoteUser @doc(description: "A limited view of a Buyer or Seller in the negotiable quote process") { firstname: String! lastname: String! } From 8aa0649e54dfc5150b41484b4cff6a60eb8434be Mon Sep 17 00:00:00 2001 From: Igor Melnikov Date: Tue, 22 Sep 2020 14:58:24 -0500 Subject: [PATCH 345/479] Apply suggestions from code review --- design-documents/graph-ql/coverage/b2b/company-credit.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/company-credit.md b/design-documents/graph-ql/coverage/b2b/company-credit.md index 89b52c06a..bd87e7d56 100644 --- a/design-documents/graph-ql/coverage/b2b/company-credit.md +++ b/design-documents/graph-ql/coverage/b2b/company-credit.md @@ -22,7 +22,7 @@ type CompanyCreditOperation { type: CompanyCreditOperationType! @doc(description: "The type of the company credit operation") amount: Money @doc(description: "The amount fo the company credit operation") balance: CompanyCredit! @doc(description: "Credit balance after the company credit operation") - custom_reference_number: String @doc(description: "Purchase order number associated with the company credit operation") + custom_reference_number: String @doc(description: "Custom reference number associated with the company credit operation") updated_by: CompanyCreditOperationUser! @doc(description: "The user submitting the company credit operation") } @@ -53,7 +53,7 @@ enum CompanyCreditOperationUserType { input CompanyCreditHistoryFilterInput { operation_type: CompanyCreditOperationType @doc(description: "Enum filter by the type of the company credit operation") - custom_reference_number: String @doc(description: "Free text filter by the purchase order number associated with the company credit operation") + custom_reference_number: String @doc(description: "Free text filter by the custom reference number associated with the company credit operation") updated_by: String @doc(description: "Free text filter by the name of the person submitting the company credit operation") } ###### End: Defining new types ###### @@ -61,4 +61,3 @@ input CompanyCreditHistoryFilterInput { ``` - From f0ed46489a73206b992cafb511ff444375454dfa Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Thu, 1 Oct 2020 11:20:31 -0500 Subject: [PATCH 346/479] Add missing uids to the types and validate optional/required fields --- design-documents/graph-ql/coverage/b2b/company-credit.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/b2b/company-credit.md b/design-documents/graph-ql/coverage/b2b/company-credit.md index bd87e7d56..2f5148598 100644 --- a/design-documents/graph-ql/coverage/b2b/company-credit.md +++ b/design-documents/graph-ql/coverage/b2b/company-credit.md @@ -14,10 +14,11 @@ type Company { type CompanyCreditHistory { items: [CompanyCreditOperation]! @doc(description: "An array of company credit operations") page_info: SearchResultPageInfo! @doc(description: "Metadata for pagination rendering") - total_count: Int @doc(description: "The number of the company credit operations matching the specified filter") + total_count: Int! @doc(description: "The number of the company credit operations matching the specified filter") } type CompanyCreditOperation { + uid: ID! @doc(description: "Unique identifier") date: String! @doc(description: "The date of the company credit operation") type: CompanyCreditOperationType! @doc(description: "The type of the company credit operation") amount: Money @doc(description: "The amount fo the company credit operation") From 3620b9b544ea9e25338d8bff5475c009f149730f Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Thu, 1 Oct 2020 11:41:53 -0500 Subject: [PATCH 347/479] Add missing uids to the types and validate optional/required fields --- design-documents/graph-ql/coverage/b2b/company-credit.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/company-credit.md b/design-documents/graph-ql/coverage/b2b/company-credit.md index 2f5148598..e04c7ffde 100644 --- a/design-documents/graph-ql/coverage/b2b/company-credit.md +++ b/design-documents/graph-ql/coverage/b2b/company-credit.md @@ -13,7 +13,7 @@ type Company { ###### Begin: Defining new types ###### type CompanyCreditHistory { items: [CompanyCreditOperation]! @doc(description: "An array of company credit operations") - page_info: SearchResultPageInfo! @doc(description: "Metadata for pagination rendering") + page_info: SearchResultPageInfo @doc(description: "Metadata for pagination rendering") total_count: Int! @doc(description: "The number of the company credit operations matching the specified filter") } @@ -21,7 +21,7 @@ type CompanyCreditOperation { uid: ID! @doc(description: "Unique identifier") date: String! @doc(description: "The date of the company credit operation") type: CompanyCreditOperationType! @doc(description: "The type of the company credit operation") - amount: Money @doc(description: "The amount fo the company credit operation") + amount: Money! @doc(description: "The amount fo the company credit operation") balance: CompanyCredit! @doc(description: "Credit balance after the company credit operation") custom_reference_number: String @doc(description: "Custom reference number associated with the company credit operation") updated_by: CompanyCreditOperationUser! @doc(description: "The user submitting the company credit operation") From 9618c91f61661ef3c6e084e47263be1e0985d848 Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Fri, 2 Oct 2020 12:29:30 -0500 Subject: [PATCH 348/479] Fix naming conventions and optional/required fields --- .../graph-ql/coverage/b2b/company.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/company.md b/design-documents/graph-ql/coverage/b2b/company.md index c1e377ccb..8563c9d9c 100644 --- a/design-documents/graph-ql/coverage/b2b/company.md +++ b/design-documents/graph-ql/coverage/b2b/company.md @@ -24,7 +24,7 @@ type Company @doc(description: "Company entity output data schema.") { name: String @doc(description: "Company name.") email: String @doc(description: "Company email address.") legal_name: String @doc(description: "Company legal name.") - vat_id: String @doc(description: "Company VAT/TAX id.") + vat_tax_id: String @doc(description: "Company VAT/TAX id.") reseller_id: String @doc(description: "Company re-seller id.") legal_address: CompanyLegalAddress @doc(description: "Company legal address.") company_admin: Customer @doc(description: "An object containing information about Company Administrator.") @@ -74,14 +74,14 @@ type CompanySalesRepresentative @doc(description: "Company sales representative } type CompanyUsers @doc(description: "Output data schema for an object returned by a Company users search query.") { - items: [Customer] @doc(description: "An array of 'CompanyUser' objects that match the specified search criteria.") - total_count: Int @doc(description: "The number of objects returned.") + items: [Customer]! @doc(description: "An array of 'CompanyUser' objects that match the specified search criteria.") + total_count: Int! @doc(description: "The number of objects returned.") page_info: SearchResultPageInfo @doc(description: "Pagination meta data.") } type CompanyRoles @doc(description: "Output data schema for an object returned by a Company roles search query.") { - items: [CompanyRole] @doc(description: "A list of company roles that match the specified search criteria.") - total_count: Int @doc(description: "The total number of objects matching the specified filter.") + items: [CompanyRole]! @doc(description: "A list of company roles that match the specified search criteria.") + total_count: Int! @doc(description: "The total number of objects matching the specified filter.") page_info: SearchResultPageInfo @doc(description: "Pagination meta data.") } @@ -95,24 +95,24 @@ type CompanyRole @doc(description: "Company role output data schema returned in type CompanyAclResource @doc(description: "Output data schema for an object with Role permission resource information.") { uid: ID! @doc(description: "ACL resource id.") text: String @doc(description: "ACL resource label.") - sortOrder: Int @doc(description: "ACL resource sort order.") + sort_order: Int @doc(description: "ACL resource sort order.") children: [CompanyAclResource!] @doc(description: "An array of sub-resources.") } type CompanyRoleNameCheckResponse @doc(description: "Response object schema for a role name validation query.") { - isNameValid: Boolean @doc(description: "Role name validation result") + is_name_valid: Boolean @doc(description: "Role name validation result") } type CompanyUserEmailCheckResponse @doc(description: "Response object schema for a Company User email validation query.") { - isEmailValid: Boolean @doc(description: "Email validation result") + is_email_valid: Boolean @doc(description: "Email validation result") } type CompanyAdminEmailCheckResponse @doc(description: "Response object schema for a Company Admin email validation query.") { - isEmailValid: Boolean @doc(description: "Email validation result") + is_email_valid: Boolean @doc(description: "Email validation result") } type CompanyEmailCheckResponse @doc(description: "Response object schema for a Company email validation query.") { - isEmailValid: Boolean @doc(description: "Email validation result") + is_email_valid: Boolean @doc(description: "Email validation result") } union CompanyStructureEntity = CompanyTeam | Customer From 2a42ae5d8731e09d5ec0bd3fa6ef0ee8ba0f563a Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Tue, 6 Oct 2020 15:38:27 -0500 Subject: [PATCH 349/479] Enabling adding gift registrants while creating gift registry --- .../graph-ql/coverage/customer/gift-registry.graphqls | 1 + 1 file changed, 1 insertion(+) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index 9efa70f2d..7a1d01681 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -86,6 +86,7 @@ input CreateGiftRegistryInput { privacy_settings: GiftRegistryPrivacySettings! status: GiftRegistryStatus! shipping_address: GiftRegistryShippingAddressInput + registrants: [AddGiftRegistryRegistrantInput!]! dynamic_attributes: [GiftRegistryDynamicAttributeInput] } From fdc1665dcbe7002114fdcc511c15b3f37f42dba4 Mon Sep 17 00:00:00 2001 From: Ji Lu Date: Wed, 7 Oct 2020 11:04:25 -0500 Subject: [PATCH 350/479] MQE-2298: Move and update test BIC document to DevDocs --- ...oning-and-backward-compatibility-policy.md | 119 +----------------- 1 file changed, 2 insertions(+), 117 deletions(-) diff --git a/design-documents/testing/functional/versioning-and-backward-compatibility-policy.md b/design-documents/testing/functional/versioning-and-backward-compatibility-policy.md index 526965ee2..246a2f6c3 100644 --- a/design-documents/testing/functional/versioning-and-backward-compatibility-policy.md +++ b/design-documents/testing/functional/versioning-and-backward-compatibility-policy.md @@ -1,119 +1,4 @@ # Magento MFTF test versioning and backward compatibility policy - -## Goals and requirements -1. Release MFTF tests as a separate magento package on repo.magento.com. -2. Define the versioning strategy for MFTF test packages. -3. Outline what is considered a backward incompatible change to MFTF tests. -4. List of what should be implemented. - -## Backwards compatibility definition for MFTF tests - -When a test undergoes changes, but achieves the same testing results as before and remains compatible with potential test customizations, this is defined as a 'backwards compatible' change. - -Types of changes: - -- **Test Flow change (Test/ActionGroup)** - A backwards compatible modification of a test flow would not diminish the original set of actions in the test. Some changes may change action's sequence (behavior), but they allow any extension to achieve the same test results without changing the test extension (e.g a 'merge file'). -- **Test Entity change (Data/Section/Page/Metadata)** - Compatible modifications of entities are 1) adding new entities or 2) updating a `value` of an existing entity in a way where the test will **NOT** require updates. -- **Test Annotation change** - Annotations can be changed without limitation and will always be considered a backward compatible change, but removing or changing a `` annotation will be considered a backward incompatible change. -- Changes which delete and/or rename a (Test/Action Group/Data/Metadata/Page/Section/Action)'s `id` attribute will be considered a backward incompatible change. Changing a reference to a data entity will also be considered a backward incompatible change. - -## Versioning policy - -The approach of defining what each release should include was taken from [Semantic Versioning](https://semver.org/). - -3-component version numbers ---------------------------- - - X.Y.Z - | | | - | | +-- Backward Compatible changes (bug fixes) - | +---- Backward Compatible changes (new features) - +------ Backward Incompatible changes - -### Z release - -Patch version **Z** MUST be incremented if only backward compatible changes to tests are introduced. -For instance: a fix which aims to resolve test flakiness. This can be done by updating an unreliable selector, adding a `wait` to an element, or updating a data entity value. - -### Y release - -Minor version **Y** MUST be incremented if a new, backwards compatible test or test entity is introduced. -It MUST be incremented if any test or test entity is marked as `deprecated`. -It MAY include patch level changes. Patch version MUST be reset to 0 when the minor version is incremented. - -### X release - -Major version **X** MUST be incremented if any backwards incompatible changes are introduced to a test or test entity. -It MAY include minor and patch level changes. Patch and minor version MUST be reset to 0 when the major version is incremented. - -## Implementation tasks - -1. Add Semantic Version analyzer to be able automatically define the release type of the MFTF tests package. -2. Update publication infrastructure to exclude tests from `magento2-module` package type. -3. Introduce publication functionality for publishing `magento2-test-module` package type. -4. Create a metapackage with test packages specifically for each Magento edition. - -## Version increase matrix - -|Entity Type|Change|Version Increase| -|---|---|---| -|ActionGroup|`` added|MINOR -| |`` removed|MAJOR -| |`` `` added|MINOR -| |`` `` removed|MAJOR -| |`` `` type changed|PATCH -| |`` `` attribute changed|PATCH -| |`` `` with `defaultValue`added|MINOR -| |`` `` without `defaultValue` added|MAJOR -| |`` `` removed|MAJOR -| |`` `` changed|MAJOR -|Data|`` added|MINOR -| |`` removed|MAJOR -| |`` `` added|MINOR -| |`` `` removed|MAJOR -| |`` `` `` removed|PATCH -| |`` `` added|MINOR -| |`` `` removed|MAJOR -| |`` `` added|MAJOR -| |`` `` removed|MAJOR -| |`` `` added|MAJOR -| |`` `` removed|MAJOR -|Metadata|`` added|MINOR -| |`` removed|MAJOR -| |`` changed|MINOR -| |`` child element added|MINOR -| |`` child element removed|MAJOR -|Page|`` added|MINOR -| |`` removed|MAJOR -| |`` `` added|MINOR -| |`` `` removed|MAJOR -|Section|`` added|MINOR -| |`` removed|MAJOR -| |`` `` added|MINOR -| |`` `` removed|MAJOR -| |`` `` `selector` changed|PATCH -| |`` `` `type` changed|PATCH -| |`` `` `parameterized` changed|MAJOR -|Test|`` added|MINOR -| |`` removed|MAJOR -| |`` `` added|MINOR -| |`` `` removed|MAJOR -| |`` `` changed|PATCH -| |`` `` sequence changed|MAJOR -| |`` `` type (`click`, `fillField`, etc) changed|PATCH -| |`` `` `ref` changed|MAJOR -| |`` (before/after) `` added|MINOR -| |`` (before/after) `` removed|MAJOR -| |`` (before/after) `` changed|PATCH -| |`` (before/after) `` `ref` changed|MINOR -| |`` (before/after) `` sequence changed|MAJOR -| |`` (before/after) `` type (`click`, `fillField`, etc) changed|PATCH -| |`` (before/after) `` `ref` changed|MAJOR -| |`` `` `` added|PATCH -| |`` `` `` changed|PATCH -| |`` `` `` GROUP removed|MAJOR - ---------------------------- - - ⃰ - `` refers to any of the available [MFTF Actions](https://github.com/magento/magento2-functional-testing-framework/blob/develop/docs/test/actions.md). +Refer to: +https://devdocs.magento.com/guides/v2.4/extension-dev-guide/versioning/mftf-tests-codebase-changes.html From 328df05efa442ce1439e045211c1c75165fd1d15 Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Wed, 7 Oct 2020 15:39:28 -0500 Subject: [PATCH 351/479] Fix naming and align with best practices --- .../coverage/b2b/requisitionList.graphqls | 50 +++++++++---------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls index 05b7ed3a8..b9ec6b6ec 100644 --- a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls +++ b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls @@ -25,7 +25,7 @@ # type Customer { - requisitionLists( + requisition_lists( pageSize: Int = 20, currentPage: Int = 1, filter: RequisitionListFilterInput @@ -33,9 +33,9 @@ type Customer { } type RequisitionLists @doc(description: "Provides Customer's Requisition Lists") { - items: [RequisitionList] @doc(description: "List of Requisition Lists") + items: [RequisitionList]! @doc(description: "List of Requisition Lists") page_info: SearchResultPageInfo @doc(description: "Page Information for pagination") - total_count: Int @doc(description: "Total count of Requisition Lists") + total_count: Int! @doc(description: "Total count of Requisition Lists") } type RequisitionList @doc(description: "Requisition List Type") { @@ -51,9 +51,9 @@ type RequisitionList @doc(description: "Requisition List Type") { } type RequistionListItems { - items: [RequisitionListItemInterface] @doc(description: "Requisition List items list") + items: [RequisitionListItemInterface]! @doc(description: "Requisition List items list") page_info: SearchResultPageInfo - total_pages: Int @doc(description: "total count of req list items") + total_pages: Int! @doc(description: "total count of req list items") } interface RequisitionListItemInterface @doc(description: "Interface type for Requisition List Item") { @@ -129,25 +129,25 @@ type Mutation { items: [UpdateRequisitionListItemsInput!]! @doc(description: "Items to be updated from requisition list") ): UpdateRequisitionListItemsOutput @doc(description: "Update Items in requisition list") - addRequisitionListItemToCart( - requisitionListId: ID!, @doc(description: "unique Id of requisition list") - itemIds: [ID!]! @doc(description: "selected requisition list items that are to be added") - ): AddRequisitionListItemToCartOutput @doc(description: "Add Requisition List Items To Customer Cart") + addRequisitionListItemsToCart( + listUid: ID!, @doc(description: "unique Id of requisition list") + itemUids: [ID!]! @doc(description: "selected requisition list items that are to be added") + ): AddRequisitionListItemsToCartOutput @doc(description: "Add Requisition List Items To Customer Cart") - copyItemsBetweenRequisitionList( - sourceId: ID!, @doc(description: "unique Id of source requisition list") - destinationId: ID, @doc(description: "unique Id of destination requisition list") # If null new requisition list will be created - itemIds: [ID!]! @doc(description: "selected requisition list items that are to be copied from source") - ): CopyItemsFromRequisitionListOutput @doc(description: "Copy Items from Requisition List to another requisition list") + copyItemsBetweenRequisitionLists( + sourceUid: ID!, @doc(description: "unique Id of source requisition list") + destinationUid: ID, @doc(description: "unique Id of destination requisition list") # If null new requisition list will be created + itemUids: [ID!]! @doc(description: "selected requisition list items that are to be copied from source") + ): CopyItemsBetweenRequisitionListsOutput @doc(description: "Copy Items from Requisition List to another requisition list") - moveItemsBetweenRequisitionList( - sourceId: ID!, @doc(description: "unique Id of source requisition list") - destinationId: ID, @doc(description: "unique Id of destination requisition list") # If null new requisition list will be created - itemIds: [ID!]! @doc(description: "selected requisition list items that are to be moved from source") - ): MoveItemsFromRequisitionListOutput @doc(description: "Move Items from Requisition List to another requisition List") + moveItemsBetweenRequisitionLists( + sourceUid: ID!, @doc(description: "unique Id of source requisition list") + destinationUid: ID, @doc(description: "unique Id of destination requisition list") # If null new requisition list will be created + itemUids: [ID!]! @doc(description: "selected requisition list items that are to be moved from source") + ): MoveItemsBetweenRequisitionListsOutput @doc(description: "Move Items from Requisition List to another requisition List") clearCustomerCart( - cartId: String! @doc(description: "masked Cart Id") + cartUid: String! @doc(description: "masked Cart Id") ): ClearCustomerCartOutput @doc(description: "Clears the cart items") } @@ -164,7 +164,7 @@ type AddProductsToRequisitionListOutput { } input RequisitionListFilterInput { - ids: FilterEqualTypeInput, @doc(description: "Filter Customer Requisition lists with an requisition list ID or list of requisition list IDs") + uids: FilterEqualTypeInput, @doc(description: "Filter Customer Requisition lists with an requisition list ID or list of requisition list IDs") name: FilterMatchTypeInput @doc(description: "Filter by display name of the Requisition list") } @@ -192,18 +192,18 @@ type RenameRequisitionListOutput { } type DeleteRequisitionListOutput { - result: Boolean + requisition_list : RequisitionList } -type AddRequisitionListItemToCartOutput { +type AddRequisitionListItemsToCartOutput { cart: Cart # since requisition list is not mutated it is not part of the output } -type CopyItemsFromRequisitionListOutput { +type CopyItemsBetweenRequisitionListsOutput { list : RequisitionList @doc(description: "Destination Requisition List")# since source requisition list is not mutated it is not part of the output } -type MoveItemsFromRequisitionListOutput { +type MoveItemsBetweenRequisitionListsOutput { source : RequisitionList @doc(description: "Source Requisition List") destination : RequisitionList @doc(description: "Destination Requisition List") } From bb14b030971c998fd8ba94813d8b5f564b86f016 Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Thu, 8 Oct 2020 15:44:58 -0500 Subject: [PATCH 352/479] GraphQL schema for dynamic blocks --- .../graph-ql/coverage/dynamic-blocks.graphqls | 49 +++++++++++++++++++ .../graph-ql/coverage/dynamic-blocks.md | 41 ++++++++++++++++ 2 files changed, 90 insertions(+) create mode 100644 design-documents/graph-ql/coverage/dynamic-blocks.graphqls create mode 100644 design-documents/graph-ql/coverage/dynamic-blocks.md diff --git a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls new file mode 100644 index 000000000..5b5d73728 --- /dev/null +++ b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls @@ -0,0 +1,49 @@ +type DynamicBlock { + uid: ID! + name: String! + content: String! +} + +type DynamicBlocks { + items: [DynamicBlock]! + page_info: SearchResultPageInfo + total_count: Int! +} + +# We don't need is_enabled, locations, ga_creative, catalog_price_rule_ids, cart_price_rules_ids, locations on storefront + +type DynamicBlocksFilterInput { + type: DynamicBlockTypeEnum! + locations: [DynamicBlockLocationEnum!] # Blocks for all locations will be displayed if not supplied + rotation_mode: DynamicBlockRotationModeEnum! + dynamic_block_uids: [Int!] # Only makes sense when DynamicBlockTypeEnum is set to SPECIFIED +} + +type DynamicBlocksOutput { + dynamic_blocks: DynamicBlocks! +} + +enum DynamicBlockTypeEnum { + SPECIFIED + CART_PRICE_RULE_RELATED + CATALOG_PRICE_RULE_RELATED +} + +enum DynamicBlockLocationEnum { + CONTENT + HEADER + FOOTER + LEFT + RIGHT +} + +enum DynamicBlockRotationModeEnum { + NO_ROTATION @doc(description: "Display all.") + RANDOM + SERIES + SHUFFLE +} + +type Query { + dynamic_blocks(input: DynamicBlocksFilterInput): DynamicBlocksOutput +} \ No newline at end of file diff --git a/design-documents/graph-ql/coverage/dynamic-blocks.md b/design-documents/graph-ql/coverage/dynamic-blocks.md new file mode 100644 index 000000000..cb1b8f02c --- /dev/null +++ b/design-documents/graph-ql/coverage/dynamic-blocks.md @@ -0,0 +1,41 @@ +## Dynamic Blocks + +Dynamic blocks can be inserted in CMS pages and blocks using widgets. Below is the sample markup of the widget inserted on the page. + +``` +{{widget type="Magento\Banner\Block\Widget\Banner" display_mode="fixed" types="content" rotate="random" banner_ids="1" template="widget/block.phtml" unique_id="34f6520f51ca9b79c91d1f56b5b453adc4d9ff235a7c9f5b04d1b0557584c5bc"}} +``` + +In Luma dynamic blocks rendered to a JavaScript component definition that does request to a backend to load content of the dynamic block. Here is an example of a JavaScript component definition. + +``` + + + + + + + + + +``` + +PWA will receive similar JavaScript component definition that can be parsed to extract parameters and make a [GraphQL query](./dynamic-blocks.graphqls) to load dynamic blocks. + +```graphql +{ + dynamic_blocks(input: {type: SPECIFIED, locations: [CONTENT], rotation_mode: RANDOM, dynamic_block_uids: [1, 2]}) { + items { + uid + name + content + } + page_info { + current_page + page_size + total_pages + } + total_count + } +} +``` From 3e61b27f7b69df73ae760736247f86aa29566f47 Mon Sep 17 00:00:00 2001 From: Nishant Kapoor Date: Mon, 12 Oct 2020 10:11:49 -0500 Subject: [PATCH 353/479] Rename requsition_list to list to be consistent @melnikovi @RakeshJesadiya --- .../graph-ql/coverage/b2b/requisitionList.graphqls | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls index 05b7ed3a8..7f37bb790 100644 --- a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls +++ b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls @@ -152,15 +152,15 @@ type Mutation { } type RemoveRequisitionListItemsOutput { - requisition_list : RequisitionList + list : RequisitionList } type UpdateRequisitionListItemsOutput { - requisition_list : RequisitionList + list : RequisitionList } type AddProductsToRequisitionListOutput { - requisition_list : RequisitionList + list : RequisitionList } input RequisitionListFilterInput { From 3db244b63f8dd7c4049a9263bc100fb498100569 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 15 Oct 2020 14:46:02 -0500 Subject: [PATCH 354/479] Update configurable-options-selection.graphqls --- .../catalog/configurable-options-selection.graphqls | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index b77985033..e56f431ef 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -1,21 +1,18 @@ type ConfigurableProduct { configurable_options_selection_metadata(selectedConfigurableOptionValues: [ID!]): ConfigurableOptionsSelectionMetadata @doc(description: "Metadata for the specified configurable options selection") + variants: [ConfigurableVariant] @deprecated(reason: "Use configurable_options_selection_metadata instead.") @doc(description: "An array of variants of products") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\ConfigurableVariant") + configurable_options: [ConfigurableProductOptions] @deprecated(reason: "Use configurable_options_selection_metadata instead.") @doc(description: "An array of linked simple product items") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\Options") } type ConfigurableOptionsSelectionMetadata @doc(description: "Metadata corresponding to the configurable options selection.") { - options_available_for_selection: [ConfigurableOptionAvailableForSelection!] @doc(description: "Configurable options available for further selection based on current selection.") + options_available_for_selection: [ConfigurableProductOptions!] @doc(description: "Configurable options available for further selection based on current selection.") media_gallery: [MediaGalleryInterface!] @doc(description: "Product images and videos corresponding to the specified configurable options selection.") variant: SimpleProduct @doc(description: "Variant represented by the specified configurable options selection. It is expected to be null, until selections are made for each configurable option.") } -type ConfigurableOptionAvailableForSelection @doc(description: "Configurable option available for further selection based on current selection.") { - option_value_uids: [ID!]! @doc(description: "Configurable option values available for further selection.") - attribute_code: String! @doc(description: "Attribute code that uniquely identifies configurable option.") -} - # Configurable option value type has to be extended to include ID which can be used to uniquely identify the option value across the system. This is consistent with proposal of single mutation for add-to-cart type ConfigurableProductOptionsValues { uid: ID! - is_available_for_selection: Boolean! + is_available_for_selection: Boolean! # when display OOS is enabled, if the variant selection is OOS, this will return false. } From 4c7db6c643d6ab44bd0092e6d6482eb7b76192af Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 15 Oct 2020 15:29:22 -0500 Subject: [PATCH 355/479] Update design-documents/graph-ql/coverage/catalog/compare-list.graphqls Co-authored-by: Igor Melnikov --- .../graph-ql/coverage/catalog/compare-list.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index a35858b57..d2cfc840b 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -10,7 +10,7 @@ type ComparableItem { type ComparableAttribute { code: String! @doc(description: "Attribute code ") - title: String! @doc(description: "Attribute display title") + label: String! @doc(description: "Attribute label") } type CompareList { From b9679f5e99f57ec55f5d47be54cb74187ea59795 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 15 Oct 2020 15:57:40 -0500 Subject: [PATCH 356/479] Update compare-list.graphqls --- .../graph-ql/coverage/catalog/compare-list.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index d2cfc840b..a12e4683e 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -2,7 +2,7 @@ type ComparableItem { productId: ID! @doc(description: "Product Id") name: String! @doc(description: "Product name") sku: String! @doc(description: "Product SKU") - priceRange: ProductPriceRange! @doc(description: "Product prices") + price_range: ProductPriceRange! @doc(description: "Product prices") canonical_url: String @doc(description: "Product URL") images: [ProductImage]! @doc(description: "Product Images") values: [ProductAttribute]! @doc(description: "Product comparable attributes") From bd8e5b6df1e885bdb6e81019c83b6f644d8b662f Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Fri, 16 Oct 2020 09:12:55 -0500 Subject: [PATCH 357/479] Removing product_id for now, since its not in scope. Will have to decide between product_id and exposing product interface --- design-documents/graph-ql/coverage/catalog/compare-list.graphqls | 1 - 1 file changed, 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index a12e4683e..c1eca23c1 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -1,5 +1,4 @@ type ComparableItem { - productId: ID! @doc(description: "Product Id") name: String! @doc(description: "Product name") sku: String! @doc(description: "Product SKU") price_range: ProductPriceRange! @doc(description: "Product prices") From 6547dbd71d11c3f31c890ad1fbbb0c0542fdf726 Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Tue, 20 Oct 2020 12:34:51 -0500 Subject: [PATCH 358/479] Minor updates --- .../graph-ql/coverage/dynamic-blocks.graphqls | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls index 5b5d73728..905025b0d 100644 --- a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls +++ b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls @@ -1,26 +1,19 @@ type DynamicBlock { uid: ID! - name: String! content: String! } -type DynamicBlocks { - items: [DynamicBlock]! - page_info: SearchResultPageInfo - total_count: Int! -} - -# We don't need is_enabled, locations, ga_creative, catalog_price_rule_ids, cart_price_rules_ids, locations on storefront +# We don't need name, is_enabled, locations, ga_creative, catalog_price_rule_ids, cart_price_rules_ids, locations on storefront type DynamicBlocksFilterInput { type: DynamicBlockTypeEnum! locations: [DynamicBlockLocationEnum!] # Blocks for all locations will be displayed if not supplied rotation_mode: DynamicBlockRotationModeEnum! - dynamic_block_uids: [Int!] # Only makes sense when DynamicBlockTypeEnum is set to SPECIFIED + dynamic_block_uids: [ID!] # Only makes sense when DynamicBlockTypeEnum is set to SPECIFIED } type DynamicBlocksOutput { - dynamic_blocks: DynamicBlocks! + items: [DynamicBlock]! } enum DynamicBlockTypeEnum { From 74b69e4e1e916351a16cd93b8150aedc1d76997c Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Tue, 20 Oct 2020 17:20:11 -0500 Subject: [PATCH 359/479] Update Wishlist.graphqls --- design-documents/graph-ql/coverage/customer/Wishlist.graphqls | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index 51f41c8d7..45be81a6f 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -84,6 +84,10 @@ type BundleWishlistItem implements WishlistItemInterface { } type GiftCardWishlistItem implements WishlistItemInterface { + gift_card_options: GiftCardOptions! +} + +type GiftCardOptions { sender_name: String! sender_email: String! recipient_name: String From 9b76d27ac776da1d69895eb3ba8b1ed61acfc67e Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Tue, 20 Oct 2020 17:21:12 -0500 Subject: [PATCH 360/479] Update Wishlist.graphqls --- design-documents/graph-ql/coverage/customer/Wishlist.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index 45be81a6f..484df73db 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -92,7 +92,7 @@ type GiftCardOptions { sender_email: String! recipient_name: String recipient_email: String - amount: SelectedGiftCardAmount + amount: Amount message: String } From 76c40d7aafa082cd5056f91ead64b5cde191584b Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Tue, 20 Oct 2020 17:58:15 -0500 Subject: [PATCH 361/479] Update configurable-options-selection.graphqls --- .../configurable-options-selection.graphqls | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index e56f431ef..d0ba57e00 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -6,13 +6,24 @@ type ConfigurableProduct { type ConfigurableOptionsSelectionMetadata @doc(description: "Metadata corresponding to the configurable options selection.") { - options_available_for_selection: [ConfigurableProductOptions!] @doc(description: "Configurable options available for further selection based on current selection.") + options_available_for_selection: [ConfigurableProductOption!] @doc(description: "Configurable options available for further selection based on current selection.") media_gallery: [MediaGalleryInterface!] @doc(description: "Product images and videos corresponding to the specified configurable options selection.") variant: SimpleProduct @doc(description: "Variant represented by the specified configurable options selection. It is expected to be null, until selections are made for each configurable option.") } -# Configurable option value type has to be extended to include ID which can be used to uniquely identify the option value across the system. This is consistent with proposal of single mutation for add-to-cart -type ConfigurableProductOptionsValues { +type ConfigurableProductOption { uid: ID! - is_available_for_selection: Boolean! # when display OOS is enabled, if the variant selection is OOS, this will return false. + attribute_code: String! + attribute_uid: ID! + label: String! + position: Int! + values: [ConfigurableProductOptionValue!] +} + +type ConfigurableProductOptionValue { + uid: ID! + is_available: Boolean! # when display OOS is enabled, if the variant selection is OOS, this will return false. + is_default: Boolean! + label: String! + swatch: SwatchDataInterface } From 161852f2bfe533bc181d67b6e4c5da7e5af4b6d4 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Tue, 20 Oct 2020 18:04:28 -0500 Subject: [PATCH 362/479] Update configurable-options-selection.graphqls --- .../coverage/catalog/configurable-options-selection.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index d0ba57e00..00b0ba06a 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -1,5 +1,5 @@ type ConfigurableProduct { - configurable_options_selection_metadata(selectedConfigurableOptionValues: [ID!]): ConfigurableOptionsSelectionMetadata @doc(description: "Metadata for the specified configurable options selection") + configurable_options_v2(selected_configurable_option_values: [ID!]): ConfigurableOptionsSelectionMetadata @doc(description: "Metadata for the specified configurable options selection") variants: [ConfigurableVariant] @deprecated(reason: "Use configurable_options_selection_metadata instead.") @doc(description: "An array of variants of products") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\ConfigurableVariant") configurable_options: [ConfigurableProductOptions] @deprecated(reason: "Use configurable_options_selection_metadata instead.") @doc(description: "An array of linked simple product items") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\Options") } From 77ee9b898fea3008b3a1312b87dba9d0a0796e4f Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Tue, 20 Oct 2020 18:51:47 -0500 Subject: [PATCH 363/479] Update Wishlist.graphqls --- design-documents/graph-ql/coverage/customer/Wishlist.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index 484df73db..733d16f4f 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -92,7 +92,7 @@ type GiftCardOptions { sender_email: String! recipient_name: String recipient_email: String - amount: Amount + amount: Money message: String } From cc87e2dcd22b09be02eaabd7affc553b4d7d13df Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Wed, 21 Oct 2020 09:41:49 -0500 Subject: [PATCH 364/479] Fix naming conventions --- .../graph-ql/coverage/b2b/company.md | 25 +++++++++---------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/company.md b/design-documents/graph-ql/coverage/b2b/company.md index 8563c9d9c..8d411c184 100644 --- a/design-documents/graph-ql/coverage/b2b/company.md +++ b/design-documents/graph-ql/coverage/b2b/company.md @@ -13,10 +13,10 @@ Delete mutations return a field indicating success or failure. In the case of fa ```graphql type Query { company: Company @doc(description: "Company assigned to the currently authenticated user") - checkCompanyEmail(email: String!): CompanyEmailCheckResponse @doc(description: "Check if an email is valid for company registration") - checkCompanyAdminEmail(email: String!): CompanyAdminEmailCheckResponse @doc(description: "Check if an email is valid for company admin registration") - checkCompanyUserEmail(email: String!): CompanyUserEmailCheckResponse @doc(description: "Check if an email is valid for company user registration") - checkCompanyRoleName(name: String!): CompanyRoleNameCheckResponse @doc(description: "Check if a role name is valid for company") + isCompanyEmailAvailable(email: String!): IsCompanyEmailAvailableOutput @doc(description: "Check if an email is valid for company registration") + isCompanyAdminEmailAvailable(email: String!): IsCompanyAdminEmailAvailableOutput @doc(description: "Check if an email is valid for company admin registration") + isCompanyUserEmailAvailable(email: String!): IsCompanyUserEmailAvailableOutput @doc(description: "Check if an email is valid for company user registration") + isCompanyRoleNameAvailable(name: String!): IsCompanyRoleNameAvailableOutput @doc(description: "Check if a role name is valid for company") } type Company @doc(description: "Company entity output data schema.") { @@ -99,20 +99,20 @@ type CompanyAclResource @doc(description: "Output data schema for an object with children: [CompanyAclResource!] @doc(description: "An array of sub-resources.") } -type CompanyRoleNameCheckResponse @doc(description: "Response object schema for a role name validation query.") { - is_name_valid: Boolean @doc(description: "Role name validation result") +type IsCompanyRoleNameAvailableOutput @doc(description: "Response object schema for a role name validation query.") { + is_role_name_available: Boolean! @doc(description: "Role name validation result") } -type CompanyUserEmailCheckResponse @doc(description: "Response object schema for a Company User email validation query.") { - is_email_valid: Boolean @doc(description: "Email validation result") +type IsCompanyUserEmailAvailableOutput @doc(description: "Response object schema for a Company User email validation query.") { + is_email_available: Boolean! @doc(description: "Email validation result") } -type CompanyAdminEmailCheckResponse @doc(description: "Response object schema for a Company Admin email validation query.") { - is_email_valid: Boolean @doc(description: "Email validation result") +type IsCompanyAdminEmailAvailableOutput @doc(description: "Response object schema for a Company Admin email validation query.") { + is_email_available: Boolean! @doc(description: "Email validation result") } -type CompanyEmailCheckResponse @doc(description: "Response object schema for a Company email validation query.") { - is_email_valid: Boolean @doc(description: "Email validation result") +type IsCompanyEmailAvailableOutput @doc(description: "Response object schema for a Company email validation query.") { + is_email_available: Boolean! @doc(description: "Email validation result") } union CompanyStructureEntity = CompanyTeam | Customer @@ -209,7 +209,6 @@ type UpdateCompanyStructureOutput @doc(description: "Update company structure ou company: Company! @doc(description: "Updated company instance.") } - input CompanyCreateInput @doc(description: "Defines the Company input data schema for creating a new entity."){ company_name: String! @doc(description: "Company name. Required.") company_email: String! @doc(description: "Company email address. Required.") From c9ce7e974a0918ee7682eec3ef5c8f019535014a Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Wed, 21 Oct 2020 09:47:13 -0500 Subject: [PATCH 365/479] Clarify what is CompanyCreditOperation.uid --- design-documents/graph-ql/coverage/b2b/company-credit.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/b2b/company-credit.md b/design-documents/graph-ql/coverage/b2b/company-credit.md index e04c7ffde..b0b1000f4 100644 --- a/design-documents/graph-ql/coverage/b2b/company-credit.md +++ b/design-documents/graph-ql/coverage/b2b/company-credit.md @@ -18,7 +18,7 @@ type CompanyCreditHistory { } type CompanyCreditOperation { - uid: ID! @doc(description: "Unique identifier") + uid: ID! @doc(description: "Unique identifier") # id of the log entry date: String! @doc(description: "The date of the company credit operation") type: CompanyCreditOperationType! @doc(description: "The type of the company credit operation") amount: Money! @doc(description: "The amount fo the company credit operation") From 4f3ab72eb66e64b9f1f5cb80d8ffb2663647d079 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 21 Oct 2020 14:55:59 -0500 Subject: [PATCH 366/479] Update Wishlist.graphqls --- .../graph-ql/coverage/customer/Wishlist.graphqls | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index 733d16f4f..4cc054d7a 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -88,11 +88,12 @@ type GiftCardWishlistItem implements WishlistItemInterface { } type GiftCardOptions { - sender_name: String! - sender_email: String! + sender_name: String + sender_email: String recipient_name: String recipient_email: String amount: Money + custom_giftcard_amount: Money message: String } From daea56c6eccf99c6b0d0bf1f6336b0db406341b9 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 21 Oct 2020 15:39:19 -0500 Subject: [PATCH 367/479] Update design-documents/graph-ql/coverage/customer/Wishlist.graphqls Co-authored-by: Igor Melnikov --- design-documents/graph-ql/coverage/customer/Wishlist.graphqls | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index 4cc054d7a..31e7fd720 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -125,7 +125,6 @@ type UpdateWishlistOutput { } type StoreConfig { - maximum_number_of_wishlists: String @doc(description: "If multiple wish lists are enabled, the maximum number of wish lists the customer can have") + maximum_number_of_wishlists: Int @doc(description: "If multiple wish lists are enabled, the maximum number of wish lists the customer can have") enable_multiple_wishlists: String @doc(description: "Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No)") } - From a0727f015733e9087c5c9d553c37990a976c2a4e Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 21 Oct 2020 15:39:35 -0500 Subject: [PATCH 368/479] Update design-documents/graph-ql/coverage/customer/Wishlist.graphqls Co-authored-by: Igor Melnikov --- design-documents/graph-ql/coverage/customer/Wishlist.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index 31e7fd720..c11046311 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -126,5 +126,5 @@ type UpdateWishlistOutput { type StoreConfig { maximum_number_of_wishlists: Int @doc(description: "If multiple wish lists are enabled, the maximum number of wish lists the customer can have") - enable_multiple_wishlists: String @doc(description: "Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No)") + enable_multiple_wishlists: Boolean @doc(description: "Indicates whether customers can have multiple wish lists.") } From 32f1cbe733c29925a6de82a9d2a45ee77c683e0a Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 21 Oct 2020 16:18:34 -0500 Subject: [PATCH 369/479] Update design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls Co-authored-by: Igor Melnikov --- .../coverage/catalog/configurable-options-selection.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index 00b0ba06a..ef6a405a2 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -16,7 +16,7 @@ type ConfigurableProductOption { attribute_code: String! attribute_uid: ID! label: String! - position: Int! + sort_order: Int! values: [ConfigurableProductOptionValue!] } From eb9ca5bb5fa9b5da2560b146dd5bd9a80fc9140f Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 21 Oct 2020 16:19:10 -0500 Subject: [PATCH 370/479] Update design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls Co-authored-by: Igor Melnikov --- .../coverage/catalog/configurable-options-selection.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index ef6a405a2..011957962 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -1,5 +1,5 @@ type ConfigurableProduct { - configurable_options_v2(selected_configurable_option_values: [ID!]): ConfigurableOptionsSelectionMetadata @doc(description: "Metadata for the specified configurable options selection") + configurable_product_options_selection(configurableOptionValues: [ID!]): ConfigurableProductOptionsSelection @doc(description: "Specified configurable product options selection") variants: [ConfigurableVariant] @deprecated(reason: "Use configurable_options_selection_metadata instead.") @doc(description: "An array of variants of products") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\ConfigurableVariant") configurable_options: [ConfigurableProductOptions] @deprecated(reason: "Use configurable_options_selection_metadata instead.") @doc(description: "An array of linked simple product items") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\Options") } From e28ca7a7b64892c3cf7065ab9033815f987542ed Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 21 Oct 2020 16:19:16 -0500 Subject: [PATCH 371/479] Update design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls Co-authored-by: Igor Melnikov --- .../coverage/catalog/configurable-options-selection.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index 011957962..630d2e6a2 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -6,7 +6,7 @@ type ConfigurableProduct { type ConfigurableOptionsSelectionMetadata @doc(description: "Metadata corresponding to the configurable options selection.") { - options_available_for_selection: [ConfigurableProductOption!] @doc(description: "Configurable options available for further selection based on current selection.") + configurable_options: [ConfigurableProductOption!] @doc(description: "Configurable options available for further selection based on current selection.") media_gallery: [MediaGalleryInterface!] @doc(description: "Product images and videos corresponding to the specified configurable options selection.") variant: SimpleProduct @doc(description: "Variant represented by the specified configurable options selection. It is expected to be null, until selections are made for each configurable option.") } From c69b6a3d09c28c62c22261523c4637644827b26e Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 21 Oct 2020 16:20:20 -0500 Subject: [PATCH 372/479] Update configurable-options-selection.graphqls --- .../coverage/catalog/configurable-options-selection.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index 630d2e6a2..615e10302 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -4,7 +4,7 @@ type ConfigurableProduct { configurable_options: [ConfigurableProductOptions] @deprecated(reason: "Use configurable_options_selection_metadata instead.") @doc(description: "An array of linked simple product items") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\Options") } -type ConfigurableOptionsSelectionMetadata @doc(description: "Metadata corresponding to the configurable options selection.") +type ConfigurableProductOptionsSelection @doc(description: "Metadata corresponding to the configurable options selection.") { configurable_options: [ConfigurableProductOption!] @doc(description: "Configurable options available for further selection based on current selection.") media_gallery: [MediaGalleryInterface!] @doc(description: "Product images and videos corresponding to the specified configurable options selection.") From 56809278f56b45a07db2512aca938ad8a6bf5470 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 22 Oct 2020 12:37:48 -0500 Subject: [PATCH 373/479] aligning schema structure with requisition list. --- .../coverage/customer/Wishlist.graphqls | 45 ++++++++++++++----- 1 file changed, 34 insertions(+), 11 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index c11046311..012e019f9 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -1,12 +1,12 @@ type Mutation { - createWishlist(name: String!, visibility: WishlistVisibilityEnum!): CreateWishlistOutput # Multiple wishlists Commerce functionality - deleteWishlist(wishlistId: ID!): Boolean # Commerce fucntionality - in Opens Source we assume customer always has one wishlist + createWishlist(input: CreateWishlistInput!): CreateWishlistOutput # Multiple wishlists Commerce functionality + deleteWishlist(wishlistId: ID!): DeleteWishlistOutput # Commerce fucntionality - in Opens Source we assume customer always has one wishlist addProductsToWishlist(wishlistId: ID!, wishlistItems: [WishlistItemInput!]!): AddProductsToWishlistOutput removeProductsFromWishlist(wishlistId: ID!, wishlistItemsIds: [ID!]!): RemoveProductsFromWishlistOutput updateProductsInWishlist(wishlistId: ID!, wishlistItems: [WishlistItemUpdateInput!]!): UpdateProductsInWishlistOutput - copyProductsToWishlist(wishlistId: ID!, wishlistItems: [WishlistItemCopyInput!]!): UpdateProductsInWishlistOutput @doc(description: "Copy a product to the wish list") - moveProductsToWishlist(wishlistId: ID!, wishlistItems: [WishlistItemMoveInput!]!): UpdateProductsInWishlistOutput @doc(description: "Move products from one wish list to another") - updateWishlist(wishlistId: ID!, name: String, visibility: WishlistVisibilityEnum): UpdateWishlistOutput @doc(description: "Change the name and visibility of the specified wish list") + copyProductsBetweenWishlists(sourceUid: ID!, destinationUid: ID!, wishlistItems: [WishlistItemCopyInput!]!): CopyProductsBetweenWishlistsOutput @doc(description: "Copy a product to the wish list") + moveProductsBetweenWishlists(sourceUid: ID!, destinationUid: ID!, wishlistItems: [WishlistItemMoveInput!]!): MoveProductsBetweenWishlistsOutput @doc(description: "Move products from one wish list to another") + updateWishlist(input: UpdateWishlistInput!): UpdateWishlistOutput @doc(description: "Change the name and visibility of the specified wish list") } type Customer { @@ -23,6 +23,18 @@ type Wishlist { sharing_code: String updated_at: String name: String @doc(description: "Avaialble in Commerce edition only") + visibility: WishlistVisibilityEnum! +} + +input CreateWishlistInput { + name: String! + visibility: WishlistVisibilityEnum! +} + +input UpdateWishlistInput { + wishlistId: ID! + name: String + visibility: WishlistVisibilityEnum } input WishlistItemUpdateInput { @@ -103,9 +115,12 @@ enum WishlistVisibilityEnum @doc(description: "This enumeration defines the wish } type CreateWishlistOutput { - uid: ID! @doc(description: "The ID of the new wish list") - name: String! @doc(description: "The wish list name") - visibility: WishlistVisibilityEnum! @doc(description: "The wish list visibility") + wishlist: Wishlist +} + +type DeleteWishlistOutput { + status: Boolean! + wishlists: [Wishlist!]! } input WishlistItemCopyInput { @@ -119,9 +134,17 @@ input WishlistItemMoveInput { } type UpdateWishlistOutput { - uid: ID! @doc(description: "The ID of the updated wish list") - name: String! @doc(description: "The wish list name") - visibility: WishlistVisibilityEnum! @doc(description: "The wish list visibility") + wishlist: Wishlist +} + +type CopyProductsBetweenWishlistsOutput { + source_wishlist: Wishlist! + destination_wishlist: Wishlist! +} + +type MoveProductsBetweenWishlistsOutput { + source_wishlist: Wishlist! + destination_wishlist: Wishlist! } type StoreConfig { From 2f7025544acaec122b60580f34b59dfc8e4f93bc Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 22 Oct 2020 12:45:40 -0500 Subject: [PATCH 374/479] After internal discussion, decided its better to return ProductInterface at the ComparableItem Simplifies implementation and usage. --- .../graph-ql/coverage/catalog/compare-list.graphqls | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index c1eca23c1..ea5a4e1be 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -1,13 +1,10 @@ type ComparableItem { - name: String! @doc(description: "Product name") - sku: String! @doc(description: "Product SKU") - price_range: ProductPriceRange! @doc(description: "Product prices") - canonical_url: String @doc(description: "Product URL") - images: [ProductImage]! @doc(description: "Product Images") - values: [ProductAttribute]! @doc(description: "Product comparable attributes") + uid: ID! + product: ProductInterface! } type ComparableAttribute { + uid: ID! code: String! @doc(description: "Attribute code ") label: String! @doc(description: "Attribute label") } From faadf5030f18c172def742e593f3228e6d7c6096 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 22 Oct 2020 13:07:00 -0500 Subject: [PATCH 375/479] Update compare-list.graphqls --- design-documents/graph-ql/coverage/catalog/compare-list.graphqls | 1 + 1 file changed, 1 insertion(+) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index ea5a4e1be..430649ec1 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -1,6 +1,7 @@ type ComparableItem { uid: ID! product: ProductInterface! + attributes: [Attribute]! @doc(description: "Product comparable attributes") } type ComparableAttribute { From a67bd69836675782dc34a6c1ff986fed7328eda3 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 22 Oct 2020 13:15:31 -0500 Subject: [PATCH 376/479] Update compare-list.graphqls --- .../graph-ql/coverage/catalog/compare-list.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls index 430649ec1..1f6d7c667 100644 --- a/design-documents/graph-ql/coverage/catalog/compare-list.graphqls +++ b/design-documents/graph-ql/coverage/catalog/compare-list.graphqls @@ -1,7 +1,7 @@ type ComparableItem { uid: ID! product: ProductInterface! - attributes: [Attribute]! @doc(description: "Product comparable attributes") + attributes: [ProductAttribute]! @doc(description: "Product comparable attributes") } type ComparableAttribute { From d6c66398e56f36f22a68108cabcd60685cae7f28 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 22 Oct 2020 13:50:27 -0500 Subject: [PATCH 377/479] Update design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls Co-authored-by: Igor Melnikov --- .../coverage/catalog/configurable-options-selection.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index 615e10302..45161f4b3 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -22,7 +22,7 @@ type ConfigurableProductOption { type ConfigurableProductOptionValue { uid: ID! - is_available: Boolean! # when display OOS is enabled, if the variant selection is OOS, this will return false. + is_available: Boolean! # When display out of stock is enabled, if the option value is out of stock, this will return false is_default: Boolean! label: String! swatch: SwatchDataInterface From a19c2e68ff1dfb2cdf3fce065e1b8d0918611a2f Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 22 Oct 2020 13:51:00 -0500 Subject: [PATCH 378/479] Update design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls Co-authored-by: Igor Melnikov --- .../coverage/catalog/configurable-options-selection.graphqls | 1 - 1 file changed, 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index 45161f4b3..f5bab0e3e 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -14,7 +14,6 @@ type ConfigurableProductOptionsSelection @doc(description: "Metadata correspondi type ConfigurableProductOption { uid: ID! attribute_code: String! - attribute_uid: ID! label: String! sort_order: Int! values: [ConfigurableProductOptionValue!] From 7af32d5bf423106dee8c441a580f5d4c1d48ea5b Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 22 Oct 2020 13:51:07 -0500 Subject: [PATCH 379/479] Update design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls Co-authored-by: Igor Melnikov --- .../coverage/catalog/configurable-options-selection.graphqls | 1 - 1 file changed, 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index f5bab0e3e..98ae12954 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -15,7 +15,6 @@ type ConfigurableProductOption { uid: ID! attribute_code: String! label: String! - sort_order: Int! values: [ConfigurableProductOptionValue!] } From 4565c793c3416da249eb82d8c295a73748ab713f Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 22 Oct 2020 14:09:49 -0500 Subject: [PATCH 380/479] Update configurable-options-selection.graphqls --- .../coverage/catalog/configurable-options-selection.graphqls | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index 98ae12954..037a53fbe 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -12,14 +12,15 @@ type ConfigurableProductOptionsSelection @doc(description: "Metadata correspondi } type ConfigurableProductOption { - uid: ID! + uid: ID! attribute_code: String! label: String! values: [ConfigurableProductOptionValue!] } type ConfigurableProductOptionValue { - uid: ID! + uid: ID! # Encoding of this uid should respect encode_algm(format: configurable//) + # refer to https://github.com/magento/architecture/blob/master/design-documents/graph-ql/coverage/cart/add-items-to-cart-single-mutation.md#single-mutation-for-adding-products-to-cart is_available: Boolean! # When display out of stock is enabled, if the option value is out of stock, this will return false is_default: Boolean! label: String! From 0f8c22bc841b4a20ad552df0b10f5024ac1942a4 Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Thu, 22 Oct 2020 15:01:36 -0500 Subject: [PATCH 381/479] Add pagination back and change type of the content field --- .../graph-ql/coverage/dynamic-blocks.graphqls | 10 ++++++++-- design-documents/graph-ql/coverage/dynamic-blocks.md | 4 +++- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls index 905025b0d..b0e05987c 100644 --- a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls +++ b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls @@ -1,10 +1,16 @@ type DynamicBlock { uid: ID! - content: String! + content: ComplexTextValue! } # We don't need name, is_enabled, locations, ga_creative, catalog_price_rule_ids, cart_price_rules_ids, locations on storefront +type DynamicBlocks { + items: [DynamicBlock]! + page_info: SearchResultPageInfo + total_count: Int! +} + type DynamicBlocksFilterInput { type: DynamicBlockTypeEnum! locations: [DynamicBlockLocationEnum!] # Blocks for all locations will be displayed if not supplied @@ -13,7 +19,7 @@ type DynamicBlocksFilterInput { } type DynamicBlocksOutput { - items: [DynamicBlock]! + dynamic_blocks: DynamicBlocks! } enum DynamicBlockTypeEnum { diff --git a/design-documents/graph-ql/coverage/dynamic-blocks.md b/design-documents/graph-ql/coverage/dynamic-blocks.md index cb1b8f02c..b56bdca37 100644 --- a/design-documents/graph-ql/coverage/dynamic-blocks.md +++ b/design-documents/graph-ql/coverage/dynamic-blocks.md @@ -28,7 +28,9 @@ PWA will receive similar JavaScript component definition that can be parsed to e items { uid name - content + content { + html + } } page_info { current_page From b3e9d8ef4449e222a3149c9d7bd7d2f5a3319bd2 Mon Sep 17 00:00:00 2001 From: Igor Melnykov Date: Thu, 22 Oct 2020 15:22:57 -0500 Subject: [PATCH 382/479] Remove name field from example --- design-documents/graph-ql/coverage/dynamic-blocks.md | 1 - 1 file changed, 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/dynamic-blocks.md b/design-documents/graph-ql/coverage/dynamic-blocks.md index b56bdca37..cc2df883a 100644 --- a/design-documents/graph-ql/coverage/dynamic-blocks.md +++ b/design-documents/graph-ql/coverage/dynamic-blocks.md @@ -27,7 +27,6 @@ PWA will receive similar JavaScript component definition that can be parsed to e dynamic_blocks(input: {type: SPECIFIED, locations: [CONTENT], rotation_mode: RANDOM, dynamic_block_uids: [1, 2]}) { items { uid - name content { html } From 4a4b6c0dc6f9131b544a2c7c7ca4d2b8b0328a03 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 22 Oct 2020 17:08:28 -0500 Subject: [PATCH 383/479] Update design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls Co-authored-by: Igor Melnikov --- .../coverage/catalog/configurable-options-selection.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls index 037a53fbe..52c7a9c2d 100644 --- a/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls +++ b/design-documents/graph-ql/coverage/catalog/configurable-options-selection.graphqls @@ -1,5 +1,5 @@ type ConfigurableProduct { - configurable_product_options_selection(configurableOptionValues: [ID!]): ConfigurableProductOptionsSelection @doc(description: "Specified configurable product options selection") + configurable_product_options_selection(configurableOptionValueUids: [ID!]): ConfigurableProductOptionsSelection @doc(description: "Specified configurable product options selection") variants: [ConfigurableVariant] @deprecated(reason: "Use configurable_options_selection_metadata instead.") @doc(description: "An array of variants of products") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\ConfigurableVariant") configurable_options: [ConfigurableProductOptions] @deprecated(reason: "Use configurable_options_selection_metadata instead.") @doc(description: "An array of linked simple product items") @resolver(class: "Magento\\ConfigurableProductGraphQl\\Model\\Resolver\\Options") } From 20da1739e70f3e0bb0332cf808e52e01719bdd72 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Tue, 27 Oct 2020 21:36:49 -0500 Subject: [PATCH 384/479] Update design-documents/graph-ql/coverage/customer/Wishlist.graphqls Co-authored-by: Igor Melnikov --- design-documents/graph-ql/coverage/customer/Wishlist.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index 012e019f9..15d025bf3 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -1,6 +1,6 @@ type Mutation { createWishlist(input: CreateWishlistInput!): CreateWishlistOutput # Multiple wishlists Commerce functionality - deleteWishlist(wishlistId: ID!): DeleteWishlistOutput # Commerce fucntionality - in Opens Source we assume customer always has one wishlist + deleteWishlist(wishlistUid: ID!): DeleteWishlistOutput # Commerce fucntionality - in Opens Source we assume customer always has one wishlist addProductsToWishlist(wishlistId: ID!, wishlistItems: [WishlistItemInput!]!): AddProductsToWishlistOutput removeProductsFromWishlist(wishlistId: ID!, wishlistItemsIds: [ID!]!): RemoveProductsFromWishlistOutput updateProductsInWishlist(wishlistId: ID!, wishlistItems: [WishlistItemUpdateInput!]!): UpdateProductsInWishlistOutput From 1bb0bcd3f3c45a11f7a8ceab4ebddf0c84036524 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Tue, 27 Oct 2020 21:37:31 -0500 Subject: [PATCH 385/479] Update Wishlist.graphqls --- design-documents/graph-ql/coverage/customer/Wishlist.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index 15d025bf3..1f480956b 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -115,7 +115,7 @@ enum WishlistVisibilityEnum @doc(description: "This enumeration defines the wish } type CreateWishlistOutput { - wishlist: Wishlist + wishlist: Wishlist! } type DeleteWishlistOutput { From 050d0e2ea583e2a9af42d30b4c28f6e7770af630 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 28 Oct 2020 14:33:09 -0500 Subject: [PATCH 386/479] align schema with uids and delete success --- .../coverage/b2b/requisitionList.graphqls | 66 ++++++++++--------- 1 file changed, 34 insertions(+), 32 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls index 996ff10de..07cef0d01 100644 --- a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls +++ b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls @@ -17,7 +17,7 @@ # # 3. In requistion list view, `renameRequistionList` mutatation can be used to rename the list # -# 4. In requistion list view, one can edit items quantity, options etc or remove items with `removeRequisitionListItems` and +# 4. In requistion list view, one can edit items quantity, options etc or remove items with `deleteRequisitionListItems` and # `updateRequisitionListItems` mutation # # 5. In requistion list view, select requistion list items and move them , copy them to different requistion list with @@ -104,46 +104,46 @@ type Mutation { description: String @doc(description: "description For the list") ): CreateRequisitionListOutput @doc(description: "Create Empty Requisition List") - renameRequisitionList( - uid: ID!, @doc(description: "unique Id of requisition list") + updateRequisitionList( + requisitionListUid: ID!, @doc(description: "unique Id of requisition list") name: String!, @doc(description: "new name for list") description: String @doc(description: "new description For the List") - ): RenameRequisitionListOutput @doc(description: "Rename a requisition list and change description") + ): UpdateRequisitionListOutput @doc(description: "Rename a requisition list and change description") deleteRequisitionList( - uid: ID! @doc(description: "unique Id of requisition list") + requisitionListUid: ID! @doc(description: "unique Id of requisition list") ): DeleteRequisitionListOutput @doc(description: "Delete a requisition list with Id") addProductsToRequisitionList( - uid: ID!, @doc(description: "unique Id of requisition list") + requisitionListUid: ID!, @doc(description: "unique Id of requisition list") items: [RequisitionListItemsInput!]! @doc(description: "Products to be added to requisition list") ): AddProductsToRequisitionListOutput @doc(description: "Add items to requisition list") - removeRequisitionListItems( - uid: ID!, @doc(description: "unique Id of requisition list") - items: [ID!]! @doc(description: "unique Ids of Items to be removed from requisition list") - ): RemoveRequisitionListItemsOutput @doc(description: "Remove Items in requisition list") + deleteRequisitionListItems( + requisitionListUid: ID!, @doc(description: "unique Id of requisition list") + requisitionListItemUids: [ID!]! @doc(description: "unique Ids of Items to be deleted from requisition list") + ): DeleteRequisitionListItemsOutput @doc(description: "Remove Items in requisition list") updateRequisitionListItems( - uid: ID!, @doc(description: "unique Id of requisition list") + requisitionListUid: ID!, @doc(description: "unique Id of requisition list") items: [UpdateRequisitionListItemsInput!]! @doc(description: "Items to be updated from requisition list") ): UpdateRequisitionListItemsOutput @doc(description: "Update Items in requisition list") addRequisitionListItemsToCart( - listUid: ID!, @doc(description: "unique Id of requisition list") - itemUids: [ID!]! @doc(description: "selected requisition list items that are to be added") + requisitionListUid: ID!, @doc(description: "unique Id of requisition list") + requisitionListItemUids: [ID!]! @doc(description: "selected requisition list items that are to be added") ): AddRequisitionListItemsToCartOutput @doc(description: "Add Requisition List Items To Customer Cart") copyItemsBetweenRequisitionLists( - sourceUid: ID!, @doc(description: "unique Id of source requisition list") - destinationUid: ID, @doc(description: "unique Id of destination requisition list") # If null new requisition list will be created - itemUids: [ID!]! @doc(description: "selected requisition list items that are to be copied from source") + sourceRequisitionListUid: ID!, @doc(description: "unique Id of source requisition list") + destinationRequisitionListUid: ID, @doc(description: "unique Id of destination requisition list") # If null new requisition list will be created + requisitionListItemUids: [ID!]! @doc(description: "selected requisition list items that are to be copied from source") ): CopyItemsBetweenRequisitionListsOutput @doc(description: "Copy Items from Requisition List to another requisition list") moveItemsBetweenRequisitionLists( - sourceUid: ID!, @doc(description: "unique Id of source requisition list") - destinationUid: ID, @doc(description: "unique Id of destination requisition list") # If null new requisition list will be created - itemUids: [ID!]! @doc(description: "selected requisition list items that are to be moved from source") + sourceRequisitionListUid: ID!, @doc(description: "unique Id of source requisition list") + destinationRequisitionListUid: ID, @doc(description: "unique Id of destination requisition list") # If null new requisition list will be created + requisitionListItemUids: [ID!]! @doc(description: "selected requisition list items that are to be moved from source") ): MoveItemsBetweenRequisitionListsOutput @doc(description: "Move Items from Requisition List to another requisition List") clearCustomerCart( @@ -151,20 +151,21 @@ type Mutation { ): ClearCustomerCartOutput @doc(description: "Clears the cart items") } -type RemoveRequisitionListItemsOutput { - list : RequisitionList +type DeleteRequisitionListItemsOutput { + status: Boolean! + list: RequisitionList } type UpdateRequisitionListItemsOutput { - list : RequisitionList + list: RequisitionList } type AddProductsToRequisitionListOutput { - list : RequisitionList + list: RequisitionList } input RequisitionListFilterInput { - uids: FilterEqualTypeInput, @doc(description: "Filter Customer Requisition lists with an requisition list ID or list of requisition list IDs") + requisitionListUid: FilterEqualTypeInput, @doc(description: "Filter Customer Requisition lists with an requisition list ID or list of requisition list IDs") name: FilterMatchTypeInput @doc(description: "Filter by display name of the Requisition list") } @@ -172,13 +173,13 @@ input RequisitionListItemsInput { sku: String! quantity: Float parent_sku: String - selected_options: [String!] @doc(description: "selected option ID") + selected_options: [ID!] @doc(description: "selected option ID") entered_options: [EnteredOptionInput!] @doc(description: "entered Options ID") } input UpdateRequisitionListItemsInput { - item_id: ID! @doc(description: "unique ID of Requisition List Item") - selected_options: [String!] @doc(description: "selected option ID") + requisitionListItemUid: ID! @doc(description: "unique ID of Requisition List Item") + selected_options: [ID!] @doc(description: "selected option ID") entered_options: [EnteredOptionInput!] @doc(description: "entered Options ID") quantity: Float } @@ -187,12 +188,13 @@ type CreateRequisitionListOutput { list: RequisitionList } -type RenameRequisitionListOutput { +type UpdateRequisitionListOutput { list: RequisitionList } type DeleteRequisitionListOutput { - requisition_list : RequisitionList + status: Boolean! + requisition_list: RequisitionList } type AddRequisitionListItemsToCartOutput { @@ -200,12 +202,12 @@ type AddRequisitionListItemsToCartOutput { } type CopyItemsBetweenRequisitionListsOutput { - list : RequisitionList @doc(description: "Destination Requisition List")# since source requisition list is not mutated it is not part of the output + list: RequisitionList @doc(description: "Destination Requisition List")# since source requisition list is not mutated it is not part of the output } type MoveItemsBetweenRequisitionListsOutput { - source : RequisitionList @doc(description: "Source Requisition List") - destination : RequisitionList @doc(description: "Destination Requisition List") + source: RequisitionList @doc(description: "Source Requisition List") + destination: RequisitionList @doc(description: "Destination Requisition List") } type ClearCustomerCartOutput { From 9ab990992ea8edbc4662c75e10a4425ff4a35cae Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 28 Oct 2020 14:38:04 -0500 Subject: [PATCH 387/479] align schema with uids and delete success --- .../graph-ql/coverage/b2b/requisitionList.graphqls | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls index 07cef0d01..9740bba00 100644 --- a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls +++ b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls @@ -15,9 +15,9 @@ # # 2. In requistion list view, `exportRequisitionList` query will generate a CSV file with particular requistion list data # -# 3. In requistion list view, `renameRequistionList` mutatation can be used to rename the list +# 3. In requistion list view, `updateRequistionList` mutatation can be used to update or rename the list # -# 4. In requistion list view, one can edit items quantity, options etc or remove items with `deleteRequisitionListItems` and +# 4. In requistion list view, one can edit items quantity, options etc or delete items with `deleteRequisitionListItems` and # `updateRequisitionListItems` mutation # # 5. In requistion list view, select requistion list items and move them , copy them to different requistion list with @@ -122,7 +122,7 @@ type Mutation { deleteRequisitionListItems( requisitionListUid: ID!, @doc(description: "unique Id of requisition list") requisitionListItemUids: [ID!]! @doc(description: "unique Ids of Items to be deleted from requisition list") - ): DeleteRequisitionListItemsOutput @doc(description: "Remove Items in requisition list") + ): DeleteRequisitionListItemsOutput @doc(description: "Delete Items in requisition list") updateRequisitionListItems( requisitionListUid: ID!, @doc(description: "unique Id of requisition list") From 0f0a221b81e557ac1835984c9891de314655fef1 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 28 Oct 2020 15:53:22 -0500 Subject: [PATCH 388/479] Update Wishlist.graphqls --- .../graph-ql/coverage/customer/Wishlist.graphqls | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index 1f480956b..fd2cc92ad 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -4,8 +4,8 @@ type Mutation { addProductsToWishlist(wishlistId: ID!, wishlistItems: [WishlistItemInput!]!): AddProductsToWishlistOutput removeProductsFromWishlist(wishlistId: ID!, wishlistItemsIds: [ID!]!): RemoveProductsFromWishlistOutput updateProductsInWishlist(wishlistId: ID!, wishlistItems: [WishlistItemUpdateInput!]!): UpdateProductsInWishlistOutput - copyProductsBetweenWishlists(sourceUid: ID!, destinationUid: ID!, wishlistItems: [WishlistItemCopyInput!]!): CopyProductsBetweenWishlistsOutput @doc(description: "Copy a product to the wish list") - moveProductsBetweenWishlists(sourceUid: ID!, destinationUid: ID!, wishlistItems: [WishlistItemMoveInput!]!): MoveProductsBetweenWishlistsOutput @doc(description: "Move products from one wish list to another") + copyProductsBetweenWishlists(sourceWishlistUid: ID!, destinationWishlistUid: ID!, wishlistItems: [WishlistItemCopyInput!]!): CopyProductsBetweenWishlistsOutput @doc(description: "Copy a product to the wish list") + moveProductsBetweenWishlists(sourceWishlistUid: ID!, destinationWishlistUid: ID!, wishlistItems: [WishlistItemMoveInput!]!): MoveProductsBetweenWishlistsOutput @doc(description: "Move products from one wish list to another") updateWishlist(input: UpdateWishlistInput!): UpdateWishlistOutput @doc(description: "Change the name and visibility of the specified wish list") } @@ -50,6 +50,7 @@ type AddProductsToWishlistOutput { } type RemoveProductsFromWishlistOutput { + status: Boolean! wishlist: Wishlist! } From 55300d25e42a8af20c4b3597165d6981589773a9 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Tue, 3 Nov 2020 17:02:20 -0600 Subject: [PATCH 389/479] Update Wishlist.graphqls --- design-documents/graph-ql/coverage/customer/Wishlist.graphqls | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index fd2cc92ad..46ed9c5b2 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -110,6 +110,10 @@ type GiftCardOptions { message: String } +type GroupedProductWishlistItem implements WishlistItemInterface { + grouped_products: [GroupedProductItem!]! +} + enum WishlistVisibilityEnum @doc(description: "This enumeration defines the wish list visibility types") { PUBLIC PRIVATE From d830efcda7e70b5b8ae38b85b1c4f936f468500f Mon Sep 17 00:00:00 2001 From: Eduard Chitoraga Date: Wed, 4 Nov 2020 11:08:54 +0200 Subject: [PATCH 390/479] We shouldn't give the possibility to update the registry's type. --- .../graph-ql/coverage/customer/gift-registry.graphqls | 1 - 1 file changed, 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index 7a1d01681..cb1a86599 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -70,7 +70,6 @@ input UpdateGiftRegistryItemInput { input UpdateGiftRegistryInput { event_name: String - type_id: String message: String privacy_settings: GiftRegistryPrivacySettings status: GiftRegistryStatus From 99281d715af13c46b6ab6e3c16c1823dc1fb9454 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 5 Nov 2020 13:38:06 -0600 Subject: [PATCH 391/479] Update Wishlist.graphqls --- .../graph-ql/coverage/customer/Wishlist.graphqls | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index 46ed9c5b2..ed30e28f6 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -18,7 +18,10 @@ type Customer { type Wishlist { id: ID items: [WishlistItem] @deprecated(reason: "Use field `items_v2` from type `Wishlist` instead") - items_v2: [WishlistItemInterface] @doc(description: "An array of items in the customer's wishlist") + items_v2( + currentPage: Int = 1, + pageSize: Int = 20 + ): WishlistItems @doc(description: "An array of items in the customer's wishlist") items_count: Int sharing_code: String updated_at: String @@ -26,6 +29,12 @@ type Wishlist { visibility: WishlistVisibilityEnum! } +type WishlistItems { + items: [WishlistItemInterface]! @doc(description: "Wishlist items list") + page_info: SearchResultPageInfo + total_pages: Int! @doc(description: "total count of wishlist items") +} + input CreateWishlistInput { name: String! visibility: WishlistVisibilityEnum! From 3ca8559ca034ddf3f6e37b487da8b2136b8df00d Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 5 Nov 2020 16:53:18 -0600 Subject: [PATCH 392/479] Update Wishlist.graphqls --- .../coverage/customer/Wishlist.graphqls | 25 ++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index ed30e28f6..fe48b067a 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -1,12 +1,16 @@ type Mutation { createWishlist(input: CreateWishlistInput!): CreateWishlistOutput # Multiple wishlists Commerce functionality deleteWishlist(wishlistUid: ID!): DeleteWishlistOutput # Commerce fucntionality - in Opens Source we assume customer always has one wishlist - addProductsToWishlist(wishlistId: ID!, wishlistItems: [WishlistItemInput!]!): AddProductsToWishlistOutput + addProductsToWishlist(wishlistId: ID!, wishlistItems: [WishlistItemInput!]!): AddProductsToWishlistOutput removeProductsFromWishlist(wishlistId: ID!, wishlistItemsIds: [ID!]!): RemoveProductsFromWishlistOutput updateProductsInWishlist(wishlistId: ID!, wishlistItems: [WishlistItemUpdateInput!]!): UpdateProductsInWishlistOutput copyProductsBetweenWishlists(sourceWishlistUid: ID!, destinationWishlistUid: ID!, wishlistItems: [WishlistItemCopyInput!]!): CopyProductsBetweenWishlistsOutput @doc(description: "Copy a product to the wish list") moveProductsBetweenWishlists(sourceWishlistUid: ID!, destinationWishlistUid: ID!, wishlistItems: [WishlistItemMoveInput!]!): MoveProductsBetweenWishlistsOutput @doc(description: "Move products from one wish list to another") - updateWishlist(input: UpdateWishlistInput!): UpdateWishlistOutput @doc(description: "Change the name and visibility of the specified wish list") + updateWishlist( wishlistId: ID!, input: UpdateWishlistInput!): UpdateWishlistOutput @doc(description: "Change the name and visibility of the specified wish list") + addWishlistItemsToCart( + wishlistId: ID!, @doc(description: "unique Id of wishlist") + wishlistItemUids: [ID!] @doc(description: "Optional param. selected wish list items that are to be added") + ): AddWishlistItemsToCartOutput @doc(description: "Add Requisition List Items To Customer Cart") } type Customer { @@ -41,7 +45,6 @@ input CreateWishlistInput { } input UpdateWishlistInput { - wishlistId: ID! name: String visibility: WishlistVisibilityEnum } @@ -67,6 +70,22 @@ type UpdateProductsInWishlistOutput { wishlist: Wishlist! } +type AddWishlistItemsToCartOutput { + status: Boolean! + add_wishlist_items_to_cart_user_errors: [AddWishlistItemUserError]! +} + +type AddWishlistItemUserError { + message: String! + type: AddWishlistItemUserErrorType! +} + +enum AddWishlistItemUserErrorType { + OUT_OF_STOCK + MAX_QTY_FOR_USER + NOT_AVAILABLE +} + input WishlistItemInput { sku: String! quantity: Float! From 4bac3300dd41e4607e4fedf1501998eedeec365e Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Thu, 5 Nov 2020 16:58:30 -0600 Subject: [PATCH 393/479] add changes to match wishlist schema --- .../coverage/b2b/requisitionList.graphqls | 102 ++++++++++++------ 1 file changed, 71 insertions(+), 31 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls index 9740bba00..540114239 100644 --- a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls +++ b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls @@ -59,22 +59,38 @@ type RequistionListItems { interface RequisitionListItemInterface @doc(description: "Interface type for Requisition List Item") { uid: ID! @doc(description:"Unique Identifier of Requisition List Item") product: ProductInterface! - qty: Float! @doc(description: "Quantity added") + quantity: Float! @doc(description: "Quantity added") + customizable_options: [SelectedCustomizableOption] @doc(description: "custom Option selected") } -type DefaultRequisitionListItem implements RequisitionListItemInterface +type SimpleRequisitionListItem implements RequisitionListItemInterface @doc(description: "Requisition List Item Implementation that for Simple and Virtual Products") { - uid: ID! @doc(description: "Unique Identifier of Requisition List Item") - product: ProductInterface! - qty: Float! @doc(description: "Quantity added") - customizable_options: [SelectedCustomizableOption] @doc(description: "custom Option selected") +} + +type GiftCardRequisitionListItem implements RequisitionListItemInterface +@doc(description: "Requisition List Item Implementation that for GiftCard Products") { + gift_card_options: GiftCardOptions! +} + +type GiftCardOptions { + sender_name: String + sender_email: String + recipient_name: String + recipient_email: String + amount: Money + custom_giftcard_amount: Money + message: String +} + +type GroupedProductRequisitionListItem implements RequisitionListItemInterface { + grouped_products: [GroupedProductItem!]! } type DownloadableRequisitionListItem implements RequisitionListItemInterface @doc(description: "Requisition List Item Implementation that for Downloadable Products") { uid: ID! @doc(description: "Unique Identifier of Requisition List Item") product: ProductInterface! - qty: Float! @doc(description: "Quantity added") + quantity: Float! @doc(description: "Quantity added") customizable_options: [SelectedCustomizableOption] @doc(description: "custom Option selected") links: [DownloadableProductLinks] @doc(description: "DownloadableProductLinks defines characteristics of a downloadable product") samples: [DownloadableProductSamples] @doc(description: "DownloadableProductSamples defines characteristics of a downloadable product") @@ -84,7 +100,7 @@ type BundleRequisitionListItem implements RequisitionListItemInterface @doc(description: "Requisition List Item Implementation that for Bundle Products") { uid: ID! @doc(description: "Unique Identifier of Requisition List Item") product: ProductInterface! - qty: Float! @doc(description: "Quantity added") + quantity: Float! @doc(description: "Quantity added") customizable_options: [SelectedCustomizableOption] @doc(description: "custom Option selected") bundle_options: [SelectedBundleOption]! @doc(description: "selected bundle options") } @@ -93,21 +109,19 @@ type ConfigurableRequisitionListItem implements RequisitionListItemInterface @doc(description: "Requisition List Item Implementation that for Configurable Products") { uid: ID! @doc(description: "Unique Identifier of Requisition List Item") product: ProductInterface! - qty: Float! @doc(description: "Quantity added") + quantity: Float! @doc(description: "Quantity added") customizable_options: [SelectedCustomizableOption] @doc(description: "custom Option selected") configurable_options: [SelectedConfigurableOption] @doc(description: "Configurable options selected") } type Mutation { createRequisitionList( - name: String!, @doc(description: "name for the list") - description: String @doc(description: "description For the list") + input: CreateRequisitionListInput ): CreateRequisitionListOutput @doc(description: "Create Empty Requisition List") updateRequisitionList( requisitionListUid: ID!, @doc(description: "unique Id of requisition list") - name: String!, @doc(description: "new name for list") - description: String @doc(description: "new description For the List") + input: UpdateRequisitionListInput ): UpdateRequisitionListOutput @doc(description: "Rename a requisition list and change description") deleteRequisitionList( @@ -124,26 +138,21 @@ type Mutation { requisitionListItemUids: [ID!]! @doc(description: "unique Ids of Items to be deleted from requisition list") ): DeleteRequisitionListItemsOutput @doc(description: "Delete Items in requisition list") - updateRequisitionListItems( - requisitionListUid: ID!, @doc(description: "unique Id of requisition list") - items: [UpdateRequisitionListItemsInput!]! @doc(description: "Items to be updated from requisition list") - ): UpdateRequisitionListItemsOutput @doc(description: "Update Items in requisition list") - addRequisitionListItemsToCart( requisitionListUid: ID!, @doc(description: "unique Id of requisition list") - requisitionListItemUids: [ID!]! @doc(description: "selected requisition list items that are to be added") + requisitionListItemUids: [ID!] @doc(description: "selected requisition list items that are to be added. Not providing this parameter will all items from req. list to the cart") ): AddRequisitionListItemsToCartOutput @doc(description: "Add Requisition List Items To Customer Cart") copyItemsBetweenRequisitionLists( sourceRequisitionListUid: ID!, @doc(description: "unique Id of source requisition list") destinationRequisitionListUid: ID, @doc(description: "unique Id of destination requisition list") # If null new requisition list will be created - requisitionListItemUids: [ID!]! @doc(description: "selected requisition list items that are to be copied from source") + requisitionListItem: CopyItemsBetweenRequisitionListsInput ): CopyItemsBetweenRequisitionListsOutput @doc(description: "Copy Items from Requisition List to another requisition list") moveItemsBetweenRequisitionLists( sourceRequisitionListUid: ID!, @doc(description: "unique Id of source requisition list") destinationRequisitionListUid: ID, @doc(description: "unique Id of destination requisition list") # If null new requisition list will be created - requisitionListItemUids: [ID!]! @doc(description: "selected requisition list items that are to be moved from source") + requisitionListItem: MoveItemsBetweenRequisitionListsInput ): MoveItemsBetweenRequisitionListsOutput @doc(description: "Move Items from Requisition List to another requisition List") clearCustomerCart( @@ -151,17 +160,35 @@ type Mutation { ): ClearCustomerCartOutput @doc(description: "Clears the cart items") } +type CreateRequisitionListInput { + name: String! @doc(description: "name for the list") + description: String @doc(description: "description For the list") +} + +type UpdateRequisitionListInput { + name: String! @doc(description: "new name for list") + description: String @doc(description: "new description For the List") +} + +type CopyItemsBetweenRequisitionListsInput { + requisitionListItemUids: [ID!]! @doc(description: "selected requisition list items that are to be copied from source") +} + +type MoveItemsBetweenRequisitionListsInput { + requisitionListItemUids: [ID!]! @doc(description: "selected requisition list items that are to be moved from source") +} + type DeleteRequisitionListItemsOutput { status: Boolean! - list: RequisitionList + requisiton_list: RequisitionList } type UpdateRequisitionListItemsOutput { - list: RequisitionList + requisiton_list: RequisitionList } type AddProductsToRequisitionListOutput { - list: RequisitionList + requisiton_list: RequisitionList } input RequisitionListFilterInput { @@ -171,8 +198,7 @@ input RequisitionListFilterInput { input RequisitionListItemsInput { sku: String! - quantity: Float - parent_sku: String + quantity: Float! selected_options: [ID!] @doc(description: "selected option ID") entered_options: [EnteredOptionInput!] @doc(description: "entered Options ID") } @@ -185,11 +211,11 @@ input UpdateRequisitionListItemsInput { } type CreateRequisitionListOutput { - list: RequisitionList + requisiton_list: RequisitionList } type UpdateRequisitionListOutput { - list: RequisitionList + requisiton_list: RequisitionList } type DeleteRequisitionListOutput { @@ -198,18 +224,32 @@ type DeleteRequisitionListOutput { } type AddRequisitionListItemsToCartOutput { + status: Boolean! + add_requisition_list_items_to_cart_user_errors: [AddRequisitionListItemToCartUserError]! cart: Cart # since requisition list is not mutated it is not part of the output } +type AddRequisitionListItemToCartUserError { + message: String! + type: AddRequisitionListItemToCartUserErrorType! +} + +enum AddRequisitionListItemToCartUserErrorType { + OUT_OF_STOCK + MAX_QTY_FOR_USER + NOT_AVAILABLE +} + type CopyItemsBetweenRequisitionListsOutput { - list: RequisitionList @doc(description: "Destination Requisition List")# since source requisition list is not mutated it is not part of the output + requisiton_list: RequisitionList @doc(description: "Destination Requisition List")# since source requisition list is not mutated it is not part of the output } type MoveItemsBetweenRequisitionListsOutput { - source: RequisitionList @doc(description: "Source Requisition List") - destination: RequisitionList @doc(description: "Destination Requisition List") + source_requisiton_list: RequisitionList @doc(description: "Source Requisition List") + destination_requisiton_list: RequisitionList @doc(description: "Destination Requisition List") } type ClearCustomerCartOutput { + status: Boolean! cart: Cart } From 677f56b08811558f0026bffe85cec04bce2ed17d Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 5 Nov 2020 17:06:29 -0600 Subject: [PATCH 394/479] Update Wishlist.graphqls --- design-documents/graph-ql/coverage/customer/Wishlist.graphqls | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls index fe48b067a..c30b45654 100644 --- a/design-documents/graph-ql/coverage/customer/Wishlist.graphqls +++ b/design-documents/graph-ql/coverage/customer/Wishlist.graphqls @@ -6,9 +6,9 @@ type Mutation { updateProductsInWishlist(wishlistId: ID!, wishlistItems: [WishlistItemUpdateInput!]!): UpdateProductsInWishlistOutput copyProductsBetweenWishlists(sourceWishlistUid: ID!, destinationWishlistUid: ID!, wishlistItems: [WishlistItemCopyInput!]!): CopyProductsBetweenWishlistsOutput @doc(description: "Copy a product to the wish list") moveProductsBetweenWishlists(sourceWishlistUid: ID!, destinationWishlistUid: ID!, wishlistItems: [WishlistItemMoveInput!]!): MoveProductsBetweenWishlistsOutput @doc(description: "Move products from one wish list to another") - updateWishlist( wishlistId: ID!, input: UpdateWishlistInput!): UpdateWishlistOutput @doc(description: "Change the name and visibility of the specified wish list") + updateWishlist( wishlistUid: ID!, input: UpdateWishlistInput!): UpdateWishlistOutput @doc(description: "Change the name and visibility of the specified wish list") addWishlistItemsToCart( - wishlistId: ID!, @doc(description: "unique Id of wishlist") + wishlistUid: ID!, @doc(description: "unique Id of wishlist") wishlistItemUids: [ID!] @doc(description: "Optional param. selected wish list items that are to be added") ): AddWishlistItemsToCartOutput @doc(description: "Add Requisition List Items To Customer Cart") } From 45ed2cf5c097dc5cc7144cf196686eacecf9d489 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Thu, 5 Nov 2020 17:11:39 -0600 Subject: [PATCH 395/479] add changes to match wishlist schema --- .../graph-ql/coverage/b2b/requisitionList.graphqls | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls index 540114239..af2aa9817 100644 --- a/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls +++ b/design-documents/graph-ql/coverage/b2b/requisitionList.graphqls @@ -124,13 +124,18 @@ type Mutation { input: UpdateRequisitionListInput ): UpdateRequisitionListOutput @doc(description: "Rename a requisition list and change description") + updateRequisitionListItems( + requisitionListUid: ID!, @doc(description: "unique Id of requisition list") + requisitionListItems: [UpdateRequisitionListItemsInput!]! @doc(description: "Items to be updated from requisition list") + ): UpdateRequisitionListItemsOutput @doc(description: "Update Items in requisition list") + deleteRequisitionList( requisitionListUid: ID! @doc(description: "unique Id of requisition list") ): DeleteRequisitionListOutput @doc(description: "Delete a requisition list with Id") addProductsToRequisitionList( requisitionListUid: ID!, @doc(description: "unique Id of requisition list") - items: [RequisitionListItemsInput!]! @doc(description: "Products to be added to requisition list") + requisitionListItems: [RequisitionListItemsInput!]! @doc(description: "Products to be added to requisition list") ): AddProductsToRequisitionListOutput @doc(description: "Add items to requisition list") deleteRequisitionListItems( @@ -156,7 +161,7 @@ type Mutation { ): MoveItemsBetweenRequisitionListsOutput @doc(description: "Move Items from Requisition List to another requisition List") clearCustomerCart( - cartUid: String! @doc(description: "masked Cart Id") + cartUid: String! @doc(description: "masked Cart Id") ): ClearCustomerCartOutput @doc(description: "Clears the cart items") } @@ -204,7 +209,6 @@ input RequisitionListItemsInput { } input UpdateRequisitionListItemsInput { - requisitionListItemUid: ID! @doc(description: "unique ID of Requisition List Item") selected_options: [ID!] @doc(description: "selected option ID") entered_options: [EnteredOptionInput!] @doc(description: "entered Options ID") quantity: Float From 9d839afc1ea085a722323a093351e6de55916ad3 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 11 Nov 2020 11:09:06 -0600 Subject: [PATCH 396/479] modifying customer and author according to new requirements and schema alignment --- .../graph-ql/coverage/returns.graphqls | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/design-documents/graph-ql/coverage/returns.graphqls b/design-documents/graph-ql/coverage/returns.graphqls index ed6db8eee..2a1da5f69 100644 --- a/design-documents/graph-ql/coverage/returns.graphqls +++ b/design-documents/graph-ql/coverage/returns.graphqls @@ -106,9 +106,8 @@ type Return @doc(description: "Customer return") { uid: ID! number: String! @doc(description: "Human-readable return number") order: CustomerOrder @doc(description: "The order associated with the return.") - creation_date: String! @doc(description: "The date when the return was requested.") - customer_email: String! @doc(description: "Email of the customer who created the return.") - customer_name: String @doc(description: "The name of the person returning the item") + creation_at: String! @doc(description: "The date when the return was requested.") + customer: ReturnCustomer! @doc(description: "The data for the customer who created the return request") status: ReturnStatus @doc(description: "Return status.") shipping: ReturnShipping @doc(description: "Shipping information for the return.") comments: [ReturnComment] @doc(description: "A list of comments posted for the return.") @@ -116,6 +115,12 @@ type Return @doc(description: "Customer return") { available_shipping_carriers: [ReturnShippingCarrier] @doc(description: "A list of shipping carriers available for returns.") } +type ReturnCustomer @doc(description: "The Customer information for the return.") { + email: String! @doc(description: "Customer email address.") + firstname: String @doc(description: "Customer first name.") + lastname: String @doc(description: "Customer last name.") +} + type ReturnItem { uid: ID! order_item: OrderItemInterface! @doc(description: "Order item provides access to the product being returned, including selected/entered options information.") @@ -134,8 +139,7 @@ type CustomAttribute { type ReturnComment { uid: ID! @doc(description: "Comment ID.") - author_firstname: String! @doc(description: "First name of the user who posted the comment.") - author_lastname: String! @doc(description: "Last name of the user who posted the comment.") + author: String! @doc(description: "The full name of the the author who posted the comment.") created_at: String! @doc(description: "The date and time when the comment was posted.") text: String! @doc(description: "The comment text.") } From d2f44f9bbd905b2fe724f5abbf3b9238ab7ce554 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 11 Nov 2020 11:46:29 -0600 Subject: [PATCH 397/479] modifying customer and author according to new requirements and schema alignment --- design-documents/graph-ql/coverage/returns.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/returns.graphqls b/design-documents/graph-ql/coverage/returns.graphqls index 2a1da5f69..3b70bfabd 100644 --- a/design-documents/graph-ql/coverage/returns.graphqls +++ b/design-documents/graph-ql/coverage/returns.graphqls @@ -139,7 +139,7 @@ type CustomAttribute { type ReturnComment { uid: ID! @doc(description: "Comment ID.") - author: String! @doc(description: "The full name of the the author who posted the comment.") + author_name: String! @doc(description: "The name of the author who posted the comment.") created_at: String! @doc(description: "The date and time when the comment was posted.") text: String! @doc(description: "The comment text.") } From e8be970a8ebf0d48dc8e32ece750cb00923a722b Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 11 Nov 2020 21:30:37 -0600 Subject: [PATCH 398/479] rename id to uid --- .../coverage/customer/gift-registry.graphqls | 50 +++++++++---------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index 7a1d01681..158cad9d5 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -1,6 +1,6 @@ type Customer { gift_registry_list: [GiftRegistry] - gift_registry(id: ID!): GiftRegistry + gift_registry(uid: ID!): GiftRegistry } type Query { @@ -8,28 +8,28 @@ type Query { giftRegistrySearch( registrantFirstname: String!, registrantLastname: String!, - giftRegistryTypeId: ID, + giftRegistryTypeUid: ID, searchableDynamicAttributes: [GiftRegistryDynamicAttributeInput] @doc(description: "For select attributes ID should be provided expected. For range search, '_from' and '_to' suffixes can be added to the attribute code. For text attributes provide value for exact matching.") ): [GiftRegistry] @doc(description: "Gift registry search by registrant name and additional searchable attributes.") - giftRegistry(id: ID!): GiftRegistry @doc(description: "This query is intended for guests and some fields of GiftRegistry will not be availalbe") + giftRegistry(giftRegistryUid: ID!): GiftRegistry @doc(description: "This query is intended for guests and some fields of GiftRegistry will not be availalbe") } type Mutation { # All mutations below should only be accessible to the registry owner. Guest users should be getting authorization error createGiftRegistry(giftRegistry: CreateGiftRegistryInput!): CreateGiftRegistryOutput - updateGiftRegistry(id: ID!, giftRegistry: UpdateGiftRegistryInput!): UpdateGiftRegistryOutput - removeGiftRegistry(id: ID!): RemoveGiftRegistryOutput + updateGiftRegistry(giftRegistryUid: ID!, giftRegistry: UpdateGiftRegistryInput!): UpdateGiftRegistryOutput + removeGiftRegistry(giftRegistryUid: ID!): RemoveGiftRegistryOutput - addGiftRegistryItems(giftRegistryId: ID!, items: [AddGiftRegistryItemInput!]!): AddGiftRegistryItemsOutput - removeGiftRegistryItems(giftRegistryId: ID!, itemIds: [ID!]!): RemoveGiftRegistryItemsOutput - updateGiftRegistryItems(giftRegistryId: ID!, items: [UpdateGiftRegistryItemInput!]!): UpdateGiftRegistryItemsOutput + addGiftRegistryItems(giftRegistryUid: ID!, items: [AddGiftRegistryItemInput!]!): AddGiftRegistryItemsOutput + removeGiftRegistryItems(giftRegistryUid: ID!, itemIds: [ID!]!): RemoveGiftRegistryItemsOutput + updateGiftRegistryItems(giftRegistryUid: ID!, items: [UpdateGiftRegistryItemInput!]!): UpdateGiftRegistryItemsOutput - addGiftRegistryRegistrants(giftRegistryId: ID!, registrants: [AddGiftRegistryRegistrantInput!]!): AddGiftRegistryRegistrantsOutput - updateGiftRegistryRegistrants(giftRegistryId: ID!, registrants: [UpdateGiftRegistryRegistrantInput!]!): UpdateGiftRegistryRegistrantsOutput - removeGiftRegistryRegistrants(giftRegistryId: ID!, registrantIds: [ID!]!): RemoveGiftRegistryRegistrantsOutput + addGiftRegistryRegistrants(giftRegistryUid: ID!, registrants: [AddGiftRegistryRegistrantInput!]!): AddGiftRegistryRegistrantsOutput + updateGiftRegistryRegistrants(giftRegistryUid: ID!, registrants: [UpdateGiftRegistryRegistrantInput!]!): UpdateGiftRegistryRegistrantsOutput + removeGiftRegistryRegistrants(giftRegistryUid: ID!, registrantIds: [ID!]!): RemoveGiftRegistryRegistrantsOutput - shareGiftRegistry(id: ID!, sender: ShareGiftRegistrySenderInput!, invitees: [ShareGiftRegistryInviteeInput!]!): ShareGiftRegistryOutput + shareGiftRegistry(giftRegistryUid: ID!, sender: ShareGiftRegistrySenderInput!, invitees: [ShareGiftRegistryInviteeInput!]!): ShareGiftRegistryOutput } input ShareGiftRegistryInviteeInput @@ -58,19 +58,19 @@ input AddGiftRegistryItemInput { # Should be defined in scope of https://github.com/magento/architecture/blob/master/design-documents/graph-ql/coverage/add-items-to-cart-single-mutation.md input EnteredOptionInput { - id: String! + uid: ID! value: String! } input UpdateGiftRegistryItemInput { - id: ID! + giftRegistryItemUid: ID! quantity: Float! note: String } input UpdateGiftRegistryInput { event_name: String - type_id: String + giftRegistryTypeUid: ID message: String privacy_settings: GiftRegistryPrivacySettings status: GiftRegistryStatus @@ -79,9 +79,9 @@ input UpdateGiftRegistryInput { } input CreateGiftRegistryInput { - id: ID @doc(description: "Optional id, can be generated on the client and used for sending multiple gift-registry related mutations in a single request. For example, create registry and immediatly add items or registrants.") + giftRegistryUid: ID @doc(description: "Optional uid, can be generated on the client and used for sending multiple gift-registry related mutations in a single request. For example, create registry and immediatly add items or registrants.") event_name: String! - type_id: String! + giftRegistryTypeUid: ID! message: String! privacy_settings: GiftRegistryPrivacySettings! status: GiftRegistryStatus! @@ -92,11 +92,11 @@ input CreateGiftRegistryInput { input GiftRegistryShippingAddressInput @doc(description: "Either address data or address ID should be provided. In case both are provided, validation will fail") { address_data: CustomerAddressInput - address_id: Int + address_id: ID } input UpdateGiftRegistryRegistrantInput { - id: ID! + giftRegistryRegistrantUid: ID! first_name: String last_name: String email: String @@ -156,7 +156,7 @@ type ShareGiftRegistryOutput { } type GiftRegistryType { - id: ID! + uid: ID! label: String! dynamic_attributes_metadata: [GiftRegistryDynamicAttributeMetadataInterface] } @@ -225,11 +225,11 @@ type GiftRegistrySelectAttributeOptionMetadata { } type GiftRegistry { - id: ID! + uid: ID! event_name: String! type: GiftRegistryType message: String! - created_on: String! @doc(description: "Creation date") @doc(description: "Accessible to the registry owner only") + created_at: String! @doc(description: "Creation date") privacy_settings: GiftRegistryPrivacySettings! @doc(description: "Accessible to the registry owner only") status: GiftRegistryStatus! @doc(description: "Accessible to the registry owner only") owner_name: String! @@ -240,11 +240,11 @@ type GiftRegistry { } interface GiftRegistryItemInterface { - id: String! + uid: String! quantity: Float! quantity_fulfilled: Float! note: String - added_on: String! + date_added: String! product: ProductInterface customizable_options: [SelectedCustomizableOption] } @@ -302,7 +302,7 @@ enum GiftRegistryDynamicAttributeGroup { } type GiftRegistryRegistrant { - id: ID! + uid: ID! first_name: String! last_name: String! email: String! @doc(description: "Accessible to the registry owner only") From f0c4f95434d3abc79c1e885fce0fbf46f5a43495 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 11 Nov 2020 21:46:36 -0600 Subject: [PATCH 399/479] add uid changes to giftregistry --- .../coverage/customer/gift-registry.md | 140 +++++++++--------- 1 file changed, 70 insertions(+), 70 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.md b/design-documents/graph-ql/coverage/customer/gift-registry.md index 3e85ada60..4917eee63 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.md +++ b/design-documents/graph-ql/coverage/customer/gift-registry.md @@ -12,7 +12,7 @@ First, get a list of available gift registry types and dynamic attributes metada ```graphql { giftRegistryTypes { - id + uid label dynamic_attributes_metadata { code @@ -48,10 +48,10 @@ First, get a list of available gift registry types and dynamic attributes metada Then create a new gift registry based on the user input. Registrants are added using a separate mutation, which can be sent in the same request if gift registry ID is client-side generated. ```graphql # In real query only one should be provided: existing address ID OR address data -mutation CreateGiftRegistryWithRegistrants($giftRegistryData: CreateGiftRegistryInput!, $giftRegistryId: ID!, $registrantsData: [AddGiftRegistryRegistrantInput!]!) { +mutation CreateGiftRegistryWithRegistrants($giftRegistryData: CreateGiftRegistryInput!, $giftRegistryUid: ID!, $registrantsData: [AddGiftRegistryRegistrantInput!]!) { createGiftRegistry(giftRegistry: $giftRegistryData) { gift_registry { - id + uid event_name shipping_address { id @@ -59,10 +59,10 @@ mutation CreateGiftRegistryWithRegistrants($giftRegistryData: CreateGiftRegistry } } } - addGiftRegistryRegistrants(giftRegistryId: $giftRegistryId, registrants: $registrantsData) { + addGiftRegistryRegistrants(giftRegistryUid: $giftRegistryUid, registrants: $registrantsData) { gift_registry { registrants { - id + iud first_name last_name email @@ -79,11 +79,11 @@ mutation CreateGiftRegistryWithRegistrants($giftRegistryData: CreateGiftRegistry The following JSON represents query variables for the `CreateGiftRegistryWithRegistrants` mutation above. ```json { - "giftRegistryId": "optional client-generated ID", + "giftRegistryUid": "optional client-generated UID", "giftRegistryData": { - "id": "optional client-generated ID", + "uid": "optional client-generated UID", "event_name": "My Birthday", - "type_id": "2", + "giftRegistryTypeUid": "2", "message": "Pleas come to my birthday", "privacy_settings":"PUBLIC", "status": "ACTIVE", @@ -135,7 +135,7 @@ The following JSON represents query variables for the `CreateGiftRegistryWithReg { customer { gift_registry_list { - id + uid event_name created_on message @@ -151,13 +151,13 @@ Render the edit gift registry form and populate it with current gift registry pr ```graphql { customer { - gift_registry(id: "ID obtained from the list query") { + gift_registry(giftRegistryUid: "ID obtained from the list query") { event_name message privacy_settings status registrants { - id + uid first_name last_name email @@ -224,10 +224,10 @@ Render the edit gift registry form and populate it with current gift registry pr Modify gift registry data: ```graphql -mutation UpdateGiftRegistryWithRegistrants($giftRegistryId: ID!, $giftRegistryData: UpdateGiftRegistryInput!, $registrantsData: [UpdateGiftRegistryRegistrantInput!]!) { - updateGiftRegistry(id: $giftRegistryId, giftRegistry: $giftRegistryData) { +mutation UpdateGiftRegistryWithRegistrants($giftRegistryUid: ID!, $giftRegistryData: UpdateGiftRegistryInput!, $registrantsData: [UpdateGiftRegistryRegistrantInput!]!) { + updateGiftRegistry(giftRegistryUid: $giftRegistryUid, giftRegistry: $giftRegistryData) { gift_registry { - id + uid event_name shipping_address { id @@ -235,10 +235,10 @@ mutation UpdateGiftRegistryWithRegistrants($giftRegistryId: ID!, $giftRegistryDa } } } - updateGiftRegistryRegistrants(giftRegistryId: $giftRegistryId, registrants: $registrantsData) { + updateGiftRegistryRegistrants(giftRegistryUid: $giftRegistryUid, registrants: $registrantsData) { gift_registry { registrants { - id + uid first_name last_name email @@ -255,10 +255,10 @@ mutation UpdateGiftRegistryWithRegistrants($giftRegistryId: ID!, $giftRegistryDa The JSON below should be used as query variable for the gift registry update mutation above: ```json { - "giftRegistryId": "existing-gift-registry-ID", + "giftRegistryUid": "existing-gift-registry-ID", "giftRegistryData": { "event_name": "My Birthday", - "type_id": "2", + "giftRegistryTypeUid": "2", "message": "Pleas come to my birthday", "privacy_settings":"PUBLIC", "status": "ACTIVE", @@ -290,7 +290,7 @@ The JSON below should be used as query variable for the gift registry update mut }, "registrantsData": [ { - "id": "existing-registrant-id", + "uid": "existing-registrant-uid", "email": "John@example.com", "first_name": "John", "last_name": "Roller", @@ -308,8 +308,8 @@ The JSON below should be used as query variable for the gift registry update mut ### Gift registry owner removes an existing gift registry ```graphql -mutation RemoveGiftRegistry($giftRegistryId: ID!) { - removeGiftRegistry(id: $giftRegistryId) { +mutation RemoveGiftRegistry($giftRegistryUid: ID!) { + removeGiftRegistry(giftRegistryUid: $giftRegistryUid) { is_removed } } @@ -327,13 +327,13 @@ It is critical to have ability to avoid the hash generation on the client, that { customerCart { items { - id + uid quantity product { sku } customizable_options { - id_v2 + uid } ... on BundleCartItem { bundle_options { @@ -346,17 +346,17 @@ It is critical to have ability to avoid the hash generation on the client, that ... on ConfigurableCartItem { child_sku configurable_options { - id_v2 + uid } } ... on DownloadableCartItem { links_v2 { - id + uid } } ... on GiftCardCartItem { amount { - id + uid } } } @@ -375,13 +375,13 @@ Query structure is almost identical to the query for getting items customer { wishlist { items { - id + uid quantity product { sku } customizable_options { - id_v2 + uid } ... on BundleWishlistItem { bundle_options { @@ -394,16 +394,16 @@ Query structure is almost identical to the query for getting items ... on ConfigurableWishlistItem { child_sku configurable_options { - id_v2 + uid } } ... on DownloadableWishlistItem { links_v2 { - id + uid } } ... on GiftCardWishlistItem { - id + uid } } } @@ -416,12 +416,12 @@ Query structure is almost identical to the query for getting items Based on that information we can send a mutation to add the selected item to gift registry. ```graphql -mutation AddGiftRegistryItems($giftRegistryId: ID!, $giftRegistryItems: [AddGiftRegistryItemInput!]!) { - addGiftRegistryItems(giftRegistryId: $giftRegistryId, items: $giftRegistryItems) { +mutation AddGiftRegistryItems($giftRegistryUid: ID!, $giftRegistryItems: [AddGiftRegistryItemInput!]!) { + addGiftRegistryItems(giftRegistryUid: $giftRegistryUid, items: $giftRegistryItems) { gift_registry { event_name items { - id + uid product { name thumbnail { @@ -429,12 +429,12 @@ mutation AddGiftRegistryItems($giftRegistryId: ID!, $giftRegistryItems: [AddGift } } selected_customizable_options { - id + uid is_required label sort_order values { - id + uid price { type units @@ -450,11 +450,11 @@ mutation AddGiftRegistryItems($giftRegistryId: ID!, $giftRegistryItems: [AddGift quantity_fulfilled ... on BundleGiftRegistryItem { selected_bundle_options { - id + uid label type values { - id + uid label price quantity @@ -463,7 +463,7 @@ mutation AddGiftRegistryItems($giftRegistryId: ID!, $giftRegistryItems: [AddGift } ... on ConfigurableGiftRegistryItem { selected_configurable_options { - id + uid option_label value_id value_label @@ -503,7 +503,7 @@ Simple product with custom options: ```json { - "giftRegistryId": "existing-gift-registry-id", + "giftRegistryUid": "existing-gift-registry-uid", "giftRegistryItems": [ { "sku": "simple-hat", @@ -514,7 +514,7 @@ Simple product with custom options: ], "entered_options": [ { - "id": "hash from custom phrase option ID", + "uid": "hash from custom phrase option UID", "value": "Custom Hat" } ] @@ -526,7 +526,7 @@ Simple product with custom options: Configurable product with custom options: ```json { - "giftRegistryId": "existing-gift-registry-id", + "giftRegistryUid": "existing-gift-registry-uid", "giftRegistryItems": [ { "sku": "custom-hat", @@ -539,7 +539,7 @@ Configurable product with custom options: ], "entered_options": [ { - "id": "hash from custom phrase option ID", + "uid": "hash from custom phrase option UID", "value": "Custom Hat" } ] @@ -552,7 +552,7 @@ Bundle product with custom options: ```json { - "giftRegistryId": "existing-gift-registry-id", + "giftRegistryUid": "existing-gift-registry-uid", "giftRegistryItems": [ { "sku": "fan-kit-hat", @@ -565,7 +565,7 @@ Bundle product with custom options: ], "entered_options": [ { - "id": "hash based on custom phrase option goes here. Must be identical for all bundle children.", + "uid": "hash based on custom phrase option goes here. Must be identical for all bundle children.", "value": "Custom Text" } ] @@ -581,7 +581,7 @@ Bundle product with custom options: ], "entered_options": [ { - "id": "hash based on custom phrase option goes here. Must be identical for all bundle children.", + "uid": "hash based on custom phrase option goes here. Must be identical for all bundle children.", "value": "Custom Text" } ] @@ -593,7 +593,7 @@ Bundle product with custom options: Downloadable product with custom options: ```json { - "giftRegistryId": "existing-gift-registry-id", + "giftRegistryUid": "existing-gift-registry-uid", "giftRegistryItems": [ { "sku": "downloadable-product", @@ -605,7 +605,7 @@ Downloadable product with custom options: ], "entered_options": [ { - "id": "hash from custom text option ID", + "uid": "hash from custom text option UID", "value": "Custom Entry" } ] @@ -617,7 +617,7 @@ Downloadable product with custom options: Gift card product with custom options: ```json { - "giftRegistryId": "existing-gift-registry-id", + "giftRegistryUid": "existing-gift-registry-uid", "giftRegistryItems": [ { "sku": "giftcard-product", @@ -628,7 +628,7 @@ Gift card product with custom options: ], "entered_options": [ { - "id": "hash from custom text option ID", + "uid": "hash from custom text option UID", "value": "Custom Entry" } ] @@ -640,7 +640,7 @@ Gift card product with custom options: Virtual card product with custom options: ```json { - "giftRegistryId": "existing-gift-registry-id", + "giftRegistryUid": "existing-gift-registry-uid", "giftRegistryItems": [ { "sku": "virtual-product", @@ -650,7 +650,7 @@ Virtual card product with custom options: ], "entered_options": [ { - "id": "hash from custom text option ID", + "uid": "hash from custom text option ID", "value": "Custom Entry" } ] @@ -664,15 +664,15 @@ Virtual card product with custom options: The following query returns enough data to add product to cart or wishlist. ```graphql { - giftRegistry(id: "existing-gift-registry-id") { + giftRegistry(uid: "existing-gift-registry-uid") { items { - id + uid quantity product { sku } customizable_options { - id_v2 + uid } ... on BundleGiftRegistryItem { bundle_options { @@ -685,16 +685,16 @@ The following query returns enough data to add product to cart or wishlist. ... on ConfigurableGiftRegistryItem { child_sku configurable_options { - id_v2 + uid } } ... on DownloadableGiftRegistryItem { links { - id + uid } } ... on GiftCardGiftRegistryItem { - id + uid } } } @@ -704,11 +704,11 @@ The following query returns enough data to add product to cart or wishlist. ### Gift registry owner removes items from an existing gift registry ```graphql -mutation RemoveGiftRegistryItem($giftRegistryId: ID!, $itemIds: [ID!]!) { - removeGiftRegistryItems(giftRegistryId: $giftRegistryId, itemIds: $itemIds) { +mutation RemoveGiftRegistryItem($giftRegistryUid: ID!, $itemIds: [ID!]!) { + removeGiftRegistryItems(giftRegistryUid: $giftRegistryUid, itemIds: $itemIds) { gift_registry { items { - id + uid } } } @@ -718,8 +718,8 @@ mutation RemoveGiftRegistryItem($giftRegistryId: ID!, $itemIds: [ID!]!) { Query variables: ```json { - "giftRegistryId": "existing-gift-registry-id", - "itemIds": ["item-one-id", "item-two-id"] + "giftRegistryUid": "existing-gift-registry-uid", + "itemIds": ["item-one-uid", "item-two-uid"] } ``` @@ -730,7 +730,7 @@ First, storefront application retrieves gift registry search form metadata: ```graphql { giftRegistryTypes { - id + uid label dynamic_attributes_metadata { code @@ -772,10 +772,10 @@ Explicitly excluded scenarios: search by ID and by email. giftRegistrySearch( registrantFirstname: "John", registrantLastname: "Roller", - giftRegistryTypeId: "2", + giftRegistryTypeUid: "2", searchableDynamicAttributes: [{code: "event_country", value: "US"}] ) { - id + uid event_name dynamic_attributes { code @@ -794,8 +794,8 @@ This link will contain gift registry hash as query parameter and should lead to The application should parse the URL, extract gift registry ID hash and query gift registry details by ID. ```graphql -mutation ShareGiftRegistry($id: ID!, $sender: ShareGiftRegistrySenderInput!, $invitees: [ShareGiftRegistryInviteeInput!]!) { - shareGiftRegistry(id: $id, sender: $sender, invitees: $invitees) { +mutation ShareGiftRegistry($giftRegistryUid: ID!, $sender: ShareGiftRegistrySenderInput!, $invitees: [ShareGiftRegistryInviteeInput!]!) { + shareGiftRegistry(giftRegistryUid: $uid, sender: $sender, invitees: $invitees) { is_shared } } @@ -805,7 +805,7 @@ The following JSON should be provided as query variables: ```json { - "id": "existing-gift-registry-id", + "uid": "existing-gift-registry-uid", "sender": { "message": "Hi, please come to my birth day", "name": "John Roller" @@ -823,7 +823,7 @@ The following JSON should be provided as query variables: ```graphql { - giftRegistry(id: "ID obtained from the invitation link in email") { + giftRegistry(uid: "ID obtained from the invitation link in email") { event_name message dynamic_attributes { From b41c87890b14c148508bf5b2899f1ca1b50afe4f Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 11 Nov 2020 21:56:52 -0600 Subject: [PATCH 400/479] add uid changes to giftregistry --- .../graph-ql/coverage/customer/gift-registry.graphqls | 4 ++-- design-documents/graph-ql/coverage/customer/gift-registry.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index 158cad9d5..00da8e88b 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -22,12 +22,12 @@ type Mutation { removeGiftRegistry(giftRegistryUid: ID!): RemoveGiftRegistryOutput addGiftRegistryItems(giftRegistryUid: ID!, items: [AddGiftRegistryItemInput!]!): AddGiftRegistryItemsOutput - removeGiftRegistryItems(giftRegistryUid: ID!, itemIds: [ID!]!): RemoveGiftRegistryItemsOutput + removeGiftRegistryItems(giftRegistryUid: ID!, itemUids: [ID!]!): RemoveGiftRegistryItemsOutput updateGiftRegistryItems(giftRegistryUid: ID!, items: [UpdateGiftRegistryItemInput!]!): UpdateGiftRegistryItemsOutput addGiftRegistryRegistrants(giftRegistryUid: ID!, registrants: [AddGiftRegistryRegistrantInput!]!): AddGiftRegistryRegistrantsOutput updateGiftRegistryRegistrants(giftRegistryUid: ID!, registrants: [UpdateGiftRegistryRegistrantInput!]!): UpdateGiftRegistryRegistrantsOutput - removeGiftRegistryRegistrants(giftRegistryUid: ID!, registrantIds: [ID!]!): RemoveGiftRegistryRegistrantsOutput + removeGiftRegistryRegistrants(giftRegistryUid: ID!, registrantUids: [ID!]!): RemoveGiftRegistryRegistrantsOutput shareGiftRegistry(giftRegistryUid: ID!, sender: ShareGiftRegistrySenderInput!, invitees: [ShareGiftRegistryInviteeInput!]!): ShareGiftRegistryOutput } diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.md b/design-documents/graph-ql/coverage/customer/gift-registry.md index 4917eee63..38f45bfdd 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.md +++ b/design-documents/graph-ql/coverage/customer/gift-registry.md @@ -704,8 +704,8 @@ The following query returns enough data to add product to cart or wishlist. ### Gift registry owner removes items from an existing gift registry ```graphql -mutation RemoveGiftRegistryItem($giftRegistryUid: ID!, $itemIds: [ID!]!) { - removeGiftRegistryItems(giftRegistryUid: $giftRegistryUid, itemIds: $itemIds) { +mutation RemoveGiftRegistryItem($giftRegistryUid: ID!, $itemUids: [ID!]!) { + removeGiftRegistryItems(giftRegistryUid: $giftRegistryUid, itemUids: $itemUids) { gift_registry { items { uid From 54f308452feee8fb6f917be877383e306a1ffdf1 Mon Sep 17 00:00:00 2001 From: rakesh Date: Thu, 12 Nov 2020 13:21:56 +0530 Subject: [PATCH 401/479] reward points uid changes --- .../graph-ql/coverage/customer/reward-points.graphqls | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/reward-points.graphqls b/design-documents/graph-ql/coverage/customer/reward-points.graphqls index 540f74077..9e79c74f5 100644 --- a/design-documents/graph-ql/coverage/customer/reward-points.graphqls +++ b/design-documents/graph-ql/coverage/customer/reward-points.graphqls @@ -7,8 +7,8 @@ type Cart { } type Mutation { - applyRewardPointsToCart(cartId: ID!): ApplyRewardPointsToCartOutput @doc(description: "Apply all available points up to the cart total. Partial redemption is not available") - removeRewardPointsFromCart(cartId: ID!): RemoveRewardPointsFromCartOutput @doc(description: "Cancel usage of the previously applied reward points to cart") + applyRewardPointsToCart(cartUid: ID!): ApplyRewardPointsToCartOutput @doc(description: "Apply all available points up to the cart total. Partial redemption is not available") + removeRewardPointsFromCart(cartUid: ID!): RemoveRewardPointsFromCartOutput @doc(description: "Cancel usage of the previously applied reward points to cart") } type ApplyRewardPointsToCartOutput { From 7df17ea52a142785d7d9c304e151754d43474caa Mon Sep 17 00:00:00 2001 From: rakesh Date: Thu, 12 Nov 2020 13:40:29 +0530 Subject: [PATCH 402/479] customer graphql uid changes --- .../coverage/customer/customer.graphqls | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/customer.graphqls b/design-documents/graph-ql/coverage/customer/customer.graphqls index 42075d0f8..8a32a655a 100644 --- a/design-documents/graph-ql/coverage/customer/customer.graphqls +++ b/design-documents/graph-ql/coverage/customer/customer.graphqls @@ -21,8 +21,8 @@ type Mutation { updateCustomer (input: CustomerInput!): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomer") @doc(description:"Update the customer's personal information") revokeCustomerToken: RevokeCustomerTokenOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\RevokeCustomerToken") @doc(description:"Revoke the customer token") createCustomerAddress(input: CustomerAddressInput!): CustomerAddress @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomerAddress") @doc(description: "Create customer address") - updateCustomerAddress(id: Int!, input: CustomerAddressInput): CustomerAddress @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomerAddress") @doc(description: "Update customer address") - deleteCustomerAddress(id: Int!): Boolean @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\DeleteCustomerAddress") @doc(description: "Delete customer address") + updateCustomerAddress(uid: ID!, input: CustomerAddressInput): CustomerAddress @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomerAddress") @doc(description: "Update customer address") + deleteCustomerAddress(uid: ID!): Boolean @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\DeleteCustomerAddress") @doc(description: "Delete customer address") requestPasswordResetEmail(email: String!): Boolean @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\RequestPasswordResetEmail") @doc(description: "Request an email with a reset password token for the registered customer identified by the specified email.") resetPassword(email: String!, resetPasswordToken: String!, newPassword: String!): Boolean @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\ResetPassword") @doc(description: "Reset a customer's password using the reset password token that the customer received in an email after requesting it using requestPasswordResetEmail.") } @@ -51,7 +51,7 @@ input CustomerAddressInput { input CustomerAddressRegionInput @doc(description: "CustomerAddressRegionInput defines the customer's state or province") { region_code: String @doc(description: "The address region code") region: String @doc(description: "The state or province name") - region_id: Int @doc(description: "The unique ID for a pre-defined region") + region_uid: ID @doc(description: "The unique ID for a pre-defined region") } input CustomerAddressAttributeInput { @@ -88,7 +88,7 @@ type RevokeCustomerTokenOutput { type Customer @doc(description: "Customer defines the customer name and address and other details") { created_at: String @doc(description: "Timestamp indicating when the account was created") - group_id: Int @deprecated(reason: "Customer group should not be exposed in the storefront scenarios") + group_uid: ID @deprecated(reason: "Customer group should not be exposed in the storefront scenarios") prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.") firstname: String @doc(description: "The customer's first name") middlename: String @doc(description: "The customer's middle name") @@ -100,17 +100,17 @@ type Customer @doc(description: "Customer defines the customer name and address dob: String @doc(description: "The customer's date of birth") @deprecated(reason: "Use `date_of_birth` instead") date_of_birth: String @doc(description: "The customer's date of birth") taxvat: String @doc(description: "The customer's Value-added tax (VAT) number (for corporate customers)") - id: Int @doc(description: "The ID assigned to the customer") @deprecated(reason: "id is not needed as part of Customer because on server side it can be identified based on customer token used for authentication. There is no need to know customer ID on the client side.") + uid: ID @doc(description: "The ID assigned to the customer") @deprecated(reason: "id is not needed as part of Customer because on server side it can be identified based on customer token used for authentication. There is no need to know customer ID on the client side.") is_subscribed: Boolean @doc(description: "Indicates whether the customer is subscribed to the company's newsletter") @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\IsSubscribed") addresses: [CustomerAddress] @doc(description: "An array containing the customer's shipping and billing addresses") @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CustomerAddresses") gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2)") } type CustomerAddress @doc(description: "CustomerAddress contains detailed information about a customer's billing and shipping addresses"){ - id: Int @doc(description: "The ID assigned to the address object") - customer_id: Int @doc(description: "The customer ID") @deprecated(reason: "customer_id is not needed as part of CustomerAddress, address ID (id) is unique identifier for the addresses.") + uid: ID @doc(description: "The ID assigned to the address object") + customer_iid: ID @doc(description: "The customer ID") @deprecated(reason: "customer_id is not needed as part of CustomerAddress, address ID (id) is unique identifier for the addresses.") region: CustomerAddressRegion @doc(description: "An object containing the region name, region code, and region ID") - region_id: Int @doc(description: "The unique ID for a pre-defined region") @deprecated(reason: "Use `region` instead.") + region_uid: ID @doc(description: "The unique ID for a pre-defined region") @deprecated(reason: "Use `region` instead.") country_id: String @doc(description: "The customer's country") @deprecated(reason: "Use `country_code` instead.") country_code: CountryCodeEnum @doc(description: "The customer's country") @deprecated(reason: "Use `country` instead.") country: Country @doc(description: "The customer's country") @@ -135,7 +135,7 @@ type CustomerAddress @doc(description: "CustomerAddress contains detailed inform type CustomerAddressRegion @doc(description: "CustomerAddressRegion defines the customer's state or province") { region_code: String @doc(description: "The address region code") region: String @doc(description: "The state or province name") - region_id: Int @doc(description: "The unique ID for a pre-defined region") + region_uid: ID @doc(description: "The unique ID for a pre-defined region") } type CustomerAddressAttribute { From 14f99f5d90b729563c413ba5f31a5dab85b0279e Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Mon, 16 Nov 2020 11:46:08 -0600 Subject: [PATCH 403/479] rename created at --- design-documents/graph-ql/coverage/returns.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/returns.graphqls b/design-documents/graph-ql/coverage/returns.graphqls index 3b70bfabd..1249c534e 100644 --- a/design-documents/graph-ql/coverage/returns.graphqls +++ b/design-documents/graph-ql/coverage/returns.graphqls @@ -106,7 +106,7 @@ type Return @doc(description: "Customer return") { uid: ID! number: String! @doc(description: "Human-readable return number") order: CustomerOrder @doc(description: "The order associated with the return.") - creation_at: String! @doc(description: "The date when the return was requested.") + created_at: String! @doc(description: "The date when the return was requested.") customer: ReturnCustomer! @doc(description: "The data for the customer who created the return request") status: ReturnStatus @doc(description: "Return status.") shipping: ReturnShipping @doc(description: "Shipping information for the return.") From 152155912ad7afe8153b640c4dd631189fa8ef9f Mon Sep 17 00:00:00 2001 From: Rakesh Jesadiya Date: Tue, 17 Nov 2020 13:55:35 +0530 Subject: [PATCH 404/479] product review uid changes --- .../graph-ql/coverage/catalog/product-reviews.graphqls | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog/product-reviews.graphqls b/design-documents/graph-ql/coverage/catalog/product-reviews.graphqls index 30cfd6e81..a723a5220 100644 --- a/design-documents/graph-ql/coverage/catalog/product-reviews.graphqls +++ b/design-documents/graph-ql/coverage/catalog/product-reviews.graphqls @@ -44,13 +44,13 @@ type ProductReviewRatingsMetadata { } type ProductReviewRatingMetadata { - id: String! @doc(description: "Base 64 encoded rating id.") + uid: ID! @doc(description: "Base 64 encoded rating uid.") name: String! @doc(description: "The review rating name for example quality, price") values: [ProductReviewRatingValueMetadata!]! @doc(description: "List of product review ratings sorted based on position.") } type ProductReviewRatingValueMetadata { - value_id: String! @doc(description: "Base 64 encoded rating value id.") + value_uid: ID! @doc(description: "Base 64 encoded rating value uid.") value: String! @doc(description: "e.g Good, Perfect, 3, 4, 5") } @@ -71,6 +71,6 @@ input CreateProductReviewInput { } type ProductReviewRatingInput { - id: String! @doc(description: "Base 64 encoded rating id.") - value_id: String! @doc(description: "Base 64 encoded rating value id.") + uid: ID! @doc(description: "Base 64 encoded rating uid.") + value_uid: ID! @doc(description: "Base 64 encoded rating value uid.") } From a80df3d1ca85fd231ce03eedcd3b834fee416884 Mon Sep 17 00:00:00 2001 From: OMelnyk Date: Tue, 8 Dec 2020 21:38:22 +0200 Subject: [PATCH 405/479] proposed changes for dynamic blocks schema --- .../graph-ql/coverage/dynamic-blocks.graphqls | 12 ++++++------ design-documents/graph-ql/coverage/dynamic-blocks.md | 6 +++++- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls index b0e05987c..36328aa5e 100644 --- a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls +++ b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls @@ -11,17 +11,13 @@ type DynamicBlocks { total_count: Int! } -type DynamicBlocksFilterInput { +input DynamicBlocksFilterInput { type: DynamicBlockTypeEnum! locations: [DynamicBlockLocationEnum!] # Blocks for all locations will be displayed if not supplied rotation_mode: DynamicBlockRotationModeEnum! dynamic_block_uids: [ID!] # Only makes sense when DynamicBlockTypeEnum is set to SPECIFIED } -type DynamicBlocksOutput { - dynamic_blocks: DynamicBlocks! -} - enum DynamicBlockTypeEnum { SPECIFIED CART_PRICE_RULE_RELATED @@ -44,5 +40,9 @@ enum DynamicBlockRotationModeEnum { } type Query { - dynamic_blocks(input: DynamicBlocksFilterInput): DynamicBlocksOutput + dynamic_blocks( + input: DynamicBlocksFilterInput + pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. The default is 20") + currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1"), + ): DynamicBlocks! } \ No newline at end of file diff --git a/design-documents/graph-ql/coverage/dynamic-blocks.md b/design-documents/graph-ql/coverage/dynamic-blocks.md index cc2df883a..ab339d2d4 100644 --- a/design-documents/graph-ql/coverage/dynamic-blocks.md +++ b/design-documents/graph-ql/coverage/dynamic-blocks.md @@ -24,7 +24,11 @@ PWA will receive similar JavaScript component definition that can be parsed to e ```graphql { - dynamic_blocks(input: {type: SPECIFIED, locations: [CONTENT], rotation_mode: RANDOM, dynamic_block_uids: [1, 2]}) { + dynamic_blocks( + input: {type: SPECIFIED, locations: [CONTENT], dynamic_block_uids: ["MQ==", "Mg=="]} + pageSize:10 + currentPage: 1 + ) { items { uid content { From 52ec0903450bd8d42e8f1ebb28d8225f7a31a86e Mon Sep 17 00:00:00 2001 From: OMelnyk Date: Tue, 8 Dec 2020 21:41:47 +0200 Subject: [PATCH 406/479] removed rotation mode from graphql schema for dynamic blocks --- .../graph-ql/coverage/dynamic-blocks.graphqls | 8 -------- 1 file changed, 8 deletions(-) diff --git a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls index 36328aa5e..823e31cd5 100644 --- a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls +++ b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls @@ -14,7 +14,6 @@ type DynamicBlocks { input DynamicBlocksFilterInput { type: DynamicBlockTypeEnum! locations: [DynamicBlockLocationEnum!] # Blocks for all locations will be displayed if not supplied - rotation_mode: DynamicBlockRotationModeEnum! dynamic_block_uids: [ID!] # Only makes sense when DynamicBlockTypeEnum is set to SPECIFIED } @@ -32,13 +31,6 @@ enum DynamicBlockLocationEnum { RIGHT } -enum DynamicBlockRotationModeEnum { - NO_ROTATION @doc(description: "Display all.") - RANDOM - SERIES - SHUFFLE -} - type Query { dynamic_blocks( input: DynamicBlocksFilterInput From 3d300c304ec87d52d3e4d1a1b1b821891e031a5a Mon Sep 17 00:00:00 2001 From: Rakesh Jesadiya Date: Thu, 17 Dec 2020 11:05:07 +0530 Subject: [PATCH 407/479] Update customer.graphqls --- design-documents/graph-ql/coverage/customer/customer.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/customer/customer.graphqls b/design-documents/graph-ql/coverage/customer/customer.graphqls index 8a32a655a..8568d7593 100644 --- a/design-documents/graph-ql/coverage/customer/customer.graphqls +++ b/design-documents/graph-ql/coverage/customer/customer.graphqls @@ -108,7 +108,7 @@ type Customer @doc(description: "Customer defines the customer name and address type CustomerAddress @doc(description: "CustomerAddress contains detailed information about a customer's billing and shipping addresses"){ uid: ID @doc(description: "The ID assigned to the address object") - customer_iid: ID @doc(description: "The customer ID") @deprecated(reason: "customer_id is not needed as part of CustomerAddress, address ID (id) is unique identifier for the addresses.") + customer_uid: ID @doc(description: "The customer ID") @deprecated(reason: "customer_id is not needed as part of CustomerAddress, address ID (id) is unique identifier for the addresses.") region: CustomerAddressRegion @doc(description: "An object containing the region name, region code, and region ID") region_uid: ID @doc(description: "The unique ID for a pre-defined region") @deprecated(reason: "Use `region` instead.") country_id: String @doc(description: "The customer's country") @deprecated(reason: "Use `country_code` instead.") From 86e393c4dd741721147ae58c70503071baef5ad6 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 13 Jan 2021 18:54:54 -0600 Subject: [PATCH 408/479] make corrections to the md file --- design-documents/graph-ql/coverage/dynamic-blocks.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/dynamic-blocks.md b/design-documents/graph-ql/coverage/dynamic-blocks.md index ab339d2d4..c8dbb18db 100644 --- a/design-documents/graph-ql/coverage/dynamic-blocks.md +++ b/design-documents/graph-ql/coverage/dynamic-blocks.md @@ -19,8 +19,18 @@ In Luma dynamic blocks rendered to a JavaScript component definition that does r ``` +By parsing `` we get the following relevant data: -PWA will receive similar JavaScript component definition that can be parsed to extract parameters and make a [GraphQL query](./dynamic-blocks.graphqls) to load dynamic blocks. +* `data-banner-id` is the id of the actual widget that contains the dynamic blocks + +* `data-ids="1,3"` are the ids of the dynamic blocks + +* `data-rotate="random"` is an obsolete behavior that we chose not to have in GraphQl + + +Ideally we want these to be rendered with graphql uid and not be exposed with real numeric ids coming from the database. + +Next the PWA will receive similar JavaScript component definition that can be parsed to extract parameters and make a [GraphQL query](./dynamic-blocks.graphqls) to load dynamic blocks. ```graphql { From cb8ca4074f1ce2595f0cf30b24925e5cf1992d7d Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 13 Jan 2021 18:57:35 -0600 Subject: [PATCH 409/479] add end of line to the end of the file --- design-documents/graph-ql/coverage/dynamic-blocks.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls index 823e31cd5..df1b78eca 100644 --- a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls +++ b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls @@ -37,4 +37,4 @@ type Query { pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. The default is 20") currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1"), ): DynamicBlocks! -} \ No newline at end of file +} From 7e4f2dd37c06f26e5971fe65ed3400cfff90523d Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 13 Jan 2021 19:07:14 -0600 Subject: [PATCH 410/479] modifying dynamic blocks schema --- .../graph-ql/coverage/dynamic-blocks.graphqls | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls index df1b78eca..5c9115f1b 100644 --- a/design-documents/graph-ql/coverage/dynamic-blocks.graphqls +++ b/design-documents/graph-ql/coverage/dynamic-blocks.graphqls @@ -1,20 +1,20 @@ type DynamicBlock { - uid: ID! - content: ComplexTextValue! + uid: ID! @doc(description: "The unique ID of the dynamic block") + content: ComplexTextValue! @doc(description: "Contains the renderable HTML code of the dynamic block") } # We don't need name, is_enabled, locations, ga_creative, catalog_price_rule_ids, cart_price_rules_ids, locations on storefront type DynamicBlocks { - items: [DynamicBlock]! - page_info: SearchResultPageInfo - total_count: Int! + items: [DynamicBlock]! @doc(description: "An array containing individual dynamic blocks") + page_info: SearchResultPageInfo @doc(description: "Metadata for pagination rendering") + total_count: Int! @doc(description: "The number of returned dynamic blocks") } input DynamicBlocksFilterInput { - type: DynamicBlockTypeEnum! - locations: [DynamicBlockLocationEnum!] # Blocks for all locations will be displayed if not supplied - dynamic_block_uids: [ID!] # Only makes sense when DynamicBlockTypeEnum is set to SPECIFIED + type: DynamicBlockTypeEnum! @doc(description: "A value indicating the type of dynamic block to filter on") + locations: [DynamicBlockLocationEnum!] @doc(description: "An array indicating the locations the dynamic block can be placed") # Blocks for all locations will be displayed if not supplied + dynamic_block_uids: [ID!] # This value appplies when DynamicBlockTypeEnum is set to SPECIFIED } enum DynamicBlockTypeEnum { From 73407a19195655dfc39aea46699123a407c3e665 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 13 Jan 2021 19:26:20 -0600 Subject: [PATCH 411/479] modify schema to fit new type for search results which is different from owner gift registy type --- .../coverage/customer/gift-registry.graphqls | 32 +++++++++++++------ 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index 6ebacf478..ffa289015 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -1,16 +1,21 @@ type Customer { - gift_registry_list: [GiftRegistry] + gift_registries: [GiftRegistry] gift_registry(uid: ID!): GiftRegistry } type Query { giftRegistryTypes: [GiftRegistryType] @doc(description: "Get a list of available gift registry types") - giftRegistrySearch( - registrantFirstname: String!, - registrantLastname: String!, - giftRegistryTypeUid: ID, - searchableDynamicAttributes: [GiftRegistryDynamicAttributeInput] @doc(description: "For select attributes ID should be provided expected. For range search, '_from' and '_to' suffixes can be added to the attribute code. For text attributes provide value for exact matching.") - ): [GiftRegistry] @doc(description: "Gift registry search by registrant name and additional searchable attributes.") + giftRegistryEmailSearch( + email: String! @doc(description: "The registrant's email") + ): [GiftRegistrySearchResult] @doc(description: "Search for gift registries by specifying a registrant email address") + giftRegistryIdSearch( + giftRegistryUid: String! @doc(description: "The ID of the gift registry") + ): [GiftRegistrySearchResult] @doc(description: "Search for gift registries by specifying a registry URL key") + giftRegistryTypeSearch( + firstName: String! @doc(description: "The first name of the registrant") + lastName: String! @doc(description: "The last name of the registrant") + typeUid: String @doc(description: "The type UID of the registry") + ): [GiftRegistrySearchResult] @doc(description: "Search for gift registries by specifying the registrant name and registry type ID") giftRegistry(giftRegistryUid: ID!): GiftRegistry @doc(description: "This query is intended for guests and some fields of GiftRegistry will not be availalbe") } @@ -32,6 +37,15 @@ type Mutation { shareGiftRegistry(giftRegistryUid: ID!, sender: ShareGiftRegistrySenderInput!, invitees: [ShareGiftRegistryInviteeInput!]!): ShareGiftRegistryOutput } +type GiftRegistrySearchResult { + gift_registry_uid: ID! @doc(description: "The URL key of the gift registry") + name: String! + event_title: String! @doc(description: "The title given to the event") + type: String @doc(description: "The type of event being held") + location: String @doc(description: "The location of the event") + event_date: String @doc(description: "The date of the event") +} + input ShareGiftRegistryInviteeInput { name: String! @@ -302,8 +316,8 @@ enum GiftRegistryDynamicAttributeGroup { type GiftRegistryRegistrant { uid: ID! - first_name: String! - last_name: String! + firstname: String! + lastname: String! email: String! @doc(description: "Accessible to the registry owner only") dynamic_attributes: [GiftRegistryRegistrantDynamicAttribute] } From 562bbd4c001c4aac22af7fb441923142f3a5e9c0 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 13 Jan 2021 19:42:33 -0600 Subject: [PATCH 412/479] - making small corrections --- .../graph-ql/coverage/customer/gift-registry.graphqls | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index ffa289015..85fc8527d 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -253,16 +253,16 @@ type GiftRegistry { } interface GiftRegistryItemInterface { - uid: String! + uid: ID! quantity: Float! quantity_fulfilled: Float! note: String date_added: String! product: ProductInterface - customizable_options: [SelectedCustomizableOption] + customizable_options: [SelectedCustomizableOption] # added support for customizable options } -type SimpleGiftRegistryItem implements GiftRegistryItemInterface { +type GiftRegistryItem implements GiftRegistryItemInterface { } type BundleGiftRegistryItem implements GiftRegistryItemInterface { From 74d002b3b14f30cd12858502c687b5bacf790096 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 13 Jan 2021 19:45:28 -0600 Subject: [PATCH 413/479] - add more corrections --- .../graph-ql/coverage/customer/gift-registry.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.md b/design-documents/graph-ql/coverage/customer/gift-registry.md index 38f45bfdd..14d497dc5 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.md +++ b/design-documents/graph-ql/coverage/customer/gift-registry.md @@ -134,10 +134,10 @@ The following JSON represents query variables for the `CreateGiftRegistryWithReg ```graphql { customer { - gift_registry_list { + gift_registries { uid event_name - created_on + created_at message } } @@ -444,7 +444,7 @@ mutation AddGiftRegistryItems($giftRegistryUid: ID!, $giftRegistryItems: [AddGif label } } - added_on + added_at note quantity quantity_fulfilled From 7c7bf9efa01d39f639678ed809eb23c8dd959b3c Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Tue, 2 Mar 2021 17:04:31 -0600 Subject: [PATCH 414/479] PWA-1486: Define the schema for FPT cart item prices --- design-documents/graph-ql/coverage/quote.graphqls | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls index 296f2ee88..4d38f67bb 100644 --- a/design-documents/graph-ql/coverage/quote.graphqls +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -367,7 +367,8 @@ type Discount @doc(description:"Defines an individual discount. A discount can b } type CartItemPrices { - price: Money! + price: Money! @doc(description:"Item price that might include tax depending on display settings for cart") + fixed_product_taxes: [FixedProductTax] @doc(description:"Applied FPT to the cart item") row_total: Money! row_total_including_tax: Money! discounts: [Discount] @doc(description:"An array of discounts to be applied to the cart item") From 367a21819de969c85e4e4c4f8ebb164cf6077c3a Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 17 Mar 2021 20:35:50 -0500 Subject: [PATCH 415/479] - add uid where possible and leave id where uids are not still introduced - modify other fields to inline --- .../coverage/b2b/negotiableQuotes.graphqls | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 71ad69b77..2e5ba3f98 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -74,8 +74,8 @@ type AddNegotiableQuoteItemsOutput { } input SetNegotiableQuoteShippingAddressInput { - quote_id: ID! @doc(description: "ID obtained from NegotiableQuote type") - customer_address_id: ID! @doc( + quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote type") + customer_address_id: Int! @doc( description: "ID obtained from the CustomerAddress type. A new address can be added using Mutation.createCustomerAddress" ) } @@ -85,14 +85,14 @@ type SetNegotiableQuoteShippingAddressOutput { } input AddNegotiableQuoteItemsInput { - quote_id: ID! @doc(description: "ID from a negotiable quote object") + quote_uid: ID! @doc(description: "UID from a negotiable quote object") # Implementation Note: This *should* be compatible with the new, single # add to cart mutation. https://github.com/magento/architecture/blob/master/design-documents/graph-ql/coverage/AddProductsToCart.graphqls cart_items: [CartItemInput!]! } input DeleteNegotiableQuotesInput { - quote_ids: [ID!]! @doc(description: "A List of IDs obtained from negotiable quote types") + quote_uids: [ID!]! @doc(description: "A List of UIDs obtained from negotiable quote types") } type DeleteNegotiableQuotesOutput { @@ -107,7 +107,7 @@ type DeleteNegotiableQuotesOutput { } input CloseNegotiableQuotesInput { - quote_ids: [ID!]! @doc(description: "A List of IDs from negotiable quote objects") + quote_uids: [ID!]! @doc(description: "A List of IDs from negotiable quote objects") } type CloseNegotiableQuotesOutput { @@ -121,22 +121,22 @@ type CloseNegotiableQuotesOutput { } input RemoveNegotiableQuoteItemsInput { - quote_id: ID! - quote_item_ids: [ID!]! + quote_uid: ID! + quote_item_uids: [ID!]! } input UpdateNegotiableQuoteQuantitiesInput { - quote_id: ID! + quote_uid: ID! items: [NegotiableQuoteItemQuantityInput!]! } input NegotiableQuoteItemQuantityInput { - quote_item_id: ID! + quote_item_uid: ID! quantity: Float! } input RequestNegotiableQuoteInput { - cart_id: ID! + cart_id: Int quote_name: String! comment: NegotiableQuoteCommentInput! # files (attachments) to be added at a later date when file upload design has been finalized @@ -148,7 +148,7 @@ input NegotiableQuoteCommentInput { } input AddNegotiableQuoteCommentInput { - quote_id: ID! + quote_uid: ID! comment: NegotiableQuoteCommentInput! } @@ -195,7 +195,7 @@ enum NegotiableQuoteStatus { } input NegotiableQuoteFilterInput { - ids: FilterEqualTypeInput @doc(description: "Filter by negotiable quote ID(s)") + negotiable_quote_uid: FilterEqualTypeInput @doc(description: "Filter by negotiable quote ID(s)") name: FilterMatchTypeInput @doc(description: "Filter by negotiable quote name") } @@ -276,8 +276,8 @@ type NegotiableQuoteHistoryProductsChange { # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L132-L146 type NegotiableQuoteHistoryProductsRemovedChange { # Open Question: Should `removed_from_catalog` ID type represent the SKU or the product id? - removed_from_catalog: [ID!] @doc(description: "List of product skus removed from seller's catalog") - removed_from_quote: [ProductInterface!] @doc(description: "List of products removed by a buyer or seller") + removed_products_uids_from_catalog: [ID!] @doc(description: "List of product skus removed from seller's catalog") + removed_products_from_quotes: [ProductInterface!] @doc(description: "List of products removed by a buyer or seller") } # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L148-L169 From deb7ca581d30194ee4df450abe6f5da4c37f573c Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 17 Mar 2021 21:38:52 -0500 Subject: [PATCH 416/479] - cart id is actually ID --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 2e5ba3f98..5048ca5c7 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -136,7 +136,7 @@ input NegotiableQuoteItemQuantityInput { } input RequestNegotiableQuoteInput { - cart_id: Int + cart_uid: ID quote_name: String! comment: NegotiableQuoteCommentInput! # files (attachments) to be added at a later date when file upload design has been finalized From 5f7c91045211b9975be6727bdea59c6d5df4e306 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Thu, 18 Mar 2021 14:51:19 -0500 Subject: [PATCH 417/479] - modify uid and history fields --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 5048ca5c7..1f767e5b3 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -136,7 +136,7 @@ input NegotiableQuoteItemQuantityInput { } input RequestNegotiableQuoteInput { - cart_uid: ID + quote_uid: ID! @doc(description: "Cart uid") quote_name: String! comment: NegotiableQuoteCommentInput! # files (attachments) to be added at a later date when file upload design has been finalized @@ -195,7 +195,7 @@ enum NegotiableQuoteStatus { } input NegotiableQuoteFilterInput { - negotiable_quote_uid: FilterEqualTypeInput @doc(description: "Filter by negotiable quote ID(s)") + quote_uid: FilterEqualTypeInput @doc(description: "Filter by quote UID(s)") name: FilterMatchTypeInput @doc(description: "Filter by negotiable quote name") } @@ -276,8 +276,8 @@ type NegotiableQuoteHistoryProductsChange { # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L132-L146 type NegotiableQuoteHistoryProductsRemovedChange { # Open Question: Should `removed_from_catalog` ID type represent the SKU or the product id? - removed_products_uids_from_catalog: [ID!] @doc(description: "List of product skus removed from seller's catalog") - removed_products_from_quotes: [ProductInterface!] @doc(description: "List of products removed by a buyer or seller") + removed_from_catalog_product_uids: [ID!] @doc(description: "List of product UIDs removed from seller's catalog") + removed_from_quote_products: [ProductInterface!] @doc(description: "List of products removed by a buyer or seller") } # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L148-L169 From 182380fee3ab8d301b220fc13c7e97ba8bd3843a Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Thu, 18 Mar 2021 15:03:49 -0500 Subject: [PATCH 418/479] - add description to cart item id as quote id --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 1f767e5b3..d736c90b4 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -122,7 +122,7 @@ type CloseNegotiableQuotesOutput { input RemoveNegotiableQuoteItemsInput { quote_uid: ID! - quote_item_uids: [ID!]! + quote_item_uids: [ID!]! @doc(description:"Cart Item uids") } input UpdateNegotiableQuoteQuantitiesInput { @@ -131,7 +131,7 @@ input UpdateNegotiableQuoteQuantitiesInput { } input NegotiableQuoteItemQuantityInput { - quote_item_uid: ID! + quote_item_uid: ID! @doc(description:"Cart Item uid") quantity: Float! } From 6e9ad1a3cb0573abab7bc89a45cc3920090f5adf Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Mon, 22 Mar 2021 16:38:32 -0500 Subject: [PATCH 419/479] - add cart management to gift registry - add user errors - correct camel case --- .../coverage/customer/gift-registry.graphqls | 42 +++++++++++++++++-- design-documents/graph-ql/directives.graphqls | 39 +++++++++++++++++ 2 files changed, 77 insertions(+), 4 deletions(-) create mode 100644 design-documents/graph-ql/directives.graphqls diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index 85fc8527d..c4a6ceed5 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -9,7 +9,7 @@ type Query { email: String! @doc(description: "The registrant's email") ): [GiftRegistrySearchResult] @doc(description: "Search for gift registries by specifying a registrant email address") giftRegistryIdSearch( - giftRegistryUid: String! @doc(description: "The ID of the gift registry") + giftRegistryUid: ID! @doc(description: "The ID of the gift registry") ): [GiftRegistrySearchResult] @doc(description: "Search for gift registries by specifying a registry URL key") giftRegistryTypeSearch( firstName: String! @doc(description: "The first name of the registrant") @@ -26,7 +26,10 @@ type Mutation { updateGiftRegistry(giftRegistryUid: ID!, giftRegistry: UpdateGiftRegistryInput!): UpdateGiftRegistryOutput removeGiftRegistry(giftRegistryUid: ID!): RemoveGiftRegistryOutput - addGiftRegistryItems(giftRegistryUid: ID!, items: [AddGiftRegistryItemInput!]!): AddGiftRegistryItemsOutput + addGiftRegistryItems(giftRegistryUid: ID!, items: [AddGiftRegistryItemInput!]!): AddGiftRegistryItemsOutput @doc(description: "Adds individual items to the gift registry") + addGiftRegistryItemsFromCart(giftRegistryUid: ID!, cartUid: ID!, emptyCart: Boolean = true): AddGiftRegistryItemsFromCartOutput @doc(description: "Adds the whole cart with all items to the gift registry with option to empty the cart") + moveCartItemsToGiftRegistry(cartUid: ID!, giftRegistryUid: ID!): MoveCartItemsToGiftRegistryOutput @doc(description: "Moves all items items from cart to the gift registry") + removeGiftRegistryItems(giftRegistryUid: ID!, itemUids: [ID!]!): RemoveGiftRegistryItemsOutput updateGiftRegistryItems(giftRegistryUid: ID!, items: [UpdateGiftRegistryItemInput!]!): UpdateGiftRegistryItemsOutput @@ -92,7 +95,8 @@ input UpdateGiftRegistryInput { } input CreateGiftRegistryInput { - giftRegistryUid: ID @doc(description: "Optional uid, can be generated on the client and used for sending multiple gift-registry related mutations in a single request. For example, create registry and immediatly add items or registrants.") + giftRegistryUid: ID @deprecated(reason: "Use `gift_registry_uid` instead") @doc(description: "Optional uid, can be generated on the client and used for sending multiple gift-registry related mutations in a single request. For example, create registry and immediatly add items or registrants.") + gift_registry_uid: ID event_name: String! giftRegistryTypeUid: ID! message: String! @@ -109,7 +113,8 @@ input GiftRegistryShippingAddressInput @doc(description: "Either address data or } input UpdateGiftRegistryRegistrantInput { - giftRegistryRegistrantUid: ID! + giftRegistryRegistrantUid: ID! @deprecated(reason: "Use `gift_registry_registrant_uid` instead") + gift_registry_registrant_uid: ID first_name: String last_name: String email: String @@ -129,26 +134,55 @@ input GiftRegistryDynamicAttributeInput { } type CreateGiftRegistryOutput { + status: Boolean! + create_gift_registry_user_errors: [GiftRegistryItemsUserError]! gift_registry: GiftRegistry } type UpdateGiftRegistryOutput { + status: Boolean! + update_gift_registry_user_errors: [GiftRegistryItemsUserError]! gift_registry: GiftRegistry } type RemoveGiftRegistryOutput { + status: Boolean! + remove_gift_registry_user_errors: [GiftRegistryItemsUserError]! is_removed: Boolean! } type AddGiftRegistryItemsOutput { + status: Boolean! + add_gift_registry_items_user_errors: [GiftRegistryItemsUserError]! gift_registry: GiftRegistry } +type MoveCartItemsToGiftRegistryOutput { + status: Boolean! + move_cart_items_to_gift_registry_user_errors: [GiftRegistryItemsUserError]! + gift_registry: GiftRegistry +} + +type AddGiftRegistryItemsFromCartOutput { + status: Boolean! + add_gift_registry_items_user_errors: [GiftRegistryItemsUserError]! + gift_registry: GiftRegistry +} + +enum GiftRegistryItemsUserError { + OUT_OF_STOCK + NOT_AVAILABLE +} + type RemoveGiftRegistryItemsOutput { + status: Boolean! + remove_gift_registry_items_user_errors: [GiftRegistryItemsUserError]! gift_registry: GiftRegistry } type UpdateGiftRegistryItemsOutput { + status: Boolean! + update_gift_registry_items_user_errors: [GiftRegistryItemsUserError]! gift_registry: GiftRegistry } diff --git a/design-documents/graph-ql/directives.graphqls b/design-documents/graph-ql/directives.graphqls new file mode 100644 index 000000000..1f25bedd9 --- /dev/null +++ b/design-documents/graph-ql/directives.graphqls @@ -0,0 +1,39 @@ +directive @doc(description: String="") on QUERY + | MUTATION + | FIELD + | FRAGMENT_DEFINITION + | FRAGMENT_SPREAD + | INLINE_FRAGMENT + | SCHEMA + | SCALAR + | OBJECT + | FIELD_DEFINITION + | ARGUMENT_DEFINITION + | INTERFACE + | UNION + | ENUM + | ENUM_VALUE + | INPUT_OBJECT + | INPUT_FIELD_DEFINITION + +directive @resolver(class: String="") on QUERY + | MUTATION + | FIELD + | FRAGMENT_DEFINITION + | FRAGMENT_SPREAD + | INLINE_FRAGMENT + | SCHEMA + | SCALAR + | OBJECT + | FIELD_DEFINITION + | ARGUMENT_DEFINITION + | ENUM + | ENUM_VALUE + | INPUT_OBJECT + | INPUT_FIELD_DEFINITION + +directive @typeResolver(class: String="") on UNION + | INTERFACE + | OBJECT + +directive @cache(cacheIdentity: String="" cacheable: Boolean=true) on QUERY From ebb56b45a2c10fb7861cc078314a2357b96dce07 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Tue, 23 Mar 2021 12:50:11 -0500 Subject: [PATCH 420/479] - keep one mutation and deprecate the other --- .../coverage/customer/gift-registry.graphqls | 32 +++++-------------- 1 file changed, 8 insertions(+), 24 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index c4a6ceed5..31721af65 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -26,8 +26,7 @@ type Mutation { updateGiftRegistry(giftRegistryUid: ID!, giftRegistry: UpdateGiftRegistryInput!): UpdateGiftRegistryOutput removeGiftRegistry(giftRegistryUid: ID!): RemoveGiftRegistryOutput - addGiftRegistryItems(giftRegistryUid: ID!, items: [AddGiftRegistryItemInput!]!): AddGiftRegistryItemsOutput @doc(description: "Adds individual items to the gift registry") - addGiftRegistryItemsFromCart(giftRegistryUid: ID!, cartUid: ID!, emptyCart: Boolean = true): AddGiftRegistryItemsFromCartOutput @doc(description: "Adds the whole cart with all items to the gift registry with option to empty the cart") + addGiftRegistryItems(giftRegistryUid: ID!, items: [AddGiftRegistryItemInput!]!): AddGiftRegistryItemsOutput @deprecated(reason: "Use `moveCartItemsToGiftRegistry` instead. Not supported for gift registry") @doc(description: "Adds individual items to the gift registry") moveCartItemsToGiftRegistry(cartUid: ID!, giftRegistryUid: ID!): MoveCartItemsToGiftRegistryOutput @doc(description: "Moves all items items from cart to the gift registry") removeGiftRegistryItems(giftRegistryUid: ID!, itemUids: [ID!]!): RemoveGiftRegistryItemsOutput @@ -133,39 +132,28 @@ input GiftRegistryDynamicAttributeInput { value: String! } -type CreateGiftRegistryOutput { +interface GiftRegistryUserErrors { status: Boolean! - create_gift_registry_user_errors: [GiftRegistryItemsUserError]! + gift_registry_user_errors: [GiftRegistryItemsUserError]! +} + +type CreateGiftRegistryOutput { gift_registry: GiftRegistry } type UpdateGiftRegistryOutput { - status: Boolean! - update_gift_registry_user_errors: [GiftRegistryItemsUserError]! gift_registry: GiftRegistry } type RemoveGiftRegistryOutput { - status: Boolean! - remove_gift_registry_user_errors: [GiftRegistryItemsUserError]! is_removed: Boolean! } type AddGiftRegistryItemsOutput { - status: Boolean! - add_gift_registry_items_user_errors: [GiftRegistryItemsUserError]! gift_registry: GiftRegistry } -type MoveCartItemsToGiftRegistryOutput { - status: Boolean! - move_cart_items_to_gift_registry_user_errors: [GiftRegistryItemsUserError]! - gift_registry: GiftRegistry -} - -type AddGiftRegistryItemsFromCartOutput { - status: Boolean! - add_gift_registry_items_user_errors: [GiftRegistryItemsUserError]! +type MoveCartItemsToGiftRegistryOutput implements GiftRegistryUserErrors { gift_registry: GiftRegistry } @@ -175,14 +163,10 @@ enum GiftRegistryItemsUserError { } type RemoveGiftRegistryItemsOutput { - status: Boolean! - remove_gift_registry_items_user_errors: [GiftRegistryItemsUserError]! gift_registry: GiftRegistry } -type UpdateGiftRegistryItemsOutput { - status: Boolean! - update_gift_registry_items_user_errors: [GiftRegistryItemsUserError]! +type UpdateGiftRegistryItemsOutput implements GiftRegistryUserErrors { gift_registry: GiftRegistry } From 25ca54d5eab2b4c719b137fdb1c43e02aade3b09 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 24 Mar 2021 19:52:02 -0500 Subject: [PATCH 421/479] - add proposal for impoved cache key --- design-documents/graph-ql/improved-caching.md | 66 +++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 design-documents/graph-ql/improved-caching.md diff --git a/design-documents/graph-ql/improved-caching.md b/design-documents/graph-ql/improved-caching.md new file mode 100644 index 000000000..43d090cc6 --- /dev/null +++ b/design-documents/graph-ql/improved-caching.md @@ -0,0 +1,66 @@ +## Current caching +Like described in [dev docs](https://devdocs.magento.com/guides/v2.4/graphql/caching.html) we create a full query cache which we identify through a unique key + +The unique cache key is usually a hash based on several factors which define the type of request, scope etc. + +Currently that formula is: + +```` +hash([FULL URL + GET PARAMS] + [Store Header Value] + [Content-Currency Header Value]) +```` + +All three types of cache (FPC, Varnish and Fastly) now know about those headers and they compute different caches + +## The problem +This strategy only supposes that all components of cache have public values, and knowing their values doesn't pose any security concern. +There is however what we can call private data that should not really be exposed or at the very least guessed easily if exposed. + +Take customer-group as an example. At no point in Luma would we expose customer group. Instead we compute the same hash but including customer group and salt it: + +```` +hash([FULL URL + GET PARAMS] + [Store] + [Currency] + [CustomerGroup] + [Salt]) +```` + +This works In Luma we put that value into a cookie called X-Magento-Vary which luma will send with each request. +In this case is the server who computes a cache key on which varnish or fastly can add. +Luma also stores in cookies the Store and Currency but never the value of customer group. + +PWA and Graphql uses a cookieless approach. PWA has to know now about Store and Currency but not about the private components of cache. +Also each time we change something on private components like in this case with customer-group we have to add something to the VCL in fastly and varnish. + +We also missed the fact that the server, since it has these components as variations of cache, should respond with: +```` +Vary: Store, Content-currency +```` + +There is a bug in GraphQL, as it doesn't construct properly the Vary header: +```` +Vary: Accept-Encoding, Cookie +```` + +All components/headers that compose cache key should be included in the Vary. + +## Solution +Graphql would compute the cache key and return a header with the same function as the Luma cookie (`X-Magento-Vary`), except we won't name it that way. The `Vary` header is not meant to have a hash. +```` +X-Magento-Request-Id: 85a0b196524c60eaeb7c87d1aa4708a3fb20c6a1 +```` + +PWA would send `X-Magento-Request-Id` back to GraphQL. So it will act like the cookie in Luma. +This way we solve the public-private without adding more haders than we have. Just this one time. + +This will require a change in VCL but only once. With all the other changes if we change the way cache key is computed, no VCL changes would be required nor in PWA. + +VCL/Fastly would process this and turn it into a real cache key processed internally but the edge cache. +Currently, Fastly has this: + +```` +X-Request-Id: chn45aznc4feogj23ssw3y7k +```` + +The `X-Magento-Request-Id` will take into account `X-Magento-Request-Id` and respond with a propper Vary header: +```` +Vary: X-Magento-Request-Id +```` + +This is all we need. we don't need to add Store and Content-Currency to Vary anymore, though if we want to be transparent for the public headers we still can. From c124e6b188a5145b1a829e220952389a30c6e5f8 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 24 Mar 2021 19:52:14 -0500 Subject: [PATCH 422/479] - add proposal for impoved cache key --- design-documents/graph-ql/improved-caching.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/improved-caching.md b/design-documents/graph-ql/improved-caching.md index 43d090cc6..66bc13508 100644 --- a/design-documents/graph-ql/improved-caching.md +++ b/design-documents/graph-ql/improved-caching.md @@ -40,7 +40,7 @@ Vary: Accept-Encoding, Cookie All components/headers that compose cache key should be included in the Vary. -## Solution +## The Solution Graphql would compute the cache key and return a header with the same function as the Luma cookie (`X-Magento-Vary`), except we won't name it that way. The `Vary` header is not meant to have a hash. ```` X-Magento-Request-Id: 85a0b196524c60eaeb7c87d1aa4708a3fb20c6a1 @@ -63,4 +63,5 @@ The `X-Magento-Request-Id` will take into account `X-Magento-Request-Id` and res Vary: X-Magento-Request-Id ```` -This is all we need. we don't need to add Store and Content-Currency to Vary anymore, though if we want to be transparent for the public headers we still can. +This should suffice all explained. We don't need to add Store and Content-Currency to Vary anymore, though if we want to be transparent for the public headers we still can. +For FPC built in cache there would be no changes besides outputing X-Magento-Request-Id and the proper Vary. We already have the code that computes the cookie hash value. From b88067ba4bcf7bd3390e6b2124dc24a495ed02db Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Mon, 29 Mar 2021 16:38:07 -0500 Subject: [PATCH 423/479] - adjust neg. quote query to contain sort and status --- .../coverage/b2b/negotiableQuotes.graphqls | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index d736c90b4..5c4441385 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -9,6 +9,7 @@ type Query { filter: NegotiableQuoteFilterInput, pageSize: Int = 20, currentPage: Int = 1 + sort: NegotiableQuoteSortInput ): NegotiableQuotesOutput @doc(description: "A (optionally filtered) list of negotiable quotes viewable by the logged-in customer") } @@ -96,6 +97,7 @@ input DeleteNegotiableQuotesInput { } type DeleteNegotiableQuotesOutput { + status: Boolean! # Implementation Note: We don't make the deleted quotes accessible # because "deleted" means they're hidden from the storefront UI. They will # still be visible (and labeled as deleted) for a Seller in the admin @@ -103,6 +105,7 @@ type DeleteNegotiableQuotesOutput { filter: NegotiableQuoteFilterInput, pageSize: Int = 20, currentPage: Int = 1 + sort: NegotiableQuoteSortInput ): NegotiableQuotesOutput @doc(description: "List of negotiable quotes available to customer") } @@ -111,12 +114,14 @@ input CloseNegotiableQuotesInput { } type CloseNegotiableQuotesOutput { - closed_quotes: [NegotiableQuote!] @doc(description: "Quotes that were just closed") + status: Boolean! + closed_quotes: [NegotiableQuote!] @doc(description: "Quotes that were just closed, returns null if none was closed") #optionally display all negotiable quotes negotiable_quotes( filter: NegotiableQuoteFilterInput, pageSize: Int = 20, currentPage: Int = 1 + sort: NegotiableQuoteSortInput ): NegotiableQuotesOutput @doc(description: "A (optionally filtered) list of negotiable quotes viewable by the logged-in customer") } @@ -199,6 +204,17 @@ input NegotiableQuoteFilterInput { name: FilterMatchTypeInput @doc(description: "Filter by negotiable quote name") } +input NegotiableQuoteSortInput { + name: SortEnum @doc(description: "Sort by negotiable quote name") + status: SortEnum + created_at: SortEnum + updated_at: SortEnum + # Some other nice to have fields are, which will not be part of MVP + is_virtual: SortEnum + grand_total: SortEnum + total_quantity: SortEnum +} + type NegotiableQuoteHistoryEntry { uid: ID! author: NegotiableQuoteUser! From cabf7fde8aa8daed2860024b77a26e9b969a7127 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Mon, 29 Mar 2021 17:10:32 -0500 Subject: [PATCH 424/479] - adding pagination for closed_quotes --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 5c4441385..2bc626bd5 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -14,7 +14,7 @@ type Query { } type NegotiableQuotesOutput { - items: [NegotiableQuote]! + items: [NegotiableQuote] page_info: SearchResultPageInfo! total_count: Int! } @@ -115,7 +115,12 @@ input CloseNegotiableQuotesInput { type CloseNegotiableQuotesOutput { status: Boolean! - closed_quotes: [NegotiableQuote!] @doc(description: "Quotes that were just closed, returns null if none was closed") + closed_quotes( + filter: NegotiableQuoteFilterInput, + pageSize: Int = 20, + currentPage: Int = 1 + sort: NegotiableQuoteSortInput + ): NegotiableQuotesOutput @doc(description: "Quotes that were just closed") #optionally display all negotiable quotes negotiable_quotes( filter: NegotiableQuoteFilterInput, From f228dcdf56de15720e896808e146e2c429bf1210 Mon Sep 17 00:00:00 2001 From: Andrew Molina Date: Fri, 9 Apr 2021 13:54:56 -0500 Subject: [PATCH 425/479] extending StoreConfig type to include Negotiable Quote config --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index d736c90b4..96d3baf3c 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -327,3 +327,7 @@ type NegotiableQuoteUser @doc(description: "A limited view of a Buyer or Seller firstname: String! lastname: String! } + +type StoreConfig { + is_negotiable_quote_active: Boolean @doc(description: "Indicates if negotiable quote functionality is enabled.") +} From 3d779d86148ac4622bd5b14f31de5a19c35ac936 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Mon, 12 Apr 2021 09:59:03 -0500 Subject: [PATCH 426/479] - remove status - add items correct behavior of non nullable --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 2bc626bd5..bf238b0d0 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -14,7 +14,7 @@ type Query { } type NegotiableQuotesOutput { - items: [NegotiableQuote] + items: [NegotiableQuote!]! page_info: SearchResultPageInfo! total_count: Int! } @@ -97,7 +97,6 @@ input DeleteNegotiableQuotesInput { } type DeleteNegotiableQuotesOutput { - status: Boolean! # Implementation Note: We don't make the deleted quotes accessible # because "deleted" means they're hidden from the storefront UI. They will # still be visible (and labeled as deleted) for a Seller in the admin @@ -114,7 +113,6 @@ input CloseNegotiableQuotesInput { } type CloseNegotiableQuotesOutput { - status: Boolean! closed_quotes( filter: NegotiableQuoteFilterInput, pageSize: Int = 20, From e28045b569843b0a43e82bc6a1d58cec48368aec Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Mon, 12 Apr 2021 10:30:51 -0500 Subject: [PATCH 427/479] adding sort fields --- design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls | 1 + 1 file changed, 1 insertion(+) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index bf238b0d0..21ebecb86 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -17,6 +17,7 @@ type NegotiableQuotesOutput { items: [NegotiableQuote!]! page_info: SearchResultPageInfo! total_count: Int! + sort_fields: SortFields } # Coverage missing: From 3e7c044aba8b68faa6b9163af1f963146ede7fa7 Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Mon, 12 Apr 2021 18:18:13 -0400 Subject: [PATCH 428/479] Add original_total_price to prices field on negotiable quotes --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 96d3baf3c..3aada7d3f 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -207,6 +207,17 @@ type NegotiableQuoteHistoryEntry { changes: NegotiableQuoteHistoryChanges } +type CartPrices { + grand_total: Money + subtotal_including_tax: Money + subtotal_excluding_tax: Money + discount: CartDiscount @deprecated(reason: "Use discounts instead ") + subtotal_with_discount_excluding_tax: Money + applied_taxes: [CartTaxItem] + discounts: [Discount] @doc(description:"An array of applied discounts") + original_total_price: Money +} + # Note: Most of these HistoryChange types were built based on looking through UI code in Luma, because we don't have existing API # support for the Negotiable Quote history log feature. If we find these types aren't ideal during implementation, # let's iterate rather than stay glued to them. From 469b628fcd8d3ca478fc597b0b5b211bebc239cb Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Mon, 12 Apr 2021 18:44:37 -0400 Subject: [PATCH 429/479] Changing negotiable quote cart price type's name to be unique --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 3aada7d3f..2f2176909 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -173,7 +173,7 @@ type NegotiableQuote { # attachments: [AttachmentContent] comments: [NegotiableQuoteComment!] history: [NegotiableQuoteHistoryEntry!] - prices: CartPrices + prices: NegotiableQuoteCartPrices buyer: NegotiableQuoteUser! created_at: String @doc(description: "Timestamp indicating when the negotiable quote was created.") updated_at: String @doc(description: "Timestamp indicating when the negotiable quote was updated.") @@ -207,7 +207,7 @@ type NegotiableQuoteHistoryEntry { changes: NegotiableQuoteHistoryChanges } -type CartPrices { +type NegotiableQuoteCartPrices { grand_total: Money subtotal_including_tax: Money subtotal_excluding_tax: Money From edb2eb51f586f2c1bcfa347710d85adf3d6f2679 Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Mon, 12 Apr 2021 20:24:12 -0400 Subject: [PATCH 430/479] Adding fields for original price on CartItemPrices --- .../coverage/b2b/negotiableQuotes.graphqls | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 2f2176909..bf4ae818a 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -173,7 +173,7 @@ type NegotiableQuote { # attachments: [AttachmentContent] comments: [NegotiableQuoteComment!] history: [NegotiableQuoteHistoryEntry!] - prices: NegotiableQuoteCartPrices + prices: CartPrices buyer: NegotiableQuoteUser! created_at: String @doc(description: "Timestamp indicating when the negotiable quote was created.") updated_at: String @doc(description: "Timestamp indicating when the negotiable quote was updated.") @@ -207,17 +207,15 @@ type NegotiableQuoteHistoryEntry { changes: NegotiableQuoteHistoryChanges } -type NegotiableQuoteCartPrices { - grand_total: Money - subtotal_including_tax: Money - subtotal_excluding_tax: Money - discount: CartDiscount @deprecated(reason: "Use discounts instead ") - subtotal_with_discount_excluding_tax: Money - applied_taxes: [CartTaxItem] - discounts: [Discount] @doc(description:"An array of applied discounts") +type CartPrices { original_total_price: Money } +type CartItemPrices { + original_price: Money + original_row_total: Money +} + # Note: Most of these HistoryChange types were built based on looking through UI code in Luma, because we don't have existing API # support for the Negotiable Quote history log feature. If we find these types aren't ideal during implementation, # let's iterate rather than stay glued to them. From c84708c07c8fa40ee908e75bee30a85235b8f565 Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Tue, 13 Apr 2021 11:24:23 -0400 Subject: [PATCH 431/479] Adding original_row_total_including_tax --- design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls | 1 + 1 file changed, 1 insertion(+) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index bf4ae818a..118ff0709 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -214,6 +214,7 @@ type CartPrices { type CartItemPrices { original_price: Money original_row_total: Money + original_row_total_including_tax: Money } # Note: Most of these HistoryChange types were built based on looking through UI code in Luma, because we don't have existing API From 6207a3f33720f1624a027c1c312232527ef4d3fc Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Tue, 13 Apr 2021 12:37:11 -0400 Subject: [PATCH 432/479] Changing original to initial --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 118ff0709..f737fd3c9 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -208,13 +208,13 @@ type NegotiableQuoteHistoryEntry { } type CartPrices { - original_total_price: Money + initial_total_price: Money } type CartItemPrices { - original_price: Money - original_row_total: Money - original_row_total_including_tax: Money + initial_price: Money + initial_row_total: Money + initial_row_total_including_tax: Money } # Note: Most of these HistoryChange types were built based on looking through UI code in Luma, because we don't have existing API From b45c93ca189d12bb4ea40331d8b95b979d135b15 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Wed, 14 Apr 2021 09:45:13 -0500 Subject: [PATCH 433/479] PWA-1612: [GraphQl] [B2B Negotiable Quote] Add mutation to submit a negotiable quote for review --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 6157415b8..c7d365491 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -59,6 +59,10 @@ type Mutation { setNegotiableQuoteShippingAddress( input: SetNegotiableQuoteShippingAddressInput! ): SetNegotiableQuoteShippingAddressOutput @doc(description: "Assign one of buyers' existing addresses to a negotiable quote") + + sendNegotiableQuoteForReview( + input: SendNegotiableQuoteForReviewInput! + ) : SendNegotiableQuoteForReviewOutput @doc(description: "Send the negotiable quote for review to the seller") # Pending decision on design of file upload (design doc still pending decisions) # addNegotiableQuoteFiles( @@ -82,6 +86,15 @@ input SetNegotiableQuoteShippingAddressInput { ) } +input SendNegotiableQuoteForReviewInput { + quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote type") + comment: NegotiableQuoteCommentInput! +} + +type SendNegotiableQuoteForReviewOutput { + quote: NegotiableQuote +} + type SetNegotiableQuoteShippingAddressOutput { quote: NegotiableQuote } From bc86edb15e7d1dd6d277e0b4d005332f6f3afac0 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 15 Apr 2021 12:33:02 -0500 Subject: [PATCH 434/479] Update negotiableQuotes.graphqls --- .../coverage/b2b/negotiableQuotes.graphqls | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index c7d365491..c409d3715 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -29,11 +29,6 @@ type Mutation { input: RequestNegotiableQuoteInput! ): RequestNegotiableQuoteOutput @doc(description: "Request a new negotiable quote for a buyer") - # Covers "Add your Comment" section of https://docs.magento.com/user-guide/customers/account-dashboard-quotes-negotiate.html#shipping-information - addNegotiableQuoteComment( - input: AddNegotiableQuoteCommentInput! - ): AddNegotiableQuoteCommentOutput @doc(description: "Append a new comment from the buyer to a negotiable quote") - # https://docs.magento.com/user-guide/customers/account-dashboard-quotes-negotiate.html#change-the-quantity updateNegotiableQuoteQuantities( input: UpdateNegotiableQuoteQuantitiesInput! @@ -169,11 +164,6 @@ input NegotiableQuoteCommentInput { # files (attachments) to be added at a later date when file upload design has been finalized } -input AddNegotiableQuoteCommentInput { - quote_uid: ID! - comment: NegotiableQuoteCommentInput! -} - type NegotiableQuoteComment { uid: ID! created_at: String! @@ -354,11 +344,6 @@ type RemoveNegotiableQuoteItemsOutput { quote: NegotiableQuote } -type AddNegotiableQuoteCommentOutput { - comment: NegotiableQuoteComment @doc(description: "The newly added comment") - quote: NegotiableQuote -} - type UpdateNegotiableQuoteItemsQuantityOutput { quote: NegotiableQuote } From b25729750dc566aee00e89d32f218b40d5aa3471 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Mon, 19 Apr 2021 14:08:48 -0500 Subject: [PATCH 435/479] Update negotiableQuotes.graphqls --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index c409d3715..c0cf10070 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -83,7 +83,7 @@ input SetNegotiableQuoteShippingAddressInput { input SendNegotiableQuoteForReviewInput { quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote type") - comment: NegotiableQuoteCommentInput! + comment: NegotiableQuoteCommentInput } type SendNegotiableQuoteForReviewOutput { From 9a1ff039621c886323b80381bffff89e2b391e04 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Thu, 22 Apr 2021 12:02:41 -0500 Subject: [PATCH 436/479] - adding per item link and correcting type --- .../coverage/customer/gift-registry.graphqls | 60 +++++++++++-------- 1 file changed, 36 insertions(+), 24 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index 31721af65..a0b0abd58 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -26,7 +26,7 @@ type Mutation { updateGiftRegistry(giftRegistryUid: ID!, giftRegistry: UpdateGiftRegistryInput!): UpdateGiftRegistryOutput removeGiftRegistry(giftRegistryUid: ID!): RemoveGiftRegistryOutput - addGiftRegistryItems(giftRegistryUid: ID!, items: [AddGiftRegistryItemInput!]!): AddGiftRegistryItemsOutput @deprecated(reason: "Use `moveCartItemsToGiftRegistry` instead. Not supported for gift registry") @doc(description: "Adds individual items to the gift registry") + addGiftRegistryItems(giftRegistryUid: ID!, items: [AddGiftRegistryItemInput!]!): AddGiftRegistryItemsOutput @doc(description: "Adds individual items to the gift registry") moveCartItemsToGiftRegistry(cartUid: ID!, giftRegistryUid: ID!): MoveCartItemsToGiftRegistryOutput @doc(description: "Moves all items items from cart to the gift registry") removeGiftRegistryItems(giftRegistryUid: ID!, itemUids: [ID!]!): RemoveGiftRegistryItemsOutput @@ -79,7 +79,7 @@ input EnteredOptionInput { } input UpdateGiftRegistryItemInput { - giftRegistryItemUid: ID! + gift_registry_item_uid: ID! quantity: Float! note: String } @@ -94,10 +94,9 @@ input UpdateGiftRegistryInput { } input CreateGiftRegistryInput { - giftRegistryUid: ID @deprecated(reason: "Use `gift_registry_uid` instead") @doc(description: "Optional uid, can be generated on the client and used for sending multiple gift-registry related mutations in a single request. For example, create registry and immediatly add items or registrants.") - gift_registry_uid: ID + gift_registry_uid: ID @doc(description: "Optional uid, can be generated on the client and used for sending multiple gift-registry related mutations in a single request. For example, create registry and immediatly add items or registrants.") event_name: String! - giftRegistryTypeUid: ID! + gift_registry_type_uid: ID! message: String! privacy_settings: GiftRegistryPrivacySettings! status: GiftRegistryStatus! @@ -112,7 +111,6 @@ input GiftRegistryShippingAddressInput @doc(description: "Either address data or } input UpdateGiftRegistryRegistrantInput { - giftRegistryRegistrantUid: ID! @deprecated(reason: "Use `gift_registry_registrant_uid` instead") gift_registry_registrant_uid: ID first_name: String last_name: String @@ -137,49 +135,63 @@ interface GiftRegistryUserErrors { gift_registry_user_errors: [GiftRegistryItemsUserError]! } -type CreateGiftRegistryOutput { - gift_registry: GiftRegistry + +interface GiftRegistryUserErrors { + status: Boolean! + gift_registry_user_errors: [GiftRegistryItemsUserError]! } -type UpdateGiftRegistryOutput { +interface GiftRegistryItemUserError { + status: Boolean! + gift_registry_user_errors: GiftRegistryItemsUserError +} + +interface GiftRegistryOutputInterface { gift_registry: GiftRegistry } +type CreateGiftRegistryOutput implements GiftRegistryOutputInterface { +} + +type UpdateGiftRegistryOutput implements GiftRegistryOutputInterface { +} + type RemoveGiftRegistryOutput { is_removed: Boolean! } -type AddGiftRegistryItemsOutput { - gift_registry: GiftRegistry +type AddGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserError { } -type MoveCartItemsToGiftRegistryOutput implements GiftRegistryUserErrors { - gift_registry: GiftRegistry +type MoveCartItemsToGiftRegistryOutput implements GiftRegistryOutputInterface, GiftRegistryUserErrors { +} + +type GiftRegistryItemsUserError { + message: String! + product_uid: ID + gift_registry_item_uid: ID + code: GiftRegistryItemsUserErrorType! } -enum GiftRegistryItemsUserError { +enum GiftRegistryItemsUserErrorType { OUT_OF_STOCK NOT_AVAILABLE + UNDEFINED @doc(description: "Used for other exceptions like db connection failures or others") } -type RemoveGiftRegistryItemsOutput { - gift_registry: GiftRegistry +type RemoveGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserError { } -type UpdateGiftRegistryItemsOutput implements GiftRegistryUserErrors { - gift_registry: GiftRegistry +type UpdateGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserError { } -type AddGiftRegistryRegistrantsOutput { - gift_registry: GiftRegistry +type AddGiftRegistryRegistrantsOutput implements GiftRegistryOutputInterface { } -type UpdateGiftRegistryRegistrantsOutput { - gift_registry: GiftRegistry +type UpdateGiftRegistryRegistrantsOutput implements GiftRegistryOutputInterface { } -type RemoveGiftRegistryRegistrantsOutput { - gift_registry: GiftRegistry +type RemoveGiftRegistryRegistrantsOutput implements GiftRegistryOutputInterface { } type ShareGiftRegistryOutput { From 0b400aa7ad3ae4eb5557466ca6aeee60c3c77cdc Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Thu, 22 Apr 2021 12:09:21 -0500 Subject: [PATCH 437/479] - correcting duplicates --- .../graph-ql/coverage/customer/gift-registry.graphqls | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index a0b0abd58..0971b7467 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -132,18 +132,12 @@ input GiftRegistryDynamicAttributeInput { interface GiftRegistryUserErrors { status: Boolean! - gift_registry_user_errors: [GiftRegistryItemsUserError]! -} - - -interface GiftRegistryUserErrors { - status: Boolean! - gift_registry_user_errors: [GiftRegistryItemsUserError]! + user_errors: [GiftRegistryItemsUserError]! } interface GiftRegistryItemUserError { status: Boolean! - gift_registry_user_errors: GiftRegistryItemsUserError + user_errors: GiftRegistryItemsUserError } interface GiftRegistryOutputInterface { From 56451442207d94d77155f001a7626f275157b275 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Thu, 22 Apr 2021 12:12:49 -0500 Subject: [PATCH 438/479] - correcting naming convention --- .../coverage/customer/gift-registry.graphqls | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index 0971b7467..2fa2bee17 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -130,12 +130,12 @@ input GiftRegistryDynamicAttributeInput { value: String! } -interface GiftRegistryUserErrors { +interface GiftRegistryUserErrorsInterface { status: Boolean! user_errors: [GiftRegistryItemsUserError]! } -interface GiftRegistryItemUserError { +interface GiftRegistryItemUserErrorInterface { status: Boolean! user_errors: GiftRegistryItemsUserError } @@ -154,10 +154,10 @@ type RemoveGiftRegistryOutput { is_removed: Boolean! } -type AddGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserError { +type AddGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserErrorInterface { } -type MoveCartItemsToGiftRegistryOutput implements GiftRegistryOutputInterface, GiftRegistryUserErrors { +type MoveCartItemsToGiftRegistryOutput implements GiftRegistryOutputInterface, GiftRegistryUserErrorsInterface { } type GiftRegistryItemsUserError { @@ -173,10 +173,10 @@ enum GiftRegistryItemsUserErrorType { UNDEFINED @doc(description: "Used for other exceptions like db connection failures or others") } -type RemoveGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserError { +type RemoveGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserErrorInterface { } -type UpdateGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserError { +type UpdateGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserErrorInterface { } type AddGiftRegistryRegistrantsOutput implements GiftRegistryOutputInterface { From 79d6b2ccc44ab768f89b309bb6276b682cc20793 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Thu, 22 Apr 2021 12:13:45 -0500 Subject: [PATCH 439/479] - adding reference to parent gift registry --- .../graph-ql/coverage/customer/gift-registry.graphqls | 1 + 1 file changed, 1 insertion(+) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index 2fa2bee17..ef1c6e895 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -164,6 +164,7 @@ type GiftRegistryItemsUserError { message: String! product_uid: ID gift_registry_item_uid: ID + gift_registry_uid: ID code: GiftRegistryItemsUserErrorType! } From 2d99bdcdf237a1824d0d942f7d9edbf8a7846ab2 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Thu, 22 Apr 2021 12:36:40 -0500 Subject: [PATCH 440/479] - refactor exceptions --- .../graph-ql/coverage/customer/gift-registry.graphqls | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index ef1c6e895..67e78a9ca 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -170,8 +170,8 @@ type GiftRegistryItemsUserError { enum GiftRegistryItemsUserErrorType { OUT_OF_STOCK - NOT_AVAILABLE - UNDEFINED @doc(description: "Used for other exceptions like db connection failures or others") + NOT_FOUND @doc(description: "Used for exceptions like EntityNotFound") + UNDEFINED @doc(description: "Used for other exceptions like db connection failures or other exceptions") } type RemoveGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserErrorInterface { From 387f428855afd72ff955847064b6963e794f7c52 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 22 Apr 2021 13:01:12 -0500 Subject: [PATCH 441/479] Handle Sorting in Negotiable Quote --- .../coverage/b2b/negotiableQuotes.graphqls | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index c0cf10070..09829ef51 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -17,7 +17,6 @@ type NegotiableQuotesOutput { items: [NegotiableQuote!]! page_info: SearchResultPageInfo! total_count: Int! - sort_fields: SortFields } # Coverage missing: @@ -212,14 +211,15 @@ input NegotiableQuoteFilterInput { } input NegotiableQuoteSortInput { - name: SortEnum @doc(description: "Sort by negotiable quote name") - status: SortEnum - created_at: SortEnum - updated_at: SortEnum - # Some other nice to have fields are, which will not be part of MVP - is_virtual: SortEnum - grand_total: SortEnum - total_quantity: SortEnum + sort_field: NegotiableQuoteSortableField! + sort_direction: SortEnum! +} + +enum NegotiableQuoteSortableField { + QUOTE_NAME + STATUS + CREATED_AT + UPDATED_AT } type NegotiableQuoteHistoryEntry { From 9be897cc2187c2f871c7edc45b1f324d855e8af9 Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Thu, 22 Apr 2021 13:35:12 -0500 Subject: [PATCH 442/479] Update negotiableQuotes.graphqls --- design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls | 1 + 1 file changed, 1 insertion(+) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 09829ef51..3b2e4c545 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -17,6 +17,7 @@ type NegotiableQuotesOutput { items: [NegotiableQuote!]! page_info: SearchResultPageInfo! total_count: Int! + sort_fields: SortFields } # Coverage missing: From f9c0e0c06dee3c2b67a0b0d310d7de21749a2868 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Mon, 26 Apr 2021 16:46:31 -0500 Subject: [PATCH 443/479] modify schema to fit negotiable quote needs --- .../coverage/b2b/negotiableQuotes.graphqls | 13 ++++++----- .../graph-ql/coverage/quote.graphqls | 22 ++++++++++++++----- 2 files changed, 23 insertions(+), 12 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index c0cf10070..d05449027 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -230,14 +230,15 @@ type NegotiableQuoteHistoryEntry { changes: NegotiableQuoteHistoryChanges } -type CartPrices { - initial_total_price: Money +type NegotiableQuotePrices implements QuotePricesInterface { + initial_grand_total: Money! } -type CartItemPrices { - initial_price: Money - initial_row_total: Money - initial_row_total_including_tax: Money +type NegotiableQuoteItemPrices implements QuoteItemPricesInterface { + initial_price: Money! + initial_row_total: Money! + initial_row_total_excluding_tax: Money! + initial_row_total_including_tax: Money! } # Note: Most of these HistoryChange types were built based on looking through UI code in Luma, because we don't have existing API diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls index 4d38f67bb..fc4737009 100644 --- a/design-documents/graph-ql/coverage/quote.graphqls +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -180,7 +180,7 @@ input SetGuestEmailOnCartInput { email: String! } -type CartPrices { +interface QuotePricesInterface { grand_total: Money subtotal_including_tax: Money subtotal_excluding_tax: Money @@ -190,6 +190,9 @@ type CartPrices { discounts: [Discount] @doc(description:"An array of applied discounts") @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\Discounts") } +type CartPrices implements QuotePricesInterface { +} + type CartTaxItem { amount: Money! label: String! @@ -366,13 +369,20 @@ type Discount @doc(description:"Defines an individual discount. A discount can b label: String! @doc(description:"A description of the discount") } -type CartItemPrices { - price: Money! @doc(description:"Item price that might include tax depending on display settings for cart") - fixed_product_taxes: [FixedProductTax] @doc(description:"Applied FPT to the cart item") - row_total: Money! - row_total_including_tax: Money! +type QuoteItemPricesInterface { discounts: [Discount] @doc(description:"An array of discounts to be applied to the cart item") total_item_discount: Money @doc(description:"The total of all discounts applied to the item") + price: Money! @doc(description:"Item display price according to settings that might include tax depending on display settings for cart") + price_including_tax: Money! + price_excluding_tax: Money! + row_total: Money! @doc(description:"Row total display total according to settings that might include tax depending on display settings for cart for prices") + row_total_excluding_tax: Money! + row_total_including_tax: Money! + fixed_product_taxes: [FixedProductTax] @doc(description:"The list of all FPT taxes applied to the cart item") +} + +type CartItemPrices implements QuoteItemPricesInterface { + custom_price: Money! } type SelectedCustomizableOption { From 873fcfc284c736fdaed20b2e10102b6e9729706b Mon Sep 17 00:00:00 2001 From: Prabhu Ram Date: Tue, 27 Apr 2021 09:08:56 -0500 Subject: [PATCH 444/479] Update negotiableQuotes.graphqls --- design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls | 1 - 1 file changed, 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 3b2e4c545..e038e72de 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -218,7 +218,6 @@ input NegotiableQuoteSortInput { enum NegotiableQuoteSortableField { QUOTE_NAME - STATUS CREATED_AT UPDATED_AT } From 2106998bed66f307d78c3bc7d375bc6b44f2f09c Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Wed, 28 Apr 2021 09:58:54 -0500 Subject: [PATCH 445/479] - modify header name --- design-documents/graph-ql/improved-caching.md | 21 +++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/design-documents/graph-ql/improved-caching.md b/design-documents/graph-ql/improved-caching.md index 66bc13508..3e8622c48 100644 --- a/design-documents/graph-ql/improved-caching.md +++ b/design-documents/graph-ql/improved-caching.md @@ -43,10 +43,10 @@ All components/headers that compose cache key should be included in the Vary. ## The Solution Graphql would compute the cache key and return a header with the same function as the Luma cookie (`X-Magento-Vary`), except we won't name it that way. The `Vary` header is not meant to have a hash. ```` -X-Magento-Request-Id: 85a0b196524c60eaeb7c87d1aa4708a3fb20c6a1 +X-Magento-Cache-Id: 85a0b196524c60eaeb7c87d1aa4708a3fb20c6a1 ```` -PWA would send `X-Magento-Request-Id` back to GraphQL. So it will act like the cookie in Luma. +PWA would send `X-Magento-Cache-Id` back to GraphQL. So it will act like the cookie in Luma. This way we solve the public-private without adding more haders than we have. Just this one time. This will require a change in VCL but only once. With all the other changes if we change the way cache key is computed, no VCL changes would be required nor in PWA. @@ -58,10 +58,19 @@ Currently, Fastly has this: X-Request-Id: chn45aznc4feogj23ssw3y7k ```` -The `X-Magento-Request-Id` will take into account `X-Magento-Request-Id` and respond with a propper Vary header: +The `X-Magento-Cache-Id` will take into account `X-Magento-Cache-Id` and respond with a propper Vary header: ```` -Vary: X-Magento-Request-Id +Vary: X-Magento-Cache-Id ```` -This should suffice all explained. We don't need to add Store and Content-Currency to Vary anymore, though if we want to be transparent for the public headers we still can. -For FPC built in cache there would be no changes besides outputing X-Magento-Request-Id and the proper Vary. We already have the code that computes the cookie hash value. +We don't need to add Store and Content-Currency to Vary anymore, though if we want to be transparent for the public headers we still can. +For FPC built in cache there would be no changes besides outputing X-Magento-Cache-Id and the proper Vary. We already have the code that computes the cookie hash value. +This should suffice all explained above except for a major possible security flaw explained below. + +### The Solution's major flaw +Since we're caching the whole query and the caching server is hit first, and we don't have yet an auth session service nor a differentiator between auth token and session token +we wouldn't check if the barer token is valid or not. +This works in Luma because they have blocks and in graphql we don't have the equivlent of that. In luma we don't cache blocks marked as private. We use separate ajax to pupulate those after we retrieve the page from cache. +In graphql we could say that we have as blocks any node Example: product {block { subblock }}. However our use cases here are catalog, prices (which we could populate and not cache). +In category permissions and shared catalogs, suddenly the whole reponse becomes uncacheable because whole products and categories might be different. +We couldn't find a viable solution here unless there's some high availability service that checks session token once this will be available part of a full oauth2 protocol in 2.5 From 3fc478cf33cd6bcd6e1cb2f2c6c05988bdfb19b8 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Fri, 30 Apr 2021 10:37:59 -0500 Subject: [PATCH 446/479] - change prices --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index d05449027..c0a04c932 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -185,7 +185,7 @@ type NegotiableQuote { # attachments: [AttachmentContent] comments: [NegotiableQuoteComment!] history: [NegotiableQuoteHistoryEntry!] - prices: CartPrices + prices: NegotiableQuotePrices buyer: NegotiableQuoteUser! created_at: String @doc(description: "Timestamp indicating when the negotiable quote was created.") updated_at: String @doc(description: "Timestamp indicating when the negotiable quote was updated.") From e2e96b247e4d35999f92feb269f314401da569f9 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Fri, 30 Apr 2021 10:56:56 -0500 Subject: [PATCH 447/479] - change prices --- design-documents/graph-ql/coverage/quote.graphqls | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls index fc4737009..caaa2859e 100644 --- a/design-documents/graph-ql/coverage/quote.graphqls +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -360,7 +360,8 @@ interface CartItemInterface @typeResolver(class: "Magento\\QuoteGraphQl\\Model\\ id: String! @deprecated(reason: "Use CartItemInterface.uid instead") uid: ID! @doc(description: "Unique identifier for a Cart Item") quantity: Float! - prices: CartItemPrices @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemPrices") + prices: CartItemPrices @deprecated(reason: "Use `itemPrices` instead") @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemPrices") + itemPrices: QuoteItemPricesInterface @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemPrices") product: ProductInterface! } From 3f020effe08586a1282e4f07527f30d15e30b3ad Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Fri, 30 Apr 2021 16:00:40 -0500 Subject: [PATCH 448/479] - revert excluding tax - modify interfaces --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 1 - design-documents/graph-ql/coverage/quote.graphqls | 7 +------ 2 files changed, 1 insertion(+), 7 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index c0a04c932..6838d2013 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -237,7 +237,6 @@ type NegotiableQuotePrices implements QuotePricesInterface { type NegotiableQuoteItemPrices implements QuoteItemPricesInterface { initial_price: Money! initial_row_total: Money! - initial_row_total_excluding_tax: Money! initial_row_total_including_tax: Money! } diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls index caaa2859e..68c4857c8 100644 --- a/design-documents/graph-ql/coverage/quote.graphqls +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -360,8 +360,7 @@ interface CartItemInterface @typeResolver(class: "Magento\\QuoteGraphQl\\Model\\ id: String! @deprecated(reason: "Use CartItemInterface.uid instead") uid: ID! @doc(description: "Unique identifier for a Cart Item") quantity: Float! - prices: CartItemPrices @deprecated(reason: "Use `itemPrices` instead") @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemPrices") - itemPrices: QuoteItemPricesInterface @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemPrices") + prices: QuoteItemPricesInterface @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemPrices") product: ProductInterface! } @@ -374,16 +373,12 @@ type QuoteItemPricesInterface { discounts: [Discount] @doc(description:"An array of discounts to be applied to the cart item") total_item_discount: Money @doc(description:"The total of all discounts applied to the item") price: Money! @doc(description:"Item display price according to settings that might include tax depending on display settings for cart") - price_including_tax: Money! - price_excluding_tax: Money! row_total: Money! @doc(description:"Row total display total according to settings that might include tax depending on display settings for cart for prices") - row_total_excluding_tax: Money! row_total_including_tax: Money! fixed_product_taxes: [FixedProductTax] @doc(description:"The list of all FPT taxes applied to the cart item") } type CartItemPrices implements QuoteItemPricesInterface { - custom_price: Money! } type SelectedCustomizableOption { From eb0f7fe93f028e077f58ce9f53f6c6026036df2f Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Fri, 30 Apr 2021 16:08:31 -0500 Subject: [PATCH 449/479] - restore order of fields --- design-documents/graph-ql/coverage/quote.graphqls | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls index 68c4857c8..84058798a 100644 --- a/design-documents/graph-ql/coverage/quote.graphqls +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -370,12 +370,12 @@ type Discount @doc(description:"Defines an individual discount. A discount can b } type QuoteItemPricesInterface { + price: Money! @doc(description:"Item price that might include tax depending on display settings for cart") + fixed_product_taxes: [FixedProductTax] @doc(description:"Applied FPT to the cart item") + row_total: Money! + row_total_including_tax: Money! discounts: [Discount] @doc(description:"An array of discounts to be applied to the cart item") total_item_discount: Money @doc(description:"The total of all discounts applied to the item") - price: Money! @doc(description:"Item display price according to settings that might include tax depending on display settings for cart") - row_total: Money! @doc(description:"Row total display total according to settings that might include tax depending on display settings for cart for prices") - row_total_including_tax: Money! - fixed_product_taxes: [FixedProductTax] @doc(description:"The list of all FPT taxes applied to the cart item") } type CartItemPrices implements QuoteItemPricesInterface { From 6da52e3463701353ad204b3e8c6b5ed1f1b55273 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Fri, 30 Apr 2021 21:46:32 -0500 Subject: [PATCH 450/479] - remove resolvers --- .../graph-ql/coverage/quote.graphqls | 80 +++++++++---------- 1 file changed, 40 insertions(+), 40 deletions(-) diff --git a/design-documents/graph-ql/coverage/quote.graphqls b/design-documents/graph-ql/coverage/quote.graphqls index 84058798a..e2b1b1110 100644 --- a/design-documents/graph-ql/coverage/quote.graphqls +++ b/design-documents/graph-ql/coverage/quote.graphqls @@ -2,27 +2,27 @@ # See COPYING.txt for license details. type Query { - cart(cart_id: String!): Cart @resolver (class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\Cart") @doc(description:"Returns information about shopping cart") @cache(cacheable: false) - customerCart: Cart! @resolver (class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CustomerCart") @doc(description:"Returns information about the customer shopping cart") @cache(cacheable: false) + cart(cart_id: String!): Cart @doc(description:"Returns information about shopping cart") @cache(cacheable: false) + customerCart: Cart! @doc(description:"Returns information about the customer shopping cart") @cache(cacheable: false) } type Mutation { - createEmptyCart(input: createEmptyCartInput): String @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CreateEmptyCart") @doc(description:"Creates an empty shopping cart for a guest or logged in user") - addSimpleProductsToCart(input: AddSimpleProductsToCartInput): AddSimpleProductsToCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddSimpleProductsToCart") - addVirtualProductsToCart(input: AddVirtualProductsToCartInput): AddVirtualProductsToCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddSimpleProductsToCart") - applyCouponToCart(input: ApplyCouponToCartInput): ApplyCouponToCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\ApplyCouponToCart") - removeCouponFromCart(input: RemoveCouponFromCartInput): RemoveCouponFromCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\RemoveCouponFromCart") - updateCartItems(input: UpdateCartItemsInput): UpdateCartItemsOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\UpdateCartItems") - removeItemFromCart(input: RemoveItemFromCartInput): RemoveItemFromCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\RemoveItemFromCart") - setShippingAddressesOnCart(input: SetShippingAddressesOnCartInput): SetShippingAddressesOnCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetShippingAddressesOnCart") - setBillingAddressOnCart(input: SetBillingAddressOnCartInput): SetBillingAddressOnCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetBillingAddressOnCart") - setShippingMethodsOnCart(input: SetShippingMethodsOnCartInput): SetShippingMethodsOnCartOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetShippingMethodsOnCart") - setPaymentMethodOnCart(input: SetPaymentMethodOnCartInput): SetPaymentMethodOnCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\SetPaymentMethodOnCart") - setGuestEmailOnCart(input: SetGuestEmailOnCartInput): SetGuestEmailOnCartOutput @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\SetGuestEmailOnCart") - setPaymentMethodAndPlaceOrder(input: SetPaymentMethodAndPlaceOrderInput): PlaceOrderOutput @deprecated(reason: "Should use setPaymentMethodOnCart and placeOrder mutations in single request.") @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SetPaymentAndPlaceOrder") - mergeCarts(source_cart_id: String!, destination_cart_id: String!): Cart! @doc(description:"Merges the source cart into the destination cart") @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\MergeCarts") - placeOrder(input: PlaceOrderInput): PlaceOrderOutput @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\PlaceOrder") - addProductsToCart(cartId: String!, cartItems: [CartItemInput!]!): AddProductsToCartOutput @doc(description:"Add any type of product to the cart") @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AddProductsToCart") + createEmptyCart(input: createEmptyCartInput): String @doc(description:"Creates an empty shopping cart for a guest or logged in user") + addSimpleProductsToCart(input: AddSimpleProductsToCartInput): AddSimpleProductsToCartOutput + addVirtualProductsToCart(input: AddVirtualProductsToCartInput): AddVirtualProductsToCartOutput + applyCouponToCart(input: ApplyCouponToCartInput): ApplyCouponToCartOutput + removeCouponFromCart(input: RemoveCouponFromCartInput): RemoveCouponFromCartOutput + updateCartItems(input: UpdateCartItemsInput): UpdateCartItemsOutput + removeItemFromCart(input: RemoveItemFromCartInput): RemoveItemFromCartOutput + setShippingAddressesOnCart(input: SetShippingAddressesOnCartInput): SetShippingAddressesOnCartOutput + setBillingAddressOnCart(input: SetBillingAddressOnCartInput): SetBillingAddressOnCartOutput + setShippingMethodsOnCart(input: SetShippingMethodsOnCartInput): SetShippingMethodsOnCartOutput + setPaymentMethodOnCart(input: SetPaymentMethodOnCartInput): SetPaymentMethodOnCartOutput + setGuestEmailOnCart(input: SetGuestEmailOnCartInput): SetGuestEmailOnCartOutput + setPaymentMethodAndPlaceOrder(input: SetPaymentMethodAndPlaceOrderInput): PlaceOrderOutput @deprecated(reason: "Should use setPaymentMethodOnCart and placeOrder mutations in single request.") + mergeCarts(source_cart_id: String!, destination_cart_id: String!): Cart! @doc(description:"Merges the source cart into the destination cart") + placeOrder(input: PlaceOrderInput): PlaceOrderOutput + addProductsToCart(cartId: String!, cartItems: [CartItemInput!]!): AddProductsToCartOutput @doc(description:"Add any type of product to the cart") } input createEmptyCartInput { @@ -187,7 +187,7 @@ interface QuotePricesInterface { discount: CartDiscount @deprecated(reason: "Use discounts instead ") subtotal_with_discount_excluding_tax: Money applied_taxes: [CartTaxItem] - discounts: [Discount] @doc(description:"An array of applied discounts") @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\Discounts") + discounts: [Discount] @doc(description:"An array of applied discounts") } type CartPrices implements QuotePricesInterface { @@ -228,21 +228,21 @@ type PlaceOrderOutput { } type Cart { - id: ID! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\MaskedCartId") @doc(description: "The ID of the cart.") - items: [CartItemInterface] @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartItems") - applied_coupon: AppliedCoupon @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\AppliedCoupon") @doc(description:"An array of coupons that have been applied to the cart") @deprecated(reason: "Use applied_coupons instead ") - applied_coupons: [AppliedCoupon] @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\AppliedCoupons") @doc(description:"An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code") - email: String @resolver (class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartEmail") - shipping_addresses: [ShippingCartAddress]! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\ShippingAddresses") - billing_address: BillingCartAddress @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\BillingAddress") - available_payment_methods: [AvailablePaymentMethod] @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\AvailablePaymentMethods") @doc(description: "Available payment methods") - selected_payment_method: SelectedPaymentMethod @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\SelectedPaymentMethod") - prices: CartPrices @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartPrices") - total_quantity: Float! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartTotalQuantity") - is_virtual: Boolean! @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartIsVirtual") -} - -interface CartAddressInterface @typeResolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartAddressTypeResolver") { + id: ID! @doc(description: "The ID of the cart.") + items: [CartItemInterface] + applied_coupon: AppliedCoupon @doc(description:"An array of coupons that have been applied to the cart") @deprecated(reason: "Use applied_coupons instead ") + applied_coupons: [AppliedCoupon] @doc(description:"An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code") + email: String + shipping_addresses: [ShippingCartAddress]! + billing_address: BillingCartAddress + available_payment_methods: [AvailablePaymentMethod] @doc(description: "Available payment methods") + selected_payment_method: SelectedPaymentMethod + prices: CartPrices + total_quantity: Float! + is_virtual: Boolean! +} + +interface CartAddressInterface { firstname: String! lastname: String! company: String @@ -255,8 +255,8 @@ interface CartAddressInterface @typeResolver(class: "\\Magento\\QuoteGraphQl\\Mo } type ShippingCartAddress implements CartAddressInterface { - available_shipping_methods: [AvailableShippingMethod] @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\ShippingAddress\\AvailableShippingMethods") - selected_shipping_method: SelectedShippingMethod @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\ShippingAddress\\SelectedShippingMethod") + available_shipping_methods: [AvailableShippingMethod] + selected_shipping_method: SelectedShippingMethod customer_notes: String items_weight: Float @deprecated(reason: "This information shoud not be exposed on frontend") cart_items: [CartItemQuantity] @deprecated(reason: "`cart_items_v2` should be used instead") @@ -349,18 +349,18 @@ type SetGuestEmailOnCartOutput { } type SimpleCartItem implements CartItemInterface @doc(description: "Simple Cart Item") { - customizable_options: [SelectedCustomizableOption] @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\CustomizableOptions") + customizable_options: [SelectedCustomizableOption] } type VirtualCartItem implements CartItemInterface @doc(description: "Virtual Cart Item") { - customizable_options: [SelectedCustomizableOption] @resolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\CustomizableOptions") + customizable_options: [SelectedCustomizableOption] } -interface CartItemInterface @typeResolver(class: "Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemTypeResolver") { +interface CartItemInterface { id: String! @deprecated(reason: "Use CartItemInterface.uid instead") uid: ID! @doc(description: "Unique identifier for a Cart Item") quantity: Float! - prices: QuoteItemPricesInterface @resolver(class: "\\Magento\\QuoteGraphQl\\Model\\Resolver\\CartItemPrices") + prices: QuoteItemPricesInterface product: ProductInterface! } From 2dce55c7b0d3d4c607422b97822fc7dfa76816fc Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Fri, 30 Apr 2021 22:20:54 -0500 Subject: [PATCH 451/479] - modify namings --- .../coverage/customer/gift-registry.graphqls | 22 +++++++++---------- 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index 67e78a9ca..a128e90c6 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -27,7 +27,7 @@ type Mutation { removeGiftRegistry(giftRegistryUid: ID!): RemoveGiftRegistryOutput addGiftRegistryItems(giftRegistryUid: ID!, items: [AddGiftRegistryItemInput!]!): AddGiftRegistryItemsOutput @doc(description: "Adds individual items to the gift registry") - moveCartItemsToGiftRegistry(cartUid: ID!, giftRegistryUid: ID!): MoveCartItemsToGiftRegistryOutput @doc(description: "Moves all items items from cart to the gift registry") + moveCartItemsToGiftRegistry(cartUid: ID!, giftRegistryUid: ID!): MoveCartItemsToGiftRegistryOutput @doc(description: "Moves all items from cart to the gift registry") removeGiftRegistryItems(giftRegistryUid: ID!, itemUids: [ID!]!): RemoveGiftRegistryItemsOutput updateGiftRegistryItems(giftRegistryUid: ID!, items: [UpdateGiftRegistryItemInput!]!): UpdateGiftRegistryItemsOutput @@ -130,14 +130,12 @@ input GiftRegistryDynamicAttributeInput { value: String! } -interface GiftRegistryUserErrorsInterface { - status: Boolean! - user_errors: [GiftRegistryItemsUserError]! +interface GiftRegistryErrorsInterface { + errors: [GiftRegistryItemUserError]! } -interface GiftRegistryItemUserErrorInterface { - status: Boolean! - user_errors: GiftRegistryItemsUserError +interface GiftRegistryItemErrorInterface { + error: GiftRegistryItemUserError } interface GiftRegistryOutputInterface { @@ -154,13 +152,13 @@ type RemoveGiftRegistryOutput { is_removed: Boolean! } -type AddGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserErrorInterface { +type AddGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemErrorInterface { } -type MoveCartItemsToGiftRegistryOutput implements GiftRegistryOutputInterface, GiftRegistryUserErrorsInterface { +type MoveCartItemsToGiftRegistryOutput implements GiftRegistryOutputInterface, GiftRegistryErrorsInterface { } -type GiftRegistryItemsUserError { +type GiftRegistryItemUserError { message: String! product_uid: ID gift_registry_item_uid: ID @@ -174,10 +172,10 @@ enum GiftRegistryItemsUserErrorType { UNDEFINED @doc(description: "Used for other exceptions like db connection failures or other exceptions") } -type RemoveGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserErrorInterface { +type RemoveGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemErrorInterface { } -type UpdateGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemUserErrorInterface { +type UpdateGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegistryItemErrorInterface { } type AddGiftRegistryRegistrantsOutput implements GiftRegistryOutputInterface { From b38c74e64f4487c63584de43628078c881016b1e Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Fri, 30 Apr 2021 22:25:11 -0500 Subject: [PATCH 452/479] - modify namings --- .../graph-ql/coverage/customer/gift-registry.graphqls | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index a128e90c6..1f4fc40ce 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -131,11 +131,11 @@ input GiftRegistryDynamicAttributeInput { } interface GiftRegistryErrorsInterface { - errors: [GiftRegistryItemUserError]! + errors: [GiftRegistryItemError]! } interface GiftRegistryItemErrorInterface { - error: GiftRegistryItemUserError + error: GiftRegistryItemError } interface GiftRegistryOutputInterface { @@ -158,15 +158,15 @@ type AddGiftRegistryItemsOutput implements GiftRegistryOutputInterface, GiftRegi type MoveCartItemsToGiftRegistryOutput implements GiftRegistryOutputInterface, GiftRegistryErrorsInterface { } -type GiftRegistryItemUserError { +type GiftRegistryItemError { message: String! product_uid: ID gift_registry_item_uid: ID gift_registry_uid: ID - code: GiftRegistryItemsUserErrorType! + code: GiftRegistryItemsErrorType! } -enum GiftRegistryItemsUserErrorType { +enum GiftRegistryItemsErrorType { OUT_OF_STOCK NOT_FOUND @doc(description: "Used for exceptions like EntityNotFound") UNDEFINED @doc(description: "Used for other exceptions like db connection failures or other exceptions") From ac9bd5a61c942b0949db001f74c8d54e8205e011 Mon Sep 17 00:00:00 2001 From: Cristian Partica Date: Fri, 30 Apr 2021 22:27:56 -0500 Subject: [PATCH 453/479] - modify namings --- .../graph-ql/coverage/customer/gift-registry.graphqls | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls index 1f4fc40ce..e90acb10e 100644 --- a/design-documents/graph-ql/coverage/customer/gift-registry.graphqls +++ b/design-documents/graph-ql/coverage/customer/gift-registry.graphqls @@ -163,10 +163,10 @@ type GiftRegistryItemError { product_uid: ID gift_registry_item_uid: ID gift_registry_uid: ID - code: GiftRegistryItemsErrorType! + code: GiftRegistryItemErrorType! } -enum GiftRegistryItemsErrorType { +enum GiftRegistryItemErrorType { OUT_OF_STOCK NOT_FOUND @doc(description: "Used for exceptions like EntityNotFound") UNDEFINED @doc(description: "Used for other exceptions like db connection failures or other exceptions") From 1c4e78be7c2caf21e660f6a49dc91ebd1027dbd9 Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Fri, 16 Jul 2021 17:54:42 -0400 Subject: [PATCH 454/479] Updating graphql cache proposal after lots of investigation --- design-documents/graph-ql/improved-caching.md | 84 ++++++++++--------- 1 file changed, 45 insertions(+), 39 deletions(-) diff --git a/design-documents/graph-ql/improved-caching.md b/design-documents/graph-ql/improved-caching.md index 3e8622c48..eea09b565 100644 --- a/design-documents/graph-ql/improved-caching.md +++ b/design-documents/graph-ql/improved-caching.md @@ -1,76 +1,82 @@ ## Current caching -Like described in [dev docs](https://devdocs.magento.com/guides/v2.4/graphql/caching.html) we create a full query cache which we identify through a unique key +For GraphQL, we create a full query cache, which has results stored under unique keys as described in the [dev docs](https://devdocs.magento.com/guides/v2.4/graphql/caching.html). -The unique cache key is usually a hash based on several factors which define the type of request, scope etc. - -Currently that formula is: +These unique keys are a combination of several factors which define the scope of a request. Currently, this is the formula used for GraphQL: ```` -hash([FULL URL + GET PARAMS] + [Store Header Value] + [Content-Currency Header Value]) +[Store Header Value] + [Content-Currency Header Value] ```` -All three types of cache (FPC, Varnish and Fastly) now know about those headers and they compute different caches +All three types of cache (FPC, Varnish, and Fastly) know about these headers and use them to compute their cache keys. ## The problem -This strategy only supposes that all components of cache have public values, and knowing their values doesn't pose any security concern. -There is however what we can call private data that should not really be exposed or at the very least guessed easily if exposed. +This strategy only allows for all the components of the cache key to have public values, and for a user knowing those values to not pose any security concerns. +There is, however, what we will call "private data" which should not be exposed, or at the very least it should not be able to be reproduced/guessed easily if it is. -Take customer-group as an example. At no point in Luma would we expose customer group. Instead we compute the same hash but including customer group and salt it: +Take Customer Group as an example: At no point in Luma do we expose Customer Group. Instead, we compute a hash using Store and Currency but also including Customer Group and a salt: ```` -hash([FULL URL + GET PARAMS] + [Store] + [Currency] + [CustomerGroup] + [Salt]) +hash([Store] + [Currency] + [CustomerGroup] + [Salt]) ```` -This works In Luma we put that value into a cookie called X-Magento-Vary which luma will send with each request. -In this case is the server who computes a cache key on which varnish or fastly can add. -Luma also stores in cookies the Store and Currency but never the value of customer group. +Using a salted hash hides the Customer Group from the user but still allows it to be considered as a cache key. +This works in Luma because we put that value into a cookie called `X-Magento-Vary`, which Luma sends with each request for the VCL code to use to do cache lookups. +In this case it is the server that computes the cache key for Varnish/Fastly. +Luma also stores Store and Currency in cookies, but never the value of Customer Group. -PWA and Graphql uses a cookieless approach. PWA has to know now about Store and Currency but not about the private components of cache. -Also each time we change something on private components like in this case with customer-group we have to add something to the VCL in fastly and varnish. +PWA and GraphQL, however, use a cookieless approach. +PWA currently knows about Store and Currency, but not about the private components of the cache key. Because of this, we explicitly bypass the cache for logged-in customers in order to hit Magento and retrieve correct results. +Also, each time we change what is used for the cache key (such as adding Customer Group), we have to change the VCL in Fastly and Varnish. -We also missed the fact that the server, since it has these components as variations of cache, should respond with: +Additionally, we missed the fact that the cache node, since it uses these values as components of its own cache key, should respond with this `Vary` header for the browser cache: ```` -Vary: Store, Content-currency +Vary: Store, Content-Currency ```` -There is a bug in GraphQL, as it doesn't construct properly the Vary header: +The Fastly VCL code for GraphQL currently has a bug where it returns the same `Vary` header as it does for non-GraphQL requests (which use a cookie to store `X-Magento-Vary`): ```` Vary: Accept-Encoding, Cookie ```` -All components/headers that compose cache key should be included in the Vary. +All components/headers that compose the cache key should be included in the `Vary` header read by the browser cache. ## The Solution -Graphql would compute the cache key and return a header with the same function as the Luma cookie (`X-Magento-Vary`), except we won't name it that way. The `Vary` header is not meant to have a hash. +On every request, our GraphQL framework will compute a salted and hashed cache key using the same factors as the Luma `X-Magento-Vary` cookie and return it in a header on the response. ```` X-Magento-Cache-Id: 85a0b196524c60eaeb7c87d1aa4708a3fb20c6a1 ```` -PWA would send `X-Magento-Cache-Id` back to GraphQL. So it will act like the cookie in Luma. -This way we solve the public-private without adding more haders than we have. Just this one time. +PWA will capture this header and send it back on following GraphQL requests, which the cache node will then use as the key. +This requires a VCL change, but only once; the VCL code will not care about the method used to generate the header, so even if that changes no further updates would be required. -This will require a change in VCL but only once. With all the other changes if we change the way cache key is computed, no VCL changes would be required nor in PWA. +PWA will continue to capture the header on every response, and when it makes a new request it will send the most recent value it has received. +This way, if something happens that changes a customer's cache key such as updating their shipping address, PWA will immediately pick it up and use the correct key on the next request. -VCL/Fastly would process this and turn it into a real cache key processed internally but the edge cache. -Currently, Fastly has this: +A different value for `X-Magento-Cache-Id` can be sent with than Magento calculates for the request, such as when a user changes their currency (which does not use a mutation). +When this happens, we cannot cache the response under the `X-Magento-Cache-Id` that was on the request, otherwise incorrect values will be returned for other requests also using the initial value. +To avoid this issue, the VCL code will compare the `X-Magento-Cache-Id` values on the request and the response and not store the result in the cache if they do not match. +The cache node will respond with a proper `Vary` header for the browser cache to use: ```` -X-Request-Id: chn45aznc4feogj23ssw3y7k +Vary: Store, Content-Currency, Authorization, X-Magento-Cache-Id ```` +There is no mutation for changing Store or Currency, so they need to remain in `Vary` for the browser cache to know to use them as keys. +Likewise, a customer logging out does not use a mutation; instead, PWA just stops sending the `Authorization` header. The browser cache needs to know that this could cause a change in result values, so `Authorization` also needs to be in the `Vary` header. Of note: The VCL code will not consider the full bearer token when doing a cache lookup, just whether it exists on the request at all. -The `X-Magento-Cache-Id` will take into account `X-Magento-Cache-Id` and respond with a propper Vary header: -```` -Vary: X-Magento-Cache-Id -```` +Like `X-Magento-Vary`, the hash calculation for the `X-Magento-Cache-Id` header will use an unpredictably random salt. To ensure the salt is consistent between requests, we will store it in the environment configuration. +However, as this will happen as part of the first GraphQL request without a pre-existing salt, multiple attempts to update the config could occur simultaneously. +To avoid issues with concurrent write attempts, we will use a lock when writing to the `app/etc/env.php` file while adding the salt. +Generating this value automatically instead of through an admin interaction will avoid adding a step to the upgrade process and allow us to ensure the salt is sufficiently random. -We don't need to add Store and Content-Currency to Vary anymore, though if we want to be transparent for the public headers we still can. -For FPC built in cache there would be no changes besides outputing X-Magento-Cache-Id and the proper Vary. We already have the code that computes the cookie hash value. -This should suffice all explained above except for a major possible security flaw explained below. +For built-in FPC, there will be no changes other than outputting `X-Magento-Cache-Id` and the proper `Vary`. + +This should account for all issues listed above except for a major possible security flaw explained below. ### The Solution's major flaw -Since we're caching the whole query and the caching server is hit first, and we don't have yet an auth session service nor a differentiator between auth token and session token -we wouldn't check if the barer token is valid or not. -This works in Luma because they have blocks and in graphql we don't have the equivlent of that. In luma we don't cache blocks marked as private. We use separate ajax to pupulate those after we retrieve the page from cache. -In graphql we could say that we have as blocks any node Example: product {block { subblock }}. However our use cases here are catalog, prices (which we could populate and not cache). -In category permissions and shared catalogs, suddenly the whole reponse becomes uncacheable because whole products and categories might be different. -We couldn't find a viable solution here unless there's some high availability service that checks session token once this will be available part of a full oauth2 protocol in 2.5 +We're caching the whole query, requests hit the caching server first, and we don't (yet) have an auth session service, nor is there a differentiator between auth token and session token. This means we can't currently validate the bearer token before the cache node checks for a hit. + +This is not a problem in Luma because it has blocks, and blocks marked as private aren't cached. We use separate ajax to populate those after we retrieve the page from the cache. +Unfortunately, GraphQL doesn't have any equivalent to Luma's blocks. We could say that a node has a set of blocks (Example: `product {block { subblock }}`), but our current use cases are catalog and prices, which we could populate and not cache. +For category permissions and shared catalogs, suddenly the whole response stops being cacheable because the products and categories might be different. + +We couldn't find a viable solution for this without having some high availability service that checks session token, which will only be possible after having full oauth2 protocol in 2.5. From 91a7e87bc96f8db8a8de32cc470bcc111daf1768 Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Fri, 16 Jul 2021 18:07:32 -0400 Subject: [PATCH 455/479] Fixing minor wording issues for readability --- design-documents/graph-ql/improved-caching.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/design-documents/graph-ql/improved-caching.md b/design-documents/graph-ql/improved-caching.md index eea09b565..791f0b22a 100644 --- a/design-documents/graph-ql/improved-caching.md +++ b/design-documents/graph-ql/improved-caching.md @@ -52,20 +52,20 @@ This requires a VCL change, but only once; the VCL code will not care about the PWA will continue to capture the header on every response, and when it makes a new request it will send the most recent value it has received. This way, if something happens that changes a customer's cache key such as updating their shipping address, PWA will immediately pick it up and use the correct key on the next request. -A different value for `X-Magento-Cache-Id` can be sent with than Magento calculates for the request, such as when a user changes their currency (which does not use a mutation). -When this happens, we cannot cache the response under the `X-Magento-Cache-Id` that was on the request, otherwise incorrect values will be returned for other requests also using the initial value. +A different value for `X-Magento-Cache-Id` can be sent by PWA than Magento calculates for the response, such as when a user changes their currency (which does not use a mutation). +When this happens, we cannot cache the response under the `X-Magento-Cache-Id` that was on the request, or else incorrect results will be returned for other requests also using that initial value. To avoid this issue, the VCL code will compare the `X-Magento-Cache-Id` values on the request and the response and not store the result in the cache if they do not match. -The cache node will respond with a proper `Vary` header for the browser cache to use: +The cache node will also respond with a proper `Vary` header for the browser cache to use: ```` Vary: Store, Content-Currency, Authorization, X-Magento-Cache-Id ```` There is no mutation for changing Store or Currency, so they need to remain in `Vary` for the browser cache to know to use them as keys. -Likewise, a customer logging out does not use a mutation; instead, PWA just stops sending the `Authorization` header. The browser cache needs to know that this could cause a change in result values, so `Authorization` also needs to be in the `Vary` header. Of note: The VCL code will not consider the full bearer token when doing a cache lookup, just whether it exists on the request at all. +Likewise, a customer logging out does not use a mutation; instead, PWA just stops sending the `Authorization` header. The browser cache needs to know that this could cause a change in result values, so `Authorization` also needs to be in `Vary`. Of note: The VCL code will not consider the full bearer token when doing a cache lookup, just whether it exists on the request at all. -Like `X-Magento-Vary`, the hash calculation for the `X-Magento-Cache-Id` header will use an unpredictably random salt. To ensure the salt is consistent between requests, we will store it in the environment configuration. -However, as this will happen as part of the first GraphQL request without a pre-existing salt, multiple attempts to update the config could occur simultaneously. -To avoid issues with concurrent write attempts, we will use a lock when writing to the `app/etc/env.php` file while adding the salt. +Like `X-Magento-Vary`, the hash calculation for the `X-Magento-Cache-Id` header will use an unpredictably random salt. To ensure this salt is consistent between requests, we will store it in the environment configuration. +However, as this will happen as part of the first GraphQL request without a pre-existing salt, multiple attempts to update the config could occur simultaneously before the first finishes. +To avoid issues with concurrent writes to the same file, we will use a lock when writing to `app/etc/env.php` while adding the salt. Generating this value automatically instead of through an admin interaction will avoid adding a step to the upgrade process and allow us to ensure the salt is sufficiently random. For built-in FPC, there will be no changes other than outputting `X-Magento-Cache-Id` and the proper `Vary`. From d73f6bff6da337e2724e88904775984e5b019892 Mon Sep 17 00:00:00 2001 From: Viktor Rad Date: Mon, 16 Aug 2021 15:04:07 -0500 Subject: [PATCH 456/479] MC-42795: GraphQl products query layered navigation filters return incorrect child categories list --- design-documents/graph-ql/coverage/catalog.graphqls | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog.graphqls b/design-documents/graph-ql/coverage/catalog.graphqls index 562444582..cb0647315 100644 --- a/design-documents/graph-ql/coverage/catalog.graphqls +++ b/design-documents/graph-ql/coverage/catalog.graphqls @@ -316,10 +316,14 @@ type Products @doc(description: "The Products object is the top-level object ret page_info: SearchResultPageInfo @doc(description: "An object that includes the page_info and currentPage values specified in the query.") total_count: Int @doc(description: "The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.") filters: [LayerFilter] @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\LayerFilters") @doc(description: "Layered navigation filters array.") @deprecated(reason: "Use aggregations instead") - aggregations: [Aggregation] @doc(description: "Layered navigation aggregations.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Aggregations") + aggregations (filter: AggregationsFilterInput): [Aggregation] @doc(description: "Layered navigation aggregations.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Aggregations") sort_fields: SortFields @doc(description: "An object that includes the default sort field and all available sort fields.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\SortFields") } +input AggregationsFilterInput { + includeSubcategoriesOnly: Boolean = false @doc(description: "Flag to include only subcategories of requested category.") +} + type CategoryProducts @doc(description: "The category products object returned in the Category query.") { items: [ProductInterface] @doc(description: "An array of products that are assigned to the category.") page_info: SearchResultPageInfo @doc(description: "An object that includes the page_info and currentPage values specified in the query.") From d17b6d538ff2bdb9b21c24b4217097e134e47874 Mon Sep 17 00:00:00 2001 From: Viktor Rad Date: Mon, 16 Aug 2021 16:03:33 -0500 Subject: [PATCH 457/479] MC-42795: GraphQl products query layered navigation filters return incorrect child categories list --- design-documents/graph-ql/coverage/catalog.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/catalog.graphqls b/design-documents/graph-ql/coverage/catalog.graphqls index cb0647315..bec859b3b 100644 --- a/design-documents/graph-ql/coverage/catalog.graphqls +++ b/design-documents/graph-ql/coverage/catalog.graphqls @@ -316,7 +316,7 @@ type Products @doc(description: "The Products object is the top-level object ret page_info: SearchResultPageInfo @doc(description: "An object that includes the page_info and currentPage values specified in the query.") total_count: Int @doc(description: "The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.") filters: [LayerFilter] @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\LayerFilters") @doc(description: "Layered navigation filters array.") @deprecated(reason: "Use aggregations instead") - aggregations (filter: AggregationsFilterInput): [Aggregation] @doc(description: "Layered navigation aggregations.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Aggregations") + aggregations (filter: AggregationsFilterInput): [Aggregation] @doc(description: "Layered navigation aggregations with filters.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Aggregations") sort_fields: SortFields @doc(description: "An object that includes the default sort field and all available sort fields.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\SortFields") } From f741d2e40998815c0e962deef9ca339b63eaf54a Mon Sep 17 00:00:00 2001 From: Viktor Rad Date: Tue, 7 Sep 2021 15:55:21 -0500 Subject: [PATCH 458/479] MC-42795: GraphQl products query layered navigation filters return incorrect child categories list --- design-documents/graph-ql/coverage/catalog.graphqls | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog.graphqls b/design-documents/graph-ql/coverage/catalog.graphqls index bec859b3b..fc1d84a41 100644 --- a/design-documents/graph-ql/coverage/catalog.graphqls +++ b/design-documents/graph-ql/coverage/catalog.graphqls @@ -320,8 +320,12 @@ type Products @doc(description: "The Products object is the top-level object ret sort_fields: SortFields @doc(description: "An object that includes the default sort field and all available sort fields.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\SortFields") } -input AggregationsFilterInput { - includeSubcategoriesOnly: Boolean = false @doc(description: "Flag to include only subcategories of requested category.") +input AggregationsFilterInput @doc(description: "Filter aggregations in layered navigation.") { + category: AggregationsCategoryFilterInput @doc(description: "Filter category aggregations in layered navigation.") +} + +input AggregationsCategoryFilterInput @doc(description: "Filter category aggregations in layered navigation."){ + includeDirectChildrenOnly: Boolean = false @doc(description: "Flag to include only direct subcategories of requested category.") } type CategoryProducts @doc(description: "The category products object returned in the Category query.") { From 040941bfa7b3c342a399c2f98da50f4485e49758 Mon Sep 17 00:00:00 2001 From: Viktor Rad Date: Tue, 7 Sep 2021 16:27:31 -0500 Subject: [PATCH 459/479] MC-42795: GraphQl products query layered navigation filters return incorrect child categories list --- design-documents/graph-ql/coverage/catalog.graphqls | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/catalog.graphqls b/design-documents/graph-ql/coverage/catalog.graphqls index fc1d84a41..6579abc1f 100644 --- a/design-documents/graph-ql/coverage/catalog.graphqls +++ b/design-documents/graph-ql/coverage/catalog.graphqls @@ -320,12 +320,12 @@ type Products @doc(description: "The Products object is the top-level object ret sort_fields: SortFields @doc(description: "An object that includes the default sort field and all available sort fields.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\SortFields") } -input AggregationsFilterInput @doc(description: "Filter aggregations in layered navigation.") { +input AggregationsFilterInput @doc(description: "An input object that specifies the filters used in product aggregations.") { category: AggregationsCategoryFilterInput @doc(description: "Filter category aggregations in layered navigation.") } input AggregationsCategoryFilterInput @doc(description: "Filter category aggregations in layered navigation."){ - includeDirectChildrenOnly: Boolean = false @doc(description: "Flag to include only direct subcategories of requested category.") + includeDirectChildrenOnly: Boolean = false @doc(description: "Indicates whether to include only direct subcategories or all children categories at all levels.") } type CategoryProducts @doc(description: "The category products object returned in the Category query.") { From 2ab45aaecd9a28f50bfd897c8de16bc2a44a6c8d Mon Sep 17 00:00:00 2001 From: Cari Spruiell Date: Fri, 17 Sep 2021 12:15:33 -0500 Subject: [PATCH 460/479] PWA-2114: [GraphQL] Create mutation to set payment method on negotiable quote - add mutation setNegotiableQuotePaymentMethod --- .../coverage/b2b/negotiableQuotes.graphqls | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 3a2b5185d..10f061c8f 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -54,7 +54,7 @@ type Mutation { setNegotiableQuoteShippingAddress( input: SetNegotiableQuoteShippingAddressInput! ): SetNegotiableQuoteShippingAddressOutput @doc(description: "Assign one of buyers' existing addresses to a negotiable quote") - + sendNegotiableQuoteForReview( input: SendNegotiableQuoteForReviewInput! ) : SendNegotiableQuoteForReviewOutput @doc(description: "Send the negotiable quote for review to the seller") @@ -63,6 +63,10 @@ type Mutation { # addNegotiableQuoteFiles( # input: AddNegotiableQuoteFilesInput! # ): AddNegotiableQuoteFilesInput + + setNegotiableQuotePaymentMethod( + input: SetNegotiableQuotePaymentMethodInput! + ): SetNegotiableQuotePaymentMethodOutput @doc(description: "Set the payment method on the negotiable quote") } type AddNegotiableQuoteItemsOutput { @@ -315,7 +319,7 @@ type NegotiableQuoteHistoryProductsRemovedChange { # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L148-L169 type NegotiableQuoteHistoryProductsAddedChange { - # TODO: List of products added and their respective options. + # TODO: List of products added and their respective options. } # Usage in Luma: https://github.com/magento/magento2b2b/blob/0e791b5f7cd604ee6ee40b7225807c01b7f70cf2/app/code/Magento/NegotiableQuote/view/base/templates/quote/history.phtml#L172-L197 @@ -359,3 +363,12 @@ type NegotiableQuoteUser @doc(description: "A limited view of a Buyer or Seller type StoreConfig { is_negotiable_quote_active: Boolean @doc(description: "Indicates if negotiable quote functionality is enabled.") } + +input SetNegotiableQuotePaymentMethodInput { + quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote object") + code: String! @doc(description:"Payment method code") +} + +type SetNegotiableQuotePaymentMethodOutput { + quote: NegotiableQuote +} From 89bbfd1210a16c476cf1e10e2af0cda019875312 Mon Sep 17 00:00:00 2001 From: Cari Spruiell Date: Mon, 20 Sep 2021 12:17:38 -0500 Subject: [PATCH 461/479] PWA-2114: [GraphQL] Create mutation to set payment method on negotiable quote - add mutation setNegotiableQuotePaymentMethod --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 2 ++ 1 file changed, 2 insertions(+) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 10f061c8f..886add3d3 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -189,6 +189,8 @@ type NegotiableQuote { # attachments: [AttachmentContent] comments: [NegotiableQuoteComment!] history: [NegotiableQuoteHistoryEntry!] + available_payment_methods: [AvailablePaymentMethod] + selected_payment_method: SelectedPaymentMethod prices: NegotiableQuotePrices buyer: NegotiableQuoteUser! created_at: String @doc(description: "Timestamp indicating when the negotiable quote was created.") From 035a7fc839be76ff0d23cf87cf039f89c202927c Mon Sep 17 00:00:00 2001 From: Cari Spruiell Date: Tue, 21 Sep 2021 15:17:38 -0500 Subject: [PATCH 462/479] PWA-2114: [GraphQL] Create mutation to set payment method on negotiable quote - update schema --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 886add3d3..a69467e22 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -368,7 +368,12 @@ type StoreConfig { input SetNegotiableQuotePaymentMethodInput { quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote object") + payment_method: NegotiableQuotePaymentMethodInput! +} + +input NegotiableQuotePaymentMethodInput { code: String! @doc(description:"Payment method code") + purchase_order_number: String @doc(description:"Purchase order number") } type SetNegotiableQuotePaymentMethodOutput { From fbdf470cf4620717ba8acea95143672450409ad2 Mon Sep 17 00:00:00 2001 From: Cari Spruiell Date: Wed, 22 Sep 2021 09:31:04 -0500 Subject: [PATCH 463/479] PWA-2114: [GraphQL] Create mutation to set payment method on negotiable quote - update schema --- .../coverage/b2b/negotiableQuotes.graphqls | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index a69467e22..62db7aecc 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -189,8 +189,8 @@ type NegotiableQuote { # attachments: [AttachmentContent] comments: [NegotiableQuoteComment!] history: [NegotiableQuoteHistoryEntry!] - available_payment_methods: [AvailablePaymentMethod] - selected_payment_method: SelectedPaymentMethod + available_payment_methods: [NegotiableQuoteAvailablePaymentMethod] + selected_payment_method: NegotiableQuoteSelectedPaymentMethod prices: NegotiableQuotePrices buyer: NegotiableQuoteUser! created_at: String @doc(description: "Timestamp indicating when the negotiable quote was created.") @@ -379,3 +379,14 @@ input NegotiableQuotePaymentMethodInput { type SetNegotiableQuotePaymentMethodOutput { quote: NegotiableQuote } + +type NegotiableQuoteAvailablePaymentMethod { + code: String! @doc(description: "The payment method code") + title: String! @doc(description: "The payment method title.") +} + +type NegotiableQuoteSelectedPaymentMethod { + code: String! @doc(description: "The payment method code") + title: String! @doc(description: "The payment method title.") + purchase_order_number: String @doc(description: "The purchase order number.") +} From 22de863cea586418ab468fb6970914d20dc38676 Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Wed, 22 Sep 2021 12:31:05 -0400 Subject: [PATCH 464/479] Fixing bad merge of pulls 495 and 496 --- .../coverage/b2b/negotiableQuotes.graphqls | 102 +++++++++++++++++- .../cart/CartAddressOperations.graphqls | 3 +- 2 files changed, 101 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 62db7aecc..cea29633b 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -59,6 +59,10 @@ type Mutation { input: SendNegotiableQuoteForReviewInput! ) : SendNegotiableQuoteForReviewOutput @doc(description: "Send the negotiable quote for review to the seller") + setNegotiableQuoteBillingAddress( + input: SetNegotiableQuoteBillingAddressInput! + ): SetNegotiableQuoteBillingAddressOutput @doc(description: "Assign a billing address to a negotiable quote") + # Pending decision on design of file upload (design doc still pending decisions) # addNegotiableQuoteFiles( # input: AddNegotiableQuoteFilesInput! @@ -80,9 +84,66 @@ type AddNegotiableQuoteItemsOutput { input SetNegotiableQuoteShippingAddressInput { quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote type") - customer_address_id: Int! @doc( - description: "ID obtained from the CustomerAddress type. A new address can be added using Mutation.createCustomerAddress" - ) + customer_address_id: Int @deprecated(reason: "Use NegotiableQuoteShippingAddressInput.customer_address_id instead") + shipping_addresses: [NegotiableQuoteShippingAddressInput!]! +} + +input NegotiableQuoteShippingAddressInput { + customer_address_id: Int + address: NegotiableQuoteAddressInput + customer_notes: String +} + +input SetNegotiableQuoteBillingAddressInput { + quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote type") + billing_address: NegotiableQuoteBillingAddressInput! +} + +input NegotiableQuoteBillingAddressInput { + customer_address_id: Int + address: NegotiableQuoteAddressInput + use_for_shipping: Boolean @doc(description: "Indicates whether to additionally set the shipping address based on the provided billing address") + same_as_shipping: Boolean @doc(description: "Indicates whether to set the billing address based on the existing shipping address on the negotiable quote") +} + +input NegotiableQuoteAddressInput { + firstname: String! + lastname: String! + company: String + street: [String!]! + city: String! + region: String + region_id: Int + postcode: String + country_code: String! + telephone: String + save_in_address_book: Boolean +} + +input SetNegotiableQuoteBillingAddressInput { + quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote type") + billing_address: NegotiableQuoteBillingAddressInput! +} + +input NegotiableQuoteBillingAddressInput { + customer_address_id: Int + address: NegotiableQuoteAddressInput + use_for_shipping: Boolean @doc(description: "Indicates whether to additionally set the shipping address based on the provided billing address") + same_as_shipping: Boolean @doc(description: "Indicates whether to set the billing address based on the existing shipping address on the negotiable quote") +} + +input NegotiableQuoteAddressInput { + firstname: String! + lastname: String! + company: String + street: [String!]! + city: String! + region: String + region_id: Int + postcode: String + country_code: String! + telephone: String + save_in_address_book: Boolean } input SendNegotiableQuoteForReviewInput { @@ -189,6 +250,8 @@ type NegotiableQuote { # attachments: [AttachmentContent] comments: [NegotiableQuoteComment!] history: [NegotiableQuoteHistoryEntry!] + shipping_addresses: [NegotiableQuoteShippingAddress]! + billing_address: NegotiableQuoteBillingAddress available_payment_methods: [NegotiableQuoteAvailablePaymentMethod] selected_payment_method: NegotiableQuoteSelectedPaymentMethod prices: NegotiableQuotePrices @@ -198,6 +261,35 @@ type NegotiableQuote { status: NegotiableQuoteStatus! } +type NegotiableQuoteShippingAddress implements NegotiableQuoteAddressInterface { +} + +type NegotiableQuoteBillingAddress implements NegotiableQuoteAddressInterface { +} + +interface NegotiableQuoteAddressInterface { + firstname: String! + lastname: String! + company: String + street: [String!]! + city: String! + region: NegotiableQuoteAddressRegion + postcode: String + country: NegotiableQuoteAddressCountry! + telephone: String +} + +type NegotiableQuoteAddressRegion { + code: String + label: String + region_id: Int +} + +type NegotiableQuoteAddressCountry { + code: String! + label: String! +} + # Implementation Note: Using the values from the "Buyer Status" column of the state mapping table in devdocs. # These states are identical between storefront/admin, but we name them differently for buyers. # https://devdocs.magento.com/guides/v2.4/b2b/negotiable-quote.html#quote-statuses @@ -366,6 +458,10 @@ type StoreConfig { is_negotiable_quote_active: Boolean @doc(description: "Indicates if negotiable quote functionality is enabled.") } +type SetNegotiableQuoteBillingAddressOutput { + quote: NegotiableQuote +} + input SetNegotiableQuotePaymentMethodInput { quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote object") payment_method: NegotiableQuotePaymentMethodInput! diff --git a/design-documents/graph-ql/coverage/cart/CartAddressOperations.graphqls b/design-documents/graph-ql/coverage/cart/CartAddressOperations.graphqls index 42630f71d..9b2622938 100644 --- a/design-documents/graph-ql/coverage/cart/CartAddressOperations.graphqls +++ b/design-documents/graph-ql/coverage/cart/CartAddressOperations.graphqls @@ -22,7 +22,8 @@ input SetBillingAddressOnCartInput { input BillingAddressInput { customer_address_id: Int address: CartAddressInput - use_for_shipping: Boolean + use_for_shipping: Boolean @doc(description: "Indicates whether to additionally set the shipping address based on the provided billing address") + same_as_shipping: Boolean @doc(description: "Indicates whether to set the billing address based on the existing shipping address on the cart") } input SetShippingAddressesOnCartInput { From 1166b8878dff12d71efbfbe74765cfd7ebe5c963 Mon Sep 17 00:00:00 2001 From: Andrew Molina Date: Thu, 21 Oct 2021 16:38:06 -0500 Subject: [PATCH 465/479] Added mutation to set shipping methods on negotiable quote --- .../coverage/b2b/negotiableQuotes.graphqls | 31 ++++++++++++++----- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index cea29633b..52084a7ed 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -49,28 +49,32 @@ type Mutation { input: DeleteNegotiableQuotesInput! ): DeleteNegotiableQuotesOutput @doc(description: "Delete a negotiable quote, removing it from the display in the storefront") + sendNegotiableQuoteForReview( + input: SendNegotiableQuoteForReviewInput! + ) : SendNegotiableQuoteForReviewOutput @doc(description: "Send the negotiable quote for review to the seller") + # Covers "Select Existing Address" in https://docs.magento.com/user-guide/customers/account-dashboard-quotes-negotiate.html#shipping-information # "New Address" flow is covered by Mutation.createCustomerAddress setNegotiableQuoteShippingAddress( input: SetNegotiableQuoteShippingAddressInput! ): SetNegotiableQuoteShippingAddressOutput @doc(description: "Assign one of buyers' existing addresses to a negotiable quote") - sendNegotiableQuoteForReview( - input: SendNegotiableQuoteForReviewInput! - ) : SendNegotiableQuoteForReviewOutput @doc(description: "Send the negotiable quote for review to the seller") - setNegotiableQuoteBillingAddress( input: SetNegotiableQuoteBillingAddressInput! ): SetNegotiableQuoteBillingAddressOutput @doc(description: "Assign a billing address to a negotiable quote") - # Pending decision on design of file upload (design doc still pending decisions) - # addNegotiableQuoteFiles( - # input: AddNegotiableQuoteFilesInput! - # ): AddNegotiableQuoteFilesInput + setNegotiableQuoteShippingMethods( + input: SetNegotiableQuoteShippingMethodsInput! + ): SetNegotiableQuoteShippingMethodsOutput @doc(description: "Assign the shipping methods on the negotiable quote") setNegotiableQuotePaymentMethod( input: SetNegotiableQuotePaymentMethodInput! ): SetNegotiableQuotePaymentMethodOutput @doc(description: "Set the payment method on the negotiable quote") + + # Pending decision on design of file upload (design doc still pending decisions) + # addNegotiableQuoteFiles( + # input: AddNegotiableQuoteFilesInput! + # ): AddNegotiableQuoteFilesInput } type AddNegotiableQuoteItemsOutput { @@ -146,6 +150,15 @@ input NegotiableQuoteAddressInput { save_in_address_book: Boolean } +input SetNegotiableQuoteShippingMethodsInput { + quote_uid: ID! + shipping_methods: [ShippingMethodInput!]! +} + +type SetNegotiableQuoteShippingMethodsOutput { + quote: NegotiableQuote +} + input SendNegotiableQuoteForReviewInput { quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote type") comment: NegotiableQuoteCommentInput @@ -262,6 +275,8 @@ type NegotiableQuote { } type NegotiableQuoteShippingAddress implements NegotiableQuoteAddressInterface { + available_shipping_methods: [AvailableShippingMethod] + selected_shipping_method: SelectedShippingMethod } type NegotiableQuoteBillingAddress implements NegotiableQuoteAddressInterface { From 6774c72ea732bfad10906a62c4f129e754c0075b Mon Sep 17 00:00:00 2001 From: Andrew Molina Date: Fri, 22 Oct 2021 14:26:41 -0500 Subject: [PATCH 466/479] Updated shipping_addresses field so that it is not required Updated customer_address_id type from Int to ID --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index cea29633b..41ab15a00 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -84,12 +84,12 @@ type AddNegotiableQuoteItemsOutput { input SetNegotiableQuoteShippingAddressInput { quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote type") - customer_address_id: Int @deprecated(reason: "Use NegotiableQuoteShippingAddressInput.customer_address_id instead") - shipping_addresses: [NegotiableQuoteShippingAddressInput!]! + customer_address_id: ID @deprecated(reason: "Use NegotiableQuoteShippingAddressInput.customer_address_id instead") + shipping_addresses: [NegotiableQuoteShippingAddressInput!] } input NegotiableQuoteShippingAddressInput { - customer_address_id: Int + customer_address_id: ID address: NegotiableQuoteAddressInput customer_notes: String } @@ -126,7 +126,7 @@ input SetNegotiableQuoteBillingAddressInput { } input NegotiableQuoteBillingAddressInput { - customer_address_id: Int + customer_address_id: ID address: NegotiableQuoteAddressInput use_for_shipping: Boolean @doc(description: "Indicates whether to additionally set the shipping address based on the provided billing address") same_as_shipping: Boolean @doc(description: "Indicates whether to set the billing address based on the existing shipping address on the negotiable quote") From d2fb07794ea916f05814a37e22eaa2d8a5c459b0 Mon Sep 17 00:00:00 2001 From: Andrew Molina Date: Fri, 22 Oct 2021 16:51:16 -0500 Subject: [PATCH 467/479] Renamed customer_address_id to customer_address_uid --- .../coverage/b2b/negotiableQuotes.graphqls | 32 ++----------------- 1 file changed, 3 insertions(+), 29 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 41ab15a00..29a8951a6 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -84,12 +84,12 @@ type AddNegotiableQuoteItemsOutput { input SetNegotiableQuoteShippingAddressInput { quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote type") - customer_address_id: ID @deprecated(reason: "Use NegotiableQuoteShippingAddressInput.customer_address_id instead") + customer_address_id: ID @deprecated(reason: "Use `NegotiableQuoteShippingAddressInput.customer_address_uid` instead") shipping_addresses: [NegotiableQuoteShippingAddressInput!] } input NegotiableQuoteShippingAddressInput { - customer_address_id: ID + customer_address_uid: ID address: NegotiableQuoteAddressInput customer_notes: String } @@ -100,33 +100,7 @@ input SetNegotiableQuoteBillingAddressInput { } input NegotiableQuoteBillingAddressInput { - customer_address_id: Int - address: NegotiableQuoteAddressInput - use_for_shipping: Boolean @doc(description: "Indicates whether to additionally set the shipping address based on the provided billing address") - same_as_shipping: Boolean @doc(description: "Indicates whether to set the billing address based on the existing shipping address on the negotiable quote") -} - -input NegotiableQuoteAddressInput { - firstname: String! - lastname: String! - company: String - street: [String!]! - city: String! - region: String - region_id: Int - postcode: String - country_code: String! - telephone: String - save_in_address_book: Boolean -} - -input SetNegotiableQuoteBillingAddressInput { - quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote type") - billing_address: NegotiableQuoteBillingAddressInput! -} - -input NegotiableQuoteBillingAddressInput { - customer_address_id: ID + customer_address_uid: ID address: NegotiableQuoteAddressInput use_for_shipping: Boolean @doc(description: "Indicates whether to additionally set the shipping address based on the provided billing address") same_as_shipping: Boolean @doc(description: "Indicates whether to set the billing address based on the existing shipping address on the negotiable quote") From 05341009b184a0634cabc8652010232ea7e29e92 Mon Sep 17 00:00:00 2001 From: Andrew Molina Date: Wed, 27 Oct 2021 17:00:35 -0500 Subject: [PATCH 468/479] Updated placeOrder mutation for negotiable quote usage --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 8fb25ba42..2b479470c 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -71,6 +71,10 @@ type Mutation { input: SetNegotiableQuotePaymentMethodInput! ): SetNegotiableQuotePaymentMethodOutput @doc(description: "Set the payment method on the negotiable quote") + placeOrder( + input: PlaceOrderInput + ): PlaceOrderOutput @doc(description: "Place an order using the negotiable quote") + # Pending decision on design of file upload (design doc still pending decisions) # addNegotiableQuoteFiles( # input: AddNegotiableQuoteFilesInput! From 6167bc541eed1e369b164db96475d54145cebc5c Mon Sep 17 00:00:00 2001 From: Tommy Wiebell Date: Tue, 2 Nov 2021 12:42:52 -0500 Subject: [PATCH 469/479] Add initial requirements for recaptcha storeConfig --- .../graph-ql/coverage/re-captcha.graphqls | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 design-documents/graph-ql/coverage/re-captcha.graphqls diff --git a/design-documents/graph-ql/coverage/re-captcha.graphqls b/design-documents/graph-ql/coverage/re-captcha.graphqls new file mode 100644 index 000000000..8c284acb6 --- /dev/null +++ b/design-documents/graph-ql/coverage/re-captcha.graphqls @@ -0,0 +1,31 @@ +enum ReCaptchaVersion { + V3 +} + +enum ReCaptchaForms { + APPLY_GIFT_CARD + APPLY_COUPON + CHANGE_PASSWORD + CHECKOUT + LOGIN + CREATE_CUSTOMER + EDIT_CUSTOMER + NEWSLETTER +} + +type ReCaptchaConfiguration { + type: ReCaptchaVersion! + website_key: String! + minimum_score: Float! + badge_position: String! + language_code: String + failure_message: String! + forms: [ReCaptchaForms!]! +} + +# Google reCAPTCHA config - will return null if v3 invisible is not configured +# for at least one Storefront form. +type StoreConfig { + recaptcha: ReCaptchaConfiguration + @doc(description: "Google reCAPTCHA Configuration") +} From beeb1ccc68b8daadea1f8a3ce0fc53dde1444999 Mon Sep 17 00:00:00 2001 From: Nicolas Marquez Date: Wed, 3 Nov 2021 13:42:38 -0400 Subject: [PATCH 470/479] Add NegotiableQuote specific place order mutation and input --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 2b479470c..965983e92 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -71,8 +71,8 @@ type Mutation { input: SetNegotiableQuotePaymentMethodInput! ): SetNegotiableQuotePaymentMethodOutput @doc(description: "Set the payment method on the negotiable quote") - placeOrder( - input: PlaceOrderInput + placeNegotiableQuoteOrder( + input: PlaceNegotiableQuoteOrderInput ): PlaceOrderOutput @doc(description: "Place an order using the negotiable quote") # Pending decision on design of file upload (design doc still pending decisions) @@ -142,6 +142,10 @@ input SendNegotiableQuoteForReviewInput { comment: NegotiableQuoteCommentInput } +input PlaceNegotiableQuoteOrderInput { + quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote type") +} + type SendNegotiableQuoteForReviewOutput { quote: NegotiableQuote } From edd71e38e15d899287840635093f78867fd4e48b Mon Sep 17 00:00:00 2001 From: Nicolas Marquez Date: Wed, 3 Nov 2021 14:23:38 -0400 Subject: [PATCH 471/479] Add Negotiable Quote specifi place order mutation output --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 965983e92..f204fb800 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -73,7 +73,7 @@ type Mutation { placeNegotiableQuoteOrder( input: PlaceNegotiableQuoteOrderInput - ): PlaceOrderOutput @doc(description: "Place an order using the negotiable quote") + ): PlaceNegotiableQuoteOrderOutput @doc(description: "Place an order using the negotiable quote") # Pending decision on design of file upload (design doc still pending decisions) # addNegotiableQuoteFiles( @@ -146,6 +146,10 @@ input PlaceNegotiableQuoteOrderInput { quote_uid: ID! @doc(description: "ID obtained from NegotiableQuote type") } +type PlaceNegotiableQuoteOrderOutput { + order: Order! +} + type SendNegotiableQuoteForReviewOutput { quote: NegotiableQuote } From 69e56aa2321c0c5d807dcc38948346a72dc3cc83 Mon Sep 17 00:00:00 2001 From: Cari Spruiell Date: Thu, 4 Nov 2021 16:25:01 -0500 Subject: [PATCH 472/479] PWA-2150: [Spike] Identify discrepancies between GraphQL types Cart and Negotiable Quote --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 8fb25ba42..578d831ee 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -237,11 +237,15 @@ type NegotiableQuote { # attachments: [AttachmentContent] comments: [NegotiableQuoteComment!] history: [NegotiableQuoteHistoryEntry!] + applied_coupons: [AppliedCoupon] @doc(description:"An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code") + email: String shipping_addresses: [NegotiableQuoteShippingAddress]! billing_address: NegotiableQuoteBillingAddress available_payment_methods: [NegotiableQuoteAvailablePaymentMethod] selected_payment_method: NegotiableQuoteSelectedPaymentMethod prices: NegotiableQuotePrices + total_quantity: Float! + is_virtual: Boolean! buyer: NegotiableQuoteUser! created_at: String @doc(description: "Timestamp indicating when the negotiable quote was created.") updated_at: String @doc(description: "Timestamp indicating when the negotiable quote was updated.") From fda525be673f91937756f7d9e8f66ba8400be683 Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Tue, 9 Nov 2021 16:20:01 -0500 Subject: [PATCH 473/479] PWA-1611: Adding the ability to report partial successes on batch operations in Negotiable Quote --- .../coverage/b2b/negotiableQuotes.graphqls | 50 ++++++++++++++++--- design-documents/graph-ql/directives.graphqls | 6 +++ 2 files changed, 50 insertions(+), 6 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 578d831ee..836ce9e19 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -157,7 +157,29 @@ input DeleteNegotiableQuotesInput { quote_uids: [ID!]! @doc(description: "A List of UIDs obtained from negotiable quote types") } +type NegotiableQuoteOperationSuccess { + quote_uid: ID! +} + +interface NegotiableQuoteOperationErrorInterface { + quote_uid: ID! + message: String +} + +type NegotiableQuoteInvalidStateError implements NegotiableQuoteOperationErrorInterface { +} + +type NegotiableQuoteNotFoundError implements NegotiableQuoteOperationErrorInterface { +} + +type NegotiableQuoteUndefinedError implements NegotiableQuoteOperationErrorInterface { +} + +union NegotiableQuoteOperationResult = NegotiableQuoteOperationSuccess | NegotiableQuoteOperationErrorInterface + type DeleteNegotiableQuotesOutput { + result_status: TriStateMutationResultStatus + operation_results: [NegotiableQuoteOperationResult!]! # Implementation Note: We don't make the deleted quotes accessible # because "deleted" means they're hidden from the storefront UI. They will # still be visible (and labeled as deleted) for a Seller in the admin @@ -174,12 +196,9 @@ input CloseNegotiableQuotesInput { } type CloseNegotiableQuotesOutput { - closed_quotes( - filter: NegotiableQuoteFilterInput, - pageSize: Int = 20, - currentPage: Int = 1 - sort: NegotiableQuoteSortInput - ): NegotiableQuotesOutput @doc(description: "Quotes that were just closed") + result_status: TriStateMutationResultStatus + operation_results: [NegotiableQuoteOperationResult!]! + closed_quotes: [NegotiableQuote!] @doc(description: "An array containing the negotiable quotes that were just closed") @deprecated(reason: "Replaced with operation_results") #optionally display all negotiable quotes negotiable_quotes( filter: NegotiableQuoteFilterInput, @@ -431,7 +450,26 @@ type RequestNegotiableQuoteOutput { quote: NegotiableQuote } +type NegotiableQuoteItemOperationSuccess { + quote_item_uid: ID! +} + +interface NegotiableQuoteItemOperationErrorInterface { + quote_item_uid: ID! + message: String +} + +type NegotiableQuoteItemNotFoundError implements NegotiableQuoteItemOperationErrorInterface { +} + +type NegotiableQuoteUndefinedError implements NegotiableQuoteItemOperationErrorInterface { +} + +union NegotiableQuoteItemOperationResult = NegotiableQuoteItemOperationSuccess | NegotiableQuoteItemOperationErrorInterface + type RemoveNegotiableQuoteItemsOutput { + result_status: TriStateMutationResultStatus + operation_results: [NegotiableQuoteItemOperationResult!]! quote: NegotiableQuote } diff --git a/design-documents/graph-ql/directives.graphqls b/design-documents/graph-ql/directives.graphqls index 1f25bedd9..5af1c5e1f 100644 --- a/design-documents/graph-ql/directives.graphqls +++ b/design-documents/graph-ql/directives.graphqls @@ -37,3 +37,9 @@ directive @typeResolver(class: String="") on UNION | OBJECT directive @cache(cacheIdentity: String="" cacheable: Boolean=true) on QUERY + +enum TriStateMutationResultStatus { + SUCCESS + FAILURE + PARTIAL_SUCCESS +} From a73c7e405935b58324f940df94ea87ca90609993 Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Tue, 9 Nov 2021 16:28:37 -0500 Subject: [PATCH 474/479] Fixing NQ Item Undefined type --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 836ce9e19..59a5b7143 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -462,7 +462,7 @@ interface NegotiableQuoteItemOperationErrorInterface { type NegotiableQuoteItemNotFoundError implements NegotiableQuoteItemOperationErrorInterface { } -type NegotiableQuoteUndefinedError implements NegotiableQuoteItemOperationErrorInterface { +type NegotiableQuoteItemUndefinedError implements NegotiableQuoteItemOperationErrorInterface { } union NegotiableQuoteItemOperationResult = NegotiableQuoteItemOperationSuccess | NegotiableQuoteItemOperationErrorInterface From f2099c8c0cc59838ee345c7094390bb2759187a1 Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Tue, 9 Nov 2021 16:49:34 -0500 Subject: [PATCH 475/479] Making result status a required output field --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 59a5b7143..51e05b377 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -178,7 +178,7 @@ type NegotiableQuoteUndefinedError implements NegotiableQuoteOperationErrorInter union NegotiableQuoteOperationResult = NegotiableQuoteOperationSuccess | NegotiableQuoteOperationErrorInterface type DeleteNegotiableQuotesOutput { - result_status: TriStateMutationResultStatus + result_status: TriStateMutationResultStatus! operation_results: [NegotiableQuoteOperationResult!]! # Implementation Note: We don't make the deleted quotes accessible # because "deleted" means they're hidden from the storefront UI. They will @@ -196,7 +196,7 @@ input CloseNegotiableQuotesInput { } type CloseNegotiableQuotesOutput { - result_status: TriStateMutationResultStatus + result_status: TriStateMutationResultStatus! operation_results: [NegotiableQuoteOperationResult!]! closed_quotes: [NegotiableQuote!] @doc(description: "An array containing the negotiable quotes that were just closed") @deprecated(reason: "Replaced with operation_results") #optionally display all negotiable quotes @@ -468,7 +468,7 @@ type NegotiableQuoteItemUndefinedError implements NegotiableQuoteItemOperationEr union NegotiableQuoteItemOperationResult = NegotiableQuoteItemOperationSuccess | NegotiableQuoteItemOperationErrorInterface type RemoveNegotiableQuoteItemsOutput { - result_status: TriStateMutationResultStatus + result_status: TriStateMutationResultStatus! operation_results: [NegotiableQuoteItemOperationResult!]! quote: NegotiableQuote } From 5b01542090d82349754184934547915042c5c52c Mon Sep 17 00:00:00 2001 From: Tommy Wiebell Date: Wed, 10 Nov 2021 15:43:10 -0600 Subject: [PATCH 476/479] Move to dedicated endpoint to accomodate model based recaptcha config --- .../graph-ql/coverage/re-captcha.graphqls | 49 ++++++++++++------- 1 file changed, 31 insertions(+), 18 deletions(-) diff --git a/design-documents/graph-ql/coverage/re-captcha.graphqls b/design-documents/graph-ql/coverage/re-captcha.graphqls index 8c284acb6..404304bc5 100644 --- a/design-documents/graph-ql/coverage/re-captcha.graphqls +++ b/design-documents/graph-ql/coverage/re-captcha.graphqls @@ -1,31 +1,44 @@ -enum ReCaptchaVersion { - V3 -} - -enum ReCaptchaForms { - APPLY_GIFT_CARD - APPLY_COUPON - CHANGE_PASSWORD - CHECKOUT - LOGIN - CREATE_CUSTOMER - EDIT_CUSTOMER +enum ReCaptchaFormEnum { + PLACE_ORDER + CONTACT + CUSTOMER_LOGIN + CUSTOMER_FORGOT_PASSWORD + CUSTOMER_CREATE + CUSTOMER_EDIT NEWSLETTER + PRODUCT_REVIEW + SENDFRIEND + BRAINTREE } -type ReCaptchaConfiguration { - type: ReCaptchaVersion! +type ReCaptchaConfigurationV3 { website_key: String! + @doc( + description: "The website key that is created when you register your Google reCAPTCHA account" + ) minimum_score: Float! + @doc( + description: "The minimum score that identifies a user interaction as a potential risk" + ) badge_position: String! + @doc( + description: "The position of the invisible reCAPTCHA badge on each page" + ) language_code: String + @doc( + description: "A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging." + ) failure_message: String! - forms: [ReCaptchaForms!]! + @doc( + description: "The message that appears to the user if validation fails" + ) + forms: [ReCaptchaFormEnum!]! + @doc(description: "A list of forms that have reCAPTCHA V3 enabled") } # Google reCAPTCHA config - will return null if v3 invisible is not configured # for at least one Storefront form. -type StoreConfig { - recaptcha: ReCaptchaConfiguration - @doc(description: "Google reCAPTCHA Configuration") +type Query { + recaptchaV3Config: ReCaptchaConfigurationV3 + @doc(description: "Google reCAPTCHA V3-Invisible Configuration") } From 08cf9d98bd995f13443cb08cc94f9cfd2546e498 Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Thu, 11 Nov 2021 11:32:49 -0500 Subject: [PATCH 477/479] Renaming shared mutation result status enum --- .../graph-ql/coverage/b2b/negotiableQuotes.graphqls | 6 +++--- design-documents/graph-ql/directives.graphqls | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index 51e05b377..f01e76bdf 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -178,7 +178,7 @@ type NegotiableQuoteUndefinedError implements NegotiableQuoteOperationErrorInter union NegotiableQuoteOperationResult = NegotiableQuoteOperationSuccess | NegotiableQuoteOperationErrorInterface type DeleteNegotiableQuotesOutput { - result_status: TriStateMutationResultStatus! + result_status: MutationResultStatus! operation_results: [NegotiableQuoteOperationResult!]! # Implementation Note: We don't make the deleted quotes accessible # because "deleted" means they're hidden from the storefront UI. They will @@ -196,7 +196,7 @@ input CloseNegotiableQuotesInput { } type CloseNegotiableQuotesOutput { - result_status: TriStateMutationResultStatus! + result_status: MutationResultStatus! operation_results: [NegotiableQuoteOperationResult!]! closed_quotes: [NegotiableQuote!] @doc(description: "An array containing the negotiable quotes that were just closed") @deprecated(reason: "Replaced with operation_results") #optionally display all negotiable quotes @@ -468,7 +468,7 @@ type NegotiableQuoteItemUndefinedError implements NegotiableQuoteItemOperationEr union NegotiableQuoteItemOperationResult = NegotiableQuoteItemOperationSuccess | NegotiableQuoteItemOperationErrorInterface type RemoveNegotiableQuoteItemsOutput { - result_status: TriStateMutationResultStatus! + result_status: MutationResultStatus! operation_results: [NegotiableQuoteItemOperationResult!]! quote: NegotiableQuote } diff --git a/design-documents/graph-ql/directives.graphqls b/design-documents/graph-ql/directives.graphqls index 5af1c5e1f..58e415d57 100644 --- a/design-documents/graph-ql/directives.graphqls +++ b/design-documents/graph-ql/directives.graphqls @@ -38,7 +38,7 @@ directive @typeResolver(class: String="") on UNION directive @cache(cacheIdentity: String="" cacheable: Boolean=true) on QUERY -enum TriStateMutationResultStatus { +enum MutationResultStatus { SUCCESS FAILURE PARTIAL_SUCCESS From 3360a7c608343d8424902a3c66bab1e6990554de Mon Sep 17 00:00:00 2001 From: Peter Dohogne Date: Tue, 23 Nov 2021 15:40:44 -0500 Subject: [PATCH 478/479] PWA-1611: Updating proposal for union type result reporting --- .../coverage/b2b/negotiableQuotes.graphqls | 65 ++++++++----------- design-documents/graph-ql/directives.graphqls | 6 -- .../graph-ql/result-status.graphqls | 16 +++++ 3 files changed, 43 insertions(+), 44 deletions(-) create mode 100644 design-documents/graph-ql/result-status.graphqls diff --git a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls index f01e76bdf..4cdfd8c8c 100644 --- a/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls +++ b/design-documents/graph-ql/coverage/b2b/negotiableQuotes.graphqls @@ -77,6 +77,16 @@ type Mutation { # ): AddNegotiableQuoteFilesInput } +interface NegotiableQuoteUidNonFatalResultInterface { + quote_uid: ID! +} + +type NegotiableQuoteUidOperationSuccess implements NegotiableQuoteUidNonFatalResultInterface { +} + +type NegotiableQuoteInvalidStateError implements ErrorInterface { +} + type AddNegotiableQuoteItemsOutput { quote: NegotiableQuote # TODO: We'll probably want to add the same @@ -157,29 +167,18 @@ input DeleteNegotiableQuotesInput { quote_uids: [ID!]! @doc(description: "A List of UIDs obtained from negotiable quote types") } -type NegotiableQuoteOperationSuccess { - quote_uid: ID! -} +union DeleteNegotiableQuoteError = NegotiableQuoteInvalidStateError | NoSuchEntityUidError | InternalError -interface NegotiableQuoteOperationErrorInterface { +type DeleteNegotiableQuoteOperationFailure { quote_uid: ID! - message: String -} - -type NegotiableQuoteInvalidStateError implements NegotiableQuoteOperationErrorInterface { -} - -type NegotiableQuoteNotFoundError implements NegotiableQuoteOperationErrorInterface { -} - -type NegotiableQuoteUndefinedError implements NegotiableQuoteOperationErrorInterface { + errors: [DeleteNegotiableQuoteError!]! } -union NegotiableQuoteOperationResult = NegotiableQuoteOperationSuccess | NegotiableQuoteOperationErrorInterface +union DeleteNegotiableQuoteOperationResult = NegotiableQuoteUidOperationSuccess | DeleteNegotiableQuoteOperationFailure type DeleteNegotiableQuotesOutput { - result_status: MutationResultStatus! - operation_results: [NegotiableQuoteOperationResult!]! + result_status: BatchMutationStatus! + operation_results: [DeleteNegotiableQuoteOperationResult!]! # Implementation Note: We don't make the deleted quotes accessible # because "deleted" means they're hidden from the storefront UI. They will # still be visible (and labeled as deleted) for a Seller in the admin @@ -195,9 +194,18 @@ input CloseNegotiableQuotesInput { quote_uids: [ID!]! @doc(description: "A List of IDs from negotiable quote objects") } +union CloseNegotiableQuoteError = NegotiableQuoteInvalidStateError | NoSuchEntityUidError | InternalError + +type CloseNegotiableQuoteOperationFailure { + quote_uid: ID! + errors: [CloseNegotiableQuoteError!]! +} + +union CloseNegotiableQuoteOperationResult = NegotiableQuoteUidOperationSuccess | CloseNegotiableQuoteOperationFailure + type CloseNegotiableQuotesOutput { - result_status: MutationResultStatus! - operation_results: [NegotiableQuoteOperationResult!]! + result_status: BatchMutationStatus! + operation_results: [CloseNegotiableQuoteOperationResult!]! closed_quotes: [NegotiableQuote!] @doc(description: "An array containing the negotiable quotes that were just closed") @deprecated(reason: "Replaced with operation_results") #optionally display all negotiable quotes negotiable_quotes( @@ -450,26 +458,7 @@ type RequestNegotiableQuoteOutput { quote: NegotiableQuote } -type NegotiableQuoteItemOperationSuccess { - quote_item_uid: ID! -} - -interface NegotiableQuoteItemOperationErrorInterface { - quote_item_uid: ID! - message: String -} - -type NegotiableQuoteItemNotFoundError implements NegotiableQuoteItemOperationErrorInterface { -} - -type NegotiableQuoteItemUndefinedError implements NegotiableQuoteItemOperationErrorInterface { -} - -union NegotiableQuoteItemOperationResult = NegotiableQuoteItemOperationSuccess | NegotiableQuoteItemOperationErrorInterface - type RemoveNegotiableQuoteItemsOutput { - result_status: MutationResultStatus! - operation_results: [NegotiableQuoteItemOperationResult!]! quote: NegotiableQuote } diff --git a/design-documents/graph-ql/directives.graphqls b/design-documents/graph-ql/directives.graphqls index 58e415d57..1f25bedd9 100644 --- a/design-documents/graph-ql/directives.graphqls +++ b/design-documents/graph-ql/directives.graphqls @@ -37,9 +37,3 @@ directive @typeResolver(class: String="") on UNION | OBJECT directive @cache(cacheIdentity: String="" cacheable: Boolean=true) on QUERY - -enum MutationResultStatus { - SUCCESS - FAILURE - PARTIAL_SUCCESS -} diff --git a/design-documents/graph-ql/result-status.graphqls b/design-documents/graph-ql/result-status.graphqls new file mode 100644 index 000000000..036ce1a66 --- /dev/null +++ b/design-documents/graph-ql/result-status.graphqls @@ -0,0 +1,16 @@ +enum BatchMutationStatus { + SUCCESS + FAILURE + MIXED_RESULTS +} + +interface ErrorInterface { + message: String! +} + +type NoSuchEntityUidError implements ErrorInterface { + uid: ID! +} + +type InternalError implements ErrorInterface { +} From f4abd7b0b9b52ad610075566e5b522c0bd72a085 Mon Sep 17 00:00:00 2001 From: Nathan Smith Date: Tue, 21 Jan 2025 13:17:32 -0600 Subject: [PATCH 479/479] Update jwt-support.md --- design-documents/jwt-support.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/design-documents/jwt-support.md b/design-documents/jwt-support.md index b8f86eb3c..a9d9e7571 100644 --- a/design-documents/jwt-support.md +++ b/design-documents/jwt-support.md @@ -237,5 +237,3 @@ The `\Magento\Framework\Jwt\KeyGeneratorInterface` provides a possibility to cre ## Summary The proposed functionality can be added in a patch release. The introduced interfaces can be marked as @api in the next minor release. - -The [POC](https://github.com/joni-jones/magento2/tree/jwt-auth) provides a possibility to use JWT wrappers instead of own implementation for Cardinal Commerce integration.