@snap/camera-kit 0.7.0

package/lib/media-sources/FunctionSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionSource.js","sourceRoot":"","sources":["../../src/media-sources/FunctionSource.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,eAAe,EAAqD,MAAM,mBAAmB,CAAC;AAEvG,MAAM,eAAe,GAAG,CAAO,MAAyB,EAAE,QAAwB,EAAsB,EAAE;IACtG,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IACjC,0FAA0F;IAC1F,MAAM,YAAY,GAAG,IAAI,WAAW,CAAC,CAAC,KAAK,GAAG,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/D,MAAM,IAAI,OAAO,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE;QACvC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IACpG,CAAC,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,YAAY,CAAC,CAAC;IACnD,OAAO,IAAI,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAChD,CAAC,CAAA,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,MAAyB,EAAE,aAA8C,EAAa,EAAE;IAC7G,IAAI,aAAa,KAAK,IAAI;QAAE,OAAO,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACvD,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACtC,OAAO,aAAa,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;AACzE,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAO,SAAoB,EAAE,MAAmB,EAAwB,EAAE;IAC7F,QAAQ,MAAM,EAAE;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,KAAK;YACN,IAAI,CAAC,MAAM,CAAC,UAAU;gBAClB,OAAO,OAAO,CAAC,MAAM,CACjB,IAAI,KAAK,CAAC,sCAAsC,MAAM,GAAG,GAAG,mCAAmC,CAAC,CACnG,CAAC;YACN,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE;gBAChD,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE,SAAS,CAAC,KAAK;gBAC3B,WAAW,EAAE,SAAS,CAAC,MAAM;gBAC7B,SAAS,EAAE,CAAC;aACf,CAAC,CAAC;YACH,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACpC,KAAK,KAAK;YACN,OAAO,iBAAiB,CAAC,SAAS,CAAC,CAAC;KAC3C;AACL,CAAC,CAAA,CAAC;AAuBF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAChC,cAAmC,EACnC,UAAoD,EAAE,EACvC,EAAE;IACjB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,kBAAkB,GAAG,IAAI,CAAC;IAE9B,kHAAkH;IAClH,6EAA6E;IAC7E,MAAM,iBAAiB,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC3D,MAAM,aAAa,GAAG,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEzD,MAAM,UAAU,GAA8B;QAC1C,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE;YACxC,MAAM,OAAO,GAAG,QAAQ,CAAC,iBAAiB,EAAE,CAAC;YAC7C,MAAM,MAAM,GAAG;gBACX,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC;gBAChD,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC;aACtD,CAAC;YAEF,MAAM,YAAY,GAAG,CACjB,MAAuB,EACvB,QAAwB,EACxB,WAAmC,EACrC,EAAE,CACA,qBAAqB,CAAC,GAAS,EAAE;;gBAC7B,IAAI,CAAC,kBAAkB;oBAAE,OAAO;gBAChC,IAAI;oBACA,MAAM,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,EAAE,EAAE;wBAC5D,MAAM,WAAW,GAAG,IAAI,OAAO,CAAc,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;4BACnE,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,SAAS,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC,CAAC;4BACpE,IAAI,UAAU,CAAC,KAAK,KAAK,KAAK,IAAI,UAAU,CAAC,MAAM,KAAK,MAAM,EAAE;gCAC5D,KAAK,GAAG,iBAAiB,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;gCACnD,MAAM,GAAG,iBAAiB,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;gCACtD,iFAAiF;gCACjF,kFAAkF;gCAClF,SAAS;gCACT,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;6BACvC;4BACD,QAAQ,CAAC,YAAY,CAAC;gCAClB,UAAU;gCACV,eAAe;gCACf,SAAS,EAAE,GAAS,EAAE;oCAClB,6EAA6E;oCAC7E,sBAAsB;oCACtB,UAAU,CAAC,KAAK,EAAE,CAAC;oCAEnB,QAAQ,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,EAAE;wCACrB,KAAK,MAAM,CAAC;wCACZ,KAAK,KAAK;4CACN,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gDACtC,eAAe,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC;gDACtC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC;6CAC5C,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gDACf,MAAM,CAAC,KAAK,CAAC,CAAC;gDACd,OAAO,CAAC,SAAS,EAAE,SAAS,CAAU,CAAC;4CAC3C,CAAC,CAAC,CAAC;4CACH,+DAA+D;4CAC/D,iCAAiC;4CACjC,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO;gDAAE,OAAO;4CAC9B,OAAO,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;wCACtC,KAAK,KAAK;4CACN,OAAO,OAAO,CAAC;gDACX,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC;gDACjD,OAAO,EAAE,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC;6CAC1D,CAAC,CAAC;qCACV;gCACL,CAAC,CAAA;gCACD,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;oCACjB,UAAU,CAAC,KAAK,EAAE,CAAC;oCACnB,MAAM,CAAC,KAAK,CAAC,CAAC;gCAClB,CAAC;6BACJ,CAAC,CAAC;wBACP,CAAC,CAAA,CAAC,CAAC;wBACH,2FAA2F;wBAC3F,gFAAgF;wBAChF,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;wBACvE,OAAO,WAAW,CAAC;oBACvB,CAAC,CAAC,CAAC;iBACN;gBAAC,OAAO,KAAK,EAAE;oBACZ,WAAW,CACP,IAAI,KAAK,CACL,kEAAkE;wBAC9D,uBAAuB,MAAA,cAAc,CAAC,IAAI,mCAAI,WAAW,GAAG,EAChE,EAAE,KAAK,EAAE,KAAK,EAAE,CACnB,CACJ,CAAC;iBACL;YACL,CAAC,CAAA,CAAC,CAAC;YACP,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAChD,CAAC;QACD,QAAQ,EAAE,GAAG,EAAE;YACX,kBAAkB,GAAG,KAAK,CAAC;QAC/B,CAAC;KACJ,CAAC;IAEF,OAAO,IAAI,eAAe,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;AACxF,CAAC,CAAC","sourcesContent":["import { LensCoreModule } from \"../lens-core-module/generated-types\";\nimport { CameraKitSource, CameraKitSourceOptions, CameraKitSourceSubscriber } from \"./CameraKitSource\";\n\nconst getYUVImageData = async (canvas: HTMLCanvasElement, lensCore: LensCoreModule): Promise<ImageData> => {\n    const { width, height } = canvas;\n    // A YUV buffer has lower-res UV channels, so the total number of bytes works out like so:\n    const outputBuffer = new ArrayBuffer((width * height * 3) / 2);\n    await new Promise((onSuccess, onFailure) => {\n        lensCore.imageToYuvBuffer({ image: canvas, width, height, outputBuffer, onSuccess, onFailure });\n    });\n    const pixels = new Uint8ClampedArray(outputBuffer);\n    return new ImageData(pixels, width, height);\n};\n\nconst getRGBImageData = (output: HTMLCanvasElement, imageReader2D: CanvasRenderingContext2D | null): ImageData => {\n    if (imageReader2D === null) return new ImageData(0, 0);\n    imageReader2D.drawImage(output, 0, 0);\n    return imageReader2D.getImageData(0, 0, output.width, output.height);\n};\n\nconst getImageBitmap = async (imageData: ImageData, format: FrameFormat): Promise<ImageBitmap> => {\n    switch (format) {\n        case \"nv12\":\n        case \"yuv\":\n            if (!window.VideoFrame)\n                return Promise.reject(\n                    new Error(`Cannot process frame. ImageData in ${format} ` + `is not supported by this browser.`)\n                );\n            const frame = new VideoFrame(imageData.data.buffer, {\n                format: \"NV12\",\n                codedWidth: imageData.width,\n                codedHeight: imageData.height,\n                timestamp: 0,\n            });\n            return createImageBitmap(frame);\n        case \"rgb\":\n            return createImageBitmap(imageData);\n    }\n};\n\n/** @internal */\nexport type FrameFormat = \"rgb\" | \"yuv\" | \"nv12\";\n\n/** @internal */\nexport interface FrameInput {\n    format?: FrameFormat;\n    imageData: ImageData;\n    timestampMillis: number;\n}\n\n/** @internal */\nexport interface FrameOutput {\n    live: ImageData;\n    capture: ImageData;\n}\n\n/** @internal */\nexport interface MediaSourceFunction {\n    (render: (frame: FrameInput) => Promise<FrameOutput>): Promise<void>;\n}\n\n/**\n * Creates a {@link CameraKitSource} from a function which provides per-frame pixel data to CameraKit.\n *\n * @param sourceFunction This function will be called in a requestAnimationFrame loop. Each time it is called, it is\n * passed a `render` function. It may call `render` and CameraKit will process the pixel data passed to `render` and\n * return a Promise of the processed pixels (along with rendering them to the normal output canvases).\n * @param options\n * @param options.cameraType By default we set this to 'front', which is the camera type most Lenses expect.\n *\n * @internal\n */\nexport const createFunctionSource = (\n    sourceFunction: MediaSourceFunction,\n    options: Omit<CameraKitSourceOptions, \"fpsLimit\"> = {}\n): CameraKitSource => {\n    let width = 0;\n    let height = 0;\n    let shouldProcessFrame = true;\n\n    // We require an auxiliary canvas that we can use to read back pixel data (unless we're in YUV mode, in which case\n    // we use LensCore to convert between formats and we don't need this canvas).\n    const imageReaderCanvas = document.createElement(\"canvas\");\n    const imageReader2D = imageReaderCanvas.getContext(\"2d\");\n\n    const subscriber: CameraKitSourceSubscriber = {\n        onAttach: (source, lensCore, reportError) => {\n            const outputs = lensCore.getOutputCanvases();\n            const output = {\n                live: outputs[lensCore.CanvasType.Preview.value],\n                capture: outputs[lensCore.CanvasType.Capture.value],\n            };\n\n            const processFrame = (\n                source: CameraKitSource,\n                lensCore: LensCoreModule,\n                reportError: (error: Error) => void\n            ) =>\n                requestAnimationFrame(async () => {\n                    if (!shouldProcessFrame) return;\n                    try {\n                        await sourceFunction(({ format, imageData, timestampMillis }) => {\n                            const frameOutput = new Promise<FrameOutput>(async (resolve, reject) => {\n                                const inputFrame = await getImageBitmap(imageData, format ?? \"rgb\");\n                                if (inputFrame.width !== width || inputFrame.height !== height) {\n                                    width = imageReaderCanvas.width = inputFrame.width;\n                                    height = imageReaderCanvas.height = inputFrame.height;\n                                    // We don't await this promise, because we want to continue to process frames and\n                                    // let LensCore manage the concurrency between setting resolution and processing a\n                                    // frame.\n                                    source.setRenderSize(width, height);\n                                }\n                                lensCore.processFrame({\n                                    inputFrame,\n                                    timestampMillis,\n                                    onSuccess: async () => {\n                                        // Closing releases graphics resources associated with the frame, now that is\n                                        // has been processed.\n                                        inputFrame.close();\n\n                                        switch (format ?? \"rgb\") {\n                                            case \"nv12\":\n                                            case \"yuv\":\n                                                const [live, capture] = await Promise.all([\n                                                    getYUVImageData(output.live, lensCore),\n                                                    getYUVImageData(output.capture, lensCore),\n                                                ]).catch((error) => {\n                                                    reject(error);\n                                                    return [undefined, undefined] as const;\n                                                });\n                                                // if either of these is undefined, we'll have already rejected\n                                                // the promise, so we can return.\n                                                if (!live || !capture) return;\n                                                return resolve({ live, capture });\n                                            case \"rgb\":\n                                                return resolve({\n                                                    live: getRGBImageData(output.live, imageReader2D),\n                                                    capture: getRGBImageData(output.capture, imageReader2D),\n                                                });\n                                        }\n                                    },\n                                    onFailure: (error) => {\n                                        inputFrame.close();\n                                        reject(error);\n                                    },\n                                });\n                            });\n                            // Even if there's an error processing the frame, we do want to attempt to process the next\n                            // frame. We expect `sourceFunction` to handle a rejected `frameOutput` Promise.\n                            frameOutput.finally(() => processFrame(source, lensCore, reportError));\n                            return frameOutput;\n                        });\n                    } catch (error) {\n                        reportError(\n                            new Error(\n                                \"Failure to process frame, which was not handled by the provided \" +\n                                    `MediaSourceFunction ${sourceFunction.name ?? \"anonymous\"}.`,\n                                { cause: error }\n                            )\n                        );\n                    }\n                });\n            processFrame(source, lensCore, reportError);\n        },\n        onDetach: () => {\n            shouldProcessFrame = false;\n        },\n    };\n\n    return new CameraKitSource({ useManualFrameProcessing: true }, subscriber, options);\n};\n"]}

