docs(patch): clarify ESM import fix for Azure SDK

Author: ysfscream

scripts/patch-azure-sdk.js

@@ -1,4 +1,30 @@
-// scripts/patch-azure-sdk.js
+/**
+ * Azure SDK ESM Import Compatibility Patch Script
+ *
+ * This script addresses an issue with unsupported ESM import paths in the Azure SDK module by replacing them
+ * with compatible paths. This ensures that the module can be correctly resolved and executed in environments
+ * that do not fully support ESM imports.
+ *
+ * The script performs the following actions:
+ * - Checks if the target file exists in the specified path.
+ * - Reads the file content and searches for the unsupported ESM import statement.
+ * - Replaces the unsupported import with a compatible one if found.
+ * - Logs the status of the patch process, indicating success, already patched, or if the target file is missing.
+ * - Exits with an error code if the patching process encounters an error.
+ *
+ * Common error before patching:
+ * ERROR  Failed to compile with 1 error                                         5:12:59 PM
+ *
+ * This dependency was not found:
+ *
+ * * @ai-sdk/openai/internal in ./node_modules/@ai-sdk/azure/dist/index.mjs
+ *
+ * To install it, you can run: npm install --save @ai-sdk/openai/internal
+ * No type errors found
+ * Version: typescript 4.9.5
+ * Time: 4294ms
+ */
+
 const fs = require('fs')
 const path = require('path')
 
@@ -14,12 +40,12 @@ try {
     if (content.includes(incorrectImport)) {
       content = content.replace(incorrectImport, correctImport)
       fs.writeFileSync(targetFilePath, content, 'utf8')
-      console.log(`✅ Successfully patched ${targetFilePath} with correct import path.`)
+      console.log(`✅ Successfully patched ${targetFilePath} with compatible import path.`)
     } else if (content.includes(correctImport)) {
-      console.log(`☑️ File already patched or has correct import: ${targetFilePath}. Skipping.`)
+      console.log(`☑️ File already patched or has compatible import: ${targetFilePath}. Skipping.`)
     } else {
       console.warn(
-        `⚠️ Could not find the expected incorrect import statement in ${targetFilePath}. Patch script might need an update.`,
+        `⚠️ Could not find the expected unsupported import statement in ${targetFilePath}. Patch script might need an update.`,
       )
     }
   } else {
@@ -28,5 +54,6 @@ try {
   console.log('🎉 Azure SDK patch process completed.')
 } catch (error) {
   console.error(`❌ Error during Azure SDK patch process for ${targetFilePath}:`, error)
+  console.error(`📄 Error details: ${error.message}`)
   process.exit(1) // Exit with error code if patching fails
 }