@snap/camera-kit 0.17.0 → 0.18.0

package/dist/session/CameraKitSession.d.ts

@@ -0,0 +1,257 @@
+import type { Observable } from "rxjs";
+import type { Lens } from "../lens/Lens";
+import type { LensLaunchData } from "../lens/LensLaunchData";
+import { TypedEventTarget } from "../events/TypedEventTarget";
+import type { CameraKitDeviceOptions, CameraKitSource } from "../media-sources/CameraKitSource";
+import type { LogEntry } from "../logger/logger";
+import type { PageVisibility } from "../common/pageVisibility";
+import type { LensCore } from "../lens-core-module/lensCore";
+import { LensPerformanceMetrics } from "./LensPerformanceMetrics";
+import type { LensState } from "./lensState";
+import type { SessionState } from "./sessionState";
+import type { Keyboard, LensKeyboard } from "./LensKeyboard";
+import type { CameraKitSessionEvents } from "./CameraKitSessionEvents";
+/**
+ * Enumerates the supported render targets.
+ *
+ * Lenses may render to different render targets, as designed by the lens creator. In CameraKit, it's possible to choose
+ * which render target to render, and the result for each target is available as a separate `<canvas>` element.
+ *
+ * @category Rendering
+ * @category Lenses
+ */
+export type RenderTarget = "live" | "capture";
+/**
+ * A CameraKitSession represents a single rendering pipeline connecting an input media source to output `<canvas>`
+ * elements. When a Lens is applied to the session, CameraKit uses the Lens to transform the input media into rendered
+ * output.
+ *
+ * CameraKitSession is the primary object that applications interact with when integrating the CameraKit SDK.
+ *
+ * A CameraKitSession instance is obtained by calling {@link CameraKit.createSession}.
+ *
+ * @example
+ * ```ts
+ * const cameraKit = await bootstrapCameraKit(config)
+ * const session = await cameraKit.createSession()
+ * ```
+ *
+ * @category Rendering
+ * @category Lenses
+ */
+declare class CameraKitSession {
+    /**
+     * Use this to interact with lenses which require text input.
+     */
+    readonly keyboard: Keyboard;
+    private readonly lensCore;
+    private readonly sessionState;
+    private readonly lensState;
+    /**
+     * CameraKitSession renders video output to a `<canvas>` element. In fact, each session contains two canvas outputs
+     * corresponding to the RenderTargets used by Lens creators, when using LensStudio to create a Lens.
+     *
+     * The `live` output renders content suitable for the Lens user (e.g. it may contain additional UI elements
+     * applicable only to the person applying the lens). The `capture` output renders content suitable for sharing with
+     * other users (e.g. sent to the other members of a video call, or saved to disk for sharing later).
+     *
+     * For many lenses, these outputs are identical – but each lens is free to render differently, based on its own
+     * use-case.
+     */
+    readonly output: {
+        live: HTMLCanvasElement;
+        capture: HTMLCanvasElement;
+    };
+    /**
+     * Indicates whether or not the session is currently rendering. If `false`, rendering is stopped. Otherwise the
+     * value indicates which output is being rendered.
+     */
+    playing: {
+        live: boolean;
+        capture: boolean;
+    };
+    /**
+     * Add event listeners here to handle events which occur during the CameraKitSession.
+     *
+     * **Note:** Applications may want to handle the `error` event, and check the contained error type -- if the type
+     * is {@link LensExecutionError}, this means the current lens was unable to render and CameraKit will automatically
+     * remove the lens.
+     *
+     * @example
+     * ```ts
+     * cameraKitSession.events.addEventListener('error', ({ detail }) => {
+     *   if (detail.error.name === 'LensExecutionError') {
+     *     console.log(`Lens ${detail.lens.name} encountered an error and was removed. Please pick a different lens.`)
+     *   }
+     * })
+     * ```
+     */
+    readonly events: TypedEventTarget<CameraKitSessionEvents>;
+    /**
+     * Use this to measure current lens performance.
+     */
+    readonly metrics: LensPerformanceMetrics;
+    private readonly removePageVisibilityHandlers;
+    private source?;
+    private subscriptions;
+    /**
+     * @internal
+     */
+    constructor(
+    /**
+     * Use this to interact with lenses which require text input.
+     */
+    keyboard: Keyboard, lensCore: LensCore, sessionState: SessionState, lensState: LensState, logEntries: Observable<LogEntry>, pageVisibility: PageVisibility);
+    /**
+     * Apply a Lens to this session.
+     *
+     * This method will download (and cache) the Lens executable, and then use that Lens for rendering. If the session
+     * is currently playing, this will immediately update the rendered output. Otherwise, the new Lens will be used
+     * when session playback in resumed.
+     *
+     * Calling `applyLens` replaces any prior Lens – only one Lens is allowed at a time (per session).
+     *
+     * **NOTE**: Errors may occur after the Lens is applied. If the Lens encounters errors while rendering,
+     * Camera Kit will automatically remove the Lens from the session and emit a {@link LensExecutionError} event.
+     * Applications may want to listen for this error and, for example,
+     * prevent the Lens from being selected again by the user.
+     *
+     * ```ts
+     * session.events.addEventListener("error", ({ detail }) => {
+     *   if (detail.error.name === "LensExecutionError") {
+     *     preventFutureLensSelection(detail.lens);
+     *     showMessage("We're sorry, but the Lens you selected encountered an error. Please choose a different Lens.");
+     *   }
+     * });
+     * ```
+     *
+     * @param lens The Lens to apply to this session.
+     * @param launchData This can optionally be provided to pass some initial data to the Lens – only certain Lenses
+     * expect launch data.
+     * @returns A promise which can have the following results:
+     * 1. Resolved with `true`: the Lens has been applied.
+     * 2. Resolved with `false`: the Lens has not been applied, but no error occurred – this can happen if a
+     * subsequent call to `applyLens` interrupted the Lens application.
+     * 3. Rejected: the Lens has not been applied because an error occurred. This can happen if:
+     *   - The Lens ID cannot be found in the LensRepository (use LensRepository to load the Lens before calling this
+     *     method)
+     *   - Lens content download fails, or the download of any required lens assets fails.
+     *   - An internal failure occurs in the Lens rendering engine when attempting to apply the Lens.
+     */
+    applyLens(lens: Lens, launchData?: LensLaunchData): Promise<boolean>;
+    /**
+     * Remove a Lens from this session.
+     *
+     * When a Lens is removed, rendering continues if the session is playing. It will just render the session input
+     * directly to the outputs without any image processing.
+     *
+     * @returns A promise which can have the following results:
+     * 1. Resolved with `true`: the session's rendered output has no lens applied.
+     * 2. Resolved with `false`: the current lens has been removed, but a subsequent call to `applyLens` means that the
+     * session's rendered output will still have a (new) lens applied.
+     * 3. Rejected: the lens has failed to be removed. This can happen if an internal failure occurs in the Lens
+     * rendering engine when attempting to remove the lens.
+     */
+    removeLens(): Promise<boolean>;
+    /**
+     * Start/resume session playback – LensCore will begin rendering frames to the output.
+     *
+     * If no source has been set for the session, calling `play()` will update the playing state, but no actual image
+     * processing will occur until `setSource()` is called.
+     *
+     * @example
+     * ```ts
+     * const cameraKitSession = await cameraKit.createSession()
+     * await cameraKitSession.setSource(mySource)
+     * await cameraKitSession.play()
+     *
+     * // If you call `play` before `setSource`, the call to `play` will resolve but playback will only begin once a
+     * // media source has been set.
+     * ```
+     *
+     * @param target Specify the {@link RenderTarget} to render. Defaults to the `live` RenderTarget.
+     * @returns Promise resolves when playback state has been updated. If no source has been set, this means `play` will
+     * resolve before any frames are processed -- but once a source is set, frames will immediately begin processing.
+     */
+    play(target?: RenderTarget): Promise<void>;
+    /**
+     * Pause session playback – LensCore will stop rendering frames to the output.
+     *
+     * @param target Specify the RenderTarget to pause playback. May be either `'live'` or `'capture'`.
+     * Default is `'live'`.
+     * @returns Promise resolves when playback has stopped.
+     */
+    pause(target?: RenderTarget): Promise<void>;
+    /**
+     * Mute all sounds (default SDK state is unmuted).
+     *
+     * @param fade Do we want audio to fade out?
+     */
+    mute(fade?: boolean): void;
+    /**
+     * Unmute all sounds.
+     *
+     * @param fade Do we want audio to fade in?
+     */
+    unmute(fade?: boolean): void;
+    /**
+     * Set the media source for this session.
+     *
+     * Sessions may only have one source at a time - if `setSource` is called multiple times, subsequent calls replace
+     * the prior source. Setting the source does not trigger rendering (that’s done by `session.play()`). If the session
+     * is already playing, setting the source will immediately begin rendering the new source.
+     *
+     * The CameraKit SDK provides implementations for various common sources, which applications can create using the
+     * following functions:
+     * - {@link createMediaStreamSource}
+     * - {@link createVideoSource}
+     * - {@link createImageSource}
+     *
+     * @param source A CameraKitSource object representing input media (e.g. a webcam stream, video, or some other
+     * source of image data), which CameraKit will supply to Lenses in order for them to render effects on top of that
+     * source.
+     * @returns Promise is resolved when the source has successfully be set. If the session was already in the playing
+     * state, the Promise resolves when the first frame from the new source has been rendered. The resolved value is
+     * the {@link CameraKitSource} object attached to the session.
+     */
+    setSource(source: CameraKitSource): Promise<CameraKitSource>;
+    setSource(source: MediaStream | HTMLVideoElement, options?: Partial<CameraKitDeviceOptions>): Promise<CameraKitSource>;
+    /**
+     * Set an FPS limit.
+     *
+     * This may be useful to reduce CPU/GPU resource usage by CameraKit if, for example, the input
+     * media source has a low FPS – CameraKit would then not try to render more frequently than the source produces
+     * new frames.
+     *
+     * This may also be useful to gracefully degrade performance in situations where lowering FPS is preferable over
+     * alternatives.
+     *
+     * @param fpsLimit A maximum FPS, rendering will not exceed this limit
+     * @returns Promise is resolved when the limit is successfully set.
+     */
+    setFPSLimit(fpsLimit: number): Promise<void>;
+    /**
+     * Destroy the session.
+     *
+     * The session will become inoperable. Frame processing stops, and any session-scoped graphical resources are freed.
+     */
+    destroy(): Promise<void>;
+    private renderTargetToCanvasType;
+    private safelyDetachSource;
+}
+export { CameraKitSession };
+/**
+ * @internal
+ */
+export declare const cameraKitSessionFactory: {
+    (args_0: LensCore, args_1: Observable<LogEntry>, args_2: LensKeyboard, args_3: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"suspend", CameraKitSession> | import("@snap/state-management").Action<"resume", CameraKitSession> | import("@snap/state-management").Action<"destroy", undefined>, import("@snap/state-management").State<"inactive", undefined> | import("@snap/state-management").State<"active", CameraKitSession> | import("@snap/state-management").State<"destroyed", undefined>>, args_4: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"applyLens", {
+        lens: Lens;
+        launchData?: LensLaunchData | undefined;
+    }> | import("@snap/state-management").Action<"downloadComplete", Lens> | import("@snap/state-management").Action<"turnedOn", Lens> | import("@snap/state-management").Action<"resourcesLoaded", Lens> | import("@snap/state-management").Action<"firstFrameProcessed", Lens> | import("@snap/state-management").Action<"applyLensComplete", Lens> | import("@snap/state-management").Action<"applyLensFailed", {
+        error: import("./lensState").LensErrors;
+        lens: Lens;
+    }> | import("@snap/state-management").Action<"applyLensAborted", Lens> | import("@snap/state-management").Action<"removeLens", undefined> | import("@snap/state-management").Action<"turnedOff", Lens> | import("@snap/state-management").Action<"removeLensComplete", undefined> | import("@snap/state-management").Action<"removeLensFailed", Error>, import("@snap/state-management").State<"noLensApplied", undefined> | import("@snap/state-management").State<"applyingLens", Lens> | import("@snap/state-management").State<"lensApplied", Lens>>, args_5: PageVisibility): CameraKitSession;
+    token: "CameraKitSession";
+    dependencies: readonly ["lensCore", "logEntries", "lensKeyboard", "sessionState", "lensState", "pageVisibility"];
+};
+//# sourceMappingURL=CameraKitSession.d.ts.map

