Add fromRfc7231 function

Author: fabon-f

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- `startOfYear`, `startOfMonth`, `startOfDay`, `startOfHour`, `startOfMinute`, `startOfSecond`, `endOfYear`, `endOfMonth`, `endOfDay`, `endOfHour`, `endOfMinute`, `endOfSecond`, `fromRfc2822` functions
+- `startOfYear`, `startOfMonth`, `startOfDay`, `startOfHour`, `startOfMinute`, `startOfSecond`, `endOfYear`, `endOfMonth`, `endOfDay`, `endOfHour`, `endOfMinute`, `endOfSecond`, `fromRfc2822`, `fromRfc7231` functions
 
 ### Changed
 

src/datetime/fromRfc7231.test.ts

@@ -0,0 +1,64 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { expect, test } from "vitest";
+
+import { fromRfc7231 } from "./fromRfc7231.js";
+
+test("Instant", () => {
+	expect(
+		fromRfc7231("Fri, 07 Jun 2024 01:23:45 GMT", Temporal.Instant),
+	).toEqual(Temporal.Instant.from("2024-06-07T01:23:45Z"));
+});
+
+test("PlainDateTime", () => {
+	expect(
+		fromRfc7231("Fri, 07 Jun 2024 01:23:45 GMT", Temporal.PlainDateTime),
+	).toEqual(Temporal.PlainDateTime.from("2024-06-07T01:23:45"));
+});
+
+test("ZonedDateTime", () => {
+	expect(
+		fromRfc7231("Fri, 07 Jun 2024 01:23:45 GMT", Temporal.ZonedDateTime),
+	).toEqual(Temporal.ZonedDateTime.from("2024-06-07T01:23:45+00:00[UTC]"));
+});
+
+test("wrong format", () => {
+	expect(() => {
+		fromRfc7231("Fri, 7 Jun 2024 01:23:45 GMT", Temporal.Instant);
+	}).toThrowError();
+});
+
+test("wrong day of week", () => {
+	expect(() => {
+		fromRfc7231("Tue, 07 Jun 2024 01:23:45 GMT", Temporal.Instant);
+	}).toThrowError(/Tue/);
+	expect(() => {
+		fromRfc7231("Tue, 07 Jun 2024 01:23:45 GMT", Temporal.PlainDateTime);
+	}).toThrowError(/Tue/);
+	expect(() => {
+		fromRfc7231("Tue, 07 Jun 2024 01:23:45 GMT", Temporal.ZonedDateTime);
+	}).toThrowError(/Tue/);
+});
+
+test("invalid day of week", () => {
+	expect(() => {
+		fromRfc7231("Mot, 07 Jun 2024 01:23:45 GMT", Temporal.Instant);
+	}).toThrowError(/Mot/);
+	expect(() => {
+		fromRfc7231("Mot, 07 Jun 2024 01:23:45 GMT", Temporal.PlainDateTime);
+	}).toThrowError(/Mot/);
+	expect(() => {
+		fromRfc7231("Mot, 07 Jun 2024 01:23:45 GMT", Temporal.ZonedDateTime);
+	}).toThrowError(/Mot/);
+});
+
+test("invalid month", () => {
+	expect(() => {
+		fromRfc7231("Mon, 07 Jut 2024 01:23:45 GMT", Temporal.Instant);
+	}).toThrowError(/Jut/);
+	expect(() => {
+		fromRfc7231("Mon, 07 Jut 2024 01:23:45 GMT", Temporal.PlainDateTime);
+	}).toThrowError(/Jut/);
+	expect(() => {
+		fromRfc7231("Mon, 07 Jut 2024 01:23:45 GMT", Temporal.ZonedDateTime);
+	}).toThrowError(/Jut/);
+});

src/datetime/fromRfc7231.ts

@@ -0,0 +1,87 @@
+import {
+	isInstantConstructor,
+	isZonedDateTimeConstructor,
+} from "../type-utils.js";
+import type { Temporal } from "../types.js";
+import { formatExactTimeIso } from "./_formatExactTimeIso.js";
+import { getDayOfWeekFromYmd } from "./_getDayOfWeekFromYmd.js";
+import { getDayOfWeekNumberFromAbbreviation } from "./_getDayOfWeekNumberFromAbbreviation.js";
+import { getMonthNumberFromAbbreviation } from "./_getMonthNumberFromAbbreviation.js";
+
+const regex =
+	/^([A-Za-z]{3}), (\d\d) ([A-Za-z]{3}) (\d{4}) (\d\d):(\d\d):(\d\d) GMT$/;
+
+function parse(date: string) {
+	const result = regex.exec(date);
+	if (result === null) {
+		throw new Error("Invalid format");
+	}
+	const [, dayOfWeek, day, monthName, year, hour, minute, second] = result;
+	if (
+		dayOfWeek === undefined ||
+		day === undefined ||
+		monthName === undefined ||
+		year === undefined ||
+		hour === undefined ||
+		minute === undefined ||
+		second === undefined
+	) {
+		throw new Error("something wrong");
+	}
+	const y = parseInt(year);
+	const m = getMonthNumberFromAbbreviation(monthName);
+	const d = parseInt(day);
+	const weekNum = getDayOfWeekNumberFromAbbreviation(dayOfWeek);
+	if (getDayOfWeekFromYmd(y, m, d) !== weekNum) {
+		throw new Error(`Wrong day of week: ${dayOfWeek}`);
+	}
+	return [y, m, d, parseInt(hour), parseInt(minute), parseInt(second)] as const;
+}
+
+/**
+ * Creates Temporal object from datetime string in RFC 7231's format (HTTP date format)
+ * such as `Mon, 01 Jan 2024 01:23:45 GMT`.
+ * This function doesn't support obsoleted formats.
+ *
+ * @param date datetime string in RFC 7231's format
+ * @param TemporalClass Temporal class (such as `Temporal.PlainDateTime` or `Temporal.Instant`) which will be returned
+ * @returns an instance of Temporal class specified in `TemporalClass` argument
+ */
+export function fromRfc7231<
+	TemporalClassType extends
+		| typeof Temporal.Instant
+		| typeof Temporal.ZonedDateTime
+		| typeof Temporal.PlainDateTime,
+>(
+	date: string,
+	TemporalClass: TemporalClassType,
+): InstanceType<TemporalClassType> {
+	const result = parse(date);
+	const [year, month, day, hour, minute, second] = result;
+	if (isInstantConstructor(TemporalClass)) {
+		return TemporalClass.from(
+			formatExactTimeIso(year, month, day, hour, minute, second, 0, "Z"),
+		) as InstanceType<TemporalClassType>;
+	}
+	if (isZonedDateTimeConstructor(TemporalClass)) {
+		return TemporalClass.from({
+			year,
+			month,
+			day,
+			hour,
+			minute,
+			second,
+			calendarId: "iso8601",
+			timeZone: "UTC",
+		}) as InstanceType<TemporalClassType>;
+	}
+	return TemporalClass.from({
+		year,
+		month,
+		day,
+		hour,
+		minute,
+		second,
+		calendarId: "iso8601",
+	}) as InstanceType<TemporalClassType>;
+}

src/datetime/index.ts

@@ -20,6 +20,7 @@ export {
 	type FormatWithoutLocaleOptions,
 } from "./formatWithoutLocale.js";
 export { fromRfc2822 } from "./fromRfc2822.js";
+export { fromRfc7231 } from "./fromRfc7231.js";
 export { isAfter } from "./isAfter.js";
 export { isBefore } from "./isBefore.js";
 export { isWithinInterval } from "./isWithinInterval.js";