tough-cookie 4.1.3 → 5.0.0-rc.1

package/README.md

@@ -9,31 +9,31 @@
 ## Synopsis
 
 ```javascript
-var tough = require("tough-cookie");
-var Cookie = tough.Cookie;
-var cookie = Cookie.parse(header);
-cookie.value = "somethingdifferent";
-header = cookie.toString();
-var cookiejar = new tough.CookieJar();
+var tough = require('tough-cookie')
+var Cookie = tough.Cookie
+var cookie = Cookie.parse(header)
+cookie.value = 'somethingdifferent'
+header = cookie.toString()
+var cookiejar = new tough.CookieJar()
 
 // Asynchronous!
 var cookie = await cookiejar.setCookie(
   cookie,
-  "https://currentdomain.example.com/path"
-);
-var cookies = await cookiejar.getCookies("https://example.com/otherpath");
+  'https://currentdomain.example.com/path',
+)
+var cookies = await cookiejar.getCookies('https://example.com/otherpath')
 
 // Or with callbacks!
 cookiejar.setCookie(
   cookie,
-  "https://currentdomain.example.com/path",
+  'https://currentdomain.example.com/path',
   function (err, cookie) {
     /* ... */
-  }
-);
-cookiejar.getCookies("http://example.com/otherpath", function (err, cookies) {
+  },
+)
+cookiejar.getCookies('http://example.com/otherpath', function (err, cookies) {
   /* ... */
-});
+})
 ```
 
 Why the name? NPM modules `cookie`, `cookies` and `cookiejar` were already taken.
@@ -113,8 +113,8 @@ For use with `.sort()`, sorts a list of cookies into the recommended order given
 ```javascript
 var cookies = [
   /* unsorted array of Cookie objects */
-];
-cookies = cookies.sort(cookieCompare);
+]
+cookies = cookies.sort(cookieCompare)
 ```
 
 > **Note**: Since the JavaScript `Date` is limited to a 1-ms precision, cookies within the same millisecond are entirely possible. This is especially true when using the `now` option to `.setCookie()`. The `.creationIndex` property is a per-process global counter, assigned during construction with `new Cookie()`, which preserves the spirit of the RFC sorting: older cookies go first. This works great for `MemoryCookieStore` since `Set-Cookie` headers are parsed in order, but is not so great for distributed systems. Sophisticated `Store`s may wish to set this to some other _logical clock_ so that if cookies A and B are created in the same millisecond, but cookie A is created before cookie B, then `A.creationIndex < B.creationIndex`. If you want to alter the global counter, which you probably _shouldn't_ do, it's stored in `Cookie.cookiesCreated`.