package/dist/session/CameraKitSession.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CameraKitSession.d.ts","sourceRoot":"","sources":["../../src/session/CameraKitSession.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAgB,MAAM,MAAM,CAAC;AAGrD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAIzC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAG7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE9D,OAAO,KAAK,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AAKhG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAIjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAG7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE7D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAmBvE;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC;AAE9C;;;;;;;;;;;;;;;;;GAiBG;AACH,cAAM,gBAAgB;IAyDd;;OAEG;aACa,QAAQ,EAAE,QAAQ;IAElC,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,SAAS;IA/D9B;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,MAAM,EAAE;QACb,IAAI,EAAE,iBAAiB,CAAC;QACxB,OAAO,EAAE,iBAAiB,CAAC;KAC9B,CAAC;IAEF;;;OAGG;IACH,OAAO,EAAE;QACL,IAAI,EAAE,OAAO,CAAC;QACd,OAAO,EAAE,OAAO,CAAC;KACpB,CAAC;IAEF;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,MAAM,2CAAkD;IAEjE;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAEzC,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAAa;IAC1D,OAAO,CAAC,MAAM,CAAC,CAAkB;IACjC,OAAO,CAAC,aAAa,CAAiB;IAEtC;;OAEG;;IAEC;;OAEG;IACa,QAAQ,EAAE,QAAQ,EAEjB,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,SAAS,EACrC,UAAU,EAAE,UAAU,CAAC,QAAQ,CAAC,EAChC,cAAc,EAAE,cAAc;IAsDlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IAGG,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IA8B1E;;;;;;;;;;;;OAYG;IAEG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAsBpC;;;;;;;;;;;;;;;;;;;OAmBG;IAGG,IAAI,CAAC,MAAM,GAAE,YAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAWxD;;;;;;OAMG;IAGG,KAAK,CAAC,MAAM,GAAE,YAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAUzD;;;;OAIG;IAEH,IAAI,CAAC,IAAI,GAAE,OAAe,GAAG,IAAI;IAOjC;;;;OAIG;IAEH,MAAM,CAAC,IAAI,GAAE,OAAe,GAAG,IAAI;IAOnC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAC5D,SAAS,CACX,MAAM,EAAE,WAAW,GAAG,gBAAgB,EACtC,OAAO,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAC1C,OAAO,CAAC,eAAe,CAAC;IAwC3B;;;;;;;;;;;;OAYG;IAGG,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMlD;;;;OAIG;IAEG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB9B,OAAO,CAAC,wBAAwB;YAIlB,kBAAkB;CAenC;AAGD,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAE5B;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;CAkBnC,CAAC"}

package/dist/session/CameraKitSession.js

