Remove All Dependencies (#47)

.eslintignore

@@ -12,3 +12,5 @@ node_modules*/
 /lib*/
 /tmp*/
 # end managed by skuba
+
+src/openapi3-ts/*

.github/workflows/validate.yml

@@ -30,3 +30,6 @@ jobs:
 
       - name: Lint
         run: yarn lint
+
+      - name: Build
+        run: yarn build

.prettierignore

@@ -21,3 +21,4 @@ gantry*.yml
 
 examples/**/*.yml
 examples/**/*.html
+src/openapi3-ts/*

README.md

@@ -150,40 +150,6 @@ Generates the following object:
 }
 ```
 
-### `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: { aliasDuplicateObjects: false } },
-);
-```
-
 ## Usage
 
 ### Request Parameters

examples/simple/createSchema.ts

@@ -1,7 +1,9 @@
 import fs from 'fs';
 import path from 'path';
 
-import { ZodOpenApiOperationObject, createDocumentYaml } from '../../src';
+import { stringify } from 'yaml';
+
+import { ZodOpenApiOperationObject, createDocument } from '../../src';
 
 import {
   CreateJobRequestSchema,
@@ -52,7 +54,7 @@ const createJobOperation: ZodOpenApiOperationObject = {
   },
 };
 
-const yaml = createDocumentYaml({
+const document = createDocument({
   openapi: '3.1.0',
   info: {
     title: 'Simple API',
@@ -99,5 +101,7 @@ const yaml = createDocumentYaml({
   },
 });
 
+const yaml = stringify(document, { aliasDuplicateObjects: false });
+
 // eslint-disable-next-line no-sync
 fs.writeFileSync(path.join(__dirname, 'openapi.yml'), yaml);

package.json

@@ -22,7 +22,8 @@
     "lib*/**/*.json"
   ],
   "scripts": {
-    "build": "skuba build-package",
+    "build": "yarn copy:types && skuba build-package",
+    "copy:types": "skuba node scripts/copyTypes.ts",
     "create:docs": " skuba node examples/simple/createSchema.ts && redocly build-docs examples/simple/openapi.yml --output=examples/simple/redoc-static.html",
     "format": "skuba format",
     "lint": "skuba lint",
@@ -31,15 +32,14 @@
     "test:ci": "skuba test --coverage",
     "test:watch": "skuba test --watch"
   },
-  "dependencies": {
-    "openapi3-ts": "^4.1.2",
-    "yaml": "^2.2.2"
-  },
+  "dependencies": {},
   "devDependencies": {
     "@redocly/cli": "1.0.0-beta.125",
     "@types/node": "^18.15.13",
     "eslint-plugin-zod-openapi": "^0.0.3",
+    "openapi3-ts": "^4.1.2",
     "skuba": "6.0.2",
+    "yaml": "2.2.2",
     "zod": "3.21.4"
   },
   "peerDependencies": {

scripts/copyTypes.ts

@@ -0,0 +1,65 @@
+import { promises as fs } from 'fs';
+import { join, relative } from 'path';
+
+import { Git } from 'skuba';
+
+async function copyDTs(src: string, dest: string): Promise<void> {
+  const files = await fs.readdir(src);
+  for (const file of files) {
+    const filePath = join(src, file);
+    const destPath = join(dest, file);
+    const stats = await fs.stat(filePath);
+    if (stats.isDirectory()) {
+      await copyDTs(filePath, destPath);
+    } else if (filePath.endsWith('.d.ts')) {
+      const dirPath = join(
+        dest,
+        relative(src, filePath).split('/').slice(0, -1).join('/'),
+      );
+      await fs.mkdir(dirPath, { recursive: true });
+      await fs.copyFile(
+        filePath,
+        `${destPath.slice(0, destPath.length - 5)}.ts`,
+      );
+    }
+  }
+}
+
+async function deleteFolderRecursive(folderPath: string) {
+  const files = await fs.readdir(folderPath);
+
+  for (const file of files) {
+    const filePath = join(folderPath, file);
+    const stats = await fs.stat(filePath);
+
+    if (stats.isDirectory()) {
+      await deleteFolderRecursive(filePath);
+    } else {
+      await fs.unlink(filePath);
+    }
+  }
+
+  await fs.rmdir(folderPath);
+}
+
+async function main() {
+  const dir = process.cwd();
+
+  const src = join(dir, './node_modules/openapi3-ts');
+  const dest = join(dir, 'src/openapi3-ts');
+  await deleteFolderRecursive(dest);
+  await copyDTs(src, dest);
+
+  if (process.env.GITHUB_ACTIONS) {
+    const files = await Git.getChangedFiles({ dir });
+    if (files.length) {
+      throw new Error('openapi3-ts types need updating');
+    }
+  }
+}
+
+main().catch((error) => {
+  // eslint-disable-next-line no-console
+  console.error(error);
+  throw error;
+});

src/create/components.test.ts

@@ -1,7 +1,7 @@
-import { oas31 } from 'openapi3-ts';
 import { z } from 'zod';
 
 import { extendZodWithOpenApi } from '../extendZod';
+import { oas31 } from '../openapi3-ts/dist';
 
 import {
   CompleteSchemaComponent,

src/create/components.ts

@@ -1,6 +1,7 @@
-import { oas30, oas31 } from 'openapi3-ts';
 import { ZodRawShape, ZodType } from 'zod';
 
+import { oas30, oas31 } from '../openapi3-ts/dist';
+
 import {
   ZodOpenApiComponentsObject,
   ZodOpenApiRequestBodyObject,

src/create/content.test.ts

@@ -1,7 +1,7 @@
-import { oas31 } from 'openapi3-ts';
 import { z } from 'zod';
 
 import { extendZodWithOpenApi } from '../extendZod';
+import { oas31 } from '../openapi3-ts/dist';
 
 import { getDefaultComponents } from './components';
 import { createContent } from './content';

src/create/content.ts

@@ -1,6 +1,7 @@
-import { oas31 } from 'openapi3-ts';
 import { ZodType } from 'zod';
 
+import { oas31 } from '../openapi3-ts/dist';
+
 import { ComponentsObject, CreationType } from './components';
 import { ZodOpenApiContentObject, ZodOpenApiMediaTypeObject } from './document';
 import { createSchemaOrRef } from './schema';