@snap/camera-kit 0.7.0

package/lib/persistence/IndexedDBPersistence.js

@@ -0,0 +1,180 @@
+import { __awaiter } from "tslib";
+import { isValidKey } from "./Persistence";
+function wrapRequest(request) {
+    const p = new Promise((resolve, reject) => {
+        request.onsuccess = () => resolve(request.result);
+        request.onerror = () => reject(request.error);
+    });
+    p.request = request;
+    return p;
+}
+/**
+ * IndexedDB cursor requests are unique, in that their `onsuccess` handler may be called multiple times. To support
+ * this, and allow for an easier-to-use Promise-based API, we wrap the cursor request to support usage like:
+ * ```ts
+ * let request = await wrapCursorRequest(store.openCursor())
+ * while (request.cursor) {
+ *   console.log(request.cursor.key, request.cursor.value)
+ *   request = await request.continue()
+ * }
+ * ```
+ */
+function wrapCursorRequest(request) {
+    return new Promise((resolve, reject) => {
+        request.onsuccess = () => {
+            const cursor = request.result;
+            if (!cursor)
+                resolve({ cursor: null, continue: () => Promise.reject() });
+            else
+                resolve({
+                    cursor,
+                    continue: () => {
+                        cursor.continue();
+                        return wrapCursorRequest(request);
+                    },
+                });
+        };
+        request.onerror = () => reject(request.error);
+    });
+}
+/**
+ * A simple key/value persistence using an IndexedDB storage backend.
+ *
+ * See [Using IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Using_IndexedDB) for an
+ * introduction to how IndexedDB works, its APIs, and how to use it.
+ *
+ * Note: Currently there is no support for database upgrades. Each instance of this class uses a single IDBObjectStore
+ * object set at instantiation time, and there are no hooks for performing migrations between versions. This may be
+ * added in the future if such functionality is needed.
+ */
+export class IndexedDBPersistence {
+    /**
+     * Construct an {@link IndexedDBPersistence} instance corresponding to a given IndexedDB database version.
+     *
+     * Throws `ConstraintError` if the version number is invalid (e.g. NaN, or less than 1).
+     */
+    constructor(options) {
+        var _a;
+        // We'll namespace our DB names to A) avoid collisions with host applications and B) be transparent about who
+        // is using persistence.
+        this.databaseName = `Snap.CameraKit.${options.databaseName}`;
+        this.databaseVersion = options.databaseVersion;
+        this.objectStore = (_a = options.objectStore) !== null && _a !== void 0 ? _a : options.databaseName;
+        // `open()` will throw if the version is invalid -- this is desirable vs. rejecting the `db` promise, since then
+        // the error is only reported when callers try to perform some operation. Instead, we want the instantiating
+        // code to see the error.
+        this.db = this.openDatabase(indexedDB.open(this.databaseName, this.databaseVersion));
+        this.size = 0;
+    }
+    retrieve(key) {
+        return this.simpleTransaction("readonly", (store) => store.get(key));
+    }
+    retrieveAll() {
+        return this.simpleTransaction("readonly", (store) => store.getAll());
+    }
+    remove(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.simpleTransaction("readwrite", (store) => store.delete(key));
+            this.size--;
+        });
+    }
+    removeAll() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = [];
+            const { store, done } = yield this.transaction("readwrite");
+            let request = yield wrapCursorRequest(store.openCursor());
+            const deleteRequests = [];
+            while (request.cursor) {
+                results.push(request.cursor.value);
+                // If any of the deletes fail (e.g. if the user deletes the object store during the transaction), it will
+                // fail the whole transaction. Since the primary expected cause of this failure mode is that the entire
+                // object store no longer exists, it's unlikely this will result in unbounded DB growth. That said, callers
+                // may want to attempt to retry the removal, or raise an alarm if the persistence size grows unexpectedly.
+                deleteRequests.push(wrapRequest(store.delete(request.cursor.key)));
+                request = yield request.continue();
+            }
+            yield Promise.all(deleteRequests.concat(done));
+            this.size = 0;
+            return results;
+        });
+    }
+    store(keyOrValue, maybeValue) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const [key, value] = maybeValue === undefined ? [undefined, keyOrValue] : [keyOrValue, maybeValue];
+            // The key must be ValidKey | undefined.
+            if (!isValidKey(key) && typeof key !== "undefined")
+                throw new TypeError(`IndexedDBPersistence failed to ` + `store a value. Invalid key type: ${typeof key}`);
+            const storedKey = yield this.simpleTransaction("readwrite", (store) => store.put(value, key));
+            this.size++;
+            // Type safety: we already assert any given key is valid, and if the key is undefined IndexedDB will generate
+            // a numeric key (https://w3c.github.io/IndexedDB/#key-generator).
+            return storedKey;
+        });
+    }
+    openDatabase(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // The `open()` call will throw if databaseVersion is invalid (e.g. < 1).
+            const dbPromise = wrapRequest(request);
+            dbPromise.request.onupgradeneeded = () => {
+                try {
+                    // The following DOMExceptions may be thrown by `createObjectStore()` – they should all be logically
+                    // impossible. We handle the one recoverable exception which could occur below.
+                    //
+                    // TransactionInactiveError: the database does not exist.
+                    // InvalidStateError: `createObjectStore` was called outside a `versionchange` transaction.
+                    // InvalidAccessError: `autoIncrement` is true and `keyPath` contains an empty string.
+                    dbPromise.request.result.createObjectStore(this.objectStore, { autoIncrement: true });
+                }
+                catch (error) {
+                    // ConstraintError is thrown if the object store already exists. Could happen if multiple tabs to the
+                    // same domain are opened and race to create the object store. In this case we can safely ignore the
+                    // error and continue.
+                    if (error instanceof DOMException && error.name === "ConstraintError")
+                        return;
+                    throw error;
+                }
+            };
+            const db = yield dbPromise;
+            db.onclose = () => {
+                // The 'close` event fires when the DB is unexpectedly closed (e.g. user clears application data). We'll
+                // attempt to re-open it (which may fail, in which case no further attempts will be made, and all future
+                // transactions will fail).
+                this.db = this.openDatabase(indexedDB.open(this.databaseName, this.databaseVersion));
+            };
+            return db;
+        });
+    }
+    simpleTransaction(mode, operation) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { store, done } = yield this.transaction(mode);
+            const [result] = yield Promise.all([wrapRequest(operation(store)), done]);
+            return result;
+        });
+    }
+    transaction(mode) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const db = yield this.db;
+            // The following DOMExceptions may be thrown – they should all be logically impossible, or could be
+            // triggered by the user deleting or modifying the database (e.g. via DevTools) at the right time. We won't
+            // attempt to recover from them now, but may decide to do so in the future (if we see them in the wild).
+            //
+            // InvalidStateError: `close()` has previously been called on the IDBDatabase
+            // NotFoundError: the object store does not exist.
+            // TypeError: the `mode` parameter is invalid.
+            // InvalidAccessError: the function was called with an empty list of object stores.
+            const tx = db.transaction(this.objectStore, mode);
+            // Similarly, the following DOMExceptions may be thrown by `objectStore()`:
+            //
+            // InvalidStateError: the transaction has already completed.
+            // NotFoundError: the object store is not in the transaction's scope.
+            const store = tx.objectStore(this.objectStore);
+            const done = new Promise((resolve, reject) => {
+                tx.oncomplete = () => resolve();
+                tx.onerror = () => reject(tx.error);
+                tx.onabort = () => reject(new DOMException("The transaction was aborted", "AbortError"));
+            });
+            return { tx, store, done };
+        });
+    }
+}
+//# sourceMappingURL=IndexedDBPersistence.js.map

