@webflow/designer-extension-typings 2.0.3 → 2.0.5

package/api.d.ts

@@ -68,6 +68,18 @@ interface WebflowApi {
    * ```
    */
   getMediaQuery(): Promise<BreakpointId>;
+
+  /**
+   * Get the current pseudo mode.
+   * @returns A Promise that resolves to a PseudoStateKey which is a string representing the current pseudo mode.
+   * @example
+   * ```ts
+   * const pseudoMode = await webflow.getPseudoMode();
+   * console.log('Current Pseudo Mode:', pseudoMode);
+   * ```
+   */
+  getPseudoMode(): Promise<null | PseudoStateKey>;
+
   /**
    * Create a component by promoting a Root Element.
    * @param name - The name of the component.
@@ -312,10 +324,11 @@ interface WebflowApi {
    * webflow.notify({ type: 'Info', message: 'Great work!' }); // General notification
    * webflow.notify({ type: 'Error', message: 'Something went wrong, try again!' }); // Error notification
    * webflow.notify({ type: 'Success', message: 'Successfully did something!' }); // Success notification
+   * webflow.notify({ type: 'Warning', message: 'Something is not right, please check again!' }); // Warning notification
    * ```
    */
   notify(opts: {
-    type: 'Error' | 'Info' | 'Success';
+    type: 'Error' | 'Info' | 'Success' | 'Warning';
     message: string;
   }): Promise<void>;
   /**
@@ -411,6 +424,11 @@ interface WebflowApi {
 
   subscribe(event: 'currentappmode', callback: () => void): Unsubscribe;
 
+  subscribe(
+    event: 'pseudomode',
+    callback: (pseudoMode: null | PseudoStateKey) => void
+  ): Unsubscribe;
+
   getIdToken(): Promise<string>;
   getAppSubscriptions(): Promise<Array<AppSubscription>>;
   elementPresets: ElementPresets;
@@ -493,6 +511,14 @@ interface WebflowApi {
    */
   appModes: {[key in AppMode]: AppMode};
 
+  /**
+   * Closes the extension
+   * ```ts
+   * await webflow.closeExtension();
+   * ```
+   */
+  closeExtension(): Promise<null>;
+
   /**
    * Gets the current App connection
    * ```ts
@@ -508,6 +534,14 @@ interface WebflowApi {
    * ```
    */
   getCurrentAppConnectionResource(): Promise<null | AppConnectionResource>;
+
+  /**
+   * Gets the current App launch context (i.e how the app was launched)
+   * ```ts
+   * const launchContext = await webflow.getLaunchContext();
+   * ```
+   */
+  getLaunchContext(): Promise<null | LaunchContext>;
 }
 
 type Unsubscribe = () => void;

package/app-connections.d.ts

@@ -2,3 +2,8 @@ type AppConnectionResource = {
   type: 'Element';
   value: AnyElement;
 };
+
+type LaunchContext = {
+  type: 'AppConnection' | 'AppIntent' | 'DeepLink';
+  value: null | string | {[key in 'form' | 'image']?: 'create' | 'manage'};
+};

package/package.json

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

package/styles-generated.d.ts

@@ -562,3 +562,21 @@ type StyleProperty =
   | '-webkit-text-fill-color'
   | '-webkit-text-stroke-color'
   | '-webkit-text-stroke-width';
+
+type PseudoStateKey =
+  | 'noPseudo'
+  | 'nth-child(odd)'
+  | 'nth-child(even)'
+  | 'first-child'
+  | 'last-child'
+  | 'hover'
+  | 'active'
+  | 'pressed'
+  | 'visited'
+  | 'focus'
+  | 'focus-visible'
+  | 'focus-within'
+  | 'placeholder'
+  | 'empty'
+  | 'before'
+  | 'after';

package/styles.d.ts

@@ -100,21 +100,3 @@ type BreakpointId =
   | 'medium'
   | 'small'
   | 'tiny';
-
-type PseudoStateKey =
-  | 'noPseudo'
-  | 'nth-child(odd)'
-  | 'nth-child(even)'
-  | 'first-child'
-  | 'last-child'
-  | 'hover'
-  | 'active'
-  | 'pressed'
-  | 'visited'
-  | 'focus'
-  | 'focus-visible'
-  | 'focus-within'
-  | 'placeholder'
-  | 'empty'
-  | 'before'
-  | 'after';