@dereekb/zoom 13.11.14 → 13.11.15

package/index.cjs.js

@@ -74,9 +74,10 @@ function _object_spread_props(target, source) {
 /**
  * Creates a FetchPageFactory using the input ZoomFetchPageFetchFunction.
  *
- * @param fetch - function that fetches a single page of results from the Zoom API
- * @param defaults - optional default pagination configuration
- * @returns a configured FetchPageFactory that handles Zoom's cursor-based pagination using `next_page_token`
+ * @param fetch - Function that fetches a single page of results from the Zoom API.
+ * @param defaults - Optional default pagination configuration.
+ * @returns A configured FetchPageFactory that handles Zoom's cursor-based pagination using `next_page_token`
+ *
  * @__NO_SIDE_EFFECTS__
  */ function zoomFetchPageFactory(fetch$1, defaults) {
     return fetch.fetchPageFactory(_object_spread_props(_object_spread({}, defaults), {
@@ -363,8 +364,9 @@ function _ts_generator$5(thisArg, body) {
 /**
  * Creates a logZoomServerErrorFunction that logs the error to console.
  *
- * @param zoomApiNamePrefix Prefix to use when logging. I.E. ZoomError, etc.
+ * @param zoomApiNamePrefix - Prefix to use when logging. I.E. ZoomError, etc.
  * @returns
+ *
  * @__NO_SIDE_EFFECTS__
  */ function logZoomServerErrorFunction(zoomApiNamePrefix) {
     return function(error) {
@@ -387,9 +389,10 @@ function _ts_generator$5(thisArg, body) {
 /**
  * Wraps a ConfiguredFetch to support handling errors returned by fetch.
  *
- * @param parseZoomError Function to parse fetch response errors into typed Zoom errors
- * @param defaultLogError Default error logging function
- * @returns A factory that wraps ConfiguredFetch with error handling
+ * @param parseZoomError - Function to parse fetch response errors into typed Zoom errors.
+ * @param defaultLogError - Default error logging function.
+ * @returns A factory that wraps ConfiguredFetch with error handling.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function handleZoomErrorFetchFactory(parseZoomError, defaultLogError) {
     return function(fetch$1) {
@@ -461,8 +464,8 @@ var DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD = util.MS_IN_SECOND;
 /**
  * Parses rate limit header details from a Zoom API response.
  *
- * @param headers The response headers to parse
- * @returns Parsed rate limit details, or null if required headers are missing
+ * @param headers - The response headers to parse.
+ * @returns Parsed rate limit details, or null if required headers are missing.
  */ function zoomRateLimitHeaderDetails(headers) {
     var limitHeader = headers.get(ZOOM_RATE_LIMIT_LIMIT_HEADER);
     var remainingHeader = headers.get(ZOOM_RATE_LIMIT_REMAINING_HEADER);
@@ -507,9 +510,9 @@ var ZoomTooManyRequestsError = /*#__PURE__*/ function(ZoomServerFetchResponseErr
 /**
  * Function that parses/transforms a ZoomServerErrorData into a general ZoomServerError or other known error type.
  *
- * @param zoomServerError The error data from the Zoom API
- * @param responseError The original fetch response error
- * @returns A typed ZoomServerFetchResponseError, or undefined
+ * @param zoomServerError - The error data from the Zoom API.
+ * @param responseError - The original fetch response error.
+ * @returns A typed ZoomServerFetchResponseError, or undefined.
  */ function parseZoomServerErrorData(zoomServerError, responseError) {
     var result;
     if (responseError.response.status === ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE) {
@@ -533,8 +536,8 @@ var ZoomTooManyRequestsError = /*#__PURE__*/ function(ZoomServerFetchResponseErr
  *
  * If other options are input, it merges those two options together and adds silenceError to the omitted keys.
  *
- * @param options Optional additional MakeUrlSearchParamsOptions to merge
- * @returns A MakeUrlSearchParamsOptions that omits silenceError
+ * @param options - Optional additional MakeUrlSearchParamsOptions to merge.
+ * @returns A MakeUrlSearchParamsOptions that omits silenceError.
  */ function omitSilenceZoomErrorKeys(options) {
     var omitKeys = [
         'silenceError'
@@ -560,20 +563,20 @@ function silenceZoomErrorWithCodesFunction(codes, returnFn) {
 }
 
 /**
- * https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meeting
+ * Https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meeting.
  *
- * @param context The Zoom API context
- * @returns A function that retrieves a meeting by ID
+ * @param context - The Zoom API context.
+ * @returns Retrieves a meeting by ID.
  */ function getMeeting(context) {
     return function(input) {
         return context.fetchJson("/meetings/".concat(input.meetingId), 'GET');
     };
 }
 /**
- * https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetings
+ * Https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetings.
  *
- * @param context The Zoom API context
- * @returns A function that lists meetings for a user
+ * @param context - The Zoom API context.
+ * @returns Lists meetings for a user.
  */ function listMeetingsForUser(context) {
     return function(input) {
         return context.fetchJson("/users/".concat(input.user, "/meetings"), 'GET').then(mapToZoomPageResult('meetings'));
@@ -582,17 +585,19 @@ function silenceZoomErrorWithCodesFunction(codes, returnFn) {
 /**
  * Creates a page factory for listing meetings for a user.
  *
- * @param context The Zoom API context
- * @returns A page factory for paginated meeting listing
+ * @param context - The Zoom API context.
+ * @returns A page factory for paginated meeting listing.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function listMeetingsForUserPageFactory(context) {
     return zoomFetchPageFactory(listMeetingsForUser(context));
 }
 /**
- * https://developers.zoom.us/docs/api/meetings/#tag/meetings/POST/users/{userId}/meetings
+ * Https://developers.zoom.us/docs/api/meetings/#tag/meetings/POST/users/{userId}/meetings.
+ *
+ * @param context - The Zoom API context.
+ * @returns Creates a meeting for a user.
  *
- * @param context The Zoom API context
- * @returns A function that creates a meeting for a user
  * @__NO_SIDE_EFFECTS__
  */ function createMeetingForUser(context) {
     return function(input) {
@@ -603,10 +608,10 @@ function silenceZoomErrorWithCodesFunction(codes, returnFn) {
     };
 }
 /**
- * https://developers.zoom.us/docs/api/meetings/#tag/meetings/PUT/meetings/{meetingId}
+ * Https://developers.zoom.us/docs/api/meetings/#tag/meetings/PUT/meetings/{meetingId}
  *
- * @param context The Zoom API context
- * @returns A function that updates a meeting
+ * @param context - The Zoom API context.
+ * @returns Updates a meeting.
  */ function updateMeeting(context) {
     return function(input) {
         return context.fetchJson("/meetings/".concat(input.meetingId, "?").concat(fetch.makeUrlSearchParams({
@@ -619,10 +624,10 @@ function silenceZoomErrorWithCodesFunction(codes, returnFn) {
 }
 var DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE = 3001;
 /**
- * https://developers.zoom.us/docs/api/meetings/#tag/meetings/DELETE/meetings/{meetingId}
+ * Https://developers.zoom.us/docs/api/meetings/#tag/meetings/DELETE/meetings/{meetingId}
  *
- * @param context The Zoom API context
- * @returns A function that deletes a meeting (silences 3001 "not found" errors by default)
+ * @param context - The Zoom API context.
+ * @returns Deletes a meeting (silences 3001 "not found" errors by default)
  */ function deleteMeeting(context) {
     var silenceDoesNotExistError = silenceZoomErrorWithCodesFunction(DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE);
     return function(input) {
@@ -630,20 +635,20 @@ var DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE = 3001;
     };
 }
 /**
- * https://developers.zoom.us/docs/api/meetings/#tag/meetings/GET/past_meetings/{meetingId}
+ * Https://developers.zoom.us/docs/api/meetings/#tag/meetings/GET/past_meetings/{meetingId}
  *
- * @param context The Zoom API context
- * @returns A function that retrieves a past meeting
+ * @param context - The Zoom API context.
+ * @returns Retrieves a past meeting.
  */ function getPastMeeting(context) {
     return function(input) {
         return context.fetchJson("/past_meetings/".concat(input.meetingId), 'GET');
     };
 }
 /**
- * https://developers.zoom.us/docs/api/meetings/#tag/meetings/GET/past_meetings/{meetingId}/participants
+ * Https://developers.zoom.us/docs/api/meetings/#tag/meetings/GET/past_meetings/{meetingId}/participants.
  *
- * @param context The Zoom API context
- * @returns A function that retrieves participants from a past meeting
+ * @param context - The Zoom API context.
+ * @returns Retrieves participants from a past meeting.
  */ function getPastMeetingParticipants(context) {
     return function(input) {
         return context.fetchJson("/past_meetings/".concat(input.meetingId, "/participants"), 'GET').then(mapToZoomPageResult('participants'));
@@ -652,8 +657,9 @@ var DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE = 3001;
 /**
  * Creates a page factory for listing past meeting participants.
  *
- * @param context The Zoom API context
- * @returns A page factory for paginated participant listing
+ * @param context - The Zoom API context.
+ * @returns A page factory for paginated participant listing.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function getPastMeetingParticipantsPageFactory(context) {
     return zoomFetchPageFactory(getPastMeetingParticipants(context));
@@ -726,7 +732,7 @@ exports.ZoomRegistrationType = void 0;
 })(exports.ZoomRegistrationType || (exports.ZoomRegistrationType = {}));
 
 /**
- * https://developers.zoom.us/docs/api/users/#tag/users/GET/users/{userId}
+ * Https://developers.zoom.us/docs/api/users/#tag/users/GET/users/{userId}
  *
  * @param context
  * @returns
@@ -736,7 +742,7 @@ exports.ZoomRegistrationType = void 0;
     };
 }
 /**
- * https://developers.zoom.us/docs/api/users/#tag/users/GET/users
+ * Https://developers.zoom.us/docs/api/users/#tag/users/GET/users.
  *
  * @param context
  * @returns
@@ -748,8 +754,9 @@ exports.ZoomRegistrationType = void 0;
 /**
  * Creates a page factory for listing users.
  *
- * @param context The Zoom API context
- * @returns A page factory for paginated user listing
+ * @param context - The Zoom API context.
+ * @returns A page factory for paginated user listing.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function listUsersPageFactory(context) {
     return zoomFetchPageFactory(listUsers(context));
@@ -896,8 +903,8 @@ var logZoomErrorToConsole = logZoomServerErrorFunction('Zoom');
 /**
  * Parses a FetchResponseError into a typed Zoom API error.
  *
- * @param responseError The fetch response error to parse
- * @returns The parsed error, or undefined if parsing fails
+ * @param responseError - The fetch response error to parse.
+ * @returns The parsed error, or undefined if parsing fails.
  */ function parseZoomApiError(responseError) {
     return _async_to_generator$4(function() {
         var data, result;
@@ -926,9 +933,9 @@ var logZoomErrorToConsole = logZoomServerErrorFunction('Zoom');
 /**
  * Parses a ZoomServerErrorData into a Zoom API-specific error.
  *
- * @param zoomServerError The raw error data from the Zoom API
- * @param responseError The original fetch response error
- * @returns A parsed error, or undefined if the error is unrecognized
+ * @param zoomServerError - The raw error data from the Zoom API.
+ * @param responseError - The original fetch response error.
+ * @returns A parsed error, or undefined if the error is unrecognized.
  */ function parseZoomApiServerErrorResponseData(zoomServerError, responseError) {
     var result;
     {
@@ -1180,8 +1187,8 @@ var logZoomOAuthErrorToConsole = logZoomServerErrorFunction('ZoomOAuth');
 /**
  * Parses a FetchResponseError into a typed Zoom OAuth error.
  *
- * @param responseError The fetch response error to parse
- * @returns The parsed error, or undefined if parsing fails
+ * @param responseError - The fetch response error to parse.
+ * @returns The parsed error, or undefined if parsing fails.
  */ function parseZoomOAuthError(responseError) {
     return _async_to_generator$3(function() {
         var data, result;
@@ -1210,9 +1217,9 @@ var logZoomOAuthErrorToConsole = logZoomServerErrorFunction('ZoomOAuth');
 /**
  * Parses a ZoomServerErrorData into a Zoom OAuth-specific error.
  *
- * @param zoomServerError The raw error data from the Zoom API
- * @param responseError The original fetch response error
- * @returns A parsed error, or undefined if the error is unrecognized
+ * @param zoomServerError - The raw error data from the Zoom API.
+ * @param responseError - The original fetch response error.
+ * @returns A parsed error, or undefined if the error is unrecognized.
  */ function parseZoomOAuthServerErrorResponseData(zoomServerError, responseError) {
     var result;
     {
@@ -1362,8 +1369,9 @@ function _ts_generator$2(thisArg, body) {
 /**
  * Generates a new ZoomAccessTokenStringFactory from a ZoomAccessTokenFactory.
  *
- * @param zoomAccessTokenFactory The factory to extract the token string from
- * @returns A factory that returns the access token string
+ * @param zoomAccessTokenFactory - The factory to extract the token string from.
+ * @returns A factory that returns the access token string.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function zoomAccessTokenStringFactory(zoomAccessTokenFactory) {
     return function() {
@@ -1397,8 +1405,8 @@ var DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION = function DEFAULT_
 /**
  * Creates a rate-limited fetch handler configured for the Zoom API.
  *
- * @param config Optional configuration for rate limiting behavior
- * @returns A configured rate-limited fetch handler
+ * @param config - Optional configuration for rate limiting behavior.
+ * @returns A configured rate-limited fetch handler.
  */ function zoomRateLimitedFetchHandler(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_ZOOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION : undefined;
@@ -1455,6 +1463,7 @@ var DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION = function DEFAULT_
     });
 }
 // MARK: Compat
+// COMPAT: Deprecated aliases
 /**
  * @deprecated use DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION instead.
  */ var DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION = DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION;
@@ -1594,8 +1603,9 @@ function _ts_generator$1(thisArg, body) {
 /**
  * Creates a Zoom API factory from the given configuration.
  *
- * @param factoryConfig Configuration including OAuth context, rate limiting, and fetch settings
- * @returns A factory function that creates a configured Zoom API instance
+ * @param factoryConfig - Configuration including OAuth context, rate limiting, and fetch settings.
+ * @returns A factory function that creates a configured Zoom API instance.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function zoomFactory(factoryConfig) {
     var oauthContext = factoryConfig.oauthContext;
@@ -1710,9 +1720,9 @@ function _ts_generator$1(thisArg, body) {
 /**
  * Builds a FetchJsonInput for Zoom OAuth API calls with Basic auth.
  *
- * @param context The Zoom OAuth context
- * @param input Optional override for client credentials
- * @returns A configured FetchJsonInput for the OAuth API call
+ * @param context - The Zoom OAuth context.
+ * @param input - Optional override for client credentials.
+ * @returns A configured FetchJsonInput for the OAuth API call.
  */ function zoomOAuthApiFetchJsonInput(context, input) {
     var _ref, _ref1;
     var _input_client, _input_client1;
@@ -1732,8 +1742,8 @@ function _ts_generator$1(thisArg, body) {
 /**
  * Generates a Basic Authorization header value for Zoom OAuth.
  *
- * @param input The client ID and secret pair
- * @returns The Base64-encoded Basic auth header value
+ * @param input - The client ID and secret pair.
+ * @returns The Base64-encoded Basic auth header value.
  */ function zoomOAuthServerBasicAuthorizationHeaderValue(input) {
     var credentials = input.clientId + ':' + input.clientSecret;
     return "Basic ".concat(Buffer.from(credentials).toString('base64'));
@@ -1874,8 +1884,9 @@ function _ts_generator(thisArg, body) {
 /**
  * Creates a ZoomOAuth instance factory from the given configuration.
  *
- * @param factoryConfig Configuration for the OAuth factory
- * @returns A factory that creates configured ZoomOAuth instances
+ * @param factoryConfig - Configuration for the OAuth factory.
+ * @returns A factory that creates configured ZoomOAuth instances.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function zoomOAuthFactory(factoryConfig) {
     var fetchHandler = zoomRateLimitedFetchHandler();
@@ -1983,10 +1994,11 @@ function _ts_generator(thisArg, body) {
     };
 }
 /**
- * Creates a ZoomOAuthZoomAccessTokenFactoryConfig
+ * Creates a ZoomOAuthZoomAccessTokenFactoryConfig.
  *
  * @param config
  * @returns
+ *
  * @__NO_SIDE_EFFECTS__
  */ function zoomOAuthZoomAccessTokenFactory(config) {
     var tokenRefresher = config.tokenRefresher, accessTokenCache = config.accessTokenCache, inputTokenExpirationBuffer = config.tokenExpirationBuffer;