cipher-kit 2.0.0-beta.4 → 2.0.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
-import { n as nodeCryptoKit } from './export-DXRl-ncG.cjs';
-import { w as webCryptoKit } from './export-Gd8hafl6.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 matchPattern, p as parseToObj, s as stringifyObj, t as tryParseToObj, a as tryStringifyObj } from './validate-Cb7IOrPo.cjs';
+import { n as nodeCryptoKit } from './export-CQNsJFh_.cjs';
+import { w as webCryptoKit } from './export-55tHE0Bw.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 matchPattern, p as parseToObj, s as stringifyObj, t as tryParseToObj, a as tryStringifyObj } from './validate-EHuJC5QQ.cjs';
 import 'node:buffer';
 import 'node:crypto';
 

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { n as nodeCryptoKit } from './export-D1Vh79Qw.js';
-import { w as webCryptoKit } from './export-DGrELdz_.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 matchPattern, p as parseToObj, s as stringifyObj, t as tryParseToObj, a as tryStringifyObj } from './validate-Cb7IOrPo.js';
+import { n as nodeCryptoKit } from './export-BMvZq46v.js';
+import { w as webCryptoKit } from './export-llM6c7Do.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 matchPattern, p as parseToObj, s as stringifyObj, t as tryParseToObj, a as tryStringifyObj } from './validate-EHuJC5QQ.js';
 import 'node:buffer';
 import 'node:crypto';
 

package/dist/index.js

@@ -1,6 +1,6 @@
-import { kit_exports } from './chunk-N5T4PNG7.js';
-import { kit_exports as kit_exports$1 } from './chunk-LHB5NXYW.js';
-export { ENCRYPTED_REGEX, matchPattern, parseToObj, stringifyObj, tryParseToObj, tryStringifyObj } from './chunk-YMNOTRET.js';
+import { kit_exports } from './chunk-ACFPMIXO.js';
+import { kit_exports as kit_exports$1 } from './chunk-4MFF6V3R.js';
+export { ENCRYPTED_REGEX, matchPattern, parseToObj, stringifyObj, tryParseToObj, tryStringifyObj } from './chunk-FKSYSPJR.js';
 
 // src/export.ts
 var nodeKit = kit_exports;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/export.ts"],"names":["kit_exports"],"mappings":";;;;;AAoCO,IAAM,OAAA,GAAU;AAwBhB,IAAM,MAAA,GAASA","file":"index.js","sourcesContent":["import * as nodeCryptoKit from './node/kit';\r\nimport * as webCryptoKit from './web/kit';\r\n\r\nexport {\r\n  parseToObj,\r\n  stringifyObj,\r\n  tryParseToObj,\r\n  tryStringifyObj,\r\n} from '~/helpers/object';\r\nexport {\r\n  ENCRYPTED_REGEX,\r\n  matchPattern,\r\n} from '~/helpers/validate';\r\nexport type * from './helpers/types';\r\n\r\n/**\r\n * Node.js cryptography kit (Crypto Node.js API).\r\n *\r\n * Can be imported directly from 'cipher-kit/node' for smaller bundle size.\r\n *\r\n * - Uses Node's `crypto` module.\r\n * - Synchronous API (throwing) + safe wrappers that return `Result` (non-throwing).\r\n * - JSDoc comments with `Explain Like I'm Five` sections.\r\n *\r\n * #### Contains:\r\n * - Secret key creation from passphrase.\r\n * - Data encryption and decryption.\r\n * - Object encryption and decryption.\r\n * - Data hashing (digest).\r\n * - Password hashing and verification with time-safe comparison.\r\n * - Object serialization and deserialization (to/from JSON).\r\n * - Pattern matching to validate encrypted data format.\r\n *\r\n * ### 🍼 Explain Like I'm Five\r\n * It's like a toolkit that helps you keep your and your users' secrets safe when using Node.js.\r\n */\r\nexport const nodeKit = nodeCryptoKit;\r\n\r\n/**\r\n * Web, Deno, Bun and Cloudflare Workers cryptography kit (Crypto Web API).\r\n *\r\n * Can be imported directly from 'cipher-kit/web-api' for smaller bundle size.\r\n *\r\n * - Uses the Web Crypto API (`crypto.subtle`).\r\n * - Async API (Promise) + safe wrappers that return `Result`.\r\n * - JSDoc comments with `Explain Like I'm Five` sections.\r\n *\r\n * #### Contains:\r\n * - Secret key creation from passphrase.\r\n * - Data encryption and decryption.\r\n * - Object encryption and decryption.\r\n * - Data hashing (digest).\r\n * - Password hashing and verification with time-safe comparison.\r\n * - Object serialization and deserialization (to/from JSON).\r\n * - Pattern matching to validate encrypted data format.\r\n *\r\n * ### 🍼 Explain Like I'm Five\r\n * It's like a toolkit that helps you keep your and your users' secrets safe when using the web\r\n * or other Node.js alternatives like Deno, Bun, or Cloudflare Workers.\r\n */\r\nexport const webKit = webCryptoKit;\r\n"]}
+{"version":3,"sources":["../src/export.ts"],"names":["kit_exports"],"mappings":";;;;;AAoCO,IAAM,OAAA,GAAU;AAwBhB,IAAM,MAAA,GAASA","file":"index.js","sourcesContent":["import * as nodeCryptoKit from \"./node/kit\";\r\nimport * as webCryptoKit from \"./web/kit\";\r\n\r\nexport {\r\n  parseToObj,\r\n  stringifyObj,\r\n  tryParseToObj,\r\n  tryStringifyObj,\r\n} from \"~/helpers/object\";\r\nexport {\r\n  ENCRYPTED_REGEX,\r\n  matchPattern,\r\n} from \"~/helpers/validate\";\r\nexport type * from \"./helpers/types\";\r\n\r\n/**\r\n * Node.js cryptography kit (Crypto Node.js API).\r\n *\r\n * Can be imported directly from 'cipher-kit/node' for smaller bundle size.\r\n *\r\n * - Uses Node's `crypto` module.\r\n * - Synchronous API (throwing) + safe wrappers that return `Result` (non-throwing).\r\n * - JSDoc comments with `Explain Like I'm Five` sections.\r\n *\r\n * #### Contains:\r\n * - Secret key creation from passphrase.\r\n * - Data encryption and decryption.\r\n * - Object encryption and decryption.\r\n * - Data hashing (digest).\r\n * - Password hashing and verification with time-safe comparison.\r\n * - Object serialization and deserialization (to/from JSON).\r\n * - Pattern matching to validate encrypted data format.\r\n *\r\n * ### 🍼 Explain Like I'm Five\r\n * It's like a toolkit that helps you keep your and your users' secrets safe when using Node.js.\r\n */\r\nexport const nodeKit = nodeCryptoKit;\r\n\r\n/**\r\n * Web, Deno, Bun and Cloudflare Workers cryptography kit (Crypto Web API).\r\n *\r\n * Can be imported directly from 'cipher-kit/web-api' for smaller bundle size.\r\n *\r\n * - Uses the Web Crypto API (`crypto.subtle`).\r\n * - Async API (Promise) + safe wrappers that return `Result`.\r\n * - JSDoc comments with `Explain Like I'm Five` sections.\r\n *\r\n * #### Contains:\r\n * - Secret key creation from passphrase.\r\n * - Data encryption and decryption.\r\n * - Object encryption and decryption.\r\n * - Data hashing (digest).\r\n * - Password hashing and verification with time-safe comparison.\r\n * - Object serialization and deserialization (to/from JSON).\r\n * - Pattern matching to validate encrypted data format.\r\n *\r\n * ### 🍼 Explain Like I'm Five\r\n * It's like a toolkit that helps you keep your and your users' secrets safe when using the web\r\n * or other Node.js alternatives like Deno, Bun, or Cloudflare Workers.\r\n */\r\nexport const webKit = webCryptoKit;\r\n"]}

package/dist/node.cjs

@@ -1,129 +1,129 @@
 'use strict';
 
