neoctl-web 0.1.0 → 0.1.2

package/plugins/downloads/downloads.mjs

@@ -1,147 +1,147 @@
-import fs from 'node:fs';
-import fsp from 'node:fs/promises';
-import path from 'node:path';
-import crypto from 'node:crypto';
-
-export class DownloadRegistry {
-  constructor() {
-    this.entries = new Map();
-  }
-
-  add(entry) {
-    const id = crypto.randomUUID();
-    const full = {
-      id,
-      createdAt: Date.now(),
-      ...entry,
-    };
-    this.entries.set(id, full);
-    return full;
-  }
-
-  get(id) {
-    const entry = this.entries.get(String(id || ''));
-    if (!entry) return undefined;
-    if (entry.expiresAt && Date.now() > entry.expiresAt) {
-      this.entries.delete(entry.id);
-      return undefined;
-    }
-    return entry;
-  }
-}
-
-export function createExposeDownloadsTool(options) {
-  const ttlMs = options.ttlMs ?? 30 * 60 * 1000;
-
-  return {
-    name: 'expose_downloads',
-    description:
-      'Expose one or more existing local files for the web user to download. Input must be absolute file paths. The result follows neoctl.resource-link.v1: copy each downloads[].markdown value verbatim into the final response, without rewriting or prefixing its link.',
-    inputSchema: {
-      type: 'object',
-      properties: {
-        paths: {
-          type: 'array',
-          items: { type: 'string' },
-          description: 'Absolute file paths to expose for browser download.',
-        },
-      },
-      required: ['paths'],
-      additionalProperties: false,
-    },
-    metadata: {
-      readOnly: true,
-      concurrent: true,
-      visible: true,
-      requiresApproval: false,
-      maxResultSizeChars: 12000,
-    },
-    validate(input) {
-      const paths = Array.isArray(input?.paths)
-        ? input.paths.map((item) => String(item || '').trim()).filter(Boolean)
-        : [];
-      if (!paths.length) throw new Error('paths must be a non-empty array');
-      if (paths.length > 20) throw new Error('too many paths; maximum is 20');
-      for (const filePath of paths) {
-        if (!path.isAbsolute(filePath)) throw new Error(`path must be absolute: ${filePath}`);
-      }
-      return { paths };
-    },
-    async execute(input, context) {
-      const downloads = [];
-      for (const rawPath of input.paths) {
-        const absolutePath = path.resolve(rawPath);
-        const stat = await fsp.stat(absolutePath).catch(() => undefined);
-        if (!stat) throw new Error(`file does not exist: ${absolutePath}`);
-        if (!stat.isFile()) throw new Error(`path is not a file: ${absolutePath}`);
-        const entry = options.registry.add({
-          absolutePath,
-          filename: path.basename(absolutePath),
-          sizeBytes: stat.size,
-          expiresAt: Date.now() + ttlMs,
-          sessionId: context.session?.sessionId,
-        });
-        const url = `/api/downloads/${encodeURIComponent(entry.id)}`;
-        const reference = `sandbox:${url}`;
-        downloads.push({
-          id: entry.id,
-          filename: entry.filename,
-          sizeBytes: entry.sizeBytes,
-          url,
-          reference,
-          markdown: `[${entry.filename.replace(/([\\\]])/g, '\\$1')}](${reference})`,
-          expiresAt: new Date(entry.expiresAt).toISOString(),
-          expiresAtEpochMs: entry.expiresAt,
-        });
-      }
-      await options.onExpose?.({ sessionId: context.session?.sessionId, downloads });
-      return {
-        ok: true,
-        output: {
-          resourceProtocol: 'neoctl.resource-link.v1',
-          usage: 'Copy downloads[].markdown verbatim when linking the resource. Do not alter the reference URI.',
-          downloads,
-          _ui: {
-            resources: downloads.map((item) => ({
-              kind: 'download',
-              url: item.url,
-              reference: item.reference,
-              label: item.filename,
-              downloadName: item.filename,
-              sizeBytes: item.sizeBytes,
-              expiresAt: item.expiresAtEpochMs,
-            })),
-          },
-        },
-        summary: `Exposed ${downloads.length} file(s) for browser download.`,
-      };
-    },
-  };
-}
-
-export function serveDownload(registry, req, res, id) {
-  const entry = registry.get(id);
-  if (!entry) {
-    res.writeHead(404, { 'Content-Type': 'application/json; charset=utf-8', 'Cache-Control': 'no-store' });
-    res.end(JSON.stringify({ error: 'download not found or expired' }));
-    return;
-  }
-
-  res.writeHead(200, {
-    'Content-Type': 'application/octet-stream',
-    'Content-Length': String(entry.sizeBytes),
-    'Content-Disposition': `attachment; filename*=UTF-8''${encodeURIComponent(entry.filename)}`,
-    'Cache-Control': 'no-store',
-  });
-
-  fs.createReadStream(entry.absolutePath)
-    .on('error', () => {
-      if (!res.headersSent) {
-        res.writeHead(500, { 'Content-Type': 'text/plain; charset=utf-8' });
-        res.end('failed to read file');
-      } else {
-        res.destroy();
-      }
-    })
-    .pipe(res);
-}
+import fs from 'node:fs';
+import fsp from 'node:fs/promises';
+import path from 'node:path';
+import crypto from 'node:crypto';
+
+export class DownloadRegistry {
+  constructor() {
+    this.entries = new Map();
+  }
+
+  add(entry) {
+    const id = crypto.randomUUID();
+    const full = {
+      id,
+      createdAt: Date.now(),
+      ...entry,
+    };
+    this.entries.set(id, full);
+    return full;
+  }
+
+  get(id) {
+    const entry = this.entries.get(String(id || ''));
+    if (!entry) return undefined;
+    if (entry.expiresAt && Date.now() > entry.expiresAt) {
+      this.entries.delete(entry.id);
+      return undefined;
+    }
+    return entry;
+  }
+}
+
+export function createExposeDownloadsTool(options) {
+  const ttlMs = options.ttlMs ?? 30 * 60 * 1000;
+
+  return {
+    name: 'expose_downloads',
+    description:
+      'Expose one or more existing local files for the web user to download. Input must be absolute file paths. The result follows neoctl.resource-link.v1: copy each downloads[].markdown value verbatim into the final response, without rewriting or prefixing its link.',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        paths: {
+          type: 'array',
+          items: { type: 'string' },
+          description: 'Absolute file paths to expose for browser download.',
+        },
+      },
+      required: ['paths'],
+      additionalProperties: false,
+    },
+    metadata: {
+      readOnly: true,
+      concurrent: true,
+      visible: true,
+      requiresApproval: false,
+      maxResultSizeChars: 12000,
+    },
+    validate(input) {
+      const paths = Array.isArray(input?.paths)
+        ? input.paths.map((item) => String(item || '').trim()).filter(Boolean)
+        : [];
+      if (!paths.length) throw new Error('paths must be a non-empty array');
+      if (paths.length > 20) throw new Error('too many paths; maximum is 20');
+      for (const filePath of paths) {
+        if (!path.isAbsolute(filePath)) throw new Error(`path must be absolute: ${filePath}`);
+      }
+      return { paths };
+    },
+    async execute(input, context) {
+      const downloads = [];
+      for (const rawPath of input.paths) {
+        const absolutePath = path.resolve(rawPath);
+        const stat = await fsp.stat(absolutePath).catch(() => undefined);
+        if (!stat) throw new Error(`file does not exist: ${absolutePath}`);
+        if (!stat.isFile()) throw new Error(`path is not a file: ${absolutePath}`);
+        const entry = options.registry.add({
+          absolutePath,
+          filename: path.basename(absolutePath),
+          sizeBytes: stat.size,
+          expiresAt: Date.now() + ttlMs,
+          sessionId: context.session?.sessionId,
+        });
+        const url = `/api/downloads/${encodeURIComponent(entry.id)}`;
+        const reference = `sandbox:${url}`;
+        downloads.push({
+          id: entry.id,
+          filename: entry.filename,
+          sizeBytes: entry.sizeBytes,
+          url,
+          reference,
+          markdown: `[${entry.filename.replace(/([\\\]])/g, '\\$1')}](${reference})`,
+          expiresAt: new Date(entry.expiresAt).toISOString(),
+          expiresAtEpochMs: entry.expiresAt,
+        });
+      }
+      await options.onExpose?.({ sessionId: context.session?.sessionId, downloads });
+      return {
+        ok: true,
+        output: {
+          resourceProtocol: 'neoctl.resource-link.v1',
+          usage: 'Copy downloads[].markdown verbatim when linking the resource. Do not alter the reference URI.',
+          downloads,
+          _ui: {
+            resources: downloads.map((item) => ({
+              kind: 'download',
+              url: item.url,
+              reference: item.reference,
+              label: item.filename,
+              downloadName: item.filename,
+              sizeBytes: item.sizeBytes,
+              expiresAt: item.expiresAtEpochMs,
+            })),
+          },
+        },
+        summary: `Exposed ${downloads.length} file(s) for browser download.`,
+      };
+    },
+  };
+}
+
+export function serveDownload(registry, req, res, id) {
+  const entry = registry.get(id);
+  if (!entry) {
+    res.writeHead(404, { 'Content-Type': 'application/json; charset=utf-8', 'Cache-Control': 'no-store' });
+    res.end(JSON.stringify({ error: 'download not found or expired' }));
+    return;
+  }
+
+  res.writeHead(200, {
+    'Content-Type': 'application/octet-stream',
+    'Content-Length': String(entry.sizeBytes),
+    'Content-Disposition': `attachment; filename*=UTF-8''${encodeURIComponent(entry.filename)}`,
+    'Cache-Control': 'no-store',
+  });
+
+  fs.createReadStream(entry.absolutePath)
+    .on('error', () => {
+      if (!res.headersSent) {
+        res.writeHead(500, { 'Content-Type': 'text/plain; charset=utf-8' });
+        res.end('failed to read file');
+      } else {
+        res.destroy();
+      }
+    })
+    .pipe(res);
+}

