@luna-editor/engine 0.3.0 → 0.3.1

package/dist/sdk.d.ts

@@ -1,5 +1,8 @@
 import React from "react";
-import type { BackgroundData, BacklogEntry, BranchChoiceHistory, Character, ConversationBranchState, DisplayedCharacter, EntityState, ScenarioBlock, ScenarioBlockType, WorkFont } from "./types";
+import { useDataAPI } from "./contexts/DataContext";
+import type { DataAPI, DataContext, DataSubscriber } from "./data-api-types";
+import type { FacePosition } from "./emotion-effect-types";
+import type { Character, ConversationBranchState, EntityState, ScenarioBlock, ScenarioBlockType } from "./types";
 /**
  * ブロックオプションの定義
  * プラグインがシナリオブロックに追加できるカスタムオプションを定義
@@ -39,132 +42,8 @@ export interface LunaPlugin {
     onUninstall?(api: PluginInstallAPI): Promise<void>;
     setup(api: PluginAPI): void;
 }
-/**
- * シナリオ再生の動的データ
- */
-export interface ScenarioPlaybackData {
-    /** 現在のブロックインデックス（0始まり） */
-    currentBlockIndex: number;
-    /** 総ブロック数 */
-    totalBlocks: number;
-    /** 現在のシナリオID */
-    scenarioId: string;
-    /** シナリオ名 */
-    scenarioName: string;
-    /** 現在のブロック */
-    currentBlock: ScenarioBlock | null;
-    /** 表示中のテキスト（改行は自動的に<br />に変換されます） */
-    displayText?: string | React.ReactNode;
-    /** テキストアニメーション中かどうか */
-    isTyping?: boolean;
-    /** 表示中のキャラクター */
-    displayedCharacters?: DisplayedCharacter[];
-}
-/**
- * バックログデータ
- */
-export interface BacklogData {
-    /** バックログエントリ */
-    entries: BacklogEntry[];
-    /** 総エントリ数 */
-    totalEntries: number;
-    /** ログエントリを追加 */
-    addLogEntry?: (entry: BacklogEntry) => void;
-    /** ログをクリア */
-    clearLogs?: () => void;
-}
-/**
- * プレイヤー設定データ
- */
-export interface PlayerSettingsData extends PlayerSettings {
-    /** テキスト速度 (ミリ秒/文字) */
-    textSpeed: number;
-    /** 自動再生速度 (秒) */
-    autoPlaySpeed: number;
-    /** BGM音量 (0-1) */
-    bgmVolume: number;
-    /** SE音量 (0-1) */
-    seVolume: number;
-    /** ボイス音量 (0-1) */
-    voiceVolume: number;
-    /** スキップ設定 */
-    skipMode?: "all" | "unread" | "none";
-}
-/**
- * プラグインアセットデータ
- */
-export interface PluginAssetsData {
-    /**
-     * プラグインのアセットURLを取得
-     * @param pluginName - プラグインのパッケージ名
-     * @param filename - アセットファイル名
-     * @returns アセットのURL
-     */
-    getAssetUrl: (pluginName: string, filename: string) => string;
-}
-/**
- * フォントデータ
- */
-export interface FontsData {
-    /** 利用可能なフォント一覧 */
-    fonts: WorkFont[];
-    /** 選択されているフォントファミリー */
-    selectedFontFamily: string | undefined;
-    /** フォントが読み込み完了しているかどうか */
-    isLoaded: boolean;
-}
-/**
- * 全データコンテキスト
- */
-export interface DataContext {
-    /** シナリオ再生情報 */
-    playback: ScenarioPlaybackData;
-    /** バックログ情報 */
-    backlog: BacklogData;
-    /** プレイヤー設定 */
-    settings: PlayerSettingsData;
-    /** プラグインアセット */
-    pluginAssets: PluginAssetsData;
-    /** 会話分岐データ */
-    branchData?: ConversationBranchState;
-    /** 分岐履歴 */
-    branchHistory?: BranchChoiceHistory[];
-    /** 現在の背景データ（単一、後方互換性用） */
-    background?: BackgroundData | null;
-    /** 現在の背景データ（複数、背景グループ対応） */
-    backgrounds?: BackgroundData[];
-    /** フォント設定 */
-    fonts?: FontsData;
-}
-/**
- * データ購読コールバック
- */
-export type DataSubscriber<T> = (data: T) => void;
-/**
- * データAPI - プラグインからのデータアクセスインターフェース
- *
- * @example Pull型（現在値の取得）
- * ```typescript
- * const blockIndex = api.data.get('playback', 'currentBlockIndex');
- * const playback = api.data.get('playback');
- * ```
- *
- * @example Push型（変更の監視）
- * ```typescript
- * const unsubscribe = api.data.subscribe('playback', (data) => {
- *   console.log('Playback updated:', data);
- * });
- * // cleanup
- * unsubscribe();
- * ```
- *
- * @example プロパティ単位での監視
- * ```typescript
- * api.data.watch('playback', 'currentBlockIndex', (index) => {
- *   console.log('Block changed to:', index);
- * });
- * ```
- */
+export type { BacklogData, FontsData, PlayerSettingsData, PluginAssetsData, ScenarioPlaybackData, } from "./data-api-types";
+export type { DataAPI, DataContext, DataSubscriber };
 /**
  * UI表示管理API - プラグインUIコンポーネントの表示/非表示を制御
  */
