datafolder 1.0.2 → 1.0.4

package/README.md

@@ -11,33 +11,29 @@ datafolder is a lightweight JSON database, featuring an AI-friendly API for simp
 ## How to use
 
 ```javascript
-const DataFolder = require("datafolder");
+import DataFolder from "datafolder";
 const dataFolder = new DataFolder(); //Specify where to store the data. Default is ./data/sampleDataFolder
-await dataFolder.start();
-dataFolder.insert("users/2026/user_0001", {
+await dataFolder.start(); //start() and stop() are the only two async places. All other code doesn't need await.
+dataFolder.insert("traindata/2026/1/20/chat_0001", {
   userid: "user_0001",
   email: "a@b.com",
-  score: 5,
+  feedbackScore: 5,
   address: { city: "a", zipcode: 123 },
 });
-dataFolder.insert("users/2026/user_0002", {
-  userid: "user_0002",
-  email: "c@b.com",
-  score: 3,
-  address: { city: "b", zipcode: 321 },
-});
-const { email, password, address, score } = dataFolder.view("users/2026/user_0002");
+dataFolder.insert("traindata/2026/1/20/chat_0001/prompt", "What is async/await?");
+dataFolder.insert("traindata/2026/1/20/chat_0001/answer", "async/await is ...");
+const { email, password, address, feedbackScore } = dataFolder.view("traindata/2026/1/20/chat_0001");
 address.zipcode = 678;
-dataFolder.insert("users/2026/user_0002", { score: score + 1, address });
+dataFolder.insert("traindata/2026/1/20/chat_0001", { feedbackScore: feedbackScore + 1, address });
 await dataFolder.stop();
 ```
 
 Or operate with dir/file objects:
 
 ```javascript
-const file = dataFolder.file("users/2026/user_0002");
-const { score, address } = file.view({ score: 1, address: 1 });
-dataFolder.insert(file, { score: score + 1, address: { city: "c", zipcode: 663 } });
+const file = dataFolder.file("traindata/2026/1/20/chat_0001");
+const { feedbackScore, address } = file.view({ feedbackScore: 1, address: 1 });
+dataFolder.insert(file, { feedbackScore: feedbackScore + 1, address: { city: "c", zipcode: 663 } });
 ```
 
 ## Features
