ciphera-net/pulse
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 15 Wiki Activity

docs: clarify default and optional data-storage options in ScriptSetupBlock and script.js for improved user understanding

Browse Source
This commit is contained in:
Usman Baig
2026-02-11 14:13:05 +01:00
parent f423d01d7b
commit 1454d15142
2 changed files with 18 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
components/sites/ScriptSetupBlock.tsx
View File

@@ -90,7 +90,7 @@ export default function ScriptSetupBlock({
{`<script defer data-domain="${site.domain}" data-api="${API_URL}" src="${APP_URL}/script.js"></script>`} {`<script defer data-domain="${site.domain}" data-api="${API_URL}" src="${APP_URL}/script.js"></script>`}
</code> </code>
<p className="mt-2 text-xs text-neutral-500 dark:text-neutral-400"> <p className="mt-2 text-xs text-neutral-500 dark:text-neutral-400">
Optional: <code className="rounded px-1 bg-neutral-200 dark:bg-neutral-700">data-storage=&quot;session&quot;</code> for per-tab (ephemeral) visitor counting. Default: cross-tab (localStorage). Optional: <code className="rounded px-1 bg-neutral-200 dark:bg-neutral-700">data-storage=&quot;session&quot;</code> to opt out (per-tab, ephemeral).
</p> </p>
<button <button
type="button" type="button"

20
public/script.js
View File

@@ -1,7 +1,7 @@
/** /**
* Pulse - Privacy-First Tracking Script * Pulse - Privacy-First Tracking Script
* Lightweight, no cookies, GDPR compliant. * Lightweight, no cookies, GDPR compliant.
* Default: cross-tab visitor ID (localStorage, optional data-storage-ttl in hours). * Default: cross-tab visitor ID (localStorage), optional data-storage-ttl in hours.
* Optional: data-storage="session" for per-tab (ephemeral) counting. * Optional: data-storage="session" for per-tab (ephemeral) counting.
*/ */
@@ -116,8 +116,8 @@
return Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15); return Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
} }
// * Returns session/visitor ID. Default: ephemeral (sessionStorage, per-tab). // * Returns session/visitor ID. Default: persistent (localStorage, cross-tab), optional TTL in hours.
// * With data-storage="local": persistent (localStorage, cross-tab), optional TTL in hours. // * With data-storage="session": ephemeral (sessionStorage, per-tab).
function getSessionId() { function getSessionId() {
if (cachedSessionId) { if (cachedSessionId) {
return cachedSessionId; return cachedSessionId;
@@ -158,6 +158,20 @@
} }
} catch (e2) {} } catch (e2) {}
} }
// * Final re-read immediately before write to avoid overwriting a fresher ID from another tab
var rawBeforeWrite = localStorage.getItem(key);
if (rawBeforeWrite) {
try {
var parsedBefore = JSON.parse(rawBeforeWrite);
if (parsedBefore && typeof parsedBefore.id === 'string') {
var expBefore = ttlMs > 0 && typeof parsedBefore.created === 'number' && (Date.now() - parsedBefore.created > ttlMs);
if (!expBefore) {
cachedSessionId = parsedBefore.id;
return cachedSessionId;
}
}
} catch (e3) {}
}
localStorage.setItem(key, JSON.stringify({ id: cachedSessionId, created: Date.now() })); localStorage.setItem(key, JSON.stringify({ id: cachedSessionId, created: Date.now() }));
} catch (e) { } catch (e) {
cachedSessionId = generateId(); cachedSessionId = generateId();