@pawabase/client 0.1.3 → 0.2.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/README.md +26 -14
- package/dist/cjs/admin.d.ts +70 -0
- package/dist/cjs/admin.d.ts.map +1 -1
- package/dist/cjs/admin.js +75 -1
- package/dist/cjs/admin.js.map +1 -1
- package/dist/cjs/agents.d.ts +87 -0
- package/dist/cjs/agents.d.ts.map +1 -0
- package/dist/cjs/agents.js +153 -0
- package/dist/cjs/agents.js.map +1 -0
- package/dist/cjs/ai.d.ts +78 -0
- package/dist/cjs/ai.d.ts.map +1 -0
- package/dist/cjs/ai.js +127 -0
- package/dist/cjs/ai.js.map +1 -0
- package/dist/cjs/auth.d.ts +38 -0
- package/dist/cjs/auth.d.ts.map +1 -1
- package/dist/cjs/auth.js +52 -0
- package/dist/cjs/auth.js.map +1 -1
- package/dist/cjs/client.d.ts +18 -3
- package/dist/cjs/client.d.ts.map +1 -1
- package/dist/cjs/client.js +30 -3
- package/dist/cjs/client.js.map +1 -1
- package/dist/cjs/data.d.ts +28 -0
- package/dist/cjs/data.d.ts.map +1 -1
- package/dist/cjs/data.js +42 -7
- package/dist/cjs/data.js.map +1 -1
- package/dist/cjs/errors.d.ts +1 -1
- package/dist/cjs/errors.d.ts.map +1 -1
- package/dist/cjs/errors.js +8 -1
- package/dist/cjs/errors.js.map +1 -1
- package/dist/cjs/functions.d.ts +0 -28
- package/dist/cjs/functions.d.ts.map +1 -1
- package/dist/cjs/functions.js +1 -42
- package/dist/cjs/functions.js.map +1 -1
- package/dist/cjs/index.d.ts +6 -2
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +6 -2
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/manage/access.d.ts +4 -62
- package/dist/cjs/manage/access.d.ts.map +1 -1
- package/dist/cjs/manage/access.js +4 -85
- package/dist/cjs/manage/access.js.map +1 -1
- package/dist/cjs/manage/agents.d.ts +76 -0
- package/dist/cjs/manage/agents.d.ts.map +1 -0
- package/dist/cjs/manage/agents.js +89 -0
- package/dist/cjs/manage/agents.js.map +1 -0
- package/dist/cjs/manage/ai.d.ts +90 -0
- package/dist/cjs/manage/ai.d.ts.map +1 -0
- package/dist/cjs/manage/ai.js +101 -0
- package/dist/cjs/manage/ai.js.map +1 -0
- package/dist/cjs/manage/base.d.ts +6 -16
- package/dist/cjs/manage/base.d.ts.map +1 -1
- package/dist/cjs/manage/base.js +11 -11
- package/dist/cjs/manage/base.js.map +1 -1
- package/dist/cjs/manage/data.d.ts +14 -16
- package/dist/cjs/manage/data.d.ts.map +1 -1
- package/dist/cjs/manage/data.js +15 -22
- package/dist/cjs/manage/data.js.map +1 -1
- package/dist/cjs/manage/files.d.ts +5 -0
- package/dist/cjs/manage/files.d.ts.map +1 -1
- package/dist/cjs/manage/files.js +10 -1
- package/dist/cjs/manage/files.js.map +1 -1
- package/dist/cjs/manage/index.d.ts +11 -10
- package/dist/cjs/manage/index.d.ts.map +1 -1
- package/dist/cjs/manage/index.js +15 -12
- package/dist/cjs/manage/index.js.map +1 -1
- package/dist/cjs/manage/lifecycle.d.ts +15 -38
- package/dist/cjs/manage/lifecycle.d.ts.map +1 -1
- package/dist/cjs/manage/lifecycle.js +21 -52
- package/dist/cjs/manage/lifecycle.js.map +1 -1
- package/dist/cjs/manage/mail.d.ts +12 -2
- package/dist/cjs/manage/mail.d.ts.map +1 -1
- package/dist/cjs/manage/mail.js +12 -1
- package/dist/cjs/manage/mail.js.map +1 -1
- package/dist/cjs/manage/observe.d.ts +6 -0
- package/dist/cjs/manage/observe.d.ts.map +1 -1
- package/dist/cjs/manage/observe.js +8 -2
- package/dist/cjs/manage/observe.js.map +1 -1
- package/dist/cjs/types.d.ts +3 -3
- package/dist/cjs/types.d.ts.map +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/admin.d.ts +70 -0
- package/dist/esm/admin.d.ts.map +1 -1
- package/dist/esm/admin.js +72 -0
- package/dist/esm/admin.js.map +1 -1
- package/dist/esm/agents.d.ts +87 -0
- package/dist/esm/agents.d.ts.map +1 -0
- package/dist/esm/agents.js +148 -0
- package/dist/esm/agents.js.map +1 -0
- package/dist/esm/ai.d.ts +78 -0
- package/dist/esm/ai.d.ts.map +1 -0
- package/dist/esm/ai.js +123 -0
- package/dist/esm/ai.js.map +1 -0
- package/dist/esm/auth.d.ts +38 -0
- package/dist/esm/auth.d.ts.map +1 -1
- package/dist/esm/auth.js +52 -0
- package/dist/esm/auth.js.map +1 -1
- package/dist/esm/client.d.ts +18 -3
- package/dist/esm/client.d.ts.map +1 -1
- package/dist/esm/client.js +31 -4
- package/dist/esm/client.js.map +1 -1
- package/dist/esm/data.d.ts +28 -0
- package/dist/esm/data.d.ts.map +1 -1
- package/dist/esm/data.js +42 -7
- package/dist/esm/data.js.map +1 -1
- package/dist/esm/errors.d.ts +1 -1
- package/dist/esm/errors.d.ts.map +1 -1
- package/dist/esm/errors.js +8 -1
- package/dist/esm/errors.js.map +1 -1
- package/dist/esm/functions.d.ts +0 -28
- package/dist/esm/functions.d.ts.map +1 -1
- package/dist/esm/functions.js +0 -40
- package/dist/esm/functions.js.map +1 -1
- package/dist/esm/index.d.ts +6 -2
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +3 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/manage/access.d.ts +4 -62
- package/dist/esm/manage/access.d.ts.map +1 -1
- package/dist/esm/manage/access.js +3 -83
- package/dist/esm/manage/access.js.map +1 -1
- package/dist/esm/manage/agents.d.ts +76 -0
- package/dist/esm/manage/agents.d.ts.map +1 -0
- package/dist/esm/manage/agents.js +82 -0
- package/dist/esm/manage/agents.js.map +1 -0
- package/dist/esm/manage/ai.d.ts +90 -0
- package/dist/esm/manage/ai.d.ts.map +1 -0
- package/dist/esm/manage/ai.js +97 -0
- package/dist/esm/manage/ai.js.map +1 -0
- package/dist/esm/manage/base.d.ts +6 -16
- package/dist/esm/manage/base.d.ts.map +1 -1
- package/dist/esm/manage/base.js +11 -11
- package/dist/esm/manage/base.js.map +1 -1
- package/dist/esm/manage/data.d.ts +14 -16
- package/dist/esm/manage/data.d.ts.map +1 -1
- package/dist/esm/manage/data.js +14 -19
- package/dist/esm/manage/data.js.map +1 -1
- package/dist/esm/manage/files.d.ts +5 -0
- package/dist/esm/manage/files.d.ts.map +1 -1
- package/dist/esm/manage/files.js +10 -1
- package/dist/esm/manage/files.js.map +1 -1
- package/dist/esm/manage/index.d.ts +11 -10
- package/dist/esm/manage/index.d.ts.map +1 -1
- package/dist/esm/manage/index.js +18 -15
- package/dist/esm/manage/index.js.map +1 -1
- package/dist/esm/manage/lifecycle.d.ts +15 -38
- package/dist/esm/manage/lifecycle.d.ts.map +1 -1
- package/dist/esm/manage/lifecycle.js +19 -50
- package/dist/esm/manage/lifecycle.js.map +1 -1
- package/dist/esm/manage/mail.d.ts +12 -2
- package/dist/esm/manage/mail.d.ts.map +1 -1
- package/dist/esm/manage/mail.js +13 -2
- package/dist/esm/manage/mail.js.map +1 -1
- package/dist/esm/manage/observe.d.ts +6 -0
- package/dist/esm/manage/observe.d.ts.map +1 -1
- package/dist/esm/manage/observe.js +8 -2
- package/dist/esm/manage/observe.js.map +1 -1
- package/dist/esm/types.d.ts +3 -3
- package/dist/esm/types.d.ts.map +1 -1
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/package.json +2 -2
- package/src/admin.ts +104 -0
- package/src/agents.ts +184 -0
- package/src/ai.ts +164 -0
- package/src/auth.ts +70 -0
- package/src/client.ts +31 -4
- package/src/data.ts +52 -5
- package/src/errors.ts +6 -1
- package/src/functions.ts +0 -49
- package/src/index.ts +6 -1
- package/src/manage/access.ts +3 -96
- package/src/manage/agents.ts +98 -0
- package/src/manage/ai.ts +129 -0
- package/src/manage/base.ts +11 -11
- package/src/manage/data.ts +15 -20
- package/src/manage/files.ts +12 -1
- package/src/manage/index.ts +18 -15
- package/src/manage/lifecycle.ts +20 -64
- package/src/manage/mail.ts +16 -2
- package/src/manage/observe.ts +9 -2
- package/src/types.ts +3 -3
- package/src/version.ts +1 -1
- package/dist/cjs/manage/functions.d.ts +0 -48
- package/dist/cjs/manage/functions.d.ts.map +0 -1
- package/dist/cjs/manage/functions.js +0 -61
- package/dist/cjs/manage/functions.js.map +0 -1
- package/dist/esm/manage/functions.d.ts +0 -48
- package/dist/esm/manage/functions.d.ts.map +0 -1
- package/dist/esm/manage/functions.js +0 -57
- package/dist/esm/manage/functions.js.map +0 -1
- package/src/manage/functions.ts +0 -69
package/dist/esm/admin.d.ts
CHANGED
|
@@ -61,6 +61,23 @@ export declare class Users extends AdminService {
|
|
|
61
61
|
deleteUser(userId: string): Promise<Api>;
|
|
62
62
|
/** The user's recent sign-ins and security events. */
|
|
63
63
|
history(userId: string): Promise<Api>;
|
|
64
|
+
/** What the user did over the last `weeks` weeks (at most 53): counts per day by kind (`signin`, `account`, `request`), totals, and a
|
|
65
|
+
* summary (last seen, failures, busiest hour, most used routes). */
|
|
66
|
+
activity(userId: string, options?: {
|
|
67
|
+
weeks?: number;
|
|
68
|
+
}): Promise<Api>;
|
|
69
|
+
/** The user's sign-ins, account changes and requests in one feed, newest first. `type`: `signin`, `account` or `request`.
|
|
70
|
+
* Pass the answer's `next_before` as `before` for the next page. */
|
|
71
|
+
timeline(userId: string, options?: {
|
|
72
|
+
type?: "signin" | "account" | "request";
|
|
73
|
+
limit?: number;
|
|
74
|
+
before?: string;
|
|
75
|
+
}): Promise<Api>;
|
|
76
|
+
/** Everything the auth service holds about the user, as JSON (a data-access request). Records that the request was handled.
|
|
77
|
+
* Rows in your own tables are not included: they are your application's to export. */
|
|
78
|
+
exportData(userId: string): Promise<Api>;
|
|
79
|
+
/** Delete the user and clear everything that could identify them (an erasure request). Final. `confirm` is their email address. */
|
|
80
|
+
eraseData(userId: string, confirm: string): Promise<Api>;
|
|
64
81
|
/** Remove the user's second factors, so they can sign in with a password alone and enrol again. */
|
|
65
82
|
resetMfa(userId: string): Promise<Api>;
|
|
66
83
|
/** Give the user permissions directly, beyond their roles' (`posts:write`, `billing:*`). */
|
|
@@ -74,6 +91,12 @@ export declare class Users extends AdminService {
|
|
|
74
91
|
/** The user's own API keys (never the secrets). */
|
|
75
92
|
apiKeys(userId: string): Promise<Api>;
|
|
76
93
|
}
|
|
94
|
+
export declare class Privacy extends AdminService {
|
|
95
|
+
/** The data requests handled so far (exports and erasures). They hold no personal data: the person's id and a hash of their address. */
|
|
96
|
+
requests(options?: {
|
|
97
|
+
limit?: number;
|
|
98
|
+
}): Promise<Api>;
|
|
99
|
+
}
|
|
77
100
|
export declare class Roles extends AdminService {
|
|
78
101
|
/** Roles with their permissions. */
|
|
79
102
|
list(): Promise<Api>;
|
|
@@ -133,6 +156,51 @@ export declare class ApiKeys extends AdminService {
|
|
|
133
156
|
}): Promise<Api>;
|
|
134
157
|
revoke(keyId: string): Promise<Api>;
|
|
135
158
|
}
|
|
159
|
+
export interface NewMachine {
|
|
160
|
+
name: string;
|
|
161
|
+
/** `agent` for an AI agent, `service` (default) for a job, backend or pipeline. */
|
|
162
|
+
kind?: "service" | "agent";
|
|
163
|
+
description?: string;
|
|
164
|
+
/** Roles whose permissions the machine holds. */
|
|
165
|
+
roles?: string[];
|
|
166
|
+
/** Permissions granted directly, on top of its roles. */
|
|
167
|
+
permissions?: string[];
|
|
168
|
+
/** An organization the machine belongs to. */
|
|
169
|
+
org?: string;
|
|
170
|
+
/** Visible to your server and policies only. */
|
|
171
|
+
appMetadata?: Body;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Machine identities: services and AI agents that call your API as themselves, with roles and keys of their own. Turn them on in the
|
|
175
|
+
* directory settings (`directory.machines.enabled`).
|
|
176
|
+
*/
|
|
177
|
+
export declare class Machines extends AdminService {
|
|
178
|
+
list(): Promise<Api>;
|
|
179
|
+
/** One machine, with its keys (never the secrets). */
|
|
180
|
+
getMachine(machineId: string): Promise<Api>;
|
|
181
|
+
create(input: NewMachine): Promise<Api>;
|
|
182
|
+
/** Change what is given. `roles` and `permissions` replace the existing lists. `org: null` removes the organization. */
|
|
183
|
+
update(machineId: string, input: {
|
|
184
|
+
name?: string;
|
|
185
|
+
description?: string;
|
|
186
|
+
roles?: string[];
|
|
187
|
+
permissions?: string[];
|
|
188
|
+
org?: string | null;
|
|
189
|
+
appMetadata?: Body;
|
|
190
|
+
disabled?: boolean;
|
|
191
|
+
}): Promise<Api>;
|
|
192
|
+
/** Stop every key of the machine at once. */
|
|
193
|
+
disable(machineId: string): Promise<Api>;
|
|
194
|
+
enable(machineId: string): Promise<Api>;
|
|
195
|
+
delete(machineId: string): Promise<Api>;
|
|
196
|
+
/** Make a key for the machine. The secret is in the answer once (`key`) and never again; `client_id` is the machine's id. */
|
|
197
|
+
createKey(machineId: string, input?: {
|
|
198
|
+
name?: string;
|
|
199
|
+
scopes?: string[];
|
|
200
|
+
expiresInDays?: number;
|
|
201
|
+
}): Promise<Api>;
|
|
202
|
+
revokeKey(machineId: string, keyId: string): Promise<Api>;
|
|
203
|
+
}
|
|
136
204
|
export declare class Devices extends AdminService {
|
|
137
205
|
/** Recent devices people signed in from. */
|
|
138
206
|
list(options?: {
|
|
@@ -175,8 +243,10 @@ export declare class Admin {
|
|
|
175
243
|
readonly invitations: Invitations;
|
|
176
244
|
readonly sessions: Sessions;
|
|
177
245
|
readonly apiKeys: ApiKeys;
|
|
246
|
+
readonly machines: Machines;
|
|
178
247
|
readonly devices: Devices;
|
|
179
248
|
readonly insight: Insight;
|
|
249
|
+
readonly privacy: Privacy;
|
|
180
250
|
constructor(http: HttpClient, environment: string);
|
|
181
251
|
/** The same services for another environment the key may manage. */
|
|
182
252
|
withEnvironment(name: string): Admin;
|
package/dist/esm/admin.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"admin.d.ts","sourceRoot":"","sources":["../../src/admin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAO,KAAK,GAAG,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAGrE,cAAM,YAAa,SAAQ,OAAO;cACb,IAAI,CAAC,MAAM,SAAK,GAAG,MAAM;CAG7C;AAED,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gDAAgD;IAChD,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,mCAAmC;IACnC,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,qBAAa,KAAM,SAAQ,YAAY;IACrC,gHAAgH;IAChH,MAAM,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzG,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrC,2GAA2G;IAC3G,MAAM,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAanC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAa1D,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxC,sDAAsD;IACtD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrC,mGAAmG;IACnG,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAItC,4FAA4F;IAC5F,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI1D,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI3D,oCAAoC;IACpC,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5C,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9D,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5D,mDAAmD;IACnD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGtC;AAED,qBAAa,KAAM,SAAQ,YAAY;IACrC,oCAAoC;IACpC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,8IAA8I;IAC9I,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjG,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGnC;AAED,kGAAkG;AAClG,qBAAa,IAAK,SAAQ,YAAY;IACpC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIlC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/E,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIlC,wCAAwC;IACxC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/E,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvE,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD,+FAA+F;IAC/F,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAGtG;AAED,qBAAa,WAAY,SAAQ,YAAY;IAC3C,yDAAyD;IACzD,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjF,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAG3C;AAED,qBAAa,QAAS,SAAQ,YAAY;IACxC,oCAAoC;IACpC,IAAI,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpD,gDAAgD;IAChD,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGrC;AAED,0CAA0C;AAC1C,qBAAa,OAAQ,SAAQ,YAAY;IACvC,IAAI,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpD,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGpC;AAED,qBAAa,OAAQ,SAAQ,YAAY;IACvC,4CAA4C;IAC5C,IAAI,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;CAGrD;AAED,gEAAgE;AAChE,qBAAa,OAAQ,SAAQ,YAAY;IACvC,4FAA4F;IAC5F,MAAM,CAAC,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvF,uDAAuD;IACvD,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC;IAIrB,2EAA2E;IAC3E,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC;IAItB,8EAA8E;IAC9E,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9F,mHAAmH;IACnH,6GAA6G;IAC7G,mBAAmB,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhG,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,IAAI,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;CAGzF;AAED,qBAAa,KAAK;
|
|
1
|
+
{"version":3,"file":"admin.d.ts","sourceRoot":"","sources":["../../src/admin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAO,KAAK,GAAG,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAGrE,cAAM,YAAa,SAAQ,OAAO;cACb,IAAI,CAAC,MAAM,SAAK,GAAG,MAAM;CAG7C;AAED,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gDAAgD;IAChD,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,mCAAmC;IACnC,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,qBAAa,KAAM,SAAQ,YAAY;IACrC,gHAAgH;IAChH,MAAM,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzG,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrC,2GAA2G;IAC3G,MAAM,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAanC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAa1D,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxC,sDAAsD;IACtD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrC;yEACqE;IACrE,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxE;yEACqE;IACrE,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIlI;2FACuF;IACvF,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxC,mIAAmI;IACnI,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD,mGAAmG;IACnG,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAItC,4FAA4F;IAC5F,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI1D,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI3D,oCAAoC;IACpC,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5C,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9D,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5D,mDAAmD;IACnD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGtC;AAED,qBAAa,OAAQ,SAAQ,YAAY;IACvC,wIAAwI;IACxI,QAAQ,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;CAGzD;AAED,qBAAa,KAAM,SAAQ,YAAY;IACrC,oCAAoC;IACpC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,8IAA8I;IAC9I,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjG,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGnC;AAED,kGAAkG;AAClG,qBAAa,IAAK,SAAQ,YAAY;IACpC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIlC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/E,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIlC,wCAAwC;IACxC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/E,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvE,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD,+FAA+F;IAC/F,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAGtG;AAED,qBAAa,WAAY,SAAQ,YAAY;IAC3C,yDAAyD;IACzD,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjF,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAG3C;AAED,qBAAa,QAAS,SAAQ,YAAY;IACxC,oCAAoC;IACpC,IAAI,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpD,gDAAgD;IAChD,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGrC;AAED,0CAA0C;AAC1C,qBAAa,OAAQ,SAAQ,YAAY;IACvC,IAAI,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpD,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGpC;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,mFAAmF;IACnF,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iDAAiD;IACjD,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,8CAA8C;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,WAAW,CAAC,EAAE,IAAI,CAAC;CACpB;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,YAAY;IACxC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,sDAAsD;IACtD,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI3C,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC;IAKvC,wHAAwH;IACxH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,WAAW,CAAC,EAAE,IAAI,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GACpJ,OAAO,CAAC,GAAG,CAAC;IAKf,6CAA6C;IAC7C,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxC,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvC,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvC,6HAA6H;IAC7H,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAQpH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAG1D;AAED,qBAAa,OAAQ,SAAQ,YAAY;IACvC,4CAA4C;IAC5C,IAAI,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;CAGrD;AAED,gEAAgE;AAChE,qBAAa,OAAQ,SAAQ,YAAY;IACvC,4FAA4F;IAC5F,MAAM,CAAC,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvF,uDAAuD;IACvD,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC;IAIrB,2EAA2E;IAC3E,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC;IAItB,8EAA8E;IAC9E,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9F,mHAAmH;IACnH,6GAA6G;IAC7G,mBAAmB,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhG,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,IAAI,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;CAGzF;AAED,qBAAa,KAAK;IAad,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM;IAb9B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBAGP,IAAI,EAAE,UAAU,EACxB,WAAW,EAAE,MAAM;IAc9B,oEAAoE;IACpE,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK;CAGrC;AAED,+FAA+F;AAC/F,wBAAgB,KAAK,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAK9E"}
|
package/dist/esm/admin.js
CHANGED
|
@@ -46,6 +46,25 @@ export class Users extends AdminService {
|
|
|
46
46
|
history(userId) {
|
|
47
47
|
return this.get(seg("users", userId, "history"));
|
|
48
48
|
}
|
|
49
|
+
/** What the user did over the last `weeks` weeks (at most 53): counts per day by kind (`signin`, `account`, `request`), totals, and a
|
|
50
|
+
* summary (last seen, failures, busiest hour, most used routes). */
|
|
51
|
+
activity(userId, options = {}) {
|
|
52
|
+
return this.get(seg("users", userId, "activity"), { weeks: options.weeks ?? 53 });
|
|
53
|
+
}
|
|
54
|
+
/** The user's sign-ins, account changes and requests in one feed, newest first. `type`: `signin`, `account` or `request`.
|
|
55
|
+
* Pass the answer's `next_before` as `before` for the next page. */
|
|
56
|
+
timeline(userId, options = {}) {
|
|
57
|
+
return this.get(seg("users", userId, "timeline"), { type: options.type, limit: options.limit ?? 50, before: options.before });
|
|
58
|
+
}
|
|
59
|
+
/** Everything the auth service holds about the user, as JSON (a data-access request). Records that the request was handled.
|
|
60
|
+
* Rows in your own tables are not included: they are your application's to export. */
|
|
61
|
+
exportData(userId) {
|
|
62
|
+
return this.post(seg("users", userId, "privacy", "export"));
|
|
63
|
+
}
|
|
64
|
+
/** Delete the user and clear everything that could identify them (an erasure request). Final. `confirm` is their email address. */
|
|
65
|
+
eraseData(userId, confirm) {
|
|
66
|
+
return this.post(seg("users", userId, "privacy", "erase"), { confirm });
|
|
67
|
+
}
|
|
49
68
|
/** Remove the user's second factors, so they can sign in with a password alone and enrol again. */
|
|
50
69
|
resetMfa(userId) {
|
|
51
70
|
return this.post(seg("users", userId, "mfa", "reset"));
|
|
@@ -75,6 +94,12 @@ export class Users extends AdminService {
|
|
|
75
94
|
return this.get(seg("users", userId, "api-keys"));
|
|
76
95
|
}
|
|
77
96
|
}
|
|
97
|
+
export class Privacy extends AdminService {
|
|
98
|
+
/** The data requests handled so far (exports and erasures). They hold no personal data: the person's id and a hash of their address. */
|
|
99
|
+
requests(options = {}) {
|
|
100
|
+
return this.get("/privacy/requests", { limit: options.limit ?? 50 });
|
|
101
|
+
}
|
|
102
|
+
}
|
|
78
103
|
export class Roles extends AdminService {
|
|
79
104
|
/** Roles with their permissions. */
|
|
80
105
|
list() {
|
|
@@ -151,6 +176,49 @@ export class ApiKeys extends AdminService {
|
|
|
151
176
|
return this.del(seg("api-keys", keyId));
|
|
152
177
|
}
|
|
153
178
|
}
|
|
179
|
+
/**
|
|
180
|
+
* Machine identities: services and AI agents that call your API as themselves, with roles and keys of their own. Turn them on in the
|
|
181
|
+
* directory settings (`directory.machines.enabled`).
|
|
182
|
+
*/
|
|
183
|
+
export class Machines extends AdminService {
|
|
184
|
+
list() {
|
|
185
|
+
return this.get("/machines");
|
|
186
|
+
}
|
|
187
|
+
/** One machine, with its keys (never the secrets). */
|
|
188
|
+
getMachine(machineId) {
|
|
189
|
+
return this.get(seg("machines", machineId));
|
|
190
|
+
}
|
|
191
|
+
create(input) {
|
|
192
|
+
const { appMetadata, ...rest } = input;
|
|
193
|
+
return this.post("/machines", { ...rest, ...(appMetadata ? { app_metadata: appMetadata } : {}) });
|
|
194
|
+
}
|
|
195
|
+
/** Change what is given. `roles` and `permissions` replace the existing lists. `org: null` removes the organization. */
|
|
196
|
+
update(machineId, input) {
|
|
197
|
+
const { appMetadata, ...rest } = input;
|
|
198
|
+
return this.patch(seg("machines", machineId), { ...rest, ...(appMetadata ? { app_metadata: appMetadata } : {}) });
|
|
199
|
+
}
|
|
200
|
+
/** Stop every key of the machine at once. */
|
|
201
|
+
disable(machineId) {
|
|
202
|
+
return this.update(machineId, { disabled: true });
|
|
203
|
+
}
|
|
204
|
+
enable(machineId) {
|
|
205
|
+
return this.update(machineId, { disabled: false });
|
|
206
|
+
}
|
|
207
|
+
delete(machineId) {
|
|
208
|
+
return this.del(seg("machines", machineId));
|
|
209
|
+
}
|
|
210
|
+
/** Make a key for the machine. The secret is in the answer once (`key`) and never again; `client_id` is the machine's id. */
|
|
211
|
+
createKey(machineId, input = {}) {
|
|
212
|
+
return this.post(seg("machines", machineId, "keys"), {
|
|
213
|
+
name: input.name ?? "",
|
|
214
|
+
scopes: input.scopes ?? [],
|
|
215
|
+
...(input.expiresInDays ? { expires_in_days: input.expiresInDays } : {}),
|
|
216
|
+
});
|
|
217
|
+
}
|
|
218
|
+
revokeKey(machineId, keyId) {
|
|
219
|
+
return this.del(seg("machines", machineId, "keys", keyId));
|
|
220
|
+
}
|
|
221
|
+
}
|
|
154
222
|
export class Devices extends AdminService {
|
|
155
223
|
/** Recent devices people signed in from. */
|
|
156
224
|
list(options = {}) {
|
|
@@ -193,8 +261,10 @@ export class Admin {
|
|
|
193
261
|
invitations;
|
|
194
262
|
sessions;
|
|
195
263
|
apiKeys;
|
|
264
|
+
machines;
|
|
196
265
|
devices;
|
|
197
266
|
insight;
|
|
267
|
+
privacy;
|
|
198
268
|
constructor(http, environment) {
|
|
199
269
|
this.http = http;
|
|
200
270
|
this.environment = environment;
|
|
@@ -204,8 +274,10 @@ export class Admin {
|
|
|
204
274
|
this.invitations = new Invitations(http, environment);
|
|
205
275
|
this.sessions = new Sessions(http, environment);
|
|
206
276
|
this.apiKeys = new ApiKeys(http, environment);
|
|
277
|
+
this.machines = new Machines(http, environment);
|
|
207
278
|
this.devices = new Devices(http, environment);
|
|
208
279
|
this.insight = new Insight(http, environment);
|
|
280
|
+
this.privacy = new Privacy(http, environment);
|
|
209
281
|
}
|
|
210
282
|
/** The same services for another environment the key may manage. */
|
|
211
283
|
withEnvironment(name) {
|
package/dist/esm/admin.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"admin.js","sourceRoot":"","sources":["../../src/admin.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,OAAO,EAAE,GAAG,EAAuB,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,MAAM,YAAa,SAAQ,OAAO;IACb,IAAI,CAAC,MAAM,GAAG,EAAE;QACjC,OAAO,qBAAqB,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,MAAM,EAAE,CAAC;IACnF,CAAC;CACF;AA8BD,MAAM,OAAO,KAAM,SAAQ,YAAY;IACrC,gHAAgH;IAChH,MAAM,CAAC,UAAiF,EAAE;QACxF,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,2GAA2G;IAC3G,MAAM,CAAC,IAAa;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;YACrB,cAAc,EAAE,IAAI,CAAC,aAAa,IAAI,IAAI;YAC1C,aAAa,EAAE,IAAI,CAAC,YAAY,IAAI,EAAE;YACtC,YAAY,EAAE,IAAI,CAAC,WAAW,IAAI,EAAE;YACpC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAc,EAAE,OAAoB;QACzC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;YACtC,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,cAAc,EAAE,OAAO,CAAC,aAAa;YACrC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,aAAa,EAAE,OAAO,CAAC,YAAY;YACnC,YAAY,EAAE,OAAO,CAAC,WAAW;YACjC,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;IAED,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,sDAAsD;IACtD,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,mGAAmG;IACnG,QAAQ,CAAC,MAAc;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IACzD,CAAC;IAED,4FAA4F;IAC5F,KAAK,CAAC,MAAc,EAAE,WAAqB;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,MAAM,CAAC,MAAc,EAAE,WAAqB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IACnF,CAAC;IAED,oCAAoC;IACpC,cAAc,CAAC,MAAc;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,aAAa,CAAC,MAAc,EAAE,SAAiB;QAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,YAAY,CAAC,MAAc,EAAE,QAAgB;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,mDAAmD;IACnD,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IACpD,CAAC;CACF;AAED,MAAM,OAAO,KAAM,SAAQ,YAAY;IACrC,oCAAoC;IACpC,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,8IAA8I;IAC9I,MAAM,CAAC,IAAY,EAAE,WAAqB,EAAE,UAAoC,EAAE;QAChF,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED,MAAM,CAAC,IAAY;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC;CACF;AAED,kGAAkG;AAClG,MAAM,OAAO,IAAK,SAAQ,YAAY;IACpC,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED,MAAM,CAAC,IAAY;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,MAAM,CAAC,IAAY,EAAE,IAAY,EAAE,UAAoD,EAAE;QACvF,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC,CAAC;IAC/G,CAAC;IAED,MAAM,CAAC,IAAY,EAAE,OAA2C;QAC9D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,CAAC,IAAY;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,wCAAwC;IACxC,SAAS,CAAC,IAAY,EAAE,MAAwC;QAC9D,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC,CAAC;IACzG,CAAC;IAED,aAAa,CAAC,IAAY,EAAE,MAAc,EAAE,IAAY;QACtD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,YAAY,CAAC,IAAY,EAAE,MAAc;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,+FAA+F;IAC/F,MAAM,CAAC,IAAY,EAAE,UAAiE;QACpF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,IAAI,QAAQ,EAAE,WAAW,EAAE,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;IACzJ,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,YAAY;IAC3C,yDAAyD;IACzD,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,YAAoB,EAAE,UAAmC,EAAE;QAChE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC9H,CAAC;IAED,MAAM,CAAC,YAAoB;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC;IACpD,CAAC;CACF;AAED,MAAM,OAAO,QAAS,SAAQ,YAAY;IACxC,oCAAoC;IACpC,IAAI,CAAC,UAA8B,EAAE;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,gDAAgD;IAChD,MAAM,CAAC,MAAc;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF;AAED,0CAA0C;AAC1C,MAAM,OAAO,OAAQ,SAAQ,YAAY;IACvC,IAAI,CAAC,UAA8B,EAAE;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,KAAa;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;IAC1C,CAAC;CACF;AAED,MAAM,OAAO,OAAQ,SAAQ,YAAY;IACvC,4CAA4C;IAC5C,IAAI,CAAC,UAA8B,EAAE;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;CACF;AAED,gEAAgE;AAChE,MAAM,OAAO,OAAQ,SAAQ,YAAY;IACvC,4FAA4F;IAC5F,MAAM,CAAC,UAA+D,EAAE;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,GAAG,EAAE,CAAC,CAAC;IAC/H,CAAC;IAED,uDAAuD;IACvD,KAAK;QACH,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,2EAA2E;IAC3E,MAAM;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC;IAED,8EAA8E;IAC9E,OAAO,CAAC,UAAgB,EAAE,UAAmD,EAAE;QAC7E,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC;IACpH,CAAC;IAED,mHAAmH;IACnH,6GAA6G;IAC7G,mBAAmB,CAAC,OAAa,EAAE,MAAc,EAAE,UAA4B,EAAE;QAC/E,OAAO,IAAI,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC1H,CAAC;IAED,YAAY,CAAC,IAAY,EAAE,UAA4C,EAAE;QACvE,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/F,CAAC;CACF;AAED,MAAM,OAAO,KAAK;IAWG;IACR;IAXF,KAAK,CAAQ;IACb,KAAK,CAAQ;IACb,IAAI,CAAO;IACX,WAAW,CAAc;IACzB,QAAQ,CAAW;IACnB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,OAAO,CAAU;IAE1B,YACmB,IAAgB,EACxB,WAAmB;QADX,SAAI,GAAJ,IAAI,CAAY;QACxB,gBAAW,GAAX,WAAW,CAAQ;QAE5B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAChD,CAAC;IAED,oEAAoE;IACpE,eAAe,CAAC,IAAY;QAC1B,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC;CACF;AAED,+FAA+F;AAC/F,MAAM,UAAU,KAAK,CAAC,MAA2B,EAAE,WAAoB;IACrE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,WAAW,CAAC,mDAAmD,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,IAAI,aAAa,CAAC,CAAC;AAC5F,CAAC"}
|
|
1
|
+
{"version":3,"file":"admin.js","sourceRoot":"","sources":["../../src/admin.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,OAAO,EAAE,GAAG,EAAuB,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,MAAM,YAAa,SAAQ,OAAO;IACb,IAAI,CAAC,MAAM,GAAG,EAAE;QACjC,OAAO,qBAAqB,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,MAAM,EAAE,CAAC;IACnF,CAAC;CACF;AA8BD,MAAM,OAAO,KAAM,SAAQ,YAAY;IACrC,gHAAgH;IAChH,MAAM,CAAC,UAAiF,EAAE;QACxF,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,2GAA2G;IAC3G,MAAM,CAAC,IAAa;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;YACrB,cAAc,EAAE,IAAI,CAAC,aAAa,IAAI,IAAI;YAC1C,aAAa,EAAE,IAAI,CAAC,YAAY,IAAI,EAAE;YACtC,YAAY,EAAE,IAAI,CAAC,WAAW,IAAI,EAAE;YACpC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAc,EAAE,OAAoB;QACzC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;YACtC,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,cAAc,EAAE,OAAO,CAAC,aAAa;YACrC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,aAAa,EAAE,OAAO,CAAC,YAAY;YACnC,YAAY,EAAE,OAAO,CAAC,WAAW;YACjC,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;IAED,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,sDAAsD;IACtD,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;yEACqE;IACrE,QAAQ,CAAC,MAAc,EAAE,UAA8B,EAAE;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;yEACqE;IACrE,QAAQ,CAAC,MAAc,EAAE,UAAwF,EAAE;QACjH,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAChI,CAAC;IAED;2FACuF;IACvF,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,mIAAmI;IACnI,SAAS,CAAC,MAAc,EAAE,OAAe;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,mGAAmG;IACnG,QAAQ,CAAC,MAAc;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IACzD,CAAC;IAED,4FAA4F;IAC5F,KAAK,CAAC,MAAc,EAAE,WAAqB;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,MAAM,CAAC,MAAc,EAAE,WAAqB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IACnF,CAAC;IAED,oCAAoC;IACpC,cAAc,CAAC,MAAc;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,aAAa,CAAC,MAAc,EAAE,SAAiB;QAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,YAAY,CAAC,MAAc,EAAE,QAAgB;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,mDAAmD;IACnD,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IACpD,CAAC;CACF;AAED,MAAM,OAAO,OAAQ,SAAQ,YAAY;IACvC,wIAAwI;IACxI,QAAQ,CAAC,UAA8B,EAAE;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AAED,MAAM,OAAO,KAAM,SAAQ,YAAY;IACrC,oCAAoC;IACpC,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,8IAA8I;IAC9I,MAAM,CAAC,IAAY,EAAE,WAAqB,EAAE,UAAoC,EAAE;QAChF,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED,MAAM,CAAC,IAAY;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC;CACF;AAED,kGAAkG;AAClG,MAAM,OAAO,IAAK,SAAQ,YAAY;IACpC,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED,MAAM,CAAC,IAAY;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,MAAM,CAAC,IAAY,EAAE,IAAY,EAAE,UAAoD,EAAE;QACvF,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC,CAAC;IAC/G,CAAC;IAED,MAAM,CAAC,IAAY,EAAE,OAA2C;QAC9D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,CAAC,IAAY;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,wCAAwC;IACxC,SAAS,CAAC,IAAY,EAAE,MAAwC;QAC9D,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC,CAAC;IACzG,CAAC;IAED,aAAa,CAAC,IAAY,EAAE,MAAc,EAAE,IAAY;QACtD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,YAAY,CAAC,IAAY,EAAE,MAAc;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,+FAA+F;IAC/F,MAAM,CAAC,IAAY,EAAE,UAAiE;QACpF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,IAAI,QAAQ,EAAE,WAAW,EAAE,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;IACzJ,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,YAAY;IAC3C,yDAAyD;IACzD,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,YAAoB,EAAE,UAAmC,EAAE;QAChE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC9H,CAAC;IAED,MAAM,CAAC,YAAoB;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC;IACpD,CAAC;CACF;AAED,MAAM,OAAO,QAAS,SAAQ,YAAY;IACxC,oCAAoC;IACpC,IAAI,CAAC,UAA8B,EAAE;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,gDAAgD;IAChD,MAAM,CAAC,MAAc;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF;AAED,0CAA0C;AAC1C,MAAM,OAAO,OAAQ,SAAQ,YAAY;IACvC,IAAI,CAAC,UAA8B,EAAE;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,KAAa;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;IAC1C,CAAC;CACF;AAiBD;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,YAAY;IACxC,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAED,sDAAsD;IACtD,UAAU,CAAC,SAAiB;QAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,KAAiB;QACtB,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACpG,CAAC;IAED,wHAAwH;IACxH,MAAM,CACJ,SAAiB,EACjB,KAAqJ;QAErJ,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACpH,CAAC;IAED,6CAA6C;IAC7C,OAAO,CAAC,SAAiB;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,CAAC,SAAiB;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,CAAC,SAAiB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,6HAA6H;IAC7H,SAAS,CAAC,SAAiB,EAAE,QAAsE,EAAE;QACnG,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE;YACnD,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE;YACtB,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,EAAE;YAC1B,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACzE,CAAC,CAAC;IACL,CAAC;IAED,SAAS,CAAC,SAAiB,EAAE,KAAa;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAC7D,CAAC;CACF;AAED,MAAM,OAAO,OAAQ,SAAQ,YAAY;IACvC,4CAA4C;IAC5C,IAAI,CAAC,UAA8B,EAAE;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;CACF;AAED,gEAAgE;AAChE,MAAM,OAAO,OAAQ,SAAQ,YAAY;IACvC,4FAA4F;IAC5F,MAAM,CAAC,UAA+D,EAAE;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,GAAG,EAAE,CAAC,CAAC;IAC/H,CAAC;IAED,uDAAuD;IACvD,KAAK;QACH,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,2EAA2E;IAC3E,MAAM;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC;IAED,8EAA8E;IAC9E,OAAO,CAAC,UAAgB,EAAE,UAAmD,EAAE;QAC7E,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC;IACpH,CAAC;IAED,mHAAmH;IACnH,6GAA6G;IAC7G,mBAAmB,CAAC,OAAa,EAAE,MAAc,EAAE,UAA4B,EAAE;QAC/E,OAAO,IAAI,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC1H,CAAC;IAED,YAAY,CAAC,IAAY,EAAE,UAA4C,EAAE;QACvE,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/F,CAAC;CACF;AAED,MAAM,OAAO,KAAK;IAaG;IACR;IAbF,KAAK,CAAQ;IACb,KAAK,CAAQ;IACb,IAAI,CAAO;IACX,WAAW,CAAc;IACzB,QAAQ,CAAW;IACnB,OAAO,CAAU;IACjB,QAAQ,CAAW;IACnB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,OAAO,CAAU;IAE1B,YACmB,IAAgB,EACxB,WAAmB;QADX,SAAI,GAAJ,IAAI,CAAY;QACxB,gBAAW,GAAX,WAAW,CAAQ;QAE5B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAChD,CAAC;IAED,oEAAoE;IACpE,eAAe,CAAC,IAAY;QAC1B,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC;CACF;AAED,+FAA+F;AAC/F,MAAM,UAAU,KAAK,CAAC,MAA2B,EAAE,WAAoB;IACrE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,WAAW,CAAC,mDAAmD,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,IAAI,aAAa,CAAC,CAAC;AAC5F,CAAC"}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import type { HttpClient } from "./http.js";
|
|
2
|
+
export type AgentRunStatus = "running" | "waiting" | "finished" | "failed" | "cancelled" | (string & {});
|
|
3
|
+
/** One run of an agent. A run that stopped to ask permission has `status: "waiting"` and lists what it is waiting on. */
|
|
4
|
+
export interface AgentRun {
|
|
5
|
+
id: string;
|
|
6
|
+
agent: string;
|
|
7
|
+
status: AgentRunStatus;
|
|
8
|
+
/** The agent's answer, once it has one. */
|
|
9
|
+
output?: string;
|
|
10
|
+
thread?: string;
|
|
11
|
+
error?: string;
|
|
12
|
+
[field: string]: unknown;
|
|
13
|
+
}
|
|
14
|
+
/** One step of a streamed run (`type` says which: text pieces, tool calls and results, approvals, `error`). */
|
|
15
|
+
export interface AgentEvent {
|
|
16
|
+
type: string;
|
|
17
|
+
[field: string]: unknown;
|
|
18
|
+
}
|
|
19
|
+
export interface AgentRunOptions {
|
|
20
|
+
/** Carry on a conversation: the `thread` of an earlier run. */
|
|
21
|
+
thread?: string;
|
|
22
|
+
/** Return at once; poll `get()` or start a flow from `agent.run.finished`. */
|
|
23
|
+
background?: boolean;
|
|
24
|
+
signal?: AbortSignal | null;
|
|
25
|
+
}
|
|
26
|
+
export interface KnowledgeHit {
|
|
27
|
+
[field: string]: unknown;
|
|
28
|
+
}
|
|
29
|
+
export interface KnowledgeDocument {
|
|
30
|
+
id: string;
|
|
31
|
+
status: "pending" | "ready" | "failed" | (string & {});
|
|
32
|
+
title?: string;
|
|
33
|
+
error?: string;
|
|
34
|
+
chunks?: number;
|
|
35
|
+
}
|
|
36
|
+
export declare class AgentsClient {
|
|
37
|
+
private readonly http;
|
|
38
|
+
constructor(http: HttpClient);
|
|
39
|
+
/** The agents the caller may run. */
|
|
40
|
+
list(): Promise<Array<{
|
|
41
|
+
name: string;
|
|
42
|
+
description: string;
|
|
43
|
+
}>>;
|
|
44
|
+
/** Send `input` and wait for the run (or, with `background`, only for it to start). */
|
|
45
|
+
run(name: string, input: string, options?: AgentRunOptions): Promise<AgentRun>;
|
|
46
|
+
/** Each step of a run as it happens. */
|
|
47
|
+
stream(name: string, input: string, options?: Omit<AgentRunOptions, "background">): AsyncGenerator<AgentEvent, void, void>;
|
|
48
|
+
/** A run of yours: its status and answer, and what it is waiting on if it stopped to ask. */
|
|
49
|
+
get(runId: string): Promise<AgentRun>;
|
|
50
|
+
/** Approve or decline what a run is waiting on: a decision per call id, and `approve` for any not named. */
|
|
51
|
+
decide(runId: string, options?: {
|
|
52
|
+
decisions?: Record<string, boolean>;
|
|
53
|
+
approve?: boolean;
|
|
54
|
+
background?: boolean;
|
|
55
|
+
}): Promise<AgentRun>;
|
|
56
|
+
/** Poll a background run until it is no longer running (a waiting run is returned too, so you can decide it). */
|
|
57
|
+
wait(runId: string, options?: {
|
|
58
|
+
intervalMs?: number;
|
|
59
|
+
timeoutMs?: number;
|
|
60
|
+
signal?: AbortSignal | null;
|
|
61
|
+
}): Promise<AgentRun>;
|
|
62
|
+
}
|
|
63
|
+
export declare class KnowledgeClient {
|
|
64
|
+
private readonly http;
|
|
65
|
+
constructor(http: HttpClient);
|
|
66
|
+
/** Search by meaning and by words together. Documents kept private to someone else are left out. */
|
|
67
|
+
search(name: string, query: string, options?: {
|
|
68
|
+
limit?: number;
|
|
69
|
+
signal?: AbortSignal | null;
|
|
70
|
+
}): Promise<KnowledgeHit[]>;
|
|
71
|
+
/** Add text, or a web page to read (`url`). A signed-in user's documents are found only by them. Adding the same `source` again replaces it. */
|
|
72
|
+
addDocument(name: string, input: {
|
|
73
|
+
text?: string;
|
|
74
|
+
url?: string;
|
|
75
|
+
title?: string;
|
|
76
|
+
source?: string;
|
|
77
|
+
}): Promise<KnowledgeDocument>;
|
|
78
|
+
/** Add a file (PDF, Word, HTML or text). */
|
|
79
|
+
addFile(name: string, file: Blob, options?: {
|
|
80
|
+
title?: string;
|
|
81
|
+
source?: string;
|
|
82
|
+
filename?: string;
|
|
83
|
+
}): Promise<KnowledgeDocument>;
|
|
84
|
+
/** Whether a document is ready to search, and why not if it failed. */
|
|
85
|
+
document(name: string, documentId: string): Promise<KnowledgeDocument>;
|
|
86
|
+
}
|
|
87
|
+
//# sourceMappingURL=agents.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"agents.d.ts","sourceRoot":"","sources":["../../src/agents.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEzG,yHAAyH;AACzH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,cAAc,CAAC;IACvB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED,+GAA+G;AAC/G,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,qBAAa,YAAY;IACX,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,qCAAqC;IAC/B,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAKnE,uFAAuF;IACvF,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;IASlF,wCAAwC;IACjC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,eAAe,EAAE,YAAY,CAAM,GAAG,cAAc,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC;IA2CrI,6FAA6F;IAC7F,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIrC,4GAA4G;IAC5G,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQxI,iHAAiH;IAC3G,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,QAAQ,CAAC;CAWrI;AAED,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,oGAAoG;IAC9F,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAUjI,gJAAgJ;IAChJ,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQ9H,4CAA4C;IAC5C,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQnI,uEAAuE;IACvE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAGvE"}
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Agents and knowledge bases, run from your app: the signed-in user's access rules decide which agents they may run and which
|
|
3
|
+
* knowledge bases they may search.
|
|
4
|
+
*
|
|
5
|
+
* ```ts
|
|
6
|
+
* const run = await pawabase.ai.agents.run("support", "How do I reset my password?");
|
|
7
|
+
* console.log(run.output);
|
|
8
|
+
* for await (const event of pawabase.ai.agents.stream("support", "Summarise my open tickets")) console.log(event);
|
|
9
|
+
* const hits = await pawabase.ai.knowledge.search("docs", "reset password");
|
|
10
|
+
* ```
|
|
11
|
+
*/
|
|
12
|
+
import { ApiError } from "./errors.js";
|
|
13
|
+
const seg = (...parts) => "/" + parts.map(encodeURIComponent).join("/");
|
|
14
|
+
export class AgentsClient {
|
|
15
|
+
http;
|
|
16
|
+
constructor(http) {
|
|
17
|
+
this.http = http;
|
|
18
|
+
}
|
|
19
|
+
/** The agents the caller may run. */
|
|
20
|
+
async list() {
|
|
21
|
+
const body = await this.http.request({ path: "/ai/v1/agents" });
|
|
22
|
+
return body.data;
|
|
23
|
+
}
|
|
24
|
+
/** Send `input` and wait for the run (or, with `background`, only for it to start). */
|
|
25
|
+
run(name, input, options = {}) {
|
|
26
|
+
return this.http.request({
|
|
27
|
+
method: "POST",
|
|
28
|
+
path: `/ai/v1${seg("agents", name, "runs")}`,
|
|
29
|
+
body: { input, thread: options.thread, background: options.background ?? false },
|
|
30
|
+
signal: options.signal ?? undefined,
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
/** Each step of a run as it happens. */
|
|
34
|
+
async *stream(name, input, options = {}) {
|
|
35
|
+
const stream = await this.http.request({
|
|
36
|
+
method: "POST",
|
|
37
|
+
path: `/ai/v1${seg("agents", name, "runs")}`,
|
|
38
|
+
body: { input, thread: options.thread, stream: true },
|
|
39
|
+
parse: "stream",
|
|
40
|
+
signal: options.signal ?? undefined,
|
|
41
|
+
});
|
|
42
|
+
if (!stream)
|
|
43
|
+
return;
|
|
44
|
+
const reader = stream.getReader();
|
|
45
|
+
const decoder = new TextDecoder();
|
|
46
|
+
let buffer = "";
|
|
47
|
+
try {
|
|
48
|
+
for (;;) {
|
|
49
|
+
const { value, done } = await reader.read();
|
|
50
|
+
if (done)
|
|
51
|
+
break;
|
|
52
|
+
buffer += decoder.decode(value, { stream: true });
|
|
53
|
+
let end;
|
|
54
|
+
while ((end = buffer.indexOf("\n\n")) >= 0) {
|
|
55
|
+
const event = buffer.slice(0, end);
|
|
56
|
+
buffer = buffer.slice(end + 2);
|
|
57
|
+
for (const line of event.split("\n")) {
|
|
58
|
+
if (!line.startsWith("data:"))
|
|
59
|
+
continue;
|
|
60
|
+
const data = line.slice(5).trim();
|
|
61
|
+
if (data === "[DONE]")
|
|
62
|
+
return;
|
|
63
|
+
let parsed;
|
|
64
|
+
try {
|
|
65
|
+
parsed = JSON.parse(data);
|
|
66
|
+
}
|
|
67
|
+
catch {
|
|
68
|
+
continue;
|
|
69
|
+
}
|
|
70
|
+
if (parsed.type === "error") {
|
|
71
|
+
throw new ApiError({ status: 502, code: "agent_error", message: String(parsed.message ?? "the run stopped") });
|
|
72
|
+
}
|
|
73
|
+
yield parsed;
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
finally {
|
|
79
|
+
reader.releaseLock();
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
/** A run of yours: its status and answer, and what it is waiting on if it stopped to ask. */
|
|
83
|
+
get(runId) {
|
|
84
|
+
return this.http.request({ path: `/ai/v1${seg("agent-runs", runId)}` });
|
|
85
|
+
}
|
|
86
|
+
/** Approve or decline what a run is waiting on: a decision per call id, and `approve` for any not named. */
|
|
87
|
+
decide(runId, options = {}) {
|
|
88
|
+
return this.http.request({
|
|
89
|
+
method: "POST",
|
|
90
|
+
path: `/ai/v1${seg("agent-runs", runId, "decide")}`,
|
|
91
|
+
body: { decisions: options.decisions ?? {}, approve: options.approve, background: options.background ?? false },
|
|
92
|
+
});
|
|
93
|
+
}
|
|
94
|
+
/** Poll a background run until it is no longer running (a waiting run is returned too, so you can decide it). */
|
|
95
|
+
async wait(runId, options = {}) {
|
|
96
|
+
const interval = options.intervalMs ?? 1000;
|
|
97
|
+
const deadline = Date.now() + (options.timeoutMs ?? 5 * 60_000);
|
|
98
|
+
for (;;) {
|
|
99
|
+
const run = await this.get(runId);
|
|
100
|
+
if (run.status !== "running")
|
|
101
|
+
return run;
|
|
102
|
+
if (options.signal?.aborted)
|
|
103
|
+
throw options.signal.reason ?? new Error("aborted");
|
|
104
|
+
if (Date.now() >= deadline)
|
|
105
|
+
throw new Error(`run ${runId} was still running after ${options.timeoutMs ?? 5 * 60_000} ms`);
|
|
106
|
+
await new Promise((resolve) => setTimeout(resolve, interval));
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
export class KnowledgeClient {
|
|
111
|
+
http;
|
|
112
|
+
constructor(http) {
|
|
113
|
+
this.http = http;
|
|
114
|
+
}
|
|
115
|
+
/** Search by meaning and by words together. Documents kept private to someone else are left out. */
|
|
116
|
+
async search(name, query, options = {}) {
|
|
117
|
+
const body = await this.http.request({
|
|
118
|
+
method: "POST",
|
|
119
|
+
path: `/ai/v1${seg("knowledge", name, "search")}`,
|
|
120
|
+
body: { query, limit: options.limit ?? 5 },
|
|
121
|
+
signal: options.signal ?? undefined,
|
|
122
|
+
});
|
|
123
|
+
return body.data;
|
|
124
|
+
}
|
|
125
|
+
/** Add text, or a web page to read (`url`). A signed-in user's documents are found only by them. Adding the same `source` again replaces it. */
|
|
126
|
+
addDocument(name, input) {
|
|
127
|
+
return this.http.request({
|
|
128
|
+
method: "POST",
|
|
129
|
+
path: `/ai/v1${seg("knowledge", name, "documents")}`,
|
|
130
|
+
body: { title: input.title ?? "", source: input.source ?? "", text: input.text, url: input.url },
|
|
131
|
+
});
|
|
132
|
+
}
|
|
133
|
+
/** Add a file (PDF, Word, HTML or text). */
|
|
134
|
+
addFile(name, file, options = {}) {
|
|
135
|
+
const form = new FormData();
|
|
136
|
+
form.append("file", file, options.filename ?? file.name ?? "document");
|
|
137
|
+
if (options.title)
|
|
138
|
+
form.append("title", options.title);
|
|
139
|
+
if (options.source)
|
|
140
|
+
form.append("source", options.source);
|
|
141
|
+
return this.http.request({ method: "POST", path: `/ai/v1${seg("knowledge", name, "documents")}`, body: form });
|
|
142
|
+
}
|
|
143
|
+
/** Whether a document is ready to search, and why not if it failed. */
|
|
144
|
+
document(name, documentId) {
|
|
145
|
+
return this.http.request({ path: `/ai/v1${seg("knowledge", name, "documents", documentId)}` });
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
//# sourceMappingURL=agents.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"agents.js","sourceRoot":"","sources":["../../src/agents.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AA2CvC,MAAM,GAAG,GAAG,CAAC,GAAG,KAAe,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAElF,MAAM,OAAO,YAAY;IACM;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD,qCAAqC;IACrC,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyD,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;QACxH,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,uFAAuF;IACvF,GAAG,CAAC,IAAY,EAAE,KAAa,EAAE,UAA2B,EAAE;QAC5D,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAW;YACjC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,SAAS,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE;YAC5C,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,KAAK,EAAE;YAChF,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,SAAS;SACpC,CAAC,CAAC;IACL,CAAC;IAED,wCAAwC;IACxC,KAAK,CAAC,CAAC,MAAM,CAAC,IAAY,EAAE,KAAa,EAAE,UAA+C,EAAE;QAC1F,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoC;YACxE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,SAAS,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE;YAC5C,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE;YACrD,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,SAAS;SACpC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM;YAAE,OAAO;QACpB,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QAClC,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC;YACH,SAAS,CAAC;gBACR,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC5C,IAAI,IAAI;oBAAE,MAAM;gBAChB,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBAClD,IAAI,GAAW,CAAC;gBAChB,OAAO,CAAC,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC3C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;oBACnC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;oBAC/B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;wBACrC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;4BAAE,SAAS;wBACxC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;wBAClC,IAAI,IAAI,KAAK,QAAQ;4BAAE,OAAO;wBAC9B,IAAI,MAAkB,CAAC;wBACvB,IAAI,CAAC;4BACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBAC5B,CAAC;wBAAC,MAAM,CAAC;4BACP,SAAS;wBACX,CAAC;wBACD,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;4BAC5B,MAAM,IAAI,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,IAAI,iBAAiB,CAAC,EAAE,CAAC,CAAC;wBACjH,CAAC;wBACD,MAAM,MAAM,CAAC;oBACf,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,CAAC;IACH,CAAC;IAED,6FAA6F;IAC7F,GAAG,CAAC,KAAa;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAW,EAAE,IAAI,EAAE,SAAS,GAAG,CAAC,YAAY,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,4GAA4G;IAC5G,MAAM,CAAC,KAAa,EAAE,UAA4F,EAAE;QAClH,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAW;YACjC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,SAAS,GAAG,CAAC,YAAY,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE;YACnD,IAAI,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,KAAK,EAAE;SAChH,CAAC,CAAC;IACL,CAAC;IAED,iHAAiH;IACjH,KAAK,CAAC,IAAI,CAAC,KAAa,EAAE,UAAoF,EAAE;QAC9G,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC;QAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;QAChE,SAAS,CAAC;YACR,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS;gBAAE,OAAO,GAAG,CAAC;YACzC,IAAI,OAAO,CAAC,MAAM,EAAE,OAAO;gBAAE,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;YACjF,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,OAAO,KAAK,4BAA4B,OAAO,CAAC,SAAS,IAAI,CAAC,GAAG,MAAM,KAAK,CAAC,CAAC;YAC1H,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;CACF;AAED,MAAM,OAAO,eAAe;IACG;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD,oGAAoG;IACpG,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,KAAa,EAAE,UAA2D,EAAE;QACrG,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAA2B;YAC7D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,SAAS,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE;YACjD,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC,EAAE;YAC1C,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,SAAS;SACpC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,gJAAgJ;IAChJ,WAAW,CAAC,IAAY,EAAE,KAAuE;QAC/F,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoB;YAC1C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,SAAS,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE,WAAW,CAAC,EAAE;YACpD,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE;SACjG,CAAC,CAAC;IACL,CAAC;IAED,4CAA4C;IAC5C,OAAO,CAAC,IAAY,EAAE,IAAU,EAAE,UAAkE,EAAE;QACpG,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,QAAQ,IAAK,IAAa,CAAC,IAAI,IAAI,UAAU,CAAC,CAAC;QACjF,IAAI,OAAO,CAAC,KAAK;YAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACvD,IAAI,OAAO,CAAC,MAAM;YAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoB,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACpI,CAAC;IAED,uEAAuE;IACvE,QAAQ,CAAC,IAAY,EAAE,UAAkB;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoB,EAAE,IAAI,EAAE,SAAS,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;IACpH,CAAC;CACF"}
|
package/dist/esm/ai.d.ts
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { AgentsClient, KnowledgeClient } from "./agents.js";
|
|
2
|
+
import type { HttpClient } from "./http.js";
|
|
3
|
+
export interface ChatMessage {
|
|
4
|
+
role: "system" | "user" | "assistant" | "tool" | "developer";
|
|
5
|
+
content: string | null;
|
|
6
|
+
tool_calls?: Array<{
|
|
7
|
+
id: string;
|
|
8
|
+
type: "function";
|
|
9
|
+
function: {
|
|
10
|
+
name: string;
|
|
11
|
+
arguments: string;
|
|
12
|
+
};
|
|
13
|
+
}>;
|
|
14
|
+
tool_call_id?: string;
|
|
15
|
+
name?: string;
|
|
16
|
+
}
|
|
17
|
+
export interface ChatOptions {
|
|
18
|
+
temperature?: number;
|
|
19
|
+
topP?: number;
|
|
20
|
+
maxTokens?: number;
|
|
21
|
+
stop?: string | string[];
|
|
22
|
+
/** Functions the model may ask you to call (OpenAI's `tools` format). */
|
|
23
|
+
tools?: unknown[];
|
|
24
|
+
toolChoice?: unknown;
|
|
25
|
+
/** `{ type: "json_object" }` asks for JSON back, where the provider supports it. */
|
|
26
|
+
responseFormat?: {
|
|
27
|
+
type: string;
|
|
28
|
+
[key: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
/** Any other parameter, passed through as given. */
|
|
31
|
+
extra?: Record<string, unknown>;
|
|
32
|
+
signal?: AbortSignal | null;
|
|
33
|
+
}
|
|
34
|
+
export interface ChatCompletion {
|
|
35
|
+
id: string;
|
|
36
|
+
object: "chat.completion";
|
|
37
|
+
model: string;
|
|
38
|
+
choices: Array<{
|
|
39
|
+
index: number;
|
|
40
|
+
message: ChatMessage;
|
|
41
|
+
finish_reason: string | null;
|
|
42
|
+
}>;
|
|
43
|
+
usage?: {
|
|
44
|
+
prompt_tokens: number;
|
|
45
|
+
completion_tokens: number;
|
|
46
|
+
total_tokens: number;
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
export interface AiModelInfo {
|
|
50
|
+
id: string;
|
|
51
|
+
kind: "chat" | "embedding";
|
|
52
|
+
description: string;
|
|
53
|
+
dimensions?: number;
|
|
54
|
+
}
|
|
55
|
+
export declare class AiClient {
|
|
56
|
+
private readonly http;
|
|
57
|
+
/** Agents the caller may run: `run`, `stream`, `get`, `decide`, `wait`. */
|
|
58
|
+
readonly agents: AgentsClient;
|
|
59
|
+
/** Knowledge bases the caller may search or add documents to. */
|
|
60
|
+
readonly knowledge: KnowledgeClient;
|
|
61
|
+
constructor(http: HttpClient);
|
|
62
|
+
/** The models the caller may use. */
|
|
63
|
+
models(): Promise<AiModelInfo[]>;
|
|
64
|
+
/** The full chat completion, in OpenAI's shape (tool calls, usage and all). */
|
|
65
|
+
complete(model: string, input: string | ChatMessage[], options?: ChatOptions): Promise<ChatCompletion>;
|
|
66
|
+
/** Ask a model and get its answer as text. */
|
|
67
|
+
chat(model: string, input: string | ChatMessage[], options?: ChatOptions): Promise<string>;
|
|
68
|
+
/** The answer as it is written: an async iterator of text pieces. */
|
|
69
|
+
stream(model: string, input: string | ChatMessage[], options?: ChatOptions): AsyncGenerator<string, void, void>;
|
|
70
|
+
/** The vector for one text, or one vector per text when given a list. */
|
|
71
|
+
embed(model: string, input: string, options?: {
|
|
72
|
+
signal?: AbortSignal | null;
|
|
73
|
+
}): Promise<number[]>;
|
|
74
|
+
embed(model: string, input: string[], options?: {
|
|
75
|
+
signal?: AbortSignal | null;
|
|
76
|
+
}): Promise<number[][]>;
|
|
77
|
+
}
|
|
78
|
+
//# sourceMappingURL=ai.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ai.d.ts","sourceRoot":"","sources":["../../src/ai.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,MAAM,GAAG,WAAW,CAAC;IAC7D,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,CAAC,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC,CAAC;IACpG,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,yEAAyE;IACzE,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,oFAAoF;IACpF,cAAc,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAC1D,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,iBAAiB,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,WAAW,CAAC;QAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC,CAAC;IACtF,KAAK,CAAC,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,iBAAiB,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;CACpF;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAqBD,qBAAa,QAAQ;IAMP,OAAO,CAAC,QAAQ,CAAC,IAAI;IALjC,2EAA2E;IAC3E,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,iEAAiE;IACjE,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;gBAEP,IAAI,EAAE,UAAU;IAK7C,qCAAqC;IAC/B,MAAM,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAKtC,+EAA+E;IAC/E,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW,EAAE,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,cAAc,CAAC;IAS1G,8CAA8C;IACxC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW,EAAE,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAKpG,qEAAqE;IAC9D,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW,EAAE,EAAE,OAAO,GAAE,WAAgB,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC;IA4C1H,yEAAyE;IACzE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IACjG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;CAWtG"}
|