origam 2.14.0 → 2.15.0

package/dist/src/types/Sheet/sheet.type.d.ts

@@ -1,2 +1,24 @@
 import { OrigamSheet } from "../../components";
 export type TOrigamSheet = InstanceType<typeof OrigamSheet>;
+/**
+ * Sheet bottom-swipe snap-point typings.
+ *
+ * The bottom-sheet pattern (see `OrigamSheet` with `swipeable + side="bottom"`)
+ * relies on a discrete set of "snap" heights the gesture composable will
+ * settle on at the end of every drag. These types describe that contract.
+ *
+ * - `TSheetSnapId` — well-known id strings the component understands by
+ *   default (`closed`, `peek`, `half`, `full`). It also accepts arbitrary
+ *   strings so brand integrations can extend the set without forking.
+ * - `TSheetSnapPoint` — a `{ id, height }` tuple. Heights may be a number
+ *   (interpreted as px) or any CSS length (`'120px'`, `'50vh'`, `'90%'`).
+ *
+ * Use site: `OrigamSheet`, `sheetSwipe.composable.ts`,
+ * `sheetSwipe.composable.spec.ts`, the `Bottom — swipeable` story Variant
+ * and `tests/e2e/sheet.spec.ts`.
+ */
+export type TSheetSnapId = 'closed' | 'peek' | 'half' | 'full' | (string & {});
+export type TSheetSnapPoint = {
+    id: TSheetSnapId;
+    height: number | string;
+};

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

@@ -1,4 +1,14 @@
+import { SLIDER_FIELD_VARIANT } from '../../enums';
 import { OrigamSliderField } from '../../components';
+/**
+ * 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}`;
 export type TAlways = boolean | 'always';
 export type TSliderData = {
     value: number;

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

@@ -1,2 +1,22 @@
 import type { OrigamSnackbarGroup } from "../../components";
 export type TOrigamSnackbarGroup = InstanceType<typeof OrigamSnackbarGroup>;
+/**
+ * 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
+ *   locations anchored to the top edge.
+ * - `bottom-up` — newest item appears at the top of the visible list
+ *   (older items drift downward). Default for locations anchored to
+ *   the bottom edge.
+ */
+export type TSnackbarGroupDirection = 'top-down' | 'bottom-up';
+/**
+ * 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 TSnackbarGroupLocation = 'top-left' | 'top-right' | 'top-center' | 'bottom-left' | 'bottom-right' | 'bottom-center' | 'top' | 'bottom';

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

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

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

@@ -0,0 +1,2 @@
+import { OrigamSnackbarItem } from '../../components';
+export type TOrigamSnackbarItem = InstanceType<typeof OrigamSnackbarItem>;

package/dist/src/types/Stepper/stepper.type.d.ts

@@ -1,5 +1,11 @@
 import type { OrigamStepper, OrigamStepperItem } from '../../components';
+import type { TDirection } from '../Commons/direction.type';
 export type TOrigamStepper = InstanceType<typeof OrigamStepper>;
 export type TOrigamStepperItem = InstanceType<typeof OrigamStepperItem>;
-export type TStepperOrientation = 'horizontal' | 'vertical';
+/**
+ * Layout axis of `<OrigamStepper>`. Mirrors the global `TDirection` so
+ * the stepper plays nicely with the rest of the design system's
+ * direction props.
+ */
+export type TStepperOrientation = TDirection;
 export type TStepperItemStatus = 'pending' | 'active' | 'done' | 'error';

package/dist/src/types/Tabs/tab.type.d.ts

@@ -1,2 +1,4 @@
+import { TAB_VARIANT } from '../../enums';
 import { OrigamTab } from '../../components';
+export type TTabVariant = `${TAB_VARIANT}`;
 export type TOrigamTab = InstanceType<typeof OrigamTab>;

package/dist/src/types/TextField/text-field.type.d.ts

@@ -1,4 +1,44 @@
+import type { BUILT_IN_PATTERN, PATTERN_VALIDATOR } from '../../enums';
+import type { IMaskOptions } from '../../interfaces';
 import { OrigamTextField } from '../../components';
 import { TEXT_FIELD_TYPE } from "../../enums";
 export type TTextFieldType = `${TEXT_FIELD_TYPE}`;
 export type TOrigamTextField = InstanceType<typeof OrigamTextField>;
