@quilltap/plugin-types 1.2.0 → 1.4.0

package/CHANGELOG.md

@@ -5,6 +5,28 @@ 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.4.0] - 2026-01-02
+
+### Added
+
+- Added `AnnotationButton` interface for roleplay template annotation buttons:
+  - `label: string` - Full name for tooltip (e.g., "Narration", "Internal Monologue")
+  - `abbrev: string` - Abbreviated label for button display (e.g., "Nar", "Int", "OOC")
+  - `prefix: string` - Opening delimiter (e.g., "[", "{", "// ")
+  - `suffix: string` - Closing delimiter (e.g., "]", "}", "")
+- Added `annotationButtons?: AnnotationButton[]` field to `RoleplayTemplateConfig` interface
+  - Enables roleplay template plugins to define custom annotation formatting buttons
+  - Used by the Document Editing Mode formatting toolbar
+
+## [1.3.0] - 2026-01-02
+
+### Added
+
+- Added `requiresRestart?: boolean` field to `PluginManifest` interface
+  - Optional field to indicate if a plugin requires a server restart to activate
+  - If not specified, restart requirement is inferred from capabilities (AUTH_METHODS, DATABASE_BACKEND, FILE_BACKEND, UPGRADE_MIGRATION)
+  - Used by hosted deployments to enforce site-wide installation for restart-requiring plugins
+
 ## [1.2.0] - 2025-12-31
 
 ### Added

package/dist/{index-DkdHzVYa.d.mts → index-BH5jVqB9.d.mts}

@@ -475,6 +475,15 @@ interface PluginManifest {
         url: string;
         email?: string;
     };
+    /**
+     * 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
+     *
+     * Set explicitly to override the inferred value.
+     */
+    requiresRestart?: boolean;
 }
 /**
  * Installed plugin metadata
@@ -836,6 +845,22 @@ interface ThemePluginExport {
  *
  * @module @quilltap/plugin-types/plugins/roleplay-template
  */
+/**
+ * Configuration for an annotation button in the formatting toolbar.
+ *
+ * Annotation buttons allow users to insert roleplay formatting
+ * (e.g., narration brackets, OOC markers) with a single click.
+ */
+interface AnnotationButton {
+    /** Full name displayed in tooltip (e.g., "Narration", "Internal Monologue") */
+    label: string;
+    /** Abbreviated label displayed on button (e.g., "Nar", "Int", "OOC") */
+    abbrev: string;
+    /** Opening delimiter (e.g., "[", "*", "{{") */
+    prefix: string;
+    /** Closing delimiter (e.g., "]", "*", "}}") - empty string for line-end delimiters */
+    suffix: string;
+}
 /**
  * Configuration for a single roleplay template
  *
@@ -854,6 +879,20 @@ interface RoleplayTemplateConfig {
     systemPrompt: string;
     /** Tags for categorization and searchability */
     tags?: string[];
+    /**
+     * Annotation buttons for the formatting toolbar.
+     * Defines which formatting options are available when document editing mode is enabled.
+     *
+     * @example
+     * ```typescript
+     * annotationButtons: [
+     *   { label: 'Narration', abbrev: 'Nar', prefix: '[', suffix: ']' },
+     *   { label: 'Internal Monologue', abbrev: 'Int', prefix: '{', suffix: '}' },
+     *   { label: 'Out of Character', abbrev: 'OOC', prefix: '// ', suffix: '' },
+     * ]
+     * ```
+     */
+    annotationButtons?: AnnotationButton[];
 }
 /**
  * Metadata for a roleplay template plugin

package/dist/{index-GOH-2K-k.d.ts → index-C0tKQeeQ.d.ts}

@@ -475,6 +475,15 @@ interface PluginManifest {
         url: string;
         email?: string;
     };
+    /**
+     * 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
+     *
+     * Set explicitly to override the inferred value.
+     */
+    requiresRestart?: boolean;
 }
 /**
  * Installed plugin metadata
@@ -836,6 +845,22 @@ interface ThemePluginExport {
  *
  * @module @quilltap/plugin-types/plugins/roleplay-template
  */