-var chunkOL2AIXWK_cjs = require('./chunk-OL2AIXWK.cjs');
-var chunkUIV6DG54_cjs = require('./chunk-UIV6DG54.cjs');
+var chunkN2EW2FDZ_cjs = require('./chunk-N2EW2FDZ.cjs');
+var chunk3UX5MZ2P_cjs = require('./chunk-3UX5MZ2P.cjs');
 
 
 
 Object.defineProperty(exports, "convertBytesToStr", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.convertBytesToStr; }
+  get: function () { return chunkN2EW2FDZ_cjs.convertBytesToStr; }
 });
 Object.defineProperty(exports, "convertEncoding", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.convertEncoding; }
+  get: function () { return chunkN2EW2FDZ_cjs.convertEncoding; }
 });
 Object.defineProperty(exports, "convertStrToBytes", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.convertStrToBytes; }
+  get: function () { return chunkN2EW2FDZ_cjs.convertStrToBytes; }
 });
 Object.defineProperty(exports, "createSecretKey", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.createSecretKey; }
+  get: function () { return chunkN2EW2FDZ_cjs.createSecretKey; }
 });
 Object.defineProperty(exports, "decrypt", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.decrypt; }
+  get: function () { return chunkN2EW2FDZ_cjs.decrypt; }
 });
 Object.defineProperty(exports, "decryptObj", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.decryptObj; }
+  get: function () { return chunkN2EW2FDZ_cjs.decryptObj; }
 });
 Object.defineProperty(exports, "encrypt", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.encrypt; }
+  get: function () { return chunkN2EW2FDZ_cjs.encrypt; }
 });
 Object.defineProperty(exports, "encryptObj", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.encryptObj; }
+  get: function () { return chunkN2EW2FDZ_cjs.encryptObj; }
 });
 Object.defineProperty(exports, "generateUuid", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.generateUuid; }
+  get: function () { return chunkN2EW2FDZ_cjs.generateUuid; }
 });
 Object.defineProperty(exports, "hash", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.hash; }
+  get: function () { return chunkN2EW2FDZ_cjs.hash; }
 });
 Object.defineProperty(exports, "hashPassword", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.hashPassword; }
+  get: function () { return chunkN2EW2FDZ_cjs.hashPassword; }
 });
 Object.defineProperty(exports, "isNodeSecretKey", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.isNodeSecretKey; }
+  get: function () { return chunkN2EW2FDZ_cjs.isNodeSecretKey; }
 });
 Object.defineProperty(exports, "tryConvertBytesToStr", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.tryConvertBytesToStr; }
+  get: function () { return chunkN2EW2FDZ_cjs.tryConvertBytesToStr; }
 });
 Object.defineProperty(exports, "tryConvertEncoding", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.tryConvertEncoding; }
+  get: function () { return chunkN2EW2FDZ_cjs.tryConvertEncoding; }
 });
 Object.defineProperty(exports, "tryConvertStrToBytes", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.tryConvertStrToBytes; }
+  get: function () { return chunkN2EW2FDZ_cjs.tryConvertStrToBytes; }
 });
 Object.defineProperty(exports, "tryCreateSecretKey", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.tryCreateSecretKey; }
+  get: function () { return chunkN2EW2FDZ_cjs.tryCreateSecretKey; }
 });
 Object.defineProperty(exports, "tryDecrypt", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.tryDecrypt; }
+  get: function () { return chunkN2EW2FDZ_cjs.tryDecrypt; }
 });
 Object.defineProperty(exports, "tryDecryptObj", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.tryDecryptObj; }
+  get: function () { return chunkN2EW2FDZ_cjs.tryDecryptObj; }
 });
 Object.defineProperty(exports, "tryEncrypt", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.tryEncrypt; }
+  get: function () { return chunkN2EW2FDZ_cjs.tryEncrypt; }
 });
 Object.defineProperty(exports, "tryEncryptObj", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.tryEncryptObj; }
+  get: function () { return chunkN2EW2FDZ_cjs.tryEncryptObj; }
 });
 Object.defineProperty(exports, "tryGenerateUuid", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.tryGenerateUuid; }
+  get: function () { return chunkN2EW2FDZ_cjs.tryGenerateUuid; }
 });
 Object.defineProperty(exports, "tryHash", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.tryHash; }
+  get: function () { return chunkN2EW2FDZ_cjs.tryHash; }
 });
 Object.defineProperty(exports, "tryHashPassword", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.tryHashPassword; }
+  get: function () { return chunkN2EW2FDZ_cjs.tryHashPassword; }
 });
 Object.defineProperty(exports, "verifyPassword", {
   enumerable: true,
-  get: function () { return chunkOL2AIXWK_cjs.verifyPassword; }
+  get: function () { return chunkN2EW2FDZ_cjs.verifyPassword; }
 });
 Object.defineProperty(exports, "ENCRYPTED_REGEX", {
   enumerable: true,
-  get: function () { return chunkUIV6DG54_cjs.ENCRYPTED_REGEX; }
+  get: function () { return chunk3UX5MZ2P_cjs.ENCRYPTED_REGEX; }
 });
 Object.defineProperty(exports, "matchPattern", {
   enumerable: true,
-  get: function () { return chunkUIV6DG54_cjs.matchPattern; }
+  get: function () { return chunk3UX5MZ2P_cjs.matchPattern; }
 });
 Object.defineProperty(exports, "parseToObj", {
   enumerable: true,
-  get: function () { return chunkUIV6DG54_cjs.parseToObj; }
+  get: function () { return chunk3UX5MZ2P_cjs.parseToObj; }
 });
 Object.defineProperty(exports, "stringifyObj", {
   enumerable: true,
-  get: function () { return chunkUIV6DG54_cjs.stringifyObj; }
+  get: function () { return chunk3UX5MZ2P_cjs.stringifyObj; }
 });
 Object.defineProperty(exports, "tryParseToObj", {
   enumerable: true,
-  get: function () { return chunkUIV6DG54_cjs.tryParseToObj; }
+  get: function () { return chunk3UX5MZ2P_cjs.tryParseToObj; }
 });
 Object.defineProperty(exports, "tryStringifyObj", {
   enumerable: true,
-  get: function () { return chunkUIV6DG54_cjs.tryStringifyObj; }
+  get: function () { return chunk3UX5MZ2P_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-Cb7IOrPo.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-DXRl-ncG.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 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';
 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-Cb7IOrPo.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-D1Vh79Qw.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 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';
 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-N5T4PNG7.js';
-export { ENCRYPTED_REGEX, matchPattern, parseToObj, stringifyObj, tryParseToObj, tryStringifyObj } from './chunk-YMNOTRET.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-ACFPMIXO.js';
+export { ENCRYPTED_REGEX, matchPattern, parseToObj, stringifyObj, tryParseToObj, tryStringifyObj } from './chunk-FKSYSPJR.js';
 //# sourceMappingURL=node.js.map
 //# sourceMappingURL=node.js.map

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

@@ -20,16 +20,18 @@ interface ResultErr {
  * @example
  * ```ts
  * // Primitive result
- * function getNum(): Result<number> { return $ok(42); }
+ * function getNum(): Result<number> {
+ *   return $ok(42);
+ * }
  * const r1 = getNum();
  * if (r1.success) console.log(r1.result); // 42
  *
  * // Object result (spread)
- * function getPair(): Result<{ a: number; b: string }> {
- *   return $ok({ a: 1, b: 'x' });
+ * function getObject(): Result<{ name: string; age: number }> {
+ *   return $ok({ name: 'Alice', age: 30 });
  * }
- * const r2 = getPair();
- * if (r2.success) console.log(r2.a, r2.b); // 1 'x'
+ * const r2 = getObject();
+ * if (r2.success) console.log(r2.name, r2.age); // 'Alice' 30
  * ```
  */
 type Result<T, E = ResultErr> = T extends object ? ({
@@ -90,6 +92,7 @@ declare const ENCRYPTION_ALGORITHMS: Readonly<{
 }>;
 
 declare const __brand: unique symbol;
+/** A brand type to distinguish between different types */
 type Brand<T> = {
     readonly [__brand]: T;
 };
@@ -102,11 +105,15 @@ type Brand<T> = {
  *
  * @template Platform - 'web' or 'node' to specify the platform of the secret key.
  */
-type SecretKey<Platform extends 'web' | 'node'> = {
+type SecretKey<Platform extends "web" | "node"> = {
+    /** The platform the key is for ('web' or 'node'). */
     readonly platform: Platform;
+    /** The digest algorithm used for HKDF (e.g. 'sha256'). */
     readonly digest: keyof typeof DIGEST_ALGORITHMS;
+    /** The encryption algorithm used (e.g. 'aes256gcm'). */
     readonly algorithm: keyof typeof ENCRYPTION_ALGORITHMS;
-    readonly key: Platform extends 'web' ? webcrypto.CryptoKey : nodeCrypto.KeyObject;
+    /** The actual secret key object (CryptoKey for web, KeyObject for node). */
+    readonly key: Platform extends "web" ? webcrypto.CryptoKey : nodeCrypto.KeyObject;
 } & Brand<`secretKey-${Platform}`>;
 /** Supported **cipher text** encodings for encrypted/hash outputs. */
 type CipherEncoding = (typeof CIPHER_ENCODING)[number];
@@ -130,9 +137,13 @@ type DigestAlgorithm = keyof typeof DIGEST_ALGORITHMS;
  * - `info` (default: `'cipher-kit'`)
  */
 interface CreateSecretKeyOptions {
+    /** Encryption algorithm to use (default: `'aes256gcm'`). */
     algorithm?: EncryptionAlgorithm;
+    /** Digest algorithm for HKDF (default: `'sha256'`). */
     digest?: DigestAlgorithm;
+    /** Optional salt for HKDF (default: `'cipher-kit-salt'`, must be ≥ 8 characters). */
     salt?: string;
+    /** Optional context info for HKDF (default: `'cipher-kit'`). */
     info?: string;
 }
 /**
@@ -368,6 +379,6 @@ declare const ENCRYPTED_REGEX: Readonly<{
  * matchPattern("abc.def.ghi.", "general"); // true
  * ```
  */
-declare function matchPattern(data: string, format: 'general' | 'node' | 'web'): boolean;
+declare function matchPattern(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 };

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

@@ -20,16 +20,18 @@ interface ResultErr {
  * @example
  * ```ts
  * // Primitive result
- * function getNum(): Result<number> { return $ok(42); }
+ * function getNum(): Result<number> {
+ *   return $ok(42);
+ * }
  * const r1 = getNum();
  * if (r1.success) console.log(r1.result); // 42
  *
  * // Object result (spread)
- * function getPair(): Result<{ a: number; b: string }> {
- *   return $ok({ a: 1, b: 'x' });
+ * function getObject(): Result<{ name: string; age: number }> {
+ *   return $ok({ name: 'Alice', age: 30 });
  * }
- * const r2 = getPair();
- * if (r2.success) console.log(r2.a, r2.b); // 1 'x'
+ * const r2 = getObject();
+ * if (r2.success) console.log(r2.name, r2.age); // 'Alice' 30
  * ```
  */
 type Result<T, E = ResultErr> = T extends object ? ({
@@ -90,6 +92,7 @@ declare const ENCRYPTION_ALGORITHMS: Readonly<{
 }>;
 
 declare const __brand: unique symbol;
+/** A brand type to distinguish between different types */
 type Brand<T> = {
     readonly [__brand]: T;
 };
@@ -102,11 +105,15 @@ type Brand<T> = {
  *
  * @template Platform - 'web' or 'node' to specify the platform of the secret key.
  */
-type SecretKey<Platform extends 'web' | 'node'> = {
+type SecretKey<Platform extends "web" | "node"> = {
+    /** The platform the key is for ('web' or 'node'). */
     readonly platform: Platform;
+    /** The digest algorithm used for HKDF (e.g. 'sha256'). */
     readonly digest: keyof typeof DIGEST_ALGORITHMS;
+    /** The encryption algorithm used (e.g. 'aes256gcm'). */
     readonly algorithm: keyof typeof ENCRYPTION_ALGORITHMS;
-    readonly key: Platform extends 'web' ? webcrypto.CryptoKey : nodeCrypto.KeyObject;
+    /** The actual secret key object (CryptoKey for web, KeyObject for node). */
+    readonly key: Platform extends "web" ? webcrypto.CryptoKey : nodeCrypto.KeyObject;
 } & Brand<`secretKey-${Platform}`>;
 /** Supported **cipher text** encodings for encrypted/hash outputs. */
 type CipherEncoding = (typeof CIPHER_ENCODING)[number];
@@ -130,9 +137,13 @@ type DigestAlgorithm = keyof typeof DIGEST_ALGORITHMS;
  * - `info` (default: `'cipher-kit'`)
  */
 interface CreateSecretKeyOptions {
+    /** Encryption algorithm to use (default: `'aes256gcm'`). */
     algorithm?: EncryptionAlgorithm;
+    /** Digest algorithm for HKDF (default: `'sha256'`). */
     digest?: DigestAlgorithm;
+    /** Optional salt for HKDF (default: `'cipher-kit-salt'`, must be ≥ 8 characters). */
     salt?: string;
+    /** Optional context info for HKDF (default: `'cipher-kit'`). */
     info?: string;
 }
 /**
@@ -368,6 +379,6 @@ declare const ENCRYPTED_REGEX: Readonly<{
  * matchPattern("abc.def.ghi.", "general"); // true
  * ```
  */
-declare function matchPattern(data: string, format: 'general' | 'node' | 'web'): boolean;
+declare function matchPattern(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 };

package/dist/web-api.cjs

@@ -1,129 +1,129 @@
 'use strict';
 
-var chunkXIWV7XVI_cjs = require('./chunk-XIWV7XVI.cjs');
-var chunkUIV6DG54_cjs = require('./chunk-UIV6DG54.cjs');
+var chunkCVCDAHDW_cjs = require('./chunk-CVCDAHDW.cjs');
+var chunk3UX5MZ2P_cjs = require('./chunk-3UX5MZ2P.cjs');
 
 
 
 Object.defineProperty(exports, "convertBytesToStr", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.convertBytesToStr; }
+  get: function () { return chunkCVCDAHDW_cjs.convertBytesToStr; }
 });
 Object.defineProperty(exports, "convertEncoding", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.convertEncoding; }
+  get: function () { return chunkCVCDAHDW_cjs.convertEncoding; }
 });
 Object.defineProperty(exports, "convertStrToBytes", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.convertStrToBytes; }
+  get: function () { return chunkCVCDAHDW_cjs.convertStrToBytes; }
 });
 Object.defineProperty(exports, "createSecretKey", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.createSecretKey; }
+  get: function () { return chunkCVCDAHDW_cjs.createSecretKey; }
 });
 Object.defineProperty(exports, "decrypt", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.decrypt; }
+  get: function () { return chunkCVCDAHDW_cjs.decrypt; }
 });
 Object.defineProperty(exports, "decryptObj", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.decryptObj; }
+  get: function () { return chunkCVCDAHDW_cjs.decryptObj; }
 });
 Object.defineProperty(exports, "encrypt", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.encrypt; }
+  get: function () { return chunkCVCDAHDW_cjs.encrypt; }
 });
 Object.defineProperty(exports, "encryptObj", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.encryptObj; }
