@aws/nx-plugin 1.0.0-rc.4 → 1.0.0-rc.41

package/src/mcp-server/tools/generator-guide.js

@@ -1,9 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addGeneratorGuideTool = void 0;
-const zod_1 = require("zod");
-const generator_info_1 = require("../generator-info");
-const schema_1 = require("../schema");
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */ import { z } from "zod";
+import { fetchGuidePagesForGenerator, renderGeneratorInfo } from "../generator-info.js";
+import { PackageManagerSchema } from "../schema.js";
 /**
  * Add a tool which provides a detailed guide for an individual generator.
  *
@@ -12,55 +12,47 @@ const schema_1 = require("../schema");
  * — and the "unsupported combination" case, where it returns an explicit
  * warning instead of empty guide content. The tool description points
  * agents at `list-generators` for the list of filterable options.
- */
-const addGeneratorGuideTool = (server, generators) => {
+ */ export const addGeneratorGuideTool = (server, generators)=>{
     server.registerTool('generator-guide', {
-        description: 'Tool to retrieve detailed information about a specific generator. ' +
-            'Pass `options` with the values you intend to use for any filterable option ' +
-            '(e.g. infra, iac, auth, ux, protocol, sourceType, targetType) ' +
-            'to receive only the guide content relevant to those choices — this cuts noise ' +
-            'and avoids suggesting configuration from a different branch. The filterable keys ' +
-            'and their valid values for each generator are listed by the `list-generators` ' +
-            'tool; call it first if you are not sure which keys to pass. When the combination ' +
-            'you pick is not supported by the generator (e.g. connection from ts#trpc-api ' +
-            'to smithy), the tool returns an "Unsupported combination" warning with the ' +
-            'list of supported pairs. When `options` is omitted, every conditional section ' +
-            'is included and prefixed with a `> [!NOTE] Only when …` marker so you can see ' +
-            'the branching condition.',
+        description: 'Tool to retrieve detailed information about a specific generator. ' + 'Pass `options` with the values you intend to use for any filterable option ' + '(e.g. infra, iac, auth, ux, protocol, sourceType, targetType) ' + 'to receive only the guide content relevant to those choices — this cuts noise ' + 'and avoids suggesting configuration from a different branch. The filterable keys ' + 'and their valid values for each generator are listed by the `list-generators` ' + 'tool; call it first if you are not sure which keys to pass. When the combination ' + 'you pick is not supported by the generator (e.g. connection from ts#trpc-api ' + 'to smithy), the tool returns an "Unsupported combination" warning with the ' + 'list of supported pairs. When `options` is omitted, every conditional section ' + 'is included and prefixed with a `> [!NOTE] Only when …` marker so you can see ' + 'the branching condition.',
         inputSchema: {
-            packageManager: schema_1.PackageManagerSchema,
-            generator: zod_1.z.enum(generators.map((g) => g.id)),
-            options: zod_1.z
-                .record(zod_1.z.string(), zod_1.z.string())
-                .optional()
-                .describe('Optional map of generator option values (e.g. { infra: "rest-lambda", iac: "cdk" }) used to filter the guide to content that applies to those choices.'),
-        },
-    }, async ({ packageManager, generator: generatorId, options }) => {
-        const generator = generators.find((g) => g.id === generatorId);
+            packageManager: PackageManagerSchema,
+            generator: z.enum(generators.map((g)=>g.id)),
+            options: z.record(z.string(), z.string()).optional().describe('Optional map of generator option values (e.g. { infra: "rest-lambda", iac: "cdk" }) used to filter the guide to content that applies to those choices.')
+        }
+    }, async ({ packageManager, generator: generatorId, options })=>{
+        const generator = generators.find((g)=>g.id === generatorId);
         if (!generator) {
-            throw new Error(`No generator found with id ${generatorId}. Available generators: ${generators.map((g) => g.id).join(' ,')}`);
+            throw new Error(`No generator found with id ${generatorId}. Available generators: ${generators.map((g)=>g.id).join(' ,')}`);
         }
-        const guide = await (0, generator_info_1.fetchGuidePagesForGenerator)(generator, generators, packageManager, undefined, options);
+        const guide = await fetchGuidePagesForGenerator(generator, generators, packageManager, undefined, options);
         // An unsupported combination renders its own self-contained warning
         // (leads with `## <id>` and lists the supported predicates), so
         // return it directly without the usual guide header.
         if (guide.kind === 'unsupported') {
-            return { content: [{ type: 'text', text: guide.content }] };
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: guide.content
+                    }
+                ]
+            };
         }
         return {
             content: [
                 {
                     type: 'text',
-                    text: `## ${(0, generator_info_1.renderGeneratorInfo)(packageManager, generator)}
+                    text: `## ${renderGeneratorInfo(packageManager, generator)}
 
 # Guide
 
 ${guide.content}
-`,
-                },
-            ],
+`
+                }
+            ]
         };
     });
 };