package/lib/persistence/IndexedDBPersistence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IndexedDBPersistence.js","sourceRoot":"","sources":["../../src/persistence/IndexedDBPersistence.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAyB,MAAM,eAAe,CAAC;AAqBlE,SAAS,WAAW,CAAC,OAAmB;IACpC,MAAM,CAAC,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtC,OAAO,CAAC,SAAS,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IACF,CAAuB,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3C,OAAO,CAAsB,CAAC;AAClC,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,iBAAiB,CAAI,OAA8C;IACxE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnC,OAAO,CAAC,SAAS,GAAG,GAAG,EAAE;YACrB,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC9B,IAAI,CAAC,MAAM;gBAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;;gBAErE,OAAO,CAAC;oBACJ,MAAM;oBACN,QAAQ,EAAE,GAAG,EAAE;wBACX,MAAM,CAAC,QAAQ,EAAE,CAAC;wBAClB,OAAO,iBAAiB,CAAI,OAAO,CAAC,CAAC;oBACzC,CAAC;iBACJ,CAAC,CAAC;QACX,CAAC,CAAC;QACF,OAAO,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;AACP,CAAC;AAiBD;;;;;;;;;GASG;AACH,MAAM,OAAO,oBAAoB;IAQ7B;;;;OAIG;IACH,YAAY,OAAoC;;QAC5C,6GAA6G;QAC7G,wBAAwB;QACxB,IAAI,CAAC,YAAY,GAAG,kBAAkB,OAAO,CAAC,YAAY,EAAE,CAAC;QAC7D,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,WAAW,GAAG,MAAA,OAAO,CAAC,WAAW,mCAAI,OAAO,CAAC,YAAY,CAAC;QAE/D,gHAAgH;QAChH,4GAA4G;QAC5G,yBAAyB;QACzB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IAClB,CAAC;IAED,QAAQ,CAAC,GAAa;QAClB,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAEK,MAAM,CAAC,GAAa;;YACtB,MAAM,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YACxE,IAAI,CAAC,IAAI,EAAE,CAAC;QAChB,CAAC;KAAA;IAEK,SAAS;;YACX,MAAM,OAAO,GAAQ,EAAE,CAAC;YACxB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YAC5D,IAAI,OAAO,GAAG,MAAM,iBAAiB,CAAI,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;YAC7D,MAAM,cAAc,GAAmB,EAAE,CAAC;YAC1C,OAAO,OAAO,CAAC,MAAM,EAAE;gBACnB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACnC,yGAAyG;gBACzG,uGAAuG;gBACvG,2GAA2G;gBAC3G,0GAA0G;gBAC1G,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBACnE,OAAO,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC;aACtC;YACD,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAC/C,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;YACd,OAAO,OAAO,CAAC;QACnB,CAAC;KAAA;IAIK,KAAK,CAAC,UAAwB,EAAE,UAAc;;YAChD,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAEnG,wCAAwC;YACxC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,KAAK,WAAW;gBAC9C,MAAM,IAAI,SAAS,CAAC,iCAAiC,GAAG,oCAAoC,OAAO,GAAG,EAAE,CAAC,CAAC;YAE9G,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;YAC9F,IAAI,CAAC,IAAI,EAAE,CAAC;YAEZ,6GAA6G;YAC7G,kEAAkE;YAClE,OAAO,SAAqB,CAAC;QACjC,CAAC;KAAA;IAEa,YAAY,CAAC,OAAyB;;YAChD,yEAAyE;YACzE,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;YACvC,SAAS,CAAC,OAAO,CAAC,eAAe,GAAG,GAAG,EAAE;gBACrC,IAAI;oBACA,oGAAoG;oBACpG,+EAA+E;oBAC/E,EAAE;oBACF,yDAAyD;oBACzD,2FAA2F;oBAC3F,sFAAsF;oBACtF,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;iBACzF;gBAAC,OAAO,KAAK,EAAE;oBACZ,qGAAqG;oBACrG,oGAAoG;oBACpG,sBAAsB;oBACtB,IAAI,KAAK,YAAY,YAAY,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB;wBAAE,OAAO;oBAC9E,MAAM,KAAK,CAAC;iBACf;YACL,CAAC,CAAC;YACF,MAAM,EAAE,GAAG,MAAM,SAAS,CAAC;YAC3B,EAAE,CAAC,OAAO,GAAG,GAAG,EAAE;gBACd,wGAAwG;gBACxG,wGAAwG;gBACxG,2BAA2B;gBAC3B,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;YACzF,CAAC,CAAC;YACF,OAAO,EAAE,CAAC;QACd,CAAC;KAAA;IAEa,iBAAiB,CAC3B,IAAwB,EACxB,SAAgD;;YAEhD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;YAC1E,OAAO,MAAM,CAAC;QAClB,CAAC;KAAA;IAEa,WAAW,CAAC,IAAwB;;YAC9C,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC;YACzB,mGAAmG;YACnG,2GAA2G;YAC3G,wGAAwG;YACxG,EAAE;YACF,6EAA6E;YAC7E,kDAAkD;YAClD,8CAA8C;YAC9C,mFAAmF;YACnF,MAAM,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YAElD,2EAA2E;YAC3E,EAAE;YACF,4DAA4D;YAC5D,qEAAqE;YACrE,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC/C,MAAM,IAAI,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC/C,EAAE,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;gBAChC,EAAE,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;gBACpC,EAAE,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,6BAA6B,EAAE,YAAY,CAAC,CAAC,CAAC;YAC7F,CAAC,CAAC,CAAC;YACH,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAC/B,CAAC;KAAA;CACJ","sourcesContent":["import { isValidKey, Persistence, ValidKey } from \"./Persistence\";\n\ntype IDBRequestPromise<T = any> = Promise<T> & { request: IDBRequest<T> };\n\ninterface EnhancedIDBTransaction {\n    tx: IDBTransaction;\n    store: IDBObjectStore;\n    done: Promise<void>;\n}\n\ninterface EnhancedIDBCursor<T> {\n    cursor: (IDBCursor & { readonly value: T }) | null;\n    continue: () => Promise<EnhancedIDBCursor<T>>;\n}\n\n/**\n * The IndexedDB API makes use of event callbacks that can be cumbersome to use. This method wraps an IDBRequest in a\n * Promise, making it easier to use.\n */\nfunction wrapRequest(request: IDBOpenDBRequest): Promise<IDBDatabase> & { request: IDBOpenDBRequest };\nfunction wrapRequest<T>(request: IDBRequest<T>): IDBRequestPromise<T>;\nfunction wrapRequest(request: IDBRequest): IDBRequestPromise {\n    const p = new Promise((resolve, reject) => {\n        request.onsuccess = () => resolve(request.result);\n        request.onerror = () => reject(request.error);\n    });\n    (p as IDBRequestPromise).request = request;\n    return p as IDBRequestPromise;\n}\n\n/**\n * IndexedDB cursor requests are unique, in that their `onsuccess` handler may be called multiple times. To support\n * this, and allow for an easier-to-use Promise-based API, we wrap the cursor request to support usage like:\n * ```ts\n * let request = await wrapCursorRequest(store.openCursor())\n * while (request.cursor) {\n *   console.log(request.cursor.key, request.cursor.value)\n *   request = await request.continue()\n * }\n * ```\n */\nfunction wrapCursorRequest<T>(request: IDBRequest<IDBCursorWithValue | null>): Promise<EnhancedIDBCursor<T>> {\n    return new Promise((resolve, reject) => {\n        request.onsuccess = () => {\n            const cursor = request.result;\n            if (!cursor) resolve({ cursor: null, continue: () => Promise.reject() });\n            else\n                resolve({\n                    cursor,\n                    continue: () => {\n                        cursor.continue();\n                        return wrapCursorRequest<T>(request);\n                    },\n                });\n        };\n        request.onerror = () => reject(request.error);\n    });\n}\n\n/**\n * Specify a database name for this {@link IndexedDBPersistence} instance to use.\n * This will be prefixed by `Snap.CameraKit`.\n *\n * A databaseVersion and objectStore may also be specified. Keep in mind the following limitations:\n * - IndexedDBPersistence currently does nothing to migrate data between versions.\n * - If two different IndexedDBPersistence instances use the same databaseName, they must also use the same objectStore.\n * Otherwise a race condition will occur which prevents the creation of all but one objectStore per database.\n */\nexport interface IndexedDBPersistenceOptions {\n    databaseName: string;\n    databaseVersion?: number;\n    objectStore?: string;\n}\n\n/**\n * A simple key/value persistence using an IndexedDB storage backend.\n *\n * See [Using IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Using_IndexedDB) for an\n * introduction to how IndexedDB works, its APIs, and how to use it.\n *\n * Note: Currently there is no support for database upgrades. Each instance of this class uses a single IDBObjectStore\n * object set at instantiation time, and there are no hooks for performing migrations between versions. This may be\n * added in the future if such functionality is needed.\n */\nexport class IndexedDBPersistence<T> implements Persistence<T> {\n    size: number;\n\n    private db: Promise<IDBDatabase>;\n    private readonly databaseName: string;\n    private readonly databaseVersion?: number;\n    private readonly objectStore: string;\n\n    /**\n     * Construct an {@link IndexedDBPersistence} instance corresponding to a given IndexedDB database version.\n     *\n     * Throws `ConstraintError` if the version number is invalid (e.g. NaN, or less than 1).\n     */\n    constructor(options: IndexedDBPersistenceOptions) {\n        // We'll namespace our DB names to A) avoid collisions with host applications and B) be transparent about who\n        // is using persistence.\n        this.databaseName = `Snap.CameraKit.${options.databaseName}`;\n        this.databaseVersion = options.databaseVersion;\n        this.objectStore = options.objectStore ?? options.databaseName;\n\n        // `open()` will throw if the version is invalid -- this is desirable vs. rejecting the `db` promise, since then\n        // the error is only reported when callers try to perform some operation. Instead, we want the instantiating\n        // code to see the error.\n        this.db = this.openDatabase(indexedDB.open(this.databaseName, this.databaseVersion));\n        this.size = 0;\n    }\n\n    retrieve(key: ValidKey): Promise<T | undefined> {\n        return this.simpleTransaction(\"readonly\", (store) => store.get(key));\n    }\n\n    retrieveAll(): Promise<T[]> {\n        return this.simpleTransaction(\"readonly\", (store) => store.getAll());\n    }\n\n    async remove(key: ValidKey): Promise<void> {\n        await this.simpleTransaction(\"readwrite\", (store) => store.delete(key));\n        this.size--;\n    }\n\n    async removeAll(): Promise<T[]> {\n        const results: T[] = [];\n        const { store, done } = await this.transaction(\"readwrite\");\n        let request = await wrapCursorRequest<T>(store.openCursor());\n        const deleteRequests: Promise<any>[] = [];\n        while (request.cursor) {\n            results.push(request.cursor.value);\n            // If any of the deletes fail (e.g. if the user deletes the object store during the transaction), it will\n            // fail the whole transaction. Since the primary expected cause of this failure mode is that the entire\n            // object store no longer exists, it's unlikely this will result in unbounded DB growth. That said, callers\n            // may want to attempt to retry the removal, or raise an alarm if the persistence size grows unexpectedly.\n            deleteRequests.push(wrapRequest(store.delete(request.cursor.key)));\n            request = await request.continue();\n        }\n        await Promise.all(deleteRequests.concat(done));\n        this.size = 0;\n        return results;\n    }\n\n    async store(value: T): Promise<ValidKey>;\n    async store(key: ValidKey, value: T): Promise<ValidKey>;\n    async store(keyOrValue: T | ValidKey, maybeValue?: T): Promise<ValidKey> {\n        const [key, value] = maybeValue === undefined ? [undefined, keyOrValue] : [keyOrValue, maybeValue];\n\n        // The key must be ValidKey | undefined.\n        if (!isValidKey(key) && typeof key !== \"undefined\")\n            throw new TypeError(`IndexedDBPersistence failed to ` + `store a value. Invalid key type: ${typeof key}`);\n\n        const storedKey = await this.simpleTransaction(\"readwrite\", (store) => store.put(value, key));\n        this.size++;\n\n        // Type safety: we already assert any given key is valid, and if the key is undefined IndexedDB will generate\n        // a numeric key (https://w3c.github.io/IndexedDB/#key-generator).\n        return storedKey as ValidKey;\n    }\n\n    private async openDatabase(request: IDBOpenDBRequest): Promise<IDBDatabase> {\n        // The `open()` call will throw if databaseVersion is invalid (e.g. < 1).\n        const dbPromise = wrapRequest(request);\n        dbPromise.request.onupgradeneeded = () => {\n            try {\n                // The following DOMExceptions may be thrown by `createObjectStore()` – they should all be logically\n                // impossible. We handle the one recoverable exception which could occur below.\n                //\n                // TransactionInactiveError: the database does not exist.\n                // InvalidStateError: `createObjectStore` was called outside a `versionchange` transaction.\n                // InvalidAccessError: `autoIncrement` is true and `keyPath` contains an empty string.\n                dbPromise.request.result.createObjectStore(this.objectStore, { autoIncrement: true });\n            } catch (error) {\n                // ConstraintError is thrown if the object store already exists. Could happen if multiple tabs to the\n                // same domain are opened and race to create the object store. In this case we can safely ignore the\n                // error and continue.\n                if (error instanceof DOMException && error.name === \"ConstraintError\") return;\n                throw error;\n            }\n        };\n        const db = await dbPromise;\n        db.onclose = () => {\n            // The 'close` event fires when the DB is unexpectedly closed (e.g. user clears application data). We'll\n            // attempt to re-open it (which may fail, in which case no further attempts will be made, and all future\n            // transactions will fail).\n            this.db = this.openDatabase(indexedDB.open(this.databaseName, this.databaseVersion));\n        };\n        return db;\n    }\n\n    private async simpleTransaction<R>(\n        mode: IDBTransactionMode,\n        operation: (tx: IDBObjectStore) => IDBRequest<R>\n    ): Promise<R> {\n        const { store, done } = await this.transaction(mode);\n        const [result] = await Promise.all([wrapRequest(operation(store)), done]);\n        return result;\n    }\n\n    private async transaction(mode: IDBTransactionMode): Promise<EnhancedIDBTransaction> {\n        const db = await this.db;\n        // The following DOMExceptions may be thrown – they should all be logically impossible, or could be\n        // triggered by the user deleting or modifying the database (e.g. via DevTools) at the right time. We won't\n        // attempt to recover from them now, but may decide to do so in the future (if we see them in the wild).\n        //\n        // InvalidStateError: `close()` has previously been called on the IDBDatabase\n        // NotFoundError: the object store does not exist.\n        // TypeError: the `mode` parameter is invalid.\n        // InvalidAccessError: the function was called with an empty list of object stores.\n        const tx = db.transaction(this.objectStore, mode);\n\n        // Similarly, the following DOMExceptions may be thrown by `objectStore()`:\n        //\n        // InvalidStateError: the transaction has already completed.\n        // NotFoundError: the object store is not in the transaction's scope.\n        const store = tx.objectStore(this.objectStore);\n        const done = new Promise<void>((resolve, reject) => {\n            tx.oncomplete = () => resolve();\n            tx.onerror = () => reject(tx.error);\n            tx.onabort = () => reject(new DOMException(\"The transaction was aborted\", \"AbortError\"));\n        });\n        return { tx, store, done };\n    }\n}\n"]}

