kv-storage - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

dist/cjs/kv-storage.js

@@ -70,2 +70,3 @@ "use strict";
                 const runbrowser = yield Promise.resolve(`${browserpkg}`).then(s => __importStar(require(s)));
+                //const runbrowser = await import('./browser-kv-storage')
                 const dbbrowser = yield runbrowser.BrowserKVStorage.init({
@@ -72,0 +73,0 @@ databaseName,

dist/mjs/kv-storage.js

@@ -34,2 +34,3 @@ export async function KVStorage({ runtime = 'node', databaseName = 'kvstorage', storageName = 'storage' }) {
             const runbrowser = await import(browserpkg);
+            //const runbrowser = await import('./browser-kv-storage')
             const dbbrowser = await runbrowser.BrowserKVStorage.init({
@@ -36,0 +37,0 @@ databaseName,

package.json

 {
   "name": "kv-storage",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Create data storage that uses a simple key-value method for Node, Browser, Deno, Bun, Cloudflare Workers",
@@ -19,14 +19,16 @@ "main": "dist/cjs/kv-storage.js",
     "dev-ts": "nodemon -e js,ts --watch src --watch test --exec \"ts-node test/server\"",
-	"dev-browser": "nodemon -e js,ts,html --watch src --watch test --exec \"npm run prepare-public && tsc -p tsconfig-browser.json && ts-node test/server-browser.ts\"",
-	"dev-deno": "nodemon -e js,ts --watch src --watch test --exec \"deno run --allow-read --allow-write --unstable-sloppy-imports test/server-deno.ts\"",
+    "dev-browser": "nodemon -e js,ts,html --watch src --watch test --exec \"npm run prepare-public && tsc -p tsconfig-browser.json && tsc -p tsconfig-umd.json && rollup -c public/config/rollup.config.js && ts-node test/server-browser.ts\"",
+    "dev-umd": "nodemon -e js,ts,html --watch src --watch test --exec \"npm run prepare-public && tsc -p tsconfig-umd.json && rollup -c public/config/rollup.config.js && ts-node test/server-browser.ts\"",
+    "dev-deno": "nodemon -e js,ts --watch src --watch test --exec \"deno run --allow-read --allow-write --unstable-sloppy-imports test/server-deno.ts\"",
     "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",
+    "build-win": "npm run prepare-build-win && tsc -p tsconfig-mjs.json && tsc -p tsconfig-cjs.json && tsc -p tsconfig-umd.json && rollup -c public/config/rollup.config.umd.js && 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\\)",
-	"prepare-typedoc": "if not exist .\\docs (mkdir docs) else (rmdir /S /Q .\\docs\\)",
-	"prepare-public": "if not exist .\\public (mkdir public) else (rmdir /S /Q .\\public\\)",
-	"typedoc":"npm run prepare-typedoc && typedoc src/kv-storage.ts src/node-kv-storage.ts src/deno-kv-storage.ts src/browser-kv-storage.ts",
+    "prepare-typedoc": "if not exist .\\docs (mkdir docs) else (rmdir /S /Q .\\docs\\)",
+    "prepare-public": "if not exist .\\public (mkdir public) else (rmdir /S /Q .\\public\\)",
+    "typedoc": "npm run prepare-typedoc && typedoc src/kv-storage.ts src/node-kv-storage.ts src/deno-kv-storage.ts src/browser-kv-storage.ts",
     "gh-deploy": "git push origin :gh-pages && git subtree push --prefix docs origin gh-pages",
-    "gh-deploy-init": "git push origin && git subtree push --prefix docs origin gh-pages"
+    "gh-deploy-init": "git push origin && git subtree push --prefix docs origin gh-pages",
+    "gh-deploydoc": "npm run typedoc && git add docs -f && git commit -m \"docs\" && npm run gh-deploy && git reset --soft HEAD~ && git restore --staged ."
   },
@@ -65,4 +67,7 @@ "files": [
   "devDependencies": {
+    "@rollup/plugin-typescript": "^11.1.6",
     "nodemon": "^3.0.3",
+    "rollup": "^4.9.6",
     "ts-node": "^10.9.2",
+    "tslib": "^2.6.2",
     "typedoc": "^0.25.7",
@@ -69,0 +74,0 @@ "typescript": "^5.3.3"

README.md

@@ -17,5 +17,11 @@ # kv-storage
 ## Installation
+
+NPM (node, browser, deno)
 ```javascript
 npm install kv-storage
 ```
+CDN (browser)
+```javascript
+<script src="https://cdn.jsdelivr.net/npm/kv-storage@0.0.4/dist/umd/kv-storage.js"></script>
+```
 
@@ -35,7 +41,15 @@ ## Initialization
 const db = await KVStorage({
-	runtime:'node', //node | deno | browser
+	runtime:'node', //node | browser| deno
 	storageName:'storage'
 })
 ```
+```javascript
+//Browser using CDN
 
+const db = await kvstorage.KVStorage({
+	runtime:'browser',
+	storageName:'storage'
+})
+```
+
 ## Example Usage
@@ -78,10 +92,10 @@
 ```
-
 ```javascript
-//Deno example
-import {KVStorage} from 'npm:kv-storage'
+<script src="https://cdn.jsdelivr.net/npm/kv-storage@0.0.4/dist/umd/kv-storage.js"></script>
+<script>
+//Browser using CDN example
 
 void async function main() {
-	const db = await KVStorage({
-		runtime:'deno',
+	const db = await kvstorage.KVStorage({
+		runtime:'browser',
 		storageName:'storage'
@@ -96,2 +110,3 @@ })
 }()
+</script>
 ```
@@ -101,4 +116,4 @@
 <script type="module">
-//Directly in Browser example
-import {KVStorage} from 'https://cdn.jsdelivr.net/npm/kv-storage@0.0.3/dist/mjs/kv-storage.js'
+//Browser ES Modules example
+import {KVStorage} from 'https://cdn.jsdelivr.net/npm/kv-storage@0.0.4/dist/mjs/kv-storage.js'
 
@@ -119,3 +134,20 @@ void async function main() {
 ```
+```javascript
+//Deno example
+import {KVStorage} from 'npm:kv-storage'
 
+void async function main() {
+	const db = await KVStorage({
+		runtime:'deno',
+		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'))
+	console.log(await db.has('key'))
+}()
+```
+
 ## API Reference
@@ -127,3 +159,3 @@
 
-### Init Parameters
+### Initialization parameters
 
@@ -138,3 +170,3 @@ ```javascript
 runtime =  Javascript runtime 
-storageName = Alphanumeric name of storage
+storageName = Alphanumeric storage name
 ```
@@ -144,3 +176,3 @@ Supported runtime :
 - [x] `deno` need `--allow-read --allow-write`
-- [x] `browser`
+- [x] `browser` use IndexedDB
 - [ ] `bun`
@@ -147,0 +179,0 @@ - [ ] `cloudflare-workers`

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

69628

increased by42.64%

Number of package files

27

increased by28.57%

Lines of code

1645

increased by49.68%

Number of lines in readme file

212

increased by17.78%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

7

increased by75%

Number of low supply chain risk alerts

4

increased by33.33%

No dependency changes