What's Changed

Features

• feat: add node localstorage quota option by @toniopelo in https://github.com/azu/kvs/pull/47

New Contributors

• @toniopelo made their first contribution in https://github.com/azu/kvs/pull/47

Full Changelog: https://github.com/azu/kvs/compare/v2.1.5...v2.2.0

What's Changed

Refactoring

• refactor(node-localstorage): use native fs by @azu in https://github.com/azu/kvs/pull/44

reduce install size

Full Changelog: https://github.com/azu/kvs/compare/v2.1.4...v2.1.5

What's Changed

Documentation

• fix: small typo by @0xflotus in https://github.com/azu/kvs/pull/35

Refactoring

• refactor: update dependencies by @azu in https://github.com/azu/kvs/pull/42

Testing

• test: move karma to playwright-test by @azu in https://github.com/azu/kvs/pull/41

New Contributors

• @0xflotus made their first contribution in https://github.com/azu/kvs/pull/35

Full Changelog: https://github.com/azu/kvs/compare/v2.1.3...v2.1.4

2.1.3 (2022-09-25)

Bug Fixes

• storage: version saving issue (#32) (49a0839)

2.1.2 (2022-08-21)

Bug Fixes

• kvs/env: module entry point to browser (b8529ad)

Republish for v2.1.0

https://github.com/azu/kvs/releases/tag/v2.1.0

2.1.0 (2022-03-02)

Bug Fixes

• indexeddb: remove "debug" option (#25) (606b9a2)

Performance Improvements

• change target to ES2018 (#28) (cb57cce)

It aim to reduce file size.

This library require AsyncIterator support from the beginning.
It means that it require ES2018+ support.

2.0.0 (2022-02-19)

Bug Fixes

• storage: use name as namespace (#21) (2a8d783)

BREAKING CHANGES

• storage: storage package sperate storags by name option

Previously, @kvs/storage does not separate key per storage.
This issue cause iteration error like #20

However, It need to change saving storage's key for fixing the issue.
We need to bump it as major update.

Affected Packages

• @kvs/env in Node.js
  • 📝 Browser is not affected because it uses IndexedDB
• @kvs/storage
• @kvs/localstorage
• @kvs/memorystorage
• @kvs/node-localstorage
• @kvs/storage-sync

Previous: storage save value with key

key: value

This PR: storage save value with ${name}.__.${key}.

${name}.__.${key}: value

It means that kvs package can not load value which is saved by previous version.

Migration

You need to write manuall migration code using upgrade.

If you have used @kvs/localstorage, you can write following.
Unfortunately, this migration should use raw localStorage API because @kvs/localstorage can not access the key which is created in kvs 1.x.

import { kvsLocalStorage } from "@kvs/localstorage";
type StorageSchema = {
    a1: string;
    b2: number;
    c3: boolean;
};
const databaseName = "kvs-database";
const storage = kvsStorageSync<StorageSchema>({
    name: databaseName,
    version: 2, // If previous `version` is 1, you need to update the version to 2
    storage: localStorage,
    upgrade({ oldVersion }: { kvs: KVSSync<StorageSchema>; oldVersion: number; newVersion: number }): any {
        if (oldVersion < 2) {
            // manually migration to new key format
            ["a1", "b2", "c3"].forEach((key) => {
                // CAUTION: use raw localStorage for migration
                const item = localStorage.getItem(key);
                if (item) {
                    localStorage.setItem(`${databaseName}.__.${key}`, item);
                }
            });
        }
    }
});

for TypeScript User

1.2.0 require TS 4.1+ because it use Key Remapping in Mapped Types.

• Announcing TypeScript 4.1 | TypeScript
  • typescript - How to remove index signature using mapped types - Stack Overflow

Features

• support index signature in SchemaTypes

(async () => {
    type Scheme = {
        [index:string]: string;
    };
    const storage = await kvsEnvStorage<Scheme>({
        name: "test-data",
        version: 1,
    });
    const value = await storage.set("key", "value");
})();

1.1.0 (2020-10-29)

Features

• drop localstorage-memory (#15) (75c66a8)
• examples: add basic example (#14) (351215d)

First Stable Version.

0.3.1 (2020-08-22)

Note: Version bump only for package kvs

0.3.0 (2020-08-22)

Features

• storage-sync: add storage-sync package (#11) (5748776)

0.2.1 (2020-08-22)

Note: Version bump only for package kvs

Introduce Schema #2

0.1.0 (2020-08-08)

Bug Fixes

• add deps (b72e91a)

Features

• @kvs/localstorage: add localstorage implementation (54fc38b)
• @kvs/memorystorage: add in memory implementation (553247b)
• @kvs/node-localstorage: add node implementation (5160012)
• @lvs/env: add universal env (36eef88)
• add close() to interface (a269d1d)
• add debug options (75a083e)
• kvs/indexeddb: add [Symbol.asyncIterator] (68392d4)
• kvs/indexeddb: add dropInstance (0a38a0c)
• kvs/indexeddb: implement basic usage (cc14444)