@varity-labs/sdk 2.0.0-alpha.1

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

@@ -0,0 +1,346 @@
+import type { VaritySDK } from '../../core/VaritySDK';
+/**
+ * Export Module
+ *
+ * Universal data export and report generation across all templates.
+ * Supports CSV, JSON, PDF, Excel exports and custom report generation.
+ * Works identically for ISO, Healthcare, Finance, Retail, etc.
+ */
+export type ExportFormat = 'csv' | 'json' | 'pdf' | 'xlsx' | 'xml';
+export type ReportFormat = 'pdf' | 'docx' | 'html';
+export interface ExportOptions {
+    dataSource: string;
+    format?: ExportFormat;
+    columns?: string[];
+    filters?: Record<string, any>;
+    startDate?: string;
+    endDate?: string;
+    sortBy?: string;
+    sortOrder?: 'asc' | 'desc';
+    limit?: number;
+    includeHeaders?: boolean;
+    fileName?: string;
+    metadata?: Record<string, any>;
+}
+export interface ExportResult {
+    id: string;
+    format: ExportFormat;
+    fileUrl?: string;
+    downloadUrl?: string;
+    fileName: string;
+    size: number;
+    rows: number;
+    createdAt: string;
+    expiresAt?: string;
+    metadata?: Record<string, any>;
+}
+export interface CSVExportOptions extends ExportOptions {
+    delimiter?: ',' | ';' | '\t';
+    quote?: '"' | "'";
+    encoding?: 'utf-8' | 'utf-16' | 'ascii';
+    includeHeaders?: boolean;
+}
+export interface JSONExportOptions extends ExportOptions {
+    pretty?: boolean;
+    indent?: number;
+}
+export interface ReportOptions {
+    template: string;
+    format: ReportFormat;
+    period: string;
+    data?: Record<string, any>;
+    includeCharts?: boolean;
+    includeTableOfContents?: boolean;
+    locale?: string;
+    metadata?: Record<string, any>;
+}
+export interface ReportResult {
+    id: string;
+    template: string;
+    format: ReportFormat;
+    fileUrl: string;
+    downloadUrl: string;
+    fileName: string;
+    size: number;
+    pages?: number;
+    createdAt: string;
+    expiresAt: string;
+    metadata?: Record<string, any>;
+}
+export interface DownloadOptions {
+    fileId: string;
+    format?: ExportFormat;
+    fileName?: string;
+}
+export interface BulkExportOptions {
+    exports: ExportOptions[];
+    zipFileName?: string;
+    metadata?: Record<string, any>;
+}
+export interface BulkExportResult {
+    id: string;
+    zipUrl: string;
+    zipFileName: string;
+    exports: ExportResult[];
+    totalSize: number;
+    createdAt: string;
+    expiresAt: string;
+}
+export interface ExportTemplate {
+    id?: string;
+    name: string;
+    description?: string;
+    dataSource: string;
+    columns: string[];
+    defaultFilters?: Record<string, any>;
+    defaultSort?: {
+        field: string;
+        order: 'asc' | 'desc';
+    };
+    format: ExportFormat;
+    metadata?: Record<string, any>;
+}
+export interface ScheduledExportOptions extends ExportOptions {
+    schedule: {
+        frequency: 'daily' | 'weekly' | 'monthly' | 'quarterly';
+        time?: string;
+        dayOfWeek?: number;
+        dayOfMonth?: number;
+    };
+    recipients?: string[];
+    enabled?: boolean;
+}
+export interface ScheduledExport {
+    id: string;
+    exportOptions: ExportOptions;
+    schedule: ScheduledExportOptions['schedule'];
+    recipients?: string[];
+    enabled: boolean;
+    lastRun?: string;
+    nextRun: string;
+    createdAt: string;
+}
+/**
+ * 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 declare class ExportModule {
+    private sdk;
+    constructor(sdk: VaritySDK);
+    /**
+     * 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']
+     * })
+     * ```
+     */
+    toCSV(options: CSVExportOptions): Promise<ExportResult>;
+    /**
+     * 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
+     * })
+     * ```
+     */
+    toJSON(options: JSONExportOptions): Promise<ExportResult>;
+    /**
+     * 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'
+     * })
+     * ```
+     */
+    toExcel(options: ExportOptions): Promise<ExportResult>;
+    /**
+     * 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' }
+     * })
+     * ```
+     */
+    generateReport(options: ReportOptions): Promise<ReportResult>;
+    /**
+     * 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'
+     * })
+     * ```
+     */
+    downloadFile(options: DownloadOptions): Promise<Blob>;
+    /**
+     * Get export file URL for direct download
+     *
+     * Universal method - returns a downloadable URL for an export.
+     */
+    getDownloadUrl(fileId: string): Promise<{
+        url: string;
+        expiresAt: string;
+    }>;
+    /**
+     * 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'
+     * })
+     * ```
+     */
+    bulkExport(options: BulkExportOptions): Promise<BulkExportResult>;
+    /**
+     * List available data sources for export
+     *
+     * Universal method - returns available data sources based on template.
+     */
+    listDataSources(): Promise<Array<{
+        name: string;
+        description?: string;
+        columns: string[];
+    }>>;
+    /**
+     * 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'
+     * })
+     * ```
+     */
+    createTemplate(template: ExportTemplate): Promise<ExportTemplate>;
+    /**
+     * Export using saved template
+     *
+     * Universal method - runs an export using a saved template.
+     */
+    exportFromTemplate(templateName: string, overrides?: Partial<ExportOptions>): Promise<ExportResult>;
+    /**
+     * List export templates
+     *
+     * Universal method - lists all saved export templates.
+     */
+    listTemplates(): Promise<ExportTemplate[]>;
+    /**
+     * 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
+     * })
+     * ```
+     */
+    scheduleExport(options: ScheduledExportOptions): Promise<ScheduledExport>;
+    /**
+     * List scheduled exports
+     *
+     * Universal method - lists all scheduled exports.
+     */
+    listScheduledExports(): Promise<ScheduledExport[]>;
+    /**
+     * Cancel scheduled export
+     *
+     * Universal method - cancels a scheduled export.
+     */
+    cancelScheduledExport(exportId: string): Promise<void>;
+    /**
+     * Get export history
+     *
+     * Universal method - retrieves past export records.
+     */
+    getHistory(options?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<{
+        exports: ExportResult[];
+        total: number;
+    }>;
+}
+//# sourceMappingURL=ExportModule.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ExportModule.d.ts","sourceRoot":"","sources":["../../../src/modules/export/ExportModule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD;;;;;;GAMG;AAEH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAAA;AAElE,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAA;AAElD,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,YAAY,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACrD,SAAS,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI,CAAA;IAC5B,KAAK,CAAC,EAAE,GAAG,GAAG,GAAG,CAAA;IACjB,QAAQ,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACvC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,YAAY,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,YAAY,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,aAAa,EAAE,CAAA;IACxB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,YAAY,EAAE,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACpC,WAAW,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAA;KAAE,CAAA;IACtD,MAAM,EAAE,YAAY,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,sBAAuB,SAAQ,aAAa;IAC3D,QAAQ,EAAE;QACR,SAAS,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAA;QACvD,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,CAAA;IACD,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,aAAa,CAAA;IAC5B,QAAQ,EAAE,sBAAsB,CAAC,UAAU,CAAC,CAAA;IAC5C,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,YAAY;IACX,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,SAAS;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,KAAK,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC;IAoB7D;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC;IAoB/D;;;;;;;;;;;;;OAaG;IACG,OAAO,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAoB5D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,cAAc,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAoBnE;;;;;;;;;;;;OAYG;IACG,YAAY,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB3D;;;;OAIG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAsBjF;;;;;;;;;;;;;;;;OAgBG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAoBvE;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;IAmBlG;;;;;;;;;;;;;;;;OAgBG;IACG,cAAc,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAoBvE;;;;OAIG;IACG,kBAAkB,CACtB,YAAY,EAAE,MAAM,EACpB,SAAS,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,GACjC,OAAO,CAAC,YAAY,CAAC;IAuBxB;;;;OAIG;IACG,aAAa,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAmBhD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC;IAoB/E;;;;OAIG;IACG,oBAAoB,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAmBxD;;;;OAIG;IACG,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB5D;;;;OAIG;IACG,UAAU,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC;QAC3E,OAAO,EAAE,YAAY,EAAE,CAAA;QACvB,KAAK,EAAE,MAAM,CAAA;KACd,CAAC;CAsBH"}