@kikiutils/shared 15.0.0 → 15.0.2

package/README.md

@@ -9,8 +9,6 @@ A lightweight and modular utility library for modern JavaScript and TypeScript
 
 - [✨ Release Notes](./CHANGELOG.md)
 
-TODO: update README
-
 ## Features
 
 - 📋 Clipboard utilities — copy text and blobs using the modern Clipboard API (Browser only)
@@ -47,17 +45,58 @@ You can also use `yarn`, `npm`, or `bun`.
 >
 > If a utility depends on a third-party package (e.g. `date-fns`), you must install it manually.
 
-## Usage
+## Modules
 
-Import the functions or modules you want to use:
+```
+src/
+├── classes/           # Class-based utilities
+│   ├── path.ts        # Path manipulation
+│   ├── precision-number.ts # Decimal.js wrapper
+│   └── ssh-client.ts  # SSH client
+│
+├── storages/
+│   ├── lru/keyed-store.ts    # LRU cache wrapper
+│   └── redis/
+│       ├── keyed-store.ts     # Redis keyed store
+│       ├── msgpack.ts         # Redis + msgpack
+│       └── types.ts           # Storage interfaces
+│
+└── *.ts              # Utility functions (see table)
+```
+
+| File | Description |
+|------|-------------|
+| `buffer.ts` | Binary → Node.js Buffer |
+| `clipboard.ts` | Clipboard API (browser) |
+| `consola.ts` | Consola logger |
+| `crypto-hash.ts` | MD5, SHA3 (Node) |
+| `datetime.ts` | date-fns wrappers |
+| `element-plus.ts` | Element Plus form rules |
+| `enum.ts` | Enum value extractors |
+| `env.ts` | Env var accessor |
+| `event-awaiter.ts` | Async event wait |
+| `general.ts` | extractFirstValue |
+| `hash.ts` | SHA3 (browser) |
+| `math.ts` | toPercentageString |
+| `number.ts` | toCompactNumberString |
+| `object.ts` | deterministic stringify |
+| `pino.ts` | Pino logger |
+| `random.ts` | nested random length |
+| `string.ts` | randomString |
+| `time.ts` | abortableDelay |
+| `url.ts` | redirect param |
+| `vue.ts` | Vue composables |
+| `web.ts` | Web DOM helpers |
+
+## Usage
 
 ```typescript
-import { logger } from '@kikituils/shared/consola';
-import { extractFirstValue } from '@kikituils/shared/general';
+import { logger } from '@kikiutils/shared/consola';
+import { extractFirstValue } from '@kikiutils/shared/general';
 
 const data = [
     0,
-    1
+    1,
 ];
 
 const value = extractFirstValue(data);
@@ -65,118 +104,6 @@ console.log(value); // 0
 logger.info(value);
 ```
 
-## Modules & Functions
-
-Each module file includes function-level comments and usage examples.
-
-### [buffer](./src/buffer.ts)
-
-- `toBuffer`
-
-### [clipboard](./src/clipboard.ts)
-
-- `copyBlobToClipboard`
-- `copyTextToClipboard`
-
-### [consola](./src/consola.ts)
-
-Console logger integration.
-
-### [crypto-hash](./src/crypto-hash.ts)
-
-- `cryptoMd5`, `cryptoMd5ToBuffer`
-- `cryptoSha3224`, `cryptoSha3224ToBuffer`
-- `cryptoSha3256`, `cryptoSha3256ToBuffer`
-- `cryptoSha3384`, `cryptoSha3384ToBuffer`
-- `cryptoSha3512`, `cryptoSha3512ToBuffer`
-
-### [datetime](./src/datetime.ts)
-
-- `formatDate`
-- `getDateRangeFromDate`
-- `getMidnightDateFromToday`
-
-### [element-plus](./src/element-plus.ts)
-
-- `createElFormItemRuleWithDefaults`
-
-### [enum](./src/enum.ts)
-
-- `getEnumStringValues`
-- `getEnumNumberValues`
-- `getEnumValues`
-
-### [env](./src/env.ts)
-
-- `checkAndGetEnvValue`
-
-### [general](./src/general.ts)
-
-- `extractFirstValue`
-
-### [hash](./src/hash.ts)
-
-- `sha3224`
-- `sha3256`
-- `sha3384`
-- `sha3512`
-
-### [math](./src/math.ts)
-
-- `toPercentageString`
-
-### [number](./src/number.ts)
-
-- `toCompactNumberString`
-
-### [object](./src/object.ts)
-
-- `stringifyObjectDeterministically`
-
-### [pino](./src/pino.ts)
-
-Pino logger integration.
-
-### [random](./src/random.ts)
-
-- `generateWithNestedRandomLength`
-
-### storage
-
-#### [enhanced-local](./src/storage/enhanced/local/index.ts)
-
-- `createKeyedEnhancedLocalStore`
-- `enhancedLocalStorage`
-
-#### [enhanced-redis](./src/storage/enhanced/redis/index.ts)
-
-- `createEnhancedRedisStorage`
-- `createKeyedEnhancedRedisStore`
-
-#### [lru/keyed-store](./src/storage/lru/keyed-store.ts)
-
-- `createKeyedLruStore`
-
-### [string](./src/string.ts)
-
-- `randomString`
-
-### [url](./src/url.ts)
-
-- `appendRedirectParamToUrl`
-
-### [vue](./src/vue.ts)
-
-- `appendRedirectParamFromCurrentRouteToUrl`
-- `clearIntervalRef`
-- `clearTimeoutRef`
-- `usePreserveScroll`
-
-### [web](./src/web.ts)
-
-- `appendRedirectParamFromCurrentLocationToUrl`
-- `assignUrlWithRedirectParamFromCurrentLocation`
-
 ## License
 
 [MIT License](./LICENSE)

package/dist/classes/ssh-client.d.ts

