@snap/camera-kit 0.7.0

package/lib/metrics/reporters/reportUserSession.js

@@ -0,0 +1,67 @@
+import { __awaiter } from "tslib";
+import { Injectable } from "../../dependency-injection/Injectable";
+import { TypedCustomEvent } from "../../events/TypedCustomEvent";
+import { DailySessionBucket } from "../../generated-proto/blizzard/cameraKitEvents";
+import { IndexedDBPersistence } from "../../persistence/IndexedDBPersistence";
+import { metricsEventTargetFactory } from "../metricsEventTarget";
+/**
+ * @internal
+ */
+export const reportUserSession = Injectable("reportUserSession", [metricsEventTargetFactory.token], (metricsEventTarget) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    const userSessionKey = "userSessionInfo";
+    const db = new IndexedDBPersistence({ databaseName: "SessionHistory" });
+    // We standardize all user dates to PST as per our documentation:
+    // https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/
+    const date = new Date(new Date().toLocaleDateString("en-US", {
+        timeZone: "America/Los_Angeles",
+    }));
+    const currentMonth = date.getMonth();
+    const currentDay = date.getDate();
+    const currentYear = date.getFullYear();
+    const userSessionInfo = yield db.retrieve(userSessionKey);
+    const mostRecentSessionStartDate = userSessionInfo === null || userSessionInfo === void 0 ? void 0 : userSessionInfo.mostRecentSessionStartDate;
+    const dailySessionBucketMap = new Map([
+        [1, DailySessionBucket.ONE_SESSION],
+        [2, DailySessionBucket.TWO_SESSION],
+        [3, DailySessionBucket.THREE_SESSION],
+        [4, DailySessionBucket.FOUR_SESSION],
+        [5, DailySessionBucket.FIVE_SESSION],
+        [6, DailySessionBucket.SIX_SESSION],
+        [7, DailySessionBucket.SEVEN_SESSION],
+        [8, DailySessionBucket.EIGHT_SESSION],
+        [9, DailySessionBucket.NINE_SESSION],
+    ]);
+    let dailySessionBucket = (_a = userSessionInfo === null || userSessionInfo === void 0 ? void 0 : userSessionInfo.dailySessionBucket) !== null && _a !== void 0 ? _a : DailySessionBucket.NO_SESSION_BUCKET;
+    let isFirstWithinMonth = false;
+    if (mostRecentSessionStartDate &&
+        mostRecentSessionStartDate.getMonth() === currentMonth &&
+        mostRecentSessionStartDate.getDate() === currentDay &&
+        mostRecentSessionStartDate.getFullYear() === currentYear) {
+        dailySessionBucket =
+            (_b = dailySessionBucketMap.get(dailySessionBucket + 1)) !== null && _b !== void 0 ? _b : DailySessionBucket.TEN_OR_MORE_SESSION;
+        yield db.remove(userSessionKey);
+        yield db.store(userSessionKey, {
+            mostRecentSessionStartDate: date,
+            dailySessionBucket,
+        });
+    }
+    else {
+        isFirstWithinMonth = !mostRecentSessionStartDate || mostRecentSessionStartDate.getMonth() !== currentMonth;
+        yield db.remove(userSessionKey);
+        yield db.store(userSessionKey, {
+            mostRecentSessionStartDate: date,
+            dailySessionBucket: (dailySessionBucket = DailySessionBucket.ONE_SESSION),
+        });
+    }
+    const session = {
+        name: "session",
+        dailySessionBucket,
+        isFirstWithinMonth,
+        month: currentMonth + 1,
+        day: currentDay,
+        year: currentYear,
+    };
+    metricsEventTarget.dispatchEvent(new TypedCustomEvent("session", session));
+}));
+//# sourceMappingURL=reportUserSession.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reportUserSession.js","sourceRoot":"","sources":["../../../src/metrics/reporters/reportUserSession.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAE9E,OAAO,EAAsB,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAYtF;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CACvC,mBAAmB,EACnB,CAAC,yBAAyB,CAAC,KAAK,CAAU,EAC1C,CAAO,kBAAsC,EAAiB,EAAE;;IAC5D,MAAM,cAAc,GAAG,iBAAiB,CAAC;IACzC,MAAM,EAAE,GAAG,IAAI,oBAAoB,CAAkB,EAAE,YAAY,EAAE,gBAAgB,EAAE,CAAC,CAAC;IACzF,iEAAiE;IACjE,mFAAmF;IACnF,MAAM,IAAI,GAAG,IAAI,IAAI,CACjB,IAAI,IAAI,EAAE,CAAC,kBAAkB,CAAC,OAAO,EAAE;QACnC,QAAQ,EAAE,qBAAqB;KAClC,CAAC,CACL,CAAC;IACF,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IACrC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAClC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAEvC,MAAM,eAAe,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC1D,MAAM,0BAA0B,GAAG,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,0BAA0B,CAAC;IAC/E,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAA6B;QAC9D,CAAC,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC;QACnC,CAAC,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC;QACnC,CAAC,CAAC,EAAE,kBAAkB,CAAC,aAAa,CAAC;QACrC,CAAC,CAAC,EAAE,kBAAkB,CAAC,YAAY,CAAC;QACpC,CAAC,CAAC,EAAE,kBAAkB,CAAC,YAAY,CAAC;QACpC,CAAC,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC;QACnC,CAAC,CAAC,EAAE,kBAAkB,CAAC,aAAa,CAAC;QACrC,CAAC,CAAC,EAAE,kBAAkB,CAAC,aAAa,CAAC;QACrC,CAAC,CAAC,EAAE,kBAAkB,CAAC,YAAY,CAAC;KACvC,CAAC,CAAC;IACH,IAAI,kBAAkB,GAAG,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,kBAAkB,mCAAI,kBAAkB,CAAC,iBAAiB,CAAC;IACrG,IAAI,kBAAkB,GAAG,KAAK,CAAC;IAC/B,IACI,0BAA0B;QAC1B,0BAA0B,CAAC,QAAQ,EAAE,KAAK,YAAY;QACtD,0BAA0B,CAAC,OAAO,EAAE,KAAK,UAAU;QACnD,0BAA0B,CAAC,WAAW,EAAE,KAAK,WAAW,EAC1D;QACE,kBAAkB;YACd,MAAA,qBAAqB,CAAC,GAAG,CAAC,kBAAkB,GAAG,CAAC,CAAC,mCAAI,kBAAkB,CAAC,mBAAmB,CAAC;QAChG,MAAM,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAChC,MAAM,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE;YAC3B,0BAA0B,EAAE,IAAI;YAChC,kBAAkB;SACrB,CAAC,CAAC;KACN;SAAM;QACH,kBAAkB,GAAG,CAAC,0BAA0B,IAAI,0BAA0B,CAAC,QAAQ,EAAE,KAAK,YAAY,CAAC;QAC3G,MAAM,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAChC,MAAM,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE;YAC3B,0BAA0B,EAAE,IAAI;YAChC,kBAAkB,EAAE,CAAC,kBAAkB,GAAG,kBAAkB,CAAC,WAAW,CAAC;SAC5E,CAAC,CAAC;KACN;IACD,MAAM,OAAO,GAAY;QACrB,IAAI,EAAE,SAAS;QACf,kBAAkB;QAClB,kBAAkB;QAClB,KAAK,EAAE,YAAY,GAAG,CAAC;QACvB,GAAG,EAAE,UAAU;QACf,IAAI,EAAE,WAAW;KACpB,CAAC;IACF,kBAAkB,CAAC,aAAa,CAAC,IAAI,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/E,CAAC,CAAA,CACJ,CAAC","sourcesContent":["import { Injectable } from \"../../dependency-injection/Injectable\";\nimport { TypedCustomEvent } from \"../../events/TypedCustomEvent\";\nimport { DailySessionBucket } from \"../../generated-proto/blizzard/cameraKitEvents\";\nimport { IndexedDBPersistence } from \"../../persistence/IndexedDBPersistence\";\nimport { MakeTaggedBusinessEvent } from \"../businessEventsReporter\";\nimport { MetricsEventTarget, metricsEventTargetFactory } from \"../metricsEventTarget\";\n\ninterface UserSessionInfo {\n    mostRecentSessionStartDate: Date;\n    dailySessionBucket: DailySessionBucket;\n}\n\n/**\n * The Session metric reports each user session.\n */\nexport type Session = MakeTaggedBusinessEvent<\"session\">;\n\n/**\n * @internal\n */\nexport const reportUserSession = Injectable(\n    \"reportUserSession\",\n    [metricsEventTargetFactory.token] as const,\n    async (metricsEventTarget: MetricsEventTarget): Promise<void> => {\n        const userSessionKey = \"userSessionInfo\";\n        const db = new IndexedDBPersistence<UserSessionInfo>({ databaseName: \"SessionHistory\" });\n        // We standardize all user dates to PST as per our documentation:\n        // https://docs.google.com/document/d/1-kSzFWCWw9Qo3D08FR1_cqeHTsUtk9p3p3uOptzWDTY/\n        const date = new Date(\n            new Date().toLocaleDateString(\"en-US\", {\n                timeZone: \"America/Los_Angeles\",\n            })\n        );\n        const currentMonth = date.getMonth();\n        const currentDay = date.getDate();\n        const currentYear = date.getFullYear();\n\n        const userSessionInfo = await db.retrieve(userSessionKey);\n        const mostRecentSessionStartDate = userSessionInfo?.mostRecentSessionStartDate;\n        const dailySessionBucketMap = new Map<number, DailySessionBucket>([\n            [1, DailySessionBucket.ONE_SESSION],\n            [2, DailySessionBucket.TWO_SESSION],\n            [3, DailySessionBucket.THREE_SESSION],\n            [4, DailySessionBucket.FOUR_SESSION],\n            [5, DailySessionBucket.FIVE_SESSION],\n            [6, DailySessionBucket.SIX_SESSION],\n            [7, DailySessionBucket.SEVEN_SESSION],\n            [8, DailySessionBucket.EIGHT_SESSION],\n            [9, DailySessionBucket.NINE_SESSION],\n        ]);\n        let dailySessionBucket = userSessionInfo?.dailySessionBucket ?? DailySessionBucket.NO_SESSION_BUCKET;\n        let isFirstWithinMonth = false;\n        if (\n            mostRecentSessionStartDate &&\n            mostRecentSessionStartDate.getMonth() === currentMonth &&\n            mostRecentSessionStartDate.getDate() === currentDay &&\n            mostRecentSessionStartDate.getFullYear() === currentYear\n        ) {\n            dailySessionBucket =\n                dailySessionBucketMap.get(dailySessionBucket + 1) ?? DailySessionBucket.TEN_OR_MORE_SESSION;\n            await db.remove(userSessionKey);\n            await db.store(userSessionKey, {\n                mostRecentSessionStartDate: date,\n                dailySessionBucket,\n            });\n        } else {\n            isFirstWithinMonth = !mostRecentSessionStartDate || mostRecentSessionStartDate.getMonth() !== currentMonth;\n            await db.remove(userSessionKey);\n            await db.store(userSessionKey, {\n                mostRecentSessionStartDate: date,\n                dailySessionBucket: (dailySessionBucket = DailySessionBucket.ONE_SESSION),\n            });\n        }\n        const session: Session = {\n            name: \"session\",\n            dailySessionBucket,\n            isFirstWithinMonth,\n            month: currentMonth + 1, // Date.getMonth() is zero-based so we need to add 1\n            day: currentDay,\n            year: currentYear,\n        };\n        metricsEventTarget.dispatchEvent(new TypedCustomEvent(\"session\", session));\n    }\n);\n"]}

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

@@ -0,0 +1,44 @@
+import { PartialContainer } from "../../dependency-injection/PartialContainer";
+/**
+ * These metrics reporters must be run once in the top-level DI container. They only depend on globally-available
+ * services.
+ *
+ * The businessEventsReporter is special, it doesn't create any of its own metrics, it simply listens to the global
+ * metricsEventTarget and reports metrics emitted there to our backend.
+ */
+export declare const reportGloballyScopedMetrics: PartialContainer<{
+    reportBenchmarks: Promise<void>;
+    reportLensAndAssetDownload: void;
+    reportHttpMetrics: void;
+}, {
+    configuration: import("../..").CameraKitConfiguration;
+    metricsEventTarget: import("../metricsEventTarget").MetricsEventTarget;
+    operationalMetricsReporter: import("../operationalMetricsReporter").OperationalMetricsReporter;
+}>;
+/**
+ * These metrics reporters must be run once for each CameraKitSession DI container created. They may depend on services
+ * which are only available at the session scope (e.g. the CameraKitSession itself).
+ */
+export declare const reportSessionScopedMetrics: PartialContainer<{
+    reportLensValidationFailed: void;
+    reportLensView: void;
+    reportLensWait: void;
+    reportUserSession: Promise<void>;
+    reportLegalState: void;
+    reportSessionException: void;
+}, {
+    configuration: import("../..").CameraKitConfiguration;
+    metricsEventTarget: import("../metricsEventTarget").MetricsEventTarget;
+    legalState: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"requestLegalPrompt", undefined> | import("@snap/state-management").Action<"accept", string> | import("@snap/state-management").Action<"reject", string>, import("@snap/state-management").State<"unknown", undefined> | import("@snap/state-management").State<"accepted", undefined> | import("@snap/state-management").State<"rejected", undefined>>;
+    lensState: 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>>;
+    sessionState: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"suspend", import("../..").CameraKitSession> | import("@snap/state-management").Action<"resume", import("../..").CameraKitSession>, import("@snap/state-management").State<"inactive", undefined> | import("@snap/state-management").State<"active", import("../..").CameraKitSession>>;
+    CameraKitSession: import("../..").CameraKitSession;
+    operationalMetricsReporter: import("../operationalMetricsReporter").OperationalMetricsReporter;
+    reportGlobalException: import("./reportGlobalException").GlobalExceptionReporter;
+}>;

package/lib/metrics/reporters/reporters.js

@@ -0,0 +1,33 @@
+import { PartialContainer } from "../../dependency-injection/PartialContainer";
+import { reportSessionException } from "./reportSessionException";
+import { reportBenchmarks } from "./reportBenchmarks";
+import { reportHttpMetrics } from "./reportHttpMetrics";
+import { reportLegalState } from "./reportLegalState";
+import { reportLensAndAssetDownload } from "./reportLensAndAssetDownload";
+import { reportLensValidationFailed } from "./reportLensValidationFailed";
+import { reportLensView } from "./reportLensView";
+import { reportLensWait } from "./reportLensWait";
+import { reportUserSession } from "./reportUserSession";
+/**
+ * These metrics reporters must be run once in the top-level DI container. They only depend on globally-available
+ * services.
+ *
+ * The businessEventsReporter is special, it doesn't create any of its own metrics, it simply listens to the global
+ * metricsEventTarget and reports metrics emitted there to our backend.
+ */
+export const reportGloballyScopedMetrics = new PartialContainer({})
+    .provides(reportHttpMetrics)
+    .provides(reportBenchmarks)
+    .provides(reportLensAndAssetDownload);
+/**
+ * These metrics reporters must be run once for each CameraKitSession DI container created. They may depend on services
+ * which are only available at the session scope (e.g. the CameraKitSession itself).
+ */
+export const reportSessionScopedMetrics = new PartialContainer({})
+    .provides(reportUserSession)
+    .provides(reportLensView)
+    .provides(reportLensWait)
+    .provides(reportSessionException)
+    .provides(reportLensValidationFailed)
+    .provides(reportLegalState);
+//# sourceMappingURL=reporters.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reporters.js","sourceRoot":"","sources":["../../../src/metrics/reporters/reporters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAC;AAC/E,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,IAAI,gBAAgB,CAAC,EAAE,CAAC;KAC9D,QAAQ,CAAC,iBAAiB,CAAC;KAC3B,QAAQ,CAAC,gBAAgB,CAAC;KAC1B,QAAQ,CAAC,0BAA0B,CAAC,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,IAAI,gBAAgB,CAAC,EAAE,CAAC;KAC7D,QAAQ,CAAC,iBAAiB,CAAC;KAC3B,QAAQ,CAAC,cAAc,CAAC;KACxB,QAAQ,CAAC,cAAc,CAAC;KACxB,QAAQ,CAAC,sBAAsB,CAAC;KAChC,QAAQ,CAAC,0BAA0B,CAAC;KACpC,QAAQ,CAAC,gBAAgB,CAAC,CAAC","sourcesContent":["import { PartialContainer } from \"../../dependency-injection/PartialContainer\";\nimport { reportSessionException } from \"./reportSessionException\";\nimport { reportBenchmarks } from \"./reportBenchmarks\";\nimport { reportHttpMetrics } from \"./reportHttpMetrics\";\nimport { reportLegalState } from \"./reportLegalState\";\nimport { reportLensAndAssetDownload } from \"./reportLensAndAssetDownload\";\nimport { reportLensValidationFailed } from \"./reportLensValidationFailed\";\nimport { reportLensView } from \"./reportLensView\";\nimport { reportLensWait } from \"./reportLensWait\";\nimport { reportUserSession } from \"./reportUserSession\";\n\n/**\n * These metrics reporters must be run once in the top-level DI container. They only depend on globally-available\n * services.\n *\n * The businessEventsReporter is special, it doesn't create any of its own metrics, it simply listens to the global\n * metricsEventTarget and reports metrics emitted there to our backend.\n */\nexport const reportGloballyScopedMetrics = new PartialContainer({})\n    .provides(reportHttpMetrics)\n    .provides(reportBenchmarks)\n    .provides(reportLensAndAssetDownload);\n\n/**\n * These metrics reporters must be run once for each CameraKitSession DI container created. They may depend on services\n * which are only available at the session scope (e.g. the CameraKitSession itself).\n */\nexport const reportSessionScopedMetrics = new PartialContainer({})\n    .provides(reportUserSession)\n    .provides(reportLensView)\n    .provides(reportLensWait)\n    .provides(reportSessionException)\n    .provides(reportLensValidationFailed)\n    .provides(reportLegalState);\n"]}

package/lib/namedErrors.d.ts

@@ -0,0 +1,107 @@
+/**
+ * Helper type to extract type generic parameter.
+ */
+declare type ExtractName<P> = P extends NamedError<infer T> ? T : never;
+/**
+ * All errors are expected to have "Error" suffix.
+ */
+declare type ErrorName = `${string}Error`;
+declare type NamedError<Name extends ErrorName> = Error & {
+    name: Name;
+};
+/**
+ * Creates error factory that ensures Error.prototype.name field value.
+ *
+ * NOTE: exported only for unit tests.
+ *
+ * @param name Error name.
+ * @returns Error factory function.
+ * @internal
+ */
+export declare function namedError<TError extends NamedError<TName> = never, TName extends ErrorName = ExtractName<TError>>(name: TName): (message: string, cause?: unknown) => TError;
+export declare type LegalError = NamedError<"LegalError">;
+/** @internal */
+export declare const legalError: (message: string, cause?: unknown) => LegalError;
+export declare type LensContentValidationError = NamedError<"LensContentValidationError">;
+/** @internal */
+export declare const lensContentValidationError: (message: string, cause?: unknown) => LensContentValidationError;
+export declare type LensError = NamedError<"LensError">;
+/** @internal */
+export declare const lensError: (message: string, cause?: unknown) => LensError;
+export declare type CameraKitSourceError = NamedError<"CameraKitSourceError">;
+/** @internal */
+export declare const cameraKitSourceError: (message: string, cause?: unknown) => CameraKitSourceError;
+/**
+ * The error triggered when a lens prompts the user to select an image, but the image fails to be successfully delivered
+ * to the lens.
+ */
+export declare type LensImagePickerError = NamedError<"LensImagePickerError">;
+/** @internal */
+export declare const lensImagePickerError: (message: string, cause?: unknown) => LensImagePickerError;
+export declare type CacheKeyNotFoundError = NamedError<"CacheKeyNotFoundError">;
+/** @internal */
+export declare const cacheKeyNotFoundError: (message: string, cause?: unknown) => CacheKeyNotFoundError;
+/**
+ * Thrown by {@link bootstrapCameraKit} if provided configuration is invalid.
+ *
+ * @category Bootstrapping and Configuration
+ */
+export declare type ConfigurationError = NamedError<"ConfigurationError">;
+/** @internal */
+export declare const configurationError: (message: string, cause?: unknown) => ConfigurationError;
+export declare type WebGLError = NamedError<"WebGLError">;
+/** @internal */
+export declare const webGLError: (message: string, cause?: unknown) => WebGLError;
+export declare type BenchmarkError = NamedError<"BenchmarkError">;
+/** @internal */
+export declare const benchmarkError: (message: string, cause?: unknown) => BenchmarkError;
+/**
+ * Thrown by {@link bootstrapCameraKit} when the current platform is not supported by CameraKit.
+ *
+ * This can happen if the browser doesn't support a required feature (e.g. WebGL).
+ *
+ * @category Bootstrapping and Configuration
+ */
+export declare type PlatformNotSupportedError = NamedError<"PlatformNotSupportedError">;
+/** @internal */
+export declare const platformNotSupportedError: (message: string, cause?: unknown) => PlatformNotSupportedError;
+/**
+ * This error occurs if a Lens is unable to continue rendering.
+ *
+ * If this error occurs, Camera Kit automatically removes the Lens from the session.
+ * It's always a good idea to handle this error and update the user experience accordingly.
+ * For example, you could remove the faulty Lens from your Lens selection UI.
+ *
+ * ```ts
+ * cameraKitSession.events.addEventListener('error', ({ detail }) => {
+ *   if (detail.error.name === 'LensExecutionError') {
+ *     console.log(`Lens ${detail.lens.name} encountered an error and was removed. Please pick a different lens.`)
+ *   }
+ * })
+ * ```
+ */
+export declare type LensExecutionError = NamedError<"LensExecutionError">;
+/** @internal */
+export declare const lensExecutionError: (message: string, cause?: unknown) => LensExecutionError;
+/**
+ * Error thrown when LensCore asked to store lens data, but CameraKit failed storing that.
+ */
+export declare type PersistentStoreError = NamedError<"PersistentStoreError">;
+/** @internal */
+export declare const persistentStoreError: (message: string, cause?: unknown) => PersistentStoreError;
+/**
+ * Error thrown when LensCore asked to provide an asset, but CameraKit failed providing that.
+ */
+export declare type LensAssetError = NamedError<"LensAssetError">;
+/** @internal */
+export declare const lensAssetError: (message: string, cause?: unknown) => LensAssetError;
+/**
+ * Thrown by {@link bootstrapCameraKit} if an error occurs during SDK initializion or while downloading the render
+ * engine WebAssembly.
+ *
+ * @category Bootstrapping and Configuration
+ */
+export declare type BootstrapError = NamedError<"BootstrapError">;
+/** @internal */
+export declare const bootstrapError: (message: string, cause?: unknown) => BootstrapError;
+export {};

