@generousbuilders/js-sdk

@heypay/js-sdk

The SDK for interacting with the HeyPay platform.

Installation

The package is hosted on JSR. You can install it via:

# pnpm
pnpm dlx jsr add @heypay/effect-sdk

# Deno
deno add jsr:@heypay/effect-sdk

# bun
bunx jsr add @heypay/effect-sdk

# npm
npx jsr add @heypay/effect-sdk

# yarn
yarn dlx jsr add @heypay/effect-sdk

Usage

import { createHeyPay } from "@heypay/js-sdk";

const heypay = createHeyPay({
  // Your HeyPay Domain
  domain: "you.heypay.sh",
  // The ID of your product on HeyPay.
  productId: "pro_..."
});

Activating a License Key

const code = prompt("The License Key, please");

// Make sure to store the `license` in a secure place.
const license = await heypay.activate({ code });

Verifying a License

const refreshedLicense = await heypay.verify({ license });

Verifying a License (online)

const refreshedLicense = await heypay.verify({ license }, { online: true });

Getting Supporter Information

const { supporter } = await heypay.getSupporter({ license });