@skdx/react 0.27.0 → 0.29.0

package/dist/utils/controllable.d.cts

@@ -0,0 +1,42 @@
+/**
+ * Whether two values are indistinguishable to a consumer, so no event is owed: `Object.is` for scalars, element-wise for the string arrays a selection carries.
+ *
+ * @param a the value now
+ * @param b the value proposed
+ */
+export declare function sameControlledValue(a: unknown, b: unknown): boolean;
+/** What the adapter currently holds on both sides of the controlled/uncontrolled split. */
+export interface ControllableState<T> {
+    /** The consumer's controlled value; `undefined` means the control owns its own value. */
+    controlled: T | undefined;
+    /** The value the adapter holds while uncontrolled; ignored once `controlled` is defined. */
+    uncontrolled: T | undefined;
+}
+/** What the adapter should do about a proposed change. */
+export interface ControllableDecision<T> {
+    /** The value in force after this decision — the proposal, or the current value when nothing changed. */
+    value: T | undefined;
+    /** Whether the adapter writes its own state; always `false` while controlled, since the consumer owns the value. */
+    write: boolean;
+    /** Whether the change event fires; only on an actual change, in both modes. */
+    emit: boolean;
+}
+/** The value in force: the controlled one when there is one, the adapter's own otherwise. */
+export declare function controllableValue<T>({ controlled, uncontrolled, }: ControllableState<T>): T | undefined;
+/** Whether the consumer owns the value, which is exactly "a controlled value was supplied". */
+export declare function isControlled<T>({ controlled }: ControllableState<T>): boolean;
+/**
+ * The decision for one proposed change.
+ *
+ * @param state what the adapter holds on both sides
+ * @param next the proposed value
+ * @returns the value in force, whether to write it, and whether to emit
+ */
+export declare function decideControllable<T>(state: ControllableState<T>, next: T | undefined): ControllableDecision<T>;
+/**
+ * The decision for a form reset, which restores `defaultValue` as it reads *now* — a consumer that changed the prop after mount expects the new default back, not the one the control was born with.
+ *
+ * @param state what the adapter holds on both sides
+ * @param liveDefault the `defaultValue` prop read at reset time
+ */
+export declare function decideReset<T>(state: ControllableState<T>, liveDefault: T | undefined): ControllableDecision<T>;

package/dist/utils/controllable.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Whether two values are indistinguishable to a consumer, so no event is owed: `Object.is` for scalars, element-wise for the string arrays a selection carries.
+ *
+ * @param a the value now
+ * @param b the value proposed
+ */
+export declare function sameControlledValue(a: unknown, b: unknown): boolean;
+/** What the adapter currently holds on both sides of the controlled/uncontrolled split. */
+export interface ControllableState<T> {
+    /** The consumer's controlled value; `undefined` means the control owns its own value. */
+    controlled: T | undefined;
+    /** The value the adapter holds while uncontrolled; ignored once `controlled` is defined. */
+    uncontrolled: T | undefined;
+}
+/** What the adapter should do about a proposed change. */
+export interface ControllableDecision<T> {
+    /** The value in force after this decision — the proposal, or the current value when nothing changed. */
+    value: T | undefined;
+    /** Whether the adapter writes its own state; always `false` while controlled, since the consumer owns the value. */
+    write: boolean;
+    /** Whether the change event fires; only on an actual change, in both modes. */
+    emit: boolean;
+}
+/** The value in force: the controlled one when there is one, the adapter's own otherwise. */
+export declare function controllableValue<T>({ controlled, uncontrolled, }: ControllableState<T>): T | undefined;
+/** Whether the consumer owns the value, which is exactly "a controlled value was supplied". */
+export declare function isControlled<T>({ controlled }: ControllableState<T>): boolean;
+/**
+ * The decision for one proposed change.
+ *
+ * @param state what the adapter holds on both sides
+ * @param next the proposed value
+ * @returns the value in force, whether to write it, and whether to emit
+ */
+export declare function decideControllable<T>(state: ControllableState<T>, next: T | undefined): ControllableDecision<T>;
+/**
+ * The decision for a form reset, which restores `defaultValue` as it reads *now* — a consumer that changed the prop after mount expects the new default back, not the one the control was born with.
+ *
+ * @param state what the adapter holds on both sides
+ * @param liveDefault the `defaultValue` prop read at reset time
+ */
+export declare function decideReset<T>(state: ControllableState<T>, liveDefault: T | undefined): ControllableDecision<T>;

package/dist/utils/controllable.js

