@api-buddy/core-api

The foundational package of API Buddy, providing core functionality for building and managing API integrations. This package serves as the backbone for the plugin system and provides essential utilities for API operations.

🏗 Architecture Position

Core-API is the central component of API Buddy's architecture, sitting at the heart of the system and providing:

• Core Client: The main API client interface
• Type System: Base types and interfaces for all API operations
• Plugin Infrastructure: Foundation for the plugin system
• Common Utilities: Shared functionality used across all API integrations

graph TD
    A[Core-API] --> B[Plugin System]
    A --> C[API Clients]
    A --> D[Type System]
    
    B --> B1[Plugin Registration]
    B --> B2[Lifecycle Management]
    B --> B3[Dependency Resolution]
    
    C --> C1[HTTP Client]
    C --> C2[Authentication]
    C --> C3[Error Handling]
    
    D --> D1[Base Types]
    D --> D2[Validation]
    D --> D3[Type Generation]

🚀 Features

• Type-Safe Core: Built with TypeScript for end-to-end type safety
• Modular Design: Import only what you need
• Plugin Ready: Extensible architecture for adding new API integrations
• Developer Experience: Comprehensive error handling and logging
• Modern JavaScript: Native ESM support with tree-shaking

📦 Installation

npm install @api-buddy/core-api
# or
yarn add @api-buddy/core-api
# or
pnpm add @api-buddy/core-api

🛠 Usage

Basic Setup

import { APIClient } from '@api-buddy/core-api';

// Initialize the API client
const apiClient = new APIClient({
  baseURL: 'https://api.example.com',
  // Optional: Configure default headers, timeouts, etc.
});

// Make API requests
const data = await apiClient.get('/endpoint');

With Plugin System

import { APIClient } from '@api-buddy/core-api';
import { StripePlugin } from '@api-buddy/stripe';

const client = new APIClient();

// Register plugins
client.use(new StripePlugin({
  apiKey: process.env.STRIPE_SECRET_KEY,
}));

// Use plugin functionality
const customer = await client.stripe.customers.retrieve('cus_123');

🔌 Plugin Development

Core-API provides the foundation for building plugins. Here's a basic example:

import { Plugin, APIClient } from '@api-buddy/core-api';

export class MyPlugin implements Plugin {
  name = 'my-plugin';
  
  install(client: APIClient) {
    // Add your plugin's functionality here
    client.myPlugin = {
      hello: () => 'Hello from MyPlugin!'
    };
  }
  
  // Optional: Implement lifecycle methods
  async initialize() {
    console.log('MyPlugin initialized');
  }
}

📚 API Reference

APIClient

The main client class for making API requests.

Constructor Options

| Option | Type | Description | Default | |--------|------|-------------|---------| | baseURL | string | Base URL for all requests | '' | | timeout | number | Request timeout in milliseconds | 30000 | | headers | Record<string, string> | Default headers | {} |

Methods

• get<T>(url: string, config?: RequestConfig): Promise<T>
• post<T>(url: string, data?: any, config?: RequestConfig): Promise<T>
• put<T>(url: string, data?: any, config?: RequestConfig): Promise<T>
• delete<T>(url: string, config?: RequestConfig): Promise<T>
• use(plugin: Plugin): void - Register a plugin

🚧 Development Status

Current Features

• [x] Base client implementation
• [x] Type definitions
• [x] Plugin system foundation
• [x] Basic error handling

Upcoming Features

• [ ] Plugin lifecycle management
• [ ] Authentication helpers
• [ ] Request/response interceptors
• [ ] Caching layer

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for more details.

📄 License

MIT © API Buddy