@webext-core/storage 1.0.0 → 1.1.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.
package/README.md CHANGED
@@ -18,8 +18,9 @@ const value = await localExtStorage.getItem('some-key');
18
18
 
19
19
  If you want to define types for your storage, you can use the `defineExtensionStorage` method:
20
20
 
21
+ ###### storage.ts
22
+
21
23
  ```ts
22
- // storage.ts
23
24
  import Browser from 'webextension-polyfill';
24
25
  import { defineExtensionStorage } from '@webext-core/storage';
25
26
 
package/lib/index.cjs CHANGED
@@ -22,6 +22,26 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
22
22
  mod
23
23
  ));
24
24
  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
25
+ var __async = (__this, __arguments, generator) => {
26
+ return new Promise((resolve, reject) => {
27
+ var fulfilled = (value) => {
28
+ try {
29
+ step(generator.next(value));
30
+ } catch (e) {
31
+ reject(e);
32
+ }
33
+ };
34
+ var rejected = (value) => {
35
+ try {
36
+ step(generator.throw(value));
37
+ } catch (e) {
38
+ reject(e);
39
+ }
40
+ };
41
+ var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
42
+ step((generator = generator.apply(__this, __arguments)).next());
43
+ });
44
+ };
25
45
 
26
46
  // src/index.ts
27
47
  var src_exports = {};
@@ -34,7 +54,37 @@ __export(src_exports, {
34
54
  module.exports = __toCommonJS(src_exports);
35
55
 
36
56
  // src/defineExtensionStorage.ts
57
+ var import_webextension_polyfill = __toESM(require("webextension-polyfill"), 1);
37
58
  function defineExtensionStorage(storage) {
59
+ const area = getStorageName(storage);
60
+ const onStorageChanged = (changes, changedArea) => __async(this, null, function* () {
61
+ if (area !== changedArea)
62
+ return;
63
+ const work = listeners.map(({ key, cb }) => {
64
+ if (!(key in changes))
65
+ return;
66
+ const { newValue, oldValue } = changes[key];
67
+ if (newValue === oldValue)
68
+ return;
69
+ return cb(newValue, oldValue);
70
+ });
71
+ yield Promise.all(work);
72
+ });
73
+ let listeners = [];
74
+ function addListener(listener) {
75
+ if (listeners.length === 0) {
76
+ import_webextension_polyfill.default.storage.onChanged.addListener(onStorageChanged);
77
+ }
78
+ listeners.push(listener);
79
+ }
80
+ function removeListener(listener) {
81
+ const i = listeners.indexOf(listener);
82
+ if (i >= 0)
83
+ listeners.splice(i, 1);
84
+ if (listeners.length === 0) {
85
+ import_webextension_polyfill.default.storage.onChanged.removeListener(onStorageChanged);
86
+ }
87
+ }
38
88
  return {
39
89
  clear: storage.clear,
40
90
  getItem(key) {
@@ -48,15 +98,36 @@ function defineExtensionStorage(storage) {
48
98
  },
49
99
  removeItem(key) {
50
100
  return storage.remove(key);
101
+ },
102
+ onChange(key, cb) {
103
+ const listener = {
104
+ key,
105
+ cb
106
+ };
107
+ addListener(listener);
108
+ return () => removeListener(listener);
51
109
  }
52
110
  };
53
111
  }
112
+ function getStorageName(storage) {
113
+ switch (storage) {
114
+ case import_webextension_polyfill.default.storage.local:
115
+ return "local";
116
+ case import_webextension_polyfill.default.storage.sync:
117
+ return "sync";
118
+ case import_webextension_polyfill.default.storage.managed:
119
+ return "managed";
120
+ }
121
+ throw Error(
122
+ "Unsupported storage area. local, sync, and managed are the only supporte storage areas."
123
+ );
124
+ }
54
125
 
55
126
  // src/index.ts
56
- var import_webextension_polyfill = __toESM(require("webextension-polyfill"), 1);
57
- var localExtStorage = defineExtensionStorage(import_webextension_polyfill.default.storage.local);
58
- var syncExtStorage = defineExtensionStorage(import_webextension_polyfill.default.storage.sync);
59
- var managedExtStorage = defineExtensionStorage(import_webextension_polyfill.default.storage.managed);
127
+ var import_webextension_polyfill2 = __toESM(require("webextension-polyfill"), 1);
128
+ var localExtStorage = defineExtensionStorage(import_webextension_polyfill2.default.storage.local);
129
+ var syncExtStorage = defineExtensionStorage(import_webextension_polyfill2.default.storage.sync);
130
+ var managedExtStorage = defineExtensionStorage(import_webextension_polyfill2.default.storage.managed);
60
131
  // Annotate the CommonJS export names for ESM import in node:
61
132
  0 && (module.exports = {
62
133
  defineExtensionStorage,
package/lib/index.d.ts CHANGED
@@ -1,6 +1,11 @@
1
1
  import { Storage } from 'webextension-polyfill';
2
2
 
3
3
  declare type AnySchema = Record<string, any>;
4
+ /**
5
+ * Call this method to remove the listener that was added.
6
+ */
7
+ declare type RemoveListenerCallback = () => void;
8
+ declare type OnChangeCallback<TSchema extends AnySchema, TKey extends keyof TSchema = keyof TSchema> = (newValue: TSchema[TKey], oldValue: TSchema[TKey] | null) => void;
4
9
  interface ExtensionStorage<TSchema extends AnySchema> {
5
10
  /**
6
11
  * Clear all values from storage.
@@ -19,6 +24,13 @@ interface ExtensionStorage<TSchema extends AnySchema> {
19
24
  * Remove the value from storage at a key.
20
25
  */
21
26
  removeItem<TKey extends keyof TSchema>(key: TKey): Promise<void>;
27
+ /**
28
+ * Add a callback that is executed when a key is changed in the storage. Listeners are executed in
29
+ * parallel, but the first listeners added are always started first.
30
+ *
31
+ * Returns a method that, when called, removes the listener that was added.
32
+ */
33
+ onChange<TKey extends keyof TSchema>(key: TKey, cb: OnChangeCallback<TSchema, TKey>): RemoveListenerCallback;
22
34
  }
23
35
 
24
36
  /**
package/lib/index.js CHANGED
@@ -1,5 +1,56 @@
1
+ var __async = (__this, __arguments, generator) => {
2
+ return new Promise((resolve, reject) => {
3
+ var fulfilled = (value) => {
4
+ try {
5
+ step(generator.next(value));
6
+ } catch (e) {
7
+ reject(e);
8
+ }
9
+ };
10
+ var rejected = (value) => {
11
+ try {
12
+ step(generator.throw(value));
13
+ } catch (e) {
14
+ reject(e);
15
+ }
16
+ };
17
+ var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
18
+ step((generator = generator.apply(__this, __arguments)).next());
19
+ });
20
+ };
21
+
1
22
  // src/defineExtensionStorage.ts
23
+ import browser from "webextension-polyfill";
2
24
  function defineExtensionStorage(storage) {
25
+ const area = getStorageName(storage);
26
+ const onStorageChanged = (changes, changedArea) => __async(this, null, function* () {
27
+ if (area !== changedArea)
28
+ return;
29
+ const work = listeners.map(({ key, cb }) => {
30
+ if (!(key in changes))
31
+ return;
32
+ const { newValue, oldValue } = changes[key];
33
+ if (newValue === oldValue)
34
+ return;
35
+ return cb(newValue, oldValue);
36
+ });
37
+ yield Promise.all(work);
38
+ });
39
+ let listeners = [];
40
+ function addListener(listener) {
41
+ if (listeners.length === 0) {
42
+ browser.storage.onChanged.addListener(onStorageChanged);
43
+ }
44
+ listeners.push(listener);
45
+ }
46
+ function removeListener(listener) {
47
+ const i = listeners.indexOf(listener);
48
+ if (i >= 0)
49
+ listeners.splice(i, 1);
50
+ if (listeners.length === 0) {
51
+ browser.storage.onChanged.removeListener(onStorageChanged);
52
+ }
53
+ }
3
54
  return {
4
55
  clear: storage.clear,
5
56
  getItem(key) {
@@ -13,9 +64,30 @@ function defineExtensionStorage(storage) {
13
64
  },
14
65
  removeItem(key) {
15
66
  return storage.remove(key);
67
+ },
68
+ onChange(key, cb) {
69
+ const listener = {
70
+ key,
71
+ cb
72
+ };
73
+ addListener(listener);
74
+ return () => removeListener(listener);
16
75
  }
17
76
  };
18
77
  }
78
+ function getStorageName(storage) {
79
+ switch (storage) {
80
+ case browser.storage.local:
81
+ return "local";
82
+ case browser.storage.sync:
83
+ return "sync";
84
+ case browser.storage.managed:
85
+ return "managed";
86
+ }
87
+ throw Error(
88
+ "Unsupported storage area. local, sync, and managed are the only supporte storage areas."
89
+ );
90
+ }
19
91
 
20
92
  // src/index.ts
21
93
  import Browser from "webextension-polyfill";
package/package.json CHANGED
@@ -1,8 +1,27 @@
1
1
  {
2
2
  "name": "@webext-core/storage",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "description": "Local storage based wrapper around the Browser.storage APIs",
5
5
  "license": "MIT",
6
+ "keywords": [
7
+ "web-extension",
8
+ "browser-extension",
9
+ "chrome-extension",
10
+ "webext",
11
+ "web-ext",
12
+ "web",
13
+ "chrome",
14
+ "browser",
15
+ "extension",
16
+ "storage",
17
+ "webextension-polyfill"
18
+ ],
19
+ "homepage": "https://github.com/aklinker1/webext-core/tree/main/packages/storage",
20
+ "repository": {
21
+ "type": "git",
22
+ "url": "https://github.com/aklinker1/webext-core",
23
+ "directory": "packages/storage"
24
+ },
6
25
  "type": "module",
7
26
  "publishConfig": {
8
27
  "access": "public"
@@ -28,11 +47,12 @@
28
47
  "tsup": "^6.4.0",
29
48
  "typescript": "^4.8.4",
30
49
  "vitest": "^0.24.5",
31
- "@webext-core/fake-browser": "1.0.0",
50
+ "@webext-core/fake-browser": "1.0.2",
32
51
  "tsconfig": "0.0.0"
33
52
  },
34
53
  "scripts": {
35
54
  "build": "tsup src/index.ts --clean --out-dir lib --format esm,cjs --dts",
55
+ "build:dependencies": "cd ../.. && turbo run build --filter=@webext-core/storage^...",
36
56
  "test": "vitest -r src",
37
57
  "test:coverage": "vitest run -r src --coverage",
38
58
  "compile": "tsc --noEmit"