feat: initial implementation

Author: toomuchdesign

.nvmrc

@@ -1 +1 @@
-20
+18

README.md

@@ -1,14 +1,46 @@
-# Project name
+# openapi-ts-json-schema
 
-## Setup after fork
+Convert OpenApi definitions to TS JSON schema files.
 
-- Fill `package.json` file with relevant fields
-- Enable [Changesets bot](https://github.com/changesets/bot)
+Given a OpenAPI definition file, `openapi-ts-json-schema` will:
 
-## Contributing
+- Dereference the definitions with [`@apidevtools/json-schema-ref-parser`](https://github.com/APIDevTools/json-schema-ref-parser)
+- Convert to JSON schema with [`@openapi-contrib/openapi-schema-to-json-schema`](https://github.com/openapi-contrib/openapi-schema-to-json-schema)
+- Generate a TS JSON schema file for each definition (with `as const` assertion)
+- Store JSON schemas in a folder structure reflecting the OpenAPI definition structure
 
-Any contribution should be provided with a `changesets` update:
+## Installation
 
 ```
-npx changeset
+npm i openapi-ts-json-schema -D
 ```
+
+## Usage
+
+```ts
+import { openapiToTsJsonSchema } from 'openapi-ts-json-schema';
+
+const { outputFolder } = await openapiToTsJsonSchema({
+  openApiSchema: path.resolve(fixtures, 'path/to/my/specs.yaml'),
+  definitionPathsToGenerateFrom: ['paths', 'components.schemas'],
+});
+```
+
+### Notes
+
+Generated JSON schemas folders get currently saved in a `schemas-autogenerated` folder next to the provided OpenAPI definition file
+
+Generated JSON schemas folders name gets escaped in order to be valid file system names.
+
+## Options
+
+| Property                          | Type                                       | Description                                                                                                                                                 | Default |
+| --------------------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| **openApiSchema** _(required)_    | `string`                                   | Path to the OpenApi file (supports yaml and json)                                                                                                           | -       |
+| **definitionPathsToGenerateFrom** | `string[]`                                 | OpenApi definition object paths to generate the JSON schemas from. Only matching paths will be generated. (Supports dot notation: `["components.schemas"]`) | `[]`    |
+| **schemaPatcher**                 | `(params: { schema: JSONSchema }) => void` | Dynamically patch generated JSON schemas. The provided function will be invoked against every single JSON schema node.                                      | -       |
+| **silent**                        | `boolean`                                  | Don't console.log user messages                                                                                                                             | `false` |
+
+## Todo
+
+- Consider exposing an option to set the output folder path