origam 2.2.1 → 2.5.0

package/dist/src/nuxt/plugin.server.js

@@ -0,0 +1,45 @@
+import { createOrigam } from "../origam.js";
+import { ORIGAM_THEME_AUTO, ORIGAM_THEME_DARK, ORIGAM_THEME_LIGHT } from "../consts/index.js";
+import { defineNuxtPlugin, useCookie, useHead, useRequestHeaders, useRuntimeConfig } from "#app";
+function resolveServerTheme(cookieValue, config, headers) {
+  if (cookieValue && cookieValue !== ORIGAM_THEME_AUTO) {
+    return cookieValue;
+  }
+  if (config.defaultTheme && config.defaultTheme !== ORIGAM_THEME_AUTO && cookieValue !== ORIGAM_THEME_AUTO) {
+    return config.defaultTheme;
+  }
+  const hint = headers["sec-ch-prefers-color-scheme"];
+  if (hint === ORIGAM_THEME_DARK) {
+    return config.themes.includes(ORIGAM_THEME_DARK) ? ORIGAM_THEME_DARK : config.themes[0] ?? ORIGAM_THEME_LIGHT;
+  }
+  return config.themes.includes(ORIGAM_THEME_LIGHT) ? ORIGAM_THEME_LIGHT : config.themes[0] ?? ORIGAM_THEME_LIGHT;
+}
+export default defineNuxtPlugin({
+  name: "origam:server",
+  enforce: "pre",
+  setup(nuxtApp) {
+    const runtimeConfig = useRuntimeConfig().public;
+    const config = runtimeConfig.origam;
+    const cookie = useCookie(config.cookieName, {
+      maxAge: config.cookieMaxAge,
+      sameSite: "lax",
+      path: "/"
+    });
+    const headers = useRequestHeaders(["sec-ch-prefers-color-scheme"]);
+    const resolved = resolveServerTheme(cookie.value, config, headers);
+    useHead({
+      htmlAttrs: {
+        "data-theme": resolved
+      }
+    });
+    const origam = createOrigam();
+    nuxtApp.vueApp.use(origam);
+    return {
+      provide: {
+        origam: {
+          theme: resolved
+        }
+      }
+    };
+  }
+});

package/dist/src/types/Audio/audio-controls.type.cjs

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

package/dist/src/types/Audio/audio-controls.type.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Controls rendering strategy for `<OrigamAudio>`.
+ *
+ * - `'custom'` (default): the component paints `<OrigamMediaController>`
+ *   on top of the `<audio>` element. The `<audio>` is rendered WITHOUT
+ *   the native `controls` attribute so the two UIs do not stack.
+ * - `'native'`: the `<audio>` element receives the native `controls`
+ *   attribute and the browser paints its own bar. No custom UI is
+ *   rendered. Useful when the platform's accessibility shortcuts
+ *   matter more than a unified visual identity.
+ */
+export type TAudioControls = 'custom' | 'native';

package/dist/src/types/Audio/audio-loop-mode.type.cjs

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

package/dist/src/types/Audio/audio-loop-mode.type.d.ts

@@ -0,0 +1,5 @@
+import { AUDIO_LOOP_MODE } from '../../enums';
+/**
+ * String-typed equivalent of {@link AUDIO_LOOP_MODE}.
+ */
+export type TAudioLoopMode = `${AUDIO_LOOP_MODE}`;

package/dist/src/types/Audio/audio-variant.type.cjs

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

package/dist/src/types/Audio/audio-variant.type.d.ts

@@ -0,0 +1,7 @@
+import { AUDIO_VARIANT } from '../../enums';
+/**
+ * String-typed equivalent of {@link AUDIO_VARIANT}. Lets callers pass
+ * literal `'normal' | 'minimal'` strings on the SFC prop API while the
+ * runtime still recognises the enum members.
+ */
+export type TAudioVariant = `${AUDIO_VARIANT}`;

package/dist/src/types/Audio/cover-position.type.cjs

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

package/dist/src/types/Audio/cover-position.type.d.ts

@@ -0,0 +1,6 @@
+import { COVER_POSITION } from '../../enums';
+/**
+ * String-typed equivalent of {@link COVER_POSITION}. Drives the
+ * `coverPosition` prop of `<OrigamAudio>`.
+ */
+export type TCoverPosition = `${COVER_POSITION}`;

package/dist/src/types/Blockquote/blockquote-align.type.cjs

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

package/dist/src/types/Blockquote/blockquote-align.type.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Horizontal alignment of the citation body. `pull` variant defaults to
+ * `'center'`; every other variant defaults to `'left'`.
+ */
+export type TBlockquoteAlign = 'left' | 'center' | 'right';