package/lib/namedErrors.js

@@ -0,0 +1,56 @@
+// NOTE: All errors thrown in the CameraKit package have to be defined here.
+// Error types are not infered from error factories for API doc purposes and consistency.
+/**
+ * Removes the top trace line from the stack.
+ */
+function cleanErrorStack(stack) {
+    const [first, _, ...rest] = stack.split("\n");
+    return [first, ...rest].join("\n");
+}
+/**
+ * Creates error factory that ensures Error.prototype.name field value.
+ *
+ * NOTE: exported only for unit tests.
+ *
+ * @param name Error name.
+ * @returns Error factory function.
+ * @internal
+ */
+export function namedError(name) {
+    return (message, cause) => {
+        const error = new Error(message, { cause });
+        error.name = name;
+        error.stack = error.stack && cleanErrorStack(error.stack);
+        // Safety: we set name above and therefore sure the type of error is correct
+        return error;
+    };
+}
+/** @internal */
+export const legalError = namedError("LegalError");
+/** @internal */
+export const lensContentValidationError = namedError("LensContentValidationError");
+/** @internal */
+export const lensError = namedError("LensError");
+/** @internal */
+export const cameraKitSourceError = namedError("CameraKitSourceError");
+/** @internal */
+export const lensImagePickerError = namedError("LensImagePickerError");
+/** @internal */
+export const cacheKeyNotFoundError = namedError("CacheKeyNotFoundError");
+/** @internal */
+export const configurationError = namedError("ConfigurationError");
+/** @internal */
+export const webGLError = namedError("WebGLError");
+/** @internal */
+export const benchmarkError = namedError("BenchmarkError");
+/** @internal */
+export const platformNotSupportedError = namedError("PlatformNotSupportedError");
+/** @internal */
+export const lensExecutionError = namedError("LensExecutionError");
+/** @internal */
+export const persistentStoreError = namedError("PersistentStoreError");
+/** @internal */
+export const lensAssetError = namedError("LensAssetError");
+/** @internal */
+export const bootstrapError = namedError("BootstrapError");
+//# sourceMappingURL=namedErrors.js.map

