Merge pull request #1934 from seriouslag/feat/add-shared-exports

feat(openapi-ts): export additional functions from openapi-ts

Author: mrlubos

.changeset/three-rats-count.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix: export some internal functions

packages/openapi-ts/package.json

@@ -52,6 +52,16 @@
         "default": "./dist/index.cjs"
       }
     },
+    "./internal": {
+      "import": {
+        "types": "./dist/internal.d.ts",
+        "default": "./dist/internal.js"
+      },
+      "require": {
+        "types": "./dist/internal.d.cts",
+        "default": "./dist/internal.cjs"
+      }
+    },
     "./package.json": "./package.json"
   },
   "bin": {
@@ -64,7 +74,7 @@
   ],
   "scripts": {
     "build": "tsup && pnpm check-exports",
-    "check-exports": "attw --pack .",
+    "check-exports": "attw --pack . --profile node16",
     "dev": "tsup --watch",
     "handlebars": "node src/legacy/handlebars/handlebars.cjs",
     "prepublishOnly": "pnpm build",

packages/openapi-ts/src/__tests__/index.test.ts

@@ -0,0 +1,10 @@
+import { describe, expect, it } from 'vitest';
+
+describe('main entry index', () => {
+  describe('createClient', () => {
+    it('should be exported', async () => {
+      const { createClient } = await import('../index');
+      expect(createClient).toBeDefined();
+    });
+  });
+});

packages/openapi-ts/src/__tests__/internal.test.ts

@@ -0,0 +1,18 @@
+import { describe, expect, it } from 'vitest';
+
+describe('internal entry index', () => {
+  it('getSpec should be exported', async () => {
+    const { getSpec } = await import('../internal');
+    expect(getSpec).toBeDefined();
+  });
+
+  it('initConfigs should be exported', async () => {
+    const { initConfigs } = await import('../internal');
+    expect(initConfigs).toBeDefined();
+  });
+
+  it('parseOpenApiSpec should be exported', async () => {
+    const { parseOpenApiSpec } = await import('../internal');
+    expect(parseOpenApiSpec).toBeDefined();
+  });
+});

packages/openapi-ts/src/getSpec.ts

@@ -21,6 +21,9 @@ interface SpecError {
   response: Response;
 }
 
+/**
+ * @internal
+ */
 export const getSpec = async ({
   fetchOptions,
   inputPath,

packages/openapi-ts/src/initConfigs.ts

@@ -253,6 +253,9 @@ const getWatch = (
   return watch;
 };
 
+/**
+ * @internal
+ */
 export const initConfigs = async (
   userConfig: UserConfig | undefined,
 ): Promise<Config[]> => {

packages/openapi-ts/src/internal.ts

@@ -0,0 +1,3 @@
+export { getSpec } from './getSpec';
+export { initConfigs } from './initConfigs';
+export { parseOpenApiSpec } from './openApi';

packages/openapi-ts/src/openApi/index.ts

@@ -57,6 +57,7 @@ export function parseLegacy({
 }
 
 /**
+ * @internal
  * Parse the resolved OpenAPI specification. This will populate and return
  * `context` with intermediate representation obtained from the parsed spec.
  */

packages/openapi-ts/tsup.config.ts

@@ -14,7 +14,7 @@ export default defineConfig((options) => ({
   },
   clean: true,
   dts: true,
-  entry: ['src/index.ts'],
+  entry: ['src/index.ts', 'src/internal.ts'],
   format: ['cjs', 'esm'],
   minify: !options.watch,
   shims: false,