@cubejs-client/core 0.29.51 → 0.30.0

package/index.d.ts

@@ -724,11 +724,11 @@ declare module '@cubejs-client/core' {
 
   export type Filter = BinaryFilter | UnaryFilter | LogicalOrFilter | LogicalAndFilter;
   export type LogicalAndFilter = {
-    and: (BinaryFilter | UnaryFilter | LogicalOrFilter)[];
+    and: Filter[];
   };
 
   export type LogicalOrFilter = {
-    or: (BinaryFilter | UnaryFilter | LogicalAndFilter)[];
+    or: Filter[];
   };
 
   export interface BinaryFilter {
@@ -788,6 +788,10 @@ declare module '@cubejs-client/core' {
 
   export type TimeDimension = TimeDimensionComparison | TimeDimensionRanged;
 
+  type DeeplyReadonly<T> = {
+    readonly [K in keyof T]: DeeplyReadonly<T[K]>;
+  };
+
   export interface Query {
     measures?: string[];
     dimensions?: string[];
@@ -804,6 +808,36 @@ declare module '@cubejs-client/core' {
     total?: boolean;
   }
 
+  export type QueryRecordType<T extends DeeplyReadonly<Query | Query[]>> =
+    T extends DeeplyReadonly<Query[]> ? QueryArrayRecordType<T> :
+    T extends DeeplyReadonly<Query> ? SingleQueryRecordType<T> :
+    never;
+
+  type QueryArrayRecordType<T extends DeeplyReadonly<Query[]>> =
+    T extends readonly [infer First, ...infer Rest]
+      ? SingleQueryRecordType<First> | QueryArrayRecordType<Rest>
+      : never;
+
+  // If we can't infer any members at all, then return any.
+  type SingleQueryRecordType<T extends DeeplyReadonly<Query>> = ExtractMembers<T> extends never
+    ? any
+    : { [K in string & ExtractMembers<T>]: string | number | boolean | null };
+
+  type ExtractMembers<T extends DeeplyReadonly<Query>> =
+    | ( T extends { dimensions: readonly (infer Names)[]; } ? Names : never )
+    | ( T extends { measures: readonly (infer Names)[]; } ? Names : never )
+    | ( T extends { timeDimensions: (infer U); } ? ExtractTimeMembers<U> : never );
+
+  type ExtractTimeMembers<T> =
+    T extends readonly [infer First, ...infer Rest]
+      ? ExtractTimeMember<First> | ExtractTimeMembers<Rest>
+      : never;
+
+  type ExtractTimeMember<T> =
+    T extends { dimension: infer Dimension, granularity: infer Granularity }
+      ? Dimension | `${Dimension & string}.${Granularity & string}`
+      : never;
+
   export class ProgressResult {
     stage(): string;
     timeElapsed(): string;
@@ -944,7 +978,7 @@ declare module '@cubejs-client/core' {
      * If empty query is provided no filtering is done based on query context and all available members are retrieved.
      * @param query - context query to provide filtering of members available to add to this query
      */
-    membersForQuery(query: Query | null, memberType: MemberType): TCubeMeasure[] | TCubeDimension[] | TCubeMember[];
+    membersForQuery(query: DeeplyReadonly<Query> | null, memberType: MemberType): TCubeMeasure[] | TCubeDimension[] | TCubeMember[];
 
     /**
      * Get meta information for a cube member
@@ -979,7 +1013,10 @@ declare module '@cubejs-client/core' {
    * @order 2
    */
   export class CubejsApi {
-    load(query: Query | Query[], options?: LoadMethodOptions): Promise<ResultSet>;
+    load<QueryType extends DeeplyReadonly<Query | Query[]>>(
+      query: QueryType,
+      options?: LoadMethodOptions,
+    ): Promise<ResultSet<QueryRecordType<QueryType>>>;
     /**
      * Fetch data for the passed `query`.
      *
@@ -1004,13 +1041,18 @@ declare module '@cubejs-client/core' {
      * ```
      * @param query - [Query object](query-format)
      */
-    load(query: Query | Query[], options?: LoadMethodOptions, callback?: LoadMethodCallback<ResultSet>): void;
-    load(
-      query: Query | Query[],
+    load<QueryType extends DeeplyReadonly<Query | Query[]>>(
+      query: QueryType,
+      options?: LoadMethodOptions,
+      callback?: LoadMethodCallback<ResultSet<QueryRecordType<QueryType>>>,
+    ): void;
+
+    load<QueryType extends DeeplyReadonly<Query | Query[]>>(
+      query: QueryType,
       options?: LoadMethodOptions,
       callback?: LoadMethodCallback<ResultSet>,
       responseFormat?: string
-    ): Promise<ResultSet>;
+    ): Promise<ResultSet<QueryRecordType<QueryType>>>;
 
     /**
      * Allows you to fetch data and receive updates over time. See [Real-Time Data Fetch](real-time-data-fetch)
@@ -1036,14 +1078,18 @@ declare module '@cubejs-client/core' {
      * );
      * ```
      */
-    subscribe(query: Query | Query[], options: LoadMethodOptions | null, callback: LoadMethodCallback<ResultSet>): void;
+    subscribe<QueryType extends DeeplyReadonly<Query | Query[]>>(
+      query: QueryType,
+      options: LoadMethodOptions | null,
+      callback: LoadMethodCallback<ResultSet<QueryRecordType<QueryType>>>,
+    ): void;
 
-    sql(query: Query | Query[], options?: LoadMethodOptions): Promise<SqlQuery>;
+    sql(query: DeeplyReadonly<Query | Query[]>, options?: LoadMethodOptions): Promise<SqlQuery>;
     /**
      * Get generated SQL string for the given `query`.
      * @param query - [Query object](query-format)
      */
-    sql(query: Query | Query[], options?: LoadMethodOptions, callback?: LoadMethodCallback<SqlQuery>): void;
+    sql(query: DeeplyReadonly<Query | Query[]>, options?: LoadMethodOptions, callback?: LoadMethodCallback<SqlQuery>): void;
 
     meta(options?: LoadMethodOptions): Promise<Meta>;
     /**
@@ -1051,11 +1097,11 @@ declare module '@cubejs-client/core' {
      */
     meta(options?: LoadMethodOptions, callback?: LoadMethodCallback<Meta>): void;
 
-    dryRun(query: Query | Query[], options?: LoadMethodOptions): Promise<DryRunResponse>;
+    dryRun(query: DeeplyReadonly<Query | Query[]>, options?: LoadMethodOptions): Promise<DryRunResponse>;
     /**
      * Get query related meta without query execution
      */
-    dryRun(query: Query | Query[], options: LoadMethodOptions, callback?: LoadMethodCallback<DryRunResponse>): void;
+    dryRun(query: DeeplyReadonly<Query | Query[]>, options: LoadMethodOptions, callback?: LoadMethodCallback<DryRunResponse>): void;
   }
 
   /**
@@ -1117,7 +1163,7 @@ declare module '@cubejs-client/core' {
   /**
    * @hidden
    */
-  export function isQueryPresent(query: Query | Query[] | null | undefined): boolean;
+  export function isQueryPresent(query: DeeplyReadonly<Query | Query[]> | null | undefined): boolean;
   export function movePivotItem(
     pivotConfig: PivotConfig,
     sourceIndex: number,
@@ -1130,7 +1176,7 @@ declare module '@cubejs-client/core' {
    */
   export function moveItemInArray<T = any>(list: T[], sourceIndex: number, destinationIndex: number): T[];
 
-  export function defaultOrder(query: Query): { [key: string]: QueryOrder };
+  export function defaultOrder(query: DeeplyReadonly<Query>): { [key: string]: QueryOrder };
 
   export interface TFlatFilter {
     /**
@@ -1164,9 +1210,9 @@ declare module '@cubejs-client/core' {
   /**
    * @hidden
    */
-  export function getQueryMembers(query: Query): string[];
+  export function getQueryMembers(query: DeeplyReadonly<Query>): string[];
 
-  export function areQueriesEqual(query1: Query | null, query2: Query | null): boolean;
+  export function areQueriesEqual(query1: DeeplyReadonly<Query> | null, query2: DeeplyReadonly<Query> | null): boolean;
 
   export type ProgressResponse = {
     stage: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cubejs-client/core",
-  "version": "0.29.51",
+  "version": "0.30.0",
   "engines": {},
   "repository": {
     "type": "git",
@@ -46,5 +46,5 @@
     "eslint-plugin-node": "^5.2.1",
     "jest": "^26.0.1"
   },
-  "gitHead": "44469b8ce956df50c2288194b550407bdb70c22d"
+  "gitHead": "bc4774e0945cdf0141e344657406115e8a4597f7"
 }

package/src/HttpTransport.js

@@ -40,9 +40,16 @@ class HttpTransport {
     });
 
     return {
+      /* eslint no-unsafe-finally: off */
       async subscribe(callback) {
-        const result = await runRequest();
-        return callback(result, () => this.subscribe(callback));
+        let result = {
+          error: 'network Error' // add default error message
+        };
+        try {
+          result = await runRequest();
+        } finally {
+          return callback(result, () => this.subscribe(callback));
+        }
       }
     };
   }

package/src/RequestError.js

@@ -1,6 +1,7 @@
 export default class RequestError extends Error {
-  constructor(message, response) {
+  constructor(message, response, status) {
     super(message);
     this.response = response;
+    this.status = status;
   }
 }

package/src/index.js

@@ -56,7 +56,7 @@ class CubejsApi {
     });
     this.pollInterval = options.pollInterval || 5;
     this.parseDateMeasures = options.parseDateMeasures;
-    
+
     this.updateAuthorizationPromise = null;
   }
 
@@ -73,7 +73,7 @@ class CubejsApi {
       callback = options;
       options = undefined;
     }
-    
+
     options = options || {};
 
     const mutexKey = options.mutexKey || 'default';
@@ -127,11 +127,11 @@ class CubejsApi {
         }
         return null;
       };
-      
+
       if (options.subscribe && !skipAuthorizationUpdate) {
         await this.updateTransportAuthorization();
       }
-      
+
       skipAuthorizationUpdate = false;
 
       if (response.status === 502) {
@@ -162,7 +162,7 @@ class CubejsApi {
           await requestInstance.unsubscribe();
         }
 
-        const error = new RequestError(body.error, body); // TODO error class
+        const error = new RequestError(body.error, body, response.status); // TODO error class
         if (callback) {
           callback(error);
         } else {
@@ -209,7 +209,7 @@ class CubejsApi {
       await this.updateAuthorizationPromise;
       return;
     }
-    
+
     if (typeof this.apiToken === 'function') {
       this.updateAuthorizationPromise = new Promise(async (resolve, reject) => {
         try {
@@ -224,7 +224,7 @@ class CubejsApi {
           this.updateAuthorizationPromise = null;
         }
       });
-      
+
       await this.updateAuthorizationPromise;
     }
   }
@@ -241,7 +241,12 @@ class CubejsApi {
       responseFormat === ResultType.COMPACT &&
       query.responseFormat !== ResultType.COMPACT
     ) {
-      query.responseFormat = ResultType.COMPACT;
+      return {
+        ...query,
+        responseFormat: ResultType.COMPACT,
+      };
+    } else {
+      return query;
     }
   }
 
@@ -287,11 +292,9 @@ class CubejsApi {
   load(query, options, callback, responseFormat = ResultType.DEFAULT) {
     if (responseFormat === ResultType.COMPACT) {
       if (Array.isArray(query)) {
-        query.forEach((q) => {
-          this.patchQueryInternal(q, ResultType.COMPACT);
-        });
+        query = query.map((q) => this.patchQueryInternal(q, ResultType.COMPACT));
       } else {
-        this.patchQueryInternal(query, ResultType.COMPACT);
+        query = this.patchQueryInternal(query, ResultType.COMPACT);
       }
     }
     return this.loadMethod(
@@ -318,11 +321,9 @@ class CubejsApi {
   subscribe(query, options, callback, responseFormat = ResultType.DEFAULT) {
     if (responseFormat === ResultType.COMPACT) {
       if (Array.isArray(query)) {
-        query.forEach((q) => {
-          this.patchQueryInternal(q, ResultType.COMPACT);
-        });
+        query = query.map((q) => this.patchQueryInternal(q, ResultType.COMPACT));
       } else {
-        this.patchQueryInternal(query, ResultType.COMPACT);
+        query = this.patchQueryInternal(query, ResultType.COMPACT);
       }
     }
     return this.loadMethod(