@webflow/designer-extension-typings 0.1.2 → 0.1.4

package/elements-generated.d.ts

@@ -18,6 +18,8 @@ interface CustomAttributes {
   readonly customAttributes: true;
   getCustomAttribute(name: string): null | string;
   setCustomAttribute(name: string, value: string): undefined;
+  removeCustomAttribute(name: string): undefined;
+  getAllCustomAttributes(): Array<CustomAttribute>;
 }
 
 interface NoCustomAttributes {
@@ -90,6 +92,7 @@ interface DOMElement
   getTag(): null | string;
   getAttribute(name: string): null | string;
   setAttribute(name: string, value: string): undefined;
+  removeAttribute(name: string): undefined;
 }
 
 interface AnimationElement
@@ -105,6 +108,19 @@ interface AnimationElement
   readonly plugin: 'Animation';
 }
 
+interface SplineElement
+  extends WebflowElement,
+    Configurable,
+    CustomAttributes,
+    DomId,
+    Styles,
+    NoChildren,
+    NoTextContent {
+  readonly id: ElementId;
+  readonly type: 'Spline';
+  readonly plugin: 'Animation';
+}
+
 interface BlockElement
   extends WebflowElement,
     Configurable,
@@ -514,7 +530,7 @@ interface CommerceAddToCartButtonElement
   extends WebflowElement,
     Configurable,
     CustomAttributes,
