@cubejs-client/core 1.3.14 → 1.3.16

package/dist/src/time.d.ts

@@ -0,0 +1,70 @@
+import dayjs from 'dayjs';
+export type SqlInterval = string;
+export type ParsedInterval = Record<string, number>;
+export type Granularity = {
+    interval: SqlInterval;
+    origin?: string;
+    offset?: SqlInterval;
+};
+export type DayRange = {
+    by: (value: any) => dayjs.Dayjs[];
+    snapTo: (value: any) => DayRange;
+    start: dayjs.Dayjs;
+    end: dayjs.Dayjs;
+};
+export type TimeDimensionPredefinedGranularity = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
+export type TimeDimensionGranularity = TimeDimensionPredefinedGranularity | string;
+export type TGranularityMap = {
+    name: TimeDimensionGranularity | undefined;
+    title: string;
+};
+export declare const GRANULARITIES: TGranularityMap[];
+export declare const DEFAULT_GRANULARITY = "day";
+export declare const internalDayjs: (...args: any[]) => dayjs.Dayjs;
+export declare const TIME_SERIES: Record<string, (range: DayRange) => string[]>;
+export declare const isPredefinedGranularity: (granularity: TimeDimensionGranularity) => boolean;
+export declare const DateRegex: RegExp;
+export declare const LocalDateRegex: RegExp;
+export declare const dayRange: (from: any, to: any) => DayRange;
+/**
+ * Parse PostgreSQL-like interval string into object
+ * E.g. '2 years 15 months 100 weeks 99 hours 15 seconds'
+ * Negative units are also supported
+ * E.g. '-2 months 5 days -10 hours'
+ *
+ * TODO: It's copy/paste of parseSqlInterval from @cubejs-backend/shared [time.ts]
+ * It's not referenced to omit imports of moment.js staff.
+ * Probably one day we should choose one implementation and reuse it in other places.
+ */
+export declare function parseSqlInterval(intervalStr: SqlInterval): ParsedInterval;
+/**
+ * Adds interval to provided date.
+ * TODO: It's copy/paste of addInterval from @cubejs-backend/shared [time.ts]
+ * but operates with dayjs instead of moment.js
+ * @param {dayjs} date
+ * @param interval
+ * @returns {dayjs}
+ */
+export declare function addInterval(date: dayjs.Dayjs, interval: ParsedInterval): dayjs.Dayjs;
+/**
+ * Adds interval to provided date.
+ * TODO: It's copy/paste of subtractInterval from @cubejs-backend/shared [time.ts]
+ * but operates with dayjs instead of moment.js
+ * @param {dayjs} date
+ * @param interval
+ * @returns {dayjs}
+ */
+export declare function subtractInterval(date: dayjs.Dayjs, interval: ParsedInterval): dayjs.Dayjs;
+/**
+ * Returns the time series points for the custom interval
+ * TODO: It's almost a copy/paste of timeSeriesFromCustomInterval from
+ * @cubejs-backend/shared [time.ts] but operates with dayjs instead of moment.js
+ */
+export declare const timeSeriesFromCustomInterval: (from: string, to: string, granularity: Granularity) => string[];
+/**
+ * Returns the lowest time unit for the interval
+ */
+export declare const diffTimeUnitForInterval: (interval: string) => string;
+export declare const minGranularityForIntervals: (i1: string, i2: string) => string;
+export declare const granularityFor: (dateStr: string) => string;
+//# sourceMappingURL=time.d.ts.map

package/dist/src/time.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"time.d.ts","sourceRoot":"","sources":["../../src/time.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAU1B,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAGjC,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEpD,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,WAAW,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;IAClC,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,QAAQ,CAAC;IACjC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;IACnB,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAC5C,QAAQ,GACN,QAAQ,GACR,MAAM,GACN,KAAK,GACL,MAAM,GACN,OAAO,GACP,SAAS,GACT,MAAM,CAAC;AAEX,MAAM,MAAM,wBAAwB,GAAG,kCAAkC,GAAG,MAAM,CAAC;AAEnF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,wBAAwB,GAAG,SAAS,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,eAAe,EAU1C,CAAC;AAEF,eAAO,MAAM,mBAAmB,QAAQ,CAAC;AAIzC,eAAO,MAAM,aAAa,YAAa,GAAG,EAAE,KAAG,MAAM,KAAuD,CAAC;AAE7G,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,MAAM,EAAE,CAWrE,CAAC;AAEF,eAAO,MAAM,uBAAuB,gBAAiB,wBAAwB,KAAG,OAAqC,CAAC;AAEtH,eAAO,MAAM,SAAS,QAAyB,CAAC;AAChD,eAAO,MAAM,cAAc,QAAkD,CAAC;AAE9E,eAAO,MAAM,QAAQ,SAAU,GAAG,MAAM,GAAG,KAAG,QAiB5C,CAAC;AAEH;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc,CAczE;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,cAAc,GAAG,KAAK,CAAC,KAAK,CAQpF;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,cAAc,GAAG,KAAK,CAAC,KAAK,CAQzF;AA4CD;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,SAAU,MAAM,MAAM,MAAM,eAAe,WAAW,KAAG,MAAM,EAkBvG,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,aAAc,MAAM,KAAG,MAkB1D,CAAC;AAIF,eAAO,MAAM,0BAA0B,OAAQ,MAAM,MAAM,MAAM,KAAG,MAWnE,CAAC;AAEF,eAAO,MAAM,cAAc,YAAa,MAAM,KAAG,MA4DhD,CAAC"}

