@juspay/neurolink 9.1.1 → 9.3.0

package/dist/processors/config/sizeLimits.js

@@ -0,0 +1,246 @@
+/**
+ * Size Limit Constants
+ * Centralized size limits for file processing and validation
+ *
+ * @module processors/config/sizeLimits
+ */
+// =============================================================================
+// FILE SIZE LIMITS (in MB)
+// =============================================================================
+/**
+ * Maximum file sizes in megabytes for different file types
+ */
+export const SIZE_LIMITS_MB = {
+    /** Maximum image file size (10MB) */
+    IMAGE_MAX_MB: 10,
+    /** Maximum PDF file size (20MB) */
+    PDF_MAX_MB: 20,
+    /** Maximum document file size (10MB) */
+    DOCUMENT_MAX_MB: 10,
+    /** Maximum Word document size (10MB) */
+    WORD_MAX_MB: 10,
+    /** Maximum text file size (5MB) */
+    TEXT_MAX_MB: 5,
+    /** Maximum CSV file size (10MB) */
+    CSV_MAX_MB: 10,
+    /** Maximum Excel file size (10MB) */
+    EXCEL_MAX_MB: 10,
+    /** Maximum source code file size (5MB) */
+    SOURCE_CODE_MAX_MB: 5,
+    /** Maximum JSON file size (5MB) */
+    JSON_MAX_MB: 5,
+    /** Maximum YAML file size (5MB) */
+    YAML_MAX_MB: 5,
+    /** Maximum XML file size (5MB) */
+    XML_MAX_MB: 5,
+    /** Maximum general file size (50MB) */
+    GENERAL_MAX_MB: 50,
+};
+// =============================================================================
+// FILE SIZE LIMITS (in bytes)
+// =============================================================================
+/**
+ * Maximum file sizes in bytes for different file types
+ */
+export const SIZE_LIMITS_BYTES = {
+    /** Maximum image file size (10MB) */
+    IMAGE_MAX: 10 * 1024 * 1024,
+    /** Maximum PDF file size (20MB) */
+    PDF_MAX: 20 * 1024 * 1024,
+    /** Maximum document file size (10MB) */
+    DOCUMENT_MAX: 10 * 1024 * 1024,
+    /** Maximum Word document size (10MB) */
+    WORD_MAX: 10 * 1024 * 1024,
+    /** Maximum text file size (5MB) */
+    TEXT_MAX: 5 * 1024 * 1024,
+    /** Maximum CSV file size (10MB) */
+    CSV_MAX: 10 * 1024 * 1024,
+    /** Maximum Excel file size (10MB) */
+    EXCEL_MAX: 10 * 1024 * 1024,
+    /** Maximum source code file size (5MB) */
+    SOURCE_CODE_MAX: 5 * 1024 * 1024,
+    /** Maximum JSON file size (5MB) */
+    JSON_MAX: 5 * 1024 * 1024,
+    /** Maximum YAML file size (5MB) */
+    YAML_MAX: 5 * 1024 * 1024,
+    /** Maximum XML file size (5MB) */
+    XML_MAX: 5 * 1024 * 1024,
+    /** Maximum general file size (50MB) */
+    GENERAL_MAX: 50 * 1024 * 1024,
+};
+// =============================================================================
+// PROCESSING LIMITS
+// =============================================================================
+/**
+ * Processing limits for different content types
+ */
+export const PROCESSING_LIMITS = {
+    /** Maximum lines for source code files */
+    MAX_SOURCE_CODE_LINES: 10000,
+    /** Maximum lines for text files */
+    MAX_TEXT_LINES: 10000,
+    /** Maximum characters for text extraction */
+    MAX_TEXT_LENGTH: 1000000,
+    /** Maximum rows for CSV files */
+    MAX_CSV_ROWS: 10000,
+    /** Maximum rows per Excel sheet */
+    MAX_EXCEL_ROWS: 5000,
+    /** Maximum sheets to process in Excel */
+    MAX_EXCEL_SHEETS: 10,
+    /** Maximum pages for PDF files */
+    MAX_PDF_PAGES: 100,
+    /** Maximum depth for JSON/YAML objects */
+    MAX_OBJECT_DEPTH: 50,
+    /** Maximum array length in JSON/YAML */
+    MAX_ARRAY_LENGTH: 10000,
+};
+// =============================================================================
+// ARCHIVE LIMITS (Security)
+// =============================================================================
+/**
+ * Security limits for archive processing (ZIP bomb protection)
+ */
+export const ARCHIVE_LIMITS = {
+    /** Maximum decompressed size (100MB) */
+    MAX_DECOMPRESSED_SIZE: 100 * 1024 * 1024,
+    /** Maximum compression ratio (100:1) */
+    MAX_COMPRESSION_RATIO: 100,
+    /** Maximum entries in archive */
+    MAX_ENTRIES: 1000,
+    /** Maximum nesting depth */
+    MAX_NESTING_DEPTH: 5,
+};
+// =============================================================================
+// YAML SECURITY LIMITS
+// =============================================================================
+/**
+ * Security limits for YAML processing (billion laughs protection)
+ */
+export const YAML_LIMITS = {
+    /** Maximum alias expansion count */
+    MAX_ALIAS_COUNT: 100,
+    /** Maximum document count in multi-doc YAML */
+    MAX_DOCUMENTS: 10,
+    /** Maximum anchor references */
+    MAX_ANCHORS: 100,
+};
+// =============================================================================
+// COMBINED SIZE LIMITS
+// =============================================================================
+/**
+ * All size limits combined for backward compatibility
+ */
+export const SIZE_LIMITS = {
+    // MB limits
+    IMAGE_MAX_MB: SIZE_LIMITS_MB.IMAGE_MAX_MB,
+    PDF_MAX_MB: SIZE_LIMITS_MB.PDF_MAX_MB,
+    DOCUMENT_MAX_MB: SIZE_LIMITS_MB.DOCUMENT_MAX_MB,
+    WORD_MAX_MB: SIZE_LIMITS_MB.WORD_MAX_MB,
+    TEXT_MAX_MB: SIZE_LIMITS_MB.TEXT_MAX_MB,
+    CSV_MAX_MB: SIZE_LIMITS_MB.CSV_MAX_MB,
+    EXCEL_MAX_MB: SIZE_LIMITS_MB.EXCEL_MAX_MB,
+    SOURCE_CODE_MAX_MB: SIZE_LIMITS_MB.SOURCE_CODE_MAX_MB,
+    // Byte limits
+    MAX_FILE_SIZE: SIZE_LIMITS_BYTES.GENERAL_MAX,
+    MAX_IMAGE_SIZE: SIZE_LIMITS_BYTES.IMAGE_MAX,
+    MAX_TEXT_SIZE: SIZE_LIMITS_BYTES.TEXT_MAX,
+    // Processing limits
+    MAX_SOURCE_CODE_LINES: PROCESSING_LIMITS.MAX_SOURCE_CODE_LINES,
+    MAX_TEXT_LINES: PROCESSING_LIMITS.MAX_TEXT_LINES,
+    MAX_TEXT_LENGTH: PROCESSING_LIMITS.MAX_TEXT_LENGTH,
+    MAX_CSV_ROWS: PROCESSING_LIMITS.MAX_CSV_ROWS,
+    EXCEL_MAX_ROWS: PROCESSING_LIMITS.MAX_EXCEL_ROWS,
+    EXCEL_MAX_SHEETS: PROCESSING_LIMITS.MAX_EXCEL_SHEETS,
+    MAX_PDF_PAGES: PROCESSING_LIMITS.MAX_PDF_PAGES,
+    // Archive limits
+    MAX_DECOMPRESSED_SIZE: ARCHIVE_LIMITS.MAX_DECOMPRESSED_SIZE,
+    MAX_COMPRESSION_RATIO: ARCHIVE_LIMITS.MAX_COMPRESSION_RATIO,
+    MAX_ZIP_ENTRIES: ARCHIVE_LIMITS.MAX_ENTRIES,
+    // YAML limits
+    YAML_MAX_ALIAS_COUNT: YAML_LIMITS.MAX_ALIAS_COUNT,
+};
+// =============================================================================
+// UTILITY FUNCTIONS
+// =============================================================================
+/**
+ * Converts bytes to megabytes
+ *
+ * @param bytes - Size in bytes
+ * @returns Size in megabytes
+ */
+export function bytesToMB(bytes) {
+    return bytes / (1024 * 1024);
+}
+/**
+ * Converts megabytes to bytes
+ *
+ * @param mb - Size in megabytes
+ * @returns Size in bytes
+ */
+export function mbToBytes(mb) {
+    return mb * 1024 * 1024;
+}
+/**
+ * Formats bytes to human-readable string
+ *
+ * @param bytes - Size in bytes
+ * @param precision - Decimal places (default: 2)
+ * @returns Formatted string like "1.5 MB" or "500 KB"
+ */
+export function formatBytes(bytes, precision = 2) {
+    if (bytes === 0) {
+        return "0 Bytes";
+    }
+    const k = 1024;
+    const sizes = ["Bytes", "KB", "MB", "GB", "TB"];
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+    return `${parseFloat((bytes / k ** i).toFixed(precision))} ${sizes[i]}`;
+}
+/**
+ * Checks if a file size is within the specified limit
+ *
+ * @param sizeInBytes - File size in bytes
+ * @param limitKey - Key from SIZE_LIMITS_BYTES
+ * @returns True if the file size is within the limit
+ */
+export function isWithinSizeLimit(sizeInBytes, limitKey) {
+    return sizeInBytes <= SIZE_LIMITS_BYTES[limitKey];
+}
+/**
+ * Gets the appropriate size limit for a file type
+ *
+ * @param fileType - Type of file (image, pdf, document, etc.)
+ * @returns Size limit in bytes
+ */
+export function getSizeLimitForType(fileType) {
+    const limitMap = {
+        image: SIZE_LIMITS_BYTES.IMAGE_MAX,
+        pdf: SIZE_LIMITS_BYTES.PDF_MAX,
+        document: SIZE_LIMITS_BYTES.DOCUMENT_MAX,
+        text: SIZE_LIMITS_BYTES.TEXT_MAX,
+        csv: SIZE_LIMITS_BYTES.CSV_MAX,
+        excel: SIZE_LIMITS_BYTES.EXCEL_MAX,
+        code: SIZE_LIMITS_BYTES.SOURCE_CODE_MAX,
+        json: SIZE_LIMITS_BYTES.JSON_MAX,
+        yaml: SIZE_LIMITS_BYTES.YAML_MAX,
+        xml: SIZE_LIMITS_BYTES.XML_MAX,
+    };
+    return limitMap[fileType] || SIZE_LIMITS_BYTES.GENERAL_MAX;
+}
+/**
+ * Validates file size against the appropriate limit
+ *
+ * @param sizeInBytes - File size in bytes
+ * @param fileType - Type of file
+ * @returns Object with isValid flag and error message if invalid
+ */
+export function validateFileSize(sizeInBytes, fileType) {
+    const limit = getSizeLimitForType(fileType);
+    if (sizeInBytes <= limit) {
+        return { isValid: true };
+    }
+    return {
+        isValid: false,
+        error: `File size (${formatBytes(sizeInBytes)}) exceeds the maximum allowed size of ${formatBytes(limit)} for ${fileType} files.`,
+    };
+}

