@snap/camera-kit 0.7.0

package/lib/legal/legalState.js

@@ -0,0 +1,149 @@
+import { defineAction, defineActions, defineState, defineStates, dispatch, forActions, inStates, StateMachine, } from "@snap/state-management";
+import { catchError, from, map, merge, of, switchMap } from "rxjs";
+import { Injectable } from "../dependency-injection/Injectable";
+import { LegalDocument, LegalDocument_Type, LegalPrompt as LegalPromptProto, } from "../generated-proto/pb_schema/camera_kit/v3/legal_prompt";
+import { getLogger } from "../logger/logger";
+import { ExpiringPersistence } from "../persistence/ExpiringPersistence";
+import { IndexedDBPersistence } from "../persistence/IndexedDBPersistence";
+import { remoteConfigurationFactory } from "../remote-configuration/remoteConfiguration";
+import { legalPromptFactory } from "./legalPrompt";
+const logger = getLogger("LegalState");
+/**
+ * We store a hash of the last accepted ToS content. This is how we determine if the user previously accepted the
+ * relevant ToS.
+ *
+ * ToS acceptance is only valid for 12 hours. That is, if legal status is checked and the last acceptance occurred more
+ * than 12 hours ago, the user must be prompted to accept again.
+ */
+const tosContentHashExpiry = 12 * 60 * 60;
+const tosContentHashKey = "lastAcceptedTosContentHash";
+/**
+ * Fast, simple hashing function from github.com/bryc
+ * https://github.com/bryc/code/blob/master/jshash/experimental/cyrb53.js
+ */
+const computeHash = (str) => {
+    let h1 = 0xdeadbeef;
+    let h2 = 0x41c6ce57;
+    for (let i = 0; i < str.length; i++) {
+        const ch = str.charCodeAt(i);
+        h1 = Math.imul(h1 ^ ch, 2654435761);
+        h2 = Math.imul(h2 ^ ch, 1597334677);
+    }
+    h1 = Math.imul(h1 ^ (h1 >>> 16), 2246822507) ^ Math.imul(h2 ^ (h2 >>> 13), 3266489909);
+    h2 = Math.imul(h2 ^ (h2 >>> 16), 2246822507) ^ Math.imul(h1 ^ (h1 >>> 13), 3266489909);
+    return (4294967296 * (2097151 & h2) + (h1 >>> 0)).toString(16);
+};
+const createLegalState = () => {
+    const states = defineStates(defineState("unknown")(), defineState("accepted")(), defineState("rejected")());
+    const actions = defineActions(defineAction("requestLegalPrompt")(), defineAction("accept")(), defineAction("reject")());
+    return new StateMachine(actions, states, states.unknown(), (actions) => {
+        return merge(actions.pipe(inStates("unknown"), forActions("accept"), map(() => states.accepted())), actions.pipe(inStates("unknown"), forActions("reject"), map(() => states.rejected())), actions.pipe(forActions("requestLegalPrompt"), map(() => states.unknown())));
+    });
+};
+const defaultLegalDocumentDate = new Date("2021-09-30T00:00:00+00:00");
+const defaultLegalPrompt = LegalPromptProto.fromPartial({
+    documents: [
+        LegalDocument.fromPartial({
+            type: LegalDocument_Type.PRIVACY_POLICY,
+            webUrl: "https://values.snap.com/privacy/privacy-policy",
+            version: "1",
+            timestamp: defaultLegalDocumentDate,
+        }),
+        LegalDocument.fromPartial({
+            type: LegalDocument_Type.TERMS_OF_SERVICE,
+            webUrl: "https://snap.com/terms",
+            version: "1",
+            timestamp: defaultLegalDocumentDate,
+        }),
+        LegalDocument.fromPartial({
+            type: LegalDocument_Type.LEARN_MORE,
+            webUrl: "https://support.snapchat.com/article/camera-information-use",
+            version: "1",
+            timestamp: defaultLegalDocumentDate,
+        }),
+    ],
+    disabled: false,
+});
+const hasAnyValue = (c) => {
+    var _a, _b;
+    return ((_b = (_a = c.value) === null || _a === void 0 ? void 0 : _a.anyValue) === null || _b === void 0 ? void 0 : _b.value) instanceof Uint8Array;
+};
+const getDocumentOrDefault = (documents) => (type) => {
+    var _a;
+    return ((_a = documents.find((d) => d.type === type)) !== null && _a !== void 0 ? _a : defaultLegalPrompt.documents.find((d) => d.type === type));
+};
+/**
+ * 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 const legalStateFactory = Injectable("legalState", [remoteConfigurationFactory.token, legalPromptFactory.token], (remoteConfig, legalPrompt) => {
+    const persistance = new ExpiringPersistence(() => tosContentHashExpiry, new IndexedDBPersistence({ databaseName: "Legal" }));
+    const getLastAcceptedTosContentHash = () => from(persistance.retrieve(tosContentHashKey).catch((error) => logger.warn(error)));
+    const setLastAcceptedTosContentHash = (hash) => persistance.store(tosContentHashKey, hash).catch((error) => logger.warn(error));
+    const legalState = createLegalState();
+    legalState.events
+        .pipe(inStates("unknown", "rejected"), forActions("requestLegalPrompt"), switchMap(() => remoteConfig.get("CAMERA_KIT_LEGAL_PROMPT").pipe(map((configResults) => {
+        const config = configResults.find(hasAnyValue);
+        if (!config)
+            return defaultLegalPrompt;
+        return LegalPromptProto.decode(config.value.anyValue.value);
+    }), catchError((error) => {
+        logger.error(error);
+        return of(defaultLegalPrompt);
+    }))), switchMap((config) => {
+        if (config.disabled)
+            return of(legalState.actions.accept("disabled"));
+        const currentTosContentHash = computeHash(JSON.stringify(config.documents));
+        return getLastAcceptedTosContentHash().pipe(switchMap((lastAcceptedTosContentHash) => {
+            if (currentTosContentHash === lastAcceptedTosContentHash)
+                return of(true);
+            // Delegate prompting the end-user to accept/reject the legal documents. This returns with
+            // an Observable<boolean> indicating accept/reject.
+            const documentOfType = getDocumentOrDefault(config.documents);
+            return legalPrompt(documentOfType(LegalDocument_Type.PRIVACY_POLICY), documentOfType(LegalDocument_Type.TERMS_OF_SERVICE), documentOfType(LegalDocument_Type.LEARN_MORE));
+        }), map((didAccept) => {
+            if (!didAccept)
+                return legalState.actions.reject(currentTosContentHash);
+            setLastAcceptedTosContentHash(currentTosContentHash);
+            return legalState.actions.accept(currentTosContentHash);
+        }));
+    }), dispatch(legalState))
+        .subscribe();
+    return legalState;
+});
+//# sourceMappingURL=legalState.js.map

package/lib/legal/legalState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"legalState.js","sourceRoot":"","sources":["../../src/legal/legalState.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,YAAY,EACZ,aAAa,EACb,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,YAAY,GACf,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EACH,aAAa,EACb,kBAAkB,EAClB,WAAW,IAAI,gBAAgB,GAClC,MAAM,yDAAyD,CAAC;AAEjE,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAuB,0BAA0B,EAAE,MAAM,6CAA6C,CAAC;AAC9G,OAAO,EAAe,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEhE,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;AAOvC;;;;;;GAMG;AACH,MAAM,oBAAoB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAC1C,MAAM,iBAAiB,GAAG,4BAA4B,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,GAAG,CAAC,GAAW,EAAU,EAAE;IACxC,IAAI,EAAE,GAAG,UAAU,CAAC;IACpB,IAAI,EAAE,GAAG,UAAU,CAAC;IACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACjC,MAAM,EAAE,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC7B,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,EAAE,UAAU,CAAC,CAAC;QACpC,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,EAAE,UAAU,CAAC,CAAC;KACvC;IACD,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;IACvF,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;IACvF,OAAO,CAAC,UAAU,GAAG,CAAC,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AACnE,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,GAAG,EAAE;IAC1B,MAAM,MAAM,GAAG,YAAY,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAE5G,MAAM,OAAO,GAAG,aAAa,CACzB,YAAY,CAAC,oBAAoB,CAAC,EAAE,EACpC,YAAY,CAAC,QAAQ,CAAC,EAAU,EAChC,YAAY,CAAC,QAAQ,CAAC,EAAU,CACnC,CAAC;IAEF,OAAO,IAAI,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,EAAE,EAAE;QACnE,OAAO,KAAK,CACR,OAAO,CAAC,IAAI,CACR,QAAQ,CAAC,SAAS,CAAC,EACnB,UAAU,CAAC,QAAQ,CAAC,EACpB,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAC/B,EACD,OAAO,CAAC,IAAI,CACR,QAAQ,CAAC,SAAS,CAAC,EACnB,UAAU,CAAC,QAAQ,CAAC,EACpB,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAC/B,EACD,OAAO,CAAC,IAAI,CACR,UAAU,CAAC,oBAAoB,CAAC,EAChC,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAC9B,CACJ,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,IAAI,IAAI,CAAC,2BAA2B,CAAC,CAAC;AACvE,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,WAAW,CAAC;IACpD,SAAS,EAAE;QACP,aAAa,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,kBAAkB,CAAC,cAAc;YACvC,MAAM,EAAE,gDAAgD;YACxD,OAAO,EAAE,GAAG;YACZ,SAAS,EAAE,wBAAwB;SACtC,CAAC;QACF,aAAa,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;YACzC,MAAM,EAAE,wBAAwB;YAChC,OAAO,EAAE,GAAG;YACZ,SAAS,EAAE,wBAAwB;SACtC,CAAC;QACF,aAAa,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,kBAAkB,CAAC,UAAU;YACnC,MAAM,EAAE,6DAA6D;YACrE,OAAO,EAAE,GAAG;YACZ,SAAS,EAAE,wBAAwB;SACtC,CAAC;KACL;IACD,QAAQ,EAAE,KAAK;CAClB,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,CAAC,CAAe,EAAsE,EAAE;;IACxG,OAAO,CAAA,MAAA,MAAA,CAAC,CAAC,KAAK,0CAAE,QAAQ,0CAAE,KAAK,aAAY,UAAU,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,SAA0B,EAAE,EAAE,CAAC,CACzD,IAAO,EACoB,EAAE;;IAC7B,OAAO,CAAC,MAAA,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,mCAC1C,kBAAkB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAE,CAAgC,CAAC;AACnG,CAAC,CAAC;AAIF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CACvC,YAAY,EACZ,CAAC,0BAA0B,CAAC,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAU,EACrE,CAAC,YAAiC,EAAE,WAAwB,EAAc,EAAE;IACxE,MAAM,WAAW,GAAG,IAAI,mBAAmB,CACvC,GAAG,EAAE,CAAC,oBAAoB,EAC1B,IAAI,oBAAoB,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CACtD,CAAC;IACF,MAAM,6BAA6B,GAAG,GAAG,EAAE,CACvC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEvF,MAAM,6BAA6B,GAAG,CAAC,IAAY,EAAE,EAAE,CACnD,WAAW,CAAC,KAAK,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAEpF,MAAM,UAAU,GAAG,gBAAgB,EAAE,CAAC;IAEtC,UAAU,CAAC,MAAM;SACZ,IAAI,CACD,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,EAC/B,UAAU,CAAC,oBAAoB,CAAC,EAChC,SAAS,CAAC,GAAG,EAAE,CACX,YAAY,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,IAAI,CAC5C,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE;QAClB,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM;YAAE,OAAO,kBAAkB,CAAC;QACvC,OAAO,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC,CAAC,EACF,UAAU,CAAC,CAAC,KAAK,EAAE,EAAE;QACjB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACpB,OAAO,EAAE,CAAC,kBAAkB,CAAC,CAAC;IAClC,CAAC,CAAC,CACL,CACJ,EACD,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE;QACjB,IAAI,MAAM,CAAC,QAAQ;YAAE,OAAO,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QAEtE,MAAM,qBAAqB,GAAG,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QAE5E,OAAO,6BAA6B,EAAE,CAAC,IAAI,CACvC,SAAS,CAAC,CAAC,0BAA0B,EAAE,EAAE;YACrC,IAAI,qBAAqB,KAAK,0BAA0B;gBAAE,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;YAE1E,0FAA0F;YAC1F,mDAAmD;YACnD,MAAM,cAAc,GAAG,oBAAoB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC9D,OAAO,WAAW,CACd,cAAc,CAAC,kBAAkB,CAAC,cAAc,CAAC,EACjD,cAAc,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EACnD,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAChD,CAAC;QACN,CAAC,CAAC,EACF,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;YACd,IAAI,CAAC,SAAS;gBAAE,OAAO,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;YACxE,6BAA6B,CAAC,qBAAqB,CAAC,CAAC;YACrD,OAAO,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAC5D,CAAC,CAAC,CACL,CAAC;IACN,CAAC,CAAC,EACF,QAAQ,CAAC,UAAU,CAAC,CACvB;SACA,SAAS,EAAE,CAAC;IAEjB,OAAO,UAAU,CAAC;AACtB,CAAC,CACJ,CAAC","sourcesContent":["import {\n    defineAction,\n    defineActions,\n    defineState,\n    defineStates,\n    dispatch,\n    forActions,\n    inStates,\n    StateMachine,\n} from \"@snap/state-management\";\nimport { catchError, from, map, merge, of, switchMap } from \"rxjs\";\nimport { Injectable } from \"../dependency-injection/Injectable\";\nimport {\n    LegalDocument,\n    LegalDocument_Type,\n    LegalPrompt as LegalPromptProto,\n} from \"../generated-proto/pb_schema/camera_kit/v3/legal_prompt\";\nimport { ConfigResult } from \"../generated-proto/pb_schema/cdp/cof/config_result\";\nimport { getLogger } from \"../logger/logger\";\nimport { ExpiringPersistence } from \"../persistence/ExpiringPersistence\";\nimport { IndexedDBPersistence } from \"../persistence/IndexedDBPersistence\";\nimport { RemoteConfiguration, remoteConfigurationFactory } from \"../remote-configuration/remoteConfiguration\";\nimport { LegalPrompt, legalPromptFactory } from \"./legalPrompt\";\n\nconst logger = getLogger(\"LegalState\");\n\ntype SupportedDocumentType =\n    | LegalDocument_Type.PRIVACY_POLICY\n    | LegalDocument_Type.TERMS_OF_SERVICE\n    | LegalDocument_Type.LEARN_MORE;\n\n/**\n * We store a hash of the last accepted ToS content. This is how we determine if the user previously accepted the\n * relevant ToS.\n *\n * ToS acceptance is only valid for 12 hours. That is, if legal status is checked and the last acceptance occurred more\n * than 12 hours ago, the user must be prompted to accept again.\n */\nconst tosContentHashExpiry = 12 * 60 * 60;\nconst tosContentHashKey = \"lastAcceptedTosContentHash\";\n\n/**\n * Fast, simple hashing function from github.com/bryc\n * https://github.com/bryc/code/blob/master/jshash/experimental/cyrb53.js\n */\nconst computeHash = (str: string): string => {\n    let h1 = 0xdeadbeef;\n    let h2 = 0x41c6ce57;\n    for (let i = 0; i < str.length; i++) {\n        const ch = str.charCodeAt(i);\n        h1 = Math.imul(h1 ^ ch, 2654435761);\n        h2 = Math.imul(h2 ^ ch, 1597334677);\n    }\n    h1 = Math.imul(h1 ^ (h1 >>> 16), 2246822507) ^ Math.imul(h2 ^ (h2 >>> 13), 3266489909);\n    h2 = Math.imul(h2 ^ (h2 >>> 16), 2246822507) ^ Math.imul(h1 ^ (h1 >>> 13), 3266489909);\n    return (4294967296 * (2097151 & h2) + (h1 >>> 0)).toString(16);\n};\n\nconst createLegalState = () => {\n    const states = defineStates(defineState(\"unknown\")(), defineState(\"accepted\")(), defineState(\"rejected\")());\n\n    const actions = defineActions(\n        defineAction(\"requestLegalPrompt\")(),\n        defineAction(\"accept\")<string>(),\n        defineAction(\"reject\")<string>()\n    );\n\n    return new StateMachine(actions, states, states.unknown(), (actions) => {\n        return merge(\n            actions.pipe(\n                inStates(\"unknown\"),\n                forActions(\"accept\"),\n                map(() => states.accepted())\n            ),\n            actions.pipe(\n                inStates(\"unknown\"),\n                forActions(\"reject\"),\n                map(() => states.rejected())\n            ),\n            actions.pipe(\n                forActions(\"requestLegalPrompt\"),\n                map(() => states.unknown())\n            )\n        );\n    });\n};\n\nconst defaultLegalDocumentDate = new Date(\"2021-09-30T00:00:00+00:00\");\nconst defaultLegalPrompt = LegalPromptProto.fromPartial({\n    documents: [\n        LegalDocument.fromPartial({\n            type: LegalDocument_Type.PRIVACY_POLICY,\n            webUrl: \"https://values.snap.com/privacy/privacy-policy\",\n            version: \"1\",\n            timestamp: defaultLegalDocumentDate,\n        }),\n        LegalDocument.fromPartial({\n            type: LegalDocument_Type.TERMS_OF_SERVICE,\n            webUrl: \"https://snap.com/terms\",\n            version: \"1\",\n            timestamp: defaultLegalDocumentDate,\n        }),\n        LegalDocument.fromPartial({\n            type: LegalDocument_Type.LEARN_MORE,\n            webUrl: \"https://support.snapchat.com/article/camera-information-use\",\n            version: \"1\",\n            timestamp: defaultLegalDocumentDate,\n        }),\n    ],\n    disabled: false,\n});\n\nconst hasAnyValue = (c: ConfigResult): c is ConfigResult & { value: { anyValue: { value: Uint8Array } } } => {\n    return c.value?.anyValue?.value instanceof Uint8Array;\n};\n\nconst getDocumentOrDefault = (documents: LegalDocument[]) => <T extends SupportedDocumentType>(\n    type: T\n): LegalDocument & { type: T } => {\n    return (documents.find((d) => d.type === type) ??\n        defaultLegalPrompt.documents.find((d) => d.type === type)!) as LegalDocument & { type: T };\n};\n\nexport type LegalState = ReturnType<typeof createLegalState>;\n\n/**\n * We maintain the state of the user's acceptance of Snap's various legal documents. Other components may require that\n * the legal state be \"accepted\" before proceeding (e.g. to apply a lens).\n *\n * On page load, the legal state starts as \"unknown.\" If a request is made to determine the legal state, the following\n * business logic is implemented:\n *\n * 1. Download remote COF config value containing the legal documents + a `disabled` field to optionally skip the legal\n * requirement.\n * 2. Check for a `lastAcceptedTosContentHash` stored in IndexedDB.\n * 3. Prompt the user to accept/reject the legal documents.\n *\n *                     ┌────────────────────────────────────────────────────────┐\n *                     │       COF config value includes \"disabled: true\"       │\n *                     └────────────────────────────────────────────────────────┘\n *                                                  │\n *                                                  │\n *                           ┌────────No────────────┴────────────Yes──────────────────┐\n *                           │                                                        │\n *                           ▼                                                        │\n *        ┌────────────────────────────────────┐                                      ▼\n *        │\"lastAcceptedTosContentHash\" exists │                               ┌────────────┐\n *        └────────────────────────────────────┘                               │  Skip ToS  │\n *                           │                                                 └────────────┘\n *                           │                                                        ▲\n *        ┌─────────────No───┴───────Yes────────────┐                                 │\n *        │                                         │                                 │\n *        │                                         │                                 │\n *        ▼                                         ▼                                 │\n * ┌────────────┐              ┌────────────────────────────────────────┐             │\n * │  Show ToS  │              │  Hash of ToS content from COF matches  │             │\n * └────────────┘              │      \"lastAcceptedTosContentHash\"      │             │\n *        ▲                    └────────────────────────────────────────┘             │\n *        │                                         │                                 │\n *        │                                         │                                 │\n *        └──────────────────No─────────────────────┴───────────────────Yes───────────┘\n *\n * @internal\n */\nexport const legalStateFactory = Injectable(\n    \"legalState\",\n    [remoteConfigurationFactory.token, legalPromptFactory.token] as const,\n    (remoteConfig: RemoteConfiguration, legalPrompt: LegalPrompt): LegalState => {\n        const persistance = new ExpiringPersistence<string>(\n            () => tosContentHashExpiry,\n            new IndexedDBPersistence({ databaseName: \"Legal\" })\n        );\n        const getLastAcceptedTosContentHash = () =>\n            from(persistance.retrieve(tosContentHashKey).catch((error) => logger.warn(error)));\n\n        const setLastAcceptedTosContentHash = (hash: string) =>\n            persistance.store(tosContentHashKey, hash).catch((error) => logger.warn(error));\n\n        const legalState = createLegalState();\n\n        legalState.events\n            .pipe(\n                inStates(\"unknown\", \"rejected\"),\n                forActions(\"requestLegalPrompt\"),\n                switchMap(() =>\n                    remoteConfig.get(\"CAMERA_KIT_LEGAL_PROMPT\").pipe(\n                        map((configResults) => {\n                            const config = configResults.find(hasAnyValue);\n                            if (!config) return defaultLegalPrompt;\n                            return LegalPromptProto.decode(config.value.anyValue.value);\n                        }),\n                        catchError((error) => {\n                            logger.error(error);\n                            return of(defaultLegalPrompt);\n                        })\n                    )\n                ),\n                switchMap((config) => {\n                    if (config.disabled) return of(legalState.actions.accept(\"disabled\"));\n\n                    const currentTosContentHash = computeHash(JSON.stringify(config.documents));\n\n                    return getLastAcceptedTosContentHash().pipe(\n                        switchMap((lastAcceptedTosContentHash) => {\n                            if (currentTosContentHash === lastAcceptedTosContentHash) return of(true);\n\n                            // Delegate prompting the end-user to accept/reject the legal documents. This returns with\n                            // an Observable<boolean> indicating accept/reject.\n                            const documentOfType = getDocumentOrDefault(config.documents);\n                            return legalPrompt(\n                                documentOfType(LegalDocument_Type.PRIVACY_POLICY),\n                                documentOfType(LegalDocument_Type.TERMS_OF_SERVICE),\n                                documentOfType(LegalDocument_Type.LEARN_MORE)\n                            );\n                        }),\n                        map((didAccept) => {\n                            if (!didAccept) return legalState.actions.reject(currentTosContentHash);\n                            setLastAcceptedTosContentHash(currentTosContentHash);\n                            return legalState.actions.accept(currentTosContentHash);\n                        })\n                    );\n                }),\n                dispatch(legalState)\n            )\n            .subscribe();\n\n        return legalState;\n    }\n);\n"]}

