@webflow/designer-extension-typings 2.0.6 → 2.0.8

package/api.d.ts

@@ -290,6 +290,50 @@ interface WebflowApi {
    * ```
    */
   getDefaultVariableCollection(): Promise<null | VariableCollection>;
+  /**
+   * Creates a new variable collection.
+   * @param name - The name of the new variable collection.
+   * @returns A Promise that resolves into a newly created Collection.
+   * @example
+   * ```ts
+   * const collection = await webflow.createVariableCollection('My New Collection');
+   * ```
+   */
+  createVariableCollection(name: string): Promise<VariableCollection>;
+
+  /**
+   * Fetches a variable collection by its id.
+   * @param id - The id of the variable collection to fetch.
+   * @returns A Promise that resolves into a Collection.
+   * @example
+   * ```ts
+   * const collection = await webflow.getVariableCollectionById('collectionId');
+   * ```
+   */
+  getVariableCollectionById(
+    id: VariableCollectionId
+  ): Promise<VariableCollection | null>;
+
+  /**
+   * Fetches all variable collections.
+   * @returns A Promise that resolves to an array of Collection objects.
+   * @example
+   * ```ts
+   * const collections = await webflow.getAllVariableCollections();
+   * ```
+   */
+  getAllVariableCollections(): Promise<Array<VariableCollection> | null>;
+
+  /**
+   * Removes the variable collection.
+   * @returns A Promise that resolves into a boolean indicating whether deleting the variable collection was successful.
+   * @example
+   * ```ts
+   * const collection = await webflow.removeVariableCollection('collectionId');
+   * ```
+   */
+  removeVariableCollection(id: VariableCollectionId): Promise<boolean>;
+
   /**
    * Sets the extension size to one of predefined sizes or a custom size. If the specified custom size is larger than
    * the user's viewport size, the extension will default to the width/height of the browser's viewport.

package/package.json

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

package/pages.d.ts

@@ -130,13 +130,13 @@ interface Page {
   getTitle(): Promise<string>;
   /**
    * Sets the title of the page to the provided value.
-   * @param title - The new title to set for the page.
+   * @param title - The new title to set for the page. Passing null will unset the current value.
    * @example
    * ```ts
    * await myPage.setTitle("New Page Title");
    * ```
    */
-  setTitle(title: string): Promise<null>;
+  setTitle(title: string | null): Promise<null>;
   /**
    * Retrieves the description of the page.
    * @example
@@ -148,13 +148,13 @@ interface Page {
   getDescription(): Promise<string>;
   /**
    * Sets the description of the page to the provided value.
-   * @param description - The new description to set for the page.
+   * @param description - The new description to set for the page. Passing null will unset the current value.
    * @example
    * ```ts
    * await myPage.setDescription("New Page Description");
    * ```
    */
-  setDescription(description: string): Promise<null>;
+  setDescription(description: string | null): Promise<null>;
   /**
    * Checks if the page is in draft mode or not.
    * @example
@@ -203,13 +203,13 @@ interface Page {
   getOpenGraphTitle(): Promise<string>;
   /**
    * Sets the Open Graph (OG) title of the page to the provided value.
-   * @param title - The new OG title to set for the page.
+   * @param title - The new OG title to set for the page. Passing null will unset the current value.
    * @example
    * ```ts
    * await myPage.setOpenGraphTitle("New OG Title");
    * ```
    */
-  setOpenGraphTitle(title: string): Promise<null>;
+  setOpenGraphTitle(title: string | null): Promise<null>;
   /**
    * Checks if the page uses its description as the Open Graph description.
    * @example
@@ -239,13 +239,13 @@ interface Page {
   getOpenGraphDescription(): Promise<string>;
   /**
    * Sets the Open Graph (OG) description of the page to the provided value.
-   * @param description - The new OG description to set for the page.
+   * @param description - The new OG description to set for the page. Passing null will unset the current value.
    * @example
    * ```ts
    * myPage.setOpenGraphDescription("New OG Description");
    * ```
    */
-  setOpenGraphDescription(description: string): Promise<null>;
+  setOpenGraphDescription(description: string | null): Promise<null>;
   /**
    * Retrieves the URL of the Open Graph (OG) image associated with the page.
    * @example
@@ -257,13 +257,13 @@ interface Page {
   getOpenGraphImage(): Promise<null | string>;
   /**
    * Sets the URL of the Open Graph (OG) image associated with the page.
-   * @param url - The new URL of the OG image to set for the page.
+   * @param url - The new URL of the OG image to set for the page. Passing null will unset the current value.
    * @example
    * ```ts
    * myPage.setOpenGraphImage("https://example.com/image.jpg");
    * ```
    */
-  setOpenGraphImage(url: string): Promise<null>;
+  setOpenGraphImage(url: string | null): Promise<null>;
   /**
    * Checks if the page is excluded from search engine indexing.
    * @example
@@ -311,13 +311,13 @@ interface Page {
   getSearchTitle(): Promise<string>;
   /**
    * Sets the search engine title of the page to the provided value.
-   * @param title - The new search engine title to set for the page.
+   * @param title - The new search engine title to set for the page. Passing null will unset the current value.
    * @example
    * ```ts
    * myPage.setSearchTitle("New Search Engine Title");
    * ```
    */
-  setSearchTitle(title: string): Promise<null>;
+  setSearchTitle(title: string | null): Promise<null>;
   /**
    * Checks if the page uses its description as the search engine description.
    * @example
@@ -347,13 +347,13 @@ interface Page {
   getSearchDescription(): Promise<string>;
   /**
    * Sets the search engine description of the page to the provided value.
-   * @param description - The new search engine description to set for the page.
+   * @param description - The new search engine description to set for the page. Passing null will unset the current value.
    * @example
    * ```ts
    * myPage.setSearchDescription("New Search Engine Description");
    * ```
    */
-  setSearchDescription(description: string): Promise<null>;
+  setSearchDescription(description: string | null): Promise<null>;
   /**
    * Checks if the page uses its Open Graph (OG) image as the search engine image.
    * @example
@@ -382,13 +382,13 @@ interface Page {
   getSearchImage(): Promise<string>;
   /**
    * Sets the search engine image URL of the page.
-   * @param url - The new search engine image URL to set for the page.
+   * @param url - The new search engine image URL to set for the page. Passing null will unset the current value.
    * @example
    * ```ts
    * myPage.setSearchImage("https://example.com/image.jpg");
    * ```
    */
-  setSearchImage(url: string): Promise<null>;
+  setSearchImage(url: string | null): Promise<null>;
   /**
    * Checks if the page is password-protected.
    * @example

package/variables.d.ts

@@ -30,6 +30,7 @@ interface ColorVariable {
    * @returns A Promise that resolves into a value, or if the variable is an alias - the original Variable.
    * @example
    * ```ts
+   * const collection = await webflow.getDefaultVariableCollection();
    * const newVariable1 = await collection.createColorVariable('myvar4', 'red');
    * await newVariable1.set('yellow');
    * ```
@@ -151,7 +152,7 @@ interface NumberVariable {
    * @returns A Promise that resolves once the value is successfully set.
    * @example
    * ```ts
-   * const newVariable = await collection.createNumberVariable('myvar1', 100});
+   * const newVariable = await collection.createNumberVariable('myvar1', 100);
    * await newVariable.set(200);
    * ```
    */
@@ -335,6 +336,17 @@ interface VariableCollection {
     name: string,
     value: string | FontFamilyVariable
   ): Promise<FontFamilyVariable>;
+  /**
+   * Sets the name of the variable collection.
+   * @param newName - The desired name of the variable collection.
+   * @returns A Promise that resolves once the name is successfully set.
+   * @example
+   * ```ts
+   * const collection = await webflow.createVariableCollection('My Collection');
+   * await collection.setName('My New Collection');
+   * ```
+   */
+  setName(newName: string): Promise<null>;
 }
 
 type VariableCollectionId = string;