webflow-api 1.0.3 → 1.1.1

package/dist/wrapper/site.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SiteWrapper = void 0;
+const _1 = require(".");
+const api_1 = require("../api");
+class SiteWrapper {
+    constructor(client, site) {
+        this.client = client;
+        Object.assign(this, site);
+    }
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a single Site
+     * @param client The Webflow client
+     * @param params The Site information
+     * @param params.siteId The Site ID
+     * @returns The Site
+     */
+    static async getOne(client, { siteId }) {
+        const res = await api_1.Site.getOne(client, { siteId });
+        const site = new SiteWrapper(client, res.data);
+        return (0, _1.ResponseWrapper)(res, site);
+    }
+    /**
+     * Get a list of Sites available
+     * @param client The Webflow client
+     * @param params The query parameters (optional)
+     * @returns A list of Sites
+     */
+    static async list(client, params) {
+        const res = await api_1.Site.list(client, params);
+        const sites = res.data.map((s) => new SiteWrapper(client, s));
+        return (0, _1.ResponseWrapper)(res, sites);
+    }
+    /**
+     * Get a list of Domains for a Site
+     * @param client The Webflow client
+     * @param params The Site information
+     * @param params.siteId The Site ID
+     * @returns A list of Domains
+     */
+    static async domains(client, { siteId }) {
+        const res = await api_1.Site.domains(client, { siteId });
+        return (0, _1.ResponseWrapper)(res, res.data);
+    }
+    /**
+     * Publish a Site
+     * @param client The Webflow client
+     * @param params The Site information
+     * @param params.siteId The Site ID
+     * @param params.domain The domains to publish
+     * @returns The result of the publish
+     */
+    static async publish(client, { siteId, domains }) {
+        const res = await api_1.Site.publish(client, { siteId, domains });
+        return (0, _1.ResponseWrapper)(res);
+    }
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Get a list of domains for a site
+     * @returns A list of domains
+     */
+    async domains() {
+        const res = await api_1.Site.domains(this.client, { siteId: this._id });
+        return (0, _1.ResponseWrapper)(res);
+    }
+    /**
+     * Publish a site
+     * @param domains The domains to publish to
+     * @returns The publish result
+     */
+    async publishSite(domains) {
+        const res = await api_1.Site.publish(this.client, { siteId: this._id, domains });
+        return (0, _1.ResponseWrapper)(res);
+    }
+    /**
+     * Get a single Collection
+     * @param params The params for the request
+     * @param params.collectionId The collection ID
+     * @returns A single Collection
+     */
+    async collection({ collectionId }) {
+        return _1.CollectionWrapper.getOne(this.client, { collectionId });
+    }
+    /**
+     * Get a list of Collections
+     * @returns A list of Collections
+     */
+    async collections() {
+        return _1.CollectionWrapper.list(this.client, { siteId: this._id });
+    }
+    /**
+     * Get a single Webhook
+     * @param params The params for the request
+     * @param params.webhookId The webhook ID
+     * @returns A single Webhook
+     */
+    async webhook({ webhookId }) {
+        return _1.WebhookWrapper.getOne(this.client, { siteId: this._id, webhookId });
+    }
+    /**
+     * Get a list of Webhooks
+     * @param params The query string parameters (optional)
+     * @returns A list of Webhooks
+     */
+    async webhooks(params) {
+        return _1.WebhookWrapper.list(this.client, { siteId: this._id }, params);
+    }
+    /**
+     * 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 }) {
+        return _1.WebhookWrapper.remove(this.client, { siteId: this._id, webhookId });
+    }
+    /**
+     * Create a new Webhook
+     * @param params1 The params for the request
+     * @param params1.url The URL to send the webhook to
+     * @param params1.triggerType The event to trigger the webhook
+     * @param params1.filter The filter to apply to the webhook (optional: form_submission only)
+     * @param params The query string parameters (optional)
+     * @returns The created webhook
+     */
+    async createWebhook({ triggerType, filter, url }) {
+        const _params = { url, siteId: this._id, triggerType, filter };
+        return _1.WebhookWrapper.create(this.client, _params);
+    }
+}
+exports.SiteWrapper = SiteWrapper;

package/dist/wrapper/webhook.d.ts