+/**
+ * Configuration for an annotation button in the formatting toolbar.
+ *
+ * Annotation buttons allow users to insert roleplay formatting
+ * (e.g., narration brackets, OOC markers) with a single click.
+ */
+interface AnnotationButton {
+    /** Full name displayed in tooltip (e.g., "Narration", "Internal Monologue") */
+    label: string;
+    /** Abbreviated label displayed on button (e.g., "Nar", "Int", "OOC") */
+    abbrev: string;
+    /** Opening delimiter (e.g., "[", "*", "{{") */
+    prefix: string;
+    /** Closing delimiter (e.g., "]", "*", "}}") - empty string for line-end delimiters */
+    suffix: string;
+}
 /**
  * Configuration for a single roleplay template
  *
@@ -854,6 +879,20 @@ interface RoleplayTemplateConfig {
     systemPrompt: string;
     /** Tags for categorization and searchability */
     tags?: string[];
+    /**
+     * Annotation buttons for the formatting toolbar.
+     * Defines which formatting options are available when document editing mode is enabled.
+     *
+     * @example
+     * ```typescript
+     * annotationButtons: [
+     *   { label: 'Narration', abbrev: 'Nar', prefix: '[', suffix: ']' },
+     *   { label: 'Internal Monologue', abbrev: 'Int', prefix: '{', suffix: '}' },
+     *   { label: 'Out of Character', abbrev: 'OOC', prefix: '// ', suffix: '' },
+     * ]
+     * ```
+     */
+    annotationButtons?: AnnotationButton[];
 }
 /**
  * Metadata for a roleplay template plugin

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 export { AnthropicToolDefinition, AttachmentResults, CacheUsage, FileAttachment, GeneratedImage, GoogleToolDefinition, ImageGenParams, ImageGenProvider, ImageGenResponse, JSONSchemaDefinition, LLMMessage, LLMParams, LLMProvider, LLMResponse, ModelMetadata, ModelWarning, ModelWarningLevel, OpenAIToolDefinition, ResponseFormat, StreamChunk, TokenUsage, ToolCall, ToolCallRequest, ToolFormatOptions, ToolResult, UniversalTool } from './llm/index.mjs';
-export { A as AttachmentSupport, C as CheapModelConfig, p as ColorPalette, r as Effects, t as EmbeddedFont, E as EmbeddingModelInfo, F as FontDefinition, d as IconProps, I as ImageGenerationModelInfo, c as ImageProviderConstraints, o as InstalledPluginInfo, L as LLMProviderPlugin, f as MessageFormatSupport, 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, R as RoleplayTemplateConfig, x as RoleplayTemplateMetadata, y as RoleplayTemplatePlugin, z as RoleplayTemplatePluginExport, S as Spacing, u as ThemeMetadata, v as ThemePlugin, w as ThemePluginExport, s as ThemeTokens, T as ToolFormatType, q as Typography } from './index-DkdHzVYa.mjs';
+export { A as AttachmentSupport, C as CheapModelConfig, p as ColorPalette, r as Effects, t as EmbeddedFont, E as EmbeddingModelInfo, F as FontDefinition, d as IconProps, I as ImageGenerationModelInfo, c as ImageProviderConstraints, o as InstalledPluginInfo, L as LLMProviderPlugin, f as MessageFormatSupport, 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, R as RoleplayTemplateConfig, x as RoleplayTemplateMetadata, y as RoleplayTemplatePlugin, z as RoleplayTemplatePluginExport, S as Spacing, u as ThemeMetadata, v as ThemePlugin, w as ThemePluginExport, s as ThemeTokens, T as ToolFormatType, q as Typography } from './index-BH5jVqB9.mjs';
 export { ApiKeyError, AttachmentError, ConfigurationError, LogContext, LogLevel, ModelNotFoundError, PluginError, PluginLogger, ProviderApiError, RateLimitError, ToolExecutionError, createConsoleLogger, createNoopLogger } from './common/index.mjs';
 import 'react';
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { AnthropicToolDefinition, AttachmentResults, CacheUsage, FileAttachment, GeneratedImage, GoogleToolDefinition, ImageGenParams, ImageGenProvider, ImageGenResponse, JSONSchemaDefinition, LLMMessage, LLMParams, LLMProvider, LLMResponse, ModelMetadata, ModelWarning, ModelWarningLevel, OpenAIToolDefinition, ResponseFormat, StreamChunk, TokenUsage, ToolCall, ToolCallRequest, ToolFormatOptions, ToolResult, UniversalTool } from './llm/index.js';
-export { A as AttachmentSupport, C as CheapModelConfig, p as ColorPalette, r as Effects, t as EmbeddedFont, E as EmbeddingModelInfo, F as FontDefinition, d as IconProps, I as ImageGenerationModelInfo, c as ImageProviderConstraints, o as InstalledPluginInfo, L as LLMProviderPlugin, f as MessageFormatSupport, 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, R as RoleplayTemplateConfig, x as RoleplayTemplateMetadata, y as RoleplayTemplatePlugin, z as RoleplayTemplatePluginExport, S as Spacing, u as ThemeMetadata, v as ThemePlugin, w as ThemePluginExport, s as ThemeTokens, T as ToolFormatType, q as Typography } from './index-GOH-2K-k.js';
+export { A as AttachmentSupport, C as CheapModelConfig, p as ColorPalette, r as Effects, t as EmbeddedFont, E as EmbeddingModelInfo, F as FontDefinition, d as IconProps, I as ImageGenerationModelInfo, c as ImageProviderConstraints, o as InstalledPluginInfo, L as LLMProviderPlugin, f as MessageFormatSupport, 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, R as RoleplayTemplateConfig, x as RoleplayTemplateMetadata, y as RoleplayTemplatePlugin, z as RoleplayTemplatePluginExport, S as Spacing, u as ThemeMetadata, v as ThemePlugin, w as ThemePluginExport, s as ThemeTokens, T as ToolFormatType, q as Typography } from './index-C0tKQeeQ.js';
 export { ApiKeyError, AttachmentError, ConfigurationError, LogContext, LogLevel, ModelNotFoundError, PluginError, PluginLogger, ProviderApiError, RateLimitError, ToolExecutionError, createConsoleLogger, createNoopLogger } from './common/index.js';
 import 'react';
 

package/dist/plugins/index.d.mts

@@ -1,3 +1,3 @@
-export { A as AttachmentSupport, p as ColorPalette, r as Effects, t as EmbeddedFont, E as EmbeddingModelInfo, F as FontDefinition, 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, R as RoleplayTemplateConfig, x as RoleplayTemplateMetadata, y as RoleplayTemplatePlugin, z as RoleplayTemplatePluginExport, S as Spacing, u as ThemeMetadata, v as ThemePlugin, w as ThemePluginExport, s as ThemeTokens, q as Typography } from '../index-DkdHzVYa.mjs';
+export { A as AttachmentSupport, p as ColorPalette, r as Effects, t as EmbeddedFont, E as EmbeddingModelInfo, F as FontDefinition, 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, R as RoleplayTemplateConfig, x as RoleplayTemplateMetadata, y as RoleplayTemplatePlugin, z as RoleplayTemplatePluginExport, S as Spacing, u as ThemeMetadata, v as ThemePlugin, w as ThemePluginExport, s as ThemeTokens, q as Typography } from '../index-BH5jVqB9.mjs';
 import 'react';
 import '../llm/index.mjs';

package/dist/plugins/index.d.ts

@@ -1,3 +1,3 @@
-export { A as AttachmentSupport, p as ColorPalette, r as Effects, t as EmbeddedFont, E as EmbeddingModelInfo, F as FontDefinition, 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, R as RoleplayTemplateConfig, x as RoleplayTemplateMetadata, y as RoleplayTemplatePlugin, z as RoleplayTemplatePluginExport, S as Spacing, u as ThemeMetadata, v as ThemePlugin, w as ThemePluginExport, s as ThemeTokens, q as Typography } from '../index-GOH-2K-k.js';
+export { A as AttachmentSupport, p as ColorPalette, r as Effects, t as EmbeddedFont, E as EmbeddingModelInfo, F as FontDefinition, 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, R as RoleplayTemplateConfig, x as RoleplayTemplateMetadata, y as RoleplayTemplatePlugin, z as RoleplayTemplatePluginExport, S as Spacing, u as ThemeMetadata, v as ThemePlugin, w as ThemePluginExport, s as ThemeTokens, q as Typography } from '../index-C0tKQeeQ.js';
 import 'react';
 import '../llm/index.js';

package/package.json

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