@gurulu/web 0.1.0 → 1.0.0

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/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 MONAFY LTD (UK Company No. 17031485)
4
+ 4 Raven Road, Unit 1C3-1051, London, United Kingdom, E18 1HB
5
+
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be included in all
14
+ copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,52 @@
1
+ # @gurulu/web
2
+
3
+ Browser SDK for [Gurulu](https://gurulu.io) — Truth Layer for product analytics.
4
+
5
+ Zero runtime dependencies. ~8 KB gzipped.
6
+
7
+ ## Install
8
+
9
+ ### Script tag (autocapture, no build step)
10
+
11
+ ```html
12
+ <script
13
+ src="https://cdn.gurulu.io/t.js"
14
+ data-workspace="pk_xxxxxxxxxxxx"
15
+ defer
16
+ ></script>
17
+ ```
18
+
19
+ ### NPM
20
+
21
+ ```bash
22
+ npm install @gurulu/web
23
+ # or
24
+ bun add @gurulu/web
25
+ ```
26
+
27
+ ```ts
28
+ import { createGurulu } from '@gurulu/web';
29
+
30
+ const gurulu = createGurulu();
31
+ gurulu.init({ workspace: 'pk_xxxxxxxxxxxx' });
32
+
33
+ gurulu.identify('user_42', { plan: 'pro' });
34
+ gurulu.track('checkout.completed', { order_id: 'o_123', total: 49.99 });
35
+ ```
36
+
37
+ ## Features
38
+
39
+ - **Autocapture** — click, pageview, form submit, scroll depth, web-vitals (LCP, INP, CLS).
40
+ - **Identity** — `identify(personId, traits)` with deterministic + probabilistic merge on the server.
41
+ - **Contract runtime** — registry-bound event validation: malformed events are quarantined, never silently dropped.
42
+ - **Consent-aware** — respects Google Consent Mode v2, GDPR/CCPA gates.
43
+
44
+ ## Documentation
45
+
46
+ Full API reference and integration guides: [gurulu.io/docs](https://gurulu.io/docs)
47
+
48
+ ## License
49
+
50
+ MIT — see [LICENSE](./LICENSE).
51
+
52
+ Copyright © 2026 MONAFY LTD (UK Company No. 17031485).
@@ -0,0 +1,17 @@
1
+ export interface ClickPayload {
2
+ element_tag: string;
3
+ element_id?: string;
4
+ element_class?: string;
5
+ element_text?: string;
6
+ href?: string;
7
+ is_outbound?: boolean;
8
+ is_download?: boolean;
9
+ custom_event?: string;
10
+ custom_props?: Record<string, string>;
11
+ }
12
+ export type ClickTracker = (payload: ClickPayload) => void;
13
+ export interface ClickAutocaptureHandle {
14
+ stop(): void;
15
+ }
16
+ export declare function startClickAutocapture(track: ClickTracker): ClickAutocaptureHandle;
17
+ //# sourceMappingURL=click.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"click.d.ts","sourceRoot":"","sources":["../../src/autocapture/click.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACvC;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,CAAC;AA8C3D,MAAM,WAAW,sBAAsB;IACrC,IAAI,IAAI,IAAI,CAAC;CACd;AAED,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,YAAY,GAAG,sBAAsB,CAiDjF"}
@@ -0,0 +1,21 @@
1
+ export interface FormStartedPayload {
2
+ form_id?: string;
3
+ form_name?: string;
4
+ field_count: number;
5
+ }
6
+ export interface FormSubmittedPayload {
7
+ form_id?: string;
8
+ form_name?: string;
9
+ field_count: number;
10
+ /** Names of fields that had user input (PII-safe — no values). */
11
+ filled_fields?: string[];
12
+ }
13
+ export type FormTracker = {
14
+ onStart: (p: FormStartedPayload) => void;
15
+ onSubmit: (p: FormSubmittedPayload) => void;
16
+ };
17
+ export interface FormAutocaptureHandle {
18
+ stop(): void;
19
+ }
20
+ export declare function startFormAutocapture(track: FormTracker): FormAutocaptureHandle;
21
+ //# sourceMappingURL=form.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../src/autocapture/form.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,kEAAkE;IAClE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACzC,QAAQ,EAAE,CAAC,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAC;CAC7C,CAAC;AAyCF,MAAM,WAAW,qBAAqB;IACpC,IAAI,IAAI,IAAI,CAAC;CACd;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,WAAW,GAAG,qBAAqB,CAoD9E"}
@@ -0,0 +1,18 @@
1
+ import type { AutocaptureConfig } from '../types.ts';
2
+ import { type ClickPayload } from './click.ts';
3
+ import { type FormStartedPayload, type FormSubmittedPayload } from './form.ts';
4
+ import { type ScrollDepthPayload } from './scroll.ts';
5
+ import { type WebVitalPayload } from './web-vitals.ts';
6
+ export interface AutocaptureSinks {
7
+ pageView: (url: string, title: string, referrer: string) => void;
8
+ click: (payload: ClickPayload) => void;
9
+ formStarted: (payload: FormStartedPayload) => void;
10
+ formSubmitted: (payload: FormSubmittedPayload) => void;
11
+ scrollDepth: (payload: ScrollDepthPayload) => void;
12
+ webVital: (payload: WebVitalPayload) => void;
13
+ }
14
+ export interface AutocaptureHandle {
15
+ stopAll(): void;
16
+ }
17
+ export declare function startAutocapture(cfg: AutocaptureConfig | false | undefined, sinks: AutocaptureSinks): AutocaptureHandle;
18
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/autocapture/index.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,KAAK,YAAY,EAAyB,MAAM,YAAY,CAAC;AACtE,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EAE1B,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,KAAK,kBAAkB,EAA0B,MAAM,aAAa,CAAC;AAC9E,OAAO,EAA6B,KAAK,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElF,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IACjE,KAAK,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,CAAC;IACvC,WAAW,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACnD,aAAa,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAC;IACvD,WAAW,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACnD,QAAQ,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,IAAI,IAAI,CAAC;CACjB;AAiBD,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,iBAAiB,GAAG,KAAK,GAAG,SAAS,EAC1C,KAAK,EAAE,gBAAgB,GACtB,iBAAiB,CA8BnB"}
@@ -0,0 +1,9 @@
1
+ export type PageTracker = (path: string, title: string, referrer: string) => void;
2
+ export interface PageAutocaptureHandle {
3
+ stop(): void;
4
+ }
5
+ /**
6
+ * Patch history & listen popstate. Emits once on init for initial page_view.
7
+ */
8
+ export declare function startPageAutocapture(track: PageTracker): PageAutocaptureHandle;
9
+ //# sourceMappingURL=page.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"page.d.ts","sourceRoot":"","sources":["../../src/autocapture/page.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;AAElF,MAAM,WAAW,qBAAqB;IACpC,IAAI,IAAI,IAAI,CAAC;CACd;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,WAAW,GAAG,qBAAqB,CA0C9E"}
@@ -0,0 +1,9 @@
1
+ export interface ScrollDepthPayload {
2
+ depth_percent: 25 | 50 | 75 | 90;
3
+ }
4
+ export type ScrollTracker = (payload: ScrollDepthPayload) => void;
5
+ export interface ScrollAutocaptureHandle {
6
+ stop(): void;
7
+ }
8
+ export declare function startScrollAutocapture(track: ScrollTracker): ScrollAutocaptureHandle;
9
+ //# sourceMappingURL=scroll.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"scroll.d.ts","sourceRoot":"","sources":["../../src/autocapture/scroll.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;CAClC;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,EAAE,kBAAkB,KAAK,IAAI,CAAC;AAIlE,MAAM,WAAW,uBAAuB;IACtC,IAAI,IAAI,IAAI,CAAC;CACd;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,aAAa,GAAG,uBAAuB,CAuCpF"}
@@ -0,0 +1,11 @@
1
+ export interface WebVitalPayload {
2
+ metric: 'LCP' | 'FID' | 'INP' | 'CLS' | 'TTFB' | 'FCP';
3
+ value: number;
4
+ rating?: 'good' | 'needs-improvement' | 'poor';
5
+ }
6
+ export type WebVitalTracker = (payload: WebVitalPayload) => void;
7
+ export interface WebVitalsHandle {
8
+ stop(): void;
9
+ }
10
+ export declare function startWebVitalsAutocapture(track: WebVitalTracker): WebVitalsHandle;
11
+ //# sourceMappingURL=web-vitals.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"web-vitals.d.ts","sourceRoot":"","sources":["../../src/autocapture/web-vitals.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;IACvD,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,mBAAmB,GAAG,MAAM,CAAC;CAChD;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAC;AAiCjE,MAAM,WAAW,eAAe;IAC9B,IAAI,IAAI,IAAI,CAAC;CACd;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,eAAe,GAAG,eAAe,CAmGjF"}
@@ -0,0 +1,117 @@
1
+ export interface ConsentCategories {
2
+ necessary: boolean;
3
+ analytics: boolean;
4
+ marketing: boolean;
5
+ functional: boolean;
6
+ personalization: boolean;
7
+ }
8
+ export interface ConsentSnapshot {
9
+ workspaceId: string;
10
+ anonymousId: string;
11
+ categories: ConsentCategories;
12
+ /** ISO 8601. */
13
+ grantedAt: string;
14
+ /** ISO 8601. */
15
+ expiresAt: string;
16
+ /** Hangi kaynaktan geldi — 'banner' | 'settings_page' | 'sdk_api' | 'remote'. */
17
+ source: 'banner' | 'settings_page' | 'sdk_api' | 'remote';
18
+ }
19
+ export interface BannerConfig {
20
+ position?: 'bottom' | 'top' | 'bottom-left' | 'bottom-right' | 'modal';
21
+ theme?: 'auto' | 'light' | 'dark';
22
+ buttons?: {
23
+ accept?: boolean;
24
+ reject?: boolean;
25
+ customize?: boolean;
26
+ };
27
+ brand?: {
28
+ logo_url?: string;
29
+ primary_color?: string;
30
+ };
31
+ text_overrides?: Record<string, Record<string, string>>;
32
+ }
33
+ export interface BannerConfigResponse {
34
+ workspace_id: string;
35
+ mode: 'allow_by_default' | 'banner_required' | 'strict_gdpr';
36
+ categories: {
37
+ necessary: {
38
+ required: true;
39
+ default: true;
40
+ };
41
+ analytics: {
42
+ default: boolean;
43
+ };
44
+ marketing: {
45
+ default: boolean;
46
+ };
47
+ functional: {
48
+ default: boolean;
49
+ };
50
+ personalization: {
51
+ default: boolean;
52
+ };
53
+ };
54
+ banner_config: BannerConfig;
55
+ renewal_months: number;
56
+ eu_detected: {
57
+ country: string;
58
+ region: string;
59
+ gdpr_applicable: boolean;
60
+ };
61
+ }
62
+ export interface GuruluConsentOptions {
63
+ workspaceId: string;
64
+ /** Default 'https://api.gurulu.io'. Local dev: 'http://localhost:3000'. */
65
+ apiUrl?: string;
66
+ /** Browser locale (banner copy fallback). Default navigator.language. */
67
+ locale?: 'tr' | 'en' | 'zh' | 'ar';
68
+ /** Anonymous ID (otherwise generated). */
69
+ anonymousId?: string;
70
+ /** Test injection. */
71
+ fetchImpl?: typeof fetch;
72
+ /** Test injection. */
73
+ storage?: Storage;
74
+ /** Auto-call showBanner() in init() if mode requires. Default true. */
75
+ autoBanner?: boolean;
76
+ }
77
+ /**
78
+ * Browser SDK consent manager.
79
+ * Zero runtime dep (M11 K28). SSR-safe (init no-op if window undefined).
80
+ */
81
+ export declare class GuruluConsent {
82
+ private readonly workspaceId;
83
+ private readonly apiUrl;
84
+ private readonly fetchImpl;
85
+ private readonly storage;
86
+ private readonly autoBanner;
87
+ private readonly locale;
88
+ private anonymousIdValue;
89
+ private bannerConfigCache;
90
+ private bannerEl;
91
+ constructor(opts: GuruluConsentOptions);
92
+ /**
93
+ * Banner config fetch + auto-show. Idempotent — tekrar çağırılabilir.
94
+ */
95
+ init(): Promise<void>;
96
+ /** Local consent snapshot — `null` if visitor henüz consent vermemiş. */
97
+ getState(): ConsentSnapshot | null;
98
+ /**
99
+ * Consent state set + remote sync (POST /v1/consent/state).
100
+ * `necessary` her zaman true (forced).
101
+ */
102
+ setState(categories: Partial<ConsentCategories>): Promise<void>;
103
+ /** Banner DOM elemanını oluştur + body'ye ekle. Idempotent. */
104
+ showBanner(): void;
105
+ hideBanner(): void;
106
+ /**
107
+ * gurulu.track() için header — `X-Gurulu-Consent: {categories JSON}`.
108
+ * Ingest endpoint K17 event snapshot için bu header'ı okur.
109
+ */
110
+ buildIngestHeader(): string;
111
+ /** Test util — current anon id. */
112
+ getAnonymousId(): string;
113
+ private storageKey;
114
+ private loadOrCreateAnonId;
115
+ private bannerText;
116
+ }
117
+ //# sourceMappingURL=consent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consent.d.ts","sourceRoot":"","sources":["../src/consent.ts"],"names":[],"mappings":"AAsBA,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,iBAAiB,CAAC;IAC9B,gBAAgB;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,iFAAiF;IACjF,MAAM,EAAE,QAAQ,GAAG,eAAe,GAAG,SAAS,GAAG,QAAQ,CAAC;CAC3D;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,aAAa,GAAG,cAAc,GAAG,OAAO,CAAC;IACvE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAClC,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CACzD;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,aAAa,CAAC;IAC7D,UAAU,EAAE;QACV,SAAS,EAAE;YAAE,QAAQ,EAAE,IAAI,CAAC;YAAC,OAAO,EAAE,IAAI,CAAA;SAAE,CAAC;QAC7C,SAAS,EAAE;YAAE,OAAO,EAAE,OAAO,CAAA;SAAE,CAAC;QAChC,SAAS,EAAE;YAAE,OAAO,EAAE,OAAO,CAAA;SAAE,CAAC;QAChC,UAAU,EAAE;YAAE,OAAO,EAAE,OAAO,CAAA;SAAE,CAAC;QACjC,eAAe,EAAE;YAAE,OAAO,EAAE,OAAO,CAAA;SAAE,CAAC;KACvC,CAAC;IACF,aAAa,EAAE,YAAY,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE;QACX,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,2EAA2E;IAC3E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IACnC,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACtB,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;IACzB,sBAAsB;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,uEAAuE;IACvE,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAMD;;;GAGG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;IACzC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAU;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA4B;IACnD,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,iBAAiB,CAAqC;IAC9D,OAAO,CAAC,QAAQ,CAA4B;gBAEhC,IAAI,EAAE,oBAAoB;IAkBtC;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAqB3B,yEAAyE;IACzE,QAAQ,IAAI,eAAe,GAAG,IAAI;IAiBlC;;;OAGG;IACG,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAuDrE,+DAA+D;IAC/D,UAAU,IAAI,IAAI;IAyClB,UAAU,IAAI,IAAI;IAOlB;;;OAGG;IACH,iBAAiB,IAAI,MAAM;IAM3B,mCAAmC;IACnC,cAAc,IAAI,MAAM;IAMxB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,kBAAkB;IAa1B,OAAO,CAAC,UAAU;CAuBnB"}
package/dist/core.d.ts ADDED
@@ -0,0 +1,42 @@
1
+ import { GuruluConsent } from './consent.ts';
2
+ import type { InitOptions } from './types.ts';
3
+ export interface PageOverride {
4
+ url?: string;
5
+ title?: string;
6
+ referrer?: string;
7
+ }
8
+ export declare class Gurulu {
9
+ private initialized;
10
+ private opts;
11
+ private queue;
12
+ private session;
13
+ private anonymousId;
14
+ private autocaptureHandle;
15
+ consent: GuruluConsent;
16
+ /**
17
+ * 1-line init. Idempotent — second call no-ops with debug warning.
18
+ */
19
+ init(opts: InitOptions): void;
20
+ /** Manual `track()` — typed via codegen (`@gurulu/web/generated`). */
21
+ track(eventKey: string, properties?: Record<string, unknown>): void;
22
+ /** Manual `page()` — SPA route helper for non-history flows. */
23
+ page(override?: PageOverride): void;
24
+ /**
25
+ * Identify — anonymous → person merge.
26
+ * Stores person_id locally + best-effort POST /v1/ingest/identify.
27
+ */
28
+ identify(personId: string, traits?: Record<string, unknown>): Promise<void>;
29
+ /** Logout — wipes person_id, rotates anonymous_id, new session. */
30
+ reset(): void;
31
+ /** Manual flush — caller may await. */
32
+ flush(): Promise<void>;
33
+ /** Tracking opt-out — all subsequent track/identify no-op. */
34
+ optOut(): void;
35
+ /** Re-enable tracking. */
36
+ optIn(): void;
37
+ private queueEvent;
38
+ private snapshotConsent;
39
+ private consentAllowsAnalytics;
40
+ private buildContext;
41
+ }
42
+ //# sourceMappingURL=core.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAiB7C,OAAO,KAAK,EAIV,WAAW,EAEZ,MAAM,YAAY,CAAC;AA8BpB,MAAM,WAAW,YAAY;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,MAAM;IACjB,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,IAAI,CAA4B;IACxC,OAAO,CAAC,KAAK,CAA2B;IACxC,OAAO,CAAC,OAAO,CAA6B;IAC5C,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,iBAAiB,CAAwC;IACjE,OAAO,EAAG,aAAa,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IA8E7B,sEAAsE;IACtE,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAInE,gEAAgE;IAChE,IAAI,CAAC,QAAQ,CAAC,EAAE,YAAY,GAAG,IAAI;IAQnC;;;OAGG;IACG,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BjF,mEAAmE;IACnE,KAAK,IAAI,IAAI;IAeb,uCAAuC;IACjC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,8DAA8D;IAC9D,MAAM,IAAI,IAAI;IAId,0BAA0B;IAC1B,KAAK,IAAI,IAAI;IAMb,OAAO,CAAC,UAAU;IAgClB,OAAO,CAAC,eAAe;IAYvB,OAAO,CAAC,sBAAsB;IAM9B,OAAO,CAAC,YAAY;CAcrB"}
@@ -0,0 +1,21 @@
1
+ export declare class SDKError extends Error {
2
+ readonly code: string;
3
+ constructor(code: string, message: string);
4
+ }
5
+ export declare class InitError extends SDKError {
6
+ constructor(message: string);
7
+ }
8
+ export declare class NetworkError extends SDKError {
9
+ readonly status?: number;
10
+ constructor(message: string, status?: number);
11
+ }
12
+ export declare class QueueFullError extends SDKError {
13
+ constructor(message: string);
14
+ }
15
+ export declare class OptedOutError extends SDKError {
16
+ constructor();
17
+ }
18
+ export declare class ConsentBlockedError extends SDKError {
19
+ constructor();
20
+ }
21
+ //# sourceMappingURL=errors.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAIA,qBAAa,QAAS,SAAQ,KAAK;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBACV,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAK1C;AAED,qBAAa,SAAU,SAAQ,QAAQ;gBACzB,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,YAAa,SAAQ,QAAQ;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;gBACb,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;CAK7C;AAED,qBAAa,cAAe,SAAQ,QAAQ;gBAC9B,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,aAAc,SAAQ,QAAQ;;CAK1C;AAED,qBAAa,mBAAoB,SAAQ,QAAQ;;CAKhD"}
@@ -0,0 +1,6 @@
1
+ export declare function getOrCreateAnonymousId(): string;
2
+ export declare function setPersonId(personId: string): void;
3
+ export declare function getPersonId(): string | null;
4
+ export declare function clearIdentity(): string;
5
+ export declare function newEventId(): string;
6
+ //# sourceMappingURL=identity.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"identity.d.ts","sourceRoot":"","sources":["../src/identity.ts"],"names":[],"mappings":"AAwEA,wBAAgB,sBAAsB,IAAI,MAAM,CAY/C;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAElD;AAED,wBAAgB,WAAW,IAAI,MAAM,GAAG,IAAI,CAE3C;AAED,wBAAgB,aAAa,IAAI,MAAM,CAOtC;AAED,wBAAgB,UAAU,IAAI,MAAM,CAEnC"}
package/dist/index.d.ts CHANGED
@@ -1,80 +1,45 @@
1
- /**
2
- * @gurulu/web Gurulu Web SDK
3
- *
4
- * Programmatic interface for Gurulu analytics.
5
- * For React/Next.js, use `@gurulu/web/react` instead.
6
- */
7
- export interface GuruluConfig {
8
- siteId: string;
9
- token: string;
10
- endpoint?: string;
11
- features?: Array<'errors' | 'replay' | 'vitals'>;
12
- autoTrack?: boolean;
13
- consent?: 'full' | 'analytics' | 'necessary' | 'none';
14
- debug?: boolean;
1
+ export declare const VERSION = "0.1.0";
2
+ export { type BannerConfig, type BannerConfigResponse, type ConsentCategories, type ConsentSnapshot, GuruluConsent, type GuruluConsentOptions, } from './consent.ts';
3
+ export { Gurulu, type PageOverride } from './core.ts';
4
+ export { ConsentBlockedError, InitError, NetworkError, OptedOutError, QueueFullError, SDKError, } from './errors.ts';
5
+ export type { AutocaptureConfig, ClickIdContext, ConsentCategoriesState, EventContext, EventProducer, EventType, InitOptions, OutgoingEvent, UTMContext, } from './types.ts';
6
+ import { Gurulu } from './core.ts';
7
+ import type { InitOptions } from './types.ts';
8
+ export interface GuruluPublicSDK {
9
+ init: (opts: InitOptions) => void;
10
+ track: (eventKey: string, properties?: Record<string, unknown>) => void;
11
+ identify: (personId: string, traits?: Record<string, unknown>) => Promise<void>;
12
+ page: (override?: Parameters<Gurulu['page']>[0]) => void;
13
+ reset: () => void;
14
+ flush: () => Promise<void>;
15
+ optOut: () => void;
16
+ optIn: () => void;
17
+ consent: Gurulu['consent'];
18
+ VERSION: string;
15
19
  }
16
- export interface GuruluInstance {
17
- track: (eventName: string, properties?: Record<string, unknown>) => void;
18
- identify: (userId: string, traits?: Record<string, unknown>) => void;
19
- purchase: (params: {
20
- value: number;
21
- currency: string;
22
- transaction_id?: string;
23
- items?: unknown[];
24
- }) => void;
25
- subscribe: (params: {
26
- value: number;
27
- currency: string;
28
- plan_id?: string;
29
- interval?: string;
30
- }) => void;
31
- login: (params?: {
32
- method?: string;
33
- }) => void;
34
- signup: (params?: {
35
- method?: string;
36
- }) => void;
37
- logout: () => void;
38
- setConsent: (level: string) => void;
39
- destroy: () => void;
40
- }
41
- declare let _config: GuruluConfig | null;
42
- /**
43
- * Initialize the Gurulu tracker by injecting the script tag.
44
- * Call once at app startup.
45
- */
46
- export declare function init(config: GuruluConfig): void;
47
- /**
48
- * Get the global gurulu instance (available after tracker loads).
49
- */
50
- export declare function getInstance(): GuruluInstance | null;
51
- /**
52
- * Track a custom event.
53
- */
54
- export declare function track(eventName: string, properties?: Record<string, unknown>): void;
55
- /**
56
- * Identify a user with traits.
57
- */
58
- export declare function identify(userId: string, traits?: Record<string, unknown>): void;
59
- /**
60
- * Track a purchase event.
61
- */
62
- export declare function purchase(params: {
63
- value: number;
64
- currency: string;
65
- transaction_id?: string;
66
- }): void;
67
- /**
68
- * Track a subscription event.
69
- */
70
- export declare function subscribe(params: {
71
- value: number;
72
- currency: string;
73
- plan_id?: string;
74
- interval?: string;
75
- }): void;
76
20
  /**
77
- * Set consent level.
78
- */
79
- export declare function setConsent(level: string): void;
80
- export { _config as config };
21
+ * Factory `createGurulu()` returns an isolated instance (multi-tenant SDK or
22
+ * test harness). For 99% of consumers, prefer the default singleton via the
23
+ * default export below.
24
+ */
25
+ export declare function createGurulu(): Gurulu;
26
+ declare const publicSdk: {
27
+ init: (opts: InitOptions) => void;
28
+ track: (eventKey: string, properties?: Record<string, unknown>) => void;
29
+ identify: (personId: string, traits?: Record<string, unknown>) => Promise<void>;
30
+ page: (override?: Parameters<Gurulu["page"]>[0]) => void;
31
+ reset: () => void;
32
+ flush: () => Promise<void>;
33
+ optOut: () => void;
34
+ optIn: () => void;
35
+ readonly consent: import("./consent.ts").GuruluConsent;
36
+ VERSION: string;
37
+ };
38
+ /**
39
+ * Script-tag auto-init — reads `<script data-workspace="pk_xxx" ...>` and
40
+ * runs `init()` automatically. No-op in non-browser environments and when
41
+ * the script is loaded via ESM import (no `data-workspace` attr).
42
+ */
43
+ export declare function autoBootstrap(): void;
44
+ export default publicSdk;
45
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,OAAO,UAAU,CAAC;AAE/B,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,aAAa,EACb,KAAK,oBAAoB,GAC1B,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,MAAM,WAAW,CAAC;AACtD,OAAO,EACL,mBAAmB,EACnB,SAAS,EACT,YAAY,EACZ,aAAa,EACb,cAAc,EACd,QAAQ,GACT,MAAM,aAAa,CAAC;AACrB,YAAY,EACV,iBAAiB,EACjB,cAAc,EACd,sBAAsB,EACtB,YAAY,EACZ,aAAa,EACb,SAAS,EACT,WAAW,EACX,aAAa,EACb,UAAU,GACX,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAK9C,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAC;IAClC,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;IACxE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChF,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IACzD,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAErC;AAED,QAAA,MAAM,SAAS;iBACA,WAAW;sBACN,MAAM,eAAe,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;yBAEzC,MAAM,WAAW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;sBAE3C,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;;;;;;;CAShD,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAwBpC;AAOD,eAAe,SAAS,CAAC"}