@financial-times/privacy-us-privacy 2.0.2 → 2.0.3

package/dist/main.d.ts

@@ -0,0 +1,32 @@
+export declare function __uspapi(command: string, version: number, callback?: USPDataCallback): Promise<void>;
+
+export declare function getUsPrivacyCookie(): string | null;
+
+export declare function getUsPrivacyForTracking(): string;
+
+export declare const NO_PRIVACY_COOKIE = "no-privacy-cookie";
+
+/**
+ * Expose a javascript function on the global `window` object that can be called
+ * by third party scripts to determine if the current user has opted out of CCPA
+ * https://github.com/InteractiveAdvertisingBureau/USPrivacy/blob/HEAD/CCPA/USP%20API.md
+ */
+export declare function setUSPrivacy(): void;
+
+/**
+ * Set a cookie based on the IAB US Privacy spec
+ * https://github.com/InteractiveAdvertisingBureau/USPrivacy/blob/HEAD/CCPA/US%20Privacy%20String.md
+ *
+ * @param consent - Does the user have consent for CCPA
+ * @param domain - An optional explicit domain for the cookie
+ */
+export declare function setUSPrivacyCookie(consent: boolean, domain?: string): void;
+
+declare interface USPData {
+    version: number;
+    uspString: string;
+}
+
+declare type USPDataCallback = (uspData: USPData, success: boolean) => void;
+
+export { }

