fix: export IntrospectionResult type

VeryBigThings · Apr 7, 2024 · 635b14d · 635b14d
1 parent 0d6b615
commit 635b14d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/src/lib/query-builder.ts b/src/lib/query-builder.ts
@@ -1,6 +1,7 @@
 import {
   AnyQuery,
   AnyQueryFilter,
+  IntrospectionResult,
   MemberFormat,
   MemberNameToType,
   MemberType,
@@ -153,7 +154,7 @@ export class QueryBuilder<
     return result;
   }
 
-  introspect(query: AnyQuery) {
+  introspect(query: AnyQuery): IntrospectionResult {
     const queryDimensions = query.dimensions ?? [];
     const queryMetrics = query.metrics ?? [];
 

diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -133,3 +133,14 @@ export type InferSqlQueryResultType<
 export type QueryMemberName<T> = T extends string[] ? T[number] : never;
 
 export type AvailableDialects = "postgresql";
+
+export type IntrospectionResult = Record<
+  string,
+  {
+    memberType: "dimension" | "metric";
+    path: string;
+    format?: MemberFormat | undefined;
+    type: MemberType;
+    description?: string | undefined;
+  }
+>;