Compare commits
44 Commits
Author | SHA1 | Date | |
---|---|---|---|
37ab7e51f1 | |||
0d343329f5 | |||
94280da45c | |||
9902414f5a | |||
65fe260519 | |||
6f425906e5 | |||
257b995ca0 | |||
2500ba4cd4 | |||
20a81e8209 | |||
18145a27e2 | |||
f62e0f87ce | |||
4e74159a54 | |||
2e8d3ca7e8 | |||
dfb4a4f62a | |||
948957b03f | |||
cb69bf3585 | |||
3d27c0fada | |||
94672fd41c | |||
4b3964c7c4 | |||
7fa246e0e4 | |||
dac5342a19 | |||
1829db1d82 | |||
3c4cba97c2 | |||
b86bd61cbf | |||
ad95154284 | |||
7fb47d224e | |||
40175dc4de | |||
115d461d29 | |||
00964a7db1 | |||
b00db37bf4 | |||
995ae20502 | |||
5c805e57a2 | |||
938207f1c5 | |||
e810bd9473 | |||
10d1bb35ce | |||
8e97b51f1f | |||
7159b33425 | |||
5860066621 | |||
fca8c434f6 | |||
6bd3bd4f37 | |||
068199b5e9 | |||
0eb8193e4a | |||
34e898e0cf | |||
3530e376d6 |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal 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
|
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal 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 @gitzone/tsdoc
|
||||
npmci command tsdoc
|
||||
continue-on-error: true
|
127
.gitlab-ci.yml
127
.gitlab-ci.yml
@ -1,127 +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
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
audit:
|
||||
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
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# 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:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
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:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
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
|
||||
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
24
.vscode/launch.json
vendored
@ -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"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
2
.vscode/settings.json
vendored
2
.vscode/settings.json
vendored
@ -15,7 +15,7 @@
|
||||
"properties": {
|
||||
"projectType": {
|
||||
"type": "string",
|
||||
"enum": ["website", "element", "service", "npm"]
|
||||
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -3,10 +3,10 @@
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "webstore",
|
||||
"shortDescription": "high performance storage in the browser using indexed db",
|
||||
"npmPackagename": "@pushrocks/webstore",
|
||||
"description": "high performance storage in the browser using indexed db",
|
||||
"npmPackagename": "@push.rocks/webstore",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks"
|
||||
}
|
||||
|
11026
package-lock.json
generated
11026
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
30
package.json
30
package.json
@ -1,27 +1,35 @@
|
||||
{
|
||||
"name": "@pushrocks/webstore",
|
||||
"version": "1.0.6",
|
||||
"name": "@push.rocks/webstore",
|
||||
"version": "2.0.9",
|
||||
"private": false,
|
||||
"description": "high performance storage in the browser using indexed db",
|
||||
"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)",
|
||||
"format": "(gitzone format)"
|
||||
"build": "(tsbuild --web --allowimplicitany)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.0.22",
|
||||
"@gitzone/tstest": "^1.0.39",
|
||||
"@pushrocks/tapbundle": "^3.0.7",
|
||||
"@types/node": "^14.0.20",
|
||||
"tslint": "^6.1.2",
|
||||
"tslint-config-prettier": "^1.15.0"
|
||||
"@gitzone/tsbuild": "^2.1.66",
|
||||
"@gitzone/tsrun": "^1.2.44",
|
||||
"@gitzone/tstest": "^1.0.77",
|
||||
"@push.rocks/smartntml": "^2.0.4",
|
||||
"@push.rocks/tapbundle": "^5.0.12",
|
||||
"@types/node": "^20.4.5"
|
||||
},
|
||||
"dependencies": {
|
||||
"idb": "^5.0.4"
|
||||
"@apiglobal/typedrequest-interfaces": "^2.0.1",
|
||||
"@push.rocks/lik": "^6.0.3",
|
||||
"@push.rocks/smartenv": "^5.0.5",
|
||||
"@push.rocks/smartjson": "^5.0.6",
|
||||
"@push.rocks/smartpromise": "^4.0.3",
|
||||
"@push.rocks/smartrx": "^3.0.6",
|
||||
"fake-indexeddb": "^4.0.2",
|
||||
"idb": "^7.1.1"
|
||||
},
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
|
5077
pnpm-lock.yaml
generated
Normal file
5077
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
30
readme.md
30
readme.md
@ -1,27 +1,26 @@
|
||||
# @pushrocks/webstore
|
||||
# @push.rocks/webstore
|
||||
high performance storage in the browser using indexed db
|
||||
|
||||
## 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/)
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/webstore)
|
||||
* [gitlab.com (source)](https://gitlab.com/push.rocks/webstore)
|
||||
* [github.com (source mirror)](https://github.com/push.rocks/webstore)
|
||||
* [docs (typedoc)](https://push.rocks.gitlab.io/webstore/)
|
||||
|
||||
## Status for master
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
|
||||
## Usage
|
||||
|
||||
@ -33,7 +32,6 @@ We are always happy for code contributions. If you are not the code contributing
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
## Legal
|
||||
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
|
44
test/skip.coexistence.smartntml.ts
Normal file
44
test/skip.coexistence.smartntml.ts
Normal 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();
|
||||
});
|
||||
|
||||
tap.start();
|
@ -1,25 +0,0 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import * as webstore from '../ts/index';
|
||||
|
||||
let testWebstore: webstore.WebStore;
|
||||
|
||||
tap.test('first test', async () => {
|
||||
testWebstore = new webstore.WebStore({
|
||||
dbName: 'mytestdb',
|
||||
storeName: 'myteststore'
|
||||
});
|
||||
expect(testWebstore).to.be.instanceOf(webstore.WebStore);
|
||||
});
|
||||
|
||||
tap.test('should init the database', async () => {
|
||||
await testWebstore.init();
|
||||
});
|
||||
|
||||
tap.test('should store a value', async () => {
|
||||
await testWebstore.set('testProp1', {
|
||||
wow: 'wowVal'
|
||||
});
|
||||
console.log(JSON.stringify(await testWebstore.get('testProp1')));
|
||||
});
|
||||
|
||||
tap.start();
|
11
test/test.typedrequestcache.both.ts
Normal file
11
test/test.typedrequestcache.both.ts
Normal file
@ -0,0 +1,11 @@
|
||||
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');
|
||||
expect(testTypedrequestcache).toBeInstanceOf(webstore.TypedrequestCache);
|
||||
});
|
||||
|
||||
tap.start();
|
40
test/test.webstore.both.ts
Normal file
40
test/test.webstore.both.ts
Normal file
@ -0,0 +1,40 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
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();
|
||||
});
|
||||
|
||||
tap.start();
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/webstore',
|
||||
version: '2.0.9',
|
||||
description: 'high performance storage in the browser using indexed db'
|
||||
}
|
@ -1 +1,2 @@
|
||||
export * from './webstiore.classes.webstore';
|
||||
export * from './webstore.classes.typedrequestcache.js';
|
||||
export * from './webstore.classes.webstore.js';
|
||||
|
@ -1,45 +0,0 @@
|
||||
import * as plugins from './webstore.plugins';
|
||||
|
||||
export interface IWebStoreOptions {
|
||||
dbName: string;
|
||||
storeName: string;
|
||||
}
|
||||
|
||||
export class WebStore<T = any> {
|
||||
public db: plugins.idb.IDBPDatabase;
|
||||
public objectStore: plugins.idb.IDBPObjectStore;
|
||||
public options: IWebStoreOptions;
|
||||
|
||||
|
||||
constructor(optionsArg: IWebStoreOptions) {
|
||||
this.options = optionsArg;
|
||||
}
|
||||
|
||||
public async init () {
|
||||
this.db = await plugins.idb.openDB(this.options.dbName, 1, {
|
||||
upgrade: (db) => {
|
||||
db.createObjectStore(this.options.storeName);
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
async get(key) {
|
||||
return this.db.get(this.options.storeName, key);
|
||||
}
|
||||
|
||||
async set(key, val) {
|
||||
return this.db.put(this.options.storeName, val, key);
|
||||
}
|
||||
|
||||
async delete(key) {
|
||||
return this.db.delete(this.options.storeName, key);
|
||||
}
|
||||
|
||||
async clear() {
|
||||
return this.db.clear(this.options.storeName);
|
||||
}
|
||||
|
||||
async keys() {
|
||||
return this.db.getAllKeys(this.options.storeName);
|
||||
}
|
||||
}
|
47
ts/webstore.classes.typedrequestcache.ts
Normal file
47
ts/webstore.classes.typedrequestcache.ts
Normal file
@ -0,0 +1,47 @@
|
||||
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
|
||||
*/
|
||||
export class TypedrequestCache {
|
||||
private webstore: WebStore;
|
||||
|
||||
constructor(domainArg = 'default') {
|
||||
this.webstore = new WebStore<plugins.typedrequestInterfaces.ITypedRequest>({
|
||||
dbName: 'trStore',
|
||||
storeName: `trStore-${domainArg}`,
|
||||
});
|
||||
}
|
||||
|
||||
private buildKey(requestArg: plugins.typedrequestInterfaces.ITypedRequest) {
|
||||
return plugins.smartjson.stringify({
|
||||
method: requestArg.method,
|
||||
request: requestArg.request,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* stores by request
|
||||
* @param typedrequestarg
|
||||
*/
|
||||
public async setByRequest(
|
||||
typedrequestArg: plugins.typedrequestInterfaces.ITypedRequest
|
||||
): Promise<void> {
|
||||
if (!typedrequestArg.response) {
|
||||
throw new Error('You cannot store requests without a response present');
|
||||
}
|
||||
await this.webstore.set(this.buildKey(typedrequestArg), typedrequestArg);
|
||||
}
|
||||
|
||||
/**
|
||||
* get by full tyoedrequest by partial typedrequest
|
||||
* @param typedrequestarg
|
||||
*/
|
||||
public async getByRequest(
|
||||
typedrequestArg: plugins.typedrequestInterfaces.ITypedRequest
|
||||
): Promise<plugins.typedrequestInterfaces.ITypedRequest> {
|
||||
const result = await this.webstore.get(this.buildKey(typedrequestArg));
|
||||
return result;
|
||||
}
|
||||
}
|
76
ts/webstore.classes.webstore.ts
Normal file
76
ts/webstore.classes.webstore.ts
Normal file
@ -0,0 +1,76 @@
|
||||
import * as plugins from './webstore.plugins.js';
|
||||
|
||||
export interface IWebStoreOptions {
|
||||
dbName: string;
|
||||
storeName: string;
|
||||
}
|
||||
|
||||
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();
|
||||
|
||||
constructor(optionsArg: IWebStoreOptions) {
|
||||
this.options = optionsArg;
|
||||
}
|
||||
|
||||
public async init() {
|
||||
if (this.initCalled) {
|
||||
await this.readyDeferred.promise;
|
||||
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);
|
||||
},
|
||||
});
|
||||
this.readyDeferred.resolve();
|
||||
return;
|
||||
}
|
||||
|
||||
async get(key: string): Promise<T> {
|
||||
await this.init();
|
||||
return this.db.get(this.options.storeName, key);
|
||||
}
|
||||
|
||||
async check(keyArg: string): Promise<boolean> {
|
||||
await this.init();
|
||||
const result = await this.get(keyArg);
|
||||
return !!result;
|
||||
}
|
||||
|
||||
async set(key: string, val: T) {
|
||||
await this.init();
|
||||
return this.db.put(this.options.storeName, val, key);
|
||||
}
|
||||
|
||||
async delete(key: string) {
|
||||
await this.init();
|
||||
return this.db.delete(this.options.storeName, key);
|
||||
}
|
||||
|
||||
async clear() {
|
||||
await this.init();
|
||||
return this.db.clear(this.options.storeName);
|
||||
}
|
||||
|
||||
async keys() {
|
||||
await this.init();
|
||||
return this.db.getAllKeys(this.options.storeName);
|
||||
}
|
||||
}
|
@ -1,5 +1,18 @@
|
||||
// pushrocks scope
|
||||
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, smartenv, smartjson, smartpromise, smartrx };
|
||||
|
||||
// apiglobal scope
|
||||
import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
|
||||
|
||||
export { typedrequestInterfaces };
|
||||
|
||||
// thirdparty scope
|
||||
import * as idb from 'idb';
|
||||
|
||||
export {
|
||||
idb
|
||||
}
|
||||
export { idb };
|
||||
|
11
tsconfig.json
Normal file
11
tsconfig.json
Normal file
@ -0,0 +1,11 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true,
|
||||
}
|
||||
}
|
17
tslint.json
17
tslint.json
@ -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"
|
||||
}
|
Reference in New Issue
Block a user