package/dist/privacy-us-privacy.cjs

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const API_URL = "https://privacy.ft.com/api/v1";
+const API_ENDPOINTS = {
+  complianceRegion: "/compliance-region.json"
+};
+function formatResponse(obj) {
+  return {
+    region: obj.region,
+    legislation: new Set(obj.legislation.split(","))
+  };
+}
+function sessionStorageOk() {
+  const test = "test";
+  try {
+    sessionStorage.setItem(test, test);
+    sessionStorage.removeItem(test);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+async function fetchLegislation() {
+  const complianceStr = sessionStorageOk() && sessionStorage.getItem("user-compliance");
+  const complianceObj = complianceStr && JSON.parse(complianceStr);
+  if (complianceObj) {
+    return Promise.resolve(formatResponse(complianceObj));
+  } else {
+    const url = `${API_URL}${API_ENDPOINTS.complianceRegion}`;
+    const res = await fetch(url);
+    const compliance = await (res.ok ? res.json() : Promise.reject(res));
+    if (sessionStorageOk()) {
+      sessionStorage.setItem("user-compliance", JSON.stringify(compliance));
+    }
+    return formatResponse(compliance);
+  }
+}
+const NO_PRIVACY_COOKIE = "no-privacy-cookie";
+function getUsPrivacyCookie() {
+  const uspCookie = document.cookie.split("; ").find((row) => row.startsWith("usprivacy"));
+  if (!uspCookie) {
+    return null;
+  }
+  return uspCookie.split("=")[1];
+}
+function getUsPrivacyForTracking() {
+  return getUsPrivacyCookie() || NO_PRIVACY_COOKIE;
+}
+async function __uspapi(command, version, callback) {
+  if (typeof callback !== "function") {
+    return console.error(
+      "Please provide a valid callback to the __uspapi() function. __uspapi(command, version, callback)"
+    );
+  }
+  if (version !== 1 || command !== "getUSPData") {
+    return console.error("Invalid version or command specified for the __uspapi() function");
+  }
+  try {
+    const uspCookie = getUsPrivacyCookie();
+    if (uspCookie) {
+      return callback({ version, uspString: uspCookie }, true);
+    } else {
+      const { legislation } = await fetchLegislation();
+      if (legislation.has("ccpa")) {
+        return callback({ version, uspString: "1NNN" }, true);
+      } else {
+        return callback({ version, uspString: "1---" }, true);
+      }
+    }
+  } catch (e) {
+    return console.error(e);
+  }
+}
+function setUSPrivacy() {
+  if (typeof window.__uspapi === "function") {
+    return;
+  }
+  window.__uspapi = __uspapi;
+}
+function setUSPrivacyCookie(consent, domain) {
+  domain = domain || (document.location.hostname || "").replace("www.", "");
+  const uspString = `1Y${consent ? "N" : "Y"}N`;
+  const maxAge = 60 * 60 * 24 * 365 * 5;
+  document.cookie = `usprivacy=${uspString};max-age=${maxAge};path=/;domain=${domain}`;
+}
+exports.NO_PRIVACY_COOKIE = NO_PRIVACY_COOKIE;
+exports.__uspapi = __uspapi;
+exports.getUsPrivacyCookie = getUsPrivacyCookie;
+exports.getUsPrivacyForTracking = getUsPrivacyForTracking;
+exports.setUSPrivacy = setUSPrivacy;
+exports.setUSPrivacyCookie = setUSPrivacyCookie;

package/dist/privacy-us-privacy.js

@@ -0,0 +1,91 @@
+const API_URL = "https://privacy.ft.com/api/v1";
+const API_ENDPOINTS = {
+  complianceRegion: "/compliance-region.json"
+};
+function formatResponse(obj) {
+  return {
+    region: obj.region,
+    legislation: new Set(obj.legislation.split(","))
+  };
+}
+function sessionStorageOk() {
+  const test = "test";
+  try {
+    sessionStorage.setItem(test, test);
+    sessionStorage.removeItem(test);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+async function fetchLegislation() {
+  const complianceStr = sessionStorageOk() && sessionStorage.getItem("user-compliance");
+  const complianceObj = complianceStr && JSON.parse(complianceStr);
+  if (complianceObj) {
+    return Promise.resolve(formatResponse(complianceObj));
+  } else {
+    const url = `${API_URL}${API_ENDPOINTS.complianceRegion}`;
+    const res = await fetch(url);
+    const compliance = await (res.ok ? res.json() : Promise.reject(res));
+    if (sessionStorageOk()) {
+      sessionStorage.setItem("user-compliance", JSON.stringify(compliance));
+    }
+    return formatResponse(compliance);
+  }
+}
+const NO_PRIVACY_COOKIE = "no-privacy-cookie";
+function getUsPrivacyCookie() {
+  const uspCookie = document.cookie.split("; ").find((row) => row.startsWith("usprivacy"));
+  if (!uspCookie) {
+    return null;
+  }
+  return uspCookie.split("=")[1];
+}
+function getUsPrivacyForTracking() {
+  return getUsPrivacyCookie() || NO_PRIVACY_COOKIE;
+}
+async function __uspapi(command, version, callback) {
+  if (typeof callback !== "function") {
+    return console.error(
+      "Please provide a valid callback to the __uspapi() function. __uspapi(command, version, callback)"
+    );
+  }
+  if (version !== 1 || command !== "getUSPData") {
+    return console.error("Invalid version or command specified for the __uspapi() function");
+  }
+  try {
+    const uspCookie = getUsPrivacyCookie();
+    if (uspCookie) {
+      return callback({ version, uspString: uspCookie }, true);
+    } else {
+      const { legislation } = await fetchLegislation();
+      if (legislation.has("ccpa")) {
+        return callback({ version, uspString: "1NNN" }, true);
+      } else {
+        return callback({ version, uspString: "1---" }, true);
+      }
+    }
+  } catch (e) {
+    return console.error(e);
+  }
+}
+function setUSPrivacy() {
+  if (typeof window.__uspapi === "function") {
+    return;
+  }
+  window.__uspapi = __uspapi;
+}
+function setUSPrivacyCookie(consent, domain) {
+  domain = domain || (document.location.hostname || "").replace("www.", "");
+  const uspString = `1Y${consent ? "N" : "Y"}N`;
+  const maxAge = 60 * 60 * 24 * 365 * 5;
+  document.cookie = `usprivacy=${uspString};max-age=${maxAge};path=/;domain=${domain}`;
+}
+export {
+  NO_PRIVACY_COOKIE,
+  __uspapi,
+  getUsPrivacyCookie,
+  getUsPrivacyForTracking,
+  setUSPrivacy,
+  setUSPrivacyCookie
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@financial-times/privacy-us-privacy",
   "description": "",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "private": false,
   "type": "module",
   "types": "./dist/main.d.ts",