feat(client-core): extend client types with custom granularity support (

#8724)
cube-js · Sep 18, 2024 · 21a63e2 · 21a63e2
1 parent 47c4d78
commit 21a63e2
Showing 1 changed file with 14 additions and 2 deletions.
diff --git a/packages/cubejs-client-core/index.d.ts b/packages/cubejs-client-core/index.d.ts
@@ -943,10 +943,22 @@ declare module '@cubejs-client/core' {
     format?: 'currency' | 'percent';
   };
 
-  export type TCubeDimension = BaseCubeMember & {
+  export type CubeTimeDimensionGranularity = {
+    name: string;
+    title: string;
+  }
+
+  export type BaseCubeDimension = BaseCubeMember & {
     primaryKey?: boolean;
     suggestFilterValues: boolean;
-  };
+  }
+
+  export type CubeTimeDimension = BaseCubeDimension &
+    { type: 'time'; granularities?: CubeTimeDimensionGranularity[] };
+
+  export type TCubeDimension =
+    (BaseCubeDimension & { type: Exclude<BaseCubeDimension['type'], 'time'> }) |
+    CubeTimeDimension;
 
   export type TCubeSegment = Omit<BaseCubeMember, 'type'>;