@lightdash/common 0.2383.0 → 0.2385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/.tsbuildinfo +1 -1
- package/dist/cjs/types/metricQuery.d.ts +22 -0
- package/dist/cjs/types/metricQuery.d.ts.map +1 -1
- package/dist/cjs/types/metricQuery.js.map +1 -1
- package/dist/esm/.tsbuildinfo +1 -1
- package/dist/esm/types/metricQuery.d.ts +22 -0
- package/dist/esm/types/metricQuery.d.ts.map +1 -1
- package/dist/esm/types/metricQuery.js.map +1 -1
- package/dist/types/.tsbuildinfo +1 -1
- package/dist/types/types/metricQuery.d.ts +22 -0
- package/dist/types/types/metricQuery.d.ts.map +1 -1
- package/dist/types/types/metricQuery.js.map +1 -1
- package/package.json +1 -1
|
@@ -3,6 +3,7 @@ import { type DateZoom } from './api/paginatedQuery';
|
|
|
3
3
|
import { type CompactOrAlias, type CompiledCustomDimension, type CompiledDimension, type CompiledMetric, type CompiledTableCalculation, type CustomDimension, type CustomFormat, type Dimension, type FieldId, type Format, type Metric, type MetricType, type TableCalculation } from './field';
|
|
4
4
|
import { type Filters, type MetricFilterRule } from './filter';
|
|
5
5
|
import { type PeriodOverPeriodComparison } from './periodOverPeriodComparison';
|
|
6
|
+
import { type TimeFrames } from './timeFrames';
|
|
6
7
|
export interface AdditionalMetric {
|
|
7
8
|
label?: string;
|
|
8
9
|
type: MetricType;
|
|
@@ -20,6 +21,27 @@ export interface AdditionalMetric {
|
|
|
20
21
|
uuid?: string | null;
|
|
21
22
|
percentile?: number;
|
|
22
23
|
formatOptions?: CustomFormat;
|
|
24
|
+
/**
|
|
25
|
+
* Optional marker for metrics generated by the system.
|
|
26
|
+
* Currently used for Period-over-Period (PoP) previous-period metrics.
|
|
27
|
+
*/
|
|
28
|
+
generationType?: 'periodOverPeriod';
|
|
29
|
+
/**
|
|
30
|
+
* For PoP-generated metrics, the base metric id that this metric is derived from.
|
|
31
|
+
*/
|
|
32
|
+
baseMetricId?: FieldId;
|
|
33
|
+
/**
|
|
34
|
+
* For PoP-generated metrics, the time dimension id used for the comparison.
|
|
35
|
+
*/
|
|
36
|
+
timeDimensionId?: FieldId;
|
|
37
|
+
/**
|
|
38
|
+
* For PoP-generated metrics, the granularity used for the comparison.
|
|
39
|
+
*/
|
|
40
|
+
granularity?: TimeFrames;
|
|
41
|
+
/**
|
|
42
|
+
* For PoP-generated metrics, the number of periods to offset by (>= 1).
|
|
43
|
+
*/
|
|
44
|
+
periodOffset?: number;
|
|
23
45
|
}
|
|
24
46
|
export declare const isAdditionalMetric: (value: AnyType) => value is AdditionalMetric;
|
|
25
47
|
export declare const hasFormatOptions: (value: AnyType) => value is {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metricQuery.d.ts","sourceRoot":"","sources":["../../../src/types/metricQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,OAAO,CAAC;AACrC,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAMH,KAAK,cAAc,EACnB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,wBAAwB,EAC7B,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,OAAO,EACZ,KAAK,MAAM,EACX,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,gBAAgB,EACxB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,KAAK,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;
|
|
1
|
+
{"version":3,"file":"metricQuery.d.ts","sourceRoot":"","sources":["../../../src/types/metricQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,OAAO,CAAC;AACrC,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAMH,KAAK,cAAc,EACnB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,wBAAwB,EAC7B,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,OAAO,EACZ,KAAK,MAAM,EACX,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,gBAAgB,EACxB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,KAAK,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,WAAW,gBAAgB;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B;;;OAGG;IACH,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC;IACzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,eAAO,MAAM,kBAAkB,UAAW,OAAO,KAAG,KAAK,IAAI,gBAIhC,CAAC;AAE9B,eAAO,MAAM,gBAAgB,UAClB,OAAO,KACf,KAAK,IAAI;IAAE,aAAa,EAAE,YAAY,CAAA;CAA2B,CAAC;AAErE,eAAO,MAAM,0BAA0B,WAAY,gBAAgB,WAClB,CAAC;AAElD,MAAM,MAAM,eAAe,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;CAAE,CAAC;AAE/E,MAAM,MAAM,kBAAkB,GAAG;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;CACnD,CAAC;AAGF,MAAM,MAAM,WAAW,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,OAAO,EAAE,CAAC;IACtB,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IACtC,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACvC,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE;QACP,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAC1E,CAAC;IACF,gBAAgB,CAAC,EAAE,0BAA0B,CAAC;CACjD,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,WAAW,EAAE,kBAAkB,CAAC,GAAG;IACtE,yBAAyB,EAAE,wBAAwB,EAAE,CAAC;IACtD,yBAAyB,EAAE,cAAc,EAAE,CAAC;IAC5C,wBAAwB,EAAE,uBAAuB,EAAE,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,wBAAwB,SAAU,gBAAgB,WAChB,CAAC;AAEhD,KAAK,mBAAmB,GAClB;IACI,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,OAAO,EAAE,CAAC;CACjB,GACD;IACI,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,OAAO,EAAE,CAAC;CAClB,CAAC;AACR,MAAM,MAAM,eAAe,GAAG;IAC1B,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,iBAAiB,CAAC,EAAE,mBAAmB,CAAC;CAC3C,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,OAAO,EAAE,CAAC;IACtB,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,OAAO,EAAE,eAAe,CAAC;IACzB,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IACtC,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACvC,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,QAAQ,CAAC,EAAE;QACP,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAC1E,CAAC;CACL,CAAC;AAEF,eAAO,MAAM,kCAAkC,gBAC9B,WAAW;;;;;CAwB1B,CAAC;AAEH,eAAO,MAAM,qBAAqB,gBAAiB,WAAW,GAAG,SAAS,wBAIrE,CAAC;AAEN,MAAM,MAAM,kBAAkB,GAAG;IAE7B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,OAAO,EAAE,CAAC;IACtB,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,OAAO,EAAE;QACL,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC/B,CAAC;IACF,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IACtC,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,QAAQ,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,gBAAgB,CAAC,EAAE,0BAA0B,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metricQuery.js","sourceRoot":"","sources":["../../../src/types/metricQuery.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,OAAO,EACP,YAAY,EACZ,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,GAcvB,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"metricQuery.js","sourceRoot":"","sources":["../../../src/types/metricQuery.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,OAAO,EACP,YAAY,EACZ,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,GAcvB,MAAM,SAAS,CAAC;AAgDjB,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,KAAc,EAA6B,EAAE,CAC5E,KAAK,EAAE,KAAK;IACZ,KAAK,EAAE,IAAI;IACX,CAAC,KAAK,EAAE,SAAS;IACjB,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;AAE9B,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC5B,KAAc,EAC0B,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC;AAErE,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,MAAwB,EAAE,EAAE,CACnE,GAAG,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,iBAAiB,EAAE,CAAC;AAuClD,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,IAAsB,EAAE,EAAE,CAC/D,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;AA+BhD,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAC9C,WAAwB,EAC1B,EAAE,CAAC,CAAC;IACF,gCAAgC,EAC5B,WAAW,CAAC,gBAAgB,EAAE,MAAM,CAChC,CAAC,SAAS,EAAE,EAAE,CACV,oBAAoB,CAAC,SAAS,CAAC;QAC/B,SAAS,CAAC,OAAO,KAAK,OAAO,CAAC,YAAY,CACjD,CAAC,MAAM,IAAI,CAAC;IACjB,+BAA+B,EAC3B,WAAW,CAAC,gBAAgB,EAAE,MAAM,CAChC,CAAC,SAAS,EAAE,EAAE,CACV,oBAAoB,CAAC,SAAS,CAAC;QAC/B,SAAS,CAAC,OAAO,KAAK,OAAO,CAAC,WAAW,CAChD,CAAC,MAAM,IAAI,CAAC;IACjB,iCAAiC,EAC7B,WAAW,CAAC,gBAAgB,EAAE,MAAM,CAChC,CAAC,SAAS,EAAE,EAAE,CACV,oBAAoB,CAAC,SAAS,CAAC;QAC/B,SAAS,CAAC,OAAO,KAAK,OAAO,CAAC,YAAY,CACjD,CAAC,MAAM,IAAI,CAAC;IACjB,sBAAsB,EAClB,WAAW,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAC/C,oBAAoB,CAAC,SAAS,CAAC,CAClC,CAAC,MAAM,IAAI,CAAC;CACpB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,WAAoC,EAAE,EAAE,CAC1E,WAAW,EAAE,gBAAgB;IAC7B,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAC5C,oBAAoB,CAAC,SAAS,CAAC,CAClC,CAAC"}
|