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

package/package.json

@@ -1,25 +1,33 @@
 {
   "name": "@financial-times/privacy-us-privacy",
   "description": "",
-  "version": "1.3.0",
-  "main": "dist/cjs/main.js",
-  "module": "dist/esm/main.js",
-  "types": "dist/cjs/main.d.ts",
+  "version": "2.0.2",
   "private": false,
+  "type": "module",
+  "types": "./dist/main.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/privacy-us-privacy.js",
+      "require": "./dist/privacy-us-privacy.cjs"
+    }
+  },
   "devDependencies": {
-    "@types/js-cookie": "^3.0.4",
+    "@types/js-cookie": "^3.0.5",
     "js-cookie": "^3.0.5",
-    "npm-run-all": "4.1.5"
+    "jsdom": "^22.1.0",
+    "npm-run-all": "4.1.5",
+    "vite": "^4.5.0",
+    "vite-plugin-dts": "^3.6.0",
+    "vitest": "^0.34.6"
   },
   "dependencies": {
     "@financial-times/privacy-legislation-client": "file:../legislation-client"
   },
   "scripts": {
-    "test": "jest",
-    "clean": "rm -rf ./dist",
-    "build:browser": "npx tsc --module es2015 --outDir ./dist/esm",
-    "build:node": "npx tsc --module commonjs --outDir ./dist/cjs",
-    "prebuild": "npm run clean",
-    "build": "run-p build:*"
+    "build": "vite build",
+    "test": "vitest"
   }
 }

package/dist/cjs/main.d.ts

