feat(types): rename field to params

Author: TomokiMiyauci

README.md

@@ -1,4 +1,4 @@
-# authorization-parser
+# auth-parser
 
 [![deno land](http://img.shields.io/badge/available%20on-deno.land/x-lightgrey.svg?logo=deno)](https://deno.land/x/authorization_parser)
 [![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/authorization_parser/mod.ts)
@@ -9,7 +9,8 @@
 [![test](https://github.com/httpland/authorization-parser/actions/workflows/test.yaml/badge.svg)](https://github.com/httpland/authorization-parser/actions/workflows/test.yaml)
 [![NPM](https://nodei.co/npm/@httpland/authorization-parser.png?mini=true)](https://nodei.co/npm/@httpland/authorization-parser/)
 
-HTTP `Authorization` field parser and serializer.
+HTTP Authentication and Authorization `Authorization` field parser and
+serializer.
 
 Compliant with
 [RFC 9110, 11.6.2. Authorization](https://www.rfc-editor.org/rfc/rfc9110.html#section-11.6.2).
@@ -26,13 +27,13 @@ const result = parseAuthorization("Basic token68");
 
 assertEquals(parseAuthorization("Basic token68"), {
   authScheme: "Basic",
-  token: "token68",
+  params: "token68",
 });
 assertEquals(
   parseAuthorization(`Bearer realm="example", error="invalid_token"`),
   {
     authScheme: "Bearer",
-    token: {
+    params: {
       realm: `"example"`,
       error: `"invalid_token"`,
     },
@@ -81,10 +82,10 @@ assertThrows(() =>
 
 `Authorization` is following structure:
 
-| Name       | Type                                       | Description            |
-| ---------- | ------------------------------------------ | ---------------------- |
-| authScheme | `string`                                   | Authentication scheme. |
-| token      | `Token68` | `AuthParam` | `null` | token68 or auth-param. |
+| Name       | Type                                        | Description            |
+| ---------- | ------------------------------------------- | ---------------------- |
+| authScheme | `string`                                    | Authentication scheme. |
+| params     | `Token68` | `AuthParams` | `null` | token68 or auth-param. |
 
 ### Token68
 
@@ -95,12 +96,12 @@ so that it can hold a base64, base64url (URL and filename safe alphabet),
 base32, or base16 (hex) encoding, with or without padding, but excluding
 whitespace.
 
-### AuthParam
+### AuthParams
 
 It is name/value pairs.
 
 ```ts
-interface AuthParam {
+interface AuthParams {
   readonly [k: string]: string;
 }
 ```

authorization.json

@@ -5,7 +5,7 @@
     "header": "Basic YWxhZGRpbjpvcGVuc2VzYW1l",
     "expected": {
       "authScheme": "Basic",
-      "authParams": "YWxhZGRpbjpvcGVuc2VzYW1l"
+      "params": "YWxhZGRpbjpvcGVuc2VzYW1l"
     }
   },
   {
@@ -14,7 +14,7 @@
     "header": "Bearer realm=\"example\", error=\"invalid_token\", error_description=\"The access token expired\"",
     "expected": {
       "authScheme": "Bearer",
-      "authParams": {
+      "params": {
         "realm": "\"example\"",
         "error": "\"invalid_token\"",
         "error_description": "\"The access token expired\""
@@ -27,7 +27,7 @@
     "header": "Digest username=\"Mufasa\", realm=\"[email protected]\", uri=\"/dir/index.html\", algorithm=SHA-256, nonce=\"7ypf/xlj9XXwfDPEoM4URrv/xwf94BcCAzFZH4GiTo0v\", nc=00000001, cnonce=\"f2/wE4q74E6zIJEtWaHKaf5wv/H5QzzpXusqGemxURZJ\", qop=auth, response=\"753927fa0e85d155564e2e272a28d1802ca10daf4496794697cf8db5856cb6c1\", opaque=\"FQhe/qaU925kfnzjCev0ciny7QMkPqMAFRtzCUYo5tdS\"",
     "expected": {
       "authScheme": "Digest",
-      "authParams": {
+      "params": {
         "username": "\"Mufasa\"",
         "realm": "\"[email protected]\"",
         "uri": "\"/dir/index.html\"",
@@ -47,7 +47,7 @@
     "ref": "https://datatracker.ietf.org/doc/html/rfc7616#section-3.9.2",
     "expected": {
       "authScheme": "Digest",
-      "authParams": {
+      "params": {
         "username": "\"488869477bf257147b804c45308cd62ac4e25eb717b12b298c79e62dcea254ec\"",
         "realm": "\"[email protected]\"",
         "uri": "\"/doe.json\"",
@@ -68,7 +68,7 @@
     "ref": "https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html",
     "expected": {
       "authScheme": "AWS4-HMAC-SHA256",
-      "authParams": {
+      "params": {
         "Credential": "\"AKIAIOSFODNN7EXAMPLE/20130524/us-east-1/s3/aws4_request\"",
         "SignedHeaders": "\"host;range;x-amz-date\"",
         "Signature": "fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc963176630326f1024"

parse.ts

@@ -20,13 +20,13 @@ const reAuthorization =
  *
  * assertEquals(parseAuthorization("Basic token68"), {
  *   authScheme: "Basic",
- *   token: "token68",
+ *   params: "token68",
  * });
  * assertEquals(
  *   parseAuthorization(`Bearer realm="example", error="invalid_token"`),
  *   {
  *     authScheme: "Bearer",
- *     token: {
+ *     params: {
  *       realm: `"example"`,
  *       error: `"invalid_token"`,
  *     },
@@ -44,11 +44,11 @@ export function parseAuthorization(input: string): Authorization {
 
   const groups = result.groups as ParsedGroups;
   const { authScheme } = groups;
-  const authParams = isString(groups.authParam)
+  const params = isString(groups.authParam)
     ? parseAuthParams(groups.authParam)
     : groups.token68;
 
-  return { authScheme, authParams: authParams ?? null };
+  return { authScheme, params: params ?? null };
 }
 
 type ParsedGroups = {

types.ts

@@ -1,13 +1,15 @@
 // Copyright 2023-latest the httpland authors. All rights reserved. MIT license.
 // This module is browser compatible.
 
-/** Credentials API. */
+/** Credentials API.
+ * @see [RFC 9110, 11.4. Credentials](https://www.rfc-editor.org/rfc/rfc9110.html#section-11.4)
+ */
 export interface Credentials {
   /** Authentication scheme. */
   readonly authScheme: string;
 
   /** Authentication parameters. */
-  readonly authParams: Token68 | AuthParams | null;
+  readonly params: Token68 | AuthParams | null;
 }
 
 /** Representation of [token68](https://www.rfc-editor.org/rfc/rfc9110.html#auth.params). */
@@ -20,4 +22,7 @@ export interface AuthParams {
   readonly [k: string]: string;
 }
 
+/** Authorization API.
+ * @see [RFC 9110, 11.6.2. Authorization](https://www.rfc-editor.org/rfc/rfc9110.html#section-11.6.2)
+ */
 export type Authorization = Credentials;