@@ -1,6 +1,6 @@
 import { Nullable } from "../types/index.js";
 import { PathLike } from "./path.js";
-import * as node_ssh0 from "node-ssh";
+import * as _$node_ssh0 from "node-ssh";
 import { Config, NodeSSH, SSHExecCommandOptions, SSHGetPutDirectoryOptions, SSHPutFilesOptions } from "node-ssh";
 import { SFTPWrapper, TransferOptions } from "ssh2";
 
@@ -22,8 +22,8 @@ declare class SshClient {
   get nodeSsh(): NodeSSH;
   connect(): Promise<boolean>;
   disconnect(): boolean;
-  execCommand(command: string, options?: SSHExecCommandOptions): Promise<void | node_ssh0.SSHExecCommandResponse>;
-  execCommandWithIo(command: string, options?: SSHExecCommandOptions): Promise<void | node_ssh0.SSHExecCommandResponse>;
+  execCommand(command: string, options?: SSHExecCommandOptions): Promise<void | _$node_ssh0.SSHExecCommandResponse>;
+  execCommandWithIo(command: string, options?: SSHExecCommandOptions): Promise<void | _$node_ssh0.SSHExecCommandResponse>;
   getDir: (localDirectory: PathLike, remoteDirectory: PathLike, options?: SSHGetPutDirectoryOptions) => Promise<boolean>;
   getDirectory(localDirectory: PathLike, remoteDirectory: PathLike, options?: SSHGetPutDirectoryOptions): Promise<boolean>;
   getFile(localFile: PathLike, remoteFile: PathLike, givenSftp?: Nullable<SFTPWrapper>, transferOptions?: Nullable<TransferOptions>): Promise<boolean>;

package/dist/classes/ssh-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ssh-client.d.ts","names":[],"sources":["../../src/classes/ssh-client.ts"],"mappings":";;;;;;;cAkBM,qCAAA;EAAA;;;;;;;;;;cAYO,SAAA;EAAA;cAMG,IAAA,UAAc,QAAA,UAAkB,QAAA,UAAkB,IAAA,WAAmB,aAAA,GAAgB,MAAA;EAAA,IAc7F,OAAA,CAAA,GAAO,OAAA;EAIL,OAAA,CAAA,GAAO,OAAA;EAUb,UAAA,CAAA;EAUA,WAAA,CAAY,OAAA,UAAiB,OAAA,GAAU,qBAAA,GAAqB,OAAA,QAAA,SAAA,CAAA,sBAAA;EAI5D,iBAAA,CAAkB,OAAA,UAAiB,OAAA,GAAU,qBAAA,GAAqB,OAAA,QAAA,SAAA,CAAA,sBAAA;EAWlE,MAAA,GAAM,cAAA,EAE6B,QAAA,EAAQ,eAAA,EAAmB,QAAA,EAAQ,OAAA,GAAY,yBAAA,KAAyB,OAAA;EAArG,YAAA,CAAa,cAAA,EAAgB,QAAA,EAAU,eAAA,EAAiB,QAAA,EAAU,OAAA,GAAU,yBAAA,GAAyB,OAAA;EASrG,OAAA,CACF,SAAA,EAAW,QAAA,EACX,UAAA,EAAY,QAAA,EACZ,SAAA,GAAY,QAAA,CAAS,WAAA,GACrB,eAAA,GAAkB,QAAA,CAAS,eAAA,IAAgB,OAAA;EAW/C,WAAA,CAAA;EAIM,KAAA,CAAM,IAAA,EAAM,QAAA,GAAQ,OAAA;EAU1B,MAAA,GAAM,cAAA,EAE6B,QAAA,EAAQ,eAAA,EAAmB,QAAA,EAAQ,OAAA,GAAY,yBAAA,KAAyB,OAAA;EAArG,YAAA,CAAa,cAAA,EAAgB,QAAA,EAAU,eAAA,EAAiB,QAAA,EAAU,OAAA,GAAU,yBAAA,GAAyB,OAAA;EASrG,OAAA,CACF,SAAA,EAAW,QAAA,EACX,UAAA,EAAY,QAAA,EACZ,SAAA,GAAY,QAAA,CAAS,WAAA,GACrB,eAAA,GAAkB,QAAA,CAAS,eAAA,IAAgB,OAAA;EAWzC,QAAA,CAAS,KAAA;IAAS,KAAA,EAAO,QAAA;IAAU,MAAA,EAAQ,QAAA;EAAA,KAAc,OAAA,GAAU,kBAAA,GAAkB,OAAA;EAe3F,cAAA,CAAe,KAAA,eAAoB,qCAAA;AAAA"}
+{"version":3,"file":"ssh-client.d.ts","names":[],"sources":["../../src/classes/ssh-client.ts"],"mappings":";;;;;;;cAkBM,qCAAA;EAAA;;;;;;;;;;cAYO,SAAA;EAAA;cAMG,IAAA,UAAc,QAAA,UAAkB,QAAA,UAAkB,IAAA,WAAmB,aAAA,GAAgB,MAAA;EAAA,IAc7F,OAAA,CAAA,GAAO,OAAA;EAIL,OAAA,CAAA,GAAO,OAAA;EAUb,UAAA,CAAA;EAUA,WAAA,CAAY,OAAA,UAAiB,OAAA,GAAU,qBAAA,GAAqB,OAAA,QAAA,WAAA,CAAA,sBAAA;EAI5D,iBAAA,CAAkB,OAAA,UAAiB,OAAA,GAAU,qBAAA,GAAqB,OAAA,QAAA,WAAA,CAAA,sBAAA;EAWlE,MAAA,GAAM,cAAA,EAE6B,QAAA,EAAQ,eAAA,EAAmB,QAAA,EAAQ,OAAA,GAAY,yBAAA,KAAyB,OAAA;EAArG,YAAA,CAAa,cAAA,EAAgB,QAAA,EAAU,eAAA,EAAiB,QAAA,EAAU,OAAA,GAAU,yBAAA,GAAyB,OAAA;EASrG,OAAA,CACF,SAAA,EAAW,QAAA,EACX,UAAA,EAAY,QAAA,EACZ,SAAA,GAAY,QAAA,CAAS,WAAA,GACrB,eAAA,GAAkB,QAAA,CAAS,eAAA,IAAgB,OAAA;EAW/C,WAAA,CAAA;EAIM,KAAA,CAAM,IAAA,EAAM,QAAA,GAAQ,OAAA;EAU1B,MAAA,GAAM,cAAA,EAE6B,QAAA,EAAQ,eAAA,EAAmB,QAAA,EAAQ,OAAA,GAAY,yBAAA,KAAyB,OAAA;EAArG,YAAA,CAAa,cAAA,EAAgB,QAAA,EAAU,eAAA,EAAiB,QAAA,EAAU,OAAA,GAAU,yBAAA,GAAyB,OAAA;EASrG,OAAA,CACF,SAAA,EAAW,QAAA,EACX,UAAA,EAAY,QAAA,EACZ,SAAA,GAAY,QAAA,CAAS,WAAA,GACrB,eAAA,GAAkB,QAAA,CAAS,eAAA,IAAgB,OAAA;EAWzC,QAAA,CAAS,KAAA;IAAS,KAAA,EAAO,QAAA;IAAU,MAAA,EAAQ,QAAA;EAAA,KAAc,OAAA,GAAU,kBAAA,GAAkB,OAAA;EAe3F,cAAA,CAAe,KAAA,eAAoB,qCAAA;AAAA"}

package/dist/consola.d.ts

@@ -1,4 +1,4 @@
-import * as consola from "consola";
+import * as _$consola from "consola";
 
 //#region src/consola.d.ts
 /**
@@ -22,8 +22,8 @@ import * as consola from "consola";
  * logger.level = 3;
  * ```
  */
-declare const consolaLogger: consola.ConsolaInstance;
-declare const logger: consola.ConsolaInstance;
+declare const consolaLogger: _$consola.ConsolaInstance;
+declare const logger: _$consola.ConsolaInstance;
 //#endregion
 export { consolaLogger, logger };
 //# sourceMappingURL=consola.d.ts.map

package/dist/consola.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"consola.d.ts","names":[],"sources":["../src/consola.ts"],"mappings":";;;;;;AAuBA;;;;;AACA;;;;;;;;;;;;;cADa,aAAA,EAA+B,OAAA,CAAlB,eAAA;AAAA,cACb,MAAA,EAAsB,OAAA,CAAhB,eAAA"}
+{"version":3,"file":"consola.d.ts","names":[],"sources":["../src/consola.ts"],"mappings":";;;;;;AAuBA;;;;;AACA;;;;;;;;;;;;;cADa,aAAA,EAA+B,SAAA,CAAlB,eAAA;AAAA,cACb,MAAA,EAAsB,SAAA,CAAhB,eAAA"}

