sim 2.2.3-preview.182.1 → 2.2.3-preview.184.1

package/README.md

@@ -187,6 +187,16 @@ For each setting, the CLI uses the first available value in this order:
 4. built-in default
 
 `sim whoami` shows both the resolved values and where each one came from.
+Its JSON and YAML `authenticated` field is `true` after the server accepts the
+credential, `false` when it is missing or rejected, and `null` when authentication
+could not be checked (including `--no-verify`). `verification.status` separately
+reports whether the configured workspace is accessible; a valid credential can
+still have `no-workspace` or `rejected` workspace verification.
+
+`sim files read` and `sim files versions read` print the complete text response as
+JSON, or YAML with `--output yaml`, including in table and text display modes.
+The `truncated` field describes server extraction limits, not display clipping.
+For the original file bytes, use `sim files get`.
 
 ## Useful commands
 

package/dist/generated/v2-api.d.ts

@@ -983,6 +983,124 @@ export type ChatResponse = {
         toolCalls?: Array<Record<string, unknown>>;
     };
 };
+/** `GET /api/v2/workflows/[workflowId]/versions/compare` */
+export type CompareWorkflowVersionsParams = {
+    workflowId: string;
+};
+export type CompareWorkflowVersionsQuery = {
+    base: number;
+    target: number;
+};
+type CompareWorkflowVersionsResponseRef0 = {
+    workflowId: string;
+    base: number;
+    target: number;
+    diff: {
+        addedBlocks: Array<{
+            id: string;
+            type: string;
+            name?: string;
+        }>;
+        removedBlocks: Array<{
+            id: string;
+            type: string;
+            name?: string;
+        }>;
+        modifiedBlocks: Array<{
+            id: string;
+            type: string;
+            name?: string;
+            changes: Array<{
+                field: string;
+                oldValue: {
+                    kind: 'unset';
+                } | {
+                    kind: 'redacted';
+                } | {
+                    kind: 'value';
+                    value: unknown;
+                };
+                newValue: {
+                    kind: 'unset';
+                } | {
+                    kind: 'redacted';
+                } | {
+                    kind: 'value';
+                    value: unknown;
+                };
+                scope: 'block' | 'subblock';
+            }>;
+        }>;
+        edgeChanges: {
+            added: number;
+            removed: number;
+            addedDetails: Array<{
+                source: string;
+                target: string;
+                sourceHandle?: string;
+                targetHandle?: string;
+                sourceName: string;
+                targetName: string;
+            }>;
+            removedDetails: Array<{
+                source: string;
+                target: string;
+                sourceHandle?: string;
+                targetHandle?: string;
+                sourceName: string;
+                targetName: string;
+            }>;
+        };
+        loopChanges: {
+            added: number;
+            removed: number;
+            modified: number;
+        };
+        parallelChanges: {
+            added: number;
+            removed: number;
+            modified: number;
+        };
+        containerChanges: Array<{
+            id: string;
+            kind: 'loop' | 'parallel';
+            name?: string;
+            changes: Array<{
+                field: string;
+                oldValue: {
+                    kind: 'unset';
+                } | {
+                    kind: 'redacted';
+                } | {
+                    kind: 'value';
+                    value: unknown;
+                };
+                newValue: {
+                    kind: 'unset';
+                } | {
+                    kind: 'redacted';
+                } | {
+                    kind: 'value';
+                    value: unknown;
+                };
+            }>;
+            nodesAdded: Array<string>;
+            nodesRemoved: Array<string>;
+        }>;
+        variableChanges: {
+            added: number;
+            removed: number;
+            modified: number;
+            addedNames: Array<string>;
+            removedNames: Array<string>;
+            modifiedNames: Array<string>;
+        };
+        hasChanges: boolean;
+    };
+};
+export type CompareWorkflowVersionsResponse = {
+    data: CompareWorkflowVersionsResponseRef0;
+};
 /** `POST /api/v2/files/uploads/[uploadId]/complete` */
 export type CompleteFileUploadParams = {
     uploadId: string;
@@ -10722,6 +10840,28 @@ export declare const V2_OPERATIONS: {
             };
         };
     };