package/dist/src/types/Blockquote/blockquote-lang.type.cjs

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

package/dist/src/types/Blockquote/blockquote-lang.type.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Locale hint for `<OrigamBlockquote>` decorative quote marks. Only
+ * relevant for `variant="quoted"` — the other variants ignore the prop.
+ *
+ * - `'fr'`   — French guillemets : « … »
+ * - `'en'`   — Curly double quotes: “ … ”
+ * - `'es'`   — Spanish angular quotes: « … » (same glyphs as fr,
+ *              kept distinct so future tweaks — e.g. spanish prefers
+ *              corner marks ｢ ｣ in some fonts — can branch cleanly).
+ * - `'de'`   — German low-9 / high-6 pair: „ … “
+ * - `'auto'` — honour the consumer-provided `lang` attribute on the
+ *              element OR `<html lang>` if none. Falls back to `'en'`
+ *              when no locale is reachable.
+ *
+ * Resolution lives in `src/consts/Blockquote/blockquote.const.ts`
+ * (`QUOTE_MARKS_BY_LANG`).
+ */
+export type TBlockquoteLang = 'fr' | 'en' | 'es' | 'de' | 'auto';

package/dist/src/types/Blockquote/blockquote-variant.type.cjs

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

package/dist/src/types/Blockquote/blockquote-variant.type.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Visual variants for `<OrigamBlockquote>`. Each variant is a self
+ * contained typographic treatment; consumers do not mix them — pick the
+ * one that fits the surrounding content density.
+ *
+ * - `default`  — left accent bar + comfortable padding-inline. Neutral
+ *                rhythm, fits most prose contexts.
+ * - `elegant`  — serif face, italic, more breathing room. Editorial
+ *                long-form content (essays, articles).
+ * - `quoted`   — large decorative open/close marks (locale-aware,
+ *                see `TBlockquoteLang`). Marketing pages, hero quotes.
+ * - `minimal`  — bare italic + small indent. Inline citations inside
+ *                technical docs where the visual must stay quiet.
+ * - `pull`     — pull quote: large body type, centred, extracted out of
+ *                the flow. Use sparingly — one per article max.
+ */
+export type TBlockquoteVariant = 'default' | 'elegant' | 'quoted' | 'minimal' | 'pull';

package/dist/src/types/Bracket/bracket-direction.type.cjs

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

package/dist/src/types/Bracket/bracket-direction.type.d.ts

@@ -0,0 +1,13 @@
+import type { TDirection } from '../Commons/direction.type';
+/**
+ * Layout axis of the bracket tree.
+ *
+ * - `'horizontal'` — each round is a column, matches stack vertically
+ *   within the column, connectors flow left-to-right.
+ * - `'vertical'`   — each round is a row, matches lay out horizontally,
+ *   connectors flow top-to-bottom.
+ *
+ * Mirrors the global `TDirection` so the bracket plays nicely with the
+ * rest of the design system's direction props.
+ */
+export type TBracketDirection = TDirection;

package/dist/src/types/Bracket/bracket-match-status.type.cjs

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

package/dist/src/types/Bracket/bracket-match-status.type.d.ts

@@ -0,0 +1,2 @@
+import { BRACKET_MATCH_STATUS } from '../../enums';
+export type TBracketMatchStatus = `${BRACKET_MATCH_STATUS}`;

package/dist/src/types/Bracket/bracket-round-side.type.cjs

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

package/dist/src/types/Bracket/bracket-round-side.type.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Optional side marker for double-elimination tournaments.
+ *
+ * - `'winner'`       — round belongs to the winner bracket.
+ * - `'loser'`        — round belongs to the loser bracket.
+ * - `'grand-final'`  — single round that pits the winner of WB against
+ *                     the winner of LB.
+ *
+ * Single-elimination tournaments do not need to set this — leave it
+ * `undefined`.
+ */
+export type TBracketRoundSide = 'winner' | 'loser' | 'grand-final';

package/dist/src/types/Bracket/bracket-variant.type.cjs

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

package/dist/src/types/Bracket/bracket-variant.type.d.ts

@@ -0,0 +1,2 @@
+import { BRACKET_VARIANT } from '../../enums';
+export type TBracketVariant = `${BRACKET_VARIANT}`;

package/dist/src/types/Calendar/calendar-time-format.type.cjs

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

