@8wave/ai-elements 0.115.0-beta.52 → 0.115.0-beta.60

package/dist-vue/packages/models/src/schema/Branding.d.ts

@@ -0,0 +1,625 @@
+import * as z from 'zod';
+/** A six-digit hex color: the only form a theme or agent color is stored in. */
+export declare const HEX_COLOR_REGEX: RegExp;
+/** The three colors a theme sets: the ones `packages/style` itself overrides. */
+export declare const BrandingPaletteSchema: z.ZodObject<{
+    brand: z.ZodString;
+    accent: z.ZodString;
+    info: z.ZodString;
+}, z.core.$strip>;
+export type BrandingPalette = z.infer<typeof BrandingPaletteSchema>;
+/**
+ * Light and dark come together: the dark brand of the design system is an
+ * independent color, not a derivation of the light one, so a theme that sets
+ * only the light palette would sit next to the default dark one.
+ */
+export declare const BrandingColorsSchema: z.ZodObject<{
+    light: z.ZodObject<{
+        brand: z.ZodString;
+        accent: z.ZodString;
+        info: z.ZodString;
+    }, z.core.$strip>;
+    dark: z.ZodObject<{
+        brand: z.ZodString;
+        accent: z.ZodString;
+        info: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type BrandingColors = z.infer<typeof BrandingColorsSchema>;
+/**
+ * Whether two palettes, or two pairs of them, are the same colors, whatever
+ * the case of the hex.
+ */
+export declare const sameBrandingColors: <T extends BrandingColors | BrandingPalette>(a: T, b: T) => boolean;
+/** Whether the user picks light or dark, or the deployment fixes one. */
+export declare enum BrandingMode {
+    System = "system",
+    ForceLight = "force-light",
+    ForceDark = "force-dark"
+}
+/** The image slots of a theme. */
+export declare enum BrandingAssetSlot {
+    LogoLight = "logoLight",
+    LogoDark = "logoDark",
+    Mark = "mark",
+    EmailLogo = "emailLogo",
+    EmailBanner = "emailBanner"
+}
+/** Largest image a theme slot accepts, before any processing. */
+export declare const BRANDING_ASSET_MAX_BYTES: number;
+/** Largest side of a raster image: a 1200 px email banner has to fit. */
+export declare const BRANDING_RASTER_MAX_SIDE = 2048;
+/**
+ * Width an email image is stored at, twice the width it is shown at for high
+ * density screens. Gmail and Outlook show neither SVG nor WebP, so the two
+ * email slots store a PNG, or a JPEG when the image is opaque.
+ */
+export declare const BRANDING_EMAIL_WIDTH: Partial<Record<BrandingAssetSlot, number>>;
+/** The formats an image is uploaded in. */
+export declare const BRANDING_ASSET_MIME_TYPES: readonly ["image/svg+xml", "image/png", "image/webp"];
+export type BrandingAssetMimeType = (typeof BRANDING_ASSET_MIME_TYPES)[number];
+/** The formats an image is stored in: an opaque email image becomes a JPEG. */
+export declare const BRANDING_STORED_MIME_TYPES: readonly ["image/svg+xml", "image/png", "image/webp", "image/jpeg"];
+export type BrandingStoredMimeType = (typeof BRANDING_STORED_MIME_TYPES)[number];
+/** An uploaded image, addressed by the sha256 of the bytes that are served. */
+export declare const BrandingAssetRefSchema: z.ZodObject<{
+    checksum: z.ZodString;
+    mimeType: z.ZodEnum<{
+        "image/png": "image/png";
+        "image/svg+xml": "image/svg+xml";
+        "image/webp": "image/webp";
+        "image/jpeg": "image/jpeg";
+    }>;
+    width: z.ZodNullable<z.ZodNumber>;
+    height: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+export type BrandingAssetRef = z.infer<typeof BrandingAssetRefSchema>;
+/** Null in a slot means the image the bundle ships. */
+export declare const BrandingAssetsSchema: z.ZodObject<{
+    logoLight: z.ZodNullable<z.ZodObject<{
+        checksum: z.ZodString;
+        mimeType: z.ZodEnum<{
+            "image/png": "image/png";
+            "image/svg+xml": "image/svg+xml";
+            "image/webp": "image/webp";
+            "image/jpeg": "image/jpeg";
+        }>;
+        width: z.ZodNullable<z.ZodNumber>;
+        height: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+    logoDark: z.ZodNullable<z.ZodObject<{
+        checksum: z.ZodString;
+        mimeType: z.ZodEnum<{
+            "image/png": "image/png";
+            "image/svg+xml": "image/svg+xml";
+            "image/webp": "image/webp";
+            "image/jpeg": "image/jpeg";
+        }>;
+        width: z.ZodNullable<z.ZodNumber>;
+        height: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+    mark: z.ZodNullable<z.ZodObject<{
+        checksum: z.ZodString;
+        mimeType: z.ZodEnum<{
+            "image/png": "image/png";
+            "image/svg+xml": "image/svg+xml";
+            "image/webp": "image/webp";
+            "image/jpeg": "image/jpeg";
+        }>;
+        width: z.ZodNullable<z.ZodNumber>;
+        height: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+    emailLogo: z.ZodNullable<z.ZodObject<{
+        checksum: z.ZodString;
+        mimeType: z.ZodEnum<{
+            "image/png": "image/png";
+            "image/svg+xml": "image/svg+xml";
+            "image/webp": "image/webp";
+            "image/jpeg": "image/jpeg";
+        }>;
+        width: z.ZodNullable<z.ZodNumber>;
+        height: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+    emailBanner: z.ZodNullable<z.ZodObject<{
+        checksum: z.ZodString;
+        mimeType: z.ZodEnum<{
+            "image/png": "image/png";
+            "image/svg+xml": "image/svg+xml";
+            "image/webp": "image/webp";
+            "image/jpeg": "image/jpeg";
+        }>;
+        width: z.ZodNullable<z.ZodNumber>;
+        height: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type BrandingAssets = z.infer<typeof BrandingAssetsSchema>;
+export declare const BrandingTextSchema: z.ZodObject<{
+    productName: z.ZodString;
+    shortName: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    productTagline: z.ZodNullable<z.ZodString>;
+    companyName: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type BrandingText = z.infer<typeof BrandingTextSchema>;
+/** A complete theme: what every level resolves to. */
+export declare const BrandingSchema: z.ZodObject<{
+    colors: z.ZodObject<{
+        light: z.ZodObject<{
+            brand: z.ZodString;
+            accent: z.ZodString;
+            info: z.ZodString;
+        }, z.core.$strip>;
+        dark: z.ZodObject<{
+            brand: z.ZodString;
+            accent: z.ZodString;
+            info: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    mode: z.ZodEnum<typeof BrandingMode>;
+    assets: z.ZodObject<{
+        logoLight: z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+        logoDark: z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+        mark: z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+        emailLogo: z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+        emailBanner: z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    text: z.ZodObject<{
+        productName: z.ZodString;
+        shortName: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        productTagline: z.ZodNullable<z.ZodString>;
+        companyName: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type Branding = z.infer<typeof BrandingSchema>;
+/** A complete theme with the hash of its content, served to the clients. */
+export declare const ResolvedBrandingSchema: z.ZodObject<{
+    colors: z.ZodObject<{
+        light: z.ZodObject<{
+            brand: z.ZodString;
+            accent: z.ZodString;
+            info: z.ZodString;
+        }, z.core.$strip>;
+        dark: z.ZodObject<{
+            brand: z.ZodString;
+            accent: z.ZodString;
+            info: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    mode: z.ZodEnum<typeof BrandingMode>;
+    assets: z.ZodObject<{
+        logoLight: z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+        logoDark: z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+        mark: z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+        emailLogo: z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+        emailBanner: z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    text: z.ZodObject<{
+        productName: z.ZodString;
+        shortName: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        productTagline: z.ZodNullable<z.ZodString>;
+        companyName: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    version: z.ZodString;
+    stylesheetVersion: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type ResolvedBranding = z.infer<typeof ResolvedBrandingSchema>;
+/**
+ * What the embeddable widget gets of the deployment theme: the stylesheet it
+ * puts in its shadow root, which the page's own stylesheet cannot reach.
+ */
+export declare const DeploymentBrandingSchema: z.ZodObject<{
+    css: z.ZodString;
+}, z.core.$strip>;
+export type DeploymentBranding = z.infer<typeof DeploymentBrandingSchema>;
+/**
+ * What a level stores, and what a write accepts: every section and every
+ * value optional, and a missing or null one inherits from the level below. An
+ * empty string clears an optional text.
+ */
+export declare const BrandingPatchSchema: z.ZodObject<{
+    colors: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        light: z.ZodObject<{
+            brand: z.ZodString;
+            accent: z.ZodString;
+            info: z.ZodString;
+        }, z.core.$strip>;
+        dark: z.ZodObject<{
+            brand: z.ZodString;
+            accent: z.ZodString;
+            info: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>>>;
+    mode: z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof BrandingMode>>>;
+    assets: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        logoLight: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>>;
+        logoDark: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>>;
+        mark: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>>;
+        emailLogo: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>>;
+        emailBanner: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            checksum: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/svg+xml": "image/svg+xml";
+                "image/webp": "image/webp";
+                "image/jpeg": "image/jpeg";
+            }>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>>;
+    text: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        productTagline: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        companyName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        productName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        shortName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type BrandingPatch = z.infer<typeof BrandingPatchSchema>;
+/**
+ * The deployment patch as the system page reads and saves it. The revision
+ * names the stored document the page started from: a save sends it back, and
+ * is refused when another one landed in between, rather than undoing it.
+ */
+export declare const SystemBrandingSchema: z.ZodObject<{
+    patch: z.ZodObject<{
+        colors: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            light: z.ZodObject<{
+                brand: z.ZodString;
+                accent: z.ZodString;
+                info: z.ZodString;
+            }, z.core.$strip>;
+            dark: z.ZodObject<{
+                brand: z.ZodString;
+                accent: z.ZodString;
+                info: z.ZodString;
+            }, z.core.$strip>;
+        }, z.core.$strip>>>;
+        mode: z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof BrandingMode>>>;
+        assets: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            logoLight: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                checksum: z.ZodString;
+                mimeType: z.ZodEnum<{
+                    "image/png": "image/png";
+                    "image/svg+xml": "image/svg+xml";
+                    "image/webp": "image/webp";
+                    "image/jpeg": "image/jpeg";
+                }>;
+                width: z.ZodNullable<z.ZodNumber>;
+                height: z.ZodNullable<z.ZodNumber>;
+            }, z.core.$strip>>>;
+            logoDark: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                checksum: z.ZodString;
+                mimeType: z.ZodEnum<{
+                    "image/png": "image/png";
+                    "image/svg+xml": "image/svg+xml";
+                    "image/webp": "image/webp";
+                    "image/jpeg": "image/jpeg";
+                }>;
+                width: z.ZodNullable<z.ZodNumber>;
+                height: z.ZodNullable<z.ZodNumber>;
+            }, z.core.$strip>>>;
+            mark: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                checksum: z.ZodString;
+                mimeType: z.ZodEnum<{
+                    "image/png": "image/png";
+                    "image/svg+xml": "image/svg+xml";
+                    "image/webp": "image/webp";
+                    "image/jpeg": "image/jpeg";
+                }>;
+                width: z.ZodNullable<z.ZodNumber>;
+                height: z.ZodNullable<z.ZodNumber>;
+            }, z.core.$strip>>>;
+            emailLogo: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                checksum: z.ZodString;
+                mimeType: z.ZodEnum<{
+                    "image/png": "image/png";
+                    "image/svg+xml": "image/svg+xml";
+                    "image/webp": "image/webp";
+                    "image/jpeg": "image/jpeg";
+                }>;
+                width: z.ZodNullable<z.ZodNumber>;
+                height: z.ZodNullable<z.ZodNumber>;
+            }, z.core.$strip>>>;
+            emailBanner: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                checksum: z.ZodString;
+                mimeType: z.ZodEnum<{
+                    "image/png": "image/png";
+                    "image/svg+xml": "image/svg+xml";
+                    "image/webp": "image/webp";
+                    "image/jpeg": "image/jpeg";
+                }>;
+                width: z.ZodNullable<z.ZodNumber>;
+                height: z.ZodNullable<z.ZodNumber>;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>>>;
+        text: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            productTagline: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            companyName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            productName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            shortName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>;
+    revision: z.ZodString;
+}, z.core.$strip>;
+export type SystemBranding = z.infer<typeof SystemBrandingSchema>;
+/**
+ * The theme the code ships with: the compile-time colors of `packages/style`
+ * and the product names of AGENTS.md. Assets are the bundled images. Frozen,
+ * because every resolution starts from it.
+ */
+export declare const DEFAULT_BRANDING: Branding;
+/**
+ * The theme a reader falls back on when the stored one cannot be read. The
+ * deployment may be any company's, so the product gets a generic name and,
+ * since that name is not the default one, no bundled image: an email or a
+ * manifest goes out without a logo rather than with Eight Wave's.
+ */
+export declare const NEUTRAL_BRANDING: Branding;
+/**
+ * Whether a theme without an image of its own may show Eight Wave's: only
+ * while it keeps the default product name. A renamed deployment gets a
+ * neutral mark, or no image in an email, never another company's logo.
+ */
+export declare const usesBundledImages: (text: Pick<BrandingText, "productName">) => boolean;
+/**
+ * The square mark of a theme that uploaded none and may not show the bundled
+ * one: the first letter of its name on its brand color, in black or white,
+ * whichever reads better (they tie at a luminance of 0.179). With rounded
+ * corners, unless an opaque icon draws it edge to edge, for a platform that
+ * rounds or crops it to its own shape.
+ */
+export declare function neutralMarkSvg(name: string, color: string, { rounded }?: {
+    rounded?: boolean;
+}): string;
+/**
+ * The neutral mark as a data URI, so an `<img>` and the favicon draw the
+ * same thing.
+ */
+export declare const neutralMarkUrl: (name: string, color: string) => string;
+/**
+ * Parse a stored patch, or null when it is missing or not an object. Values
+ * that do not validate are dropped one by one, see `BrandingPatchReadSchema`.
+ */
+export declare function parseBrandingPatch(value: unknown): BrandingPatch | null;
+/**
+ * Apply each patch in order on the default theme. A renamed theme does not
+ * inherit the default tagline and description, which name Eight Wave: they
+ * stay empty unless a patch sets them.
+ */
+export declare function resolveBranding(...patches: (BrandingPatch | null | undefined)[]): Branding;
+/**
+ * A short, stable hash of a string: an FNV-1a pass and a multiplicative pass
+ * seeded with the length, 32 bits each, in plain code so any runtime computes
+ * it the same way without a crypto module. Not a security hash.
+ */
+export declare function contentHash(input: string): string;
+/**
+ * The hash of a theme's content and of the stylesheet rendered from it: the
+ * cache key of the clients for the whole theme. A release that renders the
+ * same theme differently changes it by itself, with nothing to bump.
+ */
+export declare function brandingVersion(branding: Branding): string;
+/**
+ * Bumped whenever the icons rendered from a mark change: it is part of their
+ * URL, which is cached as immutable.
+ */
+export declare const BRANDING_ICON_REVISION = 1;
+/** Path of the public theme routes on the backend: the JSON, `.css` and the images. */
+export declare const BRANDING_PUBLIC_PATH = "/api/v1/public/branding";
+/** Path of a stored theme image on the backend, under `/api/v1`. */
+export declare const brandingAssetPath: (checksum: string) => string;
+/** Where a stored theme image is served, on a backend URL that may end in a slash. */
+export declare const brandingAssetUrl: (backendUrl: string, checksum: string) => string;
+/**
+ * Whether a request URL, query included, is one of the public theme routes:
+ * the JSON, the stylesheet, the web app manifest, the theme's icons, an image
+ * or an icon rendered from one. Anchored on each route, so a route that only
+ * shares the prefix is not one of them.
+ */
+export declare const isPublicBrandingRoute: (url: string) => boolean;
+/**
+ * The square icons rendered from an image: the favicon, the apple touch icon
+ * and the two of the installed app.
+ */
+export declare const BRANDING_ICON_SIZES: readonly [32, 180, 192, 512];
+export type BrandingIconSize = (typeof BRANDING_ICON_SIZES)[number];
+/**
+ * An icon of the theme: one of the sizes, or the installed app's maskable
+ * icon, 512 px and opaque, which a launcher crops to its own shape.
+ */
+export type BrandingThemeIcon = BrandingIconSize | 'maskable';
+/**
+ * Path of the theme's square icon: its mark, the neutral one of a renamed
+ * theme without a mark, or a redirect to the frontend's bundled icons.
+ */
+export declare const brandingThemeIconPath: (icon: BrandingThemeIcon) => string;
+/** Path of a square icon rendered from a stored image. */
+export declare const brandingIconPath: (checksum: string, size: BrandingIconSize) => string;
+/**
+ * The web app manifest of a theme, which the backend serves at
+ * `${BRANDING_PUBLIC_PATH}/manifest.webmanifest` to a frontend that reads its
+ * theme at runtime: the names, the description and the icons are the theme's.
+ * The app is the root of the frontend's origin, as in the build's manifest,
+ * written in full since the browser requires it on the page's origin; the
+ * icons are relative to the manifest, the theme's icon routes, under its
+ * version so a new theme is fetched again.
+ */
+export declare function brandingManifest(branding: ResolvedBranding, frontendUrl: string): {
+    start_url: string;
+    scope: string;
+    icons: {
+        src: string;
+        sizes: string;
+        type: string;
+        purpose: string;
+    }[];
+    description?: string | undefined;
+    id: string;
+    name: string;
+    short_name: string;
+    display: "standalone";
+    display_override: ("standalone" | "minimal-ui")[];
+    orientation: "portrait-primary";
+    dir: "ltr";
+    background_color: string;
+    theme_color: string;
+    categories: string[];
+};
+/** A theme with its version, as the endpoints serve it. */
+export declare function toResolvedBranding(branding: Branding): ResolvedBranding;
+/**
+ * The hash of the color rules of a theme's stylesheet, which the stylesheet
+ * declares as `--branding-stylesheet`: a page that knows the theme can tell
+ * whether the stylesheet a cache handed it is that theme's. It depends on the
+ * colors alone, like the rules.
+ */
+export declare const brandingStylesheetVersion: (branding: Branding) => string;
+/**
+ * The stylesheet of a theme: its color rules, see `brandingCssRules`, and the
+ * custom property that names them, see {@link brandingStylesheetVersion}.
+ */
+export declare function renderBrandingCss(branding: Branding): string;

package/dist-vue/packages/models/src/schema/Platform.d.ts

@@ -1,4 +1,12 @@
+import { BrandingText } from './Branding';
 import * as z from 'zod';
+/** The longest publisher name a Teams manifest accepts. */
+export declare const TEAMS_DEVELOPER_NAME_MAX_LENGTH = 32;
+/**
+ * The publisher a Teams app names when the admin leaves it empty: the
+ * deployment's company, or its product, cut to what Teams accepts.
+ */
+export declare const defaultTeamsDeveloperName: (text: BrandingText) => string;
 /**
  * Supported external messaging platforms.
  * Values are lowercase to match the Drizzle postgres enum convention.

package/dist-vue/packages/models/src/schema/PwaManifest.d.ts

@@ -0,0 +1,38 @@
+/**
+ * What every web app manifest of the frontend declares: the one its build
+ * writes, and the one the backend serves from the deployment theme to a build
+ * that reads its theme at runtime. Free of imports: the frontend's Vite config
+ * reads this file directly, since it cannot load the `models` package.
+ */
+export declare const PWA_MANIFEST_BASE: {
+    display: 'standalone';
+    display_override: ('standalone' | 'minimal-ui')[];
+    orientation: 'portrait-primary';
+    dir: 'ltr';
+    background_color: string;
+    theme_color: string;
+    categories: string[];
+};
+/** The icons of the installed app, as a manifest names them. */
+export type PwaIcon = 192 | 512 | 'maskable';
+/**
+ * The frontend's bundled icons, the default theme's, by the theme icon they
+ * stand for. The maskable one is opaque and keeps the mark inside the safe
+ * circle (80% of the side), since a launcher crops it to its own shape; it and
+ * the apple touch icon are derived from `pwa-512x512.png` with
+ * `pnpm --filter frontend pwa:icons`.
+ */
+export declare const PWA_BUNDLED_ICONS: {
+    readonly 32: "/favicon.svg";
+    readonly 180: "/apple-touch-icon.png";
+    readonly 192: "/pwa-192x192.png";
+    readonly 512: "/pwa-512x512.png";
+    readonly maskable: "/pwa-maskable-512x512.png";
+};
+/** The `icons` of a manifest, given where each one is served. */
+export declare const pwaManifestIcons: (src: (icon: PwaIcon) => string) => {
+    src: string;
+    sizes: string;
+    type: string;
+    purpose: string;
+}[];