@lightdash/common 0.2385.1 → 0.2386.0

package/dist/esm/types/periodOverPeriodComparison.d.ts

@@ -1,3 +1,5 @@
+import { type Metric } from './field';
+import { type AdditionalMetric } from './metricQuery';
 import { TimeFrames } from './timeFrames';
 type PreviousPeriod = {
     type: 'previousPeriod';
@@ -14,5 +16,16 @@ export declare const validPeriodOverPeriodGranularities: TimeFrames[];
 export declare const periodOverPeriodGranularityLabels: Record<TimeFrames, string>;
 export declare const isSupportedPeriodOverPeriodGranularity: (granularity: TimeFrames) => boolean;
 export declare const buildPopAdditionalMetricName: (baseMetricName: string) => string;
+export declare const getPopPeriodLabel: (granularity: TimeFrames, periodOffset: number) => string;
+export declare const buildPopAdditionalMetric: ({ metric, timeDimensionId, granularity, periodOffset, }: {
+    metric: Pick<Metric, "table" | "name" | "label" | "description" | "type" | "sql" | "round" | "compact" | "format">;
+    timeDimensionId: string;
+    granularity: TimeFrames;
+    periodOffset: number;
+}) => {
+    additionalMetric: AdditionalMetric;
+    metricId: string;
+};
+export declare const getGranularityRank: (granularity: TimeFrames) => number;
 export {};
 //# sourceMappingURL=periodOverPeriodComparison.d.ts.map

package/dist/esm/types/periodOverPeriodComparison.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"periodOverPeriodComparison.d.ts","sourceRoot":"","sources":["../../../src/types/periodOverPeriodComparison.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,KAAK,cAAc,GAAG;IAClB,IAAI,EAAE,gBAAgB,CAAC;IACvB,WAAW,EAAE,UAAU,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,cAAc,GAAG;IAEtD,KAAK,EAAE;QACH,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACjB,CAAC;CACL,CAAC;AAEF,eAAO,MAAM,kCAAkC,cAM9C,CAAC;AAEF,eAAO,MAAM,iCAAiC,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,CAuBxE,CAAC;AAEF,eAAO,MAAM,sCAAsC,gBAClC,UAAU,YACkC,CAAC;AAE9D,eAAO,MAAM,4BAA4B,mBAAoB,MAAM,WACvC,CAAC"}
+{"version":3,"file":"periodOverPeriodComparison.d.ts","sourceRoot":"","sources":["../../../src/types/periodOverPeriodComparison.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,KAAK,cAAc,GAAG;IAClB,IAAI,EAAE,gBAAgB,CAAC;IACvB,WAAW,EAAE,UAAU,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,cAAc,GAAG;IAEtD,KAAK,EAAE;QACH,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACjB,CAAC;CACL,CAAC;AAEF,eAAO,MAAM,kCAAkC,cAM9C,CAAC;AAEF,eAAO,MAAM,iCAAiC,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,CAuBxE,CAAC;AAEF,eAAO,MAAM,sCAAsC,gBAClC,UAAU,YACkC,CAAC;AAE9D,eAAO,MAAM,4BAA4B,mBAAoB,MAAM,WACvC,CAAC;AAE7B,eAAO,MAAM,iBAAiB,gBACb,UAAU,gBACT,MAAM,WAMvB,CAAC;AAEF,eAAO,MAAM,wBAAwB,4DAKlC;IACC,MAAM,EAAE,IAAI,CACR,MAAM,EACJ,OAAO,GACP,MAAM,GACN,OAAO,GACP,aAAa,GACb,MAAM,GACN,KAAK,GACL,OAAO,GACP,SAAS,GACT,QAAQ,CACb,CAAC;IACF,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,UAAU,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;CACxB,KAAG;IAAE,gBAAgB,EAAE,gBAAgB,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CA4BzD,CAAC;AAWF,eAAO,MAAM,kBAAkB,gBAAiB,UAAU,KAAG,MAG5D,CAAC"}

package/dist/esm/types/periodOverPeriodComparison.js

@@ -1,3 +1,6 @@
+import { v4 as uuidv4 } from 'uuid';
+import { getItemId } from '../utils/item';
+import { timeFrameConfigs } from '../utils/timeFrames';
 import { TimeFrames } from './timeFrames';
 export const validPeriodOverPeriodGranularities = [
     TimeFrames.DAY,
@@ -32,4 +35,46 @@ export const periodOverPeriodGranularityLabels = {
 };
 export const isSupportedPeriodOverPeriodGranularity = (granularity) => validPeriodOverPeriodGranularities.includes(granularity);
 export const buildPopAdditionalMetricName = (baseMetricName) => `${baseMetricName}__pop`;
+export const getPopPeriodLabel = (granularity, periodOffset) => {
+    const label = timeFrameConfigs[granularity]?.getLabel() || granularity;
+    return periodOffset === 1
+        ? `Previous ${String(label).toLowerCase()}`
+        : `${periodOffset} ${String(label).toLowerCase()}s ago`;
+};
+export const buildPopAdditionalMetric = ({ metric, timeDimensionId, granularity, periodOffset, }) => {
+    const baseMetricId = getItemId(metric);
+    const popName = buildPopAdditionalMetricName(metric.name);
+    const popMetricId = getItemId({ table: metric.table, name: popName });
+    const additionalMetric = {
+        uuid: uuidv4(),
+        table: metric.table,
+        name: popName,
+        label: `${metric.label} (${getPopPeriodLabel(granularity, periodOffset)})`,
+        description: metric.description,
+        type: metric.type,
+        sql: metric.sql,
+        hidden: true,
+        round: metric.round,
+        compact: metric.compact,
+        format: metric.format,
+        generationType: 'periodOverPeriod',
+        baseMetricId,
+        timeDimensionId,
+        granularity,
+        periodOffset,
+    };
+    return { additionalMetric, metricId: popMetricId };
+};
+// Granularity order from finest to coarsest (lower index = finer)
+const GRANULARITY_ORDER = [
+    TimeFrames.DAY,
+    TimeFrames.WEEK,
+    TimeFrames.MONTH,
+    TimeFrames.QUARTER,
+    TimeFrames.YEAR,
+];
+export const getGranularityRank = (granularity) => {
+    const index = GRANULARITY_ORDER.indexOf(granularity);
+    return index === -1 ? Infinity : index;
+};
 //# sourceMappingURL=periodOverPeriodComparison.js.map

package/dist/esm/types/periodOverPeriodComparison.js.map

@@ -1 +1 @@
-{"version":3,"file":"periodOverPeriodComparison.js","sourceRoot":"","sources":["../../../src/types/periodOverPeriodComparison.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAgB1C,MAAM,CAAC,MAAM,kCAAkC,GAAG;IAC9C,UAAU,CAAC,GAAG;IACd,UAAU,CAAC,IAAI;IACf,UAAU,CAAC,KAAK;IAChB,UAAU,CAAC,OAAO;IAClB,UAAU,CAAC,IAAI;CAClB,CAAC;AAEF,MAAM,CAAC,MAAM,iCAAiC,GAA+B;IACzE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM;IACzB,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,SAAS;IAC/B,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,OAAO;IAC3B,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM;IACzB,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,KAAK;IACvB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM;IACzB,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,QAAQ;IAC7B,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,QAAQ;IAC7B,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,aAAa;IACvC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,KAAK;IACvB,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE,mBAAmB;IACnD,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,cAAc;IAC7C,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,aAAa;IAC3C,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,aAAa;IACpC,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,cAAc;IACtC,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,gBAAgB;IAC1C,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,aAAa;IACpC,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,kBAAkB;IACjD,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,YAAY;IACrC,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,cAAc;IACzC,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,aAAa;IAC3C,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,gBAAgB;CACpD,CAAC;AAEF,MAAM,CAAC,MAAM,sCAAsC,GAAG,CAClD,WAAuB,EACzB,EAAE,CAAC,kCAAkC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AAE9D,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,cAAsB,EAAE,EAAE,CACnE,GAAG,cAAc,OAAO,CAAC"}
+{"version":3,"file":"periodOverPeriodComparison.js","sourceRoot":"","sources":["../../../src/types/periodOverPeriodComparison.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGvD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAgB1C,MAAM,CAAC,MAAM,kCAAkC,GAAG;IAC9C,UAAU,CAAC,GAAG;IACd,UAAU,CAAC,IAAI;IACf,UAAU,CAAC,KAAK;IAChB,UAAU,CAAC,OAAO;IAClB,UAAU,CAAC,IAAI;CAClB,CAAC;AAEF,MAAM,CAAC,MAAM,iCAAiC,GAA+B;IACzE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM;IACzB,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,SAAS;IAC/B,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,OAAO;IAC3B,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM;IACzB,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,KAAK;IACvB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM;IACzB,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,QAAQ;IAC7B,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,QAAQ;IAC7B,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,aAAa;IACvC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,KAAK;IACvB,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE,mBAAmB;IACnD,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,cAAc;IAC7C,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,aAAa;IAC3C,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,aAAa;IACpC,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,cAAc;IACtC,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,gBAAgB;IAC1C,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,aAAa;IACpC,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,kBAAkB;IACjD,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,YAAY;IACrC,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,cAAc;IACzC,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,aAAa;IAC3C,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,gBAAgB;CACpD,CAAC;AAEF,MAAM,CAAC,MAAM,sCAAsC,GAAG,CAClD,WAAuB,EACzB,EAAE,CAAC,kCAAkC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AAE9D,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,cAAsB,EAAE,EAAE,CACnE,GAAG,cAAc,OAAO,CAAC;AAE7B,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC7B,WAAuB,EACvB,YAAoB,EACtB,EAAE;IACA,MAAM,KAAK,GAAG,gBAAgB,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,IAAI,WAAW,CAAC;IACvE,OAAO,YAAY,KAAK,CAAC;QACrB,CAAC,CAAC,YAAY,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE;QAC3C,CAAC,CAAC,GAAG,YAAY,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC;AAChE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,EACrC,MAAM,EACN,eAAe,EACf,WAAW,EACX,YAAY,GAiBf,EAA4D,EAAE;IAC3D,MAAM,YAAY,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,OAAO,GAAG,4BAA4B,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1D,MAAM,WAAW,GAAG,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAEtE,MAAM,gBAAgB,GAAqB;QACvC,IAAI,EAAE,MAAM,EAAE;QACd,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,GAAG,MAAM,CAAC,KAAK,KAAK,iBAAiB,CACxC,WAAW,EACX,YAAY,CACf,GAAG;QACJ,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,MAAM,EAAE,IAAI;QACZ,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,cAAc,EAAE,kBAAkB;QAClC,YAAY;QACZ,eAAe;QACf,WAAW;QACX,YAAY;KACf,CAAC;IAEF,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACvD,CAAC,CAAC;AAEF,kEAAkE;AAClE,MAAM,iBAAiB,GAAiB;IACpC,UAAU,CAAC,GAAG;IACd,UAAU,CAAC,IAAI;IACf,UAAU,CAAC,KAAK;IAChB,UAAU,CAAC,OAAO;IAClB,UAAU,CAAC,IAAI;CAClB,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,WAAuB,EAAU,EAAE;IAClE,MAAM,KAAK,GAAG,iBAAiB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACrD,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;AAC3C,CAAC,CAAC"}