@quilltap/plugin-types 1.15.0 → 1.16.0

package/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.15.1] - 2026-02-23
+
+### Removed
+
+- **Breaking:** Removed `FILE_BACKEND` / `STORAGE_BACKEND` plugin capability and `STORAGE` plugin category
+- Removed all file-storage plugin types: `FileBackendCapabilities`, `FileBackendMetadata`, `FileMetadata`, `FileStorageBackend`, `FileStorageConfigField`, `FileStorageProviderPlugin`, `FileStoragePluginExport`
+- Removed `FILE_BACKEND` from the `requiresRestart` inference list in `PluginManifest`
+
 ## [1.14.0] - 2026-02-10
 
 ### Added

package/dist/{index-BmwJBg_D.d.mts → index-BGXq7dpd.d.mts}

@@ -459,11 +459,11 @@ interface ProviderPluginExport {
 /**
  * Plugin capability types
  */
-type PluginCapability = 'LLM_PROVIDER' | 'AUTH_PROVIDER' | 'STORAGE_BACKEND' | 'THEME' | 'ROLEPLAY_TEMPLATE' | 'TOOL_PROVIDER' | 'SEARCH_PROVIDER' | 'UTILITY';
+type PluginCapability = 'LLM_PROVIDER' | 'AUTH_PROVIDER' | 'THEME' | 'ROLEPLAY_TEMPLATE' | 'TOOL_PROVIDER' | 'SEARCH_PROVIDER' | 'MODERATION_PROVIDER' | 'UTILITY';
 /**
  * Plugin category
  */
-type PluginCategory = 'PROVIDER' | 'AUTH' | 'STORAGE' | 'UI' | 'TEMPLATE' | 'TOOLS' | 'UTILITY';
+type PluginCategory = 'PROVIDER' | 'AUTH' | 'UI' | 'TEMPLATE' | 'TOOLS' | 'UTILITY';
 /**
  * Plugin status
  */
@@ -532,6 +532,33 @@ interface ProviderConfig {
         description: string;
     };
 }
+/**
+ * Moderation provider-specific configuration (for MODERATION_PROVIDER plugins)
+ */
+interface ModerationProviderConfig {
+    /** Internal provider name (e.g., 'OPENAI') */
+    providerName: string;
+    /** Human-readable display name */
+    displayName: string;
+    /** Provider description */
+    description: string;
+    /** Short abbreviation (2-4 chars) */
+    abbreviation: string;
+    /** UI color configuration */
+    colors: {
+        bg: string;
+        text: string;
+        icon: string;
+    };
+    /** Whether the provider requires an API key */
+    requiresApiKey: boolean;
+    /** Label for API key input */
+    apiKeyLabel?: string;
+    /** Whether the provider requires a base URL */
+    requiresBaseUrl: boolean;
+    /** Default base URL */
+    baseUrlDefault?: string;
+}
 /**
  * Search provider-specific configuration (for SEARCH_PROVIDER plugins)
  */
