@gravity-rail/cli 0.36.1 → 0.40.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/lib.d.ts CHANGED
@@ -139,6 +139,15 @@ declare const COL: {
139
139
  description: () => TableColumn<any>;
140
140
  enabled: () => TableColumn<any>;
141
141
  };
142
+ /**
143
+ * Print a follow-on suggestion under the result, table output only.
144
+ *
145
+ * Suppressed for json/jsonl so machine consumers get parseable output — a hint
146
+ * written to stdout would corrupt it.
147
+ */
148
+ declare function hint(opts: {
149
+ outputFormat?: string;
150
+ }, lines: string[]): void;
142
151
  /** Write a status/progress message to stderr (never pollutes stdout) */
143
152
  declare function stderr(msg: string): void;
144
153
  /**
@@ -279,6 +288,8 @@ interface CommandDef<T = unknown> {
279
288
  requiresAuth?: boolean;
280
289
  /** Whether this command mutates data. Requires --allow-write to execute. */
281
290
  mutates?: boolean;
291
+ /** Set false for commands that read a dedicated binary/CSV file argument. */
292
+ acceptsJsonInput?: boolean;
282
293
  columns?: TableColumn<T>[];
283
294
  handler: (hctx: CommandHandlerContext) => Promise<void>;
284
295
  }
@@ -445,6 +456,19 @@ interface CrudConfig<T = unknown> {
445
456
  * an options object would be misinterpreted.
446
457
  *
447
458
  * Default: `false` (safe — never forwards pagination options unless opted in).
459
+ *
460
+ * If the backend is a `PaginatedResponse` **and** the SDK method takes an
461
+ * options object `{page?, pageSize?}`, you MUST set `'full'`. Without it,
462
+ * `gr <entity> list` (and any script that shells out to it) silently returns
463
+ * page 1. The truncation notice is stderr-only; `_run_gr` discards stderr on
464
+ * success, so a scripted "complete" inventory cannot tell (#26162 / PR #26655
465
+ * — `gr workflows list` had no `--all` at all). `'full'` plus `--all` is the
466
+ * pair that makes a read page-complete.
467
+ *
468
+ * `'full'` cannot wrap a positional signature such as
469
+ * `getWorkspaceMembers(wid, page, pageSize, search, …)`: the handler would
470
+ * pass `{page, pageSize}` as the `page` argument. Convert that method to an
471
+ * options object (see `getAgents` / `getWorkflows`) before opting in.
448
472
  */
449
473
  paginationSupport?: 'full' | 'client-only' | false;
450
474
  /**
@@ -689,4 +713,4 @@ declare function organizationsListCommand(ctx: AuthenticatedContext): Promise<vo
689
713
 
690
714
  declare function whoamiCommand(ctx: AuthenticatedContext): Promise<void>;
691
715
 
692
- export { type ArgDef, AuthRequiredError, type AuthenticatedContext, CLIError, COL, type CommandContext, type CommandDef, type CommandHandlerContext, CommandRegistry, type ConciergeChat, type ConciergeMessage, type DomainDef, type GlobalOptions, type GlobalOptionsResult, type GlobalOptionsSpec, LIST_PAGINATION_ARGS, type OutputFormat, type OutputOptions, PAGINATION_ARGS, type PaginationMeta, type ParsedArgs, type ParsedGlobalOptions, type PublicGlobalOptions, type TableColumn, WORKSPACE_EXPORT_ZIP, type WorkspaceExportZipInput, authBrowserCommand, authImportDevCommand, authListCommand, authSwitchCommand, chatCommand, commandNeedsJsonBody, conciergeCommand, conciergeOutboundCommand, confirmAccountPhoneVerify, createAuthenticatedContext, createConciergeChat, createContext, createPublicAuthenticatedContext, createPublicContext, crudCommands, detectOutputFormat, devImportLocalCommand, extractPaginationMeta, fetchAllCursorPages, fetchAllPages, flushStdout, formatPaginationWarning, getConciergeChat, getConciergeChatMessages, getStartedCommand, handleError, importDevProfiles, isCursorPaginatedResponse, isDirectoryTrusted, isLikelySeedPhoneNumber, isListResult, isPagePaginatedResponse, isPaginatedResponse, isWorkspaceExportZip, listConciergeChats, listResult, loginCommand, logoutCommand, manageCommand, organizationsListCommand, originateConciergeCall, originateConciergeSms, outputData, outputSingle, parseArgs, parseGlobalOptions, parsePaginationArgs, profilesFromDevRealms, readJsonInput, registerPublicDomains, requireAuth, requireDirectoryTrust, requireNumber, requireString, resolveVoicePhoneNumberId, simpleCrudCommands, startAccountPhoneVerify, stderr, topLevelCommands, unwrapItems, waitForOutboundPhoneCallOutcome, whoamiCommand };
716
+ export { type ArgDef, AuthRequiredError, type AuthenticatedContext, CLIError, COL, type CommandContext, type CommandDef, type CommandHandlerContext, CommandRegistry, type ConciergeChat, type ConciergeMessage, type DomainDef, type GlobalOptions, type GlobalOptionsResult, type GlobalOptionsSpec, LIST_PAGINATION_ARGS, type OutputFormat, type OutputOptions, PAGINATION_ARGS, type PaginationMeta, type ParsedArgs, type ParsedGlobalOptions, type PublicGlobalOptions, type TableColumn, WORKSPACE_EXPORT_ZIP, type WorkspaceExportZipInput, authBrowserCommand, authImportDevCommand, authListCommand, authSwitchCommand, chatCommand, commandNeedsJsonBody, conciergeCommand, conciergeOutboundCommand, confirmAccountPhoneVerify, createAuthenticatedContext, createConciergeChat, createContext, createPublicAuthenticatedContext, createPublicContext, crudCommands, detectOutputFormat, devImportLocalCommand, extractPaginationMeta, fetchAllCursorPages, fetchAllPages, flushStdout, formatPaginationWarning, getConciergeChat, getConciergeChatMessages, getStartedCommand, handleError, hint, importDevProfiles, isCursorPaginatedResponse, isDirectoryTrusted, isLikelySeedPhoneNumber, isListResult, isPagePaginatedResponse, isPaginatedResponse, isWorkspaceExportZip, listConciergeChats, listResult, loginCommand, logoutCommand, manageCommand, organizationsListCommand, originateConciergeCall, originateConciergeSms, outputData, outputSingle, parseArgs, parseGlobalOptions, parsePaginationArgs, profilesFromDevRealms, readJsonInput, registerPublicDomains, requireAuth, requireDirectoryTrust, requireNumber, requireString, resolveVoicePhoneNumberId, simpleCrudCommands, startAccountPhoneVerify, stderr, topLevelCommands, unwrapItems, waitForOutboundPhoneCallOutcome, whoamiCommand };