feat: Better type tooling around custom config (FieldStatus types etc...) #132

Author: victorgarciaesgi

.github/workflows/build-test.yml

@@ -18,7 +18,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [20.x, 22.x]
+        node-version: [22.x]
 
     steps:
       - uses: actions/checkout@v4

packages/core/src/index.ts

@@ -109,6 +109,4 @@ export type {
   RegleUnknownRulesTree,
   HaveAnyRequiredProps,
   RegleCustomFieldStatus,
-  RegleCustomStatus,
-  RegleCustomCollectionStatus,
 } from './types';

packages/core/src/types/utils/props.types.ts

@@ -7,6 +7,7 @@ import type {
   RegleFieldStatus,
   RegleFormPropertyType,
   ReglePartialRuleTree,
+  RegleRuleTree,
   RegleStatus,
   SuperCompatibleRegle,
   UnwrapRuleTree,
@@ -49,8 +50,8 @@ export type RegleEnforceRequiredRules<TRules extends keyof DefaultValidators> =
 
  */
 export type RegleEnforceCustomRequiredRules<
-  T extends Partial<AllRulesDeclarations> | useRegleFn<any, any>,
-  TRules extends T extends useRegleFn<any, any> ? keyof InferRegleRules<T> : keyof T,
+  T extends useRegleFn<any, any>,
+  TRules extends keyof InferRegleRules<T>,
 > = Omit<Partial<DefaultValidatorsTree>, TRules> & {
   [K in TRules]-?: T extends useRegleFn<any, any>
     ? K extends keyof InferRegleRules<T>
@@ -69,23 +70,5 @@ export type RegleEnforceCustomRequiredRules<
 export type RegleCustomFieldStatus<
   T extends useRegleFn<any, any>,
   TState extends unknown = any,
-  TRules extends RegleFormPropertyType<any, Partial<AllRulesDeclarations>> = InferRegleRules<T>,
-> = RegleFieldStatus<TState, TRules, InferRegleShortcuts<T>>;
-
-/**
- * Extract custom rules and custom shortcuts and apply them to a RegleFieldStatus type
- */
-export type RegleCustomStatus<
-  T extends useRegleFn<any, any>,
-  TState extends Record<string, any> | undefined = Record<string, any>,
-  TRules extends ReglePartialRuleTree<NonNullable<TState>> = InferRegleRules<T>,
-> = RegleStatus<TState, TRules, InferRegleShortcuts<T>>;
-
-/**
- * Extract custom rules and custom shortcuts and apply them to a RegleFieldStatus type
- */
-export type RegleCustomCollectionStatus<
-  T extends useRegleFn<any, any>,
-  TState extends any[] = any[],
-  TRules extends ReglePartialRuleTree<ArrayElement<TState>> = InferRegleRules<T>,
-> = RegleCollectionStatus<TState, TRules, InferRegleShortcuts<T>>;
+  TRules extends keyof InferRegleRules<T> = keyof InferRegleRules<T>,
+> = RegleFieldStatus<TState, RegleEnforceCustomRequiredRules<T, TRules>, InferRegleShortcuts<T>>;

packages/core/tsdown.dev.ts

@@ -5,7 +5,7 @@ const sharedOptions: Options = {
   ...defaultOptions,
   entry: { 'regle-core': 'src/index.ts' },
   dts: true,
-  clean: false,
+  clean: true,
   external: ['vue', '@vue/reactivity', '@vue/runtime-core', '@vue/runtime-dom'],
   ignoreWatch: ['dist/**'],
   sourcemap: false,

tests/unit/types-errors/prop-types/Component-test.vue

@@ -5,32 +5,25 @@
 <script setup lang="ts">
 import type {
   CommonComparisonOptions,
-  InferRegleShortcuts,
   MaybeOutput,
-  RegleEnforceCustomRequiredRules,
+  RegleCustomFieldStatus,
   RegleEnforceRequiredRules,
   RegleFieldStatus,
   RegleRuleMetadataDefinition,
   RegleRuleStatus,
 } from '@regle/core';
 import type { useCustomRegle } from './prop-types.config';
 
-type MyShortcuts = InferRegleShortcuts<typeof useCustomRegle>;
-
 const props = defineProps<{
   unknownField: RegleFieldStatus;
   unknownExplicitField: RegleFieldStatus<unknown>;
   booleanField: RegleFieldStatus<boolean | undefined>;
   stringField: RegleFieldStatus<string | undefined>;
   stringNumberField: RegleFieldStatus<string | undefined> | RegleFieldStatus<number | undefined>;
-  customStringField: RegleFieldStatus<string | undefined, any, MyShortcuts>;
+  customStringField: RegleCustomFieldStatus<typeof useCustomRegle, string | undefined>;
   enforcedRulesField: RegleFieldStatus<string | undefined, RegleEnforceRequiredRules<'required'>>;
   enforcedMultipleRulesField: RegleFieldStatus<string | undefined, RegleEnforceRequiredRules<'required' | 'minLength'>>;
-  enforcedCustomRulesField: RegleFieldStatus<
-    string | undefined,
-    RegleEnforceCustomRequiredRules<typeof useCustomRegle, 'myCustomRule'>,
-    MyShortcuts
-  >;
+  enforcedCustomRulesField: RegleCustomFieldStatus<typeof useCustomRegle, string | undefined, 'myCustomRule'>;
 }>();
 
 // -