@macro-inc/sdk 0.0.1 → 0.2.2
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 +628 -21
- package/dist/{chunk-5HAKQN23.js → chunk-7LVVPVNT.js} +70 -57
- package/dist/{chunk-JXIQT5TH.js → chunk-7YJ6Y7HJ.js} +234 -16
- package/dist/chunk-LMJW65ML.js +836 -0
- package/dist/{chunk-SGAHIERJ.js → chunk-OGE7WXJE.js} +16 -0
- package/dist/chunk-PRUFPW3B.js +943 -0
- package/dist/{chunk-CTKR64MY.js → chunk-QVBNNMQS.js} +242 -367
- package/dist/{chunk-QNUS5BC5.js → chunk-SUINKDXF.js} +30 -84
- package/dist/{chunk-77EI4LSQ.js → chunk-ZQXOHNDB.js} +1518 -386
- package/dist/generated/agent-harness/index.d.ts +1 -1
- package/dist/generated/agent-harness/index.js +1 -1
- package/dist/generated/agent-harness/sdk.gen.d.ts +174 -4
- package/dist/generated/agent-harness/types.gen.d.ts +2511 -189
- package/dist/generated/auth/index.d.ts +1 -1
- package/dist/generated/auth/index.js +1 -1
- package/dist/generated/auth/sdk.gen.d.ts +106 -8
- package/dist/generated/auth/types.gen.d.ts +1473 -116
- package/dist/generated/calendar/client/client.gen.d.ts +2 -0
- package/dist/generated/calendar/client/index.d.ts +10 -0
- package/dist/generated/calendar/client/types.gen.d.ts +120 -0
- package/dist/generated/calendar/client/utils.gen.d.ts +37 -0
- package/dist/generated/calendar/client.gen.d.ts +12 -0
- package/dist/generated/calendar/core/auth.gen.d.ts +25 -0
- package/dist/generated/calendar/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/calendar/core/params.gen.d.ts +43 -0
- package/dist/generated/calendar/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/calendar/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/calendar/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/calendar/core/types.gen.d.ts +83 -0
- package/dist/generated/calendar/core/utils.gen.d.ts +19 -0
- package/dist/generated/calendar/index.d.ts +2 -0
- package/dist/generated/calendar/index.js +6 -0
- package/dist/generated/calendar/sdk.gen.d.ts +95 -0
- package/dist/generated/calendar/types.gen.d.ts +1091 -0
- package/dist/generated/cognition/index.d.ts +1 -1
- package/dist/generated/cognition/index.js +1 -1
- package/dist/generated/cognition/sdk.gen.d.ts +6 -1
- package/dist/generated/cognition/types.gen.d.ts +304 -36
- package/dist/generated/connection/types.gen.d.ts +1 -1
- package/dist/generated/email/index.d.ts +1 -1
- package/dist/generated/email/index.js +1 -1
- package/dist/generated/email/sdk.gen.d.ts +32 -27
- package/dist/generated/email/types.gen.d.ts +586 -409
- package/dist/generated/notification/index.d.ts +1 -1
- package/dist/generated/notification/types.gen.d.ts +384 -19
- package/dist/generated/properties/types.gen.d.ts +8 -5
- package/dist/generated/scheduled-action/index.d.ts +1 -1
- package/dist/generated/scheduled-action/index.js +3 -842
- package/dist/generated/scheduled-action/sdk.gen.d.ts +3 -1
- package/dist/generated/scheduled-action/types.gen.d.ts +277 -41
- package/dist/generated/search/index.d.ts +1 -1
- package/dist/generated/search/types.gen.d.ts +262 -43
- package/dist/generated/storage/index.d.ts +1 -1
- package/dist/generated/storage/index.js +1 -1
- package/dist/generated/storage/sdk.gen.d.ts +678 -107
- package/dist/generated/storage/types.gen.d.ts +14827 -5995
- package/dist/generated/unfurl/index.d.ts +1 -1
- package/dist/generated/unfurl/index.js +3 -832
- package/dist/generated/unfurl/types.gen.d.ts +20 -0
- package/dist/src/config.d.ts +33 -13
- package/dist/src/entities/agent-sessions/agent-session.d.ts +150 -6
- package/dist/src/entities/agent-sessions/code-execution.d.ts +43 -0
- package/dist/src/entities/agent-sessions/conversation.d.ts +54 -0
- package/dist/src/entities/agent-sessions/namespace.d.ts +23 -5
- package/dist/src/entities/agent-sessions/queued-action.d.ts +46 -0
- package/dist/src/entities/agent-sessions/review.d.ts +107 -0
- package/dist/src/entities/agent-sessions/tool-approval.d.ts +21 -0
- package/dist/src/entities/agents/agent.d.ts +47 -0
- package/dist/src/entities/agents/namespace.d.ts +13 -0
- package/dist/src/entities/ai/namespace.d.ts +24 -0
- package/dist/src/entities/api-keys/api-key.d.ts +17 -0
- package/dist/src/entities/api-keys/namespace.d.ts +18 -0
- package/dist/src/entities/calendar/calendar.d.ts +35 -0
- package/dist/src/entities/calendar/event.d.ts +123 -0
- package/dist/src/entities/calendar/event.test.d.ts +1 -0
- package/dist/src/entities/calendar/namespace.d.ts +111 -0
- package/dist/src/entities/calendar/replacement.d.ts +15 -0
- package/dist/src/entities/calls/call-record.d.ts +62 -6
- package/dist/src/entities/calls/message.d.ts +33 -0
- package/dist/src/entities/channels/activity.d.ts +24 -0
- package/dist/src/entities/channels/channel.d.ts +44 -3
- package/dist/src/entities/channels/labels.d.ts +39 -0
- package/dist/src/entities/channels/message.d.ts +9 -17
- package/dist/src/entities/channels/namespace.d.ts +6 -0
- package/dist/src/entities/channels/picture.d.ts +11 -0
- package/dist/src/entities/channels/post.d.ts +1 -1
- package/dist/src/entities/channels/thread.d.ts +5 -0
- package/dist/src/entities/chats/chat.d.ts +11 -1
- package/dist/src/entities/chats/generation.d.ts +46 -0
- package/dist/src/entities/crm/comment.d.ts +55 -34
- package/dist/src/entities/crm/company.d.ts +42 -10
- package/dist/src/entities/crm/contact.d.ts +42 -10
- package/dist/src/entities/crm/namespace.d.ts +18 -1
- package/dist/src/entities/crm/pipeline.d.ts +122 -0
- package/dist/src/entities/crm/pipelines.d.ts +14 -0
- package/dist/src/entities/databases/column.d.ts +75 -0
- package/dist/src/entities/databases/database.d.ts +272 -0
- package/dist/src/entities/databases/namespace.d.ts +21 -0
- package/dist/src/entities/databases/query.d.ts +86 -0
- package/dist/src/entities/databases/row.d.ts +27 -0
- package/dist/src/entities/databases/table.d.ts +61 -0
- package/dist/src/entities/databases/view.d.ts +40 -0
- package/dist/src/entities/databases/webhook.d.ts +32 -0
- package/dist/src/entities/documents/anchor.d.ts +29 -0
- package/dist/src/entities/documents/comment.d.ts +25 -22
- package/dist/src/entities/documents/document.d.ts +60 -12
- package/dist/src/entities/documents/namespace.d.ts +30 -0
- package/dist/src/entities/documents/version.d.ts +22 -0
- package/dist/src/entities/email/draft.d.ts +79 -0
- package/dist/src/entities/email/filter.d.ts +34 -0
- package/dist/src/entities/email/link.d.ts +6 -4
- package/dist/src/entities/email/message.d.ts +12 -1
- package/dist/src/entities/email/namespace.d.ts +34 -1
- package/dist/src/entities/email/thread.d.ts +23 -1
- package/dist/src/entities/entity-mentions/mention.d.ts +16 -0
- package/dist/src/entities/entity-mentions/namespace.d.ts +12 -0
- package/dist/src/entities/entity.d.ts +7 -0
- package/dist/src/entities/favorites/namespace.d.ts +14 -2
- package/dist/src/entities/foreign/foreign-entity.d.ts +2 -0
- package/dist/src/entities/foreign/namespace.d.ts +40 -0
- package/dist/src/entities/forms/form.d.ts +227 -0
- package/dist/src/entities/forms/namespace.d.ts +18 -0
- package/dist/src/entities/forms/question.d.ts +37 -0
- package/dist/src/entities/forms/response.d.ts +32 -0
- package/dist/src/entities/forms/section.d.ts +19 -0
- package/dist/src/entities/github-pull-requests/namespace.d.ts +12 -0
- package/dist/src/entities/github-pull-requests/pull-request.d.ts +52 -0
- package/dist/src/entities/harnesses/harness.d.ts +19 -0
- package/dist/src/entities/harnesses/namespace.d.ts +33 -0
- package/dist/src/entities/harnesses/pairing.d.ts +39 -0
- package/dist/src/entities/initiatives/initiative.d.ts +50 -0
- package/dist/src/entities/initiatives/namespace.d.ts +13 -0
- package/dist/src/entities/meetings/meeting.d.ts +38 -0
- package/dist/src/entities/meetings/namespace.d.ts +18 -0
- package/dist/src/entities/messages/thread.d.ts +101 -0
- package/dist/src/entities/notifications/notification.d.ts +6 -3
- package/dist/src/entities/notifications/notification.test.d.ts +1 -0
- package/dist/src/entities/projects/project.d.ts +7 -0
- package/dist/src/entities/reference.d.ts +82 -0
- package/dist/src/entities/routines/namespace.d.ts +15 -0
- package/dist/src/entities/routines/routine.d.ts +115 -0
- package/dist/src/entities/sharing/access.d.ts +65 -0
- package/dist/src/entities/sharing/permissions.d.ts +13 -0
- package/dist/src/entities/tasks/namespace.d.ts +4 -0
- package/dist/src/entities/tasks/task.d.ts +6 -0
- package/dist/src/entities/unfurls/namespace.d.ts +10 -0
- package/dist/src/entities/webhooks/webhook.d.ts +3 -1
- package/dist/src/entities/workspace/items.d.ts +7 -0
- package/dist/src/entities/workspace/namespace.d.ts +83 -0
- package/dist/src/entities/workspace/query.d.ts +12 -0
- package/dist/src/entities/workspace/types.d.ts +96 -0
- package/dist/src/events/hydrate/agentSession.d.ts +192 -0
- package/dist/src/events/hydrate/channel.d.ts +2 -39
- package/dist/src/events/hydrate/message.d.ts +70 -0
- package/dist/src/events/receiver.d.ts +57 -19
- package/dist/src/events/types.d.ts +3 -1
- package/dist/src/macro.d.ts +80 -3
- package/dist/src/macro.js +8832 -2784
- package/dist/src/utils/activity.d.ts +11 -0
- package/dist/src/utils/activity.test.d.ts +1 -0
- package/dist/src/utils/client.d.ts +10 -1
- package/dist/src/utils/concurrency.d.ts +5 -0
- package/dist/src/utils/index.d.ts +1 -0
- package/dist/src/utils/pagination.d.ts +9 -4
- package/package.json +11 -3
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import type { ApiEntityFilterAst, SoupApiItem } from '../../../generated/storage/types.gen';
|
|
2
|
+
import type { CalendarEvent } from '../calendar/event';
|
|
3
|
+
import type { CallRecord } from '../calls/call-record';
|
|
4
|
+
import type { Channel } from '../channels/channel';
|
|
5
|
+
import type { Thread } from '../channels/thread';
|
|
6
|
+
import type { Chat } from '../chats/chat';
|
|
7
|
+
import type { Document } from '../documents/document';
|
|
8
|
+
import type { EmailThread } from '../email/thread';
|
|
9
|
+
import type { ForeignEntity } from '../foreign/foreign-entity';
|
|
10
|
+
import type { Project } from '../projects/project';
|
|
11
|
+
/** Workspace types supported by the browsing API. Tasks are documents. */
|
|
12
|
+
export type WorkspaceType = 'calendar_event' | 'document' | 'ai_chat' | 'project' | 'email' | 'channel' | 'channel_thread' | 'call' | 'foreign_entity';
|
|
13
|
+
/** A tag label visible to the caller, optionally qualified by ownership scope. */
|
|
14
|
+
export type WorkspaceTag = {
|
|
15
|
+
label: string;
|
|
16
|
+
scope: 'personal' | 'team';
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Server-validated AST filters, identical to the normal workspace API. Use
|
|
20
|
+
* `{l: literal}`, `{'&': [left, right]}`, `{'|': [left, right]}` or `{'!': expr}`.
|
|
21
|
+
* `&` and `|` require exactly two expressions; nest them for three or more.
|
|
22
|
+
* A single condition is `{l: literal}` without an `&` wrapper.
|
|
23
|
+
* Each entity filter applies only to that type; `propf` applies across types.
|
|
24
|
+
* See {@link WorkspaceNamespace} for task and time-window examples.
|
|
25
|
+
*/
|
|
26
|
+
export type WorkspaceFilters = Pick<ApiEntityFilterAst, 'df' | 'pf' | 'cf' | 'ef' | 'chanf' | 'cthf' | 'callf' | 'fef' | 'calf' | 'propf'>;
|
|
27
|
+
/** Options shared by bounded pages and automatic iteration. */
|
|
28
|
+
export type WorkspaceListOptions = WorkspaceFilters & {
|
|
29
|
+
/** Omitted or empty means all supported types; signal defaults to email when omitted. */
|
|
30
|
+
includeTypes?: WorkspaceType[];
|
|
31
|
+
favoritesOnly?: boolean;
|
|
32
|
+
/** Defaults to recently_updated, descending. */
|
|
33
|
+
sortBy?: 'recently_viewed' | 'recently_updated' | 'recently_created';
|
|
34
|
+
/** Page size, default 50, clamped to 1–500. Iteration may fetch many pages. */
|
|
35
|
+
limit?: number;
|
|
36
|
+
/** Case-insensitive labels resolved against the caller's personal/team tags. */
|
|
37
|
+
tags?: Array<{
|
|
38
|
+
label: string;
|
|
39
|
+
scope?: 'personal' | 'team';
|
|
40
|
+
}>;
|
|
41
|
+
/** Default any. All rejects ambiguous unscoped labels rather than guessing. */
|
|
42
|
+
tagsMatch?: 'any' | 'all';
|
|
43
|
+
/** Connected inbox email address. Omit to include all accessible/delegated inboxes. */
|
|
44
|
+
inbox?: string;
|
|
45
|
+
/** Important/signal email: overrides ef with Importance=true AND Shared=exclude. */
|
|
46
|
+
emailPreset?: 'signal';
|
|
47
|
+
/** Default inbox. Use signal + inbox for important emails, not the important view. */
|
|
48
|
+
emailView?: 'inbox' | 'sent' | 'drafts' | 'starred' | 'all' | 'important' | 'other' | `user:${string}`;
|
|
49
|
+
};
|
|
50
|
+
/** Resume a page with its opaque cursor and the same options. */
|
|
51
|
+
export type WorkspacePageOptions = WorkspaceListOptions & {
|
|
52
|
+
cursor?: string;
|
|
53
|
+
};
|
|
54
|
+
type Entry<Tag extends SoupApiItem['tag'], Type extends WorkspaceType, Entity> = {
|
|
55
|
+
type: Type;
|
|
56
|
+
id: string;
|
|
57
|
+
/** Existing entity handle for subsequent reads or mutations; no eager detail fetch. */
|
|
58
|
+
entity: Entity;
|
|
59
|
+
/** Full generated API snapshot, including timestamps and type-specific metadata. */
|
|
60
|
+
snapshot: Extract<SoupApiItem, {
|
|
61
|
+
tag: Tag;
|
|
62
|
+
}>;
|
|
63
|
+
/** Visible labels only; option IDs outside the caller's tag sets are excluded. */
|
|
64
|
+
tags: WorkspaceTag[];
|
|
65
|
+
};
|
|
66
|
+
/** Discriminated listing result. Read snapshot data without additional API calls. */
|
|
67
|
+
export type WorkspaceItem = (Entry<'document', 'document', Document> & {
|
|
68
|
+
name: string;
|
|
69
|
+
fileType?: string | null;
|
|
70
|
+
subType?: string | null;
|
|
71
|
+
}) | (Entry<'chat', 'ai_chat', Chat> & {
|
|
72
|
+
name: string;
|
|
73
|
+
}) | (Entry<'project', 'project', Project> & {
|
|
74
|
+
name: string;
|
|
75
|
+
}) | (Entry<'emailThread', 'email', EmailThread> & Pick<Extract<SoupApiItem, {
|
|
76
|
+
tag: 'emailThread';
|
|
77
|
+
}>['data'], 'snippet' | 'senderName' | 'senderEmail' | 'inboxVisible' | 'isRead' | 'isDraft'> & {
|
|
78
|
+
subject?: string | null;
|
|
79
|
+
}) | (Entry<'channel', 'channel', Channel> & {
|
|
80
|
+
name?: string | null;
|
|
81
|
+
}) | (Entry<'channelThread', 'channel_thread', Thread> & {
|
|
82
|
+
channelId: string;
|
|
83
|
+
}) | (Entry<'call', 'call', CallRecord> & {
|
|
84
|
+
createdBy: string;
|
|
85
|
+
}) | (Entry<'calendarEvent', 'calendar_event', CalendarEvent> & Pick<Extract<SoupApiItem, {
|
|
86
|
+
tag: 'calendarEvent';
|
|
87
|
+
}>['data'], 'title' | 'status' | 'location' | 'conferenceUrl' | 'conferenceProvider' | 'time'>) | (Entry<'foreignEntity', 'foreign_entity', ForeignEntity> & Pick<Extract<SoupApiItem, {
|
|
88
|
+
tag: 'foreignEntity';
|
|
89
|
+
}>['data'], 'foreignEntityId' | 'foreignEntitySource' | 'metadata'>);
|
|
90
|
+
/** A bounded page. A cursor means more results exist, not an exact total count. */
|
|
91
|
+
export type WorkspacePage = {
|
|
92
|
+
items: WorkspaceItem[];
|
|
93
|
+
nextCursor?: string | null;
|
|
94
|
+
hasMore: boolean;
|
|
95
|
+
};
|
|
96
|
+
export {};
|
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
import { AgentSession } from '../../entities/agent-sessions/agent-session';
|
|
2
|
+
import { Channel } from '../../entities/channels/channel';
|
|
3
|
+
import { Message } from '../../entities/channels/message';
|
|
4
|
+
import { Thread } from '../../entities/channels/thread';
|
|
5
|
+
import { User } from '../../entities/users/user';
|
|
6
|
+
import type { MacroClient } from '../../utils/client';
|
|
7
|
+
import type { MacroEvent } from '../types';
|
|
8
|
+
export type AgentSessionEvent = Extract<MacroEvent, {
|
|
9
|
+
event_type: `agent_session.${string}`;
|
|
10
|
+
}>;
|
|
11
|
+
/** Attach SDK entity handles to an agent-session lifecycle webhook event. */
|
|
12
|
+
export declare function hydrateAgentSessionEvent(client: MacroClient, event: AgentSessionEvent): {
|
|
13
|
+
channel: Channel;
|
|
14
|
+
thread: Thread;
|
|
15
|
+
session: AgentSession;
|
|
16
|
+
owner: User;
|
|
17
|
+
event_type: "agent_session.opened";
|
|
18
|
+
metadata: import("../../../generated/storage").SessionOpenedMetadata;
|
|
19
|
+
} | {
|
|
20
|
+
channel: undefined;
|
|
21
|
+
thread: undefined;
|
|
22
|
+
session: AgentSession;
|
|
23
|
+
owner: User;
|
|
24
|
+
event_type: "agent_session.opened";
|
|
25
|
+
metadata: import("../../../generated/storage").SessionOpenedMetadata;
|
|
26
|
+
} | {
|
|
27
|
+
actor: User | undefined;
|
|
28
|
+
announcement: Message | undefined;
|
|
29
|
+
channel: Channel;
|
|
30
|
+
thread: Thread;
|
|
31
|
+
session: AgentSession;
|
|
32
|
+
owner: User;
|
|
33
|
+
event_type: "agent_session.turn_started";
|
|
34
|
+
metadata: import("../../../generated/storage").TurnStartedMetadata;
|
|
35
|
+
} | {
|
|
36
|
+
actor: User | undefined;
|
|
37
|
+
announcement: Message | undefined;
|
|
38
|
+
channel: undefined;
|
|
39
|
+
thread: undefined;
|
|
40
|
+
session: AgentSession;
|
|
41
|
+
owner: User;
|
|
42
|
+
event_type: "agent_session.turn_started";
|
|
43
|
+
metadata: import("../../../generated/storage").TurnStartedMetadata;
|
|
44
|
+
} | {
|
|
45
|
+
actor: User | undefined;
|
|
46
|
+
announcement: Message | undefined;
|
|
47
|
+
channel: Channel;
|
|
48
|
+
thread: Thread;
|
|
49
|
+
session: AgentSession;
|
|
50
|
+
owner: User;
|
|
51
|
+
event_type: "agent_session.turn_ended";
|
|
52
|
+
metadata: import("../../../generated/storage").TurnEndedMetadata;
|
|
53
|
+
} | {
|
|
54
|
+
actor: User | undefined;
|
|
55
|
+
announcement: Message | undefined;
|
|
56
|
+
channel: undefined;
|
|
57
|
+
thread: undefined;
|
|
58
|
+
session: AgentSession;
|
|
59
|
+
owner: User;
|
|
60
|
+
event_type: "agent_session.turn_ended";
|
|
61
|
+
metadata: import("../../../generated/storage").TurnEndedMetadata;
|
|
62
|
+
} | {
|
|
63
|
+
actor: User | undefined;
|
|
64
|
+
announcement: Message | undefined;
|
|
65
|
+
channel: Channel;
|
|
66
|
+
thread: Thread;
|
|
67
|
+
session: AgentSession;
|
|
68
|
+
owner: User;
|
|
69
|
+
event_type: "agent_session.command_rejected";
|
|
70
|
+
metadata: import("../../../generated/storage").CommandRejectedMetadata;
|
|
71
|
+
} | {
|
|
72
|
+
actor: User | undefined;
|
|
73
|
+
announcement: Message | undefined;
|
|
74
|
+
channel: undefined;
|
|
75
|
+
thread: undefined;
|
|
76
|
+
session: AgentSession;
|
|
77
|
+
owner: User;
|
|
78
|
+
event_type: "agent_session.command_rejected";
|
|
79
|
+
metadata: import("../../../generated/storage").CommandRejectedMetadata;
|
|
80
|
+
} | {
|
|
81
|
+
actor: User | undefined;
|
|
82
|
+
announcement: Message | undefined;
|
|
83
|
+
channel: Channel;
|
|
84
|
+
thread: Thread;
|
|
85
|
+
session: AgentSession;
|
|
86
|
+
owner: User;
|
|
87
|
+
event_type: "agent_session.settled";
|
|
88
|
+
metadata: import("../../../generated/storage").SessionSettledMetadata;
|
|
89
|
+
} | {
|
|
90
|
+
actor: User | undefined;
|
|
91
|
+
announcement: Message | undefined;
|
|
92
|
+
channel: undefined;
|
|
93
|
+
thread: undefined;
|
|
94
|
+
session: AgentSession;
|
|
95
|
+
owner: User;
|
|
96
|
+
event_type: "agent_session.settled";
|
|
97
|
+
metadata: import("../../../generated/storage").SessionSettledMetadata;
|
|
98
|
+
} | {
|
|
99
|
+
announcement: Message | undefined;
|
|
100
|
+
channel: Channel;
|
|
101
|
+
thread: Thread;
|
|
102
|
+
session: AgentSession;
|
|
103
|
+
owner: User;
|
|
104
|
+
event_type: "agent_session.waiting_for_input";
|
|
105
|
+
metadata: import("../../../generated/storage").WaitingForInputMetadata;
|
|
106
|
+
} | {
|
|
107
|
+
announcement: Message | undefined;
|
|
108
|
+
channel: undefined;
|
|
109
|
+
thread: undefined;
|
|
110
|
+
session: AgentSession;
|
|
111
|
+
owner: User;
|
|
112
|
+
event_type: "agent_session.waiting_for_input";
|
|
113
|
+
metadata: import("../../../generated/storage").WaitingForInputMetadata;
|
|
114
|
+
} | {
|
|
115
|
+
channel: Channel;
|
|
116
|
+
thread: Thread;
|
|
117
|
+
session: AgentSession;
|
|
118
|
+
owner: User;
|
|
119
|
+
event_type: "agent_session.input_received";
|
|
120
|
+
metadata: import("../../../generated/storage").InputReceivedMetadata;
|
|
121
|
+
} | {
|
|
122
|
+
channel: undefined;
|
|
123
|
+
thread: undefined;
|
|
124
|
+
session: AgentSession;
|
|
125
|
+
owner: User;
|
|
126
|
+
event_type: "agent_session.input_received";
|
|
127
|
+
metadata: import("../../../generated/storage").InputReceivedMetadata;
|
|
128
|
+
} | {
|
|
129
|
+
mentionedBy: User | undefined;
|
|
130
|
+
mentioned: User[];
|
|
131
|
+
channel: Channel;
|
|
132
|
+
thread: Thread;
|
|
133
|
+
session: AgentSession;
|
|
134
|
+
owner: User;
|
|
135
|
+
event_type: "agent_session.mentioned";
|
|
136
|
+
metadata: import("../../../generated/storage").SessionMentionedMetadata;
|
|
137
|
+
} | {
|
|
138
|
+
mentionedBy: User | undefined;
|
|
139
|
+
mentioned: User[];
|
|
140
|
+
channel: undefined;
|
|
141
|
+
thread: undefined;
|
|
142
|
+
session: AgentSession;
|
|
143
|
+
owner: User;
|
|
144
|
+
event_type: "agent_session.mentioned";
|
|
145
|
+
metadata: import("../../../generated/storage").SessionMentionedMetadata;
|
|
146
|
+
} | {
|
|
147
|
+
actor: User | undefined;
|
|
148
|
+
announcement: Message | undefined;
|
|
149
|
+
channel: Channel;
|
|
150
|
+
thread: Thread;
|
|
151
|
+
session: AgentSession;
|
|
152
|
+
owner: User;
|
|
153
|
+
event_type: "agent_session.stopped";
|
|
154
|
+
metadata: import("../../../generated/storage").SessionStoppedMetadata;
|
|
155
|
+
} | {
|
|
156
|
+
actor: User | undefined;
|
|
157
|
+
announcement: Message | undefined;
|
|
158
|
+
channel: undefined;
|
|
159
|
+
thread: undefined;
|
|
160
|
+
session: AgentSession;
|
|
161
|
+
owner: User;
|
|
162
|
+
event_type: "agent_session.stopped";
|
|
163
|
+
metadata: import("../../../generated/storage").SessionStoppedMetadata;
|
|
164
|
+
} | {
|
|
165
|
+
channel: Channel;
|
|
166
|
+
thread: Thread;
|
|
167
|
+
session: AgentSession;
|
|
168
|
+
owner: User;
|
|
169
|
+
event_type: "agent_session.renamed";
|
|
170
|
+
metadata: import("../../../generated/storage").SessionRenamedMetadata;
|
|
171
|
+
} | {
|
|
172
|
+
channel: undefined;
|
|
173
|
+
thread: undefined;
|
|
174
|
+
session: AgentSession;
|
|
175
|
+
owner: User;
|
|
176
|
+
event_type: "agent_session.renamed";
|
|
177
|
+
metadata: import("../../../generated/storage").SessionRenamedMetadata;
|
|
178
|
+
} | {
|
|
179
|
+
channel: Channel;
|
|
180
|
+
thread: Thread;
|
|
181
|
+
session: AgentSession;
|
|
182
|
+
owner: User;
|
|
183
|
+
event_type: "agent_session.deleted";
|
|
184
|
+
metadata: import("../../../generated/storage").SessionDeletedMetadata;
|
|
185
|
+
} | {
|
|
186
|
+
channel: undefined;
|
|
187
|
+
thread: undefined;
|
|
188
|
+
session: AgentSession;
|
|
189
|
+
owner: User;
|
|
190
|
+
event_type: "agent_session.deleted";
|
|
191
|
+
metadata: import("../../../generated/storage").SessionDeletedMetadata;
|
|
192
|
+
};
|
|
@@ -1,6 +1,4 @@
|
|
|
1
1
|
import { Channel } from '../../entities/channels/channel';
|
|
2
|
-
import { Message } from '../../entities/channels/message';
|
|
3
|
-
import { Thread } from '../../entities/channels/thread';
|
|
4
2
|
import { User } from '../../entities/users/user';
|
|
5
3
|
import type { MacroClient } from '../../utils/client';
|
|
6
4
|
import type { MacroEvent } from '../types';
|
|
@@ -31,44 +29,9 @@ export declare function hydrateChannelEvent(client: MacroClient, event: ChannelE
|
|
|
31
29
|
channel: Channel;
|
|
32
30
|
actor: User | undefined;
|
|
33
31
|
} | {
|
|
34
|
-
event_type: "channel.
|
|
35
|
-
metadata: import("../../../generated/storage").
|
|
32
|
+
event_type: "channel.picture_changed";
|
|
33
|
+
metadata: import("../../../generated/storage").ChannelPictureChangedMetadata;
|
|
36
34
|
channel: Channel;
|
|
37
|
-
message: Message;
|
|
38
|
-
sender: User | undefined;
|
|
39
|
-
thread: Thread | undefined;
|
|
40
|
-
} | {
|
|
41
|
-
event_type: "channel.mentioned";
|
|
42
|
-
metadata: import("../../../generated/storage").ChannelMentionedMetadata;
|
|
43
|
-
channel: Channel;
|
|
44
|
-
message: Message;
|
|
45
|
-
sender: User | undefined;
|
|
46
|
-
thread: Thread | undefined;
|
|
47
|
-
} | {
|
|
48
|
-
event_type: "channel.message_patched";
|
|
49
|
-
metadata: import("../../../generated/storage").ChannelMessagePatchedMetadata;
|
|
50
|
-
channel: Channel;
|
|
51
|
-
message: Message;
|
|
52
|
-
actor: User | undefined;
|
|
53
|
-
thread: Thread | undefined;
|
|
54
|
-
} | {
|
|
55
|
-
event_type: "channel.message_deleted";
|
|
56
|
-
metadata: import("../../../generated/storage").ChannelMessageDeletedMetadata;
|
|
57
|
-
channel: Channel;
|
|
58
|
-
message: Message;
|
|
59
|
-
actor: User | undefined;
|
|
60
|
-
thread: Thread | undefined;
|
|
61
|
-
} | {
|
|
62
|
-
event_type: "channel.message_attachment_created";
|
|
63
|
-
metadata: import("../../../generated/storage").ChannelMessageAttachmentCreatedMetadata;
|
|
64
|
-
channel: Channel;
|
|
65
|
-
message: Message;
|
|
66
|
-
actor: User | undefined;
|
|
67
|
-
} | {
|
|
68
|
-
event_type: "channel.message_attachment_removed";
|
|
69
|
-
metadata: import("../../../generated/storage").ChannelMessageAttachmentRemovedMetadata;
|
|
70
|
-
channel: Channel;
|
|
71
|
-
message: Message;
|
|
72
35
|
actor: User | undefined;
|
|
73
36
|
} | {
|
|
74
37
|
event_type: "channel.participant_added";
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import { CallRecord } from '../../entities/calls/call-record';
|
|
2
|
+
import { CallMessage } from '../../entities/calls/message';
|
|
3
|
+
import { Channel } from '../../entities/channels/channel';
|
|
4
|
+
import { Message } from '../../entities/channels/message';
|
|
5
|
+
import { Thread } from '../../entities/channels/thread';
|
|
6
|
+
import { Comment } from '../../entities/documents/comment';
|
|
7
|
+
import { Document } from '../../entities/documents/document';
|
|
8
|
+
import type { MacroClient } from '../../utils/client';
|
|
9
|
+
import type { MacroEvent } from '../types';
|
|
10
|
+
export type MessageEvent = Extract<MacroEvent, {
|
|
11
|
+
event_type: `message.${string}`;
|
|
12
|
+
}>;
|
|
13
|
+
/**
|
|
14
|
+
* The entity a message event belongs to. Channel messages hydrate a `Channel`,
|
|
15
|
+
* a `Message`, and the `Thread` for replies; document comments hydrate a
|
|
16
|
+
* `Document` and a `Comment`. Call chat hydrates a `CallRecord` and a
|
|
17
|
+
* `CallMessage`. The message handles share `reply`, `edit`, `delete`,
|
|
18
|
+
* `author`, and `content`/`text` reads.
|
|
19
|
+
*/
|
|
20
|
+
export type MessageEventTarget = {
|
|
21
|
+
type: 'call';
|
|
22
|
+
call: CallRecord;
|
|
23
|
+
message: CallMessage;
|
|
24
|
+
/** The call id is also its canonical chat thread id. */
|
|
25
|
+
threadId: string;
|
|
26
|
+
} | {
|
|
27
|
+
type: 'channel';
|
|
28
|
+
channel: Channel;
|
|
29
|
+
message: Message;
|
|
30
|
+
/** Set for replies: the thread the message belongs to. */
|
|
31
|
+
thread: Thread | undefined;
|
|
32
|
+
} | {
|
|
33
|
+
type: 'document';
|
|
34
|
+
document: Document;
|
|
35
|
+
comment: Comment;
|
|
36
|
+
/** The root of the comment's thread. */
|
|
37
|
+
threadId: string;
|
|
38
|
+
};
|
|
39
|
+
/** Attach SDK entity handles to a message webhook event. */
|
|
40
|
+
export declare function hydrateMessageEvent(client: MacroClient, event: MessageEvent): {
|
|
41
|
+
event_type: "message.posted";
|
|
42
|
+
metadata: import("../../../generated/storage").MessagePostedMetadata;
|
|
43
|
+
target: MessageEventTarget;
|
|
44
|
+
sender: import("../../entities/users/user").User | undefined;
|
|
45
|
+
} | {
|
|
46
|
+
event_type: "message.mentioned";
|
|
47
|
+
metadata: import("../../../generated/storage").MessageMentionedMetadata;
|
|
48
|
+
target: MessageEventTarget;
|
|
49
|
+
sender: import("../../entities/users/user").User | undefined;
|
|
50
|
+
} | {
|
|
51
|
+
event_type: "message.patched";
|
|
52
|
+
metadata: import("../../../generated/storage").MessagePatchedMetadata;
|
|
53
|
+
target: MessageEventTarget;
|
|
54
|
+
actor: import("../../entities/users/user").User | undefined;
|
|
55
|
+
} | {
|
|
56
|
+
event_type: "message.deleted";
|
|
57
|
+
metadata: import("../../../generated/storage").MessageDeletedMetadata;
|
|
58
|
+
target: MessageEventTarget;
|
|
59
|
+
actor: import("../../entities/users/user").User | undefined;
|
|
60
|
+
} | {
|
|
61
|
+
event_type: "message.attachment_created";
|
|
62
|
+
metadata: import("../../../generated/storage").MessageAttachmentCreatedMetadata;
|
|
63
|
+
target: MessageEventTarget;
|
|
64
|
+
actor: import("../../entities/users/user").User | undefined;
|
|
65
|
+
} | {
|
|
66
|
+
event_type: "message.attachment_removed";
|
|
67
|
+
metadata: import("../../../generated/storage").MessageAttachmentRemovedMetadata;
|
|
68
|
+
target: MessageEventTarget;
|
|
69
|
+
actor: import("../../entities/users/user").User | undefined;
|
|
70
|
+
};
|
|
@@ -1,17 +1,34 @@
|
|
|
1
|
+
import type { WebhookFilter, WebhookScope } from '../../generated/storage/types.gen';
|
|
1
2
|
import type { MacroClient } from '../utils/client';
|
|
2
3
|
import type { DeliveryHeaders, EventHandler, EventName } from './types';
|
|
4
|
+
/** Options for {@link MacroEvents.listen}. */
|
|
5
|
+
export interface ListenOptions {
|
|
6
|
+
/**
|
|
7
|
+
* Event/entity-id filters, identical to persisted webhook `filters`.
|
|
8
|
+
* Defaults to one filter covering every event currently registered with
|
|
9
|
+
* {@link MacroEvents.on}.
|
|
10
|
+
*/
|
|
11
|
+
filters?: WebhookFilter[];
|
|
12
|
+
/**
|
|
13
|
+
* Personal or team workspace whose webhook lifecycle events are delivered.
|
|
14
|
+
* Defaults to `'user'`.
|
|
15
|
+
*/
|
|
16
|
+
scope?: WebhookScope;
|
|
17
|
+
/** Abort the stream. */
|
|
18
|
+
signal?: AbortSignal;
|
|
19
|
+
}
|
|
3
20
|
/**
|
|
4
|
-
* Per-instance
|
|
5
|
-
*
|
|
6
|
-
*
|
|
21
|
+
* Per-instance event receiver. Subscribe with {@link MacroEvents.on}, then
|
|
22
|
+
* either {@link MacroEvents.listen} (SSE, the default) or mount
|
|
23
|
+
* {@link MacroEvents.webhook} at a persisted webhook URL.
|
|
7
24
|
*
|
|
8
25
|
* Obtain via `macro.events` — do not construct directly.
|
|
9
26
|
*/
|
|
10
27
|
export declare class MacroEvents {
|
|
11
28
|
private readonly client;
|
|
12
|
-
private readonly secret
|
|
29
|
+
private readonly secret?;
|
|
13
30
|
private readonly handlers;
|
|
14
|
-
constructor(client: MacroClient, secret
|
|
31
|
+
constructor(client: MacroClient, secret?: string | undefined);
|
|
15
32
|
/**
|
|
16
33
|
* Subscribe to an event across all entities.
|
|
17
34
|
*
|
|
@@ -19,33 +36,54 @@ export declare class MacroEvents {
|
|
|
19
36
|
*/
|
|
20
37
|
on<E extends EventName>(event: E, handler: EventHandler<E>): () => void;
|
|
21
38
|
/**
|
|
22
|
-
* Subscribe to @-mentions of the authenticated caller: `
|
|
39
|
+
* Subscribe to @-mentions of the authenticated caller: `message.mentioned`
|
|
23
40
|
* deliveries whose mentioned entity is this bot (bot auth) or this user
|
|
24
|
-
* (user auth).
|
|
41
|
+
* (user auth), in channels and in document comments alike.
|
|
42
|
+
*
|
|
43
|
+
* `message.mentioned` deliveries cover every mention the stream's (or
|
|
44
|
+
* webhook's) workspace can access (its `ids` filter holds channel or
|
|
45
|
+
* document ids); picking out "me" happens here, client-side. The caller's
|
|
46
|
+
* identity is resolved lazily (once) on the first delivery.
|
|
25
47
|
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* The webhook itself is registered separately and once, e.g.
|
|
31
|
-
* `macro.webhooks.create({ filters: [{ events: ['channel.mentioned'] }],
|
|
32
|
-
* … })`.
|
|
48
|
+
* For SSE, register this handler before {@link listen} so the derived
|
|
49
|
+
* filters include `message.mentioned`. For persisted webhooks, register the
|
|
50
|
+
* webhook separately, e.g. `macro.webhooks.create({ filters: [{ events:
|
|
51
|
+
* ['message.mentioned'] }], … })`.
|
|
33
52
|
*
|
|
34
53
|
* @returns An unsubscribe function.
|
|
35
54
|
*/
|
|
36
|
-
onSelfMention(handler: EventHandler<'
|
|
55
|
+
onSelfMention(handler: EventHandler<'message.mentioned'>): () => void;
|
|
37
56
|
/**
|
|
38
|
-
*
|
|
39
|
-
*
|
|
57
|
+
* Open a live Server-Sent Events stream of matching broker events. This is
|
|
58
|
+
* the default way to receive events — no public URL or signing secret
|
|
59
|
+
* required. Delivery is best-effort: events published before the
|
|
60
|
+
* connection, while disconnected, or dropped for a slow subscriber are
|
|
61
|
+
* missed; there is no replay.
|
|
40
62
|
*
|
|
41
|
-
*
|
|
63
|
+
* Filters default to the event names currently registered with {@link on}.
|
|
64
|
+
* The stream uses those filters for its lifetime; later `.on` / unsubscribe
|
|
65
|
+
* calls do not change what the server sends.
|
|
66
|
+
*
|
|
67
|
+
* @returns A function that closes the stream.
|
|
68
|
+
*/
|
|
69
|
+
listen(opts?: ListenOptions): Promise<() => void>;
|
|
70
|
+
/**
|
|
71
|
+
* Feed a raw webhook delivery in: verifies the signature, parses, and
|
|
72
|
+
* dispatches to matching handlers.
|
|
73
|
+
*
|
|
74
|
+
* @throws {MacroError} if no signing secret was configured, or if the
|
|
75
|
+
* signature is missing or invalid.
|
|
42
76
|
*/
|
|
43
77
|
handle(rawBody: string, headers: DeliveryHeaders): Promise<void>;
|
|
44
78
|
/**
|
|
45
|
-
* A Fetch-style handler to mount at your webhook route.
|
|
79
|
+
* A Fetch-style handler to mount at your persisted webhook route.
|
|
80
|
+
*
|
|
81
|
+
* Requires `webhookSecret` (or `MACRO_WEBHOOK_SECRET`).
|
|
46
82
|
*
|
|
47
83
|
* @example
|
|
48
84
|
* app.post('/webhook', macro.events.webhook()); // Hono
|
|
49
85
|
*/
|
|
50
86
|
webhook(): (req: Request) => Promise<Response>;
|
|
87
|
+
private filtersFromHandlers;
|
|
88
|
+
private dispatchEvent;
|
|
51
89
|
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import type { WebhookEvent } from '../../generated/storage/types.gen';
|
|
2
|
+
import type { hydrateAgentSessionEvent } from './hydrate/agentSession';
|
|
2
3
|
import type { hydrateChannelEvent } from './hydrate/channel';
|
|
3
4
|
import type { hydrateDocumentEvent } from './hydrate/document';
|
|
5
|
+
import type { hydrateMessageEvent } from './hydrate/message';
|
|
4
6
|
/** A webhook delivery body, exactly as Macro serializes it. */
|
|
5
7
|
export type MacroEvent = WebhookEvent;
|
|
6
8
|
/** Every entity event name Macro can deliver. */
|
|
@@ -16,7 +18,7 @@ export type EventPayload<E extends EventName> = Extract<MacroEvent, {
|
|
|
16
18
|
* ride along with which event — this reads their inferred return types back
|
|
17
19
|
* rather than restating the mapping.
|
|
18
20
|
*/
|
|
19
|
-
type HydratedEvent = ReturnType<typeof hydrateChannelEvent> | ReturnType<typeof hydrateDocumentEvent>;
|
|
21
|
+
type HydratedEvent = ReturnType<typeof hydrateAgentSessionEvent> | ReturnType<typeof hydrateChannelEvent> | ReturnType<typeof hydrateDocumentEvent> | ReturnType<typeof hydrateMessageEvent>;
|
|
20
22
|
/**
|
|
21
23
|
* What a handler receives, per event: the raw `metadata` plus the ORM handles
|
|
22
24
|
* named by that event's ids.
|