@cadraos/sdk 0.3.15 → 0.3.16-dev.0

package/dist/kanban/index.d.cts

@@ -1179,6 +1179,51 @@ interface ExecuteResponse {
     /** Initial status */
     status: ExecutionStatus;
 }
+/**
+ * Languages an agent message can be stored and rendered in.
+ */
+type AgentMessageLang = 'en' | 'es' | 'id';
+/**
+ * One saved agent message (e.g. `handoff.requested`), text per language.
+ */
+interface AgentMessage {
+    /** Lowercase dotted key, e.g. `chat.welcome` */
+    key: string;
+    /** Text per language; `en` is the fallback language */
+    text: Partial<Record<AgentMessageLang, string>>;
+    /** `{word}` placeholder names found in any language */
+    placeholders: string[];
+}
+/**
+ * Response of `client.agents.messages.list()`
+ */
+interface AgentMessageList {
+    /** The resolved agent (a team uuid resolves to its lead agent) */
+    agentUuid: string;
+    /** The agent's saved messages, sorted by key */
+    messages: AgentMessage[];
+    /** Every key the platform knows about, for pickers (saved or not) */
+    knownKeys: string[];
+}
+/**
+ * Options for `client.agents.messages.render()`
+ */
+interface AgentMessageRenderOptions {
+    /** Requested language; falls back to `en` server-side */
+    lang?: AgentMessageLang;
+    /** Values for `{word}` placeholders; unknown placeholders are left as-is */
+    vars?: Record<string, string | number>;
+}
+/**
+ * Response of `client.agents.messages.render()`
+ */
+interface AgentMessageRenderResult {
+    key: string;
+    /** The language actually rendered */
+    lang: AgentMessageLang;
+    /** Filled text, or `null` when the agent has no message for this key */
+    text: string | null;
+}
 
 /**
  * Image extraction utilities
@@ -3767,6 +3812,46 @@ interface StreamImagesResult {
     executionId: string;
 }
 
+/**
+ * Agent Messages Resource API (p13)
+ *
+ * Read-only access to an agent's saved messages (welcome, handoff, fallback
+ * copy, ...). Reached as `client.agents.messages`.
+ * - list(): the agent's saved messages + every known key
+ * - render(): one message filled with vars, in a language (falls back to en)
+ */
+
+declare class AgentMessagesAPI extends BaseResourceAPI {
+    constructor(http: HttpClient);
+    /**
+     * List an agent's saved messages and the known keys
+     *
+     * @param agentUuid - Agent UUID (a team UUID resolves to its lead agent)
+     *
+     * @example
+     * ```typescript
+     * const { messages, knownKeys } = await client.agents.messages.list('agent-uuid');
+     * ```
+     */
+    list(agentUuid: string): Promise<AgentMessageList>;
+    /**
+     * Render one message with placeholders filled
+     *
+     * Resolves with `text: null` when the agent has no message for the key.
+     * Throws `ValidationError` before any request when the key is not a
+     * lowercase dotted key (see `MESSAGE_KEY_PATTERN`).
+     *
+     * @example
+     * ```typescript
+     * const { text } = await client.agents.messages.render('agent-uuid', 'handoff.requested', {
+     *   lang: 'es',
+     *   vars: { agentName: 'Ana' },
+     * });
+     * ```
+     */
+    render(agentUuid: string, key: string, options?: AgentMessageRenderOptions): Promise<AgentMessageRenderResult>;
+}
+
 /**
  * Agents Resource API
  *
@@ -3782,6 +3867,8 @@ interface StreamImagesResult {
  */
 declare class AgentsAPI extends BaseResourceAPI {
     private readonly getStreamConfig;
+    /** Saved agent messages (p13): `list()` and `render()` */
+    readonly messages: AgentMessagesAPI;
     constructor(http: HttpClient, getStreamConfig: () => StreamConfig);
     /**
      * List all agents in the organization

package/dist/kanban/index.d.ts

@@ -1179,6 +1179,51 @@ interface ExecuteResponse {
     /** Initial status */
     status: ExecutionStatus;
 }
