cookie/000755 001751 000177 0000000000 14530740605014016 5ustar00runner000000 000000 1453074060514530740605cookie/LICENSE000644 001751 000177 0000002165 14530740605015027 0ustar00runner000000 000000 1453074060514530740605 MIT License Copyright (c) Microsoft Corporation. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE cookie/README.md000644 001751 000177 0000001007 14530740605015273 0ustar00runner000000 000000 1453074060514530740605# Installation > `npm install --save @types/cookie` # Summary This package contains type definitions for cookie (https://github.com/jshttp/cookie). # Details Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cookie. ### Additional Details * Last updated: Sun, 26 Nov 2023 22:07:01 GMT * Dependencies: none # Credits These definitions were written by [Pine Mizune](https://github.com/pine), and [Piotr Błażejewicz](https://github.com/peterblazejewicz). cookie/index.d.ts000644 001751 000177 0000016455 14530740605015732 0ustar00runner000000 000000 1453074060514530740605/** * Basic HTTP cookie parser and serializer for HTTP servers. */ /** * Additional serialization options */ export interface CookieSerializeOptions { /** * Specifies the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.3|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 | undefined; /** * 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?(value: string): string; /** * Specifies the `Date` object to be the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.1|`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 {@link https://tools.ietf.org/html/rfc6265#section-5.3|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 | undefined; /** * Specifies the boolean value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.6|`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 | undefined; /** * 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 {@link https://tools.ietf.org/html/rfc6265#section-5.3|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 | undefined; /** * Specifies the `boolean` value for the [`Partitioned` `Set-Cookie`](rfc-cutler-httpbis-partitioned-cookies) * attribute. When truthy, the `Partitioned` attribute is set, otherwise it is not. By default, the * `Partitioned` attribute is not set. * * **note** This is an attribute that has not yet been fully standardized, and may change in the future. * This also means many clients may ignore this attribute until they understand it. * * More information about can be found in [the proposal](https://github.com/privacycg/CHIPS) */ partitioned?: boolean | undefined; /** * Specifies the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.4|`Path` `Set-Cookie` attribute}. * By default, the path is considered the "default path". */ path?: string | undefined; /** * Specifies the `string` to be the value for the [`Priority` `Set-Cookie` attribute][rfc-west-cookie-priority-00-4.1]. * * - `'low'` will set the `Priority` attribute to `Low`. * - `'medium'` will set the `Priority` attribute to `Medium`, the default priority when not set. * - `'high'` will set the `Priority` attribute to `High`. * * More information about the different priority levels can be found in * [the specification][rfc-west-cookie-priority-00-4.1]. * * **note** This is an attribute that has not yet been fully standardized, and may change in the future. * This also means many clients may ignore this attribute until they understand it. */ priority?: "low" | "medium" | "high" | undefined; /** * Specifies the boolean or string to be the value for the {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7|`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. * - `'none'` will set the SameSite attribute to None for an explicit * cross-site cookie. * * More information about the different enforcement levels can be found in {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7|the specification}. * * *note* This is an attribute that has not yet been fully standardized, and may change in the future. This also means many clients may ignore this attribute until they understand it. */ sameSite?: true | false | "lax" | "strict" | "none" | undefined; /** * Specifies the boolean value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.5|`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 | undefined; } /** * Additional parsing options */ export 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?(value: 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): Record; /** * Serialize a cookie name-value pair into a `Set-Cookie` header string. * * @param name the name for the cookie * @param value value to set the cookie to * @param [options] object containing serialization options * @throws {TypeError} when `maxAge` options is invalid */ export function serialize(name: string, value: string, options?: CookieSerializeOptions): string; cookie/package.json000644 001751 000177 0000001660 14530740605016307 0ustar00runner000000 000000 1453074060514530740605{ "name": "@types/cookie", "version": "0.6.0", "description": "TypeScript definitions for cookie", "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cookie", "license": "MIT", "contributors": [ { "name": "Pine Mizune", "githubUsername": "pine", "url": "https://github.com/pine" }, { "name": "Piotr Błażejewicz", "githubUsername": "peterblazejewicz", "url": "https://github.com/peterblazejewicz" } ], "main": "", "types": "index.d.ts", "repository": { "type": "git", "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git", "directory": "types/cookie" }, "scripts": {}, "dependencies": {}, "typesPublisherContentHash": "0fbdf9c886fb40c8dc7677b8b7d0f9e02ac5235e163d90244a4fb9004736a575", "typeScriptVersion": "4.5" }