Adobe Client Data Layer
The Adobe Client Data Layer aims to reduce the effort to instrument websites by providing a standardized method to expose and access any kind of data for any script.
Documentation
Consuming
The best way to try out the Adobe Client Data Layer is to install the distributed npm package in your project build, by running:
npm install @adobe/adobe-client-data-layer
Locate the /dist folder in the installed package, which contains the built and minified javascript.
This script can then be included in your page head, as follows:
<script src="adobe-client-data-layer.min.js" async defer></script>Note - you can directly access the minified version of the data layer without downloading the sources and compiling them.
Building / Testing
First run the following commands:
npm install
Then choose from the following npm scripts:
npm run dev- run the tests, generates the build in the./distfolder and runs a development server onlocalhost:3000.npm run build- run the tests and generates the build in the./distfolder.npm run test- run the unit tests
Note - you can get some stats (bundle size, download time) about the released version.
Releasing
Note - only release this package if you have access to the Adobe npm organization and are a project committer.
First run the following commands:
git checkout master
git pull
rm -rf node_modules && npm install
Then run:
npm run release- prompts for a new version, with patch, minor or major versions allowed, see NPM Semantic Versioning. Following selection, the task will increase, commit and push the version, create and push the Git release tag, and publish the npm package.
Contributing
Contributions are welcome! Read the Contributing Guide for more information.
Licensing
This project is licensed under the Apache V2 License. See LICENSE for more information.