package/dist/crypto-hash.d.ts

@@ -1,15 +1,160 @@
 import { BinaryLike, BinaryToTextEncoding } from "node:crypto";
 
 //#region src/crypto-hash.d.ts
+/**
+ * Computes the MD5 hash of the given data.
+ *
+ * @param {BinaryLike} data - The input data to hash
+ * @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+ *
+ * @returns {string | Buffer} The hash digest in the specified encoding
+ *
+ * @example
+ * ```typescript
+ * import { cryptoMd5 } from '@kikiutils/shared/crypto-hash';
+ *
+ * console.log(cryptoMd5('test')); // 33ed9a05a10b21f0...
+ * ```
+ */
 declare function cryptoMd5(data: BinaryLike, outputEncoding?: BinaryToTextEncoding): string;
+/**
+ * Computes the MD5 hash of the given data and returns the raw buffer.
+ *
+ * @param {BinaryLike} data - The input data to hash
+ *
+ * @returns {Buffer} The raw hash digest as a Buffer
+ *
+ * @example
+ * ```typescript
+ * import { cryptoMd5ToBuffer } from '@kikiutils/shared/crypto-hash';
+ *
+ * console.log(cryptoMd5ToBuffer('test')); // <Buffer 33 ed 9a ...>
+ * ```
+ */
 declare function cryptoMd5ToBuffer(data: BinaryLike): NonSharedBuffer;
+/**
+ * Computes the SHA-3 hash of the given data using the 224-bit digest.
+ *
+ * @param {BinaryLike} data - The input data to hash
+ * @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+ *
+ * @returns {string | Buffer} The hash digest in the specified encoding
+ *
+ * @example
+ * ```typescript
+ * import { cryptoSha3224 } from '@kikiutils/shared/crypto-hash';
+ *
+ * console.log(cryptoSha3224('test')); // 0qW8FoqDcFmkpuqR9J3uT8YX...
+ * ```
+ */
 declare function cryptoSha3224(data: BinaryLike, outputEncoding?: BinaryToTextEncoding): string;
+/**
+ * Computes the SHA-3 hash of the given data using the 224-bit digest and returns the raw buffer.
+ *
+ * @param {BinaryLike} data - The input data to hash
+ *
+ * @returns {Buffer} The raw hash digest as a Buffer
+ *
+ * @example
+ * ```typescript
+ * import { cryptoSha3224ToBuffer } from '@kikiutils/shared/crypto-hash';
+ *
+ * console.log(cryptoSha3224ToBuffer('test')); // <Buffer 0q W8 Fo ...>
+ * ```
+ */
 declare function cryptoSha3224ToBuffer(data: BinaryLike): NonSharedBuffer;
