@bbigbang/cli 0.1.0

package/dist/cliSupport.d.ts

@@ -0,0 +1,166 @@
+import { Command } from 'commander';
+import { AGENT_COMMAND_ERROR_CODES, AgentApiClient, AgentCommandError, formatBigbangReceipt, formatMessageHeld, formatPanelVersionConflict, formatTaskHeld, readOptionalStdin, readRequiredJsonStdin, readRequiredStdin, toAgentCommandError, type AgentApiResponse, type AgentApiRetryMode, type AgentCommandContext, type AgentCommandEnv, type StdinLike } from '@bbigbang/agent-command';
+export type BigbangOutputFormat = 'text' | 'json';
+export interface BigbangIo {
+    stdin: StdinLike;
+    stdout: Pick<NodeJS.WriteStream, 'write'>;
+    stderr: Pick<NodeJS.WriteStream, 'write'>;
+}
+export interface BuildBigbangProgramOptions {
+    env?: AgentCommandEnv;
+    readFile?: (path: string) => string;
+    fetch?: typeof fetch;
+    sleep?: (ms: number) => Promise<void>;
+    io?: BigbangIo;
+}
+export interface Runtime {
+    context: AgentCommandContext;
+    runId?: string;
+    turnId?: string;
+    traceId?: string;
+    client: AgentApiClient;
+    fetch: typeof fetch;
+    env: AgentCommandEnv;
+    sleep: (ms: number) => Promise<void>;
+    readFile: (path: string) => string;
+    io: BigbangIo;
+    outputFormat: BigbangOutputFormat;
+}
+export declare const MANUAL_TOPICS: readonly ["index", "cli-overview", "examples", "commands"];
+export type ManualTopic = (typeof MANUAL_TOPICS)[number];
+export declare const MANUAL_TOPICS_DIR: string;
+export declare const MANUAL_GENERATED_DIR: string;
+export declare function manualTopicPath(topic: string): string;
+export declare function commandCatalogPath(): string;
+export declare function readManualTopic(runtime: Runtime, topic: string): string;
+export declare function readCommandCatalog(runtime: Runtime): unknown;
+export declare function isManualTopic(topic: string): topic is ManualTopic;
+export declare const ATTACHMENT_UPLOAD_MAX_BYTES: number;
+export declare const ATTACHMENT_TEXT_PREVIEW_MAX_CHARS = 4000;
+export declare const MUTATION_HINTS: {
+    readonly messageSend: "Next: run `bigbang message check` for replies.";
+    readonly taskCreate: "Next: run `bigbang task list` to review created tasks.";
+    readonly taskClaim: "Next: run `bigbang task update --status in_progress` to start work.";
+    readonly panelInspect: "Next: run `bigbang panel read-rows --panel-id <id>` to inspect.";
+    readonly toolPublish: "Next: run `bigbang tool status --tool-id <id>` to verify.";
+    readonly attachmentUpload: "Next: run `bigbang message send --attachment-id <id>` to share it.";
+    readonly actionPrepare: "Next: wait for a human admin to confirm or cancel the action card.";
+};
+export declare function withHint(text: string, hint: string): string;
+export declare const MIME_BY_EXTENSION: Record<string, string>;
+export declare function defaultIo(): BigbangIo;
+export declare function parseOutputFormat(raw: unknown): BigbangOutputFormat;
+export declare function writeOutput(runtime: Runtime, text: string, data: unknown): void;
+export declare function writeJson(runtime: Runtime, data: unknown): void;
+export declare function writeReceipt(runtime: Runtime, receipt: Parameters<typeof formatBigbangReceipt>[0]): void;
+export declare function createRuntime(program: Command, options: BuildBigbangProgramOptions): Runtime;
+export declare function repeatOption(value: string, previous?: string[]): string[];
+export declare function parsePositiveInteger(name: string, raw: unknown): number | undefined;
+export declare function parseRequiredPositiveInteger(name: string, raw: unknown): number;
+export declare function parsePositiveIntegerList(name: string, raw: unknown): number[] | undefined;
+export declare function parseNumber(name: string, raw: unknown): number | undefined;
+export declare function parseRequiredNumber(name: string, raw: unknown): number;
+export declare function parseNonNegativeInteger(name: string, raw: unknown): number | undefined;
+export declare function requireString(value: unknown, flag: string): string;
+export declare function requireConversationId(runtime: Runtime, commandName: string): string;
+export declare function responseError(response: AgentApiResponse, fallback: string): AgentCommandError;
+export declare function buildCoreUrl(runtime: Runtime, path: string): string;
+export declare function fetchJsonRaw(runtime: Runtime, path: string, init?: RequestInit, options?: {
+    retry?: AgentApiRetryMode;
+}): Promise<AgentApiResponse>;
+export declare function fetchBinaryRaw(runtime: Runtime, path: string, options?: {
+    retry?: AgentApiRetryMode;
+}): Promise<{
+    ok: true;
+    status: number;
+    buffer: Buffer;
+    contentType: string;
+} | {
+    ok: false;
+    status: number;
+    error: string;
+}>;
+export declare function isHeldResponse(data: unknown): boolean;
+export declare function isSuppressedResponse(data: unknown): boolean;
+export declare function isVersionConflict(response: AgentApiResponse): boolean;
+export declare function isMessageNotResolved(response: AgentApiResponse): boolean;
+export declare function appendCommonBody(runtime: Runtime, body: Record<string, unknown>): Record<string, unknown>;
+export declare function appendRunContextParams(runtime: Runtime, params: URLSearchParams): URLSearchParams;
+export declare function parseJsonStdinOrThrow<T>(runtime: Runtime, label: string): Promise<T>;
+export declare function parseJsonStringOrThrow<T>(content: string, label: string): T;
+export declare function parseJsonObjectStringOrThrow(content: string, label: string): Record<string, unknown>;
+export declare function normalizeExpectedVersion(payload: Record<string, unknown>): Record<string, unknown>;
+export declare function normalizePanelPayload(payload: Record<string, unknown>, commandName: string): Record<string, unknown>;
+export declare function summarizePanelState(data: unknown): string;
+export declare function summarizePanelCollaborators(data: unknown): string;
+export declare function summarizeSkillList(data: unknown): string;
+export declare function summarizeSkillFile(data: unknown): string;
+export declare function normalizeAgentTaskStatus(raw: unknown): 'todo' | 'in_progress' | 'in_review';
+export declare function normalizeTaskListStatus(raw: unknown): 'all' | 'todo' | 'in_progress' | 'in_review' | 'done';
+export declare function normalizeTaskScope(raw: unknown): 'all' | 'dm' | 'channel';
+export declare function summarizeTaskIdentity(task: Record<string, unknown> | null | undefined): string;
+export declare function summarizeTaskSource(task: Record<string, unknown>): string;
+export declare function summarizeTaskList(data: unknown, emptyText: string): string;
+export declare function summarizeTaskLookup(data: unknown): string;
+export declare function formatTaskHistoryEvent(event: Record<string, unknown>): string;
+export declare function summarizeTaskHistory(data: unknown): string;
+export declare function summarizeClaimResults(data: unknown): string;
+export declare function normalizeReminderScheduleKind(raw: unknown): 'one_time' | 'recurring';
+export declare function normalizeOptionalReminderScheduleKind(raw: unknown): 'one_time' | 'recurring' | undefined;
+export declare function normalizeReminderIntervalUnit(raw: unknown): 'hour' | 'day' | 'week' | undefined;
+export declare function parseSnoozeDuration(raw: unknown): {
+    until: number;
+    durationMs: number;
+};
+export declare function summarizeTimestamp(raw: unknown): string;
+export declare function summarizeReminder(reminder: Record<string, unknown>): string;
+export declare function summarizeReminderList(data: unknown): string;
+export declare function summarizeOccurrence(label: string, occurrence: Record<string, unknown> | null | undefined): string;
+export declare function summarizeReminderOccurrences(data: unknown): string;
+export declare function summarizeReminderCurrent(data: unknown): string;
+export declare function summarizeReminderAction(action: string, data: unknown, fallbackId?: string): string;
+export declare function summarizeActionPrepare(data: unknown): string;
+export declare function summarizeReminderLog(reminderId: string, data: unknown): string;
+export declare function summarizeReminderSnooze(data: unknown): string;
+export declare function summarizeWorkspaceInspect(data: unknown): string;
+export declare function summarizeWorkspaceTree(data: unknown): string;
+export declare function summarizeWorkspaceFile(data: unknown): string;
+export declare function summarizeToolState(state: unknown): string;
+export declare function summarizeToolRun(run: Record<string, unknown> | null | undefined): string;
+export declare function summarizeToolStatus(data: unknown): string;
+export declare function summarizeToolPublish(data: unknown): string;
+export declare function summarizeToolVerification(data: unknown): string;
+export declare function summarizeToolValidate(data: unknown): string;
+export declare function summarizeToolAction(data: unknown, fallbackActionId: string): string;
+export declare function inferMimeType(filePath: string): string;
+export declare function formatSize(bytes: number): string;
+export declare function isTextLikeMimeType(mimeType: string): boolean;
+export declare function isTextLikeAttachment(mimeType: string, metadata: Record<string, unknown>, filename: string): boolean;
+export declare function summarizeAttachmentUpload(data: unknown): string;
+export declare function summarizeAttachmentView(params: {
+    attachmentId: string;
+    metadata: Record<string, unknown>;
+    buffer: Buffer;
+    contentType: string;
+}): {
+    text: string;
+    data: unknown;
+};
+export declare function summarizeAttachmentComments(attachmentId: string, data: unknown): string;
+export declare function summarizeServerDirectory(data: unknown): string;
+export declare function summarizeInboxCheck(data: unknown): string;
+export declare function summarizeInboxWait(data: unknown): string;
+export declare function summarizeSelfState(data: unknown): string;
+export declare function summarizeRuntimePresence(data: unknown): string;
+export declare function summarizeConversationList(data: unknown): string;
+export declare function summarizeConversationSummary(data: unknown): string;
+export declare function summarizeContextBundle(data: unknown): string;
+export declare function summarizeHeldMessageDrafts(data: unknown): string;
+export declare function summarizeHandoffCreate(data: unknown): string;
+export declare function summarizeHandoffStatus(data: unknown): string;
+export declare function summarizePanelComponents(data: unknown): string;
+export declare function summarizeChannelMembers(data: unknown): string;
+export declare function summarizeChannelMutation(data: unknown, verb: 'joined' | 'left'): string;
+export declare function summarizeThreadUnfollow(data: unknown): string;
+export declare function appendReminderConversation(runtime: Runtime, commandName: string, body?: Record<string, unknown>): Record<string, unknown>;
+export { AGENT_COMMAND_ERROR_CODES, AgentCommandError, formatMessageHeld, formatPanelVersionConflict, formatTaskHeld, readOptionalStdin, readRequiredJsonStdin, readRequiredStdin, toAgentCommandError, };