origam 2.3.0 → 2.6.1

package/dist/src/types/SliderField/slider-field-variant.type.d.ts

@@ -0,0 +1,10 @@
+import { SLIDER_FIELD_VARIANT } from '../../enums';
+/**
+ * Visual variant of `<OrigamSliderField>`. Drives the rendering path:
+ * - `'field'`  → wrapped in `<origam-input>` (label, messages, …).
+ * - `'timer'`  → bare wrapper, sober video-scrubber look.
+ * - `'audio'`  → bare wrapper + waveform background painted from `peaks`.
+ *
+ * Default is `'field'` (no behavioural break vs. Phase 1).
+ */
+export type TSliderFieldVariant = `${SLIDER_FIELD_VARIANT}`;

package/dist/src/types/Snackbar/snackbar-group-direction.type.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/src/types/{SnackbarStack/snackbar-stack-direction.type.d.ts → Snackbar/snackbar-group-direction.type.d.ts}

@@ -1,5 +1,5 @@
 /**
- * Stacking direction for `OrigamSnackbarStack`.
+ * Stacking direction for `OrigamSnackbarGroup`.
  *
  * - `top-down` — newest item appended at the bottom of the visible
  *   list (older items drift upward as the stack grows). Default for
@@ -8,4 +8,4 @@
  *   (older items drift downward). Default for locations anchored to
  *   the bottom edge.
  */
-export type TSnackbarStackDirection = 'top-down' | 'bottom-up';
+export type TSnackbarGroupDirection = 'top-down' | 'bottom-up';

package/dist/src/types/Snackbar/snackbar-group-location.type.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/src/types/{SnackbarStack/snackbar-stack-location.type.d.ts → Snackbar/snackbar-group-location.type.d.ts}

@@ -1,9 +1,9 @@
 /**
- * Anchor locations supported by `OrigamSnackbarStack`.
+ * Anchor locations supported by `OrigamSnackbarGroup`.
  *
  * Two-keyword strings (e.g. `'top-right'`) describe a corner, single
  * keyword strings (`'top'`, `'bottom'`) describe a viewport edge with
  * horizontal centering. Each location maps to a CSS pinning pair on
  * the stack root (`top` / `bottom` + `left` / `right` / centered).
  */
-export type TSnackbarStackLocation = 'top-left' | 'top-right' | 'top-center' | 'bottom-left' | 'bottom-right' | 'bottom-center' | 'top' | 'bottom';
+export type TSnackbarGroupLocation = 'top-left' | 'top-right' | 'top-center' | 'bottom-left' | 'bottom-right' | 'bottom-center' | 'top' | 'bottom';

package/dist/src/types/Snackbar/snackbar-group.type.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/src/types/Snackbar/snackbar-group.type.d.ts

@@ -0,0 +1,2 @@
+import type { OrigamSnackbarGroup } from "../../components";
+export type TOrigamSnackbarGroup = InstanceType<typeof OrigamSnackbarGroup>;

package/dist/src/types/TextMask/text-mask-animation.type.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/src/types/TextMask/text-mask-animation.type.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Animation strategy applied to the background painted under the
+ * `background-clip: text` mask.
+ *
+ *   - `pan`    — translate the gradient horizontally (default; great for
+ *                long horizontal `linear-gradient` ramps).
+ *   - `rotate` — rotate the background-image (best fit for `conic` gradients
+ *                where every angle is meaningful).
+ *   - `pulse`  — scale 1 → 1.2 → 1 (subtle breathing effect).
+ *   - `zoom`   — continuous scale 1 → 2 (cinematic "moving forward" feel).
+ *
+ * Every animation respects `prefers-reduced-motion: reduce` — the SCSS
+ * disables the keyframes entirely so users opting out of motion get a
+ * static painted text without flashes or transforms.
+ */
+export type TTextMaskAnimation = 'pan' | 'rotate' | 'pulse' | 'zoom';

package/dist/src/types/TextMask/text-mask.type.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/src/types/TextMask/text-mask.type.d.ts

@@ -0,0 +1,2 @@
+import { OrigamTextMask } from "../../components";
+export type TOrigamTextMask = InstanceType<typeof OrigamTextMask>;

package/dist/src/types/Theme/installed-theme.type.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/src/types/Theme/installed-theme.type.d.ts

