Merge pull request #4 from httpland/beta

Beta

Author: TomokiMiyauci

CHANGELOG.md

@@ -1,3 +1,11 @@
+# [1.2.0-beta.1](https://github.com/httpland/http-utils/compare/1.1.0...1.2.0-beta.1) (2023-04-29)
+
+
+### Features
+
+* **list:** add parser for list-based fields ([47f69bd](https://github.com/httpland/http-utils/commit/47f69bda005ef4adfabf34ad02e94e35cb51e06a))
+* **token:** export related types ([35e0839](https://github.com/httpland/http-utils/commit/35e08398e1ac369f1c20f5365fe5668b1840f0ba))
+
 # [1.1.0](https://github.com/httpland/http-utils/compare/1.0.0...1.1.0) (2023-04-29)
 
 

README.md

@@ -542,6 +542,34 @@ assert(response.headers.get(header), value);
 assert(init !== response);
 ```
 
+## Lists
+
+Compliant with
+[RFC 9110, 5.6.1. Lists](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.6.1).
+
+### parseListFields
+
+Parse
+[list-based fields](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.5-7)
+into array.
+
+Strings enclosed in double quotes are safely handled.
+
+```ts
+import { parseListFields } from "https://deno.land/x/http_utils@$VERSION/list.ts";
+import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts";
+
+assertEquals(parseListFields("foo , ,bar,charlie"), [
+  "foo",
+  "bar",
+  "charlie",
+]);
+assertEquals(parseListFields(`"Sat, 04 May 1996", "Wed, 14 Sep 2005"`), [
+  `"Sat, 04 May 1996"`,
+  `"Wed, 14 Sep 2005"`,
+]);
+```
+
 ## Tokens
 
 Compliant with
@@ -625,7 +653,8 @@ assertFalse(isQuotedPair("\\"));
 ### isQuotedString
 
 Whether the input is
-[quoted-string](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.6.4-2).
+[quoted-string](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.6.4-2) or
+not.
 
 ```ts
 import { isQuotedString } from "https://deno.land/x/http_utils@$VERSION/quoted_string.ts";

_tools/meta.ts

@@ -102,10 +102,15 @@ export const makeOptions = (version: string): BuildOptions => ({
   },
   packageManager: "pnpm",
   mappings: {
-    "https://deno.land/x/isx@1.1.1/is_null.ts": {
+    "https://deno.land/x/isx@1.3.1/is_null.ts": {
       name: "@miyauci/isx",
-      version: "1.1.1",
-      subPath: "is_null",
+      version: "1.3.1",
+      subPath: "is_null.js",
+    },
+    "https://deno.land/x/[email protected]/trim.ts": {
+      name: "@miyauci/prelude",
+      version: "1.2.0",
+      subPath: "trim.js",
     },
   },
 });

deno.lock

@@ -1,4 +1,5 @@
 // Copyright 2023-latest the httpland authors. All rights reserved. MIT license.
 // This module is browser compatible.
 
-export { isNull } from "https://deno.land/x/[email protected]/is_null.ts";
+export { isNull } from "https://deno.land/x/[email protected]/is_null.ts";
+export { trim } from "https://deno.land/x/[email protected]/trim.ts";

deps.ts

@@ -0,0 +1,30 @@
+// Copyright 2023-latest the httpland authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
+import { trim } from "./deps.ts";
+
+/** Parse [list-based fields](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.5-7) into array.
+ * Strings enclosed in double quotes are safely handled.
+ *
+ * @example
+ * ```ts
+ * import { parseListFields } from "https://deno.land/x/http_utils@$VERSION/list.ts";
+ * import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts";
+ *
+ * assertEquals(parseListFields("foo , ,bar,charlie"), [
+ *   "foo",
+ *   "bar",
+ *   "charlie",
+ * ]);
+ * assertEquals(parseListFields(`"Sat, 04 May 1996", "Wed, 14 Sep 2005"`), [
+ *   `"Sat, 04 May 1996"`,
+ *   `"Wed, 14 Sep 2005"`,
+ * ]);
+ * ```
+ */
+export function parseListFields(input: string): string[] {
+  return input
+    .split(/,(?=(?:(?:[^"]*?"){2})*?[^"]*?$)/)
+    .map(trim)
+    .filter(Boolean);
+}

list.ts

@@ -0,0 +1,56 @@
+import { parseListFields } from "./list.ts";
+import { assertEquals, describe, it } from "./_dev_deps.ts";
+
+describe("parseListFields", () => {
+  it("should ", () => {
+    const table: [string, string[]][] = [
+      ["", []],
+      ["a", ["a"]],
+      ["a, b, c", ["a", "b", "c"]],
+      ["   a, a   , a   ", ["a", "a", "a"]],
+      [`"", `, [`""`]],
+      [`","`, [`","`]],
+      [`",", `, [`","`]],
+      [`"," ,`, [`","`]],
+      [`",,," ,`, [`",,,"`]],
+      [`"," , " , "`, [`","`, `" , "`]],
+      [`","abc,`, [`","abc`]],
+      ["a, b,,,,", ["a", "b"]],
+      ["a, b, c", ["a", "b", "c"]],
+      ["a,b,c", ["a", "b", "c"]],
+      ["a,,c", ["a", "c"]],
+      [",,,", []],
+      [`"a,b"`, [`"a,b"`]],
+      [`"a,b",c, "d,e", f f , g `, [`"a,b"`, "c", `"d,e"`, "f f", "g"]],
+      [`   complex,pattern,"abc", "abc , def", ,,,, """, , ",""`, [
+        "complex",
+        "pattern",
+        `"abc"`,
+        `"abc , def"`,
+        `""", , "`,
+        `""`,
+      ]],
+      [`",","`, [`"`, `","`]],
+      [`",",","`, [`","`, `","`]],
+      [`",",",",`, [`","`, `","`]],
+      [`",",",","`, [`"`, `","`, `","`]],
+      [`",",",",",`, [`"`, `","`, `","`]],
+      [`",",",",","`, [`","`, `","`, `","`]],
+      [`"`, [`"`]],
+      [`""`, [`""`]],
+      [`"""`, [`"""`]],
+      [`""""`, [`""""`]],
+      [`"",""`, [`""`, `""`]],
+      [`",",`, [`","`]],
+      [`"abc,def", "efg, hij", "lmn, opq"`, [
+        '"abc,def"',
+        '"efg, hij"',
+        '"lmn, opq"',
+      ]],
+    ];
+
+    table.forEach(([input, expected]) => {
+      assertEquals(parseListFields(input), expected);
+    });
+  });
+});

list_test.ts

@@ -72,7 +72,7 @@ export type QuotedString = `"${string}"`;
 const reQuotedString =
   /^"(?:[\t \x21\x23-\x5B\x5D-\x7E\x80-\xFF]|\\[\t \x21-\x7E\x80-\xFF])*?"$/;
 
-/** Whether the input is [quoted-string](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.6.4-2).
+/** Whether the input is [quoted-string](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.6.4-2) or not.
  *
  * @example
  * ```ts

quoted_string.ts

@@ -64,6 +64,9 @@ export type Tchar =
  */
 const reToken = /^[\w!#$%&'*+.^`|~-]+$/;
 
+/** Representation of [token](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.6.2-2). */
+export type Token = `${Tchar}${string}`;
+
 /** Whether the input is [token](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.6.2-2) or not.
  *
  * @example
@@ -79,7 +82,7 @@ const reToken = /^[\w!#$%&'*+.^`|~-]+$/;
  * assertFalse(isToken(""));
  * ```
  */
-export function isToken(input: string): input is `${Tchar}${string}` {
+export function isToken(input: string): input is Token {
   return reToken.test(input);
 }