@shware/analytics 10.3.0 → 11.0.1

package/dist/visitor/index.cjs

@@ -2,61 +2,29 @@ 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");
 //#region src/visitor/index.ts
-async function createVisitor() {
-	const tags = await require_setup_index.config.getTags();
-	const dto = {
-		device_id: await require_setup_index.config.getDeviceId(),
-		platform: require_setup_index.config.platform,
-		environment: require_setup_index.config.environment,
-		tags,
-		properties: tags
-	};
-	const response = await (0, _shware_utils.fetch)(`${require_setup_index.config.endpoint}/visitors`, {
-		method: "POST",
-		credentials: "include",
-		headers: await require_setup_index.config.getHeaders(),
-		body: JSON.stringify(dto)
-	});
-	if (!response.ok) throw new Error(`Failed to create visitor: ${response.status} ${await response.text()}`);
-	const data = await response.json();
-	if (data.id) require_setup_index.config.storage.setItem(require_constants_storage.keys.visitor_id, data.id);
-	return data;
-}
-async function getOrCreateVisitor() {
-	const visitorId = require_setup_index.config.storage.getItem(require_constants_storage.keys.visitor_id);
-	if (visitorId && visitorId !== "undefined") {
-		const tags = await require_setup_index.config.getTags();
-		const response = await (0, _shware_utils.fetch)(`${require_setup_index.config.endpoint}/visitors/${visitorId}`, {
-			method: "PATCH",
-			credentials: "include",
-			headers: await require_setup_index.config.getHeaders(),
-			body: JSON.stringify({ tags })
-		});
-		if (!response.ok) return createVisitor();
-		const data = await response.json();
-		if (data.id) require_setup_index.config.storage.setItem(require_constants_storage.keys.visitor_id, data.id);
-		return data;
-	} else return createVisitor();
-}
-let visitorFetcher = null;
-async function getVisitor() {
-	if (require_setup_index.cache.visitor) return require_setup_index.cache.visitor;
-	if (visitorFetcher) return visitorFetcher;
-	visitorFetcher = getOrCreateVisitor();
-	try {
-		require_setup_index.cache.visitor = await visitorFetcher;
-		return require_setup_index.cache.visitor;
-	} finally {
-		visitorFetcher = null;
-	}
+/**
+* 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.
+*
+* 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.
+*/
+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 } = await getVisitor();
-	const tags = await require_setup_index.config.getTags();
+	const id = visitorId();
 	const body = {
 		...dto,
-		tags
+		tags: await require_setup_index.config.getTags()
 	};
 	const response = await (0, _shware_utils.fetch)(`${require_setup_index.config.endpoint}/visitors/${id}`, {
 		method: "PATCH",
@@ -77,11 +45,10 @@ async function setVisitor(dto) {
 			if (e instanceof Error) console.log(e.message);
 		}
 	});
-	require_setup_index.cache.visitor = data;
 	return data;
 }
 //#endregion
-exports.getVisitor = getVisitor;
 exports.setVisitor = setVisitor;
+exports.visitorId = visitorId;
 
 //# sourceMappingURL=index.cjs.map

