@macro-inc/sdk 0.0.1
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 +177 -0
- package/dist/chunk-5HAKQN23.js +1263 -0
- package/dist/chunk-77EI4LSQ.js +2492 -0
- package/dist/chunk-CTKR64MY.js +1436 -0
- package/dist/chunk-JXIQT5TH.js +1467 -0
- package/dist/chunk-P4DTO6VD.js +830 -0
- package/dist/chunk-PAAFJYGO.js +967 -0
- package/dist/chunk-QNUS5BC5.js +913 -0
- package/dist/chunk-SGAHIERJ.js +1235 -0
- package/dist/chunk-V45LUJDI.js +838 -0
- package/dist/chunk-YRUXFEZM.js +1044 -0
- package/dist/generated/agent-harness/client/client.gen.d.ts +2 -0
- package/dist/generated/agent-harness/client/index.d.ts +10 -0
- package/dist/generated/agent-harness/client/types.gen.d.ts +120 -0
- package/dist/generated/agent-harness/client/utils.gen.d.ts +37 -0
- package/dist/generated/agent-harness/client.gen.d.ts +12 -0
- package/dist/generated/agent-harness/core/auth.gen.d.ts +25 -0
- package/dist/generated/agent-harness/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/agent-harness/core/params.gen.d.ts +43 -0
- package/dist/generated/agent-harness/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/agent-harness/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/agent-harness/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/agent-harness/core/types.gen.d.ts +83 -0
- package/dist/generated/agent-harness/core/utils.gen.d.ts +19 -0
- package/dist/generated/agent-harness/index.d.ts +2 -0
- package/dist/generated/agent-harness/index.js +6 -0
- package/dist/generated/agent-harness/sdk.gen.d.ts +84 -0
- package/dist/generated/agent-harness/types.gen.d.ts +539 -0
- package/dist/generated/auth/client/client.gen.d.ts +2 -0
- package/dist/generated/auth/client/index.d.ts +10 -0
- package/dist/generated/auth/client/types.gen.d.ts +120 -0
- package/dist/generated/auth/client/utils.gen.d.ts +37 -0
- package/dist/generated/auth/client.gen.d.ts +12 -0
- package/dist/generated/auth/core/auth.gen.d.ts +25 -0
- package/dist/generated/auth/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/auth/core/params.gen.d.ts +43 -0
- package/dist/generated/auth/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/auth/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/auth/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/auth/core/types.gen.d.ts +83 -0
- package/dist/generated/auth/core/utils.gen.d.ts +19 -0
- package/dist/generated/auth/index.d.ts +2 -0
- package/dist/generated/auth/index.js +6 -0
- package/dist/generated/auth/sdk.gen.d.ts +383 -0
- package/dist/generated/auth/types.gen.d.ts +2175 -0
- package/dist/generated/cognition/client/client.gen.d.ts +2 -0
- package/dist/generated/cognition/client/index.d.ts +10 -0
- package/dist/generated/cognition/client/types.gen.d.ts +120 -0
- package/dist/generated/cognition/client/utils.gen.d.ts +37 -0
- package/dist/generated/cognition/client.gen.d.ts +12 -0
- package/dist/generated/cognition/core/auth.gen.d.ts +25 -0
- package/dist/generated/cognition/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/cognition/core/params.gen.d.ts +43 -0
- package/dist/generated/cognition/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/cognition/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/cognition/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/cognition/core/types.gen.d.ts +83 -0
- package/dist/generated/cognition/core/utils.gen.d.ts +19 -0
- package/dist/generated/cognition/index.d.ts +2 -0
- package/dist/generated/cognition/index.js +6 -0
- package/dist/generated/cognition/sdk.gen.d.ts +224 -0
- package/dist/generated/cognition/types.gen.d.ts +2484 -0
- package/dist/generated/connection/client/client.gen.d.ts +2 -0
- package/dist/generated/connection/client/index.d.ts +10 -0
- package/dist/generated/connection/client/types.gen.d.ts +120 -0
- package/dist/generated/connection/client/utils.gen.d.ts +37 -0
- package/dist/generated/connection/client.gen.d.ts +12 -0
- package/dist/generated/connection/core/auth.gen.d.ts +25 -0
- package/dist/generated/connection/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/connection/core/params.gen.d.ts +43 -0
- package/dist/generated/connection/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/connection/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/connection/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/connection/core/types.gen.d.ts +83 -0
- package/dist/generated/connection/core/utils.gen.d.ts +19 -0
- package/dist/generated/connection/index.d.ts +2 -0
- package/dist/generated/connection/index.js +839 -0
- package/dist/generated/connection/sdk.gen.d.ts +38 -0
- package/dist/generated/connection/types.gen.d.ts +235 -0
- package/dist/generated/contacts/client/client.gen.d.ts +2 -0
- package/dist/generated/contacts/client/index.d.ts +10 -0
- package/dist/generated/contacts/client/types.gen.d.ts +120 -0
- package/dist/generated/contacts/client/utils.gen.d.ts +37 -0
- package/dist/generated/contacts/client.gen.d.ts +12 -0
- package/dist/generated/contacts/core/auth.gen.d.ts +25 -0
- package/dist/generated/contacts/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/contacts/core/params.gen.d.ts +43 -0
- package/dist/generated/contacts/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/contacts/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/contacts/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/contacts/core/types.gen.d.ts +83 -0
- package/dist/generated/contacts/core/utils.gen.d.ts +19 -0
- package/dist/generated/contacts/index.d.ts +2 -0
- package/dist/generated/contacts/index.js +6 -0
- package/dist/generated/contacts/sdk.gen.d.ts +43 -0
- package/dist/generated/contacts/types.gen.d.ts +52 -0
- package/dist/generated/email/client/client.gen.d.ts +2 -0
- package/dist/generated/email/client/index.d.ts +10 -0
- package/dist/generated/email/client/types.gen.d.ts +120 -0
- package/dist/generated/email/client/utils.gen.d.ts +37 -0
- package/dist/generated/email/client.gen.d.ts +12 -0
- package/dist/generated/email/core/auth.gen.d.ts +25 -0
- package/dist/generated/email/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/email/core/params.gen.d.ts +43 -0
- package/dist/generated/email/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/email/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/email/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/email/core/types.gen.d.ts +83 -0
- package/dist/generated/email/core/utils.gen.d.ts +19 -0
- package/dist/generated/email/index.d.ts +2 -0
- package/dist/generated/email/index.js +6 -0
- package/dist/generated/email/sdk.gen.d.ts +254 -0
- package/dist/generated/email/types.gen.d.ts +2614 -0
- package/dist/generated/notification/client/client.gen.d.ts +2 -0
- package/dist/generated/notification/client/index.d.ts +10 -0
- package/dist/generated/notification/client/types.gen.d.ts +120 -0
- package/dist/generated/notification/client/utils.gen.d.ts +37 -0
- package/dist/generated/notification/client.gen.d.ts +12 -0
- package/dist/generated/notification/core/auth.gen.d.ts +25 -0
- package/dist/generated/notification/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/notification/core/params.gen.d.ts +43 -0
- package/dist/generated/notification/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/notification/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/notification/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/notification/core/types.gen.d.ts +83 -0
- package/dist/generated/notification/core/utils.gen.d.ts +19 -0
- package/dist/generated/notification/index.d.ts +2 -0
- package/dist/generated/notification/index.js +6 -0
- package/dist/generated/notification/sdk.gen.d.ts +118 -0
- package/dist/generated/notification/types.gen.d.ts +1352 -0
- package/dist/generated/properties/client/client.gen.d.ts +2 -0
- package/dist/generated/properties/client/index.d.ts +10 -0
- package/dist/generated/properties/client/types.gen.d.ts +120 -0
- package/dist/generated/properties/client/utils.gen.d.ts +37 -0
- package/dist/generated/properties/client.gen.d.ts +12 -0
- package/dist/generated/properties/core/auth.gen.d.ts +25 -0
- package/dist/generated/properties/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/properties/core/params.gen.d.ts +43 -0
- package/dist/generated/properties/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/properties/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/properties/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/properties/core/types.gen.d.ts +83 -0
- package/dist/generated/properties/core/utils.gen.d.ts +19 -0
- package/dist/generated/properties/index.d.ts +2 -0
- package/dist/generated/properties/index.js +6 -0
- package/dist/generated/properties/sdk.gen.d.ts +158 -0
- package/dist/generated/properties/types.gen.d.ts +1288 -0
- package/dist/generated/scheduled-action/client/client.gen.d.ts +2 -0
- package/dist/generated/scheduled-action/client/index.d.ts +10 -0
- package/dist/generated/scheduled-action/client/types.gen.d.ts +120 -0
- package/dist/generated/scheduled-action/client/utils.gen.d.ts +37 -0
- package/dist/generated/scheduled-action/client.gen.d.ts +12 -0
- package/dist/generated/scheduled-action/core/auth.gen.d.ts +25 -0
- package/dist/generated/scheduled-action/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/scheduled-action/core/params.gen.d.ts +43 -0
- package/dist/generated/scheduled-action/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/scheduled-action/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/scheduled-action/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/scheduled-action/core/types.gen.d.ts +83 -0
- package/dist/generated/scheduled-action/core/utils.gen.d.ts +19 -0
- package/dist/generated/scheduled-action/index.d.ts +2 -0
- package/dist/generated/scheduled-action/index.js +845 -0
- package/dist/generated/scheduled-action/sdk.gen.d.ts +42 -0
- package/dist/generated/scheduled-action/types.gen.d.ts +241 -0
- package/dist/generated/search/client/client.gen.d.ts +2 -0
- package/dist/generated/search/client/index.d.ts +10 -0
- package/dist/generated/search/client/types.gen.d.ts +120 -0
- package/dist/generated/search/client/utils.gen.d.ts +37 -0
- package/dist/generated/search/client.gen.d.ts +12 -0
- package/dist/generated/search/core/auth.gen.d.ts +25 -0
- package/dist/generated/search/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/search/core/params.gen.d.ts +43 -0
- package/dist/generated/search/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/search/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/search/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/search/core/types.gen.d.ts +83 -0
- package/dist/generated/search/core/utils.gen.d.ts +19 -0
- package/dist/generated/search/index.d.ts +2 -0
- package/dist/generated/search/index.js +6 -0
- package/dist/generated/search/sdk.gen.d.ts +44 -0
- package/dist/generated/search/types.gen.d.ts +2194 -0
- package/dist/generated/static-files/client/client.gen.d.ts +2 -0
- package/dist/generated/static-files/client/index.d.ts +10 -0
- package/dist/generated/static-files/client/types.gen.d.ts +120 -0
- package/dist/generated/static-files/client/utils.gen.d.ts +37 -0
- package/dist/generated/static-files/client.gen.d.ts +12 -0
- package/dist/generated/static-files/core/auth.gen.d.ts +25 -0
- package/dist/generated/static-files/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/static-files/core/params.gen.d.ts +43 -0
- package/dist/generated/static-files/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/static-files/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/static-files/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/static-files/core/types.gen.d.ts +83 -0
- package/dist/generated/static-files/core/utils.gen.d.ts +19 -0
- package/dist/generated/static-files/index.d.ts +2 -0
- package/dist/generated/static-files/index.js +842 -0
- package/dist/generated/static-files/sdk.gen.d.ts +43 -0
- package/dist/generated/static-files/types.gen.d.ts +214 -0
- package/dist/generated/storage/client/client.gen.d.ts +2 -0
- package/dist/generated/storage/client/index.d.ts +10 -0
- package/dist/generated/storage/client/types.gen.d.ts +120 -0
- package/dist/generated/storage/client/utils.gen.d.ts +37 -0
- package/dist/generated/storage/client.gen.d.ts +12 -0
- package/dist/generated/storage/core/auth.gen.d.ts +25 -0
- package/dist/generated/storage/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/storage/core/params.gen.d.ts +43 -0
- package/dist/generated/storage/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/storage/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/storage/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/storage/core/types.gen.d.ts +83 -0
- package/dist/generated/storage/core/utils.gen.d.ts +19 -0
- package/dist/generated/storage/index.d.ts +2 -0
- package/dist/generated/storage/index.js +6 -0
- package/dist/generated/storage/sdk.gen.d.ts +858 -0
- package/dist/generated/storage/types.gen.d.ts +12105 -0
- package/dist/generated/unfurl/client/client.gen.d.ts +2 -0
- package/dist/generated/unfurl/client/index.d.ts +10 -0
- package/dist/generated/unfurl/client/types.gen.d.ts +120 -0
- package/dist/generated/unfurl/client/utils.gen.d.ts +37 -0
- package/dist/generated/unfurl/client.gen.d.ts +12 -0
- package/dist/generated/unfurl/core/auth.gen.d.ts +25 -0
- package/dist/generated/unfurl/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/unfurl/core/params.gen.d.ts +43 -0
- package/dist/generated/unfurl/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/unfurl/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/unfurl/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/unfurl/core/types.gen.d.ts +83 -0
- package/dist/generated/unfurl/core/utils.gen.d.ts +19 -0
- package/dist/generated/unfurl/index.d.ts +2 -0
- package/dist/generated/unfurl/index.js +835 -0
- package/dist/generated/unfurl/sdk.gen.d.ts +47 -0
- package/dist/generated/unfurl/types.gen.d.ts +125 -0
- package/dist/src/config.d.ts +51 -0
- package/dist/src/entities/agent-sessions/agent-session.d.ts +45 -0
- package/dist/src/entities/agent-sessions/namespace.d.ts +18 -0
- package/dist/src/entities/bots/namespace.d.ts +25 -0
- package/dist/src/entities/calls/call-record.d.ts +55 -0
- package/dist/src/entities/calls/namespace.d.ts +9 -0
- package/dist/src/entities/channels/channel.d.ts +88 -0
- package/dist/src/entities/channels/message.d.ts +64 -0
- package/dist/src/entities/channels/namespace.d.ts +30 -0
- package/dist/src/entities/channels/post.d.ts +20 -0
- package/dist/src/entities/channels/thread.d.ts +30 -0
- package/dist/src/entities/chats/chat.d.ts +55 -0
- package/dist/src/entities/chats/namespace.d.ts +14 -0
- package/dist/src/entities/crm/comment.d.ts +43 -0
- package/dist/src/entities/crm/company.d.ts +70 -0
- package/dist/src/entities/crm/contact.d.ts +48 -0
- package/dist/src/entities/crm/namespace.d.ts +22 -0
- package/dist/src/entities/documents/comment.d.ts +41 -0
- package/dist/src/entities/documents/document.d.ts +130 -0
- package/dist/src/entities/documents/namespace.d.ts +43 -0
- package/dist/src/entities/documents/system-skill.d.ts +16 -0
- package/dist/src/entities/email/attachment.d.ts +36 -0
- package/dist/src/entities/email/label.d.ts +31 -0
- package/dist/src/entities/email/link.d.ts +29 -0
- package/dist/src/entities/email/message.d.ts +58 -0
- package/dist/src/entities/email/namespace.d.ts +49 -0
- package/dist/src/entities/email/thread.d.ts +88 -0
- package/dist/src/entities/entity.d.ts +101 -0
- package/dist/src/entities/favorites/namespace.d.ts +19 -0
- package/dist/src/entities/foreign/foreign-entity.d.ts +30 -0
- package/dist/src/entities/foreign/namespace.d.ts +7 -0
- package/dist/src/entities/notifications/namespace.d.ts +29 -0
- package/dist/src/entities/notifications/notification.d.ts +50 -0
- package/dist/src/entities/pins/namespace.d.ts +19 -0
- package/dist/src/entities/projects/namespace.d.ts +13 -0
- package/dist/src/entities/projects/project.d.ts +42 -0
- package/dist/src/entities/properties/namespace.d.ts +47 -0
- package/dist/src/entities/properties/property-definition.d.ts +45 -0
- package/dist/src/entities/properties/property-option.d.ts +32 -0
- package/dist/src/entities/search.d.ts +23 -0
- package/dist/src/entities/tasks/namespace.d.ts +21 -0
- package/dist/src/entities/tasks/task.d.ts +34 -0
- package/dist/src/entities/teams/namespace.d.ts +12 -0
- package/dist/src/entities/teams/team.d.ts +40 -0
- package/dist/src/entities/users/namespace.d.ts +10 -0
- package/dist/src/entities/users/user.d.ts +43 -0
- package/dist/src/entities/webhooks/namespace.d.ts +31 -0
- package/dist/src/entities/webhooks/webhook.d.ts +88 -0
- package/dist/src/events/hydrate/channel.d.ts +85 -0
- package/dist/src/events/hydrate/document.d.ts +54 -0
- package/dist/src/events/receiver.d.ts +51 -0
- package/dist/src/events/types.d.ts +40 -0
- package/dist/src/events/verify.d.ts +13 -0
- package/dist/src/local-portmap.d.ts +8 -0
- package/dist/src/macro.d.ts +62 -0
- package/dist/src/macro.js +4215 -0
- package/dist/src/mentions.d.ts +37 -0
- package/dist/src/raw.d.ts +12 -0
- package/dist/src/utils/client.d.ts +53 -0
- package/dist/src/utils/index.d.ts +4 -0
- package/dist/src/utils/lazy.d.ts +18 -0
- package/dist/src/utils/pagination.d.ts +7 -0
- package/dist/src/utils/unwrap.d.ts +23 -0
- package/package.json +49 -0
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import type { MacroClient } from '../../utils/client';
|
|
2
|
+
import { Document } from '../documents/document';
|
|
3
|
+
import type { Project } from '../projects/project';
|
|
4
|
+
import type { Team } from '../teams/team';
|
|
5
|
+
/**
|
|
6
|
+
* A Macro task: a document with sub-type `task`. Inherits the full document
|
|
7
|
+
* surface ({@link Document.rename}, move, delete, restore, content, events)
|
|
8
|
+
* and adds task-specific state.
|
|
9
|
+
*/
|
|
10
|
+
export declare class Task extends Document {
|
|
11
|
+
/** A handle to a task by document id. Details load on first access. */
|
|
12
|
+
static byId(client: MacroClient, id: string): Task;
|
|
13
|
+
/**
|
|
14
|
+
* Create a task. `team` scopes the team task number and may be omitted
|
|
15
|
+
* when the creator belongs to exactly one team; `shareWithTeam` defaults
|
|
16
|
+
* to true.
|
|
17
|
+
*/
|
|
18
|
+
static create(client: MacroClient, opts: {
|
|
19
|
+
name: string;
|
|
20
|
+
markdown?: string;
|
|
21
|
+
project?: Project;
|
|
22
|
+
team?: Team;
|
|
23
|
+
shareWithTeam?: boolean;
|
|
24
|
+
}): Promise<Task>;
|
|
25
|
+
/**
|
|
26
|
+
* Whether the task is completed (its Status property is "Completed");
|
|
27
|
+
* `undefined` if the document is not a task.
|
|
28
|
+
*/
|
|
29
|
+
completed(): Promise<boolean | undefined>;
|
|
30
|
+
/** The task's URL in the Macro web app. */
|
|
31
|
+
webUrl(): string;
|
|
32
|
+
/** Search tasks by name and content, most relevant first, auto-paginated. */
|
|
33
|
+
static search: (client: MacroClient, query: string, searchOpts?: import("../search").SearchOpts) => AsyncGenerator<Task, any, any>;
|
|
34
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { MacroClient } from '../../utils/client';
|
|
2
|
+
import { Team } from './team';
|
|
3
|
+
export declare class TeamNamespace {
|
|
4
|
+
private readonly client;
|
|
5
|
+
constructor(client: MacroClient);
|
|
6
|
+
/** A handle to a team by id. */
|
|
7
|
+
byId(id: string): Team;
|
|
8
|
+
/** The caller's current team. */
|
|
9
|
+
current(): Promise<Team>;
|
|
10
|
+
/** The teams the caller belongs to. */
|
|
11
|
+
list(): Promise<Team[]>;
|
|
12
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import type { Team as TeamRecord, TeamRole } from '../../../generated/auth/types.gen';
|
|
2
|
+
import type { MacroClient } from '../../utils/client';
|
|
3
|
+
import { MacroEntity } from '../entity';
|
|
4
|
+
import { User } from '../users/user';
|
|
5
|
+
/** A member of a team: the user and their role. */
|
|
6
|
+
export interface TeamMembership {
|
|
7
|
+
/** The member. */
|
|
8
|
+
user: User;
|
|
9
|
+
/** Their role on the team. */
|
|
10
|
+
role: TeamRole;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* A Macro team. A free-to-construct handle; the record loads lazily on first
|
|
14
|
+
* field access, resolved from the caller's team memberships.
|
|
15
|
+
*/
|
|
16
|
+
export declare class Team extends MacroEntity<TeamRecord> {
|
|
17
|
+
protected fetch(): Promise<TeamRecord>;
|
|
18
|
+
/** A handle to a team by id. Details load on first access. */
|
|
19
|
+
static byId(client: MacroClient, id: string): Team;
|
|
20
|
+
/** The caller's current team. */
|
|
21
|
+
static current(client: MacroClient): Promise<Team>;
|
|
22
|
+
/** The teams the caller belongs to. */
|
|
23
|
+
static list(client: MacroClient): Promise<Team[]>;
|
|
24
|
+
/** The team's display name. */
|
|
25
|
+
readonly name: () => Promise<string>;
|
|
26
|
+
/** The team's slug (its URL identifier). */
|
|
27
|
+
readonly slug: () => Promise<string>;
|
|
28
|
+
/**
|
|
29
|
+
* The team's default link-share scope for newly shared items, or null when
|
|
30
|
+
* link sharing is off by default.
|
|
31
|
+
*/
|
|
32
|
+
readonly defaultLinkShare: () => Promise<NonNullable<import("../../../generated/auth").LinkShare | null | undefined> | undefined>;
|
|
33
|
+
/** The user who owns the team. */
|
|
34
|
+
readonly owner: () => Promise<User>;
|
|
35
|
+
/**
|
|
36
|
+
* The team's members, with their roles. The API only exposes members for
|
|
37
|
+
* the caller's current team, so this rejects for any other team.
|
|
38
|
+
*/
|
|
39
|
+
members(): Promise<TeamMembership[]>;
|
|
40
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { MacroClient } from '../../utils/client';
|
|
2
|
+
import { User } from './user';
|
|
3
|
+
export declare class UserNamespace {
|
|
4
|
+
private readonly client;
|
|
5
|
+
constructor(client: MacroClient);
|
|
6
|
+
/** A handle to a user by id. */
|
|
7
|
+
byId(id: string): User;
|
|
8
|
+
/** The current authenticated user. */
|
|
9
|
+
me(): Promise<User>;
|
|
10
|
+
}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import type { UserName } from '../../../generated/auth/types.gen';
|
|
2
|
+
import { type Mentionable, type MentionPart } from '../../mentions';
|
|
3
|
+
import type { MacroClient } from '../../utils/client';
|
|
4
|
+
import { Channel } from '../channels/channel';
|
|
5
|
+
import { PropertiedEntity } from '../entity';
|
|
6
|
+
/**
|
|
7
|
+
* A Macro user. Identity lives in the auth service, so details like the
|
|
8
|
+
* display name are fetched on demand. Can be dropped into a {@link msg}
|
|
9
|
+
* template to @-mention the user.
|
|
10
|
+
*/
|
|
11
|
+
export declare class User extends PropertiedEntity<UserName> implements Mentionable {
|
|
12
|
+
/** Favorites identify users as `user`. */
|
|
13
|
+
readonly entityType = "user";
|
|
14
|
+
/** The properties service identifies users as `USER`. */
|
|
15
|
+
protected readonly propertyEntityType = "USER";
|
|
16
|
+
protected fetch(): Promise<UserName>;
|
|
17
|
+
/** A handle to a user by id. */
|
|
18
|
+
static byId(client: MacroClient, id: string): User;
|
|
19
|
+
/** A handle to the current authenticated user. */
|
|
20
|
+
static me(client: MacroClient): Promise<User>;
|
|
21
|
+
/**
|
|
22
|
+
* This user's display name, fetched from the auth service (falling back to
|
|
23
|
+
* your email contacts when the Macro profile has none).
|
|
24
|
+
*
|
|
25
|
+
* @returns The full name, or `undefined` if the user has no name on record.
|
|
26
|
+
*/
|
|
27
|
+
name(): Promise<string | undefined>;
|
|
28
|
+
/**
|
|
29
|
+
* This user's email address. Macro user ids encode it as `macro|<email>`,
|
|
30
|
+
* so this reads straight off the id — no auth-service endpoint returns
|
|
31
|
+
* emails for arbitrary users.
|
|
32
|
+
*
|
|
33
|
+
* @returns The email, or `undefined` if the id is not email-derived.
|
|
34
|
+
*/
|
|
35
|
+
email(): string | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* Open (or create) your direct-message channel with this user.
|
|
38
|
+
*
|
|
39
|
+
* @returns The DM `Channel`.
|
|
40
|
+
*/
|
|
41
|
+
dm(): Promise<Channel>;
|
|
42
|
+
toMention(): MentionPart;
|
|
43
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { WebhookFilter, WebhookScope } from '../../../generated/storage/types.gen';
|
|
2
|
+
import type { MacroClient } from '../../utils/client';
|
|
3
|
+
import { Webhook } from './webhook';
|
|
4
|
+
/**
|
|
5
|
+
* Webhook registrations for receiving signed entity-event deliveries.
|
|
6
|
+
*/
|
|
7
|
+
export declare class WebhooksNamespace {
|
|
8
|
+
private readonly client;
|
|
9
|
+
constructor(client: MacroClient);
|
|
10
|
+
/**
|
|
11
|
+
* Register a webhook. `namespace` must be unique among the owning
|
|
12
|
+
* workspace's webhooks (the endpoint returns 409 on a clash) and cannot be
|
|
13
|
+
* changed later. `filters` must be non-empty (each entry matches event
|
|
14
|
+
* names, optionally narrowed to entity ids); `scope` defaults to `'user'`.
|
|
15
|
+
*/
|
|
16
|
+
create(opts: {
|
|
17
|
+
url: string;
|
|
18
|
+
namespace: string;
|
|
19
|
+
name: string;
|
|
20
|
+
filters: WebhookFilter[];
|
|
21
|
+
scope?: WebhookScope;
|
|
22
|
+
headers?: Record<string, string>;
|
|
23
|
+
}): Promise<Webhook>;
|
|
24
|
+
/** A handle to an existing webhook by id. Details load on first access. */
|
|
25
|
+
byId(id: string): Webhook;
|
|
26
|
+
/**
|
|
27
|
+
* The caller's webhooks across their personal and team workspaces, newest
|
|
28
|
+
* first. Each returned handle already holds its record.
|
|
29
|
+
*/
|
|
30
|
+
list(): Promise<Webhook[]>;
|
|
31
|
+
}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import type { PatchWebhookRequest, ValidateWebhookResponse, WebhookFilter, Webhook as WebhookRecord, WebhookScope } from '../../../generated/storage/types.gen';
|
|
2
|
+
import type { MacroClient } from '../../utils/client';
|
|
3
|
+
import { MacroEntity } from '../entity';
|
|
4
|
+
import { User } from '../users/user';
|
|
5
|
+
/**
|
|
6
|
+
* A webhook registration: an HTTPS endpoint Macro delivers signed entity
|
|
7
|
+
* events to.
|
|
8
|
+
*
|
|
9
|
+
* A free-to-construct `(client, id)` handle like any other entity: the detail
|
|
10
|
+
* record loads lazily from the webhook GET endpoint on first field access and
|
|
11
|
+
* is dropped after any mutation. {@link WebhooksNamespace.list} enumerates the
|
|
12
|
+
* caller's webhooks across their personal and team workspaces.
|
|
13
|
+
*
|
|
14
|
+
* The signing secret is only ever returned once, from {@link create}; it's
|
|
15
|
+
* exposed there as {@link Webhook.signingSecret}. Save it — patches, gets,
|
|
16
|
+
* and `byId` handles never carry it again — and pass it to
|
|
17
|
+
* `MacroOpts.webhookSecret` so `MacroEvents` can verify deliveries.
|
|
18
|
+
*/
|
|
19
|
+
export declare class Webhook extends MacroEntity<WebhookRecord> {
|
|
20
|
+
/**
|
|
21
|
+
* The signing secret used to verify deliveries, present only on the handle
|
|
22
|
+
* returned by {@link create}. `undefined` for `byId` and listed handles.
|
|
23
|
+
*/
|
|
24
|
+
readonly signingSecret?: string;
|
|
25
|
+
private constructor();
|
|
26
|
+
protected fetch(): Promise<WebhookRecord>;
|
|
27
|
+
/** Register a webhook. */
|
|
28
|
+
static create(client: MacroClient, opts: {
|
|
29
|
+
url: string;
|
|
30
|
+
namespace: string;
|
|
31
|
+
name: string;
|
|
32
|
+
filters: WebhookFilter[];
|
|
33
|
+
scope?: WebhookScope;
|
|
34
|
+
headers?: Record<string, string>;
|
|
35
|
+
}): Promise<Webhook>;
|
|
36
|
+
/** A handle to a webhook by id. Details load on first access. */
|
|
37
|
+
static byId(client: MacroClient, id: string): Webhook;
|
|
38
|
+
/** Wrap an already-loaded record. */
|
|
39
|
+
static fromRecord(client: MacroClient, record: WebhookRecord): Webhook;
|
|
40
|
+
/** The webhook's display name. */
|
|
41
|
+
readonly name: () => Promise<string>;
|
|
42
|
+
/**
|
|
43
|
+
* The caller-chosen namespace, unique among the owning workspace's webhooks.
|
|
44
|
+
* Fixed at creation time; it cannot be patched.
|
|
45
|
+
*/
|
|
46
|
+
readonly namespace: () => Promise<string>;
|
|
47
|
+
/** The HTTPS endpoint URL deliveries are sent to. */
|
|
48
|
+
readonly endpointUrl: () => Promise<string>;
|
|
49
|
+
/** The webhook's lifecycle status. */
|
|
50
|
+
readonly status: () => Promise<import("../../../generated/storage").WebhookStatus>;
|
|
51
|
+
/** Whether the current endpoint configuration has passed validation. */
|
|
52
|
+
readonly isValid: () => Promise<boolean>;
|
|
53
|
+
/** The event/entity-id filters that gate deliveries. */
|
|
54
|
+
readonly filters: () => Promise<import("../../../generated/storage").Vec>;
|
|
55
|
+
/** When the webhook was created. */
|
|
56
|
+
readonly createdAt: () => Promise<string>;
|
|
57
|
+
/** The owning workspace id: the creator's user id for a personal webhook, or a team id for a team webhook. */
|
|
58
|
+
readonly workspaceId: () => Promise<string>;
|
|
59
|
+
/** The user who registered this webhook. */
|
|
60
|
+
readonly createdBy: () => Promise<User>;
|
|
61
|
+
/**
|
|
62
|
+
* Whether this webhook is owned by the caller personally (`user`) or by
|
|
63
|
+
* their team (`team`). Derived from ownership: a personal webhook's owning
|
|
64
|
+
* workspace is the creator's own user id, whereas a team webhook's workspace
|
|
65
|
+
* is a distinct team id.
|
|
66
|
+
*/
|
|
67
|
+
scope(): Promise<WebhookScope>;
|
|
68
|
+
/** Update the webhook. */
|
|
69
|
+
update(body: PatchWebhookRequest): Promise<void>;
|
|
70
|
+
/** Rename the webhook. */
|
|
71
|
+
rename(name: string): Promise<void>;
|
|
72
|
+
/** Point the webhook at a new HTTPS endpoint URL. */
|
|
73
|
+
setUrl(url: string): Promise<void>;
|
|
74
|
+
/** Replace the webhook's delivery filters (must be non-empty). */
|
|
75
|
+
setFilters(filters: WebhookFilter[]): Promise<void>;
|
|
76
|
+
/** Pause deliveries. */
|
|
77
|
+
pause(): Promise<void>;
|
|
78
|
+
/** Resume deliveries. */
|
|
79
|
+
resume(): Promise<void>;
|
|
80
|
+
/** Delete the webhook. */
|
|
81
|
+
delete(): Promise<void>;
|
|
82
|
+
/**
|
|
83
|
+
* Send a signed validation test delivery to the endpoint and report whether
|
|
84
|
+
* it was accepted. Drops the cached detail so a subsequent {@link isValid}
|
|
85
|
+
* read reflects the new validation state.
|
|
86
|
+
*/
|
|
87
|
+
validate(): Promise<ValidateWebhookResponse>;
|
|
88
|
+
}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { Channel } from '../../entities/channels/channel';
|
|
2
|
+
import { Message } from '../../entities/channels/message';
|
|
3
|
+
import { Thread } from '../../entities/channels/thread';
|
|
4
|
+
import { User } from '../../entities/users/user';
|
|
5
|
+
import type { MacroClient } from '../../utils/client';
|
|
6
|
+
import type { MacroEvent } from '../types';
|
|
7
|
+
export type ChannelEvent = Extract<MacroEvent, {
|
|
8
|
+
event_type: `channel.${string}`;
|
|
9
|
+
}>;
|
|
10
|
+
/**
|
|
11
|
+
* Resolve a channel principal to a user handle, or undefined when it names a
|
|
12
|
+
* bot. Lower-cased to match how the backend stores ids. Note `|` is legal in an
|
|
13
|
+
* email, so `macro|bot|a@b.com` is a user.
|
|
14
|
+
*/
|
|
15
|
+
export declare function userFromPrincipal(client: MacroClient, principalId: string): User | undefined;
|
|
16
|
+
/** Attach SDK entity handles to a channel webhook event. */
|
|
17
|
+
export declare function hydrateChannelEvent(client: MacroClient, event: ChannelEvent): {
|
|
18
|
+
event_type: "channel.created";
|
|
19
|
+
metadata: import("../../../generated/storage").ChannelCreatedMetadata;
|
|
20
|
+
channel: Channel;
|
|
21
|
+
actor: User | undefined;
|
|
22
|
+
participants: User[];
|
|
23
|
+
} | {
|
|
24
|
+
event_type: "channel.updated";
|
|
25
|
+
metadata: import("../../../generated/storage").ChannelUpdatedMetadata;
|
|
26
|
+
channel: Channel;
|
|
27
|
+
actor: User | undefined;
|
|
28
|
+
} | {
|
|
29
|
+
event_type: "channel.deleted";
|
|
30
|
+
metadata: import("../../../generated/storage").ChannelDeletedMetadata;
|
|
31
|
+
channel: Channel;
|
|
32
|
+
actor: User | undefined;
|
|
33
|
+
} | {
|
|
34
|
+
event_type: "channel.message_posted";
|
|
35
|
+
metadata: import("../../../generated/storage").ChannelMessagePostedMetadata;
|
|
36
|
+
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
|
+
actor: User | undefined;
|
|
73
|
+
} | {
|
|
74
|
+
event_type: "channel.participant_added";
|
|
75
|
+
metadata: import("../../../generated/storage").ChannelParticipantAddedMetadata;
|
|
76
|
+
channel: Channel;
|
|
77
|
+
addedBy: User | undefined;
|
|
78
|
+
addedUsers: User[];
|
|
79
|
+
} | {
|
|
80
|
+
event_type: "channel.participant_removed";
|
|
81
|
+
metadata: import("../../../generated/storage").ChannelParticipantRemovedMetadata;
|
|
82
|
+
channel: Channel;
|
|
83
|
+
removedBy: User;
|
|
84
|
+
removedUsers: User[];
|
|
85
|
+
};
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { Document } from '../../entities/documents/document';
|
|
2
|
+
import { Project } from '../../entities/projects/project';
|
|
3
|
+
import { User } from '../../entities/users/user';
|
|
4
|
+
import type { MacroClient } from '../../utils/client';
|
|
5
|
+
import type { MacroEvent } from '../types';
|
|
6
|
+
export type DocumentEvent = Extract<MacroEvent, {
|
|
7
|
+
event_type: `document.${string}`;
|
|
8
|
+
}>;
|
|
9
|
+
/** Attach SDK entity handles to a document webhook event. */
|
|
10
|
+
export declare function hydrateDocumentEvent(client: MacroClient, event: DocumentEvent): {
|
|
11
|
+
event_type: "document.created";
|
|
12
|
+
metadata: import("../../../generated/storage").DocumentCreatedMetadata;
|
|
13
|
+
document: Document;
|
|
14
|
+
owner: User;
|
|
15
|
+
project: Project | undefined;
|
|
16
|
+
} | {
|
|
17
|
+
event_type: "document.updated";
|
|
18
|
+
metadata: import("../../../generated/storage").DocumentUpdatedMetadata;
|
|
19
|
+
document: Document;
|
|
20
|
+
owner: User;
|
|
21
|
+
actor: User | undefined;
|
|
22
|
+
project: Project | undefined;
|
|
23
|
+
previousProject: Project | undefined;
|
|
24
|
+
} | {
|
|
25
|
+
event_type: "document.deleted";
|
|
26
|
+
metadata: import("../../../generated/storage").DocumentDeletedMetadata;
|
|
27
|
+
document: Document;
|
|
28
|
+
actor: User | undefined;
|
|
29
|
+
project: Project | undefined;
|
|
30
|
+
} | {
|
|
31
|
+
event_type: "document.content_uploaded";
|
|
32
|
+
metadata: import("../../../generated/storage").DocumentContentUploadedMetadata;
|
|
33
|
+
document: Document;
|
|
34
|
+
owner: User;
|
|
35
|
+
} | {
|
|
36
|
+
event_type: "document.sync_content_updated";
|
|
37
|
+
metadata: import("../../../generated/storage").DocumentSyncContentUpdatedMetadata;
|
|
38
|
+
document: Document;
|
|
39
|
+
} | {
|
|
40
|
+
event_type: "document.purged";
|
|
41
|
+
metadata: import("../../../generated/storage").DocumentPurgedMetadata;
|
|
42
|
+
document: Document;
|
|
43
|
+
} | {
|
|
44
|
+
event_type: "document.copied";
|
|
45
|
+
metadata: import("../../../generated/storage").DocumentCopiedMetadata;
|
|
46
|
+
document: Document;
|
|
47
|
+
sourceDocument: Document;
|
|
48
|
+
owner: User;
|
|
49
|
+
project: Project | undefined;
|
|
50
|
+
} | {
|
|
51
|
+
event_type: "document.interaction";
|
|
52
|
+
metadata: import("../../../generated/storage").DocumentInteractionMetadata;
|
|
53
|
+
document: Document;
|
|
54
|
+
};
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import type { MacroClient } from '../utils/client';
|
|
2
|
+
import type { DeliveryHeaders, EventHandler, EventName } from './types';
|
|
3
|
+
/**
|
|
4
|
+
* Per-instance webhook receiver. Register ONE webhook with Macro (one URL, one
|
|
5
|
+
* signing secret) and mount this receiver at it; all `.on` handlers fan out
|
|
6
|
+
* from here.
|
|
7
|
+
*
|
|
8
|
+
* Obtain via `macro.events` — do not construct directly.
|
|
9
|
+
*/
|
|
10
|
+
export declare class MacroEvents {
|
|
11
|
+
private readonly client;
|
|
12
|
+
private readonly secret;
|
|
13
|
+
private readonly handlers;
|
|
14
|
+
constructor(client: MacroClient, secret: string);
|
|
15
|
+
/**
|
|
16
|
+
* Subscribe to an event across all entities.
|
|
17
|
+
*
|
|
18
|
+
* @returns An unsubscribe function.
|
|
19
|
+
*/
|
|
20
|
+
on<E extends EventName>(event: E, handler: EventHandler<E>): () => void;
|
|
21
|
+
/**
|
|
22
|
+
* Subscribe to @-mentions of the authenticated caller: `channel.mentioned`
|
|
23
|
+
* deliveries whose mentioned entity is this bot (bot auth) or this user
|
|
24
|
+
* (user auth).
|
|
25
|
+
*
|
|
26
|
+
* `channel.mentioned` deliveries cover every mention in channels the
|
|
27
|
+
* webhook's workspace can access (its `ids` filter, like all channel
|
|
28
|
+
* events, holds channel ids); picking out "me" happens here, client-side.
|
|
29
|
+
* The caller's identity is resolved lazily (once) on the first delivery.
|
|
30
|
+
* The webhook itself is registered separately and once, e.g.
|
|
31
|
+
* `macro.webhooks.create({ filters: [{ events: ['channel.mentioned'] }],
|
|
32
|
+
* … })`.
|
|
33
|
+
*
|
|
34
|
+
* @returns An unsubscribe function.
|
|
35
|
+
*/
|
|
36
|
+
onSelfMention(handler: EventHandler<'channel.mentioned'>): () => void;
|
|
37
|
+
/**
|
|
38
|
+
* Feed a raw delivery in: verifies the signature, parses, and dispatches to
|
|
39
|
+
* matching handlers.
|
|
40
|
+
*
|
|
41
|
+
* @throws {MacroError} if the signature is missing or invalid.
|
|
42
|
+
*/
|
|
43
|
+
handle(rawBody: string, headers: DeliveryHeaders): Promise<void>;
|
|
44
|
+
/**
|
|
45
|
+
* A Fetch-style handler to mount at your webhook route.
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* app.post('/webhook', macro.events.webhook()); // Hono
|
|
49
|
+
*/
|
|
50
|
+
webhook(): (req: Request) => Promise<Response>;
|
|
51
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import type { WebhookEvent } from '../../generated/storage/types.gen';
|
|
2
|
+
import type { hydrateChannelEvent } from './hydrate/channel';
|
|
3
|
+
import type { hydrateDocumentEvent } from './hydrate/document';
|
|
4
|
+
/** A webhook delivery body, exactly as Macro serializes it. */
|
|
5
|
+
export type MacroEvent = WebhookEvent;
|
|
6
|
+
/** Every entity event name Macro can deliver. */
|
|
7
|
+
export type EventName = MacroEvent['event_type'];
|
|
8
|
+
/** The raw `metadata` payload delivered with a given event. */
|
|
9
|
+
export type EventPayload<E extends EventName> = Extract<MacroEvent, {
|
|
10
|
+
event_type: E;
|
|
11
|
+
}>['metadata'];
|
|
12
|
+
/**
|
|
13
|
+
* Every hydrated event the receiver can dispatch, as one discriminated union.
|
|
14
|
+
*
|
|
15
|
+
* The `hydrate*` functions are the single source of truth for which handles
|
|
16
|
+
* ride along with which event — this reads their inferred return types back
|
|
17
|
+
* rather than restating the mapping.
|
|
18
|
+
*/
|
|
19
|
+
type HydratedEvent = ReturnType<typeof hydrateChannelEvent> | ReturnType<typeof hydrateDocumentEvent>;
|
|
20
|
+
/**
|
|
21
|
+
* What a handler receives, per event: the raw `metadata` plus the ORM handles
|
|
22
|
+
* named by that event's ids.
|
|
23
|
+
*
|
|
24
|
+
* Handles are free to construct and load lazily, so hydrating every event costs
|
|
25
|
+
* nothing until a handler reads a field or calls a method on one.
|
|
26
|
+
*/
|
|
27
|
+
export type EventMap = {
|
|
28
|
+
[E in EventName]: Extract<HydratedEvent, {
|
|
29
|
+
event_type: E;
|
|
30
|
+
}>;
|
|
31
|
+
};
|
|
32
|
+
export type EventHandler<E extends EventName> = (event: EventMap[E]) => void | Promise<void>;
|
|
33
|
+
/** The headers Macro sends on every webhook delivery. */
|
|
34
|
+
export interface DeliveryHeaders {
|
|
35
|
+
event?: string;
|
|
36
|
+
eventId?: string;
|
|
37
|
+
timestamp?: string;
|
|
38
|
+
signature?: string;
|
|
39
|
+
}
|
|
40
|
+
export {};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Verify a Macro webhook signature.
|
|
3
|
+
*
|
|
4
|
+
* Macro signs deliveries as `X-Macro-Signature: v1=<hex>` where the digest is
|
|
5
|
+
* HMAC-SHA256 over `"{timestamp}.{rawBody}"` keyed by the webhook's signing
|
|
6
|
+
* secret (see the `X-Macro-Timestamp` header).
|
|
7
|
+
*/
|
|
8
|
+
export declare function verifySignature(opts: {
|
|
9
|
+
secret: string;
|
|
10
|
+
timestamp: string;
|
|
11
|
+
rawBody: string;
|
|
12
|
+
signature: string;
|
|
13
|
+
}): Promise<boolean>;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { ServiceName } from './config';
|
|
2
|
+
export type LocalPortmap = {
|
|
3
|
+
webAppUrl: string;
|
|
4
|
+
hosts: Partial<Record<ServiceName, string>>;
|
|
5
|
+
sdkWebhookHostReceiverPort: number;
|
|
6
|
+
};
|
|
7
|
+
/** Load a generated local-stack port map, if one is available. */
|
|
8
|
+
export declare function resolveLocalPortmap(): LocalPortmap | undefined;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import type { MacroOpts } from './config';
|
|
2
|
+
import { AgentSessionNamespace } from './entities/agent-sessions/namespace';
|
|
3
|
+
import { BotsNamespace } from './entities/bots/namespace';
|
|
4
|
+
import { CallRecordNamespace } from './entities/calls/namespace';
|
|
5
|
+
import { ChannelNamespace } from './entities/channels/namespace';
|
|
6
|
+
import { ChatNamespace } from './entities/chats/namespace';
|
|
7
|
+
import { CrmNamespace } from './entities/crm/namespace';
|
|
8
|
+
import { DocumentNamespace } from './entities/documents/namespace';
|
|
9
|
+
import { EmailNamespace } from './entities/email/namespace';
|
|
10
|
+
import { FavoritesNamespace } from './entities/favorites/namespace';
|
|
11
|
+
import { ForeignEntityNamespace } from './entities/foreign/namespace';
|
|
12
|
+
import { NotificationNamespace } from './entities/notifications/namespace';
|
|
13
|
+
import { PinsNamespace } from './entities/pins/namespace';
|
|
14
|
+
import { ProjectNamespace } from './entities/projects/namespace';
|
|
15
|
+
import { PropertiesNamespace } from './entities/properties/namespace';
|
|
16
|
+
import { TaskNamespace } from './entities/tasks/namespace';
|
|
17
|
+
import { TeamNamespace } from './entities/teams/namespace';
|
|
18
|
+
import { UserNamespace } from './entities/users/namespace';
|
|
19
|
+
import type { User } from './entities/users/user';
|
|
20
|
+
import { WebhooksNamespace } from './entities/webhooks/namespace';
|
|
21
|
+
import type { MacroEvents } from './events/receiver';
|
|
22
|
+
import { MacroClient } from './utils/client';
|
|
23
|
+
export type { MacroOpts } from './config';
|
|
24
|
+
export { here, type Interpolation, type Mentionable, type MentionPart, msg, type RichMessage, type SimpleMention, toBody, wrapXml, } from './mentions';
|
|
25
|
+
export declare class Macro<T extends MacroOpts = MacroOpts> {
|
|
26
|
+
readonly agentSessions: AgentSessionNamespace;
|
|
27
|
+
readonly bots: BotsNamespace;
|
|
28
|
+
readonly calls: CallRecordNamespace;
|
|
29
|
+
readonly channels: ChannelNamespace;
|
|
30
|
+
readonly chats: ChatNamespace;
|
|
31
|
+
readonly crm: CrmNamespace;
|
|
32
|
+
readonly documents: DocumentNamespace;
|
|
33
|
+
readonly email: EmailNamespace;
|
|
34
|
+
readonly favorites: FavoritesNamespace;
|
|
35
|
+
readonly foreignEntities: ForeignEntityNamespace;
|
|
36
|
+
readonly notifications: NotificationNamespace;
|
|
37
|
+
readonly pins: PinsNamespace;
|
|
38
|
+
readonly projects: ProjectNamespace;
|
|
39
|
+
readonly properties: PropertiesNamespace;
|
|
40
|
+
readonly tasks: TaskNamespace;
|
|
41
|
+
readonly teams: TeamNamespace;
|
|
42
|
+
readonly users: UserNamespace;
|
|
43
|
+
readonly webhooks: WebhooksNamespace;
|
|
44
|
+
readonly events: T extends {
|
|
45
|
+
webhookSecret: string;
|
|
46
|
+
} ? MacroEvents : undefined;
|
|
47
|
+
/** Base URL of the Macro web app, used to build entity URLs. */
|
|
48
|
+
readonly webAppUrl: string;
|
|
49
|
+
/** Direct access to the underlying hey-api service clients. */
|
|
50
|
+
readonly _client: MacroClient;
|
|
51
|
+
private readonly opts;
|
|
52
|
+
constructor(opts: T);
|
|
53
|
+
/**
|
|
54
|
+
* The authenticated caller's mentionable principal — `bot|<uuid>` for bot
|
|
55
|
+
* auth, `macro|<email>` for user auth — fetched once and cached.
|
|
56
|
+
*/
|
|
57
|
+
myPrincipalId(): Promise<string>;
|
|
58
|
+
/** Clone of this SDK acting on behalf of `user` (sent as
|
|
59
|
+
* `x-macro-bot-for-macro-user-id`). Bot auth only — throws for user auth,
|
|
60
|
+
* since a user token always acts as its own user. */
|
|
61
|
+
requestedAs(user: User): Macro<T>;
|
|
62
|
+
}
|