@everfur/sdk 0.5.8 → 0.6.0

package/dist/{branding-Xb_wL8N1.d.cts → branding-DYWma2il.d.ts}

@@ -1,4 +1,80 @@
-import { c as EverfurThemeSlotName, b as EverfurFontFaceKey, d as EverfurThemeSlots } from './tokens-CIngRkvt.cjs';
+import { p as EverfurThemeSlotName, b as EverfurFontFaceKey, q as EverfurThemeSlots } from './tokens-ARWZtMOU.js';
+
+/** The presets an appearance may start from. `everfur` is the compiled default. */
+declare const APPEARANCE_PRESET_NAMES: readonly ["everfur", "minimal", "night"];
+type EverfurAppearancePreset = (typeof APPEARANCE_PRESET_NAMES)[number];
+/**
+ * The global variables, Stripe's names. Colours in any form `parseColor` reads; sizes as a number of px or a
+ * `'16px'` string. Each maps onto one flat branding field:
+ *   - `colorPrimary` -> `primary_color`, `colorAccent` -> `accent_color`
+ *   - `colorBackground` -> `background_color`, `colorText` -> `text_color` (the `_dark` twins under a dark scheme)
+ *   - `colorDanger` -> `danger_color` (`danger_color_dark` under a dark scheme)
+ *   - `fontFamily` -> `font_family`, `fontSizeBase` -> `font_size_base` (px, 12 to 20; the body size, default 14)
+ *   - `borderRadius` -> `border_radius` (px, 0 to 32; the medium corner, default 14)
+ *   - `spacingUnit` -> `spacing_unit` (px, 3 to 6; the smallest step, default 4)
+ *   - `colorScheme` -> `color_scheme` (`light`, `dark` or `auto`)
+ */
+interface EverfurAppearanceVariables {
+    readonly colorPrimary?: string | number;
+    readonly colorAccent?: string | number;
+    readonly colorBackground?: string | number;
+    readonly colorText?: string | number;
+    readonly colorDanger?: string | number;
+    readonly fontFamily?: string;
+    readonly fontSizeBase?: number | string;
+    readonly borderRadius?: number | string;
+    readonly spacingUnit?: number | string;
+    readonly colorScheme?: 'light' | 'dark' | 'auto' | string;
+}
+/**
+ * Per-component rules: the nine paint slots, each with the slot paint keys (camelCase or the wire's snake_case).
+ * Stripe's `.Class` selectors (`.Input`, `.Tab:hover`) are not slots and are ignored.
+ */
+type EverfurAppearanceRules = Readonly<Partial<Record<EverfurThemeSlotName, EverfurThemeSlotInput>>>;
+/** The Stripe-shaped appearance object: a preset, global variables, and per-slot rules. Every key optional. */
+interface EverfurAppearance {
+    readonly theme?: EverfurAppearancePreset | string;
+    readonly variables?: EverfurAppearanceVariables;
+    readonly rules?: EverfurAppearanceRules;
+}
+/**
+ * What each preset sets, as variables. Pinned by `contract/appearance/appearance_v1.json`, which EFBackend runs too,
+ * so a preset means the same thing in a partner's code and in the console.
+ */
+declare const APPEARANCE_PRESETS: Readonly<Record<EverfurAppearancePreset, EverfurAppearanceVariables>>;
+/** The accepted range of each size variable, in px. A value outside it is clamped by the parse (branding.ts). */
+declare const APPEARANCE_SIZE_RANGES: Readonly<{
+    fontSizeBase: Readonly<{
+        min: 12;
+        max: 20;
+        default: 14;
+    }>;
+    borderRadius: Readonly<{
+        min: 0;
+        max: 32;
+        default: 14;
+    }>;
+    spacingUnit: Readonly<{
+        min: 3;
+        max: 6;
+        default: 4;
+    }>;
+}>;
+/**
+ * A px size from a number or a `'16px'` / `'16'` / `'16 px'` string; else undefined (the parse drops it). The range
+ * clamp is the flat field's parse, so a size set flat and one set through `variables` are bounded by the same code.
+ *
+ * Linear on any input: the length is capped before the regex runs, the string is trimmed rather than matched with
+ * leading and trailing `\s*` runs, and no two adjacent parts of the pattern can match the same character (the old
+ * `\s*(px)?\s*$` shape backtracked quadratically on a long run of spaces).
+ */
+declare function parsePx(value: unknown): number | undefined;
+/**
+ * Expand an appearance into the flat branding record (snake_case wire keys) the resolver parses, or null when it
+ * sets nothing. Preset first, then `variables` over it, then `rules` as `slots`. Pure and total: any input is
+ * tolerated and nothing throws. The result is frozen.
+ */
+declare function expandAppearance(appearance: unknown): Readonly<Record<string, unknown>> | null;
 
 /**
  * One slot's paint on the `theme` prop; colours in any form `parseColor` reads, the radius in dp/px. The console's
@@ -14,7 +90,7 @@ interface EverfurThemeSlotInput {
     readonly textColor?: string | number;
     readonly text_color?: string | number;
 }
-/** The `slots` map on the `theme` prop: any subset of the eight slot names. */
+/** The `slots` map on the `theme` prop: any subset of the nine slot names. */
 type EverfurThemeSlotsInput = Readonly<Partial<Record<EverfurThemeSlotName, EverfurThemeSlotInput>>>;
 /**
  * The faces a theme names: the three text weights and the three mono weights (`EverfurFontFaceKey` on the tokens).
@@ -99,6 +175,38 @@ interface EverfurThemeInput {
     readonly accessibilityMaxFontScale?: number | string;
     /** Paint overrides at the named slots. */
     readonly slots?: EverfurThemeSlotsInput;
