ngx-ui-tour-console - npm Package Compare versions

Comparing version 7.0.2 to 8.0.0

CHANGELOG.md

@@ -0,1 +1,14 @@
+<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>
@@ -2,0 +15,0 @@

lib/console.module.d.ts

 import { ModuleWithProviders } from '@angular/core';
 import { TourService } from 'ngx-ui-tour-core';
 import { TourAnchorConsoleDirective } from './tour-anchor.directive';
+import * as i0 from "@angular/core";
+import * as i1 from "./tour-anchor.directive";
+import * as i2 from "ngx-ui-tour-core";
+import * as i3 from "@angular/common";
+import * as i4 from "@ng-bootstrap/ng-bootstrap";
 export { TourAnchorConsoleDirective, TourService };
 export declare class TourConsoleModule {
     static forRoot(): ModuleWithProviders<TourConsoleModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TourConsoleModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<TourConsoleModule, [typeof i1.TourAnchorConsoleDirective], [typeof i2.TourModule, typeof i3.CommonModule, typeof i4.NgbPopoverModule], [typeof i1.TourAnchorConsoleDirective, typeof i2.TourHotkeyListenerComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<TourConsoleModule>;
 }

lib/tour-anchor.directive.d.ts

 import { TourAnchorDirective, TourService, IStepOption, TourBackdropService } from 'ngx-ui-tour-core';
 import { ElementRef, OnDestroy, OnInit } from '@angular/core';
+import * as i0 from "@angular/core";
 export declare class TourAnchorConsoleDirective implements OnInit, OnDestroy, TourAnchorDirective {
@@ -14,2 +15,4 @@ private tourService;
     hideTourStep(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TourAnchorConsoleDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<TourAnchorConsoleDirective, "[tourAnchor]", never, { "tourAnchor": "tourAnchor"; }, {}, never>;
 }

ngx-ui-tour-console.d.ts

 /**
  * Generated bundle index. Do not edit.
  */
+/// <amd-module name="ngx-ui-tour-console" />
 export * from './public_api';

package.json

 {
   "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 <[e-mail]>",
   "license": "MIT",
-  "description": "UI tour library for Angular 9+",
+  "description": "UI tour library for Angular 12+",
   "keywords": [
@@ -18,18 +18,30 @@ "angular",
   "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"
   },
-  "main": "bundles/ngx-ui-tour-console.umd.js",
-  "module": "fesm2015/ngx-ui-tour-console.js",
-  "es2015": "fesm2015/ngx-ui-tour-console.js",
-  "esm2015": "esm2015/ngx-ui-tour-console.js",
-  "fesm2015": "fesm2015/ngx-ui-tour-console.js",
+  "module": "fesm2015/ngx-ui-tour-console.mjs",
+  "es2020": "fesm2020/ngx-ui-tour-console.mjs",
+  "esm2020": "esm2020/ngx-ui-tour-console.mjs",
+  "fesm2020": "fesm2020/ngx-ui-tour-console.mjs",
+  "fesm2015": "fesm2015/ngx-ui-tour-console.mjs",
   "typings": "ngx-ui-tour-console.d.ts",
-  "metadata": "ngx-ui-tour-console.metadata.json",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./ngx-ui-tour-console.d.ts",
+      "esm2020": "./esm2020/ngx-ui-tour-console.mjs",
+      "es2020": "./fesm2020/ngx-ui-tour-console.mjs",
+      "es2015": "./fesm2015/ngx-ui-tour-console.mjs",
+      "node": "./fesm2015/ngx-ui-tour-console.mjs",
+      "default": "./fesm2020/ngx-ui-tour-console.mjs"
+    }
+  },
   "sideEffects": false
 }

README.md

@@ -19,2 +19,3 @@ ![Ngx UI Tour](https://user-images.githubusercontent.com/768105/130578626-8b6cbefb-217c-4943-8661-22459a7b67a3.png)
 - [Demo and documentation](#demo-and-documentation)
+- [Compatibility](#compatibility)
 - [Installation](#installation)
@@ -38,2 +39,14 @@ - [Usage](#usage)
 
+## 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
@@ -44,5 +57,2 @@
 ```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)
@@ -55,5 +65,2 @@ yarn add ngx-ui-tour-md-menu
 ```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)
@@ -280,13 +287,13 @@ npm i --save ngx-ui-tour-md-menu
 ```
-| 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  |
 
@@ -293,0 +300,0 @@ ## Custom template

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

54442

6.51%

Lines of code

317

7.46%

Number of lines in readme file

350

2.04%

Worsened metrics

Number of package files

16

-5.88%

Number of medium supply chain risk alerts

1

Infinity%

Dependency changes

• + Added

  ngx-ui-tour-core@8.0.0

• + Added

  @angular/common@13.4.0
  (transitive)

• + Added

  @angular/core@13.4.0
  (transitive)

• + Added

  @angular/platform-browser@13.4.0
  (transitive)

• + Added

  @angular/router@13.4.0
  (transitive)

• + Added

  ngx-ui-tour-core@8.0.0
  (transitive)

• - Removed

  @angular/common@12.2.17
  (transitive)

• - Removed

  @angular/core@12.2.17
  (transitive)

• - Removed

  @angular/platform-browser@12.2.17
  (transitive)

• - Removed

  @angular/router@12.2.17
  (transitive)

• - Removed

  ngx-ui-tour-core@7.0.2
  (transitive)

• - Removed

  rxjs@6.6.7
  (transitive)

• - Removed

  tslib@1.14.1
  (transitive)