Package

Author: schani

.gitignore

@@ -1 +1,7 @@
 node_modules
+dist
+.DS_Store
+*.log
+coverage
+.nyc_output
+.vscode

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Mark Probst
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,129 @@
+# zod-from-json-schema
+
+A library that creates [Zod](https://github.com/colinhacks/zod) types from [JSON Schema](https://json-schema.org/) at runtime.  This is in contrast to [json-schema-to-zod](https://www.npmjs.com/package/json-schema-to-zod), which generates JavaScript source code.
+
+## Installation
+
+```bash
+npm install zod-from-json-schema
+```
+
+## Usage
+
+This package supports both ESM and CommonJS formats.
+
+### ESM (ES Modules)
+
+```typescript
+import { convertJsonSchemaToZod } from 'zod-from-json-schema';
+
+// Define a JSON Schema
+const jsonSchema = {
+  $schema: "http://json-schema.org/draft-07/schema#",
+  type: "object",
+  properties: {
+    name: { type: "string", minLength: 2, maxLength: 50 },
+    age: { type: "integer", minimum: 0, maximum: 120 },
+    email: { type: "string", pattern: "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$" },
+    tags: {
+      type: "array",
+      items: { type: "string" },
+      uniqueItems: true,
+      minItems: 1
+    }
+  },
+  required: ["name", "email"],
+  additionalProperties: false
+};
+
+// Convert JSON Schema to Zod schema
+const zodSchema = convertJsonSchemaToZod(jsonSchema);
+
+// Use the Zod schema to validate data
+try {
+  const validData = zodSchema.parse({
+    name: "John Doe",
+    email: "[email protected]",
+    age: 30,
+    tags: ["user", "premium"]
+  });
+  console.log("Valid data:", validData);
+} catch (error) {
+  console.error("Validation error:", error);
+}
+```
+
+### CommonJS
+
+```javascript
+const { convertJsonSchemaToZod } = require('zod-from-json-schema');
+
+// Define a JSON Schema
+const jsonSchema = {
+  $schema: "http://json-schema.org/draft-07/schema#",
+  type: "object",
+  properties: {
+    name: { type: "string", minLength: 2, maxLength: 50 },
+    age: { type: "integer", minimum: 0, maximum: 120 }
+  },
+  required: ["name"],
+  additionalProperties: false
+};
+
+// Convert JSON Schema to Zod schema
+const zodSchema = convertJsonSchemaToZod(jsonSchema);
+
+// Use the Zod schema to validate data
+const validData = zodSchema.parse({
+  name: "John Doe",
+  age: 30
+});
+```
+
+## Supported JSON Schema Features
+
+This library supports the following JSON Schema features:
+
+### Basic Types
+- `string`
+- `number`
+- `integer`
+- `boolean`
+- `null`
+- `object` (with properties and required fields)
+- `array`
+
+### String Validations
+- `minLength`
+- `maxLength`
+- `pattern` (regular expressions)
+
+### Number Validations
+- `minimum`
+- `maximum`
+- `exclusiveMinimum`
+- `exclusiveMaximum`
+- `multipleOf`
+
+### Array Validations
+- `minItems`
+- `maxItems`
+- `uniqueItems`
+
+### Object Validations
+- `required` (required properties)
+- `additionalProperties` (controls passthrough behavior)
+
+### Schema Composition
+- `const` (literal values)
+- `enum` (enumerated values)
+- `anyOf` (union)
+- `allOf` (intersection)
+- `oneOf` (union)
+
+### Additional
+- `description` (carried over to Zod schemas)
+
+## License
+
+MIT

build.js

@@ -0,0 +1,47 @@
+const { build } = require('esbuild');
+const { copyFile } = require('fs/promises');
+const { resolve } = require('path');
+
+async function buildPackage() {
+  try {
+    // Build ESM version
+    await build({
+      entryPoints: ['./src/index.ts'],
+      outfile: './dist/index.mjs',
+      format: 'esm',
+      platform: 'node',
+      target: 'es2018',
+      bundle: true,
+      external: ['zod'],
+    });
+
+    // Build CommonJS version
+    await build({
+      entryPoints: ['./src/index.ts'],
+      outfile: './dist/index.js',
+      format: 'cjs',
+      platform: 'node',
+      target: 'es2018',
+      bundle: true,
+      external: ['zod'],
+    });
+
+    // Copy the TypeScript declarations
+    await copyFile(
+      resolve('./dist/index.d.ts'),
+      resolve('./dist/index.d.mts')
+    ).catch(err => {
+      // Ignore if the file doesn't exist, as TypeScript doesn't generate .d.mts files
+      if (err.code !== 'ENOENT') {
+        throw err;
+      }
+    });
+
+    console.log('✅ Build completed');
+  } catch (err) {
+    console.error('❌ Build failed:', err);
+    process.exit(1);
+  }
+}
+
+buildPackage();

example.js

@@ -0,0 +1,80 @@
+// This example demonstrates how to use zod-from-json-schema
+const { convertJsonSchemaToZod } = require('./dist/index');
+
+// Define a JSON Schema
+const jsonSchema = {
+  type: "object",
+  properties: {
+    name: { 
+      type: "string", 
+      minLength: 2, 
+      maxLength: 50,
+      description: "User's full name"
+    },
+    age: { 
+      type: "integer", 
+      minimum: 0, 
+      maximum: 120,
+      description: "User's age in years"
+    },
+    email: { 
+      type: "string", 
+      pattern: "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
+      description: "User's email address"
+    },
+    tags: {
+      type: "array",
+      items: { type: "string" },
+      uniqueItems: true,
+      minItems: 1,
+      description: "User's tags or categories"
+    }
+  },
+  required: ["name", "email"],
+  additionalProperties: false,
+  description: "A user profile schema"
+};
+
+// Convert JSON Schema to Zod schema
+const zodSchema = convertJsonSchemaToZod(jsonSchema);
+
+// Example of valid data
+const validData = {
+  name: "John Doe",
+  email: "[email protected]",
+  age: 30,
+  tags: ["user", "premium"]
+};
+
+// Validate the data
+try {
+  const validated = zodSchema.parse(validData);
+  console.log("✅ Valid data:", validated);
+} catch (error) {
+  console.error("❌ Validation error:", error.errors);
+}
+
+// Example of invalid data
+const invalidData = {
+  name: "J", // Too short - minLength is 2
+  email: "not-an-email", // Invalid email format
+  age: 150, // Above maximum of 120
+  tags: ["user", "user"] // Duplicate items - uniqueItems is true
+};
+
+// Validate the invalid data (will throw an error)
+try {
+  const validated = zodSchema.parse(invalidData);
+  console.log("Valid data:", validated);
+} catch (error) {
+  console.error("❌ Validation errors:", error.format());
+}
+
+// Example of safeParse - doesn't throw errors
+const safeResult = zodSchema.safeParse(invalidData);
+if (safeResult.success) {
+  console.log("✅ Valid data:", safeResult.data);
+} else {
+  console.log("❌ Invalid data, issues:");
+  console.log(safeResult.error.format());
+}

examples/README.md

@@ -0,0 +1,24 @@
+# zod-from-json-schema Examples
+
+This directory contains examples showing how to use zod-from-json-schema in both CommonJS and ESM environments.
+
+## Running the examples
+
+To run the CommonJS example:
+
+```bash
+node cjs-example.cjs
+```
+
+To run the ESM example:
+
+```bash
+node esm-example.mjs
+```
+
+## Notes
+
+- The CommonJS example uses `.cjs` extension and `require()` syntax
+- The ESM example uses `.mjs` extension and `import` syntax
+- Both examples import directly from the local build in `../dist/`
+- When using in your own project, you would import from `zod-from-json-schema` instead

examples/cjs-example.cjs

@@ -0,0 +1,40 @@
+// CommonJS Example
+const { convertJsonSchemaToZod } = require('../dist/index.js');
+
+// Define a JSON Schema
+const jsonSchema = {
+  type: "object",
+  properties: {
+    name: { 
+      type: "string", 
+      minLength: 2, 
+      maxLength: 50,
+      description: "User's full name"
+    },
+    age: { 
+      type: "integer", 
+      minimum: 0, 
+      maximum: 120,
+      description: "User's age in years"
+    }
+  },
+  required: ["name"],
+  additionalProperties: false
+};
+
+// Convert JSON Schema to Zod schema
+const zodSchema = convertJsonSchemaToZod(jsonSchema);
+
+// Example of valid data
+const validData = {
+  name: "John Doe",
+  age: 30
+};
+
+// Validate the data
+try {
+  const validated = zodSchema.parse(validData);
+  console.log("✅ CJS - Valid data:", validated);
+} catch (error) {
+  console.error("❌ CJS - Validation error:", error.errors);
+}