+/**
+ * Computes the SHA-3 hash of the given data using the 256-bit digest.
+ *
+ * @param {BinaryLike} data - The input data to hash
+ * @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+ *
+ * @returns {string | Buffer} The hash digest in the specified encoding
+ *
+ * @example
+ * ```typescript
+ * import { cryptoSha3256 } from '@kikiutils/shared/crypto-hash';
+ *
+ * console.log(cryptoSha3256('test')); // 36f028580bb02cc8272a9a020f4200e346e276ae664e45ee80745574e2f5ab80
+ * ```
+ */
 declare function cryptoSha3256(data: BinaryLike, outputEncoding?: BinaryToTextEncoding): string;
+/**
+ * Computes the SHA-3 hash of the given data using the 256-bit digest and returns the raw buffer.
+ *
+ * @param {BinaryLike} data - The input data to hash
+ *
+ * @returns {Buffer} The raw hash digest as a Buffer
+ *
+ * @example
+ * ```typescript
+ * import { cryptoSha3256ToBuffer } from '@kikiutils/shared/crypto-hash';
+ *
+ * console.log(cryptoSha3256ToBuffer('test')); // <Buffer 36 f0 28 ...>
+ * ```
+ */
 declare function cryptoSha3256ToBuffer(data: BinaryLike): NonSharedBuffer;
+/**
+ * Computes the SHA-3 hash of the given data using the 384-bit digest.
+ *
+ * @param {BinaryLike} data - The input data to hash
+ * @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+ *
+ * @returns {string | Buffer} The hash digest in the specified encoding
+ *
+ * @example
+ * ```typescript
+ * import { cryptoSha3384 } from '@kikiutils/shared/crypto-hash';
+ *
+ * console.log(cryptoSha3384('test')); // 1Q2wQAYaZ4o8vWX5bEB2n3Y...
+ * ```
+ */
 declare function cryptoSha3384(data: BinaryLike, outputEncoding?: BinaryToTextEncoding): string;
+/**
+ * Computes the SHA-3 hash of the given data using the 384-bit digest and returns the raw buffer.
+ *
+ * @param {BinaryLike} data - The input data to hash
+ *
+ * @returns {Buffer} The raw hash digest as a Buffer
+ *
+ * @example
+ * ```typescript
+ * import { cryptoSha3384ToBuffer } from '@kikiutils/shared/crypto-hash';
+ *
+ * console.log(cryptoSha3384ToBuffer('test')); // <Buffer 1Q 2w QZ ...>
+ * ```
+ */
 declare function cryptoSha3384ToBuffer(data: BinaryLike): NonSharedBuffer;
+/**
+ * Computes the SHA-3 hash of the given data using the 512-bit digest.
+ *
+ * @param {BinaryLike} data - The input data to hash
+ * @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+ *
+ * @returns {string | Buffer} The hash digest in the specified encoding
+ *
+ * @example
+ * ```typescript
+ * import { cryptoSha3512 } from '@kikiutils/shared/crypto-hash';
+ *
+ * console.log(cryptoSha3512('test')); // b_NQJ8FJBY9dIjm1q7...
+ * ```
+ */
 declare function cryptoSha3512(data: BinaryLike, outputEncoding?: BinaryToTextEncoding): string;
+/**
+ * Computes the SHA-3 hash of the given data using the 512-bit digest and returns the raw buffer.
+ *
+ * @param {BinaryLike} data - The input data to hash
+ *
+ * @returns {Buffer} The raw hash digest as a Buffer
+ *
+ * @example
+ * ```typescript
+ * import { cryptoSha3512ToBuffer } from '@kikiutils/shared/crypto-hash';
+ *
+ * console.log(cryptoSha3512ToBuffer('test')); // <Buffer b_ NQ ...>
+ * ```
+ */
 declare function cryptoSha3512ToBuffer(data: BinaryLike): NonSharedBuffer;
 //#endregion
 export { cryptoMd5, cryptoMd5ToBuffer, cryptoSha3224, cryptoSha3224ToBuffer, cryptoSha3256, cryptoSha3256ToBuffer, cryptoSha3384, cryptoSha3384ToBuffer, cryptoSha3512, cryptoSha3512ToBuffer };

package/dist/crypto-hash.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"crypto-hash.d.ts","names":[],"sources":["../src/crypto-hash.ts"],"mappings":";;;iBAsBgB,SAAA,CAAU,IAAA,EAAM,UAAA,EAAY,cAAA,GAAgB,oBAAA;AAAA,iBAI5C,iBAAA,CAAkB,IAAA,EAAM,UAAA,GAAU,eAAA;AAAA,iBAIlC,aAAA,CAAc,IAAA,EAAM,UAAA,EAAY,cAAA,GAAgB,oBAAA;AAAA,iBAIhD,qBAAA,CAAsB,IAAA,EAAM,UAAA,GAAU,eAAA;AAAA,iBAItC,aAAA,CAAc,IAAA,EAAM,UAAA,EAAY,cAAA,GAAgB,oBAAA;AAAA,iBAIhD,qBAAA,CAAsB,IAAA,EAAM,UAAA,GAAU,eAAA;AAAA,iBAItC,aAAA,CAAc,IAAA,EAAM,UAAA,EAAY,cAAA,GAAgB,oBAAA;AAAA,iBAIhD,qBAAA,CAAsB,IAAA,EAAM,UAAA,GAAU,eAAA;AAAA,iBAItC,aAAA,CAAc,IAAA,EAAM,UAAA,EAAY,cAAA,GAAgB,oBAAA;AAAA,iBAIhD,qBAAA,CAAsB,IAAA,EAAM,UAAA,GAAU,eAAA"}
+{"version":3,"file":"crypto-hash.d.ts","names":[],"sources":["../src/crypto-hash.ts"],"mappings":";;;;;AAqBA;;;;;;;;;;AAkBA;;;iBAlBgB,SAAA,CAAU,IAAA,EAAM,UAAA,EAAY,cAAA,GAAgB,oBAAA;;;;;;AAqC5D;;;;;;;;;iBAnBgB,iBAAA,CAAkB,IAAA,EAAM,UAAA,GAAU,eAAA;AAqClD;;;;;;;;;AAmBA;;;;;;AAnBA,iBAlBgB,aAAA,CAAc,IAAA,EAAM,UAAA,EAAY,cAAA,GAAgB,oBAAA;;;;AAuDhE;;;;;;;;;AAmBA;;iBAxDgB,qBAAA,CAAsB,IAAA,EAAM,UAAA,GAAU,eAAA;;;;;;;;AA0EtD;;;;;;;;iBAvDgB,aAAA,CAAc,IAAA,EAAM,UAAA,EAAY,cAAA,GAAgB,oBAAA;AA0EhE;;;;;;;;;;AAkBA;;;;AAlBA,iBAxDgB,qBAAA,CAAsB,IAAA,EAAM,UAAA,GAAU,eAAA;;;;;;;;;;;;;;;;iBAmBtC,aAAA,CAAc,IAAA,EAAM,UAAA,EAAY,cAAA,GAAgB,oBAAA;;;;;;;;;;;;;;;iBAkBhD,qBAAA,CAAsB,IAAA,EAAM,UAAA,GAAU,eAAA;;;;;;;;;;;;;;;;iBAmBtC,aAAA,CAAc,IAAA,EAAM,UAAA,EAAY,cAAA,GAAgB,oBAAA;;;;;;;;;;;;;;;iBAkBhD,qBAAA,CAAsB,IAAA,EAAM,UAAA,GAAU,eAAA"}

