@dereekb/calcom 13.11.14 → 13.11.16

package/index.esm.js

@@ -265,8 +265,9 @@ function _ts_generator$5(thisArg, body) {
 /**
  * Creates a logCalcomServerErrorFunction that logs the error to console.
  *
- * @param calcomApiNamePrefix Prefix to use when logging. I.E. CalcomError, etc.
- * @returns a LogCalcomServerErrorFunction that logs errors with the given prefix
+ * @param calcomApiNamePrefix - Prefix to use when logging. I.E. CalcomError, etc.
+ * @returns A LogCalcomServerErrorFunction that logs errors with the given prefix.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function logCalcomServerErrorFunction(calcomApiNamePrefix) {
     return function(error) {
@@ -289,9 +290,10 @@ function _ts_generator$5(thisArg, body) {
 /**
  * Wraps a ConfiguredFetch to support handling errors returned by fetch.
  *
- * @param parseCalcomError - function to parse a FetchResponseError into a CalcomServerError
- * @param defaultLogError - default error logging function used when no override is provided
- * @returns a factory that wraps any ConfiguredFetch with Cal.com error handling
+ * @param parseCalcomError - Function to parse a FetchResponseError into a CalcomServerError.
+ * @param defaultLogError - Default error logging function used when no override is provided.
+ * @returns A factory that wraps any ConfiguredFetch with Cal.com error handling.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function handleCalcomErrorFetchFactory(parseCalcomError, defaultLogError) {
     return function(fetch) {
@@ -358,8 +360,8 @@ var DEFAULT_CALCOM_API_RATE_LIMIT_RESET_PERIOD = 60 * MS_IN_SECOND;
 /**
  * Extracts Cal.com rate limit information from HTTP response headers.
  *
- * @param headers - the HTTP response headers to parse
- * @returns parsed rate limit details, or null if no rate limit headers are present
+ * @param headers - The HTTP response headers to parse.
+ * @returns Parsed rate limit details, or null if no rate limit headers are present.
  */ function calcomRateLimitHeaderDetails(headers) {
     var limitHeader = headers.get(CALCOM_RATE_LIMIT_LIMIT_HEADER);
     var remainingHeader = headers.get(CALCOM_RATE_LIMIT_REMAINING_HEADER);
@@ -396,9 +398,9 @@ var CalcomTooManyRequestsError = /*#__PURE__*/ function(CalcomServerFetchRespons
 /**
  * Function that parses/transforms a CalcomServerErrorData into a general CalcomServerError or other known error type.
  *
- * @param calcomServerError - the parsed error data from the Cal.com response body
- * @param responseError - the original FetchResponseError containing the HTTP response
- * @returns a CalcomServerFetchResponseError (or subclass like CalcomTooManyRequestsError), or undefined if unrecognized
+ * @param calcomServerError - The parsed error data from the Cal.com response body.
+ * @param responseError - The original FetchResponseError containing the HTTP response.
+ * @returns A CalcomServerFetchResponseError (or subclass like CalcomTooManyRequestsError), or undefined if unrecognized.
  */ function parseCalcomServerErrorData(calcomServerError, responseError) {
     var result;
     if (responseError.response.status === CALCOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE) {
@@ -552,8 +554,8 @@ var logCalcomErrorToConsole = logCalcomServerErrorFunction('Calcom');
  * Parses a FetchResponseError from a Cal.com API call into a typed CalcomServerError.
  * Attempts to extract JSON error data from the response body.
  *
- * @param responseError - the fetch response error to parse
- * @returns a parsed CalcomServerError, or undefined if the response body cannot be parsed
+ * @param responseError - The fetch response error to parse.
+ * @returns A parsed CalcomServerError, or undefined if the response body cannot be parsed.
  */ function parseCalcomApiError(responseError) {
     return _async_to_generator$4(function() {
         var data, result;
@@ -583,9 +585,9 @@ var logCalcomErrorToConsole = logCalcomServerErrorFunction('Calcom');
  * Parses Cal.com API server error response data into a specific error type.
  * Delegates to {@link parseCalcomServerErrorData} for general error classification.
  *
- * @param calcomServerError - the parsed error data from the Cal.com response body
- * @param responseError - the original FetchResponseError containing the HTTP response
- * @returns a parsed CalcomServerError, or undefined if the error data is falsy
+ * @param calcomServerError - The parsed error data from the Cal.com response body.
+ * @param responseError - The original FetchResponseError containing the HTTP response.
+ * @returns A parsed CalcomServerError, or undefined if the error data is falsy.
  */ function parseCalcomApiServerErrorResponseData(calcomServerError, responseError) {
     var result;
     if (calcomServerError) {
@@ -838,8 +840,8 @@ var logCalcomOAuthErrorToConsole = logCalcomServerErrorFunction('CalcomOAuth');
  * Parses a FetchResponseError from a Cal.com OAuth call into a typed error.
  * Attempts to extract JSON error data from the response body.
  *
- * @param responseError - the fetch response error to parse
- * @returns a parsed CalcomServerError or CalcomOAuthAccessTokenError, or undefined if unparseable
+ * @param responseError - The fetch response error to parse.
+ * @returns A parsed CalcomServerError or CalcomOAuthAccessTokenError, or undefined if unparseable.
  */ function parseCalcomOAuthError(responseError) {
     return _async_to_generator$3(function() {
         var data, result;
@@ -870,9 +872,9 @@ var logCalcomOAuthErrorToConsole = logCalcomServerErrorFunction('CalcomOAuth');
  * Handles known error codes like `invalid_grant` and delegates unknown errors
  * to {@link parseCalcomServerErrorData}.
  *
- * @param calcomServerError - the parsed error data from the Cal.com OAuth response body
- * @param responseError - the original FetchResponseError containing the HTTP response
- * @returns a parsed error instance, or undefined if the error data is falsy
+ * @param calcomServerError - The parsed error data from the Cal.com OAuth response body.
+ * @param responseError - The original FetchResponseError containing the HTTP response.
+ * @returns A parsed error instance, or undefined if the error data is falsy.
  */ function parseCalcomOAuthServerErrorResponseData(calcomServerError, responseError) {
     var result;
     if (calcomServerError) {
@@ -1024,8 +1026,9 @@ function _ts_generator$2(thisArg, body) {
  * Wraps a CalcomAccessTokenFactory to extract just the access token string,
  * throwing a CalcomOAuthAuthFailureError if the token is missing.
  *
- * @param calcomAccessTokenFactory - the factory that produces CalcomAccessToken objects
- * @returns a factory function that returns the access token string
+ * @param calcomAccessTokenFactory - The factory that produces CalcomAccessToken objects.
+ * @returns A factory function that returns the access token string.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function calcomAccessTokenStringFactory(calcomAccessTokenFactory) {
     return function() {
@@ -1060,8 +1063,8 @@ var DEFAULT_CALCOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION = function DEFAUL
  * Creates a rate-limited fetch handler configured for Cal.com API rate limits.
  * Automatically adjusts based on rate limit response headers and retries on 429 responses.
  *
- * @param config - optional rate limiter configuration overrides
- * @returns a CalcomRateLimitedFetchHandler that enforces rate limiting
+ * @param config - Optional rate limiter configuration overrides.
+ * @returns A CalcomRateLimitedFetchHandler that enforces rate limiting.
  */ function calcomRateLimitedFetchHandler(config) {
     var _ref, _ref1, _ref2;
     var onTooManyRequests = (config === null || config === void 0 ? void 0 : config.onTooManyRequests) !== false ? (_ref = config === null || config === void 0 ? void 0 : config.onTooManyRequests) !== null && _ref !== void 0 ? _ref : DEFAULT_CALCOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION : undefined;
@@ -1257,8 +1260,9 @@ function _ts_generator$1(thisArg, body) {
  * Sets up rate limiting, error handling, OAuth token management, and both server
  * and per-user fetch contexts.
  *
- * @param factoryConfig - configuration including OAuth context, rate limiter, and optional fetch/logging overrides
- * @returns a factory function that accepts a CalcomConfig and produces a Calcom instance
+ * @param factoryConfig - Configuration including OAuth context, rate limiter, and optional fetch/logging overrides.
+ * @returns A factory function that accepts a CalcomConfig and produces a Calcom instance.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function calcomFactory(factoryConfig) {
     var oauthContext = factoryConfig.oauthContext;
@@ -1400,8 +1404,8 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Returns a headers object with the cal-api-version header set.
  *
- * @param version - the Cal.com API version string to include in the header
- * @returns a headers record containing the cal-api-version header
+ * @param version - The Cal.com API version string to include in the header.
+ * @returns A headers record containing the cal-api-version header.
  */ function calcomApiVersionHeaders(version) {
     return _define_property({}, CALCOM_API_VERSION_HEADER, version);
 }
@@ -1409,10 +1413,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Retrieves the profile of the currently authenticated Cal.com user.
  *
- * @see https://cal.com/docs/api-reference/v2/me
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Retrieves the authenticated user's profile.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that retrieves the authenticated user's profile
+ * @see https://cal.com/docs/api-reference/v2/me
  *
  * @example
  * ```ts
@@ -1431,10 +1435,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Retrieves all schedules for the authenticated user, including availability rules and overrides.
  *
- * @see https://cal.com/docs/api-reference/v2/schedules/get-all-schedules
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Retrieves all schedules.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that retrieves all schedules
+ * @see https://cal.com/docs/api-reference/v2/schedules/get-all-schedules
  *
  * @example
  * ```ts
@@ -1456,10 +1460,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
  *
  * Identify the event type by `eventTypeId`, or by `eventTypeSlug` + `username`/`teamSlug`.
  *
- * @see https://cal.com/docs/api-reference/v2/slots/get-available-time-slots-for-an-event-type
+ * @param context - The Cal.com API context (authenticated or public)
+ * @returns Queries available slots for the given input.
  *
- * @param context - the Cal.com API context (authenticated or public)
- * @returns a function that queries available slots for the given input
+ * @see https://cal.com/docs/api-reference/v2/slots/get-available-time-slots-for-an-event-type
  *
  * @example
  * ```ts
@@ -1487,10 +1491,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
  * Creates a new booking for the specified event type. The `attendee` represents the person
  * booking (the client), not the host. This endpoint can be called without authentication.
  *
- * @see https://cal.com/docs/api-reference/v2/bookings/create-a-booking
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Creates a booking from the given input.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that creates a booking from the given input
+ * @see https://cal.com/docs/api-reference/v2/bookings/create-a-booking
  *
  * @example
  * ```ts
@@ -1501,6 +1505,7 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
  * });
  * console.log(response.data.uid);
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */ function createBooking(context) {
     return function(input) {
@@ -1514,10 +1519,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Retrieves a booking by its unique UID.
  *
- * @see https://cal.com/docs/api-reference/v2/bookings/get-a-booking
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Retrieves a booking by its UID.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that retrieves a booking by its UID
+ * @see https://cal.com/docs/api-reference/v2/bookings/get-a-booking
  *
  * @example
  * ```ts
@@ -1535,10 +1540,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Cancels a booking by its unique UID, with an optional cancellation reason.
  *
- * @see https://cal.com/docs/api-reference/v2/bookings/cancel-a-booking
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Cancels a booking by UID.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that cancels a booking by UID
+ * @see https://cal.com/docs/api-reference/v2/bookings/cancel-a-booking
  *
  * @example
  * ```ts
@@ -1561,10 +1566,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Retrieves all event types for the authenticated user.
  *
- * @see https://cal.com/docs/api-reference/v2/event-types/get-all-event-types
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Retrieves all event types.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that retrieves all event types
+ * @see https://cal.com/docs/api-reference/v2/event-types/get-all-event-types
  *
  * @example
  * ```ts
@@ -1582,10 +1587,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Creates a new event type for the authenticated user.
  *
- * @see https://cal.com/docs/api-reference/v2/event-types/create-an-event-type
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Creates a new event type from the given input.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that creates a new event type from the given input
+ * @see https://cal.com/docs/api-reference/v2/event-types/create-an-event-type
  *
  * @example
  * ```ts
@@ -1596,6 +1601,7 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
  * });
  * console.log(response.data.id);
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */ function createEventType(context) {
     return function(input) {
@@ -1609,10 +1615,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Updates an existing event type by ID.
  *
- * @see https://cal.com/docs/api-reference/v2/event-types/update-an-event-type
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Updates an event type by ID.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that updates an event type by ID
+ * @see https://cal.com/docs/api-reference/v2/event-types/update-an-event-type
  *
  * @example
  * ```ts
@@ -1630,10 +1636,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Deletes an event type by ID.
  *
- * @see https://cal.com/docs/api-reference/v2/event-types/delete-an-event-type
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Deletes an event type by ID.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that deletes an event type by ID
+ * @see https://cal.com/docs/api-reference/v2/event-types/delete-an-event-type
  *
  * @example
  * ```ts
@@ -1651,10 +1657,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Retrieves all connected calendars and the destination calendar for the authenticated user.
  *
- * @see https://cal.com/docs/api-reference/v2/calendars/get-all-calendars
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Retrieves all connected calendars.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that retrieves all connected calendars
+ * @see https://cal.com/docs/api-reference/v2/calendars/get-all-calendars
  *
  * @example
  * ```ts
@@ -1672,10 +1678,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Retrieves busy time ranges across the user's connected calendars for a given date range.
  *
- * @see https://cal.com/docs/api-reference/v2/calendars/get-busy-times
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Retrieves busy time ranges for a date range.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that retrieves busy time ranges for a date range
+ * @see https://cal.com/docs/api-reference/v2/calendars/get-busy-times
  *
  * @example
  * ```ts
@@ -1704,10 +1710,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
  * Creates a webhook subscription for the authenticated user. Webhooks notify your app
  * when specified events occur (e.g., bookings created, cancelled, rescheduled).
  *
- * @see https://cal.com/docs/api-reference/v2/webhooks/create-a-webhook
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Creates a webhook subscription from the given input.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that creates a webhook subscription from the given input
+ * @see https://cal.com/docs/api-reference/v2/webhooks/create-a-webhook
  *
  * @example
  * ```ts
@@ -1718,6 +1724,7 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
  * });
  * console.log(response.data.id);
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */ function createWebhook(context) {
     return function(input) {
@@ -1730,10 +1737,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Retrieves all webhooks for the authenticated user.
  *
- * @see https://cal.com/docs/api-reference/v2/webhooks/get-all-webhooks
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Retrieves all webhooks.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that retrieves all webhooks
+ * @see https://cal.com/docs/api-reference/v2/webhooks/get-all-webhooks
  *
  * @example
  * ```ts
@@ -1750,10 +1757,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Retrieves a specific webhook by ID.
  *
- * @see https://cal.com/docs/api-reference/v2/webhooks/get-a-webhook
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Retrieves a specific webhook by ID.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that retrieves a specific webhook by ID
+ * @see https://cal.com/docs/api-reference/v2/webhooks/get-a-webhook
  *
  * @example
  * ```ts
@@ -1770,10 +1777,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Updates an existing webhook by ID.
  *
- * @see https://cal.com/docs/api-reference/v2/webhooks/update-a-webhook
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Updates an existing webhook by ID.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that updates an existing webhook by ID
+ * @see https://cal.com/docs/api-reference/v2/webhooks/update-a-webhook
  *
  * @example
  * ```ts
@@ -1790,10 +1797,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
 /**
  * Deletes a webhook by ID.
  *
- * @see https://cal.com/docs/api-reference/v2/webhooks/delete-a-webhook
+ * @param context - The Cal.com API context providing authentication and fetch capabilities.
+ * @returns Deletes a webhook by ID.
  *
- * @param context - the Cal.com API context providing authentication and fetch capabilities
- * @returns a function that deletes a webhook by ID
+ * @see https://cal.com/docs/api-reference/v2/webhooks/delete-a-webhook
  *
  * @example
  * ```ts
@@ -1813,10 +1820,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
  *
  * Cal.com uses JSON body (not Basic Auth) for token requests.
  *
- * @see https://cal.com/docs/api-reference/v2/oauth/refresh-an-existing-access-token
+ * @param context - The Cal.com OAuth context providing client credentials and fetch capabilities.
+ * @returns Refreshes an access token using an optional refresh token override.
  *
- * @param context - the Cal.com OAuth context providing client credentials and fetch capabilities
- * @returns a function that refreshes an access token using an optional refresh token override
+ * @see https://cal.com/docs/api-reference/v2/oauth/refresh-an-existing-access-token
  *
  * @example
  * ```ts
@@ -1845,10 +1852,10 @@ var CALCOM_API_VERSION_HEADER = 'cal-api-version';
  *
  * Cal.com uses JSON body (not Basic Auth) for token requests.
  *
- * @see https://cal.com/docs/api-reference/v2/oauth/exchange-an-authorization-code-for-access-tokens
+ * @param context - The Cal.com OAuth context providing client credentials and fetch capabilities.
+ * @returns Exchanges an authorization code for access and refresh tokens.
  *
- * @param context - the Cal.com OAuth context providing client credentials and fetch capabilities
- * @returns a function that exchanges an authorization code for access and refresh tokens
+ * @see https://cal.com/docs/api-reference/v2/oauth/exchange-an-authorization-code-for-access-tokens
  *
  * @example
  * ```ts
@@ -2014,8 +2021,9 @@ function _ts_generator(thisArg, body) {
  * Supports both API key authentication (static token, no refresh) and full OAuth
  * refresh token flow with automatic token rotation.
  *
- * @param factoryConfig - configuration including optional fetch factory and error logging
- * @returns a factory function that accepts a CalcomOAuthConfig and produces a CalcomOAuth instance
+ * @param factoryConfig - Configuration including optional fetch factory and error logging.
+ * @returns A factory function that accepts a CalcomOAuthConfig and produces a CalcomOAuth instance.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function calcomOAuthFactory(factoryConfig) {
     var fetchHandler = calcomRateLimitedFetchHandler();
@@ -2175,8 +2183,9 @@ function _ts_generator(thisArg, body) {
  * Checks the in-memory cache first, then the external cache, and finally refreshes
  * from the token refresher if no valid token is available.
  *
- * @param config - configuration including the token refresher, optional cache, and expiration buffer
- * @returns a CalcomAccessTokenFactory that returns a valid access token on each call
+ * @param config - Configuration including the token refresher, optional cache, and expiration buffer.
+ * @returns A CalcomAccessTokenFactory that returns a valid access token on each call.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function calcomOAuthAccessTokenFactory(config) {
     var tokenRefresher = config.tokenRefresher, accessTokenCache = config.accessTokenCache, inputTokenExpirationBuffer = config.tokenExpirationBuffer;