dragdropdo-sdk 1.0.0

package/dist/src/client.d.ts

@@ -0,0 +1,208 @@
+/**
+ * dragdropdo.com Business API Client
+ *
+ * A Node.js client library for interacting with the dragdropdo.com Business API.
+ * Provides methods for file uploads, operations, and status checking.
+ */
+import { DragdropdoConfig, UploadFileOptions, UploadResponse, SupportedOperationOptions, SupportedOperationResponse, OperationOptions, OperationResponse, StatusOptions, StatusResponse, PollStatusOptions } from "./types";
+export declare class Dragdropdo {
+    private apiKey;
+    private baseURL;
+    private timeout;
+    private axiosInstance;
+    /**
+     * Create a new DragDropDo Client instance
+     *
+     * @param config - Client configuration
+     * @example
+     * ```typescript
+     * const client = new Dragdropdo({
+     *   apiKey: 'your-api-key',
+     *   baseURL: 'https://dragdropdo.com',
+     *   timeout: 30000
+     * });
+     * ```
+     */
+    constructor(config: DragdropdoConfig);
+    /**
+     * Upload a file to D3 storage
+     *
+     * This method handles the complete upload flow:
+     * 1. Request presigned URLs from the API
+     * 2. Upload file parts to presigned URLs
+     * 3. Return the file key for use in operations
+     *
+     * @param options - Upload options
+     * @returns Promise resolving to upload response with file key
+     *
+     * @example
+     * ```typescript
+     * // Upload from file path
+     * const result = await client.uploadFile({
+     *   file: '/path/to/file.pdf',
+     *   fileName: 'document.pdf',
+     *   mimeType: 'application/pdf',
+     *   onProgress: (progress) => {
+     *     console.log(`Upload: ${progress.percentage}%`);
+     *   }
+     * });
+     * console.log('File key:', result.fileKey);
+     * ```
+     */
+    uploadFile(options: UploadFileOptions): Promise<UploadResponse>;
+    /**
+     * Check if an operation is supported for a file extension
+     *
+     * @param options - Supported operation options
+     * @returns Promise resolving to supported operation response
+     *
+     * @example
+     * ```typescript
+     * // Check all available actions for PDF
+     * const result = await client.checkSupportedOperation({
+     *   ext: 'pdf'
+     * });
+     * console.log('Available actions:', result.availableActions);
+     *
+     * // Check if convert to PNG is supported
+     * const result = await client.checkSupportedOperation({
+     *   ext: 'pdf',
+     *   action: 'convert',
+     *   parameters: { convert_to: 'png' }
+     * });
+     * console.log('Supported:', result.supported);
+     *
+     * // Get available compression levels
+     * const result = await client.checkSupportedOperation({
+     *   ext: 'pdf',
+     *   action: 'compress'
+     * });
+     * console.log('Compression levels:', result.parameters?.compression_value);
+     * ```
+     */
+    checkSupportedOperation(options: SupportedOperationOptions): Promise<SupportedOperationResponse>;
+    /**
+     * Create a file operation (convert, compress, merge, zip, etc.)
+     *
+     * @param options - Operation options
+     * @returns Promise resolving to operation response with main task ID
+     *
+     * @example
+     * ```typescript
+     * // Convert PDF to PNG
+     * const result = await client.createOperation({
+     *   action: 'convert',
+     *   fileKeys: ['file-key-123'],
+     *   parameters: { convert_to: 'png' }
+     * });
+     *
+     * // Compress PDF
+     * const result = await client.createOperation({
+     *   action: 'compress',
+     *   fileKeys: ['file-key-123'],
+     *   parameters: { compression_value: 'recommended' }
+     * });
+     *
+     * // Merge multiple PDFs
+     * const result = await client.createOperation({
+     *   action: 'merge',
+     *   fileKeys: ['file-key-1', 'file-key-2', 'file-key-3']
+     * });
+     *
+     * // Lock PDF with password
+     * const result = await client.createOperation({
+     *   action: 'lock',
+     *   fileKeys: ['file-key-123'],
+     *   parameters: { password: 'secure-password' }
+     * });
+     * ```
+     */
+    createOperation(options: OperationOptions): Promise<OperationResponse>;
+    /**
+     * Convenience methods for specific operations
+     */
+    /**
+     * Convert files to a different format
+     */
+    convert(fileKeys: string[], convertTo: string, notes?: Record<string, string>): Promise<OperationResponse>;
+    /**
+     * Compress files
+     */
+    compress(fileKeys: string[], compressionValue?: string, notes?: Record<string, string>): Promise<OperationResponse>;
+    /**
+     * Merge multiple files
+     */
+    merge(fileKeys: string[], notes?: Record<string, string>): Promise<OperationResponse>;
+    /**
+     * Create a ZIP archive from files
+     */
+    zip(fileKeys: string[], notes?: Record<string, string>): Promise<OperationResponse>;
+    /**
+     * Share files (generate shareable links)
+     */
+    share(fileKeys: string[], notes?: Record<string, string>): Promise<OperationResponse>;
+    /**
+     * Lock PDF with password
+     */
+    lockPdf(fileKeys: string[], password: string, notes?: Record<string, string>): Promise<OperationResponse>;
+    /**
+     * Unlock PDF with password
+     */
+    unlockPdf(fileKeys: string[], password: string, notes?: Record<string, string>): Promise<OperationResponse>;
+    /**
+     * Reset PDF password
+     */
+    resetPdfPassword(fileKeys: string[], oldPassword: string, newPassword: string, notes?: Record<string, string>): Promise<OperationResponse>;
+    /**
+     * Get operation status
+     *
+     * @param options - Status options
+     * @returns Promise resolving to status response
+     *
+     * @example
+     * ```typescript
+     * // Get main task status
+     * const status = await client.getStatus({
+     *   mainTaskId: 'task-123'
+     * });
+     *
+     * // Get specific file task status
+     * const status = await client.getStatus({
+     *   mainTaskId: 'task-123',
+     *   fileTaskId: 'file-task-456'
+     * });
+     * ```
+     */
+    getStatus(options: StatusOptions): Promise<StatusResponse>;
+    /**
+     * Poll operation status until completion or failure
+     *
+     * @param options - Poll status options
+     * @returns Promise resolving to final status response
+     *
+     * @example
+     * ```typescript
+     * const status = await client.pollStatus({
+     *   mainTaskId: 'task-123',
+     *   interval: 2000, // Check every 2 seconds
+     *   timeout: 300000, // 5 minutes max
+     *   onUpdate: (status) => {
+     *     console.log('Status:', status.operationStatus);
+     *   }
+     * });
+     *
+     * if (status.operationStatus === 'completed') {
+     *   console.log('Download links:', status.filesData.map(f => f.downloadLink));
+     * }
+     * ```
+     */
+    pollStatus(options: PollStatusOptions): Promise<StatusResponse>;
+    /**
+     * Convert snake_case object keys to camelCase
+     */
+    private toCamelCase;
+    /**
+     * Get MIME type from file extension
+     */
+    private getMimeType;
+}