@webflow/designer-extension-typings 2.0.29 → 2.0.31

package/instance-props.d.ts

@@ -0,0 +1,150 @@
+// Instance Props types
+
+interface LinkResolvedValue {
+  mode:
+    | 'url'
+    | 'page'
+    | 'pageSection'
+    | 'email'
+    | 'phone'
+    | 'file'
+    | 'collectionPage';
+  to?:
+    | string
+    | {pageId: string}
+    | {assetId: string}
+    | {fullElementId: {element: string; component: string}}
+    | {pageSlug: string};
+  openInNewTab?: boolean;
+  emailSubject?: string;
+  rel?: string;
+}
+
+interface VideoResolvedValue {
+  src?: string;
+  title?: string;
+}
+
+interface RichTextResolvedValue {
+  innerText: string;
+}
+
+type ResolvedValue =
+  | string
+  | number
+  | boolean
+  | null
+  | LinkResolvedValue
+  | VideoResolvedValue
+  | RichTextResolvedValue;
+
+interface StaticPropValue {
+  sourceType: 'static';
+  value: ResolvedValue | null;
+}
+
+type BindingPropValue =
+  | {
+      sourceType: 'prop';
+      propId: string;
+      propName: string;
+      propGroup: string | null;
+    }
+  | {
+      sourceType: 'cms';
+      collectionId: string;
+      collectionName: string;
+      fieldId: string;
+      fieldName: string;
+      fieldGroup: string | null;
+      fieldType: CmsFieldType;
+    }
+  | {
+      sourceType: 'locale';
+      fieldKey: string;
+      fieldName: string;
+      fieldType: 'string';
+    }
+  | {
+      sourceType: 'localeItem';
+      fieldKey: string;
+      fieldName: string;
+      fieldType: 'string';
+    }
+  | {
+      sourceType: 'page';
+      fieldKey: string;
+      fieldName: string;
+    }
+  | {sourceType: 'conditional'}
+  | {sourceType: 'legacy'};
+
+type InstancePropValue = StaticPropValue | BindingPropValue;
+
+interface InstancePropDisplay {
+  label: string;
+  group: string | null;
+  trueLabel?: string;
+  falseLabel?: string;
+}
+
+interface InstanceProp {
+  propId: string;
+  valueType: BindableValueType;
+  hasOverride: boolean;
+  value: InstancePropValue;
+  resolvedValue: ResolvedValue | null;
+  defaultValue: ResolvedValue | null;
+  display: InstancePropDisplay;
+}
+
+interface InstancePropSummary {
+  propId: string;
+  value: ResolvedValue | BindingPropValue | null;
+  hasOverride: boolean;
+}
+
+interface SearchInstancePropsOptions {
+  /** Filter to props that produce a specific value type (e.g., "string", "boolean") */
+  valueType?: BindableValueType;
+}
+
+// Set Instance Props types
+
+interface PropBindingInput {
+  sourceType: 'prop';
+  propId: string;
+}
+
+interface CmsBindingInput {
+  sourceType: 'cms';
+  collectionId: string;
+  fieldId: string;
+}
+
+interface PageBindingInput {
+  sourceType: 'page';
+  fieldKey: string;
+}
+
+interface LocaleBindingInput {
+  sourceType: 'locale';
+  fieldKey: string;
+}
+
+interface LocaleItemBindingInput {
+  sourceType: 'localeItem';
+  fieldKey: string;
+}
+
+type BindingInput =
+  | PropBindingInput
+  | CmsBindingInput
+  | PageBindingInput
+  | LocaleBindingInput
+  | LocaleItemBindingInput;
+
+interface SetInstancePropEntry {
+  propId: string;
+  value: ResolvedValue | BindingInput | null;
+}

package/package.json

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

package/pages.d.ts

@@ -459,6 +459,53 @@ interface Page {
     | 'utility'
     | 'staticTemplate'
   >;
+  /**
+   * Get the branch ID of this page, if it exists on a branch.
+   * Returns null if the page is not on a branch.
+   * @returns The branch ID string, or null.
+   * @example
+   * ```ts
+   * const branchId = await myPage.getBranchId();
+   * if (branchId) {
+   *   console.log("Page is on branch:", branchId);
+   * }
+   * ```
+   */
+  getBranchId(): Promise<string | null>;
+  /**
+   * Get the ID of this page's parent. For branch pages, this returns the ID
+   * of the original page that was branched — use it with `switchPage()` to
+   * navigate back to main. For pages inside folders, returns the folder ID.
+   * Returns null for root-level non-branch pages.
+   * @returns The parent page or folder ID, or null.
+   * @example
+   * ```ts
+   * // Navigate back to main from a branch
+   * const parentId = await myPage.getParentPageId();
+   * if (parentId) {
+   *   const mainPage = await webflow.getPage(parentId);
+   *   await webflow.switchPage(mainPage);
+   * }
+   * ```
+   */
+  getParentPageId(): Promise<string | null>;
+
+  /**
+   * List all branch pages that exist for this page.
+   * Returns an array of objects with `pageId` and `branchId` for each branch.
+   * Use `pageId` with `webflow.getPage()` and `webflow.switchPage()` to navigate.
+   * Returns an empty array if the page has no branches.
+   * @returns Array of branch objects with pageId and branchId.
+   * @example
+   * ```ts
+   * const branches = await myPage.listBranches();
+   * if (branches.length > 0) {
+   *   const branchPage = await webflow.getPage(branches[0].pageId);
+   *   await webflow.switchPage(branchPage);
+   * }
+   * ```
+   */
+  listBranches(): Promise<Array<{pageId: string; branchId: string}>>;
 }
 
 type FolderId = string;