@nocobase/app-plugin-agents 0.1.0-beta.8 → 1.0.0-beta.15

package/dist/server/core/agents/agent.service.d.ts

@@ -1,54 +1,65 @@
+import type { AgentTool } from '@nocobase/agent-protocol';
 import type { DatabaseConnection } from '@nocobase/db';
 import { z } from 'zod';
-import { type Agent, type AgentChange, type AgentInput, type AgentModelEntry, type AgentPatch, type AgentType } from '../../../shared/agents.js';
-import type { I18nText } from '../../../shared/i18n.js';
-import { type ModelCatalog } from '../../../shared/models.js';
+import { type Agent, type AgentChange, type AgentName, type AgentPatch, type SystemAgentInput } from '../../../shared/agents.js';
+import { type DiscoveryPreference } from './discovery.js';
+import { type Runner } from '../../../shared/runners.js';
 import type { Clock } from '../../kernel/clock.js';
 import type { IdSource } from '../../kernel/ids.js';
 import type { People } from '../../kernel/people.js';
 import type { Tx, TxRunner } from '../../kernel/tx.js';
 import { type HistoryOptions } from './agent.history.js';
-/**
- * An agent's list of tools and models: runner entries (`{ tool, model?, effort? }`) or online ones
- * (`{ modelService, model, effort? }`).
- */
-export declare const ModelEntriesSchema: z.ZodType<AgentModelEntry[]>;
-/** What creating an agent accepts. */
-export declare const AgentInputSchema: z.ZodType<AgentInput>;
-/**
- * What updating an agent accepts: any field of the input but its type, and the revision the edit was made against. A
- * patch naming a type is refused (`AGENT_TYPE_IMMUTABLE`) rather than having it ignored.
- */
+/** What changing an agent accepts. */
 export declare const AgentPatchSchema: z.ZodType<AgentPatch>;
+/** What every agent discovered from runners is: the application's instructions and business actions. */
+export interface AgentDefaults {
+    readonly instructions: string | null;
+    readonly actions: readonly string[];
+}
+/** The fixed id of the agent of a tool and model, so two runners reporting it at once create one. */
+export declare function runnerAgentId(tool: AgentTool, model: string): string;
 export interface AgentService {
-    list(options?: {
-        readonly includeArchived?: boolean;
-    }): Promise<Agent[]>;
-    /** 404 when absent. */
+    setIgnored(groups: readonly {
+        key: string;
+        expectedRevision: number;
+    }[], ignored: boolean): Promise<DiscoveryPreference[]>;
+    /** The agents not removed, by name. */
+    list(): Promise<Agent[]>;
+    /** 404 when absent or removed. */
     get(id: string): Promise<Agent>;
+    /** Any agent by id, a removed one included (runs name it), read on `conn`. */
     find(conn: DatabaseConnection, id: string): Promise<Agent | null>;
-    /** The agent when it can be given work (present and not archived), read on `conn`. */
+    /** The names of agents by id, removed ones included, read on `conn`. */
+    names(conn: DatabaseConnection, ids: readonly string[]): Promise<Map<string, string>>;
+    /** Every agent's name, removed ones and the application's own included, read on `conn`. */
+    directory(conn: DatabaseConnection): Promise<AgentName[]>;
+    /** The agent when it can be given work: enabled, with a tool and model, read on `conn`. */
     findWorkable(conn: DatabaseConnection, id: string): Promise<Agent | null>;
-    /** The agents not archived, by name, read on `conn`. */
+    /** The agents that can be given work, by name, read on `conn`. */
     listActive(conn: DatabaseConnection): Promise<Agent[]>;
-    create(createdById: string, input: AgentCreation): Promise<Agent>;
     /**
-     * Changes the fields `patch` names, as `byUserId`, when the agent is still at `patch.expectedRevision`: 409
-     * `REVISION_CONFLICT` with the current `metadata.revision` otherwise. A patch that changes
-     * nothing leaves the revision and the history alone.
+     * Changes what an agent discovered from runners is good at, its default effort or whether it is enabled, as
+     * `byUserId`, when it is still at `patch.expectedRevision`: 409 `REVISION_CONFLICT` with the current
+     * `metadata.revision` otherwise. Enabling needs a description (400 `GOOD_AT_REQUIRED`). The application's own agents
+     * are changed through the application (400 `AGENT_MANAGED`). A patch that changes nothing changes no revision.
      */
     update(id: string, byUserId: string | null, patch: AgentPatch): Promise<Agent>;
     /**
-     * Archived agents are not run: their queued runs are withdrawn now, and `agent.removed` is announced so the
-     * application lets go of the work it gave the agent.
+     * Keeps an agent of the application's own as `input` says, creating it the first time; enabled, and recorded in its
+     * history when something changed.
      */
-    archive(id: string, byUserId: string | null): Promise<Agent>;
-    restore(id: string, byUserId: string | null): Promise<Agent>;
+    ensureSystem(input: SystemAgentInput, byUserId?: string | null): Promise<Agent>;
     /**
-     * Deletes an archived agent with no open runs, its variables, skill attachments and history; its past runs stay.
-     * `CONFLICT` otherwise. Announces `agent.removed`.
+     * What `runner` reports, in the transaction of its report: an agent for each tool and model it has signed in that
+     * none is kept for yet (pending), and when the others were last reported.
      */
-    remove(id: string, byUserId: string | null): Promise<void>;
+    syncRunner(unit: Tx, runner: Runner): Promise<void>;
+    /** Where every discovered agent's instructions and business actions come from; returns what removes it. */
+    setDefaults(provider: () => AgentDefaults): () => void;
+    /** Writes the current defaults to every discovered agent that differs; answers how many changed. */
+    applyDefaults(options?: {
+        preserveInstructions?: boolean;
+    }): Promise<number>;
     /** The agent's history, newest first; with `afterRevision`, the changes made after that revision. 404 when absent. */
     history(id: string, options?: HistoryOptions): Promise<AgentChange[]>;
     /** Records in the agent's history, on `conn`, that one of its variables was added, changed or removed. */
@@ -57,7 +68,7 @@ export interface AgentService {
         readonly change: 'added' | 'changed' | 'removed';
         readonly byUserId: string | null;
     }): Promise<void>;
