feat: bump makeswift runtime to 0.24.0, simplify implementation (#2252)

arvinpoddar · bookernath · web-flow · commit 2cdd078facc7 · 2025-04-21T17:02:26.000-05:00
Co-authored-by: Nathan Booker &lt;nathan.booker@bigcommerce.com&gt;
diff --git a/.changeset/shiny-worlds-type.md b/.changeset/shiny-worlds-type.md
@@ -0,0 +1,5 @@
+---
+"@bigcommerce/catalyst-core": patch
+---
+
+fix: bump makeswift runtime version to `v0.24.0`, fixing issue with editing on SSGd pages
diff --git a/core/app/[locale]/layout.tsx b/core/app/[locale]/layout.tsx
@@ -1,4 +1,3 @@
-import { DraftModeScript } from '@makeswift/runtime/next/server';
 import { Analytics } from '@vercel/analytics/react';
 import { SpeedInsights } from '@vercel/speed-insights/next';
 import { clsx } from 'clsx';
@@ -105,7 +104,6 @@ export default async function RootLayout({ params, children }: Props) {
       <html className={clsx(fonts.map((f) => f.variable))} lang={locale}>
         <head>
           <SiteTheme />
-          <DraftModeScript appOrigin={process.env.MAKESWIFT_APP_ORIGIN} />
         </head>
         <body>
           <NextIntlClientProvider locale={locale} messages={messages}>
diff --git a/core/middlewares/with-makeswift.ts b/core/middlewares/with-makeswift.ts
@@ -1,27 +1,18 @@
-import { unstable_createMakeswiftDraftRequest } from '@makeswift/runtime/next/middleware';
+import { unstable_isDraftModeRequest } from '@makeswift/runtime/next/middleware';
 
 import { MiddlewareFactory } from './compose-middlewares';
 
-if (!process.env.MAKESWIFT_SITE_API_KEY) {
-  throw new Error('MAKESWIFT_SITE_API_KEY is not set');
-}
-
-const MAKESWIFT_SITE_API_KEY = process.env.MAKESWIFT_SITE_API_KEY;
-
 export const withMakeswift: MiddlewareFactory = (middleware) => {
   return async (request, event) => {
-    const draftRequest = await unstable_createMakeswiftDraftRequest(
-      request,
-      MAKESWIFT_SITE_API_KEY,
-    );
+    const isDraftRequest = unstable_isDraftModeRequest(request);
 
-    if (draftRequest != null) {
+    if (isDraftRequest) {
       // Makeswift Builder's locale switcher expects the host to derive locale strictly from
       // the URL. Disable cookie- and language-based locale detection when in draft mode to
       // meet this expectation.
-      draftRequest.headers.set('x-bc-disable-locale-detection', 'true');
+      request.headers.set('x-bc-disable-locale-detection', 'true');
 
-      return await middleware(draftRequest, event);
+      return await middleware(request, event);
     }
 
     return middleware(request, event);
diff --git a/core/next.config.ts b/core/next.config.ts
@@ -8,7 +8,7 @@ import { client } from './client';
 import { graphql } from './client/graphql';
 import { cspHeader } from './lib/content-security-policy';
 
-const withMakeswift = createWithMakeswift({ previewMode: false });
+const withMakeswift = createWithMakeswift();
 const withNextIntl = createNextIntlPlugin();
 
 const LocaleQuery = graphql(`
diff --git a/core/package.json b/core/package.json
@@ -17,7 +17,7 @@
     "@conform-to/react": "^1.3.0",
     "@conform-to/zod": "^1.3.0",
     "@icons-pack/react-simple-icons": "^11.2.0",
-    "@makeswift/runtime": "^0.23.11",
+    "@makeswift/runtime": "^0.24.0",
     "@radix-ui/react-accordion": "^1.2.3",
     "@radix-ui/react-alert-dialog": "^1.1.6",
     "@radix-ui/react-checkbox": "^1.1.4",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@bigcommerce/catalyst-core": patch
 +---
++
 +fix: bump makeswift runtime version to `v0.24.0`, fixing issue with editing on SSGd pages