@zitadel/config 0.1.0-alpha.16 → 0.1.0-alpha.18

package/defaults/branding/split/login.liquid

@@ -0,0 +1,178 @@
+<zl-page-shell data-zl-template-root>
+  <div class="zl-split">
+    <aside class="zl-split__brand">
+      {% if branding.logo_url %}
+        <img class="zl-split__logo" src="{{ branding.logo_url }}" alt="" />
+      {% endif %}
+      {% if branding.hero_url %}
+        <img class="zl-split__hero" src="{{ branding.hero_url }}" alt="" />
+      {% endif %}
+    </aside>
+    <section class="zl-split__form">
+    {% if branding.logo_url %}
+      <img class="zl-split__compact" src="{{ branding.logo_url }}" alt="" />
+    {% elsif branding.hero_url %}
+      <img class="zl-split__compact zl-split__compact--hero" src="{{ branding.hero_url }}" alt="" />
+    {% endif %}
+    <zl-card>
+      <h1 slot="header" class="zl-card-title">{{ step.texts.title_key | t: identity.display_name }}</h1>
+      {% if step.texts.description_key %}
+        {% assign card_subtitle = step.texts.description_key | t: identity.display_name %}
+        {% if card_subtitle != "" %}
+          <p slot="header" class="zl-card-subtitle">{{ card_subtitle }}</p>
+        {% endif %}
+      {% endif %}
+
+      {% if errors and errors.size > 0 %}
+        {% for err in errors %}
+          {% if err | formLevelError %}
+            {% assign alert_heading = err.text_key | alertHeading %}
+            {% assign alert_body = err.text_key | alertBody %}
+            <zl-alert severity="error" dismissible data-zl-step-error{% if alert_heading != "" %} heading="{{ alert_heading | t }}"{% endif %}>
+              {% if alert_body != "" %}{{ alert_body | t }}{% elsif err.text_key %}{{ err.text_key | t }}{% else %}{{ err.message }}{% endif %}
+            </zl-alert>
+          {% endif %}
+        {% endfor %}
+      {% endif %}
+
+      {% for f in fields %}
+        {% assign field_placeholder = f.text_key | fieldPlaceholder %}
+        {% assign field_help = f.text_key | fieldHelp %}
+        {% assign field_err = f.name | fieldError: errors %}
+        {% case f.type %}
+        {% when 'checkbox' %}
+          <zl-checkbox
+            name="{{ f.name }}"
+            data-testid="zitadel-field-{{ f.name | testid }}"
+            label="{{ f.text_key | t }}"
+            value="true"
+            {% if f.value %}checked{% endif %}
+            {% if field_err != "" %}invalid error="{{ field_err }}"{% endif %}
+          ></zl-checkbox>
+        {% when 'select' %}
+          <zl-select
+            name="{{ f.name }}"
+            data-testid="zitadel-field-{{ f.name | testid }}"
+            label="{{ f.text_key | t }}"
+            value="{{ f.value }}"
+            options='{{ f.validation.enum | selectOptions | json }}'
+            {% if f.required %}required{% endif %}
+            {% if field_placeholder != "" %}placeholder="{{ field_placeholder }}"{% endif %}
+          {% if field_err != "" %}invalid error="{{ field_err }}"{% endif %}
+          ></zl-select>
+        {% else %}
+          {% assign autocomplete_val = '' %}
+          {% if f.name == 'email' %}
+            {% assign autocomplete_val = 'email' %}
+          {% elsif f.type == 'password' and step.name contains 'register' %}
+            {% assign autocomplete_val = 'new-password' %}
+          {% elsif f.type == 'password' %}
+            {% assign autocomplete_val = 'current-password' %}
+          {% endif %}
+          <zl-field
+            name="{{ f.name }}"
+            data-testid="zitadel-field-{{ f.name | testid }}"
+            label="{{ f.text_key | t }}"
+            type="{{ f.type }}"
+            value="{{ f.value }}"
+            {% if autocomplete_val != '' %}autocomplete="{{ autocomplete_val }}"{% endif %}
+            {% if f.required %}required{% endif %}
+            {% if field_placeholder != "" %}placeholder="{{ field_placeholder }}"{% endif %}
+            {% if field_err != "" %}invalid error="{{ field_err }}"{% endif %}
+          >
+            {% if field_help != "" %}
+              <span slot="help">{{ field_help }}</span>
+            {% endif %}
+          </zl-field>
+        {% endcase %}
+      {% endfor %}
+
+      {% assign recover = actions | where: "name", "recover" | first %}
+      {% if recover %}
+        <p class="zl-card-forgot">
+          <a href="#" class="zl-card-forgot__link" data-action="recover">{{ recover.text_key | t }}</a>
+        </p>
+      {% endif %}
+
+      {% for a in actions %}
+        {% if a.primary %}
+          <zl-button
+            hierarchy="primary"
+            size="medium"
+            type="submit"
+            block
+            action="{{ a.name }}"
+            data-testid="zitadel-action-{{ a.name }}"
+            label="{{ a.text_key | t }}"
+            {% if loading %}loading{% endif %}
+          ></zl-button>
+        {% endif %}
+      {% endfor %}
+
+      {% for a in actions %}
+        {% unless a.primary or a.kind == 'back' or a.name == 'passkey' or a.name == 'register' or a.name == 'sign_in' or a.name == 'recover' %}
+          <zl-button
+            hierarchy="secondary"
+            size="medium"
+            type="button"
+            block
+            action="{{ a.name }}"
+            data-testid="zitadel-action-{{ a.name }}"
+            label="{{ a.text_key | t }}"
+          ></zl-button>
+        {% endunless %}
+      {% endfor %}
+
+      {% assign passkey = actions | where: "name", "passkey" | first %}
+      {% if passkey %}
+        {% unless passkey.primary %}
+          <zl-button
+            hierarchy="secondary"
+            size="medium"
+            block
+            action="passkey"
+            data-testid="zitadel-action-passkey"
+            label="{{ passkey.text_key | t }}"
+          ></zl-button>
+        {% endunless %}
+      {% endif %}
+
+
+      {% assign register = actions | where: "name", "register" | first %}
+      {% if register %}
+        <p class="zl-card-nav">
+          {{ 'identifier.action.register.lead' | t }}<a href="#" class="zl-card-nav__link" data-action="register" data-testid="zitadel-action-register-link">{{ 'identifier.action.register.link' | t }}</a>
+        </p>
+      {% endif %}
+
+      {% assign sign_in = actions | where: "name", "sign_in" | first %}
+      {% if sign_in %}
+        <p class="zl-card-nav">
+          {{ 'register.action.sign_in.lead' | t }}<a href="#" class="zl-card-nav__link" data-action="sign_in" data-testid="zitadel-action-sign_in-link">{{ 'register.action.sign_in.link' | t }}</a>
+        </p>
+      {% endif %}
+
+      {% if challenge %}
+        {% if challenge.method == "passkey" or challenge.method == "passkey_register" %}
+          {% assign ceremony = "authenticate" %}
+          {% assign submit_method = challenge.method %}
+          {% if challenge.method == "passkey_register" or challenge.options.user %}
+            {% assign ceremony = "register" %}
+            {% assign submit_method = "passkey_register" %}
+          {% endif %}
+          <zl-passkey
+            ceremony="{{ ceremony }}"
+            method="{{ submit_method }}"
+            challenge-id="{{ challenge.challenge_id }}"
+            options='{{ challenge.options | json }}'
+            pending-label="{{ 'passkey.pending.status' | t }}"
+            cancel-label="{{ 'action.cancel' | t }}"
+          ></zl-passkey>
+        {% endif %}
+      {% endif %}
+
+      {% mandatory_gates %}
+    </zl-card>
+    </section>
+  </div>
+</zl-page-shell>

