origam 2.3.0 → 2.6.1

package/dist/src/interfaces/TextField/text-field.interface.d.ts

@@ -53,7 +53,7 @@ export interface ITextFieldSlots extends IFieldSlots, Omit<IInputSlots, 'default
         id: string;
         isDisabled: boolean;
         isDirty: boolean;
-        isValid: boolean;
+        isValid: boolean | undefined;
         isReadonly: boolean;
     }) => any;
 }

package/dist/src/interfaces/TextMask/text-mask.interface.cjs

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

package/dist/src/interfaces/TextMask/text-mask.interface.d.ts

@@ -0,0 +1,86 @@
+import type { ICommonsComponentProps, IGradient, ITagProps, ITypographyProps } from '../../interfaces';
+import type { TBlockquoteAlign, TTextMaskAnimation } from '../../types';
+/**
+ * Props for `<OrigamTextMask>` — typographic "window" component.
+ *
+ * Paints arbitrary text (or rich slot content) as a transparent fill
+ * over an animated background, leveraging `background-clip: text`. The
+ * background can be:
+ *
+ *   - a structured {@link IGradient} object (intent-aware, theme-aware),
+ *   - a raw CSS gradient string (`linear-gradient(...)`, `radial-gradient(...)`,
+ *     `conic-gradient(...)`),
+ *   - a preset name (`gradient-sunset`, `gradient-ocean`, …) resolved to
+ *     `var(--origam-gradient---{slug})`,
+ *   - an `url(...)` value pointing at an image, video poster or data-URL.
+ *
+ * The text content is preserved in the DOM (visible to screen readers
+ * and search engines) — the visual transform is purely CSS.
+ *
+ * Typography is handled via the shared {@link ITypographyProps} surface:
+ * pass token keys (`fontSize="5xl"`, `fontWeight="black"`, …) to override
+ * the component's default values; when a prop is unset the SCSS fallback
+ * token (`--origam-text-mask---font-size-default`, …) stays in control.
+ */
+export interface ITextMaskProps extends ICommonsComponentProps, ITagProps, ITypographyProps {
+    /**
+     * Text to mask. Ignored when the `default` slot is provided.
+     *
+     * Rich markup (e.g. multi-line headlines, inline `<span>` overrides)
+     * should go through the slot instead.
+     */
+    text?: string;
+    /**
+     * Background painted behind the text glyphs. REQUIRED.
+     *
+     * Accepts:
+     *   - A structured {@link IGradient} object — resolved via
+     *     `resolveGradient()` and emitted as a `linear|radial|conic-gradient`
+     *     CSS function call. Stops can reference intents (`primary`,
+     *     `success`, …) — the resolver swaps them for token-driven CSS
+     *     variables, so the gradient re-tints automatically when the
+     *     theme changes.
+     *   - A raw CSS gradient string (`linear-gradient(...)`, …) — emitted
+     *     verbatim.
+     *   - A preset name (`gradient-sunset`, etc.) — resolves to the
+     *     matching `--origam-gradient---{slug}` CSS variable.
+     *   - Any other string — used as a raw `background-image` value
+     *     (typical: `url(/hero.jpg)` for an image, `url(data:...)` for an
+     *     inline asset).
+     */
+    background: string | IGradient;
+    /**
+     * Animate the background. Combined with `animationType` to pick a
+     * keyframe set.
+     *
+     * @default false
+     */
+    animated?: boolean;
+    /**
+     * Duration of one animation cycle. Accepts any CSS `<time>` value
+     * (`'3s'`, `'750ms'`, …). Forwarded to `animation-duration`.
+     *
+     * @default '3s'
+     */
+    animationDuration?: string;
+    /**
+     * Animation strategy. See {@link TTextMaskAnimation}.
+     *
+     * @default 'pan'
+     */
+    animationType?: TTextMaskAnimation;
+    /**
+     * `text-align` of the masked content.
+     *
+     * @default 'left'
+     */
+    align?: TBlockquoteAlign;
+}
+/**
+ * Slot signatures for `<OrigamTextMask>`. The `default` slot wins over
+ * the `text` prop and accepts arbitrary markup (multiple lines, nested
+ * `<h1>` / `<span>` / `<em>` …).
+ */
+export interface ITextMaskSlots {
+    default?: () => any;
+}

