@contractspec/example.analytics-dashboard 1.57.0 → 1.59.0

package/dist/browser/dashboard/dashboard.test-spec.js

@@ -0,0 +1,213 @@
+// src/dashboard/dashboard.test-spec.ts
+import { defineTestSpec } from "@contractspec/lib.contracts";
+var CreateDashboardTest = defineTestSpec({
+  meta: {
+    key: "analytics.dashboard.create.test",
+    version: "1.0.0",
+    title: "Create Dashboard Test",
+    description: "Verifies dashboard creation flow",
+    owners: ["@example.analytics-dashboard"],
+    tags: ["analytics", "dashboard", "test"],
+    stability: "stable"
+  },
+  target: {
+    type: "operation",
+    operation: { key: "analytics.dashboard.create", version: "1.0.0" }
+  },
+  scenarios: [
+    {
+      key: "success",
+      description: "Successfully create a dashboard",
+      when: {
+        operation: { key: "analytics.dashboard.create", version: "1.0.0" },
+        input: {
+          name: "Test Dashboard",
+          description: "Test Description"
+        }
+      },
+      then: [
+        {
+          type: "expectOutput",
+          match: {
+            name: "Test Dashboard"
+          }
+        }
+      ]
+    },
+    {
+      key: "error-invalid-input",
+      description: "Fail to create dashboard with invalid input",
+      when: {
+        operation: { key: "analytics.dashboard.create", version: "1.0.0" },
+        input: {
+          name: ""
+        }
+      },
+      then: [
+        {
+          type: "expectError",
+          messageIncludes: "VALIDATION_ERROR"
+        }
+      ]
+    }
+  ]
+});
+var ListDashboardsTest = defineTestSpec({
+  meta: {
+    key: "analytics.dashboard.list.test",
+    version: "1.0.0",
+    title: "List Dashboards Test",
+    description: "Verifies dashboard listing",
+    owners: ["@example.analytics-dashboard"],
+    tags: ["analytics", "dashboard", "test"],
+    stability: "stable"
+  },
+  target: {
+    type: "operation",
+    operation: { key: "analytics.dashboard.list", version: "1.0.0" }
+  },
+  scenarios: [
+    {
+      key: "success",
+      description: "Successfully list dashboards",
+      when: {
+        operation: { key: "analytics.dashboard.list", version: "1.0.0" },
+        input: { limit: 10, offset: 0 }
+      },
+      then: [
+        {
+          type: "expectOutput",
+          match: {
+            items: [],
+            total: 0
+          }
+        }
+      ]
+    },
+    {
+      key: "error-invalid-format",
+      description: "Fail with invalid pagination",
+      when: {
+        operation: { key: "analytics.dashboard.list", version: "1.0.0" },
+        input: { limit: -1 }
+      },
+      then: [
+        {
+          type: "expectError",
+          messageIncludes: "VALIDATION_ERROR"
+        }
+      ]
+    }
+  ]
+});
+var GetDashboardTest = defineTestSpec({
+  meta: {
+    key: "analytics.dashboard.get.test",
+    version: "1.0.0",
+    title: "Get Dashboard Test",
+    description: "Verifies dashboard retrieval",
+    owners: ["@example.analytics-dashboard"],
+    tags: ["analytics", "dashboard", "test"],
+    stability: "stable"
+  },
+  target: {
+    type: "operation",
+    operation: { key: "analytics.dashboard.get", version: "1.0.0" }
+  },
+  scenarios: [
+    {
+      key: "success",
+      description: "Successfully get dashboard",
+      when: {
+        operation: { key: "analytics.dashboard.get", version: "1.0.0" },
+        input: { dashboardId: "dash-123" }
+      },
+      then: [
+        {
+          type: "expectOutput",
+          match: {
+            id: "dash-123"
+          }
+        }
+      ]
+    },
+    {
+      key: "error-not-found",
+      description: "Fail when dashboard not found",
+      when: {
+        operation: { key: "analytics.dashboard.get", version: "1.0.0" },
+        input: { dashboardId: "dash-999" }
+      },
+      then: [
+        {
+          type: "expectError",
+          messageIncludes: "NOT_FOUND"
+        }
+      ]
+    }
+  ]
+});
+var AddWidgetTest = defineTestSpec({
+  meta: {
+    key: "analytics.widget.add.test",
+    version: "1.0.0",
+    title: "Add Widget Test",
+    description: "Verifies adding widget to dashboard",
+    owners: ["@example.analytics-dashboard"],
+    tags: ["analytics", "widget", "test"],
+    stability: "stable"
+  },
+  target: {
+    type: "operation",
+    operation: { key: "analytics.widget.add", version: "1.0.0" }
+  },
+  scenarios: [
+    {
+      key: "success",
+      description: "Successfully add widget",
+      when: {
+        operation: { key: "analytics.widget.add", version: "1.0.0" },
+        input: {
+          dashboardId: "dash-123",
+          type: "chart",
+          queryId: "q-1",
+          config: {}
+        }
+      },
+      then: [
+        {
+          type: "expectOutput",
+          match: {
+            type: "chart",
+            dashboardId: "dash-123"
+          }
+        }
+      ]
+    },
+    {
+      key: "error-dashboard-not-found",
+      description: "Fail when dashboard does not exist",
+      when: {
+        operation: { key: "analytics.widget.add", version: "1.0.0" },
+        input: {
+          dashboardId: "dash-999",
+          type: "chart",
+          queryId: "q-1",
+          config: {}
+        }
+      },
+      then: [
+        {
+          type: "expectError",
+          messageIncludes: "NOT_FOUND"
+        }
+      ]
+    }
+  ]
+});
+export {
+  ListDashboardsTest,
+  GetDashboardTest,
+  CreateDashboardTest,
+  AddWidgetTest
+};

