fix: remove most of readonly properties to allow mutating in place

Author: mrlubos

.changeset/little-owls-flow.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/codegen-core': patch
+---
+
+fix: remove most of readonly properties to allow mutating in place

dev/openapi-ts.config.ts

@@ -32,25 +32,26 @@ export default defineConfig(() => {
           //   openapi: '3.1.0',
           //   paths: {},
           // },
-          path: path.resolve(
-            getSpecsPath(),
-            // '3.0.x',
-            '3.1.x',
-            // 'circular.yaml',
-            // 'dutchie.json',
-            // 'invalid',
-            // 'openai.yaml',
-            // 'full.yaml',
-            // 'opencode.yaml',
-            // 'sdk-instance.yaml',
-            // 'string-with-format.yaml',
-            // 'transformers.json',
-            // 'type-format.yaml',
-            'validators.yaml',
-            // 'validators-circular-ref.json',
-            // 'validators-circular-ref-2.yaml',
-            // 'zoom-video-sdk.json',
-          ),
+          path: 'https://gist.githubusercontent.com/nghiepdev/b2c9996750505ec82adb04fdc9b95ea6/raw/ebe990458001a5c4d3e1de0218f93dcb8f132db8/test-openapi.json',
+          // path: path.resolve(
+          //   getSpecsPath(),
+          //   // '3.0.x',
+          //   '3.1.x',
+          //   // 'circular.yaml',
+          //   // 'dutchie.json',
+          //   // 'invalid',
+          //   // 'openai.yaml',
+          //   // 'full.yaml',
+          //   // 'opencode.yaml',
+          //   // 'sdk-instance.yaml',
+          //   // 'string-with-format.yaml',
+          //   // 'transformers.json',
+          //   // 'type-format.yaml',
+          //   'validators.yaml',
+          //   // 'validators-circular-ref.json',
+          //   // 'validators-circular-ref-2.yaml',
+          //   // 'zoom-video-sdk.json',
+          // ),
           // path: 'https://get.heyapi.dev/hey-api/backend?branch=main&version=1.0.0',
           // path: 'http://localhost:4000/',
           // path: 'http://localhost:8000/openapi.json',
@@ -259,16 +260,17 @@ export default defineConfig(() => {
           //   fields.unwrap('path')
           // },
           // include...
-          instance: true,
-          // name: '@hey-api/sdk',
+          // instance: true,
+          name: '@hey-api/sdk',
           // operationId: false,
-          paramsStructure: 'flat',
+          // paramsStructure: 'flat',
           // responseStyle: 'data',
           // signature: 'auto',
           // signature: 'client',
           // signature: 'object',
           // transformer: '@hey-api/transformers',
-          // transformer: true,
+          transformer: true,
+          validator: true,
           // validator: {
           //   request: 'zod',
           //   response: 'zod',
@@ -290,7 +292,7 @@ export default defineConfig(() => {
         {
           // bigInt: true,
           // dates: true,
-          // name: '@hey-api/transformers',
+          name: '@hey-api/transformers',
         },
         {
           // name: 'fastify',
@@ -308,7 +310,7 @@ export default defineConfig(() => {
           // mutationOptions: {
           //   name: '{{name}}MO',
           // },
-          // name: '@tanstack/react-query',
+          name: '@tanstack/react-query',
           // queryKeys: {
           //   name: '{{name}}QK',
           // },

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

@@ -68,7 +68,6 @@ const makeSymbol = (
 ): ISymbolOut => {
   const { importKind, kind, ...restMeta } = meta as any;
   return {
-    exportFrom: [],
     id,
     importKind,
     kind,

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

@@ -19,7 +19,6 @@ describe('SymbolRegistry', () => {
       placeholder: 'Foo',
     });
     expect(symbol1).toEqual({
-      exportFrom: [],
       id: expect.any(Number),
       meta: {
         foo: 'bar',

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

@@ -9,19 +9,19 @@ export type IFileSelector = ReadonlyArray<string>;
 
 export type IFileIdentifier = number | IFileSelector;
 
-export interface IFileIn {
+export type IFileIn = {
   /**
    * File extension, if any.
    */
-  readonly extension?: string;
+  extension?: string;
   /**
    * Indicates whether the file is external, meaning it is not generated
    * as part of the project but is referenced (e.g., a module from
    * node_modules).
    *
    * @example true
    */
-  readonly external?: boolean;
+  external?: boolean;
   /**
    * Unique file ID. If one is not provided, it will be auto-generated.
    */
@@ -32,22 +32,22 @@ export interface IFileIn {
    *
    * @example "UserModel"
    */
-  readonly name?: string;
+  name?: string;
   /**
    * Absolute logical output path for the file.
    *
    * @example "/src/models/user.ts"
    */
-  readonly path?: string;
+  path?: string;
   /**
    * Selector array used to select this file.
    *
    * @example ["foo", "bar"]
    */
   readonly selector?: IFileSelector;
-}
+};
 
-export interface IFileOut extends IFileIn {
+export type IFileOut = IFileIn & {
   /**
    * Unique file ID.
    */
@@ -73,7 +73,7 @@ export interface IFileOut extends IFileIn {
      */
     imports: Array<number>;
   };
-}
+};
 
 export interface IFileRegistry {
   /**

packages/codegen-core/src/project/project.ts

@@ -50,11 +50,13 @@ export class Project implements IProject {
       symbolIdToFileIds.add(file.id);
       this.symbolIdToFileIds.set(symbol.id, symbolIdToFileIds);
       // update re-exports
-      for (const exportFrom of symbol.exportFrom) {
-        const exportSelector = [exportFrom];
-        const exportFile = this.files.reference(exportSelector);
-        if (exportFile.id !== file.id) {
-          exportFile.symbols.exports.push(symbol.id);
+      if (symbol.exportFrom) {
+        for (const exportFrom of symbol.exportFrom) {
+          const exportSelector = [exportFrom];
+          const exportFile = this.files.reference(exportSelector);
+          if (exportFile.id !== file.id) {
+            exportFile.symbols.exports.push(symbol.id);
+          }
         }
       }
     }

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

@@ -95,7 +95,6 @@ export class SymbolRegistry implements ISymbolRegistry {
     if (cachedId !== undefined) return this.values.get(cachedId)!;
     const id = this.id;
     const stub: ISymbolOut = {
-      exportFrom: [],
       id,
       meta,
       placeholder: wrapId(String(id)),
@@ -110,7 +109,6 @@ export class SymbolRegistry implements ISymbolRegistry {
     const id = symbol.id !== undefined ? symbol.id : this.id;
     const result: ISymbolOut = {
       ...symbol, // clone to avoid mutation
-      exportFrom: symbol.exportFrom ?? [],
       id,
       placeholder: symbol.placeholder ?? wrapId(String(id)),
     };

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

@@ -2,81 +2,67 @@ import type { ISymbolMeta } from '../extensions/types';
 
 export type ISymbolIdentifier = number | ISymbolMeta;
 
-export interface ISymbolIn {
+export type ISymbolIn = {
   /**
    * Array of file names (without extensions) from which this symbol is re-exported.
    *
    * @default undefined
    */
-  readonly exportFrom?: ReadonlyArray<string>;
+  exportFrom?: ReadonlyArray<string>;
   /**
    * Whether this symbol is exported from its own file.
    *
    * @default false
    */
-  readonly exported?: boolean;
+  exported?: boolean;
   /**
    * External module name if this symbol is imported from a module not managed
    * by the project (e.g. "zod", "lodash").
    *
    * @default undefined
    */
-  readonly external?: string;
+  external?: string;
   /**
    * Optional output strategy to override default behavior.
    *
    * @returns The file path to output the symbol to, or undefined to fallback to default behavior.
    */
-  readonly getFilePath?: (symbol: ISymbolOut) => string | undefined;
+  getFilePath?: (symbol: ISymbolOut) => string | undefined;
   /**
    * Unique symbol ID. If one is not provided, it will be auto-generated.
    */
   readonly id?: number;
   /**
    * Kind of import if this symbol represents an import.
    */
-  readonly importKind?: 'namespace' | 'default' | 'named';
+  importKind?: 'namespace' | 'default' | 'named';
   /**
    * Kind of symbol.
    */
-  readonly kind?: 'class' | 'function' | 'type';
+  kind?: 'class' | 'function' | 'type';
   /**
    * Arbitrary metadata about the symbol.
    *
    * @default undefined
    */
-  readonly meta?: ISymbolMeta;
+  meta?: ISymbolMeta;
   /**
    * The desired name for the symbol within its file. If there are multiple symbols
    * with the same desired name, this might not end up being the actual name.
    *
    * @example "UserModel"
    */
-  readonly name?: string;
+  name?: string;
   /**
    * Placeholder name for the symbol to be replaced later with the final value.
    *
    * @example "_heyapi_31_"
    */
   readonly placeholder?: string;
-}
+};
 
-export interface ISymbolOut extends ISymbolIn {
-  /**
-   * Array of file names (without extensions) from which this symbol is re-exported.
-   */
-  readonly exportFrom: ReadonlyArray<string>;
-  /**
-   * Unique symbol ID.
-   */
-  readonly id: number;
-  /**
-   * Placeholder name for the symbol to be replaced later with the final value.
-   *
-   * @example "_heyapi_31_"
-   */
-  readonly placeholder: string;
-}
+export type ISymbolOut = Omit<ISymbolIn, 'id' | 'placeholder'> &
+  Pick<Required<ISymbolIn>, 'id' | 'placeholder'>;
 
 export interface ISymbolRegistry {
   /**