@@ -144,9 +144,9 @@ If options is not an object it is ignored, which means it can be used with [`Arr
 To process the Set-Cookie header(s) on a node HTTP/HTTPS response:
 
 ```javascript
-if (Array.isArray(res.headers["set-cookie"]))
-  cookies = res.headers["set-cookie"].map(Cookie.parse);
-else cookies = [Cookie.parse(res.headers["set-cookie"])];
+if (Array.isArray(res.headers['set-cookie']))
+  cookies = res.headers['set-cookie'].map(Cookie.parse)
+else cookies = [Cookie.parse(res.headers['set-cookie'])]
 ```
 
 _Note:_ In version 2.3.3, tough-cookie limited the number of spaces before the `=` to 256 characters. This limitation was removed in version 2.3.4.
@@ -220,7 +220,7 @@ Returns the canonicalized `.domain` field. This is lower-cased and punycode ([RF
 
 #### `.toJSON()`
 
-For convenience in using `JSON.serialize(cookie)`. Returns a plain-old `Object` that can be JSON-serialized.
+For convenience in using `JSON.stringify(cookie)`. Returns a plain-old `Object` that can be JSON-serialized.
 
 Any `Date` properties (such as `.expires`, `.creation`, and `.lastAccessed`) are exported in ISO format (`.toISOString()`).
 
@@ -390,7 +390,7 @@ Base class for CookieJar stores. Available as `tough.Store`.
 
 ### Store API
 
-The storage model for each `CookieJar` instance can be replaced with a custom implementation. The default is `MemoryCookieStore` which can be found in [`lib/memstore.js`](https://github.com/salesforce/tough-cookie/blob/master/lib/memstore.js). The API uses continuation-passing-style to allow for asynchronous stores.
+The storage model for each `CookieJar` instance can be replaced with a custom implementation. The default is `MemoryCookieStore` which can be found in [`lib/memstore.ts`](https://github.com/salesforce/tough-cookie/blob/master/lib/memstore.ts). The API uses continuation-passing-style to allow for asynchronous stores.
 
 Stores should inherit from the base `Store` class, which is available as a top-level export.
 
@@ -470,16 +470,6 @@ Inherits from `Store`.
 
 A just-in-memory CookieJar synchronous store implementation, used by default. Despite being a synchronous implementation, it's usable with both the synchronous and asynchronous forms of the `CookieJar` API. Supports serialization, `getAllCookies`, and `removeAllCookies`.
 
-### Community Cookie Stores
-
-These are some Store implementations authored and maintained by the community. They aren't official and we don't vouch for them but you may be interested to have a look:
-
-- [`db-cookie-store`](https://github.com/JSBizon/db-cookie-store): SQL including SQLite-based databases
-- [`file-cookie-store`](https://github.com/JSBizon/file-cookie-store): Netscape cookie file format on disk
-- [`redis-cookie-store`](https://github.com/benkroeger/redis-cookie-store): Redis
-- [`tough-cookie-filestore`](https://github.com/mitsuru/tough-cookie-filestore): JSON on disk
-- [`tough-cookie-web-storage-store`](https://github.com/exponentjs/tough-cookie-web-storage-store): DOM localStorage and sessionStorage
-
 ## Serialization Format
 
 **NOTE**: If you want to have custom `Cookie` properties serialized, add the property name to `Cookie.serializableProperties`.

package/dist/cookie/canonicalDomain.d.ts

@@ -0,0 +1 @@
+export declare function canonicalDomain(str: string | null): string | null;

package/dist/cookie/canonicalDomain.js

@@ -0,0 +1,45 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.canonicalDomain = void 0;
+const punycode = __importStar(require("punycode/punycode.js"));
+const constants_1 = require("./constants");
+// S5.1.2 Canonicalized Host Names
+function canonicalDomain(str) {
+    if (str == null) {
+        return null;
+    }
+    let _str = str.trim().replace(/^\./, ''); // S4.1.2.3 & S5.2.3: ignore leading .
+    if (constants_1.IP_V6_REGEX_OBJECT.test(_str)) {
+        _str = _str.replace('[', '').replace(']', '');
+    }
+    // convert to IDN if any non-ASCII characters
+    // eslint-disable-next-line no-control-regex
+    if (/[^\u0001-\u007f]/.test(_str)) {
+        _str = punycode.toASCII(_str);
+    }
+    return _str.toLowerCase();
+}
+exports.canonicalDomain = canonicalDomain;

package/dist/cookie/constants.d.ts

@@ -0,0 +1,18 @@
+export declare const PrefixSecurityEnum: Readonly<{
+    SILENT: "silent";
+    STRICT: "strict";
+    DISABLED: "unsafe-disabled";
+}>;
+export declare const IP_V6_REGEX_OBJECT: RegExp;
+export interface SerializedCookieJar {
+    version: string;
+    storeType: string | null;
+    rejectPublicSuffixes: boolean;
+    [key: string]: unknown;
+    cookies: SerializedCookie[];
+}
+export interface SerializedCookie {
+    key?: string;
+    value?: string;
+    [key: string]: unknown;
+}

package/dist/cookie/constants.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IP_V6_REGEX_OBJECT = exports.PrefixSecurityEnum = void 0;
+exports.PrefixSecurityEnum = Object.freeze({
+    SILENT: 'silent',
+    STRICT: 'strict',
+    DISABLED: 'unsafe-disabled',
+});
+const IP_V6_REGEX = `
+\\[?(?:
+(?:[a-fA-F\\d]{1,4}:){7}(?:[a-fA-F\\d]{1,4}|:)|
+(?:[a-fA-F\\d]{1,4}:){6}(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)){3}|:[a-fA-F\\d]{1,4}|:)|
+(?:[a-fA-F\\d]{1,4}:){5}(?::(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)){3}|(?::[a-fA-F\\d]{1,4}){1,2}|:)|
+(?:[a-fA-F\\d]{1,4}:){4}(?:(?::[a-fA-F\\d]{1,4}){0,1}:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)){3}|(?::[a-fA-F\\d]{1,4}){1,3}|:)|
+(?:[a-fA-F\\d]{1,4}:){3}(?:(?::[a-fA-F\\d]{1,4}){0,2}:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)){3}|(?::[a-fA-F\\d]{1,4}){1,4}|:)|
+(?:[a-fA-F\\d]{1,4}:){2}(?:(?::[a-fA-F\\d]{1,4}){0,3}:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)){3}|(?::[a-fA-F\\d]{1,4}){1,5}|:)|
+(?:[a-fA-F\\d]{1,4}:){1}(?:(?::[a-fA-F\\d]{1,4}){0,4}:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)){3}|(?::[a-fA-F\\d]{1,4}){1,6}|:)|
+(?::(?:(?::[a-fA-F\\d]{1,4}){0,5}:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)){3}|(?::[a-fA-F\\d]{1,4}){1,7}|:))
+)(?:%[0-9a-zA-Z]{1,})?\\]?
+`
+    .replace(/\s*\/\/.*$/gm, '')
+    .replace(/\n/g, '')
+    .trim();
+exports.IP_V6_REGEX_OBJECT = new RegExp(`^${IP_V6_REGEX}$`);

package/dist/cookie/cookie.d.ts

@@ -0,0 +1,97 @@
+/*!
+ * Copyright (c) 2015-2020, Salesforce.com, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of Salesforce.com nor the names of its contributors may
+ * be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+import type { SerializedCookie } from './constants';
+type ParseCookieOptions = {
+    loose?: boolean | undefined;
+};
+declare function parse(str: string, options?: ParseCookieOptions): Cookie | undefined | null;
+declare function fromJSON(str: unknown): Cookie | null;
+type CreateCookieOptions = {
+    key?: string;
+    value?: string;
+    expires?: Date | 'Infinity' | null;
+    maxAge?: number | 'Infinity' | '-Infinity';
+    domain?: string | null;
+    path?: string | null;
+    secure?: boolean;
+    httpOnly?: boolean;
+    extensions?: string[] | null;
+    creation?: Date | 'Infinity' | null;
+    creationIndex?: number;
+    hostOnly?: boolean | null;
+    pathIsDefault?: boolean | null;
+    lastAccessed?: Date | 'Infinity' | null;
+    sameSite?: string | undefined;
+};
+export declare class Cookie {
+    key: string | undefined;
+    value: string | undefined;
+    expires: Date | 'Infinity' | null | undefined;
+    maxAge: number | 'Infinity' | '-Infinity' | undefined;
+    domain: string | null | undefined;
+    path: string | null | undefined;
+    secure: boolean | undefined;
+    httpOnly: boolean | undefined;
+    extensions: string[] | null | undefined;
+    creation: Date | 'Infinity' | null;
+    creationIndex: number | undefined;
+    hostOnly: boolean | null | undefined;
+    pathIsDefault: boolean | null | undefined;
+    lastAccessed: Date | 'Infinity' | null | undefined;
+    sameSite: string | undefined;
+    constructor(options?: CreateCookieOptions);
+    toJSON(): SerializedCookie;
+    clone(): Cookie | null;
+    validate(): boolean;
+    setExpires(exp: string | Date): void;
+    setMaxAge(age: number): void;
+    cookieString(): string;
+    toString(): string;
+    TTL(now?: number): number;
+    expiryTime(now?: Date): number | undefined;
+    isPersistent(): boolean;
+    canonicalizedDomain(): string | null;
+    cdomain(): string | null;
+    static parse: typeof parse;
+    static fromJSON: typeof fromJSON;
+    static cookiesCreated: number;
+    static sameSiteLevel: {
+        readonly strict: 3;
+        readonly lax: 2;
+        readonly none: 1;
+    };
+    static sameSiteCanonical: {
+        readonly strict: "Strict";
+        readonly lax: "Lax";
+    };
+    static serializableProperties: readonly ["key", "value", "expires", "maxAge", "domain", "path", "secure", "httpOnly", "extensions", "hostOnly", "pathIsDefault", "creation", "lastAccessed", "sameSite"];
+}
+export {};