@webflow/designer-extension-typings 2.0.2 → 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;
@@ -452,6 +470,33 @@ interface WebflowApi {
    */
   getAllAssets(): Promise<Array<Asset>>;
 
+  /**
+   * Gets all asset folders for the site
+   * @example
+   * ```ts
+   * const assetFolders = await webflow.getAssetFolders();
+   * console.log('Asset folders:', assetFolders);
+   * ```
+   * @returns A Promise that resolves to an array of AssetFolder objects
+   */
+  getAllAssetFolders(): Promise<Array<AssetFolder>>;
+
+  /**
+   * Creates a new asset folder within a given site
+   * @param name - The name of the new asset folder.
+   * @param parentFolderId - Optional. The ID of the parent folder. If not provided, the folder will be created at the root level.
+   * @returns A Promise that resolves to the newly created AssetFolder object.
+   * @example
+   * ```ts
+   * const newFolder = await webflow.createAssetFolder('My New Folder');
+   * console.log('New folder created:', newFolder.id);
+   * ```
+   */
+  createAssetFolder(
+    name: string,
+    parentFolderId?: string
+  ): Promise<AssetFolder>;
+
   /**
    * Checks if the user has the ability to perform the given App Mode
    * @param appModes
@@ -466,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
@@ -481,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/assets.d.ts

@@ -48,6 +48,35 @@ interface Asset {
    * ```
    */
   getMimeType(): Promise<string>;
+
+  /**
+   * Set the parent folder of the asset.
+   * @example
+   * ```ts
+   * const asset = await webflow.getAssetById('123');
+   * const folder = await webflow.createAssetFolder('New Folder');
+   * await asset.setParent(folder);
+   * ```
+   */
+  setParent(assetFolder: AssetFolder): Promise<null>;
+
+  /**
+   * Get the parent folder of the asset.
+   * @example
+   * ```ts
+   * const asset = await webflow.getAssetById('123');
+   * const parentFolder = await asset.getParent();
+   * ```
+   */
+  getParent(): Promise<AssetFolder | null>;
 }
 
 type AssetId = string;
+
+type AssetFolder = {
+  readonly id: AssetFolderId;
+
+  getName(): Promise<string>;
+};
+
+type AssetFolderId = string;

package/element-presets-generated.d.ts

@@ -103,14 +103,6 @@ type ElementPresets = {
   LayoutFooterDark: ElementPreset<SectionElement>;
   LayoutFooterLight: ElementPreset<SectionElement>;
   LayoutFooterSubscribe: ElementPreset<SectionElement>;
-  StructureLayoutQuickStack1x1: ElementPreset<SectionElement>;
-  StructureLayoutQuickStack2x1: ElementPreset<SectionElement>;
-  StructureLayoutQuickStack3x1: ElementPreset<SectionElement>;
-  StructureLayoutQuickStack4x1: ElementPreset<SectionElement>;
-  StructureLayoutQuickStack2x2: ElementPreset<SectionElement>;
-  StructureLayoutQuickStack2plus1: ElementPreset<SectionElement>;
-  StructureLayoutQuickStack1plus2: ElementPreset<SectionElement>;
-  StructureLayoutQuickStackMasonry: ElementPreset<SectionElement>;
   UserAccountSubscriptionList: ElementPreset<UserAccountSubscriptionListWrapperElement>;
   UserLogOutLogIn: ElementPreset<UserLogOutLogInElement>;
   SignUp: ElementPreset<UserSignUpFormWrapperElement>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webflow/designer-extension-typings",
-  "version": "2.0.2",
+  "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';