@dbx-tools/email 0.3.44 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.ts +26 -0
- package/lib/index.js +24 -0
- package/lib/src/brand.d.ts +47 -0
- package/lib/src/brand.js +44 -0
- package/lib/src/config.d.ts +143 -0
- package/lib/src/config.js +212 -0
- package/lib/src/defaults.d.ts +60 -0
- package/lib/src/defaults.js +64 -0
- package/lib/src/email-html.d.ts +51 -0
- package/lib/src/email-html.js +146 -0
- package/lib/src/markdown.d.ts +22 -0
- package/lib/src/markdown.js +81 -0
- package/lib/src/outbox.d.ts +22 -0
- package/lib/src/outbox.js +60 -0
- package/lib/src/plugin.d.ts +165 -0
- package/lib/src/plugin.js +294 -0
- package/lib/src/sender.d.ts +71 -0
- package/lib/src/sender.js +152 -0
- package/lib/src/tool.d.ts +68 -0
- package/lib/src/tool.js +82 -0
- package/lib/src/transport.d.ts +103 -0
- package/lib/src/transport.js +303 -0
- package/lib/tsconfig.tsbuildinfo +1 -0
- package/package.json +11 -7
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* AppKit plugin (registered name: `email`) that owns the SMTP runtime
|
|
3
|
+
* for outbound mail. Registering it validates the SMTP configuration
|
|
4
|
+
* and verifies connectivity at startup, so a bad host / credential
|
|
5
|
+
* surfaces in the boot logs instead of on the first approved send, and
|
|
6
|
+
* installs this plugin's `execute()` as the runtime's executor so every
|
|
7
|
+
* send picks up AppKit's retry / timeout / telemetry chain.
|
|
8
|
+
*
|
|
9
|
+
* The plugin is also a `ToolProvider`, so an AppKit agent can reach an
|
|
10
|
+
* `email.send` tool directly; the {@link emailTool} export is the same
|
|
11
|
+
* capability for a Mastra agent. Both share the transport primed here,
|
|
12
|
+
* and {@link sendEmail} is available to non-agent callers.
|
|
13
|
+
*
|
|
14
|
+
* Configuration is the manifest-published {@link EmailPluginConfig}
|
|
15
|
+
* (SMTP host/port/credentials, sender domain or explicit `from`, the
|
|
16
|
+
* sender policy, and an optional `allowedSenders` restriction), with
|
|
17
|
+
* unprefixed `SMTP_*` / `EMAIL_*` environment fallbacks.
|
|
18
|
+
*
|
|
19
|
+
* The plugin mounts one route under its base path (`/api/email`):
|
|
20
|
+
* `GET /senders` returns the permitted `From` options for the calling
|
|
21
|
+
* user, so a compose UI can offer them in a dropdown.
|
|
22
|
+
*
|
|
23
|
+
* @module
|
|
24
|
+
*/
|
|
25
|
+
import { Plugin, type IAppRouter } from "@databricks/appkit";
|
|
26
|
+
import { type AgentToolDefinition, type ToolProvider } from "@databricks/appkit/beta";
|
|
27
|
+
import { type EmailMessage, type EmailResult, type EmailSenders } from "@dbx-tools/shared-email";
|
|
28
|
+
import { type EmailPluginConfig } from "./config.js";
|
|
29
|
+
/**
|
|
30
|
+
* AppKit plugin that configures and verifies the SMTP transport used by
|
|
31
|
+
* the `send_email` tool, and exposes sending as an AppKit agent tool.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* import { createApp, server } from "@databricks/appkit";
|
|
36
|
+
* import { plugin as emailPlugin } from "@dbx-tools/email";
|
|
37
|
+
*
|
|
38
|
+
* await createApp({
|
|
39
|
+
* plugins: [
|
|
40
|
+
* server(),
|
|
41
|
+
* emailPlugin.email({
|
|
42
|
+
* smtp: { host: "smtp.example.com", user: "apikey", password: process.env.SMTP_KEY },
|
|
43
|
+
* domain: "mail.example.com",
|
|
44
|
+
* }),
|
|
45
|
+
* ],
|
|
46
|
+
* });
|
|
47
|
+
* ```
|
|
48
|
+
*/
|
|
49
|
+
export declare class EmailPlugin extends Plugin<EmailPluginConfig> implements ToolProvider {
|
|
50
|
+
static manifest: {
|
|
51
|
+
name: "email";
|
|
52
|
+
displayName: string;
|
|
53
|
+
description: string;
|
|
54
|
+
stability: "beta";
|
|
55
|
+
resources: {
|
|
56
|
+
required: never[];
|
|
57
|
+
optional: never[];
|
|
58
|
+
};
|
|
59
|
+
config: {
|
|
60
|
+
schema: import("json-schema").JSONSchema7;
|
|
61
|
+
};
|
|
62
|
+
};
|
|
63
|
+
/**
|
|
64
|
+
* The tool this plugin offers to an AppKit agent.
|
|
65
|
+
*
|
|
66
|
+
* Not `autoInheritable`: a send is irreversible and leaves the workspace,
|
|
67
|
+
* so it must only appear in an agent that asked for it and accepted the
|
|
68
|
+
* sender policy that comes with it.
|
|
69
|
+
*
|
|
70
|
+
* `execute` re-parses its arguments with the local schema: AppKit validates
|
|
71
|
+
* against the same schema first, but re-parsing is what gives the body typed
|
|
72
|
+
* arguments instead of `unknown`.
|
|
73
|
+
*/
|
|
74
|
+
private readonly tools;
|
|
75
|
+
/**
|
|
76
|
+
* Prime the shared runtime from this plugin's config (over env), route the
|
|
77
|
+
* tools' sends through this plugin's interceptor chain, and log the
|
|
78
|
+
* effective sender policy so an active restriction is obvious at boot. In
|
|
79
|
+
* SMTP mode, fail setup when the transport cannot be verified: a bad host
|
|
80
|
+
* or credential is a deploy-time mistake and should stop the app rather
|
|
81
|
+
* than wait for a user to approve a send that cannot work. With no SMTP
|
|
82
|
+
* credentials the runtime is in file/outbox mode (only when
|
|
83
|
+
* `EMAIL_OUTBOX_MODE` is set), logged loudly here so it is obvious mail
|
|
84
|
+
* is being written to disk rather than sent.
|
|
85
|
+
*/
|
|
86
|
+
setup(): Promise<void>;
|
|
87
|
+
/** Close the SMTP connection pool. Idempotent. */
|
|
88
|
+
shutdown(): Promise<void>;
|
|
89
|
+
/**
|
|
90
|
+
* Abort in-flight work. AppKit's graceful shutdown only invokes this hook -
|
|
91
|
+
* it never calls {@link shutdown} - so the SMTP pool is closed from here or
|
|
92
|
+
* it leaks at SIGTERM. The teardown is synchronous and idempotent, so the
|
|
93
|
+
* un-awaited call costs nothing.
|
|
94
|
+
*/
|
|
95
|
+
abortActiveOperations(): void;
|
|
96
|
+
/**
|
|
97
|
+
* Expose the sender-options lookup so UI compose views can populate a
|
|
98
|
+
* `From` dropdown from the configured allow-list. Mounted under the
|
|
99
|
+
* plugin base path, i.e. `GET /api/email/senders`. Runs in the OBO
|
|
100
|
+
* user scope so domain wildcards resolve against the caller's own
|
|
101
|
+
* local part.
|
|
102
|
+
*/
|
|
103
|
+
injectRoutes(router: IAppRouter): void;
|
|
104
|
+
exports(): {
|
|
105
|
+
/**
|
|
106
|
+
* Send a message immediately from `from` through the shared
|
|
107
|
+
* transport, bypassing the approval flow. For agent-driven sends
|
|
108
|
+
* use {@link emailTool} instead.
|
|
109
|
+
*/
|
|
110
|
+
sendEmail: (message: EmailMessage, from: string, signal?: AbortSignal) => Promise<EmailResult>;
|
|
111
|
+
/**
|
|
112
|
+
* Sender options for the current user (the `GET /senders` payload).
|
|
113
|
+
* AppKit wraps this with `asUser(req)` for OBO scoping.
|
|
114
|
+
*/
|
|
115
|
+
listSenders: () => Promise<EmailSenders>;
|
|
116
|
+
};
|
|
117
|
+
/** AppKit `ToolProvider`: the tool definitions offered to an agent. */
|
|
118
|
+
getAgentTools(): AgentToolDefinition[];
|
|
119
|
+
/**
|
|
120
|
+
* AppKit `ToolProvider`: run one tool call. Arguments are validated against
|
|
121
|
+
* the tool's schema first, and a validation failure comes back as an
|
|
122
|
+
* LLM-friendly string so the model can correct itself on the next turn.
|
|
123
|
+
*/
|
|
124
|
+
executeAgentTool(name: string, args: unknown, signal?: AbortSignal): Promise<unknown>;
|
|
125
|
+
/**
|
|
126
|
+
* Send one message, resolving the sender for the caller in scope when
|
|
127
|
+
* `from` is not pinned. The interceptor chain is applied inside
|
|
128
|
+
* {@link sendEmail} through the executor installed at setup, so this must
|
|
129
|
+
* not wrap it again.
|
|
130
|
+
*/
|
|
131
|
+
private send;
|
|
132
|
+
/** Run the sender-options lookup through the plugin's interceptor chain. */
|
|
133
|
+
private executeListSenders;
|
|
134
|
+
/**
|
|
135
|
+
* Compute the `From` options offered to the current user: the concrete
|
|
136
|
+
* addresses the effective allow-list permits (domain wildcards expanded
|
|
137
|
+
* against the OBO user's local part), the default among them, and
|
|
138
|
+
* whether the list is an enforced restriction. See
|
|
139
|
+
* {@link listSenderOptions}.
|
|
140
|
+
*/
|
|
141
|
+
private listSenders;
|
|
142
|
+
/** The `From` a send defaults to for the caller in scope. */
|
|
143
|
+
private resolveSender;
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* Register the email plugin.
|
|
147
|
+
*
|
|
148
|
+
* @example
|
|
149
|
+
* ```ts
|
|
150
|
+
* import { createApp, server } from "@databricks/appkit";
|
|
151
|
+
* import { brand, plugin as emailPlugin } from "@dbx-tools/email";
|
|
152
|
+
*
|
|
153
|
+
* await createApp({
|
|
154
|
+
* plugins: [
|
|
155
|
+
* server(),
|
|
156
|
+
* emailPlugin.email({
|
|
157
|
+
* domain: "mail.example.com",
|
|
158
|
+
* allowedSenders: ["*@mail.example.com"],
|
|
159
|
+
* brand: brand.defaultEmailBrand,
|
|
160
|
+
* }),
|
|
161
|
+
* ],
|
|
162
|
+
* });
|
|
163
|
+
* ```
|
|
164
|
+
*/
|
|
165
|
+
export declare const email: import("@databricks/appkit").ToPlugin<typeof EmailPlugin, EmailPluginConfig, "email">;
|
|
@@ -0,0 +1,294 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* AppKit plugin (registered name: `email`) that owns the SMTP runtime
|
|
3
|
+
* for outbound mail. Registering it validates the SMTP configuration
|
|
4
|
+
* and verifies connectivity at startup, so a bad host / credential
|
|
5
|
+
* surfaces in the boot logs instead of on the first approved send, and
|
|
6
|
+
* installs this plugin's `execute()` as the runtime's executor so every
|
|
7
|
+
* send picks up AppKit's retry / timeout / telemetry chain.
|
|
8
|
+
*
|
|
9
|
+
* The plugin is also a `ToolProvider`, so an AppKit agent can reach an
|
|
10
|
+
* `email.send` tool directly; the {@link emailTool} export is the same
|
|
11
|
+
* capability for a Mastra agent. Both share the transport primed here,
|
|
12
|
+
* and {@link sendEmail} is available to non-agent callers.
|
|
13
|
+
*
|
|
14
|
+
* Configuration is the manifest-published {@link EmailPluginConfig}
|
|
15
|
+
* (SMTP host/port/credentials, sender domain or explicit `from`, the
|
|
16
|
+
* sender policy, and an optional `allowedSenders` restriction), with
|
|
17
|
+
* unprefixed `SMTP_*` / `EMAIL_*` environment fallbacks.
|
|
18
|
+
*
|
|
19
|
+
* The plugin mounts one route under its base path (`/api/email`):
|
|
20
|
+
* `GET /senders` returns the permitted `From` options for the calling
|
|
21
|
+
* user, so a compose UI can offer them in a dropdown.
|
|
22
|
+
*
|
|
23
|
+
* @module
|
|
24
|
+
*/
|
|
25
|
+
import { AuthenticationError, ConfigurationError, ConnectionError, ExecutionError, getExecutionContext, Plugin, toPlugin, ValidationError, } from "@databricks/appkit";
|
|
26
|
+
import { defineTool, executeFromRegistry, toolsFromRegistry, } from "@databricks/appkit/beta";
|
|
27
|
+
import { log } from "@dbx-tools/shared-core";
|
|
28
|
+
import { email as emailWire, } from "@dbx-tools/shared-email";
|
|
29
|
+
import { EMAIL_CONFIG_SCHEMA } from "./config.js";
|
|
30
|
+
import { EMAIL_SENDERS_SETTINGS, EMAIL_VERIFY_SETTINGS } from "./defaults.js";
|
|
31
|
+
import { isSenderAllowed, listSenderOptions, resolveSenderAddress } from "./sender.js";
|
|
32
|
+
import { SEND_EMAIL_DESCRIPTION } from "./tool.js";
|
|
33
|
+
import { getEmailRuntime, resetEmailRuntime, sendEmail, setEmailExecutor, verifyEmailTransport, } from "./transport.js";
|
|
34
|
+
/** Mount-relative route (under `/api/email`) for the sender-options lookup. */
|
|
35
|
+
const SENDERS_ROUTE = "/senders";
|
|
36
|
+
/** Registry key of the agent tool, which agents address as `email.send`. */
|
|
37
|
+
const SEND_TOOL = "send";
|
|
38
|
+
const logger = log.logger("email");
|
|
39
|
+
/**
|
|
40
|
+
* AppKit plugin that configures and verifies the SMTP transport used by
|
|
41
|
+
* the `send_email` tool, and exposes sending as an AppKit agent tool.
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```ts
|
|
45
|
+
* import { createApp, server } from "@databricks/appkit";
|
|
46
|
+
* import { plugin as emailPlugin } from "@dbx-tools/email";
|
|
47
|
+
*
|
|
48
|
+
* await createApp({
|
|
49
|
+
* plugins: [
|
|
50
|
+
* server(),
|
|
51
|
+
* emailPlugin.email({
|
|
52
|
+
* smtp: { host: "smtp.example.com", user: "apikey", password: process.env.SMTP_KEY },
|
|
53
|
+
* domain: "mail.example.com",
|
|
54
|
+
* }),
|
|
55
|
+
* ],
|
|
56
|
+
* });
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
export class EmailPlugin extends Plugin {
|
|
60
|
+
static manifest = {
|
|
61
|
+
name: "email",
|
|
62
|
+
displayName: "Email",
|
|
63
|
+
description: "Sends approval-gated email over SMTP, with the sender derived from " +
|
|
64
|
+
"the on-behalf-of user's address on a configured domain.",
|
|
65
|
+
stability: "beta",
|
|
66
|
+
resources: {
|
|
67
|
+
required: [],
|
|
68
|
+
optional: [],
|
|
69
|
+
},
|
|
70
|
+
config: { schema: EMAIL_CONFIG_SCHEMA },
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* The tool this plugin offers to an AppKit agent.
|
|
74
|
+
*
|
|
75
|
+
* Not `autoInheritable`: a send is irreversible and leaves the workspace,
|
|
76
|
+
* so it must only appear in an agent that asked for it and accepted the
|
|
77
|
+
* sender policy that comes with it.
|
|
78
|
+
*
|
|
79
|
+
* `execute` re-parses its arguments with the local schema: AppKit validates
|
|
80
|
+
* against the same schema first, but re-parsing is what gives the body typed
|
|
81
|
+
* arguments instead of `unknown`.
|
|
82
|
+
*/
|
|
83
|
+
tools = {
|
|
84
|
+
[SEND_TOOL]: defineTool({
|
|
85
|
+
description: SEND_EMAIL_DESCRIPTION,
|
|
86
|
+
schema: emailWire.emailMessageSchema,
|
|
87
|
+
annotations: { effect: "write", requiresUserContext: true },
|
|
88
|
+
autoInheritable: false,
|
|
89
|
+
execute: async (args, signal) => this.send(emailWire.emailMessageSchema.parse(args), undefined, signal),
|
|
90
|
+
}),
|
|
91
|
+
};
|
|
92
|
+
/**
|
|
93
|
+
* Prime the shared runtime from this plugin's config (over env), route the
|
|
94
|
+
* tools' sends through this plugin's interceptor chain, and log the
|
|
95
|
+
* effective sender policy so an active restriction is obvious at boot. In
|
|
96
|
+
* SMTP mode, fail setup when the transport cannot be verified: a bad host
|
|
97
|
+
* or credential is a deploy-time mistake and should stop the app rather
|
|
98
|
+
* than wait for a user to approve a send that cannot work. With no SMTP
|
|
99
|
+
* credentials the runtime is in file/outbox mode (only when
|
|
100
|
+
* `EMAIL_OUTBOX_MODE` is set), logged loudly here so it is obvious mail
|
|
101
|
+
* is being written to disk rather than sent.
|
|
102
|
+
*/
|
|
103
|
+
async setup() {
|
|
104
|
+
const { transporter, config } = getEmailRuntime(this.config);
|
|
105
|
+
setEmailExecutor((fn, settings) => this.execute(fn, settings));
|
|
106
|
+
const policy = {
|
|
107
|
+
mode: config.mode,
|
|
108
|
+
senderPolicy: config.senderPolicy,
|
|
109
|
+
restricted: config.allowedSenders.length > 0,
|
|
110
|
+
...(config.allowedSenders.length > 0 ? { allowedSenders: config.allowedSenders } : {}),
|
|
111
|
+
};
|
|
112
|
+
if (config.mode === "file") {
|
|
113
|
+
logger.warn("outbox:enabled", {
|
|
114
|
+
dir: config.outDir,
|
|
115
|
+
reason: "no SMTP credentials configured; emails are written to disk instead of sent",
|
|
116
|
+
});
|
|
117
|
+
logger.info("ready", policy);
|
|
118
|
+
return;
|
|
119
|
+
}
|
|
120
|
+
const verified = await this.execute(async (signal) => verifyEmailTransport(transporter, signal), EMAIL_VERIFY_SETTINGS);
|
|
121
|
+
if (!verified.ok) {
|
|
122
|
+
logger.error("smtp:unverified", {
|
|
123
|
+
host: config.host,
|
|
124
|
+
port: config.port,
|
|
125
|
+
status: verified.status,
|
|
126
|
+
error: verified.message,
|
|
127
|
+
});
|
|
128
|
+
throw ConfigurationError.invalidConnection("SMTP", `Could not verify ${config.host}:${config.port}. Check SMTP_HOST, SMTP_PORT, SMTP_SECURE, and the credentials, or set EMAIL_OUTBOX_MODE=1 for local outbox testing.`);
|
|
129
|
+
}
|
|
130
|
+
logger.info("ready", {
|
|
131
|
+
...policy,
|
|
132
|
+
host: config.host,
|
|
133
|
+
port: config.port,
|
|
134
|
+
secure: config.secure,
|
|
135
|
+
});
|
|
136
|
+
}
|
|
137
|
+
/** Close the SMTP connection pool. Idempotent. */
|
|
138
|
+
async shutdown() {
|
|
139
|
+
resetEmailRuntime();
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Abort in-flight work. AppKit's graceful shutdown only invokes this hook -
|
|
143
|
+
* it never calls {@link shutdown} - so the SMTP pool is closed from here or
|
|
144
|
+
* it leaks at SIGTERM. The teardown is synchronous and idempotent, so the
|
|
145
|
+
* un-awaited call costs nothing.
|
|
146
|
+
*/
|
|
147
|
+
abortActiveOperations() {
|
|
148
|
+
super.abortActiveOperations();
|
|
149
|
+
void this.shutdown();
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* Expose the sender-options lookup so UI compose views can populate a
|
|
153
|
+
* `From` dropdown from the configured allow-list. Mounted under the
|
|
154
|
+
* plugin base path, i.e. `GET /api/email/senders`. Runs in the OBO
|
|
155
|
+
* user scope so domain wildcards resolve against the caller's own
|
|
156
|
+
* local part.
|
|
157
|
+
*/
|
|
158
|
+
injectRoutes(router) {
|
|
159
|
+
this.route(router, {
|
|
160
|
+
name: "listSenders",
|
|
161
|
+
method: "get",
|
|
162
|
+
path: SENDERS_ROUTE,
|
|
163
|
+
handler: async (req, res) => {
|
|
164
|
+
const result = await this.asUser(req).executeListSenders();
|
|
165
|
+
if (!result.ok) {
|
|
166
|
+
res.status(result.status).json({ error: result.message });
|
|
167
|
+
return;
|
|
168
|
+
}
|
|
169
|
+
res.json(result.data);
|
|
170
|
+
},
|
|
171
|
+
});
|
|
172
|
+
}
|
|
173
|
+
exports() {
|
|
174
|
+
return {
|
|
175
|
+
/**
|
|
176
|
+
* Send a message immediately from `from` through the shared
|
|
177
|
+
* transport, bypassing the approval flow. For agent-driven sends
|
|
178
|
+
* use {@link emailTool} instead.
|
|
179
|
+
*/
|
|
180
|
+
sendEmail: (message, from, signal) => this.send(message, from, signal),
|
|
181
|
+
/**
|
|
182
|
+
* Sender options for the current user (the `GET /senders` payload).
|
|
183
|
+
* AppKit wraps this with `asUser(req)` for OBO scoping.
|
|
184
|
+
*/
|
|
185
|
+
listSenders: async () => unwrap(await this.executeListSenders()),
|
|
186
|
+
};
|
|
187
|
+
}
|
|
188
|
+
/** AppKit `ToolProvider`: the tool definitions offered to an agent. */
|
|
189
|
+
getAgentTools() {
|
|
190
|
+
return toolsFromRegistry(this.tools);
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* AppKit `ToolProvider`: run one tool call. Arguments are validated against
|
|
194
|
+
* the tool's schema first, and a validation failure comes back as an
|
|
195
|
+
* LLM-friendly string so the model can correct itself on the next turn.
|
|
196
|
+
*/
|
|
197
|
+
async executeAgentTool(name, args, signal) {
|
|
198
|
+
return executeFromRegistry(this.tools, name, args, signal);
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* Send one message, resolving the sender for the caller in scope when
|
|
202
|
+
* `from` is not pinned. The interceptor chain is applied inside
|
|
203
|
+
* {@link sendEmail} through the executor installed at setup, so this must
|
|
204
|
+
* not wrap it again.
|
|
205
|
+
*/
|
|
206
|
+
async send(message, from, signal) {
|
|
207
|
+
return sendEmail(message, from ?? this.resolveSender(), signal);
|
|
208
|
+
}
|
|
209
|
+
/** Run the sender-options lookup through the plugin's interceptor chain. */
|
|
210
|
+
async executeListSenders() {
|
|
211
|
+
return this.execute(async () => this.listSenders(), EMAIL_SENDERS_SETTINGS);
|
|
212
|
+
}
|
|
213
|
+
/**
|
|
214
|
+
* Compute the `From` options offered to the current user: the concrete
|
|
215
|
+
* addresses the effective allow-list permits (domain wildcards expanded
|
|
216
|
+
* against the OBO user's local part), the default among them, and
|
|
217
|
+
* whether the list is an enforced restriction. See
|
|
218
|
+
* {@link listSenderOptions}.
|
|
219
|
+
*/
|
|
220
|
+
async listSenders() {
|
|
221
|
+
const { config } = getEmailRuntime();
|
|
222
|
+
const senders = listSenderOptions(config, currentUserEmail());
|
|
223
|
+
// Prefer the address a send would actually default to; fall back to
|
|
224
|
+
// the first offered option when that can't be resolved / permitted.
|
|
225
|
+
let defaultSender = senders[0];
|
|
226
|
+
try {
|
|
227
|
+
const resolved = this.resolveSender().toLowerCase();
|
|
228
|
+
if (isSenderAllowed(resolved, config.allowedSenders))
|
|
229
|
+
defaultSender = resolved;
|
|
230
|
+
}
|
|
231
|
+
catch {
|
|
232
|
+
// Keep the first offered option (or none) as the default.
|
|
233
|
+
}
|
|
234
|
+
return {
|
|
235
|
+
senders,
|
|
236
|
+
...(defaultSender ? { defaultSender } : {}),
|
|
237
|
+
restricted: config.allowedSenders.length > 0,
|
|
238
|
+
};
|
|
239
|
+
}
|
|
240
|
+
/** The `From` a send defaults to for the caller in scope. */
|
|
241
|
+
resolveSender() {
|
|
242
|
+
return resolveSenderAddress(getEmailRuntime().config, currentUserEmail());
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
/** The OBO user's address, or undefined outside a user context. */
|
|
246
|
+
function currentUserEmail() {
|
|
247
|
+
const ctx = getExecutionContext();
|
|
248
|
+
return "isUserContext" in ctx ? ctx.userEmail : undefined;
|
|
249
|
+
}
|
|
250
|
+
/**
|
|
251
|
+
* Re-raise a failed execution as the AppKit error class that already carries
|
|
252
|
+
* the status AppKit resolved, so a programmatic caller sees the same 400 /
|
|
253
|
+
* 401 / 503 an HTTP caller would.
|
|
254
|
+
*/
|
|
255
|
+
function toAppKitError(status, message) {
|
|
256
|
+
if (status === 400)
|
|
257
|
+
return new ValidationError(message);
|
|
258
|
+
if (status === 401)
|
|
259
|
+
return new AuthenticationError(message);
|
|
260
|
+
if (status === 503)
|
|
261
|
+
return new ConnectionError(message);
|
|
262
|
+
return new ExecutionError(message);
|
|
263
|
+
}
|
|
264
|
+
/**
|
|
265
|
+
* Surface a failed {@link ExecutionResult} to a programmatic caller as a
|
|
266
|
+
* throw. HTTP handlers map `status` onto the response instead.
|
|
267
|
+
*/
|
|
268
|
+
function unwrap(result) {
|
|
269
|
+
if (result.ok)
|
|
270
|
+
return result.data;
|
|
271
|
+
throw toAppKitError(result.status, result.message);
|
|
272
|
+
}
|
|
273
|
+
/**
|
|
274
|
+
* Register the email plugin.
|
|
275
|
+
*
|
|
276
|
+
* @example
|
|
277
|
+
* ```ts
|
|
278
|
+
* import { createApp, server } from "@databricks/appkit";
|
|
279
|
+
* import { brand, plugin as emailPlugin } from "@dbx-tools/email";
|
|
280
|
+
*
|
|
281
|
+
* await createApp({
|
|
282
|
+
* plugins: [
|
|
283
|
+
* server(),
|
|
284
|
+
* emailPlugin.email({
|
|
285
|
+
* domain: "mail.example.com",
|
|
286
|
+
* allowedSenders: ["*@mail.example.com"],
|
|
287
|
+
* brand: brand.defaultEmailBrand,
|
|
288
|
+
* }),
|
|
289
|
+
* ],
|
|
290
|
+
* });
|
|
291
|
+
* ```
|
|
292
|
+
*/
|
|
293
|
+
export const email = toPlugin(EmailPlugin);
|
|
294
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,MAAM,EACN,QAAQ,EACR,eAAe,GAKhB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,UAAU,EACV,mBAAmB,EACnB,iBAAiB,GAIlB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAC7C,OAAO,EACL,KAAK,IAAI,SAAS,GAInB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,mBAAmB,EAA0B,MAAM,UAAU,CAAC;AACvE,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AACpF,OAAO,EAAE,sBAAsB,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,aAAa,CAAC;AAErB,+EAA+E;AAC/E,MAAM,aAAa,GAAG,UAAU,CAAC;AAEjC,4EAA4E;AAC5E,MAAM,SAAS,GAAG,MAAM,CAAC;AAEzB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,WAAY,SAAQ,MAAyB;IACxD,MAAM,CAAC,QAAQ,GAAG;QAChB,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,OAAO;QACpB,WAAW,EACT,qEAAqE;YACrE,yDAAyD;QAC3D,SAAS,EAAE,MAAM;QACjB,SAAS,EAAE;YACT,QAAQ,EAAE,EAAE;YACZ,QAAQ,EAAE,EAAE;SACb;QACD,MAAM,EAAE,EAAE,MAAM,EAAE,mBAAmB,EAAE;KACN,CAAC;IAEpC;;;;;;;;;;OAUG;IACc,KAAK,GAAiB;QACrC,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC;YACtB,WAAW,EAAE,sBAAsB;YACnC,MAAM,EAAE,SAAS,CAAC,kBAAkB;YACpC,WAAW,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE;YAC3D,eAAe,EAAE,KAAK;YACtB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAC9B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC;SACzE,CAAC;KACH,CAAC;IAEF;;;;;;;;;;OAUG;IACM,KAAK,CAAC,KAAK;QAClB,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7D,gBAAgB,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,UAAU,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC;YAC5C,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACvF,CAAC;QACF,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBAC5B,GAAG,EAAE,MAAM,CAAC,MAAM;gBAClB,MAAM,EAAE,4EAA4E;aACrF,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC7B,OAAO;QACT,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,oBAAoB,CAAC,WAAW,EAAE,MAAM,CAAC,EAC3D,qBAAqB,CACtB,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,CAAC,KAAK,CAAC,iBAAiB,EAAE;gBAC9B,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,KAAK,EAAE,QAAQ,CAAC,OAAO;aACxB,CAAC,CAAC;YACH,MAAM,kBAAkB,CAAC,iBAAiB,CACxC,MAAM,EACN,oBAAoB,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,sHAAsH,CACrK,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE;YACnB,GAAG,MAAM;YACT,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC,CAAC;IACL,CAAC;IAED,kDAAkD;IAClD,KAAK,CAAC,QAAQ;QACZ,iBAAiB,EAAE,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACM,qBAAqB;QAC5B,KAAK,CAAC,qBAAqB,EAAE,CAAC;QAC9B,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACM,YAAY,CAAC,MAAkB;QACtC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,aAAa;YACnB,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;gBAC1B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,kBAAkB,EAAE,CAAC;gBAC3D,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;oBACf,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;oBAC1D,OAAO;gBACT,CAAC;gBACD,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACxB,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAEQ,OAAO;QACd,OAAO;YACL;;;;eAIG;YACH,SAAS,EAAE,CACT,OAAqB,EACrB,IAAY,EACZ,MAAoB,EACE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC;YAC3D;;;eAGG;YACH,WAAW,EAAE,KAAK,IAA2B,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;SACxF,CAAC;IACJ,CAAC;IAED,uEAAuE;IACvE,aAAa;QACX,OAAO,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAAY,EAAE,IAAa,EAAE,MAAoB;QACtE,OAAO,mBAAmB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,IAAI,CAChB,OAAqB,EACrB,IAAwB,EACxB,MAAoB;QAEpB,OAAO,SAAS,CAAC,OAAO,EAAE,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,4EAA4E;IACpE,KAAK,CAAC,kBAAkB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,sBAAsB,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,WAAW;QACvB,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,EAAE,CAAC;QACrC,MAAM,OAAO,GAAG,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAC9D,oEAAoE;QACpE,oEAAoE;QACpE,IAAI,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAC/B,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,WAAW,EAAE,CAAC;YACpD,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,cAAc,CAAC;gBAAE,aAAa,GAAG,QAAQ,CAAC;QACjF,CAAC;QAAC,MAAM,CAAC;YACP,0DAA0D;QAC5D,CAAC;QACD,OAAO;YACL,OAAO;YACP,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3C,UAAU,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC;SAC7C,CAAC;IACJ,CAAC;IAED,6DAA6D;IACrD,aAAa;QACnB,OAAO,oBAAoB,CAAC,eAAe,EAAE,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC5E,CAAC;;AAGH,mEAAmE;AACnE,SAAS,gBAAgB;IACvB,MAAM,GAAG,GAAG,mBAAmB,EAAE,CAAC;IAClC,OAAO,eAAe,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;AAC5D,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,MAAc,EAAE,OAAe;IACpD,IAAI,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;IACxD,IAAI,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC5D,IAAI,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;IACxD,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;AACrC,CAAC;AAED;;;GAGG;AACH,SAAS,MAAM,CAAI,MAA0B;IAC3C,IAAI,MAAM,CAAC,EAAE;QAAE,OAAO,MAAM,CAAC,IAAI,CAAC;IAClC,MAAM,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC","sourcesContent":["/**\n * AppKit plugin (registered name: `email`) that owns the SMTP runtime\n * for outbound mail. Registering it validates the SMTP configuration\n * and verifies connectivity at startup, so a bad host / credential\n * surfaces in the boot logs instead of on the first approved send, and\n * installs this plugin's `execute()` as the runtime's executor so every\n * send picks up AppKit's retry / timeout / telemetry chain.\n *\n * The plugin is also a `ToolProvider`, so an AppKit agent can reach an\n * `email.send` tool directly; the {@link emailTool} export is the same\n * capability for a Mastra agent. Both share the transport primed here,\n * and {@link sendEmail} is available to non-agent callers.\n *\n * Configuration is the manifest-published {@link EmailPluginConfig}\n * (SMTP host/port/credentials, sender domain or explicit `from`, the\n * sender policy, and an optional `allowedSenders` restriction), with\n * unprefixed `SMTP_*` / `EMAIL_*` environment fallbacks.\n *\n * The plugin mounts one route under its base path (`/api/email`):\n * `GET /senders` returns the permitted `From` options for the calling\n * user, so a compose UI can offer them in a dropdown.\n *\n * @module\n */\n\nimport {\n  AuthenticationError,\n  ConfigurationError,\n  ConnectionError,\n  ExecutionError,\n  getExecutionContext,\n  Plugin,\n  toPlugin,\n  ValidationError,\n  type AppKitError,\n  type ExecutionResult,\n  type IAppRouter,\n  type PluginManifest,\n} from \"@databricks/appkit\";\nimport {\n  defineTool,\n  executeFromRegistry,\n  toolsFromRegistry,\n  type AgentToolDefinition,\n  type ToolProvider,\n  type ToolRegistry,\n} from \"@databricks/appkit/beta\";\nimport { log } from \"@dbx-tools/shared-core\";\nimport {\n  email as emailWire,\n  type EmailMessage,\n  type EmailResult,\n  type EmailSenders,\n} from \"@dbx-tools/shared-email\";\nimport { EMAIL_CONFIG_SCHEMA, type EmailPluginConfig } from \"./config\";\nimport { EMAIL_SENDERS_SETTINGS, EMAIL_VERIFY_SETTINGS } from \"./defaults\";\nimport { isSenderAllowed, listSenderOptions, resolveSenderAddress } from \"./sender\";\nimport { SEND_EMAIL_DESCRIPTION } from \"./tool\";\nimport {\n  getEmailRuntime,\n  resetEmailRuntime,\n  sendEmail,\n  setEmailExecutor,\n  verifyEmailTransport,\n} from \"./transport\";\n\n/** Mount-relative route (under `/api/email`) for the sender-options lookup. */\nconst SENDERS_ROUTE = \"/senders\";\n\n/** Registry key of the agent tool, which agents address as `email.send`. */\nconst SEND_TOOL = \"send\";\n\nconst logger = log.logger(\"email\");\n\n/**\n * AppKit plugin that configures and verifies the SMTP transport used by\n * the `send_email` tool, and exposes sending as an AppKit agent tool.\n *\n * @example\n * ```ts\n * import { createApp, server } from \"@databricks/appkit\";\n * import { plugin as emailPlugin } from \"@dbx-tools/email\";\n *\n * await createApp({\n *   plugins: [\n *     server(),\n *     emailPlugin.email({\n *       smtp: { host: \"smtp.example.com\", user: \"apikey\", password: process.env.SMTP_KEY },\n *       domain: \"mail.example.com\",\n *     }),\n *   ],\n * });\n * ```\n */\nexport class EmailPlugin extends Plugin<EmailPluginConfig> implements ToolProvider {\n  static manifest = {\n    name: \"email\",\n    displayName: \"Email\",\n    description:\n      \"Sends approval-gated email over SMTP, with the sender derived from \" +\n      \"the on-behalf-of user's address on a configured domain.\",\n    stability: \"beta\",\n    resources: {\n      required: [],\n      optional: [],\n    },\n    config: { schema: EMAIL_CONFIG_SCHEMA },\n  } satisfies PluginManifest<\"email\">;\n\n  /**\n   * The tool this plugin offers to an AppKit agent.\n   *\n   * Not `autoInheritable`: a send is irreversible and leaves the workspace,\n   * so it must only appear in an agent that asked for it and accepted the\n   * sender policy that comes with it.\n   *\n   * `execute` re-parses its arguments with the local schema: AppKit validates\n   * against the same schema first, but re-parsing is what gives the body typed\n   * arguments instead of `unknown`.\n   */\n  private readonly tools: ToolRegistry = {\n    [SEND_TOOL]: defineTool({\n      description: SEND_EMAIL_DESCRIPTION,\n      schema: emailWire.emailMessageSchema,\n      annotations: { effect: \"write\", requiresUserContext: true },\n      autoInheritable: false,\n      execute: async (args, signal) =>\n        this.send(emailWire.emailMessageSchema.parse(args), undefined, signal),\n    }),\n  };\n\n  /**\n   * Prime the shared runtime from this plugin's config (over env), route the\n   * tools' sends through this plugin's interceptor chain, and log the\n   * effective sender policy so an active restriction is obvious at boot. In\n   * SMTP mode, fail setup when the transport cannot be verified: a bad host\n   * or credential is a deploy-time mistake and should stop the app rather\n   * than wait for a user to approve a send that cannot work. With no SMTP\n   * credentials the runtime is in file/outbox mode (only when\n   * `EMAIL_OUTBOX_MODE` is set), logged loudly here so it is obvious mail\n   * is being written to disk rather than sent.\n   */\n  override async setup(): Promise<void> {\n    const { transporter, config } = getEmailRuntime(this.config);\n    setEmailExecutor((fn, settings) => this.execute(fn, settings));\n    const policy = {\n      mode: config.mode,\n      senderPolicy: config.senderPolicy,\n      restricted: config.allowedSenders.length > 0,\n      ...(config.allowedSenders.length > 0 ? { allowedSenders: config.allowedSenders } : {}),\n    };\n    if (config.mode === \"file\") {\n      logger.warn(\"outbox:enabled\", {\n        dir: config.outDir,\n        reason: \"no SMTP credentials configured; emails are written to disk instead of sent\",\n      });\n      logger.info(\"ready\", policy);\n      return;\n    }\n    const verified = await this.execute(\n      async (signal) => verifyEmailTransport(transporter, signal),\n      EMAIL_VERIFY_SETTINGS,\n    );\n    if (!verified.ok) {\n      logger.error(\"smtp:unverified\", {\n        host: config.host,\n        port: config.port,\n        status: verified.status,\n        error: verified.message,\n      });\n      throw ConfigurationError.invalidConnection(\n        \"SMTP\",\n        `Could not verify ${config.host}:${config.port}. Check SMTP_HOST, SMTP_PORT, SMTP_SECURE, and the credentials, or set EMAIL_OUTBOX_MODE=1 for local outbox testing.`,\n      );\n    }\n    logger.info(\"ready\", {\n      ...policy,\n      host: config.host,\n      port: config.port,\n      secure: config.secure,\n    });\n  }\n\n  /** Close the SMTP connection pool. Idempotent. */\n  async shutdown(): Promise<void> {\n    resetEmailRuntime();\n  }\n\n  /**\n   * Abort in-flight work. AppKit's graceful shutdown only invokes this hook -\n   * it never calls {@link shutdown} - so the SMTP pool is closed from here or\n   * it leaks at SIGTERM. The teardown is synchronous and idempotent, so the\n   * un-awaited call costs nothing.\n   */\n  override abortActiveOperations(): void {\n    super.abortActiveOperations();\n    void this.shutdown();\n  }\n\n  /**\n   * Expose the sender-options lookup so UI compose views can populate a\n   * `From` dropdown from the configured allow-list. Mounted under the\n   * plugin base path, i.e. `GET /api/email/senders`. Runs in the OBO\n   * user scope so domain wildcards resolve against the caller's own\n   * local part.\n   */\n  override injectRoutes(router: IAppRouter): void {\n    this.route(router, {\n      name: \"listSenders\",\n      method: \"get\",\n      path: SENDERS_ROUTE,\n      handler: async (req, res) => {\n        const result = await this.asUser(req).executeListSenders();\n        if (!result.ok) {\n          res.status(result.status).json({ error: result.message });\n          return;\n        }\n        res.json(result.data);\n      },\n    });\n  }\n\n  override exports() {\n    return {\n      /**\n       * Send a message immediately from `from` through the shared\n       * transport, bypassing the approval flow. For agent-driven sends\n       * use {@link emailTool} instead.\n       */\n      sendEmail: (\n        message: EmailMessage,\n        from: string,\n        signal?: AbortSignal,\n      ): Promise<EmailResult> => this.send(message, from, signal),\n      /**\n       * Sender options for the current user (the `GET /senders` payload).\n       * AppKit wraps this with `asUser(req)` for OBO scoping.\n       */\n      listSenders: async (): Promise<EmailSenders> => unwrap(await this.executeListSenders()),\n    };\n  }\n\n  /** AppKit `ToolProvider`: the tool definitions offered to an agent. */\n  getAgentTools(): AgentToolDefinition[] {\n    return toolsFromRegistry(this.tools);\n  }\n\n  /**\n   * AppKit `ToolProvider`: run one tool call. Arguments are validated against\n   * the tool's schema first, and a validation failure comes back as an\n   * LLM-friendly string so the model can correct itself on the next turn.\n   */\n  async executeAgentTool(name: string, args: unknown, signal?: AbortSignal): Promise<unknown> {\n    return executeFromRegistry(this.tools, name, args, signal);\n  }\n\n  /**\n   * Send one message, resolving the sender for the caller in scope when\n   * `from` is not pinned. The interceptor chain is applied inside\n   * {@link sendEmail} through the executor installed at setup, so this must\n   * not wrap it again.\n   */\n  private async send(\n    message: EmailMessage,\n    from: string | undefined,\n    signal?: AbortSignal,\n  ): Promise<EmailResult> {\n    return sendEmail(message, from ?? this.resolveSender(), signal);\n  }\n\n  /** Run the sender-options lookup through the plugin's interceptor chain. */\n  private async executeListSenders(): Promise<ExecutionResult<EmailSenders>> {\n    return this.execute(async () => this.listSenders(), EMAIL_SENDERS_SETTINGS);\n  }\n\n  /**\n   * Compute the `From` options offered to the current user: the concrete\n   * addresses the effective allow-list permits (domain wildcards expanded\n   * against the OBO user's local part), the default among them, and\n   * whether the list is an enforced restriction. See\n   * {@link listSenderOptions}.\n   */\n  private async listSenders(): Promise<EmailSenders> {\n    const { config } = getEmailRuntime();\n    const senders = listSenderOptions(config, currentUserEmail());\n    // Prefer the address a send would actually default to; fall back to\n    // the first offered option when that can't be resolved / permitted.\n    let defaultSender = senders[0];\n    try {\n      const resolved = this.resolveSender().toLowerCase();\n      if (isSenderAllowed(resolved, config.allowedSenders)) defaultSender = resolved;\n    } catch {\n      // Keep the first offered option (or none) as the default.\n    }\n    return {\n      senders,\n      ...(defaultSender ? { defaultSender } : {}),\n      restricted: config.allowedSenders.length > 0,\n    };\n  }\n\n  /** The `From` a send defaults to for the caller in scope. */\n  private resolveSender(): string {\n    return resolveSenderAddress(getEmailRuntime().config, currentUserEmail());\n  }\n}\n\n/** The OBO user's address, or undefined outside a user context. */\nfunction currentUserEmail(): string | undefined {\n  const ctx = getExecutionContext();\n  return \"isUserContext\" in ctx ? ctx.userEmail : undefined;\n}\n\n/**\n * Re-raise a failed execution as the AppKit error class that already carries\n * the status AppKit resolved, so a programmatic caller sees the same 400 /\n * 401 / 503 an HTTP caller would.\n */\nfunction toAppKitError(status: number, message: string): AppKitError {\n  if (status === 400) return new ValidationError(message);\n  if (status === 401) return new AuthenticationError(message);\n  if (status === 503) return new ConnectionError(message);\n  return new ExecutionError(message);\n}\n\n/**\n * Surface a failed {@link ExecutionResult} to a programmatic caller as a\n * throw. HTTP handlers map `status` onto the response instead.\n */\nfunction unwrap<T>(result: ExecutionResult<T>): T {\n  if (result.ok) return result.data;\n  throw toAppKitError(result.status, result.message);\n}\n\n/**\n * Register the email plugin.\n *\n * @example\n * ```ts\n * import { createApp, server } from \"@databricks/appkit\";\n * import { brand, plugin as emailPlugin } from \"@dbx-tools/email\";\n *\n * await createApp({\n *   plugins: [\n *     server(),\n *     emailPlugin.email({\n *       domain: \"mail.example.com\",\n *       allowedSenders: [\"*@mail.example.com\"],\n *       brand: brand.defaultEmailBrand,\n *     }),\n *   ],\n * });\n * ```\n */\nexport const email = toPlugin(EmailPlugin);\n"]}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Sender-address policy: turn the on-behalf-of user's email into an
|
|
3
|
+
* outbound `From`, and (optionally) restrict which addresses may send.
|
|
4
|
+
*
|
|
5
|
+
* The default `From` re-homes the local part (everything before `@`) of
|
|
6
|
+
* the OBO email on the configured sending domain, so `alice@databricks.com`
|
|
7
|
+
* through a domain of `mail.example.com` goes out as
|
|
8
|
+
* `alice@mail.example.com`. An explicit `from` short-circuits that; the
|
|
9
|
+
* file/outbox fallback (no domain) keeps the user's address verbatim so
|
|
10
|
+
* test artifacts land under a recognizable folder.
|
|
11
|
+
*
|
|
12
|
+
* The resolved `From` is then constrained to the effective allow-list: a
|
|
13
|
+
* pattern is either an exact address (`user@domain.com`), a domain wildcard
|
|
14
|
+
* (`*@domain.com` or the bare `domain.com`, matching any local part on that
|
|
15
|
+
* domain), or `*` (any). This module only matches patterns; which patterns
|
|
16
|
+
* apply is decided by the configured sender policy in `./config`, which
|
|
17
|
+
* under the default `"allowlist"` mode fills an empty list in from the
|
|
18
|
+
* sender source. {@link listSenderOptions} expands the effective list into
|
|
19
|
+
* the concrete addresses a UI dropdown can offer for the current user.
|
|
20
|
+
*
|
|
21
|
+
* @module
|
|
22
|
+
*/
|
|
23
|
+
import type { ResolvedEmailConfig } from "./config.js";
|
|
24
|
+
/**
|
|
25
|
+
* Re-home the OBO user's local part on `domain`. Throws when no usable
|
|
26
|
+
* local part is available (e.g. a service-context call with no user).
|
|
27
|
+
*/
|
|
28
|
+
export declare function deriveSenderAddress(userEmail: string | undefined, domain: string): string;
|
|
29
|
+
/**
|
|
30
|
+
* Normalize a sender allow-list from config (a `string[]`) or an env var
|
|
31
|
+
* (a CSV / whitespace-separated string). Delegates to the shared
|
|
32
|
+
* {@link net.parseEmails} so allow-list patterns are read exactly
|
|
33
|
+
* like recipient lists elsewhere: entries are trimmed, lower-cased (so
|
|
34
|
+
* matching in {@link isSenderAllowed} is case-insensitive), and
|
|
35
|
+
* de-duplicated; empties are dropped. An empty result means "no
|
|
36
|
+
* restriction".
|
|
37
|
+
*/
|
|
38
|
+
export declare function parseAllowedSenders(raw: string | string[] | undefined): string[];
|
|
39
|
+
/**
|
|
40
|
+
* Whether `from` is permitted by the allow-list. An empty (or absent)
|
|
41
|
+
* allow-list permits everything: {@link resolveEmailConfig} is what turns
|
|
42
|
+
* the configured {@link SenderPolicy} into concrete patterns, so an empty
|
|
43
|
+
* list here means the policy had nothing to narrow to.
|
|
44
|
+
*/
|
|
45
|
+
export declare function isSenderAllowed(from: string, patterns: string[]): boolean;
|
|
46
|
+
/**
|
|
47
|
+
* Throw when `from` is not permitted by the allow-list. No-op when the
|
|
48
|
+
* allow-list is empty. The single enforcement point for the restriction
|
|
49
|
+
* (called from {@link sendEmail}), so every send path is covered whether
|
|
50
|
+
* the address was derived server-side or chosen in a UI.
|
|
51
|
+
*/
|
|
52
|
+
export declare function assertSenderAllowed(from: string, patterns: string[]): void;
|
|
53
|
+
/**
|
|
54
|
+
* Resolve the `From` address for a send from the resolved config and the
|
|
55
|
+
* current OBO user: explicit `from` wins, then `<local>@<domain>`, then
|
|
56
|
+
* (file/outbox mode only) the user's email verbatim. Throws when none of
|
|
57
|
+
* those yield an address.
|
|
58
|
+
*/
|
|
59
|
+
export declare function resolveSenderAddress(config: ResolvedEmailConfig, userEmail: string | undefined): string;
|
|
60
|
+
/**
|
|
61
|
+
* Expand the resolved config's allow-list into the concrete `From`
|
|
62
|
+
* addresses offered to the current user - the data a UI sender dropdown
|
|
63
|
+
* renders. Exact-address patterns pass through; domain wildcards
|
|
64
|
+
* (`*@domain.com` / bare `domain.com`) are concretized as
|
|
65
|
+
* `<user-local>@<domain>` and dropped when no OBO user local part is
|
|
66
|
+
* available. When no allow-list is configured, the single default sender
|
|
67
|
+
* ({@link resolveSenderAddress}) is returned when it can be resolved,
|
|
68
|
+
* else an empty list. The default resolved sender, when permitted, is
|
|
69
|
+
* ordered first.
|
|
70
|
+
*/
|
|
71
|
+
export declare function listSenderOptions(config: ResolvedEmailConfig, userEmail: string | undefined): string[];
|