docs: fix

Author: SSbit01

README.md

@@ -1,13 +1,24 @@
 # SingleCrypt Text
 
 > [!WARNING]  
-> This package uses [`Uint8Array.prototype.toBase64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/toBase64) and [`Uint8Array.fromBase64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/fromBase64), which, as of November 2025, are only supported by the latest versions of browsers, [Bun](https://bun.com/), [Deno 2.5 or later](https://deno.com/) and [Node.js 25 or later](https://nodejs.org/en). See [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/toBase64#browser_compatibility) for compatibility.
-
-A simple, secure, and fast symmetric encryption library that makes use of [AES-GCM](https://en.wikipedia.org/wiki/Galois/Counter_Mode) and modern platform features. It leverages the native [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API), so it works both in browsers (in secure contexts) and JavaScript runtimes.
+> This package uses
+> [`Uint8Array.prototype.toBase64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/toBase64)
+> and [`Uint8Array.fromBase64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/fromBase64),
+> which, as of November 2025, are only supported by the latest versions of browsers, [Bun](https://bun.com/),
+> [Deno 2.5 or later](https://deno.com/) and [Node.js 25 or later](https://nodejs.org/en).
+> See [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/toBase64#browser_compatibility)
+> for compatibility.
+
+A simple, secure, and fast symmetric encryption library that makes use of
+[AES-GCM](https://en.wikipedia.org/wiki/Galois/Counter_Mode) and modern platform features.
+It leverages the native [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API),
+so it works both in browsers (in secure contexts) and JavaScript runtimes.
 
 ## Why AES-GCM?
 
-AES-GCM is extremely fast on modern CPUs, which have dedicated hardware acceleration ([AES-NI](https://en.wikipedia.org/wiki/AES_instruction_set)), in addition to being highly secure and even quantum-resistant (AES-256-GCM).
+AES-GCM is extremely fast on modern CPUs,
+which have dedicated hardware acceleration ([AES-NI](https://en.wikipedia.org/wiki/AES_instruction_set)),
+in addition to being highly secure and even quantum-resistant (AES-256-GCM).
 
 ## Installation
 
@@ -179,11 +190,11 @@ new SingleCryptText(
 
 #### Instance methods
 
-- `async encrypt(text: string, urlSafe?: boolean): Promise<string>`
+- `async encrypt(text: string, urlSafe?: boolean, additionalData?: BufferSource): Promise<string>`
 
   Encrypt a string using the instance's key. Optionally specify `urlSafe` (`true` by default) to use `base64url` encoding.
 
-- `async decrypt(ciphertext: string): Promise<string>`
+- `async decrypt(ciphertext: string, additionalData?: BufferSource): Promise<string>`
 
   Decrypt a string previously encrypted by this or any compatible instance.
 
@@ -233,13 +244,15 @@ encryptTextSymmetrically(
   key: CryptoKey,
   text: string,
   urlSafe?: boolean,
-  textEncoder?: TextEncoder
+  textEncoder?: TextEncoder,
+  additionalData?: BufferSource
 ): Promise<string>
 ```
 - `key`: A symmetric key previously generated with `createSymmetricKeyFromText`.
 - `text`: String value to encrypt.
 - `urlSafe` (optional): Use `base64url` encoding if `true` (default: `true`). If `false`, uses regular `base64`.
 - `textEncoder` (optional): Optionally reuse your own `TextEncoder` instance.
+- `additionalData` (optional): Additional data for authentication. Defaults to `undefined`.
 
 Returns a `Promise<string>` containing the encrypted value as a Base64 string.
 
@@ -252,13 +265,15 @@ Returns a `Promise<string>` containing the encrypted value as a Base64 string.
 decryptTextSymmetrically(
   key: CryptoKey,
   ciphertext: string,
-  textDecoder?: TextDecoder
+  textDecoder?: TextDecoder,
+  additionalData?: BufferSource
 ): Promise<string>
 ```
 
 - `key`: A symmetric key previously generated with `createSymmetricKeyFromText`.
 - `ciphertext`: The string value to decrypt (encrypted with compatible methods/settings).
 - `textDecoder` (optional): Optionally reuse your own `TextDecoder` instance.
+- `additionalData` (optional): Additional data for authentication. Defaults to `undefined`.
 
 Returns a `Promise<string>` containing the decrypted value.
 

index.js

@@ -56,7 +56,7 @@ export async function createSymmetricKeyFromText(
  * @param {string} text - String value to be encrypted.
  * @param {boolean} [urlSafe] - The encrypted values default to `base64` alphabet; this property enables the `base64url` alphabet. Enabled by default.
  * @param {TextEncoder} [textEncoder] - If you have an instance of a `TextEncoder`, you can reuse it.
- * @param {BufferSource} [additionalData] - Additional data to be included in the encryption process (authentication tag).
+ * @param {BufferSource} [additionalData] - Additional data for authentication.
  * @returns {Promise<string>} The value encrypted and encoded as a Base64 string.
  * @throws {DOMException} Raised when:
  * - The provided key is not valid.
@@ -99,7 +99,7 @@ export async function encryptTextSymmetrically(
  * @param {CryptoKey} key - Symmetric key used to encrypt the value.
  * @param {string} ciphertext - Encrypted value to be decrypted.
  * @param {TextDecoder} [textDecoder] - If you have an instance of a `TextDecoder`, you can reuse it.
- * @param {BufferSource} [additionalData] - Additional data to be included in the encryption process (authentication tag).
+ * @param {BufferSource} [additionalData] - Additional data for authentication.
  * @returns {Promise<string>} The value decrypted.
  * @throws {TypeError} Thrown if `ciphertext` is not a string.
  * @throws {SyntaxError} Thrown if `ciphertext` contains characters outside Base64 alphabet.
@@ -211,7 +211,7 @@ export class SingleCryptText {
    * @async
    * @param {string} text - String value to be encrypted.
    * @param {boolean} [urlSafe] - The encrypted values default to `base64` alphabet; this property enables the `base64url` alphabet. Enabled by default.
-   * @param {BufferSource} [additionalData] - Additional data to be included in the encryption process (authentication tag).
+   * @param {BufferSource} [additionalData] - Additional data for authentication.
    * @returns {Promise<string>} The value encrypted and encoded as a Base64 string.
    * @throws {DOMException} Raised when:
    * - The provided key is not valid.
@@ -230,7 +230,7 @@ export class SingleCryptText {
   /**
    * @async
    * @param {string} ciphertext - Encrypted value to be decrypted.
-   * @param {BufferSource} [additionalData] - Additional data to be included in the encryption process (authentication tag).
+   * @param {BufferSource} [additionalData] - Additional data for authentication.
    * @returns {Promise<string>} The value decrypted.
    * @throws {TypeError} Thrown if `ciphertext` is not a string.
    * @throws {SyntaxError} Thrown if `ciphertext` contains characters outside Base64 alphabet.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "singlecrypt-text",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "author": "Stefan Samson <ss42701@outlook.com> (https://ssbit01.github.io/)",
   "repository": "github:SSbit01/singlecrypt-text",
   "main": "index.js",
@@ -47,7 +47,8 @@
     "test:random": "bun test --randomize",
     "build": "bun build ./index.js --minify --target browser --outdir ./dist --entry-naming [dir]/[name].min.[ext]",
     "build:cjs": "bun build ./index.js --minify --format cjs --outdir ./dist --entry-naming [dir]/[name].node.min.[ext]",
-    "build:types": "tsc"
+    "build:types": "tsc",
+    "docs": "typedoc"
   },
   "type": "module",
   "types": "index.d.ts",