package/dist/visitor/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["config","fetch","keys","cache"],"sources":["../../src/visitor/index.ts"],"sourcesContent":["import { fetch } from '@shware/utils';\nimport { keys } from '../constants/storage';\nimport type { CreateVisitorDTO, UpdateVisitorDTO } from '../schema/index';\nimport { cache, config } from '../setup/index';\nimport type { Visitor, VisitorProperties } from './types';\n\nasync function createVisitor(): Promise<Visitor> {\n  const tags = await config.getTags();\n  const dto: CreateVisitorDTO = {\n    device_id: await config.getDeviceId(),\n    platform: config.platform,\n    environment: config.environment,\n    tags,\n    properties: tags as VisitorProperties,\n  };\n\n  const response = await fetch(`${config.endpoint}/visitors`, {\n    method: 'POST',\n    credentials: 'include',\n    headers: await config.getHeaders(),\n    body: JSON.stringify(dto),\n  });\n\n  if (!response.ok) {\n    throw new Error(`Failed to create visitor: ${response.status} ${await response.text()}`);\n  }\n  const data = (await response.json()) as Visitor;\n  if (data.id) {\n    config.storage.setItem(keys.visitor_id, data.id);\n  }\n  return data;\n}\n\nasync function getOrCreateVisitor(): Promise<Visitor> {\n  const visitorId = config.storage.getItem(keys.visitor_id);\n  if (visitorId && visitorId !== 'undefined') {\n    // PATCH, not GET: `tags` is the last-touch counterpart to `initial_tags`,\n    // and the only thing that ever refreshed it was `setVisitor`, which hosts\n    // call when they identify a user. A visitor who never signs in therefore\n    // kept the browser, screen, and release captured on their first ever page\n    // load — for the rest of their life — leaving `tags` permanently equal to\n    // `initial_tags` and the two columns pointless.\n    //\n    // Costs nothing extra: this replaces the request that was already here.\n    const tags = await config.getTags();\n    const response = await fetch(`${config.endpoint}/visitors/${visitorId}`, {\n      method: 'PATCH',\n      credentials: 'include',\n      headers: await config.getHeaders(),\n      body: JSON.stringify({ tags } satisfies UpdateVisitorDTO),\n    });\n\n    if (!response.ok) return createVisitor();\n    const data = (await response.json()) as Visitor;\n\n    if (data.id) {\n      config.storage.setItem(keys.visitor_id, data.id);\n    }\n    return data;\n  } else {\n    return createVisitor();\n  }\n}\n\nlet visitorFetcher: Promise<Visitor> | null = null;\n\nexport async function getVisitor(): Promise<Visitor> {\n  if (cache.visitor) return cache.visitor;\n  if (visitorFetcher) return visitorFetcher;\n  visitorFetcher = getOrCreateVisitor();\n  try {\n    cache.visitor = await visitorFetcher;\n    return cache.visitor;\n  } finally {\n    // In a `finally`, so a rejected attempt is not left in `visitorFetcher` for every later\n    // caller to await again: `sendEvents` needs a visitor for every batch, and one failed\n    // request would otherwise stop the page from reporting anything until it is reloaded.\n    visitorFetcher = null;\n  }\n}\n\nexport async function setVisitor(dto: Omit<UpdateVisitorDTO, 'tags'>) {\n  const { id } = await getVisitor();\n  const tags = await config.getTags();\n  const body: UpdateVisitorDTO = { ...dto, tags };\n  const response = await fetch(`${config.endpoint}/visitors/${id}`, {\n    method: 'PATCH',\n    credentials: 'include',\n    headers: await config.getHeaders(),\n    body: JSON.stringify(body),\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 = { ...body, 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 skip\n      // the cache write below or reject a call that already succeeded.\n      if (e instanceof Error) console.log(e.message);\n    }\n  });\n  cache.visitor = data;\n  return data;\n}\n"],"mappings":";;;;;AAMA,eAAe,gBAAkC;CAC/C,MAAM,OAAO,MAAMA,oBAAAA,OAAO,QAAQ;CAClC,MAAM,MAAwB;EAC5B,WAAW,MAAMA,oBAAAA,OAAO,YAAY;EACpC,UAAUA,oBAAAA,OAAO;EACjB,aAAaA,oBAAAA,OAAO;EACpB;EACA,YAAY;CACd;CAEA,MAAM,WAAW,OAAA,GAAMC,cAAAA,MAAAA,CAAM,GAAGD,oBAAAA,OAAO,SAAS,YAAY;EAC1D,QAAQ;EACR,aAAa;EACb,SAAS,MAAMA,oBAAAA,OAAO,WAAW;EACjC,MAAM,KAAK,UAAU,GAAG;CAC1B,CAAC;CAED,IAAI,CAAC,SAAS,IACZ,MAAM,IAAI,MAAM,6BAA6B,SAAS,OAAO,GAAG,MAAM,SAAS,KAAK,GAAG;CAEzF,MAAM,OAAQ,MAAM,SAAS,KAAK;CAClC,IAAI,KAAK,IACP,oBAAA,OAAO,QAAQ,QAAQE,0BAAAA,KAAK,YAAY,KAAK,EAAE;CAEjD,OAAO;AACT;AAEA,eAAe,qBAAuC;CACpD,MAAM,YAAYF,oBAAAA,OAAO,QAAQ,QAAQE,0BAAAA,KAAK,UAAU;CACxD,IAAI,aAAa,cAAc,aAAa;EAS1C,MAAM,OAAO,MAAMF,oBAAAA,OAAO,QAAQ;EAClC,MAAM,WAAW,OAAA,GAAMC,cAAAA,MAAAA,CAAM,GAAGD,oBAAAA,OAAO,SAAS,YAAY,aAAa;GACvE,QAAQ;GACR,aAAa;GACb,SAAS,MAAMA,oBAAAA,OAAO,WAAW;GACjC,MAAM,KAAK,UAAU,EAAE,KAAK,CAA4B;EAC1D,CAAC;EAED,IAAI,CAAC,SAAS,IAAI,OAAO,cAAc;EACvC,MAAM,OAAQ,MAAM,SAAS,KAAK;EAElC,IAAI,KAAK,IACP,oBAAA,OAAO,QAAQ,QAAQE,0BAAAA,KAAK,YAAY,KAAK,EAAE;EAEjD,OAAO;CACT,OACE,OAAO,cAAc;AAEzB;AAEA,IAAI,iBAA0C;AAE9C,eAAsB,aAA+B;CACnD,IAAIC,oBAAAA,MAAM,SAAS,OAAOA,oBAAAA,MAAM;CAChC,IAAI,gBAAgB,OAAO;CAC3B,iBAAiB,mBAAmB;CACpC,IAAI;EACF,oBAAA,MAAM,UAAU,MAAM;EACtB,OAAOA,oBAAAA,MAAM;CACf,UAAU;EAIR,iBAAiB;CACnB;AACF;AAEA,eAAsB,WAAW,KAAqC;CACpE,MAAM,EAAE,OAAO,MAAM,WAAW;CAChC,MAAM,OAAO,MAAMH,oBAAAA,OAAO,QAAQ;CAClC,MAAM,OAAyB;EAAE,GAAG;EAAK;CAAK;CAC9C,MAAM,WAAW,OAAA,GAAMC,cAAAA,MAAAA,CAAM,GAAGD,oBAAAA,OAAO,SAAS,YAAY,MAAM;EAChE,QAAQ;EACR,aAAa;EACb,SAAS,MAAMA,oBAAAA,OAAO,WAAW;EACjC,MAAM,KAAK,UAAU,IAAI;CAC3B,CAAC;CAED,IAAI,CAAC,SAAS,IAAI,MAAM,IAAI,MAAM,uBAAuB;CACzD,MAAM,OAAQ,MAAM,SAAS,KAAK;CAIlC,MAAM,WAAW;EAAE,GAAG;EAAM,aAAa,KAAK,eAAe;CAAK;CAClE,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,oBAAA,MAAM,UAAU;CAChB,OAAO;AACT"}
+{"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 body: UpdateVisitorDTO = { ...dto, tags: await config.getTags() };\n  const response = await fetch(`${config.endpoint}/visitors/${id}`, {\n    method: 'PATCH',\n    credentials: 'include',\n    headers: await config.getHeaders(),\n    body: JSON.stringify(body),\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 = { ...body, 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,OAAyB;EAAE,GAAG;EAAK,MAAM,MAAMD,oBAAAA,OAAO,QAAQ;CAAE;CACtE,MAAM,WAAW,OAAA,GAAMG,cAAAA,MAAAA,CAAM,GAAGH,oBAAAA,OAAO,SAAS,YAAY,MAAM;EAChE,QAAQ;EACR,aAAa;EACb,SAAS,MAAMA,oBAAAA,OAAO,WAAW;EACjC,MAAM,KAAK,UAAU,IAAI;CAC3B,CAAC;CAED,IAAI,CAAC,SAAS,IAAI,MAAM,IAAI,MAAM,uBAAuB;CACzD,MAAM,OAAQ,MAAM,SAAS,KAAK;CAIlC,MAAM,WAAW;EAAE,GAAG;EAAM,aAAa,KAAK,eAAe;CAAK;CAClE,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"}

