docs: add module tags to all entrypoints

TASK-FORCE-JERICHO · Feb 22, 2025 · a5687aa · a5687aa
1 parent af175ec
commit a5687aa
Show file tree

Hide file tree

Showing 59 changed files with 239 additions and 0 deletions.
diff --git a/docs/jwe/compact/decrypt/README.md b/docs/jwe/compact/decrypt/README.md
@@ -1,5 +1,7 @@
 # jwe/compact/decrypt
 
+Decrypting JSON Web Encryption (JWE) in Compact Serialization
+
 ## Index
 
 ### Interfaces

diff --git a/docs/jwe/compact/encrypt/README.md b/docs/jwe/compact/encrypt/README.md
@@ -1,5 +1,7 @@
 # jwe/compact/encrypt
 
+Encrypting JSON Web Encryption (JWE) in Compact Serialization
+
 ## Index
 
 ### Classes

diff --git a/docs/jwe/flattened/decrypt/README.md b/docs/jwe/flattened/decrypt/README.md
@@ -1,5 +1,7 @@
 # jwe/flattened/decrypt
 
+Decrypting JSON Web Encryption (JWE) in Flattened JSON Serialization
+
 ## Index
 
 ### Interfaces

diff --git a/docs/jwe/flattened/encrypt/README.md b/docs/jwe/flattened/encrypt/README.md
@@ -1,5 +1,7 @@
 # jwe/flattened/encrypt
 
+Encrypting JSON Web Encryption (JWE) in Flattened JSON Serialization
+
 ## Index
 
 ### Classes

diff --git a/docs/jwe/general/decrypt/README.md b/docs/jwe/general/decrypt/README.md
@@ -1,5 +1,7 @@
 # jwe/general/decrypt
 
+Decrypting JSON Web Encryption (JWE) in General JSON Serialization
+
 ## Index
 
 ### Interfaces

diff --git a/docs/jwe/general/encrypt/README.md b/docs/jwe/general/encrypt/README.md
@@ -1,5 +1,7 @@
 # jwe/general/encrypt
 
+Encrypting JSON Web Encryption (JWE) in General JSON Serialization
+
 ## Index
 
 ### Classes

diff --git a/docs/jwk/embedded/README.md b/docs/jwk/embedded/README.md
@@ -1,5 +1,7 @@
 # jwk/embedded
 
+Verification using a JWK Embedded in a JWS Header
+
 ## Index
 
 ### Functions

diff --git a/docs/jwk/thumbprint/README.md b/docs/jwk/thumbprint/README.md
@@ -1,5 +1,7 @@
 # jwk/thumbprint
 
+JSON Web Key Thumbprint and JSON Web Key Thumbprint URI
+
 ## Index
 
 ### Functions

diff --git a/docs/jwks/local/README.md b/docs/jwks/local/README.md
@@ -1,5 +1,7 @@
 # jwks/local
 
+Verification using a JSON Web Key Set (JWKS) available locally
+
 ## Index
 
 ### Functions

diff --git a/docs/jwks/remote/README.md b/docs/jwks/remote/README.md
@@ -1,5 +1,7 @@
 # jwks/remote
 
+Verification using a JSON Web Key Set (JWKS) available on an HTTP(S) URL
+
 ## Index
 
 ### Functions

diff --git a/docs/jws/compact/sign/README.md b/docs/jws/compact/sign/README.md
@@ -1,5 +1,7 @@
 # jws/compact/sign
 
+Signing JSON Web Signature (JWS) in Compact Serialization
+
 ## Index
 
 ### Classes

diff --git a/docs/jws/compact/verify/README.md b/docs/jws/compact/verify/README.md
@@ -1,5 +1,7 @@
 # jws/compact/verify
 
+Verifying JSON Web Signature (JWS) in Compact Serialization
+
 ## Index
 
 ### Interfaces

diff --git a/docs/jws/flattened/sign/README.md b/docs/jws/flattened/sign/README.md
@@ -1,5 +1,7 @@
 # jws/flattened/sign
 
+Signing JSON Web Signature (JWS) in Flattened JSON Serialization
+
 ## Index
 
 ### Classes

diff --git a/docs/jws/flattened/verify/README.md b/docs/jws/flattened/verify/README.md
@@ -1,5 +1,7 @@
 # jws/flattened/verify
 
+Verifying JSON Web Signature (JWS) in Flattened JSON Serialization
+
 ## Index
 
 ### Interfaces

diff --git a/docs/jws/general/sign/README.md b/docs/jws/general/sign/README.md
@@ -1,5 +1,7 @@
 # jws/general/sign
 
+Signing JSON Web Signature (JWS) in General JSON Serialization
+
 ## Index
 
 ### Classes

diff --git a/docs/jws/general/verify/README.md b/docs/jws/general/verify/README.md
@@ -1,5 +1,7 @@
 # jws/general/verify
 
+Verifying JSON Web Signature (JWS) in General JSON Serialization
+
 ## Index
 
 ### Interfaces

