@dereekb/zoom 13.4.0 → 13.4.2

package/index.cjs.js

@@ -74,9 +74,9 @@ function _object_spread_props(target, source) {
 /**
  * Creates a FetchPageFactory using the input ZoomFetchPageFetchFunction.
  *
- * @param fetch
- * @param defaults
- * @returns
+ * @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`
  */ function zoomFetchPageFactory(fetch$1, defaults) {
     return fetch.fetchPageFactory(_object_spread_props(_object_spread({}, defaults), {
         fetch: fetch$1,
@@ -384,8 +384,9 @@ function _ts_generator$5(thisArg, body) {
 /**
  * Wraps a ConfiguredFetch to support handling errors returned by fetch.
  *
- * @param fetch
- * @returns
+ * @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
  */ function handleZoomErrorFetchFactory(parseZoomError, defaultLogError) {
     return function(fetch$1) {
         var logError = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : defaultLogError;
@@ -453,7 +454,12 @@ var ZOOM_RATE_LIMIT_REMAINING_HEADER = 'X-RateLimit-Remaining';
 var ZOOM_RATE_LIMIT_RETRY_AFTER_HEADER = 'Retry-After';
 var DEFAULT_ZOOM_API_RATE_LIMIT = 2;
 var DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD = util.MS_IN_SECOND;
-function zoomRateLimitHeaderDetails(headers) {
+/**
+ * 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
+ */ function zoomRateLimitHeaderDetails(headers) {
     var limitHeader = headers.get(ZOOM_RATE_LIMIT_LIMIT_HEADER);
     var remainingHeader = headers.get(ZOOM_RATE_LIMIT_REMAINING_HEADER);
     var retryAfterHeader = headers.get(ZOOM_RATE_LIMIT_RETRY_AFTER_HEADER);
@@ -497,9 +503,9 @@ var ZoomTooManyRequestsError = /*#__PURE__*/ function(ZoomServerFetchResponseErr
 /**
  * Function that parses/transforms a ZoomServerErrorData into a general ZoomServerError or other known error type.
  *
- * @param errorResponseData
- * @param responseError
- * @returns
+ * @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) {
@@ -509,7 +515,7 @@ var ZoomTooManyRequestsError = /*#__PURE__*/ function(ZoomServerFetchResponseErr
             responseError: responseError,
             headerDetails: result.headerDetails
         });
-    } else if (zoomServerError) {
+    } else {
         switch(zoomServerError.code){
             default:
                 result = new ZoomServerFetchResponseError(zoomServerError, responseError);
@@ -522,6 +528,9 @@ var ZoomTooManyRequestsError = /*#__PURE__*/ function(ZoomServerFetchResponseErr
  * Returns a pre-configured MakeUrlSearchParamsOptions that omits the silenceError key.
  *
  * 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
  */ function omitSilenceZoomErrorKeys(options) {
     var omitKeys = [
         'silenceError'
@@ -537,10 +546,8 @@ function silenceZoomErrorWithCodesFunction(codes, returnFn) {
     var codesSet = new Set(util.asArray(codes));
     return function(silence) {
         return function(reason) {
-            if (silence !== false && _instanceof(reason, ZoomServerFetchResponseError)) {
-                if (codesSet.has(reason.code)) {
-                    return returnFn === null || returnFn === void 0 ? void 0 : returnFn(reason);
-                }
+            if (silence !== false && _instanceof(reason, ZoomServerFetchResponseError) && codesSet.has(reason.code)) {
+                return returnFn === null || returnFn === void 0 ? void 0 : returnFn(reason);
             }
             throw reason;
         };
@@ -549,6 +556,9 @@ function silenceZoomErrorWithCodesFunction(codes, returnFn) {
 
 /**
  * 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
  */ function getMeeting(context) {
     return function(input) {
         return context.fetchJson("/meetings/".concat(input.meetingId), 'GET');
@@ -556,16 +566,27 @@ function silenceZoomErrorWithCodesFunction(codes, returnFn) {
 }
 /**
  * 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
  */ function listMeetingsForUser(context) {
     return function(input) {
         return context.fetchJson("/users/".concat(input.user, "/meetings"), 'GET').then(mapToZoomPageResult('meetings'));
     };
 }
-function listMeetingsForUserPageFactory(context) {
+/**
+ * Creates a page factory for listing meetings for a user.
+ *
+ * @param context The Zoom API context
+ * @returns A page factory for paginated meeting listing
+ */ function listMeetingsForUserPageFactory(context) {
     return zoomFetchPageFactory(listMeetingsForUser(context));
 }
 /**
  * https://developers.zoom.us/docs/api/meetings/#tag/meetings/POST/users/{userId}/meetings
+ *
+ * @param context The Zoom API context
+ * @returns A function that creates a meeting for a user
  */ function createMeetingForUser(context) {
     return function(input) {
         return context.fetchJson("/users/".concat(input.user, "/meetings"), {
@@ -576,6 +597,9 @@ function listMeetingsForUserPageFactory(context) {
 }
 /**
  * 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
  */ function updateMeeting(context) {
     return function(input) {
         return context.fetchJson("/meetings/".concat(input.meetingId, "?").concat(fetch.makeUrlSearchParams({
@@ -589,6 +613,9 @@ function listMeetingsForUserPageFactory(context) {
 var DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE = 3001;
 /**
  * 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)
  */ function deleteMeeting(context) {
     var silenceDoesNotExistError = silenceZoomErrorWithCodesFunction(DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE);
     return function(input) {
@@ -597,6 +624,9 @@ var DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE = 3001;
 }
 /**
  * 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
  */ function getPastMeeting(context) {
     return function(input) {
         return context.fetchJson("/past_meetings/".concat(input.meetingId), 'GET');
@@ -604,12 +634,20 @@ var DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE = 3001;
 }
 /**
  * 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
  */ function getPastMeetingParticipants(context) {
     return function(input) {
         return context.fetchJson("/past_meetings/".concat(input.meetingId, "/participants"), 'GET').then(mapToZoomPageResult('participants'));
     };
 }
-function getPastMeetingParticipantsPageFactory(context) {
+/**
+ * Creates a page factory for listing past meeting participants.
+ *
+ * @param context The Zoom API context
+ * @returns A page factory for paginated participant listing
+ */ function getPastMeetingParticipantsPageFactory(context) {
     return zoomFetchPageFactory(getPastMeetingParticipants(context));
 }
 
@@ -699,7 +737,12 @@ exports.ZoomRegistrationType = void 0;
         return context.fetchJson("/users?".concat(fetch.makeUrlSearchParams(input)), 'GET').then(mapToZoomPageResult('users'));
     };
 }
-function listUsersPageFactory(context) {
+/**
+ * Creates a page factory for listing users.
+ *
+ * @param context The Zoom API context
+ * @returns A page factory for paginated user listing
+ */ function listUsersPageFactory(context) {
     return zoomFetchPageFactory(listUsers(context));
 }
 
@@ -841,7 +884,12 @@ function _ts_generator$4(thisArg, body) {
 }
 // MARK: Parser
 var logZoomErrorToConsole = logZoomServerErrorFunction('Zoom');
-function parseZoomApiError(responseError) {
+/**
+ * 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
+ */ function parseZoomApiError(responseError) {
     return _async_to_generator$4(function() {
         var data, result;
         return _ts_generator$4(this, function(_state) {
@@ -849,7 +897,7 @@ function parseZoomApiError(responseError) {
                 case 0:
                     return [
                         4,
-                        responseError.response.json().catch(function(x) {
+                        responseError.response.json().catch(function() {
                             return undefined;
                         })
                     ];
@@ -866,9 +914,15 @@ function parseZoomApiError(responseError) {
         });
     })();
 }
-function parseZoomApiServerErrorResponseData(zoomServerError, responseError) {
+/**
+ * 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
+ */ function parseZoomApiServerErrorResponseData(zoomServerError, responseError) {
     var result;
-    if (zoomServerError) {
+    {
         switch(zoomServerError.code){
             default:
                 result = parseZoomServerErrorData(zoomServerError, responseError);
@@ -1114,7 +1168,12 @@ function _ts_generator$3(thisArg, body) {
     return ZoomOAuthAuthFailureError;
 }(fetch.FetchRequestFactoryError);
 var logZoomOAuthErrorToConsole = logZoomServerErrorFunction('ZoomOAuth');
-function parseZoomOAuthError(responseError) {
+/**
+ * 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
+ */ function parseZoomOAuthError(responseError) {
     return _async_to_generator$3(function() {
         var data, result;
         return _ts_generator$3(this, function(_state) {
@@ -1122,7 +1181,7 @@ function parseZoomOAuthError(responseError) {
                 case 0:
                     return [
                         4,
-                        responseError.response.json().catch(function(x) {
+                        responseError.response.json().catch(function() {
                             return undefined;
                         })
                     ];
@@ -1139,9 +1198,15 @@ function parseZoomOAuthError(responseError) {
         });
     })();
 }
-function parseZoomOAuthServerErrorResponseData(zoomServerError, responseError) {
+/**
+ * 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
+ */ function parseZoomOAuthServerErrorResponseData(zoomServerError, responseError) {
     var result;
-    if (zoomServerError) {
+    {
         var potentialErrorStringCode = zoomServerError.error;
         var errorCode = potentialErrorStringCode !== null && potentialErrorStringCode !== void 0 ? potentialErrorStringCode : zoomServerError.code;
         switch(errorCode){
@@ -1286,7 +1351,10 @@ function _ts_generator$2(thisArg, body) {
     }
 }
 /**
- * Generates a new ZoomAccessTokenStringFactory.
+ * 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
  */ function zoomAccessTokenStringFactory(zoomAccessTokenFactory) {
     return function() {
         return _async_to_generator$2(function() {
@@ -1300,7 +1368,7 @@ function _ts_generator$2(thisArg, body) {
                         ];
                     case 1:
                         token = _state.sent();
-                        if (!(token === null || token === void 0 ? void 0 : token.accessToken)) {
+                        if (!token.accessToken) {
                             throw new ZoomOAuthAuthFailureError();
                         }
                         return [
@@ -1313,12 +1381,17 @@ function _ts_generator$2(thisArg, body) {
     };
 }
 
-var DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION = function DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION(headers) {
+var DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION = function DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION(headers) {
     console.warn("zoomRateLimitedFetchHandler(): Too many requests made. The limit is ".concat(headers.limit, " requests per reset period. RetryAt is set for ").concat(headers.retryAfterAt, "."));
 };
-function zoomRateLimitedFetchHandler(config) {
+/**
+ * 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
+ */ 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_REQUETS_LOG_FUNCTION : undefined;
+    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;
     var defaultLimit = (_ref1 = config === null || config === void 0 ? void 0 : config.maxRateLimit) !== null && _ref1 !== void 0 ? _ref1 : DEFAULT_ZOOM_API_RATE_LIMIT;
     var defaultResetPeriod = (_ref2 = config === null || config === void 0 ? void 0 : config.resetPeriod) !== null && _ref2 !== void 0 ? _ref2 : DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD;
     function configForLimit(limit, resetAt) {
@@ -1344,13 +1417,13 @@ function zoomRateLimitedFetchHandler(config) {
                 var headerDetails = zoomRateLimitHeaderDetails(response.headers);
                 if (headerDetails) {
                     var type = headerDetails.type, limit = headerDetails.limit, retryAfterAt = headerDetails.retryAfterAt, remaining = headerDetails.remaining;
-                    if (response.status === ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE) {
-                        // For simple query-per-second rate limits, just schedule a retry
-                        if (type === 'QPS') {
-                            shouldRetry = true;
-                            try {
-                                onTooManyRequests === null || onTooManyRequests === void 0 ? void 0 : onTooManyRequests(headerDetails, response, fetchResponseError);
-                            } catch (e) {}
+                    if (response.status === ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE && // For simple query-per-second rate limits, just schedule a retry
+                    type === 'QPS') {
+                        shouldRetry = true;
+                        try {
+                            void (onTooManyRequests === null || onTooManyRequests === void 0 ? void 0 : onTooManyRequests(headerDetails, response, fetchResponseError));
+                        } catch (unused) {
+                        // ignored: onTooManyRequests is for logging only
                         }
                     }
                     // NOTE: typically it seems like these headers are not available usually.
@@ -1371,6 +1444,10 @@ function zoomRateLimitedFetchHandler(config) {
         }
     });
 }
+// MARK: Compat
+/**
+ * @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;
 
 /**
  * The Zoom API URL for the US datacenter.
@@ -1504,7 +1581,12 @@ function _ts_generator$1(thisArg, body) {
         };
     }
 }
-function zoomFactory(factoryConfig) {
+/**
+ * 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
+ */ function zoomFactory(factoryConfig) {
     var oauthContext = factoryConfig.oauthContext;
     var serverAccessTokenStringFactory = zoomAccessTokenStringFactory(oauthContext.loadAccessToken);
     var fetchHandler = zoomRateLimitedFetchHandler(factoryConfig.rateLimiterConfig);
@@ -1614,7 +1696,13 @@ function zoomFactory(factoryConfig) {
         return context.fetchJson("/token?grant_type=refresh_token&refresh_token=".concat(refreshToken), zoomOAuthApiFetchJsonInput(context, input));
     };
 }
-function zoomOAuthApiFetchJsonInput(context, input) {
+/**
+ * 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
+ */ function zoomOAuthApiFetchJsonInput(context, input) {
     var _ref, _ref1;
     var _input_client, _input_client1;
     var clientId = (_ref = input === null || input === void 0 ? void 0 : (_input_client = input.client) === null || _input_client === void 0 ? void 0 : _input_client.clientId) !== null && _ref !== void 0 ? _ref : context.config.clientId;
@@ -1630,8 +1718,14 @@ function zoomOAuthApiFetchJsonInput(context, input) {
     };
     return fetchJsonInput;
 }
-function zoomOAuthServerBasicAuthorizationHeaderValue(input) {
-    return "Basic ".concat(Buffer.from("".concat(input.clientId, ":").concat(input.clientSecret)).toString('base64'));
+/**
+ * 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
+ */ function zoomOAuthServerBasicAuthorizationHeaderValue(input) {
+    var credentials = input.clientId + ':' + input.clientSecret;
+    return "Basic ".concat(Buffer.from(credentials).toString('base64'));
 }
 
 /**
@@ -1766,9 +1860,14 @@ function _ts_generator(thisArg, body) {
         };
     }
 }
-function zoomOAuthFactory(factoryConfig) {
+/**
+ * Creates a ZoomOAuth instance factory from the given configuration.
+ *
+ * @param factoryConfig Configuration for the OAuth factory
+ * @returns A factory that creates configured ZoomOAuth instances
+ */ function zoomOAuthFactory(factoryConfig) {
     var fetchHandler = zoomRateLimitedFetchHandler();
-    var logZoomServerErrorFunction = factoryConfig.logZoomServerErrorFunction, _factoryConfig_fetchFactory = factoryConfig.fetchFactory, fetchFactory = _factoryConfig_fetchFactory === void 0 ? function(_) {
+    var logZoomServerErrorFunction = factoryConfig.logZoomServerErrorFunction, _factoryConfig_fetchFactory = factoryConfig.fetchFactory, fetchFactory = _factoryConfig_fetchFactory === void 0 ? function() {
         return fetch.fetchApiFetchService.makeFetch({
             baseUrl: ZOOM_OAUTH_API_URL,
             baseRequest: {
@@ -1912,7 +2011,7 @@ function zoomOAuthFactory(factoryConfig) {
                         }
                         if (!!currentToken) return [
                             3,
-                            10
+                            9
                         ];
                         _state.label = 3;
                     case 3:
@@ -1937,35 +2036,29 @@ function zoomOAuthFactory(factoryConfig) {
                         console.error("zoomOAuthZoomAccessTokenFactory(): Failed retrieving new token from tokenRefresher: ", e);
                         throw new ZoomOAuthAuthFailureError('Token Refresh Failed');
                     case 6:
-                        if (!currentToken) return [
-                            3,
-                            10
-                        ];
-                        _state.label = 7;
-                    case 7:
                         _state.trys.push([
-                            7,
-                            9,
+                            6,
+                            8,
                             ,
-                            10
+                            9
                         ]);
                         return [
                             4,
                             accessTokenCache === null || accessTokenCache === void 0 ? void 0 : accessTokenCache.updateCachedToken(currentToken)
                         ];
-                    case 8:
+                    case 7:
                         _state.sent();
                         return [
                             3,
-                            10
+                            9
                         ];
-                    case 9:
+                    case 8:
                         _state.sent();
                         return [
                             3,
-                            10
+                            9
                         ];
-                    case 10:
+                    case 9:
                         return [
                             2,
                             currentToken
@@ -1978,6 +2071,7 @@ function zoomOAuthFactory(factoryConfig) {
 
 exports.DEFAULT_ZOOM_API_RATE_LIMIT = DEFAULT_ZOOM_API_RATE_LIMIT;
 exports.DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD = DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD;
+exports.DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION = DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION;
 exports.DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION = DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION;
 exports.DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE = DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE;
 exports.ZOOM_ACCOUNTS_INVALID_GRANT_ERROR_CODE = ZOOM_ACCOUNTS_INVALID_GRANT_ERROR_CODE;