@snap/camera-kit 0.7.0

package/lib/metrics/reporters/reportLegalState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportLegalState.js","sourceRoot":"","sources":["../../../src/metrics/reporters/reportLegalState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,0BAA0B,EAAE,MAAM,gDAAgD,CAAC;AAC5F,OAAO,EAAc,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEvE,OAAO,EAAsB,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AACtF,OAAO,EAAE,gCAAgC,EAA8B,MAAM,+BAA+B,CAAC;AAO7G;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAU,CACtC,kBAAkB,EAClB,CAAC,iBAAiB,CAAC,KAAK,EAAE,yBAAyB,CAAC,KAAK,EAAE,gCAAgC,CAAC,KAAK,CAAU,EAC3G,CACI,UAAsB,EACtB,kBAAsC,EACtC,0BAAsD,EACxD,EAAE;IACA,UAAU,CAAC,MAAM;SACZ,IAAI,CACD,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAC9B,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACvB,IAAI,EAAE,aAAsB;QAC5B,aAAa,EAAE,IAAI;QACnB,iBAAiB,EACb,IAAI,KAAK,QAAQ;YACb,CAAC,CAAC,0BAA0B,CAAC,gCAAgC;YAC7D,CAAC,CAAC,0BAA0B,CAAC,iCAAiC;KACzE,CAAC,CAAC,CACN;SACA,SAAS,CAAC;QACP,IAAI,EAAE,CAAC,gBAAgB,EAAE,EAAE;YACvB,kBAAkB,CAAC,aAAa,CAAC,IAAI,gBAAgB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC;YACxF,0BAA0B,CAAC,KAAK,CAC5B,0BAA0B,EAC1B,CAAC,EACD,IAAI,GAAG,CAAC;gBACJ;oBACI,UAAU;oBACV,CACI,gBAAgB,CAAC,iBAAiB;wBAClC,0BAA0B,CAAC,gCAAgC,CAC9D,CAAC,QAAQ,EAAE;iBACf;aACJ,CAAC,CACL,CAAC;QACN,CAAC;KACJ,CAAC,CAAC;AACX,CAAC,CACJ,CAAC","sourcesContent":["import { forActions } from \"@snap/state-management\";\nimport { map } from \"rxjs\";\nimport { Injectable } from \"../../dependency-injection/Injectable\";\nimport { TypedCustomEvent } from \"../../events/TypedCustomEvent\";\nimport { CameraKitLegalPromptResult } from \"../../generated-proto/blizzard/cameraKitEvents\";\nimport { LegalState, legalStateFactory } from \"../../legal/legalState\";\nimport { MakeTaggedBusinessEvent } from \"../businessEventsReporter\";\nimport { MetricsEventTarget, metricsEventTargetFactory } from \"../metricsEventTarget\";\nimport { operationalMetricReporterFactory, OperationalMetricsReporter } from \"../operationalMetricsReporter\";\n\n/**\n * The LegalPrompt metric reports each time a BIPA legal prompt is shown.\n */\nexport type LegalPrompt = MakeTaggedBusinessEvent<\"legalPrompt\">;\n\n/**\n * @internal\n */\nexport const reportLegalState = Injectable(\n    \"reportLegalState\",\n    [legalStateFactory.token, metricsEventTargetFactory.token, operationalMetricReporterFactory.token] as const,\n    (\n        legalState: LegalState,\n        metricsEventTarget: MetricsEventTarget,\n        operationalMetricsReporter: OperationalMetricsReporter\n    ) => {\n        legalState.events\n            .pipe(\n                forActions(\"accept\", \"reject\"),\n                map(([{ data, name }]) => ({\n                    name: \"legalPrompt\" as const,\n                    legalPromptId: data,\n                    legalPromptResult:\n                        name === \"accept\"\n                            ? CameraKitLegalPromptResult.CAMERA_KIT_LEGAL_PROMPT_ACCEPTED\n                            : CameraKitLegalPromptResult.CAMERA_KIT_LEGAL_PROMPT_DISMISSED,\n                }))\n            )\n            .subscribe({\n                next: (legalPromptEvent) => {\n                    metricsEventTarget.dispatchEvent(new TypedCustomEvent(\"legalPrompt\", legalPromptEvent));\n                    operationalMetricsReporter.count(\n                        \"legal_prompt_interaction\",\n                        1,\n                        new Map([\n                            [\n                                \"accepted\",\n                                (\n                                    legalPromptEvent.legalPromptResult ===\n                                    CameraKitLegalPromptResult.CAMERA_KIT_LEGAL_PROMPT_ACCEPTED\n                                ).toString(),\n                            ],\n                        ])\n                    );\n                },\n            });\n    }\n);\n"]}

package/lib/metrics/reporters/reportLensAndAssetDownload.d.ts

@@ -0,0 +1,38 @@
+import { Dimensions } from "../../handlers/requestStateEmittingHandler";
+import { MakeTaggedBusinessEvent } from "../businessEventsReporter";
+import { MetricsEventTarget } from "../metricsEventTarget";
+import { OperationalMetricsReporter } from "../operationalMetricsReporter";
+export declare const isLensOrAssetRequest: (value: Dimensions) => value is AssetDownloadDimensions | LensDownloadDimensions;
+/**
+ * The LensDownload metric is triggered by any download of lens content.
+ *
+ * It contains download stats, which lens was requested, and whether prefetch was used.
+ *
+ * It corresponds to the internal CameraKitLensDownload event, described here:
+ * https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/edit#heading=h.stqom49qs91t
+ */
+export declare type LensDownload = MakeTaggedBusinessEvent<"lensDownload">;
+export declare type LensDownloadDimensions = {
+    requestType: "lens_content";
+    lensId: string;
+};
+/**
+ * The AssetDownload metric is triggered by any type of asset download.
+ *
+ * It contains download stats, which asset was requested, and whether prefetch was used.
+ *
+ * It corresponds to the internal CameraKitAssetDownload event, described here:
+ * https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/edit#heading=h.vlormd1724fp
+ */
+export declare type AssetDownload = MakeTaggedBusinessEvent<"assetDownload">;
+export declare type AssetDownloadDimensions = {
+    requestType: "asset";
+    assetType: string;
+    assetId: string;
+    lensId: string;
+};
+export declare const reportLensAndAssetDownload: {
+    (args_0: MetricsEventTarget, args_1: OperationalMetricsReporter): void;
+    token: "reportLensAndAssetDownload";
+    dependencies: readonly ["metricsEventTarget", "operationalMetricsReporter"];
+};

package/lib/metrics/reporters/reportLensAndAssetDownload.js

