@remix-run/cookie 0.2.0 → 0.4.0

package/README.md

@@ -1,4 +1,4 @@
-# @remix-run/cookie
+# cookie
 
 Simplify HTTP cookie management in JavaScript with type-safe, secure cookie handling. `@remix-run/cookie` provides a clean, intuitive API for creating, parsing, and serializing HTTP cookies with built-in support for signing, secret rotation, and comprehensive cookie attribute management.
 
@@ -8,8 +8,6 @@ HTTP cookies are essential for web applications, from session management and use
 
 - **Secure Cookie Signing:** Built-in cryptographic signing using HMAC-SHA256 to prevent cookie tampering, with support for secret rotation without breaking existing cookies.
 - **Secret Rotation Support:** Seamlessly rotate signing secrets while maintaining backward compatibility with existing cookies.
-- **Comprehensive Cookie Attributes:** Full support for all standard cookie attributes including `Path`, `Domain`, `Secure`, `HttpOnly`, `SameSite`, `Max-Age`, and `Expires`.
-- **Reusable Cookie Containers:** Create logical cookie containers that can be used to parse and serialize multiple values over time.
 - **Web Standards Compliant:** Built on Web Crypto API and standard cookie parsing, making it runtime-agnostic (Node.js, Bun, Deno, Cloudflare Workers).
 
 ## Installation
@@ -21,9 +19,9 @@ npm install @remix-run/cookie
 ## Usage
 
 ```tsx
-import { Cookie } from '@remix-run/cookie'
+import { createCookie } from '@remix-run/cookie'
 
-let sessionCookie = new Cookie('session')
+let sessionCookie = createCookie('session', { secrets: ['s3cret1'] })
 
 // Get the value of the "session" cookie from the request's `Cookie` header
 let value = await sessionCookie.parse(request.headers.get('Cookie'))
@@ -46,7 +44,7 @@ Secret rotation is also supported, so you can easily rotate in new secrets witho
 import { Cookie } from '@remix-run/cookie'
 
 // Start with a single secret
-let sessionCookie = new Cookie('session', {
+let sessionCookie = createCookie('session', {
   secrets: ['secret1'],
 })
 
@@ -62,12 +60,19 @@ let response = new Response('Hello, world!', {
 All cookies sent in this scenario will be signed with the secret `secret1`. Later, when it's time to rotate secrets, add a new secret to the beginning of the array and all existing cookies will still be able to be parsed.
 
 ```tsx
