refactor(package): small refactoring + tests coverage improvement

package.json

@@ -16,8 +16,9 @@
     "check:format": "biome format --write ./src",
     "check:lint": "biome lint ./src",
     "local:node": "tsx local/main.ts",
-    "prepublishOnly": "node ./bin/prepublish.js && pnpm build && agadoo && pnpm test",
-    "release": "cross-env RELEASE_MODE=true np --no-tests"
+    "prepublishOnly": "node ./bin/prepublish.js && pnpm build && agadoo",
+    "release": "cross-env RELEASE_MODE=true np",
+    "doc": "typedoc --logLevel Verbose"
   },
   "author": "Spartak Kagramanyan",
   "license": "MIT",
@@ -28,10 +29,15 @@
     "agadoo": "^3.0.0",
     "cross-env": "^7.0.3",
     "lefthook": "^1.6.15",
+    "myzod": "^1.11.0",
     "np": "^10.0.5",
     "superstruct": "^1.0.4",
     "tsup": "^8.1.0",
     "tsx": "^4.15.4",
+    "typedoc": "^0.25.13",
+    "typedoc-material-theme": "^1.0.2",
+    "typedoc-plugin-coverage": "^3.2.0",
+    "typedoc-plugin-missing-exports": "^2.3.0",
     "typescript": "^5.4.5",
     "valibot": "^0.32.0",
     "vitest": "^1.6.0",

src/factories/jsonFileFactory.ts

@@ -1,15 +1,15 @@
-import type { Parser } from "../types/parser.js";
+import type { Validator } from "../types/validator.js";
 import { Exception } from "../util/exception.js";
 import { deepMerge } from "../util/mergeObjects.js";
 import { readFile } from "../util/readFile.js";
 import { fromObject } from "./objectFactory.js";
 
-export async function fromJSONFile<$Parser extends Parser>({
+export async function fromJSONFile<$Validator extends Validator>({
   path,
   schema,
 }: {
   path: string | string[];
-  schema: $Parser;
+  schema: $Validator;
 }) {
   const paths = Array.isArray(path) ? path : [path];
 

src/factories/objectFactory.ts

@@ -1,12 +1,12 @@
-import type { Parser } from "../types/parser.js";
+import type { Validator } from "../types/validator.js";
 import { validate } from "../util/validation.js";
 
-export async function fromObject<$Parser extends Parser>({
+export async function fromObject<$Validator extends Validator>({
   data,
   schema,
 }: {
   data: unknown;
-  schema: $Parser;
+  schema: $Validator;
 }) {
   return validate(data, schema);
 }

src/factories/urlFactory.ts

@@ -1,14 +1,14 @@
-import type { Parser } from "../types/parser.js";
+import type { Validator } from "../types/validator.js";
 import { Exception } from "../util/exception.js";
 import { deepMerge } from "../util/mergeObjects.js";
 import { fromObject } from "./objectFactory.js";
 
-export async function fromURL<$Parser extends Parser>({
+export async function fromURL<$Validator extends Validator>({
   url,
   schema,
 }: {
   url: string | string[];
-  schema: $Parser;
+  schema: $Validator;
 }) {
   const urls = Array.isArray(url) ? url : [url];
 

src/types/index.d.ts

@@ -1,2 +1,2 @@
 export * from "../index.js";
-export * from "./parser.js";
+export * from "./validator.js";

src/types/validator.d.ts

@@ -0,0 +1,52 @@
+// KUDOS to trpc for the inspiration
+
+export type ValidatorZod<TI, TPI> = {
+  _input: TI;
+  _output: TPI;
+};
+
+export type ValidatorValibot<TI, TPI> = {
+  types?: {
+    input: TI;
+    output: TPI;
+  };
+};
+
+export type ValidatorMyZod<TI> = {
+  parse: (input: any) => TI;
+};
+
+export type ValidatorSuperstruct<TI> = {
+  create: (input: unknown) => TI;
+};
+
+export type ValidatorCustomValidator<TI> = (input: unknown) => Promise<TI> | TI;
+
+export type ValidatorYup<TI> = {
+  validateSync: (input: unknown) => TI;
+};
+
+export type ValidatorWithoutInput<TI> =
+  | ValidatorCustomValidator<TI>
+  | ValidatorMyZod<TI>
+  | ValidatorSuperstruct<TI>
+  | ValidatorYup<TI>;
+
+export type ValidatorWithInputOutput<TI, TPI> = ValidatorZod<TI, TPI> | ValidatorValibot<TI, TPI>;
+
+export type Validator = ValidatorWithInputOutput<any, any> | ValidatorWithoutInput<any>;
+
+export type inferValidator<$Validator extends Validator> = $Validator extends ValidatorWithInputOutput<
+  infer $TIn,
+  infer $TOut
+>
+  ? {
+      in: $TIn;
+      out: $TOut;
+    }
+  : $Validator extends ValidatorWithoutInput<infer $InOut>
+    ? {
+        in: $InOut;
+        out: $InOut;
+      }
+    : never;