@webflow/designer-extension-typings 2.0.25 → 2.0.27

package/api.d.ts

@@ -96,6 +96,26 @@ interface WebflowApi {
    */
   getElementSnapshot(element: AnyElement): Promise<null | string>;
 
+  /**
+   * Renders the specified element to WHTML format.
+   * @param element - The element to render
+   * @returns A promise that resolves to an object containing the WHTML string and shortIdMap, or null
+   * @example
+   * ```ts
+   * const selectedElement = await webflow.getSelectedElement();
+   * if (selectedElement) {
+   *   const result = await webflow.getWHTML(selectedElement);
+   *   if (result) {
+   *     console.log('WHTML:', result.whtml);
+   *     console.log('Short ID Map:', result.shortIdMap);
+   *   }
+   * }
+   * ```
+   */
+  getWHTML?(
+    element: AnyElement
+  ): Promise<null | {whtml: string; shortIdMap: Record<string, string[]>}>;
+
   elementBuilder(elementPreset: ElementPreset<AnyElement>): BuilderElement;
   /**
    * Get the current media query breakpoint ID.
@@ -240,13 +260,14 @@ interface WebflowApi {
    */
   createStyle(name: string, options?: {parent?: Style}): Promise<Style>;
   /**
-   * Fetch a style by its name.
-   * @param name - The name of the style to retrieve.
+   * Fetch a style by its name or path.
+   * @param nameOrPath - The name or path of the style to retrieve.
    * @returns A Promise that resolves to one of the following:
    * - null if no style with the given name is found.
    * - Style object representing the style with the specified name.
    * @example
    * ```ts
+   * // Get a style by name
    * const styleName = 'myStyle';
    * const style = await webflow.getStyleByName(styleName);
    * if (style) {
@@ -254,9 +275,18 @@ interface WebflowApi {
    * } else {
    *   // Style not found
    * }
-   * ```
+   *
+   * // Get a nested style by path
+   * const stylePath = ['parent', 'child'];
+   * const style = await webflow.getStyleByName(stylePath);
+   * if (style) {
+   *   // Style found, handle it
+   * } else {
+   *   // Style not found
+   * }
+   *```
    */
-  getStyleByName(name: string): Promise<null | Style>;
+  getStyleByName(nameOrPath: string | string[]): Promise<null | Style>;
   /**
    * Fetch an array of all styles available in the Webflow project.
    * @returns A Promise that resolves to an array of Style objects representing all the styles present on the

package/elements-generated.d.ts

@@ -1,5 +1,17 @@
 // This file was automatically generated. See designer-extensions docs.
 
+type BlockElementTag =
+  | 'div'
+  | 'header'
+  | 'footer'
+  | 'nav'
+  | 'main'
+  | 'section'
+  | 'article'
+  | 'aside'
+  | 'address'
+  | 'figure';
+
 type InsertOrMoveElement = <
   el extends AnyElement,
   target extends el | ElementPreset<el> | Component | BuilderElement,
@@ -244,6 +256,8 @@ interface BlockElement
   readonly id: FullElementId;
   readonly type: 'Block';
   readonly plugin: 'Basic';
+  getTag(): Promise<null | BlockElementTag>;
+  setTag(tag: BlockElementTag): Promise<null>;
 }
 
 interface BlockquoteElement

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webflow/designer-extension-typings",
-  "version": "2.0.25",
+  "version": "2.0.27",
   "license": "MIT",
   "description": "Typings for the Webflow Designer Extension API",
   "main": "",

package/styles-generated.d.ts

@@ -283,6 +283,225 @@ type PropertyMap = {
   '-webkit-text-fill-color'?: string | ColorVariable;
   '-webkit-text-stroke-color'?: string | ColorVariable;
   '-webkit-text-stroke-width'?: string | SizeVariable;
+  'align-tracks'?: string;
+  all?: string;
+  'anchor-name'?: string;
+  'anchor-scope'?: string;
+  animation?: string;
+  'animation-composition'?: string;
+  'animation-range'?: string;
+  'animation-range-end'?: string;
+  'animation-range-start'?: string;
+  'animation-timeline'?: string;
+  'aspect-ratio'?: string;
+  azimuth?: string;
+  background?: string;
+  border?: string;
+  'border-block'?: string;
+  'border-block-color'?: string;
+  'border-block-style'?: string;
+  'border-block-width'?: string;
+  'border-block-end'?: string;
+  'border-block-start'?: string;
+  'border-bottom'?: string;
+  'border-image'?: string;
+  'border-inline'?: string;
+  'border-inline-end'?: string;
+  'border-inline-color'?: string;
+  'border-inline-style'?: string;
+  'border-inline-width'?: string;
+  'border-inline-start'?: string;
+  'border-left'?: string;
+  'border-right'?: string;
+  'border-spacing'?: string;
+  'border-style'?: string;
+  'border-top'?: string;
+  'box-align'?: string;
+  'box-decoration-break'?: string;
+  'box-direction'?: string;
+  'box-flex'?: string;
+  'box-flex-group'?: string;
+  'box-lines'?: string;
+  'box-ordinal-group'?: string;
+  'box-orient'?: string;
+  'box-pack'?: string;
+  caret?: string;
+  'caret-shape'?: string;
+  'color-scheme'?: string;
+  'column-fill'?: string;
+  'column-rule'?: string;
+  columns?: string;
+  contain?: string;
+  'contain-intrinsic-size'?: string;
+  'contain-intrinsic-block-size'?: string;
+  'contain-intrinsic-height'?: string;
+  'contain-intrinsic-inline-size'?: string;
+  'contain-intrinsic-width'?: string;
+  container?: string;
+  'container-name'?: string;
+  'container-type'?: string;
+  'content-visibility'?: string;
+  'counter-increment'?: string;
+  'counter-reset'?: string;
+  'counter-set'?: string;
+  d?: string;
+  'field-sizing'?: string;
+  flex?: string;
+  'flex-flow'?: string;
+  font?: string;
+  'font-feature-settings'?: string;
+  'font-language-override'?: string;
+  'font-palette'?: string;
+  'font-variation-settings'?: string;
+  'font-size-adjust'?: string;
+  'font-smooth'?: string;
+  'font-synthesis'?: string;
+  'font-synthesis-position'?: string;
+  'font-synthesis-small-caps'?: string;
+  'font-synthesis-style'?: string;
+  'font-synthesis-weight'?: string;
+  'font-variant'?: string;
+  'font-variant-position'?: string;
+  'forced-color-adjust'?: string;
+  gap?: string;
+  grid?: string;
+  'grid-area'?: string;
+  'grid-column'?: string;
+  'grid-gap'?: string;
+  'grid-row'?: string;
+  'grid-template'?: string;
+  'hanging-punctuation'?: string;
+  'hyphenate-character'?: string;
+  'hyphenate-limit-chars'?: string;
+  hyphens?: string;
+  'image-resolution'?: string;
+  'ime-mode'?: string;
+  'initial-letter'?: string;
+  'initial-letter-align'?: string;
+  'input-security'?: string;
+  inset?: string;
+  'inset-block'?: string;
+  'inset-inline'?: string;
+  'interpolate-size'?: string;
+  'justify-tracks'?: string;
+  'line-height-step'?: string;
+  'list-style'?: string;
+  margin?: string;
+  'margin-block'?: string;
+  'margin-inline'?: string;
+  'margin-trim'?: string;
+  marker?: string;
+  mask?: string;
+  'mask-border'?: string;
+  'mask-border-mode'?: string;
+  'mask-border-outset'?: string;
+  'mask-border-repeat'?: string;
+  'mask-border-slice'?: string;
+  'mask-border-source'?: string;
+  'mask-border-width'?: string;
+  'mask-clip'?: string;
+  'mask-composite'?: string;
+  'mask-image'?: string;
+  'mask-mode'?: string;
+  'mask-origin'?: string;
+  'mask-position'?: string;
+  'mask-repeat'?: string;
+  'mask-size'?: string;
+  'masonry-auto-flow'?: string;
+  'math-depth'?: string;
+  'math-shift'?: string;
+  'math-style'?: string;
+  'max-lines'?: string;
+  offset?: string;
+  'offset-position'?: string;
+  orphans?: string;
+  outline?: string;
+  overflow?: string;
+  'overflow-anchor'?: string;
+  'overflow-block'?: string;
+  'overflow-clip-box'?: string;
+  'overflow-clip-margin'?: string;
+  'overflow-inline'?: string;
+  overlay?: string;
+  'overscroll-behavior'?: string;
+  'overscroll-behavior-x'?: string;
+  'overscroll-behavior-y'?: string;
+  padding?: string;
+  'padding-block'?: string;
+  'padding-inline'?: string;
+  page?: string;
+  'page-break-after'?: string;
+  'page-break-before'?: string;
+  'page-break-inside'?: string;
+  'place-content'?: string;
+  'place-items'?: string;
+  'place-self'?: string;
+  'position-anchor'?: string;
+  'position-area'?: string;
+  'position-try'?: string;
+  'position-try-fallbacks'?: string;
+  'position-try-order'?: string;
+  'position-visibility'?: string;
+  'print-color-adjust'?: string;
+  quotes?: string;
+  'ruby-align'?: string;
+  'ruby-merge'?: string;
+  'ruby-position'?: string;
+  'scrollbar-color'?: string;
+  'scrollbar-gutter'?: string;
+  'scrollbar-width'?: string;
+  'scroll-margin'?: string;
+  'scroll-margin-block'?: string;
+  'scroll-margin-bottom'?: string;
+  'scroll-margin-inline'?: string;
+  'scroll-margin-left'?: string;
+  'scroll-margin-right'?: string;
+  'scroll-margin-top'?: string;
+  'scroll-padding'?: string;
+  'scroll-padding-block'?: string;
+  'scroll-padding-bottom'?: string;
+  'scroll-padding-inline'?: string;
+  'scroll-padding-left'?: string;
+  'scroll-padding-right'?: string;
+  'scroll-padding-top'?: string;
+  'scroll-snap-align'?: string;
+  'scroll-snap-coordinate'?: string;
+  'scroll-snap-destination'?: string;
+  'scroll-snap-points-x'?: string;
+  'scroll-snap-points-y'?: string;
+  'scroll-snap-stop'?: string;
+  'scroll-snap-type'?: string;
+  'scroll-snap-type-x'?: string;
+  'scroll-snap-type-y'?: string;
+  'scroll-timeline'?: string;
+  'scroll-timeline-axis'?: string;
+  'scroll-timeline-name'?: string;
+  'text-combine-upright'?: string;
+  'text-decoration-skip'?: string;
+  'text-decoration-thickness'?: string;
+  'text-emphasis'?: string;
+  'text-justify'?: string;
+  'text-orientation'?: string;
+  'text-size-adjust'?: string;
+  'text-spacing-trim'?: string;
+  'text-underline-offset'?: string;
+  'text-wrap'?: string;
+  'text-wrap-mode'?: string;
+  'text-wrap-style'?: string;
+  'timeline-scope'?: string;
+  'transform-box'?: string;
+  transition?: string;
+  'transition-behavior'?: string;
+  'user-select'?: string;
+  'view-timeline'?: string;
+  'view-timeline-axis'?: string;
+  'view-timeline-inset'?: string;
+  'view-timeline-name'?: string;
+  'view-transition-name'?: string;
+  'white-space-collapse'?: string;
+  widows?: string;
+  'word-wrap'?: string;
+  zoom?: string;
 };
 
 type StyleProperty =
@@ -567,7 +786,226 @@ type StyleProperty =
   | '-webkit-line-clamp'
   | '-webkit-text-fill-color'
   | '-webkit-text-stroke-color'
-  | '-webkit-text-stroke-width';
+  | '-webkit-text-stroke-width'
+  | 'align-tracks'
+  | 'all'
+  | 'anchor-name'
+  | 'anchor-scope'
+  | 'animation'
+  | 'animation-composition'
+  | 'animation-range'
+  | 'animation-range-end'
+  | 'animation-range-start'
+  | 'animation-timeline'
+  | 'aspect-ratio'
+  | 'azimuth'
+  | 'background'
+  | 'border'
+  | 'border-block'
+  | 'border-block-color'
+  | 'border-block-style'
+  | 'border-block-width'
+  | 'border-block-end'
+  | 'border-block-start'
+  | 'border-bottom'
+  | 'border-image'
+  | 'border-inline'
+  | 'border-inline-end'
+  | 'border-inline-color'
+  | 'border-inline-style'
+  | 'border-inline-width'
+  | 'border-inline-start'
+  | 'border-left'
+  | 'border-right'
+  | 'border-spacing'
+  | 'border-style'
+  | 'border-top'
+  | 'box-align'
+  | 'box-decoration-break'
+  | 'box-direction'
+  | 'box-flex'
+  | 'box-flex-group'
+  | 'box-lines'
+  | 'box-ordinal-group'
+  | 'box-orient'
+  | 'box-pack'
+  | 'caret'
+  | 'caret-shape'
+  | 'color-scheme'
+  | 'column-fill'
+  | 'column-rule'
+  | 'columns'
+  | 'contain'
+  | 'contain-intrinsic-size'
+  | 'contain-intrinsic-block-size'
+  | 'contain-intrinsic-height'
+  | 'contain-intrinsic-inline-size'
+  | 'contain-intrinsic-width'
+  | 'container'
+  | 'container-name'
+  | 'container-type'
+  | 'content-visibility'
+  | 'counter-increment'
+  | 'counter-reset'
+  | 'counter-set'
+  | 'd'
+  | 'field-sizing'
+  | 'flex'
+  | 'flex-flow'
+  | 'font'
+  | 'font-feature-settings'
+  | 'font-language-override'
+  | 'font-palette'
+  | 'font-variation-settings'
+  | 'font-size-adjust'
+  | 'font-smooth'
+  | 'font-synthesis'
+  | 'font-synthesis-position'
+  | 'font-synthesis-small-caps'
+  | 'font-synthesis-style'
+  | 'font-synthesis-weight'
+  | 'font-variant'
+  | 'font-variant-position'
+  | 'forced-color-adjust'
+  | 'gap'
+  | 'grid'
+  | 'grid-area'
+  | 'grid-column'
+  | 'grid-gap'
+  | 'grid-row'
+  | 'grid-template'
+  | 'hanging-punctuation'
+  | 'hyphenate-character'
+  | 'hyphenate-limit-chars'
+  | 'hyphens'
+  | 'image-resolution'
+  | 'ime-mode'
+  | 'initial-letter'
+  | 'initial-letter-align'
+  | 'input-security'
+  | 'inset'
+  | 'inset-block'
+  | 'inset-inline'
+  | 'interpolate-size'
+  | 'justify-tracks'
+  | 'line-height-step'
+  | 'list-style'
+  | 'margin'
+  | 'margin-block'
+  | 'margin-inline'
+  | 'margin-trim'
+  | 'marker'
+  | 'mask'
+  | 'mask-border'
+  | 'mask-border-mode'
+  | 'mask-border-outset'
+  | 'mask-border-repeat'
+  | 'mask-border-slice'
+  | 'mask-border-source'
+  | 'mask-border-width'
+  | 'mask-clip'
+  | 'mask-composite'
+  | 'mask-image'
+  | 'mask-mode'
+  | 'mask-origin'
+  | 'mask-position'
+  | 'mask-repeat'
+  | 'mask-size'
+  | 'masonry-auto-flow'
+  | 'math-depth'
+  | 'math-shift'
+  | 'math-style'
+  | 'max-lines'
+  | 'offset'
+  | 'offset-position'
+  | 'orphans'
+  | 'outline'
+  | 'overflow'
+  | 'overflow-anchor'
+  | 'overflow-block'
+  | 'overflow-clip-box'
+  | 'overflow-clip-margin'
+  | 'overflow-inline'
+  | 'overlay'
+  | 'overscroll-behavior'
+  | 'overscroll-behavior-x'
+  | 'overscroll-behavior-y'
+  | 'padding'
+  | 'padding-block'
+  | 'padding-inline'
+  | 'page'
+  | 'page-break-after'
+  | 'page-break-before'
+  | 'page-break-inside'
+  | 'place-content'
+  | 'place-items'
+  | 'place-self'
+  | 'position-anchor'
+  | 'position-area'
+  | 'position-try'
+  | 'position-try-fallbacks'
+  | 'position-try-order'
+  | 'position-visibility'
+  | 'print-color-adjust'
+  | 'quotes'
+  | 'ruby-align'
+  | 'ruby-merge'
+  | 'ruby-position'
+  | 'scrollbar-color'
+  | 'scrollbar-gutter'
+  | 'scrollbar-width'
+  | 'scroll-margin'
+  | 'scroll-margin-block'
+  | 'scroll-margin-bottom'
+  | 'scroll-margin-inline'
+  | 'scroll-margin-left'
+  | 'scroll-margin-right'
+  | 'scroll-margin-top'
+  | 'scroll-padding'
+  | 'scroll-padding-block'
+  | 'scroll-padding-bottom'
+  | 'scroll-padding-inline'
+  | 'scroll-padding-left'
+  | 'scroll-padding-right'
+  | 'scroll-padding-top'
+  | 'scroll-snap-align'
+  | 'scroll-snap-coordinate'
+  | 'scroll-snap-destination'
+  | 'scroll-snap-points-x'
+  | 'scroll-snap-points-y'
+  | 'scroll-snap-stop'
+  | 'scroll-snap-type'
+  | 'scroll-snap-type-x'
+  | 'scroll-snap-type-y'
+  | 'scroll-timeline'
+  | 'scroll-timeline-axis'
+  | 'scroll-timeline-name'
+  | 'text-combine-upright'
+  | 'text-decoration-skip'
+  | 'text-decoration-thickness'
+  | 'text-emphasis'
+  | 'text-justify'
+  | 'text-orientation'
+  | 'text-size-adjust'
+  | 'text-spacing-trim'
+  | 'text-underline-offset'
+  | 'text-wrap'
+  | 'text-wrap-mode'
+  | 'text-wrap-style'
+  | 'timeline-scope'
+  | 'transform-box'
+  | 'transition'
+  | 'transition-behavior'
+  | 'user-select'
+  | 'view-timeline'
+  | 'view-timeline-axis'
+  | 'view-timeline-inset'
+  | 'view-timeline-name'
+  | 'view-transition-name'
+  | 'white-space-collapse'
+  | 'widows'
+  | 'word-wrap'
+  | 'zoom';
 
 type PseudoStateKey =
   | 'noPseudo'