package/dist/src/types/Calendar/calendar-time-format.type.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Clock format for time labels in week / day / agenda views.
+ *
+ * `'24h'` — 00:00 → 23:59. Default for everywhere except en-US.
+ * `'12h'` — 12:00 AM → 11:59 PM. Honours locale-specific AM/PM.
+ */
+export type TCalendarTimeFormat = '12h' | '24h';
+/**
+ * Navigation direction passed to `useCalendar().navigate(...)` and
+ * the `navigate` event. `'today'` jumps to "now" regardless of the
+ * current view.
+ */
+export type TCalendarNavigate = 'prev' | 'next' | 'today';

package/dist/src/types/Calendar/calendar-view.type.cjs

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

package/dist/src/types/Calendar/calendar-view.type.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Top-level view modes supported by `<OrigamCalendar>`.
+ *
+ * - `'month'` — 6×7 day grid; the canonical "month at a glance" view.
+ * - `'week'`  — 7-column vertical timeline with one row per slot.
+ * - `'day'`   — single-column vertical timeline (zoom into one day).
+ * - `'agenda'`— flat list grouped by day, useful for screen readers
+ *               and dense schedules.
+ */
+export type TCalendarView = 'month' | 'week' | 'day' | 'agenda';

package/dist/src/types/Chart/chart-bullet-orientation.type.cjs

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

package/dist/src/types/Chart/chart-bullet-orientation.type.d.ts

@@ -0,0 +1 @@
+export type TChartBulletOrientation = 'horizontal' | 'vertical';

package/dist/src/types/Chart/chart-cartesian-kind.type.cjs

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

package/dist/src/types/Chart/chart-cartesian-kind.type.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Cartesian chart topology — the subset of `TChartType` that
+ * `<OrigamChartCartesian>` knows how to render. Each value implies
+ * a distinct path generator inside `useChart`:
+ *
+ * - `'line'`     — `linePath` with optional smoothing.
+ * - `'area'`     — `areaPath` (fill) + `linePath` (stroke) per series.
+ * - `'bar'`      — horizontal `<rect>` per data point.
+ * - `'column'`   — vertical `<rect>` per data point.
+ * - `'scatter'`  — `<circle>` per data point, no connecting path.
+ * - `'spline'`   — `linePath` forced to `smoothing='monotone'`.
+ * - `'stepped-line'` — staircase polyline (right-angle segments).
+ *
+ * Treated as a separate type rather than a re-export of
+ * `TChartType` because the family-level component only accepts
+ * this narrower subset — the SFC's `defineProps` enforces it.
+ */
+export type TChartCartesianKind = 'line' | 'area' | 'bar' | 'column' | 'scatter' | 'spline' | 'stepped-line';

package/dist/src/types/Chart/chart-honeycomb-color-mode.type.cjs

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

package/dist/src/types/Chart/chart-honeycomb-color-mode.type.d.ts

@@ -0,0 +1,2 @@
+import type { CHART_HONEYCOMB_COLOR_MODE } from '../../enums';
+export type TChartHoneycombColorMode = `${CHART_HONEYCOMB_COLOR_MODE}`;

package/dist/src/types/Chart/chart-honeycomb-orientation.type.cjs

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

package/dist/src/types/Chart/chart-honeycomb-orientation.type.d.ts

@@ -0,0 +1,2 @@
+import type { CHART_HONEYCOMB_ORIENTATION } from '../../enums';
+export type TChartHoneycombOrientation = `${CHART_HONEYCOMB_ORIENTATION}`;

package/dist/src/types/Chart/chart-item.type.cjs

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

package/dist/src/types/Chart/chart-item.type.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Loose item shape accepted by chart data arrays — either a raw
+ * primitive (string label / number value) or a `{ value }` object
+ * for richer descriptors. Consumers normalise via
+ * `IChartSeries.data` / `useChart`.
+ */
+export type TChartItem = string | number | {
+    value: number;
+};

package/dist/src/types/Chart/chart-legend-position.type.cjs

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

package/dist/src/types/Chart/chart-legend-position.type.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Anchor position of the legend block inside `<OrigamChart>`. The
+ * SVG plotting area shrinks or grows depending on the value — the
+ * flex layout in the SCSS handles the box arithmetic.
+ */
+export type TChartLegendPosition = 'top' | 'bottom' | 'left' | 'right';

package/dist/src/types/Chart/chart-map-mode.type.cjs

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

package/dist/src/types/Chart/chart-map-mode.type.d.ts

