🤖 Merge PR #69734 [@types/set-cookie-parser] Update typings of sameSite property by @petercpwong

petercpwong · web-flow · commit 4dfd3f058adc · 2024-06-12T01:08:09.000-07:00
diff --git a/types/set-cookie-parser/index.d.ts b/types/set-cookie-parser/index.d.ts
@@ -85,7 +85,7 @@ declare namespace parse {
         /**
          * indicates a cookie ought not to be sent along with cross-site requests
          */
-        sameSite?: string | undefined;
+        sameSite?: true | false | 'lax' | 'strict' | 'none' | undefined
     }
 
     interface CookieMap {
diff --git a/types/set-cookie-parser/set-cookie-parser-tests.ts b/types/set-cookie-parser/set-cookie-parser-tests.ts
@@ -19,7 +19,7 @@ assert.strictEqual(cookies[0].value, "bar");
 
 // Optional properties included test
 const optionalIncluded =
-    "foo=bar; Max-Age=1000; Domain=.example.com; Path=/; Expires=Tue, 01 Jul 2025 10:01:11 GMT; HttpOnly; Secure; SameSite=Strict";
+    "foo=bar; Max-Age=1000; Domain=.example.com; Path=/; Expires=Tue, 01 Jul 2025 10:01:11 GMT; HttpOnly; Secure; SameSite=strict";
 cookies = setCookie(optionalIncluded);
 assert.strictEqual(cookies.length, 1);
 assert.strictEqual(cookies[0].name, "foo");
@@ -30,7 +30,7 @@ assert.deepStrictEqual(cookies[0].expires, new Date("Tue Jul 01 2025 06:01:11 GM
 assert.strictEqual(cookies[0].maxAge, 1000);
 assert.strictEqual(cookies[0].httpOnly, true);
 assert.strictEqual(cookies[0].secure, true);
-assert.strictEqual(cookies[0].sameSite, "Strict");
+assert.strictEqual(cookies[0].sameSite, "strict");
 
 // Array of strings test
 const arrayOfCookies = ["bam=baz", "foo=bar"];
@@ -125,7 +125,7 @@ assert.deepStrictEqual(cookiesMap, expectedCookiesMap);
 
 // Call parseString function
 const individualSetCookieHeader =
-    "user=%D0%98%D0%BB%D1%8C%D1%8F%20%D0%97%D0%B0%D0%B9%D1%86%D0%B5%D0%B2; Max-Age=1000; Domain=.example.com; Path=/; Expires=Tue, 01 Jul 2025 10:01:11 GMT; HttpOnly; Secure; SameSite=Strict";
+    "user=%D0%98%D0%BB%D1%8C%D1%8F%20%D0%97%D0%B0%D0%B9%D1%86%D0%B5%D0%B2; Max-Age=1000; Domain=.example.com; Path=/; Expires=Tue, 01 Jul 2025 10:01:11 GMT; HttpOnly; Secure; SameSite=strict";
 const decodedValueCookie = setCookie.parseString(individualSetCookieHeader);
 const notDecodedValueCookie = setCookie.parseString(individualSetCookieHeader, { decodeValues: false });
 const expectedCookie: setCookie.Cookie = {
@@ -137,7 +137,7 @@ const expectedCookie: setCookie.Cookie = {
     expires: new Date("Tue, 01 Jul 2025 10:01:11 GMT"),
     httpOnly: true,
     secure: true,
-    sameSite: "Strict",
+    sameSite: "strict",
 };
 assert.deepStrictEqual(decodedValueCookie, expectedCookie);
 assert.strictEqual(notDecodedValueCookie.value, "%D0%98%D0%BB%D1%8C%D1%8F%20%D0%97%D0%B0%D0%B9%D1%86%D0%B5%D0%B2");

Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ declare namespace parse {`
`85`	`85`	`/**`
`86`	`86`	`* indicates a cookie ought not to be sent along with cross-site requests`
`87`	`87`	`*/`
`88`		`- sameSite?: string \| undefined;`
	`88`	`+ sameSite?: true \| false \| 'lax' \| 'strict' \| 'none' \| undefined`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`interface CookieMap {`