package/lib/lens/Lens.d.ts

@@ -0,0 +1,71 @@
+import { Content, Lens_CameraFacing, Preview, Lens as LensGeneratedProto, LensCreator } from "../generated-proto/pb_schema/camera_kit/v3/lens";
+import { GetGroupResponse } from "../generated-proto/pb_schema/camera_kit/v3/service";
+/**
+ * @internal
+ */
+export declare type ContentProto = Omit<Content, "lnsUrl" | "iconUrl">;
+/**
+ * @internal
+ */
+export interface LensProto extends Omit<LensGeneratedProto, "content"> {
+    content: ContentProto | undefined;
+}
+/**
+ * @category Lenses
+ */
+export interface Lens {
+    /**
+     * Non-empty identifier of a unique lens available to be applied in current session.
+     *
+     * NOTE: This value may contain unsafe characters
+     * and therefore may require additional processing depending on usages.
+     */
+    id: string;
+    /**
+     * Human readable name of this lens.
+     *
+     * NOTE: This value may contain unsafe characters
+     * and therefore may require additional processing depending on usages.
+     */
+    name: string;
+    /**
+     * Icon resource URI that represents this lens if available.
+     */
+    iconUrl: string | undefined;
+    /**
+     * Vendor specific metadata associated with this lens, empty by default.
+     *
+     * NOTE: Metadata values may contain unsafe characters
+     * and therefore may require additional processing depending on usages.
+     */
+    vendorData: {
+        [key: string]: string;
+    };
+    /**
+     * Specifies a [Lens_CameraFacing] that this lens is designed for.
+     */
+    cameraFacingPreference: Lens_CameraFacing;
+    /**
+     *  Preview that represents this lens if available.
+     */
+    preview: Preview | undefined;
+    /**
+     * Information about the lens creator.
+     */
+    lensCreator: LensCreator | undefined;
+}
+export declare function isLensArray(value: unknown): value is Lens[];
+export declare function isLens(value: unknown): value is Lens;
+export declare function isLensProto(value: unknown): value is LensProto;
+export declare function isPreview(value: unknown): value is Preview;
+export declare function isLensCreator(value: unknown): value is LensCreator;
+export declare function isLensContent(value: unknown): value is ContentProto;
+export declare function isGetGroupResponse(value: unknown): value is GetGroupResponse;
+/**
+ * Converts lens proto to a public lens object.
+ * @param lens Lens proto
+ * @returns Public lens object.
+ *
+ * @internal
+ */
+export declare function toPublicLens({ id, name, content, vendorData, cameraFacingPreference, lensCreator }: LensProto): Lens;

