vndangkhoa/openpencil
1
0
Fork 0
mirror of https://github.com/ZSeven-W/openpencil.git synced 2026-05-31 19:04:29 +07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
openpencil/packages/pen-types
History
Kayshen-X c4e5359596 docs: drop op export from CLI docs and clarify pen-mcp usage 
The `op export` command was removed in 0.7.x but the README still
advertised it (#116). The pen-mcp README also documented an
`npx @zseven-w/pen-mcp` quick-start that never worked because the
package ships TypeScript source against workspace-only deps with no
`bin` entry (#117).

- Strip `op export` references from all 15 root and 15 cli READMEs
- Sync AGENTS.md, CLAUDE.md, apps/cli/CLAUDE.md to match the codegen-
  pipeline reality (no standalone export command anymore)
- Rewrite pen-mcp README's quick-start: explain the package ships as
  part of the OpenPencil app and external clients connect over HTTP

Closes #116
Closes #117
2026-04-26 19:20:14 +08:00
..
src V0.7.2-bugfix (#109) 2026-04-14 21:42:56 +08:00
CLAUDE.md V0.7.1 (#102) 2026-04-13 21:30:23 +08:00
LICENSE V0.7.1 (#102) 2026-04-13 21:30:23 +08:00
package.json docs: drop op export from CLI docs and clarify pen-mcp usage 2026-04-26 19:20:14 +08:00
README.md V0.7.1 (#102) 2026-04-13 21:30:23 +08:00
tsconfig.json V0.5.0 (#67) 2026-03-22 09:44:04 +08:00

README.md

@zseven-w/pen-types

Type definitions for the OpenPencil document model.

Install

npm install @zseven-w/pen-types

What's Included

This package provides all TypeScript types and interfaces for the OpenPencil design file format (.op):

  • Document model — PenDocument, PenPage, PenNode and all node types (FrameNode, RectangleNode, EllipseNode, TextNode, ImageNode, PathNode, etc.)
  • Styles — PenFill (solid, gradient, image), PenStroke, PenEffect (blur, shadow), BlendMode, StyledTextSegment
  • Variables & Themes — VariableDefinition, VariableValue, ThemedValue
  • Canvas state — ToolType, ViewportState, SelectionState, CanvasInteraction
  • UIKit — UIKit, KitComponent, ComponentCategory
  • Theme presets — ThemePreset, ThemePresetFile
  • Design spec — DesignMdSpec, DesignMdColor, DesignMdTypography

Usage

import type { PenDocument, PenNode, FrameNode } from '@zseven-w/pen-types';

License

MIT