@jupyterlite/ai 0.18.0 → 0.19.0

package/src/skills/types.ts

@@ -1,37 +0,0 @@
-/*
- * Copyright (c) Jupyter Development Team.
- * Distributed under the terms of the Modified BSD License.
- */
-
-/**
- * Summary information about a skill.
- */
-export interface ISkillSummary {
-  name: string;
-  description: string;
-}
-
-/**
- * Full skill definition loaded from a SKILL.md file or registry.
- */
-export interface ISkillDefinition extends ISkillSummary {
-  instructions: string;
-  resources: string[];
-}
-
-/**
- * Result for loading a skill resource.
- */
-export interface ISkillResourceResult {
-  name: string;
-  resource: string;
-  content?: string;
-  error?: string;
-}
-
-/**
- * Skill registration payload for the skill registry.
- */
-export interface ISkillRegistration extends ISkillDefinition {
-  loadResource?: (resource: string) => Promise<ISkillResourceResult>;
-}

package/src/tools/commands.ts

@@ -1,210 +0,0 @@
-import { CommandRegistry } from '@lumino/commands';
-import { Widget } from '@lumino/widgets';
-import { tool } from 'ai';
-import { z } from 'zod';
-import type { IAISettingsModel, ITool } from '../tokens';
-
-interface ICommandEntry {
-  id: string;
-  label?: string;
-  caption?: string;
-  description?: string;
-  args?: any;
-}
-
-interface ISearchableField {
-  value?: string;
-  weight: number;
-}
-
-/**
- * Search commands using case-insensitive term matching across command metadata.
- *
- * Multi-word queries are split into individual terms, and every term must be
- * contained in at least one searchable field. Results are ranked by stronger
- * field matches while keeping a stable fallback order.
- */
-function searchCommands(
-  commands: ICommandEntry[],
-  query: string
-): ICommandEntry[] {
-  const normalizedQuery = query.trim().toLowerCase();
-  if (!normalizedQuery) {
-    return commands;
-  }
-
-  const terms = normalizedQuery.split(/\s+/).filter(Boolean);
-
-  return commands
-    .map((command, index) => {
-      const fields: ISearchableField[] = [
-        { value: command.label, weight: 4 },
-        { value: command.caption, weight: 3 },
-        { value: command.id, weight: 2 },
-        { value: command.description, weight: 1 }
-      ];
-
-      const normalizedFields = fields.map(field => ({
-        normalizedValue: field.value?.toLowerCase() ?? '',
-        weight: field.weight
-      }));
-
-      const matchesAllTerms = terms.every(term =>
-        normalizedFields.some(field => field.normalizedValue.includes(term))
-      );
-
-      if (!matchesAllTerms) {
-        return null;
-      }
-
-      const score = normalizedFields.reduce((total, field) => {
-        if (!field.normalizedValue) {
-          return total;
-        }
-
-        let fieldScore = 0;
-        if (field.normalizedValue.includes(normalizedQuery)) {
-          fieldScore += field.weight * 4;
-        } else {
-          fieldScore +=
-            terms.filter(term => field.normalizedValue.includes(term)).length *
-            field.weight;
-        }
-
-        return total + fieldScore;
-      }, 0);
-
-      return { command, index, score };
-    })
-    .filter(
-      (
-        result
-      ): result is {
-        command: ICommandEntry;
-        index: number;
-        score: number;
-      } => result !== null
-    )
-    .sort((a, b) => b.score - a.score || a.index - b.index)
-    .map(result => result.command);
-}
-
-/**
- * Create a tool to discover all available commands and their metadata
- */
-export function createDiscoverCommandsTool(commands: CommandRegistry): ITool {
-  return tool({
-    title: 'Discover Commands',
-    description:
-      'Discover all available JupyterLab commands with their metadata, arguments, and descriptions',
-    inputSchema: z.object({
-      query: z
-        .string()
-        .optional()
-        .nullable()
-        .describe(
-          'Optional search query to filter commands. Supports multi-word queries (whitespace-separated) by requiring each word to be contained in the command id, label, caption, or description. Leave empty to list all commands.'
-        )
-    }),
-    execute: async (input: { query?: string | null }) => {
-      const { query } = input;
-
-      // Build the full command list first.
-      const commandIds = commands.listCommands();
-      const allCommands: ICommandEntry[] = [];
-
-      for (const id of commandIds) {
-        const description = await commands.describedBy(id);
-        const label = commands.label(id);
-        const caption = commands.caption(id);
-        const usage = commands.usage(id);
-
-        allCommands.push({
-          id,
-          label: label || undefined,
-          caption: caption || undefined,
-          description: usage || undefined,
-          args: description?.args || undefined
-        });
-      }
-
-      const commandList = query
-        ? searchCommands(allCommands, query)
-        : allCommands;
-
-      return {
-        success: true,
-        commandCount: commandList.length,
-        commands: commandList
-      };
-    }
-  });
-}
-
-/**
- * Create a tool to execute a specific JupyterLab command.
- * Commands in the settings' commandsRequiringApproval list will need approval.
- */
-export function createExecuteCommandTool(
-  commands: CommandRegistry,
-  settingsModel: IAISettingsModel
-): ITool {
-  return tool({
-    title: 'Execute Command',
-    description:
-      'Execute a specific JupyterLab command with optional arguments',
-    inputSchema: z.object({
-      commandId: z.string().describe('The ID of the command to execute'),
-      args: z
-        .record(z.string(), z.unknown())
-        .optional()
-        .describe(
-          'Optional arguments object to pass to the command (must be an object, not a string)'
-        )
-    }),
-    needsApproval: (input: { commandId: string; args?: any }) => {
-      const commandsRequiringApproval =
-        settingsModel.config.commandsRequiringApproval || [];
-      return commandsRequiringApproval.includes(input.commandId);
-    },
-    execute: async (input: { commandId: string; args?: any }) => {
-      const { commandId, args } = input;
-
-      // Check if command exists
-      if (!commands.hasCommand(commandId)) {
-        return {
-          success: false,
-          error: `Command '${commandId}' does not exist. Use 'discover_commands' to see available commands.`
-        };
-      }
-
-      // Execute the command
-      const result = await commands.execute(commandId, args);
-
-      // Handle actual Lumino widgets specially by extracting id and title.
-      // Avoid collapsing plain command results that happen to contain an `id` field.
-      let serializedResult;
-      if (result instanceof Widget) {
-        serializedResult = {
-          id: result.id,
-          title: result.title?.label || result.title
-        };
-      } else {
-        // For other objects, try JSON serialization with fallback
-        try {
-          serializedResult = JSON.parse(JSON.stringify(result));
-        } catch {
-          serializedResult = result
-            ? '[Complex object - cannot serialize]'
-            : 'Command executed successfully';
-        }
-      }
-
-      return {
-        success: true,
-        commandId,
-        result: serializedResult
-      };
-    }
-  });
-}

