@mulmochat-plugin/summarize-pdf 0.2.0 → 0.3.0

package/dist/core/definition.d.ts

@@ -0,0 +1,6 @@
+/**
+ * SummarizePdf Tool Definition (Schema)
+ */
+import type { ToolDefinition } from "gui-chat-protocol";
+export declare const TOOL_NAME = "summarizePDF";
+export declare const TOOL_DEFINITION: ToolDefinition;

package/dist/core/index.d.ts

@@ -4,5 +4,5 @@
  * This module exports the core plugin logic without UI components.
  * Import from "@mulmochat-plugin/summarize-pdf" or "@mulmochat-plugin/summarize-pdf/core"
  */
-export type { BackendType, ToolContextApp, ToolContext, ToolResult, ToolResultComplete, JsonSchemaProperty, ToolDefinition, StartApiResponse, ToolSample, InputHandler, FileInputHandler, ClipboardImageInputHandler, UrlInputHandler, TextInputHandler, FileUploadConfig, ConfigValue, ConfigFieldSchema, PluginConfigSchema, ViewComponentProps, PreviewComponentProps, ToolPluginCore, PdfToolData, PdfArgs, PdfJsonData, } from "./types";
+export type { PdfToolData, PdfArgs, PdfJsonData } from "./types";
 export { TOOL_NAME, TOOL_DEFINITION, createUploadedPdfResult, executeSummarizePdf, pluginCore, } from "./plugin";

package/dist/core/plugin.d.ts

@@ -4,9 +4,9 @@
  * Contains the plugin logic without UI components.
  * Can be used by any framework (Vue, React, etc.)
  */
-import type { ToolPluginCore, ToolContext, ToolResult, ToolDefinition, PdfToolData, PdfArgs, PdfJsonData } from "./types";
-export declare const TOOL_NAME = "summarizePDF";
-export declare const TOOL_DEFINITION: ToolDefinition;
+import type { ToolPluginCore, ToolContext, ToolResult } from "gui-chat-protocol";
+import type { PdfToolData, PdfArgs, PdfJsonData } from "./types";
+export { TOOL_NAME, TOOL_DEFINITION } from "./definition";
 /**
  * Create a ToolResult for an uploaded PDF file
  */

package/dist/core/types.d.ts

@@ -1,227 +1,9 @@
 /**
- * MulmoChat Plugin Core Types (Framework-agnostic)
+ * SummarizePdf Plugin Types
  *
- * These types can be used by any framework implementation (Vue, React, etc.)
+ * Plugin-specific types only.
+ * Common types are imported from gui-chat-protocol.
  */
