feat: add subpath module exports

panva · Aug 26, 2024 · 72ecff6 · 72ecff6
1 parent c502731
commit 72ecff6
Show file tree

Hide file tree

Showing 62 changed files with 472 additions and 4 deletions.
diff --git a/docs/classes/jwe_compact_encrypt.CompactEncrypt.md b/docs/classes/jwe_compact_encrypt.CompactEncrypt.md
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
 
 The CompactEncrypt class is used to build and encrypt Compact JWE strings.
 
+This class is exported (as a named export) from the main `'jose'` module entry point as well as
+from its subpath export `'jose/jwe/compact/encrypt'`.
+
 **`Example`**
 
 ```js

diff --git a/docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md b/docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
 
 The FlattenedEncrypt class is used to build and encrypt Flattened JWE objects.
 
+This class is exported (as a named export) from the main `'jose'` module entry point as well as
+from its subpath export `'jose/jwe/flattened/encrypt'`.
+
 **`Example`**
 
 ```js

diff --git a/docs/classes/jwe_general_encrypt.GeneralEncrypt.md b/docs/classes/jwe_general_encrypt.GeneralEncrypt.md
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
 
 The GeneralEncrypt class is used to build and encrypt General JWE objects.
 
+This class is exported (as a named export) from the main `'jose'` module entry point as well as
+from its subpath export `'jose/jwe/general/encrypt'`.
+
 **`Example`**
 
 ```js

diff --git a/docs/classes/jws_compact_sign.CompactSign.md b/docs/classes/jws_compact_sign.CompactSign.md
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
 
 The CompactSign class is used to build and sign Compact JWS strings.
 
+This class is exported (as a named export) from the main `'jose'` module entry point as well as
+from its subpath export `'jose/jws/compact/sign'`.
+
 **`Example`**
 
 ```js

diff --git a/docs/classes/jws_flattened_sign.FlattenedSign.md b/docs/classes/jws_flattened_sign.FlattenedSign.md
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
 
 The FlattenedSign class is used to build and sign Flattened JWS objects.
 
+This class is exported (as a named export) from the main `'jose'` module entry point as well as
+from its subpath export `'jose/jws/flattened/sign'`.
+
 **`Example`**
 
 ```js

diff --git a/docs/classes/jws_general_sign.GeneralSign.md b/docs/classes/jws_general_sign.GeneralSign.md
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
 
 The GeneralSign class is used to build and sign General JWS objects.
 
+This class is exported (as a named export) from the main `'jose'` module entry point as well as
+from its subpath export `'jose/jws/general/sign'`.
+
 **`Example`**
 
 ```js

diff --git a/docs/classes/jwt_encrypt.EncryptJWT.md b/docs/classes/jwt_encrypt.EncryptJWT.md
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
 
 The EncryptJWT class is used to build and encrypt Compact JWE formatted JSON Web Tokens.
 
+This class is exported (as a named export) from the main `'jose'` module entry point as well as
+from its subpath export `'jose/jwt/encrypt'`.
+
 **`Example`**
 
 ```js

diff --git a/docs/classes/jwt_sign.SignJWT.md b/docs/classes/jwt_sign.SignJWT.md
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
 
 The SignJWT class is used to build and sign Compact JWS formatted JSON Web Tokens.
 
+This class is exported (as a named export) from the main `'jose'` module entry point as well as
+from its subpath export `'jose/jwt/sign'`.
+
 **`Example`**
 
 Usage with a symmetric secret

diff --git a/docs/classes/jwt_unsecured.UnsecuredJWT.md b/docs/classes/jwt_unsecured.UnsecuredJWT.md
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
 
 The UnsecuredJWT class is a utility for dealing with `{ "alg": "none" }` Unsecured JWTs.
 
+This class is exported (as a named export) from the main `'jose'` module entry point as well as
+from its subpath export `'jose/jwt/unsecured'`.
+
 **`Example`**
 
 Encoding

diff --git a/docs/functions/jwe_compact_decrypt.compactDecrypt.md b/docs/functions/jwe_compact_decrypt.compactDecrypt.md
@@ -10,6 +10,9 @@ Support from the community to continue maintaining and improving this module is
 
 Decrypts a Compact JWE.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jwe/compact/decrypt'`.
+
 #### Parameters
 
 | Name | Type | Description |

diff --git a/docs/functions/jwe_flattened_decrypt.flattenedDecrypt.md b/docs/functions/jwe_flattened_decrypt.flattenedDecrypt.md
@@ -10,6 +10,9 @@ Support from the community to continue maintaining and improving this module is
 
 Decrypts a Flattened JWE.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jwe/flattened/decrypt'`.
+
 #### Parameters
 
 | Name | Type | Description |

