cipher-kit 2.0.0 → 2.1.1

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

@@ -4,10 +4,27 @@ import nodeCrypto, { webcrypto } from 'node:crypto';
  * Standardized error object for the `Result` type.
  * Always has a brief `message` and a more detailed `description`.
  */
-interface ResultErr {
+interface ErrorStruct {
     readonly message: string;
     readonly description: string;
 }
+type ReservedWords<Obj extends object> = "success" extends keyof Obj ? never : "error" extends keyof Obj ? never : Obj;
+type OkType<T> = {
+    readonly success: true;
+    readonly error?: undefined;
+} & (T extends object ? ReservedWords<{
+    readonly [K in keyof T]: T[K];
+}> : {
+    readonly result: T;
+});
+type ErrType<T> = {
+    readonly success: false;
+    readonly error: ErrorStruct;
+} & (T extends object ? ReservedWords<{
+    readonly [K in keyof T]?: undefined;
+}> : {
+    readonly result?: undefined;
+});
 /**
  * Discriminated union for functions that can succeed or fail.
  *
@@ -34,25 +51,7 @@ interface ResultErr {
  * if (r2.success) console.log(r2.name, r2.age); // 'Alice' 30
  * ```
  */
-type Result<T, E = ResultErr> = T extends object ? ({
-    readonly [K in keyof T]: T[K];
-} & {
-    readonly success: true;
-    readonly error?: undefined;
-}) | ({
-    readonly [K in keyof T]?: undefined;
-} & {
-    readonly success: false;
-    readonly error: E;
-}) : {
-    readonly success: true;
-    readonly result: T;
-    readonly error?: undefined;
-} | {
-    readonly success: false;
-    readonly error: E;
-    readonly result?: undefined;
-};
+type Result<T> = OkType<T> | ErrType<T>;
 
 declare const ENCODING: readonly ["base64", "base64url", "hex", "utf8", "latin1"];
 declare const CIPHER_ENCODING: readonly ["base64", "base64url", "hex"];
@@ -131,10 +130,10 @@ type DigestAlgorithm = keyof typeof DIGEST_ALGORITHMS;
  * You can choose how strong the lock is (algorithm), how to make the key (digest),
  * and add some extra secret stuff (salt and info) to make your key unique.
  *
- * - `algorithm` (default: `'aes256gcm'`)
- * - `digest` (HKDF hash; default: `'sha256'`)
- * - `salt` (default: `'cipher-kit-salt'`, must be ≥ 8 chars)
- * - `info` (default: `'cipher-kit'`)
+ * - `algorithm`: Encryption algorithm to use (default: `'aes256gcm'`)
+ * - `digest`: Digest algorithm for HKDF (default: `'sha256'`)
+ * - `salt`: Salt for HKDF (default: `'cipher-kit-salt'`, must be ≥ 8 chars)
+ * - `info`: Added context for HKDF (default: `'cipher-kit'`)
  */
 interface CreateSecretKeyOptions {
     /** Encryption algorithm to use (default: `'aes256gcm'`). */
@@ -152,11 +151,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 +163,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 +177,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,16 +193,16 @@ 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'`)
- * - `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)
+ * - `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)
  */
 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,15 +218,15 @@ 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'`)
- * - `iterations`: number of iterations (default: `320000`)
- * - `keyLength`: length of the derived key in bytes (default: `64` bytes)
+ * - `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)
  */
 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 +249,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 +273,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 +291,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 +315,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 +360,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: "node" | "web" | "general"): 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/web-api.cjs

@@ -1,129 +1,129 @@
 'use strict';
 
-var chunkCVCDAHDW_cjs = require('./chunk-CVCDAHDW.cjs');
-var chunk3UX5MZ2P_cjs = require('./chunk-3UX5MZ2P.cjs');
+var chunkLTVOIZP5_cjs = require('./chunk-LTVOIZP5.cjs');
+var chunkX4CS7UXE_cjs = require('./chunk-X4CS7UXE.cjs');
 
 
 
 Object.defineProperty(exports, "convertBytesToStr", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.convertBytesToStr; }
+  get: function () { return chunkLTVOIZP5_cjs.convertBytesToStr; }
 });
 Object.defineProperty(exports, "convertEncoding", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.convertEncoding; }
+  get: function () { return chunkLTVOIZP5_cjs.convertEncoding; }
 });
 Object.defineProperty(exports, "convertStrToBytes", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.convertStrToBytes; }
+  get: function () { return chunkLTVOIZP5_cjs.convertStrToBytes; }
 });
 Object.defineProperty(exports, "createSecretKey", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.createSecretKey; }
+  get: function () { return chunkLTVOIZP5_cjs.createSecretKey; }
 });
 Object.defineProperty(exports, "decrypt", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.decrypt; }
+  get: function () { return chunkLTVOIZP5_cjs.decrypt; }
 });
 Object.defineProperty(exports, "decryptObj", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.decryptObj; }
+  get: function () { return chunkLTVOIZP5_cjs.decryptObj; }
 });
 Object.defineProperty(exports, "encrypt", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.encrypt; }
+  get: function () { return chunkLTVOIZP5_cjs.encrypt; }
 });
 Object.defineProperty(exports, "encryptObj", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.encryptObj; }
+  get: function () { return chunkLTVOIZP5_cjs.encryptObj; }
 });
 Object.defineProperty(exports, "generateUuid", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.generateUuid; }
+  get: function () { return chunkLTVOIZP5_cjs.generateUuid; }
 });
 Object.defineProperty(exports, "hash", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.hash; }
+  get: function () { return chunkLTVOIZP5_cjs.hash; }
 });
 Object.defineProperty(exports, "hashPassword", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.hashPassword; }
+  get: function () { return chunkLTVOIZP5_cjs.hashPassword; }
 });
 Object.defineProperty(exports, "isWebSecretKey", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.isWebSecretKey; }
+  get: function () { return chunkLTVOIZP5_cjs.isWebSecretKey; }
 });
 Object.defineProperty(exports, "tryConvertBytesToStr", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.tryConvertBytesToStr; }
+  get: function () { return chunkLTVOIZP5_cjs.tryConvertBytesToStr; }
 });
 Object.defineProperty(exports, "tryConvertEncoding", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.tryConvertEncoding; }
+  get: function () { return chunkLTVOIZP5_cjs.tryConvertEncoding; }
 });
 Object.defineProperty(exports, "tryConvertStrToBytes", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.tryConvertStrToBytes; }
+  get: function () { return chunkLTVOIZP5_cjs.tryConvertStrToBytes; }
 });
 Object.defineProperty(exports, "tryCreateSecretKey", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.tryCreateSecretKey; }
+  get: function () { return chunkLTVOIZP5_cjs.tryCreateSecretKey; }
 });
 Object.defineProperty(exports, "tryDecrypt", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.tryDecrypt; }
+  get: function () { return chunkLTVOIZP5_cjs.tryDecrypt; }
 });
 Object.defineProperty(exports, "tryDecryptObj", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.tryDecryptObj; }
+  get: function () { return chunkLTVOIZP5_cjs.tryDecryptObj; }
 });
 Object.defineProperty(exports, "tryEncrypt", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.tryEncrypt; }
+  get: function () { return chunkLTVOIZP5_cjs.tryEncrypt; }
 });
 Object.defineProperty(exports, "tryEncryptObj", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.tryEncryptObj; }
+  get: function () { return chunkLTVOIZP5_cjs.tryEncryptObj; }
 });
 Object.defineProperty(exports, "tryGenerateUuid", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.tryGenerateUuid; }
+  get: function () { return chunkLTVOIZP5_cjs.tryGenerateUuid; }
 });
 Object.defineProperty(exports, "tryHash", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.tryHash; }
+  get: function () { return chunkLTVOIZP5_cjs.tryHash; }
 });
 Object.defineProperty(exports, "tryHashPassword", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.tryHashPassword; }
+  get: function () { return chunkLTVOIZP5_cjs.tryHashPassword; }
 });
 Object.defineProperty(exports, "verifyPassword", {
   enumerable: true,
-  get: function () { return chunkCVCDAHDW_cjs.verifyPassword; }
+  get: function () { return chunkLTVOIZP5_cjs.verifyPassword; }
 });
 Object.defineProperty(exports, "ENCRYPTED_REGEX", {
   enumerable: true,
-  get: function () { return chunk3UX5MZ2P_cjs.ENCRYPTED_REGEX; }
+  get: function () { return chunkX4CS7UXE_cjs.ENCRYPTED_REGEX; }
 });
-Object.defineProperty(exports, "matchPattern", {
+Object.defineProperty(exports, "matchEncryptedPattern", {
   enumerable: true,
-  get: function () { return chunk3UX5MZ2P_cjs.matchPattern; }
+  get: function () { return chunkX4CS7UXE_cjs.matchEncryptedPattern; }
 });
 Object.defineProperty(exports, "parseToObj", {
   enumerable: true,
-  get: function () { return chunk3UX5MZ2P_cjs.parseToObj; }
+  get: function () { return chunkX4CS7UXE_cjs.parseToObj; }
 });
 Object.defineProperty(exports, "stringifyObj", {
   enumerable: true,
-  get: function () { return chunk3UX5MZ2P_cjs.stringifyObj; }
+  get: function () { return chunkX4CS7UXE_cjs.stringifyObj; }
 });
 Object.defineProperty(exports, "tryParseToObj", {
   enumerable: true,
-  get: function () { return chunk3UX5MZ2P_cjs.tryParseToObj; }
+  get: function () { return chunkX4CS7UXE_cjs.tryParseToObj; }
 });
 Object.defineProperty(exports, "tryStringifyObj", {
   enumerable: true,
-  get: function () { return chunk3UX5MZ2P_cjs.tryStringifyObj; }
+  get: function () { return chunkX4CS7UXE_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-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';
+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-cJEdGlj1.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-CpZ7s25O.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-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';
+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-cJEdGlj1.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-C4DbO5zM.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-4MFF6V3R.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, isWebSecretKey, tryConvertBytesToStr, tryConvertEncoding, tryConvertStrToBytes, tryCreateSecretKey, tryDecrypt, tryDecryptObj, tryEncrypt, tryEncryptObj, tryGenerateUuid, tryHash, tryHashPassword, verifyPassword } from './chunk-FSEA3UXJ.js';
+export { ENCRYPTED_REGEX, matchEncryptedPattern, parseToObj, stringifyObj, tryParseToObj, tryStringifyObj } from './chunk-6C4NIWQ4.js';
 //# sourceMappingURL=web-api.js.map
 //# sourceMappingURL=web-api.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cipher-kit",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "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": {
@@ -68,9 +68,9 @@
     "test": "vitest"
   },
   "devDependencies": {
-    "@types/node": "^24.5.2",
+    "@types/node": "^24.6.2",
     "tsup": "^8.5.0",
-    "typescript": "^5.9.2",
+    "typescript": "^5.9.3",
     "vitest": "^3.2.4"
   },
   "author": "WolfieLeader",
@@ -81,13 +81,12 @@
     "cipher",
     "security",
     "hash",
-    "aes",
+    "password",
+    "uuid",
     "web",
     "node",
     "deno",
     "bun",
-    "cloudflare",
-    "workers",
-    "password"
+    "cloudflare"
   ]
 }

package/dist/chunk-3UX5MZ2P.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/helpers/consts.ts","../src/helpers/validate.ts","../src/helpers/error.ts","../src/helpers/object.ts"],"names":["nodeCrypto","title"],"mappings":";;;;;;;;;;;;;;;AAAO,IAAM,QAAA,GAAW,OAAO,MAAA,CAAO,CAAC,UAAU,WAAA,EAAa,KAAA,EAAO,MAAA,EAAQ,QAAQ,CAAU;AAExF,IAAM,kBAAkB,MAAA,CAAO,MAAA,CAAO,CAAC,QAAA,EAAU,WAAA,EAAa,KAAK,CAAU;AAE7E,IAAM,iBAAA,GAAoB,OAAO,MAAA,CAAO;AAAA,EAC7C,MAAA,EAAQ,EAAE,IAAA,EAAM,QAAA,EAAU,KAAK,SAAA,EAAU;AAAA,EACzC,MAAA,EAAQ,EAAE,IAAA,EAAM,QAAA,EAAU,KAAK,SAAA,EAAU;AAAA,EACzC,MAAA,EAAQ,EAAE,IAAA,EAAM,QAAA,EAAU,KAAK,SAAA;AACjC,CAAU;AAEH,IAAM,qBAAA,GAAwB,OAAO,MAAA,CAAO;AAAA,EACjD,SAAA,EAAW,EAAE,QAAA,EAAU,EAAA,EAAI,UAAU,EAAA,EAAI,IAAA,EAAM,aAAA,EAAe,GAAA,EAAK,SAAA,EAAU;AAAA,EAC7E,SAAA,EAAW,EAAE,QAAA,EAAU,EAAA,EAAI,UAAU,EAAA,EAAI,IAAA,EAAM,aAAA,EAAe,GAAA,EAAK,SAAA,EAAU;AAAA,EAC7E,SAAA,EAAW,EAAE,QAAA,EAAU,EAAA,EAAI,UAAU,EAAA,EAAI,IAAA,EAAM,aAAA,EAAe,GAAA,EAAK,SAAA;AACrE,CAAU;;;ACVH,SAAS,MAAA,CAAO,CAAA,EAAY,GAAA,GAAM,CAAA,EAAgB;AACvD,EAAA,OAAO,CAAA,KAAM,IAAA,IAAQ,CAAA,KAAM,MAAA,IAAa,OAAO,MAAM,QAAA,IAAY,CAAA,CAAE,IAAA,EAAK,CAAE,MAAA,IAAU,GAAA;AACtF;AAEO,SAAS,OAAO,CAAA,EAA0C;AAC/D,EAAA,IAAI,OAAO,CAAA,KAAM,QAAA,IAAY,MAAM,IAAA,IAAQ,CAAA,KAAM,QAAW,OAAO,KAAA;AACnE,EAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,cAAA,CAAe,CAAC,CAAA;AACrC,EAAA,OAAO,KAAA,KAAU,MAAA,CAAO,SAAA,IAAa,KAAA,KAAU,IAAA;AACjD;AAEO,SAAS,YAAY,CAAA,EAA0C;AACpE,EAAA,OAAO,OAAO,CAAA,KAAM,QAAA,IAAY,CAAA,KAAM,QAAQ,CAAA,KAAM,MAAA;AACtD;AAMA,IAAM,YAAA,uBAAmB,GAAA,CAAI,CAAC,YAAY,QAAA,EAAU,WAAA,EAAa,KAAK,CAAC,CAAA;AAEhE,SAAS,YAAA,CACd,GACA,QAAA,EACoC;AACpC,EAAA,IAAI,CAAC,WAAA,CAAY,CAAC,CAAA,IAAM,QAAA,KAAa,MAAA,IAAU,QAAA,KAAa,KAAA,IAAU,CAAA,CAAE,QAAA,KAAa,QAAA,EAAU,OAAO,IAAA;AAEtG,EAAA,MAAM,IAAA,GAAO,MAAA,CAAO,IAAA,CAAK,CAAC,CAAA;AAC1B,EAAA,IAAI,IAAA,CAAK,MAAA,KAAW,YAAA,CAAa,IAAA,EAAM,OAAO,IAAA;AAC9C,EAAA,KAAA,MAAW,GAAA,IAAO,MAAM,IAAI,CAAC,aAAa,GAAA,CAAI,GAAG,GAAG,OAAO,IAAA;AAC3D,EAAA,KAAA,MAAW,GAAA,IAAO,cAAc,IAAI,CAAC,OAAO,MAAA,CAAO,CAAA,EAAG,GAAG,CAAA,EAAG,OAAO,IAAA;AAEnE,EAAA,IACE,OAAO,CAAA,CAAE,MAAA,KAAW,QAAA,IACpB,EAAE,EAAE,MAAA,IAAU,iBAAA,CAAA,IACd,OAAO,CAAA,CAAE,SAAA,KAAc,QAAA,IACvB,EAAE,CAAA,CAAE,SAAA,IAAa,qBAAA,CAAA,IACjB,CAAC,WAAA,CAAY,CAAA,CAAE,GAAG,CAAA,IAClB,CAAA,CAAE,GAAA,CAAI,IAAA,KAAS,QAAA,EACf;AACA,IAAA,OAAO,IAAA;AAAA,EACT;AAEA,EAAA,MAAM,SAAA,GAAY,qBAAA,CAAsB,CAAA,CAAE,SAA+C,CAAA;AAEzF,EAAA,IAAI,aAAa,MAAA,EAAQ;AACvB,IAAA,IACE,EAAE,CAAA,CAAE,GAAA,YAAeA,2BAAA,CAAW,cAC7B,OAAO,CAAA,CAAE,GAAA,CAAI,gBAAA,KAAqB,QAAA,IAAY,CAAA,CAAE,GAAA,CAAI,gBAAA,KAAqB,UAAU,QAAA,EACpF;AACA,MAAA,OAAO,IAAA;AAAA,IACT;AACA,IAAA,OAAO,OAAO,MAAA,CAAO,EAAE,GAAG,CAAA,EAAG,QAAA,EAAU,WAAW,CAAA;AAAA,EACpD;AAEA,EAAA,IACE,CAAC,WAAA,CAAY,CAAA,CAAE,GAAA,CAAI,SAAS,KAC5B,CAAA,CAAE,GAAA,CAAI,SAAA,CAAU,IAAA,KAAS,SAAA,CAAU,GAAA,IAClC,OAAO,CAAA,CAAE,GAAA,CAAI,SAAA,CAAU,MAAA,KAAW,QAAA,IAAY,CAAA,CAAE,GAAA,CAAI,SAAA,CAAU,MAAA,KAAW,SAAA,CAAU,QAAA,GAAW,CAAA,IAC/F,OAAO,CAAA,CAAE,IAAI,WAAA,KAAgB,SAAA,IAC7B,CAAC,KAAA,CAAM,OAAA,CAAQ,CAAA,CAAE,IAAI,MAAM,CAAA,IAC3B,CAAA,CAAE,GAAA,CAAI,MAAA,CAAO,MAAA,KAAW,KACxB,EAAE,CAAA,CAAE,GAAA,CAAI,MAAA,CAAO,QAAA,CAAS,SAAS,CAAA,IAAK,CAAA,CAAE,GAAA,CAAI,MAAA,CAAO,QAAA,CAAS,SAAS,CAAA,CAAA,EACrE;AACA,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,OAAO,MAAA,CAAO,EAAE,GAAG,CAAA,EAAG,QAAA,EAAU,WAAW,CAAA;AACpD;AAeO,IAAM,eAAA,GAAkB,OAAO,MAAA,CAAO;AAAA,EAC3C,IAAA,EAAM,+BAAA;AAAA,EACN,GAAA,EAAK,sBAAA;AAAA,EACL,OAAA,EAAS;AACX,CAAC;AA8BM,SAAS,YAAA,CAAa,MAAc,MAAA,EAA6C;AACtF,EAAA,IAAI,OAAO,IAAA,KAAS,QAAA,EAAU,OAAO,KAAA;AACrC,EAAA,IAAI,EAAE,UAAU,eAAA,CAAA,EAAkB,MAAM,IAAI,KAAA,CAAM,CAAA,gBAAA,EAAmB,MAAM,CAAA,CAAE,CAAA;AAC7E,EAAA,OAAO,eAAA,CAAgB,MAAM,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA;AAC1C;;;AC9EO,SAAS,IAAO,MAAA,EAAuB;AAC5C,EAAA,IAAI,MAAA,CAAO,MAAM,CAAA,EAAG,OAAO,EAAE,OAAA,EAAS,IAAA,EAAM,GAAI,MAAA,EAAsB;AACtE,EAAA,OAAO,EAAE,OAAA,EAAS,IAAA,EAAM,MAAA,EAAO;AACjC;AAIO,SAAS,KAAK,GAAA,EAA0E;AAC7F,EAAA,OAAO;AAAA,IACL,OAAA,EAAS,KAAA;AAAA,IACT,KAAA,EAAO;AAAA,MACL,OAAA,EAAS,KAAA,IAAS,GAAA,GAAM,GAAA,CAAI,MAAM,GAAA,CAAI,OAAA;AAAA,MACtC,WAAA,EAAa,MAAA,IAAU,GAAA,GAAM,GAAA,CAAI,OAAO,GAAA,CAAI;AAAA;AAC9C,GACF;AACF;AAEO,SAAS,UAAU,KAAA,EAAwB;AAChD,EAAA,IAAI,OAAO,KAAA,KAAU,QAAA,EAAU,OAAO,KAAA;AACtC,EAAA,IAAI,KAAA,YAAiB,KAAA,EAAO,OAAO,KAAA,CAAM,OAAA;AACzC,EAAA,OAAO,OAAO,KAAK,CAAA;AACrB;AAEO,SAAS,cAAc,GAAA,EAAoC;AAChE,EAAA,IAAI,CAAC,KAAK,OAAO,eAAA;AACjB,EAAA,OAAO,CAAA,EAAG,GAAA,CAAI,OAAO,CAAA,GAAA,EAAM,IAAI,WAAW,CAAA,CAAA;AAC5C;AAEO,SAAS,KAAA,CAAM,UAA0BC,MAAAA,EAAuB;AACrE,EAAA,OAAO,GAAG,QAAA,KAAa,KAAA,GAAQ,gBAAA,GAAmB,mBAAmB,MAAMA,MAAK,CAAA,CAAA;AAClF;;;ACxEO,SAAS,cAA0D,GAAA,EAAwB;AAChG,EAAA,IAAI;AACF,IAAA,IAAI,CAAC,MAAA,CAAO,GAAG,CAAA,EAAG,OAAO,IAAA,CAAK,EAAE,GAAA,EAAK,gBAAA,EAAkB,IAAA,EAAM,6BAAA,EAA+B,CAAA;AAC5F,IAAA,OAAO,GAAA,CAAI,IAAA,CAAK,SAAA,CAAU,GAAG,CAAC,CAAA;AAAA,EAChC,SAAS,KAAA,EAAO;AACd,IAAA,OAAO,IAAA,CAAK,EAAE,GAAA,EAAK,0BAAA,EAA4B,MAAM,SAAA,CAAU,KAAK,GAAG,CAAA;AAAA,EACzE;AACF;AA0BO,SAAS,gBAA4D,GAAA,EAAwB;AAClG,EAAA,OAAO,cAAc,GAAG,CAAA;AAC1B;AA0BO,SAAS,aAAyD,GAAA,EAAgB;AACvF,EAAA,MAAM,EAAE,MAAA,EAAQ,KAAA,EAAM,GAAI,cAAc,GAAG,CAAA;AAC3C,EAAA,IAAI,OAAO,MAAM,IAAI,KAAA,CAAM,aAAA,CAAc,KAAK,CAAC,CAAA;AAC/C,EAAA,OAAO,MAAA;AACT;AAEO,SAAS,YAAwD,GAAA,EAAoC;AAC1G,EAAA,IAAI;AACF,IAAA,IAAI,CAAC,MAAA,CAAO,GAAG,CAAA,EAAG,OAAO,IAAA,CAAK,EAAE,GAAA,EAAK,wBAAA,EAA0B,IAAA,EAAM,6BAAA,EAA+B,CAAA;AACpG,IAAA,MAAM,GAAA,GAAM,IAAA,CAAK,KAAA,CAAM,GAAG,CAAA;AAE1B,IAAA,IAAI,CAAC,MAAA,CAAO,GAAG,CAAA,EAAG,OAAO,IAAA,CAAK,EAAE,GAAA,EAAK,gCAAA,EAAkC,IAAA,EAAM,mCAAA,EAAqC,CAAA;AAClH,IAAA,OAAO,GAAA,CAAI,EAAE,MAAA,EAAQ,GAAA,EAAU,CAAA;AAAA,EACjC,SAAS,KAAA,EAAO;AACd,IAAA,OAAO,IAAA,CAAK,EAAE,GAAA,EAAK,yBAAA,EAA2B,MAAM,SAAA,CAAU,KAAK,GAAG,CAAA;AAAA,EACxE;AACF;AAwBO,SAAS,cAA0D,GAAA,EAAoC;AAC5G,EAAA,OAAO,YAAe,GAAG,CAAA;AAC3B;AAwBO,SAAS,WAAuD,GAAA,EAAgB;AACrF,EAAA,MAAM,EAAE,MAAA,EAAQ,KAAA,EAAM,GAAI,YAAe,GAAG,CAAA;AAC5C,EAAA,IAAI,OAAO,MAAM,IAAI,KAAA,CAAM,aAAA,CAAc,KAAK,CAAC,CAAA;AAC/C,EAAA,OAAO,MAAA;AACT","file":"chunk-3UX5MZ2P.cjs","sourcesContent":["export const ENCODING = Object.freeze([\"base64\", \"base64url\", \"hex\", \"utf8\", \"latin1\"] as const);\r\n\r\nexport const CIPHER_ENCODING = Object.freeze([\"base64\", \"base64url\", \"hex\"] as const);\r\n\r\nexport const DIGEST_ALGORITHMS = Object.freeze({\r\n  sha256: { node: \"sha256\", web: \"SHA-256\" },\r\n  sha384: { node: \"sha384\", web: \"SHA-384\" },\r\n  sha512: { node: \"sha512\", web: \"SHA-512\" },\r\n} as const);\r\n\r\nexport const ENCRYPTION_ALGORITHMS = Object.freeze({\r\n  aes256gcm: { keyBytes: 32, ivLength: 12, node: \"aes-256-gcm\", web: \"AES-GCM\" },\r\n  aes192gcm: { keyBytes: 24, ivLength: 12, node: \"aes-192-gcm\", web: \"AES-GCM\" },\r\n  aes128gcm: { keyBytes: 16, ivLength: 12, node: \"aes-128-gcm\", web: \"AES-GCM\" },\r\n} as const);\r\n","import nodeCrypto from \"node:crypto\";\r\nimport type { SecretKey } from \"~/helpers/types\";\r\nimport { DIGEST_ALGORITHMS, ENCRYPTION_ALGORITHMS } from \"./consts\";\r\n\r\nexport function $isStr(x: unknown, min = 1): x is string {\r\n  return x !== null && x !== undefined && typeof x === \"string\" && x.trim().length >= min;\r\n}\r\n\r\nexport function $isObj(x: unknown): x is Record<string, unknown> {\r\n  if (typeof x !== \"object\" || x === null || x === undefined) return false;\r\n  const proto = Object.getPrototypeOf(x);\r\n  return proto === Object.prototype || proto === null;\r\n}\r\n\r\nexport function $isLooseObj(x: unknown): x is Record<string, unknown> {\r\n  return typeof x === \"object\" && x !== null && x !== undefined;\r\n}\r\n\r\ntype InjectedSecretKey<Platform extends \"web\" | \"node\"> = SecretKey<Platform> & {\r\n  readonly injected: (typeof ENCRYPTION_ALGORITHMS)[keyof typeof ENCRYPTION_ALGORITHMS];\r\n};\r\n\r\nconst expectedKeys = new Set([\"platform\", \"digest\", \"algorithm\", \"key\"]);\r\n\r\nexport function $isSecretKey<Platform extends \"node\" | \"web\">(\r\n  x: unknown,\r\n  platform: Platform,\r\n): InjectedSecretKey<Platform> | null {\r\n  if (!$isLooseObj(x) || (platform !== \"node\" && platform !== \"web\") || x.platform !== platform) return null;\r\n\r\n  const keys = Object.keys(x);\r\n  if (keys.length !== expectedKeys.size) return null;\r\n  for (const key of keys) if (!expectedKeys.has(key)) return null;\r\n  for (const key of expectedKeys) if (!Object.hasOwn(x, key)) return null;\r\n\r\n  if (\r\n    typeof x.digest !== \"string\" ||\r\n    !(x.digest in DIGEST_ALGORITHMS) ||\r\n    typeof x.algorithm !== \"string\" ||\r\n    !(x.algorithm in ENCRYPTION_ALGORITHMS) ||\r\n    !$isLooseObj(x.key) ||\r\n    x.key.type !== \"secret\"\r\n  ) {\r\n    return null;\r\n  }\r\n\r\n  const algorithm = ENCRYPTION_ALGORITHMS[x.algorithm as keyof typeof ENCRYPTION_ALGORITHMS];\r\n\r\n  if (platform === \"node\") {\r\n    if (\r\n      !(x.key instanceof nodeCrypto.KeyObject) ||\r\n      (typeof x.key.symmetricKeySize === \"number\" && x.key.symmetricKeySize !== algorithm.keyBytes)\r\n    ) {\r\n      return null;\r\n    }\r\n    return Object.freeze({ ...x, injected: algorithm }) as InjectedSecretKey<Platform>;\r\n  }\r\n\r\n  if (\r\n    !$isLooseObj(x.key.algorithm) ||\r\n    x.key.algorithm.name !== algorithm.web ||\r\n    (typeof x.key.algorithm.length === \"number\" && x.key.algorithm.length !== algorithm.keyBytes * 8) ||\r\n    typeof x.key.extractable !== \"boolean\" ||\r\n    !Array.isArray(x.key.usages) ||\r\n    x.key.usages.length !== 2 ||\r\n    !(x.key.usages.includes(\"encrypt\") && x.key.usages.includes(\"decrypt\"))\r\n  ) {\r\n    return null;\r\n  }\r\n  return Object.freeze({ ...x, injected: algorithm }) as InjectedSecretKey<Platform>;\r\n}\r\n\r\n/**\r\n * Regular expressions for encrypted data patterns.\r\n *\r\n * - **node**: `\"iv.cipher.tag.\"` (three dot-separated parts plus a trailing dot)\r\n * - **web**: `\"iv.cipherWithTag.\"` (two parts plus a trailing dot)\r\n * - **general**: accepts both shapes (2 or 3 parts) with a trailing dot\r\n *\r\n * Each part is any non-empty string without dots.\r\n *\r\n * ### 🍼 Explain Like I'm Five\r\n * You have a secret code you want to check. Before you check it,\r\n * you make sure it looks how a secret code should look.\r\n */\r\nexport const ENCRYPTED_REGEX = Object.freeze({\r\n  node: /^([^.]+)\\.([^.]+)\\.([^.]+)\\.$/,\r\n  web: /^([^.]+)\\.([^.]+)\\.$/,\r\n  general: /^([^.]+)\\.([^.]+)(?:\\.([^.]+))?\\.$/,\r\n});\r\n\r\n/**\r\n * Checks if a string matches an expected encrypted payload shape.\r\n *\r\n * - **node**: `\"iv.cipher.tag.\"` (three dot-separated parts plus a trailing dot)\r\n * - **web**: `\"iv.cipherWithTag.\"` (two parts plus a trailing dot)\r\n * - **general**: accepts both shapes (2 or 3 parts) with a trailing dot\r\n *\r\n * Each part is any non-empty string without dots.\r\n *\r\n * This validates only the **shape**, not whether content is valid base64/hex, etc.\r\n *\r\n * ### 🍼 Explain Like I'm Five\r\n * You have a secret code you want to check. Before you check it,\r\n * you make sure it looks how a secret code should look.\r\n *\r\n * @param data - The string to test.\r\n * @param format - Which layout to check: `'node'`, `'web'`, or `'general'`.\r\n * @returns `true` if the string matches the pattern; otherwise `false`.\r\n * @throws {Error} If an unknown `format` is provided.\r\n *\r\n * @example\r\n * ```ts\r\n * matchPattern(\"abc.def.ghi.\", \"node\");    // true\r\n * matchPattern(\"abc.def.\", \"web\");         // true\r\n * matchPattern(\"abc.def.\", \"node\");        // false\r\n * matchPattern(\"abc.def.ghi.\", \"general\"); // true\r\n * ```\r\n */\r\nexport function matchPattern(data: string, format: \"general\" | \"node\" | \"web\"): boolean {\r\n  if (typeof data !== \"string\") return false;\r\n  if (!(format in ENCRYPTED_REGEX)) throw new Error(`Unknown format: ${format}`);\r\n  return ENCRYPTED_REGEX[format].test(data);\r\n}\r\n","import { $isObj } from \"./validate\";\r\n\r\n/**\r\n * Standardized error object for the `Result` type.\r\n * Always has a brief `message` and a more detailed `description`.\r\n */\r\nexport interface ResultErr {\r\n  readonly message: string;\r\n  readonly description: string;\r\n}\r\n\r\n/**\r\n * Discriminated union for functions that can succeed or fail.\r\n *\r\n * - On **success**:\r\n *   - If `T` is an object - properties of `T` are **spread** into the result\r\n *     along with `success: true`.\r\n *   - Otherwise - `{ success: true, result: T }`.\r\n * - On **failure**: `{ success: false, error: E }`.\r\n *\r\n * @example\r\n * ```ts\r\n * // Primitive result\r\n * function getNum(): Result<number> {\r\n *   return $ok(42);\r\n * }\r\n * const r1 = getNum();\r\n * if (r1.success) console.log(r1.result); // 42\r\n *\r\n * // Object result (spread)\r\n * function getObject(): Result<{ name: string; age: number }> {\r\n *   return $ok({ name: 'Alice', age: 30 });\r\n * }\r\n * const r2 = getObject();\r\n * if (r2.success) console.log(r2.name, r2.age); // 'Alice' 30\r\n * ```\r\n */\r\nexport type Result<T, E = ResultErr> = T extends object\r\n  ?\r\n      | ({ readonly [K in keyof T]: T[K] } & { readonly success: true; readonly error?: undefined })\r\n      | ({ readonly [K in keyof T]?: undefined } & { readonly success: false; readonly error: E })\r\n  :\r\n      | { readonly success: true; readonly result: T; readonly error?: undefined }\r\n      | { readonly success: false; readonly error: E; readonly result?: undefined };\r\n\r\nexport function $ok<T>(result?: T): Result<T> {\r\n  if ($isObj(result)) return { success: true, ...(result as T & object) } as Result<T>;\r\n  return { success: true, result } as Result<T>;\r\n}\r\n\r\nexport function $err(err: { msg: string; desc: string }): Result<never, ResultErr>;\r\nexport function $err(err: ResultErr): Result<never, ResultErr>;\r\nexport function $err(err: { msg: string; desc: string } | ResultErr): Result<never, ResultErr> {\r\n  return {\r\n    success: false,\r\n    error: {\r\n      message: \"msg\" in err ? err.msg : err.message,\r\n      description: \"desc\" in err ? err.desc : err.description,\r\n    },\r\n  } as Result<never, ResultErr>;\r\n}\r\n\r\nexport function $fmtError(error: unknown): string {\r\n  if (typeof error === \"string\") return error;\r\n  if (error instanceof Error) return error.message;\r\n  return String(error);\r\n}\r\n\r\nexport function $fmtResultErr(err: ResultErr | undefined): string {\r\n  if (!err) return \"Unknown error\";\r\n  return `${err.message} - ${err.description}`;\r\n}\r\n\r\nexport function title(platform: \"web\" | \"node\", title: string): string {\r\n  return `${platform === \"web\" ? \"Crypto Web API\" : \"Crypto NodeJS API\"} - ${title}`;\r\n}\r\n","import { $err, $fmtError, $fmtResultErr, $ok, type Result } from \"./error\";\r\nimport { $isObj, $isStr } from \"./validate\";\r\n\r\nexport function $stringifyObj<T extends object = Record<string, unknown>>(obj: T): Result<string> {\r\n  try {\r\n    if (!$isObj(obj)) return $err({ msg: \"Invalid object\", desc: \"Input is not a plain object\" });\r\n    return $ok(JSON.stringify(obj));\r\n  } catch (error) {\r\n    return $err({ msg: \"Utility: Stringify error\", desc: $fmtError(error) });\r\n  }\r\n}\r\n\r\n/**\r\n * Safely serializes a plain object to JSON without throwing.\r\n *\r\n * Wraps `JSON.stringify` and returns a `Result` containing the JSON string or an error.\r\n * Only plain objects (POJOs) are accepted. Class instances, Maps, Sets, etc. are rejected.\r\n *\r\n * ### 🍼 Explain Like I'm Five\r\n * You have a box of toys (your object) and take a photo of it (a JSON string)\r\n * so you can send it to a friend.\r\n *\r\n * @template T - Plain object type to serialize.\r\n * @param obj - The object to stringify (must be a plain object).\r\n * @returns A `Result` with the JSON string on success, or an error.\r\n *\r\n * @example\r\n * ```ts\r\n * const res = tryStringifyObj({ a: 1 });\r\n * if (res.success) {\r\n *   console.log(res.result); // {\"a\":1}\r\n * } else {\r\n *   console.error(res.error.message, res.error.description);\r\n * }\r\n * ```\r\n */\r\nexport function tryStringifyObj<T extends object = Record<string, unknown>>(obj: T): Result<string> {\r\n  return $stringifyObj(obj);\r\n}\r\n\r\n/**\r\n * Serializes a plain object to JSON (throwing).\r\n *\r\n * Wraps `JSON.stringify` and returns the result or throws an error.\r\n * Only plain objects (POJOs) are accepted. Class instances, Maps, Sets, etc. are rejected.\r\n *\r\n * ### 🍼 Explain Like I'm Five\r\n * You have a box of toys (your object) and take a photo of it (a JSON string)\r\n * so you can send it to a friend.\r\n *\r\n * @template T - Plain object type to serialize.\r\n * @param obj - The object to stringify (must be a plain object).\r\n * @returns JSON string representation of the object.\r\n * @throws {Error} If `obj` is not a plain object or serialization fails.\r\n *\r\n * @example\r\n * ```ts\r\n * try {\r\n * const json = stringifyObj({ a: 1 }); // {\"a\":1}\r\n * } catch (error: unknown) {\r\n *   console.error(error);\r\n * }\r\n * ```\r\n */\r\nexport function stringifyObj<T extends object = Record<string, unknown>>(obj: T): string {\r\n  const { result, error } = $stringifyObj(obj);\r\n  if (error) throw new Error($fmtResultErr(error));\r\n  return result;\r\n}\r\n\r\nexport function $parseToObj<T extends object = Record<string, unknown>>(str: string): Result<{ result: T }> {\r\n  try {\r\n    if (!$isStr(str)) return $err({ msg: \"Utility: Invalid input\", desc: \"Input is not a valid string\" });\r\n    const obj = JSON.parse(str);\r\n\r\n    if (!$isObj(obj)) return $err({ msg: \"Utility: Invalid object format\", desc: \"Parsed data is not a plain object\" });\r\n    return $ok({ result: obj as T });\r\n  } catch (error) {\r\n    return $err({ msg: \"Utility: Invalid format\", desc: $fmtError(error) });\r\n  }\r\n}\r\n\r\n/**\r\n * Safely parses a JSON string to a plain object (non-throwing).\r\n *\r\n * Wraps `JSON.parse` and returns a `Result` containing the parsed object, or an error.\r\n *\r\n * ### 🍼 Explain Like I'm Five\r\n * You rebuild your toy box (an object) from a photo you took (a JSON string).\r\n *\r\n * @template T - The expected object type.\r\n * @param str - The JSON string to parse.\r\n * @returns A `Result` with the parsed object on success, or an error.\r\n *\r\n * @example\r\n * ```ts\r\n * const res = tryParseToObj<{ a: number }>('{\"a\":1}');\r\n * if (res.success) {\r\n *   console.log(res.result.a); // 1\r\n * } else {\r\n *   console.error(res.error.message, res.error.description);\r\n * }\r\n * ```\r\n */\r\nexport function tryParseToObj<T extends object = Record<string, unknown>>(str: string): Result<{ result: T }> {\r\n  return $parseToObj<T>(str);\r\n}\r\n\r\n/**\r\n * Parses a JSON string to a plain object (throwing).\r\n *\r\n * Wraps `JSON.parse` and returns the parsed object, or throws on failure.\r\n *\r\n * ### 🍼 Explain Like I'm Five\r\n * You rebuild your toy box (an object) from a photo you took (a JSON string).\r\n *\r\n * @template T - The expected object type.\r\n * @param str - The JSON string to parse.\r\n * @returns The parsed plain object.\r\n * @throws {Error} If the string can’t be parsed or doesn’t represent a plain object.\r\n *\r\n * @example\r\n * ```ts\r\n * try {\r\n *   const obj = parseToObj<{ a: number }>('{\"a\":1}'); // obj.a === 1\r\n * } catch (error: unknown) {\r\n *   console.error(error);\r\n * }\r\n * ```\r\n */\r\nexport function parseToObj<T extends object = Record<string, unknown>>(str: string): T {\r\n  const { result, error } = $parseToObj<T>(str);\r\n  if (error) throw new Error($fmtResultErr(error));\r\n  return result;\r\n}\r\n"]}