webflow-api 1.1.2 → 1.2.1

package/README.md

@@ -9,18 +9,20 @@ $ 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
+- `token` - the access token to use
+- `headers` - additional headers to add to the request
+- `version` - the version of the API you wish to use
 
-``` javascript
+```javascript
 const Webflow = require("webflow-api");
 
 // initialize the client with the access token
@@ -31,12 +33,15 @@ const webflow = new Webflow({
   token: "[ACCESS TOKEN]",
   version: "1.0.0",
   headers: {
-    "User-Agent": "My Webflow App / 1.0"
-  }
+    "User-Agent": "My Webflow App / 1.0",
+  },
 });
 ```
+
 ## Basic Usage
+
 ### Chaining Calls
+
 You can retrieve child resources by chaining calls on the parent object.
 
 ```javascript
@@ -54,6 +59,7 @@ const item = await collection.items({ itemId: "[ITEM ID]" });
 ```
 
 ### Pagination
+
 To paginate results, pass in the `limit` and `offset` options.
 
 ```javascript
@@ -65,6 +71,7 @@ const page2 = await collection.items({ limit: 20, offset: 20 });
 ```
 
 ### Rate Limit
+
 Check rate limit status on each call by checking the `_meta` property.
 
 ```javascript
@@ -74,7 +81,9 @@ 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
@@ -87,7 +96,9 @@ webflow.token = "[ACCESS TOKEN]";
 // remove the token
 webflow.clearToken();
 ```
+
 ### Calling APIs Directly
+
 All Webflow API endpoints can be called directly using the `get`, `post`, `put`, and `delete` methods.
 
 ```javascript
@@ -96,14 +107,16 @@ const sites = await webflow.get("/sites");
 
 // post to an endpoint directly
 const result = await webflow.post("/sites/[SITE ID]/publish", {
-  domains: ["hello-webflow.com"]
+  domains: ["hello-webflow.com"],
 });
 ```
 
 ## OAuth
+
 To implement OAuth, you'll need a Webflow App registered and a webserver running, that is publicly facing.
 
 ### Authorize
+
 The first step in OAuth is to generate an authorization url to redirect the user to.
 
 ```javascript
@@ -111,7 +124,7 @@ The first step in OAuth is to generate an authorization url to redirect the user
 const url = webflow.authorizeUrl({
   client_id: "[CLIENT ID]",
   state: "1234567890", // optional
-  redirect_uri: "https://my.server.com/oauth/callback" // optional
+  redirect_uri: "https://my.server.com/oauth/callback", // optional
 });
 
 // redirect user from your server route
@@ -119,6 +132,7 @@ res.redirect(url);
 ```
 
 ### 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
@@ -126,7 +140,7 @@ const auth = await webflow.accessToken({
   client_id,
   client_secret,
   code,
-  redirect_uri // optional - required if used in the authorize step
+  redirect_uri, // optional - required if used in the authorize step
 });
 
 // you now have the user's access token to make API requests with
@@ -137,21 +151,24 @@ const authenticatedUser = await userWF.authenticatedUser();
 ```
 
 ### 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
+  access_token,
 });
 
 // ensure it went through
-result.didRevoke === true
+result.didRevoke === true;
 ```
 
 ## Examples
+
 ### Sites
+
 Get all sites available or lookup by site id.
 
 ```javascript