package/dist/src/time.js

@@ -0,0 +1,249 @@
+import dayjs from 'dayjs';
+import quarterOfYear from 'dayjs/plugin/quarterOfYear';
+import duration from 'dayjs/plugin/duration';
+import isoWeek from 'dayjs/plugin/isoWeek';
+import en from 'dayjs/locale/en';
+dayjs.extend(quarterOfYear);
+dayjs.extend(duration);
+dayjs.extend(isoWeek);
+export const GRANULARITIES = [
+    { name: undefined, title: 'w/o grouping' },
+    { name: 'second', title: 'Second' },
+    { name: 'minute', title: 'Minute' },
+    { name: 'hour', title: 'Hour' },
+    { name: 'day', title: 'Day' },
+    { name: 'week', title: 'Week' },
+    { name: 'month', title: 'Month' },
+    { name: 'quarter', title: 'Quarter' },
+    { name: 'year', title: 'Year' },
+];
+export const DEFAULT_GRANULARITY = 'day';
+// 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.
+export 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')),
+    year: (range) => range.snapTo('year').by('y').map(d => d.format('YYYY-01-01T00:00:00.000')),
+    hour: (range) => range.by('h').map(d => d.format('YYYY-MM-DDTHH:00:00.000')),
+    minute: (range) => range.by('m').map(d => d.format('YYYY-MM-DDTHH:mm:00.000')),
+    second: (range) => range.by('s').map(d => d.format('YYYY-MM-DDTHH:mm:ss.000')),
+    week: (range) => range.snapTo('week').by('w').map(d => d.startOf('week').format('YYYY-MM-DDT00:00:00.000')),
+    quarter: (range) => range.snapTo('quarter').by('quarter').map(d => d.startOf('quarter').format('YYYY-MM-DDT00:00:00.000')),
+};
+export const isPredefinedGranularity = (granularity) => !!TIME_SERIES[granularity];
+export const DateRegex = /^\d\d\d\d-\d\d-\d\d$/;
+export const LocalDateRegex = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z?$/;
+export const dayRange = (from, to) => ({
+    by: (value) => {
+        const results = [];
+        let start = internalDayjs(from);
+        const end = internalDayjs(to);
+        while (start.isBefore(end) || start.isSame(end)) {
+            results.push(start);
+            start = start.add(1, value);
+        }
+        return results;
+    },
+    snapTo: (value) => dayRange(internalDayjs(from).startOf(value), internalDayjs(to).endOf(value)),
+    start: internalDayjs(from),
+    end: internalDayjs(to),
+});
+/**
+ * Parse PostgreSQL-like interval string into object
+ * E.g. '2 years 15 months 100 weeks 99 hours 15 seconds'
+ * Negative units are also supported
+ * E.g. '-2 months 5 days -10 hours'
+ *
+ * TODO: It's copy/paste of parseSqlInterval from @cubejs-backend/shared [time.ts]
+ * It's not referenced to omit imports of moment.js staff.
+ * Probably one day we should choose one implementation and reuse it in other places.
+ */
+export function parseSqlInterval(intervalStr) {
+    const interval = {};
+    const parts = intervalStr.split(/\s+/);
+    for (let i = 0; i < parts.length; i += 2) {
+        const value = parseInt(parts[i], 10);
+        const unit = parts[i + 1];
+        // Remove ending 's' (e.g., 'days' -> 'day')
+        const singularUnit = unit.endsWith('s') ? unit.slice(0, -1) : unit;
+        interval[singularUnit] = value;
+    }
+    return interval;
+}
+/**
+ * Adds interval to provided date.
+ * TODO: It's copy/paste of addInterval from @cubejs-backend/shared [time.ts]
+ * but operates with dayjs instead of moment.js
+ * @param {dayjs} date
+ * @param interval
+ * @returns {dayjs}
+ */
+export function addInterval(date, interval) {
+    let res = date.clone();
+    Object.entries(interval).forEach(([key, value]) => {
+        res = res.add(value, key);
+    });
+    return res;
+}
+/**
+ * Adds interval to provided date.
+ * TODO: It's copy/paste of subtractInterval from @cubejs-backend/shared [time.ts]
+ * but operates with dayjs instead of moment.js
+ * @param {dayjs} date
+ * @param interval
+ * @returns {dayjs}
+ */
+export function subtractInterval(date, interval) {
+    let res = date.clone();
+    Object.entries(interval).forEach(([key, value]) => {
+        res = res.subtract(value, key);
+    });
+    return res;
+}
+/**
+ * Returns the closest date prior to date parameter aligned with the origin point
+ * TODO: It's copy/paste of alignToOrigin from @cubejs-backend/shared [time.ts]
+ * but operates with dayjs instead of moment.js
+ */
+function alignToOrigin(startDate, interval, origin) {
+    let alignedDate = startDate.clone();
+    let intervalOp;
+    let isIntervalNegative = false;
+    let offsetDate = addInterval(origin, interval);
+    // The easiest way to check the interval sign
+    if (offsetDate.isBefore(origin)) {
+        isIntervalNegative = true;
+    }
+    offsetDate = origin.clone();
+    if (startDate.isBefore(origin)) {
+        intervalOp = isIntervalNegative ? addInterval : subtractInterval;
+        while (offsetDate.isAfter(startDate)) {
+            offsetDate = intervalOp(offsetDate, interval);
+        }
+        alignedDate = offsetDate;
+    }
+    else {
+        intervalOp = isIntervalNegative ? subtractInterval : addInterval;
+        while (offsetDate.isBefore(startDate)) {
+            alignedDate = offsetDate.clone();
+            offsetDate = intervalOp(offsetDate, interval);
+        }
+        if (offsetDate.isSame(startDate)) {
+            alignedDate = offsetDate;
+        }
+    }
+    return alignedDate;
+}
+/**
+ * Returns the time series points for the custom interval
+ * TODO: It's almost a copy/paste of timeSeriesFromCustomInterval from
+ * @cubejs-backend/shared [time.ts] but operates with dayjs instead of moment.js
+ */
+export const timeSeriesFromCustomInterval = (from, to, granularity) => {
+    const intervalParsed = parseSqlInterval(granularity.interval);
+    const start = internalDayjs(from);
+    const end = internalDayjs(to);
+    let origin = granularity.origin ? internalDayjs(granularity.origin) : internalDayjs().startOf('year');
+    if (granularity.offset) {
+        origin = addInterval(origin, parseSqlInterval(granularity.offset));
+    }
+    let alignedStart = alignToOrigin(start, intervalParsed, origin);
+    const dates = [];
+    while (alignedStart.isBefore(end) || alignedStart.isSame(end)) {
+        dates.push(alignedStart.format('YYYY-MM-DDTHH:mm:ss.000'));
+        alignedStart = addInterval(alignedStart, intervalParsed);
+    }
+    return dates;
+};
+/**
+ * Returns the lowest time unit for the interval
+ */
+export const diffTimeUnitForInterval = (interval) => {
+    if (/second/i.test(interval)) {
+        return 'second';
+    }
+    else if (/minute/i.test(interval)) {
+        return 'minute';
+    }
+    else if (/hour/i.test(interval)) {
+        return 'hour';
+    }
+    else if (/day/i.test(interval)) {
+        return 'day';
+    }
+    else if (/week/i.test(interval)) {
+        return 'day';
+    }
+    else if (/month/i.test(interval)) {
+        return 'month';
+    }
+    else if (/quarter/i.test(interval)) {
+        return 'month';
+    }
+    else /* if (/year/i.test(interval)) */ {
+        return 'year';
+    }
+};
+const granularityOrder = ['year', 'quarter', 'month', 'week', 'day', 'hour', 'minute', 'second'];
+export const minGranularityForIntervals = (i1, i2) => {
+    const g1 = diffTimeUnitForInterval(i1);
+    const g2 = diffTimeUnitForInterval(i2);
+    const g1pos = granularityOrder.indexOf(g1);
+    const g2pos = granularityOrder.indexOf(g2);
+    if (g1pos > g2pos) {
+        return g1;
+    }
+    return g2;
+};
+export const granularityFor = (dateStr) => {
+    const dayjsDate = internalDayjs(dateStr);
+    const month = dayjsDate.month();
+    const date = dayjsDate.date();
+    const hours = dayjsDate.hour();
+    const minutes = dayjsDate.minute();
+    const seconds = dayjsDate.second();
+    const milliseconds = dayjsDate.millisecond();
+    const weekDay = dayjsDate.isoWeekday();
+    if (month === 0 &&
+        date === 1 &&
+        hours === 0 &&
+        minutes === 0 &&
+        seconds === 0 &&
+        milliseconds === 0) {
+        return 'year';
+    }
+    else if (date === 1 &&
+        hours === 0 &&
+        minutes === 0 &&
+        seconds === 0 &&
+        milliseconds === 0) {
+        return 'month';
+    }
+    else if (weekDay === 1 &&
+        hours === 0 &&
+        minutes === 0 &&
+        seconds === 0 &&
+        milliseconds === 0) {
+        return 'week';
+    }
+    else if (hours === 0 &&
+        minutes === 0 &&
+        seconds === 0 &&
+        milliseconds === 0) {
+        return 'day';
+    }
+    else if (minutes === 0 &&
+        seconds === 0 &&
+        milliseconds === 0) {
+        return 'hour';
+    }
+    else if (seconds === 0 &&
+        milliseconds === 0) {
+        return 'minute';
+    }
+    else if (milliseconds === 0) {
+        return 'second';
+    }
+    return 'second'; // TODO return 'millisecond';
+};