@thecorporation/corp-tools 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,152 @@
+interface CorpConfig {
+    api_url: string;
+    api_key: string;
+    workspace_id: string;
+    hosting_mode: string;
+    llm: {
+        provider: string;
+        api_key: string;
+        model: string;
+        base_url?: string;
+    };
+    user: {
+        name: string;
+        email: string;
+    };
+    active_entity_id: string;
+    [key: string]: unknown;
+}
+interface ToolCall {
+    id: string;
+    name: string;
+    arguments: Record<string, unknown>;
+}
+interface LLMResponse {
+    content: string | null;
+    tool_calls: ToolCall[];
+    usage: {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+    };
+    finish_reason: string | null;
+}
+type ApiRecord = Record<string, unknown>;
+
+declare class SessionExpiredError extends Error {
+    constructor();
+}
+declare function provisionWorkspace(apiUrl: string, name?: string): Promise<ApiRecord>;
+declare class CorpAPIClient {
+    readonly apiUrl: string;
+    readonly apiKey: string;
+    readonly workspaceId: string;
+    constructor(apiUrl: string, apiKey: string, workspaceId: string);
+    private headers;
+    private request;
+    private get;
+    private post;
+    private patch;
+    private del;
+    getStatus(): Promise<ApiRecord>;
+    getObligations(tier?: string): Promise<ApiRecord>;
+    listDigests(): Promise<ApiRecord[]>;
+    triggerDigest(): Promise<ApiRecord>;
+    getDigest(key: string): Promise<ApiRecord>;
+    listEntities(): Promise<ApiRecord[]>;
+    listContacts(): Promise<ApiRecord[]>;
+    getContact(id: string): Promise<ApiRecord>;
+    getContactProfile(id: string): Promise<ApiRecord>;
+    createContact(data: ApiRecord): Promise<ApiRecord>;
+    updateContact(id: string, data: ApiRecord): Promise<ApiRecord>;
+    getNotificationPrefs(contactId: string): Promise<ApiRecord>;
+    updateNotificationPrefs(contactId: string, prefs: ApiRecord): Promise<ApiRecord>;
+    getCapTable(entityId: string): Promise<ApiRecord>;
+    getSafeNotes(entityId: string): Promise<ApiRecord[]>;
+    getShareTransfers(entityId: string): Promise<ApiRecord[]>;
+    getValuations(entityId: string): Promise<ApiRecord[]>;
+    getCurrent409a(entityId: string): Promise<ApiRecord>;
+    issueEquity(data: ApiRecord): Promise<ApiRecord>;
+    issueSafe(data: ApiRecord): Promise<ApiRecord>;
+    transferShares(data: ApiRecord): Promise<ApiRecord>;
+    calculateDistribution(data: ApiRecord): Promise<ApiRecord>;
+    listGovernanceBodies(entityId: string): Promise<ApiRecord[]>;
+    getGovernanceSeats(bodyId: string): Promise<ApiRecord[]>;
+    listMeetings(bodyId: string): Promise<ApiRecord[]>;
+    getMeetingResolutions(meetingId: string): Promise<ApiRecord[]>;
+    conveneMeeting(data: ApiRecord): Promise<ApiRecord>;
+    castVote(meetingId: string, itemId: string, data: ApiRecord): Promise<ApiRecord>;
+    getEntityDocuments(entityId: string): Promise<ApiRecord[]>;
+    generateContract(data: ApiRecord): Promise<ApiRecord>;
+    getSigningLink(documentId: string): ApiRecord;
+    createInvoice(data: ApiRecord): Promise<ApiRecord>;
+    runPayroll(data: ApiRecord): Promise<ApiRecord>;
+    submitPayment(data: ApiRecord): Promise<ApiRecord>;
+    openBankAccount(data: ApiRecord): Promise<ApiRecord>;
+    classifyContractor(data: ApiRecord): Promise<ApiRecord>;
+    reconcileLedger(data: ApiRecord): Promise<ApiRecord>;
+    fileTaxDocument(data: ApiRecord): Promise<ApiRecord>;
+    trackDeadline(data: ApiRecord): Promise<ApiRecord>;
+    getBillingStatus(): Promise<ApiRecord>;
+    getBillingPlans(): Promise<ApiRecord[]>;
+    createBillingPortal(): Promise<ApiRecord>;
+    createBillingCheckout(tier: string, entityId?: string): Promise<ApiRecord>;
+    getFormation(id: string): Promise<ApiRecord>;
+    getFormationDocuments(id: string): Promise<ApiRecord[]>;
+    createFormation(data: ApiRecord): Promise<ApiRecord>;
+    getHumanObligations(): Promise<ApiRecord[]>;
+    getSignerToken(obligationId: string): Promise<ApiRecord>;
+    seedDemo(name: string): Promise<ApiRecord>;
+    convertEntity(entityId: string, data: ApiRecord): Promise<ApiRecord>;
+    dissolveEntity(entityId: string, data: ApiRecord): Promise<ApiRecord>;
+    listAgents(): Promise<ApiRecord[]>;
+    getAgent(id: string): Promise<ApiRecord>;
+    createAgent(data: ApiRecord): Promise<ApiRecord>;
+    updateAgent(id: string, data: ApiRecord): Promise<ApiRecord>;
+    deleteAgent(id: string): Promise<void>;
+    sendAgentMessage(id: string, body: string): Promise<ApiRecord>;
+    listAgentExecutions(id: string): Promise<ApiRecord[]>;
+    getAgentUsage(id: string): Promise<ApiRecord>;
+    addAgentSkill(id: string, data: ApiRecord): Promise<ApiRecord>;
+    listSupportedModels(): Promise<ApiRecord[]>;
+    listPendingApprovals(): Promise<ApiRecord[]>;
+    respondApproval(id: string, decision: string, message?: string): Promise<ApiRecord>;
+    listApiKeys(): Promise<ApiRecord[]>;
+    assignObligation(obligationId: string, contactId: string): Promise<ApiRecord>;
+    getConfig(): Promise<ApiRecord>;
+    createLink(): Promise<ApiRecord>;
+}
+
+interface ToolContext {
+    dataDir: string;
+    onEntityFormed?: (entityId: string) => void;
+}
+declare const TOOL_DEFINITIONS: Record<string, unknown>[];
+declare function isWriteTool(name: string): boolean;
+declare function executeTool(name: string, args: Record<string, unknown>, client: CorpAPIClient, ctx: ToolContext): Promise<string>;
+
+declare function describeToolCall(name: string, args: Record<string, unknown>): string;
+
+/**
+ * System prompt base and config formatter.
+ */
+declare const SYSTEM_PROMPT_BASE = "You are a corporate governance assistant for TheCorporation, an agentic corporate governance platform.\n\n## Context\n{context}\n\n## Capabilities\nYou can perform the full range of corporate operations:\n\n**Read operations:**\n- View workspace status, entities, cap tables, documents\n- List SAFE notes, equity grants, agents\n- Check deadlines and compliance status\n\n**Write operations:**\n- Form new LLCs and corporations in any US jurisdiction\n- Issue equity (common, preferred, options, units)\n- Issue SAFE notes to investors\n- Transfer shares between holders\n- Convert entities (LLC <> Corporation)\n- Create invoices, run payroll, submit payments\n- Open bank accounts, reconcile ledgers\n- Generate contracts (NDAs, employment offers, consulting agreements)\n- File tax documents (1099-NEC, K-1, 941, W-2, estimated tax)\n- Generate signing links for documents (human-only signing)\n- Track compliance deadlines\n- Classify contractor risk (employee vs 1099)\n- Convene governance meetings and cast votes\n- Dissolve entities with full wind-down workflow\n\n## Rules\n- All monetary values are in integer cents ($1,000 = 100000).\n- Be concise and helpful.\n- **You MUST confirm with the user before calling ANY write tool.** Describe what you are about to do and wait for explicit approval. Never execute tools speculatively or \"on behalf of\" the user without their go-ahead.\n- Don't ask for info available in platform config \u2014 use the correct values automatically.\n- If only one option exists for a field, use it without asking.\n- Don't make up data \u2014 only present what the tools return.\n- If a tool returns an error, explain it simply without exposing raw error details.\n- NEVER create an agent to answer a question you can answer yourself. You are the assistant \u2014 answer questions directly using your knowledge and the read tools.\n\n## Agent Rules\n- Agents are for **delegating recurring corporate operations tasks** that the user explicitly requests \u2014 e.g. \"process incoming invoices\", \"monitor compliance deadlines\", \"handle payroll every two weeks\".\n- Agents are NOT for research, answering questions, or one-off lookups. If the user asks a question, YOU answer it.\n- NEVER proactively suggest or create an agent unless the user specifically asks for one.\n- Agent tools require a paid plan.\n\n## Entity Formation Rules\n- When forming an entity, you MUST ask about all founding members and their ownership allocations BEFORE calling the form_entity tool.\n- For LLCs, ownership percentages must total 100%.\n\n## Document Signing Rules\n- You CANNOT sign documents on behalf of users. Signing is a human action.\n- Use `get_signing_link` to generate a signing URL for a document.\n- Present the signing link so users can open it and sign themselves.\n- NEVER attempt to sign, execute, or complete signature actions automatically.\n- The `get_signing_link` tool does NOT sign anything \u2014 it only returns a URL.\n\n## User Journey\nAfter completing any action, ALWAYS present the logical next step(s) as a\nnumbered list. The user should never wonder \"what now?\" \u2014 guide them forward.\n\nAfter entity formation:\n1. The `form_entity` response includes a `documents` array with document IDs. These documents are created immediately \u2014 they are NEVER \"still being generated\" or delayed.\n2. Immediately call `get_signing_link` for each document ID in the response to get signing URLs.\n3. Present the signing links to the user right away. Do NOT tell the user to \"check back later\" or that documents are \"being prepared\" \u2014 they already exist.\n4. Then: \"Documents signed! Next: apply for an EIN, open a bank account, or issue equity.\"\n\nAfter document generation:\n1. Present signing links immediately \u2014 don't wait for the user to ask.\n2. Use the document IDs from the tool response \u2014 do NOT call `list_documents` to re-fetch them.\n\nAfter signing:\n1. \"Documents are signed! Next: file for EIN, open a bank account, or add team members.\"\n\nAfter equity issuance:\n1. \"Equity issued! Next: generate the stock certificate for signing, or issue more grants.\"\n\nGeneral pattern:\n- Always end with 1-2 concrete next actions the user can take.\n- Phrase them as questions or suggestions: \"Would you like to [next step]?\"\n- If there are signing obligations, proactively generate and present the signing links.\n- Never just say \"done\" \u2014 always show what comes next.\n\nAfter major actions, use update_checklist to track progress. Use markdown checkbox\nformat (- [x] / - [ ]). Call get_checklist first to see current state, then\nupdate_checklist with checked-off items. This helps users see where they are.\n\n{extra_sections}";
+declare function formatConfigSection(cfgData: Record<string, unknown>): string;
+
+declare const GENERATED_TOOL_DEFINITIONS: Record<string, unknown>[];
+
+/**
+ * Tool registry and classification helpers.
+ * Re-exports from existing modules + builds a registry from generated defs.
+ */
+
+interface ToolFunction {
+    name: string;
+    description: string;
+    parameters: Record<string, unknown>;
+}
+/** Registry: tool name → function metadata (description + parameters). */
+declare const TOOL_REGISTRY: Record<string, ToolFunction>;
+declare const READ_ONLY_TOOLS: Set<string>;
+
+export { type ApiRecord, CorpAPIClient, type CorpConfig, GENERATED_TOOL_DEFINITIONS, type LLMResponse, READ_ONLY_TOOLS, SYSTEM_PROMPT_BASE, SessionExpiredError, TOOL_DEFINITIONS, TOOL_REGISTRY, type ToolCall, type ToolContext, describeToolCall, executeTool, formatConfigSection, isWriteTool, provisionWorkspace };