@webflow/designer-extension-typings 2.0.21 → 2.0.24

package/api.d.ts

@@ -80,6 +80,22 @@ interface WebflowApi {
    */
   setSelectedElement(element: AnyElement): Promise<null | AnyElement>;
 
+  /**
+   * Captures a screenshot of the specified element.
+   * @returns A promise that resolves to a base64 string representing the screenshot of the element.
+   * @example
+   * ```ts
+   * const selectedElement = await webflow.getSelectedElement();
+   * if (selectedElement) {
+   *   const screenshot = await webflow.getElementSnapshot(selectedElement);
+   *   console.log('Screenshot:', screenshot);
+   * }else{
+   *   console.log('No element selected');
+   * }
+   * ```
+   */
+  getElementSnapshot(element: AnyElement): Promise<null | string>;
+
   elementBuilder(elementPreset: ElementPreset<AnyElement>): BuilderElement;
   /**
    * Get the current media query breakpoint ID.

package/element-presets-generated.d.ts

@@ -1,9 +1,6 @@
 // This file was automatically generated. See designer-extensions docs.
 
 type ElementPresets = {
-  Animation: ElementPreset<AnyElement>;
-  Spline: ElementPreset<AnyElement>;
-  Rive: ElementPreset<AnyElement>;
   SearchForm: ElementPreset<AnyElement>;
   DOM: ElementPreset<DOMElement>;
   DivBlock: ElementPreset<BlockElement>;
@@ -19,6 +16,9 @@ type ElementPresets = {
   RichText: ElementPreset<RichTextElement>;
   CodeBlock: ElementPreset<CodeBlockElement>;
   Image: ElementPreset<AnyElement>;
+  Animation: ElementPreset<AnyElement>;
+  Spline: ElementPreset<AnyElement>;
+  Rive: ElementPreset<AnyElement>;
   BackgroundVideoWrapper: ElementPreset<BackgroundVideoWrapperElement>;
   CommercePaypalCheckoutFormContainer: ElementPreset<AnyElement>;
   CommerceCheckoutFormContainer: ElementPreset<AnyElement>;

package/elements-generated.d.ts

@@ -130,7 +130,7 @@ interface DOMElement
     Styles,
     Children,
     TextContent,
-    NoAppConnections {
+    AppConnections {
   readonly id: FullElementId;
   readonly type: 'DOM';
   readonly plugin: 'Builtin';
@@ -142,32 +142,6 @@ interface DOMElement
   removeAttribute(name: string): Promise<null>;
 }
 
-interface AnimationElement
-  extends WebflowElement,
-    CustomAttributes,
-    DomId,
-    Styles,
-    NoChildren,
-    NoTextContent,
-    NoAppConnections {
-  readonly id: FullElementId;
-  readonly type: 'Animation';
-  readonly plugin: 'Animation';
-}
-
-interface SplineElement
-  extends WebflowElement,
-    CustomAttributes,
-    DomId,
-    Styles,
-    NoChildren,
-    NoTextContent,
-    NoAppConnections {
-  readonly id: FullElementId;
-  readonly type: 'Spline';
-  readonly plugin: 'Animation';
-}
-
 interface SearchFormElement
   extends WebflowElement,
     CustomAttributes,
@@ -287,9 +261,9 @@ interface BlockquoteElement
 
 interface CodeBlockElement
   extends WebflowElement,
-    NoCustomAttributes,
-    NoDomId,
-    NoStyles,
+    CustomAttributes,
+    DomId,
+    Styles,
     NoChildren,
     NoTextContent,
     NoAppConnections {
@@ -533,6 +507,45 @@ interface InlineCodeElement
   readonly plugin: 'Basic';
 }
 
+interface AnimationElement
+  extends WebflowElement,
+    CustomAttributes,
+    DomId,
+    Styles,
+    NoChildren,
+    NoTextContent,
+    NoAppConnections {
+  readonly id: FullElementId;
+  readonly type: 'Animation';
+  readonly plugin: 'Animation';
+}
+
+interface SplineElement
+  extends WebflowElement,
+    CustomAttributes,
+    DomId,
+    Styles,
+    NoChildren,
+    NoTextContent,
+    NoAppConnections {
+  readonly id: FullElementId;
+  readonly type: 'Spline';
+  readonly plugin: 'Animation';
+}
+
+interface RiveElement
+  extends WebflowElement,
+    CustomAttributes,
+    DomId,
+    Styles,
+    NoChildren,
+    NoTextContent,
+    NoAppConnections {
+  readonly id: FullElementId;
+  readonly type: 'Rive';
+  readonly plugin: 'Animation';
+}
+
 interface BackgroundVideoWrapperElement
   extends WebflowElement,
     CustomAttributes,
@@ -4341,25 +4354,23 @@ interface UserErrorMsgElement
   readonly plugin: 'Users';
 }
 
-interface CodeIslandElement
+interface FrameElement
   extends WebflowElement,
     CustomAttributes,
     DomId,
     Styles,
-    NoChildren,
+    Children,
     NoTextContent,
     NoAppConnections {
   readonly id: FullElementId;
-  readonly type: 'CodeIsland';
-  readonly plugin: 'Code';
+  readonly type: 'Frame';
+  readonly plugin: 'Frame';
 }
 
 type AnyElement =
   | ComponentElement
   | UnknownElement
   | DOMElement
-  | AnimationElement
-  | SplineElement
   | SearchFormElement
   | SearchInputElement
   | SearchButtonElement
@@ -4387,6 +4398,9 @@ type AnyElement =
   | SuperscriptElement
   | SubscriptElement
   | InlineCodeElement
+  | AnimationElement
+  | SplineElement
+  | RiveElement
   | BackgroundVideoWrapperElement
   | BackgroundVideoPlayPauseButtonElement
   | BackgroundVideoPlayPauseButtonPlayingElement
@@ -4677,4 +4691,4 @@ type AnyElement =
   | UserResetPasswordErrorMsgElement
   | UserUpdatePasswordErrorMsgElement
   | UserErrorMsgElement
-  | CodeIslandElement;
+  | FrameElement;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webflow/designer-extension-typings",
-  "version": "2.0.21",
+  "version": "2.0.24",
   "license": "SEE LICENSE IN LICENSE",
   "description": "Typings for the Webflow Designer Extension API",
   "main": "",

package/variables.d.ts

@@ -38,8 +38,8 @@ interface ColorVariable {
    * ```
    */
   set(
-    value: ColorValue | ColorVariable | CustomValue,
-    options?: VariableOptions
+    value: ColorValue | ColorVariable | CustomValue | null,
+    options?: VariableSetOptions
   ): Promise<null>;
   /**
    * Get the variable’s value.
@@ -53,8 +53,8 @@ interface ColorVariable {
    * ```
    */
   get(
-    options?: VariableOptions
-  ): Promise<ColorValue | ColorVariable | CustomValue>;
+    options?: VariableGetOptions
+  ): Promise<ColorValue | ColorVariable | CustomValue | null>;
   /**
    * Removes a variable from the default collection.
    * @returns A Promise that resolves into a boolean indicating whether deleting the variable was successful or not.
@@ -137,8 +137,8 @@ interface SizeVariable {
    * ```
    */
   set(
-    value: SizeValue | SizeVariable | CustomValue,
-    options?: VariableOptions
+    value: SizeValue | SizeVariable | CustomValue | null,
+    options?: VariableSetOptions
   ): Promise<null>;
   /**
    * Get the variable’s value.
@@ -152,8 +152,8 @@ interface SizeVariable {
    * ```
    */
   get(
-    options?: VariableOptions
-  ): Promise<SizeValue | SizeVariable | CustomValue>;
+    options?: VariableGetOptions
+  ): Promise<SizeValue | SizeVariable | CustomValue | null>;
   /**
    * Removes a variable from the default collection.
    * @returns A Promise that resolves into a boolean indicating whether deleting the variable was successful or not.
@@ -237,8 +237,8 @@ interface NumberVariable {
    * ```
    */
   set(
-    value: NumberValue | NumberVariable | CustomValue,
-    options?: VariableOptions
+    value: NumberValue | NumberVariable | CustomValue | null,
+    options?: VariableSetOptions
   ): Promise<null>;
 
   /**
@@ -253,8 +253,8 @@ interface NumberVariable {
    * ```
    */
   get(
-    options?: VariableOptions
-  ): Promise<NumberValue | NumberVariable | CustomValue>;
+    options?: VariableGetOptions
+  ): Promise<NumberValue | NumberVariable | CustomValue | null>;
 
   /**
    * Removes the variable from the default collection.
@@ -338,8 +338,8 @@ interface PercentageVariable {
    * ```
    */
   set(
-    value: PercentageValue | PercentageVariable | CustomValue,
-    options?: VariableOptions
+    value: PercentageValue | PercentageVariable | CustomValue | null,
+    options?: VariableSetOptions
   ): Promise<null>;
 
   /**
@@ -354,8 +354,8 @@ interface PercentageVariable {
    * ```
    */
   get(
-    options?: VariableOptions
-  ): Promise<PercentageValue | PercentageVariable | CustomValue>;
+    options?: VariableGetOptions
+  ): Promise<PercentageValue | PercentageVariable | CustomValue | null>;
 
   /**
    * Removes the variable from the default collection.
@@ -437,8 +437,8 @@ interface FontFamilyVariable {
    * ```
    */
   set(
-    value: FontFamilyValue | FontFamilyVariable | CustomValue,
-    options?: VariableOptions
+    value: FontFamilyValue | FontFamilyVariable | CustomValue | null,
+    options?: VariableSetOptions
   ): Promise<null>;
   /**
    * Get the variable’s value.
@@ -452,8 +452,8 @@ interface FontFamilyVariable {
    * ```
    */
   get(
-    options?: VariableOptions
-  ): Promise<FontFamilyValue | FontFamilyVariable | CustomValue>;
+    options?: VariableGetOptions
+  ): Promise<FontFamilyValue | FontFamilyVariable | CustomValue | null>;
   /**
    * Removes a variable from the default collection.
    * @returns A Promise that resolves into a boolean indicating whether deleting the variable was successful or not.
@@ -648,11 +648,19 @@ type SizeUnit =
   | 'vmax'
   | 'vmin'
   | 'ch';
-type VariableOptions = {
+type VariableSetOptions = {
+  /** The mode to get/set the variable value for. */
+  mode?: VariableMode;
+  /** Whether to return custom values. */
+  customValues?: boolean;
+};
+type VariableGetOptions = {
   /** The mode to get/set the variable value for. */
   mode?: VariableMode;
   /** Whether to return custom values. */
   customValues?: boolean;
+  /** Whether to not return the base value and instead return null. */
+  doNotInheritFromBase?: boolean;
 };
 type CustomValue = {
   type: 'custom';