@softr/sdk 0.0.96 → 0.0.97-alpha.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/dist/action.d.ts CHANGED
@@ -234,6 +234,50 @@ type IntegrationDefinition<TId extends string> = {
234
234
  * const res = await listEvents({ query: { timeMin: now, singleEvents: "true" } })
235
235
  */
236
236
  declare function defineIntegration<const TId extends string>(definition: IntegrationDefinition<TId>): IntegrationAction<TId>;
237
+ type EmailInputs = {
238
+ senderId?: string;
239
+ to?: ReadonlyArray<string>;
240
+ cc?: ReadonlyArray<string>;
241
+ bcc?: ReadonlyArray<string>;
242
+ replyTo?: string;
243
+ };
244
+ type EmailResource = {
245
+ type: "SOFTR_EMAIL";
246
+ inputs: EmailInputs;
247
+ };
248
+ type EmailAction<TId extends string = string> = Action<EmailResource> & {
249
+ id: TId;
250
+ };
251
+ type EmailDefinition<TId extends string> = EmailInputs & {
252
+ id: TId;
253
+ permissions: ActionPermissions;
254
+ };
255
+ /**
256
+ * Declares an email action: who may send it, and the fields every email it sends keeps whatever the
257
+ * call says. Softr sends it from the app's email sender and bills the workspace's workflow credits.
258
+ *
259
+ * - `to`, `cc`, `bcc`: addresses. An element may be a whole `{LOGGED_IN_USER:EMAIL}` or
260
+ * `{LOGGED_IN_USER:<field>}` placeholder, filled in for the signed-in sender.
261
+ * - `replyTo`: an address or one such placeholder.
262
+ * - `senderId`: one of the workspace's email senders, for an email that must come from that address.
263
+ * Left out, the app's sender is used. The call can never choose the sender.
264
+ *
265
+ * A field declared here wins over the call's, and declaring `to` also ignores the call's `cc` and
266
+ * `bcc`. Fix the recipients whenever the use case allows,
267
+ * because anyone in the audience can otherwise send any email to anyone.
268
+ *
269
+ * Pass the returned object to `email.send()` at runtime.
270
+ *
271
+ * @example
272
+ * const notifyOwner = defineEmailAction({
273
+ * id: "notifyOwner",
274
+ * to: ["owner@acme.com"],
275
+ * permissions: { userGroupTypes: ["NON_LOGGED_IN_USERS", "LOGGED_IN_USERS"] },
276
+ * })
277
+ *
278
+ * await email.send(notifyOwner, { subject: "New submission", body: html, replyTo: data.email })
279
+ */
280
+ declare function defineEmailAction<const TId extends string>(definition: EmailDefinition<TId>): EmailAction<TId>;
237
281
  type AiResource = {
238
282
  type: "SOFTR_AI";
239
283
  model: string;
@@ -268,4 +312,4 @@ type AiDefinition<TId extends string> = {
268
312
  */
269
313
  declare function defineAiAction<const TId extends string>(definition: AiDefinition<TId>): AiAction<TId>;
270
314
  //#endregion
271
- export { ActionData, ActionPermissions, ActionRecord, ActionShape, AiAction, DatasourceAction, FieldTypeOf, IntegrationAction, ReadOf, ReadShape, SoftrDatasources, WorkflowAction, defineAiAction, defineIntegration, defineMutation, defineQuery, defineWorkflow };
315
+ export { ActionData, ActionPermissions, ActionRecord, ActionShape, AiAction, DatasourceAction, EmailAction, FieldTypeOf, IntegrationAction, ReadOf, ReadShape, SoftrDatasources, WorkflowAction, defineAiAction, defineEmailAction, defineIntegration, defineMutation, defineQuery, defineWorkflow };
package/dist/action.js CHANGED
@@ -50,6 +50,42 @@ function defineIntegration(definition) {
50
50
  permissions
51
51
  };
52
52
  }
53
+ /**
54
+ * Declares an email action: who may send it, and the fields every email it sends keeps whatever the
55
+ * call says. Softr sends it from the app's email sender and bills the workspace's workflow credits.
56
+ *
57
+ * - `to`, `cc`, `bcc`: addresses. An element may be a whole `{LOGGED_IN_USER:EMAIL}` or
58
+ * `{LOGGED_IN_USER:<field>}` placeholder, filled in for the signed-in sender.
59
+ * - `replyTo`: an address or one such placeholder.
60
+ * - `senderId`: one of the workspace's email senders, for an email that must come from that address.
61
+ * Left out, the app's sender is used. The call can never choose the sender.
62
+ *
63
+ * A field declared here wins over the call's, and declaring `to` also ignores the call's `cc` and
64
+ * `bcc`. Fix the recipients whenever the use case allows,
65
+ * because anyone in the audience can otherwise send any email to anyone.
66
+ *
67
+ * Pass the returned object to `email.send()` at runtime.
68
+ *
69
+ * @example
70
+ * const notifyOwner = defineEmailAction({
71
+ * id: "notifyOwner",
72
+ * to: ["owner@acme.com"],
73
+ * permissions: { userGroupTypes: ["NON_LOGGED_IN_USERS", "LOGGED_IN_USERS"] },
74
+ * })
75
+ *
76
+ * await email.send(notifyOwner, { subject: "New submission", body: html, replyTo: data.email })
77
+ */
78
+ function defineEmailAction(definition) {
79
+ const { id, permissions,...inputs } = definition;
80
+ return {
81
+ id,
82
+ resource: {
83
+ type: "SOFTR_EMAIL",
84
+ inputs
85
+ },
86
+ permissions
87
+ };
88
+ }
53
89
  function isDatasourceAction(value) {
54
90
  if (typeof value !== "object" || value === null) return false;
55
91
  const candidate = value;
@@ -69,4 +105,4 @@ function defineAiAction(definition) {
69
105
  }
70
106
 
71
107
  //#endregion
72
- export { defineAiAction, defineIntegration, defineMutation, defineQuery, defineWorkflow, isDatasourceAction };
108
+ export { defineAiAction, defineEmailAction, defineIntegration, defineMutation, defineQuery, defineWorkflow, isDatasourceAction };
@@ -0,0 +1,46 @@
1
+ import { EmailAction } from "../action.js";
2
+
3
+ //#region src/core/email.d.ts
4
+ declare const EMAIL_ERROR_CODES: readonly ["NOT_FOUND", "INVALID_INPUT", "PLAN_RESTRICTED", "CREDITS_EXHAUSTED", "RATE_LIMITED", "PROVIDER_REJECTED", "UNAVAILABLE", "TIMEOUT"];
5
+ type EmailErrorCode = (typeof EMAIL_ERROR_CODES)[number];
6
+ interface EmailSendInit {
7
+ /** Ignored when the action declares its own. */
8
+ to?: ReadonlyArray<string>;
9
+ /** Ignored when the action declares its own `cc` or `to`. */
10
+ cc?: ReadonlyArray<string>;
11
+ /** Ignored when the action declares its own `bcc` or `to`. */
12
+ bcc?: ReadonlyArray<string>;
13
+ /** Ignored when the action declares its own. */
14
+ replyTo?: string;
15
+ subject: string;
16
+ /** Plain text or HTML. */
17
+ body: string;
18
+ }
19
+ interface EmailSent {
20
+ /** Null when the mail provider did not report one; the email was still sent. */
21
+ messageId: string | null;
22
+ }
23
+ /**
24
+ * Thrown when Softr did not send the email. `code` says why:
25
+ *
26
+ * - `NOT_FOUND`: no such action, or the caller is not in its audience.
27
+ * - `INVALID_INPUT`: the call's inputs were refused; the message says which.
28
+ * - `PLAN_RESTRICTED`: the workspace's plan does not include sending this email.
29
+ * - `CREDITS_EXHAUSTED`: the workspace has no workflow credits left.
30
+ * - `RATE_LIMITED`: the app sent too many emails lately; try again later.
31
+ * - `PROVIDER_REJECTED`: the mail provider refused the email.
32
+ * - `UNAVAILABLE`: Softr could not send it right now, or could not be reached.
33
+ * - `TIMEOUT`: no answer in time. It may still have been sent.
34
+ */
35
+ declare class EmailError extends Error {
36
+ readonly status: number;
37
+ readonly code: EmailErrorCode;
38
+ constructor(status: number, code: EmailErrorCode, message: string);
39
+ }
40
+ /** Sends one email through the action. Never retries by itself. */
41
+ declare function sendEmail(action: EmailAction, init: EmailSendInit): Promise<EmailSent>;
42
+ declare const email: {
43
+ send: typeof sendEmail;
44
+ };
45
+ //#endregion
46
+ export { EmailError, EmailErrorCode, EmailSendInit, EmailSent, email };
@@ -0,0 +1,96 @@
1
+ import { assert } from "../assertions.js";
2
+ import { softrApiUrl } from "../softr-api.js";
3
+ import { fetch } from "../fetch.js";
4
+ import { sessionConfig } from "../auth/config.js";
5
+ import { readSessionToken } from "../auth/session.js";
6
+
7
+ //#region src/core/email.ts
8
+ /** Longer than Softr waits for the send itself, so its own timeout answers first. */
9
+ const TIMEOUT_MS = 12e4;
10
+ const EMAIL_ERROR_CODES = [
11
+ "NOT_FOUND",
12
+ "INVALID_INPUT",
13
+ "PLAN_RESTRICTED",
14
+ "CREDITS_EXHAUSTED",
15
+ "RATE_LIMITED",
16
+ "PROVIDER_REJECTED",
17
+ "UNAVAILABLE",
18
+ "TIMEOUT"
19
+ ];
20
+ /**
21
+ * Thrown when Softr did not send the email. `code` says why:
22
+ *
23
+ * - `NOT_FOUND`: no such action, or the caller is not in its audience.
24
+ * - `INVALID_INPUT`: the call's inputs were refused; the message says which.
25
+ * - `PLAN_RESTRICTED`: the workspace's plan does not include sending this email.
26
+ * - `CREDITS_EXHAUSTED`: the workspace has no workflow credits left.
27
+ * - `RATE_LIMITED`: the app sent too many emails lately; try again later.
28
+ * - `PROVIDER_REJECTED`: the mail provider refused the email.
29
+ * - `UNAVAILABLE`: Softr could not send it right now, or could not be reached.
30
+ * - `TIMEOUT`: no answer in time. It may still have been sent.
31
+ */
32
+ var EmailError = class extends Error {
33
+ status;
34
+ code;
35
+ constructor(status, code, message) {
36
+ super(message);
37
+ this.name = "EmailError";
38
+ this.status = status;
39
+ this.code = code;
40
+ }
41
+ };
42
+ /** Sends one email through the action. Never retries by itself. */
43
+ async function sendEmail(action, init) {
44
+ const { to, cc, bcc, replyTo, subject, body } = init;
45
+ const sessionToken = readSessionToken();
46
+ let res;
47
+ try {
48
+ res = await fetch(`${softrApiUrl("SOFTR_PLATFORM_API_URL")}/v1/vibe/applications/${sessionConfig().applicationId}/actions/${action.id}/email`, {
49
+ method: "POST",
50
+ headers: {
51
+ ...sessionToken ? { Authorization: `Bearer ${sessionToken}` } : {},
52
+ "Content-Type": "application/json"
53
+ },
54
+ body: JSON.stringify({ input: {
55
+ to,
56
+ cc,
57
+ bcc,
58
+ replyTo,
59
+ subject,
60
+ body
61
+ } }),
62
+ signal: AbortSignal.timeout(TIMEOUT_MS)
63
+ });
64
+ } catch (error) {
65
+ 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.`);
66
+ throw new EmailError(502, "UNAVAILABLE", `Email "${action.id}" could not reach Softr: ${error instanceof Error ? error.message : String(error)}`);
67
+ }
68
+ if (res.ok) {
69
+ const sent = await res.json();
70
+ assert(typeof sent === "object" && sent !== null && "messageId" in sent && (typeof sent.messageId === "string" || sent.messageId === null), "the send answered without a messageId");
71
+ return { messageId: sent.messageId };
72
+ }
73
+ const { code, message } = await readFailure(res, `Email "${action.id}" failed with HTTP ${res.status}`);
74
+ throw new EmailError(res.status, code, message);
75
+ }
76
+ /** The code and message of a send Softr refused, read from its answer; `fallbackMessage` when it sent none. */
77
+ async function readFailure(res, fallbackMessage) {
78
+ const failure = await res.json().catch(() => null);
79
+ const known = typeof failure === "object" && failure !== null ? failure : {};
80
+ return {
81
+ code: ("code" in known ? EMAIL_ERROR_CODES.find((errorCode) => errorCode === known.code) : void 0) ?? codeOfStatus(res.status),
82
+ message: "message" in known && typeof known.message === "string" && known.message !== "" ? known.message : fallbackMessage
83
+ };
84
+ }
85
+ function codeOfStatus(status) {
86
+ switch (status) {
87
+ case 400: return "INVALID_INPUT";
88
+ case 404: return "NOT_FOUND";
89
+ case 429: return "RATE_LIMITED";
90
+ default: return "UNAVAILABLE";
91
+ }
92
+ }
93
+ const email = { send: sendEmail };
94
+
95
+ //#endregion
96
+ export { EmailError, email };
@@ -1,4 +1,4 @@
1
- import * as react6 from "react";
1
+ import * as react0 from "react";
2
2
 
3
3
  //#region src/default-error-overlay.d.ts
4
4
  type Props = {
@@ -8,6 +8,6 @@ type Props = {
8
8
  declare function DefaultErrorOverlay({
9
9
  error,
10
10
  reset
11
- }: Props): react6.JSX.Element;
11
+ }: Props): react0.JSX.Element;
12
12
  //#endregion
13
13
  export { DefaultErrorOverlay };
@@ -1,5 +1,5 @@
1
1
  import { z } from "zod";
2
- import * as react0 from "react";
2
+ import * as react3 from "react";
3
3
  import { ReactNode } from "react";
4
4
 
5
5
  //#region src/formatting.d.ts
@@ -94,7 +94,7 @@ declare function FormattingScope({
94
94
  /** A BCP 47 locale, such as `de-DE`. It drops the app's fixed date format inside the scope. */
95
95
  locale?: string;
96
96
  children?: ReactNode;
97
- }): react0.FunctionComponentElement<react0.ProviderProps<Scope>>;
97
+ }): react3.FunctionComponentElement<react3.ProviderProps<Scope>>;
98
98
  /**
99
99
  * A date in the app's format, safe to render on the server. A timestamp whose
100
100
  * zone is not known yet renders `fallback` until the browser supplies it, so
@@ -115,6 +115,6 @@ declare function FormattedDate({
115
115
  time?: boolean;
116
116
  /** What renders while the visitor's zone is unknown. */
117
117
  fallback?: ReactNode;
118
- }): react0.FunctionComponentElement<react0.FragmentProps>;
118
+ }): react3.FunctionComponentElement<react3.FragmentProps>;
119
119
  //#endregion
120
120
  export { DateOptions, DateParts, DateSeparator, DateValue, FixedDateFormat, FormattedDate, Formatting, FormattingScope, WeekDay, formatDate, formatDateTime, formatNumber, useFormatting };
package/dist/index.d.ts CHANGED
@@ -1,8 +1,9 @@
1
1
  import { SoftrUserGroupId, SoftrUserGroups, SoftrUserProperties, User } from "./auth/user.js";
2
- import { ActionPermissions, SoftrDatasources, defineAiAction, defineIntegration, defineMutation, defineQuery, defineWorkflow } from "./action.js";
2
+ import { ActionPermissions, SoftrDatasources, defineAiAction, defineEmailAction, defineIntegration, defineMutation, defineQuery, defineWorkflow } from "./action.js";
3
3
  import { FileAttachment } from "./core/file-upload.js";
4
4
  import { FileItem, useFileUpload } from "./core/use-file-upload.js";
5
5
  import { AiAnswer, AiFile, AiGenerateInit, AiMessage, AiUsage } from "./core/ai.js";
6
+ import { EmailSendInit, EmailSent } from "./core/email.js";
6
7
  import { DateOptions, DateParts, DateSeparator, DateValue, FixedDateFormat, FormattedDate, Formatting, FormattingScope, WeekDay, formatDate, formatDateTime, formatNumber, useFormatting } from "./formatting.js";
7
8
  import { SoftrContext } from "./auth/context.js";
8
9
  import { AuthSettings } from "./auth/platform.js";
@@ -18,4 +19,4 @@ import { useUserTimezone } from "./timezone.js";
18
19
  import { PwaInstall, PwaPlatform, SoftrPwaHead, usePwaInstall } from "./pwa.js";
19
20
  import { DefaultErrorOverlay } from "./default-error-overlay.js";
20
21
  import { Audience } from "./route/audience.js";
21
- 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 };
22
+ 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 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 CHANGED
@@ -1,4 +1,4 @@
1
- import { defineAiAction, defineIntegration, defineMutation, defineQuery, defineWorkflow } from "./action.js";
1
+ import { defineAiAction, defineEmailAction, defineIntegration, defineMutation, defineQuery, defineWorkflow } from "./action.js";
2
2
  import { useFileUpload } from "./core/use-file-upload.js";
3
3
  import { checkAccess, defineVisibility, isAuthorized } from "./route/visibility.js";
4
4
  import { assertRouteAccess, guardRoute, isAccessError, isAlreadyAuthenticatedError, isForbiddenError, isUnauthenticatedError } from "./route/route.js";
@@ -14,4 +14,4 @@ import { useUserTimezone } from "./timezone.js";
14
14
  import { DefaultErrorOverlay } from "./default-error-overlay.js";
15
15
  import { Audience } from "./route/audience.js";
16
16
 
17
- 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 };
17
+ 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/mcp.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { DatasourceAction } from "./action.js";
2
- import * as _tanstack_react_start7 from "@tanstack/react-start";
2
+ import * as _tanstack_react_start0 from "@tanstack/react-start";
3
3
 
4
4
  //#region src/mcp.d.ts
5
5
 
@@ -31,6 +31,6 @@ type SoftrMcpOptions = {
31
31
  * ],
32
32
  * }))
33
33
  */
34
- declare function softrMcpMiddleware(options?: SoftrMcpOptions): _tanstack_react_start7.RequestMiddlewareAfterServer<{}, undefined, undefined>;
34
+ declare function softrMcpMiddleware(options?: SoftrMcpOptions): _tanstack_react_start0.RequestMiddlewareAfterServer<{}, undefined, undefined>;
35
35
  //#endregion
36
36
  export { softrMcpMiddleware };
package/dist/package.js CHANGED
@@ -1,5 +1,5 @@
1
1
  //#region package.json
2
- var version = "0.0.96";
2
+ var version = "0.0.97-alpha.1";
3
3
 
4
4
  //#endregion
5
5
  export { version };
package/dist/pwa.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import * as react4 from "react";
1
+ import * as react1 from "react";
2
2
  import "@tanstack/react-start";
3
3
 
4
4
  //#region src/pwa.d.ts
@@ -23,7 +23,7 @@ import "@tanstack/react-start";
23
23
  * )
24
24
  * }
25
25
  */
26
- declare function SoftrPwaHead(): react4.FunctionComponentElement<react4.FragmentProps>;
26
+ declare function SoftrPwaHead(): react1.FunctionComponentElement<react1.FragmentProps>;
27
27
  type PwaPlatform = "ios" | "android" | "desktop";
28
28
  type PwaInstall = {
29
29
  available: false;
package/dist/server.d.ts CHANGED
@@ -1,9 +1,10 @@
1
1
  import { upload } from "./core/file-upload.js";
2
2
  import { AiError, ai } from "./core/ai.js";
3
+ import { EmailError, EmailErrorCode, email } from "./core/email.js";
3
4
  import { auth } from "./auth/server.js";
4
5
  import { FieldChoice, RecordOption, RecordOptions } from "./core/options.js";
5
6
  import { ds } from "./datasource/datasource.js";
6
7
  import { workflow } from "./core/workflow.js";
7
8
  import { integration } from "./core/integration.js";
8
9
  import "@tanstack/react-start/server-only";
9
- export { AiError, type FieldChoice, type RecordOption, type RecordOptions, ai, auth, ds, integration, upload, workflow };
10
+ export { AiError, EmailError, type EmailErrorCode, type FieldChoice, type RecordOption, type RecordOptions, ai, auth, ds, email, integration, upload, workflow };
package/dist/server.js CHANGED
@@ -4,6 +4,7 @@ import { auth } from "./auth/server.js";
4
4
  import { workflow } from "./core/workflow.js";
5
5
  import { integration } from "./core/integration.js";
6
6
  import { AiError, ai } from "./core/ai.js";
7
+ import { EmailError, email } from "./core/email.js";
7
8
  import "@tanstack/react-start/server-only";
8
9
 
9
- export { AiError, ai, auth, ds, integration, upload, workflow };
10
+ export { AiError, EmailError, ai, auth, ds, email, integration, upload, workflow };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@softr/sdk",
3
- "version": "0.0.96",
3
+ "version": "0.0.97-alpha.1",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js" },
@@ -9,7 +9,7 @@ description: >-
9
9
  metadata:
10
10
  type: core
11
11
  library: softr-sdk
12
- library_version: 0.0.96
12
+ library_version: 0.0.97-alpha.1
13
13
  ---
14
14
 
15
15
  # Softr SDK core
@@ -22,6 +22,8 @@ metadata:
22
22
  >
23
23
  > **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.
24
24
  >
25
+ > **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.
26
+ >
25
27
  > **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.
26
28
  >
27
29
  > **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
32
34
 
33
35
  | Import | Runs | Holds |
34
36
  | --- | --- | --- |
35
- | `@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 |
36
- | `@softr/sdk/server` | Server only | `ds`, `auth`, `workflow`, `integration`, `ai` |
37
+ | `@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 |
38
+ | `@softr/sdk/server` | Server only | `ds`, `auth`, `email`, `EmailError`, `workflow`, `integration`, `ai` |
37
39
  | `@softr/sdk/client` | Browser only | `useFileUpload` |
38
40
  | `@softr/sdk/vite` | Build | `softr()`, already in `vite.config.ts` |
39
41
 
@@ -47,10 +49,11 @@ Each sub-skill stands alone for its task and repeats the boundary above, so most
47
49
  | Fetch records from a datasource | [record-queries/SKILL.md](./record-queries/SKILL.md) |
48
50
  | Chart, aggregate or count records | [charts-and-metrics/SKILL.md](./charts-and-metrics/SKILL.md) |
49
51
  | Create, update or delete a record | [record-mutations/SKILL.md](./record-mutations/SKILL.md) |
52
+ | Send an email from the app: a form that emails the owner, a confirmation, staff emailing a client | [email/SKILL.md](./email/SKILL.md) |
50
53
  | Trigger a Softr workflow | [workflows/SKILL.md](./workflows/SKILL.md) |
51
54
  | Sign a visitor in, out, or up | [auth/SKILL.md](./auth/SKILL.md) |
52
55
  | Ask an AI model: a summary, an extraction from a document, a classification, a draft, a chat | [ai/SKILL.md](./ai/SKILL.md) |
53
- | 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) |
56
+ | 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) |
54
57
  | Open the app to AI assistants over MCP | [mcp/SKILL.md](./mcp/SKILL.md) |
55
58
  | Let visitors install the app on their home screen | [pwa/SKILL.md](./pwa/SKILL.md) |
56
59
  | 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?
76
79
  Submitting a form, editing a record, or deleting one?
77
80
  load softr-sdk/record-mutations
78
81
 
82
+ Sending an email when a form is submitted or a button is pressed?
83
+ load softr-sdk/email — no workflow, no connected mail service
84
+
79
85
  Triggering a Softr workflow from a button or form?
80
86
  load softr-sdk/workflows
81
87
 
@@ -13,7 +13,7 @@ description: >-
13
13
  metadata:
14
14
  type: sub-skill
15
15
  library: softr-sdk
16
- library_version: 0.0.96
16
+ library_version: 0.0.97-alpha.1
17
17
  ---
18
18
 
19
19
  **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.
@@ -9,7 +9,7 @@ description: >-
9
9
  metadata:
10
10
  type: sub-skill
11
11
  library: softr-sdk
12
- library_version: 0.0.96
12
+ library_version: 0.0.97-alpha.1
13
13
  ---
14
14
 
15
15
  **Boundary.** `auth` lives on `@softr/sdk/server` and runs only inside a `createServerFn` handler — importing it into a component fails the build.
@@ -9,7 +9,7 @@ description: >-
9
9
  metadata:
10
10
  type: sub-skill
11
11
  library: softr-sdk
12
- library_version: 0.0.96
12
+ library_version: 0.0.97-alpha.1
13
13
  ---
14
14
 
15
15
  **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.
@@ -9,7 +9,7 @@ description: >-
9
9
  metadata:
10
10
  type: sub-skill
11
11
  library: softr-sdk
12
- library_version: 0.0.96
12
+ library_version: 0.0.97-alpha.1
13
13
  ---
14
14
 
15
15
  # The current user
@@ -0,0 +1,129 @@
1
+ ---
2
+ name: email
3
+ description: >-
4
+ Send an email from the app itself, with nothing to connect and no workflow:
5
+ defineEmailAction from @softr/sdk declares who may send it and the fields it
6
+ fixes (to, cc, bcc, replyTo, and an optional senderId); email.send from
7
+ @softr/sdk/server sends one with a subject and a text or HTML body, and throws
8
+ an EmailError with a code when Softr does not send it. Load this for a contact
9
+ form that emails the owner, a confirmation to the signed-in user, staff
10
+ emailing a client, or any email the app sends while handling what a person
11
+ does in it.
12
+ metadata:
13
+ type: sub-skill
14
+ library: softr-sdk
15
+ library_version: 0.0.97-alpha.1
16
+ ---
17
+
18
+ **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.
19
+
20
+ # Email
21
+
22
+ 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.
23
+
24
+ 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.
25
+
26
+ `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.
27
+
28
+ ## Who can send it, and to whom
29
+
30
+ 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.
31
+
32
+ - **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.
33
+ - **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`: one that fixes only `cc` or `bcc` is not stored.
34
+
35
+ ## The sender
36
+
37
+ Every email comes from the app's email sender, unless the action names one of the workspace's senders with `senderId`. With no sender set, they come from the app's default `@softr.app` address, the one its sign-in emails use.
38
+
39
+ - Read the app's sender with `application_get` before you say where the emails come from, and name it. Never write "if no sender is set": read it. With no sender set, that tool shows the app's default `@softr.app` address: name that one. Say in your closing message when no sender is set, and that the app should get its own sender before real users rely on its emails.
40
+ - When the app has no sender of its own, list the workspace's senders with `workspace_list_email_senders` and offer the confirmed ones by name: for this email (`senderId`, nothing else changes) or as the app's sender. Never pick one yourself.
41
+ - 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. A workspace whose plan has no custom senders is refused; then say that sending from their own address needs the Professional plan.
42
+ - 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. That confirmation is all an email action needs; the domain's DNS records (DKIM, Return-Path) are needed only before Studio lets the app pick the address as its own sender, and they help the emails stay out of spam.
43
+
44
+ ## What it costs
45
+
46
+ Every email costs **5 workflow credits per recipient**, from the workspace's monthly workflow credits, which its workflows spend too. You do not know the workspace's plan, so never name one or count how many emails it covers. The plan and the closing message give the cost and where to watch it, for example: "Each submission emails you, at 5 workflow credits per email. Track them in Settings → Billing → Workflow usage, where this app has its own row."
47
+
48
+ 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.
49
+
50
+ ## Declare the action
51
+
52
+ ```ts
53
+ const notifyOwner = defineEmailAction({
54
+ id: 'notifyOwner',
55
+ to: ['owner@acme.com'],
56
+ permissions: { userGroupTypes: ['NON_LOGGED_IN_USERS', 'LOGGED_IN_USERS'] },
57
+ })
58
+
59
+ const emailClient = defineEmailAction({
60
+ id: 'emailClient',
61
+ replyTo: '{LOGGED_IN_USER:EMAIL}',
62
+ permissions: { userGroupTypes: ['LOGGED_IN_USERS'], customGroups: ['<the staff group id>'] },
63
+ })
64
+ ```
65
+
66
+ - `id` is a name you choose, unique across the app.
67
+ - `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.
68
+ - `replyTo`: an address or one such placeholder.
69
+ - `senderId`: one of the workspace's senders, as above. The call can never set the sender.
70
+ - `permissions`: who may send it, as for queries and mutations.
71
+
72
+ Write the object inline in `defineEmailAction`, every value a literal. A declaration that cannot be read is not stored, and the check reports it.
73
+
74
+ 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.
75
+
76
+ ## Core pattern
77
+
78
+ ```ts
79
+ const submit = createServerFn({ method: 'POST' })
80
+ .validator(contactSchema)
81
+ .handler(async ({ data }) => {
82
+ const saved = await ds.create(saveSubmission, { data })
83
+ try {
84
+ await email.send(notifyOwner, {
85
+ subject: `New message from ${data.name}`,
86
+ body: renderSubmission(data), // the app's own HTML, with what the visitor typed escaped
87
+ replyTo: data.email,
88
+ })
89
+ } catch (error) {
90
+ if (error instanceof EmailError) return { saved: true, emailed: false, reason: error.message }
91
+ throw error
92
+ }
93
+ return { saved: true, emailed: true }
94
+ })
95
+ ```
96
+
97
+ `email.send(action, init)` takes:
98
+
99
+ - `subject` and `body`. Required. `body` is plain text or HTML. Escape what visitors typed before you put it into HTML.
100
+ - `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.
101
+
102
+ It answers `{ messageId }` once the email is sent. The answer never lists the recipients. An email carries no attachments: link to the file instead.
103
+
104
+ Every call is a new email. Disable the button while the request runs, so a double click does not send twice.
105
+
106
+ ## Failure modes
107
+
108
+ **Not handling `EmailError`.** `email.send` throws an `EmailError` from `@softr/sdk/server`, 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:
109
+
110
+ | `code` | Meaning |
111
+ | --- | --- |
112
+ | `NOT_FOUND` | No such action, or the caller is not in its audience |
113
+ | `INVALID_INPUT` | No subject or body, an entry or placeholder that is not exactly one address, or more than 50 recipients |
114
+ | `PLAN_RESTRICTED` | The workspace's plan does not allow this email |
115
+ | `CREDITS_EXHAUSTED` | The workspace has no workflow credits left |
116
+ | `RATE_LIMITED` | The app sent too often lately. Tell the person to try again later |
117
+ | `PROVIDER_REJECTED` | The mail provider refused the email, for example from an unconfirmed sender |
118
+ | `UNAVAILABLE` | Softr could not send it right now or could not be reached |
119
+ | `TIMEOUT` | No answer in time. It may still have been sent, so never send it again by yourself |
120
+
121
+ **Letting a mistyped address reach Softr.** An address the person typed (the reply-to of a contact form, a client's email) that is not one address is refused with `INVALID_INPUT`, which reads as a vague failure. Check its format in the validator and tell them which field is wrong.
122
+
123
+ **Calling from client code.** `email` is server-only. Wrap the send in a `createServerFn` and call that from the form or the button.
124
+
125
+ **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.
126
+
127
+ **Placeholders in the call.** `{LOGGED_IN_USER:EMAIL}` is filled only in the declaration. In the call it is sent as written and fails.
128
+
129
+ **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.
@@ -7,7 +7,7 @@ description: >-
7
7
  metadata:
8
8
  type: sub-skill
9
9
  library: softr-sdk
10
- library_version: 0.0.96
10
+ library_version: 0.0.97-alpha.1
11
11
  ---
12
12
 
13
13
  **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.
@@ -8,7 +8,7 @@ description: >-
8
8
  metadata:
9
9
  type: sub-skill
10
10
  library: softr-sdk
11
- library_version: 0.0.96
11
+ library_version: 0.0.97-alpha.1
12
12
  ---
13
13
 
14
14
  # Dates, times and numbers
@@ -7,7 +7,7 @@ description: >-
7
7
  metadata:
8
8
  type: sub-skill
9
9
  library: softr-sdk
10
- library_version: 0.0.96
10
+ library_version: 0.0.97-alpha.1
11
11
  ---
12
12
 
13
13
  **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:
16
16
 
17
17
  `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.
18
18
 
19
+ 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.
20
+
19
21
  ## Setup
20
22
 
21
23
  ```ts
@@ -9,7 +9,7 @@ description: >-
9
9
  metadata:
10
10
  type: sub-skill
11
11
  library: softr-sdk
12
- library_version: 0.0.96
12
+ library_version: 0.0.97-alpha.1
13
13
  ---
14
14
 
15
15
  **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.
@@ -9,7 +9,7 @@ description: >-
9
9
  metadata:
10
10
  type: sub-skill
11
11
  library: softr-sdk
12
- library_version: 0.0.96
12
+ library_version: 0.0.97-alpha.1
13
13
  ---
14
14
 
15
15
  # Installing the app
@@ -8,7 +8,7 @@ description: >-
8
8
  metadata:
9
9
  type: sub-skill
10
10
  library: softr-sdk
11
- library_version: 0.0.96
11
+ library_version: 0.0.97-alpha.1
12
12
  ---
13
13
 
14
14
  **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.
@@ -9,7 +9,7 @@ description: >-
9
9
  metadata:
10
10
  type: sub-skill
11
11
  library: softr-sdk
12
- library_version: 0.0.96
12
+ library_version: 0.0.97-alpha.1
13
13
  ---
14
14
 
15
15
  **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.
@@ -9,7 +9,7 @@ description: >-
9
9
  metadata:
10
10
  type: sub-skill
11
11
  library: softr-sdk
12
- library_version: 0.0.96
12
+ library_version: 0.0.97-alpha.1
13
13
  ---
14
14
 
15
15
  **Boundary.** `Audience` and `defineVisibility` come from `@softr/sdk` and work anywhere.
@@ -9,7 +9,7 @@ description: >-
9
9
  metadata:
10
10
  type: sub-skill
11
11
  library: softr-sdk
12
- library_version: 0.0.96
12
+ library_version: 0.0.97-alpha.1
13
13
  ---
14
14
 
15
15
  **Boundary.** `definePage`, `pageHead`, the access functions and the error predicates come from `@softr/sdk` and work anywhere.
@@ -9,7 +9,7 @@ description: >-
9
9
  metadata:
10
10
  type: sub-skill
11
11
  library: softr-sdk
12
- library_version: 0.0.96
12
+ library_version: 0.0.97-alpha.1
13
13
  ---
14
14
 
15
15
  **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:
18
18
 
19
19
  `workflow.trigger` fires a Softr workflow and waits for it to finish. It resolves to `void`.
20
20
 
21
+ 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.
22
+
21
23
  ## Setup
22
24
 
23
25
  ```ts
@@ -31,15 +33,15 @@ import { workflow } from '@softr/sdk/server'
31
33
  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.
32
34
 
33
35
  ```ts
34
- const sendWelcomeEmail = defineWorkflow({
35
- id: 'sendWelcomeEmail',
36
+ const syncNewLead = defineWorkflow({
37
+ id: 'syncNewLead',
36
38
  workflowId: 'c9d8e7f6-a5b4-4c3d-8e2f-1a0b9c8d7e6f',
37
39
  triggerId: '926da496-749f-4006-999c-197d8a556122',
38
40
  permissions: { userGroupTypes: ['LOGGED_IN_USERS'] },
39
41
  body: {
40
42
  email: '{LOGGED_IN_USER:EMAIL}', // resolved server-side from the signed-in user
41
43
  name: '{LOGGED_IN_USER:NAME}',
42
- plan: 'enterprise', // any hardcoded value — always sent, never overridden at runtime
44
+ source: 'website', // any hardcoded value — always sent, never overridden at runtime
43
45
  },
44
46
  })
45
47
  ```
@@ -70,7 +72,7 @@ These placeholders are resolved server-side when the workflow runs:
70
72
  const runWorkflow = createServerFn({ method: 'POST' })
71
73
  .validator(z.object({ message: z.string() }))
72
74
  .handler(async ({ data }) => {
73
- await workflow.trigger(sendWelcomeEmail, { message: data.message })
75
+ await workflow.trigger(syncNewLead, { message: data.message })
74
76
  })
75
77
  ```
76
78
 
@@ -82,7 +84,7 @@ const runWorkflow = createServerFn({ method: 'POST' })
82
84
 
83
85
  ```ts
84
86
  const run = createServerFn({ method: 'POST' }).handler(async () => {
85
- await workflow.trigger(sendWelcomeEmail)
87
+ await workflow.trigger(syncNewLead)
86
88
  })
87
89
  ```
88
90
 
@@ -94,11 +96,11 @@ Omit the second argument when the action's `body` already carries everything the
94
96
 
95
97
  ```ts
96
98
  // Wrong: calling from a click handler
97
- <button onClick={() => workflow.trigger(sendWelcomeEmail)}>Run</button>
99
+ <button onClick={() => workflow.trigger(syncNewLead)}>Run</button>
98
100
 
99
101
  // Correct: server function, called from the button
100
102
  const run = createServerFn({ method: 'POST' }).handler(() =>
101
- workflow.trigger(sendWelcomeEmail),
103
+ workflow.trigger(syncNewLead),
102
104
  )
103
105
  // …
104
106
  const submit = useServerFn(run)