@nocobase/cli 2.1.0-beta.23 → 2.1.0-beta.25

package/dist/lib/db-connection-check.js

@@ -0,0 +1,178 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { translateCli } from "./cli-locale.js";
+import { validateTcpPort } from "./prompt-validators.js";
+const DB_CONNECTION_TIMEOUT_MS = 5_000;
+const externalDbValidationCache = new Map();
+function trimPromptValue(value) {
+    return String(value ?? '').trim();
+}
+export function readExternalDbConnectionConfig(values) {
+    const builtinDb = values.builtinDb === undefined ? true : Boolean(values.builtinDb);
+    if (builtinDb) {
+        return undefined;
+    }
+    const dialect = trimPromptValue(values.dbDialect || 'postgres');
+    if (dialect !== 'postgres' && dialect !== 'kingbase' && dialect !== 'mysql' && dialect !== 'mariadb') {
+        return undefined;
+    }
+    const host = trimPromptValue(values.dbHost);
+    const portText = trimPromptValue(values.dbPort);
+    const database = trimPromptValue(values.dbDatabase);
+    const user = trimPromptValue(values.dbUser);
+    const password = String(values.dbPassword ?? '');
+    if (!host || !portText || !database || !user || !password) {
+        return undefined;
+    }
+    if (validateTcpPort(portText)) {
+        return undefined;
+    }
+    return {
+        dialect,
+        host,
+        port: Number.parseInt(portText, 10),
+        database,
+        user,
+        password,
+    };
+}
+export function formatDbCheckAddress(config) {
+    return `${config.host}:${config.port}/${config.database}`;
+}
+function buildValidationCacheKey(config) {
+    return JSON.stringify(config);
+}
+function formatDbConnectionError(config, error) {
+    const maybeError = error;
+    const code = String(maybeError?.code ?? '').trim().toUpperCase();
+    const errno = typeof maybeError?.errno === 'number' ? maybeError.errno : undefined;
+    const rawMessage = String(maybeError?.message || maybeError?.sqlMessage || error || '').trim();
+    if (code === 'ECONNREFUSED' || code === 'ENOTFOUND' || code === 'EHOSTUNREACH' || code === 'ECONNRESET') {
+        return translateCli('validators.dbConnection.unreachable', {
+            host: config.host,
+            port: config.port,
+            details: rawMessage,
+        });
+    }
+    if (code === 'ETIMEDOUT') {
+        return translateCli('validators.dbConnection.timeout', {
+            host: config.host,
+            port: config.port,
+            seconds: Math.ceil(DB_CONNECTION_TIMEOUT_MS / 1000),
+        });
+    }
+    if (code === '28P01' || code === '28000' || code === 'ER_ACCESS_DENIED_ERROR' || errno === 1045) {
+        return translateCli('validators.dbConnection.authenticationFailed', {
+            user: config.user,
+            database: config.database,
+        });
+    }
+    if (code === '3D000' || code === 'ER_BAD_DB_ERROR' || errno === 1049) {
+        return translateCli('validators.dbConnection.databaseNotFound', {
+            database: config.database,
+        });
+    }
+    return translateCli('validators.dbConnection.connectionFailed', {
+        details: rawMessage || code || String(error),
+    });
+}
+async function checkPostgresFamilyConnection(config) {
+    const { default: pg } = await import('pg');
+    const client = new pg.Client({
+        host: config.host,
+        port: config.port,
+        user: config.user,
+        password: config.password,
+        database: config.database,
+        connectionTimeoutMillis: DB_CONNECTION_TIMEOUT_MS,
+    });
+    try {
+        await client.connect();
+        await client.query('SELECT 1');
+    }
+    finally {
+        await Promise.resolve(client.end()).catch(() => undefined);
+    }
+}
+async function checkMysqlConnection(config) {
+    const { default: mysql } = await import('mysql2/promise');
+    const connection = await mysql.createConnection({
+        host: config.host,
+        port: config.port,
+        user: config.user,
+        password: config.password,
+        database: config.database,
+        connectTimeout: DB_CONNECTION_TIMEOUT_MS,
+    });
+    try {
+        await connection.query('SELECT 1');
+    }
+    finally {
+        await Promise.resolve(connection.end()).catch(() => undefined);
+    }
+}
+async function checkMariaDbConnection(config) {
+    const { default: mariadb } = await import('mariadb');
+    const connection = await mariadb.createConnection({
+        host: config.host,
+        port: config.port,
+        user: config.user,
+        password: config.password,
+        database: config.database,
+        connectTimeout: DB_CONNECTION_TIMEOUT_MS,
+    });
+    try {
+        await connection.query('SELECT 1');
+    }
+    finally {
+        await Promise.resolve(connection.end()).catch(() => undefined);
+    }
+}
+async function performExternalDbConnectionCheck(config) {
+    try {
+        switch (config.dialect) {
+            case 'postgres':
+            case 'kingbase': {
+                await checkPostgresFamilyConnection(config);
+                return undefined;
+            }
+            case 'mysql': {
+                await checkMysqlConnection(config);
+                return undefined;
+            }
+            case 'mariadb': {
+                await checkMariaDbConnection(config);
+                return undefined;
+            }
+        }
+    }
+    catch (error) {
+        return formatDbConnectionError(config, error);
+    }
+}
+export async function checkExternalDbConnection(config) {
+    const cacheKey = buildValidationCacheKey(config);
+    const cached = externalDbValidationCache.get(cacheKey);
+    if (cached) {
+        return await cached;
+    }
+    const pending = performExternalDbConnectionCheck(config);
+    externalDbValidationCache.set(cacheKey, pending);
+    return await pending;
+}
+export async function validateExternalDbConfig(values) {
+    const config = readExternalDbConnectionConfig(values);
+    if (!config) {
+        return undefined;
+    }
+    return await checkExternalDbConnection(config);
+}
+export function clearExternalDbValidationCache() {
+    externalDbValidationCache.clear();
+}

