webflow-api 1.0.2 → 1.1.0

package/dist/api/oauth.d.ts

@@ -0,0 +1,67 @@
+import { Client } from "../core";
+/**************************************************************
+ * Interfaces
+ **************************************************************/
+export interface IAuthorizeUrlParams {
+    state?: string;
+    scope?: string;
+    client_id: string;
+    redirect_uri?: string;
+    response_type?: string;
+}
+export interface IRevokeTokenParams {
+    client_secret: string;
+    access_token: string;
+    client_id: string;
+}
+export interface IAccessTokenParams {
+    code: string;
+    client_id: string;
+    grant_type?: string;
+    client_secret: string;
+    redirect_uri?: string;
+}
+export interface IAccessToken {
+    token_type: string;
+    access_token: string;
+}
+export interface IRevokeToken {
+    didRevoke: boolean;
+}
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * 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 declare function authorizeUrl(client: Client, { response_type, redirect_uri, client_id, state, scope, }: IAuthorizeUrlParams): string;
+/**
+ * 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 declare function accessToken(client: Client, { grant_type, client_secret, redirect_uri, client_id, code, }: IAccessTokenParams): Promise<import("axios").AxiosResponse<IAccessToken, any>>;
+/**
+ * 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 declare function revokeToken(client: Client, { client_secret, access_token, client_id }: IRevokeTokenParams): Promise<import("axios").AxiosResponse<IRevokeToken, any>>;

package/dist/api/oauth.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.revokeToken = exports.accessToken = exports.authorizeUrl = void 0;
+const core_1 = require("../core");
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * 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
+ */
+function authorizeUrl(client, { response_type = "code", redirect_uri, client_id, state, scope, }) {
+    (0, core_1.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 url = "/oauth/authorize";
+    return client.getUri({ url, method: "GET", params });
+}
+exports.authorizeUrl = authorizeUrl;
+/**
+ * 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
+ */
+function accessToken(client, { grant_type = "authorization_code", client_secret, redirect_uri, client_id, code, }) {
+    (0, core_1.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(path, data);
+}
+exports.accessToken = accessToken;
+/**
+ * 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
+ */
+function revokeToken(client, { client_secret, access_token, client_id }) {
+    (0, core_1.requireArgs)({ client_id, client_secret, access_token });
+    const path = "/oauth/revoke_authorization";
+    const data = { client_secret, access_token, client_id };
+    return client.post(path, data);
+}
+exports.revokeToken = revokeToken;

package/dist/api/site.d.ts

@@ -0,0 +1,65 @@
+import { Client, QueryString } from "../core";
+/**************************************************************
+ * Interfaces
+ *************************************************************/
+export interface IDomain {
+    _id: string;
+    name: string;
+}
+export interface ISite {
+    lastPublished: string;
+    previewUrl: string;
+    createdOn: string;
+    shortName: string;
+    timezone: string;
+    database: string;
+    name: string;
+    _id: string;
+}
+export interface IPublishSite {
+    queued: boolean;
+}
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * Get a list of Sites
+ * @param client The Webflow client
+ * @param params The query string parameters (optional)
+ * @returns
+ */
+export declare function list(client: Client, params?: QueryString): Promise<import("axios").AxiosResponse<ISite[], any>>;
+/**
+ * Get a single Site
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.params The query string parameters (optional)
+ * @returns A single Site
+ */
+export declare function getOne(client: Client, { siteId, params }: {
+    siteId: string;
+    params?: QueryString;
+}): Promise<import("axios").AxiosResponse<ISite, any>>;
+/**
+ * Publish a site
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.domains The domains to publish to
+ * @returns The publish result
+ */
+export declare function publish(client: Client, { siteId, domains }: {
+    siteId: string;
+    domains: string[];
+}): Promise<import("axios").AxiosResponse<IPublishSite, any>>;
+/**
+ * Get a list of domains for a site
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @returns A list of domains
+ */
+export declare function domains(client: Client, { siteId }: {
+    siteId: string;
+}): Promise<import("axios").AxiosResponse<IDomain[], any>>;

package/dist/api/site.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.domains = exports.publish = exports.getOne = exports.list = void 0;
+const core_1 = require("../core");
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * Get a list of Sites
+ * @param client The Webflow client
+ * @param params The query string parameters (optional)
+ * @returns
+ */
+function list(client, params) {
+    const path = "/sites";
+    return client.get(path, { params });
+}
+exports.list = list;
+/**
+ * Get a single Site
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.params The query string parameters (optional)
+ * @returns A single Site
+ */
+function getOne(client, { siteId, params }) {
+    (0, core_1.requireArgs)({ siteId });
+    const path = `/sites/${siteId}`;
+    return client.get(path, { params });
+}
+exports.getOne = getOne;
+/**
+ * Publish a site
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.domains The domains to publish to
+ * @returns The publish result
+ */
+function publish(client, { siteId, domains }) {
+    (0, core_1.requireArgs)({ siteId, domains });
+    const path = `/sites/${siteId}/publish`;
+    return client.post(path, { domains });
+}
+exports.publish = publish;
+/**
+ * Get a list of domains for a site
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @returns A list of domains
+ */
+function domains(client, { siteId }) {
+    (0, core_1.requireArgs)({ siteId });
+    const path = `/sites/${siteId}/domains`;
+    return client.get(path);
+}
+exports.domains = domains;

package/dist/api/webhook.d.ts

@@ -0,0 +1,80 @@
+import { Client, QueryString } from "../core";
+/**************************************************************
+ * Types
+ **************************************************************/
+export declare type TriggerType = "form_submission" | "site_publish" | "ecomm_new_order" | "ecomm_order_changed" | "ecomm_inventory_changed" | "collection_item_created" | "collection_item_changed" | "collection_item_deleted" | string;
+export declare type Filter = {
+    name: string;
+};
+/**************************************************************
+ * Interfaces
+ **************************************************************/
+export interface IWebhook {
+    triggerType: TriggerType;
+    triggerId: string;
+    createdOn: string;
+    lastUsed?: string;
+    site: string;
+    _id: string;
+    filter?: {
+        name: string;
+    };
+}
+export interface IRemoveResult {
+    deleted: number;
+}
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * Get a list of Webhooks
+ * @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 Webhooks
+ */
+export declare function list(client: Client, { siteId }: {
+    siteId: string;
+}, params?: QueryString): Promise<import("axios").AxiosResponse<IWebhook[], any>>;
+/**
+ * Get a single Webhook
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.webhookId The webhook ID
+ * @returns A single Webhook
+ */
+export declare function getOne(client: Client, { siteId, webhookId }: {
+    siteId: string;
+    webhookId: string;
+}): Promise<import("axios").AxiosResponse<IWebhook, any>>;
+/**
+ * Create a new Webhook
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.url The URL to send the webhook to
+ * @param params.triggerType The event to trigger the webhook
+ * @param params.filter The filter to apply to the webhook (optional: form_submission only)
+ * @param params.params The query string parameters (optional)
+ * @returns The created webhook
+ */
+export declare function create(client: Client, { triggerType, siteId, filter, url, }: {
+    url: string;
+    siteId: string;
+    filter?: Filter;
+    triggerType: TriggerType;
+}): Promise<import("axios").AxiosResponse<IWebhook, any>>;
+/**
+ * Remove a Webhook
+ * @param client The Webflow client
+ * @param params The query string parameters (optional)
+ * @param params.webhookId The Webhook ID
+ * @param params.siteId The Site ID
+ * @returns The result of the removal
+ */
+export declare function remove(client: Client, { siteId, webhookId }: {
+    siteId: string;
+    webhookId: string;
+}): Promise<import("axios").AxiosResponse<IRemoveResult, any>>;

package/dist/api/webhook.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.remove = exports.create = exports.getOne = exports.list = void 0;
+const core_1 = require("../core");
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * Get a list of Webhooks
+ * @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 Webhooks
+ */
+function list(client, { siteId }, params) {
+    (0, core_1.requireArgs)({ siteId });
+    const path = `/sites/${siteId}/webhooks`;
+    return client.get(path, { params });
+}
+exports.list = list;
+/**
+ * Get a single Webhook
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.webhookId The webhook ID
+ * @returns A single Webhook
+ */
+function getOne(client, { siteId, webhookId }) {
+    (0, core_1.requireArgs)({ siteId, webhookId });
+    const path = `/sites/${siteId}/webhooks/${webhookId}`;
+    return client.get(path);
+}
+exports.getOne = getOne;
+/**
+ * Create a new Webhook
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.url The URL to send the webhook to
+ * @param params.triggerType The event to trigger the webhook
+ * @param params.filter The filter to apply to the webhook (optional: form_submission only)
+ * @param params.params The query string parameters (optional)
+ * @returns The created webhook
+ */
+function create(client, { triggerType, siteId, filter, url, }) {
+    (0, core_1.requireArgs)({ siteId, triggerType, url });
+    const path = `/sites/${siteId}/webhooks`;
+    const data = { triggerType, url, filter };
+    return client.post(path, data);
+}
+exports.create = create;
+/**
+ * Remove a Webhook
+ * @param client The Webflow client
+ * @param params The query string parameters (optional)
+ * @param params.webhookId The Webhook ID
+ * @param params.siteId The Site ID
+ * @returns The result of the removal
+ */
+function remove(client, { siteId, webhookId }) {
+    (0, core_1.requireArgs)({ siteId, webhookId });
+    const path = `/sites/${siteId}/webhooks/${webhookId}`;
+    return client.delete(path);
+}
+exports.remove = remove;

package/dist/core/client.d.ts

@@ -0,0 +1,40 @@
+import { Axios } from "axios";
+import { Options } from "../core";
+/**************************************************************
+ * Types
+ **************************************************************/
+export declare type QueryString = Record<string, any>;
+export declare 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 declare class Client extends Axios {
+    constructor({ host, headers, version, token, }?: Options);
+    /**
+     * 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;
+    set token(value: string);
+    clearToken(): void;
+}

package/dist/core/client.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const axios_1 = require("axios");
+const core_1 = require("../core");
+/**************************************************************
+ * Classes
+ **************************************************************/
+class Client extends axios_1.Axios {
+    constructor({ host = core_1.DEFAULT_HOST, headers = {}, version, token, } = {}) {
+        super({
+            transformRequest: [(data) => JSON.stringify(data)],
+            baseURL: `https://api.${host}/`,
+            headers: {
+                "Content-Type": "application/json",
+                "User-Agent": core_1.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
+     */
+    transformResponse(data = {}) {
+        // parse json if string
+        if (String(data) === data)
+            data = JSON.parse(data);
+        if (data.err)
+            throw new core_1.RequestError(data);
+        return data;
+    }
+    // set the Authorization header
+    set token(value) {
+        this.defaults.headers["Authorization"] = `Bearer ${value}`;
+    }
+    // clear the Authorization header
+    clearToken() {
+        delete this.defaults.headers["Authorization"];
+    }
+}
+exports.Client = Client;

package/dist/core/error.d.ts

@@ -0,0 +1,19 @@
+export interface IRequestError {
+    msg: string;
+    code: number;
+    name: string;
+    path: string;
+    err: string;
+}
+export declare class RequestError extends Error implements IRequestError {
+    msg: string;
+    code: number;
+    name: string;
+    path: string;
+    err: string;
+    constructor(error: IRequestError);
+}
+export declare class ArgumentError extends Error {
+    constructor(name: string);
+}
+export declare function requireArgs(args: object): void;

package/dist/core/error.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireArgs = exports.ArgumentError = exports.RequestError = void 0;
+class RequestError extends Error {
+    constructor(error) {
+        super(error.err ? error.err : "Unknown error occured");
+        Object.assign(this, error);
+    }
+}
+exports.RequestError = RequestError;
+class ArgumentError extends Error {
+    constructor(name) {
+        super(`Argument '${name}' is required but was not present`);
+    }
+}
+exports.ArgumentError = ArgumentError;
+function requireArgs(args) {
+    for (const key in args) {
+        if (!args[key])
+            throw new ArgumentError(key);
+    }
+}
+exports.requireArgs = requireArgs;

package/dist/core/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./client";
+export * from "./error";
+export * from "./options";

package/dist/core/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);
+__exportStar(require("./error"), exports);
+__exportStar(require("./options"), exports);

package/dist/core/options.d.ts

@@ -0,0 +1,8 @@
+export declare const DEFAULT_HOST = "webflow.com";
+export declare const USER_AGENT = "Webflow Javascript SDK / 1.0";
+export interface Options {
+    host?: string;
+    token?: string;
+    version?: string;
+    headers?: Record<string, string>;
+}

package/dist/core/options.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.USER_AGENT = exports.DEFAULT_HOST = void 0;
+exports.DEFAULT_HOST = "webflow.com";
+exports.USER_AGENT = "Webflow Javascript SDK / 1.0";

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,10 +1,3 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _Webflow = require("./Webflow");
-var _default = _Webflow.Webflow;
-exports.default = _default;
-module.exports = exports.default;
+const webflow_1 = require("./webflow");
+module.exports = webflow_1.Webflow;