feat : initial version support for node runtime

Author: nuzulul

.gitignore

@@ -128,3 +128,11 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+#hook
+test/cjs/node_modules/
+test/mjs/node_modules/
+public/
+package-lock.json
+data/
+docs/

README.md

@@ -1,2 +1,130 @@
 # kv-storage
 Create data storage that uses a simple key-value method for Node, Browser, Deno, Bun, Cloudflare Workers
+
+## Features
+
+* ✅ 0 Dependencies
+* ✅ NoSQL Database
+* ✅ Lightwight
+
+## Demo
+
+[https://codesandbox.io/p/devbox/simple-kv-storage-pzr9ld](https://codesandbox.io/p/devbox/simple-kv-storage-pzr9ld)
+
+## Installation
+
+```javascript
+npm install kv-storage
+```
+
+## Initialization
+
+```javascript
+//ES Modules import style
+import {KVStorage} from 'kv-storage'
+
+	or
+
+//CommonJS import style
+const {KVStorage} = require('kv-storage')
+
+const db = await KVStorage.init({
+	runtime:'node',
+	storageName:'storage'
+})
+```
+
+## Example Usage
+
+```javascript
+import {KVStorage} from 'kv-storage'
+
+void async function main() {
+	const db = await KVStorage.init({
+		storageName:'storage'
+	})
+	
+	console.log(await db.put('key','value'))
+	console.log(await db.get('key'))
+	console.log(await db.list())
+	console.log(await db.delete('key'))
+}()
+```
+
+```javascript
+const {KVStorage} = require('kv-storage')
+
+void async function main() {
+	const db = await KVStorage.init({
+		storageName:'storage'
+	})
+	
+	console.log(await db.put('key','value'))
+	console.log(await db.get('key'))
+	console.log(await db.list())
+	console.log(await db.delete('key'))
+}()
+```
+
+## API Reference
+
+### Init Parameters
+
+```javascript
+await init({
+	runtime?:string,
+	storageName?:string 
+})
+```
+```
+runtime =  Javascript runtime 
+storageName = Alphanumeric name of storage
+```
+Supported runtime :
+- [x] `node`
+- [ ] `browser`
+- [ ] `deno`
+- [ ] `bun`
+- [ ] `cloudflare-workers`
+- [ ] `memory`
+### Write key-value pairs
+
+```javascript
+await put(key:string,value:string)
+```
+The put() method returns a Promise that you should await on to verify a successful update which resolves with a boolean :
+* true = Update successful
+* false = Update failed
+### Read key-value pairs
+
+```javascript
+await get(key:string)
+```
+The get() method returns a promise you can await on to get the value which resolves with:
+* null = The key is not found
+* data = Get the value successful
+* false = Get the value failed
+
+### List keys
+
+```javascript
+await list()
+```
+Use a list operation to view all the keys that live in a given storage, return a promise which resolves with an object consist of:
+* keys = Array of keys
+* complete = True if operation complete
+
+### Delete key-value pairs
+
+```javascript
+await delete(key:string)
+```
+
+To delete a key-value pair, call the delete() method, return a promise which resolves with:
+* null = The key is not found
+* true = Delete successful
+* false = Delete failed
+
+## License
+
+MIT

package.json

@@ -0,0 +1,62 @@
+{
+  "name": "kv-storage",
+  "version": "0.0.1",
+  "description": "Create data storage that uses a simple key-value method for Node, Browser, Deno, Bun, Cloudflare Workers",
+  "main": "dist/cjs/kv-storage.js",
+  "module": "dist/mjs/kv-storage.js",
+  "exports": {
+    ".": {
+      "import": "./dist/mjs/kv-storage.js",
+      "require": "./dist/cjs/kv-storage.js"
+    }
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "start": "node public/test/server.js",
+    "start-mjs": "npm run build && node public/test/server-mjs.js",
+    "dev-ts": "nodemon -e js,ts --watch src --watch test --exec \"ts-node test/server\"",
+    "dev": "nodemon -e js,ts --watch src --watch test --exec \"npm run build && npm start\"",
+    "dev-mjs": "nodemon -e js,ts --watch src --watch test --exec \"npm run start-mjs\"",
+    "build-win": "npm run prepare-build-win && tsc -p tsconfig-mjs.json && tsc -p tsconfig-cjs.json && echo {\"type\": \"commonjs\"}>dist\\cjs\\package.json && echo {\"type\": \"module\"}>dist\\mjs\\package.json",
+    "prepare-build": "if exist .\\dist (echo ok) && mkdir dist && del /S /Q .\\dist\\*",
+    "prepare-build-win": "if not exist .\\dist (mkdir dist) else (rmdir /S /Q .\\dist\\)"
+  },
+  "files": [
+    "dist/",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nuzulul/kv-storage.git"
+  },
+  "keywords": [
+    "nodejs",
+    "nosql",
+    "data-storage",
+    "data-store",
+    "node-js",
+    "nosql-database",
+    "file-storage",
+    "kv-storage",
+    "key-value-storage",
+    "node-key-value-storage",
+    "node-kv-storage",
+    "browser-kv-storage",
+    "deno-kv-storage",
+    "bun-kv-storage",
+    "cloudflare-workers"
+  ],
+  "author": "Nuzulul Zulkarnain",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/nuzulul/kv-storage/issues"
+  },
+  "homepage": "https://github.com/nuzulul/kv-storage#readme",
+  "devDependencies": {
+    "nodemon": "^3.0.3",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.25.7",
+    "typescript": "^5.3.3"
+  }
+}