package/src/tools/skills.ts

@@ -1,84 +0,0 @@
-import { tool } from 'ai';
-import { z } from 'zod';
-import { ISkillRegistry, ITool } from '../tokens';
-
-/**
- * Create a tool to discover available skills and their summaries.
- */
-export function createDiscoverSkillsTool(skillRegistry: ISkillRegistry): ITool {
-  return tool({
-    title: 'Discover Skills',
-    description:
-      'Discover available agent skills with their names and descriptions',
-    inputSchema: z.object({
-      query: z
-        .string()
-        .optional()
-        .nullable()
-        .describe('Optional search query to filter skills')
-    }),
-    execute: async (input: { query?: string | null }) => {
-      const filtered = skillRegistry.listSkills(input.query ?? undefined);
-
-      return {
-        success: true,
-        skillCount: filtered.length,
-        skills: filtered
-      };
-    }
-  });
-}
-
-/**
- * Create a tool to load skill instructions or a bundled resource.
- */
-export function createLoadSkillTool(skillRegistry: ISkillRegistry): ITool {
-  return tool({
-    title: 'Load Skill',
-    description:
-      'Load a skill definition or a specific resource file bundled with a skill',
-    inputSchema: z.object({
-      name: z.string().describe('The name of the skill to load'),
-      resource: z
-        .string()
-        .optional()
-        .nullable()
-        .describe(
-          'Optional resource path to load from the skill (e.g. references/REFERENCE.md)'
-        )
-    }),
-    execute: async (input: { name: string; resource?: string | null }) => {
-      const { name, resource } = input;
-
-      if (resource) {
-        const result = await skillRegistry.getSkillResource(name, resource);
-        if (result.error) {
-          return {
-            success: false,
-            ...result
-          };
-        }
-        return {
-          success: true,
-          ...result
-        };
-      }
-
-      const skill = skillRegistry.getSkill(name);
-      if (!skill) {
-        return {
-          success: false,
-          error: `Skill not found: ${name}`
-        };
-      }
-
-      return {
-        success: true,
-        name: skill.name,
-        description: skill.description,
-        instructions: skill.instructions,
-        ...(skill.resources.length > 0 && { resources: skill.resources })
-      };
-    }
-  });
-}

