@piwikpro/react-piwik-pro
Advanced tools
@piwikpro/react-piwik-pro - npm Package Compare versions
Comparing version 2.0.1 to 2.1.0
| { | ||
| "name": "@piwikpro/react-piwik-pro", | ||
| "version": "2.0.1", | ||
| "version": "2.1.0", | ||
| "description": "Piwik PRO tracking library for ReactJS", | ||
@@ -17,3 +17,3 @@ "author": "Piwik Pro Integration Team <integrations@piwik.pro>", | ||
| "build": "microbundle-crl --no-compress --format modern,cjs", | ||
| "build:docs": "typedoc && concat-md docs_raw > README.md && node scripts/postProcessDocs.js", | ||
| "build:docs": "typedoc && concat-md --decrease-title-levels --start-title-level-at=2 docs_raw > README.md && node scripts/postProcessDocs.js", | ||
| "start": "microbundle-crl watch --no-compress --format modern,cjs", | ||
@@ -65,4 +65,4 @@ "prepare": "run-s build", | ||
| "dependencies": { | ||
| "@piwikpro/tracking-base-library": "^1.1.2" | ||
| "@piwikpro/tracking-base-library": "^1.2.0" | ||
| } | ||
| } |
506
README.md
@@ -9,5 +9,5 @@ | ||
| ## Installation | ||
| ### Installation | ||
| ### NPM | ||
| #### NPM | ||
@@ -20,3 +20,3 @@ To use this package in your project, run the following command. | ||
| ### Basic setup | ||
| #### Basic setup | ||
@@ -35,3 +35,3 @@ In your React Project, include the default `PiwikPro` in the highest level application module. ie `index`. To set up the Piwik PRO Tag Manager container in the app, the easiest way is to call the `PiwikPro.initialize()` method. `PiwikPro.initialize()` must be initialized using this function before any of the other tracking functions will record any data. | ||
| ### Setup with nonce | ||
| #### Setup with nonce | ||
@@ -50,5 +50,5 @@ The nonce attribute is useful to allow-list specific elements, such as a particular inline script or style elements. It can help you to avoid using the CSP unsafe-inline directive, which would allow-list all inline scripts or styles. | ||
| ## Piwik PRO Services | ||
| ### Piwik PRO Services | ||
| ### Send Custom Events | ||
| #### Send Custom Events | ||
@@ -78,3 +78,3 @@ ```ts | ||
| ### Send page views and virtual page views | ||
| #### Send page views and virtual page views | ||
@@ -95,3 +95,3 @@ ```ts | ||
| ### Send an event with Data Layer | ||
| #### Send an event with Data Layer | ||
@@ -117,5 +117,5 @@ ```ts | ||
| ## Table of contents | ||
| ### Table of contents | ||
| ### Namespaces | ||
| #### Namespaces | ||
@@ -128,2 +128,3 @@ - [ContentTracking](#modulescontenttrackingmd) | ||
| - [DownloadAndOutlink](#modulesdownloadandoutlinkmd) | ||
| - [ErrorTracking](#moduleserrortrackingmd) | ||
| - [GoalConversions](#modulesgoalconversionsmd) | ||
@@ -135,5 +136,6 @@ - [PageViews](#modulespageviewsmd) | ||
| ### Type Aliases | ||
| #### Type Aliases | ||
| - [Dimensions](#dimensions) | ||
| - [InitOptions](#initoptions) | ||
| - [PaymentInformation](#paymentinformation) | ||
@@ -143,9 +145,9 @@ - [Product](#product) | ||
| ### Variables | ||
| #### Variables | ||
| - [default](#default) | ||
| ## Type Aliases | ||
| ### Type Aliases | ||
| ### Dimensions | ||
| #### Dimensions | ||
@@ -156,7 +158,20 @@ Ƭ **Dimensions**: `Record`\<\`dimension$\{number}\`, `string`\> | ||
| ### PaymentInformation | ||
| #### InitOptions | ||
| Ƭ **InitOptions**: `Object` | ||
| ##### Type declaration | ||
| | Name | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | `dataLayerName?` | `string` | Defaults to 'dataLayer' | | ||
| | `nonce?` | `string` | - | | ||
| ___ | ||
| #### PaymentInformation | ||
| Ƭ **PaymentInformation**: `Object` | ||
| #### Type declaration | ||
| ##### Type declaration | ||
@@ -174,7 +189,7 @@ | Name | Type | | ||
| ### Product | ||
| #### Product | ||
| Ƭ **Product**: `Object` | ||
| #### Type declaration | ||
| ##### Type declaration | ||
@@ -194,13 +209,13 @@ | Name | Type | | ||
| ### VisitorInfo | ||
| #### VisitorInfo | ||
| Ƭ **VisitorInfo**: [isNew: "0" \| "1", visitorId: string, firstVisitTS: number, previousVisitCount: string \| number, currentVisitTS: number, lastVisitTS: number \| "", lastEcommerceOrderTS: number \| ""] | ||
| ## Variables | ||
| ### Variables | ||
| ### default | ||
| #### default | ||
| • `Const` **default**: `Object` | ||
| #### Type declaration | ||
| ##### Type declaration | ||
@@ -216,5 +231,5 @@ | Name | Type | | ||
| # ContentTracking | ||
| ## ContentTracking | ||
| ## Table of contents | ||
| ### Table of contents | ||
@@ -230,5 +245,4 @@ | ||
| ## Functions | ||
| ### logAllContentBlocksOnPage | ||
| #### logAllContentBlocksOnPage | ||
@@ -239,3 +253,3 @@ ▸ **logAllContentBlocksOnPage**(): `void` | ||
| #### Returns | ||
| ##### Returns | ||
@@ -246,3 +260,3 @@ `void` | ||
| ### trackAllContentImpressions | ||
| #### trackAllContentImpressions | ||
@@ -255,3 +269,3 @@ ▸ **trackAllContentImpressions**(): `void` | ||
| #### Returns | ||
| ##### Returns | ||
@@ -262,7 +276,7 @@ `void` | ||
| ### trackContentImpression | ||
| #### trackContentImpression | ||
| ▸ **trackContentImpression**(`contentName`, `contentPiece`, `contentTarget`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -275,3 +289,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -282,7 +296,7 @@ `void` | ||
| ### trackContentImpressionsWithinNode | ||
| #### trackContentImpressionsWithinNode | ||
| ▸ **trackContentImpressionsWithinNode**(`domNode`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -293,3 +307,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -300,3 +314,3 @@ `void` | ||
| ### trackContentInteraction | ||
| #### trackContentInteraction | ||
@@ -307,3 +321,3 @@ ▸ **trackContentInteraction**(`contentInteraction`, `contentName`, `contentPiece`, `contentTarget`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -317,3 +331,3 @@ | Name | Type | Description | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -324,3 +338,3 @@ `void` | ||
| ### trackContentInteractionNode | ||
| #### trackContentInteractionNode | ||
@@ -331,3 +345,3 @@ ▸ **trackContentInteractionNode**(`domNode`, `contentInteraction?`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -339,3 +353,3 @@ | Name | Type | Description | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -346,3 +360,3 @@ `void` | ||
| ### trackVisibleContentImpressions | ||
| #### trackVisibleContentImpressions | ||
@@ -353,3 +367,3 @@ ▸ **trackVisibleContentImpressions**(`checkOnScroll?`, `watchInterval?`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -361,3 +375,3 @@ | Name | Type | Description | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -370,5 +384,5 @@ `void` | ||
| # CookieManagement | ||
| ## CookieManagement | ||
| ## Table of contents | ||
| ### Table of contents | ||
@@ -393,5 +407,4 @@ | ||
| ## Functions | ||
| ### deleteCookies | ||
| #### deleteCookies | ||
@@ -402,3 +415,3 @@ ▸ **deleteCookies**(): `void` | ||
| #### Returns | ||
| ##### Returns | ||
@@ -409,3 +422,3 @@ `void` | ||
| ### disableCookies | ||
| #### disableCookies | ||
@@ -416,3 +429,3 @@ ▸ **disableCookies**(): `void` | ||
| #### Returns | ||
| ##### Returns | ||
@@ -423,3 +436,3 @@ `void` | ||
| ### enableCookies | ||
| #### enableCookies | ||
@@ -430,3 +443,3 @@ ▸ **enableCookies**(): `void` | ||
| #### Returns | ||
| ##### Returns | ||
@@ -437,3 +450,3 @@ `void` | ||
| ### getConfigVisitorCookieTimeout | ||
| #### getConfigVisitorCookieTimeout | ||
@@ -444,3 +457,3 @@ ▸ **getConfigVisitorCookieTimeout**(): `Promise`\<`number`\> | ||
| #### Returns | ||
| ##### Returns | ||
@@ -451,3 +464,3 @@ `Promise`\<`number`\> | ||
| ### getCookieDomain | ||
| #### getCookieDomain | ||
@@ -458,3 +471,3 @@ ▸ **getCookieDomain**(): `Promise`\<`string`\> | ||
| #### Returns | ||
| ##### Returns | ||
@@ -465,3 +478,3 @@ `Promise`\<`string`\> | ||
| ### getCookiePath | ||
| #### getCookiePath | ||
@@ -472,3 +485,3 @@ ▸ **getCookiePath**(): `Promise`\<`string`\> | ||
| #### Returns | ||
| ##### Returns | ||
@@ -479,3 +492,3 @@ `Promise`\<`string`\> | ||
| ### getSessionCookieTimeout | ||
| #### getSessionCookieTimeout | ||
@@ -486,3 +499,3 @@ ▸ **getSessionCookieTimeout**(): `Promise`\<`number`\> | ||
| #### Returns | ||
| ##### Returns | ||
@@ -493,3 +506,3 @@ `Promise`\<`number`\> | ||
| ### hasCookies | ||
| #### hasCookies | ||
@@ -500,3 +513,3 @@ ▸ **hasCookies**(): `Promise`\<`boolean`\> | ||
| #### Returns | ||
| ##### Returns | ||
@@ -507,3 +520,3 @@ `Promise`\<`boolean`\> | ||
| ### setCookieDomain | ||
| #### setCookieDomain | ||
@@ -514,3 +527,3 @@ ▸ **setCookieDomain**(`domain`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -521,3 +534,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -528,3 +541,3 @@ `void` | ||
| ### setCookieNamePrefix | ||
| #### setCookieNamePrefix | ||
@@ -535,3 +548,3 @@ ▸ **setCookieNamePrefix**(`prefix`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -542,3 +555,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -549,3 +562,3 @@ `void` | ||
| ### setCookiePath | ||
| #### setCookiePath | ||
@@ -556,3 +569,3 @@ ▸ **setCookiePath**(`path`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -563,3 +576,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -570,3 +583,3 @@ `void` | ||
| ### setReferralCookieTimeout | ||
| #### setReferralCookieTimeout | ||
@@ -577,3 +590,3 @@ ▸ **setReferralCookieTimeout**(`seconds`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -584,3 +597,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -591,3 +604,3 @@ `void` | ||
| ### setSecureCookie | ||
| #### setSecureCookie | ||
@@ -598,3 +611,3 @@ ▸ **setSecureCookie**(`secure`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -605,3 +618,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -612,3 +625,3 @@ `void` | ||
| ### setSessionCookieTimeout | ||
| #### setSessionCookieTimeout | ||
@@ -619,3 +632,3 @@ ▸ **setSessionCookieTimeout**(`seconds`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -626,3 +639,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -633,3 +646,3 @@ `void` | ||
| ### setVisitorCookieTimeout | ||
| #### setVisitorCookieTimeout | ||
@@ -640,3 +653,3 @@ ▸ **setVisitorCookieTimeout**(`seconds`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -647,3 +660,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -654,3 +667,3 @@ `void` | ||
| ### setVisitorIdCookie | ||
| #### setVisitorIdCookie | ||
@@ -661,3 +674,3 @@ ▸ **setVisitorIdCookie**(): `void` | ||
| #### Returns | ||
| ##### Returns | ||
@@ -670,5 +683,5 @@ `void` | ||
| # CustomDimensions | ||
| ## CustomDimensions | ||
| ## Table of contents | ||
| ### Table of contents | ||
@@ -680,5 +693,4 @@ | ||
| ## Functions | ||
| ### deleteCustomDimension | ||
| #### deleteCustomDimension | ||
@@ -689,9 +701,9 @@ ▸ **deleteCustomDimension**(`customDimensionId`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
| | Name | Type | | ||
| | :------ | :------ | | ||
| | `customDimensionId` | `string` | | ||
| | `customDimensionId` | `string` \| `number` | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -702,3 +714,3 @@ `void` | ||
| ### getCustomDimensionValue | ||
| #### getCustomDimensionValue | ||
@@ -709,3 +721,3 @@ ▸ **getCustomDimensionValue**(`customDimensionId`): `Promise`\<`string` \| `undefined`\> | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -716,3 +728,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -723,3 +735,3 @@ `Promise`\<`string` \| `undefined`\> | ||
| ### setCustomDimensionValue | ||
| #### setCustomDimensionValue | ||
@@ -730,3 +742,3 @@ ▸ **setCustomDimensionValue**(`customDimensionId`, `customDimensionValue`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -738,3 +750,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -747,5 +759,5 @@ `void` | ||
| # CustomEvent | ||
| ## CustomEvent | ||
| ## Table of contents | ||
| ### Table of contents | ||
@@ -755,5 +767,4 @@ | ||
| ## Functions | ||
| ### trackEvent | ||
| #### trackEvent | ||
@@ -764,3 +775,3 @@ ▸ **trackEvent**(`category`, `action`, `name?`, `value?`, `dimensions?`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -775,3 +786,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -784,13 +795,23 @@ `void` | ||
| # DataLayer | ||
| ## DataLayer | ||
| ## Table of contents | ||
| ### Table of contents | ||
| #### Type Aliases | ||
| - [DataLayerEntry](#datalayerentry) | ||
| - [push](#push) | ||
| - [setDataLayerName](#setdatalayername) | ||
| ## Functions | ||
| ### Type Aliases | ||
| ### push | ||
| #### DataLayerEntry | ||
| Ƭ **DataLayerEntry**: `Record`\<`string`, `AnyData`\> | ||
| #### push | ||
| ▸ **push**(`data`): `number` | ||
@@ -800,19 +821,35 @@ | ||
| #### Parameters | ||
| ##### Parameters | ||
| | Name | Type | | ||
| | :------ | :------ | | ||
| | `data` | `any` | | ||
| | `data` | [`DataLayerEntry`](#datalayerentry) | | ||
| #### Returns | ||
| ##### Returns | ||
| `number` | ||
| ___ | ||
| #### setDataLayerName | ||
| ▸ **setDataLayerName**(`name`): `void` | ||
| ##### Parameters | ||
| | Name | Type | | ||
| | :------ | :------ | | ||
| | `name` | `string` | | ||
| ##### Returns | ||
| `void` | ||
| <a name="modulesdownloadandoutlinkmd"></a> | ||
| # DownloadAndOutlink | ||
| ## DownloadAndOutlink | ||
| ## Table of contents | ||
| ### Table of contents | ||
@@ -831,5 +868,4 @@ | ||
| ## Functions | ||
| ### addDownloadExtensions | ||
| #### addDownloadExtensions | ||
@@ -840,3 +876,3 @@ ▸ **addDownloadExtensions**(`extensions`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -847,3 +883,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -854,3 +890,3 @@ `void` | ||
| ### enableLinkTracking | ||
| #### enableLinkTracking | ||
@@ -864,3 +900,3 @@ ▸ **enableLinkTracking**(`trackAlsoMiddleAndRightClicks?`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -871,3 +907,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -878,3 +914,3 @@ `void` | ||
| ### getLinkTrackingTimer | ||
| #### getLinkTrackingTimer | ||
@@ -885,3 +921,3 @@ ▸ **getLinkTrackingTimer**(): `Promise`\<`number`\> | ||
| #### Returns | ||
| ##### Returns | ||
@@ -892,3 +928,3 @@ `Promise`\<`number`\> | ||
| ### removeDownloadExtensions | ||
| #### removeDownloadExtensions | ||
@@ -899,3 +935,3 @@ ▸ **removeDownloadExtensions**(`extensions`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -906,3 +942,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -913,3 +949,3 @@ `void` | ||
| ### setDownloadClasses | ||
| #### setDownloadClasses | ||
@@ -920,3 +956,3 @@ ▸ **setDownloadClasses**(`classes`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -927,3 +963,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -934,3 +970,3 @@ `void` | ||
| ### setDownloadExtensions | ||
| #### setDownloadExtensions | ||
@@ -941,3 +977,3 @@ ▸ **setDownloadExtensions**(`extensions`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -948,3 +984,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -955,3 +991,3 @@ `void` | ||
| ### setIgnoreClasses | ||
| #### setIgnoreClasses | ||
@@ -962,3 +998,3 @@ ▸ **setIgnoreClasses**(`classes`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -969,3 +1005,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -976,3 +1012,3 @@ `void` | ||
| ### setLinkClasses | ||
| #### setLinkClasses | ||
@@ -983,3 +1019,3 @@ ▸ **setLinkClasses**(`classes`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -990,3 +1026,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -997,3 +1033,3 @@ `void` | ||
| ### setLinkTrackingTimer | ||
| #### setLinkTrackingTimer | ||
@@ -1008,3 +1044,3 @@ ▸ **setLinkTrackingTimer**(`time`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1015,3 +1051,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1022,3 +1058,3 @@ `void` | ||
| ### trackLink | ||
| #### trackLink | ||
@@ -1029,3 +1065,3 @@ ▸ **trackLink**(`url`, `linkType`, `dimensions?`, `callback?`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1039,3 +1075,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1045,8 +1081,57 @@ `void` | ||
| <a name="moduleserrortrackingmd"></a> | ||
| ## ErrorTracking | ||
| ### Table of contents | ||
| - [enableJSErrorTracking](#enablejserrortracking) | ||
| - [trackError](#trackerror) | ||
| #### enableJSErrorTracking | ||
| ▸ **enableJSErrorTracking**(`unique?`): `void` | ||
| Enables tracking of unhandled JavaScript errors. | ||
| ##### Parameters | ||
| | Name | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | `unique?` | `boolean` | track only unique errors | | ||
| ##### Returns | ||
| `void` | ||
| ___ | ||
| #### trackError | ||
| ▸ **trackError**(`error`): `void` | ||
| Attempts to send error tracking request using same format as native errors caught by enableJSErrorTracking(). | ||
| Such error request will still follow rules set for tracker, so it will be sent only when JS error tracking is enabled | ||
| ([enableJSErrorTracking](#enablejserrortracking) function was called before this attempt). It will also respect rules for tracking only unique errors. | ||
| ##### Parameters | ||
| | Name | Type | | ||
| | :------ | :------ | | ||
| | `error` | `Error` | | ||
| ##### Returns | ||
| `void` | ||
| <a name="modulesgoalconversionsmd"></a> | ||
| # GoalConversions | ||
| ## GoalConversions | ||
| ## Table of contents | ||
| ### Table of contents | ||
@@ -1056,5 +1141,4 @@ | ||
| ## Functions | ||
| ### trackGoal | ||
| #### trackGoal | ||
@@ -1065,3 +1149,3 @@ ▸ **trackGoal**(`goalId`, `conversionValue`, `dimensions?`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1074,3 +1158,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1083,5 +1167,5 @@ `void` | ||
| # PageViews | ||
| ## PageViews | ||
| ## Table of contents | ||
| ### Table of contents | ||
@@ -1091,5 +1175,4 @@ | ||
| ## Functions | ||
| ### trackPageView | ||
| #### trackPageView | ||
@@ -1100,3 +1183,3 @@ ▸ **trackPageView**(`customPageTitle?`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1107,3 +1190,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1116,5 +1199,5 @@ `void` | ||
| # SiteSearch | ||
| ## SiteSearch | ||
| ## Table of contents | ||
| ### Table of contents | ||
@@ -1124,5 +1207,4 @@ | ||
| ## Functions | ||
| ### trackSiteSearch | ||
| #### trackSiteSearch | ||
@@ -1133,3 +1215,3 @@ ▸ **trackSiteSearch**(`keyword`, `category?`, `searchCount?`, `dimensions?`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1143,3 +1225,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1152,5 +1234,5 @@ `void` | ||
| # UserManagement | ||
| ## UserManagement | ||
| ## Table of contents | ||
| ### Table of contents | ||
@@ -1164,5 +1246,4 @@ | ||
| ## Functions | ||
| ### getUserId | ||
| #### getUserId | ||
@@ -1173,3 +1254,3 @@ ▸ **getUserId**(): `Promise`\<`string`\> | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1180,3 +1261,3 @@ `Promise`\<`string`\> | ||
| ### getVisitorId | ||
| #### getVisitorId | ||
@@ -1187,3 +1268,3 @@ ▸ **getVisitorId**(): `Promise`\<`string`\> | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1194,3 +1275,3 @@ `Promise`\<`string`\> | ||
| ### getVisitorInfo | ||
| #### getVisitorInfo | ||
@@ -1201,3 +1282,3 @@ ▸ **getVisitorInfo**(): `Promise`\<[`VisitorInfo`](#visitorinfo)\> | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1208,3 +1289,3 @@ `Promise`\<[`VisitorInfo`](#visitorinfo)\> | ||
| ### resetUserId | ||
| #### resetUserId | ||
@@ -1215,3 +1296,3 @@ ▸ **resetUserId**(): `void` | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1222,3 +1303,3 @@ `void` | ||
| ### setUserId | ||
| #### setUserId | ||
@@ -1231,3 +1312,3 @@ ▸ **setUserId**(`userId`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1238,3 +1319,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1247,5 +1328,5 @@ `void` | ||
| # eCommerce | ||
| ## eCommerce | ||
| ## Table of contents | ||
| ### Table of contents | ||
@@ -1266,9 +1347,8 @@ | ||
| ## Functions | ||
| ### addEcommerceItem | ||
| #### addEcommerceItem | ||
| ▸ **addEcommerceItem**(`productSKU`, `productName`, `productCategory`, `productPrice`, `productQuantity`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1283,3 +1363,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1294,7 +1374,7 @@ `void` | ||
| ### clearEcommerceCart | ||
| #### clearEcommerceCart | ||
| ▸ **clearEcommerceCart**(): `void` | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1307,3 +1387,3 @@ `void` | ||
| ### ecommerceAddToCart | ||
| #### ecommerceAddToCart | ||
@@ -1314,3 +1394,3 @@ ▸ **ecommerceAddToCart**(`products`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1321,3 +1401,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1328,3 +1408,3 @@ `void` | ||
| ### ecommerceCartUpdate | ||
| #### ecommerceCartUpdate | ||
@@ -1335,3 +1415,3 @@ ▸ **ecommerceCartUpdate**(`products`, `grandTotal`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1343,3 +1423,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1350,3 +1430,3 @@ `void` | ||
| ### ecommerceOrder | ||
| #### ecommerceOrder | ||
@@ -1357,3 +1437,3 @@ ▸ **ecommerceOrder**(`products`, `paymentInformation`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1365,3 +1445,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1372,3 +1452,3 @@ `void` | ||
| ### ecommerceProductDetailView | ||
| #### ecommerceProductDetailView | ||
@@ -1379,3 +1459,3 @@ ▸ **ecommerceProductDetailView**(`products`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1386,3 +1466,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1393,3 +1473,3 @@ `void` | ||
| ### ecommerceRemoveFromCart | ||
| #### ecommerceRemoveFromCart | ||
@@ -1400,3 +1480,3 @@ ▸ **ecommerceRemoveFromCart**(`products`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1407,3 +1487,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1414,7 +1494,7 @@ `void` | ||
| ### getEcommerceItems | ||
| #### getEcommerceItems | ||
| ▸ **getEcommerceItems**(): `Promise`\<`object`\> | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1427,7 +1507,7 @@ `Promise`\<`object`\> | ||
| ### removeEcommerceItem | ||
| #### removeEcommerceItem | ||
| ▸ **removeEcommerceItem**(`productSKU`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1438,3 +1518,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1449,7 +1529,7 @@ `void` | ||
| ### setEcommerceView | ||
| #### setEcommerceView | ||
| ▸ **setEcommerceView**(`productSKU`, `productName?`, `productCategory?`, `productPrice?`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1463,3 +1543,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1472,7 +1552,7 @@ `void` | ||
| ### trackEcommerceCartUpdate | ||
| #### trackEcommerceCartUpdate | ||
| ▸ **trackEcommerceCartUpdate**(`cartAmount`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1483,3 +1563,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1494,7 +1574,7 @@ `void` | ||
| ### trackEcommerceOrder | ||
| #### trackEcommerceOrder | ||
| ▸ **trackEcommerceOrder**(`orderId`, `orderGrandTotal`, `orderSubTotal?`, `orderTax?`, `orderShipping?`, `orderDiscount?`): `void` | ||
| #### Parameters | ||
| ##### Parameters | ||
@@ -1510,3 +1590,3 @@ | Name | Type | | ||
| #### Returns | ||
| ##### Returns | ||
@@ -1513,0 +1593,0 @@ `void` |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by6.39%
29938
- Number of lines in readme file
- increased by5.92%
1431