open-index/open-npm huggingface dataset:
npm package: @ingeloop-nucleus/api-client
Description: A strongly-typed TypeScript client for the Nucleus API, generated from the OpenAPI specification.
Latest version: 0.0.6

# @ingeloop-nucleus/api-client

A strongly-typed TypeScript client for the Nucleus API, generated from the OpenAPI specification.

This SDK provides:
- Fully typed request and response models
- A lightweight Axios-based HTTP implementation
- Simple client construction with Base URL + API Key
- Works in both Node.js and browser environments

---

## 📦 Installation

```bash
npm install @ingeloop-nucleus/api-client
```

---

## 🚀 Quick Start

```ts
import { NucleusApiClient } from "@ingeloop-nucleus/api-client";

const client = new NucleusApiClient(
  "https://your-nucleus-server.com",
  "YOUR_API_KEY"
);

const projects = await client.getProjects();
```

---

## 🔐 Authentication

Provide your API Key when instantiating the client:

```ts
const client = new NucleusApiClient(baseUrl, apiKey);
```

The key will be automatically injected into the request headers.

---

## 📚 Documentation

For full endpoint descriptions and schema details, consult the official API documentation:
**API Reference:** https://nucleusapp.co/docs

---

## 🧱 Project Structure

| File / Folder       | Purpose |
|---------------------|---------|
| `dist/`             | Compiled JavaScript and declaration files |
| `src/BaseApiClient.ts` | Generated API client |
| `src/NucleusApiClient.ts` | Custom wrapper for auth and request configuration |
| `src/HttpClient.ts` | Axios instance factory logic |

Only `NucleusApiClient` should be used directly by applications.

---

## 📝 License

Proprietary – internal or authorized customer usage only.