@@ -0,0 +1,88 @@
+import { assertUnreachable } from "../../common/assertions";
+import { stringifyError } from "../../common/errorHelpers";
+import { Injectable } from "../../dependency-injection/Injectable";
+import { scan } from "../../events/scan";
+import { TypedCustomEvent } from "../../events/TypedCustomEvent";
+import { requestStateEventTarget } from "../../handlers/requestStateEmittingHandler";
+import { metricsEventTargetFactory } from "../metricsEventTarget";
+import { operationalMetricReporterFactory } from "../operationalMetricsReporter";
+const relevantRequestTypes = ["lens_content", "asset"];
+export const isLensOrAssetRequest = (value) => {
+    const requestType = value["requestType"];
+    // Safety: the cast makes the type less specific so we can check if any string is present in the tuple.
+    return typeof requestType === "string" && relevantRequestTypes.includes(requestType);
+};
+export const reportLensAndAssetDownload = Injectable("reportLensAndAssetDownload", [metricsEventTargetFactory.token, operationalMetricReporterFactory.token], (metricsEventTarget, reporter) => {
+    scan({ name: "inProgress", inProgress: new Map() })(requestStateEventTarget, ["started", "completed", "errored"], (state, event) => {
+        const { inProgress } = state;
+        const { dimensions, requestId, timeMs } = event.detail;
+        if (!isLensOrAssetRequest(dimensions))
+            return state;
+        switch (event.type) {
+            case "started":
+                inProgress.set(requestId, { startTimeMs: timeMs });
+                return { name: "inProgress", inProgress };
+            case "completed":
+                const completedRequest = inProgress.get(requestId);
+                if (!completedRequest)
+                    return state;
+                inProgress.delete(requestId);
+                const downloadTimeSec = (timeMs - completedRequest.startTimeMs) / 1000;
+                const { sizeByte } = event.detail;
+                switch (dimensions.requestType) {
+                    case "lens_content":
+                        return {
+                            name: "completed",
+                            inProgress,
+                            event: new TypedCustomEvent("lensDownload", {
+                                name: "lensDownload",
+                                lensId: dimensions.lensId,
+                                automaticDownload: false,
+                                sizeByte,
+                                downloadTimeSec,
+                            }),
+                        };
+                    case "asset":
+                        return {
+                            name: "completed",
+                            inProgress,
+                            event: new TypedCustomEvent("assetDownload", {
+                                name: "assetDownload",
+                                assetId: dimensions.assetId,
+                                automaticDownload: false,
+                                sizeByte,
+                                downloadTimeSec,
+                            }),
+                        };
+                    default:
+                        assertUnreachable(dimensions);
+                }
+            case "errored":
+                const erroredRequest = inProgress.get(requestId);
+                if (!erroredRequest)
+                    return state;
+                inProgress.delete(requestId);
+                const error = event.detail.error;
+                return {
+                    name: "completed",
+                    inProgress,
+                    event: new TypedCustomEvent("exception", {
+                        name: "exception",
+                        lensId: dimensions.lensId,
+                        type: dimensions.requestType === "lens_content" ? "lens" : "asset",
+                        reason: stringifyError(error),
+                    }),
+                };
+            default:
+                assertUnreachable(event);
+        }
+    }).addEventListener("state", ({ detail: state }) => {
+        if (state.name !== "completed")
+            return;
+        metricsEventTarget.dispatchEvent(state.event);
+        if (state.event.detail.name === "exception") {
+            reporter.count("handled_exception", 1, new Map([["type", state.event.detail.type]]));
+        }
+    });
+});
+//# sourceMappingURL=reportLensAndAssetDownload.js.map

package/lib/metrics/reporters/reportLensAndAssetDownload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportLensAndAssetDownload.js","sourceRoot":"","sources":["../../../src/metrics/reporters/reportLensAndAssetDownload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAc,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AAEjG,OAAO,EAA6C,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAC7G,OAAO,EAAE,gCAAgC,EAA8B,MAAM,+BAA+B,CAAC;AAc7G,MAAM,oBAAoB,GAAG,CAAC,cAAc,EAAE,OAAO,CAAU,CAAC;AAChE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAiB,EAA6D,EAAE;IACjH,MAAM,WAAW,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;IACzC,uGAAuG;IACvG,OAAO,OAAO,WAAW,KAAK,QAAQ,IAAK,oBAA0C,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AAChH,CAAC,CAAC;AAwBF,MAAM,CAAC,MAAM,0BAA0B,GAAG,UAAU,CAChD,4BAA4B,EAC5B,CAAC,yBAAyB,CAAC,KAAK,EAAE,gCAAgC,CAAC,KAAK,CAAU,EAClF,CAAC,kBAAsC,EAAE,QAAoC,EAAE,EAAE;IAC7E,IAAI,CAAe,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC,CAC7D,uBAAuB,EACvB,CAAC,SAAS,EAAE,WAAW,EAAE,SAAS,CAAC,EACnC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACb,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;QAC7B,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC;QAEvD,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC;YAAE,OAAO,KAAK,CAAC;QAEpD,QAAQ,KAAK,CAAC,IAAI,EAAE;YAChB,KAAK,SAAS;gBACV,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC;gBACnD,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC;YAC9C,KAAK,WAAW;gBACZ,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACnD,IAAI,CAAC,gBAAgB;oBAAE,OAAO,KAAK,CAAC;gBACpC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAE7B,MAAM,eAAe,GAAG,CAAC,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;gBACvE,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC;gBAElC,QAAQ,UAAU,CAAC,WAAW,EAAE;oBAC5B,KAAK,cAAc;wBACf,OAAO;4BACH,IAAI,EAAE,WAAW;4BACjB,UAAU;4BACV,KAAK,EAAE,IAAI,gBAAgB,CAAC,cAAc,EAAE;gCACxC,IAAI,EAAE,cAAc;gCACpB,MAAM,EAAE,UAAU,CAAC,MAAM;gCACzB,iBAAiB,EAAE,KAAK;gCACxB,QAAQ;gCACR,eAAe;6BAClB,CAAC;yBACL,CAAC;oBACN,KAAK,OAAO;wBACR,OAAO;4BACH,IAAI,EAAE,WAAW;4BACjB,UAAU;4BACV,KAAK,EAAE,IAAI,gBAAgB,CAAC,eAAe,EAAE;gCACzC,IAAI,EAAE,eAAe;gCACrB,OAAO,EAAE,UAAU,CAAC,OAAO;gCAC3B,iBAAiB,EAAE,KAAK;gCACxB,QAAQ;gCACR,eAAe;6BAClB,CAAC;yBACL,CAAC;oBACN;wBACI,iBAAiB,CAAC,UAAU,CAAC,CAAC;iBACrC;YACL,KAAK,SAAS;gBACV,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACjD,IAAI,CAAC,cAAc;oBAAE,OAAO,KAAK,CAAC;gBAClC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC;gBACjC,OAAO;oBACH,IAAI,EAAE,WAAW;oBACjB,UAAU;oBACV,KAAK,EAAE,IAAI,gBAAgB,CAAC,WAAW,EAAE;wBACrC,IAAI,EAAE,WAAW;wBACjB,MAAM,EAAE,UAAU,CAAC,MAAM;wBACzB,IAAI,EAAE,UAAU,CAAC,WAAW,KAAK,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;wBAClE,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC;qBAChC,CAAC;iBACL,CAAC;YACN;gBACI,iBAAiB,CAAC,KAAK,CAAC,CAAC;SAChC;IACL,CAAC,CACJ,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE;QAC9C,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW;YAAE,OAAO;QACvC,kBAAkB,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,WAAW,EAAE;YACzC,QAAQ,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SACxF;IACL,CAAC,CAAC,CAAC;AACP,CAAC,CACJ,CAAC","sourcesContent":["import { assertUnreachable } from \"../../common/assertions\";\nimport { stringifyError } from \"../../common/errorHelpers\";\nimport { Injectable } from \"../../dependency-injection/Injectable\";\nimport { scan } from \"../../events/scan\";\nimport { TypedCustomEvent } from \"../../events/TypedCustomEvent\";\nimport { Dimensions, requestStateEventTarget } from \"../../handlers/requestStateEmittingHandler\";\nimport { MakeTaggedBusinessEvent } from \"../businessEventsReporter\";\nimport { CameraKitMetricEvents, MetricsEventTarget, metricsEventTargetFactory } from \"../metricsEventTarget\";\nimport { operationalMetricReporterFactory, OperationalMetricsReporter } from \"../operationalMetricsReporter\";\n\ntype InProgressMap = Map<number, { startTimeMs: number }>;\ninterface InProgress {\n    name: \"inProgress\";\n    inProgress: InProgressMap;\n}\ninterface Completed {\n    name: \"completed\";\n    inProgress: InProgressMap;\n    event: CameraKitMetricEvents;\n}\ntype RequestState = InProgress | Completed;\n\nconst relevantRequestTypes = [\"lens_content\", \"asset\"] as const;\nexport const isLensOrAssetRequest = (value: Dimensions): value is LensDownloadDimensions | AssetDownloadDimensions => {\n    const requestType = value[\"requestType\"];\n    // Safety: the cast makes the type less specific so we can check if any string is present in the tuple.\n    return typeof requestType === \"string\" && (relevantRequestTypes as readonly string[]).includes(requestType);\n};\n\n/**\n * The LensDownload metric is triggered by any download of lens content.\n *\n * It contains download stats, which lens was requested, and whether prefetch was used.\n *\n * It corresponds to the internal CameraKitLensDownload event, described here:\n * https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/edit#heading=h.stqom49qs91t\n */\nexport type LensDownload = MakeTaggedBusinessEvent<\"lensDownload\">;\nexport type LensDownloadDimensions = { requestType: \"lens_content\"; lensId: string };\n\n/**\n * The AssetDownload metric is triggered by any type of asset download.\n *\n * It contains download stats, which asset was requested, and whether prefetch was used.\n *\n * It corresponds to the internal CameraKitAssetDownload event, described here:\n * https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/edit#heading=h.vlormd1724fp\n */\nexport type AssetDownload = MakeTaggedBusinessEvent<\"assetDownload\">;\nexport type AssetDownloadDimensions = { requestType: \"asset\"; assetType: string; assetId: string; lensId: string };\n\nexport const reportLensAndAssetDownload = Injectable(\n    \"reportLensAndAssetDownload\",\n    [metricsEventTargetFactory.token, operationalMetricReporterFactory.token] as const,\n    (metricsEventTarget: MetricsEventTarget, reporter: OperationalMetricsReporter) => {\n        scan<RequestState>({ name: \"inProgress\", inProgress: new Map() })(\n            requestStateEventTarget,\n            [\"started\", \"completed\", \"errored\"],\n            (state, event) => {\n                const { inProgress } = state;\n                const { dimensions, requestId, timeMs } = event.detail;\n\n                if (!isLensOrAssetRequest(dimensions)) return state;\n\n                switch (event.type) {\n                    case \"started\":\n                        inProgress.set(requestId, { startTimeMs: timeMs });\n                        return { name: \"inProgress\", inProgress };\n                    case \"completed\":\n                        const completedRequest = inProgress.get(requestId);\n                        if (!completedRequest) return state;\n                        inProgress.delete(requestId);\n\n                        const downloadTimeSec = (timeMs - completedRequest.startTimeMs) / 1000;\n                        const { sizeByte } = event.detail;\n\n                        switch (dimensions.requestType) {\n                            case \"lens_content\":\n                                return {\n                                    name: \"completed\",\n                                    inProgress,\n                                    event: new TypedCustomEvent(\"lensDownload\", {\n                                        name: \"lensDownload\",\n                                        lensId: dimensions.lensId,\n                                        automaticDownload: false,\n                                        sizeByte,\n                                        downloadTimeSec,\n                                    }),\n                                };\n                            case \"asset\":\n                                return {\n                                    name: \"completed\",\n                                    inProgress,\n                                    event: new TypedCustomEvent(\"assetDownload\", {\n                                        name: \"assetDownload\",\n                                        assetId: dimensions.assetId,\n                                        automaticDownload: false,\n                                        sizeByte,\n                                        downloadTimeSec,\n                                    }),\n                                };\n                            default:\n                                assertUnreachable(dimensions);\n                        }\n                    case \"errored\":\n                        const erroredRequest = inProgress.get(requestId);\n                        if (!erroredRequest) return state;\n                        inProgress.delete(requestId);\n                        const error = event.detail.error;\n                        return {\n                            name: \"completed\",\n                            inProgress,\n                            event: new TypedCustomEvent(\"exception\", {\n                                name: \"exception\",\n                                lensId: dimensions.lensId,\n                                type: dimensions.requestType === \"lens_content\" ? \"lens\" : \"asset\",\n                                reason: stringifyError(error),\n                            }),\n                        };\n                    default:\n                        assertUnreachable(event);\n                }\n            }\n        ).addEventListener(\"state\", ({ detail: state }) => {\n            if (state.name !== \"completed\") return;\n            metricsEventTarget.dispatchEvent(state.event);\n            if (state.event.detail.name === \"exception\") {\n                reporter.count(\"handled_exception\", 1, new Map([[\"type\", state.event.detail.type]]));\n            }\n        });\n    }\n);\n"]}

package/lib/metrics/reporters/reportLensValidationFailed.d.ts

@@ -0,0 +1,20 @@
+import { MakeTaggedBusinessEvent } from "../businessEventsReporter";
+import { MetricsEventTarget } from "../metricsEventTarget";
+/**
+ * The LensContentValidationFailed metric reports every time we handle an lens checksum validation failure.
+ */
+export declare type LensContentValidationFailed = MakeTaggedBusinessEvent<"lensContentValidationFailed">;
+/**
+ * @internal
+ */
+export declare const reportLensValidationFailed: {
+    (args_0: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"applyLens", {
+        lens: import("../..").Lens;
+        launchParams?: import("../..").LensLaunchParams | undefined;
+    }> | import("@snap/state-management").Action<"downloadComplete", import("../..").Lens> | import("@snap/state-management").Action<"turnedOn", import("../..").Lens> | import("@snap/state-management").Action<"resourcesLoaded", import("../..").Lens> | import("@snap/state-management").Action<"firstFrameProcessed", import("../..").Lens> | import("@snap/state-management").Action<"applyLensComplete", import("../..").Lens> | import("@snap/state-management").Action<"applyLensFailed", {
+        error: import("../../session/lensState").LensErrors;
+        lens: import("../..").Lens;
+    }> | import("@snap/state-management").Action<"removeLens", undefined> | import("@snap/state-management").Action<"turnedOff", import("../..").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", import("../..").Lens> | import("@snap/state-management").State<"lensApplied", import("../..").Lens>>, args_1: MetricsEventTarget): void;
+    token: "reportLensValidationFailed";
+    dependencies: readonly ["lensState", "metricsEventTarget"];
+};

package/lib/metrics/reporters/reportLensValidationFailed.js

@@ -0,0 +1,24 @@
+import { forActions } from "@snap/state-management";
+import { filter } from "rxjs";
+import { Injectable } from "../../dependency-injection/Injectable";
+import { TypedCustomEvent } from "../../events/TypedCustomEvent";
+import { lensStateFactory } from "../../session/lensState";
+import { metricsEventTargetFactory } from "../metricsEventTarget";
+/**
+ * @internal
+ */
+export const reportLensValidationFailed = Injectable("reportLensValidationFailed", [lensStateFactory.token, metricsEventTargetFactory.token], (lensState, metricsEventTarget) => {
+    lensState.events
+        .pipe(forActions("applyLensFailed"), filter(([a]) => a.data.error.name === "LensContentValidationError"))
+        .subscribe({
+        next: ([{ data }]) => {
+            const { lens } = data;
+            const lensContentValidationFailed = {
+                name: "lensContentValidationFailed",
+                lensId: lens.id,
+            };
+            metricsEventTarget.dispatchEvent(new TypedCustomEvent("lensContentValidationFailed", lensContentValidationFailed));
+        },
+    });
+});
+//# sourceMappingURL=reportLensValidationFailed.js.map

package/lib/metrics/reporters/reportLensValidationFailed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportLensValidationFailed.js","sourceRoot":"","sources":["../../../src/metrics/reporters/reportLensValidationFailed.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAa,MAAM,yBAAyB,CAAC;AAEtE,OAAO,EAAsB,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAOtF;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,UAAU,CAChD,4BAA4B,EAC5B,CAAC,gBAAgB,CAAC,KAAK,EAAE,yBAAyB,CAAC,KAAK,CAAU,EAClE,CAAC,SAAoB,EAAE,kBAAsC,EAAE,EAAE;IAC7D,SAAS,CAAC,MAAM;SACX,IAAI,CACD,UAAU,CAAC,iBAAiB,CAAC,EAC7B,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,4BAA4B,CAAC,CACtE;SACA,SAAS,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE;YACjB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YACtB,MAAM,2BAA2B,GAAgC;gBAC7D,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,IAAI,CAAC,EAAE;aAClB,CAAC;YACF,kBAAkB,CAAC,aAAa,CAC5B,IAAI,gBAAgB,CAAC,6BAA6B,EAAE,2BAA2B,CAAC,CACnF,CAAC;QACN,CAAC;KACJ,CAAC,CAAC;AACX,CAAC,CACJ,CAAC","sourcesContent":["import { forActions } from \"@snap/state-management\";\nimport { filter } from \"rxjs\";\nimport { Injectable } from \"../../dependency-injection/Injectable\";\nimport { TypedCustomEvent } from \"../../events/TypedCustomEvent\";\nimport { lensStateFactory, LensState } from \"../../session/lensState\";\nimport { MakeTaggedBusinessEvent } from \"../businessEventsReporter\";\nimport { MetricsEventTarget, metricsEventTargetFactory } from \"../metricsEventTarget\";\n\n/**\n * The LensContentValidationFailed metric reports every time we handle an lens checksum validation failure.\n */\nexport type LensContentValidationFailed = MakeTaggedBusinessEvent<\"lensContentValidationFailed\">;\n\n/**\n * @internal\n */\nexport const reportLensValidationFailed = Injectable(\n    \"reportLensValidationFailed\",\n    [lensStateFactory.token, metricsEventTargetFactory.token] as const,\n    (lensState: LensState, metricsEventTarget: MetricsEventTarget) => {\n        lensState.events\n            .pipe(\n                forActions(\"applyLensFailed\"),\n                filter(([a]) => a.data.error.name === \"LensContentValidationError\")\n            )\n            .subscribe({\n                next: ([{ data }]) => {\n                    const { lens } = data;\n                    const lensContentValidationFailed: LensContentValidationFailed = {\n                        name: \"lensContentValidationFailed\",\n                        lensId: lens.id,\n                    };\n                    metricsEventTarget.dispatchEvent(\n                        new TypedCustomEvent(\"lensContentValidationFailed\", lensContentValidationFailed)\n                    );\n                },\n            });\n    }\n);\n"]}

