chore(deps): npm up

package.json

@@ -27,12 +27,12 @@
   ],
   "devDependencies": {
     "@readme/eslint-config": "^14.0.0",
-    "@vitest/coverage-v8": "^1.6.0",
+    "@vitest/coverage-v8": "^2.1.3",
     "alex": "^11.0.1",
     "eslint": "^8.57.0",
     "lerna": "^8.1.2",
     "prettier": "^3.2.5",
-    "vitest": "^1.6.0"
+    "vitest": "^2.1.3"
   },
   "prettier": "@readme/eslint-config/prettier"
 }

packages/oas-normalize/package.json

@@ -77,7 +77,7 @@
     "nock": "^14.0.0-beta.12",
     "tsup": "^8.0.2",
     "typescript": "^5.1.6",
-    "vitest": "^1.6.0"
+    "vitest": "^2.1.3"
   },
   "prettier": "@readme/eslint-config/prettier"
 }

packages/oas-normalize/src/index.ts

@@ -186,6 +186,7 @@ export default class OASNormalize {
          * is valid or not we need to clone it before passing it over to `openapi-parser` so as to
          * not run into pass-by-reference problems.
          */
+        // eslint-disable-next-line try-catch-failsafe/json-parse
         const clonedSchema = JSON.parse(JSON.stringify(schema));
 
         return openapiParser

packages/oas-normalize/src/lib/utils.ts

@@ -87,6 +87,7 @@ export function stringToJSON(string: Record<string, unknown> | string): Record<s
   if (typeof string === 'object') {
     return string;
   } else if (string.match(/^\s*{/)) {
+    // eslint-disable-next-line try-catch-failsafe/json-parse
     return JSON.parse(string);
   }
 

packages/oas-to-har/package.json

@@ -63,7 +63,7 @@
     "tsup": "^8.0.2",
     "type-fest": "^4.18.3",
     "typescript": "^5.2.2",
-    "vitest": "^1.6.0"
+    "vitest": "^2.1.3"
   },
   "prettier": "@readme/eslint-config/prettier"
 }

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