package/defaults/branding/split-right/login.liquid

@@ -0,0 +1,178 @@
+<zl-page-shell data-zl-template-root>
+  <div class="zl-split zl-split--right">
+    <aside class="zl-split__brand">
+      {% if branding.logo_url %}
+        <img class="zl-split__logo" src="{{ branding.logo_url }}" alt="" />
+      {% endif %}
+      {% if branding.hero_url %}
+        <img class="zl-split__hero" src="{{ branding.hero_url }}" alt="" />
+      {% endif %}
+    </aside>
+    <section class="zl-split__form">
+    {% if branding.logo_url %}
+      <img class="zl-split__compact" src="{{ branding.logo_url }}" alt="" />
+    {% elsif branding.hero_url %}
+      <img class="zl-split__compact zl-split__compact--hero" src="{{ branding.hero_url }}" alt="" />
+    {% endif %}
+    <zl-card>
+      <h1 slot="header" class="zl-card-title">{{ step.texts.title_key | t: identity.display_name }}</h1>
+      {% if step.texts.description_key %}
+        {% assign card_subtitle = step.texts.description_key | t: identity.display_name %}
+        {% if card_subtitle != "" %}
+          <p slot="header" class="zl-card-subtitle">{{ card_subtitle }}</p>
+        {% endif %}
+      {% endif %}
+
+      {% if errors and errors.size > 0 %}
+        {% for err in errors %}
+          {% if err | formLevelError %}
+            {% assign alert_heading = err.text_key | alertHeading %}
+            {% assign alert_body = err.text_key | alertBody %}
+            <zl-alert severity="error" dismissible data-zl-step-error{% if alert_heading != "" %} heading="{{ alert_heading | t }}"{% endif %}>
+              {% if alert_body != "" %}{{ alert_body | t }}{% elsif err.text_key %}{{ err.text_key | t }}{% else %}{{ err.message }}{% endif %}
+            </zl-alert>
+          {% endif %}
+        {% endfor %}
+      {% endif %}
+
+      {% for f in fields %}
+        {% assign field_placeholder = f.text_key | fieldPlaceholder %}
+        {% assign field_help = f.text_key | fieldHelp %}
+        {% assign field_err = f.name | fieldError: errors %}
+        {% case f.type %}
+        {% when 'checkbox' %}
+          <zl-checkbox
+            name="{{ f.name }}"
+            data-testid="zitadel-field-{{ f.name | testid }}"
+            label="{{ f.text_key | t }}"
+            value="true"
+            {% if f.value %}checked{% endif %}
+            {% if field_err != "" %}invalid error="{{ field_err }}"{% endif %}
+          ></zl-checkbox>
+        {% when 'select' %}
+          <zl-select
+            name="{{ f.name }}"
+            data-testid="zitadel-field-{{ f.name | testid }}"
+            label="{{ f.text_key | t }}"
+            value="{{ f.value }}"
+            options='{{ f.validation.enum | selectOptions | json }}'
+            {% if f.required %}required{% endif %}
+            {% if field_placeholder != "" %}placeholder="{{ field_placeholder }}"{% endif %}
+          {% if field_err != "" %}invalid error="{{ field_err }}"{% endif %}
+          ></zl-select>
+        {% else %}
+          {% assign autocomplete_val = '' %}
+          {% if f.name == 'email' %}
+            {% assign autocomplete_val = 'email' %}
+          {% elsif f.type == 'password' and step.name contains 'register' %}
+            {% assign autocomplete_val = 'new-password' %}
+          {% elsif f.type == 'password' %}
+            {% assign autocomplete_val = 'current-password' %}
+          {% endif %}
+          <zl-field
+            name="{{ f.name }}"
+            data-testid="zitadel-field-{{ f.name | testid }}"
+            label="{{ f.text_key | t }}"
+            type="{{ f.type }}"
+            value="{{ f.value }}"
+            {% if autocomplete_val != '' %}autocomplete="{{ autocomplete_val }}"{% endif %}
+            {% if f.required %}required{% endif %}
+            {% if field_placeholder != "" %}placeholder="{{ field_placeholder }}"{% endif %}
+            {% if field_err != "" %}invalid error="{{ field_err }}"{% endif %}
+          >
+            {% if field_help != "" %}
+              <span slot="help">{{ field_help }}</span>
+            {% endif %}
+          </zl-field>
+        {% endcase %}
+      {% endfor %}
+
+      {% assign recover = actions | where: "name", "recover" | first %}
+      {% if recover %}
+        <p class="zl-card-forgot">
+          <a href="#" class="zl-card-forgot__link" data-action="recover">{{ recover.text_key | t }}</a>
+        </p>
+      {% endif %}
+
+      {% for a in actions %}
+        {% if a.primary %}
+          <zl-button
+            hierarchy="primary"
+            size="medium"
+            type="submit"
+            block
+            action="{{ a.name }}"
+            data-testid="zitadel-action-{{ a.name }}"
+            label="{{ a.text_key | t }}"
+            {% if loading %}loading{% endif %}
+          ></zl-button>
+        {% endif %}
+      {% endfor %}
+
+      {% for a in actions %}
+        {% unless a.primary or a.kind == 'back' or a.name == 'passkey' or a.name == 'register' or a.name == 'sign_in' or a.name == 'recover' %}
+          <zl-button
+            hierarchy="secondary"
+            size="medium"
+            type="button"
+            block
+            action="{{ a.name }}"
+            data-testid="zitadel-action-{{ a.name }}"
+            label="{{ a.text_key | t }}"
+          ></zl-button>
+        {% endunless %}
+      {% endfor %}
+
+      {% assign passkey = actions | where: "name", "passkey" | first %}
+      {% if passkey %}
+        {% unless passkey.primary %}
+          <zl-button
+            hierarchy="secondary"
+            size="medium"
+            block
+            action="passkey"
+            data-testid="zitadel-action-passkey"
+            label="{{ passkey.text_key | t }}"
+          ></zl-button>
+        {% endunless %}
+      {% endif %}
+
+
+      {% assign register = actions | where: "name", "register" | first %}
+      {% if register %}
+        <p class="zl-card-nav">
+          {{ 'identifier.action.register.lead' | t }}<a href="#" class="zl-card-nav__link" data-action="register" data-testid="zitadel-action-register-link">{{ 'identifier.action.register.link' | t }}</a>
+        </p>
+      {% endif %}
+
+      {% assign sign_in = actions | where: "name", "sign_in" | first %}
+      {% if sign_in %}
+        <p class="zl-card-nav">
+          {{ 'register.action.sign_in.lead' | t }}<a href="#" class="zl-card-nav__link" data-action="sign_in" data-testid="zitadel-action-sign_in-link">{{ 'register.action.sign_in.link' | t }}</a>
+        </p>
+      {% endif %}
+
+      {% if challenge %}
+        {% if challenge.method == "passkey" or challenge.method == "passkey_register" %}
+          {% assign ceremony = "authenticate" %}
+          {% assign submit_method = challenge.method %}
+          {% if challenge.method == "passkey_register" or challenge.options.user %}
+            {% assign ceremony = "register" %}
+            {% assign submit_method = "passkey_register" %}
+          {% endif %}
+          <zl-passkey
+            ceremony="{{ ceremony }}"
+            method="{{ submit_method }}"
+            challenge-id="{{ challenge.challenge_id }}"
+            options='{{ challenge.options | json }}'
+            pending-label="{{ 'passkey.pending.status' | t }}"
+            cancel-label="{{ 'action.cancel' | t }}"
+          ></zl-passkey>
+        {% endif %}
+      {% endif %}
+
+      {% mandatory_gates %}
+    </zl-card>
+    </section>
+  </div>
+</zl-page-shell>

