@dereekb/zoho 13.11.13 → 13.11.15

package/src/lib/zoho.error.api.d.ts

@@ -79,8 +79,8 @@ export type ZohoServerErrorDataWithDetails<T = unknown> = Required<ZohoServerErr
 /**
  * Normalizes a Zoho error response entry into a consistent {@link ZohoServerErrorData} shape, handling both object and string error formats.
  *
- * @param error - The raw error entry, either a structured object or a plain error code string
- * @returns Normalized error data with code and message fields
+ * @param error - The raw error entry, either a structured object or a plain error code string.
+ * @returns Normalized error data with code and message fields.
  */
 export declare function zohoServerErrorData(error: ZohoServerErrorResponseDataError): ZohoServerErrorData;
 /**
@@ -124,8 +124,9 @@ export interface LogZohoServerErrorFunctionConfig {
  * Creates a logZohoServerErrorFunction that logs the error to console.
  *
  * @param zohoApiNamePrefix - Prefix to use when logging (e.g. 'ZohoRecruit', 'ZohoSign')
- * @param options - Optional configuration for controlling which error types are logged
- * @returns A function that logs Zoho server errors to the console
+ * @param options - Optional configuration for controlling which error types are logged.
+ * @returns Logs Zoho server errors to the console.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function logZohoServerErrorFunction(zohoApiNamePrefix: string, options?: LogZohoServerErrorFunctionConfig): LogZohoServerErrorFunction;
@@ -141,9 +142,10 @@ export type ParseZohoFetchResponseErrorFunction = (responseError: FetchResponseE
 /**
  * Wraps a ConfiguredFetch to support handling errors returned by fetch.
  *
- * @param parseZohoError - Function that parses a fetch response error into a Zoho-specific error
- * @param defaultLogError - Default error logging function used when no custom logger is provided
- * @returns Factory that wraps a ConfiguredFetch with Zoho error handling
+ * @param parseZohoError - Function that parses a fetch response error into a Zoho-specific error.
+ * @param defaultLogError - Default error logging function used when no custom logger is provided.
+ * @returns Factory that wraps a ConfiguredFetch with Zoho error handling.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function handleZohoErrorFetchFactory(parseZohoError: ParseZohoFetchResponseErrorFunction, defaultLogError: LogZohoServerErrorFunction): HandleZohoErrorFetchFactory;
@@ -151,8 +153,9 @@ export type ParseZohoServerErrorResponseData = (zohoServerErrorResponseData: Zoh
 /**
  * FetchJsonInterceptJsonResponseFunction that intercepts a 200 response that actually contains a ZohoServerError and throws a ZohoServerError for the error handling to catch.
  *
- * @param parseZohoServerErrorResponseData - Function that parses raw error response data into a structured error
- * @returns Interceptor function that detects and throws hidden errors in 200 responses
+ * @param parseZohoServerErrorResponseData - Function that parses raw error response data into a structured error.
+ * @returns Interceptor function that detects and throws hidden errors in 200 responses.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function interceptZohoErrorResponseFactory(parseZohoServerErrorResponseData: ParseZohoServerErrorResponseData): FetchJsonInterceptJsonResponseFunction;
@@ -246,8 +249,8 @@ export interface ZohoRateLimitHeaderDetails {
 /**
  * Extracts rate limit details from Zoho API response headers, returning null if the headers are absent.
  *
- * @param headers - HTTP response headers from a Zoho API call
- * @returns Parsed rate limit details, or null if rate limit headers are missing
+ * @param headers - HTTP response headers from a Zoho API call.
+ * @returns Parsed rate limit details, or null if rate limit headers are missing.
  */
 export declare function zohoRateLimitHeaderDetails(headers: Headers): Maybe<ZohoRateLimitHeaderDetails>;
 export declare class ZohoTooManyRequestsError extends ZohoServerFetchResponseError {
@@ -256,9 +259,9 @@ export declare class ZohoTooManyRequestsError extends ZohoServerFetchResponseErr
 /**
  * Function that parses/transforms a ZohoServerErrorResponseData into a general ZohoServerError or other known error type.
  *
- * @param errorResponseData - Raw error response data from the Zoho API
- * @param responseError - The underlying fetch response error
- * @returns A typed Zoho server error, or undefined if no error is found
+ * @param errorResponseData - Raw error response data from the Zoho API.
+ * @param responseError - The underlying fetch response error.
+ * @returns A typed Zoho server error, or undefined if no error is found.
  */
 export declare function parseZohoServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData | ZohoServerErrorResponseDataArrayRef, responseError: FetchResponseError): ZohoServerFetchResponseError | undefined;
 /**

package/src/lib/zoho.limit.d.ts

@@ -16,7 +16,7 @@ export type ZohoRateLimitedTooManyRequestsLogFunction = (headers: ZohoRateLimitH
 /**
  * Default handler that logs a warning to the console when the Zoho API rate limit is exceeded.
  *
- * @param details - Rate limit details extracted from the Zoho API response headers
+ * @param details - Rate limit details extracted from the Zoho API response headers.
  */
 export declare const DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION: (details: ZohoRateLimitHeaderDetails | ZohoRateLimitResponseDetails) => void;
 /**
@@ -110,8 +110,9 @@ export interface MakeZohoRateLimitedFetchHandlerConfig extends ZohoRateLimitedFe
  * - On 429 responses, the request is automatically retried after the rate limiter delay
  * - The limiter is disabled when responses lack rate limit headers (e.g., error responses)
  *
- * @param config - Configuration including the service-specific header reader, rate limit, reset period, and 429 handling
+ * @param config - Configuration including the service-specific header reader, rate limit, reset period, and 429 handling.
  * @returns A rate-limited fetch handler with the underlying rate limiter accessible via `_rateLimiter`
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function makeZohoRateLimitedFetchHandler(config: MakeZohoRateLimitedFetchHandlerConfig): ZohoRateLimitedFetchHandler;
@@ -122,7 +123,7 @@ export declare function makeZohoRateLimitedFetchHandler(config: MakeZohoRateLimi
  * This is a convenience wrapper around {@link makeZohoRateLimitedFetchHandler} pre-configured
  * with the standard Zoho rate limit header reader.
  *
- * @param config - Optional configuration for rate limit, reset period, and 429 handling
+ * @param config - Optional configuration for rate limit, reset period, and 429 handling.
  * @returns A rate-limited fetch handler with the underlying rate limiter accessible via `_rateLimiter`
  */
 export declare function zohoRateLimitedFetchHandler(config?: Maybe<ZohoRateLimitedFetchHandlerConfig>): ZohoRateLimitedFetchHandler;
@@ -130,8 +131,8 @@ export declare function zohoRateLimitedFetchHandler(config?: Maybe<ZohoRateLimit
  * Reads rate limit details from standard Zoho API response headers (`X-RATELIMIT-*`).
  * Used by CRM, Recruit, and Sign services.
  *
- * @param headers - HTTP response headers
- * @returns Parsed rate limit details, or null if headers are absent
+ * @param headers - HTTP response headers.
+ * @returns Parsed rate limit details, or null if headers are absent.
  */
 export declare function zohoStandardRateLimitDetailsReader(headers: Headers): Maybe<ZohoRateLimitResponseDetails>;
 /**

package/src/lib/zoho.type.d.ts

@@ -27,7 +27,7 @@ export declare function safeZohoDateTimeString(date: Maybe<Date>): Maybe<ZohoDat
  * Converts a {@link Date} to a {@link ZohoDateTimeString} by stripping milliseconds
  * from the ISO 8601 representation.
  *
- * @param date - Date to convert
+ * @param date - Date to convert.
  * @returns Zoho-formatted date-time string (e.g. `'2019-05-02T11:17:33Z'`)
  *
  * @example