Added FormPathArrays type.

Author: ciscoheat

CHANGELOG.md

@@ -5,6 +5,12 @@ Headlines: Added, Changed, Deprecated, Removed, Fixed, Security
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- Added `FormPathArrays` type, enumerating all arrays in an object as string accessors.
+
 ## [1.9.0] - 2023-10-31
 
 ### Added

src/lib/index.ts

@@ -34,7 +34,11 @@ export type ZodValidation<T extends AnyZodObject> =
   | ZodEffects<ZodEffects<ZodEffects<ZodEffects<T>>>>
   | ZodEffects<ZodEffects<ZodEffects<ZodEffects<ZodEffects<T>>>>>;
 
-export { type FormPath, type FormPathLeaves } from './stringPath.js';
+export {
+  type FormPath,
+  type FormPathLeaves,
+  type FormPathArrays
+} from './stringPath.js';
 
 export type RawShape<T> = T extends ZodObject<infer U> ? U : never;
 

src/lib/stringPath.ts

@@ -21,39 +21,47 @@ export function mergePath(path: (string | number | symbol)[]) {
 /**
  * Lists all paths in an object as string accessors.
  */
-export type FormPath<T extends object, OnlyArrays extends boolean = false> =
-  | (string & StringPath<T, OnlyArrays>)
+export type FormPath<T extends object> =
+  | (string & StringPath<T>)
   | FormPathLeaves<T>;
 
 /**
- * Like FormPath, but only with non-objects as accessible properties.
+ * List paths in an object as string accessors, but only with non-objects as accessible properties.
  * Similar to the leaves in a node tree, if you look at the object as a tree structure.
  */
 export type FormPathLeaves<T extends object> = string & StringPathLeaves<T>;
 
+/**
+ * List all arrays in an object as string accessors.
+ */
+export type FormPathArrays<T extends object> = string &
+  Exclude<StringPath<T, true>, FormPathLeaves<T>>;
+
 export type StringPath<
   T extends object,
   OnlyArrays extends boolean = false
 > = NonNullable<T> extends (infer U)[]
   ? NonNullable<U> extends object
     ?
-        | `[${number}]`
-        | `[${number}]${U extends unknown[]
+        | (OnlyArrays extends false
+            ? `[${number}]`
+            : NonNullable<U> extends unknown[]
+            ? `[${number}]`
+            : never)
+        | `[${number}]${NonNullable<U> extends unknown[]
             ? ''
             : '.'}${NonNullable<U> extends Date | Set<unknown>
             ? never
-            : StringPath<NonNullable<U>> & string}`
-    : `[${number}]` /*| `[${number}].${U & string}`*/
+            : StringPath<NonNullable<U>, OnlyArrays> & string}`
+    : `[${number}]`
   : NonNullable<T> extends object
   ?
       | (OnlyArrays extends false
           ? keyof T
           : {
               [K in keyof T]-?: K extends string
-                ? NonNullable<T[K]> extends (infer U2)[]
-                  ? U2 extends object
-                    ? never
-                    : K
+                ? NonNullable<T[K]> extends unknown[]
+                  ? K
                   : never
                 : never;
             }[keyof T])
@@ -64,7 +72,7 @@ export type StringPath<
                   ? ''
                   : '.'}${NonNullable<T[K]> extends Date | Set<unknown>
                   ? never
-                  : StringPath<NonNullable<T[K]>> & string}`
+                  : StringPath<NonNullable<T[K]>, OnlyArrays> & string}`
               : never
             : never;
         }[keyof T]

src/paths.test-d.ts

@@ -2,9 +2,11 @@
 import type {
   StringPath,
   FormPathType,
+  FormPathArrays,
   StringPathLeaves
 } from '$lib/stringPath';
 import { test } from 'vitest';