-let sessionCookie = new Cookie('session', {
+let sessionCookie = createCookie('session', {
   secrets: ['secret2', 'secret1'],
 })
 
-// This will still work for cookies signed with the old secret
+// This works for cookies signed with either secret
 let value = await sessionCookie.parse(request.headers.get('Cookie'))
+
+// Newly serialized cookies will be signed with the new secret
+let response = new Response('Hello, world!', {
+  headers: {
+    'Set-Cookie': await sessionCookie.serialize(value),
+  },
+})
 ```
 
 ### Custom Encoding
@@ -75,7 +80,7 @@ let value = await sessionCookie.parse(request.headers.get('Cookie'))
 By default, the library will use `encodeURIComponent` and `decodeURIComponent` to encode and decode the cookie value. This is suitable for most use cases, but you can provide your own functions to customize the encoding and decoding of the cookie value.
 
 ```tsx
-let sessionCookie = new Cookie('session', {
+let sessionCookie = createCookie('session', {
   encode: (value) => value,
   decode: (value) => value,
 })

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { type CookieOptions, Cookie } from './lib/cookie.ts';
+export { type Cookie, type CookieOptions, createCookie } from './lib/cookie.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,aAAa,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA"}

package/dist/index.js

@@ -1 +1 @@
-export { Cookie } from "./lib/cookie.js";
+export { createCookie } from "./lib/cookie.js";

package/dist/lib/{crypto.d.ts → cookie-signing.d.ts}

@@ -1,3 +1,3 @@
 export declare function sign(value: string, secret: string): Promise<string>;
 export declare function unsign(cookie: string, secret: string): Promise<string | false>;
-//# sourceMappingURL=crypto.d.ts.map
+//# sourceMappingURL=cookie-signing.d.ts.map

package/dist/lib/cookie-signing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cookie-signing.d.ts","sourceRoot":"","sources":["../../src/lib/cookie-signing.ts"],"names":[],"mappings":"AAEA,wBAAsB,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAOzE;AAED,wBAAsB,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,CAuBpF"}

package/dist/lib/{crypto.js → cookie-signing.js}

@@ -8,12 +8,15 @@ export async function sign(value, secret) {
 }
 export async function unsign(cookie, secret) {
     let index = cookie.lastIndexOf('.');
+    if (index === -1) {
+        return false;
+    }
     let value = cookie.slice(0, index);
     let hash = cookie.slice(index + 1);
     let data = encoder.encode(value);
     let key = await createKey(secret, ['verify']);
     try {
-        let signature = byteStringToUint8Array(atob(hash));
+        let signature = byteStringToArray(atob(hash));
         let valid = await crypto.subtle.verify('HMAC', key, signature, data);
         return valid ? value : false;
     }
@@ -27,7 +30,7 @@ export async function unsign(cookie, secret) {
 async function createKey(secret, usages) {
     return crypto.subtle.importKey('raw', encoder.encode(secret), { name: 'HMAC', hash: 'SHA-256' }, false, usages);
 }
-function byteStringToUint8Array(byteString) {
+function byteStringToArray(byteString) {
     let array = new Uint8Array(byteString.length);
     for (let i = 0; i < byteString.length; i++) {
         array[i] = byteString.charCodeAt(i);

package/dist/lib/cookie.d.ts

@@ -1,5 +1,87 @@
 import { type CookieProperties } from '@remix-run/headers';
-export interface CookieOptions {
+type SameSiteValue = 'Strict' | 'Lax' | 'None';
+/**
+ * Represents a HTTP cookie.
+ *
+ * Supports parsing and serializing the cookie to/from `Cookie` and `Set-Cookie` headers.
+ *
+ * Also supports cryptographic signing of the cookie value to ensure it's not tampered with, and
+ * secret rotation to easily rotate secrets without breaking existing cookies.
+ */
+export interface Cookie {
+    /**
+     * The domain of the cookie.
+     *
+     * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#domaindomain-value)
+     */
+    readonly domain: string | undefined;
+    /**
+     * The expiration date of the cookie.
+     *
+     * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#expiresdate)
+     */
+    readonly expires: Date | undefined;
+    /**
+     * True if the cookie is HTTP-only.
+     *
+     * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#httponly)
+     */
+    readonly httpOnly: boolean;
+    /**
+     * The maximum age of the cookie in seconds.
+     *
+     * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Set-Cookie#max-agenumber)
+     */
+    readonly maxAge: number | undefined;
+    /**
+     * The name of the cookie.
+     *
+     * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Set-Cookie#cookie-namecookie-value)
+     */
+    readonly name: string;
+    /**
+     * Extracts the value of this cookie from a `Cookie` header value.
+     * @param headerValue The `Cookie` header to parse
+     * @returns The value of this cookie, or `null` if it's not present
+     */
+    parse(headerValue: string | null): Promise<string | null>;
+    /**
+     * True if the cookie is partitioned.
+     *
+     * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#partitioned)
+     */
+    readonly partitioned: boolean;
+    /**
+     * The path of the cookie. Defaults to `/`.
+     *
+     * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#pathpath-value)
+     */
+    readonly path: string;
+    /**
+     * The `SameSite` attribute of the cookie. Defaults to `Lax`.
+     *
+     * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#samesitesamesite-value)
+     */
+    readonly sameSite: SameSiteValue;
+    /**
+     * True if the cookie is secure (only sent over HTTPS).
+     *
+     * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#secure)
+     */
+    readonly secure: boolean;
+    /**
+     * Returns the value to use in a `Set-Cookie` header for this cookie.
+     * @param value The value to serialize
+     * @param props (optional) Additional properties to use when serializing the cookie
+     * @returns The `Set-Cookie` header for this cookie
+     */
+    serialize(value: string, props?: CookieProperties): Promise<string>;
+    /**
+     * True if this cookie uses one or more secrets for verification.
+     */
+    readonly signed: boolean;
+}
+export interface CookieOptions extends CookieProperties {
     /**
      * A function that decodes the cookie value.
      *
@@ -29,29 +111,11 @@ export interface CookieOptions {
     secrets?: string[];
 }
 /**
- * A container for metadata about a HTTP cookie; its name and secrets that may be used
- * to sign/unsign the value of the cookie to ensure it's not tampered with.
+ * Creates a new cookie object.
+ * @param name The name of the cookie
+ * @param options (optional) Additional options for the cookie
+ * @returns A cookie object
  */
-export declare class Cookie {
-    #private;
-    readonly name: string;
-    constructor(name: string, options?: CookieOptions);
-    /**
-     * True if this cookie uses one or more secrets for verification.
-     */
-    get isSigned(): boolean;
-    /**
-     * Extracts the value of this cookie from a `Cookie` header value.
-     * @param headerValue The value of the `Cookie` header to parse
-     * @returns The value of this cookie, or `null` if it's not present
-     */
-    parse(headerValue: string | null): Promise<string | null>;
-    /**
-     * Returns the value to use in a `Set-Cookie` header for this cookie.
-     * @param value The value to serialize
-     * @param props (optional) Additional properties to use when serializing the cookie
-     * @returns The value to use in a `Set-Cookie` header for this cookie
-     */
-    serialize(value: string, props?: CookieProperties): Promise<string>;
-}
+export declare function createCookie(name: string, options?: CookieOptions): Cookie;
+export {};
 //# sourceMappingURL=cookie.d.ts.map

package/dist/lib/cookie.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cookie.d.ts","sourceRoot":"","sources":["../../src/lib/cookie.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,gBAAgB,EACtB,MAAM,oBAAoB,CAAA;AAI3B,MAAM,WAAW,aAAa;IAC5B;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;IAClC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;IAClC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;;GAGG;AACH,qBAAa,MAAM;;IACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;gBAKT,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAOjD;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;OAIG;IACG,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAa/D;;;;;OAKG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;CAY1E"}
+{"version":3,"file":"cookie.d.ts","sourceRoot":"","sources":["../../src/lib/cookie.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,gBAAgB,EACtB,MAAM,oBAAoB,CAAA;AAI3B,KAAK,aAAa,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAA;AAE9C;;;;;;;GAOG;AACH,MAAM,WAAW,MAAM;IACrB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,IAAI,GAAG,SAAS,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IACzD;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAA;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IACxB;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IACnE;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;IAClC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;IAClC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM,CA4E1E"}

package/dist/lib/cookie.js

@@ -1,72 +1,75 @@
 import { Cookie as CookieHeader, SetCookie as SetCookieHeader, } from '@remix-run/headers';
-import { sign, unsign } from "./crypto.js";
+import { sign, unsign } from "./cookie-signing.js";
 /**
- * A container for metadata about a HTTP cookie; its name and secrets that may be used
- * to sign/unsign the value of the cookie to ensure it's not tampered with.
+ * Creates a new cookie object.
+ * @param name The name of the cookie
+ * @param options (optional) Additional options for the cookie
+ * @returns A cookie object
  */
-export class Cookie {
-    name;
-    #decode;
-    #encode;
-    #secrets;
-    constructor(name, options) {
-        this.name = name;
-        this.#decode = options?.decode;
-        this.#encode = options?.encode;
-        this.#secrets = options?.secrets ?? [];
-    }
-    /**
-     * True if this cookie uses one or more secrets for verification.
-     */
-    get isSigned() {
-        return this.#secrets.length > 0;
-    }
-    /**
-     * Extracts the value of this cookie from a `Cookie` header value.
-     * @param headerValue The value of the `Cookie` header to parse
-     * @returns The value of this cookie, or `null` if it's not present
-     */
-    async parse(headerValue) {
-        if (!headerValue)
-            return null;
-        let header = new CookieHeader(headerValue);
-        if (!header.has(this.name))
-            return null;
-        let value = header.get(this.name);
-        if (value === '')
-            return '';
-        let decoded = await decodeCookieValue(value, this.#secrets, this.#decode);
-        return decoded;
-    }
-    /**
-     * Returns the value to use in a `Set-Cookie` header for this cookie.
-     * @param value The value to serialize
-     * @param props (optional) Additional properties to use when serializing the cookie
-     * @returns The value to use in a `Set-Cookie` header for this cookie
-     */
-    async serialize(value, props) {
-        let header = new SetCookieHeader({
-            name: this.name,
-            value: value === '' ? '' : await encodeCookieValue(value, this.#secrets, this.#encode),
-            // sane defaults
-            path: '/',
-            sameSite: 'Lax',
-            ...props,
-        });
-        return header.toString();
-    }
-}
-async function encodeCookieValue(value, secrets, encode = encodeURIComponent) {
-    let encoded = encodeValue(value, encode);
-    if (secrets.length > 0) {
-        encoded = await sign(encoded, secrets[0]);
-    }
-    return encoded;
+export function createCookie(name, options) {
+    let { decode = decodeURIComponent, encode = encodeURIComponent, secrets = [], domain, expires, httpOnly, maxAge, path = '/', partitioned, secure, sameSite = 'Lax', } = options ?? {};
+    return {
+        get domain() {
+            return domain;
+        },
+        get expires() {
+            return expires;
+        },
+        get httpOnly() {
+            return httpOnly ?? false;
+        },
+        get maxAge() {
+            return maxAge;
+        },
+        get name() {
+            return name;
+        },
+        async parse(headerValue) {
+            if (!headerValue)
+                return null;
+            let header = new CookieHeader(headerValue);
+            if (!header.has(name))
+                return null;
+            let value = header.get(name);
+            if (value === '')
+                return '';
+            let decoded = await decodeCookieValue(value, secrets, decode);
+            return decoded;
+        },
+        get partitioned() {
+            return partitioned ?? false;
+        },
+        get path() {
+            return path;
+        },
+        get sameSite() {
+            return sameSite;
+        },
+        get secure() {
+            return secure ?? false;
+        },
+        async serialize(value, props) {
+            let header = new SetCookieHeader({
+                name: name,
+                value: value === '' ? '' : await encodeCookieValue(value, secrets, encode),
+                domain,
+                expires,
+                httpOnly,
+                maxAge,
+                partitioned,
+                path,
+                sameSite,
+                secure,
+                ...props,
+            });
+            return header.toString();
+        },
+        get signed() {
+            return secrets.length > 0;
+        },
+    };
 }
-function encodeValue(value, encode) {
-    return btoa(myUnescape(encode(value)));
-}
-async function decodeCookieValue(value, secrets, decode = decodeURIComponent) {
+async function decodeCookieValue(value, secrets, decode) {
     if (secrets.length > 0) {
         for (let secret of secrets) {
             let unsignedValue = await unsign(value, secret);
@@ -115,6 +118,15 @@ function hex(code, length) {
         result = '0' + result;
     return result;
 }
+async function encodeCookieValue(value, secrets, encode) {
+    let encoded = encodeValue(value, encode);
+    if (secrets.length > 0)
+        encoded = await sign(encoded, secrets[0]);
+    return encoded;
+}
+function encodeValue(value, encode) {
+    return btoa(myUnescape(encode(value)));
+}
 // See: https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.unescape.js
 function myUnescape(value) {
     let str = value.toString();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/cookie",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "A toolkit for working with cookies in JavaScript",
   "author": "Michael Jackson <mjijackson@gmail.com>",
   "license": "MIT",
@@ -29,7 +29,7 @@
     "@types/node": "^24.6.0"
   },
   "peerDependencies": {
-    "@remix-run/headers": "0.15.0"
+    "@remix-run/headers": "^0.16.0"
   },
   "keywords": [
     "http",

package/src/index.ts

@@ -1 +1 @@
-export { type CookieOptions, Cookie } from './lib/cookie.ts'
+export { type Cookie, type CookieOptions, createCookie } from './lib/cookie.ts'

package/src/lib/{crypto.ts → cookie-signing.ts}

@@ -11,14 +11,18 @@ export async function sign(value: string, secret: string): Promise<string> {
 
 export async function unsign(cookie: string, secret: string): Promise<string | false> {
   let index = cookie.lastIndexOf('.')
+
+  if (index === -1) {
+    return false
+  }
+
   let value = cookie.slice(0, index)
   let hash = cookie.slice(index + 1)
-
   let data = encoder.encode(value)
-
   let key = await createKey(secret, ['verify'])
+
   try {
-    let signature = byteStringToUint8Array(atob(hash))
+    let signature = byteStringToArray(atob(hash))
     let valid = await crypto.subtle.verify('HMAC', key, signature, data)
 
     return valid ? value : false
@@ -40,7 +44,7 @@ async function createKey(secret: string, usages: CryptoKey['usages']): Promise<C
   )
 }
 
-function byteStringToUint8Array(byteString: string): Uint8Array {
+function byteStringToArray(byteString: string): Uint8Array<ArrayBuffer> {
   let array = new Uint8Array(byteString.length)
 
   for (let i = 0; i < byteString.length; i++) {

package/src/lib/cookie.ts

@@ -4,9 +4,93 @@ import {
   type CookieProperties,
 } from '@remix-run/headers'
 
-import { sign, unsign } from './crypto.ts'
+import { sign, unsign } from './cookie-signing.ts'
 
-export interface CookieOptions {
+type SameSiteValue = 'Strict' | 'Lax' | 'None'
+
+/**
+ * Represents a HTTP cookie.
+ *
+ * Supports parsing and serializing the cookie to/from `Cookie` and `Set-Cookie` headers.
+ *
+ * Also supports cryptographic signing of the cookie value to ensure it's not tampered with, and
+ * secret rotation to easily rotate secrets without breaking existing cookies.
+ */
+export interface Cookie {
+  /**
+   * The domain of the cookie.
+   *
+   * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#domaindomain-value)
+   */
+  readonly domain: string | undefined
+  /**
+   * The expiration date of the cookie.
+   *
+   * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#expiresdate)
+   */
+  readonly expires: Date | undefined
+  /**
+   * True if the cookie is HTTP-only.
+   *
+   * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#httponly)
+   */
+  readonly httpOnly: boolean
+  /**
+   * The maximum age of the cookie in seconds.
+   *
+   * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Set-Cookie#max-agenumber)
+   */
+  readonly maxAge: number | undefined
+  /**
+   * The name of the cookie.
+   *
+   * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Set-Cookie#cookie-namecookie-value)
+   */
+  readonly name: string
+  /**
+   * Extracts the value of this cookie from a `Cookie` header value.
+   * @param headerValue The `Cookie` header to parse
+   * @returns The value of this cookie, or `null` if it's not present
+   */
+  parse(headerValue: string | null): Promise<string | null>
+  /**
+   * True if the cookie is partitioned.
+   *
+   * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#partitioned)
+   */
+  readonly partitioned: boolean
+  /**
+   * The path of the cookie. Defaults to `/`.
+   *
+   * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#pathpath-value)
+   */
+  readonly path: string
+  /**
+   * The `SameSite` attribute of the cookie. Defaults to `Lax`.
+   *
+   * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#samesitesamesite-value)
+   */
+  readonly sameSite: SameSiteValue
+  /**
+   * True if the cookie is secure (only sent over HTTPS).
+   *
+   * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#secure)
+   */
+  readonly secure: boolean
+  /**
+   * Returns the value to use in a `Set-Cookie` header for this cookie.
+   * @param value The value to serialize
+   * @param props (optional) Additional properties to use when serializing the cookie
+   * @returns The `Set-Cookie` header for this cookie
+   */
+  serialize(value: string, props?: CookieProperties): Promise<string>
+  /**
+   * True if this cookie uses one or more secrets for verification.
+   */
+  readonly signed: boolean
+}
+
+export interface CookieOptions extends CookieProperties {
   /**
    * A function that decodes the cookie value.
    *
@@ -37,89 +121,95 @@ export interface CookieOptions {
 }
 
 /**
- * A container for metadata about a HTTP cookie; its name and secrets that may be used
- * to sign/unsign the value of the cookie to ensure it's not tampered with.
+ * Creates a new cookie object.
+ * @param name The name of the cookie
+ * @param options (optional) Additional options for the cookie
+ * @returns A cookie object
  */
-export class Cookie {
-  readonly name: string
-  readonly #decode?: (value: string) => string
-  readonly #encode?: (value: string) => string
-  readonly #secrets: string[]
-
-  constructor(name: string, options?: CookieOptions) {
-    this.name = name
-    this.#decode = options?.decode
-    this.#encode = options?.encode
-    this.#secrets = options?.secrets ?? []
-  }
-
-  /**
-   * True if this cookie uses one or more secrets for verification.
-   */
-  get isSigned(): boolean {
-    return this.#secrets.length > 0
-  }
-
-  /**
-   * Extracts the value of this cookie from a `Cookie` header value.
-   * @param headerValue The value of the `Cookie` header to parse
-   * @returns The value of this cookie, or `null` if it's not present
-   */
-  async parse(headerValue: string | null): Promise<string | null> {
-    if (!headerValue) return null
-
-    let header = new CookieHeader(headerValue)
-    if (!header.has(this.name)) return null
+export function createCookie(name: string, options?: CookieOptions): Cookie {
+  let {
+    decode = decodeURIComponent,
+    encode = encodeURIComponent,
+    secrets = [],
+    domain,
+    expires,
+    httpOnly,
+    maxAge,
+    path = '/',
+    partitioned,
+    secure,
+    sameSite = 'Lax',
+  } = options ?? {}
 
-    let value = header.get(this.name)!
-    if (value === '') return ''
+  return {
+    get domain() {
+      return domain
+    },
+    get expires() {
+      return expires
+    },
+    get httpOnly() {
+      return httpOnly ?? false
+    },
+    get maxAge() {
+      return maxAge
+    },
+    get name() {
+      return name
+    },
+    async parse(headerValue: string | null): Promise<string | null> {
+      if (!headerValue) return null
 
-    let decoded = await decodeCookieValue(value, this.#secrets, this.#decode)
-    return decoded
-  }
+      let header = new CookieHeader(headerValue)
+      if (!header.has(name)) return null
 
-  /**
-   * Returns the value to use in a `Set-Cookie` header for this cookie.
-   * @param value The value to serialize
-   * @param props (optional) Additional properties to use when serializing the cookie
-   * @returns The value to use in a `Set-Cookie` header for this cookie
-   */
-  async serialize(value: string, props?: CookieProperties): Promise<string> {
-    let header = new SetCookieHeader({
-      name: this.name,
-      value: value === '' ? '' : await encodeCookieValue(value, this.#secrets, this.#encode),
-      // sane defaults
-      path: '/',
-      sameSite: 'Lax',
-      ...props,
-    })
-
-    return header.toString()
-  }
-}
+      let value = header.get(name)!
+      if (value === '') return ''
 
-async function encodeCookieValue(
-  value: string,
-  secrets: string[],
-  encode: (value: string) => string = encodeURIComponent,
-): Promise<string> {
-  let encoded = encodeValue(value, encode)
+      let decoded = await decodeCookieValue(value, secrets, decode)
+      return decoded
+    },
+    get partitioned() {
+      return partitioned ?? false
+    },
+    get path() {
+      return path
+    },
+    get sameSite() {
+      return sameSite
+    },
+    get secure() {
+      return secure ?? false
+    },
+    async serialize(value: string, props?: CookieProperties): Promise<string> {
+      let header = new SetCookieHeader({
+        name: name,
+        value: value === '' ? '' : await encodeCookieValue(value, secrets, encode),
+        domain,
+        expires,
+        httpOnly,
+        maxAge,
+        partitioned,
+        path,
+        sameSite,
+        secure,
+        ...props,
+      })
 
-  if (secrets.length > 0) {
-    encoded = await sign(encoded, secrets[0])
+      return header.toString()
+    },
+    get signed() {
+      return secrets.length > 0
+    },
   }
-
-  return encoded
 }
 
-function encodeValue(value: string, encode: (value: string) => string): string {
-  return btoa(myUnescape(encode(value)))
-}
+type Coder = (value: string) => string
 
 async function decodeCookieValue(
   value: string,
   secrets: string[],
-  decode: (value: string) => string = decodeURIComponent,
+  decode: Coder,
 ): Promise<string | null> {
   if (secrets.length > 0) {
     for (let secret of secrets) {
@@ -135,7 +225,7 @@ async function decodeCookieValue(
   return decodeValue(value, decode)
 }
 
-function decodeValue(value: string, decode: (value: string) => string): string | null {
+function decodeValue(value: string, decode: Coder): string | null {
   try {
     return decode(myEscape(atob(value)))
   } catch {
@@ -171,6 +261,16 @@ function hex(code: number, length: number): string {
   return result
 }
 
+async function encodeCookieValue(value: string, secrets: string[], encode: Coder): Promise<string> {
+  let encoded = encodeValue(value, encode)
+  if (secrets.length > 0) encoded = await sign(encoded, secrets[0])
+  return encoded
+}
+
+function encodeValue(value: string, encode: Coder): string {
+  return btoa(myUnescape(encode(value)))
+}
+
 // See: https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/es.unescape.js
 function myUnescape(value: string): string {
   let str = value.toString()

package/dist/lib/crypto.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"crypto.d.ts","sourceRoot":"","sources":["../../src/lib/crypto.ts"],"names":[],"mappings":"AAEA,wBAAsB,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAOzE;AAED,wBAAsB,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,CAmBpF"}