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

@bloomreach/segmentation

v0.0.16

Published

Bloomreach Segmentation

Downloads

763

Readme

Segmentation

Javascript library that helps to connect Exponea segmentation with Bloomreach SPA SDK.

Prerequisite

You must have Exponea snippet injected in your app. To be able to use the segmentsSubscription and the latest API for fetching segments, the Exponea snippet should be at least 3.0.0 version.

Installing

npm install @bloomreach/segmentation

Usage

Run initializePersonalization({ path }) where path is part of the URL, including a query string with campaign parameters.

API methods

  • initializePersonalization(configuration: CampaignConfiguration & SegmentationConfiguration) - initializes campaign and segmentation personalization.
  • initializeCampaignPersonalization(configuration: CampaignConfiguration) - initializes campaign personalization.
  • initializeSegmentation(configuration: SegmentationConfiguration) - initializes organic personalization.
  • segmentsSubscription(callback, configuration: SegmentationConfiguration) - subscribes to segments changes. The Exponea snippet should be at least 3.0.0 version to be able to use this method.

Configuration

There are two types of configuration objects that you pass to API methods: CampaignConfiguration and SegmentationConfiguration described below.

Campaign configuration

  • path: string(required) - path of the current page, including a query string with campaign parameters.
  • campaignVariantUrlParameter: string - URL query parameter name with campaign id. Default: btm_campaign_id.
  • campaignSegmentUrlParameter: string - URL query parameter name with segment id. Default: btm_segment.
  • campaignTtlUrlParameter: string - URL query parameter name with TTL value. Default: btm_ttl.
  • campaignCookieTtlMaxValue: number - Campaign cookie TTL max value in days. Default: 7.
  • campaignVariantCookieName: string - Cookie name for campaign id. Default: __br__campaign_id.
  • campaignSegmentCookieName: string - Cookie name for campaign segment. Default: __br__segment.

Segmentation configuration

  • ~~projectToken: string~~ - Deprecated. Project token from Exponea that is used when setting event tracking on the website or in mobile apps. It can be found in Project Settings in Exponea admin panel.
  • ~~targetURL: string~~ - Deprecated. Target url where the API is hosted.
  • ~~cacheMaxTime: string~~ - Deprecated. Define in seconds how frequently the front-end needs to refresh the cache of the personalised segments.

Workflow and Release

  • Create MR with changes.
  • When the pipeline is green and MR is approved, merge it to master.
  • Create a new commit with the new version number and push it to master.
  • The pipeline will automatically publish the package to npm.