unshared-clientjs-sdk 2.0.0-rc.9 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +54 -16
- package/dist/client.d.ts +43 -35
- package/dist/client.js +1 -1
- package/dist/esm/client.d.mts +43 -35
- package/dist/esm/client.mjs +1 -1
- package/dist/esm/index.d.mts +5 -3
- package/dist/esm/index.mjs +1 -1
- package/dist/esm/middleware/dispatch-dedupe.d.mts +11 -0
- package/dist/esm/middleware/dispatch-dedupe.mjs +1 -0
- package/dist/esm/middleware/index.d.mts +32 -12
- package/dist/esm/middleware/index.mjs +1 -1
- package/dist/esm/middleware/injection/fingerprint-script.d.mts +11 -5
- package/dist/esm/middleware/injection/fingerprint-script.mjs +1 -1
- package/dist/esm/middleware/response-interceptor.d.mts +10 -8
- package/dist/esm/middleware/response-interceptor.mjs +1 -1
- package/dist/esm/middleware/routes/submit-fp.d.mts +16 -9
- package/dist/esm/middleware/routes/submit-fp.mjs +1 -1
- package/dist/esm/middleware/routes/verify.d.mts +13 -8
- package/dist/esm/middleware/routes/verify.mjs +1 -1
- package/dist/esm/middleware/utils/client-ip.d.mts +6 -0
- package/dist/esm/middleware/utils/client-ip.mjs +1 -0
- package/dist/esm/middleware/utils/cookies.d.mts +6 -0
- package/dist/esm/middleware/utils/cookies.mjs +1 -0
- package/dist/esm/middleware/utils/device-id.d.mts +19 -0
- package/dist/esm/middleware/utils/device-id.mjs +1 -0
- package/dist/esm/middleware/utils/flagged-response.d.mts +5 -0
- package/dist/esm/middleware/utils/flagged-response.mjs +1 -0
- package/dist/esm/middleware/utils/http-helpers.d.mts +21 -0
- package/dist/esm/middleware/utils/http-helpers.mjs +1 -0
- package/dist/esm/middleware/utils/include-path.d.mts +6 -0
- package/dist/esm/middleware/utils/include-path.mjs +1 -0
- package/dist/esm/middleware/utils/is-bot.d.mts +5 -0
- package/dist/esm/middleware/utils/is-bot.mjs +1 -0
- package/dist/esm/middleware/utils/secure.d.mts +3 -0
- package/dist/esm/middleware/utils/secure.mjs +1 -0
- package/dist/esm/middleware/utils/sentinel-user-id.d.mts +10 -0
- package/dist/esm/middleware/utils/sentinel-user-id.mjs +1 -0
- package/dist/esm/middleware/utils/skip-paths.mjs +1 -1
- package/dist/esm/middleware/verdict-cache.d.mts +12 -1
- package/dist/esm/middleware/verdict-cache.mjs +1 -1
- package/dist/esm/middleware.d.mts +13 -10
- package/dist/esm/middleware.mjs +1 -1
- package/dist/esm/types.d.mts +44 -0
- package/dist/esm/types.mjs +1 -0
- package/dist/esm/web/index.d.mts +17 -0
- package/dist/esm/web/index.mjs +1 -0
- package/dist/esm/web/protection-handler.d.mts +28 -0
- package/dist/esm/web/protection-handler.mjs +1 -0
- package/dist/esm/web/submit-handler.d.mts +27 -0
- package/dist/esm/web/submit-handler.mjs +1 -0
- package/dist/esm/web/types.d.mts +110 -0
- package/dist/esm/web/types.mjs +1 -0
- package/dist/esm/web/web-helpers.d.mts +55 -0
- package/dist/esm/web/web-helpers.mjs +1 -0
- package/dist/index.d.ts +5 -3
- package/dist/index.js +1 -1
- package/dist/middleware/dispatch-dedupe.d.ts +11 -0
- package/dist/middleware/dispatch-dedupe.js +1 -0
- package/dist/middleware/index.d.ts +32 -12
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/injection/fingerprint-script.d.ts +11 -5
- package/dist/middleware/injection/fingerprint-script.js +1 -1
- package/dist/middleware/response-interceptor.d.ts +10 -8
- package/dist/middleware/response-interceptor.js +1 -1
- package/dist/middleware/routes/submit-fp.d.ts +16 -9
- package/dist/middleware/routes/submit-fp.js +1 -1
- package/dist/middleware/routes/verify.d.ts +13 -8
- package/dist/middleware/routes/verify.js +1 -1
- package/dist/middleware/utils/client-ip.d.ts +6 -0
- package/dist/middleware/utils/client-ip.js +1 -0
- package/dist/middleware/utils/cookies.d.ts +6 -0
- package/dist/middleware/utils/cookies.js +1 -0
- package/dist/middleware/utils/device-id.d.ts +19 -0
- package/dist/middleware/utils/device-id.js +1 -0
- package/dist/middleware/utils/flagged-response.d.ts +5 -0
- package/dist/middleware/utils/flagged-response.js +1 -0
- package/dist/middleware/utils/http-helpers.d.ts +21 -0
- package/dist/middleware/utils/http-helpers.js +1 -0
- package/dist/middleware/utils/include-path.d.ts +6 -0
- package/dist/middleware/utils/include-path.js +1 -0
- package/dist/middleware/utils/is-bot.d.ts +5 -0
- package/dist/middleware/utils/is-bot.js +1 -0
- package/dist/middleware/utils/secure.d.ts +3 -0
- package/dist/middleware/utils/secure.js +1 -0
- package/dist/middleware/utils/sentinel-user-id.d.ts +10 -0
- package/dist/middleware/utils/sentinel-user-id.js +1 -0
- package/dist/middleware/utils/skip-paths.js +1 -1
- package/dist/middleware/verdict-cache.d.ts +12 -1
- package/dist/middleware/verdict-cache.js +1 -1
- package/dist/middleware.d.ts +13 -10
- package/dist/middleware.js +1 -1
- package/dist/types.d.ts +44 -0
- package/dist/types.js +1 -0
- package/dist/web/index.d.ts +17 -0
- package/dist/web/index.js +1 -0
- package/dist/web/protection-handler.d.ts +28 -0
- package/dist/web/protection-handler.js +1 -0
- package/dist/web/submit-handler.d.ts +27 -0
- package/dist/web/submit-handler.js +1 -0
- package/dist/web/types.d.ts +110 -0
- package/dist/web/types.js +1 -0
- package/dist/web/web-helpers.d.ts +55 -0
- package/dist/web/web-helpers.js +1 -0
- package/package.json +7 -10
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { UnsharedRequest } from '../../types';
|
|
2
|
+
/**
|
|
3
|
+
* Resolves device ID from: custom resolver → X-Device-Id header → __unshared_fp_id cookie.
|
|
4
|
+
*
|
|
5
|
+
* Returns the literal string `"unknown"` when no source provides a value.
|
|
6
|
+
* Callers that can tolerate a tri-state should use `extractDeviceIdOrUndefined`
|
|
7
|
+
* instead — the "unknown" sentinel polluted 19% of FP rows in production
|
|
8
|
+
* because it was being dispatched as-if-real during the first request of a
|
|
9
|
+
* session, before the inline script had a chance to set `__unshared_fp_id`.
|
|
10
|
+
* Kept for API compatibility.
|
|
11
|
+
*/
|
|
12
|
+
export declare function extractDeviceId<TReq extends UnsharedRequest = UnsharedRequest>(req: TReq, resolveDeviceId?: (req: TReq) => string | undefined): string;
|
|
13
|
+
/**
|
|
14
|
+
* Resolves device ID from: custom resolver → X-Device-Id header → __unshared_fp_id cookie.
|
|
15
|
+
* Returns `undefined` when nothing is available. Use this at any call site
|
|
16
|
+
* that can take a "skip dispatch" branch during the bootstrap window, so we
|
|
17
|
+
* stop writing `device_id="unknown"` rows to the analytics table on first request.
|
|
18
|
+
*/
|
|
19
|
+
export declare function extractDeviceIdOrUndefined<TReq extends UnsharedRequest = UnsharedRequest>(req: TReq, resolveDeviceId?: (req: TReq) => string | undefined): string | undefined;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"t",{value:!0}),exports.extractDeviceId=extractDeviceId,exports.extractDeviceIdOrUndefined=extractDeviceIdOrUndefined;const cookies_1=require("./cookies");function extractDeviceId(e,t){return extractDeviceIdOrUndefined(e,t)??"unknown"}function extractDeviceIdOrUndefined(e,t){if(t)try{const r=t(e);if(r)return r}catch{}const r=e.headers["x-device-id"];if("string"==typeof r&&r)return r;return(0,cookies_1.parseCookie)(e,"__unshared_fp_id")||void 0}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";function flaggedResponse(e){return{error:exports.ACCOUNT_FLAGGED_ERROR,email:e}}Object.defineProperty(exports,"o",{value:!0}),exports.ACCOUNT_FLAGGED_ERROR=void 0,exports.flaggedResponse=flaggedResponse,exports.ACCOUNT_FLAGGED_ERROR="account_flagged";
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { UnsharedResponse } from '../../types';
|
|
2
|
+
/**
|
|
3
|
+
* Send a JSON response. Framework-agnostic replacement for Express's
|
|
4
|
+
* `res.status(code).json(data)`.
|
|
5
|
+
*/
|
|
6
|
+
export declare function sendJson(res: UnsharedResponse, statusCode: number, data: unknown): void;
|
|
7
|
+
/**
|
|
8
|
+
* Send an empty response with a status code. Replacement for Express's
|
|
9
|
+
* `res.status(code).end()`.
|
|
10
|
+
*/
|
|
11
|
+
export declare function sendEmpty(res: UnsharedResponse, statusCode: number): void;
|
|
12
|
+
/**
|
|
13
|
+
* Send a response with a specific body. Replacement for Express's
|
|
14
|
+
* `res.status(code).end(body)`.
|
|
15
|
+
*/
|
|
16
|
+
export declare function sendBody(res: UnsharedResponse, statusCode: number, body: string | Buffer): void;
|
|
17
|
+
/**
|
|
18
|
+
* Extract the pathname from a request URL, stripping query string.
|
|
19
|
+
* Framework-agnostic replacement for Express's `req.path`.
|
|
20
|
+
*/
|
|
21
|
+
export declare function getRequestPath(url: string | undefined): string;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";function sendJson(t,e,n){const s=JSON.stringify(n);t.statusCode=e,t.setHeader("Content-Type","application/json"),t.end(s)}function sendEmpty(t,e){t.statusCode=e,t.end()}function sendBody(t,e,n){t.statusCode=e,t.end(n)}function getRequestPath(t){if(!t)return"/";const e=t.indexOf("?");return-1===e?t:t.slice(0,e)}Object.defineProperty(exports,"t",{value:!0}),exports.sendJson=sendJson,exports.sendEmpty=sendEmpty,exports.sendBody=sendBody,exports.getRequestPath=getRequestPath;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Returns true if the path matches at least one of the includePathPrefix entries.
|
|
3
|
+
* When includePathPrefix is undefined, returns true (all paths match — preserves default behavior).
|
|
4
|
+
* When includePathPrefix is an empty array, returns false (no paths match).
|
|
5
|
+
*/
|
|
6
|
+
export declare function shouldIncludePath(path: string, includePathPrefix?: string[]): boolean;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";function shouldIncludePath(e,t){return!t||t.some(t=>e.startsWith(t))}Object.defineProperty(exports,"t",{value:!0}),exports.shouldIncludePath=shouldIncludePath;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"t",{value:!0}),exports.isBot=isBot;const BOT_PATTERNS=["googlebot","bingbot","slurp","baiduspider","duckduckbot","yandex","sogou","exabot","ia_archiver","curl","wget","python-requests","python-urllib","axios","node-fetch","go-http-client","java/","libwww-perl","okhttp","apache-httpclient","http_request","httpie","headlesschrome","phantomjs","puppeteer","playwright","cypress","selenium","webdriver","electron","jsdom","vercel-screenshot","screenshot","prerender","lighthouse","chrome-lighthouse","pagespeed","gtmetrix","pingdom","nessus","nikto","sqlmap","burp","zap","qualys","openvas","nmap","masscan","facebookexternalhit","twitterbot","linkedinbot","whatsapp","telegrambot","slackbot","discordbot","bot","crawl","spider","scrape","fetch","scan"],BOT_RE=new RegExp(BOT_PATTERNS.join("|"),"i");function isBot(e){return!!e&&BOT_RE.test(e)}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";function isSecureRequest(e){return!!e.socket?.encrypted||"https"===e.headers["x-forwarded-proto"]}Object.defineProperty(exports,"t",{value:!0}),exports.isSecureRequest=isSecureRequest;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Stickiness window: if the resolver returns a sentinel but the
|
|
3
|
+
* `__unshared_uid` cookie was set within this many milliseconds, we prefer
|
|
4
|
+
* the cookie value (assuming it's a hydration race on the same tab).
|
|
5
|
+
* Outside the window, the cookie is considered stale and we fall through
|
|
6
|
+
* to the "no userId" branch — without clearing the cookie, because clearing
|
|
7
|
+
* on every hydration blip is exactly the bug we're fixing.
|
|
8
|
+
*/
|
|
9
|
+
export declare const SENTINEL_STICKINESS_TTL_MS = 30000;
|
|
10
|
+
export declare function isSentinelUserId(value: string | undefined | null): boolean;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"t",{value:!0}),exports.SENTINEL_STICKINESS_TTL_MS=void 0,exports.isSentinelUserId=isSentinelUserId;const SENTINEL_USER_IDS=new Set(["__pre_auth__","anonymous","guest","undefined","null"]);function isSentinelUserId(e){return"string"==typeof e&&SENTINEL_USER_IDS.has(e)}exports.SENTINEL_STICKINESS_TTL_MS=3e4;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"t",{value:!0}),exports.shouldSkipPath=shouldSkipPath;const STATIC_EXTENSIONS=new Set([".js",".mjs",".cjs",".css",".map",".png",".jpg",".jpeg",".gif",".svg",".ico",".webp",".avif",".woff",".woff2",".ttf",".otf",".eot",".mp3",".mp4",".webm",".ogg",".wasm",".
|
|
1
|
+
"use strict";Object.defineProperty(exports,"t",{value:!0}),exports.shouldSkipPath=shouldSkipPath;const STATIC_EXTENSIONS=new Set([".js",".mjs",".cjs",".css",".map",".png",".jpg",".jpeg",".gif",".svg",".ico",".webp",".avif",".woff",".woff2",".ttf",".otf",".eot",".mp3",".mp4",".webm",".ogg",".wasm",".xml",".txt",".pdf"]),STATIC_PATH_PREFIXES=["/static/","/assets/","/public/","/_next/","/__vite/","/favicon"];function shouldSkipPath(t,s){if(s)for(const o of s)if(t.startsWith(o))return!0;const o=t.lastIndexOf(".");if(-1!==o){const s=t.slice(o).toLowerCase().split("?")[0];if(STATIC_EXTENSIONS.has(s))return!0}for(const s of STATIC_PATH_PREFIXES)if(t.startsWith(s))return!0;return!1}
|
|
@@ -10,7 +10,9 @@ export declare class VerdictCache {
|
|
|
10
10
|
private readonly _entries;
|
|
11
11
|
private readonly _activeRefreshes;
|
|
12
12
|
private readonly _defaultTtlMs;
|
|
13
|
-
|
|
13
|
+
private readonly _maxSize;
|
|
14
|
+
private _sweepTimer;
|
|
15
|
+
constructor(defaultTTL?: number, maxSize?: number);
|
|
14
16
|
get(userId: string): Verdict | undefined;
|
|
15
17
|
set(userId: string, verdict: Omit<Verdict, 'cachedAt' | 'ttl'>, ttl?: number): void;
|
|
16
18
|
/**
|
|
@@ -33,4 +35,13 @@ export declare class VerdictCache {
|
|
|
33
35
|
/** Number of cached entries. */
|
|
34
36
|
get size(): number;
|
|
35
37
|
clear(): void;
|
|
38
|
+
/**
|
|
39
|
+
* Stops the periodic sweep timer. Call this when shutting down
|
|
40
|
+
* or when the middleware is no longer needed (e.g., in tests).
|
|
41
|
+
*/
|
|
42
|
+
destroy(): void;
|
|
43
|
+
/** Remove all entries that are past their TTL + a 2x grace period. */
|
|
44
|
+
private _sweep;
|
|
45
|
+
/** Evict the oldest entry by cachedAt to make room. */
|
|
46
|
+
private _evictOldest;
|
|
36
47
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"t",{value:!0}),exports.VerdictCache=void 0;class VerdictCache{constructor(t=6e4){this.i=new Map,this.h=new Set,this.o=t}get(t){return this.i.get(t)}set(t,e
|
|
1
|
+
"use strict";Object.defineProperty(exports,"t",{value:!0}),exports.VerdictCache=void 0;const DEFAULT_TTL_MS=6e4,DEFAULT_MAX_SIZE=1e4,SWEEP_INTERVAL_MS=3e5;class VerdictCache{constructor(t=6e4,s=1e4){this.i=new Map,this.h=new Set,this.o=null,this.l=t,this.u=s,this.o=setInterval(()=>this._(),3e5),this.o&&"function"==typeof this.o.unref&&this.o.unref()}get(t){return this.i.get(t)}set(t,s,e){!this.i.has(t)&&this.i.size>=this.u&&this.p(),this.i.set(t,{...s,cachedAt:Date.now(),ttl:e??this.l})}update(t,s){const e=this.i.get(t);e?(void 0!==s.isFlagged&&(e.isFlagged=s.isFlagged),void 0!==s.isVerified&&(e.isVerified=s.isVerified),e.cachedAt=Date.now()):(this.i.size>=this.u&&this.p(),this.i.set(t,{isFlagged:s.isFlagged??!1,isVerified:s.isVerified??!1,emailAddress:"",sessionId:"",cachedAt:Date.now(),ttl:this.l}))}delete(t){this.i.delete(t),this.h.delete(t)}isStale(t){const s=this.i.get(t);return!!s&&Date.now()-s.cachedAt>s.ttl}isRefreshing(t){return this.h.has(t)}markRefreshing(t){this.h.add(t)}clearRefreshing(t){this.h.delete(t)}get size(){return this.i.size}clear(){this.i.clear(),this.h.clear()}destroy(){this.o&&(clearInterval(this.o),this.o=null),this.clear()}_(){const t=Date.now();for(const[s,e]of this.i)t-e.cachedAt>2*e.ttl&&(this.i.delete(s),this.h.delete(s))}p(){let t=null,s=1/0;for(const[e,i]of this.i)i.cachedAt<s&&(s=i.cachedAt,t=e);t&&(this.i.delete(t),this.h.delete(t))}}exports.VerdictCache=VerdictCache;
|
package/dist/middleware.d.ts
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
3
|
-
export interface MiddlewareOptions {
|
|
1
|
+
import type { UnsharedRequest, UnsharedResponse, UnsharedNextFunction } from './types';
|
|
2
|
+
import type { UnsharedClient } from './client';
|
|
3
|
+
export interface MiddlewareOptions<TReq extends UnsharedRequest = UnsharedRequest> {
|
|
4
4
|
/** Override userId extractor. Falls back to req.body.user_id. */
|
|
5
|
-
userIdExtractor?: (req:
|
|
5
|
+
userIdExtractor?: (req: TReq) => string | undefined;
|
|
6
6
|
/** Override eventType extractor. Falls back to req.body.event_type. */
|
|
7
|
-
eventTypeExtractor?: (req:
|
|
7
|
+
eventTypeExtractor?: (req: TReq) => string | undefined;
|
|
8
8
|
/** Override sessionId extractor. Falls back to X-Session-Id header, then req.body.session_id. */
|
|
9
|
-
sessionIdExtractor?: (req:
|
|
9
|
+
sessionIdExtractor?: (req: TReq) => string | undefined;
|
|
10
10
|
/** Override IP address extractor. Falls back to req.ip. */
|
|
11
|
-
ipAddressExtractor?: (req:
|
|
11
|
+
ipAddressExtractor?: (req: TReq) => string | undefined;
|
|
12
12
|
/** Default event type when none is extractable. @default "browser_event" */
|
|
13
13
|
defaultEventType?: string;
|
|
14
14
|
/**
|
|
@@ -29,6 +29,9 @@ export interface MiddlewareOptions {
|
|
|
29
29
|
* Asserts that Express `trust proxy` is configured on the app.
|
|
30
30
|
* Call this once during application startup, before mounting any middleware.
|
|
31
31
|
*
|
|
32
|
+
* **Express-specific utility.** Other frameworks handle proxy trust differently;
|
|
33
|
+
* consult your framework's documentation for equivalent configuration.
|
|
34
|
+
*
|
|
32
35
|
* Throws synchronously if the setting is missing, killing the process before
|
|
33
36
|
* any requests are served.
|
|
34
37
|
*
|
|
@@ -39,7 +42,7 @@ export interface MiddlewareOptions {
|
|
|
39
42
|
* app.use(createUnsharedMiddleware(client, options));
|
|
40
43
|
* ```
|
|
41
44
|
*/
|
|
42
|
-
export declare function assertTrustProxy(app:
|
|
45
|
+
export declare function assertTrustProxy(app: any): void;
|
|
43
46
|
/**
|
|
44
47
|
* Creates an Express middleware that proxies browser fingerprint events to
|
|
45
48
|
* Unshared Labs. Mount this to handle the browser fingerprint route contract (§4 of spec).
|
|
@@ -62,7 +65,7 @@ export declare function assertTrustProxy(app: Application): void;
|
|
|
62
65
|
*
|
|
63
66
|
* @example
|
|
64
67
|
* ```typescript
|
|
65
|
-
* import { createUnsharedMiddleware } from "
|
|
68
|
+
* import { createUnsharedMiddleware } from "unshared-clientjs-sdk";
|
|
66
69
|
*
|
|
67
70
|
* app.use(express.json()); // must come first
|
|
68
71
|
* app.use(createUnsharedMiddleware(client, {
|
|
@@ -70,4 +73,4 @@ export declare function assertTrustProxy(app: Application): void;
|
|
|
70
73
|
* }));
|
|
71
74
|
* ```
|
|
72
75
|
*/
|
|
73
|
-
export declare function createUnsharedMiddleware(client:
|
|
76
|
+
export declare function createUnsharedMiddleware<TReq extends UnsharedRequest = UnsharedRequest>(client: UnsharedClient, options?: MiddlewareOptions<TReq>): (req: TReq, res: UnsharedResponse, next: UnsharedNextFunction) => Promise<void>;
|
package/dist/middleware.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";function assertTrustProxy(e){if(!e
|
|
1
|
+
"use strict";Object.defineProperty(exports,"t",{value:!0}),exports.assertTrustProxy=assertTrustProxy,exports.createUnsharedMiddleware=createUnsharedMiddleware;const http_helpers_1=require("./middleware/utils/http-helpers");function assertTrustProxy(e){if(!e?.get?.("trust proxy"))throw new Error('[unshared-labs] Express "trust proxy" is not set.\n\n Fix: add this line before mounting any middleware:\n app.set("trust proxy", 1);\n\n Why: without it, req.ip returns the proxy/load-balancer IP instead of\n the real client IP, which degrades account-sharing detection accuracy.\n Set to 1 if behind a single reverse proxy (Nginx, ALB, CloudFront),\n or the number of trusted proxies in your chain.')}function createUnsharedMiddleware(e,r){const{userIdExtractor:s,eventTypeExtractor:t,sessionIdExtractor:o,ipAddressExtractor:n,defaultEventType:i="browser_event",routePrefix:d="/unshared",corsOrigins:c}=r??{},a=`${d}/submit-fingerprint-event`,h=c?Array.isArray(c)?c:[c]:null;return async(r,d,c)=>{const u=(0,http_helpers_1.getRequestPath)(r.url);if(h&&u===a){const e=r.headers.origin??"",s=h.includes("*");if((s||h.includes(e))&&(d.setHeader("Access-Control-Allow-Origin",s?"*":e),d.setHeader("Access-Control-Allow-Methods","POST, OPTIONS"),d.setHeader("Access-Control-Allow-Headers","Content-Type, X-Idempotency-Key, X-Session-Id")),"OPTIONS"===r.method)return void(0,http_helpers_1.sendEmpty)(d,204)}if("POST"===r.method&&u===a)try{if(void 0===r.body)return void(0,http_helpers_1.sendJson)(d,400,{success:!1,error:{code:"BODY_PARSER_MISSING",message:"req.body is undefined. Mount a JSON body-parsing middleware (e.g., express.json()) before the Unshared middleware."}});const c=r.body??{};if(!c.hash||!c.stable_hash||!c.collected_at)return void(0,http_helpers_1.sendJson)(d,400,{success:!1,error:{code:"VALIDATION_ERROR",message:"Missing required fingerprint fields: hash, stable_hash, collected_at"}});if(!r.headers["x-session-id"])return void(0,http_helpers_1.sendJson)(d,400,{success:!1,error:{code:"VALIDATION_ERROR",message:"Missing required header: X-Session-Id"}});const a={full_hash:c.hash,fingerprint_id:c.stable_hash,timestamp:c.collected_at,isIncognito:c.is_incognito??!1,components:c.components??{},version:c.version??"unknown"};let h,u,l,p;try{h=(s?s(r):void 0)??c.user_id}catch{h=c.user_id}if(r.body&&"object"==typeof r.body&&"user_id"in r.body&&delete r.body.user_id,!h)return void(0,http_helpers_1.sendJson)(d,400,{success:!1,error:{code:"VALIDATION_ERROR",message:"Missing required field: user_id"}});try{u=(t?t(r):void 0)??c.event_type??i}catch{u=c.event_type??i}try{l=(o?o(r):void 0)??r.headers["x-session-id"]?.toString()??c.session_id}catch{l=r.headers["x-session-id"]?.toString()??c.session_id}const _=r.ip??r.socket?.remoteAddress??"";try{p=(n?n(r):void 0)??_}catch{p=_}const f=await e.submitFingerprintEvent(a,{userId:h,sessionHash:l,eventType:u,ipAddress:p});if(!f.success)return void(0,http_helpers_1.sendJson)(d,200,{success:!1,error:{code:"UPSTREAM_ERROR",message:f.error?.message??"Upstream request failed"}});(0,http_helpers_1.sendJson)(d,202,{success:!0,data:f.data})}catch(e){(0,http_helpers_1.sendJson)(d,200,{success:!1,error:{code:"MIDDLEWARE_ERROR",message:e instanceof Error?e.message:"Middleware error"}})}else c()}}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Framework-agnostic HTTP types for the Unshared Labs middleware.
|
|
3
|
+
*
|
|
4
|
+
* These interfaces are structurally compatible with Express, Fastify (via raw),
|
|
5
|
+
* Koa (via ctx.req/ctx.res), and raw Node.js http.IncomingMessage/ServerResponse.
|
|
6
|
+
*/
|
|
7
|
+
import type { IncomingHttpHeaders } from 'http';
|
|
8
|
+
/**
|
|
9
|
+
* Minimal request interface for framework-agnostic middleware.
|
|
10
|
+
*
|
|
11
|
+
* Express, Fastify's `request.raw`, Koa's `ctx.req`, and Node.js
|
|
12
|
+
* `http.IncomingMessage` all satisfy this interface via structural typing.
|
|
13
|
+
*/
|
|
14
|
+
export interface UnsharedRequest {
|
|
15
|
+
method?: string;
|
|
16
|
+
url?: string;
|
|
17
|
+
headers: IncomingHttpHeaders;
|
|
18
|
+
body?: any;
|
|
19
|
+
/** Client IP address, if the framework provides it (e.g. Express `req.ip`). */
|
|
20
|
+
ip?: string;
|
|
21
|
+
socket?: {
|
|
22
|
+
remoteAddress?: string;
|
|
23
|
+
encrypted?: boolean;
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Minimal response interface for framework-agnostic middleware.
|
|
28
|
+
*
|
|
29
|
+
* Express `Response`, Fastify's `reply.raw`, Koa's `ctx.res`, and Node.js
|
|
30
|
+
* `http.ServerResponse` all satisfy this interface via structural typing.
|
|
31
|
+
*/
|
|
32
|
+
export interface UnsharedResponse {
|
|
33
|
+
statusCode: number;
|
|
34
|
+
setHeader(name: string, value: string | number | string[]): any;
|
|
35
|
+
getHeader(name: string): string | number | string[] | undefined;
|
|
36
|
+
removeHeader(name: string): void;
|
|
37
|
+
write(chunk: any, encodingOrCallback?: any, callback?: any): boolean;
|
|
38
|
+
end(chunk?: any, encodingOrCallback?: any, callback?: any): any;
|
|
39
|
+
writeHead(statusCode: number, ...args: any[]): any;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Middleware next function. Compatible with Express, Connect, and Koa.
|
|
43
|
+
*/
|
|
44
|
+
export type UnsharedNextFunction = (err?: any) => void;
|
package/dist/types.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"t",{value:!0});
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Web Standard Request/Response handlers for serverless/edge environments.
|
|
3
|
+
*
|
|
4
|
+
* Use this entry point in Next.js App Router, Vercel Edge Functions,
|
|
5
|
+
* Cloudflare Workers, Deno Deploy, Bun, or any other runtime that uses
|
|
6
|
+
* the Web Standard Fetch API (`Request`/`Response` globals).
|
|
7
|
+
*
|
|
8
|
+
* For Node.js HTTP frameworks (Express, Fastify, Koa, Next.js Pages Router),
|
|
9
|
+
* use the default `unshared-clientjs-sdk` entry point instead — its middleware
|
|
10
|
+
* is compatible with all frameworks that expose `http.IncomingMessage`/
|
|
11
|
+
* `http.ServerResponse` objects.
|
|
12
|
+
*/
|
|
13
|
+
export { createWebSubmitHandler } from './submit-handler';
|
|
14
|
+
export { createWebProtectionMiddleware } from './protection-handler';
|
|
15
|
+
export type { WebHandler, WebMiddleware, WebSubmitOptions, WebProtectionConfig, } from './types';
|
|
16
|
+
export { VerdictCache } from '../middleware/verdict-cache';
|
|
17
|
+
export type { Verdict } from '../middleware/verdict-cache';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"t",{value:!0}),exports.VerdictCache=exports.createWebProtectionMiddleware=exports.createWebSubmitHandler=void 0;var submit_handler_1=require("./submit-handler");Object.defineProperty(exports,"createWebSubmitHandler",{enumerable:!0,get:function(){return submit_handler_1.createWebSubmitHandler}});var protection_handler_1=require("./protection-handler");Object.defineProperty(exports,"createWebProtectionMiddleware",{enumerable:!0,get:function(){return protection_handler_1.createWebProtectionMiddleware}});var verdict_cache_1=require("../middleware/verdict-cache");Object.defineProperty(exports,"VerdictCache",{enumerable:!0,get:function(){return verdict_cache_1.VerdictCache}});
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { UnsharedClient } from '../client';
|
|
2
|
+
import type { WebMiddleware, WebProtectionConfig } from './types';
|
|
3
|
+
/**
|
|
4
|
+
* Web Standard equivalent of `unsharedBoundToUser` from src/middleware/index.ts.
|
|
5
|
+
*
|
|
6
|
+
* Returns a middleware `(request, next) => Promise<Response>` suitable for
|
|
7
|
+
* Next.js App Router, Vercel Edge Functions, Cloudflare Workers, Deno Deploy,
|
|
8
|
+
* and other Web Standard runtimes.
|
|
9
|
+
*
|
|
10
|
+
* Unlike the Node.js middleware which mutates the response object, this
|
|
11
|
+
* handler calls `next(request)` to get the downstream Response, transforms
|
|
12
|
+
* it (injects the fingerprint script into HTML), and returns a new Response.
|
|
13
|
+
*
|
|
14
|
+
* @example Next.js App Router (in middleware.ts)
|
|
15
|
+
* ```typescript
|
|
16
|
+
* import { createWebProtectionMiddleware } from 'unshared-clientjs-sdk/web';
|
|
17
|
+
*
|
|
18
|
+
* const protect = createWebProtectionMiddleware(client, {
|
|
19
|
+
* userId: (req) => parseJwt(req.headers.get('authorization'))?.sub,
|
|
20
|
+
* emailAddress: (req) => parseJwt(req.headers.get('authorization'))?.email,
|
|
21
|
+
* });
|
|
22
|
+
*
|
|
23
|
+
* export async function middleware(request: Request) {
|
|
24
|
+
* return protect(request, async () => NextResponse.next());
|
|
25
|
+
* }
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
export declare function createWebProtectionMiddleware(client: UnsharedClient, config: WebProtectionConfig): WebMiddleware;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"t",{value:!0}),exports.createWebProtectionMiddleware=createWebProtectionMiddleware;const verdict_cache_1=require("../middleware/verdict-cache"),rate_limit_backoff_1=require("../middleware/rate-limit-backoff"),dispatch_dedupe_1=require("../middleware/dispatch-dedupe"),fingerprint_script_1=require("../middleware/injection/fingerprint-script"),content_type_1=require("../middleware/utils/content-type"),skip_paths_1=require("../middleware/utils/skip-paths"),include_path_1=require("../middleware/utils/include-path"),is_bot_1=require("../middleware/utils/is-bot"),sentinel_user_id_1=require("../middleware/utils/sentinel-user-id"),web_helpers_1=require("./web-helpers"),CHECK_USER_TIMEOUT_MS=500;function createWebProtectionMiddleware(e,r){if(!r.userId)throw new Error("[Unshared] userId resolver is required");const{userId:s,emailAddress:t,routePrefix:i="/__unshared",corsOrigins:n,cacheTTL:a=6e4,skipPaths:o,includePathPrefix:d,sessionId:c,deviceId:_,fingerprintSdkBundle:l="",onFlagged:u,onError:p}=r,h=new verdict_cache_1.VerdictCache(a),f=new rate_limit_backoff_1.RateLimitBackoff,m=new dispatch_dedupe_1.DispatchDedupe,w=Date.now().toString(36),g=(0,fingerprint_script_1.generateFingerprintScript)(i,w),b=`${i}/fp.js`,v=`${i}/submit-fp`,I=`${i}/verify-trigger`,y=`${i}/verify`,A=`${i}/status`,S=n?Array.isArray(n)?n:[n]:null;return async function(r,n){let a,w,E;try{const e=new URL(r.url);a=e.pathname,w=e.search}catch{return n(r)}if(a.startsWith(i+"/")){const i=function(e){if(!S)return{};const r=e.headers.get("origin")??"",s=S.includes("*");return s||S.includes(r)?{"Access-Control-Allow-Origin":s?"*":r,"Access-Control-Allow-Methods":"POST, OPTIONS","Access-Control-Allow-Headers":"Content-Type, X-Idempotency-Key, X-Session-Id, X-Device-Id","Access-Control-Allow-Credentials":"true"}:{}}(r);if("OPTIONS"===r.method)return(0,web_helpers_1.emptyResponse)(204,i);if("GET"===r.method&&a===b)return l?(0,web_helpers_1.bodyResponse)(200,l,{...i,"Content-Type":"application/javascript","Cache-Control":"public, max-age=3600"}):(0,web_helpers_1.jsonResponse)(404,{success:!1,error:{code:"NOT_FOUND",message:"Fingerprint SDK bundle not configured. Pass fingerprintSdkBundle in config."}},i);if("POST"===r.method&&(a===v||a===I||a===y)){let n;try{n=await r.json()}catch{return(0,web_helpers_1.jsonResponse)(400,{success:!1,error:{code:"BODY_PARSER_MISSING",message:"Request body is not valid JSON."}},i)}return a===v?handleSubmitFp(r,n,{client:e,verdictCache:h,rateLimitBackoff:f,dispatchDedupe:m,resolveUserId:s,resolveEmailAddress:t,resolveSessionId:c,resolveDeviceId:_,onError:p},i):a===I?handleVerifyTriggerWeb(r,n,{client:e,verdictCache:h,resolveEmailAddress:t,resolveDeviceId:_,onError:p},i):handleVerifyWeb(r,n,{client:e,verdictCache:h,resolveEmailAddress:t,resolveDeviceId:_,onError:p},i)}if("GET"===r.method&&a===A){let e;try{e=s(r)}catch{}if(!e)return(0,web_helpers_1.jsonResponse)(200,{status:"anonymous"},i);const n=resolveEmail(r,t),a=h.get(e);return a&&a.isFlagged&&!a.isVerified&&u&&n?(0,web_helpers_1.jsonResponse)(403,{error:"account_flagged",email:n},i):(0,web_helpers_1.jsonResponse)(200,{status:"ok"},i)}return(0,web_helpers_1.jsonResponse)(404,{success:!1,error:{code:"NOT_FOUND",message:"Unknown route"}},i)}if((0,skip_paths_1.shouldSkipPath)(a,o))return n(r);if(!(0,include_path_1.shouldIncludePath)(a,d))return injectIntoHtmlResponse(await n(r),g);try{E=s(r)}catch{}if((0,sentinel_user_id_1.isSentinelUserId)(E)){const e=(0,web_helpers_1.parseCookieFromRequest)(r,"__unshared_uid"),s=(0,web_helpers_1.parseCookieFromRequest)(r,"__unshared_uid_at"),t=s?Number(s):NaN,i=Number.isFinite(t)&&Date.now()-t<=sentinel_user_id_1.SENTINEL_STICKINESS_TTL_MS;E=e&&i?e:void 0}if(!E){const e=(0,web_helpers_1.isSecureWebRequest)(r)?"; Secure":"",s=[`__unshared_uid=; Path=/; SameSite=Lax; Max-Age=0${e}`,`__unshared_uid_at=; Path=/; SameSite=Lax; Max-Age=0${e}`,`__unshared_sid=; Path=/; SameSite=Lax; Max-Age=0${e}`,`__unshared_email=; Path=/; SameSite=Lax; Max-Age=0${e}`];return injectIntoHtmlResponse(await n(r),g,s)}const R=resolveEmail(r,t),T=[],C=(0,web_helpers_1.isSecureWebRequest)(r)?"; Secure":"";if(T.push(`__unshared_uid=${encodeURIComponent(E)}; Path=/; SameSite=Lax${C}`),T.push(`__unshared_uid_at=${Date.now()}; Path=/; SameSite=Lax${C}`),R&&T.push(`__unshared_email=${encodeURIComponent(R)}; HttpOnly; Path=/; SameSite=Lax${C}`),!R)return injectIntoHtmlResponse(await n(r),g,T);const O=extractSessionIdFromRequest(r,c),$=(0,web_helpers_1.extractDeviceIdFromRequest)(r,_),x=(0,web_helpers_1.parseCookieFromRequest)(r,"__unshared_fingerprint_id")||void 0,P=r.headers.get("user-agent")??"",k=(0,web_helpers_1.extractClientIpFromRequest)(r),L=$??x;if((0,is_bot_1.isBot)(P))return n(r);let N=h.get(E);if(N)h.isStale(E)&&!h.isRefreshing(E)&&(h.markRefreshing(E),fetchAndCacheVerdict(e,h,E,R,L??"unknown",x,O).finally(()=>h.clearRefreshing(E)));else try{N=await fetchAndCacheVerdict(e,h,E,R,L??"unknown",x,O)}catch{return injectIntoHtmlResponse(await n(r),g,T)}if(N.isFlagged&&!N.isVerified&&u)try{const e=await u({userId:E,emailAddress:R,verdict:N,request:r});if(e)return injectIntoHtmlResponse(e,g,T)}catch(e){p&&p(e,{operation:"checkUser",userId:E,emailAddress:R})}return N.isFlagged||"unknown"===O||!L||f.isPaused()||dispatchUserEvent(e,h,f,m,{userId:E,emailAddress:R,sessionId:O,deviceId:L,fingerprintId:x,userAgent:P,ipAddress:k,eventType:a+w},p),injectIntoHtmlResponse(await n(r),g,T)}}async function injectIntoHtmlResponse(e,r,s){const t=e.headers.get("content-type");if(!(0,content_type_1.isHtmlContentType)(t??void 0)){if(!s||0===s.length)return e;const r=(0,web_helpers_1.mergeResponseHeaders)(e.headers,void 0,s);return new Response(e.body,{status:e.status,statusText:e.statusText,headers:r})}const i=await e.text(),n=i.lastIndexOf("</body>"),a=-1===n?i+r:i.slice(0,n)+r+i.slice(n),o=(0,web_helpers_1.mergeResponseHeaders)(e.headers,{"Cache-Control":"no-store","Content-Length":String((new TextEncoder).encode(a).length)},s);return o.delete("ETag"),o.delete("Last-Modified"),o.delete("Content-Encoding"),new Response(a,{status:e.status,statusText:e.statusText,headers:o})}function resolveEmail(e,r){if(r)try{const s=r(e);if(s)return s}catch{}const s=(0,web_helpers_1.parseCookieFromRequest)(e,"__unshared_email");if(s)return s}function resolveEmailWithBody(e,r,s){const t=resolveEmail(e,s);if(t)return t;const i=r.email;return"string"==typeof i&&i?i:void 0}function extractSessionIdFromRequest(e,r){if(r)try{const s=r(e);if(s)return s}catch{}return(0,web_helpers_1.parseCookieFromRequest)(e,"__unshared_sid")??"unknown"}function dispatchUserEvent(e,r,s,t,i,n){t.mark(i.userId,i.eventType),e.processUserEvent({eventType:i.eventType,userId:i.userId,emailAddress:i.emailAddress,ipAddress:i.ipAddress,deviceId:i.deviceId,fingerprintId:i.fingerprintId,sessionHash:i.sessionId,userAgent:i.userAgent}).then(e=>{e.success&&e.data?.analysis&&r.update(i.userId,{isFlagged:e.data.analysis.is_user_flagged}),!e.success&&e.error?.retryAfter&&s.pause(1e3*e.error.retryAfter)}).catch(e=>{n&&n(e,{operation:"processUserEvent",userId:i.userId,emailAddress:i.emailAddress})})}async function fetchAndCacheVerdict(e,r,s,t,i,n,a){const o={};let d;i&&"unknown"!==i&&(o.deviceId=i),n&&(o.fingerprintId=n);const c=await Promise.race([e.checkUser(t,o),new Promise(e=>{d=setTimeout(()=>e(null),500)})]);if(clearTimeout(d),!c)return{isFlagged:!1,isVerified:!1,emailAddress:t,sessionId:a,cachedAt:0,ttl:0};const _=c.data?.is_user_flagged??!1;return r.set(s,{isFlagged:_,isVerified:!1,emailAddress:t,sessionId:a}),r.get(s)}async function handleSubmitFp(e,r,s,t){try{const i={full_hash:r.hash??"",fingerprint_id:r.stable_hash??"",timestamp:r.collected_at??(new Date).toISOString(),isIncognito:r.is_incognito??!1,components:r.components??{},version:r.version??"inline-1.0.0"};let n,a,o;try{const r=s.resolveUserId(e);r&&!(0,sentinel_user_id_1.isSentinelUserId)(r)&&(n=r)}catch{}if(!n){const e="string"==typeof r.user_id?r.user_id:void 0;e&&!(0,sentinel_user_id_1.isSentinelUserId)(e)&&(n=e)}if(!n){const r=(0,web_helpers_1.parseCookieFromRequest)(e,"__unshared_uid");r&&!(0,sentinel_user_id_1.isSentinelUserId)(r)&&(n=r)}try{a=s.resolveEmailAddress?s.resolveEmailAddress(e):void 0}catch{}a=a??(0,web_helpers_1.parseCookieFromRequest)(e,"__unshared_email")??r.email??void 0;try{o=s.resolveSessionId?s.resolveSessionId(e):void 0}catch{}o=o??r.session_id??(0,web_helpers_1.parseCookieFromRequest)(e,"__unshared_sid");const d=(0,web_helpers_1.extractClientIpFromRequest)(e),c=e.headers.get("user-agent")??"";if((0,is_bot_1.isBot)(c))return(0,web_helpers_1.jsonResponse)(200,{success:!0},t);const _=(i.fingerprint_id&&i.fingerprint_id.length>0?i.fingerprint_id:void 0)??(0,web_helpers_1.extractDeviceIdFromRequestOrUnknown)(e,s.resolveDeviceId),l=i.fingerprint_id||void 0,u=i.full_hash||void 0,p=(0,web_helpers_1.isSecureWebRequest)(e)?"; Secure":"",h=[];if(u&&!(0,web_helpers_1.parseCookieFromRequest)(e,"__unshared_fingerprint_id")&&h.push(`__unshared_fingerprint_id=${encodeURIComponent(u)}; HttpOnly; Path=/; SameSite=Lax${p}`),l){const r=(0,web_helpers_1.parseCookieFromRequest)(e,"__unshared_fp_id");r&&r===l||h.push(`__unshared_fp_id=${encodeURIComponent(l)}; Path=/; SameSite=Lax; Max-Age=31536000${p}`)}let f;if(a&&!(0,web_helpers_1.parseCookieFromRequest)(e,"__unshared_email")&&h.push(`__unshared_email=${encodeURIComponent(a)}; HttpOnly; Path=/; SameSite=Lax${p}`),"string"==typeof r.event_type&&r.event_type)f=r.event_type;else{const r=e.headers.get("referer")??e.headers.get("referrer");let s="unknown";if(r)try{const e=new URL(r);s=(e.pathname||"/")+(e.search||"")}catch{}f=s}const m=e.headers.get("x-idempotency-key")||void 0,w=Date.now(),g=m?`${m}|${w}`:l&&n?`${l}|${n}|${f}|${w}`:void 0;n&&s.client.submitFingerprintEvent(i,{userId:n,emailAddress:a,sessionHash:o,eventType:f,ipAddress:d,userAgent:c,idempotencyKey:g}).catch(e=>{s.onError&&s.onError(e,{operation:"submitFingerprintEvent",userId:n,emailAddress:a})}),n&&a&&!s.rateLimitBackoff.isPaused()&&!s.dispatchDedupe.wasRecentlyDispatched(n,f)&&s.client.processUserEvent({eventType:f,userId:n,emailAddress:a,ipAddress:d,deviceId:_,fingerprintId:l,sessionHash:o??"unknown",userAgent:c}).then(e=>{e.success&&e.data?.analysis&&s.verdictCache.update(n,{isFlagged:e.data.analysis.is_user_flagged}),!e.success&&e.error?.retryAfter&&s.rateLimitBackoff.pause(1e3*e.error.retryAfter)}).catch(e=>{s.onError&&s.onError(e,{operation:"processUserEvent",userId:n,emailAddress:a})});const b={...t,"Content-Type":"application/json"},v=new Response(JSON.stringify({success:!0}),{status:200,headers:b});for(const e of h)v.headers.append("Set-Cookie",e);return v}catch{return(0,web_helpers_1.jsonResponse)(200,{success:!0},t)}}async function handleVerifyTriggerWeb(e,r,s,t){try{const i=resolveEmailWithBody(e,r??{},s.resolveEmailAddress);if(!i)return(0,web_helpers_1.jsonResponse)(400,{success:!1,error:{code:"VALIDATION_ERROR",message:"Email is required"}},t);const n=(0,web_helpers_1.extractDeviceIdFromRequestOrUnknown)(e,s.resolveDeviceId),a=(0,web_helpers_1.parseCookieFromRequest)(e,"__unshared_fingerprint_id")||void 0,o=await s.client.triggerEmailVerification(i,n,{fingerprintId:a});return o.success?(0,web_helpers_1.jsonResponse)(200,{success:!0,data:o.data},t):(0,web_helpers_1.jsonResponse)(200,{success:!1,error:o.error??{code:"TRIGGER_FAILED",message:"Failed to send verification email"}},t)}catch(e){return s.onError&&s.onError(e,{operation:"verifyTrigger"}),(0,web_helpers_1.jsonResponse)(200,{success:!1,error:{code:"INTERNAL_ERROR",message:"Failed to trigger verification"}},t)}}async function handleVerifyWeb(e,r,s,t){try{const i=resolveEmailWithBody(e,r??{},s.resolveEmailAddress),n=r?.code;if(!i||!n)return(0,web_helpers_1.jsonResponse)(400,{success:!1,error:{code:"VALIDATION_ERROR",message:"Email and code are required"}},t);const a=(0,web_helpers_1.extractDeviceIdFromRequestOrUnknown)(e,s.resolveDeviceId),o=(0,web_helpers_1.parseCookieFromRequest)(e,"__unshared_fingerprint_id")||void 0,d=await s.client.verify(i,a,n,{fingerprintId:o});if(d.success){const r=(0,web_helpers_1.parseCookieFromRequest)(e,"__unshared_uid");return r&&s.verdictCache.update(r,{isVerified:!0}),(0,web_helpers_1.jsonResponse)(200,{success:!0,data:{verified:!0}},t)}return(0,web_helpers_1.jsonResponse)(200,{success:!1,error:d.error??{code:"VERIFICATION_FAILED",message:"Verification failed"}},t)}catch(e){return s.onError&&s.onError(e,{operation:"verify"}),(0,web_helpers_1.jsonResponse)(200,{success:!1,error:{code:"INTERNAL_ERROR",message:"Verification failed"}},t)}}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { UnsharedClient } from '../client';
|
|
2
|
+
import type { WebSubmitOptions } from './types';
|
|
3
|
+
/**
|
|
4
|
+
* Web Standard equivalent of `createUnsharedMiddleware` from src/middleware.ts.
|
|
5
|
+
*
|
|
6
|
+
* Returns a handler `(request: Request) => Promise<Response>` suitable for
|
|
7
|
+
* Next.js App Router Route Handlers, Vercel Edge Functions, Cloudflare
|
|
8
|
+
* Workers, Deno Deploy, and any other Web Standard runtime.
|
|
9
|
+
*
|
|
10
|
+
* @example Next.js App Router
|
|
11
|
+
* ```typescript
|
|
12
|
+
* // app/unshared/submit-fingerprint-event/route.ts
|
|
13
|
+
* import { createWebSubmitHandler } from 'unshared-clientjs-sdk/web';
|
|
14
|
+
* import { UnsharedClient } from 'unshared-clientjs-sdk';
|
|
15
|
+
*
|
|
16
|
+
* const client = new UnsharedClient({ apiKey: '...', clientId: '...' });
|
|
17
|
+
* const handler = createWebSubmitHandler(client);
|
|
18
|
+
*
|
|
19
|
+
* export const POST = handler;
|
|
20
|
+
* export const OPTIONS = handler;
|
|
21
|
+
* ```
|
|
22
|
+
*
|
|
23
|
+
* **Error contract:** Never returns 5xx. Upstream failures return HTTP 200
|
|
24
|
+
* with `{ success: false, error: { code: "UPSTREAM_ERROR" } }`. Same contract
|
|
25
|
+
* as the Node.js middleware.
|
|
26
|
+
*/
|
|
27
|
+
export declare function createWebSubmitHandler(client: UnsharedClient, options?: WebSubmitOptions): (request: Request) => Promise<Response>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"t",{value:!0}),exports.createWebSubmitHandler=createWebSubmitHandler;const web_helpers_1=require("./web-helpers");function createWebSubmitHandler(e,r){const{userIdExtractor:s,eventTypeExtractor:t,sessionIdExtractor:n,ipAddressExtractor:o,defaultEventType:c="browser_event",routePrefix:i="/unshared",corsOrigins:a}=r??{},d=`${i}/submit-fingerprint-event`,u=a?Array.isArray(a)?a:[a]:null;return async r=>{let i;try{i=new URL(r.url).pathname}catch{return(0,web_helpers_1.jsonResponse)(400,{success:!1,error:{code:"INVALID_URL",message:"Unable to parse request URL"}})}const a=u&&i===d?function(e){if(!u)return{};const r=e.headers.get("origin")??"",s=u.includes("*");return s||u.includes(r)?{"Access-Control-Allow-Origin":s?"*":r,"Access-Control-Allow-Methods":"POST, OPTIONS","Access-Control-Allow-Headers":"Content-Type, X-Idempotency-Key, X-Session-Id"}:{}}(r):{};if("OPTIONS"===r.method&&i===d)return(0,web_helpers_1.emptyResponse)(204,a);if("POST"!==r.method||i!==d)return(0,web_helpers_1.jsonResponse)(404,{success:!1,error:{code:"NOT_FOUND",message:"Unknown route"}},a);try{let i;try{i=await r.json()}catch{return(0,web_helpers_1.jsonResponse)(400,{success:!1,error:{code:"BODY_PARSER_MISSING",message:"Request body is not valid JSON."}},a)}if(!(i&&i.hash&&i.stable_hash&&i.collected_at))return(0,web_helpers_1.jsonResponse)(400,{success:!1,error:{code:"VALIDATION_ERROR",message:"Missing required fingerprint fields: hash, stable_hash, collected_at"}},a);if(!r.headers.get("x-session-id"))return(0,web_helpers_1.jsonResponse)(400,{success:!1,error:{code:"VALIDATION_ERROR",message:"Missing required header: X-Session-Id"}},a);const d={full_hash:i.hash,fingerprint_id:i.stable_hash,timestamp:i.collected_at,isIncognito:i.is_incognito??!1,components:i.components??{},version:i.version??"unknown"};let u,l,_,h;try{u=(s?s(r):void 0)??i.user_id}catch{u=i.user_id}if(!u)return(0,web_helpers_1.jsonResponse)(400,{success:!1,error:{code:"VALIDATION_ERROR",message:"Missing required field: user_id"}},a);try{l=(t?t(r):void 0)??i.event_type??c}catch{l=i.event_type??c}try{_=(n?n(r):void 0)??r.headers.get("x-session-id")??i.session_id}catch{_=r.headers.get("x-session-id")??i.session_id}const p=(0,web_helpers_1.extractClientIpFromRequest)(r);try{h=(o?o(r):void 0)??p}catch{h=p}const b=await e.submitFingerprintEvent(d,{userId:u,sessionHash:_,eventType:l,ipAddress:h});return b.success?(0,web_helpers_1.jsonResponse)(202,{success:!0,data:b.data},a):(0,web_helpers_1.jsonResponse)(200,{success:!1,error:{code:"UPSTREAM_ERROR",message:b.error?.message??"Upstream request failed"}},a)}catch(e){return(0,web_helpers_1.jsonResponse)(200,{success:!1,error:{code:"MIDDLEWARE_ERROR",message:e instanceof Error?e.message:"Handler error"}},a)}}}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Web Standard Request/Response handler types for serverless/edge environments.
|
|
3
|
+
*
|
|
4
|
+
* These types use the global `Request` and `Response` from the Fetch API,
|
|
5
|
+
* available in: Next.js App Router Route Handlers, Vercel Edge Functions,
|
|
6
|
+
* Cloudflare Workers, Deno Deploy, Bun, and Node.js 18+.
|
|
7
|
+
*
|
|
8
|
+
* The DOM lib reference above scopes the Fetch API globals to this file only,
|
|
9
|
+
* avoiding `window`/`document` pollution in the Node.js middleware code.
|
|
10
|
+
*/
|
|
11
|
+
import type { Verdict } from '../middleware/verdict-cache';
|
|
12
|
+
/** A downstream handler that returns a Response. */
|
|
13
|
+
export type WebHandler = (request: Request) => Response | Promise<Response>;
|
|
14
|
+
/** Middleware that wraps a downstream handler, optionally intercepting the response. */
|
|
15
|
+
export type WebMiddleware = (request: Request, next: WebHandler) => Response | Promise<Response>;
|
|
16
|
+
export interface WebSubmitOptions {
|
|
17
|
+
/** Override userId extractor. Falls back to body.user_id. */
|
|
18
|
+
userIdExtractor?: (req: Request) => string | undefined;
|
|
19
|
+
/** Override eventType extractor. Falls back to body.event_type. */
|
|
20
|
+
eventTypeExtractor?: (req: Request) => string | undefined;
|
|
21
|
+
/** Override sessionId extractor. Falls back to X-Session-Id header, then body.session_id. */
|
|
22
|
+
sessionIdExtractor?: (req: Request) => string | undefined;
|
|
23
|
+
/** Override IP address extractor. Falls back to CF-Connecting-IP / X-Real-IP / X-Forwarded-For headers. */
|
|
24
|
+
ipAddressExtractor?: (req: Request) => string | undefined;
|
|
25
|
+
/** Default event type when none is extractable. @default "browser_event" */
|
|
26
|
+
defaultEventType?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Route prefix the handler responds under.
|
|
29
|
+
* @default "/unshared"
|
|
30
|
+
*/
|
|
31
|
+
routePrefix?: string;
|
|
32
|
+
/**
|
|
33
|
+
* Allowed CORS origins for the fingerprint route.
|
|
34
|
+
* Use `"*"` to allow all origins, or pass a specific origin / array of origins.
|
|
35
|
+
* The handler handles OPTIONS preflight automatically when this is set.
|
|
36
|
+
*/
|
|
37
|
+
corsOrigins?: string | string[];
|
|
38
|
+
}
|
|
39
|
+
export interface WebProtectionConfig {
|
|
40
|
+
/**
|
|
41
|
+
* Required. Resolves the current user's ID from the request.
|
|
42
|
+
* Return undefined for anonymous/logged-out visitors.
|
|
43
|
+
*/
|
|
44
|
+
userId: (req: Request) => string | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* Resolves the current user's email address from the request.
|
|
47
|
+
* Falls back to HttpOnly cookie → request body when not configured.
|
|
48
|
+
*/
|
|
49
|
+
emailAddress?: (req: Request) => string | undefined;
|
|
50
|
+
/** Route prefix for internal routes. @default "/__unshared" */
|
|
51
|
+
routePrefix?: string;
|
|
52
|
+
/** Allowed CORS origins for /__unshared/* routes. */
|
|
53
|
+
corsOrigins?: string | string[];
|
|
54
|
+
/** Verdict cache TTL in ms. @default 60000 */
|
|
55
|
+
cacheTTL?: number;
|
|
56
|
+
/** Paths to skip entirely (static assets, health checks). */
|
|
57
|
+
skipPaths?: string[];
|
|
58
|
+
/** When set, only paths matching one of these prefixes get events dispatched and checkUser called. */
|
|
59
|
+
includePathPrefix?: string[];
|
|
60
|
+
/** Resolves a custom session ID. Falls back to __unshared_sid cookie. */
|
|
61
|
+
sessionId?: (req: Request) => string | undefined;
|
|
62
|
+
/**
|
|
63
|
+
* Resolves a device ID from the request.
|
|
64
|
+
* Falls back to X-Device-Id header → __unshared_fp_id cookie.
|
|
65
|
+
*/
|
|
66
|
+
deviceId?: (req: Request) => string | undefined;
|
|
67
|
+
/**
|
|
68
|
+
* Inline JavaScript bundle for the frontend SDK, served at /__unshared/fp.js.
|
|
69
|
+
*
|
|
70
|
+
* In Node.js environments the middleware reads this from node_modules via
|
|
71
|
+
* `require.resolve('unshared-frontend-sdk/dist/index.umd.js')`. Edge runtimes
|
|
72
|
+
* do not have filesystem access, so the bundle must be passed as a string
|
|
73
|
+
* (typically imported via a bundler):
|
|
74
|
+
*
|
|
75
|
+
* ```typescript
|
|
76
|
+
* import fingerprintSdkBundle from 'unshared-frontend-sdk/dist/index.umd.js?raw';
|
|
77
|
+
* createWebProtectionMiddleware(client, { ..., fingerprintSdkBundle });
|
|
78
|
+
* ```
|
|
79
|
+
*
|
|
80
|
+
* If omitted, the fp.js route returns 404. The inline script degrades
|
|
81
|
+
* gracefully — the cached-fingerprint path still works.
|
|
82
|
+
*/
|
|
83
|
+
fingerprintSdkBundle?: string;
|
|
84
|
+
/**
|
|
85
|
+
* Called when a flagged, unverified user makes a request.
|
|
86
|
+
*
|
|
87
|
+
* Return a `Response` to block/redirect, or `null` to pass through (injection
|
|
88
|
+
* still happens). Exceptions are caught — the request passes through on error.
|
|
89
|
+
*
|
|
90
|
+
* This differs from the Node.js middleware: in Web Standard environments
|
|
91
|
+
* Response objects are immutable, so the callback returns a new Response
|
|
92
|
+
* rather than mutating an existing one.
|
|
93
|
+
*/
|
|
94
|
+
onFlagged?: (context: {
|
|
95
|
+
userId: string;
|
|
96
|
+
emailAddress: string;
|
|
97
|
+
verdict: Verdict;
|
|
98
|
+
request: Request;
|
|
99
|
+
}) => Response | Promise<Response> | null;
|
|
100
|
+
/**
|
|
101
|
+
* Called when a background SDK operation fails (fire-and-forget API calls,
|
|
102
|
+
* verdict refreshes, etc.). Use this to pipe errors to your logging or
|
|
103
|
+
* monitoring system for observability.
|
|
104
|
+
*/
|
|
105
|
+
onError?: (error: unknown, context: {
|
|
106
|
+
operation: 'processUserEvent' | 'submitFingerprintEvent' | 'checkUser' | 'verifyTrigger' | 'verify';
|
|
107
|
+
userId?: string;
|
|
108
|
+
emailAddress?: string;
|
|
109
|
+
}) => void;
|
|
110
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,"t",{value:!0});
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Thin adapter functions that bridge Web Standard `Request`/`Response` to the
|
|
3
|
+
* data shapes the rest of the SDK expects. These mirror the Node.js
|
|
4
|
+
* `src/middleware/utils/*` functions but read from Web Standard Headers
|
|
5
|
+
* instead of Node.js `req.headers` objects.
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* Reads a single cookie value from the raw Cookie header.
|
|
9
|
+
* Mirrors `parseCookie(req, name)` in src/middleware/utils/cookies.ts.
|
|
10
|
+
*/
|
|
11
|
+
export declare function parseCookieFromRequest(request: Request, name: string): string | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* Extract the real client IP from proxy headers. Web Standard has no
|
|
14
|
+
* equivalent of `req.ip` or `req.socket.remoteAddress`, so we rely entirely
|
|
15
|
+
* on standard proxy headers (which all edge platforms populate).
|
|
16
|
+
*
|
|
17
|
+
* Priority: CF-Connecting-IP → X-Real-IP → X-Forwarded-For (first entry).
|
|
18
|
+
*/
|
|
19
|
+
export declare function extractClientIpFromRequest(request: Request): string;
|
|
20
|
+
/**
|
|
21
|
+
* Resolves device ID from: custom resolver → X-Device-Id header → __unshared_fp_id cookie.
|
|
22
|
+
* Mirrors `extractDeviceIdOrUndefined` in src/middleware/utils/device-id.ts.
|
|
23
|
+
*/
|
|
24
|
+
export declare function extractDeviceIdFromRequest(request: Request, resolveDeviceId?: (req: Request) => string | undefined): string | undefined;
|
|
25
|
+
/** Same as extractDeviceIdFromRequest but returns "unknown" when nothing is available. */
|
|
26
|
+
export declare function extractDeviceIdFromRequestOrUnknown(request: Request, resolveDeviceId?: (req: Request) => string | undefined): string;
|
|
27
|
+
/**
|
|
28
|
+
* Returns true if the request arrived over HTTPS.
|
|
29
|
+
*
|
|
30
|
+
* Web Standard has no `socket.encrypted`, so this checks:
|
|
31
|
+
* 1. The `x-forwarded-proto` header (set by reverse proxies / load balancers)
|
|
32
|
+
* 2. The URL protocol (for direct HTTPS requests)
|
|
33
|
+
*/
|
|
34
|
+
export declare function isSecureWebRequest(request: Request): boolean;
|
|
35
|
+
/**
|
|
36
|
+
* Build a JSON response. Mirrors `sendJson(res, status, data)` in
|
|
37
|
+
* src/middleware/utils/http-helpers.ts, but returns a new Response instead
|
|
38
|
+
* of mutating one.
|
|
39
|
+
*/
|
|
40
|
+
export declare function jsonResponse(statusCode: number, data: unknown, extraHeaders?: HeadersInit): Response;
|
|
41
|
+
/** Build a status-only response with no body. */
|
|
42
|
+
export declare function emptyResponse(statusCode: number, extraHeaders?: HeadersInit): Response;
|
|
43
|
+
/** Build a raw-body response (for the fp.js bundle). */
|
|
44
|
+
export declare function bodyResponse(statusCode: number, body: string, extraHeaders?: HeadersInit): Response;
|
|
45
|
+
/**
|
|
46
|
+
* Append a Set-Cookie header to a Headers object. Web Standard `Headers`
|
|
47
|
+
* supports multiple Set-Cookie values via `.append()`.
|
|
48
|
+
*/
|
|
49
|
+
export declare function appendCookieToHeaders(headers: Headers, cookieValue: string): void;
|
|
50
|
+
/**
|
|
51
|
+
* Merge a downstream Response's headers with additional Set-Cookie entries
|
|
52
|
+
* and overrides. Preserves multiple Set-Cookie values from the source
|
|
53
|
+
* response via `getSetCookie()` (Node 20+, all modern edge runtimes).
|
|
54
|
+
*/
|
|
55
|
+
export declare function mergeResponseHeaders(source: Headers, overrides?: Record<string, string>, extraCookies?: string[]): Headers;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";function parseCookieFromRequest(e,t){const o=e.headers.get("cookie");if(!o)return;const n=o.match(new RegExp(`(?:^|; )${t}=([^;]*)`));return n?decodeURIComponent(n[1]):void 0}function extractClientIpFromRequest(e){const t=e.headers.get("cf-connecting-ip");if(t)return t;const o=e.headers.get("x-real-ip");if(o)return o;const n=e.headers.get("x-forwarded-for");if(n){const e=n.split(",")[0]?.trim();if(e)return e}return""}function extractDeviceIdFromRequest(e,t){if(t)try{const o=t(e);if(o)return o}catch{}const o=e.headers.get("x-device-id");if(o)return o;return parseCookieFromRequest(e,"__unshared_fp_id")||void 0}function extractDeviceIdFromRequestOrUnknown(e,t){return extractDeviceIdFromRequest(e,t)??"unknown"}function isSecureWebRequest(e){if("https"===e.headers.get("x-forwarded-proto"))return!0;try{return"https:"===new URL(e.url).protocol}catch{return!1}}function jsonResponse(e,t,o){const n=new Headers(o);return n.set("Content-Type","application/json"),new Response(JSON.stringify(t),{status:e,headers:n})}function emptyResponse(e,t){return new Response(null,{status:e,headers:new Headers(t)})}function bodyResponse(e,t,o){return new Response(t,{status:e,headers:new Headers(o)})}function appendCookieToHeaders(e,t){e.append("Set-Cookie",t)}function mergeResponseHeaders(e,t,o){const n=new Headers;e.forEach((e,t)=>{"set-cookie"!==t.toLowerCase()&&n.set(t,e)});const r="function"==typeof e.getSetCookie?e.getSetCookie():[];for(const e of r)n.append("Set-Cookie",e);if(o)for(const e of o)n.append("Set-Cookie",e);if(t)for(const[e,o]of Object.entries(t))n.set(e,o);return n}Object.defineProperty(exports,"t",{value:!0}),exports.parseCookieFromRequest=parseCookieFromRequest,exports.extractClientIpFromRequest=extractClientIpFromRequest,exports.extractDeviceIdFromRequest=extractDeviceIdFromRequest,exports.extractDeviceIdFromRequestOrUnknown=extractDeviceIdFromRequestOrUnknown,exports.isSecureWebRequest=isSecureWebRequest,exports.jsonResponse=jsonResponse,exports.emptyResponse=emptyResponse,exports.bodyResponse=bodyResponse,exports.appendCookieToHeaders=appendCookieToHeaders,exports.mergeResponseHeaders=mergeResponseHeaders;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "unshared-clientjs-sdk",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"description": "Server-side Node.js SDK for the Unshared Labs V2 API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/esm/index.mjs",
|
|
@@ -38,6 +38,11 @@
|
|
|
38
38
|
"import": "./dist/esm/middleware/index.mjs",
|
|
39
39
|
"require": "./dist/middleware/index.js",
|
|
40
40
|
"types": "./dist/middleware/index.d.ts"
|
|
41
|
+
},
|
|
42
|
+
"./web": {
|
|
43
|
+
"import": "./dist/esm/web/index.mjs",
|
|
44
|
+
"require": "./dist/web/index.js",
|
|
45
|
+
"types": "./dist/web/index.d.ts"
|
|
41
46
|
}
|
|
42
47
|
},
|
|
43
48
|
"engines": {
|
|
@@ -46,16 +51,8 @@
|
|
|
46
51
|
"keywords": [],
|
|
47
52
|
"author": "",
|
|
48
53
|
"license": "MIT",
|
|
49
|
-
"peerDependencies": {
|
|
50
|
-
"@types/express": ">=4"
|
|
51
|
-
},
|
|
52
|
-
"peerDependenciesMeta": {
|
|
53
|
-
"@types/express": {
|
|
54
|
-
"optional": true
|
|
55
|
-
}
|
|
56
|
-
},
|
|
57
54
|
"dependencies": {
|
|
58
|
-
"unshared-frontend-sdk": "
|
|
55
|
+
"unshared-frontend-sdk": "2.0.1"
|
|
59
56
|
},
|
|
60
57
|
"devDependencies": {
|
|
61
58
|
"@types/express": "^4.17.21",
|