18629639181

Committed 19 Oct 2025 11:16AM UTC coverage: 97.863% (+10.3%) from 87.552%

Build # 18629639181

Build Type

Pull #273

github

Committed by

web-flow

Commit Message

Merge 9dcc3affe into 0e0b30f4b

Pull Request Pull Request #273: V3

Run Details

317 of 333 branches covered (95.2%)

Branch coverage included in aggregate %.

288 of 293 new or added lines in 13 files covered. (98.29%)

8 existing lines in 5 files now uncovered.

1652 of 1679 relevant lines covered (98.39%)

59.37 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.67

/src/addons/basicAuth.ts

import type { ConfiguredMiddleware, Wretch, WretchAddon } from "../types.js"

function utf8ToBase64(input: string) {
  const utf8Bytes = new TextEncoder().encode(input)
  return btoa(String.fromCharCode(...utf8Bytes))
}

export interface BasicAuthAddon {
  /**
   * Sets the `Authorization` header to `Basic ` + <base64 encoded credentials>.
   * Additionally, allows using URLs with credentials in them.
   *
   * ```js
   * const user = "user"
   * const pass = "pass"
   *
   * // Automatically sets the Authorization header to "Basic " + <base64 encoded credentials>
   * wretch("...").addon(BasicAuthAddon).basicAuth(user, pass).get()
   *
   * // Allows using URLs with credentials in them
   * wretch(`https://${user}:${pass}@...`).addon(BasicAuthAddon).get()
   * ```
   *
   * @param username - Username to use for basic auth
   * @param password - Password to use for basic auth
   */
  basicAuth<T extends BasicAuthAddon, C, R, E>(
    this: T & Wretch<T, C, R, E>,
    username: string,
    password: string
  ): this
}

const makeBasicAuthMiddleware: () => ConfiguredMiddleware = () => next => (url, opts) => {
  let parsedUrl: URL | null
  try {
    parsedUrl = new URL(url)
  } catch {
    parsedUrl = null
  }

  if (parsedUrl?.username || parsedUrl?.password) {
    const basicAuthBase64 = utf8ToBase64(
      `${decodeURIComponent(parsedUrl.username)}:${decodeURIComponent(parsedUrl.password)}`,
    )
    opts.headers = {
      ...opts.headers,
      Authorization: `Basic ${basicAuthBase64}`,
    }
    parsedUrl.username = ""
    parsedUrl.password = ""
    url = parsedUrl.toString()
  }

  return next(url, opts)
}


/**
 * Adds the ability to use basic auth with the `Authorization` header.
 *
 * ```js
 * import BasicAuthAddon from "wretch/addons/basicAuth"
 *
 * wretch().addon(BasicAuthAddon)
 * ```
 */
const basicAuth: WretchAddon<BasicAuthAddon> = {
  beforeRequest(wretch) {
    return wretch.middlewares([makeBasicAuthMiddleware()])
  },
  wretch: {
    basicAuth(username, password) {
      const basicAuthBase64 = utf8ToBase64(`${username}:${password}`)
      return this.auth(`Basic ${basicAuthBase64}`)
    },
  },
}

export default basicAuth

1	import type { ConfiguredMiddleware, Wretch, WretchAddon } from "../types.js"	3✔
2		3✔
3	function utf8ToBase64(input: string) {	9✔
4	const utf8Bytes = new TextEncoder().encode(input)	9✔
5	return btoa(String.fromCharCode(...utf8Bytes))	9✔
6	}	9✔
7		3✔
8	export interface BasicAuthAddon {	3✔
9	/**	3✔
10	* Sets the `Authorization` header to `Basic ` + <base64 encoded credentials>.	3✔
11	* Additionally, allows using URLs with credentials in them.	3✔
12	*	3✔
13	* ```js	3✔
14	* const user = "user"	3✔
15	* const pass = "pass"	3✔
16	*	3✔
17	* // Automatically sets the Authorization header to "Basic " + <base64 encoded credentials>	3✔
18	* wretch("...").addon(BasicAuthAddon).basicAuth(user, pass).get()	3✔
19	*	3✔
20	* // Allows using URLs with credentials in them	3✔
21	* wretch(`https://${user}:${pass}@...`).addon(BasicAuthAddon).get()	3✔
22	* ```	3✔
23	*	3✔
24	* @param username - Username to use for basic auth	3✔
25	* @param password - Password to use for basic auth	3✔
26	*/	3✔
27	basicAuth<T extends BasicAuthAddon, C, R, E>(	3✔
28	this: T & Wretch<T, C, R, E>,	3✔
29	username: string,	3✔
30	password: string	3✔
31	): this	3✔
32	}	3✔
33		3✔
34	const makeBasicAuthMiddleware: () => ConfiguredMiddleware = () => next => (url, opts) => {	3✔
35	let parsedUrl: URL \| null	9✔
36	try {	9✔
37	parsedUrl = new URL(url)	9✔
38	} catch {	9!
39	parsedUrl = null	×
UNCOV 40	}	×
41		9✔
42	if (parsedUrl?.username \|\| parsedUrl?.password) {	9✔
43	const basicAuthBase64 = utf8ToBase64(	3✔
44	`${decodeURIComponent(parsedUrl.username)}:${decodeURIComponent(parsedUrl.password)}`,	3✔
45	)	3✔
46	opts.headers = {	3✔
47	...opts.headers,	3✔
48	Authorization: `Basic ${basicAuthBase64}`,	3✔
49	}	3✔
50	parsedUrl.username = ""	3✔
51	parsedUrl.password = ""	3✔
52	url = parsedUrl.toString()	3✔
53	}	3✔
54		9✔
55	return next(url, opts)	9✔
56	}	9✔
57		3✔
58		3✔
59	/**	3✔
60	* Adds the ability to use basic auth with the `Authorization` header.	3✔
61	*	3✔
62	* ```js	3✔
63	* import BasicAuthAddon from "wretch/addons/basicAuth"	3✔
64	*	3✔
65	* wretch().addon(BasicAuthAddon)	3✔
66	* ```	3✔
67	*/	3✔
68	const basicAuth: WretchAddon<BasicAuthAddon> = {	3✔
69	beforeRequest(wretch) {	3✔
70	return wretch.middlewares([makeBasicAuthMiddleware()])	9✔
71	},	9✔
72	wretch: {	3✔
73	basicAuth(username, password) {	3✔
74	const basicAuthBase64 = utf8ToBase64(`${username}:${password}`)	6✔
75	return this.auth(`Basic ${basicAuthBase64}`)	6✔
76	},	6✔
77	},	3✔
78	}	3✔
79		3✔
80	export default basicAuth	3✔

elbywan / wretch / 18629639181

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous