@ptkl/sdk 0.10.2 → 1.0.0

package/dist/v0.9/integrations/dms.d.ts

@@ -0,0 +1,469 @@
+import IntegrationsBaseClient from "../integrationsBaseClient";
+import { AxiosResponse } from "axios";
+import { PDFFillOptions, DataConversionParams, DataValidationParams, DataInfoParams, DataInfo, DataValidationResult, ConversionOptions, HTML2PDFOptions, PDF2HTMLOptions, MediaUploadPayload, MediaUploadBase64Payload, DocumentListParams, DocumentListResponse, DocumentCreatePayload, DocumentUpdatePayload, DocumentRestorePayload, DocumentCommentPayload, DocumentResponse } from "../types/integrations";
+/**
+ * Document Management System (DMS) API client
+ *
+ * Provides comprehensive document and media management capabilities including:
+ * - File upload, download, and management
+ * - PDF generation and form filling
+ * - Data conversion between JSON, CSV, and Excel formats
+ * - Media processing and EXIF data extraction
+ *
+ * ## Data Conversion Features
+ *
+ * The DMS class includes powerful data conversion capabilities that allow you to:
+ * - Convert between JSON, CSV, and Excel (.xlsx) formats
+ * - Handle structured data with header, items, and footer sections
+ * - Auto-detect structured patterns in JSON arrays
+ * - Validate data format integrity
+ * - Analyze data structure and metadata
+ * - Handle large datasets with memory-efficient processing
+ *
+ * ### Supported Formats
+ * - **JSON**: Array of objects (recommended for tabular data) or structured objects
+ * - **CSV**: Comma-separated values with headers and optional comments
+ * - **Excel**: .xlsx format with optional sheet specification
+ *
+ * ### Structured Data Support
+ * When converting from JSON, the API supports:
+ *
+ * **Explicit Structure**: JSON with dedicated sections
+ * ```json
+ * {
+ *   "header": { "content": { "title": "Report" } },
+ *   "items": [{ "name": "Data" }],
+ *   "footer": { "content": { "total": 100 } }
+ * }
+ * ```
+ *
+ * **Auto-Detection**: Mixed arrays with metadata and summary objects
+ * ```json
+ * [
+ *   { "metadata": "Header info" },
+ *   { "name": "John", "age": 30 },
+ *   { "summary": "Footer info" }
+ * ]
+ * ```
+ *
+ * ### Error Handling
+ * All conversion methods may throw errors with code 3003 for conversion failures.
+ * Always wrap calls in try-catch blocks for production use.
+ *
+ * @example
+ * ```typescript
+ * import { DMS } from 'protokol-sdk';
+ *
+ * const dms = new DMS({
+ *   token: 'your-bearer-token',
+ *   host: 'http://localhost:8086'
+ * });
+ *
+ * const libraryRef = 'your-library-uuid';
+ *
+ * // Convert structured JSON to CSV with comments
+ * const structuredData = {
+ *   header: { content: { title: "Sales Report" } },
+ *   items: [{ product: "Widget", sales: 100 }],
+ *   footer: { content: { total: 100 } }
+ * };
+ *
+ * try {
+ *   const csvResult = await dms.convertData(libraryRef, structuredData, {
+ *     from: 'json',
+ *     to: 'csv',
+ *     header_as_comment: true
+ *   });
+ *   console.log(csvResult.data); // CSV with header as comments
+ * } catch (error) {
+ *   console.error('Conversion failed:', error.message);
+ * }
+ * ```
+ */
+export default class DMS extends IntegrationsBaseClient {
+    list(data: any): Promise<AxiosResponse<any, any>>;
+    libraries(): Promise<AxiosResponse<any, any>>;
+    /**
+     * Upload files using multipart form data
+     *
+     * @param payload - Upload configuration with files, directory, and options
+     * @returns Upload response from the server
+     *
+     * @example
+     * ```typescript
+     * const result = await dms.upload({
+     *   files: [file1, file2],
+     *   uploadDir: '/documents/invoices',
+     *   public: true,
+     *   replace: true,
+     *   metadata: { category: 'finance' }
+     * });
+     * ```
+     */
+    upload(payload: MediaUploadPayload): Promise<AxiosResponse<any, any> | undefined>;
+    delete(data: any): Promise<AxiosResponse<any, any>>;
+    /**
+     * Upload files using base64-encoded content
+     *
+     * @param data - Upload payload with base64-encoded files
+     * @returns Upload response from the server
+     *
+     * @example
+     * ```typescript
+     * const result = await dms.uploadBase64({
+     *   path: '/documents/reports',
+     *   is_public: false,
+     *   replace: true,
+     *   files: [
+     *     {
+     *       name: 'report.pdf',
+     *       content_type: 'application/pdf',
+     *       data: 'base64EncodedContent...'
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    uploadBase64(data: MediaUploadBase64Payload): Promise<AxiosResponse<any, any>>;
+    getMedia(key: string, encoding: string): Promise<AxiosResponse<any, any>>;
+    download(key: string): Promise<AxiosResponse<any, any>>;
+    getExifData(key: string): Promise<AxiosResponse<any, any>>;
+    html2pdf(data: HTML2PDFOptions): Promise<AxiosResponse<any, any>>;
+    pdf2html(data: PDF2HTMLOptions): Promise<AxiosResponse<any, any>>;
+    createDir(path: string): Promise<AxiosResponse<any, any>>;
+    deleteDir(path: string): Promise<AxiosResponse<any, any>>;
+    dirs(data: string): Promise<AxiosResponse<any, any>>;
+    createDocument(payload: DocumentCreatePayload): Promise<AxiosResponse<DocumentResponse>>;
+    getDocument(path: string): Promise<AxiosResponse<DocumentResponse>>;
+    getDocumentRaw(path: string): Promise<AxiosResponse<any, any>>;
+    updateDocument(payload: DocumentUpdatePayload): Promise<AxiosResponse<DocumentResponse>>;
+    deleteDocument(path: string): Promise<AxiosResponse<any, any>>;
+    listDocuments(params?: DocumentListParams): Promise<AxiosResponse<DocumentListResponse>>;
+    listDeletedDocuments(params?: DocumentListParams): Promise<AxiosResponse<DocumentListResponse>>;
+    restoreDocument(payload: DocumentRestorePayload): Promise<AxiosResponse<DocumentResponse>>;
+    createDocumentComment(payload: DocumentCommentPayload): Promise<AxiosResponse<any, any>>;
+    fillPdf(data: PDFFillOptions): Promise<AxiosResponse<any, any>>;
+    /**
+     * Convert data between different formats (JSON, CSV, Excel)
+     *
+     * Supports structured data when converting from JSON format with:
+     * - Explicit structure: JSON with `header`, `items`, and `footer` properties
+     * - Auto-detection: Mixed JSON arrays with metadata objects and summary rows
+     *
+     * @param lib - Library reference UUID
+     * @param data - Raw data to convert
+     * @param params - Conversion parameters including structured data options
+     * @returns Promise resolving to converted data
+     *
+     * @example
+     * ```typescript
+     * // Convert JSON to CSV
+     * const jsonData = [
+     *   { name: "John Doe", age: 30, email: "john@example.com" },
+     *   { name: "Jane Smith", age: 25, email: "jane@example.com" }
+     * ];
+     *
+     * const csvResult = await dms.convertData(libraryRef, jsonData, {
+     *   from: 'json',
+     *   to: 'csv'
+     * });
+     * console.log(csvResult.data); // CSV string
+     *
+     * // Convert structured JSON with header as comments
+     * const structuredData = {
+     *   header: {
+     *     content: {
+     *       report_title: "Monthly Sales Report",
+     *       generated_by: "Sales System"
+     *     }
+     *   },
+     *   items: [
+     *     { product: "Widget A", sales: 100 },
+     *     { product: "Widget B", sales: 150 }
+     *   ],
+     *   footer: {
+     *     content: {
+     *       total_sales: 250
+     *     }
+     *   }
+     * };
+     *
+     * const csvWithComments = await dms.convertData(libraryRef, structuredData, {
+     *   from: 'json',
+     *   to: 'csv',
+     *   header_as_comment: true,
+     *   separator_rows: 2
+     * });
+     *
+     * // Convert JSON to Excel with custom sheet name
+     * const excelResult = await dms.convertData(libraryRef, jsonData, {
+     *   from: 'json',
+     *   to: 'excel',
+     *   sheet_name: 'Customer Data'
+     * });
+     * // excelResult.data is a Blob
+     * ```
+     */
+    convertData(data: any, params: DataConversionParams): Promise<AxiosResponse<any>>;
+    /**
+     * Get information about data format and structure
+     *
+     * @param lib - Library reference UUID
+     * @param data - Raw data to analyze
+     * @param params - Analysis parameters
+     * @returns Promise resolving to data information
+     *
+     * @example
+     * ```typescript
+     * const jsonData = [
+     *   { name: "John", age: 30, email: "john@example.com" },
+     *   { name: "Jane", age: 25, email: "jane@example.com" }
+     * ];
+     *
+     * const dataInfo = await dms.getDataInfo(libraryRef, jsonData, {
+     *   format: 'json'
+     * });
+     *
+     * console.log(dataInfo.data);
+     * // Output:
+     * // {
+     * //   format: "json",
+     * //   size_bytes: 245,
+     * //   record_count: 2,
+     * //   field_count: 3,
+     * //   fields: ["name", "age", "email"],
+     * //   library_ref: "98bee1cb-0f21-4582-a832-7c32b4b61831"
+     * // }
+     * ```
+     */
+    getDataInfo(data: any, params: DataInfoParams): Promise<AxiosResponse<DataInfo>>;
+    /**
+     * Validate data format without performing conversion
+     *
+     * @param lib - Library reference UUID
+     * @param data - Raw data to validate
+     * @param params - Validation parameters
+     * @returns Promise resolving to validation result
+     *
+     * @example
+     * ```typescript
+     * const jsonData = [{ name: "John", age: 30 }];
+     *
+     * const validation = await dms.validateData(libraryRef, jsonData, {
+     *   format: 'json'
+     * });
+     *
+     * console.log(validation.data);
+     * // Output:
+     * // {
+     * //   valid: true,
+     * //   message: "Data is valid JSON format",
+     * //   library_ref: "98bee1cb-0f21-4582-a832-7c32b4b61831"
+     * // }
+     *
+     * // Handle invalid data
+     * try {
+     *   const invalidValidation = await dms.validateData(libraryRef, "invalid json", {
+     *     format: 'json'
+     *   });
+     * } catch (error) {
+     *   console.error('Validation failed:', error.response?.data?.message);
+     * }
+     * ```
+     */
+    validateData(data: any, params: DataValidationParams): Promise<AxiosResponse<DataValidationResult>>;
+    /**
+     * Convert JSON data to CSV format
+     *
+     * This method supports both regular JSON arrays and structured data with auto-detection:
+     * - Regular arrays are converted directly to CSV
+     * - Structured data (with metadata objects) is automatically detected and formatted
+     *
+     * @param lib - Library reference UUID
+     * @param jsonData - JSON data (array of objects or structured data)
+     * @returns Promise resolving to CSV string
+     *
+     * @example
+     * ```typescript
+     * // Regular JSON to CSV
+     * const jsonData = [
+     *   { name: "John Doe", age: 30, email: "john@example.com" },
+     *   { name: "Jane Smith", age: 25, email: "jane@example.com" }
+     * ];
+     *
+     * const csvResponse = await dms.jsonToCsv(libraryRef, jsonData);
+     * console.log(csvResponse.data);
+     * // Output:
+     * // name,age,email
+     * // John Doe,30,john@example.com
+     * // Jane Smith,25,jane@example.com
+     *
+     * // Structured JSON with auto-detection
+     * const structuredData = [
+     *   { metadata: "EMPLOYEE REPORT\nGenerated: 2025-10-08" },
+     *   { name: "John Doe", age: 30, position: "Developer" },
+     *   { name: "Jane Smith", age: 25, position: "Designer" },
+     *   { name: "Total Employees:", age: null, position: "2 people" }
+     * ];
+     *
+     * const structuredCsv = await dms.jsonToCsv(libraryRef, structuredData);
+     * // Auto-detects header, items, and footer sections
+     * ```
+     */
+    jsonToCsv(jsonData: any, options?: ConversionOptions): Promise<AxiosResponse<string>>;
+    /**
+     * Convert JSON data to Excel (.xlsx) format
+     *
+     * Supports both regular JSON arrays and structured data patterns.
+     * Excel files are always generated with .xlsx extension.
+     *
+     * @param lib - Library reference UUID
+     * @param jsonData - JSON data (array of objects or structured data)
+     * @param options - Optional conversion options
+     * @returns Promise resolving to Excel file as Blob
+     *
+     * @example
+     * ```typescript
+     * // Regular JSON to Excel
+     * const jsonData = [
+     *   { name: "John Doe", age: 30, email: "john@example.com" },
+     *   { name: "Jane Smith", age: 25, email: "jane@example.com" }
+     * ];
+     *
+     * // Basic conversion
+     * const excelResponse = await dms.jsonToExcel(libraryRef, jsonData);
+     * const blob = excelResponse.data; // Blob for download
+     *
+     * // With custom sheet name
+     * const excelWithOptions = await dms.jsonToExcel(libraryRef, jsonData, {
+     *   sheet_name: 'Customer Data'
+     * });
+     *
+     * // Structured data with explicit sections
+     * const structuredData = {
+     *   header: { content: { title: "Monthly Report" } },
+     *   items: [{ product: "Widget A", sales: 100 }],
+     *   footer: { content: { total_sales: 100 } }
+     * };
+     *
+     * const structuredExcel = await dms.jsonToExcel(libraryRef, structuredData);
+     *
+     * // Create download link
+     * const url = URL.createObjectURL(structuredExcel.data);
+     * const link = document.createElement('a');
+     * link.href = url;
+     * link.download = 'report.xlsx'; // Always .xlsx extension
+     * link.click();
+     * ```
+     */
+    jsonToExcel(jsonData: any, options?: ConversionOptions): Promise<AxiosResponse<Blob>>;
+    /**
+     * Convert CSV data to JSON format
+     *
+     * @param lib - Library reference UUID
+     * @param csvData - CSV data string (with headers in first row)
+     * @returns Promise resolving to JSON array
+     *
+     * @example
+     * ```typescript
+     * const csvString = `name,age,email
+     * John Doe,30,john@example.com
+     * Jane Smith,25,jane@example.com`;
+     *
+     * const jsonResponse = await dms.csvToJson(libraryRef, csvString);
+     * console.log(jsonResponse.data);
+     * // Output:
+     * // [
+     * //   { name: "John Doe", age: "30", email: "john@example.com" },
+     * //   { name: "Jane Smith", age: "25", email: "jane@example.com" }
+     * // ]
+     * ```
+     */
+    csvToJson(csvData: string): Promise<AxiosResponse<any[]>>;
+    /**
+     * Convert CSV data to Excel (.xlsx) format
+     *
+     * @param lib - Library reference UUID
+     * @param csvData - CSV data string (with headers in first row)
+     * @param options - Optional conversion options
+     * @returns Promise resolving to Excel file as Blob
+     *
+     * @example
+     * ```typescript
+     * const csvString = `name,age,email
+     * John Doe,30,john@example.com
+     * Jane Smith,25,jane@example.com`;
+     *
+     * const excelResponse = await dms.csvToExcel(libraryRef, csvString, {
+     *   sheet_name: 'Imported Data'
+     * });
+     *
+     * // Handle the Excel blob
+     * const blob = excelResponse.data;
+     * const url = URL.createObjectURL(blob);
+     * // Use url for download or further processing
+     * ```
+     */
+    csvToExcel(csvData: string, options?: ConversionOptions): Promise<AxiosResponse<Blob>>;
+    /**
+     * Convert Excel (.xlsx) data to JSON format
+     *
+     * @param lib - Library reference UUID
+     * @param excelData - Excel file data as Blob or ArrayBuffer
+     * @param options - Optional conversion options
+     * @returns Promise resolving to JSON array
+     *
+     * @example
+     * ```typescript
+     * // From file input
+     * const fileInput = document.querySelector('input[type="file"]');
+     * const file = fileInput.files[0]; // Excel file
+     *
+     * const jsonResponse = await dms.excelToJson(libraryRef, file, {
+     *   sheet_name: 'Sheet1' // optional, defaults to first sheet
+     * });
+     *
+     * console.log(jsonResponse.data);
+     * // Output: JSON array with data from Excel sheet
+     *
+     * // From ArrayBuffer
+     * const arrayBuffer = await file.arrayBuffer();
+     * const jsonFromBuffer = await dms.excelToJson(libraryRef, arrayBuffer);
+     * ```
+     */
+    excelToJson(excelData: Blob | ArrayBuffer, options?: ConversionOptions): Promise<AxiosResponse<any[]>>;
+    /**
+     * Convert Excel (.xlsx) data to CSV format
+     *
+     * @param lib - Library reference UUID
+     * @param excelData - Excel file data as Blob or ArrayBuffer
+     * @param options - Optional conversion options
+     * @returns Promise resolving to CSV string
+     *
+     * @example
+     * ```typescript
+     * // From file input
+     * const fileInput = document.querySelector('input[type="file"]');
+     * const file = fileInput.files[0]; // Excel file
+     *
+     * const csvResponse = await dms.excelToCsv(libraryRef, file, {
+     *   sheet_name: 'Data' // optional, defaults to first sheet
+     * });
+     *
+     * console.log(csvResponse.data);
+     * // Output: CSV string with data from Excel sheet
+     *
+     * // Save as CSV file
+     * const csvBlob = new Blob([csvResponse.data], { type: 'text/csv' });
+     * const url = URL.createObjectURL(csvBlob);
+     * const link = document.createElement('a');
+     * link.href = url;
+     * link.download = 'converted.csv';
+     * link.click();
+     * ```
+     */
+    excelToCsv(excelData: Blob | ArrayBuffer, options?: ConversionOptions): Promise<AxiosResponse<string>>;
+    request(method: string, endpoint: string, params?: any): Promise<AxiosResponse<any, any>>;
+    requestv2(method: string, endpoint: string, params?: any): Promise<AxiosResponse<any, any>>;
+    requestv1(method: string, endpoint: string, params?: any): Promise<AxiosResponse<any, any>>;
+}

package/dist/v0.9/integrations/invoicing.d.ts

@@ -0,0 +1,6 @@
+import PlatformBaseClient from "../platformBaseClient";
+export default class Invoicing extends PlatformBaseClient {
+    getSalesInvoices(provider: string, page: number): Promise<import("axios").AxiosResponse<any, any>>;
+    acceptPurchaseInvoice(provider: string, id: string, comment: string): Promise<import("axios").AxiosResponse<any, any>>;
+    request(method: string, endpoint: string, params: any): Promise<import("axios").AxiosResponse<any, any>>;
+}