-/**
- * Backend types that plugins can declare they use.
- * App layer manages actual provider/model settings for each type.
- */
-export type BackendType = "textLLM" | "imageGen" | "audio" | "search" | "browse" | "map" | "mulmocast";
-/**
- * App interface provided to plugins via context.app
- * Contains backend functions and config accessors
- */
-export interface ToolContextApp extends Record<string, (...args: any[]) => any> {
-    getConfig: <T = unknown>(key: string) => T | undefined;
-    setConfig: (key: string, value: unknown) => void;
-}
-/**
- * Context passed to plugin execute function
- */
-export interface ToolContext {
-    currentResult?: ToolResult<unknown> | null;
-    app?: ToolContextApp;
-}
-/**
- * Result returned from plugin execution
- */
-export interface ToolResult<T = unknown, J = unknown> {
-    toolName?: string;
-    uuid?: string;
-    message: string;
-    title?: string;
-    jsonData?: J;
-    instructions?: string;
-    instructionsRequired?: boolean;
-    updating?: boolean;
-    cancelled?: boolean;
-    data?: T;
-    viewState?: Record<string, unknown>;
-}
-/**
- * Complete tool result with required fields
- */
-export interface ToolResultComplete<T = unknown, J = unknown> extends ToolResult<T, J> {
-    toolName: string;
-    uuid: string;
-}
-/**
- * JSON Schema property definition for tool parameters
- */
-export interface JsonSchemaProperty {
-    type?: string;
-    description?: string;
-    enum?: string[];
-    items?: JsonSchemaProperty;
-    minimum?: number;
-    maximum?: number;
-    minItems?: number;
-    maxItems?: number;
-    properties?: Record<string, JsonSchemaProperty>;
-    required?: string[];
-    additionalProperties?: boolean;
-    oneOf?: JsonSchemaProperty[];
-    [key: string]: unknown;
-}
-/**
- * Tool definition for OpenAI-compatible function calling
- */
-export interface ToolDefinition {
-    type: "function";
-    name: string;
-    description: string;
-    parameters?: {
-        type: "object";
-        properties: Record<string, JsonSchemaProperty>;
-        required: string[];
-        additionalProperties?: boolean;
-    };
-}
-/**
- * API response from server start endpoint
- */
-export interface StartApiResponse {
-    hasOpenAIApiKey?: boolean;
-    hasAnthropicApiKey?: boolean;
-    hasGoogleApiKey?: boolean;
-    [key: string]: unknown;
-}
-/**
- * Sample arguments for testing
- */
-export interface ToolSample {
-    name: string;
-    args: Record<string, unknown>;
-}
-/**
- * File input handler
- */
-export interface FileInputHandler {
-    type: "file";
-    acceptedTypes: string[];
-    handleInput: (fileData: string, fileName: string) => ToolResult<unknown, unknown>;
-}
-/**
- * Clipboard image input handler
- */
-export interface ClipboardImageInputHandler {
-    type: "clipboard-image";
-    handleInput: (imageData: string) => ToolResult<unknown, unknown>;
-}
-/**
- * URL input handler
- */
-export interface UrlInputHandler {
-    type: "url";
-    patterns?: string[];
-    handleInput: (url: string) => ToolResult<unknown, unknown>;
-}
-/**
- * Text input handler
- */
-export interface TextInputHandler {
-    type: "text";
-    patterns?: string[];
-    handleInput: (text: string) => ToolResult<unknown, unknown>;
-}
-/**
- * Union of all input handler types
- */
-export type InputHandler = FileInputHandler | ClipboardImageInputHandler | UrlInputHandler | TextInputHandler;
-/**
- * Legacy file upload config (for backward compatibility)
- * @deprecated Use InputHandler instead
- */
-export interface FileUploadConfig {
-    acceptedTypes: string[];
-    handleUpload: (fileData: string, fileName: string, ...args: unknown[]) => ToolResult<unknown, unknown>;
-}
-export type ConfigValue = string | number | boolean | string[];
-interface BaseFieldSchema {
-    label: string;
-    description?: string;
-    required?: boolean;
-}
-export interface StringFieldSchema extends BaseFieldSchema {
-    type: "string";
-    placeholder?: string;
-    minLength?: number;
-    maxLength?: number;
-    pattern?: string;
-}
-export interface NumberFieldSchema extends BaseFieldSchema {
-    type: "number";
-    min?: number;
-    max?: number;
-    step?: number;
-}
-export interface BooleanFieldSchema extends BaseFieldSchema {
-    type: "boolean";
-}
-export interface SelectOption {
-    value: string;
-    label: string;
-    description?: string;
-    disabled?: boolean;
-}
-export interface SelectFieldSchema extends BaseFieldSchema {
-    type: "select";
-    options: SelectOption[];
-}
-export interface MultiSelectFieldSchema extends BaseFieldSchema {
-    type: "multiselect";
-    options: SelectOption[];
-    minItems?: number;
-    maxItems?: number;
-}
-export type ConfigFieldSchema = StringFieldSchema | NumberFieldSchema | BooleanFieldSchema | SelectFieldSchema | MultiSelectFieldSchema;
-/**
- * Plugin configuration schema (JSON Schema based)
- */
-export interface PluginConfigSchema {
-    key: string;
-    defaultValue: ConfigValue;
-    schema: ConfigFieldSchema;
-}
-/**
- * Standard props for View components
- */
-export interface ViewComponentProps<T = unknown, J = unknown> {
-    selectedResult: ToolResultComplete<T, J>;
-    sendTextMessage: (text?: string) => void;
-    onUpdateResult?: (result: Partial<ToolResult<T, J>>) => void;
-    pluginConfigs?: Record<string, unknown>;
-}
-/**
- * Standard props for Preview components
- */
-export interface PreviewComponentProps<T = unknown, J = unknown> {
-    result: ToolResultComplete<T, J>;
-    isSelected?: boolean;
-    onSelect?: () => void;
-}
-/**
- * Core plugin interface - framework agnostic
- * Does not include UI components
- */
-export interface ToolPluginCore<T = unknown, J = unknown, A extends object = object> {
-    toolDefinition: ToolDefinition;
-    execute: (context: ToolContext, args: A) => Promise<ToolResult<T, J>>;
-    generatingMessage: string;
-    waitingMessage?: string;
-    uploadMessage?: string;
-    isEnabled: (startResponse?: StartApiResponse | null) => boolean;
-    delayAfterExecution?: number;
-    systemPrompt?: string;
-    inputHandlers?: InputHandler[];
-    /** @deprecated Use inputHandlers instead */
-    fileUpload?: FileUploadConfig;
-    /** New JSON Schema based config (framework-agnostic) */
-    configSchema?: PluginConfigSchema;
-    samples?: ToolSample[];
-    backends?: BackendType[];
-}
 /** PDF tool data stored in result.data */
 export interface PdfToolData {
     pdfData: string;
@@ -237,4 +19,3 @@ export interface PdfJsonData {
     fileName: string;
     summary: string;
 }
-export {};

package/dist/core.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i="summarizePDF",n={type:"function",name:i,description:"Summarize the content of a currently selected PDF file using Claude.",parameters:{type:"object",properties:{prompt:{type:"string",description:"Instructions for Claude on how to summarize or analyze the PDF"}},required:["prompt"]}};function o(e,a){return{toolName:i,data:{pdfData:e,fileName:a},message:"",title:a}}const u=async(e,a)=>{const{prompt:l}=a,r=e.currentResult?.data;if(!r?.pdfData)return{message:"No PDF file available to summarize. Please select a PDF file first.",instructions:"Tell the user that no PDF file is currently selected and they need to upload a PDF file first."};if(!e.app?.summarizePdf)return{message:"summarizePdf function not available",instructions:"Tell the user that the PDF summarization failed."};try{const t=(await e.app.summarizePdf({prompt:l,pdfData:r.pdfData})).summary||"";return{data:{...r,summary:t},jsonData:{fileName:r.fileName,summary:t},message:"PDF summarized successfully",instructions:"Give the user a brief summary of the PDF.",instructionsRequired:!0,updating:!0}}catch(s){console.error("PDF summarization failed",s);const t=s instanceof Error?s.message:"Unknown error";return{message:`PDF summarization failed: ${t}`,instructions:`Tell the user that the PDF summarization failed with error: ${t}`}}},m={toolDefinition:n,execute:u,generatingMessage:"Summarizing PDF...",uploadMessage:"PDF file is available. Call 'summarizePDF' to see its summary",isEnabled:e=>!!e?.hasAnthropicApiKey,fileUpload:{acceptedTypes:["application/pdf"],handleUpload:o}};exports.TOOL_DEFINITION=n;exports.TOOL_NAME=i;exports.createUploadedPdfResult=o;exports.executeSummarizePdf=u;exports.pluginCore=m;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i="summarizePDF",n={type:"function",name:i,description:"Summarize the content of a currently selected PDF file using Claude.",parameters:{type:"object",properties:{prompt:{type:"string",description:"Instructions for Claude on how to summarize or analyze the PDF"}},required:["prompt"]}};function o(e,a){return{toolName:i,data:{pdfData:e,fileName:a},message:"",title:a}}const u=async(e,a)=>{const{prompt:l}=a,r=e.currentResult?.data;if(!r?.pdfData)return{message:"No PDF file available to summarize. Please select a PDF file first.",instructions:"Tell the user that no PDF file is currently selected and they need to upload a PDF file first."};if(!e.app?.summarizePdf)return{message:"summarizePdf function not available",instructions:"Tell the user that the PDF summarization failed."};try{const t=(await e.app.summarizePdf({prompt:l,pdfData:r.pdfData})).summary||"";return{data:{...r,summary:t},jsonData:{fileName:r.fileName,summary:t},message:"PDF summarized successfully",instructions:"Give the user a brief summary of the PDF.",instructionsRequired:!0,updating:!0}}catch(s){console.error("PDF summarization failed",s);const t=s instanceof Error?s.message:"Unknown error";return{message:`PDF summarization failed: ${t}`,instructions:`Tell the user that the PDF summarization failed with error: ${t}`}}},m={toolDefinition:n,execute:u,generatingMessage:"Summarizing PDF...",uploadMessage:"PDF file is available. Call 'summarizePDF' to see its summary",isEnabled:e=>!!e?.hasAnthropicApiKey,inputHandlers:[{type:"file",acceptedTypes:["application/pdf"],handleInput:o}]};exports.TOOL_DEFINITION=n;exports.TOOL_NAME=i;exports.createUploadedPdfResult=o;exports.executeSummarizePdf=u;exports.pluginCore=m;

package/dist/core.js

@@ -66,10 +66,13 @@ const l = async (e, a) => {
   generatingMessage: "Summarizing PDF...",
   uploadMessage: "PDF file is available. Call 'summarizePDF' to see its summary",
   isEnabled: (e) => !!e?.hasAnthropicApiKey,
-  fileUpload: {
-    acceptedTypes: ["application/pdf"],
-    handleUpload: u
-  }
+  inputHandlers: [
+    {
+      type: "file",
+      acceptedTypes: ["application/pdf"],
+      handleInput: u
+    }
+  ]
 };
 export {
   o as TOOL_DEFINITION,

package/dist/vue/Preview.vue.d.ts

@@ -1,4 +1,5 @@
-import type { ToolResult, PdfToolData } from "./types";
+import type { ToolResult } from "gui-chat-protocol";
+import type { PdfToolData } from "../core/types";
 type __VLS_Props = {
     result: ToolResult<PdfToolData>;
 };

package/dist/vue/View.vue.d.ts

@@ -1,4 +1,5 @@
-import type { ToolResult, PdfToolData } from "./types";
+import type { ToolResult } from "gui-chat-protocol";
+import type { PdfToolData } from "../core/types";
 type __VLS_Props = {
     selectedResult: ToolResult<PdfToolData>;
 };

package/dist/vue/index.d.ts

@@ -5,18 +5,18 @@
  * Import from "@mulmochat-plugin/summarize-pdf/vue"
  */
 import "../style.css";
-import type { ToolPlugin, PdfToolData, PdfArgs, PdfJsonData } from "./types";
+import type { ToolPlugin } from "gui-chat-protocol/vue";
+import type { PdfToolData, PdfArgs, PdfJsonData } from "../core/types";
 import View from "./View.vue";
 import Preview from "./Preview.vue";
 /**
  * SummarizePdf plugin instance with Vue components
  */
 export declare const plugin: ToolPlugin<PdfToolData, PdfJsonData, PdfArgs>;
-export type { ToolPlugin, ToolPluginConfig } from "./types";
-export type { BackendType, ToolContextApp, ToolContext, ToolResult, ToolResultComplete, JsonSchemaProperty, ToolDefinition, StartApiResponse, ToolSample, InputHandler, FileUploadConfig, ConfigValue, ConfigFieldSchema, PluginConfigSchema, ViewComponentProps, PreviewComponentProps, ToolPluginCore, PdfToolData, PdfArgs, PdfJsonData, } from "./types";
+export type { PdfToolData, PdfArgs, PdfJsonData } from "../core/types";
 export { TOOL_NAME, TOOL_DEFINITION, createUploadedPdfResult, executeSummarizePdf, pluginCore, } from "../core/plugin";
 export { View, Preview };
 declare const _default: {
-    plugin: ToolPlugin<PdfToolData, PdfJsonData, PdfArgs>;
+    plugin: ToolPlugin<PdfToolData, PdfJsonData, PdfArgs, import("gui-chat-protocol/vue").InputHandler, Record<string, unknown>>;
 };
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mulmochat-plugin/summarize-pdf",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "PDF summarization plugin for MulmoChat",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -36,15 +36,18 @@
   "peerDependencies": {
     "vue": "^3.5.0"
   },
+  "dependencies": {
+    "gui-chat-protocol": "^0.0.1"
+  },
   "devDependencies": {
-    "marked": "^12.0.0",
     "@tailwindcss/vite": "^4.1.18",
     "@typescript-eslint/eslint-plugin": "^8.53.0",
     "@typescript-eslint/parser": "^8.53.0",
     "@vitejs/plugin-vue": "^6.0.3",
     "eslint": "^9.39.2",
-    "eslint-plugin-vue": "^10.6.2",
+    "eslint-plugin-vue": "^10.7.0",
     "globals": "^17.0.0",
+    "marked": "^17.0.1",
     "tailwindcss": "^4.1.18",
     "typescript": "~5.9.3",
     "vite": "^7.3.1",

package/dist/vue/types.d.ts

@@ -1,32 +0,0 @@
-/**
- * MulmoChat Plugin Vue Types
- *
- * Vue-specific types that extend the core plugin interface.
- */
-import type { Component } from "vue";
-import type { ToolPluginCore } from "../core/types";
-type VueComponent = Component<any>;
-/**
- * Legacy Vue component-based config
- * @deprecated Use PluginConfigSchema instead
- */
-export interface ToolPluginConfig {
-    key: string;
-    defaultValue: unknown;
-    component: VueComponent;
-}
-/**
- * Vue plugin interface - extends core with Vue components
- */
-export interface ToolPlugin<T = unknown, J = unknown, A extends object = object> extends ToolPluginCore<T, J, A> {
-    /** Vue component for full view */
-    viewComponent?: VueComponent;
-    /** Vue component for preview/thumbnail */
-    previewComponent?: VueComponent;
-    /**
-     * Legacy Vue component-based config (for backward compatibility)
-     * @deprecated Use configSchema instead
-     */
-    config?: ToolPluginConfig;
-}
-export type { BackendType, ToolContextApp, ToolContext, ToolResult, ToolResultComplete, JsonSchemaProperty, ToolDefinition, StartApiResponse, ToolSample, InputHandler, FileInputHandler, ClipboardImageInputHandler, UrlInputHandler, TextInputHandler, FileUploadConfig, ConfigValue, ConfigFieldSchema, PluginConfigSchema, ViewComponentProps, PreviewComponentProps, ToolPluginCore, PdfToolData, PdfArgs, PdfJsonData, } from "../core/types";