comments

Author: james-elicx

packages/cloudflare/src/cli/build/patches/ast/vercel-og.ts

@@ -20,6 +20,12 @@ fix: |-
   "next/dist/compiled/@vercel/og/index.edge.js"
 `;
 
+/**
+ * Patches Node.js imports for the library to be Edge imports.
+ *
+ * @param root Root node.
+ * @returns Results of applying the rule.
+ */
 export function patchVercelOgImport(root: SgNode) {
   return applyRule(vercelOgImportRule, root);
 }
@@ -46,6 +52,12 @@ fix: |-
   var fallbackFont = getFallbackFont()
 `;
 
+/**
+ * Patches the default font fetching to use a .bin import.
+ *
+ * @param root Root node.
+ * @returns Results of applying the rule.
+ */
 export function patchVercelOgFallbackFont(root: SgNode) {
   return applyRule(vercelOgFallbackFontRule, root);
 }

packages/cloudflare/src/cli/build/patches/investigated/patch-vercel-og-library.ts

@@ -10,6 +10,16 @@ import { patchVercelOgFallbackFont, patchVercelOgImport } from "../ast/vercel-og
 
 type TraceInfo = { version: number; files: string[] };
 
+/**
+ * Patches the usage of @vercel/og to be compatible with Cloudflare Workers.
+ *
+ * This involves;
+ * - Ensuring the edge version is available in the OpenNext node_modules.
+ * - Changing node imports for the library to edge imports.
+ * - Changing font fetches in the library to use .bin imports.
+ *
+ * @param buildOpts Build options.
+ */
 export function patchVercelOgLibrary(buildOpts: BuildOptions) {
   const { appBuildOutputPath, outputDir } = buildOpts;