package/lib/namedErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"namedErrors.js","sourceRoot":"","sources":["../src/namedErrors.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,yFAAyF;AAczF;;GAEG;AACH,SAAS,eAAe,CAAC,KAAa;IAClC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC9C,OAAO,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CAKxB,IAAW;IACT,OAAO,CAAC,OAAe,EAAE,KAAe,EAAU,EAAE;QAChD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5C,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1D,4EAA4E;QAC5E,OAAO,KAAe,CAAC;IAC3B,CAAC,CAAC;AACN,CAAC;AAGD,gBAAgB;AAChB,MAAM,CAAC,MAAM,UAAU,GAAG,UAAU,CAAa,YAAY,CAAC,CAAC;AAG/D,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAAG,UAAU,CAA6B,4BAA4B,CAAC,CAAC;AAG/G,gBAAgB;AAChB,MAAM,CAAC,MAAM,SAAS,GAAG,UAAU,CAAY,WAAW,CAAC,CAAC;AAG5D,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAuB,sBAAsB,CAAC,CAAC;AAO7F,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAuB,sBAAsB,CAAC,CAAC;AAG7F,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAG,UAAU,CAAwB,uBAAuB,CAAC,CAAC;AAQhG,gBAAgB;AAChB,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAqB,oBAAoB,CAAC,CAAC;AAGvF,gBAAgB;AAChB,MAAM,CAAC,MAAM,UAAU,GAAG,UAAU,CAAa,YAAY,CAAC,CAAC;AAG/D,gBAAgB;AAChB,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAiB,gBAAgB,CAAC,CAAC;AAU3E,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAAG,UAAU,CAA4B,2BAA2B,CAAC,CAAC;AAkB5G,gBAAgB;AAChB,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAqB,oBAAoB,CAAC,CAAC;AAMvF,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAuB,sBAAsB,CAAC,CAAC;AAM7F,gBAAgB;AAChB,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAiB,gBAAgB,CAAC,CAAC;AAS3E,gBAAgB;AAChB,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAiB,gBAAgB,CAAC,CAAC","sourcesContent":["// NOTE: All errors thrown in the CameraKit package have to be defined here.\n// Error types are not infered from error factories for API doc purposes and consistency.\n\n/**\n * Helper type to extract type generic parameter.\n */\ntype ExtractName<P> = P extends NamedError<infer T> ? T : never;\n\n/**\n * All errors are expected to have \"Error\" suffix.\n */\ntype ErrorName = `${string}Error`;\n\ntype NamedError<Name extends ErrorName> = Error & { name: Name };\n\n/**\n * Removes the top trace line from the stack.\n */\nfunction cleanErrorStack(stack: string): string {\n    const [first, _, ...rest] = stack.split(\"\\n\");\n    return [first, ...rest].join(\"\\n\");\n}\n\n/**\n * Creates error factory that ensures Error.prototype.name field value.\n *\n * NOTE: exported only for unit tests.\n *\n * @param name Error name.\n * @returns Error factory function.\n * @internal\n */\nexport function namedError<\n    // default to never to ensure the type argument is specified\n    TError extends NamedError<TName> = never,\n    // default to provided error name to make this type argument optional to reduce boilerplate\n    TName extends ErrorName = ExtractName<TError>\n>(name: TName) {\n    return (message: string, cause?: unknown): TError => {\n        const error = new Error(message, { cause });\n        error.name = name;\n        error.stack = error.stack && cleanErrorStack(error.stack);\n        // Safety: we set name above and therefore sure the type of error is correct\n        return error as TError;\n    };\n}\n\nexport type LegalError = NamedError<\"LegalError\">;\n/** @internal */\nexport const legalError = namedError<LegalError>(\"LegalError\");\n\nexport type LensContentValidationError = NamedError<\"LensContentValidationError\">;\n/** @internal */\nexport const lensContentValidationError = namedError<LensContentValidationError>(\"LensContentValidationError\");\n\nexport type LensError = NamedError<\"LensError\">;\n/** @internal */\nexport const lensError = namedError<LensError>(\"LensError\");\n\nexport type CameraKitSourceError = NamedError<\"CameraKitSourceError\">;\n/** @internal */\nexport const cameraKitSourceError = namedError<CameraKitSourceError>(\"CameraKitSourceError\");\n\n/**\n * The error triggered when a lens prompts the user to select an image, but the image fails to be successfully delivered\n * to the lens.\n */\nexport type LensImagePickerError = NamedError<\"LensImagePickerError\">;\n/** @internal */\nexport const lensImagePickerError = namedError<LensImagePickerError>(\"LensImagePickerError\");\n\nexport type CacheKeyNotFoundError = NamedError<\"CacheKeyNotFoundError\">;\n/** @internal */\nexport const cacheKeyNotFoundError = namedError<CacheKeyNotFoundError>(\"CacheKeyNotFoundError\");\n\n/**\n * Thrown by {@link bootstrapCameraKit} if provided configuration is invalid.\n *\n * @category Bootstrapping and Configuration\n */\nexport type ConfigurationError = NamedError<\"ConfigurationError\">;\n/** @internal */\nexport const configurationError = namedError<ConfigurationError>(\"ConfigurationError\");\n\nexport type WebGLError = NamedError<\"WebGLError\">;\n/** @internal */\nexport const webGLError = namedError<WebGLError>(\"WebGLError\");\n\nexport type BenchmarkError = NamedError<\"BenchmarkError\">;\n/** @internal */\nexport const benchmarkError = namedError<BenchmarkError>(\"BenchmarkError\");\n\n/**\n * Thrown by {@link bootstrapCameraKit} when the current platform is not supported by CameraKit.\n *\n * This can happen if the browser doesn't support a required feature (e.g. WebGL).\n *\n * @category Bootstrapping and Configuration\n */\nexport type PlatformNotSupportedError = NamedError<\"PlatformNotSupportedError\">;\n/** @internal */\nexport const platformNotSupportedError = namedError<PlatformNotSupportedError>(\"PlatformNotSupportedError\");\n\n/**\n * This error occurs if a Lens is unable to continue rendering.\n *\n * If this error occurs, Camera Kit automatically removes the Lens from the session.\n * It's always a good idea to handle this error and update the user experience accordingly.\n * For example, you could remove the faulty Lens from your Lens selection UI.\n *\n * ```ts\n * cameraKitSession.events.addEventListener('error', ({ detail }) => {\n *   if (detail.error.name === 'LensExecutionError') {\n *     console.log(`Lens ${detail.lens.name} encountered an error and was removed. Please pick a different lens.`)\n *   }\n * })\n * ```\n */\nexport type LensExecutionError = NamedError<\"LensExecutionError\">;\n/** @internal */\nexport const lensExecutionError = namedError<LensExecutionError>(\"LensExecutionError\");\n\n/**\n * Error thrown when LensCore asked to store lens data, but CameraKit failed storing that.\n */\nexport type PersistentStoreError = NamedError<\"PersistentStoreError\">;\n/** @internal */\nexport const persistentStoreError = namedError<PersistentStoreError>(\"PersistentStoreError\");\n\n/**\n * Error thrown when LensCore asked to provide an asset, but CameraKit failed providing that.\n */\nexport type LensAssetError = NamedError<\"LensAssetError\">;\n/** @internal */\nexport const lensAssetError = namedError<LensAssetError>(\"LensAssetError\");\n\n/**\n * Thrown by {@link bootstrapCameraKit} if an error occurs during SDK initializion or while downloading the render\n * engine WebAssembly.\n *\n * @category Bootstrapping and Configuration\n */\nexport type BootstrapError = NamedError<\"BootstrapError\">;\n/** @internal */\nexport const bootstrapError = namedError<BootstrapError>(\"BootstrapError\");\n"]}

