@blueprint-ts/core 4.1.0-beta.2 → 4.1.0-beta.3

package/src/requests/bodies/JsonBody.ts

@@ -1,16 +0,0 @@
-import { type BodyContract } from '../contracts/BodyContract'
-import { type HeadersContract } from '../contracts/HeadersContract'
-
-export class JsonBody<RequestBody> implements BodyContract {
-  public constructor(protected data: RequestBody) {}
-
-  public getHeaders(): HeadersContract {
-    return {
-      'Content-Type': 'application/json'
-    }
-  }
-
-  public getContent(): string {
-    return JSON.stringify(this.data)
-  }
-}

package/src/requests/contracts/BaseRequestContract.ts

@@ -1,39 +0,0 @@
-import { RequestMethodEnum } from '../RequestMethod.enum'
-import { RequestEvents } from '../RequestEvents.enum'
-import { type BodyFactoryContract } from './BodyFactoryContract'
-import { type HeadersContract } from './HeadersContract'
-import { type RequestConcurrencyOptions } from '../types/RequestConcurrencyOptions'
-
-export type EventHandlerCallback<T> = (value: T) => void
-
-export interface BaseRequestContract<RequestLoaderLoadingType, RequestBodyInterface, ResponseClass, RequestParamsInterface extends object> {
-  method(): RequestMethodEnum
-
-  url(): URL | string
-
-  setParams(params?: RequestParamsInterface): this
-
-  withParams(params?: RequestParamsInterface): this
-
-  getParams(): RequestParamsInterface | undefined
-
-  setBody(requestBody: RequestBodyInterface | undefined): this
-
-  requestHeaders(): HeadersContract
-
-  buildUrl(): URL
-
-  on<T>(event: RequestEvents, handler: EventHandlerCallback<T>): this
-
-  send(): Promise<ResponseClass>
-
-  isLoading(): RequestLoaderLoadingType
-
-  getRequestBodyFactory(): BodyFactoryContract<RequestBodyInterface> | undefined
-
-  getResponse(): ResponseClass
-
-  setAbortSignal(signal: AbortSignal): this
-
-  setConcurrency(options?: RequestConcurrencyOptions): this
-}

package/src/requests/contracts/BodyContract.ts

@@ -1,9 +0,0 @@
-import { type HeadersContract } from './HeadersContract'
-
-export type BodyContent = string | FormData | Blob | ArrayBuffer | ArrayBufferView<ArrayBuffer>
-
-export interface BodyContract {
-  getContent(): BodyContent
-
-  getHeaders(): HeadersContract
-}

package/src/requests/contracts/BodyFactoryContract.ts

@@ -1,5 +0,0 @@
-import { type BodyContract } from './BodyContract'
-
-export interface BodyFactoryContract<RequestBodyInterface> {
-  make(body: RequestBodyInterface): BodyContract
-}

package/src/requests/contracts/DriverConfigContract.ts

@@ -1,9 +0,0 @@
-import { type HeadersContract } from './HeadersContract'
-import { type RequestUploadProgress } from '../types/RequestUploadProgress'
-
-export interface DriverConfigContract {
-  corsWithCredentials?: boolean | undefined
-  abortSignal?: AbortSignal | undefined
-  headers?: HeadersContract | undefined
-  onUploadProgress?: ((progress: RequestUploadProgress) => void) | undefined
-}

package/src/requests/contracts/HeadersContract.ts

@@ -1,9 +0,0 @@
-export type HeaderValue = string | (() => string)
-
-export interface HeadersContract {
-  [key: string]: HeaderValue
-}
-
-export interface ResolvedHeadersContract {
-  [key: string]: string
-}

package/src/requests/contracts/RequestDriverContract.ts

@@ -1,15 +0,0 @@
-import { RequestMethodEnum } from '../RequestMethod.enum'
-import { type HeadersContract } from './HeadersContract'
-import { type BodyContract } from './BodyContract'
-import { type ResponseHandlerContract } from '../drivers/contracts/ResponseHandlerContract'
-import { type DriverConfigContract } from './DriverConfigContract'
-
-export interface RequestDriverContract {
-  send(
-    url: URL | string,
-    method: RequestMethodEnum,
-    headers: HeadersContract,
-    body?: BodyContract,
-    requestConfig?: DriverConfigContract
-  ): Promise<ResponseHandlerContract>
-}

