@remix-run/cookie 0.5.0 → 0.5.1

package/README.md

@@ -57,7 +57,7 @@ let sessionCookie = createCookie('session', {
   secrets: ['secret1'],
 })
 
-console.log(sessionCookie.isSigned) // true
+console.log(sessionCookie.signed) // true
 
 let response = new Response('Hello, world!', {
   headers: {
@@ -86,7 +86,7 @@ let response = new Response('Hello, world!', {
 
 ### Custom Encoding
 
-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.
+By default, [`encodeURIComponent`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) and [`decodeURIComponent`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent) are used 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 = createCookie('session', {

package/dist/lib/cookie-signing.js

@@ -27,7 +27,7 @@ export async function unsign(cookie, secret) {
         return false;
     }
 }
-async function createKey(secret, usages) {
+function createKey(secret, usages) {
     return crypto.subtle.importKey('raw', encoder.encode(secret), { name: 'HMAC', hash: 'SHA-256' }, false, usages);
 }
 function byteStringToArray(byteString) {

package/dist/lib/cookie.d.ts

@@ -1,21 +1,24 @@
 import { type CookieProperties } from '@remix-run/headers';
+/**
+ * Options for creating a cookie.
+ */
 export interface CookieOptions extends CookieProperties {
     /**
-     * A function that decodes the cookie value.
-     *
-     * Defaults to `decodeURIComponent`, which decodes any URL-encoded sequences into their original
-     * characters.
+     * A function that decodes the cookie value. Decodes any URL-encoded sequences into their
+     * original characters.
      *
      * See [RFC 6265](https://tools.ietf.org/html/rfc6265#section-4.1.1) for more details.
+     *
+     * @default decodeURIComponent
      */
     decode?: (value: string) => string;
     /**
-     * A function that encodes the cookie value.
-     *
-     * Defaults to `encodeURIComponent`, which percent-encodes all characters that are not allowed
+     * A function that encodes the cookie value. Percent-encodes all characters that are not allowed
      * in a cookie value.
      *
      * See [RFC 6265](https://tools.ietf.org/html/rfc6265#section-4.1.1) for more details.
+     *
+     * @default encodeURIComponent
      */
     encode?: (value: string) => string;
     /**
@@ -37,8 +40,12 @@ type SameSiteValue = 'Strict' | 'Lax' | 'None';
  * 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 declare class Cookie {
+export declare class Cookie implements CookieProperties {
     #private;
+    /**
+     * @param name The name of the cookie
+     * @param options Options for the cookie
+     */
     constructor(name: string, options?: CookieOptions);
     /**
      * The domain of the cookie.
@@ -56,6 +63,8 @@ export declare class Cookie {
      * True if the cookie is HTTP-only.
      *
      * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#httponly)
+     *
+     * @default false
      */
     get httpOnly(): boolean;
     /**
@@ -72,6 +81,7 @@ export declare class Cookie {
     get 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
      */
@@ -80,31 +90,40 @@ export declare class Cookie {
      * True if the cookie is partitioned.
      *
      * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#partitioned)
+     *
+     * @default false
      */
     get partitioned(): boolean;
     /**
-     * The path of the cookie. Defaults to `/`.
+     * The path of the cookie.
      *
      * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#pathpath-value)
+     *
+     * @default '/'
      */
     get path(): string;
     /**
-     * The `SameSite` attribute of the cookie. Defaults to `Lax`.
+     * The `SameSite` attribute of the cookie.
      *
      * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#samesitesamesite-value)
+     *
+     * @default 'Lax'
      */
     get 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)
+     *
+     * @default false
      */
     get 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
+     * @param props Additional properties to use when serializing the cookie
+     * @returns The `Set-Cookie` header value for this cookie
      */
     serialize(value: string, props?: CookieProperties): Promise<string>;
     /**
@@ -114,9 +133,10 @@ export declare class Cookie {
 }
 /**
  * Creates a new cookie object.
+ *
  * @param name The name of the cookie
- * @param options (optional) Additional options for the cookie
- * @returns A cookie object
+ * @param options Options for the cookie
+ * @returns A new `Cookie` object
  */
 export declare function createCookie(name: string, options?: CookieOptions): Cookie;
 export {};

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,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,KAAK,aAAa,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAA;AAG9C;;;;;;;GAOG;AACH,qBAAa,MAAM;;gBAcL,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAmCjD;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,IAAI,GAAG,SAAS,CAE9B;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;OAIG;IACG,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAa/D;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,aAAa,CAE5B;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;;OAKG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBzE;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;CACF;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM,CAE1E"}
+{"version":3,"file":"cookie.d.ts","sourceRoot":"","sources":["../../src/lib/cookie.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,gBAAgB,EACtB,MAAM,oBAAoB,CAAA;AAI3B;;GAEG;AACH,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,KAAK,aAAa,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAA;AAG9C;;;;;;;GAOG;AACH,qBAAa,MAAO,YAAW,gBAAgB;;IAc7C;;;OAGG;IACH,YAAY,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,EAiChD;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,IAAI,GAAG,SAAS,CAE9B;IAED;;;;;;OAMG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;OAKG;IACG,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAW9D;IAED;;;;;;OAMG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;;;;OAMG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;;OAMG;IACH,IAAI,QAAQ,IAAI,aAAa,CAE5B;IAED;;;;;;OAMG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;;;OAMG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAgBxE;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;CACF;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM,CAE1E"}

package/dist/lib/cookie.js

@@ -21,6 +21,10 @@ export class Cookie {
     #path;
     #sameSite;
     #secure;
+    /**
+     * @param name The name of the cookie
+     * @param options Options for the cookie
+     */
     constructor(name, options) {
         let { decode = decodeURIComponent, encode = encodeURIComponent, secrets = [], domain, expires, httpOnly, maxAge, path = '/', partitioned, secure, sameSite = 'Lax', } = options ?? {};
         if (partitioned === true) {
@@ -61,6 +65,8 @@ export class Cookie {
      * True if the cookie is HTTP-only.
      *
      * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#httponly)
+     *
+     * @default false
      */
     get httpOnly() {
         return this.#httpOnly ?? false;
@@ -83,6 +89,7 @@ export class Cookie {
     }
     /**
      * 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
      */
@@ -102,22 +109,28 @@ export class Cookie {
      * True if the cookie is partitioned.
      *
      * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#partitioned)
+     *
+     * @default false
      */
     get partitioned() {
         return this.#partitioned ?? false;
     }
     /**
-     * The path of the cookie. Defaults to `/`.
+     * The path of the cookie.
      *
      * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#pathpath-value)
+     *
+     * @default '/'
      */
     get path() {
         return this.#path;
     }
     /**
-     * The `SameSite` attribute of the cookie. Defaults to `Lax`.
+     * The `SameSite` attribute of the cookie.
      *
      * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#samesitesamesite-value)
+     *
+     * @default 'Lax'
      */
     get sameSite() {
         return this.#sameSite;
@@ -126,15 +139,18 @@ export class Cookie {
      * 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)
+     *
+     * @default false
      */
     get secure() {
         return this.#secure ?? false;
     }
     /**
      * 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
+     * @param props Additional properties to use when serializing the cookie
+     * @returns The `Set-Cookie` header value for this cookie
      */
     async serialize(value, props) {
         let header = new SetCookieHeader({
@@ -161,9 +177,10 @@ export class Cookie {
 }
 /**
  * Creates a new cookie object.
+ *
  * @param name The name of the cookie
- * @param options (optional) Additional options for the cookie
- * @returns A cookie object
+ * @param options Options for the cookie
+ * @returns A new `Cookie` object
  */
 export function createCookie(name, options) {
     return new Cookie(name, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/cookie",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "A toolkit for working with cookies in JavaScript",
   "author": "Michael Jackson <mjijackson@gmail.com>",
   "license": "MIT",
@@ -26,10 +26,11 @@
     "./package.json": "./package.json"
   },
   "devDependencies": {
-    "@types/node": "^24.6.0"
+    "@types/node": "^24.6.0",
+    "@typescript/native-preview": "7.0.0-dev.20251125.1"
   },
-  "peerDependencies": {
-    "@remix-run/headers": "^0.17.1"
+  "dependencies": {
+    "@remix-run/headers": "^0.19.0"
   },
   "keywords": [
     "http",
@@ -39,9 +40,9 @@
     "set-cookie"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.build.json",
+    "build": "tsgo -p tsconfig.build.json",
     "clean": "git clean -fdX",
-    "test": "node --disable-warning=ExperimentalWarning --test './src/**/*.test.ts'",
-    "typecheck": "tsc --noEmit"
+    "test": "node --disable-warning=ExperimentalWarning --test",
+    "typecheck": "tsgo --noEmit"
   }
 }

package/src/lib/cookie-signing.ts

@@ -34,7 +34,7 @@ export async function unsign(cookie: string, secret: string): Promise<string | f
   }
 }
 
-async function createKey(secret: string, usages: CryptoKey['usages']): Promise<CryptoKey> {
+function createKey(secret: string, usages: CryptoKey['usages']): Promise<CryptoKey> {
   return crypto.subtle.importKey(
     'raw',
     encoder.encode(secret),

package/src/lib/cookie.ts

@@ -6,23 +6,26 @@ import {
 
 import { sign, unsign } from './cookie-signing.ts'
 
+/**
+ * Options for creating a cookie.
+ */
 export interface CookieOptions extends CookieProperties {
   /**
-   * A function that decodes the cookie value.
-   *
-   * Defaults to `decodeURIComponent`, which decodes any URL-encoded sequences into their original
-   * characters.
+   * A function that decodes the cookie value. Decodes any URL-encoded sequences into their
+   * original characters.
    *
    * See [RFC 6265](https://tools.ietf.org/html/rfc6265#section-4.1.1) for more details.
+   *
+   * @default decodeURIComponent
    */
   decode?: (value: string) => string
   /**
-   * A function that encodes the cookie value.
-   *
-   * Defaults to `encodeURIComponent`, which percent-encodes all characters that are not allowed
+   * A function that encodes the cookie value. Percent-encodes all characters that are not allowed
    * in a cookie value.
    *
    * See [RFC 6265](https://tools.ietf.org/html/rfc6265#section-4.1.1) for more details.
+   *
+   * @default encodeURIComponent
    */
   encode?: (value: string) => string
   /**
@@ -47,7 +50,7 @@ type Coder = (value: string) => string
  * 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 class Cookie {
+export class Cookie implements CookieProperties {
   #name: string
   #decode: Coder
   #encode: Coder
@@ -61,6 +64,10 @@ export class Cookie {
   #sameSite: SameSiteValue
   #secure: boolean | undefined
 
+  /**
+   * @param name The name of the cookie
+   * @param options Options for the cookie
+   */
   constructor(name: string, options?: CookieOptions) {
     let {
       decode = decodeURIComponent,
@@ -118,6 +125,8 @@ export class Cookie {
    * True if the cookie is HTTP-only.
    *
    * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#httponly)
+   *
+   * @default false
    */
   get httpOnly(): boolean {
     return this.#httpOnly ?? false
@@ -143,6 +152,7 @@ export class Cookie {
 
   /**
    * 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
    */
@@ -163,24 +173,30 @@ export class Cookie {
    * True if the cookie is partitioned.
    *
    * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#partitioned)
+   *
+   * @default false
    */
   get partitioned(): boolean {
     return this.#partitioned ?? false
   }
 
   /**
-   * The path of the cookie. Defaults to `/`.
+   * The path of the cookie.
    *
    * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#pathpath-value)
+   *
+   * @default '/'
    */
   get path(): string {
     return this.#path
   }
 
   /**
-   * The `SameSite` attribute of the cookie. Defaults to `Lax`.
+   * The `SameSite` attribute of the cookie.
    *
    * [MDN Reference](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Set-Cookie#samesitesamesite-value)
+   *
+   * @default 'Lax'
    */
   get sameSite(): SameSiteValue {
     return this.#sameSite
@@ -190,6 +206,8 @@ export class Cookie {
    * 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)
+   *
+   * @default false
    */
   get secure(): boolean {
     return this.#secure ?? false
@@ -197,9 +215,10 @@ export class Cookie {
 
   /**
    * 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
+   * @param props Additional properties to use when serializing the cookie
+   * @returns The `Set-Cookie` header value for this cookie
    */
   async serialize(value: string, props?: CookieProperties): Promise<string> {
     let header = new SetCookieHeader({
@@ -229,9 +248,10 @@ export class Cookie {
 
 /**
  * Creates a new cookie object.
+ *
  * @param name The name of the cookie
- * @param options (optional) Additional options for the cookie
- * @returns A cookie object
+ * @param options Options for the cookie
+ * @returns A new `Cookie` object
  */
 export function createCookie(name: string, options?: CookieOptions): Cookie {
   return new Cookie(name, options)