sim 2.1.8-preview.100.1 → 2.1.8-preview.102.1

package/README.md

@@ -220,11 +220,26 @@ will consume the result, and `text` for tab-separated shell output:
 
 ```bash
 sim workflows list --output json
-sim logs list --output json | jq -r '.[].runId'
+sim logs list --output json | jq -r '.data[].runId'
 SIM_OUTPUT=yaml sim tables get <tableId>
 sim configure --set-output json
 ```
 
+Paginated lists return `{ "data": [...], "nextCursor": "..." }` in JSON and YAML.
+`nextCursor` is `null` when no pages remain. Resource lists and directory `ls`
+fetch every page by default; use `--limit N` to cap them. Table rows (including
+queries), logs, audit/billing events, workflow runs/versions, and knowledge
+documents/chunks keep a default limit of 100. Use `--limit 0` to fetch every page
+of those datasets, or pass the returned `nextCursor` to `--cursor` to continue
+with another bounded result. Keep the same resource, filters, and sort order
+when resuming; stop when `nextCursor` is `null`. Results accumulate in memory
+before printing, so large datasets need an explicit limit or filter.
+
+```bash
+sim tables rows list <tableId> --limit 100 --output json
+sim tables rows list <tableId> --limit 100 --cursor "$nextCursor" --output json
+```
+
 JSON-valued options accept inline JSON, a file prefixed with `@`, or stdin with
 `@-`:
 

package/dist/index.js

@@ -4763,15 +4763,21 @@ function pageProgress() {
     }
   };
 }
