@peripheries/core 0.4.0 → 0.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peripheries/core",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "The shared core lineage: layout, the document kit and the display cells, on the semantic tokens",
   "type": "module",
   "license": "UNLICENSED",

package/types/core/Rail/Rail.d.ts

@@ -0,0 +1,9 @@
+import { type CSSProperties, type ReactNode } from 'react';
+export interface RailProps {
+    label: string;
+    snap?: 'start' | 'none';
+    children?: ReactNode;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function Rail({ label, snap, children, className, ...rest }: RailProps): import("react").JSX.Element;

package/types/core/_shared/formatters.d.ts

@@ -1,7 +1,14 @@
-export type FormatterToken = 'currency' | 'currency-k' | 'currency-m' | 'currency-compact' | 'currency-monthly' | 'percent' | 'age' | 'years' | 'number';
+export type FormatterToken = 'currency' | 'currency-k' | 'currency-m' | 'currency-compact' | 'currency-monthly' | 'percent' | 'fraction-percent' | 'age' | 'years' | 'year' | 'number';
+export interface DisplayLocale {
+    locale: string;
+    currency: string;
+}
+export declare const DEFAULT_DISPLAY_LOCALE: DisplayLocale;
+export declare function displayLocale(baseProps?: unknown): DisplayLocale;
 export interface FormatOpts {
     precision?: number;
     signed?: boolean;
+    locale?: DisplayLocale;
 }
 export interface ValueSpec {
     value: number;
@@ -11,5 +18,5 @@ export interface ValueSpec {
     unit?: string;
 }
 export type FormattableValue = string | ValueSpec;
-export declare function renderFormatted(v: FormattableValue | undefined): string;
+export declare function renderFormatted(v: FormattableValue | undefined, locale?: DisplayLocale): string;
 export declare function formatValue(token: FormatterToken | undefined, value: number, opts?: FormatOpts): string;

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

@@ -0,0 +1,2 @@
+export declare function focusables(root: HTMLElement): HTMLElement[];
+export declare const prefersReducedMotion: () => boolean;

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

@@ -0,0 +1,4 @@
+import { type Ref, type RefCallback } from 'react';
+export declare function useControllable<T>(value: T | undefined, initial: T, onChange?: (next: T) => void): [T, (next: T) => void];
+export declare function mergeRefs<T>(...refs: Array<Ref<T> | undefined>): RefCallback<T>;
+export declare function useMediaQuery(query: string): boolean;

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

@@ -0,0 +1,28 @@
+export type Placement = 'bottom-start' | 'bottom-end' | 'bottom' | 'top-start' | 'top-end' | 'top';
+export interface Rect {
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+}
+export interface PlaceInput {
+    anchor: Rect;
+    size: {
+        width: number;
+        height: number;
+    };
+    viewport: {
+        width: number;
+        height: number;
+    };
+    placement: Placement;
+    gap?: number;
+    margin?: number;
+}
+export interface Placed {
+    x: number;
+    y: number;
+    placement: Placement;
+}
+export declare function place({ anchor, size, viewport, placement, gap, margin }: PlaceInput): Placed;
+export declare function supportsAnchorPositioning(): boolean;

package/types/core/_shared/overlay/scroll-lock.d.ts

@@ -0,0 +1 @@
+export declare function lockScroll(): () => void;

package/types/core/_shared/safe-url.d.ts

@@ -0,0 +1,2 @@
+export declare function safeHref(url: unknown): string | null;
+export declare function safeImageSrc(url: unknown): string | null;

package/types/core/_shared/viewer.d.ts

@@ -0,0 +1,15 @@
+import { type ReactElement, type ReactNode } from 'react';
+export interface Viewer {
+    audience: 'staff' | 'client';
+    roles: ReadonlyArray<string>;
+    previewing?: boolean;
+}
+export declare const DEFAULT_VIEWER: Viewer;
+export declare function normalizeViewer(value: unknown): Viewer;
+export declare function ViewerProvider({ value, children }: {
+    value: unknown;
+    children?: ReactNode;
+}): ReactElement;
+export declare function useViewer(): Viewer;
+export declare const isStaff: (viewer: Viewer) => boolean;
+export declare const hasRole: (viewer: Viewer, role: string) => boolean;

package/types/core/display/DataTable/DataTable.d.ts

@@ -1,5 +1,5 @@
 import { type CSSProperties, type ReactElement, type ReactNode } from 'react';
-import { type FormattableValue } from '../../_shared/formatters';
+import { type FormattableValue, type FormatterToken } from '../../_shared/formatters';
 import { type Tone } from '../_shared/tone';
 export type DataTableAlign = 'left' | 'right' | 'center';
 export interface DataTableColumn {
@@ -10,7 +10,7 @@ export interface DataTableColumn {
     minWidth?: number;
     format?: DataTableColumnFormat;
 }
-export type DataTableColumnFormat = 'date' | 'datetime' | 'raw';
+export type DataTableColumnFormat = 'date' | 'datetime' | 'raw' | 'unit' | FormatterToken;
 export interface DataTableCell {
     value: FormattableValue | ReactNode;
     tone?: Tone | string;
@@ -20,14 +20,16 @@ export interface DataTableRow {
     cells: ReadonlyArray<DataTableCellInput> | Readonly<Record<string, DataTableCellInput>>;
     highlighted?: boolean;
     total?: boolean;
+    unit?: string;
 }
 export interface DataTableProps {
     title?: string;
     subtitle?: string;
     columns: ReadonlyArray<DataTableColumn>;
     rows: ReadonlyArray<DataTableRow>;
+    baseProps?: unknown;
     className?: string;
     style?: CSSProperties;
 }
 export declare function asWords(value: string): string;
-export declare function DataTable({ title, subtitle, columns, rows, className, style }: DataTableProps): ReactElement;
+export declare function DataTable({ title, subtitle, columns, rows, baseProps, className, style }: DataTableProps): ReactElement;

package/types/core/display/KpiCardGrid/KpiCardGrid.d.ts

@@ -20,5 +20,6 @@ export interface KpiCardGridProps {
     minColumnWidth?: number;
     className?: string;
     style?: CSSProperties;
+    baseProps?: unknown;
 }
 export declare function KpiCardGrid(props: KpiCardGridProps): ReactElement;

package/types/core/display/OptionCard/OptionCard.d.ts

@@ -19,5 +19,6 @@ export interface OptionCardProps {
     isSelected?: boolean;
     className?: string;
     style?: CSSProperties;
+    baseProps?: unknown;
 }
 export declare function OptionCard(props: OptionCardProps): ReactElement;

package/types/core/display/ProfileCard/ProfileCard.d.ts

@@ -17,5 +17,6 @@ export interface ProfileCardProps {
     rows?: ReadonlyArray<ProfileRow>;
     className?: string;
     style?: CSSProperties;
+    baseProps?: unknown;
 }
 export declare function ProfileCard(props: ProfileCardProps): ReactElement;

package/types/core/display/SectionHeader/SectionHeader.d.ts

@@ -4,8 +4,9 @@ export interface SectionHeaderProps {
     title: string;
     description?: string;
     trailing?: ReactNode;
+    level?: 2 | 3;
     revealDelay?: number;
     className?: string;
     style?: CSSProperties;
 }
-export declare function SectionHeader({ eyebrow, title, description, trailing, revealDelay, className, style }: SectionHeaderProps): ReactElement;
+export declare function SectionHeader({ eyebrow, title, description, trailing, level, revealDelay, className, style }: SectionHeaderProps): ReactElement;

package/types/core/display/Stat/Stat.d.ts

@@ -13,8 +13,9 @@ export interface StatProps {
     autoStepDown?: boolean;
     className?: string;
     style?: CSSProperties;
+    baseProps?: unknown;
 }
-export declare function Stat({ value, label, size, tone, progress, progressLabel, autoStepDown, className, style, }: StatProps): ReactElement;
+export declare function Stat({ value, label, size, tone, progress, progressLabel, autoStepDown, baseProps, className, style, }: StatProps): ReactElement;
 export interface StatGroupProps {
     children?: ReactNode;
     minColumnWidth?: number;

package/types/core/display/StatStrip/StatStrip.d.ts

@@ -9,5 +9,6 @@ export interface StatStripProps {
     tone?: Tone | string;
     className?: string;
     style?: CSSProperties;
+    baseProps?: unknown;
 }
-export declare function StatStrip({ label, value, fillPercent, subtitle, tone, className, style }: StatStripProps): ReactElement;
+export declare function StatStrip({ label, value, fillPercent, subtitle, tone, baseProps, className, style }: StatStripProps): ReactElement;

package/types/core/display/_shared/ValueBadge.d.ts

@@ -1,8 +1,9 @@
-import { type FormattableValue } from '../../_shared/formatters';
+import { type DisplayLocale, type FormattableValue } from '../../_shared/formatters';
 import { type Tone } from './tone';
 export interface ValueBadgeProps {
     text: FormattableValue;
     tone?: Tone | string;
+    locale?: DisplayLocale;
     className?: string;
 }
-export declare function ValueBadge({ text, tone, className }: ValueBadgeProps): import("react").JSX.Element;
+export declare function ValueBadge({ text, tone, locale, className }: ValueBadgeProps): import("react").JSX.Element;

package/types/core/document/ComparisonBars/ComparisonBars.d.ts

@@ -15,5 +15,6 @@ export interface ComparisonBarsProps {
     profile?: DocumentProfile;
     className?: string;
     style?: CSSProperties;
+    baseProps?: unknown;
 }
-export declare function ComparisonBars({ bars, target, targetLabel, max, profileId, profile, className, style }: ComparisonBarsProps): ReactElement | null;
+export declare function ComparisonBars({ bars, target, targetLabel, max, profileId, profile, baseProps, className, style }: ComparisonBarsProps): ReactElement | null;

package/types/core/document/RowList/RowList.d.ts

@@ -1,9 +1,10 @@
 import type { CSSProperties, ReactElement, ReactNode } from 'react';
+import { type FormattableValue } from '../../_shared/formatters';
 import { type DocumentProfile, type ProfileId } from '../_shared/profile';
 export interface RowListItem {
-    marker?: string;
+    marker?: FormattableValue;
     primary: ReactNode;
-    secondary?: ReactNode;
+    secondary?: ReactNode | FormattableValue;
     missing?: boolean;
 }
 export interface RowListProps {
@@ -13,7 +14,8 @@ export interface RowListProps {
     markerWidth?: number;
     secondaryWidth?: number;
     missingLabel?: string;
+    baseProps?: unknown;
     className?: string;
     style?: CSSProperties;
 }
-export declare function RowList({ items, profileId, profile, markerWidth, secondaryWidth, missingLabel, className, style, }: RowListProps): ReactElement | null;
+export declare function RowList({ items, profileId, profile, markerWidth, secondaryWidth, missingLabel, baseProps, className, style, }: RowListProps): ReactElement | null;

package/types/core/events/CalendarFilters/CalendarFilters.d.ts

@@ -0,0 +1,22 @@
+import { type CSSProperties, type ReactElement } from 'react';
+export interface CalendarFilterType {
+    id: string;
+    label: string;
+    series?: number;
+}
+export interface CalendarFiltersProps {
+    types: ReadonlyArray<CalendarFilterType>;
+    selected?: ReadonlyArray<string>;
+    showCancelled?: boolean;
+    param?: string;
+    cancelledParam?: string;
+    keep?: Readonly<Record<string, string>>;
+    label?: string;
+    onChange?: (next: {
+        selected: string[];
+        showCancelled: boolean;
+    }) => void;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function CalendarFilters(props: CalendarFiltersProps): ReactElement | null;

package/types/core/events/CalendarView/CalendarView.d.ts

@@ -0,0 +1,23 @@
+import type { CSSProperties, ReactElement, ReactNode } from 'react';
+import { type EventView } from '../_shared/event';
+export type CalendarViewName = 'day' | 'week' | 'agenda';
+export interface CalendarViewProps {
+    occurrences: ReadonlyArray<EventView>;
+    view?: CalendarViewName;
+    date?: string;
+    weekStartsOn?: number;
+    viewParam?: string;
+    dateParam?: string;
+    eventHref?: string;
+    newEventHref?: string;
+    summary?: string;
+    notice?: ReactNode;
+    startHour?: number;
+    endHour?: number;
+    locale?: string;
+    timeZone?: string;
+    now?: string | number;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function CalendarView(props: CalendarViewProps): ReactElement;

package/types/core/events/EventCard/EventCard.d.ts

@@ -5,6 +5,7 @@ export interface EventCardProps {
     href?: string;
     locale?: string;
     timeZone?: string;
+    size?: 'default' | 'compact';
     className?: string;
     style?: CSSProperties;
 }

package/types/core/events/EventSchedule/EventSchedule.d.ts

@@ -5,10 +5,12 @@ export interface EventScheduleProps {
     view?: 'week' | 'agenda';
     weekOf?: string;
     weekParam?: string;
+    linkParams?: Readonly<Record<string, string>>;
     eventHref?: string;
     locale?: string;
     timeZone?: string;
     renderComponent?: RenderComponent;
+    label?: string;
     className?: string;
     style?: CSSProperties;
 }

package/types/core/events/HandoverCard/HandoverCard.d.ts

@@ -0,0 +1,19 @@
+import { type CSSProperties, type ReactElement } from 'react';
+import { type IntentHandler } from '../_shared/intent';
+export type HandoverPointer = {
+    kind: 'conversation';
+    at?: string;
+} | {
+    kind: 'event';
+    name?: string;
+};
+export interface HandoverCardProps {
+    scopeName?: string;
+    pointer?: HandoverPointer;
+    locale?: string;
+    timeZone?: string;
+    onIntent?: IntentHandler<'handover_continue' | 'dismiss'>;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function HandoverCard(props: HandoverCardProps): ReactElement | null;

package/types/core/events/HourGrid/HourGrid.d.ts

@@ -0,0 +1,24 @@
+import { type CSSProperties, type ReactElement } from 'react';
+import { type EventView } from '../_shared/event';
+export interface HourGridColumn {
+    id: string;
+    date: string;
+    label: string;
+    sublabel?: string;
+    href?: string;
+    events: ReadonlyArray<EventView>;
+}
+export interface HourGridProps {
+    columns: ReadonlyArray<HourGridColumn>;
+    label?: string;
+    startHour?: number;
+    endHour?: number;
+    hourHeight?: number;
+    eventHref?: string;
+    locale?: string;
+    timeZone?: string;
+    now?: string | number;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function HourGrid(props: HourGridProps): ReactElement;

package/types/core/events/LogCard/LogCard.d.ts

@@ -0,0 +1,27 @@
+import { type CSSProperties, type ReactElement } from 'react';
+import { type EventTypeOption } from '../_shared/event';
+import { type IntentHandler } from '../_shared/intent';
+export interface LogCardPrefill {
+    typeId?: string;
+    name?: string;
+    startsAt?: string;
+    durationMin?: number;
+    attendees?: ReadonlyArray<string>;
+    outcome?: string;
+    followUp?: string;
+    note?: string;
+}
+export interface LogCardProps {
+    types: ReadonlyArray<EventTypeOption>;
+    subjectName?: string;
+    prefill?: LogCardPrefill;
+    canWriteStaffNotes?: boolean;
+    logged?: {
+        name?: string;
+        href?: string;
+    };
+    onIntent?: IntentHandler<'log_event'>;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function LogCard(props: LogCardProps): ReactElement;

package/types/core/events/MiniMonth/MiniMonth.d.ts

@@ -0,0 +1,18 @@
+import { type CSSProperties, type ReactElement } from 'react';
+import { type EventView } from '../_shared/event';
+export interface MiniMonthProps {
+    month?: string;
+    date?: string;
+    highlight?: 'week' | 'day';
+    occurrences?: ReadonlyArray<EventView>;
+    weekStartsOn?: number;
+    param?: string;
+    monthParam?: string;
+    keep?: Readonly<Record<string, string>>;
+    locale?: string;
+    timeZone?: string;
+    now?: string | number;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function MiniMonth({ month: monthProp, date, highlight, occurrences, weekStartsOn, param, monthParam, keep, locale, timeZone, now, className, style }: MiniMonthProps): ReactElement;

package/types/core/events/NoteSplitCard/NoteSplitCard.d.ts

@@ -0,0 +1,22 @@
+import { type CSSProperties, type ReactElement } from 'react';
+import { type IntentHandler } from '../_shared/intent';
+export interface NoteSplitMatch {
+    id: string;
+    name: string;
+    kind: 'client' | 'project';
+    detail?: string;
+}
+export interface NoteSplitPart {
+    id: string;
+    text: string;
+    matches?: ReadonlyArray<NoteSplitMatch>;
+    state?: 'open' | 'assigned' | 'dropped';
+    assignedToName?: string;
+}
+export interface NoteSplitCardProps {
+    parts: ReadonlyArray<NoteSplitPart>;
+    onIntent?: IntentHandler<'confirm_part' | 'drop_part'>;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function NoteSplitCard(props: NoteSplitCardProps): ReactElement | null;

package/types/core/events/QuickNoteCard/QuickNoteCard.d.ts

@@ -0,0 +1,21 @@
+import { type CSSProperties, type ReactElement } from 'react';
+import { type ComboboxOption } from '../../forms/Combobox/Combobox';
+import { type IntentHandler } from '../_shared/intent';
+export interface QuickNote {
+    body?: string;
+    createdAt?: string;
+    state?: 'saved' | 'assigned' | 'event' | 'archived' | 'discarded' | 'unavailable';
+    assignedToName?: string;
+    eventHref?: string;
+}
+export interface QuickNoteCardProps {
+    note: QuickNote;
+    locale?: string;
+    timeZone?: string;
+    searchTargets?: (query: string, signal: AbortSignal) => Promise<ReadonlyArray<ComboboxOption>>;
+    onIntent?: IntentHandler<'assign' | 'make_event' | 'archive' | 'discard' | 'ask_instead'>;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare const UNDO_MS = 6000;
+export declare function QuickNoteCard(props: QuickNoteCardProps): ReactElement | null;

package/types/core/events/ShareApprovalCard/ShareApprovalCard.d.ts

@@ -0,0 +1,16 @@
+import { type CSSProperties, type ReactElement } from 'react';
+import { type IntentHandler } from '../_shared/intent';
+export interface ShareApprovalItem {
+    name: string;
+    projectName?: string;
+}
+export interface ShareApprovalCardProps {
+    mode?: 'share' | 'withdraw';
+    clientName?: string;
+    items?: ReadonlyArray<ShareApprovalItem>;
+    onIntent?: IntentHandler<'share' | 'withdraw'>;
+    onCancel?: () => void;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function ShareApprovalCard(props: ShareApprovalCardProps): ReactElement | null;

package/types/core/events/StartProcessCard/StartProcessCard.d.ts

@@ -0,0 +1,22 @@
+import { type CSSProperties, type ReactElement } from 'react';
+import { type IntentHandler } from '../_shared/intent';
+export interface StartProcessNeed {
+    label: string;
+    have?: boolean;
+}
+export interface StartProcessCardProps {
+    processName: string;
+    subjectName?: string;
+    description?: string;
+    needs?: ReadonlyArray<StartProcessNeed>;
+    typicalTime?: string;
+    typicalCost?: string;
+    costCap?: string;
+    running?: {
+        href?: string;
+    };
+    onIntent?: IntentHandler<'start_process'>;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function StartProcessCard(props: StartProcessCardProps): ReactElement | null;

package/types/core/events/SuggestedActions/SuggestedActions.d.ts

@@ -0,0 +1,10 @@
+import { type CSSProperties, type ReactElement } from 'react';
+import { type IntentHandler } from '../_shared/intent';
+export type SuggestedAction = 'save_as_note' | 'make_follow_up';
+export interface SuggestedActionsProps {
+    actions?: ReadonlyArray<SuggestedAction>;
+    onIntent?: IntentHandler<SuggestedAction>;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function SuggestedActions(props: SuggestedActionsProps): ReactElement | null;

package/types/core/events/TaskCard/TaskCard.d.ts

@@ -0,0 +1,17 @@
+import { type CSSProperties, type ReactElement } from 'react';
+import { type IntentHandler } from '../_shared/intent';
+export interface TaskView {
+    title: string;
+    dueOn?: string;
+    assigneeName?: string;
+    state?: 'proposed' | 'created' | 'done';
+}
+export interface TaskCardProps {
+    task: TaskView;
+    subjectName?: string;
+    locale?: string;
+    onIntent?: IntentHandler<'log_event' | 'complete'>;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function TaskCard(props: TaskCardProps): ReactElement | null;

package/types/core/events/WeekStrip/WeekStrip.d.ts

@@ -0,0 +1,16 @@
+import type { CSSProperties, ReactElement } from 'react';
+import { type EventView } from '../_shared/event';
+export interface WeekStripProps {
+    date?: string;
+    occurrences?: ReadonlyArray<EventView>;
+    weekStartsOn?: number;
+    param?: string;
+    steps?: boolean;
+    keep?: Readonly<Record<string, string>>;
+    locale?: string;
+    timeZone?: string;
+    now?: string | number;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function WeekStrip({ date, occurrences, weekStartsOn, param, steps, keep, locale, timeZone, now, className, style }: WeekStripProps): ReactElement;

package/types/core/events/_shared/SeriesGlyph.d.ts

@@ -0,0 +1,9 @@
+import type { ReactElement } from 'react';
+export declare const SERIES_SHAPES: readonly ["circle", "square", "triangle", "diamond", "plus", "hexagon"];
+export type SeriesShape = (typeof SERIES_SHAPES)[number];
+export declare const seriesShape: (series: number) => SeriesShape;
+export declare const seriesNumber: (series: unknown) => number;
+export declare function SeriesGlyph({ series, className }: {
+    series: number;
+    className?: string;
+}): ReactElement;

package/types/core/events/_shared/calendar.d.ts

@@ -0,0 +1,36 @@
+import { type EventView } from './event';
+export declare const DAY_MINUTES = 1440;
+export declare const OPEN_ENDED_MINUTES = 30;
+export interface Wall {
+    date: string;
+    minutes: number;
+}
+export declare function wallOf(instant: string | number | Date, timeZone?: string): Wall | null;
+export interface CalendarBlock {
+    event: EventView;
+    startMin: number;
+    endMin: number;
+    shownEndMin: number;
+    col: number;
+    cols: number;
+    continuesBefore: boolean;
+    continuesAfter: boolean;
+    busyOnly: boolean;
+    overlaps: boolean;
+}
+export interface DayLayout {
+    date: string;
+    blocks: CalendarBlock[];
+    allDay: EventView[];
+}
+export declare const isBusyOnly: (e: EventView) => boolean;
+export declare function layoutDay(events: ReadonlyArray<EventView>, date: string, { timeZone, minMinutes }?: {
+    timeZone?: string;
+    minMinutes?: number;
+}): DayLayout;
+export declare function visibleRange(days: ReadonlyArray<DayLayout>, startHour?: number, endHour?: number): {
+    fromMin: number;
+    toMin: number;
+};
+export declare function weekDates(date: string, weekStartsOn?: number): string[];
+export declare function overlapDays(events: ReadonlyArray<EventView>, dates: ReadonlyArray<string>, timeZone?: string): string[];

package/types/core/events/_shared/event.d.ts

@@ -10,6 +10,9 @@ export interface EventView {
     startOn?: string;
     endOn?: string;
     location?: string;
+    series?: number;
+    clientName?: string;
+    busyOnly?: boolean;
     cardComponent?: string;
 }
 export type RenderComponent = (key: string, props?: Record<string, unknown>) => unknown;
@@ -33,7 +36,10 @@ export interface WriteResult {
     success: boolean;
     id?: string;
     data?: unknown;
-    errors?: string;
+    errors?: string | ReadonlyArray<{
+        message: string;
+        field?: string;
+    }>;
     code?: 'DENIED' | 'CONFLICT' | 'INVALID' | 'FAILED';
 }
 export type Action<I> = (input: I) => Promise<WriteResult>;

package/types/core/events/_shared/intent.d.ts

@@ -0,0 +1,18 @@
+import { type WriteResult } from './event';
+export interface CardIntent<A extends string = string> {
+    action: A;
+    values?: Record<string, unknown>;
+}
+export type IntentHandler<A extends string = string> = (intent: CardIntent<A>) => Promise<WriteResult | void> | WriteResult | void;
+export declare function displayName(value: unknown): string | undefined;
+export declare const NOT_AVAILABLE = "This can\u2019t be done from here yet.";
+export declare function useIntent<A extends string>(handler: IntentHandler<A> | undefined): {
+    run: (action: A, values?: Record<string, unknown>) => Promise<{
+        ok: boolean;
+        result?: WriteResult | void;
+    }>;
+    busy: A | null;
+    message: string;
+    available: boolean;
+    clearMessage: () => void;
+};

package/types/core/events/_shared/path.d.ts

@@ -0,0 +1 @@
+export declare function sameOriginPath(value: unknown): string | undefined;