npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mparticle/data-planning-node

v1.0.6

Published

A Node Interface for Data Planning

Downloads

3,491

Readme

npm

mParticle Data Planning Node SDK

Hello! This is the public repo of the mParticle Web Data Planning SDK. We've built the mParticle platform to take a new approach to web and mobile app data and the platform has grown to support 200+ services and SDKs, including developer tools, analytics, attribution, messaging, and advertising services. mParticle is designed to serve as the connector between all of these services - check out our site, or hit us at [email protected] to learn more.

Documentation

Fully detailed documentation and other information about mParticle web SDK can be found at our doc site

Overview

The main purpose of this project is to validate your customer data before it arrives at mParticle's systems. In simplest terms, a Data Plan represents the contract between your data and mParticle.

This project allows the fetching of Data Plans or Data Plan Versions and the ability to validate your events and batches against said Data Plan Versions.

Getting Started

Importing Data Planning Node

$ npm install @mparticle/data-planning-node

To use this within your project:

import { DataPlanService } from '@mparticle/data-planning-node';

Fetching Data Plans

To fetch a Data Plan or Data Plan Version, you will first need the following credentials:

  • Organization ID
  • Workspace ID
  • Account ID
  • Bearer Token from Platform API
import { DataPlanService } from '@mparticle/data-planning-node';

const dataPlanService = new DataPlanService();

// Fetch full data plan
dataPlanService
    .getPlan(<organizationId>,<accountId>, <dataPlanId>, <workspaceId>, <token>)
    .then(dataPlan => {
        // Save or render your data plan
    });

// Fetch Data Plan Version
dataPlanService
    .getVersionDocument(<organizationId>, <accountId>, <dataPlanId>, <workspaceId>, <versionNumber>, <token>)
    .then(dataPlanVersion => {
        // Save or render your data plan version
    });

Validating Data

To validate your event or batch, you should use the validateEvent, validateEvents, or validateBatch methods, respectively.

import { DataPlanService } from '@mparticle/data-planning-node';

const dataPlanService = new DataPlanService();

// Fetch Data Plan Version asynchronously
const dataPlanVersion = await dataPlanService
    .getVersionDocument(<organizationId>, <accountId>, 'my_custom_data_plan, <workspaceId>, 3, <token>);

const batchValidationResults = dataPlanService.validateBatch(batch, dataPlanVersion.version_document);

const eventValidationResults = dataPlanService.validateEvent(event, dataPlanVersion.version_document);

Validation Result Sample

results: [
    {
        data: {
            match: {
                type: 'screen_view',
                criteria: {
                    screen_name: 'Test Screen View',
                },
            },
            validation_errors: [
                {
                    error_pointer: '#/data',
                    key: 'data',
                    expected: 'custom_flags',
                    schema_keyword: 'required',
                    validation_error_type: 'missing_required',
                },
            ],
        },
        event_type: 'validation_result',
    },
],

Contribution Guidelines

At mParticle, we are proud of our code and like to keep things open source. If you'd like to contribute, simply fork this repo, push any code changes to your fork, and submit a Pull Request against the master branch of mParticle-web-media-sdk.

Running the Tests

Prior to running the tests please install all dev dependencies via an npm install, and build the mParticle.js file as well as the test file by running npm run build:

$ npm install
$ npm run build
$ npm test

The test script will run all tests using Mocha as unit tests.

Development Notes

This package comes with the NPM package pre-commit, which will run GTS when you try to commit.

Support

[email protected]

License

The mParticle Web Media SDK is available under the Apache License, Version 2.0. See the LICENSE file for more info.