@nemigo/helpers 0.0.4 → 0.0.7

package/dist/explorer.d.ts

@@ -0,0 +1,14 @@
+import type { PathLike, Stats } from "node:fs";
+/**
+ * Проверяет существование пути и его тип (файл или папка) через {@link stat}
+ *
+ * @param path - Путь для проверки
+ * @param [expected] - Ожидаемый тип: `"file"` (файл) или `"folder"` (папка)
+ * @param [strict=false] - Если `true`, выбрасывает ошибку, если путь не существует
+ *
+ * @returns {@link Stats}, если путь существует и соответствует ожидаемому типу (если указан). Иначе возвращает `null`, если `strict = false`
+ * @throws {Error} Если `strict = true` и путь не существует или не соответствует ожидаемому типу
+ */
+declare function exists(path: PathLike, expected?: "file" | "folder", strict?: boolean): Promise<Stats | null>;
+declare function exists(path: PathLike, expected: "file" | "folder" | undefined, strict: true): Promise<Stats>;
+export { exists };

package/dist/explorer.js

@@ -0,0 +1,21 @@
+import { stat } from "node:fs/promises";
+async function exists(path, expected, strict = false) {
+    let existed;
+    try {
+        existed = await stat(path);
+    }
+    catch {
+        if (strict) {
+            throw new Error(`Путь "${path}" не существует или к нему нет доступа`);
+        }
+        return null;
+    }
+    if (expected === "file" && existed.isDirectory()) {
+        throw new Error(`Ожидалось, что "${path}" будет файлом`);
+    }
+    else if (expected === "folder" && existed.isFile()) {
+        throw new Error(`Ожидалось, что "${path}" будет папкой`);
+    }
+    return existed;
+}
+export { exists };

package/dist/lens.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Режим работы линзы:
+ * - `"exclude"` (исключение)
+ * - `"include"` (включение)
+ */
+export type LensMode = "exclude" | "include";
+export type LensSchema<O> = {
+    [K in keyof O]?: boolean;
+};
+/**
+ * Конфигурация для {@link Lens}
+ */
+export interface LensConfig<O> {
+    /**
+     * Режим работы линзы {@link LensMode}
+     *
+     * @default "exclude"
+     */
+    mode?: LensMode;
+    /**
+     * Схема, определяющая, какие ключи включить или исключить
+     *
+     * @default {}
+     */
+    schema?: LensSchema<O>;
+}
+/**
+ * Линза для фильтрации на основе схемы и режима
+ *
+ * @template O - Тип объект для схемы, с которой работает линза
+ */
+export declare class Lens<O> {
+    /**
+     * Режим работы линзы {@link LensMode}
+     *
+     * @default "exclude"
+     */
+    _mode: LensMode;
+    /**
+     * Схема, определяющая, какие ключи включить или исключить
+     *
+     * @default {}
+     */
+    _schema: LensSchema<O>;
+    /**
+     * Создаёт экземпляр линзы
+     *
+     * @param config - Конфигурация линзы {@link LensConfig}
+     */
+    constructor(config: LensConfig<O>);
+    /**
+     * Пересборка под другую конфигурацию
+     *
+     * @param config - Конфигурация линзы {@link LensConfig}
+     */
+    reconstruct(config: LensConfig<O>): void;
+    /**
+     * Проверяет, должен ли ключ быть включён в результат
+     *
+     * @param key - Ключ для проверки
+     * @returns `true`, если ключ должен быть включён, иначе `false`
+     */
+    get(key: keyof O): boolean;
+}

package/dist/lens.js

@@ -0,0 +1,50 @@
+/**
+ * Линза для фильтрации на основе схемы и режима
+ *
+ * @template O - Тип объект для схемы, с которой работает линза
+ */
+export class Lens {
+    /**
+     * Режим работы линзы {@link LensMode}
+     *
+     * @default "exclude"
+     */
+    _mode;
+    /**
+     * Схема, определяющая, какие ключи включить или исключить
+     *
+     * @default {}
+     */
+    _schema;
+    /**
+     * Создаёт экземпляр линзы
+     *
+     * @param config - Конфигурация линзы {@link LensConfig}
+     */
+    constructor(config) {
+        this.reconstruct(config);
+    }
+    /**
+     * Пересборка под другую конфигурацию
+     *
+     * @param config - Конфигурация линзы {@link LensConfig}
+     */
+    reconstruct(config) {
+        this._mode = config.mode ?? "exclude";
+        this._schema = config.schema ?? {};
+    }
+    /**
+     * Проверяет, должен ли ключ быть включён в результат
+     *
+     * @param key - Ключ для проверки
+     * @returns `true`, если ключ должен быть включён, иначе `false`
+     */
+    get(key) {
+        if (this._mode === "exclude") {
+            // Если в конфиге есть ключ в режиме исключения, то key false. Если нет — то true
+            return !this._schema[key];
+        }
+        // Если в конфиге есть ключ, то key true. Если нет — то false
+        return !!this._schema[key];
+    }
+}

package/dist/script.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Ищет значение флага в массиве аргументов процесса
+ *
+ * @param cmd - Команда, которой скрипт был запущен (`process.argv`)
+ * @param name - Имя флага, который нужно найти
+ * @param [strict=true] - Если `true`, выбрасывает ошибку, если флаг не найден. Если `false`, возвращает `null`
+ *
+ * @returns Значение флага (или `null`, если флаг не найден и `strict = false`)
+ * @throws {Error} Если `strict = true` и флаг не найден
+ */
+declare function getProcessFlag(cmd: string[], name: string, strict: boolean): string | null;
+declare function getProcessFlag(cmd: string[], name: string, strict?: true): string;
+export { getProcessFlag };

package/dist/script.js

@@ -0,0 +1,14 @@
+function getProcessFlag(cmd, name, strict = true) {
+    const argv = cmd.slice(2);
+    const index = argv.indexOf(name);
+    if (index > -1) {
+        const value = argv[index + 1];
+        if (value)
+            return value;
+    }
+    if (strict) {
+        throw new Error(`Флаг "${name}" не найден`);
+    }
+    return null;
+}
+export { getProcessFlag };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nemigo/helpers",
-	"version": "0.0.4",
+	"version": "0.0.7",
 	"private": false,
 	"author": {
 		"name": "Vlad Logvin",
@@ -12,13 +12,28 @@
 		"check": "tsc --noemit",
 		"lint": "eslint ./",
 		"test": "vitest --run",
-		"format": "prettier --write ./",
-		"publish": "npm publish"
+		"format": "prettier --write ./"
 	},
 	"exports": {
+		"./explorer": {
+			"types": "./dist/explorer.d.ts",
+			"default": "./dist/explorer.js"
+		},
+		"./lens": {
+			"types": "./dist/lens.d.ts",
+			"default": "./dist/lens.js"
+		},
 		"./msgpack": {
 			"types": "./dist/msgpack.d.ts",
 			"default": "./dist/msgpack.js"
+		},
+		"./random": {
+			"types": "./dist/random.d.ts",
+			"default": "./dist/random.js"
+		},
+		"./script": {
+			"types": "./dist/script.d.ts",
+			"default": "./dist/script.js"
 		}
 	},
 	"dependencies": {