@vidtreo/recorder-vue 1.15.0 → 1.16.0

package/README.md

@@ -80,6 +80,7 @@ The component accepts a single `recorder-props` object so the discriminated unio
 | `minTimeRecord` | `number` | No | – | Minimum recording time in ms before Stop is allowed. Must not be greater than `maxRecordingTime` when both are positive. |
 | `maxRecordingTime` | `number` | No | – | Maximum recording time in milliseconds. |
 | `userMetadata` | `Record<string, unknown>` | No | – | Custom metadata attached to uploads. |
+| `integrity` | `IntegrityOptions` | No | – | `{ enabled: true, policy?: "report" \| "warn" \| "block" }`: collect integrity signals while recording and send them with the upload as `integrity`; the `integritySignal` event receives each signal as it is observed. See [Integrity signals](../recorder/README.md#integrity-signals). |
 | `recordingPrompt` | `RecordingPrompt` | No | – | Prompt shown during recording. Use `countdown: { show, placement: "above-countdown" }` to float it over the countdown. A `label` field is still accepted for backward compatibility but is not displayed. |
 | `enableSourceSwitching` | `boolean` | No | `true` | Toggle between camera and screen. |
 | `enableMute` | `boolean` | No | `true` | Show the mute/unmute button. |
@@ -105,6 +106,10 @@ The component accepts a single `recorder-props` object so the discriminated unio
 | `upload-error` | `error: Error` | Upload fails. Use `getUploadErrorCode(error)` to read the [error code](#upload-errors). |
 | `transcoding-progress` | `progress: number` (0..1) | Transcoding progress after a recording stops (desktop and mobile) and native camera processing. |
 | `error` | `error: Error` | Any unhandled error, including the [credential conflict](#temporary-access-tokens) configuration error. |
+| `integrity-signal` | `signal: IntegritySignal` | The recorder observes an integrity signal (`integrity` prop enabled). |
+| `integrity-blocked` | `reason: IntegrityBlockedReason` | `policy: "block"` refuses to start a recording because the active camera matches a virtual camera pattern. The start error (`code: "integrity.blocked"`) also reaches `error`. |
+| `integrity-challenge` | `prompt: IntegrityChallengePrompt` | A liveness challenge is due (`integrity.challenges.enabled`); the component shows the instruction itself. `challenges.lang` defaults to `lang`. |
+| `integrity-challenge-end` | `id: string` | A challenge window ended. |
 
 ### Example with listeners
 

package/dist/components/StandardRecorder.vue.d.ts

@@ -1,4 +1,4 @@
-import type { RecordingUploadResult, UploadProgressPhase } from "@vidtreo/recorder";
+import type { IntegrityBlockedReason, IntegrityChallengePrompt, IntegritySignal, RecordingUploadResult, UploadProgressPhase } from "@vidtreo/recorder";
 import type { VidtreoRecorderExposed, VidtreoRecorderProps } from "../types";
 type __VLS_Props = {
     recorderProps: VidtreoRecorderProps;
@@ -7,18 +7,26 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, VidtreoRe
     error: (error: Error) => any;
     uploadProgress: (progress: number, phase: UploadProgressPhase | null) => any;
     transcodingProgress: (progress: number) => any;
+    integrityChallenge: (prompt: IntegrityChallengePrompt) => any;
     recordingStart: () => any;
     recordingStop: () => any;
     uploadComplete: (result: RecordingUploadResult) => any;
     uploadError: (error: Error) => any;
+    integritySignal: (signal: IntegritySignal) => any;
+    integrityBlocked: (reason: IntegrityBlockedReason) => any;
+    integrityChallengeEnd: (id: string) => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
     onError?: ((error: Error) => any) | undefined;
     onUploadProgress?: ((progress: number, phase: UploadProgressPhase | null) => any) | undefined;
     onTranscodingProgress?: ((progress: number) => any) | undefined;
+    onIntegrityChallenge?: ((prompt: IntegrityChallengePrompt) => any) | undefined;
     onRecordingStart?: (() => any) | undefined;
     onRecordingStop?: (() => any) | undefined;
     onUploadComplete?: ((result: RecordingUploadResult) => any) | undefined;
     onUploadError?: ((error: Error) => any) | undefined;
+    onIntegritySignal?: ((signal: IntegritySignal) => any) | undefined;
+    onIntegrityBlocked?: ((reason: IntegrityBlockedReason) => any) | undefined;
+    onIntegrityChallengeEnd?: ((id: string) => any) | undefined;
 }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;

package/dist/components/StandardRecorderContent.vue.d.ts

@@ -1,4 +1,4 @@
-import { type RecordingUploadResult, type UploadProgressPhase } from "@vidtreo/recorder";
+import { type IntegrityBlockedReason, type IntegrityChallengePrompt, type IntegritySignal, type RecordingUploadResult, type UploadProgressPhase } from "@vidtreo/recorder";
 import type { VidtreoRecorderExposed, VidtreoRecorderProps } from "../types";
 type __VLS_Props = {
     recorderProps: VidtreoRecorderProps;
@@ -7,18 +7,26 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, VidtreoRe
     error: (error: Error) => any;
     uploadProgress: (progress: number, phase: UploadProgressPhase | null) => any;
     transcodingProgress: (progress: number) => any;
+    integrityChallenge: (prompt: IntegrityChallengePrompt) => any;
     recordingStart: () => any;
     recordingStop: () => any;
     uploadComplete: (result: RecordingUploadResult) => any;
     uploadError: (error: Error) => any;
+    integritySignal: (signal: IntegritySignal) => any;
+    integrityBlocked: (reason: IntegrityBlockedReason) => any;
+    integrityChallengeEnd: (id: string) => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
     onError?: ((error: Error) => any) | undefined;
     onUploadProgress?: ((progress: number, phase: UploadProgressPhase | null) => any) | undefined;
     onTranscodingProgress?: ((progress: number) => any) | undefined;
+    onIntegrityChallenge?: ((prompt: IntegrityChallengePrompt) => any) | undefined;
     onRecordingStart?: (() => any) | undefined;
     onRecordingStop?: (() => any) | undefined;
     onUploadComplete?: ((result: RecordingUploadResult) => any) | undefined;
     onUploadError?: ((error: Error) => any) | undefined;
+    onIntegritySignal?: ((signal: IntegritySignal) => any) | undefined;
+    onIntegrityBlocked?: ((reason: IntegrityBlockedReason) => any) | undefined;
+    onIntegrityChallengeEnd?: ((id: string) => any) | undefined;
 }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;

package/dist/components/VidtreoRecorder.vue.d.ts

@@ -1,4 +1,4 @@
-import { type RecordingUploadResult, type UploadProgressPhase } from "@vidtreo/recorder";
+import { type IntegrityBlockedReason, type IntegrityChallengePrompt, type IntegritySignal, type RecordingUploadResult, type UploadProgressPhase } from "@vidtreo/recorder";
 import type { VidtreoRecorderExposed, VidtreoRecorderProps } from "../types";
 type __VLS_Props = {
     recorderProps: VidtreoRecorderProps;
@@ -7,18 +7,26 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, VidtreoRe
     error: (error: Error) => any;
     uploadProgress: (progress: number, phase: UploadProgressPhase | null) => any;
     transcodingProgress: (progress: number) => any;
+    integrityChallenge: (prompt: IntegrityChallengePrompt) => any;
     recordingStart: () => any;
     recordingStop: () => any;
     uploadComplete: (result: RecordingUploadResult) => any;
     uploadError: (error: Error) => any;
+    integritySignal: (signal: IntegritySignal) => any;
+    integrityBlocked: (reason: IntegrityBlockedReason) => any;
+    integrityChallengeEnd: (id: string) => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
     onError?: ((error: Error) => any) | undefined;
     onUploadProgress?: ((progress: number, phase: UploadProgressPhase | null) => any) | undefined;
     onTranscodingProgress?: ((progress: number) => any) | undefined;
+    onIntegrityChallenge?: ((prompt: IntegrityChallengePrompt) => any) | undefined;
     onRecordingStart?: (() => any) | undefined;
     onRecordingStop?: (() => any) | undefined;
     onUploadComplete?: ((result: RecordingUploadResult) => any) | undefined;
     onUploadError?: ((error: Error) => any) | undefined;
+    onIntegritySignal?: ((signal: IntegritySignal) => any) | undefined;
+    onIntegrityBlocked?: ((reason: IntegrityBlockedReason) => any) | undefined;
+    onIntegrityChallengeEnd?: ((id: string) => any) | undefined;
 }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;

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

@@ -0,0 +1,7 @@
+import type { IntegrityChallengePrompt } from "@vidtreo/recorder";
+type __VLS_Props = {
+    prompt: IntegrityChallengePrompt | null;
+};
+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/index.d.ts

@@ -1,4 +1,3 @@
-import "@vidtreo/ui-styles/recorder.css";
 export { CONFIG_ERROR_CREDENTIAL_CONFLICT, ERROR_RECORDING_MARKER_DUPLICATE_ID, ERROR_RECORDING_MARKER_INVALID_ID, ERROR_RECORDING_MARKER_INVALID_LABEL, ERROR_RECORDING_MARKER_LIMIT_REACHED, ERROR_RECORDING_MARKER_NOT_RECORDING, getUploadErrorCode, isCredentialConflictError, isRecordingMarkerError, type RecordingMarkerError, type RecordingMarkerErrorCode, UPLOAD_ERROR_INSUFFICIENT_CREDITS, } from "@vidtreo/recorder";
 export { default as MobileWebRecorderUI } from "./components/MobileWebRecorderUI.vue";
 export { default as NativeCameraUI } from "./components/NativeCameraUI.vue";