@cubist-labs/cubesigner-sdk-browser-storage 0.4.21-0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,34 @@
1
+ import type { SessionData, SessionManager, SessionMetadata } from "@cubist-labs/cubesigner-sdk";
2
+ import { EventEmitter } from "@cubist-labs/cubesigner-sdk";
3
+ type BrowserStorageEvents = {
4
+ logout(): void;
5
+ login(): void;
6
+ };
7
+ /**
8
+ * A manager that persists into browser storage and uses weblocks to safely perform refreshes
9
+ */
10
+ export declare class BrowserStorageManager extends EventEmitter<BrowserStorageEvents> implements SessionManager {
11
+ #private;
12
+ /**
13
+ *
14
+ * @param {string} key The storage key to use
15
+ * @param {Storage} [storage] The storage object to use (defaults to localStorage)
16
+ */
17
+ constructor(key: string, storage?: Storage);
18
+ /**
19
+ * Loads the metadata for a session from storage
20
+ * @return {SessionMetadata} The session metadata
21
+ */
22
+ metadata(): Promise<SessionMetadata>;
23
+ /**
24
+ * Loads the current access token from storage
25
+ * @return {string} The access token
26
+ */
27
+ token(): Promise<string>;
28
+ /**
29
+ * Directly set the session (updating all consumers of the session storage)
30
+ * @param {SessionData} [session] The new session
31
+ */
32
+ setSession(session?: SessionData): Promise<any>;
33
+ }
34
+ export {};
package/dist/index.js ADDED
@@ -0,0 +1,130 @@
1
+ "use strict";
2
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
3
+ if (kind === "m") throw new TypeError("Private method is not writable");
4
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
5
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
6
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
7
+ };
8
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
9
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
10
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
11
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
12
+ };
13
+ var _BrowserStorageManager_instances, _BrowserStorageManager_key, _BrowserStorageManager_storage, _BrowserStorageManager_lock, _BrowserStorageManager_emitIfNecessary, _BrowserStorageManager_loadSession;
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.BrowserStorageManager = void 0;
16
+ const cubesigner_sdk_1 = require("@cubist-labs/cubesigner-sdk");
17
+ const locks_1 = require("./locks");
18
+ /**
19
+ * A manager that persists into browser storage and uses weblocks to safely perform refreshes
20
+ */
21
+ class BrowserStorageManager extends cubesigner_sdk_1.EventEmitter {
22
+ /**
23
+ *
24
+ * @param {string} key The storage key to use
25
+ * @param {Storage} [storage] The storage object to use (defaults to localStorage)
26
+ */
27
+ constructor(key, storage = globalThis.localStorage) {
28
+ super();
29
+ _BrowserStorageManager_instances.add(this);
30
+ /** The storage key for the session data */
31
+ _BrowserStorageManager_key.set(this, void 0);
32
+ _BrowserStorageManager_storage.set(this, void 0);
33
+ _BrowserStorageManager_lock.set(this, void 0);
34
+ __classPrivateFieldSet(this, _BrowserStorageManager_key, key, "f");
35
+ __classPrivateFieldSet(this, _BrowserStorageManager_storage, storage, "f");
36
+ (__classPrivateFieldSet(this, _BrowserStorageManager_lock, `CS_SDK_STORAGE_LOCK_${key}`, "f")),
37
+ // Set up listeners to emit events when users log in or log out
38
+ window.addEventListener("storage", (ev) => {
39
+ // We only care about events on our storage object, using our key
40
+ if (ev.storageArea !== storage || ev.key !== key)
41
+ return;
42
+ __classPrivateFieldGet(this, _BrowserStorageManager_instances, "m", _BrowserStorageManager_emitIfNecessary).call(this, ev.oldValue, ev.newValue);
43
+ });
44
+ }
45
+ /**
46
+ * Loads the metadata for a session from storage
47
+ * @return {SessionMetadata} The session metadata
48
+ */
49
+ async metadata() {
50
+ const sess = __classPrivateFieldGet(this, _BrowserStorageManager_instances, "m", _BrowserStorageManager_loadSession).call(this);
51
+ if (!sess) {
52
+ throw new cubesigner_sdk_1.NoSessionFoundError();
53
+ }
54
+ return (0, cubesigner_sdk_1.metadata)(sess);
55
+ }
56
+ /**
57
+ * Loads the current access token from storage
58
+ * @return {string} The access token
59
+ */
60
+ async token() {
61
+ const sess = await (0, locks_1.readTestAndSet)(__classPrivateFieldGet(this, _BrowserStorageManager_lock, "f"), {
62
+ read: () => __classPrivateFieldGet(this, _BrowserStorageManager_instances, "m", _BrowserStorageManager_loadSession).call(this),
63
+ test: (v) => v !== undefined && (0, cubesigner_sdk_1.isStale)(v),
64
+ set: async (oldSession) => {
65
+ if ((0, cubesigner_sdk_1.isRefreshable)(oldSession)) {
66
+ try {
67
+ const newSession = await (0, cubesigner_sdk_1.refresh)(oldSession);
68
+ __classPrivateFieldGet(this, _BrowserStorageManager_storage, "f").setItem(__classPrivateFieldGet(this, _BrowserStorageManager_key, "f"), JSON.stringify(newSession));
69
+ console.log("Successfully refreshed");
70
+ }
71
+ catch (e) {
72
+ if (e instanceof cubesigner_sdk_1.ErrResponse && e.status === 403) {
73
+ __classPrivateFieldGet(this, _BrowserStorageManager_storage, "f").removeItem(__classPrivateFieldGet(this, _BrowserStorageManager_key, "f"));
74
+ }
75
+ }
76
+ }
77
+ else {
78
+ // If the session is not refreshable, we should remove it
79
+ __classPrivateFieldGet(this, _BrowserStorageManager_storage, "f").removeItem(__classPrivateFieldGet(this, _BrowserStorageManager_key, "f"));
80
+ }
81
+ // Notify that the session has changed
82
+ __classPrivateFieldGet(this, _BrowserStorageManager_instances, "m", _BrowserStorageManager_emitIfNecessary).call(this, "", __classPrivateFieldGet(this, _BrowserStorageManager_storage, "f").getItem(__classPrivateFieldGet(this, _BrowserStorageManager_key, "f")));
83
+ },
84
+ });
85
+ if (!sess) {
86
+ throw new cubesigner_sdk_1.NoSessionFoundError();
87
+ }
88
+ return sess.token;
89
+ }
90
+ /**
91
+ * Directly set the session (updating all consumers of the session storage)
92
+ * @param {SessionData} [session] The new session
93
+ */
94
+ async setSession(session) {
95
+ return await navigator.locks.request(__classPrivateFieldGet(this, _BrowserStorageManager_lock, "f"), {
96
+ mode: "exclusive",
97
+ }, async () => {
98
+ const oldValue = __classPrivateFieldGet(this, _BrowserStorageManager_storage, "f").getItem(__classPrivateFieldGet(this, _BrowserStorageManager_key, "f"));
99
+ const newValue = session ? JSON.stringify(session) : null;
100
+ // Unlike during refresh, we don't pre-empt the read locks
101
+ // because this operation is synchronous
102
+ if (newValue) {
103
+ __classPrivateFieldGet(this, _BrowserStorageManager_storage, "f").setItem(__classPrivateFieldGet(this, _BrowserStorageManager_key, "f"), newValue);
104
+ }
105
+ else {
106
+ __classPrivateFieldGet(this, _BrowserStorageManager_storage, "f").removeItem(__classPrivateFieldGet(this, _BrowserStorageManager_key, "f"));
107
+ }
108
+ // Storage events don't fire if the store occurred on the same page,
109
+ // so we have to manually invoke our emit logic
110
+ __classPrivateFieldGet(this, _BrowserStorageManager_instances, "m", _BrowserStorageManager_emitIfNecessary).call(this, oldValue, newValue);
111
+ });
112
+ }
113
+ }
114
+ exports.BrowserStorageManager = BrowserStorageManager;
115
+ _BrowserStorageManager_key = new WeakMap(), _BrowserStorageManager_storage = new WeakMap(), _BrowserStorageManager_lock = new WeakMap(), _BrowserStorageManager_instances = new WeakSet(), _BrowserStorageManager_emitIfNecessary = function _BrowserStorageManager_emitIfNecessary(oldValue, newValue) {
116
+ if (newValue === null && oldValue !== null) {
117
+ this.emit("logout");
118
+ }
119
+ // There is now a session when there didn't used to be.
120
+ else if (oldValue === null && newValue !== null) {
121
+ this.emit("login");
122
+ }
123
+ }, _BrowserStorageManager_loadSession = function _BrowserStorageManager_loadSession() {
124
+ const stored = __classPrivateFieldGet(this, _BrowserStorageManager_storage, "f").getItem(__classPrivateFieldGet(this, _BrowserStorageManager_key, "f"));
125
+ if (stored === null) {
126
+ return;
127
+ }
128
+ return JSON.parse(stored);
129
+ };
130
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,gEAQqC;AACrC,mCAAyC;AAOzC;;GAEG;AACH,MAAa,qBACX,SAAQ,6BAAkC;IAQ1C;;;;OAIG;IACH,YAAY,GAAW,EAAE,UAAmB,UAAU,CAAC,YAAY;QACjE,KAAK,EAAE,CAAC;;QAXV,2CAA2C;QAC3C,6CAAa;QACb,iDAAkB;QAClB,8CAAc;QASZ,uBAAA,IAAI,8BAAQ,GAAG,MAAA,CAAC;QAChB,uBAAA,IAAI,kCAAY,OAAO,MAAA,CAAC;QACxB,CAAC,uBAAA,IAAI,+BAAS,uBAAuB,GAAG,EAAE,MAAA,CAAC;YACzC,+DAA+D;YAC/D,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE;gBACxC,iEAAiE;gBACjE,IAAI,EAAE,CAAC,WAAW,KAAK,OAAO,IAAI,EAAE,CAAC,GAAG,KAAK,GAAG;oBAAE,OAAO;gBACzD,uBAAA,IAAI,gFAAiB,MAArB,IAAI,EAAkB,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;IACP,CAAC;IA+BD;;;OAGG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,IAAI,GAAG,uBAAA,IAAI,4EAAa,MAAjB,IAAI,CAAe,CAAC;QACjC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,oCAAmB,EAAE,CAAC;QAClC,CAAC;QACD,OAAO,IAAA,yBAAQ,EAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,GAAG,MAAM,IAAA,sBAAc,EAA0B,uBAAA,IAAI,mCAAM,EAAE;YACrE,IAAI,EAAE,GAAG,EAAE,CAAC,uBAAA,IAAI,4EAAa,MAAjB,IAAI,CAAe;YAC/B,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,IAAA,wBAAO,EAAC,CAAC,CAAC;YAC1C,GAAG,EAAE,KAAK,EAAE,UAAuB,EAAE,EAAE;gBACrC,IAAI,IAAA,8BAAa,EAAC,UAAU,CAAC,EAAE,CAAC;oBAC9B,IAAI,CAAC;wBACH,MAAM,UAAU,GAAG,MAAM,IAAA,wBAAO,EAAC,UAAU,CAAC,CAAC;wBAC7C,uBAAA,IAAI,sCAAS,CAAC,OAAO,CAAC,uBAAA,IAAI,kCAAK,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;wBAC7D,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;oBACxC,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,IAAI,CAAC,YAAY,4BAAW,IAAI,CAAC,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;4BACjD,uBAAA,IAAI,sCAAS,CAAC,UAAU,CAAC,uBAAA,IAAI,kCAAK,CAAC,CAAC;wBACtC,CAAC;oBACH,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,yDAAyD;oBACzD,uBAAA,IAAI,sCAAS,CAAC,UAAU,CAAC,uBAAA,IAAI,kCAAK,CAAC,CAAC;gBACtC,CAAC;gBAED,sCAAsC;gBACtC,uBAAA,IAAI,gFAAiB,MAArB,IAAI,EAAkB,EAAE,EAAE,uBAAA,IAAI,sCAAS,CAAC,OAAO,CAAC,uBAAA,IAAI,kCAAK,CAAC,CAAC,CAAC;YAC9D,CAAC;SACF,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,oCAAmB,EAAE,CAAC;QAClC,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,OAAqB;QACpC,OAAO,MAAM,SAAS,CAAC,KAAK,CAAC,OAAO,CAClC,uBAAA,IAAI,mCAAM,EACV;YACE,IAAI,EAAE,WAAW;SAClB,EACD,KAAK,IAAI,EAAE;YACT,MAAM,QAAQ,GAAG,uBAAA,IAAI,sCAAS,CAAC,OAAO,CAAC,uBAAA,IAAI,kCAAK,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAE1D,0DAA0D;YAC1D,wCAAwC;YACxC,IAAI,QAAQ,EAAE,CAAC;gBACb,uBAAA,IAAI,sCAAS,CAAC,OAAO,CAAC,uBAAA,IAAI,kCAAK,EAAE,QAAQ,CAAC,CAAC;YAC7C,CAAC;iBAAM,CAAC;gBACN,uBAAA,IAAI,sCAAS,CAAC,UAAU,CAAC,uBAAA,IAAI,kCAAK,CAAC,CAAC;YACtC,CAAC;YAED,oEAAoE;YACpE,+CAA+C;YAC/C,uBAAA,IAAI,gFAAiB,MAArB,IAAI,EAAkB,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC5C,CAAC,CACF,CAAC;IACJ,CAAC;CACF;AAlID,sDAkIC;oRAlGkB,QAAuB,EAAE,QAAuB;IAC/D,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC3C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtB,CAAC;IAED,uDAAuD;SAClD,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QAChD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;AACH,CAAC;IAOC,MAAM,MAAM,GAAG,uBAAA,IAAI,sCAAS,CAAC,OAAO,CAAC,uBAAA,IAAI,kCAAK,CAAC,CAAC;IAChD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO;IACT,CAAC;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC","sourcesContent":["import type { SessionData, SessionManager, SessionMetadata } from \"@cubist-labs/cubesigner-sdk\";\nimport {\n  EventEmitter,\n  NoSessionFoundError,\n  isStale,\n  isRefreshable,\n  metadata,\n  refresh,\n  ErrResponse,\n} from \"@cubist-labs/cubesigner-sdk\";\nimport { readTestAndSet } from \"./locks\";\n\ntype BrowserStorageEvents = {\n  logout(): void;\n  login(): void;\n};\n\n/**\n * A manager that persists into browser storage and uses weblocks to safely perform refreshes\n */\nexport class BrowserStorageManager\n  extends EventEmitter<BrowserStorageEvents>\n  implements SessionManager\n{\n  /** The storage key for the session data */\n  #key: string;\n  #storage: Storage;\n  #lock: string;\n\n  /**\n   *\n   * @param {string} key The storage key to use\n   * @param {Storage} [storage] The storage object to use (defaults to localStorage)\n   */\n  constructor(key: string, storage: Storage = globalThis.localStorage) {\n    super();\n    this.#key = key;\n    this.#storage = storage;\n    (this.#lock = `CS_SDK_STORAGE_LOCK_${key}`),\n      // Set up listeners to emit events when users log in or log out\n      window.addEventListener(\"storage\", (ev) => {\n        // We only care about events on our storage object, using our key\n        if (ev.storageArea !== storage || ev.key !== key) return;\n        this.#emitIfNecessary(ev.oldValue, ev.newValue);\n      });\n  }\n\n  /**\n   * Emits a `login` or `logout` event if necessary\n   * @param {null | string} oldValue The previously stored value\n   * @param {null | string} newValue The newly stored value\n   */\n  #emitIfNecessary(oldValue: null | string, newValue: string | null) {\n    if (newValue === null && oldValue !== null) {\n      this.emit(\"logout\");\n    }\n\n    // There is now a session when there didn't used to be.\n    else if (oldValue === null && newValue !== null) {\n      this.emit(\"login\");\n    }\n  }\n\n  /**\n   * Loads a session from the configured storage at the configured key\n   * @return {SessionData | undefined} The stored data or undefined if not present\n   */\n  #loadSession(): SessionData | undefined {\n    const stored = this.#storage.getItem(this.#key);\n    if (stored === null) {\n      return;\n    }\n\n    return JSON.parse(stored);\n  }\n\n  /**\n   * Loads the metadata for a session from storage\n   * @return {SessionMetadata} The session metadata\n   */\n  async metadata(): Promise<SessionMetadata> {\n    const sess = this.#loadSession();\n    if (!sess) {\n      throw new NoSessionFoundError();\n    }\n    return metadata(sess);\n  }\n\n  /**\n   * Loads the current access token from storage\n   * @return {string} The access token\n   */\n  async token(): Promise<string> {\n    const sess = await readTestAndSet<SessionData | undefined>(this.#lock, {\n      read: () => this.#loadSession(),\n      test: (v) => v !== undefined && isStale(v),\n      set: async (oldSession: SessionData) => {\n        if (isRefreshable(oldSession)) {\n          try {\n            const newSession = await refresh(oldSession);\n            this.#storage.setItem(this.#key, JSON.stringify(newSession));\n            console.log(\"Successfully refreshed\");\n          } catch (e) {\n            if (e instanceof ErrResponse && e.status === 403) {\n              this.#storage.removeItem(this.#key);\n            }\n          }\n        } else {\n          // If the session is not refreshable, we should remove it\n          this.#storage.removeItem(this.#key);\n        }\n\n        // Notify that the session has changed\n        this.#emitIfNecessary(\"\", this.#storage.getItem(this.#key));\n      },\n    });\n    if (!sess) {\n      throw new NoSessionFoundError();\n    }\n    return sess.token;\n  }\n\n  /**\n   * Directly set the session (updating all consumers of the session storage)\n   * @param {SessionData} [session] The new session\n   */\n  async setSession(session?: SessionData) {\n    return await navigator.locks.request(\n      this.#lock,\n      {\n        mode: \"exclusive\",\n      },\n      async () => {\n        const oldValue = this.#storage.getItem(this.#key);\n        const newValue = session ? JSON.stringify(session) : null;\n\n        // Unlike during refresh, we don't pre-empt the read locks\n        // because this operation is synchronous\n        if (newValue) {\n          this.#storage.setItem(this.#key, newValue);\n        } else {\n          this.#storage.removeItem(this.#key);\n        }\n\n        // Storage events don't fire if the store occurred on the same page,\n        // so we have to manually invoke our emit logic\n        this.#emitIfNecessary(oldValue, newValue);\n      },\n    );\n  }\n}\n"]}
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Used as an argument to {@link readTestAndSet}.
3
+ * Defines the behavior to perform during the locking strategy
4
+ */
5
+ export type ReadTestAndSet<T> = {
6
+ /** How to read the data */
7
+ read(): T;
8
+ /** If true, perform set, if false, return v */
9
+ test(v: T): boolean;
10
+ /** Persist the value */
11
+ set(prev: T): Promise<void>;
12
+ };
13
+ /**
14
+ * A locking primitive for contentious reads and writes.
15
+ *
16
+ * Guarantees:
17
+ * 1. Set is only called when test(read()) returns true
18
+ * 2. Only 1 set() call is active at a time
19
+ * 3. read() never occurs while set() is running
20
+ *
21
+ * @param {string} lock The name of the lock to use
22
+ * @param {ReadTestAndSet} spec The set of read, test, and set functions to use
23
+ * @return {Promise<T>} The current value
24
+ */
25
+ export declare function readTestAndSet<T>(lock: string, { read, test, set }: ReadTestAndSet<T>): Promise<T>;
package/dist/locks.js ADDED
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.readTestAndSet = void 0;
4
+ /**
5
+ * A locking primitive for contentious reads and writes.
6
+ *
7
+ * Guarantees:
8
+ * 1. Set is only called when test(read()) returns true
9
+ * 2. Only 1 set() call is active at a time
10
+ * 3. read() never occurs while set() is running
11
+ *
12
+ * @param {string} lock The name of the lock to use
13
+ * @param {ReadTestAndSet} spec The set of read, test, and set functions to use
14
+ * @return {Promise<T>} The current value
15
+ */
16
+ async function readTestAndSet(lock, { read, test, set }) {
17
+ const value = await navigator.locks.request(lock, { mode: "shared" }, async () => read());
18
+ if (test(value)) {
19
+ return navigator.locks.request(lock, { mode: "exclusive" }, async () => {
20
+ const prev = read();
21
+ if (test(prev)) {
22
+ await set(prev);
23
+ return read();
24
+ }
25
+ return prev;
26
+ });
27
+ }
28
+ return value;
29
+ }
30
+ exports.readTestAndSet = readTestAndSet;
31
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9ja3MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvbG9ja3MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBYUE7Ozs7Ozs7Ozs7O0dBV0c7QUFDSSxLQUFLLFVBQVUsY0FBYyxDQUNsQyxJQUFZLEVBQ1osRUFBRSxJQUFJLEVBQUUsSUFBSSxFQUFFLEdBQUcsRUFBcUI7SUFFdEMsTUFBTSxLQUFLLEdBQUcsTUFBTSxTQUFTLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsRUFBRSxJQUFJLEVBQUUsUUFBUSxFQUFFLEVBQUUsS0FBSyxJQUFJLEVBQUUsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBQzFGLElBQUksSUFBSSxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDaEIsT0FBTyxTQUFTLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsRUFBRSxJQUFJLEVBQUUsV0FBVyxFQUFFLEVBQUUsS0FBSyxJQUFJLEVBQUU7WUFDckUsTUFBTSxJQUFJLEdBQUcsSUFBSSxFQUFFLENBQUM7WUFDcEIsSUFBSSxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztnQkFDZixNQUFNLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQztnQkFDaEIsT0FBTyxJQUFJLEVBQUUsQ0FBQztZQUNoQixDQUFDO1lBQ0QsT0FBTyxJQUFJLENBQUM7UUFDZCxDQUFDLENBQUMsQ0FBQztJQUNMLENBQUM7SUFDRCxPQUFPLEtBQUssQ0FBQztBQUNmLENBQUM7QUFoQkQsd0NBZ0JDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBVc2VkIGFzIGFuIGFyZ3VtZW50IHRvIHtAbGluayByZWFkVGVzdEFuZFNldH0uXG4gKiBEZWZpbmVzIHRoZSBiZWhhdmlvciB0byBwZXJmb3JtIGR1cmluZyB0aGUgbG9ja2luZyBzdHJhdGVneVxuICovXG5leHBvcnQgdHlwZSBSZWFkVGVzdEFuZFNldDxUPiA9IHtcbiAgLyoqIEhvdyB0byByZWFkIHRoZSBkYXRhICovXG4gIHJlYWQoKTogVDtcbiAgLyoqIElmIHRydWUsIHBlcmZvcm0gc2V0LCBpZiBmYWxzZSwgcmV0dXJuIHYgKi9cbiAgdGVzdCh2OiBUKTogYm9vbGVhbjtcbiAgLyoqIFBlcnNpc3QgdGhlIHZhbHVlICovXG4gIHNldChwcmV2OiBUKTogUHJvbWlzZTx2b2lkPjtcbn07XG5cbi8qKlxuICogQSBsb2NraW5nIHByaW1pdGl2ZSBmb3IgY29udGVudGlvdXMgcmVhZHMgYW5kIHdyaXRlcy5cbiAqXG4gKiBHdWFyYW50ZWVzOlxuICogIDEuIFNldCBpcyBvbmx5IGNhbGxlZCB3aGVuIHRlc3QocmVhZCgpKSByZXR1cm5zIHRydWVcbiAqICAyLiBPbmx5IDEgc2V0KCkgY2FsbCBpcyBhY3RpdmUgYXQgYSB0aW1lXG4gKiAgMy4gcmVhZCgpIG5ldmVyIG9jY3VycyB3aGlsZSBzZXQoKSBpcyBydW5uaW5nXG4gKlxuICogQHBhcmFtIHtzdHJpbmd9IGxvY2sgVGhlIG5hbWUgb2YgdGhlIGxvY2sgdG8gdXNlXG4gKiBAcGFyYW0ge1JlYWRUZXN0QW5kU2V0fSBzcGVjIFRoZSBzZXQgb2YgcmVhZCwgdGVzdCwgYW5kIHNldCBmdW5jdGlvbnMgdG8gdXNlXG4gKiBAcmV0dXJuIHtQcm9taXNlPFQ+fSBUaGUgY3VycmVudCB2YWx1ZVxuICovXG5leHBvcnQgYXN5bmMgZnVuY3Rpb24gcmVhZFRlc3RBbmRTZXQ8VD4oXG4gIGxvY2s6IHN0cmluZyxcbiAgeyByZWFkLCB0ZXN0LCBzZXQgfTogUmVhZFRlc3RBbmRTZXQ8VD4sXG4pOiBQcm9taXNlPFQ+IHtcbiAgY29uc3QgdmFsdWUgPSBhd2FpdCBuYXZpZ2F0b3IubG9ja3MucmVxdWVzdChsb2NrLCB7IG1vZGU6IFwic2hhcmVkXCIgfSwgYXN5bmMgKCkgPT4gcmVhZCgpKTtcbiAgaWYgKHRlc3QodmFsdWUpKSB7XG4gICAgcmV0dXJuIG5hdmlnYXRvci5sb2Nrcy5yZXF1ZXN0KGxvY2ssIHsgbW9kZTogXCJleGNsdXNpdmVcIiB9LCBhc3luYyAoKSA9PiB7XG4gICAgICBjb25zdCBwcmV2ID0gcmVhZCgpO1xuICAgICAgaWYgKHRlc3QocHJldikpIHtcbiAgICAgICAgYXdhaXQgc2V0KHByZXYpO1xuICAgICAgICByZXR1cm4gcmVhZCgpO1xuICAgICAgfVxuICAgICAgcmV0dXJuIHByZXY7XG4gICAgfSk7XG4gIH1cbiAgcmV0dXJuIHZhbHVlO1xufVxuIl19
package/package.json ADDED
@@ -0,0 +1,37 @@
1
+ {
2
+ "name": "@cubist-labs/cubesigner-sdk-browser-storage",
3
+ "version": "0.4.21-0",
4
+ "description": "Browser-based storage for CubeSigner SDK sessions",
5
+ "license": "MIT OR Apache-2.0",
6
+ "author": "Cubist, Inc.",
7
+ "main": "dist/index.js",
8
+ "types": "dist/index.d.ts",
9
+ "files": [
10
+ "tsconfig.json",
11
+ "src/**",
12
+ "dist/**",
13
+ "../../NOTICE",
14
+ "../../LICENSE-APACHE",
15
+ "../../LICENSE-MIT"
16
+ ],
17
+ "scripts": {
18
+ "build": "tsc",
19
+ "prepack": "tsc",
20
+ "test:playwright": "playwright test",
21
+ "test:build": "esbuild test/site/testscript.ts --bundle --format=esm --outfile='test/site/testscript.js' --external:crypto",
22
+ "test:server": "http-server ./test/site -c-1"
23
+ },
24
+ "peerDependencies": {
25
+ "@cubist-labs/cubesigner-sdk": "^0.4.21-0"
26
+ },
27
+ "directories": {
28
+ "test": "test"
29
+ },
30
+ "devDependencies": {
31
+ "@cubist-labs/cubesigner-sdk": "^0.4.21-0",
32
+ "@cubist-labs/cubesigner-sdk-fs-storage": "^0.4.21-0",
33
+ "@playwright/test": "^1.42.1",
34
+ "esbuild": "^0.20.1",
35
+ "http-server": "^14.1.1"
36
+ }
37
+ }
package/src/index.ts ADDED
@@ -0,0 +1,151 @@
1
+ import type { SessionData, SessionManager, SessionMetadata } from "@cubist-labs/cubesigner-sdk";
2
+ import {
3
+ EventEmitter,
4
+ NoSessionFoundError,
5
+ isStale,
6
+ isRefreshable,
7
+ metadata,
8
+ refresh,
9
+ ErrResponse,
10
+ } from "@cubist-labs/cubesigner-sdk";
11
+ import { readTestAndSet } from "./locks";
12
+
13
+ type BrowserStorageEvents = {
14
+ logout(): void;
15
+ login(): void;
16
+ };
17
+
18
+ /**
19
+ * A manager that persists into browser storage and uses weblocks to safely perform refreshes
20
+ */
21
+ export class BrowserStorageManager
22
+ extends EventEmitter<BrowserStorageEvents>
23
+ implements SessionManager
24
+ {
25
+ /** The storage key for the session data */
26
+ #key: string;
27
+ #storage: Storage;
28
+ #lock: string;
29
+
30
+ /**
31
+ *
32
+ * @param {string} key The storage key to use
33
+ * @param {Storage} [storage] The storage object to use (defaults to localStorage)
34
+ */
35
+ constructor(key: string, storage: Storage = globalThis.localStorage) {
36
+ super();
37
+ this.#key = key;
38
+ this.#storage = storage;
39
+ (this.#lock = `CS_SDK_STORAGE_LOCK_${key}`),
40
+ // Set up listeners to emit events when users log in or log out
41
+ window.addEventListener("storage", (ev) => {
42
+ // We only care about events on our storage object, using our key
43
+ if (ev.storageArea !== storage || ev.key !== key) return;
44
+ this.#emitIfNecessary(ev.oldValue, ev.newValue);
45
+ });
46
+ }
47
+
48
+ /**
49
+ * Emits a `login` or `logout` event if necessary
50
+ * @param {null | string} oldValue The previously stored value
51
+ * @param {null | string} newValue The newly stored value
52
+ */
53
+ #emitIfNecessary(oldValue: null | string, newValue: string | null) {
54
+ if (newValue === null && oldValue !== null) {
55
+ this.emit("logout");
56
+ }
57
+
58
+ // There is now a session when there didn't used to be.
59
+ else if (oldValue === null && newValue !== null) {
60
+ this.emit("login");
61
+ }
62
+ }
63
+
64
+ /**
65
+ * Loads a session from the configured storage at the configured key
66
+ * @return {SessionData | undefined} The stored data or undefined if not present
67
+ */
68
+ #loadSession(): SessionData | undefined {
69
+ const stored = this.#storage.getItem(this.#key);
70
+ if (stored === null) {
71
+ return;
72
+ }
73
+
74
+ return JSON.parse(stored);
75
+ }
76
+
77
+ /**
78
+ * Loads the metadata for a session from storage
79
+ * @return {SessionMetadata} The session metadata
80
+ */
81
+ async metadata(): Promise<SessionMetadata> {
82
+ const sess = this.#loadSession();
83
+ if (!sess) {
84
+ throw new NoSessionFoundError();
85
+ }
86
+ return metadata(sess);
87
+ }
88
+
89
+ /**
90
+ * Loads the current access token from storage
91
+ * @return {string} The access token
92
+ */
93
+ async token(): Promise<string> {
94
+ const sess = await readTestAndSet<SessionData | undefined>(this.#lock, {
95
+ read: () => this.#loadSession(),
96
+ test: (v) => v !== undefined && isStale(v),
97
+ set: async (oldSession: SessionData) => {
98
+ if (isRefreshable(oldSession)) {
99
+ try {
100
+ const newSession = await refresh(oldSession);
101
+ this.#storage.setItem(this.#key, JSON.stringify(newSession));
102
+ console.log("Successfully refreshed");
103
+ } catch (e) {
104
+ if (e instanceof ErrResponse && e.status === 403) {
105
+ this.#storage.removeItem(this.#key);
106
+ }
107
+ }
108
+ } else {
109
+ // If the session is not refreshable, we should remove it
110
+ this.#storage.removeItem(this.#key);
111
+ }
112
+
113
+ // Notify that the session has changed
114
+ this.#emitIfNecessary("", this.#storage.getItem(this.#key));
115
+ },
116
+ });
117
+ if (!sess) {
118
+ throw new NoSessionFoundError();
119
+ }
120
+ return sess.token;
121
+ }
122
+
123
+ /**
124
+ * Directly set the session (updating all consumers of the session storage)
125
+ * @param {SessionData} [session] The new session
126
+ */
127
+ async setSession(session?: SessionData) {
128
+ return await navigator.locks.request(
129
+ this.#lock,
130
+ {
131
+ mode: "exclusive",
132
+ },
133
+ async () => {
134
+ const oldValue = this.#storage.getItem(this.#key);
135
+ const newValue = session ? JSON.stringify(session) : null;
136
+
137
+ // Unlike during refresh, we don't pre-empt the read locks
138
+ // because this operation is synchronous
139
+ if (newValue) {
140
+ this.#storage.setItem(this.#key, newValue);
141
+ } else {
142
+ this.#storage.removeItem(this.#key);
143
+ }
144
+
145
+ // Storage events don't fire if the store occurred on the same page,
146
+ // so we have to manually invoke our emit logic
147
+ this.#emitIfNecessary(oldValue, newValue);
148
+ },
149
+ );
150
+ }
151
+ }
package/src/locks.ts ADDED
@@ -0,0 +1,42 @@
1
+ /**
2
+ * Used as an argument to {@link readTestAndSet}.
3
+ * Defines the behavior to perform during the locking strategy
4
+ */
5
+ export type ReadTestAndSet<T> = {
6
+ /** How to read the data */
7
+ read(): T;
8
+ /** If true, perform set, if false, return v */
9
+ test(v: T): boolean;
10
+ /** Persist the value */
11
+ set(prev: T): Promise<void>;
12
+ };
13
+
14
+ /**
15
+ * A locking primitive for contentious reads and writes.
16
+ *
17
+ * Guarantees:
18
+ * 1. Set is only called when test(read()) returns true
19
+ * 2. Only 1 set() call is active at a time
20
+ * 3. read() never occurs while set() is running
21
+ *
22
+ * @param {string} lock The name of the lock to use
23
+ * @param {ReadTestAndSet} spec The set of read, test, and set functions to use
24
+ * @return {Promise<T>} The current value
25
+ */
26
+ export async function readTestAndSet<T>(
27
+ lock: string,
28
+ { read, test, set }: ReadTestAndSet<T>,
29
+ ): Promise<T> {
30
+ const value = await navigator.locks.request(lock, { mode: "shared" }, async () => read());
31
+ if (test(value)) {
32
+ return navigator.locks.request(lock, { mode: "exclusive" }, async () => {
33
+ const prev = read();
34
+ if (test(prev)) {
35
+ await set(prev);
36
+ return read();
37
+ }
38
+ return prev;
39
+ });
40
+ }
41
+ return value;
42
+ }
package/tsconfig.json ADDED
@@ -0,0 +1,14 @@
1
+ {
2
+ "extends": "../../tsconfig.json",
3
+ "compilerOptions": {
4
+ "module": "Node16",
5
+ "moduleResolution": "node16",
6
+ "outDir": "./dist"
7
+ },
8
+ "typedocOptions": {
9
+ "out": "./docs",
10
+ "entryPoints": ["src/index.ts"]
11
+ },
12
+ "exclude": ["node_modules", "dist"],
13
+ "include": ["src/**/*.ts"]
14
+ }