@llml-browser/types

@llml/api-types

TypeScript types and schemas for the LLML API.

Installation

npm install @llml/api-types
# or
yarn add @llml/api-types
# or
pnpm add @llml/api-types
# or
bun add @llml/api-types

Usage

Type-Only Imports (No Runtime Code)

import type { CrawlResult, CrawlOptions } from '@llml/api-types';

// Use types in your code
const result: CrawlResult = {
  url: 'https://example.com',
  status: 200,
  browserSessionId: 'session-123',
  completedTimestamp: new Date().toISOString(),
};

Runtime Validation with Zod Schemas

import { schemas } from '@llml/api-types';

// Validate data at runtime
const options = {
  format: ['markdown'],
  includeTimings: true,
};

const validated = schemas.ContentProcessingOptionsSchema.parse(options);

Available Types

• CrawlResult - Result of a URL crawl
• CrawlOptions - Configuration options for the crawler
• ContentFormat - Supported content formats ('raw', 'cleanedHTML', 'markdown')
• ContentProcessingOptions - Content processing configuration
• HTMLCleaningMetrics - Metrics for HTML cleaning process
• PageMetrics - Page performance metrics
• CrawlMetrics - Overall crawl metrics
• LimitsResponse - Browser service limits
• BrowserStatus - Browser service status

Available Schemas

All types have corresponding Zod schemas for runtime validation:

import { schemas } from '@llml/api-types';

const {
  ContentFormatSchema,
  ContentProcessingOptionsSchema,
  CrawlOptionsSchema,
  PuppeteerOptionsSchema,
  HTMLCleaningOptionsSchema,
  TurndownOptionsSchema,
  LinkExtractionOptionsSchema,
  MetadataOptionsSchema,
} = schemas;

Package Structure

src/
  ├── types/        # Type definitions (no runtime code)
  │   ├── core.ts   # Core types
  │   └── index.ts  # Type exports
  ├── schemas/      # Zod schemas (runtime code)
  │   ├── core.ts   # Core schemas
  │   └── index.ts  # Schema exports
  └── index.ts      # Main entry point

Development

# Install dependencies
bun install

# Build package
bun run build

## License

MIT