@shware/analytics 11.1.0 → 11.3.0

package/dist/visitor/index.cjs

@@ -1,38 +1,33 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_setup_index = require("../setup/index.cjs");
-const require_constants_storage = require("../constants/storage.cjs");
-let _shware_utils = require("@shware/utils");
-let uuid = require("uuid");
+const require_visitor_id = require("./id.cjs");
+const require_track_index = require("../track/index.cjs");
 //#region src/visitor/index.ts
 /**
-* This visitor's id: generated here on the first visit (uuidv7) and kept in `config.storage`, so
-* it exists the moment the page loads. The first events, and the beacon of a visit left within a
-* second, go out without waiting for a round trip; the server creates the visitor from its first
-* events. An id a server issued to an older client is kept as it is: the visitor continues.
+* The event that binds the visitor to the user who signed in on it: the server sets the visitor's
+* `user_id` and `distinct_id` from its `user_id` property, in the transaction that stores the
+* batch — which also creates the visitor when it is new, so the binding can never arrive before it.
+*/
+const IDENTIFY_EVENT = "identify";
+/** The user this page has identified the visitor as: identify once per user, not per call. */
+let identified;
+/**
+* Hands the signed-in user to the analytics: the third-party user setters (gtag, the pixels) now,
+* and the server through an `identify` event, sent when the user differs from the one this page
+* last identified — a host calls this on every page load once someone is signed in. Like any
+* event it goes with the next batch or the page-hide beacon; `user_data` is handed to the setters
+* only, never stored with the event.
 *
-* Needs a server that creates visitors from events (see the README, "Visitors"); one that still
-* only creates them on `POST /visitors` rejects the events of a new visitor.
+* Synchronous and never throws: sign-in must not fail on analytics.
 */
