@cubejs-client/core 1.3.15 → 1.3.16

package/dist/test/granularity.test.js

@@ -0,0 +1,218 @@
+/* globals describe,test,expect */
+import 'jest';
+import dayjs from 'dayjs';
+import ko from 'dayjs/locale/ko';
+import ResultSet from '../src/ResultSet';
+describe('ResultSet Granularity', () => {
+    describe('chartPivot', () => {
+        test('week granularity', () => {
+            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: [],
+                        },
+                        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,
+                },
+            ]);
+        });
+        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: [],
+                        },
+                        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,
+                },
+            ]);
+        });
+    });
+});

package/dist/test/helpers.d.ts

@@ -0,0 +1,283 @@
+export declare const DescriptiveQueryRequest: {
+    timeDimensions: ({
+        dimension: string;
+        granularity: string;
+        dateRange?: undefined;
+    } | {
+        dimension: string;
+        dateRange: string[];
+        granularity?: undefined;
+    })[];
+    filters: {
+        member: string;
+        operator: string;
+    }[];
+    dimensions: string[];
+    measures: string[];
+    segments: string[];
+};
+export declare const DescriptiveQueryRequestCompact: {
+    timeDimensions: ({
+        dimension: string;
+        granularity: string;
+        dateRange?: undefined;
+    } | {
+        dimension: string;
+        dateRange: string[];
+        granularity?: undefined;
+    })[];
+    filters: {
+        member: string;
+        operator: string;
+    }[];
+    dimensions: string[];
+    measures: string[];
+    segments: string[];
+    responseFormat: string;
+};
+export declare const DescriptiveQueryResponse: {
+    queryType: string;
+    results: {
+        query: {
+            measures: string[];
+            dimensions: string[];
+            timeDimensions: ({
+                dimension: string;
+                granularity: string;
+                dateRange?: undefined;
+            } | {
+                dimension: string;
+                dateRange: string[];
+                granularity?: undefined;
+            })[];
+            segments: string[];
+            limit: number;
+            total: boolean;
+            timezone: string;
+            filters: {
+                member: string;
+                operator: string;
+            }[];
+            rowLimit: number;
+        };
+        lastRefreshTime: string;
+        refreshKeyValues: {
+            refresh_key: string;
+        }[][];
+        usedPreAggregations: {};
+        transformedQuery: {
+            sortedDimensions: string[];
+            sortedTimeDimensions: string[][];
+            timeDimensions: (string | null)[][];
+            measures: string[];
+            leafMeasureAdditive: boolean;
+            leafMeasures: string[];
+            measureToLeafMeasures: {
+                'base_orders.count': {
+                    measure: string;
+                    additive: boolean;
+                    type: string;
+                }[];
+            };
+            hasNoTimeDimensionsWithoutGranularity: boolean;
+            allFiltersWithinSelectedDimensions: boolean;
+            isAdditive: boolean;
+            granularityHierarchies: {
+                'line_items_to_orders.created_at.year': string[];
+                'line_items_to_orders.created_at.quarter': string[];
+                'line_items_to_orders.created_at.month': string[];
+                'line_items_to_orders.created_at.week': string[];
+                'line_items_to_orders.created_at.day': string[];
+                'line_items_to_orders.created_at.hour': string[];
+                'line_items_to_orders.created_at.minute': string[];
+                'line_items_to_orders.created_at.second': string[];
+                'orders_to_line_items.created_at.year': string[];
+                'orders_to_line_items.created_at.quarter': string[];
+                'orders_to_line_items.created_at.month': string[];
+                'orders_to_line_items.created_at.week': string[];
+                'orders_to_line_items.created_at.day': string[];
+                'orders_to_line_items.created_at.hour': string[];
+                'orders_to_line_items.created_at.minute': string[];
+                'orders_to_line_items.created_at.second': string[];
+                'orders_to_line_items.completed_at.year': string[];
+                'orders_to_line_items.completed_at.quarter': string[];
+                'orders_to_line_items.completed_at.month': string[];
+                'orders_to_line_items.completed_at.week': string[];
+                'orders_to_line_items.completed_at.day': string[];
+                'orders_to_line_items.completed_at.hour': string[];
+                'orders_to_line_items.completed_at.minute': string[];
+                'orders_to_line_items.completed_at.second': string[];
+                'products.created_at.year': string[];
+                'products.created_at.quarter': string[];
+                'products.created_at.month': string[];
+                'products.created_at.week': string[];
+                'products.created_at.day': string[];
+                'products.created_at.hour': string[];
+                'products.created_at.minute': string[];
+                'products.created_at.second': string[];
+                'simple_orders.created_at.year': string[];
+                'simple_orders.created_at.quarter': string[];
+                'simple_orders.created_at.month': string[];
+                'simple_orders.created_at.week': string[];
+                'simple_orders.created_at.day': string[];
+                'simple_orders.created_at.hour': string[];
+                'simple_orders.created_at.minute': string[];
+                'simple_orders.created_at.second': string[];
+                'simple_orders_sql_ext.created_at.year': string[];
+                'simple_orders_sql_ext.created_at.quarter': string[];
+                'simple_orders_sql_ext.created_at.month': string[];
+                'simple_orders_sql_ext.created_at.week': string[];
+                'simple_orders_sql_ext.created_at.day': string[];
+                'simple_orders_sql_ext.created_at.hour': string[];
+                'simple_orders_sql_ext.created_at.minute': string[];
+                'simple_orders_sql_ext.created_at.second': string[];
+                'users.created_at.year': string[];
+                'users.created_at.quarter': string[];
+                'users.created_at.month': string[];
+                'users.created_at.week': string[];
+                'users.created_at.day': string[];
+                'users.created_at.hour': string[];
+                'users.created_at.minute': string[];
+                'users.created_at.second': string[];
+                'base_orders.created_at.year': string[];
+                'base_orders.created_at.quarter': string[];
+                'base_orders.created_at.month': string[];
+                'base_orders.created_at.week': string[];
+                'base_orders.created_at.day': string[];
+                'base_orders.created_at.hour': string[];
+                'base_orders.created_at.minute': string[];
+                'base_orders.created_at.second': string[];
+                'base_orders.completed_at.year': string[];
+                'base_orders.completed_at.quarter': string[];
+                'base_orders.completed_at.month': string[];
+                'base_orders.completed_at.week': string[];
+                'base_orders.completed_at.day': string[];
+                'base_orders.completed_at.hour': string[];
+                'base_orders.completed_at.minute': string[];
+                'base_orders.completed_at.second': string[];
+                'base_orders.event_date.year': string[];
+                'base_orders.event_date.quarter': string[];
+                'base_orders.event_date.month': string[];
+                'base_orders.event_date.week': string[];
+                'base_orders.event_date.day': string[];
+                'base_orders.event_date.hour': string[];
+                'base_orders.event_date.minute': string[];
+                'base_orders.event_date.second': string[];
+                'base_orders.event_date.fiscal_year': string[];
+                'base_orders.event_date.fiscal_quarter': string[];
+                'check_dup_names.created_at.year': string[];
+                'check_dup_names.created_at.quarter': string[];
+                'check_dup_names.created_at.month': string[];
+                'check_dup_names.created_at.week': string[];
+                'check_dup_names.created_at.day': string[];
+                'check_dup_names.created_at.hour': string[];
+                'check_dup_names.created_at.minute': string[];
+                'check_dup_names.created_at.second': string[];
+            };
+            hasMultipliedMeasures: boolean;
+            hasCumulativeMeasures: boolean;
+            windowGranularity: null;
+            filterDimensionsSingleValueEqual: null;
+            ownedDimensions: string[];
+            ownedTimeDimensionsWithRollupGranularity: string[][];
+            ownedTimeDimensionsAsIs: (string | null)[][];
+            allBackAliasMembers: {};
+            ungrouped: null;
+            sortedUsedCubePrimaryKeys: null;
+            sortedAllCubeNames: null;
+            hasMultiStage: boolean;
+        };
+        requestId: string;
+        annotation: {
+            measures: {
+                'base_orders.count': {
+                    title: string;
+                    shortTitle: string;
+                    type: string;
+                    drillMembers: string[];
+                    drillMembersGrouped: {
+                        measures: never[];
+                        dimensions: string[];
+                    };
+                };
+            };
+            dimensions: {
+                'base_orders.status': {
+                    title: string;
+                    shortTitle: string;
+                    type: string;
+                    meta: {
+                        addDesc: string;
+                        moreNum: number;
+                    };
+                };
+            };
+            timeDimensions: {
+                'base_orders.created_at': {
+                    title: string;
+                    shortTitle: string;
+                    type: string;
+                };
+                'base_orders.created_at.month': {
+                    title: string;
+                    shortTitle: string;
+                    type: string;
+                    granularity: {
+                        name: string;
+                        title: string;
+                        interval: string;
+                    };
+                };
+            };
+            segments: {
+                'users.sf_users': {
+                    title: string;
+                    shortTitle: string;
+                };
+            };
+        };
+        dataSource: string;
+        dbType: string;
+        extDbType: string;
+        external: boolean;
+        slowQuery: boolean;
+        total: number;
+        data: {
+            'base_orders.created_at.month': string;
+            'base_orders.created_at': string;
+            'base_orders.count': string;
+            'base_orders.status': string;
+        }[];
+    }[];
+    pivotQuery: {
+        measures: string[];
+        dimensions: string[];
+        timeDimensions: ({
+            dimension: string;
+            granularity: string;
+            dateRange?: undefined;
+        } | {
+            dimension: string;
+            dateRange: string[];
+            granularity?: undefined;
+        })[];
+        segments: string[];
+        limit: number;
+        total: boolean;
+        timezone: string;
+        filters: {
+            member: string;
+            operator: string;
+        }[];
+        rowLimit: number;
+        queryType: string;
+    };
+    slowQuery: boolean;
+};
+export declare const NumericCastedData: {
+    'base_orders.count': number;
+    'base_orders.created_at.month': string;
+    'base_orders.created_at': string;
+    'base_orders.status': string;
+}[];
+//# sourceMappingURL=helpers.d.ts.map

package/dist/test/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../test/helpers.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;CA6BnC,CAAC;AAEF,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;CA8B1C,CAAC;AAEF,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA44BpC,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;;;GAG3B,CAAC"}