package/dist/crypto-hash.js

@@ -1,47 +1,177 @@
 import { createHash } from "node:crypto";
 //#region src/crypto-hash.ts
 /**
-* This file provides a set of functions for creating hash digests using different algorithms and bit lengths.
-* It includes functions for generating SHA-3 hash digests with bit lengths of 224, 256, 384, and 512,
-* as well as a function for generating MD5 hash digests.
+* Computes the MD5 hash of the given data.
 *
-* These functions use the Node.js crypto module to generate the hashes.
-* Can only be used in Node.js/Deno/Bun runtimes.
+* @param {BinaryLike} data - The input data to hash
+* @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+*
+* @returns {string | Buffer} The hash digest in the specified encoding
 *
 * @example
 * ```typescript
-* import { cryptoSha3256 } from '@kikiutils/shared/crypto-hash';
+* import { cryptoMd5 } from '@kikiutils/shared/crypto-hash';
 *
-* console.log(cryptoSha3256('test')); // 36f028580bb02cc8272a9a020f4200e346e276ae664e45ee80745574e2f5ab80
+* console.log(cryptoMd5('test')); // 33ed9a05a10b21f0...
 * ```
 */
 function cryptoMd5(data, outputEncoding = "hex") {
 	return createHash("md5").update(data).digest(outputEncoding);
 }
+/**
+* Computes the MD5 hash of the given data and returns the raw buffer.
+*
+* @param {BinaryLike} data - The input data to hash
+*
+* @returns {Buffer} The raw hash digest as a Buffer
+*
+* @example
+* ```typescript
+* import { cryptoMd5ToBuffer } from '@kikiutils/shared/crypto-hash';
+*
+* console.log(cryptoMd5ToBuffer('test')); // <Buffer 33 ed 9a ...>
+* ```
+*/
 function cryptoMd5ToBuffer(data) {
 	return createHash("md5").update(data).digest();
 }
+/**
+* Computes the SHA-3 hash of the given data using the 224-bit digest.
+*
+* @param {BinaryLike} data - The input data to hash
+* @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+*
+* @returns {string | Buffer} The hash digest in the specified encoding
+*
+* @example
+* ```typescript
+* import { cryptoSha3224 } from '@kikiutils/shared/crypto-hash';
+*
+* console.log(cryptoSha3224('test')); // 0qW8FoqDcFmkpuqR9J3uT8YX...
+* ```
+*/
 function cryptoSha3224(data, outputEncoding = "hex") {
 	return createHash("sha3-224").update(data).digest(outputEncoding);
 }
+/**
+* Computes the SHA-3 hash of the given data using the 224-bit digest and returns the raw buffer.
+*
+* @param {BinaryLike} data - The input data to hash
+*
+* @returns {Buffer} The raw hash digest as a Buffer
+*
+* @example
+* ```typescript
+* import { cryptoSha3224ToBuffer } from '@kikiutils/shared/crypto-hash';
+*
+* console.log(cryptoSha3224ToBuffer('test')); // <Buffer 0q W8 Fo ...>
+* ```
+*/
 function cryptoSha3224ToBuffer(data) {
 	return createHash("sha3-224").update(data).digest();
 }
+/**
+* Computes the SHA-3 hash of the given data using the 256-bit digest.
+*
+* @param {BinaryLike} data - The input data to hash
+* @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+*
+* @returns {string | Buffer} The hash digest in the specified encoding
+*
+* @example
+* ```typescript
+* import { cryptoSha3256 } from '@kikiutils/shared/crypto-hash';
+*
+* console.log(cryptoSha3256('test')); // 36f028580bb02cc8272a9a020f4200e346e276ae664e45ee80745574e2f5ab80
+* ```
+*/
 function cryptoSha3256(data, outputEncoding = "hex") {
 	return createHash("sha3-256").update(data).digest(outputEncoding);
 }
+/**
+* Computes the SHA-3 hash of the given data using the 256-bit digest and returns the raw buffer.
+*
+* @param {BinaryLike} data - The input data to hash
+*
+* @returns {Buffer} The raw hash digest as a Buffer
+*
+* @example
+* ```typescript
+* import { cryptoSha3256ToBuffer } from '@kikiutils/shared/crypto-hash';
+*
+* console.log(cryptoSha3256ToBuffer('test')); // <Buffer 36 f0 28 ...>
+* ```
+*/
 function cryptoSha3256ToBuffer(data) {
 	return createHash("sha3-256").update(data).digest();
 }