package/dist/lib/env-config.js

@@ -71,6 +71,13 @@ export function buildStoredEnvConfig(input) {
     if (input.builtinDb === false) {
         envConfig.builtinDbImage = undefined;
     }
+    if (input.builtinDb === true) {
+        delete envConfig.dbHost;
+        const source = trimConfigValue(input.source);
+        if (source === 'docker') {
+            delete envConfig.dbPort;
+        }
+    }
     const authType = trimConfigValue(input.authType);
     const accessToken = trimConfigValue(input.accessToken);
     if (authType === 'token' && accessToken) {

package/dist/lib/generated-command.js

@@ -1,3 +1,11 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
 /**
  * This file is part of the NocoBase (R) project.
  * Copyright (c) 2020-2024 NocoBase Co., Ltd.
@@ -12,7 +20,10 @@ import { applyPostProcessor } from './post-processors.js';
 import { registerPostProcessors } from '../post-processors/index.js';
 function buildParameterFlag(parameter, options) {
     const hints = [parameter.in];
-    if (parameter.type === 'object' || parameter.type === 'array' || parameter.jsonEncoded) {
+    if (parameter.isFile) {
+        hints.push('file path');
+    }
+    else if (parameter.type === 'object' || parameter.type === 'array' || parameter.jsonEncoded) {
         hints.push('JSON');
     }
     else if (parameter.isArray) {
@@ -42,6 +53,7 @@ function buildParameterFlag(parameter, options) {
     if (parameter.type === 'boolean') {
         return Flags.boolean({
             description,
+            allowNo: true,
             ...(helpGroup ? { helpGroup } : {}),
             ...(required ? { required: true } : {}),
         });
@@ -67,10 +79,10 @@ export function createGeneratedFlags(operation) {
             // Body flags are an alternative authoring path to --body/--body-file.
             // Enforce required body semantics later in parseBody(), after we know
             // which input mode the user chose.
-            required: parameter.in === 'body' ? false : parameter.required,
+            required: parameter.in === 'body' && !parameter.isFile ? false : parameter.required,
         });
     }
-    if (operation.hasBody) {
+    if (operation.hasBody && operation.requestContentType !== 'multipart/form-data') {
         flags.body = Flags.string({
             description: 'Full JSON request body string. Do not combine with body field flags.',
             helpGroup: 'Raw JSON Body',
@@ -82,6 +94,13 @@ export function createGeneratedFlags(operation) {
             exclusive: ['body'],
         });
     }
+    if (operation.responseType === 'binary') {
+        flags.output = Flags.string({
+            description: 'Path where the downloaded response should be written.',
+            helpGroup: 'Output',
+            required: true,
+        });
+    }
     flags['api-base-url'] = Flags.string({
         description: 'NocoBase API base URL, for example http://localhost:13000/api',
         helpGroup: 'Global',
@@ -132,6 +151,8 @@ export class GeneratedApiCommand extends Command {
                 parameters: ctor.operation.parameters,
                 hasBody: ctor.operation.hasBody,
                 bodyRequired: ctor.operation.bodyRequired,
+                requestContentType: ctor.operation.requestContentType,
+                responseType: ctor.operation.responseType,
             },
         });
         if (!response.ok) {

package/dist/lib/plugin-storage.js

@@ -0,0 +1,127 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import path from 'node:path';
+import { access, lstat, mkdir, readdir, readlink, realpath, rm, stat, symlink } from 'node:fs/promises';
+async function pathExists(target) {
+    try {
+        await access(target);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+export function resolvePluginStoragePath(storagePath) {
+    const root = String(storagePath ?? process.env.STORAGE_PATH ?? '').trim();
+    if (root) {
+        return path.join(path.isAbsolute(root) ? root : path.resolve(process.cwd(), root), 'plugins');
+    }
+    const configured = String(process.env.PLUGIN_STORAGE_PATH ?? '').trim();
+    if (configured) {
+        return path.isAbsolute(configured) ? configured : path.resolve(process.cwd(), configured);
+    }
+    return path.resolve(process.cwd(), 'storage', 'plugins');
+}
+async function getStoragePluginNames(target) {
+    const plugins = [];
+    const items = await readdir(target);
+    for (const item of items) {
+        const itemPath = path.resolve(target, item);
+        if (item.startsWith('@')) {
+            const statResult = await stat(itemPath);
+            if (!statResult.isDirectory()) {
+                continue;
+            }
+            const children = await getStoragePluginNames(itemPath);
+            plugins.push(...children.map((child) => `${item}/${child}`));
+            continue;
+        }
+        if (await pathExists(path.resolve(itemPath, 'package.json'))) {
+            plugins.push(item);
+        }
+    }
+    return plugins;
+}
+async function ensureOrgDirectory(nodeModulesPath, pluginName) {
+    if (!pluginName.startsWith('@')) {
+        return;
+    }
+    const [orgName] = pluginName.split('/');
+    await mkdir(path.resolve(nodeModulesPath, orgName), { recursive: true });
+}
+async function isSymlinkValid(linkPath, targetPath) {
+    try {
+        if (await pathExists(linkPath)) {
+            const realPath = await realpath(linkPath);
+            return realPath === targetPath;
+        }
+    }
+    catch {
+        return false;
+    }
+    return false;
+}
+async function createStoragePluginSymlink(storagePluginsPath, nodeModulesPath, pluginName) {
+    const targetPath = path.resolve(storagePluginsPath, pluginName);
+    if (!(await pathExists(targetPath))) {
+        return;
+    }
+    await ensureOrgDirectory(nodeModulesPath, pluginName);
+    const linkPath = path.resolve(nodeModulesPath, pluginName);
+    if (await isSymlinkValid(linkPath, targetPath)) {
+        return;
+    }
+    await rm(linkPath, { recursive: true, force: true });
+    await symlink(targetPath, linkPath, 'dir');
+}
+export async function createStoragePluginsSymlink(storagePath, nodeModulesPath = String(process.env.NODE_MODULES_PATH ?? '').trim()) {
+    if (!nodeModulesPath) {
+        return;
+    }
+    const storagePluginsPath = resolvePluginStoragePath(storagePath);
+    if (!(await pathExists(storagePluginsPath))) {
+        return;
+    }
+    const pluginNames = await getStoragePluginNames(storagePluginsPath);
+    await Promise.all(pluginNames.map(async (pluginName) => await createStoragePluginSymlink(storagePluginsPath, nodeModulesPath, pluginName)));
+}
+export async function removeStoragePluginSymlink(pluginName, storagePath, nodeModulesPath = String(process.env.NODE_MODULES_PATH ?? '').trim()) {
+    if (!nodeModulesPath) {
+        return false;
+    }
+    const storagePluginsPath = resolvePluginStoragePath(storagePath);
+    const targetPath = path.resolve(storagePluginsPath, pluginName);
+    const linkPath = path.resolve(nodeModulesPath, pluginName);
+    if (!(await pathExists(linkPath))) {
+        return false;
+    }
+    let statResult;
+    try {
+        statResult = await lstat(linkPath);
+    }
+    catch {
+        return false;
+    }
+    if (!statResult.isSymbolicLink()) {
+        return false;
+    }
+    let resolvedLinkTarget = '';
+    try {
+        const linkTarget = await readlink(linkPath);
+        resolvedLinkTarget = path.resolve(path.dirname(linkPath), linkTarget);
+    }
+    catch {
+        return false;
+    }
+    if (resolvedLinkTarget !== targetPath) {
+        return false;
+    }
+    await rm(linkPath, { recursive: true, force: true });
+    return true;
+}

package/dist/lib/prompt-validators.js

@@ -173,13 +173,13 @@ export async function validateAvailableTcpPort(value) {
         return formatError;
     }
     const port = parseTcpPort(raw);
-    const available = await canListenOnTcpPort(port);
-    if (!available) {
-        return translateCli('validators.tcpPort.alreadyInUse', { port });
-    }
     const dockerPorts = await getDockerPublishedTcpPorts();
     if (dockerPorts.has(port)) {
         return translateCli('validators.tcpPort.alreadyInUseByDocker', { port });
     }
+    const available = await canListenOnTcpPort(port);
+    if (!available) {
+        return translateCli('validators.tcpPort.alreadyInUse', { port });
+    }
     return undefined;
 }

package/dist/lib/run-npm.js

@@ -15,6 +15,8 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import fs from 'node:fs';
+import fsp from 'node:fs/promises';
+import os from 'node:os';
 import path from 'node:path';
 import spawn from 'cross-spawn';
 const FORWARDED_SIGNALS = ['SIGINT', 'SIGTERM'];
@@ -178,6 +180,57 @@ export function commandOutput(name, args, options) {
         });
     });
 }
+async function readCommandOutputFile(filePath) {
+    try {
+        return await fsp.readFile(filePath, 'utf8');
+    }
+    catch {
+        return '';
+    }
+}
+export async function commandOutputViaFile(name, args, options) {
+    const cwd = resolveCwd(options?.cwd);
+    const label = options?.errorName ?? name;
+    const command = resolveCommandName(name);
+    const captureDir = await fsp.mkdtemp(path.join(os.tmpdir(), 'nocobase-cli-output-'));
+    const stdoutPath = path.join(captureDir, 'stdout.log');
+    const stderrPath = path.join(captureDir, 'stderr.log');
+    const stdoutHandle = await fsp.open(stdoutPath, 'w');
+    const stderrHandle = await fsp.open(stderrPath, 'w');
+    try {
+        const result = await new Promise((resolve, reject) => {
+            const child = spawn(command, [...args], {
+                cwd,
+                env: {
+                    ...process.env,
+                    ...options?.env,
+                },
+                stdio: ['ignore', stdoutHandle.fd, stderrHandle.fd],
+                windowsHide: process.platform === 'win32',
+            });
+            child.once('error', reject);
+            child.once('close', (code, signal) => {
+                resolve({ code, signal });
+            });
+        });
+        await stdoutHandle.close();
+        await stderrHandle.close();
+        const stdout = await readCommandOutputFile(stdoutPath);
+        const stderr = await readCommandOutputFile(stderrPath);
+        if (result.code === 0) {
+            return stdout.trim();
+        }
+        if (result.signal) {
+            throw new Error(`${label} exited due to signal ${result.signal}`);
+        }
+        const details = stderr.trim() || stdout.trim();
+        throw new Error(details ? `${label} exited with code ${result.code}: ${details}` : `${label} exited with code ${result.code}`);
+    }
+    finally {
+        await Promise.allSettled([stdoutHandle.close(), stderrHandle.close()]);
+        await fsp.rm(captureDir, { recursive: true, force: true });
+    }
+}
 /** Run `yarn` with the given argument list, inheriting stdio (errors label as `npm` for compatibility). */
 export function runNpm(args, options) {
     return run('yarn', [...args], { ...options, errorName: 'npm' });

package/dist/lib/runtime-env-vars.js

@@ -0,0 +1,32 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { resolveBuiltinDbConnection } from './builtin-db.js';
+function put(out, key, value) {
+    if (value === undefined || value === null) {
+        return;
+    }
+    out[key] = String(value);
+}
+export async function buildRuntimeEnvVars(runtime) {
+    const config = runtime.env.config ?? {};
+    const out = {
+        ...runtime.env.envVars,
+    };
+    if (runtime.kind !== 'local' && runtime.kind !== 'docker') {
+        return out;
+    }
+    if (!config.builtinDb) {
+        return out;
+    }
+    const connection = await resolveBuiltinDbConnection(runtime);
+    put(out, 'DB_DIALECT', connection.dbDialect);
+    put(out, 'DB_HOST', connection.dbHost);
+    put(out, 'DB_PORT', connection.dbPort);
+    return out;
+}

package/dist/lib/runtime-generator.js

@@ -1,3 +1,11 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
 /**
  * This file is part of the NocoBase (R) project.
  * Copyright (c) 2020-2024 NocoBase Co., Ltd.
@@ -60,12 +68,59 @@ function toGeneratedParameter(parameter, usedFlagNames) {
         required: parameter.required,
         description: parameter.description,
         type: inferParameterType(parameter.schema),
+        format: parameter.schema?.format,
         isArray: parameter.schema?.type === 'array',
+        isFile: parameter.schema?.type === 'string' && parameter.schema?.format === 'binary',
     };
 }
 function getJsonRequestSchema(requestBody) {
     return requestBody?.content?.['application/json']?.schema;
 }
+function getMultipartRequestSchema(requestBody) {
+    return requestBody?.content?.['multipart/form-data']?.schema;
+}
+function getRequestContentType(requestBody) {
+    if (!requestBody || '$ref' in requestBody) {
+        return undefined;
+    }
+    if (requestBody.content?.['multipart/form-data']) {
+        return 'multipart/form-data';
+    }
+    if (requestBody.content?.['application/json']) {
+        return 'application/json';
+    }
+    return undefined;
+}
+function getRequestSchema(requestBody) {
+    return getMultipartRequestSchema(requestBody) ?? getJsonRequestSchema(requestBody);
+}
+function isBinarySchema(schema) {
+    if (!schema || typeof schema !== 'object') {
+        return false;
+    }
+    if (schema.type === 'string' && schema.format === 'binary') {
+        return true;
+    }
+    return [...(schema.oneOf ?? []), ...(schema.anyOf ?? []), ...(schema.allOf ?? [])].some(isBinarySchema);
+}
+function getResponseType(operation) {
+    for (const response of Object.values(operation.responses ?? {})) {
+        const content = response?.content ?? {};
+        const mediaTypes = Object.keys(content);
+        const hasJson = mediaTypes.some((mediaType) => mediaType.includes('json'));
+        if (hasJson) {
+            return 'json';
+        }
+        const hasBinary = mediaTypes.some((mediaType) => {
+            const schema = content[mediaType]?.schema;
+            return mediaType === 'application/octet-stream' || mediaType.includes('zip') || isBinarySchema(schema);
+        });
+        if (hasBinary) {
+            return 'binary';
+        }
+    }
+    return undefined;
+}
 function normalizeCompositeSchema(schema) {
     if (!schema || typeof schema !== 'object') {
         return schema;
@@ -139,7 +194,7 @@ function describeSchemaShape(schema, options = {}) {
     return type;
 }
 function extractBodyParameters(requestBody, usedFlagNames) {
-    const schema = getJsonRequestSchema(requestBody);
+    const schema = getRequestSchema(requestBody);
     const properties = normalizeCompositeSchema(schema)?.properties;
     const required = new Set(normalizeCompositeSchema(schema)?.required ?? []);
     return Object.entries(properties ?? {}).map(([name, propertySchema]) => ({
@@ -149,7 +204,9 @@ function extractBodyParameters(requestBody, usedFlagNames) {
         required: required.has(name),
         description: propertySchema.description,
         type: inferParameterType(propertySchema),
+        format: propertySchema.format,
         isArray: propertySchema.type === 'array',
+        isFile: propertySchema.type === 'string' && propertySchema.format === 'binary',
         jsonEncoded: propertySchema.type === 'object' || propertySchema.type === 'array',
         jsonShape: describeSchemaShape(propertySchema),
     }));
@@ -179,6 +236,9 @@ function formatFlagExample(parameter) {
     if (parameter.type === 'boolean') {
         return `--${parameter.flagName}`;
     }
+    if (parameter.isFile) {
+        return `--${parameter.flagName} <path>`;
+    }
     if (parameter.type === 'object' || parameter.jsonEncoded) {
         if (parameter.type === 'array' || parameter.isArray) {
             return `--${parameter.flagName} '[]'`;
@@ -216,12 +276,13 @@ export function buildExamples(commandId, operation) {
     const requiredParameters = operation.parameters.filter((parameter) => parameter.required);
     const requiredFlags = requiredParameters.map(formatFlagExample);
     const requiredNonBodyFlags = requiredParameters.filter((parameter) => parameter.in !== 'body').map(formatFlagExample);
-    const examples = [`nb api ${commandId}${requiredFlags.length ? ` ${requiredFlags.join(' ')}` : ''}`];
+    const outputFlag = operation.responseType === 'binary' ? ' --output <path>' : '';
+    const examples = [`nb api ${commandId}${requiredFlags.length ? ` ${requiredFlags.join(' ')}` : ''}${outputFlag}`];
     const firstOptional = operation.parameters.find((parameter) => !parameter.required);
     if (firstOptional) {
-        examples.push(`${examples[0]} ${formatFlagExample(firstOptional)}`);
+        examples.push(`${examples[0]} ${formatFlagExample(firstOptional)}`.trim());
     }
-    if (operation.hasBody) {
+    if (operation.hasBody && operation.requestContentType !== 'multipart/form-data') {
         const prefix = `nb api ${commandId}${requiredNonBodyFlags.length ? ` ${requiredNonBodyFlags.join(' ')}` : ''}`;
         examples.push(`${prefix} --body '${buildSampleBody(operation.parameters)}'`);
     }
@@ -248,9 +309,17 @@ function buildDescription(operation) {
     }
     if (operation.hasBody) {
         const bodyFlags = operation.parameters.filter((parameter) => parameter.in === 'body').map((parameter) => `--${parameter.flagName}`);
-        sections.push(bodyFlags.length
-            ? `Request body: use body field flags (${bodyFlags.join(', ')}) or pass raw JSON via \`--body\` / \`--body-file\`.`
-            : 'Request body: JSON via `--body` or `--body-file`.');
+        if (operation.requestContentType === 'multipart/form-data') {
+            sections.push(bodyFlags.length ? `Request body: multipart form fields (${bodyFlags.join(', ')}).` : 'Request body: multipart form data.');
+        }
+        else {
+            sections.push(bodyFlags.length
+                ? `Request body: use body field flags (${bodyFlags.join(', ')}) or pass raw JSON via \`--body\` / \`--body-file\`.`
+                : 'Request body: JSON via `--body` or `--body-file`.');
+        }
+    }
+    if (operation.responseType === 'binary') {
+        sections.push('Response body: binary download written to `--output`.');
     }
     return sections.join('\n\n');
 }
@@ -357,6 +426,8 @@ export async function generateRuntime(document, configFile, baseUrl) {
         const bodyParameters = extractBodyParameters(operation.requestBody, usedFlagNames);
         const allParameters = [...parameters, ...bodyParameters];
         const hasBody = Boolean(operation.requestBody && !('$ref' in operation.requestBody));
+        const requestContentType = getRequestContentType(operation.requestBody);
+        const responseType = getResponseType(operation);
         const moduleDisplayName = moduleConfig.name ?? moduleKey;
         const moduleDescription = moduleConfig.description;
         const resourceDisplayName = resourceConfig?.name ?? resourceKey;
@@ -366,9 +437,11 @@ export async function generateRuntime(document, configFile, baseUrl) {
             description: operation.description,
         });
         const resourceSegments = toResourceSegments(pathTemplate);
-        const mappedResourceSegments = resourceSegments.length && resourceConfig?.name
-            ? [toKebabCase(resourceConfig.name), ...resourceSegments.slice(1)]
-            : resourceSegments;
+        const mappedResourceSegments = resourceSegments.length && resourceConfig?.segments?.length
+            ? [...resourceConfig.segments.map(toKebabCase), ...resourceSegments.slice(1)]
+            : resourceSegments.length && resourceConfig?.name
+                ? [toKebabCase(resourceConfig.name), ...resourceSegments.slice(1)]
+                : resourceSegments;
         const segments = [
             ...(resourceConfig?.topLevel ? [] : [toKebabCase(moduleDisplayName)]),
             ...mappedResourceSegments,
@@ -397,15 +470,21 @@ export async function generateRuntime(document, configFile, baseUrl) {
                 tags: operation.tags,
                 description: operationText.description,
                 hasBody,
+                requestContentType,
+                responseType,
                 parameters: allParameters,
             }),
             examples: buildExamples(segments.join(' '), {
                 parameters: allParameters,
                 hasBody,
+                requestContentType,
+                responseType,
             }),
             parameters: allParameters,
             hasBody,
             bodyRequired: operation.requestBody && !('$ref' in operation.requestBody) ? operation.requestBody.required : undefined,
+            requestContentType,
+            responseType,
         });
     }
     const schemaHash = createHash('sha1').update(JSON.stringify(document)).digest('hex').slice(0, 8);