@promptbook/utils
Version:
Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action
86 lines (85 loc) • 3.44 kB
TypeScript
/**
* Relative directory for an active TEAM conversation workspace.
*
* @private internal convention shared by the Agents Server and agent-folder runner
*/
export declare const AGENT_TEAM_CONVERSATIONS_DIRECTORY_PATH: string;
/**
* Relative directory where completed TEAM conversation transcripts are retained.
*
* @private internal convention shared by the Agents Server and agent-folder runner
*/
export declare const AGENT_FINISHED_TEAM_CONVERSATIONS_DIRECTORY_PATH: string;
/**
* Name of the JSON manifest that describes one TEAM conversation workspace.
*
* @private internal convention shared by the Agents Server and agent-folder runner
*/
export declare const AGENT_TEAM_CONVERSATION_MANIFEST_FILE_NAME = "team.json";
/**
* Name of the read-only teammate-source directory inside one TEAM workspace.
*
* @private internal convention shared by the Agents Server and agent-folder runner
*/
export declare const AGENT_TEAMMATE_SOURCES_DIRECTORY_NAME = "teammates";
/**
* One primary agent represented in a TEAM workspace manifest.
*
* @private internal convention shared by the Agents Server and agent-folder runner
*/
export type AgentTeamConversationPrimaryAgent = {
readonly permanentId: string;
readonly agentName: string;
};
/**
* One local teammate made available to the coding harness for a single user turn.
*
* @private internal convention shared by the Agents Server and agent-folder runner
*/
export type AgentTeamConversationTeammate = {
readonly permanentId: string;
readonly agentName: string;
readonly url: string;
readonly instructions: string;
readonly sourceFileName: string;
};
/**
* Persisted roster snapshot for the optional TEAM workspace of one queued message.
*
* @private internal convention shared by the Agents Server and agent-folder runner
*/
export type AgentTeamConversationWorkspaceManifest = {
readonly version: 1;
readonly primaryAgent: AgentTeamConversationPrimaryAgent;
readonly teammates: ReadonlyArray<AgentTeamConversationTeammate>;
};
/**
* Creates the stable directory name that belongs to one queued `.book` message.
*
* @private internal convention shared by the Agents Server and agent-folder runner
*/
export declare function createAgentTeamConversationWorkspaceDirectoryName(messageFileName: string): string;
/**
* Creates the relative active workspace path for one queued message.
*
* @private internal convention shared by the Agents Server and agent-folder runner
*/
export declare function createAgentTeamConversationWorkspacePath(messageFileName: string): string;
/**
* Creates the relative completed-workspace path for one queued message.
*
* @private internal convention shared by the Agents Server and agent-folder runner
*/
export declare function createFinishedAgentTeamConversationWorkspacePath(messageFileName: string): string;
/**
* Creates the source-snapshot file name for one teammate.
*
* @private internal convention shared by the Agents Server and agent-folder runner
*/
export declare function createAgentTeamTeammateSourceFileName(teammatePermanentId: string): string;
/**
* Checks whether unknown JSON has the minimum shape required for a TEAM workspace manifest.
*
* @private internal convention shared by the Agents Server and agent-folder runner
*/
export declare function isAgentTeamConversationWorkspaceManifest(value: unknown): value is AgentTeamConversationWorkspaceManifest;