Microsoft/TypeScript

Incorrect type declaration for CryptoKeyPair

Open

#46,036 opened on Sep 23, 2021

View on GitHub
 (5 comments) (1 reaction) (0 assignees)TypeScript (6,726 forks)batch import
BugDomain: lib.d.tsHelp Wanted

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

Bug Report

🔎 Search Terms

WebCrypto, CryptoKeyPair

🕗 Version & Regression Information

  • This changed between versions 4.3 and 4.4

Description

Here is W3C spec for CryptoKeyPair dictionary.

In TS v4.4.3 type declaration for CryptoKeyPair is:

interface CryptoKeyPair {
    privateKey?: CryptoKey;
    publicKey?: CryptoKey;
}

In TS v.4.3.5:

interface CryptoKeyPair {
    privateKey: CryptoKey;
    publicKey: CryptoKey;
}

Contributor guide

Research direction
Compare the current type declaration against the W3C WebCrypto spec to confirm that privateKey and publicKey should be required (not optional) and update the interface accordingly.
Tech stack
typescript
Domain
security
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80