package/dist/visitor/index.d.cts

@@ -1,7 +1,16 @@
 import { UpdateVisitorDTO } from "../schema/index.cjs";
 import { Visitor } from "./types.cjs";
 //#region src/visitor/index.d.ts
-export declare function getVisitor(): Promise<Visitor>;
+/**
+ * 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.
+ *
+ * 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.
+ */
+export declare function visitorId(): string;
 export declare function setVisitor(dto: Omit<UpdateVisitorDTO, 'tags'>): Promise<Visitor>;
 //#endregion
 //# 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":";;;wBAkEsB,cAAc,QAAQ;wBAetB,WAAW,KAAK,KAAK,4BAAyB,QAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/visitor/index.ts"],"mappings":";;;;;;;;;;;;wBAgBgB;wBAQM,WAAW,KAAK,KAAK,4BAAyB,QAAA"}

package/dist/visitor/index.d.mts

@@ -1,7 +1,16 @@
 import { UpdateVisitorDTO } from "../schema/index.mjs";
 import { Visitor } from "./types.mjs";
 //#region src/visitor/index.d.ts
-export declare function getVisitor(): Promise<Visitor>;
+/**
+ * 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.
+ *
+ * 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.
+ */
+export declare function visitorId(): string;
 export declare function setVisitor(dto: Omit<UpdateVisitorDTO, 'tags'>): Promise<Visitor>;
 //#endregion
 //# 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":";;;wBAkEsB,cAAc,QAAQ;wBAetB,WAAW,KAAK,KAAK,4BAAyB,QAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/visitor/index.ts"],"mappings":";;;;;;;;;;;;wBAgBgB;wBAQM,WAAW,KAAK,KAAK,4BAAyB,QAAA"}

