@founderroute/analytics-node 0.1.0-beta.1 → 1.0.0-rc.1

package/index.d.ts

@@ -1,6 +1,6 @@
 export function signIdentity(input:{secret:string;propertyId:string;userId:string;expiresInSeconds?:number}):string;
 export class FounderRouteServer {
   constructor(options:{secret:string;endpoint:string;fetch?:typeof fetch});
-  event(name:string,input:{consent:boolean;verificationId?:string;userId:string;anonymousId:string;eventId?:string;outcomeId?:string;accountId?:string;occurredAt?:string;traits?:Record<string,unknown>;properties?:Record<string,unknown>}):Record<string,unknown>|null;
+  event(name:string,input:{collectionMode?:"automatic"|"consent";consentState?:"not_provided"|"granted"|"denied";optedOut?:boolean;consent?:boolean;verificationId?:string;userId:string;anonymousId:string;eventId?:string;outcomeId?:string;accountId?:string;occurredAt?:string;traits?:Record<string,unknown>;properties?:Record<string,unknown>}):Record<string,unknown>|null;
   send(events:Array<Record<string,unknown>|null>):Promise<{results:Array<{event_id:string;status:string;reason?:string}>}>;
 }

package/index.js

@@ -7,16 +7,24 @@ export function signIdentity({secret,propertyId,userId,expiresInSeconds=3600}) {
 }
 export class FounderRouteServer {
   constructor({secret,endpoint,fetch:transport=globalThis.fetch}) { if(!secret?.startsWith("fr_sk_"))throw new Error("A server ingest secret is required.");this.secret=secret;this.endpoint=endpoint.replace(/\/$/,"");this.fetch=transport; }
-  event(name,{consent,userId,anonymousId,eventId=randomUUID(),outcomeId,accountId,occurredAt=new Date().toISOString(),traits={},properties={},verificationId}) {
-    if(consent!==true)return null;
+  event(name,{collectionMode,consentState,optedOut=false,consent,userId,anonymousId,eventId=randomUUID(),outcomeId,accountId,occurredAt=new Date().toISOString(),traits={},properties={},verificationId}) {
+    if (collectionMode != null && !['automatic','consent'].includes(collectionMode)) throw new Error('Invalid collection mode');
+    if (consentState != null && !['not_provided','granted','denied'].includes(consentState)) throw new Error('Invalid consent state');
+    if (optedOut || consent === false || consentState === 'denied') return null;
+    const mode = collectionMode ?? 'consent';
+    const granted = consentState === 'granted' || consent === true;
+    if (mode === 'consent' && !granted) return null;
+    const collection = collectionMode == null
+      ? {protocol:1,consent:true}
+      : {protocol:2,collection_mode:mode,consent_state:granted?'granted':'not_provided'};
     if(!userId||!anonymousId)throw new Error("Pass a stable user ID and the originating anonymous ID.");
-    return {event_id:eventId,protocol:1,name,kind:"custom",consent:true,occurred_at:occurredAt,anonymous_id:anonymousId,user_id:userId,...(outcomeId?{outcome_id:outcomeId}:{}),...(accountId?{account_id:accountId}:{}),traits,properties,context:{sdk:"node",sdk_version:"0.1.0-beta.1",...(verificationId?{verification_id:verificationId}:{})}};
+    return {event_id:eventId,...collection,name,kind:"custom",occurred_at:occurredAt,anonymous_id:anonymousId,user_id:userId,...(outcomeId?{outcome_id:outcomeId}:{}),...(accountId?{account_id:accountId}:{}),traits,properties,context:{sdk:"node",sdk_version:"1.0.0-rc.1",...(verificationId?{verification_id:verificationId}:{})}};
   }
   async send(events) {
     const batch=events.filter(Boolean);if(!batch.length)return {results:[]};
     if(batch.length>50)throw new Error("Send at most 50 events per batch.");
     const body=JSON.stringify({events:batch});if(Buffer.byteLength(body)>65536)throw new Error("Batch exceeds 64 KiB.");
-    const response=await this.fetch(`${this.endpoint}/api/analytics/v1/server-events`,{method:"POST",headers:{"Content-Type":"application/json",Authorization:`Bearer ${this.secret}`},body});
+    const response=await this.fetch(`${this.endpoint}/api/analytics/v${batch.some(event=>event.protocol===2)?2:1}/server-events`,{method:"POST",headers:{"Content-Type":"application/json",Authorization:`Bearer ${this.secret}`},body});
     const result=await response.json();if(!response.ok){const error=new Error(result.error??"Analytics delivery failed");error.status=response.status;error.retryAfter=response.headers.get("Retry-After");throw error;}return result;
   }
 }

package/package.json

@@ -1,15 +1,30 @@
 {
   "name": "@founderroute/analytics-node",
-  "version": "0.1.0-beta.1",
+  "version": "1.0.0-rc.1",
   "description": "FounderRoute server analytics SDK for verified outcomes and identity assertions",
   "type": "module",
   "main": "index.js",
   "types": "index.d.ts",
-  "files": ["index.js", "index.d.ts", "LICENSE"],
-  "engines": { "node": ">=20" },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
   "license": "MIT",
-  "repository": { "type": "git", "url": "git+https://github.com/itsreed/founderroute-analytics.git", "directory": "packages/node" },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/itsreed/founderroute-analytics.git",
+    "directory": "packages/node"
+  },
   "homepage": "https://github.com/itsreed/founderroute-analytics#readme",
-  "bugs": { "url": "https://github.com/itsreed/founderroute-analytics/issues" },
-  "publishConfig": { "access": "public", "provenance": true }
+  "bugs": {
+    "url": "https://github.com/itsreed/founderroute-analytics/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
 }