webflow-api 2.3.1 → 2.3.5

package/core/fetcher/Fetcher.js

@@ -1,4 +1,27 @@
 "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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -13,7 +36,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetcher = void 0;
-const form_data_1 = __importDefault(require("form-data"));
 const qs_1 = __importDefault(require("qs"));
 const runtime_1 = require("../runtime");
 const INITIAL_RETRY_DELAY = 1;
@@ -37,35 +59,58 @@ function fetcherImpl(args) {
             ? `${args.url}?${qs_1.default.stringify(args.queryParameters, { arrayFormat: "repeat" })}`
             : args.url;
         let body = undefined;
-        if (args.body instanceof form_data_1.default) {
-            // @ts-expect-error
-            body = args.body;
-        }
-        else if (args.body instanceof Uint8Array) {
-            body = args.body;
+        const maybeStringifyBody = (body) => {
+            if (body instanceof Uint8Array) {
+                return body;
+            }
+            else if (args.contentType === "application/x-www-form-urlencoded" && typeof args.body === "string") {
+                return args.body;
+            }
+            else {
+                return JSON.stringify(body);
+            }
+        };
+        if (runtime_1.RUNTIME.type === "node") {
+            if (args.body instanceof (yield Promise.resolve().then(() => __importStar(require("formdata-node")))).FormData) {
+                // @ts-expect-error
+                body = args.body;
+            }
+            else {
+                body = maybeStringifyBody(args.body);
+            }
         }
         else {
-            body = JSON.stringify(args.body);
+            if (args.body instanceof (yield Promise.resolve().then(() => __importStar(require("form-data")))).default) {
+                // @ts-expect-error
+                body = args.body;
+            }
+            else {
+                body = maybeStringifyBody(args.body);
+            }
         }
-        // In Node.js environments, the SDK always uses`node-fetch`.
-        // If not in Node.js the SDK uses global fetch if available,
-        // and falls back to node-fetch.
-        const fetchFn = runtime_1.RUNTIME.type === "node" ? require("node-fetch") : typeof fetch == "function" ? fetch : require("node-fetch");
+        const fetchFn = yield getFetchFn();
         const makeRequest = () => __awaiter(this, void 0, void 0, function* () {
-            const controller = new AbortController();
-            let abortId = undefined;
+            const signals = [];
+            // Add timeout signal
+            let timeoutAbortId = undefined;
             if (args.timeoutMs != null) {
-                abortId = setTimeout(() => controller.abort(), args.timeoutMs);
+                const { signal, abortId } = getTimeoutSignal(args.timeoutMs);
+                timeoutAbortId = abortId;
+                signals.push(signal);
+            }
+            // Add arbitrary signal
+            if (args.abortSignal != null) {
+                signals.push(args.abortSignal);
             }
             const response = yield fetchFn(url, {
                 method: args.method,
                 headers,
                 body,
-                signal: controller.signal,
+                signal: anySignal(signals),
                 credentials: args.withCredentials ? "include" : undefined,
             });
-            if (abortId != null) {
-                clearTimeout(abortId);
+            if (timeoutAbortId != null) {
+                clearTimeout(timeoutAbortId);
             }
             return response;
         });
@@ -91,6 +136,9 @@ function fetcherImpl(args) {
             else if (response.body != null && args.responseType === "streaming") {
                 body = response.body;
             }
+            else if (response.body != null && args.responseType === "text") {
+                body = yield response.text();
+            }
             else {
                 const text = yield response.text();
                 if (text.length > 0) {
@@ -128,7 +176,16 @@ function fetcherImpl(args) {
             }
         }
         catch (error) {
-            if (error instanceof Error && error.name === "AbortError") {
+            if (args.abortSignal != null && args.abortSignal.aborted) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: "The user aborted a request",
+                    },
+                };
+            }
+            else if (error instanceof Error && error.name === "AbortError") {
                 return {
                     ok: false,
                     error: {
@@ -155,4 +212,54 @@ function fetcherImpl(args) {
         }
     });
 }
+const TIMEOUT = "timeout";
+function getTimeoutSignal(timeoutMs) {
+    const controller = new AbortController();
+    const abortId = setTimeout(() => controller.abort(TIMEOUT), timeoutMs);
+    return { signal: controller.signal, abortId };
+}
+/**
+ * Returns an abort signal that is getting aborted when
+ * at least one of the specified abort signals is aborted.
+ *
+ * Requires at least node.js 18.
+ */
+function anySignal(...args) {
+    // Allowing signals to be passed either as array
+    // of signals or as multiple arguments.
+    const signals = (args.length === 1 && Array.isArray(args[0]) ? args[0] : args);
+    const controller = new AbortController();
+    for (const signal of signals) {
+        if (signal.aborted) {
+            // Exiting early if one of the signals
+            // is already aborted.
+            controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason);
+            break;
+        }
+        // Listening for signals and removing the listeners
+        // when at least one symbol is aborted.
+        signal.addEventListener("abort", () => controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason), {
+            signal: controller.signal,
+        });
+    }
+    return controller.signal;
+}
+/**
+ * Returns a fetch function based on the runtime
+ */
+function getFetchFn() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // In Node.js environments, the SDK always uses`node-fetch`.
+        if (runtime_1.RUNTIME.type === "node") {
+            return (yield Promise.resolve().then(() => __importStar(require("node-fetch")))).default;
+        }
+        // Otherwise the SDK uses global fetch if available,
+        // and falls back to node-fetch.
+        if (typeof fetch == "function") {
+            return fetch;
+        }
+        // Defaults to node `node-fetch` if global fetch isn't available
+        return (yield Promise.resolve().then(() => __importStar(require("node-fetch")))).default;
+    });
+}
 exports.fetcher = fetcherImpl;

