ddl-tools-plugin-user

User plugin for ddl-tools, a digital data layer helper utility with data layer schema validation for highly-decoupled analytics reporting.

Installation

Via yarn:

yarn add ddl-tools-plugin-user

Via npm

npm install --save ddl-tools-plugin-user

Usage

To use this plugin, you will need to instantiate DDLTools like you would typically do. You will also need to import this plugin, and call the use method to load the plugin into the DDLTools instance.

For example:

import DDLTools from 'ddl-tools';
import DDLValidator from 'ddl-validator';
import userPlugin from 'ddl-tools-plugin-user';
import schema from './path/to/mySchema';

const ddlValidator = new DDLValidator(schema);
const ddlTools = new DDLTools(window.digitalData, ddlValidator);
ddlTools.use(userPlugin);

Once loaded, additional methods and classes will be present on the DDLTools instance. For example:

const profile = new ddlTools.UserProfile();
profile.setUserName(username);
const user = new ddlTools.User();
user.addProfile(profile);
ddlTools.addUser(user);

See the Technical Documentation for more detailed information on what methods and classes are added by this plugin.

Technical Documentation

• ddl-tools-plugin-user

Local Installation

These steps are not necessary (nor useful) for normal use. These steps are only necessary to view the source or run tests.

To install locally, clone this repository, install dependencies, and build it.

git clone https://github.com/dash-/mono-ddl-tools.git
cd mono-ddl-tools/packages/ddl-tools-plugin-user
yarn install
npm run build

Tests

To run the unit tests, you must have this package installed locally.

Once you have this package installed locally, from the package's base directory, run npm run test.

ddl-tools-plugin-user $ npm run test

> [email protected] pretest mono-ddl-tools/packages/ddl-tools-plugin-user
> npm run -s lint

Lint finished...


> [email protected] test mono-ddl-tools/packages/ddl-tools-plugin-user
> jasmine test/specs/**/*Spec.js

Started
....................................................................................


84 specs, 0 failures
Finished in 0.069 seconds

Contribute

The easiest way to contribute is to submit issues on GitHub. We welcome feedback and deeply appreciate your contribution of an issue for:

• Improvement ideas
• Feature requests
• Bugs

Of course, code contributions are welcome as well!

To contribute code to this project, first fork the monorepo in GitHub, create a feature or bug branch, and commit code to the branch. You can then create a PR against the main repository. More information can be found on this topic in Rob Allen's guide:

• The beginner's guide to contributing to a GitHub project