package/lib/media-sources/ImageSource.d.ts

@@ -0,0 +1,13 @@
+import { CameraKitSource, CameraKitSourceOptions } from "./CameraKitSource";
+/**
+ * Create a {@link CameraKitSource} from an
+ * [HTMLImageElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement).
+ *
+ * @param image Image element.
+ * @param options
+ * @param options.cameraType By default we set this to 'front', which is the camera type most Lenses expect.
+ * @param options.fpsLimit By default we set no limit on FPS.
+ *
+ * @category Rendering
+ */
+export declare function createImageSource(image: HTMLImageElement, options?: CameraKitSourceOptions): CameraKitSource;

package/lib/media-sources/ImageSource.js

@@ -0,0 +1,28 @@
+import { CameraKitSource } from "./CameraKitSource";
+/**
+ * Create a {@link CameraKitSource} from an
+ * [HTMLImageElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement).
+ *
+ * @param image Image element.
+ * @param options
+ * @param options.cameraType By default we set this to 'front', which is the camera type most Lenses expect.
+ * @param options.fpsLimit By default we set no limit on FPS.
+ *
+ * @category Rendering
+ */
+export function createImageSource(image, options = {}) {
+    return new CameraKitSource({
+        media: image,
+    }, {
+        onAttach: (source) => {
+            // If the image element has no explicit width/height (which may be the case for elements that have not
+            // been added to the DOM or had their size set explicitly), we'll render at the image's native
+            // resolution.
+            const [width, height] = image.width === 0 || image.height === 0
+                ? [image.naturalWidth, image.naturalHeight]
+                : [image.width, image.height];
+            return source.setRenderSize(width, height);
+        },
+    }, options);
+}
+//# sourceMappingURL=ImageSource.js.map

package/lib/media-sources/ImageSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImageSource.js","sourceRoot":"","sources":["../../src/media-sources/ImageSource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAA0B,MAAM,mBAAmB,CAAC;AAE5E;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAuB,EAAE,UAAkC,EAAE;IAC3F,OAAO,IAAI,eAAe,CACtB;QACI,KAAK,EAAE,KAAK;KACf,EACD;QACI,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE;YACjB,sGAAsG;YACtG,8FAA8F;YAC9F,cAAc;YACd,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GACjB,KAAK,CAAC,KAAK,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBACnC,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,aAAa,CAAC;gBAC3C,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtC,OAAO,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;KACJ,EACD,OAAO,CACV,CAAC;AACN,CAAC","sourcesContent":["import { CameraKitSource, CameraKitSourceOptions } from \"./CameraKitSource\";\n\n/**\n * Create a {@link CameraKitSource} from an\n * [HTMLImageElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement).\n *\n * @param image Image element.\n * @param options\n * @param options.cameraType By default we set this to 'front', which is the camera type most Lenses expect.\n * @param options.fpsLimit By default we set no limit on FPS.\n *\n * @category Rendering\n */\nexport function createImageSource(image: HTMLImageElement, options: CameraKitSourceOptions = {}): CameraKitSource {\n    return new CameraKitSource(\n        {\n            media: image,\n        },\n        {\n            onAttach: (source) => {\n                // If the image element has no explicit width/height (which may be the case for elements that have not\n                // been added to the DOM or had their size set explicitly), we'll render at the image's native\n                // resolution.\n                const [width, height] =\n                    image.width === 0 || image.height === 0\n                        ? [image.naturalWidth, image.naturalHeight]\n                        : [image.width, image.height];\n\n                return source.setRenderSize(width, height);\n            },\n        },\n        options\n    );\n}\n"]}

package/lib/media-sources/MediaStreamSource.d.ts

@@ -0,0 +1,41 @@
+import { Transform2D } from "../transforms";
+import { CameraKitSource, CameraKitSourceOptions } from "./CameraKitSource";
+/** @category Rendering */
+export interface MediaStreamSourceOptions {
+    transform: Transform2D;
+    disableSourceAudio: boolean;
+}
+/**
+ * Create a {@link CameraKitSource} from a user's media device -- this calls
+ * [MediaDevices.getUserMedia](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) to get a
+ * MediaStream and then calls {@link createMediaStreamSource}.
+ *
+ * @param constraints Specify contraints used to get a MediaStream from a media device. By default we simply request
+ * a video stream.
+ * @param options
+ * @param options.transform By default we horizontally mirror the video stream. The most common use-case is to obtain a
+ * stream from a front-facing web cam, which requires mirroring to be viewed naturally.
+ * @param options.cameraType By default we set this to 'front' to indicate a camera pointed at the user (e.g. a webcam).
+ * @param options.fpsLimit By default we set no limit on FPS – if the source device has a known FPS setting this limit
+ * may prevent CameraKit from using more compute resources than strictly necessary.
+ * @returns A Promise, resolving to {@link CameraKitSource}
+ *
+ * @category Rendering
+ */
+export declare function createUserMediaSource(constraints?: MediaStreamConstraints, options?: CameraKitSourceOptions<MediaStreamSourceOptions>): Promise<CameraKitSource>;
+/**
+ * Create a {@link CameraKitSource} from any
+ * [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream).
+ *
+ * @param stream Any MediaStream, such as obtained via `canvas.captureStream()`
+ * @param options
+ * @param options.transform We apply no transformation by default.
+ * @param options.disableSourceAudio By default we pass audio to lens. Settings this to true will disable sending audio
+ * to the lens.
+ * @param options.cameraType By default we set this to 'front', which is the camera type most Lenses expect.
+ * @param options.fpsLimit By default we set no limit on FPS – if the MediaStream has a known FPS setting this limit
+ * may prevent CameraKit from using more compute resources than strictly necessary.
+ *
+ * @category Rendering
+ */
+export declare function createMediaStreamSource(stream: MediaStream, options?: CameraKitSourceOptions<MediaStreamSourceOptions>): CameraKitSource;

