@newheap/platform-ai-chat 0.15.0 → 0.16.0

package/admin/index.d.ts

@@ -1,7 +1,7 @@
 import * as _angular_core from '@angular/core';
 import { OnInit } from '@angular/core';
 import * as _newheap_platform_ai_chat from '@newheap/platform-ai-chat';
-import { NhAssistantStore, NhAssistantError, ApplicationContext, ApplicationContextVersion, AdminAgent, ToolCatalogEntry, McpServer, RunCatalog, SetAgentStateRequest, AgentShadowMode, AgentSkillState, AgentShadowState, AssistantAutonomy, AgentEvaluation, AgentReplay, AgentEvaluationCost, AgentProposalFeedbackCategory, AgentFeedbackSummaryRow, AgentFeedbackItem, AgentFeedbackCategoryCount, StaleKind, AgentProposalFeedbackGroup, AgentSubjectType, AgentRunStatus, ɵnhAssistantCodeKeys as _nhAssistantCodeKeys, AgentRunHistoryItem, DataSkill, AgentRunConfiguration, DataTrigger, SkillComparison, DataSkillVersion, ɵNhAssistantPickerOption as _NhAssistantPickerOption, McpServerTestResult, McpConnectionsSummary, McpBuiltInAuthMode, McpCustomAuthMode, McpAuthMode, McpTransport, McpConnectionScope, McpHeadlessUse, McpDiscovery, McpToolEffect, McpTool } from '@newheap/platform-ai-chat';
+import { NhAssistantStore, NhAssistantError, ApplicationContext, ApplicationContextVersion, AdminAgent, ToolCatalogEntry, McpServer, RunCatalog, SetAgentStateRequest, AgentSkillState, AgentShadowMode, AgentShadowState, AssistantAutonomy, AssistantDataClassification, AgentEvaluation, AgentReplay, AgentEvaluationCost, AgentProposalFeedbackCategory, AgentFeedbackSummaryRow, AgentFeedbackItem, AgentFeedbackCategoryCount, StaleKind, AgentProposalFeedbackGroup, AgentSubjectType, AgentRunStatus, ɵnhAssistantCodeKeys as _nhAssistantCodeKeys, AgentRunHistoryItem, DataSkill, AgentRunConfiguration, DataTrigger, SkillComparison, DataSkillVersion, ɵNhAssistantPickerOption as _NhAssistantPickerOption, McpServerTestResult, McpConnectionsSummary, McpBuiltInAuthMode, McpCustomAuthMode, McpAuthMode, McpTransport, McpConnectionScope, McpHeadlessUse, McpDiscovery, McpTool, McpToolEffect } from '@newheap/platform-ai-chat';
 import { ɵNhAssistantRunNowAgent as _NhAssistantRunNowAgent } from '@newheap/platform-ai-chat/agent-runs';
 
 type NhAssistantAdminTab = 'context' | 'agents' | 'mcp-servers';
@@ -127,6 +127,11 @@ declare function skillNameKeys(agentId: string, skillId: string): string[];
  * themselves in the language triage reads; the screen shows a translation when there is one.
  */
 declare function skillDescriptionKeys(agentId: string, skillId: string): string[];
+/**
+ * The key of a warning about an agent or a skill that is saved and in effect but may not work as
+ * configured, such as `classification-not-permitted`; a code the screen does not know shows as sent.
+ */
+declare function warningKeys(kind: 'agent' | 'skill', code: string): string[];
 /** The key an application may translate an authorization policy's name with. */
 declare function policyKeys(policy: string | null | undefined): string[];
 /** A readable name for a dash-case id: `task-follow-up` reads "Task follow up". */
@@ -149,9 +154,17 @@ interface WorksOnSummary {
 }
 
 type AgentStateAction = SetAgentStateRequest['state'];
+/** A state change being entered, of the agent or one of its skills, with the state it changes from. */
+interface StateChange {
+    agentId: string;
+    skillId?: string;
+    state: AgentStateAction;
+    from: AdminAgent['runState'] | AgentSkillState['runState'];
+}
 /**
  * Agent administration: code agents (override, reset) and agents created here (edit, delete),
- * and for every agent its run state with pause, stop and resume, its shadow mode and that of each
+ * and for every agent and skill its run state with pause, switch off, stop and resume (switch on
+ * for one that is off), its shadow mode and that of each
  * skill, and the technical account of an agent that answers to one, each with an optional reason.
  * Editing opens `nh-assistant-admin-agent-editor`; the feedback action opens
  * `nh-assistant-agent-feedback-report` for the agent, the evaluation action of an agent with
@@ -214,11 +227,7 @@ declare class NhAssistantAdminAgentsComponent {
     } | null>;
     readonly busyAgentId: _angular_core.WritableSignal<string | null>;
     /** The state change whose reason is being entered, of the agent or one of its skills. */