package/lib/persistence/Persistence.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Different persistence mechanisms (e.g. localStorage, IndexedDB) may support different key types. This type should be
+ * a valid key across all concrete Persistence implementations.
+ */
+export declare type ValidKey = string | number;
+export declare const isValidKey: (key: unknown) => key is ValidKey;
+/**
+ * The abstract Persistence class defines an async interface for interacting with persistent client-side storage. This
+ * is modeled as a simple key/value store.
+ *
+ * Subclasses may be implemented to support a variety of persistence mechanisms – e.g. localStorage, IndexedDB, etc.
+ */
+export declare abstract class Persistence<T> {
+    abstract size: number;
+    abstract retrieve(key: ValidKey): Promise<T | undefined>;
+    abstract retrieveAll(): Promise<T[]>;
+    abstract remove(key: ValidKey): Promise<void>;
+    abstract removeAll(): Promise<T[]>;
+    /**
+     * Persistence implementations must be capable of generating unique keys, or accepting a unique key from the
+     * caller.
+     */
+    abstract store(value: T): Promise<ValidKey>;
+    abstract store(key: ValidKey, value: T): Promise<ValidKey>;
+}

package/lib/persistence/Persistence.js

@@ -0,0 +1,10 @@
+export const isValidKey = (key) => typeof key === "string" || typeof key === "number";
+/**
+ * The abstract Persistence class defines an async interface for interacting with persistent client-side storage. This
+ * is modeled as a simple key/value store.
+ *
+ * Subclasses may be implemented to support a variety of persistence mechanisms – e.g. localStorage, IndexedDB, etc.
+ */
+export class Persistence {
+}
+//# sourceMappingURL=Persistence.js.map

