open-index/open-npm huggingface dataset:
npm package: @orsetra/karavan-core
Description: Apache Camel Karavan Core
Author: Marat Gubaidullin
Latest version: 4.14.3

# Karavan Core

Apache Camel Karavan Core library - Essential tools and APIs for working with Apache Camel integrations.

## Description

Karavan Core provides a comprehensive set of APIs and utilities for managing Apache Camel integrations, including:

- **CamelDefinitionApi**: Core API for working with Camel definitions
- **CamelDefinitionYaml**: YAML serialization/deserialization for Camel routes
- **ComponentApi**: Component metadata and management
- **KameletApi**: Kamelet (Camel K connectors) management
- **ProjectModelApi**: Project structure and configuration
- **TopologyUtils**: Integration topology analysis

## Installation

```bash
npm install karavan-core
```

## Usage

```typescript
import { CamelDefinitionApi } from 'karavan-core';

// Use the API to work with Camel definitions
const integration = CamelDefinitionApi.createIntegration();
```

### Importing specific modules

```typescript
// Import specific APIs
import { ComponentApi } from 'karavan-core/api/ComponentApi';
import { KameletApi } from 'karavan-core/api/KameletApi';

// Import models
import { Integration } from 'karavan-core/model/IntegrationDefinition';
```

## Features

- ✅ Full TypeScript support with type definitions
- ✅ ES Module format
- ✅ Comprehensive API for Camel integration management
- ✅ YAML serialization support
- ✅ Component and Kamelet metadata
- ✅ Project model management

## Requirements

- Node.js 14 or higher
- TypeScript 4.9+ (for development)

## License

Apache-2.0

## Repository

https://github.com/apache/camel-karavan

## Issues

https://github.com/apache/camel-karavan/issues

## Maintainers

- Marat Gubaidullin <marat.gubaidullin@gmail.com>