Release v8.0.0 (#39)

hakimio · Jan 28, 2022 · 1dcf68a · 1dcf68a
1 parent eb692fb
commit 1dcf68a
Show file tree

Hide file tree

Showing 34 changed files with 197 additions and 82 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,7 @@ maintained.
 ## Table of contents
 
 - [Demo and documentation](#demo-and-documentation)
+- [Compatibility](#compatibility)
 - [Installation](#installation)
 - [Usage](#usage)
   - [Simple project](#simple-project)
@@ -34,24 +35,30 @@ maintained.
 
 Demo and documentation can be found at [hakimio.github.io/ngx-ui-tour](https://hakimio.github.io/ngx-ui-tour)
 
+## Compatibility
+
+### Angular and RxJS versions
+
+Since libraries built with Angular Ivy partial compilation mode can only be used with Angular v12 or higher, 
+ngx-ui-tour v8 no longer supports older Angular versions.
+
+| Angular | RxJS | ngx-ui-tour |
+|---------|------|-------------|
+| 12-13   | 6, 7 | 8           |
+| 9-12    | 6    | 7           |
+
 ## Installation
 
 ### yarn
 
 ```bash
-# install the core package
-yarn add ngx-ui-tour-core
-
 # install one of the UI packages (ngx-ui-tour-md-menu, ngx-ui-tour-ng-bootstrap, ngx-ui-tour-ngx-bootstrap, ngx-ui-tour-tui-dropdown, ngx-ui-tour-tui-hint)
 yarn add ngx-ui-tour-md-menu
 ```
 
 ### npm
 
 ```bash
-# install the core package
-npm i --save ngx-ui-tour-core
-
 # install one of the UI packages (ngx-ui-tour-md-menu, ngx-ui-tour-ng-bootstrap, ngx-ui-tour-ngx-bootstrap, ngx-ui-tour-tui-dropdown, ngx-ui-tour-tui-hint)
 npm i --save ngx-ui-tour-md-menu
 ```
@@ -273,17 +280,17 @@ this.tourService.initialize$.subscribe((steps: IStepOption[]) => {
     console.log('tour configured with these steps:', steps);
 });
 ```
-| Name	| Payload	| Emitted When
-| :-----: |:-------------:|:-------------:|
-| **stepShow$** |	IStepOption	| A step is shown |
-| **stepHide$** |	IStepOption |	A step is hidden |
-| **initialize$**	| IStepOption[]	| The tour is configured with a set of steps
-| **start$**	| void |	The tour begins
-| **end$** |	void |	The tour ends
-| **pause$** |	void |	The tour is paused
-| **resume$** |	void |	The tour resumes
-| **anchorRegister$** |	string |	An anchor is registered with the tour
-| **anchorUnregister$** |	string |	An anchor is unregistered from the tour
+|         Name	         |    Payload	    |                Emitted When                |
+|:---------------------:|:--------------:|:------------------------------------------:|
+|     **stepShow$**     | 	IStepOption	  |              A step is shown               |
+|     **stepHide$**     |  	IStepOption  |             	A step is hidden              |
+|   **initialize$**	    | IStepOption[]	 | The tour is configured with a set of steps |
+|      **start$**	      |      void      |              	The tour begins              |
+|       **end$**        |     	void      |               	The tour ends               |
+|      **pause$**       |     	void      |            	The tour is paused             |
+|      **resume$**      |     	void      |             	The tour resumes              |
+|  **anchorRegister$**  |    	string     |   	An anchor is registered with the tour   |
+| **anchorUnregister$** |    	string     |  	An anchor is unregistered from the tour  |
 
 ## Custom template
 You can also customize the tour step template by providing an `<ng-template let-step="step">` inside the 

diff --git a/projects/ngx-ui-tour-console/CHANGELOG.md b/projects/ngx-ui-tour-console/CHANGELOG.md
@@ -1,3 +1,16 @@
+<a name="8.0.0"></a>
+
+# [8.0.0](https://github.com/hakimio/ngx-ui-tour) (2022-01-28)
+
+### Features
+
+- Support Angular 13 and RxJS v7
+- "Ivy" partial compilation mode
+- "ngx-ui-tour-core" is now a "hard" dependency and doesn't need to be installed separately
+
+### Breaking changes
+- Due to "Ivy" partial compilation mode, Angular versions below v12 are no longer supported
+
 <a name="7.0.2"></a>
 
 # [7.0.2](https://github.com/hakimio/ngx-ui-tour) (2021-09-23)

diff --git a/projects/ngx-ui-tour-console/README.md b/projects/ngx-ui-tour-console/README.md
@@ -2,7 +2,7 @@
 
 ## About
 
-Ui tour library for Angular 9+.
+Ui tour library for Angular 12+.
 
 This is a fork of __Isaac Mann's__ `ngx-tour` library. The fork was created because the original is no longer maintained,
 and I don't have permissions to publish new npm packages.

diff --git a/projects/ngx-ui-tour-console/ng-package.prod.json b/projects/ngx-ui-tour-console/ng-package.prod.json
@@ -3,5 +3,8 @@
   "dest": "../../dist/ngx-ui-tour-console",
   "lib": {
     "entryFile": "src/public_api.ts"
-  }
+  },
+  "allowedNonPeerDependencies": [
+    "ngx-ui-tour-core"
+  ]
 }
diff --git a/projects/ngx-ui-tour-console/package.json b/projects/ngx-ui-tour-console/package.json
@@ -1,10 +1,10 @@
 {
   "name": "ngx-ui-tour-console",
-  "version": "7.0.2",
+  "version": "8.0.0",
   "repository": "https://github.com/hakimio/ngx-ui-tour.git",
   "author": "Isaac Mann <[email protected]>",
   "license": "MIT",
-  "description": "UI tour library for Angular 9+",
+  "description": "UI tour library for Angular 12+",
   "keywords": [
     "angular",
     "ngx",
@@ -15,12 +15,12 @@
     "onboarding-tour"
   ],
   "peerDependencies": {
-    "@angular/common": ">=9.0.0 <13.0.0",
-    "@angular/core": ">=9.0.0 <13.0.0",
-    "ngx-ui-tour-core": "7.0.2",
+    "@angular/common": ">=12.0.0 <14.0.0",
+    "@angular/core": ">=12.0.0 <14.0.0",
     "typescript": ">=3.8.0"
   },
   "dependencies": {
-    "tslib": "^2.0.0"
+    "tslib": "^2.0.0",
+    "ngx-ui-tour-core": "8.0.0"
   }
 }
diff --git a/projects/ngx-ui-tour-core/CHANGELOG.md b/projects/ngx-ui-tour-core/CHANGELOG.md
@@ -1,3 +1,15 @@
+<a name="8.0.0"></a>
+
+# [8.0.0](https://github.com/hakimio/ngx-ui-tour) (2022-01-28)
+
+### Features
+
+- Support Angular 13 and RxJS v7
+- "Ivy" partial compilation mode
+
+### Breaking changes
+- Due to "Ivy" partial compilation mode, Angular versions below v12 are no longer supported
+
 <a name="7.0.2"></a>
 
 # [7.0.2](https://github.com/hakimio/ngx-ui-tour) (2021-09-23)

diff --git a/projects/ngx-ui-tour-core/README.md b/projects/ngx-ui-tour-core/README.md
@@ -2,7 +2,7 @@
 
 ## About
 
-Ui tour library for Angular 9+.
+Ui tour library for Angular 12+.
 
 This is a fork of __Isaac Mann's__ `ngx-tour` library. The fork was created because the original is no longer maintained,
 and I don't have permissions to publish new npm packages.

diff --git a/projects/ngx-ui-tour-core/package.json b/projects/ngx-ui-tour-core/package.json
@@ -1,7 +1,7 @@
 {
   "name": "ngx-ui-tour-core",
-  "version": "7.0.2",
-  "description": "UI tour library for Angular 9+",
+  "version": "8.0.0",
+  "description": "UI tour library for Angular 12+",
   "keywords": [
     "angular",
     "ngx",
@@ -15,10 +15,10 @@
   "author": "Isaac Mann <[email protected]>",
   "license": "MIT",
   "peerDependencies": {
-    "@angular/common": ">=9.0.0 <13.0.0",
-    "@angular/core": ">=9.0.0 <13.0.0",
-    "@angular/router": ">=9.0.0 <13.0.0",
-    "rxjs": "^6.0.0",
+    "@angular/common": ">=12.0.0 <14.0.0",
+    "@angular/core": ">=12.0.0 <14.0.0",
+    "@angular/router": ">=12.0.0 <14.0.0",
+    "rxjs": ">=6.0.0",
     "typescript": ">=3.8.0"
   },
   "dependencies": {

diff --git a/projects/ngx-ui-tour-md-menu/CHANGELOG.md b/projects/ngx-ui-tour-md-menu/CHANGELOG.md
@@ -1,3 +1,16 @@
+<a name="8.0.0"></a>
+
+# [8.0.0](https://github.com/hakimio/ngx-ui-tour) (2022-01-28)
+
+### Features
+
+- Support Angular 13 and RxJS v7
+- "Ivy" partial compilation mode
+- "ngx-ui-tour-core" is now a "hard" dependency and doesn't need to be installed separately
+
+### Breaking changes
+- Due to "Ivy" partial compilation mode, Angular versions below v12 are no longer supported
+
 <a name="7.0.2"></a>
 
 # [7.0.2](https://github.com/hakimio/ngx-ui-tour) (2021-09-23)

diff --git a/projects/ngx-ui-tour-md-menu/README.md b/projects/ngx-ui-tour-md-menu/README.md
@@ -2,7 +2,7 @@
 
 ## About
 
-Ui tour library for Angular 9+.
+Ui tour library for Angular 12+.
 
 This is a fork of __Isaac Mann's__ `ngx-tour` library. The fork was created because the original is no longer maintained,
 and I don't have permissions to publish new npm packages.

diff --git a/projects/ngx-ui-tour-md-menu/ng-package.prod.json b/projects/ngx-ui-tour-md-menu/ng-package.prod.json
@@ -3,5 +3,8 @@
   "dest": "../../dist/ngx-ui-tour-md-menu",
   "lib": {
     "entryFile": "src/public_api.ts"
-  }
+  },
+  "allowedNonPeerDependencies": [
+    "ngx-ui-tour-core"
+  ]
 }
diff --git a/projects/ngx-ui-tour-md-menu/package.json b/projects/ngx-ui-tour-md-menu/package.json
@@ -1,7 +1,7 @@
 {
   "name": "ngx-ui-tour-md-menu",
-  "version": "7.0.2",
-  "description": "UI tour library for Angular 9+",
+  "version": "8.0.0",
+  "description": "UI tour library for Angular 12+",
   "keywords": [
     "angular",
     "ngx",
@@ -18,15 +18,15 @@
   "author": "Isaac Mann <[email protected]>",
   "license": "MIT",
   "dependencies": {
-    "tslib": "^2.0.0"
+    "tslib": "^2.0.0",
+    "ngx-ui-tour-core": "8.0.0"
   },
   "peerDependencies": {
-    "@angular/common": ">=9.0.0 <13.0.0",
-    "@angular/core": ">=9.0.0 <13.0.0",
-    "@angular/animations": ">=9.0.0 <13.0.0",
-    "@angular/cdk": ">=9.0.0 <13.0.0",
-    "@angular/material": ">=9.0.0 <13.0.0",
-    "ngx-ui-tour-core": "7.0.2",
+    "@angular/common": ">=12.0.0 <14.0.0",
+    "@angular/core": ">=12.0.0 <14.0.0",
+    "@angular/animations": ">=12.0.0 <14.0.0",
+    "@angular/cdk": ">=12.0.0 <14.0.0",
+    "@angular/material": ">=12.0.0 <14.0.0",
     "typescript": ">=3.8.0"
   }
 }
diff --git a/projects/ngx-ui-tour-ng-bootstrap/CHANGELOG.md b/projects/ngx-ui-tour-ng-bootstrap/CHANGELOG.md
@@ -1,3 +1,16 @@
+<a name="10.0.0"></a>
+
+# [10.0.0](https://github.com/hakimio/ngx-ui-tour) (2022-01-28)
+
+### Features
+
+- Support Angular 13 and RxJS v7
+- "Ivy" partial compilation mode
+- "ngx-ui-tour-core" is now a "hard" dependency and doesn't need to be installed separately
+
+### Breaking changes
+- Due to "Ivy" partial compilation mode, Angular versions below v12 are no longer supported
+
 <a name="9.0.2"></a>
 
 # [9.0.2](https://github.com/hakimio/ngx-ui-tour) (2021-09-23)

diff --git a/projects/ngx-ui-tour-ng-bootstrap/README.md b/projects/ngx-ui-tour-ng-bootstrap/README.md
@@ -2,7 +2,7 @@
 
 ## About
 
-Ui tour library for Angular 9+.
+Ui tour library for Angular 12+.
 
 This is a fork of __Isaac Mann's__ `ngx-tour` library. The fork was created because the original is no longer maintained,
 and I don't have permissions to publish new npm packages.

diff --git a/projects/ngx-ui-tour-ng-bootstrap/ng-package.prod.json b/projects/ngx-ui-tour-ng-bootstrap/ng-package.prod.json
@@ -3,5 +3,8 @@
   "dest": "../../dist/ngx-ui-tour-ng-bootstrap",
   "lib": {
     "entryFile": "src/public_api.ts"
-  }
+  },
+  "allowedNonPeerDependencies": [
+    "ngx-ui-tour-core"
+  ]
 }
diff --git a/projects/ngx-ui-tour-ng-bootstrap/package.json b/projects/ngx-ui-tour-ng-bootstrap/package.json
@@ -1,7 +1,7 @@
 {
   "name": "ngx-ui-tour-ng-bootstrap",
   "version": "9.0.2",
-  "description": "UI tour library for Angular 9+",
+  "description": "UI tour library for Angular 12+",
   "keywords": [
     "angular",
     "ngx",
@@ -17,13 +17,13 @@
   "author": "Isaac Mann <[email protected]>",
   "license": "MIT",
   "peerDependencies": {
-    "@angular/common": ">=9.0.0 <13.0.0",
-    "@angular/core": ">=9.0.0 <13.0.0",
-    "@ng-bootstrap/ng-bootstrap": ">=7.0.0",
-    "ngx-ui-tour-core": "7.0.2",
+    "@angular/common": ">=12.0.0 <14.0.0",
+    "@angular/core": ">=12.0.0 <14.0.0",
+    "@ng-bootstrap/ng-bootstrap": ">=10.0.0",
     "typescript": ">=3.8.0"
   },
   "dependencies": {
-    "tslib": "^2.0.0"
+    "tslib": "^2.0.0",
+    "ngx-ui-tour-core": "8.0.0"
   }
 }
diff --git a/projects/ngx-ui-tour-ngx-bootstrap/CHANGELOG.md b/projects/ngx-ui-tour-ngx-bootstrap/CHANGELOG.md
@@ -1,3 +1,16 @@
+<a name="8.0.0"></a>
+
+# [8.0.0](https://github.com/hakimio/ngx-ui-tour) (2022-01-28)
+
+### Features
+
+- Support Angular 13 and RxJS v7
+- "Ivy" partial compilation mode
+- "ngx-ui-tour-core" is now a "hard" dependency and doesn't need to be installed separately
+
+### Breaking changes
+- Due to "Ivy" partial compilation mode, Angular versions below v12 are no longer supported
+
 <a name="7.0.2"></a>
 
 # [7.0.2](https://github.com/hakimio/ngx-ui-tour) (2021-09-23)

diff --git a/projects/ngx-ui-tour-ngx-bootstrap/README.md b/projects/ngx-ui-tour-ngx-bootstrap/README.md
@@ -2,7 +2,7 @@
 
 ## About
 
-Ui tour library for Angular 9+.
+Ui tour library for Angular 12+.
 
 This is a fork of __Isaac Mann's__ `ngx-tour` library. The fork was created because the original is no longer maintained,
 and I don't have permissions to publish new npm packages.

diff --git a/projects/ngx-ui-tour-ngx-bootstrap/ng-package.prod.json b/projects/ngx-ui-tour-ngx-bootstrap/ng-package.prod.json
@@ -3,5 +3,8 @@
   "dest": "../../dist/ngx-ui-tour-ngx-bootstrap",
   "lib": {
     "entryFile": "src/public_api.ts"
-  }
+  },
+  "allowedNonPeerDependencies": [
+    "ngx-ui-tour-core"
+  ]
 }
diff --git a/projects/ngx-ui-tour-ngx-bootstrap/package.json b/projects/ngx-ui-tour-ngx-bootstrap/package.json
@@ -1,7 +1,7 @@
 {
   "name": "ngx-ui-tour-ngx-bootstrap",
-  "version": "7.0.2",
-  "description": "UI tour library for Angular 9+",
+  "version": "8.0.0",
+  "description": "UI tour library for Angular 12+",
   "keywords": [
     "angular",
     "ngx",
@@ -17,13 +17,13 @@
   "author": "Isaac Mann <[email protected]>",
   "license": "MIT",
   "peerDependencies": {
-    "@angular/common": ">=9.0.0 <13.0.0",
-    "@angular/core": ">=9.0.0 <13.0.0",
-    "ngx-bootstrap": ">=3.1.0 <8.0.0",
-    "ngx-ui-tour-core": "7.0.2",
+    "@angular/common": ">=12.0.0 <14.0.0",
+    "@angular/core": ">=12.0.0 <14.0.0",
+    "ngx-bootstrap": ">=3.1.0 <9.0.0",
     "typescript": ">=3.8.0"
   },
   "dependencies": {
-    "tslib": "^2.0.0"
+    "tslib": "^2.0.0",
+    "ngx-ui-tour-core": "8.0.0"
   }
 }