@grainql/analytics-web 2.7.1 → 2.9.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.
Files changed (83) hide show
  1. package/README.md +36 -3
  2. package/dist/cjs/consent.d.ts +38 -7
  3. package/dist/cjs/consent.d.ts.map +1 -1
  4. package/dist/cjs/consent.js +82 -23
  5. package/dist/cjs/consent.js.map +1 -1
  6. package/dist/cjs/debug-agent.d.ts +171 -0
  7. package/dist/cjs/debug-agent.d.ts.map +1 -0
  8. package/dist/cjs/debug-agent.js +1219 -0
  9. package/dist/cjs/debug-agent.js.map +1 -0
  10. package/dist/cjs/id-manager.d.ts +66 -0
  11. package/dist/cjs/id-manager.d.ts.map +1 -0
  12. package/dist/cjs/id-manager.js +212 -0
  13. package/dist/cjs/id-manager.js.map +1 -0
  14. package/dist/cjs/index.d.ts +26 -8
  15. package/dist/cjs/index.d.ts.map +1 -1
  16. package/dist/cjs/index.js.map +1 -1
  17. package/dist/cjs/interaction-tracking.d.ts +6 -0
  18. package/dist/cjs/interaction-tracking.d.ts.map +1 -1
  19. package/dist/cjs/interaction-tracking.js +55 -5
  20. package/dist/cjs/interaction-tracking.js.map +1 -1
  21. package/dist/cjs/page-tracking.d.ts +6 -0
  22. package/dist/cjs/page-tracking.d.ts.map +1 -1
  23. package/dist/cjs/page-tracking.js +23 -2
  24. package/dist/cjs/page-tracking.js.map +1 -1
  25. package/dist/cjs/react/hooks/useConsent.d.ts +18 -2
  26. package/dist/cjs/react/hooks/useConsent.d.ts.map +1 -1
  27. package/dist/cjs/react/hooks/useConsent.js +52 -1
  28. package/dist/cjs/react/hooks/useConsent.js.map +1 -1
  29. package/dist/consent.d.ts +38 -7
  30. package/dist/consent.d.ts.map +1 -1
  31. package/dist/consent.js +82 -23
  32. package/dist/debug-agent.d.ts +171 -0
  33. package/dist/debug-agent.d.ts.map +1 -0
  34. package/dist/debug-agent.js +1219 -0
  35. package/dist/esm/consent.d.ts +38 -7
  36. package/dist/esm/consent.d.ts.map +1 -1
  37. package/dist/esm/consent.js +82 -23
  38. package/dist/esm/consent.js.map +1 -1
  39. package/dist/esm/debug-agent.d.ts +171 -0
  40. package/dist/esm/debug-agent.d.ts.map +1 -0
  41. package/dist/esm/debug-agent.js +1215 -0
  42. package/dist/esm/debug-agent.js.map +1 -0
  43. package/dist/esm/id-manager.d.ts +66 -0
  44. package/dist/esm/id-manager.d.ts.map +1 -0
  45. package/dist/esm/id-manager.js +208 -0
  46. package/dist/esm/id-manager.js.map +1 -0
  47. package/dist/esm/index.d.ts +26 -8
  48. package/dist/esm/index.d.ts.map +1 -1
  49. package/dist/esm/index.js.map +1 -1
  50. package/dist/esm/interaction-tracking.d.ts +6 -0
  51. package/dist/esm/interaction-tracking.d.ts.map +1 -1
  52. package/dist/esm/interaction-tracking.js +55 -5
  53. package/dist/esm/interaction-tracking.js.map +1 -1
  54. package/dist/esm/page-tracking.d.ts +6 -0
  55. package/dist/esm/page-tracking.d.ts.map +1 -1
  56. package/dist/esm/page-tracking.js +23 -2
  57. package/dist/esm/page-tracking.js.map +1 -1
  58. package/dist/esm/react/hooks/useConsent.d.ts +18 -2
  59. package/dist/esm/react/hooks/useConsent.d.ts.map +1 -1
  60. package/dist/esm/react/hooks/useConsent.js +49 -1
  61. package/dist/esm/react/hooks/useConsent.js.map +1 -1
  62. package/dist/id-manager.d.ts +66 -0
  63. package/dist/id-manager.d.ts.map +1 -0
  64. package/dist/id-manager.js +212 -0
  65. package/dist/index.d.ts +26 -8
  66. package/dist/index.d.ts.map +1 -1
  67. package/dist/index.global.dev.js +1635 -86
  68. package/dist/index.global.dev.js.map +4 -4
  69. package/dist/index.global.js +506 -2
  70. package/dist/index.global.js.map +4 -4
  71. package/dist/index.js +171 -44
  72. package/dist/index.mjs +172 -45
  73. package/dist/interaction-tracking.d.ts +6 -0
  74. package/dist/interaction-tracking.d.ts.map +1 -1
  75. package/dist/interaction-tracking.js +55 -5
  76. package/dist/page-tracking.d.ts +6 -0
  77. package/dist/page-tracking.d.ts.map +1 -1
  78. package/dist/page-tracking.js +23 -2
  79. package/dist/react/hooks/useConsent.d.ts +18 -2
  80. package/dist/react/hooks/useConsent.d.ts.map +1 -1
  81. package/dist/react/hooks/useConsent.js +52 -1
  82. package/dist/react/hooks/useConsent.mjs +49 -1
  83. package/package.json +1 -1
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * useConsent - Hook for managing user consent
3
+ * useConsent - Hook for managing user consent (v2.0)
4
+ * Updated for new consent modes: cookieless, gdpr-strict, gdpr-opt-out
4
5
  */
