webflow-api 1.1.2 → 1.2.0

package/src/api/site.ts

@@ -1,4 +1,6 @@
-import { Client, QueryString, requireArgs } from "../core";
+import { AxiosInstance } from "axios";
+import { Webhook, Collection, WebhookFilter } from ".";
+import { requireArgs, WebflowRecord } from "../core";
 
 /**************************************************************
  * Interfaces
@@ -24,63 +26,164 @@ export interface IPublishSite {
 }
 
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
 
-/**
- * Get a list of Sites
- * @param client The Webflow client
- * @param params The query string parameters (optional)
- * @returns
- */
-export function list(client: Client, params?: QueryString) {
-  const path = "/sites";
-  return client.get<ISite[]>(path, { params });
-}
+export class Site extends WebflowRecord<ISite> implements ISite {
+  lastPublished: string;
+  previewUrl: string;
+  createdOn: string;
+  shortName: string;
+  timezone: string;
+  database: string;
+  name: string;
+  _id: string;
 
-/**
- * Get a single Site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.params The query string parameters (optional)
- * @returns A single Site
- */
-export function getOne(
-  client: Client,
-  { siteId, params }: { siteId: string; params?: QueryString }
-) {
-  requireArgs({ siteId });
-  const path = `/sites/${siteId}`;
-  return client.get<ISite>(path, { params });
-}
+  /**
+   * Get a list of Sites
+   * @param client The Axios client instance
+   * @returns a list of Sites
+   */
+  static list(client: AxiosInstance) {
+    const path = "/sites";
+    return client.get<ISite[]>(path);
+  }
 
-/**
- * Publish a site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.domains The domains to publish to
- * @returns The publish result
- */
-export function publish(
-  client: Client,
-  { siteId, domains }: { siteId: string; domains: string[] }
-) {
-  requireArgs({ siteId, domains });
-  const path = `/sites/${siteId}/publish`;
-  return client.post<IPublishSite>(path, { domains });
-}
+  /**
+   * Get a single Site
+   * @param params The params for the request
+   * @param params.siteId The site ID
+   * @param params.params The query string parameters (optional)
+   * @param client The Axios client instance
+   * @returns A single Site
+   */
+  static getOne({ siteId }: { siteId: string }, client: AxiosInstance) {
+    requireArgs({ siteId });
+    const path = `/sites/${siteId}`;
+    return client.get<ISite>(path);
+  }
+
+  /**
+   * Publish a site
+   * @param params The params for the request
+   * @param params.siteId The site ID
+   * @param params.domains The domains to publish to
+   * @param client The Axios client instance
+   * @returns The publish result
+   */
+  static publish({ siteId, domains }: { siteId: string; domains: string[] }, client: AxiosInstance) {
+    requireArgs({ siteId, domains });
+    const path = `/sites/${siteId}/publish`;
+    return client.post<IPublishSite>(path, { domains });
+  }
+
+  /**
+   * Get a list of domains for a site
+   * @param params The params for the request
+   * @param params.siteId The site ID
+   * @param client The Axios client instance
+   * @returns A list of domains
+   */
+  static domains({ siteId }: { siteId: string }, client: AxiosInstance) {
+    requireArgs({ siteId });
+    const path = `/sites/${siteId}/domains`;
+    return client.get<IDomain[]>(path);
+  }
+
+  /**************************************************************
+   * Instance Methods
+   **************************************************************/
+
+  /**
+   * Get a list of domains for a site
+   * @returns A list of domains
+   */
+  async domains() {
+    const res = await Site.domains({ siteId: this._id }, this.client);
+    return res.data;
+  }
+
+  /**
+   * Publish a site
+   * @param domains The domains to publish to
+   * @returns The publish result
+   */
+  async publishSite(domains: string[]) {
+    const res = await Site.publish({ siteId: this._id, domains }, this.client);
+    return res.data;
+  }
+
+  /**
+   * Get a single Collection
+   * @param params The params for the request
+   * @param params.collectionId The collection ID
+   * @returns A single Collection
+   */
+  async collection({ collectionId }: { collectionId: string }) {
+    const res = await Collection.getOne({ collectionId }, this.client);
+    return new Collection(this.client, res);
+  }
+
+  /**
+   * Get a list of Collections
+   * @returns A list of Collections
+   */
+  async collections() {
+    const res = await Collection.list({ siteId: this._id }, this.client);
+    return res.data.map((data) => new Collection(this.client, { ...res, data }));
+  }
+
+  /**
+   * Get a single Webhook
+   * @param params The params for the request
+   * @param params.webhookId The webhook ID
+   * @returns A single Webhook
+   */
+  async webhook({ webhookId }: { webhookId: string }) {
+    const res = await Webhook.getOne({ siteId: this._id, webhookId }, this.client);
+    return new Webhook(this.client, res);
+  }
+
+  /**
+   * Get a list of Webhooks
+   * @returns A list of Webhooks
+   */
+  async webhooks() {
+    const res = await Webhook.list({ siteId: this._id }, this.client);
+    return res.data.map((data) => new Webhook(this.client, { ...res, data }));
+  }
+
+  /**
+   * Remove a Webhook
+   * @param params The query string parameters (optional)
+   * @param params.webhookId The Webhook ID
+   * @returns The result of the removal
+   */
+  async removeWebhook({ webhookId }: { webhookId: string }) {
+    const res = await Webhook.remove({ siteId: this._id, webhookId }, this.client);
+    return res.data;
+  }
 
-/**
- * Get a list of domains for a site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @returns A list of domains
- */
-export function domains(client: Client, { siteId }: { siteId: string }) {
-  requireArgs({ siteId });
-  const path = `/sites/${siteId}/domains`;
-  return client.get<IDomain[]>(path);
+  /**
+   * Create a new Webhook
+   * @param params The params for the request
+   * @param params.url The URL to send the webhook to
+   * @param params.triggerType The event to trigger the webhook
+   * @param params.filter The filter to apply to the webhook (optional: form_submission only)
+   * @returns The created webhook
+   */
+  async createWebhook({
+    triggerType,
+    filter,
+    url,
+  }: {
+    url: string;
+    siteId: string;
+    triggerType: string;
+    filter?: WebhookFilter;
+  }) {
+    const _params = { url, siteId: this._id, triggerType, filter };
+    const res = await Webhook.create(_params, this.client);
+    return new Webhook(this.client, res);
+  }
 }

package/src/api/user.ts

@@ -0,0 +1,152 @@
+import { AxiosInstance } from "axios";
+import { PaginatedData, requireArgs, WebflowRecord } from "../core";
+
+/**************************************************************
+ * Interfaces
+ **************************************************************/
+export interface IUser {
+  emailVerified: boolean;
+  lastUpdated?: string;
+  createdOn: string;
+  _id: string;
+  data: any;
+}
+
+export interface IUserDelete {
+  deleted: number;
+}
+
+/**************************************************************
+ * Types
+ **************************************************************/
+export type PaginatedUsers = PaginatedData & {
+  users: IUser[];
+};
+
+export type UserIdParam = { siteId: string; userId: string };
+
+/**************************************************************
+ * Class
+ **************************************************************/
+
+export class User extends WebflowRecord<IUser> implements IUser {
+  emailVerified: boolean;
+  lastUpdated?: string;
+  createdOn: string;
+  siteId: string;
+  _id: string;
+  data: any;
+
+  /**************************************************************
+   * Static Methods
+   **************************************************************/
+
+  /**
+   * Get a list of Users
+   * @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)
+   * @param client The Axios client instance
+   * @returns A list of Users
+   */
+  static list({ siteId, limit, offset }: { siteId: string; limit?: number; offset?: number }, client: AxiosInstance) {
+    requireArgs({ siteId });
+    const params = { limit, offset };
+    const path = `/sites/${siteId}/users`;
+    return client.get<PaginatedUsers>(path, { params });
+  }
+
+  /**
+   * Get a single User
+   * @param params The params for the request
+   * @param params.siteId The site ID
+   * @param params.userId The user ID
+   * @param client The Axios client instance
+   * @returns A single User
+   */
+  static getOne({ siteId, userId }: { siteId: string; userId: string }, client: AxiosInstance) {
+    requireArgs({ siteId, userId });
+    const path = `/sites/${siteId}/users/${userId}`;
+    return client.get<IUser>(path);
+  }
+
+  /**
+   * Update a User
+   * @param params The params for the request
+   * @param params.siteId The site ID
+   * @param params.userId The user ID
+   * @param params.data The data to update
+   * @param client The Axios client instance
+   * @returns The updated User
+   */
+  static update(
+    {
+      siteId,
+      userId,
+      data,
+    }: {
+      data: object;
+      siteId: string;
+      userId: string;
+    },
+    client: AxiosInstance
+  ) {
+    requireArgs({ siteId, userId });
+    const path = `/sites/${siteId}/users/${userId}`;
+    return client.patch<IUser>(path, data);
+  }
+
+  /**
+   * Invite a User to a site
+   * @param params The params for the request
+   * @param params.siteId The site ID
+   * @param params.email The email address of the user to invite
+   * @param client The Axios client instance
+   * @returns The newly created User
+   */
+  static async invite({ siteId, email }: { siteId: string; email: string }, client: AxiosInstance) {
+    requireArgs({ siteId, email });
+    const path = `/sites/${siteId}/users/invite`;
+    return client.post<IUser>(path, { email });
+  }
+
+  /**
+   * Remove a User
+   * @param params The params for the request
+   * @param params.siteId The site ID
+   * @param params.userId The user ID
+   * @param client The Axios client instance
+   * @returns The result of the remove
+   */
+  static remove({ siteId, userId }: { siteId: string; userId: string }, client: AxiosInstance) {
+    requireArgs({ siteId, userId });
+    const path = `/sites/${siteId}/users/${userId}`;
+    return client.delete<IUserDelete>(path);
+  }
+
+  /**************************************************************
+   * Instance Methods
+   **************************************************************/
+
+  /**
+   * Update a User
+   * @param data The data to update
+   * @returns The updated User
+   */
+  async update(data: any) {
+    const params = { siteId: this.siteId, userId: this._id, data };
+    const res = await User.update(params, this.client);
+    return new User(this.client, res);
+  }
+
+  /**
+   * Remove a User
+   * @returns The result of the remove
+   */
+  async remove() {
+    const params = { siteId: this.siteId, userId: this._id };
+    const res = await User.remove(params, this.client);
+    return res.data;
+  }
+}

package/src/api/webhook.ts

@@ -1,4 +1,5 @@
-import { Client, QueryString, requireArgs } from "../core";
+import { AxiosInstance } from "axios";
+import { requireArgs, WebflowRecord } from "../core";
 
 /**************************************************************
  * Types
@@ -14,7 +15,7 @@ export type TriggerType =
   | "collection_item_deleted"
   | string;
 
-export type Filter = {
+export type WebhookFilter = {
   name: string;
 };
 
@@ -38,88 +39,104 @@ export interface IRemoveResult {
 }
 
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
+export class Webhook extends WebflowRecord<IWebhook> implements IWebhook {
+  filter?: { name: string };
+  triggerType: string;
+  triggerId: string;
+  createdOn: string;
+  lastUsed?: string;
+  site: string;
+  _id: string;
 
-/**
- * Get a list of Webhooks
- * @param client The Webflow client
- * @param params1 The params for the request
- * @param params1.siteId The site ID
- * @param params The query string parameters (optional)
- * @returns A list of Webhooks
- */
-export function list(
-  client: Client,
-  { siteId }: { siteId: string },
-  params?: QueryString
-) {
-  requireArgs({ siteId });
-  const path = `/sites/${siteId}/webhooks`;
-  return client.get<IWebhook[]>(path, { params });
-}
+  /**************************************************************
+   * Static Methods
+   **************************************************************/
 
-/**
- * Get a single Webhook
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.webhookId The webhook ID
- * @returns A single Webhook
- */
-export function getOne(
-  client: Client,
-  { siteId, webhookId }: { siteId: string; webhookId: string }
-) {
-  requireArgs({ siteId, webhookId });
-  const path = `/sites/${siteId}/webhooks/${webhookId}`;
-  return client.get<IWebhook>(path);
-}
+  /**
+   * Get a list of Webhooks
+   * @param params The params for the request
+   * @param params.siteId The site ID
+   * @param client The Axios client instance
+   * @returns A list of Webhooks
+   */
+  static list({ siteId }: { siteId: string }, client: AxiosInstance) {
+    requireArgs({ siteId });
+    const path = `/sites/${siteId}/webhooks`;
+    return client.get<IWebhook[]>(path);
+  }
 
-/**
- * Create a new Webhook
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.url The URL to send the webhook to
- * @param params.triggerType The event to trigger the webhook
- * @param params.filter The filter to apply to the webhook (optional: form_submission only)
- * @param params.params The query string parameters (optional)
- * @returns The created webhook
- */
-export function create(
-  client: Client,
-  {
-    triggerType,
-    siteId,
-    filter,
-    url,
-  }: {
-    url: string;
-    siteId: string;
-    filter?: Filter;
-    triggerType: TriggerType;
+  /**
+   * Get a single Webhook
+   * @param params The params for the request
+   * @param params.siteId The site ID
+   * @param params.webhookId The webhook ID
+   * @param client The Axios client instance
+   * @returns A single Webhook
+   */
+  static getOne({ siteId, webhookId }: { siteId: string; webhookId: string }, client: AxiosInstance) {
+    requireArgs({ siteId, webhookId });
+    const path = `/sites/${siteId}/webhooks/${webhookId}`;
+    return client.get<IWebhook>(path);
+  }
+
+  /**
+   * Create a new Webhook
+   * @param params The params for the request
+   * @param params.siteId The site ID
+   * @param params.url The URL to send the webhook to
+   * @param params.triggerType The event to trigger the webhook
+   * @param params.filter The filter to apply to the webhook (optional: form_submission only)
+   * @param params.params The query string parameters (optional)
+   * @param client The Axios client instance
+   * @returns The created webhook
+   */
+  static create(
+    {
+      triggerType,
+      siteId,
+      filter,
+      url,
+    }: {
+      url: string;
+      siteId: string;
+      filter?: WebhookFilter;
+      triggerType: TriggerType;
+    },
+    client: AxiosInstance
+  ) {
+    requireArgs({ siteId, triggerType, url });
+    const path = `/sites/${siteId}/webhooks`;
+    const data = { triggerType, url, filter };
+    return client.post<IWebhook>(path, data);
   }
-) {
-  requireArgs({ siteId, triggerType, url });
-  const path = `/sites/${siteId}/webhooks`;
-  const data = { triggerType, url, filter };
-  return client.post<IWebhook>(path, data);
-}
 
-/**
- * Remove a Webhook
- * @param client The Webflow client
- * @param params The query string parameters (optional)
- * @param params.webhookId The Webhook ID
- * @param params.siteId The Site ID
- * @returns The result of the removal
- */
-export function remove(
-  client: Client,
-  { siteId, webhookId }: { siteId: string; webhookId: string }
-) {
-  requireArgs({ siteId, webhookId });
-  const path = `/sites/${siteId}/webhooks/${webhookId}`;
-  return client.delete<IRemoveResult>(path);
+  /**
+   * Remove a Webhook
+   * @param params The query string parameters (optional)
+   * @param params.webhookId The Webhook ID
+   * @param params.siteId The Site ID
+   * @param client The Axios client instance
+   * @returns The result of the removal
+   */
+  static remove({ siteId, webhookId }: { siteId: string; webhookId: string }, client: AxiosInstance) {
+    requireArgs({ siteId, webhookId });
+    const path = `/sites/${siteId}/webhooks/${webhookId}`;
+    return client.delete<IRemoveResult>(path);
+  }
+
+  /**************************************************************
+   * Instance Methods
+   **************************************************************/
+
+  /**
+   * Remove a Webhook
+   * @returns The result of the removal
+   */
+  async remove() {
+    const params = { siteId: this.site, webhookId: this._id };
+    const res = await Webhook.remove(params, this.client);
+    return res.data;
+  }
 }

package/src/core/error.ts

@@ -1,3 +1,5 @@
+import { AxiosResponse } from "axios";
+
 export interface IRequestError {
   msg: string;
   code: number;
@@ -30,3 +32,9 @@ export function requireArgs(args: object) {
     if (!args[key]) throw new ArgumentError(key);
   }
 }
+
+// throw an error if Webflow error
+export function ErrorInterceptor(res: AxiosResponse) {
+  if (res.data.err) throw new RequestError(res.data);
+  return res;
+}

package/src/core/index.ts

@@ -1,3 +1,3 @@
-export * from "./client";
 export * from "./error";
-export * from "./options";
+export * from "./response";
+export * from "./webflow";

package/src/core/response.ts

@@ -0,0 +1,50 @@
+import { AxiosInstance, AxiosResponse } from "axios";
+
+/**************************************************************
+ * Types
+ **************************************************************/
+export type PaginationFilter = { limit?: number; offset?: number };
+
+export type WebflowHeaders = Record<string, any>;
+
+/**************************************************************
+ * Interfaces
+ ************************************************************* */
+export interface PaginatedData {
+  count: number;
+  limit: number;
+  offset: number;
+  total: number;
+}
+
+export class MetaResponse<T> {
+  rateLimit: {
+    limit: number;
+    remaining: number;
+  };
+
+  constructor(public response: AxiosResponse<T>) {
+    this.rateLimit = {
+      limit: parseInt(response.headers["x-ratelimit-limit"], 10),
+      remaining: parseInt(response.headers["x-ratelimit-remaining"], 10),
+    };
+  }
+}
+
+export class WebflowRecord<T> {
+  response: AxiosResponse<T>;
+  _meta: MetaResponse<T>;
+  client: AxiosInstance;
+
+  constructor(client: AxiosInstance, response: AxiosResponse<any>, record?: T, ...args: any[]) {
+    Object.assign(this, record || response.data, ...args); // Copy the record data
+
+    // dynamically add client and response to object
+    // without serializing during toString()
+    Object.defineProperties(this, {
+      client: { get: () => client },
+      response: { get: () => response },
+      _meta: { get: () => new MetaResponse(response) }, // legacy support
+    });
+  }
+}