package/lib/metrics/reporters/reportLensView.d.ts

@@ -0,0 +1,36 @@
+import { MetricsEventTarget } from "../metricsEventTarget";
+import { CameraKitSession } from "../../session/CameraKitSession";
+import { MakeTaggedBusinessEvent } from "../businessEventsReporter";
+import { OperationalMetricsReporter } from "../operationalMetricsReporter";
+import { CameraKitConfiguration } from "../../configuration";
+/**
+ * The LensView metric is emitted after a lens has been viewed (for longer than 100ms), when the lens is turned off.
+ *
+ * It contains information about rendering performance.
+ *
+ * Notes:
+ *   - If the page is hidden (e.g. user switches to a different tab, or application, or closes the tab, or closes the
+ *     browser, navigates to a new page, refreshes, etc.) this metric will be emitted at that time. This is to ensure
+ *     we don't lose the metric if the page is closed.
+ *   - If the page is hidden and then made visible again later (e.g. user switches to a different tab, then back), we
+ *     will begin measuring a new LensView. That is, we will not capture the time when the page is hidden even if the
+ *     lens is still rendering in the background.
+ *
+ * @category Lenses
+ * @category Metrics
+ */
+export declare type LensView = MakeTaggedBusinessEvent<"lensView">;
+/**
+ * @internal
+ */
+export declare const reportLensView: {
+    (args_0: CameraKitSession, args_1: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"applyLens", {
+        lens: import("../..").Lens;
+        launchParams?: import("../..").LensLaunchParams | undefined;
+    }> | import("@snap/state-management").Action<"downloadComplete", import("../..").Lens> | import("@snap/state-management").Action<"turnedOn", import("../..").Lens> | import("@snap/state-management").Action<"resourcesLoaded", import("../..").Lens> | import("@snap/state-management").Action<"firstFrameProcessed", import("../..").Lens> | import("@snap/state-management").Action<"applyLensComplete", import("../..").Lens> | import("@snap/state-management").Action<"applyLensFailed", {
+        error: import("../../session/lensState").LensErrors;
+        lens: import("../..").Lens;
+    }> | import("@snap/state-management").Action<"removeLens", undefined> | import("@snap/state-management").Action<"turnedOff", import("../..").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", import("../..").Lens> | import("@snap/state-management").State<"lensApplied", import("../..").Lens>>, args_2: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"suspend", CameraKitSession> | import("@snap/state-management").Action<"resume", CameraKitSession>, import("@snap/state-management").State<"inactive", undefined> | import("@snap/state-management").State<"active", CameraKitSession>>, args_3: MetricsEventTarget, args_4: OperationalMetricsReporter, args_5: CameraKitConfiguration): void;
+    token: "reportLensView";
+    dependencies: readonly ["CameraKitSession", "lensState", "sessionState", "metricsEventTarget", "operationalMetricsReporter", "configuration"];
+};

package/lib/metrics/reporters/reportLensView.js

@@ -0,0 +1,101 @@
+import { __awaiter } from "tslib";
+import { combineLatestWith, filter, map, merge, mergeMap, of, raceWith, switchMap, take, takeUntil } from "rxjs";
+import { forActions, inStates, isState } from "@snap/state-management";
+import { Injectable } from "../../dependency-injection/Injectable";
+import { TypedCustomEvent } from "../../events/TypedCustomEvent";
+import { metricsEventTargetFactory } from "../metricsEventTarget";
+import { cameraKitSessionFactory } from "../../session/CameraKitSession";
+import { getTimeMs } from "../../common/time";
+import { operationalMetricReporterFactory } from "../operationalMetricsReporter";
+import { configurationToken } from "../../configuration";
+import { lensStateFactory } from "../../session/lensState";
+import { sessionStateFactory } from "../../session/sessionState";
+// We ignore short-duration lens views.
+//
+// The value is documented here:
+// https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/edit#heading=h.q5liip76r9lt
+const viewTimeThresholdSec = 0.1;
+/**
+ * @internal
+ */
+export const reportLensView = Injectable("reportLensView", [
+    cameraKitSessionFactory.token,
+    lensStateFactory.token,
+    sessionStateFactory.token,
+    metricsEventTargetFactory.token,
+    operationalMetricReporterFactory.token,
+    configurationToken,
+], (session, lensState, sessionState, metricsEventTarget, operationalMetricsReporter, configuration) => {
+    merge(
+    // Begin measuring LensCore apply time once the lens has finished downloading and we actually add the lens
+    // to LensCore (LensWait measures the full download + LensCore apply time i.e. perceived UX latency).
+    lensState.events.pipe(forActions("downloadComplete"), map(([a]) => a.data)), 
+    // If the session is resumed (e.g. user returns to this tab while a lens is on), we count this as a new
+    // LensView (and applyDelaySec will be 0).
+    lensState.events.pipe(inStates("lensApplied"), switchMap(([, s]) => sessionState.events.pipe(forActions("resume"), takeUntil(lensState.events.pipe(forActions("removeLens"))), map(() => s.data)))))
+        .pipe(map((lens) => [getTimeMs(), lens.id]), mergeMap(([applyLensStartTime, lensId]) => {
+        const alreadyOn = isState(lensState.getState(), "lensApplied");
+        const applyDelay = alreadyOn
+            ? of(0)
+            : lensState.events.pipe(forActions("resourcesLoaded"), filter(([a]) => a.data.id === lensId), 
+            // Applying a new lens may happen before removing the old one, so if we kept taking events
+            // we would get the lensResourcesLoaded for the next lens, too.
+            take(1), map(() => (getTimeMs() - applyLensStartTime) / 1000));
+        const viewMetrics = (alreadyOn
+            ? of([getTimeMs(), session.metrics.beginMeasurement()])
+            : lensState.events.pipe(forActions("turnedOn"), filter(([a]) => a.data.id === lensId), map(() => [getTimeMs(), session.metrics.beginMeasurement()]))).pipe(take(1), mergeMap(([lensTurnedOnTime, metricsMeasurement]) => lensState.events.pipe(forActions("turnedOff"), 
+        // Applying a new lens may happen before removing the old one, so we'll get a
+        // lensTurnedOff for the prior lens (if one was applied), which we must filter out.
+        filter(([a]) => a.data.id === lensId), 
+        // If the session is suspended, we'll count that as the lens turning off.
+        raceWith(sessionState.events.pipe(forActions("suspend"))), map(() => {
+            metricsMeasurement.end();
+            return Object.assign({ viewTimeSec: (getTimeMs() - lensTurnedOnTime) / 1000 }, metricsMeasurement.measure());
+        }))));
+        return applyDelay.pipe(combineLatestWith(viewMetrics), 
+        // This lens should always receive the lensTurnedOff action *before* the next lens is turned on.
+        // But just in case that assumption is violated, we'll clean up (and not report) if another lens
+        // turns on before our lens is turned off.
+        takeUntil(lensState.events.pipe(forActions("turnedOn"), filter(([a]) => a.data.id !== lensId))), take(1), map(([applyDelaySec, viewMetrics]) => (Object.assign({ applyDelaySec,
+            lensId }, viewMetrics))));
+    }))
+        .subscribe({
+        next: ({ applyDelaySec, lensId, viewTimeSec, avgFps, lensFrameProcessingTimeMsAvg, lensFrameProcessingTimeMsStd, }) => __awaiter(void 0, void 0, void 0, function* () {
+            var _a;
+            if (viewTimeSec < viewTimeThresholdSec)
+                return;
+            const { cluster: performanceCluster, webglRendererInfo, } = (_a = (yield configuration.lensPerformance)) !== null && _a !== void 0 ? _a : {
+                cluster: 0,
+                webglRendererInfo: "unknown",
+            };
+            const lensView = {
+                name: "lensView",
+                applyDelaySec,
+                avgFps,
+                lensId,
+                lensFrameProcessingTimeMsAvg,
+                lensFrameProcessingTimeMsStd,
+                // We don't support recording video, but applications may do this without our knowledge.
+                recordingTimeSec: 0,
+                viewTimeSec,
+                // TODO: if we want to support these fields, we'll need some persistence to keep track of the
+                // date of last application per lens.
+                // https://jira.sc-corp.net/browse/CAMKIT-3050
+                isLensFirstWithinDay: false,
+                isLensFirstWithinMonth: false,
+                performanceCluster,
+                webglRendererInfo,
+            };
+            metricsEventTarget.dispatchEvent(new TypedCustomEvent("lensView", lensView));
+            // Reporting operational metrics described here:
+            // https://docs.google.com/document/d/1g4PncAmKdyrLEFVp8ODp58oer2UJu9PIetRW035nnTo
+            //
+            // We ignore if applyDelaySec is 0, which will be the case if the session was suspended and then
+            // resumed - we only care about this metric when a new lens has been loaded.
+            if (applyDelaySec > 0)
+                operationalMetricsReporter.timer("lens.core_loading_latency", applyDelaySec * 1000);
+            operationalMetricsReporter.timer("lens.processing_time", lensFrameProcessingTimeMsAvg, new Map([["performance_cluster", performanceCluster.toString()]]));
+        }),
+    });
+});
+//# sourceMappingURL=reportLensView.js.map

package/lib/metrics/reporters/reportLensView.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportLensView.js","sourceRoot":"","sources":["../../../src/metrics/reporters/reportLensView.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjH,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAsB,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AACtF,OAAO,EAAoB,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAE3F,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,gCAAgC,EAA8B,MAAM,+BAA+B,CAAC;AAC7G,OAAO,EAA0B,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAa,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAgB,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAE/E,uCAAuC;AACvC,EAAE;AACF,gCAAgC;AAChC,8GAA8G;AAC9G,MAAM,oBAAoB,GAAG,GAAG,CAAC;AAsBjC;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CACpC,gBAAgB,EAChB;IACI,uBAAuB,CAAC,KAAK;IAC7B,gBAAgB,CAAC,KAAK;IACtB,mBAAmB,CAAC,KAAK;IACzB,yBAAyB,CAAC,KAAK;IAC/B,gCAAgC,CAAC,KAAK;IACtC,kBAAkB;CACZ,EACV,CACI,OAAyB,EACzB,SAAoB,EACpB,YAA0B,EAC1B,kBAAsC,EACtC,0BAAsD,EACtD,aAAqC,EACjC,EAAE;IACN,KAAK;IACD,0GAA0G;IAC1G,qGAAqG;IACrG,SAAS,CAAC,MAAM,CAAC,IAAI,CACjB,UAAU,CAAC,kBAAkB,CAAC,EAC9B,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CACvB;IAED,uGAAuG;IACvG,0CAA0C;IAC1C,SAAS,CAAC,MAAM,CAAC,IAAI,CACjB,QAAQ,CAAC,aAAa,CAAC,EACvB,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAChB,YAAY,CAAC,MAAM,CAAC,IAAI,CACpB,UAAU,CAAC,QAAQ,CAAC,EACpB,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,EAC1D,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CACpB,CACJ,CACJ,CACJ;SACI,IAAI,CACD,GAAG,CAAC,CAAC,IAAI,EAAoB,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EACvD,QAAQ,CAAC,CAAC,CAAC,kBAAkB,EAAE,MAAM,CAAC,EAAE,EAAE;QACtC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,aAAa,CAAC,CAAC;QAE/D,MAAM,UAAU,GAAG,SAAS;YACxB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CACjB,UAAU,CAAC,iBAAiB,CAAC,EAC7B,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC;YACrC,0FAA0F;YAC1F,+DAA+D;YAC/D,IAAI,CAAC,CAAC,CAAC,EACP,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,SAAS,EAAE,GAAG,kBAAkB,CAAC,GAAG,IAAI,CAAC,CACvD,CAAC;QAER,MAAM,WAAW,GAAG,CAAC,SAAS;YAC1B,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAU,CAAC;YAChE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CACjB,UAAU,CAAC,UAAU,CAAC,EACtB,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,EACrC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAU,CAAC,CACxE,CACN,CAAC,IAAI,CACF,IAAI,CAAC,CAAC,CAAC,EACP,QAAQ,CAAC,CAAC,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,EAAE,EAAE,CAChD,SAAS,CAAC,MAAM,CAAC,IAAI,CACjB,UAAU,CAAC,WAAW,CAAC;QACvB,6EAA6E;QAC7E,mFAAmF;QACnF,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC;QACrC,yEAAyE;QACzE,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EACzD,GAAG,CAAC,GAAG,EAAE;YACL,kBAAkB,CAAC,GAAG,EAAE,CAAC;YACzB,uBACI,WAAW,EAAE,CAAC,SAAS,EAAE,GAAG,gBAAgB,CAAC,GAAG,IAAI,IACjD,kBAAkB,CAAC,OAAO,EAAE,EACjC;QACN,CAAC,CAAC,CACL,CACJ,CACJ,CAAC;QAEF,OAAO,UAAU,CAAC,IAAI,CAClB,iBAAiB,CAAC,WAAW,CAAC;QAC9B,gGAAgG;QAChG,gGAAgG;QAChG,0CAA0C;QAC1C,SAAS,CACL,SAAS,CAAC,MAAM,CAAC,IAAI,CACjB,UAAU,CAAC,UAAU,CAAC,EACtB,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,CACxC,CACJ,EACD,IAAI,CAAC,CAAC,CAAC,EACP,GAAG,CAAC,CAAC,CAAC,aAAa,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,iBAClC,aAAa;YACb,MAAM,IACH,WAAW,EAChB,CAAC,CACN,CAAC;IACN,CAAC,CAAC,CACL;SACA,SAAS,CAAC;QACP,IAAI,EAAE,CAAO,EACT,aAAa,EACb,MAAM,EACN,WAAW,EACX,MAAM,EACN,4BAA4B,EAC5B,4BAA4B,GAC/B,EAAE,EAAE;;YACD,IAAI,WAAW,GAAG,oBAAoB;gBAAE,OAAO;YAC/C,MAAM,EACF,OAAO,EAAE,kBAAkB,EAC3B,iBAAiB,GACpB,GAAG,MAAA,CAAC,MAAM,aAAa,CAAC,eAAe,CAAC,mCAAI;gBACzC,OAAO,EAAE,CAAC;gBACV,iBAAiB,EAAE,SAAS;aAC/B,CAAC;YACF,MAAM,QAAQ,GAAa;gBACvB,IAAI,EAAE,UAAU;gBAChB,aAAa;gBACb,MAAM;gBACN,MAAM;gBACN,4BAA4B;gBAC5B,4BAA4B;gBAC5B,wFAAwF;gBACxF,gBAAgB,EAAE,CAAC;gBACnB,WAAW;gBACX,6FAA6F;gBAC7F,qCAAqC;gBACrC,8CAA8C;gBAC9C,oBAAoB,EAAE,KAAK;gBAC3B,sBAAsB,EAAE,KAAK;gBAC7B,kBAAkB;gBAClB,iBAAiB;aACpB,CAAC;YAEF,kBAAkB,CAAC,aAAa,CAAC,IAAI,gBAAgB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;YAE7E,gDAAgD;YAChD,kFAAkF;YAClF,EAAE;YACF,gGAAgG;YAChG,4EAA4E;YAC5E,IAAI,aAAa,GAAG,CAAC;gBACjB,0BAA0B,CAAC,KAAK,CAAC,2BAA2B,EAAE,aAAa,GAAG,IAAI,CAAC,CAAC;YACxF,0BAA0B,CAAC,KAAK,CAC5B,sBAAsB,EACtB,4BAA4B,EAC5B,IAAI,GAAG,CAAC,CAAC,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CACpE,CAAC;QACN,CAAC,CAAA;KACJ,CAAC,CAAC;AACX,CAAC,CACJ,CAAC","sourcesContent":["import { combineLatestWith, filter, map, merge, mergeMap, of, raceWith, switchMap, take, takeUntil } from \"rxjs\";\nimport { forActions, inStates, isState } from \"@snap/state-management\";\nimport { Injectable } from \"../../dependency-injection/Injectable\";\nimport { TypedCustomEvent } from \"../../events/TypedCustomEvent\";\nimport { MetricsEventTarget, metricsEventTargetFactory } from \"../metricsEventTarget\";\nimport { CameraKitSession, cameraKitSessionFactory } from \"../../session/CameraKitSession\";\nimport { MakeTaggedBusinessEvent } from \"../businessEventsReporter\";\nimport { getTimeMs } from \"../../common/time\";\nimport { operationalMetricReporterFactory, OperationalMetricsReporter } from \"../operationalMetricsReporter\";\nimport { CameraKitConfiguration, configurationToken } from \"../../configuration\";\nimport { lensStateFactory, LensState } from \"../../session/lensState\";\nimport { SessionState, sessionStateFactory } from \"../../session/sessionState\";\n\n// We ignore short-duration lens views.\n//\n// The value is documented here:\n// https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/edit#heading=h.q5liip76r9lt\nconst viewTimeThresholdSec = 0.1;\n\n/**\n * The LensView metric is emitted after a lens has been viewed (for longer than 100ms), when the lens is turned off.\n *\n * It contains information about rendering performance.\n *\n * Notes:\n *   - If the page is hidden (e.g. user switches to a different tab, or application, or closes the tab, or closes the\n *     browser, navigates to a new page, refreshes, etc.) this metric will be emitted at that time. This is to ensure\n *     we don't lose the metric if the page is closed.\n *   - If the page is hidden and then made visible again later (e.g. user switches to a different tab, then back), we\n *     will begin measuring a new LensView. That is, we will not capture the time when the page is hidden even if the\n *     lens is still rendering in the background.\n *\n * @category Lenses\n * @category Metrics\n */\n// This type corresponds to the internal CameraKitLensSwipe event, described here:\n// https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY#heading=h.q5liip76r9lt\nexport type LensView = MakeTaggedBusinessEvent<\"lensView\">;\n\n/**\n * @internal\n */\nexport const reportLensView = Injectable(\n    \"reportLensView\",\n    [\n        cameraKitSessionFactory.token,\n        lensStateFactory.token,\n        sessionStateFactory.token,\n        metricsEventTargetFactory.token,\n        operationalMetricReporterFactory.token,\n        configurationToken,\n    ] as const,\n    (\n        session: CameraKitSession,\n        lensState: LensState,\n        sessionState: SessionState,\n        metricsEventTarget: MetricsEventTarget,\n        operationalMetricsReporter: OperationalMetricsReporter,\n        configuration: CameraKitConfiguration\n    ): void => {\n        merge(\n            // Begin measuring LensCore apply time once the lens has finished downloading and we actually add the lens\n            // to LensCore (LensWait measures the full download + LensCore apply time i.e. perceived UX latency).\n            lensState.events.pipe(\n                forActions(\"downloadComplete\"),\n                map(([a]) => a.data)\n            ),\n\n            // If the session is resumed (e.g. user returns to this tab while a lens is on), we count this as a new\n            // LensView (and applyDelaySec will be 0).\n            lensState.events.pipe(\n                inStates(\"lensApplied\"),\n                switchMap(([, s]) =>\n                    sessionState.events.pipe(\n                        forActions(\"resume\"),\n                        takeUntil(lensState.events.pipe(forActions(\"removeLens\"))),\n                        map(() => s.data)\n                    )\n                )\n            )\n        )\n            .pipe(\n                map((lens): [number, string] => [getTimeMs(), lens.id]),\n                mergeMap(([applyLensStartTime, lensId]) => {\n                    const alreadyOn = isState(lensState.getState(), \"lensApplied\");\n\n                    const applyDelay = alreadyOn\n                        ? of(0)\n                        : lensState.events.pipe(\n                              forActions(\"resourcesLoaded\"),\n                              filter(([a]) => a.data.id === lensId),\n                              // Applying a new lens may happen before removing the old one, so if we kept taking events\n                              // we would get the lensResourcesLoaded for the next lens, too.\n                              take(1),\n                              map(() => (getTimeMs() - applyLensStartTime) / 1000)\n                          );\n\n                    const viewMetrics = (alreadyOn\n                        ? of([getTimeMs(), session.metrics.beginMeasurement()] as const)\n                        : lensState.events.pipe(\n                              forActions(\"turnedOn\"),\n                              filter(([a]) => a.data.id === lensId),\n                              map(() => [getTimeMs(), session.metrics.beginMeasurement()] as const)\n                          )\n                    ).pipe(\n                        take(1),\n                        mergeMap(([lensTurnedOnTime, metricsMeasurement]) =>\n                            lensState.events.pipe(\n                                forActions(\"turnedOff\"),\n                                // Applying a new lens may happen before removing the old one, so we'll get a\n                                // lensTurnedOff for the prior lens (if one was applied), which we must filter out.\n                                filter(([a]) => a.data.id === lensId),\n                                // If the session is suspended, we'll count that as the lens turning off.\n                                raceWith(sessionState.events.pipe(forActions(\"suspend\"))),\n                                map(() => {\n                                    metricsMeasurement.end();\n                                    return {\n                                        viewTimeSec: (getTimeMs() - lensTurnedOnTime) / 1000,\n                                        ...metricsMeasurement.measure(),\n                                    };\n                                })\n                            )\n                        )\n                    );\n\n                    return applyDelay.pipe(\n                        combineLatestWith(viewMetrics),\n                        // This lens should always receive the lensTurnedOff action *before* the next lens is turned on.\n                        // But just in case that assumption is violated, we'll clean up (and not report) if another lens\n                        // turns on before our lens is turned off.\n                        takeUntil(\n                            lensState.events.pipe(\n                                forActions(\"turnedOn\"),\n                                filter(([a]) => a.data.id !== lensId)\n                            )\n                        ),\n                        take(1),\n                        map(([applyDelaySec, viewMetrics]) => ({\n                            applyDelaySec,\n                            lensId,\n                            ...viewMetrics,\n                        }))\n                    );\n                })\n            )\n            .subscribe({\n                next: async ({\n                    applyDelaySec,\n                    lensId,\n                    viewTimeSec,\n                    avgFps,\n                    lensFrameProcessingTimeMsAvg,\n                    lensFrameProcessingTimeMsStd,\n                }) => {\n                    if (viewTimeSec < viewTimeThresholdSec) return;\n                    const {\n                        cluster: performanceCluster,\n                        webglRendererInfo,\n                    } = (await configuration.lensPerformance) ?? {\n                        cluster: 0,\n                        webglRendererInfo: \"unknown\",\n                    };\n                    const lensView: LensView = {\n                        name: \"lensView\",\n                        applyDelaySec,\n                        avgFps,\n                        lensId,\n                        lensFrameProcessingTimeMsAvg,\n                        lensFrameProcessingTimeMsStd,\n                        // We don't support recording video, but applications may do this without our knowledge.\n                        recordingTimeSec: 0,\n                        viewTimeSec,\n                        // TODO: if we want to support these fields, we'll need some persistence to keep track of the\n                        // date of last application per lens.\n                        // https://jira.sc-corp.net/browse/CAMKIT-3050\n                        isLensFirstWithinDay: false,\n                        isLensFirstWithinMonth: false,\n                        performanceCluster,\n                        webglRendererInfo,\n                    };\n\n                    metricsEventTarget.dispatchEvent(new TypedCustomEvent(\"lensView\", lensView));\n\n                    // Reporting operational metrics described here:\n                    // https://docs.google.com/document/d/1g4PncAmKdyrLEFVp8ODp58oer2UJu9PIetRW035nnTo\n                    //\n                    // We ignore if applyDelaySec is 0, which will be the case if the session was suspended and then\n                    // resumed - we only care about this metric when a new lens has been loaded.\n                    if (applyDelaySec > 0)\n                        operationalMetricsReporter.timer(\"lens.core_loading_latency\", applyDelaySec * 1000);\n                    operationalMetricsReporter.timer(\n                        \"lens.processing_time\",\n                        lensFrameProcessingTimeMsAvg,\n                        new Map([[\"performance_cluster\", performanceCluster.toString()]])\n                    );\n                },\n            });\n    }\n);\n"]}