diff --git a/docs/jwt/decrypt/README.md b/docs/jwt/decrypt/README.md
@@ -1,5 +1,7 @@
 # jwt/decrypt
 
+JSON Web Token (JWT) Decryption (JWT is in JWE format)
+
 ## Index
 
 ### Interfaces

diff --git a/docs/jwt/encrypt/README.md b/docs/jwt/encrypt/README.md
@@ -1,5 +1,7 @@
 # jwt/encrypt
 
+JSON Web Token (JWT) Encryption (JWT is in JWE format)
+
 ## Index
 
 ### Classes

diff --git a/docs/jwt/sign/README.md b/docs/jwt/sign/README.md
@@ -1,5 +1,7 @@
 # jwt/sign
 
+JSON Web Token (JWT) Signing (JWT is in JWS format)
+
 ## Index
 
 ### Classes

diff --git a/docs/jwt/unsecured/README.md b/docs/jwt/unsecured/README.md
@@ -1,5 +1,7 @@
 # jwt/unsecured
 
+Unsecured (unsigned & unencrypted) JSON Web Tokens (JWT)
+
 ## Index
 
 ### Classes

diff --git a/docs/jwt/verify/README.md b/docs/jwt/verify/README.md
@@ -1,5 +1,7 @@
 # jwt/verify
 
+JSON Web Token (JWT) Verification (JWT is in JWS format)
+
 ## Index
 
 ### Interfaces

diff --git a/docs/key/export/README.md b/docs/key/export/README.md
@@ -1,5 +1,7 @@
 # key/export
 
+Cryptographic key export functions
+
 ## Index
 
 ### Functions

diff --git a/docs/key/generate_key_pair/README.md b/docs/key/generate_key_pair/README.md
@@ -1,5 +1,7 @@
 # key/generate\_key\_pair
 
+Asymmetric key generation
+
 ## Index
 
 ### Interfaces

diff --git a/docs/key/generate_secret/README.md b/docs/key/generate_secret/README.md
@@ -1,5 +1,7 @@
 # key/generate\_secret
 
+Symmetric key generation
+
 ## Index
 
 ### Interfaces

diff --git a/docs/key/import/README.md b/docs/key/import/README.md
@@ -1,5 +1,7 @@
 # key/import
 
+Cryptographic key import functions
+
 ## Index
 
 ### Interfaces

diff --git a/docs/util/base64url/README.md b/docs/util/base64url/README.md
@@ -1,5 +1,7 @@
 # util/base64url
 
+Base64URL encoding and decoding utilities
+
 ## Index
 
 ### Functions

diff --git a/docs/util/decode_jwt/README.md b/docs/util/decode_jwt/README.md
@@ -1,5 +1,7 @@
 # util/decode\_jwt
 
+JSON Web Token (JWT) Claims Set Decoding (no validation, no signature checking)
+
 ## Index
 
 ### Functions

diff --git a/docs/util/decode_protected_header/README.md b/docs/util/decode_protected_header/README.md
@@ -1,5 +1,7 @@
 # util/decode\_protected\_header
 
+JOSE Protected Header Decoding (JWE, JWS, all serialization syntaxes)
+
 ## Index
 
 ### Type Aliases

diff --git a/docs/util/errors/README.md b/docs/util/errors/README.md
@@ -1,5 +1,7 @@
 # util/errors
 
+JOSE module errors and error codes
+
 ## Index
 
 ### Classes

diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,10 @@
+/**
+ * JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other
+ * Web-interoperable runtimes
+ *
+ * @module jose
+ */
+
 export { compactDecrypt } from './jwe/compact/decrypt.js'
 export type { CompactDecryptGetKey } from './jwe/compact/decrypt.js'
 export { flattenedDecrypt } from './jwe/flattened/decrypt.js'

diff --git a/src/jwe/compact/decrypt.ts b/src/jwe/compact/decrypt.ts
@@ -1,3 +1,9 @@
+/**
+ * Decrypting JSON Web Encryption (JWE) in Compact Serialization
+ *
+ * @module
+ */
+
 import { flattenedDecrypt } from '../flattened/decrypt.js'
 import { JWEInvalid } from '../../util/errors.js'
 import { decoder } from '../../lib/buffer_utils.js'

diff --git a/src/jwe/compact/encrypt.ts b/src/jwe/compact/encrypt.ts
@@ -1,3 +1,9 @@
+/**
+ * Encrypting JSON Web Encryption (JWE) in Compact Serialization
+ *
+ * @module
+ */
+
 import type * as types from '../../types.d.ts'
 import { FlattenedEncrypt } from '../flattened/encrypt.js'
 

diff --git a/src/jwe/flattened/decrypt.ts b/src/jwe/flattened/decrypt.ts
@@ -1,3 +1,9 @@
+/**
+ * Decrypting JSON Web Encryption (JWE) in Flattened JSON Serialization
+ *
+ * @module
+ */
+
 import type * as types from '../../types.d.ts'
 import { decode as base64url } from '../../lib/base64url.js'
 import decrypt from '../../lib/decrypt.js'

