github/penpot
1
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2026-09-08 21:19:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

📎 Update mcp server api_types.yml

Browse Source
This commit is contained in:
Andrey Antukh 2026-06-11 13:31:17 +02:00
parent 70cbb65f9c
commit 2d843da2cd
1 changed files with 57 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
mcp/packages/server/data/api_types.yml
View File

@ -15,7 +15,7 @@ Penpot:
) => void; ) => void;
size: { width: number; height: number } | null; size: { width: number; height: number } | null;
resize: (width: number, height: number) => void; resize: (width: number, height: number) => void;
sendMessage: (message: unknown) => void; sendMessage: (message: unknown, throwOnError?: boolean) => void;
onMessage: <T>(callback: (message: T) => void) => void; onMessage: <T>(callback: (message: T) => void) => void;
}; };
utils: ContextUtils; utils: ContextUtils;
@ -105,7 +105,7 @@ Penpot:
) => void; ) => void;
size: { width: number; height: number } | null; size: { width: number; height: number } | null;
resize: (width: number, height: number) => void; resize: (width: number, height: number) => void;
sendMessage: (message: unknown) => void; sendMessage: (message: unknown, throwOnError?: boolean) => void;
onMessage: <T>(callback: (message: T) => void) => void; onMessage: <T>(callback: (message: T) => void) => void;
} }
``` ```
@ -130,7 +130,7 @@ Penpot:
``` ```
penpot.ui.resize(300, 400); penpot.ui.resize(300, 400);
``` ```
* sendMessage: (message: unknown) => void * sendMessage: (message: unknown, throwOnError?: boolean) => void
Sends a message to the plugin UI. Sends a message to the plugin UI.
@ -4592,23 +4592,23 @@ CommonLayout:
``` ```
interface CommonLayout { interface CommonLayout {
alignItems?: "center" | "start" | "end" | "stretch"; alignItems?: "end" | "start" | "center" | "stretch";
alignContent?: alignContent?:
| "center"
| "start"
| "end" | "end"
| "start"
| "center"
| "stretch" | "stretch"
| "space-between" | "space-between"
| "space-around" | "space-around"
| "space-evenly"; | "space-evenly";
justifyItems?: "center" justifyItems?: "end"
| "start" | "start"
| "end" | "center"
| "stretch"; | "stretch";
justifyContent?: justifyContent?:
| "center"
| "start"
| "end" | "end"
| "start"
| "center"
| "stretch" | "stretch"
| "space-between" | "space-between"
| "space-around" | "space-around"
@ -4638,7 +4638,7 @@ CommonLayout:
Properties: Properties:
alignItems: |- alignItems: |-
``` ```
alignItems?: "center" | "start" | "end" | "stretch" alignItems?: "end" | "start" | "center" | "stretch"
``` ```
The `alignItems` property specifies the default alignment for items inside the container. The `alignItems` property specifies the default alignment for items inside the container.
@ -4651,9 +4651,9 @@ CommonLayout:
alignContent: |- alignContent: |-
``` ```
alignContent?: alignContent?:
| "center"
| "start"
| "end" | "end"
| "start"
| "center"
| "stretch" | "stretch"
| "space-between" | "space-between"
| "space-around" | "space-around"
@ -4672,7 +4672,7 @@ CommonLayout:
* 'stretch': Content is stretched to fill the container. * 'stretch': Content is stretched to fill the container.
justifyItems: |- justifyItems: |-
``` ```
justifyItems?: "center" | "start" | "end" | "stretch" justifyItems?: "end" | "start" | "center" | "stretch"
``` ```
The `justifyItems` property specifies the default justification for items inside the container. The `justifyItems` property specifies the default justification for items inside the container.
@ -4685,9 +4685,9 @@ CommonLayout:
justifyContent: |- justifyContent: |-
``` ```
justifyContent?: justifyContent?:
| "center"
| "start"
| "end" | "end"
| "start"
| "center"
| "stretch" | "stretch"
| "space-between" | "space-between"
| "space-around" | "space-around"
@ -7298,23 +7298,23 @@ FlexLayout:
``` ```
interface FlexLayout { interface FlexLayout {
alignItems?: "center" | "start" | "end" | "stretch"; alignItems?: "end" | "start" | "center" | "stretch";
alignContent?: alignContent?:
| "center"
| "start"
| "end" | "end"
| "start"
| "center"
| "stretch" | "stretch"
| "space-between" | "space-between"
| "space-around" | "space-around"
| "space-evenly"; | "space-evenly";
justifyItems?: "center" justifyItems?: "end"
| "start" | "start"
| "end" | "center"
| "stretch"; | "stretch";
justifyContent?: justifyContent?:
| "center"
| "start"
| "end" | "end"
| "start"
| "center"
| "stretch" | "stretch"
| "space-between" | "space-between"
| "space-around" | "space-around"
@ -7348,7 +7348,7 @@ FlexLayout:
Properties: Properties:
alignItems: |- alignItems: |-
``` ```
alignItems?: "center" | "start" | "end" | "stretch" alignItems?: "end" | "start" | "center" | "stretch"
``` ```
The `alignItems` property specifies the default alignment for items inside the container. The `alignItems` property specifies the default alignment for items inside the container.
@ -7361,9 +7361,9 @@ FlexLayout:
alignContent: |- alignContent: |-
``` ```
alignContent?: alignContent?:
| "center"
| "start"
| "end" | "end"
| "start"
| "center"
| "stretch" | "stretch"
| "space-between" | "space-between"
| "space-around" | "space-around"
@ -7382,7 +7382,7 @@ FlexLayout:
* 'stretch': Content is stretched to fill the container. * 'stretch': Content is stretched to fill the container.
justifyItems: |- justifyItems: |-
``` ```
justifyItems?: "center" | "start" | "end" | "stretch" justifyItems?: "end" | "start" | "center" | "stretch"
``` ```
The `justifyItems` property specifies the default justification for items inside the container. The `justifyItems` property specifies the default justification for items inside the container.
@ -7395,9 +7395,9 @@ FlexLayout:
justifyContent: |- justifyContent: |-
``` ```
justifyContent?: justifyContent?:
| "center"
| "start"
| "end" | "end"
| "start"
| "center"
| "stretch" | "stretch"
| "space-between" | "space-between"
| "space-around" | "space-around"
@ -7856,23 +7856,23 @@ GridLayout:
``` ```
interface GridLayout { interface GridLayout {
alignItems?: "center" | "start" | "end" | "stretch"; alignItems?: "end" | "start" | "center" | "stretch";
alignContent?: alignContent?:
| "center"
| "start"
| "end" | "end"
| "start"
| "center"
| "stretch" | "stretch"
| "space-between" | "space-between"
| "space-around" | "space-around"
| "space-evenly"; | "space-evenly";
justifyItems?: "center" justifyItems?: "end"
| "start" | "start"
| "end" | "center"
| "stretch"; | "stretch";
justifyContent?: justifyContent?:
| "center"
| "start"
| "end" | "end"
| "start"
| "center"
| "stretch" | "stretch"
| "space-between" | "space-between"
| "space-around" | "space-around"
@ -7915,7 +7915,7 @@ GridLayout:
Properties: Properties:
alignItems: |- alignItems: |-
``` ```
alignItems?: "center" | "start" | "end" | "stretch" alignItems?: "end" | "start" | "center" | "stretch"
``` ```
The `alignItems` property specifies the default alignment for items inside the container. The `alignItems` property specifies the default alignment for items inside the container.
@ -7928,9 +7928,9 @@ GridLayout:
alignContent: |- alignContent: |-
``` ```
alignContent?: alignContent?:
| "center"
| "start"
| "end" | "end"
| "start"
| "center"
| "stretch" | "stretch"
| "space-between" | "space-between"
| "space-around" | "space-around"
@ -7949,7 +7949,7 @@ GridLayout:
* 'stretch': Content is stretched to fill the container. * 'stretch': Content is stretched to fill the container.
justifyItems: |- justifyItems: |-
``` ```
justifyItems?: "center" | "start" | "end" | "stretch" justifyItems?: "end" | "start" | "center" | "stretch"
``` ```
The `justifyItems` property specifies the default justification for items inside the container. The `justifyItems` property specifies the default justification for items inside the container.
@ -7962,9 +7962,9 @@ GridLayout:
justifyContent: |- justifyContent: |-
``` ```
justifyContent?: justifyContent?:
| "center"
| "start"
| "end" | "end"
| "start"
| "center"
| "stretch" | "stretch"
| "space-between" | "space-between"
| "space-around" | "space-around"
@ -10592,7 +10592,7 @@ LayoutChildProperties:
zIndex: number; zIndex: number;
horizontalSizing: "fill" | "auto" | "fix"; horizontalSizing: "fill" | "auto" | "fix";
verticalSizing: "fill" | "auto" | "fix"; verticalSizing: "fill" | "auto" | "fix";
alignSelf: "center" | "auto" | "start" | "end" | "stretch"; alignSelf: "end" | "start" | "center" | "auto" | "stretch";
horizontalMargin: number; horizontalMargin: number;
verticalMargin: number; verticalMargin: number;
topMargin: number; topMargin: number;
@ -10645,7 +10645,7 @@ LayoutChildProperties:
* 'fix': The height is fixed. * 'fix': The height is fixed.
alignSelf: |- alignSelf: |-
``` ```
alignSelf: "center" | "auto" | "start" | "end" | "stretch" alignSelf: "end" | "start" | "center" | "auto" | "stretch"
``` ```
Aligns the child element within its container. Aligns the child element within its container.
@ -11244,7 +11244,7 @@ LibraryComponent:
interface LibraryComponent { interface LibraryComponent {
instance(): Shape; instance(): Shape;
mainInstance(): Shape; mainInstance(): Shape;
isVariant(): boolean; isVariant(): this is LibraryVariantComponent;
transformInVariant(): void; transformInVariant(): void;
id: string; id: string;
libraryId: string; libraryId: string;
@ -11318,12 +11318,14 @@ LibraryComponent:
Returns the reference to the main component shape. Returns the reference to the main component shape.
isVariant: |- isVariant: |-
``` ```
isVariant(): boolean isVariant(): this is LibraryVariantComponent
``` ```
Returns boolean Checks whether this component is a variant component.
If true, the component can be used as a `LibraryVariantComponent`,
which provides additional attributes (e.g. `variants`) and methods.
true when this component is a VariantComponent Returns this is LibraryVariantComponent
transformInVariant: |- transformInVariant: |-
``` ```
transformInVariant(): void transformInVariant(): void
@ -11474,7 +11476,7 @@ LibraryVariantComponent:
interface LibraryVariantComponent { interface LibraryVariantComponent {
instance(): Shape; instance(): Shape;
mainInstance(): Shape; mainInstance(): Shape;
isVariant(): boolean; isVariant(): this is LibraryVariantComponent;
transformInVariant(): void; transformInVariant(): void;
variants: Variants | null; variants: Variants | null;
variantProps: { [property: string]: string }; variantProps: { [property: string]: string };
@ -11499,7 +11501,7 @@ LibraryVariantComponent:
* LibraryComponent * LibraryComponent
+ LibraryVariantComponent + LibraryVariantComponent
Referenced by: ContextTypesUtils Referenced by: ContextTypesUtils, LibraryComponent, LibraryVariantComponent
members: members:
Properties: Properties:
variants: |- variants: |-
@ -11571,12 +11573,14 @@ LibraryVariantComponent:
Returns the reference to the main component shape. Returns the reference to the main component shape.
isVariant: |- isVariant: |-
``` ```
isVariant(): boolean isVariant(): this is LibraryVariantComponent
``` ```
Returns boolean Checks whether this component is a variant component.
If true, the component can be used as a `LibraryVariantComponent`,
which provides additional attributes (e.g. `variants`) and methods.
true when this component is a VariantComponent Returns this is LibraryVariantComponent
transformInVariant: |- transformInVariant: |-
``` ```
transformInVariant(): void transformInVariant(): void