package/dist/src/interfaces/TextareaField/textarea-field.interface.d.ts

@@ -1,6 +1,6 @@
-import type { IAdjacentInnerProps, IBorderProps, IColorProps, ICommonsComponentProps, IDensityProps, IElevationProps, IFieldEmits, IFieldProps, IFieldSlots, IInputEmits, IInputProps, IInputSlots, IMarginProps, IPaddingProps, IRoundedProps, ITextareaToolbarSlotProps } from '../../interfaces';
+import type { IAdjacentInnerProps, IBorderProps, IColorProps, ICommonsComponentProps, IDensityProps, IElevationProps, IFieldEmits, IFieldProps, IFieldSlots, IInputEmits, IInputProps, IInputSlots, IMarginProps, IPaddingProps, IRoundedProps, ITextareaToolbarSlotProps, ITypographyProps } from '../../interfaces';
 import type { TTextareaMode, TTextareaOutput, TTextareaToolbarCommand, TTextareaToolbarPosition } from '../../types';
-export interface ITextareaFieldProps extends ICommonsComponentProps, IColorProps, IDensityProps, IFieldProps, IInputProps, IPaddingProps, IMarginProps, IBorderProps, IRoundedProps, IElevationProps, IAdjacentInnerProps {
+export interface ITextareaFieldProps extends ICommonsComponentProps, IColorProps, IDensityProps, IFieldProps, IInputProps, IPaddingProps, IMarginProps, IBorderProps, IRoundedProps, IElevationProps, IAdjacentInnerProps, ITypographyProps {
     autoGrow?: boolean;
     autofocus?: boolean;
     counter?: boolean | number | string;
@@ -65,7 +65,7 @@ export interface ITextareaFieldSlots extends IFieldSlots, Omit<IInputSlots, 'def
         id: string;
         isDisabled: boolean;
         isDirty: boolean;
-        isValid: boolean;
+        isValid: boolean | undefined;
         isReadonly: boolean;
     }) => any;
     /** Replace the rich-text toolbar entirely (rich mode only). */

package/dist/src/interfaces/Theme/origam-theme.interface.cjs

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

package/dist/src/interfaces/Theme/origam-theme.interface.d.ts

