@marinoscar/platform-contract 0.1.0-next.3 → 0.1.0-next.4

package/dist/cjs/email/constants.js

@@ -0,0 +1,82 @@
+"use strict";
+// =============================================================================
+// Email: the zod-free constants of the wire contract (issue #737, PP-8.4; transports: PP-14.8)
+// =============================================================================
+//
+// Email transports are PLUGGABLE (PP-14.8): an app or package registers more
+// with `registerEmailTransport` (`@marinoscar/platform-api/email`). The two
+// below are the transports the platform ships.
+// =============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IMPLICIT_TLS_SMTP_PORT = exports.DEFAULT_SMTP_PORT = exports.LEGACY_EMAIL_FLAT_FIELD_TARGETS = exports.LEGACY_EMAIL_FLAT_FIELDS = exports.EMAIL_PROVIDER_KINDS = exports.BUILTIN_EMAIL_PROVIDER_KINDS = exports.EMAIL_TRANSPORT_ID_PATTERN = void 0;
+/**
+ * The pattern every email transport id must match: a lower-case letter, then
+ * letters, digits and hyphens, 2 to 48 characters. The same pattern as every
+ * pluggable id (`PLUGGABLE_ID_PATTERN` of `@marinoscar/platform-contract/settings`).
+ * An id is the key its settings are stored under, so it is permanent once a
+ * row exists.
+ *
+ * @stability experimental
+ */
+exports.EMAIL_TRANSPORT_ID_PATTERN = /^[a-z][a-z0-9-]{1,47}$/;
+/**
+ * The transports the platform SHIPS: Amazon SES (API) and SMTP. Not a closed
+ * set: an app registers more with `registerEmailTransport` and its id is any
+ * {@link EMAIL_TRANSPORT_ID_PATTERN} string. Use this list for defaults,
+ * labels and the legacy flat fields, never to validate an id.
+ *
+ * @stability experimental
+ */
+exports.BUILTIN_EMAIL_PROVIDER_KINDS = ['ses', 'smtp'];
+/**
+ * The built-in transports.
+ *
+ * @deprecated Use `BUILTIN_EMAIL_PROVIDER_KINDS`. The list is no longer the
+ *   set of valid transports: any registered email transport id is one.
+ * @stability stable
+ */
+exports.EMAIL_PROVIDER_KINDS = exports.BUILTIN_EMAIL_PROVIDER_KINDS;
+/**
+ * The names of the flat fields the `email` row stored before transports had a
+ * settings record of their own. They are a deprecated READ VIEW of the
+ * built-in transports' settings (`transports.ses`, `transports.smtp`) and are
+ * still accepted on `PUT /api/email-settings` as aliases.
+ *
+ * @stability experimental
+ */
+exports.LEGACY_EMAIL_FLAT_FIELDS = [
+    'sesRegion',
+    'sesAccessKeyId',
+    'smtpHost',
+    'smtpPort',
+    'smtpUseTls',
+    'smtpUsername',
+];
+/**
+ * Where each legacy flat field lives now: the built-in transport that owns it
+ * and the name of the setting inside `transports.<id>`.
+ *
+ * @stability experimental
+ */
+exports.LEGACY_EMAIL_FLAT_FIELD_TARGETS = {
+    sesRegion: { transport: 'ses', setting: 'region' },
+    sesAccessKeyId: { transport: 'ses', setting: 'accessKeyId' },
+    smtpHost: { transport: 'smtp', setting: 'host' },
+    smtpPort: { transport: 'smtp', setting: 'port' },
+    smtpUseTls: { transport: 'smtp', setting: 'useTls' },
+    smtpUsername: { transport: 'smtp', setting: 'username' },
+};
+/**
+ * Default SMTP submission port when the admin has not chosen one (RFC 6409).
+ *
+ * @stability stable
+ */
+exports.DEFAULT_SMTP_PORT = 587;
+/**
+ * The port on which SMTP speaks TLS from the first byte (implicit TLS), rather
+ * than upgrading with STARTTLS.
+ *
+ * @stability stable
+ */
+exports.IMPLICIT_TLS_SMTP_PORT = 465;
+//# sourceMappingURL=constants.js.map

