@peerbit/indexer-sqlite3 1.0.0 → 1.0.1-5e0d4ec

package/package.json

@@ -1,80 +1,80 @@
 {
-	"name": "@peerbit/indexer-sqlite3",
-	"version": "1.0.0",
-	"description": "SQLite index for document store",
-	"type": "module",
-	"sideEffects": false,
-	"types": "./dist/src/index.d.ts",
-	"typesVersions": {
-		"*": {
-			"*": [
-				"*",
-				"dist/*",
-				"dist/src/*",
-				"dist/src/*/index"
-			],
-			"src/*": [
-				"*",
-				"dist/*",
-				"dist/src/*",
-				"dist/src/*/index"
-			]
-		}
-	},
-	"files": [
-		"src",
-		"dist",
-		"!dist/e2e",
-		"!dist/test",
-		"!**/*.tsbuildinfo"
-	],
-	"exports": {
-		".": {
-			"types": "./dist/src/index.d.ts",
-			"import": "./dist/src/index.js"
-		},
-		"./sqlite.org": {
-			"types": "./dist/peerbit/sqlite.org/sqlite3.d.ts",
-			"import": "./dist/peerbit/sqlite.org/sqlite3.js"
-		}
-	},
-	"browser": {
-		"./dist/src/sqlite3.js": "./dist/src/sqlite3.browser.js"
-	},
-	"eslintConfig": {
-		"extends": "peerbit",
-		"parserOptions": {
-			"project": true,
-			"sourceType": "module"
-		},
-		"ignorePatterns": [
-			"!.aegir.js",
-			"test/ts-use",
-			"*.d.ts"
-		]
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"scripts": {
-		"clean": "aegir clean",
-		"copy-sqlite-wasm": "mkdir -p ./dist/peerbit/ && cp -r ../../../../node_modules/@sqlite.org/sqlite-wasm/sqlite-wasm/jswasm/. ./dist/peerbit/",
-		"build-worker": "node ../../../../node_modules/esbuild/bin/esbuild --bundle ./src/sqlite3.worker.ts --format=esm  --outfile=./dist/peerbit/sqlite3.worker.min.js",
-		"build": "aegir build && npm run build-worker && npm run copy-sqlite-wasm",
-		"test": "aegir test",
-		"test:browser": "aegir clean && aegir test -t browser",
-		"test:node": "aegir clean && aegir test -t node",
-		"lint": "aegir lint"
-	},
-	"author": "dao.xyz",
-	"license": "MIT",
-	"dependencies": {
-		"better-sqlite3": "^11.1.2",
-		"@peerbit/indexer-interface": "^1.0.0",
-		"@sqlite.org/sqlite-wasm": "^3.46.0-build2"
-	},
-	"devDependencies": {
-		"@types/better-sqlite3": "^7.6.11",
-		"@peerbit/indexer-tests": "^1.0.0"
-	}
+  "name": "@peerbit/indexer-sqlite3",
+  "version": "1.0.1-5e0d4ec",
+  "description": "SQLite index for document store",
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ],
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "!dist/e2e",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    },
+    "./sqlite.org": {
+      "types": "./dist/peerbit/sqlite.org/sqlite3.d.ts",
+      "import": "./dist/peerbit/sqlite.org/sqlite3.js"
+    }
+  },
+  "browser": {
+    "./dist/src/sqlite3.js": "./dist/src/sqlite3.browser.js"
+  },
+  "eslintConfig": {
+    "extends": "peerbit",
+    "parserOptions": {
+      "project": true,
+      "sourceType": "module"
+    },
+    "ignorePatterns": [
+      "!.aegir.js",
+      "test/ts-use",
+      "*.d.ts"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "aegir clean",
+    "copy-sqlite-wasm": "mkdir -p ./dist/peerbit/ && cp -r ../../../../node_modules/@sqlite.org/sqlite-wasm/sqlite-wasm/jswasm/. ./dist/peerbit/",
+    "build-worker": "node ../../../../node_modules/esbuild/bin/esbuild --bundle ./src/sqlite3.worker.ts --format=esm  --outfile=./dist/peerbit/sqlite3.worker.min.js",
+    "build": "aegir build && npm run build-worker && npm run copy-sqlite-wasm",
+    "test": "aegir test",
+    "test:browser": "aegir clean && aegir test -t browser",
+    "test:node": "aegir clean && aegir test -t node",
+    "lint": "aegir lint"
+  },
+  "author": "dao.xyz",
+  "license": "MIT",
+  "dependencies": {
+    "better-sqlite3": "^11.1.2",
+    "@peerbit/indexer-interface": "1.0.0-5e0d4ec",
+    "@sqlite.org/sqlite-wasm": "^3.46.0-build2"
+  },
+  "devDependencies": {
+    "@types/better-sqlite3": "^7.6.11",
+    "@peerbit/indexer-tests": "1.0.0-5e0d4ec"
+  }
 }