package/lib/media-sources/MediaStreamSource.js

@@ -0,0 +1,146 @@
+import { __awaiter } from "tslib";
+import { Transform2D } from "../transforms";
+import { CameraKitSource } from "./CameraKitSource";
+const defaultOptions = {
+    transform: Transform2D.Identity,
+    disableSourceAudio: false,
+};
+/**
+ * Create a {@link CameraKitSource} from a user's media device -- this calls
+ * [MediaDevices.getUserMedia](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) to get a
+ * MediaStream and then calls {@link createMediaStreamSource}.
+ *
+ * @param constraints Specify contraints used to get a MediaStream from a media device. By default we simply request
+ * a video stream.
+ * @param options
+ * @param options.transform By default we horizontally mirror the video stream. The most common use-case is to obtain a
+ * stream from a front-facing web cam, which requires mirroring to be viewed naturally.
+ * @param options.cameraType By default we set this to 'front' to indicate a camera pointed at the user (e.g. a webcam).
+ * @param options.fpsLimit By default we set no limit on FPS – if the source device has a known FPS setting this limit
+ * may prevent CameraKit from using more compute resources than strictly necessary.
+ * @returns A Promise, resolving to {@link CameraKitSource}
+ *
+ * @category Rendering
+ */
+export function createUserMediaSource(constraints = { video: true }, options = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const stream = yield navigator.mediaDevices.getUserMedia(constraints);
+        return createMediaStreamSource(stream, Object.assign({ transform: Transform2D.MirrorX, cameraType: "front" }, options));
+    });
+}
+/**
+ * Create a {@link CameraKitSource} from any
+ * [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream).
+ *
+ * @param stream Any MediaStream, such as obtained via `canvas.captureStream()`
+ * @param options
+ * @param options.transform We apply no transformation by default.
+ * @param options.disableSourceAudio By default we pass audio to lens. Settings this to true will disable sending audio
+ * to the lens.
+ * @param options.cameraType By default we set this to 'front', which is the camera type most Lenses expect.
+ * @param options.fpsLimit By default we set no limit on FPS – if the MediaStream has a known FPS setting this limit
+ * may prevent CameraKit from using more compute resources than strictly necessary.
+ *
+ * @category Rendering
+ */
+export function createMediaStreamSource(stream, options = {}) {
+    const optionsNotNull = Object.assign(Object.assign({}, defaultOptions), options);
+    const { width, height } = stream.getVideoTracks().length > 0 ? stream.getVideoTracks()[0].getSettings() : { width: 0, height: 0 };
+    const enableSourceAudio = stream.getAudioTracks().length > 0 && !optionsNotNull.disableSourceAudio;
+    const simulateStereoAudio = true;
+    const sampleRate = 44100;
+    let audioContext = undefined;
+    let audioSource = undefined;
+    let microphoneRecorderUrl;
+    if (enableSourceAudio) {
+        // https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Using_AudioWorklet
+        const microphoneRecorderWorklet = `
+        class MicrophoneWorkletProcessor extends AudioWorkletProcessor {
+            process(inputs, outputs, parameters) {
+                this.port.postMessage({
+                    eventType: 'data',
+                    buffer: inputs
+                });
+                return true;
+            }
+        }
+        registerProcessor('microphone-worklet', MicrophoneWorkletProcessor);`;
+        const microphoneRecorderBlob = new Blob([microphoneRecorderWorklet], {
+            type: "application/javascript",
+        });
+        microphoneRecorderUrl = URL.createObjectURL(microphoneRecorderBlob);
+    }
+    return new CameraKitSource({ media: stream }, {
+        onAttach: (source, lensCore, reportError) => __awaiter(this, void 0, void 0, function* () {
+            if (width !== undefined && height !== undefined)
+                yield source.setRenderSize(width, height);
+            yield source.setTransform(optionsNotNull.transform);
+            if (enableSourceAudio) {
+                // Audio paramters set has to be called before lens is applied
+                lensCore.setAudioParameters({
+                    parameters: {
+                        numChannels: simulateStereoAudio ? 2 : 1,
+                        sampleRate,
+                    },
+                    onFailure: (error) => {
+                        reportError(error);
+                    },
+                });
+                if (audioContext) {
+                    yield audioContext.close();
+                }
+                audioContext = new AudioContext();
+                audioSource = audioContext.createMediaStreamSource(stream);
+                const scopedAudioSource = audioSource;
+                audioContext.audioWorklet
+                    .addModule(microphoneRecorderUrl)
+                    .then(() => {
+                    if (audioContext) {
+                        const worklet = new AudioWorkletNode(audioContext, "microphone-worklet");
+                        scopedAudioSource.connect(worklet);
+                        worklet.connect(audioContext.destination);
+                        // NOTE: We subscribe to messages here, and they will continue to arrive
+                        // even after audioContext.close() is called. To disconnect the audio worklets
+                        // created here, we need to track another variable - audioSource.
+                        // By calling audioSource.disconnect(), we can properly
+                        // disconnect the audio worklets.
+                        worklet.port.onmessage = (e) => {
+                            if (e.data.eventType === "data") {
+                                // developer.mozilla.org/en-US/docs/Web/API/AudioWorkletProcessor/process
+                                // inputs[n][m] is the list of samples in the n-th input at the m-th channel.
+                                const leftSamples = e.data.buffer[0][0];
+                                let inputBuffers = [leftSamples];
+                                if (simulateStereoAudio) {
+                                    const rightSamples = e.data.buffer[0].length > 1 ? e.data.buffer[0][1] : leftSamples.slice();
+                                    inputBuffers.push(rightSamples);
+                                }
+                                lensCore.processAudioSampleBuffer({
+                                    input: inputBuffers,
+                                    onFailure: (error) => {
+                                        reportError(error);
+                                    },
+                                });
+                            }
+                        };
+                    }
+                })
+                    .catch((error) => {
+                    reportError(error);
+                });
+            }
+        }),
+        onDetach: (reportError) => __awaiter(this, void 0, void 0, function* () {
+            if (audioSource) {
+                audioSource.disconnect();
+                audioSource = undefined;
+            }
+            if (audioContext) {
+                yield audioContext.close().catch((error) => {
+                    reportError(error);
+                });
+                audioContext = undefined;
+            }
+        }),
+    }, options);
+}
+//# sourceMappingURL=MediaStreamSource.js.map

