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

@mackenly/zaraz-tools

v0.2.1

Published

Unofficial 3rd party toolkit for Zaraz

Downloads

402

Readme

Zaraz Tools

Community toolkit package for working and building with Zaraz

[!CAUTION] This package is temporarily in a unstable pre-release state. Please use with caution and report any issues you find.

[!NOTE]
Not sure what Zaraz is? Check out the Zaraz website for more information.

This toolkit is broken down into several different tools that can be used to work with Zaraz. The tools types are as follows:

  • Mocking / Testing Tools
  • Managed Component Utilities
  • Context Enrichment Tools
  • Consent Management Tools soon
  • Consent Management React Components Primitives soon

This package is not built, supported, or maintained by Cloudflare / Zaraz. Don't contact Cloudflare for support with this package. Instead, open an issue here on GitHub.

Why?

Hi, my name is Mackenly Jones, creator/maintainer of this package. While building Zaraz integrations for my clients I've found that many of the tools I've built are reusable across projects. This package is an attempt to make those tools available to the community to help speed up development and ensure best practices are followed. Furthermore, it lets me keep the tools up to date across all my projects by updating the package in one place.

If you or your company needs help building a Zaraz integration, reach out to me at Tricities Media Group and I'll either point you in the right direction or if it makes sense you can hire me as a consultant to help you build your integration. I'm a Certified Zaraz Developer and have built many Zaraz integrations for clients of all sizes.

Installation

To install this package, you can use your favorite package manager. Here are the commands for each:

npm install @mackenly/zaraz-tools
yarn add @mackenly/zaraz-tools
pnpm add @mackenly/zaraz-tools

Currently published on npm and GitHub Packages. If there's another package manager you'd like to see this package on, please let me know by opening an issue.

Versioning

This project uses Semantic Versioning. For the versions available, see the tags on this repository.

import { Foo } from '@mackenly/zaraz-tools';

Mocking / Testing Tools

mockManager

const mockManager: Manager

This mocks the Zaraz manager for use in testing custom managed components.

mockEvent

const mockEvent: MCEvent

This mocks the Zaraz event for use in testing custom managed components.

import { mockEvent } from '@mackenly/zaraz-tools';

const event = {
    ...mockEvent,
    payload: {
        ...mockEvent.payload,
        customValue: 'hello-there',
    },
};

Managed Component Utilities

sha256

function sha256( data: string, lowercase: boolean = false): Promise<string>

This function takes a string and returns a promise that resolves to the SHA-256 hash of the string. The second parameter is a boolean that determines if the hash should be lowercased before being hashed. By default, the string is not transformed.

import { sha256 } from '@mackenly/zaraz-tools';

const hash = await sha256('hello');
console.log(hash); // 2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824

Context Enrichment Tools

ZarazContext

interface ZarazContext

// within a context enricher:
const { system, client, config } = await request.json() as ZarazContext;

Provides a TypeScript type for the Zaraz context object.

Consent Management Tools

[!NOTE] Coming soon!

Consent Management React Components

[!NOTE]
Coming soon!

License

This project is licensed under the Apache 2.0—see the LICENSE.md file for details.

Security Policy

To report a security issue please see our security policy.

Contributing

We welcome contributions! Please see our contributing guidelines for more information.

Sponsorship

If you'd like to support this project, please consider becoming a sponsor and letting me know so I can give you a shoutout here! 🎉 Otherwise, this project is sponsored by Tricities Media Group and Mackenly Jones which is a Certified Zaraz Developer providing consulting and development services for Zaraz integrations and deployments.