package/src/requests/contracts/RequestLoaderContract.ts

@@ -1,5 +0,0 @@
-export interface RequestLoaderContract<T> {
-  isLoading(): T
-
-  setLoading(value: boolean): void
-}

package/src/requests/contracts/ResponseContract.ts

@@ -1,7 +0,0 @@
-import type { ResponseHandlerContract } from '../drivers/contracts/ResponseHandlerContract'
-
-export interface ResponseContract<ResponseBodyInterface> {
-  getAcceptHeader(): string
-
-  setResponse(response: ResponseHandlerContract): Promise<ResponseBodyInterface>
-}

package/src/requests/drivers/contracts/ResponseHandlerContract.ts

@@ -1,10 +0,0 @@
-import { type ResolvedHeadersContract } from '../../contracts/HeadersContract'
-
-export interface ResponseHandlerContract {
-  getStatusCode(): number | undefined
-  getHeaders(): ResolvedHeadersContract
-  getRawResponse(): Response
-  json<ResponseBodyInterface>(): Promise<ResponseBodyInterface>
-  text(): Promise<string>
-  blob(): Promise<Blob>
-}

package/src/requests/drivers/fetch/FetchDriver.ts

@@ -1,115 +0,0 @@
-import { ResponseException } from '../../exceptions/ResponseException'
-import { FetchResponse } from './FetchResponse'
-import { RequestMethodEnum } from '../../RequestMethod.enum'
-import { type HeadersContract, type HeaderValue } from '../../contracts/HeadersContract'
-import { type BodyContent, type BodyContract } from '../../contracts/BodyContract'
-import { type RequestDriverContract } from '../../contracts/RequestDriverContract'
-import { type DriverConfigContract } from '../../contracts/DriverConfigContract'
-import { type ResponseHandlerContract } from '../contracts/ResponseHandlerContract'
-
-enum FetchDriverCredentialConfigEnum {
-  OMIT = 'omit',
-  INCLUDE = 'include'
-}
-
-interface FetchDriverConfig {
-  method: RequestMethodEnum
-  headers: HeadersContract
-  credentials?: FetchDriverCredentialConfigEnum | undefined
-  signal?: AbortSignal | undefined
-  body?: BodyContent | URLSearchParams | undefined
-}
-
-export class FetchDriver implements RequestDriverContract {
-  public constructor(protected config?: DriverConfigContract) {}
-
-  public async send(
-    url: URL | string,
-    method: RequestMethodEnum,
-    headers: HeadersContract,
-    body?: BodyContract,
-    requestConfig?: DriverConfigContract
-  ): Promise<ResponseHandlerContract> {
-    const mergedConfig: DriverConfigContract = {
-      // Global config
-      ...this.config,
-
-      // Request specific overrides
-      ...(requestConfig ?? {})
-    }
-
-    const mergedHeaders: HeadersContract = {
-      // Set global headers
-      ...this.config?.headers,
-
-      // Set headers from the request
-      ...headers,
-
-      // Set Content-Type header
-      ...body?.getHeaders()
-    }
-
-    const resolvedHeaders = this.resolveHeaders(mergedHeaders)
-
-    const fetchConfig = this.buildRequestConfig(mergedConfig, method, resolvedHeaders, body)
-
-    const response = await fetch(url, fetchConfig as RequestInit)
-
-    const fetchResponse = new FetchResponse(response)
-
-    if (!response.ok) {
-      throw new ResponseException(fetchResponse)
-    }
-
-    return fetchResponse
-  }
-
-  protected buildRequestConfig(
-    config: DriverConfigContract,
-    method: RequestMethodEnum,
-    headers: HeadersContract,
-    body?: BodyContract
-  ): FetchDriverConfig {
-    return {
-      method: method,
-      headers: headers,
-      credentials: this.getCorsWithCredentials(config.corsWithCredentials),
-      signal: config.abortSignal ?? undefined,
-      body: [RequestMethodEnum.GET, RequestMethodEnum.HEAD].includes(method) ? undefined : body?.getContent()
-    }
-  }
-
-  protected getCorsWithCredentials(corsWithCredentials: boolean | undefined): FetchDriverCredentialConfigEnum {
-    // Request takes precedence
-    if (corsWithCredentials === true) {
-      return FetchDriverCredentialConfigEnum.INCLUDE
-    }
-
-    if (corsWithCredentials === false) {
-      return FetchDriverCredentialConfigEnum.OMIT
-    }
-
-    // Fallback to default config
-    if (this.config) {
-      return this.config.corsWithCredentials ? FetchDriverCredentialConfigEnum.INCLUDE : FetchDriverCredentialConfigEnum.OMIT
-    }
-
-    // Fallback to safe option if no default set
-    return FetchDriverCredentialConfigEnum.OMIT
-  }
-
-  protected resolveHeaders(headers: HeadersContract): HeadersContract {
-    const resolved: HeadersContract = {}
-    for (const key in headers) {
-      const value: HeaderValue | undefined = headers[key]
-
-      if (value === undefined) {
-        continue
-      }
-
-      resolved[key] = typeof value === 'function' ? value() : value
-    }
-
-    return resolved
-  }
-}

