@nocobase/app-plugin-agents 0.0.0-stage → 0.1.0-beta.1

package/dist/shared/agents.js

@@ -0,0 +1,143 @@
+/**
+ * Agents as the browser and the server's admin API exchange them.
+ *
+ * An agent is who works and how: its name and instructions, its type, the business actions it may perform. Its type is
+ * chosen when it is created and never changes:
+ *
+ * - `runner`: it drives a coding tool on a runner, with its skills, its tool policy and its own
+ *   variables. Where it runs is not configured beyond an optional list of runners: a run goes to any online runner that
+ *   has one of its tools installed and signed in, may run the waking person's work, and has a free slot.
+ * - `online`: it talks to a model of a model service directly, on the server: no runner, no working directory, no
+ *   variables. Its tools are the application's commands it may run, and whatever else the application offers
+ *   (knowledge search). It answers in seconds and runs only on subjects that need no working directory, such as
+ *   conversations.
+ *
+ * Which tool or model it works with, and with what reasoning effort, is an ordered list (`modelEntries`), the first
+ * being its default. A runner takes a runner agent's run with the first entry whose tool it has enabled and signed in;
+ * nobody chooses. An online agent's runs use the first entry, except in a conversation, whose owner may pick another of
+ * its entries. The run records the entry it used (`Run.tool`, `Run.modelService`, `Run.model`, `Run.effort`).
+ *
+ * An online agent with no entry is not configured yet (such as an application's built-in assistant before a model service exists): it is
+ * kept, shown as needing a model, and offered no work until an entry is added. A runner agent always has one.
+ */
+import { TOOL_EFFORTS, } from '@nocobase/agent-protocol';
+/** Who may wake an agent: its owner, the listed users, or everyone. */
+export const AGENT_ACCESS = ['ownerOnly', 'users', 'everyone'];
+/** What kind of agent it is; chosen at creation and never changed (`runner`: a coding tool on a runner, `online`: a model on the server). */
+export const AGENT_TYPES = ['online', 'runner'];
+/**
+ * When an agent in a conversation asks the person before changing data for them: `always` (every change goes through an
+ * operation plan they confirm) or `larger` (small changes are made directly, within the application's direct-write
+ * rules, and anything larger goes through a plan). There is no "never": what the rules call larger (waking an agent,
+ * finishing an issue, changing an owner, …) always needs the person's confirmation.
+ */
+export const CONFIRM_CHANGES = ['always', 'larger'];
+/** The reasoning efforts an online agent's entry may name, weakest first, as the model gateway passes them to providers. */
+export const ONLINE_EFFORTS = [
+    'minimal',
+    'low',
+    'medium',
+    'high',
+    'xhigh',
+];
+/** The most entries an agent's list holds. */
+export const MAX_MODEL_ENTRIES = 20;
+export function isRunnerEntry(entry) {
+    return 'tool' in entry;
+}
+export function isOnlineEntry(entry) {
+    return 'modelService' in entry;
+}
+/** The reasoning efforts `entry` may name: its tool's for a runner entry, `ONLINE_EFFORTS` for an online one. */
+export function effortsFor(entry) {
+    return 'tool' in entry ? TOOL_EFFORTS[entry.tool] : ONLINE_EFFORTS;
+}
+/** A runner agent's entries, in order; empty for an online agent. */
+export function runnerEntries(agent) {
+    return agent.modelEntries.filter(isRunnerEntry);
+}
+/** An online agent's entries, in order; empty for a runner agent. */
+export function onlineEntries(agent) {
+    return agent.modelEntries.filter(isOnlineEntry);
+}
+/**
+ * The entries an online agent answers with: its own, or, when it lists none, the system default chat model
+ * (`DefaultModels`) as its only one; empty for a runner agent or when there is no default either.
+ */
+export function onlineEntriesOrDefault(agent, defaultModel) {
+    if (agent.type !== 'online')
+        return [];
+    const own = onlineEntries(agent);
+    if (own.length > 0)
+        return own;
+    return defaultModel
+        ? [{ modelService: defaultModel.modelService, model: defaultModel.model }]
+        : [];
+}
+/** The coding tools a runner agent's entries name, in order and once each; empty for an online agent. */
+export function entryTools(agent) {
+    return [...new Set(runnerEntries(agent).map((entry) => entry.tool))];
+}
+/** Whether two entries name the same tool or service and model, whatever their efforts. */
+export function sameEntry(a, b) {
+    if (isRunnerEntry(a))
+        return (isRunnerEntry(b) &&
+            a.tool === b.tool &&
+            (a.model ?? null) === (b.model ?? null));
+    return (isOnlineEntry(b) && a.modelService === b.modelService && a.model === b.model);
+}
+/** What a change to an agent's configuration was. */
+export const AGENT_CHANGE_ACTIONS = [
+    'created',
+    'updated',
+    'archived',
+    'restored',
+    'variables',
+];
+/** The fields of an agent whose changes its history records, in the order the history shows them. */
+export const AGENT_HISTORY_FIELDS = [
+    'name',
+    'description',
+    'avatar',
+    'instructions',
+    'type',
+    'modelEntries',
+    'skillIds',
+    'actions',
+    'confirmChanges',
+    'toolPolicy',
+    'runnerIds',
+    'maxConcurrentRuns',
+    'maxAttempts',
+    'access',
+    'userIds',
+    'ownerUserId',
+];
+/** Fields no longer recorded that older history entries still carry, so the history can still name them. */
+export const RETIRED_AGENT_HISTORY_FIELDS = [
+    'tool',
+    'model',
+    'llmService',
+    'modelService',
+    'reasoningEffort',
+];
+/**
+ * The tool policy an agent starts from; an agent's `toolPolicy` overrides fields of it. The editor shows it so people
+ * see what they override.
+ */
+export const DEFAULT_TOOL_POLICY = {
+    permissionMode: 'acceptEdits',
+    allowedCommands: [
+        '^(cd|git|ls|cat|head|tail|grep|rg|find|wc|diff|sed|awk|sort|uniq|echo|printf|pwd|which|mkdir|touch|cp|mv)\\b',
+        '^(node|npm|npx|pnpm|yarn|tsc|vitest|jest|eslint|prettier|python3?|pip3?|pytest|go|cargo|make)\\b',
+    ],
+    deniedPatterns: [
+        '\\brm\\s+-[a-z]*r[a-z]*f?\\s+/(\\s|$)',
+        '\\bsudo\\b',
+        '\\bcurl\\b[^|]*\\|\\s*(sh|bash|zsh)\\b',
+        '\\bgit\\s+push\\b[^\\n]*--force\\b',
+        '\\bchmod\\s+-R\\s+777\\b',
+    ],
+    idleTimeoutMs: 30 * 60_000,
+};
+//# sourceMappingURL=agents.js.map

