Installation

Requirements

Node.js 20 or higher
Stateful mode (createSisp, the package’s own tables): knex plus one database driver - SQLite (better-sqlite3), PostgreSQL (pg), or MySQL (mysql2)
Stateless mode (createStatelessSisp, no package-owned tables): neither knex nor a database driver

Install the package

npm install @akira-io/sisp

Stateful mode

knex and the database driver are both optional peer dependencies; createSisp needs both:

npm install knex better-sqlite3   # local development and small deployments
npm install knex pg               # PostgreSQL
npm install knex mysql2           # MySQL

Skipping knex here is the most common way to hit a runtime error on first boot - it is not a transitive dependency of the driver packages.

Stateless mode

createStatelessSisp persists nothing of its own, so it needs neither knex nor a driver. See Stateless Mode.

HTTP routes

If you mount the HTTP routes, install the framework adapter peer as well. Fastify is the default adapter (fastify plus @fastify/formbody); express and @nestjs/common are supported alternatives.

Migrations

The schema ships inside the package and runs automatically the first time createSisp boots (autoMigrate: true by default). Progress is tracked in its own sisp_migrations control table, so repeated boots are no-ops.

For production setups that forbid DDL at boot time, disable it and run the CLI instead:

const sisp = await createSisp({
  // ...
  database: {
    client: 'pg',
    connection: process.env.DATABASE_URL,
    autoMigrate: false,
  },
});

npx sisp migrate

The CLI reads the configuration from sisp.config.js, sisp.config.mjs, sisp.config.cjs, or sisp.config.json in the working directory. The JavaScript variants must default-export the same object you pass to createSisp.

Created tables

sisp_transactions, sisp_transaction_items, sisp_transaction_attempts, sisp_payment_intents, sisp_invoices, sisp_request_metadata, sisp_rate_limits, sisp_blacklist, and sisp_transaction_logs. All names are configurable through the tables option.

Next: Configuration