Skip to content

About

RevenueDot web SDK in TypeScript: web subscriptions and entitlements that stay in sync with your mobile apps. MIT fork of RevenueCat's purchases-js that works with the open-source RevenueDot server.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

917 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RevenueDot

RevenueDot Web SDK

This is RevenueDot's MIT fork of RevenueCat's @revenuecat/purchases-js: the same classes and method names, pointed at a RevenueDot server (RevenueDot Cloud at https://api.revenuedot.app, or one you host) with RevenueDot's response-signing key built in, and kept in sync with upstream.

License: MIT npm Upstream

Install

npm install @revenuedot/purchases-js

Or keep every import as it is with an npm alias in package.json:

"@revenuecat/purchases-js": "npm:@revenuedot/purchases-js@1.67.0"

Configure

import { Purchases } from "@revenuedot/purchases-js";

const purchases = Purchases.configure({
  apiKey: "test_...",      // the web app's public key from the RevenueDot dashboard
  appUserId: "user_123",
  // Self-hosted server only: RevenueDot Cloud (https://api.revenuedot.app) is the default. No trailing slash.
  httpConfig: { proxyURL: "https://revenuedot.example.com" },
});

The fork already trusts RevenueDot's signing key, so no signature or verification setting is needed. Analytics events follow proxyURL too, so collectAnalyticsEvents can stay on, and the checkout reads "Secure checkout by RevenueDot". Full guide: https://revenuedot.app/docs/sdks/web.

What RevenueDot adds

  • Start free on RevenueDot Cloud: free up to $10,000 a month of tracked revenue, then 0.5%, never more than $999 a month (pricing).
  • The same REST API and webhook payloads as RevenueCat, so your backend and integrations keep working (API reference).
  • Entitlements shared with your iOS and Android apps, Test Store purchases in the browser, and real payments through RevenueDot's hosted Stripe checkout (web billing guide).
  • A one-line migration: point the stock SDK at RevenueDot with httpConfig.proxyURL, or install this fork and drop the line (migration guide).

Use with your coding agent

Coding agents can read this repository's docs and code on demand, so they use the right package and imports:

Links

RevenueDot is not affiliated with RevenueCat, Inc. RevenueCat's copyright notice stays in LICENSE; RevenueDot's changes are MIT too.


Upstream README (RevenueCat's, unchanged)

😻 In-App Subscriptions Made Easy 😻

🕸️ For the web 🕸️

RevenueCat is a powerful, reliable, and free to use in-app purchase server with cross-platform support. This repository includes all you need to manage your subscriptions on your website or web app using RevenueCat.

Sign up to get started for free.

Prerequisites

Login @ app.revenuecat.com

  • Connect your Stripe account if you haven't already (More payment gateways are coming soon)
  • Create a Project (if you haven't already)
  • Add a new Web Billing app
  • Get the sandbox API key or production API key (depending on the environment)
  • Create some products for the Web Billing App
  • Create an offering and add packages with Web Billing products
  • Create the entitlements you need in your app and link them to the Web Billing products

Installation

  • Add the library to your project's dependencies
    • npm
      npm install --save @revenuecat/purchases-js
      
    • yarn
      yarn add --save @revenuecat/purchases-js
      

Usage

See the RevenueCat docs and the SDK Reference.

Development

Install the library in a local project

  • Clone the repository
  • Install dependencies
  • Build the library
pnpm install
pnpm run build:dev

For automatic rebuilds of the web entry point during development, run:

pnpm run build:dev-watch

build:dev-watch is web-only. It preserves the Vega artifacts produced by build:dev, but does not rebuild them; rerun pnpm run build:dev after changing code used by the Vega entry point.

To avoid publishing the package you can use pnpm's link feature:

  1. In the purchases-js directory, register the package:
pnpm link
  1. In your testing project, link to the registered package:
pnpm link "@revenuecat/purchases-js"

Note: Any changes you make to the library will be automatically reflected in your testing project after running pnpm run build:dev or pnpm run build.

Using a local @revenuecat/purchases-ui-js

When you need to iterate on both purchases-js and purchases-ui-js together, you can point this repo at a sibling checkout using a pnpm-workspace.yaml override (instead of manually editing package.json).

  1. Place the two repos side by side, for example:
Developer/
  purchases-js/
  purchases-ui-js/
  1. In purchases-js, create or edit pnpm-workspace.yaml and add:
overrides:
  "@revenuecat/purchases-ui-js": "link:../purchases-ui-js"

Use the scoped package name (@revenuecat/purchases-ui-js). A key like purchases-ui-js will not apply the override.

  1. Reinstall dependencies from the purchases-js root:
pnpm install
  1. Verify the override resolved:
pnpm why @revenuecat/purchases-ui-js

You should see link:../purchases-ui-js.

  1. Build the UI package when you change it (from purchases-ui-js), then rebuild or run dev builds in purchases-js as needed.

Reverting

Remove the override from pnpm-workspace.yaml and run pnpm install again to return to the published @revenuecat/purchases-ui-js version.

Running Storybook

pnpm run storybook

Environment Setup for Purchase Stories

Note: This setup is only required if you need to test Storybook stories involving the payment-entry page.

To run these specific stories, you'll need to set up some environment variables. There are two options:

Option 1: Internal Teams

Internal team members can find the required environment variables in 1Password.

Option 2: Setup Manually

  1. Create a test account in Stripe
  2. Create a .env.development.local file and set the following variables:
VITE_STORYBOOK_PUBLISHABLE_API_KEY="pk_test_1234567890"
VITE_STORYBOOK_ACCOUNT_ID="acct_1234567890"

Running tests

pnpm run test

Running linters

pnpm run test:typecheck
pnpm run svelte-check
pnpm run prettier
pnpm run lint

Running E2E tests

Please check the Demo app readme here

Update API specs

pnpm run extract-api

This will update the files in api-report and vega/api-report with the latest public API for both packages. If it has uncommitted changes, CI tests will fail. Run this command and commit the changes if they are expected.

Publishing a new version

New versions are automated weekly, but you can also trigger a new release through CircleCI or locally following these steps:

  • Run bundle exec fastlane bump and follow the instructions
  • A PR should be created with the changes and a hold job in CircleCI.
  • Approve the hold job once tests pass. This will create a tag and continue the release in CircleCI
  • Merge the PR once it's been released

About

RevenueDot web SDK in TypeScript: web subscriptions and entitlements that stay in sync with your mobile apps. MIT fork of RevenueCat's purchases-js that works with the open-source RevenueDot server.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages