@deepdockai/cli 1.0.21 → 1.0.23

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.0.23
+
+- An incident's program version is named `programVersion` instead of `version`, in `GET /v1/incidents`, in `incidents list --json` and in the skill's concepts. Read the new name where you read the old one; the value is unchanged.
+
+## 1.0.22
+
+- `keys create --write-env` writes `DEEPDOCK_BASE_URL=<url>` beside the key when `DEEPDOCK_BASE_URL` points the CLI at another API than production, since a key works only on the API it was created on and the bundled clients default to production. A production key points such a line, left by an earlier key, at production. `meta.written.baseUrl` names the URL when the line was written. Revoking a key removes only the key line.
+- The help of `keys create` names the temporary file the CLI writes beside the env file (`<file>.deepdock-tmp-*`), which git must ignore too; a pattern such as `.env*` covers both.
+
 ## 1.0.21
 
 - A bad action input is refused before it reaches the device, with `400 invalid_request`, and the answer lists every input that failed in `error.fields`: `{ field, message }` items, sorted by name, at most 32, never the value you sent. An unknown or missing input used to come back as `422 invalid_input`; it is now this 400. `invalid_input` stays for the rules only the device can judge, such as a pattern or a calendar date. The skill's error reference describes `fields`.

package/dist/deepdock.js

@@ -11429,7 +11429,7 @@ import { spawn } from "node:child_process";
 import { homedir, hostname } from "node:os";
 
 // src/version.ts
-var VERSION = "1.0.21";
+var VERSION = "1.0.23";
 
 // src/runtime.ts
 var DEFAULT_BASE_URL = "https://api.deepdock.ai";
@@ -12138,9 +12138,13 @@ Arguments
 
 Flags
   --expires <duration>  7d, 30d or 90d (required; 90 days is the maximum from the CLI)
-  --write-env <file>    Write DEEPDOCK_API_KEY=<key> into this file (required). Inside a git
-                        repository the file must be ignored and not tracked; outside one
-                        the CLI warns
+  --write-env <file>    Write DEEPDOCK_API_KEY=<key> into this file (required), and
+                        DEEPDOCK_BASE_URL=<url> beside it when DEEPDOCK_BASE_URL points the
+                        CLI at another API than production (a production key points such a
+                        line, left by an earlier key, at production). Inside a git repository the file
+                        must be ignored and not tracked, and so must the temporary file the
+                        CLI writes next to it (<file>.deepdock-tmp-*): a pattern such as
+                        .env* covers both. Outside a repository the CLI warns
   --no-wait             Print the request and exit; finish it with --wait
   --wait <request>      Finish a request started with --no-wait
   --no-browser          Do not open the link in a browser (also DEEPDOCK_NO_BROWSER=1)
@@ -12266,6 +12270,7 @@ import { randomBytes as randomBytes2 } from "node:crypto";
 import { promises as fs4 } from "node:fs";
 import { basename, dirname as dirname2, join as join2, resolve } from "node:path";
 var API_KEY_VARIABLE = "DEEPDOCK_API_KEY";
