tough-cookie 5.0.0 → 5.1.0-rc.0

package/README.md

@@ -22,12 +22,16 @@ yarn add tough-cookie
 import { Cookie, CookieJar } from 'tough-cookie'
 
 // parse a `Cookie` request header
-const reqCookies = 'ID=298zf09hf012fh2; csrf=u32t4o3tb3gg43; _gat=1'.split(';').map(Cookie.parse)
+const reqCookies = 'ID=298zf09hf012fh2; csrf=u32t4o3tb3gg43; _gat=1'
+  .split(';')
+  .map(Cookie.parse)
 // generate a `Cookie` request header
-const cookieHeader = reqCookies.map(cookie => cookie.cookieString()).join(';')
+const cookieHeader = reqCookies.map((cookie) => cookie.cookieString()).join(';')
 
 // parse a Set-Cookie response header
-const resCookie = Cookie.parse('foo=bar; Domain=example.com; Path=/; Expires=Tue, 21 Oct 2025 00:00:00 GMT')
+const resCookie = Cookie.parse(
+  'foo=bar; Domain=example.com; Path=/; Expires=Tue, 21 Oct 2025 00:00:00 GMT',
+)
 // generate a Set-Cookie response header
 const setCookieHeader = cookie.toString()
 
@@ -58,8 +62,14 @@ import { CookieJar } from 'tough-cookie'
 const cookieJar = new CookieJar() // uses the in-memory store by default
 
 // storing cookies with various SameSite attributes
-await cookieJar.setCookie('strict=authorized; SameSite=strict', 'http://example.com/index.html')
-await cookieJar.setCookie('lax=okay; SameSite=lax', 'http://example.com/index.html')
+await cookieJar.setCookie(
+  'strict=authorized; SameSite=strict',
+  'http://example.com/index.html',
+)
+await cookieJar.setCookie(
+  'lax=okay; SameSite=lax',
+  'http://example.com/index.html',
+)
 await cookieJar.setCookie('normal=whatever', 'http://example.com/index.html')
 
 // retrieving cookies using a SameSite context