@@ -0,0 +1,78 @@
+import { Client, QueryString } from "../core";
+import { Webhook } from "../api";
+export declare type CreateWebhookParams = {
+    url: string;
+    siteId: string;
+    triggerType: string;
+    filter?: Webhook.Filter;
+};
+export declare class WebhookWrapper implements Webhook.IWebhook {
+    private client;
+    triggerType: Webhook.TriggerType;
+    triggerId: string;
+    createdOn: string;
+    lastUsed?: string;
+    site: string;
+    _id: string;
+    filter?: {
+        name: string;
+    };
+    constructor(client: Client, webhook: Webhook.IWebhook);
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a Webhook
+     * @param client The Webflow client
+     * @param params The Webhook params
+     * @param params.siteId The Site ID
+     * @param params.webhookId The Webhook ID
+     * @returns The Webhook
+     */
+    static getOne(client: Client, { siteId, webhookId }: {
+        siteId: string;
+        webhookId: string;
+    }): Promise<import("./response").MetaResponse<WebhookWrapper>>;
+    /**
+     * List Webhooks
+     * @param client The Webflow client
+     * @param param1 The Webhook params
+     * @param param1.siteId The Site ID
+     * @param params Query string params (optional)
+     * @returns A list of Webhooks
+     */
+    static list(client: Client, { siteId }: {
+        siteId: string;
+    }, params?: QueryString): Promise<import("./response").MetaResponse<WebhookWrapper[]>>;
+    /**
+     * Remove a Webhook
+     * @param client The Webflow client
+     * @param params The Webhook params
+     * @param params.siteId The Site ID
+     * @param params.webhookId The Webhook ID
+     * @returns The result of the removal
+     */
+    static remove(client: Client, { siteId, webhookId }: {
+        siteId: string;
+        webhookId: string;
+    }): Promise<import("./response").MetaResponse<Webhook.IRemoveResult>>;
+    /**
+     * Create a Webhook
+     * @param client The Webflow client
+     * @param param1 The Webhook params
+     * @param param1.siteId The Site ID
+     * @param param1.url The URL to send the Webhook to
+     * @param param1.triggerType The event to trigger the Webhook
+     * @param param1.filter The filter to use (optional: form_submission only)
+     * @returns The created Webhook
+     */
+    static create(client: Client, { triggerType, siteId, filter, url }: CreateWebhookParams): Promise<import("./response").MetaResponse<WebhookWrapper>>;
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Remove a Webhook
+     * @returns The result of the removal
+     */
+    remove(): Promise<import("./response").MetaResponse<Webhook.IRemoveResult>>;
+}

package/dist/wrapper/webhook.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookWrapper = void 0;
+const _1 = require(".");
+const api_1 = require("../api");
+class WebhookWrapper {
+    constructor(client, webhook) {
+        this.client = client;
+        Object.assign(this, webhook);
+    }
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a Webhook
+     * @param client The Webflow client
+     * @param params The Webhook params
+     * @param params.siteId The Site ID
+     * @param params.webhookId The Webhook ID
+     * @returns The Webhook
+     */
+    static async getOne(client, { siteId, webhookId }) {
+        const res = await api_1.Webhook.getOne(client, { siteId, webhookId });
+        const webhook = new WebhookWrapper(client, res.data);
+        return (0, _1.ResponseWrapper)(res, webhook);
+    }
+    /**
+     * List Webhooks
+     * @param client The Webflow client
+     * @param param1 The Webhook params
+     * @param param1.siteId The Site ID
+     * @param params Query string params (optional)
+     * @returns A list of Webhooks
+     */
+    static async list(client, { siteId }, params) {
+        const res = await api_1.Webhook.list(client, { siteId }, params);
+        const webhooks = res.data.map((w) => new WebhookWrapper(client, w));
+        return (0, _1.ResponseWrapper)(res, webhooks);
+    }
+    /**
+     * Remove a Webhook
+     * @param client The Webflow client
+     * @param params The Webhook params
+     * @param params.siteId The Site ID
+     * @param params.webhookId The Webhook ID
+     * @returns The result of the removal
+     */
+    static async remove(client, { siteId, webhookId }) {
+        const res = await api_1.Webhook.remove(client, { siteId, webhookId });
+        return (0, _1.ResponseWrapper)(res);
+    }
+    /**
+     * Create a Webhook
+     * @param client The Webflow client
+     * @param param1 The Webhook params
+     * @param param1.siteId The Site ID
+     * @param param1.url The URL to send the Webhook to
+     * @param param1.triggerType The event to trigger the Webhook
+     * @param param1.filter The filter to use (optional: form_submission only)
+     * @returns The created Webhook
+     */
+    static async create(client, { triggerType, siteId, filter, url }) {
+        const args = { triggerType, siteId, filter, url };
+        const res = await api_1.Webhook.create(client, args);
+        const _webhook = new WebhookWrapper(client, res.data);
+        return (0, _1.ResponseWrapper)(res, _webhook);
+    }
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Remove a Webhook
+     * @returns The result of the removal
+     */
+    async remove() {
+        return WebhookWrapper.remove(this.client, {
+            webhookId: this._id,
+            siteId: this.site,
+        });
+    }
+}
+exports.WebhookWrapper = WebhookWrapper;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "webflow-api",
   "description": "Webflow's official Node.js SDK for Data APIs",
