@framers/agentos-ext-local-file-search 0.1.0 → 0.1.1

package/manifest.json

@@ -2,9 +2,9 @@
   "$schema": "https://agentos.sh/schemas/extension-manifest-v1.json",
   "id": "com.framers.tools.local-file-search",
   "name": "Local File Search",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Search for files on the local filesystem by fuzzy name matching. Supports denylist filtering and relevance-ranked results.",
-  "author": { "name": "Manic Agency LLC", "url": "https://manic.agency" },
+  "author": { "name": "Frame", "url": "https://frame.dev" },
   "license": "MIT",
   "keywords": ["file", "search", "filesystem", "local", "find"],
   "agentosVersion": "^2.0.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@framers/agentos-ext-local-file-search",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Search for files on the local filesystem by fuzzy name matching",
   "type": "module",
   "main": "dist/index.js",
@@ -14,7 +14,7 @@
     "./package.json": "./package.json"
   },
   "peerDependencies": {
-    "@framers/agentos": "^0.5.2"
+    "@framers/agentos": ">=0.10.40"
   },
   "keywords": [
     "agentos",
@@ -29,17 +29,29 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/framersai/agentos-extensions.git",
+    "url": "git+https://github.com/framerslab/agentos-extensions.git",
     "directory": "registry/curated/tools/local-file-search"
   },
-  "homepage": "https://github.com/framersai/agentos-extensions/tree/master/registry/curated/tools/local-file-search#readme",
+  "homepage": "https://github.com/framerslab/agentos-extensions/tree/master/registry/curated/tools/local-file-search#readme",
   "bugs": {
-    "url": "https://github.com/framersai/agentos-extensions/issues"
+    "url": "https://github.com/framerslab/agentos-extensions/issues"
+  },
+  "files": [
+    "dist",
+    "manifest.json",
+    "README.md"
+  ],
+  "devDependencies": {
+    "@framers/agentos": "^0.10.40",
+    "@types/node": "^20.12.12",
+    "rimraf": "^5.0.7",
+    "typescript": "^5.4.5",
+    "vitest": "^3.2.7"
   },
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",
-    "test": "vitest run",
+    "test": "vitest run --passWithNoTests",
     "clean": "rimraf dist"
   }
 }

package/src/LocalFileSearchTool.ts

@@ -1,172 +0,0 @@
-// @ts-nocheck
-/**
- * @fileoverview Local File Search — find files on the host filesystem by fuzzy name matching.
- *
- * Searches the full filesystem (or a specified directory) with a configurable denylist
- * to exclude sensitive paths. Results are ranked by relevance: exact > startsWith > contains > fuzzy.
- *
- * @module agentos-ext-local-file-search/LocalFileSearchTool
- */
-
-import { readdir, stat } from 'node:fs/promises';
-import { join, basename, extname } from 'node:path';
-import type {
-  FileSearchConfig,
-  FileMatch,
-  LocalFileSearchInput,
-  LocalFileSearchOutput,
-} from './types.js';
-import { DEFAULT_FILE_SEARCH_CONFIG } from './types.js';
-
-/** MIME type map for common file extensions. */
-const MIME_MAP: Record<string, string> = {
-  '.png': 'image/png', '.jpg': 'image/jpeg', '.jpeg': 'image/jpeg',
-  '.gif': 'image/gif', '.webp': 'image/webp', '.svg': 'image/svg+xml',
-  '.mp4': 'video/mp4', '.mov': 'video/quicktime', '.webm': 'video/webm',
-  '.mp3': 'audio/mpeg', '.wav': 'audio/wav', '.ogg': 'audio/ogg',
-  '.pdf': 'application/pdf', '.zip': 'application/zip',
-  '.txt': 'text/plain', '.json': 'application/json',
-  '.csv': 'text/csv', '.md': 'text/markdown',
-  '.doc': 'application/msword',
-  '.docx': 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
-  '.xls': 'application/vnd.ms-excel',
-  '.xlsx': 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
-  '.pptx': 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
-};
-
-/**
- * ITool implementation for local filesystem search.
- * Walks directories recursively, matches files by name, and ranks by relevance.
- */
-export class LocalFileSearchTool {
-  readonly id = 'local_file_search';
-  readonly name = 'local_file_search';
-  readonly displayName = 'Local File Search';
-  readonly description = 'Search for files on the local filesystem by name. Returns matching files sorted by relevance.';
-  readonly parameters = {
-    type: 'object' as const,
-    properties: {
-      query: { type: 'string', description: 'Filename or partial filename to search for' },
-      directory: { type: 'string', description: 'Specific directory to search (overrides default scope)' },
-    },
-    required: ['query'],
-  };
-
-  private config: FileSearchConfig;
-
-  constructor(config?: Partial<FileSearchConfig>) {
-    this.config = { ...DEFAULT_FILE_SEARCH_CONFIG, ...config };
-  }
-
-  /** Execute the file search. */
-  async execute(input: LocalFileSearchInput): Promise<LocalFileSearchOutput> {
-    const query = input.query.toLowerCase();
-    const rootDir = input.directory ?? '/';
-    const matches: FileMatch[] = [];
-    let directoriesScanned = 0;
-    let timedOut = false;
-    const startTime = Date.now();
-
-    const walk = async (dir: string, depth: number): Promise<void> => {
-      if (depth > this.config.maxDepth) return;
-      if (Date.now() - startTime > this.config.timeoutMs) { timedOut = true; return; }
-      if (this.isDeniedDir(dir)) return;
-
-      directoriesScanned++;
-      let entries;
-      try {
-        entries = await readdir(dir, { withFileTypes: true });
-      } catch { return; } // permission denied, etc.
-
-      for (const entry of entries) {
-        if (timedOut) return;
-        const fullPath = join(dir, entry.name);
-
-        if (entry.isDirectory()) {
-          if (!this.isDeniedDir(entry.name) && !this.isDeniedDir(fullPath)) {
-            await walk(fullPath, depth + 1);
-          }
-        } else if (entry.isFile()) {
-          if (this.isDeniedFile(entry.name)) continue;
-          const relevance = this.scoreRelevance(entry.name.toLowerCase(), query);
-          if (relevance > 0) {
-            try {
-              const fileStat = await stat(fullPath);
-              matches.push({
-                path: fullPath,
-                name: entry.name,
-                size: fileStat.size,
-                modified: fileStat.mtime.toISOString(),
-                mimeType: MIME_MAP[extname(entry.name).toLowerCase()] ?? 'application/octet-stream',
-                relevance,
-              });
-            } catch { /* stat failed — skip */ }
-          }
-        }
-      }
-    };
-
-    await walk(rootDir, 0);
-
-    matches.sort((a, b) => b.relevance - a.relevance);
-    return {
-      matches: matches.slice(0, this.config.maxResults),
-      directoriesScanned,
-      timedOut,
-    };
-  }
-
-  /** Score how well a filename matches the query. 0 = no match. */
-  private scoreRelevance(filename: string, query: string): number {
-    const nameNoExt = filename.replace(/\.[^.]+$/, '');
-    if (filename === query) return 1.0;           // exact match
-    if (nameNoExt === query) return 0.95;          // match without extension
-    if (filename.startsWith(query)) return 0.8;    // starts with
-    if (nameNoExt.startsWith(query)) return 0.75;
-    if (filename.includes(query)) return 0.6;      // contains
-    if (nameNoExt.includes(query)) return 0.55;
-    // Levenshtein for fuzzy (only if query is close in length)
-    if (Math.abs(nameNoExt.length - query.length) <= 3) {
-      const dist = this.levenshtein(nameNoExt, query);
-      if (dist <= 3) return 0.3 - (dist * 0.08);
-    }
-    return 0;
-  }
-
-  /** Check if a directory name or path is in the denylist. */
-  private isDeniedDir(nameOrPath: string): boolean {
-    const base = basename(nameOrPath);
-    return this.config.denylist.some(pattern => {
-      if (pattern.startsWith('*')) return false; // glob patterns are for files only
-      if (pattern.startsWith('/')) return nameOrPath.startsWith(pattern);
-      if (pattern.startsWith('.')) return base === pattern;
-      return base === pattern;
-    });
-  }
-
-  /** Check if a filename matches a glob-style denylist pattern (e.g., *.key). */
-  private isDeniedFile(filename: string): boolean {
-    return this.config.denylist.some(pattern => {
-      if (pattern.startsWith('*.')) {
-        return filename.endsWith(pattern.slice(1));
-      }
-      return false;
-    });
-  }
-
-  /** Simple Levenshtein distance for fuzzy matching. */
-  private levenshtein(a: string, b: string): number {
-    const m = a.length, n = b.length;
-    const dp: number[][] = Array.from({ length: m + 1 }, () => Array(n + 1).fill(0));
-    for (let i = 0; i <= m; i++) dp[i][0] = i;
-    for (let j = 0; j <= n; j++) dp[0][j] = j;
-    for (let i = 1; i <= m; i++) {
-      for (let j = 1; j <= n; j++) {
-        dp[i][j] = a[i - 1] === b[j - 1]
-          ? dp[i - 1][j - 1]
-          : 1 + Math.min(dp[i - 1][j], dp[i][j - 1], dp[i - 1][j - 1]);
-      }
-    }
-    return dp[m][n];
-  }
-}

