webflow-api 0.8.1 → 1.0.0

package/README.md

@@ -1,39 +1,244 @@
 # Webflow CMS API Client
 
-## Requirements
-
-* Node.js 4+
-* NPM / YARN
-* Webpack / Browserify (optional)
-
 ## Installation
 
-Install the package via NPM or YARN:
+Using npm:
 
 ```shell
-$ npm install --save webflow-api
+$ npm install webflow-api
+```
 
+using yarn
+```
 $ yarn add webflow-api
 ```
 
 ## Usage
+The constructor takes in a few optional parameters to initialize the API client
+
+* `token` - the access token to use
+* `headers` - additional headers to add to the request
+* `version` - the version of the API you wish to use
+* `mode` - the [sec-fetch-mode](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-Fetch-Mode) to use
+
+``` javascript
+const Webflow = require("webflow-api");
+
+// initialize the client with the access token
+const webflow = new Webflow({ token: "[ACCESS TOKEN]" });
+
+// fully loaded
+const webflow = new Webflow({
+  token: "[ACCESS TOKEN]"
+  version: "1.0.0",
+  mode: "cors",
+  headers: {
+    "User-Agent": "My Webflow App / 1.0"
+  }
+});
+```
+## Basic Usage
+### Chaining Calls
+You can retrieve child resources by chaining calls on the parent object.
+
+```javascript
+// get the first site
+const [site] = await webflow.sites();
+
+// get the first collection in the site
+const [collection] = await site.collections();
+
+// get the first item in the collection
+const [item] = await collection.items();
+
+// get one item from the collection
+const item = await collection.items({ itemId: "[ITEM ID]" });
+```
+
+### Pagination
+To paginate results, pass in the `limit` and `offset` options.
+
+```javascript
+// Get the first page of results
+const page1 = await collection.items({ limit: 20 });
+
+// Get the second page of results
+const page2 = await collection.items({ limit: 20, offset: 20 });
+```
+
+### Rate Limit
+Check rate limit status on each call by checking the `_meta` property.
+
+```javascript
+// make an api call
+const site = await webflow.site({ siteId: "[SITE ID]" });
+
+// check rate limit
+const { rateLimit } = site._meta; // { limit: 60, remaining: 56 }
+```
+### Update Token
+If you need to update the access token, you can set the `token` property at any time.
+
+```javascript
+// token is unset
+const webflow = new Webflow();
+
+// set token
+webflow.token = "[ACCESS TOKEN]";
+```
+### Calling APIs Directly
+All Webflow API endpoints can be called directly using the `get`, `post`, `put`, and `delete` methods.
 
 ```javascript
-const Webflow = require('webflow-api');
+// call the sites endpoint directly
+const sites = await webflow.get("/sites");
+
+// post to an endpoint directly
+const result = await webflow.post("/sites/[SITE ID]/publish", {
+  domains: ["hello-webflow.com"]
+});
+```
+
+## OAuth
+To implement OAuth, you'll need a Webflow App registered and a webserver running, that is publicly facing.
 
-// Initialize the API
-const api = new Webflow({ token: 'api-token' });
+### Authorize
+The first step in OAuth is to generate an authorization url to redirect the user to.
 
-// Fetch a site
-api.site({ siteId: '580e63e98c9a982ac9b8b741' }).then(site => console.log(site));
+```javascript
+// Get the authorization url to redirect users to
+const url = webflow.authorizeUrl({
+  client_id: "[CLIENT ID]",
+  state: "1234567890", // optional
+  redirect_uri: "https://my.server.com/oauth/callback" // optional
+});
+
+// redirect user from your server route
+res.redirect(url);
 ```
 
-The `Webflow` constructor takes several options to initialize the API client:
+### Access Token
+Once a user has authorized their Webflow resource(s), Webflow will redirect back to your server with a `code`. Use this to get an access token.
+
+```javascript
+const auth = await webflow.accessToken({
+  client_id,
+  client_secret,
+  code,
+  redirect_uri // optional - required if used in the authorize step
+});
+
+// you now have the user's access token to make API requests with
+const userWF = new Webflow({ token: auth.access_token });
+
+// pull information for the installer
+const installer = await userWF.installer();
+```
 
