@softr/sdk 0.0.92 → 0.0.93-alpha.1

package/dist/action.d.ts

@@ -234,6 +234,51 @@ type IntegrationDefinition<TId extends string> = {
  * const res = await listEvents({ query: { timeMin: now, singleEvents: "true" } })
  */
 declare function defineIntegration<const TId extends string>(definition: IntegrationDefinition<TId>): IntegrationAction<TId>;
+type EmailInputs = {
+  senderId?: string;
+  to?: ReadonlyArray<string>;
+  cc?: ReadonlyArray<string>;
+  bcc?: ReadonlyArray<string>;
+  replyTo?: string;
+};
+type EmailResource = {
+  type: "WORKFLOW_STEP";
+  stepType: "SOFTR_SEND_EMAIL";
+  inputs: EmailInputs;
+};
+type EmailAction<TId extends string = string> = Action<EmailResource> & {
+  id: TId;
+};
+type EmailDefinition<TId extends string> = EmailInputs & {
+  id: TId;
+  permissions: ActionPermissions;
+};
+/**
+ * Declares an email action: who may send it, and the fields every email it sends keeps whatever the
+ * call says. Softr sends it from the app's email sender and bills the workspace's workflow credits.
+ *
+ * - `to`, `cc`, `bcc`: addresses. An element may be a whole `{LOGGED_IN_USER:EMAIL}` or
+ *   `{LOGGED_IN_USER:<field>}` placeholder, filled in for the signed-in sender.
+ * - `replyTo`: an address or one such placeholder.
+ * - `senderId`: one of the workspace's email senders, for an email that must come from that address.
+ *   Left out, the app's sender is used. The call can never choose the sender.
+ *
+ * A field declared here wins over the call's, and declaring `to` also ignores the call's `cc` and
+ * `bcc`. Fix the recipients whenever the use case allows,
+ * because anyone in the audience can otherwise send any email to anyone.
+ *
+ * Pass the returned object to `email.send()` at runtime.
+ *
+ * @example
+ * const notifyOwner = defineEmailAction({
+ *   id: "notifyOwner",
+ *   to: ["owner@acme.com"],
+ *   permissions: { userGroupTypes: ["NON_LOGGED_IN_USERS", "LOGGED_IN_USERS"] },
+ * })
+ *
+ * await email.send(notifyOwner, { subject: "New submission", body: html, replyTo: data.email })
+ */
+declare function defineEmailAction<const TId extends string>(definition: EmailDefinition<TId>): EmailAction<TId>;
 type AiResource = {
   type: "SOFTR_AI";
   model: string;
@@ -268,4 +313,4 @@ type AiDefinition<TId extends string> = {
  */
 declare function defineAiAction<const TId extends string>(definition: AiDefinition<TId>): AiAction<TId>;
 //#endregion
-export { ActionData, ActionPermissions, ActionRecord, ActionShape, AiAction, DatasourceAction, FieldTypeOf, IntegrationAction, ReadOf, ReadShape, SoftrDatasources, WorkflowAction, defineAiAction, defineIntegration, defineMutation, defineQuery, defineWorkflow };
+export { ActionData, ActionPermissions, ActionRecord, ActionShape, AiAction, DatasourceAction, EmailAction, FieldTypeOf, IntegrationAction, ReadOf, ReadShape, SoftrDatasources, WorkflowAction, defineAiAction, defineEmailAction, defineIntegration, defineMutation, defineQuery, defineWorkflow };

package/dist/action.js

@@ -50,6 +50,43 @@ function defineIntegration(definition) {
 		permissions
 	};
 }
+/**
+* Declares an email action: who may send it, and the fields every email it sends keeps whatever the
+* call says. Softr sends it from the app's email sender and bills the workspace's workflow credits.
+*
+* - `to`, `cc`, `bcc`: addresses. An element may be a whole `{LOGGED_IN_USER:EMAIL}` or
+*   `{LOGGED_IN_USER:<field>}` placeholder, filled in for the signed-in sender.
+* - `replyTo`: an address or one such placeholder.
+* - `senderId`: one of the workspace's email senders, for an email that must come from that address.
+*   Left out, the app's sender is used. The call can never choose the sender.
+*
+* A field declared here wins over the call's, and declaring `to` also ignores the call's `cc` and
+* `bcc`. Fix the recipients whenever the use case allows,
+* because anyone in the audience can otherwise send any email to anyone.
+*
+* Pass the returned object to `email.send()` at runtime.
+*
+* @example
+* const notifyOwner = defineEmailAction({
+*   id: "notifyOwner",
+*   to: ["owner@acme.com"],
+*   permissions: { userGroupTypes: ["NON_LOGGED_IN_USERS", "LOGGED_IN_USERS"] },
+* })
+*
+* await email.send(notifyOwner, { subject: "New submission", body: html, replyTo: data.email })
+*/
+function defineEmailAction(definition) {
+	const { id, permissions,...inputs } = definition;
+	return {
+		id,
+		resource: {
+			type: "WORKFLOW_STEP",
+			stepType: "SOFTR_SEND_EMAIL",
+			inputs
+		},
+		permissions
+	};
+}
 function isDatasourceAction(value) {
 	if (typeof value !== "object" || value === null) return false;
 	const candidate = value;
@@ -69,4 +106,4 @@ function defineAiAction(definition) {
 }
 
 //#endregion
-export { defineAiAction, defineIntegration, defineMutation, defineQuery, defineWorkflow, isDatasourceAction };
+export { defineAiAction, defineEmailAction, defineIntegration, defineMutation, defineQuery, defineWorkflow, isDatasourceAction };

package/dist/core/email.d.ts

@@ -0,0 +1,57 @@
+import { EmailAction } from "../action.js";
+
+//#region src/core/email.d.ts
+/** A file the email carries, by the URL the app holds it under. */
+interface EmailAttachment {
+  name: string;
+  /** The URL of a file uploaded to this app with `upload`. */
+  url: string;
+}
+interface EmailSendInit {
+  /** Ignored when the action declares its own. */
+  to?: ReadonlyArray<string>;
+  /** Ignored when the action declares its own `cc` or `to`. */
+  cc?: ReadonlyArray<string>;
+  /** Ignored when the action declares its own `bcc` or `to`. */
+  bcc?: ReadonlyArray<string>;
+  /** Ignored when the action declares its own. */
+  replyTo?: string;
+  subject: string;
+  /** Plain text or HTML. */
+  body: string;
+  /** Files uploaded to this app with `upload`; any other URL is refused. */
+  attachments?: ReadonlyArray<EmailAttachment>;
+  /**
+   * The same key sends the email once, however often the call is repeated. Pass one derived from
+   * what the email is about, such as the id of the record it announces, when the call may be retried.
+   * At most 128 characters. Left out, every call gets a fresh one.
+   */
+  idempotencyKey?: string;
+}
+interface EmailSent {
+  /** Null when the mail provider did not report one; the email was still sent. */
+  messageId: string | null;
+}
+declare const EMAIL_ERROR_CODES: readonly ["NOT_FOUND", "INVALID_INPUT", "UNAVAILABLE", "TIMEOUT"];
+type EmailErrorCode = (typeof EMAIL_ERROR_CODES)[number];
+/**
+ * Thrown when Softr did not send the email. `code` says why:
+ *
+ * - `NOT_FOUND`: no such email action, or the caller is not in its audience.
+ * - `INVALID_INPUT`: a missing subject or body, an entry that is not exactly one address, more than 50 recipients, an attachment that is not one of the app's uploads, or an idempotency key over 128 characters.
+ * - `UNAVAILABLE`: Softr could not send it, for example with no workflow credits left, past the Softr fallback
+ *   address's daily limit or with an unconfirmed sender, or could not be reached.
+ * - `TIMEOUT`: no answer in time. It may still have been sent; retry with the same idempotency key.
+ */
+declare class EmailError extends Error {
+  readonly status: number;
+  readonly code: EmailErrorCode;
+  constructor(status: number, code: EmailErrorCode, message: string);
+}
+/** Sends one email through the action. Never retries by itself. */
+declare function sendEmail(action: EmailAction, init: EmailSendInit): Promise<EmailSent>;
+declare const email: {
+  send: typeof sendEmail;
+};
+//#endregion
+export { EmailAttachment, EmailError, EmailErrorCode, EmailSendInit, EmailSent, email };

package/dist/core/email.js

@@ -0,0 +1,77 @@
+import { assert } from "../assertions.js";
+import { softrApiUrl } from "../softr-api.js";
+import { fetch } from "../fetch.js";
+import { sessionConfig } from "../auth/config.js";
+import { readSessionToken } from "../auth/session.js";
+
+//#region src/core/email.ts
+/** Longer than Softr waits for the send itself, so its own timeout answers first. */
+const TIMEOUT_MS = 12e4;
+const EMAIL_ERROR_CODES = [
+	"NOT_FOUND",
+	"INVALID_INPUT",
+	"UNAVAILABLE",
+	"TIMEOUT"
+];
+/**
+* Thrown when Softr did not send the email. `code` says why:
+*
+* - `NOT_FOUND`: no such email action, or the caller is not in its audience.
+* - `INVALID_INPUT`: a missing subject or body, an entry that is not exactly one address, more than 50 recipients, an attachment that is not one of the app's uploads, or an idempotency key over 128 characters.
+* - `UNAVAILABLE`: Softr could not send it, for example with no workflow credits left, past the Softr fallback
+*   address's daily limit or with an unconfirmed sender, or could not be reached.
+* - `TIMEOUT`: no answer in time. It may still have been sent; retry with the same idempotency key.
+*/
+var EmailError = class extends Error {
+	status;
+	code;
+	constructor(status, code, message) {
+		super(message);
+		this.name = "EmailError";
+		this.status = status;
+		this.code = code;
+	}
+};
+/** Sends one email through the action. Never retries by itself. */
+async function sendEmail(action, init) {
+	const { to, cc, bcc, replyTo, subject, body, attachments } = init;
+	const sessionToken = readSessionToken();
+	let res;
+	try {
+		res = await fetch(`${softrApiUrl("SOFTR_PLATFORM_API_URL")}/v1/vibe/applications/${sessionConfig().applicationId}/actions/${action.id}/step`, {
+			method: "POST",
+			headers: {
+				...sessionToken ? { Authorization: `Bearer ${sessionToken}` } : {},
+				"Content-Type": "application/json",
+				"Idempotency-Key": init.idempotencyKey ?? crypto.randomUUID()
+			},
+			body: JSON.stringify({ input: {
+				to,
+				cc,
+				bcc,
+				replyTo,
+				subject,
+				body,
+				attachments
+			} }),
+			signal: AbortSignal.timeout(TIMEOUT_MS)
+		});
+	} catch (error) {
+		if (error instanceof DOMException && error.name === "TimeoutError") throw new EmailError(504, "TIMEOUT", `Email "${action.id}" got no answer in time. It may still have been sent.`);
+		throw new EmailError(502, "UNAVAILABLE", `Email "${action.id}" could not reach Softr: ${error instanceof Error ? error.message : String(error)}`);
+	}
+	if (res.ok) {
+		const sent = await res.json();
+		assert(typeof sent === "object" && sent !== null && "messageId" in sent && (typeof sent.messageId === "string" || sent.messageId === null), "the send answered without a messageId");
+		return { messageId: sent.messageId };
+	}
+	const failure = await res.json().catch(() => null);
+	const known = typeof failure === "object" && failure !== null ? failure : {};
+	const code = ("code" in known ? EMAIL_ERROR_CODES.find((errorCode) => errorCode === known.code) : void 0) ?? (res.status === 404 ? "NOT_FOUND" : res.status === 400 ? "INVALID_INPUT" : "UNAVAILABLE");
+	const message = "message" in known && typeof known.message === "string" && known.message !== "" ? known.message : `Email "${action.id}" failed with HTTP ${res.status}`;
+	throw new EmailError(res.status, code, message);
+}
+const email = { send: sendEmail };
+
+//#endregion
+export { EmailError, email };

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 import { SoftrUserGroupId, SoftrUserGroups, SoftrUserProperties, User } from "./auth/user.js";
-import { ActionPermissions, SoftrDatasources, defineAiAction, defineIntegration, defineMutation, defineQuery, defineWorkflow } from "./action.js";
+import { ActionPermissions, SoftrDatasources, defineAiAction, defineEmailAction, defineIntegration, defineMutation, defineQuery, defineWorkflow } from "./action.js";
 import { FileAttachment } from "./core/file-upload.js";
 import { FileItem, useFileUpload } from "./core/use-file-upload.js";
 import { AiAnswer, AiFile, AiGenerateInit, AiMessage, AiUsage } from "./core/ai.js";
+import { EmailAttachment, EmailSendInit, EmailSent } from "./core/email.js";
 import { DateOptions, DateParts, DateSeparator, DateValue, FixedDateFormat, FormattedDate, Formatting, FormattingScope, WeekDay, formatDate, formatDateTime, formatNumber, useFormatting } from "./formatting.js";
 import { SoftrContext } from "./auth/context.js";
 import { AuthSettings } from "./auth/platform.js";
@@ -18,4 +19,4 @@ import { useUserTimezone } from "./timezone.js";
 import { PwaInstall, PwaPlatform, SoftrPwaHead, usePwaInstall } from "./pwa.js";
 import { DefaultErrorOverlay } from "./default-error-overlay.js";
 import { Audience } from "./route/audience.js";
-export { type ActionPermissions, type AiAnswer, type AiFile, type AiGenerateInit, type AiMessage, type AiUsage, Audience, type AuthOptions, type AuthSettings, AuthSettingsProvider, type DateOptions, type DateParts, type DateSeparator, type DateValue, DefaultErrorOverlay, type FieldShape, type FileAttachment, type FileItem, type FixedDateFormat, FormattedDate, type Formatting, FormattingScope, type Page, type PageSettings, type PwaInstall, type PwaPlatform, type SoftrContext, type SoftrDatasources, type SoftrFieldRegistry, SoftrPwaHead, type SoftrUserGroupId, type SoftrUserGroups, type SoftrUserProperties, type User, type WeekDay, assertRouteAccess, checkAccess, defineAiAction, defineIntegration, defineMutation, definePage, defineQuery, defineVisibility, defineWorkflow, fieldShape, formatDate, formatDateTime, formatDuration, formatField, formatNumber, formatValue, getAuthSettings, getSoftrContext, guardRoute, initialSoftrContext, isAccessError, isAlreadyAuthenticatedError, isAuthorized, isForbiddenError, isUnauthenticatedError, pageHead, registerSoftrFields, softrAuthMiddleware, softrMcpMiddleware, toReturnPath, useAuthSettings, useCurrentUser, useFileUpload, useFormatting, useOverrides, usePwaInstall, useUserTimezone };
+export { type ActionPermissions, type AiAnswer, type AiFile, type AiGenerateInit, type AiMessage, type AiUsage, Audience, type AuthOptions, type AuthSettings, AuthSettingsProvider, type DateOptions, type DateParts, type DateSeparator, type DateValue, DefaultErrorOverlay, type EmailAttachment, type EmailSendInit, type EmailSent, type FieldShape, type FileAttachment, type FileItem, type FixedDateFormat, FormattedDate, type Formatting, FormattingScope, type Page, type PageSettings, type PwaInstall, type PwaPlatform, type SoftrContext, type SoftrDatasources, type SoftrFieldRegistry, SoftrPwaHead, type SoftrUserGroupId, type SoftrUserGroups, type SoftrUserProperties, type User, type WeekDay, assertRouteAccess, checkAccess, defineAiAction, defineEmailAction, defineIntegration, defineMutation, definePage, defineQuery, defineVisibility, defineWorkflow, fieldShape, formatDate, formatDateTime, formatDuration, formatField, formatNumber, formatValue, getAuthSettings, getSoftrContext, guardRoute, initialSoftrContext, isAccessError, isAlreadyAuthenticatedError, isAuthorized, isForbiddenError, isUnauthenticatedError, pageHead, registerSoftrFields, softrAuthMiddleware, softrMcpMiddleware, toReturnPath, useAuthSettings, useCurrentUser, useFileUpload, useFormatting, useOverrides, usePwaInstall, useUserTimezone };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { defineAiAction, defineIntegration, defineMutation, defineQuery, defineWorkflow } from "./action.js";
+import { defineAiAction, defineEmailAction, defineIntegration, defineMutation, defineQuery, defineWorkflow } from "./action.js";
 import { useFileUpload } from "./core/use-file-upload.js";
 import { checkAccess, defineVisibility, isAuthorized } from "./route/visibility.js";
 import { assertRouteAccess, guardRoute, isAccessError, isAlreadyAuthenticatedError, isForbiddenError, isUnauthenticatedError } from "./route/route.js";
@@ -14,4 +14,4 @@ import { useUserTimezone } from "./timezone.js";
 import { DefaultErrorOverlay } from "./default-error-overlay.js";
 import { Audience } from "./route/audience.js";
 
-export { Audience, AuthSettingsProvider, DefaultErrorOverlay, FormattedDate, FormattingScope, SoftrPwaHead, assertRouteAccess, checkAccess, defineAiAction, defineIntegration, defineMutation, definePage, defineQuery, defineVisibility, defineWorkflow, fieldShape, formatDate, formatDateTime, formatDuration, formatField, formatNumber, formatValue, getAuthSettings, getSoftrContext, guardRoute, initialSoftrContext, isAccessError, isAlreadyAuthenticatedError, isAuthorized, isForbiddenError, isUnauthenticatedError, pageHead, registerSoftrFields, softrAuthMiddleware, softrMcpMiddleware, toReturnPath, useAuthSettings, useCurrentUser, useFileUpload, useFormatting, useOverrides, usePwaInstall, useUserTimezone };
+export { Audience, AuthSettingsProvider, DefaultErrorOverlay, FormattedDate, FormattingScope, SoftrPwaHead, assertRouteAccess, checkAccess, defineAiAction, defineEmailAction, defineIntegration, defineMutation, definePage, defineQuery, defineVisibility, defineWorkflow, fieldShape, formatDate, formatDateTime, formatDuration, formatField, formatNumber, formatValue, getAuthSettings, getSoftrContext, guardRoute, initialSoftrContext, isAccessError, isAlreadyAuthenticatedError, isAuthorized, isForbiddenError, isUnauthenticatedError, pageHead, registerSoftrFields, softrAuthMiddleware, softrMcpMiddleware, toReturnPath, useAuthSettings, useCurrentUser, useFileUpload, useFormatting, useOverrides, usePwaInstall, useUserTimezone };

package/dist/package.js

@@ -1,5 +1,5 @@
 //#region package.json
-var version = "0.0.92";
+var version = "0.0.93-alpha.1";
 
 //#endregion
 export { version };

package/dist/server.d.ts

@@ -1,9 +1,10 @@
 import { upload } from "./core/file-upload.js";
 import { AiError, ai } from "./core/ai.js";
+import { EmailError, EmailErrorCode, email } from "./core/email.js";
 import { auth } from "./auth/server.js";
 import { FieldChoice, RecordOption, RecordOptions } from "./core/options.js";
 import { ds } from "./datasource/datasource.js";
 import { workflow } from "./core/workflow.js";
 import { integration } from "./core/integration.js";
 import "@tanstack/react-start/server-only";
-export { AiError, type FieldChoice, type RecordOption, type RecordOptions, ai, auth, ds, integration, upload, workflow };
+export { AiError, EmailError, type EmailErrorCode, type FieldChoice, type RecordOption, type RecordOptions, ai, auth, ds, email, integration, upload, workflow };

package/dist/server.js

@@ -4,6 +4,7 @@ import { auth } from "./auth/server.js";
 import { workflow } from "./core/workflow.js";
 import { integration } from "./core/integration.js";
 import { AiError, ai } from "./core/ai.js";
+import { EmailError, email } from "./core/email.js";
 import "@tanstack/react-start/server-only";
 
-export { AiError, ai, auth, ds, integration, upload, workflow };
+export { AiError, EmailError, ai, auth, ds, email, integration, upload, workflow };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softr/sdk",
-  "version": "0.0.92",
+  "version": "0.0.93-alpha.1",
   "type": "module",
   "exports": {
     ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js" },

package/skills/softr-sdk/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: core
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 # Softr SDK core
@@ -22,6 +22,8 @@ metadata:
 >
 > **CRITICAL**: The app is already wired. `src/start.ts`, `src/router.tsx` and `src/routes/__root.tsx` register `softrAuthMiddleware` and resolve the session. Do not add a second registration of it. `softrMcpMiddleware` is the one thing an app adds to `src/start.ts` itself — load the `softr-sdk/mcp` sub-skill before doing so.
 >
+> **CRITICAL**: `email.send` lives on `@softr/sdk/server` and only runs inside a `createServerFn` handler. Use `defineEmailAction` from `@softr/sdk` to declare who may send it and the recipients it fixes. An email the app sends itself needs no workflow and no connected mail service. Load the `softr-sdk/email` sub-skill for the full pattern.
+>
 > **CRITICAL**: `ai.generate` and `ai.stream` live on `@softr/sdk/server` and only run inside a `createServerFn` handler. Use `defineAiAction` from `@softr/sdk` to declare the action with the model it runs on, an id copied from the `ai_list_models` tool. Softr runs the model on its own keys; never ask the user for an API key for the app's own AI feature. Load the `softr-sdk/ai` sub-skill for the full pattern.
 >
 > **CRITICAL**: `workflow.trigger` lives on `@softr/sdk/server` and only runs inside a `createServerFn` handler. Use `defineWorkflow` from `@softr/sdk` to declare the action, then pass it to `workflow.trigger`. Load the `softr-sdk/workflows` sub-skill for the full pattern.
@@ -32,8 +34,8 @@ Each sub-skill stands alone for its task and repeats the boundary above, so most
 
 | Import | Runs | Holds |
 | --- | --- | --- |
-| `@softr/sdk` | Both | `defineQuery`, `defineMutation`, `defineAiAction`, `definePage`, `pageHead`, `defineVisibility`, `guardRoute`, `assertRouteAccess`, `isAuthorized`, `checkAccess`, `Audience`, `useCurrentUser`, `useUserTimezone`, `FormattedDate`, `FormattingScope`, `useFormatting`, `formatDate`, `formatDateTime`, `formatNumber`, `formatValue`, `formatField`, `fieldShape`, `registerSoftrFields`, `useOverrides`, `SoftrPwaHead`, `usePwaInstall`, `getSoftrContext`, `initialSoftrContext`, `softrAuthMiddleware`, the error predicates, and every type |
-| `@softr/sdk/server` | Server only | `ds`, `auth`, `workflow`, `integration`, `ai` |
+| `@softr/sdk` | Both | `defineQuery`, `defineMutation`, `defineEmailAction`, `defineAiAction`, `definePage`, `pageHead`, `defineVisibility`, `guardRoute`, `assertRouteAccess`, `isAuthorized`, `checkAccess`, `Audience`, `useCurrentUser`, `useUserTimezone`, `FormattedDate`, `FormattingScope`, `useFormatting`, `formatDate`, `formatDateTime`, `formatNumber`, `formatValue`, `formatField`, `fieldShape`, `registerSoftrFields`, `useOverrides`, `SoftrPwaHead`, `usePwaInstall`, `getSoftrContext`, `initialSoftrContext`, `softrAuthMiddleware`, the error predicates, and every type |
+| `@softr/sdk/server` | Server only | `ds`, `auth`, `email`, `EmailError`, `workflow`, `integration`, `ai` |
 | `@softr/sdk/client` | Browser only | `useFileUpload` |
 | `@softr/sdk/vite` | Build | `softr()`, already in `vite.config.ts` |
 
@@ -47,10 +49,11 @@ Each sub-skill stands alone for its task and repeats the boundary above, so most
 | Fetch records from a datasource | [record-queries/SKILL.md](./record-queries/SKILL.md) |
 | Chart, aggregate or count records | [charts-and-metrics/SKILL.md](./charts-and-metrics/SKILL.md) |
 | Create, update or delete a record | [record-mutations/SKILL.md](./record-mutations/SKILL.md) |
+| Send an email from the app: a form that emails the owner, a confirmation, staff emailing a client | [email/SKILL.md](./email/SKILL.md) |
 | Trigger a Softr workflow | [workflows/SKILL.md](./workflows/SKILL.md) |
 | Sign a visitor in, out, or up | [auth/SKILL.md](./auth/SKILL.md) |
 | Ask an AI model: a summary, an extraction from a document, a classification, a draft, a chat | [ai/SKILL.md](./ai/SKILL.md) |
-| Call a connected third-party API (Slack, Stripe, Gmail, …), or an AI model on the user's own provider account | [integrations/SKILL.md](./integrations/SKILL.md) |
+| Call a connected third-party API (Slack, Stripe, Gmail from the user's own mailbox, …), or an AI model on the user's own provider account | [integrations/SKILL.md](./integrations/SKILL.md) |
 | Open the app to AI assistants over MCP | [mcp/SKILL.md](./mcp/SKILL.md) |
 | Let visitors install the app on their home screen | [pwa/SKILL.md](./pwa/SKILL.md) |
 | Show a date, a time or a number | [formatting/SKILL.md](./formatting/SKILL.md) |
@@ -76,6 +79,9 @@ Drawing a chart, a stat tile, or any aggregated number?
 Submitting a form, editing a record, or deleting one?
   load softr-sdk/record-mutations
 
+Sending an email when a form is submitted or a button is pressed?
+  load softr-sdk/email — no workflow, no connected mail service
+
 Triggering a Softr workflow from a button or form?
   load softr-sdk/workflows
 

package/skills/softr-sdk/ai/SKILL.md

@@ -1,19 +1,19 @@
 ---
 name: ai
 description: >-
-  Run an AI model from the app on Softr's own keys, billed to the workspace's
-  AI credits, with nothing to connect: defineAiAction from @softr/sdk declares
-  the action with the catalog model it runs on and its permissions;
-  ai.generate from @softr/sdk/server runs it with a system text, a prompt, an
-  optional JSON schema for an answer that is data, and optional files;
-  ai.stream runs it for an answer the user watches being written. Load this
-  for a summary, an extraction, a classification, a draft, or a chat the app
-  asks a model for, before you decide whether a feature runs on Softr AI
-  or on the user's own account, and before you change the model it runs on.
+  Run an AI model from the app on Softr's own keys, billed to the workspace's AI
+  credits, with nothing to connect: defineAiAction from @softr/sdk declares the
+  action with the catalog model it runs on and its permissions; ai.generate from
+  @softr/sdk/server runs it with a system text, a prompt, an optional JSON
+  schema for an answer that is data, and optional files; ai.stream runs it for
+  an answer the user watches being written. Load this for a summary, an
+  extraction, a classification, a draft, or a chat the app asks a model for,
+  before you decide whether a feature runs on Softr AI or on the user's own
+  account, and before you change the model it runs on.
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 **Boundary.** `ai` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build. `defineAiAction` and every type come from `@softr/sdk` and can be imported anywhere.

package/skills/softr-sdk/auth/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 **Boundary.** `auth` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build.

package/skills/softr-sdk/charts-and-metrics/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 **Boundary.** `ds` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler or a server-side route hook — importing it into a component fails the build. `defineQuery` and every type come from `@softr/sdk` and can be imported anywhere.

package/skills/softr-sdk/current-user/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 # The current user

package/skills/softr-sdk/email/SKILL.md

@@ -0,0 +1,123 @@
+---
+name: email
+description: >-
+  Send an email from the app itself, with nothing to connect and no workflow:
+  defineEmailAction from @softr/sdk declares who may send it and the fields it
+  fixes (to, cc, bcc, replyTo, and an optional senderId); email.send from
+  @softr/sdk/server sends one with a subject, a text or HTML body and optional
+  attachments, and throws an EmailError with a code when Softr does not send it.
+  Load this for a contact form that emails the owner, a confirmation to the
+  signed-in user, staff emailing a client, or any email the app sends while
+  handling what a person does in it.
+metadata:
+  type: sub-skill
+  library: softr-sdk
+  library_version: 0.0.93-alpha.1
+---
+
+**Boundary.** `email` and `EmailError` live on `@softr/sdk/server` and run only inside a `createServerFn` handler — importing them into a component fails the build. `defineEmailAction` and every type come from `@softr/sdk` and can be imported anywhere.
+
+# Email
+
+An app sends an email through an email action. Softr sends it from the app's email sender and bills the workspace's **workflow credits**, so there is no mail service to connect and no workflow to build. Use it for every email the app sends while it handles something a person does in it: a form submitted, a button pressed, a record saved through the app.
+
+A workflow is still the answer for an email on a schedule ("every Monday") or on a change made outside the app (a record edited in the table): load `automate-with-workflows` for those. A connected Gmail or Outlook is the answer only when the user wants the email to come from their own mailbox, through the `integrations` sub-skill.
+
+`defineEmailAction` missing from `@softr/sdk`? The app was built on an older version. Upgrade `@softr/sdk` to the latest version first, then write the action.
+
+## Who can send it, and to whom
+
+The action's `permissions` is its audience: everyone in it can send an email through it, directly, without the app's own code. The app's code is not a guard. Only what the declaration fixes holds whatever the caller sends.
+
+- **Fix the recipients whenever the use case allows.** A contact form that emails the owner fixes `to` to the owner. "Email me this report" fixes `to` to `{LOGGED_IN_USER:EMAIL}`. Then nobody can send the app's email to anyone else.
+- **When people pick the recipients, narrow the audience.** "Staff email a client" leaves `to` open and keeps the action to the staff group with `customGroups`. An action with open recipients for all signed-in users lets anyone who signs up send any email to anyone from the app's address, up to the workspace's credits. Build that only when the user asks for it, and tell them so in one line. An action open to visitors must fix `to`, `cc` or `bcc`: one that fixes none is not stored.
+
+## The sender
+
+Every email comes from the app's email sender, unless the action names one of the workspace's senders with `senderId`.
+
+- Read the app's sender with `application_get` before you promise an address. That tool shows the sign-in emails' default, an `@softr.app` address, when no sender is set. Emails from an email action then come from Softr's address instead: the workspace's name at `<workspaceId>@softr-email.com`, limited to 30 emails a day for the whole workspace, its workflows included. That address is for testing only. Say so in your closing message when no sender is set, and that the app needs its own sender before real users rely on its emails.
+- Changing the app's sender also changes the address its sign-in emails come from. Ask the user before you call `application_configure_email_sender`, and name both effects.
+- Set `senderId` only when the user wants this email from a specific address, such as `billing@`. Pick it from `workspace_list_email_senders`, copied exactly. A sender the mail provider has not confirmed makes every send fail until it is confirmed.
+
+## What it costs
+
+Every email costs **5 workflow credits per recipient**, from the workspace's monthly workflow credits, which its workflows spend too: 500 on Free (about 100 single-recipient emails), 2,500 on Basic (about 500), 10,000 on Pro (about 2,000), 25,000 on Business (about 5,000). The plan and the closing message say so in plain numbers, for example: "Each submission emails you, at 5 workflow credits per email — about 100 emails a month on the Free plan."
+
+Emails sent from the preview are real and charged, and the actions in the code reach the live app as soon as they are saved. Send at most one test email, and only when the user asks for one. Never send emails in a loop to try something out.
+
+## Declare the action
+
+```ts
+const notifyOwner = defineEmailAction({
+  id: 'notifyOwner',
+  to: ['owner@acme.com'],
+  permissions: { userGroupTypes: ['NON_LOGGED_IN_USERS', 'LOGGED_IN_USERS'] },
+})
+
+const emailClient = defineEmailAction({
+  id: 'emailClient',
+  replyTo: '{LOGGED_IN_USER:EMAIL}',
+  permissions: { userGroupTypes: ['LOGGED_IN_USERS'], customGroups: ['<the staff group id>'] },
+})
+```
+
+- `id` is a name you choose, unique across the app.
+- `to`, `cc`, `bcc`: arrays of addresses. Each one declared here replaces the call's, and declaring `to` also ignores the call's `cc` and `bcc`. An element may be a whole placeholder for the signed-in sender: `{LOGGED_IN_USER:EMAIL}`, or `{LOGGED_IN_USER:<field>}` for an email field of their user record. Never part of a string, never in the call.
+- `replyTo`: an address or one such placeholder.
+- `senderId`: one of the workspace's senders, as above. The call can never set the sender.
+- `permissions`: who may send it, as for queries and mutations.
+
+Write the object inline in `defineEmailAction`, every value a literal. A declaration that cannot be read is not stored, and the check reports it.
+
+Declare one action per kind of email: the owner's notification and the client's confirmation are two actions, each with its own recipients and audience.
+
+## Core pattern
+
+```ts
+const submit = createServerFn({ method: 'POST' })
+  .validator(contactSchema)
+  .handler(async ({ data }) => {
+    const saved = await ds.create(saveSubmission, { data })
+    try {
+      await email.send(notifyOwner, {
+        subject: `New message from ${data.name}`,
+        body: renderSubmission(data),  // the app's own HTML, with what the visitor typed escaped
+        replyTo: data.email,
+        idempotencyKey: `submission-${saved.id}`,
+      })
+    } catch (error) {
+      if (error instanceof EmailError) return { saved: true, emailed: false, reason: error.message }
+      throw error
+    }
+    return { saved: true, emailed: true }
+  })
+```
+
+`email.send(action, init)` takes:
+
+- `subject` and `body`. Required. `body` is plain text or HTML. Escape what visitors typed before you put it into HTML.
+- `to`, `cc`, `bcc`, `replyTo`: each used only where the action does not fix it, and `cc` and `bcc` never when it fixes `to`. Each entry is one address. At most 50 recipients per email.
+- `attachments`: `{ name, url }` each, a file uploaded to this app (the Softr SDK `file-uploads` guidance); any other URL is refused with `INVALID_INPUT`. 10 MB in total.
+- `idempotencyKey`: the same key sends once, however often the call is repeated. Pass one derived from what the email is about, such as the record it announces, so a retried request never sends twice. At most 128 characters. Left out, every call is a new email.
+
+It answers `{ messageId }` once the email is sent. The answer never lists the recipients.
+
+## Failure modes
+
+**Not handling `EmailError`.** `email.send` throws an `EmailError` with `status`, `code` and `message` when the email was not sent, and never retries by itself. Catch it, keep what the request already saved, and show the person a line they can act on: "Saved, but the email could not be sent." The codes:
+
+| `code` | Meaning |
+| --- | --- |
+| `NOT_FOUND` | No such action, or the caller is not in its audience |
+| `INVALID_INPUT` | No subject or body, an entry or placeholder that is not exactly one address, more than 50 recipients, an attachment that is not one of the app's uploads, or an idempotency key over 128 characters |
+| `UNAVAILABLE` | Softr could not send it or could not be reached: no workflow credits left, Softr's address past its 30 emails today, an unconfirmed sender, or an outage |
+| `TIMEOUT` | No answer in time. It may still have been sent: retry only with the same key |
+
+**Calling from client code.** `email` is server-only. Wrap the send in a `createServerFn` and call that from the form or the button.
+
+**Taking recipients from the request when they could be fixed.** A `to` the browser sends is a `to` any caller can change. Fix it in the declaration, or read it on the server from the record the email is about.
+
+**Placeholders in the call.** `{LOGGED_IN_USER:EMAIL}` is filled only in the declaration. In the call it is sent as written and fails.
+
+**Building a workflow for an email the app sends itself.** A "Run custom workflow" trigger plus a "Send email" step does the same at more cost to the user: a workflow to keep published. Use the email action; keep workflows for schedules and table events.

package/skills/softr-sdk/file-uploads/SKILL.md

@@ -7,7 +7,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 **Boundary.** `upload` lives on `@softr/sdk/server` and runs inside server functions. `useFileUpload` and `FileItem` live on `@softr/sdk` and run in components. `FileAttachment` comes from `@softr/sdk` and can be imported anywhere.

package/skills/softr-sdk/formatting/SKILL.md

@@ -8,7 +8,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 # Dates, times and numbers

package/skills/softr-sdk/integrations/SKILL.md

@@ -7,7 +7,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 **Boundary.** `integration` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build. `defineIntegration` and every type come from `@softr/sdk` and can be imported anywhere.
@@ -16,6 +16,8 @@ metadata:
 
 `integration.createFetcher` calls a third-party API through Softr's authenticated proxy. It adds the connected account's credentials automatically — you never set API keys or auth headers yourself. **Every call acts as that one account, whoever the visitor is**, so take what a call reaches, such as a customer or a channel, from the session or a record the server read, never from the arguments the browser sends.
 
+An email the app sends is the `email` sub-skill, with nothing to connect. Send through a connected Gmail or Outlook only when the user wants the email to come from their own mailbox.
+
 ## Setup
 
 ```ts

package/skills/softr-sdk/mcp/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 **Boundary.** `softrMcpMiddleware` lives on `@softr/sdk` and is registered once, in `src/start.ts`. The actions you hand it are the same `defineQuery` / `defineMutation` values the app's own pages use — declared wherever they already live, not duplicated for MCP.

package/skills/softr-sdk/pwa/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 # Installing the app

package/skills/softr-sdk/record-mutations/SKILL.md

@@ -8,7 +8,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 **Boundary.** `ds` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build. `defineMutation` and every type come from `@softr/sdk` and can be imported anywhere.

package/skills/softr-sdk/record-queries/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 **Boundary.** `ds` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler or a server-side route hook — importing it into a component fails the build. The same holds for any helper that calls `ds`: declare it inside the handler. A function at module level that calls `ds` keeps the server-only import in the browser bundle, and every page stops loading until it moves. `defineQuery` and every type come from `@softr/sdk` and can be imported anywhere.

package/skills/softr-sdk/region-visibility/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 **Boundary.** `Audience` and `defineVisibility` come from `@softr/sdk` and work anywhere.

package/skills/softr-sdk/routes-and-visibility/SKILL.md

@@ -3,13 +3,13 @@ name: routes-and-visibility
 description: >-
   Add a route file and declare its settings: definePage with its visibility
   (LOGGED_IN_USERS, NON_LOGGED_IN_USERS and customGroups) and its title,
-  guardRoute or assertRouteAccess in beforeLoad, pageHead in head,
-  isAuthorized and checkAccess anywhere, rendering an access error, and the
-  lint rules that require the declaration.
+  guardRoute or assertRouteAccess in beforeLoad, pageHead in head, isAuthorized
+  and checkAccess anywhere, rendering an access error, and the lint rules that
+  require the declaration.
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 **Boundary.** `definePage`, `pageHead`, the access functions and the error predicates come from `@softr/sdk` and work anywhere.

package/skills/softr-sdk/workflows/SKILL.md

@@ -9,7 +9,7 @@ description: >-
 metadata:
   type: sub-skill
   library: softr-sdk
-  library_version: 0.0.92
+  library_version: 0.0.93-alpha.1
 ---
 
 **Boundary.** `workflow` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build. `defineWorkflow` and every type come from `@softr/sdk` and can be imported anywhere.
@@ -18,6 +18,8 @@ metadata:
 
 `workflow.trigger` fires a Softr workflow and waits for it to finish. It resolves to `void`.
 
+An email the app sends itself, when a form is submitted or a button is pressed, needs no workflow: load the `email` sub-skill. Fire a workflow for what the workflow's own steps do, such as updating a CRM or posting to a connected service.
+
 ## Setup
 
 ```ts
@@ -31,15 +33,15 @@ import { workflow } from '@softr/sdk/server'
 Every trigger needs a workflow action: which workflow, which trigger step, who may run it, and any data that is always sent. The workflow must have a **Run custom workflow** trigger — no other trigger type can be fired from app code.
 
 ```ts
-const sendWelcomeEmail = defineWorkflow({
-  id: 'sendWelcomeEmail',
+const syncNewLead = defineWorkflow({
+  id: 'syncNewLead',
   workflowId: 'c9d8e7f6-a5b4-4c3d-8e2f-1a0b9c8d7e6f',
   triggerId: '926da496-749f-4006-999c-197d8a556122',
   permissions: { userGroupTypes: ['LOGGED_IN_USERS'] },
   body: {
     email: '{LOGGED_IN_USER:EMAIL}',  // resolved server-side from the signed-in user
     name: '{LOGGED_IN_USER:NAME}',
-    plan: 'enterprise',               // any hardcoded value — always sent, never overridden at runtime
+    source: 'website',                // any hardcoded value — always sent, never overridden at runtime
   },
 })
 ```
@@ -70,7 +72,7 @@ These placeholders are resolved server-side when the workflow runs:
 const runWorkflow = createServerFn({ method: 'POST' })
   .validator(z.object({ message: z.string() }))
   .handler(async ({ data }) => {
-    await workflow.trigger(sendWelcomeEmail, { message: data.message })
+    await workflow.trigger(syncNewLead, { message: data.message })
   })
 ```
 
@@ -82,7 +84,7 @@ const runWorkflow = createServerFn({ method: 'POST' })
 
 ```ts
 const run = createServerFn({ method: 'POST' }).handler(async () => {
-  await workflow.trigger(sendWelcomeEmail)
+  await workflow.trigger(syncNewLead)
 })
 ```
 
@@ -94,11 +96,11 @@ Omit the second argument when the action's `body` already carries everything the
 
 ```ts
 // Wrong: calling from a click handler
-<button onClick={() => workflow.trigger(sendWelcomeEmail)}>Run</button>
+<button onClick={() => workflow.trigger(syncNewLead)}>Run</button>
 
 // Correct: server function, called from the button
 const run = createServerFn({ method: 'POST' }).handler(() =>
-  workflow.trigger(sendWelcomeEmail),
+  workflow.trigger(syncNewLead),
 )
 // …
 const submit = useServerFn(run)