package/dist/shared/agents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agents.js","sourceRoot":"","sources":["../../shared/agents.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,OAAO,EACL,YAAY,GAGb,MAAM,0BAA0B,CAAC;AAIlC,uEAAuE;AACvE,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,WAAW,EAAE,OAAO,EAAE,UAAU,CAAU,CAAC;AAIxE,6IAA6I;AAC7I,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAC;AAIzD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAC;AAI7D,4HAA4H;AAC5H,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS;IACT,KAAK;IACL,QAAQ;IACR,MAAM;IACN,OAAO;CACC,CAAC;AAyBX,8CAA8C;AAC9C,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAEpC,MAAM,UAAU,aAAa,CAC3B,KAAsB;IAEtB,OAAO,MAAM,IAAI,KAAK,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,KAAsB;IAEtB,OAAO,cAAc,IAAI,KAAK,CAAC;AACjC,CAAC;AAED,iHAAiH;AACjH,MAAM,UAAU,UAAU,CACxB,KAAuE;IAEvE,OAAO,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;AACrE,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,aAAa,CAAC,KAE7B;IACC,OAAO,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;AAClD,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,aAAa,CAAC,KAE7B;IACC,OAAO,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAGC,EACD,YAGQ;IAER,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IACvC,MAAM,GAAG,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IACjC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC;IAC/B,OAAO,YAAY;QACjB,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,YAAY,EAAE,KAAK,EAAE,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1E,CAAC,CAAC,EAAE,CAAC;AACT,CAAC;AAED,yGAAyG;AACzG,MAAM,UAAU,UAAU,CAAC,KAE1B;IACC,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,SAAS,CAAC,CAAkB,EAAE,CAAkB;IAC9D,IAAI,aAAa,CAAC,CAAC,CAAC;QAClB,OAAO,CACL,aAAa,CAAC,CAAC,CAAC;YAChB,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI;YACjB,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,CACxC,CAAC;IACJ,OAAO,CACL,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,CAC7E,CAAC;AACJ,CAAC;AA0HD,qDAAqD;AACrD,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,SAAS;IACT,SAAS;IACT,UAAU;IACV,UAAU;IACV,WAAW;CACH,CAAC;AAIX,qGAAqG;AACrG,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,MAAM;IACN,aAAa;IACb,QAAQ;IACR,cAAc;IACd,MAAM;IACN,cAAc;IACd,UAAU;IACV,SAAS;IACT,gBAAgB;IAChB,YAAY;IACZ,WAAW;IACX,mBAAmB;IACnB,aAAa;IACb,QAAQ;IACR,SAAS;IACT,aAAa;CACL,CAAC;AAIX,4GAA4G;AAC5G,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,MAAM;IACN,OAAO;IACP,YAAY;IACZ,cAAc;IACd,iBAAiB;CACT,CAAC;AAoEX;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAe;IAC7C,cAAc,EAAE,aAAa;IAC7B,eAAe,EAAE;QACf,8GAA8G;QAC9G,kGAAkG;KACnG;IACD,cAAc,EAAE;QACd,uCAAuC;QACvC,YAAY;QACZ,wCAAwC;QACxC,oCAAoC;QACpC,0BAA0B;KAC3B;IACD,aAAa,EAAE,EAAE,GAAG,MAAM;CAC3B,CAAC"}

