aamp-sdk 0.1.20 → 0.1.22
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 +71 -1
- package/dist/client.d.ts +20 -1
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +61 -10
- package/dist/client.js.map +1 -1
- package/dist/index.d.ts +4 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/jmap-push.d.ts +3 -1
- package/dist/jmap-push.d.ts.map +1 -1
- package/dist/jmap-push.js +6 -0
- package/dist/jmap-push.js.map +1 -1
- package/dist/pairing.d.ts +51 -0
- package/dist/pairing.js +180 -0
- package/dist/pairing.js.map +1 -0
- package/dist/parser.d.ts +10 -1
- package/dist/parser.d.ts.map +1 -1
- package/dist/parser.js +77 -7
- package/dist/parser.js.map +1 -1
- package/dist/smtp-sender.d.ts +9 -1
- package/dist/smtp-sender.d.ts.map +1 -1
- package/dist/smtp-sender.js +277 -67
- package/dist/smtp-sender.js.map +1 -1
- package/dist/types.d.ts +48 -6
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +2 -1
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* AAMP SDK Type Definitions
|
|
3
3
|
*/
|
|
4
4
|
export declare const AAMP_PROTOCOL_VERSION = "1.1";
|
|
5
|
-
export type AampIntent = 'task.dispatch' | 'task.cancel' | 'task.result' | 'task.help_needed' | 'task.ack' | 'task.stream.opened' | 'card.query' | 'card.response';
|
|
5
|
+
export type AampIntent = 'task.dispatch' | 'task.cancel' | 'task.result' | 'task.help_needed' | 'task.ack' | 'task.stream.opened' | 'pair.request' | 'pair.respond' | 'card.query' | 'card.response';
|
|
6
6
|
export type TaskPriority = 'urgent' | 'high' | 'normal';
|
|
7
7
|
export type TaskStatus = 'pending' | 'running' | 'completed' | 'rejected' | 'failed' | 'help_needed' | 'cancelled' | 'expired';
|
|
8
8
|
export type AampFetch = typeof fetch;
|
|
@@ -11,7 +11,6 @@ export declare const AAMP_HEADER: {
|
|
|
11
11
|
readonly INTENT: "X-AAMP-Intent";
|
|
12
12
|
readonly TASK_ID: "X-AAMP-TaskId";
|
|
13
13
|
readonly SESSION_KEY: "X-AAMP-Session-Key";
|
|
14
|
-
readonly CONTEXT_LINKS: "X-AAMP-ContextLinks";
|
|
15
14
|
readonly DISPATCH_CONTEXT: "X-AAMP-Dispatch-Context";
|
|
16
15
|
readonly PRIORITY: "X-AAMP-Priority";
|
|
17
16
|
readonly EXPIRES_AT: "X-AAMP-Expires-At";
|
|
@@ -23,6 +22,8 @@ export declare const AAMP_HEADER: {
|
|
|
23
22
|
readonly BLOCKED_REASON: "X-AAMP-BlockedReason";
|
|
24
23
|
readonly SUGGESTED_OPTIONS: "X-AAMP-SuggestedOptions";
|
|
25
24
|
readonly STREAM_ID: "X-AAMP-Stream-Id";
|
|
25
|
+
readonly PAIR_CODE: "X-AAMP-Pair-Code";
|
|
26
|
+
readonly DISPATCH_CONTEXT_RULES: "X-AAMP-Dispatch-Context-Rules";
|
|
26
27
|
readonly PARENT_TASK_ID: "X-AAMP-ParentTaskId";
|
|
27
28
|
readonly CARD_SUMMARY: "X-AAMP-Card-Summary";
|
|
28
29
|
};
|
|
@@ -42,7 +43,6 @@ export interface TaskDispatch {
|
|
|
42
43
|
title: string;
|
|
43
44
|
priority: TaskPriority;
|
|
44
45
|
expiresAt?: string;
|
|
45
|
-
contextLinks: string[];
|
|
46
46
|
dispatchContext?: Record<string, string>;
|
|
47
47
|
parentTaskId?: string;
|
|
48
48
|
from: string;
|
|
@@ -120,6 +120,31 @@ export interface TaskStreamOpened {
|
|
|
120
120
|
to: string;
|
|
121
121
|
messageId?: string;
|
|
122
122
|
}
|
|
123
|
+
export interface PairRequest {
|
|
124
|
+
protocolVersion: string;
|
|
125
|
+
intent: 'pair.request';
|
|
126
|
+
taskId: string;
|
|
127
|
+
pairCode: string;
|
|
128
|
+
dispatchContextRules: Record<string, string[]>;
|
|
129
|
+
from: string;
|
|
130
|
+
to: string;
|
|
131
|
+
messageId?: string;
|
|
132
|
+
subject: string;
|
|
133
|
+
bodyText: string;
|
|
134
|
+
}
|
|
135
|
+
export interface PairRespond {
|
|
136
|
+
protocolVersion: string;
|
|
137
|
+
intent: 'pair.respond';
|
|
138
|
+
taskId: string;
|
|
139
|
+
status: 'completed' | 'rejected';
|
|
140
|
+
success: boolean;
|
|
141
|
+
reason?: string;
|
|
142
|
+
from: string;
|
|
143
|
+
to: string;
|
|
144
|
+
messageId?: string;
|
|
145
|
+
subject: string;
|
|
146
|
+
bodyText: string;
|
|
147
|
+
}
|
|
123
148
|
export interface CardQuery {
|
|
124
149
|
protocolVersion: string;
|
|
125
150
|
intent: 'card.query';
|
|
@@ -155,7 +180,7 @@ export interface ReceivedAttachment {
|
|
|
155
180
|
size: number;
|
|
156
181
|
blobId: string;
|
|
157
182
|
}
|
|
158
|
-
export type AampMessage = TaskDispatch | TaskCancel | TaskResult | TaskHelp | TaskAck | TaskStreamOpened | CardQuery | CardResponse | HumanReply;
|
|
183
|
+
export type AampMessage = TaskDispatch | TaskCancel | TaskResult | TaskHelp | TaskAck | TaskStreamOpened | PairRequest | PairRespond | CardQuery | CardResponse | HumanReply;
|
|
159
184
|
export interface AampClientConfig {
|
|
160
185
|
/** Node email address, e.g. codereviewer-abc123@aamp.yourdomain.com */
|
|
161
186
|
email: string;
|
|
@@ -254,11 +279,15 @@ export interface AampThreadEvent {
|
|
|
254
279
|
intent: AampIntent;
|
|
255
280
|
from: string;
|
|
256
281
|
to: string;
|
|
282
|
+
status?: string | null;
|
|
257
283
|
title?: string | null;
|
|
258
284
|
bodyText?: string | null;
|
|
259
285
|
output?: string | null;
|
|
286
|
+
errorMsg?: string | null;
|
|
287
|
+
structuredResult?: StructuredResultField[];
|
|
260
288
|
question?: string | null;
|
|
261
289
|
blockedReason?: string | null;
|
|
290
|
+
attachments?: ReceivedAttachment[];
|
|
262
291
|
messageId?: string | null;
|
|
263
292
|
createdAt: string;
|
|
264
293
|
}
|
|
@@ -285,7 +314,6 @@ export interface SendTaskOptions {
|
|
|
285
314
|
/** Absolute expiry timestamp. */
|
|
286
315
|
expiresAt?: string;
|
|
287
316
|
sessionKey?: string;
|
|
288
|
-
contextLinks?: string[];
|
|
289
317
|
dispatchContext?: Record<string, string>;
|
|
290
318
|
parentTaskId?: string;
|
|
291
319
|
/** Attachments to include with the dispatch email */
|
|
@@ -316,7 +344,6 @@ export interface SendRegisteredCommandOptions {
|
|
|
316
344
|
priority?: TaskPriority;
|
|
317
345
|
expiresAt?: string;
|
|
318
346
|
sessionKey?: string;
|
|
319
|
-
contextLinks?: string[];
|
|
320
347
|
dispatchContext?: Record<string, string>;
|
|
321
348
|
parentTaskId?: string;
|
|
322
349
|
attachments?: AampAttachment[];
|
|
@@ -362,6 +389,19 @@ export interface SendCardQueryOptions {
|
|
|
362
389
|
bodyText?: string;
|
|
363
390
|
inReplyTo?: string;
|
|
364
391
|
}
|
|
392
|
+
export interface SendPairRequestOptions {
|
|
393
|
+
to: string;
|
|
394
|
+
taskId?: string;
|
|
395
|
+
pairCode: string;
|
|
396
|
+
dispatchContextRules?: Record<string, string[]>;
|
|
397
|
+
}
|
|
398
|
+
export interface SendPairRespondOptions {
|
|
399
|
+
to: string;
|
|
400
|
+
taskId: string;
|
|
401
|
+
success: boolean;
|
|
402
|
+
reason?: string;
|
|
403
|
+
inReplyTo?: string;
|
|
404
|
+
}
|
|
365
405
|
export interface SendCardResponseOptions {
|
|
366
406
|
to: string;
|
|
367
407
|
taskId: string;
|
|
@@ -431,6 +471,8 @@ export interface AampClientEvents {
|
|
|
431
471
|
'task.help_needed': (help: TaskHelp) => void;
|
|
432
472
|
'task.ack': (ack: TaskAck) => void;
|
|
433
473
|
'task.stream.opened': (stream: TaskStreamOpened) => void;
|
|
474
|
+
'pair.request': (request: PairRequest) => void;
|
|
475
|
+
'pair.respond': (response: PairRespond) => void;
|
|
434
476
|
'card.query': (query: CardQuery) => void;
|
|
435
477
|
'card.response': (response: CardResponse) => void;
|
|
436
478
|
/** Emitted when a standard email reply (no X-AAMP headers) is received for a known thread.
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,UAAU,GAAG,eAAe,GAAG,aAAa,GAAG,WAAW,GAAG,UAAU,CAAA;AAEnF,MAAM,MAAM,UAAU,GAClB,SAAS,GACT,SAAS,GACT,WAAW,GACX,UAAU,GACV,QAAQ,GACR,SAAS,GACT,aAAa,CAAA;AAKjB,eAAO,MAAM,WAAW;;;;;;;;;;;;;;CAcd,CAAA;AAEV,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC/B;AAKD,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,eAAe,CAAA;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxC,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAA;IAChB,uEAAuE;IACvE,WAAW,CAAC,EAAE,kBAAkB,EAAE,CAAA;CACnC;AAKD,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,aAAa,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,WAAW,GAAG,UAAU,CAAA;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,gBAAgB,CAAC,EAAE,qBAAqB,EAAE,CAAA;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;2EACuE;IACvE,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,qEAAqE;IACrE,WAAW,CAAC,EAAE,kBAAkB,EAAE,CAAA;CACnC;AAQD,MAAM,WAAW,UAAU;IACzB,gFAAgF;IAChF,SAAS,EAAE,MAAM,CAAA;IACjB,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;CACjB;AAKD,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,WAAW,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAKD,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,UAAU,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAMD,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,qEAAqE;AACrE,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAA;AAKrF,MAAM,WAAW,gBAAgB;IAC/B,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAA;IAEb,oFAAoF;IACpF,SAAS,EAAE,MAAM,CAAA;IAEjB,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAA;IAEf,gHAAgH;IAChH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAEhB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,uEAAuE;IACvE,YAAY,EAAE,MAAM,CAAA;IAEpB,oEAAoE;IACpE,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;2EACuE;IACvE,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAKD,MAAM,WAAW,eAAe;IAC9B,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,qDAAqD;IACrD,WAAW,CAAC,EAAE,cAAc,EAAE,CAAA;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC,+DAA+D;IAC/D,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,WAAW,GAAG,UAAU,CAAA;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,gBAAgB,CAAC,EAAE,qBAAqB,EAAE,CAAA;IAC1C,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,mDAAmD;IACnD,WAAW,CAAC,EAAE,cAAc,EAAE,CAAA;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,+DAA+D;IAC/D,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,iDAAiD;IACjD,WAAW,CAAC,EAAE,cAAc,EAAE,CAAA;CAC/B;AAKD,MAAM,WAAW,gBAAgB;IAC/B,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAA;IAC7C,aAAa,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAA;IAC3C,WAAW,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAA;IACrC,UAAU,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAA;IAClC;8EAC0E;IAC1E,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAA;IACpC,SAAS,EAAE,MAAM,IAAI,CAAA;IACrB,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IACtC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,CAAA;CAC5B"}
|
package/dist/types.js
CHANGED
|
@@ -10,7 +10,6 @@ export const AAMP_HEADER = {
|
|
|
10
10
|
INTENT: 'X-AAMP-Intent',
|
|
11
11
|
TASK_ID: 'X-AAMP-TaskId',
|
|
12
12
|
SESSION_KEY: 'X-AAMP-Session-Key',
|
|
13
|
-
CONTEXT_LINKS: 'X-AAMP-ContextLinks',
|
|
14
13
|
DISPATCH_CONTEXT: 'X-AAMP-Dispatch-Context',
|
|
15
14
|
PRIORITY: 'X-AAMP-Priority',
|
|
16
15
|
EXPIRES_AT: 'X-AAMP-Expires-At',
|
|
@@ -22,6 +21,8 @@ export const AAMP_HEADER = {
|
|
|
22
21
|
BLOCKED_REASON: 'X-AAMP-BlockedReason',
|
|
23
22
|
SUGGESTED_OPTIONS: 'X-AAMP-SuggestedOptions',
|
|
24
23
|
STREAM_ID: 'X-AAMP-Stream-Id',
|
|
24
|
+
PAIR_CODE: 'X-AAMP-Pair-Code',
|
|
25
|
+
DISPATCH_CONTEXT_RULES: 'X-AAMP-Dispatch-Context-Rules',
|
|
25
26
|
PARENT_TASK_ID: 'X-AAMP-ParentTaskId',
|
|
26
27
|
CARD_SUMMARY: 'X-AAMP-Card-Summary',
|
|
27
28
|
};
|
package/dist/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,CAAA;
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,CAAA;AA4B1C,wDAAwD;AACxD,wBAAwB;AACxB,wDAAwD;AACxD,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,OAAO,EAAE,gBAAgB;IACzB,MAAM,EAAE,eAAe;IACvB,OAAO,EAAE,eAAe;IACxB,WAAW,EAAE,oBAAoB;IACjC,gBAAgB,EAAE,yBAAyB;IAC3C,QAAQ,EAAE,iBAAiB;IAC3B,UAAU,EAAE,mBAAmB;IAC/B,MAAM,EAAE,eAAe;IACvB,MAAM,EAAE,eAAe;IACvB,SAAS,EAAE,iBAAiB;IAC5B,iBAAiB,EAAE,yBAAyB;IAC5C,QAAQ,EAAE,iBAAiB;IAC3B,cAAc,EAAE,sBAAsB;IACtC,iBAAiB,EAAE,yBAAyB;IAC5C,SAAS,EAAE,kBAAkB;IAC7B,SAAS,EAAE,kBAAkB;IAC7B,sBAAsB,EAAE,+BAA+B;IACvD,cAAc,EAAE,qBAAqB;IACrC,YAAY,EAAE,qBAAqB;CAC3B,CAAA"}
|