package/lib/media-sources/MediaStreamSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MediaStreamSource.js","sourceRoot":"","sources":["../../src/media-sources/MediaStreamSource.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,eAAe,EAA0B,MAAM,mBAAmB,CAAC;AAE5E,MAAM,cAAc,GAA6B;IAC7C,SAAS,EAAE,WAAW,CAAC,QAAQ;IAC/B,kBAAkB,EAAE,KAAK;CAC5B,CAAC;AAQF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAgB,qBAAqB,CACvC,cAAsC,EAAE,KAAK,EAAE,IAAI,EAAE,EACrD,UAA4D,EAAE;;QAE9D,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,uBAAuB,CAAC,MAAM,kBAAI,SAAS,EAAE,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,IAAK,OAAO,EAAG,CAAC;IAChH,CAAC;CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,uBAAuB,CACnC,MAAmB,EACnB,UAA4D,EAAE;IAE9D,MAAM,cAAc,mCACb,cAAc,GACd,OAAO,CACb,CAAC;IAEF,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GACnB,MAAM,CAAC,cAAc,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAC5G,MAAM,iBAAiB,GAAY,MAAM,CAAC,cAAc,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC;IAE5G,MAAM,mBAAmB,GAAG,IAAI,CAAC;IACjC,MAAM,UAAU,GAAW,KAAK,CAAC;IAEjC,IAAI,YAAY,GAA6B,SAAS,CAAC;IACvD,IAAI,WAAW,GAA2C,SAAS,CAAC;IACpE,IAAI,qBAA6B,CAAC;IAElC,IAAI,iBAAiB,EAAE;QACnB,oFAAoF;QACpF,MAAM,yBAAyB,GAAG;;;;;;;;;;6EAUmC,CAAC;QACtE,MAAM,sBAAsB,GAAG,IAAI,IAAI,CAAC,CAAC,yBAAyB,CAAC,EAAE;YACjE,IAAI,EAAE,wBAAwB;SACjC,CAAC,CAAC;QACH,qBAAqB,GAAG,GAAG,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC;KACvE;IAED,OAAO,IAAI,eAAe,CACtB,EAAE,KAAK,EAAE,MAAM,EAAE,EACjB;QACI,QAAQ,EAAE,CAAO,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE;YAC9C,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS;gBAAE,MAAM,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC3F,MAAM,MAAM,CAAC,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAEpD,IAAI,iBAAiB,EAAE;gBACnB,8DAA8D;gBAC9D,QAAQ,CAAC,kBAAkB,CAAC;oBACxB,UAAU,EAAE;wBACR,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wBACxC,UAAU;qBACb;oBACD,SAAS,EAAE,CAAC,KAAY,EAAE,EAAE;wBACxB,WAAW,CAAC,KAAK,CAAC,CAAC;oBACvB,CAAC;iBACJ,CAAC,CAAC;gBAEH,IAAI,YAAY,EAAE;oBACd,MAAM,YAAY,CAAC,KAAK,EAAE,CAAC;iBAC9B;gBAED,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;gBAClC,WAAW,GAAG,YAAY,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;gBAC3D,MAAM,iBAAiB,GAAG,WAAW,CAAC;gBACtC,YAAY,CAAC,YAAY;qBACpB,SAAS,CAAC,qBAAqB,CAAC;qBAChC,IAAI,CAAC,GAAG,EAAE;oBACP,IAAI,YAAY,EAAE;wBACd,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC,YAAY,EAAE,oBAAoB,CAAC,CAAC;wBACzE,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;wBACnC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;wBAC1C,wEAAwE;wBACxE,8EAA8E;wBAC9E,iEAAiE;wBACjE,uDAAuD;wBACvD,iCAAiC;wBACjC,OAAO,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,EAAE;4BAC3B,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,MAAM,EAAE;gCAC7B,yEAAyE;gCACzE,6EAA6E;gCAC7E,MAAM,WAAW,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAiB,CAAC;gCACxD,IAAI,YAAY,GAAG,CAAC,WAAW,CAAC,CAAC;gCACjC,IAAI,mBAAmB,EAAE;oCACrB,MAAM,YAAY,GACd,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;oCAC5E,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iCACnC;gCAED,QAAQ,CAAC,wBAAwB,CAAC;oCAC9B,KAAK,EAAE,YAAY;oCACnB,SAAS,EAAE,CAAC,KAAY,EAAE,EAAE;wCACxB,WAAW,CAAC,KAAK,CAAC,CAAC;oCACvB,CAAC;iCACJ,CAAC,CAAC;6BACN;wBACL,CAAC,CAAC;qBACL;gBACL,CAAC,CAAC;qBACD,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;oBACpB,WAAW,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC,CAAC,CAAC;aACV;QACL,CAAC,CAAA;QACD,QAAQ,EAAE,CAAO,WAAW,EAAE,EAAE;YAC5B,IAAI,WAAW,EAAE;gBACb,WAAW,CAAC,UAAU,EAAE,CAAC;gBACzB,WAAW,GAAG,SAAS,CAAC;aAC3B;YACD,IAAI,YAAY,EAAE;gBACd,MAAM,YAAY,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;oBAC9C,WAAW,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC,CAAC,CAAC;gBACH,YAAY,GAAG,SAAS,CAAC;aAC5B;QACL,CAAC,CAAA;KACJ,EACD,OAAO,CACV,CAAC;AACN,CAAC","sourcesContent":["import { Transform2D } from \"../transforms\";\nimport { CameraKitSource, CameraKitSourceOptions } from \"./CameraKitSource\";\n\nconst defaultOptions: MediaStreamSourceOptions = {\n    transform: Transform2D.Identity,\n    disableSourceAudio: false,\n};\n\n/** @category Rendering */\nexport interface MediaStreamSourceOptions {\n    transform: Transform2D;\n    disableSourceAudio: boolean; // defaults to false\n}\n\n/**\n * Create a {@link CameraKitSource} from a user's media device -- this calls\n * [MediaDevices.getUserMedia](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) to get a\n * MediaStream and then calls {@link createMediaStreamSource}.\n *\n * @param constraints Specify contraints used to get a MediaStream from a media device. By default we simply request\n * a video stream.\n * @param options\n * @param options.transform By default we horizontally mirror the video stream. The most common use-case is to obtain a\n * stream from a front-facing web cam, which requires mirroring to be viewed naturally.\n * @param options.cameraType By default we set this to 'front' to indicate a camera pointed at the user (e.g. a webcam).\n * @param options.fpsLimit By default we set no limit on FPS – if the source device has a known FPS setting this limit\n * may prevent CameraKit from using more compute resources than strictly necessary.\n * @returns A Promise, resolving to {@link CameraKitSource}\n *\n * @category Rendering\n */\nexport async function createUserMediaSource(\n    constraints: MediaStreamConstraints = { video: true },\n    options: CameraKitSourceOptions<MediaStreamSourceOptions> = {}\n): Promise<CameraKitSource> {\n    const stream = await navigator.mediaDevices.getUserMedia(constraints);\n    return createMediaStreamSource(stream, { transform: Transform2D.MirrorX, cameraType: \"front\", ...options });\n}\n\n/**\n * Create a {@link CameraKitSource} from any\n * [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream).\n *\n * @param stream Any MediaStream, such as obtained via `canvas.captureStream()`\n * @param options\n * @param options.transform We apply no transformation by default.\n * @param options.disableSourceAudio By default we pass audio to lens. Settings this to true will disable sending audio\n * to the lens.\n * @param options.cameraType By default we set this to 'front', which is the camera type most Lenses expect.\n * @param options.fpsLimit By default we set no limit on FPS – if the MediaStream has a known FPS setting this limit\n * may prevent CameraKit from using more compute resources than strictly necessary.\n *\n * @category Rendering\n */\nexport function createMediaStreamSource(\n    stream: MediaStream,\n    options: CameraKitSourceOptions<MediaStreamSourceOptions> = {}\n): CameraKitSource {\n    const optionsNotNull = {\n        ...defaultOptions,\n        ...options,\n    };\n\n    const { width, height } =\n        stream.getVideoTracks().length > 0 ? stream.getVideoTracks()[0].getSettings() : { width: 0, height: 0 };\n    const enableSourceAudio: boolean = stream.getAudioTracks().length > 0 && !optionsNotNull.disableSourceAudio;\n\n    const simulateStereoAudio = true;\n    const sampleRate: number = 44100;\n\n    let audioContext: AudioContext | undefined = undefined;\n    let audioSource: MediaStreamAudioSourceNode | undefined = undefined;\n    let microphoneRecorderUrl: string;\n\n    if (enableSourceAudio) {\n        // https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Using_AudioWorklet\n        const microphoneRecorderWorklet = `\n        class MicrophoneWorkletProcessor extends AudioWorkletProcessor {\n            process(inputs, outputs, parameters) {\n                this.port.postMessage({\n                    eventType: 'data',\n                    buffer: inputs\n                });\n                return true;\n            }\n        }\n        registerProcessor('microphone-worklet', MicrophoneWorkletProcessor);`;\n        const microphoneRecorderBlob = new Blob([microphoneRecorderWorklet], {\n            type: \"application/javascript\",\n        });\n        microphoneRecorderUrl = URL.createObjectURL(microphoneRecorderBlob);\n    }\n\n    return new CameraKitSource(\n        { media: stream },\n        {\n            onAttach: async (source, lensCore, reportError) => {\n                if (width !== undefined && height !== undefined) await source.setRenderSize(width, height);\n                await source.setTransform(optionsNotNull.transform);\n\n                if (enableSourceAudio) {\n                    // Audio paramters set has to be called before lens is applied\n                    lensCore.setAudioParameters({\n                        parameters: {\n                            numChannels: simulateStereoAudio ? 2 : 1,\n                            sampleRate,\n                        },\n                        onFailure: (error: Error) => {\n                            reportError(error);\n                        },\n                    });\n\n                    if (audioContext) {\n                        await audioContext.close();\n                    }\n\n                    audioContext = new AudioContext();\n                    audioSource = audioContext.createMediaStreamSource(stream);\n                    const scopedAudioSource = audioSource;\n                    audioContext.audioWorklet\n                        .addModule(microphoneRecorderUrl)\n                        .then(() => {\n                            if (audioContext) {\n                                const worklet = new AudioWorkletNode(audioContext, \"microphone-worklet\");\n                                scopedAudioSource.connect(worklet);\n                                worklet.connect(audioContext.destination);\n                                // NOTE: We subscribe to messages here, and they will continue to arrive\n                                // even after audioContext.close() is called. To disconnect the audio worklets\n                                // created here, we need to track another variable - audioSource.\n                                // By calling audioSource.disconnect(), we can properly\n                                // disconnect the audio worklets.\n                                worklet.port.onmessage = (e) => {\n                                    if (e.data.eventType === \"data\") {\n                                        // developer.mozilla.org/en-US/docs/Web/API/AudioWorkletProcessor/process\n                                        // inputs[n][m] is the list of samples in the n-th input at the m-th channel.\n                                        const leftSamples = e.data.buffer[0][0] as Float32Array;\n                                        let inputBuffers = [leftSamples];\n                                        if (simulateStereoAudio) {\n                                            const rightSamples =\n                                                e.data.buffer[0].length > 1 ? e.data.buffer[0][1] : leftSamples.slice();\n                                            inputBuffers.push(rightSamples);\n                                        }\n\n                                        lensCore.processAudioSampleBuffer({\n                                            input: inputBuffers,\n                                            onFailure: (error: Error) => {\n                                                reportError(error);\n                                            },\n                                        });\n                                    }\n                                };\n                            }\n                        })\n                        .catch((error: Error) => {\n                            reportError(error);\n                        });\n                }\n            },\n            onDetach: async (reportError) => {\n                if (audioSource) {\n                    audioSource.disconnect();\n                    audioSource = undefined;\n                }\n                if (audioContext) {\n                    await audioContext.close().catch((error: Error) => {\n                        reportError(error);\n                    });\n                    audioContext = undefined;\n                }\n            },\n        },\n        options\n    );\n}\n"]}

package/lib/media-sources/VideoSource.d.ts

