@snap/camera-kit 0.7.0

package/lib/handlers/responseCachingHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"responseCachingHandler.js","sourceRoot":"","sources":["../../src/handlers/responseCachingHandler.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAI7C,MAAM,MAAM,GAAG,SAAS,CAAC,wBAAwB,CAAC,CAAC;AACnD,MAAM,QAAQ,GAAG,CAAC,GAAa,EAAE,EAAE,CAAC,qBAAqB,CAAC,oBAAoB,GAAG,sBAAsB,CAAC,CAAC;AACzG,MAAM,cAAc,GAAG,CAAC,GAAa,EAAE,KAAe,EAAE,EAAE,CACtD,IAAI,KAAK,CAAC,wCAAwC,GAAG,eAAe,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;AAIrF;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAA0B,EAAE,CAAC,CAAO,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;IAC3F,IAAI;QACA,MAAM,QAAQ,GAAG,MAAM,OAAO,EAAE,CAAC;QACjC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACvC,MAAM,CAAC,IAAI,CAAC,4CAA4C,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;KACnB;IAAC,OAAO,YAAY,EAAE;QACnB,IAAI;YACA,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACjD,IAAI,CAAC,cAAc;gBAAE,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC;YACzC,MAAM,CAAC,KAAK,CACR,gEAAgE,GAAG,uBAAuB,EAC1F,YAAY,CACf,CAAC;YACF,OAAO,cAAc,CAAC;SACzB;QAAC,OAAO,UAAU,EAAE;YACjB,MAAM,KAAK,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;YACtC,KAAK,CAAC,KAAK,GAAG,YAAY,CAAC;YAC3B,MAAM,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACpC;KACJ;AACL,CAAC,CAAA,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,GAA0B,EAAE,CAAC,CAAO,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;IACnG,IAAI;QACA,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,cAAc;YAAE,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC;QACzC,OAAO,EAAE;aACJ,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;aAC9C,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,MAAM,CAAC,IAAI,CAAC,iEAAiE,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC;QAChG,CAAC,CAAC,CAAC;QACP,OAAO,cAAc,CAAC;KACzB;IAAC,OAAO,UAAU,EAAE;QACjB,IAAI;YACA,MAAM,QAAQ,GAAG,MAAM,OAAO,EAAE,CAAC;YACjC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACvC,MAAM,CAAC,IAAI,CAAC,oDAAoD,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC;YACnF,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,KAAK,CACR,0EAA0E,GAAG,qBAAqB,EAClG,UAAU,CACb,CAAC;YACF,OAAO,QAAQ,CAAC;SACnB;QAAC,OAAO,YAAY,EAAE;YACnB,MAAM,KAAK,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC;YACxC,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC;YACzB,MAAM,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACpC;KACJ;AACL,CAAC,CAAA,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CACxC,KAAuB,EACvB,UAAuD,EACvD,QAA8B,EACY,EAAE;IAC5C,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAO,OAAO,EAAE,QAAQ,EAAE,EAAE;QACzC,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAE9C,IAAI,GAAa,CAAC;QAClB,IAAI;YACA,GAAG,GAAG,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;SACvC;QAAC,OAAO,KAAK,EAAE;YACZ,MAAM,CAAC,IAAI,CAAC,kEAAkE,EAAE,KAAK,CAAC,CAAC;YACvF,OAAO,OAAO,EAAE,CAAC;SACpB;QACD,OAAO,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC,CAAA,CAAC;AACN,CAAC,CAAC","sourcesContent":["import { ensureError } from \"../common/errorHelpers\";\nimport { cacheKeyNotFoundError } from \"../namedErrors\";\nimport { getLogger } from \"../logger/logger\";\nimport { Persistence, ValidKey } from \"../persistence/Persistence\";\nimport { ChainableHandler, RequestMetadata } from \"./HandlerChainBuilder\";\n\nconst logger = getLogger(\"responseCachingHandler\");\nconst notFound = (key: ValidKey) => cacheKeyNotFoundError(`Response for key ${key} not found in cache.`);\nconst strategyFailed = (key: ValidKey, cause?: unknown) =>\n    new Error(`Network request and cache lookup for ${key} both failed.`, { cause });\n\nexport type CachingStrategy<T> = (key: ValidKey, cache: Persistence<T>, network: () => Promise<T>) => Promise<T>;\n\n/**\n * Create a CachingStrategy that first makes a request to the network, falling back to cache if the network request\n * fails. If the network request fails and a prior response has not been cached, an error is returned to the caller.\n */\nexport const staleIfErrorStrategy = <T>(): CachingStrategy<T> => async (key, cache, network) => {\n    try {\n        const response = await network();\n        cache.store(key, response).catch((error) => {\n            logger.warn(`staleIfErrorStrategy failed to store key ${key}.`, error);\n        });\n        return response;\n    } catch (networkError) {\n        try {\n            const cachedResponse = await cache.retrieve(key);\n            if (!cachedResponse) throw notFound(key);\n            logger.debug(\n                `staleIfErrorStrategy successfully fell back to cache for key ${key} after network error.`,\n                networkError\n            );\n            return cachedResponse;\n        } catch (cacheError) {\n            const error = ensureError(cacheError);\n            error.cause = networkError;\n            throw strategyFailed(key, error);\n        }\n    }\n};\n\n/**\n * Create a CachingStrategy that first does a cache lookup – if the response is found in cache, it is returned and the\n * entry is updated with a request to the network in the background. If no cached response is found, the network request\n * is made, the result cached and returned to the caller.\n */\nexport const staleWhileRevalidateStrategy = <T>(): CachingStrategy<T> => async (key, cache, network) => {\n    try {\n        const cachedResponse = await cache.retrieve(key);\n        if (!cachedResponse) throw notFound(key);\n        network()\n            .then((response) => cache.store(key, response))\n            .catch((error) => {\n                logger.warn(`staleWhileRevalidateStrategy failed to retrieve and store key ${key}.`, error);\n            });\n        return cachedResponse;\n    } catch (cacheError) {\n        try {\n            const response = await network();\n            cache.store(key, response).catch((error) => {\n                logger.warn(`staleWhileRevalidateStrategy failed to store key ${key}.`, error);\n            });\n            logger.debug(\n                `staleWhileRevalidateStrategy successfully fell back to network for key ${key} after cache error.`,\n                cacheError\n            );\n            return response;\n        } catch (networkError) {\n            const error = ensureError(networkError);\n            error.cause = cacheError;\n            throw strategyFailed(key, error);\n        }\n    }\n};\n\n/**\n * Create a Handler capable of caching responses using various caching strategies.\n *\n * More than one caching strategy can be provided, and they will be composed into a single strategy. For example, an\n * expiringStrategy could be composed with a staleIfErrorStrategy so that responses\n *\n * @param cache A Persistence instance capable of storing responses.\n * @param resolveKey This function is called once for each request, and must return a valid persistence key\n * corresponding uniquely to that request.\n * @param strategy A CachingStrategy used to determine when to retrieve from cache vs. request from the network.\n * @returns\n */\nexport const createResponseCachingHandler = <Req, Res, Meta extends RequestMetadata>(\n    cache: Persistence<Res>,\n    resolveKey: (request: Req, metadata?: Meta) => ValidKey,\n    strategy: CachingStrategy<Res>\n): ChainableHandler<Req, Res, Req, Res, Meta> => {\n    return (next) => async (request, metadata) => {\n        const network = () => next(request, metadata);\n\n        let key: ValidKey;\n        try {\n            key = resolveKey(request, metadata);\n        } catch (error) {\n            logger.warn(\"Cache lookup failed because the cache key could not be resolved.\", error);\n            return network();\n        }\n        return strategy(key, cache, network);\n    };\n};\n"]}

package/lib/handlers/retryingHandler.d.ts

@@ -0,0 +1,37 @@
+import { ChainableHandler, RequestMetadata } from "./HandlerChainBuilder";
+export interface RetryingHandlerOptions<Req> {
+    /**
+     * Multiple used to increase the random backoff between attempts. Default is 3, usually doesn't need to be changed.
+     */
+    backoffMultiple: number;
+    /**
+     * The minimum number of milliseconds to sleep between attempts.
+     *
+     * The actual number of milliseconds slept between attempts is chosen at random.
+     */
+    baseSleep: number;
+    /**
+     * The maximum number of milliseconds to sleep between attempts. Note that this is not a timeout -- if multiple
+     * request attempts are made, the total request latency will be longer than this.
+     *
+     * The actual number of milliseconds slept between attempts is chosen at random.
+     */
+    maxSleep: number;
+    /**
+     * Determine if a given error is retryable. If `false` is returned, the error will be passed up to the Handler's
+     * caller and no additional retry attempts will be made.
+     */
+    retryPredicate: (responseOrError: Req | Error) => boolean;
+}
+/**
+ * Retry requests using an exponential backoff with jitter strategy.
+ *
+ * More about this approach to retries can be found
+ * [here](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/). This implementation uses the
+ * "Decorrelated jitter" algorithm described in that post. This offers a good tradeoff between call volume and latency,
+ * and also allows for convenient configurability.
+ *
+ * @param options
+ * @returns {@link ChainableHandler}, suitable for use in {@link HandlerChainBuilder.map}
+ */
+export declare const createRetryingHandler: <Req, Res, Meta extends RequestMetadata>(options?: Partial<RetryingHandlerOptions<Res>>) => ChainableHandler<Req, Res, Req, Res, Meta>;

