@edgekits/astro-i18n 0.1.8 → 0.2.0

package/src/format.ts

@@ -1,107 +1,3 @@
-// Sanitizer: Turns <script> into &lt;script&gt;
-function escapeHtml(unsafe: string | number): string {
-  return String(unsafe)
-    .replace(/&/g, '&amp;')
-    .replace(/</g, '&lt;')
-    .replace(/>/g, '&gt;')
-    .replace(/"/g, '&quot;')
-    .replace(/'/g, '&#039;')
-}
-
-type TemplateValues = Record<string, string | number>
-
-// `./format` is a Node-safe entry: under plain Node (a project's unit tests, `astro sync`)
-// there is no `import.meta.env`, and a missing one counts as "not production", so the
-// dev warnings below still fire instead of throwing.
-function isProd(): boolean {
-  return import.meta.env?.PROD === true
-}
-
-/**
- * Interpolates {placeholders} in a template string and escapes values.
- * - If `template` is undefined/null, returns an empty string (and logs in dev).
- * - If `values` is undefined, returns the template unchanged.
- */
-export function fmt(template: string | null | undefined, values?: TemplateValues): string {
-  if (template == null) {
-    if (!isProd()) {
-      console.warn('[i18n] fmt() called with null/undefined template')
-    }
-    return ''
-  }
-
-  if (!values) return template
-
-  return template.replace(/{([^}]+)}/g, (match, key) => {
-    const replacement = values[key]
-
-    if (replacement === undefined || replacement === null) {
-      return match
-    }
-
-    return escapeHtml(replacement)
-  })
-}
-
-/**
- * Simple two-form plural helper.
- * Good for English-like languages where "1" vs "other" is enough.
- */
-export function plural(count: number, singular: string, plural: string): string {
-  return count === 1 ? singular : fmt(plural, { count })
-}
-
-/**
- * ICU-style plural categories used by Intl.PluralRules.
- */
-export type PluralCategory = 'zero' | 'one' | 'two' | 'few' | 'many' | 'other'
-
-export type PluralPatterns = Partial<Record<PluralCategory, string>>
-
-/**
- * Advanced plural helper using Intl.PluralRules + fmt().
- *
- * - `locale` controls plural categories (en, de, es, ja, ...).
- * - `patterns` comes from KV (e.g. { zero, one, other }).
- * - Missing categories fall back to `other`.
- *
- * Example:
- *   pluralIcu(5, 'en', {
- *     zero: 'No items',
- *     one: '{count} item',
- *     other: '{count} items'
- *   })
- */
-export function pluralIcu(count: number, locale: string, patterns: PluralPatterns): string {
-  const rules = new Intl.PluralRules(locale)
-  const cat = rules.select(count) as PluralCategory
-
-  const template =
-    patterns[cat] ??
-    patterns.other ??
-    (isProd() ? '' : (console.warn('[i18n] pluralIcu(): missing "other" pattern'), ''))
-
-  return fmt(template, { count })
-}
-
-// Used in the LanguageSwitcher and SeoHreflangs components
-export function replaceLocaleInPath(currentPath: string, currentLocale: string, newLocale: string): string {
-  const prefixRegex = new RegExp(`^/${currentLocale}/`)
-  return currentPath.replace(prefixRegex, `/${newLocale}/`)
-}
-
-// Used in the LanguageSwitcher component
-export function getLangFromUrl(pathname: string) {
-  // Remove leading/trailing slashes: '/en/about/' -> 'en/about'
-  const cleaned = pathname.replace(/^\/+|\/+$/g, '')
-  const [lang] = cleaned.split('/')
-  return lang
-}
-
-// Converts a URL locale code to an IETF BCP 47 language tag.
-// Used for the HTML lang attribute and hreflang values.
-// 'pt-br' → 'pt-BR', 'en-us' → 'en-US', 'en' → 'en'
-export function toIetfTag(locale: string): string {
-  const [lang, region] = locale.split('-')
-  return region ? `${lang}-${region.toUpperCase()}` : locale
-}
+// The `./format` entry: the core's formatting helpers. Node-safe, like the core's
+// `./format` it re-exports (`test/node-safe-entries.test.ts`).
+export * from '@edgekits/i18n-core/format'

package/src/instance.ts

@@ -0,0 +1,44 @@
+import { env, waitUntil } from 'cloudflare:workers'
+import * as fallbacksModule from 'virtual:@edgekits/astro-i18n/fallbacks'
+import * as runtimeConstants from 'virtual:@edgekits/astro-i18n/runtime-constants'
+import { createI18n, parseBooleanFlag, type Bindings, type EdgeCache, type I18nBindings } from '@edgekits/i18n-core'
+
+import { I18N_CONFIG } from './config'
+
+// The bindings this module reads, typed by the package rather than the project's Env.
+const i18nEnv = env as unknown as I18nBindings
+
+/**
+ * The platform as the core reads it. Getters: in Astro on Workers, `env` is valid only
+ * inside a request, and the core reads each property at call time.
+ *
+ * Wrangler vars (wrangler.jsonc / wrangler.toml or .dev.vars; then `wrangler types` if
+ * the project generates its Env), each "on" | "off" | "true" | "false" | "1" | "0":
+ *   I18N_CACHE: the edge cache, on by default;
+ *   DEBUG_I18N: the fetcher's debug log, off by default.
+ */
+const bindings: Bindings = {
+  get kv() {
+    return i18nEnv.TRANSLATIONS
+  },
+  get cache() {
+    // `caches.default` only: absent (an untrusted Workers for Platforms namespace), the
+    // core reads KV directly.
+    const cacheStorage = caches as { default?: EdgeCache }
+    return cacheStorage?.default ?? null
+  },
+  // Top-level waitUntil (cloudflare:workers): same semantics as ctx.waitUntil.
+  waitUntil: (promise) => waitUntil(promise),
+  get cacheEnabled() {
+    return parseBooleanFlag(i18nEnv.I18N_CACHE, /* defaultValue */ true)
+  },
+  get debug() {
+    return parseBooleanFlag(i18nEnv.DEBUG_I18N, /* defaultValue */ false)
+  },
+}
+
+/**
+ * The one engine instance of the project: the core's `createI18n` over the virtual config,
+ * the generated modules (or the Vite plugin's stubs) and the Worker bindings.
+ */
+export const i18n = createI18n(I18N_CONFIG, { fallbacks: fallbacksModule, runtimeConstants }, bindings)

package/src/integration/index.ts

@@ -1,6 +1,6 @@
 import type { AstroConfig, AstroIntegration } from 'astro'
+import { DEFAULT_GENERATED_DIR, defineI18nConfig, type I18nConfig, type I18nRouting } from '@edgekits/i18n-core'
 
-import { DEFAULT_GENERATED_DIR, defineI18nConfig, type I18nConfig } from '../types.ts'
 import { i18nVitePlugin } from './vite-plugin.ts'
 import { virtualModulesDeclaration } from './virtual-types.ts'
 
@@ -20,7 +20,7 @@ export const PACKAGE_NAME = '@edgekits/astro-i18n'
  * plugin's virtual modules.
  */
 export function edgekitsI18n(config: I18nConfig, options: EdgekitsI18nOptions = {}): AstroIntegration {
-  const i18nConfig = defineI18nConfig(config)
+  const i18nConfig = resolveConfig(config)
   const middleware = options.middleware ?? 'auto'
 
   if (!MIDDLEWARE_MODES.includes(middleware)) {
@@ -66,8 +66,19 @@ export function edgekitsI18n(config: I18nConfig, options: EdgekitsI18nOptions =
   }
 }
 
-// Each entry that exports `I18nLocales` from its own declaration: the root entry's comes
-// from dist/types.d.ts, the runtime entry's from the shipped source (src/types.ts).
+/**
+ * The validated config with `routing` resolved: absent means 'prefix-except-default', the
+ * mode for new projects. Resolved here, before the Vite plugin serialises it, so the
+ * virtual config (and `I18N_CONFIG`) always carries the mode the middleware runs.
+ */
+export function resolveConfig(config: I18nConfig): I18nConfig & { routing: I18nRouting } {
+  const validated = defineI18nConfig(config)
+  return { ...validated, routing: validated.routing ?? 'prefix-except-default' }
+}
+
+// Each entry that exports `I18nLocales`: both re-export the core's interface (root through
+// dist/types.d.ts, runtime through the shipped src/types.ts), so either augmentation
+// merges into it; both are kept so neither entry depends on how the other resolves.
 const LOCALE_MODULES = ['@edgekits/astro-i18n', '@edgekits/astro-i18n/runtime']
 
 /**
@@ -95,9 +106,16 @@ export function localesDeclaration(locales: readonly string[]): string {
 
 /**
  * The Astro `i18n` block set when the project has none: locales and default from the
- * config; every URL locale-prefixed (the middleware redirects `/` itself, so Astro
- * does not). Complete, `fallbackType` included: Astro does not re-validate what
- * `updateConfig` merges, so its schema defaults never fill a partial block.
+ * config; routed as locale-prefixed in both modes (the middleware redirects `/` itself in
+ * 'prefix', so Astro does not). Complete, `fallbackType` included: Astro does not
+ * re-validate what `updateConfig` merges, so its schema defaults never fill a partial block.
+ *
+ * `prefixDefaultLocale: true` in 'prefix-except-default' too: Astro's own i18n check runs
+ * after the middleware, on the rewritten URL (astro/dist/core/routing/handler.js:128-130),
+ * and with `prefixDefaultLocale: false` the strategy `pathname-prefix-other-locales`
+ * answers notFound to any path carrying the default locale (astro/dist/i18n/router.js:
+ * 104-121) — the rewritten `/<default>/about/` is exactly that. With `true` the check
+ * passes and `Astro.currentLocale` works on root pages.
  */
 export function astroI18n(config: I18nConfig): NonNullable<AstroConfig['i18n']> {
   return {
@@ -109,9 +127,10 @@ export function astroI18n(config: I18nConfig): NonNullable<AstroConfig['i18n']>
 
 /**
  * A project's own Astro `i18n` block must cover every configured locale (as a string
- * entry, a `path` or one of its `codes`) and share the default locale.
+ * entry, a `path` or one of its `codes`), share the default locale, and route as
+ * `astroI18n` does (`prefixDefaultLocale: true`, `redirectToDefaultLocale: false`).
  */
-function assertAstroI18n(block: NonNullable<AstroConfig['i18n']>, config: I18nConfig): void {
+export function assertAstroI18n(block: NonNullable<AstroConfig['i18n']>, config: I18nConfig): void {
   const declared = new Set(
     block.locales.flatMap((entry) => (typeof entry === 'string' ? [entry] : [entry.path, ...entry.codes])),
   )
@@ -129,6 +148,16 @@ function assertAstroI18n(block: NonNullable<AstroConfig['i18n']>, config: I18nCo
         'Make them equal, or remove the `i18n` block from astro.config and the integration sets it for you.',
     )
   }
+  // Absent values are Astro's schema defaults (both false): `redirectToDefaultLocale` left
+  // out is fine, `prefixDefaultLocale` left out is not.
+  const routing = typeof block.routing === 'object' ? block.routing : undefined
+  if (routing?.prefixDefaultLocale !== true || routing.redirectToDefaultLocale === true) {
+    throw new Error(
+      '[@edgekits/astro-i18n] Astro `i18n.routing` must set `prefixDefaultLocale: true` and `redirectToDefaultLocale: false` ' +
+        `(found ${JSON.stringify(block.routing)}): the middleware handles the default locale itself, and Astro's ` +
+        'own check would otherwise answer 404 or redirect the pages it serves. Set them, or remove the `i18n` block from astro.config and the integration sets it for you.',
+    )
+  }
 }
 
 function trimSlashes(path: string): string {

package/src/integration/vite-plugin.ts

@@ -2,7 +2,7 @@ import { existsSync } from 'node:fs'
 import { fileURLToPath } from 'node:url'
 import type { AstroConfig } from 'astro'
 
-import type { I18nConfig } from '../types.ts'
+import type { I18nConfig } from '@edgekits/i18n-core'
 
 type VitePlugin = NonNullable<NonNullable<AstroConfig['vite']>['plugins']>[number]