@remix-run/cookie 0.2.0 → 0.3.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.
 

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { type CookieOptions, Cookie } from './lib/cookie.ts';
+export { createCookie, type CookieOptions, Cookie } 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,YAAY,EAAE,KAAK,aAAa,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA"}

package/dist/index.js

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

package/dist/lib/cookie.d.ts

@@ -1,5 +1,12 @@
 import { type CookieProperties } from '@remix-run/headers';
-export interface CookieOptions {
+/**
+ * Creates a new `Cookie` object.
+ * @param name The name of the cookie
+ * @param options The options for the cookie
+ * @returns A new cookie instance
+ */
+export declare function createCookie(name: string, options?: CookieOptions): Cookie;
+export interface CookieOptions extends CookieProperties {
     /**
      * A function that decodes the cookie value.
      *
@@ -34,12 +41,15 @@ export interface CookieOptions {
  */
 export declare class Cookie {
     #private;
-    readonly name: string;
     constructor(name: string, options?: CookieOptions);
+    /**
+     * The name of the cookie.
+     */
+    readonly name: string;
     /**
      * True if this cookie uses one or more secrets for verification.
      */
-    get isSigned(): boolean;
+    get signed(): boolean;
     /**
      * Extracts the value of this cookie from a `Cookie` header value.
      * @param headerValue The value of the `Cookie` header to parse

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;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM,CAE1E;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;;;GAGG;AACH,qBAAa,MAAM;;gBACL,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAejD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAOrB;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;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;CAa1E"}

package/dist/lib/cookie.js

@@ -1,24 +1,39 @@
 import { Cookie as CookieHeader, SetCookie as SetCookieHeader, } from '@remix-run/headers';
 import { sign, unsign } from "./crypto.js";
+/**
+ * Creates a new `Cookie` object.
+ * @param name The name of the cookie
+ * @param options The options for the cookie
+ * @returns A new cookie instance
+ */
+export function createCookie(name, options) {
+    return new Cookie(name, options);
+}
 /**
  * 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.
  */
 export class Cookie {
+    constructor(name, options) {
+        let { decode = decodeURIComponent, encode = encodeURIComponent, secrets = [], ...props } = options ?? {};
+        this.name = name;
+        this.#decode = decode;
+        this.#encode = encode;
+        this.#secrets = secrets;
+        this.#props = props;
+    }
+    /**
+     * The name of the cookie.
+     */
     name;
     #decode;
     #encode;
     #secrets;
-    constructor(name, options) {
-        this.name = name;
-        this.#decode = options?.decode;
-        this.#encode = options?.encode;
-        this.#secrets = options?.secrets ?? [];
-    }
+    #props;
     /**
      * True if this cookie uses one or more secrets for verification.
      */
-    get isSigned() {
+    get signed() {
         return this.#secrets.length > 0;
     }
     /**
@@ -51,22 +66,13 @@ export class Cookie {
             // sane defaults
             path: '/',
             sameSite: 'Lax',
+            ...this.#props,
             ...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;
-}
-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 +121,16 @@ 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.3.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 { createCookie, type CookieOptions, Cookie } from './lib/cookie.ts'

package/src/lib/cookie.ts

@@ -6,7 +6,17 @@ import {
 
 import { sign, unsign } from './crypto.ts'
 
-export interface CookieOptions {
+/**
+ * Creates a new `Cookie` object.
+ * @param name The name of the cookie
+ * @param options The options for the cookie
+ * @returns A new cookie instance
+ */
+export function createCookie(name: string, options?: CookieOptions): Cookie {
+  return new Cookie(name, options)
+}
+
+export interface CookieOptions extends CookieProperties {
   /**
    * A function that decodes the cookie value.
    *
@@ -41,22 +51,35 @@ export interface CookieOptions {
  * to sign/unsign the value of the cookie to ensure it's not tampered with.
  */
 export class Cookie {
-  readonly name: string
-  readonly #decode?: (value: string) => string
-  readonly #encode?: (value: string) => string
-  readonly #secrets: string[]
-
   constructor(name: string, options?: CookieOptions) {
+    let {
+      decode = decodeURIComponent,
+      encode = encodeURIComponent,
+      secrets = [],
+      ...props
+    } = options ?? {}
+
     this.name = name
-    this.#decode = options?.decode
-    this.#encode = options?.encode
-    this.#secrets = options?.secrets ?? []
+    this.#decode = decode
+    this.#encode = encode
+    this.#secrets = secrets
+    this.#props = props
   }
 
+  /**
+   * The name of the cookie.
+   */
+  readonly name: string
+
+  readonly #decode: (value: string) => string
+  readonly #encode: (value: string) => string
+  readonly #secrets: string[]
+  readonly #props: CookieProperties
+
   /**
    * True if this cookie uses one or more secrets for verification.
    */
-  get isSigned(): boolean {
+  get signed(): boolean {
     return this.#secrets.length > 0
   }
 
@@ -91,6 +114,7 @@ export class Cookie {
       // sane defaults
       path: '/',
       sameSite: 'Lax',
+      ...this.#props,
       ...props,
     })
 
@@ -98,28 +122,10 @@ export class Cookie {
   }
 }
 
-async function encodeCookieValue(
-  value: string,
-  secrets: string[],
-  encode: (value: string) => string = encodeURIComponent,
-): Promise<string> {
-  let encoded = encodeValue(value, encode)
-
-  if (secrets.length > 0) {
-    encoded = await sign(encoded, secrets[0])
-  }
-
-  return encoded
-}
-
-function encodeValue(value: string, encode: (value: string) => string): string {
-  return btoa(myUnescape(encode(value)))
-}
-
 async function decodeCookieValue(
   value: string,
   secrets: string[],
-  decode: (value: string) => string = decodeURIComponent,
+  decode: (value: string) => string,
 ): Promise<string | null> {
   if (secrets.length > 0) {
     for (let secret of secrets) {
@@ -171,6 +177,24 @@ function hex(code: number, length: number): string {
   return result
 }
 
+async function encodeCookieValue(
+  value: string,
+  secrets: string[],
+  encode: (value: string) => string,
+): Promise<string> {
+  let encoded = encodeValue(value, encode)
+
+  if (secrets.length > 0) {
+    encoded = await sign(encoded, secrets[0])
+  }
+
+  return encoded
+}
+
+function encodeValue(value: string, encode: (value: string) => string): 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/src/lib/crypto.ts

@@ -40,7 +40,7 @@ async function createKey(secret: string, usages: CryptoKey['usages']): Promise<C
   )
 }
 
-function byteStringToUint8Array(byteString: string): Uint8Array {
+function byteStringToUint8Array(byteString: string): Uint8Array<ArrayBuffer> {
   let array = new Uint8Array(byteString.length)
 
   for (let i = 0; i < byteString.length; i++) {