@@ -0,0 +1,2 @@
+'use client';
+import{sameSelection as t}from"./selection.js";function o(e,n){return Object.is(e,n)?!0:!Array.isArray(e)||!Array.isArray(n)||!e.every(r=>typeof r=="string")||!n.every(r=>typeof r=="string")?!1:t(e,n)}function l({controlled:e,uncontrolled:n}){return e!==void 0?e:n}function i({controlled:e}){return e!==void 0}function u(e,n){let r=l(e);return o(r,n)?{value:r,write:!1,emit:!1}:{value:n,write:!i(e),emit:!0}}function f(e,n){return u(e,n)}export{l as controllableValue,u as decideControllable,f as decideReset,i as isControlled,o as sameControlledValue};

package/dist/utils/createContext.cjs

@@ -1 +1,2 @@
-"use strict";var l=Object.create;var i=Object.defineProperty;var C=Object.getOwnPropertyDescriptor;var R=Object.getOwnPropertyNames;var h=Object.getPrototypeOf,g=Object.prototype.hasOwnProperty;var v=(e,t)=>{for(var n in t)i(e,n,{get:t[n],enumerable:!0})},x=(e,t,n,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of R(t))!g.call(e,o)&&o!==n&&i(e,o,{get:()=>t[o],enumerable:!(r=C(t,o))||r.enumerable});return e};var w=(e,t,n)=>(n=e!=null?l(h(e)):{},x(t||!e||!e.__esModule?i(n,"default",{value:e,enumerable:!0}):n,e)),b=e=>x(i({},"__esModule",{value:!0}),e);var P={};v(P,{createSafeContext:()=>k});module.exports=b(P);var c=w(require("react"),1),f=require("react/jsx-runtime");function j(e,t){let n=Object.keys(e);return n.length!==Object.keys(t).length?!1:n.every(r=>r in t&&Object.is(e[r],t[r]))}function k(e,t){let n=c.createContext(t);function r(u){let{children:s,...a}=u,d=c.useRef(a);return j(d.current,a)||(d.current=a),(0,f.jsx)(n.Provider,{value:d.current,children:s})}r.displayName=`${e}Provider`;function o(u){let s=c.useContext(n);if(s!==void 0)return s;if(t!==void 0)return t;throw new Error(`[skandadx] \`${u}\` must be used within \`${e}\`.`)}return[r,o]}0&&(module.exports={createSafeContext});
+'use client';
+"use strict";var f=Object.create;var s=Object.defineProperty;var R=Object.getOwnPropertyDescriptor;var h=Object.getOwnPropertyNames;var g=Object.getPrototypeOf,v=Object.prototype.hasOwnProperty;var w=(e,t)=>{for(var n in t)s(e,n,{get:t[n],enumerable:!0})},x=(e,t,n,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of h(t))!v.call(e,o)&&o!==n&&s(e,o,{get:()=>t[o],enumerable:!(r=R(t,o))||r.enumerable});return e};var b=(e,t,n)=>(n=e!=null?f(g(e)):{},x(t||!e||!e.__esModule?s(n,"default",{value:e,enumerable:!0}):n,e)),j=e=>x(s({},"__esModule",{value:!0}),e);var y={};w(y,{createSafeContext:()=>k});module.exports=j(y);var c=b(require("react"),1),l=require("react/jsx-runtime");function V(e,t){let n=Object.keys(e);return n.length!==Object.keys(t).length?!1:n.every(r=>r in t&&Object.is(e[r],t[r]))}function k(e,t){let n=c.createContext(t);function r(i){let{children:u,...a}=i,d=c.useRef(a);return V(d.current,a)||(d.current=a),(0,l.jsx)(n.Provider,{value:d.current,children:u})}r.displayName=`${e}Provider`;function o(i){let u=c.useContext(n);if(u!==void 0)return u;if(t!==void 0)return t;throw new Error(`[skandadx] \`${i}\` must be used within \`${e}\`.`)}function C(){return c.useContext(n)??t}return[r,o,C]}0&&(module.exports={createSafeContext});

package/dist/utils/createContext.d.cts

@@ -1,14 +1,10 @@
 import * as React from 'react';
 /**
- * Creates a scoped `[Provider, useContext]` pair for a compound component's
- * internal state (e.g. `Tabs`'s selected value, shared with `TabsTrigger`
- * and `TabsContent`). Unlike raw `React.createContext`, the returned
- * `useContext(consumerName)` throws a descriptive error instead of silently
- * returning `undefined` when a part is rendered outside its root.
+ * Creates a scoped `[Provider, useContext]` pair for a compound component's internal state, whose `useContext(consumerName)` throws a descriptive error instead of silently returning `undefined` outside its root.
  *
  * @param rootComponentName - Name of the root component, used in the Provider's `displayName` and in error messages.
  * @param defaultValue - Optional fallback so the context also works without a Provider (rare; most compound components require one).
- * @returns A `[Provider, useContext]` tuple. `useContext` takes the *consuming* part's name so its error message names the right component.
+ * @returns A `[Provider, useContext, useOptionalContext]` tuple. `useContext` takes the *consuming* part's name so its error message names the right component; `useOptionalContext` returns `undefined` instead of throwing, for the rare part whose root is optional.
  *
  * @example
  * ```tsx
@@ -20,10 +16,13 @@ import * as React from 'react';
  * // in TabsTrigger.tsx
  * const context = useTabsContext('TabsTrigger'); // throws "`TabsTrigger` must be used within `Tabs`." if misused
  * ```
+ *
+ * @internal Not part of the public API; import it inside the package only.
  */
