webflow-api 1.1.1 → 1.2.0

package/src/core/client.ts

@@ -1,76 +0,0 @@
-import { Axios } from "axios";
-import { DEFAULT_HOST, USER_AGENT, Options, RequestError } from "../core";
-
-/**************************************************************
- * Types
- **************************************************************/
-export type QueryString = Record<string, any>;
-export type PaginationFilter = { limit?: number; offset?: number };
-
-/**************************************************************
- * Interfaces
- ************************************************************* */
-export interface PaginatedData {
-  count: number;
-  limit: number;
-  offset: number;
-  total: number;
-}
-
-export interface WebflowOptions {
-  host?: string;
-  token?: string;
-  version?: string;
-  headers?: Record<string, string>;
-}
-
-/**************************************************************
- * Classes
- **************************************************************/
-export class Client extends Axios {
-  constructor({
-    host = DEFAULT_HOST,
-    headers = {},
-    version,
-    token,
-  }: Options = {}) {
-    super({
-      transformRequest: [(data) => JSON.stringify(data)],
-      baseURL: `https://api.${host}/`,
-      headers: {
-        "Content-Type": "application/json",
-        "User-Agent": USER_AGENT,
-        "Accept-Version": version,
-        ...headers,
-      },
-    });
-
-    if (token) this.token = token;
-
-    // check for webflow errors
-    this.defaults.transformResponse = [this.transformResponse];
-  }
-
-  /**
-   * Transforms JSON response to an object
-   * if the response is a Webflow error, it will throw an error
-   * @param data JSON response
-   * @returns response object
-   */
-  private transformResponse(data: any = {}) {
-    // parse json if string
-    if (String(data) === data) data = JSON.parse(data);
-    if (data.err) throw new RequestError(data);
-    return data;
-  }
-
-  // set the Authorization header
-  set token(value: string) {
-    this.defaults.headers["Authorization"] = `Bearer ${value}`;
-  }
-
-  // clear the Authorization header
-  clearToken() {
-    delete this.defaults.headers["Authorization"];
-  }
-}

package/src/core/options.ts

@@ -1,9 +0,0 @@
-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>;
-}

package/src/wrapper/collection.ts

