@zeroad.network/token 0.9.2 → 0.10.0

package/README.md

@@ -40,7 +40,7 @@ bun add @zeroad.network/token
 
 # Examples
 
-Take the example as a reference only. The most basic, and honestly, quite complete use with `express` could look similar to this:
+Take the example as a reference only. The most basic, and honestly, quite complete use with `express` v.5 could look similar to this:
 
 ```js
 import express from "express";
@@ -56,22 +56,21 @@ const app = express();
 const port = 3000;
 
 // Welcome Header Value acquired during Site Registration process at Zero Ad Network platform
-const ZERO_AD_PARTNER_HEADER_VALUE = "AZqnKU56eIC7vCD1PPlwhg^1^3";
+const ZERO_AD_NETWORK_WELCOME_HEADER_VALUE = "AZqnKU56eIC7vCD1PPlwhg^1^3";
 
 // Initialize your Zero Ad Network module
-init({ value: ZERO_AD_PARTNER_HEADER_VALUE });
+init({ value: ZERO_AD_NETWORK_WELCOME_HEADER_VALUE });
 
 app
   .use((req, res, next) => {
     // X-Better-Web-Welcome header injection can could have it's own simple middleware like this:
-    res.header(getServerHeaderName(), getServerHeaderValue());
+    res.set(getServerHeaderName(), getServerHeaderValue());
+
+    next();
   })
   .use((req, res, next) => {
-    const result = processRequest(c.req.header(getClientHeaderName()));
-
-    res.locals.disableAds = result.shouldRemoveAds();
-    res.locals.removePaywalls = result.shouldEnablePremiumContentAccess();
-    res.locals.vipExperience = result.shouldEnableVipExperience();
+    const tokenContext = processRequest(req.get(getClientHeaderName()));
+    res.locals.tokenContext = tokenContext;
 
     next();
   })
@@ -79,7 +78,11 @@ app
     // The "locals.disableAds" variable can now be used to suppress rendering
     // of ads and 3rd party non-functional trackers.
 
-    // The "locals.removePaywalls" variable can allow users to bypass pay-walled content.
+    // If "locals.shouldRemoveAds" value is true, the ads should be disabled in the template.
+
+    // If "locals.shouldEnablePremiumContentAccess" value is true, the access to paywalled content should be enabled. Depending on site subscription pricing, the basic subscription access could be enabled without forcing visitor to pay.
+
+    // If "locals.shouldEnableVipExperience" value is true, the next tier subscription access should be enabled without forcing visitor to pay.
     res.render("index.ejs");
   });
 
@@ -88,6 +91,8 @@ app.listen(port, () => {
 });
 ```
 
+For more example implementations such as `Express.js`, `Hono` or `Fastify`, please go to [see more examples](https://github.com/laurynas-karvelis/zeroad-token/tree/main/examples/).
+
 P.S.: Each web request coming from active subscriber using their Zero Ad Network browser extension will incur a tiny fraction of CPU computation cost to verify the token data matches its encrypted signature. On modern web infrasctructure a request execution time will increase roughly by ~0.08ms to 0.2ms or so. Mileage might vary, but the impact is minimal.
 
 # Final thoughts

package/dist/index.cjs

@@ -80,10 +80,16 @@ class ClientHeader {
   processRequest(headerValue) {
     const data = this.decode(headerValue);
     return {
-      data,
-      shouldRemoveAds: () => shouldRemoveAds(data),
-      shouldEnablePremiumContentAccess: () => shouldEnablePremiumContentAccess(data),
-      shouldEnableVipExperience: () => shouldEnableVipExperience(data)
+      _raw: data,
+      get shouldRemoveAds() {
+        return shouldRemoveAds(data);
+      },
+      get shouldEnablePremiumContentAccess() {
+        return shouldEnablePremiumContentAccess(data);
+      },
+      get shouldEnableVipExperience() {
+        return shouldEnableVipExperience(data);
+      }
     };
   }
 }
@@ -112,12 +118,12 @@ class Site {
     this.clientHeader = new ClientHeader(browser.ZEROAD_NETWORK_PUBLIC_KEY);
   }
 }
-let _defaultSite;
-const init = (options) => _defaultSite = new Site(options);
-const processRequest = (headerValue) => _defaultSite.clientHeader.processRequest(headerValue);
-const getClientHeaderName = () => _defaultSite.clientHeader.name;
-const getServerHeaderName = () => _defaultSite.serverHeader.name;
-const getServerHeaderValue = () => _defaultSite.serverHeader.value;
+let defaultSite;
+const init = (options) => defaultSite = new Site(options);
+const processRequest = (headerValue) => defaultSite.clientHeader.processRequest(headerValue);
+const getClientHeaderName = () => defaultSite.clientHeader.name;
+const getServerHeaderName = () => defaultSite.serverHeader.name;
+const getServerHeaderValue = () => defaultSite.serverHeader.value;
 
 exports.CLIENT_HEADERS = browser.CLIENT_HEADERS;
 exports.CURRENT_PROTOCOL_VERSION = browser.CURRENT_PROTOCOL_VERSION;

package/dist/index.d.cts

