feat(codegen-core): add isRegistered() method to file and symbol registry

Author: mrlubos

.changeset/wet-glasses-sleep.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/codegen-core': patch
+---
+
+feat: add `isRegistered()` method to file and symbol registry

packages/codegen-core/src/__tests__/files.test.ts

@@ -28,6 +28,10 @@ describe('FileRegistry', () => {
     expect(registry.get(file1.id)).toEqual(file1);
     expect(registry.get(['foo'])).toEqual(file1);
 
+    // isRegistered should be true for explicitly registered files
+    expect(registry.isRegistered(file1.id)).toBe(true);
+    expect(registry.isRegistered(['foo'])).toBe(true);
+
     // Registering again with same selector returns same file
     const file1b = registry.register({ selector: ['foo'] });
     expect(file1b).toEqual(file1);
@@ -76,6 +80,17 @@ describe('FileRegistry', () => {
     expect(referenced).toContainEqual(file3);
     // Once registered, file1 is not in referenced set
     expect(referenced).not.toContainEqual(file1);
+
+    // Referenced-only file should not be considered registered
+    expect(registry.isRegistered(file3.id)).toBe(false);
+    // Once registered, file3 becomes registered and no longer appears in referenced()
+    const file3Registered = registry.register({
+      name: 'Baz',
+      selector: ['baz'],
+    });
+    expect(registry.isRegistered(file3Registered.id)).toBe(true);
+    const referencedAfter = Array.from(registry.referenced());
+    expect(referencedAfter).not.toContainEqual(file3Registered);
   });
 
   it('throws on invalid register or reference', () => {

packages/codegen-core/src/__tests__/symbols.test.ts

@@ -27,6 +27,10 @@ describe('SymbolRegistry', () => {
     expect(registry.get(symbol1.id)).toEqual(symbol1);
     expect(registry.get(['foo'])).toEqual(symbol1);
 
+    // isRegistered should be true for explicitly registered symbols
+    expect(registry.isRegistered(symbol1.id)).toBe(true);
+    expect(registry.isRegistered(['foo'])).toBe(true);
+
     // Registering again with same selector returns same symbol
     const symbol1b = registry.register({ selector: ['foo'] });
     expect(symbol1b).toEqual(symbol1);
@@ -75,6 +79,15 @@ describe('SymbolRegistry', () => {
     registry.setValue(symbol1.id, 42);
     expect(registry.hasValue(symbol1.id)).toBe(true);
     expect(registry.getValue(symbol1.id)).toBe(42);
+
+    // referenced-only symbol should not be registered until register() with data
+    const symRef = registry.reference(['qux']);
+    expect(registry.isRegistered(symRef.id)).toBe(false);
+    const symRegistered = registry.register({
+      placeholder: 'Qux',
+      selector: ['qux'],
+    });
+    expect(registry.isRegistered(symRegistered.id)).toBe(true);
   });
 
   it('throws on invalid register or reference', () => {

packages/codegen-core/src/files/registry.ts

@@ -43,6 +43,11 @@ export class FileRegistry implements IFileRegistry {
       : { selector: symbolIdOrSelector };
   }
 
+  isRegistered(fileIdOrSelector: number | ISelector): boolean {
+    const file = this.get(fileIdOrSelector);
+    return file ? this.registerOrder.has(file.id) : false;
+  }
+
   reference(fileIdOrSelector: number | ISelector): IFileOut {
     const file = this.idOrSelector(fileIdOrSelector);
     return this.register(file);
@@ -104,6 +109,9 @@ export class FileRegistry implements IFileRegistry {
 
     if (hasOtherKeys) {
       this.registerOrder.add(id);
+      if (this.referenceOrder.has(id)) {
+        this.referenceOrder.delete(id);
+      }
     } else {
       this.referenceOrder.add(id);
     }

packages/codegen-core/src/files/types.d.ts

@@ -82,6 +82,13 @@ export interface IFileRegistry {
    * @returns File ID before being incremented
    */
   readonly id: number;
+  /**
+   * Returns whether a file is registered in the registry.
+   *
+   * @param fileIdOrSelector File ID or selector to check.
+   * @returns True if the file is registered, false otherwise.
+   */
+  isRegistered(fileIdOrSelector: number | ISelector): boolean;
   /**
    * Returns a file by ID or selector, registering it if it doesn't exist.
    *

packages/codegen-core/src/symbols/registry.ts

@@ -51,6 +51,11 @@ export class SymbolRegistry implements ISymbolRegistry {
       : { selector: symbolIdOrSelector };
   }
 
+  isRegistered(symbolIdOrSelector: number | ISelector): boolean {
+    const symbol = this.get(symbolIdOrSelector);
+    return symbol ? this.registerOrder.has(symbol.id) : false;
+  }
+
   reference(symbolIdOrSelector: number | ISelector): ISymbolOut {
     const symbol = this.idOrSelector(symbolIdOrSelector);
     return this.register(symbol);

packages/codegen-core/src/symbols/types.d.ts

@@ -113,6 +113,13 @@ export interface ISymbolRegistry {
    * @returns Symbol ID before being incremented.
    */
   readonly id: number;
+  /**
+   * Returns whether a symbol is registered in the registry.
+   *
+   * @param symbolIdOrSelector Symbol ID or selector to check.
+   * @returns True if the symbol is registered, false otherwise.
+   */
+  isRegistered(symbolIdOrSelector: number | ISelector): boolean;
   /**
    * Returns a symbol by ID or selector, registering it if it doesn't exist.
    *

packages/openapi-ts-tests/main/test/openapi-ts.config.ts

@@ -34,9 +34,9 @@ export default defineConfig(() => {
           // },
           path: path.resolve(
             getSpecsPath(),
-            // '3.0.x',
-            '3.1.x',
-            // 'circular.yaml',
+            '3.0.x',
+            // '3.1.x',
+            'circular.yaml',
             // 'dutchie.json',
             // 'invalid',
             // 'openai.yaml',
@@ -46,7 +46,7 @@ export default defineConfig(() => {
             // 'string-with-format.yaml',
             // 'transformers.json',
             // 'type-format.yaml',
-            'validators.yaml',
+            // 'validators.yaml',
             // 'validators-circular-ref.json',
             // 'validators-circular-ref-2.yaml',
             // 'zoom-video-sdk.json',

packages/openapi-ts-tests/zod/v3/__snapshots__/3.0.x/mini/circular/zod.gen.ts

@@ -15,7 +15,11 @@ export const zCorge = z.object({
 });
 
 export const zFoo = z.object({
-    quux: z.optional(zQuux)
+    get quux() {
+        return z.optional(z.lazy((): any => {
+            return zQuux;
+        }));
+    }
 });
 
 export const zQux = z.union([

packages/openapi-ts-tests/zod/v3/__snapshots__/3.0.x/v3/circular/zod.gen.ts

@@ -12,8 +12,10 @@ export const zCorge = z.object({
     baz: z.array(zBaz).optional()
 });
 
-export const zFoo = z.object({
-    quux: zQuux.optional()
+export const zFoo: z.AnyZodObject = z.object({
+    quux: z.lazy(() => {
+        return zQuux;
+    }).optional()
 });
 
 export const zQux = z.union([