@cosmicdrift/kumiko-samples 0.361.0 → 0.363.0

package/packages/bundled-features/src/waitlist/handlers/submit.write.ts

@@ -10,10 +10,10 @@ import { Temporal } from "@cosmicdrift/kumiko-types/temporal";
 import { WAITLIST_NOTIFICATION_TYPES, WAITLIST_STATUS } from "../constants.js";
 import { normalizeEmail, platformActor, waitlistDb, waitlistExecutor } from "../lib.js";
 import {
-  renderWaitlistAdminNoticeEmail,
-  renderWaitlistConfirmationEmail,
   resolveWaitlistAdminMailLocale,
   resolveWaitlistMailLocale,
+  waitlistAdminNoticeVariables,
+  waitlistConfirmationVariables,
 } from "../mail.js";
 import {
   DEFAULT_SUBMIT_EMAIL_RATE_LIMITS,
@@ -130,7 +130,7 @@ export function createSubmitHandler(opts: WaitlistOptions) {
       await sendBestEffort(ctx, "confirmation", (notify) =>
         notify(WAITLIST_NOTIFICATION_TYPES.confirmation, {
           route: { email },
-          data: renderWaitlistConfirmationEmail({
+          data: waitlistConfirmationVariables({
             locale: payload.locale,
             appName: opts.appName,
           }),
@@ -145,12 +145,11 @@ export function createSubmitHandler(opts: WaitlistOptions) {
         if (!adminRecipient) return;
         await notify(WAITLIST_NOTIFICATION_TYPES.adminNotice, {
           route: { email: adminRecipient },
-          data: renderWaitlistAdminNoticeEmail({
+          data: waitlistAdminNoticeVariables({
             name: payload.name,
             email,
             company: payload.company,
             message: payload.message,
-            adminLocale: ctx.locale,
           }),
           priority: "normal",
           locale: resolveWaitlistAdminMailLocale(ctx.locale),

package/packages/bundled-features/src/waitlist/mail.ts

@@ -1,4 +1,10 @@
-import type { AuthMailContent } from "../auth-email-password/index.js";
+import {
+  type NotificationLocalizedTemplate,
+  type NotificationRecordMapping,
+  type TemplateVariables,
+  templateVariable,
+} from "@cosmicdrift/kumiko-framework/engine";
+import { mailHeading, mailParagraph, mailRepeatedRows } from "../shared/index.js";
 
 export type WaitlistMailLocale = "en" | "de" | "es";
 
@@ -72,43 +78,88 @@ export function resolveWaitlistMailLocale(locale: string | undefined): WaitlistM
   return isConfirmationLocale(language) ? language : "en";
 }
 
+export const WAITLIST_CONFIRMATION_VARIABLES: TemplateVariables = {
+  subject: templateVariable.text({ required: true }),
+  intro: templateVariable.text({ required: true }),
+  footer: templateVariable.text({ required: true }),
+};
+
+// Only `name` is a plain entry field; the details rows are composed from several fields.
+export const WAITLIST_ADMIN_NOTICE_RECORD: NotificationRecordMapping = {
+  entity: "waitlistEntry",
+  map: { name: "name" },
+};
+
+export const WAITLIST_ADMIN_NOTICE_VARIABLES: TemplateVariables = {
+  name: templateVariable.text({ required: true }),
+  details: templateVariable.list(
+    { text: templateVariable.text({ required: true }) },
+    { required: true },
+  ),
+};
+
+// The app name is optional, so the sentences that mention it are computed in
+// code and handed over as variables; the template keeps heading and structure.
 // The submitter's name stays out: the address is unverified, so any text in
 // this mail could be planted by whoever typed someone else's email.
-export function renderWaitlistConfirmationEmail(args: {
+export function waitlistConfirmationVariables(args: {
   readonly locale: string | undefined;
   readonly appName?: string | undefined;
-}): AuthMailContent {
+}): { readonly subject: string; readonly intro: string; readonly footer: string } {
   const t = CONFIRMATION_STRINGS[resolveWaitlistMailLocale(args.locale)];
   return {
     subject: t.subject(args.appName),
-    header: t.header,
-    sections: [{ text: t.intro(args.appName) }],
+    intro: t.intro(args.appName),
     footer: t.footer(args.appName),
   };
 }
 
+export function waitlistConfirmationTemplate(): NotificationLocalizedTemplate {
+  return Object.fromEntries(
+    Object.entries(CONFIRMATION_STRINGS).map(([locale, t]) => [
+      locale,
+      {
+        body: [mailHeading(t.header), mailParagraph("{intro}"), mailParagraph("{footer}")].join(""),
+        meta: { subject: "{{subject}}", category: "transactional" as const },
+      },
+    ]),
+  );
+}
+
 // Operator-facing, so the entrant's locale does not apply: en/de, en default.
 export function resolveWaitlistAdminMailLocale(adminLocale: string | undefined): "en" | "de" {
   return languageOf(adminLocale) === "de" ? "de" : "en";
 }
 
-export function renderWaitlistAdminNoticeEmail(args: {
+export function waitlistAdminNoticeVariables(args: {
   readonly name: string;
   readonly email: string;
   readonly company: string | undefined;
   readonly message: string | undefined;
-  readonly adminLocale: string | undefined;
-}): AuthMailContent {
-  const t = ADMIN_NOTICE_STRINGS[resolveWaitlistAdminMailLocale(args.adminLocale)];
-  const details = [
-    `${args.name} <${args.email}>`,
-    ...(args.company ? [args.company] : []),
-    ...(args.message ? [args.message] : []),
-  ];
+}): { readonly name: string; readonly details: readonly { readonly text: string }[] } {
   return {
-    subject: t.subject(args.name),
-    header: t.header,
-    sections: [{ text: t.intro }, { text: details.join("\n") }],
-    footer: t.footer,
+    name: args.name,
+    details: [
+      `${args.name} <${args.email}>`,
+      ...(args.company ? [args.company] : []),
+      ...(args.message ? [args.message] : []),
+    ].map((text) => ({ text })),
   };
 }
+
+export function waitlistAdminNoticeTemplate(): NotificationLocalizedTemplate {
+  return Object.fromEntries(
+    Object.entries(ADMIN_NOTICE_STRINGS).map(([locale, t]) => [
+      locale,
+      {
+        body: [
+          mailHeading(t.header),
+          mailParagraph(t.intro),
+          mailRepeatedRows("details", "text"),
+          mailParagraph(t.footer),
+        ].join(""),
+        meta: { subject: t.subject("{{name}}"), category: "transactional" as const },
+      },
+    ]),
+  );
+}

package/packages/bundled-features/src/workflow-runner/event-trigger.ts

@@ -22,7 +22,6 @@ import {
   describeWorkflowStepError,
   getStep,
   SYSTEM_TENANT_ID,
-  type TenantId,
   WORKFLOW_AGGREGATE_TYPE,
   WORKFLOW_RUN_FAILED_TYPE,
   WorkflowStepError,
@@ -71,7 +70,7 @@ export function assertEventTriggerStepsSupported(workflow: WorkflowDefinition):
     steps = buildPipelineSteps(workflow.pipelineDef, {
       type: "workflow-registration-probe",
       payload: {},
-      user: createSystemUser(SYSTEM_TENANT_ID as TenantId),
+      user: createSystemUser(SYSTEM_TENANT_ID),
     });
   } catch (error) {
     throw new Error(

package/samples/apps/ui-walkthrough/package.json

@@ -10,9 +10,11 @@
   "dependencies": {
     "@cosmicdrift/kumiko-bundled-features": "workspace:*",
     "@cosmicdrift/kumiko-dev-server": "workspace:*",
+    "@cosmicdrift/kumiko-document-designer": "workspace:*",
     "@cosmicdrift/kumiko-dispatcher-live": "workspace:*",
     "@cosmicdrift/kumiko-framework": "workspace:*",
     "@cosmicdrift/kumiko-headless": "workspace:*",
+    "@cosmicdrift/kumiko-renderer-mail-html": "workspace:*",
     "@cosmicdrift/kumiko-renderer-web": "workspace:*",
     "@cosmicdrift/kumiko-server-runtime": "workspace:*",
     "react": "^19.2.6",

package/samples/apps/ui-walkthrough/src/app/auth-constants.ts

@@ -18,3 +18,12 @@ export const ADMIN_PASSWORD = "kumiko-admin";
 // `as TenantId`-Cast lokal.
 export const DEV_TENANT_ID = "00000000-0000-4000-8000-000000000001";
 export const BETA_TENANT_ID = "00000000-0000-4000-8000-000000000002";
+
+// Nordlicht Immobilien GmbH: the tenant the document-designer walkthrough runs
+// in. Both users are new; the admin above stays untouched.
+export const NORDLICHT_TENANT_ID = "00000000-0000-4000-8000-000000000003";
+export const NORDLICHT_TENANT_NAME = "Nordlicht Immobilien GmbH";
+export const TENANT_ADMIN_EMAIL = "a.berger@nordlicht-immobilien.de";
+export const TENANT_ADMIN_PASSWORD = "nordlicht-berger";
+export const PLATFORM_ADMIN_EMAIL = "plattform@kumiko.dev";
+export const PLATFORM_ADMIN_PASSWORD = "kumiko-plattform";

package/samples/apps/ui-walkthrough/src/app/client.tsx

@@ -2,8 +2,11 @@
 // übergibt Shell + clientFeatures an createKumikoApp.
 
 import { emailPasswordClient } from "@cosmicdrift/kumiko-bundled-features/auth-email-password/web";
+import { textBlocksClient } from "@cosmicdrift/kumiko-bundled-features/template-resolver/web";
+import { documentDesignerClient } from "@cosmicdrift/kumiko-document-designer/web";
 import { localeDeClient } from "@cosmicdrift/kumiko-locale-de/web";
 import { createKumikoApp } from "@cosmicdrift/kumiko-renderer-web";
+import { billingClient } from "../features/billing/web";
 import { rentalClient } from "../features/rental/web";
 import { tasksClient } from "../features/tasks/web";
 import { vehiclesClient } from "../features/vehicles/web";
@@ -17,5 +20,8 @@ createKumikoApp({
     tasksClient,
     rentalClient,
     vehiclesClient,
+    billingClient,
+    textBlocksClient(),
+    documentDesignerClient(),
   ],
 });

package/samples/apps/ui-walkthrough/src/app/seed-templates.ts

@@ -0,0 +1,154 @@
+// Nordlicht Immobilien GmbH for the document-designer walkthrough: a tenant
+// admin, a platform admin, branding and a realistic set of mail and PDF
+// templates. Everything goes through the template write handlers (or the
+// system-template seed), never straight into the tables.
+
+import { seedAdmin } from "@cosmicdrift/kumiko-bundled-features/auth-email-password/seeding";
+import { BRANDING_QN } from "@cosmicdrift/kumiko-bundled-features/managed-pages";
+import {
+  TemplateResolverHandlers,
+  TemplateResolverQueries,
+} from "@cosmicdrift/kumiko-bundled-features/template-resolver";
+import type { SeedFn } from "@cosmicdrift/kumiko-dev-server";
+import type { SessionUser, TenantId } from "@cosmicdrift/kumiko-framework/engine";
+import { DEFAULT_MAIL_LAYOUT_MJML } from "@cosmicdrift/kumiko-renderer-mail-html";
+import {
+  NORDLICHT_TENANT_ID,
+  NORDLICHT_TENANT_NAME,
+  PLATFORM_ADMIN_EMAIL,
+  PLATFORM_ADMIN_PASSWORD,
+  TENANT_ADMIN_EMAIL,
+  TENANT_ADMIN_PASSWORD,
+} from "./auth-constants";
+import {
+  INVOICE_CORRECTED_DRAFT,
+  INVOICE_ISSUED_DRAFT_VERSIONS,
+  PAYMENT_REMINDER_TEMPLATES,
+  type SeedTemplate,
+  SYSTEM_AUTH_MAILS,
+  SYSTEM_INVOICE_DOCUMENTS,
+  SYSTEM_INVOICE_ISSUED,
+  SYSTEM_PDF_LAYOUT,
+  SYSTEM_TENANCY_CERTIFICATE,
+  TENANT_MAIL_LAYOUT_VERSIONS,
+  TENANT_UTILITY_STATEMENT,
+} from "./template-seed-data";
+
+const NORDLICHT = NORDLICHT_TENANT_ID as TenantId;
+
+const BRANDING = [
+  [BRANDING_QN.title, "Nordlicht Mieterportal"],
+  [BRANDING_QN.accentColor, "#205265"],
+  [BRANDING_QN.siteUrl, "https://nordlicht-immobilien.de"],
+  [BRANDING_QN.logoUrl, "https://nordlicht-immobilien.de/logo-nordlicht.png"],
+] as const;
+
+export const seedTemplates: SeedFn = async (stack) => {
+  const membership = (roles: readonly string[]) => [
+    {
+      tenantId: NORDLICHT,
+      tenantKey: "nordlicht",
+      tenantName: NORDLICHT_TENANT_NAME,
+      roles,
+    },
+  ];
+  const tenantAdminAccount = await seedAdmin(stack.db, {
+    email: TENANT_ADMIN_EMAIL,
+    password: TENANT_ADMIN_PASSWORD,
+    displayName: "A. Berger",
+    emailVerified: true,
+    memberships: membership(["TenantAdmin"]),
+  });
+  const platformAdminAccount = await seedAdmin(stack.db, {
+    email: PLATFORM_ADMIN_EMAIL,
+    password: PLATFORM_ADMIN_PASSWORD,
+    displayName: "Plattform-Admin",
+    emailVerified: true,
+    globalRoles: ["SystemAdmin"],
+    memberships: membership(["TenantAdmin"]),
+  });
+  // The session re-derives roles from the membership row on every request, so
+  // the roles here only have to match what the account really has.
+  const tenantAdmin: SessionUser = {
+    id: tenantAdminAccount.id as SessionUser["id"],
+    tenantId: NORDLICHT,
+    roles: ["TenantAdmin"],
+  };
+  const platformAdmin: SessionUser = {
+    id: platformAdminAccount.id as SessionUser["id"],
+    tenantId: NORDLICHT,
+    roles: ["TenantAdmin", "SystemAdmin"],
+  };
+
+  const overview = await stack.http.queryOk<{ rows: { origin: string }[] }>(
+    TemplateResolverQueries.overview,
+    {},
+    tenantAdmin,
+  );
+  if (overview.rows.some((row) => row.origin === "tenant")) return;
+
+  const upsert = (
+    handler: string,
+    template: SeedTemplate,
+    user: SessionUser,
+    extra: Record<string, unknown> = {},
+  ) =>
+    stack.http.writeOk<{ id: string }>(
+      handler,
+      {
+        slug: template.slug,
+        kind: template.kind,
+        locale: template.locale,
+        contentFormat: "html",
+        content: template.content,
+        ...(template.title !== undefined && { title: template.title }),
+        ...(template.meta !== undefined && { meta: template.meta }),
+        ...(template.variableSchema !== undefined && { variableSchema: template.variableSchema }),
+        ...extra,
+      },
+      user,
+    );
+  const upsertSystem = (template: SeedTemplate) =>
+    upsert(TemplateResolverHandlers.upsertSystem, template, platformAdmin);
+  const upsertTenant = (template: SeedTemplate, status: "draft" | "active") =>
+    upsert(TemplateResolverHandlers.upsertTenant, template, tenantAdmin, { status });
+
+  await stack.http.writeOk(
+    TemplateResolverHandlers.upsertSystem,
+    {
+      slug: "default",
+      kind: "mail-layout",
+      locale: "en",
+      contentFormat: "mjml",
+      content: DEFAULT_MAIL_LAYOUT_MJML,
+      title: "Mail-Layout",
+    },
+    platformAdmin,
+  );
+  await upsertSystem(SYSTEM_PDF_LAYOUT);
+  for (const mail of SYSTEM_AUTH_MAILS) await upsertSystem(mail);
+  await upsertSystem(SYSTEM_INVOICE_ISSUED);
+  for (const document of SYSTEM_INVOICE_DOCUMENTS) await upsertSystem(document);
+  const certificate = await upsertSystem(SYSTEM_TENANCY_CERTIFICATE);
+  await stack.http.writeOk(
+    TemplateResolverHandlers.archiveSystem,
+    { id: certificate.id },
+    platformAdmin,
+  );
+
+  for (const [key, value] of BRANDING) {
+    await stack.http.writeOk("config:write:set", { key, value }, tenantAdmin);
+  }
+  // Each save is a new version of the same row; the second one makes the
+  // layout "customised" for the overview and the first leaves history to diff.
+  for (const content of TENANT_MAIL_LAYOUT_VERSIONS) {
+    await upsertTenant(
+      { slug: "default", kind: "mail-layout", locale: "en", title: "Mail-Layout", content },
+      "active",
+    );
+  }
+  for (const draft of INVOICE_ISSUED_DRAFT_VERSIONS) await upsertTenant(draft, "draft");
+  await upsertTenant(INVOICE_CORRECTED_DRAFT, "draft");
+  for (const reminder of PAYMENT_REMINDER_TEMPLATES) await upsertTenant(reminder, "active");
+  await upsertTenant(TENANT_UTILITY_STATEMENT, "active");
+};

package/samples/apps/ui-walkthrough/src/app/server.ts

@@ -11,10 +11,12 @@
 
 import { runDevApp } from "@cosmicdrift/kumiko-dev-server";
 import type { TenantId } from "@cosmicdrift/kumiko-framework/engine";
+import { createInMemoryFileProvider } from "@cosmicdrift/kumiko-framework/files";
 import { APP_FEATURES } from "../run-config";
 import { ADMIN_EMAIL, ADMIN_PASSWORD, BETA_TENANT_ID, DEV_TENANT_ID } from "./auth-constants";
 import { seedTasks } from "./seed";
 import { seedRental } from "./seed-rental";
+import { seedTemplates } from "./seed-templates";
 import { seedVehicles } from "./seed-vehicles";
 
 // Zwei feste Tenants — Admin ist in beiden Mitglied damit der
@@ -25,10 +27,12 @@ import { seedVehicles } from "./seed-vehicles";
 
 await runDevApp({
   features: [...APP_FEATURES],
-  seeds: [seedTasks, seedRental, seedVehicles],
+  seeds: [seedTasks, seedRental, seedVehicles, seedTemplates],
   // PORT env-var override für Playwright-e2e-Runs (config zeigt auf 4174);
   // sonst lokal-Default 4173.
   port: Number.parseInt(process.env["PORT"] ?? "4173", 10),
+  // Logo and attachment uploads of the mail editor need a file store.
+  files: { storageProvider: createInMemoryFileProvider() },
   clientEntry: "./src/app/client.tsx",
   htmlPath: "./public/index.html",
   watchDirs: ["./src", "../../../packages/*/src"],

package/samples/apps/ui-walkthrough/src/app/shell.tsx

@@ -5,6 +5,7 @@
 import {
   TenantMenuItems,
   UserMenu,
+  useSession,
 } from "@cosmicdrift/kumiko-bundled-features/auth-email-password/web";
 import {
   type AppSchema,
@@ -18,13 +19,19 @@ import {
 import { MoonStar, Sun } from "lucide-react";
 import type { ReactNode } from "react";
 import { AssistantAction } from "./assistant-action";
-import { BETA_TENANT_ID, DEV_TENANT_ID } from "./auth-constants";
+import {
+  BETA_TENANT_ID,
+  DEV_TENANT_ID,
+  NORDLICHT_TENANT_ID,
+  NORDLICHT_TENANT_NAME,
+} from "./auth-constants";
 
 const APP_NAME = "Kumiko Walkthrough";
 
 const tenantName = (tenantId: string): string => {
   if (tenantId === DEV_TENANT_ID) return "Dev Tenant";
   if (tenantId === BETA_TENANT_ID) return "Beta Tenant";
+  if (tenantId === NORDLICHT_TENANT_ID) return NORDLICHT_TENANT_NAME;
   return tenantId.slice(0, 8);
 };
 
@@ -41,10 +48,14 @@ export function AppShell({
   readonly schema: AppSchema;
 }): ReactNode {
   const t = useTranslation();
+  const session = useSession();
+  // Without the user the shell hides role-gated navs and KumikoScreen denies role-gated screens.
+  const user = session.user !== null ? { id: session.user.id, roles: session.roles } : undefined;
   return (
     <DefaultAppShell
       brand={<SidebarBrand name={APP_NAME} plan={t("tasks.shell.tagline")} />}
       schema={schema}
+      {...(user !== undefined && { user })}
       headerActions={
         <>
           <AssistantAction />