diff --git a/src/jwe/flattened/encrypt.ts b/src/jwe/flattened/encrypt.ts
@@ -1,3 +1,9 @@
+/**
+ * Encrypting JSON Web Encryption (JWE) in Flattened JSON Serialization
+ *
+ * @module
+ */
+
 import { encode as base64url } from '../../lib/base64url.js'
 import { unprotected } from '../../lib/private_symbols.js'
 import encrypt from '../../lib/encrypt.js'

diff --git a/src/jwe/general/decrypt.ts b/src/jwe/general/decrypt.ts
@@ -1,3 +1,9 @@
+/**
+ * Decrypting JSON Web Encryption (JWE) in General JSON Serialization
+ *
+ * @module
+ */
+
 import { flattenedDecrypt } from '../flattened/decrypt.js'
 import { JWEDecryptionFailed, JWEInvalid } from '../../util/errors.js'
 import type * as types from '../../types.d.ts'

diff --git a/src/jwe/general/encrypt.ts b/src/jwe/general/encrypt.ts
@@ -1,3 +1,9 @@
+/**
+ * Encrypting JSON Web Encryption (JWE) in General JSON Serialization
+ *
+ * @module
+ */
+
 import type * as types from '../../types.d.ts'
 import { FlattenedEncrypt } from '../flattened/encrypt.js'
 import { unprotected } from '../../lib/private_symbols.js'

diff --git a/src/jwk/embedded.ts b/src/jwk/embedded.ts
@@ -1,3 +1,9 @@
+/**
+ * Verification using a JWK Embedded in a JWS Header
+ *
+ * @module
+ */
+
 import type * as types from '../types.d.ts'
 import { importJWK } from '../key/import.js'
 import isObject from '../lib/is_object.js'

diff --git a/src/jwk/thumbprint.ts b/src/jwk/thumbprint.ts
@@ -1,3 +1,9 @@
+/**
+ * JSON Web Key Thumbprint and JSON Web Key Thumbprint URI
+ *
+ * @module
+ */
+
 import digest from '../lib/digest.js'
 import { encode as base64url } from '../lib/base64url.js'
 

diff --git a/src/jwks/local.ts b/src/jwks/local.ts
@@ -1,3 +1,9 @@
+/**
+ * Verification using a JSON Web Key Set (JWKS) available locally
+ *
+ * @module
+ */
+
 import type * as types from '../types.d.ts'
 import { importJWK } from '../key/import.js'
 import {

diff --git a/src/jwks/remote.ts b/src/jwks/remote.ts
@@ -1,3 +1,9 @@
+/**
+ * Verification using a JSON Web Key Set (JWKS) available on an HTTP(S) URL
+ *
+ * @module
+ */
+
 import type * as types from '../types.d.ts'
 import { JOSEError, JWKSNoMatchingKey, JWKSTimeout } from '../util/errors.js'
 

diff --git a/src/jws/compact/sign.ts b/src/jws/compact/sign.ts
@@ -1,3 +1,9 @@
+/**
+ * Signing JSON Web Signature (JWS) in Compact Serialization
+ *
+ * @module
+ */
+
 import type * as types from '../../types.d.ts'
 import { FlattenedSign } from '../flattened/sign.js'
 

diff --git a/src/jws/compact/verify.ts b/src/jws/compact/verify.ts
@@ -1,3 +1,9 @@
+/**
+ * Verifying JSON Web Signature (JWS) in Compact Serialization
+ *
+ * @module
+ */
+
 import type * as types from '../../types.d.ts'
 import { flattenedVerify } from '../flattened/verify.js'
 import { JWSInvalid } from '../../util/errors.js'

diff --git a/src/jws/flattened/sign.ts b/src/jws/flattened/sign.ts
@@ -1,3 +1,9 @@
+/**
+ * Signing JSON Web Signature (JWS) in Flattened JSON Serialization
+ *
+ * @module
+ */
+
 import type * as types from '../../types.d.ts'
 import { encode as base64url } from '../../lib/base64url.js'
 import sign from '../../lib/sign.js'

diff --git a/src/jws/flattened/verify.ts b/src/jws/flattened/verify.ts
@@ -1,3 +1,9 @@
+/**
+ * Verifying JSON Web Signature (JWS) in Flattened JSON Serialization
+ *
+ * @module
+ */
+
 import type * as types from '../../types.d.ts'
 import { decode as base64url } from '../../lib/base64url.js'
 import verify from '../../lib/verify.js'

diff --git a/src/jws/general/sign.ts b/src/jws/general/sign.ts
@@ -1,3 +1,9 @@
+/**
+ * Signing JSON Web Signature (JWS) in General JSON Serialization
+ *
+ * @module
+ */
+
 import type * as types from '../../types.d.ts'
 import { FlattenedSign } from '../flattened/sign.js'
 import { JWSInvalid } from '../../util/errors.js'