@nocobase/app-server 0.11.1-alpha.4 → 2.0.0-beta.1

package/dist/router/cli/reference.js

@@ -0,0 +1,64 @@
+const words = (command) => command.id.split(':').join(' ');
+/** A command as it is typed: its words, its positional arguments, and its required flags. */
+export function cliUsageOf(command, bin) {
+    const parts = bin ? [bin, words(command)] : [words(command)];
+    const positional = command.parameters
+        .filter((parameter) => parameter.position !== undefined)
+        .sort((a, b) => (a.position ?? 0) - (b.position ?? 0));
+    for (const parameter of positional)
+        parts.push(parameter.required ? `<${parameter.name}>` : `[<${parameter.name}>]`);
+    for (const parameter of command.parameters) {
+        if (parameter.position !== undefined || !parameter.required)
+            continue;
+        if (parameter.default !== undefined)
+            continue;
+        parts.push(parameter.type === 'boolean'
+            ? `--${parameter.name}`
+            : `--${parameter.name} <${parameter.in === 'file' ? 'path' : parameter.type}>`);
+    }
+    // A body that only a file can give: no flag fills any of its fields.
+    if (command.body?.file &&
+        command.body.required &&
+        !command.parameters.some((parameter) => parameter.in === 'body'))
+        parts.push(`--${command.body.file} <file.json>`);
+    return parts.join(' ');
+}
+/**
+ * The caller's commands as compact text an agent reads before using the CLI (`GET /api/cli/llms.txt`): how the CLI
+ * answers, then one line per command with its usage, summary, and the action it needs, grouped by its first word.
+ */
+export function renderCliReference(manifest, description = {}) {
+    const bin = description.bin ?? 'cli';
+    const title = description.title ?? bin;
+    const lines = [
+        `# ${title} command line`,
+        '',
+        `> The commands \`${bin}\` offers ${manifest.identity.kind === 'run' ? `this agent run (for ${manifest.identity.displayName})` : manifest.identity.displayName}. Each is one API route.`,
+        '',
+        `- \`${bin} <command> --help\` shows a command's arguments and flags; \`${bin} docs <command>\` adds its examples.`,
+        `- \`--json\` prints one JSON document, \`{ schemaVersion, ok, command, status, result | error, warnings }\`; a command's answer is \`result.data\`, a failure's reason \`error.code\`.`,
+        '- Exit codes: 0 ok, 1 general, 2 network, 3 authentication or permission, 4 not found, 5 invalid input, 6 conflict, 7 a plan is required.',
+        '- A command that asks first takes `--yes`; a long text flag also takes `--<flag>-file <path>`.',
+        ...(description.notes ?? []).map((note) => `- ${note}`),
+    ];
+    const groups = new Map();
+    for (const command of manifest.commands) {
+        const group = command.id.split(':')[0] ?? command.id;
+        groups.set(group, [...(groups.get(group) ?? []), command]);
+    }
+    for (const [group, commands] of [...groups].sort(([a], [b]) => a.localeCompare(b))) {
+        lines.push('', `## ${group}`, '');
+        for (const command of commands)
+            lines.push(`- \`${cliUsageOf(command, bin)}\`: ${command.summary}${command.action ? ` (action \`${command.action}\`)` : ''}${command.confirm ? ' Asks first.' : ''}`);
+    }
+    if (manifest.withheld.length > 0) {
+        const byAction = manifest.withheld.filter((command) => command.reason === 'action');
+        if (byAction.length > 0) {
+            lines.push('', '## Not offered', '', 'These need an action the caller does not hold; ask whoever manages permissions:', '');
+            for (const command of byAction)
+                lines.push(`- \`${words(command)}\`: needs \`${command.action}\``);
+        }
+    }
+    return `${lines.join('\n')}\n`;
+}
+//# sourceMappingURL=reference.js.map