package/defaults/default-human-user.json

@@ -26,21 +26,6 @@
       "format": "email",
       "x-unique": "project",
       "description": "The user's email address."
-    },
-    "givenName": {
-      "type": "string",
-      "maxLength": 50,
-      "description": "The user's given (first) name."
-    },
-    "familyName": {
-      "type": "string",
-      "maxLength": 50,
-      "description": "The user's family (last) name."
-    },
-    "dateOfBirth": {
-      "type": "string",
-      "format": "date",
-      "description": "The user's date of birth (ISO 8601, YYYY-MM-DD)."
     }
   }
 }

package/defaults/default-login.json

@@ -70,10 +70,7 @@
     {
       "name": "register",
       "fields": [
-        "email",
-        "givenName",
-        "familyName",
-        "dateOfBirth"
+        "email"
       ],
       "actions": [
         {

package/defaults/presets/passkey-first/human-user.json

@@ -26,21 +26,6 @@
       "format": "email",
       "x-unique": "project",
       "description": "The user's email address."
-    },
-    "givenName": {
-      "type": "string",
-      "maxLength": 50,
-      "description": "The user's given (first) name."
-    },
-    "familyName": {
-      "type": "string",
-      "maxLength": 50,
-      "description": "The user's family (last) name."
-    },
-    "dateOfBirth": {
-      "type": "string",
-      "format": "date",
-      "description": "The user's date of birth (ISO 8601, YYYY-MM-DD)."
     }
   }
 }