package/lib/handlers/retryingHandler.js

@@ -0,0 +1,73 @@
+import { __awaiter } from "tslib";
+import { copyDefinedProperties } from "../common/copyDefinedProperties";
+import { getLogger } from "../logger/logger";
+const logger = getLogger("retryingHandler");
+const logRetry = (responseOrError, sleep) => {
+    logger.warn(`Retrying handler got failed response:`, responseOrError, `Waited ${sleep} millis, attempting retry now.`);
+};
+const sleep = (millis) => new Promise((resolve) => setTimeout(resolve, millis));
+const randomInRange = (min, max) => Math.round(Math.random() * (max - min) + min);
+const defaultOptions = {
+    backoffMultiple: 3,
+    baseSleep: 500,
+    maxSleep: 5 * 1000,
+    // The Response type is very common, so our default predicate special-cases to retry all failed Responses.
+    retryPredicate: (responseOrError) => (responseOrError instanceof Response ? !responseOrError.ok : true),
+};
+/**
+ * Retry requests using an exponential backoff with jitter strategy.
+ *
+ * More about this approach to retries can be found
+ * [here](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/). This implementation uses the
+ * "Decorrelated jitter" algorithm described in that post. This offers a good tradeoff between call volume and latency,
+ * and also allows for convenient configurability.
+ *
+ * @param options
+ * @returns {@link ChainableHandler}, suitable for use in {@link HandlerChainBuilder.map}
+ */
+export const createRetryingHandler = (options = {}) => {
+    const definedOptions = copyDefinedProperties(options);
+    const { backoffMultiple, baseSleep, maxSleep, retryPredicate } = Object.assign(Object.assign({}, defaultOptions), definedOptions);
+    const jitterSleep = (priorSleep) => __awaiter(void 0, void 0, void 0, function* () {
+        const nextSleep = Math.min(maxSleep, randomInRange(baseSleep, priorSleep * backoffMultiple));
+        yield sleep(nextSleep);
+        return nextSleep;
+    });
+    const makeRequestAttempt = (next, priorSleep = baseSleep) => (req, metadata) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b;
+        try {
+            const response = yield next(req, metadata);
+            if (retryPredicate(response)) {
+                const nextSleep = yield jitterSleep(priorSleep);
+                // The request may have been aborted while we were sleeping. In that case, we'll resolve with the failed
+                // response. In many cases this will be ignored, because an AbortError has already been returned to
+                // the caller of the Handler chain – but this prevents us from doing any extra work, and there may be
+                // edge cases where the caller could find the response useful.
+                if ((_a = metadata === null || metadata === void 0 ? void 0 : metadata.signal) === null || _a === void 0 ? void 0 : _a.aborted)
+                    return response;
+                logRetry(response, nextSleep);
+                return makeRequestAttempt(next, nextSleep)(req, metadata);
+            }
+            return response;
+        }
+        catch (error) {
+            if (!(error instanceof Error)) {
+                throw new Error("Invalid type caught by retrying handler. Handlers may only throw Errors. Got " +
+                    `${JSON.stringify(error)}`);
+            }
+            // If the request fails because it was aborted, we assume this was done intentionally and we can stop.
+            if (error.name === "AbortError")
+                throw error;
+            // If no retry is to be attempted, return the error to the caller.
+            if (!retryPredicate(error))
+                throw error;
+            const nextSleep = yield jitterSleep(priorSleep);
+            if ((_b = metadata === null || metadata === void 0 ? void 0 : metadata.signal) === null || _b === void 0 ? void 0 : _b.aborted)
+                throw error;
+            logRetry(error, nextSleep);
+            return makeRequestAttempt(next, nextSleep)(req, metadata);
+        }
+    });
+    return (next) => makeRequestAttempt(next);
+};
+//# sourceMappingURL=retryingHandler.js.map

package/lib/handlers/retryingHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryingHandler.js","sourceRoot":"","sources":["../../src/handlers/retryingHandler.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAG7C,MAAM,MAAM,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;AAE5C,MAAM,QAAQ,GAAG,CAAC,eAAoB,EAAE,KAAa,EAAE,EAAE;IACrD,MAAM,CAAC,IAAI,CACP,uCAAuC,EACvC,eAAe,EACf,UAAU,KAAK,gCAAgC,CAClD,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAExF,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AAElG,MAAM,cAAc,GAAoC;IACpD,eAAe,EAAE,CAAC;IAClB,SAAS,EAAE,GAAG;IACd,QAAQ,EAAE,CAAC,GAAG,IAAI;IAElB,0GAA0G;IAC1G,cAAc,EAAE,CAAC,eAAwB,EAAE,EAAE,CAAC,CAAC,eAAe,YAAY,QAAQ,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;CACnH,CAAC;AA6BF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACjC,UAAgD,EAAE,EACR,EAAE;IAC5C,MAAM,cAAc,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACtD,MAAM,EAAE,eAAe,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,EAAE,mCAAQ,cAAc,GAAK,cAAc,CAAE,CAAC;IAE1G,MAAM,WAAW,GAAG,CAAO,UAAkB,EAAE,EAAE;QAC7C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,SAAS,EAAE,UAAU,GAAG,eAAe,CAAC,CAAC,CAAC;QAC7F,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC;QACvB,OAAO,SAAS,CAAC;IACrB,CAAC,CAAA,CAAC;IAEF,MAAM,kBAAkB,GAAG,CAAC,IAA6B,EAAE,UAAU,GAAG,SAAS,EAAE,EAAE,CAAC,CAClF,GAAQ,EACR,QAAe,EACH,EAAE;;QACd,IAAI;YACA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YAC3C,IAAI,cAAc,CAAC,QAAQ,CAAC,EAAE;gBAC1B,MAAM,SAAS,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC,CAAC;gBAChD,wGAAwG;gBACxG,mGAAmG;gBACnG,qGAAqG;gBACrG,8DAA8D;gBAC9D,IAAI,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,0CAAE,OAAO;oBAAE,OAAO,QAAQ,CAAC;gBAC/C,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;gBAC9B,OAAO,kBAAkB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;aAC7D;YACD,OAAO,QAAQ,CAAC;SACnB;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,EAAE;gBAC3B,MAAM,IAAI,KAAK,CACX,+EAA+E;oBAC3E,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CACjC,CAAC;aACL;YAED,sGAAsG;YACtG,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY;gBAAE,MAAM,KAAK,CAAC;YAE7C,kEAAkE;YAClE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC;gBAAE,MAAM,KAAK,CAAC;YAExC,MAAM,SAAS,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC,CAAC;YAChD,IAAI,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,0CAAE,OAAO;gBAAE,MAAM,KAAK,CAAC;YAC3C,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAC3B,OAAO,kBAAkB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;SAC7D;IACL,CAAC,CAAA,CAAC;IAEF,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;AAC9C,CAAC,CAAC","sourcesContent":["import { copyDefinedProperties } from \"../common/copyDefinedProperties\";\nimport { getLogger } from \"../logger/logger\";\nimport { ChainableHandler, Handler, RequestMetadata } from \"./HandlerChainBuilder\";\n\nconst logger = getLogger(\"retryingHandler\");\n\nconst logRetry = (responseOrError: any, sleep: number) => {\n    logger.warn(\n        `Retrying handler got failed response:`,\n        responseOrError,\n        `Waited ${sleep} millis, attempting retry now.`\n    );\n};\n\nconst sleep = (millis: number) => new Promise((resolve) => setTimeout(resolve, millis));\n\nconst randomInRange = (min: number, max: number) => Math.round(Math.random() * (max - min) + min);\n\nconst defaultOptions: RetryingHandlerOptions<unknown> = {\n    backoffMultiple: 3,\n    baseSleep: 500,\n    maxSleep: 5 * 1000,\n\n    // The Response type is very common, so our default predicate special-cases to retry all failed Responses.\n    retryPredicate: (responseOrError: unknown) => (responseOrError instanceof Response ? !responseOrError.ok : true),\n};\nexport interface RetryingHandlerOptions<Req> {\n    /**\n     * Multiple used to increase the random backoff between attempts. Default is 3, usually doesn't need to be changed.\n     */\n    backoffMultiple: number;\n\n    /**\n     * The minimum number of milliseconds to sleep between attempts.\n     *\n     * The actual number of milliseconds slept between attempts is chosen at random.\n     */\n    baseSleep: number;\n\n    /**\n     * The maximum number of milliseconds to sleep between attempts. Note that this is not a timeout -- if multiple\n     * request attempts are made, the total request latency will be longer than this.\n     *\n     * The actual number of milliseconds slept between attempts is chosen at random.\n     */\n    maxSleep: number;\n\n    /**\n     * Determine if a given error is retryable. If `false` is returned, the error will be passed up to the Handler's\n     * caller and no additional retry attempts will be made.\n     */\n    retryPredicate: (responseOrError: Req | Error) => boolean;\n}\n\n/**\n * Retry requests using an exponential backoff with jitter strategy.\n *\n * More about this approach to retries can be found\n * [here](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/). This implementation uses the\n * \"Decorrelated jitter\" algorithm described in that post. This offers a good tradeoff between call volume and latency,\n * and also allows for convenient configurability.\n *\n * @param options\n * @returns {@link ChainableHandler}, suitable for use in {@link HandlerChainBuilder.map}\n */\nexport const createRetryingHandler = <Req, Res, Meta extends RequestMetadata>(\n    options: Partial<RetryingHandlerOptions<Res>> = {}\n): ChainableHandler<Req, Res, Req, Res, Meta> => {\n    const definedOptions = copyDefinedProperties(options);\n    const { backoffMultiple, baseSleep, maxSleep, retryPredicate } = { ...defaultOptions, ...definedOptions };\n\n    const jitterSleep = async (priorSleep: number) => {\n        const nextSleep = Math.min(maxSleep, randomInRange(baseSleep, priorSleep * backoffMultiple));\n        await sleep(nextSleep);\n        return nextSleep;\n    };\n\n    const makeRequestAttempt = (next: Handler<Req, Res, Meta>, priorSleep = baseSleep) => async (\n        req: Req,\n        metadata?: Meta\n    ): Promise<Res> => {\n        try {\n            const response = await next(req, metadata);\n            if (retryPredicate(response)) {\n                const nextSleep = await jitterSleep(priorSleep);\n                // The request may have been aborted while we were sleeping. In that case, we'll resolve with the failed\n                // response. In many cases this will be ignored, because an AbortError has already been returned to\n                // the caller of the Handler chain – but this prevents us from doing any extra work, and there may be\n                // edge cases where the caller could find the response useful.\n                if (metadata?.signal?.aborted) return response;\n                logRetry(response, nextSleep);\n                return makeRequestAttempt(next, nextSleep)(req, metadata);\n            }\n            return response;\n        } catch (error) {\n            if (!(error instanceof Error)) {\n                throw new Error(\n                    \"Invalid type caught by retrying handler. Handlers may only throw Errors. Got \" +\n                        `${JSON.stringify(error)}`\n                );\n            }\n\n            // If the request fails because it was aborted, we assume this was done intentionally and we can stop.\n            if (error.name === \"AbortError\") throw error;\n\n            // If no retry is to be attempted, return the error to the caller.\n            if (!retryPredicate(error)) throw error;\n\n            const nextSleep = await jitterSleep(priorSleep);\n            if (metadata?.signal?.aborted) throw error;\n            logRetry(error, nextSleep);\n            return makeRequestAttempt(next, nextSleep)(req, metadata);\n        }\n    };\n\n    return (next) => makeRequestAttempt(next);\n};\n"]}

