@nexim/upload-types/README.md

TypeScript types and interfaces for Nexim Media Upload Service, including image preset configurations and file handling types

# @nexim/upload-types

![NPM Version](https://img.shields.io/npm/v/@nexim/upload-types)
![npm bundle size](https://img.shields.io/bundlephobia/min/@nexim/upload-types)
![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg)
![NPM Downloads](https://img.shields.io/npm/dm/@nexim/upload-types)
![NPM License](https://img.shields.io/npm/l/@nexim/upload-types)

## Overview

`@nexim/upload-types` provides TypeScript type definitions and interfaces for the Nexim Media Upload ecosystem. It includes types for image preset configurations, file handling, and common interfaces used across the SDK and service.

## Features

- 📝 TypeScript type definitions
- 🎯 Image preset configurations
- 📦 File handling types
- 🔄 State machine types
- 🛠️ Utility types

## Installation

```sh
npm install @nexim/upload-types

# Or using yarn
yarn add @nexim/upload-types
```

## Usage

```typescript
import type { FileDetail, UploadImagePreset } from '@nexim/upload-types';

// Use preset types
const preset: UploadImagePreset = {
  format: 'webp',
  width: 800,
  quality: 80,
};

// Work with file details
const fileInfo: FileDetail = {
  name: 'image.jpg',
  size: 1024,
  type: 'image/jpeg',
};
```

## Documentation

For detailed type documentation and definitions, please refer to the [documentation](./docs/README.md).

## License

This project is licensed under the [AGPL-3.0 License](LICENSE).