-exports.addGeneratorGuideTool = addGeneratorGuideTool;
+
 //# sourceMappingURL=generator-guide.js.map

package/src/mcp-server/tools/generator-guide.js.map

@@ -1 +1 @@
-{"version":3,"file":"generator-guide.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/mcp-server/tools/generator-guide.ts"],"names":[],"mappings":";;;AAMA,6BAAwB;AACxB,sDAG2B;AAC3B,sCAAiD;AAEjD;;;;;;;;GAQG;AACI,MAAM,qBAAqB,GAAG,CACnC,MAAiB,EACjB,UAA6B,EAC7B,EAAE;IACF,MAAM,CAAC,YAAY,CACjB,iBAAiB,EACjB;QACE,WAAW,EACT,oEAAoE;YACpE,6EAA6E;YAC7E,gEAAgE;YAChE,gFAAgF;YAChF,mFAAmF;YACnF,gFAAgF;YAChF,mFAAmF;YACnF,+EAA+E;YAC/E,6EAA6E;YAC7E,gFAAgF;YAChF,gFAAgF;YAChF,0BAA0B;QAC5B,WAAW,EAAE;YACX,cAAc,EAAE,6BAAoB;YACpC,SAAS,EAAE,OAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC9C,OAAO,EAAE,OAAC;iBACP,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC;iBAC9B,QAAQ,EAAE;iBACV,QAAQ,CACP,wJAAwJ,CACzJ;SACJ;KACF,EACD,KAAK,EAAE,EAAE,cAAc,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,EAAE;QAC5D,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,WAAW,CAAC,CAAC;QAC/D,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,8BAA8B,WAAW,2BAA2B,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC7G,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,IAAA,4CAA2B,EAC7C,SAAS,EACT,UAAU,EACV,cAAc,EACd,SAAS,EACT,OAAO,CACR,CAAC;QAEF,oEAAoE;QACpE,gEAAgE;QAChE,qDAAqD;QACrD,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;YACjC,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QACvE,CAAC;QAED,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE,MAAM,IAAA,oCAAmB,EAAC,cAAc,EAAE,SAAS,CAAC;;;;EAIpE,KAAK,CAAC,OAAO;CACd;iBACU;aACF;SACF,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AArEW,QAAA,qBAAqB,yBAqEhC"}
+{"version":3,"sources":["../../../../../../packages/nx-plugin/src/mcp-server/tools/generator-guide.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';\nimport { z } from 'zod';\nimport type { NxGeneratorInfo } from '../../utils/generators';\nimport {\n  fetchGuidePagesForGenerator,\n  renderGeneratorInfo,\n} from '../generator-info';\nimport { PackageManagerSchema } from '../schema';\n\n/**\n * Add a tool which provides a detailed guide for an individual generator.\n *\n * `fetchGuidePagesForGenerator` handles both the \"narrow by `options`\"\n * case — reading each page's frontmatter `when:` to pick matching variants\n * — and the \"unsupported combination\" case, where it returns an explicit\n * warning instead of empty guide content. The tool description points\n * agents at `list-generators` for the list of filterable options.\n */\nexport const addGeneratorGuideTool = (\n  server: McpServer,\n  generators: NxGeneratorInfo[],\n) => {\n  server.registerTool(\n    'generator-guide',\n    {\n      description:\n        'Tool to retrieve detailed information about a specific generator. ' +\n        'Pass `options` with the values you intend to use for any filterable option ' +\n        '(e.g. infra, iac, auth, ux, protocol, sourceType, targetType) ' +\n        'to receive only the guide content relevant to those choices — this cuts noise ' +\n        'and avoids suggesting configuration from a different branch. The filterable keys ' +\n        'and their valid values for each generator are listed by the `list-generators` ' +\n        'tool; call it first if you are not sure which keys to pass. When the combination ' +\n        'you pick is not supported by the generator (e.g. connection from ts#trpc-api ' +\n        'to smithy), the tool returns an \"Unsupported combination\" warning with the ' +\n        'list of supported pairs. When `options` is omitted, every conditional section ' +\n        'is included and prefixed with a `> [!NOTE] Only when …` marker so you can see ' +\n        'the branching condition.',\n      inputSchema: {\n        packageManager: PackageManagerSchema,\n        generator: z.enum(generators.map((g) => g.id)),\n        options: z\n          .record(z.string(), z.string())\n          .optional()\n          .describe(\n            'Optional map of generator option values (e.g. { infra: \"rest-lambda\", iac: \"cdk\" }) used to filter the guide to content that applies to those choices.',\n          ),\n      },\n    },\n    async ({ packageManager, generator: generatorId, options }) => {\n      const generator = generators.find((g) => g.id === generatorId);\n      if (!generator) {\n        throw new Error(\n          `No generator found with id ${generatorId}. Available generators: ${generators.map((g) => g.id).join(' ,')}`,\n        );\n      }\n\n      const guide = await fetchGuidePagesForGenerator(\n        generator,\n        generators,\n        packageManager,\n        undefined,\n        options,\n      );\n\n      // An unsupported combination renders its own self-contained warning\n      // (leads with `## <id>` and lists the supported predicates), so\n      // return it directly without the usual guide header.\n      if (guide.kind === 'unsupported') {\n        return { content: [{ type: 'text' as const, text: guide.content }] };\n      }\n\n      return {\n        content: [\n          {\n            type: 'text' as const,\n            text: `## ${renderGeneratorInfo(packageManager, generator)}\n\n# Guide\n\n${guide.content}\n`,\n          },\n        ],\n      };\n    },\n  );\n};\n"],"names":["z","fetchGuidePagesForGenerator","renderGeneratorInfo","PackageManagerSchema","addGeneratorGuideTool","server","generators","registerTool","description","inputSchema","packageManager","generator","enum","map","g","id","options","record","string","optional","describe","generatorId","find","Error","join","guide","undefined","kind","content","type","text"],"mappings":"AAAA;;;CAGC,GAED,SAASA,CAAC,QAAQ,MAAM;AAExB,SACEC,2BAA2B,EAC3BC,mBAAmB,QACd,uBAAoB;AAC3B,SAASC,oBAAoB,QAAQ,eAAY;AAEjD;;;;;;;;CAQC,GACD,OAAO,MAAMC,wBAAwB,CACnCC,QACAC;IAEAD,OAAOE,YAAY,CACjB,mBACA;QACEC,aACE,uEACA,gFACA,mEACA,mFACA,sFACA,mFACA,sFACA,kFACA,gFACA,mFACA,mFACA;QACFC,aAAa;YACXC,gBAAgBP;YAChBQ,WAAWX,EAAEY,IAAI,CAACN,WAAWO,GAAG,CAAC,CAACC,IAAMA,EAAEC,EAAE;YAC5CC,SAAShB,EACNiB,MAAM,CAACjB,EAAEkB,MAAM,IAAIlB,EAAEkB,MAAM,IAC3BC,QAAQ,GACRC,QAAQ,CACP;QAEN;IACF,GACA,OAAO,EAAEV,cAAc,EAAEC,WAAWU,WAAW,EAAEL,OAAO,EAAE;QACxD,MAAML,YAAYL,WAAWgB,IAAI,CAAC,CAACR,IAAMA,EAAEC,EAAE,KAAKM;QAClD,IAAI,CAACV,WAAW;YACd,MAAM,IAAIY,MACR,CAAC,2BAA2B,EAAEF,YAAY,wBAAwB,EAAEf,WAAWO,GAAG,CAAC,CAACC,IAAMA,EAAEC,EAAE,EAAES,IAAI,CAAC,OAAO;QAEhH;QAEA,MAAMC,QAAQ,MAAMxB,4BAClBU,WACAL,YACAI,gBACAgB,WACAV;QAGF,oEAAoE;QACpE,gEAAgE;QAChE,qDAAqD;QACrD,IAAIS,MAAME,IAAI,KAAK,eAAe;YAChC,OAAO;gBAAEC,SAAS;oBAAC;wBAAEC,MAAM;wBAAiBC,MAAML,MAAMG,OAAO;oBAAC;iBAAE;YAAC;QACrE;QAEA,OAAO;YACLA,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,GAAG,EAAE5B,oBAAoBQ,gBAAgBC,WAAW;;;;AAIvE,EAAEc,MAAMG,OAAO,CAAC;AAChB,CAAC;gBACS;aACD;QACH;IACF;AAEJ,EAAE"}