-    DomId,
+    NoDomId,
     Styles,
     NoChildren,
     NoTextContent {
@@ -696,7 +712,7 @@ interface CommerceCartOpenLinkElement
   extends WebflowElement,
     Configurable,
     CustomAttributes,
-    DomId,
+    NoDomId,
     Styles,
     Children,
     TextContent {
@@ -748,7 +764,7 @@ interface CommerceCartContainerElement
   extends WebflowElement,
     Configurable,
     CustomAttributes,
-    DomId,
+    NoDomId,
     Styles,
     Children,
     NoTextContent {
@@ -969,7 +985,7 @@ interface CommerceCartCloseLinkElement
   extends WebflowElement,
     Configurable,
     CustomAttributes,
-    DomId,
+    NoDomId,
     Styles,
     Children,
     TextContent {
@@ -995,7 +1011,7 @@ interface CommerceCartRemoveLinkElement
   extends WebflowElement,
     Configurable,
     CustomAttributes,
-    DomId,
+    NoDomId,
     Styles,
     Children,
     TextContent {
@@ -2516,7 +2532,7 @@ interface FormBlockLabelElement
   extends WebflowElement,
     Configurable,
     CustomAttributes,
-    DomId,
+    NoDomId,
     Styles,
     Children,
     TextContent {
@@ -2928,6 +2944,58 @@ interface IconElement
   readonly plugin: 'Icon';
 }
 
+interface LocalesWrapperElement
+  extends WebflowElement,
+    Configurable,
+    CustomAttributes,
+    DomId,
+    Styles,
+    Children,
+    NoTextContent {
+  readonly id: ElementId;
+  readonly type: 'LocalesWrapper';
+  readonly plugin: 'Localization';
+}
+
+interface LocalesEmptyElement
+  extends WebflowElement,
+    Configurable,
+    CustomAttributes,
+    DomId,
+    Styles,
+    Children,
+    NoTextContent {
+  readonly id: ElementId;
+  readonly type: 'LocalesEmpty';
+  readonly plugin: 'Localization';
+}
+
+interface LocalesListElement
+  extends WebflowElement,
+    Configurable,
+    CustomAttributes,
+    DomId,
+    Styles,
+    Children,
+    NoTextContent {
+  readonly id: ElementId;
+  readonly type: 'LocalesList';
+  readonly plugin: 'Localization';
+}
+
+interface LocalesItemElement
+  extends WebflowElement,
+    Configurable,
+    CustomAttributes,
+    DomId,
+    Styles,
+    Children,
+    NoTextContent {
+  readonly id: ElementId;
+  readonly type: 'LocalesItem';
+  readonly plugin: 'Localization';
+}
+
 interface ContainerElement
   extends WebflowElement,
     Configurable,
@@ -3019,7 +3087,7 @@ interface CellElement
   readonly plugin: 'Layout';
 }
 
-interface FlexContainerElement
+interface BlockContainerElement
   extends WebflowElement,
     Configurable,
     CustomAttributes,
@@ -3028,7 +3096,7 @@ interface FlexContainerElement
     Children,
     NoTextContent {
   readonly id: ElementId;
-  readonly type: 'FlexContainer';
+  readonly type: 'BlockContainer';
   readonly plugin: 'Layout';
 }
 
@@ -3127,7 +3195,7 @@ interface NavbarMenuElement
   extends WebflowElement,
     Configurable,
     CustomAttributes,
-    DomId,
+    NoDomId,
     Styles,
     Children,
     NoTextContent {
@@ -3816,7 +3884,7 @@ interface UserFormBlockLabelElement
   extends WebflowElement,
     Configurable,
     CustomAttributes,
-    DomId,
+    NoDomId,
     Styles,
     Children,
     TextContent {
@@ -4154,6 +4222,7 @@ declare type AnyElement =
   | UnknownElement
   | DOMElement
   | AnimationElement
+  | SplineElement
   | BlockElement
   | BlockquoteElement
   | EmphasizedElement
@@ -4371,6 +4440,10 @@ declare type AnyElement =
   | FormFileUploadInfoElement
   | FormFileUploadTextElement
   | IconElement
+  | LocalesWrapperElement
+  | LocalesEmptyElement
+  | LocalesListElement
+  | LocalesItemElement
   | ContainerElement
   | RowElement
   | ColumnElement
@@ -4378,7 +4451,7 @@ declare type AnyElement =
   | GridElement
   | LayoutElement
   | CellElement
-  | FlexContainerElement
+  | BlockContainerElement
   | VFlexElement
   | HFlexElement
   | LightboxWrapperElement

package/elements.d.ts

@@ -2,3 +2,7 @@
 /// <reference path="./elements-generated.d.ts" />
 
 declare type ElementId = string;
+declare type CustomAttribute = {
+  name: string;
+  value: string;
+};

package/index.d.ts

@@ -1,4 +1,5 @@
 /// <reference path="./styles.d.ts" />
+/// <reference path="./pages.d.ts" />
 /// <reference path="./elements.d.ts" />
 
 declare global {
@@ -6,15 +7,24 @@ declare global {
 }
 
 interface WebflowApi {
+  getSiteInfo(): Promise<{siteId: string; siteName: string}>;
   getSelectedElement(): Promise<null | AnyElement>;
   getMediaQuery(): Promise<BreakpointId>;
   getAllElements(): Promise<Array<AnyElement>>;
   createStyle(name: string): Style;
   getStyleByName(name: string): Promise<null | Style>;
   getAllStyles(): Promise<Array<Style>>;
+  getCurrentPage(): Promise<Page>;
+  getAllPagesAndFolders(): Promise<Array<Page | Folder>>;
+  createFolder(): Promise<Folder>;
+  createPage(): Promise<Page>;
+  switchPage(page: Page): Promise<void>;
   createString(text: string): StringElement;
   createDOM(tag: string): DOMElement;
   createHeading(tag: 1 | 2 | 3 | 4 | 5 | 6): HeadingElement;
+  setExtensionSize(
+    size: 'default' | 'comfortable' | 'large' | {width: number; height: number}
+  ): Promise<null>;
   notify(opts: {
     type: 'Error' | 'Info' | 'Success';
     message: string;
@@ -27,6 +37,7 @@ interface WebflowApi {
     event: 'mediaquery',
     callback: (breakpoint: BreakpointId) => void
   ): Unsubscribe;
+  subscribe(event: 'currentpage', callback: (page: Page) => void): Unsubscribe;
 }
 
 type Unsubscribe = () => undefined;

package/package.json

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

package/pages.d.ts

@@ -0,0 +1,66 @@
+interface Folder {
+  readonly id: FolderId;
+  readonly type: 'Folder';
+
+  getName(): string;
+  setName(name: string): undefined;
+  getSlug(): string;
+  setSlug(slug: string): undefined;
+  getParent(): Promise<null | Folder>;
+  setParent(parent: Folder): undefined;
+
+  save(): Promise<undefined>;
+  destroy(): undefined;
+}
+
+interface Page {
+  readonly id: PageId;
+  readonly type: 'Page';
+
+  getName(): string;
+  setName(name: string): undefined;
+  getSlug(): string;
+  setSlug(slug: string): undefined;
+  getParent(): Promise<null | Folder>;
+  setParent(parent: Folder): undefined;
+
+  getTitle(): string;
+  setTitle(title: string): undefined;
+  getDescription(): string;
+  setDescription(description: string): undefined;
+  isDraft(): boolean;
+  setDraft(isDraft: boolean): undefined;
+  usesTitleAsOgTitle(): boolean;
+  useTitleAsOgTitle(use: boolean): undefined;
+  getOgTitle(): string;
+  setOgTitle(title: string): undefined;
+  usesDescriptionAsOgDescription(): boolean;
+  useDescriptionAsOgDescription(use: boolean): undefined;
+  getOgDescription(): string;
+  setOgDescription(description: string): undefined;
+  getOgImage(): string;
+  setOgImage(url: string): undefined;
+  isExcludedFromSearch(): boolean;
+  excludeFromSearch(shouldExclude: boolean): undefined;
+  usesTitleAsSearchTitle(): boolean;
+  useTitleAsSearchTitle(use: boolean): undefined;
+  getSearchTitle(): string;
+  setSearchTitle(title: string): undefined;
+  usesDescriptionAsSearchDescription(): boolean;
+  useDescriptionAsSearchDescription(use: boolean): undefined;
+  getSearchDescription(): string;
+  setSearchDescription(description: string): undefined;
+  usesOgImageAsSearchImage(): boolean;
+  useOgImageAsSearchImage(use: boolean): undefined;
+  getSearchImage(): string;
+  setSearchImage(url: string): undefined;
+  isPasswordProtected(): boolean;
+  getUtilityPageKey(): null | string;
+  isHomepage(): boolean;
+
+  save(): Promise<undefined>;
+  destroy(): undefined;
+}
+
+declare type FolderId = string;
+declare type PageId = string;