package/dist/processors/data/JsonProcessor.d.ts

@@ -0,0 +1,122 @@
+/**
+ * JSON Processing Utility
+ *
+ * Handles downloading, validating, and processing JSON files.
+ * Provides parsed JSON content with validation and metadata extraction.
+ *
+ * Features:
+ * - JSON syntax validation
+ * - Pretty-printing for valid JSON
+ * - Metadata extraction (key count, array length)
+ * - Graceful error handling with detailed messages
+ *
+ * @module processors/data/JsonProcessor
+ *
+ * @example
+ * ```typescript
+ * import { jsonProcessor, isJsonFile, processJson } from "./JsonProcessor.js";
+ *
+ * // Check if file is JSON
+ * if (isJsonFile("application/json", "config.json")) {
+ *   // Process the file
+ *   const result = await processJson(fileInfo);
+ *   if (result.success && result.data) {
+ *     console.log("Parsed JSON:", result.data.parsed);
+ *     console.log("Pretty-printed:", result.data.content);
+ *   }
+ * }
+ * ```
+ */
+import { BaseFileProcessor } from "../base/BaseFileProcessor.js";
+import type { FileInfo, FileProcessingResult, ProcessOptions } from "../base/types.js";
+export type { ProcessedJson } from "../base/types.js";
+import type { ProcessedJson } from "../base/types.js";
+/**
+ * JSON file processor.
+ * Extends BaseFileProcessor with JSON-specific parsing and validation.
+ *
+ * @example
+ * ```typescript
+ * const processor = new JsonProcessor();
+ *
+ * const result = await processor.processFile({
+ *   id: "file-123",
+ *   name: "config.json",
+ *   mimetype: "application/json",
+ *   size: 1024,
+ *   buffer: jsonBuffer,
+ * });
+ *
+ * if (result.success && result.data?.valid) {
+ *   console.log("JSON keys:", result.data.keyCount);
+ * }
+ * ```
+ */
+export declare class JsonProcessor extends BaseFileProcessor<ProcessedJson> {
+    constructor();
+    /**
+     * Validate downloaded JSON is parseable.
+     *
+     * @param buffer - Downloaded file content
+     * @param _fileInfo - Original file information
+     * @returns null if valid, error message if invalid
+     */
+    protected validateDownloadedFile(buffer: Buffer, _fileInfo: FileInfo): Promise<string | null>;
+    /**
+     * Build processed JSON result with parsed content.
+     *
+     * @param buffer - Downloaded file content
+     * @param fileInfo - Original file information
+     * @returns Processed JSON result
+     */
+    protected buildProcessedResult(buffer: Buffer, fileInfo: FileInfo): ProcessedJson;
+}
+/** Singleton JSON processor instance */
+export declare const jsonProcessor: JsonProcessor;
+/**
+ * Check if a file is a JSON file based on MIME type or extension.
+ *
+ * @param mimetype - MIME type of the file
+ * @param filename - Filename (for extension-based detection)
+ * @returns true if the file is a JSON file
+ *
+ * @example
+ * ```typescript
+ * if (isJsonFile("application/json", "config.json")) {
+ *   // Process as JSON
+ * }
+ * ```
+ */
+export declare function isJsonFile(mimetype: string, filename: string): boolean;
+/**
+ * Validate JSON file size against configured limit.
+ *
+ * @param sizeBytes - File size in bytes
+ * @returns true if size is within the limit
+ */
+export declare function validateJsonSize(sizeBytes: number): boolean;
+/**
+ * Process a single JSON file.
+ *
+ * @param fileInfo - File information (with URL or buffer)
+ * @param options - Optional processing options (auth headers, timeout, retry config)
+ * @returns Processing result with parsed JSON or error
+ *
+ * @example
+ * ```typescript
+ * const result = await processJson({
+ *   id: "file-123",
+ *   name: "data.json",
+ *   mimetype: "application/json",
+ *   size: 2048,
+ *   url: "https://example.com/data.json",
+ * }, {
+ *   authHeaders: { "Authorization": "Bearer token" },
+ * });
+ *
+ * if (result.success && result.data) {
+ *   console.log("Parsed:", result.data.parsed);
+ * }
+ * ```
+ */
+export declare function processJson(fileInfo: FileInfo, options?: ProcessOptions): Promise<FileProcessingResult<ProcessedJson>>;