package/lib/lens/Lens.js

@@ -0,0 +1,63 @@
+import { assert } from "../common/assertions";
+import { predicateRecordValues, isRecord, isString, isUndefined, isEmptyOrSafeUrl, isArrayOfType, } from "../common/typeguards";
+export function isLensArray(value) {
+    return isArrayOfType(isLens, value);
+}
+export function isLens(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        isString(value.name) &&
+        (isUndefined(value.iconUrl) || isString(value.iconUrl)) &&
+        isRecord(value.vendorData) &&
+        predicateRecordValues(isString)(value.vendorData) &&
+        isString(value.cameraFacingPreference) &&
+        (isUndefined(value.preview) || isPreview(value.preview)) &&
+        (isUndefined(value.lensCreator) || isLensCreator(value.lensCreator)));
+}
+export function isLensProto(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        isString(value.name) &&
+        isRecord(value.vendorData) &&
+        predicateRecordValues(isString)(value.vendorData) &&
+        (typeof value.content === "undefined" || isLensContent(value.content)));
+}
+export function isPreview(value) {
+    return isRecord(value) && isString(value.imageUrl);
+}
+export function isLensCreator(value) {
+    return isRecord(value) && isString(value.displayName);
+}
+export function isLensContent(value) {
+    return (isRecord(value) &&
+        isString(value.iconUrlBolt) &&
+        isString(value.lnsSha256) &&
+        isString(value.lnsUrlBolt) &&
+        isRecord(value.preview) &&
+        isString(value.preview.imageUrl));
+}
+export function isGetGroupResponse(value) {
+    return isRecord(value) && isString(value.id) && Array.isArray(value.lenses) && value.lenses.every(isLensProto);
+}
+/**
+ * Converts lens proto to a public lens object.
+ * @param lens Lens proto
+ * @returns Public lens object.
+ *
+ * @internal
+ */
+export function toPublicLens({ id, name, content, vendorData, cameraFacingPreference, lensCreator }) {
+    var _a;
+    assert(isEmptyOrSafeUrl(content === null || content === void 0 ? void 0 : content.iconUrlBolt), "Unsafe icon URL");
+    assert(isEmptyOrSafeUrl((_a = content === null || content === void 0 ? void 0 : content.preview) === null || _a === void 0 ? void 0 : _a.imageUrl), "Unsafe preview URL");
+    return {
+        id,
+        name,
+        iconUrl: content === null || content === void 0 ? void 0 : content.iconUrlBolt,
+        preview: content === null || content === void 0 ? void 0 : content.preview,
+        vendorData,
+        cameraFacingPreference,
+        lensCreator,
+    };
+}
+//# sourceMappingURL=Lens.js.map