-    /** Whether `userId` may wake the agent. */
+    /** Whether work may be given to the agent: it is enabled, with a tool and model. Anyone may wake such an agent. */
     mayInvoke(agent: Agent, userId: string): boolean;
 }
 export interface AgentServiceDeps {
@@ -66,20 +77,17 @@ export interface AgentServiceDeps {
     readonly clock: Clock;
     /** Names of the people in the history. */
     readonly people: People;
-    /** The models online agents may use (the model gateway's catalog): one is saved only with a model offered now. */
-    readonly models: () => Promise<ModelCatalog>;
-    /** The agent types a business action may be given to (`AgentActionOption.types`); every type when undefined. */
-    readonly actionTypes?: (key: string) => readonly AgentType[] | undefined;
-    /** The agent's variables and runs: deleting it checks its open runs and clears its variables; archiving it withdraws its queued runs. */
+    /** The agent's runs: disabling it withdraws its queued runs. */
     readonly owned?: {
-        readonly openRuns: (conn: DatabaseConnection, agentId: string) => Promise<number>;
-        readonly clearVariables: (conn: DatabaseConnection, agentId: string) => Promise<void>;
         readonly withdrawQueued: (unit: Tx, agentId: string, byUserId: string | null) => Promise<void>;
     };
 }
-/** What creating an agent takes inside the server: the input, and a description's i18n reference a copy keeps. */
-export type AgentCreation = AgentInput & {
-    readonly descriptionText?: I18nText | null;
-};
+/** Whether work may be given to the agent: enabled, with at least one tool and model. */
+export declare function isWorkable(agent: Agent): boolean;
+/** The tools and models a runner reports signed in, normalized, each once. */
+export declare function reportedCombos(runner: Runner): {
+    readonly tool: AgentTool;
+    readonly model: string;
+}[];
 export declare function createAgentService(deps: AgentServiceDeps): AgentService;
 //# sourceMappingURL=agent.service.d.ts.map

package/dist/server/core/agents/agent.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"agent.service.d.ts","sourceRoot":"","sources":["../../../../server/core/agents/agent.service.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EASL,KAAK,KAAK,EACV,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,UAAU,EACf,KAAK,SAAS,EAGf,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAU,KAAK,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAOnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAOvD,OAAO,EAIL,KAAK,cAAc,EACpB,MAAM,oBAAoB,CAAC;AAiD5B;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,CAMxD,CAAC;AAoBL,sCAAsC;AACtC,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAiBjD,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAM/C,CAAC;AAEL,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACzE,uBAAuB;IACvB,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,CAAC,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAClE,sFAAsF;IACtF,YAAY,CAAC,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAC1E,wDAAwD;IACxD,UAAU,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACvD,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAClE;;;;OAIG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC,KAAK,CAAC,CAAC;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7D,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7D;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D,sHAAsH;IACtH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IACtE,0GAA0G;IAC1G,YAAY,CACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE;QACR,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;QACjD,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC,GACA,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,2CAA2C;IAC3C,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;CAClD;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,kHAAkH;IAClH,QAAQ,CAAC,MAAM,EAAE,MAAM,OAAO,CAAC,YAAY,CAAC,CAAC;IAC7C,gHAAgH;IAChH,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,SAAS,SAAS,EAAE,GAAG,SAAS,CAAC;IACzE,yIAAyI;IACzI,QAAQ,CAAC,KAAK,CAAC,EAAE;QACf,QAAQ,CAAC,QAAQ,EAAE,CACjB,IAAI,EAAE,kBAAkB,EACxB,OAAO,EAAE,MAAM,KACZ,OAAO,CAAC,MAAM,CAAC,CAAC;QACrB,QAAQ,CAAC,cAAc,EAAE,CACvB,IAAI,EAAE,kBAAkB,EACxB,OAAO,EAAE,MAAM,KACZ,OAAO,CAAC,IAAI,CAAC,CAAC;QACnB,QAAQ,CAAC,cAAc,EAAE,CACvB,IAAI,EAAE,EAAE,EACR,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GAAG,IAAI,KACpB,OAAO,CAAC,IAAI,CAAC,CAAC;KACpB,CAAC;CACH;AAED,kHAAkH;AAClH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG;IACvC,QAAQ,CAAC,eAAe,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC5C,CAAC;AAsJF,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,gBAAgB,GAAG,YAAY,CAyQvE"}
+{"version":3,"file":"agent.service.d.ts","sourceRoot":"","sources":["../../../../server/core/agents/agent.service.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAGL,KAAK,KAAK,EACV,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,UAAU,EAEf,KAAK,gBAAgB,EACtB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAGL,KAAK,mBAAmB,EACzB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAkB,KAAK,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACzE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAEnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEvD,OAAO,EAIL,KAAK,cAAc,EACpB,MAAM,oBAAoB,CAAC;AAc5B,sCAAsC;AACtC,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAkBjD,CAAC;AAEH,wGAAwG;AACxG,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAkBD,qGAAqG;AACrG,wBAAgB,aAAa,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAMpE;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,CACR,MAAM,EAAE,SAAS;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,EAAE,EAC5D,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAClC,uCAAuC;IACvC,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACzB,kCAAkC;IAClC,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAChC,8EAA8E;IAC9E,IAAI,CAAC,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAClE,wEAAwE;IACxE,KAAK,CACH,IAAI,EAAE,kBAAkB,EACxB,GAAG,EAAE,SAAS,MAAM,EAAE,GACrB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAChC,2FAA2F;IAC3F,SAAS,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAC1D,2FAA2F;IAC3F,YAAY,CAAC,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAC1E,kEAAkE;IAClE,UAAU,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACvD;;;;;OAKG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC,KAAK,CAAC,CAAC;IAClB;;;OAGG;IACH,YAAY,CACV,KAAK,EAAE,gBAAgB,EACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GACvB,OAAO,CAAC,KAAK,CAAC,CAAC;IAClB;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,2GAA2G;IAC3G,WAAW,CAAC,QAAQ,EAAE,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC;IACvD,oGAAoG;IACpG,aAAa,CAAC,OAAO,CAAC,EAAE;QAAE,oBAAoB,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7E,sHAAsH;IACtH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IACtE,0GAA0G;IAC1G,YAAY,CACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE;QACR,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;QACjD,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC,GACA,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,mHAAmH;IACnH,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;CAClD;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,gEAAgE;IAChE,QAAQ,CAAC,KAAK,CAAC,EAAE;QACf,QAAQ,CAAC,cAAc,EAAE,CACvB,IAAI,EAAE,EAAE,EACR,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GAAG,IAAI,KACpB,OAAO,CAAC,IAAI,CAAC,CAAC;KACpB,CAAC;CACH;AAiBD,yFAAyF;AACzF,wBAAgB,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAEhD;AAED,8EAA8E;AAC9E,wBAAgB,cAAc,CAC5B,MAAM,EAAE,MAAM,GACb;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,EAAE,CAKxD;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,gBAAgB,GAAG,YAAY,CAubvE"}