GraphQL Introspection of VTEX Apps

[ganobrega]

There is duplication code and breaking of compatibility between VTEX products (Faststore <=> VTEX Apps).

This can be uncomfortable for Headless. As we would have to create customizations to complement the feature and read many documents around to learn the same thing.

We need more compatibility with VTEX IO Apps and our custom apps, and something completely finished.GraphQL Servers of Checkout and Catalog module already exists. And many of custom apps can't be used because it's need to remap typeDefs

Look for this code for VTEX IO App ✅:

The given directive @context(provider: "vtex.store-graphql") is assuming to send to given provider

query GET_SHIPPING_INFO($items: [ShippingItem], $postalCode: String, $country: String) {
	shipping(items: $items, postalCode: $postalCode, country: $country) @context(provider: "vtex.store-graphql") {
		logisticsInfo {
			itemIndex
			selectedSla
			slas {
				id
				name
				price
				shippingEstimate
				shippingEstimateDate
				friendlyName
				deliveryIds {
					courierId
					warehouseId
					courierName
					quantity
				}
			}
		}
		messages {
			code
			text
			status
			fields {
				itemIndex
				ean
				skuName
			}
		}
	}
}

We just need to point to correct server by using stitchSchemas from @graphql-tools/stitch and typeDefs correctly.

Please, let's consider compatibility with existing GraphQL apps instead of re-mapping everything from the REST API. The pourpose of faststore/sdk needs to be a use-hook that calls this a existing query in VTEX IO GraphQL Server using swr

Problems

• VTEX IO doesn't support introspection
• Doing a Hack to introspect by /_v/private/admin-graphql-ide/v0/vtex.store-graphql endpoint works, but comes with GraphQL Schema conflicts of Product type and others like.

  Required to use secrets.revealed.json and VtexIdclientAutCookie cookie

Solutions

• Solve the conflicts of Introspection by admin-graphql-ide
  • Categorize all Schemas with namespaces to filter all we want exclude from typeDefs. Works great with @graphql-tools/merge