-export declare function createSafeContext<ContextValue extends object | null>(rootComponentName: string, defaultValue?: ContextValue): readonly [{
-    (props: ContextValue & {
+export declare function createSafeContext<ContextValue extends object | null>(rootComponentName: string, defaultValue?: ContextValue): readonly [
+    React.FC<ContextValue & {
         children: React.ReactNode;
-    }): React.JSX.Element;
-    displayName: string;
-}, (consumerName: string) => ContextValue];
+    }>,
+    (consumerName: string) => ContextValue,
+    () => ContextValue | undefined
+];

package/dist/utils/createContext.d.ts

@@ -1,14 +1,10 @@
 import * as React from 'react';
 /**
- * Creates a scoped `[Provider, useContext]` pair for a compound component's
- * internal state (e.g. `Tabs`'s selected value, shared with `TabsTrigger`
- * and `TabsContent`). Unlike raw `React.createContext`, the returned
- * `useContext(consumerName)` throws a descriptive error instead of silently
- * returning `undefined` when a part is rendered outside its root.
+ * Creates a scoped `[Provider, useContext]` pair for a compound component's internal state, whose `useContext(consumerName)` throws a descriptive error instead of silently returning `undefined` outside its root.
  *
  * @param rootComponentName - Name of the root component, used in the Provider's `displayName` and in error messages.
  * @param defaultValue - Optional fallback so the context also works without a Provider (rare; most compound components require one).
- * @returns A `[Provider, useContext]` tuple. `useContext` takes the *consuming* part's name so its error message names the right component.
+ * @returns A `[Provider, useContext, useOptionalContext]` tuple. `useContext` takes the *consuming* part's name so its error message names the right component; `useOptionalContext` returns `undefined` instead of throwing, for the rare part whose root is optional.
  *
  * @example
  * ```tsx
@@ -20,10 +16,13 @@ import * as React from 'react';
  * // in TabsTrigger.tsx
  * const context = useTabsContext('TabsTrigger'); // throws "`TabsTrigger` must be used within `Tabs`." if misused
  * ```
+ *
+ * @internal Not part of the public API; import it inside the package only.
  */
-export declare function createSafeContext<ContextValue extends object | null>(rootComponentName: string, defaultValue?: ContextValue): readonly [{
-    (props: ContextValue & {
+export declare function createSafeContext<ContextValue extends object | null>(rootComponentName: string, defaultValue?: ContextValue): readonly [
+    React.FC<ContextValue & {
         children: React.ReactNode;
-    }): React.JSX.Element;
-    displayName: string;
-}, (consumerName: string) => ContextValue];
+    }>,
+    (consumerName: string) => ContextValue,
+    () => ContextValue | undefined
+];

package/dist/utils/createContext.js

@@ -1 +1,2 @@
-import*as n from"react";import{jsx as x}from"react/jsx-runtime";function d(r,e){let o=Object.keys(r);return o.length!==Object.keys(e).length?!1:o.every(t=>t in e&&Object.is(r[t],e[t]))}function f(r,e){let o=n.createContext(e);function t(s){let{children:c,...i}=s,u=n.useRef(i);return d(u.current,i)||(u.current=i),x(o.Provider,{value:u.current,children:c})}t.displayName=`${r}Provider`;function a(s){let c=n.useContext(o);if(c!==void 0)return c;if(e!==void 0)return e;throw new Error(`[skandadx] \`${s}\` must be used within \`${r}\`.`)}return[t,a]}export{f as createSafeContext};
+'use client';
+import*as t from"react";import{jsx as l}from"react/jsx-runtime";function x(o,e){let n=Object.keys(o);return n.length!==Object.keys(e).length?!1:n.every(r=>r in e&&Object.is(o[r],e[r]))}function C(o,e){let n=t.createContext(e);function r(u){let{children:c,...s}=u,i=t.useRef(s);return x(i.current,s)||(i.current=s),l(n.Provider,{value:i.current,children:c})}r.displayName=`${o}Provider`;function a(u){let c=t.useContext(n);if(c!==void 0)return c;if(e!==void 0)return e;throw new Error(`[skandadx] \`${u}\` must be used within \`${o}\`.`)}function d(){return t.useContext(n)??e}return[r,a,d]}export{C as createSafeContext};

package/dist/utils/date-segments.cjs

