@datatruck/cli 0.37.0 → 0.38.1

package/lib/utils/datatruck/command.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createCommands = exports.createCommand = exports.datatruckCommandMap = void 0;
+exports.createCommands = exports.createCommand = exports.datatruckCommands = void 0;
 const BackupCommand_1 = require("../../commands/BackupCommand");
 const CleanCacheCommand_1 = require("../../commands/CleanCacheCommand");
 const ConfigCommand_1 = require("../../commands/ConfigCommand");
 const CopyCommand_1 = require("../../commands/CopyCommand");
+const ExportCommand_1 = require("../../commands/ExportCommand");
 const InitCommand_1 = require("../../commands/InitCommand");
 const PruneCommand_1 = require("../../commands/PruneCommand");
 const RestoreCommand_1 = require("../../commands/RestoreCommand");
@@ -13,7 +14,7 @@ const SnapshotsCommand_1 = require("../../commands/SnapshotsCommand");
 const StartServerCommand_1 = require("../../commands/StartServerCommand");
 const error_1 = require("../error");
 const stream_1 = require("stream");
-exports.datatruckCommandMap = {
+exports.datatruckCommands = {
     config: ConfigCommand_1.ConfigCommand,
     init: InitCommand_1.InitCommand,
     snapshots: SnapshotsCommand_1.SnapshotsCommand,
@@ -24,9 +25,10 @@ exports.datatruckCommandMap = {
     copy: CopyCommand_1.CopyCommand,
     cleanCache: CleanCacheCommand_1.CleanCacheCommand,
     startServer: StartServerCommand_1.StartServerCommand,
+    export: ExportCommand_1.ExportCommand,
 };
 function createCommand(name, globalOptions, options, streams, configPath) {
-    const constructor = exports.datatruckCommandMap[name];
+    const constructor = exports.datatruckCommands[name];
     if (!constructor)
         throw new error_1.AppError(`Invalid command name: ${name}`);
     return new constructor(globalOptions, options, streams, configPath);
@@ -34,7 +36,7 @@ function createCommand(name, globalOptions, options, streams, configPath) {
 exports.createCommand = createCommand;
 function createCommands(globalOptions) {
     const object = {};
-    for (const name in exports.datatruckCommandMap) {
+    for (const name in exports.datatruckCommands) {
         object[name] = async (options) => {
             let stdoutData = "";
             const stdout = new stream_1.Writable({
@@ -51,7 +53,9 @@ function createCommands(globalOptions) {
                 if (exitCode !== 0)
                     throw new Error(`Invalid exit code: ${exitCode}`);
                 await end();
-                return JSON.parse(stdoutData);
+                return ["run", "export"].includes(name)
+                    ? undefined
+                    : JSON.parse(stdoutData);
             }
             finally {
                 await end();

package/lib/utils/datatruck/job.js

@@ -4,6 +4,7 @@ exports.runJob = void 0;
 const async_process_1 = require("../async-process");
 const cli_1 = require("../cli");
 const fs_1 = require("../fs");
+const options_1 = require("../options");
 const command_1 = require("./command");
 const cron_server_1 = require("./cron-server");
 const fs_2 = require("fs");
@@ -12,9 +13,9 @@ const path_1 = require("path");
 async function runJob(job, name, config) {
     let pid = 0;
     try {
-        const Command = command_1.datatruckCommandMap[job.action];
+        const Command = command_1.datatruckCommands[job.action];
         const command = new Command({ config: { packages: [], repositories: [] } }, {});
-        const cliOptions = (0, cli_1.stringifyOptions)(command.optionsConfig(), job.action === "prune"
+        const cliOptions = (0, options_1.stringifyOptions)(command.optionsConfig, job.action === "prune"
             ? ({ ...job.options, confirm: true })
             : job.options);
         const [node, bin] = process.argv;
@@ -26,13 +27,8 @@ async function runJob(job, name, config) {
         let stream;
         let logPath;
         const dt = new Date().toISOString().replaceAll(":", "-");
-        if (baseLogPath) {
-            const tmpLogPath = (0, path_1.join)(baseLogPath, dt) + ".log";
-            await (0, promises_1.mkdir)(baseLogPath, { recursive: true });
-            stream = (0, fs_2.createWriteStream)(tmpLogPath);
-        }
-        const p = new async_process_1.AsyncProcess(node, [
-            process.env.pm_exec_path ?? bin,
+        const argv = [
+            process.env.DTT_BIN_SCRIPT ?? process.env.pm_exec_path ?? bin,
             "--tty",
             "false",
             "--progress",
@@ -41,7 +37,14 @@ async function runJob(job, name, config) {
             config.configPath,
             job.action,
             ...cliOptions,
-        ], {
+        ];
+        if (baseLogPath) {
+            const tmpLogPath = (0, path_1.join)(baseLogPath, dt) + ".log";
+            await (0, promises_1.mkdir)(baseLogPath, { recursive: true });
+            stream = (0, fs_2.createWriteStream)(tmpLogPath);
+            stream.write(`+ dtt ${argv.join(" ")}\n`);
+        }
+        const p = new async_process_1.AsyncProcess(node, argv, {
             $log: config.verbose,
             $exitCode: false,
             env: {
@@ -59,8 +62,10 @@ async function runJob(job, name, config) {
             stream && p.stderr.pipe(stream),
             stream && p.stdout.pipe(stream),
         ]);
-        if (stream)
-            await (0, fs_1.safeRename)(stream.path.toString(), (logPath = (0, path_1.join)(stream.path.toString(), `${dt}-${pid}.log`)));
+        if (stream) {
+            const base = (0, path_1.dirname)(stream.path.toString());
+            await (0, fs_1.safeRename)(stream.path.toString(), (logPath = (0, path_1.join)(base, `${dt}-${pid}.log`)));
+        }
         if (config.log)
             (0, cli_1.logJson)("job", `'${name}' finished`, {
                 pid,

package/lib/utils/datatruck/repository.d.ts

@@ -13,4 +13,5 @@ export declare function getRepoConstructor(type: keyof typeof repoMap): {
 };
 export declare function createRepo(repository: RepositoryConfig, verbose: boolean | undefined): RepositoryAbstract<any>;
 export declare function createAndInitRepo(repository: RepositoryConfig, verbose: boolean | undefined): Promise<RepositoryAbstract<any>>;
+export declare function initSnapshotPath(path: string, minFreeDiskSpace?: string | number): Promise<void>;
 export {};

package/lib/utils/datatruck/repository.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAndInitRepo = exports.createRepo = exports.getRepoConstructor = void 0;
+exports.initSnapshotPath = exports.createAndInitRepo = exports.createRepo = exports.getRepoConstructor = void 0;
 const DatatruckRepository_1 = require("../../repositories/DatatruckRepository");
 const GitRepository_1 = require("../../repositories/GitRepository");
 const ResticRepository_1 = require("../../repositories/ResticRepository");
 const error_1 = require("../error");
+const fs_1 = require("../fs");
 const repoMap = {
     [GitRepository_1.gitRepositoryName]: GitRepository_1.GitRepository,
     [ResticRepository_1.resticRepositoryName]: ResticRepository_1.ResticRepository,
@@ -28,3 +29,9 @@ async function createAndInitRepo(repository, verbose) {
     return repo;
 }
 exports.createAndInitRepo = createAndInitRepo;
+async function initSnapshotPath(path, minFreeDiskSpace) {
+    await (0, fs_1.initEmptyDir)(path);
+    if (minFreeDiskSpace)
+        await (0, fs_1.ensureFreeDiskSpace)([path], minFreeDiskSpace);
+}
+exports.initSnapshotPath = initSnapshotPath;

package/lib/utils/git.d.ts

@@ -37,7 +37,11 @@ export declare class Git {
         name: string;
         message?: string | undefined;
     }[]>;
-    addTag(name: string, message?: string): Promise<void>;
+    addTag(name: string, message?: string, options?: {
+        allowEmpty?: boolean;
+        userName?: string;
+        userEmail?: string;
+    }): Promise<void>;
     pushTags(): Promise<void>;
     push(options: {
         branchName: string;

package/lib/utils/git.js

@@ -98,12 +98,16 @@ class Git {
             return result;
         }, []);
     }
-    async addTag(name, message) {
+    async addTag(name, message, options = {}) {
+        const commit = [
+            ...(options.userName ? ["-c", `user.name='${options.userName}'`] : []),
+            ...(options.userEmail ? ["-c", `user.email='${options.userEmail}'`] : []),
+        ];
         if (message) {
-            await this.exec(["tag", "-a", name, "-m", message]);
+            await this.exec([...commit, "tag", "-a", name, "-m", message]);
         }
         else {
-            await this.exec(["tag", name]);
+            await this.exec([...commit, "tag", name]);
         }
     }
     async pushTags() {

package/lib/utils/math.js

@@ -10,7 +10,7 @@ exports.progressPercent = progressPercent;
 class Counter {
     maxValue;
     value = 0;
-    constructor(maxValue = 4294967295) {
+    constructor(maxValue = 4_294_967_295) {
         this.maxValue = maxValue;
     }
     next() {

package/lib/utils/object.d.ts

@@ -1,5 +1,10 @@
 export declare function merge<T extends Record<string, unknown>>(target: T, ...sources: Record<string, unknown>[]): T;
 export declare function omitProp<T extends Record<string, any>, N extends keyof T>(object: T, name: N): Omit<T, N>;
+export declare function pickProps<T extends Record<string, any>, I extends {
+    [K in keyof T]?: boolean;
+}>(object: T, input: I): {
+    [K in keyof T as K extends keyof I ? [I[K]] extends [true] ? K : never : never]: T[K];
+};
 export declare function getErrorProperties(error: Error): Record<string, string>;
 type GroupByKeyParamType<TItem> = ((item: TItem) => string[] | string) | (keyof TItem)[] | keyof TItem;
 export declare function groupBy<TItem>(items: TItem[], keyOrCb: GroupByKeyParamType<TItem>): Record<string, TItem[]>;

package/lib/utils/object.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StrictMap = exports.groupBy = exports.getErrorProperties = exports.omitProp = exports.merge = void 0;
+exports.StrictMap = exports.groupBy = exports.getErrorProperties = exports.pickProps = exports.omitProp = exports.merge = void 0;
 function merge(target, ...sources) {
     const isObject = (o) => typeof o === "object" && o !== null;
     for (const source of sources)
@@ -19,6 +19,15 @@ function omitProp(object, name) {
     return result;
 }
 exports.omitProp = omitProp;
+function pickProps(object, input) {
+    const result = {};
+    for (const name in input) {
+        if (input[name])
+            result[name] = object[name];
+    }
+    return result;
+}
+exports.pickProps = pickProps;
 function getErrorProperties(error) {
     const alt = {};
     for (const key of Object.getOwnPropertyNames(error)) {

package/lib/utils/options.d.ts

@@ -0,0 +1,24 @@
+export type OptionsConfigObject = {
+    flag?: string | false;
+    shortFlag?: string;
+    description: string;
+    required?: boolean;
+    defaults?: any;
+    value?: "boolean" | "number" | "string" | "array" | ((value: string) => any);
+};
+export type OptionsConfig = Record<string, OptionsConfigObject>;
+export type InferOptionsValue<O extends OptionsConfigObject> = [
+    O["value"]
+] extends ["number"] ? number : [O["value"]] extends ["boolean"] ? boolean : [O["value"]] extends ["array"] ? string[] : O["value"] extends (value: any) => any ? ReturnType<O["value"]> : string;
+export type InferOptions<T extends OptionsConfig> = {
+    [K in keyof T as [T[K]["required"]] extends [true] ? K : never]: InferOptionsValue<T[K]>;
+} & {
+    [K in keyof T as [T[K]["required"]] extends [true] ? never : K]?: InferOptionsValue<T[K]>;
+};
+export type CommandConfig<T extends OptionsConfig = OptionsConfig> = {
+    name: string;
+    alias?: string;
+    options: T;
+};
+export declare function createCommand<T extends OptionsConfig>(config: CommandConfig<T>, action: (options: InferOptions<T>) => any): import("commander").Command;
+export declare function stringifyOptions(options: OptionsConfig, object: any): string[];

package/lib/utils/options.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringifyOptions = exports.createCommand = void 0;
+const string_1 = require("./string");
+const commander_1 = require("commander");
+function createCommand(config, action) {
+    const command = commander_1.program.createCommand(config.name);
+    const argumentOptions = [];
+    if (config.alias)
+        command.alias(config.alias);
+    for (const name in config.options) {
+        const option = config.options[name];
+        const flag = option.flag ?? name;
+        const description = `${option.description}${option.defaults ? ` (defaults: ${option.defaults})` : ""}`;
+        if (flag === false) {
+            const arg = new commander_1.Argument(name, description);
+            if (option.required) {
+                arg.argRequired();
+            }
+            else {
+                arg.argOptional();
+            }
+            command.addArgument(arg);
+            argumentOptions.push(name);
+        }
+        else if (typeof flag === "string") {
+            const flags = [
+                option.shortFlag ? `-${option.shortFlag},` : "",
+                `--${name}`,
+                option.value !== "boolean"
+                    ? option.value === "array"
+                        ? " <values>"
+                        : " <value>"
+                    : "",
+            ].join("");
+            const opt = new commander_1.Option(flags, description);
+            opt.makeOptionMandatory(!!option.required);
+            command.addOption(opt);
+        }
+    }
+    const parsers = {
+        number: Number,
+        array: string_1.parseStringList,
+    };
+    return command.action(async (...args) => {
+        const inlineValues = args.slice(0, argumentOptions.length);
+        const cliOptions = args[argumentOptions.length] || {};
+        const commandOptions = {};
+        for (const name in config.options) {
+            const option = config.options[name];
+            if (option.flag !== false) {
+                const parse = typeof option.value === "string" ? parsers[option.value] : undefined;
+                const cliValue = cliOptions[option.flag ?? name] ?? option.defaults;
+                commandOptions[name] = parse ? parse(cliValue) : cliValue;
+            }
+        }
+        const options = argumentOptions.reduce((result, inlineOption, index) => {
+            const value = inlineValues[index];
+            if (value !== undefined)
+                result[inlineOption] = value;
+            return result;
+        }, commandOptions);
+        return await action(options);
+    });
+}
+exports.createCommand = createCommand;
+function stringifyOptions(options, object) {
+    const result = [];
+    const prepend = [];
+    for (const key in options) {
+        const option = options[key];
+        const value = object[key];
+        if (value === undefined)
+            continue;
+        if (option.flag === false) {
+            prepend.push(value);
+        }
+        else {
+            const flag = option.shortFlag
+                ? `-${option.shortFlag}`
+                : `--${option.flag ?? option.shortFlag}`;
+            if (option.value === "boolean") {
+                if (option.value)
+                    result.push(flag);
+            }
+            else {
+                result.push(flag);
+                result.push(`${value}`);
+            }
+        }
+    }
+    return [...prepend, ...result];
+}
+exports.stringifyOptions = stringifyOptions;

package/lib/utils/progress.js

@@ -67,7 +67,7 @@ class ProgressManager {
             this.keydownListener = undefined;
         }
     }
-    create(input, delay = 1000) {
+    create(input, delay = 1_000) {
         const update = (progress, force) => {
             const text = this.renderProgress(progress, force);
             if (typeof text === "string") {

package/lib/utils/restic.js

@@ -165,7 +165,7 @@ class Restic {
     }
     async restore(options) {
         let progressTimeout;
-        const progressInterval = options.progressInterval ?? 30000;
+        const progressInterval = options.progressInterval ?? 30_000;
         async function progressRutine() {
             try {
                 const total_bytes = await (0, fs_1.fastFolderSizeAsync)(options.target);

package/lib/utils/string.d.ts

@@ -1,7 +1,8 @@
 export declare function snakeCase(value: string, char?: string): string;
+export declare function camelize(input: string): string;
 export declare function render(subject: string, data: Record<string, string | undefined>): string;
 type NoInfer<T> = [T][T extends any ? 0 : never];
-export declare function parseStringList<T>(value: string | undefined, validValues?: T[], defaultsValues?: NoInfer<T>[] | true): T[];
+export declare function parseStringList<T = string>(value: string | undefined, validValues?: T[], defaultsValues?: NoInfer<T>[] | true): T[];
 export type Uri = {
     protocol?: "http" | "https";
     host?: string;

package/lib/utils/string.js

@@ -1,12 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compareJsons = exports.undefIfEmpty = exports.endsWith = exports.createPatternFilter = exports.match = exports.splitPatterns = exports.formatUri = exports.parseStringList = exports.render = exports.snakeCase = void 0;
+exports.compareJsons = exports.undefIfEmpty = exports.endsWith = exports.createPatternFilter = exports.match = exports.splitPatterns = exports.formatUri = exports.parseStringList = exports.render = exports.camelize = exports.snakeCase = void 0;
 const error_1 = require("./error");
 const micromatch_1 = require("micromatch");
 function snakeCase(value, char = "_") {
     return value.replace(/[A-Z]/g, (letter) => `${char}${letter.toLowerCase()}`);
 }
 exports.snakeCase = snakeCase;
+function camelize(input) {
+    return input.replace(/-./g, (x) => x[1].toUpperCase());
+}
+exports.camelize = camelize;
 function render(subject, data) {
     return subject.replace(/{([\w\./]*)}/g, function (match, name) {
         if (!name.length) {

package/lib/utils/watcher.js

@@ -22,7 +22,7 @@ function createWatcher(options) {
         start: () => {
             clearInterval(interval);
             rutine(true).finally(() => {
-                interval = setInterval(rutine, options.interval ?? 5000);
+                interval = setInterval(rutine, options.interval ?? 5_000);
             });
         },
         stop: () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datatruck/cli",
-  "version": "0.37.0",
+  "version": "0.38.1",
   "description": "Tool for creating and managing backups",
   "homepage": "https://github.com/swordev/datatruck#readme",
   "bugs": {
@@ -26,7 +26,7 @@
     "config.schema.json"
   ],
   "dependencies": {
-    "@supercharge/promise-pool": "^3.1.1",
+    "@supercharge/promise-pool": "^3.2.0",
     "ajv": "^8.12.0",
     "async": "^3.2.5",
     "chalk": "^4.1.2",
@@ -37,9 +37,9 @@
     "fast-glob": "^3.3.2",
     "listr2": "^8.0.2",
     "micromatch": "^4.0.5",
-    "mysql2": "^3.9.1",
+    "mysql2": "^3.9.3",
     "tty-table": "^4.2.3",
-    "yaml": "^2.3.4"
+    "yaml": "^2.4.1"
   },
   "devDependencies": {
     "@types/async": "^3.2.24",