@cubejs-client/core 0.28.45 → 0.29.8

package/index.d.ts

@@ -8,6 +8,7 @@
  */
 
 declare module '@cubejs-client/core' {
+
   export type TransportOptions = {
     /**
      * [jwt auth token](security)
@@ -714,28 +715,34 @@ declare module '@cubejs-client/core' {
   }
 
   export type Filter = BinaryFilter | UnaryFilter | LogicalOrFilter | LogicalAndFilter;
-  type LogicalAndFilter = {
+  export type LogicalAndFilter = {
     and: (BinaryFilter | UnaryFilter | LogicalOrFilter)[];
   };
 
-  type LogicalOrFilter = {
+  export type LogicalOrFilter = {
     or: (BinaryFilter | UnaryFilter | LogicalAndFilter)[];
   };
 
-  type BinaryFilter = {
+  export interface BinaryFilter {
+    /**
+     * @deprecated Use `member` instead.
+     */
     dimension?: string;
     member?: string;
     operator: BinaryOperator;
     values: string[];
-  };
-  type UnaryFilter = {
+  }
+  export interface UnaryFilter {
+    /**
+     * @deprecated Use `member` instead.
+     */
     dimension?: string;
     member?: string;
     operator: UnaryOperator;
     values?: never;
-  };
-  type UnaryOperator = 'set' | 'notSet';
-  type BinaryOperator =
+  }
+  export type UnaryOperator = 'set' | 'notSet';
+  export type BinaryOperator =
     | 'equals'
     | 'notEquals'
     | 'contains'