+  get: function () { return chunkCVCDAHDW_cjs.encryptObj; }
 });
 Object.defineProperty(exports, "generateUuid", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.generateUuid; }
+  get: function () { return chunkCVCDAHDW_cjs.generateUuid; }
 });
 Object.defineProperty(exports, "hash", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.hash; }
+  get: function () { return chunkCVCDAHDW_cjs.hash; }
 });
 Object.defineProperty(exports, "hashPassword", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.hashPassword; }
+  get: function () { return chunkCVCDAHDW_cjs.hashPassword; }
 });
 Object.defineProperty(exports, "isWebSecretKey", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.isWebSecretKey; }
+  get: function () { return chunkCVCDAHDW_cjs.isWebSecretKey; }
 });
 Object.defineProperty(exports, "tryConvertBytesToStr", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.tryConvertBytesToStr; }
+  get: function () { return chunkCVCDAHDW_cjs.tryConvertBytesToStr; }
 });
 Object.defineProperty(exports, "tryConvertEncoding", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.tryConvertEncoding; }
+  get: function () { return chunkCVCDAHDW_cjs.tryConvertEncoding; }
 });
 Object.defineProperty(exports, "tryConvertStrToBytes", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.tryConvertStrToBytes; }
+  get: function () { return chunkCVCDAHDW_cjs.tryConvertStrToBytes; }
 });
 Object.defineProperty(exports, "tryCreateSecretKey", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.tryCreateSecretKey; }
+  get: function () { return chunkCVCDAHDW_cjs.tryCreateSecretKey; }
 });
 Object.defineProperty(exports, "tryDecrypt", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.tryDecrypt; }
+  get: function () { return chunkCVCDAHDW_cjs.tryDecrypt; }
 });
 Object.defineProperty(exports, "tryDecryptObj", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.tryDecryptObj; }
+  get: function () { return chunkCVCDAHDW_cjs.tryDecryptObj; }
 });
 Object.defineProperty(exports, "tryEncrypt", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.tryEncrypt; }
+  get: function () { return chunkCVCDAHDW_cjs.tryEncrypt; }
 });
 Object.defineProperty(exports, "tryEncryptObj", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.tryEncryptObj; }
+  get: function () { return chunkCVCDAHDW_cjs.tryEncryptObj; }
 });
 Object.defineProperty(exports, "tryGenerateUuid", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.tryGenerateUuid; }
+  get: function () { return chunkCVCDAHDW_cjs.tryGenerateUuid; }
 });
 Object.defineProperty(exports, "tryHash", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.tryHash; }
+  get: function () { return chunkCVCDAHDW_cjs.tryHash; }
 });
 Object.defineProperty(exports, "tryHashPassword", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.tryHashPassword; }
+  get: function () { return chunkCVCDAHDW_cjs.tryHashPassword; }
 });
 Object.defineProperty(exports, "verifyPassword", {
   enumerable: true,
-  get: function () { return chunkXIWV7XVI_cjs.verifyPassword; }
+  get: function () { return chunkCVCDAHDW_cjs.verifyPassword; }
 });
 Object.defineProperty(exports, "ENCRYPTED_REGEX", {
   enumerable: true,
-  get: function () { return chunkUIV6DG54_cjs.ENCRYPTED_REGEX; }
+  get: function () { return chunk3UX5MZ2P_cjs.ENCRYPTED_REGEX; }
 });
 Object.defineProperty(exports, "matchPattern", {
   enumerable: true,
-  get: function () { return chunkUIV6DG54_cjs.matchPattern; }
+  get: function () { return chunk3UX5MZ2P_cjs.matchPattern; }
 });
 Object.defineProperty(exports, "parseToObj", {
   enumerable: true,
-  get: function () { return chunkUIV6DG54_cjs.parseToObj; }
+  get: function () { return chunk3UX5MZ2P_cjs.parseToObj; }
 });
 Object.defineProperty(exports, "stringifyObj", {
   enumerable: true,
-  get: function () { return chunkUIV6DG54_cjs.stringifyObj; }
+  get: function () { return chunk3UX5MZ2P_cjs.stringifyObj; }
 });
 Object.defineProperty(exports, "tryParseToObj", {
   enumerable: true,
-  get: function () { return chunkUIV6DG54_cjs.tryParseToObj; }
+  get: function () { return chunk3UX5MZ2P_cjs.tryParseToObj; }
 });
 Object.defineProperty(exports, "tryStringifyObj", {
   enumerable: true,
-  get: function () { return chunkUIV6DG54_cjs.tryStringifyObj; }
+  get: function () { return chunk3UX5MZ2P_cjs.tryStringifyObj; }
 });
 //# sourceMappingURL=web-api.cjs.map
 //# sourceMappingURL=web-api.cjs.map

package/dist/web-api.d.cts

@@ -1,3 +1,3 @@
-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-Cb7IOrPo.cjs';
-export { u as convertBytesToStr, y as convertEncoding, r as convertStrToBytes, c as createSecretKey, f as decrypt, l as decryptObj, e as encrypt, j as encryptObj, g as generateUuid, n as hash, p as hashPassword, i as isWebSecretKey, s as tryConvertBytesToStr, x as tryConvertEncoding, q as tryConvertStrToBytes, a as tryCreateSecretKey, d as tryDecrypt, k as tryDecryptObj, b as tryEncrypt, h as tryEncryptObj, t as tryGenerateUuid, m as tryHash, o as tryHashPassword, v as verifyPassword } from './export-Gd8hafl6.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 matchPattern, p as parseToObj, s as stringifyObj, t as tryParseToObj, a as tryStringifyObj } from './validate-EHuJC5QQ.cjs';
+export { u as convertBytesToStr, y as convertEncoding, r as convertStrToBytes, c as createSecretKey, f as decrypt, l as decryptObj, e as encrypt, j as encryptObj, g as generateUuid, n as hash, p as hashPassword, i as isWebSecretKey, s as tryConvertBytesToStr, x as tryConvertEncoding, q as tryConvertStrToBytes, a as tryCreateSecretKey, d as tryDecrypt, k as tryDecryptObj, b as tryEncrypt, h as tryEncryptObj, t as tryGenerateUuid, m as tryHash, o as tryHashPassword, v as verifyPassword } from './export-55tHE0Bw.cjs';
 import 'node:crypto';

