fix: process object index signature jsdoc

Author: mdevils

docs/modules/index.md

@@ -24,6 +24,11 @@
 - [OpenApiDocumentPatchPathItem](index.md#openapidocumentpatchpathitem)
 - [OpenApiDocumentPatchSchema](index.md#openapidocumentpatchschema)
 - [OpenApiDocumentPatchTags](index.md#openapidocumentpatchtags)
+- [OpenApiSchemaFieldPathItem](index.md#openapischemafieldpathitem)
+
+### Variables
+
+- [stringIndexSignature](index.md#stringindexsignature)
 
 ## Type Aliases
 
@@ -174,3 +179,17 @@ Callback to patch tags.
 ##### Returns
 
 [`OpenApiTag`](../interfaces/openapi.OpenApiTag.md)[] \| `Promise`\<[`OpenApiTag`](../interfaces/openapi.OpenApiTag.md)[]\>
+
+___
+
+### OpenApiSchemaFieldPathItem
+
+Ƭ **OpenApiSchemaFieldPathItem**: `string` \| typeof [`stringIndexSignature`](index.md#stringindexsignature)
+
+Path item used to reference a path to a field in the schema.
+
+## Variables
+
+### stringIndexSignature
+
+• `Const` **stringIndexSignature**: typeof [`stringIndexSignature`](index.md#stringindexsignature)

docs/modules/openapi_client.md

@@ -213,7 +213,7 @@ ___
 
 ### GenerateModelJsDoc
 
-Ƭ **GenerateModelJsDoc**: (`params`: \{ `fieldPath`: `string`[] ; `schema`: [`OpenApiSchema`](openapi.md#openapischema) ; `schemaName`: `string` ; `suggestedJsDoc`: [`JsDocBlock`](../interfaces/index.JsDocBlock.md)  }) => [`JsDocBlock`](../interfaces/index.JsDocBlock.md)
+Ƭ **GenerateModelJsDoc**: (`params`: \{ `fieldPath`: [`OpenApiSchemaFieldPathItem`](index.md#openapischemafieldpathitem)[] ; `schema`: [`OpenApiSchema`](openapi.md#openapischema) ; `schemaName`: `string` ; `suggestedJsDoc`: [`JsDocBlock`](../interfaces/index.JsDocBlock.md)  }) => [`JsDocBlock`](../interfaces/index.JsDocBlock.md)
 
 #### Type declaration
 
@@ -226,7 +226,7 @@ Callback for generating the JSDoc of a model.
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `params` | `Object` | - |
-| `params.fieldPath` | `string`[] | Path to the field in the schema. Empty if the schema is a model schema. |
+| `params.fieldPath` | [`OpenApiSchemaFieldPathItem`](index.md#openapischemafieldpathitem)[] | Path to the field in the schema. Empty if the schema is a model schema. |
 | `params.schema` | [`OpenApiSchema`](openapi.md#openapischema) | OpenAPISchema of the model schema (if fieldPath is empty) or the field schema. |
 | `params.schemaName` | `string` | Name of the schema. |
 | `params.suggestedJsDoc` | [`JsDocBlock`](../interfaces/index.JsDocBlock.md) | Suggested JSDoc block. Used by default if the callback is not specified. |

src/index.ts

@@ -13,3 +13,4 @@ export type {
 } from './schema-to-typescript/config';
 export type {JsDocBlockTag, JsDocBlock} from './utils/jsdoc';
 export type {FilenameFormat, EntityNameCase} from './utils/string-utils';
+export {stringIndexSignature, type OpenApiSchemaFieldPathItem} from './schema-to-typescript/common';

src/schema-to-typescript/common.ts

@@ -51,13 +51,20 @@ import {attachJsDocComment, extractJsDoc, JsDocBlock, JsDocRenderConfig, renderJ
 import {applyEntityNameCase} from '../utils/string-utils';
 import {simplifyIntersectionTypeIfPossible, simplifyUnionTypeIfPossible} from '../utils/type-utils';
 
+export const stringIndexSignature = Symbol('stringIndexSignature');
+
+/**
+ * Path item used to reference a path to a field in the schema.
+ */
+export type OpenApiSchemaFieldPathItem = string | typeof stringIndexSignature;
+
 export interface GenerateSchemaTypeParams {
     schema: OpenApiSchema;
     getTypeName: (name: string, schema: OpenApiSchema) => string;
     getBinaryType: () => TSType;
     expand?: boolean;
-    processJsDoc?: (jsdoc: JsDocBlock, entity: OpenApiSchema, path: string[]) => JsDocBlock;
-    processJsDocPath?: string[];
+    processJsDoc?: (jsdoc: JsDocBlock, entity: OpenApiSchema, path: OpenApiSchemaFieldPathItem[]) => JsDocBlock;
+    processJsDocPath?: OpenApiSchemaFieldPathItem[];
     jsDocRenderConfig?: JsDocRenderConfig;
 }
 
@@ -234,16 +241,25 @@ export function generateSchemaType({
             if (typeof additionalProperties === 'object' && additionalProperties.title) {
                 keyName = applyEntityNameCase(additionalProperties.title, 'camelCase');
             }
+            let jsdoc = extractJsDoc(additionalProperties);
+            const currentProcessJsDocPath = (processJsDocPath ?? []).concat(stringIndexSignature);
+            if (processJsDoc) {
+                jsdoc = processJsDoc(jsdoc, additionalProperties, currentProcessJsDocPath);
+            }
             objectIntersection.push(
                 tsTypeLiteral([
                     attachJsDocComment(
                         tsIndexSignature(
                             [attachTypeAnnotation(identifier(keyName), tsTypeAnnotation(tsStringKeyword()))],
                             tsTypeAnnotation(
-                                generateSchemaType({schema: additionalProperties, ...commonSchemaGenerationOptions})
+                                generateSchemaType({
+                                    schema: additionalProperties,
+                                    ...commonSchemaGenerationOptions,
+                                    processJsDocPath: currentProcessJsDocPath
+                                })
                             )
                         ),
-                        renderJsDoc(extractJsDoc(additionalProperties), jsDocRenderConfig)
+                        renderJsDoc(jsdoc, jsDocRenderConfig)
                     )
                 ])
             );

src/schema-to-typescript/common/models.ts

@@ -39,7 +39,13 @@ import {attachJsDocComment, extractJsDoc, JsDocRenderConfig, renderJsDoc} from '
 import {getRelativeImportPath} from '../../utils/paths';
 import {applyEntityNameCase, formatFilename} from '../../utils/string-utils';
 import {ExtractedTags} from '../../utils/tags';
-import {attachTypeAnnotation, CommentsRenderConfig, generateSchemaType, renderTypeScript} from '../common';
+import {
+    attachTypeAnnotation,
+    CommentsRenderConfig,
+    generateSchemaType,
+    OpenApiSchemaFieldPathItem,
+    renderTypeScript
+} from '../common';
 import {ClientGenerationResultFile} from '../config';
 import {
     GenerateModelJsDoc,
@@ -89,7 +95,7 @@ function generateTypeExport({
             extendDependenciesAndGetResult(generateBinaryType(binaryTypes, importPath), dependencyImports),
         processJsDoc:
             generateJsDoc &&
-            ((jsdoc, schema, path: string[]) =>
+            ((jsdoc, schema, path: OpenApiSchemaFieldPathItem[]) =>
                 generateJsDoc({
                     suggestedJsDoc: jsdoc,
                     schema,

src/schema-to-typescript/openapi-to-typescript-client.ts

@@ -1,3 +1,4 @@
+import {OpenApiSchemaFieldPathItem} from './common';
 import {generateClient} from './common/client';
 import {
     generateCommonHttpClient,
@@ -462,7 +463,7 @@ export type GenerateModelJsDoc = (params: {
     /**
      * Path to the field in the schema. Empty if the schema is a model schema.
      */
-    fieldPath: string[];
+    fieldPath: OpenApiSchemaFieldPathItem[];
 }) => JsDocBlock;
 
 /**