@commercetools-frontend/cookie-consent 1.4.2 → 1.5.0

package/README.md

@@ -99,7 +99,17 @@ import { setConsentCookie } from '@commercetools-frontend/cookie-consent/core';
 setConsentCookie({ performanceCookieConsent: true });
 ```
 
-Also here you can use the `useCookieConsent` from the `/react` entry point of the package.
+Setting a cookie also accepts a `domain` as a second argument. This value defaults to `.commercetools.com` but can also be influenced using the `additionalEnv` when building a Custom Application:
+
+```js
+additionalEnv: {
+    cookieConsentDomain: '${env:COOKIE_CONSENT_DOMAIN}',
+},
+```
+
+Whenever you are not building a Custom Application you can define the `window.app.cookieConsentDomain` instead.
+
+When needing to set a cookie you can use the `useCookieConsent` from the `/react` entry point of the package.
 
 ```js
 import { useCookieConsent } from '@commercetools-frontend/cookie-consent/react';
@@ -131,32 +141,3 @@ import { CookieConsentModal } from '@commercetools-frontend/cookie-consent/react
 
 <CookieConsentModal />;
 ```
-
-## Local development strategies
-
-Cookies are bound to a domain. In order to test this functionality when developing locally, it's important to spoof a cookie, and also ensure that the domain is localhost when using `cookie-consent` module functionality.
-
-To spoof a cookie in your browser, open Chrome, and enter the following into the console:
-
-```
-document.cookie="OptanonConsent=isGpcEnabled=0&datestamp=Wed+Mar+01+2023+11%3A38%3A38+GMT-0500+(Eastern+Standard+Time)&version=202301.2.0&isIABGlobal=false&hosts=&consentId=1623165b-6d62-4e4a-beae-71598c0756c6&interactionCount=1&landingPath=NotLandingPage&groups=C0001%3A1%2CC0002%3A0%2CC0003%3A1%2CC0004%3A1%2CC0005%3A1&geolocation=US%3BNC&AwaitingReconsent=false; domain=localhost; path=/"
-```
-
-This will create a cookie with all consent values set to false, bound to localhost.
-
-In order to set the domain to localhost when using `cookie-consent`, pass the domain in where appropriate. For example:
-
-```js
-setConsent(
-  {
-    essentialCookies: true,
-    performanceCookies: true,
-    functionalCookies: false,
-    socialMediaCookies: false,
-    targetingCookies: false,
-  },
-  'localhost' // <- the important part
-);
-```
-
-Remember to remove this argument before making a PR.

package/core/dist/commercetools-frontend-cookie-consent-core.cjs.d.ts

@@ -1 +1,2 @@
 export * from "../../dist/declarations/src/core/index";
+//# sourceMappingURL=commercetools-frontend-cookie-consent-core.cjs.d.ts.map

package/core/dist/commercetools-frontend-cookie-consent-core.cjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commercetools-frontend-cookie-consent-core.cjs.d.ts","sourceRoot":"","sources":["../../dist/declarations/src/core/index.d.ts"],"names":[],"mappings":"AAAA"}

package/core/dist/commercetools-frontend-cookie-consent-core.cjs.dev.js

@@ -127,12 +127,25 @@ function generateConsentCookie(consentGroups) {
   const consentCookieValue = new _URLSearchParams__default["default"](consentValues);
   return consentCookieValue.toString();
 }
-function setConsentCookie(consentGroups) {
+function setConsentCookie(consentGroups, domain) {
   var _context8, _context9;
-  let domain = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '.commercetools.com';
   const expiresAt = new Date();
   expiresAt.setFullYear(expiresAt.getFullYear() + 11);
-  document.cookie = _concatInstanceProperty__default["default"](_context8 = _concatInstanceProperty__default["default"](_context9 = "".concat(CONSENT_COOKIE_NAME, "=").concat(generateConsentCookie(consentGroups), "; domain=")).call(_context9, domain, "; expires=")).call(_context8, expiresAt.toUTCString(), "; SameSite=Lax; path=/; ");
+  let consentCookieDomain;
+
+  /**
+   * The `domain` argument takes precedence if passed.
+   * The `window.app.cookieConsentDomain` can be passed but can not be an empty string.
+   * By default `.commercetools.com` is used.
+   */
+  if (domain && domain.length > 0) {
+    consentCookieDomain = domain;
+  } else if (window.app && window.app.cookieConsentDomain && window.app.cookieConsentDomain.length > 0) {
+    consentCookieDomain = window.app.cookieConsentDomain;
+  } else {
+    consentCookieDomain = '.commercetools.com';
+  }
+  document.cookie = _concatInstanceProperty__default["default"](_context8 = _concatInstanceProperty__default["default"](_context9 = "".concat(CONSENT_COOKIE_NAME, "=").concat(generateConsentCookie(consentGroups), "; domain=")).call(_context9, consentCookieDomain, "; expires=")).call(_context8, expiresAt.toUTCString(), "; SameSite=Lax; path=/; ");
 }
 
 exports.CONSENT_COOKIE_NAME = CONSENT_COOKIE_NAME;

package/core/dist/commercetools-frontend-cookie-consent-core.cjs.prod.js

@@ -127,12 +127,25 @@ function generateConsentCookie(consentGroups) {
   const consentCookieValue = new _URLSearchParams__default["default"](consentValues);
   return consentCookieValue.toString();
 }
-function setConsentCookie(consentGroups) {
+function setConsentCookie(consentGroups, domain) {
   var _context8, _context9;
-  let domain = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '.commercetools.com';
   const expiresAt = new Date();
   expiresAt.setFullYear(expiresAt.getFullYear() + 11);
-  document.cookie = _concatInstanceProperty__default["default"](_context8 = _concatInstanceProperty__default["default"](_context9 = "".concat(CONSENT_COOKIE_NAME, "=").concat(generateConsentCookie(consentGroups), "; domain=")).call(_context9, domain, "; expires=")).call(_context8, expiresAt.toUTCString(), "; SameSite=Lax; path=/; ");
+  let consentCookieDomain;
+
+  /**
+   * The `domain` argument takes precedence if passed.
+   * The `window.app.cookieConsentDomain` can be passed but can not be an empty string.
+   * By default `.commercetools.com` is used.
+   */
+  if (domain && domain.length > 0) {
+    consentCookieDomain = domain;
+  } else if (window.app && window.app.cookieConsentDomain && window.app.cookieConsentDomain.length > 0) {
+    consentCookieDomain = window.app.cookieConsentDomain;
+  } else {
+    consentCookieDomain = '.commercetools.com';
+  }
+  document.cookie = _concatInstanceProperty__default["default"](_context8 = _concatInstanceProperty__default["default"](_context9 = "".concat(CONSENT_COOKIE_NAME, "=").concat(generateConsentCookie(consentGroups), "; domain=")).call(_context9, consentCookieDomain, "; expires=")).call(_context8, expiresAt.toUTCString(), "; SameSite=Lax; path=/; ");
 }
 
 exports.CONSENT_COOKIE_NAME = CONSENT_COOKIE_NAME;

package/core/dist/commercetools-frontend-cookie-consent-core.esm.js

@@ -106,12 +106,25 @@ function generateConsentCookie(consentGroups) {
   const consentCookieValue = new _URLSearchParams(consentValues);
   return consentCookieValue.toString();
 }
-function setConsentCookie(consentGroups) {
+function setConsentCookie(consentGroups, domain) {
   var _context8, _context9;
-  let domain = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '.commercetools.com';
   const expiresAt = new Date();
   expiresAt.setFullYear(expiresAt.getFullYear() + 11);
-  document.cookie = _concatInstanceProperty(_context8 = _concatInstanceProperty(_context9 = "".concat(CONSENT_COOKIE_NAME, "=").concat(generateConsentCookie(consentGroups), "; domain=")).call(_context9, domain, "; expires=")).call(_context8, expiresAt.toUTCString(), "; SameSite=Lax; path=/; ");
+  let consentCookieDomain;
+
+  /**
+   * The `domain` argument takes precedence if passed.
+   * The `window.app.cookieConsentDomain` can be passed but can not be an empty string.
+   * By default `.commercetools.com` is used.
+   */
+  if (domain && domain.length > 0) {
+    consentCookieDomain = domain;
+  } else if (window.app && window.app.cookieConsentDomain && window.app.cookieConsentDomain.length > 0) {
+    consentCookieDomain = window.app.cookieConsentDomain;
+  } else {
+    consentCookieDomain = '.commercetools.com';
+  }
+  document.cookie = _concatInstanceProperty(_context8 = _concatInstanceProperty(_context9 = "".concat(CONSENT_COOKIE_NAME, "=").concat(generateConsentCookie(consentGroups), "; domain=")).call(_context9, consentCookieDomain, "; expires=")).call(_context8, expiresAt.toUTCString(), "; SameSite=Lax; path=/; ");
 }
 
 export { CONSENT_COOKIE_NAME, COOKIE_CONSENT_GROUPS, generateConsentCookie, getParsedConsentCookieGroups, getRawConsentCookie, setConsentCookie };

package/dist/declarations/src/core/index.d.ts

@@ -5,6 +5,11 @@ declare const COOKIE_CONSENT_GROUPS: {
     readonly targetingCookies: "C0004";
     readonly socialMediaCookies: "C0005";
 };
+declare global {
+    interface Window {
+        app: Record<string, unknown>;
+    }
+}
 type TConsentGroupNames = keyof typeof COOKIE_CONSENT_GROUPS;
 type TConsentGroups = Record<TConsentGroupNames, boolean>;
 declare const CONSENT_COOKIE_NAME = "OptanonConsent";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools-frontend/cookie-consent",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "A package integrating with OneTrust cookie consent",
   "license": "MIT",
   "main": "dist/commercetools-frontend-cookie-consent.cjs.js",
@@ -17,21 +17,21 @@
     "@babel/core": "^7.21.0",
     "@babel/runtime": "^7.21.0",
     "@babel/runtime-corejs3": "^7.21.0",
-    "@commercetools-frontend/application-components": "^21.24.1",
-    "@commercetools-uikit/collapsible-panel": "^15.14.0",
-    "@commercetools-uikit/design-system": "^15.14.0",
-    "@commercetools-uikit/grid": "^15.14.0",
-    "@commercetools-uikit/link": "^15.14.0",
-    "@commercetools-uikit/primary-button": "^15.14.0",
-    "@commercetools-uikit/spacings": "^15.14.0",
-    "@commercetools-uikit/text": "^15.14.0",
-    "@commercetools-uikit/toggle-input": "^15.14.0"
+    "@commercetools-frontend/application-components": "^21.25.2",
+    "@commercetools-uikit/collapsible-panel": "^15.15.0",
+    "@commercetools-uikit/design-system": "^15.15.0",
+    "@commercetools-uikit/grid": "^15.15.0",
+    "@commercetools-uikit/link": "^15.15.0",
+    "@commercetools-uikit/primary-button": "^15.15.0",
+    "@commercetools-uikit/spacings": "^15.15.0",
+    "@commercetools-uikit/text": "^15.15.0",
+    "@commercetools-uikit/toggle-input": "^15.15.0"
   },
   "devDependencies": {
-    "@commercetools-frontend/application-shell": "21.24.1",
-    "@commercetools-frontend/application-shell-connectors": "21.24.1",
-    "@types/node": "18.15.10",
-    "@types/react": "17.0.54",
+    "@commercetools-frontend/application-shell": "21.25.2",
+    "@commercetools-frontend/application-shell-connectors": "21.25.2",
+    "@types/node": "18.15.12",
+    "@types/react": "17.0.58",
     "@emotion/react": "11.10.6",
     "react": "17.0.2",
     "react-intl": "5.25.1",

package/react/dist/commercetools-frontend-cookie-consent-react.cjs.d.ts

@@ -1 +1,2 @@
 export * from "../../dist/declarations/src/react/index";
+//# sourceMappingURL=commercetools-frontend-cookie-consent-react.cjs.d.ts.map

package/react/dist/commercetools-frontend-cookie-consent-react.cjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commercetools-frontend-cookie-consent-react.cjs.d.ts","sourceRoot":"","sources":["../../dist/declarations/src/react/index.d.ts"],"names":[],"mappings":"AAAA"}