@orchestree/onboarding

User onboarding and guided tours for Orchestree. Create onboarding wizards, interactive tours, and track user progress.

Installation

npm install @orchestree/onboarding

Quick Start

const { OnboardingClient } = require('@orchestree/onboarding');

const client = new OnboardingClient({
  apiKey: 'your-api-key',
});

// Create onboarding wizard
const wizard = await client.createWizard({
  name: 'Product Setup',
  steps: [
    { title: 'Welcome', description: 'Get started', order: 1 },
    { title: 'Configuration', description: 'Configure your account', order: 2 },
    { title: 'Invite Team', description: 'Add team members', order: 3 },
  ],
});

// Start tour
await client.startTour('user-123', wizard.id);

// Track progress
await client.trackProgress('user-123', 'step-1');

// Get user progress
const progress = await client.getUserProgress('user-123');

API Reference

OnboardingClient

createWizard(wizardDef)

Create an onboarding wizard.

const wizard = await client.createWizard({
  name: 'Getting Started',
  steps: [
    { title: 'Step 1', description: 'First step', order: 1 },
    { title: 'Step 2', description: 'Second step', order: 2 },
  ],
});

startTour(userId, tourId)

Start a guided tour for a user.

await client.startTour('user-123', 'tour-456');

trackProgress(userId, stepId)

Track user progress on a step.

const progress = await client.trackProgress('user-123', 'step-1');

getCompletionRate(wizardId)

Get wizard completion statistics.

const stats = await client.getCompletionRate(wizard.id);

License

MIT