@synsci/plugin 2.0.77 → 2.0.78-test.34095579610

package/dist/connector.d.ts

@@ -0,0 +1,90 @@
+/** Broad scientific domain a connector belongs to. Used for grouping + filtering. */
+export type ConnectorDomain = "biology" | "chemistry" | "physics" | "genomics" | "proteomics" | "structure" | "literature" | "materials" | "clinical" | "general";
+/** A single normalized search result from a connector. */
+export interface ConnectorHit {
+    /** Stable identifier within the source (accession, DOI, PDB id, ...). */
+    id: string;
+    /** Human-readable title / name of the record. */
+    title: string;
+    /** Short summary or abstract snippet. */
+    summary?: string;
+    /** Canonical URL to the record on the source's site. */
+    url?: string;
+    /** Relevance score if the source provides one (0-1 or source-native). */
+    score?: number;
+    /** Source-specific structured fields, passed through verbatim. */
+    extra?: Record<string, unknown>;
+}
+/** Options accepted by `search`. Connectors ignore fields they don't support. */
+export interface SearchOptions {
+    /** Max hits to return. Connectors clamp to their own ceiling. */
+    limit?: number;
+    /** Organism / taxon filter where meaningful (e.g. NCBI taxon id). */
+    organism?: string;
+    /** Free-form per-source knobs. */
+    params?: Record<string, unknown>;
+    /** Abort signal wired through from the tool context. */
+    signal?: AbortSignal;
+}
+/** Options accepted by `fetch`. */
+export interface FetchOptions {
+    /** Desired representation, e.g. "json" | "pdb" | "fasta" | "sdf". */
+    format?: string;
+    params?: Record<string, unknown>;
+    signal?: AbortSignal;
+}
+/**
+ * Per-host politeness limits a connector can request for its HTTP calls.
+ *
+ * Applied per URL host by the shared http layer, so a multi-DB fan-out is never
+ * over-serialized. arXiv, for example, asks for ~1 request every 3s
+ * (`minIntervalMs: 3000`); keyless Semantic Scholar wants ~1000ms.
+ */
+export interface RateLimit {
+    /** Minimum spacing between the START of requests to the same host, in ms. */
+    minIntervalMs?: number;
+    /** Max concurrent in-flight requests to the same host. */
+    maxConcurrent?: number;
+}
+/** A record retrieved as a file rather than a structured record. */
+export interface FetchedFile {
+    /** File contents. Text formats only — no binary support in this increment. */
+    body: string;
+    /** MIME type as served, e.g. "chemical/x-cif". */
+    contentType: string;
+    /** Extension-bearing suggested name, e.g. "6LU7.cif". */
+    filename: string;
+}
+/** The uniform contract every scientific data source implements. */
+export interface Connector {
+    /** Unique, stable, lowercase id used to route (e.g. "uniprot", "rcsb-pdb"). */
+    id: string;
+    /** Display name (e.g. "UniProt", "RCSB PDB"). */
+    name: string;
+    /** Primary domain for grouping in the catalog. */
+    domain: ConnectorDomain;
+    /** One-line description shown in `science_list_dbs`. */
+    description: string;
+    /** Homepage / docs URL. */
+    homepage?: string;
+    /** Search the source; returns normalized hits. */
+    search(query: string, opts?: SearchOptions): Promise<ConnectorHit[]>;
+    /** Fetch a single record by id. Return shape is source-specific. */
+    fetch(id: string, opts?: FetchOptions): Promise<unknown>;
+    /**
+     * FILE formats this connector can serve, e.g. ["pdb", "cif"]. Absent = records only.
+     * Never includes "json" — omitting `format` is the record path via `fetch()`.
+     */
+    formats?: string[];
+    /** Retrieve a record as a file in one of `formats`. Present iff `formats` is. */
+    fetchFile?(id: string, format: string, opts?: FetchOptions): Promise<FetchedFile>;
+}
+/** Public catalog entry shape returned by the registry (no functions). */
+export interface CatalogEntry {
+    id: string;
+    name: string;
+    domain: ConnectorDomain;
+    description: string;
+    homepage?: string;
+    formats?: string[];
+}

