@industry-theme/file-city-panel 0.2.80 → 0.3.1

package/dist/types/TextToSpeech.d.ts

@@ -0,0 +1,116 @@
+/**
+ * Text-to-Speech Adapter Types
+ *
+ * These types define the interface for TTS functionality in tour players.
+ * The host application provides a TTS adapter implementation that handles
+ * audio generation, caching, and playback.
+ */
+/**
+ * Audio event types
+ */
+export type TTSEvent = 'ended' | 'error' | 'playing' | 'paused' | 'loading';
+/**
+ * Current state of the TTS system
+ */
+export interface TTSState {
+    /** Whether audio is currently being loaded/generated */
+    isLoading: boolean;
+    /** Whether audio is currently playing */
+    isPlaying: boolean;
+    /** Whether audio is paused */
+    isPaused: boolean;
+    /** Current error, if any */
+    error: Error | null;
+    /** Playback progress (0-100) */
+    progress?: number;
+    /** Total duration in seconds */
+    duration?: number;
+    /** Current playback time in seconds */
+    currentTime?: number;
+}
+/**
+ * Options for TTS generation and playback
+ */
+export interface TTSOptions {
+    /** Voice identifier (e.g., ElevenLabs voice ID) */
+    voice?: string;
+    /** Speech speed multiplier (0.5 - 2.0) */
+    speed?: number;
+    /** Pitch adjustment (if supported by TTS provider) */
+    pitch?: number;
+}
+/**
+ * Context information for fetching tour audio
+ * This is used to identify the tour file in version control
+ */
+export interface TourAudioContext {
+    /** Repository owner (e.g., "anthropics") */
+    owner: string;
+    /** Repository name (e.g., "web-ade") */
+    repo: string;
+    /** Path to tour file in repo (e.g., "docs/tours/intro.tour.json") */
+    path: string;
+    /** Git commit SHA to ensure cache invalidation on changes */
+    commitSha: string;
+}
+/**
+ * Text-to-Speech Adapter Interface
+ *
+ * Host applications implement this interface to provide TTS functionality.
+ * The adapter handles audio generation, caching (e.g., S3), and playback.
+ *
+ * Security: The adapter should NOT accept arbitrary text. Instead, it should
+ * fetch tour content from a trusted source (e.g., GitHub) using the context
+ * information provided.
+ */
+export interface TextToSpeechAdapter {
+    /**
+     * Fetch audio URLs for all steps in a tour
+     * This is called when the tour loads to ensure audio is available
+     *
+     * @param tourId - Unique identifier for the tour
+     * @param stepIds - Array of step IDs to fetch audio for
+     * @param context - Repository and file context
+     * @param options - Voice and playback options
+     * @returns Map of stepId -> audio URL
+     */
+    fetchTourAudio(tourId: string, stepIds: string[], context: TourAudioContext, options?: TTSOptions): Promise<Map<string, string>>;
+    /**
+     * Play audio for a specific step
+     *
+     * @param stepId - The step ID to play audio for
+     * @throws Error if audio URL not found (fetchTourAudio must be called first)
+     */
+    speak(stepId: string): Promise<void>;
+    /**
+     * Stop current audio playback and reset position
+     */
+    stop(): void;
+    /**
+     * Pause current audio playback (preserves position)
+     */
+    pause(): void;
+    /**
+     * Resume paused audio playback
+     */
+    resume(): void;
+    /**
+     * Current state of the TTS system
+     */
+    readonly state: TTSState;
+    /**
+     * Subscribe to TTS events
+     *
+     * @param event - Event type to listen for
+     * @param handler - Callback function
+     */
+    addEventListener(event: TTSEvent, handler: () => void): void;
+    /**
+     * Unsubscribe from TTS events
+     *
+     * @param event - Event type to stop listening for
+     * @param handler - Callback function to remove
+     */
+    removeEventListener(event: TTSEvent, handler: () => void): void;
+}
+//# sourceMappingURL=TextToSpeech.d.ts.map

package/dist/types/TextToSpeech.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextToSpeech.d.ts","sourceRoot":"","sources":["../../src/types/TextToSpeech.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,wDAAwD;IACxD,SAAS,EAAE,OAAO,CAAC;IAEnB,yCAAyC;IACzC,SAAS,EAAE,OAAO,CAAC;IAEnB,8BAA8B;IAC9B,QAAQ,EAAE,OAAO,CAAC;IAElB,4BAA4B;IAC5B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAEpB,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,uCAAuC;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,mDAAmD;IACnD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;IAEd,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IAEb,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IAEb,6DAA6D;IAC7D,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;OASG;IACH,cAAc,CACZ,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE,gBAAgB,EACzB,OAAO,CAAC,EAAE,UAAU,GACnB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhC;;;;;OAKG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErC;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IAEzB;;;;;OAKG;IACH,gBAAgB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE7D;;;;;OAKG;IACH,mBAAmB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CACjE"}

package/dist/types/index.d.ts

@@ -6,4 +6,5 @@
 export type { DataSlice, WorkspaceMetadata, RepositoryMetadata, FileTreeSource, ActiveFileSlice, PanelEventType, PanelEvent, PanelEventEmitter, PanelActions, PanelContextValue, PanelComponentProps, PanelMetadata, PanelLifecycleHooks, PanelDefinition, PanelModule, PanelRegistryEntry, PanelLoader, PanelRegistryConfig, } from '@principal-ade/panel-framework-core';
 export type { FileCityColorModesSliceData, QualitySliceData, ColorMode, ColorModeConfig, FileMetricData, HighlightLayer, } from '../panels/utils/qualityLayers';
 export type { IntroductionTour, IntroductionTourStep, HighlightLayerConfig, InteractiveAction, TourResource, } from './IntroductionTour';
+export type { TextToSpeechAdapter, TTSState, TTSOptions, TTSEvent, TourAudioContext, } from './TextToSpeech';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,YAAY,EAEV,SAAS,EACT,iBAAiB,EACjB,kBAAkB,EAClB,cAAc,EACd,eAAe,EAGf,cAAc,EACd,UAAU,EACV,iBAAiB,EAGjB,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EAGnB,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,WAAW,EAGX,kBAAkB,EAClB,WAAW,EACX,mBAAmB,GACpB,MAAM,qCAAqC,CAAC;AAG7C,YAAY,EACV,2BAA2B,EAC3B,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,cAAc,EACd,cAAc,GACf,MAAM,+BAA+B,CAAC;AAGvC,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,GACb,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,YAAY,EAEV,SAAS,EACT,iBAAiB,EACjB,kBAAkB,EAClB,cAAc,EACd,eAAe,EAGf,cAAc,EACd,UAAU,EACV,iBAAiB,EAGjB,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EAGnB,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,WAAW,EAGX,kBAAkB,EAClB,WAAW,EACX,mBAAmB,GACpB,MAAM,qCAAqC,CAAC;AAG7C,YAAY,EACV,2BAA2B,EAC3B,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,cAAc,EACd,cAAc,GACf,MAAM,+BAA+B,CAAC;AAGvC,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,GACb,MAAM,oBAAoB,CAAC;AAG5B,YAAY,EACV,mBAAmB,EACnB,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,gBAAgB,GACjB,MAAM,gBAAgB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@industry-theme/file-city-panel",
-  "version": "0.2.80",
+  "version": "0.3.1",
   "description": "File City visualization panel extension for @principal-ade/panel-framework-core",
   "type": "module",
   "main": "dist/panels.bundle.js",