Compare commits

...

49 Commits

Author SHA1 Message Date
12119192cf update description 2024-05-29 14:17:47 +02:00
ed0f497ac9 2.0.20 2024-05-28 01:00:35 +02:00
7f7c4a28ee fix(core): update 2024-05-28 01:00:35 +02:00
4ee78554a4 2.0.19 2024-05-25 02:02:45 +02:00
34b90b438c fix(core): update 2024-05-25 02:02:44 +02:00
40dcedf585 2.0.18 2024-05-25 02:02:00 +02:00
d630bd90a4 fix(core): update 2024-05-25 02:01:59 +02:00
56d9072996 2.0.17 2024-05-17 17:46:56 +02:00
ed1c977387 fix(core): update 2024-05-17 17:46:56 +02:00
7425a5c42d 2.0.16 2024-05-17 16:36:57 +02:00
65d5d1f6d3 fix(core): update 2024-05-17 16:36:56 +02:00
88fd33d8cc 2.0.15 2024-05-17 16:35:41 +02:00
d11b63637f fix(core): update 2024-05-17 16:35:40 +02:00
845ffa3c86 2.0.14 2024-04-18 20:52:00 +02:00
77867e26c2 fix(core): update 2024-04-18 20:51:59 +02:00
09e247db1e update tsconfig 2024-04-14 18:42:46 +02:00
394d9e8f9e update tsconfig 2024-04-01 21:42:49 +02:00
92e77a9679 update npmextra.json: githost 2024-04-01 20:00:24 +02:00
76cd2061ad update npmextra.json: githost 2024-03-30 21:49:22 +01:00
5e4f493a21 2.0.13 2023-10-02 19:11:28 +02:00
62f32bd2ba fix(core): update 2023-10-02 19:11:27 +02:00
d537d04fb6 2.0.12 2023-10-02 19:10:31 +02:00
b1586354e9 fix(core): update 2023-10-02 19:10:30 +02:00
ccae316e29 2.0.11 2023-09-30 15:10:42 +02:00
5de6e1d591 fix(core): update 2023-09-30 15:10:42 +02:00
7fe5f98477 2.0.10 2023-09-23 10:08:50 +02:00
ce9f998da8 fix(core): update 2023-09-23 10:08:50 +02:00
37ab7e51f1 2.0.9 2023-07-27 13:51:41 +02:00
0d343329f5 fix(core): update 2023-07-27 13:51:40 +02:00
94280da45c 2.0.8 2023-05-01 14:40:20 +02:00
9902414f5a fix(core): update 2023-05-01 14:40:19 +02:00
65fe260519 2.0.7 2023-05-01 12:45:00 +02:00
6f425906e5 fix(core): update 2023-05-01 12:44:59 +02:00
257b995ca0 2.0.6 2023-05-01 12:17:40 +02:00
2500ba4cd4 fix(core): update 2023-05-01 12:17:39 +02:00
20a81e8209 2.0.5 2022-08-01 15:50:05 +02:00
18145a27e2 fix(core): update 2022-08-01 15:50:05 +02:00
f62e0f87ce 2.0.4 2022-07-07 08:49:31 +02:00
4e74159a54 fix(core): update 2022-07-07 08:49:31 +02:00
2e8d3ca7e8 2.0.3 2022-05-29 20:04:44 +02:00
dfb4a4f62a fix(core): update 2022-05-29 20:04:44 +02:00
948957b03f 2.0.2 2022-05-28 13:40:14 +02:00
cb69bf3585 fix(core): update 2022-05-28 13:40:14 +02:00
3d27c0fada 2.0.1 2022-05-28 12:49:03 +02:00
94672fd41c fix(core): update 2022-05-28 12:49:03 +02:00
4b3964c7c4 2.0.0 2022-05-28 12:33:10 +02:00
7fa246e0e4 BREAKING CHANGE(core): switch to esm 2022-05-28 12:33:10 +02:00
dac5342a19 1.0.18 2022-01-24 04:40:22 +01:00
1829db1d82 fix(core): update 2022-01-24 04:40:21 +01:00
20 changed files with 7306 additions and 27327 deletions

View File

@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @git.zone/tsdoc
npmci command tsdoc
continue-on-error: true

View File

@ -1,137 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- security
- test
- release
- metadata
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
stage: metadata
script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- lossless
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

24
.vscode/launch.json vendored
View File

@ -2,28 +2,10 @@
"version": "0.2.0",
"configurations": [
{
"name": "current file",
"type": "node",
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"args": [
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
"type": "node-terminal"
}
]
}

View File

