Installation

Requirements

• Node.js ≥ 20
• A Vista Group API key (operator token) or Vista loyalty cookie

Install the SDK

npm

npm install @theatrical/sdk

pnpm

pnpm add @theatrical/sdk

yarn

yarn add @theatrical/sdk

Install the CLI

The CLI is a dev dependency — install it globally or per-project.

global

npm install -g @theatrical/cli
theatrical --version

project

npm install --save-dev @theatrical/cli
npx theatrical --version

Install React components

npm

npm install @theatrical/react @theatrical/sdk

pnpm

pnpm add @theatrical/react @theatrical/sdk

Optional packages

Package	Purpose
@theatrical/analytics	Query Vista Horizon data warehouses
@theatrical/events	Real-time event bridge via polling

npm install @theatrical/analytics @theatrical/events

TypeScript

Theatrical requires TypeScript 5.0+. Add @theatrical/sdk types to your tsconfig.json:

{
  "compilerOptions": {
    "strict": true,
    "moduleResolution": "bundler",
    "target": "ES2022"
  }
}

All Theatrical packages ship with bundled .d.ts declarations — no @types/ packages needed.

Next steps

Head to the Quickstart to make your first API call in under five minutes.