package/dist/browser/dashboard/index.js

@@ -0,0 +1,299 @@
+// src/dashboard/dashboard.enum.ts
+import { defineEnum } from "@contractspec/lib.schema";
+var DashboardStatusEnum = defineEnum("DashboardStatus", [
+  "DRAFT",
+  "PUBLISHED",
+  "ARCHIVED"
+]);
+var WidgetTypeEnum = defineEnum("WidgetType", [
+  "LINE_CHART",
+  "BAR_CHART",
+  "PIE_CHART",
+  "AREA_CHART",
+  "SCATTER_PLOT",
+  "METRIC",
+  "TABLE",
+  "HEATMAP",
+  "FUNNEL",
+  "MAP",
+  "TEXT",
+  "EMBED"
+]);
+var RefreshIntervalEnum = defineEnum("RefreshInterval", [
+  "NONE",
+  "MINUTE",
+  "FIVE_MINUTES",
+  "FIFTEEN_MINUTES",
+  "HOUR",
+  "DAY"
+]);
+
+// src/dashboard/dashboard.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var WidgetModel = defineSchemaModel({
+  name: "WidgetModel",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    dashboardId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    type: { type: WidgetTypeEnum, isOptional: false },
+    gridX: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    gridY: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    gridWidth: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    gridHeight: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    queryId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    config: { type: ScalarTypeEnum.JSON(), isOptional: true }
+  }
+});
+var DashboardModel = defineSchemaModel({
+  name: "DashboardModel",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    slug: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    status: { type: DashboardStatusEnum, isOptional: false },
+    refreshInterval: { type: RefreshIntervalEnum, isOptional: false },
+    isPublic: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+    widgets: { type: WidgetModel, isArray: true, isOptional: true },
+    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var CreateDashboardInputModel = defineSchemaModel({
+  name: "CreateDashboardInput",
+  fields: {
+    name: { type: ScalarTypeEnum.NonEmptyString(), isOptional: false },
+    slug: { type: ScalarTypeEnum.NonEmptyString(), isOptional: false },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    refreshInterval: { type: RefreshIntervalEnum, isOptional: true },
+    dateRange: { type: ScalarTypeEnum.JSON(), isOptional: true }
+  }
+});
+var AddWidgetInputModel = defineSchemaModel({
+  name: "AddWidgetInput",
+  fields: {
+    dashboardId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.NonEmptyString(), isOptional: false },
+    type: { type: WidgetTypeEnum, isOptional: false },
+    gridX: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+    gridY: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+    gridWidth: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+    gridHeight: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+    queryId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    config: { type: ScalarTypeEnum.JSON(), isOptional: true }
+  }
+});
+var ListDashboardsInputModel = defineSchemaModel({
+  name: "ListDashboardsInput",
+  fields: {
+    status: { type: DashboardStatusEnum, isOptional: true },
+    search: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    limit: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: true,
+      defaultValue: 20
+    },
+    offset: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: true,
+      defaultValue: 0
+    }
+  }
+});
+var ListDashboardsOutputModel = defineSchemaModel({
+  name: "ListDashboardsOutput",
+  fields: {
+    dashboards: { type: DashboardModel, isArray: true, isOptional: false },
+    total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false }
+  }
+});
+var GetDashboardInputModel = defineSchemaModel({
+  name: "GetDashboardInput",
+  fields: {
+    dashboardId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    slug: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    shareToken: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+
+// src/dashboard/dashboard.operation.ts
+import {
+  defineCommand,
+  defineQuery
+} from "@contractspec/lib.contracts/operations";
+var OWNERS = ["@example.analytics-dashboard"];
+var CreateDashboardContract = defineCommand({
+  meta: {
+    key: "analytics.dashboard.create",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["analytics", "dashboard", "create"],
+    description: "Create a new analytics dashboard.",
+    goal: "Allow users to create custom dashboards.",
+    context: "Dashboard management."
+  },
+  io: { input: CreateDashboardInputModel, output: DashboardModel },
+  policy: { auth: "user" },
+  sideEffects: {
+    emits: [
+      {
+        key: "analytics.dashboard.created",
+        version: "1.0.0",
+        stability: "stable",
+        owners: [...OWNERS],
+        tags: ["analytics", "dashboard", "created"],
+        when: "Dashboard created",
+        payload: DashboardModel
+      }
+    ],
+    audit: ["analytics.dashboard.created"]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "create-dashboard-happy-path",
+        given: ["User is authenticated"],
+        when: ["User submits valid dashboard configuration"],
+        then: ["Dashboard is created", "DashboardCreated event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "create-basic",
+        input: {
+          name: "Revenue Dashboard",
+          description: "Monthly revenue metrics"
+        },
+        output: { id: "dash-123", name: "Revenue Dashboard", widgets: [] }
+      }
+    ]
+  }
+});
+var AddWidgetContract = defineCommand({
+  meta: {
+    key: "analytics.widget.add",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["analytics", "widget", "add"],
+    description: "Add a widget to a dashboard.",
+    goal: "Allow users to add visualizations.",
+    context: "Dashboard editor."
+  },
+  io: { input: AddWidgetInputModel, output: WidgetModel },
+  policy: { auth: "user" },
+  sideEffects: {
+    emits: [
+      {
+        key: "analytics.widget.added",
+        version: "1.0.0",
+        stability: "stable",
+        owners: [...OWNERS],
+        tags: ["analytics", "widget", "added"],
+        when: "Widget added",
+        payload: WidgetModel
+      }
+    ]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "add-widget-happy-path",
+        given: ["Dashboard exists"],
+        when: ["User adds widget to dashboard"],
+        then: ["Widget is created", "WidgetAdded event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "add-chart-widget",
+        input: {
+          dashboardId: "dash-123",
+          type: "chart",
+          queryId: "query-456",
+          config: { chartType: "bar" }
+        },
+        output: { id: "widget-789", type: "chart", dashboardId: "dash-123" }
+      }
+    ]
+  }
+});
+var ListDashboardsContract = defineQuery({
+  meta: {
+    key: "analytics.dashboard.list",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["analytics", "dashboard", "list"],
+    description: "List dashboards.",
+    goal: "Browse available dashboards.",
+    context: "Dashboard listing."
+  },
+  io: { input: ListDashboardsInputModel, output: ListDashboardsOutputModel },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "list-dashboards-happy-path",
+        given: ["User has dashboards"],
+        when: ["User lists dashboards"],
+        then: ["Paginated list of dashboards is returned"]
+      }
+    ],
+    examples: [
+      {
+        key: "list-basic",
+        input: { limit: 10, offset: 0 },
+        output: { items: [], total: 0, hasMore: false }
+      }
+    ]
+  }
+});
+var GetDashboardContract = defineQuery({
+  meta: {
+    key: "analytics.dashboard.get",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["analytics", "dashboard", "get"],
+    description: "Get a dashboard with widgets.",
+    goal: "Load dashboard for viewing.",
+    context: "Dashboard view."
+  },
+  io: { input: GetDashboardInputModel, output: DashboardModel },
+  policy: { auth: "anonymous" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "get-dashboard-happy-path",
+        given: ["Dashboard exists"],
+        when: ["User requests dashboard by ID"],
+        then: ["Dashboard with widgets is returned"]
+      }
+    ],
+    examples: [
+      {
+        key: "get-basic",
+        input: { dashboardId: "dash-123" },
+        output: { id: "dash-123", name: "Revenue Dashboard", widgets: [] }
+      }
+    ]
+  }
+});
+export {
+  WidgetTypeEnum,
+  WidgetModel,
+  RefreshIntervalEnum,
+  ListDashboardsOutputModel,
+  ListDashboardsInputModel,
+  ListDashboardsContract,
+  GetDashboardInputModel,
+  GetDashboardContract,
+  DashboardStatusEnum,
+  DashboardModel,
+  CreateDashboardInputModel,
+  CreateDashboardContract,
+  AddWidgetInputModel,
+  AddWidgetContract
+};