package/src/index.ts

@@ -1,31 +0,0 @@
-// @ts-nocheck
-/**
- * @fileoverview Extension pack factory for the local-file-search tool.
- * @module agentos-ext-local-file-search
- */
-
-import { LocalFileSearchTool } from './LocalFileSearchTool.js';
-import type { FileSearchConfig } from './types.js';
-
-export { LocalFileSearchTool } from './LocalFileSearchTool.js';
-export type { FileSearchConfig, FileMatch, LocalFileSearchInput, LocalFileSearchOutput } from './types.js';
-
-/**
- * Create the local-file-search extension pack.
- * @param ctx - Extension context with optional configuration.
- */
-export function createExtensionPack(ctx?: { config?: Partial<FileSearchConfig> }) {
-  const tool = new LocalFileSearchTool(ctx?.config);
-  return {
-    name: '@framers/agentos-ext-local-file-search',
-    version: '0.1.0',
-    descriptors: [
-      {
-        id: 'local_file_search',
-        kind: 'tool' as const,
-        priority: 50,
-        payload: tool,
-      },
-    ],
-  };
-}

package/src/types.ts

@@ -1,64 +0,0 @@
-// @ts-nocheck
-/**
- * @fileoverview Types for the local-file-search extension tool.
- * @module agentos-ext-local-file-search/types
- */
-
-/** Configuration for file search scope and behavior. */
-export interface FileSearchConfig {
-  /** Directories and glob patterns to exclude from search. */
-  denylist: string[];
-  /** Maximum number of results to return. */
-  maxResults: number;
-  /** Maximum directory depth to traverse. */
-  maxDepth: number;
-  /** Timeout in milliseconds — returns best results found so far. */
-  timeoutMs: number;
-}
-
-/** A single file match result. */
-export interface FileMatch {
-  /** Absolute path to the file. */
-  path: string;
-  /** File name (basename). */
-  name: string;
-  /** File size in bytes. */
-  size: number;
-  /** ISO 8601 last modified timestamp. */
-  modified: string;
-  /** Detected MIME type based on extension. */
-  mimeType: string;
-  /** Relevance score (higher is better). */
-  relevance: number;
-}
-
-/** Input schema for the local_file_search tool. */
-export interface LocalFileSearchInput {
-  /** Filename or partial filename to search for. */
-  query: string;
-  /** Specific directory to search (overrides full filesystem scan). */
-  directory?: string;
-}
-
-/** Output schema for the local_file_search tool. */
-export interface LocalFileSearchOutput {
-  /** Array of matching files sorted by relevance. */
-  matches: FileMatch[];
-  /** Number of directories scanned. */
-  directoriesScanned: number;
-  /** Whether the search timed out before completing. */
-  timedOut: boolean;
-}
-
-/** Default file search configuration. */
-export const DEFAULT_FILE_SEARCH_CONFIG: FileSearchConfig = {
-  denylist: [
-    '/proc', '/sys', '/dev',
-    'node_modules', '.git', '.env',
-    '.ssh', '.gnupg', '.aws',
-    '*.key', '*.pem', '*.secret',
-  ],
-  maxResults: 10,
-  maxDepth: 10,
-  timeoutMs: 10_000,
-};