+import type { z } from 'zod';
 
 type Obj = {
   name: string;
@@ -16,29 +18,53 @@ type Obj = {
   tags:
     | ({ id: number; name: string; parents: number[] } | null)[]
     | undefined;
+  names: string[];
 };
 
 const i = 7 + 3;
 
 type Test = StringPath<Obj>;
+type Arrays = FormPathArrays<Obj>;
 
 test('StringPath', () => {
-  const a1: Test = 'name';
-  const a2: Test = 'city';
-  const a3: Test = 'tags';
-  const a4: Test = 'city.name';
-  const a5: Test = 'tags[3]';
-  const a6: Test = 'tags[3].name';
-  const a7: Test = 'scores[3][4]';
+  const t1: Test = 'name';
+  const t2: Test = 'city';
+  const t3: Test = 'tags';
+  const t4: Test = 'city.name';
+  const t5: Test = 'tags[3]';
+  const t6: Test = 'tags[3].name';
+  const t7: Test = 'scores[3][4]';
+  const t8: Test = 'names[3]';
 
   // @ts-expect-error incorrect path
-  const n8: Test = 'city[3]';
+  const t1e: Test = 'city[3]';
   // @ts-expect-error incorrect path
-  const n7: Test = 'city.nope';
+  const t2e: Test = 'city.nope';
   // @ts-expect-error incorrect path
-  const n9: Test = 'tags[4].nope';
+  const t3e: Test = 'tags[4].nope';
   // @ts-expect-error incorrect path
-  const n0: Test = 'nope';
+  const t4e: Test = 'nope';
+  // @ts-expect-error incorrect path
+  const t5e: Test = 'names[2].test';
+
+  const a1: Arrays = 'scores';
+  const a2: Arrays = 'scores[3]';
+  const a3: Arrays = 'tags';
+  const a4: Arrays = 'tags[2].parents';
+  const a5: Arrays = 'names';
+
+  // @ts-expect-error incorrect path
+  const a1e: Arrays = 'name';
+  // @ts-expect-error incorrect path
+  const a2e: Arrays = 'points';
+  // @ts-expect-error incorrect path
+  const a3e: Arrays = 'scores[2][1]';
+  // @ts-expect-error incorrect path
+  const a4e: Arrays = 'city';
+  // @ts-expect-error incorrect path
+  const a5e: Arrays = 'tags[1]';
+  // @ts-expect-error incorrect path
+  const a6e: Arrays = 'names[1]';
 });
 
 function checkPath<T = never>() {

src/routes/tests/array-component/+page.svelte

@@ -4,17 +4,8 @@
   import SuperDebug from '$lib/client/SuperDebug.svelte';
   import AutoComplete from './AutoComplete.svelte';
 
-  import type { FormPath, FormPathLeaves } from '$lib';
-  import type { schema } from './schema';
-  import type { z } from 'zod';
-
   export let data: PageData;
 
-  type FP = FormPath<z.infer<typeof schema>, true>;
-  type FPL = FormPathLeaves<z.infer<typeof schema>>;
-
-  type OK = Exclude<FP, FPL>;
-
   const pageForm = superForm(data.form, {
     //dataType: 'json',
     //validators: schema
@@ -41,13 +32,5 @@
 <style lang="scss">
   form {
     margin: 2rem 0;
-
-    input {
-      background-color: #dedede;
-    }
-
-    .invalid {
-      color: crimson;
-    }
   }
 </style>

src/routes/tests/array-component/AutoComplete.svelte

@@ -5,15 +5,12 @@
 
 <script lang="ts" generics="T extends AnyZodObject">
   import type { z } from 'zod';
-  import type { ZodValidation, FormPath, FormPathLeaves } from '$lib';
+  import type { ZodValidation, FormPath, FormPathArrays } from '$lib';
   import type { Writable } from 'svelte/store';
   import { fieldProxy, type SuperForm } from '$lib/client';
 
   export let form: SuperForm<ZodValidation<T>, unknown>;
-  export let field: Exclude<
-    FormPath<z.infer<T>>,
-    FormPathLeaves<z.infer<T>>
-  >;
+  export let field: FormPathArrays<z.infer<T>>;
   export let options: { value: string; label: string }[];
   export let label = '';