@monok/server 1.5.0 → 1.5.1

package/AGENTS.md

@@ -222,7 +222,7 @@ If `getSiteInfo` is omitted, `/info` returns this authenticated fallback:
 ```json
 {
   "js_scripts": "Disabled",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "name": "Custom CMS",
   "logo": "",
   "categories": [],

package/README.md

@@ -10,7 +10,20 @@ the complete host-implementation contract, response shapes, and verification che
 
 ---
 
-## ⚡ Quick Start
+## Choose the integration mode
+
+Use `@monok/server` in one of three modes:
+
+1. **Content only** — receive and publish Monok content.
+2. **Affiliate only** — capture affiliate attribution and register referred customers.
+3. **Content and affiliate** — implement both independent integrations.
+
+Only implement the mode your project needs. Existing content-only integrations
+do not need affiliate middleware or configuration when updating this package.
+
+---
+
+## ⚡ Content quick start
 
 ```ts
 import express from "express";
@@ -47,53 +60,7 @@ npm install @monok/server express
 
 ---
 
-## 📚 Usage
-
-### Affiliate attribution (independent of content delivery)
-
-The affiliate middleware preserves the signed `monok_ref` value from a Monok
-redirect in an HttpOnly, SameSite=Lax cookie, then redirects to the same URL
-without the token. The offer controls the attribution window and the middleware
-derives the cookie expiry from the token, so merchants do not configure it.
-Mount it before the merchant's landing and signup routes. After the customer has
-been durably created, register the referral using the merchant's own stable
-customer ID.
-
-```ts
-import express from "express";
-import {
-  createMonokReferral,
-  monokAffiliateAttribution
-} from "@monok/server";
-
-const app = express();
-app.use(monokAffiliateAttribution());
-app.use(express.json());
-
-app.post("/signup", async (req, res) => {
-  const customer = await createCustomer(req.body);
-
-  if (req.monokAttribution) {
-    await createMonokReferral(
-      {
-        attributionToken: req.monokAttribution,
-        customerReference: customer.id
-      },
-      { apiKey: process.env.MONOK_API_KEY! }
-    );
-  }
-
-  res.status(201).json({ id: customer.id });
-});
-```
-
-The middleware defaults to secure cookies. For local HTTP development only, use
-`monokAffiliateAttribution({ secure: false })`. `customerReference` should be a
-durable internal ID, not an email address or other personal data. Repeating the
-same offer/customer registration is idempotent and retains the first referral.
-
-Affiliate-only merchants do **not** need to mount `createMonokRouter` or expose
-`/push`, `/info`, or `/postfilter`.
+## 📚 Content integration
 
 ### Express setup (TypeScript)
 
@@ -273,6 +240,57 @@ await sendMonokLinkback({
 
 ---
 
+## Affiliate integration
+
+Follow this section for **affiliate only** or **content and affiliate** mode.
+Content-only integrations can ignore it completely.
+
+The affiliate middleware preserves the signed `monok_ref` value from a Monok
+redirect in an HttpOnly, SameSite=Lax cookie, then redirects to the same URL
+without the token. The offer controls the attribution window and the middleware
+derives the cookie expiry from the token, so merchants do not configure it.
+Mount it before the merchant's landing and signup routes. After the customer has
+been durably created, register the referral using the merchant's own stable
+customer ID.
+
+```ts
+import express from "express";
+import {
+  createMonokReferral,
+  monokAffiliateAttribution
+} from "@monok/server";
+
+const app = express();
+app.use(monokAffiliateAttribution());
+app.use(express.json());
+
+app.post("/signup", async (req, res) => {
+  const customer = await createCustomer(req.body);
+
+  if (req.monokAttribution) {
+    await createMonokReferral(
+      {
+        attributionToken: req.monokAttribution,
+        customerReference: customer.id
+      },
+      { apiKey: process.env.MONOK_API_KEY! }
+    );
+  }
+
+  res.status(201).json({ id: customer.id });
+});
+```
+
+The middleware defaults to secure cookies. For local HTTP development only, use
+`monokAffiliateAttribution({ secure: false })`. `customerReference` should be a
+durable internal ID, not an email address or other personal data. Repeating the
+same offer/customer registration is idempotent and retains the first referral.
+
+Affiliate-only merchants do **not** need to mount `createMonokRouter` or expose
+`/push`, `/info`, or `/postfilter`.
+
+---
+
 ## 🛠 Development
 
 Build the package:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monok/server",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "Monok server integration helpers for content and affiliate attribution",
   "license": "MIT",
   "type": "module",