package/src/tools/tool-registry.ts

@@ -1,63 +0,0 @@
-import { ISignal, Signal } from '@lumino/signaling';
-import { ITool, IToolRegistry, INamedTool } from '../tokens';
-
-/**
- * Implementation of the tool registry for managing AI tools
- */
-export class ToolRegistry implements IToolRegistry {
-  /**
-   * The registered tools as a record (name -> tool mapping).
-   */
-  get tools(): Record<string, ITool> {
-    return { ...this._tools }; // Return a copy to prevent external modification
-  }
-
-  /**
-   * The registered named tools array.
-   */
-  get namedTools(): INamedTool[] {
-    return Object.entries(this._tools).map(([name, tool]) => ({ name, tool }));
-  }
-
-  /**
-   * A signal triggered when the tools have changed.
-   */
-  get toolsChanged(): ISignal<IToolRegistry, void> {
-    return this._toolsChanged;
-  }
-
-  /**
-   * Add a new tool to the registry.
-   */
-  add(name: string, tool: ITool): void {
-    this._tools[name] = tool;
-    this._toolsChanged.emit();
-  }
-
-  /**
-   * Get a tool for a given name.
-   * Return null if the name is not provided or if there is no registered tool with the
-   * given name.
-   */
-  get(name: string | null): ITool | null {
-    if (name === null) {
-      return null;
-    }
-    return this._tools[name] || null;
-  }
-
-  /**
-   * Remove a tool from the registry by name.
-   */
-  remove(name: string): boolean {
-    if (name in this._tools) {
-      delete this._tools[name];
-      this._toolsChanged.emit();
-      return true;
-    }
-    return false;
-  }
-
-  private _tools: Record<string, ITool> = {};
-  private _toolsChanged = new Signal<IToolRegistry, void>(this);
-}

package/src/tools/web.ts

