extra-request 8.5.0 → 8.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extra-request",
-  "version": "8.5.0",
+  "version": "8.5.1",
   "description": "Utilities for Request",
   "type": "module",
   "sideEffects": false,
@@ -9,7 +9,8 @@
     "Request"
   ],
   "files": [
-    "lib"
+    "lib",
+    "src"
   ],
   "main": "lib/index.js",
   "exports": {

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './types.js'
+export * from './request.js'
+export * from './pipe-request-options-transformers.js'

package/src/pipe-request-options-transformers.ts

@@ -0,0 +1,23 @@
+import { Headers } from 'extra-fetch'
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import { isntFalsy } from '@blackglory/prelude'
+import { Falsy } from '@blackglory/prelude'
+import { pipe } from 'extra-utils'
+
+export function pipeRequestOptionsTransformers(
+  ...transformers: Array<IRequestOptionsTransformer | Falsy>
+): IRequestOptions {
+  const base: IRequestOptions = {
+    url: new URL(
+      typeof document !== 'undefined'
+    ? document.baseURI
+    : 'http://localhost'
+    )
+  , headers: new Headers()
+  }
+
+  return pipe(
+    base
+  , ...transformers.filter<IRequestOptionsTransformer>(isntFalsy)
+  )
+}

package/src/request.ts

@@ -0,0 +1,45 @@
+import { Headers, Request } from 'extra-fetch'
+import { IRequestOptionsTransformer } from '@src/types.js'
+import { pipeRequestOptionsTransformers } from '@src/pipe-request-options-transformers.js'
+import { Falsy } from '@blackglory/prelude'
+
+export function get(...transformers: Array<IRequestOptionsTransformer | Falsy>): Request {
+  return request('GET', ...transformers)
+}
+
+export function head(...transformers: Array<IRequestOptionsTransformer | Falsy>): Request {
+  return request('HEAD', ...transformers)
+}
+
+export function post(...transformers: Array<IRequestOptionsTransformer | Falsy>): Request {
+  return request('POST', ...transformers)
+}
+
+export function put(...transformers: Array<IRequestOptionsTransformer | Falsy>): Request {
+  return request('PUT', ...transformers)
+}
+
+export function patch(...transformers: Array<IRequestOptionsTransformer | Falsy>): Request {
+  return request('PATCH', ...transformers)
+}
+
+export function del(...transformers: Array<IRequestOptionsTransformer | Falsy>): Request {
+  return request('DELETE', ...transformers)
+}
+
+function request(
+  method: 'GET' | 'HEAD' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'
+, ...transformers: Array<IRequestOptionsTransformer | Falsy>
+): Request {
+  const requestOptions = pipeRequestOptionsTransformers(...transformers)
+  const headers = new Headers(requestOptions.headers)
+
+  return new Request(requestOptions.url.href, {
+    method
+  , headers
+  , signal: requestOptions.signal
+  , body: requestOptions.payload as any
+  , keepalive: requestOptions.keepalive
+  , redirect: requestOptions.redirect
+  })
+}

package/src/transformers/accept.ts

@@ -0,0 +1,6 @@
+import { appendHeader } from './append-header.js'
+import { IRequestOptionsTransformer } from '@src/types.js'
+
+export function accept(accept: string): IRequestOptionsTransformer {
+  return appendHeader('Accept', accept)
+}

package/src/transformers/append-header.ts

@@ -0,0 +1,14 @@
+import { Headers } from 'extra-fetch'
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+
+export function appendHeader(name: string, value: string): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    const headers = new Headers(options.headers)
+    headers.append(name, value)
+
+    return {
+      ...options
+    , headers
+    }
+  }
+}

package/src/transformers/append-pathname.ts

@@ -0,0 +1,11 @@
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import * as URL from 'url-operator'
+
+export function appendPathname(pathname: string): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    return {
+      ...options
+    , url: URL.appendPathname(options.url, pathname)
+    }
+  }
+}

package/src/transformers/append-search-param.ts

@@ -0,0 +1,14 @@
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import * as URL from 'url-operator'
+
+export function appendSearchParam(
+  name: string
+, value: string | number
+): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    return {
+      ...options
+    , url: URL.appendSearchParam(options.url, name, value)
+    }
+  }
+}

package/src/transformers/basic-auth.ts

@@ -0,0 +1,9 @@
+import { header } from './header.js'
+import { IRequestOptionsTransformer } from '@src/types.js'
+
+export function basicAuth(
+  username: string
+, password: string
+): IRequestOptionsTransformer {
+  return header('Authorization', 'Basic ' + btoa(`${username}:${password}`))
+}

