@overlap.ai/react-video-subtitles 2.2.0 → 2.3.0

package/dist/hooks/useRefreshSubtitlesComponent.d.ts

@@ -0,0 +1,33 @@
+import { StyleConfig } from '../types/subtitles';
+interface RefreshSubtitlesComponentParams {
+    apiKey: string;
+    companyId: string;
+    clipId: string;
+    onConfigRefreshed?: (config: StyleConfig) => void;
+}
+interface RefreshSubtitlesComponentResult {
+    refresh: () => Promise<StyleConfig | null>;
+    isRefreshing: boolean;
+    lastRefreshedConfig: StyleConfig | null;
+}
+/**
+ * Hook to refresh subtitle configuration from the database
+ *
+ * @param params - Object containing apiKey, companyId, clipId, and optional onConfigRefreshed callback
+ * @returns Object with refresh function, isRefreshing state, and lastRefreshedConfig
+ *
+ * @example
+ * ```tsx
+ * const { refresh, isRefreshing, lastRefreshedConfig } = useRefreshSubtitlesComponent({
+ *   apiKey: 'your-api-key',
+ *   companyId: 'company123',
+ *   clipId: 'clip456',
+ *   onConfigRefreshed: (config) => console.log('Config refreshed:', config)
+ * });
+ *
+ * // Refresh subtitle config
+ * const newConfig = await refresh();
+ * ```
+ */
+export declare const useRefreshSubtitlesComponent: ({ apiKey, companyId, clipId, onConfigRefreshed, }: RefreshSubtitlesComponentParams) => RefreshSubtitlesComponentResult;
+export {};

package/dist/hooks/useUpdatePersistentSubtitleConfig.d.ts

@@ -0,0 +1,31 @@
+import { StyleConfig } from '../types/subtitles';
+interface UpdatePersistentSubtitleConfigParams {
+    apiKey: string;
+    companyId: string;
+    clipId: string;
+}
+/**
+ * Hook to update persistent subtitle configuration in the database
+ *
+ * @param params - Object containing apiKey, companyId, and clipId
+ * @returns Object with updateConfig function and isUpdating state
+ *
+ * @example
+ * ```tsx
+ * const { updateConfig } = useUpdatePersistentSubtitleConfig({
+ *   apiKey: 'your-api-key',
+ *   companyId: 'company123',
+ *   clipId: 'clip456'
+ * });
+ *
+ * // Update subtitle config
+ * await updateConfig({
+ *   fontSize: 24,
+ *   color: '#FF0000'
+ * });
+ * ```
+ */
+export declare const useUpdatePersistentSubtitleConfig: ({ apiKey, companyId, clipId, }: UpdatePersistentSubtitleConfigParams) => {
+    updateConfig: (subtitleConfig: Partial<StyleConfig>) => Promise<any>;
+};
+export {};

package/dist/index.d.ts

@@ -4,7 +4,9 @@ import { useStyleConfig } from './hooks/useStyleConfig';
 import { useAdjustedPosition } from './hooks/useAdjustedPosition';
 import { useAdjustedPhrases } from './hooks/useAdjustedPhrases';
 import { useTextStyle } from './hooks/useTextStyle';
+import { useUpdatePersistentSubtitleConfig } from './hooks/useUpdatePersistentSubtitleConfig';
+import { useRefreshSubtitlesComponent } from './hooks/useRefreshSubtitlesComponent';
 import { loadSubtitlePreset } from './utils/loadSubtitlePreset';
 import type { StyleConfig, SubtitlesProps, Phrase, SegmentWord, SubtitleComponent, SubtitleTextProps } from './types';
-export { Subtitles, SubtitleText, useStyleConfig, useAdjustedPosition, useAdjustedPhrases, useTextStyle, loadSubtitlePreset, };
+export { Subtitles, SubtitleText, useStyleConfig, useAdjustedPosition, useAdjustedPhrases, useTextStyle, useUpdatePersistentSubtitleConfig, useRefreshSubtitlesComponent, loadSubtitlePreset, };
 export type { StyleConfig, SubtitlesProps, Phrase, SegmentWord, SubtitleComponent, SubtitleTextProps, };