webstore/readme.md

# @push.rocks/webstore

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

Install via npm:

```bash
npm install @push.rocks/webstore
```

Or with pnpm:

```bash
pnpm add @push.rocks/webstore
```

## Usage

`@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 store = new WebStore<{ name: string; age: number }>({
  dbName: 'myAppDatabase',
  storeName: 'users',
});
```

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 store.set('user:1', { name: 'Alice', age: 30 });
await store.set('user:2', { name: 'Bob', age: 25 });
```

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
const user = await store.get('user:1');
console.log(user); // { name: 'Alice', age: 30 }
```

Returns `undefined` if the key doesn't exist.

### ✅ Checking Key Existence

```typescript
const exists = await store.check('user:1');
console.log(exists); // true

const missing = await store.check('user:999');
console.log(missing); // false
```

### 🗑️ Deleting Data

Remove a single entry:

```typescript
await store.delete('user:1');
```

Or clear the entire store:

```typescript
await store.clear();
```

### 🔑 Listing All Keys

```typescript
const allKeys = await store.keys();
console.log(allKeys); // ['user:1', 'user:2']
```

### 🌐 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
// 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'
```

### ⚡ Typed Request Caching

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 cache = new TypedrequestCache('api.example.com');

// Cache a request/response pair
await cache.setByRequest({
  method: 'getUserProfile',
  request: { userId: '123' },
  response: { name: 'Alice', role: 'admin' },
});

// Retrieve cached response by matching method + request
const cached = await cache.getByRequest({
  method: 'getUserProfile',
  request: { userId: '123' },
});

console.log(cached.response); // { name: 'Alice', role: 'admin' }
```

> **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
const store = new WebStore({ dbName: 'mydb', storeName: 'data' });

// Both of these trigger init, but it only runs once
const [a, b] = await Promise.all([
  store.get('key1'),
  store.get('key2'),
]);
```

## 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 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 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

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.