+    readonly compareWorkflowVersions: {
+        readonly method: 'GET';
+        readonly path: '/api/v2/workflows/[workflowId]/versions/compare';
+        readonly pathParams: readonly ['workflowId'];
+        readonly pathParamDocs: {
+            readonly workflowId: 'Unique workflow identifier.';
+        };
+        readonly responseMode: 'json';
+        readonly summary: 'Compare Workflow Versions';
+        readonly query: {
+            readonly base: {
+                readonly kind: 'integer';
+                readonly required: true;
+                readonly describe: 'Deployment version to compare from.';
+            };
+            readonly target: {
+                readonly kind: 'integer';
+                readonly required: true;
+                readonly describe: 'Deployment version to compare to, in the same workflow.';
+            };
+        };
+    };
     readonly completeFileUpload: {
         readonly method: 'POST';
         readonly path: '/api/v2/files/uploads/[uploadId]/complete';

package/dist/index.js

@@ -9327,6 +9327,17 @@ import { spawn as spawn3 } from "node:child_process";
 import { randomBytes as randomBytes3 } from "node:crypto";
 import { createInterface } from "node:readline/promises";
 
+// ../utils/src/object.ts
+function isRecordLike(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function toRecord(value) {
+  return isRecordLike(value) ? value : {};
+}
+function toRecordOrNull(value) {
+  return isRecordLike(value) ? value : null;
+}
+
 // src/auth/device-flow.ts
 import { createHash as createHash3, randomBytes as randomBytes2, randomInt } from "node:crypto";
 
@@ -9946,6 +9957,22 @@ var V2_OPERATIONS = {
       }
     }
   },