package/src/requests/drivers/fetch/FetchResponse.ts

@@ -1,30 +0,0 @@
-import { type ResolvedHeadersContract } from '../../contracts/HeadersContract'
-import { type ResponseHandlerContract } from '../contracts/ResponseHandlerContract'
-
-export class FetchResponse implements ResponseHandlerContract {
-  public constructor(protected response: Response) {}
-
-  public getStatusCode(): number | undefined {
-    return this.response.status
-  }
-
-  public getHeaders(): ResolvedHeadersContract {
-    return Object.fromEntries(this.response.headers)
-  }
-
-  public getRawResponse(): Response {
-    return this.response
-  }
-
-  public async json<ResponseBodyInterface>(): Promise<ResponseBodyInterface> {
-    return await this.response.json()
-  }
-
-  public async text(): Promise<string> {
-    return await this.response.text()
-  }
-
-  public async blob(): Promise<Blob> {
-    return await this.response.blob()
-  }
-}

package/src/requests/drivers/xhr/XMLHttpRequestDriver.ts

@@ -1,138 +0,0 @@
-import { ResponseException } from '../../exceptions/ResponseException'
-import { RequestMethodEnum } from '../../RequestMethod.enum'
-import { type HeadersContract, type HeaderValue } from '../../contracts/HeadersContract'
-import { type BodyContract } from '../../contracts/BodyContract'
-import { type RequestDriverContract } from '../../contracts/RequestDriverContract'
-import { type DriverConfigContract } from '../../contracts/DriverConfigContract'
-import { type ResponseHandlerContract } from '../contracts/ResponseHandlerContract'
-import { XMLHttpRequestResponse } from './XMLHttpRequestResponse'
-
-export class XMLHttpRequestDriver implements RequestDriverContract {
-  public constructor(protected config?: DriverConfigContract) {}
-
-  public async send(
-    url: URL | string,
-    method: RequestMethodEnum,
-    headers: HeadersContract,
-    body?: BodyContract,
-    requestConfig?: DriverConfigContract
-  ): Promise<ResponseHandlerContract> {
-    const mergedConfig: DriverConfigContract = {
-      ...this.config,
-      ...(requestConfig ?? {})
-    }
-
-    const mergedHeaders: HeadersContract = {
-      ...this.config?.headers,
-      ...headers,
-      ...body?.getHeaders()
-    }
-
-    const resolvedHeaders = this.resolveHeaders(mergedHeaders)
-
-    return await new Promise<ResponseHandlerContract>((resolve, reject) => {
-      const request = new XMLHttpRequest()
-      const requestUrl = url instanceof URL ? url.toString() : url
-      const requestBody = [RequestMethodEnum.GET, RequestMethodEnum.HEAD].includes(method) ? undefined : body?.getContent()
-      const abortSignal = mergedConfig.abortSignal
-      const handleAbortSignal = () => request.abort()
-
-      const cleanup = () => {
-        request.onload = null
-        request.onerror = null
-        request.onabort = null
-
-        if (request.upload) {
-          request.upload.onprogress = null
-        }
-
-        abortSignal?.removeEventListener('abort', handleAbortSignal)
-      }
-
-      request.open(method, requestUrl, true)
-      request.responseType = 'blob'
-      request.withCredentials = this.getCorsWithCredentials(mergedConfig.corsWithCredentials)
-
-      for (const key in resolvedHeaders) {
-        request.setRequestHeader(key, resolvedHeaders[key] as string)
-      }
-
-      request.onload = () => {
-        cleanup()
-
-        if (request.status === 0) {
-          reject(new Error('No response received.'))
-          return
-        }
-
-        const response = new XMLHttpRequestResponse(request)
-
-        if (request.status < 200 || request.status >= 300) {
-          reject(new ResponseException(response))
-          return
-        }
-
-        resolve(response)
-      }
-
-      request.onerror = () => {
-        cleanup()
-        reject(new Error('Network request failed.'))
-      }
-
-      request.onabort = () => {
-        cleanup()
-        reject(new DOMException('The operation was aborted.', 'AbortError'))
-      }
-
-      if (request.upload) {
-        request.upload.onprogress = (event: ProgressEvent<EventTarget>) => {
-          const total = event.lengthComputable ? event.total : undefined
-
-          mergedConfig.onUploadProgress?.({
-            loaded: event.loaded,
-            total: total,
-            lengthComputable: event.lengthComputable,
-            progress: total === undefined || total === 0 ? undefined : event.loaded / total
-          })
-        }
-      }
-
-      if (abortSignal?.aborted) {
-        handleAbortSignal()
-        return
-      }
-
-      abortSignal?.addEventListener('abort', handleAbortSignal, { once: true })
-      request.send(requestBody)
-    })
-  }
-
-  protected getCorsWithCredentials(corsWithCredentials: boolean | undefined): boolean {
-    if (corsWithCredentials === true) {
-      return true
-    }
-
-    if (corsWithCredentials === false) {
-      return false
-    }
-
-    return this.config?.corsWithCredentials ?? false
-  }
-
-  protected resolveHeaders(headers: HeadersContract): HeadersContract {
-    const resolved: HeadersContract = {}
-
-    for (const key in headers) {
-      const value: HeaderValue | undefined = headers[key]
-
-      if (value === undefined) {
-        continue
-      }
-
-      resolved[key] = typeof value === 'function' ? value() : value
-    }
-
-    return resolved
-  }
-}

