@zerotal/i18n 1.6.3 → 1.7.0

package/api-surface.md

@@ -0,0 +1,100 @@
+# @zerotal/i18n — public API surface
+
+<!-- AUTO-GENERATED by scripts/api-surface.ts. Do not edit by hand.
+     Run `bun run api:surface` to regenerate after an intentional API change. -->
+
+## .  `(./src/index.ts)`
+
+class CatalogLoadError = {
+  new (file: string, cause: unknown): CatalogLoadError
+  readonly code: string
+  readonly context?: Record<string, unknown> | undefined
+  readonly status: number
+}
+
+class I18nContext = {
+  new (): I18nContext
+  static current: () => string | undefined
+  static run: <T>(locale: string, callback: () => T) => T
+}
+
+class I18nError = {
+  new (message: string, code?: string, status?: number, context?: Record<string, unknown>): I18nError
+  readonly code: string
+  readonly context?: Record<string, unknown> | undefined
+  readonly status: number
+}
+
+class I18nProvider = {
+  new (app: Application): I18nProvider
+  static dependsOn?: (new (app: Application) => ServiceProvider)[]
+  static environments: AppEnvironment[]
+  static priority?: number
+  static provides: readonly ['i18n']
+  devProcesses: () => DevProcessDefinition[]
+  doctorChecks: () => DoctorCheck[]
+  onBooted: () => Promise<void>
+  onBooting: () => Promise<void>
+  onRegister: () => void
+  onRequestProcessed: (_ctx: HttpContext) => Promise<void>
+  onRequestReceived: (_ctx: HttpContext) => Promise<void>
+  onResponseSent: (_ctx: HttpContext) => Promise<void>
+  onStarted: () => Promise<void>
+  onStarting: () => Promise<void>
+  onStopped: () => Promise<void>
+  onStopping: () => Promise<void>
+  replContext: () => Record<string, unknown>
+}
+
+class LocaleMiddleware = {
+  new (): LocaleMiddleware
+  static configure: (translator: Translator, config: I18nConfigShape) => void
+  handle: (http: HttpContext, next: NextFn) => Promise<Response | void>
+}
+
+class Translator = {
+  new (opts: TranslatorOptions): Translator
+  addCatalog: (locale: string, messages: Messages) => void
+  has: (key: string, locale?: string) => boolean
+  locales: string[]
+  readonly defaultLocale: string
+  readonly fallbackLocale: string
+  translate: (key: string, replacements?: Replacements, locale?: string) => string
+}
+
+const Lang = Translator
+
+function I18nConfig = (options?: Partial<I18nConfigShape>) => I18nConfigShape
+
+function loadCatalogs = (dir: string) => Promise<Catalogs>
+
+function parseAcceptLanguage = (header: string | null) => string[]
+
+function resolveLocale = (request: Request, config: I18nConfigShape) => string
+
+function t = (key: string, replacements?: Replacements, locale?: string) => string
+
+interface I18nConfigShape = {
+  catalogs?: Catalogs
+  cookieKey: string
+  defaultLocale: string
+  fallbackLocale: string
+  loadPath?: string
+  queryKey: string
+  resolvers: LocaleResolver[]
+  supportedLocales: string[]
+}
+
+interface TranslatorOptions = {
+  catalogs: Catalogs
+  defaultLocale: string
+  fallbackLocale: string
+}
+
+type Catalogs = {    [x: string]: Messages;}
+
+type LocaleResolver = 'query' | 'cookie' | 'accept-header'
+
+type Messages = {    [key: string]: string | Messages;}
+
+type Replacements = {    [x: string]: string | number;}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zerotal/i18n",
-  "version": "1.6.3",
+  "version": "1.7.0",
   "license": "MIT",
   "maturity": "stable",
   "private": false,
@@ -12,6 +12,7 @@
   },
   "files": [
     "CHANGELOG.md",
+    "api-surface.md",
     "src",
     "!src/**/*.test.ts",
     "!src/**/*.test.tsx",
@@ -32,7 +33,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@zerotal/core": "1.6.3"
+    "@zerotal/core": "1.7.0"
   },
   "devDependencies": {
     "typescript": "^5.8.0"