@ -2,17 +2,34 @@
"gitzone": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"gitscope": "pushrocks",
"githost": "code.foss.global",
"gitscope": "push.rocks",
"gitrepo": "webstore",
"shortDescription": "high performance storage in the browser using indexed db",
"npmPackagename": "@pushrocks/webstore",
"description": "A high-performance storage solution for web applications using IndexedDB.",
"npmPackagename": "@push.rocks/webstore",
"license": "MIT",
"projectDomain": "push.rocks"
"projectDomain": "push.rocks",
"keywords": [
"indexeddb",
"browser storage",
"high performance",
"typescript",
"database",
"web development",
"data persistence",
"storage solution",
"typed requests",
"performance optimization",
"API caching",
"efficient data management"
]
}
},
"npmci": {
"npmGlobalTools": [],
"npmAccessLevel": "public"
},
"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"
}
}

27081
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,31 +1,35 @@
{
"name": "@pushrocks/webstore",
"version": "1.0.17",
"name": "@push.rocks/webstore",
"version": "2.0.20",
"private": false,
"description": "high performance storage in the browser using indexed db",
"description": "A high-performance storage solution for web applications using IndexedDB.",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
"author": "Lossless GmbH",
"license": "MIT",
"scripts": {
"test": "(tstest test/ --web)",
"build": "(tsbuild --web)"
"build": "(tsbuild --web --allowimplicitany)",
"buildDocs": "tsdoc"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.29",
"@gitzone/tstest": "^1.0.60",
"@pushrocks/tapbundle": "^4.0.0",
"@types/node": "^17.0.10",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.15.0"
"@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"
},
"dependencies": {
"@apiglobal/typedrequest-interfaces": "^1.0.15",
"@pushrocks/lik": "^5.0.0",
"@pushrocks/smartjson": "^4.0.6",
"@pushrocks/smartpromise": "^3.1.6",
"@pushrocks/smartrx": "^2.0.20",
"idb": "^7.0.0"
"@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"
},
"browserslist": [
"last 1 chrome versions"
@ -41,5 +45,24 @@
"cli.js",
"npmextra.json",
"readme.md"
]
}
],
"keywords": [
"indexeddb",
"browser storage",
"high performance",
"typescript",
"database",
"web development",
"data persistence",
"storage solution",
"typed requests",
"performance optimization",
"API caching",
"efficient data management"
],
"homepage": "https://code.foss.global/push.rocks/webstore",
"repository": {
"type": "git",
"url": "https://code.foss.global/push.rocks/webstore.git"
}
}

6736
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

243
readme.md
View File

@ -1,39 +1,226 @@
# @pushrocks/webstore
high performance storage in the browser using indexed db
# @push.rocks/webstore
High performance storage in the browser using IndexedDB.
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/webstore)
* [gitlab.com (source)](https://gitlab.com/pushrocks/webstore)
* [github.com (source mirror)](https://github.com/pushrocks/webstore)
* [docs (typedoc)](https://pushrocks.gitlab.io/webstore/)
## Install
To install `@push.rocks/webstore`, use the following npm command:
## Status for master
```bash
npm install @push.rocks/webstore --save
```
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/webstore/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/webstore/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/webstore)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/webstore)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/webstore)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/webstore)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/webstore)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
This will add it to your project's dependencies.
## 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.
Use TypeScript for best in class intellisense
### 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:
## Contribution
```typescript
import { WebStore } from '@push.rocks/webstore';
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
const myStore = new WebStore<{
[key: string]: any; // Define the shape of your store objects here
}>({
dbName: 'myDatabase',
storeName: 'myStore'
});
```
For further information read the linked docs at the top of this readme.
### Initialization
To ensure that IndexedDB is set up correctly, call the `init` method before executing any CRUD operations:
> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
```typescript
await myStore.init();
```
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
### 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:
```typescript
await myStore.set('myKey', { some: 'data' });
```
### 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:
```typescript
const myData = await myStore.get('myKey');
console.log(myData); // { some: 'data' }
```
### Checking Data Existence
To check whether a key exists in the store, use the `check` method:
```typescript
const exists = await myStore.check('myKey');
console.log(exists); // true or false
```
### Deleting Data
To delete a specific entry, use the `delete` method with a key:
```typescript
await myStore.delete('myKey');
```
### Clearing the Store
To remove all entries from the store, use the `clear` method:
```typescript
await myStore.clear();
```
### 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:
```typescript
const allKeys = await myStore.keys();
console.log(allKeys); // ['myKey', ...]
```
### 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.
#### 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`:
```typescript
import { TypedrequestCache } from '@push.rocks/webstore';
const myCache = new TypedrequestCache('domainIdentifier');
```
#### 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' }
});
```
#### 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'
});
console.log(cachedResponse); // { data: 'response data' }
```
### Comprehensive Usage Example
Here is a comprehensive example that covers initialization, data manipulation, and error handling:
```typescript
import { WebStore, TypedrequestCache } from '@push.rocks/webstore';
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);
```
### 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.
## 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.
**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.
### Company Information
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.
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.

View File

