@guardian/consent-management-platform - npm Package Compare versions

Comparing version 1.0.2 to 1.1.0-beta.4

lib/cmp-ui.d.ts

@@ -1,4 +0,1 @@
-declare type Callback = (error?: Error) => void;
-export declare const setupMessageHandlers: (onReadyCmp: Callback, onCloseCmp: Callback, onErrorCmp: Callback) => void;
 export declare const canShow: () => boolean;
-export {};

lib/cmp-ui.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var cookies_1 = require("./cookies");
-var consent_storage_1 = require("./consent-storage");
-var config_1 = require("./config");
-exports.setupMessageHandlers = function (onReadyCmp, onCloseCmp, onErrorCmp) {
-    var receiveMessage = function (event) {
-        var withErrorHandling = function (callback) {
-            try {
-                callback();
-            }
-            catch (e) {
-                onErrorCmp(e);
-            }
-        };
-        var origin = event.origin, data = event.data;
-        if (origin !== config_1.CMP_DOMAIN) {
-            return;
-        }
-        var msgType = data.msgType, msgData = data.msgData;
-        switch (msgType) {
-            case config_1.CMP_READY_MSG:
-                withErrorHandling(onReadyCmp);
-                break;
-            case config_1.CMP_CLOSE_MSG:
-                withErrorHandling(onCloseCmp);
-                break;
-            case config_1.CMP_SAVED_MSG:
-                consent_storage_1.save(msgData)
-                    .then(function (response) {
-                    if (!response.ok) {
-                        throw new Error("Error posting to consent logs: " + response.status + " | " + response.statusText);
-                    }
-                })
-                    .catch(function (error) {
-                    onErrorCmp(error);
-                });
-                break;
-            default:
-                break;
-        }
-    };
-    window.addEventListener('message', receiveMessage, false);
-};
 exports.canShow = function () { return !cookies_1.readIabCookie(); }; // TODO: Restore readGuCookie check once we start saving GU cookie

lib/cmp.js

@@ -13,4 +13,7 @@ "use strict";
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var Cookies = require("js-cookie");
+var js_cookie_1 = __importDefault(require("js-cookie"));
 var consent_string_1 = require("consent-string");
@@ -72,3 +75,3 @@ var config_1 = require("./config");
 var getGuTkStateFromCookie = function () {
-    var cookie = Cookies.get(config_1.GU_AD_CONSENT_COOKIE);
+    var cookie = js_cookie_1.default.get(config_1.GU_AD_CONSENT_COOKIE);
     var iabState = __assign({}, iabPurposeRegister.state);
@@ -75,0 +78,0 @@ var adConsentState = null;

lib/config.d.ts

@@ -21,1 +21,4 @@ import { GuPurposeList } from './types';
 export declare const GU_PURPOSE_LIST: GuPurposeList;
+export declare const SCROLLABLE_ID = "cmpScrollable";
+export declare const CONTENT_ID = "cmpContent";
+export declare const PURPOSES_ID = "cmpPurposes";

lib/config.js

@@ -96,1 +96,4 @@ "use strict";
 };
+exports.SCROLLABLE_ID = 'cmpScrollable';
+exports.CONTENT_ID = 'cmpContent';
+exports.PURPOSES_ID = 'cmpPurposes';

lib/consent-storage.d.ts

@@ -1,2 +0,2 @@
-import { CmpMsgData } from './types';
-export declare const save: ({ iabVendorList, allowedPurposes, allowedVendors, }: CmpMsgData) => Promise<Response>;
+import { ParsedIabVendorList } from './types';
+export declare const save: (iabVendorList: ParsedIabVendorList, allowedPurposes: number[], allowedVendors: number[]) => Promise<Response>;

lib/consent-storage.js

 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var Cookies = require("js-cookie");
+var js_cookie_1 = __importDefault(require("js-cookie"));
 var consent_string_1 = require("consent-string");
@@ -9,4 +12,3 @@ var config_1 = require("./config");
 var DUMMY_BROWSER_ID = "No bwid available";