package/core/runtime/runtime.d.ts

@@ -3,6 +3,6 @@
  */
 export declare const RUNTIME: Runtime;
 export interface Runtime {
-    type: "browser" | "web-worker" | "deno" | "bun" | "node" | "react-native" | "unknown";
+    type: "browser" | "web-worker" | "deno" | "bun" | "node" | "react-native" | "unknown" | "workerd";
     version?: string;
 }

package/core/runtime/runtime.js

@@ -1,5 +1,5 @@
 "use strict";
-var _a, _b, _c, _d;
+var _a, _b, _c, _d, _e;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RUNTIME = void 0;
 /**
@@ -37,6 +37,11 @@ const isNode = typeof process !== "undefined" &&
  * https://github.com/facebook/react-native/blob/main/packages/react-native/Libraries/Core/setUpNavigator.js
  */
 const isReactNative = typeof navigator !== "undefined" && (navigator === null || navigator === void 0 ? void 0 : navigator.product) === "ReactNative";
+/**
+ * A constant that indicates whether the environment the code is running is Cloudflare.
+ * https://developers.cloudflare.com/workers/runtime-apis/web-standards/#navigatoruseragent
+ */
+const isCloudflare = typeof globalThis !== "undefined" && ((_e = globalThis === null || globalThis === void 0 ? void 0 : globalThis.navigator) === null || _e === void 0 ? void 0 : _e.userAgent) === "Cloudflare-Workers";
 /**
  * A constant that indicates which environment and version the SDK is running in.
  */
@@ -48,6 +53,11 @@ function evaluateRuntime() {
             version: window.navigator.userAgent,
         };
     }
+    if (isCloudflare) {
+        return {
+            type: "workerd",
+        };
+    }
     if (isWebWorker) {
         return {
             type: "web-worker",

package/core/schemas/builders/object/object.js

@@ -39,7 +39,7 @@ function object(schemas) {
                     valueSchema,
                 };
                 rawKeyToProperty[rawKey] = property;
-                if (yield isSchemaRequired(valueSchema)) {
+                if (isSchemaRequired(valueSchema)) {
                     requiredKeys.push(rawKey);
                 }
             }
@@ -70,7 +70,7 @@ function object(schemas) {
                 const valueSchema = (0, property_1.isProperty)(schemaOrObjectProperty)
                     ? schemaOrObjectProperty.valueSchema
                     : schemaOrObjectProperty;
-                if (yield isSchemaRequired(valueSchema)) {
+                if (isSchemaRequired(valueSchema)) {
                     requiredKeys.push(parsedKey);
                 }
             }
@@ -240,19 +240,15 @@ function validateAndTransformExtendedObject({ extensionKeys, value, transformBas
     });
 }
 function isSchemaRequired(schema) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return !(yield isSchemaOptional(schema));
-    });
+    return !isSchemaOptional(schema);
 }
 function isSchemaOptional(schema) {
-    return __awaiter(this, void 0, void 0, function* () {
-        switch (yield schema.getType()) {
-            case Schema_1.SchemaType.ANY:
-            case Schema_1.SchemaType.UNKNOWN:
-            case Schema_1.SchemaType.OPTIONAL:
-                return true;
-            default:
-                return false;
-        }
-    });
+    switch (schema.getType()) {
+        case Schema_1.SchemaType.ANY:
+        case Schema_1.SchemaType.UNKNOWN:
+        case Schema_1.SchemaType.OPTIONAL:
+            return true;
+        default:
+            return false;
+    }
 }

package/dist/Client.d.ts

