@lightdash/common 0.2876.0 → 0.2876.1

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.
@@ -32,12 +32,23 @@ export type MissingTargetsPartialFailure = {
32
32
  type: PartialFailureType.MISSING_TARGETS;
33
33
  };
34
34
  export type PartialFailure = DashboardChartPartialFailure | DashboardSqlChartPartialFailure | MissingTargetsPartialFailure;
35
+ /**
36
+ * Outcome of evaluating a threshold-alert scheduler against the latest query results.
37
+ * Emitted on `SchedulerDetails.thresholdStatus` and on the `scheduler_job.completed`
38
+ * analytics event so downstream consumers (UI toasts, dashboards) can branch reliably.
39
+ */
40
+ export declare enum ThresholdStatus {
41
+ MET = "met",
42
+ NOT_MET = "not_met"
43
+ }
35
44
  export type SchedulerDetails = {
36
45
  projectUuid?: string;
37
46
  organizationUuid?: string;
38
47
  createdByUserUuid?: string;
39
48
  /** Partial failures that occurred during the scheduled delivery (e.g., some charts failed in a dashboard export) */
40
49
  partialFailures?: PartialFailure[];
50
+ /** Set when a threshold-alert scheduler completed without sending a notification because the threshold was not met. */
51
+ thresholdStatus?: ThresholdStatus;
41
52
  [key: string]: AnyType;
42
53
  };
