@esmj/schema 0.2.0 → 0.2.1

package/README.md

@@ -24,7 +24,7 @@ When choosing a schema validation library, bundle size can be an important facto
 
 | Library         | Bundle Size (minified + gzipped) |
 |------------------|---------------------------------|
-| `@esmj/schema`   | ~1 KB                           |
+| `@esmj/schema`   | `~1 KB`                         |
 | Superstruct      | ~3.2 KB                         |
 | Yup              | ~12.2 KB                        |
 | Zod@3            | ~13 KB                          |
@@ -36,22 +36,22 @@ When choosing a schema validation library, bundle size can be an important facto
 
 #### Schema Creation Performance
 
-| Library         | 1 Iteration | 1,000 Iterations | 1,000,000 Iterations |
+| Library         | 1 Schema    | 1,000 Schema     | 1,000,000 Schema     |
 |-----------------|-------------|------------------|----------------------|
-| `@esmj/schema`  | 0.02 ms     | 4.93 ms          | 399.62 ms            |
+| `@esmj/schema`  | `0.02 ms`   | 4.93 ms          | `399.62 ms`          |
 | zod@3           | 0.08 ms     | 9.68 ms          | 8.53 s               |
 | @zod/mini       | 0.22 ms     | 39.77 ms         | 34.51 s              |
 | Yup             | 0.54 ms     | 14.03 ms         | 12.34 s              |
-| Superstruct     | 0.13 ms     | 1.04 ms          | 487.94 ms            |
+| Superstruct     | 0.13 ms     | `1.04 ms`        | 487.94 ms            |
 | Joi             | 0.62 ms     | 31.60 ms         | 23.06 s              |
 
 #### Parsing Performance
 
 | Library         | 1 Iteration | 1,000 Iterations | 1,000,000 Iterations |
 |-----------------|-------------|------------------|----------------------|
-| `@esmj/schema`  | 0.05 ms     | 0.46 ms          | 267.93 ms            |
+| `@esmj/schema`  | `0.05 ms`   | 0.46 ms          | 267.93 ms            |
 | zod@3           | 0.14 ms     | 1.44 ms          | 897.89 ms            |
-| @zod/mini       | 0.23 ms     | 0.42 ms          | 199.08 ms            |
+| @zod/mini       | 0.23 ms     | `0.42 ms`        | `199.08 ms`          |
 | Yup             | 0.30 ms     | 9.49 ms          | 8.69 s               |
 | Superstruct     | 0.08 ms     | 4.18 ms          | 3.71 s               |
 | Joi             | 0.33 ms     | 3.35 ms          | 2.69 s               |
@@ -60,13 +60,15 @@ When choosing a schema validation library, bundle size can be an important facto
 
 | Library         | 1 Iteration | 1,000 Iterations | 1,000,000 Iterations |
 |-----------------|-------------|------------------|----------------------|
-| `@esmj/schema`  | 0.03 ms     | 0.59 ms          | 365.32 ms            |
+| `@esmj/schema`  | `0.03 ms`   | `0.59 ms`        | `365.32 ms`          |
 | zod3            | 0.05 ms     | 2.09 ms          | 1.26 s               |
 | @zod/mini       | 0.07 ms     | 0.99 ms          | 545.12 ms            |
 | Yup             | 0.27 ms     | 19.28 ms         | 18.87 s              |
 | Superstruct     | 0.04 ms     | 8.62 ms          | 6.24 s               |
 | Joi             | 0.15 ms     | 4.13 ms          | 2.57 s               |
 
