webflow-api 1.1.2 → 1.2.1

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
+    });
+  }
+}

package/src/{webflow.ts → core/webflow.ts}

@@ -1,32 +1,69 @@
-import { QueryString, Options, Client, PaginationFilter } from "./core";
-import { Meta, OAuth, Webhook } from "./api";
+import axios, { AxiosInstance, AxiosRequestConfig } from "axios";
+import { PaginationFilter, ErrorInterceptor } from "../core";
 import {
-  MembershipWrapper,
-  CollectionWrapper,
-  WebhookWrapper,
-  SiteWrapper,
-  ItemWrapper,
-  ResponseWrapper,
-} from "./wrapper";
+  Collection,
+  IAccessTokenParams,
+  IAuthorizeUrlParams,
+  IRevokeTokenParams,
+  User,
+  Meta,
+  OAuth,
+  Site,
+  Webhook,
+  WebhookFilter,
+  Item,
+} from "../api";
+
+export const DEFAULT_HOST = "webflow.com";
+export const USER_AGENT = "Webflow Javascript SDK / 1.0";
+
+export interface Options {
+  host?: string;
+  token?: string;
+  version?: string;
+  headers?: Record<string, string>;
+}
 
 /**************************************************************
  * Class
  **************************************************************/
 export class Webflow {
-  client: Client;
-
+  private client: AxiosInstance;
   constructor(public options: Options = {}) {
-    this.client = new Client(options);
+    this.client = axios.create(this.config);
+    this.client.interceptors.response.use(ErrorInterceptor);
   }
 
   // Set the Authentication token
   set token(value: string) {
-    this.client.token = value;
+    this.options.token = value;
   }
 
   // clear the Authorization header
   clearToken() {
-    this.client.clearToken();
+    delete this.options.token;
+  }
+
+  // The Axios configuration
+  get config() {
+    const { host = DEFAULT_HOST, token, version, headers } = this.options;
+
+    const config: AxiosRequestConfig = {
+      baseURL: `https://api.${host}/`,
+      headers: {
+        "Content-Type": "application/json",
+        "User-Agent": USER_AGENT,
+        ...headers,
+      },
+    };
+
+    // Add the version to the headers if passed in
+    if (version) config.headers["Accept-Version"] = version;
+
+    // Add the Authorization header if a token is set
+    if (token) config.headers.Authorization = `Bearer ${token}`;
+
+    return config;
   }
 
   /**************************************************************
@@ -39,7 +76,7 @@ export class Webflow {
    * @param params The query parameters (optional)
    * @returns The response from the Webflow API
    */
-  get(path: string, params?: QueryString) {
+  get(path: string, params?: Record<string, any>) {
     return this.client.get(path, { params });
   }
   /**
@@ -48,7 +85,7 @@ export class Webflow {
    * @param params The query parameters (optional)
    * @returns The response from the Webflow API
    */
-  delete(path: string, params?: QueryString) {
+  delete(path: string, params?: Record<string, any>) {
     return this.client.delete(path, { params });
   }
   /**
@@ -58,7 +95,7 @@ export class Webflow {
    * @param params The query parameters (optional)
    * @returns The response from the Webflow API
    */
-  post(path: string, data: any, params?: QueryString) {
+  post(path: string, data: any, params?: Record<string, any>) {
     return this.client.post(path, data, { params });
   }
   /**
@@ -68,7 +105,7 @@ export class Webflow {
    * @param params The query parameters (optional)
    * @returns The response from the Webflow API
    */
-  put(path: string, data: any, params?: QueryString) {
+  put(path: string, data: any, params?: Record<string, any>) {
     return this.client.put(path, data, { params });
   }
   /**
@@ -78,7 +115,7 @@ export class Webflow {
    * @param params The query parameters (optional)
    * @returns The response from the Webflow API
    */
-  patch(path: string, data: any, params?: QueryString) {
+  patch(path: string, data: any, params?: Record<string, any>) {
     return this.client.patch(path, data, { params });
   }
 
@@ -96,8 +133,8 @@ export class Webflow {
    * @param params.response_type The response_type parameter (default: "code")
    * @returns The url to redirect to
    */
-  authorizeUrl(params: OAuth.IAuthorizeUrlParams) {
-    return OAuth.authorizeUrl(this.client, params);
+  authorizeUrl(params: IAuthorizeUrlParams) {
+    return OAuth.authorizeUrl(params, this.client);
   }
   /**
    * Create an OAuth Access Token
@@ -109,9 +146,9 @@ export class Webflow {
    * @param params.grant_type The grant_type parameter (default: "authorization_code")
    * @returns The access token
    */
-  async accessToken(params: OAuth.IAccessTokenParams) {
-    const res = await OAuth.accessToken(this.client, params);
-    return ResponseWrapper<typeof res.data>(res);
+  async accessToken(params: IAccessTokenParams) {
+    const res = await OAuth.accessToken(params, this.client);
+    return res.data;
   }
   /**
    * Revoke an OAuth Access Token
@@ -121,9 +158,9 @@ export class Webflow {
    * @param params.client_secret The client_secret parameter
    * @returns The result of the revoked token
    */
-  async revokeToken(params: OAuth.IRevokeTokenParams) {
-    const res = await OAuth.revokeToken(this.client, params);
-    return ResponseWrapper<typeof res.data>(res);
+  async revokeToken(params: IRevokeTokenParams) {
+    const res = await OAuth.revokeToken(params, this.client);
+    return res.data;
   }
 
   /**************************************************************
@@ -136,7 +173,7 @@ export class Webflow {
    */
   async info() {
     const res = await Meta.info(this.client);
-    return ResponseWrapper<typeof res.data>(res);
+    return res.data;
   }
   /**
    * Get the current authenticated user
@@ -144,7 +181,7 @@ export class Webflow {
    */
   async authenticatedUser() {
     const res = await Meta.user(this.client);
-    return ResponseWrapper<typeof res.data>(res);
+    return res.data;
   }
 
   /**************************************************************
@@ -153,11 +190,11 @@ export class Webflow {
 
   /**
    * Get a list of Sites available
-   * @param query The query parameters (optional)
    * @returns A list of Sites
    */
-  async sites(query?: QueryString) {
-    return SiteWrapper.list(this.client, query);
+  async sites() {
+    const res = await Site.list(this.client);
+    return res.data.map((data) => new Site(this.client, { ...res, data }));
   }
   /**
    * Get a single Site
@@ -166,7 +203,8 @@ export class Webflow {
    * @returns The Site
    */
   async site({ siteId }: { siteId: string }) {
-    return SiteWrapper.getOne(this.client, { siteId });
+    const res = await Site.getOne({ siteId }, this.client);
+    return new Site(this.client, res);
   }
   /**
    * Publish a Site
@@ -175,8 +213,9 @@ export class Webflow {
    * @param params.domain The domains to publish
    * @returns The result of the publish
    */
-  publishSite({ siteId, domains }: { siteId: string } & { domains: string[] }) {
-    return SiteWrapper.publish(this.client, { siteId, domains });
+  async publishSite({ siteId, domains }: { siteId: string } & { domains: string[] }) {
+    const res = await Site.publish({ siteId, domains }, this.client);
+    return res.data;
   }
   /**
    * Get a list of Domains for a Site
@@ -185,7 +224,8 @@ export class Webflow {
    * @returns A list of Domains
    */
   async domains({ siteId }: { siteId: string }) {
-    return SiteWrapper.domains(this.client, { siteId });
+    const res = await Site.domains({ siteId }, this.client);
+    return res.data;
   }
 
   /**************************************************************
@@ -196,11 +236,11 @@ export class Webflow {
    * Get a list of Collections
    * @param params The Site information
    * @param params.siteId The Site ID
-   * @param query The query parameters (optional)
    * @returns A list of Collections
    */
-  async collections({ siteId }: { siteId: string }, query?: QueryString) {
-    return CollectionWrapper.list(this.client, { siteId }, query);
+  async collections({ siteId }: { siteId: string }) {
+    const res = await Collection.list({ siteId }, this.client);
+    return res.data.map((data) => new Collection(this.client, { ...res, data }));
   }
   /**
    * Get a single Collection
@@ -209,7 +249,8 @@ export class Webflow {
    * @returns A single Collection
    */
   async collection({ collectionId }: { collectionId: string }) {
-    return CollectionWrapper.getOne(this.client, { collectionId });
+    const res = await Collection.getOne({ collectionId }, this.client);
+    return new Collection(this.client, res);
   }
 
   /**************************************************************
@@ -220,14 +261,13 @@ export class Webflow {
    * Get a list of Collection Items
    * @param params The Collection information
    * @param params.collectionId The Collection ID
-   * @param pageParams The pagination parameters (optional)
+   * @param params.limit The number of items to return
+   * @param params.offset The number of items to skip
    * @returns A list of Items
    */
-  async items(
-    { collectionId }: { collectionId: string },
-    pageParams?: PaginationFilter
-  ) {
-    return ItemWrapper.list(this.client, { collectionId, ...pageParams });
+  async items({ collectionId, limit, offset }: { collectionId: string } & PaginationFilter) {
+    const res = await Item.list({ collectionId, limit, offset }, this.client);
+    return res.data.items.map((data) => new Item(this.client, { ...res, data }));
   }
   /**
    * Get a single Collection Item
@@ -236,14 +276,10 @@ export class Webflow {
    * @param params.itemId The Item ID
    * @returns A single Collection Item
    */
-  async item({
-    itemId,
-    collectionId,
-  }: {
-    itemId: string;
-    collectionId: string;
-  }) {
-    return ItemWrapper.getOne(this.client, { itemId, collectionId });
+  async item({ itemId, collectionId }: { itemId: string; collectionId: string }) {
+    const res = await Item.getOne({ itemId, collectionId }, this.client);
+    const [item] = res.data.items.map((data) => new Item(this.client, { ...res, data }));
+    return item;
   }
   /**
    * Create a new Collection Item
@@ -251,51 +287,34 @@ export class Webflow {
    * @param params.collectionId The Collection ID
    * @returns The created Collection Item
    */
-  async createItem({
-    collectionId,
-    fields,
-  }: {
-    collectionId: string;
-    fields: any;
-  }) {
-    return ItemWrapper.create(this.client, { collectionId, fields });
+  async createItem({ collectionId, fields }: { collectionId: string; fields: any }) {
+    const res = await Item.create({ collectionId, fields }, this.client);
+    return new Item(this.client, res);
   }
   /**
    * Update a Collection Item
    * @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({
-    collectionId,
-    itemId,
-    ...fields
-  }: {
-    itemId: string;
-    collectionId: string;
-  }) {
+  async updateItem({ collectionId, itemId, ...fields }: { itemId: string; collectionId: string }) {
     const _params = { collectionId, itemId, fields };
-    return ItemWrapper.update(this.client, _params);
+    const res = await Item.update(_params, this.client);
+    return new Item(this.client, res);
   }
   /**
    * Patch a Collection Item
    * @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 patched Collection Item
    */
-  patchItem(
-    {
-      collectionId,
-      itemId,
-      ...fields
-    }: { collectionId: string; itemId: string },
-    query?: QueryString
-  ) {
+  async patchItem({ collectionId, itemId, ...fields }: { collectionId: string; itemId: string }) {
     const _params = { collectionId, itemId, fields };
-    return ItemWrapper.patch(this.client, _params, query);
+    const res = await Item.patch(_params, this.client);
+    return new Item(this.client, res);
   }
   /**
    * Delete a Collection Item
@@ -304,14 +323,9 @@ export class Webflow {
    * @param params.itemId The Item ID
    * @returns The deleted Collection Item result
    */
-  removeItem({
-    collectionId,
-    itemId,
-  }: {
-    itemId: string;
-    collectionId: string;
-  }) {
-    return ItemWrapper.remove(this.client, { collectionId, itemId });
+  async removeItem({ collectionId, itemId }: { itemId: string; collectionId: string }) {
+    const res = await Item.remove({ collectionId, itemId }, this.client);
+    return res.data;
   }
   /**
    * Upublish a Collection Item
@@ -321,7 +335,7 @@ export class Webflow {
    * @param params.live Update the live version
    * @returns The unpublished Collection Item result
    */
-  deleteItems({
+  async deleteItems({
     collectionId,
     itemIds,
     live,
@@ -330,8 +344,8 @@ export class Webflow {
     itemIds: string[];
     live?: boolean;
   }) {
-    const params = { collectionId, itemIds, live };
-    return ItemWrapper.unpublish(this.client, params);
+    const res = await Item.unpublish({ collectionId, itemIds, live }, this.client);
+    return res.data;
   }
   /**
    * Publish a Collection Item
@@ -341,7 +355,7 @@ export class Webflow {
    * @param params.live Update the live version
    * @returns The Published Collection Item result
    */
-  publishItems({
+  async publishItems({
     collectionId,
     itemIds,
     live,
@@ -350,8 +364,8 @@ export class Webflow {
     itemIds: string[];
     live?: boolean;
   }) {
-    const params = { collectionId, itemIds, live };
-    return ItemWrapper.publish(this.client, params);
+    const res = await Item.publish({ collectionId, itemIds, live }, this.client);
+    return res.data;
   }
 
   /**************************************************************
@@ -363,12 +377,11 @@ 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) {
-    return MembershipWrapper.list(this.client, { siteId, ...pageParams });
+    const res = await User.list({ siteId, ...pageParams }, this.client);
+    return res.data.users.map((data) => new User(this.client, { ...res, data }));
   }
 
   /**
@@ -379,7 +392,8 @@ export class Webflow {
    * @returns The User information
    */
   async user({ siteId, userId }: { siteId: string; userId: string }) {
-    return MembershipWrapper.getOne(this.client, { siteId, userId });
+    const res = await User.getOne({ siteId, userId }, this.client);
+    return new User(this.client, res, res.data, { siteId });
   }
 
   /**
@@ -389,17 +403,10 @@ export class Webflow {
    * @param params.userId The User ID
    * @returns The updated User
    */
-  async updateUser({
-    siteId,
-    userId,
-    ...data
-  }: {
-    siteId: string;
-    userId: string;
-    data: any;
-  }) {
+  async updateUser({ siteId, userId, ...data }: { siteId: string; userId: string; data: any }) {
     const _params = { siteId, userId, data };
-    return MembershipWrapper.update(this.client, _params);
+    const res = await User.update(_params, this.client);
+    return new User(this.client, res, res.data, { siteId });
   }
 
   /**
@@ -410,7 +417,8 @@ export class Webflow {
    * @returns The created User account
    */
   async inviteUser({ siteId, email }: { siteId: string; email: string }) {
-    return MembershipWrapper.invite(this.client, { siteId, email });
+    const res = await User.invite({ siteId, email }, this.client);
+    return new User(this.client, res, res.data, { siteId });
   }
 
   /**
@@ -420,18 +428,34 @@ export class Webflow {
    * @param params.userId The User ID
    * @returns The result from the remove request
    */
-  removeUser({ siteId, userId }: { siteId: string; userId: string }) {
-    return MembershipWrapper.remove(this.client, { siteId, userId });
+  async removeUser({ siteId, userId }: { siteId: string; userId: string }) {
+    const res = await User.remove({ siteId, userId }, this.client);
+    return res.data;
   }
 
   /**
-   * 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
+   * Get a list of User Access Groups
+   * @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 params.sort The sort order of the groups (optional)
+   * @returns A list of Access Groups
    */
-  accessGroups({ siteId }: { siteId: string }) {
-    return MembershipWrapper.accessGroups(this.client, { siteId });
+  async accessGroups({
+    siteId,
+    limit,
+    offset,
+    sort,
+  }: {
+    siteId: string;
+    limit?: number;
+    offset?: number;
+    sort?: string;
+  }) {
+    const params = { siteId, limit, offset, sort };
+    const res = await User.accessGroups(params, this.client);
+    return res.data;
   }
 
   /**************************************************************
@@ -444,8 +468,9 @@ export class Webflow {
    * @param params.siteId The Site ID
    * @returns A list of Webhooks
    */
-  async webhooks({ siteId }: { siteId: string }, query?: QueryString) {
-    return WebhookWrapper.list(this.client, { siteId }, query);
+  async webhooks({ siteId }: { siteId: string }) {
+    const res = await Webhook.list({ siteId }, this.client);
+    return res.data.map((data) => new Webhook(this.client, { ...res, data }));
   }
 
   /**
@@ -456,7 +481,8 @@ export class Webflow {
    * @returns The Webhook
    */
   async webhook({ siteId, webhookId }: { siteId: string; webhookId: string }) {
-    return WebhookWrapper.getOne(this.client, { siteId, webhookId });
+    const res = await Webhook.getOne({ siteId, webhookId }, this.client);
+    return new Webhook(this.client, res);
   }
 
   /**
@@ -466,8 +492,9 @@ export class Webflow {
    * @param params.webhookId The Webhook Id
    * @returns the result from the remove request
    */
-  removeWebhook({ siteId, webhookId }: { siteId: string; webhookId: string }) {
-    return WebhookWrapper.remove(this.client, { siteId, webhookId });
+  async removeWebhook({ siteId, webhookId }: { siteId: string; webhookId: string }) {
+    const res = await Webhook.remove({ siteId, webhookId }, this.client);
+    return res.data;
   }
 
   /**
@@ -488,9 +515,10 @@ export class Webflow {
     url: string;
     siteId: string;
     triggerType: string;
-    filter?: Webhook.Filter;
+    filter?: WebhookFilter;
   }) {
     const _params = { url, siteId, triggerType, filter };
-    return WebhookWrapper.create(this.client, _params);
+    const res = await Webhook.create(_params, this.client);
+    return new Webhook(this.client, res);
   }
 }

package/src/index.ts

@@ -1,3 +1,3 @@
-import { Webflow } from "./webflow";
+import { Webflow } from "./core";
 
 export = Webflow;

package/yarn.lock

@@ -654,11 +654,6 @@
   dependencies:
     "@types/node" "*"
 
-"@types/isomorphic-fetch@^0.0.36":
-  "integrity" "sha512-ulw4d+vW1HKn4oErSmNN2HYEcHGq0N1C5exlrMM0CRqX1UUpFhGb5lwiom5j9KN3LBJJDLRmYIZz1ghm7FIzZw=="
-  "resolved" "https://registry.npmjs.org/@types/isomorphic-fetch/-/isomorphic-fetch-0.0.36.tgz"
-  "version" "0.0.36"
-
 "@types/istanbul-lib-coverage@*", "@types/istanbul-lib-coverage@^2.0.0", "@types/istanbul-lib-coverage@^2.0.1":
   "integrity" "sha512-z/QT1XN4K4KYuslS23k62yDIDLwLFkzxOuMplDtObz0+y7VqJCaO2o+SPwHCvLFZh7xazvvoor2tA/hPz9ee7g=="
   "resolved" "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.4.tgz"
@@ -678,10 +673,10 @@
   dependencies:
     "@types/istanbul-lib-report" "*"
 
-"@types/jest@^29.2.1":
-  "integrity" "sha512-nKixEdnGDqFOZkMTF74avFNr3yRqB1ZJ6sRZv5/28D5x2oLN14KApv7F9mfDT/vUic0L3tRCsh3XWpWjtJisUQ=="
-  "resolved" "https://registry.npmjs.org/@types/jest/-/jest-29.2.1.tgz"
-  "version" "29.2.1"
+"@types/jest@^29.2.3":
+  "integrity" "sha512-6XwoEbmatfyoCjWRX7z0fKMmgYKe9+/HrviJ5k0X/tjJWHGAezZOfYaxqQKuzG/TvQyr+ktjm4jgbk0s4/oF2w=="
+  "resolved" "https://registry.npmjs.org/@types/jest/-/jest-29.2.3.tgz"
+  "version" "29.2.3"
   dependencies:
     "expect" "^29.0.0"
     "pretty-format" "^29.0.0"