Merge pull request #1465 from Shopify/Support-storefront-api-access-f…

…or-customer-account-standard-api Support storefront api for customer account api
Shopify · Oct 27, 2023 · 03d69b5 · 03d69b5
2 parents 355e19f + c3aaf8a
commit 03d69b5
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/packages/ui-extensions/src/surfaces/customer-account/api/docs.ts b/packages/ui-extensions/src/surfaces/customer-account/api/docs.ts
@@ -73,5 +73,5 @@ export interface Docs_Standard_StorageApi
 
 export interface Docs_Standard_UIApi extends Pick<StandardApi<any>, 'ui'> {}
 
-export interface Docs_OrderStatus_QueryApi
-  extends Pick<OrderStatusApi<any>, 'query'> {}
+export interface Docs_Standard_QueryApi
+  extends Pick<StandardApi<any>, 'query'> {}
diff --git a/packages/ui-extensions/src/surfaces/customer-account/api/standard-api/standard-api.ts b/packages/ui-extensions/src/surfaces/customer-account/api/standard-api/standard-api.ts
@@ -4,6 +4,8 @@ import {
   Storage,
   Language,
   AuthenticatedAccount,
+  GraphQLError,
+  StorefrontApiVersion,
 } from '../shared';
 
 import type {ExtensionTarget} from '../../targets';
@@ -83,6 +85,16 @@ export interface StandardApi<Target extends ExtensionTarget = ExtensionTarget> {
     };
   };
   navigation: StandardExtensionNavigation;
+
+  /**
+   * Used to query the Storefront GraphQL API with a prefetched token.
+   *
+   * See [storefront api access examples](https://shopify.dev/docs/api/customer-account-ui-extensions/apis/standard-api/storefront-api#examples) for more information.
+   */
+  query: <Data = unknown, Variables = {[key: string]: unknown}>(
+    query: string,
+    options?: {variables?: Variables; version?: StorefrontApiVersion},
+  ) => Promise<{data?: Data; errors?: GraphQLError[]}>;
 }
 
 export interface CompanyLocationApi {