package/src/schema.ts

@@ -253,17 +253,8 @@ export const ARRAY_INDEX_COLUMN = "__index";
 export const PARENT_TABLE_ID = "__parent_id";
 const FOREIGN_VALUE_PROPERTY = "value";
 
-/* const clazzHasVariants = (clazz: Constructor<any>) => {
-	const schema = getSchema(clazz);
-	return schema?.variant !== undefined;
-
-}
- */
 const clazzCanBeInlined = (clazz: Constructor<any>) => {
-	return (
-		/* clazzHasVariants(clazz) === false &&  */ (getDependencies(clazz, 0)
-			?.length ?? 0) === 0
-	);
+	return (getDependencies(clazz, 0)?.length ?? 0) === 0;
 };
 
 interface SimpleNested {

package/src/sqlite3.browser.ts

@@ -10,6 +10,7 @@ import {
 } from "./types.js";
 
 class ProxyStatement implements IStatement {
+	id: string;
 	resolvers: {
 		[hash in string]: {
 			resolve: (...args: any) => void;
@@ -23,7 +24,9 @@ class ProxyStatement implements IStatement {
 		) => Promise<T>,
 		readonly databaseId: string,
 		readonly statementId: string,
-	) {}
+	) {
+		this.id = statementId;
+	}
 
 	async bind(values: any[]) {
 		await this.send({

package/src/sqlite3.wasm.ts

@@ -7,14 +7,13 @@ import {
 	type PreparedStatement as SQLStatement,
 	default as sqlite3InitModule,
 } from "@sqlite.org/sqlite-wasm";
+import { v4 as uuid } from "uuid";
 import type { BindableValue } from "./schema.js";
 import {
 	type Statement as IStatement,
 	type StatementGetResult,
 } from "./types.js";
 
-/* import { v4 as uuid } from 'uuid';
- */
 export const encodeName = (name: string): string => {
 	// since "/" and perhaps other characters might not be allowed we do encode
 	const writer = new BinaryWriter();
@@ -29,7 +28,10 @@ export const decodeName = (name: string): string => {
 };
 
 class Statement implements IStatement {
-	constructor(private statement: SQLStatement) {}
+	constructor(
+		readonly statement: SQLStatement,
+		readonly id: string,
+	) {}
 
 	async bind(values: any[]) {
 		await this.statement.bind(values);
@@ -85,61 +87,11 @@ class Statement implements IStatement {
 	}
 }
 
-/* export class Database implements IDatabase {
-
-	statements: Map<string, Statement> = new Map();
-	private db: SQLDatabase
-	constructor(private readonly _close?: () => Promise<any> | any) { }
-
-	async exec(sql: string) {
-		return this.db.exec(sql);
-	}
-
-	async prepare(sql: string) {
-		const statement = this.db.prepare(sql);
-		const wrappedStatement = new Statement(statement);
-		this.statements.set(sql, wrappedStatement)
-		return wrappedStatement
-	}
-
-	async close() {
-		await Promise.all([...this.statements.values()].map(x => x.finalize?.()))
-		await this.db.close();
-		await this._close?.()
-	}
-
-	async get(sql: string) {
-		return this.db.exec({ sql, rowMode: 'array' });
-	}
-
-	async run(sql: string, bind: any[]) {
-		return this.db.exec(sql, { bind, rowMode: 'array' });
-	}
-}
-
- */
-
 // eslint-disable-next-line no-console
 const log = (...args: any) => console.log(...args);
 // eslint-disable-next-line no-console
 const error = (...args: any) => console.error(...args);
 
-/* let initOpfsResult: Promise<{ sqlite3: Awaited<ReturnType<typeof sqlite3InitModule>>,poolUtil: }> | undefined = undefined;
-const initOpfs = async () => {
-
-	let sqlite3: Awaited<ReturnType<typeof sqlite3InitModule>> = await sqlite3InitModule({
-		locateFile: (path, prefix) => {
-
-			return path;
-		}, print: log, printErr: error
-	});
-	let poolUtil = await sqlite3.installOpfsSAHPoolVfs({
-		directory: encodeName("helloworld")
-	});
-
-	return initOpfsResult || (initOpfsResult = { sqlite3, poolUtil })
-} */
-
 let poolUtil: SAHPoolUtil = undefined;
 let sqlite3: Awaited<ReturnType<typeof sqlite3InitModule>> | undefined =
 	undefined;
@@ -190,10 +142,13 @@ const create = async (directory?: string) => {
 			return sqliteDb.exec(sql);
 		},
 		open,
-		prepare: (sql: string) => {
+		prepare: (sql: string, id?: string) => {
+			if (id == null) {
+				id = uuid();
+			}
 			const statement = sqliteDb.prepare(sql);
-			const wrappedStatement = new Statement(statement);
-			statements.set(sql, wrappedStatement);
+			const wrappedStatement = new Statement(statement, id);
+			statements.set(id, wrappedStatement);
 			return wrappedStatement;
 		},
 		get(sql: string) {

package/src/sqlite3.worker.ts

@@ -38,8 +38,8 @@ class SqliteWorkerHandler {
 			} else if (message.type === "status") {
 				return db.status();
 			} else if (message.type === "prepare") {
-				const statementId = message.sql;
-				await db.prepare(message.sql);
+				const statementId = message.id;
+				await db.prepare(message.sql, message.id);
 				// db.statements.get(statementId) -> statement, because sqlite3.wasm stores the statement in a map like this
 				return statementId;
 			} else if (message.type === "close") {

package/src/types.ts

@@ -6,10 +6,7 @@ export type SQLite = {
 
 export type Database = {
 	exec: (sql: string) => Promise<any> | any;
-	prepare: (
-		sql: string,
-		err?: (err: any) => any,
-	) => Promise<Statement> | Statement;
+	prepare: (sql: string, id?: string) => Promise<Statement> | Statement;
 	close: (err?: (err: any) => any) => Promise<any> | any;
 	open(): Promise<any> | any;
 	status: () => Promise<"open" | "closed"> | "open" | "closed";
@@ -18,6 +15,7 @@ export type Database = {
 export type StatementGetResult = { [key: string]: SQLLiteValue };
 
 export type Statement = {
+	id: string;
 	bind: (
 		values: BindableValue[],
 		err?: (err: any) => any,

package/README.md

@@ -1,111 +0,0 @@
-# Documents
-
-Distributed document store.
-
-This store is built on top of the base store. This store allows for type-safe document storage and retrieval accross peers. 
-
-As of now, go through the [tests](./src//__tests__/index.integration.test.ts) for documentation on how to use the module.
-
-
-
-Example 
-```typescript 
-import { field, option, serialize, variant } from "@dao-xyz/borsh";
-import { Program } from "@peerbit/program";
-import { Peerbit } from "peerbit";
-import {
-	Documents,
-	DocumentIndex,
-	SearchRequest,
-	StringMatch,
-	StringMatchMethod,
-	Results,
-} from "@peerbit/document";
-
-
-@variant("document")
-class Document {
-    @field({ type: "string" })
-    id: string;
-
-    @field({ type: option("string") })
-    name?: string;
-
-    @field({ type: option("u64") })
-    number?: bigint;
-
-    constructor(opts?: Document) {
-        if (opts) {
-            Object.assign(this, opts);
-        }
-    }
-}
-
-@variant("test_documents")
-class TestStore extends Program {
-    @field({ type: Documents })
-    docs: Documents<Document>;
-
-    constructor(properties?: { docs: Documents<Document> }) {
-        super();
-        if (properties) {
-            this.docs = properties.docs;
-        }
-    }
-    async open(): Promise<void> {
-        await this.docs.open({ 
-			type: Document, 
-			index: {
-				fields: (obj) => obj // here you can filter and transform what fields you want to index
-			}})
-    }
-}
-
-// later 
-
-const peer = await Peerbit.create ({libp2p: your_libp2p_instance})
-const store = peer.open(new TestStore());
-console.log(store.address) /// this address can be opened by another peer 
-
-
-// insert
-let doc = new Document({
-    id: "1",
-    name: "hello world",
-    number: 1n,
-});
-let doc2 = new Document({
-    id: "2",
-    name: "hello world",
-    number: 2n,
-});
-
-let doc3 = new Document({
-    id: "3",
-    name: "foo",
-    number: 3n,
-});
-
-await store.docs.put(doc);
-await store.docs.put(doc2);
-await store.docs.put(doc3);
-
-
-// search for documents from another peer
-const peer2 = await Peerbit.create ({libp2: another_libp2p_instance})
-const store2 = peer2.open(store.address);
-
-let responses: Document[] = await store2.docs.index.search(
-    new SearchRequest({
-        query: [
-          new StringMatch({
-                key: "name",
-                value: "ello",
-				method: StringMatchMethod.contains
-            }),
-        ],
-    })
-);
-expect(responses]).to.have.length(2);
-expect(responses.map((x) => x.value.id)).to.deep.equal(["1", "2"]);
-```