@@ -0,0 +1,21 @@
+import { CameraKitSource, CameraKitSourceOptions } from "./CameraKitSource";
+/** @category Rendering */
+export interface VideoSourceOptions {
+    trackingData: ArrayBuffer;
+}
+/**
+ * Create a {@link CameraKitSource} from an
+ * [HTMLVideoElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement).
+ *
+ * @param video CameraKit performs best when the source video is 720p – arbitrary resolutions are supported, but very
+ * high resolutions may not perform well.
+ * @param options
+ * @param options.trackingData If pre-computed tracking data exists for this video, it may be provided in order to boost
+ * rendering performance (it is not typical or expected for this to be provided).
+ * @param options.cameraType By default we set this to 'front', which is the camera type most Lenses expect.
+ * @param options.fpsLimit By default we set no limit on FPS – if the video has a known FPS setting this limit
+ * may prevent CameraKit from using more compute resources than strictly necessary.
+ *
+ * @category Rendering
+ */
+export declare function createVideoSource(video: HTMLVideoElement, options?: CameraKitSourceOptions<VideoSourceOptions>): CameraKitSource;

package/lib/media-sources/VideoSource.js

@@ -0,0 +1,38 @@
+import { CameraKitSource } from "./CameraKitSource";
+const defaultOptions = {
+    trackingData: new ArrayBuffer(0),
+};
+/**
+ * Create a {@link CameraKitSource} from an
+ * [HTMLVideoElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement).
+ *
+ * @param video CameraKit performs best when the source video is 720p – arbitrary resolutions are supported, but very
+ * high resolutions may not perform well.
+ * @param options
+ * @param options.trackingData If pre-computed tracking data exists for this video, it may be provided in order to boost
+ * rendering performance (it is not typical or expected for this to be provided).
+ * @param options.cameraType By default we set this to 'front', which is the camera type most Lenses expect.
+ * @param options.fpsLimit By default we set no limit on FPS – if the video has a known FPS setting this limit
+ * may prevent CameraKit from using more compute resources than strictly necessary.
+ *
+ * @category Rendering
+ */
+export function createVideoSource(video, options = {}) {
+    const { trackingData } = Object.assign(Object.assign({}, defaultOptions), options);
+    const replayTrackingData = trackingData.byteLength > 0 ? { buffer: trackingData } : undefined;
+    return new CameraKitSource({
+        media: video,
+        replayTrackingData,
+    }, {
+        onAttach: (source) => {
+            // If the video element has no explicit width/height (which may be the case for elements that have not
+            // been added to the DOM or had their size set explicitly), we'll render at the video's native
+            // resolution.
+            const [width, height] = video.width === 0 || video.height === 0
+                ? [video.videoWidth, video.videoHeight]
+                : [video.width, video.height];
+            return source.setRenderSize(width, height);
+        },
+    }, options);
+}
+//# sourceMappingURL=VideoSource.js.map

package/lib/media-sources/VideoSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VideoSource.js","sourceRoot":"","sources":["../../src/media-sources/VideoSource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAA0B,MAAM,mBAAmB,CAAC;AAE5E,MAAM,cAAc,GAAuB;IACvC,YAAY,EAAE,IAAI,WAAW,CAAC,CAAC,CAAC;CACnC,CAAC;AAOF;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,iBAAiB,CAC7B,KAAuB,EACvB,UAAsD,EAAE;IAExD,MAAM,EAAE,YAAY,EAAE,mCAAQ,cAAc,GAAK,OAAO,CAAE,CAAC;IAC3D,MAAM,kBAAkB,GAAG,YAAY,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAE9F,OAAO,IAAI,eAAe,CACtB;QACI,KAAK,EAAE,KAAK;QACZ,kBAAkB;KACrB,EACD;QACI,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE;YACjB,sGAAsG;YACtG,8FAA8F;YAC9F,cAAc;YACd,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GACjB,KAAK,CAAC,KAAK,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBACnC,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC;gBACvC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtC,OAAO,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;KACJ,EACD,OAAO,CACV,CAAC;AACN,CAAC","sourcesContent":["import { CameraKitSource, CameraKitSourceOptions } from \"./CameraKitSource\";\n\nconst defaultOptions: VideoSourceOptions = {\n    trackingData: new ArrayBuffer(0),\n};\n\n/** @category Rendering */\nexport interface VideoSourceOptions {\n    trackingData: ArrayBuffer;\n}\n\n/**\n * Create a {@link CameraKitSource} from an\n * [HTMLVideoElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement).\n *\n * @param video CameraKit performs best when the source video is 720p – arbitrary resolutions are supported, but very\n * high resolutions may not perform well.\n * @param options\n * @param options.trackingData If pre-computed tracking data exists for this video, it may be provided in order to boost\n * rendering performance (it is not typical or expected for this to be provided).\n * @param options.cameraType By default we set this to 'front', which is the camera type most Lenses expect.\n * @param options.fpsLimit By default we set no limit on FPS – if the video has a known FPS setting this limit\n * may prevent CameraKit from using more compute resources than strictly necessary.\n *\n * @category Rendering\n */\nexport function createVideoSource(\n    video: HTMLVideoElement,\n    options: CameraKitSourceOptions<VideoSourceOptions> = {}\n): CameraKitSource {\n    const { trackingData } = { ...defaultOptions, ...options };\n    const replayTrackingData = trackingData.byteLength > 0 ? { buffer: trackingData } : undefined;\n\n    return new CameraKitSource(\n        {\n            media: video,\n            replayTrackingData,\n        },\n        {\n            onAttach: (source) => {\n                // If the video element has no explicit width/height (which may be the case for elements that have not\n                // been added to the DOM or had their size set explicitly), we'll render at the video's native\n                // resolution.\n                const [width, height] =\n                    video.width === 0 || video.height === 0\n                        ? [video.videoWidth, video.videoHeight]\n                        : [video.width, video.height];\n\n                return source.setRenderSize(width, height);\n            },\n        },\n        options\n    );\n}\n"]}

package/lib/metrics/businessEventsReporter.d.ts

@@ -0,0 +1,37 @@
+import { FetchHandler } from "../handlers/defaultFetchHandler";
+import * as blizzard from "../generated-proto/blizzard/cameraKitEvents";
+import { MetricsEventTarget } from "./metricsEventTarget";
+/**
+ * Translate between an external metric name, which is exposed to SDK users, and an internal Blizzard event name,
+ * property name, and constructor.
+ *
+ * It is very important that we do this, since the naming of these internal business events are unintuitive and will
+ * not make sense to SDK users.
+ *
+ * For a full list of business events (using their internal names), see:
+ * https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/
+ */
+declare type CameraKitBusinessEventMap = {
+    assetDownload: MakeBusinessEvent<blizzard.CameraKitAssetDownload>;
+    assetValidationFailed: MakeBusinessEvent<blizzard.CameraKitAssetValidationFailed>;
+    benchmarkComplete: MakeBusinessEvent<blizzard.CameraKitWebBenchmarkComplete>;
+    exception: MakeBusinessEvent<blizzard.CameraKitException>;
+    legalPrompt: MakeBusinessEvent<blizzard.CameraKitLegalPrompt>;
+    lensDownload: MakeBusinessEvent<blizzard.CameraKitLensDownload>;
+    lensView: MakeBusinessEvent<blizzard.CameraKitWebLensSwipe>;
+    lensWait: MakeBusinessEvent<blizzard.CameraKitLensSpin>;
+    lensContentValidationFailed: MakeBusinessEvent<blizzard.CameraKitLensContentValidationFailed>;
+    session: MakeBusinessEvent<blizzard.CameraKitSession>;
+};
+export declare type MakeBusinessEvent<E> = Omit<{
+    [K in keyof E]: Exclude<E[K], undefined> extends Record<keyof any, any> ? MakeBusinessEvent<Exclude<E[K], undefined>> : E[K];
+}, "cameraKitEventBase">;
+export declare type MakeTaggedBusinessEvent<K extends keyof CameraKitBusinessEventMap> = {
+    name: K;
+} & CameraKitBusinessEventMap[K];
+export declare const businessEventsReporterFactory: {
+    (args_0: MetricsEventTarget, args_1: FetchHandler<Response>): void;
+    token: "businessEventsReporter";
+    dependencies: readonly ["metricsEventTarget", "metricsHandler"];
+};
+export {};

package/lib/metrics/businessEventsReporter.js