package/dist/shared/briefs.d.ts

@@ -0,0 +1,46 @@
+/**
+ * The brief an agent runs with, as people read it: the four layers the server renders (rules, task, context, the
+ * agent's own instructions) and the first turn. The runner adds what only it knows where the system prompt holds its
+ * placeholders (`{{runner.workspaceNotes}}`, `{{runner.workspaceInit}}`).
+ */
+export interface BriefLayers {
+    readonly system: string;
+    readonly task: string;
+    readonly context: string;
+    readonly agent: string;
+}
+/** A made-up value in a previewed brief, marked so nobody mistakes it for data. */
+export declare function sampleValue(text: string): string;
+/**
+ * `GET /api/agents/:agentId/previewBrief?scenario=`: what a run of the agent on a made-up subject of the scenario's kind
+ * would be sent now (`SubjectSample`), the made-up values marked with `sampleValue`.
+ */
+export interface BriefPreview {
+    /** The subject kind the brief was rendered for (for example, `issue` or `conversation`). */
+    readonly scenario: string;
+    /** The made-up subject. */
+    readonly subject: {
+        readonly key: string;
+        readonly title: string | null;
+    };
+    /**
+     * The system prompt as the runner or the online executor receives it is `platform` followed by `agentPrompt`.
+     * `platform` is everything before the agent's own prompt: the rules, the task, the context and the English lead-in to
+     * the agent's prompt. The runner's placeholders are shown annotated.
+     */
+    readonly platform: string;
+    /** The agent's own prompt as written, which ends the system prompt; empty when the agent has none. */
+    readonly agentPrompt: string;
+    /** The first message: the turn the agent is given, with what woke it. */
+    readonly firstMessage: string;
+}
+/** `GET /api/agents/runs/:runId/brief`: the brief the run's latest attempt was given. */
+export interface RunBrief {
+    readonly runId: string;
+    readonly attempt: number;
+    readonly layers: BriefLayers;
+    readonly turn: string;
+    readonly prompt: string;
+    readonly createdAt: string;
+}
+//# sourceMappingURL=briefs.d.ts.map

package/dist/shared/briefs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"briefs.d.ts","sourceRoot":"","sources":["../../shared/briefs.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,mFAAmF;AACnF,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,4FAA4F;IAC5F,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,2BAA2B;IAC3B,QAAQ,CAAC,OAAO,EAAE;QAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAC1E;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,sGAAsG;IACtG,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,yEAAyE;IACzE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC/B;AAED,yFAAyF;AACzF,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B"}

package/dist/shared/briefs.js

@@ -0,0 +1,10 @@
+/**
+ * The brief an agent runs with, as people read it: the four layers the server renders (rules, task, context, the
+ * agent's own instructions) and the first turn. The runner adds what only it knows where the system prompt holds its
+ * placeholders (`{{runner.workspaceNotes}}`, `{{runner.workspaceInit}}`).
+ */
+/** A made-up value in a previewed brief, marked so nobody mistakes it for data. */
+export function sampleValue(text) {
+    return `[sample] ${text}`;
+}
+//# sourceMappingURL=briefs.js.map

package/dist/shared/briefs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"briefs.js","sourceRoot":"","sources":["../../shared/briefs.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AASH,mFAAmF;AACnF,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,YAAY,IAAI,EAAE,CAAC;AAC5B,CAAC"}