package/lib/persistence/Persistence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Persistence.js","sourceRoot":"","sources":["../../src/persistence/Persistence.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,GAAY,EAAmB,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC;AAEhH;;;;;GAKG;AACH,MAAM,OAAgB,WAAW;CAiBhC","sourcesContent":["/**\n * Different persistence mechanisms (e.g. localStorage, IndexedDB) may support different key types. This type should be\n * a valid key across all concrete Persistence implementations.\n */\nexport type ValidKey = string | number;\n\nexport const isValidKey = (key: unknown): key is ValidKey => typeof key === \"string\" || typeof key === \"number\";\n\n/**\n * The abstract Persistence class defines an async interface for interacting with persistent client-side storage. This\n * is modeled as a simple key/value store.\n *\n * Subclasses may be implemented to support a variety of persistence mechanisms – e.g. localStorage, IndexedDB, etc.\n */\nexport abstract class Persistence<T> {\n    abstract size: number;\n\n    abstract retrieve(key: ValidKey): Promise<T | undefined>;\n\n    abstract retrieveAll(): Promise<T[]>;\n\n    abstract remove(key: ValidKey): Promise<void>;\n\n    abstract removeAll(): Promise<T[]>;\n\n    /**\n     * Persistence implementations must be capable of generating unique keys, or accepting a unique key from the\n     * caller.\n     */\n    abstract store(value: T): Promise<ValidKey>;\n    abstract store(key: ValidKey, value: T): Promise<ValidKey>;\n}\n"]}