package/dist/browser/dashboard.feature.js

@@ -0,0 +1,84 @@
+// src/dashboard.feature.ts
+import { defineFeature } from "@contractspec/lib.contracts";
+var AnalyticsDashboardFeature = defineFeature({
+  meta: {
+    key: "analytics-dashboard",
+    version: "1.0.0",
+    title: "Analytics Dashboard",
+    description: "Analytics dashboards with customizable widgets and queries",
+    domain: "analytics",
+    owners: ["@analytics-dashboard"],
+    tags: ["analytics", "dashboards", "widgets", "queries"],
+    stability: "experimental"
+  },
+  operations: [
+    { key: "analytics.dashboard.create", version: "1.0.0" },
+    { key: "analytics.dashboard.list", version: "1.0.0" },
+    { key: "analytics.dashboard.get", version: "1.0.0" },
+    { key: "analytics.widget.add", version: "1.0.0" },
+    { key: "analytics.query.create", version: "1.0.0" },
+    { key: "analytics.query.execute", version: "1.0.0" }
+  ],
+  events: [
+    { key: "analytics.dashboard.created", version: "1.0.0" },
+    { key: "analytics.widget.added", version: "1.0.0" },
+    { key: "analytics.query.created", version: "1.0.0" }
+  ],
+  presentations: [
+    { key: "analytics.dashboard.viewList", version: "1.0.0" },
+    { key: "analytics.dashboard.view", version: "1.0.0" },
+    { key: "analytics.dashboard.editor", version: "1.0.0" },
+    { key: "analytics.query.list", version: "1.0.0" },
+    { key: "analytics.query.builder", version: "1.0.0" }
+  ],
+  opToPresentation: [
+    {
+      op: { key: "analytics.dashboard.list", version: "1.0.0" },
+      pres: { key: "analytics.dashboard.viewList", version: "1.0.0" }
+    },
+    {
+      op: { key: "analytics.dashboard.get", version: "1.0.0" },
+      pres: { key: "analytics.dashboard.view", version: "1.0.0" }
+    },
+    {
+      op: { key: "analytics.dashboard.create", version: "1.0.0" },
+      pres: { key: "analytics.dashboard.editor", version: "1.0.0" }
+    },
+    {
+      op: { key: "analytics.query.create", version: "1.0.0" },
+      pres: { key: "analytics.query.builder", version: "1.0.0" }
+    }
+  ],
+  presentationsTargets: [
+    {
+      key: "analytics.dashboard.viewList",
+      version: "1.0.0",
+      targets: ["react", "markdown", "application/json"]
+    },
+    {
+      key: "analytics.dashboard.view",
+      version: "1.0.0",
+      targets: ["react", "markdown"]
+    },
+    {
+      key: "analytics.dashboard.editor",
+      version: "1.0.0",
+      targets: ["react"]
+    },
+    {
+      key: "analytics.query.builder",
+      version: "1.0.0",
+      targets: ["react"]
+    }
+  ],
+  capabilities: {
+    requires: [
+      { key: "identity", version: "1.0.0" },
+      { key: "metering", version: "1.0.0" },
+      { key: "audit-trail", version: "1.0.0" }
+    ]
+  }
+});
+export {
+  AnalyticsDashboardFeature
+};