@peripheries/core 0.4.1 → 0.5.0

package/types/core/forms/CodeField/CodeField.d.ts

@@ -0,0 +1,15 @@
+import { type CSSProperties, type ReactElement } from 'react';
+export interface CodeFieldProps {
+    length?: number;
+    label?: string;
+    value?: string;
+    onChange?: (value: string) => void;
+    onComplete?: (code: string) => void;
+    error?: string;
+    disabled?: boolean;
+    autoFocus?: boolean;
+    name?: string;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function CodeField({ length, label, value, onChange, onComplete, error, disabled, autoFocus, name, className, style }: CodeFieldProps): ReactElement;

package/types/core/forms/Combobox/Combobox.d.ts

@@ -0,0 +1,17 @@
+import { type CSSProperties, type ReactNode } from 'react';
+import { useCombobox, type ComboboxOption, type UseComboboxOptions } from './useCombobox';
+export type { ComboboxOption, UseComboboxOptions };
+export { useCombobox };
+export interface ComboboxProps extends UseComboboxOptions {
+    placeholder?: string;
+    emptyText?: string;
+    errorText?: string;
+    renderOption?: (option: ComboboxOption, query: string) => ReactNode;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function Highlighted({ text, match }: {
+    text: string;
+    match: string;
+}): import("react").JSX.Element;
+export declare function Combobox({ placeholder, emptyText, errorText, renderOption, className, style, ...options }: ComboboxProps): import("react").JSX.Element;

package/types/core/forms/Combobox/useCombobox.d.ts

@@ -0,0 +1,74 @@
+import { type ChangeEvent, type KeyboardEvent } from 'react';
+export interface ComboboxOption {
+    id: string;
+    label: string;
+    description?: string;
+    highlight?: string;
+    group?: string;
+    disabled?: boolean;
+    data?: unknown;
+}
+export type ComboboxStatus = 'idle' | 'loading' | 'ready' | 'empty' | 'error';
+export interface UseComboboxOptions {
+    label: string;
+    options?: ReadonlyArray<ComboboxOption>;
+    loadOptions?: (query: string, signal: AbortSignal) => Promise<ReadonlyArray<ComboboxOption>>;
+    value?: string;
+    defaultValue?: string;
+    onValueChange?: (value: string) => void;
+    onSelect?: (option: ComboboxOption) => void;
+    orientation?: 'vertical' | 'horizontal';
+    debounceMs?: number;
+    minChars?: number;
+    closeOnSelect?: boolean;
+    fillOnSelect?: boolean;
+    openOnFocus?: boolean;
+    emptyText?: string;
+    errorText?: string;
+    defaultOpen?: boolean;
+}
+export declare function useCombobox({ label, options, loadOptions, value, defaultValue, onValueChange, onSelect, orientation, debounceMs, minChars, closeOnSelect, fillOnSelect, openOnFocus, defaultOpen, emptyText, errorText }: UseComboboxOptions): {
+    options: readonly ComboboxOption[];
+    status: ComboboxStatus;
+    statusText: string;
+    open: boolean;
+    activeId: string | null;
+    close: () => void;
+    inputProps: {
+        role: "combobox";
+        'aria-label': string;
+        'aria-expanded': boolean;
+        'aria-controls': string;
+        'aria-autocomplete': "list";
+        'aria-activedescendant': string | undefined;
+        autoComplete: string;
+        value: string;
+        onChange: (e: ChangeEvent<HTMLInputElement>) => void;
+        onKeyDown: (e: KeyboardEvent<HTMLInputElement>) => void;
+        onFocus: () => void;
+        onBlur: () => void;
+    };
+    listboxProps: {
+        id: string;
+        role: "listbox";
+        'aria-label': string;
+        'aria-orientation': "horizontal" | "vertical";
+    };
+    statusProps: {
+        role: "status";
+        'aria-live': "polite";
+        'aria-atomic': boolean;
+    };
+    getOptionProps: (option: ComboboxOption) => {
+        id: string;
+        role: "option";
+        'aria-selected': boolean;
+        'aria-disabled': true | undefined;
+        'data-active': string | undefined;
+        onPointerDown: (e: {
+            preventDefault: () => void;
+        }) => void;
+        onClick: () => void;
+    };
+    query: string;
+};

package/types/core/overlay/Dialog/Dialog.d.ts

@@ -0,0 +1,16 @@
+import type { ReactNode } from 'react';
+export interface DialogProps {
+    open: boolean;
+    onClose: () => void;
+    title: ReactNode;
+    label?: string;
+    description?: ReactNode;
+    role?: 'dialog' | 'alertdialog';
+    initialFocus?: string;
+    dismissOnBackdrop?: boolean;
+    headerTools?: ReactNode;
+    footer?: ReactNode;
+    children?: ReactNode;
+    className?: string;
+}
+export declare function Dialog({ role, dismissOnBackdrop, ...props }: DialogProps): import("react").JSX.Element;

package/types/core/overlay/Menu/Menu.d.ts

@@ -0,0 +1,26 @@
+import { type ReactElement, type ReactNode } from 'react';
+import { type Placement } from '../Popover/Popover';
+export interface MenuItem {
+    id: string;
+    label: string;
+    icon?: ReactNode;
+    tone?: 'danger';
+    disabled?: boolean;
+    href?: string;
+    onSelect?: () => void;
+}
+export interface MenuSeparator {
+    type: 'separator';
+    id: string;
+}
+export interface MenuProps {
+    trigger: ReactElement<Record<string, unknown>>;
+    items: ReadonlyArray<MenuItem | MenuSeparator>;
+    label: string;
+    placement?: Placement;
+    presentation?: 'auto' | 'popover' | 'sheet';
+    defaultOpen?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    className?: string;
+}
+export declare function Menu({ trigger, items, label, placement, presentation, defaultOpen, onOpenChange, className }: MenuProps): import("react").JSX.Element;

package/types/core/overlay/Popover/Popover.d.ts

@@ -0,0 +1,19 @@
+import { type ReactElement, type ReactNode } from 'react';
+import { type Placement } from '../../_shared/overlay/placement';
+export type { Placement };
+export interface PopoverProps {
+    trigger: ReactElement<Record<string, unknown>>;
+    label: string;
+    placement?: Placement;
+    open?: boolean;
+    defaultOpen?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    popupRole?: 'dialog' | 'menu';
+    initialFocus?: string | false | ((panel: HTMLElement) => HTMLElement | null);
+    onTriggerKeyDown?: (event: React.KeyboardEvent) => void;
+    children?: ReactNode | ((api: {
+        close: () => void;
+    }) => ReactNode);
+    className?: string;
+}
+export declare function Popover({ trigger, label, placement, open: openProp, defaultOpen, onOpenChange, popupRole, initialFocus, onTriggerKeyDown, children, className }: PopoverProps): import("react").JSX.Element;

package/types/core/overlay/Sheet/Sheet.d.ts

@@ -0,0 +1,21 @@
+import type { ReactNode } from 'react';
+export interface SheetBack {
+    label: string;
+    onBack: () => void;
+}
+export interface SheetProps {
+    open: boolean;
+    onClose: () => void;
+    title: ReactNode;
+    label?: string;
+    description?: ReactNode;
+    side?: 'bottom' | 'end';
+    back?: SheetBack;
+    initialFocus?: string;
+    dismissOnBackdrop?: boolean;
+    headerTools?: ReactNode;
+    footer?: ReactNode;
+    children?: ReactNode;
+    className?: string;
+}
+export declare function Sheet({ side, back, ...props }: SheetProps): import("react").JSX.Element;

package/types/core/overlay/Toast/Toast.d.ts

@@ -0,0 +1,20 @@
+import { type CSSProperties } from 'react';
+import { dismissToast, toast, type ToastItem } from './toast-store';
+export { dismissToast, toast, type ToastInput, type ToastTone } from './toast-store';
+export declare function useToast(): {
+    toast: typeof toast;
+    dismiss: typeof dismissToast;
+};
+export interface ToastProps {
+    toast: Pick<ToastItem, 'title' | 'description' | 'tone' | 'action'>;
+    actionAvailable?: boolean;
+    onAction?: () => void;
+    onDismiss?: () => void;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function Toast({ toast: t, actionAvailable, onAction, onDismiss, className, ...rest }: ToastProps): import("react").JSX.Element;
+export declare function ToastRegion({ className, actions }: {
+    className?: string;
+    actions?: Record<string, () => void>;
+}): import("react").JSX.Element | null;

package/types/core/overlay/Toast/toast-store.d.ts

@@ -0,0 +1,51 @@
+export type ToastTone = 'neutral' | 'info' | 'success' | 'warning' | 'danger';
+export interface ToastInput {
+    title: string;
+    description?: string;
+    tone?: ToastTone;
+    duration?: number;
+    action?: {
+        id: string;
+        label: string;
+    };
+    id?: string;
+    source?: string;
+}
+export interface ToastItem {
+    id: string;
+    title: string;
+    description?: string;
+    tone: ToastTone;
+    duration: number;
+    action?: {
+        id: string;
+        label: string;
+    };
+    source: string;
+    revision: number;
+}
+export interface ToastSnapshot {
+    toasts: readonly ToastItem[];
+    actions: readonly string[];
+}
+export declare const LIMITS: {
+    readonly title: 120;
+    readonly description: 280;
+    readonly label: 40;
+    readonly visible: 4;
+    readonly perSource: 2;
+    readonly burst: 5;
+    readonly windowMs: 10000;
+    readonly defaultDuration: 6000;
+};
+export declare function toast(input: ToastInput): string | null;
+export declare function dismissToast(id: string): void;
+export declare function runToastAction(id: string): boolean;
+export declare const subscribeToasts: (listener: () => void) => () => undefined;
+export declare const getToasts: () => ToastSnapshot;
+export interface RegionClaim {
+    release: () => void;
+    setActions: (handlers: Record<string, () => void>) => void;
+}
+export declare function claimRegion(): RegionClaim | null;
+export declare function resetToasts(): void;

package/types/core/overlay/_shared/Modal.d.ts

@@ -0,0 +1,19 @@
+import { type ReactNode } from 'react';
+export type ModalVariant = 'dialog' | 'sheet-bottom' | 'sheet-end';
+export interface ModalProps {
+    variant: ModalVariant;
+    open: boolean;
+    onClose: () => void;
+    title: ReactNode;
+    label?: string;
+    description?: ReactNode;
+    role?: 'dialog' | 'alertdialog';
+    initialFocus?: string;
+    dismissOnBackdrop?: boolean;
+    headerStart?: ReactNode;
+    headerTools?: ReactNode;
+    footer?: ReactNode;
+    children?: ReactNode;
+    className?: string;
+}
+export declare function Modal({ variant, open, onClose, title, label, description, role, initialFocus, dismissOnBackdrop, headerStart, headerTools, footer, children, className }: ModalProps): import("react").JSX.Element;

package/types/core/public/ContactForm/ContactForm.d.ts

@@ -0,0 +1,24 @@
+import { type CSSProperties, type ReactElement } from 'react';
+import { type Action } from '../../events/_shared/event';
+export interface ContactRequestInput {
+    name: string;
+    email: string;
+    phone?: string;
+    message?: string;
+    consent: boolean;
+    website: string;
+}
+export interface ContactFormProps {
+    title?: string;
+    intro?: string;
+    askPhone?: boolean;
+    consent?: string;
+    submitLabel?: string;
+    thanks?: string;
+    actions?: {
+        submitRequest?: Action<ContactRequestInput>;
+    };
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function ContactForm({ title, intro, askPhone, consent, submitLabel, thanks, actions, className, style }: ContactFormProps): ReactElement;

package/types/core/public/CtaBand/CtaBand.d.ts

@@ -0,0 +1,11 @@
+import type { CSSProperties, ReactElement } from 'react';
+import { type PublicAction } from '../_shared/actions';
+export interface CtaBandProps {
+    title: string;
+    text?: string;
+    actions?: PublicAction[] | PublicAction;
+    tone?: 'accent' | 'strong' | 'neutral' | string;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function CtaBand({ title, text, actions, tone, className, style }: CtaBandProps): ReactElement;

package/types/core/public/FeatureGrid/FeatureGrid.d.ts

@@ -0,0 +1,15 @@
+import type { CSSProperties, ReactElement } from 'react';
+export interface FeatureItem {
+    title: string;
+    text?: string;
+    icon?: string;
+}
+export interface FeatureGridProps {
+    title?: string;
+    intro?: string;
+    items: FeatureItem[];
+    columns?: number;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function FeatureGrid({ title, intro, items, columns, className, style }: FeatureGridProps): ReactElement | null;

package/types/core/public/Hero/Hero.d.ts

@@ -0,0 +1,14 @@
+import type { CSSProperties, ReactElement } from 'react';
+import { type PublicAction } from '../_shared/actions';
+import { type PublicImage } from '../_shared/media';
+export interface HeroProps {
+    eyebrow?: string;
+    title: string;
+    intro?: string;
+    actions?: PublicAction[] | PublicAction;
+    media?: PublicImage;
+    align?: 'start' | 'center' | string;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function Hero({ eyebrow, title, intro, actions, media, align, className, style }: HeroProps): ReactElement;

package/types/core/public/Image/Image.d.ts

@@ -0,0 +1,12 @@
+import type { CSSProperties, ReactElement } from 'react';
+export interface ImageProps {
+    src: string;
+    alt?: string;
+    decorative?: boolean;
+    ratio?: string;
+    caption?: string;
+    priority?: boolean;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function Image({ src, alt, decorative, ratio, caption, priority, className, style }: ImageProps): ReactElement | null;

package/types/core/public/LogoMark/LogoMark.d.ts

@@ -0,0 +1,10 @@
+import type { CSSProperties, ReactElement } from 'react';
+export interface LogoMarkProps {
+    text: string;
+    src?: string;
+    href?: string;
+    size?: 'sm' | 'md' | 'lg' | string;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function LogoMark({ text, src, href, size, className, style }: LogoMarkProps): ReactElement;

package/types/core/public/PublicFooter/PublicFooter.d.ts

@@ -0,0 +1,15 @@
+import type { CSSProperties, ReactElement } from 'react';
+import { type LogoMarkProps } from '../LogoMark/LogoMark';
+import { type PublicNavLink } from '../PublicHeader/PublicHeader';
+export interface PublicFooterGroup {
+    title: string;
+    links: PublicNavLink[];
+}
+export interface PublicFooterProps {
+    logo?: LogoMarkProps;
+    groups?: PublicFooterGroup[];
+    legal?: string;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function PublicFooter({ logo, groups, legal, className, style }: PublicFooterProps): ReactElement;

package/types/core/public/PublicHeader/PublicHeader.d.ts

@@ -0,0 +1,16 @@
+import type { CSSProperties, ReactElement } from 'react';
+import { type PublicAction } from '../_shared/actions';
+import { type LogoMarkProps } from '../LogoMark/LogoMark';
+export interface PublicNavLink {
+    label: string;
+    href: string;
+}
+export interface PublicHeaderProps {
+    logo?: LogoMarkProps;
+    links?: PublicNavLink[];
+    signIn?: PublicAction | false;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare const linksOf: (v: unknown) => PublicNavLink[];
+export declare function PublicHeader({ logo, links, signIn, className, style }: PublicHeaderProps): ReactElement;

package/types/core/public/TeamGrid/TeamGrid.d.ts

@@ -0,0 +1,16 @@
+import type { CSSProperties, ReactElement } from 'react';
+import { type PublicImage } from '../_shared/media';
+export interface TeamMember {
+    name: string;
+    role?: string;
+    bio?: string;
+    photo?: PublicImage;
+}
+export interface TeamGridProps {
+    title?: string;
+    intro?: string;
+    members: TeamMember[];
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function TeamGrid({ title, intro, members, className, style }: TeamGridProps): ReactElement | null;

package/types/core/public/Testimonial/Testimonial.d.ts

@@ -0,0 +1,11 @@
+import type { CSSProperties, ReactElement } from 'react';
+import { type PublicImage } from '../_shared/media';
+export interface TestimonialProps {
+    quote: string;
+    name: string;
+    role?: string;
+    photo?: PublicImage;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function Testimonial({ quote, name, role, photo, className, style }: TestimonialProps): ReactElement | null;

package/types/core/public/_shared/actions.d.ts

@@ -0,0 +1,15 @@
+import type { ReactElement } from 'react';
+export interface PublicAction {
+    label: string;
+    href: string;
+    variant?: 'primary' | 'secondary' | string;
+}
+export declare function actionsOf(value: unknown): PublicAction[];
+export declare function ActionLink({ action, className }: {
+    action: PublicAction;
+    className?: string;
+}): ReactElement | null;
+export declare function ActionRow({ actions, className }: {
+    actions: PublicAction[];
+    className?: string;
+}): ReactElement | null;

package/types/core/public/_shared/media.d.ts

@@ -0,0 +1,9 @@
+export interface PublicImage {
+    src: string;
+    alt?: string;
+    decorative?: boolean;
+}
+export declare function imageOf(value: unknown): {
+    src: string;
+    alt: string;
+} | null;

package/types/index.core.d.ts

@@ -5,7 +5,13 @@ export { Container } from './core/Container/Container';
 export { Divider } from './core/Divider/Divider';
 export { Hide } from './core/Hide/Hide';
 export { Inline } from './core/Inline/Inline';
+export { Rail, type RailProps } from './core/Rail/Rail';
 export { Show } from './core/Show/Show';
+export { Menu, type MenuItem, type MenuProps, type MenuSeparator } from './core/overlay/Menu/Menu';
+export { ToastRegion, Toast, dismissToast, toast, useToast, type ToastInput, type ToastTone, type ToastProps } from './core/overlay/Toast/Toast';
+export { Popover, type Placement, type PopoverProps } from './core/overlay/Popover/Popover';
+export { Dialog, type DialogProps } from './core/overlay/Dialog/Dialog';
+export { Sheet, type SheetBack, type SheetProps } from './core/overlay/Sheet/Sheet';
 export { Spacer } from './core/Spacer/Spacer';
 export { Stack } from './core/Stack/Stack';
 export { ListRow, type ListRowProps } from './core/page/ListRow/ListRow';
@@ -80,7 +86,7 @@ export { ExecutionBlock, type ExecutionBlockProps, type ExecutionSignatory } fro
 export { DocumentBlocks, type DocumentBlocksProps } from './core/document/DocumentBlocks/DocumentBlocks';
 export { DocumentSection, type DocumentSectionProps } from './core/document/DocumentSection/DocumentSection';
 export { BLOCK_SCHEMAS } from './core/document/_shared/block-schemas';
-export { formatValue, renderFormatted, type FormatOpts, type FormattableValue, type FormatterToken, type ValueSpec } from './core/_shared/formatters';
+export { DEFAULT_DISPLAY_LOCALE, displayLocale, formatValue, renderFormatted, type DisplayLocale, type FormatOpts, type FormattableValue, type FormatterToken, type ValueSpec } from './core/_shared/formatters';
 export { TONES, toneOf, type Tone } from './core/display/_shared/tone';
 export { Eyebrow, inkToneOf, type EyebrowAs, type EyebrowProps, type InkTone } from './core/display/Eyebrow/Eyebrow';
 export { Stat, StatGroup, type StatGroupProps, type StatProps, type StatSize } from './core/display/Stat/Stat';
@@ -98,4 +104,36 @@ export { EventLogForm, type EventLogFormProps, type LogEventInput } from './core
 export { EventRespond, type EventRespondProps } from './core/events/EventRespond/EventRespond';
 export { EventSchedule, type EventScheduleProps } from './core/events/EventSchedule/EventSchedule';
 export { EventTimeline, type ActivityItem, type EventTimelineProps } from './core/events/EventTimeline/EventTimeline';
-export { eventWhen, typeCard, type EventTypeOption, type EventView, type RenderComponent as EventRenderComponent, type WriteResult as EventWriteResult } from './core/events/_shared/event';
+export { eventWhen, hrefFrom, typeCard, type EventTypeOption, type EventView, type RenderComponent as EventRenderComponent, type WriteResult as EventWriteResult } from './core/events/_shared/event';
+export { DAY_MINUTES, isBusyOnly, layoutDay, overlapDays, visibleRange, wallOf, weekDates, type CalendarBlock, type DayLayout, type Wall } from './core/events/_shared/calendar';
+export { HourGrid, type HourGridColumn, type HourGridProps } from './core/events/HourGrid/HourGrid';
+export { SeriesGlyph, seriesNumber, seriesShape, SERIES_SHAPES, type SeriesShape } from './core/events/_shared/SeriesGlyph';
+export { CalendarFilters, type CalendarFilterType, type CalendarFiltersProps } from './core/events/CalendarFilters/CalendarFilters';
+export { MiniMonth, type MiniMonthProps } from './core/events/MiniMonth/MiniMonth';
+export { CalendarView, type CalendarViewName, type CalendarViewProps } from './core/events/CalendarView/CalendarView';
+export { WeekStrip, type WeekStripProps } from './core/events/WeekStrip/WeekStrip';
+export { sameOriginPath } from './core/events/_shared/path';
+export { NOT_AVAILABLE, useIntent, type CardIntent, type IntentHandler } from './core/events/_shared/intent';
+export { LogCard, type LogCardPrefill, type LogCardProps } from './core/events/LogCard/LogCard';
+export { QuickNoteCard, type QuickNote, type QuickNoteCardProps } from './core/events/QuickNoteCard/QuickNoteCard';
+export { TaskCard, type TaskCardProps, type TaskView } from './core/events/TaskCard/TaskCard';
+export { HandoverCard, type HandoverCardProps, type HandoverPointer } from './core/events/HandoverCard/HandoverCard';
+export { StartProcessCard, type StartProcessCardProps, type StartProcessNeed } from './core/events/StartProcessCard/StartProcessCard';
+export { NoteSplitCard, type NoteSplitCardProps, type NoteSplitMatch, type NoteSplitPart } from './core/events/NoteSplitCard/NoteSplitCard';
+export { ShareApprovalCard, type ShareApprovalCardProps, type ShareApprovalItem } from './core/events/ShareApprovalCard/ShareApprovalCard';
+export { SuggestedActions, type SuggestedAction, type SuggestedActionsProps } from './core/events/SuggestedActions/SuggestedActions';
+export { ActionLink, ActionRow, actionsOf, type PublicAction } from './core/public/_shared/actions';
+export { imageOf, type PublicImage } from './core/public/_shared/media';
+export { Hero, type HeroProps } from './core/public/Hero/Hero';
+export { PublicHeader, type PublicHeaderProps, type PublicNavLink } from './core/public/PublicHeader/PublicHeader';
+export { PublicFooter, type PublicFooterGroup, type PublicFooterProps } from './core/public/PublicFooter/PublicFooter';
+export { LogoMark, type LogoMarkProps } from './core/public/LogoMark/LogoMark';
+export { Image, type ImageProps } from './core/public/Image/Image';
+export { FeatureGrid, type FeatureGridProps, type FeatureItem } from './core/public/FeatureGrid/FeatureGrid';
+export { TeamGrid, type TeamGridProps, type TeamMember } from './core/public/TeamGrid/TeamGrid';
+export { Testimonial, type TestimonialProps } from './core/public/Testimonial/Testimonial';
+export { CtaBand, type CtaBandProps } from './core/public/CtaBand/CtaBand';
+export { ContactForm, type ContactFormProps, type ContactRequestInput } from './core/public/ContactForm/ContactForm';
+export { Combobox, Highlighted, useCombobox, type ComboboxOption, type ComboboxProps, type UseComboboxOptions } from './core/forms/Combobox/Combobox';
+export { CodeField, type CodeFieldProps } from './core/forms/CodeField/CodeField';
+export { DEFAULT_VIEWER, ViewerProvider, hasRole, isStaff, normalizeViewer, useViewer, type Viewer } from './core/_shared/viewer';