package/lib/handlers/timeoutHandler.d.ts

@@ -0,0 +1,18 @@
+import { ChainableHandler, RequestMetadata } from "./HandlerChainBuilder";
+export interface TimeoutHandlerOptions<Req> {
+    /**
+     * A function that returns a new Error instance when a timeout occurs.
+     */
+    createError: (req: Req, meta?: RequestMetadata | void) => Error;
+    /**
+     * Abort requests after this number of milliseconds. Defaults to 30 seconds.
+     */
+    timeout: number;
+}
+/**
+ * Timeout requests after a given number of milliseconds, rejecting the Response promise with a custom error.
+ *
+ * @param options
+ * @returns {@link ChainableHandler}, suitable for use in {@link HandlerChainBuilder.map}
+ */
+export declare const createTimeoutHandler: <Req, Res, Meta extends RequestMetadata>(options?: Partial<TimeoutHandlerOptions<Req>>) => ChainableHandler<Req, Res, Req, Res, Meta>;

package/lib/handlers/timeoutHandler.js

@@ -0,0 +1,30 @@
+import { copyDefinedProperties } from "../common/copyDefinedProperties";
+import { isString } from "../common/typeguards";
+const sleep = (millis) => new Promise((resolve) => setTimeout(resolve, millis));
+const defaultOptions = {
+    createError: (request) => {
+        // The string and Request types are very common, so our default error creator special-cases those types to
+        // provide better error messages.
+        const destination = isString(request)
+            ? `for ${request}`
+            : request instanceof Request
+                ? `for ${request.url}`
+                : "";
+        return new Error(`Request ${destination} timed out by client timeout handler.`);
+    },
+    timeout: 30 * 1000,
+};
+/**
+ * Timeout requests after a given number of milliseconds, rejecting the Response promise with a custom error.
+ *
+ * @param options
+ * @returns {@link ChainableHandler}, suitable for use in {@link HandlerChainBuilder.map}
+ */
+export const createTimeoutHandler = (options = {}) => {
+    const definedOptions = copyDefinedProperties(options);
+    const { createError, timeout } = Object.assign(Object.assign({}, defaultOptions), definedOptions);
+    // If the timeout Promise wins the race, the HandlerChainBuilder sets the abort signal for subsequent handlers. They
+    // may look at the abort signal in order to terminate themselves early.
+    return (next) => (req, meta) => Promise.race([next(req, meta), sleep(timeout).then(() => Promise.reject(createError(req, meta)))]);
+};
+//# sourceMappingURL=timeoutHandler.js.map

package/lib/handlers/timeoutHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeoutHandler.js","sourceRoot":"","sources":["../../src/handlers/timeoutHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAGhD,MAAM,KAAK,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAE9F,MAAM,cAAc,GAAmC;IACnD,WAAW,EAAE,CAAC,OAAO,EAAE,EAAE;QACrB,0GAA0G;QAC1G,iCAAiC;QACjC,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC;YACjC,CAAC,CAAC,OAAO,OAAO,EAAE;YAClB,CAAC,CAAC,OAAO,YAAY,OAAO;gBAC5B,CAAC,CAAC,OAAO,OAAO,CAAC,GAAG,EAAE;gBACtB,CAAC,CAAC,EAAE,CAAC;QACT,OAAO,IAAI,KAAK,CAAC,WAAW,WAAW,uCAAuC,CAAC,CAAC;IACpF,CAAC;IACD,OAAO,EAAE,EAAE,GAAG,IAAI;CACrB,CAAC;AAcF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAChC,UAA+C,EAAE,EACP,EAAE;IAC5C,MAAM,cAAc,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACtD,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,mCAAQ,cAAc,GAAK,cAAc,CAAE,CAAC;IAE1E,oHAAoH;IACpH,uEAAuE;IACvE,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3G,CAAC,CAAC","sourcesContent":["import { copyDefinedProperties } from \"../common/copyDefinedProperties\";\nimport { isString } from \"../common/typeguards\";\nimport { ChainableHandler, RequestMetadata } from \"./HandlerChainBuilder\";\n\nconst sleep = (millis: number) => new Promise<void>((resolve) => setTimeout(resolve, millis));\n\nconst defaultOptions: TimeoutHandlerOptions<unknown> = {\n    createError: (request) => {\n        // The string and Request types are very common, so our default error creator special-cases those types to\n        // provide better error messages.\n        const destination = isString(request)\n            ? `for ${request}`\n            : request instanceof Request\n            ? `for ${request.url}`\n            : \"\";\n        return new Error(`Request ${destination} timed out by client timeout handler.`);\n    },\n    timeout: 30 * 1000,\n};\n\nexport interface TimeoutHandlerOptions<Req> {\n    /**\n     * A function that returns a new Error instance when a timeout occurs.\n     */\n    createError: (req: Req, meta?: RequestMetadata | void) => Error;\n\n    /**\n     * Abort requests after this number of milliseconds. Defaults to 30 seconds.\n     */\n    timeout: number;\n}\n\n/**\n * Timeout requests after a given number of milliseconds, rejecting the Response promise with a custom error.\n *\n * @param options\n * @returns {@link ChainableHandler}, suitable for use in {@link HandlerChainBuilder.map}\n */\nexport const createTimeoutHandler = <Req, Res, Meta extends RequestMetadata>(\n    options: Partial<TimeoutHandlerOptions<Req>> = {}\n): ChainableHandler<Req, Res, Req, Res, Meta> => {\n    const definedOptions = copyDefinedProperties(options);\n    const { createError, timeout } = { ...defaultOptions, ...definedOptions };\n\n    // If the timeout Promise wins the race, the HandlerChainBuilder sets the abort signal for subsequent handlers. They\n    // may look at the abort signal in order to terminate themselves early.\n    return (next) => (req, meta) =>\n        Promise.race([next(req, meta), sleep(timeout).then(() => Promise.reject(createError(req, meta)))]);\n};\n"]}

package/lib/index.d.ts