-* `token` - the API token **(required)**
-* `version` - the version of the API you wish to use (optional)
+### Revoke Token
+If the user decides to disconnect from your server, you should call revoke token to remove the authorization.
+
+```javascript
+const result = await webflow.revokeToken({
+  client_id,
+  client_secret,
+  access_token
+});
+
+// ensure it went through
+if (result.didRevoke) {
+  // should equal true
+}
+```
+
+## Examples
+### Sites
+Get all sites available or lookup by site id.
+
+```javascript
+// List all sites
+const sites = await webflow.sites();
+
+// Get a single site
+const site = await webflow.sites({ siteId: "[SITE ID]" });
+```
+
+### Collections
+Get all collections available for a site or lookup by collection id.
+```javascript
+// Get a site's collection from the site
+const collections = await site.collections();
+
+// Get a site's collection by passing in a site id
+const collections = await webflow.collections({ siteId: "[SITE ID]" });
+
+// Get a single collection
+const collection = await webflow.collection({ collectionId: "[COLLECTION ID]" });
+```
+
+### Collection Items
+Get all collection items available for a collection or lookup by item id.
+```javascript
+// Get the items from a collection
+const items = await collection.items();
+
+// Get a subset of items
+const items = await collection.items({ limit: 10, offset: 2 });
+
+// Get a single item
+const item = await webflow.item({ collectionId: "[COLLECTION ID]", itemId: "[ITEM ID]" });
+```
+### Update an Item
+```javascript
+// Set the fields to update
+const fields = {
+  name: "New Name",
+  _archived: false,
+  _draft: false,
+  slug: "new-name",
+};
+
+// call update
+const updatedItem = await webflow.updateItem({
+  collectionId: "[COLLECTION ID]",
+  itemId: "[ITEM ID]",
+  fields,
+});
+```
+
+### Memberships
+```javascript
+// Get the all users for a site
+const users = await webflow.users({
+  siteId: "[SITE ID]"
+});
+
+// Get a single user
+const user = await site.user({
+  siteId: "[SITE ID]",
+  userId: "[USER ID]"
+});
+```
+
+### Webhooks
+```javascript
+// get webhooks for a site
+const webhooks = await site.webhooks();
+
+// create a webhook
+const webhook = await site.createWebhook({
+  triggerType: "form_submission",
+  url: "https://webhook.site"
+});
+
+```
+
+### Installer
+```javascript
+// pull information for the installer
+const installer = await webflow.installer();
+```
 
