webflow-api 1.1.2 → 1.2.1

package/dist/wrapper/site.js

@@ -1,191 +0,0 @@
-"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);
-    }
-    /**
-     * Get a list of Users
-     * @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 Users
-     */
-    async users({ limit, offset } = {}) {
-        return _1.MembershipWrapper.list(this.client, {
-            siteId: this._id,
-            limit,
-            offset,
-        });
-    }
-    /**
-     * Get a single User
-     * @param params The params for the request
-     * @param params.userId The user ID
-     * @returns A single User
-     */
-    async user({ userId }) {
-        return _1.MembershipWrapper.getOne(this.client, { siteId: this._id, userId });
-    }
-    /**
-     * Invite a User to a site
-     * @param params The params for the request
-     * @param params.email The email address of the user to invite
-     * @returns The newly created User
-     */
-    async inviteUser({ email }) {
-        return _1.MembershipWrapper.invite(this.client, { siteId: this._id, email });
-    }
-    /**
-     * Get a list of Access Groups
-     * @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 Access Groups
-     */
-    async accessGroups({ limit, offset, } = {}) {
-        return _1.MembershipWrapper.accessGroups(this.client, {
-            siteId: this._id,
-            limit,
-            offset,
-        });
-    }
-    /**
-     * Remove a User
-     * @param params The params for the request
-     * @param params.userId The user ID
-     * @returns The result of the remove
-     */
-    async removeUser({ userId }) {
-        return _1.MembershipWrapper.remove(this.client, { siteId: this._id, userId });
-    }
-}
-exports.SiteWrapper = SiteWrapper;

package/dist/wrapper/webhook.d.ts

@@ -1,78 +0,0 @@
-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

@@ -1,82 +0,0 @@
-"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/src/api/membership.ts

@@ -1,155 +0,0 @@
-import { Client, PaginatedData, requireArgs } from "../core";
-
-/**************************************************************
- * Interfaces
- **************************************************************/
-export interface IUser {
-  emailVerified: boolean;
-  lastUpdated?: string;
-  createdOn: string;
-  _id: string;
-  data: any;
-}
-
-export interface IAccessGroup {
-  _id: string;
-  name: string;
-  shortId: string;
-  slug: string;
-  createdOn: string;
-}
-
-export interface IUserDelete {
-  deleted: number;
-}
-
-/**************************************************************
- * Types
- **************************************************************/
-export type PaginatedUsers = PaginatedData & {
-  users: IUser[];
-};
-
-export type PaginatedAccessGroups = PaginatedData & {
-  accessGroups: IAccessGroup[];
-};
-
-export type UserIdParam = { siteId: string; userId: string };
-
-/**************************************************************
- * Functions
- **************************************************************/
-
-/**
- * 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
- */
-export function list(
-  client: Client,
-  { siteId, limit, offset }: { siteId: string; limit?: number; offset?: number }
-) {
-  requireArgs({ siteId });
-  const params = { limit, offset };
-  const path = `/sites/${siteId}/users`;
-  return client.get<PaginatedUsers>(path, { params });
-}
-
-/**
- * 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
- */
-export function getOne(
-  client: Client,
-  { siteId, userId }: { siteId: string; userId: string }
-) {
-  requireArgs({ siteId, userId });
-  const path = `/sites/${siteId}/users/${userId}`;
-  return client.get<IUser>(path);
-}
-
-/**
- * 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
- */
-export function update(
-  client: Client,
-  {
-    siteId,
-    userId,
-    ...data
-  }: {
-    siteId: string;
-    userId: string;
-  }
-) {
-  requireArgs({ siteId, userId });
-  const path = `/sites/${siteId}/users/${userId}`;
-  return client.patch<IUser>(path, data);
-}
-
-/**
- * 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
- */
-export async function invite(
-  client: Client,
-  { siteId, email }: { siteId: string; email: string }
-) {
-  requireArgs({ siteId, email });
-  const path = `/sites/${siteId}/users/invite`;
-  return client.post<IUser>(path, { email });
-}
-
-/**
- * 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
- */
-export function remove(
-  client: Client,
-  { siteId, userId }: { siteId: string; userId: string }
-) {
-  requireArgs({ siteId, userId });
-  const path = `/sites/${siteId}/users/${userId}`;
-  return client.delete<IUserDelete>(path);
-}
-
-/**
- * Get a list of Access Groups
- * @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 Access Groups
- */
-export function accessGroups(
-  client: Client,
-  { siteId, limit, offset }: { siteId: string; limit?: number; offset?: number }
-) {
-  requireArgs({ siteId });
-  const params = { limit, offset };
-  const path = `/sites/${siteId}/users/accessgroups`;
-  return client.get<PaginatedAccessGroups>(path, { params });
-}

package/src/core/client.ts

@@ -1,82 +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;
-}
-
-/**************************************************************
- * Functions
- **************************************************************/
-
-/**
- * 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
- */
-function transformResponse(data: any = {}) {
-  // parse json if string
-  if (String(data) === data) data = JSON.parse(data);
-
-  // throw an error if Webflow returns an error obejct
-  if (data.err) throw new RequestError(data);
-  return data;
-}
-
-/**
- * Transforms POST/PUT/PATCH request data to JSON
- * @param data A JavaScript object
- * @returns JSON string
- */
-function transformRequest(data: any = {}) {
-  return JSON.stringify(data);
-}
-
-/**************************************************************
- * Classes
- **************************************************************/
-export class Client extends Axios {
-  constructor({
-    host = DEFAULT_HOST,
-    headers = {},
-    version,
-    token,
-  }: Options = {}) {
-    super({
-      transformRequest: [transformRequest],
-      transformResponse: [transformResponse],
-      baseURL: `https://api.${host}/`,
-      headers: {
-        "Content-Type": "application/json",
-        "User-Agent": USER_AGENT,
-        "Accept-Version": version,
-        ...headers,
-      },
-    });
-
-    if (token) this.token = token;
-  }
-
-  // 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>;
-}