@@ -0,0 +1,114 @@
+import type { IThemeVars, TThemeVars } from '../../types';
+import type { TMode } from '../../types/Theme/theme.type';
+import type { IDefault } from '../DefaultProvider/default-provider.interface';
+/**
+ * Runtime theme object ingested by `createOrigam({ themes })`. At install time
+ * the DS resolves it to a block of `--origam-*` CSS variables injected into
+ * `<head>`, scoped to `:root` (or `[data-theme="<name>"]` when `name` is set,
+ * optionally narrowed by `[data-mode]` when `mode` is set).
+ *
+ * ## A theme has exactly THREE authoring surfaces
+ *
+ * 1. **`vars`** — the design tokens (the normal path). Plain nested JSON keyed
+ *    by token GROUP (`color` / `rounded` / `border` / `typo` / `shadow` /
+ *    `spacing` / `motion`). No `--origam-*` prefixes, no DTCG ceremony: the DS
+ *    walks each tree and derives the CSS-variable name from the leaf path, so a
+ *    hand-written theme resolves to the EXACT same `--origam-*` names as the
+ *    published token sheets.
+ *
+ * 2. **`cssVars`** — the escape hatch. A flat map of raw `--origam-*` custom
+ *    properties, for the rare var that has no group slot in `vars`.
+ *
+ * 3. **`component`** — per-component DEFAULT PROPS (not CSS): `{ global, 'origam-btn', … }`.
+ *
+ * ```ts
+ * {
+ *   name: 'sobre', mode: 'light', label: 'Sobre',
+ *   vars: {
+ *     color:   { surface: { default: '#ffffff' }, text: { primary: '#171717', secondary: '#525252' },
+ *                action: { primary: { bg: '#7c3aed', fg: '#ffffff' } } },
+ *     rounded: { md: '10px', lg: '14px' },
+ *     typo:    { family: { sans: 'Inter, sans-serif' } },
+ *     shadow:  { md: '0 2px 8px rgba(0,0,0,.12)' }
+ *   },
+ *   components: { 'origam-btn': { variant: 'flat', color: 'primary' } }
+ * }
+ * ```
+ *
+ * A COLOR slot accepts any CSS color OR a gradient (a gradient is an ordinary
+ * color value). Everything is plain JSON so a Theme Builder export round-trips
+ * without loss.
+ */
+export interface IOrigamTheme {
+    /**
+     * Brand name. When set, the injected variables are scoped to
+     * `[data-theme="<name>"]` instead of `:root`, so the theme activates only
+     * when `data-theme` matches (set it via `useTheme().setTheme(name)`).
+     */
+    name?: string;
+    /**
+     * Color mode this variable block applies to. When set alongside `name`,
+     * the selector becomes `[data-theme="<name>"][data-mode="<mode>"]`. When
+     * set without `name`, it becomes `[data-mode="<mode>"]`.
+     */
+    mode?: TMode;
+    /**
+     * Human-readable brand label for UI (e.g. a theme switcher). Falls back to
+     * `name` when absent. Surfaced through `useInstalledThemes()`.
+     */
+    label?: string;
+    /**
+     * Short brand description for UI (e.g. a switcher subtitle). Surfaced
+     * through `useInstalledThemes()`.
+     */
+    description?: string;
+    /**
+     * CSS background value for a brand swatch preview (a solid color or a
+     * `linear-gradient(...)`). Surfaced through `useInstalledThemes()` so a
+     * switcher can render a preview without a hard-coded metadata map.
+     */
+    swatch?: string;
+    /**
+     * THE token-configuration bucket — the normal way to author a theme's
+     * design tokens. Nested JSON keyed by token GROUP; each group's tree
+     * resolves to its `--origam-*` namespace via the shared naming grammar
+     * (see `IThemeVars`):
+     *   - `color`   → `--origam-color-*`   (`color.surface.default`, `color.action.primary.bg`, …)
+     *   - `rounded` → `--origam-radius-*`  (`rounded.md`, `rounded.lg`, …)
+     *   - `border`  → `--origam-border-*`  (`border.width.thin`, …)
+     *   - `typo`    → `--origam-font-*`    (`typo.family.sans`, `typo.size.md`, …)
+     *   - `shadow`  → `--origam-shadow-*`  (`shadow.md`, …)
+     *   - `spacing` → `--origam-space-*`   (`spacing.4`, …)
+     *   - `motion`  → `--origam-motion-*`  (`motion.duration.fast`, …)
+     *
+     * A color leaf accepts any CSS color OR a gradient (no dedicated gradient group).
+     */
+    vars?: IThemeVars;
+    /**
+     * ESCAPE HATCH — pre-resolved raw `--origam-*` custom-property map. Keys
+     * with or without the leading `--` are accepted. Use ONLY for a raw var
+     * that has no group slot in `vars`. Wins over `vars` on key collision.
+     *
+     *   cssVars: { '--origam-some-unmapped-var': '...' }
+     */
+    cssVars?: TThemeVars;
+    /**
+     * Per-component DEFAULT PROPS layer. Keyed by `global` (applies to every
+     * component) or by a component's kebab-case instance name (e.g.
+     * `'origam-btn'`, `'origam-card'`), exactly like `<OrigamDefaultsProvider>`.
+     *
+     * `createOrigam` collapses the `component` maps of the ACTIVE brand×mode
+     * themes into a single `IDefault` and provides it under
+     * `ORIGAM_DEFAULTS_KEY`, so a component rendered with no explicit prop
+     * inherits the theme's default. This is the "look comes from the theme,
+     * not from hard-coded `withDefaults`" mechanism.
+     *
+     * @example
+     * components: {
+     *   global:        { density: 'comfortable' },
+     *   'origam-btn':  { color: 'primary', rounded: 0 },
+     *   'origam-card': { rounded: 'lg', elevation: 2 }
+     * }
+     */
+    components?: IDefault;
+}