@@ -0,0 +1,33 @@
+export { Keyboard, KeyboardEvents } from "./session/LensKeyboard";
+export { CameraKitConfiguration, CameraKitBootstrapConfiguration, configurationToken } from "./configuration";
+export { getRequiredBootstrapURLs } from "./lens-core-module/loader/lensCoreFactory";
+export { estimateLensPerformance, EstimatedLensPerformance, LensPerformanceCluster, } from "./benchmark/estimateLensPerformanceCluster";
+export * from "./bootstrapCameraKit";
+export { extensionRequestContext } from "./extensions/extensionRequestContext";
+export { LensSource, LensSources, lensSourcesFactory } from "./extensions/LensSources";
+export { Uri, UriRequest, UriResponse, UriCancelRequest, UriHandler, UriHandlers, uriHandlersFactory, } from "./extensions/UriHandlers";
+export { CameraKit, CreateSessionOptions, LensMetricsEvents } from "./CameraKit";
+export { LensView } from "./metrics/reporters/reportLensView";
+export { LensWait } from "./metrics/reporters/reportLensWait";
+export { cameraKitUserAgent, CameraKitUserAgent } from "./common/cameraKitUserAgent";
+export { Lens, toPublicLens } from "./lens/Lens";
+export { AssetTiming, LensRepository } from "./lens/LensRepository";
+export { LensLaunchParams } from "./lens/LensLaunchParams";
+export { AssetLoader } from "./lens/assets/LensAssetRepository";
+export { remoteMediaAssetLoaderFactory } from "./lens/assets/remoteMediaAssetLoaderFactory";
+export * from "./media-sources/CameraKitSource";
+export * from "./media-sources/MediaStreamSource";
+export * from "./media-sources/FunctionSource";
+export * from "./media-sources/VideoSource";
+export * from "./media-sources/ImageSource";
+export * from "./session/CameraKitSession";
+export { CameraKitSessionEvents, CameraKitSessionEventListener } from "./session/CameraKitSessionEvents";
+export { Injectable } from "./dependency-injection/Injectable";
+export { PartialContainer } from "./dependency-injection/PartialContainer";
+export * from "./transforms";
+export * from "./namedErrors";
+export { LensPerformanceMeasurement, ComputedFrameMetrics } from "./session/LensPerformanceMeasurement";
+export { LensPerformanceMetrics } from "./session/LensPerformanceMetrics";
+export { TypedCustomEvent } from "./events/TypedCustomEvent";
+export { TypedEventTarget } from "./events/TypedEventTarget";
+export { namedError } from "./namedErrors";

package/lib/index.js

@@ -0,0 +1,32 @@
+import environment from "./environment.json";
+import lensCoreWasm from "./lensCoreWasmVersions.json";
+console.info(`SDK: ${environment.PACKAGE_VERSION} \
+(${lensCoreWasm.version}/${lensCoreWasm.buildNumber})`);
+export { configurationToken } from "./configuration";
+export { getRequiredBootstrapURLs } from "./lens-core-module/loader/lensCoreFactory";
+export { estimateLensPerformance, } from "./benchmark/estimateLensPerformanceCluster";
+export * from "./bootstrapCameraKit";
+export { extensionRequestContext } from "./extensions/extensionRequestContext";
+export { LensSources, lensSourcesFactory } from "./extensions/LensSources";
+export { uriHandlersFactory, } from "./extensions/UriHandlers";
+export { CameraKit } from "./CameraKit";
+export { cameraKitUserAgent } from "./common/cameraKitUserAgent";
+export { toPublicLens } from "./lens/Lens";
+export { LensRepository } from "./lens/LensRepository";
+export { remoteMediaAssetLoaderFactory } from "./lens/assets/remoteMediaAssetLoaderFactory";
+export * from "./media-sources/CameraKitSource";
+export * from "./media-sources/MediaStreamSource";
+export * from "./media-sources/FunctionSource";
+export * from "./media-sources/VideoSource";
+export * from "./media-sources/ImageSource";
+export * from "./session/CameraKitSession";
+export { Injectable } from "./dependency-injection/Injectable";
+export { PartialContainer } from "./dependency-injection/PartialContainer";
+export * from "./transforms";
+export * from "./namedErrors";
+export { LensPerformanceMeasurement } from "./session/LensPerformanceMeasurement";
+export { LensPerformanceMetrics } from "./session/LensPerformanceMetrics";
+export { TypedCustomEvent } from "./events/TypedCustomEvent";
+export { TypedEventTarget } from "./events/TypedEventTarget";
+export { namedError } from "./namedErrors";
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,oBAAoB,CAAC;AAC7C,OAAO,YAAY,MAAM,6BAA6B,CAAC;AACvD,OAAO,CAAC,IAAI,CAAC,QAAQ,WAAW,CAAC,eAAe;GAC7C,YAAY,CAAC,OAAO,IAAI,YAAY,CAAC,WAAW,GAAG,CAAC,CAAC;AAGxD,OAAO,EAA2D,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC9G,OAAO,EAAE,wBAAwB,EAAE,MAAM,2CAA2C,CAAC;AACrF,OAAO,EACH,uBAAuB,GAG1B,MAAM,4CAA4C,CAAC;AACpD,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,EAAc,WAAW,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AACvF,OAAO,EAOH,kBAAkB,GACrB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,SAAS,EAA2C,MAAM,aAAa,CAAC;AAGjF,OAAO,EAAE,kBAAkB,EAAsB,MAAM,6BAA6B,CAAC;AACrF,OAAO,EAAQ,YAAY,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAe,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAGpE,OAAO,EAAE,6BAA6B,EAAE,MAAM,6CAA6C,CAAC;AAC5F,cAAc,iCAAiC,CAAC;AAChD,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAE3C,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAC3E,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,0BAA0B,EAAwB,MAAM,sCAAsC,CAAC;AACxG,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC","sourcesContent":["import environment from \"./environment.json\";\nimport lensCoreWasm from \"./lensCoreWasmVersions.json\";\nconsole.info(`SDK: ${environment.PACKAGE_VERSION} \\\n(${lensCoreWasm.version}/${lensCoreWasm.buildNumber})`);\n\nexport { Keyboard, KeyboardEvents } from \"./session/LensKeyboard\";\nexport { CameraKitConfiguration, CameraKitBootstrapConfiguration, configurationToken } from \"./configuration\";\nexport { getRequiredBootstrapURLs } from \"./lens-core-module/loader/lensCoreFactory\";\nexport {\n    estimateLensPerformance,\n    EstimatedLensPerformance,\n    LensPerformanceCluster,\n} from \"./benchmark/estimateLensPerformanceCluster\";\nexport * from \"./bootstrapCameraKit\";\nexport { extensionRequestContext } from \"./extensions/extensionRequestContext\";\nexport { LensSource, LensSources, lensSourcesFactory } from \"./extensions/LensSources\";\nexport {\n    Uri,\n    UriRequest,\n    UriResponse,\n    UriCancelRequest,\n    UriHandler,\n    UriHandlers,\n    uriHandlersFactory,\n} from \"./extensions/UriHandlers\";\nexport { CameraKit, CreateSessionOptions, LensMetricsEvents } from \"./CameraKit\";\nexport { LensView } from \"./metrics/reporters/reportLensView\";\nexport { LensWait } from \"./metrics/reporters/reportLensWait\";\nexport { cameraKitUserAgent, CameraKitUserAgent } from \"./common/cameraKitUserAgent\";\nexport { Lens, toPublicLens } from \"./lens/Lens\";\nexport { AssetTiming, LensRepository } from \"./lens/LensRepository\";\nexport { LensLaunchParams } from \"./lens/LensLaunchParams\";\nexport { AssetLoader } from \"./lens/assets/LensAssetRepository\";\nexport { remoteMediaAssetLoaderFactory } from \"./lens/assets/remoteMediaAssetLoaderFactory\";\nexport * from \"./media-sources/CameraKitSource\";\nexport * from \"./media-sources/MediaStreamSource\";\nexport * from \"./media-sources/FunctionSource\";\nexport * from \"./media-sources/VideoSource\";\nexport * from \"./media-sources/ImageSource\";\nexport * from \"./session/CameraKitSession\";\nexport { CameraKitSessionEvents, CameraKitSessionEventListener } from \"./session/CameraKitSessionEvents\";\nexport { Injectable } from \"./dependency-injection/Injectable\";\nexport { PartialContainer } from \"./dependency-injection/PartialContainer\";\nexport * from \"./transforms\";\nexport * from \"./namedErrors\";\nexport { LensPerformanceMeasurement, ComputedFrameMetrics } from \"./session/LensPerformanceMeasurement\";\nexport { LensPerformanceMetrics } from \"./session/LensPerformanceMetrics\";\nexport { TypedCustomEvent } from \"./events/TypedCustomEvent\";\nexport { TypedEventTarget } from \"./events/TypedEventTarget\";\nexport { namedError } from \"./namedErrors\";\n"]}

package/lib/legal/legalPrompt.d.ts