@@ -1,115 +0,0 @@
-import { ResponseWrapper, ItemWrapper } from ".";
-import { Client, QueryString } from "../core";
-import { Collection, Item } from "../api";
-
-export class CollectionWrapper implements Collection.ICollection {
-  fields: Collection.CollectionField[];
-  singularName: string;
-  lastUpdated: string;
-  createdOn: string;
-  _id: string;
-  name: string;
-  slug: string;
-
-  constructor(private client: Client, collection: Collection.ICollection) {
-    Object.assign(this, collection);
-  }
-
-  /**************************************************************
-   * Static Methods
-   **************************************************************/
-
-  /**
-   * Get a single Collection
-   * @param client The Webflow client
-   * @param params The Collection information
-   * @param params.collectionId The Collection ID
-   * @returns A single Collection
-   */
-  static async getOne(
-    client: Client,
-    { collectionId }: { collectionId: string }
-  ) {
-    const res = await Collection.getOne(client, { collectionId });
-    const collection = new CollectionWrapper(client, res.data);
-    return ResponseWrapper<typeof collection>(res, collection);
-  }
-
-  /**
-   * Get a list of Collections
-   * @param client The Webflow client
-   * @param params1 The Site information
-   * @param params1.siteId The Site ID
-   * @param params The query parameters (optional)
-   * @returns A list of Collections
-   */
-  static async list(
-    client: Client,
-    { siteId }: { siteId: string },
-    params?: QueryString
-  ) {
-    const res = await Collection.list(client, { siteId }, params);
-    const collections = res.data.map((c) => new CollectionWrapper(client, c));
-    return ResponseWrapper<typeof collections>(res, collections);
-  }
-
-  /**************************************************************
-   * 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 }) {
-    return ItemWrapper.getOne(this.client, { itemId, collectionId: this._id });
-  }
-
-  /**
-   * 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(params?: QueryString) {
-    return ItemWrapper.list(this.client, { collectionId: this._id, ...params });
-  }
-
-  /**
-   * 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 }) {
-    return ItemWrapper.remove(this.client, { itemId, collectionId: this._id });
-  }
-
-  /**
-   * Create a new Item
-   * @param params The params for the request
-   * @param params.fields The Item fields to create
-   * @returns The created Item
-   */
-  async createItem(fields: any) {
-    return ItemWrapper.create(this.client, { collectionId: this._id, fields });
-  }
-
-  /**
-   * 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: any }) {
-    return ItemWrapper.update(this.client, {
-      collectionId: this._id,
-      itemId,
-      fields,
-    });
-  }
-}

package/src/wrapper/index.ts

@@ -1,6 +0,0 @@
-export * from "./membership";
-export * from "./collection";
-export * from "./response";
-export * from "./webhook";
-export * from "./site";
-export * from "./item";

package/src/wrapper/item.ts

@@ -1,218 +0,0 @@
-import { Client, QueryString, PaginationFilter } from "../core";
-import { ResponseWrapper } from ".";
-import { Item } from "../api";
-
-export class ItemWrapper implements Item.IItem {
-  "published-on"?: string | null;
-  "published-by"?: string | null;
-  "updated-on": string;
-  "created-on": string;
-  "updated-by": string;
-  "created-by": string;
-  _archived: boolean;
-  _draft: boolean;
-  _cid: string;
-  name: string;
-  slug: string;
-  _id: string;
-
-  constructor(private client: Client, item: Item.IItem) {
-    Object.assign(this, item);
-  }
-
-  /**************************************************************
-   * Static Methods
-   **************************************************************/
-
-  /**
-   * 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
-   */
-  static async create(
-    client: Client,
-    { collectionId, fields }: { collectionId: string; fields: any }
-  ) {
-    const res = await Item.create(client, { collectionId, fields });
-    const item = new ItemWrapper(client, res.data);
-    return ResponseWrapper<typeof item>(res, item);
-  }
-
-  /**
-   * 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
-   */
-  static async getOne(
-    client: Client,
-    itemParams: { collectionId: string; itemId: string }
-  ) {
-    const res = await Item.getOne(client, itemParams);
-    const item = new ItemWrapper(client, res.data.items[0]);
-    return ResponseWrapper<typeof item>(res, item);
-  }
-
-  /**
-   * 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
-   */
-  static async list(
-    client: Client,
-    { collectionId, limit, offset }: { collectionId: string } & PaginationFilter
-  ) {
-    const res = await Item.list(client, { collectionId, limit, offset });
-    const items = res.data.items.map((i) => new ItemWrapper(client, i));
-    return ResponseWrapper<typeof items>(res, items);
-  }
-
-  /**
-   * 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
-   */
-  static async remove(
-    client: Client,
-    { collectionId, itemId }: { collectionId: string; itemId: string }
-  ) {
-    const res = await Item.remove(client, { collectionId, itemId });
-    return ResponseWrapper<typeof res.data>(res);
-  }
-
-  /**
-   * 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
-   */
-  static async publish(
-    client: Client,
-    {
-      collectionId,
-      itemIds,
-      live,
-    }: { collectionId: string; itemIds: string[]; live: boolean }
-  ) {
-    const res = await Item.publish(client, { collectionId, itemIds, live });
-    return ResponseWrapper<typeof res.data>(res);
-  }
-
-  /**
-   * 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
-   */
-  static async unpublish(
-    client: Client,
-    {
-      collectionId,
-      itemIds,
-      live,
-    }: { collectionId: string; itemIds: string[]; live: boolean }
-  ) {
-    const res = await Item.unpublish(client, { collectionId, itemIds, live });
-    return ResponseWrapper<typeof res.data>(res);
-  }
-
-  /**
-   * 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
-   */
-  static async update(
-    client: Client,
-    {
-      collectionId,
-      itemId,
-      fields,
-    }: { collectionId: string; itemId: string; fields: any }
-  ) {
-    const res = await Item.update(client, {
-      collectionId,
-      fields,
-      itemId,
-    });
-
-    const item = new ItemWrapper(client, res.data);
-    return ResponseWrapper<typeof item>(res, item);
-  }
-
-  /**
-   * 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
-   */
-  static async patch(
-    client: Client,
-    {
-      collectionId,
-      itemId,
-      fields,
-    }: { collectionId: string; itemId: string; fields: any },
-    params?: QueryString
-  ) {
-    const res = await Item.patch(client, {
-      collectionId,
-      fields,
-      itemId,
-    });
-
-    const item = new ItemWrapper(client, res.data);
-    return ResponseWrapper<typeof item>(res, item);
-  }
-
-  /**************************************************************
-   * Instance Methods
-   **************************************************************/
-
-  /**
-   * Update a single Item
-   * @param fields The fields to update
-   * @returns The updated Item
-   */
-  update({ ...fields }) {
-    return ItemWrapper.update(this.client, {
-      collectionId: this._cid,
-      itemId: this._id,
-      fields,
-    });
-  }
-
-  /**
-   * Remove a single Item
-   * @returns The result from the removal
-   */
-  remove() {
-    return ItemWrapper.remove(this.client, {
-      collectionId: this._cid,
-      itemId: this._id,
-    });
-  }
-}

