@datatruck/cli 0.30.0 → 0.30.1

package/Action/BackupAction.d.ts

@@ -4,7 +4,7 @@ import { RepositoryConfigType } from "../Config/RepositoryConfig";
 import { PreSnapshot } from "../Repository/RepositoryAbstract";
 import { DataFormat } from "../utils/DataFormat";
 import { Listr3TaskResultEnd } from "../utils/list";
-import { Progress, ProgressManager } from "../utils/progress";
+import { Progress, ProgressMode } from "../utils/progress";
 import { Streams } from "../utils/stream";
 import { IfRequireKeys } from "../utils/ts";
 export type BackupActionOptions = {
@@ -17,8 +17,7 @@ export type BackupActionOptions = {
     verbose?: boolean;
     date?: string;
     tty?: "auto" | boolean;
-    progress?: "auto" | "interval" | boolean;
-    progressInterval?: number;
+    progress?: ProgressMode;
     streams?: Streams;
     prune?: boolean;
 };
@@ -51,7 +50,6 @@ type Context = {
 export declare class BackupAction<TRequired extends boolean = true> {
     readonly config: ConfigType;
     readonly options: IfRequireKeys<TRequired, BackupActionOptions>;
-    protected pm: ProgressManager;
     constructor(config: ConfigType, options?: IfRequireKeys<TRequired, BackupActionOptions>);
     protected prepareSnapshot(): PreSnapshot;
     protected getPackages(snapshot: PreSnapshot): PackageConfigType[];

package/Action/BackupAction.js

@@ -22,16 +22,9 @@ const dayjs_1 = __importDefault(require("dayjs"));
 class BackupAction {
     config;
     options;
-    pm;
     constructor(config, options = {}) {
         this.config = config;
         this.options = options;
-        this.pm = new progress_1.ProgressManager({
-            verbose: options.verbose,
-            tty: options.tty,
-            enabled: options.progress,
-            interval: options.progressInterval,
-        });
     }
     prepareSnapshot() {
         const date = this.options.date ?? new Date().toISOString();
@@ -165,8 +158,7 @@ class BackupAction {
         const pm = new progress_1.ProgressManager({
             verbose: options.verbose,
             tty: options.tty,
-            enabled: options.progress,
-            interval: options.progressInterval,
+            mode: options.progress,
         });
         const l = new list_1.Listr3({
             streams: this.options.streams,
@@ -246,7 +238,7 @@ class BackupAction {
                                         repositoryName,
                                         snapshot,
                                         snapshotPath: taskResult?.snapshotPath,
-                                        onProgress: (p) => this.pm.update(p, (t) => (task.output = t)),
+                                        onProgress: (p) => pm.update(p, (t) => (task.output = t)),
                                     });
                                 },
                             })), l.$task({

package/Action/CopyAction.d.ts

@@ -2,6 +2,7 @@ import type { ConfigType } from "../Config/Config";
 import { Snapshot } from "../Repository/RepositoryAbstract";
 import { DataFormat } from "../utils/DataFormat";
 import { Listr3TaskResultEnd } from "../utils/list";
+import { ProgressMode } from "../utils/progress";
 import { Streams } from "../utils/stream";
 import { IfRequireKeys } from "../utils/ts";
 export type CopyActionOptionsType = {
@@ -13,8 +14,7 @@ export type CopyActionOptionsType = {
     repositoryNames2?: string[];
     verbose?: boolean;
     tty?: "auto" | boolean;
-    progress?: "auto" | "interval" | boolean;
-    progressInterval?: number;
+    progress?: ProgressMode;
 };
 export type CopyActionResult = {
     errors: Error[];

package/Action/CopyAction.js

@@ -69,8 +69,7 @@ class CopyAction {
         const pm = new progress_1.ProgressManager({
             verbose: options.verbose,
             tty: options.tty,
-            enabled: options.progress,
-            interval: options.progressInterval,
+            mode: options.progress,
         });
         const l = new list_1.Listr3({ progressManager: pm });
         return l

package/Action/RestoreAction.d.ts

@@ -4,7 +4,7 @@ import { Snapshot } from "../Repository/RepositoryAbstract";
 import { TaskAbstract } from "../Task/TaskAbstract";
 import { DataFormat } from "../utils/DataFormat";
 import { Listr3TaskResultEnd } from "../utils/list";
-import { Progress } from "../utils/progress";
+import { Progress, ProgressMode } from "../utils/progress";
 import { Streams } from "../utils/stream";
 import { GargabeCollector } from "../utils/temp";
 import { IfRequireKeys } from "../utils/ts";
@@ -19,8 +19,7 @@ export type RestoreActionOptions = {
     verbose?: boolean;
     initial?: boolean;
     tty?: "auto" | boolean;
-    progress?: "auto" | "interval" | boolean;
-    progressInterval?: number;
+    progress?: ProgressMode;
     streams?: Streams;
 };
 type RestoreSnapshot = Snapshot & {

package/Action/RestoreAction.js

@@ -143,8 +143,7 @@ class RestoreAction {
         const pm = new progress_1.ProgressManager({
             verbose: options.verbose,
             tty: options.tty,
-            enabled: options.progress,
-            interval: options.progressInterval,
+            mode: options.progress,
         });
         const l = new list_1.Listr3({
             streams: options.streams,

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @datatruck/cli
 
+## 0.30.1
+
+### Patch Changes
+
+- [`68e991b`](https://github.com/swordev/datatruck/commit/68e991b862ee3793e6b31d1fd5d6cebdf59524a4) Thanks [@juanrgm](https://github.com/juanrgm)! - Fix allowlist in datatruck server
+
+- [`16f982c`](https://github.com/swordev/datatruck/commit/16f982c7da0d44cbbb691d5552da77fb27366f82) Thanks [@juanrgm](https://github.com/juanrgm)! - Reduce progress interval to 300 ms in auto progress mode
+
 ## 0.30.0
 
 ### Minor Changes

package/Command/BackupCommand.js

@@ -61,7 +61,6 @@ class BackupCommand extends CommandAbstract_1.CommandAbstract {
             date: this.options.date,
             tty: this.globalOptions.tty,
             progress: this.globalOptions.progress,
-            progressInterval: this.globalOptions.progressInterval,
             streams: this.streams,
             prune: this.options.prune,
         });

package/Command/CommandAbstract.d.ts

@@ -1,6 +1,7 @@
 import { ConfigType } from "../Config/Config";
 import { FormatType } from "../utils/DataFormat";
 import { OptionsType } from "../utils/cli";
+import { ProgressMode } from "../utils/progress";
 import { Streams } from "../utils/stream";
 import { If, SimilarObject } from "../utils/ts";
 export type GlobalOptions<TResolved = false> = {
@@ -8,8 +9,7 @@ export type GlobalOptions<TResolved = false> = {
     outputFormat?: FormatType;
     verbose?: number;
     tty?: If<TResolved, "auto" | boolean, "auto" | "true" | "false">;
-    progress?: If<TResolved, "auto" | boolean, "auto" | "true" | "false" | "interval">;
-    progressInterval?: number;
+    progress?: If<TResolved, ProgressMode, Exclude<ProgressMode, boolean> | "true" | "false">;
 };
 export type CommandConstructor<TUnresolvedOptions, TOptions extends SimilarObject<TUnresolvedOptions>> = {
     new (globalOptions: GlobalOptions<true>, options: TOptions): CommandAbstract<TUnresolvedOptions, TOptions>;

package/Command/CopyCommand.js

@@ -53,7 +53,6 @@ class CopyCommand extends CommandAbstract_1.CommandAbstract {
             verbose: verbose > 0,
             tty: this.globalOptions.tty,
             progress: this.globalOptions.progress,
-            progressInterval: this.globalOptions.progressInterval,
         });
         const result = await copy.exec();
         if (this.globalOptions.outputFormat)

package/Command/RestoreCommand.js

@@ -63,7 +63,6 @@ class RestoreCommand extends CommandAbstract_1.CommandAbstract {
             initial: this.options.initial,
             tty: this.globalOptions.tty,
             progress: this.globalOptions.progress,
-            progressInterval: this.globalOptions.progressInterval,
             streams: this.streams,
         });
         const result = await restore.exec();

package/Config/Config.js

@@ -77,7 +77,7 @@ exports.configDefinition = {
                     additionalProperties: false,
                     properties: {
                         enabled: { type: "boolean" },
-                        remoteAddreses: (0, DefinitionEnum_1.makeRef)(DefinitionEnum_1.DefinitionEnum.stringListUtil),
+                        remoteAddresses: (0, DefinitionEnum_1.makeRef)(DefinitionEnum_1.DefinitionEnum.stringListUtil),
                     },
                 },
             },

package/Repository/DatatruckRepository.js

@@ -292,6 +292,7 @@ class DatatruckRepository extends RepositoryAbstract_1.RepositoryAbstract {
                         absolute,
                         relative: {
                             description: "Downloading",
+                            format: "size",
                             ...progress,
                         },
                     }),
@@ -306,6 +307,7 @@ class DatatruckRepository extends RepositoryAbstract_1.RepositoryAbstract {
                             absolute,
                             relative: {
                                 description: "Downloading",
+                                format: "size",
                                 ...progress,
                             },
                         }),

package/cli.js

@@ -19,12 +19,11 @@ const fs_2 = require("fs");
 const path_1 = require("path");
 function getGlobalOptions() {
     const result = program.opts();
+    const parseBool = (v) => v === "true" ? true : v === "false" ? false : v;
     return {
         ...result,
-        tty: result.tty === "auto" ? "auto" : result.tty === "true",
-        progress: result.progress === "auto" || result.progress === "interval"
-            ? result.progress
-            : result.progress === "true",
+        tty: parseBool(result.tty),
+        progress: parseBool(result.progress),
     };
 }
 function makeCommand(command) {
@@ -89,8 +88,7 @@ program.usage("dtt");
 program.option("-v,--verbose", "Verbose", (_, previous) => previous + 1, 0);
 program.option("-c,--config <path>", "Config path", process.env["DATATRUCK_CONFIG"] ?? (cwd.endsWith(path_1.sep) ? cwd : `${cwd}${path_1.sep}`));
 program.option("--tty <value>", "TTY mode (auto, true, false)", "auto");
-program.option("--progress <value>", "Progress type (auto, true, false, interval)", "auto");
-program.option("--progress-interval <ms>", "Progress interval", Number, 1000);
+program.option("--progress <value>", "Progress type (auto, true, false, interval, interval:[ms])", "auto");
 program.option("-o,--output-format <format>", "Output format (json, pjson, yaml, table, custom=$, tpl=name)", "table");
 makeCommand(CommandFactory_1.CommandEnum.startServer).alias("start");
 makeCommand(CommandFactory_1.CommandEnum.config).alias("c");

package/config.schema.json

@@ -1107,7 +1107,7 @@
                 "enabled": {
                   "type": "boolean"
                 },
-                "remoteAddreses": {
+                "remoteAddresses": {
                   "$ref": "#/definitions/stringlist-util"
                 }
               }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datatruck/cli",
-  "version": "0.30.0",
+  "version": "0.30.1",
   "dependencies": {
     "@supercharge/promise-pool": "^3.1.0",
     "ajv": "^8.12.0",

package/utils/datatruck/server.d.ts

@@ -20,7 +20,7 @@ export type DatatruckServerOptions = {
          * @default true
          */
         enabled?: boolean;
-        remoteAddreses?: string[];
+        remoteAddresses?: string[];
     };
 };
 export declare const headerKey: {

package/utils/datatruck/server.js

@@ -26,9 +26,9 @@ exports.headerKey = {
 };
 function validateRequest(req, options) {
     const list = options.allowlist;
-    if (list && (list.enabled ?? true) && list.remoteAddreses) {
+    if (list && (list.enabled ?? true) && list.remoteAddresses) {
         const remoteAddress = getRemoteAddress(req, options);
-        if (!remoteAddress || list.remoteAddreses.includes(remoteAddress))
+        if (!remoteAddress || !list.remoteAddresses.includes(remoteAddress))
             return false;
     }
     const name = req.headers[exports.headerKey.user]?.toString().trim();

package/utils/http.js

@@ -114,7 +114,10 @@ async function downloadFile(url, output, options = {}) {
                 }
                 res
                     .on("error", async (error) => {
-                    file.destroy();
+                    try {
+                        file.destroy();
+                    }
+                    catch (_) { }
                     try {
                         await (0, promises_1.unlink)(output);
                     }

package/utils/progress.d.ts

@@ -17,29 +17,36 @@ export type Progress = {
     absolute?: ProgressStats;
     relative?: ProgressStats;
 };
+export type ProgressTty = "auto" | boolean;
+export type ProgressMode = "auto" | "interval" | `interval:${number}` | boolean;
 export declare class ProgressManager {
     readonly options: {
         verbose?: boolean;
         /**
-         * @default true
+         * @default false
          */
-        tty?: boolean | "auto";
-        enabled?: boolean | "auto" | "interval";
-        interval?: number;
+        tty?: ProgressTty;
+        /**
+         * @default "interval"
+         */
+        mode?: ProgressMode;
     };
     protected timer: Timer;
     protected interval: Timer | undefined;
+    protected intervalMs: number;
     protected keydownListener: ((data: Buffer | undefined) => void) | undefined;
-    readonly tty: boolean;
-    readonly enabled: boolean | "interval";
+    readonly tty: Exclude<ProgressTty, "auto">;
+    readonly mode: Exclude<ProgressMode, "auto" | `interval:${number}`>;
     constructor(options: {
         verbose?: boolean;
         /**
-         * @default true
+         * @default false
+         */
+        tty?: ProgressTty;
+        /**
+         * @default "interval"
          */
-        tty?: boolean | "auto";
-        enabled?: boolean | "auto" | "interval";
-        interval?: number;
+        mode?: ProgressMode;
     });
     elapsed(): number;
     start(): void;

package/utils/progress.js

@@ -11,9 +11,10 @@ class ProgressManager {
     options;
     timer = (0, date_1.createTimer)();
     interval = (0, date_1.createTimer)();
+    intervalMs;
     keydownListener;
     tty;
-    enabled;
+    mode;
     constructor(options) {
         this.options = options;
         this.tty =
@@ -22,12 +23,21 @@ class ProgressManager {
                     ? false
                     : process.stdout.isTTY
                 : !!options.tty;
-        this.enabled =
-            options.enabled === "auto"
-                ? this.tty
-                    ? true
-                    : "interval"
-                : !!options.enabled;
+        const mode = options.mode === "auto"
+            ? this.tty
+                ? `interval:${300}`
+                : "interval"
+            : options.mode ?? "interval";
+        this.intervalMs = 1000;
+        if (typeof mode === "string" && mode.startsWith("interval:")) {
+            const [, ms] = mode.split(":");
+            this.mode = "interval";
+            if (/^\d+$/.test(ms))
+                this.intervalMs = Number(ms);
+        }
+        else {
+            this.mode = mode;
+        }
     }
     elapsed() {
         return this.timer.elapsed();
@@ -57,11 +67,11 @@ class ProgressManager {
         }
     }
     update(progress, cb) {
-        if (!this.enabled)
+        if (!this.mode)
             return;
-        if (this.enabled === "interval") {
+        if (this.mode === "interval") {
             if (this.interval) {
-                if (!this.interval.reset(this.options.interval ?? 5000))
+                if (!this.interval.reset(this.intervalMs))
                     return;
             }
             else {