@seenn/types

Shared TypeScript types for all Seenn SDKs. This package is the single source of truth for type definitions.

Installation

npm install @seenn/types
# or
pnpm add @seenn/types

Usage

import type {
  SeennJob,
  JobStatus,
  StageInfo,
  ConnectionState,
  SSEEventType,
} from '@seenn/types';

SDK Sync Guidelines

When updating types in this package:

1. Bump version in package.json
2. Publish to npm: npm publish
3. Update all SDKs to use new version:
   • @seenn/react-native
   • @seenn/node
   • seenn_flutter (generate from TypeScript)

Version Compatibility

| @seenn/types | @seenn/react-native | @seenn/node | seenn_flutter | |--------------|---------------------|-------------|---------------| | 0.1.0 | 0.2.6+ | 0.2.2+ | 0.1.0+ |

Type Categories

Core Types

• SeennJob - Main job object
• JobStatus - Status enum
• StageInfo, QueueInfo - Progress info
• JobResult, JobError - Completion data

Parent-Child Types

• ParentInfo, ChildrenStats - Relationship data
• ChildJobSummary - Child job info
• ParentWithChildren - Full parent with children

SSE Types

• ConnectionState - SSE connection states
• SSEEventType - All SSE event types
• SSEEvent - Event wrapper

API Types

• CreateJobParams, UpdateJobParams - Request types
• CompleteJobParams, FailJobParams - Completion types

Live Activity Types

• LiveActivityStartParams, LiveActivityUpdateParams
• LiveActivityEndParams, LiveActivityResult

Flutter Integration

For Flutter SDK, generate Dart types from this package:

# In seenn-platform root
pnpm run generate:flutter-types

This runs scripts/generate-flutter-types.ts which converts TypeScript to Dart.

License

MIT