@marinoscar/platform-contract 0.0.0-stage → 0.1.0-next.4

package/dist/esm/doctor/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../src/doctor/schemas.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGnD;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;KAAG,CAAC,IAAI,YAAY,GAAG,CAAC;CAAE,CAAC;AAE1D;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG;KAAG,CAAC,IAAI,MAAM,GAAG,OAAO,GAAG,CAAC;CAAE,CAAC;AAErE;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAMxD,CAAC;AAEJ;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;iBAqBlC,CAAC;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;iBAS7B,CAAC;AAKH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB;;;iBAU5B,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAkBD;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;6BAqB3C,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAE1F;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;iBAkB9B,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC"}

package/dist/esm/doctor/schemas.js

@@ -0,0 +1,180 @@
+// =============================================================================
+// The Doctor's wire shapes (issue #634; moved here from
+// `@marinoscar/platform-api/doctor` by #701)
+// =============================================================================
+//
+// ALWAYS A 200 FOR AN AUTHORIZED CALLER. A failing check is a row with
+// `status: 'fail'`, never an error status: the report is read precisely when
+// something is wrong, and a 500 or a 503 would withhold the list of what.
+//
+// Every nullable field is present on every row (`null` rather than absent), so
+// a client renders one shape without optional-chaining through it.
+//
+// ⚠ OpenAPI is generated from these schemas (nestjs-zod, through the DTOs of
+// `@marinoscar/platform-api/doctor`). Field order, `.describe()` texts and the
+// order of the status enum are part of the published document: change them
+// only as a deliberate API change.
+// =============================================================================
+import { z } from 'zod';
+import { SUPPORT_BUNDLE_REDACTION_RULES, SUPPORT_BUNDLE_VERSION } from './constants.js';
+/**
+ * A check's status on the wire.
+ *
+ * The enum lists the values in the order the OpenAPI document has always
+ * published (`pass, warn, fail, skip`), which is not the severity order of
+ * {@link DOCTOR_STATUSES}; rank statuses with {@link DOCTOR_STATUS_RANK}.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export const doctorStatusSchema = z
+    .enum(['pass', 'warn', 'fail', 'skip'])
+    .describe('`pass` — verified healthy. `warn` — works, but needs attention. `fail` — broken. ' +
+    '`skip` — not evaluated: a check it depends on did not pass, or the capability is ' +
+    'intentionally switched off.');
+/**
+ * One row of the report, as `GET /api/admin/doctor` returns it.
+ *
+ * Fields: `id` (stable dotted id, `storage.bucket`), `category` (`core`,
+ * `auth`, ...; an app may add its own), `label`, `settingsPath` (the web route
+ * that fixes it, or `null`), `status`, `detail` (one line: what was found),
+ * `remedy` (set on `warn` and `fail`, otherwise `null`), `error` (the
+ * underlying probe error, or `null`), `data` (small scalar facts, never secret
+ * material, or `null`) and `durationMs` (0 when skipped without running).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export const doctorCheckReportSchema = z.object({
+    /** Stable dotted id, e.g. `storage.bucket`. */
+    id: z.string(),
+    /** `core`, `auth`, `storage`, ... — a fork may add its own. */
+    category: z.string(),
+    /** Short human label: "Object storage bucket". */
+    label: z.string(),
+    /** The web route that fixes this check, when there is one. */
+    settingsPath: z.string().nullable(),
+    /** `pass`, `warn`, `fail` or `skip`. */
+    status: doctorStatusSchema,
+    /** One line: what was found. */
+    detail: z.string(),
+    /** What to do about a `warn` or `fail`. Always set on those two. */
+    remedy: z.string().nullable(),
+    /** The underlying error message, when a probe failed. */
+    error: z.string().nullable(),
+    /** Small scalar facts: counts, versions, latencies. Never secret material. */
+    data: z.record(z.string(), z.union([z.string(), z.number(), z.boolean(), z.null()])).nullable(),
+    /** How long this check took; 0 when it was skipped without running. */
+    durationMs: z.number().int(),
+});
+/**
+ * The whole report, as `GET /api/admin/doctor` returns it: `verdict` (the
+ * worst status in `checks`, `skip` when none ran), `generatedAt` (ISO 8601; a
+ * cached report keeps its original time), `durationMs` (wall time of the run)
+ * and `checks` (sorted by category, configured order first, then registration
+ * order).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export const doctorReportSchema = z.object({
+    /** The worst status in `checks` (`pass < skip < warn < fail`); `skip` when none ran. */
+    verdict: doctorStatusSchema,
+    /** When this report was produced. A cached report keeps its original time. */
+    generatedAt: z.iso.datetime(),
+    /** Wall time of the whole run. */
+    durationMs: z.number().int(),
+    /** Sorted by category (shipped order first), then registration order. */
+    checks: z.array(doctorCheckReportSchema),
+});
+// The query's `'true' | 'false'` parameter, typed through its named entries.
+const booleanStringSchema = z.enum(['true', 'false']);
+/**
+ * `GET /api/admin/doctor` query: `category` (a lowercase identifier; only the
+ * checks in that category, plus, unreported, whatever they depend on) and
+ * `refresh` (`'true'` bypasses the 15-second report cache).
+ *
+ * `refresh` is `z.enum(['true','false']).transform(...)` and NOT
+ * `z.coerce.boolean()`: every query parameter is a string and
+ * `Boolean('false')` is `true`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export const doctorQuerySchema = z.object({
+    /** Only the checks in this category (plus, unreported, whatever they depend on). */
+    category: z
+        .string()
+        .regex(/^[a-z0-9][a-z0-9_-]{0,63}$/, 'category must be a lowercase identifier')
+        .optional(),
+    /** `true` bypasses the 15-second report cache. */
+    refresh: booleanStringSchema
+        .transform((value) => value === 'true')
+        .optional(),
+});
+const statusEnumMatchesConstants = true;
+const queryInputMatchesSchema = true;
+void statusEnumMatchesConstants;
+void queryInputMatchesSchema;
+// -----------------------------------------------------------------------------
+// The support bundle (issue #772): the envelope `GET /api/admin/doctor/support-bundle`
+// returns. Each section's `data` is validated by that section's own strict
+// schema on the server (`@marinoscar/platform-api/doctor`), so here it stays
+// `unknown`.
+// -----------------------------------------------------------------------------
+/**
+ * One section of a bundle. `truncated: true` with `data: null` means the
+ * section was larger than its size cap and its data was dropped.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export const supportBundleSectionResultSchema = z.discriminatedUnion('status', [
+    z.object({
+        /** Collected. */
+        status: z.literal('ok'),
+        /** The section's data, validated by its strict schema and redacted; `null` when truncated. */
+        data: z.unknown().describe("The section's data, already validated by its strict schema and redacted."),
+        /** `true` when a size cap dropped the data. */
+        truncated: z.boolean().optional().describe('`true` when a size cap dropped the data (`data` is then `null`).'),
+    }),
+    z.object({
+        /** Not collected. */
+        status: z.literal('omitted'),
+        /** Why: a missing permission, a capability switched off. */
+        reason: z.string().describe('Why the section was not collected (a missing permission, a capability switched off).'),
+    }),
+    z.object({
+        /** Collected, but dropped. */
+        status: z.literal('error'),
+        /** One redacted line saying why. */
+        error: z.string().describe('One redacted line: a throw, a timeout or a schema violation. Never the raw value.'),
+    }),
+]);
+/**
+ * The support bundle: what `GET /api/admin/doctor/support-bundle` returns as a
+ * JSON attachment.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export const supportBundleSchema = z.object({
+    /** The bundle format version, {@link SUPPORT_BUNDLE_VERSION}. */
+    bundleVersion: z.literal(SUPPORT_BUNDLE_VERSION).describe('The bundle format version.'),
+    /** When the bundle was built (ISO 8601, UTC). */
+    generatedAt: z.string().describe('When the bundle was built (ISO 8601, UTC).'),
+    /** The central redaction pass. */
+    redaction: z
+        .object({
+        /** The rule set applied, {@link SUPPORT_BUNDLE_REDACTION_RULES}. */
+        rules: z.literal(SUPPORT_BUNDLE_REDACTION_RULES).describe('The redaction rule set applied.'),
+        /** How many values the pass replaced. */
+        replacements: z.number().int().describe('How many values the redaction pass replaced.'),
+    })
+        .describe('The central redaction pass, applied on top of every section schema.'),
+    /** One result per registered section, keyed by section id. */
+    sections: z
+        .record(z.string(), supportBundleSectionResultSchema)
+        .describe('One entry per registered section, keyed by section id.'),
+});
+//# sourceMappingURL=schemas.js.map