package/lib/remote-configuration/cofHandler.d.ts

@@ -0,0 +1,21 @@
+import { ConfigTargetingRequest } from "../generated-proto/pb_schema/cdp/cof/config_request";
+import { ConfigTargetingResponse } from "../generated-proto/pb_schema/cdp/cof/config_response";
+interface Metadata {
+    [key: string]: string;
+}
+export declare const COF_REQUEST_TYPE = "cof";
+export declare type CofDimensions = {
+    requestType: typeof COF_REQUEST_TYPE;
+};
+/**
+ * Handler chain used to make COF requests. Uses the COF client to perform the
+ * requests, with retries, timeout, and caching.
+ *
+ * The handler will first attempt to retrieve the COF response from cache. If it is found, the result is returned
+ * immediately and the cache is updated in the background. If no response is found, a COF request is made. This request
+ * will retry (with exponential backoff + jitter) for 5 seconds before returning an error to the caller.
+ */
+export declare const cofHandlerFactory: (apiToken: string) => import("../handlers/HandlerChainBuilder").Handler<Partial<ConfigTargetingRequest>, ConfigTargetingResponse, Metadata & {
+    signal?: AbortSignal | null | undefined;
+}>;
+export {};

package/lib/remote-configuration/cofHandler.js

@@ -0,0 +1,75 @@
+import { __awaiter, __rest } from "tslib";
+import { BrowserHeaders } from "browser-headers";
+import { cameraKitUserAgent } from "../common/cameraKitUserAgent";
+import { ensureError } from "../common/errorHelpers";
+import { CircumstancesServiceClientImpl, GrpcWebImpl } from "../generated-proto/pb_schema/cdp/cof/circumstance_service";
+import { HandlerChainBuilder } from "../handlers/HandlerChainBuilder";
+import { dispatchRequestCompleted, dispatchRequestErrored, dispatchRequestStarted, } from "../handlers/requestStateEmittingHandler";
+import { createResponseCachingHandler, staleWhileRevalidateStrategy } from "../handlers/responseCachingHandler";
+import { createRetryingHandler } from "../handlers/retryingHandler";
+import { createTimeoutHandler } from "../handlers/timeoutHandler";
+import { ExpiringPersistence } from "../persistence/ExpiringPersistence";
+import { IndexedDBPersistence } from "../persistence/IndexedDBPersistence";
+const id = (h) => h;
+// We need to wrap `targetingQuery` to create a usable Handler – the main issue is that HandlerChainBuilder always adds
+// a `signal` property to the metadata argument (second argument of the Handler), but `targetingQuery` expects the
+// second argument to only contain headers.
+const createTargetingQueryHandler = (apiToken) => (request, _a) => __awaiter(void 0, void 0, void 0, function* () {
+    var { signal } = _a, metadata = __rest(_a, ["signal"]);
+    const rpc = new GrpcWebImpl("https://api-kit.snapchat.com", {});
+    const client = new CircumstancesServiceClientImpl(rpc);
+    const response = yield client.targetingQuery(request, new BrowserHeaders(Object.assign({ authorization: `Bearer ${apiToken}`, "x-snap-client-user-agent": cameraKitUserAgent.userAgent }, metadata)));
+    // NOTE: in order for cache persistance to work, we need to make the object cloneable,
+    // i.e. with no methods (it appears targetingQuery() attaches toObject() to response object).
+    delete response["toObject"];
+    return response;
+});
+export const COF_REQUEST_TYPE = "cof";
+/**
+ * Handler chain used to make COF requests. Uses the COF client to perform the
+ * requests, with retries, timeout, and caching.
+ *
+ * The handler will first attempt to retrieve the COF response from cache. If it is found, the result is returned
+ * immediately and the cache is updated in the background. If no response is found, a COF request is made. This request
+ * will retry (with exponential backoff + jitter) for 5 seconds before returning an error to the caller.
+ */
+export const cofHandlerFactory = (apiToken) => new HandlerChainBuilder(createTargetingQueryHandler(apiToken))
+    .map(id((next) => (request, metadata) => __awaiter(void 0, void 0, void 0, function* () {
+    const dimensions = { requestType: COF_REQUEST_TYPE };
+    const { requestId } = dispatchRequestStarted({ dimensions });
+    try {
+        const response = yield next(request, metadata);
+        // TODO: We hardcode status code and sizeByte values because we do not have access to underlying
+        // transport of configs-web.
+        // When this ticket is done https://jira.sc-corp.net/browse/CAMKIT-2840,
+        // we will remove this handler and benefit from existing ones.
+        const status = 200;
+        let sizeByte = 0;
+        try {
+            sizeByte = new TextEncoder().encode(JSON.stringify(response)).byteLength;
+        }
+        finally {
+            dispatchRequestCompleted({ requestId, dimensions, status, sizeByte });
+            return response;
+        }
+    }
+    catch (error) {
+        dispatchRequestErrored({ requestId, dimensions, error: ensureError(error) });
+        throw error;
+    }
+})))
+    // targetingQuery() always converts failed responses into errors (unlike fetch()), so we need a custom
+    // retryPredicate that retries all errors. We'll keep retrying (with backoff) for 20 seconds total elapsed
+    // time before we return an error back up the chain.
+    .map(createRetryingHandler({ retryPredicate: (r) => r instanceof Error }))
+    // API gateway has 15 seconds timeout, so we rely on that first
+    .map(createTimeoutHandler({ timeout: 20 * 1000 }))
+    .map(createResponseCachingHandler(
+// COF responses will be removed from cache after 1 week. Keep in mind that the staleWhileRevalidate
+// strategy will update the cache each time COF is requested – this expiration comes into play only if
+// e.g. a user doesn't load the page for more than a week.
+new ExpiringPersistence(() => 7 * 24 * 60 * 60, new IndexedDBPersistence({ databaseName: "COFCache" })), (r) => JSON.stringify(r), 
+// If we have a matching response already in cache, we'll return it immediately and then update the
+// cache in the background.
+staleWhileRevalidateStrategy())).handler;
+//# sourceMappingURL=cofHandler.js.map