package/dist/router/cli/reference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reference.js","sourceRoot":"","sources":["../../../src/router/cli/reference.ts"],"names":[],"mappings":"AAEA,MAAM,KAAK,GAAG,CAAC,OAA+B,EAAU,EAAE,CACxD,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAElC,6FAA6F;AAC7F,MAAM,UAAU,UAAU,CAAC,OAAmB,EAAE,GAAY;IAC1D,MAAM,KAAK,GAAa,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACvE,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU;SAClC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,KAAK,SAAS,CAAC;SACvD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC;IACzD,KAAK,MAAM,SAAS,IAAI,UAAU;QAChC,KAAK,CAAC,IAAI,CACR,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,IAAI,IAAI,CACrE,CAAC;IACJ,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QAC3C,IAAI,SAAS,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,SAAS,CAAC,QAAQ;YAAE,SAAS;QACtE,IAAI,SAAS,CAAC,OAAO,KAAK,SAAS;YAAE,SAAS;QAC9C,KAAK,CAAC,IAAI,CACR,SAAS,CAAC,IAAI,KAAK,SAAS;YAC1B,CAAC,CAAC,KAAK,SAAS,CAAC,IAAI,EAAE;YACvB,CAAC,CAAC,KAAK,SAAS,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,GAAG,CACjF,CAAC;IACJ,CAAC;IACD,qEAAqE;IACrE,IACE,OAAO,CAAC,IAAI,EAAE,IAAI;QAClB,OAAO,CAAC,IAAI,CAAC,QAAQ;QACrB,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,MAAM,CAAC;QAEhE,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,CAAC;IACnD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAChC,QAAqB,EACrB,cAA8B,EAAE;IAEhC,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,IAAI,KAAK,CAAC;IACrC,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,IAAI,GAAG,CAAC;IACvC,MAAM,KAAK,GAAa;QACtB,KAAK,KAAK,eAAe;QACzB,EAAE;QACF,oBAAoB,GAAG,aAAa,QAAQ,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,uBAAuB,QAAQ,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,0BAA0B;QACxL,EAAE;QACF,OAAO,GAAG,gEAAgE,GAAG,sCAAsC;QACnH,wLAAwL;QACxL,2IAA2I;QAC3I,gGAAgG;QAChG,GAAG,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;KACxD,CAAC;IACF,MAAM,MAAM,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC/C,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,EAAE,CAAC;QACrD,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7D,CAAC;IACD,KAAK,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAC5D,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CACnB,EAAE,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QAClC,KAAK,MAAM,OAAO,IAAI,QAAQ;YAC5B,KAAK,CAAC,IAAI,CACR,OAAO,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,EAAE,CAC1J,CAAC;IACN,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CACvC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,QAAQ,CACzC,CAAC;QACF,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,KAAK,CAAC,IAAI,CACR,EAAE,EACF,gBAAgB,EAChB,EAAE,EACF,iFAAiF,EACjF,EAAE,CACH,CAAC;YACF,KAAK,MAAM,OAAO,IAAI,QAAQ;gBAC5B,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,OAAO,CAAC,eAAe,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IACD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC"}

package/dist/router/cli/routes.d.ts

@@ -0,0 +1,9 @@
+import { Hono } from 'hono';
+import type { ApiDocsService } from '../openapi/service.js';
+import type { CliService } from './service.js';
+/**
+ * `GET /cli/manifest`, mounted under `/api`: the commands the caller may run, derived from the API document and
+ * filtered by who calls. Without a caller resolver it answers `404 ROUTE_NOT_FOUND`, like a path that does not exist.
+ */
+export declare function createCliRouter(cli: CliService, docs: ApiDocsService): Hono;
+//# sourceMappingURL=routes.d.ts.map

package/dist/router/cli/routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../../../src/router/cli/routes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAgB,MAAM,MAAM,CAAC;AAc1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AA2K/C;;;GAGG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,cAAc,GAAG,IAAI,CAuF3E"}

package/dist/router/cli/routes.js