package/src/transformers/bearer-auth.ts

@@ -0,0 +1,6 @@
+import { header } from './header.js'
+import { IRequestOptionsTransformer } from '@src/types.js'
+
+export function bearerAuth(token: string): IRequestOptionsTransformer {
+  return header('Authorization', `Bearer ${token}`)
+}

package/src/transformers/body.ts

@@ -0,0 +1,10 @@
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+
+export function body(val: BodyInit | NodeJS.ReadableStream): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    return {
+      ...options
+    , payload: val
+    }
+  }
+}

package/src/transformers/csv.ts

@@ -0,0 +1,26 @@
+import { Headers } from 'extra-fetch'
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import papaparse from 'papaparse'
+import { assert } from '@blackglory/prelude'
+
+const { unparse } = papaparse
+
+export function csv<T extends object>(payload: T[]): IRequestOptionsTransformer {
+  assert(payload.length > 0, 'payload must be a non-empty array')
+
+  return (options: IRequestOptions) => {
+    const headers = new Headers(options.headers)
+    headers.set('Content-Type', 'text/csv')
+
+    return {
+      ...options
+    , headers
+    , payload: stringify(payload)
+    }
+  }
+}
+
+function stringify<T extends object>(data: T[]): string {
+  const fields = Object.keys(data[0])
+  return unparse({ data, fields })
+}

package/src/transformers/form-data-field.ts

@@ -0,0 +1,33 @@
+import { FormData } from 'extra-fetch'
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import { isArray } from '@blackglory/prelude'
+
+export function formDataField(
+  name: string
+, value: string | string[] | Blob
+): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    const formData = options.payload instanceof FormData
+      ? cloneFormData(options.payload)
+      : new FormData()
+
+    if (isArray(value)) {
+      value.forEach(x => formData.append(name, x))
+    } else {
+      formData.append(name, value)
+    }
+
+    return {
+      ...options
+    , payload: formData
+    }
+  }
+}
+
+function cloneFormData(formData: FormData): FormData{
+  const result = new FormData()
+  for (const [name, value] of formData.entries()) {
+    result.append(name, value)
+  }
+  return result
+}

package/src/transformers/header.ts

@@ -0,0 +1,14 @@
+import { Headers } from 'extra-fetch'
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+
+export function header(name: string, value: string): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    const headers = new Headers(options.headers)
+    headers.set(name, value)
+
+    return {
+      ...options
+    , headers
+    }
+  }
+}

package/src/transformers/headers.ts

@@ -0,0 +1,16 @@
+import { Headers } from 'extra-fetch'
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+
+export function headers(headers: { [name: string]: string }): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    const newHeaders = new Headers(options.headers)
+    for (const [name, value] of Object.entries(headers)) {
+      newHeaders.set(name, value)
+    }
+
+    return {
+      ...options
+    , headers: newHeaders
+    }
+  }
+}

package/src/transformers/host.ts

@@ -0,0 +1,11 @@
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import { setHost } from 'url-operator'
+
+export function host(host: string): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    return {
+      ...options
+    , url: setHost(options.url, host)
+    }
+  }
+}

package/src/transformers/index.ts

@@ -0,0 +1,29 @@
+export * from '@transformers/url.js'
+
+export * from '@transformers/text.js'
+export * from '@transformers/json.js'
+export * from '@transformers/csv.js'
+
+export * from '@transformers/header.js'
+export * from '@transformers/append-header.js'
+export * from '@transformers/headers.js'
+export * from '@transformers/accept.js'
+
+export * from '@transformers/host.js'
+export * from '@transformers/port.js'
+export * from '@transformers/pathname.js'
+export * from '@transformers/append-pathname.js'
+export * from '@transformers/search.js'
+export * from '@transformers/search-param.js'
+export * from '@transformers/search-params.js'
+export * from '@transformers/append-search-param.js'
+
+export * from '@transformers/form-data-field.js'
+
+export * from '@transformers/basic-auth.js'
+export * from '@transformers/bearer-auth.js'
+
+export * from '@transformers/signal.js'
+export * from '@transformers/keepalive.js'
+export * from '@transformers/redirect.js'
+export * from '@transformers/body.js'

package/src/transformers/json.ts