package/defaults/presets/passkey-first/login.json

@@ -99,10 +99,7 @@
     {
       "name": "register",
       "fields": [
-        "email",
-        "givenName",
-        "familyName",
-        "dateOfBirth"
+        "email"
       ],
       "actions": [
         {

package/dist/defaults-Bh4_xVbh.d.mts

@@ -0,0 +1,84 @@
+import { CreateFlowDefinitionBodyFlowDefinition, CreateSchemaBody } from "@zitadel/api/generated/model";
+
+//#region src/readmes.d.ts
+/**
+ * README content the CLI copies to `.zitadel/schemas/README.md` during setup.
+ * Source of truth is `packages/config/defaults/README-schemas.md`; the Go
+ * server-side embed reads the same file (see `defaults.go`).
+ */
+declare function schemasReadmeContent(): string;
+/**
+ * README content the CLI copies to `.zitadel/flows/README.md` during setup.
+ * Source of truth is `packages/config/defaults/README-flows.md`.
+ */
+declare function flowsReadmeContent(): string;
+/**
+ * README content the CLI copies to `.zitadel/branding/README.md` when a
+ * branding design is ejected. Source of truth is
+ * `packages/config/defaults/README-branding.md`.
+ */
+declare function brandingReadmeContent(): string;
+//#endregion
+//#region src/defaults.d.ts
+declare const DEFAULT_BUILTIN_SCHEMA_BASE = "https://nextgen.com/api/schemas";
+declare const DEFAULT_FLOW_SCHEMA_URI = "https://nextgen.com/flow-definition.json";
+declare const DEFAULT_SCHEMA_CONFIG_PATH = ".zitadel/schemas/default-human-user.json";
+declare const DEFAULT_FLOW_CONFIG_PATH = ".zitadel/flows/default-login.json";
+declare const DEFAULT_BRANDING_CONFIG_PATH = ".zitadel/branding/branding.json";
+declare const DEFAULT_BRANDING_TEMPLATE_PATH = ".zitadel/branding/login.liquid";
+/**
+ * Named schema+flow bundles `zitadel setup` can scaffold (#448: the prompt
+ * fires before any `.zitadel/` file is written; each preset maps to a
+ * pre-defined bundle the CLI copies on first setup). `password-first` is
+ * today's default; `passkey-first` puts a passkey ceremony on the login
+ * entry step with an email→password fallback path.
+ */
+declare const SETUP_PRESETS: readonly ["password-first", "passkey-first"];
+type SetupPreset = (typeof SETUP_PRESETS)[number];
+declare const DEFAULT_SETUP_PRESET: SetupPreset;
+/**
+ * Login-design starting points `zitadel branding eject --design <name>` (and
+ * `zitadel setup --design <name>`) scaffold into `.zitadel/branding/`. A
+ * design is a full Liquid template plus the descriptor `layout` it degrades
+ * to — the wire `layout` enum stays `centered | split`, richer designs are
+ * delivered as templates (ADR 040).
+ */
+declare const BRANDING_DESIGNS: readonly ["centered", "split", "split-right", "hero", "minimal"];
+type BrandingDesign = (typeof BRANDING_DESIGNS)[number];
+declare const DEFAULT_BRANDING_DESIGN: BrandingDesign;
+type DefaultBrandingConfig = {
+  /** The `.zitadel/branding/branding.json` descriptor body (sans `$schema`). */branding: {
+    layout: "centered" | "split";
+    liquid_template_file: string;
+  }; /** The `.zitadel/branding/login.liquid` template content. */
+  template: string;
+};
+/**
+ * Renders the scaffold files for a branding design. The `centered` template
+ * is a drift-tested copy of the bundled default in `@zitadel/components`;
+ * the other designs are authored variants of it.
+ */
+declare function getDefaultBrandingConfig(design?: string): DefaultBrandingConfig;
+/**
+ * The second setup axis (#448): *who* signs in, orthogonal to the sign-in
+ * preset (*how* they sign in). The sign-in preset owns the flow shape and
+ * auth methods; the use case owns which profile fields the schema collects.
+ * Composing the two keeps us at one field catalog + one flow-per-preset
+ * instead of a bundle per (use case × preset) pair. `minimal` is the
+ * default and never blocks non-interactive runs.
+ */
+declare const SETUP_USE_CASES: readonly ["minimal", "consumer", "business"];
+type SetupUseCase = (typeof SETUP_USE_CASES)[number];
+declare const DEFAULT_SETUP_USE_CASE: SetupUseCase;
+type DefaultConfigRenderOptions = {
+  builtinSchemaBase?: string;
+  userSchemaUrl?: string; /** Which flow/auth bundle to render; defaults to {@link DEFAULT_SETUP_PRESET}. */
+  preset?: string; /** Which field set to collect; defaults to {@link DEFAULT_SETUP_USE_CASE}. */
+  useCase?: string;
+};
+declare function defaultHumanUserSchemaUrl(builtinSchemaBase?: string): string;
+declare function getDefaultHumanUserSchema(options?: DefaultConfigRenderOptions): CreateSchemaBody;
+declare function getDefaultLoginFlow(options?: DefaultConfigRenderOptions): CreateFlowDefinitionBodyFlowDefinition;
+//#endregion
+export { flowsReadmeContent as C, brandingReadmeContent as S, SetupUseCase as _, DEFAULT_BRANDING_TEMPLATE_PATH as a, getDefaultHumanUserSchema as b, DEFAULT_FLOW_SCHEMA_URI as c, DEFAULT_SETUP_USE_CASE as d, DefaultBrandingConfig as f, SetupPreset as g, SETUP_USE_CASES as h, DEFAULT_BRANDING_DESIGN as i, DEFAULT_SCHEMA_CONFIG_PATH as l, SETUP_PRESETS as m, BrandingDesign as n, DEFAULT_BUILTIN_SCHEMA_BASE as o, DefaultConfigRenderOptions as p, DEFAULT_BRANDING_CONFIG_PATH as r, DEFAULT_FLOW_CONFIG_PATH as s, BRANDING_DESIGNS as t, DEFAULT_SETUP_PRESET as u, defaultHumanUserSchemaUrl as v, schemasReadmeContent as w, getDefaultLoginFlow as x, getDefaultBrandingConfig as y };
+//# sourceMappingURL=defaults-Bh4_xVbh.d.mts.map

package/dist/defaults-Bh4_xVbh.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults-Bh4_xVbh.d.mts","names":[],"sources":["../src/readmes.ts","../src/defaults.ts"],"mappings":";;;;;;AAQA;;iBAAgB,oBAAA,CAAA;;;AAQhB;;iBAAgB,kBAAA,CAAA;;;AAShB;;;iBAAgB,qBAAA,CAAA;;;cCFH,2BAAA;AAAA,cACA,uBAAA;AAAA,cACA,0BAAA;AAAA,cACA,wBAAA;AAAA,cACA,4BAAA;AAAA,cACA,8BAAA;ADZb;;;;;AASA;;AATA,cCqBa,aAAA;AAAA,KAED,WAAA,WAAsB,aAAA;AAAA,cAErB,oBAAA,EAAsB,WAAA;;;;AAlBnC;;;;cAkDa,gBAAA;AAAA,KAED,cAAA,WAAyB,gBAAA;AAAA,cAExB,uBAAA,EAAyB,cAAA;AAAA,KAW1B,qBAAA;EAhEwB,8EAkElC,QAAA;IACE,MAAA;IACA,oBAAA;EAAA,GAnEmC;EAsErC,QAAA;AAAA;;;;;AApEF;iBA4EgB,wBAAA,CACd,MAAA,YACC,qBAAA;;;;AA7EH;;;;;cAgHa,eAAA;AAAA,KAED,YAAA,WAAuB,eAAA;AAAA,cAEtB,sBAAA,EAAwB,YAAA;AAAA,KA0GzB,0BAAA;EACV,iBAAA;EACA,aAAA,WArNqB;EAuNrB,MAAA,WAvNgC;EAyNhC,OAAA;AAAA;AAAA,iBAGc,yBAAA,CACd,iBAAA;AAAA,iBAKc,yBAAA,CACd,OAAA,GAAS,0BAAA,GACR,gBAAA;AAAA,iBAca,mBAAA,CACd,OAAA,GAAS,0BAAA,GACR,sCAAA"}