V1.1.2 (#71)

* cleaned-up tests

* add + corrected membership endpoints

Author: John Agan

README.md

@@ -207,7 +207,10 @@ const updatedItem = await webflow.updateItem({
 
 ### Memberships
 ```javascript
-// Get the all users for a site
+// Get a site's users from the site
+const users = await site.users();
+
+// Get a site's users with a site id
 const users = await webflow.users({
   siteId: "[SITE ID]"
 });
@@ -217,6 +220,14 @@ const user = await site.user({
   siteId: "[SITE ID]",
   userId: "[USER ID]"
 });
+
+// Get a site's access groups
+const accessGroups = await site.accessGroups();
+
+// Get a site's access groups with a site id
+const accessGroups = await webflow.accessGroups({
+  siteId: "[SITE ID]"
+});
 ```
 
 ### Webhooks

package.json

@@ -1,7 +1,7 @@
 {
   "name": "webflow-api",
   "description": "Webflow's official Node.js SDK for Data APIs",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "contributors": [

src/api/item.ts

@@ -1,4 +1,4 @@
-import { Client, PaginatedData, QueryString, requireArgs } from "../core";
+import { Client, PaginatedData, requireArgs } from "../core";
 
 /**************************************************************
  * Interfaces

src/api/membership.ts

@@ -1,4 +1,4 @@
-import { Client, PaginatedData, QueryString, requireArgs } from "../core";
+import { Client, PaginatedData, requireArgs } from "../core";
 
 /**************************************************************
  * Interfaces
@@ -11,6 +11,14 @@ export interface IUser {
   data: any;
 }
 
+export interface IAccessGroup {
+  _id: string;
+  name: string;
+  shortId: string;
+  slug: string;
+  createdOn: string;
+}
+
 export interface IUserDelete {
   deleted: number;
 }
@@ -22,6 +30,10 @@ export type PaginatedUsers = PaginatedData & {
   users: IUser[];
 };
 
+export type PaginatedAccessGroups = PaginatedData & {
+  accessGroups: IAccessGroup[];
+};
+
 export type UserIdParam = { siteId: string; userId: string };
 
 /**************************************************************
@@ -78,9 +90,8 @@ export function update(
   {
     siteId,
     userId,
-    data,
+    ...data
   }: {
-    data: object;
     siteId: string;
     userId: string;
   }
@@ -123,3 +134,22 @@ export function remove(
   const path = `/sites/${siteId}/users/${userId}`;
   return client.delete<IUserDelete>(path);
 }
+
+/**
+ * Get a list of Access Groups
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The Site ID
+ * @param params.limit The number of items to return (optional)
+ * @param params.offset The number of items to skip (optional)
+ * @returns A list of Access Groups
+ */
+export function accessGroups(
+  client: Client,
+  { siteId, limit, offset }: { siteId: string; limit?: number; offset?: number }
+) {
+  requireArgs({ siteId });
+  const params = { limit, offset };
+  const path = `/sites/${siteId}/users/accessgroups`;
+  return client.get<PaginatedAccessGroups>(path, { params });
+}

src/core/client.ts

@@ -17,11 +17,32 @@ export interface PaginatedData {
   total: number;
 }
 
-export interface WebflowOptions {
-  host?: string;
-  token?: string;
-  version?: string;
-  headers?: Record<string, string>;
+/**************************************************************
+ * Functions
+ **************************************************************/
+
+/**
+ * Transforms JSON response to an object
+ * if the response is a Webflow error, it will throw an error
+ * @param data JSON response
+ * @returns response object
+ */
+function transformResponse(data: any = {}) {
+  // parse json if string
+  if (String(data) === data) data = JSON.parse(data);
+
+  // throw an error if Webflow returns an error obejct
+  if (data.err) throw new RequestError(data);
+  return data;
+}
+
+/**
+ * Transforms POST/PUT/PATCH request data to JSON
+ * @param data A JavaScript object
+ * @returns JSON string
+ */
+function transformRequest(data: any = {}) {
+  return JSON.stringify(data);
 }
 
 /**************************************************************
@@ -35,7 +56,8 @@ export class Client extends Axios {
     token,
   }: Options = {}) {
     super({
-      transformRequest: [(data) => JSON.stringify(data)],
+      transformRequest: [transformRequest],
+      transformResponse: [transformResponse],
       baseURL: `https://api.${host}/`,
       headers: {
         "Content-Type": "application/json",
@@ -46,22 +68,6 @@ export class Client extends Axios {
     });
 
     if (token) this.token = token;
-
-    // check for webflow errors
-    this.defaults.transformResponse = [this.transformResponse];
-  }
-
-  /**
-   * Transforms JSON response to an object
-   * if the response is a Webflow error, it will throw an error
-   * @param data JSON response
-   * @returns response object
-   */
-  private transformResponse(data: any = {}) {
-    // parse json if string
-    if (String(data) === data) data = JSON.parse(data);
-    if (data.err) throw new RequestError(data);
-    return data;
   }
 
   // set the Authorization header

src/webflow.ts

@@ -265,7 +265,6 @@ export class Webflow {
    * @param params The Item information
    * @param params.collectionId The Collection ID
    * @param params.itemId The Item ID
-   * @param query The query parameters (optional)
    * @returns The updated Collection Item
    */
   updateItem({
@@ -319,8 +318,7 @@ export class Webflow {
    * @param params The Item information
    * @param params.collectionId The Collection ID
    * @param params.itemId The Item ID
-   * @param query The query parameters (optional)
-   * @param query.live Update the live version
+   * @param params.live Update the live version
    * @returns The unpublished Collection Item result
    */
   deleteItems({
@@ -340,8 +338,7 @@ export class Webflow {
    * @param params The Item information
    * @param params.collectionId The Collection ID
    * @param params.itemId The Item ID
-   * @param query The query parameters (optional)
-   * @param query.live Update the live version
+   * @param params.live Update the live version
    * @returns The Published Collection Item result
    */
   publishItems({
@@ -366,6 +363,8 @@ export class Webflow {
    * @param params The Site information
    * @param params.siteId The Site ID
    * @param pageParams The pagination information (optional)
+   * @param pageParams.limit The number of results to return
+   * @param pageParams.offset The number of results to skip
    * @returns A list of User accounts
    */
   async users({ siteId }: { siteId: string }, pageParams?: PaginationFilter) {
@@ -425,6 +424,16 @@ export class Webflow {
     return MembershipWrapper.remove(this.client, { siteId, userId });
   }
 
+  /**
+   * Get a list of Access Groups
+   * @param params The Site and User information
+   * @param params.siteId The Site ID
+   * @returns The result from the remove request
+   */
+  accessGroups({ siteId }: { siteId: string }) {
+    return MembershipWrapper.accessGroups(this.client, { siteId });
+  }
+
   /**************************************************************
    * Webhook Endpoints
    **************************************************************/

src/wrapper/collection.ts

@@ -1,6 +1,6 @@
 import { ResponseWrapper, ItemWrapper } from ".";
 import { Client, QueryString } from "../core";
-import { Collection, Item } from "../api";
+import { Collection } from "../api";
 
 export class CollectionWrapper implements Collection.ICollection {
   fields: Collection.CollectionField[];

src/wrapper/membership.ts

@@ -71,7 +71,7 @@ export class MembershipWrapper implements Membership.IUser {
     client: Client,
     { userId, siteId, data }: { userId: string; siteId: string; data: any }
   ) {
-    const res = await Membership.update(client, { userId, siteId, data });
+    const res = await Membership.update(client, { userId, siteId, ...data });
     const user = ResponseWrapper<typeof res.data>(res);
     return new MembershipWrapper(client, siteId, user);
   }
@@ -92,6 +92,31 @@ export class MembershipWrapper implements Membership.IUser {
     return ResponseWrapper<typeof res.data>(res);
   }
 
+  /**
+   * Get a list of Access Groups
+   * @param client The Webflow client
+   * @param params The params for the request
+   * @param params.siteId The Site ID
+   * @param params.limit The number of items to return (optional)
+   * @param params.offset The number of items to skip (optional)
+   * @returns A list of Access Groups
+   */
+  static async accessGroups(
+    client: Client,
+    {
+      siteId,
+      limit,
+      offset,
+    }: { siteId: string; limit?: number; offset?: number }
+  ) {
+    const res = await Membership.accessGroups(client, {
+      siteId,
+      limit,
+      offset,
+    });
+    return ResponseWrapper<typeof res.data>(res);
+  }
+
   /**
    * Remove a User
    * @param client The Webflow client

src/wrapper/site.ts

@@ -3,6 +3,7 @@ import {
   CollectionWrapper,
   ResponseWrapper,
   WebhookWrapper,
+  MembershipWrapper,
 } from ".";
 import { Client, QueryString } from "../core";
 import { Site } from "../api";
@@ -161,4 +162,67 @@ export class SiteWrapper implements Site.ISite {
     const _params = { url, siteId: this._id, triggerType, filter };
     return WebhookWrapper.create(this.client, _params);
   }
+
+  /**
+   * Get a list of Users
+   * @param params The params for the request
+   * @param params.limit The number of items to return (optional)
+   * @param params.offset The number of items to skip (optional)
+   * @returns A list of Users
+   */
+  async users({ limit, offset }: { limit?: number; offset?: number } = {}) {
+    return MembershipWrapper.list(this.client, {
+      siteId: this._id,
+      limit,
+      offset,
+    });
+  }
+
+  /**
+   * Get a single User
+   * @param params The params for the request
+   * @param params.userId The user ID
+   * @returns A single User
+   */
+  async user({ userId }: { userId: string }) {
+    return MembershipWrapper.getOne(this.client, { siteId: this._id, userId });
+  }
+
+  /**
+   * Invite a User to a site
+   * @param params The params for the request
+   * @param params.email The email address of the user to invite
+   * @returns The newly created User
+   */
+  async inviteUser({ email }: { email: string }) {
+    return MembershipWrapper.invite(this.client, { siteId: this._id, email });
+  }
+
+  /**
+   * Get a list of Access Groups
+   * @param params The params for the request
+   * @param params.limit The number of items to return (optional)
+   * @param params.offset The number of items to skip (optional)
+   * @returns A list of Access Groups
+   */
+  async accessGroups({
+    limit,
+    offset,
+  }: { limit?: number; offset?: number } = {}) {
+    return MembershipWrapper.accessGroups(this.client, {
+      siteId: this._id,
+      limit,
+      offset,
+    });
+  }
+
+  /**
+   * Remove a User
+   * @param params The params for the request
+   * @param params.userId The user ID
+   * @returns The result of the remove
+   */
+  async removeUser({ userId }: { userId: string }) {
+    return MembershipWrapper.remove(this.client, { siteId: this._id, userId });
+  }
 }

src/wrapper/webhook.ts

@@ -1,5 +1,5 @@
-import { ResponseWrapper } from ".";
 import { Client, QueryString } from "../core";
+import { ResponseWrapper } from ".";
 import { Webhook } from "../api";
 
 export type CreateWebhookParams = {