@@ -0,0 +1,18 @@
+import { Headers } from 'extra-fetch'
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import { JSONValue, JSONSerializable } from 'justypes'
+
+export function json<T extends JSONValue | JSONSerializable<any>>(
+  payload: T
+): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    const headers = new Headers(options.headers)
+    headers.set('Content-Type', 'application/json')
+
+    return {
+      ...options
+    , headers
+    , payload: JSON.stringify(payload)
+    }
+  }
+}

package/src/transformers/keepalive.ts

@@ -0,0 +1,10 @@
+import { IRequestOptionsTransformer, IRequestOptions } from '@src/types.js'
+
+export function keepalive(val: boolean = true): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    return {
+      ...options
+    , keepalive: val
+    }
+  }
+}

package/src/transformers/pathname.ts

@@ -0,0 +1,11 @@
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import { setPathname } from 'url-operator'
+
+export function pathname(pathname: string): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    return {
+      ...options
+    , url: setPathname(options.url, pathname)
+    }
+  }
+}

package/src/transformers/port.ts

@@ -0,0 +1,11 @@
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import { setPort } from 'url-operator'
+
+export function port(port: number): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    return {
+      ...options
+    , url: setPort(options.url, port)
+    }
+  }
+}

package/src/transformers/redirect.ts

@@ -0,0 +1,10 @@
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+
+export function redirect(val: RequestRedirect): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    return {
+      ...options
+    , redirect: val
+    }
+  }
+}

package/src/transformers/search-param.ts

@@ -0,0 +1,14 @@
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import { setSearchParam } from 'url-operator'
+
+export function searchParam(
+  name: string
+, value: string | number
+): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    return {
+      ...options
+    , url: setSearchParam(options.url, name, value)
+    }
+  }
+}

package/src/transformers/search-params.ts

@@ -0,0 +1,13 @@
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import { setSearchParams } from 'url-operator'
+
+export function searchParams(
+  searchParams: Record<string, string | number>
+): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    return {
+      ...options
+    , url: setSearchParams(options.url, searchParams)
+    }
+  }
+}

package/src/transformers/search.ts

@@ -0,0 +1,11 @@
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import { setSearch } from 'url-operator'
+
+export function search(search: string): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    return {
+      ...options
+    , url: setSearch(options.url, search)
+    }
+  }
+}

package/src/transformers/signal.ts

@@ -0,0 +1,10 @@
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+
+export function signal(signal: AbortSignal): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    return {
+      ...options
+    , signal
+    }
+  }
+}

package/src/transformers/text.ts

@@ -0,0 +1,15 @@
+import { Headers } from 'extra-fetch'
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+
+export function text(payload: string): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    const headers = new Headers(options.headers)
+    headers.set('Content-Type', 'application/x-www-form-urlencoded')
+
+    return {
+      ...options
+    , headers
+    , payload
+    }
+  }
+}

package/src/transformers/url.ts

@@ -0,0 +1,15 @@
+import { IRequestOptions, IRequestOptionsTransformer } from '@src/types.js'
+import { NonEmptyArray } from 'justypes'
+
+export function url(...urls: NonEmptyArray<string | URL>): IRequestOptionsTransformer {
+  return (options: IRequestOptions) => {
+    const newURL = new URL(
+      [options.url, ...urls].reduce((acc, cur) => new URL(cur, acc))
+    )
+
+    return {
+      ...options
+    , url: newURL
+    }
+  }
+}

package/src/types.ts

@@ -0,0 +1,21 @@
+export type IRequestOptionsTransformer = (options: IRequestOptions) => IRequestOptions
+
+/**
+ * Q: Why not use `Request` interface?
+ * A: Because `Request['body']` is `ReadableStream`,
+ *    it is very difficult to use.
+ * 
+ * Q: Why not use `RequestInit` interface?
+ * A: Because `RequestInit` has no `url` property,
+ *    and its optional properties are not suitable for our cases.
+ */
+export interface IRequestOptions {
+  url: URL
+  headers: Headers
+  payload?:
+  | BodyInit // WHATWG
+  | NodeJS.ReadableStream // node-fetch
+  signal?: AbortSignal
+  keepalive?: boolean
+  redirect?: RequestRedirect
+}

package/lib/browser.d.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './request.js';
-export * from './transformers/index.js';

package/lib/browser.js

@@ -1,4 +0,0 @@
-export * from './types.js';
-export * from './request.js';
-export * from './transformers/index.js';
-//# sourceMappingURL=browser.js.map

package/lib/browser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,yBAAyB,CAAA"}