Future SDK

SDK is integrated by merchants to interact with Future.

Installation

cp env.example .env.development.local
npm install

Development

npm run dev

update .bashrc or .zshrc

export FUTUREAI_NPM_TOKEN="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"

Development is a build + watch.

Vite watches the v1 directory and re-runs the build whenever it is updated.

Build

npm run build

This puts the built and minified file in dist/

Deployment

Updates need to be made both to the public npm package and to the hosted file.

First, run a build:

npm run build

Publish

npm version [minor|major|bump]

Commit & create a PR to the main branch

NPM package

Copy the build into the public npm package folder's dist/:

cp dist/future-sdk.umd.cjs ../future-js/dist/index.js

Careful! These files will be part of the public sdk available on npm. Make sure there is no private information inside them!

Go into the package folder and update the version based on type (patch, minor, or major):

cd ../future-js
npm version <update_type>

Finally, publish the package online (requires sign in to an account with access to the future-sdk organization)

npm publish --access public

Hosted Link

The current version of the sdk is also made available online at https://sdk.paywithfuture.com/v1/future.js.

This file is hosted using Digital Ocean Spaces Object Storage.

To update, overwrite the file in the Spaces Object Storage located at future-sdk/v1/future.js.

Then purge the CDN cache.

Warning: Don't forget to purge the CDN cache!