package/dist/web-api.d.ts

@@ -1,3 +1,3 @@
-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-Cb7IOrPo.js';
-export { u as convertBytesToStr, y as convertEncoding, r as convertStrToBytes, c as createSecretKey, f as decrypt, l as decryptObj, e as encrypt, j as encryptObj, g as generateUuid, n as hash, p as hashPassword, i as isWebSecretKey, s as tryConvertBytesToStr, x as tryConvertEncoding, q as tryConvertStrToBytes, a as tryCreateSecretKey, d as tryDecrypt, k as tryDecryptObj, b as tryEncrypt, h as tryEncryptObj, t as tryGenerateUuid, m as tryHash, o as tryHashPassword, v as verifyPassword } from './export-DGrELdz_.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 matchPattern, p as parseToObj, s as stringifyObj, t as tryParseToObj, a as tryStringifyObj } from './validate-EHuJC5QQ.js';
+export { u as convertBytesToStr, y as convertEncoding, r as convertStrToBytes, c as createSecretKey, f as decrypt, l as decryptObj, e as encrypt, j as encryptObj, g as generateUuid, n as hash, p as hashPassword, i as isWebSecretKey, s as tryConvertBytesToStr, x as tryConvertEncoding, q as tryConvertStrToBytes, a as tryCreateSecretKey, d as tryDecrypt, k as tryDecryptObj, b as tryEncrypt, h as tryEncryptObj, t as tryGenerateUuid, m as tryHash, o as tryHashPassword, v as verifyPassword } from './export-llM6c7Do.js';
 import 'node:crypto';

package/dist/web-api.js

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cipher-kit",
-  "version": "2.0.0-beta.4",
-  "description": "🔐 Secure, Lightweight, and Cross-Platform Encryption, Decryption, and Hashing for Web, Node.js, Deno, Bun, and Cloudflare Workers",
+  "version": "2.0.0",
+  "description": "🔐 Secure, Modern, and Cross-Platform Cryptography Helpers for Web, Node.js, Deno, Bun, and Cloudflare Workers",
   "homepage": "https://github.com/WolfieLeader/npm/tree/main/packages/cipher-kit#readme",
   "repository": {
     "type": "git",
@@ -87,6 +87,7 @@
     "deno",
     "bun",
     "cloudflare",
-    "workers"
+    "workers",
+    "password"
   ]
 }