jose 4.13.1 → 4.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/README.md +94 -88
  2. package/dist/browser/jws/general/sign.js +1 -1
  3. package/dist/browser/lib/jwt_claims_set.js +17 -6
  4. package/dist/node/cjs/jws/general/sign.js +1 -1
  5. package/dist/node/cjs/lib/jwt_claims_set.js +17 -6
  6. package/dist/node/esm/jws/general/sign.js +1 -1
  7. package/dist/node/esm/lib/jwt_claims_set.js +17 -6
  8. package/dist/types/jwe/compact/decrypt.d.ts +4 -14
  9. package/dist/types/jwe/compact/encrypt.d.ts +3 -13
  10. package/dist/types/jwe/flattened/decrypt.d.ts +4 -24
  11. package/dist/types/jwe/flattened/encrypt.d.ts +3 -14
  12. package/dist/types/jwe/general/decrypt.d.ts +4 -28
  13. package/dist/types/jwe/general/encrypt.d.ts +2 -16
  14. package/dist/types/jwk/embedded.d.ts +0 -14
  15. package/dist/types/jwk/thumbprint.d.ts +2 -30
  16. package/dist/types/jwks/local.d.ts +0 -59
  17. package/dist/types/jwks/remote.d.ts +5 -48
  18. package/dist/types/jws/compact/sign.d.ts +3 -13
  19. package/dist/types/jws/compact/verify.d.ts +5 -17
  20. package/dist/types/jws/flattened/sign.d.ts +3 -13
  21. package/dist/types/jws/flattened/verify.d.ts +5 -22
  22. package/dist/types/jws/general/sign.d.ts +3 -16
  23. package/dist/types/jws/general/verify.d.ts +5 -25
  24. package/dist/types/jwt/decrypt.d.ts +4 -18
  25. package/dist/types/jwt/encrypt.d.ts +12 -22
  26. package/dist/types/jwt/sign.d.ts +3 -93
  27. package/dist/types/jwt/unsecured.d.ts +0 -23
  28. package/dist/types/jwt/verify.d.ts +5 -84
  29. package/dist/types/key/export.d.ts +0 -26
  30. package/dist/types/key/generate_key_pair.d.ts +1 -9
  31. package/dist/types/key/generate_secret.d.ts +1 -8
  32. package/dist/types/key/import.d.ts +15 -80
  33. package/dist/types/types.d.ts +63 -95
  34. package/dist/types/util/decode_jwt.d.ts +0 -7
  35. package/dist/types/util/decode_protected_header.d.ts +0 -7
  36. package/dist/types/util/errors.d.ts +57 -14
  37. package/package.json +1 -1
@@ -1,5 +1,8 @@
1
1
  import type { KeyLike } from '../types';
