SDK TypeScript : guide d’intégration de bibliothèques tierces

weave.wrapOpenAI(new OpenAI());

​

Utiliser les intégrations Weave avec votre projet TypeScript

​

Si vous ne savez pas de quel type de projet il s’agit

npx tsx test.ts

"type": "module"

• Si type vaut "module", le projet utilise ESM.
• Si le champ type est absent ou défini sur "commonjs", le projet utilise CommonJS par défaut.

​

Configurer un projet CommonJS

1. Créez ou mettez à jour votre fichier package.json :
   {
     "type": "commonjs"
   }
   
2. Créez un fichier tsconfig.json avec des paramètres compatibles avec CommonJS :
   {
     "compilerOptions": {
       "module": "CommonJS",
       "target": "es2022",
       "rootDir": ".",
       "outDir": "dist"
     }
   }
   
   Ces paramètres configurent TypeScript pour compiler vers CommonJS :
   • module: "CommonJS". Compile les modules au format CommonJS (require ou module.exports). Pour plus de détails sur cette option du compilateur, consultez TypeScript - Module.
   • target: "es2022" (recommandé). Génère du JavaScript moderne compatible avec les versions récentes de Node.js. Pour plus de détails sur cette option du compilateur, consultez TypeScript - Target.
   • rootDir: ".". Définit le répertoire contenant tsconfig.json comme racine de vos fichiers d’entrée. TypeScript s’en sert, avec outDir, pour reproduire l’arborescence de votre dossier source dans la sortie. Pour plus de détails sur cette option du compilateur, consultez TypeScript - Root Dir.
   • outDir: "dist". Écrit le JavaScript généré et les autres sorties du compilateur dans le dossier dist. Pour plus de détails sur cette option du compilateur, consultez TypeScript - Out Dir.
3. Installez Weave et les autres bibliothèques requises :
   npm install weave
   
4. Compilez votre fichier TypeScript. Par exemple, pour un fichier test.ts :
   npx tsc
   
   Cette commande génère le fichier compilé dist/test.js.
5. Exécutez le fichier compilé avec Node.js :
   node dist/test.js
   

​

Configurer un projet ESM

1. Créez ou mettez à jour votre fichier package.json :
   {
     "type": "module"
   }
   
2. Créez un fichier tsconfig.json avec des paramètres ESM compatibles avec Node :
   {
     "compilerOptions": {
       "module": "nodenext",
       "moduleResolution": "nodenext",
       "target": "es2022",
       "rootDir": ".",
       "outDir": "dist"
     }
   }
   
   Ces paramètres configurent TypeScript pour compiler vers l’ESM moderne de Node.js :
   • module: "nodenext". Compile les modules selon la sémantique ESM de Node.js. Pour en savoir plus sur cette option du compilateur, consultez TypeScript - Module.
   • moduleResolution: "nodenext". Garantit que la résolution des modules respecte les règles ESM de Node.js. Pour en savoir plus sur cette option du compilateur, consultez TypeScript - Module Resolution.
   • target: "es2022" (recommandé). Génère du JavaScript moderne compatible avec les versions récentes de Node.js. Pour en savoir plus sur cette option du compilateur, consultez TypeScript - Target.
   • rootDir: ".". Définit le répertoire contenant tsconfig.json comme racine de vos fichiers d’entrée. TypeScript s’en sert avec outDir pour reproduire l’arborescence de vos dossiers sources dans la sortie. Pour en savoir plus sur cette option du compilateur, consultez TypeScript - Root Dir.
   • outDir: "dist". Écrit le JavaScript généré et les autres sorties du compilateur dans le dossier dist. Pour en savoir plus sur cette option du compilateur, consultez TypeScript - Out Dir.
3. Installez Weave ainsi que toute autre bibliothèque requise :
   npm install weave
   
4. Compilez votre fichier TypeScript. Par exemple, pour un fichier test.ts :
   npx tsc
   
   Cette commande compile le fichier en dist/test.js.
5. Exécutez le fichier compilé avec Node.js en préchargeant l’instrumentation Weave :
   node --import=weave/instrument dist/test.js
   

​

Utilisation avancée et dépannage

​

Utiliser NODE_OPTIONS (uniquement pour ESM)

export NODE_OPTIONS="--import=weave/instrument"

​

Compatibilité avec les bundlers

1. Déclarez les bibliothèques LLM comme externes dans la configuration de votre bundler. Le bundler ne les empaquette alors pas, et Weave peut leur appliquer correctement un patch au moment de l’exécution. L’exemple suivant montre comment déclarer le package openai comme externe dans une configuration next.config.js, afin que le bundler ne l’empaquette pas. Le module est chargé au moment de l’exécution, ce qui permet à Weave de lui appliquer automatiquement un patch et d’en assurer le suivi. Utilisez cette configuration avec des frameworks tels que Next.js pour activer l’instrumentation automatique.
   externals: {
   'openai': 'commonjs openai'
   }
   
2. Si le patching échoue toujours, rabattez-vous sur l’instrumentation manuelle.

​

Patching manuel (solution de repli)

import { wrapOpenAI } from 'weave';
const client = wrapOpenAI(new OpenAI());