1.0.248 • Published 10 months ago

@bufferapp/buffer-tracking-browser-ts v1.0.248

Weekly downloads
-
License
ISC
Repository
github
Last release
10 months ago

npm version

Buffer Tracker - Browser (Typescript)

A Strongly-typed segment tracking companion for use in Browser Typescript projects. Under the hood this uses the Buffer segment tracking plan, acting as a type-safe wrapper for clients. With this, there is no need to pull in or reference the tracking plan!

You will need to have configured segment as per these instructions before using this package.

You can install this by running:

npm install @bufferapp/buffer-tracking-browser-ts

Before using, you'll need to ensure that your project is configured to access to segment. You can follow this guide here.

Next you'll need to add the typewriter import to the desired file:

import {BufferTracker} from '@bufferapp/buffer-tracking-browser-ts'

With the dependency added, you can use the typewriter reference to call the desired tracking functions:

typewriter.draftSubmitted({
  product: 'publish',
  channel: 'instagram',
  channelType: 'business',
  postId: '58edaj782102dff',
  channelId: '12345679',
  channelServiceId: '987654567898'
})

When calling these functions, any violations or errors will be logged as warnings to your console. if you wish for these to throw errors (maybe during development), then you can configure options on the typewriter reference to enable this:

typewriter.setTypewriterOptions({
  onViolation: (msg, violations) => {
    const issues = violations.map(v => v.keyword === 'type' ? `${v.message}: '${v.dataPath}'` : `${v.message}`)
    throw new Error(
      `"${msg.event}" Fired with Tracking Plan Violation\n    ${issues.join('\n    ')}`
    )
  }
})

Product / Client Typings

If you need access to Product or Client typings, you can import them like so:

import {Product, Client} from '@bufferapp/buffer-tracking-node-ts' If there is a Product or Client that is not included, let us know in the #data-governance slack channel and it can be added :)


Gotchas

There is currently no Type support for the requirement of a userId or anonymous ID when triggering a tracking event. We are working on adding support for this in the near future, but for now it's important to note that either one of these must be added when tracking!

Latest plan changes not reflected in the library

If the library does not reflect the latest tracking changes then you can trigger a rebuild manually. Head over to this URL and select the Run Workflow option. After a few minutes, the latest release should be pushed to NPM.

1.0.244

10 months ago

1.0.243

10 months ago

1.0.246

10 months ago

1.0.245

10 months ago

1.0.248

10 months ago

1.0.247

10 months ago

1.0.220

11 months ago

1.0.222

11 months ago

1.0.221

11 months ago

1.0.228

11 months ago

1.0.227

11 months ago

1.0.229

11 months ago

1.0.224

11 months ago

1.0.223

11 months ago

1.0.226

11 months ago

1.0.225

11 months ago

1.0.217

11 months ago

1.0.216

11 months ago

1.0.219

11 months ago

1.0.218

11 months ago

1.0.242

10 months ago

1.0.241

10 months ago

1.0.240

10 months ago

1.0.231

10 months ago

1.0.230

10 months ago

1.0.233

10 months ago

1.0.232

10 months ago

1.0.239

10 months ago

1.0.238

10 months ago

1.0.235

10 months ago

1.0.234

10 months ago

1.0.237

10 months ago

1.0.236

10 months ago

1.0.200

12 months ago

1.0.206

12 months ago

1.0.205

12 months ago

1.0.208

11 months ago

1.0.207

12 months ago

1.0.202

12 months ago

1.0.201

12 months ago

1.0.204

12 months ago

1.0.203

12 months ago

1.0.187

1 year ago

1.0.186

1 year ago

1.0.189

1 year ago

1.0.188

1 year ago

1.0.183

1 year ago

1.0.182

1 year ago

1.0.185

1 year ago

1.0.184

1 year ago

1.0.181

1 year ago

1.0.180

1 year ago

1.0.176

1 year ago

1.0.175

1 year ago

1.0.178

1 year ago

1.0.177

1 year ago

1.0.172

1 year ago

1.0.171

1 year ago

1.0.174

1 year ago

1.0.173

1 year ago

1.0.179

1 year ago

1.0.170

1 year ago

1.0.198

12 months ago

1.0.197

12 months ago

1.0.199

12 months ago

1.0.194

1 year ago

1.0.193

1 year ago

1.0.196

12 months ago

1.0.195

1 year ago

1.0.190

1 year ago

