Skip to content

Architecture ​

Scope: the package boundaries and the documentation pipeline.

Year Planner for React is an ESM-only monorepo with two public packages and two private apps:

  • @blendsdk/year-planner-core — pure TypeScript dates, intervals, validation, visibility resolution, layout geometry, ribbon lanes, hit index and print planning. No React, no DOM.
  • @blendsdk/react-year-planner — React view, interaction engine, command pipeline, renderer, theme provider, slots and design-system adapters.
  • apps/demo — private integration demo and the benchmark route.
  • apps/storybook — private component catalogue and the published site.

Mermaid diagram ​

mermaid
flowchart LR
  subgraph Core["@blendsdk/year-planner-core"]
    Dates[Dates and intervals]
    Model[Validation and visibility]
    Layout[Year layout]
    Ribbon[Ribbons and lanes]
    Print[Print planning]
  end

  subgraph React["@blendsdk/react-year-planner"]
    View[YearPlanner view]
    Interaction[Interaction engine]
    Commands[Command pipeline]
    Theme[Theme and adapters]
  end

  Dates --> Layout
  Model --> Layout
  Layout --> Ribbon
  Layout --> Print
  Layout --> View
  Ribbon --> View
  Interaction --> Commands
  View --> Interaction
  Theme --> View

  Demo["apps/demo"] --> React
  Storybook["apps/storybook"] --> React
  Storybook --> StorybookStatic["storybook-static/"]
  TypeDoc["TypeDoc"] --> Api["storybook-static/api/"]
  StorybookStatic --> Pages["GitHub Pages artifact"]
  Api --> Pages

Rules ​

  • The core package never imports React or reads the DOM.
  • The React package imports the core through the public package entry, never a deep path.
  • The adapters (adapters/fluent, adapters/mui) accept plain theme objects and declare no design-system peer dependency.
  • Storybook and the demo consume the public packages; they are private and are not published.
  • TypeDoc reads the package entry points and the checked-in TSDoc; API Extractor protects the same surface.

Free for internal use. Built with VitePress, Storybook and TypeDoc.