praxis-kit 4.0.1 → 4.1.0

package/dist/lit/index.d.ts

@@ -1,8 +1,10 @@
-import { Except, RequireAtLeastOne, Simplify, ReadonlyDeep } from 'type-fest';
+import { RequireAtLeastOne, Simplify, ReadonlyDeep } from 'type-fest';
+import { Diagnostics, DiagnosticInput } from '../_shared/diagnostics.js';
 import { LitElement } from 'lit';
 
 type StringMap<T = unknown> = Record<string, T>;
 type AnyRecord = StringMap<unknown>;
+type EmptyRecord = Record<never, never>;
 
 type IntrinsicTag = keyof HTMLElementTagNameMap;
 
@@ -13,7 +15,6 @@ type KnownAriaRole = (typeof KNOWN_ARIA_ROLES)[number];
 
 type Booleanish = boolean | 'true' | 'false';
 type ClassName = string | string[];
-type EmptyRecord = Record<never, never>;
 type NonEmptyArray<T> = [T, ...T[]];
 type Numberish = number | `${number}`;
 type Primitive = string | number | boolean;
@@ -23,148 +24,6 @@ type IntrinsicProps = AnyRecord & {
 };
 type TagMap = Partial<Record<IntrinsicTag | (string & {}), ClassName>>;
 