-    readonly changingState: _angular_core.WritableSignal<{
-        agentId: string;
-        skillId?: string;
-        state: AgentStateAction;
-    } | null>;
+    readonly changingState: _angular_core.WritableSignal<StateChange | null>;
     /** The shadow mode change whose reason is being entered, of the agent or one of its skills. */
     readonly changingShadow: _angular_core.WritableSignal<{
         agentId: string;
@@ -258,6 +267,7 @@ declare class NhAssistantAdminAgentsComponent {
     readonly errorKeys: _angular_core.Signal<string[]>;
     readonly codeTextKeys: typeof codeTextKeys;
     readonly skillNameKeys: typeof skillNameKeys;
+    readonly warningKeys: typeof warningKeys;
     readonly skillDescriptionKeys: typeof skillDescriptionKeys;
     readonly policyKeys: typeof policyKeys;
     readonly readableId: typeof readableId;
@@ -280,8 +290,8 @@ declare class NhAssistantAdminAgentsComponent {
     hasRunConfiguration(agent: AdminAgent): boolean;
     /**
      * Whether the agent can be run now: it runs on its own, so it has a run configuration, it is
-     * neither stopped nor disabled in code, and the run catalog names what it can run on. The server
-     * decides the rest when the run starts.
+     * neither stopped nor disabled in code, and the run catalog names what it can run on. An agent
+     * that is off still runs for a person. The server decides the rest when the run starts.
      */
     canRunNow(agent: AdminAgent): boolean;
     /** Opens the run-now dialog of the agent. */
@@ -332,6 +342,13 @@ declare class NhAssistantAdminAgentsComponent {
     stateActions(agent: AdminAgent): AgentStateAction[];
     /** The state changes a skill allows. */
     skillActions(skill: AgentSkillState): AgentStateAction[];
+    /**
+     * The key of a state change's label, explanation or confirmation: making an agent or skill that is
+     * off active again switches it on, which replays nothing, unlike a resume.
+     */
+    stateKey(part: 'action' | 'explain' | 'confirm', from: string, action: AgentStateAction): string;
+    /** The explanation of a state change of one skill. */
+    skillStateExplainKey(change: StateChange): string;
     /** Opens the reason form of a state change of the agent or, with a skill, of that skill. */
     askState(agent: AdminAgent, state: AgentStateAction, skill?: AgentSkillState): void;
     /**
@@ -435,6 +452,7 @@ declare class NhAssistantAdminAgentEditorComponent {
     readonly id: string;
     readonly max = 20000;
     readonly autonomyLevels: readonly AssistantAutonomy[];
+    readonly classifications: readonly AssistantDataClassification[];
     readonly agentId: _angular_core.WritableSignal<string>;
     readonly displayName: _angular_core.WritableSignal<string>;
     readonly description: _angular_core.WritableSignal<string>;
@@ -442,6 +460,12 @@ declare class NhAssistantAdminAgentEditorComponent {
     readonly autonomy: _angular_core.WritableSignal<AssistantAutonomy>;
     /** How the agent is used: in the chat, on its own, or both. */
     readonly use: _angular_core.WritableSignal<AgentUse>;
+    /** A new agent takes its triggers at once; without it, it starts off until someone switches it on. */
+    readonly switchOnNow: _angular_core.WritableSignal<boolean>;
+    /** The model profile of an agent created here; empty uses the application's chat profile. */
+    readonly profile: _angular_core.WritableSignal<string>;
+    /** The classification of the model calls of an agent created here; `internal` when it has none. */
+    readonly dataClassification: _angular_core.WritableSignal<AssistantDataClassification>;
     readonly requiredPolicy: _angular_core.WritableSignal<string>;
     readonly toolSelectors: _angular_core.WritableSignal<string[]>;
     readonly mcpServerIds: _angular_core.WritableSignal<string[]>;
@@ -498,10 +522,17 @@ declare class NhAssistantAdminAgentEditorComponent {
     readonly knownTypes: _angular_core.Signal<string[]>;
     /** What the agent works on is edited here: an agent created here, while the run catalog is known. */
     readonly editsWorksOn: _angular_core.Signal<boolean>;
+    /** An agent created here chooses its profile from those the run catalog offers. */
+    readonly choosesProfile: _angular_core.Signal<boolean>;
+    /** The profiles the run catalog offers, and the agent's own when the catalog no longer lists it. */
+    readonly profileChoices: _angular_core.Signal<string[]>;
     /** Chosen object types without a type, and not the application either: the agent would work on nothing. */
     readonly worksOnMissing: _angular_core.Signal<boolean>;
     readonly tooManyTypes: _angular_core.Signal<boolean>;
     readonly policyKeys: typeof policyKeys;
+    readonly warningKeys: typeof warningKeys;
+    /** The warnings of the agent as it was saved, until this editor saves it again. */
+    readonly warnings: _angular_core.Signal<_newheap_platform_ai_chat.AssistantConfigurationWarning[]>;
     readonly valid: _angular_core.Signal<boolean>;
     readonly errorKeys: _angular_core.Signal<string[]>;
     readonly filteredTools: _angular_core.Signal<ToolCatalogEntry[]>;
@@ -845,6 +876,7 @@ declare class NhAssistantAgentRunConfigurationComponent implements OnInit {
     readonly id: string;
     readonly maxReason: 500;
     readonly skillNameKeys: typeof skillNameKeys;
+    readonly warningKeys: typeof warningKeys;
     readonly skillDescriptionKeys: typeof skillDescriptionKeys;
     readonly readableId: typeof readableId;
     readonly loading: _angular_core.WritableSignal<boolean>;
@@ -855,6 +887,8 @@ declare class NhAssistantAgentRunConfigurationComponent implements OnInit {
     readonly error: _angular_core.WritableSignal<NhAssistantError | null>;
     readonly errorKeys: _angular_core.Signal<string[]>;
     readonly saved: _angular_core.WritableSignal<string | null>;
+    /** The warnings of the skill that was just saved, shown with the saved message. */
+    readonly savedWarnings: _angular_core.WritableSignal<readonly string[]>;
     readonly form: _angular_core.WritableSignal<Form | null>;
     readonly confirming: _angular_core.WritableSignal<Confirmation | null>;
     readonly reason: _angular_core.WritableSignal<string>;
@@ -1036,12 +1070,35 @@ declare class NhAssistantAdminMcpServersComponent {
 type NhAssistantSecretAction = 'keep' | 'replace' | 'clear';
 /** Where the secret is: stored here, encrypted, or a reference to a secret of the application. */
 type NhAssistantSecretSource = 'stored' | 'reference';
+/**
+ * One reader as the editor shows it: the tool, the media types as typed (separated by commas, spaces
+ * or new lines), the highest classification and the priority as typed. `key` keeps a row's controls
+ * when another row is removed.
+ */
+interface NhAssistantReaderDraft {
+    key: number;
+    toolName: string;
+    mediaTypes: string;
+    maxClassification: AssistantDataClassification | '';
+    priority: string;
+}
+/** What is wrong with one reader before it is saved. */
+interface ReaderProblems {
+    types: boolean;
+    tool: boolean;
+    duplicate: boolean;
+    classification: boolean;
+    priority: boolean;
+}
 /**
  * Creates or edits one MCP server: the authentication with a write-only secret or a reference to
  * one, OAuth with discovery the administrator confirms, an optional client certificate, the
- * transport and the use in background runs. Every field stops at the length the server accepts; a
- * refused save shows each of the server's field errors at its field, for example a secret reference
- * the application cannot resolve (`not-found`), and moves the focus to the first of them.
+ * transport, the use in background runs and, for a server that exists, its readers: per reader the
+ * synced tool that turns files into text, the media types it reads, the highest classification that
+ * may be sent to it and its priority, with readers to add and remove. Every field stops at the length
+ * the server accepts; a refused save shows each of the server's field errors at its field, those of a
+ * reader at that reader (`readers[0].toolName`), for example a secret reference the application cannot
+ * resolve (`not-found`), and moves the focus to the first of them.
  */
 declare class NhAssistantAdminMcpServerEditorComponent {
     private readonly admin;
@@ -1050,6 +1107,7 @@ declare class NhAssistantAdminMcpServerEditorComponent {
     private subscription?;
     private discoverySubscription?;
     private modesSubscription?;
+    private toolsSubscription?;
     /** Fields whose server error the administrator changed since the refused save. */
     private readonly touched;
     /** The server to edit, or null for a new server. */
@@ -1080,6 +1138,7 @@ declare class NhAssistantAdminMcpServerEditorComponent {
     readonly transports: readonly McpTransport[];
     readonly secretSources: readonly NhAssistantSecretSource[];
     readonly connectionScopes: readonly McpConnectionScope[];
+    readonly classifications: readonly AssistantDataClassification[];
     readonly serverId: _angular_core.WritableSignal<string>;
     readonly displayName: _angular_core.WritableSignal<string>;
     readonly url: _angular_core.WritableSignal<string>;
@@ -1110,6 +1169,15 @@ declare class NhAssistantAdminMcpServerEditorComponent {
     readonly discovering: _angular_core.WritableSignal<boolean>;
     readonly discoveryError: _angular_core.WritableSignal<NhAssistantError | null>;
     readonly confirmAuthorization: _angular_core.WritableSignal<boolean>;
+    /** The readers of the server as the editor shows them, in their order. */
+    readonly readers: _angular_core.WritableSignal<readonly NhAssistantReaderDraft[]>;
+    readonly maxReaders = 16;
+    readonly readerPriority: {
+        readonly min: -1000;
+        readonly max: 1000;
+    };
+    /** The server's synced tools, which can read files; empty until they are loaded. */
+    readonly readerTools: _angular_core.WritableSignal<readonly McpTool[]>;
     readonly submitted: _angular_core.WritableSignal<boolean>;
     readonly saving: _angular_core.WritableSignal<boolean>;
     readonly error: _angular_core.WritableSignal<NhAssistantError | null>;
@@ -1161,6 +1229,13 @@ declare class NhAssistantAdminMcpServerEditorComponent {
     readonly certificateInvalid: _angular_core.Signal<boolean>;
     readonly oauthInvalid: _angular_core.Signal<boolean>;
     readonly headerNameInvalid: _angular_core.Signal<boolean>;
+    /** The tool names to choose from, keeping the stored tools the list no longer holds selectable. */
+    readonly readerToolNames: _angular_core.Signal<string[]>;
+    /** What is wrong with each reader, in the order of `readers`. */
+    readonly readerProblems: _angular_core.Signal<readonly ReaderProblems[]>;
+    /** Why a reader can or cannot be added: the server's tools are not synced, or it has the most. */
+    readonly readerAddHint: _angular_core.Signal<"nh-assistant.admin.server-editor.reader.tool-sync" | "nh-assistant.admin.server-editor.reader.limit" | "nh-assistant.admin.server-editor.reader.add-hint">;
+    readonly readerInvalid: _angular_core.Signal<boolean>;
     readonly valid: _angular_core.Signal<boolean>;
     readonly errorKeys: _angular_core.Signal<string[]>;
     /** The server's first error per field of the refused save, until the administrator changes the field. */
@@ -1179,6 +1254,17 @@ declare class NhAssistantAdminMcpServerEditorComponent {
     serverErrorKeys(field: string): string[];
     /** The id of a field's error, for `aria-describedby`. */
     errorId(field: string): string;
+    /** The name of a reader's field in the server's errors, such as `readers[0].toolName`. */
+    readerField(index: number, field: 'mediaTypes' | 'toolName' | 'maxClassification' | 'priority'): string;
+    /** Adds an empty reader at the end, at priority 0, and moves the focus to its tool. */
+    addReader(): void;
+    /**
+     * Removes a reader and moves the focus to the button that adds one; the server's errors of the
+     * readers no longer match their positions.
+     */
+    removeReader(index: number): void;
+    /** Changes one field of a reader as the administrator typed or chose it. */
+    updateReader(index: number, field: 'toolName' | 'mediaTypes' | 'maxClassification' | 'priority', value: string): void;
     /** The ids a control describes itself with: its hint and, while the server refused it, its error. */
     describedBy(hintId: string | null, field: string): string | null;
     /** The administrator changed a field; its server error no longer applies. */
@@ -1195,8 +1281,15 @@ declare class NhAssistantAdminMcpServerEditorComponent {
     discover(): void;
     save(): void;
     private focusFirstInvalid;
+    private focusById;
     private valueKeys;
+    /** Whether the editor shows a field error at a reader's own field. */
+    private showsReaderField;
+    /** The server's errors of the readers no longer apply once a reader is added or removed. */
+    private forgetReaderErrors;
     private reset;
+    /** The synced tools of an existing server, to choose the reading tool from. */
+    private loadReaderTools;
     /**
      * The OAuth settings as the editor shows them: every value is sent, so an emptied field clears the
      * stored value. The client secret is write-only: sent only when replaced.
@@ -1251,4 +1344,4 @@ declare class NhAssistantAdminMcpToolsComponent {
 }
 
 export { NH_ASSISTANT_MAX_INSTRUCTIONS, NhAssistantAdminAgentEditorComponent, NhAssistantAdminAgentsComponent, NhAssistantAdminComponent, NhAssistantAdminContextComponent, NhAssistantAdminMcpServerEditorComponent, NhAssistantAdminMcpServersComponent, NhAssistantAdminMcpToolsComponent, NhAssistantAgentEvaluationComponent, NhAssistantAgentFeedbackReportComponent, NhAssistantAgentRunConfigurationComponent, NhAssistantAgentRunHistoryComponent, nhAssistantSelectorMatches };
-export type { AgentUse, NhAssistantAdminTab, NhAssistantEvaluationPeriod, NhAssistantFeedbackPeriod, NhAssistantSecretAction, NhAssistantSecretSource, WorksOnScope };
+export type { AgentUse, NhAssistantAdminTab, NhAssistantEvaluationPeriod, NhAssistantFeedbackPeriod, NhAssistantReaderDraft, NhAssistantSecretAction, NhAssistantSecretSource, WorksOnScope };