push.rocks/webstore
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(build): migrate project tooling and tests to the smartconfig setup and updated IndexedDB dependencies

Browse Source
This commit is contained in:
Jürgen Kunz
2026-03-26 08:33:53 +00:00
parent 12119192cf
commit e3e143eeb4
14 changed files with 5875 additions and 2581 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
npmextra.json → .smartconfig.json
View File

@@ -1,5 +1,5 @@
{
"gitzone": {
"@git.zone/cli": {
"projectType": "npm",
"module": {
"githost": "code.foss.global",
@@ -23,13 +23,19 @@
"API caching",
"efficient data management"
]
},
"release": {
"registries": [
"https://verdaccio.lossless.digital",
"https://registry.npmjs.org"
],
"accessLevel": "public"
}
},
"npmci": {
"npmGlobalTools": [],
"npmAccessLevel": "public"
},
"tsdoc": {
"@git.zone/tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
},
"@ship.zone/szci": {
"npmGlobalTools": []
}
}

51
changelog.md Normal file
View File

@@ -0,0 +1,51 @@
# Changelog
## 2026-03-26 - 2.0.21 - fix(build)
migrate project tooling and tests to the smartconfig setup and updated IndexedDB dependencies
- replace deprecated npmextra.json metadata with .smartconfig.json
- switch IndexedDB import from @tempfix/idb to idb and add pnpm overrides and patch metadata
- update test imports and rename cross-runtime tests to the node+chromium convention
- add Node.js types and initialize the WebStore database property with a definite assignment assertion
## 2024-05-29 - 2.0.20 - metadata
Updated project description.
- Refreshed package description metadata
- Includes routine release housekeeping for versions 2.0.19-2.0.20
## 2024-05-17 - 2.0.14-2.0.19 - core
Applied a series of routine core updates across multiple patch releases.
- Repeated `fix(core): update` changes were released from 2.0.14 through 2.0.19
- Changes appear to be maintenance-level updates with no further detail in commit history
## 2024-04-14 - 2.0.13 - build
Updated project configuration and package host metadata.
- Updated `tsconfig`
- Updated `npmextra.json` githost settings
## 2023-05-01 - 2.0.5-2.0.12 - core
Released a sequence of routine core patch updates.
- Repeated `fix(core): update` changes were published from 2.0.5 through 2.0.12
- No additional implementation details were provided in commit messages
## 2022-05-28 - 2.0.0 - core
Released the 2.0 major version with a breaking module format change.
- Breaking change: switched package output to ESM
- Included routine core update follow-up releases through 2.0.4
## 2020-10-17 - 1.0.16-1.0.18 - core
Released routine maintenance updates leading up to the final 1.x release.
- Repeated `fix(core): update` changes were published for 1.0.16 and 1.0.17
- Version 1.0.18 introduced the breaking change later released as part of 2.0.0: switch to ESM
## 2020-07-09 - 1.0.1-1.0.15 - core
Published a long series of routine core maintenance releases.
- Repeated `fix(core): update` changes were released across versions 1.0.1 through 1.0.15
- Commit history does not include more specific change details

2
license
View File

@@ -1,4 +1,4 @@
Copyright (c) 2020 Lossless GmbH (hello@lossless.com)
Copyright (c) 2020 Task Venture Capital GmbH (hello@task.vc)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

42
package.json
View File

