drizzle-cube 0.1.34 → 0.1.36

package/dist/server/index.d.ts

@@ -145,7 +145,7 @@ declare interface CubeJoin {
     /** Target cube reference - lazy loaded to avoid circular dependencies */
     targetCube: Cube | (() => Cube);
     /** Semantic relationship - determines join behavior */
-    relationship: 'belongsTo' | 'hasOne' | 'hasMany';
+    relationship: CubeRelationship;
     /** Array of join conditions - supports multi-column joins */
     on: Array<{
         /** Column from source cube */
@@ -157,6 +157,28 @@ declare interface CubeJoin {
     }>;
     /** Override default SQL join type (derived from relationship) */
     sqlJoinType?: 'inner' | 'left' | 'right' | 'full';
+    /**
+     * Many-to-many relationship configuration through a junction table
+     * Only used when relationship is 'belongsToMany'
+     */
+    through?: {
+        /** Junction/join table (Drizzle table reference) */
+        table: Table;
+        /** Join conditions from source cube to junction table */
+        sourceKey: Array<{
+            source: AnyColumn;
+            target: AnyColumn;
+            as?: (source: AnyColumn, target: AnyColumn) => SQL;
+        }>;
+        /** Join conditions from junction table to target cube */
+        targetKey: Array<{
+            source: AnyColumn;
+            target: AnyColumn;
+            as?: (source: AnyColumn, target: AnyColumn) => SQL;
+        }>;
+        /** Optional security context SQL for junction table */
+        securitySql?: (securityContext: SecurityContext) => SQL | SQL[];
+    };
 }
 export { CubeJoin }
 export { CubeJoin as SemanticJoin }
@@ -174,12 +196,17 @@ export declare interface CubeMetadata {
     relationships?: CubeRelationshipMetadata[];
 }
 
+/**
+ * Relationship types supported by cube joins
+ */
+export declare type CubeRelationship = 'belongsTo' | 'hasOne' | 'hasMany' | 'belongsToMany';
+
 /**
  * Cube relationship metadata for ERD visualization
  */
 export declare interface CubeRelationshipMetadata {
     targetCube: string;
-    relationship: 'belongsTo' | 'hasOne' | 'hasMany';
+    relationship: 'belongsTo' | 'hasOne' | 'hasMany' | 'belongsToMany';
     joinFields: Array<{
         sourceField: string;
         targetField: string;
@@ -662,6 +689,15 @@ export declare interface QueryPlan {
         alias: string;
         joinType: 'inner' | 'left' | 'right' | 'full';
         joinCondition: SQL;
+        /** Junction table information for belongsToMany relationships */
+        junctionTable?: {
+            table: Table;
+            alias: string;
+            joinType: 'inner' | 'left' | 'right' | 'full';
+            joinCondition: SQL;
+            /** Optional security SQL function to apply to junction table */
+            securitySql?: (securityContext: SecurityContext) => SQL | SQL[];
+        };
     }>;
     /** Combined field selections across all cubes (built by QueryBuilder) */
     selections: Record<string, SQL | AnyColumn>;