@@ -753,10 +760,10 @@ declare module '@cubejs-client/core' {
 
   export type DateRange = string | [string, string];
 
-  export type TimeDimensionBase = {
+  export interface TimeDimensionBase {
     dimension: string;
     granularity?: TimeDimensionGranularity;
-  };
+  }
 
   type TimeDimensionComparisonFields = {
     compareDateRange: Array<DateRange>;
@@ -771,7 +778,7 @@ declare module '@cubejs-client/core' {
 
   export type TimeDimension = TimeDimensionComparison | TimeDimensionRanged;
 
-  export type Query = {
+  export interface Query {
     measures?: string[];
     dimensions?: string[];
     filters?: Filter[];
@@ -783,7 +790,7 @@ declare module '@cubejs-client/core' {
     timezone?: string;
     renewQuery?: boolean;
     ungrouped?: boolean;
-  };
+  }
 
   export class ProgressResult {
     stage(): string;
@@ -825,6 +832,7 @@ declare module '@cubejs-client/core' {
     title: string;
     shortTitle: string;
     isVisible?: boolean;
+    meta?: any;
   };
 
   export type BaseCubeMember = {
@@ -1105,12 +1113,15 @@ declare module '@cubejs-client/core' {
 
   export function defaultOrder(query: Query): { [key: string]: QueryOrder };
 
-  type TFlatFilter = {
+  export interface TFlatFilter {
+    /**
+     * @deprecated Use `member` instead.
+     */
     dimension?: string;
     member?: string;
     operator: BinaryOperator;
     values: string[];
-  };
+  }
 
   /**
    * @hidden
@@ -1143,3 +1154,5 @@ declare module '@cubejs-client/core' {
     timeElapsed: number;
   };
 }
+
+import '@cubejs-client/dx';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cubejs-client/core",
-  "version": "0.28.45",
+  "version": "0.29.8",
   "engines": {},
   "repository": {
     "type": "git",
@@ -14,6 +14,7 @@
   "author": "Cube Dev, Inc.",
   "dependencies": {
     "@babel/runtime": "^7.1.2",
+    "@cubejs-client/dx": "^0.29.5",
     "core-js": "^3.6.5",
     "cross-fetch": "^3.0.2",
     "dayjs": "^1.10.4",
@@ -45,5 +46,5 @@
     "eslint-plugin-node": "^5.2.1",
     "jest": "^26.0.1"
   },
-  "gitHead": "5d3def74d8e2b029706358b6a3ca4c21a02ed497"
+  "gitHead": "2bd982f9f7aff8afc071c01015306421a2cd7739"
 }

package/src/ResultSet.js

@@ -9,12 +9,12 @@ import {
 
 import { aliasSeries } from './utils';
 
-dayjs.locale({
-  ...en,
-  weekStart: 1,
-});
 dayjs.extend(quarterOfYear);
 
+// When granularity is week, weekStart Value must be 1. However, since the client can change it globally (https://day.js.org/docs/en/i18n/changing-locale)
+// So the function below has been added.
+const internalDayjs = (...args) => dayjs(...args).locale({ ...en, weekStart: 1 });
+
 export const TIME_SERIES = {
   day: (range) => range.by('d').map(d => d.format('YYYY-MM-DDT00:00:00.000')),
   month: (range) => range.snapTo('month').by('M').map(d => d.format('YYYY-MM-01T00:00:00.000')),
@@ -60,8 +60,8 @@ export const dayRange = (from, to) => ({
   by: (value) => {
     const results = [];
 
-    let start = dayjs(from);
-    const end = dayjs(to);
+    let start = internalDayjs(from);
+    const end = internalDayjs(to);
 
     while (start.isBefore(end) || start.isSame(end)) {
       results.push(start);
@@ -70,9 +70,9 @@ export const dayRange = (from, to) => ({
 
     return results;
   },
-  snapTo: (value) => dayRange(dayjs(from).startOf(value), dayjs(to).endOf(value)),
-  start: dayjs(from),
-  end: dayjs(to),
+  snapTo: (value) => dayRange(internalDayjs(from).startOf(value), internalDayjs(to).endOf(value)),
+  start: internalDayjs(from),
+  end: internalDayjs(to),
 });
 
 export const QUERY_TYPE = {
@@ -318,7 +318,7 @@ class ResultSet {
     if (!dateRange) {
       const member = ResultSet.timeDimensionMember(timeDimension);
       const dates = pipe(
-        map(row => row[member] && dayjs(row[member])),
+        map(row => row[member] && internalDayjs(row[member])),
         filter(Boolean)
       )(this.timeDimensionBackwardCompatibleData(resultIndex));
 
@@ -355,7 +355,7 @@ class ResultSet {
     const pivotImpl = (resultIndex = 0) => {
       let groupByXAxis = groupByToPairs(({ xValues }) => this.axisValuesString(xValues));
 
-      let measureValue = (row, measure) => row[measure];
+      const measureValue = (row, measure) => row[measure] || 0;
 
       if (
         pivotConfig.fillMissingDates &&
@@ -379,8 +379,6 @@ class ResultSet {
             );
             return series[resultIndex].map(d => [d, byXValues[d] || [{ xValues: [d], row: {} }]]);
           };
-
-          measureValue = (row, measure) => row[measure] || 0;
         }
       }
 

package/src/tests/ResultSet.test.js

@@ -187,7 +187,7 @@ describe('ResultSet', () => {
         {
           x: 'Name 1',
           
-          'Foo.count': null,
+          'Foo.count': 0,
           xValues: [
             'Name 1'
           ],
@@ -235,8 +235,7 @@ describe('ResultSet', () => {
       expect(resultSet.chartPivot()).toEqual([
         {
           x: 'Name 1',
-          
-          'Foo.count': undefined,
+          'Foo.count': 0,
           xValues: [
             'Name 1'
           ],

package/src/tests/data-blending.test.js

@@ -255,11 +255,14 @@ describe('data blending', () => {
         xValues: ['2020-08-01T00:00:00.000'],
         'Orders.count': 1,
         'Australia,Users.count': 20,
+        'Italy,Users.count': 0,
+        'Spain,Users.count': 0
       },
       {
         x: '2020-08-02T00:00:00.000',
         xValues: ['2020-08-02T00:00:00.000'],
         'Orders.count': 2,
+        'Australia,Users.count': 0,
         'Spain,Users.count': 34,
         'Italy,Users.count': 18,
       },

package/src/tests/granularity.test.js

@@ -1,5 +1,6 @@
 import 'jest';
-
+import dayjs from 'dayjs';
+import ko from 'dayjs/locale/ko';
 import ResultSet from '../ResultSet';
 
 describe('ResultSet Granularity', () => {
@@ -110,5 +111,113 @@ describe('ResultSet Granularity', () => {
         },
       ]);
     });
+
+    test('week granularity in other locale', () => {
+      dayjs.locale(ko);
+      const result = new ResultSet({
+        queryType: 'regularQuery',
+        results: [
+          {
+            query: {
+              measures: ['LineItems.count'],
+              timeDimensions: [
+                {
+                  dimension: 'LineItems.createdAt',
+                  granularity: 'week',
+                  dateRange: ['2019-01-08T00:00:00.000', '2019-01-18T00:00:00.000'],
+                },
+              ],
+              filters: [
+                {
+                  operator: 'equals',
+                  values: ['us-ut'],
+                  member: 'Users.state',
+                },
+              ],
+              limit: 2,
+              rowLimit: 2,
+              timezone: 'UTC',
+              order: [],
+              dimensions: [],
+              queryType: 'regularQuery',
+            },
+            data: [
+              {
+                'LineItems.createdAt.week': '2019-01-07T00:00:00.000',
+                'LineItems.createdAt': '2019-01-07T00:00:00.000',
+                'LineItems.count': '2',
+              },
+            ],
+            lastRefreshTime: '2021-07-07T14:31:30.458Z',
+            annotation: {
+              measures: {
+                'LineItems.count': {
+                  title: 'Line Items Count',
+                  shortTitle: 'Count',
+                  type: 'number',
+                  drillMembers: ['LineItems.id', 'LineItems.createdAt'],
+                  drillMembersGrouped: {
+                    measures: [],
+                    dimensions: ['LineItems.id', 'LineItems.createdAt'],
+                  },
+                },
+              },
+              dimensions: {},
+              segments: {},
+              timeDimensions: {
+                'LineItems.createdAt.week': {
+                  title: 'Line Items Created at',
+                  shortTitle: 'Created at',
+                  type: 'time',
+                },
+                'LineItems.createdAt': {
+                  title: 'Line Items Created at',
+                  shortTitle: 'Created at',
+                  type: 'time',
+                },
+              },
+            },
+            slowQuery: false,
+          },
+        ],
+        pivotQuery: {
+          measures: ['LineItems.count'],
+          timeDimensions: [
+            {
+              dimension: 'LineItems.createdAt',
+              granularity: 'week',
+              dateRange: ['2019-01-08T00:00:00.000', '2019-01-18T00:00:00.000'],
+            },
+          ],
+          filters: [
+            {
+              operator: 'equals',
+              values: ['us-ut'],
+              member: 'Users.state',
+            },
+          ],
+          limit: 2,
+          rowLimit: 2,
+          timezone: 'UTC',
+          order: [],
+          dimensions: [],
+          queryType: 'regularQuery',
+        },
+        slowQuery: false,
+      });
+
+      expect(result.chartPivot()).toStrictEqual([
+        {
+          x: '2019-01-07T00:00:00.000',
+          xValues: ['2019-01-07T00:00:00.000'],
+          'LineItems.count': 2,
+        },
+        {
+          x: '2019-01-14T00:00:00.000',
+          xValues: ['2019-01-14T00:00:00.000'],
+          'LineItems.count': 0,
+        },
+      ]);
+    });
   });
 });