@@ -14,22 +14,22 @@
"buildDocs": "tsdoc"
},
"devDependencies": {
"@git.zone/tsbuild": "^2.1.80",
"@git.zone/tsrun": "^1.2.46",
"@git.zone/tstest": "^1.0.90",
"@push.rocks/smartntml": "^2.0.4",
"@push.rocks/tapbundle": "^5.0.23",
"@types/node": "^20.12.12"
"@git.zone/tsbuild": "^4.4.0",
"@git.zone/tsrun": "^2.0.2",
"@git.zone/tstest": "^3.6.1",
"@push.rocks/smartntml": "^2.0.8",
"@push.rocks/tapbundle": "^6.0.3",
"@types/node": "^25.5.0"
},
"dependencies": {
"@api.global/typedrequest-interfaces": "^3.0.19",
"@push.rocks/lik": "^6.0.15",
"@push.rocks/smartenv": "^5.0.12",
"@push.rocks/smartjson": "^5.0.19",
"@push.rocks/smartpromise": "^4.0.3",
"@push.rocks/smartrx": "^3.0.7",
"@tempfix/idb": "^8.0.3",
"fake-indexeddb": "^5.0.2"
"@push.rocks/lik": "^6.4.0",
"@push.rocks/smartenv": "^6.0.0",
"@push.rocks/smartjson": "^6.0.0",
"@push.rocks/smartpromise": "^4.2.3",
"@push.rocks/smartrx": "^3.0.10",
"fake-indexeddb": "^6.2.5",
"idb": "^8.0.3"
},
"browserslist": [
"last 1 chrome versions"
@@ -43,7 +43,7 @@
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
".smartconfig.json",
"readme.md"
],
"keywords": [
@@ -60,6 +60,20 @@
"API caching",
"efficient data management"
],
"pnpm": {
"onlyBuiltDependencies": [
"esbuild",
"puppeteer",
"sharp",
"mongodb-memory-server"
],
"overrides": {
"@push.rocks/smartrequest": "^5.0.1"
},
"patchedDependencies": {
"agentkeepalive@4.5.0": "patches/agentkeepalive@4.5.0.patch"
}
},
"homepage": "https://code.foss.global/push.rocks/webstore",
"repository": {
"type": "git",

16
patches/agentkeepalive@4.5.0.patch Normal file
View File

@@ -0,0 +1,16 @@
diff --git a/History.md b/History.md
deleted file mode 100644
index 6877834dd92a5c71416d47b8d5f92a16aff5c1e6..0000000000000000000000000000000000000000
diff --git a/index.js b/index.js
index 6ca1513463724d5ab388b5fa4cfc44df0d93ff3d..cfe41dce77cb5e402e917980b0895c379b8f2033 100644
--- a/index.js
+++ b/index.js
@@ -1,5 +1,7 @@
'use strict';
-module.exports = require('./lib/agent');
+const HttpAgent = require('./lib/agent');
+module.exports = HttpAgent;
+module.exports.HttpAgent = HttpAgent;
module.exports.HttpsAgent = require('./lib/https_agent');
module.exports.constants = require('./lib/constants');

8036
pnpm-lock.yaml generated
View File

File diff suppressed because it is too large Load Diff

274
readme.md
View File

@@ -1,226 +1,198 @@
# @push.rocks/webstore
High performance storage in the browser using IndexedDB.
A high-performance, isomorphic key-value storage solution powered by IndexedDB — works seamlessly in the browser and Node.js with zero config.
## Issue Reporting and Security
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
## Install
To install `@push.rocks/webstore`, use the following npm command:
Install via npm:
```bash
npm install @push.rocks/webstore --save
npm install @push.rocks/webstore
```
This will add it to your project's dependencies.
Or with pnpm:
```bash
pnpm add @push.rocks/webstore
```
## Usage
The `@push.rocks/webstore` module provides a high-performance storage solution for web applications, leveraging IndexedDB. This guide demonstrates how to use `@push.rocks/webstore` to store, retrieve, check, and manage data in the browser efficiently.
### Basic Setup
Before using `@push.rocks/webstore`, you must import and instantiate a `WebStore` class. Specify a database name (`dbName`) and a store name (`storeName`) in the options:
`@push.rocks/webstore` provides a clean, Promise-based API over IndexedDB. It auto-detects the runtime environment — in the browser it uses native IndexedDB, on Node.js it transparently loads `fake-indexeddb` for testing and server-side use.
> All methods are fully typed via TypeScript generics. ESM-only (`"type": "module"`).
### 🏗️ Creating a Store
Create a `WebStore` instance by specifying a database name and an object store name:
```typescript
import { WebStore } from '@push.rocks/webstore';
const myStore = new WebStore<{
[key: string]: any; // Define the shape of your store objects here
}>({
dbName: 'myDatabase',
storeName: 'myStore'
const store = new WebStore<{ name: string; age: number }>({
dbName: 'myAppDatabase',
storeName: 'users',
});
```
### Initialization
To ensure that IndexedDB is set up correctly, call the `init` method before executing any CRUD operations:
The generic type parameter `<T>` defines the shape of values stored — giving you full type safety on `get` and `set` operations.
### 📝 Storing Data
```typescript
await myStore.init();
await store.set('user:1', { name: 'Alice', age: 30 });
await store.set('user:2', { name: 'Bob', age: 25 });
```
### Storing Data
To store data, use the `set` method with a key and value. The value can be any object adhering to the store's object shape:
Initialization is automatic — the first call to any data method triggers `init()` behind the scenes, so you don't need to call it manually.
### 📖 Retrieving Data
```typescript
await myStore.set('myKey', { some: 'data' });
const user = await store.get('user:1');
console.log(user); // { name: 'Alice', age: 30 }
```
### Retrieving Data
To retrieve data, use the `get` method with a key. This method returns a promise that resolves to the value associated with the key, or `undefined` if the key does not exist:
Returns `undefined` if the key doesn't exist.
### ✅ Checking Key Existence
```typescript
const myData = await myStore.get('myKey');
console.log(myData); // { some: 'data' }
const exists = await store.check('user:1');
console.log(exists); // true
const missing = await store.check('user:999');
console.log(missing); // false
```
### Checking Data Existence
To check whether a key exists in the store, use the `check` method:
### 🗑️ Deleting Data
Remove a single entry:
```typescript
const exists = await myStore.check('myKey');
console.log(exists); // true or false
await store.delete('user:1');
```
### Deleting Data
To delete a specific entry, use the `delete` method with a key:
Or clear the entire store:
```typescript
await myStore.delete('myKey');
await store.clear();
```
### Clearing the Store
To remove all entries from the store, use the `clear` method:
### 🔑 Listing All Keys
```typescript
await myStore.clear();
const allKeys = await store.keys();
console.log(allKeys); // ['user:1', 'user:2']
```
### Fetching All Keys
To retrieve all keys from the store, use the `keys` method. It returns a promise that resolves to an array of keys:
### 🌐 Isomorphic by Design
`WebStore` automatically detects the runtime:
- **Browser** → uses the native `IndexedDB` API directly
- **Node.js** → auto-loads `fake-indexeddb` to provide an in-memory IndexedDB implementation
This means the exact same code works in both environments — perfect for universal/isomorphic apps, SSR frameworks, and testing.
```typescript
const allKeys = await myStore.keys();
console.log(allKeys); // ['myKey', ...]
// Works identically in Node.js and the browser
const store = new WebStore<string>({
dbName: 'config',
storeName: 'settings',
});
await store.set('theme', 'dark');
const theme = await store.get('theme'); // 'dark'
```
### Error Handling
One of the strengths of `WebStore` is its built-in error handling using `smartpromise`. All the asynchronous operations (`init`, `get`, `set`, `delete`, `clear`, `keys`) inherently handle errors gracefully by catching them and allowing you to handle them with standard JavaScript try-catch or using `.catch` on the promises.
### ⚡ Typed Request Caching
#### Error Handling Example
In TypeScript, you can write try-catch blocks to handle errors:
```typescript
try {
await myStore.set('myKey', { some: 'data' });
} catch (error) {
console.error('Error storing data:', error);
}
try {
const myData = await myStore.get('myKey');
console.log(myData);
} catch (error) {
console.error('Error retrieving data:', error);
}
```
### Advanced Features: Typed Request Caching
`@push.rocks/webstore` also includes a feature for caching typed requests using the `TypedrequestCache` class. This is particularly useful for caching API requests and their responses.
#### Setting Up a Typed Request Cache
To set up a `TypedrequestCache`:
For API-heavy applications, `TypedrequestCache` provides a specialized cache layer for typed requests (compatible with `@api.global/typedrequest-interfaces`). It serializes request method + payload as the cache key and stores the full response.
```typescript
import { TypedrequestCache } from '@push.rocks/webstore';
const myCache = new TypedrequestCache('domainIdentifier');
```
const cache = new TypedrequestCache('api.example.com');
#### Storing a Request and Its Response
Store a request and its response:
```typescript
await myCache.setByRequest({
method: 'GET',
request: 'https://example.com/api/data',
response: { data: 'response data' }
// Cache a request/response pair
await cache.setByRequest({
method: 'getUserProfile',
request: { userId: '123' },
response: { name: 'Alice', role: 'admin' },
});
```
#### Retrieving a Cached Request
Retrieve a cached request by making a partial request:
```typescript
const cachedResponse = await myCache.getByRequest({
method: 'GET',
request: 'https://example.com/api/data'
// Retrieve cached response by matching method + request
const cached = await cache.getByRequest({
method: 'getUserProfile',
request: { userId: '123' },
});
console.log(cachedResponse); // { data: 'response data' }
console.log(cached.response); // { name: 'Alice', role: 'admin' }
```
### Comprehensive Usage Example
Here is a comprehensive example that covers initialization, data manipulation, and error handling:
> **Note:** `setByRequest` will throw if the typed request has no `response` field — you can only cache completed request/response pairs.
### 🔄 Lazy Initialization & Deduplication
`WebStore` handles initialization lazily and safely:
- The first data operation automatically triggers `init()`
- Concurrent calls during init are safely queued via a deferred promise
- Calling `init()` explicitly multiple times is safe — subsequent calls are no-ops
```typescript
import { WebStore, TypedrequestCache } from '@push.rocks/webstore';
const store = new WebStore({ dbName: 'mydb', storeName: 'data' });
async function main() {
const myStore = new WebStore<{
[key: string]: any;
}>({
dbName: 'myDatabase',
storeName: 'myStore',
});
try {
await myStore.init();
// Set data
await myStore.set('myKey', { some: 'data' });
console.log('Data set successfully.');
// Get data
const myData = await myStore.get('myKey');
console.log('Retrieved data:', myData); // { some: 'data' }
// Check data existence
const exists = await myStore.check('myKey');
console.log('Key exists:', exists); // true
// Delete data
await myStore.delete('myKey');
console.log('Data deleted.');
// Clear store
await myStore.clear();
console.log('Store cleared.');
// Fetch all keys
const allKeys = await myStore.keys();
console.log('All keys:', allKeys); // []
} catch (error) {
console.error('Error during storage operations:', error);
}
// Typed Request Caching
const myCache = new TypedrequestCache('exampleDomain');
try {
await myCache.setByRequest({
method: 'GET',
request: 'https://example.com/api/data',
response: { data: 'response data' }
});
console.log('Typed request cached.');
const cachedResponse = await myCache.getByRequest({
method: 'GET',
request: 'https://example.com/api/data'
});
console.log('Cached response:', cachedResponse); // { data: 'response data' }
} catch (error) {
console.error('Error during typed request caching operations:', error);
}
}
main().catch(console.error);
// Both of these trigger init, but it only runs once
const [a, b] = await Promise.all([
store.get('key1'),
store.get('key2'),
]);
```
### Conclusion
The `@push.rocks/webstore` package provides a flexible and efficient way to handle browser storage and caching. With features like error handling, typed request caching, and easy-to-use APIs, it can significantly improve performance and maintainability in web applications. For further exploration, feel free to explore the source code and tests provided in the repository.
## API Reference
### `WebStore<T>`
| Method | Signature | Description |
|--------|-----------|-------------|
| `init()` | `() => Promise<void>` | Explicitly initialize the database (called automatically) |
| `get()` | `(key: string) => Promise<T>` | Retrieve a value by key |
| `set()` | `(key: string, val: T) => Promise<IDBValidKey>` | Store a value under a key |
| `check()` | `(key: string) => Promise<boolean>` | Check if a key exists |
| `delete()` | `(key: string) => Promise<void>` | Delete a single entry |
| `clear()` | `() => Promise<void>` | Remove all entries from the store |
| `keys()` | `() => Promise<IDBValidKey[]>` | Get all keys in the store |
### `TypedrequestCache`
| Method | Signature | Description |
|--------|-----------|-------------|
| `setByRequest()` | `(req: ITypedRequest) => Promise<void>` | Cache a completed typed request |
| `getByRequest()` | `(req: ITypedRequest) => Promise<ITypedRequest>` | Retrieve a cached response by request |
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./license) file.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
Task Venture Capital GmbH
Registered at District Court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
For any legal inquiries or further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