+/**
+* Computes the SHA-3 hash of the given data using the 384-bit digest.
+*
+* @param {BinaryLike} data - The input data to hash
+* @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+*
+* @returns {string | Buffer} The hash digest in the specified encoding
+*
+* @example
+* ```typescript
+* import { cryptoSha3384 } from '@kikiutils/shared/crypto-hash';
+*
+* console.log(cryptoSha3384('test')); // 1Q2wQAYaZ4o8vWX5bEB2n3Y...
+* ```
+*/
 function cryptoSha3384(data, outputEncoding = "hex") {
 	return createHash("sha3-384").update(data).digest(outputEncoding);
 }
+/**
+* Computes the SHA-3 hash of the given data using the 384-bit digest and returns the raw buffer.
+*
+* @param {BinaryLike} data - The input data to hash
+*
+* @returns {Buffer} The raw hash digest as a Buffer
+*
+* @example
+* ```typescript
+* import { cryptoSha3384ToBuffer } from '@kikiutils/shared/crypto-hash';
+*
+* console.log(cryptoSha3384ToBuffer('test')); // <Buffer 1Q 2w QZ ...>
+* ```
+*/
 function cryptoSha3384ToBuffer(data) {
 	return createHash("sha3-384").update(data).digest();
 }
+/**
+* Computes the SHA-3 hash of the given data using the 512-bit digest.
+*
+* @param {BinaryLike} data - The input data to hash
+* @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+*
+* @returns {string | Buffer} The hash digest in the specified encoding
+*
+* @example
+* ```typescript
+* import { cryptoSha3512 } from '@kikiutils/shared/crypto-hash';
+*
+* console.log(cryptoSha3512('test')); // b_NQJ8FJBY9dIjm1q7...
+* ```
+*/
 function cryptoSha3512(data, outputEncoding = "hex") {
 	return createHash("sha3-512").update(data).digest(outputEncoding);
 }
+/**
+* Computes the SHA-3 hash of the given data using the 512-bit digest and returns the raw buffer.
+*
+* @param {BinaryLike} data - The input data to hash
+*
+* @returns {Buffer} The raw hash digest as a Buffer
+*
+* @example
+* ```typescript
+* import { cryptoSha3512ToBuffer } from '@kikiutils/shared/crypto-hash';
+*
+* console.log(cryptoSha3512ToBuffer('test')); // <Buffer b_ NQ ...>
+* ```
+*/
 function cryptoSha3512ToBuffer(data) {
 	return createHash("sha3-512").update(data).digest();
 }

package/dist/crypto-hash.js.map

