@delegance/cli 0.2.0

package/dist/index.d.ts

@@ -0,0 +1,300 @@
+import { Command } from 'commander';
+import Conf from 'conf';
+
+/**
+ * Authentication commands for the Delegance CLI
+ *
+ *   auth login            browser login: approve this terminal in the portal (default)
+ *   auth login --key K    store a key created in the portal
+ *   auth login --paste    prompt for a key instead of opening the browser
+ *   auth status           the stored key, where it lives, and when it expires
+ *   auth refresh          extend a CLI key to 90 days from now
+ *   auth logout / whoami
+ *
+ * Keys live only in ~/.delegance/credentials (0600); config.json keeps a
+ * masked hint (spec 2026-09-24-cli-auth-hardening).
+ */
+
+declare function createAuthCommand(): Command;
+
+/**
+ * Company commands for the Delegance CLI
+ */
+
+declare function createCompanyCommand(): Command;
+
+/**
+ * Document commands for the Delegance CLI
+ */
+
+declare function createDocumentCommand(): Command;
+
+/**
+ * Chat commands for the Delegance CLI
+ *
+ * Interact with the Orin insurance assistant.
+ */
+
+declare function createChatCommand(): Command;
+
+/**
+ * Quote commands for the Delegance CLI
+ *
+ * Request and manage insurance quotes.
+ */
+
+declare function createQuoteCommand(): Command;
+
+/**
+ * Policy commands for the Delegance CLI
+ *
+ * Manage insurance policies.
+ */
+
+declare function createPolicyCommand(): Command;
+
+/**
+ * COI commands for the Delegance CLI
+ *
+ * Generate and manage Certificates of Insurance.
+ */
+
+declare function createCOICommand(): Command;
+
+/**
+ * SOV commands for the Delegance CLI
+ *
+ * Manage Schedules of Values for commercial property insurance.
+ */
+
+declare function createSOVCommand(): Command;
+
+/**
+ * Appetite commands for the Delegance CLI
+ *
+ * Which carriers will write a risk. Needs an API key with the
+ * `appetite:read` scope; `read` and `write` do not include it.
+ */
+
+declare function createAppetiteCommand(): Command;
+
+/**
+ * Lead commands for the Delegance CLI
+ *
+ * Send a prospect business to Delegance. Needs the `write` scope.
+ */
+
+declare function createLeadCommand(): Command;
+
+/**
+ * Knowledge commands for the Delegance CLI
+ *
+ * Search the company's notecards and document chunks, list notecards, and
+ * read the structured facts extracted from one document.
+ */
+
+declare function createKnowledgeCommand(): Command;
+
+/**
+ * Onboarding commands for the Delegance CLI
+ *
+ * Read the account's setup checklist and onboarding state, send the email
+ * verification challenge, and wait for a target state.
+ */
+
+declare function createOnboardingCommand(): Command;
+
+/**
+ * Usage commands for the Delegance CLI
+ *
+ * Billing-period summary, daily metered usage, and rate-limit headroom.
+ */
+
+declare function createUsageCommand(): Command;
+
+/**
+ * API key commands for the Delegance CLI
+ *
+ * create and list work with an API key that carries `admin` (create) or
+ * `read` (list). Revoking needs a portal session today, and the server has
+ * no rotate route, so `rotate` creates a replacement key with the same
+ * scopes and tells you where to revoke the old one.
+ */
+
+declare function createKeysCommand(): Command;
+
+/**
+ * Config commands for the Delegance CLI
+ *
+ * Manage CLI configuration and profiles.
+ */
+
+declare function createConfigCommand(): Command;
+
+/**
+ * Builds the `delegance` command tree. The bin entry parses argv against it;
+ * tests inspect it without running any command.
+ */
+
+declare function createProgram(): Command;
+
+/** Kept equal to package.json "version"; a unit test fails on drift. */
+declare const CLI_VERSION = "0.2.0";
+
+/**
+ * Configuration management for the Delegance CLI
+ *
+ * Two files:
+ *   - the conf store (config.json, mode 0600): base URL, default company,
+ *     output format, and a MASKED hint of the key. Never the key itself.
+ *   - ~/.delegance/credentials (mode 0600, directory 0700): the API key, and
+ *     nothing else.
+ *
+ * CLI versions before 0.2.0 also wrote the full key into config.json at the
+ * default mode. migrateLegacyConfigKey() moves such a key into the
+ * credentials file on the next run (spec 2026-09-24-cli-auth-hardening D1).
+ */
+
+interface CLIConfig {
+    /** Legacy only: older CLIs wrote the full key here. Read by the migration, never written. */
+    apiKey?: string;
+    /** Masked key for display: prefix plus the last 4 characters. */
+    apiKeyHint?: string;
+    /** Last known expiry of the stored key (ISO), from login, refresh, or status. */
+    apiKeyExpiresAt?: string;
+    baseUrl?: string;
+    defaultCompanyId?: string;
+    outputFormat?: 'table' | 'json' | 'yaml';
+}
+/**
+ * Get the config store instance
+ */
+declare function getConfig(): Conf<CLIConfig>;
+/**
+ * Set a configuration value
+ */
+declare function setConfig<K extends keyof CLIConfig>(key: K, value: CLIConfig[K]): void;
+/**
+ * Get all configuration values
+ */
+declare function getAllConfig(): CLIConfig;
+/**
+ * Clear all configuration
+ */
+declare function clearConfig(): void;
+/**
+ * Get the config file path
+ */
+declare function getConfigPath(): string;
+/**
+ * Store the API key: the key goes ONLY to ~/.delegance/credentials (0600);
+ * config.json keeps a masked hint and the expiry when known.
+ */
+declare function storeApiKey(apiKey: string, meta?: {
+    expiresAt?: string | null;
+}): void;
+/**
+ * Get stored API key
+ */
+declare function getApiKey(): string | undefined;
+/**
+ * Check if user is authenticated
+ */
+declare function isAuthenticated(): boolean;
+/**
+ * Clear stored credentials
+ */
+declare function clearCredentials(): void;
+/**
+ * Get base URL for API calls
+ */
+declare function getBaseUrl(): string;
+/**
+ * Mask an API key for display
+ */
+declare function maskApiKey(apiKey: string): string;
+
+/**
+ * Output utilities for the Delegance CLI
+ */
+type OutputFormat = 'table' | 'json' | 'yaml';
+/**
+ * Print a success message
+ */
+declare function success(message: string): void;
+/**
+ * Print an error message
+ */
+declare function error(message: string, details?: string): void;
+/**
+ * Print a warning message
+ */
+declare function warn(message: string): void;
+/**
+ * Print an info message
+ */
+declare function info(message: string): void;
+/**
+ * Print a debug message (only in verbose mode)
+ */
+declare function debug(message: string): void;
+/**
+ * Print a header
+ */
+declare function header(text: string): void;
+/**
+ * Print key-value pairs
+ * Supports both object format and key/value arguments
+ */
+declare function keyValue(keyOrData: string | Record<string, unknown>, value?: unknown): void;
+/**
+ * Print a table
+ */
+declare function table(headers: string[], rows: (string | number | null | undefined)[][], options?: {
+    compact?: boolean;
+}): void;
+/**
+ * Print data as JSON
+ */
+declare function json(data: unknown): void;
+/**
+ * Print data based on format
+ */
+declare function output(data: unknown, format?: OutputFormat): void;
+/**
+ * Format a date for display
+ */
+declare function formatDate(dateStr: string | Date | undefined): string;
+/**
+ * Format file size for display
+ */
+declare function formatFileSize(bytes: number | undefined): string;
+/**
+ * Format document status with color
+ */
+declare function formatStatus(status: string): string;
+/**
+ * Format currency for display
+ */
+declare function formatCurrency(amount: number | undefined | null): string;
+
+type output$1_OutputFormat = OutputFormat;
+declare const output$1_debug: typeof debug;
+declare const output$1_error: typeof error;
+declare const output$1_formatCurrency: typeof formatCurrency;
+declare const output$1_formatDate: typeof formatDate;
+declare const output$1_formatFileSize: typeof formatFileSize;
+declare const output$1_formatStatus: typeof formatStatus;
+declare const output$1_header: typeof header;
+declare const output$1_info: typeof info;
+declare const output$1_json: typeof json;
+declare const output$1_keyValue: typeof keyValue;
+declare const output$1_output: typeof output;
+declare const output$1_success: typeof success;
+declare const output$1_table: typeof table;
+declare const output$1_warn: typeof warn;
+declare namespace output$1 {
+  export { type output$1_OutputFormat as OutputFormat, output$1_debug as debug, output$1_error as error, output$1_formatCurrency as formatCurrency, output$1_formatDate as formatDate, output$1_formatFileSize as formatFileSize, output$1_formatStatus as formatStatus, output$1_header as header, output$1_info as info, output$1_json as json, output$1_keyValue as keyValue, output$1_output as output, output$1_success as success, output$1_table as table, output$1_warn as warn };
+}
+
+export { CLI_VERSION, clearConfig, clearCredentials, createAppetiteCommand, createAuthCommand, createCOICommand, createChatCommand, createCompanyCommand, createConfigCommand, createDocumentCommand, createKeysCommand, createKnowledgeCommand, createLeadCommand, createOnboardingCommand, createPolicyCommand, createProgram, createQuoteCommand, createSOVCommand, createUsageCommand, getAllConfig, getApiKey, getBaseUrl, getConfig, getConfigPath, isAuthenticated, maskApiKey, output$1 as output, setConfig, storeApiKey };