jtcsv 2.1.1 → 2.1.5

package/plugins/nextjs-api/README.md

@@ -1,452 +1,57 @@
 # @jtcsv/nextjs
 
-Next.js интеграция для JTCSV - API routes, React hooks и компоненты для конвертации CSV/JSON.
-
-## 📦 Установка
+Next.js helpers for JTCSV: API route handler, React hooks, and browser helpers.
 
+## Install
 ```bash
 npm install @jtcsv/nextjs jtcsv
-# или
-pnpm add @jtcsv/nextjs jtcsv
-# или
-yarn add @jtcsv/nextjs jtcsv
 ```
 
-## 🚀 Быстрый старт
-
-### 1. API Route
-
-Создайте файл `pages/api/convert.js`:
-
+## API route
 ```javascript
 // pages/api/convert.js
-import { handler } from '@jtcsv/nextjs/route';
+import handler from '@jtcsv/nextjs/route';
 
 export default handler;
-
-export const config = {
-  api: {
-    bodyParser: {
-      sizeLimit: '50mb'
-    }
-  }
-};
 ```
 
-### 2. React компонент
+Query options handled by the route:
+- format: json|csv
+- delimiter
+- includeHeaders
+- parseNumbers
+- parseBooleans
+- useFastPath
+- preventCsvInjection
 
+## React hook
 ```jsx
-// components/Converter.jsx
 'use client';
-
 import { useJtcsv } from '@jtcsv/nextjs';
 
 export default function Converter() {
-  const { 
-    convertCsvToJson, 
-    convertJsonToCsv, 
-    isLoading, 
-    error, 
-    result 
-  } = useJtcsv();
-  
-  const handleConvert = async () => {
-    const csv = 'name,age\nJohn,30\nJane,25';
-    const json = await convertCsvToJson(csv);
-    console.log('Converted:', json);
-  };
-  
-  return (
-    <div>
-      <button onClick={handleConvert} disabled={isLoading}>
-        {isLoading ? 'Converting...' : 'Convert CSV to JSON'}
-      </button>
-      {error && <div>Error: {error}</div>}
-      {result && <pre>{JSON.stringify(result, null, 2)}</pre>}
-    </div>
-  );
+  const { convertCsvToJson, convertJsonToCsv, isLoading, error, result } = useJtcsv();
+  return null;
 }
 ```
 
-## 📖 Документация
-
-### API Routes
-
-#### Автоматическая конвертация
-
+## Components and utilities
 ```javascript
-// pages/api/convert.js
-import { handler } from '@jtcsv/nextjs/route';
-
-export default handler;
-```
-
-**Примеры запросов:**
-
-```bash
-# JSON → CSV
-curl -X POST http://localhost:3000/api/convert \
-  -H "Content-Type: application/json" \
-  -d '[{"name":"John","age":30}]'
-
-# CSV → JSON
-curl -X POST http://localhost:3000/api/convert \
-  -H "Content-Type: text/csv" \
-  -d 'name,age\nJohn,30\nJane,25'
-
-# Специфичный формат вывода
-curl -X POST "http://localhost:3000/api/convert?format=csv" \
-  -H "Content-Type: application/json" \
-  -d '[{"name":"John","age":30}]'
+import {
+  CsvFileUploader,
+  downloadCsv,
+  createJtcsvApiClient,
+  JtcsvProvider,
+  useJtcsvContext
+} from '@jtcsv/nextjs';
 ```
 
