use graphql-client utils

Author: scottdixon

packages/admin-api-client/package.json

@@ -66,7 +66,7 @@
     "!node_modules"
   ],
   "dependencies": {
-    "@shopify/graphql-client": "^0.3.0"
+    "@shopify/graphql-client": "^0.5.0"
   },
   "devDependencies": {
     "@babel/core": "^7.21.3",

packages/admin-api-client/src/admin-api-client.ts

@@ -2,21 +2,22 @@ import {
   createGraphQLClient,
   CustomFetchAPI,
   RequestParams as GQLClientRequestParams,
+  getCurrentSupportedAPIVersions,
+  validateDomainAndGetStoreUrl,
+  validateApiVersion,
 } from "@shopify/graphql-client";
 
 import {
   AdminAPIClient,
   AdminAPIClientConfig,
   AdminAPIClientRequestOptions,
 } from "./types";
-import { DEFAULT_CONTENT_TYPE, ACCESS_TOKEN_HEADER } from "./constants";
+import { DEFAULT_CONTENT_TYPE, ACCESS_TOKEN_HEADER, CLIENT } from "./constants";
 import {
-  getCurrentSupportedAPIVersions,
   validateRequiredStoreDomain,
   validateRequiredAccessToken,
-  validateApiVersion,
   validateServerSideUsage,
-} from "./utilities";
+} from "./validations";
 
 const httpRegEx = new RegExp("^(https?:)?//");
 