@ -0,0 +1,44 @@
import { expect, tap } from '@push.rocks/tapbundle';
import * as smartntml from '@push.rocks/smartntml';
const smartntmlInstance = new smartntml.Smartntml();
import * as webstore from '../ts/index.js';
let testWebstore: webstore.WebStore;
tap.test('first test', async () => {
testWebstore = new webstore.WebStore({
dbName: 'mytest-db',
storeName: 'mytest-store',
});
expect(testWebstore).toBeInstanceOf(webstore.WebStore);
});
tap.test('should allow storing a string', async () => {
await testWebstore.set('mystring', 'heythere');
expect(await testWebstore.get('mystring')).toEqual('heythere');
});
tap.test('should allow storing an object', async () => {
await testWebstore.set('testProp1', {
wow: 'wowVal',
});
console.log(JSON.stringify(await testWebstore.get('testProp1')));
});
tap.test('should overwrite a value', async () => {
await testWebstore.set('testProp1', {
wow: 'wowVal2',
});
console.log(JSON.stringify(await testWebstore.get('testProp1')));
});
tap.test('should correctly check the existence of keys', async () => {
const resultNotThere = await testWebstore.check('notThere');
const resultThere = await testWebstore.check('testProp1');
expect(resultNotThere).toBeFalse();
expect(resultThere).toBeTrue();
});
export default tap.start();

View File

@ -1,11 +1,11 @@
import { expect, tap } from '@pushrocks/tapbundle';
import * as webstore from '../ts/index';
import { expect, tap } from '@push.rocks/tapbundle';
import * as webstore from '../ts/index.js';
let testTypedrequestcache: webstore.TypedrequestCache;
tap.test('first test', async () => {
testTypedrequestcache = new webstore.TypedrequestCache('https://test.lossless.com/typedrequest')
testTypedrequestcache = new webstore.TypedrequestCache('https://test.lossless.com/typedrequest');
expect(testTypedrequestcache).toBeInstanceOf(webstore.TypedrequestCache);
});
tap.start();
export default tap.start();

View File

@ -1,5 +1,5 @@
import { expect, tap } from '@pushrocks/tapbundle';
import * as webstore from '../ts/index';
import { expect, tap } from '@push.rocks/tapbundle';
import * as webstore from '../ts/index.js';
let testWebstore: webstore.WebStore;
@ -37,4 +37,4 @@ tap.test('should correctly check the existence of keys', async () => {
expect(resultThere).toBeTrue();
});
tap.start();
export default tap.start();

8
ts/00_commitinfo_data.ts Normal file
View File

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

View File

@ -1,2 +1,2 @@
export * from './webstore.classes.typedrequestcache';
export * from './webstore.classes.webstore';
export * from './webstore.classes.typedrequestcache.js';
export * from './webstore.classes.webstore.js';

View File

@ -1,5 +1,5 @@
import { WebStore } from './webstore.classes.webstore';
import * as plugins from './webstore.plugins';
import { WebStore } from './webstore.classes.webstore.js';
import * as plugins from './webstore.plugins.js';
/**
* a cache that can be used to store and retrieve typedrequests

View File

@ -1,4 +1,4 @@
import * as plugins from './webstore.plugins';
import * as plugins from './webstore.plugins.js';
export interface IWebStoreOptions {
dbName: string;
@ -7,7 +7,6 @@ export interface IWebStoreOptions {
export class WebStore<T = any> {
public db: plugins.idb.IDBPDatabase;
public objectStore: plugins.idb.IDBPObjectStore;
public options: IWebStoreOptions;
private initCalled: boolean = false;
private readyDeferred = plugins.smartpromise.defer();
@ -22,6 +21,18 @@ export class WebStore<T = any> {
return;
}
this.initCalled = true;
const smartenv = new plugins.smartenv.Smartenv();
if (!smartenv.isBrowser && !globalThis.indexedDB) {
console.log('hey');
console.log(globalThis.indexedDB);
await smartenv.getSafeNodeModule('fake-indexeddb/auto');
if (!globalThis.indexedDB) {
const mod = await smartenv.getSafeNodeModule('fake-indexeddb');
globalThis.indexedDB = new mod.IDBFactory();
}
}
this.db = await plugins.idb.openDB(this.options.dbName, 1, {
upgrade: (db) => {
db.createObjectStore(this.options.storeName);

View File

@ -1,17 +1,18 @@
// pushrocks scope
import * as lik from '@pushrocks/lik';
import * as smartjson from '@pushrocks/smartjson';
import * as smartpromise from '@pushrocks/smartpromise';
import * as smartrx from '@pushrocks/smartrx';
import * as lik from '@push.rocks/lik';
import * as smartenv from '@push.rocks/smartenv';
import * as smartjson from '@push.rocks/smartjson';
import * as smartpromise from '@push.rocks/smartpromise';
import * as smartrx from '@push.rocks/smartrx';
export { lik, smartjson, smartpromise, smartrx };
export { lik, smartenv, smartjson, smartpromise, smartrx };
// apiglobal scope
import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
export { typedrequestInterfaces };
// thirdparty scope
import * as idb from 'idb';
import * as idb from '@tempfix/idb';
export { idb };

14
tsconfig.json Normal file
View File

@ -0,0 +1,14 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}

View File

@ -1,17 +0,0 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}