feat: add type definitions (#22)

Author: George-Payne

index.d.ts

@@ -0,0 +1,32 @@
+declare namespace OpenapiSchemaToJsonSchema {
+  interface Options {
+    dateToDateTime?: boolean;
+    cloneSchema?: boolean;
+    supportPatternProperties?: boolean;
+    keepNotSupported?: NotSupported[];
+    strictMode?: boolean;
+  }
+  type NotSupported =
+    | "nullable"
+    | "discriminator"
+    | "readOnly"
+    | "writeOnly"
+    | "xml"
+    | "externalDocs"
+    | "example"
+    | "deprecated";
+
+  function fromSchema<T = Record<string | number, any>>(
+    schema: Record<string | number, any>,
+    options?: Options
+  ): T;
+  function fromParameter<T = Record<string | number, any>>(
+    parameter: Record<string | number, any>,
+    options?: Options
+  ): T;
+}
+declare function OpenapiSchemaToJsonSchema<T = Record<string | number, any>>(
+  schema: Record<string | number, any>,
+  options?: OpenapiSchemaToJsonSchema.Options
+): T;
+export = OpenapiSchemaToJsonSchema;

package.json

@@ -3,6 +3,7 @@
   "version": "0.0.0-development",
   "description": "Converts OpenAPI Schema Object to JSON Schema",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "pretest": "npm run lint",
     "test": "tape test/**/*.test.js | tap-spec",