package/dist/cjs/email/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/email/constants.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,+FAA+F;AAC/F,gFAAgF;AAChF,EAAE;AACF,6EAA6E;AAC7E,4EAA4E;AAC5E,+CAA+C;AAC/C,gFAAgF;;;AAEhF;;;;;;;;GAQG;AACU,QAAA,0BAA0B,GAAG,wBAAwB,CAAC;AAEnE;;;;;;;GAOG;AACU,QAAA,4BAA4B,GAAG,CAAC,KAAK,EAAE,MAAM,CAAU,CAAC;AAErE;;;;;;GAMG;AACU,QAAA,oBAAoB,GAAG,oCAA4B,CAAC;AAkBjE;;;;;;;GAOG;AACU,QAAA,wBAAwB,GAAG;IACtC,WAAW;IACX,gBAAgB;IAChB,UAAU;IACV,UAAU;IACV,YAAY;IACZ,cAAc;CACN,CAAC;AAcX;;;;;GAKG;AACU,QAAA,+BAA+B,GAAwF;IAClI,SAAS,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE;IAClD,cAAc,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE;IAC5D,QAAQ,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE;IAChD,QAAQ,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE;IAChD,UAAU,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE;IACpD,YAAY,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE;CACzD,CAAC;AAEF;;;;GAIG;AACU,QAAA,iBAAiB,GAAG,GAAG,CAAC;AAErC;;;;;GAKG;AACU,QAAA,sBAAsB,GAAG,GAAG,CAAC"}

package/dist/cjs/email/index.d.ts

@@ -0,0 +1,5 @@
+export { BUILTIN_EMAIL_PROVIDER_KINDS, DEFAULT_SMTP_PORT, EMAIL_PROVIDER_KINDS, EMAIL_TRANSPORT_ID_PATTERN, IMPLICIT_TLS_SMTP_PORT, LEGACY_EMAIL_FLAT_FIELDS, LEGACY_EMAIL_FLAT_FIELD_TARGETS, } from './constants.js';
+export type { BuiltinEmailProviderKind, EmailProviderKind, LegacyEmailFieldTarget } from './constants.js';
+export { DEFAULT_EMAIL_SETTINGS, EMAIL_SETTINGS_CARRIES_NO_SECRET, EMAIL_SETTINGS_RESPONSE_CARRIES_NO_SECRET, credentialStatusSchema, emailSettingsResponseSchema, emailSettingsSchema, emailTransportIdSchema, emailTransportSettingsSchema, emailTransportsPatchSchema, emailTransportsSchema, testEmailResultSchema, updateEmailSettingsSchema, } from './schemas.js';
+export type { EmailCredentialStatusDto, EmailProviderKindEnum, EmailSecretFieldName, EmailSettings, EmailSettingsCarriesNoSecret, EmailSettingsResponse, EmailSettingsResponseCarriesNoSecret, TestEmailResult, UpdateEmailSettingsInput, } from './schemas.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/email/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/email/index.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,4BAA4B,EAC5B,iBAAiB,EACjB,oBAAoB,EACpB,0BAA0B,EAC1B,sBAAsB,EACtB,wBAAwB,EACxB,+BAA+B,GAChC,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAC1G,OAAO,EACL,sBAAsB,EACtB,gCAAgC,EAChC,yCAAyC,EACzC,sBAAsB,EACtB,2BAA2B,EAC3B,mBAAmB,EACnB,sBAAsB,EACtB,4BAA4B,EAC5B,0BAA0B,EAC1B,qBAAqB,EACrB,qBAAqB,EACrB,yBAAyB,GAC1B,MAAM,cAAc,CAAC;AACtB,YAAY,EACV,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,aAAa,EACb,4BAA4B,EAC5B,qBAAqB,EACrB,oCAAoC,EACpC,eAAe,EACf,wBAAwB,GACzB,MAAM,cAAc,CAAC"}

