sim 2.0.0-preview.16.1 → 2.0.0-preview.17.1

package/dist/index.js

@@ -8939,6 +8939,10 @@ var V2_OPERATIONS = {
         kind: "string",
         required: true,
         describe: "Write-only secret value. It is never returned."
+      },
+      description: {
+        kind: "string",
+        describe: "What the secret is for, shown to teammates. Workspace scope only — sending it for a personal secret is rejected. Omit it to leave an existing description untouched; send null or an empty string to clear one."
       }
     }
   },
@@ -9996,7 +10000,8 @@ var CLI_CONTRACT = {
       { header: "name" },
       { header: "scope" },
       { header: "role" },
-      { header: "updated", path: "updatedAt", format: "timestamp" }
+      { header: "updated", path: "updatedAt", format: "timestamp" },
+      { header: "description" }
     ]
   },
   getWorkspace: {
@@ -11834,7 +11839,8 @@ var SECRET_RESULT = {
     { header: "name" },
     { header: "scope" },
     { header: "role" },
-    { header: "updated", path: "updatedAt", format: "timestamp" }
+    { header: "updated", path: "updatedAt", format: "timestamp" },
+    { header: "description" }
   ]
 };
 function validateSecretValue(value) {
@@ -11845,7 +11851,16 @@ function validateSecretValue(value) {
   }
   return value;
 }
+function validateDescriptionScope(description, scope) {
+  if (description === undefined)
+    return;
+  if (scope === "personal") {
+    throw new SimApiError("--description is only supported for a workspace secret.", 0);
+  }
+  return description;
+}
 async function setSecret(name, options, command) {
+  const description = validateDescriptionScope(options.description, options.scope);
   const value = validateSecretValue(options.value ?? await promptSecret());
   const { client, profile } = clientFrom(command);
   const operation = V2_OPERATIONS.setSecret;
@@ -11854,7 +11869,8 @@ async function setSecret(name, options, command) {
     body: {
       workspaceId: client.requireWorkspace(),
       scope: options.scope,
-      value
+      value,
+      description
     }
   });
   renderResult("setSecret", profile.output, response.data, SECRET_RESULT);
@@ -11863,7 +11879,7 @@ function attachSecretCommands(program2) {
   const secrets = program2.commands.find((command) => command.name() === "secrets");
   if (!secrets)
     throw new Error("The generated secrets command group is missing");
-  secrets.command("set").argument("<name>", "Secret name, as referenced in workflows").description("Create or replace a named secret").addOption(new Option("--scope <scope>", "Secret ownership scope").choices([...SECRET_SCOPES]).makeOptionMandatory()).option("--value <value>", "Secret value; visible to shell history when supplied directly").action((name, options, command) => setSecret(name, options, command));
+  secrets.command("set").argument("<name>", "Secret name, as referenced in workflows").description("Create or replace a named secret").addOption(new Option("--scope <scope>", "Secret ownership scope").choices([...SECRET_SCOPES]).makeOptionMandatory()).option("--value <value>", "Secret value; visible to shell history when supplied directly").option("--description <description>", "What the secret is for, shown to teammates; workspace scope only. Omit to leave an existing description unchanged").action((name, options, command) => setSecret(name, options, command));
 }
 
 // src/runtime/renamed.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sim",
-  "version": "2.0.0-preview.16.1",
+  "version": "2.0.0-preview.17.1",
   "description": "Sim CLI - talk to the Sim API from your terminal",
   "type": "module",
   "bin": {