@@ -191,86 +70,6 @@ export interface UIAPI {
      */
     isVisible(type: ComponentType): boolean;
 }
-export interface DataAPI {
-    /**
-     * データの現在値を取得（Pull型）
-     * @param key - データカテゴリ
-     */
-    get<K extends keyof DataContext>(key: K): DataContext[K];
-    /**
-     * データの特定プロパティを取得（Pull型）
-     * @param key - データカテゴリ
-     * @param property - プロパティ名
-     */
-    get<K extends keyof DataContext, P extends keyof DataContext[K]>(key: K, property: P): DataContext[K][P];
-    /**
-     * データカテゴリ全体の変更を監視（Push型）
-     * @param key - データカテゴリ
-     * @param callback - 変更時のコールバック
-     * @returns unsubscribe関数
-     */
-    subscribe<K extends keyof DataContext>(key: K, callback: DataSubscriber<DataContext[K]>): () => void;
-    /**
-     * 特定プロパティの変更を監視（Push型）
-     * @param key - データカテゴリ
-     * @param property - プロパティ名
-     * @param callback - 変更時のコールバック
-     * @returns unsubscribe関数
-     */
-    watch<K extends keyof DataContext, P extends keyof DataContext[K]>(key: K, property: P, callback: DataSubscriber<DataContext[K][P]>): () => void;
-    /**
-     * プレイヤー設定を更新
-     * @param settings - 更新する設定値（部分更新可能）
-     */
-    updateSettings(settings: Partial<PlayerSettingsData>): void;
-    /**
-     * BGM音量を設定
-     * @param volume - 音量（0-1の範囲）
-     */
-    setBgmVolume(volume: number): void;
-    /**
-     * SE音量を設定
-     * @param volume - 音量（0-1の範囲）
-     */
-    setSeVolume(volume: number): void;
-    /**
-     * ボイス音量を設定
-     * @param volume - 音量（0-1の範囲）
-     */
-    setVoiceVolume(volume: number): void;
-    /**
-     * 全カテゴリの音量を一括設定
-     * @param volumes - カテゴリ別音量設定
-     */
-    setVolumes(volumes: {
-        bgm?: number;
-        se?: number;
-        voice?: number;
-    }): void;
-    /**
-     * 現在のブロックのオプション値を型安全に取得
-     *
-     * @example
-     * ```typescript
-     * // プラグイン側で型を定義
-     * type MyBlockOptions = {
-     *   ultemist_bubble_style: "normal" | "monologue" | "star";
-     *   ultemist_effect_type: "none" | "shake" | "fade";
-     * };
-     *
-     * // コンポーネントで使用
-     * const bubbleStyle = dataAPI.getBlockOption<MyBlockOptions, "ultemist_bubble_style">("ultemist_bubble_style");
-     * // 型: "normal" | "monologue" | "star" | undefined
-     *
-     * // または簡易版（キーのみ指定）
-     * const bubbleStyle = dataAPI.getBlockOption<MyBlockOptions>("ultemist_bubble_style");
-     * ```
-     *
-     * @param key - オプションのキー
-     * @returns オプションの値、または未設定の場合undefined
-     */
-    getBlockOption<T extends Record<string, unknown>, K extends keyof T = keyof T>(key: K): T[K] | undefined;
-}
 /**
  * ブロックオプション登録API
  */
@@ -466,12 +265,15 @@ export interface CharacterSpeakContext {
         id?: string;
         name?: string;
     };
