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

@scrimmage/rewards

v1.4.0

Published

Simple rewards for your app or website

Downloads

461

Readme

Rewards.ts

The low-code loyalty program maker.

This library is a part of the Scrimmage Rewards Program that is providing a solution for loyalty programs and rewards.

Tutorial can be found at Scrimmage Rewards Tutorial.

Installation

  1. Install the library
    npm install @scrimmage/rewards
    or
    yarn add @scrimmage/rewards

Usage on the backend

  1. Import the library in CommonJS:

    const Scrimmage = require('@scrimmage/rewards');

    or in ES6:

    import Scrimmage from '@scrimmage/rewards';
  2. Initialize the library for global usage

    Scrimmage.initRewarder({
      apiServerEndpoint: '<your api server endpoint>',
      privateKey: '<your private key>',
      namespace: '<environment, e.g. staging or production>',   
    });
  3. Use the library

    await Scrimmage.reward.trackRewardable(
      'unique-user-id',
      'Data Type Name',
      {
        'custom-property': 'custom-value',
        'custom-property-2': {
           'custom-property-2-1': 'custom-value-2-1',
        },
      },
    );

    For one-time events you can use trackRewardableOnce method. Make sure to use unique event id.

     await Scrimmage.reward.trackRewardableOnce(
       'unique-user-id',
       'Data Type Name',
       'unique-event-id',
       {
          'custom-property': 'custom-value',
          'custom-property-2': {
              'custom-property-2-1': 'custom-value-2-1',
          },
       },
     );
  4. Get user token

    const token = await Scrimmage.user.getUserToken('unique-user-id');

    or

    const token = await Scrimmage.user.getUserToken('unique-user-id', {
       tags: ['tag1', 'tag2'],
       properties: {
          'custom-property': 'custom-value',
          'custom-property-2': 12345,
       },
    });

    Use this token to identify the user on the frontend. Make sure to deliver the token to the frontend securely.

Multiple connections

If you want to use multiple connections, you need to create a new instance of the library.

const rewarderForProduction = Scrimmage.createRewarder({
  apiServer: '<your api server endpoint 1>',
  privateKey: '<your private key 1>',
  namespace: '<environment 1, e.g. staging or production>',
});

const rewarderForStaging = Scrimmage.createRewarder({
  apiServer: '<your api server endpoint 2>',
  privateKey: '<your private key 2>',
  namespace: '<environment 2, e.g. staging or production>',
});

Then you can use the two instances simultaneously.

await rewarderForProduction.reward.trackRewardable(
  'unique-user-id',
  'Data Type Name',
  {
    'custom-property': 'custom-value',
    'custom-property-2': {
      'custom-property-2-1': 'custom-value-2-1',
    },
  },
);

await rewarderForStaging.reward.trackRewardable(
  'unique-user-id',
  'Data Type Name',
  {
    'custom-property': 'custom-value',
    'custom-property-2': {
      'custom-property-2-1': 'custom-value-2-1',
    },
  },
);

Usage on the frontend