webflow-api 1.1.2 → 1.2.1

package/src/api/item.ts

@@ -1,4 +1,5 @@
-import { Client, PaginatedData, requireArgs } from "../core";
+import { AxiosInstance } from "axios";
+import { PaginatedData, requireArgs, WebflowRecord } from "../core";
 
 /**************************************************************
  * Interfaces
@@ -40,192 +41,232 @@ export type PageinatedItems = PaginatedData & {
 };
 
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
 
-/**
- * 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);
-}
+export class Item extends WebflowRecord<IItem> implements 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;
 
-/**
- * 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 });
-}
+  /**************************************************************
+   * 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
- */
-export function create(
-  client: Client,
-  { collectionId, fields }: { fields: any; collectionId: string }
-) {
-  requireArgs({ collectionId });
-  const path = `/collections/${collectionId}/items`;
-  return client.post<IItem>(path, { fields });
-}
+  /**
+   * Get a single Item
+   * @param params The params for the request
+   * @param params.collectionId The Collection ID
+   * @param params.itemId The Item ID
+   * @param client The Axios client instance
+   * @returns A single Item
+   */
+  static getOne(
+    { collectionId, itemId }: { collectionId: string; itemId: string },
+    client: AxiosInstance,
+  ) {
+    requireArgs({ collectionId, itemId });
+    const path = `/collections/${collectionId}/items/${itemId}`;
+    // The API returns a paginated list with one record :(
+    return client.get<PageinatedItems>(path);
+  }
 
-/**
- * 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;
+  /**
+   * Get a list of Items
+   * @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)
+   * @param client The Axios client instance
+   * @returns A list of Items
+   */
+  static list(
+    { collectionId, limit, offset }: { collectionId: string; limit?: number; offset?: number },
+    client: AxiosInstance,
+  ) {
+    requireArgs({ collectionId });
+    const params = { limit, offset };
+    const path = `/collections/${collectionId}/items`;
+    return client.get<PageinatedItems>(path, { params });
   }
-) {
-  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;
+  /**
+   * Create a new Item
+   * @param params The params for the request
+   * @param params.collectionId The Collection ID
+   * @param params.fields The Item fields to create
+   * @param client The Axios client instance
+   * @returns The created Item
+   */
+  static create(
+    { collectionId, fields }: { fields: any; collectionId: string },
+    client: AxiosInstance,
+  ) {
+    requireArgs({ collectionId });
+    const path = `/collections/${collectionId}/items`;
+    return client.post<IItem>(path, { fields });
   }
-) {
-  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;
+  /**
+   * Update a single Item
+   * @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
+   * @param client The Axios client instance
+   * @returns The updated Item
+   */
+  static update(
+    {
+      collectionId,
+      itemId,
+      fields,
+    }: {
+      fields: any;
+      itemId: string;
+      collectionId: string;
+    },
+    client: AxiosInstance,
+  ) {
+    requireArgs({ collectionId, itemId });
+    const path = `/collections/${collectionId}/items/${itemId}`;
+    return client.put<IItem>(path, { fields });
   }
-) {
-  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;
+  /**
+   * Patch a single Item
+   * @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
+   * @param client The Axios client instance
+   * @returns The patched Item
+   */
+  static patch(
+    {
+      collectionId,
+      itemId,
+      fields,
+    }: {
+      fields: any;
+      itemId: string;
+      collectionId: string;
+    },
+    client: AxiosInstance,
+  ) {
+    requireArgs({ collectionId, itemId });
+    const path = `/collections/${collectionId}/items/${itemId}`;
+    return client.patch<IItem>(path, { fields });
   }
-) {
-  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 });
+  /**
+   * Remove a single Item
+   * @param params The params for the request
+   * @param params.collectionId The Collection ID
+   * @param params.itemId The Item ID
+   * @param client The Axios client instance
+   * @returns The result from the removal
+   */
+  static remove(
+    {
+      collectionId,
+      itemId,
+    }: {
+      itemId: string;
+      collectionId: string;
+    },
+    client: AxiosInstance,
+  ) {
+    requireArgs({ collectionId, itemId });
+    const path = `/collections/${collectionId}/items/${itemId}`;
+    return client.delete<IItemDelete>(path);
+  }
+
+  /**
+   * Unpublishes a list of Items
+   * @param params The params for the request
+   * @param params.collectionId The Collection ID
+   * @param params.live Unpublish from the live site
+   * @param client The Axios client instance
+   * @returns The result of the unpublish
+   */
+  static unpublish(
+    {
+      collectionId,
+      itemIds,
+      live = false,
+    }: {
+      live?: boolean;
+      itemIds: string[];
+      collectionId: string;
+    },
+    client: AxiosInstance,
+  ) {
+    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 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
+   * @param client The Axios client instance
+   * @returns The result of the publish
+   */
+  static publish(
+    {
+      itemIds,
+      live = false,
+      collectionId,
+    }: { live?: boolean; itemIds: string[]; collectionId: string },
+    client: AxiosInstance,
+  ) {
+    requireArgs({ collectionId, itemIds });
+    const params = { live };
+    const path = `/collections/${collectionId}/items/publish`;
+    return client.put<IPublishItems>(path, { itemIds }, { params });
+  }
+
+  /**************************************************************
+   * Instance Methods
+   **************************************************************/
+
+  /**
+   * Update a single Item
+   * @param fields The fields to update
+   * @returns The updated Item
+   */
+  async update({ ...fields }) {
+    const params = { collectionId: this._cid, itemId: this._id, fields };
+    const res = await Item.update(params, this.client);
+    return new Item(this.client, res);
+  }
+
+  /**
+   * Remove a single Item
+   * @returns The result from the removal
+   */
+  async remove() {
+    const params = { collectionId: this._cid, itemId: this._id };
+    const res = await Item.remove(params, this.client);
+    return res.data;
+  }
 }