package/dist/visitor/index.mjs

@@ -1,61 +1,29 @@
-import { cache, config } from "../setup/index.mjs";
+import { config } from "../setup/index.mjs";
 import { keys } from "../constants/storage.mjs";
 import { fetch } from "@shware/utils";
+import { v7 } from "uuid";
 //#region src/visitor/index.ts
-async function createVisitor() {
-	const tags = await config.getTags();
-	const dto = {
-		device_id: await config.getDeviceId(),
-		platform: config.platform,
-		environment: config.environment,
-		tags,
-		properties: tags
-	};
-	const response = await fetch(`${config.endpoint}/visitors`, {
-		method: "POST",
-		credentials: "include",
-		headers: await config.getHeaders(),
-		body: JSON.stringify(dto)
-	});
-	if (!response.ok) throw new Error(`Failed to create visitor: ${response.status} ${await response.text()}`);
-	const data = await response.json();
-	if (data.id) config.storage.setItem(keys.visitor_id, data.id);
-	return data;
-}
-async function getOrCreateVisitor() {
-	const visitorId = config.storage.getItem(keys.visitor_id);
-	if (visitorId && visitorId !== "undefined") {
-		const tags = await config.getTags();
-		const response = await fetch(`${config.endpoint}/visitors/${visitorId}`, {
-			method: "PATCH",
-			credentials: "include",
-			headers: await config.getHeaders(),
-			body: JSON.stringify({ tags })
-		});
-		if (!response.ok) return createVisitor();
-		const data = await response.json();
-		if (data.id) config.storage.setItem(keys.visitor_id, data.id);
-		return data;
-	} else return createVisitor();
-}
-let visitorFetcher = null;
-async function getVisitor() {
-	if (cache.visitor) return cache.visitor;
-	if (visitorFetcher) return visitorFetcher;
-	visitorFetcher = getOrCreateVisitor();
-	try {
-		cache.visitor = await visitorFetcher;
-		return cache.visitor;
-	} finally {
-		visitorFetcher = null;
-	}
+/**
+* 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.
+*
+* 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.
+*/
+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 } = await getVisitor();
-	const tags = await config.getTags();
+	const id = visitorId();
 	const body = {
 		...dto,
-		tags
+		tags: await config.getTags()
 	};
 	const response = await fetch(`${config.endpoint}/visitors/${id}`, {
 		method: "PATCH",
@@ -76,10 +44,9 @@ async function setVisitor(dto) {
 			if (e instanceof Error) console.log(e.message);
 		}
 	});
-	cache.visitor = data;
 	return data;
 }
 //#endregion
-export { getVisitor, setVisitor };
+export { setVisitor, visitorId };
 
 //# sourceMappingURL=index.mjs.map

