@cloudscaile-eng/web-ext-utils 0.0.2 → 0.0.4
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/README.md +9 -11
- package/dist/cs-ext-utils.untrimmed.d.ts +7 -9
- package/dist/index.d.ts +7 -9
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +8 -10
- package/dist/index.js.map +1 -1
- package/package.json +3 -4
package/README.md
CHANGED
|
@@ -61,7 +61,7 @@ import {
|
|
|
61
61
|
getCookieConsent,
|
|
62
62
|
updateCookieConsent,
|
|
63
63
|
resetCookieConsent,
|
|
64
|
-
|
|
64
|
+
trackGA4Event
|
|
65
65
|
} from '@cloudscaile-eng/web-ext-utils';
|
|
66
66
|
|
|
67
67
|
// Create extension object
|
|
@@ -101,9 +101,9 @@ const consent = getCookieConsent(extension); // { status: 'pending', timestamp:
|
|
|
101
101
|
updateCookieConsent(extension, 'accepted');
|
|
102
102
|
resetCookieConsent(extension);
|
|
103
103
|
|
|
104
|
-
// Track
|
|
105
|
-
|
|
106
|
-
|
|
104
|
+
// Track GA4 events (no-ops if consent not given)
|
|
105
|
+
trackGA4Event(extension, 'login', { method: 'email' });
|
|
106
|
+
trackGA4Event(extension, 'purchase', { item: 'cart', value: 49 });
|
|
107
107
|
```
|
|
108
108
|
|
|
109
109
|
## API Reference
|
|
@@ -128,7 +128,7 @@ Initializes shared resources in the host application.
|
|
|
128
128
|
- `config.getCookieConsent`: Function to retrieve the current cookie consent state.
|
|
129
129
|
- `config.updateCookieConsent`: Function to dispatch consent actions and initialize analytics on acceptance.
|
|
130
130
|
- `config.resetCookieConsent`: Function to reset consent state and stop analytics events.
|
|
131
|
-
- `config.
|
|
131
|
+
- `config.trackGA4Event`: Function to track a GA4 event.
|
|
132
132
|
|
|
133
133
|
#### Returns
|
|
134
134
|
|
|
@@ -286,17 +286,15 @@ Resets the cookie consent state and stops further analytics events by calling `r
|
|
|
286
286
|
|
|
287
287
|
- `extension`: Extension object from `getExtension()`.
|
|
288
288
|
|
|
289
|
-
#### `
|
|
289
|
+
#### `trackGA4Event(extension, eventName, params?)`
|
|
290
290
|
|
|
291
|
-
Tracks
|
|
291
|
+
Tracks a GA4 event. Silently no-ops if analytics has not been initialized (i.e. consent not yet given).
|
|
292
292
|
|
|
293
293
|
**Parameters:**
|
|
294
294
|
|
|
295
295
|
- `extension`: Extension object from `getExtension()`.
|
|
296
|
-
- `
|
|
297
|
-
- `
|
|
298
|
-
- `label`: Optional event label.
|
|
299
|
-
- `value`: Optional numeric event value.
|
|
296
|
+
- `eventName`: The GA4 event name (e.g. `'login'`, `'purchase'`).
|
|
297
|
+
- `params`: Optional object of event parameters (e.g. `{ method: 'email' }`).
|
|
300
298
|
|
|
301
299
|
## Error Handling
|
|
302
300
|
|
|
@@ -161,7 +161,7 @@ export declare interface HostConfig {
|
|
|
161
161
|
getCookieConsent: SharedResources['getCookieConsent'];
|
|
162
162
|
updateCookieConsent: SharedResources['updateCookieConsent'];
|
|
163
163
|
resetCookieConsent: SharedResources['resetCookieConsent'];
|
|
164
|
-
|
|
164
|
+
trackGA4Event: SharedResources['trackGA4Event'];
|
|
165
165
|
}
|
|
166
166
|
|
|
167
167
|
/**
|
|
@@ -180,7 +180,7 @@ export declare interface HostConfig {
|
|
|
180
180
|
* - getCookieConsent: Function to retrieve the current cookie consent state
|
|
181
181
|
* - updateCookieConsent: Function to dispatch consent actions and initialize analytics on acceptance
|
|
182
182
|
* - resetCookieConsent: Function to reset consent state and stop analytics events
|
|
183
|
-
* -
|
|
183
|
+
* - trackGA4Event: Function to track a GA4 event
|
|
184
184
|
* @throws Will throw an error if any required configuration is missing
|
|
185
185
|
* @returns Object with method to access shared resources
|
|
186
186
|
* @public
|
|
@@ -272,7 +272,7 @@ export declare interface SharedResources {
|
|
|
272
272
|
getCookieConsent: () => CookieConsent;
|
|
273
273
|
updateCookieConsent: (status: CookieConsentStatus) => void;
|
|
274
274
|
resetCookieConsent: () => void;
|
|
275
|
-
|
|
275
|
+
trackGA4Event: (eventName: string, params?: Record<string, unknown>) => void;
|
|
276
276
|
}
|
|
277
277
|
|
|
278
278
|
export { StoreEnhancer }
|
|
@@ -299,16 +299,14 @@ export declare function toast(extension: Extension, message: string, type: Toast
|
|
|
299
299
|
export declare type ToastType = 'success' | 'error' | 'info' | 'warn';
|
|
300
300
|
|
|
301
301
|
/**
|
|
302
|
-
* Tracks
|
|
302
|
+
* Tracks a GA4 event for the given extension.
|
|
303
303
|
* Silently no-ops if analytics has not been initialized (consent not given).
|
|
304
304
|
* @param extension - The extension object.
|
|
305
|
-
* @param
|
|
306
|
-
* @param
|
|
307
|
-
* @param label - Optional event label.
|
|
308
|
-
* @param value - Optional numeric event value.
|
|
305
|
+
* @param eventName - The GA4 event name.
|
|
306
|
+
* @param params - Optional event parameters.
|
|
309
307
|
* @public
|
|
310
308
|
*/
|
|
311
|
-
export declare function
|
|
309
|
+
export declare function trackGA4Event(extension: Extension, eventName: string, params?: Record<string, unknown>): void;
|
|
312
310
|
|
|
313
311
|
/**
|
|
314
312
|
* Triggers the login process in the host application for the given extension.
|
package/dist/index.d.ts
CHANGED
|
@@ -161,7 +161,7 @@ export declare interface HostConfig {
|
|
|
161
161
|
getCookieConsent: SharedResources['getCookieConsent'];
|
|
162
162
|
updateCookieConsent: SharedResources['updateCookieConsent'];
|
|
163
163
|
resetCookieConsent: SharedResources['resetCookieConsent'];
|
|
164
|
-
|
|
164
|
+
trackGA4Event: SharedResources['trackGA4Event'];
|
|
165
165
|
}
|
|
166
166
|
|
|
167
167
|
/**
|
|
@@ -180,7 +180,7 @@ export declare interface HostConfig {
|
|
|
180
180
|
* - getCookieConsent: Function to retrieve the current cookie consent state
|
|
181
181
|
* - updateCookieConsent: Function to dispatch consent actions and initialize analytics on acceptance
|
|
182
182
|
* - resetCookieConsent: Function to reset consent state and stop analytics events
|
|
183
|
-
* -
|
|
183
|
+
* - trackGA4Event: Function to track a GA4 event
|
|
184
184
|
* @throws Will throw an error if any required configuration is missing
|
|
185
185
|
* @returns Object with method to access shared resources
|
|
186
186
|
* @public
|
|
@@ -272,7 +272,7 @@ export declare interface SharedResources {
|
|
|
272
272
|
getCookieConsent: () => CookieConsent;
|
|
273
273
|
updateCookieConsent: (status: CookieConsentStatus) => void;
|
|
274
274
|
resetCookieConsent: () => void;
|
|
275
|
-
|
|
275
|
+
trackGA4Event: (eventName: string, params?: Record<string, unknown>) => void;
|
|
276
276
|
}
|
|
277
277
|
|
|
278
278
|
export { StoreEnhancer }
|
|
@@ -299,16 +299,14 @@ export declare function toast(extension: Extension, message: string, type: Toast
|
|
|
299
299
|
export declare type ToastType = 'success' | 'error' | 'info' | 'warn';
|
|
300
300
|
|
|
301
301
|
/**
|
|
302
|
-
* Tracks
|
|
302
|
+
* Tracks a GA4 event for the given extension.
|
|
303
303
|
* Silently no-ops if analytics has not been initialized (consent not given).
|
|
304
304
|
* @param extension - The extension object.
|
|
305
|
-
* @param
|
|
306
|
-
* @param
|
|
307
|
-
* @param label - Optional event label.
|
|
308
|
-
* @param value - Optional numeric event value.
|
|
305
|
+
* @param eventName - The GA4 event name.
|
|
306
|
+
* @param params - Optional event parameters.
|
|
309
307
|
* @public
|
|
310
308
|
*/
|
|
311
|
-
export declare function
|
|
309
|
+
export declare function trackGA4Event(extension: Extension, eventName: string, params?: Record<string, unknown>): void;
|
|
312
310
|
|
|
313
311
|
/**
|
|
314
312
|
* Triggers the login process in the host application for the given extension.
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACb,KAAK,EACL,aAAa,EACb,aAAa,EACd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAIlD;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,mBAAmB,CAAC;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AAE9D;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,CAAC,MAAM,EAAE,cAAc,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,aAAa,CAAC;IACvF,UAAU,EAAE,aAAa,CACvB;QACE,KAAK,EAAE;YACL,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC;KACH,EACD,aAAa,EACb,KAAK,CACH;QACE,aAAa,CAAC;YACZ,QAAQ,EAAE,aAAa,CACrB;gBACE,KAAK,EAAE;oBACL,KAAK,EAAE,MAAM,CAAC;oBACd,MAAM,EAAE,MAAM,CAAC;iBAChB,CAAC;aACH,EACD,SAAS,EACT,aAAa,CACd,CAAC;SACH,CAAC;QACF,aAAa;KACd,CACF,CACF,CAAC;IACF,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QACxC,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;QACjE,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;KACjD,CAAC;IACF,cAAc,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC;IACrD,mBAAmB,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC;IAC9D,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;IAClD,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,sBAAsB,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjG,YAAY,EAAE,CAAC,MAAM,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC;IACvD,KAAK,EAAE,KAAK,CAAC;IACb,WAAW,EAAE,OAAO,CAAC;IACrB,gBAAgB,EAAE,MAAM,aAAa,CAAC;IACtC,mBAAmB,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAC3D,kBAAkB,EAAE,MAAM,IAAI,CAAC;IAC/B,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACb,KAAK,EACL,aAAa,EACb,aAAa,EACd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAIlD;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,mBAAmB,CAAC;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AAE9D;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,CAAC,MAAM,EAAE,cAAc,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,aAAa,CAAC;IACvF,UAAU,EAAE,aAAa,CACvB;QACE,KAAK,EAAE;YACL,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC;KACH,EACD,aAAa,EACb,KAAK,CACH;QACE,aAAa,CAAC;YACZ,QAAQ,EAAE,aAAa,CACrB;gBACE,KAAK,EAAE;oBACL,KAAK,EAAE,MAAM,CAAC;oBACd,MAAM,EAAE,MAAM,CAAC;iBAChB,CAAC;aACH,EACD,SAAS,EACT,aAAa,CACd,CAAC;SACH,CAAC;QACF,aAAa;KACd,CACF,CACF,CAAC;IACF,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QACxC,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;QACjE,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;KACjD,CAAC;IACF,cAAc,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC;IACrD,mBAAmB,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC;IAC9D,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;IAClD,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,sBAAsB,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjG,YAAY,EAAE,CAAC,MAAM,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC;IACvD,KAAK,EAAE,KAAK,CAAC;IACb,WAAW,EAAE,OAAO,CAAC;IACrB,gBAAgB,EAAE,MAAM,aAAa,CAAC;IACtC,mBAAmB,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAC3D,kBAAkB,EAAE,MAAM,IAAI,CAAC;IAC/B,aAAa,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;CAC9E;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IACtC,UAAU,EAAE,eAAe,CAAC,YAAY,CAAC,CAAC;IAC1C,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IACtC,cAAc,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAClD,mBAAmB,EAAE,eAAe,CAAC,qBAAqB,CAAC,CAAC;IAC5D,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;IAChC,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IACpC,sBAAsB,EAAE,eAAe,CAAC,wBAAwB,CAAC,CAAC;IAClE,YAAY,EAAE,eAAe,CAAC,cAAc,CAAC,CAAC;IAC9C,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;IAChC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gBAAgB,EAAE,eAAe,CAAC,kBAAkB,CAAC,CAAC;IACtD,mBAAmB,EAAE,eAAe,CAAC,qBAAqB,CAAC,CAAC;IAC5D,kBAAkB,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC;IAC1D,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,kBAAkB,IAAI,eAAe,CAAC;CACvC;AAED;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,uBAAuB,EAAE,eAAe,CAAC;KAC1C;CACF;AAyBD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAkB1D;AA+BD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,CAKpE;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,GAAE,cAAmB,GAAG,aAAa,CAI5F;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,eAAe,CAAC,YAAY,CAAC,CAGjF;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,eAAe,CAAC,UAAU,CAAC,CAG7E;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,GAAG,OAAO,CAIrF;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAI9F;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAGrF;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,KAAK,CAGpD;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,CAIlF;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAIlD;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,SAAS,EACpB,WAAW,EAAE,MAAM,EAAE,GACpB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAIzB;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAIvF;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,aAAa,CAIpE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,GAAG,IAAI,CAI3F;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAI7D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACnC,IAAI,CAIN;AAMD,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC1F,YAAY,EACV,aAAa,EACb,aAAa,EACb,aAAa,EACb,KAAK,EACL,aAAa,EACd,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -22,7 +22,7 @@ const ERROR_MAPS = {
|
|
|
22
22
|
getCookieConsent: 'Get Cookie Consent',
|
|
23
23
|
updateCookieConsent: 'Update Cookie Consent',
|
|
24
24
|
resetCookieConsent: 'Reset Cookie Consent',
|
|
25
|
-
|
|
25
|
+
trackGA4Event: 'Track GA4 Event'
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* Initialize the communication package in the host application
|
|
@@ -40,7 +40,7 @@ const ERROR_MAPS = {
|
|
|
40
40
|
* - getCookieConsent: Function to retrieve the current cookie consent state
|
|
41
41
|
* - updateCookieConsent: Function to dispatch consent actions and initialize analytics on acceptance
|
|
42
42
|
* - resetCookieConsent: Function to reset consent state and stop analytics events
|
|
43
|
-
* -
|
|
43
|
+
* - trackGA4Event: Function to track a GA4 event
|
|
44
44
|
* @throws Will throw an error if any required configuration is missing
|
|
45
45
|
* @returns Object with method to access shared resources
|
|
46
46
|
* @public
|
|
@@ -259,18 +259,16 @@ export function resetCookieConsent(extension) {
|
|
|
259
259
|
resetCookieConsentResource();
|
|
260
260
|
}
|
|
261
261
|
/**
|
|
262
|
-
* Tracks
|
|
262
|
+
* Tracks a GA4 event for the given extension.
|
|
263
263
|
* Silently no-ops if analytics has not been initialized (consent not given).
|
|
264
264
|
* @param extension - The extension object.
|
|
265
|
-
* @param
|
|
266
|
-
* @param
|
|
267
|
-
* @param label - Optional event label.
|
|
268
|
-
* @param value - Optional numeric event value.
|
|
265
|
+
* @param eventName - The GA4 event name.
|
|
266
|
+
* @param params - Optional event parameters.
|
|
269
267
|
* @public
|
|
270
268
|
*/
|
|
271
|
-
export function
|
|
269
|
+
export function trackGA4Event(extension, eventName, params = {}) {
|
|
272
270
|
validateExtension(extension);
|
|
273
|
-
const
|
|
274
|
-
|
|
271
|
+
const trackGA4EventResource = getResource('trackGA4Event');
|
|
272
|
+
trackGA4EventResource(eventName, params);
|
|
275
273
|
}
|
|
276
274
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;EAKE;AA6LF,2CAA2C;AAE3C,IAAI,WAAW,GAA6B;IAC1C,WAAW,EAAE,KAAK;CACnB,CAAC;AAEF,MAAM,UAAU,GAA0D;IACxE,QAAQ,EAAE,mBAAmB;IAC7B,UAAU,EAAE,aAAa;IACzB,QAAQ,EAAE,WAAW;IACrB,cAAc,EAAE,iBAAiB;IACjC,mBAAmB,EAAE,sBAAsB;IAC3C,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,UAAU;IACnB,sBAAsB,EAAE,0BAA0B;IAClD,YAAY,EAAE,eAAe;IAC7B,gBAAgB,EAAE,oBAAoB;IACtC,mBAAmB,EAAE,uBAAuB;IAC5C,kBAAkB,EAAE,sBAAsB;IAC1C,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;EAKE;AA6LF,2CAA2C;AAE3C,IAAI,WAAW,GAA6B;IAC1C,WAAW,EAAE,KAAK;CACnB,CAAC;AAEF,MAAM,UAAU,GAA0D;IACxE,QAAQ,EAAE,mBAAmB;IAC7B,UAAU,EAAE,aAAa;IACzB,QAAQ,EAAE,WAAW;IACrB,cAAc,EAAE,iBAAiB;IACjC,mBAAmB,EAAE,sBAAsB;IAC3C,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,UAAU;IACnB,sBAAsB,EAAE,0BAA0B;IAClD,YAAY,EAAE,eAAe;IAC7B,gBAAgB,EAAE,oBAAoB;IACtC,mBAAmB,EAAE,uBAAuB;IAC5C,kBAAkB,EAAE,sBAAsB;IAC1C,aAAa,EAAE,iBAAiB;CACjC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,cAAc,CAAC,MAAkB;IAC9C,MAAM,CAAC,IAAI,CAAC,UAAU,CAAoC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAC1E,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACpD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,WAAW,GAAG;QACZ,GAAG,WAAW;QACd,GAAG,MAAM;QACT,WAAW,EAAE,IAAI;KAClB,CAAC;IAEF,MAAM,CAAC,uBAAuB,GAAG,WAA8B,CAAC;IAEhE,OAAO;QACL,kBAAkB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,CAAoB;KAClE,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAkC,QAAW;IAC/D,IAAI,CAAC,MAAM,CAAC,uBAAuB,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CACb,uBAAuB,QAAQ,6DAA6D,CAC7F,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;AAClD,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,SAAoB;IAC7C,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,IAAY;IACvD,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AAC1B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,SAAoB,EAAE,SAAyB,EAAE;IAC3E,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,MAAM,QAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;IACzC,OAAO,QAAQ,CAAC,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;AACjF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,SAAoB;IAChD,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,OAAO,WAAW,CAAC,YAAY,CAAC,CAAC;AACnC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,SAAoB;IAC9C,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,SAAoB,EAAE,MAAuB;IAC1E,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,MAAM,sBAAsB,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAC7D,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,SAAoB,EAAE,MAA2B;IACnF,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,MAAM,2BAA2B,GAAG,WAAW,CAAC,qBAAqB,CAAC,CAAC;IACvE,OAAO,2BAA2B,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,SAAoB,EAAE,WAAmB;IAC3E,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,OAAO,GAAG,SAAS,CAAC,MAAM,IAAI,SAAS,CAAC,IAAI,IAAI,WAAW,EAAE,CAAC;AAChE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,SAAoB;IAC3C,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK,CAAC,SAAoB,EAAE,OAAe,EAAE,IAAe;IAC1E,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,MAAM,aAAa,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAC3C,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,SAAoB;IAC1C,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,MAAM,eAAe,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;IAC/C,OAAO,eAAe,EAAE,CAAC;AAC3B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CACpC,SAAoB,EACpB,WAAqB;IAErB,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,MAAM,8BAA8B,GAAG,WAAW,CAAC,wBAAwB,CAAC,CAAC;IAC7E,OAAO,8BAA8B,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,SAAoB,EAAE,MAA2B;IAC5E,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,MAAM,oBAAoB,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;IACzD,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAC;AACtC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAAoB;IACnD,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,MAAM,wBAAwB,GAAG,WAAW,CAAC,kBAAkB,CAAC,CAAC;IACjE,OAAO,wBAAwB,EAAE,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,SAAoB,EAAE,MAA2B;IACnF,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,MAAM,2BAA2B,GAAG,WAAW,CAAC,qBAAqB,CAAC,CAAC;IACvE,2BAA2B,CAAC,MAAM,CAAC,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,SAAoB;IACrD,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,MAAM,0BAA0B,GAAG,WAAW,CAAC,oBAAoB,CAAC,CAAC;IACrE,0BAA0B,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAC3B,SAAoB,EACpB,SAAiB,EACjB,SAAkC,EAAE;IAEpC,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC7B,MAAM,qBAAqB,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAC3D,qBAAqB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AAC3C,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cloudscaile-eng/web-ext-utils",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.4",
|
|
4
4
|
"description": "Utilities for sharing host resources with micro-frontends in web applications",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "CloudScaile Engineering",
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"LICENSE"
|
|
21
21
|
],
|
|
22
22
|
"scripts": {
|
|
23
|
-
"build": "rimraf dist && tsc && api-extractor run --local || true",
|
|
23
|
+
"build": "rimraf dist && tsc && node scripts/fix-rtk-types.cjs && api-extractor run --local || true",
|
|
24
24
|
"prepublishOnly": "npm run build",
|
|
25
25
|
"build:lint": "npm run format-check && npm run lint && npm run typecheck",
|
|
26
26
|
"typecheck": "tsc --noEmit",
|
|
@@ -28,8 +28,7 @@
|
|
|
28
28
|
"lint-fix": "eslint src --fix",
|
|
29
29
|
"format": "prettier --write .",
|
|
30
30
|
"format-check": "prettier --check .",
|
|
31
|
-
"prepare": "husky"
|
|
32
|
-
"postinstall": "node scripts/fix-rtk-types.cjs"
|
|
31
|
+
"prepare": "husky"
|
|
33
32
|
},
|
|
34
33
|
"keywords": [
|
|
35
34
|
"cloudscaile",
|