foldkit 0.59.0 → 0.61.0

package/dist/ui/calendar/index.d.ts

@@ -0,0 +1,242 @@
+import { Option, Schema as S } from 'effect';
+import * as Calendar from '../../calendar';
+import type { CalendarDate } from '../../calendar';
+import * as Command from '../../command';
+import { type Attribute, type Html } from '../../html';
+/** Schema for the calendar component's state. Tracks the visible month/year,
+ * the keyboard-focused and user-selected dates, and the configuration that
+ * governs navigation (locale, min/max, disabled days). */
+export declare const Model: S.Struct<{
+    id: typeof S.String;
+    today: S.filter<S.Struct<{
+        year: typeof S.Int;
+        month: S.filter<typeof S.Int>;
+        day: S.filter<typeof S.Int>;
+    }>>;
+    viewYear: typeof S.Int;
+    viewMonth: S.filter<typeof S.Int>;
+    maybeFocusedDate: S.OptionFromSelf<S.filter<S.Struct<{
+        year: typeof S.Int;
+        month: S.filter<typeof S.Int>;
+        day: S.filter<typeof S.Int>;
+    }>>>;
+    maybeSelectedDate: S.OptionFromSelf<S.filter<S.Struct<{
+        year: typeof S.Int;
+        month: S.filter<typeof S.Int>;
+        day: S.filter<typeof S.Int>;
+    }>>>;
+    isGridFocused: typeof S.Boolean;
+    locale: S.Struct<{
+        firstDayOfWeek: S.Literal<["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]>;
+        monthNames: S.Tuple<[typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String]>;
+        shortMonthNames: S.Tuple<[typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String]>;
+        dayNames: S.Tuple<[typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String]>;
+        shortDayNames: S.Tuple<[typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String, typeof S.String]>;
+    }>;
+    maybeMinDate: S.OptionFromSelf<S.filter<S.Struct<{
+        year: typeof S.Int;
+        month: S.filter<typeof S.Int>;
+        day: S.filter<typeof S.Int>;
+    }>>>;
+    maybeMaxDate: S.OptionFromSelf<S.filter<S.Struct<{
+        year: typeof S.Int;
+        month: S.filter<typeof S.Int>;
+        day: S.filter<typeof S.Int>;
+    }>>>;
+    disabledDaysOfWeek: S.Array$<S.Literal<["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]>>;
+    disabledDates: S.Array$<S.filter<S.Struct<{
+        year: typeof S.Int;
+        month: S.filter<typeof S.Int>;
+        day: S.filter<typeof S.Int>;
+    }>>>;
+}>;
+export type Model = typeof Model.Type;
+/** Sent when the user clicks a day cell in the grid. */
+export declare const ClickedDay: import("../../schema").CallableTaggedStruct<"ClickedDay", {
+    date: S.filter<S.Struct<{
+        year: typeof S.Int;
+        month: S.filter<typeof S.Int>;
+        day: S.filter<typeof S.Int>;
+    }>>;
+}>;
+/** Sent when the user presses a key on the grid container. The update maps
+ * the key to a navigation or selection action. */
+export declare const PressedKeyOnGrid: import("../../schema").CallableTaggedStruct<"PressedKeyOnGrid", {
+    key: typeof S.String;
+    isShift: typeof S.Boolean;
+}>;
+/** Sent when the user clicks the previous-month navigation button. */
+export declare const ClickedPreviousMonthButton: import("../../schema").CallableTaggedStruct<"ClickedPreviousMonthButton", {}>;
+/** Sent when the user clicks the next-month navigation button. */
+export declare const ClickedNextMonthButton: import("../../schema").CallableTaggedStruct<"ClickedNextMonthButton", {}>;
+/** Sent when the user picks a month from the month dropdown. */
+export declare const SelectedMonthFromDropdown: import("../../schema").CallableTaggedStruct<"SelectedMonthFromDropdown", {
+    month: typeof S.Int;
+}>;
+/** Sent when the user picks a year from the year dropdown. */
+export declare const SelectedYearFromDropdown: import("../../schema").CallableTaggedStruct<"SelectedYearFromDropdown", {
+    year: typeof S.Int;
+}>;
+/** Sent when the grid container receives DOM focus. */
+export declare const FocusedGrid: import("../../schema").CallableTaggedStruct<"FocusedGrid", {}>;
+/** Sent when the grid container loses DOM focus. */
+export declare const BlurredGrid: import("../../schema").CallableTaggedStruct<"BlurredGrid", {}>;
+/** Sent when a long-lived session's "today" reference should be refreshed. */
+export declare const RefreshedToday: import("../../schema").CallableTaggedStruct<"RefreshedToday", {
+    today: S.filter<S.Struct<{
+        year: typeof S.Int;
+        month: S.filter<typeof S.Int>;
+        day: S.filter<typeof S.Int>;
+    }>>;
+}>;
+/** Sent when a FocusGrid command completes. */
+export declare const CompletedFocusGrid: import("../../schema").CallableTaggedStruct<"CompletedFocusGrid", {}>;
+/** Union of all messages the calendar component can produce. */
+export declare const Message: S.Union<[import("../../schema").CallableTaggedStruct<"ClickedDay", {
+    date: S.filter<S.Struct<{
+        year: typeof S.Int;
+        month: S.filter<typeof S.Int>;
+        day: S.filter<typeof S.Int>;
+    }>>;
+}>, import("../../schema").CallableTaggedStruct<"PressedKeyOnGrid", {
+    key: typeof S.String;
+    isShift: typeof S.Boolean;
+}>, import("../../schema").CallableTaggedStruct<"ClickedPreviousMonthButton", {}>, import("../../schema").CallableTaggedStruct<"ClickedNextMonthButton", {}>, import("../../schema").CallableTaggedStruct<"SelectedMonthFromDropdown", {
+    month: typeof S.Int;
+}>, import("../../schema").CallableTaggedStruct<"SelectedYearFromDropdown", {
+    year: typeof S.Int;
+}>, import("../../schema").CallableTaggedStruct<"FocusedGrid", {}>, import("../../schema").CallableTaggedStruct<"BlurredGrid", {}>, import("../../schema").CallableTaggedStruct<"RefreshedToday", {
+    today: S.filter<S.Struct<{
+        year: typeof S.Int;
+        month: S.filter<typeof S.Int>;
+        day: S.filter<typeof S.Int>;
+    }>>;
+}>, import("../../schema").CallableTaggedStruct<"CompletedFocusGrid", {}>]>;
+export type Message = typeof Message.Type;
+/** Emitted when the visible month changes due to navigation. Consumers of an
+ * inline calendar may use this to load month-scoped data (holidays, events).
+ *
+ * Date selection does NOT use OutMessage — consumers subscribe via the
+ * `onSelectedDate` callback in `ViewConfig`, matching the Listbox/Popover
+ * controlled-component pattern. Use `Calendar.selectDate(model, date)` to
+ * write back when handling the callback. */
+export declare const ChangedViewMonth: import("../../schema").CallableTaggedStruct<"ChangedViewMonth", {
+    year: typeof S.Int;
+    month: typeof S.Int;
+}>;
+/** The calendar's OutMessage. Only one variant — `ChangedViewMonth` — which
+ * fires when navigation shifts the visible month. Date selection goes through
+ * the `onSelectedDate` ViewConfig callback, not OutMessage. */
+export declare const OutMessage: import("../../schema").CallableTaggedStruct<"ChangedViewMonth", {
+    year: typeof S.Int;
+    month: typeof S.Int;
+}>;
+export type OutMessage = typeof OutMessage.Type;
+/** Configuration for creating a calendar model with `init`. */
+export type InitConfig = Readonly<{
+    id: string;
+    today: CalendarDate;
+    maybeInitialSelectedDate?: Option.Option<CalendarDate>;
+    locale?: Calendar.LocaleConfig;
+    maybeMinDate?: Option.Option<CalendarDate>;
+    maybeMaxDate?: Option.Option<CalendarDate>;
+    disabledDaysOfWeek?: ReadonlyArray<Calendar.DayOfWeek>;
+    disabledDates?: ReadonlyArray<CalendarDate>;
+}>;
+/** Creates an initial calendar model. The view month defaults to the month
+ * of the initial selected date, or today if no date is pre-selected. */
+export declare const init: (config: InitConfig) => Model;
+type UpdateReturn = readonly [
+    Model,
+    ReadonlyArray<Command.Command<Message>>,
+    Option.Option<OutMessage>
+];
+/** Focuses the calendar grid container. */
+export declare const FocusGrid: Command.CommandDefinition<"FocusGrid", {
+    readonly _tag: "CompletedFocusGrid";
+}>;
+/** Builds a command that focuses the calendar grid container. Parent
+ * components like DatePicker dispatch this after opening to hand focus to
+ * the grid's keyboard layer. */
+export declare const focusGrid: (modelId: string) => Command.Command<Message>;
+/** Programmatically selects a date on the calendar, committing it as the
+ * chosen value and moving the cursor onto it. Use this in controlled-mode
+ * handlers (when the view's `onSelectedDate` callback is provided) to write
+ * the selection back to the calendar's internal state.
+ *
+ * Equivalent to dispatching `ClickedDay({ date })` through `update`. */
+export declare const selectDate: (model: Model, date: CalendarDate) => UpdateReturn;
+/** Processes a calendar message and returns the next model, commands, and
+ * optional OutMessage. */
+export declare const update: (model: Model, message: Message) => UpdateReturn;
+/** Information about a single day cell in the rendered calendar grid. */
+export type DayCell<ParentMessage> = Readonly<{
+    date: CalendarDate;
+    label: string;
+    cellAttributes: ReadonlyArray<Attribute<ParentMessage>>;
+    buttonAttributes: ReadonlyArray<Attribute<ParentMessage>>;
+    isSelected: boolean;
+    isFocused: boolean;
+    isToday: boolean;
+    isInViewMonth: boolean;
+    isDisabled: boolean;
+}>;
+/** A column header for the grid's first row (day-of-week labels). */
+export type ColumnHeader<ParentMessage> = Readonly<{
+    name: string;
+    attributes: ReadonlyArray<Attribute<ParentMessage>>;
+}>;
+/** A single week row in the calendar grid, carrying its own row attributes
+ * (role, aria-rowindex) alongside its 7 day cells. */
+export type Week<ParentMessage> = Readonly<{
+    attributes: ReadonlyArray<Attribute<ParentMessage>>;
+    cells: ReadonlyArray<DayCell<ParentMessage>>;
+}>;
+/** Attribute groups and derived data the calendar component provides to the
+ * consumer's `toView` callback. */
+export type CalendarAttributes<ParentMessage> = Readonly<{
+    root: ReadonlyArray<Attribute<ParentMessage>>;
+    previousMonthButton: ReadonlyArray<Attribute<ParentMessage>>;
+    nextMonthButton: ReadonlyArray<Attribute<ParentMessage>>;
+    heading: Readonly<{
+        id: string;
+        text: string;
+    }>;
+    monthSelect: ReadonlyArray<Attribute<ParentMessage>>;
+    monthOptions: ReadonlyArray<Readonly<{
+        value: number;
+        label: string;
+    }>>;
+    yearSelect: ReadonlyArray<Attribute<ParentMessage>>;
+    yearOptions: ReadonlyArray<number>;
+    grid: ReadonlyArray<Attribute<ParentMessage>>;
+    headerRow: ReadonlyArray<Attribute<ParentMessage>>;
+    columnHeaders: ReadonlyArray<ColumnHeader<ParentMessage>>;
+    weeks: ReadonlyArray<Week<ParentMessage>>;
+}>;
+/** Configuration for rendering a calendar with `view`. */
+export type ViewConfig<ParentMessage> = Readonly<{
+    model: Model;
+    toParentMessage: (message: Message) => ParentMessage;
+    toView: (attributes: CalendarAttributes<ParentMessage>) => Html;
+    /** Optional callback invoked when the user commits a date via click, Enter,
+     * or Space. When provided, the view dispatches the callback directly (the
+     * controlled pattern — parent owns the event). When omitted, the calendar
+     * manages its own `maybeSelectedDate` state automatically (uncontrolled).
+     * In controlled mode, use `Calendar.selectDate(model, date)` to write the
+     * selection back to the calendar's internal state. */
+    onSelectedDate?: (date: CalendarDate) => ParentMessage;
+    previousMonthLabel?: string;
+    nextMonthLabel?: string;
+    monthSelectLabel?: string;
+    yearSelectLabel?: string;
+}>;
+/** Renders an accessible calendar grid. Builds ARIA attribute groups (grid,
+ * row, gridcell, column header) plus the derived month grid, then delegates
+ * layout to the consumer's `toView` callback. */
+export declare const view: <ParentMessage>(config: ViewConfig<ParentMessage>) => Html;
+/** Creates a memoized calendar view. Static config is captured in a closure;
+ *  only `model` and `toParentMessage` are compared per render via `createLazy`. */
+export declare const lazy: <ParentMessage>(staticConfig: Omit<ViewConfig<ParentMessage>, "model" | "toParentMessage">) => ((model: Model, toParentMessage: ViewConfig<ParentMessage>["toParentMessage"]) => Html);
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/ui/calendar/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ui/calendar/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,MAAM,EAAE,MAAM,IAAI,CAAC,EAAQ,MAAM,QAAQ,CAAA;AAE7E,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAA;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,OAAO,MAAM,eAAe,CAAA;AAExC,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,IAAI,EAAoB,MAAM,YAAY,CAAA;AAOxE;;0DAE0D;AAC1D,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAahB,CAAA;AAEF,MAAM,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC,IAAI,CAAA;AAIrC,wDAAwD;AACxD,eAAO,MAAM,UAAU;;;;;;EAAmD,CAAA;AAC1E;kDACkD;AAClD,eAAO,MAAM,gBAAgB;;;EAG3B,CAAA;AACF,sEAAsE;AACtE,eAAO,MAAM,0BAA0B,+EAAkC,CAAA;AACzE,kEAAkE;AAClE,eAAO,MAAM,sBAAsB,2EAA8B,CAAA;AACjE,gEAAgE;AAChE,eAAO,MAAM,yBAAyB;;EAEpC,CAAA;AACF,8DAA8D;AAC9D,eAAO,MAAM,wBAAwB;;EAEnC,CAAA;AACF,uDAAuD;AACvD,eAAO,MAAM,WAAW,gEAAmB,CAAA;AAC3C,oDAAoD;AACpD,eAAO,MAAM,WAAW,gEAAmB,CAAA;AAC3C,8EAA8E;AAC9E,eAAO,MAAM,cAAc;;;;;;EAEzB,CAAA;AACF,+CAA+C;AAC/C,eAAO,MAAM,kBAAkB,uEAA0B,CAAA;AAEzD,gEAAgE;AAChE,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;2EAWnB,CAAA;AACD,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC,IAAI,CAAA;AAIzC;;;;;;4CAM4C;AAC5C,eAAO,MAAM,gBAAgB;;;EAG3B,CAAA;AAEF;;+DAE+D;AAC/D,eAAO,MAAM,UAAU;;;EAAmB,CAAA;AAC1C,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;AAI/C,+DAA+D;AAC/D,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,YAAY,CAAA;IACnB,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IACtD,MAAM,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAA;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IAC1C,kBAAkB,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;IACtD,aAAa,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC,CAAA;CAC5C,CAAC,CAAA;AAEF;wEACwE;AACxE,eAAO,MAAM,IAAI,GAAI,QAAQ,UAAU,KAAG,KAmBzC,CAAA;AAID,KAAK,YAAY,GAAG,SAAS;IAC3B,KAAK;IACL,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACvC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;CAC1B,CAAA;AAMD,2CAA2C;AAC3C,eAAO,MAAM,SAAS;;EAAkD,CAAA;AAExE;;gCAEgC;AAChC,eAAO,MAAM,SAAS,GAAI,SAAS,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAMhE,CAAA;AAEH;;;;;wEAKwE;AACxE,eAAO,MAAM,UAAU,GAAI,OAAO,KAAK,EAAE,MAAM,YAAY,KAAG,YACzB,CAAA;AA0MrC;0BAC0B;AAC1B,eAAO,MAAM,MAAM,GAAI,OAAO,KAAK,EAAE,SAAS,OAAO,KAAG,YAiGrD,CAAA;AAmFH,yEAAyE;AACzE,MAAM,MAAM,OAAO,CAAC,aAAa,IAAI,QAAQ,CAAC;IAC5C,IAAI,EAAE,YAAY,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,EAAE,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAA;IACvD,gBAAgB,EAAE,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAA;IACzD,UAAU,EAAE,OAAO,CAAA;IACnB,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,aAAa,EAAE,OAAO,CAAA;IACtB,UAAU,EAAE,OAAO,CAAA;CACpB,CAAC,CAAA;AAEF,qEAAqE;AACrE,MAAM,MAAM,YAAY,CAAC,aAAa,IAAI,QAAQ,CAAC;IACjD,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAA;CACpD,CAAC,CAAA;AAEF;sDACsD;AACtD,MAAM,MAAM,IAAI,CAAC,aAAa,IAAI,QAAQ,CAAC;IACzC,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAA;IACnD,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAA;CAC7C,CAAC,CAAA;AAEF;mCACmC;AACnC,MAAM,MAAM,kBAAkB,CAAC,aAAa,IAAI,QAAQ,CAAC;IACvD,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAA;IAC7C,mBAAmB,EAAE,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAA;IAC5D,eAAe,EAAE,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAA;IACxD,OAAO,EAAE,QAAQ,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAC/C,WAAW,EAAE,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAA;IACpD,YAAY,EAAE,aAAa,CAAC,QAAQ,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAA;IACvE,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAA;IACnD,WAAW,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAClC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAA;IAC7C,SAAS,EAAE,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAA;IAClD,aAAa,EAAE,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAA;IACzD,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAA;CAC1C,CAAC,CAAA;AAEF,0DAA0D;AAC1D,MAAM,MAAM,UAAU,CAAC,aAAa,IAAI,QAAQ,CAAC;IAC/C,KAAK,EAAE,KAAK,CAAA;IACZ,eAAe,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,aAAa,CAAA;IACpD,MAAM,EAAE,CAAC,UAAU,EAAE,kBAAkB,CAAC,aAAa,CAAC,KAAK,IAAI,CAAA;IAC/D;;;;;0DAKsD;IACtD,cAAc,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,aAAa,CAAA;IACtD,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAC,CAAA;AAeF;;iDAEiD;AACjD,eAAO,MAAM,IAAI,GAAI,aAAa,EAChC,QAAQ,UAAU,CAAC,aAAa,CAAC,KAChC,IAiPF,CAAA;AAED;mFACmF;AACnF,eAAO,MAAM,IAAI,GAAI,aAAa,EAChC,cAAc,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC,KACzE,CAAC,CACF,KAAK,EAAE,KAAK,EACZ,eAAe,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC,iBAAiB,CAAC,KAC1D,IAAI,CAgBR,CAAA"}