@@ -11,10 +11,10 @@ declare class ClientHeader {
     encode(version: PROTOCOL_VERSION, expiresAt: Date, features: SITE_FEATURES[]): string;
     decode(headerValue: string): ClientHeaderParseResult;
     processRequest(headerValue: string | undefined): {
-        data: ClientHeaderParseResult;
-        shouldRemoveAds: () => boolean;
-        shouldEnablePremiumContentAccess: () => boolean;
-        shouldEnableVipExperience: () => boolean;
+        _raw: ClientHeaderParseResult;
+        readonly shouldRemoveAds: boolean;
+        readonly shouldEnablePremiumContentAccess: boolean;
+        readonly shouldEnableVipExperience: boolean;
     };
 }
 
@@ -28,10 +28,10 @@ declare class Site {
 }
 declare const init: (options: ServerHeaderOptions) => Site;
 declare const processRequest: (headerValue: string | undefined) => {
-    data: ClientHeaderParseResult;
-    shouldRemoveAds: () => boolean;
-    shouldEnablePremiumContentAccess: () => boolean;
-    shouldEnableVipExperience: () => boolean;
+    _raw: ClientHeaderParseResult;
+    readonly shouldRemoveAds: boolean;
+    readonly shouldEnablePremiumContentAccess: boolean;
+    readonly shouldEnableVipExperience: boolean;
 };
 declare const getClientHeaderName: () => CLIENT_HEADERS;
 declare const getServerHeaderName: () => SERVER_HEADERS;

package/dist/index.d.mts

@@ -11,10 +11,10 @@ declare class ClientHeader {
     encode(version: PROTOCOL_VERSION, expiresAt: Date, features: SITE_FEATURES[]): string;
     decode(headerValue: string): ClientHeaderParseResult;
     processRequest(headerValue: string | undefined): {
-        data: ClientHeaderParseResult;
-        shouldRemoveAds: () => boolean;
-        shouldEnablePremiumContentAccess: () => boolean;
-        shouldEnableVipExperience: () => boolean;
+        _raw: ClientHeaderParseResult;
+        readonly shouldRemoveAds: boolean;
+        readonly shouldEnablePremiumContentAccess: boolean;
+        readonly shouldEnableVipExperience: boolean;
     };
 }
 
@@ -28,10 +28,10 @@ declare class Site {
 }
 declare const init: (options: ServerHeaderOptions) => Site;
 declare const processRequest: (headerValue: string | undefined) => {
-    data: ClientHeaderParseResult;
-    shouldRemoveAds: () => boolean;
-    shouldEnablePremiumContentAccess: () => boolean;
-    shouldEnableVipExperience: () => boolean;
+    _raw: ClientHeaderParseResult;
+    readonly shouldRemoveAds: boolean;
+    readonly shouldEnablePremiumContentAccess: boolean;
+    readonly shouldEnableVipExperience: boolean;
 };
 declare const getClientHeaderName: () => CLIENT_HEADERS;
 declare const getServerHeaderName: () => SERVER_HEADERS;

package/dist/index.mjs

@@ -79,10 +79,16 @@ class ClientHeader {
   processRequest(headerValue) {
     const data = this.decode(headerValue);
     return {
-      data,
-      shouldRemoveAds: () => shouldRemoveAds(data),
-      shouldEnablePremiumContentAccess: () => shouldEnablePremiumContentAccess(data),
-      shouldEnableVipExperience: () => shouldEnableVipExperience(data)
+      _raw: data,
+      get shouldRemoveAds() {
+        return shouldRemoveAds(data);
+      },
+      get shouldEnablePremiumContentAccess() {
+        return shouldEnablePremiumContentAccess(data);
+      },
+      get shouldEnableVipExperience() {
+        return shouldEnableVipExperience(data);
+      }
     };
   }
 }
@@ -111,11 +117,11 @@ class Site {
     this.clientHeader = new ClientHeader(ZEROAD_NETWORK_PUBLIC_KEY);
   }
 }
-let _defaultSite;
-const init = (options) => _defaultSite = new Site(options);
-const processRequest = (headerValue) => _defaultSite.clientHeader.processRequest(headerValue);
-const getClientHeaderName = () => _defaultSite.clientHeader.name;
-const getServerHeaderName = () => _defaultSite.serverHeader.name;
-const getServerHeaderValue = () => _defaultSite.serverHeader.value;
+let defaultSite;
+const init = (options) => defaultSite = new Site(options);
+const processRequest = (headerValue) => defaultSite.clientHeader.processRequest(headerValue);
+const getClientHeaderName = () => defaultSite.clientHeader.name;
+const getServerHeaderName = () => defaultSite.serverHeader.name;
+const getServerHeaderValue = () => defaultSite.serverHeader.value;
 
 export { CLIENT_HEADERS, ClientHeader, PROTOCOL_VERSION, SITE_FEATURES, ServerHeader, Site, ZEROAD_NETWORK_PUBLIC_KEY, getClientHeaderName, getServerHeaderName, getServerHeaderValue, init, processRequest };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeroad.network/token",
-  "version": "0.9.2",
+  "version": "0.10.0",
   "license": "SEE LICENSE IN LICENSE",
   "repository": "github:laurynas-karvelis/zeroad-token",
   "homepage": "https://zeroad.network",
@@ -49,7 +49,7 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@types/bun": "^1.3.2",
+    "@types/bun": "^1.3.3",
     "@types/node": "^24.10.0",
     "pkgroll": "^2.20.1",
     "prettier": "^3.6.2",