-    facePosition?: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
+    /**
+     * 【機能概要】: 顔位置情報（感情エフェクト用）
+     * 【実装方針】: インライン定義からFacePosition型に変更し、型の再利用性を向上
+     * 【テスト対応】: TC-009を通すための実装
+     * 🔵 信頼性レベル: note.md（行301-308）の推奨事項に基づく
+     *
+     * @see FacePosition - 完全な型定義は emotion-effect-types.ts を参照
+     */
+    facePosition?: FacePosition;
 }
 export interface ScenarioContext {
     scenario: {
@@ -553,15 +355,27 @@ export declare enum ComponentType {
     Config = "Config",
     ConversationBranch = "ConversationBranch",
     Background = "Background",
-    FullscreenTextBox = "FullscreenTextBox"
+    FullscreenTextBox = "FullscreenTextBox",
+    /**
+     * 【機能概要】: 感情エフェクトコンポーネント登録用の型定義
+     * 【実装方針】: 既存のComponentType値と同じパターン（PascalCase、文字列リテラル型）で追加
+     * 【テスト対応】: TC-001, TC-003, TC-004, TC-012を通すための実装
+     * 🔵 信頼性レベル: タスクノート、要件定義書、設計文書に明確に定義されている
+     *
+     * @see EmotionEffectState - 関連する型定義は emotion-effect-types.ts を参照
+     */
+    EmotionEffect = "EmotionEffect"
 }
 /**
  * コンポーネント登録API
- * すべてのデータはDataContext経由で提供されるため、propsは使用しません
+ * DataAPIはPluginComponentProviderから自動的にpropsとして渡されます
  */
 export interface ComponentAPI {
-    registerComponent(type: ComponentType, component: React.ComponentType): void;
+    registerComponent(type: ComponentType, component: React.ComponentType<{
+        dataAPI?: DataAPI;
+    }>): void;
 }
+export type { EffectPosition, EmotionEffectPosition, EmotionEffectState, EmotionType, FacePosition, PositionType, } from "./emotion-effect-types";
 export type { BacklogEntry, DisplayedCharacter } from "./types";
 export interface PlayerSettings {
     textSpeed: number;
@@ -597,7 +411,7 @@ export declare function calculateFaceRelativePosition(options: FaceRelativeEffec
     x: number;
     y: number;
 };
-export { React };
+export { React, useDataAPI };
 /**
  * 画面サイズ変換ユーティリティの型定義
  */

package/dist/sdk.js

@@ -1,6 +1,7 @@
 // SDK exports for plugin development
 // This file contains all types and utilities needed for plugin development
 import React from "react";
+import { useDataAPI } from "./contexts/DataContext";
 // Component registration types
 export var ComponentType;
 (function (ComponentType) {
@@ -17,6 +18,15 @@ export var ComponentType;
     ComponentType["ConversationBranch"] = "ConversationBranch";
     ComponentType["Background"] = "Background";
     ComponentType["FullscreenTextBox"] = "FullscreenTextBox";
+    /**
+     * 【機能概要】: 感情エフェクトコンポーネント登録用の型定義
+     * 【実装方針】: 既存のComponentType値と同じパターン（PascalCase、文字列リテラル型）で追加
+     * 【テスト対応】: TC-001, TC-003, TC-004, TC-012を通すための実装
+     * 🔵 信頼性レベル: タスクノート、要件定義書、設計文書に明確に定義されている
+     *
+     * @see EmotionEffectState - 関連する型定義は emotion-effect-types.ts を参照
+     */
+    ComponentType["EmotionEffect"] = "EmotionEffect";
 })(ComponentType || (ComponentType = {}));
 // Component types are already exported as part of the interfaces above
 // Plugin utility function
@@ -58,8 +68,8 @@ export function calculateFaceRelativePosition(options) {
         y: baseY + offsetY,
     };
 }
-// Export React for plugin use
-export { React };
+// Export React and hooks for plugin use
+export { React, useDataAPI };
 export { OverlayUI } from "./components/OverlayUI";
 // Screen size constants
 export { aspectRatio, BasisHeight, BasisWidth } from "./constants/screen-size";

package/dist/types.d.ts

@@ -16,6 +16,7 @@ export interface ScenarioBlock {
     updatedAt: Date;
     /** Plugin-defined block options (key-value pairs) */
     options?: BlockOptions | null;
+    characterLayoutMode?: "detailed" | "simple";
     speaker?: {
         id: string;
         name: string;
@@ -311,13 +312,24 @@ export interface PlayerSettings {
     defaultBackgroundFadeDuration?: number;
     /** 全ての音声をミュートする (デフォルト: false) */
     muteAudio?: boolean;
-    /** 選択されたフォントファミリー */
+    /** 選択されたフォントファミリー（テキスト用） */
     selectedFontFamily?: string;
+    /** 選択されたUIフォントファミリー（メニュー・ラベル等） */
+    selectedUIFontFamily?: string;
+    /** 非アクティブキャラクターの明るさ (0-1, デフォルト: 0.8) */
+    inactiveCharacterBrightness?: number;
+    /** キャラクター間隔（簡易モード用、デフォルト: 0.1） */
+    characterSpacing?: number;
 }
 export interface PluginConfig {
     packageName: string;
     bundleUrl: string;
     config?: unknown;
+    /** アセットのファイル名→絶対URLマッピング（外部アプリから利用時に必要） */
+    assets?: {
+        filename: string;
+        url: string;
+    }[];
 }
 /** 作品のサウンドデータ（プラグインからアクセス可能） */
 export interface WorkSound {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luna-editor/engine",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Luna Editor scenario playback engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -31,11 +31,11 @@
     "lucide-react": "^0.503.0"
   },
   "devDependencies": {
-    "@types/react": "^19",
-    "@types/react-dom": "^19",
-    "typescript": "^5",
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0"
+    "@types/react": "^19.2.9",
+    "@types/react-dom": "^19.2.3",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
+    "typescript": "^5"
   },
   "publishConfig": {
     "access": "public"