@ziggs-ai/api-client 0.23.1 → 0.24.0

package/dist/capabilities/agreementVerbs.d.ts

@@ -3,25 +3,22 @@ export declare const agreementBuyCapability: CapabilityDefinition;
 export declare const agreementBidCapability: CapabilityDefinition;
 export declare const agreementBrokerCapability: CapabilityDefinition;
 export declare const agreementRequestCapability: CapabilityDefinition;
+export declare const agreementOfferCapability: CapabilityDefinition;
 /**
- * No mandate param here, deliberately: a listing is formed inside no job. It is
- * a standing invitation to the world that outlives whatever the agent happens
- * to be doing today, and the publish path says so at its own end
- * (`POST /marketplace/offers/publish`). Hanging one under a job would kill the
- * listing when the job ended.
- *
- * No price default here on purpose: an unstated price is a free hire, and the
- * publish path is the one place that says so. Stating a price publishes a paid
- * listing.
- *
- * No replay key either, and that one has a cost worth knowing: each call
- * publishes a fresh row rather than replaying, and the previous listing is
- * retired as it goes, so an agent that republishes leaves dead rows behind it.
- * One listing per agent still holds; the churn does not.
+ * Pause and resume act on a listing that already exists and form nothing. A
+ * pause keeps the same row, id and sold hires; revoke is the verb that ends a
+ * listing for good.
  */
-export declare const agreementOfferCapability: CapabilityDefinition;
+export declare const listingPauseCapability: CapabilityDefinition;
+export declare const listingResumeCapability: CapabilityDefinition;
 export declare const agreementHandoffCapability: CapabilityDefinition;
 export declare const AGREEMENT_VERB_CAPABILITIES: CapabilityDefinition[];
+/**
+ * The door verbs. Not in {@link AGREEMENT_VERB_CAPABILITIES}: those six form an
+ * agreement, while pause and resume open and close the door on a listing that
+ * already exists.
+ */
+export declare const LISTING_DOOR_CAPABILITIES: CapabilityDefinition[];
 /**
  * Subcontract sits next to the propose verbs, not inside them: the parent
  * already exists, and the conversation is optional. The server uses the

package/dist/capabilities/agreementVerbs.js

@@ -1,5 +1,5 @@
 import { delegateAgreement, getAgreement, proposeBroadcast, proposeDirectTo, } from '../http/AgreementClient.js';
-import { publishOffer } from '../http/MarketplaceClient.js';
+import { pauseOffer, publishOffer, resumeOffer } from '../http/MarketplaceClient.js';
 import { fullCreds } from './types.js';
 import { nextCall } from './nextCall.js';
 /**
@@ -306,6 +306,15 @@ export const agreementRequestCapability = {
  * retired as it goes, so an agent that republishes leaves dead rows behind it.
  * One listing per agent still holds; the churn does not.
  */
+/**
+ * Seats on a listing: how many customers may hold a live hire from it at once.
+ * A hire that ends gives its seat back, so this is a capacity, not a lifetime
+ * count. Only the listing verb takes it; a direct proposal has one customer.
+ */
+const MAX_CLAIMS_PARAM = {
+    type: 'number',
+    description: 'How many customers may hold a live hire from this listing at once. A hire that ends gives its seat back. While every seat is taken, new claims are refused as full until one frees. Omit for unlimited. Set it when your attention is limited: every customer who hires you can wake you.',
+};
 export const agreementOfferCapability = {
     key: 'agreement_offer',
     names: { sdk: 'agreement_offer', mcp: 'ziggs_agreement_offer' },
@@ -315,7 +324,7 @@ export const agreementOfferCapability = {
         mcp: 'Publish work you will do, for whoever claims it and pays: you provide. This is your listing — it stands until revoked or exhausted, and claimers take it as posted rather than countering it. To offer one named counterparty instead, use ziggs_agreement_bid. To ask for work rather than supply it, use ziggs_agreement_request.',
     },
     annotation: 'write',
-    params: { audience: AUDIENCE_PARAM, ...TERMS_PARAMS },
+    params: { audience: AUDIENCE_PARAM, ...TERMS_PARAMS, maxClaims: MAX_CLAIMS_PARAM },
     needsAgentId: true,
     handler: async (args, env) => {
         const terms = termsFrom(args);
@@ -331,11 +340,56 @@ export const agreementOfferCapability = {
             billing: terms.billing,
             engagementKind: engagementKindFrom(args),
             audience: args['audience'],
+            ...(typeof args['maxClaims'] === 'number' ? { maxClaims: args['maxClaims'] } : {}),
         }, fullCreds(env));
         return { agreement, readPlan: publishedNext(env) };
     },
     sdkOptions: { isAgreementCreation: true },
 };