+/**
+ * Discriminated union of every curated mask preset shipped
+ * with origam. New presets must be added to
+ * `BUILT_IN_PATTERN` AND `BUILT_IN_PATTERNS` (const map).
+ */
+export type TBuiltInPattern = typeof BUILT_IN_PATTERN[keyof typeof BUILT_IN_PATTERN];
+/**
+ * Accepted value for the `OrigamTextField.mask` prop and the
+ * `useMask` first arg. Either a built-in preset key, a raw
+ * pattern string (with `#`, `A`, `*`, literals), or a full
+ * options object.
+ */
+export type TMask = TBuiltInPattern | string | IMaskOptions | null;
+/**
+ * Token kinds recognised by the in-house token-walker.
+ *
+ * - `digit`    : consumer slot, accepts `[0-9]` only.    (`#`)
+ * - `letter`   : consumer slot, accepts `[a-zA-Z]` only. (`A`)
+ * - `any`      : consumer slot, accepts any character.   (`*`)
+ * - `literal`  : emitted as-is, does NOT consume the
+ *                input character.
+ */
+export type TMaskTokenKind = 'digit' | 'letter' | 'any' | 'literal';
+/**
+ * Built-in validator name (string) — recognised by
+ * `validatePattern`.
+ */
+export type TPatternValidatorName = typeof PATTERN_VALIDATOR[keyof typeof PATTERN_VALIDATOR];
+/**
+ * User-supplied validator function — receives the UNMASKED
+ * value and returns `true` if it passes business rules.
+ */
+export type TPatternValidatorFn = (unmasked: string) => boolean;
+/**
+ * Validator passed to `useMask` / accepted by `resolveMaskConfig`.
+ * Either a registered name, or an arbitrary function.
+ */
+export type TPatternValidator = TPatternValidatorName | TPatternValidatorFn;

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

@@ -1,2 +1,18 @@
 import { OrigamTextMask } from "../../components";
 export type TOrigamTextMask = InstanceType<typeof OrigamTextMask>;
+/**
+ * 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/TextareaField/textarea-field.type.d.ts

@@ -1,2 +1,5 @@
+import type { TEXTAREA_MODE, TEXTAREA_OUTPUT } from '../../enums';
 import { OrigamTextareaField } from "../../components";
 export type TOrigamTextareaField = InstanceType<typeof OrigamTextareaField>;
+export type TTextareaMode = `${TEXTAREA_MODE}`;
+export type TTextareaOutput = `${TEXTAREA_OUTPUT}`;

package/dist/src/types/ThemeProvider/theme-provider.type.cjs

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

package/dist/src/types/ThemeProvider/theme-provider.type.d.ts

@@ -0,0 +1,2 @@
+import { OrigamThemeProvider } from '../../components';
+export type TOrigamThemeProvider = InstanceType<typeof OrigamThemeProvider>;

package/dist/src/types/Timeline/timeline.type.d.ts

@@ -1,5 +1,11 @@
 import type { OrigamTimeline, OrigamTimelineItem } from '../../components';
+import type { TDirection } from '../Commons/direction.type';
 export type TOrigamTimeline = InstanceType<typeof OrigamTimeline>;
 export type TOrigamTimelineItem = InstanceType<typeof OrigamTimelineItem>;
 export type TTimelineSide = 'start' | 'end' | 'alternating';
-export type TTimelineOrientation = 'vertical' | 'horizontal';
+/**
+ * Layout axis of `<OrigamTimeline>`. Mirrors the global `TDirection` so
+ * the timeline plays nicely with the rest of the design system's
+ * direction props.
+ */
+export type TTimelineOrientation = TDirection;

package/dist/src/types/Transition/reverse-translate-picker.type.cjs

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

package/dist/src/types/Transition/reverse-translate-picker.type.d.ts

@@ -0,0 +1,2 @@
+import { OrigamReverseTranslatePicker } from '../../components';
+export type TOrigamReverseTranslatePicker = InstanceType<typeof OrigamReverseTranslatePicker>;

package/dist/src/types/Transition/translate-picker.type.cjs

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

package/dist/src/types/Transition/translate-picker.type.d.ts

@@ -0,0 +1,2 @@
+import { OrigamTranslatePicker } from '../../components';
+export type TOrigamTranslatePicker = InstanceType<typeof OrigamTranslatePicker>;

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

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

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

@@ -0,0 +1,35 @@
+import { OrigamVideo } from '../../components';
+import type { TControlsSource } from '../Commons/controls.type';
+export type TOrigamVideo = InstanceType<typeof OrigamVideo>;
+/**
+ * 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.
+ *
+ * Full range of the Commons `TControlsSource` (see
+ * `Commons/controls.type.ts`) — mirrors `TAudioControls`, which is the
+ * `custom | native` subset (Audio has no `none`).
+ */
+export type TVideoControls = TControlsSource;
+/**
+ * `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';

package/dist/src/types/Watermark/watermark.type.cjs

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

package/dist/src/types/Watermark/watermark.type.d.ts

@@ -0,0 +1,2 @@
+import { OrigamWatermark } from '../../components';
+export type TOrigamWatermark = InstanceType<typeof OrigamWatermark>;