package/lib/lens/Lens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Lens.js","sourceRoot":"","sources":["../../src/lens/Lens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EACH,qBAAqB,EACrB,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,aAAa,GAChB,MAAM,sBAAsB,CAAC;AAuE9B,MAAM,UAAU,WAAW,CAAC,KAAc;IACtC,OAAO,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,KAAc;IACjC,OAAO,CACH,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;QACpB,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvD,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC;QAC1B,qBAAqB,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;QACjD,QAAQ,CAAC,KAAK,CAAC,sBAAsB,CAAC;QACtC,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CACvE,CAAC;AACN,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAc;IACtC,OAAO,CACH,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;QACpB,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC;QAC1B,qBAAqB,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;QACjD,CAAC,OAAO,KAAK,CAAC,OAAO,KAAK,WAAW,IAAI,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CACzE,CAAC;AACN,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAc;IACpC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAc;IACxC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAc;IACxC,OAAO,CACH,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC;QAC3B,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC;QACzB,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC;QAC1B,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;QACvB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CACnC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC7C,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AACnH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,sBAAsB,EAAE,WAAW,EAAa;;IAC1G,MAAM,CAAC,gBAAgB,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,CAAC,EAAE,iBAAiB,CAAC,CAAC;IAClE,MAAM,CAAC,gBAAgB,CAAC,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,0CAAE,QAAQ,CAAC,EAAE,oBAAoB,CAAC,CAAC;IAC3E,OAAO;QACH,EAAE;QACF,IAAI;QACJ,OAAO,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW;QAC7B,OAAO,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO;QACzB,UAAU;QACV,sBAAsB;QACtB,WAAW;KACd,CAAC;AACN,CAAC","sourcesContent":["import { assert } from \"../common/assertions\";\nimport {\n    predicateRecordValues,\n    isRecord,\n    isString,\n    isUndefined,\n    isEmptyOrSafeUrl,\n    isArrayOfType,\n} from \"../common/typeguards\";\nimport {\n    Content,\n    Lens_CameraFacing,\n    Preview,\n    Lens as LensGeneratedProto,\n    LensCreator,\n} from \"../generated-proto/pb_schema/camera_kit/v3/lens\";\nimport { GetGroupResponse } from \"../generated-proto/pb_schema/camera_kit/v3/service\";\n\n/**\n * @internal\n */\nexport type ContentProto = Omit<Content, \"lnsUrl\" | \"iconUrl\">;\n\n/**\n * @internal\n */\nexport interface LensProto extends Omit<LensGeneratedProto, \"content\"> {\n    content: ContentProto | undefined;\n}\n\n/**\n * @category Lenses\n */\nexport interface Lens {\n    /**\n     * Non-empty identifier of a unique lens available to be applied in current session.\n     *\n     * NOTE: This value may contain unsafe characters\n     * and therefore may require additional processing depending on usages.\n     */\n    id: string;\n\n    /**\n     * Human readable name of this lens.\n     *\n     * NOTE: This value may contain unsafe characters\n     * and therefore may require additional processing depending on usages.\n     */\n    name: string;\n\n    /**\n     * Icon resource URI that represents this lens if available.\n     */\n    iconUrl: string | undefined;\n\n    /**\n     * Vendor specific metadata associated with this lens, empty by default.\n     *\n     * NOTE: Metadata values may contain unsafe characters\n     * and therefore may require additional processing depending on usages.\n     */\n    vendorData: { [key: string]: string };\n\n    /**\n     * Specifies a [Lens_CameraFacing] that this lens is designed for.\n     */\n    cameraFacingPreference: Lens_CameraFacing;\n\n    /**\n     *  Preview that represents this lens if available.\n     */\n    preview: Preview | undefined;\n\n    /**\n     * Information about the lens creator.\n     */\n    lensCreator: LensCreator | undefined;\n}\n\nexport function isLensArray(value: unknown): value is Lens[] {\n    return isArrayOfType(isLens, value);\n}\n\nexport function isLens(value: unknown): value is Lens {\n    return (\n        isRecord(value) &&\n        isString(value.id) &&\n        isString(value.name) &&\n        (isUndefined(value.iconUrl) || isString(value.iconUrl)) &&\n        isRecord(value.vendorData) &&\n        predicateRecordValues(isString)(value.vendorData) &&\n        isString(value.cameraFacingPreference) &&\n        (isUndefined(value.preview) || isPreview(value.preview)) &&\n        (isUndefined(value.lensCreator) || isLensCreator(value.lensCreator))\n    );\n}\n\nexport function isLensProto(value: unknown): value is LensProto {\n    return (\n        isRecord(value) &&\n        isString(value.id) &&\n        isString(value.name) &&\n        isRecord(value.vendorData) &&\n        predicateRecordValues(isString)(value.vendorData) &&\n        (typeof value.content === \"undefined\" || isLensContent(value.content))\n    );\n}\n\nexport function isPreview(value: unknown): value is Preview {\n    return isRecord(value) && isString(value.imageUrl);\n}\n\nexport function isLensCreator(value: unknown): value is LensCreator {\n    return isRecord(value) && isString(value.displayName);\n}\n\nexport function isLensContent(value: unknown): value is ContentProto {\n    return (\n        isRecord(value) &&\n        isString(value.iconUrlBolt) &&\n        isString(value.lnsSha256) &&\n        isString(value.lnsUrlBolt) &&\n        isRecord(value.preview) &&\n        isString(value.preview.imageUrl)\n    );\n}\n\nexport function isGetGroupResponse(value: unknown): value is GetGroupResponse {\n    return isRecord(value) && isString(value.id) && Array.isArray(value.lenses) && value.lenses.every(isLensProto);\n}\n\n/**\n * Converts lens proto to a public lens object.\n * @param lens Lens proto\n * @returns Public lens object.\n *\n * @internal\n */\nexport function toPublicLens({ id, name, content, vendorData, cameraFacingPreference, lensCreator }: LensProto): Lens {\n    assert(isEmptyOrSafeUrl(content?.iconUrlBolt), \"Unsafe icon URL\");\n    assert(isEmptyOrSafeUrl(content?.preview?.imageUrl), \"Unsafe preview URL\");\n    return {\n        id,\n        name,\n        iconUrl: content?.iconUrlBolt,\n        preview: content?.preview,\n        vendorData,\n        cameraFacingPreference,\n        lensCreator,\n    };\n}\n"]}