@@ -33,11 +34,15 @@ export function createAdminAPIClient({
   clientName?: string;
   customFetchAPI?: CustomFetchAPI;
 }): AdminAPIClient {
-  const currentSupportedAPIVersions = getCurrentSupportedAPIVersions();
+  const currentSupportedApiVersions = getCurrentSupportedAPIVersions();
 
   validateServerSideUsage();
   validateRequiredStoreDomain(storeDomain);
-  validateApiVersion(currentSupportedAPIVersions, apiVersion);
+  validateApiVersion({
+    client: CLIENT,
+    currentSupportedApiVersions,
+    apiVersion,
+  });
   validateRequiredAccessToken(accessToken);
 
   const trimmedStoreDomain = storeDomain.trim();
@@ -47,7 +52,11 @@ export function createAdminAPIClient({
 
   const generateApiUrl = (version?: string) => {
     if (version) {
-      validateApiVersion(currentSupportedAPIVersions, version);
+      validateApiVersion({
+        client: CLIENT,
+        currentSupportedApiVersions,
+        apiVersion: version,
+      });
     }
 
     const urlApiVersion = (version ?? apiVersion).trim();

packages/admin-api-client/src/constants.ts

@@ -3,3 +3,4 @@ export const DEFAULT_CONTENT_TYPE = "application/json";
 export const DEFAULT_CLIENT_VERSION = "ROLLUP_REPLACE_CLIENT_VERSION";
 export const ACCESS_TOKEN_HEADER = "X-Shopify-Access-Token";
 export const ERROR_PREFIX = "Admin API Client:";
+export const CLIENT = "Admin API Client";

packages/admin-api-client/src/tests/admin-api-client.test.ts

@@ -100,8 +100,7 @@ describe("Admin API Client", () => {
           expect(() =>
             createAdminAPIClient({
               ...config,
-              // @ts-ignore
-              storeDomain: undefined,
+              storeDomain: undefined as any,
             })
           ).toThrow(
             new Error("Admin API Client: a valid store domain must be provided")
@@ -112,8 +111,7 @@ describe("Admin API Client", () => {
           expect(() =>
             createAdminAPIClient({
               ...config,
-              // @ts-ignore
-              storeDomain: "   ",
+              storeDomain: "   " as any,
             })
           ).toThrow(
             new Error("Admin API Client: a valid store domain must be provided")
@@ -124,8 +122,7 @@ describe("Admin API Client", () => {
           expect(() =>
             createAdminAPIClient({
               ...config,
-              // @ts-ignore
-              storeDomain: 123,
+              storeDomain: 123 as any,
             })
           ).toThrow(
             new Error("Admin API Client: a valid store domain must be provided")
@@ -136,28 +133,11 @@ describe("Admin API Client", () => {
           expect(() =>
             createAdminAPIClient({
               ...config,
-              // @ts-ignore
-              apiVersion: undefined,
+              apiVersion: undefined as any,
             })
           ).toThrow(
             new Error(
-              `Admin API Client: the provided \`apiVersion\` is invalid. Current supported API versions: ${mockApiVersions.join(
-                ", "
-              )}`
-            )
-          );
-        });
-
-        it("throws an error when the api version is not a string", () => {
-          expect(() =>
-            createAdminAPIClient({
-              ...config,
-              // @ts-ignore
-              apiVersion: { year: 2022, month: 1 },
-            })
-          ).toThrow(
-            new Error(
-              `Admin API Client: the provided \`apiVersion\` is invalid. Current supported API versions: ${mockApiVersions.join(
+              `Admin API Client: the provided apiVersion ("undefined") is invalid. Current supported API versions: ${mockApiVersions.join(
                 ", "
               )}`
             )
@@ -175,7 +155,7 @@ describe("Admin API Client", () => {
           });
 
           expect(consoleWarnSpy).toHaveBeenCalledWith(
-            `Admin API Client: the provided \`apiVersion\` (\`2022-07\`) is deprecated or not supported. Current supported API versions: ${mockApiVersions.join(
+            `Admin API Client: the provided apiVersion ("2022-07") is deprecated or not supported. Current supported API versions: ${mockApiVersions.join(
               ", "
             )}`
           );
@@ -185,20 +165,17 @@ describe("Admin API Client", () => {
           expect(() =>
             createAdminAPIClient({
               ...config,
-              // @ts-ignore
-              accessToken: undefined,
+              accessToken: undefined as any,
             })
           ).toThrow(
             new Error(`Admin API Client: an access token must be provided`)
           );
         });
 
         it("throws an error when run in a browser environment (window is defined)", () => {
-          // @ts-ignore
-          global.window = {};
+          global.window = {} as any;
 
           expect(() =>
-            // @ts-ignore
             createAdminAPIClient({
               ...config,
               accessToken: "access-token",
@@ -341,7 +318,7 @@ describe("Admin API Client", () => {
           client.getApiUrl(version)
         ).toThrow(
           new Error(
-            `Admin API Client: the provided \`apiVersion\` is invalid. Current supported API versions: ${mockApiVersions.join(
+            `Admin API Client: the provided apiVersion ("123") is invalid. Current supported API versions: ${mockApiVersions.join(
               ", "
             )}`
           )
@@ -357,7 +334,7 @@ describe("Admin API Client", () => {
         client.getApiUrl(version);
 
         expect(consoleWarnSpy).toHaveBeenCalledWith(
-          `Admin API Client: the provided \`apiVersion\` (\`2021-01\`) is deprecated or not supported. Current supported API versions: ${mockApiVersions.join(
+          `Admin API Client: the provided apiVersion ("2021-01") is deprecated or not supported. Current supported API versions: ${mockApiVersions.join(
             ", "
           )}`
         );

packages/admin-api-client/src/utilities/api-versions.ts

@@ -0,0 +1,25 @@
+import { ERROR_PREFIX } from "./constants";
+
+export function validateRequiredStoreDomain(storeDomain: string | undefined) {
+  if (
+    !storeDomain ||
+    typeof storeDomain !== "string" ||
+    storeDomain.trim().length < 1
+  ) {
+    throw new Error(`${ERROR_PREFIX} a valid store domain must be provided`);
+  }
+}
+
+export function validateRequiredAccessToken(accessToken: string) {
+  if (!accessToken) {
+    throw new Error(`${ERROR_PREFIX} an access token must be provided`);
+  }
+}
+
+export function validateServerSideUsage() {
+  if (typeof window !== "undefined") {
+    throw new Error(
+      `${ERROR_PREFIX} this client should not be used in the browser`
+    );
+  }
+}