@financial-times/privacy-legislation-client 2.0.2 → 2.0.4-alpha

package/dist/main.cjs

@@ -0,0 +1,66 @@
+"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;
+  }
+}
+function getHostname(referrer) {
+  if (referrer) {
+    try {
+      return new URL(referrer).hostname;
+    } catch (err) {
+      return referrer;
+    }
+  }
+  return typeof window === "undefined" ? "" : window.location.hostname;
+}
+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);
+  }
+}
+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.API_ENDPOINTS = API_ENDPOINTS;
+exports.API_URL = API_URL;
+exports.buildConsentPageUrl = buildConsentPageUrl;
+exports.fetchLegislation = fetchLegislation;

package/dist/main.d.ts

@@ -0,0 +1,32 @@
+export declare const API_ENDPOINTS: {
+    complianceRegion: string;
+};
+
+export declare const API_URL = "https://privacy.ft.com/api/v1";
+
+/**
+ * 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, }: {
+    url: string;
+    legislation: Set<string>;
+    referrer?: string;
+}): 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>;
+
+export declare type RegionalCompliance = {
+    region: string;
+    legislation: Set<string>;
+};
+
+export { }

package/dist/main.js

@@ -0,0 +1,66 @@
+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;
+  }
+}
+function getHostname(referrer) {
+  if (referrer) {
+    try {
+      return new URL(referrer).hostname;
+    } catch (err) {
+      return referrer;
+    }
+  }
+  return typeof window === "undefined" ? "" : window.location.hostname;
+}
+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);
+  }
+}
+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();
+}
+export {
+  API_ENDPOINTS,
+  API_URL,
+  buildConsentPageUrl,
+  fetchLegislation
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@financial-times/privacy-legislation-client",
   "description": "",
-  "version": "2.0.2",
+  "version": "2.0.4-alpha",
   "private": false,
   "type": "module",
   "types": "./dist/main.d.ts",
@@ -27,4 +27,4 @@
     "build": "vite build",
     "test": "vitest"
   }
-}
+}