Deprecate customerAccountUrl

Shopify · Jan 24, 2025 · 89de145 · 89de145
1 parent e90bc58
commit 89de145
Show file tree

Hide file tree

Showing 13 changed files with 44 additions and 561 deletions.
diff --git a/.changeset/clean-baboons-clap.md b/.changeset/clean-baboons-clap.md
@@ -0,0 +1,5 @@
+---
+'@shopify/hydrogen': patch
+---
+
+Remove deprecated `customerAccountUrl`
diff --git a/packages/hydrogen/src/createHydrogenContext.ts b/packages/hydrogen/src/createHydrogenContext.ts
@@ -202,9 +202,6 @@ export function createHydrogenContext<
     // defaults
     customerAccountId: env.PUBLIC_CUSTOMER_ACCOUNT_API_CLIENT_ID,
     shopId: env.SHOP_ID,
-
-    // deprecated - keep until next major release
-    customerAccountUrl: env.PUBLIC_CUSTOMER_ACCOUNT_API_URL,
   });
 
   /*

diff --git a/packages/hydrogen/src/customer/customer-account-helper.test.ts b/packages/hydrogen/src/customer/customer-account-helper.test.ts
@@ -8,7 +8,6 @@ describe('return correct urls', () => {
   describe('when shopId is provided', () => {
     const getAccountUrl = createCustomerAccountHelper(
       '2025-01',
-      customerAccountUrl,
       shopId,
     );
 
@@ -52,52 +51,4 @@ describe('return correct urls', () => {
       );
     });
   });
-
-  describe('when shopId is not provided', () => {
-    const getAccountUrl = createCustomerAccountHelper(
-      '2025-01',
-      customerAccountUrl,
-      undefined,
-    );
-
-    it('returns customer account base url', () => {
-      expect(getAccountUrl(URL_TYPE.CA_BASE_URL)).toBe(customerAccountUrl);
-    });
-
-    it('returns customer account auth url', () => {
-      expect(getAccountUrl(URL_TYPE.CA_BASE_AUTH_URL)).toBe(
-        `${customerAccountUrl}/auth`,
-      );
-    });
-
-    it('returns customer account graphql url', () => {
-      expect(getAccountUrl(URL_TYPE.GRAPHQL)).toBe(
-        `https://shopify.com/${shopId}/account/customer/api/2025-01/graphql`,
-      );
-    });
-
-    it('returns customer account authorize url', () => {
-      expect(getAccountUrl(URL_TYPE.AUTH)).toBe(
-        `${customerAccountUrl}/auth/oauth/authorize`,
-      );
-    });
-
-    it('returns customer account login scope', () => {
-      expect(getAccountUrl(URL_TYPE.LOGIN_SCOPE)).toBe(
-        'openid email https://api.customers.com/auth/customer.graphql',
-      );
-    });
-
-    it('returns customer account token exchange url', () => {
-      expect(getAccountUrl(URL_TYPE.TOKEN_EXCHANGE)).toBe(
-        `${customerAccountUrl}/auth/oauth/token`,
-      );
-    });
-
-    it('returns customer account logout url', () => {
-      expect(getAccountUrl(URL_TYPE.LOGOUT)).toBe(
-        `${customerAccountUrl}/auth/logout`,
-      );
-    });
-  });
 });
diff --git a/packages/hydrogen/src/customer/customer-account-helper.ts b/packages/hydrogen/src/customer/customer-account-helper.ts
@@ -10,21 +10,14 @@ export enum URL_TYPE {
 
 export function createCustomerAccountHelper(
   customerApiVersion: string,
-  deprecatedCustomerAccountUrl?: string,
-  shopId?: string,
+  shopId: string,
 ) {
-  const customerAccountUrl = shopId
-    ? `https://shopify.com/${shopId}`
-    : deprecatedCustomerAccountUrl;
-
-  const customerAccountAuthUrl = shopId
-    ? `https://shopify.com/authentication/${shopId}`
-    : `${deprecatedCustomerAccountUrl}/auth`;
+  const customerAccountUrl = `https://shopify.com/${shopId}`
+  const customerAccountAuthUrl = `https://shopify.com/authentication/${shopId}`
 
   return function getCustomerAccountUrl(urlType: URL_TYPE): string {
     switch (urlType) {
       case URL_TYPE.CA_BASE_URL:
-        // @ts-expect-error
         return customerAccountUrl;
       case URL_TYPE.CA_BASE_AUTH_URL:
         return customerAccountAuthUrl;

diff --git a/packages/hydrogen/src/customer/customer.auth-handler.example.jsx b/packages/hydrogen/src/customer/customer.auth-handler.example.jsx
@@ -22,8 +22,8 @@ export default {
       waitUntil: (p) => executionContext.waitUntil(p),
       /* Public Customer Account API client ID for your store */
       customerAccountId: env.PUBLIC_CUSTOMER_ACCOUNT_ID,
