add setCookieLocale

Author: kazupon

bun.lockb

@@ -59,11 +59,13 @@
   },
   "devDependencies": {
     "@types/node": "^20.6.0",
+    "@types/supertest": "^2.0.12",
     "@vitest/coverage-v8": "^0.34.4",
     "bumpp": "^9.2.0",
     "gh-changelogen": "^0.2.8",
     "h3": "^1.8.1",
     "lint-staged": "^14.0.0",
+    "supertest": "^6.3.3",
     "typescript": "^5.2.2",
     "unbuild": "^2.0.0",
     "vitest": "^0.34.4"

package.json

@@ -1,5 +1,5 @@
-import { getCookie, getHeaders } from 'h3'
-import { parseAcceptLanguage } from './utils.ts'
+import { getCookie, getHeaders, setCookie } from 'h3'
+import { isLocale, parseAcceptLanguage, validateLanguageTag } from './utils.ts'
 
 import type { H3Event } from 'h3'
 
@@ -50,3 +50,24 @@ export function getCookieLocale(
 ): Intl.Locale {
   return new Intl.Locale(getCookie(event, name) || lang)
 }
+
+/**
+ * @param {H3Event} event The {@link H3Event | H3} event
+ * @param {string | Intl.Locale} locale The locale value
+ * @param options.name The cookie name, default is `i18n_locale`
+ *
+ * @throws {SyntaxError} Throws a {@link SyntaxError} if `locale` is invalid.
+ */
+export function setCookieLocale(
+  event: H3Event,
+  locale: string | Intl.Locale,
+  { name = 'i18n_locale' } = {},
+): void {
+  if (
+    !(isLocale(locale) ||
+      typeof locale === 'string' && validateLanguageTag(locale))
+  ) {
+    throw new SyntaxError(`locale is invalid: ${locale.toString()}`)
+  }
+  setCookie(event, name, locale.toString())
+}

src/index.ts

@@ -1,7 +1,15 @@
-import { describe, expect, test } from 'vitest'
-import { getAcceptLanguages, getCookieLocale, getLocale } from '../src/index.ts'
+import { beforeEach, describe, expect, test } from 'vitest'
+import { createApp, eventHandler, toNodeListener } from 'h3'
+import supertest from 'supertest'
+import {
+  getAcceptLanguages,
+  getCookieLocale,
+  getLocale,
+  setCookieLocale,
+} from '../src/index.ts'
 
-import type { H3Event } from 'h3'
+import type { App, H3Event } from 'h3'
+import type { SuperTest, Test } from 'supertest'
 
 describe('getAcceptLanguages', () => {
   test('basic', () => {
@@ -191,3 +199,70 @@ describe('getCookieLocale', () => {
       .toThrowError(RangeError)
   })
 })
+
+describe('setCookieLocale', () => {
+  let app: App
+  let request: SuperTest<Test>
+
+  beforeEach(() => {
+    app = createApp({ debug: false })
+    request = supertest(toNodeListener(app))
+  })
+
+  test('specify Locale instance', async () => {
+    app.use(
+      '/',
+      eventHandler((event) => {
+        const locale = new Intl.Locale('ja-JP')
+        setCookieLocale(event, locale)
+        return '200'
+      }),
+    )
+    const result = await request.get('/')
+    expect(result.headers['set-cookie']).toEqual([
+      'i18n_locale=ja-JP; Path=/',
+    ])
+  })
+
+  test('specify language tag', async () => {
+    app.use(
+      '/',
+      eventHandler((event) => {
+        setCookieLocale(event, 'ja-JP')
+        return '200'
+      }),
+    )
+    const result = await request.get('/')
+    expect(result.headers['set-cookie']).toEqual([
+      'i18n_locale=ja-JP; Path=/',
+    ])
+  })
+
+  test('specify cookie name', async () => {
+    app.use(
+      '/',
+      eventHandler((event) => {
+        setCookieLocale(event, 'ja-JP', { name: 'intlify_locale' })
+        return '200'
+      }),
+    )
+    const result = await request.get('/')
+    expect(result.headers['set-cookie']).toEqual([
+      'intlify_locale=ja-JP; Path=/',
+    ])
+  })
+
+  test('Syntax Error', () => {
+    const eventMock = {
+      node: {
+        req: {
+          method: 'GET',
+          headers: {},
+        },
+      },
+    } as H3Event
+
+    expect(() => setCookieLocale(eventMock, 'j'))
+      .toThrowError(/locale is invalid: j/)
+  })
+})