feat: Update type defs for query transformer (#619) Thanks to @jcw-!

* feat: Update type defs for query transformer

* Make dimension on filter optional (prefer member)

* Prefer use of member over dimension

Author: jcw-

docs/Cube.js-Backend/@cubejs-backend-server-core.md

@@ -289,7 +289,7 @@ CubejsServerCore.create({
     const user = authInfo.u;
     if (user.filterByRegion) {
       query.filters.push({
-        dimension: 'Regions.id',
+        member: 'Regions.id',
         operator: 'equals',
         values: [user.regionId]
       })

packages/cubejs-api-gateway/index.d.ts

@@ -0,0 +1,57 @@
+declare module "@cubejs-backend/api-gateway" {
+  export interface QueryFilter {
+    member: string;
+    operator:
+      | "equals"
+      | "notEquals"
+      | "contains"
+      | "notContains"
+      | "gt"
+      | "gte"
+      | "lt"
+      | "lte"
+      | "set"
+      | "notSet"
+      | "inDateRange"
+      | "notInDateRange"
+      | "beforeDate"
+      | "afterDate";
+    values?: string[];
+  }
+
+  export type QueryTimeDimensionGranularity =
+    | "hour"
+    | "day"
+    | "week"
+    | "month"
+    | "year";
+
+  export interface QueryTimeDimension {
+    dimension: string;
+    dateRange?: string[] | string;
+    granularity?: QueryTimeDimensionGranularity;
+  }
+
+  export interface Query {
+    measures: string[];
+    dimensions?: string[];
+    filters?: QueryFilter[];
+    timeDimensions?: QueryTimeDimension[];
+    segments?: string[];
+    limit?: number;
+    offset?: number;
+    order?: "asc" | "desc";
+    timezone?: string;
+    renewQuery?: boolean;
+    ungrouped?: boolean;
+  }
+
+  export interface NormalizedQuery extends Query {
+    filters?: NormalizedQueryFilter[];
+    rowLimit?: number;
+  }
+
+  export interface NormalizedQueryFilter extends QueryFilter {
+    dimension?: string;
+  }
+}

packages/cubejs-api-gateway/package.json

@@ -15,6 +15,7 @@
     "test": "jest"
   },
   "main": "index.js",
+  "types": "index.d.ts",
   "dependencies": {
     "@hapi/joi": "^15.1.1",
     "chrono-node": "^1.3.11",

packages/cubejs-server-core/core/index.d.ts

@@ -3,6 +3,7 @@ import {
   Response as ExpressResponse,
   NextFunction as ExpressNextFunction
 } from "express";
+import { NormalizedQuery as Query } from "@cubejs-backend/api-gateway";
 
 declare module "@cubejs-backend/server-core" {
   export function create(options?: CreateOptions): any;
@@ -99,51 +100,4 @@ declare module "@cubejs-backend/server-core" {
     | "redshift"
     | "snowflake"
     | "sqlite";
-
-  export interface QueryFilter {
-    member: string;
-    operator:
-      | "equals"
-      | "notEquals"
-      | "contains"
-      | "notContains"
-      | "gt"
-      | "gte"
-      | "lt"
-      | "lte"
-      | "set"
-      | "notSet"
-      | "inDateRange"
-      | "notInDateRange"
-      | "beforeDate"
-      | "afterDate";
-    values?: string[];
-  }
-
-  export type QueryTimeDimensionGranularity =
-    | "hour"
-    | "day"
-    | "week"
-    | "month"
-    | "year";
-
-  export interface QueryTimeDimension {
-    dimension: string;
-    dateRange?: string[] | string;
-    granularity?: QueryTimeDimensionGranularity;
-  }
-
-  export interface Query {
-    measures: string[];
-    dimensions?: string[];
-    filters?: QueryFilter[];
-    timeDimensions?: QueryTimeDimension[];
-    segments?: string[];
-    limit?: number;
-    offset?: number;
-    order?: "asc" | "desc";
-    timezone?: string;
-    renewQuery?: boolean;
-    ungrouped?: boolean;
-  }
 }