@webflow/designer-extension-typings 2.0.7 → 2.0.9

package/api.d.ts

@@ -19,15 +19,35 @@ interface WebflowApi {
    * - siteId: the unique ID of the current Webflow site.
    * - siteName: the name of the current Webflow site.
    * - shortName: a shortened reference to the name of the current Webflow site.
+   * - isPasswordProtected: whether the site is password protected.
+   * - isPrivateStaging: whether the site has private staging turned on or not.
+   * - domains: an array of objects representing the domains associated with the site, each containing the following properties:
+   *   - url: the URL of the domain.
+   *   - lastPublished: the timestamp of the last time the domain was published.
+   *   - default: a boolean indicating whether the domain is the default domain for the site.
+   *   - stage: the target of the publish
    * @example
    * ```ts
    * const siteInfo = await webflow.getSiteInfo();
    * console.log('Site ID:', siteInfo.siteId);
    * console.log('Site Name:', siteInfo.siteName);
    * console.log('Shortened Site Name:', siteInfo.shortName);
-   * ```
-   */
-  getSiteInfo(): Promise<{siteId: string; siteName: string; shortName: string}>;
+   * console.log('Domains:', siteInfo.domains);
+   * ```
+   */
+  getSiteInfo(): Promise<{
+    siteId: string;
+    siteName: string;
+    shortName: string;
+    isPasswordProtected: boolean;
+    isPrivateStaging: boolean;
+    domains: Array<{
+      url: string;
+      lastPublished: string | null;
+      default: boolean;
+      stage: 'staging' | 'production';
+    }>;
+  }>;
   /**
    * Get the currently selected element in the Webflow Designer.
    * @returns A promise that resolves to one of the following:
@@ -290,6 +310,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.7",
+  "version": "2.0.9",
   "license": "SEE LICENSE IN LICENSE",
   "description": "Typings for the Webflow Designer Extension API",
   "main": "",

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;