feat: add field-level support to global rules

logaretm · Nov 25, 2023 · 43561e2 · 43561e2
1 parent 58b470f
commit 43561e2
Show file tree

Hide file tree

Showing 5 changed files with 86 additions and 21 deletions.
diff --git a/packages/rules/src/toTypedSchema.ts b/packages/rules/src/toTypedSchema.ts
@@ -35,21 +35,12 @@ export function toTypedSchema<TOutput = any, TInput extends Optional<TOutput> =
       };
     },
     describe(path) {
-      if (isObject(rawSchema) && path in rawSchema) {
-        const rules = (rawSchema as any)[path];
-        if (typeof rules === 'string') {
-          return {
-            exists: true,
-            required: rules.includes('required'),
-          };
-        }
+      if (!path) {
+        return getDescriptionFromExpression(rawSchema);
+      }
 
-        if (isObject(rules)) {
-          return {
-            exists: true,
-            required: !!rules.required,
-          };
-        }
+      if (isObject(rawSchema) && path in rawSchema) {
+        return getDescriptionFromExpression((rawSchema as any)[path]);
       }
 
       return {
@@ -61,3 +52,24 @@ export function toTypedSchema<TOutput = any, TInput extends Optional<TOutput> =
 
   return schema;
 }
+
+function getDescriptionFromExpression(rules: string | Record<string, any>) {
+  if (typeof rules === 'string') {
+    return {
+      exists: true,
+      required: rules.includes('required'),
+    };
+  }
+
+  if (isObject(rules)) {
+    return {
+      exists: true,
+      required: !!rules.required,
+    };
+  }
+
+  return {
+    required: false,
+    exists: true,
+  };
+}
diff --git a/packages/rules/tests/toTypedSchema.spec.ts b/packages/rules/tests/toTypedSchema.spec.ts
@@ -142,7 +142,7 @@ test('reports required state on fields', async () => {
   );
 });
 
-test('reports required state on fields', async () => {
+test('reports required false for non-existent fields', async () => {
   const metaSpy = vi.fn();
   mountWithHoc({
     setup() {
@@ -177,3 +177,56 @@ test('reports required state on fields', async () => {
     }),
   );
 });
+
+test('reports required state for field-level schemas', async () => {
+  const metaSpy = vi.fn();
+  mountWithHoc({
+    setup() {
+      useForm();
+      const { meta: req } = useField('req', toTypedSchema('required'));
+      const { meta: nreq } = useField('nreq', toTypedSchema('email'));
+
+      metaSpy({
+        req: req.required,
+        nreq: nreq.required,
+      });
+
+      return {};
+    },
+    template: `<div></div>`,
+  });
+
+  await flushPromises();
+  await expect(metaSpy).toHaveBeenLastCalledWith(
+    expect.objectContaining({
+      req: true,
+      nreq: false,
+    }),
+  );
+});
+
+test('reports required state for field-level schemas without a form context', async () => {
+  const metaSpy = vi.fn();
+  mountWithHoc({
+    setup() {
+      const { meta: req } = useField('req', toTypedSchema('required'));
+      const { meta: nreq } = useField('nreq', toTypedSchema('email'));
+
+      metaSpy({
+        req: req.required,
+        nreq: nreq.required,
+      });
+
+      return {};
+    },
+    template: `<div></div>`,
+  });
+
+  await flushPromises();
+  await expect(metaSpy).toHaveBeenLastCalledWith(
+    expect.objectContaining({
+      req: true,
+      nreq: false,
+    }),
+  );
+});
diff --git a/packages/valibot/tests/valibot.spec.ts b/packages/valibot/tests/valibot.spec.ts
@@ -473,7 +473,7 @@ test('reports required false for non-existent fields', async () => {
   );
 });
 
-test('reports required state single field schemas', async () => {
+test('reports required state for field-level schemas', async () => {
   const metaSpy = vi.fn();
   mountWithHoc({
     setup() {
@@ -500,7 +500,7 @@ test('reports required state single field schemas', async () => {
   );
 });
 
-test('reports required state single field schemas without a form context', async () => {
+test('reports required state for field-level schemas without a form context', async () => {
   const metaSpy = vi.fn();
   mountWithHoc({
     setup() {

diff --git a/packages/yup/tests/yup.spec.ts b/packages/yup/tests/yup.spec.ts
@@ -430,7 +430,7 @@ test('reports required false for non-existent fields', async () => {
   );
 });
 
-test('reports required state single field schemas', async () => {
+test('reports required state for field-level schemas', async () => {
   const metaSpy = vi.fn();
   mountWithHoc({
     setup() {
@@ -457,7 +457,7 @@ test('reports required state single field schemas', async () => {
   );
 });
 
-test('reports required state single field schemas without a form context', async () => {
+test('reports required state for field-level schemas without a form context', async () => {
   const metaSpy = vi.fn();
   mountWithHoc({
     setup() {

diff --git a/packages/zod/tests/zod.spec.ts b/packages/zod/tests/zod.spec.ts
@@ -524,7 +524,7 @@ test('reports required false for non-existent fields', async () => {
   );
 });
 
-test('reports required state single field schemas', async () => {
+test('reports required state for field-level schemas', async () => {
   const metaSpy = vi.fn();
   mountWithHoc({
     setup() {
@@ -551,7 +551,7 @@ test('reports required state single field schemas', async () => {
   );
 });
 
-test('reports required state single field schemas without a form context', async () => {
+test('reports required state for field-level schemas without a form context', async () => {
   const metaSpy = vi.fn();
   mountWithHoc({
     setup() {