@@ -105,7 +115,7 @@ You can define this functionality by passing in the `prefixSecurity` option to `
 import { CookieJar, MemoryCookieStore } from 'tough-cookie'
 
 const cookieJar = new CookieJar(new MemoryCookieStore(), {
-  prefixSecurity: 'silent'
+  prefixSecurity: 'silent',
 })
 
 // this cookie will be silently ignored since the url is insecure (http)
@@ -132,8 +142,8 @@ for older versions of node, and we will do so in consultation with our community
 
 [npm-badge]: https://img.shields.io/npm/v/tough-cookie.svg?style=flat
 [npm-repo]: https://www.npmjs.com/package/tough-cookie
-[ci-badge]: https://github.com/salesforce/tough-cookie/actions/workflows/integration.yaml/badge.svg
-[ci-url]: https://github.com/salesforce/tough-cookie/actions/workflows/integration.yaml
+[ci-badge]: https://github.com/salesforce/tough-cookie/actions/workflows/ci.yaml/badge.svg
+[ci-url]: https://github.com/salesforce/tough-cookie/actions/workflows/ci.yaml
 [rfc6265-badge]: https://img.shields.io/badge/RFC-6265-flat?labelColor=000000&color=666666
 [rfc6265-tracker]: https://datatracker.ietf.org/doc/rfc6265/
 [rfc6265bis-badge]: https://img.shields.io/badge/RFC-6265bis-flat?labelColor=000000&color=666666

package/dist/cookie/cookie.d.ts

@@ -217,6 +217,17 @@ export declare class Cookie {
      * @param now - can be used to provide a time offset (instead of {@link Cookie.lastAccessed}) to use when calculating the "Max-Age" value
      */
     expiryTime(now?: Date): number | undefined;
+    /**
+     * Similar to {@link Cookie.expiryTime}, computes the absolute unix-epoch milliseconds that this cookie expires and returns it as a Date.
+     *
+     * The "Max-Age" attribute takes precedence over "Expires" (as per the RFC). The {@link Cookie.lastAccessed} attribute
+     * (or the `now` parameter if given) is used to offset the {@link Cookie.maxAge} attribute.
+     *
+     * If Expires ({@link Cookie.expires}) is set, that's returned.
+     *
+     * @param now - can be used to provide a time offset (instead of {@link Cookie.lastAccessed}) to use when calculating the "Max-Age" value
+     */
+    expiryDate(now?: Date): Date | undefined;
     /**
      * Indicates if the cookie has been persisted to a store or not.
      * @public

package/dist/cookie/cookie.js

@@ -675,6 +675,36 @@ class Cookie {
         }
         return this.expires ? this.expires.getTime() : undefined;
     }
+    /**
+     * Similar to {@link Cookie.expiryTime}, computes the absolute unix-epoch milliseconds that this cookie expires and returns it as a Date.
+     *
+     * The "Max-Age" attribute takes precedence over "Expires" (as per the RFC). The {@link Cookie.lastAccessed} attribute
+     * (or the `now` parameter if given) is used to offset the {@link Cookie.maxAge} attribute.
+     *
+     * If Expires ({@link Cookie.expires}) is set, that's returned.
+     *
+     * @param now - can be used to provide a time offset (instead of {@link Cookie.lastAccessed}) to use when calculating the "Max-Age" value
+     */
+    expiryDate(now) {
+        const millisec = this.expiryTime(now);
+        if (millisec == Infinity) {
+            // The 31-bit value of 2147483647000 was chosen to be the MAX_TIME representable
+            // in tough-cookie though MDN states that the actual maximum value for a Date is 8.64e15.
+            // I'm guessing this is due to the Y2038 problem that would affect systems that store
+            // unix time as 32-bit integers.
+            // See:
+            // - https://github.com/salesforce/tough-cookie/commit/0616f70bf725e00c63d442544ad230c4f8b23357
+            // - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#the_epoch_timestamps_and_invalid_date
+            // - https://en.wikipedia.org/wiki/Year_2038_problem
+            return new Date(2147483647000);
+        }
+        else if (millisec == -Infinity) {
+            return new Date(0);
+        }
+        else {
+            return millisec == undefined ? undefined : new Date(millisec);
+        }
+    }
     /**
      * Indicates if the cookie has been persisted to a store or not.
      * @public

package/dist/cookie/cookieJar.d.ts

@@ -310,7 +310,7 @@ export declare class CookieJar {
      * @param url - The domain to store the cookie with.
      * @param options - Configuration settings to use when retrieving the cookies.
      */
-    getCookies(url: string | URL, options?: GetCookiesOptions | undefined): Promise<Cookie[]>;
+    getCookies(url: string | URL, options?: GetCookiesOptions): Promise<Cookie[]>;
     /**
      * @internal No doc because this is an overload that supports the implementation
      */

package/dist/cookie/cookieJar.js

@@ -527,7 +527,7 @@ class CookieJar {
             // deferred from S5.3
             // non-RFC: allow retention of expired cookies by choice
             const expiryTime = c.expiryTime();
-            if (expireCheck && expiryTime && expiryTime <= now) {
+            if (expireCheck && expiryTime != undefined && expiryTime <= now) {
                 store.removeCookie(c.domain, c.path, c.key, () => { }); // result ignored
                 return false;
             }

package/dist/pathMatch.js

@@ -32,8 +32,7 @@ function pathMatch(reqPath, cookiePath) {
         // " o  The cookie-path is a prefix of the request-path, and the first
         // character of the request-path that is not included in the cookie- path
         // is a %x2F ("/") character."
-        if (new RegExp(`^${cookiePath}`).test(reqPath) &&
-            reqPath[cookiePath.length] === '/') {
+        if (reqPath.startsWith(cookiePath) && reqPath[cookiePath.length] === '/') {
             return true;
         }
     }

package/dist/utils.js

@@ -29,7 +29,8 @@ const safeToStringImpl = (val, seenArrays = new WeakSet()) => {
         return Array.isArray(val)
             ? // Arrays have a weird custom toString that we need to replicate
                 safeArrayToString(val, seenArrays)
-            : String(val);
+            : // eslint-disable-next-line @typescript-eslint/no-base-to-string
+                String(val);
     }
     else {
         // This case should just be objects with null prototype, so we can just use Object#toString

package/dist/version.d.ts

@@ -2,4 +2,4 @@
  * The version of `tough-cookie`
  * @public
  */
-export declare const version = "5.0.0";
+export declare const version = "5.1.0-rc.0";

package/dist/version.js

@@ -5,4 +5,4 @@ exports.version = void 0;
  * The version of `tough-cookie`
  * @public
  */
-exports.version = '5.0.0';
+exports.version = '5.1.0-rc.0';

package/package.json

@@ -75,7 +75,7 @@
     "RFC6265",
     "RFC2965"
   ],
-  "version": "5.0.0",
+  "version": "5.1.0-rc.0",
   "homepage": "https://github.com/salesforce/tough-cookie",
   "repository": {
     "type": "git",
@@ -92,21 +92,25 @@
     "!__tests__"
   ],
   "scripts": {
-    "api:dev": "npm run build && npm run api:extract -- --local && npm run api:docs",
-    "api:docs": "api-documenter markdown --input-folder ./tmp --output-folder ./api/docs",
-    "api:extract": "api-extractor run --verbose",
-    "build": "npm run clean && tsc",
-    "clean": "rm -rf dist",
-    "version": "genversion --template version-template.ejs --force lib/version.ts && git add lib/version.ts",
-    "test": "npm run test:ts && npm run test:legacy",
-    "test:ts": "jest",
-    "test:legacy": "npm run build -- --declaration false && ./test/scripts/vows.js test/*_test.js",
-    "typecheck": "tsc --noEmit",
-    "cover": "jest --coverage",
-    "lint": "eslint .",
-    "eslint": "eslint .",
-    "prettier": "prettier '**/*.{json,ts,yaml,md}'",
-    "format": "npm run eslint -- --fix"
+    "build": "npm run _build:clean && npm run _build:compile",
+    "lint": "npm run _lint:check",
+    "prepack": "npm run build",
+    "prepare-pr": "npm test && npm run _api:update && npm run _docs:generate && npm run _format:fix && npm run _lint:fix",
+    "test": "npm run build && npm run _test:ts && npm run _test:legacy",
+    "version": "npm run _version:generate && npm run prepare-pr && git add --renormalize .",
+    "_api:check": "api-extractor run --verbose",
+    "_api:update": "api-extractor run --verbose --local",
+    "_build:clean": "rm -rf dist",
+    "_build:compile": "tsc",
+    "_docs:generate": "api-documenter markdown --input-folder ./tmp --output-folder ./api/docs",
+    "_docs:fix": "prettier ./api/docs --write",
+    "_format:check": "prettier . --check",
+    "_format:fix": "prettier . --write",
+    "_lint:check": "eslint .",
+    "_lint:fix": "eslint . --fix",
+    "_test:legacy": "./test/scripts/vows.js test/*_test.js",
+    "_test:ts": "jest",
+    "_version:generate": "genversion --template version-template.ejs --force lib/version.ts"
   },
   "//": "We only support node 18+, but v16 still works. We won't block v16 until it becomes a burden.",
   "engines": {