package/lib/metrics/reporters/reportLensWait.d.ts

@@ -0,0 +1,33 @@
+import { MakeTaggedBusinessEvent } from "../businessEventsReporter";
+import { MetricsEventTarget } from "../metricsEventTarget";
+import { OperationalMetricsReporter } from "../operationalMetricsReporter";
+/**
+ * The LensWait metric measures the time spent downloading the lens content and required assets. It gives an indication
+ * of the real UX impact of download latency. If lens content and assets are pre-loaded, the latency measured here
+ * should decrease – we measure between the request to apply a lens and when the lens is ready to render.
+ *
+ * @category Lenses
+ * @category Metrics
+ */
+export declare type LensWait = MakeTaggedBusinessEvent<"lensWait">;
+/**
+ * Each time a lens is applied, we measure the duration until the lens is fully loaded by LensCore. This
+ * includes any time spent downloading the lens content and required assets from the lens manifest.
+ *
+ * The intention of this event is to measure the experienced UX latency between a user requesting a lens and
+ * the lens rendering. Of course, the application may call `applyLens` at any time, and may hide/show the
+ * rendered result at any time – but this should give us a good baseline for how much UX latency could be seen.
+ *
+ * @internal
+ */
+export declare const reportLensWait: {
+    (args_0: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"applyLens", {
+        lens: import("../..").Lens;
+        launchParams?: import("../..").LensLaunchParams | undefined;
+    }> | import("@snap/state-management").Action<"downloadComplete", import("../..").Lens> | import("@snap/state-management").Action<"turnedOn", import("../..").Lens> | import("@snap/state-management").Action<"resourcesLoaded", import("../..").Lens> | import("@snap/state-management").Action<"firstFrameProcessed", import("../..").Lens> | import("@snap/state-management").Action<"applyLensComplete", import("../..").Lens> | import("@snap/state-management").Action<"applyLensFailed", {
+        error: import("../../session/lensState").LensErrors;
+        lens: import("../..").Lens;
+    }> | import("@snap/state-management").Action<"removeLens", undefined> | import("@snap/state-management").Action<"turnedOff", import("../..").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", import("../..").Lens> | import("@snap/state-management").State<"lensApplied", import("../..").Lens>>, args_1: MetricsEventTarget, args_2: OperationalMetricsReporter): void;
+    token: "reportLensWait";
+    dependencies: readonly ["lensState", "metricsEventTarget", "operationalMetricsReporter"];
+};

package/lib/metrics/reporters/reportLensWait.js

@@ -0,0 +1,56 @@
+import { forActions } from "@snap/state-management";
+import { map, mergeMap, take } from "rxjs";
+import { getTimeMs } from "../../common/time";
+import { Injectable } from "../../dependency-injection/Injectable";
+import { TypedCustomEvent } from "../../events/TypedCustomEvent";
+import { lensStateFactory } from "../../session/lensState";
+import { metricsEventTargetFactory } from "../metricsEventTarget";
+import { operationalMetricReporterFactory } from "../operationalMetricsReporter";
+// We ignore short-duration lens waits.
+//
+// The value is documented here:
+// https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/edit#heading=h.q5liip76r9lt
+const viewTimeThresholdSec = 0.1;
+/**
+ * Each time a lens is applied, we measure the duration until the lens is fully loaded by LensCore. This
+ * includes any time spent downloading the lens content and required assets from the lens manifest.
+ *
+ * The intention of this event is to measure the experienced UX latency between a user requesting a lens and
+ * the lens rendering. Of course, the application may call `applyLens` at any time, and may hide/show the
+ * rendered result at any time – but this should give us a good baseline for how much UX latency could be seen.
+ *
+ * @internal
+ */
+export const reportLensWait = Injectable("reportLensWait", [lensStateFactory.token, metricsEventTargetFactory.token, operationalMetricReporterFactory.token], (lensState, metricsEventTarget, reporter) => {
+    lensState.events
+        .pipe(forActions("applyLens"), mergeMap(([a]) => {
+        const lensId = a.data.lens.id;
+        const applyLensStartTime = getTimeMs();
+        return lensState.events.pipe(
+        // We'll measure the time until either the requested lens was rendered, or a new applyLens
+        // request was made (in both cases, we're done waiting for this lens).
+        //
+        // This does have the side-effect that if a user rapidly switches between lenses, we'll record
+        // many low-duration lensWait events that are measuring user behavior instead of system latency.
+        // But this is a good trade-off so that we can capture those long-duration lensWaits that are
+        // terminated by the user trying a different lens.
+        //
+        // (This effect can be mitigated by increasing the viewtimeThresholdSec to ignore low-duration
+        // waits that are likely caused by user behavior).
+        forActions("firstFrameProcessed", "applyLens"), take(1), map(() => [(getTimeMs() - applyLensStartTime) / 1000, lensId]));
+    }))
+        .subscribe({
+        next: ([viewTimeSec, lensId]) => {
+            if (viewTimeSec < viewTimeThresholdSec)
+                return;
+            const lensWait = {
+                name: "lensWait",
+                lensId,
+                viewTimeSec,
+            };
+            metricsEventTarget.dispatchEvent(new TypedCustomEvent("lensWait", lensWait));
+            reporter.timer("lens.apply_lens_latency", viewTimeSec * 1000);
+        },
+    });
+});
+//# sourceMappingURL=reportLensWait.js.map

package/lib/metrics/reporters/reportLensWait.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportLensWait.js","sourceRoot":"","sources":["../../../src/metrics/reporters/reportLensWait.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAa,MAAM,yBAAyB,CAAC;AAEtE,OAAO,EAAsB,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AACtF,OAAO,EAAE,gCAAgC,EAA8B,MAAM,+BAA+B,CAAC;AAE7G,uCAAuC;AACvC,EAAE;AACF,gCAAgC;AAChC,8GAA8G;AAC9G,MAAM,oBAAoB,GAAG,GAAG,CAAC;AAcjC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CACpC,gBAAgB,EAChB,CAAC,gBAAgB,CAAC,KAAK,EAAE,yBAAyB,CAAC,KAAK,EAAE,gCAAgC,CAAC,KAAK,CAAU,EAC1G,CAAC,SAAoB,EAAE,kBAAsC,EAAE,QAAoC,EAAE,EAAE;IACnG,SAAS,CAAC,MAAM;SACX,IAAI,CACD,UAAU,CAAC,WAAW,CAAC,EACvB,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE;QACb,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,MAAM,kBAAkB,GAAG,SAAS,EAAE,CAAC;QACvC,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI;QACxB,0FAA0F;QAC1F,sEAAsE;QACtE,EAAE;QACF,8FAA8F;QAC9F,gGAAgG;QAChG,6FAA6F;QAC7F,kDAAkD;QAClD,EAAE;QACF,8FAA8F;QAC9F,kDAAkD;QAClD,UAAU,CAAC,qBAAqB,EAAE,WAAW,CAAC,EAC9C,IAAI,CAAC,CAAC,CAAC,EACP,GAAG,CAAC,GAAqB,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,kBAAkB,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CACnF,CAAC;IACN,CAAC,CAAC,CACL;SACA,SAAS,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,EAAE;YAC5B,IAAI,WAAW,GAAG,oBAAoB;gBAAE,OAAO;YAE/C,MAAM,QAAQ,GAAa;gBACvB,IAAI,EAAE,UAAU;gBAChB,MAAM;gBACN,WAAW;aACd,CAAC;YACF,kBAAkB,CAAC,aAAa,CAAC,IAAI,gBAAgB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC7E,QAAQ,CAAC,KAAK,CAAC,yBAAyB,EAAE,WAAW,GAAG,IAAI,CAAC,CAAC;QAClE,CAAC;KACJ,CAAC,CAAC;AACX,CAAC,CACJ,CAAC","sourcesContent":["import { forActions } from \"@snap/state-management\";\nimport { map, mergeMap, take } from \"rxjs\";\nimport { getTimeMs } from \"../../common/time\";\nimport { Injectable } from \"../../dependency-injection/Injectable\";\nimport { TypedCustomEvent } from \"../../events/TypedCustomEvent\";\nimport { lensStateFactory, LensState } from \"../../session/lensState\";\nimport { MakeTaggedBusinessEvent } from \"../businessEventsReporter\";\nimport { MetricsEventTarget, metricsEventTargetFactory } from \"../metricsEventTarget\";\nimport { operationalMetricReporterFactory, OperationalMetricsReporter } from \"../operationalMetricsReporter\";\n\n// We ignore short-duration lens waits.\n//\n// The value is documented here:\n// https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/edit#heading=h.q5liip76r9lt\nconst viewTimeThresholdSec = 0.1;\n\n/**\n * The LensWait metric measures the time spent downloading the lens content and required assets. It gives an indication\n * of the real UX impact of download latency. If lens content and assets are pre-loaded, the latency measured here\n * should decrease – we measure between the request to apply a lens and when the lens is ready to render.\n *\n * @category Lenses\n * @category Metrics\n */\n// This type corresponds to the internal CameraKitLensSpin event, described here:\n// https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY#heading=h.q5liip76r9lt\nexport type LensWait = MakeTaggedBusinessEvent<\"lensWait\">;\n\n/**\n * Each time a lens is applied, we measure the duration until the lens is fully loaded by LensCore. This\n * includes any time spent downloading the lens content and required assets from the lens manifest.\n *\n * The intention of this event is to measure the experienced UX latency between a user requesting a lens and\n * the lens rendering. Of course, the application may call `applyLens` at any time, and may hide/show the\n * rendered result at any time – but this should give us a good baseline for how much UX latency could be seen.\n *\n * @internal\n */\nexport const reportLensWait = Injectable(\n    \"reportLensWait\",\n    [lensStateFactory.token, metricsEventTargetFactory.token, operationalMetricReporterFactory.token] as const,\n    (lensState: LensState, metricsEventTarget: MetricsEventTarget, reporter: OperationalMetricsReporter) => {\n        lensState.events\n            .pipe(\n                forActions(\"applyLens\"),\n                mergeMap(([a]) => {\n                    const lensId = a.data.lens.id;\n                    const applyLensStartTime = getTimeMs();\n                    return lensState.events.pipe(\n                        // We'll measure the time until either the requested lens was rendered, or a new applyLens\n                        // request was made (in both cases, we're done waiting for this lens).\n                        //\n                        // This does have the side-effect that if a user rapidly switches between lenses, we'll record\n                        // many low-duration lensWait events that are measuring user behavior instead of system latency.\n                        // But this is a good trade-off so that we can capture those long-duration lensWaits that are\n                        // terminated by the user trying a different lens.\n                        //\n                        // (This effect can be mitigated by increasing the viewtimeThresholdSec to ignore low-duration\n                        // waits that are likely caused by user behavior).\n                        forActions(\"firstFrameProcessed\", \"applyLens\"),\n                        take(1),\n                        map((): [number, string] => [(getTimeMs() - applyLensStartTime) / 1000, lensId])\n                    );\n                })\n            )\n            .subscribe({\n                next: ([viewTimeSec, lensId]) => {\n                    if (viewTimeSec < viewTimeThresholdSec) return;\n\n                    const lensWait: LensWait = {\n                        name: \"lensWait\",\n                        lensId,\n                        viewTimeSec,\n                    };\n                    metricsEventTarget.dispatchEvent(new TypedCustomEvent(\"lensWait\", lensWait));\n                    reporter.timer(\"lens.apply_lens_latency\", viewTimeSec * 1000);\n                },\n            });\n    }\n);\n"]}

