Merge pull request #279 from MatrixAI/feature-unix-rm

Adding `secrets rm` command

npmDepsHash

@@ -1 +1 @@
-sha256-iXj2QmiuiYudb/V9FRTAPU52ns1i2g4H82Rb2NrWLNo=
+sha256-FDJmb93Xgols7SXWv/ETyDm0uggBmVuVWiD+vJOcKcc=

package.json

@@ -150,7 +150,7 @@
     "nexpect": "^0.6.0",
     "node-gyp-build": "^4.4.0",
     "nodemon": "^3.0.1",
-    "polykey": "^1.10.0",
+    "polykey": "^1.11.1",
     "prettier": "^3.0.0",
     "shelljs": "^0.8.5",
     "shx": "^0.3.4",

src/secrets/CommandDelete.ts → src/secrets/CommandRemove.ts

@@ -8,18 +8,20 @@ import * as binProcessors from '../utils/processors';
 class CommandDelete extends CommandPolykey {
   constructor(...args: ConstructorParameters<typeof CommandPolykey>) {
     super(...args);
-    this.name('delete');
-    this.aliases(['del', 'rm']);
-    this.description('Delete a Secret from a Specified Vault');
+    this.name('rm');
+    this.description('Delete a Secret from a specified Vault');
     this.argument(
-      '<secretPath>',
-      'Path to the secret that to be deleted, specified as <vaultName>:<directoryPath>',
-      binParsers.parseSecretPathValue,
+      '<secretPaths...>',
+      'Path to one or more secret to be deleted, each specified as <vaultName>:<directoryPath>',
     );
     this.addOption(binOptions.nodeId);
     this.addOption(binOptions.clientHost);
     this.addOption(binOptions.clientPort);
-    this.action(async (secretPath, options) => {
+    this.addOption(binOptions.recursive);
+    this.action(async (secretPaths, options) => {
+      secretPaths = secretPaths.map((path: string) =>
+        binParsers.parseSecretPathValue(path),
+      );
       const { default: PolykeyClient } = await import(
         'polykey/dist/PolykeyClient'
       );
@@ -31,11 +33,10 @@ class CommandDelete extends CommandPolykey {
         this.fs,
         this.logger.getChild(binProcessors.processClientOptions.name),
       );
-      const auth = await binProcessors.processAuthentication(
+      const meta = await binProcessors.processAuthentication(
         options.passwordFile,
         this.fs,
       );
-
       let pkClient: PolykeyClient;
       this.exitHandlers.handlers.push(async () => {
         if (pkClient != null) await pkClient.stop();
@@ -45,20 +46,16 @@ class CommandDelete extends CommandPolykey {
           nodeId: clientOptions.nodeId,
           host: clientOptions.clientHost,
           port: clientOptions.clientPort,
-          options: {
-            nodePath: options.nodePath,
-          },
+          options: { nodePath: options.nodePath },
           logger: this.logger.getChild(PolykeyClient.name),
         });
-        await binUtils.retryAuthentication(
-          (auth) =>
-            pkClient.rpcClient.methods.vaultsSecretsDelete({
-              metadata: auth,
-              nameOrId: secretPath[0],
-              secretName: secretPath[1],
-            }),
-          auth,
-        );
+        await binUtils.retryAuthentication(async (auth) => {
+          await pkClient.rpcClient.methods.vaultsSecretsRemove({
+            metadata: auth,
+            secretNames: secretPaths,
+            options: { recursive: options.recursive },
+          });
+        }, meta);
       } finally {
         if (pkClient! != null) await pkClient.stop();
       }

src/secrets/CommandSecrets.ts

@@ -1,12 +1,12 @@
 import CommandCreate from './CommandCreate';
-import CommandDelete from './CommandDelete';
 import CommandDir from './CommandDir';
 import CommandEdit from './CommandEdit';
 import CommandEnv from './CommandEnv';
 import CommandGet from './CommandGet';
 import CommandList from './CommandList';
 import CommandMkdir from './CommandMkdir';
 import CommandRename from './CommandRename';
+import CommandRemove from './CommandRemove';
 import CommandUpdate from './CommandUpdate';
 import CommandStat from './CommandStat';
 import CommandPolykey from '../CommandPolykey';
@@ -17,14 +17,14 @@ class CommandSecrets extends CommandPolykey {
     this.name('secrets');
     this.description('Secrets Operations');
     this.addCommand(new CommandCreate(...args));
-    this.addCommand(new CommandDelete(...args));
     this.addCommand(new CommandDir(...args));
     this.addCommand(new CommandEdit(...args));
     this.addCommand(new CommandEnv(...args));
     this.addCommand(new CommandGet(...args));
     this.addCommand(new CommandList(...args));
     this.addCommand(new CommandMkdir(...args));
     this.addCommand(new CommandRename(...args));
+    this.addCommand(new CommandRemove(...args));
     this.addCommand(new CommandUpdate(...args));
     this.addCommand(new CommandStat(...args));
   }

src/utils/options.ts

@@ -302,6 +302,11 @@ const order = new commander.Option(
   .choices(['asc', 'desc'])
   .default('asc');
 
+const recursive = new commander.Option(
+  '--recursive',
+  'If enabled, specified directories will be removed along with their contents',
+).default(false);
+
 export {
   nodePath,
   format,
@@ -343,4 +348,5 @@ export {
   events,
   limit,
   order,
+  recursive,
 };