cipher-kit 2.0.0 → 2.1.0

package/dist/node.cjs

@@ -1,129 +1,129 @@
 'use strict';
 
-var chunkN2EW2FDZ_cjs = require('./chunk-N2EW2FDZ.cjs');
-var chunk3UX5MZ2P_cjs = require('./chunk-3UX5MZ2P.cjs');
+var chunkHMTHK2IY_cjs = require('./chunk-HMTHK2IY.cjs');
+var chunkBHG5RSUV_cjs = require('./chunk-BHG5RSUV.cjs');
 
 
 
 Object.defineProperty(exports, "convertBytesToStr", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.convertBytesToStr; }
+  get: function () { return chunkHMTHK2IY_cjs.convertBytesToStr; }
 });
 Object.defineProperty(exports, "convertEncoding", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.convertEncoding; }
+  get: function () { return chunkHMTHK2IY_cjs.convertEncoding; }
 });
 Object.defineProperty(exports, "convertStrToBytes", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.convertStrToBytes; }
+  get: function () { return chunkHMTHK2IY_cjs.convertStrToBytes; }
 });
 Object.defineProperty(exports, "createSecretKey", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.createSecretKey; }
+  get: function () { return chunkHMTHK2IY_cjs.createSecretKey; }
 });
 Object.defineProperty(exports, "decrypt", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.decrypt; }
+  get: function () { return chunkHMTHK2IY_cjs.decrypt; }
 });
 Object.defineProperty(exports, "decryptObj", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.decryptObj; }
+  get: function () { return chunkHMTHK2IY_cjs.decryptObj; }
 });
 Object.defineProperty(exports, "encrypt", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.encrypt; }
+  get: function () { return chunkHMTHK2IY_cjs.encrypt; }
 });
 Object.defineProperty(exports, "encryptObj", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.encryptObj; }
+  get: function () { return chunkHMTHK2IY_cjs.encryptObj; }
 });
 Object.defineProperty(exports, "generateUuid", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.generateUuid; }
+  get: function () { return chunkHMTHK2IY_cjs.generateUuid; }
 });
 Object.defineProperty(exports, "hash", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.hash; }
+  get: function () { return chunkHMTHK2IY_cjs.hash; }
 });
 Object.defineProperty(exports, "hashPassword", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.hashPassword; }
+  get: function () { return chunkHMTHK2IY_cjs.hashPassword; }
 });
 Object.defineProperty(exports, "isNodeSecretKey", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.isNodeSecretKey; }
+  get: function () { return chunkHMTHK2IY_cjs.isNodeSecretKey; }
 });
 Object.defineProperty(exports, "tryConvertBytesToStr", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.tryConvertBytesToStr; }
+  get: function () { return chunkHMTHK2IY_cjs.tryConvertBytesToStr; }
 });
 Object.defineProperty(exports, "tryConvertEncoding", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.tryConvertEncoding; }
+  get: function () { return chunkHMTHK2IY_cjs.tryConvertEncoding; }
 });
 Object.defineProperty(exports, "tryConvertStrToBytes", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.tryConvertStrToBytes; }
+  get: function () { return chunkHMTHK2IY_cjs.tryConvertStrToBytes; }
 });
 Object.defineProperty(exports, "tryCreateSecretKey", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.tryCreateSecretKey; }
+  get: function () { return chunkHMTHK2IY_cjs.tryCreateSecretKey; }
 });
 Object.defineProperty(exports, "tryDecrypt", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.tryDecrypt; }
+  get: function () { return chunkHMTHK2IY_cjs.tryDecrypt; }
 });
 Object.defineProperty(exports, "tryDecryptObj", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.tryDecryptObj; }
+  get: function () { return chunkHMTHK2IY_cjs.tryDecryptObj; }
 });
 Object.defineProperty(exports, "tryEncrypt", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.tryEncrypt; }
