@mulmochat-plugin/form 0.1.2 → 0.2.0

package/dist/common/types.d.ts

@@ -1,142 +0,0 @@
-/**
- * MulmoChat Plugin Common Types
- *
- * Core interfaces for building MulmoChat plugins.
- * These types are plugin-agnostic and can be used by any plugin implementation.
- */
-import type { Component } from "vue";
-/**
- * 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>;
-}
-/**
- * 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;
-}
-/**
- * API response from server start endpoint
- */
-export interface StartApiResponse {
-    hasOpenAIApiKey?: boolean;
-    hasAnthropicApiKey?: boolean;
-    hasGoogleApiKey?: boolean;
-    [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;
-    };
-}
-/**
- * File upload configuration
- */
-export interface FileUploadConfig {
-    acceptedTypes: string[];
-    handleUpload: (fileData: string, fileName: string, ...args: unknown[]) => ToolResult<unknown, unknown>;
-}
-/**
- * Plugin configuration
- */
-export interface ToolPluginConfig {
-    key: string;
-    defaultValue: unknown;
-    component: Component;
-}
-/**
- * Sample arguments for testing
- */
-export interface ToolSample {
-    name: string;
-    args: Record<string, unknown>;
-}
-/**
- * Main plugin interface
- * @template T - Type of data stored in result.data
- * @template J - Type of data stored in result.jsonData
- * @template A - Type of arguments passed to execute
- */
-export interface ToolPlugin<T = unknown, J = unknown, A extends object = object> {
-    /** Tool definition for LLM function calling */
-    toolDefinition: ToolDefinition;
-    /** Execute the plugin with given context and arguments */
-    execute: (context: ToolContext, args: A) => Promise<ToolResult<T, J>>;
-    /** Message shown while generating */
-    generatingMessage: string;
-    /** Message shown while waiting for user action */
-    waitingMessage?: string;
-    /** Message shown during file upload */
-    uploadMessage?: string;
-    /** Check if plugin is enabled based on server capabilities */
-    isEnabled: (startResponse?: StartApiResponse | null) => boolean;
-    /** Delay in ms after execution before proceeding */
-    delayAfterExecution?: number;
-    /** Vue component for full view */
-    viewComponent?: Component;
-    /** Vue component for preview/thumbnail */
-    previewComponent?: Component;
-    /** System prompt additions for this plugin */
-    systemPrompt?: string;
-    /** Optional file upload configuration */
-    fileUpload?: FileUploadConfig;
-    /** Optional plugin-specific configuration */
-    config?: ToolPluginConfig;
-    /** Optional sample arguments for testing */
-    samples?: ToolSample[];
-    /** Backend types this plugin uses (e.g., ["textLLM", "imageGen"]) */
-    backends?: BackendType[];
-}

package/dist/plugin/index.d.ts

@@ -1,18 +0,0 @@
-/**
- * MulmoChat Form Plugin
- *
- * A plugin for creating structured forms to collect user information.
- *
- * @example Basic usage
- * ```typescript
- * import { plugin } from "@mulmochat-plugin/form";
- * import "@mulmochat-plugin/form/style.css";
- * // Use plugin directly
- * ```
- */
-import type { ToolPlugin } from "../common";
-import type { FormData, FormArgs } from "./types";
-/**
- * Form plugin instance
- */
-export declare const plugin: ToolPlugin<never, FormData, FormArgs>;

package/dist/plugin/samples.d.ts

@@ -1,5 +0,0 @@
-/**
- * Form Sample Data
- */
-import type { ToolSample } from "../common";
-export declare const SAMPLES: ToolSample[];

package/dist/plugin/tools.d.ts

