feat: add import error handler that ignores urls from themer.sanity.build

Author: kbrabrand

packages/sanity/src/_internal/cli/util/importErrorHandler.ts

@@ -0,0 +1,65 @@
+import Module from 'node:module'
+
+export interface ImportErrorHandlerResult {
+  cleanup: () => void
+}
+
+// Module._load is an internal Node.js API not exposed in types
+interface ModuleConstructor {
+  _load(request: string, parent: Module | undefined, isMain: boolean): any
+}
+
+/**
+ * Return safe empty module with Proxy for deep property access. This ensures any property
+ * access or function call returns a safe value
+ */
+function getProxyHandler() {
+  const handler: ProxyHandler<object> = {
+    get: (_target, prop) => {
+      if (prop === '__esModule') return true
+      if (prop === 'default') return new Proxy({}, handler)
+      return new Proxy({}, handler)
+    },
+    apply: () => new Proxy({}, handler),
+  }
+  return new Proxy({}, handler)
+}
+
+/**
+ * Sets up a Module._load wrapper to silently ignore imports from https://themer.sanity.build
+ * This allows users to use themer URL imports in their config without breaking CLI commands.
+ *
+ * @returns Handler result with cleanup function
+ * @internal
+ */
+export function setupImportErrorHandler(): ImportErrorHandlerResult {
+  // Store original Module._load
+  const ModuleConstructor = Module as unknown as ModuleConstructor
+  const originalLoad = ModuleConstructor._load
+
+  // Override Module._load to catch and handle themer.sanity.build imports
+  ModuleConstructor._load = function (
+    request: string,
+    parent: Module | undefined,
+    isMain: boolean,
+  ) {
+    try {
+      return originalLoad.call(this, request, parent, isMain)
+    } catch (error) {
+      // Check if this is a themer.sanity.build URL import
+      if (request.startsWith('https://themer.sanity.build/api/')) {
+        // Return a safe proxy object that can be used in place of the theme
+        return getProxyHandler()
+      }
+
+      // Re-throw all other errors
+      throw error
+    }
+  }
+
+  return {
+    cleanup: () => {
+      ModuleConstructor._load = originalLoad
+    },
+  }
+}

packages/sanity/src/_internal/cli/util/mockBrowserEnvironment.ts

@@ -7,6 +7,7 @@ import {addHook} from 'pirates'
 import resolveFrom from 'resolve-from'
 
 import {getStudioEnvironmentVariables} from '../server/getStudioEnvironmentVariables'
+import {setupImportErrorHandler} from './importErrorHandler'
 
 const require = createRequire(import.meta.url)
 
@@ -24,6 +25,9 @@ export function mockBrowserEnvironment(basePath: string): () => void {
     }
   }
 
+  // Set up import error handler before esbuild-register to silently ignore themer.sanity.build URLs
+  const importErrorHandler = setupImportErrorHandler()
+
   const btoa = global.btoa
   const domCleanup = jsdomGlobal(jsdomDefaultHtml, {url: 'http://localhost:3333/'})
 
@@ -60,6 +64,7 @@ export function mockBrowserEnvironment(basePath: string): () => void {
     globalCleanup()
     windowCleanup()
     domCleanup()
+    importErrorHandler.cleanup()
   }
 }