-async function requestAllPages(client, path, options) {
-  return (await requestPages(client, path, options)).items;
+function assertCursorAdvances(cursor, seenCursors) {
+  if (cursor === null)
+    return;
+  if (seenCursors.has(cursor)) {
+    throw new SimApiError("The API returned a repeated pagination cursor; cannot continue.", 0);
+  }
+  seenCursors.add(cursor);
 }
-async function requestPages(client, path, options) {
+async function requestAllPages(client, path, options) {
   const { query, pageSize, limit: requestedLimit, ...requestOptions } = options;
   const limit = requestedLimit ?? Number.POSITIVE_INFINITY;
   if (limit <= 0)
-    return { items: [], truncated: false };
+    return [];
   const items = [];
+  const seenCursors = new Set;
   const progress = pageProgress();
   let cursor = null;
   try {
@@ -4784,6 +4790,7 @@ async function requestPages(client, path, options) {
           cursor
         }
       });
+      assertCursorAdvances(page.nextCursor, seenCursors);
       items.push(...page.data);
       cursor = page.nextCursor;
       if (cursor && items.length < limit)
@@ -4792,7 +4799,7 @@ async function requestPages(client, path, options) {
   } finally {
     progress.finish();
   }
-  return { items: items.slice(0, limit), truncated: cursor !== null || items.length > limit };
+  return items.slice(0, limit);
 }
 function resolvePath(template, params = {}) {
   return template.replace(/\[([^\]]+)\]/g, (_match, key) => {
@@ -16075,7 +16082,30 @@ function buildRequest(operation, positional, flags, workspaceId) {
 }
 
 // src/runtime/options.ts
-var DEFAULT_LIMIT = 100;
+var DEFAULT_PAGE_SIZE = 100;
+var COMPLETE_LIST_OPERATIONS = new Set([
+  "listBlocks",
+  "listChatDeployments",
+  "listCredentials",
+  "listCustomTools",
+  "listFiles",
+  "listKnowledgeBases",
+  "listKnowledgeConnectors",
+  "listMcpServers",
+  "listSandboxes",
+  "listSecrets",
+  "listSkillEditors",
+  "listSkills",
+  "listTables",
+  "listTools",
+  "listWorkflowMcpServers",
+  "listWorkflows",
+  "listWorkspaceMembers",
+  "listWorkspaces"
+]);
+function defaultListLimit(operation) {
+  return COMPLETE_LIST_OPERATIONS.has(operation) ? 0 : 100;
+}
 function describeField(flag, descriptor, name, field) {
   return flag.describe ?? descriptor.describe ?? `Set ${name.replaceAll("-", " ") || field}`;
 }
@@ -16088,15 +16118,21 @@ function withoutWireVocabulary(documented) {
 }
 var NON_PAGINATED_LIMIT_HINT = " (caps a --filter match only; omit it to act on every match, and note 0 is not accepted)";
 function addFieldOption(command, operation, field, descriptor, slot, paginates, capsAFilter) {
-  if (field === PROFILE_INJECTED_FIELD || field === "cursor")
+  if (field === PROFILE_INJECTED_FIELD)
     return;
+  if (field === "cursor") {
+    if (paginates && defaultListLimit(operation) > 0) {
+      command.option("--cursor <value>", "Continue from nextCursor returned by a previous result");
+    }
+    return;
+  }
   const flag = flagSpecFor(operation, field);
   if (flag.omit)
     return;
   const name = flagNameFor(operation, field);
   const short = flag.short ? `-${flag.short}, ` : "";
   if (paginates && field === "limit" && (descriptor.kind === "number" || descriptor.kind === "integer")) {
-    command.option("--limit <n>", "Maximum items to return (0 for everything)", String(DEFAULT_LIMIT));
+    command.option("--limit <n>", "Maximum items to return (0 for everything)", String(defaultListLimit(operation)));
     return;
   }
   const documented = `${describeField(flag, descriptor, name, field)}${capsAFilter && field === "limit" && (descriptor.kind === "number" || descriptor.kind === "integer") ? NON_PAGINATED_LIMIT_HINT : ""}`;
@@ -16456,11 +16492,10 @@ function unwrapResource(data) {
   const [, value] = entries[0];
   return value && typeof value === "object" && !Array.isArray(value) ? value : data;
 }
-function renderPage(format, rows, spec, envelope, options = {}) {
+function renderPage(format, page, spec, envelope) {
   writePageNote(spec, envelope);
   writeEnvelopeTruncation(envelope);
-  writeCursorTruncation(rows.length, options.truncated === true);
-  printList(format, rows, spec.columns ? columnsFrom(spec.columns) : inferColumns(rows, spec.expand));
+  printList(format, page.data, spec.columns ? columnsFrom(spec.columns) : inferColumns(page.data, spec.expand), page);
 }
 function writePageNote(spec, envelope) {
   if (!spec.pageNote)
@@ -16505,12 +16540,6 @@ function writeEnvelopeTruncation(envelope) {
 `));
   }
 }
-function writeCursorTruncation(count, truncated) {
-  if (!truncated)
-    return;
-  process.stderr.write(source_default.dim(`showing the first ${count}; more results exist — re-run with --limit 0 for all
-`));
-}
 function renderResult(operation, format, raw, spec, options = {}, envelope) {
   writeEnvelopeTruncation(envelope);
   if (spec.document) {
@@ -16647,8 +16676,8 @@ function bulkFailureMessage(operation, payload, body) {
 var EXCLUSIVE_CAP_FIELDS = {
   deleteTableRows: { cap: "limit", ids: "rowIds" }
 };
-function readPagedLimit(raw) {
-  const text = String(raw ?? DEFAULT_LIMIT).trim();
+function readPagedLimit(raw, operation) {
+  const text = String(raw ?? defaultListLimit(operation)).trim();
   const value = text === "" ? Number.NaN : Number(text);
   if (!Number.isInteger(value) || value < 0) {
     throw new SimApiError("--limit must be a whole number of 0 or more (0 for everything)", 0);
@@ -16723,24 +16752,33 @@ async function executeOperation(operation, commandSpec, operationSpec, invocatio
   const omitsWorkspace = commandSpec.allWorkspaces && requestFlags.allWorkspaces === true;
   const needsWorkspace = (hasWorkspaceField || commandSpec.profileWorkspacePath === true) && !omitsWorkspace;
   const paging = cursorSlot(operationSpec);
-  const pagedLimit = paging ? readPagedLimit(requestFlags.limit) : 0;
+  const pagedLimit = paging ? readPagedLimit(requestFlags.limit, operation) : 0;
   const request = buildRequest(operation, positional, requestFlags, needsWorkspace ? client.requireWorkspace() : profile.workspaceId);
   if (paging) {
+    const initialCursor = request[paging]?.cursor;
+    if (initialCursor !== undefined && (typeof initialCursor !== "string" || initialCursor.trim() === "")) {
+      throw new SimApiError("--cursor must be a non-empty string", 0);
+    }
     const limit = pagedLimit === 0 ? Number.POSITIVE_INFINITY : pagedLimit;
-    const pageSize = Math.min(Number.isFinite(limit) ? limit : DEFAULT_LIMIT, DEFAULT_LIMIT);
-    const pageLimit = "limit" in (operationSpec[paging] ?? {}) ? { limit: pageSize } : {};
     const rows = [];
+    const seenCursors = new Set(initialCursor ? [initialCursor] : []);
     const progress = pageProgress();
-    let cursor = null;
+    let cursor = initialCursor ?? null;
     let envelope;
     try {
       do {
+        const pageSize = Math.min(DEFAULT_PAGE_SIZE, limit - rows.length);
+        const pageLimit = "limit" in (operationSpec[paging] ?? {}) ? { limit: pageSize } : {};
         const page = await client.request(request.path, {
           method: operationSpec.method,
           headers: request.headers,
           query: paging === "query" ? { ...request.query, ...pageLimit, cursor } : request.query,
           body: paging === "body" ? { ...request.body ?? {}, ...pageLimit, ...cursor ? { cursor } : {} } : request.body
         });
+        if (page.data.length > pageSize) {
+          throw new SimApiError(`The API returned ${page.data.length} items for a page limit of ${pageSize}; nextCursor would skip unreturned items.`, 0);
+        }
+        assertCursorAdvances(page.nextCursor, seenCursors);
         envelope = foldPageEnvelope(envelope, page);
         rows.push(...page.data);
         cursor = page.nextCursor;
@@ -16750,7 +16788,7 @@ async function executeOperation(operation, commandSpec, operationSpec, invocatio
     } finally {
       progress.finish();
     }
-    renderPage(profile.output, Number.isFinite(limit) ? rows.slice(0, limit) : rows, commandSpec, envelope, { truncated: Boolean(cursor) });
+    renderPage(profile.output, { data: rows, nextCursor: cursor }, commandSpec, envelope);
     return;
   }
   const result = await client.request(request.path, {
@@ -18102,11 +18140,11 @@ async function listResources(client, config, workspaceId, folderPath, search, li
   const paginated = "cursor" in V2_OPERATIONS[config.resources].query;
   if (!paginated) {
     const page = await client.request(path, { query });
-    return { items: page.data.slice(0, limit), truncated: page.data.length > limit };
+    return page.data.slice(0, limit);
   }
-  return requestPages(client, path, {
+  return requestAllPages(client, path, {
     query,
-    pageSize: DEFAULT_LIMIT,
+    pageSize: DEFAULT_PAGE_SIZE,
     limit
   });
 }
@@ -18136,7 +18174,7 @@ function entriesFor(config, folders, resources) {
   ].sort((left, right) => left.name.localeCompare(right.name) || left.kind.localeCompare(right.kind));
 }
 function attachResourceDirectoryCommands(group, config) {
-  group.command("ls").argument("[path]", "Folder path to list; defaults to the root folder").allowExcessArguments(false).description(`List ${config.kind} resources and child folders together`).option("--search <text>", "Filter folders and resources by name").addOption(new Option("--limit <n>", "Maximum combined items to return (0 for everything)").default(String(DEFAULT_LIMIT))).action(async (path, options, command) => {
+  group.command("ls").argument("[path]", "Folder path to list; defaults to the root folder").allowExcessArguments(false).description(`List ${config.kind} resources and child folders together`).option("--search <text>", "Filter folders and resources by name").addOption(new Option("--limit <n>", "Maximum combined items to return (0 for everything)").default("0")).action(async (path, options, command) => {
     const rawLimit = Number(options.limit);
     if (!Number.isSafeInteger(rawLimit) || rawLimit < 0) {
       throw new SimApiError("--limit must be a whole number of 0 or more (0 for everything)", 0);
@@ -18149,9 +18187,8 @@ function attachResourceDirectoryCommands(group, config) {
       listFolders(client, config.folders, workspaceId, folderPath, options.search),
       listResources(client, config, workspaceId, folderPath, options.search, limit)
     ]);
-    const entries = entriesFor(config, folders, resources.items);
+    const entries = entriesFor(config, folders, resources);
     const shown = entries.slice(0, limit);
-    writeCursorTruncation(shown.length, resources.truncated || entries.length > limit);
     printList(profile.output, shown, COLUMNS2);
   });
   group.command("mkdir").argument("<path>", "Folder path to create; the leading / is optional").allowExcessArguments(false).description(`Create a ${config.kind} directory at a path`).action(async (path, _options, command) => {

package/package.json

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