Adding 'many()' feature for 'get()', 'set()', and 'remove()' API methods

closes #5 closes #6

Squashed commit of the following:

commit a32f35a3e61daf03418fce842b91e6b62143a347
Author: Kyle Simpson <[email protected]>
Date:   Thu Dec 19 10:57:01 2024 -0600

    fixing/improving 'many' implementations from @MuaviyaImran per #6, improving tests, adding docs

commit 5600326
Merge: 01ba6fc 71977a6
Author: Muaviya Imran <[email protected]>
Date:   Thu Dec 19 02:50:02 2024 +0500

    Merge branch 'main' into f/enhancement-set-get-remove-many

commit 01ba6fc
Author: Muaviyaimran <[email protected]>
Date:   Thu Dec 19 02:49:04 2024 +0500

    Removed commented code

commit 47a087b
Author: Muaviyaimran <[email protected]>
Date:   Thu Dec 19 02:43:53 2024 +0500

    Added many.js

commit 8eb84b2
Author: Muaviyaimran <[email protected]>
Date:   Thu Dec 19 02:29:42 2024 +0500

    implemented getMany for local, session, idb and cookie

commit c9a14a6
Author: Muaviyaimran <[email protected]>
Date:   Thu Dec 19 02:27:30 2024 +0500

    Converted session, local and cookies to async functions

commit 933697d
Author: Muaviyaimran <[email protected]>
Date:   Thu Dec 19 02:10:23 2024 +0500

    implemented setMany, and removeMany for local,session, idb and cookie

Co-authored-by: Muaviyaimran <[email protected]>
Co-authored-by: Kyle Simpson <[email protected]>

Author: getify

README.md

@@ -104,8 +104,8 @@ If you are using a bundler (Astro, Vite, Webpack, etc) for your web application,
 Just `import` the adapter(s) of your choice, like so:
 
 ```js
-// {WHICHEVER}: "idb", "local-storage", etc
-import { get, set } from "@byojs/storage/{WHICHEVER}";
+// {TYPE}: "idb", "local-storage", etc
+import { get, set } from "@byojs/storage/{TYPE}";
 ```
 
 The bundler tool should pick up and find whatever files (and dependencies) are needed.
@@ -134,8 +134,8 @@ If you are not using a bundler (Astro, Vite, Webpack, etc) for your web applicat
 Now, you'll be able to `import` the library in your app in a friendly/readable way:
 
 ```js
-// {WHICHEVER}: "idb", "local-storage", etc
-import { get, set } from "storage/{WHICHEVER}";
+// {TYPE}: "idb", "local-storage", etc
+import { get, set } from "storage/{TYPE}";
 ```
 
 **Note:** If you omit the above *adapter* import-map entries, you can still `import` **Storage** by specifying the proper full path to whichever `adapter.*.mjs` file(s) you want to use.
