@reopt-ai/data-contract 0.6.2 → 0.7.0

package/dist/report.d.cts

@@ -1,15 +1,28 @@
-import { z } from 'zod';
-
+import { z } from "zod";
+//#region src/report.d.ts
 declare const REPORT_SPEC_VERSION: 1;
 declare const zReportRange: z.ZodString;
 declare const zReportInterval: z.ZodEnum<{
-    month: "month";
-    day: "day";
-    hour: "hour";
-    week: "week";
-    minute: "minute";
+  hour: "hour";
+  day: "day";
+  week: "week";
+  month: "month";
+  minute: "minute";
 }>;
 declare const zLegacyChartType: z.ZodEnum<{
+  linear: "linear";
+  bar: "bar";
+  pie: "pie";
+  metric: "metric";
+  area: "area";
+  gauge: "gauge";
+  scatter: "scatter";
+  table: "table";
+  sparkline: "sparkline";
+}>;
+declare const zTimeseriesReportSpec: z.ZodObject<{
+  kind: z.ZodLiteral<"timeseries">;
+  chartType: z.ZodEnum<{
     linear: "linear";
     bar: "bar";
     pie: "pie";
@@ -19,149 +32,182 @@ declare const zLegacyChartType: z.ZodEnum<{
     scatter: "scatter";
     table: "table";
     sparkline: "sparkline";
-}>;
-declare const zTimeseriesReportSpec: z.ZodObject<{
-    kind: z.ZodLiteral<"timeseries">;
-    chartType: z.ZodEnum<{
-        linear: "linear";
-        bar: "bar";
-        pie: "pie";
-        metric: "metric";
-        area: "area";
-        gauge: "gauge";
-        scatter: "scatter";
-        table: "table";
-        sparkline: "sparkline";
-    }>;
-    interval: z.ZodEnum<{
-        month: "month";
-        day: "day";
-        hour: "hour";
-        week: "week";
-        minute: "minute";
-    }>;
-    events: z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
-    }, z.core.$strip>>;
-    breakdowns: z.ZodDefault<z.ZodArray<z.ZodString>>;
-    comparePrevious: z.ZodDefault<z.ZodBoolean>;
-    version: z.ZodLiteral<1>;
-    range: z.ZodDefault<z.ZodString>;
-    segmentId: z.ZodOptional<z.ZodString>;
+  }>;
+  interval: z.ZodEnum<{
+    hour: "hour";
+    day: "day";
+    week: "week";
+    month: "month";
+    minute: "minute";
+  }>;
+  events: z.ZodArray<z.ZodObject<{
+    name: z.ZodString;
+  }, z.core.$strip>>;
+  breakdowns: z.ZodDefault<z.ZodArray<z.ZodString>>;
+  comparePrevious: z.ZodDefault<z.ZodBoolean>;
+  version: z.ZodLiteral<1>;
+  range: z.ZodDefault<z.ZodString>;
+  segmentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 declare const zFunnelReportSpec: z.ZodObject<{
-    kind: z.ZodLiteral<"funnel">;
-    steps: z.ZodArray<z.ZodString>;
-    windowSeconds: z.ZodDefault<z.ZodNumber>;
-    version: z.ZodLiteral<1>;
-    range: z.ZodDefault<z.ZodString>;
-    segmentId: z.ZodOptional<z.ZodString>;
+  kind: z.ZodLiteral<"funnel">;
+  steps: z.ZodArray<z.ZodString>;
+  windowSeconds: z.ZodDefault<z.ZodNumber>;
+  version: z.ZodLiteral<1>;
+  range: z.ZodDefault<z.ZodString>;
+  segmentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 declare const zRetentionReportSpec: z.ZodObject<{
-    kind: z.ZodLiteral<"retention">;
-    interval: z.ZodDefault<z.ZodEnum<{
-        month: "month";
-        day: "day";
-        week: "week";
-    }>>;
-    periods: z.ZodDefault<z.ZodNumber>;
-    startEvent: z.ZodOptional<z.ZodString>;
-    returnEvent: z.ZodOptional<z.ZodString>;
-    retentionType: z.ZodDefault<z.ZodEnum<{
-        bounded: "bounded";
-        unbounded: "unbounded";
-    }>>;
-    cohortMode: z.ZodDefault<z.ZodEnum<{
-        "first-ever": "first-ever";
-        "first-in-window": "first-in-window";
-    }>>;
-    version: z.ZodLiteral<1>;
-    range: z.ZodDefault<z.ZodString>;
-    segmentId: z.ZodOptional<z.ZodString>;
+  kind: z.ZodLiteral<"retention">;
+  interval: z.ZodDefault<z.ZodEnum<{
+    day: "day";
+    week: "week";
+    month: "month";
+  }>>;
+  periods: z.ZodDefault<z.ZodNumber>;
+  startEvent: z.ZodOptional<z.ZodString>;
+  returnEvent: z.ZodOptional<z.ZodString>;
+  retentionType: z.ZodDefault<z.ZodEnum<{
+    bounded: "bounded";
+    unbounded: "unbounded";
+  }>>;
+  cohortMode: z.ZodDefault<z.ZodEnum<{
+    "first-ever": "first-ever";
+    "first-in-window": "first-in-window";
+  }>>;
+  version: z.ZodLiteral<1>;
+  range: z.ZodDefault<z.ZodString>;
+  segmentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 declare const zPathReportSpec: z.ZodObject<{
-    kind: z.ZodLiteral<"path">;
-    limit: z.ZodDefault<z.ZodNumber>;
-    startPage: z.ZodOptional<z.ZodString>;
-    endPage: z.ZodOptional<z.ZodString>;
-    version: z.ZodLiteral<1>;
-    range: z.ZodDefault<z.ZodString>;
-    segmentId: z.ZodOptional<z.ZodString>;
+  kind: z.ZodLiteral<"path">;
+  limit: z.ZodDefault<z.ZodNumber>;
+  startPage: z.ZodOptional<z.ZodString>;
+  endPage: z.ZodOptional<z.ZodString>;
+  version: z.ZodLiteral<1>;
+  range: z.ZodDefault<z.ZodString>;
+  segmentId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * The issues throwing hardest, as a dashboard tile.
+ *
+ * The only spec kind with no `events`: it reads issues, which are rows in
+ * Postgres joined to occurrence volumes, not an event query. `range` is
+ * inherited from `zCommon` and is what the tile counts occurrences over.
+ */
+declare const zErrorIssuesTopReportSpec: z.ZodObject<{
+  kind: z.ZodLiteral<"error_issues_top">;
+  limit: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<5>, z.ZodLiteral<10>]>>;
+  sort: z.ZodDefault<z.ZodEnum<{
+    users: "users";
+    occurrences: "occurrences";
+    lastSeen: "lastSeen";
+  }>>;
+  statuses: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+    active: "active";
+    archived: "archived";
+    resolved: "resolved";
+    pending_release: "pending_release";
+    suppressed: "suppressed";
+  }>>>;
+  version: z.ZodLiteral<1>;
+  range: z.ZodDefault<z.ZodString>;
+  segmentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 declare const zReportSpec: z.ZodDiscriminatedUnion<[z.ZodObject<{
-    kind: z.ZodLiteral<"timeseries">;
-    chartType: z.ZodEnum<{
-        linear: "linear";
-        bar: "bar";
-        pie: "pie";
-        metric: "metric";
-        area: "area";
-        gauge: "gauge";
-        scatter: "scatter";
-        table: "table";
-        sparkline: "sparkline";
-    }>;
-    interval: z.ZodEnum<{
-        month: "month";
-        day: "day";
-        hour: "hour";
-        week: "week";
-        minute: "minute";
-    }>;
-    events: z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
-    }, z.core.$strip>>;
-    breakdowns: z.ZodDefault<z.ZodArray<z.ZodString>>;
-    comparePrevious: z.ZodDefault<z.ZodBoolean>;
-    version: z.ZodLiteral<1>;
-    range: z.ZodDefault<z.ZodString>;
-    segmentId: z.ZodOptional<z.ZodString>;
+  kind: z.ZodLiteral<"timeseries">;
+  chartType: z.ZodEnum<{
+    linear: "linear";
+    bar: "bar";
+    pie: "pie";
+    metric: "metric";
+    area: "area";
+    gauge: "gauge";
+    scatter: "scatter";
+    table: "table";
+    sparkline: "sparkline";
+  }>;
+  interval: z.ZodEnum<{
+    hour: "hour";
+    day: "day";
+    week: "week";
+    month: "month";
+    minute: "minute";
+  }>;
+  events: z.ZodArray<z.ZodObject<{
+    name: z.ZodString;
+  }, z.core.$strip>>;
+  breakdowns: z.ZodDefault<z.ZodArray<z.ZodString>>;
+  comparePrevious: z.ZodDefault<z.ZodBoolean>;
+  version: z.ZodLiteral<1>;
+  range: z.ZodDefault<z.ZodString>;
+  segmentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, z.ZodObject<{
-    kind: z.ZodLiteral<"funnel">;
-    steps: z.ZodArray<z.ZodString>;
-    windowSeconds: z.ZodDefault<z.ZodNumber>;
-    version: z.ZodLiteral<1>;
-    range: z.ZodDefault<z.ZodString>;
-    segmentId: z.ZodOptional<z.ZodString>;
+  kind: z.ZodLiteral<"funnel">;
+  steps: z.ZodArray<z.ZodString>;
+  windowSeconds: z.ZodDefault<z.ZodNumber>;
+  version: z.ZodLiteral<1>;
+  range: z.ZodDefault<z.ZodString>;
+  segmentId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+  kind: z.ZodLiteral<"retention">;
+  interval: z.ZodDefault<z.ZodEnum<{
+    day: "day";
+    week: "week";
+    month: "month";
+  }>>;
+  periods: z.ZodDefault<z.ZodNumber>;
+  startEvent: z.ZodOptional<z.ZodString>;
+  returnEvent: z.ZodOptional<z.ZodString>;
+  retentionType: z.ZodDefault<z.ZodEnum<{
+    bounded: "bounded";
+    unbounded: "unbounded";
+  }>>;
+  cohortMode: z.ZodDefault<z.ZodEnum<{
+    "first-ever": "first-ever";
+    "first-in-window": "first-in-window";
+  }>>;
+  version: z.ZodLiteral<1>;
+  range: z.ZodDefault<z.ZodString>;
+  segmentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, z.ZodObject<{
-    kind: z.ZodLiteral<"retention">;
-    interval: z.ZodDefault<z.ZodEnum<{
-        month: "month";
-        day: "day";
-        week: "week";
-    }>>;
-    periods: z.ZodDefault<z.ZodNumber>;
-    startEvent: z.ZodOptional<z.ZodString>;
-    returnEvent: z.ZodOptional<z.ZodString>;
-    retentionType: z.ZodDefault<z.ZodEnum<{
-        bounded: "bounded";
-        unbounded: "unbounded";
-    }>>;
-    cohortMode: z.ZodDefault<z.ZodEnum<{
-        "first-ever": "first-ever";
-        "first-in-window": "first-in-window";
-    }>>;
-    version: z.ZodLiteral<1>;
-    range: z.ZodDefault<z.ZodString>;
-    segmentId: z.ZodOptional<z.ZodString>;
+  kind: z.ZodLiteral<"path">;
+  limit: z.ZodDefault<z.ZodNumber>;
+  startPage: z.ZodOptional<z.ZodString>;
+  endPage: z.ZodOptional<z.ZodString>;
+  version: z.ZodLiteral<1>;
+  range: z.ZodDefault<z.ZodString>;
+  segmentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, z.ZodObject<{
-    kind: z.ZodLiteral<"path">;
-    limit: z.ZodDefault<z.ZodNumber>;
-    startPage: z.ZodOptional<z.ZodString>;
-    endPage: z.ZodOptional<z.ZodString>;
-    version: z.ZodLiteral<1>;
-    range: z.ZodDefault<z.ZodString>;
-    segmentId: z.ZodOptional<z.ZodString>;
+  kind: z.ZodLiteral<"error_issues_top">;
+  limit: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<5>, z.ZodLiteral<10>]>>;
+  sort: z.ZodDefault<z.ZodEnum<{
+    users: "users";
+    occurrences: "occurrences";
+    lastSeen: "lastSeen";
+  }>>;
+  statuses: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+    active: "active";
+    archived: "archived";
+    resolved: "resolved";
+    pending_release: "pending_release";
+    suppressed: "suppressed";
+  }>>>;
+  version: z.ZodLiteral<1>;
+  range: z.ZodDefault<z.ZodString>;
+  segmentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>], "kind">;
 type ReportSpec = z.infer<typeof zReportSpec>;
 type TimeseriesReportSpec = z.infer<typeof zTimeseriesReportSpec>;
+type ErrorIssuesTopReportSpec = z.infer<typeof zErrorIssuesTopReportSpec>;
 /** Convert a pre-ReportSpec row into the canonical v1 representation. */
 declare function legacyReportToSpec(input: {
-    chartType: z.infer<typeof zLegacyChartType>;
-    interval: z.infer<typeof zReportInterval>;
-    range: string;
-    events: unknown;
-    breakdowns: unknown;
+  chartType: z.infer<typeof zLegacyChartType>;
+  interval: z.infer<typeof zReportInterval>;
+  range: string;
+  events: unknown;
+  breakdowns: unknown;
 }): TimeseriesReportSpec;
-
-export { REPORT_SPEC_VERSION, type ReportSpec, type TimeseriesReportSpec, legacyReportToSpec, zFunnelReportSpec, zLegacyChartType, zPathReportSpec, zReportInterval, zReportRange, zReportSpec, zRetentionReportSpec, zTimeseriesReportSpec };
+//#endregion
+export { ErrorIssuesTopReportSpec, REPORT_SPEC_VERSION, ReportSpec, TimeseriesReportSpec, legacyReportToSpec, zErrorIssuesTopReportSpec, zFunnelReportSpec, zLegacyChartType, zPathReportSpec, zReportInterval, zReportRange, zReportSpec, zRetentionReportSpec, zTimeseriesReportSpec };
+//# sourceMappingURL=report.d.cts.map

package/dist/report.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.d.cts","names":[],"sources":["../src/report.ts"],"mappings":";;cAEa;cAEA,cAAY,EAAA;cACZ,iBAAe,EAAA;;;;;;;cACf,kBAAgB,EAAA;;;;;;;;;;;cAkBhB,uBAAqB,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAWhC,EAAA,KAAA;cAEW,mBAAiB,EAAA;;;;;;;GAK5B,EAAA,KAAA;cAEW,sBAAoB,EAAA;;;;;;;;;;;;;;;;;;;;;GAS/B,EAAA,KAAA;cAEW,iBAAe,EAAA;;;;;;;;GAM1B,EAAA,KAAA;;;;;;;;cASW,2BAAyB,EAAA;;;;;;;;;;;;;;;;;;GAepC,EAAA,KAAA;cAEW,aAAW,EAAA,uBAAA,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAMtB,EAAA,KAAA;KAEU,aAAa,EAAE,aAAa;KAC5B,uBAAuB,EAAE,aAAa;KACtC,2BAA2B,EAAE,aAAa;;iBAGtC,mBAAmB;EACjC,WAAW,EAAE,aAAa;EAC1B,UAAU,EAAE,aAAa;EACzB;EACA;EACA;IACE"}