framer-api 0.1.4-alpha.2 → 0.1.5

package/dist/index.d.ts

@@ -386,6 +386,10 @@ interface WithUnsupportedComputedValueClass {
     [classKey]: typeof unsupportedComputedValueClass;
 }
 type UnsupportedComputedValueData = WithUnsupportedComputedValueClass;
+/**
+ * A computed value type not yet supported by the plugin API.
+ * @category canvas
+ */
 declare class UnsupportedComputedValue extends ComputedValueBase {
     #private;
     readonly type = "unsupported";
@@ -426,7 +430,10 @@ declare const fontWeights: readonly [100, 200, 300, 400, 500, 600, 700, 800, 900
  * - `900` - Black (Heavy)
  * */
 type FontWeight = (typeof fontWeights)[number];
-/** A font available in the project, including custom uploaded fonts. */
+/**
+ * A font available in the project, including custom uploaded fonts.
+ * @category canvas
+ */
 declare class Font {
     /** An identifier used internally for differentiating fonts. */
     readonly selector: string;
@@ -738,6 +745,7 @@ interface IsComponentGestureVariant extends IsComponentVariant {
 interface WithNameTrait {
     /**
      * The name of the node displayed in the layers panel.
+     *
      * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode,
      * ComponentNode, VectorSetNode, VectorSetItemNode.
      */
@@ -745,14 +753,18 @@ interface WithNameTrait {
 }
 interface WithVisibleTrait {
     /**
-     * Whether the node is visible on the canvas. Defaults to `true`.
+     * Whether the node is visible on the canvas.
+     *
+     * Defaults to `true`.
      * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode, VectorSetItemNode.
      */
     readonly visible: boolean;
 }
 interface WithLockedTrait {
     /**
-     * Whether the node is locked for editing. Defaults to `false`.
+     * Whether the node is locked for editing.
+     *
+     * Defaults to `false`.
      * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode, VectorSetItemNode.
      */
     readonly locked: boolean;
@@ -770,6 +782,7 @@ interface IsBreakpoint {
 interface WithBackgroundColorTrait<T extends TraitVariant> {
     /**
      * Background color in RGBA format (e.g. `rgba(242, 59, 57, 1)`) or as a {@link ColorStyle} instance.
+     *
      * Setting to `null` removes the background color. Supported by FrameNode.
      */
     readonly backgroundColor: (T extends TraitVariantData ? ColorStyleData : ColorStyle) | string | null;
@@ -784,22 +797,26 @@ interface WithBackgroundGradientTrait<T extends TraitVariant> {
 }
 interface WithRotationTrait {
     /**
-     * Rotation angle in degrees. Defaults to `0`.
-     * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode.
+     * Rotation angle in degrees.
+     *
+     * Defaults to `0`. Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode.
      */
     readonly rotation: number;
 }
 interface WithOpacityTrait {
     /**
-     * Opacity of the node, from `0` (fully transparent) to `1` (fully opaque). Defaults to `1`.
-     * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode.
+     * Opacity of the node, from `0` (fully transparent) to `1` (fully opaque).
+     *
+     * Defaults to `1`. Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode.
      */
     readonly opacity: number;
 }
 type BorderRadius = CSSDimension<CSSUnit.Percentage | CSSUnit.Pixel> | `${CSSDimension<CSSUnit.Pixel>} ${CSSDimension<CSSUnit.Pixel>} ${CSSDimension<CSSUnit.Pixel>} ${CSSDimension<CSSUnit.Pixel>}` | null;
 interface WithBorderRadiusTrait {
     /**
-     * Border radius for rounded corners. Single value (e.g. `"10px"` or `"50%"`)
+     * Border radius for rounded corners.
+     *
+     * Single value (e.g. `"10px"` or `"50%"`)
      * or per-corner (e.g. `"10px 20px 30px 40px"` for top-left, top-right, bottom-right, bottom-left).
      * Setting to `null` removes the border radius. Supported by FrameNode.
      */
@@ -815,6 +832,7 @@ interface Border {
 interface WithBorderTrait<T extends TraitVariant> {
     /**
      * Border properties including width, color, and style.
+     *
      * Styles: `"solid"`, `"dashed"`, `"dotted"`, `"double"`.
      * Width can be per-side (e.g. `"1px 2px 3px 4px"`).
      * Setting to `null` removes the border. Supported by FrameNode.
@@ -826,6 +844,7 @@ type ImageRendering = "auto" | "pixelated";
 interface WithImageRenderingTrait {
     /**
      * How images should be rendered when scaled: `"auto"` or `"pixelated"`.
+     *
      * Only applies to frames with image backgrounds.
      * Setting to `null` uses default rendering. Supported by FrameNode.
      */
@@ -837,24 +856,28 @@ type AxisOverflow = Overflow;
 interface WithOverflowTrait {
     /**
      * Controls how content that exceeds the element's box is handled.
+     *
      * Setting to `null` removes the overflow property. Will overwrite `overflowX` or `overflowY`.
      * Supported by FrameNode, TextNode.
      */
     readonly overflow: Overflow | null;
     /**
      * Controls horizontal overflow behavior.
+     *
      * Setting to `null` removes the overflow X property. Supported by FrameNode, TextNode.
      */
     readonly overflowX: AxisOverflow | null;
     /**
      * Controls vertical overflow behavior.
+     *
      * Setting to `null` removes the overflow Y property. Supported by FrameNode, TextNode.
      */
     readonly overflowY: AxisOverflow | null;
 }
 interface WithTextTruncationTrait {
     /**
-     * Maximum number of lines a text node can display before being truncated with an ellipsis.
+     * Maximum number of lines before text is truncated with an ellipsis.
+     *
      * Must be used alongside `overflow`. Setting to `null` removes the text truncation property.
      * Supported by TextNode.
      */
@@ -862,7 +885,9 @@ interface WithTextTruncationTrait {
 }
 interface WithZIndexTrait {
     /**
-     * Stacking order of positioned elements. Higher values appear on top of lower values.
+     * Stacking order of positioned elements.
+     *
+     * Higher values appear on top of lower values.
      * Setting to `null` removes the z-index property. Supported by FrameNode, TextNode.
      */
     readonly zIndex: number | null;
@@ -888,13 +913,17 @@ interface WithWebPageInfoTrait {
 type SupportedLinkRelValue = "nofollow" | "noreferrer" | "me" | "ugc" | "sponsored";
 interface WithLinkTrait {
     /**
-     * URL or internal page link. External: `"https://example.com"`, internal: `"/about"`,
+     * URL or internal page link.
+     *
+     * External: `"https://example.com"`, internal: `"/about"`,
      * email: `"mailto:user@example.com"`. Setting to `null` removes the link.
      * Supported by FrameNode, TextNode.
      */
     readonly link: string | null;
     /**
-     * Whether to open the link in a new tab. Default is automatically determined based on link type.
+     * Whether to open the link in a new tab.
+     *
+     * Default is automatically determined based on link type.
      * Supported by FrameNode, TextNode.
      */
     readonly linkOpenInNewTab: boolean | null;
@@ -947,36 +976,42 @@ type FitImage = "fit-image";
 interface WithPinsTrait {
     /**
      * Distance from top edge when using absolute/fixed positioning.
+     *
      * Only applies when position is not `"relative"`.
      * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode, VectorSetItemNode.
      */
     top: CSSDimension<CSSUnit.Pixel> | null;
     /**
      * Distance from right edge when using absolute/fixed positioning.
+     *
      * Only applies when position is not `"relative"`.
      * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode, VectorSetItemNode.
      */
     right: CSSDimension<CSSUnit.Pixel> | null;
     /**
      * Distance from bottom edge when using absolute/fixed positioning.
+     *
      * Only applies when position is not `"relative"`.
      * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode, VectorSetItemNode.
      */
     bottom: CSSDimension<CSSUnit.Pixel> | null;
     /**
      * Distance from left edge when using absolute/fixed positioning.
+     *
      * Only applies when position is not `"relative"`.
      * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode, VectorSetItemNode.
      */
     left: CSSDimension<CSSUnit.Pixel> | null;
     /**
      * Center anchor horizontal position as percentage (e.g. `"50%"`).
+     *
      * Used when pins are not set.
      * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode, VectorSetItemNode.
      */
     centerX: CSSDimension<CSSUnit.Percentage> | null;
     /**
      * Center anchor vertical position as percentage (e.g. `"50%"`).
+     *
      * Used when pins are not set.
      * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode, VectorSetItemNode.
      */
@@ -987,12 +1022,16 @@ type WidthLength = Length | FitContent | FitImage;
 type HeightLength = Length | FitContent | CSSDimension<CSSUnit.ViewportHeight> | FitImage;
 interface WithSizeTrait {
     /**
-     * Width of the node. Accepts pixel, percentage, fraction values, or `"fit-content"`.
+     * Width of the node.
+     *
+     * Accepts pixel, percentage, fraction values, or `"fit-content"`.
      * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode, VectorSetItemNode.
      */
     width: WidthLength | null;
     /**
-     * Height of the node. Accepts pixel, percentage, fraction, viewport-height values, or `"fit-content"`.
+     * Height of the node.
+     *
+     * Accepts pixel, percentage, fraction, viewport-height values, or `"fit-content"`.
      * Supported by FrameNode, TextNode, SVGNode, ComponentInstanceNode, VectorSetItemNode.
      */
     height: HeightLength | null;
@@ -1000,6 +1039,7 @@ interface WithSizeTrait {
 interface WithAspectRatioTrait {
     /**
      * Width-to-height ratio (e.g. `1.5` for 3:2).
+     *
      * Setting to `null` removes the aspect ratio constraint.
      * Supported by FrameNode, ComponentInstanceNode.
      */
@@ -1019,8 +1059,9 @@ interface WithSizeConstraintsTrait {
 }
 interface WithInlineTextStyleTrait<T extends TraitVariant> {
     /**
-     * Apply a text style preset. Setting to `null` removes the text style.
-     * Supported by TextNode.
+     * Apply a text style preset.
+     *
+     * Setting to `null` removes the text style. Supported by TextNode.
      */
     readonly inlineTextStyle: (T extends TraitVariantData ? TextStyleData : TextStyle) | null;
 }
@@ -1069,18 +1110,24 @@ interface GridLayout {
 }
 interface WithLayoutTrait extends StackLayout, GridLayout {
     /**
-     * Enables stack or grid layout. Setting to `null` disables any applied layout.
+     * Enables stack or grid layout.
+     *
+     * Setting to `null` disables any applied layout.
      * Operation is deferred and applied after the current update cycle. Supported by FrameNode.
      */
     layout: LayoutType | null;
     /**
-     * Spacing between items in a layout. Single value (e.g. `"10px"`) applies to both axes;
+     * Spacing between items in a layout.
+     *
+     * Single value (e.g. `"10px"`) applies to both axes;
      * two values (e.g. `"10px 20px"`) set horizontal and vertical separately.
      * Only works with layout enabled. Supported by FrameNode.
      */
     gap: CSSDimension<CSSUnit.Pixel> | `${CSSDimension<CSSUnit.Pixel>} ${CSSDimension<CSSUnit.Pixel>}` | null;
     /**
-     * Inner spacing of a container with layout. Single value (e.g. `"10px"`) applies to all sides;
+     * Inner spacing of a container with layout.
+     *
+     * Single value (e.g. `"10px"`) applies to all sides;
      * four values (e.g. `"10px 20px 30px 40px"`) set top, right, bottom, left.
      * Only works with layout enabled. Supported by FrameNode.
      */
@@ -1089,17 +1136,41 @@ interface WithLayoutTrait extends StackLayout, GridLayout {
 type GridItemAlignment = "start" | "center" | "end";
 type GridItemColumnSpan = number | "all";
 interface WithGridItemTrait {
-    /** Whether to fill the grid cell width. For nodes inside a grid container. Defaults to `true`. Supported by FrameNode, TextNode. */
+    /**
+     * Whether to fill the grid cell width.
+     *
+     * For nodes inside a grid container. Defaults to `true`. Supported by FrameNode, TextNode.
+     */
     gridItemFillCellWidth: boolean | null;
-    /** Whether to fill the grid cell height. For nodes inside a grid container. Defaults to `true`. Supported by FrameNode, TextNode. */
+    /**
+     * Whether to fill the grid cell height.
+     *
+     * For nodes inside a grid container. Defaults to `true`. Supported by FrameNode, TextNode.
+     */
     gridItemFillCellHeight: boolean | null;
-    /** Horizontal alignment within grid cell. For nodes inside a grid container. Defaults to `"center"`. Supported by FrameNode, TextNode. */
+    /**
+     * Horizontal alignment within grid cell.
+     *
+     * For nodes inside a grid container. Defaults to `"center"`. Supported by FrameNode, TextNode.
+     */
     gridItemHorizontalAlignment: GridItemAlignment | null;
-    /** Vertical alignment within grid cell. For nodes inside a grid container. Defaults to `"center"`. Supported by FrameNode, TextNode. */
+    /**
+     * Vertical alignment within grid cell.
+     *
+     * For nodes inside a grid container. Defaults to `"center"`. Supported by FrameNode, TextNode.
+     */
     gridItemVerticalAlignment: GridItemAlignment | null;
-    /** Number of columns to span, or `"all"` for all columns. For nodes inside a grid container. Defaults to `1`. Supported by FrameNode, TextNode. */
+    /**
+     * Number of columns to span, or `"all"` for all columns.
+     *
+     * For nodes inside a grid container. Defaults to `1`. Supported by FrameNode, TextNode.
+     */
     gridItemColumnSpan: GridItemColumnSpan | null;
-    /** Number of rows to span. For nodes inside a grid container. Defaults to `1`. Supported by FrameNode, TextNode. */
+    /**
+     * Number of rows to span.
+     *
+     * For nodes inside a grid container. Defaults to `1`. Supported by FrameNode, TextNode.
+     */
     gridItemRowSpan: number | null;
 }
 type TraitVariant = TraitVariantData | TraitVariantNode;
@@ -1200,6 +1271,7 @@ type ColorStyleAttributes = Prettify<RequiredColorStyleAttributes & Partial<Opti
  * // Store plugin data on a color style.
  * await colorStyle.setPluginData("key", "value")
  * ```
+ * @category canvas
  */
 declare class ColorStyle {
     #private;
@@ -1379,6 +1451,7 @@ type TextStyleAttributes = Prettify<Partial<Omit<TextStyleData, "id" | "color" |
  * // Remove a text style from the project.
  * await textStyle.remove()
  * ```
+ * @category canvas
  */
 declare class TextStyle {
     #private;
@@ -1632,6 +1705,10 @@ declare abstract class GradientBase {
     cloneWithAttributes(attributes: Partial<ExtractUnmarshaledGradientAttributes<typeof this>>): typeof this;
 }
 type UnmarshaledLinearGradientAttributes = Omit<UnmarshaledLinearGradient, ClassKey>;
+/**
+ * A linear gradient with two or more color stops.
+ * @category canvas
+ */
 declare class LinearGradient extends GradientBase {
     #private;
     readonly [classKey]: "LinearGradient";
@@ -1643,6 +1720,10 @@ declare class LinearGradient extends GradientBase {
     toCSS(): string;
 }
 type UnmarshaledRadialGradientAttributes = Omit<UnmarshaledRadialGradient, ClassKey>;
+/**
+ * A radial gradient with two or more color stops.
+ * @category canvas
+ */
 declare class RadialGradient extends GradientBase {
     #private;
     readonly [classKey]: "RadialGradient";
@@ -1660,6 +1741,10 @@ declare class RadialGradient extends GradientBase {
     toCSS(): string;
 }
 type UnmarshaledConicGradientAttributes = Omit<UnmarshaledConicGradient, ClassKey>;
+/**
+ * A conic (angular) gradient with two or more color stops.
+ * @category canvas
+ */
 declare class ConicGradient extends GradientBase {
     #private;
     readonly [classKey]: "ConicGradient";
@@ -1768,6 +1853,10 @@ interface CreateBooleanVariable extends WithBooleanVariableType, CreateVariableB
 }
 interface UpdateBooleanVariable extends WithBooleanVariableType, UpdateVariableBase, Partial<WithBooleanDefaultValue> {
 }
+/**
+ * A boolean variable.
+ * @category canvas
+ */
 declare class BooleanVariable extends VariableBase {
     #private;
     readonly type: "boolean";
@@ -1792,6 +1881,10 @@ interface CreateNumberVariable extends WithNumberVariableType, CreateVariableBas
 }
 interface UpdateNumberVariable extends WithNumberVariableType, UpdateVariableBase, Partial<WithNumberDefaultValue> {
 }
+/**
+ * A number variable.
+ * @category canvas
+ */
 declare class NumberVariable extends VariableBase {
     #private;
     readonly type: "number";
@@ -1816,6 +1909,10 @@ interface CreateStringVariable extends WithStringVariableType, CreateVariableBas
 }
 interface UpdateStringVariable extends WithStringVariableType, UpdateVariableBase, Partial<WithStringDefaultValue> {
 }
+/**
+ * A string variable.
+ * @category canvas
+ */
 declare class StringVariable extends VariableBase {
     #private;
     readonly type: "string";
@@ -1837,6 +1934,10 @@ interface CreateFormattedTextVariable extends WithFormattedTextVariableType, Cre
 }
 interface UpdateFormattedTextVariable extends WithFormattedTextVariableType, UpdateVariableBase, Partial<WithStringDefaultValue> {
 }
+/**
+ * A formatted text (rich text) variable.
+ * @category canvas
+ */
 declare class FormattedTextVariable extends VariableBase {
     #private;
     readonly type: "formattedText";
@@ -1850,7 +1951,10 @@ interface EnumCaseData extends WithId, WithName, WithNameByLocale {
 }
 interface UpdateEnumCase extends Partial<WithName>, Partial<WithNameByLocaleUpdate> {
 }
-/** An individual case (option) within an Enum Field or Enum Variable. */
+/**
+ * An individual case (option) within an Enum Field or Enum Variable.
+ * @category cms
+ */
 declare class EnumCase {
     #private;
     /** A unique identifier for the enum case. */
@@ -1915,6 +2019,10 @@ interface CreateEnumVariable extends WithEnumVariableType, CreateVariableBase {
 }
 interface UpdateEnumVariable extends WithEnumVariableType, UpdateVariableBase, Partial<WithStringDefaultValue> {
 }
+/**
+ * An enum variable with a fixed set of cases.
+ * @category canvas
+ */
 declare class EnumVariable extends VariableBase {
     #private;
     readonly type: "enum";
@@ -1955,6 +2063,10 @@ interface CreateColorVariable extends WithColorVariableType, CreateVariableBase,
 }
 interface UpdateColorVariable extends WithColorVariableType, UpdateVariableBase, Partial<WithColorDefaultValue> {
 }
+/**
+ * A color variable.
+ * @category canvas
+ */
 declare class ColorVariable extends VariableBase {
     #private;
     readonly type: "color";
@@ -1982,6 +2094,10 @@ interface CreateImageVariable extends WithImageVariableType, CreateVariableBase,
 }
 interface UpdateImageVariable extends WithImageVariableType, UpdateVariableBase, Partial<WithImageDefaultValue> {
 }
+/**
+ * An image variable.
+ * @category canvas
+ */
 declare class ImageVariable extends VariableBase {
     #private;
     readonly type: "image";
@@ -2020,6 +2136,10 @@ interface CreateFileVariable extends WithFileVariableType, CreateVariableBase, P
 }
 interface UpdateFileVariable extends WithFileVariableType, UpdateVariableBase, Partial<WithFileDefaultValue>, Partial<WithAllowedFileTypes> {
 }
+/**
+ * A file variable.
+ * @category canvas
+ */
 declare class FileVariable extends VariableBase {
     #private;
     readonly type: "file";
@@ -2042,6 +2162,10 @@ interface CreateLinkVariable extends WithLinkVariableType, CreateVariableBase {
 }
 interface UpdateLinkVariable extends WithLinkVariableType, UpdateVariableBase {
 }
+/**
+ * A link variable.
+ * @category canvas
+ */
 declare class LinkVariable extends VariableBase {
     #private;
     readonly type: "link";
@@ -2066,6 +2190,10 @@ interface CreateDateVariable extends WithDateVariableType, CreateVariableBase, P
 }
 interface UpdateDateVariable extends WithDateVariableType, UpdateVariableBase, Partial<WithStringDefaultValue>, Partial<WithDisplayTime> {
 }
+/**
+ * A date variable.
+ * @category canvas
+ */
 declare class DateVariable extends VariableBase {
     #private;
     readonly type: "date";
@@ -2094,6 +2222,10 @@ interface CreateBorderVariable extends WithBorderVariableType, CreateVariableBas
 }
 interface UpdateBorderVariable extends WithBorderVariableType, UpdateVariableBase, Partial<WithBorderDefaultValue> {
 }
+/**
+ * A border variable.
+ * @category canvas
+ */
 declare class BorderVariable extends VariableBase {
     #private;
     readonly type: "border";
@@ -2113,6 +2245,10 @@ interface UnsupportedVariableData extends WithUnsupportedVariableClass, BaseVari
 }
 interface UpdateUnsupportedVariable extends WithUnsupportedVariableType, UpdateVariableBase {
 }
+/**
+ * A variable type not yet supported by the plugin API.
+ * @category canvas
+ */
 declare class UnsupportedVariable extends VariableBase {
     #private;
     readonly type: "unsupported";
@@ -2197,38 +2333,62 @@ declare abstract class FieldBaseWithRequired extends FieldBase implements WithFi
     get required(): boolean;
     constructor(engine: PluginEngine, collectionId: string, data: FieldDefinitionBase & WithFieldRequired);
 }
-/** A CMS Collection field that stores a boolean (true or false) value. */
+/**
+ * A CMS Collection field that stores a boolean (true or false) value.
+ * @category cms
+ */
 declare class BooleanField extends FieldBase {
     readonly type = "boolean";
 }
-/** A CMS Collection field that stores a color value (RGBA/HSL/HEX format). */
+/**
+ * A CMS Collection field that stores a color value (RGBA/HSL/HEX format).
+ * @category cms
+ */
 declare class ColorField extends FieldBase {
     readonly type = "color";
 }
-/** A CMS Collection field that stores a numeric value. */
+/**
+ * A CMS Collection field that stores a numeric value.
+ * @category cms
+ */
 declare class NumberField extends FieldBase {
     readonly type = "number";
 }
-/** A CMS Collection field that stores a text string value. */
+/**
+ * A CMS Collection field that stores a text string value.
+ * @category cms
+ */
 declare class StringField extends FieldBaseWithRequired implements WithFieldBasedOn {
     #private;
     readonly type = "string";
     constructor(engine: PluginEngine, collectionId: string, data: StringFieldDefinitionData);
     get basedOn(): string | null;
 }
-/** A CMS Collection field that stores HTML-formatted text content (H1-H6, P, and other standard content elements). */
+/**
+ * A CMS Collection field that stores HTML-formatted text content (H1-H6, P, and other standard content elements).
+ * @category cms
+ */
 declare class FormattedTextField extends FieldBaseWithRequired {
     readonly type = "formattedText";
 }
-/** A CMS Collection field that stores an image asset (`ImageAsset`). */
+/**
+ * A CMS Collection field that stores an image asset (`ImageAsset`).
+ * @category cms
+ */
 declare class ImageField extends FieldBaseWithRequired {
     readonly type = "image";
 }
-/** A CMS Collection field that stores a URL in string format. */
+/**
+ * A CMS Collection field that stores a URL in string format.
+ * @category cms
+ */
 declare class LinkField extends FieldBaseWithRequired {
     readonly type = "link";
 }
-/** A CMS Collection field that stores a date in UTC format. Optionally displays time. */
+/**
+ * A CMS Collection field that stores a date in UTC format. Optionally displays time.
+ * @category cms
+ */
 declare class DateField extends FieldBaseWithRequired {
     #private;
     readonly type = "date";
@@ -2236,18 +2396,25 @@ declare class DateField extends FieldBaseWithRequired {
     get displayTime(): boolean | undefined;
     constructor(engine: PluginEngine, collectionId: string, data: DateFieldDefinitionData);
 }
-/** A visual divider between fields in the CMS UI. Not a data field. */
+/**
+ * A visual divider between fields in the CMS UI. Not a data field.
+ * @category cms
+ */
 declare class FieldDivider extends FieldBase {
     readonly type = "divider";
 }
 /**
  * A field type that is not yet supported by the plugin API.
  * Returned when Framer uses a field type that the plugin API does not recognize.
+ * @category cms
  */
 declare class UnsupportedField extends FieldBase {
     readonly type = "unsupported";
 }
-/** A CMS Collection field that stores a file asset (`FileAsset`). */
+/**
+ * A CMS Collection field that stores a file asset (`FileAsset`).
+ * @category cms
+ */
 declare class FileField extends FieldBaseWithRequired implements WithAllowedFileTypes {
     #private;
     readonly type = "file";
@@ -2259,6 +2426,7 @@ declare class FileField extends FieldBaseWithRequired implements WithAllowedFile
  * A CMS Collection field with a fixed set of enum cases (options) that the user
  * can choose from. Enum cases must be defined as options before they can be
  * assigned to CMS items.
+ * @category cms
  */
 declare class EnumField extends FieldBase {
     #private;
@@ -2302,7 +2470,10 @@ declare class EnumField extends FieldBase {
      */
     setCaseOrder(caseIds: string[]): Promise<void>;
 }
-/** A field that references an item in another collection. */
+/**
+ * A field that references an item in another collection.
+ * @category cms
+ */
 declare class CollectionReferenceField extends FieldBaseWithRequired implements WithFieldCollectionId {
     #private;
     readonly type = "collectionReference";
@@ -2310,7 +2481,10 @@ declare class CollectionReferenceField extends FieldBaseWithRequired implements
     get collectionId(): string;
     constructor(engine: PluginEngine, collectionId: string, data: CollectionReferenceFieldDefinitionData);
 }
-/** A field that references multiple items in another collection. */
+/**
+ * A field that references multiple items in another collection.
+ * @category cms
+ */
 declare class MultiCollectionReferenceField extends FieldBaseWithRequired implements WithFieldCollectionId {
     #private;
     readonly type = "multiCollectionReference";
@@ -2322,6 +2496,7 @@ type ArrayItemField = ImageField;
 /**
  * A CMS Collection field that stores an array of nested fields. Currently only
  * supports a single image field, which creates a Gallery in the CMS.
+ * @category cms
  */
 declare class ArrayField extends FieldBaseWithRequired {
     readonly type = "array";
@@ -2893,16 +3068,19 @@ type ManagedCollectionField = SupportedFieldDefinitionData & WithUserEditable;
 /** @deprecated Use `ManagedCollectionFieldInput` instead. */
 type EditableManagedCollectionField = ManagedCollectionFieldInputData;
 /**
- * A CMS Collection that is fully controlled by a plugin. Managed Collections
- * allow plugins to define fields and sync items programmatically. Fields and
- * items can only be added, edited, and deleted by the owning plugin, not by
- * the user (unless a field is marked `userEditable`).
+ * A CMS Collection that is fully controlled by a plugin.
+ *
+ * Managed Collections allow plugins to define fields and sync items
+ * programmatically. Fields and items can only be added, edited, and deleted
+ * by the owning plugin, not by the user (unless a field is marked
+ * `userEditable`).
  *
  * A Managed Collection plugin becomes available within the CMS when it supports
  * both `configureManagedCollection` and `syncManagedCollection` modes.
  *
  * Use `framer.getManagedCollection()` to obtain an instance when the plugin is
  * launched in either of those modes.
+ * @category cms
  */
 declare class ManagedCollection implements Navigable {
     #private;
@@ -2960,8 +3138,10 @@ declare class ManagedCollection implements Navigable {
      */
     getFields(): Promise<ManagedCollectionField[]>;
     /**
-     * Add, update, or remove Collection fields. Fields not included in the
-     * array will be removed. You can configure up to 30 custom fields.
+     * Add, update, or remove Collection fields.
+     *
+     * Fields not included in the array will be removed. You can configure
+     * up to 30 custom fields.
      *
      * Each field requires an `id`, `name`, and `type`. For the `id`, use a
      * unique identifier that stays the same across future synchronizations.
@@ -2988,9 +3168,10 @@ declare class ManagedCollection implements Navigable {
      */
     setFields(fields: ManagedCollectionFieldInput[]): Promise<void>;
     /**
-     * Add new items or update existing ones if their IDs match. This method
-     * performs an upsert: items with matching IDs are updated, new IDs are
-     * inserted.
+     * Add new items or update existing ones if their IDs match.
+     *
+     * This method performs an upsert: items with matching IDs are updated,
+     * new IDs are inserted.
      *
      * Each item requires an `id` and `slug`. Custom field data is provided via
      * the `fieldData` object, using field IDs as keys.
@@ -3045,9 +3226,11 @@ declare class ManagedCollection implements Navigable {
      */
     setAsActive(): Promise<void>;
     /**
-     * Set plugin data by key. Similar to local storage, you can store custom
-     * data on the Managed Collection (e.g., the last synchronization date or a
-     * connected database ID).
+     * Set plugin data by key.
+     *
+     * Similar to local storage, you can store custom data on the Managed
+     * Collection (e.g., the last synchronization date or a connected database
+     * ID).
      *
      * Use `"ManagedCollection.setPluginData"` to check if this method is allowed.
      *
@@ -3077,17 +3260,19 @@ declare class ManagedCollection implements Navigable {
      */
     getPluginDataKeys(): Promise<string[]>;
     /**
-     * Navigate to this collection. May switch modes to reveal the relevant view.
+     * Navigate to this collection.
+     *
+     * May switch modes to reveal the relevant view.
      */
     navigateTo(opts?: NavigableOptions): Promise<void>;
 }
 /**
- * A CMS Collection in the project. Collections can be created by users or
- * managed by plugins. Use `managedBy` to check the owner.
+ * A CMS Collection in the project.
  *
- * Any kind of Collection can be read from. Unmanaged Collections are those
- * created and updated by people. Use the `collection` mode to access CMS
- * data from your plugin.
+ * Collections can be created by users or managed by plugins. Use `managedBy`
+ * to check the owner. Any kind of Collection can be read from, while those
+ * managed by other plugins are read-only.
+ * @category cms
  */
 declare class Collection implements Navigable {
     #private;
@@ -3147,6 +3332,7 @@ declare class Collection implements Navigable {
     constructor(data: CollectionData, engine: PluginEngine);
     /**
      * Reorder the items in this Collection based on an array of item IDs.
+     *
      * Unknown item IDs are ignored.
      *
      * Use `"Collection.setItemOrder"` to check if this method is allowed.
@@ -3174,8 +3360,9 @@ declare class Collection implements Navigable {
      */
     getFields(): Promise<Field[]>;
     /**
-     * Create new unmanaged Collection fields. Use `Field.setAttributes` to
-     * update existing fields.
+     * Create new unmanaged Collection fields.
+     *
+     * Use `Field.setAttributes` to update existing fields.
      *
      * Use `"Collection.addFields"` to check if this method is allowed.
      *
@@ -3208,6 +3395,7 @@ declare class Collection implements Navigable {
     removeFields(fieldIds: string[]): Promise<void>;
     /**
      * Reorder the fields in this Collection based on an array of field IDs.
+     *
      * Unknown field IDs are ignored.
      *
      * Use `"Collection.setFieldOrder"` to check if this method is allowed.
@@ -3222,6 +3410,7 @@ declare class Collection implements Navigable {
     setFieldOrder(fieldIds: string[]): Promise<void>;
     /**
      * Retrieve all items within this Collection, in their current order.
+     *
      * Items may include drafts (unpublished items).
      *
      * @returns An array of CollectionItem instances.
@@ -3304,13 +3493,18 @@ declare class Collection implements Navigable {
      */
     getPluginDataKeys(): Promise<string[]>;
     /**
-     * Navigate to this collection. May switch modes to reveal the relevant view.
+     * Navigate to this collection.
+     *
+     * May switch modes to reveal the relevant view.
      */
     navigateTo(opts?: NavigableOptions): Promise<void>;
 }
 /**
- * An item (row) in a CMS Collection. Each item contains field data keyed by
- * field ID, a unique slug, and a draft status.
+ * An item (row) in a CMS Collection.
+ *
+ * Each item contains field data keyed by field ID, a unique slug, and a
+ * draft status.
+ * @category cms
  */
 declare class CollectionItem implements Navigable {
     #private;
@@ -3324,8 +3518,9 @@ declare class CollectionItem implements Navigable {
     /** Drafts are excluded from publishing. */
     readonly draft: boolean;
     /**
-     * The fields and corresponding values of this Collection item. Field data
-     * uses the field `id` as keys in an object.
+     * The fields and corresponding values of this Collection item.
+     *
+     * Field data uses the field `id` as keys in an object.
      *
      * @example
      * ```ts
@@ -3446,9 +3641,10 @@ interface NodeClassToEditableAttributes {
     UnknownNode: object;
 }
 /**
- * Base class providing common methods shared by all node types. Nodes are
- * the building blocks that make up the content in a project. They are
- * represented as "layers" in the editor UI.
+ * Base class providing common methods shared by all node types.
+ *
+ * Nodes are the building blocks that make up the content in a project.
+ * They are represented as "layers" in the editor UI.
  *
  * Every node has a unique {@link NodeMethods.id | id}. Nodes support
  * plugin data storage, tree traversal (parent/children), cloning,
@@ -3500,8 +3696,10 @@ declare abstract class NodeMethods implements WithIdTrait, Navigable {
      */
     clone(): Promise<typeof this | null>;
     /**
-     * Set the attributes of this node. Attributes are merged with existing
-     * values, so only the provided attributes are updated.
+     * Set the attributes of this node.
+     *
+     * Attributes are merged with existing values, so only the provided
+     * attributes are updated.
      *
      * @param update - The attributes to update.
      * @returns The updated node, or `null` if the node was not found.
@@ -3523,7 +3721,9 @@ declare abstract class NodeMethods implements WithIdTrait, Navigable {
      */
     zoomIntoView(options?: ZoomIntoViewOptions): Promise<void>;
     /**
-     * Navigate to this node. May switch modes to reveal the relevant view.
+     * Navigate to this node.
+     *
+     * May switch modes to reveal the relevant view.
      */
     navigateTo(opts?: Pick<NavigableOptions, "select" | "zoomIntoView">): Promise<void>;
     /**
@@ -3539,8 +3739,9 @@ declare abstract class NodeMethods implements WithIdTrait, Navigable {
      */
     getChildren(): Promise<CanvasNode[]>;
     /**
-     * Get descendants of this node that match the given type. This can
-     * also be used to query within a selection subtree.
+     * Get descendants of this node that match the given type.
+     *
+     * This can also be used to query within a selection subtree.
      *
      * @param type - The node type to search for.
      * @returns An array of matching descendant nodes.
@@ -3565,8 +3766,9 @@ declare abstract class NodeMethods implements WithIdTrait, Navigable {
     getNodesWithType(type: "WebPageNode"): Promise<WebPageNode[]>;
     getNodesWithType(type: "ComponentNode"): Promise<ComponentNode[]>;
     /**
-     * Get the descendants of this node that support `attribute`. This
-     * returns nodes that have the given attribute defined in their type,
+     * Get the descendants of this node that support `attribute`.
+     *
+     * This returns nodes that have the given attribute defined in their type,
      * regardless of whether it has been set.
      *
      * @param attribute - The attribute name to filter by.
@@ -3594,21 +3796,26 @@ declare abstract class NodeMethods implements WithIdTrait, Navigable {
      */
     getNodesWithAttributeSet<T extends NodeAttributeKey, Node = NodeWithAttribute<T>>(attribute: T): Promise<Node[]>;
     /**
-     * Walk this node and its descendants recursively using an async
-     * generator. Yields nodes depth-first.
+     * Walk this node and its descendants recursively.
+     *
+     * Uses an async generator. Yields nodes depth-first.
      */
     walk(this: AnyNode): AsyncGenerator<AnyNode>;
     /**
-     * Get plugin data by key. Plugin data lets you store arbitrary
-     * string values on individual nodes, scoped to your plugin.
+     * Get plugin data by key.
+     *
+     * Plugin data lets you store arbitrary string values on individual
+     * nodes, scoped to your plugin.
      *
      * @param key - The plugin data key.
      * @returns The stored value, or `null` if no data exists for the key.
      */
     getPluginData(key: string): Promise<string | null>;
     /**
-     * Set plugin data by key. Plugin data lets you store arbitrary
-     * string values on individual nodes, scoped to your plugin.
+     * Set plugin data by key.
+     *
+     * Plugin data lets you store arbitrary string values on individual
+     * nodes, scoped to your plugin.
      *
      * @param key - The plugin data key.
      * @param value - The value to set, or `null` to remove.
@@ -3631,9 +3838,11 @@ interface FrameNodeData extends CommonNodeData, Partial<DrawableNode>, WithPosit
     [classKey]: "FrameNode";
 }
 /**
- * A frame layer on the canvas, the most common container node. Frames
- * can contain children, have layout settings, backgrounds, borders, and
- * can serve as breakpoint or component variants.
+ * A frame layer on the canvas, the most common container node.
+ *
+ * Frames can contain children, have layout settings, backgrounds, borders,
+ * and can serve as breakpoint or component variants.
+ * @category canvas
  */
 declare class FrameNode extends NodeMethods implements EditableFrameNodeAttributes, WithBreakpointTrait {
     readonly [classKey]: FrameNodeData[ClassKey];
@@ -3707,7 +3916,9 @@ interface TextNodeData extends CommonNodeData, Partial<DrawableNode>, WithPositi
     [classKey]: "TextNode";
 }
 /**
- * A text layer on the canvas. Use {@link TextNode.setText | setText} and
+ * A text layer on the canvas.
+ *
+ * Use {@link TextNode.setText | setText} and
  * {@link TextNode.getText | getText} to work with plain text, or
  * {@link TextNode.setHTML | setHTML} and {@link TextNode.getHTML | getHTML}
  * for rich text content.
@@ -3721,6 +3932,7 @@ interface TextNodeData extends CommonNodeData, Partial<DrawableNode>, WithPositi
  *   }
  * }
  * ```
+ * @category canvas
  */
 declare class TextNode extends NodeMethods implements EditableTextNodeAttributes {
     #private;
@@ -3764,13 +3976,17 @@ declare class TextNode extends NodeMethods implements EditableTextNodeAttributes
     readonly textTruncation: WithTextTruncationTrait["textTruncation"];
     constructor(rawData: TextNodeData, engine: PluginEngine);
     /**
-     * Set the text of this node. Plain text content, not HTML.
+     * Set the text of this node.
+     *
+     * Plain text content, not HTML.
      *
      * Use `"TextNode.setText"` to check if this method is allowed.
      */
     setText(text: string): Promise<void>;
     /**
-     * Get the text of this node. Plain text content, not HTML.
+     * Get the text of this node.
+     *
+     * Plain text content, not HTML.
      */
     getText(): Promise<string | null>;
     /**
@@ -3792,8 +4008,11 @@ interface SVGNodeData extends CommonNodeData, Partial<DrawableNode>, WithPositio
     [classKey]: "SVGNode";
 }
 /**
- * An SVG graphic layer on the canvas. Contains the raw SVG string and
- * supports positioning, sizing, rotation, and visibility.
+ * An SVG graphic layer on the canvas.
+ *
+ * Contains the raw SVG string and supports positioning, sizing,
+ * rotation, and visibility.
+ * @category canvas
  */
 declare class SVGNode extends NodeMethods implements EditableSVGNodeAttributes {
     readonly [classKey]: SVGNodeData[ClassKey];
@@ -3819,7 +4038,10 @@ interface EditableVectorSetItemNodeAttributes extends WithNameTrait, WithVisible
 interface VectorSetItemNodeData extends CommonNodeData, Partial<WithNameTrait>, Partial<WithVisibleTrait>, Partial<WithLockedTrait>, Partial<WithPinsTrait>, Partial<WithSizeTrait> {
     [classKey]: "VectorSetItemNode";
 }
-/** An individual item within a VectorSet node. */
+/**
+ * An individual item within a VectorSet node.
+ * @category canvas
+ */
 declare class VectorSetItemNode extends NodeMethods implements EditableVectorSetItemNodeAttributes {
     #private;
     readonly [classKey]: VectorSetItemNodeData[ClassKey];
@@ -3843,8 +4065,10 @@ interface ComponentInstanceNodeData extends CommonNodeData, Partial<DrawableNode
     [classKey]: "ComponentInstanceNode";
 }
 /**
- * An instance of a code or design component on the canvas. Component
- * instances are identified by their {@link ComponentInstanceNode.componentIdentifier | componentIdentifier}
+ * An instance of a code or design component on the canvas.
+ *
+ * Component instances are identified by their
+ * {@link ComponentInstanceNode.componentIdentifier | componentIdentifier}
  * and can have their control properties updated via
  * {@link NodeMethods.setAttributes | setAttributes}.
  *
@@ -3856,6 +4080,7 @@ interface ComponentInstanceNodeData extends CommonNodeData, Partial<DrawableNode
  *   })
  * }
  * ```
+ * @category canvas
  */
 declare class ComponentInstanceNode extends NodeMethods implements EditableComponentInstanceNodeAttributes, WithComponentInfoTrait {
     #private;
@@ -3901,9 +4126,11 @@ interface WebPageNodeData extends CommonNodeData, Partial<WithWebPageInfoTrait>
     [classKey]: "WebPageNode";
 }
 /**
- * A web page in the project's site map. Web pages have a
- * {@link WebPageNode.path | path} and may be associated with a CMS
- * collection when used as a detail page.
+ * A web page in the project's site map.
+ *
+ * Web pages have a {@link WebPageNode.path | path} and may be associated
+ * with a CMS collection when used as a detail page.
+ * @category canvas
  */
 declare class WebPageNode extends NodeMethods implements EditableWebPageNodeAttributes, WithWebPageInfoTrait {
     #private;
@@ -3938,6 +4165,7 @@ declare class WebPageNode extends NodeMethods implements EditableWebPageNodeAttr
     addBreakpoint(basedOn: NodeId, breakpoint: Breakpoint): Promise<FrameNode>;
     /**
      * Get the active collection item for this CMS detail page.
+     *
      * Returns null if this is not a detail page or the collection is empty.
      *
      * @alpha
@@ -3949,9 +4177,11 @@ interface ComponentNodeData extends CommonNodeData, Partial<WithNameTrait>, With
     [classKey]: "ComponentNode";
 }
 /**
- * A reusable design component definition. Component nodes contain
- * variants, gesture states, and variables. They can be inserted as
- * instances via their module URL.
+ * A reusable design component definition.
+ *
+ * Component nodes contain variants, gesture states, and variables.
+ * They can be inserted as instances via their module URL.
+ * @category canvas
  */
 declare class ComponentNode extends NodeMethods implements EditableComponentNodeAttributes, WithComponentInfoTrait {
     #private;
@@ -4019,7 +4249,10 @@ type EditableVectorSetNodeAttributes = WithNameTrait;
 interface VectorSetNodeData extends CommonNodeData, Partial<WithNameTrait> {
     [classKey]: "VectorSetNode";
 }
-/** A container node for a set of vector icons. */
+/**
+ * A container node for a set of vector icons.
+ * @category canvas
+ */
 declare class VectorSetNode extends NodeMethods implements EditableVectorSetNodeAttributes {
     readonly [classKey]: VectorSetNodeData[ClassKey];
     readonly name: string | null;
@@ -4032,7 +4265,10 @@ interface DesignPageCloneOptions {
 interface DesignPageNodeData extends CommonNodeData, Partial<WithNameTrait> {
     [classKey]: "DesignPageNode";
 }
-/** A design page (non-web canvas) in the project. */
+/**
+ * A design page (non-web canvas) in the project.
+ * @category canvas
+ */
 declare class DesignPageNode extends NodeMethods implements EditableDesignPageNodeAttributes {
     #private;
     readonly [classKey]: DesignPageNodeData[ClassKey];
@@ -4154,6 +4390,7 @@ interface CodeFileVersionData extends Pick<CodeFileData, "id" | "name"> {
 }
 /**
  * A saved version (snapshot) of a code file.
+ * @category code-files
  */
 declare class CodeFileVersion {
     #private;
@@ -4181,6 +4418,7 @@ declare class CodeFileVersion {
 /**
  * Represents a code file in the Framer project, such as a code component
  * or code override.
+ * @category code-files
  */
 declare class CodeFile implements Navigable {
     #private;
@@ -4819,6 +5057,7 @@ type RedirectInput = Prettify<CreateRedirect | UpdateRedirect>;
 /**
  * A URL redirect configured in the project. Redirects are applied when
  * the site is published.
+ * @category settings
  */
 declare class Redirect {
     #private;
@@ -5140,9 +5379,11 @@ declare class FramerPluginAPI {
     #private;
     constructor(engine: PluginEngine);
     /**
-     * Get the current mode. A plugin can launch in a special mode where only a
-     * subset of the API is allowed. The mode is set when the plugin launches
-     * and never changes while the plugin is active.
+     * Get the current mode.
+     *
+     * A plugin can launch in a special mode where only a subset of the API is
+     * allowed. The mode is set when the plugin launches and never changes while
+     * the plugin is active.
      *
      * @example
      * ```ts
@@ -5151,6 +5392,7 @@ declare class FramerPluginAPI {
      *   return
      * }
      * ```
+     * @category settings
      */
     get mode(): Mode;
     /**
@@ -5173,6 +5415,7 @@ declare class FramerPluginAPI {
      *
      * @param methods - The methods to check, at least one.
      * @returns `true` if all of `methods` can be executed, `false` otherwise.
+     * @category permissions
      */
     isAllowedTo(...methods: [ProtectedMethod, ...ProtectedMethod[]]): boolean;
     /**
@@ -5205,6 +5448,7 @@ declare class FramerPluginAPI {
      *   width: 220
      * })
      * ```
+     * @category plugin-ui
      */
     showUI(options?: UIOptions): Promise<void>;
     /**
@@ -5217,14 +5461,14 @@ declare class FramerPluginAPI {
      * ```ts
      * framer.hideUI()
      * ```
+     * @category plugin-ui
      */
     hideUI(): Promise<void>;
     /**
      * Update the background status text shown while the plugin UI is hidden.
-     * This allows plugins running in the background to communicate their current
-     * status to users.
      *
-     * Set to `null` to clear the message.
+     * This allows plugins running in the background to communicate their current
+     * status to users. Set to `null` to clear the message.
      *
      * @param status - The message to display, or `null` to clear.
      *
@@ -5236,10 +5480,13 @@ declare class FramerPluginAPI {
      * // Clear the status message
      * await framer.setBackgroundMessage(null)
      * ```
+     * @category plugin-ui
      */
     setBackgroundMessage(status: string | null): Promise<void>;
     /**
-     * Close and terminate the plugin. Throws `FramerPluginClosedError`, which should be ignored.
+     * Close and terminate the plugin.
+     *
+     * Throws `FramerPluginClosedError`, which should be ignored.
      *
      * @param message - Optional message to show in the notification (ignored if options.silent is true)
      * @param options - Options to control the close behaviour
@@ -5250,6 +5497,7 @@ declare class FramerPluginAPI {
      *     variant: "success",
      * })
      * ```
+     * @category plugin-ui
      */
     closePlugin(message?: string, options?: ClosePluginOptions): never;
     /**
@@ -5259,32 +5507,45 @@ declare class FramerPluginAPI {
      * ```ts
      * const user = await framer.getCurrentUser();
      * ```
+     * @category user
      */
     getCurrentUser(): Promise<User>;
-    /** Get the project info like name and id. */
+    /** Get the project info like name and id.
+     * @category settings
+     */
     getProjectInfo(): Promise<ProjectInfo>;
-    /** Get the current selection. */
+    /** Get the current selection.
+     * @category canvas
+     */
     getSelection(): Promise<CanvasNode[]>;
-    /** Set the current selection. */
+    /** Set the current selection.
+     * @category canvas
+     */
     setSelection(nodeIds: string | Iterable<string>): Promise<void>;
     /** Subscribe to selection changes. */
     subscribeToSelection(selectionUpdate: (nodes: CanvasNode[]) => void): Unsubscribe$1;
-    /** Get the root of the current canvas. */
+    /** Get the root of the current canvas.
+     * @category canvas
+     */
     getCanvasRoot(): Promise<CanvasRootNode>;
     /** Subscribe to canvas root changes */
     subscribeToCanvasRoot(rootUpdate: (root: CanvasRootNode) => void): Unsubscribe$1;
     /**
-     * Get information about the published website, such as the time of the most
-     * recent deploy, or the URL of the current page. Provides information about
-     * both `staging` and `production` environments (either may be `null` if the
-     * site has never been published).
+     * Get information about the published website.
+     *
+     * Provides details such as the time of the most recent deploy or the URL of
+     * the current page. Covers both `staging` and `production` environments
+     * (either may be `null` if the site has never been published).
      *
      * @returns The current publish info for both staging and production.
+     * @category settings
      */
     getPublishInfo(): Promise<PublishInfo>;
     /**
-     * Subscribe to publish info changes. The callback is called whenever
-     * publish info is updated (e.g., after a new deployment).
+     * Subscribe to publish info changes.
+     *
+     * The callback is called whenever publish info is updated (e.g., after a
+     * new deployment).
      *
      * @param publishInfoUpdate - Called when publish info changes.
      * @returns A function to unsubscribe from updates.
@@ -5301,21 +5562,35 @@ declare class FramerPluginAPI {
      * ```
      */
     subscribeToPublishInfo(publishInfoUpdate: (info: PublishInfo) => void): Unsubscribe$1;
-    /** Create a new node on the canvas. */
+    /** Create a new node on the canvas.
+     * @category canvas
+     */
     createFrameNode(attributes: Partial<EditableFrameNodeAttributes>, parentId?: string): Promise<FrameNode | null>;
-    /** Remove nodes from the canvas. */
+    /** Remove nodes from the canvas.
+     * @category canvas
+     */
     removeNodes(nodeIds: NodeId[]): Promise<void>;
     /** @deprecated Use `removeNodes` directly. */
     removeNode(nodeId: NodeId): Promise<void>;
-    /** Clone a node. */
+    /** Clone a node.
+     * @category canvas
+     */
     cloneNode(nodeId: NodeId): Promise<AnyNode | null>;
-    /** Get a node by its id. */
+    /** Get a node by its id.
+     * @category canvas
+     */
     getNode(nodeId: NodeId): Promise<AnyNode | null>;
-    /** Get the parent of a node. */
+    /** Get the parent of a node.
+     * @category canvas
+     */
     getParent(nodeId: NodeId): Promise<AnyNode | null>;
-    /** Get the children of a node. */
+    /** Get the children of a node.
+     * @category canvas
+     */
     getChildren(nodeId: NodeId): Promise<CanvasNode[]>;
-    /** Get the rect of a node */
+    /** Get the rect of a node
+     * @category canvas
+     */
     getRect(nodeId: NodeId): Promise<Rect$1 | null>;
     /**
      * Pans and zooms the viewport to center a single or group of nodes.
@@ -5331,13 +5606,21 @@ declare class FramerPluginAPI {
      * // Scroll and zoom to fit multiple nodes into the viewport.
      * await framer.zoomIntoView(["node-id-1", "node-id-2"])
      * ```
+     * @category navigation
      */
     zoomIntoView(nodeIds: NodeId | Iterable<NodeId>, options?: ZoomIntoViewOptions): Promise<void>;
-    /** Set the attributes of a node. */
+    /** Set the attributes of a node.
+     * @category canvas
+     */
     setAttributes(nodeId: NodeId, attributes: Partial<AnyEditableAttributes>): Promise<AnyNode | null>;
-    /** Set the parent of a node. */
+    /** Set the parent of a node.
+     * @category canvas
+     */
     setParent(nodeId: NodeId, parentId: NodeId, index?: number | undefined): Promise<void>;
-    /** Get all nodes of a certain class. */
+    /**
+     * Get all nodes of a certain class.
+     * @category canvas
+     */
     getNodesWithType(type: "FrameNode"): Promise<FrameNode[]>;
     getNodesWithType(type: "TextNode"): Promise<TextNode[]>;
     getNodesWithType(type: "SVGNode"): Promise<SVGNode[]>;
@@ -5345,39 +5628,59 @@ declare class FramerPluginAPI {
     getNodesWithType(type: "WebPageNode"): Promise<WebPageNode[]>;
     getNodesWithType(type: "DesignPageNode"): Promise<DesignPageNode[]>;
     getNodesWithType(type: "ComponentNode"): Promise<ComponentNode[]>;
-    /** Get all nodes with a certain attribute. */
+    /** Get all nodes with a certain attribute.
+     * @category canvas
+     */
     getNodesWithAttribute<T extends NodeAttributeKey, Node = NodeWithAttribute<T>>(attribute: T): Promise<Node[]>;
-    /** Get all nodes with a certain attribute which value is set. */
+    /** Get all nodes with a certain attribute which value is set.
+     * @category canvas
+     */
     getNodesWithAttributeSet<T extends NodeAttributeKey, Node = NodeWithAttribute<T>>(attribute: T): Promise<Node[]>;
     /**
      * Get the image of the current selection or `null` if there is no image.
      *
      * In `editImage` mode, this returns the image the user already has set,
      * which your plugin can then modify.
+     * @category canvas
      */
     getImage(): Promise<ImageAsset | null>;
     /** Subscribe to single image selection changes. */
     subscribeToImage(imageUpdate: (image: ImageAsset | null) => void): Unsubscribe$1;
-    /** Upload an image, and insert on the canvas. */
+    /** Upload an image, and insert on the canvas.
+     * @category canvas
+     */
     addImage(image: NamedImageAssetInput | File): Promise<void>;
     /**
      * Upload an image and set it on the selected node.
      *
      * In `image` or `editImage` mode, this is the primary method to send the
      * selected or edited image back to Framer.
+     * @category canvas
      */
     setImage(image: NamedImageAssetInput | File): Promise<void>;
-    /** Upload an image without assigning it to a property. */
+    /** Upload an image without assigning it to a property.
+     * @category canvas
+     */
     uploadImage(image: NamedImageAssetInput | File): Promise<ImageAsset>;
-    /** Add multiple images, replacing the selected images, or insert on the canvas. */
+    /** Add multiple images, replacing the selected images, or insert on the canvas.
+     * @category canvas
+     */
     addImages(images: readonly NamedImageAssetInput[]): Promise<void>;
-    /** Upload multiple images without assigning them to properties. */
+    /** Upload multiple images without assigning them to properties.
+     * @category canvas
+     */
     uploadImages(images: readonly NamedImageAssetInput[]): Promise<ImageAsset[]>;
-    /** Uploads a file without assigning it to a property. */
+    /** Uploads a file without assigning it to a property.
+     * @category canvas
+     */
     uploadFile(file: NamedFileAssetInput | File): Promise<FileAsset>;
-    /** Upload multiple files without assigning them to properties. */
+    /** Upload multiple files without assigning them to properties.
+     * @category canvas
+     */
     uploadFiles(files: readonly NamedFileAssetInput[]): Promise<FileAsset[]>;
-    /** Add an SVG, replacing the selected SVG, or insert on the canvas. */
+    /** Add an SVG, replacing the selected SVG, or insert on the canvas.
+     * @category canvas
+     */
     addSVG(svg: SVGData): Promise<void>;
     /**
      * Add a component instance by module URL.
@@ -5386,22 +5689,34 @@ declare class FramerPluginAPI {
      * @param attributes - Optional component attributes.
      *
      * @returns The newly created component instance node.
+     * @category canvas
      */
     addComponentInstance({ url, attributes, parentId, }: AddComponentInstanceOptions): Promise<ComponentInstanceNode>;
-    /** Adds the layers of a component by module URL. */
+    /** Adds the layers of a component by module URL.
+     * @category canvas
+     */
     addDetachedComponentLayers({ url, layout, attributes }: AddDetachedComponentLayersOptions): Promise<FrameNode>;
-    /** Preload the component layers for detached insertion. */
+    /** Preload the component layers for detached insertion.
+     * @category canvas
+     */
     preloadDetachedComponentLayers(url: string): Promise<void>;
     preloadImageUrlForInsertion(url: string): Promise<void>;
     preloadDragPreviewImage(url: string): Promise<void>;
-    /** Get plaintext of the current selection or null if there is no text. */
+    /** Get plaintext of the current selection or null if there is no text.
+     * @category canvas
+     */
     getText(): Promise<string | null>;
-    /** Set the text of the current selection or insert it onto the canvas. */
+    /** Set the text of the current selection or insert it onto the canvas.
+     * @category canvas
+     */
     setText(text: string): Promise<void>;
-    /** Add a new text node to the canvas. */
+    /** Add a new text node to the canvas.
+     * @category canvas
+     */
     addText(text: string, options?: AddTextOptions): Promise<void>;
     /**
      * Install a custom code snippet in the user's website via `<script>` tags.
+     *
      * A plugin can only set custom HTML once per location. Custom code should be
      * valid HTML. Setting `html` to `null` clears the installed code snippet.
      *
@@ -5414,11 +5729,14 @@ declare class FramerPluginAPI {
      *   location: "bodyEnd"
      * })
      * ```
+     * @category code-files
      */
     setCustomCode(options: SetCustomCodeOptions): Promise<void>;
     /**
-     * Get custom code settings set by the plugin. Your plugin can detect if
-     * custom code was set and whether the user has disabled it.
+     * Get custom code settings set by the plugin.
+     *
+     * Your plugin can detect if custom code was set and whether the user has
+     * disabled it.
      *
      * @example
      * ```ts
@@ -5427,11 +5745,14 @@ declare class FramerPluginAPI {
      *   // Custom code was disabled by the user in settings
      * }
      * ```
+     * @category code-files
      */
     getCustomCode(): Promise<CustomCode>;
     /**
-     * Subscribe to custom code changes. Called when custom code is registered
-     * or when changes to the settings are made.
+     * Subscribe to custom code changes.
+     *
+     * Called when custom code is registered or when changes to the settings
+     * are made.
      *
      * @param callback - Called when custom code settings change.
      * @returns A function to unsubscribe from updates.
@@ -5449,9 +5770,12 @@ declare class FramerPluginAPI {
     /** Subscribe to the current text selection. */
     subscribeToText(callback: (text: string | null) => void): Unsubscribe$1;
     /**
-     * Allow any HTML element to become draggable. Different types of drag data can be dropped onto
-     * Framer. A function is returned to remove the draggable behavior from the element and to stop
+     * Allow any HTML element to become draggable.
+     *
+     * Different types of drag data can be dropped onto Framer. A function is
+     * returned to remove the draggable behavior from the element and to stop
      * all of the added listeners.
+     * @category canvas
      */
     makeDraggable(element: HTMLElement, getDragData: () => DragData, onDragComplete?: DragCompleteCallback): Cleanup;
     /**
@@ -5463,9 +5787,12 @@ declare class FramerPluginAPI {
      * ```ts
      * const collection = await framer.getActiveManagedCollection();
      * ```
+     * @category cms
      */
     getActiveManagedCollection(): Promise<ManagedCollection>;
-    /** @deprecated Use `getActiveManagedCollection` */
+    /** @deprecated Use `getActiveManagedCollection`
+     * @category cms
+     */
     getManagedCollection(): Promise<ManagedCollection>;
     /**
      * Retrieve Collections that are managed by the current Plugin.
@@ -5477,9 +5804,12 @@ declare class FramerPluginAPI {
      * ```ts
      * const managedCollections = await framer.getManagedCollections();
      * ```
+     * @category cms
      */
     getManagedCollections(): Promise<ManagedCollection[]>;
-    /** Get a collection by its id. */
+    /** Get a collection by its id.
+     * @category cms
+     */
     getCollection(id: NodeId): Promise<Collection | null>;
     /**
      * Retrieve the Collection currently active (selected) in the Framer UI.
@@ -5493,6 +5823,7 @@ declare class FramerPluginAPI {
      * ```ts
      * const collection = await framer.getActiveCollection();
      * ```
+     * @category cms
      */
     getActiveCollection(): Promise<Collection | null>;
     /**
@@ -5502,10 +5833,13 @@ declare class FramerPluginAPI {
      * ```ts
      * const collections = await framer.getCollections()
      * ```
+     * @category cms
      */
     getCollections(): Promise<Collection[]>;
     /**
-     * Display a notification message. The message will be truncated if longer than 120 characters.
+     * Display a notification message.
+     *
+     * The message will be truncated if longer than 120 characters.
      *
      * @param message - The message to display. Truncated if longer than 120 characters.
      * @param options - Options like `variant` (`"info"`, `"success"`, `"warning"`, `"error"`), `durationMs`, `button`, and `onDisappear`.
@@ -5523,34 +5857,55 @@ declare class FramerPluginAPI {
      * // Close the notification programmatically
      * notification.close()
      * ```
+     * @category plugin-ui
      */
     notify: Notify;
-    /** Get plugin data by key. */
+    /** Get plugin data by key.
+     * @category plugin-ui
+     */
     getPluginData(key: string): Promise<string | null>;
-    /** Set plugin data by key. */
+    /** Set plugin data by key.
+     * @category plugin-ui
+     */
     setPluginData(key: string, value: string | null): Promise<void>;
-    /** Get all plugin data keys. */
+    /** Get all plugin data keys.
+     * @category plugin-ui
+     */
     getPluginDataKeys(): Promise<string[]>;
-    /** Get all color styles in the project. */
+    /** Get all color styles in the project.
+     * @category canvas
+     */
     getColorStyles(): Promise<ColorStyle[]>;
-    /** Get a specific color style. */
+    /** Get a specific color style.
+     * @category canvas
+     */
     getColorStyle(id: NodeId): Promise<ColorStyle | null>;
-    /** Add a new color style to the project. */
+    /** Add a new color style to the project.
+     * @category canvas
+     */
     createColorStyle(attributes: ColorStyleAttributes): Promise<ColorStyle>;
     /** Fired when a color style is added, edited or removed. */
     subscribeToColorStyles(callback: (styles: ColorStyle[]) => void): Unsubscribe$1;
-    /** Get all text styles in the project. */
+    /** Get all text styles in the project.
+     * @category canvas
+     */
     getTextStyles(): Promise<TextStyle[]>;
-    /** Get a specific text style. */
+    /** Get a specific text style.
+     * @category canvas
+     */
     getTextStyle(id: NodeId): Promise<TextStyle | null>;
-    /** Add a new text style to the project. */
+    /** Add a new text style to the project.
+     * @category canvas
+     */
     createTextStyle(attributes: TextStyleAttributes): Promise<TextStyle>;
     /** Fired when a text style is added, edited or removed. */
     subscribeToTextStyles(callback: (styles: TextStyle[]) => void): Unsubscribe$1;
     /**
-     * Get a specific font from a family by name. This is not case sensitive.
-     * By default, returns a font with normal weight and style. Returns `null`
-     * if the font does not exist or lacks the requested weight/style combination.
+     * Get a specific font from a family by name.
+     *
+     * This is not case sensitive. By default, returns a font with normal weight
+     * and style. Returns `null` if the font does not exist or lacks the
+     * requested weight/style combination.
      *
      * Note: Custom fonts are not available to plugins.
      *
@@ -5569,12 +5924,15 @@ declare class FramerPluginAPI {
      *   style: "italic"
      * })
      * ```
+     * @category canvas
      */
     getFont(family: string, attributes?: FontAttributes): Promise<Font | null>;
     /**
-     * Get all available fonts. Unlike the Font Picker which groups fonts by
-     * typeface, this lists individual fonts for each weight and style (each
-     * representing a separate font file).
+     * Get all available fonts.
+     *
+     * Unlike the Font Picker which groups fonts by typeface, this lists
+     * individual fonts for each weight and style (each representing a separate
+     * font file).
      *
      * Note: Custom fonts are not available to plugins.
      *
@@ -5584,6 +5942,7 @@ declare class FramerPluginAPI {
      * ```ts
      * const fonts = await framer.getFonts()
      * ```
+     * @category canvas
      */
     getFonts(): Promise<Font[]>;
     /**
@@ -5595,6 +5954,7 @@ declare class FramerPluginAPI {
      * ```ts
      * const locales = await framer.getLocales()
      * ```
+     * @category localization
      */
     getLocales(): Promise<readonly Locale[]>;
     /**
@@ -5604,6 +5964,7 @@ declare class FramerPluginAPI {
      * ```ts
      * const defaultLocale = await framer.getDefaultLocale()
      * ```
+     * @category localization
      */
     getDefaultLocale(): Promise<Locale>;
     /**
@@ -5617,6 +5978,7 @@ declare class FramerPluginAPI {
      * ```ts
      * const activeLocale = await framer.getActiveLocale()
      * ```
+     * @category localization
      */
     getActiveLocale(): Promise<Locale | null>;
     /**
@@ -5635,6 +5997,7 @@ declare class FramerPluginAPI {
      * // Get specific groups by ID
      * const specific = await framer.getLocalizationGroups({ groupIds: ["id1", "id2"] })
      * ```
+     * @category localization
      */
     getLocalizationGroups(filter?: GetLocalizationGroupsFilter): Promise<readonly LocalizationGroup[]>;
     /**
@@ -5658,6 +6021,7 @@ declare class FramerPluginAPI {
      *     }
      * })
      * ```
+     * @category localization
      */
     setLocalizationData(update: LocalizationData): Promise<SetLocalizationDataResult>;
     /**
@@ -5669,6 +6033,7 @@ declare class FramerPluginAPI {
      * ```ts
      * const redirects = await framer.getRedirects()
      * ```
+     * @category settings
      */
     getRedirects(): Promise<readonly Redirect[]>;
     /** Subscribe to redirect changes. */
@@ -5694,10 +6059,13 @@ declare class FramerPluginAPI {
      *   { from: "/posts/*", to: "/blog/:1", expandToAllLocales: false },
      * ])
      * ```
+     * @category settings
      */
     addRedirects(redirects: RedirectInput[]): Promise<Redirect[]>;
     /**
-     * Remove Redirects from the project. Unknown Redirect IDs are ignored.
+     * Remove Redirects from the project.
+     *
+     * Unknown Redirect IDs are ignored.
      *
      * Throws a `FramerPluginError` when the user lacks Site Settings permissions
      * or when the project plan does not include Redirects.
@@ -5708,10 +6076,13 @@ declare class FramerPluginAPI {
      * ```ts
      * await framer.removeRedirects([aboutPageRedirect.id, blogPageRedirect.id])
      * ```
+     * @category settings
      */
     removeRedirects(redirectIds: string[]): Promise<void>;
     /**
-     * Set the order of Redirects in the list. Unknown Redirect IDs are ignored.
+     * Set the order of Redirects in the list.
+     *
+     * Unknown Redirect IDs are ignored.
      *
      * Throws a `FramerPluginError` when the user lacks Site Settings permissions
      * or when the project plan does not include Redirects.
@@ -5722,6 +6093,7 @@ declare class FramerPluginAPI {
      * ```ts
      * await framer.setRedirectOrder([aboutPageRedirect.id, blogPageRedirect.id])
      * ```
+     * @category settings
      */
     setRedirectOrder(redirectIds: string[]): Promise<void>;
     /**
@@ -5741,6 +6113,7 @@ declare class FramerPluginAPI {
      *   }`
      * )
      * ```
+     * @category code-files
      */
     createCodeFile(name: string, code: string, options?: {
         editViaPlugin?: boolean;
@@ -5755,6 +6128,7 @@ declare class FramerPluginAPI {
      * const allFiles = await framer.getCodeFiles()
      * console.log(`Project has ${allFiles.length} code files`)
      * ```
+     * @category code-files
      */
     getCodeFiles(): Promise<readonly CodeFile[]>;
     /**
@@ -5767,6 +6141,7 @@ declare class FramerPluginAPI {
      * ```ts
      * const codeFile = await framer.getCodeFile("code-file-id")
      * ```
+     * @category code-files
      */
     getCodeFile(id: string): Promise<CodeFile | null>;
     /**
@@ -5786,12 +6161,14 @@ declare class FramerPluginAPI {
      * @param content - The content of the code file.
      * @param compilerOptions - Optional compiler options to override the default compiler options for type checking.
      * @param sessionId - Optional session ID. Pass it when repeatedly type checking the same file. If not provided, a new session will be created for each type check, which is slow.
+     * @category code-files
      */
     typecheckCode(fileName: string, content: string, compilerOptions?: ts.server.protocol.CompilerOptions, sessionId?: string): Promise<TypecheckDiagnostic[]>;
     /**
-     * Subscribe to changes in code files across the project. The callback is
-     * called when code files are added, removed, or updated, and receives an
-     * array of all code files in the project.
+     * Subscribe to changes in code files across the project.
+     *
+     * The callback is called when code files are added, removed, or updated,
+     * and receives an array of all code files in the project.
      *
      * @param callback - Function called when code files change.
      * @returns A function to stop listening to changes.
@@ -5828,6 +6205,7 @@ declare class FramerPluginAPI {
      *     },
      * ])
      * ```
+     * @category plugin-ui
      */
     setMenu(menuItems: MenuItem[]): Promise<void>;
     /**
@@ -5860,6 +6238,7 @@ declare class FramerPluginAPI {
      *   }
      * )
      * ```
+     * @category plugin-ui
      */
     showContextMenu(menuItems: MenuItem[], config: ContextMenuConfig): Promise<void>;
     /**
@@ -5867,11 +6246,14 @@ declare class FramerPluginAPI {
      * specified version.
      *
      * WARNING: This API is unstable and may change or break in the future
+     * @category code-files
      */
     unstable_ensureMinimumDependencyVersion(packageName: string, version: string): Promise<void>;
     /**
-     * Navigate the Framer UI to a target by its ID. When the target isn't in the
-     * current mode, it might terminate or restart the plugin in the new mode.
+     * Navigate the Framer UI to a target by its ID.
+     *
+     * When the target isn't in the current mode, it might terminate or restart
+     * the plugin in the new mode.
      *
      * @param nodeId - The ID of the node to navigate to.
      * @param opts - The options for the navigation.
@@ -5881,11 +6263,13 @@ declare class FramerPluginAPI {
      * ```ts
      * await framer.navigateTo(nodeId, opts)
      * ```
+     * @category navigation
      */
     navigateTo(nodeId: string, opts?: NavigableOptions): Promise<void>;
     /**
-     * Subscribe to changes in the Code Editor's active file. This function is
-     * primarily useful when the plugin's mode is `"code"`.
+     * Subscribe to changes in the Code Editor's active file.
+     *
+     * This function is primarily useful when the plugin's mode is `"code"`.
      *
      * @param callback - Function called when the active code file changes.
      * @returns A function to stop listening to changes.
@@ -5915,6 +6299,7 @@ declare class FramerPluginAPI {
      * const designPage = await framer.createDesignPage("About")
      * await designPage.navigateTo()
      * ```
+     * @category canvas
      */
     createDesignPage(pageName: string): Promise<DesignPageNode>;
     /**
@@ -5929,12 +6314,14 @@ declare class FramerPluginAPI {
      * const webPage = await framer.createWebPage("/about")
      * await webPage.navigateTo()
      * ```
+     * @category canvas
      */
     createWebPage(pagePath: string): Promise<WebPageNode>;
     /**
      * Create a new collection.
      *
      * @param name - The name to give the new collection.
+     * @category cms
      */
     createCollection(name: string): Promise<Collection>;
     /**
@@ -5948,6 +6335,7 @@ declare class FramerPluginAPI {
      * ```ts
      * const newCollection = await framer.createManagedCollection(name)
      * ```
+     * @category cms
      */
     createManagedCollection(name: string): Promise<ManagedCollection>;
     /**
@@ -5965,6 +6353,7 @@ declare class FramerPluginAPI {
      * // Remove the close warning
      * await framer.setCloseWarning(false)
      * ```
+     * @category settings
      */
     setCloseWarning(message: string | false): Promise<void>;
     /**
@@ -6579,7 +6968,10 @@ declare const fileAssetDiscriminator: "FileAsset";
 interface FileAssetData extends AssetIdentifier, FileAssetDataFields {
     [classKey]: typeof fileAssetDiscriminator;
 }
-/** A file asset uploaded to the Framer project. */
+/**
+ * A file asset uploaded to the Framer project.
+ * @category canvas
+ */
 declare class FileAsset implements AssetIdentifier, FileAssetDataFields {
     readonly id: AssetId;
     readonly url: string;
@@ -6622,6 +7014,7 @@ interface Size {
 /**
  * An image that has been uploaded to the Framer project. Provides methods
  * to access image data, measure dimensions, and load as bitmap or HTML element.
+ * @category canvas
  */
 declare class ImageAsset implements ImageDataFields, AssetIdentifier {
     #private;