+/**
+ * Languages an agent message can be stored and rendered in.
+ */
+type AgentMessageLang = 'en' | 'es' | 'id';
+/**
+ * One saved agent message (e.g. `handoff.requested`), text per language.
+ */
+interface AgentMessage {
+    /** Lowercase dotted key, e.g. `chat.welcome` */
+    key: string;
+    /** Text per language; `en` is the fallback language */
+    text: Partial<Record<AgentMessageLang, string>>;
+    /** `{word}` placeholder names found in any language */
+    placeholders: string[];
+}
+/**
+ * Response of `client.agents.messages.list()`
+ */
+interface AgentMessageList {
+    /** The resolved agent (a team uuid resolves to its lead agent) */
+    agentUuid: string;
+    /** The agent's saved messages, sorted by key */
+    messages: AgentMessage[];
+    /** Every key the platform knows about, for pickers (saved or not) */
+    knownKeys: string[];
+}
+/**
+ * Options for `client.agents.messages.render()`
+ */
+interface AgentMessageRenderOptions {
+    /** Requested language; falls back to `en` server-side */
+    lang?: AgentMessageLang;
+    /** Values for `{word}` placeholders; unknown placeholders are left as-is */
+    vars?: Record<string, string | number>;
+}
+/**
+ * Response of `client.agents.messages.render()`
+ */
+interface AgentMessageRenderResult {
+    key: string;
+    /** The language actually rendered */
+    lang: AgentMessageLang;
+    /** Filled text, or `null` when the agent has no message for this key */
+    text: string | null;
+}
 
 /**
  * Image extraction utilities
@@ -3767,6 +3812,46 @@ interface StreamImagesResult {
     executionId: string;
 }
 
+/**
+ * Agent Messages Resource API (p13)
+ *
+ * Read-only access to an agent's saved messages (welcome, handoff, fallback
+ * copy, ...). Reached as `client.agents.messages`.
+ * - list(): the agent's saved messages + every known key
+ * - render(): one message filled with vars, in a language (falls back to en)
+ */
+
+declare class AgentMessagesAPI extends BaseResourceAPI {
+    constructor(http: HttpClient);
+    /**
+     * List an agent's saved messages and the known keys
+     *
+     * @param agentUuid - Agent UUID (a team UUID resolves to its lead agent)
+     *
+     * @example
+     * ```typescript
+     * const { messages, knownKeys } = await client.agents.messages.list('agent-uuid');
+     * ```
+     */
+    list(agentUuid: string): Promise<AgentMessageList>;
+    /**
+     * Render one message with placeholders filled
+     *
+     * Resolves with `text: null` when the agent has no message for the key.
+     * Throws `ValidationError` before any request when the key is not a
+     * lowercase dotted key (see `MESSAGE_KEY_PATTERN`).
+     *
+     * @example
+     * ```typescript
+     * const { text } = await client.agents.messages.render('agent-uuid', 'handoff.requested', {
+     *   lang: 'es',
+     *   vars: { agentName: 'Ana' },
+     * });
+     * ```
+     */
+    render(agentUuid: string, key: string, options?: AgentMessageRenderOptions): Promise<AgentMessageRenderResult>;
+}
+
 /**
  * Agents Resource API
  *
@@ -3782,6 +3867,8 @@ interface StreamImagesResult {
  */
 declare class AgentsAPI extends BaseResourceAPI {
     private readonly getStreamConfig;
+    /** Saved agent messages (p13): `list()` and `render()` */
+    readonly messages: AgentMessagesAPI;
     constructor(http: HttpClient, getStreamConfig: () => StreamConfig);
     /**
      * List all agents in the organization

package/dist/kanban/index.js

@@ -5410,13 +5410,69 @@ function executionCancelPath(executionId) {
   return `${EXECUTION_PATH}/${executionId}/cancel`;
 }
 
+// src/utils/message-key.ts
+var MESSAGE_KEY_PATTERN = /^[a-z][a-z0-9_]*(\.[a-z0-9_]+)+$/;
+function isValidMessageKey(key) {
+  return MESSAGE_KEY_PATTERN.test(key);
+}
+
+// src/resources/agent-messages.ts
+var AgentMessagesAPI = class extends BaseResourceAPI {
+  constructor(http) {
+    super(http, "/api/v1/agents");
+  }
+  /**
+   * List an agent's saved messages and the known keys
+   *
+   * @param agentUuid - Agent UUID (a team UUID resolves to its lead agent)
+   *
+   * @example
+   * ```typescript
+   * const { messages, knownKeys } = await client.agents.messages.list('agent-uuid');
+   * ```
+   */
+  async list(agentUuid) {
+    return this.httpGet(`/${agentUuid}/messages`);
+  }
+  /**
+   * Render one message with placeholders filled
+   *
+   * Resolves with `text: null` when the agent has no message for the key.
+   * Throws `ValidationError` before any request when the key is not a
+   * lowercase dotted key (see `MESSAGE_KEY_PATTERN`).
+   *
+   * @example
+   * ```typescript
+   * const { text } = await client.agents.messages.render('agent-uuid', 'handoff.requested', {
+   *   lang: 'es',
+   *   vars: { agentName: 'Ana' },
+   * });
+   * ```
+   */
+  async render(agentUuid, key, options = {}) {
+    if (!isValidMessageKey(key)) {
+      throw new ValidationError(`Invalid message key "${key}"`, [
+        { field: "key", message: "Must be a lowercase dotted key, e.g. chat.welcome" }
+      ]);
+    }
+    return this.httpPost(`/${agentUuid}/messages/render`, {
+      key,
+      ...options.lang ? { lang: options.lang } : {},
+      ...options.vars ? { vars: options.vars } : {}
+    });
+  }
+};
+
 // src/resources/agents.ts
 var AgentsAPI = class extends BaseResourceAPI {
   constructor(http, getStreamConfig) {
     super(http, "/api/v1/agents");
     this.getStreamConfig = getStreamConfig;
+    this.messages = new AgentMessagesAPI(http);
   }
   getStreamConfig;
+  /** Saved agent messages (p13): `list()` and `render()` */
+  messages;
   // ===== LIST Operations =====
   /**
    * List all agents in the organization