@ai-guide/types

Shared TypeScript types and Zod schemas for the AI Guide SDK.

Installation

npm install @ai-guide/types
# or
pnpm add @ai-guide/types
# or
yarn add @ai-guide/types

Usage

import { GuideStep, GuideResponse, SelectorStrategy } from '@ai-guide/types';

// Use types in your application
const step: GuideStep = {
  action: 'click',
  selector: '#submit-button',
  description: 'Click the submit button',
  // ...
};

Available Types

Core Types

• GuideStep - Individual step in a guidance flow
• GuideResponse - Complete response from the AI guide API
• SessionState - Current state of a guidance session
• DOMElement - Simplified DOM element representation

Selector Strategies

• SelectorStrategy - Different strategies for element selection
• LayeredSelector - Multi-layered selector with fallbacks

Schemas

All types are backed by Zod schemas for runtime validation:

• guideStepSchema
• guideResponseSchema
• domElementSchema

Features

• 🔒 Runtime type validation with Zod
• 📘 Full TypeScript support
• 🎯 Designed for AI-powered UI guidance
• 🔄 Compatible with all AI Guide packages

License

MIT