@@ -1,238 +0,0 @@
-import { tool } from 'ai';
-import { z } from 'zod';
-import { ITool } from '../tokens';
-
-const DEFAULT_MAX_CONTENT_CHARS = 20000;
-const MAX_ALLOWED_CONTENT_CHARS = 100000;
-const DEFAULT_TIMEOUT_MS = 20000;
-const MAX_TIMEOUT_MS = 120000;
-
-interface IReadBodyResult {
-  content: string;
-  isTruncated: boolean;
-  totalChars: number;
-  totalCharsExact: boolean;
-}
-
-/**
- * Read response body text with a character cap.
- *
- * Stops early once the cap is reached to avoid buffering arbitrarily large
- * payloads in memory.
- */
-async function readResponseText(
-  response: Response,
-  maxContentChars: number
-): Promise<IReadBodyResult> {
-  if (!response.body) {
-    const body = await response.text();
-    return {
-      content: body.slice(0, maxContentChars),
-      isTruncated: body.length > maxContentChars,
-      totalChars: body.length,
-      totalCharsExact: true
-    };
-  }
-
-  const reader = response.body.getReader();
-  const decoder = new TextDecoder();
-  let content = '';
-  let totalChars = 0;
-  let isTruncated = false;
-  let done = false;
-
-  while (!done) {
-    const readResult = await reader.read();
-    done = readResult.done;
-    if (done) {
-      continue;
-    }
-
-    const chunk = decoder.decode(readResult.value, { stream: true });
-    if (!chunk) {
-      continue;
-    }
-
-    totalChars += chunk.length;
-
-    if (!isTruncated) {
-      const remaining = maxContentChars - content.length;
-      if (chunk.length <= remaining) {
-        content += chunk;
-      } else {
-        content += chunk.slice(0, remaining);
-        isTruncated = true;
-      }
-    }
-
-    if (isTruncated) {
-      await reader.cancel();
-      return {
-        content,
-        isTruncated: true,
-        totalChars,
-        totalCharsExact: false
-      };
-    }
-  }
-
-  const tail = decoder.decode();
-  if (tail) {
-    totalChars += tail.length;
-    const remaining = maxContentChars - content.length;
-    if (tail.length <= remaining) {
-      content += tail;
-    } else {
-      content += tail.slice(0, remaining);
-      isTruncated = true;
-    }
-  }
-
-  return {
-    content,
-    isTruncated,
-    totalChars,
-    totalCharsExact: true
-  };
-}
-
-/**
- * Create a browser-native URL fetch tool.
- *
- * This is best-effort and subject to normal browser constraints (CORS, CSP,
- * mixed content, bot protections).
- */
-export function createBrowserFetchTool(): ITool {
-  return tool({
-    title: 'Browser Fetch',
-    description:
-      'Fetch a URL directly from the browser using HTTP GET for exact URL inspection when CORS/access permits.',
-    inputSchema: z.object({
-      url: z.string().describe('HTTP(S) URL to fetch'),
-      maxContentChars: z
-        .number()
-        .int()
-        .min(1)
-        .max(MAX_ALLOWED_CONTENT_CHARS)
-        .optional()
-        .describe(
-          `Maximum number of response characters to return (default: ${DEFAULT_MAX_CONTENT_CHARS})`
-        ),
-      timeoutMs: z
-        .number()
-        .int()
-        .min(1000)
-        .max(MAX_TIMEOUT_MS)
-        .optional()
-        .describe(
-          `Timeout in milliseconds (default: ${DEFAULT_TIMEOUT_MS}, max: ${MAX_TIMEOUT_MS})`
-        )
-    }),
-    execute: async (input: {
-      url: string;
-      maxContentChars?: number;
-      timeoutMs?: number;
-    }) => {
-      const maxContentChars = Math.min(
-        input.maxContentChars ?? DEFAULT_MAX_CONTENT_CHARS,
-        MAX_ALLOWED_CONTENT_CHARS
-      );
-      const timeoutMs = Math.min(
-        input.timeoutMs ?? DEFAULT_TIMEOUT_MS,
-        MAX_TIMEOUT_MS
-      );
-
-      let parsedUrl: URL;
-      try {
-        parsedUrl = new URL(input.url);
-      } catch {
-        return {
-          success: false,
-          errorType: 'invalid_url',
-          error: 'Invalid URL format',
-          url: input.url
-        };
-      }
-
-      if (!['http:', 'https:'].includes(parsedUrl.protocol)) {
-        return {
-          success: false,
-          errorType: 'unsupported_protocol',
-          error: 'Only http:// and https:// URLs are supported',
-          url: input.url
-        };
-      }
-
-      const controller = new AbortController();
-      const timeoutHandle = setTimeout(() => controller.abort(), timeoutMs);
-
-      try {
-        const response = await fetch(parsedUrl.toString(), {
-          method: 'GET',
-          credentials: 'omit',
-          redirect: 'follow',
-          signal: controller.signal,
-          headers: {
-            Accept:
-              'text/html,text/plain,application/json,text/markdown,*/*;q=0.8'
-          }
-        });
-
-        const contentType = response.headers.get('content-type') || '';
-        const contentLength = response.headers.get('content-length');
-        const body = await readResponseText(response, maxContentChars);
-        const success = response.ok;
-
-        return {
-          success,
-          url: response.url,
-          requestedUrl: parsedUrl.toString(),
-          status: response.status,
-          statusText: response.statusText,
-          contentType,
-          contentLength,
-          ...(success
-            ? {}
-            : {
-                errorType: 'http_error',
-                error: `HTTP ${response.status} ${response.statusText}`
-              }),
-          isTruncated: body.isTruncated,
-          returnedChars: body.content.length,
-          totalChars: body.totalChars,
-          totalCharsExact: body.totalCharsExact,
-          content: body.content,
-          limitations:
-            'Browser fetch is subject to CORS, site bot protections, and browser network policy.'
-        };
-      } catch (error) {
-        if ((error as Error).name === 'AbortError') {
-          return {
-            success: false,
-            errorType: 'timeout',
-            error: `Request timed out after ${timeoutMs} ms`,
-            url: parsedUrl.toString()
-          };
-        }
-
-        return {
-          success: false,
-          errorType: 'network_or_cors',
-          error:
-            error instanceof Error && error.message
-              ? error.message
-              : 'Fetch failed',
-          url: parsedUrl.toString(),
-          likelyCauses: [
-            'CORS blocked by the target website',
-            'DNS/network resolution failure',
-            'TLS/certificate issue',
-            'Target server rejected browser access'
-          ]
-        };
-      } finally {
-        clearTimeout(timeoutHandle);
-      }
-    }
-  });
-}