@@ -0,0 +1,242 @@
+import { __awaiter, __esDecorate, __runInitializers } from "tslib";
+import { filter, firstValueFrom, map, of, takeUntil, tap } from "rxjs";
+import { dispatch, forActions, inStates, isAction, isState } from "@snap/state-management";
+import { isLens } from "../lens/Lens";
+import { Injectable } from "../dependency-injection/Injectable";
+import { lensCoreFactory } from "../lens-core-module/loader/lensCoreFactory";
+import { isLensLaunchDataOrUndefined } from "../lens/LensLaunchData";
+import { getTypeName, validate } from "../common/validate";
+import { TypedEventTarget } from "../events/TypedEventTarget";
+import { TypedCustomEvent } from "../events/TypedCustomEvent";
+import { isCameraKitSource, isPartialCameraKitDeviceOptionsOrUndefined } from "../media-sources/CameraKitSource";
+import { cameraKitSourceError } from "../namedErrors";
+import { createMediaStreamSource } from "../media-sources/MediaStreamSource";
+import { createVideoSource } from "../media-sources/VideoSource";
+import { getLogger } from "../logger/logger";
+import { errorLoggingDecorator } from "../logger/errorLoggingDecorator";
+import { logEntriesFactory } from "../logger/logEntries";
+import { pageVisibilityFactory } from "../common/pageVisibility";
+import { isUndefined, isValidNumber } from "../common/typeguards";
+import { LensPerformanceMetrics } from "./LensPerformanceMetrics";
+import { lensStateFactory } from "./lensState";
+import { sessionStateFactory } from "./sessionState";
+import { lensKeyboardFactory } from "./LensKeyboard";
+import { isPublicLensError } from "./CameraKitSessionEvents";
+const logger = getLogger("CameraKitSession");
+function isAllowedSource(value) {
+    return isCameraKitSource(value) || isMediaStream(value) || isHTMLVideoElement(value);
+}
+function isMediaStream(value) {
+    return value instanceof MediaStream;
+}
+function isHTMLVideoElement(value) {
+    return value instanceof HTMLVideoElement;
+}
+function isRenderTargetOrUndefined(value) {
+    return isUndefined(value) || value === "live" || value === "capture";
+}
+let CameraKitSession = (() => {
+    var _a;
+    let _instanceExtraInitializers = [];
+    let _applyLens_decorators;
+    let _removeLens_decorators;
+    let _play_decorators;
+    let _pause_decorators;
+    let _mute_decorators;
+    let _unmute_decorators;
+    let _setSource_decorators;
+    let _setFPSLimit_decorators;
+    let _destroy_decorators;
+    return _a = class CameraKitSession {
+            constructor(keyboard, lensCore, sessionState, lensState, logEntries, pageVisibility) {
+                this.keyboard = (__runInitializers(this, _instanceExtraInitializers), keyboard);
+                this.lensCore = lensCore;
+                this.sessionState = sessionState;
+                this.lensState = lensState;
+                this.events = new TypedEventTarget();
+                const outputs = this.lensCore.getOutputCanvases();
+                this.output = {
+                    live: outputs[this.lensCore.CanvasType.Preview.value],
+                    capture: outputs[this.lensCore.CanvasType.Capture.value],
+                };
+                this.playing = {
+                    live: false,
+                    capture: false,
+                };
+                this.metrics = new LensPerformanceMetrics(this.lensCore);
+                const removeOnHidden = pageVisibility.onPageHidden(() => this.sessionState.dispatch("suspend", this));
+                const removeOnVisible = pageVisibility.onPageVisible(() => this.sessionState.dispatch("resume", this));
+                this.removePageVisibilityHandlers = () => {
+                    removeOnHidden();
+                    removeOnVisible();
+                };
+                this.subscriptions = [
+                    lensCore.errors
+                        .pipe(filter((error) => error.name === "LensCoreAbortError"))
+                        .subscribe(() => this.destroy()),
+                    lensCore.errors
+                        .pipe(filter((error) => error.name !== "LensCoreAbortError" && error.isFrameError))
+                        .subscribe(() => this.removeLens()),
+                    logEntries
+                        .pipe(filter((entry) => entry.level === "error"), map((entry) => entry.messages.find((e) => e instanceof Error)), filter(isPublicLensError))
+                        .subscribe((error) => {
+                        const state = lensState.getState();
+                        if (!isState(state, "noLensApplied")) {
+                            this.events.dispatchEvent(new TypedCustomEvent("error", { error, lens: state.data }));
+                        }
+                        else {
+                            logger.warn("Lens error occurred even though there is no active lens.", error);
+                        }
+                    }),
+                ];
+            }
+            applyLens(lens, launchData) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    const action = this.lensState.actions.applyLens({ lens, launchData });
+                    return firstValueFrom(of(action).pipe(dispatch(this.lensState), takeUntil(this.lensState.events.pipe(forActions("applyLens"), filter(([a]) => a !== action))), tap(([a]) => {
+                        if (isAction(a, "applyLensFailed") && a.data.lens.id === lens.id)
+                            throw a.data.error;
+                    }), inStates("lensApplied"), map(() => true)), { defaultValue: false });
+                });
+            }
+            removeLens() {
+                return __awaiter(this, void 0, void 0, function* () {
+                    if (isState(this.lensState.getState(), "noLensApplied"))
+                        return true;
+                    return firstValueFrom(of(this.lensState.actions.removeLens()).pipe(dispatch(this.lensState), tap(([a]) => {
+                        if (isAction(a, "removeLensFailed"))
+                            throw a.data;
+                    }), inStates("noLensApplied"), takeUntil(this.lensState.events.pipe(forActions("applyLens"))), map(() => true)), { defaultValue: false });
+                });
+            }
+            play(target = "live") {
+                return __awaiter(this, void 0, void 0, function* () {
+                    if (this.playing[target])
+                        return;
+                    this.playing[target] = true;
+                    const type = this.renderTargetToCanvasType(target);
+                    return this.lensCore.playCanvas({ type }).catch((error) => {
+                        this.playing[target] = false;
+                        throw error;
+                    });
+                });
+            }
+            pause(target = "live") {
+                return __awaiter(this, void 0, void 0, function* () {
+                    if (this.playing[target] === false)
+                        return;
+                    this.playing[target] = false;
+                    const type = this.renderTargetToCanvasType(target);
+                    return this.lensCore.pauseCanvas({ type }).catch((error) => {
+                        this.playing[target] = true;
+                        throw error;
+                    });
+                });
+            }
+            mute(fade = false) {
+                this.lensCore.setAllSoundsMuted({
+                    muted: true,
+                    fade,
+                });
+            }
+            unmute(fade = false) {
+                this.lensCore.setAllSoundsMuted({
+                    muted: false,
+                    fade,
+                });
+            }
+            setSource(source, options = {}) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    yield this.safelyDetachSource();
+                    const cameraKitSource = isMediaStream(source)
+                        ? createMediaStreamSource(source, options)
+                        : isHTMLVideoElement(source)
+                            ? createVideoSource(source, options)
+                            : source;
+                    const priorPlayingState = this.playing;
+                    this.playing = {
+                        live: false,
+                        capture: false,
+                    };
+                    yield cameraKitSource.attach(this.lensCore, (error) => {
+                        logger.error(cameraKitSourceError("Error occurred during source attachment.", error));
+                    });
+                    this.source = cameraKitSource;
+                    if (priorPlayingState.live)
+                        yield this.play("live");
+                    if (priorPlayingState.capture)
+                        yield this.play("capture");
+                    return cameraKitSource;
+                });
+            }
+            setFPSLimit(fpsLimit) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    const fps = fpsLimit < Number.POSITIVE_INFINITY ? fpsLimit : 0;
+                    return this.lensCore.setFPSLimit({ fps });
+                });
+            }
+            destroy() {
+                return __awaiter(this, void 0, void 0, function* () {
+                    try {
+                        yield this.lensCore.clearAllLenses();
+                        yield this.lensCore.teardown();
+                    }
+                    catch (error) {
+                        logger.warn("An error occurred in LensCore during the session termination process.", error);
+                    }
+                    this.subscriptions.forEach((sub) => sub.unsubscribe());
+                    yield this.safelyDetachSource();
+                    this.removePageVisibilityHandlers();
+                    this.sessionState.dispatch("destroy", undefined);
+                });
+            }
+            renderTargetToCanvasType(target) {
+                return target === "capture" ? this.lensCore.CanvasType.Capture : this.lensCore.CanvasType.Preview;
+            }
+            safelyDetachSource() {
+                return __awaiter(this, void 0, void 0, function* () {
+                    if (this.source) {
+                        try {
+                            yield this.source.detach((error) => {
+                                logger.error(cameraKitSourceError("Error occurred during source detachment.", error));
+                            });
+                        }
+                        catch (error) {
+                            logger.error(cameraKitSourceError(`Detaching prior source of type ${getTypeName(this.source)} failed.`, error));
+                        }
+                    }
+                });
+            }
+        },
+        (() => {
+            _applyLens_decorators = [validate(isLens, isLensLaunchDataOrUndefined), errorLoggingDecorator(logger)];
+            _removeLens_decorators = [errorLoggingDecorator(logger)];
+            _play_decorators = [validate(isRenderTargetOrUndefined), errorLoggingDecorator(logger)];
+            _pause_decorators = [validate(isRenderTargetOrUndefined), errorLoggingDecorator(logger)];
+            _mute_decorators = [errorLoggingDecorator(logger)];
+            _unmute_decorators = [errorLoggingDecorator(logger)];
+            _setSource_decorators = [validate(isAllowedSource, isPartialCameraKitDeviceOptionsOrUndefined), errorLoggingDecorator(logger)];
+            _setFPSLimit_decorators = [validate(isValidNumber), errorLoggingDecorator(logger)];
+            _destroy_decorators = [errorLoggingDecorator(logger)];
+            __esDecorate(_a, null, _applyLens_decorators, { kind: "method", name: "applyLens", static: false, private: false, access: { has: obj => "applyLens" in obj, get: obj => obj.applyLens } }, null, _instanceExtraInitializers);
+            __esDecorate(_a, null, _removeLens_decorators, { kind: "method", name: "removeLens", static: false, private: false, access: { has: obj => "removeLens" in obj, get: obj => obj.removeLens } }, null, _instanceExtraInitializers);
+            __esDecorate(_a, null, _play_decorators, { kind: "method", name: "play", static: false, private: false, access: { has: obj => "play" in obj, get: obj => obj.play } }, null, _instanceExtraInitializers);
+            __esDecorate(_a, null, _pause_decorators, { kind: "method", name: "pause", static: false, private: false, access: { has: obj => "pause" in obj, get: obj => obj.pause } }, null, _instanceExtraInitializers);
+            __esDecorate(_a, null, _mute_decorators, { kind: "method", name: "mute", static: false, private: false, access: { has: obj => "mute" in obj, get: obj => obj.mute } }, null, _instanceExtraInitializers);
+            __esDecorate(_a, null, _unmute_decorators, { kind: "method", name: "unmute", static: false, private: false, access: { has: obj => "unmute" in obj, get: obj => obj.unmute } }, null, _instanceExtraInitializers);
+            __esDecorate(_a, null, _setSource_decorators, { kind: "method", name: "setSource", static: false, private: false, access: { has: obj => "setSource" in obj, get: obj => obj.setSource } }, null, _instanceExtraInitializers);
+            __esDecorate(_a, null, _setFPSLimit_decorators, { kind: "method", name: "setFPSLimit", static: false, private: false, access: { has: obj => "setFPSLimit" in obj, get: obj => obj.setFPSLimit } }, null, _instanceExtraInitializers);
+            __esDecorate(_a, null, _destroy_decorators, { kind: "method", name: "destroy", static: false, private: false, access: { has: obj => "destroy" in obj, get: obj => obj.destroy } }, null, _instanceExtraInitializers);
+        })(),
+        _a;
+})();
+export { CameraKitSession };
+export const cameraKitSessionFactory = Injectable("CameraKitSession", [
+    lensCoreFactory.token,
+    logEntriesFactory.token,
+    lensKeyboardFactory.token,
+    sessionStateFactory.token,
+    lensStateFactory.token,
+    pageVisibilityFactory.token,
+], (lensCore, logEntries, keyboard, sessionState, lensState, pageVisibility) => new CameraKitSession(keyboard, lensCore, sessionState, lensState, logEntries, pageVisibility));
+//# sourceMappingURL=CameraKitSession.js.map

