blotoutio/sdk-js

Javascript SDK for Blotout

sdk-js's Issues

Classname error

We are getting error if you hover over svg events-logger.js?2efc:1 Uncaught TypeError: e.className.split is not a function

Introduce TS namespaces

Split code in packages

Code should be split in two packages.

• sdk-core (everything that we have - PII/PHI)
• sdk-personal (PII and PHI api's)

Duplicated events

we are getting duplicate events in the system. This could be related to our retry logic.

Move internal definitions from index.d.ts

Consent API

trends('consent', options)

options	Object		This is key/values pair object where key is provider/category for example facebook and value is boolean. true if user consents for data to be send to facebook and false if they do not

Example

trends('consent', { 
  facebook: true,
  google: false
})

Another way to use this api is based on categories.

Example

trends('consent', { 
  analytics: false,
  advertising: true
})

User can also just enable everything

Example

trends('consent', { 
  all: true
})

Do not send personal event if public key is missing

Remove event code generation for codified events

If event is codified we shouldn't send evcs anymore. Generation should happen on server side

Personal event don't match other API's and docs

Improve packaging

Right now we just package the whole thing on npm. We should add support for different modules types, so that people can use it as npm module directly: cjs, es, esm, modules, umd, etc

Implement idle time detection & visibility change detection

Add two events that will be triggered based on visibilitychange. Because we have this event now we can remove pagehide.

Name: visibility_visible
Event code: 11131

Name: visibility_hidden
Event code: 11132

user_id & session_id can't be null

In case on one client deployment, session_id was found null.

Check Slack conversation for more details.

OS name is not send in sdk_start

Loosing pagehide on mobile browsers

Add page title to payload

We need to put in meta object new property page_title, which will have value document.title.

Send click as beacon

We should send system event click as beacon, to be more reliable with capturing.

Add type to event payload

Fix jsdemo vercel deployment

Allow passing url in pageView for old page

Fix user time being null

Some time user created time is null, so we need to make it more bullet proof

Move PHI/PII option from options in new param

trends('capturePersonal', eventName, [additionalData], [isPHI], [options])

Add advance view to demo page

Remove appn from meta

Optimize github action cache

Simplify user id creation

System events

System events now don't have boolean in manifest anymore, but are defined as an array. Client side needs to handle new type in manifest.

Lower node version to 14

Additional data clarification

In our code right now we use data, eventData and additionalData for the same thing. This should be unified so that it's easier to read the code.

Unification of payload

Right now events are having different structure. We should unify it and only have one prop additionalInfo where we would put things that are event specific.

Updated demo to new env

Lower node version to 12.x

User id is null

In some cases user ID is still null.

Update docs to show how to use packages

Do not retry if offline

PageView should accept additionalData

We should allow users to put additionalData in pageView, so they can send custom data with sdk_start and page_hide.

Manifest changes

• remove lastUpdatedTime and bundleId from manifest payload
• remove deviceInfoGrain
• remove event path (just use hard coded value)
• remove end point (just use hard coded value)

kramdown security update

Add enabled API

Enabled api would allow developer to enable/disable collection at any point.

Fix release action

Right now release action is failing on publishing personal event because dep is not defined correctly. We need to use npm run bootstrap at the beginning to build all packages and do internal linking, so that we can publish all at once and not have dependency to npm.

We also need as part of version bump update package.json deps to blotout packages in sdk-personal and sdk-browser

Remove high frequency limitations

Remove deviceInfoGrain

deviceInfoGrain will not be needed anymore as server side will now do UA parsing, so logic for this can be removed

Click and Hover system events must capture DOM obj & object title

SDK should be able to capture DOM obj - complete path when nested.

Object Title use cases:
SDK should be able to capture DOM object title as :

• text displayed to the users.
• ALT text from images when image.
• when image without ALT text or object without title then ID
• When image without ALT text but with link then link
• As last resort DOM - object identifier or standard default as per DOM.

Current Behaviour:

• Right now we when I hover over images then though link or ids are present but title is missed because there is no ALT text present & link or IDs are not sent.

Also ALT text from images should be default choice for title if present after link.

---

Slack icon I was hovering when this event was sent - but I can't know.

Also let's set as recommendation in our documentation that ALT should be present for better analysis then link if ALT is not needed.

Unify payload

Add bulk api for capture

We should allow users to send multiple events at once to save bandwidth

mid is duplicated

When we send pageView we send two events at the same time. Because of that Date.now() is the same for them so mid is the same. We should use performance.now() instead of Date.now().

API to add data to events

Create API where user can define additional data that will be sent with every event. User can define if this data will be sent out with regular events, dev events or both. This should be stored in local storage per type.

defaultEventData(type, data)
type: 'system', 'codified', 'pii', 'phi'
data: object

Visibility events are not tagged correctly

Remove UA logic from client side and just send UA in meta

We should pass the whole UA in meta. Key should be user_agent

Add custom events

Remove dplatform from payload

This will be calculated on server based on plf