zod-openapi 0.0.0-semantically-released → 0.2.0

package/README.md

@@ -2,36 +2,354 @@
 
 [![Powered by skuba](https://img.shields.io/badge/🤿%20skuba-powered-009DC4)](https://github.com/seek-oss/skuba)
 
-This package is intended to be public on [seek-oss].
-To create an internal package,
-run `skuba init` and select the `private-npm-package` template.
+A Typescript library to create full OpenAPI 3.1 documentation from Zod Schemas.
 
-Next steps:
+## API
 
-1. [ ] Read [SEEK's Open Source RFC].
-2. [ ] Create a new repository in the [seek-oss] GitHub organisation.
-3. [ ] Push local commits to the upstream GitHub branch.
-4. [ ] Configure [GitHub repository settings].
-5. [ ] Keep dependencies up to date with [Renovate];
-       request installation in [#open-source].
-6. [ ] Delete this checklist 😌.
+### `extendZodWithOpenApi`
 
-[#open-source]: https://slack.com/app_redirect?channel=C39P1H2SU
-[github repository settings]: https://github.com/seek-oss/zod-openapi/settings
-[renovate]: https://github.com/apps/renovate
-[seek's open source rfc]: https://rfc.skinfra.xyz/RFC016-Open-Source.html
+Mutates Zod with an `.openapi()` method and extra metadata. Make a side-effectful import at the top of your entry point(s).
 
-## API
+```typescript
+import { z } from 'zod';
+import { extendZodWithOpenApi } from 'zod-openapi';
+
+extendZodWithOpenApi(z);
+
+z.string().openapi({ description: 'hello world!', example: 'hello world' });
+```
+
+### `createDocument`
+
+Creates an OpenAPI documentation object
+
+```typescript
+import { z } from 'zod';
+import { createDocument, extendZodWithOpenApi } from 'zod-openapi';
+
+extendZodWithOpenApi(z);
+
+const jobId = z.string().openapi({
+  description: 'Job ID',
+  examples: ['12345'],
+});
+
+const title = z.string().openapi({
+  description: 'Job title',
+  examples: ['My job'],
+});
+
+const document = createDocument({
+  openapi: '3.1.0',
+  info: {
+    title: 'My API',
+    version: '1.0.0',
+  },
+  paths: {
+    '/jobs/{jobId}': {
+      put: {
+        requestParams: { path: z.object({ jobId }) },
+        requestBody: {
+          content: {
+            'application/json': { schema: z.object({ title }) },
+          },
+        },
+        responses: {
+          '200': {
+            description: '200 OK',
+            content: {
+              'application/json': { schema: z.object({ jobId, title }) },
+            },
+          },
+        },
+      },
+    },
+  },
+});
+```
+
+Generates the following object:
+
+```json
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "My API",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/jobs/{jobId}": {
+      "put": {
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "title": {
+                    "type": "string",
+                    "description": "Job title",
+                    "examples": ["My job"]
+                  }
+                },
+                "required": ["title"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "200 OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "jobId": {
+                      "type": "string",
+                      "description": "Job ID",
+                      "examples": ["12345"]
+                    },
+                    "title": {
+                      "type": "string",
+                      "description": "Job title",
+                      "examples": ["My job"]
+                    }
+                  },
+                  "required": ["jobId", "title"]
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "in": "path",
+            "name": "jobId",
+            "schema": {
+              "type": "string",
+              "description": "Job ID",
+              "examples": ["12345"]
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+### `createDocumentJson`
+
+In the background it calls `createDocument` but instead outputs it as a JSON string using `JSON.stringify`. It takes an optional options object as the second parameter which can customize how the JSON string is outputted.
+
+```typescript
+const document = createDocumentJson(
+  {
+    openapi: '3.1.0',
+    info: {
+      title: 'My API',
+      version: '1.0.0',
+    },
+  },
+  { options: 2 },
+);
+```
+
+### `createDocumentYaml`
+
+In the background it calls `createDocument` but instead outputs it as a YAML string using the [yaml](https://github.com/eemeli/yaml) library. It takes an optional options object as the second parameter which can customize how the YAML string is outputted.
+
+```typescript
+const document = createDocumentYaml(
+  {
+    openapi: '3.1.0',
+    info: {
+      title: 'My API',
+      version: '1.0.0',
+    },
+  },
+  { options: { uniqueKeys: false } },
+);
+```
+
+## Usage
+
+### Request Parameters
+
+Query, Path, Header & Cookie parameters can be created using the `requestParams` key under the `method` key as follows:
+
+```typescript
+createDocument({
+  paths: {
+    '/jobs/:a': {
+      put: {
+        requestParams: {
+          path: z.object({ a: z.string() }),
+          query: z.object({ b: z.string() }),
+          cookie: z.object({ cookie: z.string() }),
+          header: z.object({ 'custom-header': z.string() }),
+        },
+      },
+    },
+  },
+});
+```
+
+If you would like to declare parameters using OpenAPI syntax you may also declare them using the [parameters](https://swagger.io/docs/specification/describing-parameters/) key. The definitions will then all be combined.
+
+### Request Body
+
+Where you would normally declare the [media type](https://swagger.io/docs/specification/media-types/), instead declare the `content` as `application/json` and set the `schema` as your Zod Schema as follows.
+
+```typescript
+createDocument({
+  paths: {
+    '/jobs': {
+      get: {
+        requestBody: {
+          content: {
+            'application/json': { schema: z.object({ a: z.string() }) },
+          },
+        },
+      },
+    },
+  },
+});
+```
+
+If you wish to use OpenAPI syntax for your schemas, simply add an OpenAPI schema to the `schema` field instead.
+
+### Responses
+
+Similarly to the [Request Body](#request-body), simply set the `schema` as your Zod Schema as follows. You can set the response headers using the `responseHeaders` key.
+
+```typescript
+createDocument({
+  paths: {
+    '/jobs': {
+      get: {
+        responses: {
+          200: {
+            description: '200 OK',
+            content: {
+              'application/json': { schema: z.object({ a: z.string() }) },
+            },
+            responseHeaders: z.object({
+              'header-key': z.string(),
+            }),
+          },
+        },
+      },
+    },
+  },
+});
+```
+
+### Creating Components
+
+OpenAPI allows you to define reusable [components](https://swagger.io/docs/specification/components/) and this library allows you to replicate that in a simple way.
+
+#### Schema
+
+If we take the example in `createDocument` and instead create `title` as follows
+
+```typescript
+const title = z.string().openapi({
+  description: 'Job title',
+  examples: ['My job'],
+  ref: 'jobTitle', // <- new field
+});
+```
+
+Wherever `title` is used in schemas across the document, it will instead be created as a reference.
 
-### `log`
+```json
+{
+  "title": { "$ref": "#/components/schemas/jobTitle" }
+}
+```
+
+`title` will then be outputted as a schema within the components section of the documentation.
+
+```json
+{
+  "components": {
+    "schemas": {
+      "jobTitle": {
+        "type": "string",
+        "description": "Job title",
+        "examples": ["My job"]
+      }
+    }
+  }
+}
+```
+
+This can be an extremely powerful way to generate better Open API documentation. There are some Open API features like [discriminator mapping](https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/) which require all schemas in the union to contain a ref.
+
+#### Parameters
 
-Writes the module name to stdout.
-Thrilling stuff.
+Query, Path, Header & Cookie parameters can be similarly registered:
 
 ```typescript
-import { log } from 'zod-openapi';
+const jobId = z.string().openapi({
+  description: 'Job ID',
+  examples: ['1234'],
+  param: { ref: 'jobId' },
+});
+```
+
+#### Response Headers
+
+Response headers can be similarly registered:
 
-log();
+```typescript
+const header = z.string().openapi({
+  description: 'Job ID',
+  examples: ['1234'],
+  header: { ref: 'some-header' },
+});
+```
+
+## Supported Zod Schema
+
+- ZodArray
+  - `minItems`/`maxItems` mapping for `.length()`, `.min()`, `.max()`
+- ZodBoolean
+- ZodDate
+  - `string` `type` mapping by default
+- ZodDefault
+- ZodDiscriminatedUnion
+  - `discriminator` mapping when all schemas in the union contain a `ref`.
+- ZodEffects
+  - `pre-process` and `refine` support
+- ZodEnum
+- ZodLiteral
+- ZodNativeEnum
+  - supporting `string`, `number` and combined enums.
+- ZodNull
+- ZodNullable
+- ZodNumber
+  - `integer` `type` mapping for `.int()`
+  - `exclusiveMin`/`min`/`exclusiveMax`/`max` mapping for `.min()`, `.max()`, `lt()`, `gt()`
+- ZodObject
+- ZodOptional
+- ZodRecord
+- ZodString
+  - `format` mapping for `.url()`, `.uuid()`, `.email()`, `.datetime()`
+  - `minLength`/`maxLength` mapping for `.length()`, `.min()`, `.max()`
+  - `pattern` mapping for `.regex()`
+- ZodTuple
+  - `items` mapping for `.rest()`
+- ZodUnion
+
+If this library cannot determine a type for a Zod Schema, it will throw an error. To avoid this, declare a manual `type` in the `.openapi()` section of that schema.
+
+eg.
+
+```typescript
+z.custom().openapi({ type: 'string' });
 ```
 
 ## Development
@@ -71,58 +389,6 @@ yarn build
 npm pack
 ```
 
-## Release
-
-This package is published to the public npm registry with a GitHub Actions [release workflow].
-
-The workflow runs on select branches:
-
-```yaml
-on:
-  push:
-    branches:
-      # add others as necessary
-      - beta
-      - master
-      # - alpha
-```
-
-It depends on this repo being hosted on [seek-oss] with appropriate access.
-
-To set up this repo for publishing, follow the instructions in our [OSS npm package guidance].
-
-### Commit messages
-
-This package is published with **[semantic-release]**, which requires a particular commit format to manage semantic versioning.
-You can run the interactive `yarn commit` command in place of `git commit` to generate a compliant commit title and message.
-If you use the `Squash and merge` option on pull requests, take extra care to format the squashed commit in the GitHub UI before merging.
-
-### Releasing latest
-
-Commits to the `master` branch will be released with the `latest` tag,
-which is the default used when running `npm install` or `yarn install`.
-
-### Releasing other dist-tags
-
-**[semantic-release]** prescribes a branch-based workflow for managing [distribution tags].
-
-You can push to other branches to manage betas, maintenance updates to prior major versions, and more.
-
-Here are some branches that **semantic-release** supports by default:
-
-| Git branch | npm dist-tag |
-| :--------- | :----------- |
-| master     | latest       |
-| alpha      | alpha        |
-| beta       | beta         |
-| next       | next         |
-| 1.x        | release-1.x  |
-
-For more information, see the **semantic-release** docs on [triggering a release].
+## Credits
 
-[distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
-[oss npm package guidance]: https://github.com/SEEK-Jobs/seek-oss-ci/blob/master/NPM_PACKAGES.md#access-to-publish-to-npm
-[release workflow]: .github/workflows/release.yml
-[seek-oss]: https://github.com/seek-oss
-[semantic-release]: https://github.com/semantic-release/semantic-release
-[triggering a release]: https://github.com/semantic-release/semantic-release/#triggering-a-release
+- [@asteasolutions/zod-to-openapi](https://github.com/asteasolutions/zod-to-openapi) - zod-openapi was created while trying to re-write the wonderful library to support auto registering schemas. However, the underlying structure of the library which consists of tightly coupled classes would not allow for this be done easily. As a result zod-openapi was born with the goal of keeping the Zod Schemas independent from the generation of the documentation.

package/lib-commonjs/create/components.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createComponents = exports.createComponentSchemaRef = exports.getDefaultComponents = void 0;
+const zod_1 = require("zod");
+const schema_1 = require("./schema");
+const getDefaultComponents = (componentsObject) => {
+    const defaultComponents = { schemas: {}, parameters: {}, headers: {} };
+    if (!componentsObject) {
+        return defaultComponents;
+    }
+    createSchemas(componentsObject.schemas, defaultComponents);
+    createParameters(componentsObject.parameters, defaultComponents);
+    createHeaders(componentsObject.headers, defaultComponents);
+    return defaultComponents;
+};
+exports.getDefaultComponents = getDefaultComponents;
+const createSchemas = (schemas, components) => {
+    if (!schemas) {
+        return;
+    }
+    return Object.entries(schemas).forEach(([key, schema]) => {
+        const component = components.schemas[key];
+        if (component) {
+            throw new Error(`schemaRef "${key}" is already registered`);
+        }
+        if (schema instanceof zod_1.ZodType) {
+            components.schemas[key] = {
+                schemaObject: (0, schema_1.createSchemaOrRef)(schema, components),
+                zodSchema: schema,
+            };
+            return;
+        }
+        components.schemas[key] = {
+            schemaObject: schema,
+        };
+    });
+};
+const createParameters = (parameters, components) => {
+    if (!parameters) {
+        return;
+    }
+    return Object.entries(parameters).forEach(([key, schema]) => {
+        const component = components.parameters[key];
+        if (component) {
+            throw new Error(`parameter "${key}" is already registered`);
+        }
+        components.parameters[key] = {
+            paramObject: schema,
+        };
+    });
+};
+const createHeaders = (headers, components) => {
+    if (!headers) {
+        return;
+    }
+    return Object.entries(headers).forEach(([key, schema]) => {
+        const component = components.headers[key];
+        if (component) {
+            throw new Error(`header "${key}" is already registered`);
+        }
+        components.headers[key] = {
+            headerObject: schema,
+        };
+    });
+};
+const createComponentSchemaRef = (schemaRef) => `#/components/schemas/${schemaRef}`;
+exports.createComponentSchemaRef = createComponentSchemaRef;
+const createComponents = (componentsObject, components) => {
+    const schemas = createSchemaComponents(components.schemas);
+    const parameters = createParamComponents(components.parameters);
+    const headers = createHeaderComponents(components.headers);
+    const finalComponents = {
+        ...componentsObject,
+        ...(schemas && { schemas }),
+        ...(parameters && { parameters }),
+        ...(headers && { headers }),
+    };
+    return Object.keys(finalComponents).length ? finalComponents : undefined;
+};
+exports.createComponents = createComponents;
+const createSchemaComponents = (component) => {
+    const components = Object.entries(component).reduce((acc, [key, value]) => {
+        if (value) {
+            acc[key] = value.schemaObject;
+        }
+        return acc;
+    }, {});
+    return Object.keys(components).length ? components : undefined;
+};
+const createParamComponents = (component) => {
+    const components = Object.entries(component).reduce((acc, [key, value]) => {
+        if (value) {
+            acc[key] = value.paramObject;
+        }
+        return acc;
+    }, {});
+    return Object.keys(components).length ? components : undefined;
+};
+const createHeaderComponents = (component) => {
+    const components = Object.entries(component).reduce((acc, [key, value]) => {
+        if (value) {
+            acc[key] = value.headerObject;
+        }
+        return acc;
+    }, {});
+    return Object.keys(components).length ? components : undefined;
+};
+//# sourceMappingURL=components.js.map

package/lib-commonjs/create/components.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"components.js","sourceRoot":"","sources":["../../src/create/components.ts"],"names":[],"mappings":";;;AACA,6BAA8B;AAG9B,qCAA6C;AAmCtC,MAAM,oBAAoB,GAAG,CAClC,gBAGC,EACiB,EAAE;IACpB,MAAM,iBAAiB,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACvE,IAAI,CAAC,gBAAgB,EAAE;QACrB,OAAO,iBAAiB,CAAC;KAC1B;IAED,aAAa,CAAC,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAC3D,gBAAgB,CAAC,gBAAgB,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;IACjE,aAAa,CAAC,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAE3D,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC;AAhBW,QAAA,oBAAoB,wBAgB/B;AAEF,MAAM,aAAa,GAAG,CACpB,OAA8C,EAC9C,UAA4B,EACtB,EAAE;IACR,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO;KACR;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE;QACvD,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,SAAS,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,cAAc,GAAG,yBAAyB,CAAC,CAAC;SAC7D;QAED,IAAI,MAAM,YAAY,aAAO,EAAE;YAC7B,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;gBACxB,YAAY,EAAE,IAAA,0BAAiB,EAAC,MAAM,EAAE,UAAU,CAAC;gBACnD,SAAS,EAAE,MAAM;aAClB,CAAC;YACF,OAAO;SACR;QAED,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;YACxB,YAAY,EAAE,MAAM;SACrB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACvB,UAAoD,EACpD,UAA4B,EACtB,EAAE;IACR,IAAI,CAAC,UAAU,EAAE;QACf,OAAO;KACR;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE;QAC1D,MAAM,SAAS,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,SAAS,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,cAAc,GAAG,yBAAyB,CAAC,CAAC;SAC7D;QAED,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG;YAC3B,WAAW,EAAE,MAAM;SACpB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CACpB,OAA8C,EAC9C,UAA4B,EACtB,EAAE;IACR,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO;KACR;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE;QACvD,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,SAAS,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,WAAW,GAAG,yBAAyB,CAAC,CAAC;SAC1D;QAED,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;YACxB,YAAY,EAAE,MAAM;SACrB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEK,MAAM,wBAAwB,GAAG,CAAC,SAAiB,EAAE,EAAE,CAC5D,wBAAwB,SAAS,EAAE,CAAC;AADzB,QAAA,wBAAwB,4BACC;AAC/B,MAAM,gBAAgB,GAAG,CAC9B,gBAEa,EACb,UAA4B,EACQ,EAAE;IACtC,MAAM,OAAO,GAAG,sBAAsB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC3D,MAAM,UAAU,GAAG,qBAAqB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IAChE,MAAM,OAAO,GAAG,sBAAsB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAE3D,MAAM,eAAe,GAA2B;QAC9C,GAAG,gBAAgB;QACnB,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC;QAC3B,GAAG,CAAC,UAAU,IAAI,EAAE,UAAU,EAAE,CAAC;QACjC,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC;KAC5B,CAAC;IACF,OAAO,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3E,CAAC,CAAC;AAjBW,QAAA,gBAAgB,oBAiB3B;AAEF,MAAM,sBAAsB,GAAG,CAC7B,SAAgC,EACG,EAAE;IACrC,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,CAEjD,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACtB,IAAI,KAAK,EAAE;YACT,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC;SAC/B;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAC5B,SAAoC,EACE,EAAE;IACxC,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,CAEjD,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACtB,IAAI,KAAK,EAAE;YACT,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC;SAC9B;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAC7B,SAAiC,EACE,EAAE;IACrC,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,CAEjD,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACtB,IAAI,KAAK,EAAE;YACT,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC;SAC/B;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;AACjE,CAAC,CAAC"}

package/lib-commonjs/create/content.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createContent = void 0;
+const zod_1 = require("zod");
+const schema_1 = require("./schema");
+const createMediaTypeSchema = (schemaObject, components) => {
+    if (!schemaObject) {
+        return undefined;
+    }
+    if (!(schemaObject instanceof zod_1.ZodType)) {
+        return schemaObject;
+    }
+    return (0, schema_1.createSchemaOrRef)(schemaObject, components);
+};
+const createMediaTypeObject = (mediaTypeObject, components) => {
+    if (!mediaTypeObject) {
+        return undefined;
+    }
+    return {
+        ...mediaTypeObject,
+        schema: createMediaTypeSchema(mediaTypeObject.schema, components),
+    };
+};
+const createContent = (contentObject, components) => Object.entries(contentObject).reduce((acc, [path, zodOpenApiMediaTypeObject]) => {
+    const mediaTypeObject = createMediaTypeObject(zodOpenApiMediaTypeObject, components);
+    if (mediaTypeObject) {
+        acc[path] = mediaTypeObject;
+    }
+    return acc;
+}, {});
+exports.createContent = createContent;
+//# sourceMappingURL=content.js.map

package/lib-commonjs/create/content.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content.js","sourceRoot":"","sources":["../../src/create/content.ts"],"names":[],"mappings":";;;AACA,6BAA4C;AAI5C,qCAA6C;AAE7C,MAAM,qBAAqB,GAAG,CAC5B,YAIa,EACb,UAA4B,EAC4B,EAAE;IAC1D,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,CAAC,CAAC,YAAY,YAAY,aAAO,CAAC,EAAE;QACtC,OAAO,YAAY,CAAC;KACrB;IAED,OAAO,IAAA,0BAAiB,EAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAC5B,eAAsD,EACtD,UAA4B,EACO,EAAE;IACrC,IAAI,CAAC,eAAe,EAAE;QACpB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO;QACL,GAAG,eAAe;QAClB,MAAM,EAAE,qBAAqB,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC;KAClE,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,aAAa,GAAG,CAC3B,aAAsC,EACtC,UAA4B,EACP,EAAE,CACvB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,MAAM,CAClC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,yBAAyB,CAAC,EAAuB,EAAE;IAC9D,MAAM,eAAe,GAAG,qBAAqB,CAC3C,yBAAyB,EACzB,UAAU,CACX,CAAC;IAEF,IAAI,eAAe,EAAE;QACnB,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;KAC7B;IACD,OAAO,GAAG,CAAC;AACb,CAAC,EACD,EAAE,CACH,CAAC;AAjBS,QAAA,aAAa,iBAiBtB"}

package/lib-commonjs/create/document.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDocumentYaml = exports.createDocumentJson = exports.createDocument = void 0;
+const yaml_1 = require("yaml");
+const components_1 = require("./components");
+const paths_1 = require("./paths");
+const createDocument = (zodOpenApiObject) => {
+    const { schemas, parameters, headers, ...rest } = zodOpenApiObject.components ?? {};
+    const components = (0, components_1.getDefaultComponents)({ headers, schemas, parameters });
+    return {
+        ...zodOpenApiObject,
+        paths: (0, paths_1.createPaths)(zodOpenApiObject.paths, components),
+        webhooks: (0, paths_1.createPaths)(zodOpenApiObject.webhooks, components),
+        components: (0, components_1.createComponents)(rest, components),
+    };
+};
+exports.createDocument = createDocument;
+const createDocumentJson = (params, jsonOptions) => {
+    const document = (0, exports.createDocument)(params);
+    return JSON.stringify(document, jsonOptions?.replacer, jsonOptions?.options ?? 2);
+};
+exports.createDocumentJson = createDocumentJson;
+const createDocumentYaml = (params, yamlOptions = {}) => {
+    const document = (0, exports.createDocument)(params);
+    return (0, yaml_1.stringify)(document, yamlOptions.replacer, yamlOptions.options);
+};
+exports.createDocumentYaml = createDocumentYaml;
+//# sourceMappingURL=document.js.map

package/lib-commonjs/create/document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.js","sourceRoot":"","sources":["../../src/create/document.ts"],"names":[],"mappings":";;;AACA,+BAAiC;AAGjC,6CAAsE;AACtE,mCAAsC;AA+E/B,MAAM,cAAc,GAAG,CAC5B,gBAAkC,EACb,EAAE;IACvB,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAC7C,gBAAgB,CAAC,UAAU,IAAI,EAAE,CAAC;IACpC,MAAM,UAAU,GAAG,IAAA,iCAAoB,EAAC,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IAE1E,OAAO;QACL,GAAG,gBAAgB;QACnB,KAAK,EAAE,IAAA,mBAAW,EAAC,gBAAgB,CAAC,KAAK,EAAE,UAAU,CAAC;QACtD,QAAQ,EAAE,IAAA,mBAAW,EAAC,gBAAgB,CAAC,QAAQ,EAAE,UAAU,CAAC;QAC5D,UAAU,EAAE,IAAA,6BAAgB,EAAC,IAAI,EAAE,UAAU,CAAC;KAC/C,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,cAAc,kBAazB;AAEK,MAAM,kBAAkB,GAAG,CAChC,MAAwB,EACxB,WAGC,EACO,EAAE;IACV,MAAM,QAAQ,GAAG,IAAA,sBAAc,EAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,CAAC,SAAS,CACnB,QAAQ,EACR,WAAW,EAAE,QAAQ,EACrB,WAAW,EAAE,OAAO,IAAI,CAAC,CAC1B,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,kBAAkB,sBAa7B;AAEK,MAAM,kBAAkB,GAAG,CAChC,MAAwB,EACxB,cAGI,EAAE,EACE,EAAE;IACV,MAAM,QAAQ,GAAG,IAAA,sBAAc,EAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAA,gBAAS,EAAC,QAAQ,EAAE,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;AACxE,CAAC,CAAC;AATW,QAAA,kBAAkB,sBAS7B"}