package/dist/src/interfaces/Timeline/timeline.interface.d.ts

@@ -37,7 +37,7 @@ export interface ITimelineProps extends ICommonsComponentProps, ITagProps, IColo
     truncateLine?: boolean;
     ariaLabel?: string;
 }
-export interface ITimelineItemProps extends ICommonsComponentProps, IColorProps {
+export interface ITimelineItemProps extends ICommonsComponentProps, IColorProps, IDensityProps, ISizeProps {
     title?: string;
     subtitle?: string;
     icon?: TIcon;

package/dist/src/interfaces/Title/title.interface.d.ts

@@ -1,4 +1,4 @@
-import type { IBorderProps, IBgColorProps, IColorProps, ICommonsComponentProps, IDensityProps, IMarginProps, IPaddingProps, ITagProps } from '../../interfaces';
-export interface ITitleProps extends ITagProps, ICommonsComponentProps, IColorProps, IBgColorProps, IDensityProps, IPaddingProps, IMarginProps, IBorderProps {
+import type { IBorderProps, IBgColorProps, IColorProps, ICommonsComponentProps, IDensityProps, IMarginProps, IPaddingProps, ITagProps, ITypographyProps } from '../../interfaces';
+export interface ITitleProps extends ITagProps, ICommonsComponentProps, IColorProps, IBgColorProps, IDensityProps, IPaddingProps, IMarginProps, IBorderProps, ITypographyProps {
     text?: string;
 }

package/dist/src/interfaces/Toolbar/toolbar.interface.d.ts

@@ -1,5 +1,5 @@
-import type { IActiveProps, IBgColorProps, IBorderProps, IColorProps, ICommonsComponentProps, IDensityProps, IDimensionProps, IElevationProps, IHoverProps, IMarginProps, IPaddingProps, IPositionProps, IRoundedProps, ITagProps } from '../../interfaces';
-export interface IToolbarProps extends ITagProps, ICommonsComponentProps, IBorderProps, IRoundedProps, IElevationProps, IDensityProps, IColorProps, IBgColorProps, IPaddingProps, IMarginProps, IPositionProps, IDimensionProps, IActiveProps, IHoverProps {
+import type { IActiveProps, IBgColorProps, IBorderProps, IColorProps, ICommonsComponentProps, IDensityProps, IDimensionProps, IElevationProps, IHoverProps, IMarginProps, IPaddingProps, IPositionProps, IRoundedProps, ITagProps, ITypographyProps } from '../../interfaces';
+export interface IToolbarProps extends ITagProps, ICommonsComponentProps, IBorderProps, IRoundedProps, IElevationProps, IDensityProps, IColorProps, IBgColorProps, IPaddingProps, IMarginProps, IPositionProps, IDimensionProps, IActiveProps, IHoverProps, ITypographyProps {
     collapse?: boolean;
     flat?: boolean;
     floating?: boolean;

package/dist/src/interfaces/Tooltip/tooltip.interface.d.ts

@@ -1,5 +1,8 @@
-import type { IActivatorProps, IBgColorProps, IColorProps, ICommonsComponentProps, IDimensionProps, ILazyProps, ILocationStrategyProps, IOverlayProps, IScrimProps, IScrollStrategyProps, ITransitionComponentProps } from '../../interfaces';
-export interface ITooltipProps extends ICommonsComponentProps, IOverlayProps, IColorProps, IBgColorProps, IDimensionProps, IActivatorProps, ILocationStrategyProps, IScrollStrategyProps, ILazyProps, ITransitionComponentProps, IScrimProps {
+import type { IActivatorProps, IBgColorProps, IColorProps, ICommonsComponentEmits, ICommonsComponentProps, IDimensionProps, ILazyProps, ILocationStrategyProps, IOverlayProps, IScrimProps, IScrollStrategyProps, ITransitionComponentProps, ITypographyProps } from '../../interfaces';
+export interface ITooltipProps extends ICommonsComponentProps, IOverlayProps, IColorProps, IBgColorProps, IDimensionProps, IActivatorProps, ILocationStrategyProps, IScrollStrategyProps, ILazyProps, ITransitionComponentProps, IScrimProps, ITypographyProps {
     id?: string;
     text?: string;
 }
+/** Emits fired by `<OrigamTooltip>` — v-model on the open state. */
+export interface ITooltipEmits extends ICommonsComponentEmits {
+}

package/dist/src/interfaces/Video/video-track.interface.cjs

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

package/dist/src/interfaces/Video/video-track.interface.d.ts

@@ -0,0 +1,76 @@
+import type { TVideoTrackKind } from '../../types';
+/**
+ * A single `<track>` declaration attached to the `<video>` element.
+ * Mirrors the HTML attributes of the native element 1:1 so consumers
+ * don't have to learn a new shape — pass the same dictionary they'd
+ * pass to a vanilla `<video>` markup.
+ *
+ * The component renders one `<track>` per item, and the custom captions
+ * toggle picks the first item whose `default` is true; the user can
+ * then cycle through the others via the in-toolbar dropdown.
+ */
+export interface IVideoTrack {
+    /**
+     * `kind` of the track. `'captions'` is the default — used by the
+     * built-in captions switcher. `'subtitles'` is treated the same way
+     * for switching purposes; `'descriptions'` and `'chapters'` are
+     * declared but not surfaced in the default toolbar (consumers
+     * needing those expose their own `#controls` slot).
+     */
+    kind: TVideoTrackKind;
+    /**
+     * URL of the WebVTT file. Same-origin or CORS-enabled, otherwise
+     * the browser silently rejects the track.
+     */
+    src: string;
+    /**
+     * BCP-47 language tag — `'en'`, `'fr'`, `'pt-BR'`, … Drives the
+     * language label shown in the captions switcher and is exposed to
+     * assistive technology via the underlying `<track srclang>`.
+     */
+    srclang: string;
+    /**
+     * Human-readable label shown in the switcher (`"English"`,
+     * `"Français"`, …). Defaults to the uppercased `srclang` when
+     * omitted.
+     */
+    label?: string;
+    /**
+     * Marks this track as the one to enable on load. At most one track
+     * per kind should be flagged — if multiple are passed, the first
+     * one wins.
+     */
+    default?: boolean;
+}
+/**
+ * A single `<source>` entry when the consumer passes multiple media
+ * URLs (typically one `mp4` + one `webm` so the browser picks whichever
+ * codec it can decode).
+ */
+export interface IVideoSource {
+    /** Absolute or root-relative URL to the media file. */
+    src: string;
+    /**
+     * MIME type — `"video/mp4"`, `"video/webm"`, `"application/vnd.apple.mpegurl"`
+     * for HLS, etc. Optional but recommended: it lets the browser skip
+     * sources it can't decode without a network round-trip.
+     */
+    type?: string;
+    /**
+     * Quality identifier used to group multiple sources of the same
+     * content at different resolutions / bitrates (e.g. `"1080p"`,
+     * `"720p"`, `"480p"`, `"4K"`, `"auto"`).
+     *
+     * When ≥ 2 sources expose distinct `quality` values, OrigamVideo
+     * shows a "Quality" entry in the settings (cog) menu and lets the
+     * user swap between them. The currently-playing source is then
+     * matched on `quality` rather than on codec.
+     */
+    quality?: string;
+    /**
+     * Optional human-readable label override for the quality switcher
+     * menu. Defaults to the `quality` value when not provided. Use
+     * this for cases like `quality: "auto"` rendered as `"Auto (720p)"`.
+     */
+    label?: string;
+}

package/dist/src/interfaces/Video/video.interface.cjs

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