Merge pull request #1022 from cyrilletuzi:v20

Angular 20

Author: cyrilletuzi

.github/workflows/main.yml

@@ -37,7 +37,7 @@ jobs:
 
   test-minimum:
 
-    name: Test with Angular@19.0.0 and minimum dependencies requirements
+    name: Test with Angular@20.0.0 and minimum dependencies requirements
     runs-on: ubuntu-latest
     timeout-minutes: 10
 
@@ -46,15 +46,15 @@ jobs:
     - name: Setup Node
       uses: actions/setup-node@v3
       with:
-        node-version: '18'
+        node-version: '20.19'
     - 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 typescript@5.6.3 [email protected] better-typescript-lib@2.9.0 [email protected] [email protected] @angular/common@19.0.0 @angular/compiler@19.0.0 @angular/core@19.0.0 @angular/platform-browser@19.0.0 @angular/router@19.0.0 @angular/cli@19.0.0 @angular/compiler-cli@19.0.0 @angular-devkit/build-angular@19.0.0 --legacy-peer-deps
+      run: npm install typescript@5.8.2 [email protected] better-typescript-lib@2.11.0 [email protected] [email protected] @angular/common@20.0.0 @angular/compiler@20.0.0 @angular/core@20.0.0 @angular/platform-browser@20.0.0 @angular/router@20.0.0 @angular/cli@20.0.0 @angular/compiler-cli@20.0.0 @angular/build@20.0.0 --legacy-peer-deps
       env:
         CI: true
     - name: Run unit tests

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 This library is fully documented and so you will find detailed [migration guides](https://github.com/cyrilletuzi/angular-async-local-storage/blob/main/MIGRATION.md).
 
+## 20.0.0 (2025-05-29)
+
+### Breaking changes
+
+- Angular 20 is required.
+
 ## 19.0.0 (2024-11-19)
 
 ### Breaking changes

LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2016-2024 Cyrille Tuzi
+Copyright (c) 2016-2025 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

@@ -13,6 +13,7 @@
 - [Migration to version 17](./docs/MIGRATION_TO_V17.md)
 - [Migration to version 18](./docs/MIGRATION_TO_V18.md)
 - [Migration to version 19](./docs/MIGRATION_TO_V19.md)
+- [Migration to version 19](./docs/MIGRATION_TO_V20.md)
 
 [Full changelog available here.](./CHANGELOG.md)
 

README.md

@@ -28,7 +28,7 @@ This library has a simple API similar to native `localStorage`, but internally s
 Install the package:
 
 ```bash
-# For Angular LTS (Angular >= 17):
+# For Angular LTS (Angular >= 18):
 ng add @ngx-pwa/local-storage
 ```
 
@@ -37,7 +37,7 @@ ng add @ngx-pwa/local-storage
 If for any reason `ng add` does not work, follow the [manual installation guide](https://github.com/cyrilletuzi/angular-async-local-storage/blob/main/docs/MANUAL_INSTALLATION.md).
 
 > [!NOTE]
-> Angular versions <= 15 are [officially outdated](https://angular.dev/reference/versions).
+> Angular versions <= 17 are [officially outdated](https://angular.dev/reference/versions).
 
 ### Upgrading
 

angular.json

@@ -11,9 +11,6 @@
       "architect": {
         "build": {
           "builder": "@angular/build:ng-packagr",
-          "options": {
-            "project": "lib/ng-package.json"
-          },
           "configurations": {
             "production": {
               "tsConfig": "lib/tsconfig.lib.prod.json"
@@ -40,8 +37,8 @@
           "builder": "@angular-eslint/builder:lint",
           "options": {
             "lintFilePatterns": [
-              "lib/**/*.ts",
-              "lib/**/*.html"
+              "lib/src/**/*.ts",
+              "lib/src/**/*.html"
             ]
           }
         }
@@ -56,16 +53,13 @@
         "build": {
           "builder": "@angular/build:application",
           "options": {
-            "outputPath": "dist/demo",
-            "index": "testing-apps/demo/src/index.html",
             "browser": "testing-apps/demo/src/main.ts",
             "polyfills": [
               "zone.js"
             ],
             "tsConfig": "testing-apps/demo/tsconfig.app.json",
             "assets": [],
-            "styles": [],
-            "scripts": []
+            "styles": []
           },
           "configurations": {
             "production": {
@@ -117,16 +111,13 @@
         "build": {
           "builder": "@angular/build:application",
           "options": {
-            "outputPath": "dist/iframe",
-            "index": "testing-apps/iframe/src/index.html",
             "browser": "testing-apps/iframe/src/main.ts",
             "polyfills": [
               "zone.js"
             ],
             "tsConfig": "testing-apps/iframe/tsconfig.app.json",
             "assets": [],
-            "styles": [],
-            "scripts": []
+            "styles": []
           },
           "configurations": {
             "production": {
@@ -178,16 +169,13 @@
         "build": {
           "builder": "@angular/build:application",
           "options": {
-            "outputPath": "dist/localforage",
-            "index": "testing-apps/localforage/src/index.html",
             "browser": "testing-apps/localforage/src/main.ts",
             "polyfills": [
               "zone.js"
             ],
             "tsConfig": "testing-apps/localforage/tsconfig.app.json",
             "assets": [],
-            "styles": [],
-            "scripts": []
+            "styles": []
           },
           "configurations": {
             "production": {

docs/MANUAL_INSTALLATION.md

@@ -15,17 +15,17 @@ If it causes an error, please file an issue. In the meantime, you can proceed to
 Install the right version according to your Angular one via [`npm`](http://npmjs.com):
 
 ```bash
+# For Angular 20:
+npm install @ngx-pwa/local-storage@^20.0.0
+
 # For Angular 19:
 npm install @ngx-pwa/local-storage@^19.0.0
 
 # For Angular 18:
 npm install @ngx-pwa/local-storage@^18.0.0
-
-# For Angular 17:
-npm install @ngx-pwa/local-storage@^17.0.0
 ```
 
 > [!NOTE]
-> Angular versions <= 16 are [officially outdated](https://angular.dev/reference/versions).
+> Angular versions <= 17 are [officially outdated](https://angular.dev/reference/versions).
 
 [Back to general documentation](../README.md)

docs/MIGRATION_TO_NEW_PACKAGE.md

@@ -14,9 +14,10 @@ But **do not worry: the previous package is still here** and will be as long as
 - v16 for Angular 16,
 - v17 for Angular 17,
 - v18 for Angular 18,
-- v19 for Angular 19.
+- v19 for Angular 19,
+- v20 for Angular 20.
 
-[Angular <= 15 are officially outdated](https://angular.dev/reference/versions#actively-supported-versions).
+[Angular <= 17 are officially outdated](https://angular.dev/reference/versions#actively-supported-versions).
 
 ## Installing the new package
 

docs/MIGRATION_TO_V19.md

@@ -17,6 +17,8 @@ ng update @ngx-pwa/local-storage
 > [!IMPORTANT]
 > RxJS 6 is *not* supported.
 
+Done, no code changes.
+
 ## More documentation
 
 - [Full changelog for v19](../CHANGELOG.md)

docs/MIGRATION_TO_V20.md

@@ -0,0 +1,26 @@
+# Migration guide to version 20
+
+## How to update
+
+```bash
+ng update @ngx-pwa/local-storage
+```
+
+> [!IMPORTANT]
+> If your project is actually in a version < 19, please do the [other migrations](../MIGRATION.md) first in an incremental way. **The version 9 migration is especially important**, as a wrongly done migration could lead to the loss of all previously stored data.
+
+## Breaking changes
+
+- Angular 20 is required.
+- RxJS >= 7.6 is required.
+
+> [!IMPORTANT]
+> RxJS 6 is *not* supported.
+
+Done, no code changes.
+
+## More documentation
+
+- [Full changelog for v20](../CHANGELOG.md)
+- [Other migration guides](../MIGRATION.md)
+- [Main documentation](../README.md)