@contractspec/example.analytics-dashboard 1.57.0 → 1.59.0

package/dist/docs/analytics-dashboard.docblock.js

@@ -1,21 +1,16 @@
+// @bun
+// src/docs/analytics-dashboard.docblock.ts
 import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
-
-//#region src/docs/analytics-dashboard.docblock.ts
-registerDocBlocks([
-	{
-		id: "docs.examples.analytics-dashboard",
-		title: "Analytics Dashboard",
-		summary: "Multi-tenant analytics with dashboards, widgets, query builder, and scheduled reports built on the Event Bus.",
-		kind: "reference",
-		visibility: "public",
-		route: "/docs/examples/analytics-dashboard",
-		tags: [
-			"analytics",
-			"dashboards",
-			"bi",
-			"queries"
-		],
-		body: `## Entities
+var analyticsDashboardDocBlocks = [
+  {
+    id: "docs.examples.analytics-dashboard",
+    title: "Analytics Dashboard",
+    summary: "Multi-tenant analytics with dashboards, widgets, query builder, and scheduled reports built on the Event Bus.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/analytics-dashboard",
+    tags: ["analytics", "dashboards", "bi", "queries"],
+    body: `## Entities
 
 - Dashboard, Widget, Query, Report.
 - Widget/query configs stay declarative for regeneration.
@@ -41,16 +36,16 @@ registerDocBlocks([
 - Use Feature Flags for beta widgets; Metering to track query volume.
 - PostHog datasource can back query execution via HogQL for dashboard widgets.
 `
-	},
-	{
-		id: "docs.examples.analytics-dashboard.goal",
-		title: "Analytics Dashboard — Goal",
-		summary: "Why this template matters and what success looks like.",
-		kind: "goal",
-		visibility: "public",
-		route: "/docs/examples/analytics-dashboard/goal",
-		tags: ["analytics", "goal"],
-		body: `## Why it matters
+  },
+  {
+    id: "docs.examples.analytics-dashboard.goal",
+    title: "Analytics Dashboard \u2014 Goal",
+    summary: "Why this template matters and what success looks like.",
+    kind: "goal",
+    visibility: "public",
+    route: "/docs/examples/analytics-dashboard/goal",
+    tags: ["analytics", "goal"],
+    body: `## Why it matters
 - Give teams a regenerable analytics workspace that stays in sync with Event Bus, Usage/Metering, and presentations.
 - Avoid dashboard drift by keeping schema-first widgets/queries.
 
@@ -61,16 +56,16 @@ registerDocBlocks([
 ## Success criteria
 - Dashboards can be regenerated safely from spec changes.
 - Queries/widgets have enforced validation; PII is redacted per policy.`
-	},
-	{
-		id: "docs.examples.analytics-dashboard.usage",
-		title: "Analytics Dashboard — Usage",
-		summary: "How to seed, extend, and safely regenerate dashboards.",
-		kind: "usage",
-		visibility: "public",
-		route: "/docs/examples/analytics-dashboard/usage",
-		tags: ["analytics", "usage"],
-		body: `## Setup
+  },
+  {
+    id: "docs.examples.analytics-dashboard.usage",
+    title: "Analytics Dashboard \u2014 Usage",
+    summary: "How to seed, extend, and safely regenerate dashboards.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/analytics-dashboard/usage",
+    tags: ["analytics", "usage"],
+    body: `## Setup
 1) Seed dashboards/widgets (via template registry) to preload sample queries.
 2) Configure org/tenant scope and attach Usage/Metering for cost/sampling controls.
 
@@ -82,20 +77,16 @@ registerDocBlocks([
 ## Guardrails
 - Keep all query inputs validated; mark PII paths in policy.
 - Use Audit Trail for report deliveries; Notifications for scheduled sends.`
-	},
-	{
-		id: "docs.examples.analytics-dashboard.constraints",
-		title: "Analytics Dashboard — Constraints & Safety",
-		summary: "Internal guardrails for queries, widgets, and regeneration.",
-		kind: "reference",
-		visibility: "internal",
-		route: "/docs/examples/analytics-dashboard/constraints",
-		tags: [
-			"analytics",
-			"constraints",
-			"internal"
-		],
-		body: `## Constraints
+  },
+  {
+    id: "docs.examples.analytics-dashboard.constraints",
+    title: "Analytics Dashboard \u2014 Constraints & Safety",
+    summary: "Internal guardrails for queries, widgets, and regeneration.",
+    kind: "reference",
+    visibility: "internal",
+    route: "/docs/examples/analytics-dashboard/constraints",
+    tags: ["analytics", "constraints", "internal"],
+    body: `## Constraints
 - Queries and widgets must declare inputs/validation in spec; no ad-hoc query strings.
 - Regeneration must preserve sampling/windowing semantics; document changes explicitly.
 - Events/usage metrics should remain consistent with Metering/Audit wiring.
@@ -108,8 +99,6 @@ registerDocBlocks([
 - Add fixtures for widget/query schema changes and scheduled reports.
 - Run regeneration diff when adjusting query builders; ensure UI/markdown targets updated.
 - Confirm feature-flagged widgets default to safe/off for new tenants.`
-	}
-]);
-
-//#endregion
-//# sourceMappingURL=analytics-dashboard.docblock.js.map
+  }
+];
+registerDocBlocks(analyticsDashboardDocBlocks);

