@sladg/apex-state 3.0.2 → 3.0.3

package/dist/index.d.ts

@@ -223,6 +223,40 @@ type ArrayOfChanges<DATA, META extends GenericMeta = GenericMeta> = {
  * their return types for proper type-safe concern registration and reading.
  */
 
+/**
+ * Config type for the validationState concern at a specific path.
+ *
+ * Defined here (not in concerns/prebuilts/validation-state.ts) to avoid
+ * circular imports when used in ConcernRegistrationMap.
+ *
+ * Can be a schema for the path's own value type, or a scoped schema
+ * targeting a different path in the same state.
+ */
+type ValidationStateInput<DATA, PATH extends DeepKey<DATA>> = {
+    schema: z.ZodSchema<DeepValue<DATA, PATH>>;
+} | {
+    [SCOPE in DeepKey<DATA>]: {
+        scope: SCOPE;
+        schema: z.ZodSchema<DeepValue<DATA, SCOPE>>;
+    };
+}[DeepKey<DATA>];
+/**
+ * Get the appropriate registration config type for a concern at a given path.
+ *
+ * - validationState: schema must match DeepValue<DATA, PATH> — path-dependent
+ * - BoolLogic-based concerns: boolLogic paths are typed against DATA
+ * - Template-based concerns: fixed { template: string }
+ * - Custom concerns: fall back to Record<string, unknown>
+ */
+type ConcernConfigFor<C, DATA extends object, PATH extends DeepKey<DATA>> = C extends {
+    name: 'validationState';
+} ? ValidationStateInput<DATA, PATH> : C extends {
+    evaluate: (props: infer P) => any;
+} ? P extends {
+    boolLogic: any;
+} ? {
+    boolLogic: BoolLogic<DATA>;
+} : Omit<P, 'state' | 'path' | 'value'> : Record<string, unknown>;
 /**
  * Extract the return type from a concern's evaluate function
  *
@@ -261,8 +295,12 @@ type EvaluatedConcerns<CONCERNS extends readonly any[]> = {
 /**
  * Maps field paths to per-concern config objects.
  *
- * Used as the `registration` parameter for `useConcerns` / `registerConcernEffects`.
- * Each key is a `DeepKey<DATA>` path, and the value maps concern names to their config.
+ * When CONCERNS is provided (e.g., from createGenericStore's CONCERNS generic),
+ * each concern config is type-checked against:
+ * - The concern's own EXTRA_PROPS (e.g., `{ boolLogic: ... }` for disabledWhen)
+ * - The path's value type for validationState (schema must match DeepValue<DATA, PATH>)
+ *
+ * Without CONCERNS (standalone usage), falls back to loose typing for backward compatibility.
  *
  * @example
  * ```typescript
@@ -272,7 +310,13 @@ type EvaluatedConcerns<CONCERNS extends readonly any[]> = {
  * }
  * ```
  */
-type ConcernRegistrationMap<DATA extends object> = Partial<Record<DeepKey<DATA>, Partial<Record<string, unknown>>>>;
+type ConcernRegistrationMap<DATA extends object, CONCERNS extends readonly any[] = readonly any[]> = Partial<{
+    [PATH in DeepKey<DATA>]: Partial<{
+        [C in CONCERNS[number] as C extends {
+            name: string;
+        } ? C['name'] : never]: ConcernConfigFor<C, DATA, PATH>;
+    }>;
+}>;
 
 /**
  * DeepKeyFiltered - Filters paths by their resolved value type
@@ -384,8 +428,8 @@ interface BaseConcernProps<STATE, PATH extends string> {
     path: PATH;
     value: unknown;
 }
-interface ConcernType<EXTRA_PROPS = Record<string, unknown>, RETURN_TYPE = unknown> {
-    name: string;
+interface ConcernType<NAME extends string = string, EXTRA_PROPS = Record<string, unknown>, RETURN_TYPE = unknown> {
+    name: NAME;
     description: string;
     /** Evaluated inside effect() - all state accesses are tracked */
     evaluate: (props: BaseConcernProps<Record<string, unknown>, string> & EXTRA_PROPS) => RETURN_TYPE;
@@ -770,14 +814,6 @@ interface ValidationStateResult {
     isError: boolean;
     errors: ValidationError[];
 }
-type ValidationStateInput<SUB_STATE, PATH extends DeepKey<SUB_STATE>> = {
-    schema: z.ZodSchema<DeepValue<SUB_STATE, PATH>>;
-} | {
-    [SCOPE in DeepKey<SUB_STATE>]: {
-        scope: SCOPE;
-        schema: z.ZodSchema<DeepValue<SUB_STATE, SCOPE>>;
-    };
-}[DeepKey<SUB_STATE>];
 interface ValidationStateConcern {
     name: 'validationState';
     description: string;
@@ -796,21 +832,21 @@ declare const findConcern: (name: string, concerns?: readonly any[]) => ConcernT
 /**
  * Default concerns provided by apex-state
  */
-declare const defaultConcerns: readonly [ValidationStateConcern, ConcernType<{
+declare const defaultConcerns: readonly [ValidationStateConcern, ConcernType<"disabledWhen", {
     boolLogic: BoolLogic<any>;
-}, boolean>, ConcernType<{
+}, boolean>, ConcernType<"readonlyWhen", {
     boolLogic: BoolLogic<any>;
-}, boolean>, ConcernType<{
+}, boolean>, ConcernType<"visibleWhen", {
     boolLogic: BoolLogic<any>;
-}, boolean>, ConcernType<{
+}, boolean>, ConcernType<"dynamicTooltip", {
     template: string;
-}, string>, ConcernType<{
+}, string>, ConcernType<"dynamicLabel", {
     template: string;
-}, string>, ConcernType<{
+}, string>, ConcernType<"dynamicPlaceholder", {
     template: string;
 }, string>];
 
-declare const disabledWhen: ConcernType<{
+declare const disabledWhen: ConcernType<'disabledWhen', {
     boolLogic: BoolLogic<any>;
 }, boolean>;
 
@@ -833,7 +869,7 @@ declare const disabledWhen: ConcernType<{
  * ```
  */
 
-declare const readonlyWhen: ConcernType<{
+declare const readonlyWhen: ConcernType<'readonlyWhen', {
     boolLogic: BoolLogic<any>;
 }, boolean>;
 
@@ -856,7 +892,7 @@ declare const readonlyWhen: ConcernType<{
  * ```
  */
 
-declare const visibleWhen: ConcernType<{
+declare const visibleWhen: ConcernType<'visibleWhen', {
     boolLogic: BoolLogic<any>;
 }, boolean>;
 
@@ -879,7 +915,7 @@ declare const visibleWhen: ConcernType<{
  * ```
  */
 
-declare const dynamicLabel: ConcernType<{
+declare const dynamicLabel: ConcernType<'dynamicLabel', {
     template: string;
 }, string>;
 
@@ -902,7 +938,7 @@ declare const dynamicLabel: ConcernType<{
  * ```
  */
 
-declare const dynamicPlaceholder: ConcernType<{
+declare const dynamicPlaceholder: ConcernType<'dynamicPlaceholder', {
     template: string;
 }, string>;
 
@@ -925,24 +961,24 @@ declare const dynamicPlaceholder: ConcernType<{
  * ```
  */
 
-declare const dynamicTooltip: ConcernType<{
+declare const dynamicTooltip: ConcernType<'dynamicTooltip', {
     template: string;
 }, string>;
 
 /**
  * All pre-built concerns as a tuple (for use with findConcern)
  */
-declare const prebuilts: readonly [ValidationStateConcern, ConcernType<{
+declare const prebuilts: readonly [ValidationStateConcern, ConcernType<"disabledWhen", {
     boolLogic: BoolLogic<any>;
-}, boolean>, ConcernType<{
+}, boolean>, ConcernType<"readonlyWhen", {
     boolLogic: BoolLogic<any>;
-}, boolean>, ConcernType<{
+}, boolean>, ConcernType<"visibleWhen", {
     boolLogic: BoolLogic<any>;
-}, boolean>, ConcernType<{
+}, boolean>, ConcernType<"dynamicTooltip", {
     template: string;
-}, string>, ConcernType<{
+}, string>, ConcernType<"dynamicLabel", {
     template: string;
-}, string>, ConcernType<{
+}, string>, ConcernType<"dynamicPlaceholder", {
     template: string;
 }, string>];
 /**
@@ -950,22 +986,22 @@ declare const prebuilts: readonly [ValidationStateConcern, ConcernType<{
  */
 declare const prebuiltsNamespace: {
     validationState: ValidationStateConcern;
-    disabledWhen: ConcernType<{
+    disabledWhen: ConcernType<"disabledWhen", {
         boolLogic: BoolLogic<any>;
     }, boolean>;
-    readonlyWhen: ConcernType<{
+    readonlyWhen: ConcernType<"readonlyWhen", {
         boolLogic: BoolLogic<any>;
     }, boolean>;
-    visibleWhen: ConcernType<{
+    visibleWhen: ConcernType<"visibleWhen", {
         boolLogic: BoolLogic<any>;
     }, boolean>;
-    dynamicTooltip: ConcernType<{
+    dynamicTooltip: ConcernType<"dynamicTooltip", {
         template: string;
     }, string>;
-    dynamicLabel: ConcernType<{
+    dynamicLabel: ConcernType<"dynamicLabel", {
         template: string;
     }, string>;
-    dynamicPlaceholder: ConcernType<{
+    dynamicPlaceholder: ConcernType<"dynamicPlaceholder", {
         template: string;
     }, string>;
 };
@@ -1085,7 +1121,7 @@ interface SideEffects<DATA extends object, META extends GenericMeta = GenericMet
     listeners?: ListenerRegistration<DATA, META>[];
 }
 
-declare const createGenericStore: <DATA extends object, META extends GenericMeta = GenericMeta, CONCERNS extends readonly any[] = typeof defaultConcerns>(config?: StoreConfig) => {
+declare const createGenericStore: <DATA extends object, META extends GenericMeta = GenericMeta, CONCERNS extends readonly ConcernType<string, any, any>[] = typeof defaultConcerns>(config?: StoreConfig) => {
     Provider: {
         ({ initialState: rawInitialState, children, }: ProviderProps<DATA>): react_jsx_runtime.JSX.Element | null;
         displayName: string;
@@ -1101,12 +1137,14 @@ declare const createGenericStore: <DATA extends object, META extends GenericMeta
         getState: () => DATA;
     };
     useSideEffects: (id: string, effects: SideEffects<DATA, META>) => void;
-    useConcerns: (id: string, registration: ConcernRegistrationMap<DATA>, customConcerns?: readonly ConcernType<any, any>[]) => void;
-    withConcerns: <SELECTION extends Partial<Record<string, boolean>>>(selection: SELECTION) => {
+    useConcerns: <CUSTOM extends readonly ConcernType<string, any, any>[] = readonly []>(id: string, registration: ConcernRegistrationMap<DATA, readonly [...CONCERNS, ...CUSTOM]>, customConcerns?: CUSTOM) => void;
+    withConcerns: <SELECTION extends Partial<Record<Extract<CONCERNS[number], {
+        name: string;
+    }>["name"], boolean>>>(selection: SELECTION) => {
         useFieldStore: <P extends DeepKey<DATA>>(path: P) => {
             value: DATA extends readonly any[] ? DATA[number] : P extends `${infer First}.${infer Rest}` ? First extends keyof DATA ? DeepValue<DATA[First], Rest> : string extends keyof DATA ? First extends "[*]" ? DeepValue<DATA[keyof DATA & string], Rest> : unknown : unknown : P extends "[*]" ? string extends keyof DATA ? DATA[keyof DATA & string] : unknown : P extends keyof DATA ? DATA[P] : unknown;
             setValue: (newValue: DATA extends readonly any[] ? DATA[number] : P extends `${infer First}.${infer Rest}` ? First extends keyof DATA ? DeepValue<DATA[First], Rest> : string extends keyof DATA ? First extends "[*]" ? DeepValue<DATA[keyof DATA & string], Rest> : unknown : unknown : P extends "[*]" ? string extends keyof DATA ? DATA[keyof DATA & string] : unknown : P extends keyof DATA ? DATA[P] : unknown, meta?: META) => void;
-        } & { [K in keyof SELECTION as SELECTION[K] extends true ? K : never]?: K extends CONCERNS[number]["name"] ? EvaluatedConcerns<CONCERNS>[K] : never; };
+        } & { [K in keyof SELECTION as SELECTION[K] extends true ? K : never]?: K extends keyof EvaluatedConcerns<CONCERNS> ? EvaluatedConcerns<CONCERNS>[K] : never; };
     };
 };