+    /**
+     * The Stripe-shaped way to set all of this: `{ theme, variables, rules }` (appearance.ts). It expands onto the
+     * flat keys of this same object, and a flat key written beside it wins: preset < variables < rules < flat keys.
+     */
+    readonly appearance?: EverfurAppearance;
+    /** The light palette's ground (surface, chat ground, page); the cream and subtle grounds derive from it. */
+    readonly background_color?: string | number;
+    readonly backgroundColor?: string | number;
+    /** The dark palette's ground; absent, the dark palette keeps Everfur's own. */
+    readonly background_color_dark?: string | number;
+    readonly backgroundColorDark?: string | number;
+    /** The light palette's body text, kept at 4.5:1 on every ground by the resolver. */
+    readonly text_color?: string | number;
+    readonly textColor?: string | number;
+    /** The dark palette's body text, guarded the same way. */
+    readonly text_color_dark?: string | number;
+    readonly textColorDark?: string | number;
+    /** Errors and destructive actions on the light palette (the dark twin is derived from it when unset), kept at 4.5:1. */
+    readonly danger_color?: string | number;
+    readonly dangerColor?: string | number;
+    /** Errors and destructive actions on the dark palette; absent, derived from `danger_color`. */
+    readonly danger_color_dark?: string | number;
+    readonly dangerColorDark?: string | number;
+    /** The body text size in px, 12 to 20 (clamped); every size scales from it. Default 14. */
+    readonly font_size_base?: number | string;
+    readonly fontSizeBase?: number | string;
+    /** The medium corner radius in px, 0 to 32 (clamped); every radius but the pill scales from it. Default 14. */
+    readonly border_radius?: number | string;
+    readonly borderRadius?: number | string;
+    /** The smallest spacing step in px, 3 to 6 (clamped); every step scales from it. Default 4. */
+    readonly spacing_unit?: number | string;
+    readonly spacingUnit?: number | string;
     /** Tolerated for any other key; ignored by the resolver. */
     readonly [key: string]: unknown;
 }
