@financial-times/privacy-legislation-client 1.2.0 → 2.0.0

package/package.json

@@ -1,21 +1,30 @@
 {
   "name": "@financial-times/privacy-legislation-client",
   "description": "",
-  "version": "1.2.0",
-  "main": "dist/cjs/main.js",
-  "module": "dist/esm/main.js",
-  "types": "dist/cjs/main.d.ts",
+  "version": "2.0.0",
   "private": false,
+  "type": "module",
+  "types": "./dist/main.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/main.js",
+      "require": "./dist/main.cjs"
+    }
+  },
   "devDependencies": {
     "jest-fetch-mock": "^3.0.3",
-    "npm-run-all": "4.1.5"
+    "jsdom": "^22.1.0",
+    "msw": "^1.3.2",
+    "npm-run-all": "4.1.5",
+    "vite": "^4.5.0",
+    "vite-plugin-dts": "^3.6.0",
+    "vitest": "^0.34.6"
   },
   "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,28 +0,0 @@
-export declare const API_URL = "https://privacy.ft.com/api/v1";
-export declare const API_ENDPOINTS: {
-    complianceRegion: string;
-};
-export type RegionalCompliance = {
-    region: string;
-    legislation: Set<string>;
-};
-type Props = {
-    url: string;
-    legislation: Set<string>;
-    referrer?: string;
-};
-/**
- * Return a promise resolving to an object containing information about the
- * user's legal protections: *
- * - region: A string consisting of a country code or country-region ("GB", "US-CA")
- * - legislation: A Set of the applicable legislationIds
- */
-export declare function fetchLegislation(): Promise<RegionalCompliance>;
-/**
- * Embed legislationIds and referrer as params to `url`
- * Allows customisation (e.g. skinning, granularity of consent, etc) of the destination page
- *
- * This method provides a standardised way to interface with x-privacy-manager
- */
-export declare function buildConsentPageUrl({ url, legislation, referrer }: Props): string;
-export {};

package/dist/cjs/main.js

