feat: make proxy address customizable

Converting proxyUrl into a string would be possibly a breaking change,
so instead I added a proxyAddress option which is a URL to use instead
of try.readme.io

The reason to make this change is so that I can test a beta version of
try.readme.io safely in staging

Bumped oas-to-har version to 23.3.0

packages/oas-to-har/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@readme/oas-to-har",
   "description": "Utility to transform an OAS operation into a HAR representation",
-  "version": "23.2.27",
+  "version": "23.3.0",
   "author": "Jon Ursenbach <jon@ursenba.ch>",
   "license": "ISC",
   "sideEffects": false,

packages/oas-to-har/src/index.ts

@@ -223,11 +223,16 @@ export default function oasToHar(
   values: DataForHAR = {},
   auth: AuthForHAR = {},
   opts: oasToHarOptions = {
-    // If true, the operation URL will be rewritten and prefixed with https://try.readme.io/ in
-    // order to funnel requests through our CORS-friendly proxy.
+    // If true, the operation URL will be rewritten and prefixed with
+    // a proxy
     proxyUrl: false,
   },
 ) {
+  if (opts.proxyUrl && !opts.proxyAddress) {
+    // eslint-disable-next-line no-param-reassign
+    opts.proxyAddress = 'https://try.readme.io';
+  }
+
   let operation: Operation;
   if (!operationSchema || typeof operationSchema.getParameters !== 'function') {
     /**
@@ -287,7 +292,7 @@ export default function oasToHar(
 
   if (opts.proxyUrl) {
     if (oas.getExtension(PROXY_ENABLED, operation)) {
-      har.url = `https://try.readme.io/${har.url}`;
+      har.url = `${opts.proxyAddress}/${har.url}`;
     }
   }
 

packages/oas-to-har/src/lib/types.ts

@@ -3,6 +3,9 @@ export type AuthForHAR = Record<string, number | string | { pass?: string; user?
 export { DataForHAR } from 'oas/types';
 
 export interface oasToHarOptions {
+  // The URL to use for the proxy; defaults to https://try.readme.io
+  proxyAddress?: string;
+
   // If true, the operation URL will be rewritten and prefixed with https://try.readme.io/ in
   // order to funnel requests through our CORS-friendly proxy.
   proxyUrl: boolean;

packages/oas-to-har/test/index.test.ts

@@ -213,6 +213,17 @@ describe('oas-to-har', () => {
         const har = oasToHar(proxyOas, proxyOas.operation('/path', 'get'), {}, {}, { proxyUrl: true });
         expect(har.log.entries[0].request.url).toBe('https://try.readme.io/https://example.com/path');
       });
+
+      it('should be prefixed with beta.try.readme.io with proxyAddress option', () => {
+        const har = oasToHar(
+          proxyOas,
+          proxyOas.operation('/path', 'get'),
+          {},
+          {},
+          { proxyUrl: true, proxyAddress: 'https://beta.try.readme.io' },
+        );
+        expect(har.log.entries[0].request.url).toBe('https://beta.try.readme.io/https://example.com/path');
+      });
     });
   });