feat(types): internalize external types

Author: JB AUBREE

README.md

@@ -41,7 +41,7 @@ import { useFormValidation } from 'vue-use-form-validation'
 
 ```ts
 // Import types for better TypeScript support
-import type { FieldErrors, Form, GetErrorsFn, ReturnType, Schema } from './types'
+import type { FieldErrors, Form, GetErrorsFn, InputSchema, ReturnType } from './types'
 ```
 
 ## Basic Example
@@ -91,7 +91,7 @@ async function onSubmit() {
 ```ts
 const options = {
   mode: 'eager', // or 'lazy'
-  transformFn: (schema: Schema, form: Form) => {
+  transformFn: (schema: InputSchema, form: Form) => {
     // Custom validation logic
     return {} // Return errors if any
   },
@@ -111,7 +111,7 @@ const { validate } = useFormValidation(schema, form, options)
 ## API Reference
 
 ```ts
-declare function useFormValidation<S extends Schema<F>, F extends Form>(
+declare function useFormValidation<S extends InputSchema<F>, F extends Form>(
   schema: S,
   form: MaybeRefOrGetter<F>,
   options?: {

build.config.ts

@@ -4,12 +4,12 @@ export default defineBuildConfig({
   entries: [
     'src/index',
   ],
-  declaration: true,
   clean: true,
   rollup: {
     esbuild: {
       minify: true,
     },
     emitCJS: true,
   },
+  failOnWarn: false,
 })

dts.config.json

@@ -0,0 +1,25 @@
+{
+  "compilationOptions": {
+    "followSymlinks": true,
+    "preferredConfigPath": "./tsconfig.json"
+  },
+  "entries": [
+    {
+      "filePath": "./src/index.ts",
+      "outFile": "./dist/index.d.ts",
+      "libraries": {
+        "importedLibraries": ["vue"],
+        "inlinedLibraries": [
+          "joi",
+          "superstruct",
+          "valibot",
+          "yup",
+          "zod"
+        ]
+      },
+      "output": {
+        "exportReferencedTypes": false
+      }
+    }
+  ]
+}

package.json

@@ -37,7 +37,8 @@
     "dist"
   ],
   "scripts": {
-    "build": "unbuild",
+    "build": "unbuild && pnpm build:types",
+    "build:types": "dts-bundle-generator --config dts.config.json",
     "dev": "unbuild --stub",
     "lint": "eslint .",
     "prepublishOnly": "nr build",
@@ -79,6 +80,7 @@
     "@types/node": "^22.7.5",
     "@vitest/coverage-v8": "^2.1.3",
     "bumpp": "^9.7.1",
+    "dts-bundle-generator": "^9.5.1",
     "eslint": "^9.12.0",
     "esno": "^4.8.0",
     "happy-dom": "^15.7.4",

pnpm-lock.yaml

@@ -1,11 +1,11 @@
-import type { FieldErrors, Form, GetErrorsFn, Schema } from './types'
+import type { FieldErrors, Form, GetErrorsFn, InputSchema } from './types'
 import { getJoiErrors, isJoiSchema } from './joi'
 import { getSuperStructErrors, isSuperStructSchema } from './superstruct'
 import { getValibotErrors, isValibotSchema } from './valibot'
 import { getYupErrors, isYupSchema } from './yup'
 import { getZodErrors, isZodSchema } from './zod'
 
-export async function getErrors<S extends Schema<F>, F extends Form>(
+export async function getErrors<S extends InputSchema<F>, F extends Form>(
   schema: S,
   form: F,
 ): Promise<FieldErrors<F>>

src/errors.ts

@@ -1,22 +1,38 @@
-import type { Schema as JoiSchema } from 'joi'
-import type { Struct } from 'superstruct'
-import type { BaseIssue, BaseSchema as ValibotSchema } from 'valibot'
+import type { Schema } from 'joi'
 import type { ComputedRef, Ref } from 'vue'
-import type { ObjectSchema as YupSchema } from 'yup'
-import type { ZodSchema } from 'zod'
 
-export type Awaitable<T> = T | PromiseLike<T>
+type AnyObject = Record<string, any>
 
+interface ZodSchema<F> extends AnyObject {
+  shape: Record<keyof F, unknown>
+}
+interface YupSchema<F> extends AnyObject {
+  fields: Record<keyof F, unknown>
+}
+interface ValibotSchema<F> extends AnyObject {
+  entries: Record<keyof F, unknown>
+}
+// interface JoiTerms<F> extends AnyObject {
+//   keys: Array<{ key: keyof F, schema: unknown }>
+// }
+// interface JoiSchema<F> extends AnyObject {
+//   $_terms: JoiTerms<F>
+// }
+interface SuperstructSchema<F> extends AnyObject {
+  schema: Record<keyof F, unknown>
+}
+
+export type Awaitable<T> = T | PromiseLike<T>
 export type FieldErrors<F> = Partial<Record<keyof F, string>>
 export type Form = Record<string, unknown>
 export type GetErrorsFn<S, F extends Form> = (schema: S, form: F) => Awaitable<FieldErrors<F>>
 
-export type Schema<F extends Form> =
-  | ZodSchema
+export type InputSchema<F extends Form> =
+  | ZodSchema<F>
   | YupSchema<F>
-  | ValibotSchema<unknown, unknown, BaseIssue<unknown>>
-  | JoiSchema
-  | Struct<F>
+  | ValibotSchema<F>
+  | Schema<F>
+  | SuperstructSchema<F>
 
 export interface ReturnType<F> {
   validate: () => Promise<FieldErrors<F>>

src/types.ts

@@ -1,4 +1,4 @@
-import type { FieldErrors, Form, GetErrorsFn, ReturnType, Schema } from './types'
+import type { FieldErrors, Form, GetErrorsFn, InputSchema, ReturnType } from './types'
 import { computed, type MaybeRefOrGetter, ref, shallowRef, toValue, watch } from 'vue'
 import { getErrors } from './errors'
 import { polyfillGroupBy } from './polyfill'
@@ -8,12 +8,12 @@ export function useFormValidation<S, F extends Form>(
   form: MaybeRefOrGetter<F>,
   options: { mode?: 'eager' | 'lazy', transformFn: GetErrorsFn<S, F> },
 ): ReturnType<F>
-export function useFormValidation<S extends Schema<F>, F extends Form>(
+export function useFormValidation<S extends InputSchema<F>, F extends Form>(
   schema: S,
   form: MaybeRefOrGetter<F>,
   options?: { mode?: 'eager' | 'lazy' },
 ): ReturnType<F>
-export function useFormValidation<S extends Schema<F>, F extends Form>(
+export function useFormValidation<S extends InputSchema<F>, F extends Form>(
   schema: S,
   form: MaybeRefOrGetter<F>,
   options?: { mode?: 'eager' | 'lazy', transformFn?: GetErrorsFn<S, F> },