43
54
  type BaseSchedulerLog = {
@@ -1 +1 @@
1
- {"version":3,"file":"schedulerLog.d.ts","sourceRoot":"","sources":["../../../src/types/schedulerLog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,OAAO,CAAC;AACrC,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EACH,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EAC1B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,mBAAmB,GACzB,OAAO,GACP,OAAO,GACP,SAAS,GACT,SAAS,GACT,YAAY,CAAC;AAEnB,oBAAY,qBAAqB;IAC7B,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,SAAS,aAAa;CACzB;AAGD,oBAAY,kBAAkB;IAC1B,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,mBAAmB,wBAAwB;CAC9C;AAED,MAAM,MAAM,4BAA4B,GAAG;IACvC,IAAI,EAAE,kBAAkB,CAAC,eAAe,CAAC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC1C,IAAI,EAAE,kBAAkB,CAAC,mBAAmB,CAAC;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACvC,IAAI,EAAE,kBAAkB,CAAC,eAAe,CAAC;CAC5C,CAAC;AAGF,MAAM,MAAM,cAAc,GACpB,4BAA4B,GAC5B,+BAA+B,GAC/B,4BAA4B,CAAC;AAEnC,MAAM,MAAM,gBAAgB,GAAG;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oHAAoH;IACpH,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,iBAAiB,CAAC;IACxB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,aAAa,EAAE,IAAI,CAAC;IACpB,SAAS,EAAE,IAAI,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,gBAAgB,GAAG;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,OAAO,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;AAEjE,MAAM,MAAM,iBAAiB,GAAG;IAC5B,UAAU,EAAE,mBAAmB,EAAE,CAAC;IAClC,KAAK,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACnE,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACnD,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACtD,IAAI,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,UAAU,CAC7C,iBAAiB,CAAC,iBAAiB,CAAC,CACvC,CAAC;AAIF,oBAAY,kBAAkB;IAC1B,SAAS,cAAc;IACvB,eAAe,oBAAoB;IACnC,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,SAAS,cAAc;CAC1B;AAED,MAAM,MAAM,SAAS,GAAG;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,IAAI,CAAC;IACpB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACxC,SAAS,EAAE,SAAS,CAAC;IAErB,YAAY,EAAE,qBAAqB,CAAC;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,eAAe,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,UAAU,CAC7C,iBAAiB,CAAC,YAAY,EAAE,CAAC,CACpC,CAAC;AAIF,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACvC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACjC,QAAQ,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,IAAI,CAAC;IACpB,IAAI,EAAE,eAAe,EAAE,CAAC;IAExB,YAAY,EAAE,qBAAqB,CAAC;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC"}
1
+ {"version":3,"file":"schedulerLog.d.ts","sourceRoot":"","sources":["../../../src/types/schedulerLog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,OAAO,CAAC;AACrC,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EACH,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EAC1B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,mBAAmB,GACzB,OAAO,GACP,OAAO,GACP,SAAS,GACT,SAAS,GACT,YAAY,CAAC;AAEnB,oBAAY,qBAAqB;IAC7B,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,SAAS,aAAa;CACzB;AAGD,oBAAY,kBAAkB;IAC1B,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,mBAAmB,wBAAwB;CAC9C;AAED,MAAM,MAAM,4BAA4B,GAAG;IACvC,IAAI,EAAE,kBAAkB,CAAC,eAAe,CAAC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC1C,IAAI,EAAE,kBAAkB,CAAC,mBAAmB,CAAC;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACvC,IAAI,EAAE,kBAAkB,CAAC,eAAe,CAAC;CAC5C,CAAC;AAGF,MAAM,MAAM,cAAc,GACpB,4BAA4B,GAC5B,+BAA+B,GAC/B,4BAA4B,CAAC;AAEnC;;;;GAIG;AACH,oBAAY,eAAe;IACvB,GAAG,QAAQ;IACX,OAAO,YAAY;CACtB;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oHAAoH;IACpH,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,uHAAuH;IACvH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,iBAAiB,CAAC;IACxB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,aAAa,EAAE,IAAI,CAAC;IACpB,SAAS,EAAE,IAAI,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,gBAAgB,GAAG;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,OAAO,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;AAEjE,MAAM,MAAM,iBAAiB,GAAG;IAC5B,UAAU,EAAE,mBAAmB,EAAE,CAAC;IAClC,KAAK,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACnE,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACnD,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACtD,IAAI,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,UAAU,CAC7C,iBAAiB,CAAC,iBAAiB,CAAC,CACvC,CAAC;AAIF,oBAAY,kBAAkB;IAC1B,SAAS,cAAc;IACvB,eAAe,oBAAoB;IACnC,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,SAAS,cAAc;CAC1B;AAED,MAAM,MAAM,SAAS,GAAG;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,IAAI,CAAC;IACpB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACxC,SAAS,EAAE,SAAS,CAAC;IAErB,YAAY,EAAE,qBAAqB,CAAC;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,eAAe,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,UAAU,CAC7C,iBAAiB,CAAC,YAAY,EAAE,CAAC,CACpC,CAAC;AAIF,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACvC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACjC,QAAQ,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,IAAI,CAAC;IACpB,IAAI,EAAE,eAAe,EAAE,CAAC;IAExB,YAAY,EAAE,qBAAqB,CAAC;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC"}
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SchedulerRunStatus = exports.PartialFailureType = exports.SchedulerResourceType = void 0;
3
+ exports.SchedulerRunStatus = exports.ThresholdStatus = exports.PartialFailureType = exports.SchedulerResourceType = void 0;
4
4
  var SchedulerResourceType;
5
5
  (function (SchedulerResourceType) {
6
6
  SchedulerResourceType["CHART"] = "chart";
@@ -14,6 +14,16 @@ var PartialFailureType;
14
14
  PartialFailureType["DASHBOARD_CHART"] = "dashboard_chart";
15
15
  PartialFailureType["DASHBOARD_SQL_CHART"] = "dashboard_sql_chart";
16
16
  })(PartialFailureType || (exports.PartialFailureType = PartialFailureType = {}));
17
+ /**
18
+ * Outcome of evaluating a threshold-alert scheduler against the latest query results.
19
+ * Emitted on `SchedulerDetails.thresholdStatus` and on the `scheduler_job.completed`
20
+ * analytics event so downstream consumers (UI toasts, dashboards) can branch reliably.
21
+ */
22
+ var ThresholdStatus;
23
+ (function (ThresholdStatus) {
24
+ ThresholdStatus["MET"] = "met";
25
+ ThresholdStatus["NOT_MET"] = "not_met";
26
+ })(ThresholdStatus || (exports.ThresholdStatus = ThresholdStatus = {}));
17
27
  // Scheduler Runs API types
18
28
  var SchedulerRunStatus;
19
29
  (function (SchedulerRunStatus) {
@@ -1 +1 @@
1
- {"version":3,"file":"schedulerLog.js","sourceRoot":"","sources":["../../../src/types/schedulerLog.ts"],"names":[],"mappings":";;;AAiBA,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC7B,wCAAe,CAAA;IACf,gDAAuB,CAAA;IACvB,+CAAsB,CAAA;AAC1B,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC;AAED,gDAAgD;AAChD,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,yDAAmC,CAAA;IACnC,yDAAmC,CAAA;IACnC,iEAA2C,CAAA;AAC/C,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAmED,2BAA2B;AAE3B,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC1B,6CAAuB,CAAA;IACvB,yDAAmC,CAAA;IACnC,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;AAC3B,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B"}
1
+ {"version":3,"file":"schedulerLog.js","sourceRoot":"","sources":["../../../src/types/schedulerLog.ts"],"names":[],"mappings":";;;AAiBA,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC7B,wCAAe,CAAA;IACf,gDAAuB,CAAA;IACvB,+CAAsB,CAAA;AAC1B,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC;AAED,gDAAgD;AAChD,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,yDAAmC,CAAA;IACnC,yDAAmC,CAAA;IACnC,iEAA2C,CAAA;AAC/C,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AA4BD;;;;GAIG;AACH,IAAY,eAGX;AAHD,WAAY,eAAe;IACvB,8BAAW,CAAA;IACX,sCAAmB,CAAA;AACvB,CAAC,EAHW,eAAe,+BAAf,eAAe,QAG1B;AA2CD,2BAA2B;AAE3B,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC1B,6CAAuB,CAAA;IACvB,yDAAmC,CAAA;IACnC,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;AAC3B,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B"}