src/kv-storage.ts

@@ -0,0 +1,34 @@
+export async function KVStorage({
+	runtime = 'node',
+	storageName = 'storage'
+	}:{
+		runtime?:string,
+		storageName?:string
+	}): Promise<any> {
+
+	function isAlphanumeric(str:string) {
+	  return /^[a-zA-Z0-9]+$/.test(str);
+	}
+	
+	function showError(msg:string = 'Error'){
+		throw new Error(msg)
+	}
+
+	if(!isAlphanumeric(runtime))showError('Runtime must be Alphanumeric')
+	if(!isAlphanumeric(storageName))showError('storageName must be Alphanumeric')
+
+	switch(runtime.toLowerCase()){
+		case 'node':
+			const runtime = await import('./node-kv-storage')
+			const db = await runtime.NodeKVStorage.init({
+				storageName
+			})
+			return db
+			break
+		case 'browser':
+			break
+		default:
+			showError('Runtime unknown')
+	}
+
+}

src/node-kv-storage.ts

@@ -0,0 +1,133 @@
+import fs from 'fs'
+
+export class NodeKVStorage{
+
+	_storageDir:string
+	
+	private constructor({
+		storageDir
+	}:{
+
+		storageDir:string
+	}){
+
+		this._storageDir = storageDir
+	}
+
+	private isAlphanumeric(str:string) {
+	  return /^[a-zA-Z0-9]+$/.test(str);
+	}
+	
+	private showError(msg:string = 'Error'){
+		throw new Error(msg)
+	}
+	
+	public static async init({
+		dataDirName = "data",
+		storageName
+	}:{
+		dataDirName?:string,
+		storageName:string
+	}): Promise<NodeKVStorage>{
+	
+		function isAlphanumeric(str:string) {
+		  return /^[a-zA-Z0-9]+$/.test(str);
+		}
+		
+		function showError(msg:string = 'Error'){
+			throw new Error(msg)
+		}
+
+		async function makeDir(dir:string): Promise<boolean>{
+			return new Promise((resolve) => {
+				fs.stat(dir, (err)=>{
+					if (err) {
+						fs.mkdir(dir, { recursive: true }, (err,path) => {
+							if (err) {resolve(false)}else{resolve(true)}
+						})
+					}else{resolve(true)}
+				})
+			})
+		}
+
+		if(!isAlphanumeric(dataDirName))showError('dataDirName must be Alphanumeric')
+		if(!isAlphanumeric(storageName))showError('storageName must be Alphanumeric')
+		let _dataDirName = "./"+dataDirName
+		let storageDir = _dataDirName+'/'+storageName
+		await makeDir(storageDir)
+		return new NodeKVStorage({storageDir})
+	}
+
+	
+	private async makeDirSync(dir:string){
+      if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, {
+            recursive: true
+        })
+      }
+	}
+	
+	private async makeDir(dir:string): Promise<boolean>{
+		return new Promise((resolve) => {
+			fs.stat(dir, (err)=>{
+				if (err) {
+					fs.mkdir(dir, { recursive: true }, (err,path) => {
+						if (err) {resolve(false)}else{resolve(true)}
+					})
+				}else{resolve(true)}
+			})
+		})
+	}
+	
+	public async put(key:string,value:string){
+		return new Promise((resolve) => {
+			if(!this.isAlphanumeric(key))this.showError('Key must be Alphanumeric')
+			const keyFilePath = this._storageDir+'/'+key
+			fs.writeFile(keyFilePath, value,(err)=>{
+				if (err) {resolve(false)}else{resolve(true)}
+			});
+		})
+	}
+	
+	public async get(key:string){
+		return new Promise((resolve) => {
+			if(!this.isAlphanumeric(key))this.showError('Key must be Alphanumeric')
+			const keyFilePath = this._storageDir+'/'+key
+			fs.stat(keyFilePath, (err)=>{
+				if (err) {resolve(null)}else{
+				  fs.readFile(keyFilePath,(err,data)=>{
+					if (err) {resolve(false)}else{resolve(data.toString('utf8', 0, data.length))}
+				  });
+				}
+			})
+		})
+	}
+
+	public async delete(key:string){
+		return new Promise((resolve) => {
+			if(!this.isAlphanumeric(key))this.showError('Key must be Alphanumeric')
+			const keyFilePath = this._storageDir+'/'+key
+			fs.stat(keyFilePath, (err)=>{
+				if (err) {resolve(null)}else{
+				  fs.unlink(keyFilePath,(err)=>{
+					if (err) {resolve(false)}else{resolve(true)}
+				  });
+				}
+			})
+		})
+	}
+	
+	public async list(){
+		return new Promise((resolve) => {
+			  fs.readdir(this._storageDir,(err,files)=>{
+				if (err) {throw err}else{
+					let result = {
+						keys:files,
+						complete:true
+					}
+					resolve(result)
+				}
+			  });
+		})
+	}
+}

test/server.ts

@@ -0,0 +1,16 @@
+import {KVStorage} from './../src/kv-storage'
+
+void async function main() {
+
+	const db = await KVStorage({
+		runtime:'node',
+		storageName:'storage'
+	})
+	
+	console.log(await db.put('yes','no'))
+	console.log(await db.get('yes'))
+	console.log(await db.delete('yes'))
+	console.log(await db.get('yes'))
+	console.log(await db.put('yes1','no1'))
+	console.log(await db.list())
+}()