diff --git a/docs/functions/jwe_general_decrypt.generalDecrypt.md b/docs/functions/jwe_general_decrypt.generalDecrypt.md
@@ -10,6 +10,9 @@ Support from the community to continue maintaining and improving this module is
 
 Decrypts a General JWE.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jwe/general/decrypt'`.
+
 #### Parameters
 
 | Name | Type | Description |

diff --git a/docs/functions/jwk_embedded.EmbeddedJWK.md b/docs/functions/jwk_embedded.EmbeddedJWK.md
@@ -13,6 +13,9 @@ operations whenever you need to opt-in to verify signatures with a public key em
 token's "jwk" (JSON Web Key) Header Parameter. It is recommended to combine this with the verify
 function's `algorithms` option to define accepted JWS "alg" (Algorithm) Header Parameter values.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jwk/embedded'`.
+
 #### Type parameters
 
 | Name | Type |

diff --git a/docs/functions/jwk_thumbprint.calculateJwkThumbprint.md b/docs/functions/jwk_thumbprint.calculateJwkThumbprint.md
@@ -10,6 +10,9 @@ Support from the community to continue maintaining and improving this module is
 
 Calculates a base64url-encoded JSON Web Key (JWK) Thumbprint
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jwk/thumbprint'`.
+
 #### Parameters
 
 | Name | Type | Description |

diff --git a/docs/functions/jwk_thumbprint.calculateJwkThumbprintUri.md b/docs/functions/jwk_thumbprint.calculateJwkThumbprintUri.md
@@ -10,6 +10,9 @@ Support from the community to continue maintaining and improving this module is
 
 Calculates a JSON Web Key (JWK) Thumbprint URI
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jwk/thumbprint'`.
+
 #### Parameters
 
 | Name | Type | Description |

diff --git a/docs/functions/jwks_local.createLocalJWKSet.md b/docs/functions/jwks_local.createLocalJWKSet.md
@@ -23,6 +23,9 @@ verification in an iterative manner.
 Note: The function's purpose is to resolve public keys used for verifying signatures and will not
 work for public encryption keys.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jwks/local'`.
+
 #### Type parameters
 
 | Name | Type |

diff --git a/docs/functions/jwks_remote.createRemoteJWKSet.md b/docs/functions/jwks_remote.createRemoteJWKSet.md
@@ -25,6 +25,9 @@ verification in an iterative manner.
 Note: The function's purpose is to resolve public keys used for verifying signatures and will not
 work for public encryption keys.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jwks/remote'`.
+
 #### Type parameters
 
 | Name | Type |

diff --git a/docs/functions/jws_compact_verify.compactVerify.md b/docs/functions/jws_compact_verify.compactVerify.md
@@ -10,6 +10,9 @@ Support from the community to continue maintaining and improving this module is
 
 Verifies the signature and format of and afterwards decodes the Compact JWS.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jws/compact/verify'`.
+
 #### Parameters
 
 | Name | Type | Description |

diff --git a/docs/functions/jws_flattened_verify.flattenedVerify.md b/docs/functions/jws_flattened_verify.flattenedVerify.md
@@ -10,6 +10,9 @@ Support from the community to continue maintaining and improving this module is
 
 Verifies the signature and format of and afterwards decodes the Flattened JWS.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jws/flattened/verify'`.
+
 #### Parameters
 
 | Name | Type | Description |

diff --git a/docs/functions/jws_general_verify.generalVerify.md b/docs/functions/jws_general_verify.generalVerify.md
@@ -10,6 +10,9 @@ Support from the community to continue maintaining and improving this module is
 
 Verifies the signature and format of and afterwards decodes the General JWS.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jws/general/verify'`.
+
 #### Parameters
 
 | Name | Type | Description |

diff --git a/docs/functions/jwt_decrypt.jwtDecrypt.md b/docs/functions/jwt_decrypt.jwtDecrypt.md
@@ -11,6 +11,9 @@ Support from the community to continue maintaining and improving this module is
 Verifies the JWT format (to be a JWE Compact format), decrypts the ciphertext, validates the JWT
 Claims Set.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jwt/decrypt'`.
+
 #### Type parameters
 
 | Name | Type |

diff --git a/docs/functions/jwt_verify.jwtVerify.md b/docs/functions/jwt_verify.jwtVerify.md
@@ -11,6 +11,9 @@ Support from the community to continue maintaining and improving this module is
 Verifies the JWT format (to be a JWS Compact format), verifies the JWS signature, validates the
 JWT Claims Set.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jwt/verify'`.
+
 #### Type parameters
 
 | Name | Type |

diff --git a/docs/functions/key_export.exportJWK.md b/docs/functions/key_export.exportJWK.md
@@ -10,6 +10,9 @@ Support from the community to continue maintaining and improving this module is
 
 Exports a runtime-specific key representation (KeyLike) to a JWK.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/key/export'`.