@@ -0,0 +1,2 @@
+'use client';
+"use strict";var d=Object.defineProperty;var N=Object.getOwnPropertyDescriptor;var R=Object.getOwnPropertyNames;var $=Object.prototype.hasOwnProperty;var H=(e,n)=>{for(var t in n)d(e,t,{get:n[t],enumerable:!0})},V=(e,n,t,r)=>{if(n&&typeof n=="object"||typeof n=="function")for(let o of R(n))!$.call(e,o)&&o!==t&&d(e,o,{get:()=>n[o],enumerable:!(r=N(n,o))||r.enumerable});return e};var v=e=>V(d({},"__esModule",{value:!0}),e);var te={};H(te,{EMPTY_VALUE_TEXT:()=>G,SEGMENT_LABELS:()=>O,SEGMENT_PLACEHOLDERS:()=>b,buildSegments:()=>Y,clampValuesToTimeRange:()=>W,clearDateSegmentCache:()=>ne,dateRangeViolation:()=>ee,dateToFormValue:()=>s,dateToValues:()=>q,dayPeriodFromKey:()=>I,daysInMonth:()=>D,formatSegmentText:()=>E,from24Hour:()=>h,getDayPeriodNames:()=>y,isComplete:()=>X,parseDateFormValue:()=>J,resolveHourCycle:()=>T,resolveLocale:()=>m,segmentRange:()=>C,segmentStepFor:()=>Z,segmentTypesFor:()=>P,segmentValueNow:()=>j,stepSegment:()=>z,timeRangeViolation:()=>w,timeStepMismatch:()=>Q,timeStringToValues:()=>M,to24Hour:()=>p,typeDigit:()=>K,valuesToDate:()=>k,valuesToTimeString:()=>F});module.exports=v(te);var b={year:"yyyy",month:"mm",day:"dd",hour:"hh",minute:"mm",second:"ss",dayPeriod:"--"},G="Empty",O={year:"year",month:"month",day:"day",hour:"hour",minute:"minute",second:"second",dayPeriod:"AM/PM"},x={year:4,month:2,day:2,hour:2,minute:2,second:2,dayPeriod:0},L={...x,month:1,day:1,hour:1},A=Date.UTC(2024,0,15,13,45,56),g=new Map,f=new Map;function m(e){return e??new Intl.DateTimeFormat().resolvedOptions().locale}function T(e,n){if(n===12||n===24)return n;let t=new Intl.DateTimeFormat(m(e),{hour:"numeric"}).resolvedOptions(),r=t.hourCycle??(t.hour12?"h12":"h23");return r==="h11"||r==="h12"?12:24}function P(e,n){let t=e==="date"?["year","month","day"]:[];return(e==="time"||n!=="day")&&(t.push("hour","minute"),n==="second"&&t.push("second")),t}function D(e,n){return!e||!n?31:new Date(e,n,0).getDate()}function C(e,n,t){switch(e){case"year":return{min:1,max:9999};case"month":return{min:1,max:12};case"day":return{min:1,max:D(n.year,n.month)};case"hour":return t===12?{min:1,max:12}:{min:0,max:23};case"minute":case"second":return{min:0,max:59};case"dayPeriod":return{min:0,max:1}}}function y(e){let n=m(e),t=f.get(n);if(t)return t;let r=new Intl.DateTimeFormat(n,{hour:"numeric",hourCycle:"h12",timeZone:"UTC"}),o=i=>r.formatToParts(Date.UTC(2024,0,15,i)).find(l=>l.type==="dayPeriod")?.value??(i<12?"AM":"PM"),u=[o(1),o(13)];return f.set(n,u),u}function I(e,n){if([...e].length!==1)return null;let t=e.toLowerCase();if(t==="a")return 0;if(t==="p")return 1;let r=y(n),o=l=>{let a=[...l][0];return a!==void 0&&a.localeCompare(e,n,{sensitivity:"base"})===0},u=o(r[0]),i=o(r[1]);return u&&i?null:u?0:i?1:null}function _(e,n){let t={timeZone:"UTC"};return e.includes("year")&&(t.year="numeric"),e.includes("month")&&(t.month="2-digit"),e.includes("day")&&(t.day="2-digit"),e.includes("hour")&&(t.hour="2-digit",t.hourCycle=n===12?"h12":"h23"),e.includes("minute")&&(t.minute="2-digit"),e.includes("second")&&(t.second="2-digit"),t}function U(e,n,t){let r=`${e}|${n.join(",")}|${t}`,o=g.get(r);if(o)return o;let u=new Intl.DateTimeFormat(e,_(n,t)).formatToParts(A),i=[];for(let l of u)l.type==="literal"?i.push({type:"literal",text:l.value.replace(/[\u202F\u2009\u00A0]/g," "),value:null,min:0,max:0,isPlaceholder:!1,isEditable:!1}):(l.type==="dayPeriod"||n.includes(l.type))&&i.push({type:l.type,text:"",value:null,min:0,max:0,isPlaceholder:!0,isEditable:!0});return g.set(r,i),i}function E(e,n,t,r,o=!0){if(n===null)return r?.(e)??b[e];if(e==="dayPeriod")return y(t)[n===0?0:1];let u=o?x:L;return String(n).padStart(u[e],"0")}function Y(e){let n=m(e.locale),t=T(n,e.hourCycle),r=P(e.kind,e.granularity);return U(n,r,t).map(o=>{if(!o.isEditable)return o;let u=o.type,i=e.values[u]??null,{min:l,max:a}=C(u,e.values,t);return{type:u,text:E(u,i,n,e.getSegmentPlaceholder,e.shouldForceLeadingZeros??!0),value:i,min:l,max:a,isPlaceholder:i===null,isEditable:!0}})}function B(e){let n=new Date;switch(e.type){case"year":return n.getFullYear();case"hour":{let t=n.getHours();return e.min!==1?t:t%12===0?12:t%12}case"minute":return n.getMinutes();case"second":return n.getSeconds();case"dayPeriod":return n.getHours()<12?0:1;case"day":case"month":case"literal":return e.min}}function Z(e,n,t){let r=n==="second"?"second":"minute",o=n==="second"?1:60;if(e!==r||t===void 0||!Number.isFinite(t)||t<=0||t%o!==0)return 1;let u=t/o;return u<60?u:1}function z(e,n,t=1){let{min:r,max:o}=e;if(e.value===null)return r+Math.floor((B(e)-r)/t)*t;let u=Math.floor((o-r)/t)+1,i=e.value-r,l=(n>0?Math.floor(i/t):Math.ceil(i/t))+n;return r+(l%u+u)%u*t}function j(e){return Math.min(Math.max(e.value??e.min,e.min),e.max)}function K(e,n,t){let r=n*10+t;r>e.max&&(r=t);let o=r*10>e.max;return{value:r,buffer:o?0:r,advance:o}}function X(e){return e.every(n=>!n.isEditable||n.value!==null&&n.value>=n.min&&n.value<=n.max)}function p(e,n,t){return t===24?e:e%12+(n===1?12:0)}function h(e,n){return n===24?[e,null]:[e%12===0?12:e%12,e<12?0:1]}function k(e,n){let{year:t,month:r,day:o}=e;if(!t||!r||!o)return null;let u=e.hour==null?0:p(e.hour,e.dayPeriod,n),i=new Date(t,r-1,o,u,e.minute??0,e.second??0,0);return t<100&&i.setFullYear(t),i}function q(e,n){let[t,r]=h(e.getHours(),n);return{year:e.getFullYear(),month:e.getMonth()+1,day:e.getDate(),hour:t,minute:e.getMinutes(),second:e.getSeconds(),dayPeriod:r}}function F(e,n,t){if(e.hour==null||e.minute==null||t===12&&e.dayPeriod==null)return null;let r=i=>String(i).padStart(2,"0"),o=p(e.hour,e.dayPeriod,t),u=`${r(o)}:${r(e.minute)}`;return n!=="second"?u:e.second==null?null:`${u}:${r(e.second)}`}function M(e,n){let t=/^(\d{1,2}):(\d{2})(?::(\d{2}))?$/.exec(e.trim());if(!t)return{};let r=Number(t[1]),o=Number(t[2]),u=t[3]===void 0?0:Number(t[3]);if(r>23||o>59||u>59)return{};let[i,l]=h(r,n);return{hour:i,minute:o,second:u,dayPeriod:l}}function s(e,n){let t=(u,i=2)=>String(u).padStart(i,"0"),r=`${t(e.getFullYear(),4)}-${t(e.getMonth()+1)}-${t(e.getDate())}`;if(n==="day")return r;let o=`${t(e.getHours())}:${t(e.getMinutes())}`;return n==="second"?`${r}T${o}:${t(e.getSeconds())}`:`${r}T${o}`}function J(e){let n=/^(\d{4,})-(\d{2})-(\d{2})(?:T(\d{2}):(\d{2})(?::(\d{2}))?)?$/.exec(e.trim());if(!n)return null;let t=Number(n[1]),r=new Date(t,Number(n[2])-1,Number(n[3]),Number(n[4]??0),Number(n[5]??0),Number(n[6]??0));return t<100&&r.setFullYear(t),Number.isNaN(r.getTime())?null:r}function c(e){let n=/^(\d{1,2}):(\d{2})(?::(\d{2}))?$/.exec(e.trim());if(!n)return null;let t=r=>r.padStart(2,"0");return`${t(n[1])}:${n[2]}:${t(n[3]??"00")}`}function w(e,n,t){if(!e)return null;let r=c(e);if(r===null)return null;let o=n?c(n):null;if(o!==null&&r<o)return"underflow";let u=t?c(t):null;return u!==null&&r>u?"overflow":null}function S(e){let n=c(e);if(n===null)return null;let[t,r,o]=n.split(":").map(Number);return t*3600+r*60+o}function Q(e,n,t){if(!e||n===void 0||!Number.isFinite(n)||n<=0)return!1;let r=S(e);if(r===null)return!1;let o=(t===void 0?0:S(t))??0;return((r-o)%n+n)%n!==0}function W(e,n,t,r,o){let u=F(e,n,t),i=w(u,r,o);return i===null?e:{...e,...M(i==="underflow"?r:o,t)}}function ee(e,n,t,r){if(!e)return null;let o=s(e,n);return t&&o<s(t,n)?"underflow":r&&o>s(r,n)?"overflow":null}function ne(){g.clear(),f.clear()}0&&(module.exports={EMPTY_VALUE_TEXT,SEGMENT_LABELS,SEGMENT_PLACEHOLDERS,buildSegments,clampValuesToTimeRange,clearDateSegmentCache,dateRangeViolation,dateToFormValue,dateToValues,dayPeriodFromKey,daysInMonth,formatSegmentText,from24Hour,getDayPeriodNames,isComplete,parseDateFormValue,resolveHourCycle,resolveLocale,segmentRange,segmentStepFor,segmentTypesFor,segmentValueNow,stepSegment,timeRangeViolation,timeStepMismatch,timeStringToValues,to24Hour,typeDigit,valuesToDate,valuesToTimeString});