package/dist/esm/doctor/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/doctor/schemas.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,wDAAwD;AACxD,6CAA6C;AAC7C,gFAAgF;AAChF,EAAE;AACF,uEAAuE;AACvE,6EAA6E;AAC7E,0EAA0E;AAC1E,EAAE;AACF,+EAA+E;AAC/E,mEAAmE;AACnE,EAAE;AACF,6EAA6E;AAC7E,+EAA+E;AAC/E,2EAA2E;AAC3E,mCAAmC;AACnC,gFAAgF;AAEhF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAkBxF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAgC,CAAC;KAC7D,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;KACtC,QAAQ,CACP,mFAAmF;IACjF,mFAAmF;IACnF,6BAA6B,CAChC,CAAC;AAEJ;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,+CAA+C;IAC/C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,+DAA+D;IAC/D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,kDAAkD;IAClD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,8DAA8D;IAC9D,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,wCAAwC;IACxC,MAAM,EAAE,kBAAkB;IAC1B,gCAAgC;IAChC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,oEAAoE;IACpE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,yDAAyD;IACzD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,8EAA8E;IAC9E,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC/F,uEAAuE;IACvE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC7B,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,wFAAwF;IACxF,OAAO,EAAE,kBAAkB;IAC3B,8EAA8E;IAC9E,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IAC7B,kCAAkC;IAClC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC5B,yEAAyE;IACzE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC;CACzC,CAAC,CAAC;AAEH,6EAA6E;AAC7E,MAAM,mBAAmB,GAAuC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAE1F;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,oFAAoF;IACpF,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,KAAK,CAAC,4BAA4B,EAAE,yCAAyC,CAAC;SAC9E,QAAQ,EAAE;IACb,kDAAkD;IAClD,OAAO,EAAE,mBAAmB;SACzB,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,MAAM,CAAC;SACtC,QAAQ,EAAE;CACd,CAAC,CAAC;AAwCH,MAAM,0BAA0B,GAA2D,IAAI,CAAC;AAChG,MAAM,uBAAuB,GAA8C,IAAI,CAAC;AAChF,KAAK,0BAA0B,CAAC;AAChC,KAAK,uBAAuB,CAAC;AAE7B,gFAAgF;AAChF,uFAAuF;AACvF,2EAA2E;AAC3E,6EAA6E;AAC7E,aAAa;AACb,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE;IAC7E,CAAC,CAAC,MAAM,CAAC;QACP,iBAAiB;QACjB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;QACvB,8FAA8F;QAC9F,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,0EAA0E,CAAC;QACtG,+CAA+C;QAC/C,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kEAAkE,CAAC;KAC/G,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,qBAAqB;QACrB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;QAC5B,4DAA4D;QAC5D,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sFAAsF,CAAC;KACpH,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,8BAA8B;QAC9B,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QAC1B,oCAAoC;QACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mFAAmF,CAAC;KAChH,CAAC;CACH,CAAC,CAAC;AASH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,iEAAiE;IACjE,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IACvF,iDAAiD;IACjD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC;IAC9E,kCAAkC;IAClC,SAAS,EAAE,CAAC;SACT,MAAM,CAAC;QACN,oEAAoE;QACpE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAAC,CAAC,QAAQ,CAAC,iCAAiC,CAAC;QAC5F,yCAAyC;QACzC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,8CAA8C,CAAC;KACxF,CAAC;SACD,QAAQ,CAAC,qEAAqE,CAAC;IAClF,8DAA8D;IAC9D,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,gCAAgC,CAAC;SACpD,QAAQ,CAAC,wDAAwD,CAAC;CACtE,CAAC,CAAC"}