2
- /** A generic Error subclass that all other specific JOSE Error subclasses inherit from. */
2
+ /**
3
+ * A generic Error that all other JOSE specific Error subclasses extend.
4
+ *
5
+ */
3
6
  export declare class JOSEError extends Error {
4
7
  /** A unique error code for the particular error subclass. */
5
8
  static get code(): string;
@@ -7,7 +10,10 @@ export declare class JOSEError extends Error {
7
10
  code: string;
8
11
  constructor(message?: string);
9
12
  }
10
- /** An error subclass thrown when a JWT Claim Set member validation fails. */
13
+ /**
14
+ * An error subclass thrown when a JWT Claim Set member validation fails.
15
+ *
16
+ */
11
17
  export declare class JWTClaimValidationFailed extends JOSEError {
12
18
  static get code(): 'ERR_JWT_CLAIM_VALIDATION_FAILED';
13
19
  code: string;
@@ -17,7 +23,10 @@ export declare class JWTClaimValidationFailed extends JOSEError {
17
23
  reason: string;
18
24
  constructor(message: string, claim?: string, reason?: string);
19
25
  }
20
- /** An error subclass thrown when a JWT is expired. */
26
+ /**
27
+ * An error subclass thrown when a JWT is expired.
28
+ *
29
+ */
21
30
  export declare class JWTExpired extends JOSEError implements JWTClaimValidationFailed {
22
31
  static get code(): 'ERR_JWT_EXPIRED';
23
32
  code: string;
@@ -27,7 +36,10 @@ export declare class JWTExpired extends JOSEError implements JWTClaimValidationF
27
36
  reason: string;
28
37
  constructor(message: string, claim?: string, reason?: string);
29
38
  }
30
- /** An error subclass thrown when a JOSE Algorithm is not allowed per developer preference. */
39
+ /**
40
+ * An error subclass thrown when a JOSE Algorithm is not allowed per developer preference.
41
+ *
42
+ */
31
43
  export declare class JOSEAlgNotAllowed extends JOSEError {
32
44
  static get code(): 'ERR_JOSE_ALG_NOT_ALLOWED';
33
45
  code: string;
@@ -35,49 +47,74 @@ export declare class JOSEAlgNotAllowed extends JOSEError {
35
47
  /**
36
48
  * An error subclass thrown when a particular feature or algorithm is not supported by this
37
49
  * implementation or JOSE in general.
50
+ *
38
51
  */
39
52
  export declare class JOSENotSupported extends JOSEError {
40
53
  static get code(): 'ERR_JOSE_NOT_SUPPORTED';
41
54
  code: string;
42
55
  }
43
- /** An error subclass thrown when a JWE ciphertext decryption fails. */
56
+ /**
57
+ * An error subclass thrown when a JWE ciphertext decryption fails.
58
+ *
59
+ */
44
60
  export declare class JWEDecryptionFailed extends JOSEError {
45
61
  static get code(): 'ERR_JWE_DECRYPTION_FAILED';
46
62
  code: string;
47
63
  message: string;
48
64
  }
49
- /** An error subclass thrown when a JWE is invalid. */
65
+ /**
66
+ * An error subclass thrown when a JWE is invalid.
67
+ *
68
+ */
50
69
  export declare class JWEInvalid extends JOSEError {
51
70
  static get code(): 'ERR_JWE_INVALID';
52
71
  code: string;
53
72
  }
54
- /** An error subclass thrown when a JWS is invalid. */
73
+ /**
74
+ * An error subclass thrown when a JWS is invalid.
75
+ *
76
+ */
55
77
  export declare class JWSInvalid extends JOSEError {
56
78
  static get code(): 'ERR_JWS_INVALID';
57
79
  code: string;
58
80
  }
59
- /** An error subclass thrown when a JWT is invalid. */
81
+ /**
82
+ * An error subclass thrown when a JWT is invalid.
83
+ *
84
+ */
60
85
  export declare class JWTInvalid extends JOSEError {
61
86
  static get code(): 'ERR_JWT_INVALID';
62
87
  code: string;
63
88
  }
64
- /** An error subclass thrown when a JWK is invalid. */
89
+ /**
90
+ * An error subclass thrown when a JWK is invalid.
91
+ *
92
+ */
65
93
  export declare class JWKInvalid extends JOSEError {
66
94
  static get code(): 'ERR_JWK_INVALID';
67
95
  code: string;
68
96
  }
69
- /** An error subclass thrown when a JWKS is invalid. */
97
+ /**
98
+ * An error subclass thrown when a JWKS is invalid.
99
+ *
100
+ */
70
101
  export declare class JWKSInvalid extends JOSEError {
71
102
  static get code(): 'ERR_JWKS_INVALID';
72
103
  code: string;
73
104
  }
74
- /** An error subclass thrown when no keys match from a JWKS. */
105
+ /**
106
+ * An error subclass thrown when no keys match from a JWKS.
107
+ *
108
+ */
75
109
  export declare class JWKSNoMatchingKey extends JOSEError {
76
110
  static get code(): 'ERR_JWKS_NO_MATCHING_KEY';
77
111
  code: string;
78
112
  message: string;
79
113
  }
80
- /** An error subclass thrown when multiple keys match from a JWKS. */
114
+ /**
115
+ * An error subclass thrown when multiple keys match from a JWKS.
116
+ *
117
+ */
81
118
  export declare class JWKSMultipleMatchingKeys extends JOSEError {
82
119
  /** @ignore */
83
120
  [Symbol.asyncIterator]: () => AsyncIterableIterator<KeyLike>;
@@ -85,13 +122,19 @@ export declare class JWKSMultipleMatchingKeys extends JOSEError {
85
122
  code: string;
86
123
  message: string;
87
124
  }
88
- /** Timeout was reached when retrieving the JWKS response. */
125
+ /**
126
+ * Timeout was reached when retrieving the JWKS response.
127
+ *
128
+ */
89
129
  export declare class JWKSTimeout extends JOSEError {
90
130
  static get code(): 'ERR_JWKS_TIMEOUT';
91
131
  code: string;
92
132
  message: string;
93
133
  }
94
- /** An error subclass thrown when JWS signature verification fails. */
134
+ /**
135
+ * An error subclass thrown when JWS signature verification fails.
136
+ *
137
+ */
95
138
  export declare class JWSSignatureVerificationFailed extends JOSEError {
96
139
  static get code(): 'ERR_JWS_SIGNATURE_VERIFICATION_FAILED';
97
140
  code: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jose",
3
- "version": "4.13.1",
3
+ "version": "4.14.0",
4
4
  "description": "'JSON Web Almost Everything' - JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other Web-interoperable runtimes",
5
5
  "keywords": [
6
6
  "browser",