@@ -617,6 +644,8 @@ interface PluginManifest {
     providerConfig?: ProviderConfig;
     /** Search provider configuration (for SEARCH_PROVIDER plugins) */
     searchProviderConfig?: SearchProviderConfig;
+    /** Moderation provider configuration (for MODERATION_PROVIDER plugins) */
+    moderationProviderConfig?: ModerationProviderConfig;
     /** Required permissions */
     permissions?: PluginPermissions;
     /** Repository URL */
@@ -636,7 +665,7 @@ interface PluginManifest {
      * Whether this plugin requires a server restart to activate.
      *
      * If not specified, this is inferred from capabilities:
-     * - AUTH_METHODS, DATABASE_BACKEND, FILE_BACKEND, UPGRADE_MIGRATION → requires restart
+     * - AUTH_METHODS, DATABASE_BACKEND, UPGRADE_MIGRATION → requires restart
      *
      * Set explicitly to override the inferred value.
      */
@@ -1005,7 +1034,7 @@ interface ThemePlugin {
      * Allows a theme to rename, re-describe, or re-image any of the
      * Foundry subsystem pages. Keys are subsystem IDs:
      * 'foundry' | 'aurora' | 'forge' | 'salon' | 'commonplace-book' |
-     * 'prospero' | 'dangermouse' | 'calliope' | 'lantern'
+     * 'prospero' | 'dangermouse' | 'calliope' | 'lantern' | 'pascal' | 'saquel'
      */
     subsystems?: Partial<Record<string, SubsystemOverrides>>;
     /**
@@ -1429,4 +1458,139 @@ interface SearchProviderPluginExport {
     plugin: SearchProviderPlugin;
 }
 
-export type { AttachmentSupport as A, SearchProviderPlugin as B, CheapModelConfig as C, SearchProviderPluginExport as D, Effects as E, FontDefinition as F, SearchResult as G, Spacing as H, IconProps as I, SubsystemOverrides as J, ThemePlugin as K, LLMProviderPlugin as L, MessageFormatSupport as M, ThemePluginExport as N, ThemeTokens as O, PluginAuthor as P, ToolFormatType as Q, RoleplayTemplateConfig as R, SearchOutput as S, ThemeMetadata as T, Typography as U, AnnotationButton as V, DialogueDetection as W, RenderingPattern as X, ColorPalette as a, EmbeddedFont as b, EmbeddingModelInfo as c, ImageGenerationModelInfo as d, ImageProviderConstraints as e, ImageStyleInfo as f, InstalledPluginInfo as g, ModelInfo as h, PluginCapability as i, PluginCategory as j, PluginCompatibility as k, PluginIconData as l, PluginManifest as m, PluginPermissions as n, PluginStatus as o, ProviderCapabilities as p, ProviderConfig as q, ProviderConfigRequirements as r, ProviderMetadata as s, ProviderPluginExport as t, RoleplayTemplateMetadata as u, RoleplayTemplatePlugin as v, RoleplayTemplatePluginExport as w, SearchProviderConfig as x, SearchProviderConfigRequirements as y, SearchProviderMetadata as z };
+/**
+ * Moderation Provider Plugin types for Quilltap plugin development
+ *
+ * Defines the interfaces and types needed to create pluggable content
+ * moderation backends as Quilltap plugins (e.g., OpenAI moderation endpoint).
+ *
+ * @module @quilltap/plugin-types/plugins/moderation-provider
+ */
+/**
+ * Moderation provider metadata for UI display and identification
+ */
+interface ModerationProviderMetadata {
+    /** Internal identifier for the moderation provider (e.g., 'OPENAI') */
+    providerName: string;
+    /** Human-readable display name for UI (e.g., 'OpenAI Moderation') */
+    displayName: string;
+    /** Short description of the moderation provider */
+    description: string;
+    /** Short abbreviation for icon display (e.g., 'OAI') */
+    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 a moderation provider
+ */
+interface ModerationProviderConfigRequirements {
+    /** Whether this moderation provider requires an API key */
+    requiresApiKey: boolean;
+    /** Label text for API key input field */
+    apiKeyLabel?: string;
+    /** Whether this moderation provider requires a custom base URL */
+    requiresBaseUrl: boolean;
+    /** Default value for base URL (if applicable) */
+    baseUrlDefault?: string;
+}
+/**
+ * A single moderation category result
+ *
+ * Categories are provider-specific (e.g., OpenAI returns 'hate', 'sexual',
+ * 'violence', etc.; other providers may return different categories).
+ */
+interface ModerationCategoryResult {
+    /** Category name as returned by the provider (e.g., 'sexual', 'violence', 'hate') */
+    category: string;
+    /** Whether this specific category was flagged */
+    flagged: boolean;
+    /** Confidence score for this category (0-1) */
+    score: number;
+}
+/**
+ * Result from a moderation provider's content classification
+ *
+ * This is the generic result type returned by all moderation providers.
+ * The categories array contains provider-specific category names and scores.
+ * The consuming system (Dangermouse) maps these to its own category structure.
+ */
+interface ModerationResult {
+    /** Whether the content was flagged by the moderation provider */
+    flagged: boolean;
+    /** Per-category breakdown with provider-specific category names */
+    categories: ModerationCategoryResult[];
+}
+/**
+ * Main Moderation Provider Plugin Interface
+ *
+ * Plugins implementing this interface provide content moderation backends
+ * for Quilltap's Dangermouse system. The moderation provider is used
+ * as an alternative to the Cheap LLM classification approach.
+ *
+ * @example
+ * ```typescript
+ * import type { ModerationProviderPlugin } from '@quilltap/plugin-types';
+ *
+ * export const moderationPlugin: ModerationProviderPlugin = {
+ *   metadata: {
+ *     providerName: 'OPENAI',
+ *     displayName: 'OpenAI Moderation',
+ *     description: 'Free content moderation via OpenAI moderation endpoint',
+ *     abbreviation: 'OAI',
+ *     colors: { bg: 'bg-green-100', text: 'text-green-800', icon: 'text-green-600' },
+ *   },
+ *   config: {
+ *     requiresApiKey: true,
+ *     apiKeyLabel: 'OpenAI API Key',
+ *     requiresBaseUrl: false,
+ *   },
+ *   moderate: async (content, apiKey) => {
+ *     // ... call moderation API ...
+ *     return { flagged: false, categories: [] };
+ *   },
+ * };
+ * ```
+ */
+interface ModerationProviderPlugin {
+    /** Moderation provider metadata for UI display and identification */
+    metadata: ModerationProviderMetadata;
+    /** Configuration requirements for this moderation provider */
+    config: ModerationProviderConfigRequirements;
+    /**
+     * Classify content for moderation
+     *
+     * @param content The text content to classify
+     * @param apiKey The API key for authentication
+     * @param baseUrl Optional base URL for the moderation API
+     * @returns Promise resolving to moderation result with flagged status and categories
+     */
+    moderate: (content: string, apiKey: string, baseUrl?: string) => Promise<ModerationResult>;
+    /**
+     * Validate an API key for this moderation provider (optional)
+     *
+     * Should test the API key by making a minimal API call to verify
+     * that it is valid and has proper permissions.
+     *
+     * @param apiKey The API key to validate
+     * @param baseUrl Optional base URL for the moderation API
+     * @returns Promise resolving to true if valid, false otherwise
+     */
+    validateApiKey?: (apiKey: string, baseUrl?: string) => Promise<boolean>;
+}
+/**
+ * Standard export type for moderation provider plugins
+ */
+interface ModerationProviderPluginExport {
+    /** The moderation provider plugin instance */
+    moderationPlugin: ModerationProviderPlugin;
+}
+
+export type { AnnotationButton as $, AttachmentSupport as A, RoleplayTemplateMetadata as B, CheapModelConfig as C, RoleplayTemplatePlugin as D, Effects as E, FontDefinition as F, RoleplayTemplatePluginExport as G, SearchProviderConfig as H, IconProps as I, SearchProviderConfigRequirements as J, SearchProviderMetadata as K, LLMProviderPlugin as L, MessageFormatSupport as M, SearchProviderPlugin as N, SearchProviderPluginExport as O, PluginAuthor as P, SearchResult as Q, RoleplayTemplateConfig as R, SearchOutput as S, Spacing as T, SubsystemOverrides as U, ThemeMetadata as V, ThemePlugin as W, ThemePluginExport as X, ThemeTokens as Y, ToolFormatType as Z, Typography as _, ColorPalette as a, DialogueDetection as a0, ModerationProviderConfig as a1, RenderingPattern as a2, EmbeddedFont as b, EmbeddingModelInfo as c, ImageGenerationModelInfo as d, ImageProviderConstraints as e, ImageStyleInfo as f, InstalledPluginInfo as g, ModelInfo as h, ModerationCategoryResult as i, ModerationProviderConfigRequirements as j, ModerationProviderMetadata as k, ModerationProviderPlugin as l, ModerationProviderPluginExport as m, ModerationResult as n, PluginCapability as o, PluginCategory as p, PluginCompatibility as q, PluginIconData as r, PluginManifest as s, PluginPermissions as t, PluginStatus as u, ProviderCapabilities as v, ProviderConfig as w, ProviderConfigRequirements as x, ProviderMetadata as y, ProviderPluginExport as z };

package/dist/{index-XZ8WkWjp.d.ts → index-CeYb2BY9.d.ts}

@@ -459,11 +459,11 @@ interface ProviderPluginExport {
 /**
  * Plugin capability types
  */
-type PluginCapability = 'LLM_PROVIDER' | 'AUTH_PROVIDER' | 'STORAGE_BACKEND' | 'THEME' | 'ROLEPLAY_TEMPLATE' | 'TOOL_PROVIDER' | 'SEARCH_PROVIDER' | 'UTILITY';
+type PluginCapability = 'LLM_PROVIDER' | 'AUTH_PROVIDER' | 'THEME' | 'ROLEPLAY_TEMPLATE' | 'TOOL_PROVIDER' | 'SEARCH_PROVIDER' | 'MODERATION_PROVIDER' | 'UTILITY';
 /**
  * Plugin category
  */
-type PluginCategory = 'PROVIDER' | 'AUTH' | 'STORAGE' | 'UI' | 'TEMPLATE' | 'TOOLS' | 'UTILITY';
+type PluginCategory = 'PROVIDER' | 'AUTH' | 'UI' | 'TEMPLATE' | 'TOOLS' | 'UTILITY';
 /**
  * Plugin status
  */
@@ -532,6 +532,33 @@ interface ProviderConfig {
         description: string;
     };
 }
+/**
+ * Moderation provider-specific configuration (for MODERATION_PROVIDER plugins)
+ */
+interface ModerationProviderConfig {
+    /** Internal provider name (e.g., 'OPENAI') */
+    providerName: string;
+    /** Human-readable display name */
+    displayName: string;
+    /** Provider description */
+    description: string;
+    /** Short abbreviation (2-4 chars) */
+    abbreviation: string;
+    /** UI color configuration */
+    colors: {
+        bg: string;
+        text: string;
+        icon: string;
+    };
+    /** Whether the provider requires an API key */
+    requiresApiKey: boolean;
+    /** Label for API key input */
+    apiKeyLabel?: string;
+    /** Whether the provider requires a base URL */
+    requiresBaseUrl: boolean;
+    /** Default base URL */
+    baseUrlDefault?: string;
+}
 /**
  * Search provider-specific configuration (for SEARCH_PROVIDER plugins)
  */
@@ -617,6 +644,8 @@ interface PluginManifest {
     providerConfig?: ProviderConfig;
     /** Search provider configuration (for SEARCH_PROVIDER plugins) */
     searchProviderConfig?: SearchProviderConfig;
+    /** Moderation provider configuration (for MODERATION_PROVIDER plugins) */
+    moderationProviderConfig?: ModerationProviderConfig;
     /** Required permissions */
     permissions?: PluginPermissions;
     /** Repository URL */
@@ -636,7 +665,7 @@ interface PluginManifest {
      * Whether this plugin requires a server restart to activate.
      *
      * If not specified, this is inferred from capabilities:
-     * - AUTH_METHODS, DATABASE_BACKEND, FILE_BACKEND, UPGRADE_MIGRATION → requires restart
+     * - AUTH_METHODS, DATABASE_BACKEND, UPGRADE_MIGRATION → requires restart
      *
      * Set explicitly to override the inferred value.
      */
@@ -1005,7 +1034,7 @@ interface ThemePlugin {
      * Allows a theme to rename, re-describe, or re-image any of the
      * Foundry subsystem pages. Keys are subsystem IDs:
      * 'foundry' | 'aurora' | 'forge' | 'salon' | 'commonplace-book' |
-     * 'prospero' | 'dangermouse' | 'calliope' | 'lantern'
+     * 'prospero' | 'dangermouse' | 'calliope' | 'lantern' | 'pascal' | 'saquel'
      */
     subsystems?: Partial<Record<string, SubsystemOverrides>>;
     /**
@@ -1429,4 +1458,139 @@ interface SearchProviderPluginExport {
     plugin: SearchProviderPlugin;
 }
 
-export type { AttachmentSupport as A, SearchProviderPlugin as B, CheapModelConfig as C, SearchProviderPluginExport as D, Effects as E, FontDefinition as F, SearchResult as G, Spacing as H, IconProps as I, SubsystemOverrides as J, ThemePlugin as K, LLMProviderPlugin as L, MessageFormatSupport as M, ThemePluginExport as N, ThemeTokens as O, PluginAuthor as P, ToolFormatType as Q, RoleplayTemplateConfig as R, SearchOutput as S, ThemeMetadata as T, Typography as U, AnnotationButton as V, DialogueDetection as W, RenderingPattern as X, ColorPalette as a, EmbeddedFont as b, EmbeddingModelInfo as c, ImageGenerationModelInfo as d, ImageProviderConstraints as e, ImageStyleInfo as f, InstalledPluginInfo as g, ModelInfo as h, PluginCapability as i, PluginCategory as j, PluginCompatibility as k, PluginIconData as l, PluginManifest as m, PluginPermissions as n, PluginStatus as o, ProviderCapabilities as p, ProviderConfig as q, ProviderConfigRequirements as r, ProviderMetadata as s, ProviderPluginExport as t, RoleplayTemplateMetadata as u, RoleplayTemplatePlugin as v, RoleplayTemplatePluginExport as w, SearchProviderConfig as x, SearchProviderConfigRequirements as y, SearchProviderMetadata as z };
+/**
+ * Moderation Provider Plugin types for Quilltap plugin development
+ *
+ * Defines the interfaces and types needed to create pluggable content
+ * moderation backends as Quilltap plugins (e.g., OpenAI moderation endpoint).
+ *
+ * @module @quilltap/plugin-types/plugins/moderation-provider
+ */
+/**
+ * Moderation provider metadata for UI display and identification
+ */
+interface ModerationProviderMetadata {
+    /** Internal identifier for the moderation provider (e.g., 'OPENAI') */
+    providerName: string;
+    /** Human-readable display name for UI (e.g., 'OpenAI Moderation') */
+    displayName: string;
+    /** Short description of the moderation provider */
+    description: string;
+    /** Short abbreviation for icon display (e.g., 'OAI') */
+    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 a moderation provider
+ */
+interface ModerationProviderConfigRequirements {
+    /** Whether this moderation provider requires an API key */
+    requiresApiKey: boolean;
+    /** Label text for API key input field */
+    apiKeyLabel?: string;
+    /** Whether this moderation provider requires a custom base URL */
+    requiresBaseUrl: boolean;
+    /** Default value for base URL (if applicable) */
+    baseUrlDefault?: string;
+}
+/**
+ * A single moderation category result
+ *
+ * Categories are provider-specific (e.g., OpenAI returns 'hate', 'sexual',
+ * 'violence', etc.; other providers may return different categories).
+ */
+interface ModerationCategoryResult {
+    /** Category name as returned by the provider (e.g., 'sexual', 'violence', 'hate') */
+    category: string;
+    /** Whether this specific category was flagged */
+    flagged: boolean;
+    /** Confidence score for this category (0-1) */
+    score: number;
+}
+/**
+ * Result from a moderation provider's content classification
+ *
+ * This is the generic result type returned by all moderation providers.
+ * The categories array contains provider-specific category names and scores.
+ * The consuming system (Dangermouse) maps these to its own category structure.
+ */
+interface ModerationResult {
+    /** Whether the content was flagged by the moderation provider */
+    flagged: boolean;
+    /** Per-category breakdown with provider-specific category names */
+    categories: ModerationCategoryResult[];
+}
+/**
+ * Main Moderation Provider Plugin Interface
+ *
+ * Plugins implementing this interface provide content moderation backends
+ * for Quilltap's Dangermouse system. The moderation provider is used
+ * as an alternative to the Cheap LLM classification approach.
+ *
+ * @example
+ * ```typescript
+ * import type { ModerationProviderPlugin } from '@quilltap/plugin-types';
+ *
+ * export const moderationPlugin: ModerationProviderPlugin = {
+ *   metadata: {
+ *     providerName: 'OPENAI',
+ *     displayName: 'OpenAI Moderation',
+ *     description: 'Free content moderation via OpenAI moderation endpoint',
+ *     abbreviation: 'OAI',
+ *     colors: { bg: 'bg-green-100', text: 'text-green-800', icon: 'text-green-600' },
+ *   },
+ *   config: {
+ *     requiresApiKey: true,
+ *     apiKeyLabel: 'OpenAI API Key',
+ *     requiresBaseUrl: false,
+ *   },
+ *   moderate: async (content, apiKey) => {
+ *     // ... call moderation API ...
+ *     return { flagged: false, categories: [] };
+ *   },
+ * };
+ * ```
+ */
+interface ModerationProviderPlugin {
+    /** Moderation provider metadata for UI display and identification */
+    metadata: ModerationProviderMetadata;
+    /** Configuration requirements for this moderation provider */
+    config: ModerationProviderConfigRequirements;
+    /**
+     * Classify content for moderation
+     *
+     * @param content The text content to classify
+     * @param apiKey The API key for authentication
+     * @param baseUrl Optional base URL for the moderation API
+     * @returns Promise resolving to moderation result with flagged status and categories
+     */
+    moderate: (content: string, apiKey: string, baseUrl?: string) => Promise<ModerationResult>;
+    /**
+     * Validate an API key for this moderation provider (optional)
+     *
+     * Should test the API key by making a minimal API call to verify
+     * that it is valid and has proper permissions.
+     *
+     * @param apiKey The API key to validate
+     * @param baseUrl Optional base URL for the moderation API
+     * @returns Promise resolving to true if valid, false otherwise
+     */
+    validateApiKey?: (apiKey: string, baseUrl?: string) => Promise<boolean>;
+}
+/**
+ * Standard export type for moderation provider plugins
+ */
+interface ModerationProviderPluginExport {
+    /** The moderation provider plugin instance */
+    moderationPlugin: ModerationProviderPlugin;
+}
+
+export type { AnnotationButton as $, AttachmentSupport as A, RoleplayTemplateMetadata as B, CheapModelConfig as C, RoleplayTemplatePlugin as D, Effects as E, FontDefinition as F, RoleplayTemplatePluginExport as G, SearchProviderConfig as H, IconProps as I, SearchProviderConfigRequirements as J, SearchProviderMetadata as K, LLMProviderPlugin as L, MessageFormatSupport as M, SearchProviderPlugin as N, SearchProviderPluginExport as O, PluginAuthor as P, SearchResult as Q, RoleplayTemplateConfig as R, SearchOutput as S, Spacing as T, SubsystemOverrides as U, ThemeMetadata as V, ThemePlugin as W, ThemePluginExport as X, ThemeTokens as Y, ToolFormatType as Z, Typography as _, ColorPalette as a, DialogueDetection as a0, ModerationProviderConfig as a1, RenderingPattern as a2, EmbeddedFont as b, EmbeddingModelInfo as c, ImageGenerationModelInfo as d, ImageProviderConstraints as e, ImageStyleInfo as f, InstalledPluginInfo as g, ModelInfo as h, ModerationCategoryResult as i, ModerationProviderConfigRequirements as j, ModerationProviderMetadata as k, ModerationProviderPlugin as l, ModerationProviderPluginExport as m, ModerationResult as n, PluginCapability as o, PluginCategory as p, PluginCompatibility as q, PluginIconData as r, PluginManifest as s, PluginPermissions as t, PluginStatus as u, ProviderCapabilities as v, ProviderConfig as w, ProviderConfigRequirements as x, ProviderMetadata as y, ProviderPluginExport as z };