package/dist/docs/index.d.ts

@@ -1 +1,2 @@
-export { };
+import './analytics-dashboard.docblock';
+//# sourceMappingURL=index.d.ts.map

package/dist/docs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docs/index.ts"],"names":[],"mappings":"AAAA,OAAO,gCAAgC,CAAC"}

package/dist/docs/index.js

@@ -1 +1,104 @@
-import "./analytics-dashboard.docblock.js";
+// @bun
+// src/docs/analytics-dashboard.docblock.ts
+import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
+var analyticsDashboardDocBlocks = [
+  {
+    id: "docs.examples.analytics-dashboard",
+    title: "Analytics Dashboard",
+    summary: "Multi-tenant analytics with dashboards, widgets, query builder, and scheduled reports built on the Event Bus.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/analytics-dashboard",
+    tags: ["analytics", "dashboards", "bi", "queries"],
+    body: `## Entities
+
+- Dashboard, Widget, Query, Report.
+- Widget/query configs stay declarative for regeneration.
+
+## Contracts
+
+- \`analytics.dashboard.create\`, \`analytics.widget.add\`, \`analytics.query.execute\`, \`analytics.dashboard.get\`.
+- Metrics can source from Event Bus schemas and Usage/Metering module.
+
+## Events
+
+- dashboard.created/updated, widget.added, report.scheduled/sent.
+- Emitted for audit + notification hooks.
+
+## UI / Presentations
+
+- Dashboard list, dashboard view, query builder, widget gallery.
+- Registered under \`analytics-dashboard\` template in Template Registry.
+
+## Notes
+
+- Enforce org scoping for multi-tenant isolation.
+- Use Feature Flags for beta widgets; Metering to track query volume.
+- PostHog datasource can back query execution via HogQL for dashboard widgets.
+`
+  },
+  {
+    id: "docs.examples.analytics-dashboard.goal",
+    title: "Analytics Dashboard \u2014 Goal",
+    summary: "Why this template matters and what success looks like.",
+    kind: "goal",
+    visibility: "public",
+    route: "/docs/examples/analytics-dashboard/goal",
+    tags: ["analytics", "goal"],
+    body: `## Why it matters
+- Give teams a regenerable analytics workspace that stays in sync with Event Bus, Usage/Metering, and presentations.
+- Avoid dashboard drift by keeping schema-first widgets/queries.
+
+## Business/Product goal
+- Deliver tenant-scoped dashboards, governed queries, and scheduled reports with clear ownership and auditability.
+- Enable feature-flagged rollout of new widgets and sampling for cost control.
+
+## Success criteria
+- Dashboards can be regenerated safely from spec changes.
+- Queries/widgets have enforced validation; PII is redacted per policy.`
+  },
+  {
+    id: "docs.examples.analytics-dashboard.usage",
+    title: "Analytics Dashboard \u2014 Usage",
+    summary: "How to seed, extend, and safely regenerate dashboards.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/analytics-dashboard/usage",
+    tags: ["analytics", "usage"],
+    body: `## Setup
+1) Seed dashboards/widgets (via template registry) to preload sample queries.
+2) Configure org/tenant scope and attach Usage/Metering for cost/sampling controls.
+
+## Extend & regenerate
+1) Add or modify widget/query schemas in the spec (inputs, validation, PII paths).
+2) Regenerate to update UI + API + events; review presentations for redaction.
+3) Use Feature Flags to roll out new widgets or sampling knobs gradually.
+
+## Guardrails
+- Keep all query inputs validated; mark PII paths in policy.
+- Use Audit Trail for report deliveries; Notifications for scheduled sends.`
+  },
+  {
+    id: "docs.examples.analytics-dashboard.constraints",
+    title: "Analytics Dashboard \u2014 Constraints & Safety",
+    summary: "Internal guardrails for queries, widgets, and regeneration.",
+    kind: "reference",
+    visibility: "internal",
+    route: "/docs/examples/analytics-dashboard/constraints",
+    tags: ["analytics", "constraints", "internal"],
+    body: `## Constraints
+- Queries and widgets must declare inputs/validation in spec; no ad-hoc query strings.
+- Regeneration must preserve sampling/windowing semantics; document changes explicitly.
+- Events/usage metrics should remain consistent with Metering/Audit wiring.
+
+## PII & Data
+- Mark PII paths (user ids, emails) in presentations for redaction.
+- Avoid exposing raw query payloads in MCP/web without policy checks.
+
+## Verification
+- Add fixtures for widget/query schema changes and scheduled reports.
+- Run regeneration diff when adjusting query builders; ensure UI/markdown targets updated.
+- Confirm feature-flagged widgets default to safe/off for new tenants.`
+  }
+];
+registerDocBlocks(analyticsDashboardDocBlocks);