@@ -0,0 +1,17 @@
+import { Observable } from "rxjs";
+import { LegalDocument, LegalDocument_Type } from "../generated-proto/pb_schema/camera_kit/v3/legal_prompt";
+export declare type LegalPrompt = (privacyPolicy: LegalDocument & {
+    type: LegalDocument_Type.PRIVACY_POLICY;
+}, termsOfService: LegalDocument & {
+    type: LegalDocument_Type.TERMS_OF_SERVICE;
+}, learnMore: LegalDocument & {
+    type: LegalDocument_Type.LEARN_MORE;
+}, container?: HTMLElement) => Observable<boolean>;
+/**
+ * @internal
+ */
+export declare const legalPromptFactory: {
+    (): LegalPrompt;
+    token: "legalPrompt";
+    dependencies: [];
+};

package/lib/legal/legalPrompt.js

@@ -0,0 +1,144 @@
+import { fromEvent, map, mergeWith, take } from "rxjs";
+import { Injectable } from "../dependency-injection/Injectable";
+import { localizedString } from "../common/localization";
+function createCameraKitLegalPrompt(privacyPolicyUrl, termsOfServiceUrl, learnMoreUrl) {
+    const element = document.createElement("div");
+    element.id = "tos-popup";
+    const shadow = element.attachShadow({ mode: "open" });
+    const prompt = document.createElement("div");
+    prompt.id = "content";
+    /* eslint-disable max-len */
+    prompt.innerHTML = `
+        <button id="reject">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+            <title>${localizedString("legalPromptReject")}</title>
+            <path
+                d="M 14.356 12.5 L 17.803 15.947 C 18.316 16.46 18.316 17.291 17.803 17.803 C 17.291 18.316 16.46 18.316 15.947 17.803 L 12.5 14.356 L 9.053 17.803 C 8.54 18.316 7.709 18.316 7.197 17.803 C 6.684 17.291 6.684 16.46 7.197 15.947 L 10.644 12.5 L 7.197 9.053 C 6.684 8.54 6.684 7.709 7.197 7.197 C 7.709 6.684 8.54 6.684 9.053 7.197 L 12.5 10.644 L 15.947 7.197 C 16.46 6.684 17.291 6.684 17.803 7.197 C 18.316 7.709 18.316 8.54 17.803 9.053 Z"
+                fill="#a0a0a0"
+            />
+        </svg>
+        </button>
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
+            <g>
+                <path
+                    d="M 30.898 23.477 C 30.77 23.045 30.148 22.743 30.148 22.743 C 30.092 22.71 30.039 22.684 29.994 22.663 C 28.962 22.161 28.048 21.561 27.277 20.876 C 26.659 20.325 26.128 19.719 25.701 19.074 C 25.182 18.288 24.937 17.632 24.831 17.275 C 24.773 17.043 24.782 16.951 24.831 16.832 C 24.873 16.731 24.99 16.632 25.049 16.588 C 25.397 16.341 25.96 15.976 26.303 15.75 C 26.602 15.556 26.859 15.389 27.009 15.283 C 27.494 14.944 27.824 14.596 28.02 14.223 C 28.275 13.74 28.303 13.208 28.107 12.684 C 27.84 11.978 27.184 11.556 26.35 11.556 C 26.163 11.556 25.974 11.577 25.785 11.62 C 25.308 11.723 24.852 11.894 24.474 12.042 C 24.446 12.054 24.416 12.032 24.418 12.002 C 24.457 11.059 24.502 9.79 24.399 8.584 C 24.306 7.493 24.082 6.576 23.717 5.776 C 23.351 4.972 22.874 4.376 22.5 3.947 C 22.143 3.536 21.519 2.936 20.577 2.394 C 19.251 1.631 17.742 1.244 16.09 1.244 C 14.443 1.244 12.934 1.631 11.605 2.394 C 10.607 2.966 9.97 3.614 9.678 3.947 C 9.304 4.376 8.827 4.972 8.46 5.776 C 8.096 6.576 7.872 7.496 7.778 8.584 C 7.673 9.792 7.715 10.96 7.76 11.999 C 7.762 12.03 7.732 12.051 7.704 12.039 C 7.325 11.892 6.87 11.72 6.393 11.617 C 6.204 11.575 6.012 11.554 5.828 11.554 C 4.994 11.554 4.337 11.976 4.071 12.682 C 3.875 13.205 3.903 13.738 4.157 14.221 C 4.354 14.594 4.685 14.941 5.169 15.281 C 5.318 15.387 5.575 15.553 5.874 15.748 C 6.211 15.968 6.758 16.323 7.108 16.569 C 7.152 16.599 7.299 16.712 7.346 16.827 C 7.397 16.951 7.404 17.045 7.341 17.289 C 7.234 17.648 6.989 18.298 6.479 19.069 C 6.052 19.715 5.522 20.32 4.902 20.871 C 4.132 21.556 3.218 22.157 2.186 22.658 C 2.137 22.682 2.078 22.712 2.015 22.748 C 2.015 22.748 1.399 23.064 1.282 23.472 C 1.109 24.075 1.567 24.64 2.036 24.943 C 2.8 25.438 3.732 25.703 4.272 25.849 C 4.421 25.889 4.559 25.926 4.683 25.964 C 4.76 25.989 4.956 26.062 5.038 26.17 C 5.143 26.306 5.155 26.473 5.192 26.66 C 5.253 26.977 5.384 27.373 5.774 27.643 C 6.204 27.941 6.75 27.962 7.444 27.99 C 8.168 28.018 9.07 28.054 10.1 28.394 C 10.579 28.553 11.011 28.818 11.514 29.128 C 12.56 29.773 13.864 30.578 16.09 30.578 C 18.318 30.578 19.629 29.768 20.685 29.119 C 21.183 28.811 21.612 28.546 22.08 28.391 C 23.11 28.049 24.011 28.014 24.735 27.988 C 25.427 27.962 25.974 27.941 26.404 27.641 C 26.822 27.35 26.943 26.918 26.997 26.59 C 27.027 26.428 27.046 26.285 27.14 26.165 C 27.219 26.064 27.399 25.992 27.483 25.964 C 27.609 25.924 27.751 25.886 27.906 25.844 C 28.445 25.698 29.123 25.527 29.945 25.061 C 30.933 24.511 31.001 23.82 30.898 23.477"
+                    fill="#ffffff"
+                    stroke="#00000000"
+                    stroke-width="1"
+                />
+            </g>
+            <g>
+                <path
+                    d="M 29.56 24.299 C 28.21 25.045 27.312 24.965 26.613 25.414 C 26.021 25.795 26.37 26.618 25.939 26.915 C 25.411 27.279 23.843 26.889 21.822 27.555 C 20.155 28.107 19.09 29.689 16.089 29.689 C 13.081 29.689 12.047 28.114 10.357 27.555 C 8.335 26.889 6.768 27.279 6.24 26.915 C 5.809 26.618 6.16 25.795 5.566 25.414 C 4.869 24.965 3.969 25.045 2.619 24.299 C 1.758 23.825 2.247 23.53 2.532 23.393 C 7.426 21.027 8.204 17.372 8.24 17.096 C 8.282 16.769 8.328 16.509 7.966 16.175 C 7.615 15.853 6.066 14.895 5.636 14.593 C 4.925 14.098 4.612 13.6 4.841 12.99 C 5 12.569 5.395 12.41 5.812 12.41 C 5.94 12.41 6.071 12.426 6.2 12.452 C 6.981 12.623 7.741 13.013 8.179 13.118 C 8.24 13.132 8.293 13.139 8.34 13.139 C 8.574 13.139 8.656 13.022 8.639 12.754 C 8.59 11.9 8.469 10.234 8.602 8.677 C 8.787 6.536 9.477 5.476 10.298 4.538 C 10.693 4.087 12.543 2.133 16.082 2.133 C 19.633 2.133 21.474 4.087 21.867 4.538 C 22.688 5.478 23.378 6.536 23.563 8.677 C 23.698 10.234 23.581 11.898 23.525 12.754 C 23.506 13.034 23.591 13.139 23.825 13.139 C 23.872 13.139 23.925 13.132 23.986 13.118 C 24.426 13.013 25.184 12.62 25.965 12.452 C 26.091 12.424 26.222 12.41 26.353 12.41 C 26.77 12.41 27.165 12.569 27.324 12.99 C 27.555 13.6 27.242 14.095 26.529 14.593 C 26.098 14.892 24.547 15.85 24.199 16.175 C 23.836 16.509 23.883 16.767 23.925 17.096 C 23.96 17.372 24.739 21.025 29.633 23.393 C 29.932 23.53 30.421 23.825 29.56 24.299 M 31.709 23.12 C 31.489 22.523 31.07 22.203 30.594 21.939 C 30.505 21.887 30.423 21.845 30.355 21.812 C 30.212 21.74 30.067 21.667 29.922 21.592 C 28.435 20.806 27.275 19.812 26.469 18.635 C 26.198 18.238 26.008 17.88 25.877 17.587 C 25.809 17.391 25.811 17.281 25.86 17.178 C 25.898 17.101 25.996 17.019 26.05 16.979 C 26.305 16.811 26.57 16.64 26.748 16.525 C 27.067 16.319 27.317 16.156 27.481 16.043 C 28.093 15.617 28.519 15.164 28.786 14.658 C 29.163 13.945 29.21 13.131 28.919 12.363 C 28.517 11.301 27.509 10.642 26.291 10.642 C 26.038 10.642 25.783 10.67 25.527 10.726 C 25.46 10.74 25.394 10.756 25.328 10.773 C 25.34 10.05 25.324 9.278 25.258 8.524 C 25.029 5.872 24.099 4.48 23.129 3.371 C 22.724 2.908 22.021 2.232 20.964 1.628 C 19.491 0.781 17.821 0.356 16 0.356 C 14.185 0.356 12.518 0.781 11.044 1.623 C 9.983 2.229 9.278 2.905 8.875 3.366 C 7.905 4.475 6.975 5.867 6.746 8.52 C 6.68 9.273 6.663 10.045 6.675 10.768 C 6.61 10.752 6.544 10.735 6.476 10.721 C 6.221 10.665 5.965 10.637 5.713 10.637 C 4.494 10.637 3.487 11.297 3.084 12.359 C 2.794 13.126 2.841 13.94 3.218 14.654 C 3.485 15.159 3.911 15.613 4.522 16.039 C 4.686 16.153 4.937 16.314 5.256 16.52 C 5.427 16.633 5.68 16.794 5.926 16.958 C 5.963 16.984 6.097 17.082 6.141 17.173 C 6.193 17.279 6.195 17.393 6.118 17.604 C 5.987 17.891 5.801 18.242 5.535 18.631 C 4.747 19.782 3.62 20.757 2.18 21.536 C 1.419 21.941 0.54 22.355 0.29 23.118 C 0.039 23.88 0.203 24.582 0.842 25.239 C 1.053 25.466 1.318 25.665 1.653 25.85 C 2.438 26.283 3.105 26.496 3.63 26.641 C 3.721 26.669 3.937 26.736 4.031 26.819 C 4.265 27.022 4.23 27.331 4.543 27.78 C 4.731 28.061 4.949 28.25 5.129 28.374 C 5.783 28.826 6.516 28.854 7.294 28.881 C 7.997 28.908 8.793 28.94 9.702 29.24 C 10.079 29.364 10.47 29.605 10.922 29.883 C 12.011 30.552 13.501 31.467 15.998 31.467 C 18.493 31.467 19.995 30.547 21.091 29.876 C 21.541 29.6 21.93 29.361 22.297 29.242 C 23.206 28.942 24.003 28.912 24.706 28.884 C 25.483 28.854 26.216 28.826 26.87 28.377 C 27.076 28.234 27.331 28.004 27.535 27.651 C 27.76 27.272 27.753 27.003 27.964 26.821 C 28.05 26.746 28.238 26.68 28.338 26.65 C 28.868 26.505 29.545 26.292 30.344 25.852 C 30.697 25.658 30.976 25.443 31.192 25.2 C 31.194 25.197 31.196 25.192 31.199 25.19 C 31.805 24.544 31.955 23.787 31.709 23.12"
+                    fill="#000000"
+                    stroke="#00000000"
+                    stroke-width="1"
+                />
+            </g>
+        </svg>
+        <p>${localizedString("legalPromptMessage")({ privacyPolicyUrl, termsOfServiceUrl, learnMoreUrl })}</p>
+        <button id="accept">${localizedString("legalPromptAccept")}</button>
+    `;
+    /* eslint-enable */
+    const style = document.createElement("style");
+    style.innerHTML = `
+        div#content {
+            display: flex;
+            flex-direction: column;
+
+            position: fixed;
+            top: 25%;
+            left: 50%;
+            transform: translate(-50%, -25%);
+
+            background-color: #fff;
+            border: #efefef 1px solid;
+            border-radius: 1.5rem;
+            box-shadow: rgba(0, 0, 0, 0.25) 0 1.5rem 2rem;
+
+            min-width: 16rem;
+            max-width: 20rem;
+            padding: 2rem;
+
+            text-align: center;
+            font-family: sans-serif;
+        }
+
+        div > svg {
+            height: 3rem;
+        }
+
+        div > p {
+            margin: 1rem 0;
+        }
+
+        div > p > a {
+            color: rgb(78, 171, 248);
+        }
+
+        div > button {
+            cursor: pointer;
+        }
+
+        div > button#reject {
+            align-self: flex-end;
+
+            position: absolute;
+
+            background-color: transparent;
+            border: 0;
+
+            width: 3rem;
+            margin: -1.5rem;
+        }
+
+        div > button#accept {
+            align-self: center;
+
+            background-color: rgb(78, 171, 248);
+            border: 0;
+            border-radius: 1.5rem;
+
+            width: 80%;
+            padding: 1rem;
+            margin-top: 1rem;
+
+            color: #fff;
+            font-size: 1.5rem;
+            font-weight: 700;
+            font-family: inherit;
+        }
+
+        div#overlay {
+            position: fixed;
+            top: 0;
+            right: 0;
+            bottom: 0;
+            left: 0;
+
+            background-color: rgba(0, 0, 0, 0.4);
+        }
+    `;
+    const overlay = document.createElement("div");
+    overlay.id = "overlay";
+    shadow.appendChild(overlay);
+    shadow.appendChild(style);
+    shadow.appendChild(prompt);
+    const acceptBtn = prompt.querySelector("#accept");
+    const rejectBtn = prompt.querySelector("#reject");
+    const result = fromEvent(acceptBtn, "click").pipe(map(() => true), mergeWith(fromEvent(rejectBtn, "click").pipe(map(() => false))), take(1));
+    result.subscribe({ complete: element.remove.bind(element) });
+    return { element, result, focus: () => rejectBtn.focus() };
+}
+/**
+ * @internal
+ */
+export const legalPromptFactory = Injectable("legalPrompt", () => {
+    return function legalPrompt(privacyPolicy, termsOfService, learnMore, container = document.body) {
+        const prompt = createCameraKitLegalPrompt(privacyPolicy.webUrl, termsOfService.webUrl, learnMore.webUrl);
+        container.appendChild(prompt.element);
+        prompt.focus();
+        return prompt.result;
+    };
+});
+//# sourceMappingURL=legalPrompt.js.map

