@quilltap/plugin-types 1.0.1 → 1.0.3

package/dist/plugins/index.d.ts

@@ -1,442 +1,3 @@
-import { ReactNode } from 'react';
-import { LLMProvider, ImageGenProvider, ToolFormatOptions, ToolCallRequest } from '../llm/index.js';
-
-/**
- * Provider Plugin Interface types for Quilltap plugin development
- *
- * @module @quilltap/plugin-types/plugins/provider
- */
-
-/**
- * Provider metadata for UI display and identification
- */
-interface ProviderMetadata {
-    /** Internal identifier for the provider (e.g., 'OPENAI', 'ANTHROPIC') */
-    providerName: string;
-    /** Human-readable display name for UI (e.g., 'OpenAI', 'Anthropic') */
-    displayName: string;
-    /** Short description of the provider */
-    description: string;
-    /** Short abbreviation for icon display (e.g., 'OAI', 'ANT') */
-    abbreviation: string;
-    /** Tailwind CSS color classes for UI styling */
-    colors: {
-        /** Background color class (e.g., 'bg-green-100') */
-        bg: string;
-        /** Text color class (e.g., 'text-green-800') */
-        text: string;
-        /** Icon color class (e.g., 'text-green-600') */
-        icon: string;
-    };
-}
-/**
- * Configuration requirements for the provider
- */
-interface ProviderConfigRequirements {
-    /** Whether this provider requires an API key */
-    requiresApiKey: boolean;
-    /** Whether this provider requires a custom base URL */
-    requiresBaseUrl: boolean;
-    /** Label text for API key input field */
-    apiKeyLabel?: string;
-    /** Label text for base URL input field */
-    baseUrlLabel?: string;
-    /** Placeholder text for base URL input */
-    baseUrlPlaceholder?: string;
-    /** Default value for base URL */
-    baseUrlDefault?: string;
-    /** Deprecated: use baseUrlDefault instead */
-    defaultBaseUrl?: string;
-}
-/**
- * Provider capability flags
- */
-interface ProviderCapabilities {
-    /** Whether the provider supports chat completions */
-    chat: boolean;
-    /** Whether the provider supports image generation */
-    imageGeneration: boolean;
-    /** Whether the provider supports text embeddings */
-    embeddings: boolean;
-    /** Whether the provider supports web search functionality */
-    webSearch: boolean;
-}
-/**
- * Attachment/file support configuration
- */
-interface AttachmentSupport {
-    /** Whether this provider supports file attachments */
-    supportsAttachments: boolean;
-    /** Array of MIME types supported for attachments */
-    supportedMimeTypes: string[];
-    /** Human-readable description of attachment support */
-    description: string;
-    /** Additional notes about attachment support or limitations */
-    notes?: string;
-    /** Maximum file size in bytes */
-    maxFileSize?: number;
-    /** Maximum number of files per request */
-    maxFiles?: number;
-}
-/**
- * Information about a specific model
- */
-interface ModelInfo {
-    /** Unique identifier for the model */
-    id: string;
-    /** Human-readable name of the model */
-    name: string;
-    /** Context window size (tokens) */
-    contextWindow?: number;
-    /** Maximum output tokens for this model */
-    maxOutputTokens?: number;
-    /** Whether this model supports image attachments */
-    supportsImages?: boolean;
-    /** Whether this model supports tool/function calling */
-    supportsTools?: boolean;
-    /** Description of the model */
-    description?: string;
-    /** Pricing information */
-    pricing?: {
-        /** Price per 1M input tokens */
-        input: number;
-        /** Price per 1M output tokens */
-        output: number;
-    };
-}
-/**
- * Information about an embedding model
- */
-interface EmbeddingModelInfo {
-    /** Unique identifier for the embedding model */
-    id: string;
-    /** Human-readable name of the model */
-    name: string;
-    /** Dimensions of the embedding vector output */
-    dimensions?: number;
-    /** Description of the model's characteristics */
-    description?: string;
-}
-/**
- * Information about an image generation model
- */
-interface ImageGenerationModelInfo {
-    /** Unique identifier for the model */
-    id: string;
-    /** Human-readable name of the model */
-    name: string;
-    /** Supported aspect ratios (e.g., ['1:1', '16:9']) */
-    supportedAspectRatios?: string[];
-    /** Supported image sizes (e.g., ['1024x1024', '512x512']) */
-    supportedSizes?: string[];
-    /** Description of the model */
-    description?: string;
-}
-/**
- * Constraints for image generation
- */
-interface ImageProviderConstraints {
-    /** Maximum bytes allowed for image generation prompt */
-    maxPromptBytes?: number;
-    /** Warning message about prompt constraints */
-    promptConstraintWarning?: string;
-    /** Maximum images per request */
-    maxImagesPerRequest?: number;
-    /** Supported aspect ratios */
-    supportedAspectRatios?: string[];
-    /** Supported image sizes */
-    supportedSizes?: string[];
-}
-/**
- * Icon component props
- */
-interface IconProps {
-    /** CSS class for styling */
-    className?: string;
-}
-/**
- * Main LLM Provider Plugin Interface
- *
- * Plugins implementing this interface can be dynamically loaded
- * by Quilltap to provide LLM functionality from various providers.
- *
- * @example
- * ```typescript
- * import type { LLMProviderPlugin } from '@quilltap/plugin-types';
- *
- * export const plugin: LLMProviderPlugin = {
- *   metadata: {
- *     providerName: 'MY_PROVIDER',
- *     displayName: 'My Provider',
- *     description: 'Custom LLM provider',
- *     abbreviation: 'MYP',
- *     colors: { bg: 'bg-blue-100', text: 'text-blue-800', icon: 'text-blue-600' },
- *   },
- *   config: {
- *     requiresApiKey: true,
- *     requiresBaseUrl: false,
- *     apiKeyLabel: 'API Key',
- *   },
- *   capabilities: {
- *     chat: true,
- *     imageGeneration: false,
- *     embeddings: false,
- *     webSearch: false,
- *   },
- *   attachmentSupport: {
- *     supportsAttachments: false,
- *     supportedMimeTypes: [],
- *     description: 'No file attachments supported',
- *   },
- *   createProvider: () => new MyProvider(),
- *   getAvailableModels: async (apiKey) => [...],
- *   validateApiKey: async (apiKey) => {...},
- *   renderIcon: ({ className }) => <MyIcon className={className} />,
- * };
- * ```
- */
-interface LLMProviderPlugin {
-    /** Provider metadata for UI display and identification */
-    metadata: ProviderMetadata;
-    /** Configuration requirements for this provider */
-    config: ProviderConfigRequirements;
-    /** Supported capabilities for this provider */
-    capabilities: ProviderCapabilities;
-    /** File attachment support information */
-    attachmentSupport: AttachmentSupport;
-    /**
-     * Factory method to create an LLMProvider instance
-     * @param baseUrl Optional base URL for the provider
-     */
-    createProvider: (baseUrl?: string) => LLMProvider;
-    /**
-     * Factory method to create an ImageGenProvider instance (optional)
-     * Only required if capabilities.imageGeneration is true
-     * @param baseUrl Optional base URL for the provider
-     */
-    createImageProvider?: (baseUrl?: string) => ImageGenProvider;
-    /**
-     * Factory method to create an embedding provider (optional)
-     * Only required if capabilities.embeddings is true
-     * @param baseUrl Optional base URL for the provider
-     */
-    createEmbeddingProvider?: (baseUrl?: string) => unknown;
-    /**
-     * Get list of available models for this provider
-     * @param apiKey API key for authentication
-     * @param baseUrl Optional base URL
-     */
-    getAvailableModels: (apiKey: string, baseUrl?: string) => Promise<string[]>;
-    /**
-     * Get static model information without API calls
-     */
-    getModelInfo?: () => ModelInfo[];
-    /**
-     * Get embedding models supported by this provider
-     */
-    getEmbeddingModels?: () => EmbeddingModelInfo[];
-    /**
-     * Get image generation models supported by this provider
-     */
-    getImageGenerationModels?: () => ImageGenerationModelInfo[];
-    /**
-     * Validate an API key for this provider
-     * @param apiKey API key to validate
-     * @param baseUrl Optional base URL
-     */
-    validateApiKey: (apiKey: string, baseUrl?: string) => Promise<boolean>;
-    /**
-     * Render the provider icon as a React component
-     * @param props Icon component props
-     */
-    renderIcon: (props: IconProps) => ReactNode;
-    /**
-     * Convert universal tool format to provider-specific format (optional)
-     * @param tool Tools in OpenAI format or generic objects
-     * @param options Formatting options
-     */
-    formatTools?: (tool: any, options?: ToolFormatOptions) => any;
-    /**
-     * Parse provider-specific tool calls from response (optional)
-     * @param response Raw API response
-     */
-    parseToolCalls?: (response: any) => ToolCallRequest[];
-    /**
-     * Get image provider constraints (optional)
-     * Only applicable for providers with imageGeneration capability
-     */
-    getImageProviderConstraints?: () => ImageProviderConstraints;
-}
-/**
- * Standard export type for provider plugins
- */
-interface ProviderPluginExport {
-    /** The provider plugin instance */
-    plugin: LLMProviderPlugin;
-}
-
-/**
- * Plugin Manifest types for Quilltap plugin development
- *
- * @module @quilltap/plugin-types/plugins/manifest
- */
-/**
- * Plugin capability types
- */
-type PluginCapability = 'LLM_PROVIDER' | 'AUTH_PROVIDER' | 'STORAGE_BACKEND' | 'THEME' | 'UTILITY';
-/**
- * Plugin category
- */
-type PluginCategory = 'PROVIDER' | 'AUTH' | 'STORAGE' | 'UI' | 'UTILITY';
-/**
- * Plugin status
- */
-type PluginStatus = 'STABLE' | 'BETA' | 'EXPERIMENTAL' | 'DEPRECATED';
-/**
- * Author information
- */
-interface PluginAuthor {
-    /** Author name */
-    name: string;
-    /** Author email */
-    email?: string;
-    /** Author website or profile URL */
-    url?: string;
-}
-/**
- * Compatibility requirements
- */
-interface PluginCompatibility {
-    /** Minimum Quilltap version (semver range) */
-    quilltapVersion: string;
-    /** Minimum Node.js version (semver range) */
-    nodeVersion?: string;
-}
-/**
- * Provider-specific configuration (for LLM_PROVIDER plugins)
- */
-interface ProviderConfig {
-    /** Internal provider name */
-    providerName: string;
-    /** Human-readable display name */
-    displayName: string;
-    /** Provider description */
-    description: string;
-    /** Short abbreviation */
-    abbreviation: string;
-    /** UI color configuration */
-    colors: {
-        bg: string;
-        text: string;
-        icon: string;
-    };
-    /** Whether the provider requires an API key */
-    requiresApiKey: boolean;
-    /** Whether the provider requires a base URL */
-    requiresBaseUrl: boolean;
-    /** Label for API key input */
-    apiKeyLabel?: string;
-    /** Provider capabilities */
-    capabilities: {
-        chat: boolean;
-        imageGeneration: boolean;
-        embeddings: boolean;
-        webSearch: boolean;
-    };
-    /** Attachment support configuration */
-    attachmentSupport: {
-        supported: boolean;
-        mimeTypes: string[];
-        description: string;
-    };
-}
-/**
- * Required permissions for the plugin
- */
-interface PluginPermissions {
-    /** Network domains the plugin may access */
-    network?: string[];
-    /** Whether the plugin accesses user data */
-    userData?: boolean;
-    /** Whether the plugin accesses the database */
-    database?: boolean;
-    /** Whether the plugin accesses the file system */
-    fileSystem?: boolean;
-}
-/**
- * Plugin manifest schema
- *
- * This is the structure of the quilltap-manifest.json file
- * that every Quilltap plugin must include.
- */
-interface PluginManifest {
-    /** JSON schema reference */
-    $schema?: string;
-    /** Package name (must start with qtap-plugin-) */
-    name: string;
-    /** Human-readable title */
-    title: string;
-    /** Plugin description */
-    description: string;
-    /** Semantic version */
-    version: string;
-    /** Author information */
-    author: PluginAuthor;
-    /** License identifier (SPDX) */
-    license: string;
-    /** Compatibility requirements */
-    compatibility: PluginCompatibility;
-    /** Plugin capabilities */
-    capabilities: PluginCapability[];
-    /** Plugin category */
-    category: PluginCategory;
-    /** Main entry point (relative path) */
-    main: string;
-    /** Whether TypeScript source is available */
-    typescript?: boolean;
-    /** Frontend framework used */
-    frontend?: 'REACT' | 'NONE';
-    /** Styling approach used */
-    styling?: 'TAILWIND' | 'CSS' | 'NONE';
-    /** Whether to enable by default when installed */
-    enabledByDefault?: boolean;
-    /** Plugin status */
-    status: PluginStatus;
-    /** Search keywords */
-    keywords?: string[];
-    /** Provider-specific configuration (for LLM_PROVIDER plugins) */
-    providerConfig?: ProviderConfig;
-    /** Required permissions */
-    permissions?: PluginPermissions;
-    /** Repository URL */
-    repository?: string | {
-        type: string;
-        url: string;
-        directory?: string;
-    };
-    /** Homepage URL */
-    homepage?: string;
-    /** Bug tracker URL */
-    bugs?: string | {
-        url: string;
-        email?: string;
-    };
-}
-/**
- * Installed plugin metadata
- * Extended manifest with installation-specific information
- */
-interface InstalledPluginInfo extends PluginManifest {
-    /** Whether the plugin is currently enabled */
-    enabled: boolean;
-    /** Installation timestamp */
-    installedAt?: string;
-    /** Last update timestamp */
-    updatedAt?: string;
-    /** Installation scope */
-    scope?: 'site' | 'user';
-    /** Path to installed plugin */
-    installPath?: string;
-}
-
-export type { AttachmentSupport, EmbeddingModelInfo, IconProps, ImageGenerationModelInfo, ImageProviderConstraints, InstalledPluginInfo, LLMProviderPlugin, ModelInfo, PluginAuthor, PluginCapability, PluginCategory, PluginCompatibility, PluginManifest, PluginPermissions, PluginStatus, ProviderCapabilities, ProviderConfig, ProviderConfigRequirements, ProviderMetadata, ProviderPluginExport };
+export { A as AttachmentSupport, E as EmbeddingModelInfo, d as IconProps, I as ImageGenerationModelInfo, c as ImageProviderConstraints, o as InstalledPluginInfo, L as LLMProviderPlugin, M as ModelInfo, j as PluginAuthor, g as PluginCapability, h as PluginCategory, k as PluginCompatibility, n as PluginManifest, m as PluginPermissions, i as PluginStatus, b as ProviderCapabilities, l as ProviderConfig, a as ProviderConfigRequirements, P as ProviderMetadata, e as ProviderPluginExport } from '../index-yK-qJDls.js';
+import 'react';
+import '../llm/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quilltap/plugin-types",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Type definitions for Quilltap plugin development",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",