Fix the cookie module definition (#15111)

cookie/cookie-tests.ts

@@ -17,7 +17,7 @@ function test_parse(): void {
 }
 
 function test_options(): void {
-    var serializeOptions: CookieSerializeOptions = {
+    var serializeOptions: cookie.CookieSerializeOptions = {
         encode: (x: string) => x,
         path: '/',
         expires: new Date(),
@@ -27,7 +27,7 @@ function test_options(): void {
         httpOnly: false
     };
 
-    var parseOptios: CookieParseOptions = {
+    var parseOptios: cookie.CookieParseOptions = {
         decode: (x: string) => x
     };
 }

cookie/index.d.ts

@@ -1,28 +1,118 @@
-// Type definitions for cookie v0.1.2
+// Type definitions for cookie v0.3.0
 // Project: https://github.com/jshttp/cookie
 // Definitions by: Pine Mizune <https://github.com/pine613>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
 interface CookieSerializeOptions {
-    encode?: (val: string) => string;
-    path?: string;
-    expires?: Date;
-    maxAge?: number;
+    /**
+     * Specifies the value for the Domain Set-Cookie attribute. By default, no
+     * domain is set, and most clients will consider the cookie to apply to only
+     * the current domain.
+     */
     domain?: string;
-    secure?: boolean;
+    /**
+     * Specifies a function that will be used to encode a cookie's value. Since
+     * value of a cookie has a limited character set (and must be a simple
+     * string), this function can be used to encode a value into a string suited
+     * for a cookie's value.
+     *
+     * The default function is the global `encodeURIComponent`, which will
+     * encode a JavaScript string into UTF-8 byte sequences and then URL-encode
+     * any that fall outside of the cookie range.
+     */
+    encode?: (val: string) => string;
+    /**
+     * Specifies the `Date` object to be the value for the `Expires`
+     * `Set-Cookie` attribute. By default, no expiration is set, and most
+     * clients will consider this a "non-persistent cookie" and will delete it
+     * on a condition like exiting a web browser application.
+     *
+     * *Note* the cookie storage model specification states that if both
+     * `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is
+     * possible not all clients by obey this, so if both are set, they should
+     * point to the same date and time.
+     */
+    expires?: Date;
+    /**
+     * Specifies the boolean value for the `HttpOnly` `Set-Cookie` attribute.
+     * When truthy, the `HttpOnly` attribute is set, otherwise it is not. By
+     * default, the `HttpOnly` attribute is not set.
+     *
+     * *Note* be careful when setting this to true, as compliant clients will
+     * not allow client-side JavaScript to see the cookie in `document.cookie`.
+     */
     httpOnly?: boolean;
+    /**
+     * Specifies the number (in seconds) to be the value for the `Max-Age`
+     * `Set-Cookie` attribute. The given number will be converted to an integer
+     * by rounding down. By default, no maximum age is set.
+     *
+     * *Note* the cookie storage model specification states that if both
+     * `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is
+     * possible not all clients by obey this, so if both are set, they should
+     * point to the same date and time.
+     */
+    maxAge?: number;
+    /**
+     * Specifies the value for the `Path` `Set-Cookie` attribute. By default,
+     * the path is considered the "default path".
+     */
+    path?: string;
+    /**
+     * Specifies the boolean or string to be the value for the `SameSite`
+     * `Set-Cookie` attribute.
+     *
+     * - `true` will set the `SameSite` attribute to `Strict` for strict same
+     * site enforcement.
+     * - `false` will not set the `SameSite` attribute.
+     * - `'lax'` will set the `SameSite` attribute to Lax for lax same site
+     * enforcement.
+     * - `'strict'` will set the `SameSite` attribute to Strict for strict same
+     * site enforcement.
+     */
+    sameSite?: boolean | 'lax' | 'strict';
+    /**
+     * Specifies the boolean value for the `Secure` `Set-Cookie` attribute. When
+     * truthy, the `Secure` attribute is set, otherwise it is not. By default,
+     * the `Secure` attribute is not set.
+     *
+     * *Note* be careful when setting this to `true`, as compliant clients will
+     * not send the cookie back to the server in the future if the browser does
+     * not have an HTTPS connection.
+     */
+    secure?: boolean;
 }
 
 interface CookieParseOptions {
+    /**
+     * Specifies a function that will be used to decode a cookie's value. Since
+     * the value of a cookie has a limited character set (and must be a simple
+     * string), this function can be used to decode a previously-encoded cookie
+     * value into a JavaScript string or other object.
+     *
+     * The default function is the global `decodeURIComponent`, which will decode
+     * any URL-encoded sequences into their byte representations.
+     *
+     * *Note* if an error is thrown from this function, the original, non-decoded
+     * cookie value will be returned as the cookie's value.
+     */
     decode?: (val: string) => string;
 }
 
-interface CookieStatic {
-    serialize(name: string, val: string, options?: CookieSerializeOptions): string;
-    parse(str: string, options?: CookieParseOptions): { [key: string]: string };
-}
+/**
+ * Parse an HTTP Cookie header string and returning an object of all cookie
+ * name-value pairs.
+ *
+ * @param str the string representing a `Cookie` header value
+ * @param options object containing parsing options
+ */
+export function parse(str: string, options?: CookieParseOptions): { [key: string]: string };
 
-declare module "cookie" {
-    var cookie: CookieStatic;
-    export = cookie;
-}
+/**
+ * Serialize a cookie name-value pair into a `Set-Cookie` header string.
+ *
+ * @param name the name for the cookie
+ * @param val value to set the cookie to
+ * @param options object containing serialization options
+ */
+export function serialize(name: string, val: string, options?: CookieSerializeOptions): string;