@@ -0,0 +1,228 @@
+import { Hono } from 'hono';
+import { z } from 'zod';
+import { ApiError, apiErrorHandler, apiNotFoundHandler, appErrorDomain, } from '../api-error.js';
+import { apiErrorResponse, dataResponse, describeRoute, } from '../openapi/describe.js';
+import { renderCliReference } from './reference.js';
+import { cliRoute } from './types.js';
+const Identity = z.enum(['person', 'run']);
+const CliParameterSchema = z
+    .object({
+    name: z.string(),
+    field: z.string(),
+    in: z.enum(['path', 'query', 'body', 'file']),
+    position: z.number().int().optional(),
+    type: z.enum([
+        'string',
+        'number',
+        'integer',
+        'boolean',
+        'string[]',
+        'number[]',
+        'json',
+    ]),
+    required: z.boolean(),
+    description: z.string().optional(),
+    enum: z.array(z.string()).optional(),
+    default: z.unknown().optional(),
+    alias: z.string().optional(),
+    contentFile: z.boolean().optional(),
+    prompt: z.boolean().optional(),
+    fromEnv: z.string().optional(),
+    env: z
+        .array(z.union([z.string(), z.object({ file: z.string(), path: z.string() })]))
+        .optional()
+        .meta({
+        description: 'Read from the environment when not given, the first found wins: a variable, or a field (dot-separated `path`) of the JSON file the variable `file` names.',
+    }),
+    upload: z
+        .object({
+        method: z.string(),
+        path: z.string(),
+        part: z.string(),
+        field: z.string(),
+        multiple: z.boolean(),
+        maxBytes: z.number().int().optional(),
+    })
+        .optional(),
+    ticket: z
+        .object({
+        maxBytes: z.number().int(),
+        accept: z.array(z.string()).optional(),
+        optional: z.boolean().optional(),
+    })
+        .optional(),
+    changed: z
+        .object({
+        dir: z.string(),
+        manifest: z.string(),
+        maxBytes: z.number().int(),
+        maxFiles: z.number().int(),
+        accept: z.array(z.string()).optional(),
+    })
+        .optional(),
+    binary: z.boolean().optional(),
+    multiple: z.boolean().optional(),
+})
+    .meta({ ref: 'CliParameter' });
+const CliCommandSchema = z
+    .object({
+    id: z.string().meta({
+        description: 'The command words joined by `:`, such as `issue:get`.',
+    }),
+    summary: z.string(),
+    description: z.string().optional(),
+    operationId: z.string().optional(),
+    method: z.enum(['GET', 'POST', 'PUT', 'PATCH', 'DELETE']),
+    path: z.string().meta({
+        description: 'The request path, the base path included, with `{name}` placeholders.',
+    }),
+    parameters: z.array(CliParameterSchema),
+    body: z
+        .object({
+        media: z.enum(['application/json', 'multipart/form-data']),
+        file: z.string().optional(),
+        required: z.boolean().optional(),
+    })
+        .optional(),
+    output: z.object({
+        kind: z.enum(['data', 'list', 'empty', 'download']),
+        columns: z.array(z.string()).optional(),
+    }),
+    confirm: z.string().optional(),
+    examples: z.array(z.string()).optional(),
+    identities: z.array(Identity),
+    action: z.string().optional(),
+})
+    .meta({ ref: 'CliCommand' });
+const CliManifestSchema = z
+    .object({
+    version: z.number().int(),
+    etag: z.string(),
+    identity: z.object({
+        kind: Identity,
+        userId: z.string(),
+        displayName: z.string(),
+        runId: z.string().optional(),
+        actions: z.array(z.string()).meta({
+            description: 'The business actions the caller holds.',
+        }),
+    }),
+    commands: z.array(CliCommandSchema),
+    withheld: z
+        .array(z
+        .object({
+        id: z.string(),
+        summary: z.string(),
+        reason: z.enum(['identity', 'action']),
+        identities: z.array(Identity),
+        action: z.string().optional(),
+    })
+        .meta({ ref: 'CliWithheldCommand' }))
+        .meta({
+        description: 'The commands the document describes that the caller is not offered: another identity’s, or naming an action it does not hold.',
+    }),
+})
+    .meta({ ref: 'CliManifest' });
+const MANIFEST_OPERATION = 'cliGetManifest';
+const REFERENCE_OPERATION = 'cliGetReference';
+const bound = new WeakMap();
+/**
+ * The manifest takes every credential that names a CLI identity: the document's own (a session, an API key) and each
+ * scheme `addIdentityScheme()` names that the document declares, such as an agent's run token.
+ */
+function bindManifestSecurity(cli, docs) {
+    if (bound.get(docs) === cli)
+        return;
+    bound.set(docs, cli);
+    cli.onChange(() => docs.invalidate());
+    docs.addTransform((document) => {
+        const operations = Object.values(document.paths ?? {})
+            .map((item) => item?.get)
+            .filter((candidate) => candidate?.operationId === MANIFEST_OPERATION ||
+            candidate?.operationId === REFERENCE_OPERATION);
+        const declared = document.components?.securitySchemes ?? {};
+        for (const operation of operations) {
+            if (!operation)
+                continue;
+            const base = operation.security ?? document.security ?? [];
+            const named = new Set(base.flatMap((requirement) => Object.keys(requirement)));
+            const extra = Object.keys(cli.identitySchemes())
+                .filter((scheme) => scheme in declared && !named.has(scheme))
+                .sort()
+                .map((scheme) => ({ [scheme]: [] }));
+            if (extra.length > 0)
+                operation.security = [...base, ...extra];
+        }
+    });
+}
+/**
+ * `GET /cli/manifest`, mounted under `/api`: the commands the caller may run, derived from the API document and
+ * filtered by who calls. Without a caller resolver it answers `404 ROUTE_NOT_FOUND`, like a path that does not exist.
+ */
+export function createCliRouter(cli, docs) {
+    bindManifestSecurity(cli, docs);
+    const router = new Hono();
+    router.onError(apiErrorHandler);
+    const manifestOf = async (context) => {
+        const caller = await cli.callerOf(context);
+        if (!caller)
+            throw new ApiError({
+                status: 'UNAUTHENTICATED',
+                reason: 'CLI_UNAUTHENTICATED',
+                domain: appErrorDomain,
+                message: 'Sign in, or present an API key or a run token.',
+            });
+        return cli.manifestFor(await docs.getDocument(), caller);
+    };
+    router.get('/cli/manifest', describeRoute({
+        tags: ['Cli'],
+        summary: 'Get the command-line manifest',
+        operationId: MANIFEST_OPERATION,
+        description: "The commands the caller may run, derived from this document: each operation's `x-cli` extension, or its tag, path and method. A person signs in or presents an API key; an agent's run presents its run token. Answers an `etag`; a request whose `if-none-match` names the current one is answered `304` without a body.",
+        responses: {
+            200: dataResponse(CliManifestSchema),
+            304: {
+                description: 'The manifest has not changed since `if-none-match`.',
+            },
+            401: apiErrorResponse(401, 'No credential the application recognizes (`CLI_UNAUTHENTICATED`).'),
+            404: apiErrorResponse(404, 'The application recognizes no CLI callers (`ROUTE_NOT_FOUND`).'),
+            500: apiErrorResponse(500),
+        },
+        ...cliRoute(false),
+    }), async (context) => {
+        if (!cli.hasCallers())
+            return apiNotFoundHandler(context);
+        const manifest = await manifestOf(context);
+        context.header('etag', `"${manifest.etag}"`);
+        context.header('cache-control', 'private, no-cache');
+        const asked = context.req.header('if-none-match');
+        if (asked &&
+            asked.replace(/^W\//u, '').replaceAll('"', '') === manifest.etag)
+            return context.body(null, 304);
+        return context.json({ data: manifest });
+    });
+    router.get('/cli/llms.txt', describeRoute({
+        tags: ['Cli'],
+        summary: 'Get the command-line reference for agents',
+        operationId: REFERENCE_OPERATION,
+        description: 'The commands the caller may run as compact Markdown an agent reads before using the CLI: how it answers, one line per command with its usage, summary and action, and the commands that need an action the caller does not hold. Takes the same credentials as the manifest.',
+        responses: {
+            200: {
+                description: 'The reference.',
+                content: { 'text/plain': { schema: { type: 'string' } } },
+            },
+            401: apiErrorResponse(401, 'No credential the application recognizes (`CLI_UNAUTHENTICATED`).'),
+            404: apiErrorResponse(404, 'The application recognizes no CLI callers (`ROUTE_NOT_FOUND`).'),
+            500: apiErrorResponse(500),
+        },
+        ...cliRoute(false),
+    }), async (context) => {
+        if (!cli.hasCallers())
+            return apiNotFoundHandler(context);
+        const manifest = await manifestOf(context);
+        context.header('cache-control', 'private, no-cache');
+        return context.text(renderCliReference(manifest, cli.described()));
+    });
+    return router;
+}
+//# sourceMappingURL=routes.js.map

package/dist/router/cli/routes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.js","sourceRoot":"","sources":["../../../src/router/cli/routes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAgB,MAAM,MAAM,CAAC;AAC1C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,cAAc,GACf,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,aAAa,GACd,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAoB,MAAM,YAAY,CAAC;AAExD,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;AAE3C,MAAM,kBAAkB,GAAG,CAAC;KACzB,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACrC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;QACX,QAAQ;QACR,QAAQ;QACR,SAAS;QACT,SAAS;QACT,UAAU;QACV,UAAU;QACV,MAAM;KACP,CAAC;IACF,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACpC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACnC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,GAAG,EAAE,CAAC;SACH,KAAK,CACJ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CACxE;SACA,QAAQ,EAAE;SACV,IAAI,CAAC;QACJ,WAAW,EACT,2JAA2J;KAC9J,CAAC;IACJ,MAAM,EAAE,CAAC;SACN,MAAM,CAAC;QACN,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;QAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;QACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;KACtC,CAAC;SACD,QAAQ,EAAE;IACb,MAAM,EAAE,CAAC;SACN,MAAM,CAAC;QACN,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QAC1B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;QACtC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;KACjC,CAAC;SACD,QAAQ,EAAE;IACb,OAAO,EAAE,CAAC;SACP,MAAM,CAAC;QACN,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;QACf,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;QACpB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QAC1B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QAC1B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;KACvC,CAAC;SACD,QAAQ,EAAE;IACb,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,IAAI,CAAC,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC,CAAC;AAEjC,MAAM,gBAAgB,GAAG,CAAC;KACvB,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;QAClB,WAAW,EAAE,uDAAuD;KACrE,CAAC;IACF,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACzD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;QACpB,WAAW,EACT,uEAAuE;KAC1E,CAAC;IACF,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;IACvC,IAAI,EAAE,CAAC;SACJ,MAAM,CAAC;QACN,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,CAAC;QAC1D,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;KACjC,CAAC;SACD,QAAQ,EAAE;IACb,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QACnD,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;KACxC,CAAC;IACF,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACxC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC;KACD,IAAI,CAAC,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC,CAAC;AAE/B,MAAM,iBAAiB,GAA2B,CAAC;KAChD,MAAM,CAAC;IACN,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;QAClB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC;YAChC,WAAW,EAAE,wCAAwC;SACtD,CAAC;KACH,CAAC;IACF,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;IACnC,QAAQ,EAAE,CAAC;SACR,KAAK,CACJ,CAAC;SACE,MAAM,CAAC;QACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;QACd,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACtC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC9B,CAAC;SACD,IAAI,CAAC,EAAE,GAAG,EAAE,oBAAoB,EAAE,CAAC,CACvC;SACA,IAAI,CAAC;QACJ,WAAW,EACT,+HAA+H;KAClI,CAAC;CACL,CAAC;KACD,IAAI,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,CAAC;AAEhC,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AAC5C,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;AAE9C,MAAM,KAAK,GAAG,IAAI,OAAO,EAA8B,CAAC;AAExD;;;GAGG;AACH,SAAS,oBAAoB,CAAC,GAAe,EAAE,IAAoB;IACjE,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG;QAAE,OAAO;IACpC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACrB,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACtC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7B,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC;aACnD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;aACxB,MAAM,CACL,CAAC,SAAS,EAAE,EAAE,CACZ,SAAS,EAAE,WAAW,KAAK,kBAAkB;YAC7C,SAAS,EAAE,WAAW,KAAK,mBAAmB,CACjD,CAAC;QACJ,MAAM,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,eAAe,IAAI,EAAE,CAAC;QAC5D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,IAAI,CAAC,SAAS;gBAAE,SAAS;YACzB,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,IAAI,EAAE,CAAC;YAC3D,MAAM,KAAK,GAAG,IAAI,GAAG,CACnB,IAAI,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CACxD,CAAC;YACF,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC;iBAC7C,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,IAAI,QAAQ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;iBAC5D,IAAI,EAAE;iBACN,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;YACvC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;gBAAE,SAAS,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC;QACjE,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,GAAe,EAAE,IAAoB;IACnE,oBAAoB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAChC,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;IAC1B,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAChC,MAAM,UAAU,GAAG,KAAK,EAAE,OAAgB,EAAwB,EAAE;QAClE,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,QAAQ,CAAC;gBACjB,MAAM,EAAE,iBAAiB;gBACzB,MAAM,EAAE,qBAAqB;gBAC7B,MAAM,EAAE,cAAc;gBACtB,OAAO,EAAE,gDAAgD;aAC1D,CAAC,CAAC;QACL,OAAO,GAAG,CAAC,WAAW,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC,CAAC;IACF,MAAM,CAAC,GAAG,CACR,eAAe,EACf,aAAa,CAAC;QACZ,IAAI,EAAE,CAAC,KAAK,CAAC;QACb,OAAO,EAAE,+BAA+B;QACxC,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EACT,2TAA2T;QAC7T,SAAS,EAAE;YACT,GAAG,EAAE,YAAY,CAAC,iBAAiB,CAAC;YACpC,GAAG,EAAE;gBACH,WAAW,EAAE,qDAAqD;aACnE;YACD,GAAG,EAAE,gBAAgB,CACnB,GAAG,EACH,mEAAmE,CACpE;YACD,GAAG,EAAE,gBAAgB,CACnB,GAAG,EACH,gEAAgE,CACjE;YACD,GAAG,EAAE,gBAAgB,CAAC,GAAG,CAAC;SAC3B;QACD,GAAG,QAAQ,CAAC,KAAK,CAAC;KACnB,CAAC,EACF,KAAK,EAAE,OAAO,EAAE,EAAE;QAChB,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE;YAAE,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;QAC7C,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;QACrD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAClD,IACE,KAAK;YACL,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,QAAQ,CAAC,IAAI;YAEhE,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACjC,OAAO,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC1C,CAAC,CACF,CAAC;IACF,MAAM,CAAC,GAAG,CACR,eAAe,EACf,aAAa,CAAC;QACZ,IAAI,EAAE,CAAC,KAAK,CAAC;QACb,OAAO,EAAE,2CAA2C;QACpD,WAAW,EAAE,mBAAmB;QAChC,WAAW,EACT,8QAA8Q;QAChR,SAAS,EAAE;YACT,GAAG,EAAE;gBACH,WAAW,EAAE,gBAAgB;gBAC7B,OAAO,EAAE,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE;aAC1D;YACD,GAAG,EAAE,gBAAgB,CACnB,GAAG,EACH,mEAAmE,CACpE;YACD,GAAG,EAAE,gBAAgB,CACnB,GAAG,EACH,gEAAgE,CACjE;YACD,GAAG,EAAE,gBAAgB,CAAC,GAAG,CAAC;SAC3B;QACD,GAAG,QAAQ,CAAC,KAAK,CAAC;KACnB,CAAC,EACF,KAAK,EAAE,OAAO,EAAE,EAAE;QAChB,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE;YAAE,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;QACrD,OAAO,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IACrE,CAAC,CACF,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/router/cli/service.d.ts

@@ -0,0 +1,50 @@
+import { type ServiceToken } from '@nocobase/service-provider';
+import type { Context } from 'hono';
+import type { ApiDocument } from '../openapi/document.js';
+import type { CliCaller, CliCommand, CliDescription, CliExclusion, CliIdentity, CliManifest } from './types.js';
+/**
+ * Tells who calls the CLI manifest: a caller, `null` for a request it recognizes but refuses, or `undefined` to leave
+ * the request to the other resolvers. It may throw an `ApiError` to answer with a status of its own.
+ */
+export type CliCallerResolver = (context: Context) => Promise<CliCaller | null | undefined> | CliCaller | null | undefined;
+/**
+ * The application's command-line surface: the commands its API document describes, filtered per caller. Who a caller is
+ * comes from the resolvers plugins register (the framework knows no credential); which security schemes name which
+ * identity from `addIdentityScheme()`; which documented
+ * operations stay off the command line from `exclude()`.
+ */
+export declare class CliService {
+    private readonly resolvers;
+    private readonly schemes;
+    private readonly exclusions;
+    private readonly listeners;
+    private description;
+    private derived;
+    /** Recognize callers with `resolver`. Returns a function that removes it. */
+    addCaller(resolver: CliCallerResolver): () => void;
+    /** An operation whose security names `scheme` is offered to `identity`. Returns a function that removes it. */
+    addIdentityScheme(scheme: string, identity: CliIdentity): () => void;
+    /** The security schemes `addIdentityScheme()` named, beside the session and the API key. */
+    identitySchemes(): Readonly<Record<string, CliIdentity>>;
+    /** Keeps the operations `rule` matches off the command line; they stay documented. Returns what removes it. */
+    exclude(rule: CliExclusion): () => void;
+    /** Calls `listener` whenever the identity schemes or exclusions change. Returns what removes it. */
+    onChange(listener: () => void): () => void;
+    /** Names the application's CLI, for the agent-readable reference (`GET /api/cli/llms.txt`). */
+    describe(description: CliDescription): void;
+    /** What `describe()` said. */
+    described(): CliDescription;
+    /** Whether any resolver is registered: without one, nobody can be told apart and there is no manifest. */
+    hasCallers(): boolean;
+    /** Who calls, by the first resolver that recognizes the request; `null` when none does. */
+    callerOf(context: Context): Promise<CliCaller | null>;
+    /** Every command `document` describes, derived once per document. */
+    commandsOf(document: ApiDocument): readonly CliCommand[];
+    /** The manifest of `caller`: the commands `document` describes that it may run. */
+    manifestFor(document: ApiDocument, caller: CliCaller): CliManifest;
+    private changed;
+    private track;
+}
+/** The application's `CliService`; a plugin resolves it to recognize callers or add commands. */
+export declare const cliToken: ServiceToken<CliService>;
+//# sourceMappingURL=service.d.ts.map

package/dist/router/cli/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../../src/router/cli/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,YAAY,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAM1D,OAAO,KAAK,EACV,SAAS,EACT,UAAU,EACV,cAAc,EACd,YAAY,EACZ,WAAW,EACX,WAAW,EACZ,MAAM,YAAY,CAAC;AAEpB;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAC9B,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,SAAS,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,SAAS,GAAG,IAAI,GAAG,SAAS,CAAC;AAE1E;;;;;GAKG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA2B;IACrD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmC;IAC3D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IACjD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAsB;IAChD,OAAO,CAAC,WAAW,CAAsB;IACzC,OAAO,CAAC,OAAO,CAED;IAEd,6EAA6E;IACtE,SAAS,CAAC,QAAQ,EAAE,iBAAiB,GAAG,MAAM,IAAI;IAIzD,+GAA+G;IACxG,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,MAAM,IAAI;IAS3E,4FAA4F;IACrF,eAAe,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAI/D,+GAA+G;IACxG,OAAO,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,IAAI;IAU9C,oGAAoG;IAC7F,QAAQ,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IAIjD,+FAA+F;IACxF,QAAQ,CAAC,WAAW,EAAE,cAAc,GAAG,IAAI;IAIlD,8BAA8B;IACvB,SAAS,IAAI,cAAc;IAIlC,0GAA0G;IACnG,UAAU,IAAI,OAAO;IAI5B,2FAA2F;IAC9E,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAQlE,qEAAqE;IAC9D,UAAU,CAAC,QAAQ,EAAE,WAAW,GAAG,SAAS,UAAU,EAAE;IAc/D,mFAAmF;IAC5E,WAAW,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,GAAG,WAAW;IAIzE,OAAO,CAAC,OAAO;IAKf,OAAO,CAAC,KAAK;CAOd;AAED,iGAAiG;AACjG,eAAO,MAAM,QAAQ,EAAE,YAAY,CAAC,UAAU,CACO,CAAC"}

package/dist/router/cli/service.js

@@ -0,0 +1,104 @@
+import { createServiceToken, } from '@nocobase/service-provider';
+import { cliManifestOf, deriveAllCliCommands, } from './derive.js';
+/**
+ * The application's command-line surface: the commands its API document describes, filtered per caller. Who a caller is
+ * comes from the resolvers plugins register (the framework knows no credential); which security schemes name which
+ * identity from `addIdentityScheme()`; which documented
+ * operations stay off the command line from `exclude()`.
+ */
+export class CliService {
+    resolvers = [];
+    schemes = {};
+    exclusions = [];
+    listeners = [];
+    description = {};
+    derived;
+    /** Recognize callers with `resolver`. Returns a function that removes it. */
+    addCaller(resolver) {
+        return this.track(this.resolvers, resolver);
+    }
+    /** An operation whose security names `scheme` is offered to `identity`. Returns a function that removes it. */
+    addIdentityScheme(scheme, identity) {
+        this.schemes[scheme] = identity;
+        this.changed();
+        return () => {
+            if (this.schemes[scheme] === identity)
+                delete this.schemes[scheme];
+            this.changed();
+        };
+    }
+    /** The security schemes `addIdentityScheme()` named, beside the session and the API key. */
+    identitySchemes() {
+        return { ...this.schemes };
+    }
+    /** Keeps the operations `rule` matches off the command line; they stay documented. Returns what removes it. */
+    exclude(rule) {
+        this.exclusions.push(rule);
+        this.changed();
+        return () => {
+            const index = this.exclusions.indexOf(rule);
+            if (index >= 0)
+                this.exclusions.splice(index, 1);
+            this.changed();
+        };
+    }
+    /** Calls `listener` whenever the identity schemes or exclusions change. Returns what removes it. */
+    onChange(listener) {
+        return this.track(this.listeners, listener);
+    }
+    /** Names the application's CLI, for the agent-readable reference (`GET /api/cli/llms.txt`). */
+    describe(description) {
+        this.description = { ...this.description, ...description };
+    }
+    /** What `describe()` said. */
+    described() {
+        return { ...this.description };
+    }
+    /** Whether any resolver is registered: without one, nobody can be told apart and there is no manifest. */
+    hasCallers() {
+        return this.resolvers.length > 0;
+    }
+    /** Who calls, by the first resolver that recognizes the request; `null` when none does. */
+    async callerOf(context) {
+        for (const resolver of [...this.resolvers]) {
+            const caller = await resolver(context);
+            if (caller !== undefined)
+                return caller;
+        }
+        return null;
+    }
+    /** Every command `document` describes, derived once per document. */
+    commandsOf(document) {
+        if (this.derived?.document !== document) {
+            const options = {
+                identitySchemes: { ...this.schemes },
+                exclude: [...this.exclusions],
+            };
+            this.derived = {
+                document,
+                commands: deriveAllCliCommands(document, options),
+            };
+        }
+        return this.derived.commands;
+    }
+    /** The manifest of `caller`: the commands `document` describes that it may run. */
+    manifestFor(document, caller) {
+        return cliManifestOf(this.commandsOf(document), caller);
+    }
+    changed() {
+        this.derived = undefined;
+        for (const listener of [...this.listeners])
+            listener();
+    }
+    track(list, entry) {
+        list.push(entry);
+        return () => {
+            const index = list.indexOf(entry);
+            if (index >= 0)
+                list.splice(index, 1);
+        };
+    }
+}
+/** The application's `CliService`; a plugin resolves it to recognize callers or add commands. */
+export const cliToken = createServiceToken('@nocobase/app/cli');
+//# sourceMappingURL=service.js.map

package/dist/router/cli/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/router/cli/service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,GAEnB,MAAM,4BAA4B,CAAC;AAIpC,OAAO,EACL,aAAa,EACb,oBAAoB,GAErB,MAAM,aAAa,CAAC;AAkBrB;;;;;GAKG;AACH,MAAM,OAAO,UAAU;IACJ,SAAS,GAAwB,EAAE,CAAC;IACpC,OAAO,GAAgC,EAAE,CAAC;IAC1C,UAAU,GAAmB,EAAE,CAAC;IAChC,SAAS,GAAmB,EAAE,CAAC;IACxC,WAAW,GAAmB,EAAE,CAAC;IACjC,OAAO,CAED;IAEd,6EAA6E;IACtE,SAAS,CAAC,QAA2B;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED,+GAA+G;IACxG,iBAAiB,CAAC,MAAc,EAAE,QAAqB;QAC5D,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;QAChC,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,OAAO,GAAG,EAAE;YACV,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ;gBAAE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACnE,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC,CAAC;IACJ,CAAC;IAED,4FAA4F;IACrF,eAAe;QACpB,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED,+GAA+G;IACxG,OAAO,CAAC,IAAkB;QAC/B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,OAAO,GAAG,EAAE;YACV,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAI,KAAK,IAAI,CAAC;gBAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACjD,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC,CAAC;IACJ,CAAC;IAED,oGAAoG;IAC7F,QAAQ,CAAC,QAAoB;QAClC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED,+FAA+F;IACxF,QAAQ,CAAC,WAA2B;QACzC,IAAI,CAAC,WAAW,GAAG,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,GAAG,WAAW,EAAE,CAAC;IAC7D,CAAC;IAED,8BAA8B;IACvB,SAAS;QACd,OAAO,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACjC,CAAC;IAED,0GAA0G;IACnG,UAAU;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IACnC,CAAC;IAED,2FAA2F;IACpF,KAAK,CAAC,QAAQ,CAAC,OAAgB;QACpC,KAAK,MAAM,QAAQ,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC3C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAC;YACvC,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,MAAM,CAAC;QAC1C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qEAAqE;IAC9D,UAAU,CAAC,QAAqB;QACrC,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACxC,MAAM,OAAO,GAA6B;gBACxC,eAAe,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;gBACpC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;aAC9B,CAAC;YACF,IAAI,CAAC,OAAO,GAAG;gBACb,QAAQ;gBACR,QAAQ,EAAE,oBAAoB,CAAC,QAAQ,EAAE,OAAO,CAAC;aAClD,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED,mFAAmF;IAC5E,WAAW,CAAC,QAAqB,EAAE,MAAiB;QACzD,OAAO,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAEO,OAAO;QACb,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QACzB,KAAK,MAAM,QAAQ,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;YAAE,QAAQ,EAAE,CAAC;IACzD,CAAC;IAEO,KAAK,CAAI,IAAS,EAAE,KAAQ;QAClC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjB,OAAO,GAAG,EAAE;YACV,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,KAAK,IAAI,CAAC;gBAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC;IACJ,CAAC;CACF;AAED,iGAAiG;AACjG,MAAM,CAAC,MAAM,QAAQ,GACnB,kBAAkB,CAAa,mBAAmB,CAAC,CAAC"}