index.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *--------------------------------------------------------------------------------------------*/

/**
 * Copilot SDK - TypeScript/Node.js Client
 *
 * JSON-RPC based SDK for programmatic control of GitHub Copilot CLI
 */

export { CopilotClient } from "./client.js";
export { RuntimeConnection } from "./types.js";
export { BuiltInTools, ToolSet } from "./toolSet.js";
export { CopilotSession, type AssistantMessageEvent } from "./session.js";
export { defineFactory, FactoryResumeError, isFactoryRunTerminal } from "./factory.js";
export {
    Canvas,
    CanvasError,
    createCanvas,
    type CanvasAction,
    type CanvasDeclaration,
    type CanvasHostContext,
    type CanvasHostContextCapabilities,
    type CanvasJsonSchema,
    type CanvasOptions,
} from "./canvas.js";
export {
    defineTool,
    approveAll,
    createAttributedPermissionResult,
    convertMcpCallToolResult,
    createSessionFsAdapter,
    CopilotRequestHandler,
    CopilotWebSocketHandler,
    CopilotWebSocketCloseStatus,
    CopilotWebSocketForwarder,
    SessionFsSqliteTransactionFailure,
    SYSTEM_MESSAGE_SECTIONS,
} from "./types.js";
// Re-export the generated session-event types (every *Event interface and
// its corresponding *Data payload type, plus supporting unions/aliases) so
// consumers can import them directly from "@github/copilot-sdk" instead of
// reaching into the package's internal dist layout. See issue #1156.
//
// Six names from this file are also explicitly exported elsewhere in this
// module — `SessionEvent` (re-exported below from `./types.js`),
// `PermissionRequest` (re-exported below from `./types.js`),
// `PermissionRequestedData`/`PermissionRequestedEvent` (also re-exported below
// from `./types.js`), `AssistantMessageEvent` (re-exported above from
// `./session.js`), and `JsonValue` (re-exported below from `./factory.js`).
// Per the ECMAScript module spec, the explicit named re-exports
// shadow the names arriving via `export type *`, so the hand-authored public API
// surface for those six identifiers is preserved unchanged.
export type * from "./generated/session-events.js";
export type {
    CommandContext,
    CommandDefinition,
    CommandHandler,
    CanvasProviderIdentity,
    CloudSessionOptions,
    CloudSessionRepository,
    AutoModeSwitchHandler,
    AutoModeSwitchRequest,
    AutoModeSwitchResponse,
    AgentStopHandler,
    AgentStopHookInput,
    AgentStopHookOutput,
    UserPromptTransformedHandler,
    UserPromptTransformedHookInput,
    UserPromptTransformedHookOutput,
    CopilotClientMode,
    CopilotClientOptions,
    CopilotExpAssignmentResponse,
    StdioRuntimeConnection,
    InProcessRuntimeConnection,
    TcpRuntimeConnection,
    UriRuntimeConnection,
    ChildProcessRuntimeConnection,
    CustomAgentConfig,
    ElicitationFieldValue,
    ElicitationHandler,
    ElicitationParams,
    ElicitationContext,
    ElicitationResult,
    ElicitationSchema,
    ElicitationSchemaField,
    ExpConfigEntry,
    ExpFlagValue,
    ExitPlanModeHandler,
    ExitPlanModeRequest,
    ExitPlanModeResult,
    ExtensionInfo,
    ForegroundSessionInfo,
    GetAuthStatusResponse,
    GetStatusResponse,
    GitHubMcpToolConfig,
    GitHubTelemetryNotification,
    GitHubTelemetryEvent,
    GitHubTelemetryClientInfo,
    InfiniteSessionConfig,
    LargeToolOutputConfig,
    MemoryConfiguration,
    UiInputOptions,
    FactoryLimits,
    FactoryMeta,
    MCPStdioServerConfig,
    MCPHTTPServerConfig,
    MCPServerConfig,
    DefaultAgentConfig,
    BearerTokenProvider,
    MessageOptions,
    ManagedSettings,
    ManagedSettingsPermissions,
    ModelBilling,
    ModelBillingTokenPrices,
    ModelBillingTokenPricesLongContext,
    CapiSessionOptions,
    ModelCapabilities,
    ModelCapabilitiesOverride,
    ModelInfo,
    ModelPolicy,
    NamedProviderConfig,
    PermissionHandler,
    PermissionRequest,
    PermissionRequestedData,
    PermissionRequestedEvent,
    PermissionRequestResult,
    AttributedPermissionResult,
    PermissionDecisionContext,
    PermissionDecisionOutcome,
    PermissionDecisionSource,
    PermissionDecisionSurface,
    ProviderConfig,
    ProviderModelConfig,
    ProviderTokenArgs,
    RemoteSessionMode,
    ResumeSessionConfig,
    SectionOverride,
    SectionOverrideAction,
    SectionTransformFn,
    SessionCapabilities,
    SessionConfig,
    SessionConfigBase,
    SessionEvent,
    SessionEventHandler,
    SessionEventPayload,
    SessionEventType,
    SessionLifecycleEvent,
    SessionLifecycleEventMetadata,
    SessionLifecycleEventType,
    SessionLifecycleHandler,
    SessionHooks,
    SessionCreatedEvent,
    SessionDeletedEvent,
    SessionUpdatedEvent,
    SessionForegroundEvent,
    SessionBackgroundEvent,
    SessionContext,
    SessionListFilter,
    SessionMetadata,
    SessionUiApi,
    SessionFsConfig,
    SessionFsProvider,
    SessionFsFileInfo,
    SessionFsSqliteQueryResult,
    SessionFsSqliteQueryType,
    SessionFsSqliteProvider,
    SessionFsSqliteStatement,
    SessionFsSqliteTransactionErrorClass,
    CopilotRequestContext,
    SystemMessageAppendConfig,
    SystemMessageConfig,
    SystemMessageCustomizeConfig,
    SystemMessageReplaceConfig,
    SystemMessageSection,
    TelemetryConfig,
    TraceContext,
    TraceContextProvider,
    Tool,
    ToolHandler,
    ToolInvocation,
    CurrentToolMetadata,
    ToolTelemetry,
    ToolResultObject,
    ToolSearchConfig,
    TypedSessionEventHandler,
    TypedSessionLifecycleHandler,
    ZodSchema,
} from "./types.js";
export type {
    RunOptions,
    ResumeOptions,
    FactoryResumeErrorCode,
    SessionFactoryApi,
    FactoryAgentOptions,
    FactoryContext,
    FactoryDefinition,
    FactoryHandle,
    FactoryJsonSchema,
    JsonValue,
    FactoryPipelineStage,
    FactoryStepOptions,
    FactoryRunResult,
    FactoryRunStatus,
    FactoryRunSummary,
    FactoryRunDetail,
    FactoryProgressPage,
    FactoryProgressLine,
    FactoryPhaseObservation,
    FactoryPhaseStatus,
    FactoryAgentSummary,
} from "./factory.js";