package/src/requests/drivers/xhr/XMLHttpRequestResponse.ts

@@ -1,95 +0,0 @@
-import { type ResolvedHeadersContract } from '../../contracts/HeadersContract'
-import { type ResponseHandlerContract } from '../contracts/ResponseHandlerContract'
-
-export class XMLHttpRequestResponse implements ResponseHandlerContract {
-  protected response: Response
-  protected headers: ResolvedHeadersContract
-
-  public constructor(protected request: XMLHttpRequest) {
-    this.headers = this.parseHeaders(request.getAllResponseHeaders())
-    this.response = new Response(this.getResponseBody(), {
-      status: request.status,
-      statusText: request.statusText,
-      headers: Object.entries(this.headers).map(([key, value]) => [key, String(value)])
-    })
-  }
-
-  public getStatusCode(): number | undefined {
-    return this.request.status
-  }
-
-  public getHeaders(): ResolvedHeadersContract {
-    return this.headers
-  }
-
-  public getRawResponse(): Response {
-    return this.response
-  }
-
-  public async json<ResponseBodyInterface>(): Promise<ResponseBodyInterface> {
-    return await this.response.json()
-  }
-
-  public async text(): Promise<string> {
-    return await this.response.text()
-  }
-
-  public async blob(): Promise<Blob> {
-    return await this.response.blob()
-  }
-
-  protected getResponseBody(): Blob | string | null {
-    if ([204, 205, 304].includes(this.request.status)) {
-      return null
-    }
-
-    if (this.request.response === null || this.request.response === undefined) {
-      return null
-    }
-
-    if (this.isBlobLike(this.request.response) || typeof this.request.response === 'string') {
-      return this.request.response
-    }
-
-    return new Blob([this.request.response])
-  }
-
-  protected isBlobLike(value: unknown): value is Blob {
-    return (
-      value instanceof Blob ||
-      (typeof value === 'object' &&
-        value !== null &&
-        typeof (value as Blob).arrayBuffer === 'function' &&
-        typeof (value as Blob).stream === 'function' &&
-        typeof (value as Blob).text === 'function')
-    )
-  }
-
-  protected parseHeaders(rawHeaders: string): ResolvedHeadersContract {
-    const headers: ResolvedHeadersContract = {}
-    const lines = rawHeaders.trim()
-
-    if (lines.length === 0) {
-      return headers
-    }
-
-    for (const line of lines.split(/\r?\n/)) {
-      const separatorIndex = line.indexOf(':')
-
-      if (separatorIndex === -1) {
-        continue
-      }
-
-      const key = line.slice(0, separatorIndex).trim()
-      const value = line.slice(separatorIndex + 1).trim()
-
-      if (key.length === 0) {
-        continue
-      }
-
-      headers[key] = key in headers ? `${String(headers[key])}, ${value}` : value
-    }
-
-    return headers
-  }
-}

