v8 (#76)

* feat: new JSONSchema, and shortcuts and auto-inference for basic types
* feat: disallow null or undefined in setItem
* feat: allow custom indexeddb database and store names (#78)
* feat: better error management and move idb fallback to main service
* internal: reduce surface api
* fix: stringify all keys for interoperability
* fix: better error management
* feat: new getItem() signature (#79)
* fix: catch stringify error
* fix: catch quota error on localStorage setItem
* fix: catch missing store error
* fix: remove getUnsafeItem()
* feat: new IDB storing behavior with no wrapping (#82)
* feat: new prefix token for interop
* feat: removeItem when storing null or undefined (#93)
* feat: remove xSubscribe() methods (#96)
* feat: separate localStorage and Map APIs (#100)
* feat: iterating keys()
* fix: deprecate xSubscribe
* feat: rxjs 6.4 as minimum
* fix: use openKeyCursor() when possible for perf
* feat: schema option in set()
* fix: throw when storing data that can't be serialized in localStorage (#104)
* feat: engine and database info + opt-in for unwraped values in idb + new options system (#107)
* fix: new interface for new options system
* fix: test and doc about blob refused in idb in safari private

Author: cyrilletuzi

.circleci/config.yml

@@ -7,36 +7,36 @@ jobs: # a collection of steps
       - checkout
       - restore_cache: # special step to restore the dependency cache
           # Read about caching dependencies: https://circleci.com/docs/2.0/caching/
-          key: dependency-cache-{{ checksum "package.json" }}
+          key: dependency-cache-{{ checksum "package-lock.json" }}
       - run:
           name: install-npm-wee
           command: npm install
       - save_cache: # special step to save the dependency cache
-          key: dependency-cache-{{ checksum "package.json" }}
+          key: dependency-cache-{{ checksum "package-lock.json" }}
           paths:
             - ./node_modules
       - run: # run tests
           name: lint
           command: npm run lint
-  build:
+  test:
     docker: # run the steps with Docker
-      - image: circleci/node:10 # ...with this image as the primary container; this is where all `steps` will run
+      - image: circleci/node:10-browsers # ...with this image as the primary container; this is where all `steps` will run
     steps: # a collection of executable commands
       - checkout
       - restore_cache: # special step to restore the dependency cache
           # Read about caching dependencies: https://circleci.com/docs/2.0/caching/
-          key: dependency-cache-{{ checksum "package.json" }}
+          key: dependency-cache-{{ checksum "package-lock.json" }}
       - run:
           name: install-npm-wee
           command: npm install
       - save_cache: # special step to save the dependency cache
-          key: dependency-cache-{{ checksum "package.json" }}
+          key: dependency-cache-{{ checksum "package-lock.json" }}
           paths:
             - ./node_modules
       - run: # run tests
-          name: build
-          command: npm run build
-  test:
+          name: test
+          command: npm test && npm run test:ivy
+  ng80:
     docker: # run the steps with Docker
       - image: circleci/node:10-browsers # ...with this image as the primary container; this is where all `steps` will run
     steps: # a collection of executable commands
@@ -47,17 +47,16 @@ jobs: # a collection of steps
       - run:
           name: install-npm-wee
           command: npm install
-      - save_cache: # special step to save the dependency cache
-          key: dependency-cache-{{ checksum "package-lock.json" }}
-          paths:
-            - ./node_modules
+      - run:
+          name: downgrade
+          command: npm run ci:ng80
       - run: # run tests
           name: test
-          command: ./node_modules/.bin/ng test @ngx-pwa/local-storage --watch false
+          command: npm test
 workflows:
   version: 2
-  lint_and_build_and_test:
+  test:
     jobs:
       - lint
-      - build
       - test
+      - ng80

CHANGELOG.md

@@ -2,11 +2,62 @@
 
 This lib is fully documented and so you'll find detailed [migration guides](./MIGRATION.md).
 
-## 8.0.0-beta.x
+## 8.0.0-beta.13 (2019-05-27)
 
-v8 development is tracked in [#76](https://github.com/cyrilletuzi/angular-async-local-storage/pull/76).
+**A [full migration guide to version 8](./docs/MIGRATION_TO_V8.md) is available.**
 
-This will be an important release so **beta testers are very welcomed.**
+### Angular 8
+
+v8 requires Angular 8.
+
+### Feature: new `StorageMap` service
+
+See the [general documentation](./README.md).
+
+### Feature: validation is much easier!
+
+- The schema used for validation can (and should) be passed directly as the second argument of `getItem()`
+- The returned type of `getItem()` is now inferred for basic types (`string`, `number`, `boolean`) and arrays of basic types (`string[]`, `number[]`, `boolean[]`)
+- Just use the new `JSONSchema` interface, IntelliSense will adjust itself based on the `type` option
+
+See the new [validation guide](./docs/VALIDATION.md).
+
+### Full review
+
+This lib started as a little project and is now the first Angular library used for local storage.
+It was time to do a full review and refactoring, which results in:
+
+- Better error management (see [README](./README.md#errors))
+- Better documentation
+- Better overall code (= easier to contribute)
+
+### Other features
+
+- `indexedDB` database and object store names default values are exported and can be changed
+(see the [interoperability guide](./docs/INTEROPERABILITY.md))
+- When trying to store `null` or `undefined`, `removeItem()` instead of just bypassing (meaning the old value was kept)
+
+### Breaking changes
+
+- **`type` now required for array, object, const and enum validation schemas**
+- `JSONSchemaNull` removed (useless, `null` doesn't require any validation)
+- `JSONSchema` no longer accepts extra properties
+- `getUnsafeItem()` is removed (was already deprecated in v7)
+
+### Future breaking changes
+
+- `.has()`, `.keys()` and `.size` are deprecated in `LocalStorage`. They will be removed in v9. They moved to the new `StorageMap` service.
+- `JSONSchemaNumeric` deprecated (will be removed in v9)
+- `LSGetItemsOptions` deprecated (not necessary anymore, will be removed in v9)
+- `LOCAL_STORAGE_PREFIX`, `LocalStorageProvidersConfig` and `localStorageProviders()` deprecated (will be removed in v9). Moved to `StorageModule.forRoot()`
+- `setItemSubscribe()`, `removeItemSubscribe()` and `clearSubscribe()` deprecated (will be removed in v9)
+
+### Reduced public API
+
+Should not concern you as it was internal stuff.
+
+- `IndexedDBDatabase` and `LocalStorageDatabase` not exported anymore
+- `MockLocalDatabase` renamed and not exported anymore
 
 ## 7.4.1 (2019-01-27) / 5.3.6 and 6.2.3 and 7.4.2 (2019-02-25)
 
@@ -27,6 +78,8 @@ This will be an important release so **beta testers are very welcomed.**
 - `has()` and `keys()` now work in Edge/IE too
 (fixes [#69](https://github.com/cyrilletuzi/angular-async-local-storage/issues/69))
 
+Do *not* use: it's deprecated in v8.
+
 ## 7.3.0 (2019-01-03)
 
 ### Feature
@@ -59,6 +112,8 @@ This will be an important release so **beta testers are very welcomed.**
 
 In v7.2, `has()` and `keys()` were not supported in Internet Explorer and Edge. Update to v7.4.
 
+Do *not* use: it's deprecated in v8.
+
 See [documentation](./docs/MAP_OPERATIONS.md).
 
 ### Breaking change (from v7.1 only)
@@ -87,7 +142,7 @@ These releases have been **deprecated** due to a critical regression.
   - `JSONSchemaConst`
   - `JSONSchemaEnum`
   - `JSONSchemaString`
-  - `JSONSchemaNumeric`
+  - `JSONSchemaNumeric` (deprecated in v8)
   - `JSONSchemaBoolean`
   - `JSONSchemaArray`
   - `JSONSchemaObject`
@@ -133,8 +188,6 @@ Validation of data is now required when using `getItem()`:
 
 - New JSON Schema validation options supported (see [#18](https://github.com/cyrilletuzi/angular-async-local-storage/issues/18) for the full list).
 
-- `setItemSubscribe()`, `removeItemSubscribe()`, `clearSubscribe()` methods for auto-subscription
-
 - `localStorageProviders({ prefix: 'myapp' })` to avoid collision in multiple apps on same subdomain 
 
 ### Breaking changes
@@ -206,12 +259,6 @@ If you want to keep your previous data, double the prefix, for example: `localSt
 
 - `localStorageProviders({ prefix: 'myapp' })` to avoid collision in multiple apps on same subdomain
 
-## 5.2.0 (2018-04-08)
-
-### Feature
-
-- `setItemSubscribe()`, `removeItemSubscribe()`, `clearSubscribe()` methods for auto-subscription
-
 ## 5.1.1 (2018-04-07)
 
 ### Bug fix

MIGRATION.md

@@ -3,6 +3,7 @@
 - [Migration from the old `angular-async-local-storage` package to `@ngx-pwa/local-storage`](./docs/MIGRATION_TO_NEW_PACKAGE.md)
 - [Migration to version 6](./docs/MIGRATION_TO_V6.md)
 - [Migration to version 7](./docs/MIGRATION_TO_V7.md)
+- [Migration to version 8](./docs/MIGRATION_TO_V8.md)
 
 [Full changelog available here.](./CHANGELOG.md)