package/dist/session/CameraKitSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CameraKitSession.js","sourceRoot":"","sources":["../../src/session/CameraKitSession.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAE3F,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,4CAA4C,CAAC;AAE7E,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE9D,OAAO,EAAE,iBAAiB,EAAE,0CAA0C,EAAE,MAAM,kCAAkC,CAAC;AACjH,OAAO,EAAE,oBAAoB,EAAsB,MAAM,gBAAgB,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAGjE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,MAAM,MAAM,GAAG,SAAS,CAAC,kBAAkB,CAAC,CAAC;AAE7C,SAAS,eAAe,CAAC,KAAc;IACnC,OAAO,iBAAiB,CAAC,KAAK,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,kBAAkB,CAAC,KAAK,CAAC,CAAC;AACzF,CAAC;AACD,SAAS,aAAa,CAAC,KAAc;IACjC,OAAO,KAAK,YAAY,WAAW,CAAC;AACxC,CAAC;AACD,SAAS,kBAAkB,CAAC,KAAc;IACtC,OAAO,KAAK,YAAY,gBAAgB,CAAC;AAC7C,CAAC;AAED,SAAS,yBAAyB,CAAC,KAAc;IAC7C,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,SAAS,CAAC;AACzE,CAAC;IA+BK,gBAAgB;;;;;;;;;;;;sBAAhB,gBAAgB;YAwDlB,YAIoB,QAAkB,EAEjB,QAAkB,EAClB,YAA0B,EAC1B,SAAoB,EACrC,UAAgC,EAChC,cAA8B;gBANd,aAAQ,yDAAR,QAAQ,EAAU;gBAEjB,aAAQ,GAAR,QAAQ,CAAU;gBAClB,iBAAY,GAAZ,YAAY,CAAc;gBAC1B,cAAS,GAAT,SAAS,CAAW;gBAtBhC,WAAM,GAAG,IAAI,gBAAgB,EAA0B,CAAC;gBA0B7D,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;gBAClD,IAAI,CAAC,MAAM,GAAG;oBACV,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC;oBACrD,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC;iBAC3D,CAAC;gBACF,IAAI,CAAC,OAAO,GAAG;oBACX,IAAI,EAAE,KAAK;oBACX,OAAO,EAAE,KAAK;iBACjB,CAAC;gBAEF,IAAI,CAAC,OAAO,GAAG,IAAI,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAEzD,MAAM,cAAc,GAAG,cAAc,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;gBACtG,MAAM,eAAe,GAAG,cAAc,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;gBACvG,IAAI,CAAC,4BAA4B,GAAG,GAAG,EAAE;oBACrC,cAAc,EAAE,CAAC;oBACjB,eAAe,EAAE,CAAC;gBACtB,CAAC,CAAC;gBAEF,IAAI,CAAC,aAAa,GAAG;oBAGjB,QAAQ,CAAC,MAAM;yBACV,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,oBAAoB,CAAC,CAAC;yBAC5D,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;oBAKpC,QAAQ,CAAC,MAAM;yBACV,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,oBAAoB,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;yBAClF,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;oBAGvC,UAAU;yBACL,IAAI,CACD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,OAAO,CAAC,EAC1C,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC,EAC9D,MAAM,CAAC,iBAAiB,CAAC,CAC5B;yBACA,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;wBACjB,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;wBACnC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,eAAe,CAAC,EAAE;4BAClC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,gBAAgB,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;yBACzF;6BAAM;4BAEH,MAAM,CAAC,IAAI,CAAC,0DAA0D,EAAE,KAAK,CAAC,CAAC;yBAClF;oBACL,CAAC,CAAC;iBACT,CAAC;YACN,CAAC;YAwCK,SAAS,CAAC,IAAU,EAAE,UAA2B;;oBACnD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;oBACtE,OAAO,cAAc,CACjB,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CACX,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAIxB,SAAS,CACL,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CACtB,UAAU,CAAC,WAAW,CAAC,EACvB,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAChC,CACJ,EAGD,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE;wBACR,IAAI,QAAQ,CAAC,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE;4BAAE,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;oBACzF,CAAC,CAAC,EAEF,QAAQ,CAAC,aAAa,CAAC,EAEvB,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAClB,EAGD,EAAE,YAAY,EAAE,KAAK,EAAE,CAC1B,CAAC;gBACN,CAAC;aAAA;YAgBK,UAAU;;oBACZ,IAAI,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,eAAe,CAAC;wBAAE,OAAO,IAAI,CAAC;oBACrE,OAAO,cAAc,CACjB,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CACxC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAExB,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE;wBACR,IAAI,QAAQ,CAAC,CAAC,EAAE,kBAAkB,CAAC;4BAAE,MAAM,CAAC,CAAC,IAAI,CAAC;oBACtD,CAAC,CAAC,EACF,QAAQ,CAAC,eAAe,CAAC,EAIzB,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,EAC9D,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAClB,EAGD,EAAE,YAAY,EAAE,KAAK,EAAE,CAC1B,CAAC;gBACN,CAAC;aAAA;YAwBK,IAAI,CAAC,SAAuB,MAAM;;oBACpC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;wBAAE,OAAO;oBAEjC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;oBAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;oBACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;wBACtD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;wBAC7B,MAAM,KAAK,CAAC;oBAChB,CAAC,CAAC,CAAC;gBACP,CAAC;aAAA;YAWK,KAAK,CAAC,SAAuB,MAAM;;oBACrC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK;wBAAE,OAAO;oBAC3C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;oBAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;oBACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;wBACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;wBAC5B,MAAM,KAAK,CAAC;oBAChB,CAAC,CAAC,CAAC;gBACP,CAAC;aAAA;YAQD,IAAI,CAAC,OAAgB,KAAK;gBACtB,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;oBAC5B,KAAK,EAAE,IAAI;oBACX,IAAI;iBACP,CAAC,CAAC;YACP,CAAC;YAQD,MAAM,CAAC,OAAgB,KAAK;gBACxB,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;oBAC5B,KAAK,EAAE,KAAK;oBACZ,IAAI;iBACP,CAAC,CAAC;YACP,CAAC;YA8BK,SAAS,CACX,MAAwD,EACxD,UAA2C,EAAE;;oBAE7C,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAIhC,MAAM,eAAe,GAAG,aAAa,CAAC,MAAM,CAAC;wBACzC,CAAC,CAAC,uBAAuB,CAAC,MAAM,EAAE,OAAO,CAAC;wBAC1C,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC;4BAC5B,CAAC,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC;4BACpC,CAAC,CAAC,MAAM,CAAC;oBAEb,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC;oBACvC,IAAI,CAAC,OAAO,GAAG;wBACX,IAAI,EAAE,KAAK;wBACX,OAAO,EAAE,KAAK;qBACjB,CAAC;oBAIF,MAAM,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;wBAClD,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAC,CAAC;oBAC1F,CAAC,CAAC,CAAC;oBAGH,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC;oBAG9B,IAAI,iBAAiB,CAAC,IAAI;wBAAE,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBACpD,IAAI,iBAAiB,CAAC,OAAO;wBAAE,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAE1D,OAAO,eAAe,CAAC;gBAC3B,CAAC;aAAA;YAiBK,WAAW,CAAC,QAAgB;;oBAE9B,MAAM,GAAG,GAAG,QAAQ,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC/D,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;gBAC9C,CAAC;aAAA;YAQK,OAAO;;oBACT,IAAI;wBACA,MAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;wBACrC,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;qBAClC;oBAAC,OAAO,KAAK,EAAE;wBAIZ,MAAM,CAAC,IAAI,CAAC,uEAAuE,EAAE,KAAK,CAAC,CAAC;qBAC/F;oBACD,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;oBACvD,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAChC,IAAI,CAAC,4BAA4B,EAAE,CAAC;oBACpC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;gBACrD,CAAC;aAAA;YAEO,wBAAwB,CAAC,MAAoB;gBACjD,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC;YACtG,CAAC;YAEa,kBAAkB;;oBAC5B,IAAI,IAAI,CAAC,MAAM,EAAE;wBACb,IAAI;4BACA,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gCAC/B,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAC,CAAC;4BAC1F,CAAC,CAAC,CAAC;yBAGN;wBAAC,OAAO,KAAK,EAAE;4BACZ,MAAM,CAAC,KAAK,CACR,oBAAoB,CAAC,kCAAkC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,CACpG,CAAC;yBACL;qBACJ;gBACL,CAAC;aAAA;;;qCA/QA,QAAQ,CAAC,MAAM,EAAE,2BAA2B,CAAC,EAC7C,qBAAqB,CAAC,MAAM,CAAC;sCA4C7B,qBAAqB,CAAC,MAAM,CAAC;gCA2C7B,QAAQ,CAAC,yBAAyB,CAAC,EACnC,qBAAqB,CAAC,MAAM,CAAC;iCAmB7B,QAAQ,CAAC,yBAAyB,CAAC,EACnC,qBAAqB,CAAC,MAAM,CAAC;gCAgB7B,qBAAqB,CAAC,MAAM,CAAC;kCAa7B,qBAAqB,CAAC,MAAM,CAAC;qCAkC7B,QAAQ,CAAC,eAAe,EAAE,0CAA0C,CAAC,EACrE,qBAAqB,CAAC,MAAM,CAAC;uCAkD7B,QAAQ,CAAC,aAAa,CAAC,EACvB,qBAAqB,CAAC,MAAM,CAAC;mCAY7B,qBAAqB,CAAC,MAAM,CAAC;YA1O9B,4KAAM,SAAS,wCA4Bd;YAgBD,+KAAM,UAAU,wCAoBf;YAwBD,6JAAM,IAAI,wCAST;YAWD,gKAAM,KAAK,wCAQV;YAQD,6JAAA,IAAI,wCAKH;YAQD,mKAAA,MAAM,wCAKL;YA8BD,4KAAM,SAAS,wCAkCd;YAiBD,kLAAM,WAAW,wCAIhB;YAQD,sKAAM,OAAO,wCAcZ;;;;AAwBL,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAK5B,MAAM,CAAC,MAAM,uBAAuB,GAAG,UAAU,CAC7C,kBAAkB,EAClB;IACI,eAAe,CAAC,KAAK;IACrB,iBAAiB,CAAC,KAAK;IACvB,mBAAmB,CAAC,KAAK;IACzB,mBAAmB,CAAC,KAAK;IACzB,gBAAgB,CAAC,KAAK;IACtB,qBAAqB,CAAC,KAAK;CACrB,EACV,CACI,QAAkB,EAClB,UAAgC,EAChC,QAAsB,EACtB,YAA0B,EAC1B,SAAoB,EACpB,cAA8B,EAChC,EAAE,CAAC,IAAI,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,CAAC,CACrG,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/member-ordering */\nimport type { Observable, Subscription } from \"rxjs\";\nimport { filter, firstValueFrom, map, of, takeUntil, tap } from \"rxjs\";\nimport { dispatch, forActions, inStates, isAction, isState } from \"@snap/state-management\";\nimport type { Lens } from \"../lens/Lens\";\nimport { isLens } from \"../lens/Lens\";\nimport { Injectable } from \"../dependency-injection/Injectable\";\nimport { lensCoreFactory } from \"../lens-core-module/loader/lensCoreFactory\";\nimport type { LensLaunchData } from \"../lens/LensLaunchData\";\nimport { isLensLaunchDataOrUndefined } from \"../lens/LensLaunchData\";\nimport { getTypeName, validate } from \"../common/validate\";\nimport { TypedEventTarget } from \"../events/TypedEventTarget\";\nimport { TypedCustomEvent } from \"../events/TypedCustomEvent\";\nimport type { CameraKitDeviceOptions, CameraKitSource } from \"../media-sources/CameraKitSource\";\nimport { isCameraKitSource, isPartialCameraKitDeviceOptionsOrUndefined } from \"../media-sources/CameraKitSource\";\nimport { cameraKitSourceError, LensExecutionError } from \"../namedErrors\";\nimport { createMediaStreamSource } from \"../media-sources/MediaStreamSource\";\nimport { createVideoSource } from \"../media-sources/VideoSource\";\nimport type { LogEntry } from \"../logger/logger\";\nimport { getLogger } from \"../logger/logger\";\nimport { errorLoggingDecorator } from \"../logger/errorLoggingDecorator\";\nimport { logEntriesFactory } from \"../logger/logEntries\";\nimport type { PageVisibility } from \"../common/pageVisibility\";\nimport { pageVisibilityFactory } from \"../common/pageVisibility\";\nimport type { LensCore } from \"../lens-core-module/lensCore\";\nimport type { CanvasType } from \"../lens-core-module/generated-types\";\nimport { isUndefined, isValidNumber } from \"../common/typeguards\";\nimport { LensPerformanceMetrics } from \"./LensPerformanceMetrics\";\nimport type { LensState } from \"./lensState\";\nimport { lensStateFactory } from \"./lensState\";\nimport type { SessionState } from \"./sessionState\";\nimport { sessionStateFactory } from \"./sessionState\";\nimport type { Keyboard, LensKeyboard } from \"./LensKeyboard\";\nimport { lensKeyboardFactory } from \"./LensKeyboard\";\nimport type { CameraKitSessionEvents } from \"./CameraKitSessionEvents\";\nimport { isPublicLensError } from \"./CameraKitSessionEvents\";\n\nconst logger = getLogger(\"CameraKitSession\");\n\nfunction isAllowedSource(value: unknown): value is CameraKitSource | MediaStream | HTMLVideoElement {\n    return isCameraKitSource(value) || isMediaStream(value) || isHTMLVideoElement(value);\n}\nfunction isMediaStream(value: unknown): value is MediaStream {\n    return value instanceof MediaStream;\n}\nfunction isHTMLVideoElement(value: unknown): value is HTMLVideoElement {\n    return value instanceof HTMLVideoElement;\n}\n\nfunction isRenderTargetOrUndefined(value: unknown): value is RenderTarget | undefined {\n    return isUndefined(value) || value === \"live\" || value === \"capture\";\n}\n\n/**\n * Enumerates the supported render targets.\n *\n * Lenses may render to different render targets, as designed by the lens creator. In CameraKit, it's possible to choose\n * which render target to render, and the result for each target is available as a separate `<canvas>` element.\n *\n * @category Rendering\n * @category Lenses\n */\nexport type RenderTarget = \"live\" | \"capture\";\n\n/**\n * A CameraKitSession represents a single rendering pipeline connecting an input media source to output `<canvas>`\n * elements. When a Lens is applied to the session, CameraKit uses the Lens to transform the input media into rendered\n * output.\n *\n * CameraKitSession is the primary object that applications interact with when integrating the CameraKit SDK.\n *\n * A CameraKitSession instance is obtained by calling {@link CameraKit.createSession}.\n *\n * @example\n * ```ts\n * const cameraKit = await bootstrapCameraKit(config)\n * const session = await cameraKit.createSession()\n * ```\n *\n * @category Rendering\n * @category Lenses\n */\nclass CameraKitSession {\n    /**\n     * CameraKitSession renders video output to a `<canvas>` element. In fact, each session contains two canvas outputs\n     * corresponding to the RenderTargets used by Lens creators, when using LensStudio to create a Lens.\n     *\n     * The `live` output renders content suitable for the Lens user (e.g. it may contain additional UI elements\n     * applicable only to the person applying the lens). The `capture` output renders content suitable for sharing with\n     * other users (e.g. sent to the other members of a video call, or saved to disk for sharing later).\n     *\n     * For many lenses, these outputs are identical – but each lens is free to render differently, based on its own\n     * use-case.\n     */\n    readonly output: {\n        live: HTMLCanvasElement;\n        capture: HTMLCanvasElement;\n    };\n\n    /**\n     * Indicates whether or not the session is currently rendering. If `false`, rendering is stopped. Otherwise the\n     * value indicates which output is being rendered.\n     */\n    playing: {\n        live: boolean;\n        capture: boolean;\n    };\n\n    /**\n     * Add event listeners here to handle events which occur during the CameraKitSession.\n     *\n     * **Note:** Applications may want to handle the `error` event, and check the contained error type -- if the type\n     * is {@link LensExecutionError}, this means the current lens was unable to render and CameraKit will automatically\n     * remove the lens.\n     *\n     * @example\n     * ```ts\n     * cameraKitSession.events.addEventListener('error', ({ detail }) => {\n     *   if (detail.error.name === 'LensExecutionError') {\n     *     console.log(`Lens ${detail.lens.name} encountered an error and was removed. Please pick a different lens.`)\n     *   }\n     * })\n     * ```\n     */\n    readonly events = new TypedEventTarget<CameraKitSessionEvents>();\n\n    /**\n     * Use this to measure current lens performance.\n     */\n    readonly metrics: LensPerformanceMetrics;\n\n    private readonly removePageVisibilityHandlers: () => void;\n    private source?: CameraKitSource;\n    private subscriptions: Subscription[];\n\n    /**\n     * @internal\n     */\n    constructor(\n        /**\n         * Use this to interact with lenses which require text input.\n         */\n        public readonly keyboard: Keyboard,\n\n        private readonly lensCore: LensCore,\n        private readonly sessionState: SessionState,\n        private readonly lensState: LensState,\n        logEntries: Observable<LogEntry>,\n        pageVisibility: PageVisibility\n    ) {\n        const outputs = this.lensCore.getOutputCanvases();\n        this.output = {\n            live: outputs[this.lensCore.CanvasType.Preview.value],\n            capture: outputs[this.lensCore.CanvasType.Capture.value],\n        };\n        this.playing = {\n            live: false,\n            capture: false,\n        };\n\n        this.metrics = new LensPerformanceMetrics(this.lensCore);\n\n        const removeOnHidden = pageVisibility.onPageHidden(() => this.sessionState.dispatch(\"suspend\", this));\n        const removeOnVisible = pageVisibility.onPageVisible(() => this.sessionState.dispatch(\"resume\", this));\n        this.removePageVisibilityHandlers = () => {\n            removeOnHidden();\n            removeOnVisible();\n        };\n\n        this.subscriptions = [\n            // In case of an abort error, the only option is to destroy the current session,\n            // as it becomes inoperable.\n            lensCore.errors\n                .pipe(filter((error) => error.name === \"LensCoreAbortError\"))\n                .subscribe(() => this.destroy()),\n\n            // In case of LensCore lens execution error, we must remove the lens from rendering\n            // NOTE: LensCore doesn't differentiate recoverable vs non-recoverable errors and\n            // it is recommended to always remove the lens.\n            lensCore.errors\n                .pipe(filter((error) => error.name !== \"LensCoreAbortError\" && error.isFrameError))\n                .subscribe(() => this.removeLens()),\n\n            // Forward logged errors that are public to the app\n            logEntries\n                .pipe(\n                    filter((entry) => entry.level === \"error\"),\n                    map((entry) => entry.messages.find((e) => e instanceof Error)),\n                    filter(isPublicLensError)\n                )\n                .subscribe((error) => {\n                    const state = lensState.getState();\n                    if (!isState(state, \"noLensApplied\")) {\n                        this.events.dispatchEvent(new TypedCustomEvent(\"error\", { error, lens: state.data }));\n                    } else {\n                        // NOTE: at this point the error is already reported, so we can just log a warning\n                        logger.warn(\"Lens error occurred even though there is no active lens.\", error);\n                    }\n                }),\n        ];\n    }\n\n    /**\n     * Apply a Lens to this session.\n     *\n     * This method will download (and cache) the Lens executable, and then use that Lens for rendering. If the session\n     * is currently playing, this will immediately update the rendered output. Otherwise, the new Lens will be used\n     * when session playback in resumed.\n     *\n     * Calling `applyLens` replaces any prior Lens – only one Lens is allowed at a time (per session).\n     *\n     * **NOTE**: Errors may occur after the Lens is applied. If the Lens encounters errors while rendering,\n     * Camera Kit will automatically remove the Lens from the session and emit a {@link LensExecutionError} event.\n     * Applications may want to listen for this error and, for example,\n     * prevent the Lens from being selected again by the user.\n     *\n     * ```ts\n     * session.events.addEventListener(\"error\", ({ detail }) => {\n     *   if (detail.error.name === \"LensExecutionError\") {\n     *     preventFutureLensSelection(detail.lens);\n     *     showMessage(\"We're sorry, but the Lens you selected encountered an error. Please choose a different Lens.\");\n     *   }\n     * });\n     * ```\n     *\n     * @param lens The Lens to apply to this session.\n     * @param launchData This can optionally be provided to pass some initial data to the Lens – only certain Lenses\n     * expect launch data.\n     * @returns A promise which can have the following results:\n     * 1. Resolved with `true`: the Lens has been applied.\n     * 2. Resolved with `false`: the Lens has not been applied, but no error occurred – this can happen if a\n     * subsequent call to `applyLens` interrupted the Lens application.\n     * 3. Rejected: the Lens has not been applied because an error occurred. This can happen if:\n     *   - The Lens ID cannot be found in the LensRepository (use LensRepository to load the Lens before calling this\n     *     method)\n     *   - Lens content download fails, or the download of any required lens assets fails.\n     *   - An internal failure occurs in the Lens rendering engine when attempting to apply the Lens.\n     */\n    @validate(isLens, isLensLaunchDataOrUndefined)\n    @errorLoggingDecorator(logger)\n    async applyLens(lens: Lens, launchData?: LensLaunchData): Promise<boolean> {\n        const action = this.lensState.actions.applyLens({ lens, launchData });\n        return firstValueFrom(\n            of(action).pipe(\n                dispatch(this.lensState),\n\n                // If another applyLens occurs while we're waiting, resolve this applyLens promise early – we're no\n                // longer waiting for the requested lens to be applied.\n                takeUntil(\n                    this.lensState.events.pipe(\n                        forActions(\"applyLens\"),\n                        filter(([a]) => a !== action)\n                    )\n                ),\n\n                // If lens application failed, convert this into a rejected promise by throwing the error.\n                tap(([a]) => {\n                    if (isAction(a, \"applyLensFailed\") && a.data.lens.id === lens.id) throw a.data.error;\n                }),\n\n                inStates(\"lensApplied\"),\n\n                map(() => true)\n            ),\n            // The default value is used if `takeUntil` completes the Observable early – i.e. the lens was not\n            // applied (application was interrupted by a new call to `applyLens`), so we'll resolve with `false`.\n            { defaultValue: false }\n        );\n    }\n\n    /**\n     * Remove a Lens from this session.\n     *\n     * When a Lens is removed, rendering continues if the session is playing. It will just render the session input\n     * directly to the outputs without any image processing.\n     *\n     * @returns A promise which can have the following results:\n     * 1. Resolved with `true`: the session's rendered output has no lens applied.\n     * 2. Resolved with `false`: the current lens has been removed, but a subsequent call to `applyLens` means that the\n     * session's rendered output will still have a (new) lens applied.\n     * 3. Rejected: the lens has failed to be removed. This can happen if an internal failure occurs in the Lens\n     * rendering engine when attempting to remove the lens.\n     */\n    @errorLoggingDecorator(logger)\n    async removeLens(): Promise<boolean> {\n        if (isState(this.lensState.getState(), \"noLensApplied\")) return true;\n        return firstValueFrom(\n            of(this.lensState.actions.removeLens()).pipe(\n                dispatch(this.lensState),\n                // If lens removal failed, convert this into a rejected promise by throwing the error.\n                tap(([a]) => {\n                    if (isAction(a, \"removeLensFailed\")) throw a.data;\n                }),\n                inStates(\"noLensApplied\"),\n\n                // If applyLens is called while we're waiting for removal, complete immediately – applying the next lens\n                // will replace the current one.\n                takeUntil(this.lensState.events.pipe(forActions(\"applyLens\"))),\n                map(() => true)\n            ),\n            // The default value is used if `takeUntil` completes the Observable early (otherwise firstValueFrom will\n            // return a rejected Promise).\n            { defaultValue: false }\n        );\n    }\n\n    /**\n     * Start/resume session playback – LensCore will begin rendering frames to the output.\n     *\n     * If no source has been set for the session, calling `play()` will update the playing state, but no actual image\n     * processing will occur until `setSource()` is called.\n     *\n     * @example\n     * ```ts\n     * const cameraKitSession = await cameraKit.createSession()\n     * await cameraKitSession.setSource(mySource)\n     * await cameraKitSession.play()\n     *\n     * // If you call `play` before `setSource`, the call to `play` will resolve but playback will only begin once a\n     * // media source has been set.\n     * ```\n     *\n     * @param target Specify the {@link RenderTarget} to render. Defaults to the `live` RenderTarget.\n     * @returns Promise resolves when playback state has been updated. If no source has been set, this means `play` will\n     * resolve before any frames are processed -- but once a source is set, frames will immediately begin processing.\n     */\n    @validate(isRenderTargetOrUndefined)\n    @errorLoggingDecorator(logger)\n    async play(target: RenderTarget = \"live\"): Promise<void> {\n        if (this.playing[target]) return;\n\n        this.playing[target] = true;\n        const type = this.renderTargetToCanvasType(target);\n        return this.lensCore.playCanvas({ type }).catch((error) => {\n            this.playing[target] = false;\n            throw error;\n        });\n    }\n\n    /**\n     * Pause session playback – LensCore will stop rendering frames to the output.\n     *\n     * @param target Specify the RenderTarget to pause playback. May be either `'live'` or `'capture'`.\n     * Default is `'live'`.\n     * @returns Promise resolves when playback has stopped.\n     */\n    @validate(isRenderTargetOrUndefined)\n    @errorLoggingDecorator(logger)\n    async pause(target: RenderTarget = \"live\"): Promise<void> {\n        if (this.playing[target] === false) return;\n        this.playing[target] = false;\n        const type = this.renderTargetToCanvasType(target);\n        return this.lensCore.pauseCanvas({ type }).catch((error) => {\n            this.playing[target] = true;\n            throw error;\n        });\n    }\n\n    /**\n     * Mute all sounds (default SDK state is unmuted).\n     *\n     * @param fade Do we want audio to fade out?\n     */\n    @errorLoggingDecorator(logger)\n    mute(fade: boolean = false): void {\n        this.lensCore.setAllSoundsMuted({\n            muted: true,\n            fade,\n        });\n    }\n\n    /**\n     * Unmute all sounds.\n     *\n     * @param fade Do we want audio to fade in?\n     */\n    @errorLoggingDecorator(logger)\n    unmute(fade: boolean = false): void {\n        this.lensCore.setAllSoundsMuted({\n            muted: false,\n            fade,\n        });\n    }\n\n    /**\n     * Set the media source for this session.\n     *\n     * Sessions may only have one source at a time - if `setSource` is called multiple times, subsequent calls replace\n     * the prior source. Setting the source does not trigger rendering (that’s done by `session.play()`). If the session\n     * is already playing, setting the source will immediately begin rendering the new source.\n     *\n     * The CameraKit SDK provides implementations for various common sources, which applications can create using the\n     * following functions:\n     * - {@link createMediaStreamSource}\n     * - {@link createVideoSource}\n     * - {@link createImageSource}\n     *\n     * @param source A CameraKitSource object representing input media (e.g. a webcam stream, video, or some other\n     * source of image data), which CameraKit will supply to Lenses in order for them to render effects on top of that\n     * source.\n     * @returns Promise is resolved when the source has successfully be set. If the session was already in the playing\n     * state, the Promise resolves when the first frame from the new source has been rendered. The resolved value is\n     * the {@link CameraKitSource} object attached to the session.\n     */\n    async setSource(source: CameraKitSource): Promise<CameraKitSource>;\n    async setSource(\n        source: MediaStream | HTMLVideoElement,\n        options?: Partial<CameraKitDeviceOptions>\n    ): Promise<CameraKitSource>;\n\n    @validate(isAllowedSource, isPartialCameraKitDeviceOptionsOrUndefined)\n    @errorLoggingDecorator(logger)\n    async setSource(\n        source: CameraKitSource | MediaStream | HTMLVideoElement,\n        options: Partial<CameraKitDeviceOptions> = {}\n    ): Promise<CameraKitSource> {\n        await this.safelyDetachSource();\n\n        // For convenience, we allow callers to pass in native objects (e.g. MediaStream) as well as CameraKitSource.\n        // Native objects are wrapped in corresponding CameraKitSource classes with default options.\n        const cameraKitSource = isMediaStream(source)\n            ? createMediaStreamSource(source, options)\n            : isHTMLVideoElement(source)\n            ? createVideoSource(source, options)\n            : source;\n\n        const priorPlayingState = this.playing;\n        this.playing = {\n            live: false,\n            capture: false,\n        };\n\n        // The source will provide its data to LensCore, and use other LensCore APIs (e.g. setRenderSize,\n        // setInputTransform) to render the source correctly.\n        await cameraKitSource.attach(this.lensCore, (error) => {\n            logger.error(cameraKitSourceError(\"Error occurred during source attachment.\", error));\n        });\n\n        // If attachment is successful, we'll update our source so that we can detach it later.\n        this.source = cameraKitSource;\n\n        // Finally we'll resume playback, if appropriate.\n        if (priorPlayingState.live) await this.play(\"live\");\n        if (priorPlayingState.capture) await this.play(\"capture\");\n\n        return cameraKitSource;\n    }\n\n    /**\n     * Set an FPS limit.\n     *\n     * This may be useful to reduce CPU/GPU resource usage by CameraKit if, for example, the input\n     * media source has a low FPS – CameraKit would then not try to render more frequently than the source produces\n     * new frames.\n     *\n     * This may also be useful to gracefully degrade performance in situations where lowering FPS is preferable over\n     * alternatives.\n     *\n     * @param fpsLimit A maximum FPS, rendering will not exceed this limit\n     * @returns Promise is resolved when the limit is successfully set.\n     */\n    @validate(isValidNumber)\n    @errorLoggingDecorator(logger)\n    async setFPSLimit(fpsLimit: number): Promise<void> {\n        // LensCore uses 0 to remove the limit.\n        const fps = fpsLimit < Number.POSITIVE_INFINITY ? fpsLimit : 0;\n        return this.lensCore.setFPSLimit({ fps });\n    }\n\n    /**\n     * Destroy the session.\n     *\n     * The session will become inoperable. Frame processing stops, and any session-scoped graphical resources are freed.\n     */\n    @errorLoggingDecorator(logger)\n    async destroy(): Promise<void> {\n        try {\n            await this.lensCore.clearAllLenses();\n            await this.lensCore.teardown();\n        } catch (error) {\n            // If a LensCore is in an aborted state, the above lines may throw an error.\n            // In such cases, we should continue with the cleanup process.\n            // We are also not interested in reporting these errors to our backend.\n            logger.warn(\"An error occurred in LensCore during the session termination process.\", error);\n        }\n        this.subscriptions.forEach((sub) => sub.unsubscribe());\n        await this.safelyDetachSource();\n        this.removePageVisibilityHandlers();\n        this.sessionState.dispatch(\"destroy\", undefined);\n    }\n\n    private renderTargetToCanvasType(target: RenderTarget): CanvasType {\n        return target === \"capture\" ? this.lensCore.CanvasType.Capture : this.lensCore.CanvasType.Preview;\n    }\n\n    private async safelyDetachSource(): Promise<void> {\n        if (this.source) {\n            try {\n                await this.source.detach((error) => {\n                    logger.error(cameraKitSourceError(\"Error occurred during source detachment.\", error));\n                });\n                // If there's a failure to detach, we will report the error and proceed. Failure to detach may lead to a\n                // memory leak, but it shouldn't prevent us from switching to the new source.\n            } catch (error) {\n                logger.error(\n                    cameraKitSourceError(`Detaching prior source of type ${getTypeName(this.source)} failed.`, error)\n                );\n            }\n        }\n    }\n}\n\n// NOTE: jest doesn't like default exports of classes with decorated methods.\nexport { CameraKitSession };\n\n/**\n * @internal\n */\nexport const cameraKitSessionFactory = Injectable(\n    \"CameraKitSession\",\n    [\n        lensCoreFactory.token,\n        logEntriesFactory.token,\n        lensKeyboardFactory.token,\n        sessionStateFactory.token,\n        lensStateFactory.token,\n        pageVisibilityFactory.token,\n    ] as const,\n    (\n        lensCore: LensCore,\n        logEntries: Observable<LogEntry>,\n        keyboard: LensKeyboard,\n        sessionState: SessionState,\n        lensState: LensState,\n        pageVisibility: PageVisibility\n    ) => new CameraKitSession(keyboard, lensCore, sessionState, lensState, logEntries, pageVisibility)\n);\n"]}

