@vidtreo/recorder-vue 1.6.0

package/dist/components/ui/PreviewContent.vue.d.ts

@@ -0,0 +1,72 @@
+import type { RecorderController } from "@vidtreo/recorder";
+import type { ButtonVisibility } from "../../utils/button-visibility";
+import { type RecordingControlsButtonsTranslations } from "./RecordingControlsButtons.vue";
+export type PreviewContentState = {
+    stream: MediaStream | null;
+    transitionMessage: string | null;
+    recordingState: string;
+    countdown: number | null;
+    timer: string;
+    isMuted: boolean;
+    isPaused: boolean;
+    isAudioReady: boolean;
+    errorCode: string | null;
+    browserName: string | null;
+    browserVersion: string | null;
+};
+export type PreviewContentTranslations = {
+    initializingCamera: string;
+    grantPermissions: string;
+    browserUnsupported: string;
+    browserUnsupportedDynamic: string;
+    browserUnsupportedSafari: string;
+    browserUnsupportedFirefox: string;
+    retryCamera: string;
+    cameraInUse: string;
+    cameraNotFound: string;
+    cameraPermissionDenied: string;
+    failedToStartCamera: string;
+    audioInUse: string;
+    audioNotFound: string;
+    audioPermissionDenied: string;
+    failedToStartAudio: string;
+    switchingDevice: string;
+    recordingStartsIn: string;
+    rec: string;
+};
+type __VLS_Props = {
+    state: PreviewContentState;
+    isVideoLoaded: boolean;
+    isRecording: boolean;
+    controller: RecorderController | null;
+    audioLevel: number;
+    buttonVisibility: ButtonVisibility;
+    currentSourceType: "camera" | "screen";
+    isStopLocked: boolean;
+    stopLockedTooltip: string;
+    translations: PreviewContentTranslations;
+    buttonTranslations: RecordingControlsButtonsTranslations;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    pause: () => any;
+    resume: () => any;
+    switchSource: () => any;
+    download: () => any;
+    toggleSettings: () => any;
+    startRecording: () => any;
+    stopRecording: () => any;
+    toggleMute: () => any;
+    loadedChange: (loaded: boolean) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onPause?: (() => any) | undefined;
+    onResume?: (() => any) | undefined;
+    onSwitchSource?: (() => any) | undefined;
+    onDownload?: (() => any) | undefined;
+    onToggleSettings?: (() => any) | undefined;
+    onStartRecording?: (() => any) | undefined;
+    onStopRecording?: (() => any) | undefined;
+    onToggleMute?: (() => any) | undefined;
+    onLoadedChange?: ((loaded: boolean) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/ui/RecordingControlsButtons.vue.d.ts

@@ -0,0 +1,72 @@
+export type RecordingControlsButtonsTranslations = {
+    settings: string;
+    record: string;
+    stop: string;
+    minimumRecordingTimeNotReached: string;
+    pause: string;
+    resume: string;
+    mute: string;
+    unmute: string;
+    switchSource: string;
+    download: string;
+    microphoneConnecting: string;
+};
+declare const DEFAULT_TRANSLATIONS: RecordingControlsButtonsTranslations;
+export { DEFAULT_TRANSLATIONS as RECORDING_CONTROLS_DEFAULT_TRANSLATIONS };
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<{
+    buttonVisibility: {
+        showSettingsButton: boolean;
+        showMuteButton: boolean;
+        showPauseButton: boolean;
+        showResumeButton: boolean;
+        showStopButton: boolean;
+        showSwitchSourceButton: boolean;
+        showDownloadButton?: boolean;
+    };
+    recordingState: string;
+    isMuted: boolean;
+    isAudioReady: boolean;
+    currentSourceType: "camera" | "screen";
+    isStopLocked: boolean;
+    stopLockedTooltip: string;
+    translations?: RecordingControlsButtonsTranslations;
+}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    pause: () => any;
+    resume: () => any;
+    switchSource: () => any;
+    download: () => any;
+    toggleSettings: () => any;
+    startRecording: () => any;
+    stopRecording: () => any;
+    toggleMute: () => any;
+}, string, import("vue").PublicProps, Readonly<{
+    buttonVisibility: {
+        showSettingsButton: boolean;
+        showMuteButton: boolean;
+        showPauseButton: boolean;
+        showResumeButton: boolean;
+        showStopButton: boolean;
+        showSwitchSourceButton: boolean;
+        showDownloadButton?: boolean;
+    };
+    recordingState: string;
+    isMuted: boolean;
+    isAudioReady: boolean;
+    currentSourceType: "camera" | "screen";
+    isStopLocked: boolean;
+    stopLockedTooltip: string;
+    translations?: RecordingControlsButtonsTranslations;
+}> & Readonly<{
+    onPause?: (() => any) | undefined;
+    onResume?: (() => any) | undefined;
+    onSwitchSource?: (() => any) | undefined;
+    onDownload?: (() => any) | undefined;
+    onToggleSettings?: (() => any) | undefined;
+    onStartRecording?: (() => any) | undefined;
+    onStopRecording?: (() => any) | undefined;
+    onToggleMute?: (() => any) | undefined;
+}>, {
+    translations: RecordingControlsButtonsTranslations;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

package/dist/components/ui/SettingsPanel.vue.d.ts

@@ -0,0 +1,34 @@
+export type SettingsPanelTranslations = {
+    settings: string;
+    camera: string;
+    microphone: string;
+};
+declare const DEFAULT_TRANSLATIONS: SettingsPanelTranslations;
+export { DEFAULT_TRANSLATIONS as SETTINGS_PANEL_DEFAULT_TRANSLATIONS };
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<{
+    devices: {
+        cameras: MediaDeviceInfo[];
+        microphones: MediaDeviceInfo[];
+        selectedCamera: string | null;
+        selectedMic: string | null;
+    };
+    translations?: SettingsPanelTranslations;
+}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    cameraChange: (value: string) => any;
+    micChange: (value: string) => any;
+}, string, import("vue").PublicProps, Readonly<{
+    devices: {
+        cameras: MediaDeviceInfo[];
+        microphones: MediaDeviceInfo[];
+        selectedCamera: string | null;
+        selectedMic: string | null;
+    };
+    translations?: SettingsPanelTranslations;
+}> & Readonly<{
+    onCameraChange?: ((value: string) => any) | undefined;
+    onMicChange?: ((value: string) => any) | undefined;
+}>, {
+    translations: SettingsPanelTranslations;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

package/dist/components/ui/TranscodingProgress.vue.d.ts

@@ -0,0 +1,6 @@
+type __VLS_Props = {
+    progress: number;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/ui/UploadProgress.vue.d.ts

@@ -0,0 +1,7 @@
+type __VLS_Props = {
+    progress: number | null;
+    visible: boolean;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/ui/VideoPreview.vue.d.ts

@@ -0,0 +1,16 @@
+import type { RecorderController } from "@vidtreo/recorder";
+type __VLS_Props = {
+    controller?: RecorderController | null;
+    stream?: MediaStream | null;
+    transitionMessage?: string | null;
+    className?: string;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    loadedChange: (loaded: boolean) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onLoadedChange?: ((loaded: boolean) => any) | undefined;
+}>, {
+    className: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/ui/VideoPreviewSkeleton.vue.d.ts

@@ -0,0 +1,8 @@
+type __VLS_Props = {
+    className?: string;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    className: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/composables/use-mobile-web-recorder.d.ts

@@ -0,0 +1,8 @@
+import type { UseVidtreoRecorderConfig, UseVidtreoRecorderReturn } from "../types";
+export type UseMobileWebRecorderReturn = UseVidtreoRecorderReturn & {
+    isModalOpen: import("vue").Ref<boolean>;
+    canCloseModal: import("vue").ComputedRef<boolean>;
+    openModal: () => void;
+    closeModal: () => void;
+};
+export declare function useMobileWebRecorder(config: UseVidtreoRecorderConfig): UseMobileWebRecorderReturn;

package/dist/composables/use-native-camera.d.ts

@@ -0,0 +1,22 @@
+import { type NativeCameraFile } from "@vidtreo/recorder";
+import type { UseVidtreoRecorderConfig } from "../types";
+export type NativeCameraState = {
+    file: NativeCameraFile | null;
+    transcodingProgress: number | null;
+    uploadProgress: number | null;
+    isTranscoding: boolean;
+    isConfigLoading: boolean;
+    error: string | null;
+    transcodedBlob: Blob | null;
+};
+export type NativeCameraActions = {
+    handleFileSelect: (selectedFile: File) => Promise<NativeCameraFile>;
+    processAndUpload: (fileToProcess?: NativeCameraFile) => Promise<void>;
+    downloadVideo: () => void;
+    reset: () => void;
+};
+export type UseNativeCameraReturn = {
+    state: NativeCameraState;
+    actions: NativeCameraActions;
+};
+export declare function useNativeCamera(config: UseVidtreoRecorderConfig): UseNativeCameraReturn;

package/dist/composables/use-permission-flow.d.ts

@@ -0,0 +1,22 @@
+import type { PermissionFlowChangeReason, PermissionFlowLanguage, PermissionFlowState, PermissionFlowStep } from "@vidtreo/recorder";
+import { type ComputedRef, type MaybeRefOrGetter } from "vue";
+export type PermissionStepStatus = PermissionFlowState["permissions"]["camera"];
+export type PermissionFlowStepInfo = {
+    deviceType: "camera" | "microphone";
+    status: PermissionStepStatus;
+};
+export type UsePermissionFlowOptions = {
+    language?: MaybeRefOrGetter<PermissionFlowLanguage | undefined>;
+    onComplete?: (state: PermissionFlowState) => void;
+    onChange?: (state: PermissionFlowState, reason: PermissionFlowChangeReason) => void;
+};
+export type UsePermissionFlowReturn = {
+    isActive: ComputedRef<boolean>;
+    isComplete: ComputedRef<boolean>;
+    currentStep: ComputedRef<PermissionFlowStep>;
+    steps: ComputedRef<readonly PermissionFlowStepInfo[]>;
+    recoveryData: ComputedRef<PermissionFlowState["recoveryData"] | undefined>;
+    requestPermission: () => Promise<void>;
+    retryPermission: () => Promise<void>;
+};
+export declare function usePermissionFlow(options?: UsePermissionFlowOptions): UsePermissionFlowReturn;

package/dist/composables/use-recorder-translations.d.ts

@@ -0,0 +1,46 @@
+import { type ComputedRef, type MaybeRefOrGetter } from "vue";
+import type { TranslationKeys } from "../i18n/translations";
+export type PreviewTranslations = {
+    initializingCamera: string;
+    grantPermissions: string;
+    browserUnsupported: string;
+    browserUnsupportedDynamic: string;
+    browserUnsupportedSafari: string;
+    browserUnsupportedFirefox: string;
+    retryCamera: string;
+    cameraInUse: string;
+    cameraNotFound: string;
+    cameraPermissionDenied: string;
+    failedToStartCamera: string;
+    audioInUse: string;
+    audioNotFound: string;
+    audioPermissionDenied: string;
+    failedToStartAudio: string;
+    switchingDevice: string;
+    recordingStartsIn: string;
+    rec: string;
+};
+export type ButtonTranslations = {
+    settings: string;
+    record: string;
+    stop: string;
+    minimumRecordingTimeNotReached: string;
+    pause: string;
+    resume: string;
+    mute: string;
+    unmute: string;
+    switchSource: string;
+    download: string;
+    microphoneConnecting: string;
+};
+export type SettingsTranslations = {
+    settings: string;
+    camera: string;
+    microphone: string;
+};
+export type RecorderTranslations = {
+    preview: ComputedRef<PreviewTranslations>;
+    buttons: ComputedRef<ButtonTranslations>;
+    settings: ComputedRef<SettingsTranslations>;
+};
+export declare function useRecorderTranslations(translations: MaybeRefOrGetter<TranslationKeys>): RecorderTranslations;

package/dist/composables/use-vidtreo-recorder.d.ts

@@ -0,0 +1,2 @@
+import type { UseVidtreoRecorderConfig, UseVidtreoRecorderReturn } from "../types";
+export declare function useVidtreoRecorder(config: UseVidtreoRecorderConfig): UseVidtreoRecorderReturn;

package/dist/constants/constants.d.ts

@@ -0,0 +1 @@
+export declare const DEFAULT_BACKEND_URL = "https://core.vidtreo.com";

package/dist/i18n/translations.d.ts

@@ -0,0 +1,96 @@
+export type TranslationKeys = {
+    initializingCamera: string;
+    grantPermissions: string;
+    browserUnsupported: string;
+    browserUnsupportedDynamic: string;
+    browserUnsupportedSafari: string;
+    browserUnsupportedFirefox: string;
+    retryCamera: string;
+    cameraInUse: string;
+    cameraNotFound: string;
+    cameraPermissionDenied: string;
+    failedToStartCamera: string;
+    audioInUse: string;
+    audioNotFound: string;
+    audioPermissionDenied: string;
+    failedToStartAudio: string;
+    audioErrorTitle: string;
+    audioErrorMessage: string;
+    audioErrorRetry: string;
+    audioMissingTitle: string;
+    audioMissingMessage: string;
+    audioSilentTitle: string;
+    audioSilentMessage: string;
+    audioProcessingErrorTitle: string;
+    audioProcessingErrorMessage: string;
+    audioMissingRetry: string;
+    audioWarningNoSignalTitle: string;
+    audioWarningNoSignalMessage: string;
+    audioWarningLowSignalTitle: string;
+    audioWarningLowSignalMessage: string;
+    audioWarningTrackEndedTitle: string;
+    audioWarningTrackEndedMessage: string;
+    audioWarningNoChunksTitle: string;
+    audioWarningNoChunksMessage: string;
+    audioWarningTrackMutedTitle: string;
+    audioWarningTrackMutedMessage: string;
+    audioWarningDismiss: string;
+    cameraErrorTitle: string;
+    cameraErrorMessage: string;
+    browserErrorTitle: string;
+    browserErrorMessage: string;
+    genericErrorTitle: string;
+    genericErrorMessage: string;
+    errorRetry: string;
+    switchingDevice: string;
+    recordingStartsIn: string;
+    switchingSource: string;
+    rec: string;
+    settings: string;
+    record: string;
+    stop: string;
+    pause: string;
+    resume: string;
+    mute: string;
+    unmute: string;
+    switchSource: string;
+    camera: string;
+    microphone: string;
+    microphoneConnecting: string;
+    minimumRecordingTimeNotReached: string;
+    uploading: string;
+    userInAnotherTab: string;
+    download: string;
+    nativeCameraSelectVideo: string;
+    nativeCameraRecordVideo: string;
+    nativeCameraProcessing: string;
+    nativeCameraConfigLoading: string;
+    errorTitle: string;
+    errorApiKeyRequired: string;
+    errorGeneric: string;
+    mobileOpenCamera: string;
+    mobileOpenCameraTitle: string;
+    mobileOpenCameraDescription: string;
+    mobileCloseCamera: string;
+    mobilePermissionDenied: string;
+    mobilePermissionDeniedDescription: string;
+    permissionFlowTitle: string;
+    permissionFlowCameraTitle: string;
+    permissionFlowMicrophoneTitle: string;
+    permissionFlowCameraLabel: string;
+    permissionFlowMicrophoneLabel: string;
+    permissionFlowStatusPending: string;
+    permissionFlowStatusGranted: string;
+    permissionFlowStatusDenied: string;
+    permissionFlowStatusRequesting: string;
+    permissionFlowAllowCamera: string;
+    permissionFlowAllowMicrophone: string;
+    permissionFlowRetry: string;
+    permissionFlowRecoveryTitle: string;
+    permissionFlowRecoveryInstructions: string;
+    permissionFlowRecoveryGuideHint: string;
+    permissionFlowConnecting: string;
+};
+export declare const defaultTranslations: Record<string, TranslationKeys>;
+export type PartialTranslations = Partial<TranslationKeys>;
+export declare function getTranslations(lang?: string, customTexts?: PartialTranslations): TranslationKeys;

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import "@vidtreo/ui-styles/recorder.css";
+export { default as MobileWebRecorderUI } from "./components/MobileWebRecorderUI.vue";
+export { default as NativeCameraUI } from "./components/NativeCameraUI.vue";
+export { default as StandardRecorder } from "./components/StandardRecorder.vue";
+export { default as VidtreoRecorder } from "./components/VidtreoRecorder.vue";
+export type { UseMobileWebRecorderReturn } from "./composables/use-mobile-web-recorder";
+export { useMobileWebRecorder } from "./composables/use-mobile-web-recorder";
+export type { NativeCameraActions, NativeCameraState, UseNativeCameraReturn, } from "./composables/use-native-camera";
+export { useNativeCamera } from "./composables/use-native-camera";
+export type { PermissionFlowStepInfo, PermissionStepStatus, UsePermissionFlowOptions, UsePermissionFlowReturn, } from "./composables/use-permission-flow";
+export { usePermissionFlow } from "./composables/use-permission-flow";
+export type { ButtonTranslations, PreviewTranslations, RecorderTranslations, SettingsTranslations, } from "./composables/use-recorder-translations";
+export { useRecorderTranslations } from "./composables/use-recorder-translations";
+export { useVidtreoRecorder } from "./composables/use-vidtreo-recorder";
+export { defaultTranslations, getTranslations, type PartialTranslations, type TranslationKeys, } from "./i18n/translations";
+export type { AudioWarning, MobileMode, RecordingState, RecordingStopResult, SourceType, UseVidtreoRecorderConfig, UseVidtreoRecorderReturn, VidtreoRecorderActions, VidtreoRecorderEmits, VidtreoRecorderProps, VidtreoRecorderState, } from "./types";