package/lib/lens/LensLaunchParams.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Various lenses may support the passing of certain parameters from the application to the lens when it is launched.
+ *
+ * @category Lenses
+ */
+export declare type LensLaunchParams = Record<string, string | number | string[] | number[]>;
+export declare type LaunchDetails = {
+    launchParams?: LensLaunchParams;
+    persistentStore?: ArrayBuffer;
+};
+/**
+ * @internal
+ */
+export declare function isLaunchParamsValid(launchParams: unknown): launchParams is LensLaunchParams;
+/**
+ * @param launchDetails
+ * @internal
+ */
+export declare const createLaunchData: ({ launchParams, persistentStore }: LaunchDetails) => Uint8Array;

package/lib/lens/LensLaunchParams.js

@@ -0,0 +1,38 @@
+import { LaunchData } from "../generated-proto/pb_schema/lenses/launchdata";
+import { isNumber, isRecord, isString } from "../common/typeguards";
+const isNotValid = (value) => !(isString(value) || isValidNumber(value));
+const isValidNumber = (value) => isNumber(value) && !Number.isNaN(value) && Number.isFinite(value);
+/**
+ * @internal
+ */
+export function isLaunchParamsValid(launchParams) {
+    if (!isRecord(launchParams) || launchParams instanceof Date) {
+        throw new Error("should be a record <string, number | string | string[] | number[]>");
+    }
+    for (const value of Object.values(launchParams)) {
+        if (Array.isArray(value)) {
+            if (!value.every(isString) && !value.every(isValidNumber)) {
+                throw new Error("only number, string, string[], number[] values are allowed");
+            }
+        }
+        else if (isNotValid(value)) {
+            throw new Error("only number, string, string[], number[] values are allowed");
+        }
+    }
+    return true;
+}
+/**
+ * @param launchDetails
+ * @internal
+ */
+export const createLaunchData = ({ launchParams, persistentStore }) => 
+// finish() protobufjs method returns UInt8Array with shared ArrayBuffer
+// to avoid of detached buffer error when passing data to Lens Core
+// data should be copied using slice() method
+LaunchData.encode(LaunchData.fromPartial(Object.assign(Object.assign({}, (launchParams &&
+    isLaunchParamsValid(launchParams) && {
+    launchParams: { data: new TextEncoder().encode(JSON.stringify(launchParams)) },
+})), (persistentStore && { persistentStore: { store: new Uint8Array(persistentStore) } }))))
+    .finish()
+    .slice();
+//# sourceMappingURL=LensLaunchParams.js.map