-exports.save = function (_a) {
-    var iabVendorList = _a.iabVendorList, allowedPurposes = _a.allowedPurposes, allowedVendors = _a.allowedVendors;
+exports.save = function (iabVendorList, allowedPurposes, allowedVendors) {
     var consentData = new consent_string_1.ConsentString();
@@ -32,3 +34,3 @@ consentData.setGlobalVendorList(iabVendorList);
     cookies_1.writeLegacyCookie(pAdvertising);
-    var browserID = Cookies.get('bwid') || DUMMY_BROWSER_ID;
+    var browserID = js_cookie_1.default.get('bwid') || DUMMY_BROWSER_ID;
     if (config_1.isProd && browserID === DUMMY_BROWSER_ID) {
@@ -35,0 +37,0 @@ throw new Error("Error getting browserID in PROD");

lib/cookies.js

 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var Cookies = require("js-cookie");
+// import * as Cookies from 'js-cookie';
+var js_cookie_1 = __importDefault(require("js-cookie"));
 var config_1 = require("./config");
@@ -20,6 +24,6 @@ var getShortDomain = function () {
     };
-    Cookies.set(name, value, options);
+    js_cookie_1.default.set(name, value, options);
 };
 var readGuCookie = function () {
-    var cookie = Cookies.getJSON(config_1.GU_COOKIE_NAME);
+    var cookie = js_cookie_1.default.getJSON(config_1.GU_COOKIE_NAME);
     if (cookie) {
@@ -34,3 +38,3 @@ if (cookie.version === 1) {
 var readIabCookie = function () {
-    var cookie = Cookies.get(config_1.IAB_COOKIE_NAME);
+    var cookie = js_cookie_1.default.get(config_1.IAB_COOKIE_NAME);
     return cookie || null;
@@ -37,0 +41,0 @@ };

lib/index.d.ts

@@ -17,4 +17,3 @@ import * as cookie from './cookies';
 export declare const cmpUi: {
-    setupMessageHandlers: (onReadyCmp: (error?: Error | undefined) => void, onCloseCmp: (error?: Error | undefined) => void, onErrorCmp: (error?: Error | undefined) => void) => void;
     canShow: () => boolean;
 };

lib/index.js

@@ -5,5 +5,12 @@ "use strict";
 }
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 var config_1 = require("./config");
-var cookie = require("./cookies");
+var cookie = __importStar(require("./cookies"));
 var cmp_ui_1 = require("./cmp-ui");
@@ -25,4 +32,3 @@ __export(require("./cmp"));
 exports.cmpUi = {
-    setupMessageHandlers: cmp_ui_1.setupMessageHandlers,
     canShow: cmp_ui_1.canShow,
 };

lib/types.d.ts

@@ -1,6 +0,2 @@
-export declare type CmpMsgData = {
-    iabVendorList: IabVendorList;
-    allowedPurposes: number[];
-    allowedVendors: number[];
-};
+/// <reference types="react" />
 export declare type GuResponsivePurposeEventId = 'functional' | 'performance';
@@ -72,1 +68,7 @@ export declare type GuPurposeEventId = 'essential' | GuResponsivePurposeEventId;
 }
+export interface ParsedIabVendorList extends IabVendorList {
+    vendors: ParsedIabVendor[];
+}
+export interface ParsedIabVendor extends IabVendor {
+    description: React.ReactNode;
+}

package.json

 {
     "name": "@guardian/consent-management-platform",
-    "version": "1.0.2",
+    "version": "1.1.0-beta.4",
     "description": "Library of useful utilities for managing consent state across *.theguardian.com",
@@ -8,6 +8,6 @@ "main": "lib/index.js",
     "scripts": {
-        "build": "yarn clean && tsc",
-        "clean": "rm -f lib/*",
+        "build": "yarn clean && tsc && rollup --config",
+        "clean": "rm -rf lib/*",
         "test": "jest --config jestconfig.json",
-        "lint": "eslint src/**/*.ts",
+        "lint": "eslint src/**/*.ts src/**/*.tsx",
         "tsc": "tsc --noEmit",
@@ -31,8 +31,22 @@ "validate": "yarn tsc && yarn lint && yarn test",
     "dependencies": {
+        "@guardian/src-foundations": "^0.2.3",
         "consent-string": "^1.5.1",
-        "js-cookie": "^2.2.1"
+        "js-cookie": "^2.2.1",
+        "whatwg-fetch": "^3.0.0"
     },
+    "peerDependencies": {
+        "@emotion/core": "^10.0.21",
+        "react": "^16.10.2"
+    },
     "devDependencies": {
+        "@babel/core": "^7.6.4",
+        "@babel/plugin-proposal-class-properties": "^7.5.5",
+        "@babel/preset-env": "^7.6.3",
+        "@babel/preset-react": "^7.6.3",
+        "@babel/preset-typescript": "^7.6.0",
+        "@emotion/babel-preset-css-prop": "^10.0.17",
+        "@emotion/core": "^10.0.21",
         "@types/jest": "^24.0.16",
         "@types/js-cookie": "^2.2.2",
+        "@types/react": "^16.9.9",
         "@typescript-eslint/eslint-plugin": "^2.1.0",
@@ -46,5 +60,11 @@ "@typescript-eslint/parser": "^1.13.0",
         "eslint-plugin-prettier": "^3.1.0",
+        "eslint-plugin-react": "^7.16.0",
         "husky": "^3.0.2",
         "jest": "^24.8.0",
         "prettier": "^1.18.2",
+        "react": "^16.10.2",
+        "rollup": "^1.24.0",
+        "rollup-plugin-babel": "^4.3.3",
+        "rollup-plugin-commonjs": "^10.1.0",
+        "rollup-plugin-node-resolve": "^5.2.0",
         "ts-jest": "^24.0.2",
@@ -51,0 +71,0 @@ "typescript": "^3.5.3"

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

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

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

215052

increased by489.52%

Number of package files

39

increased by129.41%

Lines of code

4344

increased by697.06%

Worsened metrics

Dependency count

6

increased by200%

Dev dependency count

29

increased by93.33%

Number of low quality alerts

1

increased byInfinity%

Number of low supply chain risk alerts

2

increased by100%

Number of medium supply chain risk alerts

4

increased by300%

Dependency changes

• + Added@guardian/src-foundations@^0.2.3

• + Addedwhatwg-fetch@^3.0.0

• + Added@babel/code-frame@7.26.2(transitive)

• + Added@babel/generator@7.26.9(transitive)

• + Added@babel/helper-module-imports@7.25.9(transitive)

• + Added@babel/helper-string-parser@7.25.9(transitive)

• + Added@babel/helper-validator-identifier@7.25.9(transitive)

• + Added@babel/parser@7.26.9(transitive)

• + Added@babel/runtime@7.26.9(transitive)

• + Added@babel/template@7.26.9(transitive)

• + Added@babel/traverse@7.26.9(transitive)

• + Added@babel/types@7.26.9(transitive)

• + Added@emotion/cache@10.0.29(transitive)

• + Added@emotion/core@10.3.1(transitive)

• + Added@emotion/css@10.0.27(transitive)

• + Added@emotion/hash@0.8.0(transitive)

• + Added@emotion/memoize@0.7.4(transitive)

• + Added@emotion/serialize@0.11.16(transitive)

• + Added@emotion/sheet@0.9.4(transitive)

• + Added@emotion/stylis@0.8.5(transitive)

• + Added@emotion/unitless@0.7.5(transitive)

• + Added@emotion/utils@0.11.3(transitive)

• + Added@emotion/weak-memoize@0.2.5(transitive)

• + Added@guardian/src-foundations@0.2.4(transitive)

• + Added@jridgewell/gen-mapping@0.3.8(transitive)

• + Added@jridgewell/resolve-uri@3.1.2(transitive)

• + Added@jridgewell/set-array@1.2.1(transitive)

• + Added@jridgewell/sourcemap-codec@1.5.0(transitive)

• + Added@jridgewell/trace-mapping@0.3.25(transitive)

• + Added@types/parse-json@4.0.2(transitive)

• + Addedbabel-plugin-emotion@10.2.2(transitive)

• + Addedbabel-plugin-macros@2.8.0(transitive)

• + Addedbabel-plugin-syntax-jsx@6.18.0(transitive)

• + Addedcallsites@3.1.0(transitive)

• + Addedconvert-source-map@1.9.0(transitive)

• + Addedcosmiconfig@6.0.0(transitive)

• + Addedcsstype@2.6.21(transitive)

• + Addeddebug@4.4.0(transitive)

• + Addederror-ex@1.3.2(transitive)

• + Addedescape-string-regexp@1.0.5(transitive)

• + Addedfind-root@1.1.0(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedglobals@11.12.0(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedimport-fresh@3.3.1(transitive)

• + Addedis-arrayish@0.2.1(transitive)

• + Addedis-core-module@2.16.1(transitive)

• + Addedjs-tokens@4.0.0(transitive)

• + Addedjsesc@3.1.0(transitive)

• + Addedjson-parse-even-better-errors@2.3.1(transitive)

• + Addedlines-and-columns@1.2.4(transitive)

• + Addedloose-envify@1.4.0(transitive)

• + Addedms@2.1.3(transitive)

• + Addedobject-assign@4.1.1(transitive)

• + Addedparent-module@1.0.1(transitive)

• + Addedparse-json@5.2.0(transitive)

• + Addedpath-parse@1.0.7(transitive)

• + Addedpath-type@4.0.0(transitive)

• + Addedpicocolors@1.1.1(transitive)

• + Addedprop-types@15.8.1(transitive)

• + Addedreact@16.14.0(transitive)

• + Addedreact-is@16.13.1(transitive)

• + Addedregenerator-runtime@0.14.1(transitive)

• + Addedresolve@1.22.10(transitive)

• + Addedresolve-from@4.0.0(transitive)

• + Addedsource-map@0.5.7(transitive)

• + Addedsupports-preserve-symlinks-flag@1.0.0(transitive)

• + Addedwhatwg-fetch@3.6.20(transitive)

• + Addedyaml@1.10.2(transitive)