package/dist/cjs/email/index.js

@@ -0,0 +1,30 @@
+"use strict";
+// `@marinoscar/platform-contract/email`: the wire contract of the email
+// slice's admin routes (issue #737, PP-8.4): the stored settings, the PUT
+// body, the GET/PUT response, the test-send result and the built-in transport
+// list (the transport itself is an open id, PP-14.8). constants.ts is zod-free. Documented in ./README.md. Explicit named
+// exports only.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateEmailSettingsSchema = exports.testEmailResultSchema = exports.emailTransportsSchema = exports.emailTransportsPatchSchema = exports.emailTransportSettingsSchema = exports.emailTransportIdSchema = exports.emailSettingsSchema = exports.emailSettingsResponseSchema = exports.credentialStatusSchema = exports.EMAIL_SETTINGS_RESPONSE_CARRIES_NO_SECRET = exports.EMAIL_SETTINGS_CARRIES_NO_SECRET = exports.DEFAULT_EMAIL_SETTINGS = exports.LEGACY_EMAIL_FLAT_FIELD_TARGETS = exports.LEGACY_EMAIL_FLAT_FIELDS = exports.IMPLICIT_TLS_SMTP_PORT = exports.EMAIL_TRANSPORT_ID_PATTERN = exports.EMAIL_PROVIDER_KINDS = exports.DEFAULT_SMTP_PORT = exports.BUILTIN_EMAIL_PROVIDER_KINDS = void 0;
+var constants_js_1 = require("./constants.js");
+Object.defineProperty(exports, "BUILTIN_EMAIL_PROVIDER_KINDS", { enumerable: true, get: function () { return constants_js_1.BUILTIN_EMAIL_PROVIDER_KINDS; } });
+Object.defineProperty(exports, "DEFAULT_SMTP_PORT", { enumerable: true, get: function () { return constants_js_1.DEFAULT_SMTP_PORT; } });
+Object.defineProperty(exports, "EMAIL_PROVIDER_KINDS", { enumerable: true, get: function () { return constants_js_1.EMAIL_PROVIDER_KINDS; } });
+Object.defineProperty(exports, "EMAIL_TRANSPORT_ID_PATTERN", { enumerable: true, get: function () { return constants_js_1.EMAIL_TRANSPORT_ID_PATTERN; } });
+Object.defineProperty(exports, "IMPLICIT_TLS_SMTP_PORT", { enumerable: true, get: function () { return constants_js_1.IMPLICIT_TLS_SMTP_PORT; } });
+Object.defineProperty(exports, "LEGACY_EMAIL_FLAT_FIELDS", { enumerable: true, get: function () { return constants_js_1.LEGACY_EMAIL_FLAT_FIELDS; } });
+Object.defineProperty(exports, "LEGACY_EMAIL_FLAT_FIELD_TARGETS", { enumerable: true, get: function () { return constants_js_1.LEGACY_EMAIL_FLAT_FIELD_TARGETS; } });
+var schemas_js_1 = require("./schemas.js");
+Object.defineProperty(exports, "DEFAULT_EMAIL_SETTINGS", { enumerable: true, get: function () { return schemas_js_1.DEFAULT_EMAIL_SETTINGS; } });
+Object.defineProperty(exports, "EMAIL_SETTINGS_CARRIES_NO_SECRET", { enumerable: true, get: function () { return schemas_js_1.EMAIL_SETTINGS_CARRIES_NO_SECRET; } });
+Object.defineProperty(exports, "EMAIL_SETTINGS_RESPONSE_CARRIES_NO_SECRET", { enumerable: true, get: function () { return schemas_js_1.EMAIL_SETTINGS_RESPONSE_CARRIES_NO_SECRET; } });
+Object.defineProperty(exports, "credentialStatusSchema", { enumerable: true, get: function () { return schemas_js_1.credentialStatusSchema; } });
+Object.defineProperty(exports, "emailSettingsResponseSchema", { enumerable: true, get: function () { return schemas_js_1.emailSettingsResponseSchema; } });
+Object.defineProperty(exports, "emailSettingsSchema", { enumerable: true, get: function () { return schemas_js_1.emailSettingsSchema; } });
+Object.defineProperty(exports, "emailTransportIdSchema", { enumerable: true, get: function () { return schemas_js_1.emailTransportIdSchema; } });
+Object.defineProperty(exports, "emailTransportSettingsSchema", { enumerable: true, get: function () { return schemas_js_1.emailTransportSettingsSchema; } });
+Object.defineProperty(exports, "emailTransportsPatchSchema", { enumerable: true, get: function () { return schemas_js_1.emailTransportsPatchSchema; } });
+Object.defineProperty(exports, "emailTransportsSchema", { enumerable: true, get: function () { return schemas_js_1.emailTransportsSchema; } });
+Object.defineProperty(exports, "testEmailResultSchema", { enumerable: true, get: function () { return schemas_js_1.testEmailResultSchema; } });
+Object.defineProperty(exports, "updateEmailSettingsSchema", { enumerable: true, get: function () { return schemas_js_1.updateEmailSettingsSchema; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/email/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/email/index.ts"],"names":[],"mappings":";AAAA,wEAAwE;AACxE,0EAA0E;AAC1E,8EAA8E;AAC9E,0HAA0H;AAC1H,gBAAgB;;;AAEhB,+CAQwB;AAPtB,4HAAA,4BAA4B,OAAA;AAC5B,iHAAA,iBAAiB,OAAA;AACjB,oHAAA,oBAAoB,OAAA;AACpB,0HAAA,0BAA0B,OAAA;AAC1B,sHAAA,sBAAsB,OAAA;AACtB,wHAAA,wBAAwB,OAAA;AACxB,+HAAA,+BAA+B,OAAA;AAGjC,2CAasB;AAZpB,oHAAA,sBAAsB,OAAA;AACtB,8HAAA,gCAAgC,OAAA;AAChC,uIAAA,yCAAyC,OAAA;AACzC,oHAAA,sBAAsB,OAAA;AACtB,yHAAA,2BAA2B,OAAA;AAC3B,iHAAA,mBAAmB,OAAA;AACnB,oHAAA,sBAAsB,OAAA;AACtB,0HAAA,4BAA4B,OAAA;AAC5B,wHAAA,0BAA0B,OAAA;AAC1B,mHAAA,qBAAqB,OAAA;AACrB,mHAAA,qBAAqB,OAAA;AACrB,uHAAA,yBAAyB,OAAA"}

package/dist/cjs/email/schemas.d.ts

@@ -0,0 +1,276 @@
+import { z } from 'zod';
+import type { BuiltinEmailProviderKind } from './constants.js';
+/**
+ * The entries of the former transport enum: each built-in kind keyed by itself.
+ *
+ * @deprecated The transport is an open id now ({@link emailTransportIdSchema}).
+ * @stability stable
+ */
+export type EmailProviderKindEnum = {
+    [K in BuiltinEmailProviderKind]: K;
+};
+/**
+ * An email transport id: any string matching {@link EMAIL_TRANSPORT_ID_PATTERN}.
+ * Not an enum: an app registers transports (`registerEmailTransport`), and the
+ * API validates the id against the registry.
+ *
+ * @extensionPoint option
+ * @stability experimental
+ */
+export declare const emailTransportIdSchema: z.ZodString;
+/**
+ * One transport's non-secret settings as stored: whatever that transport's
+ * `settingsSchema` declares. The contract cannot see the registry, so it
+ * checks the shape (a record) and the API validates each entry with the
+ * transport that owns it.
+ *
+ * @stability experimental
+ */
+export declare const emailTransportSettingsSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+/**
+ * The `transports` record: transport id to that transport's settings.
+ *
+ * @stability experimental
+ */
+export declare const emailTransportsSchema: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+/**
+ * The `transports` record of a PUT: `null` removes a transport's stored
+ * settings (back to its defaults), an object is merged over them.
+ *
+ * @stability experimental
+ */
+export declare const emailTransportsPatchSchema: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+/**
+ * The admin-configurable half of email delivery: which transport, where it
+ * lives, who the mail claims to be from. Ordinary configuration, safe to
+ * return from an admin endpoint; stored in the `email` row of
+ * `system_settings`.
+ *
+ * @stability stable
+ */
+export declare const emailSettingsSchema: z.ZodObject<{
+    provider: z.ZodNullable<z.ZodString>;
+    enabled: z.ZodBoolean;
+    transports: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    sesRegion: z.ZodOptional<z.ZodString>;
+    sesAccessKeyId: z.ZodOptional<z.ZodString>;
+    smtpHost: z.ZodOptional<z.ZodString>;
+    smtpPort: z.ZodOptional<z.ZodNumber>;
+    smtpUseTls: z.ZodOptional<z.ZodBoolean>;
+    smtpUsername: z.ZodOptional<z.ZodString>;
+    fromAddress: z.ZodOptional<z.ZodEmail>;
+    fromName: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Validated email settings.
+ *
+ * @stability stable
+ */
+export type EmailSettings = z.infer<typeof emailSettingsSchema>;
+/**
+ * What a system with no email configuration reads as: no transport, switched
+ * off.
+ *
+ * @stability stable
+ */
+export declare const DEFAULT_EMAIL_SETTINGS: EmailSettings;
+/**
+ * What the admin page knows about a stored secret (the SMTP password, the SES
+ * secret access key) without being told the secret: whether it is set, the
+ * store's mask, and when and by whom it was last written.
+ *
+ * @stability stable
+ */
+export declare const credentialStatusSchema: z.ZodObject<{
+    configured: z.ZodBoolean;
+    hint: z.ZodNullable<z.ZodString>;
+    updatedAt: z.ZodNullable<z.ZodISODateTime>;
+    updatedByUserId: z.ZodNullable<z.ZodUUID>;
+}, z.core.$strip>;
+/**
+ * The masked status of one stored secret.
+ *
+ * @stability stable
+ */
+export type EmailCredentialStatusDto = z.infer<typeof credentialStatusSchema>;
+/**
+ * The `GET` and `PUT /api/email-settings` response body (inside the global
+ * `{ data }` envelope): the settings, a descriptor per registered transport,
+ * the masked status of every transport secret, why
+ * the stored row could not be read (field paths only; the read degrades to
+ * the defaults instead of failing, so the page that repairs the row still
+ * renders), and the row's version for `If-Match`.
+ *
+ * @stability stable
+ */
+export declare const emailSettingsResponseSchema: z.ZodObject<{
+    provider: z.ZodNullable<z.ZodString>;
+    enabled: z.ZodBoolean;
+    sesRegion: z.ZodOptional<z.ZodString>;
+    sesAccessKeyId: z.ZodOptional<z.ZodString>;
+    smtpHost: z.ZodOptional<z.ZodString>;
+    smtpPort: z.ZodOptional<z.ZodNumber>;
+    smtpUseTls: z.ZodOptional<z.ZodBoolean>;
+    smtpUsername: z.ZodOptional<z.ZodString>;
+    fromAddress: z.ZodOptional<z.ZodEmail>;
+    fromName: z.ZodOptional<z.ZodString>;
+    transports: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    descriptors: z.ZodArray<z.ZodObject<{
+        kind: z.ZodString;
+        id: z.ZodString;
+        label: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        fields: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"boolean">;
+            name: z.ZodString;
+            label: z.ZodString;
+            help: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"enum">;
+            options: z.ZodArray<z.ZodString>;
+            name: z.ZodString;
+            label: z.ZodString;
+            help: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"number">;
+            min: z.ZodOptional<z.ZodNumber>;
+            max: z.ZodOptional<z.ZodNumber>;
+            integer: z.ZodOptional<z.ZodBoolean>;
+            name: z.ZodString;
+            label: z.ZodString;
+            help: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"string">;
+            maxLength: z.ZodOptional<z.ZodNumber>;
+            name: z.ZodString;
+            label: z.ZodString;
+            help: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"other">;
+            name: z.ZodString;
+            label: z.ZodString;
+            help: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"secret">;
+            hasValue: z.ZodBoolean;
+            required: z.ZodBoolean;
+            name: z.ZodString;
+            label: z.ZodString;
+            help: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>], "kind">>;
+    }, z.core.$strip>>;
+    secretStatuses: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodObject<{
+        configured: z.ZodBoolean;
+        hint: z.ZodNullable<z.ZodString>;
+        updatedAt: z.ZodNullable<z.ZodISODateTime>;
+        updatedByUserId: z.ZodNullable<z.ZodUUID>;
+    }, z.core.$strip>>>;
+    smtpPasswordStatus: z.ZodObject<{
+        configured: z.ZodBoolean;
+        hint: z.ZodNullable<z.ZodString>;
+        updatedAt: z.ZodNullable<z.ZodISODateTime>;
+        updatedByUserId: z.ZodNullable<z.ZodUUID>;
+    }, z.core.$strip>;
+    sesSecretAccessKeyStatus: z.ZodObject<{
+        configured: z.ZodBoolean;
+        hint: z.ZodNullable<z.ZodString>;
+        updatedAt: z.ZodNullable<z.ZodISODateTime>;
+        updatedByUserId: z.ZodNullable<z.ZodUUID>;
+    }, z.core.$strip>;
+    settingsError: z.ZodNullable<z.ZodString>;
+    version: z.ZodNumber;
+    updatedAt: z.ZodNullable<z.ZodISODateTime>;
+    updatedBy: z.ZodNullable<z.ZodObject<{
+        id: z.ZodUUID;
+        email: z.ZodEmail;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * The GET/PUT response body, as sent.
+ *
+ * @stability stable
+ */
+export type EmailSettingsResponse = z.infer<typeof emailSettingsResponseSchema>;
+/**
+ * The `PUT /api/email-settings` body: every settings field (blankable), the
+ * `transports` patch, plus the WRITE-ONLY secrets (`secrets`, and the two
+ * legacy aliases). A blank secret (absent, `null` or `''`)
+ * preserves the stored one; erasing a stored secret is not expressible here.
+ *
+ * @stability stable
+ */
+export declare const updateEmailSettingsSchema: z.ZodObject<{
+    provider: z.ZodNullable<z.ZodString>;
+    enabled: z.ZodBoolean;
+    transports: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>>;
+    sesRegion: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodNull]>, z.ZodOptional<z.ZodString>]>;
+    sesAccessKeyId: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodNull]>, z.ZodOptional<z.ZodString>]>;
+    smtpHost: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodNull]>, z.ZodOptional<z.ZodString>]>;
+    smtpPort: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodNull]>, z.ZodOptional<z.ZodNumber>]>;
+    smtpUseTls: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodNull]>, z.ZodOptional<z.ZodBoolean>]>;
+    smtpUsername: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodNull]>, z.ZodOptional<z.ZodString>]>;
+    fromAddress: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodNull]>, z.ZodOptional<z.ZodEmail>]>;
+    fromName: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodNull]>, z.ZodOptional<z.ZodString>]>;
+    smtpPassword: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    sesSecretAccessKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    secrets: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodNullable<z.ZodString>>>>>;
+}, z.core.$strip>;
+/**
+ * The parsed PUT body, secrets included.
+ *
+ * @stability stable
+ */
+export type UpdateEmailSettingsInput = z.infer<typeof updateEmailSettingsSchema>;
+/**
+ * The `POST /api/email-settings/test` response body. HTTP 200 even when the
+ * send failed: read `success`, and show `error`, the provider's own message
+ * (already redacted of every credential and length-capped by the API).
+ *
+ * @stability stable
+ */
+export declare const testEmailResultSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    sentTo: z.ZodEmail;
+    providerKind: z.ZodNullable<z.ZodString>;
+    messageId: z.ZodNullable<z.ZodString>;
+    error: z.ZodNullable<z.ZodString>;
+    attemptedAt: z.ZodISODateTime;
+}, z.core.$strip>;
+/**
+ * The POST /test response body.
+ *
+ * @stability stable
+ */
+export type TestEmailResult = z.infer<typeof testEmailResultSchema>;
+/**
+ * The field names no email settings shape may declare (the compile-time
+ * proofs below check against them).
+ *
+ * @stability stable
+ */
+export type EmailSecretFieldName = 'smtpPassword' | 'password' | 'secret' | 'apiKey' | 'accessKeyId' | 'secretAccessKey' | 'ciphertext';
+/**
+ * `true` while {@link EmailSettings} has no secret-named field; `never` otherwise.
+ *
+ * @stability stable
+ */
+export type EmailSettingsCarriesNoSecret = Extract<keyof EmailSettings, EmailSecretFieldName> extends never ? true : never;
+/**
+ * The proof that {@link EmailSettings} carries no secret (fails to compile otherwise).
+ *
+ * @stability stable
+ */
+export declare const EMAIL_SETTINGS_CARRIES_NO_SECRET: EmailSettingsCarriesNoSecret;
+/**
+ * `true` while {@link EmailSettingsResponse} has no secret-named field; `never` otherwise.
+ *
+ * @stability stable
+ */
+export type EmailSettingsResponseCarriesNoSecret = Extract<keyof EmailSettingsResponse, EmailSecretFieldName> extends never ? true : never;
+/**
+ * The proof that {@link EmailSettingsResponse} carries no secret (fails to compile otherwise).
+ *
+ * @stability stable
+ */
+export declare const EMAIL_SETTINGS_RESPONSE_CARRIES_NO_SECRET: EmailSettingsResponseCarriesNoSecret;
+//# sourceMappingURL=schemas.d.ts.map