-  "version": "1.0.3",
-  "types": "index.d.ts",
+  "version": "1.1.1",
+  "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "contributors": [
     "John Agan (https://github.com/johnagan)"
@@ -16,35 +16,33 @@
     "dist",
     "src",
     "LICENSE",
-    "yarn.lock",
-    "index.d.ts"
+    "yarn.lock"
   ],
   "scripts": {
-    "compile": "BABEL_ENV=production babel --out-dir dist src/",
-    "build": " yarn clean && yarn compile",
-    "watch": "yarn build --watch",
+    "build": "yarn clean && tsc -p ./",
+    "lint": "eslint . --ext .ts,.tsx",
     "prepublish": "yarn build",
+    "watch": "tsc -watch -p ./",
     "clean": "rm -rf dist",
-    "lint": "eslint",
     "test": "jest"
   },
   "devDependencies": {
-    "@babel/cli": "^7.19.3",
-    "@babel/core": "^7.19.6",
-    "@babel/preset-env": "^7.19.4",
-    "@babel/register": "^7.18.9",
     "@jest/globals": "^29.2.2",
-    "babel-jest": "^29.2.2",
-    "babel-plugin-add-module-exports": "^1.0.4",
+    "@types/isomorphic-fetch": "^0.0.36",
+    "@types/jest": "^29.2.1",
+    "@types/node": "^18.11.9",
+    "@typescript-eslint/eslint-plugin": "^5.42.0",
+    "@typescript-eslint/parser": "^5.42.0",
+    "axios-mock-adapter": "^1.21.2",
     "eslint": "^8.12.0",
-    "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.2.1",
     "jest": "^29.2.2",
-    "nock": "^13.0.7"
+    "prettier": "^2.7.1",
+    "ts-jest": "^29.0.3",
+    "typescript": "^4.8.4"
   },
   "dependencies": {
-    "isomorphic-fetch": "^3.0.0"
+    "axios": "^1.1.3"
   }
 }

package/src/api/collection.ts

