@ziggs-ai/api-client 0.17.1 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/capabilities/chat.js +2 -2
- package/dist/http/AgreementClient.d.ts +17 -0
- package/dist/http/AgreementClient.js +49 -1
- package/dist/http/ArtifactsClient.d.ts +11 -4
- package/dist/http/ChatClient.d.ts +14 -11
- package/dist/http/GrantsClient.d.ts +14 -14
- package/dist/http/InboxClient.d.ts +6 -1
- package/dist/http/InboxClient.js +14 -0
- package/dist/http/PaymentsClient.d.ts +36 -10
- package/dist/http/PaymentsClient.js +34 -8
- package/dist/http/TaskClient.d.ts +21 -0
- package/dist/http/grants.d.ts +17 -40
- package/dist/http/index.d.ts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/shared/operatorKey.d.ts +15 -4
- package/dist/shared/operatorKey.js +17 -6
- package/dist/types.d.ts +34 -73
- package/dist/types.js +1 -0
- package/package.json +2 -2
|
@@ -12,8 +12,8 @@ export const openConversationCapability = {
|
|
|
12
12
|
names: { sdk: 'chat_open', mcp: 'ziggs_chat_open' },
|
|
13
13
|
title: 'Open a chat',
|
|
14
14
|
descriptions: {
|
|
15
|
-
sdk: 'Open or reuse a chat with a user or agent participant. Calling it again for the same participant returns the SAME chat, so it is how you find the conversation you already have with someone — pass newChat only when this really is a separate subject. This is also how you reach the HUMAN who hired you when the work needs an answer only they have: pass their user id (context_snapshot lists it under users; on your agreement they are the payer/creator party), then chat_send in the chat it returns with no receiverId. Opening a room is issuing the other side access to it, so it needs something that authorizes that: they publish a listing, you share an org, you hold a live agreement with them (a link counts, so link_propose is how you get one with a peer in another org), or they claimed your invite. With none of those the call is refused and the refusal names the levers. To list chats you can already read, use grant_list scopeKind=chat.',
|
|
16
|
-
mcp: 'Open or reuse a chat with a user or agent participant. Calling it again for the same participant returns the SAME chat; pass newChat only when this really is a separate subject. Opening a room is issuing the other side access to it, so it needs something that authorizes that: they publish a listing, you share an org, you hold a live agreement with them (a link counts, so ziggs_link_propose is how you get one with a peer in another org), or they claimed your invite. With none of those the call is refused and names the levers.',
|
|
15
|
+
sdk: 'Open or reuse a chat with a user or agent participant. Calling it again for the same participant returns the SAME chat, so it is how you find the conversation you already have with someone — pass newChat only when this really is a separate subject. This is also how you reach the HUMAN who hired you when the work needs an answer only they have: pass their user id (context_snapshot lists it under users; on your agreement they are the payer/creator party), then chat_send in the chat it returns with no receiverId. Opening a room is issuing the other side access to it, so it needs something that authorizes that: they publish a listing, you share an org, you hold a live agreement with them (a link counts, so link_propose is how you get one with a peer in another org), or they claimed your invite. With none of those the call is refused and the refusal names the levers. When the person you cannot reach is somebody YOUR OWN PERSON already knows — their teammate, their partner, their customer — none of those levers is the right one: ask the person you work for to open a room with them and add you, in plain words in your conversation with them, then stop until you are in it. Claiming a listing or sending an invite is for a stranger you are doing business with, and using it on somebody your person could introduce you to in two clicks costs them a negotiation instead. To list chats you can already read, use grant_list scopeKind=chat.',
|
|
16
|
+
mcp: 'Open or reuse a chat with a user or agent participant. Calling it again for the same participant returns the SAME chat; pass newChat only when this really is a separate subject. Opening a room is issuing the other side access to it, so it needs something that authorizes that: they publish a listing, you share an org, you hold a live agreement with them (a link counts, so ziggs_link_propose is how you get one with a peer in another org), or they claimed your invite. With none of those the call is refused and names the levers. When the person you cannot reach is somebody your own person already knows — their teammate, their partner, their customer — ask that person to open a room with them and add you, rather than reaching for a listing or an invite: those are for strangers you are doing business with.',
|
|
17
17
|
},
|
|
18
18
|
annotation: 'write',
|
|
19
19
|
params: {
|
|
@@ -88,6 +88,23 @@ export declare function linkSummary(a: Agreement): Record<string, unknown>;
|
|
|
88
88
|
* Agreement field, so this narrows a document rather than returning a different
|
|
89
89
|
* shape.
|
|
90
90
|
*/
|
|
91
|
+
/**
|
|
92
|
+
* Lift the fields the wire nests, then summarise a link.
|
|
93
|
+
*
|
|
94
|
+
* `Agreement` offers `description`, `proposalStatus`, `lifecycle`,
|
|
95
|
+
* `expiresAt`, `maxExecutions` and `linkInvite` at the top level. The wire
|
|
96
|
+
* does not: it sends them under `terms` and `proposal`, and calls the seats
|
|
97
|
+
* `claimSeats`. This function is the only thing between the two and it used
|
|
98
|
+
* to map NONE of them, so every one of those reads answered `undefined` —
|
|
99
|
+
* silently, because the hand-written type promised they would be there.
|
|
100
|
+
*
|
|
101
|
+
* Filled here rather than by changing the type, because ~78 call sites across
|
|
102
|
+
* the SDK, ziggs-mcp and the agents read them at the top level. They keep
|
|
103
|
+
* reading them; they now get the value.
|
|
104
|
+
*
|
|
105
|
+
* The nested fields stay where the server put them. This adds a view, it does
|
|
106
|
+
* not move anything.
|
|
107
|
+
*/
|
|
91
108
|
export declare function shapeAgreement(a: Agreement): Agreement;
|
|
92
109
|
/** @deprecated Alias for {@link ProposeDirectInput}. */
|
|
93
110
|
export type ProposeAgreementData = ProposeDirectInput;
|
|
@@ -73,8 +73,56 @@ export function linkSummary(a) {
|
|
|
73
73
|
* Agreement field, so this narrows a document rather than returning a different
|
|
74
74
|
* shape.
|
|
75
75
|
*/
|
|
76
|
+
/**
|
|
77
|
+
* Lift the fields the wire nests, then summarise a link.
|
|
78
|
+
*
|
|
79
|
+
* `Agreement` offers `description`, `proposalStatus`, `lifecycle`,
|
|
80
|
+
* `expiresAt`, `maxExecutions` and `linkInvite` at the top level. The wire
|
|
81
|
+
* does not: it sends them under `terms` and `proposal`, and calls the seats
|
|
82
|
+
* `claimSeats`. This function is the only thing between the two and it used
|
|
83
|
+
* to map NONE of them, so every one of those reads answered `undefined` —
|
|
84
|
+
* silently, because the hand-written type promised they would be there.
|
|
85
|
+
*
|
|
86
|
+
* Filled here rather than by changing the type, because ~78 call sites across
|
|
87
|
+
* the SDK, ziggs-mcp and the agents read them at the top level. They keep
|
|
88
|
+
* reading them; they now get the value.
|
|
89
|
+
*
|
|
90
|
+
* The nested fields stay where the server put them. This adds a view, it does
|
|
91
|
+
* not move anything.
|
|
92
|
+
*/
|
|
76
93
|
export function shapeAgreement(a) {
|
|
77
|
-
|
|
94
|
+
const wire = a;
|
|
95
|
+
const lifted = {
|
|
96
|
+
...a,
|
|
97
|
+
...(wire.terms?.description != null
|
|
98
|
+
? { description: wire.terms.description }
|
|
99
|
+
: {}),
|
|
100
|
+
...(wire.terms?.lifecycle != null
|
|
101
|
+
? { lifecycle: wire.terms.lifecycle }
|
|
102
|
+
: {}),
|
|
103
|
+
...(wire.terms?.expiresAt != null
|
|
104
|
+
? { expiresAt: wire.terms.expiresAt }
|
|
105
|
+
: {}),
|
|
106
|
+
...(wire.terms?.maxExecutions != null
|
|
107
|
+
? { maxExecutions: wire.terms.maxExecutions }
|
|
108
|
+
: {}),
|
|
109
|
+
...(wire.proposal?.status != null
|
|
110
|
+
? { proposalStatus: wire.proposal.status }
|
|
111
|
+
: {}),
|
|
112
|
+
...(wire.claimSeats
|
|
113
|
+
? {
|
|
114
|
+
linkInvite: {
|
|
115
|
+
...(wire.claimSeats.maxClaims != null
|
|
116
|
+
? { maxClaims: wire.claimSeats.maxClaims }
|
|
117
|
+
: {}),
|
|
118
|
+
claimsUsed: wire.claimSeats.claimsUsed,
|
|
119
|
+
},
|
|
120
|
+
}
|
|
121
|
+
: {}),
|
|
122
|
+
};
|
|
123
|
+
return lifted.engagementKind === 'link'
|
|
124
|
+
? linkSummary(lifted)
|
|
125
|
+
: lifted;
|
|
78
126
|
}
|
|
79
127
|
export async function proposeAgreement(proposalData, creds) {
|
|
80
128
|
if (!proposalData)
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { ListReachableArtifactsResult } from '@ziggs-ai/contracts';
|
|
1
2
|
/**
|
|
2
3
|
* Inline `POST /artifacts` body cap (matches backend
|
|
3
4
|
* `ARTIFACT_PUBLIC_TEXT_MAX_CHARS`). Over this → file rail or multi-part; the
|
|
@@ -22,10 +23,16 @@ export interface ListArtifactsQuery {
|
|
|
22
23
|
*/
|
|
23
24
|
authoredBy?: 'me';
|
|
24
25
|
}
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
26
|
+
/**
|
|
27
|
+
* The reachable-artifact listing, as the server sends it.
|
|
28
|
+
*
|
|
29
|
+
* `truncated` was missing here, and it is the field that says the answer is
|
|
30
|
+
* incomplete — a caller typed against the old shape could not see that some
|
|
31
|
+
* sources were dropped, which is the same "short list read as a whole one"
|
|
32
|
+
* failure the grants rail names `unreadableRails` for. `artifacts` is also
|
|
33
|
+
* typed now, where it was `unknown[]`.
|
|
34
|
+
*/
|
|
35
|
+
export type ListArtifactsResult = ListReachableArtifactsResult;
|
|
29
36
|
export interface WriteArtifactInput {
|
|
30
37
|
text: string;
|
|
31
38
|
/** Short list name. An upload defaults to filename when omitted. */
|
|
@@ -1,15 +1,18 @@
|
|
|
1
|
+
import type { ChatReadDto } from '@ziggs-ai/contracts';
|
|
1
2
|
import type { SendChatMessageResult } from '@ziggs-ai/contracts';
|
|
2
3
|
import { type Creds } from '../types.js';
|
|
3
|
-
/**
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
4
|
+
/**
|
|
5
|
+
* One room from `GET /chats/mine`, as the server sends it.
|
|
6
|
+
*
|
|
7
|
+
* The backend answers `toChatReadDto(...)`, so this is that type rather than
|
|
8
|
+
* a restatement of it. The restatement had drifted both ways: it declared
|
|
9
|
+
* `orgId` and `isOrgChat`, neither of which the wire carries — a caller
|
|
10
|
+
* branching on `isOrgChat` was branching on `undefined` — and it omitted
|
|
11
|
+
* seven fields the wire does send, including `name`, `updatedAt` and
|
|
12
|
+
* `lastMessage`, which are the ones this list exists to let an agent triage
|
|
13
|
+
* with without a second call.
|
|
14
|
+
*/
|
|
15
|
+
export type ChatSummary = ChatReadDto;
|
|
13
16
|
export declare function openConversation(participantId: string, creds: Creds, { newChat, agreementId }?: {
|
|
14
17
|
newChat?: boolean;
|
|
15
18
|
agreementId?: string;
|
|
@@ -95,5 +98,5 @@ export declare class ChatClient {
|
|
|
95
98
|
}>;
|
|
96
99
|
addMember(input: AddChatMemberInput): Promise<AddChatMemberResult>;
|
|
97
100
|
sendMessage(input: SendChatMessageInput): Promise<SendChatMessageResult>;
|
|
98
|
-
listMine(): Promise<
|
|
101
|
+
listMine(): Promise<ChatReadDto[]>;
|
|
99
102
|
}
|
|
@@ -31,20 +31,20 @@ export interface ListGrantsQuery {
|
|
|
31
31
|
* presenting a short list as if it were complete). Replaces the client-side
|
|
32
32
|
* mirror of the backend scope table + JWT decode (the retired grantRails.ts).
|
|
33
33
|
*/
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
}
|
|
34
|
+
/**
|
|
35
|
+
* The wire's list, not this client's guess at it.
|
|
36
|
+
*
|
|
37
|
+
* This named three rails where the server has five, so a refusal on the
|
|
38
|
+
* `consent` or `inbox` rail did not typecheck as one — and the whole point of
|
|
39
|
+
* this field is that a short list must not read as an empty one.
|
|
40
|
+
*/
|
|
41
|
+
import type { UnreadableRail, ListGrantsResult } from '@ziggs-ai/contracts';
|
|
42
|
+
export type { UnreadableRail };
|
|
43
|
+
/**
|
|
44
|
+
* The unified grant listing. `unreadableRails` names the rails the caller
|
|
45
|
+
* could not read, so a short list is never mistaken for an empty one.
|
|
46
|
+
*/
|
|
47
|
+
export type { ListGrantsResult };
|
|
48
48
|
/**
|
|
49
49
|
* unified grant listing across every rail. `GET /grants` returns the
|
|
50
50
|
* canonical GrantView for each grant the caller holds (or, admin-gated, a named
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { InboxAckResult, InboxEnvelope, InboxReadOptions } from '../types.js';
|
|
1
|
+
import type { InboxAckResult, InboxEnvelope, InboxPeek, InboxReadOptions } from '../types.js';
|
|
2
2
|
/**
|
|
3
3
|
* The doorbell, not the door: references addressed to this agent
|
|
4
4
|
* since its last ack — never content. Flow: inbox → read → act → ack
|
|
@@ -21,6 +21,11 @@ export declare class InboxClient {
|
|
|
21
21
|
private headers;
|
|
22
22
|
private inboxUrl;
|
|
23
23
|
getInbox(opts?: InboxReadOptions): Promise<InboxEnvelope>;
|
|
24
|
+
/**
|
|
25
|
+
* Wait for assigned mail without taking the host lease.
|
|
26
|
+
* Still sends X-Ziggs-Instance; the server ignores it on this route.
|
|
27
|
+
*/
|
|
28
|
+
peek(opts?: InboxReadOptions): Promise<InboxPeek>;
|
|
24
29
|
/**
|
|
25
30
|
* Advance this agent's watermark — pass the envelope's `ackTo` plus every
|
|
26
31
|
* `resourceId` handled in `(priorAck, upTo]`. Monotonic
|
package/dist/http/InboxClient.js
CHANGED
|
@@ -56,6 +56,20 @@ export class InboxClient {
|
|
|
56
56
|
}
|
|
57
57
|
return JSON.parse(body);
|
|
58
58
|
}
|
|
59
|
+
/**
|
|
60
|
+
* Wait for assigned mail without taking the host lease.
|
|
61
|
+
* Still sends X-Ziggs-Instance; the server ignores it on this route.
|
|
62
|
+
*/
|
|
63
|
+
async peek(opts = {}) {
|
|
64
|
+
const res = await fetch(this.inboxUrl('/inbox/peek', opts), {
|
|
65
|
+
headers: this.headers(),
|
|
66
|
+
});
|
|
67
|
+
const body = await res.text().catch(() => '');
|
|
68
|
+
if (!res.ok) {
|
|
69
|
+
throw pollSurfaceError('InboxClient.peek', res, body);
|
|
70
|
+
}
|
|
71
|
+
return JSON.parse(body);
|
|
72
|
+
}
|
|
59
73
|
/**
|
|
60
74
|
* Advance this agent's watermark — pass the envelope's `ackTo` plus every
|
|
61
75
|
* `resourceId` handled in `(priorAck, upTo]`. Monotonic
|
|
@@ -14,14 +14,16 @@ export interface PaymentTransactionView {
|
|
|
14
14
|
transactionId?: string;
|
|
15
15
|
[key: string]: unknown;
|
|
16
16
|
}
|
|
17
|
-
/**
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
17
|
+
/**
|
|
18
|
+
* A resolved wallet reference (GET /payments/wallets/resolve).
|
|
19
|
+
*
|
|
20
|
+
* The wire's shape, not a guess at it. This was all-optional with no `orgId`,
|
|
21
|
+
* so a caller could not tell a wallet that has no org from one whose org the
|
|
22
|
+
* client forgot to declare — and every field being optional meant TypeScript
|
|
23
|
+
* agreed with any misreading of the response.
|
|
24
|
+
*/
|
|
25
|
+
import type { WalletRef } from '@ziggs-ai/contracts';
|
|
26
|
+
export type { WalletRef };
|
|
25
27
|
export type TransferResult = {
|
|
26
28
|
status: 'approval_required';
|
|
27
29
|
approvalId: string | null;
|
|
@@ -43,10 +45,18 @@ export interface ReleaseResult {
|
|
|
43
45
|
transaction?: PaymentTransactionView;
|
|
44
46
|
[key: string]: unknown;
|
|
45
47
|
}
|
|
48
|
+
/**
|
|
49
|
+
* A payment grant as this rail answers it.
|
|
50
|
+
*
|
|
51
|
+
* `parentGrantId` is `string | null`, which is what the wire sends — it was
|
|
52
|
+
* `string | undefined` here, so a root grant's explicit `null` did not match
|
|
53
|
+
* the declared type and `parentGrantId === undefined` was a test for "is this
|
|
54
|
+
* a root grant" that never passed.
|
|
55
|
+
*/
|
|
46
56
|
export interface PaymentGrantView {
|
|
47
57
|
grantId?: string;
|
|
48
58
|
holderId?: string;
|
|
49
|
-
parentGrantId?: string;
|
|
59
|
+
parentGrantId?: string | null;
|
|
50
60
|
caveats?: unknown[];
|
|
51
61
|
expiresAt?: string | null;
|
|
52
62
|
[key: string]: unknown;
|
|
@@ -75,6 +85,17 @@ export type WaitForApprovalResult = {
|
|
|
75
85
|
status: 'rejected' | 'expired' | 'timeout';
|
|
76
86
|
approval: PaymentApproval;
|
|
77
87
|
};
|
|
88
|
+
/**
|
|
89
|
+
* Who to pay on a transfer. Kind is declared by the caller — never inferred
|
|
90
|
+
* from id shape. A bare string is only a wallet id (`wal_…`).
|
|
91
|
+
*/
|
|
92
|
+
export type TransferPayee = string | {
|
|
93
|
+
walletId: string;
|
|
94
|
+
} | {
|
|
95
|
+
agentId: string;
|
|
96
|
+
} | {
|
|
97
|
+
userId: string;
|
|
98
|
+
};
|
|
78
99
|
/**
|
|
79
100
|
* the one payments client for every surface (agent-sdk, ziggs-mcp,
|
|
80
101
|
* scripts). Consolidates the former agent-sdk private ZiggsPayClient. Wallet
|
|
@@ -107,8 +128,13 @@ export declare class PaymentsClient {
|
|
|
107
128
|
userId?: string;
|
|
108
129
|
agentId?: string;
|
|
109
130
|
}): Promise<WalletRef | null>;
|
|
131
|
+
/**
|
|
132
|
+
* Resolve `transfer.to` to a wallet id. String form is wallet-only; agent /
|
|
133
|
+
* user payees must name their kind.
|
|
134
|
+
*/
|
|
135
|
+
private resolvePayeeWalletId;
|
|
110
136
|
transfer({ to, amount, idempotencyKey, description, paymentGrantId, agreementId, }: {
|
|
111
|
-
to:
|
|
137
|
+
to: TransferPayee;
|
|
112
138
|
amount: number;
|
|
113
139
|
idempotencyKey?: string;
|
|
114
140
|
description?: string;
|
|
@@ -61,20 +61,46 @@ export class PaymentsClient {
|
|
|
61
61
|
const res = (await this._get(`/payments/wallets/resolve?${params}`));
|
|
62
62
|
return res['wallet'] || null;
|
|
63
63
|
}
|
|
64
|
+
/**
|
|
65
|
+
* Resolve `transfer.to` to a wallet id. String form is wallet-only; agent /
|
|
66
|
+
* user payees must name their kind.
|
|
67
|
+
*/
|
|
68
|
+
async resolvePayeeWalletId(to) {
|
|
69
|
+
if (typeof to === 'string') {
|
|
70
|
+
const id = to.trim();
|
|
71
|
+
if (!id)
|
|
72
|
+
throw new Error('transfer: `to` is required');
|
|
73
|
+
if (id.startsWith('wal_'))
|
|
74
|
+
return id;
|
|
75
|
+
throw new Error('transfer: string `to` must be a wallet id (wal_…); pass { agentId } or { userId } for a principal');
|
|
76
|
+
}
|
|
77
|
+
if ('walletId' in to && typeof to.walletId === 'string' && to.walletId.trim()) {
|
|
78
|
+
return to.walletId.trim();
|
|
79
|
+
}
|
|
80
|
+
if ('agentId' in to && typeof to.agentId === 'string' && to.agentId.trim()) {
|
|
81
|
+
const w = await this.resolve({ agentId: to.agentId.trim() });
|
|
82
|
+
if (!w?.walletId) {
|
|
83
|
+
throw new Error(`transfer: could not resolve wallet for agent "${to.agentId}"`);
|
|
84
|
+
}
|
|
85
|
+
return w.walletId;
|
|
86
|
+
}
|
|
87
|
+
if ('userId' in to && typeof to.userId === 'string' && to.userId.trim()) {
|
|
88
|
+
const w = await this.resolve({ userId: to.userId.trim() });
|
|
89
|
+
if (!w?.walletId) {
|
|
90
|
+
throw new Error(`transfer: could not resolve wallet for user "${to.userId}"`);
|
|
91
|
+
}
|
|
92
|
+
return w.walletId;
|
|
93
|
+
}
|
|
94
|
+
throw new Error('transfer: `to` must be a wallet id (wal_…) or { walletId | agentId | userId }');
|
|
95
|
+
}
|
|
64
96
|
async transfer({ to, amount, idempotencyKey, description, paymentGrantId, agreementId, }) {
|
|
65
|
-
if (
|
|
97
|
+
if (to == null || to === '')
|
|
66
98
|
throw new Error('transfer: `to` is required');
|
|
67
99
|
if (!(Number.isInteger(amount) && amount > 0))
|
|
68
100
|
throw new Error('transfer: `amount` must be a positive integer (cents)');
|
|
69
101
|
// The recipient is resolved BEFORE choosing a grant: an `allowed_recipients`
|
|
70
102
|
// caveat cannot be checked against a name the client has not resolved yet.
|
|
71
|
-
|
|
72
|
-
if (!to.startsWith('wal_')) {
|
|
73
|
-
const w = await this.resolve(to.startsWith('agent_') ? { agentId: to } : { userId: to });
|
|
74
|
-
if (!w?.walletId)
|
|
75
|
-
throw new Error(`transfer: could not resolve wallet for "${to}"`);
|
|
76
|
-
toWalletId = w.walletId;
|
|
77
|
-
}
|
|
103
|
+
const toWalletId = await this.resolvePayeeWalletId(to);
|
|
78
104
|
// Choose the grant that covers this spend when the caller omitted one.
|
|
79
105
|
// An explicit id still wins — a caller who names a grant means it.
|
|
80
106
|
if (this.agentId && !paymentGrantId) {
|
|
@@ -72,6 +72,27 @@ export interface CreateTaskData {
|
|
|
72
72
|
waitsOn?: string[];
|
|
73
73
|
/** Atomically declare a native work graph beneath the returned root task. */
|
|
74
74
|
graph?: CreateTaskGraphData;
|
|
75
|
+
/**
|
|
76
|
+
* When the answer stops being useful, ISO 8601. At the deadline
|
|
77
|
+
* the holder posts what it has and where it is stuck, and stops. A deadline
|
|
78
|
+
* already past is refused server-side.
|
|
79
|
+
*/
|
|
80
|
+
dueAt?: string;
|
|
81
|
+
/**
|
|
82
|
+
* Reminder cadence and budget for work somebody has to be chased about
|
|
83
|
+
* Both halves are required together: a cadence with no budget is
|
|
84
|
+
* an open-ended wake loop, and one reminder is one wake, so the server
|
|
85
|
+
* refuses a half-filled rule rather than defaulting the missing half. Omit
|
|
86
|
+
* the whole object for a task nobody needs reminding about.
|
|
87
|
+
*/
|
|
88
|
+
checkBack?: CreateTaskCheckBackData;
|
|
89
|
+
}
|
|
90
|
+
/** See {@link CreateTaskData.checkBack}. */
|
|
91
|
+
export interface CreateTaskCheckBackData {
|
|
92
|
+
/** Minimum minutes between two reminders to the same person. */
|
|
93
|
+
everyMinutes: number;
|
|
94
|
+
/** Total reminders allowed per person asked, after the first ask. */
|
|
95
|
+
maxReminders: number;
|
|
75
96
|
}
|
|
76
97
|
export declare function createTask(taskData: CreateTaskData, creds: Creds): Promise<Task>;
|
|
77
98
|
export declare function getTask(taskId: string, creds: Creds): Promise<Task>;
|
package/dist/http/grants.d.ts
CHANGED
|
@@ -46,45 +46,22 @@ export declare const CONTEXT_GRANT_SCOPE_KINDS: readonly ["chat", "agreement", "
|
|
|
46
46
|
*/
|
|
47
47
|
export declare const GRANT_SCOPE_KINDS: readonly ["chat", "agreement", "org", "artifact", "task", "connection", "wallet", "consent", "inbox"];
|
|
48
48
|
export type GrantScopeKind = (typeof GRANT_SCOPE_KINDS)[number];
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
holderId: string;
|
|
67
|
-
parentGrantId: string | null;
|
|
68
|
-
agreementId: string | null;
|
|
69
|
-
scope: GrantScopeView;
|
|
70
|
-
caveats: GrantCaveatView[];
|
|
71
|
-
revoked: boolean;
|
|
72
|
-
/** ISO-8601, or null for no expiry. */
|
|
73
|
-
expiresAt: string | null;
|
|
74
|
-
/** ISO-8601. */
|
|
75
|
-
createdAt: string;
|
|
76
|
-
health: GrantHealth;
|
|
77
|
-
/**
|
|
78
|
-
* What the holder is, what the grant lets them do, and which consent object
|
|
79
|
-
* authorized it. Present on rails that record them (context grants do);
|
|
80
|
-
* absent means the rail does not say, not that there is nothing.
|
|
81
|
-
*/
|
|
82
|
-
holderKind?: GrantHolderKind;
|
|
83
|
-
access?: GrantAccessKind;
|
|
84
|
-
basis?: {
|
|
85
|
-
kind: GrantBasisKind;
|
|
86
|
-
id: string | null;
|
|
87
|
-
};
|
|
88
|
-
}
|
|
49
|
+
/**
|
|
50
|
+
* The scope a grant is over, and one caveat on it — the wire's shapes.
|
|
51
|
+
*
|
|
52
|
+
* `label` is populated only by the unified list read; the per-rail
|
|
53
|
+
* issue/delegate responses omit it, which is why the contract has it optional.
|
|
54
|
+
*/
|
|
55
|
+
export type { GrantScopeView, GrantCaveatView };
|
|
56
|
+
/**
|
|
57
|
+
* A grant row, exactly as the server sends it.
|
|
58
|
+
*
|
|
59
|
+
* Generated from the OpenAPI spec rather than restated here. Three copies of
|
|
60
|
+
* this shape lived in this package — this one, a looser one on
|
|
61
|
+
* `PaymentsClient`, and a third on `ConnectionsClient` — and each rail's
|
|
62
|
+
* client believed a different subset of the row.
|
|
63
|
+
*/
|
|
64
|
+
import type { GrantView, GrantScopeView, GrantCaveatView } from '@ziggs-ai/contracts';
|
|
65
|
+
export type { GrantView };
|
|
89
66
|
/** Value of the first caveat of `type` on a grant, or undefined. */
|
|
90
67
|
export declare function grantCaveat(grant: GrantView, type: string): unknown | undefined;
|
package/dist/http/index.d.ts
CHANGED
|
@@ -20,7 +20,7 @@ export type { ContextGrantRecord, ContextGrantScope, ContextGrantScopeKind, Cont
|
|
|
20
20
|
export { grantCaveat, CONTEXT_GRANT_SCOPE_KINDS, GRANT_SCOPE_KINDS, } from './grants.js';
|
|
21
21
|
export type { GrantView, GrantScopeKind, GrantScopeView, GrantCaveatView, GrantHealth, GrantHolderKind, GrantAccessKind, GrantBasisKind, } from './grants.js';
|
|
22
22
|
export { PaymentsClient } from './PaymentsClient.js';
|
|
23
|
-
export type { PaymentsError, WalletBalance, WalletRef, PaymentTransactionView, TransferResult, HoldResult, ReleaseResult, PaymentGrantView, PaymentGrantEnvelope, RevokeGrantResult, PaymentApproval, WaitForApprovalResult, } from './PaymentsClient.js';
|
|
23
|
+
export type { PaymentsError, WalletBalance, WalletRef, PaymentTransactionView, TransferPayee, TransferResult, HoldResult, ReleaseResult, PaymentGrantView, PaymentGrantEnvelope, RevokeGrantResult, PaymentApproval, WaitForApprovalResult, } from './PaymentsClient.js';
|
|
24
24
|
export { ConnectionsClient, assertNoLeakedConnectionSecret, } from './ConnectionsClient.js';
|
|
25
25
|
export type { ConnectionsError, ConnectionProxyParams, ConnectionGrant, ConnectionWithGrants, McpConnectionRequestParams, } from './ConnectionsClient.js';
|
|
26
26
|
export { fetchMyOrgs, resolveOrgSelector, fetchDelegateAccess, fetchHostedAgentAccess, fetchSessionAccess, } from './OrgsClient.js';
|
package/dist/index.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ export { runtimeLog, resetRuntimeLogLevelCache } from './shared/runtimeLog.js';
|
|
|
10
10
|
export { RateLimitedError, isRateLimited, parseRetryAfterMs, pollSurfaceError, } from './shared/rateLimit.js';
|
|
11
11
|
export { parseErrorMessage, parseErrorCode, throwApiError, } from './shared/apiError.js';
|
|
12
12
|
export { ApiError } from './types.js';
|
|
13
|
-
export type { Creds, Task, TaskState, PlanStep, PlanStepStatus, Agreement, AgreementParties, AgreementPartySide, EngagementKind, BroadcastAudience, EntryType, ContentType, MessageMetadata, MessageHandler, InboxDeliveryKind, InboxDeliveryRef, InboxChatNews, InboxProposalRef, InboxTaskRef, InboxRequestRef, InboxConnectionRequestRef, InboxHumanAttention, InboxEnvelope, InboxAckResult, InboxReadOptions, } from './types.js';
|
|
13
|
+
export type { Creds, Task, TaskState, PlanStep, PlanStepStatus, Agreement, AgreementParties, AgreementPartySide, EngagementKind, BroadcastAudience, EntryType, ContentType, MessageMetadata, MessageHandler, InboxDeliveryKind, InboxDeliveryRef, InboxChatNews, InboxProposalRef, InboxTaskRef, InboxRequestRef, InboxConnectionRequestRef, InboxHumanAttention, InboxEnvelope, InboxAckResult, InboxPeek, InboxReadOptions, } from './types.js';
|
|
14
14
|
export type { ProposeTerms, ProposeDirectInput, ProposeBroadcastInput, ProposeAgreementData, ClaimOptions, } from './http/AgreementClient.js';
|
|
15
15
|
export { agreementLaneId, agreementIdFromLane, isAgreementLaneId, isAgreementId } from '@ziggs-ai/contracts';
|
|
16
16
|
export * from './shared/operatorKey.js';
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { OPERATOR_KEY_ISSUED_VIA } from '@ziggs-ai/contracts';
|
|
1
2
|
/** JWT payload fields we read client-side (signature not verified — identity hint only). */
|
|
2
3
|
export interface OperatorKeyClaims {
|
|
3
4
|
type?: string;
|
|
@@ -14,10 +15,20 @@ export interface OperatorKeyClaims {
|
|
|
14
15
|
/** Decode operator JWT payload without verifying signature (boundAgentId). */
|
|
15
16
|
export declare function decodeOperatorKeyClaims(token: string): OperatorKeyClaims | null;
|
|
16
17
|
export declare function isOperatorKeyExpired(claims: OperatorKeyClaims | null): boolean;
|
|
17
|
-
/**
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
18
|
+
/**
|
|
19
|
+
* The stamps the two consent rails put on the tokens they mint.
|
|
20
|
+
*
|
|
21
|
+
* Re-exported from the contract rather than restated here. This file used to
|
|
22
|
+
* declare the two strings it cared about while the server's list had six, so
|
|
23
|
+
* a rail added there was invisible here until somebody remembered — and the
|
|
24
|
+
* predicate below decides which tool surface a connected assistant gets, so
|
|
25
|
+
* forgetting would have served the whole catalogue to the new rail's
|
|
26
|
+
* credentials.
|
|
27
|
+
*/
|
|
28
|
+
export declare const ISSUED_VIA_MCP_OAUTH: "mcp_oauth";
|
|
29
|
+
export declare const ISSUED_VIA_DEVICE_CODE: "device_code";
|
|
30
|
+
export { OPERATOR_KEY_ISSUED_VIA };
|
|
31
|
+
export type { OperatorKeyIssuedVia } from '@ziggs-ai/contracts';
|
|
21
32
|
/**
|
|
22
33
|
* Did a person board this credential through the connector directory?
|
|
23
34
|
*
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { OPERATOR_KEY_ISSUED_VIA, isDirectoryBoardedIssuedVia, } from '@ziggs-ai/contracts';
|
|
1
2
|
/** Decode operator JWT payload without verifying signature (boundAgentId). */
|
|
2
3
|
export function decodeOperatorKeyClaims(token) {
|
|
3
4
|
const trimmed = token.trim();
|
|
@@ -26,10 +27,19 @@ export function isOperatorKeyExpired(claims) {
|
|
|
26
27
|
return false;
|
|
27
28
|
return claims.exp * 1000 <= Date.now();
|
|
28
29
|
}
|
|
29
|
-
/**
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
30
|
+
/**
|
|
31
|
+
* The stamps the two consent rails put on the tokens they mint.
|
|
32
|
+
*
|
|
33
|
+
* Re-exported from the contract rather than restated here. This file used to
|
|
34
|
+
* declare the two strings it cared about while the server's list had six, so
|
|
35
|
+
* a rail added there was invisible here until somebody remembered — and the
|
|
36
|
+
* predicate below decides which tool surface a connected assistant gets, so
|
|
37
|
+
* forgetting would have served the whole catalogue to the new rail's
|
|
38
|
+
* credentials.
|
|
39
|
+
*/
|
|
40
|
+
export const ISSUED_VIA_MCP_OAUTH = OPERATOR_KEY_ISSUED_VIA.MCP_OAUTH;
|
|
41
|
+
export const ISSUED_VIA_DEVICE_CODE = OPERATOR_KEY_ISSUED_VIA.DEVICE_CODE;
|
|
42
|
+
export { OPERATOR_KEY_ISSUED_VIA };
|
|
33
43
|
/**
|
|
34
44
|
* Did a person board this credential through the connector directory?
|
|
35
45
|
*
|
|
@@ -52,8 +62,9 @@ export const ISSUED_VIA_DEVICE_CODE = 'device_code';
|
|
|
52
62
|
* is PERMITTED.
|
|
53
63
|
*/
|
|
54
64
|
export function isDirectoryBoarded(claims) {
|
|
55
|
-
|
|
56
|
-
|
|
65
|
+
// The set of boarding rails is the contract's, for the reason above: two
|
|
66
|
+
// copies of "which rails board an assistant" is how one of them goes stale.
|
|
67
|
+
return isDirectoryBoardedIssuedVia(claims?.issuedVia);
|
|
57
68
|
}
|
|
58
69
|
/** Routing hint only. Every request is still authenticated by the backend. */
|
|
59
70
|
export function isMcpOAuthDelegateSession(creds) {
|
package/dist/types.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { AgreementPartySide, AgreementParties, PrincipalPresentation, InboxDeliveryRef } from '@ziggs-ai/contracts';
|
|
1
2
|
import type { InboxRequestChannel } from '@ziggs-ai/contracts';
|
|
2
3
|
/**
|
|
3
4
|
* One failure shape for every HTTP client path.
|
|
@@ -102,6 +103,21 @@ export interface Task {
|
|
|
102
103
|
steps?: PlanStep[];
|
|
103
104
|
};
|
|
104
105
|
planReview?: unknown;
|
|
106
|
+
/**
|
|
107
|
+
* When the answer stops being useful. At this point the holder
|
|
108
|
+
* posts what it has and where it is stuck, and stops. Absent or null on a
|
|
109
|
+
* task nobody has to chase.
|
|
110
|
+
*/
|
|
111
|
+
dueAt?: string | null;
|
|
112
|
+
/**
|
|
113
|
+
* How often the holder may remind, and how many times at most.
|
|
114
|
+
* `everyMinutes` is a floor, not a schedule: remind later, never sooner.
|
|
115
|
+
* The budget is per person asked, after the first ask.
|
|
116
|
+
*/
|
|
117
|
+
checkBack?: {
|
|
118
|
+
everyMinutes: number;
|
|
119
|
+
maxReminders: number;
|
|
120
|
+
} | null;
|
|
105
121
|
history?: unknown[];
|
|
106
122
|
creatorIsYou?: boolean;
|
|
107
123
|
providerIsYou?: boolean;
|
|
@@ -119,30 +135,17 @@ export declare const AGREEMENT_ENGAGEMENT_KIND: {
|
|
|
119
135
|
};
|
|
120
136
|
export type EngagementKind = (typeof AGREEMENT_ENGAGEMENT_KIND)[keyof typeof AGREEMENT_ENGAGEMENT_KIND];
|
|
121
137
|
/**
|
|
122
|
-
* One side of an agreement.
|
|
138
|
+
* One side of an agreement, as the wire carries it.
|
|
123
139
|
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
140
|
+
* `principal` is the accountable person or org — never an agent. On `payer`
|
|
141
|
+
* and `proposedTo` it may instead hold a broadcast sentinel
|
|
142
|
+
* ({@link isBroadcastTarget}), in which case nobody has taken the side up yet.
|
|
143
|
+
* `actor` is the agent that performed on this side, null when the principal
|
|
144
|
+
* acted itself.
|
|
128
145
|
*/
|
|
129
|
-
export
|
|
130
|
-
/**
|
|
131
|
-
* The accountable person or org — never an agent. On `payer` and `proposedTo`
|
|
132
|
-
* this may instead hold a broadcast sentinel ({@link isBroadcastTarget}), in
|
|
133
|
-
* which case nobody has taken the side up yet.
|
|
134
|
-
*/
|
|
135
|
-
principal?: string | null;
|
|
136
|
-
/** The agent that performed on this side. Null when the principal acted itself. */
|
|
137
|
-
actor?: string | null;
|
|
138
|
-
}
|
|
146
|
+
export type { AgreementPartySide };
|
|
139
147
|
/** The four sides of an agreement, each {@link AgreementPartySide}. */
|
|
140
|
-
export
|
|
141
|
-
payer?: AgreementPartySide;
|
|
142
|
-
provider?: AgreementPartySide;
|
|
143
|
-
proposedTo?: AgreementPartySide;
|
|
144
|
-
creator?: AgreementPartySide;
|
|
145
|
-
}
|
|
148
|
+
export type { AgreementParties };
|
|
146
149
|
/** Both ids on one side, principal first, absent ones dropped. */
|
|
147
150
|
export declare function partySideIds(side: AgreementPartySide | null | undefined): string[];
|
|
148
151
|
/**
|
|
@@ -172,6 +175,8 @@ export interface AgreementApprovalEntry {
|
|
|
172
175
|
}
|
|
173
176
|
export interface Agreement {
|
|
174
177
|
agreementId: string;
|
|
178
|
+
parentAgreementId?: string | null;
|
|
179
|
+
rootAgreementId?: string | null;
|
|
175
180
|
description?: string;
|
|
176
181
|
status?: AgreementStatus;
|
|
177
182
|
engagementKind?: EngagementKind;
|
|
@@ -270,22 +275,7 @@ export declare const BROADCAST_TARGETS: readonly ["everyone", "org"];
|
|
|
270
275
|
export declare function isBroadcastTarget(id: string | null | undefined): boolean;
|
|
271
276
|
export { isPersonaFaceRef as isPersonaRef, isRoomBindingRef as isRoomPresentationRef, isPresentationRef as isOpaquePresentationRef, } from '@ziggs-ai/contracts';
|
|
272
277
|
/** Display + entitlement face for a principal on the message/roster wire. */
|
|
273
|
-
export
|
|
274
|
-
/** Public, non-addressable reference (`psn_*` or `rpb_*`). */
|
|
275
|
-
ref?: string;
|
|
276
|
-
persona: {
|
|
277
|
-
id: string;
|
|
278
|
-
name: string;
|
|
279
|
-
image?: string | null;
|
|
280
|
-
revision?: number;
|
|
281
|
-
};
|
|
282
|
-
mode: 'persona' | 'chain';
|
|
283
|
-
/** Present only when the viewer is entitled to resolve the subject. */
|
|
284
|
-
subject?: {
|
|
285
|
-
id: string;
|
|
286
|
-
type: 'user' | 'agent';
|
|
287
|
-
};
|
|
288
|
-
}
|
|
278
|
+
export type { PrincipalPresentation };
|
|
289
279
|
export interface MessageMetadata {
|
|
290
280
|
chatId: string;
|
|
291
281
|
/** Stable id for dedup across push + inbox catch-up. */
|
|
@@ -355,42 +345,8 @@ export interface InboxSourceRef {
|
|
|
355
345
|
partyId: string;
|
|
356
346
|
partyKind: InboxPartyKind;
|
|
357
347
|
}
|
|
358
|
-
/**
|
|
359
|
-
|
|
360
|
-
* it (a chat read, a task read) is where this agent's grants are enforced.
|
|
361
|
-
*
|
|
362
|
-
* "Mine to act on" is `assigneeId === my agent id`, nothing else. A row
|
|
363
|
-
* without my stamp is context I may read, never a wake and never mine to ack
|
|
364
|
-
* as handled.
|
|
365
|
-
*/
|
|
366
|
-
export interface InboxDeliveryRef {
|
|
367
|
-
kind: InboxDeliveryKind;
|
|
368
|
-
resourceId: string;
|
|
369
|
-
/** One emit, one id — copies of the same event collapse on this. */
|
|
370
|
-
eventId: string;
|
|
371
|
-
/** The mailbox this copy lives in. */
|
|
372
|
-
partyId: string;
|
|
373
|
-
partyKind: InboxPartyKind;
|
|
374
|
-
/** The ONE agent stamped to act; null when nothing has to. */
|
|
375
|
-
assigneeId: string | null;
|
|
376
|
-
/** The owner's human should see this. */
|
|
377
|
-
needsHuman: boolean;
|
|
378
|
-
chatId: string | null;
|
|
379
|
-
agreementId: string | null;
|
|
380
|
-
taskId: string | null;
|
|
381
|
-
/** Who wrote it. Never this agent — you are not woken by your own writes. */
|
|
382
|
-
actorId: string | null;
|
|
383
|
-
ts: string;
|
|
384
|
-
/**
|
|
385
|
-
* lifecycle hint when the server includes one (e.g.
|
|
386
|
-
* `connection_request_fulfilled`). Absent on ordinary doorbells / older servers.
|
|
387
|
-
*/
|
|
388
|
-
reason?: string | null;
|
|
389
|
-
/** MCP connection after a fulfilled first-hop request. */
|
|
390
|
-
connectionId?: string | null;
|
|
391
|
-
/** grant minted for this agent on fulfill. */
|
|
392
|
-
grantId?: string | null;
|
|
393
|
-
}
|
|
348
|
+
/** One delivery in a mailbox, as the wire carries it. */
|
|
349
|
+
export type { InboxDeliveryRef };
|
|
394
350
|
/** Message/artifact deliveries folded by chat, so you can open chats directly. */
|
|
395
351
|
export interface InboxChatNews {
|
|
396
352
|
chatId: string;
|
|
@@ -520,3 +476,8 @@ export interface InboxAckResult {
|
|
|
520
476
|
export interface InboxReadOptions {
|
|
521
477
|
waitSeconds?: number;
|
|
522
478
|
}
|
|
479
|
+
/** Count-only peek. Does not take the inbox host lease. */
|
|
480
|
+
export interface InboxPeek {
|
|
481
|
+
asOf: string;
|
|
482
|
+
count: number;
|
|
483
|
+
}
|
package/dist/types.js
CHANGED
|
@@ -47,6 +47,7 @@ export function partySideIds(side) {
|
|
|
47
47
|
* so widening the match to `principal` would hit an unrelated estate.
|
|
48
48
|
*/
|
|
49
49
|
export function partyActorIds(parties) {
|
|
50
|
+
// The wire always sends all four sides; a caller may still hand us nothing.
|
|
50
51
|
const p = parties ?? {};
|
|
51
52
|
return [
|
|
52
53
|
...new Set(AGREEMENT_PARTY_SIDES.map((name) => p[name]?.actor).filter((id) => typeof id === 'string' && id.length > 0)),
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ziggs-ai/api-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.18.0",
|
|
4
4
|
"description": "HTTP and WebSocket client for the Ziggs backend API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
30
|
"socket.io-client": "^4.7.0",
|
|
31
|
-
"@ziggs-ai/contracts": "^0.
|
|
31
|
+
"@ziggs-ai/contracts": "^0.7.1"
|
|
32
32
|
},
|
|
33
33
|
"keywords": [
|
|
34
34
|
"ziggs",
|