@@ -23,8 +23,12 @@ export declare namespace WebflowClient {
         accessToken: core.Supplier<core.BearerToken>;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
     }
 }
 export declare class WebflowClient {

package/dist/api/errors/BadRequestError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 export declare class BadRequestError extends errors.WebflowError {
     constructor(body?: unknown);
 }

package/dist/api/errors/BadRequestError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BadRequestError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class BadRequestError extends errors.WebflowError {
     constructor(body) {
         super({

package/dist/api/errors/ConflictError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 export declare class ConflictError extends errors.WebflowError {
     constructor(body?: unknown);
 }

package/dist/api/errors/ConflictError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConflictError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class ConflictError extends errors.WebflowError {
     constructor(body) {
         super({

package/dist/api/errors/ForbiddenError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 export declare class ForbiddenError extends errors.WebflowError {
     constructor(body?: unknown);
 }

package/dist/api/errors/ForbiddenError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForbiddenError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class ForbiddenError extends errors.WebflowError {
     constructor(body) {
         super({

package/dist/api/errors/InternalServerError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 export declare class InternalServerError extends errors.WebflowError {
     constructor(body?: unknown);
 }

package/dist/api/errors/InternalServerError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalServerError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class InternalServerError extends errors.WebflowError {
     constructor(body) {
         super({

package/dist/api/errors/NotFoundError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 export declare class NotFoundError extends errors.WebflowError {
     constructor(body?: unknown);
 }

package/dist/api/errors/NotFoundError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFoundError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class NotFoundError extends errors.WebflowError {
     constructor(body) {
         super({

package/dist/api/errors/TooManyRequestsError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 export declare class TooManyRequestsError extends errors.WebflowError {
     constructor(body?: unknown);
 }

package/dist/api/errors/TooManyRequestsError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TooManyRequestsError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class TooManyRequestsError extends errors.WebflowError {
     constructor(body) {
         super({

package/dist/api/errors/UnauthorizedError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 export declare class UnauthorizedError extends errors.WebflowError {
     constructor(body?: unknown);
 }

package/dist/api/errors/UnauthorizedError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnauthorizedError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class UnauthorizedError extends errors.WebflowError {
     constructor(body) {
         super({

package/dist/api/errors/index.d.ts

@@ -1,7 +1,7 @@
-export * from "./BadRequestError";
 export * from "./UnauthorizedError";
 export * from "./ForbiddenError";
+export * from "./BadRequestError";
 export * from "./NotFoundError";
-export * from "./ConflictError";
 export * from "./TooManyRequestsError";
 export * from "./InternalServerError";
+export * from "./ConflictError";

package/dist/api/errors/index.js

@@ -14,10 +14,10 @@ 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("./BadRequestError"), exports);
 __exportStar(require("./UnauthorizedError"), exports);
 __exportStar(require("./ForbiddenError"), exports);
+__exportStar(require("./BadRequestError"), exports);
 __exportStar(require("./NotFoundError"), exports);
-__exportStar(require("./ConflictError"), exports);
 __exportStar(require("./TooManyRequestsError"), exports);
 __exportStar(require("./InternalServerError"), exports);
+__exportStar(require("./ConflictError"), exports);

package/dist/api/resources/accessGroups/client/Client.d.ts

@@ -3,15 +3,19 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Webflow from "../../..";
+import * as Webflow from "../../../index";
 export declare namespace AccessGroups {
     interface Options {
         environment?: core.Supplier<environments.WebflowEnvironment | string>;
         accessToken: core.Supplier<core.BearerToken>;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
     }
 }
 export declare class AccessGroups {
@@ -19,6 +23,11 @@ export declare class AccessGroups {
     constructor(_options: AccessGroups.Options);
     /**
      * Get a list of access groups for a site <br><br> Required scope | `users:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.AccessGroupsListRequest} request
+     * @param {AccessGroups.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -27,7 +36,7 @@ export declare class AccessGroups {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.accessGroups.list("site_id", {})
+     *     await client.accessGroups.list("site_id")
      */
     list(siteId: string, request?: Webflow.AccessGroupsListRequest, requestOptions?: AccessGroups.RequestOptions): Promise<Webflow.AccessGroupList>;
     protected _getAuthorizationHeader(): Promise<string>;

package/dist/api/resources/accessGroups/client/Client.js

@@ -41,16 +41,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccessGroups = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const Webflow = __importStar(require("../../.."));
+const Webflow = __importStar(require("../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
-const serializers = __importStar(require("../../../../serialization"));
-const errors = __importStar(require("../../../../errors"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const errors = __importStar(require("../../../../errors/index"));
 class AccessGroups {
     constructor(_options) {
         this._options = _options;
     }
     /**
      * Get a list of access groups for a site <br><br> Required scope | `users:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.AccessGroupsListRequest} request
+     * @param {AccessGroups.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -59,7 +64,7 @@ class AccessGroups {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.accessGroups.list("site_id", {})
+     *     await client.accessGroups.list("site_id")
      */
     list(siteId, request = {}, requestOptions) {
         var _a;
@@ -76,13 +81,13 @@ class AccessGroups {
                 _queryParams["sort"] = sort;
             }
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${siteId}/accessgroups`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/accessgroups`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.1",
+                    "X-Fern-SDK-Version": "2.3.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -90,6 +95,7 @@ class AccessGroups {
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.AccessGroupList.parseOrThrow(_response.body, {

package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "../../../..";
+import * as Webflow from "../../../../index";
 /**
  * @example
  *     {}

package/dist/api/resources/accessGroups/client/requests/index.d.ts

@@ -1 +1 @@
-export { AccessGroupsListRequest } from "./AccessGroupsListRequest";
+export { type AccessGroupsListRequest } from "./AccessGroupsListRequest";