-declare enum DiagnosticCategory {
-    Contract = 0,
-    HTML = 1,
-    ARIA = 2,
-    Composition = 3,
-    Rendering = 4,
-    Accessibility = 5,
-    Performance = 6,
-    Internal = 7,
-    Deprecation = 8,
-    Lint = 9
-}
-
-declare enum DiagnosticCode {
-    MissingRequiredChild = "COMP1001",
-    InvalidParent = "COMP1002",
-    InvalidChild = "COMP1003",
-    UnexpectedChild = "COMP1004",
-    AmbiguousChild = "COMP1005",
-    CardinalityMin = "COMP1006",
-    CardinalityMax = "COMP1007",
-    PositionViolation = "COMP1008",
-    AllowedAsViolation = "COMP1009",
-    SlotExclusive = "SLOT1001",
-    SlotSingleChild = "SLOT1002",
-    SlotDiscardedChildren = "SLOT1003",
-    SlotRenderFn = "SLOT1004",
-    MissingAriaRelationship = "ARIA2001",
-    AriaViolation = "ARIA2002",
-    AriaAttributeInvalid = "ARIA2003",
-    AriaMissingLiveRegion = "ARIA2004",
-    AriaMissingAtomic = "ARIA2005",
-    AriaRelevantInvalidToken = "ARIA2006",
-    AriaRelevantSuperseded = "ARIA2007",
-    AriaInvalidRole = "ARIA2008",
-    AriaMissingAccessibleName = "ARIA2009",
-    AriaAttributeOnPresentational = "ARIA2010",
-    AriaHiddenOnFocusable = "ARIA2011",
-    AriaRequiredProperty = "ARIA2012",
-    AriaInvalidAttributeValue = "ARIA2013",
-    AriaRedundantLevelAttribute = "ARIA2014",
-    InvalidHeadingHierarchy = "HTML3001",
-    HtmlEmptyRole = "HTML3002",
-    HtmlImplicitRoleRedundant = "HTML3003",
-    HtmlImplicitRoleOverride = "HTML3004",
-    HtmlStandaloneRegionOverride = "HTML3005",
-    HtmlLandmarkRoleOverride = "HTML3006",
-    HtmlInvalidChild = "HTML3007",
-    InvalidRenderingTarget = "RENDER4001",
-    LintDeadCompoundKey = "LINT5001",
-    LintDeadCompoundValue = "LINT5002",
-    LintDeadCompoundNonLiteral = "LINT5003",
-    LintMissingStrict = "LINT5004",
-    LintInvalidDefaultKey = "LINT5005",
-    LintInvalidDefaultValue = "LINT5006",
-    LintInvalidDefaultNonLiteral = "LINT5007",
-    LintNegativeMin = "LINT5008",
-    LintNegativeMax = "LINT5009",
-    LintMaxLessThanMin = "LINT5010",
-    LintZeroMax = "LINT5011",
-    LintMultipleFirst = "LINT5012",
-    LintMultipleLast = "LINT5013",
-    LintMinSumExceedsCapacity = "LINT5014",
-    LintCardinalityViolation = "LINT5015",
-    LintAriaTagOverride = "LINT5016",
-    ContractUnknownVariantDim = "COMP1010",
-    ContractUnknownVariantValue = "COMP1011",
-    ContractUnknownRecipeKey = "COMP1012",
-    ContractInvalidVariantValue = "COMP1013",
-    TailwindMultipleDisplayProps = "CSS6001",
-    TailwindReservedLayoutLiteral = "CSS6002",
-    TailwindDeadVariantClass = "CSS6003",
-    PluginInvalidShape = "PLUGIN7001",
-    PluginPipelineReturnType = "PLUGIN7002",
-    InternalError = "INTERNAL9000"
-}
-
-interface SourcePosition {
-    line: number;
-    col: number;
-}
-interface SourceLocation {
-    file: string;
-    start: SourcePosition;
-    end?: SourcePosition;
-}
-
-declare enum Severity$1 {
-    Debug = 0,
-    Info = 1,
-    Warning = 2,
-    Error = 3,
-    Fatal = 4
-}
-
-interface DiagnosticSuggestion {
-    title: string;
-    description?: string;
-    fix?: string;
-}
-
-type Context = AnyRecord;
-type Metadata = AnyRecord;
-interface Diagnostic {
-    code: DiagnosticCode;
-    severity: Severity$1;
-    category: DiagnosticCategory;
-    message: string;
-    rationale?: string;
-    component?: string;
-    contract?: string;
-    location?: SourceLocation;
-    suggestions?: DiagnosticSuggestion[];
-    context?: Context;
-    metadata?: Metadata;
-}
-
-declare enum Enforcement {
-    Ignore = 0,
-    Report = 1,
-    Throw = 2
-}
-interface DiagnosticPolicy {
-    resolve(diagnostic: Diagnostic): Enforcement;
-}
-
-interface DiagnosticReporter {
-    report(diagnostic: Diagnostic): void;
-}
-
-type DiagnosticInput = Except<Diagnostic, 'severity'>;
-declare class Diagnostics {
-    private readonly reporter;
-    private readonly policy;
-    readonly active: boolean;
-    constructor(reporter: DiagnosticReporter, policy?: DiagnosticPolicy);
-    report(diagnostic: Diagnostic): Diagnostic;
-    warn(input: DiagnosticInput): Diagnostic;
-    error(input: DiagnosticInput): Diagnostic;
-    info(input: DiagnosticInput): Diagnostic;
-}
-
 type MinMax = {
     min: number;
     max: number;
@@ -192,34 +51,16 @@ type ValidResult = {
     valid: true;
 };
 
-type RequireAtLeastOneIfNotEmpty<T> = keyof T extends never ? EmptyRecord : RequireAtLeastOne<T>;
-type CompoundVariantConditionValue<V extends VariantMap, K extends keyof V> = VariantKey<V, K> | NonEmptyArray<VariantKey<V, K>>;
-type CompoundVariantConditions<V extends VariantMap> = Simplify<{
-    [K in keyof V]: CompoundVariantConditionValue<V, K>;
-}>;
-type CompoundVariantRequiredConditions<V extends VariantMap> = RequireAtLeastOneIfNotEmpty<CompoundVariantConditions<V>>;
-type CompoundVariantBase<V extends VariantMap> = keyof V extends never ? EmptyRecord : CompoundVariantRequiredConditions<V>;
-type CompoundVariant<V extends VariantMap> = CompoundVariantBase<V> & {
-    class: VariantValue;
-};
-
-interface CVACompounds<V extends VariantMap> {
-    compoundVariants?: readonly CompoundVariant<V>[];
-}
-
-interface CVADefaults<V extends VariantMap> {
-    defaultVariants?: DefaultVariants<V>;
-}
-
-interface CVAVariants<V extends VariantMap> {
-    variants?: V;
-}
-
 type StringToBoolean<T> = T extends 'true' | 'false' ? boolean : T;
+
 type VariantValue = string | string[];
+
 type VariantStates<K extends string = string> = Record<K, VariantValue>;
+
 type VariantMap<V extends string = string, K extends string = string> = Record<V, VariantStates<K>>;
+
 type VariantKey<V extends VariantMap, K extends keyof V> = StringToBoolean<keyof V[K] & string>;
+
 /**
  * A partial selection of variant states authored at factory definition time.
  *
@@ -229,10 +70,12 @@ type VariantKey<V extends VariantMap, K extends keyof V> = StringToBoolean<keyof
 type VariantSelection<V extends VariantMap> = {
     [K in keyof V]?: keyof V[K];
 };
+
 type NormalizedVariantValue<K extends string> = string extends K ? Primitive : K extends 'true' | 'false' ? Booleanish : K extends `${number}` ? Numberish : K;
 type DefaultVariants<V extends VariantMap> = {
     [K in keyof V]?: NormalizedVariantValue<keyof V[K] & string>;
 };
+
 /**
  * A static, immutable map of named presets to partial variant selections.
  *
@@ -240,8 +83,32 @@ type DefaultVariants<V extends VariantMap> = {
  * avoiding the need to repeat variant combinations at each call site.
  */
 type RecipeMap<V extends VariantMap = VariantMap> = Readonly<Record<string, VariantSelection<V>>>;
+
 type RecipeTarget<TVariants extends VariantMap = VariantMap> = VariantSelection<TVariants>;
 
+type RequireAtLeastOneIfNotEmpty<T> = keyof T extends never ? EmptyRecord : RequireAtLeastOne<T>;
+type CompoundVariantConditionValue<V extends VariantMap, K extends keyof V> = VariantKey<V, K> | NonEmptyArray<VariantKey<V, K>>;
+type CompoundVariantConditions<V extends VariantMap> = Simplify<{
+    [K in keyof V]: CompoundVariantConditionValue<V, K>;
+}>;
+type CompoundVariantRequiredConditions<V extends VariantMap> = RequireAtLeastOneIfNotEmpty<CompoundVariantConditions<V>>;
+type CompoundVariantBase<V extends VariantMap> = keyof V extends never ? EmptyRecord : CompoundVariantRequiredConditions<V>;
+type CompoundVariant<V extends VariantMap> = CompoundVariantBase<V> & {
+    class: VariantValue;
+};
+
+interface CVACompounds<V extends VariantMap> {
+    compoundVariants?: readonly CompoundVariant<V>[];
+}
+
+interface CVADefaults<V extends VariantMap> {
+    defaultVariants?: DefaultVariants<V>;
+}
+
+interface CVAVariants<V extends VariantMap> {
+    variants?: V;
+}
+
 interface BaseClassOptions {
     baseClassName?: ClassName;
 }
@@ -273,7 +140,11 @@ type ClassPlugin<TProps extends AnyRecord = EmptyRecord> = Readonly<{
 }>;
 
 type ClassPluginFactory<TProps extends AnyRecord = EmptyRecord> = <V extends VariantMap>(options: ClassPipelineOptions<V>, diagnostics: Diagnostics) => ClassPlugin<TProps>;
-type ExtractPluginProps<TPlugin extends ClassPluginFactory<AnyRecord> | undefined> = TPlugin extends ClassPluginFactory<infer T> ? string extends keyof T ? EmptyRecord : T : EmptyRecord;
+/** `ClassPluginFactory` with its plugin-owned-props generic erased — the common form used
+ *  wherever a factory's concrete plugin-props shape isn't tracked (factory generics,
+ *  capability wiring). */
+type AnyClassPluginFactory = ClassPluginFactory<AnyRecord> | undefined;
+type ExtractPluginProps<TPlugin extends AnyClassPluginFactory> = TPlugin extends ClassPluginFactory<infer T> ? string extends keyof T ? EmptyRecord : T : EmptyRecord;
 
 type AriaContext = {
     readonly tag: IntrinsicTag;
@@ -333,7 +204,7 @@ type EnforcementOptions<TAllowed extends ElementType = ElementType> = {
     readonly allowedAs?: readonly TAllowed[];
 };
 
-type StylingOptions<V extends Readonly<VariantMap> = Readonly<EmptyRecord>, TPreset extends RecipeMap<V> = Readonly<EmptyRecord>, TPlugin extends ClassPluginFactory<AnyRecord> | undefined = ClassPluginFactory<AnyRecord> | undefined> = {
+type StylingOptions<V extends Readonly<VariantMap> = Readonly<EmptyRecord>, TPreset extends RecipeMap<V> = Readonly<EmptyRecord>, TPlugin extends AnyClassPluginFactory = AnyClassPluginFactory> = {
     readonly base?: ClassName;
     readonly variants?: V;
     readonly defaults?: Partial<DefaultVariants<V>>;
@@ -347,8 +218,8 @@ type StylingOptions<V extends Readonly<VariantMap> = Readonly<EmptyRecord>, TPre
 type NormalizeFn<Props extends AnyRecord = AnyRecord> = {
     normalize(props: Readonly<Props & IntrinsicProps>): Props & IntrinsicProps;
 }['normalize'];
-type AnyFactoryOptions = FactoryOptions<ElementType, AnyRecord, VariantMap, RecipeMap<VariantMap>, ClassPluginFactory<AnyRecord> | undefined>;
-type FactoryOptions<TDefault extends ElementType = ElementType, Props extends AnyRecord = EmptyRecord, V extends Readonly<VariantMap> = Readonly<EmptyRecord>, TPreset extends RecipeMap<V> = Readonly<EmptyRecord>, TPlugin extends ClassPluginFactory<AnyRecord> | undefined = ClassPluginFactory<AnyRecord> | undefined, TAllowed extends ElementType = ElementType> = {
+type AnyFactoryOptions = FactoryOptions<ElementType, AnyRecord, VariantMap, RecipeMap<VariantMap>, AnyClassPluginFactory>;
+type FactoryOptions<TDefault extends ElementType = ElementType, Props extends AnyRecord = EmptyRecord, V extends Readonly<VariantMap> = Readonly<EmptyRecord>, TPreset extends RecipeMap<V> = Readonly<EmptyRecord>, TPlugin extends AnyClassPluginFactory = AnyClassPluginFactory, TAllowed extends ElementType = ElementType> = {
     readonly tag?: TDefault;
     readonly name?: string;
     readonly defaults?: Partial<NoInfer<Props>>;
@@ -372,7 +243,7 @@ declare function defineContractComponent<O extends FactoryOptions>(options: O):
  * Note: this adapter targets Light DOM composition only. Shadow DOM slot
  * protocol is intentionally out of scope.
  */
-type LitFactoryOptions<TDefault extends ElementType = ElementType, TProps extends AnyRecord = EmptyRecord, TVariants extends Readonly<VariantMap> = Readonly<EmptyRecord>, TPreset extends RecipeMap<TVariants> = Readonly<EmptyRecord>, TPlugin extends ClassPluginFactory<AnyRecord> | undefined = ClassPluginFactory<AnyRecord> | undefined> = FactoryOptions<TDefault, TProps, TVariants, TPreset, TPlugin> & {
+type LitFactoryOptions<TDefault extends ElementType = ElementType, TProps extends AnyRecord = EmptyRecord, TVariants extends Readonly<VariantMap> = Readonly<EmptyRecord>, TPreset extends RecipeMap<TVariants> = Readonly<EmptyRecord>, TPlugin extends AnyClassPluginFactory = AnyClassPluginFactory> = FactoryOptions<TDefault, TProps, TVariants, TPreset, TPlugin> & {
     readonly filterProps?: FilterPredicate;
 };
 
@@ -414,7 +285,7 @@ type LitContractComponent<TVariants extends Readonly<VariantMap> = Readonly<Empt
  * customElements.define('praxis-button', Button)
  * ```
  */
-declare function createContractComponent<TDefault extends ElementType, TProps extends UnknownProps = EmptyRecord, TVariants extends Readonly<VariantMap> = Readonly<EmptyRecord>, TPreset extends RecipeMap<TVariants> = Readonly<EmptyRecord>, TPlugin extends ClassPluginFactory<AnyRecord> | undefined = ClassPluginFactory<AnyRecord> | undefined>(options: LitFactoryOptions<TDefault, TProps, TVariants, TPreset, TPlugin>): LitContractComponent<TVariants, ExtractPluginProps<TPlugin>>;
+declare function createContractComponent<TDefault extends ElementType, TProps extends UnknownProps = EmptyRecord, TVariants extends Readonly<VariantMap> = Readonly<EmptyRecord>, TPreset extends RecipeMap<TVariants> = Readonly<EmptyRecord>, TPlugin extends AnyClassPluginFactory = AnyClassPluginFactory>(options: LitFactoryOptions<TDefault, TProps, TVariants, TPreset, TPlugin>): LitContractComponent<TVariants, ExtractPluginProps<TPlugin>>;
 
 /**
  * Renders a praxis-kit Lit component to an HTML string without requiring a DOM.