@ziggs-ai/api-client 0.27.0 → 0.28.1

package/dist/capabilities/chat.js

@@ -33,9 +33,12 @@ export function presentSendResult(result, env) {
     const destination = delivery.broadcast
         ? 'the humans in the room, not one addressee'
         : `${delivery.to.id} (${delivery.to.type})`;
+    // What counted it, in the server's words: a stranger's free messages with a
+    // listed agent run out, and the person writing needs to know before they do.
+    const counted = result.coverage?.message ? ` ${result.coverage.message}` : '';
     return {
         ...base,
-        delivered: `Message ${result.messageId} was accepted into chat ${result.chatId}, addressed to ${destination}. Mailbox routing is unconfirmed; a person may be covered by an assistant. Accepted is not read and does not confirm a wake or reply.`,
+        delivered: `Message ${result.messageId} was accepted into chat ${result.chatId}, addressed to ${destination}. Mailbox routing is unconfirmed; a person may be covered by an assistant. Accepted is not read and does not confirm a wake or reply.${counted}`,
         to: delivery.to,
     };
 }
@@ -63,6 +66,7 @@ export const openConversationCapability = {
         participantIds: { type: 'array', items: { type: 'string' }, description: '1–20 known ids. Without chatId: people, for a separate group. With chatId: people or agents to invite into that room (an agent waits for the room\'s people to approve). Use instead of participantId. Each invitation is authorized separately.' },
         chatId: { type: 'string', description: 'Existing room to invite participantIds into. Never creates another room. Omit creation options and agreementId.' },
         idempotencyKey: { type: 'string', description: 'Required for group creation: a unique key for this conversation, reused unchanged on retries. A different participant set needs a new key.' },
+        name: { type: 'string', description: 'Name for a new group, 1–80 characters. Pair rooms and team channels take no name. A retry of the same idempotencyKey keeps the first name. Rename later is PATCH /chats/:chatId by someone who can admit people.' },
         createIfMissing: { type: 'boolean', description: 'Set false to reuse only an existing room for this acting agent and participant. A missing room is refused without creating a replacement.' },
         newChat: {
             type: 'boolean',
@@ -96,7 +100,10 @@ export const openConversationCapability = {
         else if (args.chatId || args.idempotencyKey) {
             throw new Error('chatId and idempotencyKey require participantIds');
         }
-        const { chatId, reused, invited } = await openConversation({
+        if (typeof args.name === 'string' && args.name.trim() && !Array.isArray(args.participantIds)) {
+            throw new Error('A name is for a new group. Pair rooms take no name; the person is the name.');
+        }
+        const { chatId, reused, invited, name } = await openConversation({
             ...(typeof args.participantId === 'string' ? { participantId: args.participantId } : {}),
             ...(Array.isArray(args.participantIds) ? { participantIds: args.participantIds } : {}),
             ...(typeof args.chatId === 'string' ? { chatId: args.chatId } : {}),
@@ -104,6 +111,7 @@ export const openConversationCapability = {
             ...(args.newChat === true ? { newChat: true } : {}),
             ...(typeof args.createIfMissing === 'boolean' ? { createIfMissing: args.createIfMissing } : {}),
             ...(typeof args.agreementId === 'string' && args.agreementId ? { agreementId: args.agreementId } : {}),
+            ...(typeof args.name === 'string' && args.name.trim() ? { name: args.name.trim() } : {}),
         }, fullCreds(env));
         const lister = env.surface === 'mcp' ? 'ziggs_grant_list' : 'grant_list';
         const grantNote = `Use ${lister} with scopeKind ["chat"] to inspect your room grants. Opening a conversation does not send a message or confirm that anyone has read it.`;
@@ -123,6 +131,7 @@ export const openConversationCapability = {
             chatId,
             actingAgentId: fullCreds(env).agentId,
             ...(typeof reused === 'boolean' ? { reused } : {}),
+            ...(name ? { name } : {}),
             ...(invited ? { invited } : {}),
             note: `${outcomeNote} ${grantNote}`,
         };

package/dist/engagementGuide.js

@@ -272,7 +272,7 @@ export function strangerBriefGuide(env, chatId) {
         kind: 'stranger_brief',
         outcome: 'pending',
         chatId,
-        summary: "A stranger's brief is not a work order. Draft an agreement; do not create a task under a hire you do not have.",
+        summary: "A stranger's brief is not a work order. They hire you through your store listing, or through an agreement you draft when you have none; do not create a task under a hire you do not have.",
         next: nextCall(env, 'agreement_request', undefined, 'draft the agreement this brief would ride', { definition: agreementRequestCapability }),
     };
 }

package/dist/http/ChatClient.d.ts

@@ -26,6 +26,8 @@ export interface OpenConversationInput {
     participantIds?: string[];
     chatId?: string;
     idempotencyKey?: string;
+    /** Name for a new group. Pair rooms take no name. */
+    name?: string;
     newChat?: boolean;
     agreementId?: string;
     createIfMissing?: boolean;
@@ -38,6 +40,7 @@ export declare function openConversation(participant: string | OpenConversationI
     chatId: string;
     reused?: boolean;
     invited?: ChatOpenInvite[];
+    name?: string;
 }>;
 export interface SendChatMessageInput {
     /**
@@ -93,7 +96,20 @@ export type { MessageDelivery } from '@ziggs-ai/contracts';
  */
 export type SendChatMessageResult = Omit<WireSendChatMessageResult, 'delivery'> & {
     delivery?: MessageDelivery;
+    /**
+     * What covers this message, when something counts it: a hire's shared
+     * allowance, or a listed agent's free messages for a stranger ("2 of 3 free
+     * messages used with seo-growth."). Absent for ordinary conversation.
+     */
+    coverage?: ConversationCoverageReceipt;
 };
+/** The server's receipt for a counted message. */
+export interface ConversationCoverageReceipt {
+    agreementId: string;
+    messagesUsed: number;
+    messageLimit: number | null;
+    message: string;
+}
 export type ContextTemporal = 'from-now' | 'from-start';
 export interface AddChatMemberInput {
     chatId: string;
@@ -145,6 +161,7 @@ export declare class ChatClient {
         chatId: string;
         reused?: boolean;
         invited?: ChatOpenInvite[];
+        name?: string;
     }>;
     addMember(input: AddChatMemberInput): Promise<AddChatMemberResult>;
     sendMessage(input: SendChatMessageInput): Promise<SendChatMessageResult>;

package/dist/http/ChatClient.js

@@ -38,15 +38,33 @@ export async function openConversation(participant, creds, { newChat = false, ag
     // the room — defaulting to false would report a reused conversation as fresh,
     // which is worse than saying nothing.
     const reused = data['reused'];
+    const name = data['name'];
     const invited = Array.isArray(data['invited'])
         ? data['invited']
         : undefined;
     return {
         chatId: data['chatId'],
         ...(typeof reused === 'boolean' ? { reused } : {}),
+        ...(typeof name === 'string' && name ? { name } : {}),
         ...(invited ? { invited } : {}),
     };
 }
+function coverageFrom(value) {
+    if (!value || typeof value !== 'object')
+        return null;
+    const row = value;
+    return typeof row['agreementId'] === 'string' &&
+        typeof row['message'] === 'string' &&
+        typeof row['messagesUsed'] === 'number' &&
+        (row['messageLimit'] === null || typeof row['messageLimit'] === 'number')
+        ? {
+            agreementId: row['agreementId'],
+            messagesUsed: row['messagesUsed'],
+            messageLimit: row['messageLimit'],
+            message: row['message'],
+        }
+        : null;
+}
 /**
  * POST /chats/:chatId/members — add user/agent; agent-invite may return pending admission.
  */
@@ -119,6 +137,7 @@ export async function sendChatMessage(input, creds) {
     }
     const data = (await res.json().catch(() => null));
     const delivery = data?.['delivery'];
+    const coverage = coverageFrom(data?.['coverage']);
     return {
         success: Boolean(data?.['success']),
         message: String(data?.['message'] ?? 'ok'),
@@ -130,6 +149,7 @@ export async function sendChatMessage(input, creds) {
         ...(delivery && typeof delivery === 'object'
             ? { delivery: delivery }
             : {}),
+        ...(coverage ? { coverage } : {}),
     };
 }
 export async function listMyChats(creds) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ziggs-ai/api-client",
-  "version": "0.27.0",
+  "version": "0.28.1",
   "description": "HTTP and WebSocket client for the Ziggs backend API",
   "type": "module",
   "main": "dist/index.js",