package/src/wrapper/membership.ts

@@ -1,138 +0,0 @@
-import { Client, PaginationFilter } from "../core";
-import { ResponseWrapper } from ".";
-import { Membership } from "../api";
-
-export class MembershipWrapper implements Membership.IUser {
-  emailVerified: boolean;
-  lastUpdated?: string;
-  createdOn: string;
-  _id: string;
-  data: any;
-
-  constructor(
-    private client: Client,
-    private siteId: string,
-    membership: Membership.IUser
-  ) {
-    Object.assign(this, membership);
-  }
-
-  /**************************************************************
-   * Static Methods
-   **************************************************************/
-
-  /**
-   * Get a single User
-   * @param client The Webflow client
-   * @param params The params for the request
-   * @param params.siteId The site ID
-   * @param params.userId The user ID
-   * @returns A single User
-   */
-  static async getOne(
-    client: Client,
-    { userId, siteId }: { siteId: string; userId: string }
-  ) {
-    const res = await Membership.getOne(client, { userId, siteId });
-    const user = ResponseWrapper<typeof res.data>(res);
-    return new MembershipWrapper(client, siteId, user);
-  }
-
-  /**
-   * Get a list of Users
-   * @param client The Webflow client
-   * @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)
-   * @returns A list of Users
-   */
-  static async list(
-    client: Client,
-    { siteId, limit, offset }: { siteId: string } & PaginationFilter
-  ) {
-    const res = await Membership.list(client, { siteId, limit, offset });
-    const users = res.data.users.map(
-      (u) => new MembershipWrapper(client, siteId, u)
-    );
-    return ResponseWrapper<typeof users>(res, users);
-  }
-
-  /**
-   * Update a User
-   * @param client The Webflow client
-   * @param params The params for the request
-   * @param params.siteId The site ID
-   * @param params.userId The user ID
-   * @param params.data The data to update
-   * @returns The updated User
-   */
-  static async update(
-    client: Client,
-    { userId, siteId, data }: { userId: string; siteId: string; data: any }
-  ) {
-    const res = await Membership.update(client, { userId, siteId, data });
-    const user = ResponseWrapper<typeof res.data>(res);
-    return new MembershipWrapper(client, siteId, user);
-  }
-
-  /**
-   * Invite a User to a site
-   * @param client The Webflow client
-   * @param params The params for the request
-   * @param params.siteId The site ID
-   * @param params.email The email address of the user to invite
-   * @returns The newly created User
-   */
-  static async invite(
-    client: Client,
-    { siteId, email }: { siteId: string; email: string }
-  ) {
-    const res = await Membership.invite(client, { siteId, email });
-    return ResponseWrapper<typeof res.data>(res);
-  }
-
-  /**
-   * Remove a User
-   * @param client The Webflow client
-   * @param params The params for the request
-   * @param params.siteId The site ID
-   * @param params.userId The user ID
-   * @returns The result of the remove
-   */
-  static async remove(
-    client: Client,
-    { siteId, userId }: { siteId: string; userId: string }
-  ) {
-    const res = await Membership.remove(client, { userId, siteId });
-    return ResponseWrapper<typeof res.data>(res);
-  }
-
-  /**************************************************************
-   * Instance Methods
-   **************************************************************/
-
-  /**
-   * Update a User
-   * @param data The data to update
-   * @returns The updated User
-   */
-  async update(data: any) {
-    return MembershipWrapper.update(this.client, {
-      siteId: this.siteId,
-      userId: this._id,
-      data,
-    });
-  }
-
-  /**
-   * Remove a User
-   * @returns The result of the remove
-   */
-  async remove() {
-    return MembershipWrapper.remove(this.client, {
-      siteId: this.siteId,
-      userId: this._id,
-    });
-  }
-}

package/src/wrapper/response.ts

@@ -1,25 +0,0 @@
-import { AxiosResponse } from "axios";
-
-export type MetaResponse<T> = T & {
-  _meta: {
-    rateLimit: {
-      limit: number;
-      remaining: number;
-    };
-  };
-};
-
-/**
- * Wraps an HTTP response with Webflow Rate Limiting information
- * @param response The HTTP response
- * @param data The data to use (defaults to response.data)
- * @returns The response with Webflow Rate Limiting information
- */
-export function ResponseWrapper<T>(response: AxiosResponse, data?: T) {
-  const limit = parseInt(response.headers["x-ratelimit-limit"], 10);
-  const remaining = parseInt(response.headers["x-ratelimit-remaining"], 10);
-
-  const result: MetaResponse<T> = data || response.data;
-  result._meta = { rateLimit: { limit, remaining } };
-  return result;
-}