+  get: function () { return chunkHMTHK2IY_cjs.tryEncrypt; }
 });
 Object.defineProperty(exports, "tryEncryptObj", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.tryEncryptObj; }
+  get: function () { return chunkHMTHK2IY_cjs.tryEncryptObj; }
 });
 Object.defineProperty(exports, "tryGenerateUuid", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.tryGenerateUuid; }
+  get: function () { return chunkHMTHK2IY_cjs.tryGenerateUuid; }
 });
 Object.defineProperty(exports, "tryHash", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.tryHash; }
+  get: function () { return chunkHMTHK2IY_cjs.tryHash; }
 });
 Object.defineProperty(exports, "tryHashPassword", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.tryHashPassword; }
+  get: function () { return chunkHMTHK2IY_cjs.tryHashPassword; }
 });
 Object.defineProperty(exports, "verifyPassword", {
   enumerable: true,
-  get: function () { return chunkN2EW2FDZ_cjs.verifyPassword; }
+  get: function () { return chunkHMTHK2IY_cjs.verifyPassword; }
 });
 Object.defineProperty(exports, "ENCRYPTED_REGEX", {
   enumerable: true,
-  get: function () { return chunk3UX5MZ2P_cjs.ENCRYPTED_REGEX; }
+  get: function () { return chunkBHG5RSUV_cjs.ENCRYPTED_REGEX; }
 });
