@halloverden/ngx-cookiebot - npm Package Compare versions

Comparing version 5.0.0-rc.1 to 5.0.0

package.json

 {
   "name": "@halloverden/ngx-cookiebot",
-  "version": "5.0.0-rc.1",
+  "version": "5.0.0",
   "description": "A simple Angular wrapper for the Cookiebot SDK",
@@ -5,0 +5,0 @@ "private": false,

README.md

@@ -8,3 +8,3 @@ # NgxCookiebot
 | Version | Angular support |
-|---------|:---------------:|
+| ------- | :-------------: |
 | ^5.0.0  |     ^18.0.0     |
@@ -16,2 +16,3 @@ | ^4.0.0  |     ^17.0.0     |
 ## Installation
+
 ```
@@ -24,5 +25,7 @@ npm i @halloverden/ngx-cookiebot -S
 ### Prerequisites
+
 A Cookiebot account.
 
 ### 1. Configure service
+
 Configure the service according to the [Cookiebot developer docs](https://www.cookiebot.com/en/developer/). The package also ships with custom config not defined in the Cookiebot developer docs. See below for deets.
@@ -50,14 +53,18 @@
 ```
+
 #### Custom config
+
 In addition to the config defined in the Cookiebot developer docs, the package also supports this custom config:
 
-##### *cdn*
+##### _cdn_
+
 Choose what version of the cookiebot CDN you want to use (https://support.cookiebot.com/hc/en-us/articles/4530208762396-Cookiebot-CMP-European-CDN-solution):
 
 | Config |          CDN          |
-|--------|:---------------------:|
+| ------ | :-------------------: |
 | com    | consent.cookiebot.com |
 | eu     | consent.cookiebot.eu  |
 
-##### *loadScript*
+##### _loadScript_
+
 The package injects the script in the head tag through Angular. This can lead to high script loading time. If your app is time sensitive, you can opt out of the package setting the script tag, and set it yourself. You can use the module for everything else but the script embedding.
@@ -74,3 +81,3 @@
 
-ngxCookiebotProvider(CookiebotConfig)
+ngxCookiebotProvider(CookiebotConfig);
 ```
@@ -81,2 +88,3 @@
 ### Consent box
+
 The script will now automatically append itself to the `head` tag, which in turn will prompt the cookie consent box.
@@ -101,3 +109,3 @@
 
-Reference the [Cookiebot docs](https://www.cookiebot.com/en/developer/) for a list of properties, methods and callbacks available through the cookiebot object. 
+Reference the [Cookiebot docs](https://www.cookiebot.com/en/developer/) for a list of properties, methods and callbacks available through the cookiebot object.
 
@@ -108,24 +116,25 @@ If you prefer to use observables, the NgxCookiebotService exposes an observable for every available method and callback on the cookiebot object:
 
-| Method                            | Observable            |
-|-----------------------------------|:-------------------------:|
-| CookiebotOnConsentReady           | onConsentReady$           |
-| CookiebotOnLoad                   | onLoad$                   |
-| CookiebotOnAccept                 | onAccept$                 |
-| CookiebotOnDecline                | onDecline$                |
-| CookiebotOnDialogInit             | onDialogInit$             |
-| CookiebotOnDialogDisplay          | onDialogDisplay$          |  
-| CookiebotOnTagsExecuted           | onTagsExecuted$           |
+| Method                   |    Observable    |
+| ------------------------ | :--------------: |
+| CookiebotOnConsentReady  | onConsentReady$  |
+| CookiebotOnLoad          |     onLoad$      |
+| CookiebotOnAccept        |    onAccept$     |
+| CookiebotOnDecline       |    onDecline$    |
+| CookiebotOnDialogInit    |  onDialogInit$   |
+| CookiebotOnDialogDisplay | onDialogDisplay$ |
+| CookiebotOnTagsExecuted  | onTagsExecuted$  |
 
 #### Callbacks
 
-| Callback                          | Observable                |
-|-----------------------------------|:-------------------------:|
-| CookiebotCallback_OnLoad          | onLoadCallback$           |
-| CookiebotCallback_OnAccept        | onAcceptCallback$         |
-| CookiebotCallback_OnDecline       | onDeclineCallback$        |
-| CookiebotCallback_OnDialogInit    | onDialogInitCallback$     |
-| CookiebotCallback_OnDialogDisplay | onDialogDisplayCallback$  |
-| CookiebotCallback_OnTagsExecuted  | onTagsExecutedCallback$   |
+| Callback                          |        Observable        |
+| --------------------------------- | :----------------------: |
+| CookiebotCallback_OnLoad          |     onLoadCallback$      |
+| CookiebotCallback_OnAccept        |    onAcceptCallback$     |
+| CookiebotCallback_OnDecline       |    onDeclineCallback$    |
+| CookiebotCallback_OnDialogInit    |  onDialogInitCallback$   |
+| CookiebotCallback_OnDialogDisplay | onDialogDisplayCallback$ |
+| CookiebotCallback_OnTagsExecuted  | onTagsExecutedCallback$  |
 
 Usage example:
+
 ```typescript
@@ -142,5 +151,6 @@ // whatever.ts
 ### Cookie declaration
-The NgxCookiebot package exposes a component to insert the cookie consent declaration. 
-Use the component where you want the declaration to appear: 
 
+The NgxCookiebot package exposes a component to insert the cookie consent declaration.
+Use the component where you want the declaration to appear:
+
 ```
@@ -153,2 +163,3 @@ // my.component.html
 ## License
+
 MIT © [Hallo Verden](https://github.com/halloverden)

Fixed alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

78447

0.73%

Lines of code

585

3.54%

Number of medium maintenance alerts

0

-100%

Number of low quality alerts

0

-100%

Number of lines in readme file

156

7.59%

No dependency changes