jtcsv 2.1.3 → 2.2.2

package/plugins/README.md

@@ -1,17 +1,35 @@
-# JTCSV Плагины и Интеграции
-
-Пакеты интеграций JTCSV с популярными фреймворками и платформами.
-
-## 📦 Доступные плагины
-
-### 1. Express Middleware (@jtcsv/express-middleware)
-
-**Express middleware для автоматической конвертации CSV/JSON в HTTP запросах.**
-
+# JTCSV framework integrations
+
+This folder contains optional adapters published as separate packages. Each adapter depends on `jtcsv`.
+
+## Available packages
+- @jtcsv/express-middleware
+- @jtcsv/fastify
+- @jtcsv/nextjs
+- @jtcsv/nestjs
+- @jtcsv/remix
+- @jtcsv/nuxt
+- @jtcsv/sveltekit
+- @jtcsv/hono
+- @jtcsv/trpc
+
+## Main package shortcuts
+If you already depend on `jtcsv`, the adapters are also exported from the main package:
+- jtcsv/express
+- jtcsv/fastify
+- jtcsv/nextjs
+- jtcsv/nextjs/route
+- jtcsv/nestjs
+- jtcsv/remix
+- jtcsv/nuxt
+- jtcsv/sveltekit
+- jtcsv/hono
+- jtcsv/trpc
+
+## Express
 ```bash
 npm install @jtcsv/express-middleware express jtcsv
 ```
-
 ```javascript
 const express = require('express');
 const { middleware } = require('@jtcsv/express-middleware');
@@ -20,498 +38,54 @@ const app = express();
 app.use(express.json());
 app.use(express.text({ type: 'text/csv' }));
 app.use(middleware());
-
-app.post('/api/convert', (req, res) => {
-  res.json({
-    data: req.converted.data,
-    format: req.converted.format,
-    stats: req.converted.stats
-  });
-});
 ```
 
-[📚 Документация](./express-middleware/README.md)
-
-### 2. Fastify Plugin (@jtcsv/fastify)
-
-**Fastify plugin для автоматической конвертации CSV/JSON.**
-
+## Fastify
 ```bash
 npm install @jtcsv/fastify fastify fastify-plugin jtcsv
 ```
-
 ```javascript
 const fastify = require('fastify')();
-
-await fastify.register(require('@jtcsv/fastify'), {
-  prefix: '/api/convert'
-});
-
-// Доступ через fastify.jtcsv
-const csv = await fastify.jtcsv.jsonToCsv([{ name: 'John' }]);
+await fastify.register(require('@jtcsv/fastify'), { prefix: '/api' });
 ```
 
-[📚 Документация](./fastify-plugin/README.md)
-
-### 3. Next.js Integration (@jtcsv/nextjs)
-
-**Next.js интеграция - API routes, React hooks и компоненты.**
-
+## Next.js
 ```bash
 npm install @jtcsv/nextjs jtcsv
 ```
-
-```jsx
-// pages/api/convert.js
-import { handler } from '@jtcsv/nextjs/route';
+```javascript
+import handler from '@jtcsv/nextjs/route';
 export default handler;