@@ -1 +1 @@
-{"version":3,"file":"crypto-hash.js","names":[],"sources":["../src/crypto-hash.ts"],"sourcesContent":["/**\n * This file provides a set of functions for creating hash digests using different algorithms and bit lengths.\n * It includes functions for generating SHA-3 hash digests with bit lengths of 224, 256, 384, and 512,\n * as well as a function for generating MD5 hash digests.\n *\n * These functions use the Node.js crypto module to generate the hashes.\n * Can only be used in Node.js/Deno/Bun runtimes.\n *\n * @example\n * ```typescript\n * import { cryptoSha3256 } from '@kikiutils/shared/crypto-hash';\n *\n * console.log(cryptoSha3256('test')); // 36f028580bb02cc8272a9a020f4200e346e276ae664e45ee80745574e2f5ab80\n * ```\n */\n\nimport { createHash } from 'node:crypto';\nimport type {\n    BinaryLike,\n    BinaryToTextEncoding,\n} from 'node:crypto';\n\nexport function cryptoMd5(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {\n    return createHash('md5').update(data).digest(outputEncoding);\n}\n\nexport function cryptoMd5ToBuffer(data: BinaryLike) {\n    return createHash('md5').update(data).digest();\n}\n\nexport function cryptoSha3224(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {\n    return createHash('sha3-224').update(data).digest(outputEncoding);\n}\n\nexport function cryptoSha3224ToBuffer(data: BinaryLike) {\n    return createHash('sha3-224').update(data).digest();\n}\n\nexport function cryptoSha3256(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {\n    return createHash('sha3-256').update(data).digest(outputEncoding);\n}\n\nexport function cryptoSha3256ToBuffer(data: BinaryLike) {\n    return createHash('sha3-256').update(data).digest();\n}\n\nexport function cryptoSha3384(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {\n    return createHash('sha3-384').update(data).digest(outputEncoding);\n}\n\nexport function cryptoSha3384ToBuffer(data: BinaryLike) {\n    return createHash('sha3-384').update(data).digest();\n}\n\nexport function cryptoSha3512(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {\n    return createHash('sha3-512').update(data).digest(outputEncoding);\n}\n\nexport function cryptoSha3512ToBuffer(data: BinaryLike) {\n    return createHash('sha3-512').update(data).digest();\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAsBA,SAAgB,UAAU,MAAkB,iBAAuC,OAAO;AACtF,QAAO,WAAW,MAAM,CAAC,OAAO,KAAK,CAAC,OAAO,eAAe;;AAGhE,SAAgB,kBAAkB,MAAkB;AAChD,QAAO,WAAW,MAAM,CAAC,OAAO,KAAK,CAAC,QAAQ;;AAGlD,SAAgB,cAAc,MAAkB,iBAAuC,OAAO;AAC1F,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,OAAO,eAAe;;AAGrE,SAAgB,sBAAsB,MAAkB;AACpD,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,QAAQ;;AAGvD,SAAgB,cAAc,MAAkB,iBAAuC,OAAO;AAC1F,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,OAAO,eAAe;;AAGrE,SAAgB,sBAAsB,MAAkB;AACpD,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,QAAQ;;AAGvD,SAAgB,cAAc,MAAkB,iBAAuC,OAAO;AAC1F,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,OAAO,eAAe;;AAGrE,SAAgB,sBAAsB,MAAkB;AACpD,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,QAAQ;;AAGvD,SAAgB,cAAc,MAAkB,iBAAuC,OAAO;AAC1F,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,OAAO,eAAe;;AAGrE,SAAgB,sBAAsB,MAAkB;AACpD,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,QAAQ"}
+{"version":3,"file":"crypto-hash.js","names":[],"sources":["../src/crypto-hash.ts"],"sourcesContent":["import { createHash } from 'node:crypto';\nimport type {\n    BinaryLike,\n    BinaryToTextEncoding,\n} from 'node:crypto';\n\n/**\n * Computes the MD5 hash of the given data.\n *\n * @param {BinaryLike} data - The input data to hash\n * @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)\n *\n * @returns {string | Buffer} The hash digest in the specified encoding\n *\n * @example\n * ```typescript\n * import { cryptoMd5 } from '@kikiutils/shared/crypto-hash';\n *\n * console.log(cryptoMd5('test')); // 33ed9a05a10b21f0...\n * ```\n */\nexport function cryptoMd5(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {\n    return createHash('md5').update(data).digest(outputEncoding);\n}\n\n/**\n * Computes the MD5 hash of the given data and returns the raw buffer.\n *\n * @param {BinaryLike} data - The input data to hash\n *\n * @returns {Buffer} The raw hash digest as a Buffer\n *\n * @example\n * ```typescript\n * import { cryptoMd5ToBuffer } from '@kikiutils/shared/crypto-hash';\n *\n * console.log(cryptoMd5ToBuffer('test')); // <Buffer 33 ed 9a ...>\n * ```\n */\nexport function cryptoMd5ToBuffer(data: BinaryLike) {\n    return createHash('md5').update(data).digest();\n}\n\n/**\n * Computes the SHA-3 hash of the given data using the 224-bit digest.\n *\n * @param {BinaryLike} data - The input data to hash\n * @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)\n *\n * @returns {string | Buffer} The hash digest in the specified encoding\n *\n * @example\n * ```typescript\n * import { cryptoSha3224 } from '@kikiutils/shared/crypto-hash';\n *\n * console.log(cryptoSha3224('test')); // 0qW8FoqDcFmkpuqR9J3uT8YX...\n * ```\n */\nexport function cryptoSha3224(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {\n    return createHash('sha3-224').update(data).digest(outputEncoding);\n}\n\n/**\n * Computes the SHA-3 hash of the given data using the 224-bit digest and returns the raw buffer.\n *\n * @param {BinaryLike} data - The input data to hash\n *\n * @returns {Buffer} The raw hash digest as a Buffer\n *\n * @example\n * ```typescript\n * import { cryptoSha3224ToBuffer } from '@kikiutils/shared/crypto-hash';\n *\n * console.log(cryptoSha3224ToBuffer('test')); // <Buffer 0q W8 Fo ...>\n * ```\n */\nexport function cryptoSha3224ToBuffer(data: BinaryLike) {\n    return createHash('sha3-224').update(data).digest();\n}\n\n/**\n * Computes the SHA-3 hash of the given data using the 256-bit digest.\n *\n * @param {BinaryLike} data - The input data to hash\n * @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)\n *\n * @returns {string | Buffer} The hash digest in the specified encoding\n *\n * @example\n * ```typescript\n * import { cryptoSha3256 } from '@kikiutils/shared/crypto-hash';\n *\n * console.log(cryptoSha3256('test')); // 36f028580bb02cc8272a9a020f4200e346e276ae664e45ee80745574e2f5ab80\n * ```\n */\nexport function cryptoSha3256(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {\n    return createHash('sha3-256').update(data).digest(outputEncoding);\n}\n\n/**\n * Computes the SHA-3 hash of the given data using the 256-bit digest and returns the raw buffer.\n *\n * @param {BinaryLike} data - The input data to hash\n *\n * @returns {Buffer} The raw hash digest as a Buffer\n *\n * @example\n * ```typescript\n * import { cryptoSha3256ToBuffer } from '@kikiutils/shared/crypto-hash';\n *\n * console.log(cryptoSha3256ToBuffer('test')); // <Buffer 36 f0 28 ...>\n * ```\n */\nexport function cryptoSha3256ToBuffer(data: BinaryLike) {\n    return createHash('sha3-256').update(data).digest();\n}\n\n/**\n * Computes the SHA-3 hash of the given data using the 384-bit digest.\n *\n * @param {BinaryLike} data - The input data to hash\n * @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)\n *\n * @returns {string | Buffer} The hash digest in the specified encoding\n *\n * @example\n * ```typescript\n * import { cryptoSha3384 } from '@kikiutils/shared/crypto-hash';\n *\n * console.log(cryptoSha3384('test')); // 1Q2wQAYaZ4o8vWX5bEB2n3Y...\n * ```\n */\nexport function cryptoSha3384(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {\n    return createHash('sha3-384').update(data).digest(outputEncoding);\n}\n\n/**\n * Computes the SHA-3 hash of the given data using the 384-bit digest and returns the raw buffer.\n *\n * @param {BinaryLike} data - The input data to hash\n *\n * @returns {Buffer} The raw hash digest as a Buffer\n *\n * @example\n * ```typescript\n * import { cryptoSha3384ToBuffer } from '@kikiutils/shared/crypto-hash';\n *\n * console.log(cryptoSha3384ToBuffer('test')); // <Buffer 1Q 2w QZ ...>\n * ```\n */\nexport function cryptoSha3384ToBuffer(data: BinaryLike) {\n    return createHash('sha3-384').update(data).digest();\n}\n\n/**\n * Computes the SHA-3 hash of the given data using the 512-bit digest.\n *\n * @param {BinaryLike} data - The input data to hash\n * @param {BinaryToTextEncoding} [outputEncoding] - The output encoding (default: `'hex'`)\n *\n * @returns {string | Buffer} The hash digest in the specified encoding\n *\n * @example\n * ```typescript\n * import { cryptoSha3512 } from '@kikiutils/shared/crypto-hash';\n *\n * console.log(cryptoSha3512('test')); // b_NQJ8FJBY9dIjm1q7...\n * ```\n */\nexport function cryptoSha3512(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {\n    return createHash('sha3-512').update(data).digest(outputEncoding);\n}\n\n/**\n * Computes the SHA-3 hash of the given data using the 512-bit digest and returns the raw buffer.\n *\n * @param {BinaryLike} data - The input data to hash\n *\n * @returns {Buffer} The raw hash digest as a Buffer\n *\n * @example\n * ```typescript\n * import { cryptoSha3512ToBuffer } from '@kikiutils/shared/crypto-hash';\n *\n * console.log(cryptoSha3512ToBuffer('test')); // <Buffer b_ NQ ...>\n * ```\n */\nexport function cryptoSha3512ToBuffer(data: BinaryLike) {\n    return createHash('sha3-512').update(data).digest();\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAqBA,SAAgB,UAAU,MAAkB,iBAAuC,OAAO;AACtF,QAAO,WAAW,MAAM,CAAC,OAAO,KAAK,CAAC,OAAO,eAAe;;;;;;;;;;;;;;;;AAiBhE,SAAgB,kBAAkB,MAAkB;AAChD,QAAO,WAAW,MAAM,CAAC,OAAO,KAAK,CAAC,QAAQ;;;;;;;;;;;;;;;;;AAkBlD,SAAgB,cAAc,MAAkB,iBAAuC,OAAO;AAC1F,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,OAAO,eAAe;;;;;;;;;;;;;;;;AAiBrE,SAAgB,sBAAsB,MAAkB;AACpD,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,QAAQ;;;;;;;;;;;;;;;;;AAkBvD,SAAgB,cAAc,MAAkB,iBAAuC,OAAO;AAC1F,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,OAAO,eAAe;;;;;;;;;;;;;;;;AAiBrE,SAAgB,sBAAsB,MAAkB;AACpD,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,QAAQ;;;;;;;;;;;;;;;;;AAkBvD,SAAgB,cAAc,MAAkB,iBAAuC,OAAO;AAC1F,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,OAAO,eAAe;;;;;;;;;;;;;;;;AAiBrE,SAAgB,sBAAsB,MAAkB;AACpD,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,QAAQ;;;;;;;;;;;;;;;;;AAkBvD,SAAgB,cAAc,MAAkB,iBAAuC,OAAO;AAC1F,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,OAAO,eAAe;;;;;;;;;;;;;;;;AAiBrE,SAAgB,sBAAsB,MAAkB;AACpD,QAAO,WAAW,WAAW,CAAC,OAAO,KAAK,CAAC,QAAQ"}

package/dist/datetime.d.ts

@@ -26,8 +26,6 @@ type DateRangeType = 'lastMonth' | 'lastWeek' | 'thisMonth' | 'thisWeek' | 'toda
  * // Format a date string
  * console.log(formatDate('2024-07-10T00:00:00Z', 'yyyy-MM-dd')); // 2024-07-10
  * ```
- *
- * @see https://date-fns.org/docs/format
  */
 declare function formatDate(date: DateArg<Date> & {}, format?: string, options?: FormatOptions): string;
 /**

package/dist/datetime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"datetime.d.ts","names":[],"sources":["../src/datetime.ts"],"mappings":";;;KAkBY,aAAA;;AAAZ;;;;;AA6BA;;;;;;;;;;;;;;;;AA+BA;;;;;iBA/BgB,UAAA,CAAW,IAAA,EAAM,OAAA,CAAQ,IAAA,QAAY,MAAA,WAAwC,OAAA,GAAU,aAAA;;;;;;;;;;;;;;;;;;;AAwGvG;;;;;;;;;iBAzEgB,oBAAA,CACZ,IAAA,EAAM,IAAA,EACN,IAAA,EAAM,aAAA,EACN,OAAA;EACI,wBAAA;EACA,YAAA,GAAe,GAAA;AAAA;;;;;;;;;;;;;;;;;;;;iBAoEP,wBAAA,CAAyB,UAAA,YAAsB,IAAA"}
+{"version":3,"file":"datetime.d.ts","names":[],"sources":["../src/datetime.ts"],"mappings":";;;KAkBY,aAAA;;AAAZ;;;;;AA2BA;;;;;;;;;;;;;;;;AA+BA;;;iBA/BgB,UAAA,CAAW,IAAA,EAAM,OAAA,CAAQ,IAAA,QAAY,MAAA,WAAwC,OAAA,GAAU,aAAA;;;;;;;;;;;;;;;;;;;;;AAwGvG;;;;;;;iBAzEgB,oBAAA,CACZ,IAAA,EAAM,IAAA,EACN,IAAA,EAAM,aAAA,EACN,OAAA;EACI,wBAAA;EACA,YAAA,GAAe,GAAA;AAAA;;;;;;;;;;;;;;;;;;;;iBAoEP,wBAAA,CAAyB,UAAA,YAAsB,IAAA"}

package/dist/datetime.js

@@ -24,8 +24,6 @@ import { endOfDay, endOfMonth, endOfWeek, format, startOfDay, startOfMonth, star
 * // Format a date string
 * console.log(formatDate('2024-07-10T00:00:00Z', 'yyyy-MM-dd')); // 2024-07-10
 * ```
-*
-* @see https://date-fns.org/docs/format
 */
 function formatDate(date, format$1 = "yyyy-MM-dd HH:mm:ss", options) {
 	return format(date, format$1, options);