gettyimages / gettyimages-api_nodejs

98%

main: 98%

LAST BUILD ON BRANCH feature/typescript-declarations

branch: feature/typescript-declarations

CHANGE BRANCH

x

Reset

• feature/typescript-declarations
• actions
• add-orientations-search-videos-creative
• allow-calls-with-api-key-only
• allow-custom-param-header
• allow-setting-token
• api-consistency
• code-samples
• dependabot/31
• dependabot/60
• dependabot/github_actions/dot-github/workflows/actions/download-artifact-4.1.7
• dependabot/npm_and_yarn/babel/traverse-7.23.2
• dependabot/npm_and_yarn/braces-3.0.3
• dependabot/npm_and_yarn/flatted-3.4.2
• dependabot/npm_and_yarn/got-and-ava--removed
• dependabot/npm_and_yarn/js-yaml-3.14.2
• dependabot/npm_and_yarn/json5-1.0.2
• dependabot/npm_and_yarn/lodash-4.17.23
• dependabot/npm_and_yarn/lodash-4.18.1
• dependabot/npm_and_yarn/minimatch-3.1.5
• dependabot/npm_and_yarn/picomatch-2.3.2
• dependabot/npm_and_yarn/word-wrap-1.2.4
• deprecate-eol-versions-of-node
• feature/add-search-video-editorial-filters
• fix-lint-errors
• fix/js-yaml-dependabot-61
• fix/npm-publish
• fix_token_exp
• handle-boolean-properties-correctly
• main
• node-10
• node10
• publish-only-one-version
• refs/heads/main
• refs/tags/5.1.0
• refs/tags/6.0.0
• refs/tags/6.0.1
• refs/tags/6.1.0
• refs/tags/6.1.1
• refs/tags/6.1.2
• refs/tags/6.2.0
• refs/tags/6.2.1
• refs/tags/6.2.2
• refs/tags/6.2.3
• refs/tags/6.3.0
• refs/tags/6.3.1
• refs/tags/6.4.0
• refs/tags/6.5.0
• refs/tags/6.5.1
• refs/tags/6.5.2
• refs/tags/6.5.3
• refs/tags/6.5.4
• refs/tags/6.5.5
• refs/tags/6.5.6
• refs/tags/6.5.7
• refs/tags/6.5.8
• refs/tags/6.6.0
• refs/tags/6.7.0
• review-tests
• update-auth-hostname
• update-code-samples
• update-dependencies
• update-packages
• upgrade-upload-artifact

Build # 32191505935

Build Type

Pull #84

github

Committed by mapitman

Commit Message

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

Pull Request Pull Request #84: Add TypeScript declarations for the existing public surface

Coverage Stats

94 of 115 branches covered (81.74%)

1029 of 1049 relevant lines covered (98.09%)

114.41 hits per line