package/dist/index.d.ts

@@ -2,7 +2,9 @@ import type { Event, createOpenScienceClient, Project, Permission, UserMessage,
 import type { Model, Provider } from "@synsci/sdk/v2";
 import type { BunShell } from "./shell.js";
 import { type ToolDefinition } from "./tool.js";
+import type { Connector } from "./connector.js";
 export * from "./tool.js";
+export type * from "./connector.js";
 export type ProviderContext = {
     source: "env" | "config" | "custom" | "api";
     info: Provider;
@@ -15,6 +17,8 @@ export type PluginInput = {
     worktree: string;
     serverUrl: URL;
     $: BunShell;
+    /** Aborted when this instance unloads the plugin. Older hosts may omit it. */
+    signal?: AbortSignal;
 };
 export type Plugin = (input: PluginInput) => Promise<Hooks>;
 export type AuthHook = {
@@ -107,6 +111,8 @@ export type AuthOuathResult = {
     }>;
 });
 export interface Hooks {
+    /** Release resources on instance shutdown or plugin invalidation. */
+    dispose?: () => Promise<void>;
     event?: (input: {
         event: Event;
     }) => Promise<void>;
@@ -114,6 +120,8 @@ export interface Hooks {
     tool?: {
         [key: string]: ToolDefinition;
     };
+    /** Scientific sources available through science_list_dbs/search/fetch in this instance. */
+    connector?: Connector[];
     auth?: AuthHook;
     /**
      * Called when a new message is received

package/dist/tool.d.ts

@@ -2,6 +2,8 @@ import { z } from "zod";
 export type ToolContext = {
     sessionID: string;
     messageID: string;
+    /** Identifies this invocation when the host executes a model tool call. */
+    callID?: string;
     agent: string;
     /**
      * Current project directory for this session.
@@ -16,9 +18,7 @@ export type ToolContext = {
     abort: AbortSignal;
     metadata(input: {
         title?: string;
-        metadata?: {
-            [key: string]: any;
-        };
+        metadata?: Record<string, unknown>;
     }): void;
     ask(input: AskInput): Promise<void>;
 };
@@ -26,18 +26,30 @@ type AskInput = {
     permission: string;
     patterns: string[];
     always: string[];
-    metadata: {
-        [key: string]: any;
-    };
+    metadata: Record<string, unknown>;
+};
+/** A file reference. The host supplies its message, session, and part IDs. */
+export type ToolAttachment = {
+    type: "file";
+    mime: string;
+    url: string;
+    filename?: string;
+};
+/** Metadata must be JSON-serializable. File references do not save an artifact. */
+export type ToolResult = string | {
+    output: string;
+    title?: string;
+    metadata?: Record<string, unknown>;
+    attachments?: ToolAttachment[];
 };
 export declare function tool<Args extends z.ZodRawShape>(input: {
     description: string;
     args: Args;
-    execute(args: z.infer<z.ZodObject<Args>>, context: ToolContext): Promise<string>;
+    execute(args: z.infer<z.ZodObject<Args>>, context: ToolContext): Promise<ToolResult>;
 }): {
     description: string;
     args: Args;
-    execute(args: z.infer<z.ZodObject<Args>>, context: ToolContext): Promise<string>;
+    execute(args: z.infer<z.ZodObject<Args>>, context: ToolContext): Promise<ToolResult>;
 };
 export declare namespace tool {
     var schema: typeof z;

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@synsci/plugin",
-  "version": "2.0.77",
+  "version": "2.0.78-test.34095579610",
   "type": "module",
   "license": "Apache-2.0",
   "scripts": {
@@ -22,7 +22,7 @@
     "dist"
   ],
   "dependencies": {
-    "@synsci/sdk": "2.0.77",
+    "@synsci/sdk": "2.0.78-test.34095579610",
     "zod": "4.1.8"
   },
   "devDependencies": {