Merge pull request #172 from cyrilletuzi/v9beta

V9

Author: cyrilletuzi

.github/workflows/main.yml

@@ -8,11 +8,11 @@ jobs:
     name: Lint check
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
     - name: Setup Node
       uses: actions/setup-node@v1
       with:
-        node-version: 10
+        node-version: 12
     - name: Install dependencies
       run: npm ci
       env:
@@ -30,11 +30,11 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
     - name: Setup Node
       uses: actions/setup-node@v1
       with:
-        node-version: 10
+        node-version: 12
     - name: Install dependencies
       run: npm ci
       env:
@@ -58,25 +58,25 @@ jobs:
       run: npm run test:ivy
       if: matrix.os == 'ubuntu-latest'
 
-  test-backward:
+  test-next:
 
-    name: Test with Angular@8.0 (and [email protected] and [email protected])
+    name: Test with Angular@next
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
     - name: Setup Node
       uses: actions/setup-node@v1
       with:
-        node-version: 10.9
+        node-version: 12
     - name: Install dependencies
       run: npm ci
       env:
         CI: true
     - name: Build the lib (with the current version, as it is what is published on npm)
       run: npm run build
     - name: Update dependencies to next version
-      run: npm install [email protected] [email protected] [email protected] @angular/common@8.0.0 @angular/compiler@8.0.0 @angular/core@8.0.0 @angular/platform-browser@8.0.0 @angular/platform-browser-dynamic@8.0.0 @angular/router@8.0.0 @angular/cli@8.0.1 @angular/compiler-cli@8.0.0 @angular-devkit/build-angular@0.800.1 @angular-devkit/build-ng-packagr@0.800.1
+      run: npm install @angular/common@next @angular/compiler@next @angular/core@next @angular/platform-browser@next @angular/platform-browser-dynamic@next @angular/router@next @angular/cli@next @angular/compiler-cli@next @angular-devkit/build-angular@next @angular-devkit/build-ng-packagr@next
       env:
         CI: true
     - name: Run unit tests
@@ -89,3 +89,39 @@ jobs:
       run: npm run test:e2e:demo
     - name: Run interoperability e2e tests
       run: npm run test:e2e:interoperability
+    - name: Run Ivy e2e tests
+      run: npm run test:ivy
+
+  test-minimum:
+
+    name: Test with [email protected] and minimum dependencies requirements
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup Node
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12
+    - name: Install dependencies
+      run: npm ci
+      env:
+        CI: true
+    - name: Build the lib (with the current version, as it is what is published on npm)
+      run: npm run build
+    - name: Downgrade dependencies to minimal required version
+      run: npm install [email protected] [email protected] [email protected] [email protected]
+      env:
+        CI: true
+    - name: Run unit tests
+      run: npm run test:unit:ubuntu-latest
+    - name: Run unit tests in private mode
+      run: npm run test:unit:ubuntu-latest:private
+    - name: Install matching webdriver version
+      run: ./node_modules/.bin/webdriver-manager update --versions.chrome 78.0.3904.70
+    - name: Run general e2e tests
+      run: npm run test:e2e:demo
+    - name: Run interoperability e2e tests
+      run: npm run test:e2e:interoperability
+    - name: Run Ivy e2e tests
+      run: npm run test:ivy

CHANGELOG.md

@@ -2,18 +2,11 @@
 
 This lib is fully documented and so you'll find detailed [migration guides](./MIGRATION.md).
 