package/lib/legal/legalPrompt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"legalPrompt.js","sourceRoot":"","sources":["../../src/legal/legalPrompt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAc,IAAI,EAAE,MAAM,MAAM,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAEhE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,SAAS,0BAA0B,CAC/B,gBAAwB,EACxB,iBAAyB,EACzB,YAAoB;IAEpB,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9C,OAAO,CAAC,EAAE,GAAG,WAAW,CAAC;IACzB,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC7C,MAAM,CAAC,EAAE,GAAG,SAAS,CAAC;IAEtB,4BAA4B;IAC5B,MAAM,CAAC,SAAS,GAAG;;;qBAGF,eAAe,CAAC,mBAAmB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;aAyB5C,eAAe,CAAC,oBAAoB,CAAC,CAAC,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,YAAY,EAAE,CAAC;8BAC3E,eAAe,CAAC,mBAAmB,CAAC;KAC7D,CAAC;IACF,mBAAmB;IAEnB,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC9C,KAAK,CAAC,SAAS,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA6EjB,CAAC;IAEF,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9C,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC;IACvB,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAE5B,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC1B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAE3B,MAAM,SAAS,GAAsB,MAAM,CAAC,aAAa,CAAC,SAAS,CAAE,CAAC;IACtE,MAAM,SAAS,GAAsB,MAAM,CAAC,aAAa,CAAC,SAAS,CAAE,CAAC;IACtE,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,CAC7C,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,EACf,SAAS,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAC/D,IAAI,CAAC,CAAC,CAAC,CACV,CAAC;IACF,MAAM,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,CAAC;AAC/D,CAAC;AASD;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CACxC,aAAa,EACb,GAAgB,EAAE;IACd,OAAO,SAAS,WAAW,CACvB,aAA0E,EAC1E,cAA6E,EAC7E,SAAkE,EAClE,SAAS,GAAG,QAAQ,CAAC,IAAI;QAEzB,MAAM,MAAM,GAAG,0BAA0B,CAAC,aAAa,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;QACzG,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,OAAO,MAAM,CAAC,MAAM,CAAC;IACzB,CAAC,CAAC;AACN,CAAC,CACJ,CAAC","sourcesContent":["import { fromEvent, map, mergeWith, Observable, take } from \"rxjs\";\nimport { Injectable } from \"../dependency-injection/Injectable\";\nimport { LegalDocument, LegalDocument_Type } from \"../generated-proto/pb_schema/camera_kit/v3/legal_prompt\";\nimport { localizedString } from \"../common/localization\";\n\nfunction createCameraKitLegalPrompt(\n    privacyPolicyUrl: string,\n    termsOfServiceUrl: string,\n    learnMoreUrl: string\n): { element: HTMLDivElement; result: Observable<boolean>; focus: () => void } {\n    const element = document.createElement(\"div\");\n    element.id = \"tos-popup\";\n    const shadow = element.attachShadow({ mode: \"open\" });\n    const prompt = document.createElement(\"div\");\n    prompt.id = \"content\";\n\n    /* eslint-disable max-len */\n    prompt.innerHTML = `\n        <button id=\"reject\">\n        <svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\">\n            <title>${localizedString(\"legalPromptReject\")}</title>\n            <path\n                d=\"M 14.356 12.5 L 17.803 15.947 C 18.316 16.46 18.316 17.291 17.803 17.803 C 17.291 18.316 16.46 18.316 15.947 17.803 L 12.5 14.356 L 9.053 17.803 C 8.54 18.316 7.709 18.316 7.197 17.803 C 6.684 17.291 6.684 16.46 7.197 15.947 L 10.644 12.5 L 7.197 9.053 C 6.684 8.54 6.684 7.709 7.197 7.197 C 7.709 6.684 8.54 6.684 9.053 7.197 L 12.5 10.644 L 15.947 7.197 C 16.46 6.684 17.291 6.684 17.803 7.197 C 18.316 7.709 18.316 8.54 17.803 9.053 Z\"\n                fill=\"#a0a0a0\"\n            />\n        </svg>\n        </button>\n        <svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 32 32\">\n            <g>\n                <path\n                    d=\"M 30.898 23.477 C 30.77 23.045 30.148 22.743 30.148 22.743 C 30.092 22.71 30.039 22.684 29.994 22.663 C 28.962 22.161 28.048 21.561 27.277 20.876 C 26.659 20.325 26.128 19.719 25.701 19.074 C 25.182 18.288 24.937 17.632 24.831 17.275 C 24.773 17.043 24.782 16.951 24.831 16.832 C 24.873 16.731 24.99 16.632 25.049 16.588 C 25.397 16.341 25.96 15.976 26.303 15.75 C 26.602 15.556 26.859 15.389 27.009 15.283 C 27.494 14.944 27.824 14.596 28.02 14.223 C 28.275 13.74 28.303 13.208 28.107 12.684 C 27.84 11.978 27.184 11.556 26.35 11.556 C 26.163 11.556 25.974 11.577 25.785 11.62 C 25.308 11.723 24.852 11.894 24.474 12.042 C 24.446 12.054 24.416 12.032 24.418 12.002 C 24.457 11.059 24.502 9.79 24.399 8.584 C 24.306 7.493 24.082 6.576 23.717 5.776 C 23.351 4.972 22.874 4.376 22.5 3.947 C 22.143 3.536 21.519 2.936 20.577 2.394 C 19.251 1.631 17.742 1.244 16.09 1.244 C 14.443 1.244 12.934 1.631 11.605 2.394 C 10.607 2.966 9.97 3.614 9.678 3.947 C 9.304 4.376 8.827 4.972 8.46 5.776 C 8.096 6.576 7.872 7.496 7.778 8.584 C 7.673 9.792 7.715 10.96 7.76 11.999 C 7.762 12.03 7.732 12.051 7.704 12.039 C 7.325 11.892 6.87 11.72 6.393 11.617 C 6.204 11.575 6.012 11.554 5.828 11.554 C 4.994 11.554 4.337 11.976 4.071 12.682 C 3.875 13.205 3.903 13.738 4.157 14.221 C 4.354 14.594 4.685 14.941 5.169 15.281 C 5.318 15.387 5.575 15.553 5.874 15.748 C 6.211 15.968 6.758 16.323 7.108 16.569 C 7.152 16.599 7.299 16.712 7.346 16.827 C 7.397 16.951 7.404 17.045 7.341 17.289 C 7.234 17.648 6.989 18.298 6.479 19.069 C 6.052 19.715 5.522 20.32 4.902 20.871 C 4.132 21.556 3.218 22.157 2.186 22.658 C 2.137 22.682 2.078 22.712 2.015 22.748 C 2.015 22.748 1.399 23.064 1.282 23.472 C 1.109 24.075 1.567 24.64 2.036 24.943 C 2.8 25.438 3.732 25.703 4.272 25.849 C 4.421 25.889 4.559 25.926 4.683 25.964 C 4.76 25.989 4.956 26.062 5.038 26.17 C 5.143 26.306 5.155 26.473 5.192 26.66 C 5.253 26.977 5.384 27.373 5.774 27.643 C 6.204 27.941 6.75 27.962 7.444 27.99 C 8.168 28.018 9.07 28.054 10.1 28.394 C 10.579 28.553 11.011 28.818 11.514 29.128 C 12.56 29.773 13.864 30.578 16.09 30.578 C 18.318 30.578 19.629 29.768 20.685 29.119 C 21.183 28.811 21.612 28.546 22.08 28.391 C 23.11 28.049 24.011 28.014 24.735 27.988 C 25.427 27.962 25.974 27.941 26.404 27.641 C 26.822 27.35 26.943 26.918 26.997 26.59 C 27.027 26.428 27.046 26.285 27.14 26.165 C 27.219 26.064 27.399 25.992 27.483 25.964 C 27.609 25.924 27.751 25.886 27.906 25.844 C 28.445 25.698 29.123 25.527 29.945 25.061 C 30.933 24.511 31.001 23.82 30.898 23.477\"\n                    fill=\"#ffffff\"\n                    stroke=\"#00000000\"\n                    stroke-width=\"1\"\n                />\n            </g>\n            <g>\n                <path\n                    d=\"M 29.56 24.299 C 28.21 25.045 27.312 24.965 26.613 25.414 C 26.021 25.795 26.37 26.618 25.939 26.915 C 25.411 27.279 23.843 26.889 21.822 27.555 C 20.155 28.107 19.09 29.689 16.089 29.689 C 13.081 29.689 12.047 28.114 10.357 27.555 C 8.335 26.889 6.768 27.279 6.24 26.915 C 5.809 26.618 6.16 25.795 5.566 25.414 C 4.869 24.965 3.969 25.045 2.619 24.299 C 1.758 23.825 2.247 23.53 2.532 23.393 C 7.426 21.027 8.204 17.372 8.24 17.096 C 8.282 16.769 8.328 16.509 7.966 16.175 C 7.615 15.853 6.066 14.895 5.636 14.593 C 4.925 14.098 4.612 13.6 4.841 12.99 C 5 12.569 5.395 12.41 5.812 12.41 C 5.94 12.41 6.071 12.426 6.2 12.452 C 6.981 12.623 7.741 13.013 8.179 13.118 C 8.24 13.132 8.293 13.139 8.34 13.139 C 8.574 13.139 8.656 13.022 8.639 12.754 C 8.59 11.9 8.469 10.234 8.602 8.677 C 8.787 6.536 9.477 5.476 10.298 4.538 C 10.693 4.087 12.543 2.133 16.082 2.133 C 19.633 2.133 21.474 4.087 21.867 4.538 C 22.688 5.478 23.378 6.536 23.563 8.677 C 23.698 10.234 23.581 11.898 23.525 12.754 C 23.506 13.034 23.591 13.139 23.825 13.139 C 23.872 13.139 23.925 13.132 23.986 13.118 C 24.426 13.013 25.184 12.62 25.965 12.452 C 26.091 12.424 26.222 12.41 26.353 12.41 C 26.77 12.41 27.165 12.569 27.324 12.99 C 27.555 13.6 27.242 14.095 26.529 14.593 C 26.098 14.892 24.547 15.85 24.199 16.175 C 23.836 16.509 23.883 16.767 23.925 17.096 C 23.96 17.372 24.739 21.025 29.633 23.393 C 29.932 23.53 30.421 23.825 29.56 24.299 M 31.709 23.12 C 31.489 22.523 31.07 22.203 30.594 21.939 C 30.505 21.887 30.423 21.845 30.355 21.812 C 30.212 21.74 30.067 21.667 29.922 21.592 C 28.435 20.806 27.275 19.812 26.469 18.635 C 26.198 18.238 26.008 17.88 25.877 17.587 C 25.809 17.391 25.811 17.281 25.86 17.178 C 25.898 17.101 25.996 17.019 26.05 16.979 C 26.305 16.811 26.57 16.64 26.748 16.525 C 27.067 16.319 27.317 16.156 27.481 16.043 C 28.093 15.617 28.519 15.164 28.786 14.658 C 29.163 13.945 29.21 13.131 28.919 12.363 C 28.517 11.301 27.509 10.642 26.291 10.642 C 26.038 10.642 25.783 10.67 25.527 10.726 C 25.46 10.74 25.394 10.756 25.328 10.773 C 25.34 10.05 25.324 9.278 25.258 8.524 C 25.029 5.872 24.099 4.48 23.129 3.371 C 22.724 2.908 22.021 2.232 20.964 1.628 C 19.491 0.781 17.821 0.356 16 0.356 C 14.185 0.356 12.518 0.781 11.044 1.623 C 9.983 2.229 9.278 2.905 8.875 3.366 C 7.905 4.475 6.975 5.867 6.746 8.52 C 6.68 9.273 6.663 10.045 6.675 10.768 C 6.61 10.752 6.544 10.735 6.476 10.721 C 6.221 10.665 5.965 10.637 5.713 10.637 C 4.494 10.637 3.487 11.297 3.084 12.359 C 2.794 13.126 2.841 13.94 3.218 14.654 C 3.485 15.159 3.911 15.613 4.522 16.039 C 4.686 16.153 4.937 16.314 5.256 16.52 C 5.427 16.633 5.68 16.794 5.926 16.958 C 5.963 16.984 6.097 17.082 6.141 17.173 C 6.193 17.279 6.195 17.393 6.118 17.604 C 5.987 17.891 5.801 18.242 5.535 18.631 C 4.747 19.782 3.62 20.757 2.18 21.536 C 1.419 21.941 0.54 22.355 0.29 23.118 C 0.039 23.88 0.203 24.582 0.842 25.239 C 1.053 25.466 1.318 25.665 1.653 25.85 C 2.438 26.283 3.105 26.496 3.63 26.641 C 3.721 26.669 3.937 26.736 4.031 26.819 C 4.265 27.022 4.23 27.331 4.543 27.78 C 4.731 28.061 4.949 28.25 5.129 28.374 C 5.783 28.826 6.516 28.854 7.294 28.881 C 7.997 28.908 8.793 28.94 9.702 29.24 C 10.079 29.364 10.47 29.605 10.922 29.883 C 12.011 30.552 13.501 31.467 15.998 31.467 C 18.493 31.467 19.995 30.547 21.091 29.876 C 21.541 29.6 21.93 29.361 22.297 29.242 C 23.206 28.942 24.003 28.912 24.706 28.884 C 25.483 28.854 26.216 28.826 26.87 28.377 C 27.076 28.234 27.331 28.004 27.535 27.651 C 27.76 27.272 27.753 27.003 27.964 26.821 C 28.05 26.746 28.238 26.68 28.338 26.65 C 28.868 26.505 29.545 26.292 30.344 25.852 C 30.697 25.658 30.976 25.443 31.192 25.2 C 31.194 25.197 31.196 25.192 31.199 25.19 C 31.805 24.544 31.955 23.787 31.709 23.12\"\n                    fill=\"#000000\"\n                    stroke=\"#00000000\"\n                    stroke-width=\"1\"\n                />\n            </g>\n        </svg>\n        <p>${localizedString(\"legalPromptMessage\")({ privacyPolicyUrl, termsOfServiceUrl, learnMoreUrl })}</p>\n        <button id=\"accept\">${localizedString(\"legalPromptAccept\")}</button>\n    `;\n    /* eslint-enable */\n\n    const style = document.createElement(\"style\");\n    style.innerHTML = `\n        div#content {\n            display: flex;\n            flex-direction: column;\n\n            position: fixed;\n            top: 25%;\n            left: 50%;\n            transform: translate(-50%, -25%);\n\n            background-color: #fff;\n            border: #efefef 1px solid;\n            border-radius: 1.5rem;\n            box-shadow: rgba(0, 0, 0, 0.25) 0 1.5rem 2rem;\n\n            min-width: 16rem;\n            max-width: 20rem;\n            padding: 2rem;\n\n            text-align: center;\n            font-family: sans-serif;\n        }\n\n        div > svg {\n            height: 3rem;\n        }\n\n        div > p {\n            margin: 1rem 0;\n        }\n\n        div > p > a {\n            color: rgb(78, 171, 248);\n        }\n\n        div > button {\n            cursor: pointer;\n        }\n\n        div > button#reject {\n            align-self: flex-end;\n\n            position: absolute;\n\n            background-color: transparent;\n            border: 0;\n\n            width: 3rem;\n            margin: -1.5rem;\n        }\n\n        div > button#accept {\n            align-self: center;\n\n            background-color: rgb(78, 171, 248);\n            border: 0;\n            border-radius: 1.5rem;\n\n            width: 80%;\n            padding: 1rem;\n            margin-top: 1rem;\n\n            color: #fff;\n            font-size: 1.5rem;\n            font-weight: 700;\n            font-family: inherit;\n        }\n\n        div#overlay {\n            position: fixed;\n            top: 0;\n            right: 0;\n            bottom: 0;\n            left: 0;\n\n            background-color: rgba(0, 0, 0, 0.4);\n        }\n    `;\n\n    const overlay = document.createElement(\"div\");\n    overlay.id = \"overlay\";\n    shadow.appendChild(overlay);\n\n    shadow.appendChild(style);\n    shadow.appendChild(prompt);\n\n    const acceptBtn: HTMLButtonElement = prompt.querySelector(\"#accept\")!;\n    const rejectBtn: HTMLButtonElement = prompt.querySelector(\"#reject\")!;\n    const result = fromEvent(acceptBtn, \"click\").pipe(\n        map(() => true),\n        mergeWith(fromEvent(rejectBtn, \"click\").pipe(map(() => false))),\n        take(1)\n    );\n    result.subscribe({ complete: element.remove.bind(element) });\n    return { element, result, focus: () => rejectBtn.focus() };\n}\n\nexport type LegalPrompt = (\n    privacyPolicy: LegalDocument & { type: LegalDocument_Type.PRIVACY_POLICY },\n    termsOfService: LegalDocument & { type: LegalDocument_Type.TERMS_OF_SERVICE },\n    learnMore: LegalDocument & { type: LegalDocument_Type.LEARN_MORE },\n    container?: HTMLElement\n) => Observable<boolean>;\n\n/**\n * @internal\n */\nexport const legalPromptFactory = Injectable(\n    \"legalPrompt\",\n    (): LegalPrompt => {\n        return function legalPrompt(\n            privacyPolicy: LegalDocument & { type: LegalDocument_Type.PRIVACY_POLICY },\n            termsOfService: LegalDocument & { type: LegalDocument_Type.TERMS_OF_SERVICE },\n            learnMore: LegalDocument & { type: LegalDocument_Type.LEARN_MORE },\n            container = document.body\n        ): Observable<boolean> {\n            const prompt = createCameraKitLegalPrompt(privacyPolicy.webUrl, termsOfService.webUrl, learnMore.webUrl);\n            container.appendChild(prompt.element);\n            prompt.focus();\n            return prompt.result;\n        };\n    }\n);\n"]}