package/dist/session/CameraKitSessionEvents.d.ts

@@ -0,0 +1,29 @@
+import type { LensExecutionError, LensImagePickerError, LensAbortError } from "../namedErrors";
+import type { TypedCustomEvent } from "../events/TypedCustomEvent";
+import type { TypedEventListener } from "../events/TypedEventTarget";
+import type { Lens } from "../lens/Lens";
+/**
+ * Events emitted by {@link CameraKitSession.events | CameraKitSession.events}.
+ *
+ * The following events are emitted:
+ *   - `error`: An error has been encountered during lens rendering. May contain an error of type:
+ *     - {@link LensExecutionError} If an error of this type occurs, the rendering lens will be automatically removed
+ * from the associated CameraKitSession.
+ *     - {@link LensImagePickerError}
+ *
+ * @category Rendering
+ * @category Lenses
+ */
+export type CameraKitSessionEvents = TypedCustomEvent<"error", {
+    error: LensExecutionError | LensAbortError | LensImagePickerError;
+    lens: Lens;
+}>;
+/**
+ * Listener of {@link CameraKitSessionEvents} events.
+ */
+export type CameraKitSessionEventListener = TypedEventListener<CameraKitSessionEvents>;
+/**
+ * Determines if the value is an error to be reported to the host application.
+ */
+export declare function isPublicLensError(value: unknown): value is CameraKitSessionEvents["detail"]["error"];
+//# sourceMappingURL=CameraKitSessionEvents.d.ts.map

