feat(oas): working to get strict mode enabled

Author: erunion

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

@@ -23,7 +23,7 @@ export function codeSampleLanguages(definition: OASDocument): string[] {
     new Set(
       query(["$..['x-readme']['samples-languages']", "$..['x-samples-languages']"], definition)
         .map(res => res.value as string)
-        .reduce((prev, next) => prev.concat(next), []),
+        .reduce<string[]>((prev, next) => prev.concat(next), []),
     ),
   );
 

packages/oas/src/extensions.ts

@@ -265,10 +265,10 @@ export interface Extensions {
 }
 
 export const extensionDefaults: Extensions = {
-  [CODE_SAMPLES]: undefined,
+  [CODE_SAMPLES]: [],
   [DISABLE_TAG_SORTING]: false,
   [EXPLORER_ENABLED]: true,
-  [HEADERS]: undefined,
+  [HEADERS]: [],
   [METRICS_ENABLED]: true,
   [OAUTH_OPTIONS]: {},
   [PARAMETER_ORDERING]: ['path', 'query', 'body', 'cookie', 'form', 'header'],
@@ -342,6 +342,10 @@ export function validateParameterOrdering(
   ordering: (typeof extensionDefaults)[typeof PARAMETER_ORDERING] | undefined,
   extension: string,
 ): void {
+  if (!ordering) {
+    return;
+  }
+
   const defaultValue = extensionDefaults[PARAMETER_ORDERING];
   const requiredLength = defaultValue.length;
   const defaultsHuman = `${defaultValue.slice(0, -1).join(', ')}, and ${defaultValue.slice(-1)}`;

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

@@ -7,7 +7,11 @@ type authKey = unknown | { password: number | string; user: number | string } |
  * @param user User to retrieve retrieve an auth key for.
  * @param scheme The type of security scheme that we want a key for.
  */
-function getKey(user: RMOAS.User, scheme: RMOAS.KeyedSecuritySchemeObject): authKey {
+function getKey(user: RMOAS.User | undefined, scheme: RMOAS.KeyedSecuritySchemeObject): authKey {
+  if (!user) {
+    return null;
+  }
+
   switch (scheme.type) {
     case 'oauth2':
     case 'apiKey':
@@ -82,12 +86,12 @@ export function getAuth(
           {
             // This sucks but since we dereference we'll never have a `$ref` pointer here with a
             // `ReferenceObject` type.
-            ...(api.components.securitySchemes[scheme] as RMOAS.SecuritySchemeObject),
+            ...(api.components?.securitySchemes?.[scheme] as RMOAS.SecuritySchemeObject),
             _key: scheme,
           },
           selectedApp,
         ),
       };
     })
-    .reduce((prev, next) => Object.assign(prev, next), {});
+    .reduce<RMOAS.AuthForHAR>((prev, next) => Object.assign(prev, next), {});
 }

packages/oas/src/lib/get-auth.ts

@@ -9,7 +9,7 @@ import type * as RMOAS from '../types.js';
  * @param selectedApp The user app to retrieve an auth key for.
  */
 export default function getUserVariable(user: RMOAS.User, property: string, selectedApp?: number | string): unknown {
-  let key = user;
+  let key: RMOAS.User | undefined = user;
 
   if ('keys' in user && Array.isArray(user.keys) && user.keys.length) {
     if (selectedApp) {
@@ -19,5 +19,5 @@ export default function getUserVariable(user: RMOAS.User, property: string, sele
     }
   }
 
-  return key[property] || user[property] || null;
+  return key?.[property] || user[property] || null;
 }

packages/oas/src/lib/get-user-variable.ts

@@ -19,10 +19,14 @@ export type CallbackExamples = {
 export function getCallbackExamples(operation: RMOAS.OperationObject): CallbackExamples {
   const ret: CallbackExamples = [];
 
+  if (!operation.callbacks) {
+    return ret;
+  }
+
   // spreads the contents of the map for each callback so there's not nested arrays returned
   return ret.concat(
-    ...Object.keys(operation.callbacks || {}).map(identifier => {
-      const callback = operation.callbacks[identifier] as RMOAS.CallbackObject;
+    ...Object.keys(operation.callbacks).map(identifier => {
+      const callback = operation.callbacks![identifier] as RMOAS.CallbackObject;
 
       // spreads the contents again so there's not nested arrays returned
       return []

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

@@ -50,7 +50,7 @@ export function getMediaTypeExamples(
 
         let example = examples[key];
         if (example !== null && typeof example === 'object') {
-          if ('summary' in example) {
+          if ('summary' in example && example.summary) {
             summary = example.summary;
           }
 

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

@@ -1,5 +1,8 @@
 {
   "extends": "../../tsconfig.base.json",
   "include": ["./src/**/*"],
-  "exclude": ["dist"]
+  "exclude": ["dist"],
+  "compilerOptions": {
+    "strict": true
+  }
 }