fix(typescript): Signed JWT Header Parameters has alg as required and…

… b64 as never
panva · Nov 11, 2021 · 79cbd82 · 79cbd82
1 parent c7fabd0
commit 79cbd82
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 5 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -91,4 +91,5 @@ export type {
   ResolvedKey,
   CompactJWEHeaderParameters,
   CompactJWSHeaderParameters,
+  JWTHeaderParameters,
 } from './types.d'
diff --git a/src/jwt/sign.ts b/src/jwt/sign.ts
@@ -1,6 +1,6 @@
 import { CompactSign } from '../jws/compact/sign.js'
 import { JWTInvalid } from '../util/errors.js'
-import type { JWSHeaderParameters, KeyLike, SignOptions } from '../types.d'
+import type { JWTHeaderParameters, KeyLike, SignOptions } from '../types.d'
 import { encoder } from '../lib/buffer_utils.js'
 import { ProduceJWT } from './produce.js'
 
@@ -21,15 +21,15 @@ import { ProduceJWT } from './produce.js'
  * ```
  */
 export class SignJWT extends ProduceJWT {
-  private _protectedHeader!: JWSHeaderParameters
+  private _protectedHeader!: JWTHeaderParameters
 
   /**
    * Sets the JWS Protected Header on the SignJWT object.
    *
    * @param protectedHeader JWS Protected Header.
    * Must contain an "alg" (JWS Algorithm) property.
    */
-  setProtectedHeader(protectedHeader: JWSHeaderParameters) {
+  setProtectedHeader(protectedHeader: JWTHeaderParameters) {
     this._protectedHeader = protectedHeader
     return this
   }

diff --git a/src/jwt/verify.ts b/src/jwt/verify.ts
@@ -3,7 +3,7 @@ import type {
   KeyLike,
   VerifyOptions,
   JWTClaimVerificationOptions,
-  JWSHeaderParameters,
+  JWTHeaderParameters,
   GetKeyFunction,
   FlattenedJWSInput,
   JWTVerifyResult,
@@ -24,7 +24,7 @@ export interface JWTVerifyOptions extends VerifyOptions, JWTClaimVerificationOpt
  * See [createRemoteJWKSet](../functions/jwks_remote.createRemoteJWKSet.md#function-createremotejwkset)
  * to verify using a remote JSON Web Key Set.
  */
-export interface JWTVerifyGetKey extends GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput> {}
+export interface JWTVerifyGetKey extends GetKeyFunction<JWTHeaderParameters, FlattenedJWSInput> {}
 
 /**
  * Verifies the JWT format (to be a JWS Compact format), verifies the JWS signature, validates the JWT Claims Set.

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -729,6 +729,14 @@ export interface CompactJWSHeaderParameters extends JWSHeaderParameters {
   alg: string
 }
 
+/**
+ * Recognized Signed JWT Header Parameters, any other Header Members
+ * may also be present.
+ */
+export interface JWTHeaderParameters extends CompactJWSHeaderParameters {
+  b64: never
+}
+
 /**
  * Recognized Compact JWE Header Parameters, any other Header Members
  * may also be present.