package/lib/lens/LensLaunchParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LensLaunchParams.js","sourceRoot":"","sources":["../../src/lens/LensLaunchParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gDAAgD,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEpE,MAAM,UAAU,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AAElF,MAAM,aAAa,GAAG,CAAC,KAAc,EAAmB,EAAE,CACtD,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AActE;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,YAAqB;IACrD,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,YAAY,YAAY,IAAI,EAAE;QACzD,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;KACzF;IAED,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;QAC7C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACtB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;aACjF;SACJ;aAAM,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;SACjF;KACJ;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,EAAE,YAAY,EAAE,eAAe,EAAiB,EAAE,EAAE;AACjF,wEAAwE;AACxE,mEAAmE;AACnE,6CAA6C;AAC7C,UAAU,CAAC,MAAM,CACb,UAAU,CAAC,WAAW,iCACf,CAAC,YAAY;IACZ,mBAAmB,CAAC,YAAY,CAAC,IAAI;IACjC,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,EAAE;CACjF,CAAC,GACH,CAAC,eAAe,IAAI,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,IAAI,UAAU,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC,EACzF,CACL;KACI,MAAM,EAAE;KACR,KAAK,EAAE,CAAC","sourcesContent":["import { LaunchData } from \"../generated-proto/pb_schema/lenses/launchdata\";\nimport { isNumber, isRecord, isString } from \"../common/typeguards\";\n\nconst isNotValid = (value: unknown) => !(isString(value) || isValidNumber(value));\n\nconst isValidNumber = (value: unknown): value is number =>\n    isNumber(value) && !Number.isNaN(value) && Number.isFinite(value);\n\n/**\n * Various lenses may support the passing of certain parameters from the application to the lens when it is launched.\n *\n * @category Lenses\n */\nexport type LensLaunchParams = Record<string, string | number | string[] | number[]>;\n\nexport type LaunchDetails = {\n    launchParams?: LensLaunchParams;\n    persistentStore?: ArrayBuffer;\n};\n\n/**\n * @internal\n */\nexport function isLaunchParamsValid(launchParams: unknown): launchParams is LensLaunchParams {\n    if (!isRecord(launchParams) || launchParams instanceof Date) {\n        throw new Error(\"should be a record <string, number | string | string[] | number[]>\");\n    }\n\n    for (const value of Object.values(launchParams)) {\n        if (Array.isArray(value)) {\n            if (!value.every(isString) && !value.every(isValidNumber)) {\n                throw new Error(\"only number, string, string[], number[] values are allowed\");\n            }\n        } else if (isNotValid(value)) {\n            throw new Error(\"only number, string, string[], number[] values are allowed\");\n        }\n    }\n\n    return true;\n}\n\n/**\n * @param launchDetails\n * @internal\n */\nexport const createLaunchData = ({ launchParams, persistentStore }: LaunchDetails) =>\n    // finish() protobufjs method returns UInt8Array with shared ArrayBuffer\n    // to avoid of detached buffer error when passing data to Lens Core\n    // data should be copied using slice() method\n    LaunchData.encode(\n        LaunchData.fromPartial({\n            ...(launchParams &&\n                isLaunchParamsValid(launchParams) && {\n                    launchParams: { data: new TextEncoder().encode(JSON.stringify(launchParams)) },\n                }),\n            ...(persistentStore && { persistentStore: { store: new Uint8Array(persistentStore) } }),\n        })\n    )\n        .finish()\n        .slice();\n"]}