+**Note:** During the performance tests, `@zod/mini` was observed to consume 200% CPU, while other libraries used only 100% CPU. This may affect the interpretation of the results, especially in multi-threaded environments.
+
 ## Usage
 
 ### Basic Usage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esmj/schema",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Tiny extendable package for schema validation.",
   "keywords": [
     "schema",
@@ -22,7 +22,7 @@
   "scripts": {
     "lint": "biome check --no-errors-on-unmatched",
     "lint:fix": "npm run lint -- --fix --unsafe",
-    "benchmark": "node benchmark/index.ts",
+    "benchmark": "node benchmark/benchmark.ts",
     "dev": "node_modules/.bin/tsup --dts --watch --onSuccess 'node ./dist/index.mjs'",
     "test": "node --test --experimental-strip-types",
     "test:watch": "npm run test -- --watch",

package/benchmark/benchmark.ts

@@ -1,585 +0,0 @@
-import { performance } from 'node:perf_hooks';
-import { z as zodMini } from '@zod/mini'; // Import Zod Mini
-import Joi from 'joi'; // Import Joi
-import superStruct from 'superstruct'; // Import Superstruct
-import * as yup from 'yup'; // Import Yup
-import { z } from 'zod'; // Import Zod
-import { s } from '../src/index.ts'; // Import @esmj/schema
-
-function formatTime(time: number) {
-  // Convert time to milliseconds
-  if (time < 1000) {
-    return `${time.toFixed(2)} ms`;
-  }
-  // Convert to seconds
-  const seconds = time / 1000;
-  return `${seconds.toFixed(2)} s`;
-}
-
-function benchmark(label: string, fn: () => void) {
-  const REPEAT = 10;
-  let sum = 0;
-  let min = Number.POSITIVE_INFINITY;
-  let max = Number.NEGATIVE_INFINITY;
-  for (let i = 0; i < REPEAT; i++) {
-    const start = performance.now();
-    fn();
-    const end = performance.now();
-
-    const time = end - start;
-
-    min = Math.min(min, time);
-    max = Math.max(max, time);
-    sum += time;
-  }
-
-  const average = sum / REPEAT;
-
-  console.log(
-    `${label} took an average of ${formatTime(average)} over ${REPEAT} iterations. Min: ${formatTime(min)}, Max: ${formatTime(max)}`,
-  );
-
-  return formatTime(average);
-}
-
-function scenarioParseSchema(testData) {
-  // Define a schema using @esmj/schema
-  const esmjSchema = s.object({
-    username: s.string(),
-    password: s.string(),
-    age: s.number().optional(),
-    address: s.object({
-      street: s.string().nullish(),
-      city: s.string().nullable(),
-      date: s.date().optional(), // Optional date field
-    }),
-    tags: s.array(s.string()),
-  });
-
-  // Define a schema using Zod
-  const zodSchema = z.object({
-    username: z.string(),
-    password: z.string(),
-    age: z.number().optional(),
-    address: z.object({
-      street: z.string().nullish(),
-      city: z.string().nullable(),
-      date: z.date().optional(), // Optional date field
-    }),
-    tags: z.array(z.string()),
-  });
-
-  // Define a schema using Zod Mini
-  const zodMiniSchema = zodMini.object({
-    username: zodMini.string(),
-    password: zodMini.string(),
-    age: zodMini.optional(zodMini.number()),
-    address: zodMini.object({
-      street: zodMini.nullish(zodMini.string()),
-      city: zodMini.nullable(zodMini.string()),
-      date: zodMini.optional(zodMini.date()), // Optional date field
-    }),
-    tags: zodMini.array(zodMini.string()),
-  });
-
-  // Define a schema using Yup
-  const yupSchema = yup.object({
-    username: yup.string().required(),
-    password: yup.string().required(),
-    age: yup.number().optional(),
-    address: yup.object({
-      street: yup.string().nullable(),
-      city: yup.string().nullable(),
-      date: yup.date().optional(), // Optional date field
-    }),
-    tags: yup.array().of(yup.string().required()).required(),
-  });
-
-  // Define a schema using Superstruct
-  const superStructSchema = superStruct.object({
-    username: superStruct.string(),
-    password: superStruct.string(),
-    age: superStruct.number(),
-    address: superStruct.object({
-      street: superStruct.optional(superStruct.string()),
-      city: superStruct.optional(superStruct.string()),
-      date: superStruct.optional(superStruct.date()), // Optional date field
-    }),
-    tags: superStruct.array(superStruct.string()),
-  });
-
-  // Define a schema using Joi
-  const joiSchema = Joi.object({
-    username: Joi.string().required(),
-    password: Joi.string().required(),
-    age: Joi.number().required(),
-    address: Joi.object({
-      street: Joi.string().optional(), // Allow null for street
-      city: Joi.string().optional(),
-      date: Joi.date().optional(), // Optional date field
-    }),
-    tags: Joi.array().items(Joi.string().required()).required(),
-  });
-
-  const result = {} as Record<string, object>;
-
-  const esmjSchemaResult = {};
-  esmjSchemaResult['1'] = benchmark('@esmj/schema 1', () => {
-    for (let i = 0; i < 1; i++) {
-      esmjSchema.safeParse(testData);
-    }
-  });
-
-  esmjSchemaResult['1_000'] = benchmark('@esmj/schema 1_000', () => {
-    for (let i = 0; i < 1_000; i++) {
-      esmjSchema.safeParse(testData);
-    }
-  });
-
-  esmjSchemaResult['1_000_000'] = benchmark('@esmj/schema 1_000_000', () => {
-    for (let i = 0; i < 1_000_000; i++) {
-      esmjSchema.safeParse(testData);
-    }
-  });
-  result.esmjSchema = esmjSchemaResult;
-
-  const zod = {};
-  zod['1'] = benchmark('zod 1', () => {
-    for (let i = 0; i < 1; i++) {
-      zodSchema.safeParse(testData);
-    }
-  });
-
-  zod['1_000'] = benchmark('zod 1_000', () => {
-    for (let i = 0; i < 1_000; i++) {
-      zodSchema.safeParse(testData);
-    }
-  });
-
-  zod['1_000_000'] = benchmark('zod 1_000_000', () => {
-    for (let i = 0; i < 1_000_000; i++) {
-      zodSchema.safeParse(testData);
-    }
-  });
-  result.zod = zod;
-
-  const zodMiniResult = {};
-  zodMiniResult['1'] = benchmark('@zod/mini 1', () => {
-    for (let i = 0; i < 1; i++) {
-      zodMiniSchema.safeParse(testData);
-    }
-  });
-
-  zodMiniResult['1_000'] = benchmark('@zod/mini 1_000', () => {
-    for (let i = 0; i < 1_000; i++) {
-      zodMiniSchema.safeParse(testData);
-    }
-  });
-
-  zodMiniResult['1_000_000'] = benchmark('@zod/mini 1_000_000', () => {
-    for (let i = 0; i < 1_000_000; i++) {
-      zodMiniSchema.safeParse(testData);
-    }
-  });
-  result.zodMini = zodMiniResult;
-
-  const yupResult = {};
-  yupResult['1'] = benchmark('yup 1', () => {
-    for (let i = 0; i < 1; i++) {
-      yupSchema.isValidSync(testData);
-    }
-  });
-
-  yupResult['1_000'] = benchmark('yup 1_000', () => {
-    for (let i = 0; i < 1_000; i++) {
-      yupSchema.isValidSync(testData);
-    }
-  });
-
-  yupResult['1_000_000'] = benchmark('yup 1_000_000', () => {
-    for (let i = 0; i < 1_000_000; i++) {
-      yupSchema.isValidSync(testData);
-    }
-  });
-  result.yup = yupResult;
-
-  const superStructResult = {};
-  superStructResult['1'] = benchmark('superStruct 1', () => {
-    for (let i = 0; i < 1; i++) {
-      superStruct.is(testData, superStructSchema);
-    }
-  });
-
-  superStructResult['1_000'] = benchmark('superStruct 1_000', () => {
-    for (let i = 0; i < 1_000; i++) {
-      superStruct.is(testData, superStructSchema);
-    }
-  });
-
-  superStructResult['1_000_000'] = benchmark('superStruct 1_000_000', () => {
-    for (let i = 0; i < 1_000_000; i++) {
-      superStruct.is(testData, superStructSchema);
-    }
-  });
-  result.superStruct = superStructResult;
-
-  const joiResult = {};
-  joiResult['1'] = benchmark('joi 1', () => {
-    for (let i = 0; i < 1; i++) {
-      try {
-        joiSchema.validate(testData);
-      } catch (e) {}
-    }
-  });
-
-  joiResult['1_000'] = benchmark('joi 1_000', () => {
-    for (let i = 0; i < 1_000; i++) {
-      try {
-        joiSchema.validate(testData);
-      } catch (e) {}
-    }
-  });
-
-  joiResult['1_000_000'] = benchmark('joi 1_000_000', () => {
-    for (let i = 0; i < 1_000_000; i++) {
-      try {
-        joiSchema.validate(testData);
-      } catch (e) {}
-    }
-  });
-  result.joi = joiResult;
-
-  return result;
-}
-
-function scenarioCreatingSchema() {
-  const result = {} as Record<string, object>;
-  const esmjSchemaResult = {};
-  esmjSchemaResult['1'] = benchmark('@esmj/schema 1', () => {
-    for (let i = 0; i < 1; i++) {
-      const esmjSchema = s.object({
-        username: s.string(),
-        password: s.string(),
-        age: s.number().optional(),
-        address: s.object({
-          street: s.string().nullish(),
-          city: s.string().nullable(),
-          date: s.date().optional(), // Optional date field
-        }),
-        tags: s.array(s.string()),
-      });
-    }
-  });
-
-  esmjSchemaResult['1_000'] = benchmark('@esmj/schema 1_000', () => {
-    for (let i = 0; i < 1_000; i++) {
-      const esmjSchema = s.object({
-        username: s.string(),
-        password: s.string(),
-        age: s.number().optional(),
-        address: s.object({
-          street: s.string().nullish(),
-          city: s.string().nullable(),
-          date: s.date().optional(), // Optional date field
-        }),
-        tags: s.array(s.string()),
-      });
-    }
-  });
-
-  esmjSchemaResult['1_000_000'] = benchmark('@esmj/schema 1_000_000', () => {
-    for (let i = 0; i < 1_000_000; i++) {
-      const esmjSchema = s.object({
-        username: s.string(),
-        password: s.string(),
-        age: s.number().optional(),
-        address: s.object({
-          street: s.string().nullish(),
-          city: s.string().nullable(),
-          date: s.date().optional(), // Optional date field
-        }),
-        tags: s.array(s.string()),
-      });
-    }
-  });
-  result.esmjSchema = esmjSchemaResult;
-
-  const zod = {};
-  zod['1'] = benchmark('zod 1', () => {
-    for (let i = 0; i < 1; i++) {
-      const zodSchema = z.object({
-        username: z.string(),
-        password: z.string(),
-        age: z.number().optional(),
-        address: z.object({
-          street: z.string().nullish(),
-          city: z.string().nullable(),
-          date: z.date().optional(), // Optional date field
-        }),
-        tags: z.array(z.string()),
-      });
-    }
-  });
-
-  zod['1_000'] = benchmark('zod 1_000', () => {
-    for (let i = 0; i < 1_000; i++) {
-      const zodSchema = z.object({
-        username: z.string(),
-        password: z.string(),
-        age: z.number().optional(),
-        address: z.object({
-          street: z.string().nullish(),
-          city: z.string().nullable(),
-          date: z.date().optional(), // Optional date field
-        }),
-        tags: z.array(z.string()),
-      });
-    }
-  });
-
-  zod['1_000_000'] = benchmark('zod 1_000_000', () => {
-    for (let i = 0; i < 1_000_000; i++) {
-      const zodSchema = z.object({
-        username: z.string(),
-        password: z.string(),
-        age: z.number().optional(),
-        address: z.object({
-          street: z.string().nullish(),
-          city: z.string().nullable(),
-          date: z.date().optional(), // Optional date field
-        }),
-        tags: z.array(z.string()),
-      });
-    }
-  });
-  result.zod = zod;
-
-  const zodMiniResult = {};
-  zodMiniResult['1'] = benchmark('@zod/mini 1', () => {
-    for (let i = 0; i < 1; i++) {
-      const zodMiniSchema = zodMini.object({
-        username: zodMini.string(),
-        password: zodMini.string(),
-        age: zodMini.optional(zodMini.number()),
-        address: zodMini.object({
-          street: zodMini.nullish(zodMini.string()),
-          city: zodMini.nullable(zodMini.string()),
-          date: zodMini.optional(zodMini.date()), // Optional date field
-        }),
-        tags: zodMini.array(zodMini.string()),
-      });
-    }
-  });
-
-  zodMiniResult['1_000'] = benchmark('@zod/mini 1_000', () => {
-    for (let i = 0; i < 1_000; i++) {
-      const zodMiniSchema = zodMini.object({
-        username: zodMini.string(),
-        password: zodMini.string(),
-        age: zodMini.optional(zodMini.number()),
-        address: zodMini.object({
-          street: zodMini.nullish(zodMini.string()),
-          city: zodMini.nullable(zodMini.string()),
-          date: zodMini.optional(zodMini.date()), // Optional date field
-        }),
-        tags: zodMini.array(zodMini.string()),
-      });
-    }
-  });
-
-  zodMiniResult['1_000_000'] = benchmark('@zod/mini 1_000_000', () => {
-    for (let i = 0; i < 1_000_000; i++) {
-      const zodMiniSchema = zodMini.object({
-        username: zodMini.string(),
-        password: zodMini.string(),
-        age: zodMini.optional(zodMini.number()),
-        address: zodMini.object({
-          street: zodMini.nullish(zodMini.string()),
-          city: zodMini.nullable(zodMini.string()),
-          date: zodMini.optional(zodMini.date()), // Optional date field
-        }),
-        tags: zodMini.array(zodMini.string()),
-      });
-    }
-  });
-  result.zodMini = zodMiniResult;
-
-  const yupResult = {};
-  yupResult['1'] = benchmark('yup 1', () => {
-    for (let i = 0; i < 1; i++) {
-      const yupSchema = yup.object({
-        username: yup.string().required(),
-        password: yup.string().required(),
-        age: yup.number().optional(),
-        address: yup.object({
-          street: yup.string().nullable(),
-          city: yup.string().nullable(),
-          date: yup.date().optional(), // Optional date field
-        }),
-        tags: yup.array().of(yup.string().required()).required(),
-      });
-    }
-  });
-
-  yupResult['1_000'] = benchmark('yup 1_000', () => {
-    for (let i = 0; i < 1_000; i++) {
-      const yupSchema = yup.object({
-        username: yup.string().required(),
-        password: yup.string().required(),
-        age: yup.number().optional(),
-        address: yup.object({
-          street: yup.string().nullable(),
-          city: yup.string().nullable(),
-          date: yup.date().optional(), // Optional date field
-        }),
-        tags: yup.array().of(yup.string().required()).required(),
-      });
-    }
-  });
-
-  yupResult['1_000_000'] = benchmark('yup 1_000_000', () => {
-    for (let i = 0; i < 1_000_000; i++) {
-      const yupSchema = yup.object({
-        username: yup.string().required(),
-        password: yup.string().required(),
-        age: yup.number().optional(),
-        address: yup.object({
-          street: yup.string().nullable(),
-          city: yup.string().nullable(),
-          date: yup.date().optional(), // Optional date field
-        }),
-        tags: yup.array().of(yup.string().required()).required(),
-      });
-    }
-  });
-  result.yup = yupResult;
-
-  const superStructResult = {};
-  superStructResult['1'] = benchmark('superStruct 1', () => {
-    for (let i = 0; i < 1; i++) {
-      const superStructSchema = superStruct.object({
-        username: superStruct.string(),
-        password: superStruct.string(),
-        age: superStruct.number(),
-        address: superStruct.object({
-          street: superStruct.optional(superStruct.string()),
-          city: superStruct.optional(superStruct.string()),
-          date: superStruct.optional(superStruct.date()), // Optional date field
-        }),
-        tags: superStruct.array(superStruct.string()),
-      });
-    }
-  });
-
-  superStructResult['1_000'] = benchmark('superStruct 1_000', () => {
-    for (let i = 0; i < 1_000; i++) {
-      const superStructSchema = superStruct.object({
-        username: superStruct.string(),
-        password: superStruct.string(),
-        age: superStruct.number(),
-        address: superStruct.object({
-          street: superStruct.optional(superStruct.string()),
-          city: superStruct.optional(superStruct.string()),
-          date: superStruct.optional(superStruct.date()), // Optional date field
-        }),
-        tags: superStruct.array(superStruct.string()),
-      });
-    }
-  });
-
-  superStructResult['1_000_000'] = benchmark('superStruct 1_000_000', () => {
-    for (let i = 0; i < 1_000_000; i++) {
-      const superStructSchema = superStruct.object({
-        username: superStruct.string(),
-        password: superStruct.string(),
-        age: superStruct.number(),
-        address: superStruct.object({
-          street: superStruct.optional(superStruct.string()),
-          city: superStruct.optional(superStruct.string()),
-          date: superStruct.optional(superStruct.date()), // Optional date field
-        }),
-        tags: superStruct.array(superStruct.string()),
-      });
-    }
-  });
-  result.superStruct = superStructResult;
-
-  const joiResult = {};
-  joiResult['1'] = benchmark('joi 1', () => {
-    for (let i = 0; i < 1; i++) {
-      const joiSchema = Joi.object({
-        username: Joi.string().required(),
-        password: Joi.string().required(),
-        age: Joi.number().required(),
-        address: Joi.object({
-          street: Joi.string().optional(), // Allow null for street
-          city: Joi.string().optional(),
-          date: Joi.date().optional(), // Optional date field
-        }),
-        tags: Joi.array().items(Joi.string().required()).required(),
-      });
-    }
-  });
-
-  joiResult['1_000'] = benchmark('joi 1_000', () => {
-    for (let i = 0; i < 1_000; i++) {
-      const joiSchema = Joi.object({
-        username: Joi.string().required(),
-        password: Joi.string().required(),
-        age: Joi.number().required(),
-        address: Joi.object({
-          street: Joi.string().optional(), // Allow null for street
-          city: Joi.string().optional(),
-          date: Joi.date().optional(), // Optional date field
-        }),
-        tags: Joi.array().items(Joi.string().required()).required(),
-      });
-    }
-  });
-
-  joiResult['1_000_000'] = benchmark('joi 1_000_000', () => {
-    for (let i = 0; i < 1_000_000; i++) {
-      const joiSchema = Joi.object({
-        username: Joi.string().required(),
-        password: Joi.string().required(),
-        age: Joi.number().required(),
-        address: Joi.object({
-          street: Joi.string().optional(), // Allow null for street
-          city: Joi.string().optional(),
-          date: Joi.date().optional(), // Optional date field
-        }),
-        tags: Joi.array().items(Joi.string().required()).required(),
-      });
-    }
-  });
-  result.joi = joiResult;
-
-  return result;
-}
-
-const testDataGood = {
-  username: 'john_doe',
-  password: 'securepassword',
-  age: 30,
-  address: {
-    street: '123 Main St',
-    city: 'New York',
-    date: new Date(),
-  },
-  tags: ['developer', 'typescript'],
-};
-
-const testDataBad = {
-  username: 'john_doe',
-  password: 'securepassword',
-  age: 30,
-  address: {
-    street: '123 Main St',
-    city: 'New York',
-    date: new Date(),
-  },
-};
-
-console.table(scenarioCreatingSchema());
-console.table(scenarioParseSchema(testDataGood));
-console.table(scenarioParseSchema(testDataBad));