jose 4.14.1 → 4.14.2
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.
- package/README.md +3 -3
- package/dist/types/types.d.ts +9 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -47,7 +47,7 @@ The `jose` module supports encrypted JSON Web Tokens and provides functionality
|
|
|
47
47
|
|
|
48
48
|
### Key Utilities
|
|
49
49
|
|
|
50
|
-
The `jose` module
|
|
50
|
+
The `jose` module supports importing, exporting, and generating keys and secrets in various formats, including PEM formats like SPKI, X.509 certificate, and PKCS #8, as well as JSON Web Key (JWK).
|
|
51
51
|
|
|
52
52
|
- Key Import Functions
|
|
53
53
|
- [JWK Import](docs/functions/key_import.importJWK.md)
|
|
@@ -64,7 +64,7 @@ The `jose` module provides functionality for importing, exporting, and generatin
|
|
|
64
64
|
|
|
65
65
|
### JSON Web Signature (JWS)
|
|
66
66
|
|
|
67
|
-
The `jose`
|
|
67
|
+
The `jose` module supports signing and verification of JWS messages with arbitrary payloads in Compact, Flattened JSON, and General JSON serialization syntaxes.
|
|
68
68
|
|
|
69
69
|
- Signing - [Compact](docs/classes/jws_compact_sign.CompactSign.md), [Flattened JSON](docs/classes/jws_flattened_sign.FlattenedSign.md), [General JSON](docs/classes/jws_general_sign.GeneralSign.md)
|
|
70
70
|
- Verification - [Compact](docs/functions/jws_compact_verify.compactVerify.md), [Flattened JSON](docs/functions/jws_flattened_verify.flattenedVerify.md), [General JSON](docs/functions/jws_general_verify.generalVerify.md)
|
|
@@ -75,7 +75,7 @@ The `jose` modules supports signing and verification of JWS messages with arbitr
|
|
|
75
75
|
|
|
76
76
|
### JSON Web Encryption (JWE)
|
|
77
77
|
|
|
78
|
-
The `jose`
|
|
78
|
+
The `jose` module supports encryption and decryption of JWE messages with arbitrary plaintext in Compact, Flattened JSON, and General JSON serialization syntaxes.
|
|
79
79
|
|
|
80
80
|
- Encryption - [Compact](docs/classes/jwe_compact_encrypt.CompactEncrypt.md), [Flattened JSON](docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md), [General JSON](docs/classes/jwe_general_encrypt.GeneralEncrypt.md)
|
|
81
81
|
- Decryption - [Compact](docs/functions/jwe_compact_decrypt.compactDecrypt.md), [Flattened JSON](docs/functions/jwe_flattened_decrypt.flattenedDecrypt.md), [General JSON](docs/functions/jwe_general_decrypt.generalDecrypt.md)
|
package/dist/types/types.d.ts
CHANGED
|
@@ -29,6 +29,11 @@
|
|
|
29
29
|
*/
|
|
30
30
|
export type KeyLike = { type: string }
|
|
31
31
|
|
|
32
|
+
type JsonObject = { [Key in string]?: JsonValue }
|
|
33
|
+
type JsonArray = JsonValue[]
|
|
34
|
+
type JsonPrimitive = string | number | boolean | null
|
|
35
|
+
type JsonValue = JsonPrimitive | JsonObject | JsonArray
|
|
36
|
+
|
|
32
37
|
/**
|
|
33
38
|
* JSON Web Key ({@link https://www.rfc-editor.org/rfc/rfc7517 JWK}). "RSA", "EC", "OKP", and "oct"
|
|
34
39
|
* key types are supported.
|
|
@@ -72,7 +77,7 @@ export interface JWK {
|
|
|
72
77
|
/** JWK "x5u" (X.509 URL) Parameter. */
|
|
73
78
|
x5u?: string
|
|
74
79
|
|
|
75
|
-
[propName: string]:
|
|
80
|
+
[propName: string]: JsonValue | undefined
|
|
76
81
|
}
|
|
77
82
|
|
|
78
83
|
/**
|
|
@@ -196,7 +201,7 @@ export interface JWSHeaderParameters extends JoseHeaderParameters {
|
|
|
196
201
|
crit?: string[]
|
|
197
202
|
|
|
198
203
|
/** Any other JWS Header member. */
|
|
199
|
-
[propName: string]:
|
|
204
|
+
[propName: string]: JsonValue | undefined
|
|
200
205
|
}
|
|
201
206
|
|
|
202
207
|
/** Recognized JWE Key Management-related Header Parameters. */
|
|
@@ -304,7 +309,7 @@ export interface JWEHeaderParameters extends JoseHeaderParameters {
|
|
|
304
309
|
zip?: string
|
|
305
310
|
|
|
306
311
|
/** Any other JWE Header member. */
|
|
307
|
-
[propName: string]:
|
|
312
|
+
[propName: string]: JsonValue | undefined
|
|
308
313
|
}
|
|
309
314
|
|
|
310
315
|
/** Shared Interface with a "crit" property for all sign, verify, encrypt and decrypt operations. */
|
|
@@ -478,7 +483,7 @@ export interface JWTPayload {
|
|
|
478
483
|
iat?: number
|
|
479
484
|
|
|
480
485
|
/** Any other JWT Claim Set member. */
|
|
481
|
-
[propName: string]:
|
|
486
|
+
[propName: string]: JsonValue | undefined
|
|
482
487
|
}
|
|
483
488
|
|
|
484
489
|
/**
|
package/package.json
CHANGED