@plmbr/notebook-intelligence 5.0.0

package/lib/api.d.ts

@@ -0,0 +1,288 @@
+import { Signal } from '@lumino/signaling';
+import { IChatCompletionResponseEmitter, IChatParticipant, IContextItem, ITelemetryEvent, IToolSelections, RequestDataType } from './tokens';
+export declare enum GitHubCopilotLoginStatus {
+    NotLoggedIn = "NOT_LOGGED_IN",
+    ActivatingDevice = "ACTIVATING_DEVICE",
+    LoggingIn = "LOGGING_IN",
+    LoggedIn = "LOGGED_IN"
+}
+export interface IDeviceVerificationInfo {
+    verificationURI: string;
+    userCode: string;
+}
+export declare enum ClaudeModelType {
+    None = "none",
+    Inherit = "inherit",
+    Default = ""
+}
+export interface IClaudeModelInfo {
+    id: string;
+    name: string;
+    contextWindow: number;
+}
+export interface IClaudeSessionInfo {
+    session_id: string;
+    path: string;
+    modified_at: number;
+    created_at: number;
+    preview: string;
+    cwd: string;
+}
+export interface IClaudeSessionList {
+    sessions: IClaudeSessionInfo[];
+    currentCwd: string;
+}
+export type ClaudeSessionScope = 'cwd' | 'all';
+export declare enum ClaudeToolType {
+    ClaudeCodeTools = "claude-code:built-in-tools",
+    JupyterUITools = "nbi:built-in-jupyter-ui-tools"
+}
+export type SkillScope = 'user' | 'project';
+export type ClaudeMCPScope = 'user' | 'project' | 'local';
+export type ClaudeMCPTransport = 'stdio' | 'sse' | 'http';
+export type PluginScope = 'user' | 'project' | 'local';
+export interface IPluginInfo {
+    id?: string;
+    name?: string;
+    scope?: PluginScope | string;
+    enabled?: boolean;
+    marketplace?: string;
+    version?: string;
+    description?: string;
+    [key: string]: unknown;
+}
+export interface IPluginMarketplaceInfo {
+    name?: string;
+    source?: string;
+    scope?: PluginScope | string;
+    description?: string;
+    version?: string;
+    plugin_count?: number;
+    plugin_names?: string[];
+    [key: string]: unknown;
+}
+export interface IPluginMarketplacePluginInfo extends IPluginInfo {
+    source?: unknown;
+    category?: string;
+    tags?: string[];
+}
+export interface IClaudeMCPServer {
+    name: string;
+    scope: ClaudeMCPScope;
+    transport: ClaudeMCPTransport | string;
+    command: string;
+    args: string[];
+    env: Record<string, string>;
+    url: string;
+    headers: Record<string, string>;
+    disabledForWorkspace: boolean;
+}
+export interface IClaudeMCPAddInput {
+    name: string;
+    scope: ClaudeMCPScope;
+    transport: ClaudeMCPTransport;
+    commandOrUrl: string;
+    args?: string[];
+    env?: Record<string, string>;
+    headers?: Record<string, string>;
+}
+export interface ISkillSummary {
+    scope: SkillScope;
+    name: string;
+    description: string;
+    allowedTools: string[];
+    rootPath: string;
+    files: string[];
+    source: string;
+    managed: boolean;
+    managedSource: string;
+    managedRef: string;
+    tracksUpstream: boolean;
+    trackingRef: string;
+}
+export interface IReconcileResult {
+    added: number;
+    updated: number;
+    removed: number;
+    unchanged: number;
+    errors: string[];
+}
+export interface ISkillDetail extends ISkillSummary {
+    body: string;
+}
+export interface ISkillsContext {
+    projectRoot: string;
+    projectName: string;
+    userSkillsDir: string;
+    projectSkillsDir: string;
+}
+export interface ISkillImportPreview {
+    name: string;
+    description: string;
+    allowedTools: string[];
+    body: string;
+    files: string[];
+    sourceUrl: string;
+    canonicalUrl: string;
+    existsInUserScope: boolean;
+    existsInProjectScope: boolean;
+}
+export declare function skillFromWire(wire: any): ISkillDetail;
+export interface ISyncSkillResult {
+    updated: boolean;
+    ref: string;
+}
+export interface ISyncAllTrackingEntry {
+    scope: SkillScope;
+    name: string;
+    updated?: boolean;
+    ref?: string;
+    error?: string;
+}
+export interface ICellOutputFeatureFlag {
+    enabled: boolean;
+    locked: boolean;
+}
+export interface ICellOutputFeatures {
+    explain_error: ICellOutputFeatureFlag;
+    output_followup: ICellOutputFeatureFlag;
+    output_toolbar: ICellOutputFeatureFlag;
+}
+export type CellOutputActionFlag = Exclude<keyof ICellOutputFeatures, 'output_toolbar'>;
+export type FeaturePolicyName = 'explain_error' | 'output_followup' | 'output_toolbar' | 'claude_mode' | 'claude_continue_conversation' | 'claude_code_tools' | 'claude_jupyter_ui_tools' | 'claude_setting_source_user' | 'claude_setting_source_project' | 'store_github_access_token' | 'skills_management' | 'claude_mcp_management' | 'claude_plugins_management' | 'terminal_drag_drop' | 'refresh_open_files_on_disk_change';
+export type IFeaturePolicies = Record<FeaturePolicyName, ICellOutputFeatureFlag>;
+export type SettingLockName = 'chat_model_provider' | 'chat_model_id' | 'inline_completion_model_provider' | 'inline_completion_model_id' | 'claude_chat_model' | 'claude_inline_completion_model' | 'claude_api_key' | 'claude_base_url';
+export type ISettingLocks = Record<SettingLockName, {
+    locked: boolean;
+}>;
+export declare class NBIConfig {
+    get userHomeDir(): string;
+    get userConfigDir(): string;
+    get llmProviders(): [any];
+    get chatModels(): [any];
+    get inlineCompletionModels(): [any];
+    get defaultChatMode(): string;
+    get chatModel(): any;
+    get chatModelSupportsVision(): boolean;
+    get inlineCompletionModel(): any;
+    get usingGitHubCopilotModel(): boolean;
+    get storeGitHubAccessToken(): boolean;
+    get inlineCompletionDebouncerDelay(): number;
+    get toolConfig(): any;
+    get mcpServers(): any;
+    getMCPServer(serverId: string): any;
+    getMCPServerPrompt(serverId: string, promptName: string): any;
+    get mcpServerSettings(): any;
+    get claudeSettings(): any;
+    get claudeModels(): IClaudeModelInfo[];
+    get isInClaudeCodeMode(): boolean;
+    get isClaudeCliAvailable(): boolean;
+    get isOpenCodeCliAvailable(): boolean;
+    get isPiCliAvailable(): boolean;
+    get isGitHubCopilotCliAvailable(): boolean;
+    get isCodexCliAvailable(): boolean;
+    isCodingAgentLauncherDisabledByPolicy(launcherId: string): boolean;
+    get chatFeedbackEnabled(): boolean;
+    get tourOverrides(): Record<string, any>;
+    get allowGithubSkillImport(): boolean;
+    get additionalSkippedWorkspaceDirectories(): string[];
+    get allowGithubPluginImport(): boolean;
+    get cellOutputFeatures(): ICellOutputFeatures;
+    get featurePolicies(): IFeaturePolicies;
+    get settingLocks(): ISettingLocks;
+    capabilities: any;
+    chatParticipants: IChatParticipant[];
+    changed: Signal<this, void>;
+}
+export declare class NBIAPI {
+    static _loginStatus: GitHubCopilotLoginStatus;
+    static _deviceVerificationInfo: IDeviceVerificationInfo;
+    static _webSocket: WebSocket;
+    static _messageReceived: Signal<unknown, any>;
+    static config: NBIConfig;
+    static configChanged: Signal<NBIConfig, void>;
+    static githubLoginStatusChanged: Signal<unknown, void>;
+    static skillsReloaded: Signal<unknown, void>;
+    static claudeCodeHeartbeat: Signal<unknown, void>;
+    static initialize(): Promise<void>;
+    static initializeWebsocket(): Promise<void>;
+    static getLoginStatus(): GitHubCopilotLoginStatus;
+    static getDeviceVerificationInfo(): IDeviceVerificationInfo;
+    static getGHLoginRequired(): boolean;
+    static getChatEnabled(): any;
+    static getInlineCompletionEnabled(): any;
+    static loginToGitHub(): Promise<unknown>;
+    static logoutFromGitHub(): Promise<unknown>;
+    static updateGitHubLoginStatus(): Promise<void>;
+    static fetchCapabilities(): Promise<void>;
+    static setConfig(config: any): Promise<void>;
+    static updateOllamaModelList(): Promise<void>;
+    static updateClaudeModelList(): Promise<void>;
+    static getMCPConfigFile(): Promise<any>;
+    static setMCPConfigFile(config: any): Promise<any>;
+    static listSkills(): Promise<ISkillSummary[]>;
+    static getSkillsContext(): Promise<ISkillsContext>;
+    static readSkill(scope: SkillScope, name: string): Promise<ISkillDetail>;
+    static createSkill(payload: {
+        scope: SkillScope;
+        name: string;
+        description: string;
+        allowedTools: string[];
+        body: string;
+    }): Promise<ISkillDetail>;
+    static updateSkill(scope: SkillScope, name: string, payload: {
+        description?: string;
+        allowedTools?: string[];
+        body?: string;
+        tracksUpstream?: boolean;
+    }): Promise<ISkillDetail>;
+    static deleteSkill(scope: SkillScope, name: string): Promise<void>;
+    static previewSkillImport(url: string): Promise<ISkillImportPreview>;
+    static importSkill(payload: {
+        url: string;
+        scope: SkillScope;
+        name?: string;
+        overwrite?: boolean;
+        tracksUpstream?: boolean;
+    }): Promise<ISkillDetail>;
+    static syncTrackingSkill(scope: SkillScope, name: string): Promise<ISyncSkillResult>;
+    static syncAllTrackingSkills(): Promise<ISyncAllTrackingEntry[]>;
+    static listClaudeMCPServers(): Promise<IClaudeMCPServer[]>;
+    static addClaudeMCPServer(input: IClaudeMCPAddInput): Promise<IClaudeMCPServer>;
+    static removeClaudeMCPServer(name: string, scope: ClaudeMCPScope): Promise<void>;
+    static setClaudeMCPServerDisabled(name: string, scope: ClaudeMCPScope, disabled: boolean): Promise<IClaudeMCPServer>;
+    static listPlugins(): Promise<IPluginInfo[]>;
+    static installPlugin(plugin: string, scope?: PluginScope): Promise<void>;
+    static uninstallPlugin(plugin: string, scope?: PluginScope): Promise<void>;
+    static setPluginEnabled(plugin: string, scope: PluginScope, enabled: boolean): Promise<void>;
+    static listPluginMarketplaces(): Promise<IPluginMarketplaceInfo[]>;
+    static listPluginMarketplacePlugins(marketplace: string): Promise<IPluginMarketplacePluginInfo[]>;
+    static addPluginMarketplace(source: string, scope?: PluginScope): Promise<void>;
+    static removePluginMarketplace(name: string): Promise<void>;
+    static updatePluginMarketplace(name: string): Promise<void>;
+    static reconcileManagedSkills(): Promise<IReconcileResult>;
+    static renameSkill(scope: SkillScope, name: string, newName: string): Promise<ISkillDetail>;
+    static readBundleFile(scope: SkillScope, name: string, path: string): Promise<string>;
+    static writeBundleFile(scope: SkillScope, name: string, path: string, content: string): Promise<void>;
+    static deleteBundleFile(scope: SkillScope, name: string, path: string): Promise<void>;
+    static renameBundleFile(scope: SkillScope, name: string, from: string, to: string): Promise<void>;
+    /**
+     * Subscribe to inbound websocket messages for a single request, forwarding
+     * them to `responseEmitter`. The subscription auto-disconnects when the
+     * server emits StreamEnd, preventing per-request listener accumulation.
+     */
+    private static _subscribeUntilStreamEnd;
+    static chatRequest(messageId: string, chatId: string, prompt: string, language: string, currentDirectory: string, filename: string, additionalContext: IContextItem[], chatMode: string, toolSelections: IToolSelections, responseEmitter: IChatCompletionResponseEmitter): Promise<void>;
+    static reloadMCPServers(): Promise<any>;
+    static generateCode(messageId: string, chatId: string, prompt: string, prefix: string, suffix: string, existingCode: string, language: string, filename: string, responseEmitter: IChatCompletionResponseEmitter): Promise<void>;
+    static sendChatUserInput(messageId: string, data: any): Promise<void>;
+    static sendWebSocketMessage(messageId: string, messageType: RequestDataType, data: any): Promise<void>;
+    static inlineCompletionsRequest(chatId: string, messageId: string, prefix: string, suffix: string, language: string, filename: string, responseEmitter: IChatCompletionResponseEmitter): Promise<void>;
+    static uploadFile(file: File): Promise<{
+        serverPath: string;
+        filename: string;
+    }>;
+    static listClaudeSessions(scope?: ClaudeSessionScope): Promise<IClaudeSessionList>;
+    static resumeClaudeSession(sessionId: string): Promise<void>;
+    static emitTelemetryEvent(event: ITelemetryEvent): Promise<void>;
+}