@@ -0,0 +1,31 @@
+import type { TModeResolved } from './theme.type';
+/**
+ * Summary of one installed brand theme, derived from the `IOrigamTheme[]`
+ * objects passed to `createOrigam({ themes })`. Several `IOrigamTheme` objects
+ * may share the same `name` (one per mode); they are collapsed into a single
+ * entry whose `modes` lists every concrete mode that brand was installed for.
+ *
+ * Consumers (e.g. a theme switcher) map over this list instead of hard-coding
+ * the available brands — the list is the single source of truth for "what was
+ * installed".
+ */
+export interface TInstalledTheme {
+    /** Brand name, applied as `data-theme="<name>"`. */
+    name: string;
+    /** Concrete modes this brand ships (`'light'` / `'dark'`). */
+    modes: TModeResolved[];
+    /**
+     * Human-readable label for UI. Defaults to `name` when no installed object
+     * for this brand provided a `label`.
+     */
+    label: string;
+    /** Short description for UI, when an installed object provided one. */
+    description?: string;
+    /** CSS background for a brand swatch preview, when provided. */
+    swatch?: string;
+}
+/**
+ * The full installed-themes list provided by `createOrigam` and read back via
+ * `useInstalledThemes()`.
+ */
+export type TInstalledThemes = TInstalledTheme[];

package/dist/src/types/Theme/semantic-tree.type.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/src/types/Theme/semantic-tree.type.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Plain, hand-authored semantic tree — the NORMAL way to write an origam theme
+ * (ADR-004 DX). A node is either a bare value (`string | number`) or a nested
+ * group of further nodes. No DTCG `$value` ceremony, no `--origam-*` prefixes:
+ * you write intentions (`surface.default`, `text.secondary`, `action.primary.bg`)
+ * and the DS resolves each leaf path to its `--origam-*` CSS variable through the
+ * shared `tokenPathToCssVar` naming grammar.
+ *
+ * A leaf VALUE is free-form CSS for its slot:
+ *   - a color slot accepts any CSS color OR a gradient
+ *     (`'#171717'`, `'rgb(23,23,23)'`, `'hsl(...)'`, `'linear-gradient(...)'`),
+ *   - a dimension slot accepts any CSS length (`'0.5rem'`, `'8px'`, `0`),
+ *   - a duration/easing slot accepts the matching CSS value (`'200ms'`,
+ *     `'cubic-bezier(.4,0,.2,1)'`).
+ *
+ * Everything is plain JSON — fully serialisable, so a Theme Builder export can
+ * round-trip it without losing fidelity.
+ */
+export type TSemanticLeaf = string | number;
+export interface ISemanticTree {
+    [key: string]: TSemanticLeaf | ISemanticTree;
+}
+/**
+ * Structured token-configuration bucket — THE way to author a theme's global
+ * design tokens (the JSON that generates every global `--origam-*` variable).
+ *
+ * Each key is a friendly token GROUP whose nested tree resolves to the matching
+ * `--origam-*` namespace through the shared naming grammar:
+ *   - `color`   → `--origam-color-*`   (`color.surface.default`, `color.text.primary`, `color.action.primary.bg`, …)
+ *   - `rounded` → `--origam-radius-*`  (`rounded.sm`, `rounded.md`, `rounded.lg`, …)
+ *   - `border`  → `--origam-border-*`  (`border.width.thin`, …)
+ *   - `typo`    → `--origam-font-*`    (`typo.family.sans`, `typo.size.md`, `typo.weight.bold`, …)
+ *   - `shadow`  → `--origam-shadow-*`  (`shadow.sm`, `shadow.md`, …)
+ *   - `spacing` → `--origam-space-*`   (`spacing.4`, `spacing.12`, …)
+ *   - `motion`  → `--origam-motion-*`  (`motion.duration.fast`, `motion.easing.standard`, …)
+ *
+ * A leaf value is free-form CSS for its slot (a color slot also accepts a
+ * gradient). Plain JSON — fully serialisable for Theme-Builder round-trips.
+ */
+export interface IThemeVars {
+    color?: ISemanticTree;
+    rounded?: ISemanticTree;
+    border?: ISemanticTree;
+    typo?: ISemanticTree;
+    shadow?: ISemanticTree;
+    spacing?: ISemanticTree;
+    motion?: ISemanticTree;
+}

package/dist/src/types/Theme/theme.type.d.ts