5
6
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
7
  if (k2 === undefined) k2 = k;
@@ -37,6 +38,9 @@ var __importStar = (this && this.__importStar) || (function () {
37
38
  })();
38
39
  Object.defineProperty(exports, "__esModule", { value: true });
39
40
  exports.useConsent = useConsent;
41
+ exports.useConsentMode = useConsentMode;
42
+ exports.useTrackingId = useTrackingId;
43
+ exports.useCanTrack = useCanTrack;
40
44
  const React = __importStar(require("react"));
41
45
  const useGrainAnalytics_1 = require("./useGrainAnalytics");
42
46
  function useConsent() {
@@ -81,4 +85,51 @@ function useConsent() {
81
85
  categories: consentState?.categories ?? [],
82
86
  };
83
87
  }
88
+ /**
89
+ * useConsentMode - Hook to get current consent mode
90
+ * v2.0: Returns 'cookieless' | 'gdpr-strict' | 'gdpr-opt-out'
91
+ */
92
+ function useConsentMode() {
93
+ const client = (0, useGrainAnalytics_1.useGrainAnalytics)();
94
+ const [mode, setMode] = React.useState(null);
95
+ React.useEffect(() => {
96
+ if (!client)
97
+ return;
98
+ // Access internal consent manager via client methods
99
+ // This is a simplified version - mode doesn't change at runtime
100
+ const config = client.config;
101
+ setMode(config?.consentMode ?? 'cookieless');
102
+ }, [client]);
103
+ return mode;
104
+ }
105
+ /**
106
+ * useTrackingId - Hook to get current tracking ID
107
+ * v2.0: Returns daily rotating ID or permanent ID based on consent
108
+ */
109
+ function useTrackingId() {
110
+ const client = (0, useGrainAnalytics_1.useGrainAnalytics)();
111
+ const [trackingId, setTrackingId] = React.useState(null);
112
+ const { consentState } = useConsent();
113
+ React.useEffect(() => {
114
+ if (!client)
115
+ return;
116
+ try {
117
+ const id = client.getEffectiveUserId();
118
+ setTrackingId(id);
119
+ }
120
+ catch (error) {
121
+ console.warn('Failed to get tracking ID:', error);
122
+ }
123
+ }, [client, consentState]); // Re-fetch when consent changes
124
+ return trackingId;
125
+ }
126
+ /**
127
+ * useCanTrack - Hook to check if tracking is allowed
128
+ * v2.0: Always returns true (even cookieless mode allows basic tracking)
129
+ */
130
+ function useCanTrack() {
131
+ const mode = useConsentMode();
132
+ // All modes allow some form of tracking in v2.0
133
+ return mode !== null;
134
+ }
84
135
  //# sourceMappingURL=useConsent.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"useConsent.js","sourceRoot":"","sources":["../../../../src/react/hooks/useConsent.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMH,gCAyDC;AA7DD,6CAA+B;AAC/B,2DAAwD;AAGxD,SAAgB,UAAU;IACxB,MAAM,MAAM,GAAG,IAAA,qCAAiB,GAAE,CAAC;IACnC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAsB,IAAI,CAAC,CAAC;IAElF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,CAAC,MAAM;YAAE,OAAO;QAEpB,4BAA4B;QAC5B,MAAM,YAAY,GAAG,MAAM,CAAC,eAAe,EAAE,CAAC;QAC9C,eAAe,CAAC,YAAY,CAAC,CAAC;QAE9B,6BAA6B;QAC7B,MAAM,QAAQ,GAAG,CAAC,KAAmB,EAAE,EAAE;YACvC,eAAe,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC,CAAC;QAEF,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAEjC,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,MAAM,YAAY,GAAG,KAAK,CAAC,WAAW,CACpC,CAAC,UAAqB,EAAE,EAAE;QACxB,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAClC,CAAC;IACH,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,MAAM,aAAa,GAAG,KAAK,CAAC,WAAW,CACrC,CAAC,UAAqB,EAAE,EAAE;QACxB,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACnC,CAAC;IACH,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAClC,CAAC,QAAiB,EAAE,EAAE;QACpB,IAAI,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAC1B,OAAO,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,OAAO;QACL,YAAY;QACZ,YAAY;QACZ,aAAa;QACb,UAAU;QACV,SAAS,EAAE,YAAY,EAAE,OAAO,IAAI,KAAK;QACzC,UAAU,EAAE,YAAY,EAAE,UAAU,IAAI,EAAE;KAC3C,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"useConsent.js","sourceRoot":"","sources":["../../../../src/react/hooks/useConsent.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMH,gCAyDC;AAMD,wCAaC;AAMD,sCAiBC;AAMD,kCAKC;AAlHD,6CAA+B;AAC/B,2DAAwD;AAGxD,SAAgB,UAAU;IACxB,MAAM,MAAM,GAAG,IAAA,qCAAiB,GAAE,CAAC;IACnC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAsB,IAAI,CAAC,CAAC;IAElF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,CAAC,MAAM;YAAE,OAAO;QAEpB,4BAA4B;QAC5B,MAAM,YAAY,GAAG,MAAM,CAAC,eAAe,EAAE,CAAC;QAC9C,eAAe,CAAC,YAAY,CAAC,CAAC;QAE9B,6BAA6B;QAC7B,MAAM,QAAQ,GAAG,CAAC,KAAmB,EAAE,EAAE;YACvC,eAAe,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC,CAAC;QAEF,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAEjC,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,MAAM,YAAY,GAAG,KAAK,CAAC,WAAW,CACpC,CAAC,UAAqB,EAAE,EAAE;QACxB,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAClC,CAAC;IACH,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,MAAM,aAAa,GAAG,KAAK,CAAC,WAAW,CACrC,CAAC,UAAqB,EAAE,EAAE;QACxB,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACnC,CAAC;IACH,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAClC,CAAC,QAAiB,EAAE,EAAE;QACpB,IAAI,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAC1B,OAAO,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,OAAO;QACL,YAAY;QACZ,YAAY;QACZ,aAAa;QACb,UAAU;QACV,SAAS,EAAE,YAAY,EAAE,OAAO,IAAI,KAAK;QACzC,UAAU,EAAE,YAAY,EAAE,UAAU,IAAI,EAAE;KAC3C,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,cAAc;IAC5B,MAAM,MAAM,GAAG,IAAA,qCAAiB,GAAE,CAAC;IACnC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAqB,IAAI,CAAC,CAAC;IAEjE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,CAAC,MAAM;YAAE,OAAO;QACpB,qDAAqD;QACrD,gEAAgE;QAChE,MAAM,MAAM,GAAI,MAAc,CAAC,MAAM,CAAC;QACtC,OAAO,CAAC,MAAM,EAAE,WAAW,IAAI,YAAY,CAAC,CAAC;IAC/C,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,SAAgB,aAAa;IAC3B,MAAM,MAAM,GAAG,IAAA,qCAAiB,GAAE,CAAC;IACnC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAgB,IAAI,CAAC,CAAC;IACxE,MAAM,EAAE,YAAY,EAAE,GAAG,UAAU,EAAE,CAAC;IAEtC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,CAAC,MAAM;YAAE,OAAO;QAEpB,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,MAAM,CAAC,kBAAkB,EAAE,CAAC;YACvC,aAAa,CAAC,EAAE,CAAC,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAC;QACpD,CAAC;IACH,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,gCAAgC;IAE5D,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,SAAgB,WAAW;IACzB,MAAM,IAAI,GAAG,cAAc,EAAE,CAAC;IAE9B,gDAAgD;IAChD,OAAO,IAAI,KAAK,IAAI,CAAC;AACvB,CAAC"}
