@webflow/designer-extension-typings 0.1.2 → 0.1.3

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,12 +7,18 @@ 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;
@@ -27,6 +34,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.3",
   "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;