@shopify/shopify-app-remix 4.2.1 → 5.0.0

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@shopify/shopify-app-remix",
-  "version": "4.2.1",
+  "version": "5.0.0",
   "description": "Shopify Remix - to simplify the building of Shopify Apps with Remix",
   "engines": {
-    "node": ">=20.10.0"
+    "node": ">=22.0.0"
   },
   "repository": {
     "type": "git",
@@ -70,21 +70,21 @@
     "@remix-run/node": "^2.17.5",
     "@remix-run/react": "^2.17.5",
     "@remix-run/testing": "^2.17.5",
-    "@shopify/generate-docs": "^1.2.0",
+    "@shopify/generate-docs": "^1.2.3",
     "@shopify/polaris": "^12.18.0",
     "@shopify/react-testing": "^6.0.0",
-    "@shopify/shopify-app-session-storage-memory": "^6.0.1",
-    "@types/react": "^19.2.16",
-    "jest-fetch-mock": "^3.0.3"
+    "@shopify/shopify-app-session-storage-memory": "^7.0.0",
+    "@types/react": "^19.2.17",
+    "jest-fetch-mock": "^3.2.0"
   },
   "dependencies": {
     "@remix-run/server-runtime": "^2.17.5",
-    "@shopify/admin-api-client": "^1.1.2",
-    "@shopify/shopify-api": "^13.1.0",
-    "@shopify/shopify-app-session-storage": "^5.0.1",
-    "@shopify/storefront-api-client": "^1.0.10",
+    "@shopify/admin-api-client": "^2.0.0",
+    "@shopify/shopify-api": "^14.0.0",
+    "@shopify/shopify-app-session-storage": "^6.0.0",
+    "@shopify/storefront-api-client": "^2.0.0",
     "compare-versions": "^6.1.1",
-    "isbot": "^5.1.40"
+    "isbot": "^5.2.0"
   },
   "peerDependencies": {
     "@remix-run/node": "*",
@@ -113,7 +113,6 @@
   "scripts": {
     "build-docs": "sh docs/build-docs.sh",
     "validate-docs": "sh ./docs/build-docs.sh isTest && pnpm compare-docs",
-    "lint": "eslint .",
     "build": "pnpm rollup && pnpm tsc -p ./tsconfig.build.json",
     "tsc": "tsc",
     "test": "jest",

package/src/server/__test-helpers/const.ts

@@ -11,4 +11,4 @@ export {
   BASE64_HOST,
   USER_ID,
 } from '@shopify/shopify-api/test-helpers';
-export const GRAPHQL_URL = `https://${TEST_SHOP}/admin/api/${ApiVersion.July25}/graphql.json`;
+export const GRAPHQL_URL = `https://${TEST_SHOP}/admin/api/${ApiVersion.July26}/graphql.json`;

package/src/server/__test-helpers/expect-admin-api-client.ts

@@ -18,7 +18,7 @@ export function expectAdminApiClient(
       const {admin, actualSession} = await factory();
       await mockExternalRequest({
         request: new Request(
-          `https://${TEST_SHOP}/admin/api/${ApiVersion.July25}/graphql.json`,
+          `https://${TEST_SHOP}/admin/api/${ApiVersion.July26}/graphql.json`,
           {
             method: 'POST',
             headers: {'X-Shopify-Access-Token': actualSession.accessToken!},

package/src/server/__test-helpers/expect-storefront-api-client.ts

@@ -18,7 +18,7 @@ export function expectStorefrontApiClient(
     const apiResponse = {data: {blogs: {nodes: [{id: 1}]}}, headers: {}};
     await mockExternalRequest({
       request: new Request(
-        `https://${TEST_SHOP}/api/${ApiVersion.July25}/graphql.json`,
+        `https://${TEST_SHOP}/api/${ApiVersion.July26}/graphql.json`,
         {
           method: 'POST',
           headers: {

package/src/server/__test-helpers/mock-graphql-request.ts

@@ -10,7 +10,7 @@ export interface MockGraphqlRequestArg {
 }
 
 export function mockGraphqlRequest(
-  apiVersion = ApiVersion.July25,
+  apiVersion = ApiVersion.July26,
   shopUrl = TEST_SHOP,
 ) {
   return async function ({
@@ -32,7 +32,7 @@ export function mockGraphqlRequest(
 }
 
 export function mockGraphqlRequests(
-  apiVersion = ApiVersion.July25,
+  apiVersion = ApiVersion.July26,
   shopUrl = TEST_SHOP,
 ) {
   return async function (...mocks: MockGraphqlRequestArg[]) {

package/src/server/__test-helpers/request-mock.ts

@@ -99,7 +99,7 @@ export async function validateMocks() {
       // TODO: we're currently not checking the headers properly. We should fix this.
       Object.entries(request.headers).forEach(([key, value]) => {
         expected.headers[key] = value;
-        actual.headers[key] = (init?.headers as any)[key];
+        actual.headers[key] = (init?.headers as any)?.[key];
       });
     }
 

package/src/server/__test-helpers/setup-valid-request.ts

@@ -20,8 +20,7 @@ interface ValidExtensionRequestOptions {
 }
 
 type ValidRequestOptions =
-  | ValidBaseRequestOptions
-  | ValidExtensionRequestOptions;
+  ValidBaseRequestOptions | ValidExtensionRequestOptions;
 
 export async function setupValidRequest(
   shopify: ShopifyApp<any>,

package/src/server/__test-helpers/test-config.ts

@@ -19,7 +19,7 @@ const TEST_FUTURE_FLAGS: Required<{[key in keyof FutureFlags]: true}> = {
 
 // Override the helper's future flags and logger settings for our purposes
 const TEST_CONFIG = {
-  apiVersion: ApiVersion.July25,
+  apiVersion: ApiVersion.July26,
   isEmbeddedApp: true,
   future: TEST_FUTURE_FLAGS,
   logger: {

package/src/server/authenticate/admin/authenticate.ts

@@ -80,8 +80,7 @@ export function authStrategyFactory<ConfigArg extends AppConfigArg>({
   }
 
   type AdminContextBase =
-    | EmbeddedAdminContext<ConfigArg>
-    | NonEmbeddedAdminContext<ConfigArg>;
+    EmbeddedAdminContext<ConfigArg> | NonEmbeddedAdminContext<ConfigArg>;
 
   function createContext(
     request: Request,
@@ -157,13 +156,11 @@ export function authStrategyFactory<ConfigArg extends AppConfigArg>({
         await ensureSessionTokenSearchParamIfRequired(params, request);
       }
 
-      logger.info('Authenticating admin request', {
-        shop: getShopFromRequest(request),
-      });
-
       const {payload, shop, sessionId, sessionToken} =
         await getSessionTokenContext(params, request);
 
+      logger.info('Authenticating admin request', {shop});
+
       logger.debug('Loading session from storage', {shop, sessionId});
       const existingSession = sessionId
         ? await config.sessionStorage!.loadSession(sessionId)

package/src/server/authenticate/admin/helpers/validate-redirect-url.ts

@@ -33,7 +33,7 @@ function isSafe(
 
   try {
     url = new URL(redirectUrl, domain);
-  } catch (error) {
+  } catch (_error) {
     return false;
   }
 

package/src/server/authenticate/public/appProxy/authenticate.ts

@@ -95,10 +95,9 @@ async function validateAppProxyHmac(
       searchParams.delete('index');
     }
 
-    let isValid = await api.utils.validateHmac(
-      Object.fromEntries(searchParams.entries()),
-      {signator: 'appProxy'},
-    );
+    let isValid = await api.utils.validateHmac(searchParams, {
+      signator: 'appProxy',
+    });
 
     if (!isValid) {
       const cleanPath = url.pathname
@@ -111,20 +110,18 @@ async function validateAppProxyHmac(
         `?_data=${data}&${searchParams.toString().replace(/^\?/, '')}`,
       );
 
-      isValid = await api.utils.validateHmac(
-        Object.fromEntries(searchParams.entries()),
-        {signator: 'appProxy'},
-      );
+      isValid = await api.utils.validateHmac(searchParams, {
+        signator: 'appProxy',
+      });
 
       if (!isValid) {
         const searchParams = new URLSearchParams(
           `?_data=${data}._index&${url.search.replace(/^\?/, '')}`,
         );
 
-        isValid = await api.utils.validateHmac(
-          Object.fromEntries(searchParams.entries()),
-          {signator: 'appProxy'},
-        );
+        isValid = await api.utils.validateHmac(searchParams, {
+          signator: 'appProxy',
+        });
       }
     }
 

package/src/server/authenticate/public/customer-account/authenticate.public.customerAccount.doc.example.ts

@@ -10,7 +10,8 @@ export const loader = async ({request}: LoaderFunctionArgs) => {
 };
 
 export const action = async ({request}: ActionFunctionArgs) => {
-  const {cors, sessionToken} = await authenticate.public.customerAccount(request);
+  const {cors, sessionToken} =
+    await authenticate.public.customerAccount(request);
 
   // Get offers for the customer
   const offers = getOffers(sessionToken.des, sessionToken.sub);

package/src/server/authenticate/webhooks/authenticate.ts

@@ -60,7 +60,6 @@ export function authenticateWebhookFactory<Topics extends string>(
         topic: check.topic as Topics,
         webhookId: check.webhookId,
         payload: JSON.parse(rawBody),
-        subTopic: check.subTopic || undefined,
         session: undefined,
         admin: undefined,
         webhookType: check.webhookType,

package/src/server/authenticate/webhooks/authenticate.webhooks.doc.example.ts

@@ -30,13 +30,13 @@ export const action = async ({request}: ActionFunctionArgs) => {
           }
         }
       `,
-      {
-        variables: {
-          productId: payload.admin_graphql_api_id,
-          time: new Date().toISOString(),
+        {
+          variables: {
+            productId: payload.admin_graphql_api_id,
+            time: new Date().toISOString(),
+          },
         },
-      },
-    );
+      );
   }
 
   return new Response();

package/src/server/authenticate/webhooks/types.ts

@@ -118,26 +118,6 @@ interface Context<Topics = string | number | symbol> {
    */
   webhookType: WebhookTypeValue;
 
-  /**
-   * The sub-topic of the webhook. Only available for traditional webhooks.
-   *
-   * @example
-   * <caption>Webhook sub-topic.</caption>
-   * <description>Get the webhook sub-topic.</description>
-   * ```ts
-   * // /app/routes/webhooks.tsx
-   * import { ActionFunctionArgs } from "@remix-run/node";
-   * import { authenticate } from "../shopify.server";
-   *
-   * export const action = async ({ request }: ActionFunctionArgs) => {
-   *   const { subTopic } = await authenticate.webhook(request);
-   *   return new Response();
-   * };
-   * ```
-   *
-   */
-  subTopic?: string;
-
   /**
    * The name assigned to the webhook subscription. Only available for traditional webhooks.
    */
@@ -255,8 +235,7 @@ export interface WebhookContextWithSession<
 }
 
 export type WebhookContext<Topics = string | number | symbol> =
-  | WebhookContextWithoutSession<Topics>
-  | WebhookContextWithSession<Topics>;
+  WebhookContextWithoutSession<Topics> | WebhookContextWithSession<Topics>;
 
 /**
  * Verifies requests coming from Shopify webhooks.

package/src/server/config-types.ts

@@ -204,7 +204,7 @@ export interface AppConfigArg<
    *
    * const shopify = shopifyApp({
    *   // ...etc
-   *   apiVersion: ApiVersion.July25,
+   *   apiVersion: ApiVersion.July26,
    * });
    * ```
    */

package/src/server/shopify-app.ts

@@ -89,9 +89,7 @@ export function shopifyApp<
   });
 
   const shopify:
-    | AdminApp<Config>
-    | AppStoreApp<Config>
-    | SingleMerchantApp<Config> = {
+    AdminApp<Config> | AppStoreApp<Config> | SingleMerchantApp<Config> = {
     sessionStorage: config.sessionStorage,
     addDocumentResponseHeaders: addDocumentResponseHeadersFactory(params),
     registerWebhooks: registerWebhooksFactory(params),
@@ -140,7 +138,7 @@ export function deriveApi(appConfig: AppConfigArg): BasicParams['api'] {
   let appUrl: URL;
   try {
     appUrl = new URL(appConfig.appUrl);
-  } catch (error) {
+  } catch (_error) {
     const message =
       appConfig.appUrl === ''
         ? `Detected an empty appUrl configuration, please make sure to set the necessary environment variables.\n` +

package/src/server/test-helpers/test-config.ts

@@ -51,9 +51,9 @@ export function testConfig<
  * the output being a const object.
  */
 type Modify<Type1, Type2> = {
-  [key in keyof Type2 as Type2[key] extends undefined
-    ? never
-    : key]: Type2[key];
+  [
+    key in keyof Type2 as Type2[key] extends undefined ? never : key
+  ]: Type2[key];
 } & {
   [key in keyof Type1 as key extends keyof Type2 ? never : key]: Type1[key];
 };

package/src/server/version.ts

@@ -1 +1 @@
-export const SHOPIFY_REMIX_LIBRARY_VERSION = '4.2.1';
+export const SHOPIFY_REMIX_LIBRARY_VERSION = '5.0.0';