openpencil/packages/core/src/tools/create.ts

367 lines
12 KiB
TypeScript

import { parseColor } from '../color'
import { fetchIcons, searchIconsBatch } from '../iconify'
import type { SceneNode } from '../scene-graph'
import { defineTool, nodeSummary } from './schema'
import type { FigmaAPI, FigmaNodeProxy } from '../figma-api'
import type { Color } from '../types'
import type { Stroke, StrokeCap, StrokeJoin } from '../scene-graph'
export const createShape = defineTool({
name: 'create_shape',
mutates: true,
description:
'Create a shape on the canvas. Use FRAME for containers/cards, RECTANGLE for solid blocks, ELLIPSE for circles, TEXT for labels, SECTION for page sections.',
params: {
type: {
type: 'string',
description: 'Node type',
required: true,
enum: ['FRAME', 'RECTANGLE', 'ELLIPSE', 'TEXT', 'LINE', 'STAR', 'POLYGON', 'SECTION']
},
x: { type: 'number', description: 'X position', required: true },
y: { type: 'number', description: 'Y position', required: true },
width: { type: 'number', description: 'Width in pixels', required: true, min: 1 },
height: { type: 'number', description: 'Height in pixels', required: true, min: 1 },
name: { type: 'string', description: 'Node name shown in layers panel' },
parent_id: { type: 'string', description: 'Parent node ID to nest inside' }
},
execute: (figma, args) => {
const parentId = args.parent_id
const parent = parentId ? figma.getNodeById(parentId) : null
const createMap: Record<string, () => FigmaNodeProxy> = {
FRAME: () => figma.createFrame(),
RECTANGLE: () => figma.createRectangle(),
ELLIPSE: () => figma.createEllipse(),
TEXT: () => figma.createText(),
LINE: () => figma.createLine(),
STAR: () => figma.createStar(),
POLYGON: () => figma.createPolygon(),
SECTION: () => figma.createSection()
}
const node = createMap[args.type]()
node.x = args.x
node.y = args.y
node.resize(args.width, args.height)
if (args.name) node.name = args.name
if (parent) parent.appendChild(node)
return nodeSummary(node)
}
})
export const render = defineTool({
name: 'render',
mutates: true,
description:
'Render JSX to design nodes. Primary creation tool — creates entire component trees in one call. Example: <Frame name="Card" w={320} h="hug" flex="col" gap={16} p={24} bg="#FFF" rounded={16}><Text size={18} weight="bold">Title</Text></Frame>',
params: {
jsx: { type: 'string', description: 'JSX string to render', required: true },
x: { type: 'number', description: 'X position of the root node' },
y: { type: 'number', description: 'Y position of the root node' },
parent_id: { type: 'string', description: 'Parent node ID to render into' }
},
execute: async (figma, args) => {
const { renderJSX } = await import('../render/render-jsx.js')
const result = renderJSX(figma.graph, args.jsx, {
parentId: args.parent_id ?? figma.currentPageId,
x: args.x,
y: args.y
})
return { id: result.id, name: result.name, type: result.type, children: result.childIds }
}
})
export const createComponent = defineTool({
name: 'create_component',
mutates: true,
description: 'Convert a frame/group into a component.',
params: {
id: { type: 'string', description: 'Node ID to convert', required: true }
},
execute: (figma, { id }) => {
const node = figma.getNodeById(id)
if (!node) return { error: `Node "${id}" not found` }
const comp = figma.createComponentFromNode(node)
return nodeSummary(comp)
}
})
export const createInstance = defineTool({
name: 'create_instance',
mutates: true,
description: 'Create an instance of a component.',
params: {
component_id: { type: 'string', description: 'Component node ID', required: true },
x: { type: 'number', description: 'X position' },
y: { type: 'number', description: 'Y position' }
},
execute: (figma, args) => {
const comp = figma.getNodeById(args.component_id)
if (!comp) return { error: `Component "${args.component_id}" not found` }
const instance = comp.createInstance()
if (args.x !== undefined) instance.x = args.x
if (args.y !== undefined) instance.y = args.y
return nodeSummary(instance)
}
})
export const createPage = defineTool({
name: 'create_page',
mutates: true,
description: 'Create a new page.',
params: {
name: { type: 'string', description: 'Page name', required: true }
},
execute: (figma, { name }) => {
const page = figma.createPage()
page.name = name
return { id: page.id, name }
}
})
export const createVector = defineTool({
name: 'create_vector',
mutates: true,
description: 'Create a vector node with optional path data.',
params: {
x: { type: 'number', description: 'X position', required: true },
y: { type: 'number', description: 'Y position', required: true },
name: { type: 'string', description: 'Node name' },
path: { type: 'string', description: 'VectorNetwork JSON' },
fill: { type: 'color', description: 'Fill color (hex)' },
stroke: { type: 'color', description: 'Stroke color (hex)' },
stroke_weight: { type: 'number', description: 'Stroke weight' },
parent_id: { type: 'string', description: 'Parent node ID' }
},
execute: (figma, args) => {
const node = figma.createVector()
node.x = args.x
node.y = args.y
if (args.name) node.name = args.name
if (args.path) {
figma.graph.updateNode(node.id, { vectorNetwork: JSON.parse(args.path) as SceneNode['vectorNetwork'] })
}
if (args.fill) {
node.fills = [{ type: 'SOLID', color: parseColor(args.fill), opacity: 1, visible: true }]
}
if (args.stroke) {
node.strokes = [
{
color: parseColor(args.stroke),
weight: args.stroke_weight ?? 1,
opacity: 1,
visible: true,
align: 'CENTER'
}
]
}
if (args.parent_id) {
const parent = figma.getNodeById(args.parent_id)
if (parent) parent.appendChild(node)
}
return nodeSummary(node)
}
})
export const createSlice = defineTool({
name: 'create_slice',
mutates: true,
description: 'Create a slice (export region) on the canvas.',
params: {
x: { type: 'number', description: 'X position', required: true },
y: { type: 'number', description: 'Y position', required: true },
width: { type: 'number', description: 'Width', required: true, min: 1 },
height: { type: 'number', description: 'Height', required: true, min: 1 },
name: { type: 'string', description: 'Slice name' },
parent_id: { type: 'string', description: 'Parent node ID' }
},
execute: (figma, args) => {
const node = figma.createFrame()
node.x = args.x
node.y = args.y
node.resize(args.width, args.height)
node.name = args.name ?? 'Slice'
node.fills = []
if (args.parent_id) {
const parent = figma.getNodeById(args.parent_id)
if (parent) parent.appendChild(node)
}
return nodeSummary(node)
}
})
const STROKE_CAP_MAP: Record<string, StrokeCap> = {
butt: 'NONE',
round: 'ROUND',
square: 'SQUARE'
}
const STROKE_JOIN_MAP: Record<string, StrokeJoin> = {
miter: 'MITER',
round: 'ROUND',
bevel: 'BEVEL'
}
export const fetchIconsTool = defineTool({
name: 'fetch_icons',
description:
'Pre-fetch icons from Iconify into cache. Batches by prefix (one HTTP request per set). Call this once with all needed icons, then use insert_icon to place them instantly. Popular sets: lucide (outline), mdi (filled), heroicons, tabler, solar, mingcute, ri (remix).',
params: {
names: {
type: 'string[]',
description: 'Icon names as prefix:name (e.g. ["lucide:heart", "lucide:home", "mdi:star"])',
required: true
},
size: { type: 'number', description: 'Icon size in pixels (default: 24)' }
},
execute: async (_figma, args) => {
const size = args.size ?? 24
try {
const icons = await fetchIcons(args.names, size)
const fetched = [...icons.keys()]
const notFound = args.names.filter((n) => !icons.has(n))
const result: Record<string, unknown> = { fetched, count: fetched.length }
if (notFound.length > 0) result.not_found = notFound
return result
} catch (e) {
return { error: (e as Error).message }
}
}
})
import type { IconData } from '../iconify'
function createIconFrame(
figma: FigmaAPI,
icon: IconData,
name: string,
size: number,
parsedColor: Color,
parentId?: string
): FigmaNodeProxy {
const frame = figma.createFrame()
frame.name = `Icon / ${name}`
frame.resize(size, size)
frame.fills = []
if (parentId) {
const parent = figma.getNodeById(parentId)
if (parent) parent.appendChild(frame)
}
for (const path of icon.paths) {
const vector = figma.createVector()
vector.name = 'path'
vector.resize(size, size)
frame.appendChild(vector)
figma.graph.updateNode(vector.id, {
vectorNetwork: path.vectorNetwork
} as Record<string, unknown>)
if (path.fill) {
vector.fills = [{
type: 'SOLID',
color: path.fill === 'currentColor' ? parsedColor : parseColor(path.fill),
opacity: 1,
visible: true
}]
} else {
vector.fills = []
}
if (path.stroke) {
const strokeColor = path.stroke === 'currentColor' ? parsedColor : parseColor(path.stroke)
const stroke: Stroke = {
color: strokeColor,
weight: path.strokeWidth,
opacity: 1,
visible: true,
align: 'CENTER',
cap: STROKE_CAP_MAP[path.strokeCap] ?? 'NONE',
join: STROKE_JOIN_MAP[path.strokeJoin] ?? 'MITER'
}
vector.strokes = [stroke]
}
}
return frame
}
export const insertIcon = defineTool({
name: 'insert_icon',
mutates: true,
description:
'Insert one or more vector icons onto the canvas. Pass a single name or multiple names to batch-insert into the same parent. If already cached by fetch_icons — instant, no network request.',
params: {
names: {
type: 'string[]',
description: 'Icon names as prefix:name (e.g. ["lucide:heart"] or ["lucide:heart","lucide:home","lucide:star"])',
required: true
},
size: { type: 'number', description: 'Icon size in pixels (default: 24)' },
color: { type: 'color', description: 'Icon color hex (replaces currentColor). Default: #000000' },
parent_id: { type: 'string', description: 'Parent node ID for all icons' }
},
execute: async (figma, args) => {
const size = args.size ?? 24
const color = args.color ?? '#000000'
const parsedColor = parseColor(color)
let icons
try {
icons = await fetchIcons(args.names, size)
} catch (e) {
return { error: (e as Error).message }
}
const inserted: { id: string; name: string; icon: string }[] = []
const notFound: string[] = []
for (const name of args.names) {
const icon = icons.get(name)
if (!icon || icon.paths.length === 0) {
notFound.push(name)
continue
}
const frame = createIconFrame(figma, icon, name, size, parsedColor, args.parent_id)
inserted.push({ id: frame.id, name: frame.name, icon: name })
}
const result: Record<string, unknown> = { inserted }
if (notFound.length > 0) result.not_found = notFound
return result
}
})
export const searchIconsTool = defineTool({
name: 'search_icons',
description:
'Search Iconify for icons by keyword. Accepts multiple queries — all searched in parallel. Returns results keyed by query.',
params: {
queries: {
type: 'string[]',
description: 'Search keywords (e.g. ["heart", "arrow", "settings"])',
required: true
},
limit: { type: 'number', description: 'Max results per query (default: 20)' },
prefix: { type: 'string', description: 'Filter by icon set prefix (e.g. "lucide", "mdi")' }
},
execute: async (_figma, args) => {
try {
const results = await searchIconsBatch(args.queries, {
limit: args.limit ?? 20,
prefix: args.prefix
})
const output: Record<string, { icons: string[]; total: number }> = {}
for (const [query, result] of results) {
output[query] = { icons: result.icons, total: result.total }
}
return output
} catch (e) {
return { error: (e as Error).message }
}
}
})