1.0.192

1 year ago

1.0.191

1 year ago

1.0.167

1 year ago

1.0.166

1 year ago

1.0.169

1 year ago

1.0.168

1 year ago

1.0.211

11 months ago

1.0.210

11 months ago

1.0.213

11 months ago

1.0.212

11 months ago

1.0.215

11 months ago

1.0.214

11 months ago

1.0.209

11 months ago

1.0.165

1 year ago

1.0.164

1 year ago

1.0.163

1 year ago

1.0.162

1 year ago

1.0.161

1 year ago

1.0.160

1 year ago

1.0.158

1 year ago

1.0.159

1 year ago

1.0.157

1 year ago

1.0.154

1 year ago

1.0.153

1 year ago

1.0.156

1 year ago

1.0.155

1 year ago

1.0.150

1 year ago

1.0.152

1 year ago

1.0.146

1 year ago

1.0.149

1 year ago

1.0.148

1 year ago

1.0.145

1 year ago

1.0.144

1 year ago

1.0.143

1 year ago

1.0.142

1 year ago

1.0.141

1 year ago

1.0.140

1 year ago

1.0.139

1 year ago

1.0.138

1 year ago

1.0.136

1 year ago

1.0.135

1 year ago

1.0.137

1 year ago

1.0.134

1 year ago

1.0.133

1 year ago

1.0.132

1 year ago

1.0.131

1 year ago

1.0.130

1 year ago

1.0.129

1 year ago

1.0.128

1 year ago

1.0.127

1 year ago

1.0.126

1 year ago

1.0.125

1 year ago

1.0.124

2 years ago

1.0.121

2 years ago

1.0.123

2 years ago

1.0.122

2 years ago

1.0.120

2 years ago

1.0.119

2 years ago

1.0.118

2 years ago

1.0.117

2 years ago

1.0.116

2 years ago

1.0.114

2 years ago

1.0.115

2 years ago

1.0.112

2 years ago

1.0.113

2 years ago

1.0.80

2 years ago

1.0.84

2 years ago

1.0.83

2 years ago

1.0.82

2 years ago

1.0.81

2 years ago

1.0.88

2 years ago

1.0.87

2 years ago

1.0.86

2 years ago

1.0.85

2 years ago

1.0.89

2 years ago

1.0.91

2 years ago

1.0.90

2 years ago

1.0.95

2 years ago

1.0.94

2 years ago

1.0.93

2 years ago

1.0.92

2 years ago

1.0.99

2 years ago

1.0.98

2 years ago

1.0.97

2 years ago

1.0.96

2 years ago

1.0.62

2 years ago

1.0.61

2 years ago

1.0.60

2 years ago

1.0.66

2 years ago

1.0.65

2 years ago

1.0.64

2 years ago

1.0.63

2 years ago

1.0.69

2 years ago

1.0.68

2 years ago

1.0.67

2 years ago

1.0.73

2 years ago

1.0.72

2 years ago

1.0.71

2 years ago

1.0.70

2 years ago

1.0.77

2 years ago

1.0.76

2 years ago

1.0.75

2 years ago

1.0.74

2 years ago

1.0.79

2 years ago

1.0.78

2 years ago

1.0.59

2 years ago

1.0.58

2 years ago

1.0.57

2 years ago

1.0.56

2 years ago

1.0.101

2 years ago

1.0.100

2 years ago

1.0.107

2 years ago

1.0.106

2 years ago

1.0.109

2 years ago

1.0.108

2 years ago

1.0.103

2 years ago

1.0.102

2 years ago

1.0.105

2 years ago

1.0.104

2 years ago

1.0.110

2 years ago

1.0.111

2 years ago

1.0.48

2 years ago

1.0.47

2 years ago

1.0.49

2 years ago

1.0.51

2 years ago

1.0.50

2 years ago

1.0.55

2 years ago

1.0.54

2 years ago

1.0.53

2 years ago

1.0.52

2 years ago

1.0.39

2 years ago

1.0.38

2 years ago

1.0.40

2 years ago

1.0.44

2 years ago

1.0.43

2 years ago

1.0.42

2 years ago

1.0.41

2 years ago

1.0.46

2 years ago

1.0.45

2 years ago

1.0.33

2 years ago

1.0.32

2 years ago

1.0.37

2 years ago

1.0.36

2 years ago

1.0.35

2 years ago

1.0.34

2 years ago

1.0.29