package/dist/session/CameraKitSessionEvents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CameraKitSessionEvents.d.ts","sourceRoot":"","sources":["../../src/session/CameraKitSessionEvents.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC/F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAOzC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CACjD,OAAO,EACP;IAAE,KAAK,EAAE,kBAAkB,GAAG,cAAc,GAAG,oBAAoB,CAAC;IAAC,IAAI,EAAE,IAAI,CAAA;CAAE,CACpF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;AAEvF;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,sBAAsB,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAYpG"}

package/dist/session/CameraKitSessionEvents.js

@@ -0,0 +1,15 @@
+const isReachable = (_) => false;
+export function isPublicLensError(value) {
+    if (!(value instanceof Error))
+        return false;
+    const maybeSessionErrorName = value.name;
+    switch (maybeSessionErrorName) {
+        case "LensAbortError":
+        case "LensExecutionError":
+        case "LensImagePickerError":
+            return true;
+        default:
+            return isReachable(maybeSessionErrorName);
+    }
+}
+//# sourceMappingURL=CameraKitSessionEvents.js.map

package/dist/session/CameraKitSessionEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CameraKitSessionEvents.js","sourceRoot":"","sources":["../../src/session/CameraKitSessionEvents.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,GAAG,CAAC,CAAQ,EAAE,EAAE,CAAC,KAAK,CAAC;AA2BxC,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC5C,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAE5C,MAAM,qBAAqB,GAAI,KAAmD,CAAC,IAAI,CAAC;IACxF,QAAQ,qBAAqB,EAAE;QAC3B,KAAK,gBAAgB,CAAC;QACtB,KAAK,oBAAoB,CAAC;QAC1B,KAAK,sBAAsB;YACvB,OAAO,IAAI,CAAC;QAChB;YACI,OAAO,WAAW,CAAC,qBAAqB,CAAC,CAAC;KACjD;AACL,CAAC","sourcesContent":["import type { LensExecutionError, LensImagePickerError, LensAbortError } from \"../namedErrors\";\nimport type { TypedCustomEvent } from \"../events/TypedCustomEvent\";\nimport type { TypedEventListener } from \"../events/TypedEventTarget\";\nimport type { Lens } from \"../lens/Lens\";\n\n/**\n * A type guard helper to detect unreachable code.\n */\nconst isReachable = (_: never) => false;\n\n/**\n * Events emitted by {@link CameraKitSession.events | CameraKitSession.events}.\n *\n * The following events are emitted:\n *   - `error`: An error has been encountered during lens rendering. May contain an error of type:\n *     - {@link LensExecutionError} If an error of this type occurs, the rendering lens will be automatically removed\n * from the associated CameraKitSession.\n *     - {@link LensImagePickerError}\n *\n * @category Rendering\n * @category Lenses\n */\nexport type CameraKitSessionEvents = TypedCustomEvent<\n    \"error\",\n    { error: LensExecutionError | LensAbortError | LensImagePickerError; lens: Lens }\n>;\n\n/**\n * Listener of {@link CameraKitSessionEvents} events.\n */\nexport type CameraKitSessionEventListener = TypedEventListener<CameraKitSessionEvents>;\n\n/**\n * Determines if the value is an error to be reported to the host application.\n */\nexport function isPublicLensError(value: unknown): value is CameraKitSessionEvents[\"detail\"][\"error\"] {\n    if (!(value instanceof Error)) return false;\n\n    const maybeSessionErrorName = (value as CameraKitSessionEvents[\"detail\"][\"error\"]).name;\n    switch (maybeSessionErrorName) {\n        case \"LensAbortError\":\n        case \"LensExecutionError\":\n        case \"LensImagePickerError\":\n            return true;\n        default:\n            return isReachable(maybeSessionErrorName);\n    }\n}\n"]}