-## 8.2.4 (2020-01-13)
-
-No code change, just a release built with last Angular 8.
-Probably the last before Angular 9.
-
-Also, documentation about [sponsorship](https://github.com/sponsors/cyrilletuzi).
-
-## 9.0.0-rc.1 (2019-11-08)
+## 9.0.0 (2020-02-07)
 
-To update: `ng update @ngx-pwa/local-storage@next`
+To update: `ng update @ngx-pwa/local-storage`
 
-A [full migration guide to version 9](https://github.com/cyrilletuzi/angular-async-local-storage/blob/v9beta/docs/MIGRATION_TO_V9.md) is available.
+A [full migration guide to version 9](https://github.com/cyrilletuzi/angular-async-local-storage/blob/master/docs/MIGRATION_TO_V9.md) is available.
 
 ### Angular 9
 
@@ -24,12 +17,12 @@ v9 requires Angular 9.
 Doing `ng update` should have managed backward compatibility.
 But it's not easy to be sure schematics work in all cases,
 so **be sure to check the migration was done correctly** by following the
-[migration guide to v9](https://github.com/cyrilletuzi/angular-async-local-storage/blob/v9beta/docs/MIGRATION_TO_V9.md), **otherwise you would lost previously stored data**.
+[migration guide to v9](https://github.com/cyrilletuzi/angular-async-local-storage/blob/master/docs/MIGRATION_TO_V9.md), **otherwise you would lost previously stored data**.
 
 ### Feature
 
 - New `.watch()` method on `StorageMap` service
-(see [#108](https://github.com/cyrilletuzi/angular-async-local-storage/pull/108/))
+(see [documentation](https://github.com/cyrilletuzi/angular-async-local-storage/blob/master/docs/WATCHING.md))
 
 ### Breaking changes: removal of deprecated features
 
@@ -51,6 +44,13 @@ Please follow the [migration guide to v8](./docs/MIGRATION_TO_V8.md) for more de
   - `.removeItemSubscribe()` (use `.removeItem().subscribe()` instead)
   - `.clearSubscribe()` (use `.clear().subscribe()` instead)
 
+## 8.2.4 (2020-01-13)
+
+No code change, just a release built with last Angular 8.
+Probably the last before Angular 9.
+
+Also, documentation about [sponsorship](https://github.com/sponsors/cyrilletuzi).
+
 ## 8.2.3 (2019-09-27)
 
 ### Bug fix

LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2016-2019 Cyrille Tuzi
+Copyright (c) 2016-2020 Cyrille Tuzi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MIGRATION.md

@@ -1,8 +1,9 @@
 # Migration guides
 
 - [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 6](./docs/MIGRATION_TO_V6.md) (for Angular 6 & 7)
 - [Migration to version 8](./docs/MIGRATION_TO_V8.md)
+- [Migration to version 9](./docs/MIGRATION_TO_V9.md)
 
 [Full changelog available here.](./CHANGELOG.md)
 

README.md

@@ -58,7 +58,7 @@ to be homogeneous with other Angular modules.
 Install the package, according to your Angular version:
 
 ```bash
-# For Angular 8:
+# For Angular 8 & 9:
 ng add @ngx-pwa/local-storage
 
 # For Angular 6 & 7:
@@ -69,7 +69,7 @@ npm install @ngx-pwa/local-storage@6
 
 You should **stick to these commands**. If for any reason `ng add` does not work,
 be sure to follow the [manual installation guide](./docs/MANUAL_INSTALLATION.md),
-as there are additionnal steps to do in addition to the package installation.
+as there are additionnal steps to do in addition to the package installation for some versions.
 
 For version >= 8, if you have multiple applications in the same project, as usual, you need to choose the project:
 ```bash
@@ -203,11 +203,8 @@ this.storage.get('notexisting').subscribe((data) => {
 ```
 
 Note you'll only get *one* value: the `Observable` is here for asynchrony but is not meant to
-emit again when the stored data is changed. And it's normal: if app data change, it's the role of your app
-to keep track of it, not of this lib. See [#16](https://github.com/cyrilletuzi/angular-async-local-storage/issues/16) 
-for more context and [#4](https://github.com/cyrilletuzi/angular-async-local-storage/issues/4)
-for an example. A `watch()` method may come soon
-(see [#108](https://github.com/cyrilletuzi/angular-async-local-storage/pull/108))
+emit again when the stored data is changed. If you need to watch the value,
+version 9 introduced a `watch()` method, see the [watching guide](./docs/WATCHING.md).
 
 ### Checking data
 
@@ -276,7 +273,7 @@ For example, it allows to implement a multiple databases scenario.
 ### Angular support
 
 We follow [Angular LTS support](https://angular.io/guide/releases),
-meaning we support Angular >= 6, until November 2019.
+meaning we support Angular >= 7, until April 2020.
 
 This module supports [AoT pre-compiling](https://angular.io/guide/aot-compiler) and Ivy.
 

angular.json

@@ -17,7 +17,8 @@
           },
           "configurations": {
             "production": {
-              "project": "projects/ngx-pwa/local-storage/ng-package.prod.json"
+              "project": "projects/ngx-pwa/local-storage/ng-package.prod.json",
+              "tsConfig": "projects/ngx-pwa/local-storage/tsconfig.lib.prod.json"
             }
           }
         },
@@ -85,7 +86,6 @@
               "sourceMap": false,
               "extractCss": true,
               "namedChunks": false,
-              "aot": true,
               "extractLicenses": true,
               "vendorChunk": false,
               "buildOptimizer": true,
@@ -94,6 +94,10 @@
                   "type": "initial",
                   "maximumWarning": "2mb",
                   "maximumError": "5mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "6kb"
                 }
               ]
             }
@@ -189,7 +193,6 @@
               "sourceMap": false,
               "extractCss": true,
               "namedChunks": false,
-              "aot": true,
               "extractLicenses": true,
               "vendorChunk": false,
               "buildOptimizer": true,
@@ -198,6 +201,10 @@
                   "type": "initial",
                   "maximumWarning": "2mb",
                   "maximumError": "5mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "6kb"
                 }
               ]
             }
@@ -306,7 +313,6 @@
               "sourceMap": false,
               "extractCss": true,
               "namedChunks": false,
-              "aot": true,
               "extractLicenses": true,
               "vendorChunk": false,
               "buildOptimizer": true,
@@ -315,6 +321,10 @@
                   "type": "initial",
                   "maximumWarning": "2mb",
                   "maximumError": "5mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "6kb"
                 }
               ]
             }
@@ -423,7 +433,6 @@
               "sourceMap": false,
               "extractCss": true,
               "namedChunks": false,
-              "aot": true,
               "extractLicenses": true,
               "vendorChunk": false,
               "buildOptimizer": true,
@@ -432,6 +441,10 @@
                   "type": "initial",
                   "maximumWarning": "2mb",
                   "maximumError": "5mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "6kb"
                 }
               ]
             }

browserslist

@@ -0,0 +1,16 @@
+# This file is used by the build system to adjust CSS and JS output to support the specified browsers below.
+# For additional information regarding the format and rule options, please see:
+# https://github.com/browserslist/browserslist#queries
+
+# You can see what browsers were selected by your queries by running:
+#   npx browserslist
+
+# Googlebot uses an older version of Chrome
+# For additional information see: https://developers.google.com/search/docs/guides/rendering
+
+> 0.5%
+last 2 versions
+Firefox ESR
+Chrome 41 # Support for Googlebot
+not dead
+IE 9-11 # For IE 9-11 support, remove 'not'.

docs/INTEROPERABILITY.md

@@ -16,11 +16,11 @@ as there are important things to do and to be aware of to achieve interoperabili
 
 ## Requirements
 
-Interoperability can be achieved:
-- **since v8 of this lib**,
-- **only for apps that haven't been deployed in production yet**,
-as v8 uses the following opt-in option to allow interoperability:
-changing configuration on the fly would mean to **lose all previously stored data**.
+Interoperability can be achieved **since v8 of this lib**.
+
+In versions >= 9, no requirement, the new configuration is now the default.
+
+In version 8, you need to add this config:
 
 ```ts
 import { StorageModule } from '@ngx-pwa/local-storage';
@@ -54,7 +54,7 @@ import { StorageModule } from '@ngx-pwa/local-storage';
 @NgModule({
   imports: [
     StorageModule.forRoot({
-      IDBNoWrap: true,
+      IDBNoWrap: true, // Not required in versions >= 9
       IDBDBName: 'customDataBaseName',
       IDBStoreName: 'customStoreName',
     })
@@ -93,6 +93,7 @@ import { StorageModule } from '@ngx-pwa/local-storage';
 @NgModule({
   imports: [
     StorageModule.forRoot({
+      IDBNoWrap: true, // Not required in versions >= 9
       LSPrefix: 'myapp_',
     })
   ]
@@ -118,7 +119,7 @@ import { StorageModule } from '@ngx-pwa/local-storage';
 @NgModule({
   imports: [
     StorageModule.forRoot({
-      IDBNoWrap: true,
+      IDBNoWrap: true, // Not required in versions >= 9
       LSPrefix: 'localforage/',
       IDBDBName: 'localforage',
       IDBStoreName: 'keyvaluepairs',