package/dist/consent.d.ts CHANGED
@@ -1,8 +1,13 @@
1
1
  /**
2
- * Consent management for Grain Analytics
3
- * Handles GDPR-compliant consent tracking and state management
2
+ * Consent management for Grain Analytics v2.0
3
+ * Privacy-first, cookie-less by default
4
+ *
5
+ * Consent Modes:
6
+ * - cookieless: Default mode, daily rotating IDs, no consent needed
7
+ * - gdpr-strict: Requires explicit consent, falls back to cookieless
8
+ * - gdpr-opt-out: Permanent IDs by default, cookieless on opt-out
4
9
  */
5
- export type ConsentMode = 'opt-in' | 'opt-out' | 'disabled';
10
+ export type ConsentMode = 'cookieless' | 'gdpr-strict' | 'gdpr-opt-out';
6
11
  export interface ConsentState {
7
12
  granted: boolean;
8
13
  categories: string[];
@@ -13,6 +18,7 @@ export declare const DEFAULT_CONSENT_CATEGORIES: string[];
13
18
  export declare const CONSENT_VERSION = "1.0.0";
14
19
  /**
15
20
  * Consent manager for handling user consent state
21
+ * v2.0: Cookie-less by default, privacy-first approach
16
22
  */
17
23
  export declare class ConsentManager {
18
24
  private consentState;
@@ -23,9 +29,8 @@ export declare class ConsentManager {
23
29
  /**
24
30
  * Load consent state from localStorage
25
31
  *
26
- * GDPR Compliance: In opt-in mode, we can use localStorage for consent preferences
27
- * since storing consent choices is a legitimate interest and necessary for compliance.
28
- * The consent preference itself is not tracking data.
32
+ * GDPR Compliance: localStorage only used for storing consent preferences
33
+ * (not for tracking), which is a legitimate interest for compliance.
29
34
  */
30
35
  private loadConsentState;
31
36
  /**
@@ -45,11 +50,28 @@ export declare class ConsentManager {
45
50
  */
46
51
  getConsentState(): ConsentState | null;
47
52
  /**
48
- * Check if user has granted consent
53
+ * Check if user has granted consent for permanent IDs
49
54
  */
50
55
  hasConsent(category?: string): boolean;
56
+ /**
57
+ * Check if permanent IDs are allowed
58
+ */
59
+ shouldUsePermanentId(): boolean;
60
+ /**
61
+ * Check if we should strip query parameters from URLs
62
+ * Query params stripped unless:
63
+ * - Mode is gdpr-opt-out, OR
64
+ * - Mode is gdpr-strict AND consent given
65
+ */
66
+ shouldStripQueryParams(): boolean;
67
+ /**
68
+ * Check if we can track events (always true in v2.0)
69
+ * Even cookieless mode allows basic analytics with daily IDs
70
+ */
71
+ canTrack(): boolean;
51
72
  /**
52
73
  * Check if we should wait for consent before tracking
74
+ * Only relevant for GDPR Strict mode
53
75
  */
54
76
  shouldWaitForConsent(): boolean;
55
77
  /**
@@ -68,5 +90,14 @@ export declare class ConsentManager {
68
90
  * Clear all consent data
69
91
  */
70
92
  clearConsent(): void;
93
+ /**
94
+ * Get current consent mode
95
+ */
96
+ getConsentMode(): ConsentMode;
97
+ /**
98
+ * Get ID mode based on consent state
99
+ * Returns 'cookieless' or 'permanent'
100
+ */
101
+ getIdMode(): 'cookieless' | 'permanent';
71
102
  }
72
103
  //# sourceMappingURL=consent.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"consent.d.ts","sourceRoot":"","sources":["../src/consent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;AAE5D,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,eAAO,MAAM,0BAA0B,UAA2C,CAAC;AACnF,eAAO,MAAM,eAAe,UAAU,CAAC;AAEvC;;GAEG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,YAAY,CAA6B;IACjD,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,SAAS,CAA4C;gBAEjD,QAAQ,EAAE,MAAM,EAAE,WAAW,GAAE,WAAuB;IAMlE;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IA2BxB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAUxB;;OAEG;IACH,YAAY,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IAczC;;OAEG;IACH,aAAa,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IA8B1C;;OAEG;IACH,eAAe,IAAI,YAAY,GAAG,IAAI;IAItC;;OAEG;IACH,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO;IAwBtC;;OAEG;IACH,oBAAoB,IAAI,OAAO;IAI/B;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI;IAI1D;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI;IAO7D;;OAEG;IACH,OAAO,CAAC,eAAe;IAYvB;;OAEG;IACH,YAAY,IAAI,IAAI;CAUrB"}
1
+ {"version":3,"file":"consent.d.ts","sourceRoot":"","sources":["../src/consent.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,aAAa,GAAG,cAAc,CAAC;AAExE,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,eAAO,MAAM,0BAA0B,UAA2C,CAAC;AACnF,eAAO,MAAM,eAAe,UAAU,CAAC;AAEvC;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,YAAY,CAA6B;IACjD,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,SAAS,CAA4C;gBAEjD,QAAQ,EAAE,MAAM,EAAE,WAAW,GAAE,WAA0B;IAMrE;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IA2BxB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAUxB;;OAEG;IACH,YAAY,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IAczC;;OAEG;IACH,aAAa,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IA8B1C;;OAEG;IACH,eAAe,IAAI,YAAY,GAAG,IAAI;IAItC;;OAEG;IACH,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO;IAiCtC;;OAEG;IACH,oBAAoB,IAAI,OAAO;IAI/B;;;;;OAKG;IACH,sBAAsB,IAAI,OAAO;IAgBjC;;;OAGG;IACH,QAAQ,IAAI,OAAO;IAInB;;;OAGG;IACH,oBAAoB,IAAI,OAAO;IAI/B;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI;IAI1D;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI;IAO7D;;OAEG;IACH,OAAO,CAAC,eAAe;IAYvB;;OAEG;IACH,YAAY,IAAI,IAAI;IAWpB;;OAEG;IACH,cAAc,IAAI,WAAW;IAI7B;;;OAGG;IACH,SAAS,IAAI,YAAY,GAAG,WAAW;CAGxC"}
package/dist/consent.js CHANGED
@@ -1,7 +1,12 @@
1
1
  "use strict";
2
2
  /**
3
- * Consent management for Grain Analytics
4
- * Handles GDPR-compliant consent tracking and state management
3
+ * Consent management for Grain Analytics v2.0
4
+ * Privacy-first, cookie-less by default
5
+ *
6
+ * Consent Modes:
7
+ * - cookieless: Default mode, daily rotating IDs, no consent needed
8
+ * - gdpr-strict: Requires explicit consent, falls back to cookieless
9
+ * - gdpr-opt-out: Permanent IDs by default, cookieless on opt-out
5
10
  */
6
11
  Object.defineProperty(exports, "__esModule", { value: true });
7
12
  exports.ConsentManager = exports.CONSENT_VERSION = exports.DEFAULT_CONSENT_CATEGORIES = void 0;
@@ -9,9 +14,10 @@ exports.DEFAULT_CONSENT_CATEGORIES = ['necessary', 'analytics', 'functional'];
9
14
  exports.CONSENT_VERSION = '1.0.0';
10
15
  /**
11
16
  * Consent manager for handling user consent state
17
+ * v2.0: Cookie-less by default, privacy-first approach
12
18
  */
13
19
  class ConsentManager {
14
- constructor(tenantId, consentMode = 'opt-out') {
20
+ constructor(tenantId, consentMode = 'cookieless') {
15
21
  this.consentState = null;
16
22
  this.listeners = [];
17
23
  this.consentMode = consentMode;
@@ -21,9 +27,8 @@ class ConsentManager {
21
27
  /**
22
28
  * Load consent state from localStorage
23
29
  *
24
- * GDPR Compliance: In opt-in mode, we can use localStorage for consent preferences
25
- * since storing consent choices is a legitimate interest and necessary for compliance.
26
- * The consent preference itself is not tracking data.
30
+ * GDPR Compliance: localStorage only used for storing consent preferences
31
+ * (not for tracking), which is a legitimate interest for compliance.
27
32
  */
28
33
  loadConsentState() {
29
34
  if (typeof window === 'undefined')
@@ -37,8 +42,8 @@ class ConsentManager {
37
42
  timestamp: new Date(parsed.timestamp),
38
43
  };
39
44
  }
40
- else if (this.consentMode === 'opt-out' || this.consentMode === 'disabled') {
41
- // Auto-grant consent for opt-out and disabled modes
45
+ else if (this.consentMode === 'gdpr-opt-out') {
46
+ // Auto-grant consent for opt-out mode (user hasn't opted out yet)
42
47
  this.consentState = {
43
48
  granted: true,
44
49
  categories: exports.DEFAULT_CONSENT_CATEGORIES,
@@ -47,10 +52,10 @@ class ConsentManager {
47
52
  };
48
53
  this.saveConsentState();
49
54
  }
50
- // Note: In opt-in mode without stored consent, consentState remains null (no consent)
55
+ // Note: cookieless and gdpr-strict modes without stored consent no permanent tracking
51
56
  }
52
57
  catch (error) {
53
- // Silent failure - consent will be requested when needed
58
+ // Silent failure - will use cookieless mode by default
54
59
  }
55
60
  }
56
61
  /**
@@ -120,32 +125,73 @@ class ConsentManager {
120
125
  return this.consentState ? { ...this.consentState } : null;
121
126
  }
122
127
  /**
123
- * Check if user has granted consent
128
+ * Check if user has granted consent for permanent IDs
124
129
  */
125
130
  hasConsent(category) {
126
- // Disabled mode always returns true (no consent required)
127
- if (this.consentMode === 'disabled') {
128
- return true;
131
+ // Cookie-less mode: no consent needed (no permanent tracking)
132
+ if (this.consentMode === 'cookieless') {
133
+ return false; // No permanent IDs
129
134
  }
130
- // No consent state in opt-in mode means no consent
131
- if (this.consentMode === 'opt-in' && !this.consentState) {
132
- return false;
135
+ // GDPR Strict: requires explicit consent
136
+ if (this.consentMode === 'gdpr-strict') {
137
+ if (!this.consentState?.granted) {
138
+ return false;
139
+ }
133
140
  }
134
- // Check consent state
135
- if (!this.consentState?.granted) {
136
- return false;
141
+ // GDPR Opt-out: consent by default unless explicitly revoked
142
+ if (this.consentMode === 'gdpr-opt-out') {
143
+ // If no state, assume consent (opt-out model)
144
+ if (!this.consentState) {
145
+ return true;
146
+ }
147
+ // Check if consent was revoked
148
+ if (!this.consentState.granted) {
149
+ return false;
150
+ }
137
151
  }
138
152
  // Check specific category if provided
139
- if (category) {
153
+ if (category && this.consentState) {
140
154
  return this.consentState.categories.includes(category);
141
155
  }
142
- return true;
156
+ return this.consentState?.granted ?? (this.consentMode === 'gdpr-opt-out');
157
+ }
158
+ /**
159
+ * Check if permanent IDs are allowed
160
+ */
161
+ shouldUsePermanentId() {
162
+ return this.hasConsent();
163
+ }
164
+ /**
165
+ * Check if we should strip query parameters from URLs
166
+ * Query params stripped unless:
167
+ * - Mode is gdpr-opt-out, OR
168
+ * - Mode is gdpr-strict AND consent given
169
+ */
170
+ shouldStripQueryParams() {
171
+ if (this.consentMode === 'cookieless') {
172
+ return true; // Always strip in cookieless mode
173
+ }
174
+ if (this.consentMode === 'gdpr-strict') {
175
+ return !this.hasConsent(); // Strip unless consented
176
+ }
177
+ if (this.consentMode === 'gdpr-opt-out') {
178
+ return false; // Don't strip in opt-out mode
179
+ }
180
+ return true; // Default: strip
181
+ }
182
+ /**
183
+ * Check if we can track events (always true in v2.0)
184
+ * Even cookieless mode allows basic analytics with daily IDs
185
+ */
186
+ canTrack() {
187
+ return true; // All modes allow some form of tracking
143
188
  }
144
189
  /**
145
190
  * Check if we should wait for consent before tracking
191
+ * Only relevant for GDPR Strict mode
146
192
  */
147
193
  shouldWaitForConsent() {
148
- return this.consentMode === 'opt-in' && !this.consentState?.granted;
194
+ return this.consentMode === 'gdpr-strict' && !this.consentState?.granted;
149
195
  }
150
196
  /**
151
197
  * Add consent change listener
@@ -191,6 +237,19 @@ class ConsentManager {
191
237
  // Silent failure - consent state may not be fully cleared
192
238
  }
193
239
  }
240
+ /**
241
+ * Get current consent mode
242
+ */
243
+ getConsentMode() {
244
+ return this.consentMode;
245
+ }
246
+ /**
247
+ * Get ID mode based on consent state
248
+ * Returns 'cookieless' or 'permanent'
249
+ */
250
+ getIdMode() {
251
+ return this.shouldUsePermanentId() ? 'permanent' : 'cookieless';
252
+ }
194
253
  }
195
254
  exports.ConsentManager = ConsentManager;
196
255
  //# sourceMappingURL=consent.js.map
@@ -0,0 +1,171 @@
1
+ /**
2
+ * Debug Agent for Visual Event Tracking
3
+ * Provides a toolbar and element inspection mode for creating event trackers
4
+ */
5
+ export interface DebugAgentConfig {
6
+ debug?: boolean;
7
+ }
8
+ export interface Tracker {
9
+ track(eventName: string, properties?: Record<string, unknown>): void | Promise<void>;
10
+ log(...args: unknown[]): void;
11
+ }
12
+ export interface ExistingTracker {
13
+ trackerId: string;
14
+ name: string;
15
+ type: string;
16
+ selector: string;
17
+ urlScope: string;
18
+ urlPattern?: string;
19
+ isEnabled: boolean;
20
+ }
21
+ export declare class DebugAgent {
22
+ private tracker;
23
+ private sessionId;
24
+ private tenantId;
25
+ private apiUrl;
26
+ private config;
27
+ private isDestroyed;
28
+ private isInspectMode;
29
+ private showTrackers;
30
+ private selectedElement;
31
+ private toolbarElement;
32
+ private panelElement;
33
+ private highlightElement;
34
+ private existingTrackers;
35
+ private trackerHighlights;
36
+ private isDragging;
37
+ private dragStartX;
38
+ private dragStartY;
39
+ private toolbarStartX;
40
+ private toolbarStartY;
41
+ private mouseMoveListener;
42
+ private clickListener;
43
+ private dragMoveListener;
44
+ private dragEndListener;
45
+ constructor(tracker: Tracker, sessionId: string, tenantId: string, apiUrl: string, config?: DebugAgentConfig);
46
+ /**
47
+ * Initialize the debug agent
48
+ */
49
+ private initialize;
50
+ /**
51
+ * Load existing trackers from API
52
+ */
53
+ private loadExistingTrackers;
54
+ /**
55
+ * Show the debug toolbar
56
+ */
57
+ private showToolbar;
58
+ /**
59
+ * Create highlight element for hovering
60
+ */
61
+ private createHighlightElement;
62
+ /**
63
+ * Start dragging the toolbar
64
+ */
65
+ private startDrag;
66
+ /**
67
+ * Handle drag movement
68
+ */
69
+ private onDrag;
70
+ /**
71
+ * End dragging
72
+ */
73
+ private endDrag;
74
+ /**
75
+ * Toggle tracker view
76
+ */
77
+ private toggleTrackerView;
78
+ /**
79
+ * Show tracker highlights on page
80
+ */
81
+ private showTrackerHighlights;
82
+ /**
83
+ * Hide tracker highlights
84
+ */
85
+ private hideTrackerHighlights;
86
+ /**
87
+ * Show trackers list
88
+ */
89
+ private showTrackersList;
90
+ /**
91
+ * Hide trackers list
92
+ */
93
+ private hideTrackersList;
94
+ /**
95
+ * Scroll to and highlight a tracker element
96
+ */
97
+ private scrollToTracker;
98
+ /**
99
+ * Find element by XPath selector
100
+ */
101
+ private findElementBySelector;
102
+ /**
103
+ * Toggle inspect mode
104
+ */
105
+ private toggleInspectMode;
106
+ /**
107
+ * Enable element inspection mode
108
+ */
109
+ private enableInspectMode;
110
+ /**
111
+ * Handle ESC key to exit inspect mode
112
+ */
113
+ private handleEscapeKey;
114
+ /**
115
+ * Disable element inspection mode
116
+ */
117
+ private disableInspectMode;
118
+ /**
119
+ * Handle mouse move to highlight hovered element
120
+ */
121
+ private handleMouseMove;
122
+ /**
123
+ * Handle element click to show creation panel
124
+ */
125
+ private handleElementClick;
126
+ /**
127
+ * Show tracker creation panel
128
+ */
129
+ private showCreationPanel;
130
+ /**
131
+ * Generate suggested event name from element
132
+ */
133
+ private generateEventName;
134
+ /**
135
+ * Handle tracker creation
136
+ */
137
+ private handleCreateTracker;
138
+ /**
139
+ * Create tracker via API
140
+ */
141
+ private createTracker;
142
+ /**
143
+ * Hide creation panel
144
+ */
145
+ private hideCreationPanel;
146
+ /**
147
+ * Show success message
148
+ */
149
+ private showSuccessMessage;
150
+ /**
151
+ * End debug session
152
+ */
153
+ private endDebug;
154
+ /**
155
+ * Get XPath for element
156
+ */
157
+ private getXPathForElement;
158
+ /**
159
+ * Log debug messages
160
+ */
161
+ private log;
162
+ /**
163
+ * Update toolbar stats
164
+ */
165
+ private updateToolbarStats;
166
+ /**
167
+ * Destroy the debug agent
168
+ */
169
+ destroy(): void;
170
+ }
171
+ //# sourceMappingURL=debug-agent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"debug-agent.d.ts","sourceRoot":"","sources":["../src/debug-agent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,OAAO;IACtB,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrF,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,qBAAa,UAAU;IACrB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,WAAW,CAAS;IAG5B,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,eAAe,CAAwB;IAC/C,OAAO,CAAC,cAAc,CAA4B;IAClD,OAAO,CAAC,YAAY,CAA4B;IAChD,OAAO,CAAC,gBAAgB,CAA4B;IACpD,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,iBAAiB,CAAqB;IAG9C,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,aAAa,CAAK;IAG1B,OAAO,CAAC,iBAAiB,CAA0C;IACnE,OAAO,CAAC,aAAa,CAA0C;IAC/D,OAAO,CAAC,gBAAgB,CAA0C;IAClE,OAAO,CAAC,eAAe,CAA0C;gBAG/D,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,gBAAqB;IAe/B;;OAEG;YACW,UAAU;IAYxB;;OAEG;YACW,oBAAoB;IAelC;;OAEG;IACH,OAAO,CAAC,WAAW;IAkTnB;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAU9B;;OAEG;IACH,OAAO,CAAC,SAAS;IAoBjB;;OAEG;IACH,OAAO,CAAC,MAAM;IAsBd;;OAEG;IACH,OAAO,CAAC,OAAO;IAoBf;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAkBzB;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAgC7B;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAO7B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAwCxB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAOxB;;OAEG;IACH,OAAO,CAAC,eAAe;IA+BvB;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAgB7B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAwBzB;;OAEG;IACH,OAAO,CAAC,eAAe,CAIrB;IAEF;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAgC1B;;OAEG;IACH,OAAO,CAAC,eAAe;IAwBvB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA2B1B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IA8PzB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAmBzB;;OAEG;YACW,mBAAmB;IAoEjC;;OAEG;YACW,aAAa;IA4B3B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA2C1B;;OAEG;YACW,QAAQ;IAyBtB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA6B1B;;OAEG;IACH,OAAO,CAAC,GAAG;IAMX;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;OAEG;IACH,OAAO,IAAI,IAAI;CAyBhB"}