tm1npm 1.2.1 → 1.4.0

package/lib/services/BulkService.d.ts

@@ -0,0 +1,383 @@
+/**
+ * BulkService - High-performance bulk operations for TM1
+ *
+ * Provides efficient batch operations, data import/export, and bulk processing
+ * capabilities for handling large datasets with optimal performance.
+ */
+import { RestService } from './RestService';
+import { CellService } from './CellService';
+import { ViewService } from './ViewService';
+/**
+ * Bulk write operation definition
+ */
+export interface BulkWriteOperation {
+    cubeName: string;
+    coordinates: string[];
+    value: any;
+}
+/**
+ * Bulk read query definition
+ */
+export interface BulkReadQuery {
+    cubeName: string;
+    coordinates: string[];
+}
+/**
+ * Bulk update operation definition
+ */
+export interface BulkUpdateOperation {
+    cubeName: string;
+    coordinates: string[];
+    value: any;
+    increment?: boolean;
+}
+/**
+ * Bulk delete operation definition
+ */
+export interface BulkDeleteOperation {
+    cubeName: string;
+    coordinates: string[];
+}
+/**
+ * CSV import options
+ */
+export interface CSVImportOptions {
+    delimiter?: string;
+    hasHeader?: boolean;
+    encoding?: string;
+    batchSize?: number;
+    skipErrors?: boolean;
+    decimalSeparator?: string;
+    thousandSeparator?: string;
+    sandbox_name?: string;
+    increment?: boolean;
+    use_ti?: boolean;
+}
+/**
+ * CSV export options
+ */
+export interface CSVExportOptions {
+    delimiter?: string;
+    includeHeader?: boolean;
+    encoding?: string;
+    decimalSeparator?: string;
+    thousandSeparator?: string;
+    sandbox_name?: string;
+    skip_zeros?: boolean;
+    skip_consolidated?: boolean;
+    skip_rule_derived?: boolean;
+}
+/**
+ * JSON import options
+ */
+export interface JSONImportOptions {
+    batchSize?: number;
+    skipErrors?: boolean;
+    sandbox_name?: string;
+    increment?: boolean;
+    use_ti?: boolean;
+    validate?: boolean;
+}
+/**
+ * JSON export options
+ */
+export interface JSONExportOptions {
+    sandbox_name?: string;
+    skip_zeros?: boolean;
+    skip_consolidated?: boolean;
+    skip_rule_derived?: boolean;
+    format?: 'compact' | 'full';
+}
+/**
+ * Batch operation types
+ */
+export type BatchOperationType = 'write' | 'read' | 'update' | 'delete';
+/**
+ * Batch operation definition
+ */
+export interface BatchOperation {
+    type: BatchOperationType;
+    cubeName: string;
+    coordinates: string[];
+    value?: any;
+    options?: any;
+}
+/**
+ * Batch operation result
+ */
+export interface BatchResult {
+    success: boolean;
+    operation: BatchOperation;
+    result?: any;
+    error?: string;
+}
+/**
+ * Bulk write options
+ */
+export interface BulkWriteOptions {
+    maxWorkers?: number;
+    chunkSize?: number;
+    maxRetries?: number;
+    retryDelay?: number;
+    cancelAtFailure?: boolean;
+    sandbox_name?: string;
+    increment?: boolean;
+    use_ti?: boolean;
+    use_blob?: boolean;
+}
+/**
+ * Bulk read options
+ */
+export interface BulkReadOptions {
+    maxWorkers?: number;
+    chunkSize?: number;
+    sandbox_name?: string;
+    use_blob?: boolean;
+}
+/**
+ * Transaction state
+ */
+export interface TransactionState {
+    id: string;
+    operations: BatchOperation[];
+    status: 'pending' | 'committed' | 'rolled_back';
+    createdAt: Date;
+}
+/**
+ * BulkService - Comprehensive bulk operations service
+ *
+ * Provides high-performance batch operations for TM1 data manipulation,
+ * import/export capabilities, and transaction management.
+ */
+export declare class BulkService {
+    private rest;
+    private cellService;
+    private viewService?;
+    private transactions;
+    constructor(rest: RestService, cellService: CellService, viewService?: ViewService);
+    /**
+     * Execute bulk write operations
+     *
+     * Efficiently writes multiple cells across one or more cubes with optimized batching
+     * and parallel processing.
+     *
+     * @param operations - Array of bulk write operations
+     * @param options - Bulk write options for performance tuning
+     *
+     * @example
+     * ```typescript
+     * const operations = [
+     *     { cubeName: 'Sales', coordinates: ['2024', 'Q1', 'Revenue'], value: 100000 },
+     *     { cubeName: 'Sales', coordinates: ['2024', 'Q2', 'Revenue'], value: 120000 }
+     * ];
+     * await bulkService.executeBulkWrite(operations, { chunkSize: 1000 });
+     * ```
+     */
+    executeBulkWrite(operations: BulkWriteOperation[], options?: BulkWriteOptions): Promise<void>;
+    /**
+     * Execute bulk read operations
+     *
+     * Efficiently reads multiple cells across one or more cubes with parallel processing.
+     *
+     * @param queries - Array of bulk read queries
+     * @param options - Bulk read options for performance tuning
+     * @returns Array of cell values corresponding to queries
+     *
+     * @example
+     * ```typescript
+     * const queries = [
+     *     { cubeName: 'Sales', coordinates: ['2024', 'Q1', 'Revenue'] },
+     *     { cubeName: 'Sales', coordinates: ['2024', 'Q2', 'Revenue'] }
+     * ];
+     * const values = await bulkService.executeBulkRead(queries);
+     * ```
+     */
+    executeBulkRead(queries: BulkReadQuery[], options?: BulkReadOptions): Promise<any[]>;
+    /**
+     * Execute bulk update operations
+     *
+     * Updates multiple cells with support for increment operations.
+     *
+     * @param updates - Array of bulk update operations
+     * @param options - Bulk write options
+     *
+     * @example
+     * ```typescript
+     * const updates = [
+     *     { cubeName: 'Sales', coordinates: ['2024', 'Q1', 'Revenue'], value: 10000, increment: true }
+     * ];
+     * await bulkService.executeBulkUpdate(updates);
+     * ```
+     */
+    executeBulkUpdate(updates: BulkUpdateOperation[], options?: BulkWriteOptions): Promise<void>;
+    /**
+     * Execute bulk delete operations
+     *
+     * Clears values from multiple cells (sets to 0 or empty string).
+     *
+     * @param deletes - Array of bulk delete operations
+     * @param options - Bulk write options
+     *
+     * @example
+     * ```typescript
+     * const deletes = [
+     *     { cubeName: 'Sales', coordinates: ['2024', 'Q1', 'Revenue'] }
+     * ];
+     * await bulkService.executeBulkDelete(deletes);
+     * ```
+     */
+    executeBulkDelete(deletes: BulkDeleteOperation[], options?: BulkWriteOptions): Promise<void>;
+    /**
+     * Import data from CSV
+     *
+     * Imports data from CSV string into a TM1 cube with configurable parsing options.
+     *
+     * @param cubeName - Target cube name
+     * @param csvData - CSV data as string
+     * @param options - CSV import options
+     *
+     * @example
+     * ```typescript
+     * const csv = `Year,Quarter,Amount
+     * 2024,Q1,100000
+     * 2024,Q2,120000`;
+     * await bulkService.importDataFromCSV('Sales', csv, { hasHeader: true });
+     * ```
+     */
+    importDataFromCSV(cubeName: string, csvData: string, options?: CSVImportOptions): Promise<void>;
+    /**
+     * Export data to CSV
+     *
+     * Exports cube data to CSV format using an MDX query.
+     *
+     * @param cubeName - Source cube name
+     * @param mdx - MDX query to define data selection
+     * @param options - CSV export options
+     * @returns CSV data as string
+     *
+     * @example
+     * ```typescript
+     * const mdx = `SELECT {[Year].[2024]} ON 0 FROM [Sales]`;
+     * const csv = await bulkService.exportDataToCSV('Sales', mdx, { includeHeader: true });
+     * ```
+     */
+    exportDataToCSV(cubeName: string, mdx: string, options?: CSVExportOptions): Promise<string>;
+    /**
+     * Import data from JSON
+     *
+     * Imports data from JSON format into a TM1 cube.
+     *
+     * @param cubeName - Target cube name
+     * @param jsonData - JSON data array
+     * @param options - JSON import options
+     *
+     * @example
+     * ```typescript
+     * const data = [
+     *     { coordinates: ['2024', 'Q1', 'Revenue'], value: 100000 },
+     *     { coordinates: ['2024', 'Q2', 'Revenue'], value: 120000 }
+     * ];
+     * await bulkService.importDataFromJSON('Sales', data);
+     * ```
+     */
+    importDataFromJSON(cubeName: string, jsonData: any[], options?: JSONImportOptions): Promise<void>;
+    /**
+     * Export data to JSON
+     *
+     * Exports cube data to JSON format using an MDX query.
+     *
+     * @param cubeName - Source cube name
+     * @param mdx - MDX query to define data selection
+     * @param options - JSON export options
+     * @returns Array of JSON objects with coordinates and values
+     *
+     * @example
+     * ```typescript
+     * const mdx = `SELECT {[Year].[2024]} ON 0 FROM [Sales]`;
+     * const data = await bulkService.exportDataToJSON('Sales', mdx);
+     * ```
+     */
+    exportDataToJSON(cubeName: string, mdx: string, options?: JSONExportOptions): Promise<any[]>;
+    /**
+     * Execute batch operations
+     *
+     * Executes a mixed batch of operations (read, write, update, delete) in sequence.
+     *
+     * @param batch - Array of mixed batch operations
+     * @returns Array of batch results
+     *
+     * @example
+     * ```typescript
+     * const batch = [
+     *     { type: 'write', cubeName: 'Sales', coordinates: ['2024', 'Q1'], value: 100 },
+     *     { type: 'read', cubeName: 'Sales', coordinates: ['2024', 'Q1'] }
+     * ];
+     * const results = await bulkService.executeBatchOperations(batch);
+     * ```
+     */
+    executeBatchOperations(batch: BatchOperation[]): Promise<BatchResult[]>;
+    /**
+     * Create batch transaction
+     *
+     * Creates a transaction that can be committed or rolled back.
+     *
+     * @param operations - Array of operations for the transaction
+     * @returns Transaction ID
+     *
+     * @example
+     * ```typescript
+     * const txId = await bulkService.createBatchTransaction(operations);
+     * try {
+     *     await bulkService.commitBatchTransaction(txId);
+     * } catch (error) {
+     *     await bulkService.rollbackBatchTransaction(txId);
+     * }
+     * ```
+     */
+    createBatchTransaction(operations: BatchOperation[]): Promise<string>;
+    /**
+     * Commit batch transaction
+     *
+     * Executes and commits a previously created transaction.
+     *
+     * @param transactionId - Transaction ID to commit
+     */
+    commitBatchTransaction(transactionId: string): Promise<void>;
+    /**
+     * Rollback batch transaction
+     *
+     * Rolls back a transaction without executing operations.
+     *
+     * @param transactionId - Transaction ID to rollback
+     */
+    rollbackBatchTransaction(transactionId: string): Promise<void>;
+    /**
+     * Group operations by cube name for batch processing
+     */
+    private groupOperationsByCube;
+    /**
+     * Group queries by cube name for batch processing
+     */
+    private groupQueriesByCube;
+    /**
+     * Split array into chunks
+     */
+    private chunkArray;
+    /**
+     * Parse CSV line with delimiter handling
+     */
+    private parseCSVLine;
+    /**
+     * Parse value from string (handles numbers and strings)
+     */
+    private parseValue;
+    /**
+     * Generate unique transaction ID
+     */
+    private generateTransactionId;
+    /**
+     * Sleep helper for retry delays
+     */
+    private sleep;
+}
+//# sourceMappingURL=BulkService.d.ts.map