+
 #### Parameters
 
 | Name | Type | Description |

diff --git a/docs/functions/key_export.exportPKCS8.md b/docs/functions/key_export.exportPKCS8.md
@@ -11,6 +11,9 @@ Support from the community to continue maintaining and improving this module is
 Exports a runtime-specific private key representation (KeyObject or CryptoKey) to a PEM-encoded
 PKCS8 string format.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/key/export'`.
+
 #### Parameters
 
 | Name | Type | Description |

diff --git a/docs/functions/key_export.exportSPKI.md b/docs/functions/key_export.exportSPKI.md
@@ -11,6 +11,9 @@ Support from the community to continue maintaining and improving this module is
 Exports a runtime-specific public key representation (KeyObject or CryptoKey) to a PEM-encoded
 SPKI string format.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/key/export'`.
+
 #### Parameters
 
 | Name | Type | Description |

diff --git a/docs/functions/key_generate_key_pair.generateKeyPair.md b/docs/functions/key_generate_key_pair.generateKeyPair.md
@@ -15,6 +15,9 @@ Note: Under Web Crypto API runtime the `privateKey` is generated with `extractab
 `false` by default. See [GenerateKeyPairOptions.extractable](../interfaces/key_generate_key_pair.GenerateKeyPairOptions.md#extractable) to generate an extractable
 `privateKey`.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/generate/keypair'`.
+
 #### Type parameters
 
 | Name | Type |

diff --git a/docs/functions/key_generate_secret.generateSecret.md b/docs/functions/key_generate_secret.generateSecret.md
@@ -13,6 +13,9 @@ Generates a symmetric secret key for a given JWA algorithm identifier.
 Note: Under Web Crypto API runtime the secret key is generated with `extractable` set to `false`
 by default.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/generate/secret'`.
+
 #### Type parameters
 
 | Name | Type |

diff --git a/docs/functions/key_import.importJWK.md b/docs/functions/key_import.importJWK.md
@@ -14,6 +14,9 @@ Imports a JWK to a runtime-specific key representation (KeyLike). Either the JWK
 Note: When the runtime is using [Web Cryptography API](https://w3c.github.io/webcrypto/) the
 jwk parameters "use", "key_ops", and "ext" are also used in the resulting `CryptoKey`.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/key/import'`.
+
 #### Type parameters
 
 | Name | Type |

diff --git a/docs/functions/key_import.importPKCS8.md b/docs/functions/key_import.importPKCS8.md
@@ -15,6 +15,9 @@ Note: The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in
 [Web Cryptography API](https://w3c.github.io/webcrypto/), use the OID rsaEncryption
 (1.2.840.113549.1.1.1) instead for all RSA algorithms.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/key/import'`.
+
 #### Type parameters
 
 | Name | Type |

diff --git a/docs/functions/key_import.importSPKI.md b/docs/functions/key_import.importSPKI.md
@@ -15,6 +15,9 @@ Note: The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in
 [Web Cryptography API](https://w3c.github.io/webcrypto/), use the OID rsaEncryption
 (1.2.840.113549.1.1.1) instead for all RSA algorithms.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/key/import'`.
+
 #### Type parameters
 
 | Name | Type |

diff --git a/docs/functions/key_import.importX509.md b/docs/functions/key_import.importX509.md
@@ -15,6 +15,9 @@ Note: The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in
 [Web Cryptography API](https://w3c.github.io/webcrypto/), use the OID rsaEncryption
 (1.2.840.113549.1.1.1) instead for all RSA algorithms.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/key/import'`.
+
 #### Type parameters
 
 | Name | Type |

diff --git a/docs/functions/util_decode_jwt.decodeJwt.md b/docs/functions/util_decode_jwt.decodeJwt.md
@@ -13,6 +13,9 @@ values. This does not validate the JWS Signature. For a proper Signed JWT Claims
 and JWS signature verification use `jose.jwtVerify()`. For an encrypted JWT Claims Set validation
 and JWE decryption use `jose.jwtDecrypt()`.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/jwt/decode'`.
+
 #### Type parameters
 
 | Name | Type |

diff --git a/docs/functions/util_decode_protected_header.decodeProtectedHeader.md b/docs/functions/util_decode_protected_header.decodeProtectedHeader.md
@@ -10,6 +10,9 @@ Support from the community to continue maintaining and improving this module is
 
 Decodes the Protected Header of a JWE/JWS/JWT token utilizing any JOSE serialization.
 
+This function is exported (as a named export) from the main `'jose'` module entry point as well
+as from its subpath export `'jose/decode/protected_header'`.
+
 #### Parameters
 
 | Name | Type | Description |