chore(vendor/zodJsonSchema): add option to duplicate top-level ref

openai · Aug 7, 2024 · 84b8a38 · 84b8a38
1 parent bceea60
commit 84b8a38
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 1 deletion.
diff --git a/src/_vendor/zod-to-json-schema/Options.ts b/src/_vendor/zod-to-json-schema/Options.ts
@@ -27,7 +27,7 @@ export type Options<Target extends Targets = 'jsonSchema7'> = {
   applyRegexFlags: boolean;
   emailStrategy: 'format:email' | 'format:idn-email' | 'pattern:zod';
   base64Strategy: 'format:binary' | 'contentEncoding:base64' | 'pattern:zod';
-  nameStrategy: 'ref' | 'title';
+  nameStrategy: 'ref' | 'duplicate-ref' | 'title';
   override?: (
     def: ZodTypeDef,
     refs: Refs,

diff --git a/src/_vendor/zod-to-json-schema/Refs.ts b/src/_vendor/zod-to-json-schema/Refs.ts
@@ -4,6 +4,12 @@ import { JsonSchema7Type } from './parseDef';
 
 export type Refs = {
   seen: Map<ZodTypeDef, Seen>;
+  /**
+   * Set of all the `$ref`s we created, e.g. `Set(['#/$defs/ui'])`
+   * this notable does not include any `definitions` that were
+   * explicitly given as an option.
+   */
+  seenRefs: Set<string>;
   currentPath: string[];
   propertyPath: string[] | undefined;
 } & Options<Targets>;
@@ -24,6 +30,7 @@ export const getRefs = (options?: string | Partial<Options<Targets>>): Refs => {
     ..._options,
     currentPath: currentPath,
     propertyPath: undefined,
+    seenRefs: new Set(),
     seen: new Map(
       Object.entries(_options.definitions).map(([name, def]) => [
         def._def,

diff --git a/src/_vendor/zod-to-json-schema/parseDef.ts b/src/_vendor/zod-to-json-schema/parseDef.ts
@@ -87,6 +87,10 @@ export function parseDef(
     const seenSchema = get$ref(seenItem, refs);
 
     if (seenSchema !== undefined) {
+      if ('$ref' in seenSchema) {
+        refs.seenRefs.add(seenSchema.$ref);
+      }
+
       return seenSchema;
     }
   }

diff --git a/src/_vendor/zod-to-json-schema/zodToJsonSchema.ts b/src/_vendor/zod-to-json-schema/zodToJsonSchema.ts
@@ -61,6 +61,8 @@ const zodToJsonSchema = <Target extends Targets = 'jsonSchema7'>(
     main.title = title;
   }
 
+  const rootRefPath = name ? [...refs.basePath, refs.definitionPath, name].join('/') : null;
+
   const combined: ReturnType<typeof zodToJsonSchema<Target>> =
     name === undefined ?
       definitions ?
@@ -69,6 +71,20 @@ const zodToJsonSchema = <Target extends Targets = 'jsonSchema7'>(
           [refs.definitionPath]: definitions,
         }
       : main
+    : refs.nameStrategy === 'duplicate-ref' ?
+      {
+        ...main,
+        ...(definitions || refs.seenRefs.has(rootRefPath!) ?
+          {
+            [refs.definitionPath]: {
+              ...definitions,
+              // only actually duplicate the schema definition if it was ever referenced
+              // otherwise the duplication is completely pointless
+              ...(refs.seenRefs.has(rootRefPath!) ? { [name]: main } : undefined),
+            },
+          }
+        : undefined),
+      }
     : {
         $ref: [...(refs.$refStrategy === 'relative' ? [] : refs.basePath), refs.definitionPath, name].join(
           '/',