package/lib/persistence/ExpiringPersistence.d.ts

@@ -0,0 +1,20 @@
+import { Persistence, ValidKey } from "./Persistence";
+/**
+ * Create a Persistence that will remove entries after they expire.
+ *
+ * An expiration function must be provided, which is called each time a value is stored. It must return the expiration
+ * time for that value, given in seconds from now. For example, to expire a value 24 hours after it is stored, the
+ * expiration function should return 86400 (the number of seconds in 24 hours).
+ */
+export declare class ExpiringPersistence<T> implements Persistence<T> {
+    private readonly expiration;
+    private readonly persistence;
+    constructor(expiration: (value: T) => number, persistence: Persistence<[number, T]>);
+    get size(): number;
+    retrieve(key: ValidKey): Promise<T | undefined>;
+    retrieveAll(): Promise<T[]>;
+    remove(key: ValidKey): Promise<void>;
+    removeAll(): Promise<T[]>;
+    store(value: T): Promise<ValidKey>;
+    store(key: ValidKey, value: T): Promise<ValidKey>;
+}

package/lib/persistence/ExpiringPersistence.js

@@ -0,0 +1,58 @@
+import { __awaiter } from "tslib";
+import { ensureError } from "../common/errorHelpers";
+import { getLogger } from "../logger/logger";
+const logger = getLogger("ExpiringPersistence");
+/**
+ * Create a Persistence that will remove entries after they expire.
+ *
+ * An expiration function must be provided, which is called each time a value is stored. It must return the expiration
+ * time for that value, given in seconds from now. For example, to expire a value 24 hours after it is stored, the
+ * expiration function should return 86400 (the number of seconds in 24 hours).
+ */
+export class ExpiringPersistence {
+    constructor(expiration, persistence) {
+        this.expiration = expiration;
+        this.persistence = persistence;
+    }
+    get size() {
+        return this.persistence.size;
+    }
+    retrieve(key) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const [expiry, value] = (_a = (yield this.persistence.retrieve(key))) !== null && _a !== void 0 ? _a : [];
+            if (value === undefined || expiry === undefined)
+                return undefined;
+            if (Date.now() > expiry) {
+                yield this.persistence.remove(key).catch((error) => {
+                    logger.warn(`Key ${key} is expired, but removing it from persistence failed.`, ensureError(error));
+                });
+                return undefined;
+            }
+            return value;
+        });
+    }
+    retrieveAll() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const now = Date.now();
+            return (yield this.persistence.retrieveAll()).filter(([expiry]) => expiry >= now).map(([, v]) => v);
+        });
+    }
+    remove(key) {
+        return this.persistence.remove(key);
+    }
+    removeAll() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = yield this.persistence.removeAll();
+            return results.map(([, v]) => v);
+        });
+    }
+    store(keyOrValue, maybeValue) {
+        const [key, value] = maybeValue === undefined ? [undefined, keyOrValue] : [keyOrValue, maybeValue];
+        const expiry = Date.now() + this.expiration(value) * 1000;
+        return key === undefined
+            ? this.persistence.store([expiry, value])
+            : this.persistence.store(key, [expiry, value]);
+    }
+}
+//# sourceMappingURL=ExpiringPersistence.js.map

