fix(typescript): Compact JWS Header Parameters has alg as required

panva · Nov 11, 2021 · c7fabd0 · c7fabd0
1 parent 0fa87af
commit c7fabd0
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 4 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -90,4 +90,5 @@ export type {
   JWTDecryptResult,
   ResolvedKey,
   CompactJWEHeaderParameters,
+  CompactJWSHeaderParameters,
 } from './types.d'
diff --git a/src/jws/compact/sign.ts b/src/jws/compact/sign.ts
@@ -1,5 +1,5 @@
 import { FlattenedSign } from '../flattened/sign.js'
-import type { JWSHeaderParameters, KeyLike, SignOptions } from '../../types.d'
+import type { CompactJWSHeaderParameters, KeyLike, SignOptions } from '../../types.d'
 
 /**
  * The CompactSign class is a utility for creating Compact JWS strings.
@@ -32,7 +32,7 @@ export class CompactSign {
    *
    * @param protectedHeader JWS Protected Header.
    */
-  setProtectedHeader(protectedHeader: JWSHeaderParameters) {
+  setProtectedHeader(protectedHeader: CompactJWSHeaderParameters) {
     this._flattened.setProtectedHeader(protectedHeader)
     return this
   }

diff --git a/src/jws/compact/verify.ts b/src/jws/compact/verify.ts
@@ -5,7 +5,7 @@ import type {
   CompactVerifyResult,
   FlattenedJWSInput,
   GetKeyFunction,
-  JWSHeaderParameters,
+  CompactJWSHeaderParameters,
   KeyLike,
   VerifyOptions,
   ResolvedKey,
@@ -19,7 +19,7 @@ import type {
  * to verify using a remote JSON Web Key Set.
  */
 export interface CompactVerifyGetKey
-  extends GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput> {}
+  extends GetKeyFunction<CompactJWSHeaderParameters, FlattenedJWSInput> {}
 
 /**
  * Verifies the signature and format of and afterwards decodes the Compact JWS.

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -721,6 +721,14 @@ export interface ResolvedKey {
   key: KeyLike | Uint8Array
 }
 
+/**
+ * Recognized Compact JWS Header Parameters, any other Header Members
+ * may also be present.
+ */
+export interface CompactJWSHeaderParameters extends JWSHeaderParameters {
+  alg: string
+}
+
 /**
  * Recognized Compact JWE Header Parameters, any other Header Members
  * may also be present.