package/dist/events.d.ts

@@ -1,149 +1,143 @@
-import * as _contractspec_lib_contracts0 from "@contractspec/lib.contracts";
-import * as _contractspec_lib_schema0 from "@contractspec/lib.schema";
-
-//#region src/events.d.ts
-declare const DashboardCreatedEvent: _contractspec_lib_contracts0.EventSpec<_contractspec_lib_schema0.SchemaModel<{
-  dashboardId: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  title: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  orgId: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  createdBy: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  timestamp: {
-    type: _contractspec_lib_schema0.FieldType<Date, string>;
-    isOptional: false;
-  };
-}>>;
-declare const WidgetAddedEvent: _contractspec_lib_contracts0.EventSpec<_contractspec_lib_schema0.SchemaModel<{
-  widgetId: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  dashboardId: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  widgetType: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  orgId: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  timestamp: {
-    type: _contractspec_lib_schema0.FieldType<Date, string>;
-    isOptional: false;
-  };
-}>>;
-declare const QueryCreatedEvent: _contractspec_lib_contracts0.EventSpec<_contractspec_lib_schema0.SchemaModel<{
-  queryId: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  name: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  queryType: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  orgId: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  createdBy: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  timestamp: {
-    type: _contractspec_lib_schema0.FieldType<Date, string>;
-    isOptional: false;
-  };
-}>>;
-declare const AnalyticsDashboardEvents: {
-  DashboardCreatedEvent: _contractspec_lib_contracts0.EventSpec<_contractspec_lib_schema0.SchemaModel<{
+export declare const DashboardCreatedEvent: import("@contractspec/lib.contracts").EventSpec<import("@contractspec/lib.schema").SchemaModel<{
     dashboardId: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     title: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     orgId: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     createdBy: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     timestamp: {
-      type: _contractspec_lib_schema0.FieldType<Date, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<Date, string>;
+        isOptional: false;
     };
-  }>>;
-  WidgetAddedEvent: _contractspec_lib_contracts0.EventSpec<_contractspec_lib_schema0.SchemaModel<{
+}>>;
+export declare const WidgetAddedEvent: import("@contractspec/lib.contracts").EventSpec<import("@contractspec/lib.schema").SchemaModel<{
     widgetId: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     dashboardId: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     widgetType: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     orgId: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     timestamp: {
-      type: _contractspec_lib_schema0.FieldType<Date, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<Date, string>;
+        isOptional: false;
     };
-  }>>;
-  QueryCreatedEvent: _contractspec_lib_contracts0.EventSpec<_contractspec_lib_schema0.SchemaModel<{
+}>>;
+export declare const QueryCreatedEvent: import("@contractspec/lib.contracts").EventSpec<import("@contractspec/lib.schema").SchemaModel<{
     queryId: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     name: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     queryType: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     orgId: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     createdBy: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     timestamp: {
-      type: _contractspec_lib_schema0.FieldType<Date, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<Date, string>;
+        isOptional: false;
     };
-  }>>;
+}>>;
+export declare const AnalyticsDashboardEvents: {
+    DashboardCreatedEvent: import("@contractspec/lib.contracts").EventSpec<import("@contractspec/lib.schema").SchemaModel<{
+        dashboardId: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        title: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        orgId: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        createdBy: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        timestamp: {
+            type: import("@contractspec/lib.schema").FieldType<Date, string>;
+            isOptional: false;
+        };
+    }>>;
+    WidgetAddedEvent: import("@contractspec/lib.contracts").EventSpec<import("@contractspec/lib.schema").SchemaModel<{
+        widgetId: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        dashboardId: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        widgetType: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        orgId: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        timestamp: {
+            type: import("@contractspec/lib.schema").FieldType<Date, string>;
+            isOptional: false;
+        };
+    }>>;
+    QueryCreatedEvent: import("@contractspec/lib.contracts").EventSpec<import("@contractspec/lib.schema").SchemaModel<{
+        queryId: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        name: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        queryType: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        orgId: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        createdBy: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        timestamp: {
+            type: import("@contractspec/lib.schema").FieldType<Date, string>;
+            isOptional: false;
+        };
+    }>>;
 };
-//#endregion
-export { AnalyticsDashboardEvents, DashboardCreatedEvent, QueryCreatedEvent, WidgetAddedEvent };
 //# sourceMappingURL=events.d.ts.map

package/dist/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","names":[],"sources":["../src/events.ts"],"mappings":";;;;cAwCa,qBAAA,EAAqB,4BAAA,CAAA,SAAA,2BAAA,WAAA;;UAUhC,yBAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;cAEW,gBAAA,EAAgB,4BAAA,CAAA,SAAA,2BAAA,WAAA;;UAU3B,yBAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;cAEW,iBAAA,EAAiB,4BAAA,CAAA,SAAA,2BAAA,WAAA;;UAU5B,yBAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;cAEW,wBAAA;;;YAIZ,yBAAA,CAAA,SAAA"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAwCA,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;GAUhC,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;GAU3B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;GAU5B,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAIpC,CAAC"}