package/lib/lens/LensPersistenceStore.d.ts

@@ -0,0 +1,7 @@
+import { LensCoreModule } from "../lens-core-module";
+import { IndexedDBPersistence } from "../persistence/IndexedDBPersistence";
+export declare const lensPersistenceStoreFactory: {
+    (args_0: LensCoreModule): IndexedDBPersistence<ArrayBuffer>;
+    token: "lensPersistenceStore";
+    dependencies: readonly ["lensCore"];
+};

package/lib/lens/LensPersistenceStore.js

@@ -0,0 +1,20 @@
+import { __awaiter } from "tslib";
+import { Injectable } from "../dependency-injection/Injectable";
+import { persistentStoreError } from "../namedErrors";
+import { lensCoreFactory } from "../lens-core-module";
+import { getLogger } from "../logger/logger";
+import { IndexedDBPersistence } from "../persistence/IndexedDBPersistence";
+const logger = getLogger("LensPersistenceStore");
+export const lensPersistenceStoreFactory = Injectable("lensPersistenceStore", [lensCoreFactory.token], (lensCore) => {
+    const db = new IndexedDBPersistence({ databaseName: "lensPersistenceStore" });
+    lensCore.registerSavePersistentStoreCallback((id, data) => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            yield db.store(id, data);
+        }
+        catch (error) {
+            logger.error(persistentStoreError(`Unable to store data for lens "${id}".`, error));
+        }
+    }));
+    return db;
+});
+//# sourceMappingURL=LensPersistenceStore.js.map

package/lib/lens/LensPersistenceStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LensPersistenceStore.js","sourceRoot":"","sources":["../../src/lens/LensPersistenceStore.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAkB,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAE3E,MAAM,MAAM,GAAG,SAAS,CAAC,sBAAsB,CAAC,CAAC;AAEjD,MAAM,CAAC,MAAM,2BAA2B,GAAG,UAAU,CACjD,sBAAsB,EACtB,CAAC,eAAe,CAAC,KAAK,CAAU,EAChC,CAAC,QAAwB,EAAqC,EAAE;IAC5D,MAAM,EAAE,GAAG,IAAI,oBAAoB,CAAc,EAAE,YAAY,EAAE,sBAAsB,EAAE,CAAC,CAAC;IAC3F,QAAQ,CAAC,mCAAmC,CAAC,CAAO,EAAE,EAAE,IAAI,EAAE,EAAE;QAC5D,IAAI;YACA,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SAC5B;QAAC,OAAO,KAAK,EAAE;YACZ,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,kCAAkC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;SACvF;IACL,CAAC,CAAA,CAAC,CAAC;IACH,OAAO,EAAE,CAAC;AACd,CAAC,CACJ,CAAC","sourcesContent":["import { Injectable } from \"../dependency-injection/Injectable\";\nimport { persistentStoreError } from \"../namedErrors\";\nimport { lensCoreFactory, LensCoreModule } from \"../lens-core-module\";\nimport { getLogger } from \"../logger/logger\";\nimport { IndexedDBPersistence } from \"../persistence/IndexedDBPersistence\";\n\nconst logger = getLogger(\"LensPersistenceStore\");\n\nexport const lensPersistenceStoreFactory = Injectable(\n    \"lensPersistenceStore\",\n    [lensCoreFactory.token] as const,\n    (lensCore: LensCoreModule): IndexedDBPersistence<ArrayBuffer> => {\n        const db = new IndexedDBPersistence<ArrayBuffer>({ databaseName: \"lensPersistenceStore\" });\n        lensCore.registerSavePersistentStoreCallback(async (id, data) => {\n            try {\n                await db.store(id, data);\n            } catch (error) {\n                logger.error(persistentStoreError(`Unable to store data for lens \"${id}\".`, error));\n            }\n        });\n        return db;\n    }\n);\n"]}

