123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
import { IAxiodResponse } from "https://deno.land/x/axiod@0.20.0-0/interfaces.ts"import { WebAPICallResult } from './WebClient.ts'
/** * Deno polyfill for ErrnoException */interface ErrnoException {    code?: string,    errno?: number    message: string,    name: string,    path?: string,    syscall?: string}
/** * All errors produced by this package adhere to this interface */export interface CodedError extends ErrnoException {    code: ErrorCode}
/** * A dictionary of codes for errors produced by this package */export enum ErrorCode {  RequestError = 'slack_webapi_request_error',  HTTPError = 'slack_webapi_http_error',  PlatformError = 'slack_webapi_platform_error',  RateLimitedError = 'slack_webapi_rate_limited_error',}
export type WebAPICallError = WebAPIPlatformError | WebAPIRequestError | WebAPIHTTPError | WebAPIRateLimitedError
export interface WebAPIPlatformError extends CodedError {    code: ErrorCode.PlatformError    data: WebAPICallResult & {        error: string    }}
export interface WebAPIRequestError extends CodedError {    code: ErrorCode.RequestError    original: Error}
export interface WebAPIHTTPError extends CodedError {    code: ErrorCode.HTTPError    statusCode: number    statusMessage: string    headers: Headers    body?: any}
export interface WebAPIRateLimitedError extends CodedError {    code: ErrorCode.RateLimitedError    retryAfter: number}
/** * Factory for producing a {@link CodedError} from a generic error */function errorWithCode(error: Error, code: ErrorCode): CodedError {    // NOTE: might be able to return something more specific than a CodedError with conditional typing    const codedError = error as Partial<CodedError>    codedError.code = code    return codedError as CodedError}
/** * A factory to create WebAPIRequestError objects * @param original - original error */export function requestErrorWithOriginal(original: Error): WebAPIRequestError {    const error = errorWithCode(        new Error(`A request error occurred: ${original.message}`),        ErrorCode.RequestError,    ) as Partial<WebAPIRequestError>    error.original = original    return (error as WebAPIRequestError)}
/** * A factory to create WebAPIHTTPError objects * @param response - original error */export async function httpErrorFromResponse(response: IAxiodResponse): Promise<WebAPIHTTPError> {    const error = errorWithCode(        new Error(`An HTTP protocol error occurred: statusCode = ${response.status}`),        ErrorCode.HTTPError,    ) as Partial<WebAPIHTTPError>    error.statusCode = response.status    error.statusMessage = response.statusText    error.headers = response.headers    error.body = await response.data    return (error as WebAPIHTTPError)}
/** * A factory to create WebAPIPlatformError objects * @param result - Web API call result */export function platformErrorFromResult(result: WebAPICallResult & { error: string }): WebAPIPlatformError {    const error = errorWithCode(        new Error(`An API error occurred: ${result.error}`),        ErrorCode.PlatformError,    ) as Partial<WebAPIPlatformError>    error.data = result    return (error as WebAPIPlatformError)}
/** * A factory to create WebAPIRateLimitedError objects * @param retrySec - Number of seconds that the request can be retried in */export function rateLimitedErrorWithDelay(retrySec: number): WebAPIRateLimitedError {    const error = errorWithCode(        new Error(`A rate-limit has been reached, you may retry this request in ${retrySec} seconds`),        ErrorCode.RateLimitedError,    ) as Partial<WebAPIRateLimitedError>    error.retryAfter = retrySec    return (error as WebAPIRateLimitedError)}