@datatruck/cli 0.4.0 → 0.5.0

package/Action/BackupAction.js

@@ -23,6 +23,7 @@ class BackupAction {
             packageNames: this.options.packageNames,
             repositoryNames: this.options.repositoryNames,
             repositoryTypes: this.options.repositoryTypes,
+            sourceAction: "backup",
         });
         packages = (0, config_util_1.resolvePackages)(packages, {
             snapshotId: snapshot.id,

package/Action/InitAction.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InitAction = void 0;
 const RepositoryFactory_1 = require("../Factory/RepositoryFactory");
+const config_util_1 = require("../util/datatruck/config-util");
 class InitAction {
     constructor(config, options) {
         this.config = config;
@@ -10,6 +11,8 @@ class InitAction {
     async exec() {
         const result = [];
         for (const repo of this.config.repositories) {
+            if (!(0, config_util_1.filterRepository)(repo, "init"))
+                continue;
             if (this.options.repositoryNames &&
                 !this.options.repositoryNames.includes(repo.name))
                 continue;

package/Action/PruneAction.js

@@ -24,7 +24,7 @@ class PruneAction {
     }
     async exec() {
         const snapshotsAction = new SnapshotsAction_1.SnapshotsAction(this.config, this.options);
-        const snapshots = await snapshotsAction.exec();
+        const snapshots = await snapshotsAction.exec("prune");
         const snapshotsDeleted = [];
         const reasons = {};
         const inputFilter = {

package/Action/RestoreAction.js

@@ -203,7 +203,10 @@ class RestoreAction {
         const snapshots = this.groupSnapshots(await this.findSnapshots());
         if (!snapshots.length)
             throw new AppError_1.AppError("None snapshot found");
-        let packages = (0, config_util_1.filterPackages)(this.config, this.options);
+        let packages = (0, config_util_1.filterPackages)(this.config, {
+            ...this.options,
+            sourceAction: "restore",
+        });
         packages = (0, config_util_1.resolvePackages)(packages, {
             snapshotId: this.options.snapshotId,
             snapshotDate: snapshots[0].date,

package/Action/SnapshotsAction.d.ts

@@ -1,4 +1,5 @@
 import type { ConfigType } from "../Config/Config";
+import { RepositoryConfigEnabledActionType } from "../Config/RepositoryConfig";
 import { SnapshotResultType } from "../Repository/RepositoryAbstract";
 import { IfRequireKeys } from "../util/ts-util";
 export declare type SnapshotGroupByType = keyof Pick<SnapshotExtendedType, "packageName" | "repositoryName" | "repositoryType">;
@@ -27,5 +28,5 @@ export declare class SnapshotsAction<TRequired extends boolean = true> {
     readonly config: ConfigType;
     readonly options: IfRequireKeys<TRequired, SnapshotsActionOptionsType>;
     constructor(config: ConfigType, options: IfRequireKeys<TRequired, SnapshotsActionOptionsType>);
-    exec(): Promise<SnapshotExtendedType[]>;
+    exec(sourceAction?: RepositoryConfigEnabledActionType): Promise<SnapshotExtendedType[]>;
 }

package/Action/SnapshotsAction.js

@@ -2,15 +2,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SnapshotsAction = void 0;
 const RepositoryFactory_1 = require("../Factory/RepositoryFactory");
+const config_util_1 = require("../util/datatruck/config-util");
 const snapshot_util_1 = require("../util/datatruck/snapshot-util");
 class SnapshotsAction {
     constructor(config, options) {
         this.config = config;
         this.options = options;
     }
-    async exec() {
+    async exec(sourceAction) {
+        if (!sourceAction)
+            sourceAction = "snapshots";
         let result = [];
         for (const repo of this.config.repositories) {
+            if (!(0, config_util_1.filterRepository)(repo, sourceAction))
+                continue;
             if (this.options.repositoryNames &&
                 !this.options.repositoryNames.includes(repo.name))
                 continue;

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @datatruck/cli
 
+## 0.5.0
+
+### Minor Changes
+
+- [`5aeb2af`](https://github.com/swordev/datatruck/commit/5aeb2afb96692e00bdba501b58df9cc0e02dceaa) Thanks [@juanrgm](https://github.com/juanrgm)! - Add `enabled` option to repository config
+
+* [`75de836`](https://github.com/swordev/datatruck/commit/75de8369356cf02ed3fd5c58b1f9bea66432cda8) Thanks [@juanrgm](https://github.com/juanrgm)! - Allow restic password without file
+
 ## 0.4.0
 
 ### Minor Changes

package/Config/RepositoryConfig.d.ts

@@ -4,8 +4,12 @@ import { ResticRepositoryConfigType, resticRepositoryName } from "../Repository/
 import type { JSONSchema7 } from "json-schema";
 export declare const repositoryConfigDefinition: JSONSchema7;
 export declare type RepositoryConfigTypeType = RepositoryConfigType["type"];
+export declare type RepositoryConfigEnabledActionType = "backup" | "init" | "prune" | "restore" | "snapshots";
 export declare type RepositoryConfigType = {
     name: string;
+    enabled?: boolean | {
+        [K in "defaults" | RepositoryConfigEnabledActionType]?: boolean;
+    };
 } & ({
     type: typeof resticRepositoryName;
     config: ResticRepositoryConfigType;

package/Config/RepositoryConfig.js

@@ -17,6 +17,25 @@ exports.repositoryConfigDefinition = {
     properties: {
         type: { type: "string" },
         name: { type: "string" },
+        enabled: {
+            anyOf: [
+                {
+                    type: "boolean",
+                },
+                {
+                    type: "object",
+                    additionalProperties: false,
+                    properties: {
+                        defaults: { type: "boolean" },
+                        backup: { type: "boolean" },
+                        init: { type: "boolean" },
+                        prune: { type: "boolean" },
+                        restore: { type: "boolean" },
+                        snapshots: { type: "boolean" },
+                    },
+                },
+            ],
+        },
         config: {},
     },
     anyOf: Object.keys(types).map((type) => ({

package/Repository/ResticRepository.d.ts

@@ -2,7 +2,9 @@ import { RepositoryType } from "../util/ResticUtil";
 import { RepositoryAbstract, BackupDataType, InitDataType, RestoreDataType, SnapshotsDataType, SnapshotResultType, SnapshotTagObjectType, SnapshotTagEnum, PruneDataType } from "./RepositoryAbstract";
 import { JSONSchema7 } from "json-schema";
 export declare type ResticRepositoryConfigType = {
-    passwordFile: string;
+    password: string | {
+        path: string;
+    };
     repository: RepositoryType;
 };
 export declare type ResticPackageRepositoryConfigType = {};
@@ -12,11 +14,13 @@ export declare const resticPackageRepositoryDefinition: JSONSchema7;
 export declare class ResticRepository extends RepositoryAbstract<ResticRepositoryConfigType> {
     static refPrefix: string;
     protected env: {
-        RESTIC_PASSWORD_FILE: string;
+        RESTIC_PASSWORD?: string;
+        RESTIC_PASSWORD_FILE?: string;
         RESTIC_REPOSITORY: string;
     };
     buildEnv(): Promise<{
-        RESTIC_PASSWORD_FILE: string;
+        RESTIC_PASSWORD?: string | undefined;
+        RESTIC_PASSWORD_FILE?: string | undefined;
         RESTIC_REPOSITORY: string;
     }>;
     static buildSnapshotTag(name: SnapshotTagEnum, value: string): string;

package/Repository/ResticRepository.js

@@ -18,10 +18,22 @@ const path_1 = require("path");
 exports.resticRepositoryName = "restic";
 exports.resticRepositoryDefinition = {
     type: "object",
-    required: ["passwordFile", "repository"],
+    required: ["password", "repository"],
     additionalProperties: false,
     properties: {
-        passwordFile: { type: "string" },
+        password: {
+            anyOf: [
+                { type: "string" },
+                {
+                    type: "object",
+                    additionalProperties: false,
+                    required: ["path"],
+                    properties: {
+                        path: { type: "string" },
+                    },
+                },
+            ],
+        },
         repository: {
             type: "object",
             additionalProperties: false,
@@ -59,7 +71,9 @@ class ResticRepository extends RepositoryAbstract_1.RepositoryAbstract {
         if (this.env)
             return this.env;
         return (this.env = {
-            RESTIC_PASSWORD_FILE: (0, path_1.resolve)(this.config.passwordFile),
+            ...(typeof this.config.password === "string"
+                ? { RESTIC_PASSWORD: this.config.password }
+                : { RESTIC_PASSWORD_FILE: (0, path_1.resolve)(this.config.password.path) }),
             RESTIC_REPOSITORY: await ResticUtil_1.ResticUtil.formatRepository(this.config.repository),
         });
     }

package/config.schema.json

@@ -20,6 +20,37 @@
         "name": {
           "type": "string"
         },
+        "enabled": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "defaults": {
+                  "type": "boolean"
+                },
+                "backup": {
+                  "type": "boolean"
+                },
+                "init": {
+                  "type": "boolean"
+                },
+                "prune": {
+                  "type": "boolean"
+                },
+                "restore": {
+                  "type": "boolean"
+                },
+                "snapshots": {
+                  "type": "boolean"
+                }
+              }
+            }
+          ]
+        },
         "config": {}
       },
       "anyOf": [
@@ -462,13 +493,29 @@
     "restic-repository": {
       "type": "object",
       "required": [
-        "passwordFile",
+        "password",
         "repository"
       ],
       "additionalProperties": false,
       "properties": {
-        "passwordFile": {
-          "type": "string"
+        "password": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "path"
+              ],
+              "properties": {
+                "path": {
+                  "type": "string"
+                }
+              }
+            }
+          ]
         },
         "repository": {
           "type": "object",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datatruck/cli",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "dependencies": {
     "ajv": "^8.11.0",
     "chalk": "^4.1.2",

package/util/datatruck/config-util.d.ts

@@ -1,10 +1,13 @@
 import { ConfigType } from "../../Config/Config";
 import type { PackageConfigType } from "../../Config/PackageConfig";
-export declare function findRepositoryOrFail(config: ConfigType, repositoryName: string): import("../../Config/RepositoryConfig").RepositoryConfigType;
+import { RepositoryConfigEnabledActionType, RepositoryConfigType } from "../../Config/RepositoryConfig";
+export declare function findRepositoryOrFail(config: ConfigType, repositoryName: string): RepositoryConfigType;
+export declare function filterRepository(repository: RepositoryConfigType, action?: RepositoryConfigEnabledActionType): boolean;
 export declare function filterPackages(config: ConfigType, options: {
     packageNames?: string[];
     repositoryNames?: string[];
     repositoryTypes?: string[];
+    sourceAction?: RepositoryConfigEnabledActionType;
 }): PackageConfigType[];
 declare type ResolvePackagePathParamsType = ResolvePackageParamsType & {
     packageName: string;

package/util/datatruck/config-util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.params = exports.dbNameParams = exports.pkgRestorePathParams = exports.pkgExcludeParams = exports.pkgIncludeParams = exports.pkgPathParams = exports.resolvePackages = exports.resolvePackage = exports.resolveDatabaseName = exports.resolvePackagePath = exports.filterPackages = exports.findRepositoryOrFail = void 0;
+exports.params = exports.dbNameParams = exports.pkgRestorePathParams = exports.pkgExcludeParams = exports.pkgIncludeParams = exports.pkgPathParams = exports.resolvePackages = exports.resolvePackage = exports.resolveDatabaseName = exports.resolvePackagePath = exports.filterPackages = exports.filterRepository = exports.findRepositoryOrFail = void 0;
 const AppError_1 = require("../../Error/AppError");
 const fs_util_1 = require("../fs-util");
 const string_util_1 = require("../string-util");
@@ -12,6 +12,14 @@ function findRepositoryOrFail(config, repositoryName) {
     return repo;
 }
 exports.findRepositoryOrFail = findRepositoryOrFail;
+function filterRepository(repository, action) {
+    const enabled = repository.enabled ?? true;
+    if (typeof enabled === "boolean")
+        return enabled;
+    const defaults = enabled["defaults"] ?? true;
+    return action ? enabled[action] ?? defaults : defaults;
+}
+exports.filterRepository = filterRepository;
 function filterPackages(config, options) {
     const packagePatterns = (0, string_util_1.makePathPatterns)(options.packageNames);
     return config.packages
@@ -19,6 +27,8 @@ function filterPackages(config, options) {
         pkg = Object.assign({}, pkg);
         pkg.repositoryNames = (pkg.repositoryNames ?? []).filter((name) => {
             const repo = findRepositoryOrFail(config, name);
+            if (!filterRepository(repo, options?.sourceAction))
+                return false;
             return ((!options.repositoryNames ||
                 options.repositoryNames.includes(name)) &&
                 (!options.repositoryTypes ||