praxis-kit 1.1.0 → 2.0.0

package/dist/contract/index.d.ts

@@ -0,0 +1,130 @@
+import { ReadonlyDeep } from 'type-fest';
+
+type AnyRecord = Record<string, unknown>;
+
+type IntrinsicTag = keyof HTMLElementTagNameMap;
+
+type ElementType = IntrinsicTag | (string & {});
+
+declare const KNOWN_ARIA_ROLES: readonly ["alert", "alertdialog", "application", "article", "banner", "blockquote", "button", "caption", "cell", "checkbox", "code", "columnheader", "combobox", "complementary", "contentinfo", "definition", "deletion", "dialog", "document", "emphasis", "feed", "figure", "form", "generic", "grid", "gridcell", "group", "heading", "img", "insertion", "link", "list", "listbox", "listitem", "log", "main", "marquee", "math", "menu", "menubar", "menuitem", "menuitemcheckbox", "menuitemradio", "meter", "navigation", "none", "note", "option", "paragraph", "presentation", "progressbar", "radio", "radiogroup", "region", "row", "rowgroup", "rowheader", "scrollbar", "search", "searchbox", "separator", "slider", "spinbutton", "status", "strong", "subscript", "superscript", "switch", "tab", "table", "tablist", "tabpanel", "term", "textbox", "time", "timer", "toolbar", "tooltip", "tree", "treegrid", "treeitem"];
+type KnownAriaRole = (typeof KNOWN_ARIA_ROLES)[number];
+
+type AriaRole = KnownAriaRole | (string & {});
+
+type IntrinsicProps = AnyRecord & {
+    role?: AriaRole;
+};
+
+type StrictMode = boolean | 'warn' | 'async-warn' | 'throw';
+
+type CardinalityInput = {
+    min?: number;
+    max?: number;
+};
+
+type ChildRuleMatch<T, U extends T = T> = (child: T) => child is U;
+
+type ChildRulePosition = 'first' | 'last' | 'any';
+
+type ChildRuleInput<T = unknown, U extends T = T> = {
+    name: string;
+    match: ChildRuleMatch<T, U>;
+    cardinality?: CardinalityInput;
+    position?: ChildRulePosition;
+    /**
+     * Optional component-type reference for O(1) dispatch index.
+     * When provided for every rule, the matcher reads child.type instead of
+     * calling every match function on every child (O(n×m) → O(n+m)).
+     */
+    type?: unknown;
+};
+
+type ValidResult = {
+    valid: true;
+};
+
+type AriaContext = {
+    readonly tag: IntrinsicTag;
+    readonly implicitRole: AriaRole | undefined;
+    readonly effectiveRole: string | undefined;
+    readonly props: ReadonlyDeep<IntrinsicProps>;
+};
+
+type RemoveAttributeFixKind = `removeAttribute:${string}`;
+type InjectLiveFixKind = `injectLive:${string}`;
+type FixKind = 'removeRole' | 'setRole' | 'normalizeRelevantAll' | RemoveAttributeFixKind | InjectLiveFixKind;
+
+type AriaFixResult = {
+    applied: false;
+    next: ReadonlyDeep<IntrinsicProps>;
+} | {
+    applied: true;
+    next: ReadonlyDeep<IntrinsicProps>;
+    previous: ReadonlyDeep<IntrinsicProps>;
+};
+type AriaFix = {
+    readonly kind: FixKind;
+    readonly priority?: number;
+    readonly source?: string;
+    readonly apply: (context: AriaContext) => AriaFixResult;
+};
+
+type Severity = 'error' | 'warning' | (string & {});
+
+type AriaInvalidBase<M extends string = string> = {
+    valid: false;
+    severity: Severity;
+    message: M;
+    attribute?: string;
+};
+type AriaInvalidWithFix<M extends string = string> = AriaInvalidBase<M> & {
+    fixable: true;
+    fix: AriaFix;
+};
+type AriaInvalidWithoutFix<M extends string = string> = AriaInvalidBase<M> & {
+    fixable: false;
+};
+type AriaInvalidResult<M extends string = string> = AriaInvalidWithFix<M> | AriaInvalidWithoutFix<M>;
+type AriaResult = ValidResult | AriaInvalidResult;
+
+type AriaRule<C extends AriaContext = AriaContext> = (context: C) => readonly AriaResult[];
+
+type PropNormalizer = (props: Readonly<AnyRecord & IntrinsicProps>) => Partial<AnyRecord & IntrinsicProps>;
+
+type EnforcementOptions<TAllowed extends ElementType = ElementType> = {
+    readonly strict?: StrictMode;
+    readonly aria?: readonly AriaRule[];
+    readonly children?: readonly ChildRuleInput[];
+    readonly props?: readonly PropNormalizer[];
+    /** Restricts the `as` prop to this set of tags. Violations route through strict mode. */
+    readonly allowedAs?: readonly TAllowed[];
+};
+
+declare const activeProps: PropNormalizer;
+
+declare const disabledProps: PropNormalizer;
+
+declare const expandedProps: PropNormalizer;
+
+declare const invalidProps: PropNormalizer;
+
+declare const loadingProps: PropNormalizer;
+
+declare const pressedProps: PropNormalizer;
+
+declare const readonlyProps: PropNormalizer;
+
+declare const selectedProps: PropNormalizer;
+
+declare const activeContract: EnforcementOptions;
+declare const disabledContract: EnforcementOptions;
+declare const expandedContract: EnforcementOptions;
+declare const invalidContract: EnforcementOptions;
+declare const loadingContract: EnforcementOptions;
+declare const pressedContract: EnforcementOptions;
+declare const readonlyContract: EnforcementOptions;
+declare const selectedContract: EnforcementOptions;
+
+declare function mergeContracts(...contracts: readonly EnforcementOptions[]): EnforcementOptions;
+
+export { type PropNormalizer, activeContract, activeProps, disabledContract, disabledProps, expandedContract, expandedProps, invalidContract, invalidProps, loadingContract, loadingProps, mergeContracts, pressedContract, pressedProps, readonlyContract, readonlyProps, selectedContract, selectedProps };