@zeroad.network/token 0.13.10 → 0.13.12

package/README.md

@@ -69,7 +69,7 @@ Partnering with Zero Ad Network allows your site to:
 ## Onboarding Your Site
 
 1. [Sign up](https://zeroad.network/login) with Zero Ad Network.
-2. [Register your site](https://zeroad.network/publisher/sites/add) to receive your unique `X-Better-Web-Welcome` header.
+2. [Register your site](https://zeroad.network/publisher/sites/add) to receive your unique `Client ID` value.
 
 Your site must include this header on all publicly accessible HTML or RESTful endpoints so that Zero Ad Network users’ browser extensions can recognize participation.
 
@@ -117,7 +117,7 @@ const app = express();
 
 // Initialize the Zero Ad Network module at app startup.
 // Your site's `clientId` value is obtained during site registration on the Zero Ad Network platform (https://zeroad.network).
-const ZERO_AD_NETWORK_CLIENT_ID = "Z2CclA8oXIT1e0QmqTWF8w";
+const ZERO_AD_NETWORK_CLIENT_ID = "DEMO-Z2CclA8oXIT1e0Qmq";
 const site = Site({
   clientId: ZERO_AD_NETWORK_CLIENT_ID,
   features: [FEATURES.CLEAN_WEB, FEATURES.ONE_PASS],

package/dist/{browser-Bx6W_oKL.mjs → browser--AdrX2EX.mjs}

@@ -86,10 +86,10 @@ function encodeServerHeader(clientId, features) {
     throw new Error("The provided `clientId` value cannot be an empty string");
   }
   if (!features?.length) {
-    throw new Error("At least one Site feature must be provided");
+    throw new Error("At least one site feature must be provided");
   }
   if (features.filter((feature) => validFeatureValues.includes(feature)).length !== features.length) {
-    throw new Error(`Only valid Site features are allowed: ${validFeatureKeys.join(" | ")}`);
+    throw new Error(`Only valid site features are allowed: ${validFeatureKeys.join(" | ")}`);
   }
   return [clientId, CURRENT_PROTOCOL_VERSION, setFlags(features)].join(SEPARATOR);
 }
@@ -118,4 +118,4 @@ function decodeServerHeader(headerValue) {
   }
 }
 
-export { CLIENT_HEADERS as C, FEATURE_MAP as F, PROTOCOL_VERSION as P, SERVER_HEADERS as S, ZEROAD_NETWORK_PUBLIC_KEY as Z, setLogLevel as a, FEATURES as b, CURRENT_PROTOCOL_VERSION as c, decodeServerHeader as d, encodeServerHeader as e, fromBase64 as f, hasFlag as h, log as l, setFlags as s, toBase64 as t };
+export { CLIENT_HEADERS as C, FEATURES as F, PROTOCOL_VERSION as P, SERVER_HEADERS as S, ZEROAD_NETWORK_PUBLIC_KEY as Z, setLogLevel as a, CURRENT_PROTOCOL_VERSION as b, decodeServerHeader as d, encodeServerHeader as e, fromBase64 as f, hasFlag as h, log as l, setFlags as s, toBase64 as t };

package/dist/{browser-B9BhMU2_.cjs → browser-A5-3SGMN.cjs}

@@ -88,10 +88,10 @@ function encodeServerHeader(clientId, features) {
     throw new Error("The provided `clientId` value cannot be an empty string");
   }
   if (!features?.length) {
-    throw new Error("At least one Site feature must be provided");
+    throw new Error("At least one site feature must be provided");
   }
   if (features.filter((feature) => validFeatureValues.includes(feature)).length !== features.length) {
-    throw new Error(`Only valid Site features are allowed: ${validFeatureKeys.join(" | ")}`);
+    throw new Error(`Only valid site features are allowed: ${validFeatureKeys.join(" | ")}`);
   }
   return [clientId, CURRENT_PROTOCOL_VERSION, setFlags(features)].join(SEPARATOR);
 }
@@ -123,7 +123,6 @@ function decodeServerHeader(headerValue) {
 exports.CLIENT_HEADERS = CLIENT_HEADERS;
 exports.CURRENT_PROTOCOL_VERSION = CURRENT_PROTOCOL_VERSION;
 exports.FEATURES = FEATURES;
-exports.FEATURE_MAP = FEATURE_MAP;
 exports.PROTOCOL_VERSION = PROTOCOL_VERSION;
 exports.SERVER_HEADERS = SERVER_HEADERS;
 exports.ZEROAD_NETWORK_PUBLIC_KEY = ZEROAD_NETWORK_PUBLIC_KEY;

package/dist/browser.mjs

@@ -1 +1 @@
-export { C as CLIENT_HEADERS, c as CURRENT_PROTOCOL_VERSION, b as FEATURES, P as PROTOCOL_VERSION, S as SERVER_HEADERS, Z as ZEROAD_NETWORK_PUBLIC_KEY, d as decodeServerHeader } from './browser-Bx6W_oKL.mjs';
+export { C as CLIENT_HEADERS, b as CURRENT_PROTOCOL_VERSION, F as FEATURES, P as PROTOCOL_VERSION, S as SERVER_HEADERS, Z as ZEROAD_NETWORK_PUBLIC_KEY, d as decodeServerHeader } from './browser--AdrX2EX.mjs';

package/dist/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var browser = require('./browser-B9BhMU2_.cjs');
+var browser = require('./browser-A5-3SGMN.cjs');
 var node_buffer = require('node:buffer');
 var node_crypto = require('node:crypto');
 
@@ -38,26 +38,29 @@ function importPublicKey(publicKeyBase64) {
 const VERSION_BYTES = 1;
 const NONCE_BYTES = 4;
 const SEPARATOR = ".";
-function parseClientToken(headerValue, clientId, publicKey) {
+const FEATURES_TO_ACTIONS = {
+  [browser.FEATURES.CLEAN_WEB]: [
+    "HIDE_ADVERTISEMENTS",
+    "HIDE_COOKIE_CONSENT_SCREEN",
+    "HIDE_MARKETING_DIALOGS",
+    "DISABLE_NON_FUNCTIONAL_TRACKING"
+  ],
+  [browser.FEATURES.ONE_PASS]: ["DISABLE_CONTENT_PAYWALL", "ENABLE_SUBSCRIPTION_ACCESS"]
+};
+function parseClientToken(headerValue, options) {
   const headerValueAsString = Array.isArray(headerValue) ? headerValue[0] : headerValue;
-  const data = decodeClientHeader(headerValueAsString, publicKey);
+  const data = decodeClientHeader(headerValueAsString, options.publicKey || browser.ZEROAD_NETWORK_PUBLIC_KEY);
   let flags = 0;
   if (data && data.expiresAt.getTime() >= Date.now()) flags = data.flags;
-  if (flags && data?.clientId && data.clientId !== clientId) flags = 0;
-  const features = [];
-  for (const [feature, bit] of browser.FEATURE_MAP()) {
-    if (browser.hasFlag(Number(flags), bit)) features.push(feature);
+  if (flags && data?.clientId && data.clientId !== options.clientId) flags = 0;
+  const context = /* @__PURE__ */ new Map();
+  for (const [feature, actionNames] of Object.entries(FEATURES_TO_ACTIONS)) {
+    const decision = options.features.includes(Number(feature)) && browser.hasFlag(Number(feature), flags);
+    for (const actionName of actionNames) {
+      context.set(actionName, decision);
+    }
   }
-  const hasCleanWeb = features.includes("CLEAN_WEB");
-  const hasOnePass = features.includes("ONE_PASS");
-  return {
-    HIDE_ADVERTISEMENTS: hasCleanWeb,
-    HIDE_COOKIE_CONSENT_SCREEN: hasCleanWeb,
-    HIDE_MARKETING_DIALOGS: hasCleanWeb,
-    DISABLE_NON_FUNCTIONAL_TRACKING: hasCleanWeb,
-    DISABLE_CONTENT_PAYWALL: hasOnePass,
-    ENABLE_SUBSCRIPTION_ACCESS: hasOnePass
-  };
+  return Object.fromEntries(context);
 }
 function decodeClientHeader(headerValue, publicKey) {
   if (!headerValue?.length) return;
@@ -116,8 +119,8 @@ function as32BitNumber(byteArray, begin) {
 function Site(options) {
   const serverHeaderValue = browser.encodeServerHeader(options.clientId, options.features);
   return {
-    parseClientToken: (headerValue) => parseClientToken(headerValue, options.clientId, browser.ZEROAD_NETWORK_PUBLIC_KEY),
-    CLIENT_HEADER_NAME: browser.CLIENT_HEADERS.HELLO,
+    parseClientToken: (headerValue) => parseClientToken(headerValue, { clientId: options.clientId, features: options.features }),
+    CLIENT_HEADER_NAME: browser.CLIENT_HEADERS.HELLO.toLowerCase(),
     SERVER_HEADER_NAME: browser.SERVER_HEADERS.WELCOME,
     SERVER_HEADER_VALUE: serverHeaderValue
   };

package/dist/index.d.cts

@@ -1,13 +1,18 @@
-import { P as PROTOCOL_VERSION, F as FEATURES, C as CLIENT_HEADERS, S as SERVER_HEADERS } from './browser-BiNZ2c6t.cjs';
-export { a as CURRENT_PROTOCOL_VERSION, W as WelcomeHeader, Z as ZEROAD_NETWORK_PUBLIC_KEY, d as decodeServerHeader, e as encodeServerHeader } from './browser-BiNZ2c6t.cjs';
+import { F as FEATURES, P as PROTOCOL_VERSION, S as SERVER_HEADERS } from './browser-BiNZ2c6t.cjs';
+export { C as CLIENT_HEADERS, a as CURRENT_PROTOCOL_VERSION, W as WelcomeHeader, Z as ZEROAD_NETWORK_PUBLIC_KEY, d as decodeServerHeader, e as encodeServerHeader } from './browser-BiNZ2c6t.cjs';
 
 type LogLevel = "error" | "warn" | "info" | "debug";
 declare function setLogLevel(level: LogLevel): void;
 
-type FEATURE_FLAG = "HIDE_ADVERTISEMENTS" | "HIDE_COOKIE_CONSENT_SCREEN" | "HIDE_MARKETING_DIALOGS" | "DISABLE_NON_FUNCTIONAL_TRACKING" | "DISABLE_CONTENT_PAYWALL" | "ENABLE_SUBSCRIPTION_ACCESS";
+type FEATURE_ACTIONS = "HIDE_ADVERTISEMENTS" | "HIDE_COOKIE_CONSENT_SCREEN" | "HIDE_MARKETING_DIALOGS" | "DISABLE_NON_FUNCTIONAL_TRACKING" | "DISABLE_CONTENT_PAYWALL" | "ENABLE_SUBSCRIPTION_ACCESS";
 type ClientHeaderValue = string | string[] | undefined;
-type FeatureFlags = Record<FEATURE_FLAG, boolean>;
-declare function parseClientToken(headerValue: ClientHeaderValue, clientId: string, publicKey: string): FeatureFlags;
+type TokenContext = Record<FEATURE_ACTIONS, boolean>;
+type ParseClientTokenOptions = {
+    clientId: string;
+    features: FEATURES[];
+    publicKey?: string;
+};
+declare function parseClientToken(headerValue: ClientHeaderValue, options: ParseClientTokenOptions): TokenContext;
 type DecodedClientHeader = {
     version: PROTOCOL_VERSION;
     expiresAt: Date;
@@ -28,11 +33,11 @@ type SiteOptions = {
     features: FEATURES[];
 };
 declare function Site(options: SiteOptions): {
-    parseClientToken: (headerValue: ClientHeaderValue) => FeatureFlags;
-    CLIENT_HEADER_NAME: CLIENT_HEADERS;
+    parseClientToken: (headerValue: ClientHeaderValue) => TokenContext;
+    CLIENT_HEADER_NAME: string;
     SERVER_HEADER_NAME: SERVER_HEADERS;
     SERVER_HEADER_VALUE: string;
 };
 
-export { CLIENT_HEADERS, FEATURES, PROTOCOL_VERSION, SERVER_HEADERS, Site, decodeClientHeader, encodeClientHeader, parseClientToken, setLogLevel };
-export type { ClientHeaderValue, DecodedClientHeader, FEATURE_FLAG, FeatureFlags };
+export { FEATURES, PROTOCOL_VERSION, SERVER_HEADERS, Site, decodeClientHeader, encodeClientHeader, parseClientToken, setLogLevel };
+export type { ClientHeaderValue, DecodedClientHeader, FEATURE_ACTIONS, ParseClientTokenOptions, TokenContext };

package/dist/index.d.mts

@@ -1,13 +1,18 @@
-import { P as PROTOCOL_VERSION, F as FEATURES, C as CLIENT_HEADERS, S as SERVER_HEADERS } from './browser-BiNZ2c6t.mjs';
-export { a as CURRENT_PROTOCOL_VERSION, W as WelcomeHeader, Z as ZEROAD_NETWORK_PUBLIC_KEY, d as decodeServerHeader, e as encodeServerHeader } from './browser-BiNZ2c6t.mjs';
+import { F as FEATURES, P as PROTOCOL_VERSION, S as SERVER_HEADERS } from './browser-BiNZ2c6t.mjs';
+export { C as CLIENT_HEADERS, a as CURRENT_PROTOCOL_VERSION, W as WelcomeHeader, Z as ZEROAD_NETWORK_PUBLIC_KEY, d as decodeServerHeader, e as encodeServerHeader } from './browser-BiNZ2c6t.mjs';
 
 type LogLevel = "error" | "warn" | "info" | "debug";
 declare function setLogLevel(level: LogLevel): void;
 
-type FEATURE_FLAG = "HIDE_ADVERTISEMENTS" | "HIDE_COOKIE_CONSENT_SCREEN" | "HIDE_MARKETING_DIALOGS" | "DISABLE_NON_FUNCTIONAL_TRACKING" | "DISABLE_CONTENT_PAYWALL" | "ENABLE_SUBSCRIPTION_ACCESS";
+type FEATURE_ACTIONS = "HIDE_ADVERTISEMENTS" | "HIDE_COOKIE_CONSENT_SCREEN" | "HIDE_MARKETING_DIALOGS" | "DISABLE_NON_FUNCTIONAL_TRACKING" | "DISABLE_CONTENT_PAYWALL" | "ENABLE_SUBSCRIPTION_ACCESS";
 type ClientHeaderValue = string | string[] | undefined;
-type FeatureFlags = Record<FEATURE_FLAG, boolean>;
-declare function parseClientToken(headerValue: ClientHeaderValue, clientId: string, publicKey: string): FeatureFlags;
+type TokenContext = Record<FEATURE_ACTIONS, boolean>;
+type ParseClientTokenOptions = {
+    clientId: string;
+    features: FEATURES[];
+    publicKey?: string;
+};
+declare function parseClientToken(headerValue: ClientHeaderValue, options: ParseClientTokenOptions): TokenContext;
 type DecodedClientHeader = {
     version: PROTOCOL_VERSION;
     expiresAt: Date;
@@ -28,11 +33,11 @@ type SiteOptions = {
     features: FEATURES[];
 };
 declare function Site(options: SiteOptions): {
-    parseClientToken: (headerValue: ClientHeaderValue) => FeatureFlags;
-    CLIENT_HEADER_NAME: CLIENT_HEADERS;
+    parseClientToken: (headerValue: ClientHeaderValue) => TokenContext;
+    CLIENT_HEADER_NAME: string;
     SERVER_HEADER_NAME: SERVER_HEADERS;
     SERVER_HEADER_VALUE: string;
 };
 
-export { CLIENT_HEADERS, FEATURES, PROTOCOL_VERSION, SERVER_HEADERS, Site, decodeClientHeader, encodeClientHeader, parseClientToken, setLogLevel };
-export type { ClientHeaderValue, DecodedClientHeader, FEATURE_FLAG, FeatureFlags };
+export { FEATURES, PROTOCOL_VERSION, SERVER_HEADERS, Site, decodeClientHeader, encodeClientHeader, parseClientToken, setLogLevel };
+export type { ClientHeaderValue, DecodedClientHeader, FEATURE_ACTIONS, ParseClientTokenOptions, TokenContext };

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { F as FEATURE_MAP, f as fromBase64, P as PROTOCOL_VERSION, l as log, s as setFlags, t as toBase64, h as hasFlag, e as encodeServerHeader, S as SERVER_HEADERS, C as CLIENT_HEADERS, Z as ZEROAD_NETWORK_PUBLIC_KEY } from './browser-Bx6W_oKL.mjs';
-export { c as CURRENT_PROTOCOL_VERSION, b as FEATURES, d as decodeServerHeader, a as setLogLevel } from './browser-Bx6W_oKL.mjs';
+import { F as FEATURES, Z as ZEROAD_NETWORK_PUBLIC_KEY, h as hasFlag, f as fromBase64, P as PROTOCOL_VERSION, l as log, s as setFlags, t as toBase64, e as encodeServerHeader, S as SERVER_HEADERS, C as CLIENT_HEADERS } from './browser--AdrX2EX.mjs';
+export { b as CURRENT_PROTOCOL_VERSION, d as decodeServerHeader, a as setLogLevel } from './browser--AdrX2EX.mjs';
 import { Buffer } from 'node:buffer';
 import { verify as verify$1, randomBytes, sign as sign$1, createPublicKey, createPrivateKey } from 'node:crypto';
 
@@ -37,26 +37,29 @@ function importPublicKey(publicKeyBase64) {
 const VERSION_BYTES = 1;
 const NONCE_BYTES = 4;
 const SEPARATOR = ".";
-function parseClientToken(headerValue, clientId, publicKey) {
+const FEATURES_TO_ACTIONS = {
+  [FEATURES.CLEAN_WEB]: [
+    "HIDE_ADVERTISEMENTS",
+    "HIDE_COOKIE_CONSENT_SCREEN",
+    "HIDE_MARKETING_DIALOGS",
+    "DISABLE_NON_FUNCTIONAL_TRACKING"
+  ],
+  [FEATURES.ONE_PASS]: ["DISABLE_CONTENT_PAYWALL", "ENABLE_SUBSCRIPTION_ACCESS"]
+};
+function parseClientToken(headerValue, options) {
   const headerValueAsString = Array.isArray(headerValue) ? headerValue[0] : headerValue;
-  const data = decodeClientHeader(headerValueAsString, publicKey);
+  const data = decodeClientHeader(headerValueAsString, options.publicKey || ZEROAD_NETWORK_PUBLIC_KEY);
   let flags = 0;
   if (data && data.expiresAt.getTime() >= Date.now()) flags = data.flags;
-  if (flags && data?.clientId && data.clientId !== clientId) flags = 0;
-  const features = [];
-  for (const [feature, bit] of FEATURE_MAP()) {
-    if (hasFlag(Number(flags), bit)) features.push(feature);
+  if (flags && data?.clientId && data.clientId !== options.clientId) flags = 0;
+  const context = /* @__PURE__ */ new Map();
+  for (const [feature, actionNames] of Object.entries(FEATURES_TO_ACTIONS)) {
+    const decision = options.features.includes(Number(feature)) && hasFlag(Number(feature), flags);
+    for (const actionName of actionNames) {
+      context.set(actionName, decision);
+    }
   }
-  const hasCleanWeb = features.includes("CLEAN_WEB");
-  const hasOnePass = features.includes("ONE_PASS");
-  return {
-    HIDE_ADVERTISEMENTS: hasCleanWeb,
-    HIDE_COOKIE_CONSENT_SCREEN: hasCleanWeb,
-    HIDE_MARKETING_DIALOGS: hasCleanWeb,
-    DISABLE_NON_FUNCTIONAL_TRACKING: hasCleanWeb,
-    DISABLE_CONTENT_PAYWALL: hasOnePass,
-    ENABLE_SUBSCRIPTION_ACCESS: hasOnePass
-  };
+  return Object.fromEntries(context);
 }
 function decodeClientHeader(headerValue, publicKey) {
   if (!headerValue?.length) return;
@@ -115,11 +118,11 @@ function as32BitNumber(byteArray, begin) {
 function Site(options) {
   const serverHeaderValue = encodeServerHeader(options.clientId, options.features);
   return {
-    parseClientToken: (headerValue) => parseClientToken(headerValue, options.clientId, ZEROAD_NETWORK_PUBLIC_KEY),
-    CLIENT_HEADER_NAME: CLIENT_HEADERS.HELLO,
+    parseClientToken: (headerValue) => parseClientToken(headerValue, { clientId: options.clientId, features: options.features }),
+    CLIENT_HEADER_NAME: CLIENT_HEADERS.HELLO.toLowerCase(),
     SERVER_HEADER_NAME: SERVER_HEADERS.WELCOME,
     SERVER_HEADER_VALUE: serverHeaderValue
   };
 }
 
-export { CLIENT_HEADERS, PROTOCOL_VERSION, SERVER_HEADERS, Site, ZEROAD_NETWORK_PUBLIC_KEY, decodeClientHeader, encodeClientHeader, encodeServerHeader, parseClientToken };
+export { CLIENT_HEADERS, FEATURES, PROTOCOL_VERSION, SERVER_HEADERS, Site, ZEROAD_NETWORK_PUBLIC_KEY, decodeClientHeader, encodeClientHeader, encodeServerHeader, parseClientToken };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeroad.network/token",
-  "version": "0.13.10",
+  "version": "0.13.12",
   "license": "Apache-2.0",
   "repository": "github:laurynas-karvelis/zeroad-token-typescript",
   "homepage": "https://zeroad.network",