Skip to content
ContractSpec
Start here

Package manual · examples

·Examples and implementation patterns

example.analytics-dashboard

Analytics Dashboard example with widgets and query engine for ContractSpec

examplesexamplev5.0.5stableservernode
@lssm-tech/example.analytics-dashboard
bun add @lssm-tech/example.analytics-dashboard
Package source ↗Manifest ↗

Manifest declarations describe the current workspace; they do not verify registry publication or runtime execution.

Package guide

Website: https://contractspec.io

Analytics Dashboard example with widgets and query engine for ContractSpec.

What This Demonstrates

  • Dashboard feature with presentation, schema, enum, and test-spec.
  • Query engine with typed operations and handlers.
  • PostHog datasource adapter.
  • React UI with hooks, renderers, markdown output, and a shared ContractSpec DataTable for saved queries.
  • Client-mode table capabilities including sorting, pagination, column visibility, column resizing, pinning, and expandable row details.
  • Event definitions for analytics tracking.
  • Seeders for demo data.

Running Locally

From examples/analytics-dashboard:

  • bun run dev
  • bun run build
  • bun run test
  • bun run typecheck
  • bun run preflight

Usage

Use @lssm-tech/example.analytics-dashboard as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.

Architecture

  • src/dashboard is part of the package's public or composition surface.
  • src/dashboard.feature.ts defines a feature entrypoint.
  • src/datasource is part of the package's public or composition surface.
  • src/docs/ contains docblocks and documentation-facing exports.
  • src/events.ts is package-level event definitions.
  • src/example.ts is the runnable example entrypoint.
  • src/handlers/ contains handlers or demo adapters wired to contract surfaces.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./dashboard resolves through ./src/dashboard/index.ts.
  • Export ./dashboard.feature resolves through ./src/dashboard.feature.ts.
  • Export ./dashboard/dashboard.enum resolves through ./src/dashboard/dashboard.enum.ts.
  • Export ./dashboard/dashboard.operation resolves through ./src/dashboard/dashboard.operation.ts.
  • Export ./dashboard/dashboard.presentation resolves through ./src/dashboard/dashboard.presentation.ts.
  • Export ./dashboard/dashboard.schema resolves through ./src/dashboard/dashboard.schema.ts.
  • Export ./dashboard/dashboard.test-spec resolves through ./src/dashboard/dashboard.test-spec.ts.
  • Export ./datasource/posthog-datasource resolves through ./src/datasource/posthog-datasource.ts.
  • Export ./docs resolves through ./src/docs/index.ts.
  • The package publishes 37 total export subpaths; keep docs aligned with package.json.

Local Commands

  • bun run dev — contractspec-bun-build dev
  • bun run build — contractspec-bun-build build
  • bun run lint — bun lint:fix
  • bun run lint:check — biome check .
  • bun run lint:fix — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
  • bun run typecheck — tsgo --noEmit
  • bun run preflight — bun run build && bun run typecheck && bun run test
  • bun run publish:pkg — bun publish --tolerate-republish --ignore-scripts --verbose
  • bun run publish:pkg:canary — bun publish:pkg --tag canary
  • bun run clean — rimraf dist .turbo
  • bun run build:bundle — contractspec-bun-build transpile
  • bun run build:types — contractspec-bun-build types
  • bun run prebuild — contractspec-bun-build prebuild

Recent Updates

  • Replace eslint+prettier by biomejs to optimize speed.
  • Add data visualization capabilities.
  • Missing contract layers.

Notes

  • Works alongside @lssm-tech/lib.contracts-integrations, @lssm-tech/lib.contracts-spec, @lssm-tech/lib.design-system, @lssm-tech/lib.example-shared-ui, @lssm-tech/lib.runtime-sandbox, ...

Relationships

THIS PACKAGEexample.analytics-dashboard37 import paths

Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.

11 declarations

Declared capabilities

This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.

Scripts

  • publish:pkgbun publish --tolerate-republish --ignore-scripts --verbose
  • publish:pkg:canarybun publish:pkg --tag canary
  • buildcontractspec-bun-build build
  • build:bundlecontractspec-bun-build transpile
  • build:typescontractspec-bun-build types
  • devcontractspec-bun-build dev
  • cleanrimraf dist .turbo
  • lintbun lint:fix
  • lint:fixnode ../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../scripts/biome.cjs check --write .
  • lint:checknode ../../scripts/biome.cjs check .
  • testbun test
  • prebuildcontractspec-bun-build prebuild
  • typechecktsgo --noEmit
  • preflightbun run build && bun run typecheck && bun run test