@wtfalch/foundry 0.56.0 → 0.57.0

package/dist/plan/executor.d.ts

@@ -2022,7 +2022,7 @@ export declare class FoundryStepExecutor implements StepExecutor, StepDestroyer
     /** Whether the held keys can store a new company's sign-in database CA and certificate (#746). */
     ownSigninDbKeysPuttable(): boolean;
     /**
-     * Whether the host says its company ZITADEL port has `ensureEmailOtpMessageText` and `ensureLabelPolicy`
+     * Whether the host says its company ZITADEL port has `ensureEmailOtpMessageText`, `ensureLabelPolicy` and `ensureEmailOtpGenerator`
      * (`provision.auth.signinMailWritable`). The port is a lazy proxy that answers any name, so it cannot be probed.
      */
     ownSigninMailWritable(): boolean;

package/dist/plan/executor.js

@@ -1014,7 +1014,7 @@ export class FoundryStepExecutor {
         return Boolean(this.ports.ownServices?.provision.auth.heldKeys?.put);
     }
     /**
-     * Whether the host says its company ZITADEL port has `ensureEmailOtpMessageText` and `ensureLabelPolicy`
+     * Whether the host says its company ZITADEL port has `ensureEmailOtpMessageText`, `ensureLabelPolicy` and `ensureEmailOtpGenerator`
      * (`provision.auth.signinMailWritable`). The port is a lazy proxy that answers any name, so it cannot be probed.
      */
     ownSigninMailWritable() {

package/dist/plan/platform-providers.js

@@ -2551,11 +2551,12 @@ export async function provisionAuthStack(scope, deps, target, input) {
             throw new Error(`${label}: could not configure ZITADEL's SMTP provider for ${hostname}: ${cause}`);
         }
         // A company's own sign-in: its name and design in the code mail. Idempotent; the marker is
-        // recorded after both writes, so a failure halfway is repeated.
+        // recorded after all three writes, so a failure halfway is repeated.
         if (input.mailBranding &&
             (deps.signinMailWritable !== true ||
                 typeof mailZitadel.ensureEmailOtpMessageText !== 'function' ||
-                typeof mailZitadel.ensureLabelPolicy !== 'function')) {
+                typeof mailZitadel.ensureLabelPolicy !== 'function' ||
+                typeof mailZitadel.ensureEmailOtpGenerator !== 'function')) {
             console.info(`${label}: the host cannot write message texts, so the sign-in mail keeps ZITADEL's default text`);
         }
         else if (input.mailBranding) {

package/dist/plan/signin-mail.d.ts

@@ -2,17 +2,23 @@
  * The sign-in code mail of a company that runs its own sign-in: the company's name in the sender and
  * the text, the platform's design tokens for the look. ZITADEL's email-code message is built from the
  * instance's custom text and label policy; both are written through `PlatformZitadelMailBranding`
- * (`@wtfalch/providers` 0.13.0), each only when it differs.
+ * (`@wtfalch/providers` 0.14.0), each only when it differs. The code itself (six digits, five minutes)
+ * is the instance's email-OTP generator.
  *
  * The look: no company declares a design foundry can read (an `OrgTheme` lives in cms and reaches
  * Agora, Boule and the site as data), so every company gets the login's house colours
  * (`SIGNIN_MAIL_LABEL_POLICY`). No logo: ZITADEL takes it as a multipart upload the client does not make.
  */
 /** Raise it when the text or the look changes, so an applied company plans its sign-in step again. */
-export declare const AUTH_SIGNIN_MAIL_VERSION = "1";
+export declare const AUTH_SIGNIN_MAIL_VERSION = "2";
 /** `signinMailMarker` of the company name and version last written, recorded after both writes. */
 export declare const PLATFORM_AUTH_SIGNIN_MAIL_SCOPE_KEY = "auth_signin_mail_applied";
-/** The two ZITADEL calls the sign-in mail needs. `@wtfalch/providers` 0.13.0's `ZitadelClient` has both. */
+/** The code the mail carries: six digits, valid five minutes (`123-456` in the mail, see `signinMailText`). */
+export declare const SIGNIN_MAIL_CODE: {
+    readonly length: 6;
+    readonly expirySeconds: 300;
+};
+/** The three ZITADEL calls the sign-in mail needs. `@wtfalch/providers` 0.14.0's `ZitadelClient` has all. */
 export interface PlatformZitadelMailBranding {
     ensureEmailOtpMessageText(language: string, text: {
         title: string;
@@ -38,6 +44,12 @@ export interface PlatformZitadelMailBranding {
     }): Promise<{
         changed: boolean;
     }>;
+    ensureEmailOtpGenerator(generator: {
+        length: number;
+        expirySeconds: number;
+    }): Promise<{
+        changed: boolean;
+    }>;
 }
 /** What the marker holds: the version and the company name, so a rename writes the mail again. */
 export declare function signinMailMarker(companyName: string): string;
@@ -49,7 +61,9 @@ export declare function signinMailName(companyName: string): string;
 export declare const SIGNIN_MAIL_LANGUAGE = "en";
 /**
  * English text. `{{.OTP}}` is the code variable of this message (ZITADEL's `otp.go` sets it; the link
- * behind the button carries the code as `{{.Code}}` from the login's `urlTemplate`). No greeting by
+ * behind the button carries the code as `{{.Code}}` from the login's `urlTemplate`). The greeting
+ * holds the code, split in the middle with Go's `slice` (`123-456`), because ZITADEL renders the
+ * greeting as the large heading, so the code is the first thing the reader sees. No greeting by
  * name: the login fills names from the email address, so it would read "Wtfalch Wtfalch".
  */
 export declare function signinMailText(companyName: string): {
@@ -77,7 +91,7 @@ export declare const SIGNIN_MAIL_LABEL_POLICY: {
     readonly warnColorDark: "#FF9C8C";
     readonly disableWatermark: true;
 };
-/** Writes the text and the look, each only when it differs. Throws the client's fixed-text error. */
+/** Writes the text, the look and the code, each only when it differs. Throws the client's fixed-text error. */
 export declare function applySigninMail(zitadel: PlatformZitadelMailBranding, companyName: string): Promise<{
     changed: boolean;
 }>;

package/dist/plan/signin-mail.js

@@ -2,16 +2,19 @@
  * The sign-in code mail of a company that runs its own sign-in: the company's name in the sender and
  * the text, the platform's design tokens for the look. ZITADEL's email-code message is built from the
  * instance's custom text and label policy; both are written through `PlatformZitadelMailBranding`
- * (`@wtfalch/providers` 0.13.0), each only when it differs.
+ * (`@wtfalch/providers` 0.14.0), each only when it differs. The code itself (six digits, five minutes)
+ * is the instance's email-OTP generator.
  *
  * The look: no company declares a design foundry can read (an `OrgTheme` lives in cms and reaches
  * Agora, Boule and the site as data), so every company gets the login's house colours
  * (`SIGNIN_MAIL_LABEL_POLICY`). No logo: ZITADEL takes it as a multipart upload the client does not make.
  */
 /** Raise it when the text or the look changes, so an applied company plans its sign-in step again. */
-export const AUTH_SIGNIN_MAIL_VERSION = '1';
+export const AUTH_SIGNIN_MAIL_VERSION = '2';
 /** `signinMailMarker` of the company name and version last written, recorded after both writes. */
 export const PLATFORM_AUTH_SIGNIN_MAIL_SCOPE_KEY = 'auth_signin_mail_applied';
+/** The code the mail carries: six digits, valid five minutes (`123-456` in the mail, see `signinMailText`). */
+export const SIGNIN_MAIL_CODE = { length: 6, expirySeconds: 300 };
 /** What the marker holds: the version and the company name, so a rename writes the mail again. */
 export function signinMailMarker(companyName) {
     return `${AUTH_SIGNIN_MAIL_VERSION}:${signinMailName(companyName)}`;
@@ -30,7 +33,9 @@ export function signinMailName(companyName) {
 export const SIGNIN_MAIL_LANGUAGE = 'en';
 /**
  * English text. `{{.OTP}}` is the code variable of this message (ZITADEL's `otp.go` sets it; the link
- * behind the button carries the code as `{{.Code}}` from the login's `urlTemplate`). No greeting by
+ * behind the button carries the code as `{{.Code}}` from the login's `urlTemplate`). The greeting
+ * holds the code, split in the middle with Go's `slice` (`123-456`), because ZITADEL renders the
+ * greeting as the large heading, so the code is the first thing the reader sees. No greeting by
  * name: the login fills names from the email address, so it would read "Wtfalch Wtfalch".
  */
 export function signinMailText(companyName) {
@@ -39,8 +44,8 @@ export function signinMailText(companyName) {
         title: 'Your sign-in code',
         preHeader: `Your ${name} sign-in code`,
         subject: `Your ${name} sign-in code`,
-        greeting: 'Hello,',
-        text: 'Your code is {{.OTP}}. It works for five minutes. Or use the button to sign in on this device.',
+        greeting: '{{slice .OTP 0 3}}-{{slice .OTP 3}}',
+        text: 'Enter this code to sign in. It works for five minutes. Or use the button to sign in on this device.',
         buttonText: 'Sign in',
         footerText: name,
     };
@@ -61,9 +66,10 @@ export const SIGNIN_MAIL_LABEL_POLICY = {
     warnColorDark: '#FF9C8C',
     disableWatermark: true,
 };
-/** Writes the text and the look, each only when it differs. Throws the client's fixed-text error. */
+/** Writes the text, the look and the code, each only when it differs. Throws the client's fixed-text error. */
 export async function applySigninMail(zitadel, companyName) {
     const text = await zitadel.ensureEmailOtpMessageText(SIGNIN_MAIL_LANGUAGE, signinMailText(companyName));
     const look = await zitadel.ensureLabelPolicy({ ...SIGNIN_MAIL_LABEL_POLICY });
-    return { changed: text.changed || look.changed };
+    const code = await zitadel.ensureEmailOtpGenerator({ ...SIGNIN_MAIL_CODE });
+    return { changed: text.changed || look.changed || code.changed };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wtfalch/foundry",
-  "version": "0.56.0",
+  "version": "0.57.0",
   "description": "Foundry's SDK: the declared org's types, the plan and apply contracts, and the state store's interface.",
   "repository": {
     "type": "git",