drizzle-cube 0.3.21 → 0.3.23

package/dist/server/index.d.ts

@@ -352,6 +352,12 @@ declare interface Cube {
     measures: Record<string, Measure>;
     /** Optional joins to other cubes for multi-cube queries */
     joins?: Record<string, CubeJoin>;
+    /**
+     * Hierarchies for structured drill-down paths
+     * Groups dimensions into levels for navigation (e.g., country -> region -> city)
+     * A dimension can appear in multiple hierarchies
+     */
+    hierarchies?: Record<string, Hierarchy>;
     /** Whether cube is publicly accessible */
     public?: boolean;
     /** SQL alias for the cube */
@@ -484,6 +490,11 @@ export declare interface CubeMetadata {
     dimensions: DimensionMetadata[];
     segments: any[];
     relationships?: CubeRelationshipMetadata[];
+    /**
+     * Hierarchies for structured drill-down paths
+     * Enables navigation through dimension levels (e.g., country -> region -> city)
+     */
+    hierarchies?: HierarchyMetadata[];
     /** Additional cube metadata (e.g., eventStream configuration for funnel queries) */
     meta?: Record<string, any>;
 }
@@ -751,6 +762,13 @@ declare interface Dimension {
     format?: string;
     /** Additional metadata */
     meta?: Record<string, any>;
+    /**
+     * Supported granularities for time dimensions
+     * If not specified for time dimensions, defaults to ['year', 'quarter', 'month', 'week', 'day']
+     * Only applies when type is 'time'
+     * @example ['year', 'quarter', 'month', 'day'] for a custom subset
+     */
+    granularities?: TimeGranularity[];
 }
 export { Dimension }
 export { Dimension as SemanticDimension }
@@ -779,6 +797,12 @@ export declare interface DimensionMetadata {
      * Used by AI agents for natural language matching
      */
     synonyms?: string[];
+    /**
+     * Supported granularities for time dimensions
+     * Only present when type is 'time'
+     * Used for time-based drill-down (year -> quarter -> month -> week -> day)
+     */
+    granularities?: TimeGranularity[];
 }
 
 export declare type DimensionType = 'string' | 'number' | 'time' | 'boolean';
@@ -1348,6 +1372,40 @@ export declare function getCubeInvalidationPattern(cubeName: string, keyPrefix?:
  */
 export declare function getJoinType(relationship: string, override?: string): string;
 
+/**
+ * Hierarchy definition for grouped drill-down paths
+ * Groups dimensions into ordered levels for structured navigation
+ */
+export declare interface Hierarchy {
+    /** Unique identifier for the hierarchy */
+    name: string;
+    /** Display title for the hierarchy */
+    title?: string;
+    /**
+     * Dimension names in order from least to most granular
+     * @example ['country', 'region', 'city'] for geographic hierarchy
+     * @example ['category', 'subcategory', 'product'] for product hierarchy
+     */
+    levels: string[];
+}
+
+/**
+ * Hierarchy metadata for structured drill-down paths
+ */
+export declare interface HierarchyMetadata {
+    /** Unique identifier for the hierarchy */
+    name: string;
+    /** Display title for the hierarchy */
+    title: string;
+    /** Cube name this hierarchy belongs to */
+    cubeName: string;
+    /**
+     * Full dimension names in order from least to most granular
+     * Format: "CubeName.dimensionName"
+     */
+    levels: string[];
+}
+
 /**
  * Information about a database index
  */
@@ -1516,6 +1574,14 @@ declare interface Measure {
     dependencies?: string[];
     /** Additional metadata */
     meta?: Record<string, any>;
+    /**
+     * Dimension names shown when drilling into this measure
+     * Can include cross-cube dimensions via joins (e.g., 'Products.name', 'Users.email')
+     * If not specified, drilling is disabled for this measure
+     * @example ['id', 'status', 'createdAt'] for same-cube dimensions
+     * @example ['Orders.id', 'Products.name', 'Users.city'] for cross-cube dimensions
+     */
+    drillMembers?: string[];
     /**
      * Statistical function configuration
      * Used for percentile, stddev, variance measure types
@@ -1615,6 +1681,12 @@ export declare interface MeasureMetadata {
      * Used by AI agents for natural language matching
      */
     synonyms?: string[];
+    /**
+     * Dimension names shown when drilling into this measure
+     * Full names like "CubeName.dimensionName" for cross-cube support
+     * If not specified, drilling is disabled for this measure
+     */
+    drillMembers?: string[];
 }
 
 /**
@@ -2788,9 +2860,15 @@ export declare class SemanticLayerCompiler {
      * Handles different column types and extracts the actual column name
      */
     private getColumnName;
+    /**
+     * Default time granularities for time dimensions (ordered from least to most granular)
+     * Used when dimension.granularities is not specified
+     */
+    private static readonly DEFAULT_TIME_GRANULARITIES;
     /**
      * Generate cube metadata for API responses from cubes
      * Optimized version that minimizes object iterations
+     * Includes drill-down support: drillMembers on measures, granularities on time dimensions, hierarchies
      */
     private generateCubeMetadata;
     /**