@smile-design/shared

Shared TypeScript types and utilities for smile-design — consumed by @smile-design/mcp-server, @smile-design/design-engine, @smile-design/preview-server, @smile-design/inspector, and the smile-design Web UI.

This package is the type contract layer of smile-design. End users rarely import this directly — instead they use the higher-level packages above. Publish it for transitive resolution.

Install

pnpm add @smile-design/shared

Use

import type {
  DOMContext,
  SelectedElement,
  StyleDiff,
  DesignTokens,
  ProjectState,
  AestheticReport,
  HarnessEvent,
} from '@smile-design/shared';

// Subpath imports are also supported:
import type { DesignMdAst } from '@smile-design/shared/types';
import { ensureProjectDir } from '@smile-design/shared/utils';

What's inside

• DOM / Inspector — DOMContext, SelectedElement, InspectorMessage, StyleDiff, SetStyleMessage, ResetStyleMessage
• Design Tokens / DESIGN.md — DesignTokens, DesignMdAst, DesignTokenCategory
• Aesthetic checks — AestheticReport, AestheticIssue, AestheticSeverity
• Harness — HarnessEvent, GuideContext, SensorReport
• MCP / Agent / Preview — BatchOp, ChatMessage, PreviewStatus, ProjectState, ProjectTemplate

Requirements

• Node.js ≥ 22 (LTS)
• TypeScript ≥ 5.4 (consumers)

License

MIT