@slotkitjs/types

TypeScript type definitions for the SlotKit plugin system.

Overview

This package provides type-only exports for the SlotKit plugin system, allowing plugins to import type definitions without creating runtime dependencies on implementation code.

Installation

npm install @slotkitjs/types
# or
pnpm add @slotkitjs/types
# or
yarn add @slotkitjs/types

Usage

Importing Service Contracts

import type { IAuthService, IHttpClient } from '@slotkitjs/types/contracts'

// Use types without importing implementations
const authService = context.services.get<IAuthService>('IAuthService')

Importing Event Types

import type { AuthLoginEvent, AuthLogoutEvent } from '@slotkitjs/types/events'

// Type-safe event handling
context.events.on<AuthLoginEvent>('auth:login', (event) => {
  console.log('User logged in:', event.payload.userId)
})

Importing Core Types

import type {
  ServiceContainer,
  EventBus,
  ExtensionRegistry,
  PluginContext
} from '@slotkitjs/types/core'

Package Structure

• /contracts - Service contract interfaces
• /events - Event type definitions
• /core - Core system type definitions

Benefits

1. No Runtime Dependencies: Import types without bundling implementation code
2. Type Safety: Full TypeScript type checking across plugin boundaries
3. Decoupling: Plugins depend only on interfaces, not implementations
4. Versioning: Type definitions can be versioned independently

License

MIT