package/src/mcp-server/tools/list-generators.d.ts

@@ -2,8 +2,8 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
-import { NxGeneratorInfo } from '../../utils/generators';
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import type { NxGeneratorInfo } from '../../utils/generators';
 /**
  * Adds a tool which lists details about the available generators.
  *

package/src/mcp-server/tools/list-generators.js

@@ -1,8 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addListGeneratorsTool = void 0;
-const schema_1 = require("../schema");
-const generator_info_1 = require("../generator-info");
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */ import { renderFilterableOptionsAsync, renderGeneratorInfo } from "../generator-info.js";
+import { PackageManagerSchema } from "../schema.js";
 /**
  * Adds a tool which lists details about the available generators.
  *
@@ -14,34 +14,28 @@ const generator_info_1 = require("../generator-info");
  *   - The union of `when:` frontmatter keys across the generator's guide
  *     pages (lets multi-variant generators like `connection` surface
  *     `sourceType` / `targetType` / `protocol` without any bespoke config).
- */
-const addListGeneratorsTool = (server, generators) => {
+ */ export const addListGeneratorsTool = (server, generators)=>{
     server.registerTool('list-generators', {
-        description: 'Tool to discover the available generators and how to run them. ' +
-            'Each entry includes a "Filterable options" section — pass those ' +
-            'keys to `generator-guide` before invoking a generator so the guide ' +
-            'is narrowed to the variant you intend to scaffold.',
-        inputSchema: { packageManager: schema_1.PackageManagerSchema },
-    }, async ({ packageManager }) => {
-        const entries = await Promise.all(generators.map(async (g) => {
-            const info = (0, generator_info_1.renderGeneratorInfo)(packageManager, g);
-            const filterable = await (0, generator_info_1.renderFilterableOptionsAsync)(g);
+        description: 'Tool to discover the available generators and how to run them. ' + 'Each entry includes a "Filterable options" section — pass those ' + 'keys to `generator-guide` before invoking a generator so the guide ' + 'is narrowed to the variant you intend to scaffold.',
+        inputSchema: {
+            packageManager: PackageManagerSchema
+        }
+    }, async ({ packageManager })=>{
+        const entries = await Promise.all(generators.map(async (g)=>{
+            const info = renderGeneratorInfo(packageManager, g);
+            const filterable = await renderFilterableOptionsAsync(g);
             return `### ${info}${filterable ? `\n${filterable}\n` : ''}`;
         }));
-        const guidance = 'Before running any generator below, call `generator-guide` with the ' +
-            "generator's id and `options` populated from its `generator-guide options` " +
-            'list — the guide is returned narrowed to the branches that apply to ' +
-            'those choices, which keeps you from mixing configuration from a ' +
-            'different variant.';
+        const guidance = 'Before running any generator below, call `generator-guide` with the ' + "generator's id and `options` populated from its `generator-guide options` " + 'list — the guide is returned narrowed to the branches that apply to ' + 'those choices, which keeps you from mixing configuration from a ' + 'different variant.';
         return {
             content: [
                 {
                     type: 'text',
-                    text: `## Available Generators\n\n${guidance}\n\n${entries.join('\n\n')}\n`,
-                },
-            ],
+                    text: `## Available Generators\n\n${guidance}\n\n${entries.join('\n\n')}\n`
+                }
+            ]
         };
     });
 };
-exports.addListGeneratorsTool = addListGeneratorsTool;
+
 //# sourceMappingURL=list-generators.js.map

package/src/mcp-server/tools/list-generators.js.map

@@ -1 +1 @@
-{"version":3,"file":"list-generators.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/mcp-server/tools/list-generators.ts"],"names":[],"mappings":";;;AAKA,sCAAiD;AACjD,sDAG2B;AAG3B;;;;;;;;;;;GAWG;AACI,MAAM,qBAAqB,GAAG,CACnC,MAAiB,EACjB,UAA6B,EAC7B,EAAE;IACF,MAAM,CAAC,YAAY,CACjB,iBAAiB,EACjB;QACE,WAAW,EACT,iEAAiE;YACjE,kEAAkE;YAClE,qEAAqE;YACrE,oDAAoD;QACtD,WAAW,EAAE,EAAE,cAAc,EAAE,6BAAoB,EAAE;KACtD,EACD,KAAK,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE;QAC3B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;YACzB,MAAM,IAAI,GAAG,IAAA,oCAAmB,EAAC,cAAc,EAAE,CAAC,CAAC,CAAC;YACpD,MAAM,UAAU,GAAG,MAAM,IAAA,6CAA4B,EAAC,CAAC,CAAC,CAAC;YACzD,OAAO,OAAO,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC/D,CAAC,CAAC,CACH,CAAC;QACF,MAAM,QAAQ,GACZ,sEAAsE;YACtE,4EAA4E;YAC5E,sEAAsE;YACtE,kEAAkE;YAClE,oBAAoB,CAAC;QACvB,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE,8BAA8B,QAAQ,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI;iBAC5E;aACF;SACF,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAtCW,QAAA,qBAAqB,yBAsChC"}
+{"version":3,"sources":["../../../../../../packages/nx-plugin/src/mcp-server/tools/list-generators.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';\nimport type { NxGeneratorInfo } from '../../utils/generators';\nimport {\n  renderFilterableOptionsAsync,\n  renderGeneratorInfo,\n} from '../generator-info';\nimport { PackageManagerSchema } from '../schema';\n\n/**\n * Adds a tool which lists details about the available generators.\n *\n * Each entry carries a \"Filterable options\" section that tells the agent\n * which keys it can pass to `generator-guide` to narrow the guide response\n * to only the branches relevant to its selection. The keys come from two\n * sources, merged transparently:\n *   - Enum properties from the generator's JSON schema.\n *   - The union of `when:` frontmatter keys across the generator's guide\n *     pages (lets multi-variant generators like `connection` surface\n *     `sourceType` / `targetType` / `protocol` without any bespoke config).\n */\nexport const addListGeneratorsTool = (\n  server: McpServer,\n  generators: NxGeneratorInfo[],\n) => {\n  server.registerTool(\n    'list-generators',\n    {\n      description:\n        'Tool to discover the available generators and how to run them. ' +\n        'Each entry includes a \"Filterable options\" section — pass those ' +\n        'keys to `generator-guide` before invoking a generator so the guide ' +\n        'is narrowed to the variant you intend to scaffold.',\n      inputSchema: { packageManager: PackageManagerSchema },\n    },\n    async ({ packageManager }) => {\n      const entries = await Promise.all(\n        generators.map(async (g) => {\n          const info = renderGeneratorInfo(packageManager, g);\n          const filterable = await renderFilterableOptionsAsync(g);\n          return `### ${info}${filterable ? `\\n${filterable}\\n` : ''}`;\n        }),\n      );\n      const guidance =\n        'Before running any generator below, call `generator-guide` with the ' +\n        \"generator's id and `options` populated from its `generator-guide options` \" +\n        'list — the guide is returned narrowed to the branches that apply to ' +\n        'those choices, which keeps you from mixing configuration from a ' +\n        'different variant.';\n      return {\n        content: [\n          {\n            type: 'text' as const,\n            text: `## Available Generators\\n\\n${guidance}\\n\\n${entries.join('\\n\\n')}\\n`,\n          },\n        ],\n      };\n    },\n  );\n};\n"],"names":["renderFilterableOptionsAsync","renderGeneratorInfo","PackageManagerSchema","addListGeneratorsTool","server","generators","registerTool","description","inputSchema","packageManager","entries","Promise","all","map","g","info","filterable","guidance","content","type","text","join"],"mappings":"AAAA;;;CAGC,GAGD,SACEA,4BAA4B,EAC5BC,mBAAmB,QACd,uBAAoB;AAC3B,SAASC,oBAAoB,QAAQ,eAAY;AAEjD;;;;;;;;;;;CAWC,GACD,OAAO,MAAMC,wBAAwB,CACnCC,QACAC;IAEAD,OAAOE,YAAY,CACjB,mBACA;QACEC,aACE,oEACA,qEACA,wEACA;QACFC,aAAa;YAAEC,gBAAgBP;QAAqB;IACtD,GACA,OAAO,EAAEO,cAAc,EAAE;QACvB,MAAMC,UAAU,MAAMC,QAAQC,GAAG,CAC/BP,WAAWQ,GAAG,CAAC,OAAOC;YACpB,MAAMC,OAAOd,oBAAoBQ,gBAAgBK;YACjD,MAAME,aAAa,MAAMhB,6BAA6Bc;YACtD,OAAO,CAAC,IAAI,EAAEC,OAAOC,aAAa,CAAC,EAAE,EAAEA,WAAW,EAAE,CAAC,GAAG,IAAI;QAC9D;QAEF,MAAMC,WACJ,yEACA,+EACA,yEACA,qEACA;QACF,OAAO;YACLC,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,2BAA2B,EAAEH,SAAS,IAAI,EAAEP,QAAQW,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC7E;aACD;QACH;IACF;AAEJ,EAAE"}

package/src/open-api/ts-client/__snapshots__/generator.additional-properties.spec.ts.snap

@@ -66,7 +66,7 @@ exports[`openApiTsClientGenerator - complex types > should handle response objec
  * Utility for serialisation and deserialisation of API types.
  */
 export class $IO {
-  protected static $mapValues = (data: any, fn: (item: any) => any) =>
+  public static $mapValues = (data: any, fn: (item: any) => any) =>
     Object.fromEntries(Object.entries(data).map(([k, v]) => [k, fn(v)]));
 
   public static GetDynamicPropertiesAny200Response = {
@@ -457,11 +457,31 @@ export class TestApi {
     this.getDynamicPropertyValues = this.getDynamicPropertyValues.bind(this);
   }
 
+  private $collectionDelimiters: { [format: string]: string } = {
+    csv: ',',
+    ssv: ' ',
+    pipes: '|',
+  };
+
+  private $deepObject = (key: string, value: any): string[] => {
+    if (value === undefined || value === null) {
+      return [];
+    }
+    if (typeof value !== 'object') {
+      return [\`\${key}=\${encodeURIComponent(String(value))}\`];
+    }
+    return Object.entries(value).flatMap(([prop, v]) =>
+      this.$deepObject(\`\${key}[\${encodeURIComponent(prop)}]\`, v),
+    );
+  };
+
   private $url = (
     path: string,
     pathParameters: { [key: string]: any },
     queryParameters: { [key: string]: any },
-    collectionFormats?: { [key: string]: 'multi' | 'csv' },
+    collectionFormats?: {
+      [key: string]: 'multi' | 'csv' | 'ssv' | 'pipes' | 'deepObject';
+    },
   ): string => {
     const baseUrl = this.$config.url.endsWith('/')
       ? this.$config.url.slice(0, -1)
@@ -472,15 +492,24 @@ export class TestApi {
       path,
     );
     const queryString = Object.entries(queryParameters)
-      .map(([key, value]) => {
+      .flatMap(([key, value]) => {
         if (Array.isArray(value) && collectionFormats?.[key] === 'multi') {
-          return value
-            .map(
-              (v) => \`\${encodeURIComponent(key)}=\${encodeURIComponent(\`\${v}\`)}\`,
-            )
-            .join('&');
+          return value.map(
+            (v) => \`\${encodeURIComponent(key)}=\${encodeURIComponent(\`\${v}\`)}\`,
+          );
+        }
+        if (
+          collectionFormats?.[key] === 'deepObject' &&
+          value !== null &&
+          typeof value === 'object'
+        ) {
+          return this.$deepObject(encodeURIComponent(key), value);
         }
-        return \`\${encodeURIComponent(key)}=\${encodeURIComponent(Array.isArray(value) ? value.map(String).join(',') : String(value))}\`;
+        const delimiter =
+          this.$collectionDelimiters[collectionFormats?.[key] ?? 'csv'] ?? ',';
+        return [
+          \`\${encodeURIComponent(key)}=\${encodeURIComponent(Array.isArray(value) ? value.map(String).join(delimiter) : String(value))}\`,
+        ];
       })
       .join('&');
     return (
@@ -490,13 +519,22 @@ export class TestApi {
 
   private $headers = (
     headerParameters: { [key: string]: any },
-    collectionFormats?: { [key: string]: 'multi' | 'csv' },
+    collectionFormats?: { [key: string]: 'multi' | 'csv' | 'ssv' | 'pipes' },
   ): [string, string][] => {
     return Object.entries(headerParameters).flatMap(([key, value]) => {
       if (Array.isArray(value) && collectionFormats?.[key] === 'multi') {
         return value.map((v) => [key, String(v)]) as [string, string][];
       }
-      return [[key, String(value)]];
+      const delimiter =
+        this.$collectionDelimiters[collectionFormats?.[key] ?? 'csv'] ?? ',';
+      return [
+        [
+          key,
+          Array.isArray(value)
+            ? value.map(String).join(delimiter)
+            : String(value),
+        ],
+      ];
     });
   };
 
@@ -765,7 +803,7 @@ exports[`openApiTsClientGenerator - complex types > should handle response objec
  * Utility for serialisation and deserialisation of API types.
  */
 export class $IO {
-  protected static $mapValues = (data: any, fn: (item: any) => any) =>
+  public static $mapValues = (data: any, fn: (item: any) => any) =>
     Object.fromEntries(Object.entries(data).map(([k, v]) => [k, fn(v)]));
 
   public static GetPatternPropertiesArrayArrays200Response = {
@@ -1872,11 +1910,31 @@ export class TestApi {
       this.getPatternPropertiesSingle.bind(this);
   }
 
+  private $collectionDelimiters: { [format: string]: string } = {
+    csv: ',',
+    ssv: ' ',
+    pipes: '|',
+  };
+
+  private $deepObject = (key: string, value: any): string[] => {
+    if (value === undefined || value === null) {
+      return [];
+    }
+    if (typeof value !== 'object') {
+      return [\`\${key}=\${encodeURIComponent(String(value))}\`];
+    }
+    return Object.entries(value).flatMap(([prop, v]) =>
+      this.$deepObject(\`\${key}[\${encodeURIComponent(prop)}]\`, v),
+    );
+  };
+
   private $url = (
     path: string,
     pathParameters: { [key: string]: any },
     queryParameters: { [key: string]: any },
-    collectionFormats?: { [key: string]: 'multi' | 'csv' },
+    collectionFormats?: {
+      [key: string]: 'multi' | 'csv' | 'ssv' | 'pipes' | 'deepObject';
+    },
   ): string => {
     const baseUrl = this.$config.url.endsWith('/')
       ? this.$config.url.slice(0, -1)
@@ -1887,15 +1945,24 @@ export class TestApi {
       path,
     );
     const queryString = Object.entries(queryParameters)
-      .map(([key, value]) => {
+      .flatMap(([key, value]) => {
         if (Array.isArray(value) && collectionFormats?.[key] === 'multi') {
-          return value
-            .map(
-              (v) => \`\${encodeURIComponent(key)}=\${encodeURIComponent(\`\${v}\`)}\`,
-            )
-            .join('&');
+          return value.map(
+            (v) => \`\${encodeURIComponent(key)}=\${encodeURIComponent(\`\${v}\`)}\`,
+          );
+        }
+        if (
+          collectionFormats?.[key] === 'deepObject' &&
+          value !== null &&
+          typeof value === 'object'
+        ) {
+          return this.$deepObject(encodeURIComponent(key), value);
         }
-        return \`\${encodeURIComponent(key)}=\${encodeURIComponent(Array.isArray(value) ? value.map(String).join(',') : String(value))}\`;
+        const delimiter =
+          this.$collectionDelimiters[collectionFormats?.[key] ?? 'csv'] ?? ',';
+        return [
+          \`\${encodeURIComponent(key)}=\${encodeURIComponent(Array.isArray(value) ? value.map(String).join(delimiter) : String(value))}\`,
+        ];
       })
       .join('&');
     return (
@@ -1905,13 +1972,22 @@ export class TestApi {
 
   private $headers = (
     headerParameters: { [key: string]: any },
-    collectionFormats?: { [key: string]: 'multi' | 'csv' },
+    collectionFormats?: { [key: string]: 'multi' | 'csv' | 'ssv' | 'pipes' },
   ): [string, string][] => {
     return Object.entries(headerParameters).flatMap(([key, value]) => {
       if (Array.isArray(value) && collectionFormats?.[key] === 'multi') {
         return value.map((v) => [key, String(v)]) as [string, string][];
       }
-      return [[key, String(value)]];
+      const delimiter =
+        this.$collectionDelimiters[collectionFormats?.[key] ?? 'csv'] ?? ',';
+      return [
+        [
+          key,
+          Array.isArray(value)
+            ? value.map(String).join(delimiter)
+            : String(value),
+        ],
+      ];
     });
   };
 
@@ -2245,7 +2321,7 @@ exports[`openApiTsClientGenerator - complex types > should render \`unknown\` va
  * Utility for serialisation and deserialisation of API types.
  */
 export class $IO {
-  protected static $mapValues = (data: any, fn: (item: any) => any) =>
+  public static $mapValues = (data: any, fn: (item: any) => any) =>
     Object.fromEntries(Object.entries(data).map(([k, v]) => [k, fn(v)]));
 
   public static GetAdditionalPropsTrue200Response = {
@@ -2326,11 +2402,31 @@ export class TestApi {
     this.getBareObject = this.getBareObject.bind(this);
   }
 
+  private $collectionDelimiters: { [format: string]: string } = {
+    csv: ',',
+    ssv: ' ',
+    pipes: '|',
+  };
+
+  private $deepObject = (key: string, value: any): string[] => {
+    if (value === undefined || value === null) {
+      return [];
+    }
+    if (typeof value !== 'object') {
+      return [\`\${key}=\${encodeURIComponent(String(value))}\`];
+    }
+    return Object.entries(value).flatMap(([prop, v]) =>
+      this.$deepObject(\`\${key}[\${encodeURIComponent(prop)}]\`, v),
+    );
+  };
+
   private $url = (
     path: string,
     pathParameters: { [key: string]: any },
     queryParameters: { [key: string]: any },
-    collectionFormats?: { [key: string]: 'multi' | 'csv' },
+    collectionFormats?: {
+      [key: string]: 'multi' | 'csv' | 'ssv' | 'pipes' | 'deepObject';
+    },
   ): string => {
     const baseUrl = this.$config.url.endsWith('/')
       ? this.$config.url.slice(0, -1)
@@ -2341,15 +2437,24 @@ export class TestApi {
       path,
     );
     const queryString = Object.entries(queryParameters)
-      .map(([key, value]) => {
+      .flatMap(([key, value]) => {
         if (Array.isArray(value) && collectionFormats?.[key] === 'multi') {
-          return value
-            .map(
-              (v) => \`\${encodeURIComponent(key)}=\${encodeURIComponent(\`\${v}\`)}\`,
-            )
-            .join('&');
+          return value.map(
+            (v) => \`\${encodeURIComponent(key)}=\${encodeURIComponent(\`\${v}\`)}\`,
+          );
+        }
+        if (
+          collectionFormats?.[key] === 'deepObject' &&
+          value !== null &&
+          typeof value === 'object'
+        ) {
+          return this.$deepObject(encodeURIComponent(key), value);
         }
-        return \`\${encodeURIComponent(key)}=\${encodeURIComponent(Array.isArray(value) ? value.map(String).join(',') : String(value))}\`;
+        const delimiter =
+          this.$collectionDelimiters[collectionFormats?.[key] ?? 'csv'] ?? ',';
+        return [
+          \`\${encodeURIComponent(key)}=\${encodeURIComponent(Array.isArray(value) ? value.map(String).join(delimiter) : String(value))}\`,
+        ];
       })
       .join('&');
     return (
@@ -2359,13 +2464,22 @@ export class TestApi {
 
   private $headers = (
     headerParameters: { [key: string]: any },
-    collectionFormats?: { [key: string]: 'multi' | 'csv' },
+    collectionFormats?: { [key: string]: 'multi' | 'csv' | 'ssv' | 'pipes' },
   ): [string, string][] => {
     return Object.entries(headerParameters).flatMap(([key, value]) => {
       if (Array.isArray(value) && collectionFormats?.[key] === 'multi') {
         return value.map((v) => [key, String(v)]) as [string, string][];
       }
-      return [[key, String(value)]];
+      const delimiter =
+        this.$collectionDelimiters[collectionFormats?.[key] ?? 'csv'] ?? ',';
+      return [
+        [
+          key,
+          Array.isArray(value)
+            ? value.map(String).join(delimiter)
+            : String(value),
+        ],
+      ];
     });
   };