first commit

packages/@n8n/json-schema-to-zod/README.md

@@ -0,0 +1,34 @@
+# Json-Schema-to-Zod
+
+A package to convert JSON schema (draft 4+) objects into Zod schemas in the form of Zod objects at runtime.
+
+## Installation
+
+```sh
+npm install @n8n/json-schema-to-zod
+```
+
+### Simple example
+
+```typescript
+import { jsonSchemaToZod } from "json-schema-to-zod";
+
+const jsonSchema = {
+  type: "object",
+  properties: {
+    hello: {
+      type: "string",
+    },
+  },
+};
+
+const zodSchema = jsonSchemaToZod(myObject);
+```
+
+### Overriding a parser
+
+You can pass a function to the `overrideParser` option, which represents a function that receives the current schema node and the reference object, and should return a zod object when it wants to replace a default output. If the default output should be used for the node just return undefined.
+
+## Acknowledgements
+
+This is a fork of [`json-schema-to-zod`](https://github.com/StefanTerdell/json-schema-to-zod).