@peripheries/core 0.1.0

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

@@ -0,0 +1,7 @@
+import { type ReactElement } from 'react';
+export interface MathProps {
+    children?: string;
+    mode?: 'inline' | 'block';
+    className?: string;
+}
+export declare function Math({ children, mode, className }: MathProps): ReactElement;

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

@@ -0,0 +1,14 @@
+import type { CSSProperties, ReactElement } from 'react';
+import { type DocumentProfile, type ProfileId } from '../_shared/profile';
+export interface MetaField {
+    label: string;
+    value: string;
+}
+export interface MetaRailProps {
+    fields: ReadonlyArray<MetaField>;
+    profileId?: ProfileId;
+    profile?: DocumentProfile;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function MetaRail({ fields, profileId, profile, className, style }: MetaRailProps): ReactElement | null;

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

@@ -0,0 +1,15 @@
+import type { CSSProperties, ReactElement, ReactNode } from 'react';
+import { type DocumentProfile, type ProfileId } from '../_shared/profile';
+export interface NextStepItem {
+    body: ReactNode;
+    marker?: string;
+}
+export interface NextStepsProps {
+    items: ReadonlyArray<NextStepItem>;
+    profileId?: ProfileId;
+    profile?: DocumentProfile;
+    checkboxes?: boolean;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function NextSteps({ items, profileId, profile, checkboxes, className, style }: NextStepsProps): ReactElement | null;

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

@@ -0,0 +1,12 @@
+import type { CSSProperties, ReactElement } from 'react';
+import { type DocumentProfile, type ProfileId } from '../_shared/profile';
+export declare const WRITE_LINE_HEIGHT_PX = 38;
+export interface NotesProps {
+    title?: string;
+    lines?: number;
+    profileId?: ProfileId;
+    profile?: DocumentProfile;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function Notes({ title, lines, profileId, profile, className, style }: NotesProps): ReactElement | null;

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

@@ -0,0 +1,5 @@
+import type { ReactElement } from 'react';
+export interface PageBreakProps {
+    className?: string;
+}
+export declare function PageBreak({ className }: PageBreakProps): ReactElement;

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

@@ -0,0 +1,11 @@
+import type { CSSProperties, ReactElement, ReactNode } from 'react';
+import { type DocumentProfile, type ProfileId } from '../_shared/profile';
+export interface ProseProps {
+    children?: ReactNode;
+    profileId?: ProfileId;
+    profile?: DocumentProfile;
+    full?: boolean;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function Prose({ children, profileId, profile, full, className, style }: ProseProps): ReactElement;

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

@@ -0,0 +1,8 @@
+import type { CSSProperties, ReactElement, ReactNode } from 'react';
+export interface QuoteProps {
+    children?: ReactNode;
+    citation?: ReactNode;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function Quote({ children, citation, className, style }: QuoteProps): ReactElement;

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

@@ -0,0 +1,18 @@
+import type { CSSProperties, ReactElement } from 'react';
+import type { SectionReference } from '../_shared/host';
+import { type ReferenceForm } from '../_shared/ordinal-format';
+import { type DocumentProfile, type ProfileId } from '../_shared/profile';
+export interface ReferenceProps {
+    target: string;
+    form?: ReferenceForm;
+    sectionReferences?: Readonly<Record<string, SectionReference>>;
+    sectionNumbers?: Readonly<Record<string, ReadonlyArray<number>>>;
+    sectionTitles?: Readonly<Record<string, string>>;
+    sectionAnchors?: Readonly<Record<string, string>>;
+    profileId?: ProfileId;
+    profile?: DocumentProfile;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function Reference({ target, form, sectionReferences, sectionNumbers, sectionTitles, sectionAnchors, profileId, profile, className, style, }: ReferenceProps): ReactElement;
+export default Reference;

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

@@ -0,0 +1,19 @@
+import type { CSSProperties, ReactElement, ReactNode } from 'react';
+import { type DocumentProfile, type ProfileId } from '../_shared/profile';
+export interface RowListItem {
+    marker?: string;
+    primary: ReactNode;
+    secondary?: ReactNode;
+    missing?: boolean;
+}
+export interface RowListProps {
+    items: ReadonlyArray<RowListItem>;
+    profileId?: ProfileId;
+    profile?: DocumentProfile;
+    markerWidth?: number;
+    secondaryWidth?: number;
+    missingLabel?: string;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function RowList({ items, profileId, profile, markerWidth, secondaryWidth, missingLabel, className, style, }: RowListProps): ReactElement | null;

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

@@ -0,0 +1,12 @@
+import type { CSSProperties, ReactElement, ReactNode } from 'react';
+import { type DocumentProfile, type ProfileId } from '../_shared/profile';
+export interface RunningFooterProps {
+    left?: ReactNode;
+    centre?: ReactNode;
+    right?: ReactNode;
+    profileId?: ProfileId;
+    profile?: DocumentProfile;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function RunningFooter({ left, centre, right, profileId, profile, className, style }: RunningFooterProps): ReactElement | null;

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

@@ -0,0 +1,11 @@
+import type { CSSProperties, ReactElement } from 'react';
+import { type DocumentProfile, type ProfileId } from '../_shared/profile';
+export interface SkippedSectionProps {
+    wouldTell: string;
+    openingLine?: string;
+    profileId?: ProfileId;
+    profile?: DocumentProfile;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function SkippedSection({ wouldTell, openingLine, profileId, profile, className, style }: SkippedSectionProps): ReactElement;

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

@@ -0,0 +1,18 @@
+import type { CSSProperties, ReactElement, ReactNode } from 'react';
+import { type DocumentProfile, type ProfileId } from '../_shared/profile';
+export interface TalkItThroughAdvisor {
+    name: string;
+    role?: string;
+    phone?: string;
+    email?: string;
+}
+export interface TalkItThroughProps {
+    advisor: TalkItThroughAdvisor;
+    title?: string;
+    invitation?: ReactNode;
+    profileId?: ProfileId;
+    profile?: DocumentProfile;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function TalkItThrough({ advisor, title, invitation, profileId, profile, className, style, }: TalkItThroughProps): ReactElement | null;

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

@@ -0,0 +1,13 @@
+import type { CSSProperties, ReactElement } from 'react';
+import { type DocumentProfile, type ProfileId } from '../_shared/profile';
+export declare const WRITE_HEIGHT_PX = 38;
+export interface WriteInFieldProps {
+    question?: string;
+    answer?: string;
+    lines?: number;
+    profileId?: ProfileId;
+    profile?: DocumentProfile;
+    className?: string;
+    style?: CSSProperties;
+}
+export declare function WriteInField({ question, answer, lines, profileId, profile, className, style }: WriteInFieldProps): ReactElement;

package/types/core/document/_shared/block-schemas.d.ts

@@ -0,0 +1,3 @@
+import type { Block } from './blocks';
+export type JsonSchemaNode = Record<string, unknown>;
+export declare const BLOCK_SCHEMAS: Record<Block['kind'], JsonSchemaNode>;

package/types/core/document/_shared/blocks.d.ts

@@ -0,0 +1,88 @@
+export interface ProseBlock {
+    kind: 'prose';
+    text: string;
+    full?: boolean;
+}
+export interface ClauseItem {
+    marker?: string;
+    level?: number;
+    id?: string;
+    text: string;
+    note?: string;
+    missing?: boolean;
+}
+export interface ClauseBlock {
+    kind: 'clause';
+    items: ReadonlyArray<ClauseItem>;
+}
+export interface DefinitionsBlock {
+    kind: 'definitions';
+    pairs: ReadonlyArray<{
+        term: string;
+        description: string;
+    }>;
+}
+export interface TableBlock {
+    kind: 'table';
+    caption?: string;
+    columns: ReadonlyArray<{
+        header: string;
+        align?: 'left' | 'right' | 'center';
+    }>;
+    rows: ReadonlyArray<ReadonlyArray<string>>;
+}
+export interface NoticeBlock {
+    kind: 'notice';
+    tone: 'note' | 'warning' | 'important';
+    title?: string;
+    text: string;
+}
+export interface FigureBlock {
+    kind: 'figure';
+    caption: string;
+    src?: string;
+    placeholder?: string;
+}
+export interface ExecutionSignatoryInput {
+    role: string;
+    name?: string;
+    detail?: string;
+    dated?: boolean;
+}
+export interface ExecutionBlockInput {
+    kind: 'execution';
+    label?: string;
+    attestation?: string;
+    signatories: ReadonlyArray<ExecutionSignatoryInput>;
+    columns?: 1 | 2;
+    note?: string;
+}
+export type Block = ProseBlock | ClauseBlock | DefinitionsBlock | TableBlock | NoticeBlock | FigureBlock | ExecutionBlockInput;
+export type BlockKind = Block['kind'];
+export declare const BLOCK_KINDS: ReadonlyArray<BlockKind>;
+export declare const REF_TOKEN: RegExp;
+export declare const ELEMENT_ID: RegExp;
+export type ReferenceForm = 'title' | 'full' | 'number';
+export interface ParsedReference {
+    key: string;
+    doc?: string;
+    unit: string;
+    element?: string;
+    form?: ReferenceForm;
+}
+export declare function parseTarget(raw: string, form?: string): ParsedReference | null;
+export declare function leafOf(unit: string): string;
+export interface ReferenceScan {
+    refs: ParsedReference[];
+    malformed: string[];
+}
+export declare function scanReferences(text: string): ReferenceScan;
+export type TextSegment = {
+    kind: 'text';
+    text: string;
+} | ({
+    kind: 'ref';
+} & ParsedReference);
+export declare function splitReferences(text: string): TextSegment[];
+export declare function hasReference(text: string): boolean;
+export declare function referencesIn(text: string): string[];

package/types/core/document/_shared/footnote-context.d.ts

@@ -0,0 +1,19 @@
+import { type ReactNode } from 'react';
+export interface FootnoteEntry {
+    id: string;
+    number: number;
+    content: ReactNode;
+}
+interface FootnoteState {
+    footnotes: FootnoteEntry[];
+}
+export interface FootnoteContextValue {
+    state: FootnoteState;
+    registerFootnote: (entry: Omit<FootnoteEntry, 'number'>) => number;
+    unregisterFootnote: (id: string) => void;
+}
+export declare function useFootnoteContext(): FootnoteContextValue | null;
+export declare function FootnoteProvider({ children }: {
+    children?: ReactNode;
+}): import("react").JSX.Element;
+export {};

package/types/core/document/_shared/host.d.ts

@@ -0,0 +1,15 @@
+export interface ClauseShape {
+    level?: number;
+    marker?: string;
+}
+export interface SectionReference {
+    number?: ReadonlyArray<number>;
+    title?: string;
+    anchor?: string;
+    href?: string;
+    openable: boolean;
+    element?: {
+        index: number;
+        shape: ReadonlyArray<ClauseShape>;
+    };
+}

package/types/core/document/_shared/ordinal-format.d.ts

@@ -0,0 +1,7 @@
+export { hasReference, leafOf, parseTarget, splitReferences, type ParsedReference, type ReferenceForm, type TextSegment } from './blocks';
+export declare function articleLabel(ordinal: ReadonlyArray<number>): string | null;
+export declare function articleInline(ordinal: ReadonlyArray<number>): string | null;
+export declare function clauseNumbers(sectionOrdinal: ReadonlyArray<number> | undefined, shape: ReadonlyArray<{
+    level?: number;
+    marker?: string;
+}>, numbering: 'none' | 'ladder' | undefined): Array<string | undefined>;

package/types/core/document/_shared/profile.d.ts

@@ -0,0 +1,15 @@
+export { DEFAULT_PROFILE_ID, profileIds, resolveProfile, resolveProfileOrDefault, safeResolveProfile } from '../profiles/registry';
+export type { DocumentProfile, ProfileId } from '../profiles/profile';
+export { warnOnce } from '../../_shared/warn-once';
+export declare const profileAttr: (profileId: string | undefined) => {
+    'data-profile': string;
+} | {
+    'data-profile'?: undefined;
+};
+export declare const fillsAttr: (profile: {
+    fills?: boolean;
+} | null | undefined) => {
+    'data-fills': string;
+} | {
+    'data-fills'?: undefined;
+};

package/types/core/document/_shared/section-anchors.d.ts

@@ -0,0 +1 @@
+export declare function resolveAnchor(anchors: Readonly<Record<string, string>> | undefined, role: string): string;

package/types/core/document/profiles/builtin.d.ts

@@ -0,0 +1,5 @@
+import { type DocumentProfile, type ProfileDefinition } from './profile';
+export declare const workbookProfile: DocumentProfile;
+export declare const reportProfile: ProfileDefinition;
+export declare const instrumentProfile: ProfileDefinition;
+export declare const BUILTIN_PROFILES: ReadonlyArray<ProfileDefinition>;

package/types/core/document/profiles/profile.d.ts

@@ -0,0 +1,68 @@
+export type ProfileId = string;
+export type DocumentTypeRole = 'display' | 'heading' | 'subhead' | 'title' | 'body' | 'bodySmall' | 'label' | 'note' | 'eyebrow';
+export interface TypeRole {
+    size: number;
+    lineHeight: number;
+    weight: number;
+    tracking: string;
+    uppercase?: boolean;
+}
+export type InkRole = 'full' | 'muted' | 'subtle' | 'border' | 'accent' | 'accentText' | 'sunken';
+export type RuleWeight = 'structural' | 'hairline' | 'head' | 'row';
+export type RegionBinding = 'page-x-of-y' | 'page-number' | 'page-count' | 'member-ref' | 'document-id' | 'document-version' | 'generated-at' | 'execution-state';
+export declare const PAGINATOR_BINDINGS: ReadonlyArray<RegionBinding>;
+export interface PageRegionSlots {
+    left?: RegionBinding;
+    centre?: RegionBinding;
+    right?: RegionBinding;
+}
+export interface PageRegions {
+    'page-header'?: PageRegionSlots;
+    'page-footer'?: PageRegionSlots;
+}
+export interface DocumentProfile {
+    id: ProfileId;
+    extends?: ProfileId;
+    label: string;
+    sheet: {
+        width: string;
+        height: string;
+    };
+    margins: {
+        top: string;
+        right: string;
+        bottom: string;
+        left: string;
+    };
+    measure: string;
+    bodyMeasureCh?: number;
+    rail: {
+        placement: 'strip' | 'column' | 'none';
+        axis?: string;
+        width?: string;
+        gutter?: string;
+    };
+    ink: Record<InkRole, string>;
+    rules: Partial<Record<RuleWeight, string>>;
+    type: Record<DocumentTypeRole, TypeRole>;
+    floorPx: number;
+    depth: {
+        max: number;
+        indent: string[];
+        numbering: 'none' | 'ladder';
+    };
+    fills: boolean;
+    regions?: PageRegions;
+    requiredBindings?: ReadonlyArray<RegionBinding>;
+    sections?: {
+        required?: string[];
+        known?: string[];
+    };
+}
+export type ProfileDefinition = DocumentProfile | (Partial<Omit<DocumentProfile, 'id' | 'extends' | 'label'>> & {
+    id: ProfileId;
+    extends: ProfileId;
+    label: string;
+});
+export declare const DOCUMENT_TYPE_SCALE: Record<DocumentTypeRole, TypeRole>;
+export declare const THEMED_INK: Record<InkRole, string>;

package/types/core/document/profiles/registry.d.ts

@@ -0,0 +1,9 @@
+import type { DocumentProfile, ProfileDefinition, ProfileId } from './profile';
+export declare function registerProfile(profile: ProfileDefinition): void;
+export declare function profileIds(): ProfileId[];
+export declare function resolveProfile(id: ProfileId): DocumentProfile;
+export declare function resolvedProfiles(): Record<ProfileId, DocumentProfile>;
+export declare const documentProfiles: Readonly<Record<ProfileId, DocumentProfile>>;
+export declare const DEFAULT_PROFILE_ID: ProfileId;
+export declare function safeResolveProfile(id: ProfileId, component: string): DocumentProfile | null;
+export declare function resolveProfileOrDefault(id: ProfileId | undefined, component: string): DocumentProfile | null;

package/types/core/document/profiles/tokens.d.ts

@@ -0,0 +1,3 @@
+import type { DocumentProfile } from './profile';
+export declare function profileTokens(p: DocumentProfile): Record<string, string>;
+export declare function profileCss(profiles: ReadonlyArray<DocumentProfile>, defaultId?: string): string;

package/types/index.core.d.ts

@@ -0,0 +1,54 @@
+export { cx, length, vars } from './core/_shared/props';
+export { Box } from './core/Box/Box';
+export { Center } from './core/Center/Center';
+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 { Show } from './core/Show/Show';
+export { Spacer } from './core/Spacer/Spacer';
+export { Stack } from './core/Stack/Stack';
+export { DEFAULT_PROFILE_ID, documentProfiles, profileIds, registerProfile, resolveProfile, resolvedProfiles } from './core/document/profiles/registry';
+export { profileCss, profileTokens } from './core/document/profiles/tokens';
+export { PAGINATOR_BINDINGS, type DocumentProfile, type ProfileDefinition, type ProfileId, type RegionBinding } from './core/document/profiles/profile';
+export { BLOCK_KINDS, type Block, type BlockKind } from './core/document/_shared/blocks';
+export { Aside, type AsideProps, type AsideTone } from './core/document/Aside/Aside';
+export { Prose } from './core/document/Prose/Prose';
+export { Quote } from './core/document/Quote/Quote';
+export { Definition } from './core/document/Definition/Definition';
+export { Math } from './core/document/Math/Math';
+export { Footnote } from './core/document/Footnote/Footnote';
+export { Figure } from './core/document/Figure/Figure';
+export { PageBreak } from './core/document/PageBreak/PageBreak';
+export { DocumentLabel } from './core/document/DocumentLabel/DocumentLabel';
+export { Reference } from './core/document/Reference/Reference';
+export { DocumentTable } from './core/document/DocumentTable/DocumentTable';
+export { RowList, type RowListItem, type RowListProps } from './core/document/RowList/RowList';
+export { AnswerRows, ANSWER_COLUMN_PX, type AnswerRowItem, type AnswerRowsProps } from './core/document/AnswerRows/AnswerRows';
+export { ComparisonBars, type ComparisonBar, type ComparisonBarsProps } from './core/document/ComparisonBars/ComparisonBars';
+export { NextSteps, type NextStepItem, type NextStepsProps } from './core/document/NextSteps/NextSteps';
+export { Notes, WRITE_LINE_HEIGHT_PX, type NotesProps } from './core/document/Notes/Notes';
+export { SkippedSection, type SkippedSectionProps } from './core/document/SkippedSection/SkippedSection';
+export { TalkItThrough, type TalkItThroughAdvisor, type TalkItThroughProps } from './core/document/TalkItThrough/TalkItThrough';
+export { WriteInField, WRITE_HEIGHT_PX, type WriteInFieldProps } from './core/document/WriteInField/WriteInField';
+export { Masthead, type MastheadProps } from './core/document/Masthead/Masthead';
+export { MetaRail, type MetaField, type MetaRailProps } from './core/document/MetaRail/MetaRail';
+export { RunningFooter, type RunningFooterProps } from './core/document/RunningFooter/RunningFooter';
+export { DocumentShell, type DocumentShellProps } from './core/document/DocumentShell/DocumentShell';
+export { Contents, type ContentsEntry, type ContentsProps } from './core/document/Contents/Contents';
+export { ExecutionBlock, type ExecutionBlockProps, type ExecutionSignatory } from './core/document/ExecutionBlock/ExecutionBlock';
+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 { 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';
+export { SectionHeader, type SectionHeaderProps } from './core/display/SectionHeader/SectionHeader';
+export { HighlightBox, type HighlightBoxProps } from './core/display/HighlightBox/HighlightBox';
+export { DisclaimerBlock, type DisclaimerBlockProps } from './core/display/DisclaimerBlock/DisclaimerBlock';
+export { StatStrip, type StatStripProps } from './core/display/StatStrip/StatStrip';
+export { OptionCard, type OptionCardBar, type OptionCardProps } from './core/display/OptionCard/OptionCard';
+export { ProfileCard, type ProfileCardProps, type ProfileRow, type ProfileRowBadge } from './core/display/ProfileCard/ProfileCard';
+export { KpiCardGrid, KpiGrid, type KpiCard, type KpiCardBadge, type KpiCardGridProps } from './core/display/KpiCardGrid/KpiCardGrid';
+export { DataTable, type DataTableAlign, type DataTableCell, type DataTableCellInput, type DataTableColumn, type DataTableProps, type DataTableRow, } from './core/display/DataTable/DataTable';