package/dist/utils/date-segments.d.cts

@@ -0,0 +1,223 @@
+/** One editable piece of a segmented date/time value. */
+export type SegmentType = 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second' | 'dayPeriod';
+/** How far down a segmented field is editable (no 'hour': would duplicate 'minute'). */
+export type Granularity = 'day' | 'minute' | 'second';
+/** Whether hours read `1`–`12` (with an AM/PM segment) or `0`–`23`. */
+export type HourCycle = 12 | 24;
+/** Current numeric value of each editable segment; `null` means "not typed yet". */
+export type SegmentValues = Partial<Record<SegmentType, number | null>>;
+/** One rendered piece of a segmented field — an editable segment or a locale literal. */
+export interface Segment {
+    /** The segment this piece edits, or `'literal'` for the text between segments. */
+    type: SegmentType | 'literal';
+    /** What to render: the padded value, the placeholder, or the literal itself. */
+    text: string;
+    /** Current numeric value; `null` for literals and for untyped segments. */
+    value: number | null;
+    /** Lowest accepted value (`0` for literals). */
+    min: number;
+    /** Highest accepted value (`0` for literals). Dynamic for `day`. */
+    max: number;
+    /** Whether this segment is still showing its placeholder. */
+    isPlaceholder: boolean;
+    /** `false` only for literals. */
+    isEditable: boolean;
+}
+/** Default placeholder text; unreachable by Intl and untranslatable by locale. */
+export declare const SEGMENT_PLACEHOLDERS: Record<SegmentType, string>;
+/** The `aria-valuetext` an untyped segment announces, so a spinbutton never reads a value the user did not enter. */
+export declare const EMPTY_VALUE_TEXT = "Empty";
+/** Accessible names for each segment type. */
+export declare const SEGMENT_LABELS: Record<SegmentType, string>;
+/** Localization strings for segmented date/time fields. */
+export interface SegmentedLabelProps {
+    /**
+     * Words the accessible name of each segment type.
+     * @default undefined — the built-in English names ('year', 'month', 'AM/PM', …).
+     */
+    getSegmentLabel?: ((type: SegmentType) => string | undefined) | undefined;
+    /**
+     * Aria text for untyped segments.
+     * @default 'Empty'
+     */
+    emptySegmentText?: string | undefined;
+    /**
+     * Words the placeholder for each segment.
+     * @default undefined — the built-in English letters ('yyyy', 'mm', 'dd', …).
+     */
+    getSegmentPlaceholder?: SegmentPlaceholderResolver | undefined;
+}
+/** The runtime's own locale, used whenever `locale` is omitted — matches `calendar-locale`'s `resolveLocale`. */
+export declare function resolveLocale(locale?: string): string;
+/**
+ * The hour cycle to render with: the explicit `hourCycle` when given, otherwise
+ * whatever the locale resolves to (`h11`/`h12` → `12`, `h23`/`h24` → `24`).
+ *
+ * @example
+ * ```ts
+ * resolveHourCycle('en-US'); // 12
+ * resolveHourCycle('de-DE'); // 24
+ * ```
+ */
+export declare function resolveHourCycle(locale?: string, hourCycle?: HourCycle): HourCycle;
+/**
+ * The editable segments a field of this kind and granularity owns, in canonical (not locale) order; `dayPeriod` is appended by {@link buildSegments} only when the resolved hour cycle is 12.
+ *
+ * @example
+ * ```ts
+ * segmentTypesFor('date', 'minute'); // ['year','month','day','hour','minute']
+ * segmentTypesFor('time', 'second'); // ['hour','minute','second']
+ * ```
+ */
+export declare function segmentTypesFor(kind: 'date' | 'time', granularity: Granularity): SegmentType[];
+/** Days in a Gregorian month; `31` while either input is unknown, so `day` stays fully typeable. */
+export declare function daysInMonth(year: number | null | undefined, month: number | null | undefined): number;
+/** The accepted range of one segment, given the values around it. */
+export declare function segmentRange(type: SegmentType, values: SegmentValues, hourCycle: HourCycle): {
+    min: number;
+    max: number;
+};
+/** The locale's AM and PM names, e.g. `['AM', 'PM']` or `['vorm.', 'nachm.']`. */
+export declare function getDayPeriodNames(locale?: string): [string, string];
+/** Converts a keystroke to day period index (0 AM, 1 PM, null if neither). */
+export declare function dayPeriodFromKey(key: string, locale?: string): number | null;
+/** Words the placeholder of one segment type; return the built-in {@link SEGMENT_PLACEHOLDERS} entry for the types you do not want to change. */
+export type SegmentPlaceholderResolver = (type: SegmentType) => string;
+/**
+ * How a segment renders: zero-padded digits, the locale's AM/PM name, or the
+ * placeholder.
+ *
+ * @param shouldForceLeadingZeros `false` renders a one-digit month, day or hour
+ * bare — see {@link SEGMENT_PAD_UNFORCED} for why those three and no others.
+ */
+export declare function formatSegmentText(type: SegmentType, value: number | null, locale?: string, getSegmentPlaceholder?: SegmentPlaceholderResolver, shouldForceLeadingZeros?: boolean): string;
+/** Options for {@link buildSegments}. */
+export interface BuildSegmentsOptions {
+    /** `'date'` adds year/month/day ahead of the time segments. */
+    kind: 'date' | 'time';
+    /** How far down the field is editable. */
+    granularity: Granularity;
+    /** BCP-47 locale deciding segment order, literals and AM/PM names. */
+    locale?: string | undefined;
+    /** Forced hour cycle; omitted means "whatever the locale uses". */
+    hourCycle?: HourCycle | undefined;
+    /** Current per-segment values. */
+    values: SegmentValues;
+    /** Words each segment's placeholder; omitted keeps the built-in English letters. */
+    getSegmentPlaceholder?: SegmentPlaceholderResolver | undefined;
+    /**
+     * Whether a one-digit month, day or hour renders zero-padded (`05`) or bare
+     * (`5`). Never touches `year`, `minute` or `second`.
+     * @default true
+     */
+    shouldForceLeadingZeros?: boolean | undefined;
+}
+/**
+ * The full ordered render list for a segmented field — editable segments
+ * interleaved with the locale's literals.
+ *
+ * @example
+ * ```ts
+ * buildSegments({ kind: 'date', granularity: 'day', locale: 'en-US', values: {} })
+ *   .filter((s) => s.isEditable)
+ *   .map((s) => s.type); // ['month', 'day', 'year']
+ * ```
+ */
+export declare function buildSegments(options: BuildSegmentsOptions): Segment[];
+/**
+ * How many units one Arrow press moves a segment, given the field-level `step` in seconds; drives only the finest rendered segment, falling back to `1` when `step` doesn't fit the grid.
+ *
+ * @example
+ * ```ts
+ * segmentStepFor('minute', 'minute', 900); // 15
+ * segmentStepFor('hour', 'minute', 900); // 1 — only the finest segment steps
+ * ```
+ */
+export declare function segmentStepFor(type: SegmentType, granularity: Granularity, step?: number): number;
+/**
+ * Stepper one segment by `delta`, wrapping around its range, snapping onto the `step` grid like a native stepper when `step` is past 1.
+ * @param step the segment's own step, from {@link segmentStepFor}
+ */
+export declare function stepSegment(segment: Segment, delta: number, step?: number): number;
+/** The `aria-valuenow` a segment publishes: its current value pulled back inside its own `aria-valuemin`/`aria-valuemax`, since mid-entry it can legitimately sit below minimum. */
+export declare function segmentValueNow(segment: Segment): number;
+/** The result of typing one digit into a segment. */
+export interface DigitEntry {
+    /** The segment's new value. May be below `min` mid-entry (typing `0` then `5` into a month). */
+    value: number;
+    /** Buffer to carry into the next keystroke on this segment; `0` once entry is complete. */
+    buffer: number;
+    /** Whether focus should move to the next editable segment. */
+    advance: boolean;
+}
+/**
+ * Types one digit into a segment: an overflowing keystroke restarts entry at that digit instead of being rejected, and focus advances once no further digit could fit.
+ *
+ * @param segment the segment being typed into
+ * @param buffer what has been typed into it so far (`0` when entry just started)
+ * @param digit the digit `0`–`9` just pressed
+ *
+ * @example
+ * ```ts
+ * // month, "1" already typed, user presses 5 → 15 overflows, restart at 5
+ * typeDigit(monthSegment, 1, 5); // { value: 5, buffer: 0, advance: true }
+ * ```
+ */
+export declare function typeDigit(segment: Segment, buffer: number, digit: number): DigitEntry;
+/** Whether every editable segment has been typed and sits inside its range. */
+export declare function isComplete(segments: Segment[]): boolean;
+/** Converts a possibly-12-hour `hour` plus `dayPeriod` into the 0-23 hour. */
+export declare function to24Hour(hour: number, dayPeriod: number | null | undefined, hourCycle: HourCycle): number;
+/** Converts a 0-23 hour into the `[hour, dayPeriod]` pair the given cycle renders. */
+export declare function from24Hour(hour: number, hourCycle: HourCycle): [number, number | null];
+/**
+ * The `Date` these segment values describe, in local time, or `null` while
+ * any date segment is still untyped; unowned time segments default to `0`,
+ * like `<input type="date">`.
+ */
+export declare function valuesToDate(values: SegmentValues, hourCycle: HourCycle): Date | null;
+/** Splits a `Date` back into segment values for the given hour cycle. */
+export declare function dateToValues(date: Date, hourCycle: HourCycle): SegmentValues;
+/**
+ * The `HH:mm` / `HH:mm:ss` string these segment values describe — always 24
+ * hour, like `<input type="time">`, regardless of the rendered `hourCycle` —
+ * or `null` while hour or minute is untyped.
+ */
+export declare function valuesToTimeString(values: SegmentValues, granularity: Granularity, hourCycle: HourCycle): string | null;
+/** Parses `HH:mm[:ss]` (24 hour) into segment values for the given hour cycle. Invalid input yields empty values. */
+export declare function timeStringToValues(time: string, hourCycle: HourCycle): SegmentValues;
+/** The `YYYY-MM-DD` / `YYYY-MM-DDTHH:mm[:ss]` string a segmented date field submits. */
+export declare function dateToFormValue(date: Date, granularity: Granularity): string;
+/**
+ * The inverse of {@link dateToFormValue}, built field by field rather than `new Date(string)`, which reads a bare `YYYY-MM-DD` as UTC midnight.
+ *
+ * @param value a string in the shape {@link dateToFormValue} produces
+ * @returns the local date, or `null` when the string is not one of those shapes
+ */
+export declare function parseDateFormValue(value: string): Date | null;
+/** Which side of a `min`/`max` bound a value falls outside, or `null` when it is in range. */
+export type RangeViolation = 'underflow' | 'overflow';
+/**
+ * Whether a `HH:mm[:ss]` time falls outside `min`/`max`, compared as strings
+ * (24-hour times sort chronologically when zero-padded).
+ *
+ * @param value the field's current wire value, or `null` while incomplete
+ * @param min the earliest accepted time, `HH:mm[:ss]`
+ * @param max the latest accepted time, `HH:mm[:ss]`
+ * @returns which bound was crossed, or `null` when in range
+ */
+export declare function timeRangeViolation(value: string | null | undefined, min?: string, max?: string): RangeViolation | null;
+/**
+ * Whether an `HH:mm[:ss]` time misses the `step` grid — the `stepMismatch` `<input type="time" step>` raises. Step counts seconds, anchored on `min` or midnight.
+ *
+ * @param value the field's current wire value, or `null` while incomplete
+ * @param step the field's step in seconds; non-positive or non-finite is no constraint
+ * @param min the step base — the same `min` the range check uses
+ */
+export declare function timeStepMismatch(value: string | null | undefined, step?: number, min?: string): boolean;
+/** Pulls segment values inside `min`/`max` bounds (Home/End only); arrow-stepping and typing deliberately do not clamp so out-of-bounds values stay reachable for validation. */
+export declare function clampValuesToTimeRange(values: SegmentValues, granularity: Granularity, hourCycle: HourCycle, min?: string, max?: string): SegmentValues;
+/** Whether a `Date` falls outside `minDate`/`maxDate`, compared at the field's `granularity` (a `day` field ignores time of day), string-compared via {@link dateToFormValue} to match the native input's behavior. */
+export declare function dateRangeViolation(value: Date | null | undefined, granularity: Granularity, minDate?: Date, maxDate?: Date): RangeViolation | null;
+/** @internal Drops every memoized `Intl` result. */
+export declare function clearDateSegmentCache(): void;