package/dist/processors/data/JsonProcessor.js

@@ -0,0 +1,203 @@
+/**
+ * JSON Processing Utility
+ *
+ * Handles downloading, validating, and processing JSON files.
+ * Provides parsed JSON content with validation and metadata extraction.
+ *
+ * Features:
+ * - JSON syntax validation
+ * - Pretty-printing for valid JSON
+ * - Metadata extraction (key count, array length)
+ * - Graceful error handling with detailed messages
+ *
+ * @module processors/data/JsonProcessor
+ *
+ * @example
+ * ```typescript
+ * import { jsonProcessor, isJsonFile, processJson } from "./JsonProcessor.js";
+ *
+ * // Check if file is JSON
+ * if (isJsonFile("application/json", "config.json")) {
+ *   // Process the file
+ *   const result = await processJson(fileInfo);
+ *   if (result.success && result.data) {
+ *     console.log("Parsed JSON:", result.data.parsed);
+ *     console.log("Pretty-printed:", result.data.content);
+ *   }
+ * }
+ * ```
+ */
+import { BaseFileProcessor } from "../base/BaseFileProcessor.js";
+import { SIZE_LIMITS_MB } from "../config/index.js";
+// =============================================================================
+// CONSTANTS
+// =============================================================================
+/** Supported JSON MIME types */
+const SUPPORTED_JSON_TYPES = ["application/json", "text/json"];
+/** Supported JSON file extensions */
+const SUPPORTED_JSON_EXTENSIONS = [".json"];
+// =============================================================================
+// JSON PROCESSOR CLASS
+// =============================================================================
+/**
+ * JSON file processor.
+ * Extends BaseFileProcessor with JSON-specific parsing and validation.
+ *
+ * @example
+ * ```typescript
+ * const processor = new JsonProcessor();
+ *
+ * const result = await processor.processFile({
+ *   id: "file-123",
+ *   name: "config.json",
+ *   mimetype: "application/json",
+ *   size: 1024,
+ *   buffer: jsonBuffer,
+ * });
+ *
+ * if (result.success && result.data?.valid) {
+ *   console.log("JSON keys:", result.data.keyCount);
+ * }
+ * ```
+ */
+export class JsonProcessor extends BaseFileProcessor {
+    constructor() {
+        super({
+            maxSizeMB: SIZE_LIMITS_MB.JSON_MAX_MB,
+            timeoutMs: 30000,
+            supportedMimeTypes: SUPPORTED_JSON_TYPES,
+            supportedExtensions: SUPPORTED_JSON_EXTENSIONS,
+            fileTypeName: "JSON",
+            defaultFilename: "data.json",
+        });
+    }
+    /**
+     * Validate downloaded JSON is parseable.
+     *
+     * @param buffer - Downloaded file content
+     * @param _fileInfo - Original file information
+     * @returns null if valid, error message if invalid
+     */
+    async validateDownloadedFile(buffer, _fileInfo) {
+        try {
+            const content = buffer.toString("utf-8");
+            JSON.parse(content);
+            return null;
+        }
+        catch (error) {
+            return `Invalid JSON file: ${error instanceof Error ? error.message : "Parse error"}`;
+        }
+    }
+    /**
+     * Build processed JSON result with parsed content.
+     *
+     * @param buffer - Downloaded file content
+     * @param fileInfo - Original file information
+     * @returns Processed JSON result
+     */
+    buildProcessedResult(buffer, fileInfo) {
+        const rawContent = buffer.toString("utf-8");
+        let parsed = null;
+        let valid = true;
+        let errorMessage;
+        let keyCount;
+        let arrayLength;
+        let content;
+        try {
+            parsed = JSON.parse(rawContent);
+            // Extract metadata based on parsed type
+            if (typeof parsed === "object" && parsed !== null) {
+                if (Array.isArray(parsed)) {
+                    arrayLength = parsed.length;
+                }
+                else {
+                    keyCount = Object.keys(parsed).length;
+                }
+            }
+            // Pretty print valid JSON
+            content = JSON.stringify(parsed, null, 2);
+        }
+        catch (error) {
+            // This shouldn't happen since we validate, but handle gracefully
+            valid = false;
+            errorMessage = error instanceof Error ? error.message : "Invalid JSON";
+            content = rawContent;
+        }
+        return {
+            content,
+            rawContent,
+            parsed,
+            valid,
+            errorMessage,
+            keyCount,
+            arrayLength,
+            truncated: false,
+            buffer,
+            mimetype: fileInfo.mimetype || "application/json",
+            size: fileInfo.size,
+            filename: this.getFilename(fileInfo),
+        };
+    }
+}
+// =============================================================================
+// SINGLETON INSTANCE
+// =============================================================================
+/** Singleton JSON processor instance */
+export const jsonProcessor = new JsonProcessor();
+// =============================================================================
+// UTILITY FUNCTIONS
+// =============================================================================
+/**
+ * Check if a file is a JSON file based on MIME type or extension.
+ *
+ * @param mimetype - MIME type of the file
+ * @param filename - Filename (for extension-based detection)
+ * @returns true if the file is a JSON file
+ *
+ * @example
+ * ```typescript
+ * if (isJsonFile("application/json", "config.json")) {
+ *   // Process as JSON
+ * }
+ * ```
+ */
+export function isJsonFile(mimetype, filename) {
+    return jsonProcessor.isFileSupported(mimetype, filename);
+}
+/**
+ * Validate JSON file size against configured limit.
+ *
+ * @param sizeBytes - File size in bytes
+ * @returns true if size is within the limit
+ */
+export function validateJsonSize(sizeBytes) {
+    const maxBytes = SIZE_LIMITS_MB.JSON_MAX_MB * 1024 * 1024;
+    return sizeBytes <= maxBytes;
+}
+/**
+ * Process a single JSON file.
+ *
+ * @param fileInfo - File information (with URL or buffer)
+ * @param options - Optional processing options (auth headers, timeout, retry config)
+ * @returns Processing result with parsed JSON or error
+ *
+ * @example
+ * ```typescript
+ * const result = await processJson({
+ *   id: "file-123",
+ *   name: "data.json",
+ *   mimetype: "application/json",
+ *   size: 2048,
+ *   url: "https://example.com/data.json",
+ * }, {
+ *   authHeaders: { "Authorization": "Bearer token" },
+ * });
+ *
+ * if (result.success && result.data) {
+ *   console.log("Parsed:", result.data.parsed);
+ * }
+ * ```
+ */
+export function processJson(fileInfo, options) {
+    return jsonProcessor.processFile(fileInfo, options);
+}