-      /* Public account URL for your store */
-      customerAccountUrl: env.PUBLIC_CUSTOMER_ACCOUNT_URL,
+      /* Shop Id */
+      shopId: env.SHOP_ID,
       request,
       session,
       customAuthStatusHandler,

diff --git a/packages/hydrogen/src/customer/customer.auth-handler.example.tsx b/packages/hydrogen/src/customer/customer.auth-handler.example.tsx
@@ -31,8 +31,8 @@ export default {
       waitUntil: (p) => executionContext.waitUntil(p),
       /* Public Customer Account API client ID for your store */
       customerAccountId: env.PUBLIC_CUSTOMER_ACCOUNT_ID,
-      /* Public account URL for your store */
-      customerAccountUrl: env.PUBLIC_CUSTOMER_ACCOUNT_URL,
+      /* Shop Id */
+      shopId: env.SHOP_ID,
       request,
       session,
       customAuthStatusHandler,

diff --git a/packages/hydrogen/src/customer/customer.example.jsx b/packages/hydrogen/src/customer/customer.example.jsx
@@ -15,8 +15,8 @@ export default {
       waitUntil: (p) => executionContext.waitUntil(p),
       /* Public Customer Account API token for your store */
       customerAccountId: env.PUBLIC_CUSTOMER_ACCOUNT_ID,
-      /* Public account URL for your store */
-      customerAccountUrl: env.PUBLIC_CUSTOMER_ACCOUNT_URL,
+      /* Shop Id */
+      shopId: env.SHOP_ID,
       request,
       session,
     });

diff --git a/packages/hydrogen/src/customer/customer.example.tsx b/packages/hydrogen/src/customer/customer.example.tsx
@@ -24,8 +24,8 @@ export default {
       waitUntil: (p) => executionContext.waitUntil(p),
       /* Public Customer Account API client ID for your store */
       customerAccountId: env.PUBLIC_CUSTOMER_ACCOUNT_ID,
-      /* Public account URL for your store */
-      customerAccountUrl: env.PUBLIC_CUSTOMER_ACCOUNT_URL,
+      /* Shop Id */
+      shopId: env.SHOP_ID,
       request,
       session,
     });

diff --git a/packages/hydrogen/src/customer/customer.opt-out-handler.example.jsx b/packages/hydrogen/src/customer/customer.opt-out-handler.example.jsx
@@ -22,8 +22,8 @@ export default {
       waitUntil: (p) => executionContext.waitUntil(p),
       /* Public Customer Account API client ID for your store */
       customerAccountId: env.PUBLIC_CUSTOMER_ACCOUNT_ID,
-      /* Public account URL for your store */
-      customerAccountUrl: env.PUBLIC_CUSTOMER_ACCOUNT_URL,
+      /* Shop Id */
+      shopId: env.SHOP_ID,
       request,
       session,
       customAuthStatusHandler,

diff --git a/packages/hydrogen/src/customer/customer.opt-out-handler.example.tsx b/packages/hydrogen/src/customer/customer.opt-out-handler.example.tsx
@@ -31,8 +31,8 @@ export default {
       waitUntil: (p) => executionContext.waitUntil(p),
       /* Public Customer Account API client ID for your store */
       customerAccountId: env.PUBLIC_CUSTOMER_ACCOUNT_ID,
-      /* Public account URL for your store */
-      customerAccountUrl: env.PUBLIC_CUSTOMER_ACCOUNT_URL,
+      /* Shop Id */
+      shopId: env.SHOP_ID,
       request,
       session,
       customAuthStatusHandler,