@eggjs/cookies 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-present Alibaba Group Holding Limited and other contributors.
+
+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.

package/README.md

@@ -0,0 +1,58 @@
+# @eggjs/cookies
+
+[![NPM version][npm-image]][npm-url]
+[![build status][ci-image]][ci-url]
+[![Test coverage][codecov-image]][codecov-url]
+[![npm download][download-image]][download-url]
+
+[npm-image]: https://img.shields.io/npm/v/@eggjs/cookies.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/cookies
+[ci-image]: https://github.com/eggjs/egg-cookies/actions/workflows/nodejs.yml/badge.svg
+[ci-url]: https://github.com/eggjs/egg-cookies/actions/workflows/nodejs.yml
+[codecov-image]: https://codecov.io/gh/eggjs/egg-cookies/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/eggjs/egg-cookies
+[download-image]: https://img.shields.io/npm/dm/@eggjs/cookies.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/cookies
+
+Extends [pillarjs/cookies](https://github.com/pillarjs/cookies) to adapt koa and egg with some additional features.
+
+## Encrypt
+
+`@eggjs/cookies` provide an alternative `encrypt` mode like `signed`. An encrypt cookie's value will be encrypted base on keys. Anyone who don't have the keys are unable to know the original cookie's value.
+
+```ts
+import { Cookies } from '@eggjs/cookies';
+
+const cookies = new Cookies(ctx, keys[, defaultCookieOptions]);
+
+cookies.set('foo', 'bar', { encrypt: true });
+cookies.get('foo', { encrypt: true });
+```
+
+**Note: you should both indicating in get and set in pairs.**
+
+## Cookie Length Check
+
+[Browsers all had some limitation in cookie's length](http://browsercookielimits.squawky.net/), so if set a cookie with an extremely long value(> 4093), `@eggjs/cookies` will emit an `cookieLimitExceed` event. You can listen to this event and record.
+
+```ts
+import { Cookies } from '@eggjs/cookies';
+
+const cookies = new Cookies(ctx, keys);
+
+cookies.on('cookieLimitExceed', ({ name, value }) => {
+  // log
+});
+
+cookies.set('foo', longText);
+```
+
+## License
+
+[MIT](LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg-cookies)](https://github.com/eggjs/egg-cookies/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

package/README.zh-CN.md

@@ -0,0 +1,76 @@
+# @eggjs/cookies
+
+[![NPM version][npm-image]][npm-url]
+[![build status][ci-image]][ci-url]
+[![Test coverage][codecov-image]][codecov-url]
+[![npm download][download-image]][download-url]
+
+[npm-image]: https://img.shields.io/npm/v/@eggjs/cookies.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/cookies
+[ci-image]: https://github.com/eggjs/egg-cookies/actions/workflows/nodejs.yml/badge.svg
+[ci-url]: https://github.com/eggjs/egg-cookies/actions/workflows/nodejs.yml
+[codecov-image]: https://codecov.io/gh/eggjs/egg-cookies/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/eggjs/egg-cookies
+[download-image]: https://img.shields.io/npm/dm/@eggjs/cookies.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/cookies
+
+为 egg 提供 cookie 操作的封装。
+
+```ts
+ctx.cookies = new Cookies(ctx, keys[, defaultCookieOptions]);
+
+ctx.cookies.get('key', 'value', options);
+ctx.cookies.set('key', 'value', options);
+```
+
+## 初始化
+
+初始化时需要传递 Array 类型 的keys 参数，否则无法使用 cookies 的 `signed` 和 `encrypt` 功能。
+
+每次设置或读取 signed cookie 或者 encrypt cookie 的时候，会用 keys 进行加密。每次加密都通过 keys 数组的第一个 key 进行加密，解密会从先到后逐个 key 尝试解密。读取 signed cookie 时，如果发现不是用第一个 key 进行加密时，会更新签名为第一个 key 加密的值。读取 encrypt cookie 时不会进行更新操作。
+
+### `defaultCookieOptions`
+
+全局默认配置：
+
+- autoChips - `Boolean` 是否开启 [CHIPS](https://developers.google.com/privacy-sandbox/3pcd/chips#security_design) 的自动适配方案，
+会自动给 Cookie 新增一个 `_CHIPS-` 为前缀的分区 Cookie，优先读取非分区 Cookie，读取失败则尝试读取 `_CHIPS-` 前缀的同名 Cookie 适配三方 Cookie 禁止逻辑。
+一旦 `cookies.set` 设置 `partitioned=true`，那么会强制忽略 `autoChips` 参数。
+
+## 设置 cookie
+
+通过 `cookies.set(key, value, options)` 的方式来设置一个 cookie。其中 options 支持的参数有：
+
+- path - `String` cookie 的有效路径，默认为 `/`。
+- domain - `String` cookie 的有效域名范围，默认为 `undefined`。
+- expires - `Date` cookie 的失效时间。
+- maxAge - `Number` cookie 的最大有效时间，如果设置了 maxAge，将会覆盖 expires 的值。
+- secure - `Boolean` 是否只在加密信道中传输，注意，如果请求为 http 时，不允许设置为 `true`，https 时自动设置为 `true`。
+- partitioned - `Boolean` 是否设置独立分区状态（[CHIPS](https://developers.google.com/privacy-sandbox/3pcd/chips)）的 Cookie。注意，只有 `secure` 为 `true` 的时候此配置才会生效。
+- removeUnpartitioned - `Boolean` 是否删除非独立分区状态的同名 cookie。注意，只有 `partitioned` 为 `true` 的时候此配置才会生效。
+- httpOnly - `Boolean` 如果设置为 `true`，则浏览器中不允许读取这个 cookie 的值。
+- overwrite - `Boolean` 如果设置为 `true`，在一个请求上重复写入同一个 key 将覆盖前一次写入的值，默认为 `false`。
+- signed - `Boolean` 是否需要对 cookie 进行签名，需要配合 get 时传递 signed 参数，此时前端无法篡改这个 cookie，默认为 `true`。
+- encrypt - `Boolean` 是否需要对 cookie 进行加密，需要配合 get 时传递 encrypt 参数，此时前端无法读到真实的 cookie 值，默认为 `false`。
+- priority - `String` 表示 cookie 优先级的字符串，可以设置为 `'low'`, `'medium'`, `'high'`，默认为 `undefined`。[A Retention Priority Attribute for HTTP Cookies](https://datatracker.ietf.org/doc/html/draft-west-cookie-priority)
+
+## 读取 cookie
+
+通过 `cookies.get(key, value, options)` 的方式来读取一个 cookie。其中 options 支持的参数有：
+
+- signed - `Boolean` 是否需要对 cookie 进行验签，需要配合 set 时传递 signed 参数，此时前端无法篡改这个 cookie，默认为 true。
+- encrypt - `Boolean` 是否需要对 cookie 进行解密，需要配合 set 时传递 encrypt 参数，此时前端无法读到真实的 cookie 值，默认为 false。
+
+## 删除 cookie
+
+通过 `cookie.set(key, null)` 来删除一个 cookie。如果传递了 `signed` 参数，签名也会被删除。
+
+## License
+
+[MIT](LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg-cookies)](https://github.com/eggjs/egg-cookies/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

package/dist/commonjs/cookie.d.ts

@@ -0,0 +1,62 @@
+export interface CookieSetOptions {
+    /**
+     * The path for the cookie to be set in
+     */
+    path?: string | null;
+    /**
+     * The domain for the cookie
+     */
+    domain?: string | (() => string);
+    /**
+     * Is overridable
+     */
+    overwrite?: boolean;
+    /**
+     * Is the same site
+     */
+    sameSite?: string | boolean;
+    /**
+     * Encrypt the cookie's value or not
+     */
+    encrypt?: boolean;
+    /**
+     * Max age for browsers
+     */
+    maxAge?: number;
+    /**
+     * Expire time
+     */
+    expires?: Date;
+    /**
+    * Is for http only
+    */
+    httpOnly?: boolean;
+    /**
+    * Encrypt the cookie's value or not
+    */
+    secure?: boolean;
+    /**
+     * Is it signed or not.
+     */
+    signed?: boolean | number;
+    /**
+     * Is it partitioned or not.
+     */
+    partitioned?: boolean;
+    /**
+     * Remove unpartitioned same name cookie or not.
+     */
+    removeUnpartitioned?: boolean;
+    /**
+     * The cookie priority.
+     */
+    priority?: 'low' | 'medium' | 'high' | 'LOW' | 'MEDIUM' | 'HIGH';
+}
+export declare class Cookie {
+    name: string;
+    value: string;
+    readonly attrs: CookieSetOptions;
+    constructor(name: string, value?: string | null, attrs?: CookieSetOptions);
+    toString(): string;
+    toHeader(): string;
+}

package/dist/commonjs/cookie.js

@@ -0,0 +1,101 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cookie = void 0;
+const node_assert_1 = __importDefault(require("node:assert"));
+/**
+ * RegExp to match field-content in RFC 7230 sec 3.2
+ *
+ * field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ]
+ * field-vchar   = VCHAR / obs-text
+ * obs-text      = %x80-FF
+ */
+const fieldContentRegExp = /^[\u0009\u0020-\u007e\u0080-\u00ff]+$/; // eslint-disable-line no-control-regex
+/**
+* RegExp to match Same-Site cookie attribute value.
+* https://en.wikipedia.org/wiki/HTTP_cookie#SameSite_cookie
+*/
+const sameSiteRegExp = /^(?:none|lax|strict)$/i;
+/**
+ * RegExp to match Priority cookie attribute value.
+ */
+const PRIORITY_REGEXP = /^(?:low|medium|high)$/i;
+class Cookie {
+    name;
+    value;
+    attrs;
+    constructor(name, value, attrs) {
+        (0, node_assert_1.default)(fieldContentRegExp.test(name), 'argument name is invalid');
+        (0, node_assert_1.default)(!value || fieldContentRegExp.test(value), 'argument value is invalid');
+        this.name = name;
+        this.value = value ?? '';
+        this.attrs = mergeDefaultAttrs(attrs);
+        (0, node_assert_1.default)(!this.attrs.path || fieldContentRegExp.test(this.attrs.path), 'argument option path is invalid');
+        if (typeof this.attrs.domain === 'function') {
+            this.attrs.domain = this.attrs.domain();
+        }
+        (0, node_assert_1.default)(!this.attrs.domain || fieldContentRegExp.test(this.attrs.domain), 'argument option domain is invalid');
+        (0, node_assert_1.default)(!this.attrs.sameSite || this.attrs.sameSite === true || sameSiteRegExp.test(this.attrs.sameSite), 'argument option sameSite is invalid');
+        (0, node_assert_1.default)(!this.attrs.priority || PRIORITY_REGEXP.test(this.attrs.priority), 'argument option priority is invalid');
+        if (!value) {
+            this.attrs.expires = new Date(0);
+            // make sure maxAge is empty
+            this.attrs.maxAge = undefined;
+        }
+    }
+    toString() {
+        return this.name + '=' + this.value;
+    }
+    toHeader() {
+        let header = this.toString();
+        const attrs = this.attrs;
+        if (attrs.path) {
+            header += '; path=' + attrs.path;
+        }
+        const maxAge = typeof attrs.maxAge === 'string' ? parseInt(attrs.maxAge, 10) : attrs.maxAge;
+        // ignore 0, `session` and other invalid maxAge
+        if (maxAge) {
+            header += '; max-age=' + Math.round(maxAge / 1000);
+            attrs.expires = new Date(Date.now() + maxAge);
+        }
+        if (attrs.expires) {
+            header += '; expires=' + attrs.expires.toUTCString();
+        }
+        if (attrs.domain) {
+            header += '; domain=' + attrs.domain;
+        }
+        if (attrs.priority) {
+            header += '; priority=' + attrs.priority.toLowerCase();
+        }
+        if (attrs.sameSite) {
+            header += '; samesite=' + (attrs.sameSite === true ? 'strict' : attrs.sameSite.toLowerCase());
+        }
+        if (attrs.secure) {
+            header += '; secure';
+        }
+        if (attrs.httpOnly) {
+            header += '; httponly';
+        }
+        if (attrs.partitioned) {
+            header += '; partitioned';
+        }
+        return header;
+    }
+}
+exports.Cookie = Cookie;
+function mergeDefaultAttrs(attrs) {
+    const merged = {
+        path: '/',
+        httpOnly: true,
+        secure: false,
+        overwrite: false,
+        sameSite: false,
+        partitioned: false,
+        priority: undefined,
+        ...attrs,
+    };
+    return merged;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29va2llLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2Nvb2tpZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFBQSw4REFBaUM7QUFFakM7Ozs7OztHQU1HO0FBQ0gsTUFBTSxrQkFBa0IsR0FBRyx1Q0FBdUMsQ0FBQyxDQUFDLHVDQUF1QztBQUUzRzs7O0VBR0U7QUFDRixNQUFNLGNBQWMsR0FBRyx3QkFBd0IsQ0FBQztBQUVoRDs7R0FFRztBQUNILE1BQU0sZUFBZSxHQUFHLHdCQUF3QixDQUFDO0FBeURqRCxNQUFhLE1BQU07SUFDakIsSUFBSSxDQUFTO0lBQ2IsS0FBSyxDQUFTO0lBQ0wsS0FBSyxDQUFtQjtJQUVqQyxZQUFZLElBQVksRUFBRSxLQUFxQixFQUFFLEtBQXdCO1FBQ3ZFLElBQUEscUJBQU0sRUFBQyxrQkFBa0IsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsMEJBQTBCLENBQUMsQ0FBQztRQUNsRSxJQUFBLHFCQUFNLEVBQUMsQ0FBQyxLQUFLLElBQUksa0JBQWtCLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxFQUFFLDJCQUEyQixDQUFDLENBQUM7UUFDOUUsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUM7UUFDakIsSUFBSSxDQUFDLEtBQUssR0FBRyxLQUFLLElBQUksRUFBRSxDQUFDO1FBQ3pCLElBQUksQ0FBQyxLQUFLLEdBQUcsaUJBQWlCLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDdEMsSUFBQSxxQkFBTSxFQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLElBQUksa0JBQWtCLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLEVBQ2pFLGlDQUFpQyxDQUFDLENBQUM7UUFDckMsSUFBSSxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxLQUFLLFVBQVUsRUFBRSxDQUFDO1lBQzVDLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDMUMsQ0FBQztRQUNELElBQUEscUJBQU0sRUFBQyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxJQUFJLGtCQUFrQixDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxFQUNyRSxtQ0FBbUMsQ0FBQyxDQUFDO1FBQ3ZDLElBQUEscUJBQU0sRUFBQyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsUUFBUSxJQUFJLElBQUksQ0FBQyxLQUFLLENBQUMsUUFBUSxLQUFLLElBQUksSUFBSSxjQUFjLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUFDLEVBQ3JHLHFDQUFxQyxDQUFDLENBQUM7UUFDekMsSUFBQSxxQkFBTSxFQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxRQUFRLElBQUksZUFBZSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxFQUN0RSxxQ0FBcUMsQ0FBQyxDQUFDO1FBQ3pDLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQztZQUNYLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxHQUFHLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ2pDLDRCQUE0QjtZQUM1QixJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sR0FBRyxTQUFTLENBQUM7UUFDaEMsQ0FBQztJQUNILENBQUM7SUFFRCxRQUFRO1FBQ04sT0FBTyxJQUFJLENBQUMsSUFBSSxHQUFHLEdBQUcsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDO0lBQ3RDLENBQUM7SUFFRCxRQUFRO1FBQ04sSUFBSSxNQUFNLEdBQUcsSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQzdCLE1BQU0sS0FBSyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUM7UUFDekIsSUFBSSxLQUFLLENBQUMsSUFBSSxFQUFFLENBQUM7WUFDZixNQUFNLElBQUksU0FBUyxHQUFHLEtBQUssQ0FBQyxJQUFJLENBQUM7UUFDbkMsQ0FBQztRQUNELE1BQU0sTUFBTSxHQUFHLE9BQU8sS0FBSyxDQUFDLE1BQU0sS0FBSyxRQUFRLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsTUFBTSxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDO1FBQzVGLCtDQUErQztRQUMvQyxJQUFJLE1BQU0sRUFBRSxDQUFDO1lBQ1gsTUFBTSxJQUFJLFlBQVksR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sR0FBRyxJQUFJLENBQUMsQ0FBQztZQUNuRCxLQUFLLENBQUMsT0FBTyxHQUFHLElBQUksSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxNQUFNLENBQUMsQ0FBQztRQUNoRCxDQUFDO1FBQ0QsSUFBSSxLQUFLLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDbEIsTUFBTSxJQUFJLFlBQVksR0FBRyxLQUFLLENBQUMsT0FBTyxDQUFDLFdBQVcsRUFBRSxDQUFDO1FBQ3ZELENBQUM7UUFDRCxJQUFJLEtBQUssQ0FBQyxNQUFNLEVBQUUsQ0FBQztZQUNqQixNQUFNLElBQUksV0FBVyxHQUFHLEtBQUssQ0FBQyxNQUFNLENBQUM7UUFDdkMsQ0FBQztRQUNELElBQUksS0FBSyxDQUFDLFFBQVEsRUFBRSxDQUFDO1lBQ25CLE1BQU0sSUFBSSxhQUFhLEdBQUcsS0FBSyxDQUFDLFFBQVEsQ0FBQyxXQUFXLEVBQUUsQ0FBQztRQUN6RCxDQUFDO1FBQ0QsSUFBSSxLQUFLLENBQUMsUUFBUSxFQUFFLENBQUM7WUFDbkIsTUFBTSxJQUFJLGFBQWEsR0FBRyxDQUFDLEtBQUssQ0FBQyxRQUFRLEtBQUssSUFBSSxDQUFDLENBQUMsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsV0FBVyxFQUFFLENBQUMsQ0FBQztRQUNoRyxDQUFDO1FBQ0QsSUFBSSxLQUFLLENBQUMsTUFBTSxFQUFFLENBQUM7WUFDakIsTUFBTSxJQUFJLFVBQVUsQ0FBQztRQUN2QixDQUFDO1FBQ0QsSUFBSSxLQUFLLENBQUMsUUFBUSxFQUFFLENBQUM7WUFDbkIsTUFBTSxJQUFJLFlBQVksQ0FBQztRQUN6QixDQUFDO1FBQ0QsSUFBSSxLQUFLLENBQUMsV0FBVyxFQUFFLENBQUM7WUFDdEIsTUFBTSxJQUFJLGVBQWUsQ0FBQztRQUM1QixDQUFDO1FBQ0QsT0FBTyxNQUFNLENBQUM7SUFDaEIsQ0FBQztDQUNGO0FBcEVELHdCQW9FQztBQUVELFNBQVMsaUJBQWlCLENBQUMsS0FBd0I7SUFDakQsTUFBTSxNQUFNLEdBQUc7UUFDYixJQUFJLEVBQUUsR0FBRztRQUNULFFBQVEsRUFBRSxJQUFJO1FBQ2QsTUFBTSxFQUFFLEtBQUs7UUFDYixTQUFTLEVBQUUsS0FBSztRQUNoQixRQUFRLEVBQUUsS0FBSztRQUNmLFdBQVcsRUFBRSxLQUFLO1FBQ2xCLFFBQVEsRUFBRSxTQUFTO1FBQ25CLEdBQUcsS0FBSztLQUNULENBQUM7SUFDRixPQUFPLE1BQU0sQ0FBQztBQUNoQixDQUFDIn0=

package/dist/commonjs/cookies.d.ts

@@ -0,0 +1,43 @@
+import { Keygrip } from './keygrip.js';
+import { CookieSetOptions } from './cookie.js';
+export interface DefaultCookieOptions extends CookieSetOptions {
+    /**
+     * Auto get and set `_CHIPS-` prefix cookie to adaptation CHIPS mode (The default value is false).
+     */
+    autoChips?: boolean;
+}
+export interface CookieGetOptions {
+    /**
+     * Whether to sign or not (The default value is true).
+     */
+    signed?: boolean;
+    /**
+     * Encrypt the cookie's value or not (The default value is false).
+     */
+    encrypt?: boolean;
+}
+/**
+ * cookies for egg
+ * extend pillarjs/cookies, add encrypt and decrypt
+ */
+export declare class Cookies {
+    #private;
+    readonly ctx: Record<string, any>;
+    readonly app: Record<string, any>;
+    readonly secure: boolean;
+    constructor(ctx: Record<string, any>, keys: string[], defaultCookieOptions?: DefaultCookieOptions);
+    get keys(): Keygrip;
+    /**
+     * get cookie value by name
+     * @param  {String} name - cookie's name
+     * @param  {Object} opts - cookies' options
+     *            - {Boolean} signed - default to true
+     *            - {Boolean} encrypt - default to false
+     * @return {String} value - cookie's value
+     */
+    get(name: string, opts?: CookieGetOptions): string | undefined;
+    _get(name: string, opts: CookieGetOptions): string | undefined;
+    set(name: string, value: string | null, opts?: CookieSetOptions): this;
+    isSameSiteNoneCompatible(userAgent: string): boolean;
+    isPartitionedCompatible(userAgent: string): boolean;
+}

package/dist/commonjs/cookies.js

@@ -0,0 +1,271 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cookies = void 0;
+const node_assert_1 = __importDefault(require("node:assert"));
+const utility_1 = require("utility");
+const should_send_same_site_none_1 = require("should-send-same-site-none");
+const keygrip_js_1 = require("./keygrip.js");
+const cookie_js_1 = require("./cookie.js");
+const error_js_1 = require("./error.js");
+const keyCache = new Map();
+/**
+ * cookies for egg
+ * extend pillarjs/cookies, add encrypt and decrypt
+ */
+class Cookies {
+    #keysArray;
+    #keys;
+    #defaultCookieOptions;
+    #autoChips;
+    ctx;
+    app;
+    secure;
+    #parseChromiumResult;
+    constructor(ctx, keys, defaultCookieOptions) {
+        this.#keysArray = keys;
+        // default cookie options
+        this.#defaultCookieOptions = defaultCookieOptions;
+        this.#autoChips = defaultCookieOptions?.autoChips;
+        this.ctx = ctx;
+        this.secure = this.ctx.secure;
+        this.app = ctx.app;
+    }
+    get keys() {
+        if (!this.#keys) {
+            (0, node_assert_1.default)(Array.isArray(this.#keysArray), '.keys required for encrypt/sign cookies');
+            const cache = keyCache.get(this.#keysArray);
+            if (cache) {
+                this.#keys = cache;
+            }
+            else {
+                this.#keys = new keygrip_js_1.Keygrip(this.#keysArray);
+                keyCache.set(this.#keysArray, this.#keys);
+            }
+        }
+        return this.#keys;
+    }
+    /**
+     * get cookie value by name
+     * @param  {String} name - cookie's name
+     * @param  {Object} opts - cookies' options
+     *            - {Boolean} signed - default to true
+     *            - {Boolean} encrypt - default to false
+     * @return {String} value - cookie's value
+     */
+    get(name, opts = {}) {
+        let value = this._get(name, opts);
+        if (value === undefined && this.#autoChips) {
+            // try to read _CHIPS-${name} prefix cookie
+            value = this._get(this.#formatChipsCookieName(name), opts);
+        }
+        return value;
+    }
+    _get(name, opts) {
+        const signed = computeSigned(opts);
+        const header = this.ctx.get('cookie');
+        if (!header)
+            return;
+        const match = header.match(getPattern(name));
+        if (!match)
+            return;
+        let value = match[1];
+        if (!opts.encrypt && !signed)
+            return value;
+        // signed
+        if (signed) {
+            const sigName = name + '.sig';
+            const sigValue = this.get(sigName, { signed: false });
+            if (!sigValue)
+                return;
+            const raw = name + '=' + value;
+            const index = this.keys.verify(raw, sigValue);
+            if (index < 0) {
+                // can not match any key, remove ${name}.sig
+                this.set(sigName, null, { path: '/', signed: false, overwrite: true });
+                return;
+            }
+            if (index > 0) {
+                // not signed by the first key, update sigValue
+                this.set(sigName, this.keys.sign(raw), { signed: false, overwrite: true });
+            }
+            return value;
+        }
+        // encrypt
+        value = (0, utility_1.base64decode)(value, true, 'buffer');
+        const res = this.keys.decrypt(value);
+        return res ? res.value.toString() : undefined;
+    }
+    set(name, value, opts) {
+        opts = {
+            ...this.#defaultCookieOptions,
+            ...opts,
+        };
+        const signed = computeSigned(opts);
+        value = value || '';
+        if (!this.secure && opts.secure) {
+            throw new error_js_1.CookieError('Cannot send secure cookie over unencrypted connection');
+        }
+        let headers = this.ctx.response.get('set-cookie') || [];
+        if (!Array.isArray(headers)) {
+            headers = [headers];
+        }
+        // encrypt
+        if (opts.encrypt) {
+            value = value && (0, utility_1.base64encode)(this.keys.encrypt(value), true);
+        }
+        // http://browsercookielimits.squawky.net/
+        if (value.length > 4093) {
+            this.app.emit('cookieLimitExceed', { name, value, ctx: this.ctx });
+        }
+        // https://github.com/linsight/should-send-same-site-none
+        // fixed SameSite=None: Known Incompatible Clients
+        const userAgent = this.ctx.get('user-agent');
+        let isSameSiteNone = false;
+        // disable autoChips if partitioned enable
+        let autoChips = !opts.partitioned && this.#autoChips;
+        if (opts.sameSite && typeof opts.sameSite === 'string' && opts.sameSite.toLowerCase() === 'none') {
+            isSameSiteNone = true;
+            if (opts.secure === false || !this.secure || (userAgent && !this.isSameSiteNoneCompatible(userAgent))) {
+                // Non-secure context or Incompatible clients, don't send SameSite=None property
+                opts.sameSite = false;
+                isSameSiteNone = false;
+            }
+        }
+        if (autoChips || opts.partitioned) {
+            // allow to set partitioned: secure=true and sameSite=none and chrome >= 118
+            if (!isSameSiteNone || opts.secure === false || !this.secure || (userAgent && !this.isPartitionedCompatible(userAgent))) {
+                // Non-secure context or Incompatible clients, don't send partitioned property
+                autoChips = false;
+                opts.partitioned = false;
+            }
+        }
+        // remove unpartitioned same name cookie first
+        if (opts.partitioned && opts.removeUnpartitioned) {
+            const overwrite = opts.overwrite;
+            if (overwrite) {
+                opts.overwrite = false;
+                headers = ignoreCookiesByName(headers, name);
+            }
+            const removeCookieOpts = Object.assign({}, opts, {
+                partitioned: false,
+            });
+            const removeUnpartitionedCookie = new cookie_js_1.Cookie(name, '', removeCookieOpts);
+            // if user not set secure, reset secure to ctx.secure
+            if (opts.secure === undefined) {
+                removeUnpartitionedCookie.attrs.secure = this.secure;
+            }
+            headers = pushCookie(headers, removeUnpartitionedCookie);
+            // signed
+            if (signed) {
+                removeUnpartitionedCookie.name += '.sig';
+                headers = ignoreCookiesByName(headers, removeUnpartitionedCookie.name);
+                headers = pushCookie(headers, removeUnpartitionedCookie);
+            }
+        }
+        else if (autoChips) {
+            // add _CHIPS-${name} prefix cookie
+            const newCookieName = this.#formatChipsCookieName(name);
+            const newCookieOpts = {
+                ...opts,
+                partitioned: true,
+            };
+            const newPartitionedCookie = new cookie_js_1.Cookie(newCookieName, value, newCookieOpts);
+            // if user not set secure, reset secure to ctx.secure
+            if (opts.secure === undefined)
+                newPartitionedCookie.attrs.secure = this.secure;
+            headers = pushCookie(headers, newPartitionedCookie);
+            // signed
+            if (signed) {
+                newPartitionedCookie.value = value && this.keys.sign(newPartitionedCookie.toString());
+                newPartitionedCookie.name += '.sig';
+                headers = ignoreCookiesByName(headers, newPartitionedCookie.name);
+                headers = pushCookie(headers, newPartitionedCookie);
+            }
+        }
+        const cookie = new cookie_js_1.Cookie(name, value, opts);
+        // if user not set secure, reset secure to ctx.secure
+        if (opts.secure === undefined) {
+            cookie.attrs.secure = this.secure;
+        }
+        headers = pushCookie(headers, cookie);
+        // signed
+        if (signed) {
+            cookie.value = value && this.keys.sign(cookie.toString());
+            cookie.name += '.sig';
+            headers = pushCookie(headers, cookie);
+        }
+        this.ctx.set('set-cookie', headers);
+        return this;
+    }
+    #formatChipsCookieName(name) {
+        return `_CHIPS-${name}`;
+    }
+    #parseChromiumAndMajorVersion(userAgent) {
+        if (!this.#parseChromiumResult) {
+            this.#parseChromiumResult = parseChromiumAndMajorVersion(userAgent);
+        }
+        return this.#parseChromiumResult;
+    }
+    isSameSiteNoneCompatible(userAgent) {
+        // Chrome >= 80.0.0.0
+        const result = this.#parseChromiumAndMajorVersion(userAgent);
+        if (result.chromium) {
+            return result.majorVersion >= 80;
+        }
+        return (0, should_send_same_site_none_1.isSameSiteNoneCompatible)(userAgent);
+    }
+    isPartitionedCompatible(userAgent) {
+        // support: Chrome >= 114.0.0.0
+        // default enable: Chrome >= 118.0.0.0
+        // https://developers.google.com/privacy-sandbox/3pcd/chips
+        const result = this.#parseChromiumAndMajorVersion(userAgent);
+        if (result.chromium) {
+            return result.majorVersion >= 118;
+        }
+        return false;
+    }
+}
+exports.Cookies = Cookies;
+// https://github.com/linsight/should-send-same-site-none/blob/master/index.js#L86
+function parseChromiumAndMajorVersion(userAgent) {
+    const m = /Chrom[^ /]{1,100}\/(\d{1,100}?)\./.exec(userAgent);
+    if (!m) {
+        return { chromium: false, majorVersion: 0 };
+    }
+    // Extract digits from first capturing group.
+    return { chromium: true, majorVersion: parseInt(m[1]) };
+}
+const _patternCache = new Map();
+function getPattern(name) {
+    const cache = _patternCache.get(name);
+    if (cache) {
+        return cache;
+    }
+    const reg = new RegExp('(?:^|;) *' +
+        name.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&') +
+        '=([^;]*)');
+    _patternCache.set(name, reg);
+    return reg;
+}
+function computeSigned(opts) {
+    // encrypt default to false, signed default to true.
+    // disable singed when encrypt is true.
+    if (opts.encrypt)
+        return false;
+    return opts.signed !== false;
+}
+function pushCookie(cookies, cookie) {
+    if (cookie.attrs.overwrite) {
+        cookies = ignoreCookiesByName(cookies, cookie.name);
+    }
+    cookies.push(cookie.toHeader());
+    return cookies;
+}
+function ignoreCookiesByName(cookies, name) {
+    const prefix = `${name}=`;
+    return cookies.filter(c => !c.startsWith(prefix));
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"cookies.js","sourceRoot":"","sources":["../../src/cookies.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAiC;AACjC,qCAAqD;AACrD,2EAAsE;AACtE,6CAAuC;AACvC,2CAAuD;AACvD,yCAAyC;AAEzC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAqB,CAAC;AAoB9C;;;GAGG;AACH,MAAa,OAAO;IACT,UAAU,CAAW;IAC9B,KAAK,CAAU;IACN,qBAAqB,CAAwB;IAC7C,UAAU,CAAW;IACrB,GAAG,CAAsB;IACzB,GAAG,CAAsB;IACzB,MAAM,CAAU;IACzB,oBAAoB,CAAuB;IAE3C,YAAY,GAAwB,EAAE,IAAc,EAAE,oBAA2C;QAC/F,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,yBAAyB;QACzB,IAAI,CAAC,qBAAqB,GAAG,oBAAoB,CAAC;QAClD,IAAI,CAAC,UAAU,GAAG,oBAAoB,EAAE,SAAS,CAAC;QAClD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;IACrB,CAAC;IAED,IAAI,IAAI;QACN,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,IAAA,qBAAM,EAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,yCAAyC,CAAC,CAAC;YAClF,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC5C,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACrB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBAC1C,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,IAAY,EAAE,OAAyB,EAAE;QAC3C,IAAI,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClC,IAAI,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YAC3C,2CAA2C;YAC3C,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,IAAY,EAAE,IAAsB;QACvC,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QACnC,MAAM,MAAM,GAAW,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM;YAAE,OAAO;QAEpB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,KAAK;YAAE,OAAO;QAEnB,IAAI,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAE3C,SAAS;QACT,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC;YAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YACtD,IAAI,CAAC,QAAQ;gBAAE,OAAO;YAEtB,MAAM,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,KAAK,CAAC;YAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YAC9C,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,4CAA4C;gBAC5C,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBACvE,OAAO;YACT,CAAC;YACD,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,+CAA+C;gBAC/C,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC7E,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,UAAU;QACV,KAAK,GAAG,IAAA,sBAAY,EAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAW,CAAC;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACrC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAChD,CAAC;IAED,GAAG,CAAC,IAAY,EAAE,KAAoB,EAAE,IAAuB;QAC7D,IAAI,GAAG;YACL,GAAG,IAAI,CAAC,qBAAqB;YAC7B,GAAG,IAAI;SACR,CAAC;QACF,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QACnC,KAAK,GAAG,KAAK,IAAI,EAAE,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,IAAI,sBAAW,CAAC,uDAAuD,CAAC,CAAC;QACjF,CAAC;QAED,IAAI,OAAO,GAAa,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;QAClE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,OAAO,GAAG,CAAE,OAAO,CAAE,CAAC;QACxB,CAAC;QAED,UAAU;QACV,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,KAAK,GAAG,KAAK,IAAI,IAAA,sBAAY,EAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QAChE,CAAC;QAED,0CAA0C;QAC1C,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,yDAAyD;QACzD,kDAAkD;QAClD,MAAM,SAAS,GAAuB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,0CAA0C;QAC1C,IAAI,SAAS,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,UAAU,CAAC;QACrD,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;YACjG,cAAc,GAAG,IAAI,CAAC;YACtB,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;gBACtG,gFAAgF;gBAChF,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;gBACtB,cAAc,GAAG,KAAK,CAAC;YACzB,CAAC;QACH,CAAC;QACD,IAAI,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAClC,4EAA4E;YAC5E,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;gBACxH,8EAA8E;gBAC9E,SAAS,GAAG,KAAK,CAAC;gBAClB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;YAC3B,CAAC;QACH,CAAC;QAED,8CAA8C;QAC9C,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACjD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;YACjC,IAAI,SAAS,EAAE,CAAC;gBACd,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;gBACvB,OAAO,GAAG,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC/C,CAAC;YACD,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE;gBAC/C,WAAW,EAAE,KAAK;aACnB,CAAC,CAAC;YACH,MAAM,yBAAyB,GAAG,IAAI,kBAAM,CAAC,IAAI,EAAE,EAAE,EAAE,gBAAgB,CAAC,CAAC;YACzE,qDAAqD;YACrD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC9B,yBAAyB,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YACvD,CAAC;YAED,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC;YACzD,SAAS;YACT,IAAI,MAAM,EAAE,CAAC;gBACX,yBAAyB,CAAC,IAAI,IAAI,MAAM,CAAC;gBACzC,OAAO,GAAG,mBAAmB,CAAC,OAAO,EAAE,yBAAyB,CAAC,IAAI,CAAC,CAAC;gBACvE,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;aAAM,IAAI,SAAS,EAAE,CAAC;YACrB,mCAAmC;YACnC,MAAM,aAAa,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;YACxD,MAAM,aAAa,GAAG;gBACpB,GAAG,IAAI;gBACP,WAAW,EAAE,IAAI;aAClB,CAAC;YACF,MAAM,oBAAoB,GAAG,IAAI,kBAAM,CAAC,aAAa,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;YAC7E,qDAAqD;YACrD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;gBAAE,oBAAoB,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAE/E,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;YACpD,SAAS;YACT,IAAI,MAAM,EAAE,CAAC;gBACX,oBAAoB,CAAC,KAAK,GAAG,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,CAAC,CAAC;gBACtF,oBAAoB,CAAC,IAAI,IAAI,MAAM,CAAC;gBACpC,OAAO,GAAG,mBAAmB,CAAC,OAAO,EAAE,oBAAoB,CAAC,IAAI,CAAC,CAAC;gBAClE,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,kBAAM,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAC7C,qDAAqD;QACrD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACpC,CAAC;QACD,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAEtC,SAAS;QACT,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,KAAK,GAAG,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC1D,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC;YACtB,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sBAAsB,CAAC,IAAY;QACjC,OAAO,UAAU,IAAI,EAAE,CAAC;IAC1B,CAAC;IAED,6BAA6B,CAAC,SAAiB;QAC7C,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/B,IAAI,CAAC,oBAAoB,GAAG,4BAA4B,CAAC,SAAS,CAAC,CAAC;QACtE,CAAC;QACD,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED,wBAAwB,CAAC,SAAiB;QACxC,qBAAqB;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,OAAO,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC;QACnC,CAAC;QACD,OAAO,IAAA,qDAAwB,EAAC,SAAS,CAAC,CAAC;IAC7C,CAAC;IAED,uBAAuB,CAAC,SAAiB;QACvC,+BAA+B;QAC/B,sCAAsC;QACtC,2DAA2D;QAC3D,MAAM,MAAM,GAAG,IAAI,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,OAAO,MAAM,CAAC,YAAY,IAAI,GAAG,CAAC;QACpC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AArOD,0BAqOC;AAOD,kFAAkF;AAClF,SAAS,4BAA4B,CAAC,SAAiB;IACrD,MAAM,CAAC,GAAG,mCAAmC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9D,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC;IAC9C,CAAC;IACD,6CAA6C;IAC7C,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC1D,CAAC;AAED,MAAM,aAAa,GAAG,IAAI,GAAG,EAAkB,CAAC;AAChD,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,KAAK,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACtC,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,MAAM,CACpB,WAAW;QACX,IAAI,CAAC,OAAO,CAAC,0BAA0B,EAAE,MAAM,CAAC;QAChD,UAAU,CACX,CAAC;IACF,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC7B,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,aAAa,CAAC,IAAsD;IAC3E,oDAAoD;IACpD,uCAAuC;IACvC,IAAI,IAAI,CAAC,OAAO;QAAE,OAAO,KAAK,CAAC;IAC/B,OAAO,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC;AAC/B,CAAC;AAED,SAAS,UAAU,CAAC,OAAiB,EAAE,MAAc;IACnD,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;QAC3B,OAAO,GAAG,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IAChC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAiB,EAAE,IAAY;IAC1D,MAAM,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC;IAC1B,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;AACpD,CAAC"}

package/dist/commonjs/error.d.ts

@@ -0,0 +1,3 @@
+export declare class CookieError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}