@carthooks/arcubase-cli 0.1.19 → 0.1.20

package/src/generated/help_examples.generated.ts

@@ -0,0 +1,289 @@
+// Generated by scripts/generate-help-examples.mjs. Do not edit by hand.
+
+export type GeneratedHelpExample = {
+  title: string
+  body?: unknown
+  notes?: readonly string[]
+}
+
+export const helpExamplesIndex = {
+  "admin.access-rule.assign-users": {
+    "command": [
+      "access-rule",
+      "assign-users"
+    ],
+    "examples": [
+      {
+        "title": "replace user_scope with user, department, and actor scopes",
+        "body": {
+          "update": [
+            "user_scope"
+          ],
+          "options": {
+            "user_scope": [
+              {
+                "type": "user",
+                "id": 2188889901
+              },
+              {
+                "type": "department",
+                "id": 2188881201
+              },
+              {
+                "type": "actor",
+                "id": 2188883301
+              }
+            ]
+          }
+        },
+        "notes": [
+          "id must be numeric arcubaseUserId, department ID, or actor ID",
+          "assign-users updates user_scope only and preserves the existing policy"
+        ]
+      }
+    ]
+  },
+  "admin.access-rule.create": {
+    "command": [
+      "access-rule",
+      "create"
+    ],
+    "examples": [
+      {
+        "title": "full access for a specific arcubaseUserId",
+        "body": {
+          "name": "Admin full access",
+          "enabled": true,
+          "type": "form",
+          "options": {
+            "user_scope": [
+              {
+                "type": "user",
+                "id": 2188889977
+              }
+            ],
+            "policy": {
+              "key": "custom",
+              "actions": [
+                "view",
+                "add",
+                "edit",
+                "delete"
+              ],
+              "all_fields_read": true,
+              "all_fields_write": true
+            },
+            "list_options": {}
+          }
+        }
+      },
+      {
+        "title": "department can view/add/edit only rows created by themselves",
+        "body": {
+          "name": "Sales own rows",
+          "enabled": true,
+          "type": "form",
+          "options": {
+            "user_scope": [
+              {
+                "type": "department",
+                "id": 2188881201
+              }
+            ],
+            "policy": {
+              "key": "custom",
+              "actions": [
+                "view",
+                "add",
+                "edit"
+              ],
+              "all_fields_read": true,
+              "all_fields_write": true,
+              "condition": {
+                "mode": "and",
+                "conditions": [
+                  {
+                    "column": "creator",
+                    "operator": "$eq",
+                    "value": "[[current_user]]",
+                    "value_from": 0,
+                    "value_relation": ""
+                  }
+                ]
+              }
+            },
+            "list_options": {}
+          }
+        },
+        "notes": [
+          "department scope includes child departments",
+          "row-owner isolation uses [[current_user]] on creator"
+        ]
+      },
+      {
+        "title": "role actor can view rows matching a complex AND/OR condition",
+        "body": {
+          "name": "Sales manager review queue",
+          "enabled": true,
+          "type": "form",
+          "options": {
+            "user_scope": [
+              {
+                "type": "actor",
+                "id": 2188883301
+              }
+            ],
+            "policy": {
+              "key": "custom",
+              "actions": [
+                "view",
+                "edit"
+              ],
+              "all_fields_read": true,
+              "all_fields_write": true,
+              "condition": {
+                "mode": "and",
+                "conditions": [
+                  {
+                    "column": ":1004",
+                    "operator": "$eq",
+                    "value": "pending",
+                    "value_from": 0,
+                    "value_relation": ""
+                  },
+                  {
+                    "column": "",
+                    "operator": "",
+                    "value": null,
+                    "value_from": 0,
+                    "value_relation": "",
+                    "subset": {
+                      "mode": "or",
+                      "conditions": [
+                        {
+                          "column": "creator",
+                          "operator": "$eq",
+                          "value": "[[current_user]]",
+                          "value_from": 0,
+                          "value_relation": ""
+                        },
+                        {
+                          "column": ":1005",
+                          "operator": "$eq",
+                          "value": "high",
+                          "value_from": 0,
+                          "value_relation": ""
+                        }
+                      ]
+                    }
+                  }
+                ]
+              }
+            },
+            "list_options": {}
+          }
+        },
+        "notes": [
+          "actor means Arcubase role id",
+          "condition mode \"and\" and \"or\" are canonical; legacy \"all\" also reads as AND",
+          "nested OR uses subset and leaves the wrapper column/operator empty"
+        ]
+      }
+    ]
+  },
+  "user.row.bulk-update": {
+    "command": [
+      "row",
+      "bulk-update"
+    ],
+    "examples": [
+      {
+        "title": "bulk update explicit row ids",
+        "body": {
+          "selection": {
+            "type": "ids",
+            "ids": [
+              2188890411,
+              2188890412
+            ],
+            "length": 2
+          },
+          "fields": [
+            {
+              "id": 1003,
+              "action": {
+                "type": "set",
+                "value": 2
+              }
+            }
+          ]
+        }
+      },
+      {
+        "title": "bulk update rows selected by a search condition",
+        "body": {
+          "selection": {
+            "type": "condition",
+            "condition": {
+              "selectAll": true,
+              "q": "SO-1001"
+            },
+            "length": 0
+          },
+          "fields": [
+            {
+              "id": 1003,
+              "action": {
+                "type": "set",
+                "value": 2
+              }
+            }
+          ]
+        },
+        "notes": [
+          "condition selection uses row-query style keys such as q, tab, and filter_:1002"
+        ]
+      }
+    ]
+  },
+  "user.row.selection-action": {
+    "command": [
+      "row",
+      "selection-action"
+    ],
+    "examples": [
+      {
+        "title": "run a custom action against explicit row ids",
+        "body": {
+          "selection": {
+            "type": "ids",
+            "ids": [
+              2188890411
+            ],
+            "length": 1
+          }
+        },
+        "notes": [
+          "pass the backend action code with --action",
+          "for query action, use ids or all selection instead of condition selection"
+        ]
+      },
+      {
+        "title": "run a custom action against a filtered selection",
+        "body": {
+          "selection": {
+            "type": "condition",
+            "condition": {
+              "selectAll": true,
+              "q": "SO-1001"
+            },
+            "length": 0
+          }
+        },
+        "notes": [
+          "condition selection uses row-query style keys such as q, tab, and filter_:1002"
+        ]
+      }
+    ]
+  }
+} as const satisfies Record<string, { command: readonly string[]; examples: readonly GeneratedHelpExample[] }>