package/lib/legal/legalState.d.ts

@@ -0,0 +1,50 @@
+import { StateMachine } from "@snap/state-management";
+import { RemoteConfiguration } from "../remote-configuration/remoteConfiguration";
+import { LegalPrompt } from "./legalPrompt";
+declare const createLegalState: () => 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>>;
+export declare type LegalState = ReturnType<typeof createLegalState>;
+/**
+ * We maintain the state of the user's acceptance of Snap's various legal documents. Other components may require that
+ * the legal state be "accepted" before proceeding (e.g. to apply a lens).
+ *
+ * On page load, the legal state starts as "unknown." If a request is made to determine the legal state, the following
+ * business logic is implemented:
+ *
+ * 1. Download remote COF config value containing the legal documents + a `disabled` field to optionally skip the legal
+ * requirement.
+ * 2. Check for a `lastAcceptedTosContentHash` stored in IndexedDB.
+ * 3. Prompt the user to accept/reject the legal documents.
+ *
+ *                     ┌────────────────────────────────────────────────────────┐
+ *                     │       COF config value includes "disabled: true"       │
+ *                     └────────────────────────────────────────────────────────┘
+ *                                                  │
+ *                                                  │
+ *                           ┌────────No────────────┴────────────Yes──────────────────┐
+ *                           │                                                        │
+ *                           ▼                                                        │
+ *        ┌────────────────────────────────────┐                                      ▼
+ *        │"lastAcceptedTosContentHash" exists │                               ┌────────────┐
+ *        └────────────────────────────────────┘                               │  Skip ToS  │
+ *                           │                                                 └────────────┘
+ *                           │                                                        ▲
+ *        ┌─────────────No───┴───────Yes────────────┐                                 │
+ *        │                                         │                                 │
+ *        │                                         │                                 │
+ *        ▼                                         ▼                                 │
+ * ┌────────────┐              ┌────────────────────────────────────────┐             │
+ * │  Show ToS  │              │  Hash of ToS content from COF matches  │             │
+ * └────────────┘              │      "lastAcceptedTosContentHash"      │             │
+ *        ▲                    └────────────────────────────────────────┘             │
+ *        │                                         │                                 │
+ *        │                                         │                                 │
+ *        └──────────────────No─────────────────────┴───────────────────Yes───────────┘
+ *
+ * @internal
+ */
+export declare const legalStateFactory: {
+    (args_0: RemoteConfiguration, args_1: LegalPrompt): 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>>;
+    token: "legalState";
+    dependencies: readonly ["remoteConfiguration", "legalPrompt"];
+};
+export {};