2
test/skip.coexistence.smartntml.ts
View File

@@ -1,4 +1,4 @@
import { expect, tap } from '@push.rocks/tapbundle';
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as smartntml from '@push.rocks/smartntml';
const smartntmlInstance = new smartntml.Smartntml();

2
test/test.typedrequestcache.both.ts → test/test.typedrequestcache.node+chromium.ts
View File

@@ -1,4 +1,4 @@
import { expect, tap } from '@push.rocks/tapbundle';
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as webstore from '../ts/index.js';
let testTypedrequestcache: webstore.TypedrequestCache;

2
test/test.webstore.both.ts → test/test.webstore.node+chromium.ts
View File

@@ -1,4 +1,4 @@
import { expect, tap } from '@push.rocks/tapbundle';
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as webstore from '../ts/index.js';
let testWebstore: webstore.WebStore;

4
ts/00_commitinfo_data.ts
View File

@@ -1,8 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/webstore',
version: '2.0.20',
version: '2.0.21',
description: 'A high-performance storage solution for web applications using IndexedDB.'
}

2
ts/webstore.classes.webstore.ts
View File

@@ -6,7 +6,7 @@ export interface IWebStoreOptions {
}
export class WebStore<T = any> {
public db: plugins.idb.IDBPDatabase;
public db!: plugins.idb.IDBPDatabase;
public options: IWebStoreOptions;
private initCalled: boolean = false;
private readyDeferred = plugins.smartpromise.defer();

2
ts/webstore.plugins.ts
View File

@@ -13,6 +13,6 @@ import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
export { typedrequestInterfaces };
// thirdparty scope
import * as idb from '@tempfix/idb';
import * as idb from 'idb';
export { idb };

3
tsconfig.json
View File

@@ -6,7 +6,8 @@
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
"verbatimModuleSyntax": true,
"types": ["node"]
},
"exclude": [
"dist_*/**/*.d.ts"