-
-// components/Converter.jsx
-'use client';
-import { useJtcsv } from '@jtcsv/nextjs';
-
-export default function Converter() {
-  const { convertCsvToJson } = useJtcsv();
-  // ...
-}
 ```
 
-[📚 Документация](./nextjs-api/README.md)
-
-### 4. NestJS Integration (@jtcsv/nestjs)
-
-**NestJS interceptors and decorators for CSV upload/download.**
-
+## NestJS
 ```bash
 npm install @jtcsv/nestjs jtcsv
 ```
 
-```typescript
-import { CsvParserInterceptor, CsvDownloadDecorator } from 'jtcsv/nestjs';
-
-@Controller('data')
-export class DataController {
-  @Post('upload')
-  @CsvParserInterceptor({ delimiter: ',' })
-  uploadCsv(@Body() jsonData: any[]) {
-    return { parsed: jsonData };
-  }
-
-  @Get('export')
-  @CsvDownloadDecorator({ filename: 'export.csv' })
-  exportData() {
-    return [{ id: 1, name: 'John' }];
-  }
-}
-```
-
-[📚 Документация](./nestjs/README.md)
-
-### 5. Remix Integration (@jtcsv/remix)
-
-**Helpers for form-data parsing and CSV downloads in Remix.**
-
+## Remix
 ```bash
 npm install @jtcsv/remix jtcsv
 ```
 
-```typescript
-import { parseFormData, generateCsvResponse } from 'jtcsv/remix';
-
-export async function action({ request }) {
-  const rows = await parseFormData(request, { delimiter: ',' });
-  return { parsed: rows };
-}
-
-export async function loader() {
-  return generateCsvResponse([{ id: 1, name: 'John' }], 'export.csv');
-}
-```
-
-[📚 Документация](./remix/README.md)
-
-### 6. Nuxt Integration (@jtcsv/nuxt)
-
-**Nuxt module with auto-imported composable.**
-
+## Nuxt
 ```bash
 npm install @jtcsv/nuxt jtcsv
 ```
 
-```typescript
-export default defineNuxtConfig({
-  modules: ['@jtcsv/nuxt'],
-  jtcsv: { autoimport: true }
-});
-```
-
-```vue
-<script setup>
-const { csvToJson, jsonToCsv } = useJtcsv();
-</script>
-```
-
-[📚 Документация](./nuxt/README.md)
-
-### 7. SvelteKit Integration (@jtcsv/sveltekit)
-
-**Request helpers for SvelteKit actions/endpoints.**
-
+## SvelteKit
 ```bash
 npm install @jtcsv/sveltekit jtcsv
 ```
 
-```typescript
-import { parseCsv, generateCsv } from 'jtcsv/sveltekit';
-
-export const actions = {
-  upload: async ({ request }) => {
-    const rows = await parseCsv(request, { delimiter: ',' });
-    return { rows };
-  }
-};
-
-export async function GET() {
-  return generateCsv([{ id: 1 }], 'export.csv');
-}
-```
-
-[📚 Документация](./sveltekit/README.md)
-
-### 8. Hono Integration (@jtcsv/hono)
-
-**Minimal middleware for CSV parsing with Hono.**
-
+## Hono
 ```bash
 npm install @jtcsv/hono jtcsv
 ```
 
-```typescript
-import { Hono } from 'hono';
-import { csvMiddleware, createCsvResponse } from 'jtcsv/hono';
-
-const app = new Hono()
-  .use('/upload', csvMiddleware())
-  .post('/upload', (c) => c.json({ rows: c.get('csv') }))
-  .get('/export', (c) => {
-    const { csv, headers } = createCsvResponse([{ id: 1 }], 'export.csv');
-    return c.text(csv, 200, headers);
-  });
-```
-
-[📚 Документация](./hono/README.md)
-
-### 9. tRPC Integration (@jtcsv/trpc)
-
-**Middleware helper for CSV input parsing in tRPC procedures.**
-
+## tRPC
 ```bash
 npm install @jtcsv/trpc jtcsv
 ```
 
-```typescript
-import { initTRPC } from '@trpc/server';
-import { z } from 'zod';
-import { createCsvProcedure } from 'jtcsv/trpc';
-
-const t = initTRPC.create();
-
-export const router = t.router({
-  parseCsv: createCsvProcedure(t, z.string())
-    .mutation(async ({ input }) => ({ parsed: input }))
-});
-```
-
-[📚 Документация](./trpc/README.md)
-
-## 🎯 Особенности
-
-### Единый API
-
-Все плагины предоставляют согласованный API:
-
-```javascript
-// Express
-app.use(jtcsvMiddleware({ delimiter: ',' }));
-
-// Fastify  
-await fastify.register(jtcsvPlugin, { delimiter: ',' });
-
-// Next.js
-const { convertCsvToJson } = useJtcsv({ delimiter: ',' });
-```
-
-### Автоматическое определение формата
-
-- Определение по Content-Type заголовку
-- Автоматическое определение по содержимому
-- Поддержка query параметров для ручного указания
-
-### Безопасность
-
-- Защита от CSV инъекций (по умолчанию включена)
-- Валидация размера запросов
-- RFC 4180 compliance
-
-### Производительность
-
-- Fast-Path Engine для оптимизации
-- Streaming поддержка для больших файлов
-- Кеширование парсеров
-
-## 🔧 Конфигурация
-
-### Общие опции
-
-| Опция | Тип | По умолчанию | Описание |
-|-------|-----|--------------|----------|
-| `delimiter` | `string` | `','` | Разделитель CSV |
-| `preventCsvInjection` | `boolean` | `true` | Защита от CSV инъекций |
-| `rfc4180Compliant` | `boolean` | `true` | Соответствие RFC 4180 |
-| `useFastPath` | `boolean` | `true` | Использовать Fast-Path Engine |
-
-### Специфичные опции
-
-#### Express Middleware
-
-```javascript
-{
-  maxSize: '10mb',      // Максимальный размер тела запроса
-  autoDetect: true      // Автоматическое определение формата
-}
-```
-
-#### Fastify Plugin
-
-```javascript
-{
-  prefix: '/convert'    // Префикс для routes
-}
-```
-
-#### Next.js Integration
-
-```javascript
-{
-  parseNumbers: true,   // Парсить числа
-  parseBooleans: true   // Парсить булевы значения
-}
-```
-
-## 🌐 Примеры использования
-
-### REST API
-
-```bash
-# JSON → CSV
-curl -X POST https://api.example.com/convert \
-  -H "Content-Type: application/json" \
-  -d '[{"name":"John","age":30}]'
-
-# CSV → JSON  
-curl -X POST https://api.example.com/convert \
-  -H "Content-Type: text/csv" \
-  -d 'name,age\nJohn,30\nJane,25'
-```
-
-### Web Application
-
-```jsx
-// React/Next.js компонент
-function DataExporter({ data }) {
-  const { convertJsonToCsv } = useJtcsv();
-  
-  const handleExport = async () => {
-    const csv = await convertJsonToCsv(data);
-    downloadCsv(csv, 'export.csv');
-  };
-  
-  return (
-    <button onClick={handleExport}>
-      Export as CSV
-    </button>
-  );
-}
-```
-
-### Backend Service
-
-```javascript
-// Express приложение для обработки загрузок
-app.post('/api/upload', upload.single('file'), async (req, res) => {
-  const csv = req.file.buffer.toString();
-  const json = await csvToJson(csv);
-  
-  // Сохранение в базу данных
-  await db.insert('data', json);
-  
-  res.json({ success: true, rows: json.length });
-});
-```
-
-## 📊 Мониторинг и Health Check
-
-Все плагины предоставляют health check endpoints:
-
-```bash
-# Express
-GET /api/health
-
-# Fastify
-GET /convert/health
-
-# Next.js
-GET /api/convert/health
-```
-
-**Пример ответа:**
-```json
-{
-  "service": "jtcsv-integration",
-  "status": "healthy",
-  "version": "1.0.0",
-  "features": {
-    "csvToJson": true,
-    "jsonToCsv": true,
-    "fastPathEngine": true,
-    "csvInjectionProtection": true
-  }
-}
-```
-
-## 🔌 Расширяемость
-
-### Кастомные middleware
-
-```javascript
-// Express
-app.use((req, res, next) => {
-  // Логирование
-  console.log(`[${new Date()}] ${req.method} ${req.url}`);
-  
-  // Rate limiting
-  // ...
-  
-  next();
-});
-
-app.use(jtcsvMiddleware());
-```
-
-### Плагины JTCSV
-
-Все интеграции совместимы с plugin system JTCSV:
-
-```javascript
-const jtcsv = require('jtcsv;
-
-jtcsv.use('my-plugin', {
-  hooks: {
-    'before:csvToJson': (csv) => {
-      // Кастомная обработка
-      return csv;
-    }
-  }
-});
-```
-
-## 🚀 Производительность
-
-### Бенчмарки
-
-| Операция | Без плагина | С плагином | Ускорение |
-|----------|-------------|------------|-----------|
-| CSV → JSON (10k rows) | 120ms | 45ms | 2.7x |
-| JSON → CSV (10k rows) | 85ms | 32ms | 2.7x |
-| File Upload (1MB) | 210ms | 95ms | 2.2x |
-
-### Оптимизации
-
-1. **Fast-Path Engine** - автоматический выбор оптимального парсера
-2. **Streaming** - обработка больших файлов без загрузки в память
-3. **Кеширование** - кеширование скомпилированных парсеров
-4. **Пакетная обработка** - оптимизация для bulk операций
-
-## 🔐 Безопасность
-
-### Защитные механизмы
-
-1. **CSV Injection Protection** - экранирование опасных символов
-2. **Size Limits** - ограничение размера запросов
-3. **Input Validation** - валидация входных данных
-4. **Error Handling** - безопасная обработка ошибок
-
-### Рекомендации
-
-```javascript
-// Production конфигурация
-app.use(jtcsvMiddleware({
-  maxSize: '10mb',
-  preventCsvInjection: true,
-  rfc4180Compliant: true
-}));
-
-// Rate limiting
-app.use(rateLimit({
-  windowMs: 15 * 60 * 1000,
-  max: 100
-}));
-```
-
-## 📚 Документация
-
-- [Express Middleware](./express-middleware/README.md)
-- [Fastify Plugin](./fastify-plugin/README.md)
-- [Next.js Integration](./nextjs-api/README.md)
-- [Основная документация JTCSV](../README.md)
-
-## 🧪 Тестирование
-
-```bash
-# Тестирование всех плагинов
-cd plugins
-npm test
-
-# Тестирование конкретного плагина
-cd express-middleware
-npm test
-
-# Запуск примеров
-cd nextjs-api/examples
-node api-convert.js
-```
-
-## 🤝 Вклад в развитие
-
-Мы приветствуем вклады в развитие плагинов!
-
-### Как помочь
-
-1. **Сообщить о баге** - создайте issue с подробным описанием
-2. **Предложить улучшение** - обсудите в Discussions
-3. **Создать pull request** - реализуйте новую функцию
-4. **Улучшить документацию** - помогите другим разработчикам
-
-### Руководство по разработке
-
-1. Клонируйте репозиторий
-2. Установите зависимости: `npm install`
-3. Создайте ветку: `git checkout -b feature/amazing`
-4. Внесите изменения и протестируйте
-5. Запушьте изменения: `git push origin feature/amazing`
-6. Откройте Pull Request
-
-## 📞 Поддержка
-
-- **Issues**: [GitHub Issues](https://github.com/Linol-Hamelton/jtcsv/issues)
-- **Discussions**: [GitHub Discussions](https://github.com/Linol-Hamelton/jtcsv/discussions)
-- **Documentation**: [Основная документация](../README.md)
-- **Email**: [Указать email если есть]
-
-## 📄 Лицензия
-
-Все плагины распространяются под лицензией MIT. См. файл [LICENSE](../LICENSE) для подробностей.
-
----
-
-**JTCSV Плагины** - делаем работу с CSV/JSON проще в любом фреймворке! 🚀
+See each package README in this folder for API details.