package/src/api/meta.ts

@@ -1,4 +1,4 @@
-import { Client } from "../core";
+import { AxiosInstance } from "axios";
 
 /**************************************************************
  * Types
@@ -39,23 +39,24 @@ export interface IAuthentiationInfo {
 }
 
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
+export class Meta {
+  /**
+   * Get the authentication info for the current token
+   * @param client The Axios client instance
+   * @returns The authentication info
+   */
+  static info(client: AxiosInstance) {
+    return client.get<IAuthentiationInfo>("/info");
+  }
 
-/**
- * Get the authentication info for the current token
- * @param client The Webflow client
- * @returns The authentication info
- */
-export function info(client: Client) {
-  return client.get<IAuthentiationInfo>("/info");
-}
-
-/**
- * Get the authenticated user
- * @param client The Webflow client
- * @returns The authenticated user
- */
-export function user(client: Client) {
-  return client.get<IAuthenticatedUser>("/user");
+  /**
+   * Get the authenticated user
+   * @param client The Axios client instance
+   * @returns The authenticated user
+   */
+  static user(client: AxiosInstance) {
+    return client.get<IAuthenticatedUser>("/user");
+  }
 }

package/src/api/oauth.ts

@@ -1,4 +1,5 @@
-import { Client, requireArgs } from "../core";
+import { AxiosInstance } from "axios";
+import { requireArgs } from "../core";
 
 /**************************************************************
  * Interfaces
@@ -35,85 +36,81 @@ export interface IRevokeToken {
 }
 
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
 
-/**
- * Get the URL to authorize a user
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.client_id The OAuth client ID
- * @param params.scope The scope (optional)
- * @param params.state The state (optional)
- * @param params.redirect_uri The redirect URI (optional)
- * @param params.response_type The response type (default: code)
- * @returns The URL to authorize a user
- */
-export function authorizeUrl(
-  client: Client,
-  {
-    response_type = "code",
-    redirect_uri,
-    client_id,
-    state,
-    scope,
-  }: IAuthorizeUrlParams
-) {
-  requireArgs({ client_id });
+export class OAuth {
+  /**
+   * Get the URL to authorize a user
+   * @param params The params for the request
+   * @param params.client_id The OAuth client ID
+   * @param params.scope The scope (optional)
+   * @param params.state The state (optional)
+   * @param params.redirect_uri The redirect URI (optional)
+   * @param params.response_type The response type (default: code)
+   * @param client The Axios client instance
+   * @returns The URL to authorize a user
+   */
+  static authorizeUrl(
+    { response_type = "code", redirect_uri, client_id, state, scope }: IAuthorizeUrlParams,
+    client: AxiosInstance,
+  ) {
+    requireArgs({ client_id });
 
-  const params = { response_type, client_id };
-  if (redirect_uri) params["redirect_uri"] = redirect_uri;
-  if (state) params["state"] = state;
-  if (scope) params["scope"] = scope;
+    const params = { response_type, client_id };
+    if (redirect_uri) params["redirect_uri"] = redirect_uri;
+    if (state) params["state"] = state;
+    if (scope) params["scope"] = scope;
 
-  const url = "/oauth/authorize";
-  return client.getUri({ url, method: "GET", params });
-}
+    const url = "/oauth/authorize";
+    return client.getUri({ url, method: "GET", params });
+  }
 
-/**
- * Get an access token
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.code The OAuth code
- * @param params.client_id The OAuth client ID
- * @param params.client_secret The OAuth client secret
- * @param params.redirect_uri The redirect URI (optional)
- * @param params.grant_type The grant type (default: "authorization_code")
- * @returns An access token
- */
-export function accessToken(
-  client: Client,
-  {
-    grant_type = "authorization_code",
-    client_secret,
-    redirect_uri,
-    client_id,
-    code,
-  }: IAccessTokenParams
-) {
-  requireArgs({ client_id, client_secret, code });
+  /**
+   * Get an access token
+   * @param params The params for the request
+   * @param params.code The OAuth code
+   * @param params.client_id The OAuth client ID
+   * @param params.client_secret The OAuth client secret
+   * @param params.redirect_uri The redirect URI (optional)
+   * @param params.grant_type The grant type (default: "authorization_code")
+   * @param client The Axios client instance
+   * @returns An access token
+   */
+  static accessToken(
+    {
+      grant_type = "authorization_code",
+      client_secret,
+      redirect_uri,
+      client_id,
+      code,
+    }: IAccessTokenParams,
+    client: AxiosInstance,
+  ) {
+    requireArgs({ client_id, client_secret, code });
 
-  const path = "/oauth/access_token";
-  const data = { client_secret, redirect_uri, grant_type, client_id, code };
-  return client.post<IAccessToken>(path, data);
-}
+    const path = "/oauth/access_token";
+    const data = { client_secret, redirect_uri, grant_type, client_id, code };
+    return client.post<IAccessToken>(path, data);
+  }
 
-/**
- * Revoke an access token
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.client_id The OAuth client ID
- * @param params.client_secret The OAuth client secret
- * @param params.access_token The OAuth access token
- * @returns The result of the revoke
- */
-export function revokeToken(
-  client: Client,
-  { client_secret, access_token, client_id }: IRevokeTokenParams
-) {
-  requireArgs({ client_id, client_secret, access_token });
+  /**
+   * Revoke an access token
+   * @param params The params for the request
+   * @param params.client_id The OAuth client ID
+   * @param params.client_secret The OAuth client secret
+   * @param params.access_token The OAuth access token
+   * @param client The Axios client instance
+   * @returns The result of the revoke
+   */
+  static revokeToken(
+    { client_secret, access_token, client_id }: IRevokeTokenParams,
+    client: AxiosInstance,
+  ) {
+    requireArgs({ client_id, client_secret, access_token });
 
-  const path = "/oauth/revoke_authorization";
-  const data = { client_secret, access_token, client_id };
-  return client.post<IRevokeToken>(path, data);
+    const path = "/oauth/revoke_authorization";
+    const data = { client_secret, access_token, client_id };
+    return client.post<IRevokeToken>(path, data);
+  }
 }