@@ -0,0 +1,8 @@
+import type { CHART_MAP_MODE } from '../../enums/Chart/chart-map-mode.enum';
+/**
+ * Rendering mode for `<OrigamChartMap>`.
+ *
+ * - `'choropleth'`    — country shapes coloured by data value.
+ * - `'flight-routes'` — curved arcs drawn between country pairs.
+ */
+export type TChartMapMode = `${CHART_MAP_MODE}`;

package/dist/src/types/Chart/chart-pictorial-direction.type.cjs

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

package/dist/src/types/Chart/chart-pictorial-direction.type.d.ts

@@ -0,0 +1 @@
+export type TChartPictorialDirection = 'vertical' | 'horizontal';

package/dist/src/types/Chart/chart-pictorial-mode.type.cjs

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

package/dist/src/types/Chart/chart-pictorial-mode.type.d.ts

@@ -0,0 +1 @@
+export type TChartPictorialMode = 'stack' | 'fill';

package/dist/src/types/Chart/chart-polar-kind.type.cjs

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

package/dist/src/types/Chart/chart-polar-kind.type.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Polar chart topology — the subset of `TChartType` that
+ * `<OrigamChartPolar>` knows how to render. Two values, two arc
+ * generators:
+ *
+ * - `'pie'`   — `arcPath` with `innerR = 0` (closed wedge).
+ * - `'donut'` — `arcPath` with `innerR > 0` (outer + inner arc).
+ *
+ * Polar charts deliberately don't render cartesian axes / grid —
+ * the family component lives in its own SFC for exactly that
+ * reason (the legacy `<OrigamChart>` shell painted axis lines
+ * behind pie/donut slices, which is the user's primary complaint).
+ */
+export type TChartPolarKind = 'pie' | 'donut';

package/dist/src/types/Chart/chart-pyramid-kind.type.cjs

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

package/dist/src/types/Chart/chart-pyramid-kind.type.d.ts

@@ -0,0 +1,9 @@
+import { CHART_PYRAMID_KIND } from '../../enums';
+/**
+ * The two rendering modes of the pyramid / funnel family.
+ *
+ * - `'pyramid'` — narrow at the top, widening toward the bottom.
+ * - `'funnel'`  — wide at the top, narrowing toward the bottom
+ *                 (classic conversion funnel shape).
+ */
+export type TChartPyramidKind = `${CHART_PYRAMID_KIND}`;

package/dist/src/types/Chart/chart-smoothing.type.cjs

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

package/dist/src/types/Chart/chart-smoothing.type.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Path smoothing strategy for `line` / `area` / `spline` charts.
+ *
+ * - `'none'`     — straight line segments between data points (default).
+ * - `'curve'`    — cubic Bezier between every pair of points using a
+ *                  tangent estimation a la Catmull-Rom. Visually
+ *                  smoother but slightly overshoots at sharp peaks.
+ * - `'monotone'` — monotone cubic interpolation (Fritsch-Carlson).
+ *                  Smooth like `'curve'` but guaranteed not to
+ *                  overshoot — what most "spline" demos show. Used
+ *                  as the implicit default for `type='spline'`.
+ *
+ * Note: `'stepped-line'` is a CHART_TYPE, not a smoothing value —
+ * staircase is a different topology (right-angle connections),
+ * not a curve choice. See `TChartCartesianKind`.
+ */
+export type TChartSmoothing = 'none' | 'curve' | 'monotone';

package/dist/src/types/Chart/chart-sparkline-kind.type.cjs

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

package/dist/src/types/Chart/chart-sparkline-kind.type.d.ts

@@ -0,0 +1,10 @@
+import { CHART_SPARKLINE_KIND } from '../../enums';
+/**
+ * The four rendering modes of the sparkline family.
+ *
+ * - `'line'`   — polyline connecting data points.
+ * - `'area'`   — line with a translucent fill below.
+ * - `'column'` — vertical bars (Y values mapped to height).
+ * - `'bar'`    — horizontal bars (Y values mapped to width).
+ */
+export type TChartSparklineKind = `${CHART_SPARKLINE_KIND}`;

package/dist/src/types/Chart/chart-stacking.type.cjs

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

package/dist/src/types/Chart/chart-stacking.type.d.ts

@@ -0,0 +1,9 @@
+import type { CHART_STACKING } from '../../enums';
+/**
+ * Stacking strategy for bar / column / area charts.
+ *
+ * - `'normal'`  — raw absolute values stacked on top of each other.
+ * - `'percent'` — each stack normalised to 100 %; Y-axis fixed
+ *                 `0 → 100`, tick labels show `${v}%`.
+ */
+export type TChartStacking = `${CHART_STACKING}`;

package/dist/src/types/Chart/chart-streamgraph-offset.type.cjs

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

package/dist/src/types/Chart/chart-streamgraph-offset.type.d.ts

@@ -0,0 +1 @@
+export type TChartStreamgraphOffset = 'wiggle' | 'silhouette' | 'expand' | 'zero';

package/dist/src/types/Chart/chart-treemap-algorithm.type.cjs

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

package/dist/src/types/Chart/chart-treemap-algorithm.type.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Treemap layout algorithm selector.
+ *
+ * - `'squarified'` — Bruls / Huijse / van Wijk squarified algorithm.
+ *   Tiles are laid out row by row, each row accumulates items while
+ *   their worst aspect ratio improves. Produces nearly-square tiles.
+ *
+ * - `'slice-dice'` — Alternates horizontal and vertical splits at
+ *   each recursion level (slice at even depth, dice at odd depth).
+ *   Tiles tend to be long and thin but preserve data order.
+ */
+export type TChartTreemapAlgorithm = 'squarified' | 'slice-dice';

package/dist/src/types/Chart/chart-type.type.cjs

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

package/dist/src/types/Chart/chart-type.type.d.ts

@@ -0,0 +1,7 @@
+import { CHART_TYPE } from '../../enums';
+/**
+ * Union of all visualisation primitives accepted by the chart family.
+ * Derives from `CHART_TYPE` so the enum stays the single source of
+ * truth.
+ */
+export type TChartType = `${CHART_TYPE}`;

package/dist/src/types/Chart/chart-word-cloud-rotation.type.cjs

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

package/dist/src/types/Chart/chart-word-cloud-rotation.type.d.ts

@@ -0,0 +1,8 @@
+import { CHART_WORD_CLOUD_ROTATION } from '../../enums/Chart/chart-word-cloud-rotation.enum';
+/**
+ * Word rotation mode for `<OrigamChartWordCloud>`.
+ * - `'none'`        — all words horizontal (0°).
+ * - `'random'`      — uniform random angle in [-30°, 30°].
+ * - `'orthogonal'`  — each word either 0° or 90° (parity-based for determinism).
+ */
+export type TChartWordCloudRotation = `${CHART_WORD_CLOUD_ROTATION}`;

package/dist/src/types/Code/code-lang.type.cjs

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

package/dist/src/types/Code/code-lang.type.d.ts

@@ -0,0 +1,2 @@
+import { CODE_LANG } from '../../enums';
+export type TCodeLang = `${CODE_LANG}`;

package/dist/src/types/Code/code-theme.type.cjs

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

package/dist/src/types/Code/code-theme.type.d.ts

@@ -0,0 +1,2 @@
+import { CODE_THEME } from '../../enums';
+export type TCodeTheme = `${CODE_THEME}`;

package/dist/src/types/CommandPalette/command-palette-hotkey.type.cjs

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

package/dist/src/types/CommandPalette/command-palette-hotkey.type.d.ts

@@ -0,0 +1,5 @@
+/**
+ * A normalised hotkey combination — array of canonical key tokens
+ * accepted by `useHotkey` (e.g. `['meta', 'k']`).
+ */
+export type TCommandPaletteHotkeyCombination = ReadonlyArray<string>;

package/dist/src/types/Commons/color.type.d.ts

@@ -1,4 +1,21 @@
-export type TColor = string | false | null | undefined;
+import type { IGradient } from '../../interfaces/Commons/gradient.interface';
+/**
+ * Accepted shapes for the `color` / `bgColor` / `textColor` props.
+ *
+ * Three input families, all supported transparently:
+ *
+ *   1. `string` — a {@link TIntent} (`'primary'`, `'success'`, …),
+ *      a raw CSS color (`'#ff00aa'`, `'rgb(…)'`, `'transparent'`),
+ *      a full CSS gradient (`'linear-gradient(…)'`, `'radial-gradient(…)'`,
+ *      `'conic-gradient(…)'`), or a preset name prefixed with
+ *      `gradient-` (e.g. `'gradient-sunset'`).
+ *   2. {@link IGradient} — structured gradient descriptor. The composable
+ *      resolves it to an inline `background-image: linear-gradient(…)` (or
+ *      radial / conic) declaration, with intent stops translated to their
+ *      respective design-token CSS variables.
+ *   3. `false | null | undefined` — opt-out (no color applied).
+ */
+export type TColor = string | IGradient | false | null | undefined;
 export type TXYZ = [number, number, number];
 export type TLAB = [number, number, number];
 export type THSVA = {

package/dist/src/types/EmptyState/empty-state-align.type.cjs

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