package/dist/cjs/email/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../src/email/schemas.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAE/D;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG;KAAG,CAAC,IAAI,wBAAwB,GAAG,CAAC;CAAE,CAAC;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,aAA+C,CAAC;AAEnF;;;;;;;GAOG;AACH,eAAO,MAAM,4BAA4B,wCAAoC,CAAC;AAE9E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,kEAAiE,CAAC;AAEpG;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,iFAA4E,CAAC;AAKpH;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;iBA6D9B,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,EAAE,aAGpC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;;iBASjC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAE9E;;;;;;;;;GASG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmCtC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAqBhF;;;;;;;GAOG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;iBAkCpC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAEjF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;;;;;;;iBAahC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAYpE;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAC5B,cAAc,GACd,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,aAAa,GACb,iBAAiB,GACjB,YAAY,CAAC;AAEjB;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,OAAO,CAAC,MAAM,aAAa,EAAE,oBAAoB,CAAC,SAAS,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC;AAE3H;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,EAAE,4BAAmC,CAAC;AAEnF;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,GAC9C,OAAO,CAAC,MAAM,qBAAqB,EAAE,oBAAoB,CAAC,SAAS,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC;AAE1F;;;;GAIG;AACH,eAAO,MAAM,yCAAyC,EAAE,oCAA2C,CAAC"}