@opencxh/domain 1.280.0 → 1.282.0

package/dist/entities/analytics/dashboard.d.ts

@@ -1,6 +1,7 @@
+import { SavedView } from '../saved-view/types';
 import { OwnerScope } from '../scope/types';
 import { DimensionId } from './dimensions';
-import { WidgetConfig } from './report';
+import { FilterClause, WidgetConfig } from './report';
 /**
  * A dashboard SECTION, declaratively. The analytics frontend runs the right widget(s) for the viz and
  * renders the matching component. `title` and the parent def's `title` are i18n keys resolved against the
@@ -20,6 +21,12 @@ export interface DashboardSection {
     metricIds: string[];
     /** Row dimension for bar/table (line/heatmap imply the time axis). */
     groupBy?: DimensionId;
+    /**
+     * column only: stack the series into one bar per period. Only the source can
+     * say its series add up to a whole (answered + missed = offered); two
+     * unrelated counts stacked would draw a total that means nothing.
+     */
+    stacked?: boolean;
 }
 /**
  * A preset dashboard shipped by an owning app (or by analytics for cross-source ones). Discovered like
@@ -55,3 +62,17 @@ export interface DashboardConfig {
     createdAt?: number;
     updatedAt?: number;
 }
+/** What a report view keeps: the window as the URL writes it (`30d`, `2026-08-01~2026-08-31`) and the filters. */
+export interface ReportViewFilters {
+    period: string;
+    clauses: FilterClause[];
+}
+/**
+ * A saved report view: a preset dashboard with a period and filters, under a name. The shared
+ * `SavedView` shape; `layout` is always `"report"` and the dashboard rides in its own column,
+ * because the list of dashboards is discovered, not fixed.
+ */
+export type ReportView = SavedView<ReportViewFilters, "report"> & {
+    dashboardKey: string;
+};
+export declare const REPORT_VIEW_LAYOUTS: readonly ["report"];

package/dist/entities/analytics/metric.d.ts

@@ -1,3 +1,4 @@
+import { SlaMetric } from '../sla/types';
 import { DimensionId } from './dimensions';
 /**
  * Metric register — the declarative building block. Fixed in code as a typed `const` in the owning app
@@ -8,6 +9,20 @@ import { DimensionId } from './dimensions';
  */
 export type MetricValueType = "count" | "duration_ms" | "percent" | "currency";
 export type MetricAggregation = "sum" | "avg" | "rate" | "distinct" | "p50" | "p90" | "min" | "max";
+/**
+ * Which direction of change is good news. `neutral` is for volume: more
+ * conversations is more work, not better work, so its delta stays grey.
+ */
+export type MetricPolarity = "higher" | "lower" | "neutral";
+/**
+ * Where the goal for a metric lives. Only SLA targets today: the minutes an SLA
+ * profile sets for one of its metrics. A report shows the goal only when exactly
+ * one profile applies — picking between several would be a guess.
+ */
+export type MetricTarget = {
+    kind: "sla";
+    metric: SlaMetric;
+};
 export interface MetricDefinition {
     /**
      * Globally-unique, app-namespaced id: "<source>.<family>.<name>", e.g. "comms.reply_time.first",
@@ -35,4 +50,8 @@ export interface MetricDefinition {
     description?: string;
     /** Hidden from the picker (e.g. a numerator/denominator base metric of a rate). */
     hidden?: boolean;
+    /** Good direction for a delta. Omitted = the analytics app guesses from id and aggregation. */
+    polarity?: MetricPolarity;
+    /** The goal this metric is measured against, if any (a duration metric against an SLA target). */
+    target?: MetricTarget;
 }