package/lib/lens/LensRepository.d.ts

@@ -0,0 +1,134 @@
+import { FetchHandler } from "../handlers/defaultFetchHandler";
+import { LensSources } from "../extensions/LensSources";
+import { LensDownloadDimensions } from "../metrics/reporters/reportLensAndAssetDownload";
+import { Handler } from "../handlers/HandlerChainBuilder";
+import { LensAssetManifestItem_RequestTiming } from "../generated-proto/pb_schema/camera_kit/v3/lens";
+import { Lens, LensProto } from "./Lens";
+import { LensAssetRepository } from "./assets/LensAssetRepository";
+declare type LensFetchHandler = Handler<[
+    RequestInfo,
+    LensDownloadDimensions
+], [
+    ArrayBuffer,
+    Response
+], RequestInit | undefined>;
+declare const assetTimingMap: {
+    required: LensAssetManifestItem_RequestTiming;
+    onDemand: LensAssetManifestItem_RequestTiming;
+};
+/**
+ * Lens assets are included in a manifest, and each will indicate when that asset will be used by the lens.
+ *
+ * Assets can have the following timing values:
+ * - `required`: the lens will definitely request this asset immediately when the lens is applied.
+ * - `onDemand`: the lens may request this asset at some time while the lens is applied.
+ *
+ * Depending on the use-case, an application may want to cache both required and onDemand assets for
+ * a particular lens, or may decide to only cache required assets (or cache no assets).
+ *
+ * @category Lenses
+ */
+export declare type AssetTiming = keyof typeof assetTimingMap;
+export interface LensGroupsQueryResponse {
+    errors: Error[];
+    lenses: Lens[];
+}
+export interface LensBinary {
+    lensBuffer: ArrayBuffer;
+    lensChecksum: string;
+}
+/**
+ * The LensRepository is used to query for lenses from specific lens groups, or for a lens with a specific ID.
+ *
+ * Lens groups are configured in the CameraKit Portal -- that's where you'll find lens group IDs and lens IDs.
+ *
+ * Lenses must be loaded by the LensRepository before they can be applied to a {@link CameraKitSession}.
+ *
+ * @example
+ * ```ts
+ * const cameraKit = await bootstrapCameraKit(options)
+ * const session = await cameraKit.createSession()
+ * const lens = await cameraKit.lensRepository.loadLens(lensId, groupId)
+ * session.applyLens(lens)
+ * ```
+ *
+ * @category Lenses
+ */
+export declare class LensRepository {
+    private readonly lensMetadataFetchHandler;
+    private readonly lensFetchHandler;
+    private readonly lensSources;
+    private readonly lensAssetRepository;
+    private readonly metadataCache;
+    private readonly binariesCache;
+    /** @internal */
+    constructor(lensMetadataFetchHandler: FetchHandler, lensFetchHandler: LensFetchHandler, lensSources: LensSources, lensAssetRepository: LensAssetRepository);
+    /**
+     * Retrieve a single Lens.
+     *
+     * @param lensId Desired Lens's unique ID. Can be found in the CameraKit Portal.
+     * @param groupId The ID of a group containing the desired Lens. Can be found in the CameraKit Portal.
+     * @returns Resolves with the desired Lens, or rejects if an error occurred (including a missing Lens).
+     */
+    loadLens(lensId: string, groupId: string): Promise<Lens>;
+    /**
+     * Retrieve the Lenses contained in a list of Lens Groups.
+     *
+     * This may result in multiple requests to retrieve Lens data (e.g. one per desired group). If any constituent
+     * requests fail, those errors will be reported in the response – but the returned Promise will not be rejected. Any
+     * Lenses which could be successfully retrieved will be available in the response.
+     *
+     * @param groupIds A list of Lens Group IDs. Can be found in the CameraKit Portal.
+     * @returns Resolves with a flattened list of all lenses in the desired groups. If any errors occurred during the
+     * query operation, these will be included in a separate list. If errors are present, the list of Lenses may not
+     * contain all the Lenses from the desired groups.
+     */
+    loadLensGroups(groupIds: string[]): Promise<LensGroupsQueryResponse>;
+    /**
+     * Loads and caches lens content and dependencies to reduce latency when {@link CameraKitSession.applyLens} is later
+     * called to apply the lens. This is an in-memory cache, it will not be persisted across page loads.
+     *
+     * This may useful if the application A) knows which lenses will be applied and B) has some opportunity to call
+     * this method before a lens is applied. For example, if the user must perform some other actions before lenses
+     * become active, this might be a good opportunity to cache lenses to improve applyLens latency.
+     *
+     * @example
+     * ```ts
+     * const lens = await cameraKit.lensRepository.loadLens(lensId, groupId)
+     * await cameraKit.lensRepository.cacheLensContent([lens])
+     *
+     * // sometime later -- this call will use the cached lens content, making lens application faster.
+     * await cameraKitSession.applyLens(lens)
+     * ```
+     *
+     * @param lenses Array of lenses to cache in memory.
+     * @param assetTimingsToCache Lenses specify certain required assets that are necessary for the lens to render, and
+     * other assets which may be needed by the lens. By default this method will cache all of those assets, but this
+     * behavior can be modified to only load the required assets, only the "onDemand" assets, or neither (by passing
+     * an empty array).
+     */
+    cacheLensContent(lenses: Lens[], assetTimingsToCache?: AssetTiming[]): Promise<void>;
+    /**
+     * Returns loaded Lens metadata if available.
+     */
+    getLensMetadata(lensId: string): LensProto | undefined;
+    /**
+     * Removes Lens content from the in-memory cache.
+     */
+    removeCachedLenses(lenses: Lens[]): void;
+    /**
+     * Fetches lens content and assets. This may come from the cache, otherwise network requests will be made.
+     *
+     * @internal
+     */
+    getLensContent(lens: Lens): Promise<LensBinary>;
+}
+/**
+ * @internal
+ */
+export declare const lensRepositoryFactory: {
+    (args_0: FetchHandler<Response>, args_1: FetchHandler<Response>, args_2: LensSources, args_3: LensAssetRepository): LensRepository;
+    token: "LensRepository";
+    dependencies: readonly ["cameraKitServiceFetchHandler", "defaultFetchHandler", "lensSources", "lensAssetRepository"];
+};
+export {};