drizzle-cube 0.2.24 → 0.2.26

package/dist/client/utils/multiQueryUtils.d.ts

@@ -0,0 +1,86 @@
+import { CubeResultSet, CubeQuery, QueryMergeStrategy } from '../types';
+/**
+ * Metadata fields injected into multi-query data
+ */
+export interface MultiQueryMetadata {
+    __queryIndex: number;
+    __queryLabel: string;
+}
+/**
+ * Check if data contains multi-query metadata
+ */
+export declare function isMultiQueryData(data: unknown[]): boolean;
+/**
+ * Get unique query labels from multi-query data
+ */
+export declare function getQueryLabels(data: unknown[]): string[];
+/**
+ * Get query indices from multi-query data
+ */
+export declare function getQueryIndices(data: unknown[]): number[];
+/**
+ * Merge results using 'concat' strategy
+ * Appends all rows with __queryIndex and __queryLabel metadata
+ *
+ * @param resultSets - Array of CubeResultSet from each query
+ * @param queries - Original CubeQuery objects
+ * @param labels - Optional user-defined labels per query
+ * @returns Merged data array with query metadata
+ */
+export declare function mergeResultsConcat(resultSets: CubeResultSet[], _queries: CubeQuery[], labels?: string[]): unknown[];
+/**
+ * Merge results using 'merge' strategy
+ * Aligns data by common dimensions (composite key), combining measures from all queries
+ *
+ * Example:
+ *   Query 1: [{ date: '2024-01', revenue: 100 }]
+ *   Query 2: [{ date: '2024-01', cost: 50 }]
+ *   Result:  [{ date: '2024-01', revenue: 100, cost: 50 }]
+ *
+ * If multiple queries have the same measure, the first query's value is used.
+ *
+ * @param resultSets - Array of CubeResultSet from each query
+ * @param queries - Original CubeQuery objects
+ * @param mergeKeys - Dimension fields to align data on (composite key)
+ * @param _labels - Optional user-defined labels per query (unused, kept for API compatibility)
+ * @returns Merged data array with combined measures
+ */
+export declare function mergeResultsByKey(resultSets: CubeResultSet[], queries: CubeQuery[], mergeKeys: string[], _labels?: string[]): unknown[];
+/**
+ * Main entry point for merging query results
+ * Delegates to appropriate strategy implementation
+ *
+ * @param resultSets - Array of CubeResultSet from each query
+ * @param queries - Original CubeQuery objects
+ * @param strategy - Merge strategy ('concat' or 'merge')
+ * @param mergeKeys - Dimension fields to align on (required for 'merge' strategy)
+ * @param labels - Optional user-defined labels per query
+ * @returns Merged data array
+ */
+export declare function mergeQueryResults(resultSets: CubeResultSet[], queries: CubeQuery[], strategy: QueryMergeStrategy, mergeKeys?: string[], labels?: string[]): unknown[];
+/**
+ * Get combined fields from all queries
+ * Used for chart configuration to show all available measures/dimensions
+ *
+ * @param queries - Array of CubeQuery objects
+ * @param _labels - Optional user-defined labels per query (unused, kept for API compatibility)
+ * @returns Object containing combined measures, dimensions, and time dimensions
+ */
+export declare function getCombinedFields(queries: CubeQuery[], _labels?: string[]): {
+    measures: string[];
+    dimensions: string[];
+    timeDimensions: string[];
+};
+/**
+ * Generate a default label for a query based on its measures
+ * Used when user doesn't provide custom labels
+ */
+export declare function generateQueryLabel(query: CubeQuery, index: number): string;
+/**
+ * Validate merge key exists in all queries
+ * Returns validation result with details
+ */
+export declare function validateMergeKey(queries: CubeQuery[], mergeKey: string): {
+    isValid: boolean;
+    missingInQueries: number[];
+};

package/dist/client/utils/multiQueryValidation.d.ts

@@ -0,0 +1,69 @@
+import { CubeQuery } from '../types';
+type TimeDimension = NonNullable<CubeQuery['timeDimensions']>[number];
+/**
+ * Validation error for multi-query configuration
+ */
+export interface MultiQueryValidationError {
+    type: 'missing_time_dimension' | 'granularity_mismatch' | 'missing_merge_key';
+    queryIndex: number;
+    message: string;
+    details?: {
+        field?: string;
+        expectedGranularity?: string;
+        actualGranularity?: string;
+    };
+}
+/**
+ * Validation warning for multi-query configuration
+ */
+export interface MultiQueryValidationWarning {
+    type: 'measure_collision' | 'asymmetric_date_range';
+    queryIndices: number[];
+    message: string;
+    affectedMeasures?: string[];
+}
+/**
+ * Result of multi-query validation
+ */
+export interface MultiQueryValidationResult {
+    isValid: boolean;
+    errors: MultiQueryValidationError[];
+    warnings: MultiQueryValidationWarning[];
+}
+/**
+ * Extract time dimension info from a query
+ */
+export declare function extractTimeDimensions(query: CubeQuery): TimeDimension[];
+/**
+ * Validate that all queries have matching time dimension granularities
+ * Only relevant for 'merge' strategy where data needs to align
+ */
+export declare function validateTimeDimensionAlignment(queries: CubeQuery[]): MultiQueryValidationError[];
+/**
+ * Validate that merge keys exist in all queries
+ */
+export declare function validateMergeKeys(queries: CubeQuery[], mergeKeys: string[]): MultiQueryValidationError[];
+/**
+ * Detect when the same measure appears in multiple queries
+ * This is a warning since the first value wins in merge mode
+ */
+export declare function detectMeasureCollisions(queries: CubeQuery[]): MultiQueryValidationWarning[];
+/**
+ * Check if queries have different date ranges
+ */
+export declare function detectAsymmetricDateRanges(queries: CubeQuery[]): MultiQueryValidationWarning[];
+/**
+ * Validate a multi-query configuration
+ * For 'merge' strategy: strict validation (errors block execution)
+ * For 'concat' strategy: only warnings
+ */
+export declare function validateMultiQueryConfig(queries: CubeQuery[], mergeStrategy: 'concat' | 'merge', mergeKeys?: string[]): MultiQueryValidationResult;
+/**
+ * Check if a multi-query configuration is valid for execution
+ */
+export declare function isMultiQueryValid(queries: CubeQuery[]): boolean;
+/**
+ * Get human-readable validation summary
+ */
+export declare function getValidationSummary(result: MultiQueryValidationResult): string;
+export {};

package/dist/client/utils/shareUtils.d.ts

@@ -1,10 +1,10 @@
-import { CubeQuery, ChartType, ChartAxisConfig, ChartDisplayConfig } from '../types';
+import { CubeQuery, ChartType, ChartAxisConfig, ChartDisplayConfig, MultiQueryConfig } from '../types';
 /**
  * State that can be shared via URL
- * Query is required, chart config is optional (may be dropped if too large)
+ * Query is required (can be single CubeQuery or MultiQueryConfig), chart config is optional (may be dropped if too large)
  */
 export interface ShareableState {
-    query: CubeQuery;
+    query: CubeQuery | MultiQueryConfig;
     chartType?: ChartType;
     chartConfig?: ChartAxisConfig;
     displayConfig?: ChartDisplayConfig;