package/lib/remote-configuration/cofHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cofHandler.js","sourceRoot":"","sources":["../../src/remote-configuration/cofHandler.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,8BAA8B,EAAE,WAAW,EAAE,MAAM,2DAA2D,CAAC;AAGxH,OAAO,EAAoB,mBAAmB,EAAmB,MAAM,iCAAiC,CAAC;AACzG,OAAO,EACH,wBAAwB,EACxB,sBAAsB,EACtB,sBAAsB,GACzB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,4BAA4B,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAChH,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAM3E,MAAM,EAAE,GAAG,CAAyC,CAA6C,EAAE,EAAE,CAAC,CAAC,CAAC;AAExG,uHAAuH;AACvH,kHAAkH;AAClH,2CAA2C;AAC3C,MAAM,2BAA2B,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,CACtD,OAAwC,EACxC,EAAmD,EACrD,EAAE;QADA,EAAE,MAAM,OAA2C,EAAtC,QAAQ,cAArB,UAAuB,CAAF;IAErB,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;IAChE,MAAM,MAAM,GAAG,IAAI,8BAA8B,CAAC,GAAG,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,cAAc,CACxC,OAAO,EACP,IAAI,cAAc,iBACd,aAAa,EAAE,UAAU,QAAQ,EAAE,EACnC,0BAA0B,EAAE,kBAAkB,CAAC,SAAS,IACrD,QAAQ,EACb,CACL,CAAC;IAEF,sFAAsF;IACtF,6FAA6F;IAC7F,OAAO,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC5B,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAA,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,CAAC;AAItC;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAE,EAAE,CAClD,IAAI,mBAAmB,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC;KACzD,GAAG,CACA,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAO,OAAO,EAAE,QAAQ,EAAE,EAAE;IACrC,MAAM,UAAU,GAAkB,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;IACpE,MAAM,EAAE,SAAS,EAAE,GAAG,sBAAsB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAC7D,IAAI;QACA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC/C,gGAAgG;QAChG,4BAA4B;QAC5B,wEAAwE;QACxE,8DAA8D;QAC9D,MAAM,MAAM,GAAG,GAAG,CAAC;QACnB,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI;YACA,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC;SAC5E;gBAAS;YACN,wBAAwB,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;YACtE,OAAO,QAAQ,CAAC;SACnB;KACJ;IAAC,OAAO,KAAK,EAAE;QACZ,sBAAsB,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC7E,MAAM,KAAK,CAAC;KACf;AACL,CAAC,CAAA,CAAC,CACL;IACD,sGAAsG;IACtG,0GAA0G;IAC1G,oDAAoD;KACnD,GAAG,CAAC,qBAAqB,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,KAAK,EAAE,CAAC,CAAC;IAC1E,+DAA+D;KAC9D,GAAG,CAAC,oBAAoB,CAAC,EAAE,OAAO,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;KACjD,GAAG,CACA,4BAA4B;AACxB,oGAAoG;AACpG,sGAAsG;AACtG,0DAA0D;AAC1D,IAAI,mBAAmB,CACnB,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EACtB,IAAI,oBAAoB,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CACzD,EACD,CAAC,CAAkC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;AAEzD,mGAAmG;AACnG,2BAA2B;AAC3B,4BAA4B,EAAE,CACjC,CACJ,CAAC,OAAO,CAAC","sourcesContent":["import { BrowserHeaders } from \"browser-headers\";\nimport { cameraKitUserAgent } from \"../common/cameraKitUserAgent\";\nimport { ensureError } from \"../common/errorHelpers\";\nimport { CircumstancesServiceClientImpl, GrpcWebImpl } from \"../generated-proto/pb_schema/cdp/cof/circumstance_service\";\nimport { ConfigTargetingRequest } from \"../generated-proto/pb_schema/cdp/cof/config_request\";\nimport { ConfigTargetingResponse } from \"../generated-proto/pb_schema/cdp/cof/config_response\";\nimport { ChainableHandler, HandlerChainBuilder, RequestMetadata } from \"../handlers/HandlerChainBuilder\";\nimport {\n    dispatchRequestCompleted,\n    dispatchRequestErrored,\n    dispatchRequestStarted,\n} from \"../handlers/requestStateEmittingHandler\";\nimport { createResponseCachingHandler, staleWhileRevalidateStrategy } from \"../handlers/responseCachingHandler\";\nimport { createRetryingHandler } from \"../handlers/retryingHandler\";\nimport { createTimeoutHandler } from \"../handlers/timeoutHandler\";\nimport { ExpiringPersistence } from \"../persistence/ExpiringPersistence\";\nimport { IndexedDBPersistence } from \"../persistence/IndexedDBPersistence\";\n\ninterface Metadata {\n    [key: string]: string;\n}\n\nconst id = <Req, Res, Meta extends RequestMetadata>(h: ChainableHandler<Req, Res, Req, Res, Meta>) => h;\n\n// We need to wrap `targetingQuery` to create a usable Handler – the main issue is that HandlerChainBuilder always adds\n// a `signal` property to the metadata argument (second argument of the Handler), but `targetingQuery` expects the\n// second argument to only contain headers.\nconst createTargetingQueryHandler = (apiToken: string) => async (\n    request: Partial<ConfigTargetingRequest>,\n    { signal, ...metadata }: Metadata & RequestMetadata\n) => {\n    const rpc = new GrpcWebImpl(\"https://api-kit.snapchat.com\", {});\n    const client = new CircumstancesServiceClientImpl(rpc);\n    const response = await client.targetingQuery(\n        request,\n        new BrowserHeaders({\n            authorization: `Bearer ${apiToken}`,\n            \"x-snap-client-user-agent\": cameraKitUserAgent.userAgent,\n            ...metadata,\n        })\n    );\n\n    // NOTE: in order for cache persistance to work, we need to make the object cloneable,\n    // i.e. with no methods (it appears targetingQuery() attaches toObject() to response object).\n    delete response[\"toObject\"];\n    return response;\n};\n\nexport const COF_REQUEST_TYPE = \"cof\";\n\nexport type CofDimensions = { requestType: typeof COF_REQUEST_TYPE };\n\n/**\n * Handler chain used to make COF requests. Uses the COF client to perform the\n * requests, with retries, timeout, and caching.\n *\n * The handler will first attempt to retrieve the COF response from cache. If it is found, the result is returned\n * immediately and the cache is updated in the background. If no response is found, a COF request is made. This request\n * will retry (with exponential backoff + jitter) for 5 seconds before returning an error to the caller.\n */\nexport const cofHandlerFactory = (apiToken: string) =>\n    new HandlerChainBuilder(createTargetingQueryHandler(apiToken))\n        .map(\n            id((next) => async (request, metadata) => {\n                const dimensions: CofDimensions = { requestType: COF_REQUEST_TYPE };\n                const { requestId } = dispatchRequestStarted({ dimensions });\n                try {\n                    const response = await next(request, metadata);\n                    // TODO: We hardcode status code and sizeByte values because we do not have access to underlying\n                    // transport of configs-web.\n                    // When this ticket is done https://jira.sc-corp.net/browse/CAMKIT-2840,\n                    // we will remove this handler and benefit from existing ones.\n                    const status = 200;\n                    let sizeByte = 0;\n                    try {\n                        sizeByte = new TextEncoder().encode(JSON.stringify(response)).byteLength;\n                    } finally {\n                        dispatchRequestCompleted({ requestId, dimensions, status, sizeByte });\n                        return response;\n                    }\n                } catch (error) {\n                    dispatchRequestErrored({ requestId, dimensions, error: ensureError(error) });\n                    throw error;\n                }\n            })\n        )\n        // targetingQuery() always converts failed responses into errors (unlike fetch()), so we need a custom\n        // retryPredicate that retries all errors. We'll keep retrying (with backoff) for 20 seconds total elapsed\n        // time before we return an error back up the chain.\n        .map(createRetryingHandler({ retryPredicate: (r) => r instanceof Error }))\n        // API gateway has 15 seconds timeout, so we rely on that first\n        .map(createTimeoutHandler({ timeout: 20 * 1000 }))\n        .map(\n            createResponseCachingHandler(\n                // COF responses will be removed from cache after 1 week. Keep in mind that the staleWhileRevalidate\n                // strategy will update the cache each time COF is requested – this expiration comes into play only if\n                // e.g. a user doesn't load the page for more than a week.\n                new ExpiringPersistence<ConfigTargetingResponse>(\n                    () => 7 * 24 * 60 * 60,\n                    new IndexedDBPersistence({ databaseName: \"COFCache\" })\n                ),\n                (r: Partial<ConfigTargetingRequest>) => JSON.stringify(r),\n\n                // If we have a matching response already in cache, we'll return it immediately and then update the\n                // cache in the background.\n                staleWhileRevalidateStrategy()\n            )\n        ).handler;\n"]}

