fix: openapi3spec update get schema objects

[tom-arnold]

When using the jest-openapi package in on of our projects, our build is failing with the following message when running tsc:

  Type '() => { [key: string]: ReferenceObject | SchemaObject; } | undefined' is not assignable to type '() => Record<string, Schema>'.
    Type '{ [key: string]: ReferenceObject | SchemaObject; } | undefined' is not assignable to type 'Record<string, Schema>'.
      Type 'undefined' is not assignable to type 'Record<string, Schema>'. 

After reviewing the current code, it looks like the issue lies in the OpenApi3Spec.d.ts file, specifically that the current implementation of getSchemaObjects() is using the wrong type. By making this change, I was able to successfully complete our build.

System: Kali-linux WSL2
typescript: v 4.4.3
node: v 14.17.2

[codecov]

Codecov Report

Merging #248 (4342385) into master (15ddc61) will not change coverage.
The diff coverage is 100.00%.

❗ Current head 4342385 differs from pull request most recent head 962e80a. Consider uploading reports for the commit 962e80a to get more accurate results

@@            Coverage Diff            @@
##            master      #248   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           17        17           
  Lines          421       421           
  Branches        58        60    +2     
=========================================
  Hits           421       421           

Impacted Files	Coverage Δ
...ages/openapi-validator/lib/classes/OpenApi3Spec.ts	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 15ddc61...962e80a. Read the comment docs.

[rwalle61]

Thanks @tom-arnold for raising this and submitting a fix! 🙂

I can't reproduce the error. Does this error come from jestOpenAPI(spec) or toSatisfySchemaInApiSpec(foo)? Would you mind showing how you're triggering this error and your full stack trace? Also your tsconfig and OpenAPI doc version please.

For fastest resolution, please recreate this in our recreation template.

I ask because I'm not sure how your change fixes the error. I assume you want '{ [key: string]: ReferenceObject | SchemaObject; } | undefined' to change to '{ [key: string]: ReferenceObject | SchemaObject; }'.

But given OpenAPIV3.ComponentsObject has type:

interface ComponentsObject {
        schemas?: {
            [key: string]: ReferenceObject | SchemaObject;
        };

OpenAPIV3.ComponentsObject['schemas'] is { [key: string]: ReferenceObject | SchemaObject; } | undefined,

whereas Pick<OpenAPIV3.ComponentsObject, 'schemas'> is

{
        schemas?: {
            [key: string]: ReferenceObject | SchemaObject;
        };
}

which does not match the actual value this.getComponentDefinitions().schemas. This seems wrong to me, so I wonder if it fixes your error by breaking something, so TypeScript accepts any.

[rwalle61]

@tom-arnold I saw this error when I enabled TypeScript's strict mode, so I wonder if it will be fixed by https://github.com/openapi-library/OpenAPIValidators/pull/254/files#diff-f24b64aecef0d95e0a629f3f7ba7ea12fd4f2ef959ec61b82448a54fe309bbe2R15.

It'd be great to know exactly what error you're seeing:

• does this error come from jestOpenAPI(spec) or toSatisfySchemaInApiSpec(foo)?
• What exactly triggers this error?
• What's your full stack trace?
• What's your full tsconfig?
• What OpenAPI doc version are you using?

[rwalle61]

Thanks, I accidentally didn't include axios in openapi-validator's package.json 🙂 I guess it doesn't break anything because we use it only for types.

Since we only use it for types, it should be in devDependencies. Same for @types/request.

Also axios already has the types, so @types/axios is deprecated.

[tom-arnold]

Good point, @types/axios is not necessary as it is depreciated. However, it does start to break things upstream when trying to convert typescript to javascript using tsc. The error message I get without axios is the following:

node_modules/openapi-validator/dist/classes/AxiosResponse.d.ts:1:57 - error TS2307: Cannot find module 'axios' or its corresponding type declarations.

1 import type { AxiosResponse as AxiosResponseType } from 'axios';

As for @types/request, I will have to look into that.

[rwalle61]

Yep we'll get that error if we don't have axios, because the types are from axios. We shouldn't need @types/axios though.

I'm quite curious as to why this error triggers when you run tsc, so it'd be great to know exactly how the error is triggered (#248 (comment))