@ambitiondev/cookiebot-common - npm Package Compare versions

Comparing version 3.0.0-alpha.4 to 3.0.0-alpha.5

dist/types/types/cookiebot.d.ts

@@ -9,16 +9,34 @@ import { MaybeRef } from 'vue';
 }
-type BlockingMode = 'auto' | 'none';
-type Level = 'implied' | 'strict';
-type ConsentDialogType = 'optin' | 'optout' | 'optinout' | 'leveloptin' | 'inlineoptin' | 'optionaloptin';
-interface CookiebotOptions {
+export type BlockingMode = 'auto' | 'none';
+export type Level = 'implied' | 'strict';
+export type ConsentDialogType = 'optin' | 'optout' | 'optinout' | 'leveloptin' | 'inlineoptin' | 'optionaloptin';
+export interface CookiebotOptions {
+    /**
+     * Defines if Cookiebot should automatically block all cookies until a user has consented, value: “auto”.
+     * If not, (value: “none”) cookie-setting scripts should manually be marked up as described in our
+     * manual implementation guide. If you omit this attribute, behavior will equal value: “none”.
+     */
     blockingMode: BlockingMode;
+    /**
+     * Allows you to disable Google Consent Mode
+     */
     consentmode: boolean;
+    /**
+     * Sets the language for the Cookiebot implementation
+     */
     culture: string;
+    /**
+     * Overrides the default consent method with one of the following values: “implied”, “strict”
+     */
     level: Level;
+    /**
+     * Overrides the default dialog type with one of the following values:
+     * “optin”, “optout”, “optinout”, “leveloptin”, “inlineoptin”, “optionaloptin”
+     */
     type: ConsentDialogType;
 }
-interface PluginOptions extends Partial<CookiebotOptions> {
+export interface PluginOptions extends Partial<CookiebotOptions> {
     cookieBotId: string;
 }
-interface CookiebotComposable {
+export interface CookiebotComposable {
     /**
@@ -73,2 +91,1 @@ * Create script tag for the consent banner and append it to body
 }
-export { CookiebotComposable, CookiebotOptions, PluginOptions };

package.json

 {
 	"name": "@ambitiondev/cookiebot-common",
-	"version": "3.0.0-alpha.4",
+	"version": "3.0.0-alpha.5",
 	"description": "Common logic for Cookiebot packages",
@@ -46,2 +46,4 @@ "main": "dist/index.cjs.js",
 		"rollup": "^4.9.6",
+		"typedoc": "^0.25.7",
+		"typedoc-plugin-markdown": "^3.17.1",
 		"typescript": "^5.3.3"
@@ -53,3 +55,3 @@ },
 	"prettier": "@netvlies/prettier-config",
-	"gitHead": "b3b31d5cdd9e77061b64fc17f0ac932c4de8ade6"
+	"gitHead": "f8e75ff11d61a9e247a3c3fe818bf2f2ed706fd9"
 }

No alert changes

Improved metrics

Total package byte prevSize

19054

4.61%

Lines of code

200

9.29%

Worsened metrics

Dev dependency count

8

33.33%

No dependency changes