-Object.defineProperty(exports, "matchPattern", {
+Object.defineProperty(exports, "matchEncryptedPattern", {
   enumerable: true,
-  get: function () { return chunk3UX5MZ2P_cjs.matchPattern; }
+  get: function () { return chunkBHG5RSUV_cjs.matchEncryptedPattern; }
 });
 Object.defineProperty(exports, "parseToObj", {
   enumerable: true,
-  get: function () { return chunk3UX5MZ2P_cjs.parseToObj; }
+  get: function () { return chunkBHG5RSUV_cjs.parseToObj; }
 });
 Object.defineProperty(exports, "stringifyObj", {
   enumerable: true,
-  get: function () { return chunk3UX5MZ2P_cjs.stringifyObj; }
+  get: function () { return chunkBHG5RSUV_cjs.stringifyObj; }
 });
 Object.defineProperty(exports, "tryParseToObj", {
   enumerable: true,
-  get: function () { return chunk3UX5MZ2P_cjs.tryParseToObj; }
+  get: function () { return chunkBHG5RSUV_cjs.tryParseToObj; }
 });
 Object.defineProperty(exports, "tryStringifyObj", {
   enumerable: true,
-  get: function () { return chunk3UX5MZ2P_cjs.tryStringifyObj; }
+  get: function () { return chunkBHG5RSUV_cjs.tryStringifyObj; }
 });
 //# sourceMappingURL=node.cjs.map
 //# sourceMappingURL=node.cjs.map

package/dist/node.d.cts

@@ -1,4 +1,4 @@
-export { C as CipherEncoding, d as CreateSecretKeyOptions, f as DecryptOptions, D as DigestAlgorithm, E as ENCRYPTED_REGEX, b as Encoding, e as EncryptOptions, c as EncryptionAlgorithm, H as HashOptions, g as HashPasswordOptions, S as SecretKey, V as VerifyPasswordOptions, m as matchPattern, p as parseToObj, s as stringifyObj, t as tryParseToObj, a as tryStringifyObj } from './validate-EHuJC5QQ.cjs';
-export { w as convertBytesToStr, y as convertEncoding, s as convertStrToBytes, c as createSecretKey, f as decrypt, l as decryptObj, e as encrypt, j as encryptObj, g as generateUuid, o as hash, q as hashPassword, i as isNodeSecretKey, u as tryConvertBytesToStr, x as tryConvertEncoding, r as tryConvertStrToBytes, a as tryCreateSecretKey, d as tryDecrypt, k as tryDecryptObj, b as tryEncrypt, h as tryEncryptObj, t as tryGenerateUuid, m as tryHash, p as tryHashPassword, v as verifyPassword } from './export-CQNsJFh_.cjs';
+export { C as CipherEncoding, d as CreateSecretKeyOptions, f as DecryptOptions, D as DigestAlgorithm, E as ENCRYPTED_REGEX, b as Encoding, e as EncryptOptions, c as EncryptionAlgorithm, H as HashOptions, g as HashPasswordOptions, S as SecretKey, V as VerifyPasswordOptions, m as matchEncryptedPattern, p as parseToObj, s as stringifyObj, t as tryParseToObj, a as tryStringifyObj } from './validate-B3uHoP8n.cjs';
+export { w as convertBytesToStr, y as convertEncoding, s as convertStrToBytes, c as createSecretKey, f as decrypt, l as decryptObj, e as encrypt, j as encryptObj, g as generateUuid, o as hash, q as hashPassword, i as isNodeSecretKey, u as tryConvertBytesToStr, x as tryConvertEncoding, r as tryConvertStrToBytes, a as tryCreateSecretKey, d as tryDecrypt, k as tryDecryptObj, b as tryEncrypt, h as tryEncryptObj, t as tryGenerateUuid, m as tryHash, p as tryHashPassword, v as verifyPassword } from './export-5hmOiU0J.cjs';
 import 'node:crypto';
 import 'node:buffer';

package/dist/node.d.ts

@@ -1,4 +1,4 @@
-export { C as CipherEncoding, d as CreateSecretKeyOptions, f as DecryptOptions, D as DigestAlgorithm, E as ENCRYPTED_REGEX, b as Encoding, e as EncryptOptions, c as EncryptionAlgorithm, H as HashOptions, g as HashPasswordOptions, S as SecretKey, V as VerifyPasswordOptions, m as matchPattern, p as parseToObj, s as stringifyObj, t as tryParseToObj, a as tryStringifyObj } from './validate-EHuJC5QQ.js';
-export { w as convertBytesToStr, y as convertEncoding, s as convertStrToBytes, c as createSecretKey, f as decrypt, l as decryptObj, e as encrypt, j as encryptObj, g as generateUuid, o as hash, q as hashPassword, i as isNodeSecretKey, u as tryConvertBytesToStr, x as tryConvertEncoding, r as tryConvertStrToBytes, a as tryCreateSecretKey, d as tryDecrypt, k as tryDecryptObj, b as tryEncrypt, h as tryEncryptObj, t as tryGenerateUuid, m as tryHash, p as tryHashPassword, v as verifyPassword } from './export-BMvZq46v.js';
+export { C as CipherEncoding, d as CreateSecretKeyOptions, f as DecryptOptions, D as DigestAlgorithm, E as ENCRYPTED_REGEX, b as Encoding, e as EncryptOptions, c as EncryptionAlgorithm, H as HashOptions, g as HashPasswordOptions, S as SecretKey, V as VerifyPasswordOptions, m as matchEncryptedPattern, p as parseToObj, s as stringifyObj, t as tryParseToObj, a as tryStringifyObj } from './validate-B3uHoP8n.js';
+export { w as convertBytesToStr, y as convertEncoding, s as convertStrToBytes, c as createSecretKey, f as decrypt, l as decryptObj, e as encrypt, j as encryptObj, g as generateUuid, o as hash, q as hashPassword, i as isNodeSecretKey, u as tryConvertBytesToStr, x as tryConvertEncoding, r as tryConvertStrToBytes, a as tryCreateSecretKey, d as tryDecrypt, k as tryDecryptObj, b as tryEncrypt, h as tryEncryptObj, t as tryGenerateUuid, m as tryHash, p as tryHashPassword, v as verifyPassword } from './export-BF9wW56f.js';
 import 'node:crypto';
 import 'node:buffer';

package/dist/node.js

@@ -1,4 +1,4 @@
-export { convertBytesToStr, convertEncoding, convertStrToBytes, createSecretKey, decrypt, decryptObj, encrypt, encryptObj, generateUuid, hash, hashPassword, isNodeSecretKey, tryConvertBytesToStr, tryConvertEncoding, tryConvertStrToBytes, tryCreateSecretKey, tryDecrypt, tryDecryptObj, tryEncrypt, tryEncryptObj, tryGenerateUuid, tryHash, tryHashPassword, verifyPassword } from './chunk-ACFPMIXO.js';
-export { ENCRYPTED_REGEX, matchPattern, parseToObj, stringifyObj, tryParseToObj, tryStringifyObj } from './chunk-FKSYSPJR.js';
+export { convertBytesToStr, convertEncoding, convertStrToBytes, createSecretKey, decrypt, decryptObj, encrypt, encryptObj, generateUuid, hash, hashPassword, isNodeSecretKey, tryConvertBytesToStr, tryConvertEncoding, tryConvertStrToBytes, tryCreateSecretKey, tryDecrypt, tryDecryptObj, tryEncrypt, tryEncryptObj, tryGenerateUuid, tryHash, tryHashPassword, verifyPassword } from './chunk-RAEBT46G.js';
+export { ENCRYPTED_REGEX, matchEncryptedPattern, parseToObj, stringifyObj, tryParseToObj, tryStringifyObj } from './chunk-RUTGDMVR.js';
 //# sourceMappingURL=node.js.map
 //# sourceMappingURL=node.js.map

package/dist/{validate-EHuJC5QQ.d.cts → validate-B3uHoP8n.d.cts}

@@ -152,11 +152,11 @@ interface CreateSecretKeyOptions {
  * ### 🍼 Explain Like I'm Five
  * After locking your message, how should we write the locked message down?
  *
- * - `encoding`: output ciphertext encoding (`'base64' | 'base64url' | 'hex'`) (default: `'base64url'`)
+ * - `outputEncoding`: output ciphertext encoding (`'base64' | 'base64url' | 'hex'`) (default: `'base64url'`)
  */
 interface EncryptOptions {
     /** Encoding format for the output ciphertext (default: `'base64url'`). */
-    encoding?: CipherEncoding;
+    outputEncoding?: CipherEncoding;
 }
 /**
  * Options for decryption.
@@ -164,11 +164,11 @@ interface EncryptOptions {
  * ### 🍼 Explain Like I'm Five
  * To unlock the message, we must know how it was written down.
  *
- * - `encoding`: input ciphertext encoding (`'base64' | 'base64url' | 'hex'`) (default: `'base64url'`)
+ * - `inputEncoding`: input ciphertext encoding (`'base64' | 'base64url' | 'hex'`) (default: `'base64url'`)
  */
 interface DecryptOptions {
     /** Encoding format for the input ciphertext (default: `'base64url'`). */
-    encoding?: CipherEncoding;
+    inputEncoding?: CipherEncoding;
 }
 /**
  * Options for hashing arbitrary data.
@@ -178,13 +178,13 @@ interface DecryptOptions {
  * You can choose how to create the fingerprint (digest) and how to write it down (encoding).
  *
  * - `digest`: `'sha256' | 'sha384' | 'sha512'` (default: `'sha256'`)
- * - `encoding`: output ciphertext encoding for the hash (`'base64' | 'base64url' | 'hex'`; default: `'base64url'`)
+ * - `outputEncoding`: output ciphertext encoding for the hash (`'base64' | 'base64url' | 'hex'`; default: `'base64url'`)
  */
 interface HashOptions {
     /** Digest algorithm to use (default: `'sha256'`). */
     digest?: DigestAlgorithm;
     /** Encoding format for the output hash (default: `'base64url'`). */
-    encoding?: CipherEncoding;
+    outputEncoding?: CipherEncoding;
 }
 /**
  * Options for password hashing (PBKDF2).
@@ -194,7 +194,7 @@ interface HashOptions {
  * stirring many times (iterations), and making a long result (keyLength).
  *
  * - `digest`: `'sha256' | 'sha384' | 'sha512'` (default: `'sha512'`)
- * - `encoding`: output ciphertext encoding for the hash (`'base64' | 'base64url' | 'hex'`; default: `'base64url'`)
+ * - `outputEncoding`: output ciphertext encoding for the hash (`'base64' | 'base64url' | 'hex'`; default: `'base64url'`)
  * - `saltLength`: size of the random salt in bytes (default: `16` bytes)
  * - `iterations`: number of iterations (default: `320000`)
  * - `keyLength`: length of the derived key in bytes (default: `64` bytes)
@@ -203,7 +203,7 @@ interface HashPasswordOptions {
     /** Digest algorithm to use (default: `'sha512'`). */
     digest?: DigestAlgorithm;
     /** Encoding format for the output hash (default: `'base64url'`). */
-    encoding?: CipherEncoding;
+    outputEncoding?: CipherEncoding;
     /** Length of the salt in bytes (default: `16` bytes, min: `8` bytes). */
     saltLength?: number;
     /** Number of iterations for key derivation (default: `320000`, min: `1000`). */
@@ -219,7 +219,7 @@ interface HashPasswordOptions {
  * same size—so the new result matches the old one.
  *
  * - `digest`: `'sha256' | 'sha384' | 'sha512'` (default: `'sha512'`)
- * - `encoding`: input ciphertext encoding for the hash (`'base64' | 'base64url' | 'hex'`; default: `'base64url'`)
+ * - `inputEncoding`: input ciphertext encoding for the hash (`'base64' | 'base64url' | 'hex'`; default: `'base64url'`)
  * - `iterations`: number of iterations (default: `320000`)
  * - `keyLength`: length of the derived key in bytes (default: `64` bytes)
  */
@@ -227,7 +227,7 @@ interface VerifyPasswordOptions {
     /** Digest algorithm to use (default: `'sha512'`). */
     digest?: DigestAlgorithm;
     /** Encoding format of the input hash (default: `'base64url'`). */
-    encoding?: CipherEncoding;
+    inputEncoding?: CipherEncoding;
     /** Number of iterations for key derivation (default: `320000`). */
     iterations?: number;
     /** Length of the derived key in bytes (default: `64` bytes). */
@@ -250,12 +250,10 @@ interface VerifyPasswordOptions {
  *
  * @example
  * ```ts
- * const res = tryStringifyObj({ a: 1 });
- * if (res.success) {
- *   console.log(res.result); // {"a":1}
- * } else {
- *   console.error(res.error.message, res.error.description);
- * }
+ * const { result, error, success } = tryStringifyObj({ a: 1 });
+ *
+ * if (success) console.log(result); // "{\"a\":1}"
+ * else console.error(error); // { message: "...", description: "..." }
  * ```
  */
 declare function tryStringifyObj<T extends object = Record<string, unknown>>(obj: T): Result<string>;
@@ -276,11 +274,7 @@ declare function tryStringifyObj<T extends object = Record<string, unknown>>(obj
  *
  * @example
  * ```ts
- * try {
- * const json = stringifyObj({ a: 1 }); // {"a":1}
- * } catch (error: unknown) {
- *   console.error(error);
- * }
+ * const json = stringifyObj({ a: 1 }); // "{\"a\":1}"
  * ```
  */
 declare function stringifyObj<T extends object = Record<string, unknown>>(obj: T): string;
@@ -298,12 +292,10 @@ declare function stringifyObj<T extends object = Record<string, unknown>>(obj: T
  *
  * @example
  * ```ts
- * const res = tryParseToObj<{ a: number }>('{"a":1}');
- * if (res.success) {
- *   console.log(res.result.a); // 1
- * } else {
- *   console.error(res.error.message, res.error.description);
- * }
+ * const {result, error, success} = tryParseToObj<{ a: number }>('{"a":1}');
+ *
+ * if (success) console.log(result); // { a: 1 }
+ * else console.error(error) // { message: "...", description: "..." }
  * ```
  */
 declare function tryParseToObj<T extends object = Record<string, unknown>>(str: string): Result<{
@@ -324,11 +316,7 @@ declare function tryParseToObj<T extends object = Record<string, unknown>>(str:
  *
  * @example
  * ```ts
- * try {
- *   const obj = parseToObj<{ a: number }>('{"a":1}'); // obj.a === 1
- * } catch (error: unknown) {
- *   console.error(error);
- * }
+ * const obj = parseToObj<{ a: number }>('{"a":1}'); // obj.a === 1
  * ```
  */
 declare function parseToObj<T extends object = Record<string, unknown>>(str: string): T;
@@ -373,12 +361,12 @@ declare const ENCRYPTED_REGEX: Readonly<{
  *
  * @example
  * ```ts
- * matchPattern("abc.def.ghi.", "node");    // true
- * matchPattern("abc.def.", "web");         // true
- * matchPattern("abc.def.", "node");        // false
- * matchPattern("abc.def.ghi.", "general"); // true
+ * matchEncryptedPattern("abc.def.ghi.", "node");    // true
+ * matchEncryptedPattern("abc.def.", "web");         // true
+ * matchEncryptedPattern("abc.def.", "node");        // false
+ * matchEncryptedPattern("abc.def.ghi.", "general"); // true
  * ```
  */
-declare function matchPattern(data: string, format: "general" | "node" | "web"): boolean;
+declare function matchEncryptedPattern(data: string, format: "general" | "node" | "web"): boolean;
 
-export { type CipherEncoding as C, type DigestAlgorithm as D, ENCRYPTED_REGEX as E, type HashOptions as H, type Result as R, type SecretKey as S, type VerifyPasswordOptions as V, tryStringifyObj as a, type Encoding as b, type EncryptionAlgorithm as c, type CreateSecretKeyOptions as d, type EncryptOptions as e, type DecryptOptions as f, type HashPasswordOptions as g, matchPattern as m, parseToObj as p, stringifyObj as s, tryParseToObj as t };
+export { type CipherEncoding as C, type DigestAlgorithm as D, ENCRYPTED_REGEX as E, type HashOptions as H, type Result as R, type SecretKey as S, type VerifyPasswordOptions as V, tryStringifyObj as a, type Encoding as b, type EncryptionAlgorithm as c, type CreateSecretKeyOptions as d, type EncryptOptions as e, type DecryptOptions as f, type HashPasswordOptions as g, matchEncryptedPattern as m, parseToObj as p, stringifyObj as s, tryParseToObj as t };

package/dist/{validate-EHuJC5QQ.d.ts → validate-B3uHoP8n.d.ts}

@@ -152,11 +152,11 @@ interface CreateSecretKeyOptions {
  * ### 🍼 Explain Like I'm Five
  * After locking your message, how should we write the locked message down?
  *
- * - `encoding`: output ciphertext encoding (`'base64' | 'base64url' | 'hex'`) (default: `'base64url'`)
+ * - `outputEncoding`: output ciphertext encoding (`'base64' | 'base64url' | 'hex'`) (default: `'base64url'`)
  */
 interface EncryptOptions {
     /** Encoding format for the output ciphertext (default: `'base64url'`). */
-    encoding?: CipherEncoding;
+    outputEncoding?: CipherEncoding;
 }
 /**
  * Options for decryption.
@@ -164,11 +164,11 @@ interface EncryptOptions {
  * ### 🍼 Explain Like I'm Five
  * To unlock the message, we must know how it was written down.
  *
- * - `encoding`: input ciphertext encoding (`'base64' | 'base64url' | 'hex'`) (default: `'base64url'`)
+ * - `inputEncoding`: input ciphertext encoding (`'base64' | 'base64url' | 'hex'`) (default: `'base64url'`)
  */
 interface DecryptOptions {
     /** Encoding format for the input ciphertext (default: `'base64url'`). */
-    encoding?: CipherEncoding;
+    inputEncoding?: CipherEncoding;
 }
 /**
  * Options for hashing arbitrary data.
@@ -178,13 +178,13 @@ interface DecryptOptions {
  * You can choose how to create the fingerprint (digest) and how to write it down (encoding).
  *
  * - `digest`: `'sha256' | 'sha384' | 'sha512'` (default: `'sha256'`)
- * - `encoding`: output ciphertext encoding for the hash (`'base64' | 'base64url' | 'hex'`; default: `'base64url'`)
+ * - `outputEncoding`: output ciphertext encoding for the hash (`'base64' | 'base64url' | 'hex'`; default: `'base64url'`)
  */
 interface HashOptions {
     /** Digest algorithm to use (default: `'sha256'`). */
     digest?: DigestAlgorithm;
     /** Encoding format for the output hash (default: `'base64url'`). */
-    encoding?: CipherEncoding;
+    outputEncoding?: CipherEncoding;
 }
 /**
  * Options for password hashing (PBKDF2).
@@ -194,7 +194,7 @@ interface HashOptions {
  * stirring many times (iterations), and making a long result (keyLength).
  *
  * - `digest`: `'sha256' | 'sha384' | 'sha512'` (default: `'sha512'`)
- * - `encoding`: output ciphertext encoding for the hash (`'base64' | 'base64url' | 'hex'`; default: `'base64url'`)
+ * - `outputEncoding`: output ciphertext encoding for the hash (`'base64' | 'base64url' | 'hex'`; default: `'base64url'`)
  * - `saltLength`: size of the random salt in bytes (default: `16` bytes)
  * - `iterations`: number of iterations (default: `320000`)
  * - `keyLength`: length of the derived key in bytes (default: `64` bytes)
@@ -203,7 +203,7 @@ interface HashPasswordOptions {
     /** Digest algorithm to use (default: `'sha512'`). */
     digest?: DigestAlgorithm;
     /** Encoding format for the output hash (default: `'base64url'`). */
-    encoding?: CipherEncoding;
+    outputEncoding?: CipherEncoding;
     /** Length of the salt in bytes (default: `16` bytes, min: `8` bytes). */
     saltLength?: number;
     /** Number of iterations for key derivation (default: `320000`, min: `1000`). */
@@ -219,7 +219,7 @@ interface HashPasswordOptions {
  * same size—so the new result matches the old one.
  *
  * - `digest`: `'sha256' | 'sha384' | 'sha512'` (default: `'sha512'`)
- * - `encoding`: input ciphertext encoding for the hash (`'base64' | 'base64url' | 'hex'`; default: `'base64url'`)
+ * - `inputEncoding`: input ciphertext encoding for the hash (`'base64' | 'base64url' | 'hex'`; default: `'base64url'`)
  * - `iterations`: number of iterations (default: `320000`)
  * - `keyLength`: length of the derived key in bytes (default: `64` bytes)
  */
@@ -227,7 +227,7 @@ interface VerifyPasswordOptions {
     /** Digest algorithm to use (default: `'sha512'`). */
     digest?: DigestAlgorithm;
     /** Encoding format of the input hash (default: `'base64url'`). */
-    encoding?: CipherEncoding;
+    inputEncoding?: CipherEncoding;
     /** Number of iterations for key derivation (default: `320000`). */
     iterations?: number;
     /** Length of the derived key in bytes (default: `64` bytes). */
@@ -250,12 +250,10 @@ interface VerifyPasswordOptions {
  *
  * @example
  * ```ts
- * const res = tryStringifyObj({ a: 1 });
- * if (res.success) {
- *   console.log(res.result); // {"a":1}
- * } else {
- *   console.error(res.error.message, res.error.description);
- * }
+ * const { result, error, success } = tryStringifyObj({ a: 1 });
+ *
+ * if (success) console.log(result); // "{\"a\":1}"
+ * else console.error(error); // { message: "...", description: "..." }
  * ```
  */
 declare function tryStringifyObj<T extends object = Record<string, unknown>>(obj: T): Result<string>;
@@ -276,11 +274,7 @@ declare function tryStringifyObj<T extends object = Record<string, unknown>>(obj
  *
  * @example
  * ```ts
- * try {
- * const json = stringifyObj({ a: 1 }); // {"a":1}
- * } catch (error: unknown) {
- *   console.error(error);
- * }
+ * const json = stringifyObj({ a: 1 }); // "{\"a\":1}"
  * ```
  */
 declare function stringifyObj<T extends object = Record<string, unknown>>(obj: T): string;
@@ -298,12 +292,10 @@ declare function stringifyObj<T extends object = Record<string, unknown>>(obj: T
  *
  * @example
  * ```ts
- * const res = tryParseToObj<{ a: number }>('{"a":1}');
- * if (res.success) {
- *   console.log(res.result.a); // 1
- * } else {
- *   console.error(res.error.message, res.error.description);
- * }
+ * const {result, error, success} = tryParseToObj<{ a: number }>('{"a":1}');
+ *
+ * if (success) console.log(result); // { a: 1 }
+ * else console.error(error) // { message: "...", description: "..." }
  * ```
  */
 declare function tryParseToObj<T extends object = Record<string, unknown>>(str: string): Result<{
@@ -324,11 +316,7 @@ declare function tryParseToObj<T extends object = Record<string, unknown>>(str:
  *
  * @example
  * ```ts
- * try {
- *   const obj = parseToObj<{ a: number }>('{"a":1}'); // obj.a === 1
- * } catch (error: unknown) {
- *   console.error(error);
- * }
+ * const obj = parseToObj<{ a: number }>('{"a":1}'); // obj.a === 1
  * ```
  */
 declare function parseToObj<T extends object = Record<string, unknown>>(str: string): T;
@@ -373,12 +361,12 @@ declare const ENCRYPTED_REGEX: Readonly<{
  *
  * @example
  * ```ts
- * matchPattern("abc.def.ghi.", "node");    // true
- * matchPattern("abc.def.", "web");         // true
- * matchPattern("abc.def.", "node");        // false
- * matchPattern("abc.def.ghi.", "general"); // true
+ * matchEncryptedPattern("abc.def.ghi.", "node");    // true
+ * matchEncryptedPattern("abc.def.", "web");         // true
+ * matchEncryptedPattern("abc.def.", "node");        // false
+ * matchEncryptedPattern("abc.def.ghi.", "general"); // true
  * ```
  */
-declare function matchPattern(data: string, format: "general" | "node" | "web"): boolean;
+declare function matchEncryptedPattern(data: string, format: "general" | "node" | "web"): boolean;
 
-export { type CipherEncoding as C, type DigestAlgorithm as D, ENCRYPTED_REGEX as E, type HashOptions as H, type Result as R, type SecretKey as S, type VerifyPasswordOptions as V, tryStringifyObj as a, type Encoding as b, type EncryptionAlgorithm as c, type CreateSecretKeyOptions as d, type EncryptOptions as e, type DecryptOptions as f, type HashPasswordOptions as g, matchPattern as m, parseToObj as p, stringifyObj as s, tryParseToObj as t };
+export { type CipherEncoding as C, type DigestAlgorithm as D, ENCRYPTED_REGEX as E, type HashOptions as H, type Result as R, type SecretKey as S, type VerifyPasswordOptions as V, tryStringifyObj as a, type Encoding as b, type EncryptionAlgorithm as c, type CreateSecretKeyOptions as d, type EncryptOptions as e, type DecryptOptions as f, type HashPasswordOptions as g, matchEncryptedPattern as m, parseToObj as p, stringifyObj as s, tryParseToObj as t };