@@ -1,11 +1,14 @@
 /**
- * Runtime theme name applied to `<html data-theme="…">` (or to a sub-tree
- * via `<OrigamThemeProvider>`).
+ * Runtime theme (brand) name applied to `<html data-theme="…">` (or to a
+ * sub-tree via `<OrigamThemeProvider>`).
  *
- * - `'auto'`  : no `data-theme` attribute set; the browser picks light/dark
- *               from `prefers-color-scheme`.
- * - `'light'` : default light theme.
- * - `'dark'`  : dark theme.
+ * The theme axis carries the **brand** identity (`'default'`, `'brand-a'`,
+ * …). It is orthogonal to the light/dark `mode` axis (`data-mode`).
+ *
+ * - `'auto'`  : no `data-theme` attribute set; children resolve against the
+ *               closest ancestor (or the default brand at document root).
+ * - `'light'` : legacy alias kept for back-compat (was the default brand).
+ * - `'dark'`  : legacy alias kept for back-compat.
  * - any other string is treated as a custom theme (e.g. `'brand-a'`) — the
  *   matching CSS file must be loaded by the consumer.
  */
@@ -16,3 +19,21 @@ export type TTheme = 'auto' | 'light' | 'dark' | (string & {});
  * effective theme (e.g. switching an SVG asset).
  */
 export type TThemeResolved = Exclude<TTheme, 'auto'>;
+/**
+ * Runtime color mode applied to `<html data-mode="…">` (or to a sub-tree
+ * via `<OrigamThemeProvider mode="…">`).
+ *
+ * The mode axis is orthogonal to the brand `theme` axis: any brand can be
+ * rendered in light or dark.
+ *
+ * - `'auto'`  : no `data-mode` attribute set; the browser/tokens pick
+ *               light/dark from `prefers-color-scheme`.
+ * - `'light'` : forced light mode.
+ * - `'dark'`  : forced dark mode.
+ */
+export type TMode = 'auto' | 'light' | 'dark';
+/**
+ * Concrete (resolved) mode — what `data-mode` actually equals after
+ * resolving `'auto'` against `prefers-color-scheme`.
+ */
+export type TModeResolved = Exclude<TMode, 'auto'>;

package/dist/src/types/Theme/token-tree.type.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/src/types/Theme/token-tree.type.d.ts

@@ -0,0 +1,10 @@
+/**
+ * A fully-resolved theme variable map: CSS custom-property name → value.
+ * This is what `resolveThemeVars` produces and what the `cssVars` escape hatch
+ * accepts. Keys may be supplied with or without the leading `--`; `createOrigam`
+ * normalises them.
+ *
+ *   { '--origam-color__action--primary---bg': '#7c3aed' }
+ *   { 'origam-radius---md': '0.5rem' }
+ */
+export type TThemeVars = Record<string, string | number>;

package/dist/src/types/Video/video-controls.type.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/src/types/Video/video-controls.type.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Controls rendering strategy for `<OrigamVideo>`.
+ *
+ * - `'custom'` (default): the component paints its own toolbar with
+ *   play/pause, scrubber, volume, captions, PIP and fullscreen buttons.
+ *   The `<video>` element is rendered WITHOUT the native `controls`
+ *   attribute so the two UIs do not stack.
+ * - `'native'`: the `<video>` element receives the native `controls`
+ *   attribute and the browser paints its own toolbar. No custom UI is
+ *   rendered. Useful when the consumer needs the platform-specific
+ *   accessibility shortcuts (e.g. AirPlay button on Safari) or when
+ *   rendering inside a Tauri shell that talks to native players.
+ * - `'none'`: neither the custom nor the native toolbar is rendered.
+ *   The consumer drives playback programmatically through the
+ *   `#controls` slot or the exposed composable methods.
+ */
+export type TVideoControls = 'custom' | 'native' | 'none';

package/dist/src/types/Video/video-track-kind.type.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/src/types/Video/video-track-kind.type.d.ts

@@ -0,0 +1,11 @@
+/**
+ * `kind` attribute of a WebVTT `<track>` element. We expose the four
+ * values that are useful in a player UI — `'metadata'` is left out
+ * because it is invisible by design and meant for programmatic
+ * consumption only (out of scope for the default toolbar's caption
+ * switcher).
+ *
+ * See https://html.spec.whatwg.org/multipage/media.html#attr-track-kind
+ * for the full list of legal values.
+ */
+export type TVideoTrackKind = 'captions' | 'subtitles' | 'descriptions' | 'chapters';