package/src/types.d.ts

@@ -1,4 +0,0 @@
-declare module '*.svg' {
-  const content: string;
-  export default content;
-}

package/style/icons/jupyternaut-lite.svg

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg fill="none" version="1.1" viewBox="0 0 38 38" xmlns="http://www.w3.org/2000/svg">
- <g>
-  <circle cx="19" cy="19" r="19" fill="#f7dc1e"/>
-  <path d="m19.948 6.8365c0.6344-0.21603 1.0908-0.81693 1.0908-1.5244 0-0.88916-0.7208-1.61-1.61-1.61s-1.61 0.72081-1.61 1.61c0 0.70739 0.4562 1.3082 1.0905 1.5243v1.1674h-0.5394c-6.2858 0-11.399 5.1132-11.399 11.399 0 6.2859 5.1133 11.399 11.399 11.399h1.398c6.2859 0 11.399-5.1132 11.399-11.399 0-6.2253-5.0159-11.301-11.219-11.397v-1.1687zm-1.5781 22.163h1.398c5.3669 0 9.7303-4.9787 9.7303-8.3455 0-5.3669-4.3634-9.7303-9.7303-9.7303h-1.398c-5.3668 0-9.7302 4.3634-9.7302 9.7303 0 3.3668 4.3634 8.3455 9.7302 8.3455zm14.522-5.003c0.7341 0 0.7375-0.5123 0.7422-1.2408v-1e-4c0.0012-0.1847 0.0025-0.3833 0.0158-0.591 0.0573-0.8624 0.0739-1.7008 0.0573-2.4892l-0.0033-0.119c-0.0373-1.3318-0.0436-1.5579-1.3047-1.8058l-0.1479-0.0246 0.0015 0.0495c0.0076 0.2465 0.0151 0.493 0.0151 0.739 0 1.8018-0.2712 3.5478-0.773 5.189-0.1363 0.4459 0.3433 0.8629 0.7534 0.6411l0.6436-0.3481zm-27.612 0c-0.73409 0-0.73741-0.5123-0.74215-1.2407-0.0012-0.1848-0.00249-0.3834-0.01581-0.5912-0.0573-0.8624-0.07392-1.7007-0.05731-2.4892l0.00336-0.1189c0.03721-1.3319 0.04352-1.5579 1.3047-1.8058l0.14784-0.0247-0.00151 0.0495c-0.00756 0.2465-0.01511 0.493-0.01511 0.739 0 1.8019 0.27119 3.5478 0.773 5.189 0.13634 0.4459-0.34326 0.8629-0.7534 0.6411l-0.64361-0.3481zm14.242-12.005c-4.6297 0-8.4776 2.9361-9.4584 6.7577-0.13379 0.5212 0.5513 0.6935 0.877 0.2653 1.3829-1.818 3.1418-2.153 4.7068-2.4511 2.1143-0.4027 3.8746-0.7379 3.8746-4.5719z" clip-rule="evenodd" fill="#000" fill-rule="evenodd"/>
- </g>
-</svg>