-function visitorId() {
-	const stored = require_setup_index.config.storage.getItem(require_constants_storage.keys.visitor_id);
-	if (stored && stored !== "undefined") return stored;
-	const id = (0, uuid.v7)();
-	require_setup_index.config.storage.setItem(require_constants_storage.keys.visitor_id, id);
-	return id;
-}
-async function setVisitor(dto) {
-	const id = visitorId();
-	const response = await (0, _shware_utils.fetch)(`${require_setup_index.config.endpoint}/visitors/${id}`, {
-		method: "PATCH",
-		credentials: "include",
-		headers: await require_setup_index.config.getHeaders(),
-		body: JSON.stringify(dto)
-	});
-	if (!response.ok) throw new Error("Failed to set visitor");
-	const data = await response.json();
+function setVisitor(dto) {
+	if (dto.user_id && dto.user_id !== identified) {
+		identified = dto.user_id;
+		require_track_index.track(IDENTIFY_EVENT, { user_id: dto.user_id }, { enableThirdPartyTracking: false });
+	}
 	const identity = {
 		...dto,
-		distinct_id: data.distinct_id ?? null
+		distinct_id: dto.user_id ?? null
 	};
 	require_setup_index.config.thirdPartyUserSetters.forEach((setter) => {
 		try {
@@ -41,10 +36,10 @@ async function setVisitor(dto) {
 			if (e instanceof Error) console.log(e.message);
 		}
 	});
-	return data;
 }
 //#endregion
+exports.IDENTIFY_EVENT = IDENTIFY_EVENT;
 exports.setVisitor = setVisitor;
-exports.visitorId = visitorId;
+exports.visitorId = require_visitor_id.visitorId;
 
 //# sourceMappingURL=index.cjs.map

package/dist/visitor/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["config","keys","uuidv7","fetch"],"sources":["../../src/visitor/index.ts"],"sourcesContent":["import { fetch } from '@shware/utils';\nimport { v7 as uuidv7 } from 'uuid';\nimport { keys } from '../constants/storage';\nimport type { UpdateVisitorDTO } from '../schema/index';\nimport { config } from '../setup/index';\nimport type { Visitor } from './types';\n\n/**\n * This visitor's id: generated here on the first visit (uuidv7) and kept in `config.storage`, so\n * it exists the moment the page loads. The first events, and the beacon of a visit left within a\n * second, go out without waiting for a round trip; the server creates the visitor from its first\n * events. An id a server issued to an older client is kept as it is: the visitor continues.\n *\n * Needs a server that creates visitors from events (see the README, \"Visitors\"); one that still\n * only creates them on `POST /visitors` rejects the events of a new visitor.\n */\nexport function visitorId(): string {\n  const stored = config.storage.getItem(keys.visitor_id);\n  if (stored && stored !== 'undefined') return stored;\n  const id = uuidv7();\n  config.storage.setItem(keys.visitor_id, id);\n  return id;\n}\n\nexport async function setVisitor(dto: Omit<UpdateVisitorDTO, 'tags'>) {\n  const id = visitorId();\n  const response = await fetch(`${config.endpoint}/visitors/${id}`, {\n    method: 'PATCH',\n    credentials: 'include',\n    headers: await config.getHeaders(),\n    body: JSON.stringify(dto),\n  });\n\n  if (!response.ok) throw new Error('Failed to set visitor');\n  const data = (await response.json()) as Visitor;\n\n  // Setters get the server's distinct_id — the person the visitor now belongs to — not anything\n  // the client could have said about it.\n  const identity = { ...dto, distinct_id: data.distinct_id ?? null };\n  config.thirdPartyUserSetters.forEach((setter) => {\n    try {\n      setter(identity);\n    } catch (e: unknown) {\n      // The visitor was updated before this ran, so a third-party setter throwing must not reject\n      // a call that already succeeded.\n      if (e instanceof Error) console.log(e.message);\n    }\n  });\n  return data;\n}\n"],"mappings":";;;;;;;;;;;;;;;AAgBA,SAAgB,YAAoB;CAClC,MAAM,SAASA,oBAAAA,OAAO,QAAQ,QAAQC,0BAAAA,KAAK,UAAU;CACrD,IAAI,UAAU,WAAW,aAAa,OAAO;CAC7C,MAAM,MAAA,GAAKC,KAAAA,GAAAA,CAAO;CAClB,oBAAA,OAAO,QAAQ,QAAQD,0BAAAA,KAAK,YAAY,EAAE;CAC1C,OAAO;AACT;AAEA,eAAsB,WAAW,KAAqC;CACpE,MAAM,KAAK,UAAU;CACrB,MAAM,WAAW,OAAA,GAAME,cAAAA,MAAAA,CAAM,GAAGH,oBAAAA,OAAO,SAAS,YAAY,MAAM;EAChE,QAAQ;EACR,aAAa;EACb,SAAS,MAAMA,oBAAAA,OAAO,WAAW;EACjC,MAAM,KAAK,UAAU,GAAG;CAC1B,CAAC;CAED,IAAI,CAAC,SAAS,IAAI,MAAM,IAAI,MAAM,uBAAuB;CACzD,MAAM,OAAQ,MAAM,SAAS,KAAK;CAIlC,MAAM,WAAW;EAAE,GAAG;EAAK,aAAa,KAAK,eAAe;CAAK;CACjE,oBAAA,OAAO,sBAAsB,SAAS,WAAW;EAC/C,IAAI;GACF,OAAO,QAAQ;EACjB,SAAS,GAAY;GAGnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;EAC/C;CACF,CAAC;CACD,OAAO;AACT"}
+{"version":3,"file":"index.cjs","names":[],"sources":["../../src/visitor/index.ts"],"sourcesContent":["import type { UpdateVisitorDTO } from '../schema/index';\nimport { config } from '../setup/index';\nimport { track } from '../track/index';\n\nexport { visitorId } from './id';\n\n/**\n * The event that binds the visitor to the user who signed in on it: the server sets the visitor's\n * `user_id` and `distinct_id` from its `user_id` property, in the transaction that stores the\n * batch — which also creates the visitor when it is new, so the binding can never arrive before it.\n */\nexport const IDENTIFY_EVENT = 'identify';\n\n/** The user this page has identified the visitor as: identify once per user, not per call. */\nlet identified: string | undefined;\n\n/**\n * Hands the signed-in user to the analytics: the third-party user setters (gtag, the pixels) now,\n * and the server through an `identify` event, sent when the user differs from the one this page\n * last identified — a host calls this on every page load once someone is signed in. Like any\n * event it goes with the next batch or the page-hide beacon; `user_data` is handed to the setters\n * only, never stored with the event.\n *\n * Synchronous and never throws: sign-in must not fail on analytics.\n */\nexport function setVisitor(dto: Omit<UpdateVisitorDTO, 'tags'>) {\n  if (dto.user_id && dto.user_id !== identified) {\n    identified = dto.user_id;\n    track(IDENTIFY_EVENT, { user_id: dto.user_id }, { enableThirdPartyTracking: false });\n  }\n\n  // Once bound, the server's person key for the visitor is the user's id, so the setters are told\n  // that rather than waiting for the server to say it.\n  const identity = { ...dto, distinct_id: dto.user_id ?? null };\n  config.thirdPartyUserSetters.forEach((setter) => {\n    try {\n      setter(identity);\n    } catch (e: unknown) {\n      // One third-party script does not get to stop the others.\n      if (e instanceof Error) console.log(e.message);\n    }\n  });\n}\n"],"mappings":";;;;;;;;;;AAWA,MAAa,iBAAiB;;AAG9B,IAAI;;;;;;;;;;AAWJ,SAAgB,WAAW,KAAqC;CAC9D,IAAI,IAAI,WAAW,IAAI,YAAY,YAAY;EAC7C,aAAa,IAAI;EACjB,oBAAA,MAAM,gBAAgB,EAAE,SAAS,IAAI,QAAQ,GAAG,EAAE,0BAA0B,MAAM,CAAC;CACrF;CAIA,MAAM,WAAW;EAAE,GAAG;EAAK,aAAa,IAAI,WAAW;CAAK;CAC5D,oBAAA,OAAO,sBAAsB,SAAS,WAAW;EAC/C,IAAI;GACF,OAAO,QAAQ;EACjB,SAAS,GAAY;GAEnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;EAC/C;CACF,CAAC;AACH"}

package/dist/visitor/index.d.cts

@@ -1,16 +1,22 @@
 import { UpdateVisitorDTO } from "../schema/index.cjs";
-import { Visitor } from "./types.cjs";
+import { visitorId } from "./id.cjs";
 //#region src/visitor/index.d.ts
 /**
- * This visitor's id: generated here on the first visit (uuidv7) and kept in `config.storage`, so
- * it exists the moment the page loads. The first events, and the beacon of a visit left within a
- * second, go out without waiting for a round trip; the server creates the visitor from its first
- * events. An id a server issued to an older client is kept as it is: the visitor continues.
+ * The event that binds the visitor to the user who signed in on it: the server sets the visitor's
+ * `user_id` and `distinct_id` from its `user_id` property, in the transaction that stores the
+ * batch — which also creates the visitor when it is new, so the binding can never arrive before it.
+ */
+export declare const IDENTIFY_EVENT = "identify";
+/**
+ * Hands the signed-in user to the analytics: the third-party user setters (gtag, the pixels) now,
+ * and the server through an `identify` event, sent when the user differs from the one this page
+ * last identified — a host calls this on every page load once someone is signed in. Like any
+ * event it goes with the next batch or the page-hide beacon; `user_data` is handed to the setters
+ * only, never stored with the event.
  *
- * Needs a server that creates visitors from events (see the README, "Visitors"); one that still
- * only creates them on `POST /visitors` rejects the events of a new visitor.
+ * Synchronous and never throws: sign-in must not fail on analytics.
  */
-export declare function visitorId(): string;
-export declare function setVisitor(dto: Omit<UpdateVisitorDTO, 'tags'>): Promise<Visitor>;
+export declare function setVisitor(dto: Omit<UpdateVisitorDTO, 'tags'>): void;
 //#endregion
+export { visitorId };
 //# sourceMappingURL=index.d.cts.map

package/dist/visitor/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/visitor/index.ts"],"mappings":";;;;;;;;;;;;wBAgBgB;wBAQM,WAAW,KAAK,KAAK,4BAAyB,QAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/visitor/index.ts"],"mappings":";;;;;;;;qBAWa;;;;;;;;;;wBAcG,WAAW,KAAK,KAAK"}

package/dist/visitor/index.d.mts

@@ -1,16 +1,22 @@
 import { UpdateVisitorDTO } from "../schema/index.mjs";
-import { Visitor } from "./types.mjs";
+import { visitorId } from "./id.mjs";
 //#region src/visitor/index.d.ts
 /**
- * This visitor's id: generated here on the first visit (uuidv7) and kept in `config.storage`, so
- * it exists the moment the page loads. The first events, and the beacon of a visit left within a
- * second, go out without waiting for a round trip; the server creates the visitor from its first
- * events. An id a server issued to an older client is kept as it is: the visitor continues.
+ * The event that binds the visitor to the user who signed in on it: the server sets the visitor's
+ * `user_id` and `distinct_id` from its `user_id` property, in the transaction that stores the
+ * batch — which also creates the visitor when it is new, so the binding can never arrive before it.
+ */
+export declare const IDENTIFY_EVENT = "identify";
+/**
+ * Hands the signed-in user to the analytics: the third-party user setters (gtag, the pixels) now,
+ * and the server through an `identify` event, sent when the user differs from the one this page
+ * last identified — a host calls this on every page load once someone is signed in. Like any
+ * event it goes with the next batch or the page-hide beacon; `user_data` is handed to the setters
+ * only, never stored with the event.
  *
- * Needs a server that creates visitors from events (see the README, "Visitors"); one that still
- * only creates them on `POST /visitors` rejects the events of a new visitor.
+ * Synchronous and never throws: sign-in must not fail on analytics.
  */
-export declare function visitorId(): string;
-export declare function setVisitor(dto: Omit<UpdateVisitorDTO, 'tags'>): Promise<Visitor>;
+export declare function setVisitor(dto: Omit<UpdateVisitorDTO, 'tags'>): void;
 //#endregion
+export { visitorId };
 //# sourceMappingURL=index.d.mts.map

package/dist/visitor/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/visitor/index.ts"],"mappings":";;;;;;;;;;;;wBAgBgB;wBAQM,WAAW,KAAK,KAAK,4BAAyB,QAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/visitor/index.ts"],"mappings":";;;;;;;;qBAWa;;;;;;;;;;wBAcG,WAAW,KAAK,KAAK"}

package/dist/visitor/index.mjs

@@ -1,37 +1,32 @@
 import { config } from "../setup/index.mjs";
-import { keys } from "../constants/storage.mjs";
-import { fetch } from "@shware/utils";
-import { v7 } from "uuid";
+import { visitorId } from "./id.mjs";
+import { track } from "../track/index.mjs";
 //#region src/visitor/index.ts
 /**
-* This visitor's id: generated here on the first visit (uuidv7) and kept in `config.storage`, so
-* it exists the moment the page loads. The first events, and the beacon of a visit left within a
-* second, go out without waiting for a round trip; the server creates the visitor from its first
-* events. An id a server issued to an older client is kept as it is: the visitor continues.
+* The event that binds the visitor to the user who signed in on it: the server sets the visitor's
+* `user_id` and `distinct_id` from its `user_id` property, in the transaction that stores the
+* batch — which also creates the visitor when it is new, so the binding can never arrive before it.
+*/
+const IDENTIFY_EVENT = "identify";
+/** The user this page has identified the visitor as: identify once per user, not per call. */
+let identified;
+/**
+* Hands the signed-in user to the analytics: the third-party user setters (gtag, the pixels) now,
+* and the server through an `identify` event, sent when the user differs from the one this page
+* last identified — a host calls this on every page load once someone is signed in. Like any
+* event it goes with the next batch or the page-hide beacon; `user_data` is handed to the setters
+* only, never stored with the event.
 *
-* Needs a server that creates visitors from events (see the README, "Visitors"); one that still
-* only creates them on `POST /visitors` rejects the events of a new visitor.
+* Synchronous and never throws: sign-in must not fail on analytics.
 */
-function visitorId() {
-	const stored = config.storage.getItem(keys.visitor_id);
-	if (stored && stored !== "undefined") return stored;
-	const id = v7();
-	config.storage.setItem(keys.visitor_id, id);
-	return id;
-}
-async function setVisitor(dto) {
-	const id = visitorId();
-	const response = await fetch(`${config.endpoint}/visitors/${id}`, {
-		method: "PATCH",
-		credentials: "include",
-		headers: await config.getHeaders(),
-		body: JSON.stringify(dto)
-	});
-	if (!response.ok) throw new Error("Failed to set visitor");
-	const data = await response.json();
+function setVisitor(dto) {
+	if (dto.user_id && dto.user_id !== identified) {
+		identified = dto.user_id;
+		track(IDENTIFY_EVENT, { user_id: dto.user_id }, { enableThirdPartyTracking: false });
+	}
 	const identity = {
 		...dto,
-		distinct_id: data.distinct_id ?? null
+		distinct_id: dto.user_id ?? null
 	};
 	config.thirdPartyUserSetters.forEach((setter) => {
 		try {
@@ -40,9 +35,8 @@ async function setVisitor(dto) {
 			if (e instanceof Error) console.log(e.message);
 		}
 	});
-	return data;
 }
 //#endregion
-export { setVisitor, visitorId };
+export { IDENTIFY_EVENT, setVisitor, visitorId };
 
 //# sourceMappingURL=index.mjs.map

package/dist/visitor/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":["uuidv7"],"sources":["../../src/visitor/index.ts"],"sourcesContent":["import { fetch } from '@shware/utils';\nimport { v7 as uuidv7 } from 'uuid';\nimport { keys } from '../constants/storage';\nimport type { UpdateVisitorDTO } from '../schema/index';\nimport { config } from '../setup/index';\nimport type { Visitor } from './types';\n\n/**\n * This visitor's id: generated here on the first visit (uuidv7) and kept in `config.storage`, so\n * it exists the moment the page loads. The first events, and the beacon of a visit left within a\n * second, go out without waiting for a round trip; the server creates the visitor from its first\n * events. An id a server issued to an older client is kept as it is: the visitor continues.\n *\n * Needs a server that creates visitors from events (see the README, \"Visitors\"); one that still\n * only creates them on `POST /visitors` rejects the events of a new visitor.\n */\nexport function visitorId(): string {\n  const stored = config.storage.getItem(keys.visitor_id);\n  if (stored && stored !== 'undefined') return stored;\n  const id = uuidv7();\n  config.storage.setItem(keys.visitor_id, id);\n  return id;\n}\n\nexport async function setVisitor(dto: Omit<UpdateVisitorDTO, 'tags'>) {\n  const id = visitorId();\n  const response = await fetch(`${config.endpoint}/visitors/${id}`, {\n    method: 'PATCH',\n    credentials: 'include',\n    headers: await config.getHeaders(),\n    body: JSON.stringify(dto),\n  });\n\n  if (!response.ok) throw new Error('Failed to set visitor');\n  const data = (await response.json()) as Visitor;\n\n  // Setters get the server's distinct_id — the person the visitor now belongs to — not anything\n  // the client could have said about it.\n  const identity = { ...dto, distinct_id: data.distinct_id ?? null };\n  config.thirdPartyUserSetters.forEach((setter) => {\n    try {\n      setter(identity);\n    } catch (e: unknown) {\n      // The visitor was updated before this ran, so a third-party setter throwing must not reject\n      // a call that already succeeded.\n      if (e instanceof Error) console.log(e.message);\n    }\n  });\n  return data;\n}\n"],"mappings":";;;;;;;;;;;;;;AAgBA,SAAgB,YAAoB;CAClC,MAAM,SAAS,OAAO,QAAQ,QAAQ,KAAK,UAAU;CACrD,IAAI,UAAU,WAAW,aAAa,OAAO;CAC7C,MAAM,KAAKA,GAAO;CAClB,OAAO,QAAQ,QAAQ,KAAK,YAAY,EAAE;CAC1C,OAAO;AACT;AAEA,eAAsB,WAAW,KAAqC;CACpE,MAAM,KAAK,UAAU;CACrB,MAAM,WAAW,MAAM,MAAM,GAAG,OAAO,SAAS,YAAY,MAAM;EAChE,QAAQ;EACR,aAAa;EACb,SAAS,MAAM,OAAO,WAAW;EACjC,MAAM,KAAK,UAAU,GAAG;CAC1B,CAAC;CAED,IAAI,CAAC,SAAS,IAAI,MAAM,IAAI,MAAM,uBAAuB;CACzD,MAAM,OAAQ,MAAM,SAAS,KAAK;CAIlC,MAAM,WAAW;EAAE,GAAG;EAAK,aAAa,KAAK,eAAe;CAAK;CACjE,OAAO,sBAAsB,SAAS,WAAW;EAC/C,IAAI;GACF,OAAO,QAAQ;EACjB,SAAS,GAAY;GAGnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;EAC/C;CACF,CAAC;CACD,OAAO;AACT"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../../src/visitor/index.ts"],"sourcesContent":["import type { UpdateVisitorDTO } from '../schema/index';\nimport { config } from '../setup/index';\nimport { track } from '../track/index';\n\nexport { visitorId } from './id';\n\n/**\n * The event that binds the visitor to the user who signed in on it: the server sets the visitor's\n * `user_id` and `distinct_id` from its `user_id` property, in the transaction that stores the\n * batch — which also creates the visitor when it is new, so the binding can never arrive before it.\n */\nexport const IDENTIFY_EVENT = 'identify';\n\n/** The user this page has identified the visitor as: identify once per user, not per call. */\nlet identified: string | undefined;\n\n/**\n * Hands the signed-in user to the analytics: the third-party user setters (gtag, the pixels) now,\n * and the server through an `identify` event, sent when the user differs from the one this page\n * last identified — a host calls this on every page load once someone is signed in. Like any\n * event it goes with the next batch or the page-hide beacon; `user_data` is handed to the setters\n * only, never stored with the event.\n *\n * Synchronous and never throws: sign-in must not fail on analytics.\n */\nexport function setVisitor(dto: Omit<UpdateVisitorDTO, 'tags'>) {\n  if (dto.user_id && dto.user_id !== identified) {\n    identified = dto.user_id;\n    track(IDENTIFY_EVENT, { user_id: dto.user_id }, { enableThirdPartyTracking: false });\n  }\n\n  // Once bound, the server's person key for the visitor is the user's id, so the setters are told\n  // that rather than waiting for the server to say it.\n  const identity = { ...dto, distinct_id: dto.user_id ?? null };\n  config.thirdPartyUserSetters.forEach((setter) => {\n    try {\n      setter(identity);\n    } catch (e: unknown) {\n      // One third-party script does not get to stop the others.\n      if (e instanceof Error) console.log(e.message);\n    }\n  });\n}\n"],"mappings":";;;;;;;;;AAWA,MAAa,iBAAiB;;AAG9B,IAAI;;;;;;;;;;AAWJ,SAAgB,WAAW,KAAqC;CAC9D,IAAI,IAAI,WAAW,IAAI,YAAY,YAAY;EAC7C,aAAa,IAAI;EACjB,MAAM,gBAAgB,EAAE,SAAS,IAAI,QAAQ,GAAG,EAAE,0BAA0B,MAAM,CAAC;CACrF;CAIA,MAAM,WAAW;EAAE,GAAG;EAAK,aAAa,IAAI,WAAW;CAAK;CAC5D,OAAO,sBAAsB,SAAS,WAAW;EAC/C,IAAI;GACF,OAAO,QAAQ;EACjB,SAAS,GAAY;GAEnB,IAAI,aAAa,OAAO,QAAQ,IAAI,EAAE,OAAO;EAC/C;CACF,CAAC;AACH"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shware/analytics",
-  "version": "11.1.0",
+  "version": "11.3.0",
   "private": false,
   "repository": {
     "type": "git",