-#### Специализированные handlers
-
+## Route helpers
 ```javascript
-// pages/api/convert/[...path].js
-import { 
+import {
   csvToJsonHandler,
   jsonToCsvHandler,
-  healthCheckHandler 
+  healthCheckHandler,
+  createJtcsvApiEndpoint
 } from '@jtcsv/nextjs/route';
-
-export default async function handler(req, res) {
-  const { path } = req.query;
-  
-  switch (path?.[0]) {
-    case 'csv-to-json':
-      return csvToJsonHandler(req, res);
-    case 'json-to-csv':
-      return jsonToCsvHandler(req, res);
-    case 'health':
-      return healthCheckHandler(req, res);
-    default:
-      res.status(404).json({ error: 'Not found' });
-  }
-}
-```
-
-### React Hooks
-
-#### useJtcsv
-
-```jsx
-import { useJtcsv } from '@jtcsv/nextjs';
-
-function Converter() {
-  const {
-    convertCsvToJson,
-    convertJsonToCsv,
-    isLoading,
-    error,
-    result,
-    stats,
-    reset
-  } = useJtcsv({
-    delimiter: ',',           // Разделитель CSV
-    parseNumbers: true,       // Парсить числа
-    parseBooleans: true,      // Парсить булевы значения
-    preventCsvInjection: true // Защита от инъекций
-  });
-  
-  // ...
-}
-```
-
-#### JtcsvProvider (Context)
-
-```jsx
-// app/layout.jsx
-import { JtcsvProvider } from '@jtcsv/nextjs';
-
-export default function Layout({ children }) {
-  return (
-    <JtcsvProvider options={{ delimiter: ',' }}>
-      {children}
-    </JtcsvProvider>
-  );
-}
-
-// components/Converter.jsx
-'use client';
-import { useJtcsvContext } from '@jtcsv/nextjs';
-
-export default function Converter() {
-  const { csvToJson, jsonToCsv } = useJtcsvContext();
-  // ...
-}
-```
-
-### Компоненты
-
-#### CsvFileUploader
-
-```jsx
-import { CsvFileUploader } from '@jtcsv/nextjs';
-
-function FileUpload() {
-  const handleConvert = (result, stats) => {
-    console.log('Converted:', result);
-    console.log('Stats:', stats);
-  };
-  
-  return (
-    <CsvFileUploader
-      onConvert={handleConvert}
-      options={{ delimiter: ',' }}
-    >
-      <button>📁 Upload CSV File</button>
-    </CsvFileUploader>
-  );
-}
-```
-
-### Утилиты
-
-#### downloadCsv
-
-```javascript
-import { downloadCsv } from '@jtcsv/nextjs';
-
-const data = [{ name: 'John', age: 30 }];
-await downloadCsv(data, 'users.csv', { delimiter: ',' });
-```
-
-#### createJtcsvApiClient
-
-```javascript
-import { createJtcsvApiClient } from '@jtcsv/nextjs';
-
-const api = createJtcsvApiClient('/api/convert');
-
-// Конвертация CSV в JSON
-const json = await api.csvToJson('name,age\nJohn,30');
-
-// Конвертация JSON в CSV
-const csv = await api.jsonToCsv([{ name: 'John', age: 30 }]);
-
-// Проверка здоровья
-const health = await api.health();
-```
-
-## 🔧 Конфигурация
-
-### Опции API Route
-
-| Параметр | Тип | По умолчанию | Описание |
-|----------|-----|--------------|----------|
-| `format` | `string` | `auto` | Формат вывода: `json`, `csv` |
-| `delimiter` | `string` | `','` | Разделитель CSV |
-| `includeHeaders` | `boolean` | `true` | Включать заголовки в CSV |
-| `parseNumbers` | `boolean` | `true` | Парсить числа |
-| `parseBooleans` | `boolean` | `true` | Парсить булевы значения |
-| `useFastPath` | `boolean` | `true` | Использовать Fast-Path Engine |
-| `preventCsvInjection` | `boolean` | `true` | Защита от CSV инъекций |
-
-### Опции React Hook
-
-```javascript
-const options = {
-  delimiter: ',',           // Разделитель CSV
-  includeHeaders: true,     // Включать заголовки
-  parseNumbers: true,       // Парсить числа
-  parseBooleans: true,      // Парсить булевы значения
-  useFastPath: true,        // Использовать Fast-Path Engine
-  preventCsvInjection: true,// Защита от инъекций
-  rfc4180Compliant: true    // Соответствие RFC 4180
-};
-```
-
-## 🌐 Примеры
-
-### Полный пример приложения
-
-Смотрите `examples/ConverterComponent.jsx` для полного примера React компонента.
-
-### Кастомная API Route
-
-```javascript
-// pages/api/convert/secure.js
-import { handler } from '@jtcsv/nextjs/route';
-
-export default async function secureHandler(req, res) {
-  // Проверка API ключа
-  const apiKey = req.headers['x-api-key'];
-  if (apiKey !== process.env.API_KEY) {
-    return res.status(401).json({ error: 'Unauthorized' });
-  }
-  
-  // Rate limiting
-  const ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress;
-  // ... ваша логика rate limiting
-  
-  // Логирование
-  console.log(`[${new Date().toISOString()}] ${req.method} ${req.url}`);
-  
-  // Вызов основного обработчика
-  return handler(req, res);
-}
-
-export const config = {
-  api: {
-    bodyParser: {
-      sizeLimit: '10mb'
-    }
-  }
-};
-```
-
-### Интеграция с формой
-
-```jsx
-'use client';
-import { useState } from 'react';
-import { useJtcsv, downloadCsv } from '@jtcsv/nextjs';
-
-export default function DataForm() {
-  const [data, setData] = useState([]);
-  const { convertJsonToCsv } = useJtcsv();
-  
-  const handleSubmit = async (e) => {
-    e.preventDefault();
-    
-    // Конвертируем данные в CSV
-    const csv = await convertJsonToCsv(data);
-    
-    // Скачиваем файл
-    await downloadCsv(data, 'form-data.csv');
-    
-    // Отправляем на сервер
-    await fetch('/api/submit', {
-      method: 'POST',
-      headers: { 'Content-Type': 'application/json' },
-      body: JSON.stringify({ csv, data })
-    });
-  };
-  
-  return (
-    <form onSubmit={handleSubmit}>
-      {/* поля формы */}
-      <button type="submit">Submit and Download CSV</button>
-    </form>
-  );
-}
-```
-
-## 🛡️ Безопасность
-
-### Защита от CSV инъекций
-
-Все конвертации по умолчанию защищены от CSV инъекций:
-
-```javascript
-// Опасные данные
-const dangerous = [{ formula: '=1+1', command: '@echo hello' }];
-
-// Безопасный CSV
-const safeCsv = await jsonToCsv(dangerous, { preventCsvInjection: true });
-// Результат: "'=1+1','@echo hello"
-```
-
-### Валидация размера
-
-```javascript
-// pages/api/convert.js
-export const config = {
-  api: {
-    bodyParser: {
-      sizeLimit: '10mb' // Ограничение размера
-    }
-  }
-};
-```
-
-## 📊 Мониторинг
-
-### Health Check
-
-```bash
-curl http://localhost:3000/api/convert/health
-```
-
-**Ответ:**
-```json
-{
-  "service": "jtcsv-nextjs-api",
-  "status": "healthy",
-  "version": "1.0.0",
-  "timestamp": "2026-01-23T10:30:00.000Z",
-  "features": {
-    "csvToJson": true,
-    "jsonToCsv": true,
-    "fastPathEngine": true,
-    "csvInjectionProtection": true,
-    "streaming": true,
-    "ndjson": true
-  }
-}
-```
-
-### Статистика
-
-Каждая операция возвращает статистику:
-
-```json
-{
-  "stats": {
-    "inputSize": 45,
-    "outputSize": 28,
-    "processingTime": 12,
-    "conversion": "json→csv",
-    "rows": 2
-  }
-}
-```
-
-## 🔌 TypeScript
-
-Полная поддержка TypeScript:
-
-```typescript
-import { 
-  useJtcsv, 
-  CsvFileUploader, 
-  type ConversionStats 
-} from '@jtcsv/nextjs';
-
-interface MyComponentProps {
-  onConvert: (result: any[], stats: ConversionStats) => void;
-}
-```
-
-## 🧪 Тестирование
-
-```bash
-# Запуск примеров
-cd plugins/nextjs-api/examples
-
-# Тестовые запросы к API
-curl -X POST http://localhost:3000/api/convert \
-  -H "Content-Type: application/json" \
-  -d '[{"test":"data"}]'
-```
-
-## 📄 Лицензия
-
-MIT
-
-## 🤝 Вклад в развитие
-
-1. Форкните репозиторий
-2. Создайте ветку для вашей функции
-3. Закоммитьте изменения
-4. Запушьте в ветку
-5. Откройте Pull Request
-
-## 📞 Поддержка
-
-- [Issues](https://github.com/Linol-Hamelton/jtcsv/issues)
-- [Discussions](https://github.com/Linol-Hamelton/jtcsv/discussions)
-- [Documentation](https://github.com/Linol-Hamelton/jtcsv#readme)
-
-
+```

package/plugins/nextjs-api/index.js

@@ -6,7 +6,7 @@
  * @date 2026-01-23
  */
 
-import { csvToJson, jsonToCsv } from 'jtcsv
+import { csvToJson, jsonToCsv } from 'jtcsv';
 
 export { csvToJson, jsonToCsv };
 
@@ -385,4 +385,3 @@ export function useJtcsvContext() {
 // Экспортируем все из route.js
 export * from './route';
 
-

package/plugins/nextjs-api/route.js

@@ -10,7 +10,7 @@
  * 2. Или импортируйте функции в существующие API routes
  */
 
-import { csvToJson, jsonToCsv } from 'jtcsv
+import { csvToJson, jsonToCsv } from 'jtcsv';
 
 /**
  * Конфигурация Next.js API route
@@ -369,4 +369,3 @@ export function createJtcsvApiEndpoint(options = {}) {
   };
 }
 
-

package/plugins/nuxt/README.md

@@ -0,0 +1,24 @@
+# @jtcsv/nuxt
+
+Nuxt module that injects `jtcsv` into the Nuxt app and provides a `useJtcsv` composable.
+
+## Install
+```bash
+npm install @jtcsv/nuxt jtcsv
+```
+
+## Nuxt config
+```typescript
+export default defineNuxtConfig({
+  modules: ['@jtcsv/nuxt'],
+  jtcsv: { autoimport: true }
+});
+```
+
+## Usage
+```vue
+<script setup>
+const jtcsv = useJtcsv();
+const csv = jtcsv.jsonToCsv([{ id: 1 }]);
+</script>
+```

package/plugins/nuxt/index.js

@@ -0,0 +1,21 @@
+const { defineNuxtModule, addPlugin, addImports, createResolver } = require('@nuxt/kit');
+
+module.exports = defineNuxtModule({
+  meta: {
+    name: '@jtcsv/nuxt',
+    configKey: 'jtcsv'
+  },
+  defaults: {
+    autoimport: true
+  },
+  setup(options) {
+    const resolver = createResolver(__dirname);
+    addPlugin(resolver.resolve('runtime/plugin'));
+
+    if (options.autoimport !== false) {
+      addImports([
+        { name: 'useJtcsv', from: resolver.resolve('runtime/composables/useJtcsv') }
+      ]);
+    }
+  }
+});

package/plugins/nuxt/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@jtcsv/nuxt",
+  "version": "1.0.0",
+  "description": "Nuxt module for JTCSV (auto-imported composable)",
+  "main": "index.js",
+  "keywords": [
+    "nuxt",
+    "module",
+    "csv",
+    "json",
+    "converter",
+    "jtcsv"
+  ],
+  "author": "Ruslan Fomenko",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Linol-Hamelton/jtcsv.git",
+    "directory": "plugins/nuxt"
+  },
+  "bugs": {
+    "url": "https://github.com/Linol-Hamelton/jtcsv/issues"
+  },
+  "homepage": "https://github.com/Linol-Hamelton/jtcsv/tree/main/plugins/nuxt#readme",
+  "peerDependencies": {
+    "@nuxt/kit": "^3.0.0",
+    "jtcsv": "^2.1.3",
+    "nuxt": "^3.0.0"
+  },
+  "files": [
+    "index.js",
+    "README.md",
+    "runtime/"
+  ]
+}

package/plugins/nuxt/runtime/composables/useJtcsv.js

@@ -0,0 +1,6 @@
+import { useNuxtApp } from '#app';
+
+export const useJtcsv = () => {
+  const { $jtcsv } = useNuxtApp();
+  return $jtcsv;
+};

package/plugins/nuxt/runtime/plugin.js

@@ -0,0 +1,6 @@
+import { defineNuxtPlugin } from '#app';
+import * as jtcsv from 'jtcsv';
+
+export default defineNuxtPlugin((nuxtApp) => {
+  nuxtApp.provide('jtcsv', jtcsv);
+});

package/plugins/remix/README.md

@@ -0,0 +1,26 @@
+# @jtcsv/remix
+
+Remix helpers for CSV form uploads and CSV responses.
+
+## Install
+```bash
+npm install @jtcsv/remix jtcsv
+```
+
+## Usage
+```javascript
+import { parseFormData, generateCsvResponse } from '@jtcsv/remix';
+
+export async function action({ request }) {
+  const rows = await parseFormData(request, { fieldName: 'file', delimiter: ',' });
+  return { rows };
+}
+
+export async function loader() {
+  return generateCsvResponse([{ id: 1 }], 'export.csv');
+}
+```
+
+## Exports
+- parseFormData
+- generateCsvResponse

package/plugins/remix/index.d.ts

@@ -0,0 +1,16 @@
+import type { CsvToJsonOptions, JsonToCsvOptions } from 'jtcsv';
+
+export interface RemixCsvParseOptions extends CsvToJsonOptions {
+  fieldName?: string;
+}
+
+export function parseFormData(
+  request: Request,
+  options?: RemixCsvParseOptions
+): Promise<unknown[]>;
+
+export function generateCsvResponse(
+  data: unknown[] | Record<string, unknown>,
+  filename?: string,
+  options?: JsonToCsvOptions
+): Response;