Snowplow JavaScript and TypeScript Analytics SDK

This JavaScript SDK provides an ability to work with Snowplow enriched events in your JavaScript or TypeScript event processing, data modeling, and machine-learning jobs. You can also use this SDK with AWS Lambda.

Currently, the JavaScript Analytics SDK provides the JSON Event Transformer only.

You can find more information about Snowplow Analytics SDKs in general on Snowplow Wiki.

Source acknowledgement

This SDK was contributed by Michael Dokolin in 2018 - big thanks for the help in getting this one started and maintaining it over the years!

Install

npm install --save snowplow-analytics-sdk

Usage

In your app.js:

const { transform } = require('snowplow-analytics-sdk');

module.exports.handler = (input) => {
  let event = transform(
    new Buffer(input.Records[0].kinesis.data, 'base64').toString('utf8'),
  );

  // ...
};

Or in app.ts:

import { transform } from 'snowplow-analytics-sdk';

export function handler(input: any) {
  let event = transform(
    new Buffer(input.Records[0].kinesis.data, 'base64').toString('utf8'),
  );

  // ...
}

API

transform(event: string): Event

• event: string - TSV string containing event data.

Returns decoded Snowplow enriched event.

Links

• Canonical Event Model
• Snowplow Analytics SDK
• SDK Overview
• JSON Event Transformer

Copyright and license

The Snowplow JS Analytics SDK is copyright 2018-current Snowplow Analytics Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.