feat: changed parsers to allow using vault name without secret path

Author: aryanjassal

src/secrets/CommandCat.ts

@@ -85,7 +85,7 @@ class CommandGet extends CommandPolykey {
             for (const [vaultName, secretPath] of secretPaths) {
               await writer.write({
                 nameOrId: vaultName,
-                secretName: secretPath,
+                secretName: secretPath ?? '/',
                 metadata: first
                   ? { ...auth, options: { continueOnError: true } }
                   : undefined,

src/secrets/CommandEdit.ts

@@ -17,7 +17,7 @@ class CommandEdit extends CommandPolykey {
     this.argument(
       '<secretPath>',
       'Path to the secret to be edited, specified as <vaultName>:<directoryPath>',
-      binParsers.parseSecretPathValue,
+      binParsers.parseSecretPath,
     );
     this.addOption(binOptions.nodeId);
     this.addOption(binOptions.clientHost);
@@ -68,7 +68,7 @@ class CommandEdit extends CommandPolykey {
             const writer = res.writable.getWriter();
             await writer.write({
               nameOrId: secretPath[0],
-              secretName: secretPath[1],
+              secretName: secretPath[1] ?? '/',
               metadata: auth,
             });
             await writer.close();

src/secrets/CommandList.ts

@@ -14,7 +14,7 @@ class CommandList extends CommandPolykey {
     this.argument(
       '<directoryPath>',
       'Directory to list files from, specified as <vaultName>[:<path>]',
-      binParsers.parseSecretPathOptional,
+      binParsers.parseSecretPath,
     );
     this.addOption(binOptions.nodeId);
     this.addOption(binOptions.clientHost);

src/secrets/CommandMkdir.ts

@@ -13,7 +13,7 @@ class CommandMkdir extends CommandPolykey {
     this.argument(
       '<secretPath>',
       'Path to where the directory to be created, specified as <vaultName>:<directoryPath>',
-      binParsers.parseSecretPathValue,
+      binParsers.parseSecretPath,
     );
     this.option('-r, --recursive', 'Create the directory recursively');
     this.addOption(binOptions.nodeId);

src/secrets/CommandRemove.ts

@@ -21,7 +21,7 @@ class CommandRemove extends CommandPolykey {
     this.addOption(binOptions.recursive);
     this.action(async (secretPaths, options) => {
       secretPaths = secretPaths.map((path: string) =>
-        binParsers.parseSecretPathValue(path),
+        binParsers.parseSecretPath(path),
       );
       const { default: PolykeyClient } = await import(
         'polykey/dist/PolykeyClient'

src/secrets/CommandStat.ts

@@ -13,7 +13,7 @@ class CommandStat extends CommandPolykey {
     this.argument(
       '<secretPath>',
       'Path to where the secret, specified as <vaultName>:<directoryPath>',
-      binParsers.parseSecretPathValue,
+      binParsers.parseSecretPath,
     );
     this.addOption(binOptions.nodeId);
     this.addOption(binOptions.clientHost);

src/secrets/CommandWrite.ts

@@ -13,7 +13,7 @@ class CommandWrite extends CommandPolykey {
     this.argument(
       '<secretPath>',
       'Path to the secret, specified as <vaultName>:<directoryPath>',
-      binParsers.parseSecretPathValue,
+      binParsers.parseSecretPath,
     );
     this.addOption(binOptions.nodeId);
     this.addOption(binOptions.clientHost);

src/utils/parsers.ts

@@ -65,12 +65,12 @@ function parseCoreCount(v: string): number | undefined {
   }
 }
 
-function parseSecretPathOptional(
-  secretPath: string,
-): [string, string?, string?] {
+function parseSecretPath(secretPath: string): [string, string?, string?] {
   // E.g. If 'vault1:a/b/c', ['vault1', 'a/b/c'] is returned
   //      If 'vault1', ['vault1, undefined] is returned
-  // splits out everything after an `=` separator
+  //      If 'vault1:', an error is thrown
+  //      If 'a/b/c', an error is thrown
+  // Splits out everything after an `=` separator
   const lastEqualIndex = secretPath.lastIndexOf('=');
   const splitSecretPath =
     lastEqualIndex === -1
@@ -89,25 +89,18 @@ function parseSecretPathOptional(
   return [vaultName, directoryPath, value];
 }
 
-function parseSecretPath(secretPath: string): [string, string, string?] {
-  // E.g. If 'vault1:a/b/c', ['vault1', 'a/b/c'] is returned
-  //      If 'vault1', an error is thrown
-  const [vaultName, secretName, value] = parseSecretPathOptional(secretPath);
-  if (secretName === undefined) {
-    throw new commander.InvalidArgumentError(
-      `${secretPath} is not of the format <vaultName>:<directoryPath>[=<value>]`,
-    );
-  }
-  return [vaultName, secretName, value];
-}
-
 function parseSecretPathValue(secretPath: string): [string, string, string?] {
   const [vaultName, directoryPath, value] = parseSecretPath(secretPath);
   if (value != null && !secretPathValueRegex.test(value)) {
     throw new commander.InvalidArgumentError(
       `${value} is not a valid value name`,
     );
   }
+  if (directoryPath == null) {
+    throw new commander.InvalidArgumentError(
+      `${secretPath} is not of the format <vaultName>:<directoryPath>[=<value>]`,
+    );
+  }
   return [vaultName, directoryPath, value];
 }
 
@@ -118,6 +111,11 @@ function parseSecretPathEnv(secretPath: string): [string, string, string?] {
       `${value} is not a valid environment variable name`,
     );
   }
+  if (directoryPath == null) {
+    throw new commander.InvalidArgumentError(
+      `${secretPath} is not of the format <vaultName>:<directoryPath>[=<value>]`,
+    );
+  }
   return [vaultName, directoryPath, value];
 }
 
@@ -221,7 +219,6 @@ export {
   validateParserToArgParser,
   validateParserToArgListParser,
   parseCoreCount,
-  parseSecretPathOptional,
   parseSecretPath,
   parseSecretPathValue,
   parseSecretPathEnv,