@cubejs-client/core 0.28.35 → 0.28.52

package/index.d.ts

@@ -94,6 +94,10 @@ declare module '@cubejs-client/core' {
      * Pass `true` to use continuous fetch behavior.
      */
     subscribe?: boolean;
+    /**
+     * A Cube.js API instance. If not provided will be taken from `CubeProvider`
+     */
+    cubejsApi?: CubejsApi;
     /**
      * Function that receives `ProgressResult` on each `Continue wait` message.
      */
@@ -144,7 +148,7 @@ declare module '@cubejs-client/core' {
   type UsedPreAggregation = {
     targetTableName: string;
     type: PreAggregationType;
-  }
+  };
 
   type LoadResponseResult<T> = {
     annotation: QueryAnnotations;
@@ -154,6 +158,7 @@ declare module '@cubejs-client/core' {
     external: boolean | null;
     dbType: string;
     extDbType: string;
+    requestId?: string,
     usedPreAggregations?: Record<string, UsedPreAggregation>;
     transformedQuery?: TransformedQuery;
   };
@@ -710,11 +715,11 @@ declare module '@cubejs-client/core' {
 
   export type Filter = BinaryFilter | UnaryFilter | LogicalOrFilter | LogicalAndFilter;
   type LogicalAndFilter = {
-    and: (BinaryFilter | UnaryFilter | LogicalOrFilter)[]
+    and: (BinaryFilter | UnaryFilter | LogicalOrFilter)[];
   };
 
   type LogicalOrFilter = {
-    or: (BinaryFilter | UnaryFilter | LogicalAndFilter)[]
+    or: (BinaryFilter | UnaryFilter | LogicalAndFilter)[];
   };
 
   type BinaryFilter = {
@@ -812,14 +817,25 @@ declare module '@cubejs-client/core' {
 
   type TCubeMemberType = 'time' | 'number' | 'string' | 'boolean';
 
+  // @see BaseCubeMember
+  // @depreacated
   export type TCubeMember = {
     type: TCubeMemberType;
     name: string;
     title: string;
     shortTitle: string;
+    isVisible?: boolean;
+  };
+
+  export type BaseCubeMember = {
+    type: TCubeMemberType;
+    name: string;
+    title: string;
+    shortTitle: string;
+    isVisible?: boolean;
   };
 
-  export type TCubeMeasure = TCubeMember & {
+  export type TCubeMeasure = BaseCubeMember & {
     aggType: 'count' | 'number';
     cumulative: boolean;
     cumulativeTotal: boolean;
@@ -830,11 +846,11 @@ declare module '@cubejs-client/core' {
     };
   };
 
-  export type TCubeDimension = TCubeMember & {
+  export type TCubeDimension = BaseCubeMember & {
     suggestFilterValues: boolean;
   };
 
-  export type TCubeSegment = Pick<TCubeMember, 'name' | 'shortTitle' | 'title'>;
+  export type TCubeSegment = Omit<BaseCubeMember, 'type'>;
 
   type TCubeMemberByType<T> = T extends 'measures'
     ? TCubeMeasure
@@ -844,6 +860,8 @@ declare module '@cubejs-client/core' {
     ? TCubeSegment
     : never;
 
+  export type CubeMember = TCubeMeasure | TCubeDimension | TCubeSegment;
+
   /**
    * @deprecated use DryRunResponse
    */
@@ -852,7 +870,7 @@ declare module '@cubejs-client/core' {
     normalizedQueries: Query[];
     pivotQuery: PivotQuery;
     queryOrder: Array<{ [k: string]: QueryOrder }>;
-    transformedQueries: TransformedQuery[]
+    transformedQueries: TransformedQuery[];
   };
 
   export type DryRunResponse = {
@@ -860,6 +878,7 @@ declare module '@cubejs-client/core' {
     normalizedQueries: Query[];
     pivotQuery: PivotQuery;
     queryOrder: Array<{ [k: string]: QueryOrder }>;
+    transformedQueries: TransformedQuery[];
   };
 
   export type Cube = {
@@ -928,6 +947,9 @@ declare module '@cubejs-client/core' {
     ): { title: string; error: string } | TCubeMemberByType<T>;
     defaultTimeDimensionNameFor(memberName: string): string;
     filterOperatorsForMember(memberName: string, memberType: MemberType | MemberType[]): FilterOperator[];
+
+    // todo: types
+    membersGroupedByCube(): any;
   }
 
   /**
@@ -1068,7 +1090,7 @@ declare module '@cubejs-client/core' {
   /**
    * @hidden
    */
-  export function isQueryPresent(query: Query | Query[]): boolean;
+  export function isQueryPresent(query: Query | Query[] | null | undefined): boolean;
   export function movePivotItem(
     pivotConfig: PivotConfig,
     sourceIndex: number,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cubejs-client/core",
-  "version": "0.28.35",
+  "version": "0.28.52",
   "engines": {},
   "repository": {
     "type": "git",
@@ -45,5 +45,5 @@
     "eslint-plugin-node": "^5.2.1",
     "jest": "^26.0.1"
   },
-  "gitHead": "34bfc75296e9b265c55233e432a41c3017496e45"
+  "gitHead": "22f1fcf3dc77d5784eda6b8eff8bcd430652cc69"
 }

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));
 

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,
+        },
+      ]);
+    });
   });
 });