webflow-api 1.1.2 → 1.2.1

package/dist/{webflow.js → core/webflow.js}

@@ -1,24 +1,49 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Webflow = void 0;
-const core_1 = require("./core");
-const api_1 = require("./api");
-const wrapper_1 = require("./wrapper");
+exports.Webflow = exports.USER_AGENT = exports.DEFAULT_HOST = void 0;
+const axios_1 = __importDefault(require("axios"));
+const core_1 = require("../core");
+const api_1 = require("../api");
+exports.DEFAULT_HOST = "webflow.com";
+exports.USER_AGENT = "Webflow Javascript SDK / 1.0";
 /**************************************************************
  * Class
  **************************************************************/
 class Webflow {
     constructor(options = {}) {
         this.options = options;
-        this.client = new core_1.Client(options);
+        this.client = axios_1.default.create(this.config);
+        this.client.interceptors.response.use(core_1.ErrorInterceptor);
     }
     // Set the Authentication token
     set token(value) {
-        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 = exports.DEFAULT_HOST, token, version, headers } = this.options;
+        const config = {
+            baseURL: `https://api.${host}/`,
+            headers: {
+                "Content-Type": "application/json",
+                "User-Agent": exports.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;
     }
     /**************************************************************
      * HTTP Methods
@@ -85,7 +110,7 @@ class Webflow {
      * @returns The url to redirect to
      */
     authorizeUrl(params) {
-        return api_1.OAuth.authorizeUrl(this.client, params);
+        return api_1.OAuth.authorizeUrl(params, this.client);
     }
     /**
      * Create an OAuth Access Token
@@ -98,8 +123,8 @@ class Webflow {
      * @returns The access token
      */
     async accessToken(params) {
-        const res = await api_1.OAuth.accessToken(this.client, params);
-        return (0, wrapper_1.ResponseWrapper)(res);
+        const res = await api_1.OAuth.accessToken(params, this.client);
+        return res.data;
     }
     /**
      * Revoke an OAuth Access Token
@@ -110,8 +135,8 @@ class Webflow {
      * @returns The result of the revoked token
      */
     async revokeToken(params) {
-        const res = await api_1.OAuth.revokeToken(this.client, params);
-        return (0, wrapper_1.ResponseWrapper)(res);
+        const res = await api_1.OAuth.revokeToken(params, this.client);
+        return res.data;
     }
     /**************************************************************
      * Meta Endpoints
@@ -122,7 +147,7 @@ class Webflow {
      */
     async info() {
         const res = await api_1.Meta.info(this.client);
-        return (0, wrapper_1.ResponseWrapper)(res);
+        return res.data;
     }
     /**
      * Get the current authenticated user
@@ -130,18 +155,18 @@ class Webflow {
      */
     async authenticatedUser() {
         const res = await api_1.Meta.user(this.client);
-        return (0, wrapper_1.ResponseWrapper)(res);
+        return res.data;
     }
     /**************************************************************
      * Site Endpoints
      **************************************************************/
     /**
      * Get a list of Sites available
-     * @param query The query parameters (optional)
      * @returns A list of Sites
      */
-    async sites(query) {
-        return wrapper_1.SiteWrapper.list(this.client, query);
+    async sites() {
+        const res = await api_1.Site.list(this.client);
+        return res.data.map((data) => new api_1.Site(this.client, { ...res, data }));
     }
     /**
      * Get a single Site
@@ -150,7 +175,8 @@ class Webflow {
      * @returns The Site
      */
     async site({ siteId }) {
-        return wrapper_1.SiteWrapper.getOne(this.client, { siteId });
+        const res = await api_1.Site.getOne({ siteId }, this.client);
+        return new api_1.Site(this.client, res);
     }
     /**
      * Publish a Site
@@ -159,8 +185,9 @@ class Webflow {
      * @param params.domain The domains to publish
      * @returns The result of the publish
      */
-    publishSite({ siteId, domains }) {
-        return wrapper_1.SiteWrapper.publish(this.client, { siteId, domains });
+    async publishSite({ siteId, domains }) {
+        const res = await api_1.Site.publish({ siteId, domains }, this.client);
+        return res.data;
     }
     /**
      * Get a list of Domains for a Site
@@ -169,7 +196,8 @@ class Webflow {
      * @returns A list of Domains
      */
     async domains({ siteId }) {
-        return wrapper_1.SiteWrapper.domains(this.client, { siteId });
+        const res = await api_1.Site.domains({ siteId }, this.client);
+        return res.data;
     }
     /**************************************************************
      * Collection Endpoints
@@ -178,11 +206,11 @@ 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 }, query) {
-        return wrapper_1.CollectionWrapper.list(this.client, { siteId }, query);
+    async collections({ siteId }) {
+        const res = await api_1.Collection.list({ siteId }, this.client);
+        return res.data.map((data) => new api_1.Collection(this.client, { ...res, data }));
     }
     /**
      * Get a single Collection
@@ -191,7 +219,8 @@ class Webflow {
      * @returns A single Collection
      */
     async collection({ collectionId }) {
-        return wrapper_1.CollectionWrapper.getOne(this.client, { collectionId });
+        const res = await api_1.Collection.getOne({ collectionId }, this.client);
+        return new api_1.Collection(this.client, res);
     }
     /**************************************************************
      * Item Endpoints
@@ -200,11 +229,13 @@ 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 }, pageParams) {
-        return wrapper_1.ItemWrapper.list(this.client, { collectionId, ...pageParams });
+    async items({ collectionId, limit, offset }) {
+        const res = await api_1.Item.list({ collectionId, limit, offset }, this.client);
+        return res.data.items.map((data) => new api_1.Item(this.client, { ...res, data }));
     }
     /**
      * Get a single Collection Item
@@ -213,8 +244,10 @@ class Webflow {
      * @param params.itemId The Item ID
      * @returns A single Collection Item
      */
-    async item({ itemId, collectionId, }) {
-        return wrapper_1.ItemWrapper.getOne(this.client, { itemId, collectionId });
+    async item({ itemId, collectionId }) {
+        const res = await api_1.Item.getOne({ itemId, collectionId }, this.client);
+        const [item] = res.data.items.map((data) => new api_1.Item(this.client, { ...res, data }));
+        return item;
     }
     /**
      * Create a new Collection Item
@@ -222,31 +255,34 @@ class Webflow {
      * @param params.collectionId The Collection ID
      * @returns The created Collection Item
      */
-    async createItem({ collectionId, fields, }) {
-        return wrapper_1.ItemWrapper.create(this.client, { collectionId, fields });
+    async createItem({ collectionId, fields }) {
+        const res = await api_1.Item.create({ collectionId, fields }, this.client);
+        return new api_1.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 }) {
+    async updateItem({ collectionId, itemId, ...fields }) {
         const _params = { collectionId, itemId, fields };
-        return wrapper_1.ItemWrapper.update(this.client, _params);
+        const res = await api_1.Item.update(_params, this.client);
+        return new api_1.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 }, query) {
+    async patchItem({ collectionId, itemId, ...fields }) {
         const _params = { collectionId, itemId, fields };
-        return wrapper_1.ItemWrapper.patch(this.client, _params, query);
+        const res = await api_1.Item.patch(_params, this.client);
+        return new api_1.Item(this.client, res);
     }
     /**
      * Delete a Collection Item
@@ -255,8 +291,9 @@ class Webflow {
      * @param params.itemId The Item ID
      * @returns The deleted Collection Item result
      */
-    removeItem({ collectionId, itemId, }) {
-        return wrapper_1.ItemWrapper.remove(this.client, { collectionId, itemId });
+    async removeItem({ collectionId, itemId }) {
+        const res = await api_1.Item.remove({ collectionId, itemId }, this.client);
+        return res.data;
     }
     /**
      * Upublish a Collection Item
@@ -266,9 +303,9 @@ class Webflow {
      * @param params.live Update the live version
      * @returns The unpublished Collection Item result
      */
-    deleteItems({ collectionId, itemIds, live, }) {
-        const params = { collectionId, itemIds, live };
-        return wrapper_1.ItemWrapper.unpublish(this.client, params);
+    async deleteItems({ collectionId, itemIds, live, }) {
+        const res = await api_1.Item.unpublish({ collectionId, itemIds, live }, this.client);
+        return res.data;
     }
     /**
      * Publish a Collection Item
@@ -278,9 +315,9 @@ class Webflow {
      * @param params.live Update the live version
      * @returns The Published Collection Item result
      */
-    publishItems({ collectionId, itemIds, live, }) {
-        const params = { collectionId, itemIds, live };
-        return wrapper_1.ItemWrapper.publish(this.client, params);
+    async publishItems({ collectionId, itemIds, live, }) {
+        const res = await api_1.Item.publish({ collectionId, itemIds, live }, this.client);
+        return res.data;
     }
     /**************************************************************
      * Membership Endpoints
@@ -290,12 +327,11 @@ 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 }, pageParams) {
-        return wrapper_1.MembershipWrapper.list(this.client, { siteId, ...pageParams });
+        const res = await api_1.User.list({ siteId, ...pageParams }, this.client);
+        return res.data.users.map((data) => new api_1.User(this.client, { ...res, data }));
     }
     /**
      * Get a single User account
@@ -305,7 +341,8 @@ class Webflow {
      * @returns The User information
      */
     async user({ siteId, userId }) {
-        return wrapper_1.MembershipWrapper.getOne(this.client, { siteId, userId });
+        const res = await api_1.User.getOne({ siteId, userId }, this.client);
+        return new api_1.User(this.client, res, res.data, { siteId });
     }
     /**
      * Update a User account
@@ -316,7 +353,8 @@ class Webflow {
      */
     async updateUser({ siteId, userId, ...data }) {
         const _params = { siteId, userId, data };
-        return wrapper_1.MembershipWrapper.update(this.client, _params);
+        const res = await api_1.User.update(_params, this.client);
+        return new api_1.User(this.client, res, res.data, { siteId });
     }
     /**
      * Invite a User to a Site
@@ -326,7 +364,8 @@ class Webflow {
      * @returns The created User account
      */
     async inviteUser({ siteId, email }) {
-        return wrapper_1.MembershipWrapper.invite(this.client, { siteId, email });
+        const res = await api_1.User.invite({ siteId, email }, this.client);
+        return new api_1.User(this.client, res, res.data, { siteId });
     }
     /**
      * Remove a user from a Site
@@ -335,17 +374,23 @@ class Webflow {
      * @param params.userId The User ID
      * @returns The result from the remove request
      */
-    removeUser({ siteId, userId }) {
-        return wrapper_1.MembershipWrapper.remove(this.client, { siteId, userId });
+    async removeUser({ siteId, userId }) {
+        const res = await api_1.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 }) {
-        return wrapper_1.MembershipWrapper.accessGroups(this.client, { siteId });
+    async accessGroups({ siteId, limit, offset, sort, }) {
+        const params = { siteId, limit, offset, sort };
+        const res = await api_1.User.accessGroups(params, this.client);
+        return res.data;
     }
     /**************************************************************
      * Webhook Endpoints
@@ -356,8 +401,9 @@ class Webflow {
      * @param params.siteId The Site ID
      * @returns A list of Webhooks
      */
-    async webhooks({ siteId }, query) {
-        return wrapper_1.WebhookWrapper.list(this.client, { siteId }, query);
+    async webhooks({ siteId }) {
+        const res = await api_1.Webhook.list({ siteId }, this.client);
+        return res.data.map((data) => new api_1.Webhook(this.client, { ...res, data }));
     }
     /**
      * Get a single Webhook
@@ -367,7 +413,8 @@ class Webflow {
      * @returns The Webhook
      */
     async webhook({ siteId, webhookId }) {
-        return wrapper_1.WebhookWrapper.getOne(this.client, { siteId, webhookId });
+        const res = await api_1.Webhook.getOne({ siteId, webhookId }, this.client);
+        return new api_1.Webhook(this.client, res);
     }
     /**
      * Remove a Webhook
@@ -376,8 +423,9 @@ class Webflow {
      * @param params.webhookId The Webhook Id
      * @returns the result from the remove request
      */
-    removeWebhook({ siteId, webhookId }) {
-        return wrapper_1.WebhookWrapper.remove(this.client, { siteId, webhookId });
+    async removeWebhook({ siteId, webhookId }) {
+        const res = await api_1.Webhook.remove({ siteId, webhookId }, this.client);
+        return res.data;
     }
     /**
      * Create a Webhook
@@ -390,7 +438,8 @@ class Webflow {
      */
     async createWebhook({ url, siteId, triggerType, filter, }) {
         const _params = { url, siteId, triggerType, filter };
-        return wrapper_1.WebhookWrapper.create(this.client, _params);
+        const res = await api_1.Webhook.create(_params, this.client);
+        return new api_1.Webhook(this.client, res);
     }
 }
 exports.Webflow = Webflow;

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,3 +1,3 @@
 "use strict";
-const webflow_1 = require("./webflow");
-module.exports = webflow_1.Webflow;
+const core_1 = require("./core");
+module.exports = core_1.Webflow;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "webflow-api",
   "description": "Webflow's official Node.js SDK for Data APIs",
-  "version": "1.1.2",
+  "version": "1.2.1",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "contributors": [
@@ -19,17 +19,21 @@
     "yarn.lock"
   ],
   "scripts": {
-    "build": "yarn clean && tsc -p ./",
-    "lint": "eslint . --ext .ts,.tsx",
+    "test": "yarn build && jest",
+    "build": "yarn clean && tsc",
+    "lint": "eslint src --ext .ts",
+    "test:snapshot": "yarn test --updateSnapshot",
+    "test:coverage": "yarn test --collectCoverage",
+    "test:ci": "yarn test --ci --coverage --forceExit",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
     "prepublish": "yarn build",
-    "watch": "tsc -watch -p ./",
+    "watch": "tsc --watch",
     "clean": "rm -rf dist",
-    "test": "jest"
+    "typecheck": "tsc --noEmit"
   },
   "devDependencies": {
-    "@jest/globals": "^29.2.2",
-    "@types/isomorphic-fetch": "^0.0.36",
-    "@types/jest": "^29.2.1",
+    "@types/jest": "^29.2.3",
     "@types/node": "^18.11.9",
     "@typescript-eslint/eslint-plugin": "^5.42.0",
     "@typescript-eslint/parser": "^5.42.0",

package/src/api/collection.ts

@@ -1,4 +1,6 @@
-import { Client, QueryString, requireArgs } from "../core";
+import { AxiosInstance } from "axios";
+import { requireArgs, WebflowRecord } from "../core";
+import { Item } from ".";
 
 /**************************************************************
  * Types
@@ -30,7 +32,7 @@ export type CollectionField = {
   required: boolean;
   editable: boolean;
   // TODO: add a better type
-  validations?: any;
+  validations?: Record<string, string | number | boolean | object>;
 };
 
 /**************************************************************
@@ -47,41 +49,106 @@ export interface ICollection {
 }
 
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
+export class Collection extends WebflowRecord<ICollection> implements ICollection {
+  fields: CollectionField[];
+  singularName: string;
+  lastUpdated: string;
+  createdOn: string;
+  _id: string;
+  name: string;
+  slug: string;
 
-/**
- * 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 function list(
-  client: Client,
-  { siteId }: { siteId: string },
-  params?: QueryString
-) {
-  requireArgs({ siteId });
-  const path = `/sites/${siteId}/collections`;
-  return client.get<ICollection[]>(path, { params });
-}
+  /**************************************************************
+   * 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) {
+    requireArgs({ siteId });
+    const path = `/sites/${siteId}/collections`;
+    return client.get<ICollection[]>(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 }: { collectionId: string }, client: AxiosInstance) {
+    requireArgs({ collectionId });
+    const path = `/collections/${collectionId}`;
+    return client.get<ICollection>(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 }: { itemId: string }) {
+    const res = await Item.getOne({ itemId, collectionId: this._id }, this.client);
+    const [item] = res.data.items.map((data) => new 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 }: { limit?: number; offset?: number } = {}) {
+    const res = await Item.list({ collectionId: this._id, limit, offset }, this.client);
+    return res.data.items.map((data) => new 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 }: { itemId: string }) {
+    const res = await 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: object) {
+    const res = await Item.create({ collectionId: this._id, fields }, this.client);
+    return new Item(this.client, res);
+  }
 
-/**
- * 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 function getOne(
-  client: Client,
-  { collectionId }: { collectionId: string },
-  params?: QueryString
-) {
-  requireArgs({ collectionId });
-  const path = `/collections/${collectionId}`;
-  return client.get<ICollection>(path, { params });
+  /**
+   * 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 }: { itemId: string; fields: object }) {
+    const params = { itemId, collectionId: this._id, fields };
+    const res = await Item.update(params, this.client);
+    return new Item(this.client, res);
+  }
 }

package/src/api/index.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";