package/lib/services/BulkService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BulkService.d.ts","sourceRoot":"","sources":["../../src/services/BulkService.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAI5C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,EAAE,GAAG,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,EAAE,GAAG,CAAC;IACX,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,kBAAkB,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,OAAO,CAAC,EAAE,GAAG,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,cAAc,CAAC;IAC1B,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,cAAc,EAAE,CAAC;IAC7B,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,aAAa,CAAC;IAChD,SAAS,EAAE,IAAI,CAAC;CACnB;AAED;;;;;GAKG;AACH,qBAAa,WAAW;IACpB,OAAO,CAAC,IAAI,CAAc;IAC1B,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,WAAW,CAAC,CAAc;IAClC,OAAO,CAAC,YAAY,CAAgC;gBAExC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC,EAAE,WAAW;IAOlF;;;;;;;;;;;;;;;;;OAiBG;IACU,gBAAgB,CACzB,UAAU,EAAE,kBAAkB,EAAE,EAChC,OAAO,GAAE,gBAAqB,GAC/B,OAAO,CAAC,IAAI,CAAC;IA2DhB;;;;;;;;;;;;;;;;;OAiBG;IACU,eAAe,CACxB,OAAO,EAAE,aAAa,EAAE,EACxB,OAAO,GAAE,eAAoB,GAC9B,OAAO,CAAC,GAAG,EAAE,CAAC;IA0CjB;;;;;;;;;;;;;;;OAeG;IACU,iBAAiB,CAC1B,OAAO,EAAE,mBAAmB,EAAE,EAC9B,OAAO,GAAE,gBAAqB,GAC/B,OAAO,CAAC,IAAI,CAAC;IAahB;;;;;;;;;;;;;;;OAeG;IACU,iBAAiB,CAC1B,OAAO,EAAE,mBAAmB,EAAE,EAC9B,OAAO,GAAE,gBAAqB,GAC/B,OAAO,CAAC,IAAI,CAAC;IAUhB;;;;;;;;;;;;;;;;OAgBG;IACU,iBAAiB,CAC1B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,gBAAqB,GAC/B,OAAO,CAAC,IAAI,CAAC;IAiDhB;;;;;;;;;;;;;;;OAeG;IACU,eAAe,CACxB,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,gBAAqB,GAC/B,OAAO,CAAC,MAAM,CAAC;IAmDlB;;;;;;;;;;;;;;;;;OAiBG;IACU,kBAAkB,CAC3B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,GAAG,EAAE,EACf,OAAO,GAAE,iBAAsB,GAChC,OAAO,CAAC,IAAI,CAAC;IA2ChB;;;;;;;;;;;;;;;OAeG;IACU,gBAAgB,CACzB,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,iBAAsB,GAChC,OAAO,CAAC,GAAG,EAAE,CAAC;IA0CjB;;;;;;;;;;;;;;;;OAgBG;IACU,sBAAsB,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IA+DpF;;;;;;;;;;;;;;;;;OAiBG;IACU,sBAAsB,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAalF;;;;;;OAMG;IACU,sBAAsB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BzE;;;;;;OAMG;IACU,wBAAwB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAa3E;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAU7B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAU1B;;OAEG;IACH,OAAO,CAAC,UAAU;IAQlB;;OAEG;IACH,OAAO,CAAC,YAAY;IAsBpB;;OAEG;IACH,OAAO,CAAC,UAAU;IAalB;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAI7B;;OAEG;IACH,OAAO,CAAC,KAAK;CAGhB"}