feat(cookie): generateCookie and generateSignedCookie helpers (#4285)

* generateCookie

* generateSignedCookie

* removed context arg from generators

* tests

* removed lines

Author: Soviut

src/helper/cookie/index.test.ts

@@ -1,5 +1,13 @@
 import { Hono } from '../../hono'
-import { deleteCookie, getCookie, getSignedCookie, setCookie, setSignedCookie } from '.'
+import {
+  deleteCookie,
+  getCookie,
+  getSignedCookie,
+  setCookie,
+  setSignedCookie,
+  generateCookie,
+  generateSignedCookie,
+} from '.'
 
 describe('Cookie Middleware', () => {
   describe('Parse cookie', () => {
@@ -445,4 +453,49 @@ describe('Cookie Middleware', () => {
       expect(await res.text()).toBe('choco')
     })
   })
+
+  describe('Generate cookie', () => {
+    it('should generate a cookie', () => {
+      const cookie = generateCookie('delicious_cookie', 'macha')
+      expect(cookie).toBe('delicious_cookie=macha; Path=/')
+    })
+
+    it('should generate a cookie with options', () => {
+      const cookie = generateCookie('delicious_cookie', 'macha', {
+        path: '/',
+        secure: true,
+        httpOnly: true,
+        domain: 'example.com',
+      })
+      expect(cookie).toBe('delicious_cookie=macha; Domain=example.com; Path=/; HttpOnly; Secure')
+    })
+
+    it('should generate a signed cookie', async () => {
+      const cookie = await generateSignedCookie(
+        'delicious_cookie',
+        'macha',
+        'secret chocolate chips'
+      )
+      expect(cookie).toBe(
+        'delicious_cookie=macha.diubJPY8O7hI1pLa42QSfkPiyDWQ0I4DnlACH%2FN2HaA%3D; Path=/'
+      )
+    })
+
+    it('should generate a signed cookie with options', async () => {
+      const cookie = await generateSignedCookie(
+        'delicious_cookie',
+        'macha',
+        'secret chocolate chips',
+        {
+          path: '/',
+          secure: true,
+          httpOnly: true,
+          domain: 'example.com',
+        }
+      )
+      expect(cookie).toBe(
+        'delicious_cookie=macha.diubJPY8O7hI1pLa42QSfkPiyDWQ0I4DnlACH%2FN2HaA%3D; Domain=example.com; Path=/; HttpOnly; Secure'
+      )
+    })
+  })
 })

src/helper/cookie/index.ts

@@ -75,7 +75,7 @@ export const getSignedCookie: GetSignedCookie = async (
   return obj as any
 }
 
-export const setCookie = (c: Context, name: string, value: string, opt?: CookieOptions): void => {
+export const generateCookie = (name: string, value: string, opt?: CookieOptions): string => {
   // Cookie names prefixed with __Secure- can be used only if they are set with the secure attribute.
   // Cookie names prefixed with __Host- can be used only if they are set with the secure attribute, must have a path of / (meaning any path at the host)
   // and must not have a Domain attribute.
@@ -93,16 +93,20 @@ export const setCookie = (c: Context, name: string, value: string, opt?: CookieO
   } else {
     cookie = serialize(name, value, { path: '/', ...opt })
   }
+  return cookie
+}
+
+export const setCookie = (c: Context, name: string, value: string, opt?: CookieOptions): void => {
+  const cookie = generateCookie(name, value, opt)
   c.header('Set-Cookie', cookie, { append: true })
 }
 
-export const setSignedCookie = async (
-  c: Context,
+export const generateSignedCookie = async (
   name: string,
   value: string,
   secret: string | BufferSource,
   opt?: CookieOptions
-): Promise<void> => {
+): Promise<string> => {
   let cookie
   if (opt?.prefix === 'secure') {
     cookie = await serializeSigned('__Secure-' + name, value, secret, {
@@ -120,6 +124,17 @@ export const setSignedCookie = async (
   } else {
     cookie = await serializeSigned(name, value, secret, { path: '/', ...opt })
   }
+  return cookie
+}
+
+export const setSignedCookie = async (
+  c: Context,
+  name: string,
+  value: string,
+  secret: string | BufferSource,
+  opt?: CookieOptions
+): Promise<void> => {
+  const cookie = await generateSignedCookie(name, value, secret, opt)
   c.header('set-cookie', cookie, { append: true })
 }