@@ -75,7 +71,7 @@ const { email, address } = dataFolder.view("path/to/file", { email: 1, addres: 1
 
 ```javascript
 dataFolder.insert("path/to/file", { email: newEmail, address: { zipcode: newZipcode } });
-dataFolder.insert(file, { score: score + 1 });
+dataFolder.insert(file, { feedbackScore: feedbackScore + 1 });
 ```
 
 #### Delete
@@ -91,14 +87,15 @@ dataFolder.remove(file, { email: 1, address: { zipcode: 1 } });
 ### 2. Batch APIs
 
 ```javascript
-const [dir, file, { email, score }] = dataFolder.fetch
+const [dir, file, { email, feedbackScore }] = dataFolder.fetch
   .dir("path/to/dir")
   .file("path/to/file")
   .view("path/to/file")
   .run();
 dataFolder.batch
-  .insert("path/to/file", { email: "email1@a.b.com" })
-  .insert("path/to/file", { email: "email2", score: 100 })
+  .insert("path/to/chat_details", { user: "user_0001", feedbackScore: 100 })
+  .insert("path/to/prompt", "what is LLM?")
+  .insert("path/to/answer", "LLM is AI...")
   .remove("path/to/file", { address: { city: 1 } })
   .run();
 ```
@@ -107,7 +104,13 @@ dataFolder.batch
 
 ```javascript
 dataFolder.queryFiles("flights/**", { _from: "airports/LAX" });
-dataFolder.queryFiles(["flights", "*", 1, (x) => x >= 5 && x <= 7], {
+dataFolder.queryFiles(["flights", "*", "jan", (x) => x >= 5 && x <= 7], {
+  $or: [{ _from: "airports/BIS" }, { _to: "airports/BIS" }],
+});
+dataFolder.queryFiles(["flights", "*", "feb", { $or: [5, 6, 7] }], {
+  $or: [{ _from: "airports/BIS" }, { _to: "airports/BIS" }],
+});
+dataFolder.queryFiles(["flights", "*", "mar", { $gte: 5, lte: 7 }], {
   $or: [{ _from: "airports/BIS" }, { _to: "airports/BIS" }],
 });
 dataFolder.queryFilesMulti([
@@ -119,23 +122,23 @@ dataFolder.queryFilesMulti([
 ### 4. Flexible Trigger Support to Monitor Any Changes
 
 ```javascript
-function onEmailChanged({ studentId, email }) {
-  const { oldValue, newValue } = email;
-  // Logic to handle email change.
+function onPromptScoreChanged({ promptId, feedbackScore }) {
+  const { oldValue, newValue } = feedbackScore;
+  // Logic to handle prompt feedback score change.
 }
-dataFolder.insertTrigger("emailChanged", "students/{studentId}", "email");
-dataFolder.on("emailChanged", onEmailChanged);
-dataFolder.insert("students/student1", { email: "email1" });
-dataFolder.insert("students/student2", { email: "email2" });
-dataFolder.insert("students/student1", { email: "email1_changed" });
+dataFolder.insertTrigger("promptScoreChanged", "traindata/{promptId}", "feedbackScore");
+dataFolder.on("promptScoreChanged", onPromptScoreChanged);
+dataFolder.insert("traindata/prompt_1", { feedbackScore: 80 });
+dataFolder.insert("traindata/prompt_2", { feedbackScore: 63 });
+dataFolder.insert("traindata/prompt_1", { feedbackScore: 32 });
 ```
 
 Will trigger the following calls:
 
 ```javascript
-onEmailChanged({ studentId: "student1", email: { oldValue: undefined, newValue: "email1" } });
-onEmailChanged({ studentId: "student2", email: { oldValue: undefined, newValue: "email2" } });
-onEmailChanged({ studentId: "student1", email: { oldValue: "email1", newValue: "email1_changed" } });
+onPromptScoreChanged({ promptId: "student1", feedbackScore: { oldValue: undefined, newValue: 80 } });
+onPromptScoreChanged({ promptId: "student2", feedbackScore: { oldValue: undefined, newValue: 63 } });
+onPromptScoreChanged({ promptId: "student1", feedbackScore: { oldValue: 80, newValue: 32 } });
 ```
 
 ## Example

package/index.js

@@ -1,3 +1 @@
-const { QyDB } = require("./src/QyDB.js");
-module.exports = QyDB;
-module.exports.default = QyDB;
+export { QyDB as default } from "./src/QyDB.js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "datafolder",
-	"version": "1.0.2",
+	"version": "1.0.4",
 	"author": {
 		"name": "lysh",
 		"email": "datafolderdev@outlook.com"
@@ -37,7 +37,8 @@
 		"easy",
 		"quick",
 		"millisecond",
-		"lightweight"
+		"lightweight",
+		"LSM"
 	],
 	"dependencies": {},
 	"devDependencies": {
@@ -50,5 +51,6 @@
 	"scripts": {
 		"ui": "start http://localhost:3628/datafolderui/index.html && node ./scripts/fastify.js",
 		"airbnb": "node ./scripts/airbnb2.js && start http://localhost:3628/datafolderui/index.html && node ./scripts/fastify.js"
-	}
+	},
+	"type": "module"
 }

package/sample.js

@@ -1,37 +1,37 @@
-const DataFolder = require("datafolder");
-const dataFolder = new DataFolder();
-
-run();
-
-async function run() {
-	await dataFolder.start();
-	dataFolder.insert("users/2026/user_0001", {
-		userid: "user_0001",
-		email: "a@b.com",
-		password: "123",
-		score: 5,
-		address: { city: "a", zipcode: 123 },
-	});
-	dataFolder.insert("users/2026/user_0002", {
-		userid: "user_0002",
-		email: "c@b.com",
-		password: "333",
-		score: 3,
-		address: { city: "b", zipcode: 321 },
-	});
-	const { email, password, address, score } = dataFolder.view("users/2026/user_0002");
-	logger.log(email, password, score, address);
-	address.zipcode = 678;
-	dataFolder.insert("users/2026/user_0002", { score: score + 1, address });
-	logger.log(dataFolder.view("users/2026/user_0002", ["score", "address"]));
-	await dataFolder.stop();
-	await dataFolder.start();
-	{
-		const file = dataFolder.file("users/2026/user_0002");
-		const { email, password, score } = file.view();
-		logger.log(email, password, score);
-		dataFolder.insert(file, { score: score + 1 });
-		logger.log(file.view());
-	}
-	await dataFolder.stop();
-}
+import DataFolder from "datafolder";
+const dataFolder = new DataFolder();
+
+run();
+
+async function run() {
+	await dataFolder.start();
+	dataFolder.insert("users/2026/user_0001", {
+		userid: "user_0001",
+		email: "a@b.com",
+		password: "123",
+		score: 5,
+		address: { city: "a", zipcode: 123 },
+	});
+	dataFolder.insert("users/2026/user_0002", {
+		userid: "user_0002",
+		email: "c@b.com",
+		password: "333",
+		score: 3,
+		address: { city: "b", zipcode: 321 },
+	});
+	const { email, password, address, score } = dataFolder.view("users/2026/user_0002");
+	logger.log(email, password, score, address);
+	address.zipcode = 678;
+	dataFolder.insert("users/2026/user_0002", { score: score + 1, address });
+	logger.log(dataFolder.view("users/2026/user_0002", ["score", "address"]));
+	await dataFolder.stop();
+	await dataFolder.start();
+	{
+		const file = dataFolder.file("users/2026/user_0002");
+		const { email, password, score } = file.view();
+		logger.log(email, password, score);
+		dataFolder.insert(file, { score: score + 1 });
+		logger.log(file.view());
+	}
+	await dataFolder.stop();
+}

package/scripts/airbnb.js

@@ -1,13 +1,13 @@
-const path = require("node:path");
-const fsPromises = require("node:fs/promises");
-const { QyDB } = require("../src/QyDB.js");
-const { folderOrFileExists, isSimpleType } = require("../src/QyUtils.js");
-const { runQueries } = require("./airbnb_queries.js");
-const { downloadFile } = require("./downloadFile.js");
+import { join } from "node:path";
+import { open, rm } from "node:fs/promises";
+import { QyDB } from "../src/QyDB.js";
+import { folderOrFileExists, isSimpleType, __dirname } from "../src/QyUtils.js";
+import { runQueries } from "./airbnb_queries.js";
+import { downloadFile } from "./downloadFile.js";
 
 const fileName = "listingsAndReviews.json";
 const fileUrl = `https://raw.githubusercontent.com/neelabalan/mongodb-sample-dataset/refs/heads/main/sample_airbnb/${fileName}`;
-const airbnbJsonFilePath = path.join(__dirname, "../data/", fileName);
+const airbnbJsonFilePath = join(__dirname, "../data/", fileName);
 const qyDB = new QyDB();
 const { rootFolder } = qyDB;
 
@@ -15,7 +15,7 @@ run();
 async function insertData() {
     console.time("insertData");
     const { batch } = qyDB;
-    const fileHandle = await fsPromises.open(airbnbJsonFilePath, "r");
+    const fileHandle = await open(airbnbJsonFilePath, "r");
     for await (const line of fileHandle.readLines()) {
         const oneItem = convert(JSON.parse(line));
         batch.insert(["airbnb1", oneItem._id], oneItem);
@@ -39,7 +39,7 @@ async function run() {
     let shouldInsertData = true;
     if (process.argv[2] == "true") {
         try {
-            await fsPromises.rm(rootFolder, { recursive: true });
+            await rm(rootFolder, { recursive: true });
         } catch (exception) {}
         shouldInsertData = true;
     } else if (!(await folderOrFileExists(rootFolder))) shouldInsertData = true;
@@ -69,5 +69,4 @@ function convert(item) {
         item[prop] = convert(item[prop]);
     }
     return item;
-}
-Object.assign(module.exports, { runQueries });
+}

package/scripts/airbnb2.js

@@ -1,13 +1,13 @@
-const path = require("node:path");
-const fsPromises = require("node:fs/promises");
-const { QyDB } = require("../src/QyDB.js");
-const { folderOrFileExists, isSimpleType } = require("../src/QyUtils.js");
-const { runQueries } = require("./airbnb2_queries.js");
-const { downloadFile } = require("./downloadFile.js");
+import { join } from "node:path";
+import { open, rm } from "node:fs/promises";
+import { QyDB } from "../src/QyDB.js";
+import { folderOrFileExists, isSimpleType, __dirname } from "../src/QyUtils.js";
+import { runQueries } from "./airbnb2_queries.js";
+import { downloadFile } from "./downloadFile.js";
 
 const fileName = "listingsAndReviews.json";
 const fileUrl = `https://raw.githubusercontent.com/neelabalan/mongodb-sample-dataset/refs/heads/main/sample_airbnb/${fileName}`;
-const airbnbJsonFilePath = path.join(__dirname, "../data/", fileName);
+const airbnbJsonFilePath = join(__dirname, "../data/", fileName);
 const qyDB = new QyDB();
 const { rootFolder } = qyDB;
 
@@ -15,7 +15,7 @@ run();
 async function insertData() {
     console.time("insertData");
     const { batch } = qyDB;
-    const fileHandle = await fsPromises.open(airbnbJsonFilePath, "r");
+    const fileHandle = await open(airbnbJsonFilePath, "r");
     for await (const line of fileHandle.readLines()) {
         const oneItem = convert(JSON.parse(line));
         const { property_type, room_type, bed_type, _id } = oneItem;
@@ -40,7 +40,7 @@ async function run() {
     let shouldInsertData = true;
     if (process.argv[2] == "true") {
         try {
-            await fsPromises.rm(rootFolder, { recursive: true });
+            await rm(rootFolder, { recursive: true });
         } catch (exception) {}
         shouldInsertData = true;
     } else if (!(await folderOrFileExists(rootFolder))) shouldInsertData = true;
@@ -70,5 +70,4 @@ function convert(item) {
         item[prop] = convert(item[prop]);
     }
     return item;
-}
-Object.assign(module.exports, { runQueries });
+}

package/scripts/airbnb2_queries.js

@@ -1,13 +1,13 @@
-const assert = require("node:assert/strict");
+import { deepEqual } from "node:assert/strict";
 
 function query1(qyDB) {
     console.time("query1");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFiles(["airbnb", "Loft", "Entire home/apt", "Real Bed"], {
                 address: { street: "Porto, Porto, Portugal" },
             })
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [
             "Porto city centre apartment H",
             "Romantic loft near historic center",
@@ -32,7 +32,7 @@ function query1(qyDB) {
 }
 function query2(qyDB) {
     console.time("query2");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFiles(
                 ["airbnb", "Loft", "Entire home/apt", "Real Bed"],
@@ -41,7 +41,7 @@ function query2(qyDB) {
                 },
                 9,
             )
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [
             "Porto city centre apartment H",
             "Romantic loft near historic center",
@@ -58,7 +58,7 @@ function query2(qyDB) {
 }
 function query3(qyDB) {
     console.time("query3");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFiles(
                 ["airbnb", "Loft", "Entire home/apt", "Real Bed"],
@@ -66,7 +66,7 @@ function query3(qyDB) {
                 9,
                 9,
             )
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [
             "Bright Top Floor Two Rooms Apartment w/ Terrace",
             "ReUrban Flats - Santa Catarina #3",
@@ -82,14 +82,14 @@ function query3(qyDB) {
 }
 function query4(qyDB) {
     console.time("query4");
-    assert.deepEqual(
+    deepEqual(
         qyDB.fetch
             .queryFilesMulti([
                 [["airbnb", "Loft", "Entire home/apt", "Real Bed"], { address: { street: "Porto, Porto, Portugal" } }],
                 ["airbnb/Loft/**", { minimum_nights: (x) => x >= 60 }],
             ])
             .run()[0]
-            .map((x) => x.view(["name"]).name)
+            .map((x) => x.prop("name"))
             .sort(),
         [
             "Porto city centre apartment H",
@@ -116,7 +116,7 @@ function query4(qyDB) {
 }
 function query5(qyDB) {
     console.time("query5");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFilesMulti(
                 [
@@ -128,7 +128,7 @@ function query5(qyDB) {
                 ],
                 3,
             )
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [
             "Porto city centre apartment H",
             "Romantic loft near historic center",
@@ -139,7 +139,7 @@ function query5(qyDB) {
 }
 function query6(qyDB) {
     console.time("query6");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFilesMulti(
                 [
@@ -152,7 +152,7 @@ function query6(qyDB) {
                 20,
                 10,
             )
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [
             "ReUrban Flats - Santa Catarina #3",
             "The Blue and White Porto House - Vintage",
@@ -168,25 +168,23 @@ function query6(qyDB) {
 }
 function query7(qyDB) {
     console.time("query7");
-    assert.deepEqual(
-        qyDB.queryFiles(["airbnb", "Loft", "**"], { minimum_nights: (x) => x >= 60 }).map((x) => x.view(["name"]).name),
+    deepEqual(
+        qyDB.queryFiles(["airbnb", "Loft", "**"], { minimum_nights: (x) => x >= 60 }).map((x) => x.prop("name")),
         ["Romantic loft near historic center", "Brand New Luxury Downtown Studio"],
     );
     console.timeEnd("query7");
 }
 function query8(qyDB) {
     console.time("query8");
-    assert.deepEqual(
-        qyDB
-            .queryFiles(["airbnb", "Loft", ""], { minimum_nights: (x) => x >= 60 }, 10, 10)
-            .map((x) => x.view(["name"]).name),
+    deepEqual(
+        qyDB.queryFiles(["airbnb", "Loft", ""], { minimum_nights: (x) => x >= 60 }, 10, 10).map((x) => x.prop("name")),
         [],
     );
     console.timeEnd("query8");
 }
 function query9(qyDB) {
     console.time("query9");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFilesMulti(
                 [
@@ -198,7 +196,7 @@ function query9(qyDB) {
                 ],
                 3,
             )
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [
             "Porto city centre apartment H",
             "Romantic loft near historic center",
@@ -228,4 +226,4 @@ function runQueries(qyDB) {
     query9(qyDB);
 }
 
-Object.assign(module.exports, { runQueries });
+export { runQueries };

package/scripts/airbnb_queries.js

@@ -1,8 +1,8 @@
-const assert = require("node:assert/strict");
+import { deepEqual } from "node:assert/strict";
 
 function query1(qyDB) {
     console.time("query1");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFiles("airbnb1", {
                 property_type: "Loft",
@@ -10,7 +10,7 @@ function query1(qyDB) {
                 bed_type: "Real Bed",
                 address: { street: "Porto, Porto, Portugal" },
             })
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [
             "Porto city centre apartment H",
             "Romantic loft near historic center",
@@ -35,7 +35,7 @@ function query1(qyDB) {
 }
 function query2(qyDB) {
     console.time("query2");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFiles(
                 "airbnb1",
@@ -47,7 +47,7 @@ function query2(qyDB) {
                 },
                 9,
             )
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [
             "Porto city centre apartment H",
             "Romantic loft near historic center",
@@ -64,7 +64,7 @@ function query2(qyDB) {
 }
 function query3(qyDB) {
     console.time("query3");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFiles(
                 "airbnb1",
@@ -77,7 +77,7 @@ function query3(qyDB) {
                 9,
                 9,
             )
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [
             "Bright Top Floor Two Rooms Apartment w/ Terrace",
             "ReUrban Flats - Santa Catarina #3",
@@ -93,7 +93,7 @@ function query3(qyDB) {
 }
 function query4(qyDB) {
     console.time("query4");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFiles("airbnb1", {
                 $or: [
@@ -106,7 +106,8 @@ function query4(qyDB) {
                     { property_type: (x) => x == "Loft", minimum_nights: (x) => x >= 60 },
                 ],
             })
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name"))
+            .sort(),
         [
             "Porto city centre apartment H",
             "Romantic loft near historic center",
@@ -126,13 +127,13 @@ function query4(qyDB) {
             "Your OWM Invicta",
             "Pury Apartments",
             "Live Porto & Douro - Breiner III",
-        ],
+        ].sort(),
     );
     console.timeEnd("query4");
 }
 function query5(qyDB) {
     console.time("query5");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFiles(
                 "airbnb1",
@@ -149,7 +150,7 @@ function query5(qyDB) {
                 },
                 3,
             )
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [
             "Porto city centre apartment H",
             "Romantic loft near historic center",
@@ -160,7 +161,7 @@ function query5(qyDB) {
 }
 function query6(qyDB) {
     console.time("query6");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFiles(
                 "airbnb1",
@@ -178,9 +179,8 @@ function query6(qyDB) {
                 20,
                 10,
             )
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [
-            "Bright Top Floor Two Rooms Apartment w/ Terrace",
             "ReUrban Flats - Santa Catarina #3",
             "The Blue and White Porto House - Vintage",
             "4twoLoft at Great Location",
@@ -188,33 +188,34 @@ function query6(qyDB) {
             "Your OWM Invicta",
             "Pury Apartments",
             "Live Porto & Douro - Breiner III",
+            "Brand New Luxury Downtown Studio",
         ],
     );
     console.timeEnd("query6");
 }
 function query7(qyDB) {
     console.time("query7");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFiles("airbnb1", { property_type: (x) => x == "Loft", minimum_nights: (x) => x >= 60 })
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         ["Romantic loft near historic center", "Brand New Luxury Downtown Studio"],
     );
     console.timeEnd("query7");
 }
 function query8(qyDB) {
     console.time("query8");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFiles("airbnb1", { property_type: (x) => x == "Loft", minimum_nights: (x) => x >= 60 }, 10, 10)
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [],
     );
     console.timeEnd("query8");
 }
 function query9(qyDB) {
     console.time("query9");
-    assert.deepEqual(
+    deepEqual(
         qyDB
             .queryFiles(
                 "airbnb1",
@@ -231,7 +232,7 @@ function query9(qyDB) {
                 },
                 3,
             )
-            .map((x) => x.view(["name"]).name),
+            .map((x) => x.prop("name")),
         [
             "Porto city centre apartment H",
             "Romantic loft near historic center",
@@ -261,4 +262,4 @@ function runQueries(qyDB) {
     query9(qyDB);
 }
 
-Object.assign(module.exports, { runQueries });
+export { runQueries };