@@ -1,26 +0,0 @@
-export declare const NO_PRIVACY_COOKIE = "no-privacy-cookie";
-declare global {
-    interface Window {
-        __uspapi?: (command: string, version: number, callback?: Function) => Promise<unknown>;
-    }
-}
-export declare function getUsPrivacyCookie(): string | null;
-/**
- * @return {string}
- */
-export declare function getUsPrivacyForTracking(): string;
-export declare function __uspapi(command: string, version: number, callback?: Function): Promise<void>;
-/**
- * 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;

package/dist/cjs/main.js

@@ -1,94 +0,0 @@
-"use strict";
-/* eslint-disable @typescript-eslint/ban-types */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setUSPrivacyCookie = exports.setUSPrivacy = exports.__uspapi = exports.getUsPrivacyForTracking = exports.getUsPrivacyCookie = exports.NO_PRIVACY_COOKIE = void 0;
-const privacy_legislation_client_1 = require("@financial-times/privacy-legislation-client");
-exports.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];
-}
-exports.getUsPrivacyCookie = getUsPrivacyCookie;
-/**
- * @return {string}
- */
-function getUsPrivacyForTracking() {
-    return getUsPrivacyCookie() || exports.NO_PRIVACY_COOKIE;
-}
-exports.getUsPrivacyForTracking = getUsPrivacyForTracking;
-async function __uspapi(command, version, callback) {
-    if (typeof callback !== "function") {
-        console.error("Please provide a valid callback to the __uspapi() function. __uspapi(command, version, callback)"); //eslint-disable-line no-console
-        return;
-    }
-    if (version !== 1 || command !== "getUSPData") {
-        console.error("Invalid version or command specified for the __uspapi() function"); //eslint-disable-line no-console
-        return;
-    }
-    try {
-        const uspCookie = getUsPrivacyCookie();
-        // User has visited the CCPA page and toggled CCPA on/off.
-        // Values in the usprivacy cookie should be either '1YYN' or '1YNN'
-        if (uspCookie) {
-            callback({
-                version,
-                uspString: uspCookie,
-            }, true);
-            return;
-        }
-        // No cookie, assume user hasn't ever visited the CCPA page
-        else {
-            const { legislation } = await (0, privacy_legislation_client_1.fetchLegislation)();
-            if (legislation.has("ccpa")) {
-                callback({
-                    version,
-                    uspString: "1NNN",
-                }, true);
-                return;
-            }
-            else {
-                // CCPA does not apply
-                callback({
-                    version,
-                    uspString: "1---",
-                }, true);
-                return;
-            }
-        }
-    }
-    catch (e) {
-        callback(undefined, false);
-    }
-}
-exports.__uspapi = __uspapi;
-/**
- * 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
- */
-function setUSPrivacy() {
-    if (typeof window.__uspapi === "function") {
-        return;
-    }
-    window.__uspapi = __uspapi;
-}
-exports.setUSPrivacy = setUSPrivacy;
-/**
- * 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
- */
-function setUSPrivacyCookie(consent, domain) {
-    // The problem of removing any subdomain from a hostname is relatively involved,
-    // and we are not trying to make it this work for every possible subdomain yet
-    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.setUSPrivacyCookie = setUSPrivacyCookie;

package/dist/esm/main.d.ts

@@ -1,26 +0,0 @@
-export declare const NO_PRIVACY_COOKIE = "no-privacy-cookie";
-declare global {
-    interface Window {
-        __uspapi?: (command: string, version: number, callback?: Function) => Promise<unknown>;
-    }
-}
-export declare function getUsPrivacyCookie(): string | null;
-/**
- * @return {string}
- */
-export declare function getUsPrivacyForTracking(): string;
-export declare function __uspapi(command: string, version: number, callback?: Function): Promise<void>;
-/**
- * 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;

package/dist/esm/main.js

@@ -1,86 +0,0 @@
-/* eslint-disable @typescript-eslint/ban-types */
-import { fetchLegislation } from "@financial-times/privacy-legislation-client";
-export const NO_PRIVACY_COOKIE = "no-privacy-cookie";
-export function getUsPrivacyCookie() {
-    const uspCookie = document.cookie.split("; ").find((row) => row.startsWith("usprivacy"));
-    if (!uspCookie) {
-        return null;
-    }
-    return uspCookie.split("=")[1];
-}
-/**
- * @return {string}
- */
-export function getUsPrivacyForTracking() {
-    return getUsPrivacyCookie() || NO_PRIVACY_COOKIE;
-}
-export async function __uspapi(command, version, callback) {
-    if (typeof callback !== "function") {
-        console.error("Please provide a valid callback to the __uspapi() function. __uspapi(command, version, callback)"); //eslint-disable-line no-console
-        return;
-    }
-    if (version !== 1 || command !== "getUSPData") {
-        console.error("Invalid version or command specified for the __uspapi() function"); //eslint-disable-line no-console
-        return;
-    }
-    try {
-        const uspCookie = getUsPrivacyCookie();
-        // User has visited the CCPA page and toggled CCPA on/off.
-        // Values in the usprivacy cookie should be either '1YYN' or '1YNN'
-        if (uspCookie) {
-            callback({
-                version,
-                uspString: uspCookie,
-            }, true);
-            return;
-        }
-        // No cookie, assume user hasn't ever visited the CCPA page
-        else {
-            const { legislation } = await fetchLegislation();
-            if (legislation.has("ccpa")) {
-                callback({
-                    version,
-                    uspString: "1NNN",
-                }, true);
-                return;
-            }
-            else {
-                // CCPA does not apply
-                callback({
-                    version,
-                    uspString: "1---",
-                }, true);
-                return;
-            }
-        }
-    }
-    catch (e) {
-        callback(undefined, false);
-    }
-}
-/**
- * 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 function setUSPrivacy() {
-    if (typeof window.__uspapi === "function") {
-        return;
-    }
-    window.__uspapi = __uspapi;
-}
-/**
- * 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 function setUSPrivacyCookie(consent, domain) {
-    // The problem of removing any subdomain from a hostname is relatively involved,
-    // and we are not trying to make it this work for every possible subdomain yet
-    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}`;
-}

package/src/main.ts

@@ -1,114 +0,0 @@
-/* eslint-disable @typescript-eslint/ban-types */
-
-import { fetchLegislation } from "@financial-times/privacy-legislation-client";
-
-export const NO_PRIVACY_COOKIE = "no-privacy-cookie";
-
-declare global {
-  interface Window {
-    __uspapi?: (command: string, version: number, callback?: Function) => Promise<unknown>;
-  }
-}
-
-export function getUsPrivacyCookie(): string | null {
-  const uspCookie = document.cookie.split("; ").find((row) => row.startsWith("usprivacy"));
-  if (!uspCookie) {
-    return null;
-  }
-  return uspCookie.split("=")[1];
-}
-
-/**
- * @return {string}
- */
-export function getUsPrivacyForTracking() {
-  return getUsPrivacyCookie() || NO_PRIVACY_COOKIE;
-}
-
-export async function __uspapi(
-  command: string,
-  version: number,
-  callback?: Function
-): Promise<void> {
-  if (typeof callback !== "function") {
-    console.error(
-      "Please provide a valid callback to the __uspapi() function. __uspapi(command, version, callback)"
-    ); //eslint-disable-line no-console
-    return;
-  }
-
-  if (version !== 1 || command !== "getUSPData") {
-    console.error("Invalid version or command specified for the __uspapi() function"); //eslint-disable-line no-console
-    return;
-  }
-
-  try {
-    const uspCookie = getUsPrivacyCookie();
-    // User has visited the CCPA page and toggled CCPA on/off.
-    // Values in the usprivacy cookie should be either '1YYN' or '1YNN'
-    if (uspCookie) {
-      callback(
-        {
-          version,
-          uspString: uspCookie,
-        },
-        true
-      );
-      return;
-    }
-    // No cookie, assume user hasn't ever visited the CCPA page
-    else {
-      const { legislation } = await fetchLegislation();
-      if (legislation.has("ccpa")) {
-        callback(
-          {
-            version,
-            uspString: "1NNN",
-          },
-          true
-        );
-        return;
-      } else {
-        // CCPA does not apply
-        callback(
-          {
-            version,
-            uspString: "1---",
-          },
-          true
-        );
-        return;
-      }
-    }
-  } catch (e) {
-    callback(undefined, false);
-  }
-}
-
-/**
- * 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 function setUSPrivacy(): void {
-  if (typeof window.__uspapi === "function") {
-    return;
-  }
-  window.__uspapi = __uspapi;
-}
-
-/**
- * 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 function setUSPrivacyCookie(consent: boolean, domain?: string): void {
-  // The problem of removing any subdomain from a hostname is relatively involved,
-  // and we are not trying to make it this work for every possible subdomain yet
-  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}`;
-}

package/src/test/main.test.ts

@@ -1,230 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-
-import type { RegionalCompliance } from "../../../legislation-client/src/main";
-
-import {
-  setUSPrivacy,
-  setUSPrivacyCookie,
-  getUsPrivacyForTracking,
-  getUsPrivacyCookie,
-  NO_PRIVACY_COOKIE,
-} from "../main";
-import * as legislationClient from "@financial-times/privacy-legislation-client";
-import Cookies from "js-cookie";
-
-const mockFetchLegislationCcpa = (): Promise<RegionalCompliance> =>
-  Promise.resolve({
-    region: "CA",
-    legislation: new Set(["ccpa"]),
-  });
-
-const mockFetchLegislationNotCcpa = (): Promise<RegionalCompliance> =>
-  Promise.resolve({
-    region: "GB",
-    legislation: new Set(["gdpr"]),
-  });
-
-describe("US Privacy", () => {
-  beforeEach(() => {
-    jest.spyOn(console, "error").mockImplementation((arg) => arg);
-  });
-
-  afterEach(() => {
-    jest.resetAllMocks();
-  });
-
-  it("should not overwrite an existing window.__uspapi?.() function", async () => {
-    window.__uspapi = (): Promise<string> => Promise.resolve("just testing");
-    await setUSPrivacy();
-    expect(await window.__uspapi?.("test command", 1)).toEqual("just testing");
-    delete window.__uspapi;
-  });
-
-  describe("window.__uspapi?.()", () => {
-    test("should console.error and return if called with command != `getUSPData`", () => {
-      jest.spyOn(legislationClient, "fetchLegislation");
-      const cb = jest.fn();
-      setUSPrivacy();
-      window.__uspapi?.("fake-command", 1, cb);
-      expect(console.error).toBeCalled();
-      expect(legislationClient.fetchLegislation).not.toBeCalled();
-      expect(cb).not.toBeCalled();
-    });
-
-    test("should console.error if called with version != 1", () => {
-      jest.spyOn(legislationClient, "fetchLegislation");
-      const cb = jest.fn();
-      setUSPrivacy();
-      window.__uspapi?.("getUSPData", 2, cb);
-      expect(console.error).toBeCalled();
-      expect(legislationClient.fetchLegislation).not.toBeCalled();
-      expect(cb).not.toBeCalled();
-    });
-
-    test("should console.error if callback is not defined", () => {
-      jest.spyOn(legislationClient, "fetchLegislation");
-      setUSPrivacy();
-      window.__uspapi?.("getUSPData", 1);
-      expect(console.error).toBeCalled();
-      expect(legislationClient.fetchLegislation).not.toBeCalled();
-    });
-
-    describe("When legislation information is not available", () => {
-      test("should execute the callback with (undefined, false) as it's arguments", () => {
-        jest.spyOn(legislationClient, "fetchLegislation").mockImplementation(() => {
-          throw new Error("Failed to get legislation data");
-        });
-        const cb = jest.fn();
-        setUSPrivacy();
-        window.__uspapi?.("getUSPData", 1, cb);
-        expect(cb).toBeCalledWith(undefined, false);
-      });
-    });
-
-    describe("Legislation is NOT CCPA", () => {
-      describe("`usprivacy` cookie is set", () => {
-        test("should execute the callback with { version: 1, uspString:`1---` }", async () => {
-          jest
-            .spyOn(legislationClient, "fetchLegislation")
-            .mockImplementation(mockFetchLegislationNotCcpa);
-          Cookies.set("usprivacy", "fake-value");
-          const cb = jest.fn();
-          setUSPrivacy();
-          await window.__uspapi?.("getUSPData", 1, cb);
-          expect(cb).toBeCalledWith(
-            {
-              version: 1,
-              uspString: "fake-value",
-            },
-            true
-          );
-        });
-      });
-
-      describe("`usprivacy` cookie is NOT set", () => {
-        test("should execute the callback with { version: 1, uspString:`1---` }", async () => {
-          jest
-            .spyOn(legislationClient, "fetchLegislation")
-            .mockImplementation(mockFetchLegislationNotCcpa);
-          Cookies.remove("usprivacy");
-          const cb = jest.fn();
-          setUSPrivacy();
-          await window.__uspapi?.("getUSPData", 1, cb);
-          expect(cb).toBeCalledWith(
-            {
-              version: 1,
-              uspString: "1---",
-            },
-            true
-          );
-        });
-      });
-    });
-
-    describe("Legislation is CCPA", () => {
-      describe("`usprivacy` cookie is set", () => {
-        test("should execute the callback with the value of the cookie", async () => {
-          jest
-            .spyOn(legislationClient, "fetchLegislation")
-            .mockImplementation(mockFetchLegislationCcpa);
-          const cb = jest.fn();
-          Cookies.set("usprivacy", "fake-value");
-          setUSPrivacy();
-          await window.__uspapi?.("getUSPData", 1, cb);
-          expect(cb).toBeCalledWith(
-            {
-              version: 1,
-              uspString: "fake-value",
-            },
-            true
-          );
-          expect(cb.mock.calls.length).toEqual(1);
-        });
-      });
-      describe("`usprivacy` cookie is NOT set", () => {
-        test("should execute the callback with us privacy string `1NNN`", async () => {
-          jest
-            .spyOn(legislationClient, "fetchLegislation")
-            .mockImplementation(mockFetchLegislationCcpa);
-          const cb = jest.fn();
-          Cookies.remove("usprivacy");
-          setUSPrivacy();
-          await window.__uspapi?.("getUSPData", 1, cb);
-          expect(cb).toBeCalledWith(
-            {
-              version: 1,
-              uspString: "1NNN",
-            },
-            true
-          );
-        });
-      });
-    });
-  });
-
-  describe("Set and Get CCPA consent cookie", () => {
-    beforeEach(() => Cookies.remove("usprivacy", { path: "/", domain: "ft.com" }));
-
-    describe("User has given CCPA consent (opten in)", () => {
-      test("should set the `usprivacy` cookie to `1YNN`", () => {
-        const consentGivenCode = "1YNN";
-        setUSPrivacyCookie(true);
-        expect(Cookies.get("usprivacy")).toEqual(consentGivenCode);
-        expect(getUsPrivacyCookie()).toEqual(consentGivenCode);
-        expect(getUsPrivacyForTracking()).toEqual(consentGivenCode);
-      });
-    });
-
-    describe("User has NOT given CCPA consent (opted out)", () => {
-      test("should set the `usprivacy` cookie to `1YYN`", () => {
-        const consentNotGivenCode = "1YYN";
-        setUSPrivacyCookie(false);
-        expect(Cookies.get("usprivacy")).toEqual(consentNotGivenCode);
-        expect(getUsPrivacyCookie()).toEqual(consentNotGivenCode);
-        expect(getUsPrivacyForTracking()).toEqual(consentNotGivenCode);
-      });
-    });
-
-    describe("User has neither accepted nor denied CCPA consent (cookie not found)", () => {
-      test("`usprivacy` has not ben set", () => {
-        //expect(Cookies.get("usprivacy")).toEqual(null);
-        expect(getUsPrivacyCookie()).toEqual(null);
-        expect(getUsPrivacyForTracking()).toEqual(NO_PRIVACY_COOKIE);
-      });
-    });
-
-    describe("when providing an explicit cookie domain", () => {
-      let setCookieSpy: jest.SpyInstance;
-
-      beforeAll(() => {
-        setCookieSpy = jest.spyOn(document, "cookie", "set");
-      });
-
-      afterAll(() => {
-        setCookieSpy.mockRestore();
-      });
-
-      describe("User has given CCPA consent (opted in)", () => {
-        test("should set the `usprivacy` cookie to `1YNN` under the specified domain", () => {
-          setUSPrivacyCookie(true, ".ftadviser.com");
-          expect(setCookieSpy).toHaveBeenCalledWith(
-            // max-age should be 31536000 seconds (1 year)
-            "usprivacy=1YNN;max-age=157680000;path=/;domain=.ftadviser.com"
-          );
-        });
-      });
-
-      describe("User has NOT given CCPA consent (opted out)", () => {
-        test("should set the `usprivacy` cookie to `1YYN` under the specified domain", () => {
-          setUSPrivacyCookie(false, ".ftadviser.com");
-          // max-age should be 31536000 seconds (1 year)
-          expect(setCookieSpy).toHaveBeenCalledWith(
-            "usprivacy=1YYN;max-age=157680000;path=/;domain=.ftadviser.com"
-          );
-        });
-      });
-    });
-  });
-});

package/tsconfig.json

@@ -1,6 +0,0 @@
-{
-  "extends": "../../../tsconfig",
-  "compilerOptions": {
-    "rootDir": "./src/"
-  }
-}