@@ -0,0 +1,160 @@
+import { v4 } from "uuid";
+import { cameraKitUserAgent as userAgent } from "../common/cameraKitUserAgent";
+import { entries } from "../common/entries";
+import { Injectable } from "../dependency-injection/Injectable";
+import { createBatchingHandler } from "../handlers/batchingHandler";
+import { HandlerChainBuilder } from "../handlers/HandlerChainBuilder";
+import { createMappingHandler } from "../handlers/mappingHandler";
+import * as blizzard from "../generated-proto/blizzard/cameraKitEvents";
+import { getLogger } from "../logger/logger";
+import { metricsHandlerFactory } from "./metricsHandler";
+import { metricsEventTargetFactory } from "./metricsEventTarget";
+const logger = getLogger("BusinessEventsReporter");
+// CameraKit's prod metrics endpoint.
+// See: https://github.sc-corp.net/Snapchat/pb_schema/blob/2a966db/proto/camera_kit/v3/service.proto#L133
+const BUSINESS_EVENTS_ENDPOINT = "https://api-kit.snapchat.com/com.snap.camerakit.v3.Metrics/metrics/business_events";
+// These values are (currently) arbitrarily selected.
+// TODO: Once we have gathered a sufficient quantity of metrics data, we should tune these numbers to ensure we're
+// operating with the right cost vs. staying under the `keepalive` request body limit of 64 kibibytes.
+const BUSINESS_EVENT_BATCH_MAX_SIZE = 100;
+const BUSINESS_EVENT_BATCH_MAX_AGE_MS = 5000;
+function listenAndReport(metricsEventTarget, metricsHandler, eventHandlers) {
+    const sessionId = v4();
+    logger.log(`Session ID: ${sessionId}`);
+    const handler = new HandlerChainBuilder(metricsHandler)
+        .map(createMappingHandler((events) => {
+        const body = {
+            batchEvents: {
+                "@type": "com.snapchat.analytics.blizzard.ServerEventBatch",
+                serverEvents: events,
+            },
+        };
+        return new Request(BUSINESS_EVENTS_ENDPOINT, {
+            method: "POST",
+            body: JSON.stringify(body),
+            credentials: "include",
+            // Setting this to true makes fetch behave like `Navigator.sendBeacon` – that is, the request
+            // will still be made even if the page terminates.
+            // https://developer.mozilla.org/en-US/docs/Web/API/fetch
+            keepalive: true,
+        });
+    }))
+        .map(createBatchingHandler({
+        batchReduce: (previousBundle, businessEvent) => {
+            const bundle = previousBundle !== null && previousBundle !== void 0 ? previousBundle : [];
+            bundle.push(businessEvent);
+            return bundle;
+        },
+        isBatchComplete: (bundle) => bundle.length >= BUSINESS_EVENT_BATCH_MAX_SIZE,
+        maxBatchAge: BUSINESS_EVENT_BATCH_MAX_AGE_MS,
+    })).handler;
+    const makeBlizzardEvent = (event) => {
+        return Object.assign(Object.assign({}, event), { cameraKitEventBase: blizzard.CameraKitEventBase.fromPartial({
+                kitEventBase: blizzard.KitEventBase.fromPartial({
+                    locale: userAgent.locale,
+                    kitVariant: blizzard.KitType.CAMERA_KIT_WEB,
+                    kitVariantVersion: userAgent.sdkShortVersion,
+                    kitClientTimestampMillis: Date.now(),
+                }),
+                deviceCluster: 0,
+                cameraKitVersion: userAgent.sdkLongVersion,
+                lensCoreVersion: userAgent.lensCoreVersion,
+                deviceModel: userAgent.deviceModel,
+                cameraKitVariant: blizzard.CameraKitVariant.CAMERA_KIT_VARIANT_PARTNER,
+                cameraKitFlavor: blizzard.CameraKitFlavor.CAMERA_KIT_FLAVOR_DEBUG,
+                // We overload appId, using the origin instead because it's nice and human-readable (our backed adds
+                // the true appId as oauth_client_id before forwarding events to Blizzard).
+                appId: userAgent.origin,
+                deviceConnectivity: blizzard.CameraKitConnectivityType.CAMERA_KIT_CONNECTIVITY_TYPE_WIFI,
+                sessionId: sessionId,
+            }) });
+    };
+    const sendServerEvent = (eventName, eventData) => {
+        return handler(blizzard.ServerEvent.fromPartial({
+            eventName,
+            osType: userAgent.osType,
+            osVersion: userAgent.osVersion,
+            maxSequenceIdOnInstance: 0,
+            sequenceId: 0,
+            eventData,
+        }));
+    };
+    entries(eventHandlers).forEach(([eventType, createEventData]) => {
+        metricsEventTarget.addEventListener(eventType, ({ detail }) => {
+            // Safety: When iterating over object keys in a mapped type, we lose the association between the key type
+            // and the value type – at each iteration, the key type is a union of all possible keys and the value type
+            // is a union of all possible values. When the value is a function with an argument, and that argument
+            // depends on the key type (which is a union), the contravariance of the argument type means that the union
+            // becomes an intersection. In our case here, this means the compiler expects each argument to contain all
+            // properties from all event types. The cast is safe because the mapped `EventHandlers` type ensures that
+            // `createEventData` takes an argument of the type corresponding its key's `eventType`'s event detail.
+            const [eventName, eventData] = createEventData(makeBlizzardEvent(detail));
+            sendServerEvent(eventName, eventData);
+        });
+    });
+}
+export const businessEventsReporterFactory = Injectable("businessEventsReporter", [metricsEventTargetFactory.token, metricsHandlerFactory.token], (metricsEventTarget, metricsHandler) => {
+    /**
+     * This defines a mapping from a business event's external name (the name we document in public API docs), to
+     * its internal representation as a Blizzard ServerEvent.
+     *
+     * It is important that we do this, since the naming of these internal business events are unintuitive and will
+     * not make sense to SDK users.
+     *
+     * To specify the internal event, we must give the ServerEvent's eventName, the specific property name which
+     * contains the event data (this is a "oneof" property on ServerEvent), and use the correct event type's
+     * `fromPartial` method (this is generated from the ServerEvent protobuf).
+     *
+     * These events are documented here:
+     * https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/
+     *
+     * They are defined in code here:
+     * https://github.sc-corp.net/Snapchat/snapchat/tree/master/blizzard/schema/blizzard-schema/
+     *  codeGen/src/main/java/com/snapchat/analytics/schema/events/cameraKit
+     */
+    listenAndReport(metricsEventTarget, metricsHandler, {
+        assetDownload: (event) => [
+            "CAMERA_KIT_ASSET_DOWNLOAD",
+            { cameraKitAssetDownload: blizzard.CameraKitAssetDownload.fromPartial(event) },
+        ],
+        assetValidationFailed: (event) => [
+            "CAMERA_KIT_ASSET_VALIDATION_FAILED",
+            { cameraKitAssetValidationFailed: blizzard.CameraKitAssetValidationFailed.fromPartial(event) },
+        ],
+        benchmarkComplete: (event) => [
+            "CAMERA_KIT_WEB_BENCHMARK_COMPLETE",
+            { cameraKitWebBenchmarkComplete: blizzard.CameraKitWebBenchmarkComplete.fromPartial(event) },
+        ],
+        exception: (event) => [
+            "CAMERA_KIT_EXCEPTION",
+            { cameraKitException: blizzard.CameraKitException.fromPartial(event) },
+        ],
+        legalPrompt: (event) => [
+            "CAMERA_KIT_LEGAL_PROMPT",
+            { cameraKitLegalPrompt: blizzard.CameraKitLegalPrompt.fromPartial(event) },
+        ],
+        lensDownload: (event) => [
+            "CAMERA_KIT_LENS_DOWNLOAD",
+            { cameraKitLensDownload: blizzard.CameraKitLensDownload.fromPartial(event) },
+        ],
+        lensView: (event) => [
+            "CAMERA_KIT_WEB_LENS_SWIPE",
+            { cameraKitWebLensSwipe: blizzard.CameraKitWebLensSwipe.fromPartial(event) },
+        ],
+        lensWait: (event) => [
+            "CAMERA_KIT_LENS_SPIN",
+            { cameraKitLensSpin: blizzard.CameraKitLensSpin.fromPartial(event) },
+        ],
+        lensContentValidationFailed: (event) => [
+            "CAMERA_KIT_LENS_CONTENT_VALIDATION_FAILED",
+            {
+                cameraKitLensContentValidationFailed: blizzard.CameraKitLensContentValidationFailed.fromPartial(event),
+            },
+        ],
+        session: (event) => [
+            "CAMERA_KIT_SESSION",
+            { cameraKitSession: blizzard.CameraKitSession.fromPartial(event) },
+        ],
+    });
+});
+//# sourceMappingURL=businessEventsReporter.js.map