@@ -148,7 +148,7 @@ The API provided by the **Storage** adapters can be accessed, for each adapter,
 
 ```js
 // for IndexedDB:
-import { has, get, set, remove } from "@byojs/storage/idb";
+import { has, get, set, remove } from "{..}/idb";
 
 await has("Hello");             // false
 
@@ -181,6 +181,70 @@ The key-value oriented methods available on each adapter's API are:
 
 **NOTE:** All of these methods are async (promise-returning).
 
+### Many API
+
+The `get(..)`, `set(..)`, and `remove(..)` methods also support a bulk-call form, to process multiple keys/values at once:
+
+```js
+// for IndexedDB:
+import { has, get, set, remove } from "{..}/idb";
+
+var entries = [
+    [ "Hello", "World!" ],
+    [ "special", 42 ]
+];
+
+await set.many(entries);
+// true
+
+var keys = entries.map(([ key, val ]) => key);
+// [ "Hello", "special" ]
+
+await get.many(keys);
+// [ "World!", 42 ]
+
+await Promise.all(keys.map(has));
+// [ true, true ]
+
+await remove.many(keys);
+// true
+
+await Promise.all(keys.map(has));
+// [ false, false ]
+```
+
+The `*.many(..)` methods also accept objects:
+
+```js
+import { has, get, set, remove } from "{..}/idb";
+
+var obj = {
+    Hello: "World!",
+    special: 42
+};
+
+await set.many(obj);
+// true
+
+var keysObj = {
+    Hello: null,
+    special: null
+};
+var keysArr = Object.keys(keys)
+
+await get.many(keysObj);
+// [ "World!", 42 ]
+
+await Promise.all(keysArr.map(has));
+// [ true, true ]
+
+await remove.many(keysObj);
+// true
+
+await Promise.all(keysArr.map(has));
+// [ false, false ]
+```
+
 ## Re-building `dist/*`
 
 If you need to rebuild the `dist/*` files for any reason, run:

scripts/build-all.js

@@ -57,7 +57,7 @@ async function main() {
 		SRC_DIR,
 		DIST_DIR,
 		(contents,outputPath,filename = path.basename(outputPath)) => prepareFileContents(
-			contents.replace(/(\.\/(util|worker\.opfs))\.js/g,"$1.mjs"),
+			contents.replace(/(\.\/(util|many|worker\.opfs))\.js/g,"$1.mjs"),
 			outputPath.replace(/\.js$/,".mjs"),
 			filename.replace(/\.js$/,".mjs")
 		),

src/adapter.cookie.js

@@ -1,4 +1,16 @@
 import { safeJSONParse, } from "./util.js";
+import {
+	setMany,
+	getMany,
+	removeMany,
+} from "./many.js";
+
+
+// ***********************
+
+get.many = (...args) => getMany(get,...args);
+set.many = (...args) => setMany(set,...args);
+remove.many = (...args) => removeMany(remove,...args);
 
 
 // ***********************

src/adapter.idb.js

@@ -5,6 +5,18 @@ import {
 	keys as idbKeys,
 	entries as idbEntries,
 } from "idb-keyval";
+import {
+	setMany,
+	getMany,
+	removeMany,
+} from "./many.js";
+
+
+// ***********************
+
+get.many = (...args) => getMany(get,...args);
+set.many = (...args) => setMany(set,...args);
+remove.many = (...args) => removeMany(remove,...args);
 
 
 // ***********************

src/adapter.local-storage.js

@@ -1,4 +1,16 @@
 import { safeJSONParse, } from "./util.js";
+import {
+	setMany,
+	getMany,
+	removeMany,
+} from "./many.js";
+
+
+// ***********************
+
+get.many = (...args) => getMany(get,...args);
+set.many = (...args) => setMany(set,...args);
+remove.many = (...args) => removeMany(remove,...args);
 
 
 // ***********************
@@ -12,7 +24,7 @@ export {
 	remove,
 	keys,
 	entries,
-}
+};
 var publicAPI = {
 	storageType,
 	has,
@@ -24,7 +36,6 @@ var publicAPI = {
 };
 export default publicAPI;
 
-
 // ***********************
 
 async function has(name) {

src/adapter.opfs-worker.js

@@ -5,6 +5,16 @@ import {
 } from "./util.js";
 
 
+// ***********************
+
+get.many = async (...args) => (
+	(await sendToWorker("get.many",...args))
+		.map(safeJSONParse)
+);
+set.many = (...args) => sendToWorker("set.many",...args);
+remove.many = (...args) => sendToWorker("remove.many",...args);
+
+
 // ***********************
 
 var worker = null;

src/adapter.opfs.js

@@ -3,6 +3,18 @@ import {
 	isPromise,
 	getRootFS,
 } from "./util.js";
+import {
+	setMany,
+	getMany,
+	removeMany,
+} from "./many.js";
+
+
+// ***********************
+
+get.many = (...args) => getMany(get,...args);
+set.many = (...args) => setMany(set,...args);
+remove.many = (...args) => removeMany(remove,...args);
 
 
 // ***********************

src/adapter.session-storage.js

@@ -1,4 +1,16 @@
 import { safeJSONParse, } from "./util.js";
+import {
+	setMany,
+	getMany,
+	removeMany,
+} from "./many.js";
+
+
+// ***********************
+
+get.many = (...args) => getMany(get,...args);
+set.many = (...args) => setMany(set,...args);
+remove.many = (...args) => removeMany(remove,...args);
 
 
 // ***********************
@@ -12,7 +24,7 @@ export {
 	remove,
 	keys,
 	entries,
-}
+};
 var publicAPI = {
 	storageType,
 	has,

src/many.js

@@ -0,0 +1,52 @@
+export { setMany, getMany, removeMany };
+
+
+// ***********************
+
+function setMany(set,entries) {
+	// not already an entries-array?
+	if (
+		entries != null &&
+		typeof entries == "object" &&
+		!Array.isArray(entries)
+	) {
+		entries = [ ...Object.entries(entries), ];
+	}
+	return (
+		Promise.all(
+			entries.map(([ key, val ]) => set(key,val))
+		)
+		.then(() => true)
+	);
+}
+
+function getMany(get,keys) {
+	// not already a keys-array?
+	if (
+		keys != null &&
+		typeof keys == "object" &&
+		!Array.isArray(keys)
+	) {
+		keys = [ ...Object.keys(keys), ];
+	}
+	return Promise.all(
+		keys.map(key => get(key))
+	);
+}
+
+function removeMany(remove,keys) {
+	// not already a keys-array?
+	if (
+		keys != null &&
+		typeof keys == "object" &&
+		!Array.isArray(keys)
+	) {
+		keys = [ ...Object.keys(keys), ];
+	}
+	return (
+		Promise.all(
+			keys.map(key => remove(key))
+		)
+		.then(() => true)
+	);
+}

src/worker.opfs.js

@@ -2,10 +2,19 @@ import {
 	isPromise,
 	getRootFS,
 } from "./util.js";
+import {
+	setMany,
+	getMany,
+	removeMany,
+} from "./many.js";
 
 
 // ***********************
 
+get.many = (...args) => getMany(get,...args);
+set.many = (...args) => setMany(set,...args);
+remove.many = (...args) => removeMany(remove,...args);
+
 self.addEventListener("message",onMessage);
 self.postMessage({ "ready": true });
 
@@ -16,8 +25,11 @@ async function onMessage({ data, } = {}) {
 	var recognizedMessages = {
 		has,
 		get,
+		"get.many": get.many,
 		set,
+		"set.many": set.many,
 		remove,
+		"remove.many": remove.many,
 		keys,
 		entries,
 	};