@@ -0,0 +1,87 @@
+import { Client, QueryString, requireArgs } from "../core";
+
+/**************************************************************
+ * Types
+ **************************************************************/
+export type CollectionFieldType =
+  | "Bool"
+  | "Color"
+  | "Date"
+  | "ExtFileRef"
+  | "Set"
+  | "ImageRef"
+  | "Set"
+  | "ItemRef"
+  | "ItemRefSet"
+  | "Link"
+  | "Number"
+  | "Option"
+  | "PlainText"
+  | "RichText"
+  | "Video"
+  | "User"
+  | string;
+
+export type CollectionField = {
+  id: string;
+  type: CollectionFieldType;
+  slug: string;
+  name: string;
+  required: boolean;
+  editable: boolean;
+  // TODO: add a better type
+  validations?: any;
+};
+
+/**************************************************************
+ * Interfaces
+ **************************************************************/
+export interface ICollection {
+  _id: string;
+  lastUpdated: string;
+  createdOn: string;
+  name: string;
+  slug: string;
+  singularName: string;
+  fields: CollectionField[];
+}
+
+/**************************************************************
+ * Functions
+ **************************************************************/
+
+/**
+ * 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 });
+}
+
+/**
+ * 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 });
+}

package/src/api/index.ts

@@ -0,0 +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";

package/src/api/item.ts

@@ -0,0 +1,231 @@
+import { Client, PaginatedData, QueryString, requireArgs } from "../core";
+
+/**************************************************************
+ * Interfaces
+ **************************************************************/
+export interface IItem {
+  _archived: boolean;
+  _draft: boolean;
+  _id: string;
+  _cid: string;
+  name: string;
+  slug: string;
+  "updated-on": string;
+  "created-on": string;
+  "updated-by": string;
+  "created-by": string;
+  "published-on"?: string | null;
+  "published-by"?: string | null;
+}
+
+export interface IItemDelete {
+  deleted: number;
+}
+
+export interface IPublishItems {
+  publishedItemIds: string[];
+  errors: string[];
+}
+
+export interface IDeletedItems {
+  deletedItemIds: string[];
+  errors: string[];
+}
+
+/**************************************************************
+ * Types
+ **************************************************************/
+export type PageinatedItems = PaginatedData & {
+  items: IItem[];
+};
+
+/**************************************************************
+ * Functions
+ **************************************************************/
+
+/**
+ * Get a single Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.itemId The Item ID
+ * @returns A single Item
+ */
+export function getOne(
+  client: Client,
+  { collectionId, itemId }: { collectionId: string; itemId: string }
+) {
+  requireArgs({ collectionId, itemId });
+  const path = `/collections/${collectionId}/items/${itemId}`;
+  // The API returns a paginated list with one record :(
+  return client.get<PageinatedItems>(path);
+}
+
+/**
+ * Get a list of Items
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @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
+ */
+export function list(
+  client: Client,
+  {
+    collectionId,
+    limit,
+    offset,
+  }: { collectionId: string; limit?: number; offset?: number }
+) {
+  requireArgs({ collectionId });
+  const params = { limit, offset };
+  const path = `/collections/${collectionId}/items`;
+  return client.get<PageinatedItems>(path, { params });
+}
+
+/**
+ * Create a new Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.fields The Item fields to create
+ * @returns The created Item
+ */
+export function create(
+  client: Client,
+  { collectionId, fields }: { fields: any; collectionId: string }
+) {
+  requireArgs({ collectionId });
+  const path = `/collections/${collectionId}/items`;
+  return client.post<IItem>(path, { fields });
+}
+
+/**
+ * Update a single Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.itemId The Item ID
+ * @param params.fields The fields to update
+ * @returns The updated Item
+ */
+export function update(
+  client: Client,
+  {
+    collectionId,
+    itemId,
+    fields,
+  }: {
+    fields: any;
+    itemId: string;
+    collectionId: string;
+  }
+) {
+  requireArgs({ collectionId, itemId });
+  const path = `/collections/${collectionId}/items/${itemId}`;
+  return client.put<IItem>(path, { fields });
+}
+
+/**
+ * Patch a single Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.itemId The Item ID
+ * @param params.fields The fields to patch
+ * @returns The patched Item
+ */
+export function patch(
+  client: Client,
+  {
+    collectionId,
+    itemId,
+    fields,
+  }: {
+    fields: any;
+    itemId: string;
+    collectionId: string;
+  }
+) {
+  requireArgs({ collectionId, itemId });
+  const path = `/collections/${collectionId}/items/${itemId}`;
+  return client.patch<IItem>(path, { fields });
+}
+
+/**
+ * Remove a single Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.itemId The Item ID
+ * @returns The result from the removal
+ */
+export function remove(
+  client: Client,
+  {
+    collectionId,
+    itemId,
+  }: {
+    itemId: string;
+    collectionId: string;
+  }
+) {
+  requireArgs({ collectionId, itemId });
+  const path = `/collections/${collectionId}/items/${itemId}`;
+  return client.delete<IItemDelete>(path);
+}
+
+/**
+ * Unpublishes a list of Items
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.live Unpublish from the live site
+ * @returns The result of the unpublish
+ */
+export function unpublish(
+  client: Client,
+  {
+    collectionId,
+    itemIds,
+    live = false,
+  }: {
+    live?: boolean;
+    itemIds: string[];
+    collectionId: string;
+  }
+) {
+  requireArgs({ collectionId, itemIds });
+  const params = { live };
+  const data = { itemIds };
+  const url = `/collections/${collectionId}/items`;
+  const _params = { method: "DELETE", url, data, params };
+
+  // DELETE spec doesn't support body in delete
+  // RFC-9110 https://tools.ietf.org/html/rfc9110
+  return client.request<IDeletedItems>(_params);
+}
+
+/**
+ * Publishes a list of Items
+ * @param client The Webflow client
+ * @param params The request parameters
+ * @param params.collectionId The Collection ID
+ * @param params.itemIds The list of Item IDs to publish
+ * @param params.live Publish to live site
+ * @returns The result of the publish
+ */
+export function publish(
+  client: Client,
+  {
+    itemIds,
+    live = false,
+    collectionId,
+  }: { live?: boolean; itemIds: string[]; collectionId: string }
+) {
+  requireArgs({ collectionId, itemIds });
+  const params = { live };
+  const path = `/collections/${collectionId}/items/publish`;
+  return client.put<IPublishItems>(path, { itemIds }, { params });
+}