package/lib/metrics/businessEventsReporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"businessEventsReporter.js","sourceRoot":"","sources":["../../src/metrics/businessEventsReporter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAC1B,OAAO,EAAE,kBAAkB,IAAI,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAIhE,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,QAAQ,MAAM,6CAA6C,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAsB,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAErF,MAAM,MAAM,GAAG,SAAS,CAAC,wBAAwB,CAAC,CAAC;AAuDnD,qCAAqC;AACrC,yGAAyG;AACzG,MAAM,wBAAwB,GAAG,oFAAoF,CAAC;AAEtH,qDAAqD;AACrD,kHAAkH;AAClH,sGAAsG;AACtG,MAAM,6BAA6B,GAAG,GAAG,CAAC;AAC1C,MAAM,+BAA+B,GAAG,IAAI,CAAC;AAE7C,SAAS,eAAe,CACpB,kBAAsC,EACtC,cAA4B,EAC5B,aAA4B;IAE5B,MAAM,SAAS,GAAG,EAAE,EAAE,CAAC;IACvB,MAAM,CAAC,GAAG,CAAC,eAAe,SAAS,EAAE,CAAC,CAAC;IAEvC,MAAM,OAAO,GAAG,IAAI,mBAAmB,CAAC,cAAc,CAAC;SAClD,GAAG,CACA,oBAAoB,CAAC,CAAC,MAA8B,EAAE,EAAE;QACpD,MAAM,IAAI,GAA6B;YACnC,WAAW,EAAE;gBACT,OAAO,EAAE,kDAAkD;gBAC3D,YAAY,EAAE,MAAM;aACvB;SACJ,CAAC;QACF,OAAO,IAAI,OAAO,CAAC,wBAAwB,EAAE;YACzC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAC1B,WAAW,EAAE,SAAS;YAEtB,6FAA6F;YAC7F,kDAAkD;YAClD,yDAAyD;YACzD,SAAS,EAAE,IAAI;SAClB,CAAC,CAAC;IACP,CAAC,CAAC,CACL;SACA,GAAG,CACA,qBAAqB,CAAC;QAClB,WAAW,EAAE,CACT,cAAkD,EAClD,aAAmC,EACrC,EAAE;YACA,MAAM,MAAM,GAAG,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,EAAE,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC3B,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,eAAe,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,6BAA6B;QAC3E,WAAW,EAAE,+BAA+B;KAC/C,CAAC,CACL,CAAC,OAAO,CAAC;IAEd,MAAM,iBAAiB,GAAG,CAAoC,KAAQ,EAAwB,EAAE;QAC5F,uCACO,KAAK,KACR,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC;gBACxD,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,WAAW,CAAC;oBAC5C,MAAM,EAAE,SAAS,CAAC,MAAM;oBACxB,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,cAAc;oBAC3C,iBAAiB,EAAE,SAAS,CAAC,eAAe;oBAC5C,wBAAwB,EAAE,IAAI,CAAC,GAAG,EAAE;iBACvC,CAAC;gBACF,aAAa,EAAE,CAAC;gBAChB,gBAAgB,EAAE,SAAS,CAAC,cAAc;gBAC1C,eAAe,EAAE,SAAS,CAAC,eAAe;gBAC1C,WAAW,EAAE,SAAS,CAAC,WAAW;gBAClC,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,CAAC,0BAA0B;gBACtE,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC,uBAAuB;gBACjE,oGAAoG;gBACpG,2EAA2E;gBAC3E,KAAK,EAAE,SAAS,CAAC,MAAM;gBACvB,kBAAkB,EAAE,QAAQ,CAAC,yBAAyB,CAAC,iCAAiC;gBACxF,SAAS,EAAE,SAAS;aACvB,CAAC,IACJ;IACN,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,CACpB,SAAiB,EACjB,SAAwD,EAC3C,EAAE;QACf,OAAO,OAAO,CACV,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC;YAC7B,SAAS;YACT,MAAM,EAAE,SAAS,CAAC,MAAM;YACxB,SAAS,EAAE,SAAS,CAAC,SAAS;YAC9B,uBAAuB,EAAE,CAAC;YAC1B,UAAU,EAAE,CAAC;YACb,SAAS;SACZ,CAAC,CACL,CAAC;IACN,CAAC,CAAC;IAEF,OAAO,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,eAAe,CAAC,EAAE,EAAE;QAC5D,kBAAkB,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;YAC1D,yGAAyG;YACzG,0GAA0G;YAC1G,sGAAsG;YACtG,2GAA2G;YAC3G,0GAA0G;YAC1G,yGAAyG;YACzG,sGAAsG;YACtG,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,eAAe,CAAC,iBAAiB,CAAC,MAAM,CAAQ,CAAC,CAAC;YACjF,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC;AAeD,MAAM,CAAC,MAAM,6BAA6B,GAAG,UAAU,CACnD,wBAAwB,EACxB,CAAC,yBAAyB,CAAC,KAAK,EAAE,qBAAqB,CAAC,KAAK,CAAU,EACvE,CAAC,kBAAsC,EAAE,cAA4B,EAAE,EAAE;IACrE;;;;;;;;;;;;;;;;;OAiBG;IACH,eAAe,CAAC,kBAAkB,EAAE,cAAc,EAAE;QAChD,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;YACtB,2BAA2B;YAC3B,EAAE,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;SACjF;QACD,qBAAqB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;YAC9B,oCAAoC;YACpC,EAAE,8BAA8B,EAAE,QAAQ,CAAC,8BAA8B,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;SACjG;QACD,iBAAiB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;YAC1B,mCAAmC;YACnC,EAAE,6BAA6B,EAAE,QAAQ,CAAC,6BAA6B,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;SAC/F;QACD,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;YAClB,sBAAsB;YACtB,EAAE,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;SACzE;QACD,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;YACpB,yBAAyB;YACzB,EAAE,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;SAC7E;QACD,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;YACrB,0BAA0B;YAC1B,EAAE,qBAAqB,EAAE,QAAQ,CAAC,qBAAqB,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;SAC/E;QACD,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;YACjB,2BAA2B;YAC3B,EAAE,qBAAqB,EAAE,QAAQ,CAAC,qBAAqB,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;SAC/E;QACD,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;YACjB,sBAAsB;YACtB,EAAE,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;SACvE;QACD,2BAA2B,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;YACpC,2CAA2C;YAC3C;gBACI,oCAAoC,EAAE,QAAQ,CAAC,oCAAoC,CAAC,WAAW,CAC3F,KAAK,CACR;aACJ;SACJ;QACD,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;YAChB,oBAAoB;YACpB,EAAE,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;SACrE;KACJ,CAAC,CAAC;AACP,CAAC,CACJ,CAAC","sourcesContent":["import { v4 } from \"uuid\";\nimport { cameraKitUserAgent as userAgent } from \"../common/cameraKitUserAgent\";\nimport { entries } from \"../common/entries\";\nimport { Injectable } from \"../dependency-injection/Injectable\";\nimport { EventOfType } from \"../events/TypedCustomEvent\";\nimport { EventsFromTarget } from \"../events/TypedEventTarget\";\nimport { FetchHandler } from \"../handlers/defaultFetchHandler\";\nimport { createBatchingHandler } from \"../handlers/batchingHandler\";\nimport { HandlerChainBuilder } from \"../handlers/HandlerChainBuilder\";\nimport { createMappingHandler } from \"../handlers/mappingHandler\";\nimport * as blizzard from \"../generated-proto/blizzard/cameraKitEvents\";\nimport { getLogger } from \"../logger/logger\";\nimport { metricsHandlerFactory } from \"./metricsHandler\";\nimport { MetricsEventTarget, metricsEventTargetFactory } from \"./metricsEventTarget\";\n\nconst logger = getLogger(\"BusinessEventsReporter\");\n\ntype Nullables<T> = { [K in keyof T]-?: undefined extends T[K] ? K : never }[keyof T];\ntype UndefinedToOptional<T> = Partial<Pick<T, Nullables<T>>> & Omit<T, Nullables<T>>;\n\ntype CameraKitBusinessEvents = EventsFromTarget<MetricsEventTarget>[\"detail\"];\n\ntype MakeBlizzardEvent<E> = Omit<E, \"name\"> & { cameraKitEventBase: blizzard.CameraKitEventBase };\n\ntype CreateEventData<EventType extends EventsFromTarget<MetricsEventTarget>[\"type\"]> = (\n    event: MakeBlizzardEvent<EventOfType<EventType, EventsFromTarget<MetricsEventTarget>>[\"detail\"]>\n) => [string, UndefinedToOptional<blizzard.ServerEventData>];\n\ntype EventHandlers = {\n    [EventType in EventsFromTarget<MetricsEventTarget>[\"type\"]]: CreateEventData<EventType>;\n};\n\n/**\n * Translate between an external metric name, which is exposed to SDK users, and an internal Blizzard event name,\n * property name, and constructor.\n *\n * It is very important that we do this, since the naming of these internal business events are unintuitive and will\n * not make sense to SDK users.\n *\n * For a full list of business events (using their internal names), see:\n * https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/\n */\ntype CameraKitBusinessEventMap = {\n    assetDownload: MakeBusinessEvent<blizzard.CameraKitAssetDownload>;\n    assetValidationFailed: MakeBusinessEvent<blizzard.CameraKitAssetValidationFailed>;\n    benchmarkComplete: MakeBusinessEvent<blizzard.CameraKitWebBenchmarkComplete>;\n    exception: MakeBusinessEvent<blizzard.CameraKitException>;\n    legalPrompt: MakeBusinessEvent<blizzard.CameraKitLegalPrompt>;\n    lensDownload: MakeBusinessEvent<blizzard.CameraKitLensDownload>;\n    lensView: MakeBusinessEvent<blizzard.CameraKitWebLensSwipe>;\n    lensWait: MakeBusinessEvent<blizzard.CameraKitLensSpin>;\n    lensContentValidationFailed: MakeBusinessEvent<blizzard.CameraKitLensContentValidationFailed>;\n    session: MakeBusinessEvent<blizzard.CameraKitSession>;\n};\n\n/**\n * This interface is defined in the CameraKit pb_schema proto definition – but the generated TypeScript does not handle\n * the `Any` type properly. It does not conform to the Proto3 canonical JSON mapping scheme, as defined here:\n * https://developers.google.com/protocol-buffers/docs/proto3#json\n *\n * To solve this (since we only need one message from the CameraKit schema), we'll just manually define the correct\n * interface here.\n */\ninterface SetBusinessEventsRequest {\n    batchEvents: {\n        \"@type\": \"com.snapchat.analytics.blizzard.ServerEventBatch\";\n        serverEvents: blizzard.ServerEvent[];\n    };\n}\n\n// CameraKit's prod metrics endpoint.\n// See: https://github.sc-corp.net/Snapchat/pb_schema/blob/2a966db/proto/camera_kit/v3/service.proto#L133\nconst BUSINESS_EVENTS_ENDPOINT = \"https://api-kit.snapchat.com/com.snap.camerakit.v3.Metrics/metrics/business_events\";\n\n// These values are (currently) arbitrarily selected.\n// TODO: Once we have gathered a sufficient quantity of metrics data, we should tune these numbers to ensure we're\n// operating with the right cost vs. staying under the `keepalive` request body limit of 64 kibibytes.\nconst BUSINESS_EVENT_BATCH_MAX_SIZE = 100;\nconst BUSINESS_EVENT_BATCH_MAX_AGE_MS = 5000;\n\nfunction listenAndReport(\n    metricsEventTarget: MetricsEventTarget,\n    metricsHandler: FetchHandler,\n    eventHandlers: EventHandlers\n): void {\n    const sessionId = v4();\n    logger.log(`Session ID: ${sessionId}`);\n\n    const handler = new HandlerChainBuilder(metricsHandler)\n        .map(\n            createMappingHandler((events: blizzard.ServerEvent[]) => {\n                const body: SetBusinessEventsRequest = {\n                    batchEvents: {\n                        \"@type\": \"com.snapchat.analytics.blizzard.ServerEventBatch\",\n                        serverEvents: events,\n                    },\n                };\n                return new Request(BUSINESS_EVENTS_ENDPOINT, {\n                    method: \"POST\",\n                    body: JSON.stringify(body),\n                    credentials: \"include\",\n\n                    // Setting this to true makes fetch behave like `Navigator.sendBeacon` – that is, the request\n                    // will still be made even if the page terminates.\n                    // https://developer.mozilla.org/en-US/docs/Web/API/fetch\n                    keepalive: true,\n                });\n            })\n        )\n        .map(\n            createBatchingHandler({\n                batchReduce: (\n                    previousBundle: blizzard.ServerEvent[] | undefined,\n                    businessEvent: blizzard.ServerEvent\n                ) => {\n                    const bundle = previousBundle ?? [];\n                    bundle.push(businessEvent);\n                    return bundle;\n                },\n                isBatchComplete: (bundle) => bundle.length >= BUSINESS_EVENT_BATCH_MAX_SIZE,\n                maxBatchAge: BUSINESS_EVENT_BATCH_MAX_AGE_MS,\n            })\n        ).handler;\n\n    const makeBlizzardEvent = <E extends CameraKitBusinessEvents>(event: E): MakeBlizzardEvent<E> => {\n        return {\n            ...event,\n            cameraKitEventBase: blizzard.CameraKitEventBase.fromPartial({\n                kitEventBase: blizzard.KitEventBase.fromPartial({\n                    locale: userAgent.locale,\n                    kitVariant: blizzard.KitType.CAMERA_KIT_WEB,\n                    kitVariantVersion: userAgent.sdkShortVersion,\n                    kitClientTimestampMillis: Date.now(),\n                }),\n                deviceCluster: 0,\n                cameraKitVersion: userAgent.sdkLongVersion,\n                lensCoreVersion: userAgent.lensCoreVersion,\n                deviceModel: userAgent.deviceModel,\n                cameraKitVariant: blizzard.CameraKitVariant.CAMERA_KIT_VARIANT_PARTNER,\n                cameraKitFlavor: blizzard.CameraKitFlavor.CAMERA_KIT_FLAVOR_DEBUG,\n                // We overload appId, using the origin instead because it's nice and human-readable (our backed adds\n                // the true appId as oauth_client_id before forwarding events to Blizzard).\n                appId: userAgent.origin,\n                deviceConnectivity: blizzard.CameraKitConnectivityType.CAMERA_KIT_CONNECTIVITY_TYPE_WIFI,\n                sessionId: sessionId,\n            }),\n        };\n    };\n\n    const sendServerEvent = (\n        eventName: string,\n        eventData: UndefinedToOptional<blizzard.ServerEventData>\n    ): Promise<void> => {\n        return handler(\n            blizzard.ServerEvent.fromPartial({\n                eventName,\n                osType: userAgent.osType,\n                osVersion: userAgent.osVersion,\n                maxSequenceIdOnInstance: 0,\n                sequenceId: 0,\n                eventData,\n            })\n        );\n    };\n\n    entries(eventHandlers).forEach(([eventType, createEventData]) => {\n        metricsEventTarget.addEventListener(eventType, ({ detail }) => {\n            // Safety: When iterating over object keys in a mapped type, we lose the association between the key type\n            // and the value type – at each iteration, the key type is a union of all possible keys and the value type\n            // is a union of all possible values. When the value is a function with an argument, and that argument\n            // depends on the key type (which is a union), the contravariance of the argument type means that the union\n            // becomes an intersection. In our case here, this means the compiler expects each argument to contain all\n            // properties from all event types. The cast is safe because the mapped `EventHandlers` type ensures that\n            // `createEventData` takes an argument of the type corresponding its key's `eventType`'s event detail.\n            const [eventName, eventData] = createEventData(makeBlizzardEvent(detail) as any);\n            sendServerEvent(eventName, eventData);\n        });\n    });\n}\n\nexport type MakeBusinessEvent<E> = Omit<\n    {\n        [K in keyof E]: Exclude<E[K], undefined> extends Record<keyof any, any>\n            ? MakeBusinessEvent<Exclude<E[K], undefined>>\n            : E[K];\n    },\n    \"cameraKitEventBase\"\n>;\n\nexport type MakeTaggedBusinessEvent<K extends keyof CameraKitBusinessEventMap> = {\n    name: K;\n} & CameraKitBusinessEventMap[K];\n\nexport const businessEventsReporterFactory = Injectable(\n    \"businessEventsReporter\",\n    [metricsEventTargetFactory.token, metricsHandlerFactory.token] as const,\n    (metricsEventTarget: MetricsEventTarget, metricsHandler: FetchHandler) => {\n        /**\n         * This defines a mapping from a business event's external name (the name we document in public API docs), to\n         * its internal representation as a Blizzard ServerEvent.\n         *\n         * It is important that we do this, since the naming of these internal business events are unintuitive and will\n         * not make sense to SDK users.\n         *\n         * To specify the internal event, we must give the ServerEvent's eventName, the specific property name which\n         * contains the event data (this is a \"oneof\" property on ServerEvent), and use the correct event type's\n         * `fromPartial` method (this is generated from the ServerEvent protobuf).\n         *\n         * These events are documented here:\n         * https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/\n         *\n         * They are defined in code here:\n         * https://github.sc-corp.net/Snapchat/snapchat/tree/master/blizzard/schema/blizzard-schema/\n         *  codeGen/src/main/java/com/snapchat/analytics/schema/events/cameraKit\n         */\n        listenAndReport(metricsEventTarget, metricsHandler, {\n            assetDownload: (event) => [\n                \"CAMERA_KIT_ASSET_DOWNLOAD\",\n                { cameraKitAssetDownload: blizzard.CameraKitAssetDownload.fromPartial(event) },\n            ],\n            assetValidationFailed: (event) => [\n                \"CAMERA_KIT_ASSET_VALIDATION_FAILED\",\n                { cameraKitAssetValidationFailed: blizzard.CameraKitAssetValidationFailed.fromPartial(event) },\n            ],\n            benchmarkComplete: (event) => [\n                \"CAMERA_KIT_WEB_BENCHMARK_COMPLETE\",\n                { cameraKitWebBenchmarkComplete: blizzard.CameraKitWebBenchmarkComplete.fromPartial(event) },\n            ],\n            exception: (event) => [\n                \"CAMERA_KIT_EXCEPTION\",\n                { cameraKitException: blizzard.CameraKitException.fromPartial(event) },\n            ],\n            legalPrompt: (event) => [\n                \"CAMERA_KIT_LEGAL_PROMPT\",\n                { cameraKitLegalPrompt: blizzard.CameraKitLegalPrompt.fromPartial(event) },\n            ],\n            lensDownload: (event) => [\n                \"CAMERA_KIT_LENS_DOWNLOAD\",\n                { cameraKitLensDownload: blizzard.CameraKitLensDownload.fromPartial(event) },\n            ],\n            lensView: (event) => [\n                \"CAMERA_KIT_WEB_LENS_SWIPE\",\n                { cameraKitWebLensSwipe: blizzard.CameraKitWebLensSwipe.fromPartial(event) },\n            ],\n            lensWait: (event) => [\n                \"CAMERA_KIT_LENS_SPIN\",\n                { cameraKitLensSpin: blizzard.CameraKitLensSpin.fromPartial(event) },\n            ],\n            lensContentValidationFailed: (event) => [\n                \"CAMERA_KIT_LENS_CONTENT_VALIDATION_FAILED\",\n                {\n                    cameraKitLensContentValidationFailed: blizzard.CameraKitLensContentValidationFailed.fromPartial(\n                        event\n                    ),\n                },\n            ],\n            session: (event) => [\n                \"CAMERA_KIT_SESSION\",\n                { cameraKitSession: blizzard.CameraKitSession.fromPartial(event) },\n            ],\n        });\n    }\n);\n"]}