package/dist/esm/email/constants.d.ts

@@ -0,0 +1,82 @@
+/**
+ * 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
+ */
+export declare const EMAIL_TRANSPORT_ID_PATTERN: RegExp;
+/**
+ * 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
+ */
+export declare const BUILTIN_EMAIL_PROVIDER_KINDS: readonly ["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
+ */
+export declare const EMAIL_PROVIDER_KINDS: readonly ["ses", "smtp"];
+/**
+ * One of {@link BUILTIN_EMAIL_PROVIDER_KINDS}.
+ *
+ * @stability experimental
+ */
+export type BuiltinEmailProviderKind = (typeof BUILTIN_EMAIL_PROVIDER_KINDS)[number];
+/**
+ * A configured transport: the id of a registered email transport. A plain
+ * string since transports became pluggable; the built-ins are
+ * `BuiltinEmailProviderKind`.
+ *
+ * @stability stable
+ */
+export type EmailProviderKind = string;
+/**
+ * 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
+ */
+export declare const LEGACY_EMAIL_FLAT_FIELDS: readonly ["sesRegion", "sesAccessKeyId", "smtpHost", "smtpPort", "smtpUseTls", "smtpUsername"];
+/**
+ * Where one legacy flat field lives now.
+ *
+ * @stability experimental
+ */
+export interface LegacyEmailFieldTarget {
+    /** The built-in transport that owns the setting. */
+    transport: BuiltinEmailProviderKind;
+    /** The name of the setting inside `transports.<transport>`. */
+    setting: string;
+}
+/**
+ * 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
+ */
+export declare const LEGACY_EMAIL_FLAT_FIELD_TARGETS: Readonly<Record<(typeof LEGACY_EMAIL_FLAT_FIELDS)[number], LegacyEmailFieldTarget>>;
+/**
+ * Default SMTP submission port when the admin has not chosen one (RFC 6409).
+ *
+ * @stability stable
+ */
+export declare const DEFAULT_SMTP_PORT = 587;
+/**
+ * The port on which SMTP speaks TLS from the first byte (implicit TLS), rather
+ * than upgrading with STARTTLS.
+ *
+ * @stability stable
+ */
+export declare const IMPLICIT_TLS_SMTP_PORT = 465;
+//# sourceMappingURL=constants.d.ts.map

package/dist/esm/email/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/email/constants.ts"],"names":[],"mappings":"AASA;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B,QAA2B,CAAC;AAEnE;;;;;;;GAOG;AACH,eAAO,MAAM,4BAA4B,0BAA2B,CAAC;AAErE;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,0BAA+B,CAAC;AAEjE;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,CAAC,CAAC;AAErF;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,gGAO3B,CAAC;AAEX;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,oDAAoD;IACpD,SAAS,EAAE,wBAAwB,CAAC;IACpC,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,eAAO,MAAM,+BAA+B,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,CAAC,EAAE,sBAAsB,CAAC,CAO/H,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,MAAM,CAAC;AAErC;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,MAAM,CAAC"}

package/dist/esm/email/constants.js

@@ -0,0 +1,79 @@
+// =============================================================================
+// 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.
+// =============================================================================
+/**
+ * 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
+ */
+export const 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
+ */
+export const 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
+ */
+export const EMAIL_PROVIDER_KINDS = 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
+ */
+export const 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
+ */
+export const 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
+ */
+export const DEFAULT_SMTP_PORT = 587;
+/**
+ * The port on which SMTP speaks TLS from the first byte (implicit TLS), rather
+ * than upgrading with STARTTLS.
+ *
+ * @stability stable
+ */
+export const IMPLICIT_TLS_SMTP_PORT = 465;
+//# sourceMappingURL=constants.js.map

package/dist/esm/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;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,wBAAwB,CAAC;AAEnE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,KAAK,EAAE,MAAM,CAAU,CAAC;AAErE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,4BAA4B,CAAC;AAkBjE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,WAAW;IACX,gBAAgB;IAChB,UAAU;IACV,UAAU;IACV,YAAY;IACZ,cAAc;CACN,CAAC;AAcX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,+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;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAErC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC"}

package/dist/esm/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/esm/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/esm/email/index.js

@@ -0,0 +1,8 @@
+// `@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.
+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 { 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';
+//# sourceMappingURL=index.js.map

package/dist/esm/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,OAAO,EACL,4BAA4B,EAC5B,iBAAiB,EACjB,oBAAoB,EACpB,0BAA0B,EAC1B,sBAAsB,EACtB,wBAAwB,EACxB,+BAA+B,GAChC,MAAM,gBAAgB,CAAC;AAExB,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"}

package/dist/esm/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