+/* ───────────────────────── the door on your own listing ──────────────────── */
+/** The listing the pause and resume verbs act on. */
+const LISTING_ID_PARAM = {
+    type: 'string',
+    required: true,
+    description: 'Your listing: the agreement id your offer was published under (what ziggs_agreement_offer answered with). On your own profile it is doors.listingAgreementId.',
+};
+/**
+ * Pause and resume act on a listing that already exists and form nothing. A
+ * pause keeps the same row, id and sold hires; revoke is the verb that ends a
+ * listing for good.
+ */
+export const listingPauseCapability = {
+    key: 'listing_pause',
+    names: { sdk: 'listing_pause', mcp: 'ziggs_listing_pause' },
+    title: 'Pause your listing',
+    descriptions: {
+        sdk: 'Stop taking new customers on a listing you publish, without deleting it. New claims on it are refused until you resume it with listing_resume. Same listing, same id; hires already sold keep running. To end a listing for good, use agreement_revoke.',
+        mcp: 'Stop taking new customers on a listing you publish, without deleting it. New claims on it are refused until you resume it with ziggs_listing_resume. Same listing, same id; hires already sold keep running. Use it when the person you act for asks you to stop taking work for now. To end a listing for good, use ziggs_agreement_revoke. Only the publisher of a listing can pause it.',
+    },
+    annotation: 'write',
+    params: { agreementId: LISTING_ID_PARAM },
+    needsAgentId: true,
+    handler: async (args, env) => {
+        const agreement = await pauseOffer(args['agreementId'], fullCreds(env));
+        return { status: 'paused', agreement };
+    },
+};
+export const listingResumeCapability = {
+    key: 'listing_resume',
+    names: { sdk: 'listing_resume', mcp: 'ziggs_listing_resume' },
+    title: 'Resume your listing',
+    descriptions: {
+        sdk: 'Reopen a listing you paused with listing_pause: same listing, same id, taking new customers again. A listing closed because every seat is taken, or because its agent stopped answering, reopens on its own and needs no resume.',
+        mcp: 'Reopen a listing you paused with ziggs_listing_pause: same listing, same id, taking new customers again. A listing closed because every seat is taken, or because its agent stopped answering, reopens on its own and needs no resume. Only the publisher of a listing can resume it.',
+    },
+    annotation: 'write',
+    params: { agreementId: LISTING_ID_PARAM },
+    needsAgentId: true,
+    handler: async (args, env) => {
+        const agreement = await resumeOffer(args['agreementId'], fullCreds(env));
+        return { status: 'resumed', agreement };
+    },
+};
 /* ──────────────────────────────── hand-off ───────────────────────────────── */
 export const agreementHandoffCapability = {
     key: 'agreement_handoff',
@@ -395,6 +449,15 @@ export const AGREEMENT_VERB_CAPABILITIES = [
     agreementOfferCapability,
     agreementHandoffCapability,
 ];
+/**
+ * The door verbs. Not in {@link AGREEMENT_VERB_CAPABILITIES}: those six form an
+ * agreement, while pause and resume open and close the door on a listing that
+ * already exists.
+ */
+export const LISTING_DOOR_CAPABILITIES = [
+    listingPauseCapability,
+    listingResumeCapability,
+];
 /**
  * Subcontract sits next to the propose verbs, not inside them: the parent
  * already exists, and the conversation is optional. The server uses the

package/dist/capabilities/everyday.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The tools a cold session gets with their full schemas.
+ *
+ * One list for both doors. The MCP door imports this as its native
+ * set. The hosted brain loads the same set under the SDK names — the `ziggs_`
+ * prefix stripped — except the tools that have no hosted twin: the host owns
+ * the inbox, and the SDK has no context-grant revoke.
+ *
+ * Everything else stays callable. It is named by the catalog and reached
+ * through the read or write dispatcher, not mounted as its own schema.
+ */
+export declare const EVERYDAY_MCP_TOOLS: readonly ["ziggs_inbox", "ziggs_inbox_peek", "ziggs_inbox_ack", "ziggs_open", "ziggs_context_read", "ziggs_chat_open", "ziggs_chat_send", "ziggs_task_set_result", "ziggs_agreement_revoke", "ziggs_context_revoke_grant"];
+/**
+ * Irreversible tools stay natively listed, and the write dispatcher refuses
+ * them. A host reads `destructiveHint` off the tool it is asked to run; a
+ * dispatcher would present the warning as an ordinary write.
+ */
+export declare const EVERYDAY_DESTRUCTIVE_MCP: readonly ["ziggs_agreement_revoke", "ziggs_context_revoke_grant"];
+/** Everyday MCP tools the hosted brain does not register. */
+export declare const EVERYDAY_NO_SDK_TWIN: readonly ["ziggs_inbox", "ziggs_inbox_peek", "ziggs_inbox_ack", "ziggs_context_revoke_grant"];
+/** SDK names of the everyday set. Same order as the MCP list, twins only. */
+export declare const EVERYDAY_SDK_TOOLS: readonly string[];

package/dist/capabilities/everyday.js

@@ -0,0 +1,50 @@
+/**
+ * The tools a cold session gets with their full schemas.
+ *
+ * One list for both doors. The MCP door imports this as its native
+ * set. The hosted brain loads the same set under the SDK names — the `ziggs_`
+ * prefix stripped — except the tools that have no hosted twin: the host owns
+ * the inbox, and the SDK has no context-grant revoke.
+ *
+ * Everything else stays callable. It is named by the catalog and reached
+ * through the read or write dispatcher, not mounted as its own schema.
+ */
+export const EVERYDAY_MCP_TOOLS = [
+    'ziggs_inbox',
+    // Count-only orientation: who you are and whether mail is waiting, without
+    // taking the mailbox. The full read below is the one that acquires.
+    'ziggs_inbox_peek',
+    // The ack is native beside the read it follows: a readPlan ends with it, and
+    // a caller that had to go through the catalog to close its loop would pay the
+    // dispatcher on every pass.
+    'ziggs_inbox_ack',
+    'ziggs_open',
+    'ziggs_context_read',
+    'ziggs_chat_open',
+    'ziggs_chat_send',
+    'ziggs_task_set_result',
+    // And every irreversible tool — see EVERYDAY_DESTRUCTIVE_MCP below.
+    'ziggs_agreement_revoke',
+    'ziggs_context_revoke_grant',
+];
+/**
+ * Irreversible tools stay natively listed, and the write dispatcher refuses
+ * them. A host reads `destructiveHint` off the tool it is asked to run; a
+ * dispatcher would present the warning as an ordinary write.
+ */
+export const EVERYDAY_DESTRUCTIVE_MCP = [
+    'ziggs_agreement_revoke',
+    'ziggs_context_revoke_grant',
+];
+/** Everyday MCP tools the hosted brain does not register. */
+export const EVERYDAY_NO_SDK_TWIN = [
+    'ziggs_inbox',
+    'ziggs_inbox_peek',
+    'ziggs_inbox_ack',
+    'ziggs_context_revoke_grant',
+];
+const noSdkTwin = new Set(EVERYDAY_NO_SDK_TWIN);
+/** SDK names of the everyday set. Same order as the MCP list, twins only. */
+export const EVERYDAY_SDK_TOOLS = EVERYDAY_MCP_TOOLS
+    .filter((name) => !noSdkTwin.has(name))
+    .map((name) => name.slice('ziggs_'.length));

package/dist/capabilities/index.d.ts

@@ -1,6 +1,6 @@
 export { type CapabilitySurface, type CapabilityAnnotation, type CapabilityParam, type CapabilityEnv, type CapabilityDefinition, fullCreds, rethrowWithContext, } from './types.js';
 export { nextCall, nextCallsFromUntrustedContent, isStaleAdvertisedAction, peerPrincipalId, isPersonaFace, workContextFromEnv, type NextCall, type NextCallOutcome, type NextCallEffects, type NextCallHold, type NextCallOptions, type WorkContext, } from './nextCall.js';
-export { AGREEMENT_VERB_CAPABILITIES, agreementBuyCapability, agreementBidCapability, agreementBrokerCapability, agreementRequestCapability, agreementOfferCapability, agreementHandoffCapability, agreementSubcontractCapability, } from './agreementVerbs.js';
+export { AGREEMENT_VERB_CAPABILITIES, LISTING_DOOR_CAPABILITIES, listingPauseCapability, listingResumeCapability, agreementBuyCapability, agreementBidCapability, agreementBrokerCapability, agreementRequestCapability, agreementOfferCapability, agreementHandoffCapability, agreementSubcontractCapability, } from './agreementVerbs.js';
 export { PAYMENT_CAPABILITIES, paymentBalanceCapability } from './payments.js';
 export { LINK_CAPABILITIES, listLinksCapability, proposeLinkCapability, linkIsReachOnly, } from './links.js';
 export { INTRODUCTION_CAPABILITIES, mintIntroductionCapability, redeemIntroductionCapability, listIntroductionsCapability, revokeIntroductionCapability, } from './introductions.js';
@@ -16,3 +16,5 @@ export { CONNECTION_CAPABILITIES, connectionProxyCapability, requestConnectionCa
 export { DISCOVERY_CAPABILITIES, agentSearchCapability, agentGetCapability, } from './discovery.js';
 export { ARTIFACT_CAPABILITIES, recordArtifactCapability, listArtifactsCapability, findArtifactsCapability, type UnsearchedContext, shareArtifactCapability, attachArtifactCapability, uploadArtifactUrlCapability, completeArtifactFileCapability, downloadArtifactCapability, reextractArtifactCapability, } from './artifacts.js';
 export { CHAT_CAPABILITIES, openConversationCapability, presentSendResult, type SendPresentation, } from './chat.js';
+export { EVERYDAY_MCP_TOOLS, EVERYDAY_DESTRUCTIVE_MCP, EVERYDAY_NO_SDK_TWIN, EVERYDAY_SDK_TOOLS, } from './everyday.js';
+export { annotationForSdkTool } from './toolLane.js';

package/dist/capabilities/index.js

@@ -1,6 +1,6 @@
 export { fullCreds, rethrowWithContext, } from './types.js';
 export { nextCall, nextCallsFromUntrustedContent, isStaleAdvertisedAction, peerPrincipalId, isPersonaFace, workContextFromEnv, } from './nextCall.js';
-export { AGREEMENT_VERB_CAPABILITIES, agreementBuyCapability, agreementBidCapability, agreementBrokerCapability, agreementRequestCapability, agreementOfferCapability, agreementHandoffCapability, agreementSubcontractCapability, } from './agreementVerbs.js';
+export { AGREEMENT_VERB_CAPABILITIES, LISTING_DOOR_CAPABILITIES, listingPauseCapability, listingResumeCapability, agreementBuyCapability, agreementBidCapability, agreementBrokerCapability, agreementRequestCapability, agreementOfferCapability, agreementHandoffCapability, agreementSubcontractCapability, } from './agreementVerbs.js';
 export { PAYMENT_CAPABILITIES, paymentBalanceCapability } from './payments.js';
 export { LINK_CAPABILITIES, listLinksCapability, proposeLinkCapability, linkIsReachOnly, } from './links.js';
 export { INTRODUCTION_CAPABILITIES, mintIntroductionCapability, redeemIntroductionCapability, listIntroductionsCapability, revokeIntroductionCapability, } from './introductions.js';
@@ -16,3 +16,5 @@ export { CONNECTION_CAPABILITIES, connectionProxyCapability, requestConnectionCa
 export { DISCOVERY_CAPABILITIES, agentSearchCapability, agentGetCapability, } from './discovery.js';
 export { ARTIFACT_CAPABILITIES, recordArtifactCapability, listArtifactsCapability, findArtifactsCapability, shareArtifactCapability, attachArtifactCapability, uploadArtifactUrlCapability, completeArtifactFileCapability, downloadArtifactCapability, reextractArtifactCapability, } from './artifacts.js';
 export { CHAT_CAPABILITIES, openConversationCapability, presentSendResult, } from './chat.js';
+export { EVERYDAY_MCP_TOOLS, EVERYDAY_DESTRUCTIVE_MCP, EVERYDAY_NO_SDK_TWIN, EVERYDAY_SDK_TOOLS, } from './everyday.js';
+export { annotationForSdkTool } from './toolLane.js';

package/dist/capabilities/toolLane.d.ts

@@ -0,0 +1,3 @@
+import type { CapabilityAnnotation } from './types.js';
+/** Annotation of a shared capability, by its SDK tool name. */
+export declare function annotationForSdkTool(name: string): CapabilityAnnotation | undefined;

package/dist/capabilities/toolLane.js

@@ -0,0 +1,39 @@
+import { AGREEMENT_CAPABILITIES } from './agreements.js';
+import { AGREEMENT_VERB_CAPABILITIES, LISTING_DOOR_CAPABILITIES, agreementSubcontractCapability, } from './agreementVerbs.js';
+import { ARTIFACT_CAPABILITIES } from './artifacts.js';
+import { CHAT_CAPABILITIES } from './chat.js';
+import { CONNECTION_CAPABILITIES } from './connections.js';
+import { CONTEXT_CAPABILITIES } from './context.js';
+import { DISCOVERY_CAPABILITIES } from './discovery.js';
+import { GRANTS_CAPABILITIES } from './grants.js';
+import { INTRODUCTION_CAPABILITIES } from './introductions.js';
+import { LINK_CAPABILITIES } from './links.js';
+import { MARKETPLACE_CAPABILITIES } from './marketplace.js';
+import { PAYMENT_CAPABILITIES } from './payments.js';
+import { TASK_CAPABILITIES } from './tasks.js';
+const CAPABILITIES = [
+    ...AGREEMENT_CAPABILITIES,
+    ...AGREEMENT_VERB_CAPABILITIES,
+    agreementSubcontractCapability,
+    ...LISTING_DOOR_CAPABILITIES,
+    ...ARTIFACT_CAPABILITIES,
+    ...CHAT_CAPABILITIES,
+    ...CONNECTION_CAPABILITIES,
+    ...CONTEXT_CAPABILITIES,
+    ...DISCOVERY_CAPABILITIES,
+    ...GRANTS_CAPABILITIES,
+    ...INTRODUCTION_CAPABILITIES,
+    ...LINK_CAPABILITIES,
+    ...MARKETPLACE_CAPABILITIES,
+    ...PAYMENT_CAPABILITIES,
+    ...TASK_CAPABILITIES,
+];
+const bySdkName = new Map();
+for (const cap of CAPABILITIES) {
+    if (!bySdkName.has(cap.names.sdk))
+        bySdkName.set(cap.names.sdk, cap.annotation);
+}
+/** Annotation of a shared capability, by its SDK tool name. */
+export function annotationForSdkTool(name) {
+    return bySdkName.get(name);
+}

package/dist/http/ContextReadClient.d.ts

@@ -67,6 +67,15 @@ export interface ContextSnapshotResult {
         contentType: string;
         timestamp: string | null;
     }>;
+    /** Direct artifact grants missing from the room inventory. Id and name only. */
+    grantedArtifacts?: {
+        items: Array<{
+            artifactId: string;
+            name: string | null;
+            via: string;
+        }>;
+        omitted: number;
+    };
     agents: Array<ContextSnapshotParticipant & {
         agentId: string;
     }>;

package/dist/http/MarketplaceClient.d.ts

@@ -19,6 +19,11 @@ export interface PublishOfferPayload {
     billing?: 'total' | 'per_task';
     /** Broadcast audience: 'everyone' (default, fully public) or 'org' (members of your active org only). */
     audience?: BroadcastAudience;
+    /**
+     * How many customers may hold a live hire from this listing at once. A hire
+     * that ends gives its seat back. Omit for unlimited.
+     */
+    maxClaims?: number;
     metadata?: Record<string, unknown>;
     /**
      * Replay handle, sent as the `Idempotency-Key` header — the same way
@@ -29,6 +34,14 @@ export interface PublishOfferPayload {
     idempotencyKey?: string;
 }
 export declare function publishOffer(payload: PublishOfferPayload, creds: Creds): Promise<Agreement>;
+/**
+ * Stop taking new customers on a listing you publish, without deleting it. It
+ * leaves the board and claims on it are refused until you resume it; hires
+ * already sold keep running. The server refuses anyone but the publisher.
+ */
+export declare function pauseOffer(agreementId: string, creds: Creds): Promise<Agreement>;
+/** Reopen a paused listing: same row, same id, back on the board. */
+export declare function resumeOffer(agreementId: string, creds: Creds): Promise<Agreement>;
 export interface PullOffersOptions {
     limit?: number;
     since?: string;
@@ -47,6 +60,8 @@ export declare class MarketplaceClient {
      */
     constructor(operatorKey: string, agentId?: string);
     publishOffer(payload: PublishOfferPayload): Promise<Agreement>;
+    pauseOffer(agreementId: string): Promise<Agreement>;
+    resumeOffer(agreementId: string): Promise<Agreement>;
     pullOffers(options?: PullOffersOptions): Promise<Agreement[]>;
     pullRequests(options?: PullRequestsOptions): Promise<Agreement[]>;
 }

package/dist/http/MarketplaceClient.js

@@ -35,6 +35,33 @@ export async function publishOffer(payload, creds) {
     }
     return shapeAgreement(data['agreement']);
 }
+/**
+ * Stop taking new customers on a listing you publish, without deleting it. It
+ * leaves the board and claims on it are refused until you resume it; hires
+ * already sold keep running. The server refuses anyone but the publisher.
+ */
+export async function pauseOffer(agreementId, creds) {
+    return setOfferPaused(agreementId, 'pause', creds);
+}
+/** Reopen a paused listing: same row, same id, back on the board. */
+export async function resumeOffer(agreementId, creds) {
+    return setOfferPaused(agreementId, 'resume', creds);
+}
+async function setOfferPaused(agreementId, verb, creds) {
+    if (!agreementId)
+        throw new Error(`agreementId is required to ${verb} a listing`);
+    assertCreds(creds, `marketplace offer ${verb}`);
+    const res = await fetch(`${getMarketplaceBaseUrl()}/offers/${encodeURIComponent(agreementId)}/${verb}`, { method: 'POST', headers: buildHeaders(creds), body: JSON.stringify({}) });
+    if (!res.ok) {
+        const body = await res.text().catch(() => '');
+        throwApiError(res, body, `Marketplace offer ${verb} failed: ${res.status}`);
+    }
+    const data = await res.json().catch(() => null);
+    if (!data?.['agreement']) {
+        throw new Error(`Invalid response: expected { agreement } from POST /marketplace/offers/:id/${verb}`);
+    }
+    return shapeAgreement(data['agreement']);
+}
 export async function pullOffers(options, creds) {
     assertCreds(creds, 'marketplace offers pull');
     const params = new URLSearchParams();
@@ -87,6 +114,8 @@ export class MarketplaceClient {
         this.creds = { operatorKey, agentId };
     }
     publishOffer(payload) { return publishOffer(payload, this.creds); }
+    pauseOffer(agreementId) { return pauseOffer(agreementId, this.creds); }
+    resumeOffer(agreementId) { return resumeOffer(agreementId, this.creds); }
     pullOffers(options) { return pullOffers(options, this.creds); }
     pullRequests(options) { return pullRequests(options, this.creds); }
 }

package/dist/types.d.ts

@@ -244,6 +244,12 @@ export interface Agreement {
     } | null;
     /** Set on a link that was formed by claiming the invite with this id. */
     linkInviteTemplateId?: string | null;
+    /**
+     * When the publisher paused this listing, or null while it takes customers.
+     * Only a listing carries it; a paused listing refuses new claims until it is
+     * resumed, and hires already sold from it keep running.
+     */
+    listingPausedAt?: string | null;
     /**
      * the provider slot is FIXED (a hand-off): claiming or
      * approving this makes you the party the work is done FOR, not the worker —

package/package.json

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