package/lib/persistence/ExpiringPersistence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExpiringPersistence.js","sourceRoot":"","sources":["../../src/persistence/ExpiringPersistence.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAG7C,MAAM,MAAM,GAAG,SAAS,CAAC,qBAAqB,CAAC,CAAC;AAEhD;;;;;;GAMG;AACH,MAAM,OAAO,mBAAmB;IAC5B,YACqB,UAAgC,EAChC,WAAqC;QADrC,eAAU,GAAV,UAAU,CAAsB;QAChC,gBAAW,GAAX,WAAW,CAA0B;IACvD,CAAC;IAEJ,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACjC,CAAC;IAEK,QAAQ,CAAC,GAAa;;;YACxB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,MAAA,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,mCAAI,EAAE,CAAC;YACrE,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,SAAS,CAAC;YAElE,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,EAAE;gBACrB,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC/C,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG,uDAAuD,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;gBACvG,CAAC,CAAC,CAAC;gBACH,OAAO,SAAS,CAAC;aACpB;YACD,OAAO,KAAK,CAAC;;KAChB;IAEK,WAAW;;YACb,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,OAAO,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QACxG,CAAC;KAAA;IAED,MAAM,CAAC,GAAa;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACxC,CAAC;IAEK,SAAS;;YACX,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;YACnD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC;KAAA;IAID,KAAK,CAAC,UAAwB,EAAE,UAAc;QAC1C,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GACd,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,UAAe,CAAC,CAAC,CAAC,CAAC,CAAC,UAAsB,EAAE,UAAU,CAAC,CAAC;QACnG,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QAC1D,OAAO,GAAG,KAAK,SAAS;YACpB,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YACzC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IACvD,CAAC;CACJ","sourcesContent":["import { ensureError } from \"../common/errorHelpers\";\nimport { getLogger } from \"../logger/logger\";\nimport { Persistence, ValidKey } from \"./Persistence\";\n\nconst logger = getLogger(\"ExpiringPersistence\");\n\n/**\n * Create a Persistence that will remove entries after they expire.\n *\n * An expiration function must be provided, which is called each time a value is stored. It must return the expiration\n * time for that value, given in seconds from now. For example, to expire a value 24 hours after it is stored, the\n * expiration function should return 86400 (the number of seconds in 24 hours).\n */\nexport class ExpiringPersistence<T> implements Persistence<T> {\n    constructor(\n        private readonly expiration: (value: T) => number,\n        private readonly persistence: Persistence<[number, T]>\n    ) {}\n\n    get size(): number {\n        return this.persistence.size;\n    }\n\n    async retrieve(key: ValidKey): Promise<T | undefined> {\n        const [expiry, value] = (await this.persistence.retrieve(key)) ?? [];\n        if (value === undefined || expiry === undefined) return undefined;\n\n        if (Date.now() > expiry) {\n            await this.persistence.remove(key).catch((error) => {\n                logger.warn(`Key ${key} is expired, but removing it from persistence failed.`, ensureError(error));\n            });\n            return undefined;\n        }\n        return value;\n    }\n\n    async retrieveAll(): Promise<T[]> {\n        const now = Date.now();\n        return (await this.persistence.retrieveAll()).filter(([expiry]) => expiry >= now).map(([, v]) => v);\n    }\n\n    remove(key: ValidKey): Promise<void> {\n        return this.persistence.remove(key);\n    }\n\n    async removeAll(): Promise<T[]> {\n        const results = await this.persistence.removeAll();\n        return results.map(([, v]) => v);\n    }\n\n    store(value: T): Promise<ValidKey>;\n    store(key: ValidKey, value: T): Promise<ValidKey>;\n    store(keyOrValue: T | ValidKey, maybeValue?: T): Promise<ValidKey> {\n        const [key, value] =\n            maybeValue === undefined ? [undefined, keyOrValue as T] : [keyOrValue as ValidKey, maybeValue];\n        const expiry = Date.now() + this.expiration(value) * 1000;\n        return key === undefined\n            ? this.persistence.store([expiry, value])\n            : this.persistence.store(key, [expiry, value]);\n    }\n}\n"]}

package/lib/persistence/IndexedDBPersistence.d.ts

@@ -0,0 +1,47 @@
+import { Persistence, ValidKey } from "./Persistence";
+/**
+ * Specify a database name for this {@link IndexedDBPersistence} instance to use.
+ * This will be prefixed by `Snap.CameraKit`.
+ *
+ * A databaseVersion and objectStore may also be specified. Keep in mind the following limitations:
+ * - IndexedDBPersistence currently does nothing to migrate data between versions.
+ * - If two different IndexedDBPersistence instances use the same databaseName, they must also use the same objectStore.
+ * Otherwise a race condition will occur which prevents the creation of all but one objectStore per database.
+ */
+export interface IndexedDBPersistenceOptions {
+    databaseName: string;
+    databaseVersion?: number;
+    objectStore?: string;
+}
+/**
+ * A simple key/value persistence using an IndexedDB storage backend.
+ *
+ * See [Using IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Using_IndexedDB) for an
+ * introduction to how IndexedDB works, its APIs, and how to use it.
+ *
+ * Note: Currently there is no support for database upgrades. Each instance of this class uses a single IDBObjectStore
+ * object set at instantiation time, and there are no hooks for performing migrations between versions. This may be
+ * added in the future if such functionality is needed.
+ */
+export declare class IndexedDBPersistence<T> implements Persistence<T> {
+    size: number;
+    private db;
+    private readonly databaseName;
+    private readonly databaseVersion?;
+    private readonly objectStore;
+    /**
+     * Construct an {@link IndexedDBPersistence} instance corresponding to a given IndexedDB database version.
+     *
+     * Throws `ConstraintError` if the version number is invalid (e.g. NaN, or less than 1).
+     */
+    constructor(options: IndexedDBPersistenceOptions);
+    retrieve(key: ValidKey): Promise<T | undefined>;
+    retrieveAll(): Promise<T[]>;
+    remove(key: ValidKey): Promise<void>;
+    removeAll(): Promise<T[]>;
+    store(value: T): Promise<ValidKey>;
+    store(key: ValidKey, value: T): Promise<ValidKey>;
+    private openDatabase;
+    private simpleTransaction;
+    private transaction;
+}