@@ -163,7 +180,9 @@ 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();
@@ -176,7 +195,9 @@ 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();
@@ -187,7 +208,9 @@ 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 = {
@@ -206,19 +229,20 @@ const updatedItem = await webflow.updateItem({
 ```
 
 ### Memberships
+
 ```javascript
 // 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]"
+  siteId: "[SITE ID]",
 });
 
 // Get a single user
 const user = await site.user({
   siteId: "[SITE ID]",
-  userId: "[USER ID]"
+  userId: "[USER ID]",
 });
 
 // Get a site's access groups
@@ -226,11 +250,12 @@ const accessGroups = await site.accessGroups();
 
 // Get a site's access groups with a site id
 const accessGroups = await webflow.accessGroups({
-  siteId: "[SITE ID]"
+  siteId: "[SITE ID]",
 });
 ```
 
 ### Webhooks
+
 ```javascript
 // get webhooks for a site
 const webhooks = await site.webhooks();
@@ -238,18 +263,17 @@ const webhooks = await site.webhooks();
 // create a webhook
 const webhook = await site.createWebhook({
   triggerType: "form_submission",
-  url: "https://webhook.site"
+  url: "https://webhook.site",
 });
-
 ```
 
 ### Authenticated User
+
 ```javascript
 // pull information for the authenticated user
 const authenticatedUser = await webflow.authenticatedUser();
 ```
 
-
 ## Contributing
 
 Contributions are welcome - feel free to open an issue or pull request.

package/dist/api/collection.d.ts

@@ -1,4 +1,6 @@
-import { Client, QueryString } from "../core";
+import { AxiosInstance } from "axios";
+import { WebflowRecord } from "../core";
+import { Item } from ".";
 /**************************************************************
  * Types
  **************************************************************/
@@ -10,7 +12,7 @@ export declare type CollectionField = {
     name: string;
     required: boolean;
     editable: boolean;
-    validations?: any;
+    validations?: Record<string, string | number | boolean | object>;
 };
 /**************************************************************
  * Interfaces
@@ -25,27 +27,86 @@ export interface ICollection {
     fields: CollectionField[];
 }
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * Get a list of Collections
- * @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 Collections
- */
-export declare function list(client: Client, { siteId }: {
-    siteId: string;
-}, params?: QueryString): Promise<import("axios").AxiosResponse<ICollection[], any>>;
-/**
- * Get a single Collection
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.collectionId The collection ID
- * @param params.params The query string parameters (optional)
- * @returns A single Collection
- */
-export declare function getOne(client: Client, { collectionId }: {
-    collectionId: string;
-}, params?: QueryString): Promise<import("axios").AxiosResponse<ICollection, any>>;
+export declare class Collection extends WebflowRecord<ICollection> implements ICollection {
+    fields: CollectionField[];
+    singularName: string;
+    lastUpdated: string;
+    createdOn: string;
+    _id: string;
+    name: string;
+    slug: string;
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a list of Collections
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param client The Axios client instance
+     * @returns A list of Collections
+     */
+    static list({ siteId }: {
+        siteId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<ICollection[], any>>;
+    /**
+     * Get a single Collection
+     * @param params The params for the request
+     * @param params.collectionId The collection ID
+     * @param client The Axios client instance
+     * @returns A single Collection
+     */
+    static getOne({ collectionId }: {
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<ICollection, any>>;
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Get a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @returns A single Item
+     */
+    item({ itemId }: {
+        itemId: string;
+    }): Promise<Item>;
+    /**
+     * Get a list of Items
+     * @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 Items
+     */
+    items({ limit, offset }?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<Item[]>;
+    /**
+     * Remove a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @returns The result from the removal
+     */
+    removeItem({ itemId }: {
+        itemId: string;
+    }): Promise<import("./item").IItemDelete>;
+    /**
+     * Create a new Item
+     * @param fields The Item fields to create
+     * @returns The created Item
+     */
+    createItem(fields: object): Promise<Item>;
+    /**
+     * Update a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @param params.fields The fields to update
+     * @returns The updated Item
+     */
+    updateItem({ itemId, fields }: {
+        itemId: string;
+        fields: object;
+    }): Promise<Item>;
+}

package/dist/api/collection.js

@@ -1,35 +1,94 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOne = exports.list = void 0;
+exports.Collection = void 0;
 const core_1 = require("../core");
+const _1 = require(".");
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * Get a list of Collections
- * @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 Collections
- */
-function list(client, { siteId }, params) {
-    (0, core_1.requireArgs)({ siteId });
-    const path = `/sites/${siteId}/collections`;
-    return client.get(path, { params });
+class Collection extends core_1.WebflowRecord {
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a list of Collections
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param client The Axios client instance
+     * @returns A list of Collections
+     */
+    static list({ siteId }, client) {
+        (0, core_1.requireArgs)({ siteId });
+        const path = `/sites/${siteId}/collections`;
+        return client.get(path);
+    }
+    /**
+     * Get a single Collection
+     * @param params The params for the request
+     * @param params.collectionId The collection ID
+     * @param client The Axios client instance
+     * @returns A single Collection
+     */
+    static getOne({ collectionId }, client) {
+        (0, core_1.requireArgs)({ collectionId });
+        const path = `/collections/${collectionId}`;
+        return client.get(path);
+    }
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Get a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @returns A single Item
+     */
+    async item({ itemId }) {
+        const res = await _1.Item.getOne({ itemId, collectionId: this._id }, this.client);
+        const [item] = res.data.items.map((data) => new _1.Item(this.client, { ...res, data }));
+        return item;
+    }
+    /**
+     * Get a list of Items
+     * @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 Items
+     */
+    async items({ limit, offset } = {}) {
+        const res = await _1.Item.list({ collectionId: this._id, limit, offset }, this.client);
+        return res.data.items.map((data) => new _1.Item(this.client, { ...res, data }));
+    }
+    /**
+     * Remove a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @returns The result from the removal
+     */
+    async removeItem({ itemId }) {
+        const res = await _1.Item.remove({ itemId, collectionId: this._id }, this.client);
+        return res.data;
+    }
+    /**
+     * Create a new Item
+     * @param fields The Item fields to create
+     * @returns The created Item
+     */
+    async createItem(fields) {
+        const res = await _1.Item.create({ collectionId: this._id, fields }, this.client);
+        return new _1.Item(this.client, res);
+    }
+    /**
+     * Update a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @param params.fields The fields to update
+     * @returns The updated Item
+     */
+    async updateItem({ itemId, fields }) {
+        const params = { itemId, collectionId: this._id, fields };
+        const res = await _1.Item.update(params, this.client);
+        return new _1.Item(this.client, res);
+    }
 }
-exports.list = list;
-/**
- * Get a single Collection
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.collectionId The collection ID
- * @param params.params The query string parameters (optional)
- * @returns A single Collection
- */
-function getOne(client, { collectionId }, params) {
-    (0, core_1.requireArgs)({ collectionId });
-    const path = `/collections/${collectionId}`;
-    return client.get(path, { params });
-}
-exports.getOne = getOne;
+exports.Collection = Collection;

package/dist/api/index.d.ts

@@ -1,7 +1,7 @@
-export * as Membership from "./membership";
-export * as Collection from "./collection";
-export * as Webhook from "./webhook";
-export * as OAuth from "./oauth";
-export * as Item from "./item";
-export * as Site from "./site";
-export * as Meta from "./meta";
+export * from "./collection";
+export * from "./user";
+export * from "./webhook";
+export * from "./item";
+export * from "./site";
+export * from "./oauth";
+export * from "./meta";

package/dist/api/index.js

@@ -10,24 +10,14 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Meta = exports.Site = exports.Item = exports.OAuth = exports.Webhook = exports.Collection = exports.Membership = void 0;
-exports.Membership = __importStar(require("./membership"));
-exports.Collection = __importStar(require("./collection"));
-exports.Webhook = __importStar(require("./webhook"));
-exports.OAuth = __importStar(require("./oauth"));
-exports.Item = __importStar(require("./item"));
-exports.Site = __importStar(require("./site"));
-exports.Meta = __importStar(require("./meta"));
+__exportStar(require("./collection"), exports);
+__exportStar(require("./user"), exports);
+__exportStar(require("./webhook"), exports);
+__exportStar(require("./item"), exports);
+__exportStar(require("./site"), exports);
+__exportStar(require("./oauth"), exports);
+__exportStar(require("./meta"), exports);