package/lib/remote-configuration/remoteConfiguration.d.ts

@@ -0,0 +1,13 @@
+import { Observable } from "rxjs";
+import { CameraKitConfiguration } from "../configuration";
+import { ConfigResult } from "../generated-proto/pb_schema/cdp/cof/config_result";
+export declare class RemoteConfiguration {
+    private readonly configById;
+    constructor(apiToken: string, lensPerformance: CameraKitConfiguration["lensPerformance"]);
+    get(configId: string): Observable<ConfigResult[]>;
+}
+export declare const remoteConfigurationFactory: {
+    (args_0: CameraKitConfiguration): RemoteConfiguration;
+    token: "remoteConfiguration";
+    dependencies: readonly ["configuration"];
+};

package/lib/remote-configuration/remoteConfiguration.js

@@ -0,0 +1,43 @@
+import { from, map, mergeMap, shareReplay, take } from "rxjs";
+import { configurationToken } from "../configuration";
+import { Injectable } from "../dependency-injection/Injectable";
+import { Namespace } from "../generated-proto/pb_schema/cdp/cof/namespace";
+import { cofHandlerFactory } from "./cofHandler";
+const defaultTargetingRequest = {
+    namespaces: [Namespace.LENS_CORE, Namespace.CAMERA_KIT_CORE],
+};
+export class RemoteConfiguration {
+    constructor(apiToken, lensPerformance) {
+        const lensCluster = Promise.resolve(lensPerformance).then((lensPerformance) => {
+            // `0` means no cluster could be determined. For COF, we'll omit a value in that case.
+            return (lensPerformance === null || lensPerformance === void 0 ? void 0 : lensPerformance.cluster) === 0 ? undefined : lensPerformance === null || lensPerformance === void 0 ? void 0 : lensPerformance.cluster;
+        });
+        const cofHandler = cofHandlerFactory(apiToken);
+        this.configById = from(lensCluster).pipe(
+        // Note: we don't catch errors here, purposefully letting them propagate to subscribers outside this class.
+        // Subscribers, having more context about the config use-case, will know better how to handle an error than
+        // we do here (e.g. their logging / reporting will have more context, and they can use the error they get
+        // from this Observable as a cause).
+        mergeMap((lensClusterOrig4) => from(cofHandler(Object.assign(Object.assign({}, defaultTargetingRequest), { lensClusterOrig4 })))), map((result) => {
+            const configById = new Map();
+            result.configResults.forEach((config) => {
+                var _a;
+                const configsWithId = (_a = configById.get(config.configId)) !== null && _a !== void 0 ? _a : [];
+                configsWithId.push(config);
+                configById.set(config.configId, configsWithId);
+            });
+            return configById;
+        }), shareReplay(1));
+    }
+    get(configId) {
+        return this.configById.pipe(map((config) => { var _a; return (_a = config.get(configId)) !== null && _a !== void 0 ? _a : []; }));
+    }
+}
+export const remoteConfigurationFactory = Injectable("remoteConfiguration", [configurationToken], (config) => {
+    const remoteConfig = new RemoteConfiguration(config.apiToken, config.lensPerformance);
+    // We'll kick off remote configuration loading by subscribing (and then unsubscribing) to a dummy config value.
+    // Subsequent requests for config will use the shared Observable, benefitting from this eager loading.
+    remoteConfig.get("").pipe(take(1)).subscribe();
+    return remoteConfig;
+});
+//# sourceMappingURL=remoteConfiguration.js.map

