additional properties -> json input

Author: mmkal

src/index.ts

@@ -97,7 +97,10 @@ export function createCli<R extends AnyRouter>({router, ...params}: TrpcCliParam
                 },
               },
             },
-            getPojoInput: parsedCliParams => JSON.parse(parsedCliParams.options.input as string) as {},
+            getPojoInput: parsedCliParams => {
+              if (parsedCliParams.options.input == null) return parsedCliParams.options.input
+              return JSON.parse(parsedCliParams.options.input as string) as {}
+            },
           },
           incompatiblePairs: [],
           type,
@@ -182,7 +185,7 @@ export function createCli<R extends AnyRouter>({router, ...params}: TrpcCliParam
       })
 
       const unusedFlagAliases: Record<string, string> = {...meta.aliases?.flags}
-      Object.entries(flagJsonSchemaProperties).forEach(([propertyKey, propertyValue]) => {
+      const addOptionForProperty = ([propertyKey, propertyValue]: [string, JsonSchema7Type]) => {
         const description = getDescription(propertyValue)
 
         const longOption = `--${kebabCase(propertyKey)}`
@@ -356,7 +359,19 @@ export function createCli<R extends AnyRouter>({router, ...params}: TrpcCliParam
         )
 
         command.addOption(option)
-      })
+      }
+
+      if (
+        'additionalProperties' in procedureInputs.optionsJsonSchema &&
+        procedureInputs.optionsJsonSchema.additionalProperties !== false
+      ) {
+        program.allowUnknownOption()
+        program.allowExcessArguments()
+        command.allowUnknownOption()
+        command.allowExcessArguments()
+      }
+
+      Object.entries(flagJsonSchemaProperties).forEach(addOptionForProperty)
 
       const invalidFlagAliases = Object.entries(unusedFlagAliases).map(([flag, alias]) => `${flag}: ${alias}`)
       if (invalidFlagAliases.length) {
@@ -368,6 +383,7 @@ export function createCli<R extends AnyRouter>({router, ...params}: TrpcCliParam
         program.__ran ||= []
         program.__ran.push(command)
         const options = command.opts()
+        // console.dir({options, args}, {depth: null})
 
         if (args.at(-2) !== options) {
           // This is a code bug and not recoverable. Will hopefully never happen but if commander totally changes their API this will break

src/parse-procedure.ts

@@ -72,6 +72,10 @@ export function parseProcedureInputs(inputs: unknown[]): Result<ParsedProcedure>
 }
 
 function handleMergedSchema(mergedSchema: JSONSchema7): Result<ParsedProcedure> {
+  if (mergedSchema.additionalProperties) {
+    return {success: false, error: `Inputs with additional properties are not currently supported`}
+  }
+
   if (mergedSchema.type === 'string') {
     return {
       success: true,

test/zod-inputs.test.ts

@@ -437,6 +437,32 @@ test('mixed array input', async () => {
   expect(result).toMatchInlineSnapshot(`"list: [12,true,3.14,"null","undefined","hello"]"`)
 })
 
+test('record input', async () => {
+  const router = t.router({
+    test: t.procedure
+      .input(z.record(z.number()).optional()) //
+      .query(({input}) => `input: ${JSON.stringify(input)}`),
+  })
+
+  expect(await run(router, ['test', '--help'])).toMatchInlineSnapshot(`
+    "Usage: program test [options]
+
+    Options:
+      --input [json]  Input formatted as JSON (procedure's schema couldn't be
+                      converted to CLI arguments: Inputs with additional properties
+                      are not currently supported)
+      -h, --help      display help for command
+    "
+  `)
+  expect(await run(router, ['test'])).toMatchInlineSnapshot(`"input: undefined"`)
+  expect(await run(router, ['test', '--input', '{"foo": 1}'])).toMatchInlineSnapshot(`"input: {"foo":1}"`)
+  await expect(run(router, ['test', '--input', '{"foo": "x"}'])).rejects.toMatchInlineSnapshot(`
+    CLI exited with code 1
+      Caused by: CliValidationError: Validation error
+      - Expected number, received string at "--foo"
+  `)
+})
+
 test("nullable array inputs aren't supported", async () => {
   const router = t.router({
     test1: t.procedure.input(z.array(z.string().nullable())).query(({input}) => `list: ${JSON.stringify(input)}`),