package/src/runtime/execute.ts

@@ -10,6 +10,7 @@ import { getBodySchema, getCommandDocHints, getDocHints, getTypeHints, getUnsupp
 import { resolveArcubaseSDKPath } from './paths.js'
 import { compileCSVImportMapping, compileExcelImportMapping, type CompiledEntityImportConfig } from './entity_import_mapping.js'
 import { uploadLocalFileWithToken } from './local_upload.js'
+import { renderCommandHelpExamples } from './help_examples.js'
 
 export type CommandExecutionSummary = {
   scope: CommandScope
@@ -64,12 +65,39 @@ function buildUnknownCommandDetails(scope: CommandScope, moduleName: string, com
   return suggestions.length > 0 ? { suggestions } : undefined
 }
 
+function throwHelpExamplesRequiresCommand(scope: CommandScope, moduleName?: string): never {
+  const binary = binaryForScope(scope)
+  const suggestions = scope === 'admin'
+    ? [
+        `${binary} access-rule create --help-examples`,
+        `${binary} access-rule assign-users --help-examples`,
+      ]
+    : [
+        `${binary} row bulk-update --help-examples`,
+        `${binary} row selection-action --help-examples`,
+      ]
+  throw new CLIError(
+    'HELP_EXAMPLES_REQUIRES_COMMAND',
+    '--help-examples must follow a final command',
+    2,
+    {
+      operation: moduleName ? `${binary} ${moduleName} --help-examples` : `${binary} --help-examples`,
+      hint: `retry with a final command, for example: ${suggestions[0]}`,
+      suggestions,
+    },
+  )
+}
+
 type EnvInput = Record<string, string | undefined>
 
 function sdkPath(file: string, env: EnvInput = process.env): string {
   return resolveArcubaseSDKPath(file, env)
 }
 
+function binaryForScope(scope: CommandScope): string {
+  return scope === 'admin' ? 'arcubase-admin' : 'arcubase'
+}
+
 export function renderCommandHelp(scope: CommandScope, moduleName: string, commandName?: string, env: EnvInput = process.env): string {
   const command = findCommand(scope, moduleName, commandName)
   if (!command) {
@@ -92,6 +120,7 @@ export function renderCommandHelp(scope: CommandScope, moduleName: string, comma
     command.requestType ? `body: ${bodyTypeText} via --body-json <json-string> | --body-file <file>.json` : 'body: none',
     queryFlags.length ? `query flags: ${queryFlags.join(', ')}, --query-file` : 'query flags: --query-file',
     pathFlags.length ? `path flags: ${pathFlags.join(', ')}` : 'path flags: none',
+    `copyable examples: ${scope === 'admin' ? 'arcubase-admin' : 'arcubase'} ${command.commandPath.join(' ')} --help-examples`,
     ...(isTableCreate
       ? [
           'body-json example:',
@@ -248,7 +277,7 @@ function buildScalarQuery(command: ReturnType<typeof findCommand>, flags: Record
 }
 
 function validateKnownFlags(command: NonNullable<ReturnType<typeof findCommand>>, flags: Record<string, string | boolean>, env: EnvInput = process.env) {
-  const allowed = new Set<string>(['help', 'body-file', 'body-json', 'query-file'])
+  const allowed = new Set<string>(['help', 'help-examples', 'body-file', 'body-json', 'query-file'])
   for (const mapping of command.pathParams) {
     if (!getFixedValue(mapping)) {
       allowed.add(mapping.flag)
@@ -1051,6 +1080,38 @@ function validateAccessRuleUserScope(
   }
 }
 
+function normalizeNumericAccessRuleUserScopeIDs(
+  scope: CommandScope,
+  command: NonNullable<ReturnType<typeof findCommand>>,
+  body: unknown,
+): unknown {
+  if (!isAccessRuleCommand(scope, command) || !isRecord(body) || !isRecord(body.options) || !Array.isArray(body.options.user_scope)) {
+    return body
+  }
+
+  let changed = false
+  const userScope = body.options.user_scope.map((item) => {
+    if (!isRecord(item) || typeof item.id !== 'string' || !/^\d+$/.test(item.id)) {
+      return item
+    }
+    const id = Number(item.id)
+    if (!Number.isFinite(id) || !Number.isInteger(id)) {
+      return item
+    }
+    changed = true
+    return { ...item, id }
+  })
+
+  if (!changed) return body
+  return {
+    ...body,
+    options: {
+      ...body.options,
+      user_scope: userScope,
+    },
+  }
+}
+
 function requireUpdateContains(
   scope: CommandScope,
   command: NonNullable<ReturnType<typeof findCommand>>,
@@ -2005,16 +2066,32 @@ export async function executeCLI(scope: CommandScope, argv: string[], env?: Runt
   const parsed = parseCLIArgs(argv)
   const envInput = env ?? process.env
   if (parsed.commandTokens.length === 0) {
+    if (hasFlag(parsed.flags, 'help-examples')) {
+      throwHelpExamplesRequiresCommand(scope)
+    }
     return { kind: 'help', text: renderRootHelp(scope) }
   }
   const [moduleName, commandName] = parsed.commandTokens
   if (!moduleName) {
+    if (hasFlag(parsed.flags, 'help-examples')) {
+      throwHelpExamplesRequiresCommand(scope)
+    }
     return { kind: 'help', text: renderRootHelp(scope) }
   }
   const singleTokenCommand = !commandName ? findCommand(scope, moduleName) : null
   if (!commandName && !singleTokenCommand) {
+    if (hasFlag(parsed.flags, 'help-examples')) {
+      throwHelpExamplesRequiresCommand(scope, moduleName)
+    }
     return { kind: 'help', text: renderModuleHelp(scope, moduleName, envInput) }
   }
+  if (hasFlag(parsed.flags, 'help-examples')) {
+    const command = commandName ? findCommand(scope, moduleName, commandName) : singleTokenCommand
+    if (!command) {
+      throw new CLIError('UNKNOWN_COMMAND', `unknown command: ${moduleName}${commandName ? ` ${commandName}` : ''}`, 2, buildUnknownCommandDetails(scope, moduleName, commandName ?? ''))
+    }
+    return { kind: 'help', text: renderCommandHelpExamples(scope, command) }
+  }
   if (hasFlag(parsed.flags, 'help')) {
     return { kind: 'help', text: renderCommandHelp(scope, moduleName, commandName, envInput) }
   }
@@ -2065,6 +2142,7 @@ export async function executeCLI(scope: CommandScope, argv: string[], env?: Runt
     if (body === undefined) {
       throw new CLIError('MISSING_BODY_FILE', `command requires --body-json or --body-file for ${command.requestType}; prefer --body-json to avoid file creation`, 2)
     }
+    body = normalizeNumericAccessRuleUserScopeIDs(scope, command, body)
     if (isTableCreateCommand(scope, command)) {
       requireTableCreateSchemaBody(scope, command, body, runtimeEnv)
       validateActionSpecificRawBody(scope, command, body, runtimeEnv)

package/src/runtime/help_examples.ts

@@ -0,0 +1,61 @@
+import { helpExamplesIndex } from '../generated/help_examples.generated.js'
+import type { CommandDef, CommandScope } from './command_registry.js'
+
+type HelpExample = {
+  title: string
+  body?: unknown
+  notes?: readonly string[]
+}
+
+function binaryForScope(scope: CommandScope): string {
+  return scope === 'admin' ? 'arcubase-admin' : 'arcubase'
+}
+
+function getFixedValue(value: object): string | undefined {
+  if (!('fixedValue' in value)) {
+    return undefined
+  }
+  const fixedValue = (value as { fixedValue?: unknown }).fixedValue
+  return typeof fixedValue === 'string' ? fixedValue : undefined
+}
+
+function pathFlagPlaceholders(command: CommandDef): string {
+  const parts = command.pathParams
+    .filter((item) => !getFixedValue(item))
+    .map((item) => `--${item.flag} <${item.flag.replace(/-/g, '_')}>`)
+  return parts.length > 0 ? `${parts.join(' ')} ` : ''
+}
+
+function helpExampleKey(scope: CommandScope, command: CommandDef): string {
+  return `${scope}.${command.commandPath.join('.')}`
+}
+
+export function getCommandHelpExamples(scope: CommandScope, command: CommandDef): readonly HelpExample[] {
+  return (helpExamplesIndex as Record<string, { examples?: readonly HelpExample[] } | undefined>)[helpExampleKey(scope, command)]?.examples ?? []
+}
+
+export function renderCommandHelpExamples(scope: CommandScope, command: CommandDef): string {
+  const binary = binaryForScope(scope)
+  const examples = getCommandHelpExamples(scope, command)
+  const header = `${binary} ${command.commandPath.join(' ')} --help-examples`
+  if (examples.length === 0) {
+    return [
+      header,
+      '',
+      'No dedicated examples for this final command yet.',
+      `Use ${binary} ${command.commandPath.join(' ')} --help for flags, docs, and type paths.`,
+    ].join('\n')
+  }
+  return [
+    header,
+    '',
+    ...examples.flatMap((example) => [
+      `${example.title}:`,
+      ...(example.body === undefined
+        ? []
+        : [`  ${binary} ${command.commandPath.join(' ')} ${pathFlagPlaceholders(command)}--body-json '${JSON.stringify(example.body)}'`.replace(/\s+/g, ' ').trim()]),
+      ...(example.notes ?? []).map((note) => `  - ${note}`),
+      '',
+    ]),
+  ].join('\n').trimEnd()
+}

package/src/tests/execute_validation.test.ts

@@ -1344,6 +1344,33 @@ test('access-rule assign-users rejects non-numeric user scope id', async () => {
   }, (error: unknown) => assertAssignUsersGuidance(error, /numeric arcubaseUserId, department ID, or actor ID/))
 })
 
+test('access-rule create normalizes numeric string user_scope ids before validation and request', async () => {
+  const out = await executeCLI(
+    'admin',
+    ['access-rule', 'create', '--app-id', 'app_1', '--table-id', 'table_1', '--body-json', '{"name":"Role read","enabled":true,"type":"form","options":{"user_scope":[{"type":"actor","id":"2188883301"}],"policy":{"key":"custom","actions":["view"],"all_fields_read":true,"all_fields_write":false},"list_options":{}}}'],
+    env as any,
+    async (_url, init) => new Response(String(init?.body ?? '{}'), { status: 200 }),
+  )
+  assert.equal(out.kind, 'result')
+  assert.deepEqual(out.data.options.user_scope, [{ type: 'actor', id: 2188883301 }])
+})
+
+test('access-rule assign-users normalizes numeric string user_scope ids before validation and request', async () => {
+  const out = await executeCLI(
+    'admin',
+    ['access-rule', 'assign-users', '--app-id', 'app_1', '--table-id', 'table_1', '--rule-id', 'rule_1', '--body-json', '{"update":["user_scope"],"options":{"user_scope":[{"type":"user","id":"2188889901"},{"type":"department","id":"2188881201"},{"type":"actor","id":"2188883301"}]}}'],
+    env as any,
+    async (_url, init) => new Response(String(init?.body ?? '{}'), { status: 200 }),
+  )
+  assert.equal(out.kind, 'result')
+  assert.deepEqual(out.data.update, ['user_scope'])
+  assert.deepEqual(out.data.options.user_scope, [
+    { type: 'user', id: 2188889901 },
+    { type: 'department', id: 2188881201 },
+    { type: 'actor', id: 2188883301 },
+  ])
+})
+
 test('access-rule assign-users accepts canonical mixed user_scope body', async () => {
   const out = await executeCLI(
     'admin',

package/src/tests/help.test.ts

@@ -130,6 +130,38 @@ test('admin access-rule help gives update whitelist and assign-users body-json e
   assert.doesNotMatch(assign.text, /"allowedUsers"/)
 })
 
+test('help-examples requires a final command', async () => {
+  await assert.rejects(
+    () => executeCLI('admin', ['--help-examples'], env as any, async () => new Response('{}')),
+    { code: 'HELP_EXAMPLES_REQUIRES_COMMAND' },
+  )
+  await assert.rejects(
+    () => executeCLI('admin', ['access-rule', '--help-examples'], env as any, async () => new Response('{}')),
+    { code: 'HELP_EXAMPLES_REQUIRES_COMMAND' },
+  )
+})
+
+test('admin access-rule create help-examples show canonical ingress scopes and conditions', async () => {
+  const out = await executeCLI('admin', ['access-rule', 'create', '--help-examples'], env as any, async () => new Response('{}'))
+  assert.equal(out.kind, 'help')
+  assert.match(out.text, /arcubase-admin access-rule create --help-examples/)
+  assert.match(out.text, /"type":"department"/)
+  assert.match(out.text, /"type":"actor"/)
+  assert.match(out.text, /"column":"creator","operator":"\$eq","value":"\[\[current_user\]\]"/)
+  assert.match(out.text, /"subset":\{"mode":"or"/)
+  assert.doesNotMatch(out.text, forbiddenArcubaseUserTerms())
+  assert.doesNotMatch(out.text, /"type":"member"/)
+})
+
+test('user row bulk-update help-examples show ids and condition selection bodies', async () => {
+  const out = await executeCLI('user', ['row', 'bulk-update', '--help-examples'], env as any, async () => new Response('{}'))
+  assert.equal(out.kind, 'help')
+  assert.match(out.text, /arcubase row bulk-update --help-examples/)
+  assert.match(out.text, /"selection":\{"type":"ids"/)
+  assert.match(out.text, /"selection":\{"type":"condition"/)
+  assert.match(out.text, /"action":\{"type":"set"/)
+})
+
 test('admin assign-users help uses arcubaseUserId terminology', async () => {
   const help = await executeCLI('admin', ['access-rule', 'assign-users', '--help'], env as any, async () => new Response('{}'))
   assert.equal(help.kind, 'help')