@@ -1,84 +0,0 @@
-"use strict";
-/* eslint-disable @typescript-eslint/no-explicit-any */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildConsentPageUrl = exports.fetchLegislation = exports.API_ENDPOINTS = exports.API_URL = void 0;
-exports.API_URL = "https://privacy.ft.com/api/v1";
-exports.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;
-    }
-}
-function getHostname(referrer) {
-    if (referrer) {
-        try {
-            return new URL(referrer).hostname;
-        }
-        catch (err) {
-            return referrer;
-        }
-    }
-    return typeof window === "undefined" ? "" : window.location.hostname;
-}
-/**
- * Return a promise resolving to an object containing information about the
- * user's legal protections: *
- * - region: A string consisting of a country code or country-region ("GB", "US-CA")
- * - legislation: A Set of the applicable legislationIds
- */
-async function fetchLegislation() {
-    // Look in session storage first
-    const complianceStr = sessionStorageOk() && sessionStorage.getItem("user-compliance");
-    const complianceObj = complianceStr && JSON.parse(complianceStr);
-    if (complianceObj) {
-        return Promise.resolve(formatResponse(complianceObj));
-    }
-    // Not found in session storage, fetch from API
-    else {
-        try {
-            const url = `${exports.API_URL}${exports.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);
-        }
-        catch (err) {
-            throw new Error(err.status);
-        }
-    }
-}
-exports.fetchLegislation = fetchLegislation;
-/**
- * Embed legislationIds and referrer as params to `url`
- * Allows customisation (e.g. skinning, granularity of consent, etc) of the destination page
- *
- * This method provides a standardised way to interface with x-privacy-manager
- */
-function buildConsentPageUrl({ url, legislation, referrer }) {
-    const decoratedUrl = new URL(url);
-    const hostname = getHostname(referrer);
-    for (const id of legislation) {
-        decoratedUrl.searchParams.append("legislation", id);
-    }
-    if (hostname) {
-        decoratedUrl.searchParams.set("referrer", hostname.toLowerCase());
-    }
-    return decoratedUrl.toString();
-}
-exports.buildConsentPageUrl = buildConsentPageUrl;

package/dist/esm/main.d.ts

@@ -1,28 +0,0 @@
-export declare const API_URL = "https://privacy.ft.com/api/v1";
-export declare const API_ENDPOINTS: {
-    complianceRegion: string;
-};
-export type RegionalCompliance = {
-    region: string;
-    legislation: Set<string>;
-};
-type Props = {
-    url: string;
-    legislation: Set<string>;
-    referrer?: string;
-};
-/**
- * Return a promise resolving to an object containing information about the
- * user's legal protections: *
- * - region: A string consisting of a country code or country-region ("GB", "US-CA")
- * - legislation: A Set of the applicable legislationIds
- */
-export declare function fetchLegislation(): Promise<RegionalCompliance>;
-/**
- * Embed legislationIds and referrer as params to `url`
- * Allows customisation (e.g. skinning, granularity of consent, etc) of the destination page
- *
- * This method provides a standardised way to interface with x-privacy-manager
- */
-export declare function buildConsentPageUrl({ url, legislation, referrer }: Props): string;
-export {};

package/dist/esm/main.js

@@ -1,79 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export const API_URL = "https://privacy.ft.com/api/v1";
-export 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;
-    }
-}
-function getHostname(referrer) {
-    if (referrer) {
-        try {
-            return new URL(referrer).hostname;
-        }
-        catch (err) {
-            return referrer;
-        }
-    }
-    return typeof window === "undefined" ? "" : window.location.hostname;
-}
-/**
- * Return a promise resolving to an object containing information about the
- * user's legal protections: *
- * - region: A string consisting of a country code or country-region ("GB", "US-CA")
- * - legislation: A Set of the applicable legislationIds
- */
-export async function fetchLegislation() {
-    // Look in session storage first
-    const complianceStr = sessionStorageOk() && sessionStorage.getItem("user-compliance");
-    const complianceObj = complianceStr && JSON.parse(complianceStr);
-    if (complianceObj) {
-        return Promise.resolve(formatResponse(complianceObj));
-    }
-    // Not found in session storage, fetch from API
-    else {
-        try {
-            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);
-        }
-        catch (err) {
-            throw new Error(err.status);
-        }
-    }
-}
-/**
- * Embed legislationIds and referrer as params to `url`
- * Allows customisation (e.g. skinning, granularity of consent, etc) of the destination page
- *
- * This method provides a standardised way to interface with x-privacy-manager
- */
-export function buildConsentPageUrl({ url, legislation, referrer }) {
-    const decoratedUrl = new URL(url);
-    const hostname = getHostname(referrer);
-    for (const id of legislation) {
-        decoratedUrl.searchParams.append("legislation", id);
-    }
-    if (hostname) {
-        decoratedUrl.searchParams.set("referrer", hostname.toLowerCase());
-    }
-    return decoratedUrl.toString();
-}

package/src/main.ts

@@ -1,98 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-export const API_URL = "https://privacy.ft.com/api/v1";
-export const API_ENDPOINTS = {
-  complianceRegion: "/compliance-region.json",
-};
-
-export type RegionalCompliance = {
-  region: string;
-  legislation: Set<string>;
-};
-
-type Props = {
-  url: string;
-  legislation: Set<string>;
-  referrer?: string;
-};
-
-function formatResponse(obj: { region: string; legislation: "string" }): RegionalCompliance {
-  return {
-    region: obj.region,
-    legislation: new Set<string>(obj.legislation.split(",")),
-  };
-}
-
-function sessionStorageOk(): boolean {
-  const test = "test";
-  try {
-    sessionStorage.setItem(test, test);
-    sessionStorage.removeItem(test);
-    return true;
-  } catch (e) {
-    return false;
-  }
-}
-
-function getHostname(referrer?: string): string {
-  if (referrer) {
-    try {
-      return new URL(referrer).hostname;
-    } catch (err) {
-      return referrer;
-    }
-  }
-
-  return typeof window === "undefined" ? "" : window.location.hostname;
-}
-
-/**
- * Return a promise resolving to an object containing information about the
- * user's legal protections: *
- * - region: A string consisting of a country code or country-region ("GB", "US-CA")
- * - legislation: A Set of the applicable legislationIds
- */
-export async function fetchLegislation(): Promise<RegionalCompliance> {
-  // Look in session storage first
-  const complianceStr = sessionStorageOk() && sessionStorage.getItem("user-compliance");
-  const complianceObj = complianceStr && JSON.parse(complianceStr);
-  if (complianceObj) {
-    return Promise.resolve(formatResponse(complianceObj));
-  }
-  // Not found in session storage, fetch from API
-  else {
-    try {
-      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);
-    } catch (err: any) {
-      throw new Error(err.status);
-    }
-  }
-}
-
-/**
- * Embed legislationIds and referrer as params to `url`
- * Allows customisation (e.g. skinning, granularity of consent, etc) of the destination page
- *
- * This method provides a standardised way to interface with x-privacy-manager
- */
-export function buildConsentPageUrl({ url, legislation, referrer }: Props): string {
-  const decoratedUrl = new URL(url);
-  const hostname = getHostname(referrer);
-
-  for (const id of legislation) {
-    decoratedUrl.searchParams.append("legislation", id);
-  }
-
-  if (hostname) {
-    decoratedUrl.searchParams.set("referrer", hostname.toLowerCase());
-  }
-
-  return decoratedUrl.toString();
-}

package/src/test/main.test.ts

@@ -1,131 +0,0 @@
-import fetch from "jest-fetch-mock";
-
-fetch.enableMocks();
-
-import { fetchLegislation, buildConsentPageUrl } from "../main";
-
-describe("fetchLegislation()", function () {
-  const payload = {
-    region: "US-CA",
-    legislation: "ccpa,gdpr",
-  };
-
-  describe("no referrer", () => {
-    beforeEach(() => {
-      sessionStorage.clear();
-      fetch.mockResponse(JSON.stringify(payload));
-    });
-
-    afterEach(() => {
-      fetch.resetMocks();
-    });
-
-    it("returns a Set of legislation ids", async function () {
-      const { region, legislation } = await fetchLegislation();
-      const consentPageUrl = buildConsentPageUrl({
-        url: "https://privacy.ft.com/consent",
-        legislation,
-      });
-
-      expect(region).toEqual("US-CA");
-      expect(legislation).toEqual(new Set(["ccpa", "gdpr"]));
-      const matchRegex = /(https:\/\/privacy.ft.com\/consent\?legislation=ccpa&legislation=gdpr)&referrer=www.ft.com$/;
-      expect(matchRegex.test(consentPageUrl)).toBeTruthy();
-    });
-  });
-
-  describe("With referrer", () => {
-    beforeEach(() => {
-      sessionStorage.clear();
-      fetch.mockResponse(
-        JSON.stringify({
-          region: "GB",
-          legislation: "gdpr",
-        })
-      );
-    });
-
-    afterEach(() => {
-      fetch.resetMocks();
-    });
-
-    it("Handles valid URL", async function () {
-      const referrer =
-        "https://www.thebanker.com/World/Middle-East/Saudi-Arabia/Will-the-pandemic-stymie-Saudi-Arabia-s-reform-agenda?ct=true";
-
-      const { region, legislation } = await fetchLegislation();
-      const consentPageUrl = buildConsentPageUrl({
-        url: "https://privacy.ft.com/consent",
-        legislation,
-        referrer,
-      });
-
-      expect(region).toBe("GB");
-      expect(legislation).toEqual(new Set(["gdpr"]));
-      expect(consentPageUrl).toBe(
-        "https://privacy.ft.com/consent?legislation=gdpr&referrer=www.thebanker.com"
-      );
-    });
-
-    it("Handles invalid URLs", async function () {
-      const { region, legislation } = await fetchLegislation();
-      const consentPageUrl = buildConsentPageUrl({
-        url: "https://privacy.ft.com/consent",
-        legislation,
-        referrer: "FT-App",
-      });
-
-      expect(region).toEqual("GB");
-      expect(legislation).toEqual(new Set(["gdpr"]));
-      expect(consentPageUrl).toBe(
-        "https://privacy.ft.com/consent?legislation=gdpr&referrer=ft-app"
-      );
-    });
-  });
-
-  describe("sessionStorage available", () => {
-    beforeEach(() => {
-      sessionStorage.clear();
-      fetch.mockResponse(
-        JSON.stringify({
-          region: "US-CA",
-          legislation: "ccpa,gdpr",
-        })
-      );
-    });
-
-    afterEach(() => {
-      fetch.resetMocks();
-    });
-
-    test("should fetch from sessionStorage if available", async () => {
-      sessionStorage.setItem(
-        "user-compliance",
-        JSON.stringify({
-          region: "US-CA",
-          legislation: "ccpa,gdpr",
-        })
-      );
-      const { region, legislation } = await fetchLegislation();
-
-      expect(region).toBe("US-CA");
-      expect(legislation).toEqual(new Set(["ccpa", "gdpr"]));
-      expect(fetch.mock.calls.length).toEqual(0);
-    });
-
-    test("should set sessionStorage item after fetch", async () => {
-      const { region, legislation } = await fetchLegislation();
-
-      const ssItemStr = sessionStorage.getItem("user-compliance");
-      const ssItemObj = ssItemStr && JSON.parse(ssItemStr);
-
-      expect(region).toBe("US-CA");
-      expect(legislation).toEqual(new Set(["ccpa", "gdpr"]));
-      expect(fetch.mock.calls.length).toEqual(1);
-      expect(ssItemObj).toEqual({
-        region: "US-CA",
-        legislation: "ccpa,gdpr",
-      });
-    });
-  });
-});

package/tsconfig.json

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