package/lib/remote-configuration/remoteConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remoteConfiguration.js","sourceRoot":"","sources":["../../src/remote-configuration/remoteConfiguration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAc,WAAW,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC1E,OAAO,EAA0B,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAGhE,OAAO,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD,MAAM,uBAAuB,GAAoC;IAC7D,UAAU,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,eAAe,CAAC;CAC/D,CAAC;AAEF,MAAM,OAAO,mBAAmB;IAG5B,YAAY,QAAgB,EAAE,eAA0D;QACpF,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,EAAE;YAC1E,sFAAsF;YACtF,OAAO,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,MAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,CAAC;QACjF,CAAC,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAE/C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI;QACpC,2GAA2G;QAC3G,2GAA2G;QAC3G,yGAAyG;QACzG,oCAAoC;QACpC,QAAQ,CAAC,CAAC,gBAAgB,EAAE,EAAE,CAC1B,IAAI,CACA,UAAU,iCACH,uBAAuB,KAC1B,gBAAgB,IAClB,CACL,CACJ,EACD,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACX,MAAM,UAAU,GAAG,IAAI,GAAG,EAA0B,CAAC;YACrD,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;;gBACpC,MAAM,aAAa,GAAG,MAAA,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,mCAAI,EAAE,CAAC;gBAC5D,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC3B,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;YACH,OAAO,UAAU,CAAC;QACtB,CAAC,CAAC,EACF,WAAW,CAAC,CAAC,CAAC,CACjB,CAAC;IACN,CAAC;IAED,GAAG,CAAC,QAAgB;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,WAAC,OAAA,MAAA,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,mCAAI,EAAE,CAAA,EAAA,CAAC,CAAC,CAAC;IAC7E,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,0BAA0B,GAAG,UAAU,CAChD,qBAAqB,EACrB,CAAC,kBAAkB,CAAU,EAC7B,CAAC,MAA8B,EAAuB,EAAE;IACpD,MAAM,YAAY,GAAG,IAAI,mBAAmB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;IAEtF,+GAA+G;IAC/G,sGAAsG;IACtG,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;IAE/C,OAAO,YAAY,CAAC;AACxB,CAAC,CACJ,CAAC","sourcesContent":["import { from, map, mergeMap, Observable, shareReplay, take } from \"rxjs\";\nimport { CameraKitConfiguration, configurationToken } from \"../configuration\";\nimport { Injectable } from \"../dependency-injection/Injectable\";\nimport { ConfigTargetingRequest } from \"../generated-proto/pb_schema/cdp/cof/config_request\";\nimport { ConfigResult } from \"../generated-proto/pb_schema/cdp/cof/config_result\";\nimport { Namespace } from \"../generated-proto/pb_schema/cdp/cof/namespace\";\nimport { cofHandlerFactory } from \"./cofHandler\";\n\nconst defaultTargetingRequest: Partial<ConfigTargetingRequest> = {\n    namespaces: [Namespace.LENS_CORE, Namespace.CAMERA_KIT_CORE],\n};\n\nexport class RemoteConfiguration {\n    private readonly configById: Observable<Map<string, ConfigResult[]>>;\n\n    constructor(apiToken: string, lensPerformance: CameraKitConfiguration[\"lensPerformance\"]) {\n        const lensCluster = Promise.resolve(lensPerformance).then((lensPerformance) => {\n            // `0` means no cluster could be determined. For COF, we'll omit a value in that case.\n            return lensPerformance?.cluster === 0 ? undefined : lensPerformance?.cluster;\n        });\n\n        const cofHandler = cofHandlerFactory(apiToken);\n\n        this.configById = from(lensCluster).pipe(\n            // Note: we don't catch errors here, purposefully letting them propagate to subscribers outside this class.\n            // Subscribers, having more context about the config use-case, will know better how to handle an error than\n            // we do here (e.g. their logging / reporting will have more context, and they can use the error they get\n            // from this Observable as a cause).\n            mergeMap((lensClusterOrig4) =>\n                from(\n                    cofHandler({\n                        ...defaultTargetingRequest,\n                        lensClusterOrig4,\n                    })\n                )\n            ),\n            map((result) => {\n                const configById = new Map<string, ConfigResult[]>();\n                result.configResults.forEach((config) => {\n                    const configsWithId = configById.get(config.configId) ?? [];\n                    configsWithId.push(config);\n                    configById.set(config.configId, configsWithId);\n                });\n                return configById;\n            }),\n            shareReplay(1)\n        );\n    }\n\n    get(configId: string): Observable<ConfigResult[]> {\n        return this.configById.pipe(map((config) => config.get(configId) ?? []));\n    }\n}\n\nexport const remoteConfigurationFactory = Injectable(\n    \"remoteConfiguration\",\n    [configurationToken] as const,\n    (config: CameraKitConfiguration): RemoteConfiguration => {\n        const remoteConfig = new RemoteConfiguration(config.apiToken, config.lensPerformance);\n\n        // We'll kick off remote configuration loading by subscribing (and then unsubscribing) to a dummy config value.\n        // Subsequent requests for config will use the shared Observable, benefitting from this eager loading.\n        remoteConfig.get(\"\").pipe(take(1)).subscribe();\n\n        return remoteConfig;\n    }\n);\n"]}