gettyimages / gettyimages-api_nodejs / 32191505935

98%

main: 98%

Pull #84

github

Add TypeScript declarations for the existing public surface

Declare the client, the fourteen request classes, and their fluent builders in
a single root gettyimages-api.d.ts, and point the "types" field at it. This
covers only what the SDK supports today: no response models, no new operations,
and no literal-union enums for values the SDK never enumerates.

No runtime code changes, so JavaScript consumers are unaffected. The risk that
does exist is a declaration too strict for a call the SDK already accepts,
which would break TypeScript consumers at compile time. Three cases drove the
signatures:

- Builders named in the singular, such as withCollectionCode, are called with
  arrays throughout the tests, so they accept a value or an array.
- Identifier builders, such as withKeywordId, are called with numbers as well
  as strings.
- execute() returns Promise<any>, because Promise<unknown> would force every
  existing consumer to cast before reading a response field.

types-test.ts exercises every builder in the argument forms the AVA tests and
the README use. It runs under "npm run test:types" and in CI, so an over-strict
signature fails the build rather than reaching consumers.

Closes #56

94 of 115 branches covered (81.74%)

1029 of 1049 relevant lines covered (98.09%)

114.41 hits per line