+var BASE_URL_VARIABLE = "DEEPDOCK_BASE_URL";
 var windowsFileWarning = (platform, envFile, settingsFile) => platform === "win32" ? `On Windows these files keep the permissions of their folder: ${envFile} and the settings file ${settingsFile} hold secrets; under C:\\Users\\<you> only you can read them, in other folders other users of this PC may be able to.` : undefined;
 var git = (rt, dir, args) => new Promise((done) => {
   const env = { ...rt.env ?? process.env, LC_ALL: "C" };
@@ -12420,7 +12425,7 @@ var atomicWrite = async (path, content) => {
   }
 };
 var KEY_SHAPE = /^[A-Za-z0-9_-]{16,}$/;
-var writeEnvValue = async (path, variable, value) => {
+var writeEnvValue = async (path, variable, value, baseUrl) => {
   if (!KEY_SHAPE.test(value)) {
     throw internal("The API answered a key in a shape this CLI will not write.", "Nothing was written.");
   }
@@ -12431,7 +12436,11 @@ var writeEnvValue = async (path, variable, value) => {
     if (!(error instanceof Error && ("code" in error) && error.code === "ENOENT"))
       throw error;
   }
-  await atomicWrite(path, upsertLine(existing, variable, value));
+  const withKey = upsertLine(existing, variable, value);
+  const matcher = lineStart(BASE_URL_VARIABLE);
+  const writeBase = baseUrl !== undefined && (baseUrl.always || withKey.split(/\r?\n/).some((line) => matcher.test(line)));
+  await atomicWrite(path, writeBase ? upsertLine(withKey, BASE_URL_VARIABLE, baseUrl.url) : withKey);
+  return writeBase;
 };
 var removeEnvValue = async (path, variable, prefix) => {
   let existing;
@@ -12994,6 +13003,8 @@ var finishKey = async (ctx, pending, warned) => {
     org: org.slug
   });
   const created = answer.key;
+  const baseUrlLine = { url: ctx.baseUrl, always: ctx.baseUrl !== DEFAULT_BASE_URL };
+  let baseUrlWritten = false;
   const entry = {
     org: org.slug,
     id: created.id,
@@ -13014,7 +13025,7 @@ var finishKey = async (ctx, pending, warned) => {
     const windows = windowsFileWarning(ctx.rt.platform, pending.file, configPath(ctx.rt));
     if (windows)
       ctx.note(windows);
-    await writeEnvValue(pending.file, pending.variable, created.key);
+    baseUrlWritten = await writeEnvValue(pending.file, pending.variable, created.key, baseUrlLine);
   } catch (error) {
     let revoked = true;
     try {
@@ -13035,13 +13046,14 @@ var finishKey = async (ctx, pending, warned) => {
     });
   }
   const file = displayPath(ctx.rt, pending.file);
+  const written = baseUrlWritten ? `${pending.variable}, ${BASE_URL_VARIABLE}` : pending.variable;
   const days = Math.round((Date.parse(created.expiresAt) - ctx.rt.now().getTime()) / DAY_MS);
   const text = [
     `${paint(ctx.out, "success", "Created")} API key "${stripControl(created.name)}".`,
     `  ID:        ${created.id}`,
     `  Prefix:    ${created.keyPrefix}`,
     `  Expires:   ${created.expiresAt.slice(0, 10)} (${days} days)`,
-    `  Written:   ${file} (${pending.variable})`,
+    `  Written:   ${file} (${written})`,
     `The key value was shown to nobody and this CLI keeps no copy; your code reads it from ${file}.`,
     `To revoke it: ${paint(ctx.out, "emphasis", `deepdock keys revoke ${created.id}`)}`,
     `${paint(ctx.out, "emphasis", "`deepdock auth logout`")} revokes this key; use ${paint(ctx.out, "emphasis", "`auth logout --keep-keys`")} to keep it.`
@@ -13055,7 +13067,14 @@ var finishKey = async (ctx, pending, warned) => {
       createdAt: created.createdAt,
       expiresAt: created.expiresAt
     },
-    meta: { requestId, written: { file, name: pending.variable } },
+    meta: {
+      requestId,
+      written: {
+        file,
+        name: pending.variable,
+        ...baseUrlWritten ? { baseUrl: ctx.baseUrl } : {}
+      }
+    },
     text
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deepdockai/cli",
-  "version": "1.0.21",
+  "version": "1.0.23",
   "description": "Deepdock partner CLI: pair devices, see systems and actions, create the API key your code runs them with.",
   "type": "module",
   "license": "MIT",

package/skill/SKILL.md

@@ -58,8 +58,8 @@ and what your code does with the result.
    dashboard. The CLI receives the key once, writes `DEEPDOCK_API_KEY=<key>` into that file (it
    must be ignored by git) and keeps no copy. It is displayed to you or to the human by nobody.
    You work only with the key's id, prefix and the file name. Never ask for, read, print or paste
-   a key value. If the CLI runs with `DEEPDOCK_BASE_URL` set (a non-production API), add the same
-   `DEEPDOCK_BASE_URL=<url>` line to that file ([auth-and-keys.md](references/auth-and-keys.md)).
+   a key value. If the CLI runs with `DEEPDOCK_BASE_URL` set (a non-production API), it writes the
+   same `DEEPDOCK_BASE_URL=<url>` line into that file too ([auth-and-keys.md](references/auth-and-keys.md)).
 6. **Test it.** Run your own code against the demo device the human named, with the key from
    `.env.local`, and read back with the read action. The CLI runs no action. Read
    [references/testing.md](references/testing.md) before any write.

package/skill/references/auth-and-keys.md

@@ -35,8 +35,9 @@ in the dashboard" and stop retrying.
   dashboard's examples use). Never a literal in source, a test fixture, a log or a URL.
 - One key per deployment is enough; there is no per-device key.
 - A key works only against the API it was created on. The CLI uses production unless
-  `DEEPDOCK_BASE_URL` is set; when it is (`deepdock auth status --json` shows it as `baseUrl`), put
-  the same `DEEPDOCK_BASE_URL=<url>` line next to the key. The bundled clients read it too.
+  `DEEPDOCK_BASE_URL` is set; when it is (`deepdock auth status --json` shows it as `baseUrl`),
+  `keys create --write-env` writes the same `DEEPDOCK_BASE_URL=<url>` line next to the key, and a
+  production key points such a line at production. The bundled clients read it too.
 - Getting a key into the app is the CLI's job: `deepdock keys create <name> --expires <d>
   --write-env <file>` opens a link to the dashboard; a human clicks Approve (or Deny); the CLI
   receives the key once and writes `DEEPDOCK_API_KEY=<key>` into the file, which must be ignored

package/skill/references/concepts.md

@@ -95,7 +95,8 @@ Each pause opens an **incident** (`GET /v1/incidents`). Only Deepdock lifts a pa
 customer's site see that an action is paused but cannot resume it; there is no partner call to
 resume. A stopped or missing system needs no resume: its incident closes once the system is back.
 
-An incident has `id`, `system`, `version`, `action` (`null` for a system-level incident), `reason`,
+An incident has `id`, `system`, `programVersion` (the version of the vendor's program its devices
+run, `null` when they reported none), `action` (`null` for a system-level incident), `reason`,
 `openedAt`, `closedAt`, and `devices` with `deviceId`, `pausedAt`, `resumedAt` and `inactiveAt`. It
 closes once none of its devices is still paused. `GET /v1/incidents` lists incidents that are open
 or closed within the last 30 days, newest first, at most 100.