-All of the API methods are documented in the [API documentation](https://developers.webflow.com).
 
 ## Contributing
 

package/dist/ResponseWrapper.js

@@ -3,202 +3,133 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports["default"] = void 0;
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-
-var ResponseWrapper = /*#__PURE__*/function () {
-  function ResponseWrapper(api) {
-    _classCallCheck(this, ResponseWrapper);
-
+exports.default = void 0;
+class ResponseWrapper {
+  constructor(api) {
     this.api = api;
   }
-
-  _createClass(ResponseWrapper, [{
-    key: "site",
-    value: function site(_site) {
-      return _objectSpread(_objectSpread({}, _site), {}, {
-        collections: this.api.collections.bind(this.api, {
-          siteId: _site._id
-        }),
-        webhooks: this.api.webhooks.bind(this.api, {
-          siteId: _site._id
-        }),
-        domains: this.api.domains.bind(this.api, {
-          siteId: _site._id
-        }),
-        webhook: function webhook(first) {
-          var _this$api;
-
-          for (var _len = arguments.length, rest = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
-            rest[_key - 1] = arguments[_key];
-          }
-
-          return (_this$api = this.api).webhook.apply(_this$api, [_objectSpread(_objectSpread({}, first), {}, {
-            siteId: _site._id
-          })].concat(rest));
-        },
-        createWebhook: function createWebhook(first) {
-          var _this$api2;
-
-          for (var _len2 = arguments.length, rest = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
-            rest[_key2 - 1] = arguments[_key2];
-          }
-
-          return (_this$api2 = this.api).createWebhook.apply(_this$api2, [_objectSpread(_objectSpread({}, first), {}, {
-            siteId: _site._id
-          })].concat(rest));
-        },
-        removeWebhook: function removeWebhook(first) {
-          var _this$api3;
-
-          for (var _len3 = arguments.length, rest = new Array(_len3 > 1 ? _len3 - 1 : 0), _key3 = 1; _key3 < _len3; _key3++) {
-            rest[_key3 - 1] = arguments[_key3];
-          }
-
-          return (_this$api3 = this.api).removeWebhook.apply(_this$api3, [_objectSpread(_objectSpread({}, first), {}, {
-            siteId: _site._id
-          })].concat(rest));
-        },
-        publishSite: function publishSite(domains) {
-          return this.api.publishSite({
-            siteId: _site._id,
-            domains: domains
-          });
-        }
-      });
-    }
-  }, {
-    key: "domain",
-    value: function domain(_domain) {
-      return _objectSpread({}, _domain);
-    }
-  }, {
-    key: "collection",
-    value: function collection(_collection) {
-      return _objectSpread(_objectSpread({}, _collection), {}, {
-        items: this.api.items.bind(this.api, {
-          collectionId: _collection._id
-        }),
-        item: function item(first) {
-          var _this$api4;
-
-          for (var _len4 = arguments.length, rest = new Array(_len4 > 1 ? _len4 - 1 : 0), _key4 = 1; _key4 < _len4; _key4++) {
-            rest[_key4 - 1] = arguments[_key4];
-          }
-
-          return (_this$api4 = this.api).item.apply(_this$api4, [_objectSpread(_objectSpread({}, first), {}, {
-            collectionId: _collection._id
-          })].concat(rest));
-        },
-        createItem: function createItem(first) {
-          var _this$api5;
-
-          for (var _len5 = arguments.length, rest = new Array(_len5 > 1 ? _len5 - 1 : 0), _key5 = 1; _key5 < _len5; _key5++) {
-            rest[_key5 - 1] = arguments[_key5];
-          }
-
-          return (_this$api5 = this.api).createItem.apply(_this$api5, [_objectSpread(_objectSpread({}, first), {}, {
-            collectionId: _collection._id
-          })].concat(rest));
-        },
-        updateItem: function updateItem(first) {
-          var _this$api6;
-
-          for (var _len6 = arguments.length, rest = new Array(_len6 > 1 ? _len6 - 1 : 0), _key6 = 1; _key6 < _len6; _key6++) {
-            rest[_key6 - 1] = arguments[_key6];
-          }
-
-          return (_this$api6 = this.api).updateItem.apply(_this$api6, [_objectSpread(_objectSpread({}, first), {}, {
-            collectionId: _collection._id
-          })].concat(rest));
-        },
-        removeItem: function removeItem(first) {
-          var _this$api7;
-
-          for (var _len7 = arguments.length, rest = new Array(_len7 > 1 ? _len7 - 1 : 0), _key7 = 1; _key7 < _len7; _key7++) {
-            rest[_key7 - 1] = arguments[_key7];
-          }
-
-          return (_this$api7 = this.api).removeItem.apply(_this$api7, [_objectSpread(_objectSpread({}, first), {}, {
-            collectionId: _collection._id
-          })].concat(rest));
-        }
-      });
-    }
-  }, {
-    key: "item",
-    value: function item(_item, collectionId) {
-      return _objectSpread(_objectSpread({}, _item), {}, {
-        update: function update(first) {
-          var _this$api8;
-
-          for (var _len8 = arguments.length, rest = new Array(_len8 > 1 ? _len8 - 1 : 0), _key8 = 1; _key8 < _len8; _key8++) {
-            rest[_key8 - 1] = arguments[_key8];
-          }
-
-          return (_this$api8 = this.api).updateItem.apply(_this$api8, [_objectSpread(_objectSpread({}, first), {}, {
-            collectionId: collectionId,
-            itemId: _item._id
-          })].concat(rest));
-        },
-        remove: this.api.updateItem.bind(this.api, {
-          collectionId: collectionId,
-          itemId: _item._id
-        })
-      });
-    }
-  }, {
-    key: "user",
-    value: function user(_user, siteId) {
-      return _objectSpread(_objectSpread({}, _user), {}, {
-        update: function update(first) {
-          var _this$api9;
-
-          for (var _len9 = arguments.length, rest = new Array(_len9 > 1 ? _len9 - 1 : 0), _key9 = 1; _key9 < _len9; _key9++) {
-            rest[_key9 - 1] = arguments[_key9];
-          }
-
-          return (_this$api9 = this.api).updateUser.apply(_this$api9, [_objectSpread(_objectSpread({}, first), {}, {
-            siteId: siteId
-          })].concat(rest));
-        },
-        remove: function remove(first) {
-          var _this$api10;
-
-          for (var _len10 = arguments.length, rest = new Array(_len10 > 1 ? _len10 - 1 : 0), _key10 = 1; _key10 < _len10; _key10++) {
-            rest[_key10 - 1] = arguments[_key10];
-          }
-
-          return (_this$api10 = this.api).removeUser.apply(_this$api10, [_objectSpread(_objectSpread({}, first), {}, {
-            siteId: siteId
-          })].concat(rest));
-        }
-      });
-    }
-  }, {
-    key: "webhook",
-    value: function webhook(_webhook, siteId) {
-      return _objectSpread(_objectSpread({}, _webhook), {}, {
-        remove: this.api.removeWebhook.bind(this.api, {
-          siteId: siteId,
-          webhookId: _webhook._id
-        })
-      });
-    }
-  }]);
-
-  return ResponseWrapper;
-}();
-
-exports["default"] = ResponseWrapper;
+  site(site) {
+    return {
+      ...site,
+      collections: this.api.collections.bind(this.api, {
+        siteId: site._id
+      }),
+      webhooks: this.api.webhooks.bind(this.api, {
+        siteId: site._id
+      }),
+      domains: this.api.domains.bind(this.api, {
+        siteId: site._id
+      }),
+      webhook: (first, ...rest) => {
+        return this.api.webhook({
+          ...first,
+          siteId: site._id
+        }, ...rest);
+      },
+      createWebhook: (first, ...rest) => {
+        return this.api.createWebhook({
+          ...first,
+          siteId: site._id
+        }, ...rest);
+      },
+      removeWebhook: (first, ...rest) => {
+        return this.api.removeWebhook({
+          ...first,
+          siteId: site._id
+        }, ...rest);
+      },
+      publishSite: domains => {
+        return this.api.publishSite({
+          siteId: site._id,
+          domains
+        });
+      }
+    };
+  }
+  domain(domain) {
+    return {
+      ...domain
+    };
+  }
+  collection(collection) {
+    return {
+      ...collection,
+      items: this.api.items.bind(this.api, {
+        collectionId: collection._id
+      }),
+      item: (first, ...rest) => {
+        return this.api.item({
+          ...first,
+          collectionId: collection._id
+        }, ...rest);
+      },
+      createItem: (first, ...rest) => {
+        return this.api.createItem({
+          ...first,
+          collectionId: collection._id
+        }, ...rest);
+      },
+      updateItem: (first, ...rest) => {
+        return this.api.updateItem({
+          ...first,
+          collectionId: collection._id
+        }, ...rest);
+      },
+      removeItem: (first, ...rest) => {
+        return this.api.removeItem({
+          ...first,
+          collectionId: collection._id
+        }, ...rest);
+      }
+    };
+  }
+  item(item, collectionId) {
+    const itemId = item._id;
+    const ids = {
+      itemId,
+      collectionId
+    };
+    return {
+      ...item,
+      update: (itemData, query) => {
+        return this.api.updateItem({
+          ...itemData,
+          ...ids
+        }, query);
+      },
+      remove: query => {
+        return this.api.removeItem(ids, query);
+      }
+    };
+  }
+  user(user, siteId) {
+    const userId = user._id;
+    const ids = {
+      userId,
+      siteId
+    };
+    return {
+      ...user,
+      update: userData => {
+        return this.api.updateUser({
+          ...ids,
+          ...userData
+        });
+      },
+      remove: this.api.removeUser.bind(this.api, ids)
+    };
+  }
+  webhook(webhook, siteId) {
+    const webhookId = webhook._id;
+    const ids = {
+      webhookId,
+      siteId
+    };
+    return {
+      ...webhook,
+      remove: this.api.removeWebhook.bind(this.api, ids)
+    };
+  }
+}
+exports.default = ResponseWrapper;
+module.exports = exports.default;