package/plugins/downloads/index.mjs

@@ -1,19 +1,19 @@
-import { createExposeDownloadsTool, DownloadRegistry, serveDownload } from './downloads.mjs';
-
-export function createPlugin() {
-  const registry = new DownloadRegistry();
-  return {
-    tools: [createExposeDownloadsTool({ registry })],
-    promptSections: [{
-      name: 'Web Downloads',
-      cacheStable: true,
-      content: 'When you create, modify, export, package, or identify local files that the web user should receive, call expose_downloads with the relevant absolute paths before the final response. For every link in your response, copy the returned downloads[].markdown value verbatim. This is the neoctl.resource-link.v1 protocol: never construct a link, alter the reference URI, or add/remove a sandbox: prefix. The tool also returns expiresAt as an ISO timestamp.',
-    }],
-    async route(req, res, url) {
-      if (req.method !== 'GET' || !url.pathname.startsWith('/api/downloads/')) return false;
-      const id = decodeURIComponent(url.pathname.slice('/api/downloads/'.length));
-      await serveDownload(registry, req, res, id);
-      return true;
-    },
-  };
-}
+import { createExposeDownloadsTool, DownloadRegistry, serveDownload } from './downloads.mjs';
+
+export function createPlugin() {
+  const registry = new DownloadRegistry();
+  return {
+    tools: [createExposeDownloadsTool({ registry })],
+    promptSections: [{
+      name: 'Web Downloads',
+      cacheStable: true,
+      content: 'When you create, modify, export, package, or identify local files that the web user should receive, call expose_downloads with the relevant absolute paths before the final response. For every link in your response, copy the returned downloads[].markdown value verbatim. This is the neoctl.resource-link.v1 protocol: never construct a link, alter the reference URI, or add/remove a sandbox: prefix. The tool also returns expiresAt as an ISO timestamp.',
+    }],
+    async route(req, res, url) {
+      if (req.method !== 'GET' || !url.pathname.startsWith('/api/downloads/')) return false;
+      const id = decodeURIComponent(url.pathname.slice('/api/downloads/'.length));
+      await serveDownload(registry, req, res, id);
+      return true;
+    },
+  };
+}

package/plugins/downloads/neo-plugin.json

@@ -1,9 +1,9 @@
-{
-  "protocol": "neo-plugin/v1",
-  "id": "downloads",
-  "name": "文件下载",
-  "version": "1.0.0",
-  "entry": "index.mjs",
-  "defaultEnabled": true,
-  "description": "将本地文件安全地暴露为临时浏览器下载链接。"
-}
+{
+  "protocol": "neo-plugin/v1",
+  "id": "downloads",
+  "name": "文件下载",
+  "version": "1.0.0",
+  "entry": "index.mjs",
+  "defaultEnabled": true,
+  "description": "将本地文件安全地暴露为临时浏览器下载链接。"
+}