package/lib/metrics/reporters/reportSessionException.d.ts

@@ -0,0 +1,17 @@
+import { GlobalExceptionReporter } from "./reportGlobalException";
+/**
+ * Reports log entries to Blizzard during a CameraKit session.
+ *
+ * @internal
+ */
+export declare const reportSessionException: {
+    (args_0: GlobalExceptionReporter, args_1: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"applyLens", {
+        lens: import("../..").Lens;
+        launchParams?: import("../..").LensLaunchParams | undefined;
+    }> | import("@snap/state-management").Action<"downloadComplete", import("../..").Lens> | import("@snap/state-management").Action<"turnedOn", import("../..").Lens> | import("@snap/state-management").Action<"resourcesLoaded", import("../..").Lens> | import("@snap/state-management").Action<"firstFrameProcessed", import("../..").Lens> | import("@snap/state-management").Action<"applyLensComplete", import("../..").Lens> | import("@snap/state-management").Action<"applyLensFailed", {
+        error: import("../../session/lensState").LensErrors;
+        lens: import("../..").Lens;
+    }> | import("@snap/state-management").Action<"removeLens", undefined> | import("@snap/state-management").Action<"turnedOff", import("../..").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", import("../..").Lens> | import("@snap/state-management").State<"lensApplied", import("../..").Lens>>): void;
+    token: "reportSessionException";
+    dependencies: readonly ["reportGlobalException", "lensState"];
+};

package/lib/metrics/reporters/reportSessionException.js

@@ -0,0 +1,12 @@
+import { Injectable } from "../../dependency-injection/Injectable";
+import { lensStateFactory } from "../../session/lensState";
+import { reportGlobalException } from "./reportGlobalException";
+/**
+ * Reports log entries to Blizzard during a CameraKit session.
+ *
+ * @internal
+ */
+export const reportSessionException = Injectable("reportSessionException", [reportGlobalException.token, lensStateFactory.token], (globalExceptionReporter, lensState) => {
+    globalExceptionReporter.attachLensContext(lensState);
+});
+//# sourceMappingURL=reportSessionException.js.map

package/lib/metrics/reporters/reportSessionException.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportSessionException.js","sourceRoot":"","sources":["../../../src/metrics/reporters/reportSessionException.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAa,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAA2B,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEzF;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,UAAU,CAC5C,wBAAwB,EACxB,CAAC,qBAAqB,CAAC,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAU,EAC9D,CAAC,uBAAgD,EAAE,SAAoB,EAAE,EAAE;IACvE,uBAAuB,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;AACzD,CAAC,CACJ,CAAC","sourcesContent":["import { Injectable } from \"../../dependency-injection/Injectable\";\nimport { LensState, lensStateFactory } from \"../../session/lensState\";\nimport { GlobalExceptionReporter, reportGlobalException } from \"./reportGlobalException\";\n\n/**\n * Reports log entries to Blizzard during a CameraKit session.\n *\n * @internal\n */\nexport const reportSessionException = Injectable(\n    \"reportSessionException\",\n    [reportGlobalException.token, lensStateFactory.token] as const,\n    (globalExceptionReporter: GlobalExceptionReporter, lensState: LensState) => {\n        globalExceptionReporter.attachLensContext(lensState);\n    }\n);\n"]}

package/lib/metrics/reporters/reportUserSession.d.ts

@@ -0,0 +1,14 @@
+import { MakeTaggedBusinessEvent } from "../businessEventsReporter";
+import { MetricsEventTarget } from "../metricsEventTarget";
+/**
+ * The Session metric reports each user session.
+ */
+export declare type Session = MakeTaggedBusinessEvent<"session">;
+/**
+ * @internal
+ */
+export declare const reportUserSession: {
+    (args_0: MetricsEventTarget): Promise<void>;
+    token: "reportUserSession";
+    dependencies: readonly ["metricsEventTarget"];
+};