package/test/LocalFileSearchTool.spec.ts

@@ -1,83 +0,0 @@
-// @ts-nocheck
-import { describe, it, expect, beforeAll, afterAll } from 'vitest';
-import { mkdirSync, writeFileSync, rmSync } from 'node:fs';
-import { join } from 'node:path';
-import { tmpdir } from 'node:os';
-import { LocalFileSearchTool } from '../src/LocalFileSearchTool.js';
-
-const TEST_DIR = join(tmpdir(), 'lfs-test-' + Date.now());
-
-beforeAll(() => {
-  mkdirSync(join(TEST_DIR, 'docs'), { recursive: true });
-  mkdirSync(join(TEST_DIR, 'pics'), { recursive: true });
-  mkdirSync(join(TEST_DIR, 'node_modules', 'pkg'), { recursive: true });
-  mkdirSync(join(TEST_DIR, '.ssh'), { recursive: true });
-  writeFileSync(join(TEST_DIR, 'docs', 'report.pdf'), 'fake pdf');
-  writeFileSync(join(TEST_DIR, 'docs', 'notes.txt'), 'some notes');
-  writeFileSync(join(TEST_DIR, 'pics', 'photo.png'), 'fake png');
-  writeFileSync(join(TEST_DIR, 'pics', 'sunset.jpg'), 'fake jpg');
-  writeFileSync(join(TEST_DIR, 'node_modules', 'pkg', 'index.js'), 'module');
-  writeFileSync(join(TEST_DIR, '.ssh', 'id_rsa.key'), 'secret');
-});
-
-afterAll(() => {
-  rmSync(TEST_DIR, { recursive: true, force: true });
-});
-
-describe('LocalFileSearchTool', () => {
-  const tool = new LocalFileSearchTool({
-    denylist: ['node_modules', '.ssh', '*.key'],
-    maxResults: 10,
-    maxDepth: 5,
-    timeoutMs: 5000,
-  });
-
-  it('finds files by exact name', async () => {
-    const result = await tool.execute({ query: 'report.pdf', directory: TEST_DIR });
-    expect(result.matches.length).toBeGreaterThanOrEqual(1);
-    expect(result.matches[0].name).toBe('report.pdf');
-  });
-
-  it('finds files by partial name', async () => {
-    const result = await tool.execute({ query: 'photo', directory: TEST_DIR });
-    expect(result.matches.some(m => m.name === 'photo.png')).toBe(true);
-  });
-
-  it('respects denylist — skips node_modules', async () => {
-    const result = await tool.execute({ query: 'index.js', directory: TEST_DIR });
-    expect(result.matches.length).toBe(0);
-  });
-
-  it('respects denylist — skips .ssh', async () => {
-    const result = await tool.execute({ query: 'id_rsa', directory: TEST_DIR });
-    expect(result.matches.length).toBe(0);
-  });
-
-  it('respects glob denylist — skips *.key files', async () => {
-    const result = await tool.execute({ query: 'id_rsa.key', directory: TEST_DIR });
-    expect(result.matches.length).toBe(0);
-  });
-
-  it('ranks exact matches higher than partial', async () => {
-    const result = await tool.execute({ query: 'notes.txt', directory: TEST_DIR });
-    expect(result.matches[0].name).toBe('notes.txt');
-    expect(result.matches[0].relevance).toBeGreaterThan(0.8);
-  });
-
-  it('returns size and mimeType', async () => {
-    const result = await tool.execute({ query: 'photo.png', directory: TEST_DIR });
-    expect(result.matches[0].size).toBeGreaterThan(0);
-    expect(result.matches[0].mimeType).toBe('image/png');
-  });
-
-  it('limits results to maxResults', async () => {
-    const smallTool = new LocalFileSearchTool({
-      denylist: ['node_modules', '.ssh', '*.key'],
-      maxResults: 1,
-      maxDepth: 5,
-      timeoutMs: 5000,
-    });
-    const result = await smallTool.execute({ query: '.', directory: TEST_DIR });
-    expect(result.matches.length).toBeLessThanOrEqual(1);
-  });
-});

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "outDir": "dist",
-    "rootDir": "src",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true
-  },
-  "include": ["src"],
-  "exclude": ["dist", "test", "node_modules"]
-}