@@ -1,121 +0,0 @@
-/**
- * Form Tool Definition
- */
-export declare const TOOL_NAME = "presentForm";
-export declare const TOOL_DEFINITION: {
-    type: "function";
-    name: string;
-    description: string;
-    parameters: {
-        type: "object";
-        properties: {
-            title: {
-                type: string;
-                description: string;
-            };
-            description: {
-                type: string;
-                description: string;
-            };
-            fields: {
-                type: string;
-                description: string;
-                items: {
-                    type: string;
-                    properties: {
-                        id: {
-                            type: string;
-                            description: string;
-                        };
-                        type: {
-                            type: string;
-                            enum: string[];
-                            description: string;
-                        };
-                        label: {
-                            type: string;
-                            description: string;
-                        };
-                        description: {
-                            type: string;
-                            description: string;
-                        };
-                        required: {
-                            type: string;
-                            description: string;
-                        };
-                        placeholder: {
-                            type: string;
-                            description: string;
-                        };
-                        validation: {
-                            type: string;
-                            description: string;
-                        };
-                        minLength: {
-                            type: string;
-                            description: string;
-                        };
-                        maxLength: {
-                            type: string;
-                            description: string;
-                        };
-                        rows: {
-                            type: string;
-                            description: string;
-                        };
-                        choices: {
-                            type: string;
-                            items: {
-                                type: string;
-                            };
-                            description: string;
-                        };
-                        searchable: {
-                            type: string;
-                            description: string;
-                        };
-                        minSelections: {
-                            type: string;
-                            description: string;
-                        };
-                        maxSelections: {
-                            type: string;
-                            description: string;
-                        };
-                        minDate: {
-                            type: string;
-                            description: string;
-                        };
-                        maxDate: {
-                            type: string;
-                            description: string;
-                        };
-                        format: {
-                            type: string;
-                            description: string;
-                        };
-                        min: {
-                            type: string;
-                            description: string;
-                        };
-                        max: {
-                            type: string;
-                            description: string;
-                        };
-                        step: {
-                            type: string;
-                            description: string;
-                        };
-                        defaultValue: {
-                            description: string;
-                        };
-                    };
-                    required: string[];
-                };
-                minItems: number;
-            };
-        };
-        required: string[];
-    };
-};

package/dist/plugin/types.d.ts

@@ -1,89 +0,0 @@
-/**
- * Form Types
- */
-/** Field type discriminator */
-export type FieldType = "text" | "textarea" | "radio" | "dropdown" | "checkbox" | "date" | "time" | "number";
-/** Base field interface */
-export interface BaseField {
-    id: string;
-    type: FieldType;
-    label: string;
-    description?: string;
-    required?: boolean;
-    maxLength?: number;
-}
-/** Text field */
-export interface TextField extends BaseField {
-    type: "text";
-    placeholder?: string;
-    validation?: "email" | "url" | "phone" | string;
-    defaultValue?: string;
-    minLength?: number;
-    maxLength?: number;
-}
-/** Textarea field */
-export interface TextareaField extends BaseField {
-    type: "textarea";
-    placeholder?: string;
-    minLength?: number;
-    maxLength?: number;
-    rows?: number;
-    defaultValue?: string;
-}
-/** Radio field */
-export interface RadioField extends BaseField {
-    type: "radio";
-    choices: string[];
-    defaultValue?: string;
-}
-/** Dropdown field */
-export interface DropdownField extends BaseField {
-    type: "dropdown";
-    choices: string[];
-    searchable?: boolean;
-    defaultValue?: string;
-}
-/** Checkbox field */
-export interface CheckboxField extends BaseField {
-    type: "checkbox";
-    choices: string[];
-    minSelections?: number;
-    maxSelections?: number;
-    defaultValue?: string[];
-}
-/** Date field */
-export interface DateField extends BaseField {
-    type: "date";
-    minDate?: string;
-    maxDate?: string;
-    format?: string;
-    defaultValue?: string;
-}
-/** Time field */
-export interface TimeField extends BaseField {
-    type: "time";
-    format?: "12hr" | "24hr";
-    defaultValue?: string;
-}
-/** Number field */
-export interface NumberField extends BaseField {
-    type: "number";
-    min?: number;
-    max?: number;
-    step?: number;
-    defaultValue?: number;
-}
-/** Union type for all fields */
-export type FormField = TextField | TextareaField | RadioField | DropdownField | CheckboxField | DateField | TimeField | NumberField;
-/** Form data stored in result.jsonData */
-export interface FormData {
-    title?: string;
-    description?: string;
-    fields: FormField[];
-}
-/** Arguments passed to the form tool */
-export interface FormArgs {
-    title?: string;
-    description?: string;
-    fields: FormField[];
-}