@@ -161,6 +269,30 @@ interface ClientBranding {
      * attribution.
      */
     readonly lockedFields?: readonly ThemeLockName[] | null;
+    /**
+     * background_color: the ground of the LIGHT palette (the surface, the chat ground, the page, the assistant reply),
+     * with the cream, subtle and ring grounds derived from it. Absent/null keeps Everfur's own grounds.
+     */
+    readonly backgroundColor?: string | null;
+    /** background_color_dark: the same on the dark palette. Absent/null keeps Everfur's dark grounds. */
+    readonly backgroundColorDark?: string | null;
+    /** text_color: the body text of the light palette; guarded at 4.5:1 on every ground. Absent/null keeps the base. */
+    readonly textColor?: string | null;
+    /** text_color_dark: the body text of the dark palette, guarded the same way. */
+    readonly textColorDark?: string | null;
+    /**
+     * danger_color: errors and destructive actions on the LIGHT palette; the dark palette derives its variant from
+     * it when `danger_color_dark` is absent (as EFBackend's fold does). Guarded at 4.5:1 on every ground it is drawn on.
+     */
+    readonly dangerColor?: string | null;
+    /** danger_color_dark: the same on the dark palette. Absent/null, it is derived from `danger_color`. */
+    readonly dangerColorDark?: string | null;
+    /** font_size_base: the body size in px (12..20, clamped); every type size scales by it over 14. */
+    readonly fontSizeBase?: number | null;
+    /** border_radius: the medium corner in px (0..32, clamped); every radius but the pill scales by it over 14. */
+    readonly borderRadius?: number | null;
+    /** spacing_unit: the smallest spacing step in px (3..6, clamped); every step scales by it over 4. */
+    readonly spacingUnit?: number | null;
     /**
      * schema_version: the wire version the branding was written for. null when absent (schema 1); 0 when present but
      * not a positive integer. A version this SDK does not know (`THEME_SCHEMA_VERSIONS`) drops the server branding.
@@ -175,7 +307,7 @@ type RadiusScale = 'sharp' | 'default' | 'round';
  * The wire names a tenant may list in `locked_fields` (every cosmetic field). `hide_powered_by` is not listed:
  * it is server-wins unconditionally, so locking it is meaningless.
  */
-declare const LOCKABLE_THEME_FIELDS: readonly ["display_name", "logo_url", "logo_url_dark", "primary_color", "accent_color", "primary_color_dark", "accent_color_dark", "brightness", "color_scheme", "font_family", "font_url", "fonts", "font_urls", "chat_placeholder", "surface_style", "radius_scale", "accessibility_max_font_scale", "slots"];
+declare const LOCKABLE_THEME_FIELDS: readonly ["display_name", "logo_url", "logo_url_dark", "primary_color", "accent_color", "primary_color_dark", "accent_color_dark", "brightness", "color_scheme", "font_family", "font_url", "fonts", "font_urls", "chat_placeholder", "surface_style", "radius_scale", "accessibility_max_font_scale", "slots", "background_color", "background_color_dark", "text_color", "text_color_dark", "danger_color", "danger_color_dark", "font_size_base", "border_radius", "spacing_unit"];
 type LockableThemeField = (typeof LOCKABLE_THEME_FIELDS)[number];
 /** The `locked_fields` key that locks one slot (`slots.<name>`), as EFBackend branding_slots.py emits it. */
 declare const SLOT_LOCK_PREFIX = "slots.";
@@ -209,4 +341,4 @@ declare const MAX_FONT_SCALE_CEILING = 3.1;
  */
 declare function hardenHttpsUrl(url: string | null): string | null;
 
-export { type ClientBranding as C, type EverfurThemeInput as E, LOCKABLE_THEME_FIELDS as L, MAX_FONT_SCALE_CEILING as M, type RadiusScale as R, type SurfaceStyle as S, THEME_SCHEMA_VERSIONS as T, type EverfurThemeFontFaceKey as a, type EverfurThemeFontUrlsInput as b, type EverfurThemeFontsInput as c, type EverfurThemeSlotInput as d, type EverfurThemeSlotsInput as e, type LockableThemeField as f, SLOT_LOCK_PREFIX as g, type SlotLockName as h, type ThemeLockName as i, hardenHttpsUrl as j, isEmptyBranding as k, isKnownBrandingSchema as l, lockedFieldsOf as m, parseClientBranding as p };
+export { APPEARANCE_PRESETS as A, type ClientBranding as C, type EverfurThemeInput as E, LOCKABLE_THEME_FIELDS as L, MAX_FONT_SCALE_CEILING as M, type RadiusScale as R, type SurfaceStyle as S, THEME_SCHEMA_VERSIONS as T, APPEARANCE_PRESET_NAMES as a, APPEARANCE_SIZE_RANGES as b, type EverfurAppearance as c, type EverfurAppearancePreset as d, type EverfurAppearanceRules as e, type EverfurAppearanceVariables as f, type EverfurThemeFontFaceKey as g, type EverfurThemeFontUrlsInput as h, type EverfurThemeFontsInput as i, type EverfurThemeSlotInput as j, type EverfurThemeSlotsInput as k, expandAppearance as l, type LockableThemeField as m, SLOT_LOCK_PREFIX as n, type SlotLockName as o, type ThemeLockName as p, hardenHttpsUrl as q, isEmptyBranding as r, isKnownBrandingSchema as s, lockedFieldsOf as t, parseClientBranding as u, parsePx as v };

package/dist/{casesRepository-s5EjE3Md.d.ts → casesRepository-BbgXYPxa.d.ts}

@@ -1,5 +1,5 @@
 import { E as EverfurResult } from './EverfurResult-SGvHKsCB.js';
-import { A as AuthContext } from './identity-vvueVndA.js';
+import { A as AuthContext } from './identity-B8rp0L9G.js';
 import { P as PetRef } from './ids-B2GAAifq.js';
 
 /** The owner's answer to a check-in, the wire values of the consumer `CheckinResponse` enum. */

package/dist/{casesRepository-C2gzlgJW.d.cts → casesRepository-Jj6t60AY.d.cts}

@@ -1,5 +1,5 @@
 import { E as EverfurResult } from './EverfurResult-ZtH-YV1h.cjs';
-import { A as AuthContext } from './identity-DczAiVsf.cjs';
+import { A as AuthContext } from './identity-D7PO5s9m.cjs';
 import { P as PetRef } from './ids-B2GAAifq.cjs';
 
 /** The owner's answer to a check-in, the wire values of the consumer `CheckinResponse` enum. */