2 years ago

1.0.31

2 years ago

1.0.30

2 years ago

1.0.22

2 years ago

1.0.21

2 years ago

1.0.26

2 years ago

1.0.25

2 years ago

1.0.24

2 years ago

1.0.23

2 years ago

1.0.28

2 years ago

1.0.27

2 years ago

1.0.15

2 years ago

1.0.14

2 years ago

1.0.13

2 years ago

1.0.12

2 years ago

1.0.0

3 years ago

1.0.9

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

0.0.128

3 years ago

0.0.127

3 years ago

0.0.126

3 years ago

0.0.125

3 years ago

0.0.129

3 years ago

0.0.124

3 years ago

0.0.131

3 years ago

0.0.130

3 years ago

0.0.135

2 years ago

0.0.134

3 years ago

0.0.133

3 years ago

0.0.132

3 years ago

1.0.11

2 years ago

1.0.10

2 years ago

0.0.106

3 years ago

0.0.105

3 years ago

0.0.104

3 years ago

0.0.103

3 years ago

0.0.109

3 years ago

0.0.108

3 years ago

0.0.107

3 years ago

0.0.117

3 years ago

0.0.116

3 years ago

0.0.115

3 years ago

0.0.114

3 years ago

0.0.119

3 years ago

0.0.118

3 years ago

0.0.113

3 years ago

0.0.112

3 years ago

0.0.111

3 years ago

0.0.110

3 years ago

0.0.120

3 years ago

0.0.123

3 years ago

0.0.122

3 years ago

0.0.121

3 years ago

0.0.102

3 years ago

0.0.101

3 years ago

0.0.100

3 years ago

0.0.97

3 years ago

0.0.98

3 years ago

0.0.99

3 years ago

0.0.95

3 years ago

0.0.96

3 years ago

0.0.92

3 years ago

0.0.93

3 years ago

0.0.94

3 years ago

0.0.84

3 years ago

0.0.85

3 years ago

0.0.86

3 years ago

0.0.87

3 years ago

0.0.88

3 years ago

0.0.89

3 years ago

0.0.82

3 years ago

0.0.83

3 years ago

0.0.90

3 years ago

0.0.91

3 years ago

0.0.80

3 years ago

0.0.81

3 years ago

0.0.77

3 years ago

0.0.78

3 years ago

0.0.79

3 years ago

0.0.73

3 years ago

0.0.74

3 years ago

0.0.75

3 years ago

0.0.76

3 years ago

0.0.72

3 years ago

0.0.70

3 years ago

0.0.71

3 years ago

0.0.68

3 years ago

0.0.69

3 years ago

0.0.62

3 years ago

0.0.63

3 years ago

0.0.64

3 years ago

0.0.65

3 years ago

0.0.66

3 years ago

0.0.67

3 years ago

0.0.60

3 years ago

0.0.61

3 years ago

0.0.59

4 years ago

0.0.55

4 years ago

0.0.56

4 years ago

0.0.57

4 years ago

0.0.58

4 years ago

0.0.51

4 years ago

0.0.52

4 years ago

0.0.53

4 years ago

0.0.54

4 years ago

0.0.50

4 years ago

0.0.47

4 years ago

0.0.48

4 years ago

0.0.49

4 years ago

0.0.46

4 years ago

0.0.42

4 years ago

0.0.43

4 years ago

0.0.44

4 years ago

0.0.45

4 years ago

0.0.41

4 years ago

0.0.40

4 years ago

0.0.39

4 years ago

0.0.38

4 years ago

0.0.37

4 years ago

0.0.35

4 years ago

0.0.36

4 years ago

0.0.34

4 years ago

0.0.32

4 years ago

0.0.33

4 years ago

0.0.31

4 years ago

0.0.30

4 years ago

0.0.29

4 years ago

0.0.28

4 years ago

0.0.27

4 years ago

0.0.26

4 years ago

0.0.23

4 years ago

0.0.24

4 years ago

0.0.25

4 years ago

0.0.21

4 years ago

0.0.22

4 years ago

0.0.20

4 years ago

0.0.19

4 years ago

0.0.18

4 years ago

0.0.16

4 years ago

0.0.17

4 years ago

0.0.15

4 years ago

0.0.12

4 years ago

0.0.13

4 years ago

0.0.14

4 years ago

0.0.11

4 years ago

0.0.10

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.2

5 years ago

0.0.1

5 years ago