@@ -411,6 +411,7 @@ export default function oasToHar(
 
     if (operation.isFormUrlEncoded()) {
       if (Object.keys(formData.formData || {}).length) {
+        // eslint-disable-next-line try-catch-failsafe/json-parse
         const cleanFormData = removeUndefinedObjects(JSON.parse(JSON.stringify(formData.formData)));
         if (cleanFormData !== undefined) {
           const postData: PostData = { params: [], mimeType: 'application/x-www-form-urlencoded' };
@@ -539,6 +540,7 @@ export default function oasToHar(
                   jsonTypes.forEach((prop: boolean | string) => {
                     try {
                       set(cleanBody, String(prop), JSON.parse(get(cleanBody, String(prop))));
+                      // eslint-disable-next-line @typescript-eslint/no-unused-vars
                     } catch (e) {
                       // leave the prop as a string value
                     }
@@ -551,6 +553,7 @@ export default function oasToHar(
                   }
 
                   har.postData.text = JSON.stringify(cleanBody);
+                  // eslint-disable-next-line @typescript-eslint/no-unused-vars
                 } catch (e) {
                   har.postData.text = stringify(formData.body);
                 }
@@ -559,6 +562,7 @@ export default function oasToHar(
               }
             }
           }
+          // eslint-disable-next-line @typescript-eslint/no-unused-vars
         } catch (e) {
           // If anything above fails for whatever reason, assume that whatever we had is invalid
           // JSON and just treat it as raw text.

packages/oas-to-har/src/lib/style-formatting/style-serializer.ts

@@ -16,6 +16,7 @@ const isRfc3986Unreserved = (char: string) => /^[a-z0-9\-._~]+$/i.test(char);
 function isURIEncoded(value: string) {
   try {
     return decodeURIComponent(value) !== value;
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
   } catch (err) {
     // `decodeURIComponent` will throw an exception if a string that has an un-encoded percent sign
     //  in it (like 20%), o if it's throwing we can just assume that the value hasn't been encoded.
@@ -59,6 +60,7 @@ export function encodeDisallowedCharacters(
   }
 
   if (parse) {
+    // eslint-disable-next-line try-catch-failsafe/json-parse
     return JSON.parse(str);
   }
 

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

@@ -144,6 +144,7 @@ export function getTypedFormatsInSchema(
       })
       .flat()
       .filter(Boolean);
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
   } catch (err) {
     // If this fails for whatever reason then we should act as if we didn't find any `format`'d
     // schemas.

packages/oas-to-snippet/package.json

@@ -50,7 +50,7 @@
     "test": "echo 'Please run tests from the root!' && exit 1"
   },
   "dependencies": {
-    "@readme/httpsnippet": "^10.1.0",
+    "@readme/httpsnippet": "^11.0.0",
     "@readme/oas-to-har": "file:../oas-to-har"
   },
   "devDependencies": {
@@ -63,7 +63,7 @@
     "tsup": "^8.0.2",
     "type-fest": "^4.18.3",
     "typescript": "^5.2.2",
-    "vitest": "^1.6.0"
+    "vitest": "^2.1.3"
   },
   "prettier": "@readme/eslint-config/prettier"
 }

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

@@ -91,6 +91,7 @@ export default function oasToSnippet(
 
   try {
     ({ config, language, target } = getLanguageConfig(languages, lang));
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
   } catch (err) {
     if (!language || !target) {
       return { code: '', highlightMode: false, install: false };

packages/oas-to-snippet/src/languages.ts

@@ -257,6 +257,7 @@ export function getSupportedLanguages(
     plugins?: ClientPlugin<any>[];
   } = { plugins: [] },
 ) {
+  // eslint-disable-next-line try-catch-failsafe/json-parse
   const languages: SupportedLanguages = JSON.parse(JSON.stringify(DEFAULT_LANGUAGES));
 
   Object.entries(targets).forEach(([target, { clientsById }]) => {

packages/oas-to-snippet/test/__snapshots__/index.test.ts.snap

@@ -493,19 +493,19 @@ developers.loginUser({username: 'woof', password: 'barkbarkbark'})
   .then(({ data }) => console.log(data))
   .catch(err => console.error(err));",
   "highlightMode": "javascript",
-  "install": "npx api install @developers/v2.0#17273l2glm9fq4l5",
+  "install": "npx api install "@developers/v2.0#17273l2glm9fq4l5"",
 }
 `;
 
 exports[`oas-to-snippet > supported languages > node > targets > api > should support snippet generation 1`] = `
 {
-  "code": "import sdk from '@api/developers';
+  "code": "import developers from '@api/developers';
 
-sdk.loginUser({username: 'woof', password: 'barkbarkbark'})
+developers.loginUser({username: 'woof', password: 'barkbarkbark'})
   .then(({ data }) => console.log(data))
   .catch(err => console.error(err));",
   "highlightMode": "javascript",
-  "install": "npx api install @developers/v2.0#17273l2glm9fq4l5",
+  "install": "npx api install "@developers/v2.0#17273l2glm9fq4l5"",
 }
 `;
 

packages/oas-to-snippet/test/languages.test.ts

@@ -19,7 +19,7 @@ describe('#getSupportedLanguages', () => {
 
     expect(languages.node.httpsnippet.targets.api).toStrictEqual({
       name: 'API',
-      install: 'npx api install {packageName}',
+      install: 'npx api install "{packageName}"',
     });
   });
 });
@@ -43,7 +43,7 @@ describe('#getClientInstallationInstructions', () => {
     });
 
     expect(getClientInstallationInstructions(languages, ['node', 'api'], '@developers/v2.0#17273l2glm9fq4l5')).toBe(
-      'npx api install @developers/v2.0#17273l2glm9fq4l5',
+      'npx api install "@developers/v2.0#17273l2glm9fq4l5"',
     );
   });
 

packages/oas/.eslintrc

@@ -2,6 +2,7 @@
   "rules": {
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/no-use-before-define": ["error", { "classes": false }],
+    "@typescript-eslint/no-unused-vars": "error",
 
     "camelcase": "off",
 

packages/oas/package.json

@@ -107,7 +107,7 @@
     "@types/node": "^20.12.13",
     "tsup": "^8.0.2",
     "typescript": "^5.4.4",
-    "vitest": "^1.6.0"
+    "vitest": "^2.1.3"
   },
   "prettier": "@readme/eslint-config/prettier"
 }

packages/oas/src/analyzer/queries/openapi.ts

@@ -32,6 +32,7 @@ export function callbacks(definition: OASDocument) {
 export async function circularRefs(definition: OASDocument) {
   // Dereferencing will update the passed in variable, which we don't want to do, so we
   // instantiated `Oas` with a clone.
+  // eslint-disable-next-line try-catch-failsafe/json-parse
   const oas = new Oas(JSON.parse(JSON.stringify(definition)));
   await oas.dereference();
 

packages/oas/src/index.ts

@@ -88,6 +88,7 @@ function normalizedUrl(api: RMOAS.OASDocument, selected: number) {
       urlWithOrigin.pathname = url;
       url = urlWithOrigin.href;
     }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
   } catch (e) {
     url = exampleDotCom;
   }
@@ -167,6 +168,7 @@ function generatePathMatches(paths: RMOAS.PathsObject, pathName: string, origin:
       try {
         const matchStatement = match(cleanedPath, { decode: decodeURIComponent });
         matchResult = matchStatement(prunedPathName);
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
       } catch (err) {
         // If path matching fails for whatever reason (maybe they have a malformed path parameter)
         // then we shouldn't also fail.
@@ -281,6 +283,7 @@ export default class Oas {
    */
   constructor(oas: RMOAS.OASDocument | string, user?: RMOAS.User) {
     if (typeof oas === 'string') {
+      // eslint-disable-next-line try-catch-failsafe/json-parse
       oas = JSON.parse(oas) as RMOAS.OASDocument;
     }
     // @todo throw an exception here instead of allowing an empty oas
@@ -337,6 +340,7 @@ export default class Oas {
     try {
       variables = this.api.servers[selected].variables;
       if (!variables) throw new Error('no variables');
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
     } catch (e) {
       variables = {};
     }

packages/oas/src/lib/clone-object.ts

@@ -3,5 +3,6 @@ export default function cloneObject<T>(obj: T): T {
     return undefined;
   }
 
+  // eslint-disable-next-line try-catch-failsafe/json-parse
   return JSON.parse(JSON.stringify(obj));
 }

packages/oas/src/lib/openapi-to-json-schema.ts

@@ -198,6 +198,7 @@ function searchForValueByPropAndPointer(
 
       try {
         foundValue = jsonpointer.get(schema, pointers[i]);
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
       } catch (err) {
         // If the schema we're looking at is `{obj: null}` and our pointer is `/obj/propertyName`
         // `jsonpointer` will throw an error. If that happens, we should silently catch and toss it
@@ -329,6 +330,7 @@ export function toJSONSchema(data: RMOAS.SchemaObject | boolean, opts: toJSONSch
             defaultResolver: mergeJSONSchemaAllOf.options.resolvers.title,
           } as unknown,
         }) as RMOAS.SchemaObject;
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
       } catch (e) {
         // If we can't merge the `allOf` for whatever reason (like if one item is a `string` and
         // the other is a `object`) then we should completely remove it from the schema and continue
@@ -780,6 +782,7 @@ export function toJSONSchema(data: RMOAS.SchemaObject | boolean, opts: toJSONSch
       if (userJwtDefault) {
         schema.default = userJwtDefault;
       }
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
     } catch (err) {
       // If jsonpointer returns an error, we won't show any defaults for that path.
     }

packages/oas/src/operation/index.ts

@@ -1,9 +1,9 @@
+import type { Extensions } from '../extensions.js';
+import type { SecurityType } from '../types.js';
 import type { CallbackExamples } from './lib/get-callback-examples.js';
 import type { getParametersAsJSONSchemaOptions } from './lib/get-parameters-as-json-schema.js';
 import type { RequestBodyExamples } from './lib/get-requestbody-examples.js';
 import type { ResponseExamples } from './lib/get-response-examples.js';
-import type { Extensions } from '../extensions.js';
-import type { SecurityType } from '../types.js';
 import type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
 
 import findSchemaDefinition from '../lib/find-schema-definition.js';
@@ -194,6 +194,7 @@ export class Operation {
       let keys;
       try {
         keys = Object.keys(requirement);
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
       } catch (e) {
         return false;
       }
@@ -203,6 +204,7 @@ export class Operation {
         try {
           // Remove the reference type, because we know this will be dereferenced
           security = this.api.components.securitySchemes[key] as RMOAS.KeyedSecuritySchemeObject;
+          // eslint-disable-next-line @typescript-eslint/no-unused-vars
         } catch (e) {
           return false;
         }

packages/oas/src/operation/lib/get-mediatype-examples.ts

@@ -89,6 +89,7 @@ export function getMediaTypeExamples(
     if (!matchesMimeType.xml(mediaType)) {
       return [
         {
+          // eslint-disable-next-line try-catch-failsafe/json-parse
           value: sampleFromSchema(JSON.parse(JSON.stringify(mediaTypeObject.schema)), opts),
         },
       ];

packages/oas/src/reducer/index.ts

@@ -86,6 +86,7 @@ export default function reducer(definition: OASDocument, opts: ReducerOptions =
   }
 
   // Stringify and parse so we get a full non-reference clone of the API definition to work with.
+  // eslint-disable-next-line try-catch-failsafe/json-parse
   const reduced = JSON.parse(JSON.stringify(definition)) as OASDocument;
 
   // Retain any root-level security definitions.

packages/oas/src/samples/index.ts

@@ -98,6 +98,7 @@ function sampleFromSchema(
         }),
         opts,
       );
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
     } catch (error) {
       return undefined;
     }

packages/oas/src/samples/utils.ts

@@ -36,7 +36,7 @@ export function normalizeArray(arr: (number | string)[] | number | string) {
   return [arr];
 }
 
-// eslint-disable-next-line @typescript-eslint/ban-types
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
 export function isFunc(thing: unknown): thing is Function {
   return typeof thing === 'function';
 }

packages/oas/test/analyzer/queries/openapi.test.ts

@@ -100,6 +100,7 @@ describe('analyzer queries (OpenAPI)', () => {
   describe('discriminators', () => {
     it('should discover `discriminator` usage within a definition that has it', () => {
       expect(QUERIES.discriminators(discriminators)).toStrictEqual([
+        '#/components/schemas/BaseVehicle/discriminator',
         '#/components/schemas/Pet/discriminator',
         '#/paths/~1discriminator-with-mapping/patch/requestBody/content/application~1json/schema/discriminator',
         '#/paths/~1discriminator-with-no-mapping/patch/requestBody/content/application~1json/schema/discriminator',

packages/postman-types/src/index.ts

@@ -124,6 +124,7 @@ export namespace PostmanV2 {
     variable?: VariableListObject;
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   export interface ProtocolProfileBehaviorObject {}
 
   export interface ProxyConfigObject {