fix(helpers/zod): avoid import issue in certain environments (#1039)

Author: RobertCraigie

ecosystem-tests/cli.ts

@@ -25,6 +25,11 @@ const projectRunners = {
   'node-ts-esm': defaultNodeRunner,
   'node-ts-esm-web': defaultNodeRunner,
   'node-ts-esm-auto': defaultNodeRunner,
+  'node-ts-es2020': async () => {
+    await installPackage();
+    await run('npm', ['run', 'tsc']);
+    await run('npm', ['run', 'main']);
+  },
   'node-js': async () => {
     await installPackage();
     await run('node', ['test.js']);

ecosystem-tests/node-ts-es2020/index.ts

@@ -0,0 +1,36 @@
+import { zodResponseFormat } from 'openai/helpers/zod';
+import OpenAI from 'openai/index';
+import { z } from 'zod';
+
+const Step = z.object({
+  explanation: z.string(),
+  output: z.string(),
+});
+
+const MathResponse = z.object({
+  steps: z.array(Step),
+  final_answer: z.string(),
+});
+
+async function main() {
+  const client = new OpenAI();
+
+  const completion = await client.beta.chat.completions.parse({
+    model: 'gpt-4o-2024-08-06',
+    messages: [
+      { role: 'system', content: 'You are a helpful math tutor.' },
+      { role: 'user', content: 'solve 8x + 31 = 2' },
+    ],
+    response_format: zodResponseFormat(MathResponse, 'math_response'),
+  });
+
+  console.dir(completion, { depth: 5 });
+
+  const message = completion.choices[0]?.message;
+  if (message?.parsed) {
+    console.log(message.parsed.steps);
+    console.log(`answer: ${message.parsed.final_answer}`);
+  }
+}
+
+main();

ecosystem-tests/node-ts-es2020/package-lock.json

@@ -0,0 +1,16 @@
+{
+  "name": "node-ts-es2020",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "tsc": "tsc && tsc -p tsconfig.nodenext.json && tsc -p node_modules/openai/src/tsconfig.json",
+    "main": "ts-node index.ts"
+  },
+  "dependencies": {
+    "ts-node": "^10.9.2",
+    "zod": "^3.23.8"
+  },
+  "overrides": {
+    "@types/node": "20.4.2"
+  }
+}

ecosystem-tests/node-ts-es2020/package.json

@@ -0,0 +1,37 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "commonjs",
+    "lib": ["es2020", "dom"],
+    "allowJs": false,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "removeComments": true,
+    "forceConsistentCasingInFileNames": true,
+    "downlevelIteration": true,
+    "strict": true,
+    "moduleResolution": "node",
+    "paths": {},
+    "typeRoots": ["node_modules/@types"],
+    "types": ["node"],
+    "allowSyntheticDefaultImports": false,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "resolveJsonModule": true,
+    "incremental": true,
+    "strictBindCallApply": true,
+    "strictFunctionTypes": true,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "noImplicitReturns": true,
+    "noUnusedParameters": true,
+    "noUnusedLocals": true,
+    "noFallthroughCasesInSwitch": true,
+    "preserveSymlinks": true,
+    "suppressImplicitAnyIndexErrors": true
+  },
+  "exclude": ["node_modules"]
+}

ecosystem-tests/node-ts-es2020/tsconfig.base.json

@@ -0,0 +1,18 @@
+{
+  "extends": "./tsconfig.base.json",
+  "ts-node": {
+    "swc": true,
+    "transpileOnly": true
+  },
+  "compilerOptions": {
+    "declaration": false,
+    "declarationMap": false,
+    "allowJs": true,
+    "checkJs": false,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "types": ["node", "jest"],
+    "paths": {}
+  },
+  "include": ["index.ts", "tsconfig.json", "jest.config.ts", ".eslintrc.js"]
+}

ecosystem-tests/node-ts-es2020/tsconfig.json

@@ -0,0 +1,55 @@
+{
+  "include": ["tests/*.ts", "index.ts"],
+  "exclude": ["tests/*-shim-errors.ts"],
+
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+    /* Projects */
+    "incremental": true,
+
+    /* Language and Environment */
+    "target": "ES2015",
+    "lib": ["ES2015"],
+    "jsx": "react",
+
+    /* Modules */
+    "module": "commonjs",
+    "rootDir": "./",
+    "moduleResolution": "NodeNext",
+    "baseUrl": "./",
+    "paths": {
+      "~/*": ["*"]
+    },
+    "resolveJsonModule": true,
+    "composite": true,
+
+    /* Emit */
+    "outDir": "node_modules",
+    "noEmit": true,
+
+    /* Interop Constraints */
+    "isolatedModules": true,
+    "allowSyntheticDefaultImports": true,
+    /* "esModuleInterop": true, */
+    "forceConsistentCasingInFileNames": true,
+    "allowJs": true,
+    "checkJs": true,
+
+    /* Experimental Features */
+    "experimentalDecorators": true,
+
+    /* Type Checking */
+    "strict": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "skipLibCheck": false
+  }
+}

ecosystem-tests/node-ts-es2020/tsconfig.nodenext.json

@@ -1,5 +1,5 @@
-import { ResponseFormatJSONSchema } from 'openai/resources';
-import type z from 'zod';
+import { ResponseFormatJSONSchema } from '../resources/index';
+import type { infer as zodInfer, ZodType } from 'zod';
 import {
   AutoParseableResponseFormat,
   AutoParseableTool,
@@ -8,7 +8,7 @@ import {
 } from '../lib/parser';
 import { zodToJsonSchema as _zodToJsonSchema } from '../_vendor/zod-to-json-schema';
 
-function zodToJsonSchema(schema: z.ZodType, options: { name: string }): Record<string, unknown> {
+function zodToJsonSchema(schema: ZodType, options: { name: string }): Record<string, unknown> {
   return _zodToJsonSchema(schema, {
     openaiStrictMode: true,
     name: options.name,
@@ -55,11 +55,11 @@ function zodToJsonSchema(schema: z.ZodType, options: { name: string }): Record<s
  * This can be passed directly to the `.create()` method but will not
  * result in any automatic parsing, you'll have to parse the response yourself.
  */
-export function zodResponseFormat<ZodInput extends z.ZodType>(
+export function zodResponseFormat<ZodInput extends ZodType>(
   zodObject: ZodInput,
   name: string,
   props?: Omit<ResponseFormatJSONSchema.JSONSchema, 'schema' | 'strict' | 'name'>,
-): AutoParseableResponseFormat<z.infer<ZodInput>> {
+): AutoParseableResponseFormat<zodInfer<ZodInput>> {
   return makeParseableResponseFormat(
     {
       type: 'json_schema',
@@ -79,15 +79,15 @@ export function zodResponseFormat<ZodInput extends z.ZodType>(
  * automatically by the chat completion `.runTools()` method or automatically
  * parsed by `.parse()` / `.stream()`.
  */
-export function zodFunction<Parameters extends z.ZodType>(options: {
+export function zodFunction<Parameters extends ZodType>(options: {
   name: string;
   parameters: Parameters;
-  function?: ((args: z.infer<Parameters>) => unknown | Promise<unknown>) | undefined;
+  function?: ((args: zodInfer<Parameters>) => unknown | Promise<unknown>) | undefined;
   description?: string | undefined;
 }): AutoParseableTool<{
   arguments: Parameters;
   name: string;
-  function: (args: z.infer<Parameters>) => unknown;
+  function: (args: zodInfer<Parameters>) => unknown;
 }> {
   // @ts-expect-error TODO
   return makeParseableTool<any>(