+  compareWorkflowVersions: {
+    method: "GET",
+    path: "/api/v2/workflows/[workflowId]/versions/compare",
+    pathParams: ["workflowId"],
+    pathParamDocs: { workflowId: "Unique workflow identifier." },
+    responseMode: "json",
+    summary: "Compare Workflow Versions",
+    query: {
+      base: { kind: "integer", required: true, describe: "Deployment version to compare from." },
+      target: {
+        kind: "integer",
+        required: true,
+        describe: "Deployment version to compare to, in the same workflow."
+      }
+    }
+  },
   completeFileUpload: {
     method: "POST",
     path: "/api/v2/files/uploads/[uploadId]/complete",
@@ -16775,13 +16802,13 @@ function openBrowser(url) {
 function presentAuthentication(source) {
   switch (source) {
     case "flag":
-      return { authenticated: true, source: "flag" };
+      return { configured: true, source: "flag" };
     case "env":
-      return { authenticated: true, source: "env" };
+      return { configured: true, source: "env" };
     case "credentials":
-      return { authenticated: true, source: "credentials" };
+      return { configured: true, source: "credentials" };
     case "unset":
-      return { authenticated: false, source: "unset" };
+      return { configured: false, source: "unset" };
     case "config":
     case "default":
       throw new SimApiError(`Unexpected credential source "${source}".`, 0);
@@ -17187,18 +17214,7 @@ function logoutCommand() {
     }
   });
 }
-async function readKeyType(client) {
-  const operation = V2_OPERATIONS.getMeta;
-  try {
-    const response = await client.request(operation.path, {
-      method: operation.method
-    });
-    return response.data.keyType;
-  } catch {
-    return null;
-  }
-}
-var CREDENTIAL_VERDICT_STATUSES = new Set([401, 403, 404]);
+var PROFILE_REJECTION_STATUSES = new Set([401, 403, 404]);
 var WHOAMI_EXIT_CODES = {
   verified: 0,
   disabled: 0,
@@ -17211,15 +17227,41 @@ async function verifyProfile(client, profile) {
   if (!profile.apiKey && !profile.oauth) {
     return {
       status: "unauthenticated",
+      authenticated: false,
       workspace: null,
       keyType: null,
       detail: `not logged in — run: sim login --profile ${safeOneLine(profile.name)}`
     };
   }
-  const keyType = await readKeyType(client);
+  let keyType = null;
+  let authenticated = null;
+  const metaOperation = V2_OPERATIONS.getMeta;
+  try {
+    const response = await client.request(metaOperation.path, {
+      method: metaOperation.method
+    });
+    const reportedKeyType = toRecord(toRecord(response).data).keyType;
+    if (reportedKeyType === "personal" || reportedKeyType === "workspace" || reportedKeyType === "oauth_access_token") {
+      keyType = reportedKeyType;
+      authenticated = true;
+    }
+  } catch (error) {
+    if (!(error instanceof SimApiError))
+      throw error;
+    if (error.status === 401 || error.status === 403) {
+      return {
+        status: "rejected",
+        authenticated: false,
+        workspace: null,
+        keyType: null,
+        detail: error.message
+      };
+    }
+  }
   if (!profile.workspaceId) {
     return {
       status: "no-workspace",
+      authenticated,
       workspace: null,
       keyType,
       detail: `no workspace to check against — run: sim configure --profile ${safeOneLine(profile.name)} --set-workspace <id>`
@@ -17229,12 +17271,19 @@ async function verifyProfile(client, profile) {
   try {
     const response = await client.request(resolvePath(operation.path, { workspaceId: profile.workspaceId }), { method: operation.method });
     const { id, name, memberCount } = response.data;
-    return { status: "verified", workspace: { id, name, memberCount }, keyType, detail: null };
+    return {
+      status: "verified",
+      authenticated: true,
+      workspace: { id, name, memberCount },
+      keyType,
+      detail: null
+    };
   } catch (error) {
     if (!(error instanceof SimApiError))
       throw error;
     return {
-      status: CREDENTIAL_VERDICT_STATUSES.has(error.status) ? "rejected" : "unreachable",
+      status: PROFILE_REJECTION_STATUSES.has(error.status) ? "rejected" : "unreachable",
+      authenticated: error.status === 401 ? false : authenticated,
       workspace: null,
       keyType,
       detail: error.message
@@ -17266,6 +17315,7 @@ function whoamiCommand() {
     const authentication = presentAuthentication(sources.credential);
     const verification = options.verify ? await verifyProfile(client, profile) : {
       status: "disabled",
+      authenticated: authentication.configured ? null : false,
       workspace: null,
       keyType: null,
       detail: "not checked (--no-verify)"
@@ -17276,7 +17326,7 @@ function whoamiCommand() {
       ["Endpoint", annotate(profile.endpoint, sources.endpoint)],
       [
         "Login",
-        authentication.authenticated ? annotate(profile.oauth ? "OAuth" : "API key", authentication.source) : styles3().yellow("not logged in")
+        authentication.configured ? annotate(profile.oauth ? "OAuth" : "API key", authentication.source) : styles3().yellow("not logged in")
       ],
       [
         "Key type",
@@ -17290,7 +17340,7 @@ function whoamiCommand() {
       endpoint: profile.endpoint,
       workspaceId: profile.workspaceId,
       output: profile.output,
-      authenticated: authentication.authenticated,
+      authenticated: verification.authenticated,
       sources: {
         endpoint: sources.endpoint,
         authentication: authentication.source,
@@ -17788,7 +17838,8 @@ var CLI_CONTRACT = {
   },
   readFileText: {
     command: "files read",
-    describe: "Read a file’s text content"
+    describe: "Read a file’s text content as JSON or YAML",
+    document: true
   },
   createWorkflowMcpServer: {
     flags: { workflowIds: { name: "workflow", list: true } }
@@ -17845,6 +17896,7 @@ var CLI_CONTRACT = {
       operations: { json: true, describe: WORKFLOW_VARIABLE_OPERATIONS_HELP }
     }
   },
+  compareWorkflowVersions: { command: "workflows versions compare" },
   revertWorkflowVersion: {
     confirm: "This overwrites the draft graph with the selected version and cannot be undone."
   },
@@ -17981,7 +18033,14 @@ var CLI_CONTRACT = {
     variants: [moveResource("knowledge mv", "knowledge base")],
     flags: { folderPath: FOLDER_PATH_FLAG }
   },
-  createWorkflow: { flags: { folderPath: FOLDER_PATH_FLAG } },
+  createWorkflow: {
+    flags: {
+      folderPath: {
+        ...FOLDER_PATH_FLAG,
+        describe: "Existing folder path (leading / optional); create it first with sim workflows mkdir <path>"
+      }
+    }
+  },
   updateWorkflow: {
     variants: [moveResource("workflows mv", "workflow")],
     flags: { folderPath: FOLDER_PATH_FLAG }
@@ -18597,7 +18656,8 @@ var CLI_CONTRACT = {
   },
   readFileVersionText: {
     command: "files versions read",
-    describe: "Read the text content of one version of a file"
+    describe: "Read the text content of one version of a file as JSON or YAML",
+    document: true
   },
   revertFileVersion: {
     command: "files versions revert",
@@ -22188,14 +22248,6 @@ function attachTableImport(tables) {
   });
 }
 
-// ../utils/src/object.ts
-function isRecordLike(value) {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-function toRecordOrNull(value) {
-  return isRecordLike(value) ? value : null;
-}
-
 // src/commands/protocol/workflow-run-follow.ts
 var AGENT_STREAM_PROTOCOL_HEADER = "x-sim-stream-protocol";
 var AGENT_STREAM_PROTOCOL_V1 = "agent-events-v1";

package/dist/runtime.js

@@ -9036,6 +9036,17 @@ import { spawn as spawn3 } from "node:child_process";
 import { randomBytes as randomBytes3 } from "node:crypto";
 import { createInterface } from "node:readline/promises";
 
+// ../utils/src/object.ts
+function isRecordLike(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function toRecord(value) {
+  return isRecordLike(value) ? value : {};
+}
+function toRecordOrNull(value) {
+  return isRecordLike(value) ? value : null;
+}
+
 // src/auth/device-flow.ts
 import { createHash as createHash2, randomBytes, randomInt } from "node:crypto";
 
@@ -9995,6 +10006,22 @@ var V2_OPERATIONS = {
       }
     }
   },
+  compareWorkflowVersions: {
+    method: "GET",
+    path: "/api/v2/workflows/[workflowId]/versions/compare",
+    pathParams: ["workflowId"],
+    pathParamDocs: { workflowId: "Unique workflow identifier." },
+    responseMode: "json",
+    summary: "Compare Workflow Versions",
+    query: {
+      base: { kind: "integer", required: true, describe: "Deployment version to compare from." },
+      target: {
+        kind: "integer",
+        required: true,
+        describe: "Deployment version to compare to, in the same workflow."
+      }
+    }
+  },
   completeFileUpload: {
     method: "POST",
     path: "/api/v2/files/uploads/[uploadId]/complete",
@@ -16824,13 +16851,13 @@ function openBrowser(url) {
 function presentAuthentication(source) {
   switch (source) {
     case "flag":
-      return { authenticated: true, source: "flag" };
+      return { configured: true, source: "flag" };
     case "env":
-      return { authenticated: true, source: "env" };
+      return { configured: true, source: "env" };
     case "credentials":
-      return { authenticated: true, source: "credentials" };
+      return { configured: true, source: "credentials" };
     case "unset":
-      return { authenticated: false, source: "unset" };
+      return { configured: false, source: "unset" };
     case "config":
     case "default":
       throw new SimApiError(`Unexpected credential source "${source}".`, 0);
@@ -17236,18 +17263,7 @@ function logoutCommand() {
     }
   });
 }
-async function readKeyType(client) {
-  const operation = V2_OPERATIONS.getMeta;
-  try {
-    const response = await client.request(operation.path, {
-      method: operation.method
-    });
-    return response.data.keyType;
-  } catch {
-    return null;
-  }
-}
-var CREDENTIAL_VERDICT_STATUSES = new Set([401, 403, 404]);
+var PROFILE_REJECTION_STATUSES = new Set([401, 403, 404]);
 var WHOAMI_EXIT_CODES = {
   verified: 0,
   disabled: 0,
@@ -17260,15 +17276,41 @@ async function verifyProfile(client, profile) {
   if (!profile.apiKey && !profile.oauth) {
     return {
       status: "unauthenticated",
+      authenticated: false,
       workspace: null,
       keyType: null,
       detail: `not logged in — run: sim login --profile ${safeOneLine(profile.name)}`
     };
   }
-  const keyType = await readKeyType(client);
+  let keyType = null;
+  let authenticated = null;
+  const metaOperation = V2_OPERATIONS.getMeta;
+  try {
+    const response = await client.request(metaOperation.path, {
+      method: metaOperation.method
+    });
+    const reportedKeyType = toRecord(toRecord(response).data).keyType;
+    if (reportedKeyType === "personal" || reportedKeyType === "workspace" || reportedKeyType === "oauth_access_token") {
+      keyType = reportedKeyType;
+      authenticated = true;
+    }
+  } catch (error) {
+    if (!(error instanceof SimApiError))
+      throw error;
+    if (error.status === 401 || error.status === 403) {
+      return {
+        status: "rejected",
+        authenticated: false,
+        workspace: null,
+        keyType: null,
+        detail: error.message
+      };
+    }
+  }
   if (!profile.workspaceId) {
     return {
       status: "no-workspace",
+      authenticated,
       workspace: null,
       keyType,
       detail: `no workspace to check against — run: sim configure --profile ${safeOneLine(profile.name)} --set-workspace <id>`
@@ -17278,12 +17320,19 @@ async function verifyProfile(client, profile) {
   try {
     const response = await client.request(resolvePath(operation.path, { workspaceId: profile.workspaceId }), { method: operation.method });
     const { id, name, memberCount } = response.data;
-    return { status: "verified", workspace: { id, name, memberCount }, keyType, detail: null };
+    return {
+      status: "verified",
+      authenticated: true,
+      workspace: { id, name, memberCount },
+      keyType,
+      detail: null
+    };
   } catch (error) {
     if (!(error instanceof SimApiError))
       throw error;
     return {
-      status: CREDENTIAL_VERDICT_STATUSES.has(error.status) ? "rejected" : "unreachable",
+      status: PROFILE_REJECTION_STATUSES.has(error.status) ? "rejected" : "unreachable",
+      authenticated: error.status === 401 ? false : authenticated,
       workspace: null,
       keyType,
       detail: error.message
@@ -17315,6 +17364,7 @@ function whoamiCommand() {
     const authentication = presentAuthentication(sources.credential);
     const verification = options.verify ? await verifyProfile(client, profile) : {
       status: "disabled",
+      authenticated: authentication.configured ? null : false,
       workspace: null,
       keyType: null,
       detail: "not checked (--no-verify)"
@@ -17325,7 +17375,7 @@ function whoamiCommand() {
       ["Endpoint", annotate(profile.endpoint, sources.endpoint)],
       [
         "Login",
-        authentication.authenticated ? annotate(profile.oauth ? "OAuth" : "API key", authentication.source) : styles3().yellow("not logged in")
+        authentication.configured ? annotate(profile.oauth ? "OAuth" : "API key", authentication.source) : styles3().yellow("not logged in")
       ],
       [
         "Key type",
@@ -17339,7 +17389,7 @@ function whoamiCommand() {
       endpoint: profile.endpoint,
       workspaceId: profile.workspaceId,
       output: profile.output,
-      authenticated: authentication.authenticated,
+      authenticated: verification.authenticated,
       sources: {
         endpoint: sources.endpoint,
         authentication: authentication.source,
@@ -17837,7 +17887,8 @@ var CLI_CONTRACT = {
   },
   readFileText: {
     command: "files read",
-    describe: "Read a file’s text content"
+    describe: "Read a file’s text content as JSON or YAML",
+    document: true
   },
   createWorkflowMcpServer: {
     flags: { workflowIds: { name: "workflow", list: true } }
@@ -17894,6 +17945,7 @@ var CLI_CONTRACT = {
       operations: { json: true, describe: WORKFLOW_VARIABLE_OPERATIONS_HELP }
     }
   },
+  compareWorkflowVersions: { command: "workflows versions compare" },
   revertWorkflowVersion: {
     confirm: "This overwrites the draft graph with the selected version and cannot be undone."
   },
@@ -18030,7 +18082,14 @@ var CLI_CONTRACT = {
     variants: [moveResource("knowledge mv", "knowledge base")],
     flags: { folderPath: FOLDER_PATH_FLAG }
   },
-  createWorkflow: { flags: { folderPath: FOLDER_PATH_FLAG } },
+  createWorkflow: {
+    flags: {
+      folderPath: {
+        ...FOLDER_PATH_FLAG,
+        describe: "Existing folder path (leading / optional); create it first with sim workflows mkdir <path>"
+      }
+    }
+  },
   updateWorkflow: {
     variants: [moveResource("workflows mv", "workflow")],
     flags: { folderPath: FOLDER_PATH_FLAG }
@@ -18646,7 +18705,8 @@ var CLI_CONTRACT = {
   },
   readFileVersionText: {
     command: "files versions read",
-    describe: "Read the text content of one version of a file"
+    describe: "Read the text content of one version of a file as JSON or YAML",
+    document: true
   },
   revertFileVersion: {
     command: "files versions revert",
@@ -22237,14 +22297,6 @@ function attachTableImport(tables) {
   });
 }
 
-// ../utils/src/object.ts
-function isRecordLike(value) {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-function toRecordOrNull(value) {
-  return isRecordLike(value) ? value : null;
-}
-
 // src/commands/protocol/workflow-run-follow.ts
 var AGENT_STREAM_PROTOCOL_HEADER = "x-sim-stream-protocol";
 var AGENT_STREAM_PROTOCOL_V1 = "agent-events-v1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sim",
-  "version": "2.2.3-preview.182.1",
+  "version": "2.2.3-preview.184.1",
   "description": "Sim CLI - talk to the Sim API from your terminal",
   "type": "module",
   "imports": {