package/src/requests/exceptions/BadGatewayException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class BadGatewayException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/BadRequestException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class BadRequestException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/ConflictException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class ConflictException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/ForbiddenException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class ForbiddenException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/GatewayTimeoutException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class GatewayTimeoutException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/GoneException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class GoneException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/InvalidJsonException.ts

@@ -1,15 +0,0 @@
-import { ResponseException } from './ResponseException'
-import { type ResponseHandlerContract } from '../drivers/contracts/ResponseHandlerContract'
-
-export class InvalidJsonException extends ResponseException {
-  public constructor(
-    response: ResponseHandlerContract,
-    public cause: unknown
-  ) {
-    super(response)
-  }
-
-  public getCause(): unknown {
-    return this.cause
-  }
-}

package/src/requests/exceptions/LockedException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class LockedException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/MethodNotAllowedException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class MethodNotAllowedException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/NotFoundException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class NotFoundException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/NotImplementedException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class NotImplementedException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/PageExpiredException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class PageExpiredException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/PayloadTooLargeException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class PayloadTooLargeException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/PreconditionFailedException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class PreconditionFailedException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/RequestTimeoutException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class RequestTimeoutException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/ResponseBodyException.ts

@@ -1,15 +0,0 @@
-import { ResponseException } from './ResponseException'
-import { type ResponseHandlerContract } from '../drivers/contracts/ResponseHandlerContract'
-
-export class ResponseBodyException<ResponseErrorBody> extends ResponseException {
-  public constructor(
-    response: ResponseHandlerContract,
-    protected body: ResponseErrorBody
-  ) {
-    super(response)
-  }
-
-  public getBody(): ResponseErrorBody {
-    return this.body
-  }
-}

package/src/requests/exceptions/ResponseException.ts

@@ -1,11 +0,0 @@
-import { type ResponseHandlerContract } from '../drivers/contracts/ResponseHandlerContract'
-
-export class ResponseException extends Error {
-  constructor(protected response: ResponseHandlerContract) {
-    super()
-  }
-
-  public getResponse(): ResponseHandlerContract {
-    return this.response
-  }
-}

package/src/requests/exceptions/ServerErrorException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class ServerErrorException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/ServiceUnavailableException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class ServiceUnavailableException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}

package/src/requests/exceptions/StaleResponseException.ts

@@ -1,13 +0,0 @@
-export class StaleResponseException extends Error {
-  public readonly cause: unknown
-
-  public constructor(message: string = 'Stale response ignored', cause?: unknown) {
-    super(message)
-    this.name = 'StaleResponseException'
-    this.cause = cause
-  }
-
-  public getCause(): unknown {
-    return this.cause
-  }
-}

package/src/requests/exceptions/TooManyRequestsException.ts

@@ -1,3 +0,0 @@
-import { ResponseBodyException } from './ResponseBodyException'
-
-export class TooManyRequestsException<ResponseErrorBody> extends ResponseBodyException<ResponseErrorBody> {}