@varity-labs/sdk 2.0.0-alpha.1

package/dist/modules/export/ExportModule.js

@@ -0,0 +1,432 @@
+/**
+ * ExportModule - Universal data export and report generation
+ *
+ * Provides flexible export capabilities for any data source with multiple
+ * format options. Works across all templates by reading from template-specific
+ * data sources.
+ */
+export class ExportModule {
+    constructor(sdk) {
+        this.sdk = sdk;
+    }
+    /**
+     * Export data to CSV format
+     *
+     * Universal method - exports any data source to CSV.
+     * Template configuration determines available data sources.
+     *
+     * @example ISO Dashboard
+     * ```typescript
+     * const csv = await sdk.export.toCSV({
+     *   dataSource: 'merchants',
+     *   startDate: '2025-01-01',
+     *   endDate: '2025-01-31',
+     *   columns: ['merchantId', 'businessName', 'status', 'totalVolume'],
+     *   delimiter: ','
+     * })
+     * ```
+     *
+     * @example Healthcare Dashboard
+     * ```typescript
+     * const csv = await sdk.export.toCSV({
+     *   dataSource: 'patients',
+     *   filters: { status: 'active' },
+     *   columns: ['patientId', 'name', 'lastVisit']
+     * })
+     * ```
+     */
+    async toCSV(options) {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/csv`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            },
+            body: JSON.stringify({ ...options, format: 'csv' })
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to export to CSV: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    /**
+     * Export data to JSON format
+     *
+     * Universal method - exports any data source to JSON.
+     *
+     * @example
+     * ```typescript
+     * const json = await sdk.export.toJSON({
+     *   dataSource: 'transactions',
+     *   startDate: '2025-01-01',
+     *   endDate: '2025-01-31',
+     *   pretty: true,
+     *   indent: 2
+     * })
+     * ```
+     */
+    async toJSON(options) {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/json`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            },
+            body: JSON.stringify({ ...options, format: 'json' })
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to export to JSON: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    /**
+     * Export data to Excel (XLSX) format
+     *
+     * Universal method - exports any data source to Excel with formatting.
+     *
+     * @example
+     * ```typescript
+     * const xlsx = await sdk.export.toExcel({
+     *   dataSource: 'merchants',
+     *   columns: ['merchantId', 'businessName', 'totalVolume'],
+     *   fileName: 'merchants_report_2025-01.xlsx'
+     * })
+     * ```
+     */
+    async toExcel(options) {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/xlsx`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            },
+            body: JSON.stringify({ ...options, format: 'xlsx' })
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to export to Excel: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    /**
+     * Generate PDF report
+     *
+     * Universal method - generates formatted PDF reports using templates.
+     * Template configuration provides report templates.
+     *
+     * @example ISO Dashboard
+     * ```typescript
+     * const report = await sdk.export.generateReport({
+     *   template: 'monthly_summary',
+     *   format: 'pdf',
+     *   period: '2025-01',
+     *   includeCharts: true
+     * })
+     * ```
+     *
+     * @example Healthcare Dashboard
+     * ```typescript
+     * const report = await sdk.export.generateReport({
+     *   template: 'patient_outcomes_report',
+     *   format: 'pdf',
+     *   period: 'Q1 2025',
+     *   data: { departmentId: 'cardiology' }
+     * })
+     * ```
+     */
+    async generateReport(options) {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/report`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            },
+            body: JSON.stringify(options)
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to generate report: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    /**
+     * Download previously exported file
+     *
+     * Universal method - downloads an export file by ID.
+     *
+     * @example
+     * ```typescript
+     * const file = await sdk.export.downloadFile({
+     *   fileId: 'export-123',
+     *   fileName: 'custom_name.csv'
+     * })
+     * ```
+     */
+    async downloadFile(options) {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/download/${options.fileId}`, {
+            method: 'GET',
+            headers: {
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            }
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to download file: ${response.statusText}`);
+        }
+        return await response.blob();
+    }
+    /**
+     * Get export file URL for direct download
+     *
+     * Universal method - returns a downloadable URL for an export.
+     */
+    async getDownloadUrl(fileId) {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/download-url/${fileId}`, {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            }
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to get download URL: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    /**
+     * Export multiple data sources in bulk (creates ZIP file)
+     *
+     * Universal method - exports multiple data sources and packages them in ZIP.
+     *
+     * @example
+     * ```typescript
+     * const bulk = await sdk.export.bulkExport({
+     *   exports: [
+     *     { dataSource: 'merchants', format: 'csv' },
+     *     { dataSource: 'transactions', format: 'csv' },
+     *     { dataSource: 'residuals', format: 'xlsx' }
+     *   ],
+     *   zipFileName: 'iso_data_export_2025-01.zip'
+     * })
+     * ```
+     */
+    async bulkExport(options) {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/bulk`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            },
+            body: JSON.stringify(options)
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to perform bulk export: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    /**
+     * List available data sources for export
+     *
+     * Universal method - returns available data sources based on template.
+     */
+    async listDataSources() {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/data-sources`, {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            }
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to list data sources: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    /**
+     * Create reusable export template
+     *
+     * Universal method - creates a saved export configuration.
+     *
+     * @example
+     * ```typescript
+     * const template = await sdk.export.createTemplate({
+     *   name: 'active_merchants_monthly',
+     *   description: 'Export active merchants for monthly review',
+     *   dataSource: 'merchants',
+     *   columns: ['merchantId', 'businessName', 'status', 'totalVolume'],
+     *   defaultFilters: { status: 'ACTIVE' },
+     *   format: 'csv'
+     * })
+     * ```
+     */
+    async createTemplate(template) {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/templates`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            },
+            body: JSON.stringify(template)
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to create export template: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    /**
+     * Export using saved template
+     *
+     * Universal method - runs an export using a saved template.
+     */
+    async exportFromTemplate(templateName, overrides) {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/templates/${templateName}/execute`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            },
+            body: JSON.stringify(overrides || {})
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to export from template: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    /**
+     * List export templates
+     *
+     * Universal method - lists all saved export templates.
+     */
+    async listTemplates() {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/templates`, {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            }
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to list export templates: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    /**
+     * Schedule recurring export
+     *
+     * Universal method - schedules automatic exports.
+     *
+     * @example
+     * ```typescript
+     * const scheduled = await sdk.export.scheduleExport({
+     *   dataSource: 'transactions',
+     *   format: 'csv',
+     *   schedule: {
+     *     frequency: 'monthly',
+     *     dayOfMonth: 1,
+     *     time: '09:00'
+     *   },
+     *   recipients: ['finance@example.com'],
+     *   enabled: true
+     * })
+     * ```
+     */
+    async scheduleExport(options) {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/scheduled`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            },
+            body: JSON.stringify(options)
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to schedule export: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    /**
+     * List scheduled exports
+     *
+     * Universal method - lists all scheduled exports.
+     */
+    async listScheduledExports() {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/scheduled`, {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            }
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to list scheduled exports: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+    /**
+     * Cancel scheduled export
+     *
+     * Universal method - cancels a scheduled export.
+     */
+    async cancelScheduledExport(exportId) {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const response = await fetch(`${apiEndpoint}/api/v1/export/scheduled/${exportId}`, {
+            method: 'DELETE',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            }
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to cancel scheduled export: ${response.statusText}`);
+        }
+    }
+    /**
+     * Get export history
+     *
+     * Universal method - retrieves past export records.
+     */
+    async getHistory(options = {}) {
+        const apiEndpoint = this.sdk.getAPIEndpoint();
+        const apiKey = this.sdk.getAPIKey();
+        const queryParams = new URLSearchParams();
+        if (options.limit)
+            queryParams.append('limit', options.limit.toString());
+        if (options.offset)
+            queryParams.append('offset', options.offset.toString());
+        const response = await fetch(`${apiEndpoint}/api/v1/export/history?${queryParams}`, {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+                ...(apiKey && { 'Authorization': `Bearer ${apiKey}` })
+            }
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to get export history: ${response.statusText}`);
+        }
+        return await response.json();
+    }
+}

package/dist/modules/export/index.d.ts

@@ -0,0 +1,3 @@
+export { ExportModule } from './ExportModule';
+export type { ExportFormat, ReportFormat, ExportOptions, ExportResult, CSVExportOptions, JSONExportOptions, ReportOptions, ReportResult, DownloadOptions, BulkExportOptions, BulkExportResult, ExportTemplate, ScheduledExportOptions, ScheduledExport } from './ExportModule';
+//# sourceMappingURL=index.d.ts.map

package/dist/modules/export/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/modules/export/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,YAAY,EACZ,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,sBAAsB,EACtB,eAAe,EAChB,MAAM,gBAAgB,CAAA"}

package/dist/modules/export/index.js

@@ -0,0 +1 @@
+export { ExportModule } from './ExportModule';