@webflow/designer-extension-typings 2.0.31 → 2.0.33

package/elements.d.ts

@@ -14,6 +14,11 @@ type FormState = 'normal' | 'success' | 'error';
 
 type FormMethod = 'get' | 'post';
 
+/**
+ * @deprecated Use `element.getSettings()` (returns `ElementSettingSummaries`) or
+ * `element.searchSettings()` (returns `Record<string, ElementSetting>`) instead.
+ * These generic APIs return the same form fields plus all other applicable settings.
+ */
 type FormSettings = {
   state: FormState;
   name: string;

package/instance-props.d.ts

@@ -1,25 +1,60 @@
 // 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};
+/** All public-facing link mode identifiers. */
+type LinkMode =
+  | 'url'
+  | 'page'
+  | 'pageSection'
+  | 'email'
+  | 'phone'
+  | 'file'
+  | 'collectionPage';
+
+interface LinkResolvedValueBase {
+  mode: LinkMode;
   openInNewTab?: boolean;
+  rel?: 'none' | 'preload' | 'prefetch' | 'prerender';
+}
+
+interface PageLinkResolvedValue extends LinkResolvedValueBase {
+  mode: 'page';
+  to?: {pageId: string};
+}
+
+interface PageSectionLinkResolvedValue extends LinkResolvedValueBase {
+  mode: 'pageSection';
+  to?: {fullElementId: FullElementId};
+}
+
+interface CollectionPageLinkResolvedValue extends LinkResolvedValueBase {
+  mode: 'collectionPage';
+  to?: {pageSlug: string};
+}
+
+interface EmailLinkResolvedValue extends LinkResolvedValueBase {
+  mode: 'email';
+  to?: string;
   emailSubject?: string;
-  rel?: string;
 }
 
+interface FileLinkResolvedValue extends LinkResolvedValueBase {
+  mode: 'file';
+  to?: {assetId: string};
+}
+
+interface GenericLinkResolvedValue extends LinkResolvedValueBase {
+  mode: 'url' | 'phone';
+  to?: string;
+}
+
+type LinkResolvedValue =
+  | PageLinkResolvedValue
+  | PageSectionLinkResolvedValue
+  | CollectionPageLinkResolvedValue
+  | EmailLinkResolvedValue
+  | FileLinkResolvedValue
+  | GenericLinkResolvedValue;
+
 interface VideoResolvedValue {
   src?: string;
   title?: string;
@@ -43,7 +78,7 @@ interface StaticPropValue {
   value: ResolvedValue | null;
 }
 
-type BindingPropValue =
+type BindingValue =
   | {
       sourceType: 'prop';
       propId: string;
@@ -79,31 +114,38 @@ type BindingPropValue =
   | {sourceType: 'conditional'}
   | {sourceType: 'legacy'};
 
-type InstancePropValue = StaticPropValue | BindingPropValue;
+type SettingValue = StaticPropValue | BindingValue;
 
-interface InstancePropDisplay {
+interface SettingDisplay {
   label: string;
   group: string | null;
   trueLabel?: string;
   falseLabel?: string;
+  /** Available choices for variant props. Each entry is a variant the component author defined. */
+  options?: Array<Pick<Variant, 'id' | 'name'>>;
 }
 
 interface InstanceProp {
   propId: string;
   valueType: BindableValueType;
   hasOverride: boolean;
-  value: InstancePropValue;
+  value: SettingValue;
   resolvedValue: ResolvedValue | null;
   defaultValue: ResolvedValue | null;
-  display: InstancePropDisplay;
+  display: SettingDisplay;
 }
 
 interface InstancePropSummary {
   propId: string;
-  value: ResolvedValue | BindingPropValue | null;
+  value: ResolvedValue | BindingValue | null;
   hasOverride: boolean;
 }
 
+interface ResolvedInstanceProp {
+  propId: string;
+  value: ResolvedValue | null;
+}
+
 interface SearchInstancePropsOptions {
   /** Filter to props that produce a specific value type (e.g., "string", "boolean") */
   valueType?: BindableValueType;

package/package.json

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