Skip to content

Commit

Permalink
Release of 2.0.1 (#43)
Browse files Browse the repository at this point in the history
* release of 2.0.1 - update docs, package.json

* update package-lock
  • Loading branch information
lysy-vlc authored Oct 28, 2024
1 parent cdf3960 commit 1814456
Show file tree
Hide file tree
Showing 5 changed files with 158 additions and 35 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

## 2.0.1
- updates dependencies
- bugfix - prevent sending custom event parameters in wrong order
- include @piwikpro/tracking-base-library in package.json of the build

## 2.0.0

Expand Down
132 changes: 126 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,15 +223,17 @@ export class TestPageComponent implements OnInit {
- [CustomEvent](#namespacescustomeventreadmemd)
- [DataLayer](#namespacesdatalayerreadmemd)
- [DownloadAndOutlink](#namespacesdownloadandoutlinkreadmemd)
- [eCommerce](#namespacesecommercereadmemd)
- [ErrorTracking](#namespaceserrortrackingreadmemd)
- [GoalConversions](#namespacesgoalconversionsreadmemd)
- [PageViews](#namespacespageviewsreadmemd)
- [SiteSearch](#namespacessitesearchreadmemd)
- [UserManagement](#namespacesusermanagementreadmemd)
- [eCommerce](#namespacesecommercereadmemd)

### Type Aliases

- [Dimensions](#type-aliasesdimensionsmd)
- [InitOptions](#type-aliasesinitoptionsmd)
- [PaymentInformation](#type-aliasespaymentinformationmd)
- [Product](#type-aliasesproductmd)
- [VisitorInfo](#type-aliasesvisitorinfomd)
Expand Down Expand Up @@ -886,8 +888,13 @@ Tracks a custom event, e.g. when a visitor interacts with the page
## DataLayer


#### Type Aliases

- [DataLayerEntry](#namespacesdatalayertype-aliasesdatalayerentrymd)


- [push](#namespacesdatalayerfunctionspushmd)
- [setDataLayerName](#namespacesdatalayerfunctionssetdatalayernamemd)


<a name="namespacesdatalayerfunctionspushmd"></a>
Expand All @@ -904,13 +911,43 @@ Adds entry to a data layer

### Parameters

**data**: `any`
**data**: [`DataLayerEntry`](#namespacesdatalayertype-aliasesdatalayerentrymd)

### Returns

`number`


<a name="namespacesdatalayerfunctionssetdatalayernamemd"></a>


***


## setDataLayerName()

> **setDataLayerName**(`name`): `void`
### Parameters

**name**: `string`

### Returns

`void`


<a name="namespacesdatalayertype-aliasesdatalayerentrymd"></a>


***


## Type Alias: DataLayerEntry

> **DataLayerEntry**: `Record`\<`string`, `AnyData`\>

<a name="namespacesdownloadandoutlinkreadmemd"></a>


Expand Down Expand Up @@ -1152,6 +1189,66 @@ Manually tracks outlink or download event with provided values
`void`


<a name="namespaceserrortrackingreadmemd"></a>


***


## ErrorTracking



- [enableJSErrorTracking](#namespaceserrortrackingfunctionsenablejserrortrackingmd)
- [trackError](#namespaceserrortrackingfunctionstrackerrormd)


<a name="namespaceserrortrackingfunctionsenablejserrortrackingmd"></a>


***


## enableJSErrorTracking()

> **enableJSErrorTracking**(`unique`?): `void`
Enables tracking of unhandled JavaScript errors.

### Parameters

**unique?**: `boolean`

track only unique errors

### Returns

`void`


<a name="namespaceserrortrackingfunctionstrackerrormd"></a>


***


## 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](#namespaceserrortrackingfunctionsenablejserrortrackingmd) function was called before this attempt). It will also respect rules for tracking only unique errors.

### Parameters

**error**: `Error`

### Returns

`void`


<a name="namespacesgoalconversionsreadmemd"></a>


Expand Down Expand Up @@ -1682,18 +1779,41 @@ Please use the ecommerceOrder instead.
***


## Type alias: Dimensions
## Type Alias: Dimensions

> **Dimensions**: `Record`\<\`dimension$\{number\}\`, `string`\>

<a name="type-aliasesinitoptionsmd"></a>


***


## Type Alias: InitOptions

> **InitOptions**: `object`
### Type declaration

#### dataLayerName?

> `optional` **dataLayerName**: `string`
Defaults to 'dataLayer'

#### nonce?

> `optional` **nonce**: `string`

<a name="type-aliasespaymentinformationmd"></a>


***


## Type alias: PaymentInformation
## Type Alias: PaymentInformation

> **PaymentInformation**: `object`
Expand Down Expand Up @@ -1730,7 +1850,7 @@ Please use the ecommerceOrder instead.
***


## Type alias: Product
## Type Alias: Product

> **Product**: `object`
Expand Down Expand Up @@ -1775,7 +1895,7 @@ Please use the ecommerceOrder instead.
***


## Type alias: VisitorInfo
## Type Alias: VisitorInfo

> **VisitorInfo**: [`"0"` \| `"1"`, `string`, `number`, `string` \| `number`, `number`, `number` \| `""`, `number` \| `""`]
Expand Down
55 changes: 28 additions & 27 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@piwikpro/ngx-piwik-pro-project",
"version": "2.0.3",
"version": "2.0.1",
"scripts": {
"ng": "ng",
"start": "ng serve",
Expand Down
2 changes: 1 addition & 1 deletion projects/ngx-piwik-pro/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@piwikpro/ngx-piwik-pro",
"version": "2.0.3",
"version": "2.0.1",
"description": "Piwik PRO tracking library for Angular apps.",
"keywords": [
"PiwikPRO",
Expand Down

0 comments on commit 1814456

Please sign in to comment.