🚀 Big News:Socket Has Acquired Secure Annex.Learn More →
Socket
Book a DemoSign in
Socket
Book a DemoSign in

cookie-es

Package Overview
Dependencies
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

cookie-es - npm Package Compare versions

Comparing version
3.0.1
 to
3.1.0
+47
-14
dist/index.d.mts

@@ -47,2 +47,8 @@ /**

encode?: (str: string) => string;
/**
* Specifies a function that will be used to coerce non-string values to a string.
*
* @default JSON.stringify
*/
stringify?: (value: unknown) => string;
}

@@ -134,6 +140,10 @@ /**

/**
* Parse a `Cookie` header.
* Parse a `Cookie` header string into an object.
*
* Parse the given cookie header string into an object
* The object has the various cookies as keys(names) => values
* The object has cookie names as keys and decoded values as values.
* First occurrence wins for duplicate names unless `allowMultiple` is set.
*
* @param str - The `Cookie` header string to parse.
* @param options - Parsing options (`decode`, `filter`, `allowMultiple`).
* @returns A prototype-less object of cookie name-value pairs.
*/

@@ -145,16 +155,27 @@ declare function parse(str: string, options: CookieParseOptions & {

/**
* Stringifies an object into an HTTP `Cookie` header.
* Stringify a cookies object into an HTTP `Cookie` header string.
*
* @param cookie - An object of cookie name-value pairs.
* @param options - Stringify options (`encode`).
* @returns A `Cookie` header string (e.g. `"foo=bar; baz=qux"`).
*/
declare function stringifyCookie(cookie: Cookies, options?: CookieStringifyOptions): string;
/**
* Serialize data into a cookie header.
* Serialize a cookie into a `Set-Cookie` header string.
*
* Serialize a name value pair into a cookie string suitable for
* http headers. An optional options object specifies cookie parameters.
* Accepts either a name-value pair with options or a `SetCookie` object.
* Non-string values are coerced to strings. Validates name, value, domain,
* and path against RFC 6265bis.
*
* serialize('foo', 'bar', { httpOnly: true })
* => "foo=bar; httpOnly"
* @example
* ```js
* serialize("foo", "bar", { httpOnly: true });
* // => "foo=bar; HttpOnly"
*
* serialize({ name: "foo", value: "bar", secure: true });
* // => "foo=bar; Secure"
* ```
*/
declare function serialize(cookie: SetCookie, options?: CookieStringifyOptions): string;
declare function serialize(name: string, val: string, options?: CookieSerializeOptions): string;
declare function serialize(name: string, val: unknown, options?: CookieSerializeOptions): string;
interface SetCookieParseOptions {

@@ -225,12 +246,24 @@ /**

/**
* Parse a [Set-Cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie) header string into an object.
* Parse a [`Set-Cookie`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie) header string into an object.
*
* Returns `undefined` for cookies with forbidden names (prototype pollution protection)
* or when both name and value are empty (RFC 6265bis sec 5.7).
*
* @param str - The `Set-Cookie` header string to parse.
* @param options - Parsing options (`decode`).
* @returns A `SetCookie` object with all parsed attributes, or `undefined`.
*/
declare function parseSetCookie(str: string, options?: SetCookieParseOptions): SetCookie$1 | undefined;
/**
* Set-Cookie header field-values are sometimes comma joined in one string. This splits them without choking on commas
* that are within a single set-cookie field-value, such as in the Expires portion.
* Split comma-joined `Set-Cookie` header strings into individual cookie strings.
*
* See https://tools.ietf.org/html/rfc2616#section-4.2
* Correctly handles commas within cookie attributes like `Expires` dates
* by checking for `=` after a comma to determine if it's a cookie separator.
*
* @param cookiesString - A comma-joined `Set-Cookie` string or array of strings.
* @returns An array of individual `Set-Cookie` strings.
*
* @see https://tools.ietf.org/html/rfc2616#section-4.2
*/
declare function splitSetCookieString(cookiesString: string | string[]): string[];
export { type CookieParseOptions, type CookieSerializeOptions, type CookieStringifyOptions, type Cookies, type MultiCookies, type SetCookie, type SetCookieParseOptions, parse, parse as parseCookie, parseSetCookie, serialize, serialize as serializeCookie, splitSetCookieString, stringifyCookie };
+9
-6
dist/index.mjs

@@ -89,9 +89,12 @@ const COOKIE_MAX_AGE_LIMIT = 400 * 24 * 60 * 60;

}
function serialize(_name, _val, _opts) {
const cookie = typeof _name === "object" ? _name : {
..._opts,
name: _name,
value: String(_val)
function serialize(_a0, _a1, _a2) {
const isObj = typeof _a0 === "object" && _a0 !== null;
const options = isObj ? _a1 : _a2;
const stringify = options?.stringify || JSON.stringify;
const cookie = isObj ? _a0 : {
..._a2,
name: _a0,
value: _a1 == void 0 ? "" : typeof _a1 === "string" ? _a1 : stringify(_a1)
};
const enc = (typeof _val === "object" ? _val : _opts)?.encode || encodeURIComponent;
const enc = options?.encode || encodeURIComponent;
if (!cookieNameRegExp.test(cookie.name)) throw new TypeError(`argument name is invalid: ${cookie.name}`);

@@ -98,0 +101,0 @@ const value = cookie.value ? enc(cookie.value) : "";

+1
-1
package.json
{
"name": "cookie-es",
"version": "3.0.1",
"version": "3.1.0",
"license": "MIT",

@@ -5,0 +5,0 @@ "repository": "unjs/cookie-es",

+2
-14
README.md

@@ -24,4 +24,2 @@ # 🍪 cookie-es

**ESM** (Node.js, Bun, Deno)
```js

@@ -37,14 +35,2 @@ import {

**CDN** (Deno, Bun and Browsers)
```js
import {
parseCookie,
parseSetCookie,
serializeCookie,
stringifyCookie,
splitSetCookieString,
} from "https://esm.sh/cookie-es";
```
## API

@@ -111,2 +97,4 @@

Non-string values are coerced to strings (`null` and `undefined` become empty string).
Supported attributes: `maxAge`, `expires`, `domain`, `path`, `httpOnly`, `secure`, `sameSite`, `priority`, `partitioned`. Use `encode` option for custom value encoding (default: `encodeURIComponent`).

@@ -113,0 +101,0 @@