zod-openapi 0.0.0-semantically-released → 0.2.0

package/lib-types/extendZod.d.ts

@@ -0,0 +1,36 @@
+import { oas31 } from 'openapi3-ts';
+import { UnknownKeysParam, ZodDate, ZodObject, ZodRawShape, ZodTypeAny, z } from 'zod';
+interface ZodOpenApiMetadata<T extends ZodTypeAny, TInferred = z.infer<T>> extends Omit<oas31.SchemaObject, 'example'> {
+    examples?: [TInferred, ...TInferred[]];
+    default?: T extends ZodDate ? string : TInferred;
+    ref?: string;
+    param?: Partial<oas31.ParameterObject> & {
+        example?: TInferred;
+        examples?: {
+            [param: string]: (oas31.ExampleObject & {
+                value: TInferred;
+            }) | oas31.ReferenceObject;
+        };
+        ref?: string;
+    };
+    header?: Partial<oas31.HeaderObject> & {
+        ref?: string;
+    };
+}
+interface ZodOpenApiExtendMetadata {
+    extends: ZodObject<any, any, any, any, any>;
+    extendsRef?: string;
+}
+declare module 'zod' {
+    interface ZodSchema<Output, Def extends ZodTypeDef, Input = Output> {
+        openapi<T extends ZodTypeAny>(this: T, metadata: ZodOpenApiMetadata<T>): T;
+    }
+    interface ZodTypeDef {
+        openapi?: ZodOpenApiMetadata<ZodTypeAny>;
+    }
+    interface ZodObjectDef<T extends ZodRawShape = ZodRawShape, UnknownKeys extends UnknownKeysParam = UnknownKeysParam, Catchall extends ZodTypeAny = ZodTypeAny> extends ZodTypeDef {
+        extendMetadata?: ZodOpenApiExtendMetadata;
+    }
+}
+export declare function extendZodWithOpenApi(zod: typeof z): void;
+export {};

package/lib-types/index.d.ts

@@ -1,5 +1,2 @@
-/**
- * Writes the module name to stdout.
- * Thrilling stuff.
- */
-export declare const log: () => void;
+export * from './create/document';
+export * from './extendZod';

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "zod-openapi",
-  "version": "0.0.0-semantically-released",
-  "description": "Zod OpenAPI Plugin",
-  "homepage": "https://github.com/seek-oss/zod-openapi#readme",
+  "version": "0.2.0",
+  "description": "A plugin to create full OpenAPI documents from your Zod types",
+  "homepage": "https://github.com/samchungy/zod-openapi#readme",
   "bugs": {
-    "url": "https://github.com/seek-oss/zod-openapi/issues"
+    "url": "https://github.com/samchungy/zod-openapi/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com/seek-oss/zod-openapi.git"
+    "url": "git+ssh://git@github.com/samchungy/zod-openapi.git"
   },
   "license": "MIT",
   "sideEffects": false,
@@ -36,11 +36,18 @@
       "path": "cz-conventional-changelog"
     }
   },
-  "dependencies": {},
+  "dependencies": {
+    "openapi3-ts": "4.0.4",
+    "yaml": "2.2.1"
+  },
+  "peerDependencies": {
+    "zod": "^3.21.4"
+  },
   "devDependencies": {
     "@types/node": "^16.18.3",
     "commitizen": "^4.2.4",
-    "skuba": "6.0.0"
+    "skuba": "6.0.0",
+    "zod": "3.21.4"
   },
   "engines": {
     "node": ">=16.11"