package/dist/visitor/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../../src/visitor/index.ts"],"sourcesContent":["import { fetch } from '@shware/utils';\nimport { keys } from '../constants/storage';\nimport type { CreateVisitorDTO, UpdateVisitorDTO } from '../schema/index';\nimport { cache, config } from '../setup/index';\nimport type { Visitor, VisitorProperties } from './types';\n\nasync function createVisitor(): Promise<Visitor> {\n  const tags = await config.getTags();\n  const dto: CreateVisitorDTO = {\n    device_id: await config.getDeviceId(),\n    platform: config.platform,\n    environment: config.environment,\n    tags,\n    properties: tags as VisitorProperties,\n  };\n\n  const response = await fetch(`${config.endpoint}/visitors`, {\n    method: 'POST',\n    credentials: 'include',\n    headers: await config.getHeaders(),\n    body: JSON.stringify(dto),\n  });\n\n  if (!response.ok) {\n    throw new Error(`Failed to create visitor: ${response.status} ${await response.text()}`);\n  }\n  const data = (await response.json()) as Visitor;\n  if (data.id) {\n    config.storage.setItem(keys.visitor_id, data.id);\n  }\n  return data;\n}\n\nasync function getOrCreateVisitor(): Promise<Visitor> {\n  const visitorId = config.storage.getItem(keys.visitor_id);\n  if (visitorId && visitorId !== 'undefined') {\n    // PATCH, not GET: `tags` is the last-touch counterpart to `initial_tags`,\n    // and the only thing that ever refreshed it was `setVisitor`, which hosts\n    // call when they identify a user. A visitor who never signs in therefore\n    // kept the browser, screen, and release captured on their first ever page\n    // load — for the rest of their life — leaving `tags` permanently equal to\n    // `initial_tags` and the two columns pointless.\n    //\n    // Costs nothing extra: this replaces the request that was already here.\n    const tags = await config.getTags();\n    const response = await fetch(`${config.endpoint}/visitors/${visitorId}`, {\n      method: 'PATCH',\n      credentials: 'include',\n      headers: await config.getHeaders(),\n      body: JSON.stringify({ tags } satisfies UpdateVisitorDTO),\n    });\n\n    if (!response.ok) return createVisitor();\n    const data = (await response.json()) as Visitor;\n\n    if (data.id) {\n      config.storage.setItem(keys.visitor_id, data.id);\n    }\n    return data;\n  } else {\n    return createVisitor();\n  }\n}\n\nlet visitorFetcher: Promise<Visitor> | null = null;\n\nexport async function getVisitor(): Promise<Visitor> {\n  if (cache.visitor) return cache.visitor;\n  if (visitorFetcher) return visitorFetcher;\n  visitorFetcher = getOrCreateVisitor();\n  try {\n    cache.visitor = await visitorFetcher;\n    return cache.visitor;\n  } finally {\n    // In a `finally`, so a rejected attempt is not left in `visitorFetcher` for every later\n    // caller to await again: `sendEvents` needs a visitor for every batch, and one failed\n    // request would otherwise stop the page from reporting anything until it is reloaded.\n    visitorFetcher = null;\n  }\n}\n\nexport async function setVisitor(dto: Omit<UpdateVisitorDTO, 'tags'>) {\n  const { id } = await getVisitor();\n  const tags = await config.getTags();\n  const body: UpdateVisitorDTO = { ...dto, tags };\n  const response = await fetch(`${config.endpoint}/visitors/${id}`, {\n    method: 'PATCH',\n    credentials: 'include',\n    headers: await config.getHeaders(),\n    body: JSON.stringify(body),\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 = { ...body, 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 skip\n      // the cache write below or reject a call that already succeeded.\n      if (e instanceof Error) console.log(e.message);\n    }\n  });\n  cache.visitor = data;\n  return data;\n}\n"],"mappings":";;;;AAMA,eAAe,gBAAkC;CAC/C,MAAM,OAAO,MAAM,OAAO,QAAQ;CAClC,MAAM,MAAwB;EAC5B,WAAW,MAAM,OAAO,YAAY;EACpC,UAAU,OAAO;EACjB,aAAa,OAAO;EACpB;EACA,YAAY;CACd;CAEA,MAAM,WAAW,MAAM,MAAM,GAAG,OAAO,SAAS,YAAY;EAC1D,QAAQ;EACR,aAAa;EACb,SAAS,MAAM,OAAO,WAAW;EACjC,MAAM,KAAK,UAAU,GAAG;CAC1B,CAAC;CAED,IAAI,CAAC,SAAS,IACZ,MAAM,IAAI,MAAM,6BAA6B,SAAS,OAAO,GAAG,MAAM,SAAS,KAAK,GAAG;CAEzF,MAAM,OAAQ,MAAM,SAAS,KAAK;CAClC,IAAI,KAAK,IACP,OAAO,QAAQ,QAAQ,KAAK,YAAY,KAAK,EAAE;CAEjD,OAAO;AACT;AAEA,eAAe,qBAAuC;CACpD,MAAM,YAAY,OAAO,QAAQ,QAAQ,KAAK,UAAU;CACxD,IAAI,aAAa,cAAc,aAAa;EAS1C,MAAM,OAAO,MAAM,OAAO,QAAQ;EAClC,MAAM,WAAW,MAAM,MAAM,GAAG,OAAO,SAAS,YAAY,aAAa;GACvE,QAAQ;GACR,aAAa;GACb,SAAS,MAAM,OAAO,WAAW;GACjC,MAAM,KAAK,UAAU,EAAE,KAAK,CAA4B;EAC1D,CAAC;EAED,IAAI,CAAC,SAAS,IAAI,OAAO,cAAc;EACvC,MAAM,OAAQ,MAAM,SAAS,KAAK;EAElC,IAAI,KAAK,IACP,OAAO,QAAQ,QAAQ,KAAK,YAAY,KAAK,EAAE;EAEjD,OAAO;CACT,OACE,OAAO,cAAc;AAEzB;AAEA,IAAI,iBAA0C;AAE9C,eAAsB,aAA+B;CACnD,IAAI,MAAM,SAAS,OAAO,MAAM;CAChC,IAAI,gBAAgB,OAAO;CAC3B,iBAAiB,mBAAmB;CACpC,IAAI;EACF,MAAM,UAAU,MAAM;EACtB,OAAO,MAAM;CACf,UAAU;EAIR,iBAAiB;CACnB;AACF;AAEA,eAAsB,WAAW,KAAqC;CACpE,MAAM,EAAE,OAAO,MAAM,WAAW;CAChC,MAAM,OAAO,MAAM,OAAO,QAAQ;CAClC,MAAM,OAAyB;EAAE,GAAG;EAAK;CAAK;CAC9C,MAAM,WAAW,MAAM,MAAM,GAAG,OAAO,SAAS,YAAY,MAAM;EAChE,QAAQ;EACR,aAAa;EACb,SAAS,MAAM,OAAO,WAAW;EACjC,MAAM,KAAK,UAAU,IAAI;CAC3B,CAAC;CAED,IAAI,CAAC,SAAS,IAAI,MAAM,IAAI,MAAM,uBAAuB;CACzD,MAAM,OAAQ,MAAM,SAAS,KAAK;CAIlC,MAAM,WAAW;EAAE,GAAG;EAAM,aAAa,KAAK,eAAe;CAAK;CAClE,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,MAAM,UAAU;CAChB,OAAO;AACT"}
+{"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 body: UpdateVisitorDTO = { ...dto, tags: await config.getTags() };\n  const response = await fetch(`${config.endpoint}/visitors/${id}`, {\n    method: 'PATCH',\n    credentials: 'include',\n    headers: await config.getHeaders(),\n    body: JSON.stringify(body),\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 = { ...body, 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,OAAyB;EAAE,GAAG;EAAK,MAAM,MAAM,OAAO,QAAQ;CAAE;CACtE,MAAM,WAAW,MAAM,MAAM,GAAG,OAAO,SAAS,YAAY,MAAM;EAChE,QAAQ;EACR,aAAa;EACb,SAAS,MAAM,OAAO,WAAW;EACjC,MAAM,KAAK,UAAU,IAAI;CAC3B,CAAC;CAED,IAAI,CAAC,SAAS,IAAI,MAAM,IAAI,MAAM,uBAAuB;CACzD,MAAM,OAAQ,MAAM,SAAS,KAAK;CAIlC,MAAM,WAAW;EAAE,GAAG;EAAM,aAAa,KAAK,eAAe;CAAK;CAClE,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"}

package/package.json

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