@kikiutils/shared 13.3.0 → 13.5.0

package/dist/classes/precision-number.js

@@ -0,0 +1,133 @@
+import { Decimal } from "decimal.js";
+
+//#region src/classes/precision-number.ts
+/**
+* Class representing a precision number with configurable decimal places and rounding.
+*
+* This class leverages the Decimal.js library to ensure accurate arithmetic operations
+* with floating point numbers. It provides methods for various arithmetic operations
+* (addition, subtraction, multiplication, division) as well as comparison and utility
+* methods to check the state of the number (e.g., if it is finite, an integer, zero, etc.).
+*
+* The class also includes custom symbol methods to support Node.js inspection and primitive
+* type conversion.
+*
+* The class supports in-place modification methods that alter the current instance's value,
+* such as `plus`, `minus`, `times`, `dividedBy`, and others. Additionally, methods prefixed
+* with `to` (e.g., `toPlus`, `toMinus`) return a new instance of `PrecisionNumber` with the
+* modified value, leaving the original instance unchanged.
+*/
+var PrecisionNumber = class PrecisionNumber {
+	#decimalPlaces;
+	#rounding;
+	#decimal;
+	constructor(value = "0", decimalPlaces = 2, rounding = Decimal.ROUND_DOWN) {
+		this.#decimalPlaces = decimalPlaces;
+		this.#rounding = rounding;
+		this.#decimal = this.#decimalToFixedDecimal(new Decimal(value.toString().trim()));
+	}
+	[Symbol.for("nodejs.util.inspect.custom")]() {
+		return this.value;
+	}
+	[Symbol.toPrimitive](hint) {
+		if (hint === "number") return this.#decimal.toNumber();
+		return this.value;
+	}
+	#decimalToFixedDecimal(decimal) {
+		return decimal.toDecimalPlaces(this.#decimalPlaces, this.#rounding);
+	}
+	get value() {
+		return this.#decimal.toFixed(this.#decimalPlaces, this.#rounding);
+	}
+	static toFixed(value, decimalPlaces = 2, rounding = Decimal.ROUND_DOWN) {
+		return new Decimal(value.toString().trim()).toFixed(decimalPlaces, rounding);
+	}
+	absoluteValue() {
+		this.#decimal = this.#decimalToFixedDecimal(this.#decimal.absoluteValue());
+		return this;
+	}
+	dividedBy(value) {
+		this.#decimal = this.#decimalToFixedDecimal(this.#decimal.dividedBy(value.toString().trim()));
+		return this;
+	}
+	equals(value) {
+		return this.#decimal.equals(value.toString().trim());
+	}
+	gt(value) {
+		return this.#decimal.gt(value.toString().trim());
+	}
+	gte(value) {
+		return this.#decimal.gte(value.toString().trim());
+	}
+	isFinite() {
+		return this.#decimal.isFinite();
+	}
+	isInteger() {
+		return this.#decimal.isInteger();
+	}
+	isNaN() {
+		return this.#decimal.isNaN();
+	}
+	isNegative() {
+		return this.#decimal.isNegative();
+	}
+	isPositive() {
+		return this.#decimal.isPositive();
+	}
+	isZero() {
+		return this.#decimal.isZero();
+	}
+	lt(value) {
+		return this.#decimal.lt(value.toString().trim());
+	}
+	lte(value) {
+		return this.#decimal.lte(value.toString().trim());
+	}
+	minus(value) {
+		this.#decimal = this.#decimalToFixedDecimal(this.#decimal.minus(value.toString().trim()));
+		return this;
+	}
+	negate() {
+		this.#decimal = this.#decimalToFixedDecimal(this.#decimal.negated());
+		return this;
+	}
+	plus(value) {
+		this.#decimal = this.#decimalToFixedDecimal(this.#decimal.plus(value.toString().trim()));
+		return this;
+	}
+	times(value) {
+		this.#decimal = this.#decimalToFixedDecimal(this.#decimal.times(value.toString().trim()));
+		return this;
+	}
+	toAbsoluteValue() {
+		return new PrecisionNumber(this.#decimal.absoluteValue(), this.#decimalPlaces, this.#rounding);
+	}
+	toDividedBy(value) {
+		return new PrecisionNumber(this.#decimal.dividedBy(value.toString().trim()), this.#decimalPlaces, this.#rounding);
+	}
+	toJSON() {
+		return this.value;
+	}
+	toMinus(value) {
+		return new PrecisionNumber(this.#decimal.minus(value.toString().trim()), this.#decimalPlaces, this.#rounding);
+	}
+	toNegated() {
+		return new PrecisionNumber(this.#decimal.negated(), this.#decimalPlaces, this.#rounding);
+	}
+	toPlus(value) {
+		return new PrecisionNumber(this.#decimal.plus(value.toString().trim()), this.#decimalPlaces, this.#rounding);
+	}
+	toString() {
+		return this.value;
+	}
+	toFixed(decimalPlaces = this.#decimalPlaces, rounding = this.#rounding) {
+		return this.#decimal.toFixed(decimalPlaces, rounding);
+	}
+	toTimes(value) {
+		return new PrecisionNumber(this.#decimal.times(value.toString().trim()), this.#decimalPlaces, this.#rounding);
+	}
+};
+
+//#endregion
+export { PrecisionNumber };
+//# sourceMappingURL=precision-number.js.map

package/dist/classes/precision-number.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"precision-number.js","names":["#decimalPlaces","#rounding","#decimal","#decimalToFixedDecimal"],"sources":["../../src/classes/precision-number.ts"],"sourcesContent":["import { Decimal } from 'decimal.js';\n\nexport type PrecisionNumberValue = Decimal.Value | PrecisionNumber | { toString: () => string };\n\n/**\n * Class representing a precision number with configurable decimal places and rounding.\n *\n * This class leverages the Decimal.js library to ensure accurate arithmetic operations\n * with floating point numbers. It provides methods for various arithmetic operations\n * (addition, subtraction, multiplication, division) as well as comparison and utility\n * methods to check the state of the number (e.g., if it is finite, an integer, zero, etc.).\n *\n * The class also includes custom symbol methods to support Node.js inspection and primitive\n * type conversion.\n *\n * The class supports in-place modification methods that alter the current instance's value,\n * such as `plus`, `minus`, `times`, `dividedBy`, and others. Additionally, methods prefixed\n * with `to` (e.g., `toPlus`, `toMinus`) return a new instance of `PrecisionNumber` with the\n * modified value, leaving the original instance unchanged.\n */\nexport class PrecisionNumber {\n    // Private properties\n    readonly #decimalPlaces: number;\n    readonly #rounding: Decimal.Rounding;\n    #decimal: Decimal;\n\n    constructor(\n        value: PrecisionNumberValue = '0',\n        decimalPlaces: number = 2,\n        rounding: Decimal.Rounding = Decimal.ROUND_DOWN,\n    ) {\n        this.#decimalPlaces = decimalPlaces;\n        this.#rounding = rounding;\n        this.#decimal = this.#decimalToFixedDecimal(new Decimal(value.toString().trim()));\n    }\n\n    // Symbols\n    [Symbol.for('nodejs.util.inspect.custom')]() {\n        return this.value;\n    }\n\n    [Symbol.toPrimitive](hint: string) {\n        if (hint === 'number') return this.#decimal.toNumber();\n        return this.value;\n    }\n\n    // Private methods\n    #decimalToFixedDecimal(decimal: Decimal) {\n        return decimal.toDecimalPlaces(this.#decimalPlaces, this.#rounding);\n    }\n\n    // Public getters\n    get value() {\n        return this.#decimal.toFixed(this.#decimalPlaces, this.#rounding);\n    }\n\n    // Static methods\n    static toFixed(\n        value: PrecisionNumberValue,\n        decimalPlaces: number = 2,\n        rounding: Decimal.Rounding = Decimal.ROUND_DOWN,\n    ) {\n        return new Decimal(value.toString().trim()).toFixed(decimalPlaces, rounding);\n    }\n\n    // Public methods\n    absoluteValue() {\n        this.#decimal = this.#decimalToFixedDecimal(this.#decimal.absoluteValue());\n        return this;\n    }\n\n    dividedBy(value: PrecisionNumberValue) {\n        this.#decimal = this.#decimalToFixedDecimal(this.#decimal.dividedBy(value.toString().trim()));\n        return this;\n    }\n\n    equals(value: PrecisionNumberValue) {\n        return this.#decimal.equals(value.toString().trim());\n    }\n\n    gt(value: PrecisionNumberValue) {\n        return this.#decimal.gt(value.toString().trim());\n    }\n\n    gte(value: PrecisionNumberValue) {\n        return this.#decimal.gte(value.toString().trim());\n    }\n\n    isFinite() {\n        return this.#decimal.isFinite();\n    }\n\n    isInteger() {\n        return this.#decimal.isInteger();\n    }\n\n    isNaN() {\n        return this.#decimal.isNaN();\n    }\n\n    isNegative() {\n        return this.#decimal.isNegative();\n    }\n\n    isPositive() {\n        return this.#decimal.isPositive();\n    }\n\n    isZero() {\n        return this.#decimal.isZero();\n    }\n\n    lt(value: PrecisionNumberValue) {\n        return this.#decimal.lt(value.toString().trim());\n    }\n\n    lte(value: PrecisionNumberValue) {\n        return this.#decimal.lte(value.toString().trim());\n    }\n\n    minus(value: PrecisionNumberValue) {\n        this.#decimal = this.#decimalToFixedDecimal(this.#decimal.minus(value.toString().trim()));\n        return this;\n    }\n\n    negate() {\n        this.#decimal = this.#decimalToFixedDecimal(this.#decimal.negated());\n        return this;\n    }\n\n    plus(value: PrecisionNumberValue) {\n        this.#decimal = this.#decimalToFixedDecimal(this.#decimal.plus(value.toString().trim()));\n        return this;\n    }\n\n    times(value: PrecisionNumberValue) {\n        this.#decimal = this.#decimalToFixedDecimal(this.#decimal.times(value.toString().trim()));\n        return this;\n    }\n\n    toAbsoluteValue() {\n        return new PrecisionNumber(this.#decimal.absoluteValue(), this.#decimalPlaces, this.#rounding);\n    }\n\n    toDividedBy(value: PrecisionNumberValue) {\n        return new PrecisionNumber(\n            this.#decimal.dividedBy(value.toString().trim()),\n            this.#decimalPlaces,\n            this.#rounding,\n        );\n    }\n\n    toJSON() {\n        return this.value;\n    }\n\n    toMinus(value: PrecisionNumberValue) {\n        return new PrecisionNumber(this.#decimal.minus(value.toString().trim()), this.#decimalPlaces, this.#rounding);\n    }\n\n    toNegated() {\n        return new PrecisionNumber(this.#decimal.negated(), this.#decimalPlaces, this.#rounding);\n    }\n\n    toPlus(value: PrecisionNumberValue) {\n        return new PrecisionNumber(this.#decimal.plus(value.toString().trim()), this.#decimalPlaces, this.#rounding);\n    }\n\n    toString() {\n        return this.value;\n    }\n\n    toFixed(decimalPlaces: number = this.#decimalPlaces, rounding: Decimal.Rounding = this.#rounding) {\n        return this.#decimal.toFixed(decimalPlaces, rounding);\n    }\n\n    toTimes(value: PrecisionNumberValue) {\n        return new PrecisionNumber(this.#decimal.times(value.toString().trim()), this.#decimalPlaces, this.#rounding);\n    }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAoBA,IAAa,kBAAb,MAAa,gBAAgB;CAEzB,CAASA;CACT,CAASC;CACT;CAEA,YACI,QAA8B,KAC9B,gBAAwB,GACxB,WAA6B,QAAQ,YACvC;AACE,QAAKD,gBAAiB;AACtB,QAAKC,WAAY;AACjB,QAAKC,UAAW,MAAKC,sBAAuB,IAAI,QAAQ,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;;CAIrF,CAAC,OAAO,IAAI,6BAA6B,IAAI;AACzC,SAAO,KAAK;;CAGhB,CAAC,OAAO,aAAa,MAAc;AAC/B,MAAI,SAAS,SAAU,QAAO,MAAKD,QAAS,UAAU;AACtD,SAAO,KAAK;;CAIhB,uBAAuB,SAAkB;AACrC,SAAO,QAAQ,gBAAgB,MAAKF,eAAgB,MAAKC,SAAU;;CAIvE,IAAI,QAAQ;AACR,SAAO,MAAKC,QAAS,QAAQ,MAAKF,eAAgB,MAAKC,SAAU;;CAIrE,OAAO,QACH,OACA,gBAAwB,GACxB,WAA6B,QAAQ,YACvC;AACE,SAAO,IAAI,QAAQ,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC,QAAQ,eAAe,SAAS;;CAIhF,gBAAgB;AACZ,QAAKC,UAAW,MAAKC,sBAAuB,MAAKD,QAAS,eAAe,CAAC;AAC1E,SAAO;;CAGX,UAAU,OAA6B;AACnC,QAAKA,UAAW,MAAKC,sBAAuB,MAAKD,QAAS,UAAU,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;AAC7F,SAAO;;CAGX,OAAO,OAA6B;AAChC,SAAO,MAAKA,QAAS,OAAO,MAAM,UAAU,CAAC,MAAM,CAAC;;CAGxD,GAAG,OAA6B;AAC5B,SAAO,MAAKA,QAAS,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC;;CAGpD,IAAI,OAA6B;AAC7B,SAAO,MAAKA,QAAS,IAAI,MAAM,UAAU,CAAC,MAAM,CAAC;;CAGrD,WAAW;AACP,SAAO,MAAKA,QAAS,UAAU;;CAGnC,YAAY;AACR,SAAO,MAAKA,QAAS,WAAW;;CAGpC,QAAQ;AACJ,SAAO,MAAKA,QAAS,OAAO;;CAGhC,aAAa;AACT,SAAO,MAAKA,QAAS,YAAY;;CAGrC,aAAa;AACT,SAAO,MAAKA,QAAS,YAAY;;CAGrC,SAAS;AACL,SAAO,MAAKA,QAAS,QAAQ;;CAGjC,GAAG,OAA6B;AAC5B,SAAO,MAAKA,QAAS,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC;;CAGpD,IAAI,OAA6B;AAC7B,SAAO,MAAKA,QAAS,IAAI,MAAM,UAAU,CAAC,MAAM,CAAC;;CAGrD,MAAM,OAA6B;AAC/B,QAAKA,UAAW,MAAKC,sBAAuB,MAAKD,QAAS,MAAM,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;AACzF,SAAO;;CAGX,SAAS;AACL,QAAKA,UAAW,MAAKC,sBAAuB,MAAKD,QAAS,SAAS,CAAC;AACpE,SAAO;;CAGX,KAAK,OAA6B;AAC9B,QAAKA,UAAW,MAAKC,sBAAuB,MAAKD,QAAS,KAAK,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;AACxF,SAAO;;CAGX,MAAM,OAA6B;AAC/B,QAAKA,UAAW,MAAKC,sBAAuB,MAAKD,QAAS,MAAM,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;AACzF,SAAO;;CAGX,kBAAkB;AACd,SAAO,IAAI,gBAAgB,MAAKA,QAAS,eAAe,EAAE,MAAKF,eAAgB,MAAKC,SAAU;;CAGlG,YAAY,OAA6B;AACrC,SAAO,IAAI,gBACP,MAAKC,QAAS,UAAU,MAAM,UAAU,CAAC,MAAM,CAAC,EAChD,MAAKF,eACL,MAAKC,SACR;;CAGL,SAAS;AACL,SAAO,KAAK;;CAGhB,QAAQ,OAA6B;AACjC,SAAO,IAAI,gBAAgB,MAAKC,QAAS,MAAM,MAAM,UAAU,CAAC,MAAM,CAAC,EAAE,MAAKF,eAAgB,MAAKC,SAAU;;CAGjH,YAAY;AACR,SAAO,IAAI,gBAAgB,MAAKC,QAAS,SAAS,EAAE,MAAKF,eAAgB,MAAKC,SAAU;;CAG5F,OAAO,OAA6B;AAChC,SAAO,IAAI,gBAAgB,MAAKC,QAAS,KAAK,MAAM,UAAU,CAAC,MAAM,CAAC,EAAE,MAAKF,eAAgB,MAAKC,SAAU;;CAGhH,WAAW;AACP,SAAO,KAAK;;CAGhB,QAAQ,gBAAwB,MAAKD,eAAgB,WAA6B,MAAKC,UAAW;AAC9F,SAAO,MAAKC,QAAS,QAAQ,eAAe,SAAS;;CAGzD,QAAQ,OAA6B;AACjC,SAAO,IAAI,gBAAgB,MAAKA,QAAS,MAAM,MAAM,UAAU,CAAC,MAAM,CAAC,EAAE,MAAKF,eAAgB,MAAKC,SAAU"}

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

@@ -0,0 +1,43 @@
+import { PathLike } from "./path.js";
+import { Nullable } from "../types/index.js";
+import * as node_ssh0 from "node-ssh";
+import { Config, NodeSSH, SSHExecCommandOptions, SSHGetPutDirectoryOptions, SSHPutFilesOptions } from "node-ssh";
+import { SFTPWrapper, TransferOptions } from "ssh2";
+
+//#region src/classes/ssh-client.d.ts
+declare const loggerLevelStringToConsolaLogLevelMap: {
+  readonly debug: 4;
+  readonly error: 0;
+  readonly fatal: 0;
+  readonly info: 3;
+  readonly normal: 2;
+  readonly silent: -999;
+  readonly trace: 5;
+  readonly verbose: 999;
+  readonly warn: 1;
+};
+declare class SshClient {
+  #private;
+  constructor(host: string, username: string, password: string, port?: number, connectConfig?: Config);
+  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>;
+  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>;
+  isConnected(): boolean;
+  mkdir(path: PathLike): Promise<boolean>;
+  putDir: (localDirectory: PathLike, remoteDirectory: PathLike, options?: SSHGetPutDirectoryOptions) => Promise<boolean>;
+  putDirectory(localDirectory: PathLike, remoteDirectory: PathLike, options?: SSHGetPutDirectoryOptions): Promise<boolean>;
+  putFile(localFile: PathLike, remoteFile: PathLike, givenSftp?: Nullable<SFTPWrapper>, transferOptions?: Nullable<TransferOptions>): Promise<boolean>;
+  putFiles(files: {
+    local: PathLike;
+    remote: PathLike;
+  }[], options?: SSHPutFilesOptions): Promise<boolean>;
+  setLoggerLevel(level: keyof typeof loggerLevelStringToConsolaLogLevelMap): void;
+}
+//#endregion
+export { SshClient };
+//# sourceMappingURL=ssh-client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ssh-client.d.ts","names":[],"sources":["../../src/classes/ssh-client.ts"],"sourcesContent":[],"mappings":";;;;;;;cAkBM;;EAAA,SAAA,KAAA,EAAA,CAAA;EAYO,SAAA,KAAS,EAAA,CAAA;EAAA,SAAA,IAAA,EAAA,CAAA;WAM+E,MAAA,EAAA,CAAA;WActF,MAAA,EAAA,CAAA,GAAA;WAIE,KAAA,EAAA,CAAA;WAoB0B,OAAA,EAAA,GAAA;WAAqB,IAAA,EAAA,CAAA;;AAIf,cAhDpC,SAAA,CAgDoC;UAAqB;aAAA,CAAA,IAAA,EAAA,MAAA,EAAA,QAAA,EAAA,MAAA,EAAA,QAAA,EAAA,MAAA,EAAA,IAAA,CAAA,EAAA,MAAA,EAAA,aAAA,CAAA,EA1C+B,MA0C/B;MAa/B,OAAA,CAAA,CAAA,EAzCxB,OAyCwB;SAA2B,CAAA,CAAA,EArCjD,OAqCiD,CAAA,OAAA,CAAA;YAAoB,CAAA,CAAA,EAAA,OAAA;aAAyB,CAAA,OAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EAjBpE,qBAiBoE,CAAA,EAjB/C,OAiB+C,CAAA,IAAA,GAjB/C,SAAA,CAAA,sBAiB+C,CAAA;mBAAxE,CAAA,OAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EAbU,qBAaV,CAAA,EAb+B,OAa/B,CAAA,IAAA,GAb+B,SAAA,CAAA,sBAa/B,CAAA;QAA2B,EAAA,CAAA,cAAA,EAA3B,QAA2B,EAAA,eAAA,EAAA,QAAA,EAAA,OAAA,CAAA,EAAoB,yBAApB,EAAA,GAA6C,OAA7C,CAAA,OAAA,CAAA;cAAoB,CAAA,cAAA,EAA/C,QAA+C,EAAA,eAAA,EAApB,QAAoB,EAAA,OAAA,CAAA,EAAA,yBAAA,CAAA,EAAyB,OAAzB,CAAA,OAAA,CAAA;SAAyB,CAAA,SAAA,EAU5F,QAV4F,EAAA,UAAA,EAW3F,QAX2F,EAAA,SAAA,CAAA,EAY3F,QAZ2F,CAYlF,WAZkF,CAAA,EAAA,eAAA,CAAA,EAarF,QAbqF,CAa5E,eAb4E,CAAA,CAAA,EAa5D,OAb4D,CAAA,OAAA,CAAA;aAU5F,CAAA,CAAA,EAAA,OAAA;OACC,CAAA,IAAA,EAiBE,QAjBF,CAAA,EAiBU,OAjBV,CAAA,OAAA,CAAA;QACS,EAAA,CAAA,cAAA,EA4BU,QA5BV,EAAA,eAAA,EA4BqC,QA5BrC,EAAA,OAAA,CAAA,EA4ByD,yBA5BzD,EAAA,GA4BkF,OA5BlF,CAAA,OAAA,CAAA;cAAT,CAAA,cAAA,EA4BmB,QA5BnB,EAAA,eAAA,EA4B8C,QA5B9C,EAAA,OAAA,CAAA,EA4BkE,yBA5BlE,CAAA,EA4B2F,OA5B3F,CAAA,OAAA,CAAA;SACe,CAAA,SAAA,EAqChB,QArCgB,EAAA,UAAA,EAsCf,QAtCe,EAAA,SAAA,CAAA,EAuCf,QAvCe,CAuCN,WAvCM,CAAA,EAAA,eAAA,CAAA,EAwCT,QAxCS,CAwCA,eAxCA,CAAA,CAAA,EAwCgB,OAxChB,CAAA,OAAA,CAAA;UAAT,CAAA,KAAA,EAAA;IAAyB,KAAA,EAmDhB,QAnDgB;IAe7B,MAAA,EAoC+B,QApC/B;KAAQ,EAAA,OAAA,CAAA,EAoC+C,kBApC/C,CAAA,EAoCiE,OApCjE,CAAA,OAAA,CAAA;gBAYS,CAAA,KAAA,EAAA,MAAA,OAuCA,qCAvCA,CAAA,EAAA,IAAA"}

package/dist/classes/ssh-client.js

@@ -0,0 +1,131 @@
+import { createConsola } from "consola";
+import { NodeSSH } from "node-ssh";
+
+//#region src/classes/ssh-client.ts
+const loggerLevelStringToConsolaLogLevelMap = {
+	debug: 4,
+	error: 0,
+	fatal: 0,
+	info: 3,
+	normal: 2,
+	silent: -999,
+	trace: 5,
+	verbose: 999,
+	warn: 1
+};
+var SshClient = class {
+	#connectConfig;
+	#logger;
+	#nodeSsh;
+	constructor(host, username, password, port = 22, connectConfig) {
+		this.#connectConfig = {
+			...connectConfig,
+			host,
+			password,
+			port,
+			username
+		};
+		this.#logger = createConsola();
+		this.#nodeSsh = new NodeSSH();
+		if (process.env.NODE_ENV === "production") this.setLoggerLevel("error");
+	}
+	get nodeSsh() {
+		return this.#nodeSsh;
+	}
+	async connect() {
+		try {
+			this.#nodeSsh = await this.#nodeSsh.connect(this.#connectConfig);
+			return true;
+		} catch (error) {
+			this.#logger.error(error);
+			return false;
+		}
+	}
+	disconnect() {
+		try {
+			this.#nodeSsh.dispose();
+			return true;
+		} catch (error) {
+			this.#logger.error(error);
+			return false;
+		}
+	}
+	execCommand(command, options) {
+		return this.#nodeSsh.execCommand(command, options).catch(() => {});
+	}
+	execCommandWithIo(command, options) {
+		return this.execCommand(command, {
+			...options,
+			onStderr: (data) => process.stderr.write(data.toString()),
+			onStdout: (data) => process.stdout.write(data.toString())
+		});
+	}
+	getDir = this.getDirectory;
+	async getDirectory(localDirectory, remoteDirectory, options) {
+		try {
+			return await this.#nodeSsh.getDirectory(localDirectory.toString(), remoteDirectory.toString(), options);
+		} catch (error) {
+			this.#logger.error(error);
+			return false;
+		}
+	}
+	async getFile(localFile, remoteFile, givenSftp, transferOptions) {
+		try {
+			await this.#nodeSsh.getFile(localFile.toString(), remoteFile.toString(), givenSftp, transferOptions);
+			return true;
+		} catch (error) {
+			this.#logger.error(error);
+			return false;
+		}
+	}
+	isConnected() {
+		return this.#nodeSsh.isConnected();
+	}
+	async mkdir(path) {
+		try {
+			await this.#nodeSsh.mkdir(path.toString());
+			return true;
+		} catch (error) {
+			this.#logger.error(error);
+			return false;
+		}
+	}
+	putDir = this.putDirectory;
+	async putDirectory(localDirectory, remoteDirectory, options) {
+		try {
+			return await this.#nodeSsh.putDirectory(localDirectory.toString(), remoteDirectory.toString(), options);
+		} catch (error) {
+			this.#logger.error(error);
+			return false;
+		}
+	}
+	async putFile(localFile, remoteFile, givenSftp, transferOptions) {
+		try {
+			await this.#nodeSsh.putFile(localFile.toString(), remoteFile.toString(), givenSftp, transferOptions);
+			return true;
+		} catch (error) {
+			this.#logger.error(error);
+			return false;
+		}
+	}
+	async putFiles(files, options) {
+		try {
+			const convertedFiles = files.map(({ local, remote }) => ({
+				local: local.toString(),
+				remote: remote.toString()
+			}));
+			await this.#nodeSsh.putFiles(convertedFiles, options);
+			return true;
+		} catch (error) {
+			this.#logger.error(error);
+			return false;
+		}
+	}
+	setLoggerLevel(level) {
+		this.#logger.level = loggerLevelStringToConsolaLogLevelMap[level];
+	}
+};
+
+//#endregion
+export { SshClient };
+//# sourceMappingURL=ssh-client.js.map

package/dist/classes/ssh-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssh-client.js","names":["#connectConfig","#logger","#nodeSsh"],"sources":["../../src/classes/ssh-client.ts"],"sourcesContent":["import { createConsola } from 'consola';\nimport type { ConsolaInstance } from 'consola';\nimport { NodeSSH } from 'node-ssh';\nimport type {\n    Config,\n    SSHExecCommandOptions,\n    SSHGetPutDirectoryOptions,\n    SSHPutFilesOptions,\n} from 'node-ssh';\nimport type {\n    SFTPWrapper,\n    TransferOptions,\n} from 'ssh2';\n\nimport type { Nullable } from '../types';\n\nimport type { PathLike } from './path';\n\nconst loggerLevelStringToConsolaLogLevelMap = {\n    debug: 4,\n    error: 0,\n    fatal: 0,\n    info: 3,\n    normal: 2,\n    silent: -999,\n    trace: 5,\n    verbose: 999,\n    warn: 1,\n} as const;\n\nexport class SshClient {\n    readonly #connectConfig: Config;\n    readonly #logger: ConsolaInstance;\n\n    #nodeSsh: NodeSSH;\n\n    constructor(host: string, username: string, password: string, port: number = 22, connectConfig?: Config) {\n        this.#connectConfig = {\n            ...connectConfig,\n            host,\n            password,\n            port,\n            username,\n        };\n\n        this.#logger = createConsola();\n        this.#nodeSsh = new NodeSSH();\n        if (process.env.NODE_ENV === 'production') this.setLoggerLevel('error');\n    }\n\n    get nodeSsh() {\n        return this.#nodeSsh;\n    }\n\n    async connect() {\n        try {\n            this.#nodeSsh = await this.#nodeSsh.connect(this.#connectConfig);\n            return true;\n        } catch (error) {\n            this.#logger.error(error);\n            return false;\n        }\n    }\n\n    disconnect() {\n        try {\n            this.#nodeSsh.dispose();\n            return true;\n        } catch (error) {\n            this.#logger.error(error);\n            return false;\n        }\n    }\n\n    execCommand(command: string, options?: SSHExecCommandOptions) {\n        return this.#nodeSsh.execCommand(command, options).catch(() => {});\n    }\n\n    execCommandWithIo(command: string, options?: SSHExecCommandOptions) {\n        return this.execCommand(\n            command,\n            {\n                ...options,\n                onStderr: (data) => process.stderr.write(data.toString()),\n                onStdout: (data) => process.stdout.write(data.toString()),\n            },\n        );\n    }\n\n    getDir = this.getDirectory;\n\n    async getDirectory(localDirectory: PathLike, remoteDirectory: PathLike, options?: SSHGetPutDirectoryOptions) {\n        try {\n            return await this.#nodeSsh.getDirectory(localDirectory.toString(), remoteDirectory.toString(), options);\n        } catch (error) {\n            this.#logger.error(error);\n            return false;\n        }\n    }\n\n    async getFile(\n        localFile: PathLike,\n        remoteFile: PathLike,\n        givenSftp?: Nullable<SFTPWrapper>,\n        transferOptions?: Nullable<TransferOptions>,\n    ) {\n        try {\n            await this.#nodeSsh.getFile(localFile.toString(), remoteFile.toString(), givenSftp, transferOptions);\n            return true;\n        } catch (error) {\n            this.#logger.error(error);\n            return false;\n        }\n    }\n\n    isConnected() {\n        return this.#nodeSsh.isConnected();\n    }\n\n    async mkdir(path: PathLike) {\n        try {\n            await this.#nodeSsh.mkdir(path.toString());\n            return true;\n        } catch (error) {\n            this.#logger.error(error);\n            return false;\n        }\n    }\n\n    putDir = this.putDirectory;\n\n    async putDirectory(localDirectory: PathLike, remoteDirectory: PathLike, options?: SSHGetPutDirectoryOptions) {\n        try {\n            return await this.#nodeSsh.putDirectory(localDirectory.toString(), remoteDirectory.toString(), options);\n        } catch (error) {\n            this.#logger.error(error);\n            return false;\n        }\n    }\n\n    async putFile(\n        localFile: PathLike,\n        remoteFile: PathLike,\n        givenSftp?: Nullable<SFTPWrapper>,\n        transferOptions?: Nullable<TransferOptions>,\n    ) {\n        try {\n            await this.#nodeSsh.putFile(localFile.toString(), remoteFile.toString(), givenSftp, transferOptions);\n            return true;\n        } catch (error) {\n            this.#logger.error(error);\n            return false;\n        }\n    }\n\n    async putFiles(files: { local: PathLike; remote: PathLike }[], options?: SSHPutFilesOptions) {\n        try {\n            const convertedFiles = files.map(({ local, remote }) => ({\n                local: local.toString(),\n                remote: remote.toString(),\n            }));\n\n            await this.#nodeSsh.putFiles(convertedFiles, options);\n            return true;\n        } catch (error) {\n            this.#logger.error(error);\n            return false;\n        }\n    }\n\n    setLoggerLevel(level: keyof typeof loggerLevelStringToConsolaLogLevelMap) {\n        this.#logger.level = loggerLevelStringToConsolaLogLevelMap[level];\n    }\n}\n"],"mappings":";;;;AAkBA,MAAM,wCAAwC;CAC1C,OAAO;CACP,OAAO;CACP,OAAO;CACP,MAAM;CACN,QAAQ;CACR,QAAQ;CACR,OAAO;CACP,SAAS;CACT,MAAM;CACT;AAED,IAAa,YAAb,MAAuB;CACnB,CAASA;CACT,CAASC;CAET;CAEA,YAAY,MAAc,UAAkB,UAAkB,OAAe,IAAI,eAAwB;AACrG,QAAKD,gBAAiB;GAClB,GAAG;GACH;GACA;GACA;GACA;GACH;AAED,QAAKC,SAAU,eAAe;AAC9B,QAAKC,UAAW,IAAI,SAAS;AAC7B,MAAI,QAAQ,IAAI,aAAa,aAAc,MAAK,eAAe,QAAQ;;CAG3E,IAAI,UAAU;AACV,SAAO,MAAKA;;CAGhB,MAAM,UAAU;AACZ,MAAI;AACA,SAAKA,UAAW,MAAM,MAAKA,QAAS,QAAQ,MAAKF,cAAe;AAChE,UAAO;WACF,OAAO;AACZ,SAAKC,OAAQ,MAAM,MAAM;AACzB,UAAO;;;CAIf,aAAa;AACT,MAAI;AACA,SAAKC,QAAS,SAAS;AACvB,UAAO;WACF,OAAO;AACZ,SAAKD,OAAQ,MAAM,MAAM;AACzB,UAAO;;;CAIf,YAAY,SAAiB,SAAiC;AAC1D,SAAO,MAAKC,QAAS,YAAY,SAAS,QAAQ,CAAC,YAAY,GAAG;;CAGtE,kBAAkB,SAAiB,SAAiC;AAChE,SAAO,KAAK,YACR,SACA;GACI,GAAG;GACH,WAAW,SAAS,QAAQ,OAAO,MAAM,KAAK,UAAU,CAAC;GACzD,WAAW,SAAS,QAAQ,OAAO,MAAM,KAAK,UAAU,CAAC;GAC5D,CACJ;;CAGL,SAAS,KAAK;CAEd,MAAM,aAAa,gBAA0B,iBAA2B,SAAqC;AACzG,MAAI;AACA,UAAO,MAAM,MAAKA,QAAS,aAAa,eAAe,UAAU,EAAE,gBAAgB,UAAU,EAAE,QAAQ;WAClG,OAAO;AACZ,SAAKD,OAAQ,MAAM,MAAM;AACzB,UAAO;;;CAIf,MAAM,QACF,WACA,YACA,WACA,iBACF;AACE,MAAI;AACA,SAAM,MAAKC,QAAS,QAAQ,UAAU,UAAU,EAAE,WAAW,UAAU,EAAE,WAAW,gBAAgB;AACpG,UAAO;WACF,OAAO;AACZ,SAAKD,OAAQ,MAAM,MAAM;AACzB,UAAO;;;CAIf,cAAc;AACV,SAAO,MAAKC,QAAS,aAAa;;CAGtC,MAAM,MAAM,MAAgB;AACxB,MAAI;AACA,SAAM,MAAKA,QAAS,MAAM,KAAK,UAAU,CAAC;AAC1C,UAAO;WACF,OAAO;AACZ,SAAKD,OAAQ,MAAM,MAAM;AACzB,UAAO;;;CAIf,SAAS,KAAK;CAEd,MAAM,aAAa,gBAA0B,iBAA2B,SAAqC;AACzG,MAAI;AACA,UAAO,MAAM,MAAKC,QAAS,aAAa,eAAe,UAAU,EAAE,gBAAgB,UAAU,EAAE,QAAQ;WAClG,OAAO;AACZ,SAAKD,OAAQ,MAAM,MAAM;AACzB,UAAO;;;CAIf,MAAM,QACF,WACA,YACA,WACA,iBACF;AACE,MAAI;AACA,SAAM,MAAKC,QAAS,QAAQ,UAAU,UAAU,EAAE,WAAW,UAAU,EAAE,WAAW,gBAAgB;AACpG,UAAO;WACF,OAAO;AACZ,SAAKD,OAAQ,MAAM,MAAM;AACzB,UAAO;;;CAIf,MAAM,SAAS,OAAgD,SAA8B;AACzF,MAAI;GACA,MAAM,iBAAiB,MAAM,KAAK,EAAE,OAAO,cAAc;IACrD,OAAO,MAAM,UAAU;IACvB,QAAQ,OAAO,UAAU;IAC5B,EAAE;AAEH,SAAM,MAAKC,QAAS,SAAS,gBAAgB,QAAQ;AACrD,UAAO;WACF,OAAO;AACZ,SAAKD,OAAQ,MAAM,MAAM;AACzB,UAAO;;;CAIf,eAAe,OAA2D;AACtE,QAAKA,OAAQ,QAAQ,sCAAsC"}

package/dist/event-awaiter.d.ts

@@ -22,6 +22,16 @@ declare class EventAwaiter<T> {
    * May be `undefined` to indicate no result or a timeout-like behavior.
    */
   trigger(key: string, value: T | undefined): void;
+  /**
+   * Triggers and resolves all pending promises across all keys.
+   *
+   * This is typically used during shutdown or cleanup to ensure that
+   * no consumer is left waiting indefinitely.
+   *
+   * @param {T | undefined} [value] - Optional value to resolve all waiters with.
+   * Defaults to `undefined`, which usually indicates cancellation or shutdown.
+   */
+  triggerAll(value?: T | undefined): void;
   /**
    * Waits for an event associated with the given key.
    *

package/dist/event-awaiter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-awaiter.d.ts","names":[],"sources":["../src/event-awaiter.ts"],"sourcesContent":[],"mappings":";;AAYA;;;;;;;;;;;AAmHoE,cAnHvD,YAmHuD,CAAA,CAAA,CAAA,CAAA;EAAA,CAAA,OAAA;;;;;;;;;8BAxGpC;;;;;;;;;;;;;;;;;;;;;;;;+EA+BiD,cAAW,QAAA;;;;;;;;;;;0DA2DhC,cAAW,QAAA;;;;;;;;;;;uDAcd,cAAW,QAAA"}
+{"version":3,"file":"event-awaiter.d.ts","names":[],"sources":["../src/event-awaiter.ts"],"sourcesContent":[],"mappings":";;AAYA;;;;;;;;;;;AAiIoE,cAjIvD,YAiIuD,CAAA,CAAA,CAAA,CAAA;UAAA;EAAA;;;;;;;;8BAtHpC;;;;;;;;;;qBAiBV;;;;;;;;;;;;;;;;;;;;;;;;+EA4B2D,cAAW,QAAA;;;;;;;;;;;0DA2DhC,cAAW,QAAA;;;;;;;;;;;uDAcd,cAAW,QAAA"}

package/dist/event-awaiter.js

@@ -29,6 +29,19 @@ var EventAwaiter = class {
 		}
 	}
 	/**
+	* Triggers and resolves all pending promises across all keys.
+	*
+	* This is typically used during shutdown or cleanup to ensure that
+	* no consumer is left waiting indefinitely.
+	*
+	* @param {T | undefined} [value] - Optional value to resolve all waiters with.
+	* Defaults to `undefined`, which usually indicates cancellation or shutdown.
+	*/
+	triggerAll(value = void 0) {
+		for (const [_, resolvers] of this.#promiseResolvers.entries()) resolvers.forEach((resolve) => resolve(value));
+		this.#promiseResolvers.clear();
+	}
+	/**
 	* Waits for an event associated with the given key.
 	*
 	* The returned promise will resolve when:

package/dist/event-awaiter.js.map

@@ -1 +1 @@
-{"version":3,"file":"event-awaiter.js","names":["#promiseResolvers","resolvers"],"sources":["../src/event-awaiter.ts"],"sourcesContent":["/**\n * EventAwaiter provides a mechanism to wait for events (by key) asynchronously.\n *\n * This class allows multiple consumers to `wait` for a specific key\n * and be resolved when `trigger` is called for that key, or automatically\n * resolved with `undefined` if a timeout occurs or an AbortSignal is triggered.\n *\n * Typical use cases include long-polling, request coordination,\n * or implementing event-driven primitives in applications or services.\n *\n * @template T - The type of value that will be resolved when the event is triggered\n */\nexport class EventAwaiter<T> {\n    #promiseResolvers = new Map<string, ((value: PromiseLike<T | undefined> | T | undefined) => void)[]>();\n\n    /**\n     * Triggers all pending promises waiting for the given key.\n     * Each promise will be resolved with the provided value.\n     *\n     * @param {string} key - Identifier for the awaited event\n     * @param {T | undefined} value - The value to resolve the awaiting promises with.\n     * May be `undefined` to indicate no result or a timeout-like behavior.\n     */\n    trigger(key: string, value: T | undefined) {\n        const resolvers = this.#promiseResolvers.get(key);\n        if (resolvers) {\n            this.#promiseResolvers.delete(key);\n            resolvers?.forEach((resolve) => resolve(value));\n        }\n    }\n\n    /**\n     * Waits for an event associated with the given key.\n     *\n     * The returned promise will resolve when:\n     *  - `trigger(key)` is called, in which case it resolves with the provided value.\n     *  - The optional timeout is reached, in which case it resolves with `undefined`.\n     *  - The optional `AbortSignal` is aborted, in which case it resolves with `undefined`.\n     *\n     * Behavior when multiple waiters exist for the same key:\n     *  - Default (no mode): multiple waiters are allowed, all will be resolved when triggered.\n     *  - `strict` mode: throws an error if a waiter already exists for the given key.\n     *  - `override` mode: cancels all existing waiters (resolving them with `undefined`)\n     *    and only keeps the latest one.\n     *\n     * @param {string} key - Identifier for the awaited event\n     * @param {number} [timeoutMs] - Optional timeout (in milliseconds).\n     * If reached, the promise resolves with `undefined`.\n     * @param {'override' | 'strict'} [mode] - Optional behavior mode for handling multiple waiters\n     * @param {AbortSignal} [signal] - Optional AbortSignal. If aborted, the promise resolves with `undefined`\n     *\n     * @returns {Promise<T | undefined>} A promise that resolves with the triggered value,\n     * or `undefined` if timeout or abort occurs\n     */\n    wait(key: string, timeoutMs?: number, mode?: 'override' | 'strict', signal?: AbortSignal) {\n        return new Promise<T | undefined>((resolve) => {\n            const resolvers = this.#promiseResolvers.get(key) || [];\n            if (resolvers.length) {\n                switch (mode) {\n                    case 'override':\n                        resolvers.forEach((r) => r(undefined));\n                        resolvers.length = 0;\n                        break;\n                    case 'strict':\n                        throw new Error(`Duplicate wait detected for key: ${key}`);\n                }\n            }\n\n            resolvers.push(resolve);\n            this.#promiseResolvers.set(key, resolvers);\n            if (timeoutMs) {\n                setTimeout(\n                    () => {\n                        const resolvers = this.#promiseResolvers.get(key);\n                        if (resolvers?.includes(resolve)) {\n                            resolve(undefined);\n                            const newResolvers = resolvers.filter((r) => r !== resolve);\n                            if (newResolvers.length) this.#promiseResolvers.set(key, newResolvers);\n                            else this.#promiseResolvers.delete(key);\n                        }\n                    },\n                    timeoutMs,\n                );\n            }\n\n            if (signal) {\n                signal.addEventListener(\n                    'abort',\n                    () => {\n                        const resolvers = this.#promiseResolvers.get(key);\n                        if (resolvers?.includes(resolve)) {\n                            resolve(undefined);\n                            const newResolvers = resolvers.filter((r) => r !== resolve);\n                            if (newResolvers.length) this.#promiseResolvers.set(key, newResolvers);\n                            else this.#promiseResolvers.delete(key);\n                        }\n                    },\n                    { once: true },\n                );\n            }\n        });\n    }\n\n    /**\n     * Waits for an event in strict mode.\n     * Only one waiter is allowed per key. If another waiter already exists,\n     * this method will throw an error.\n     *\n     * @param {string} key - Identifier for the awaited event\n     * @param {number} [timeoutMs] - Optional timeout (in milliseconds).\n     * If reached, the promise resolves with `undefined`.\n     * @param {AbortSignal} [signal] - Optional AbortSignal. If aborted, the promise resolves with `undefined`\n     */\n    waitExclusive(key: string, timeoutMs?: number, signal?: AbortSignal) {\n        return this.wait(key, timeoutMs, 'strict', signal);\n    }\n\n    /**\n     * Waits for an event in override mode.\n     * If another waiter already exists for the given key, it will be canceled\n     * (resolved with `undefined`) and replaced by the new waiter.\n     *\n     * @param {string} key - Identifier for the awaited event\n     * @param {number} [timeoutMs] - Optional timeout (in milliseconds).\n     * If reached, the promise resolves with `undefined`.\n     * @param {AbortSignal} [signal] - Optional AbortSignal. If aborted, the promise resolves with `undefined`\n     */\n    waitLatest(key: string, timeoutMs?: number, signal?: AbortSignal) {\n        return this.wait(key, timeoutMs, 'override', signal);\n    }\n}\n"],"mappings":";;;;;;;;;;;;;AAYA,IAAa,eAAb,MAA6B;CACzB,oCAAoB,IAAI,KAA8E;;;;;;;;;CAUtG,QAAQ,KAAa,OAAsB;EACvC,MAAM,YAAY,MAAKA,iBAAkB,IAAI,IAAI;AACjD,MAAI,WAAW;AACX,SAAKA,iBAAkB,OAAO,IAAI;AAClC,cAAW,SAAS,YAAY,QAAQ,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BvD,KAAK,KAAa,WAAoB,MAA8B,QAAsB;AACtF,SAAO,IAAI,SAAwB,YAAY;GAC3C,MAAM,YAAY,MAAKA,iBAAkB,IAAI,IAAI,IAAI,EAAE;AACvD,OAAI,UAAU,OACV,SAAQ,MAAR;IACI,KAAK;AACD,eAAU,SAAS,MAAM,EAAE,OAAU,CAAC;AACtC,eAAU,SAAS;AACnB;IACJ,KAAK,SACD,OAAM,IAAI,MAAM,oCAAoC,MAAM;;AAItE,aAAU,KAAK,QAAQ;AACvB,SAAKA,iBAAkB,IAAI,KAAK,UAAU;AAC1C,OAAI,UACA,kBACU;IACF,MAAMC,cAAY,MAAKD,iBAAkB,IAAI,IAAI;AACjD,QAAIC,aAAW,SAAS,QAAQ,EAAE;AAC9B,aAAQ,OAAU;KAClB,MAAM,eAAeA,YAAU,QAAQ,MAAM,MAAM,QAAQ;AAC3D,SAAI,aAAa,OAAQ,OAAKD,iBAAkB,IAAI,KAAK,aAAa;SACjE,OAAKA,iBAAkB,OAAO,IAAI;;MAG/C,UACH;AAGL,OAAI,OACA,QAAO,iBACH,eACM;IACF,MAAMC,cAAY,MAAKD,iBAAkB,IAAI,IAAI;AACjD,QAAIC,aAAW,SAAS,QAAQ,EAAE;AAC9B,aAAQ,OAAU;KAClB,MAAM,eAAeA,YAAU,QAAQ,MAAM,MAAM,QAAQ;AAC3D,SAAI,aAAa,OAAQ,OAAKD,iBAAkB,IAAI,KAAK,aAAa;SACjE,OAAKA,iBAAkB,OAAO,IAAI;;MAG/C,EAAE,MAAM,MAAM,CACjB;IAEP;;;;;;;;;;;;CAaN,cAAc,KAAa,WAAoB,QAAsB;AACjE,SAAO,KAAK,KAAK,KAAK,WAAW,UAAU,OAAO;;;;;;;;;;;;CAatD,WAAW,KAAa,WAAoB,QAAsB;AAC9D,SAAO,KAAK,KAAK,KAAK,WAAW,YAAY,OAAO"}
+{"version":3,"file":"event-awaiter.js","names":["#promiseResolvers","resolvers"],"sources":["../src/event-awaiter.ts"],"sourcesContent":["/**\n * EventAwaiter provides a mechanism to wait for events (by key) asynchronously.\n *\n * This class allows multiple consumers to `wait` for a specific key\n * and be resolved when `trigger` is called for that key, or automatically\n * resolved with `undefined` if a timeout occurs or an AbortSignal is triggered.\n *\n * Typical use cases include long-polling, request coordination,\n * or implementing event-driven primitives in applications or services.\n *\n * @template T - The type of value that will be resolved when the event is triggered\n */\nexport class EventAwaiter<T> {\n    #promiseResolvers = new Map<string, ((value: PromiseLike<T | undefined> | T | undefined) => void)[]>();\n\n    /**\n     * Triggers all pending promises waiting for the given key.\n     * Each promise will be resolved with the provided value.\n     *\n     * @param {string} key - Identifier for the awaited event\n     * @param {T | undefined} value - The value to resolve the awaiting promises with.\n     * May be `undefined` to indicate no result or a timeout-like behavior.\n     */\n    trigger(key: string, value: T | undefined) {\n        const resolvers = this.#promiseResolvers.get(key);\n        if (resolvers) {\n            this.#promiseResolvers.delete(key);\n            resolvers?.forEach((resolve) => resolve(value));\n        }\n    }\n\n    /**\n     * Triggers and resolves all pending promises across all keys.\n     *\n     * This is typically used during shutdown or cleanup to ensure that\n     * no consumer is left waiting indefinitely.\n     *\n     * @param {T | undefined} [value] - Optional value to resolve all waiters with.\n     * Defaults to `undefined`, which usually indicates cancellation or shutdown.\n     */\n    triggerAll(value: T | undefined = undefined) {\n        for (const [_, resolvers] of this.#promiseResolvers.entries()) resolvers.forEach((resolve) => resolve(value));\n        this.#promiseResolvers.clear();\n    }\n\n    /**\n     * Waits for an event associated with the given key.\n     *\n     * The returned promise will resolve when:\n     *  - `trigger(key)` is called, in which case it resolves with the provided value.\n     *  - The optional timeout is reached, in which case it resolves with `undefined`.\n     *  - The optional `AbortSignal` is aborted, in which case it resolves with `undefined`.\n     *\n     * Behavior when multiple waiters exist for the same key:\n     *  - Default (no mode): multiple waiters are allowed, all will be resolved when triggered.\n     *  - `strict` mode: throws an error if a waiter already exists for the given key.\n     *  - `override` mode: cancels all existing waiters (resolving them with `undefined`)\n     *    and only keeps the latest one.\n     *\n     * @param {string} key - Identifier for the awaited event\n     * @param {number} [timeoutMs] - Optional timeout (in milliseconds).\n     * If reached, the promise resolves with `undefined`.\n     * @param {'override' | 'strict'} [mode] - Optional behavior mode for handling multiple waiters\n     * @param {AbortSignal} [signal] - Optional AbortSignal. If aborted, the promise resolves with `undefined`\n     *\n     * @returns {Promise<T | undefined>} A promise that resolves with the triggered value,\n     * or `undefined` if timeout or abort occurs\n     */\n    wait(key: string, timeoutMs?: number, mode?: 'override' | 'strict', signal?: AbortSignal) {\n        return new Promise<T | undefined>((resolve) => {\n            const resolvers = this.#promiseResolvers.get(key) || [];\n            if (resolvers.length) {\n                switch (mode) {\n                    case 'override':\n                        resolvers.forEach((r) => r(undefined));\n                        resolvers.length = 0;\n                        break;\n                    case 'strict':\n                        throw new Error(`Duplicate wait detected for key: ${key}`);\n                }\n            }\n\n            resolvers.push(resolve);\n            this.#promiseResolvers.set(key, resolvers);\n            if (timeoutMs) {\n                setTimeout(\n                    () => {\n                        const resolvers = this.#promiseResolvers.get(key);\n                        if (resolvers?.includes(resolve)) {\n                            resolve(undefined);\n                            const newResolvers = resolvers.filter((r) => r !== resolve);\n                            if (newResolvers.length) this.#promiseResolvers.set(key, newResolvers);\n                            else this.#promiseResolvers.delete(key);\n                        }\n                    },\n                    timeoutMs,\n                );\n            }\n\n            if (signal) {\n                signal.addEventListener(\n                    'abort',\n                    () => {\n                        const resolvers = this.#promiseResolvers.get(key);\n                        if (resolvers?.includes(resolve)) {\n                            resolve(undefined);\n                            const newResolvers = resolvers.filter((r) => r !== resolve);\n                            if (newResolvers.length) this.#promiseResolvers.set(key, newResolvers);\n                            else this.#promiseResolvers.delete(key);\n                        }\n                    },\n                    { once: true },\n                );\n            }\n        });\n    }\n\n    /**\n     * Waits for an event in strict mode.\n     * Only one waiter is allowed per key. If another waiter already exists,\n     * this method will throw an error.\n     *\n     * @param {string} key - Identifier for the awaited event\n     * @param {number} [timeoutMs] - Optional timeout (in milliseconds).\n     * If reached, the promise resolves with `undefined`.\n     * @param {AbortSignal} [signal] - Optional AbortSignal. If aborted, the promise resolves with `undefined`\n     */\n    waitExclusive(key: string, timeoutMs?: number, signal?: AbortSignal) {\n        return this.wait(key, timeoutMs, 'strict', signal);\n    }\n\n    /**\n     * Waits for an event in override mode.\n     * If another waiter already exists for the given key, it will be canceled\n     * (resolved with `undefined`) and replaced by the new waiter.\n     *\n     * @param {string} key - Identifier for the awaited event\n     * @param {number} [timeoutMs] - Optional timeout (in milliseconds).\n     * If reached, the promise resolves with `undefined`.\n     * @param {AbortSignal} [signal] - Optional AbortSignal. If aborted, the promise resolves with `undefined`\n     */\n    waitLatest(key: string, timeoutMs?: number, signal?: AbortSignal) {\n        return this.wait(key, timeoutMs, 'override', signal);\n    }\n}\n"],"mappings":";;;;;;;;;;;;;AAYA,IAAa,eAAb,MAA6B;CACzB,oCAAoB,IAAI,KAA8E;;;;;;;;;CAUtG,QAAQ,KAAa,OAAsB;EACvC,MAAM,YAAY,MAAKA,iBAAkB,IAAI,IAAI;AACjD,MAAI,WAAW;AACX,SAAKA,iBAAkB,OAAO,IAAI;AAClC,cAAW,SAAS,YAAY,QAAQ,MAAM,CAAC;;;;;;;;;;;;CAavD,WAAW,QAAuB,QAAW;AACzC,OAAK,MAAM,CAAC,GAAG,cAAc,MAAKA,iBAAkB,SAAS,CAAE,WAAU,SAAS,YAAY,QAAQ,MAAM,CAAC;AAC7G,QAAKA,iBAAkB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;CA0BlC,KAAK,KAAa,WAAoB,MAA8B,QAAsB;AACtF,SAAO,IAAI,SAAwB,YAAY;GAC3C,MAAM,YAAY,MAAKA,iBAAkB,IAAI,IAAI,IAAI,EAAE;AACvD,OAAI,UAAU,OACV,SAAQ,MAAR;IACI,KAAK;AACD,eAAU,SAAS,MAAM,EAAE,OAAU,CAAC;AACtC,eAAU,SAAS;AACnB;IACJ,KAAK,SACD,OAAM,IAAI,MAAM,oCAAoC,MAAM;;AAItE,aAAU,KAAK,QAAQ;AACvB,SAAKA,iBAAkB,IAAI,KAAK,UAAU;AAC1C,OAAI,UACA,kBACU;IACF,MAAMC,cAAY,MAAKD,iBAAkB,IAAI,IAAI;AACjD,QAAIC,aAAW,SAAS,QAAQ,EAAE;AAC9B,aAAQ,OAAU;KAClB,MAAM,eAAeA,YAAU,QAAQ,MAAM,MAAM,QAAQ;AAC3D,SAAI,aAAa,OAAQ,OAAKD,iBAAkB,IAAI,KAAK,aAAa;SACjE,OAAKA,iBAAkB,OAAO,IAAI;;MAG/C,UACH;AAGL,OAAI,OACA,QAAO,iBACH,eACM;IACF,MAAMC,cAAY,MAAKD,iBAAkB,IAAI,IAAI;AACjD,QAAIC,aAAW,SAAS,QAAQ,EAAE;AAC9B,aAAQ,OAAU;KAClB,MAAM,eAAeA,YAAU,QAAQ,MAAM,MAAM,QAAQ;AAC3D,SAAI,aAAa,OAAQ,OAAKD,iBAAkB,IAAI,KAAK,aAAa;SACjE,OAAKA,iBAAkB,OAAO,IAAI;;MAG/C,EAAE,MAAM,MAAM,CACjB;IAEP;;;;;;;;;;;;CAaN,cAAc,KAAa,WAAoB,QAAsB;AACjE,SAAO,KAAK,KAAK,KAAK,WAAW,UAAU,OAAO;;;;;;;;;;;;CAatD,WAAW,KAAa,WAAoB,QAAsB;AAC9D,SAAO,KAAK,KAAK,KAAK,WAAW,YAAY,OAAO"}

package/dist/types/filtered-key-path.d.ts

@@ -0,0 +1,30 @@
+import { ObjectId } from "bson";
+
+//#region src/types/filtered-key-path.d.ts
+
+/**
+ * The following types are based on or inspired by types from the Element Plus project.
+ * Source: https://github.com/element-plus/element-plus
+ * License: MIT (https://opensource.org/licenses/MIT)
+ *
+ * Original types might have been modified to suit this project’s needs.
+ */
+/***/
+type ConditionalPath<K extends number | string, V, U> = V extends U ? `${K}` : DefaultPath<K, V, U, never>;
+type DefaultPath<K extends number | string, V, U = never, RK = `${K}`> = V extends TerminalType ? RK : `${K}.${FilteredKeyPath<V, U>}`;
+/**
+ * A utility type that generates a union of key paths from a given object type `T`,
+ * filtered by a specific type `U`. If `U` is
+ * not provided, it defaults to including all key paths.
+ *
+ * @template T - The object type to traverse.
+ * @template U - The type used to filter key paths. Defaults to `never`, meaning no filtering.
+ */
+type FilteredKeyPath<T, U = never> = T extends ReadonlyArray<infer V> ? (IsTuple<T> extends true ? { [K in TupleKey<T>]-?: PathImpl<Exclude<K, symbol>, T[K], U> }[TupleKey<T>] : PathImpl<number, V, U>) : { [K in keyof T]-?: PathImpl<Exclude<K, symbol>, T[K], U> }[keyof T];
+type IsTuple<T extends ReadonlyArray<any>> = number extends T['length'] ? false : true;
+type PathImpl<K extends number | string, V, U> = [U] extends [never] ? DefaultPath<K, V> : ConditionalPath<K, V, U>;
+type TerminalType = bigint | Blob | boolean | Date | File | null | number | ObjectId | RegExp | string | symbol | undefined;
+type TupleKey<T extends ReadonlyArray<any>> = Exclude<keyof T, keyof any[]>;
+//#endregion
+export { FilteredKeyPath };
+//# sourceMappingURL=filtered-key-path.d.ts.map

package/dist/types/filtered-key-path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filtered-key-path.d.ts","names":[],"sources":["../../src/types/filtered-key-path.ts"],"sourcesContent":[],"mappings":";;;;;;AAAqC;;;;;;KAWhC,eAAyF,CAAA,UAAA,MAAA,GAAA,MAAA,EAAA,CAAA,EAAA,CAAA,CAAA,GAAtC,CAAsC,SAA5B,CAA4B,GAAA,GAArB,CAAqB,EAAA,GAAf,WAAe,CAAH,CAAG,EAAA,CAAA,EAAG,CAAH,EAAA,KAAA,CAAA;KACzF,WAD4F,CAAA,UAAA,MAAA,GAAA,MAAA,EAAA,CAAA,EAAA,IAAA,KAAA,EAAA,KAAA,GAKrF,CALqF,EAAA,CAAA,GAM7F,CAN6F,SAMnF,YANmF,GAMpE,EANoE,GAAA,GAM5D,CAN4D,IAMvD,eANuD,CAMvC,CANuC,EAMpC,CANoC,CAAA,EAAA;;;AAAP;;;;;;AAMrD,KAWzB,eAXyB,CAAA,CAAA,EAAA,IAAA,KAAA,CAAA,GAWO,CAXP,SAWiB,aAXjB,CAAA,KAAA,EAAA,CAAA,GAAA,CAW2C,OAX3C,CAWmD,CAXnD,CAAA,SAAA,IAAA,GAAA,QAW6E,QAXxD,CAWiE,CAXjE,CAAA,KAWwE,QAXxE,CAWiF,OAXjF,CAWyF,CAXzF,EAAA,MAAA,CAAA,EAWqG,CAXrG,CAWuG,CAXvG,CAAA,EAW2G,CAX3G,CAAA,GAWgH,QAX7G,CAWsH,CAXtH,CAAA,CAAA,GAW4H,QAX5H,CAAA,MAAA,EAW6I,CAX7I,EAWgJ,CAXhJ,CAAA,CAAA,GAAA,QAAnB,MAWuL,CAXvL,KAW6L,QAX7L,CAWsM,OAXtM,CAW8M,CAX9M,EAAA,MAAA,CAAA,EAW0N,CAX1N,CAW4N,CAX5N,CAAA,EAWgO,CAXhO,CAAA,EAAe,CAAA,MAW4N,CAX5N,CAAA;AAWzD,KACK,OADO,CAAA,UACW,aADI,CAAA,GAAA,CAAA,CAAA,GAAA,MAAA,SACiC,CADjC,CAAA,QAAA,CAAA,GAAA,KAAA,GAAA,IAAA;KAEtB,QAFsB,CAAA,UAAA,MAAA,GAAA,MAAA,EAAA,CAAA,EAAA,CAAA,CAAA,GAAA,CAEuB,CAFvB,CAAA,SAAA,CAAA,KAAA,CAAA,GAE4C,WAF5C,CAEwD,CAFxD,EAE2D,CAF3D,CAAA,GAEgE,eAFhE,CAEgF,CAFhF,EAEmF,CAFnF,EAEsF,CAFtF,CAAA;KAGtB,YAAA,GAHuC,MAAA,GAKxC,IALwC,GAAA,OAAA,GAOxC,IAPwC,GAQxC,IARwC,GAAA,IAAA,GAAA,MAAA,GAWxC,QAXwC,GAYxC,MAZwC,GAAA,MAAA,GAAA,MAAA,GAAA,SAAA;KAiBvC,QAjBiD,CAAA,UAiB9B,aAjB8B,CAAA,GAAA,CAAA,CAAA,GAiBR,OAjBQ,CAAA,MAiBM,CAjBN,EAAA,MAAA,GAAA,EAAA,CAAA"}

package/dist/types/index.d.ts

@@ -0,0 +1,17 @@
+import { FilteredKeyPath } from "./filtered-key-path.js";
+import { Blob as Blob$1, Buffer, File as File$1 } from "node:buffer";
+
+//#region src/types/index.d.ts
+type AnyRecord = Record<string, any>;
+type BinaryInput = Blob | Buffer | File | Blob$1 | File$1;
+type Booleanish = 'false' | 'true' | boolean;
+type MaybePartial<T> = Partial<T> | T;
+type MaybeReadonly<T> = Readonly<T> | T;
+type Nullable<T> = null | T;
+type Numberish = number | string;
+type PartialRecord<K extends keyof any, T> = Partial<Record<K, T>>;
+type ReadonlyPartialRecord<K extends keyof any, T> = Readonly<PartialRecord<K, T>>;
+type ReadonlyRecord<K extends keyof any, T> = Readonly<Record<K, T>>;
+//#endregion
+export { AnyRecord, BinaryInput, Booleanish, type FilteredKeyPath, MaybePartial, MaybeReadonly, Nullable, Numberish, PartialRecord, ReadonlyPartialRecord, ReadonlyRecord };
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/types/index.ts"],"sourcesContent":[],"mappings":";;;;KAQY,SAAA,GAAY;KACZ,WAAA,GAAc,OAAO,SAAS,OAAO,SAAW;AADhD,KAEA,UAAA,GAFS,OAAG,GAAM,MAAA,GAAA,OAAA;AAClB,KAEA,YAFW,CAAA,CAAA,CAAA,GAEO,OAFP,CAEe,CAFf,CAAA,GAEoB,CAFpB;AAAA,KAGX,aAHW,CAAA,CAAA,CAAA,GAGQ,QAHR,CAGiB,CAHjB,CAAA,GAGsB,CAHtB;AAAG,KAId,QAJc,CAAA,CAAA,CAAA,GAAA,IAAA,GAIO,CAJP;AAAO,KAKrB,SAAA,GALqB,MAAA,GAAA,MAAA;AAAS,KAM9B,aAN8B,CAAA,UAAA,MAAA,GAAA,EAAA,CAAA,CAAA,GAMU,OANV,CAMkB,MANlB,CAMyB,CANzB,EAM4B,CAN5B,CAAA,CAAA;AAAO,KAOrC,qBAPqC,CAAA,UAAA,MAAA,GAAA,EAAA,CAAA,CAAA,GAOW,QAPX,CAOoB,aAPpB,CAOkC,CAPlC,EAOqC,CAPrC,CAAA,CAAA;AAAW,KAQhD,cARgD,CAAA,UAAA,MAAA,GAAA,EAAA,CAAA,CAAA,GAQP,QARO,CAQE,MARF,CAQS,CART,EAQY,CARZ,CAAA,CAAA"}

package/dist/types/vue.d.ts

@@ -0,0 +1,22 @@
+import { Nullable } from "./index.js";
+import { GlobalComponents } from "vue";
+
+//#region src/types/vue.d.ts
+
+/**
+ * A type that represents a reference to a Vue component instance.
+ * The reference can be either an instance of the specified component or null.
+ *
+ * @template K - The key of the component in the GlobalComponents.
+ *
+ * @example
+ * ```typescript
+ * import type { ComponentRef } from '@kikiutils/types/vue';
+ *
+ * const keepAliveRef = ref<ComponentRef<'KeepAlive'>>(null);
+ * ```
+ */
+type ComponentRef<K extends keyof GlobalComponents> = Nullable<InstanceType<GlobalComponents[K]>>;
+//#endregion
+export { ComponentRef };
+//# sourceMappingURL=vue.d.ts.map

package/dist/types/vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vue.d.ts","names":[],"sources":["../../src/types/vue.ts"],"sourcesContent":[],"mappings":";;;;;;;AAiBA;;;;;;;;;;;KAAY,6BAA6B,oBAAoB,SAAS,aAAa,iBAAiB"}

package/dist/vue.d.ts

@@ -1,3 +1,4 @@
+import { Nullable } from "./types/index.js";
 import { Ref } from "vue";
 
 //#region src/vue.d.ts
@@ -13,24 +14,24 @@ declare function appendRedirectParamFromCurrentRouteToUrl(url: string): string;
 /**
  * Clears an interval referenced by a Vue ref and sets it to null.
  *
- * @param {Ref<null | ReturnType<typeof setInterval>>} intervalRef - A Vue ref holding a NodeJS.Timeout or null
+ * @param {Ref<Nullable<ReturnType<typeof setInterval>>>} intervalRef - A Vue ref holding a NodeJS.Timeout or null
  */
-declare function clearIntervalRef(intervalRef: Ref<null | ReturnType<typeof setInterval>>): void;
+declare function clearIntervalRef(intervalRef: Ref<Nullable<ReturnType<typeof setInterval>>>): void;
 /**
  * Clears a timeout referenced by a Vue ref and sets it to null.
  *
- * @param {Ref<null | ReturnType<typeof setTimeout>>} timeoutRef - A Vue ref holding a NodeJS.Timeout or null
+ * @param {Ref<Nullable<ReturnType<typeof setTimeout>>>} timeoutRef - A Vue ref holding a NodeJS.Timeout or null
  */
-declare function clearTimeoutRef(timeoutRef: Ref<null | ReturnType<typeof setTimeout>>): void;
+declare function clearTimeoutRef(timeoutRef: Ref<Nullable<ReturnType<typeof setTimeout>>>): void;
 /**
  * A Vue composition function that remembers and restores scroll position
  * of a scrollable container across route changes and keep-alive activation.
  *
  * @template T - The type of the scrollable element (defaults to HTMLElement)
  *
- * @param {Ref<null | T>} containerRef - A ref to the scrollable HTML element
+ * @param {Ref<Nullable<T>>} containerRef - A ref to the scrollable HTML element
  */
-declare function usePreserveScroll<T extends Element = HTMLElement>(containerRef: Ref<null | T>): void;
+declare function usePreserveScroll<T extends Element = HTMLElement>(containerRef: Ref<Nullable<T>>): void;
 //#endregion
 export { appendRedirectParamFromCurrentRouteToUrl, clearIntervalRef, clearTimeoutRef, usePreserveScroll };
 //# sourceMappingURL=vue.d.ts.map

package/dist/vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vue.d.ts","names":[],"sources":["../src/vue.ts"],"sourcesContent":[],"mappings":";;;;;;AAgBA;AASA;;;;AAA8C,iBAT9B,wCAAA,CAS8B,GAAA,EAAA,MAAA,CAAA,EAAA,MAAA;;AAU9C;;;;AAA4C,iBAV5B,gBAAA,CAU4B,WAAA,EAVE,GAUF,CAAA,IAAA,GAVa,UAUb,CAAA,OAV+B,WAU/B,CAAA,CAAA,CAAA,EAAA,IAAA;;AAa5C;;;;AAA4F,iBAb5E,eAAA,CAa4E,UAAA,EAbhD,GAagD,CAAA,IAAA,GAbrC,UAaqC,CAAA,OAbnB,UAamB,CAAA,CAAA,CAAA,EAAA,IAAA;;;;;;;;;iBAA5E,4BAA4B,UAAU,2BAA2B,WAAW"}
+{"version":3,"file":"vue.d.ts","names":[],"sources":["../src/vue.ts"],"sourcesContent":[],"mappings":";;;;;;;AAiBA;AASA;;;;AAAkD,iBATlC,wCAAA,CASkC,GAAA,EAAA,MAAA,CAAA,EAAA,MAAA;;;AAUlD;;;AAAyD,iBAVzC,gBAAA,CAUyC,WAAA,EAVX,GAUW,CAVP,QAUO,CAVE,UAUF,CAAA,OAVoB,WAUpB,CAAA,CAAA,CAAA,CAAA,EAAA,IAAA;;;;AAazD;;AAA4C,iBAb5B,eAAA,CAa4B,UAAA,EAbA,GAaA,CAbI,QAaJ,CAba,UAab,CAAA,OAb+B,UAa/B,CAAA,CAAA,CAAA,CAAA,EAAA,IAAA;;;;;;;;;iBAA5B,4BAA4B,UAAU,2BAA2B,IAAI,SAAS"}

package/dist/vue.js

@@ -16,7 +16,7 @@ function appendRedirectParamFromCurrentRouteToUrl(url) {
 /**
 * Clears an interval referenced by a Vue ref and sets it to null.
 *
-* @param {Ref<null | ReturnType<typeof setInterval>>} intervalRef - A Vue ref holding a NodeJS.Timeout or null
+* @param {Ref<Nullable<ReturnType<typeof setInterval>>>} intervalRef - A Vue ref holding a NodeJS.Timeout or null
 */
 function clearIntervalRef(intervalRef) {
 	if (intervalRef.value) clearInterval(intervalRef.value);
@@ -25,7 +25,7 @@ function clearIntervalRef(intervalRef) {
 /**
 * Clears a timeout referenced by a Vue ref and sets it to null.
 *
-* @param {Ref<null | ReturnType<typeof setTimeout>>} timeoutRef - A Vue ref holding a NodeJS.Timeout or null
+* @param {Ref<Nullable<ReturnType<typeof setTimeout>>>} timeoutRef - A Vue ref holding a NodeJS.Timeout or null
 */
 function clearTimeoutRef(timeoutRef) {
 	if (timeoutRef.value) clearTimeout(timeoutRef.value);
@@ -37,7 +37,7 @@ function clearTimeoutRef(timeoutRef) {
 *
 * @template T - The type of the scrollable element (defaults to HTMLElement)
 *
-* @param {Ref<null | T>} containerRef - A ref to the scrollable HTML element
+* @param {Ref<Nullable<T>>} containerRef - A ref to the scrollable HTML element
 */
 function usePreserveScroll(containerRef) {
 	let scrollLeft = 0;

package/dist/vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"vue.js","names":[],"sources":["../src/vue.ts"],"sourcesContent":["import { onActivated } from 'vue';\nimport type { Ref } from 'vue';\nimport {\n    onBeforeRouteLeave,\n    useRoute,\n} from 'vue-router';\n\nimport { appendRedirectParamToUrl } from '@/url';\n\n/**\n * Appends the current Vue Router route's fullPath as the `redirect` query parameter to the given URL.\n *\n * @param {string} url - The base URL to modify\n *\n * @returns {string} A new URL with the current route fullPath as the `redirect` parameter\n */\nexport function appendRedirectParamFromCurrentRouteToUrl(url: string) {\n    return appendRedirectParamToUrl(url, useRoute().fullPath);\n}\n\n/**\n * Clears an interval referenced by a Vue ref and sets it to null.\n *\n * @param {Ref<null | ReturnType<typeof setInterval>>} intervalRef - A Vue ref holding a NodeJS.Timeout or null\n */\nexport function clearIntervalRef(intervalRef: Ref<null | ReturnType<typeof setInterval>>) {\n    if (intervalRef.value) clearInterval(intervalRef.value);\n    intervalRef.value = null;\n}\n\n/**\n * Clears a timeout referenced by a Vue ref and sets it to null.\n *\n * @param {Ref<null | ReturnType<typeof setTimeout>>} timeoutRef - A Vue ref holding a NodeJS.Timeout or null\n */\nexport function clearTimeoutRef(timeoutRef: Ref<null | ReturnType<typeof setTimeout>>) {\n    if (timeoutRef.value) clearTimeout(timeoutRef.value);\n    timeoutRef.value = null;\n}\n\n/**\n * A Vue composition function that remembers and restores scroll position\n * of a scrollable container across route changes and keep-alive activation.\n *\n * @template T - The type of the scrollable element (defaults to HTMLElement)\n *\n * @param {Ref<null | T>} containerRef - A ref to the scrollable HTML element\n */\nexport function usePreserveScroll<T extends Element = HTMLElement>(containerRef: Ref<null | T>) {\n    let scrollLeft = 0;\n    let scrollTop = 0;\n    onActivated(() => {\n        if (!containerRef.value) return;\n        containerRef.value.scrollLeft = scrollLeft;\n        containerRef.value.scrollTop = scrollTop;\n    });\n\n    onBeforeRouteLeave(() => {\n        scrollLeft = containerRef.value?.scrollLeft || 0;\n        scrollTop = containerRef.value?.scrollTop || 0;\n    });\n}\n"],"mappings":";;;;;;;;;;;;AAgBA,SAAgB,yCAAyC,KAAa;AAClE,QAAO,yBAAyB,KAAK,UAAU,CAAC,SAAS;;;;;;;AAQ7D,SAAgB,iBAAiB,aAAyD;AACtF,KAAI,YAAY,MAAO,eAAc,YAAY,MAAM;AACvD,aAAY,QAAQ;;;;;;;AAQxB,SAAgB,gBAAgB,YAAuD;AACnF,KAAI,WAAW,MAAO,cAAa,WAAW,MAAM;AACpD,YAAW,QAAQ;;;;;;;;;;AAWvB,SAAgB,kBAAmD,cAA6B;CAC5F,IAAI,aAAa;CACjB,IAAI,YAAY;AAChB,mBAAkB;AACd,MAAI,CAAC,aAAa,MAAO;AACzB,eAAa,MAAM,aAAa;AAChC,eAAa,MAAM,YAAY;GACjC;AAEF,0BAAyB;AACrB,eAAa,aAAa,OAAO,cAAc;AAC/C,cAAY,aAAa,OAAO,aAAa;GAC/C"}
+{"version":3,"file":"vue.js","names":[],"sources":["../src/vue.ts"],"sourcesContent":["import { onActivated } from 'vue';\nimport type { Ref } from 'vue';\nimport {\n    onBeforeRouteLeave,\n    useRoute,\n} from 'vue-router';\n\nimport type { Nullable } from './types';\nimport { appendRedirectParamToUrl } from './url';\n\n/**\n * Appends the current Vue Router route's fullPath as the `redirect` query parameter to the given URL.\n *\n * @param {string} url - The base URL to modify\n *\n * @returns {string} A new URL with the current route fullPath as the `redirect` parameter\n */\nexport function appendRedirectParamFromCurrentRouteToUrl(url: string) {\n    return appendRedirectParamToUrl(url, useRoute().fullPath);\n}\n\n/**\n * Clears an interval referenced by a Vue ref and sets it to null.\n *\n * @param {Ref<Nullable<ReturnType<typeof setInterval>>>} intervalRef - A Vue ref holding a NodeJS.Timeout or null\n */\nexport function clearIntervalRef(intervalRef: Ref<Nullable<ReturnType<typeof setInterval>>>) {\n    if (intervalRef.value) clearInterval(intervalRef.value);\n    intervalRef.value = null;\n}\n\n/**\n * Clears a timeout referenced by a Vue ref and sets it to null.\n *\n * @param {Ref<Nullable<ReturnType<typeof setTimeout>>>} timeoutRef - A Vue ref holding a NodeJS.Timeout or null\n */\nexport function clearTimeoutRef(timeoutRef: Ref<Nullable<ReturnType<typeof setTimeout>>>) {\n    if (timeoutRef.value) clearTimeout(timeoutRef.value);\n    timeoutRef.value = null;\n}\n\n/**\n * A Vue composition function that remembers and restores scroll position\n * of a scrollable container across route changes and keep-alive activation.\n *\n * @template T - The type of the scrollable element (defaults to HTMLElement)\n *\n * @param {Ref<Nullable<T>>} containerRef - A ref to the scrollable HTML element\n */\nexport function usePreserveScroll<T extends Element = HTMLElement>(containerRef: Ref<Nullable<T>>) {\n    let scrollLeft = 0;\n    let scrollTop = 0;\n    onActivated(() => {\n        if (!containerRef.value) return;\n        containerRef.value.scrollLeft = scrollLeft;\n        containerRef.value.scrollTop = scrollTop;\n    });\n\n    onBeforeRouteLeave(() => {\n        scrollLeft = containerRef.value?.scrollLeft || 0;\n        scrollTop = containerRef.value?.scrollTop || 0;\n    });\n}\n"],"mappings":";;;;;;;;;;;;AAiBA,SAAgB,yCAAyC,KAAa;AAClE,QAAO,yBAAyB,KAAK,UAAU,CAAC,SAAS;;;;;;;AAQ7D,SAAgB,iBAAiB,aAA4D;AACzF,KAAI,YAAY,MAAO,eAAc,YAAY,MAAM;AACvD,aAAY,QAAQ;;;;;;;AAQxB,SAAgB,gBAAgB,YAA0D;AACtF,KAAI,WAAW,MAAO,cAAa,WAAW,MAAM;AACpD,YAAW,QAAQ;;;;;;;;;;AAWvB,SAAgB,kBAAmD,cAAgC;CAC/F,IAAI,aAAa;CACjB,IAAI,YAAY;AAChB,mBAAkB;AACd,MAAI,CAAC,aAAa,MAAO;AACzB,eAAa,MAAM,aAAa;AAChC,eAAa,MAAM,YAAY;GACjC;AAEF,0BAAyB;AACrB,eAAa,aAAa,OAAO,cAAc;AAC/C,cAAY,aAAa,OAAO,aAAa;GAC/C"}

package/dist/web.js.map

@@ -1 +1 @@
-{"version":3,"file":"web.js","names":[],"sources":["../src/web.ts"],"sourcesContent":["import { appendRedirectParamToUrl } from '@/url';\n\n/**\n * Appends the current browser URL (including path, query, and hash) as the `redirect` query parameter to the given URL.\n *\n * @param {string} url - The base URL to modify\n *\n * @returns {string} A new URL with the current location as the `redirect` parameter\n */\nexport function appendRedirectParamFromCurrentLocationToUrl(url: string) {\n    const currentPath = `${window.location.pathname}${window.location.search}${window.location.hash}`;\n    return appendRedirectParamToUrl(url, currentPath);\n}\n\n/**\n * Navigates to the given URL, appending the current browser location\n * (path, query, and hash) as the `redirect` query parameter.\n *\n * Useful for redirecting to login or other gateways while preserving\n * the current location for post-auth navigation.\n *\n * @param {string} url - The destination URL to navigate to\n * @param {number} [delayMs] - Optional delay in milliseconds before navigation\n */\nexport function assignUrlWithRedirectParamFromCurrentLocation(url: string, delayMs?: number) {\n    if (delayMs === undefined) window.location.assign(appendRedirectParamFromCurrentLocationToUrl(url));\n    else return setTimeout(() => window.location.assign(appendRedirectParamFromCurrentLocationToUrl(url)), delayMs);\n}\n"],"mappings":";;;;;;;;;;AASA,SAAgB,4CAA4C,KAAa;CACrE,MAAM,cAAc,GAAG,OAAO,SAAS,WAAW,OAAO,SAAS,SAAS,OAAO,SAAS;AAC3F,QAAO,yBAAyB,KAAK,YAAY;;;;;;;;;;;;AAarD,SAAgB,8CAA8C,KAAa,SAAkB;AACzF,KAAI,YAAY,OAAW,QAAO,SAAS,OAAO,4CAA4C,IAAI,CAAC;KAC9F,QAAO,iBAAiB,OAAO,SAAS,OAAO,4CAA4C,IAAI,CAAC,EAAE,QAAQ"}
+{"version":3,"file":"web.js","names":[],"sources":["../src/web.ts"],"sourcesContent":["import { appendRedirectParamToUrl } from './url';\n\n/**\n * Appends the current browser URL (including path, query, and hash) as the `redirect` query parameter to the given URL.\n *\n * @param {string} url - The base URL to modify\n *\n * @returns {string} A new URL with the current location as the `redirect` parameter\n */\nexport function appendRedirectParamFromCurrentLocationToUrl(url: string) {\n    const currentPath = `${window.location.pathname}${window.location.search}${window.location.hash}`;\n    return appendRedirectParamToUrl(url, currentPath);\n}\n\n/**\n * Navigates to the given URL, appending the current browser location\n * (path, query, and hash) as the `redirect` query parameter.\n *\n * Useful for redirecting to login or other gateways while preserving\n * the current location for post-auth navigation.\n *\n * @param {string} url - The destination URL to navigate to\n * @param {number} [delayMs] - Optional delay in milliseconds before navigation\n */\nexport function assignUrlWithRedirectParamFromCurrentLocation(url: string, delayMs?: number) {\n    if (delayMs === undefined) window.location.assign(appendRedirectParamFromCurrentLocationToUrl(url));\n    else return setTimeout(() => window.location.assign(appendRedirectParamFromCurrentLocationToUrl(url)), delayMs);\n}\n"],"mappings":";;;;;;;;;;AASA,SAAgB,4CAA4C,KAAa;CACrE,MAAM,cAAc,GAAG,OAAO,SAAS,WAAW,OAAO,SAAS,SAAS,OAAO,SAAS;AAC3F,QAAO,yBAAyB,KAAK,YAAY;;;;;;;;;;;;AAarD,SAAgB,8CAA8C,KAAa,SAAkB;AACzF,KAAI,YAAY,OAAW,QAAO,SAAS,OAAO,4CAA4C,IAAI,CAAC;KAC9F,QAAO,iBAAiB,OAAO,SAAS,OAAO,4CAA4C,IAAI,CAAC,EAAE,QAAQ"}