fix(httpsnippet-client-api): making external deps no longer external (#810)

* fix: marking external esm-only deps as bundled deps

* fix: moving camelcase and stringify-object to being devdeps

* fix: dont use bundledDependencies

Author: erunion

package-lock.json

@@ -11,11 +11,14 @@ export default defineConfig((options: Options) => ({
   ...config,
 
   entry: ['src/errors/fetchError.ts', 'src/lib/index.ts', 'src/index.ts', 'src/types.ts'],
+
   noExternal: [
-    // `get-stream` is ESM-only and we need to build for CommonJS,
-    // so including it here means that its (tree-shaken!) source code
-    // will be included directly in our dist outputs.
+    // These dependencies are ESM-only but because we're building for ESM **and** CJS we can't
+    // treat them as external dependencies as CJS libraries can't load ESM code that uses `export`.
+    // `noExternal` will instead treeshake these dependencies down and include them in our compiled
+    // dists.
     'get-stream',
   ],
+
   silent: !options.watch,
 }));

packages/core/tsup.config.ts

@@ -36,10 +36,8 @@
     "node": ">=18"
   },
   "dependencies": {
-    "camelcase": "^8.0.0",
     "content-type": "^1.0.5",
-    "reserved2": "^0.1.5",
-    "stringify-object": "^5.0.0"
+    "reserved2": "^0.1.5"
   },
   "peerDependencies": {
     "@readme/httpsnippet": ">=8.1.2",
@@ -51,6 +49,8 @@
     "@types/content-type": "^1.1.6",
     "@types/stringify-object": "^4.0.3",
     "@vitest/coverage-v8": "^0.34.4",
+    "camelcase": "^8.0.0",
+    "stringify-object": "^5.0.0",
     "typescript": "^5.2.2",
     "vitest": "^0.34.5"
   },

packages/httpsnippet-client-api/package.json

@@ -4,12 +4,12 @@ import type { Operation } from 'oas/operation';
 import type { HttpMethods, OASDocument } from 'oas/types';
 
 import { CodeBuilder } from '@readme/httpsnippet/helpers/code-builder';
-import camelCase from 'camelcase';
+import camelCase from 'camelcase'; // eslint-disable-line import/no-extraneous-dependencies
 import contentType from 'content-type';
 import Oas from 'oas';
 import { matchesMimeType } from 'oas/utils';
 import { isReservedOrBuiltinsLC } from 'reserved2';
-import stringifyObject from 'stringify-object';
+import stringifyObject from 'stringify-object'; // eslint-disable-line import/no-extraneous-dependencies
 
 /**
  * @note This regex also exists in `api/fetcher`.

packages/httpsnippet-client-api/src/index.ts

@@ -11,5 +11,15 @@ export default defineConfig((options: Options) => ({
   ...config,
 
   entry: ['src/index.ts'],
+
+  noExternal: [
+    // These dependencies are ESM-only but because we're building for ESM **and** CJS we can't
+    // treat them as external dependencies as CJS libraries can't load ESM code that uses `export`.
+    // `noExternal` will instead treeshake these dependencies down and include them in our compiled
+    // dists.
+    'camelcase',
+    'stringify-object',
+  ],
+
   silent: !options.watch,
 }));