@terrafirmagreg-team/translate 0.1.0 → 1.2.1

package/package.json

@@ -1,26 +1,34 @@
 {
   "name": "@terrafirmagreg-team/translate",
-  "version": "0.1.0",
+  "version": "1.2.1",
   "type": "module",
+  "description": "Localization runtime and catalogs",
+  "license": "LGPL-3.0-only",
   "exports": {
-    ".": "./src/runtime.tsx",
-    "./provider": "./src/provider.tsx",
+    ".": "./src/components/runtime.tsx",
+    "./provider": "./src/components/provider.tsx",
     "./lang": "./src/lang.ts",
     "./create": "./src/create.ts",
     "./config": "./src/config.ts",
     "./server": "./src/server.ts",
     "./hooks": "./src/hooks/index.ts",
-    "./hooks/*": "./src/hooks/*.ts",
-    "./lib/*": "./src/lib/*.ts",
+    "./hooks/*": [
+      "./src/hooks/*.ts",
+      "./src/hooks/*/index.ts"
+    ],
+    "./lib/*": [
+      "./src/lib/*.ts",
+      "./src/lib/*/index.ts"
+    ],
     "./types/*": "./src/types/*.ts",
-    "./package.json": "./package.json",
-    "./runtime": "./src/runtime.tsx"
+    "./runtime": "./src/components/runtime.tsx"
   },
   "files": [
-    "src",
-    "styles",
-    "styles.css"
+    "src"
   ],
+  "dependencies": {
+    "@fuma-translate/react": "1.0.2"
+  },
   "peerDependencies": {
     "react": ">=19"
   },
@@ -36,6 +44,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "scripts": {}
+  }
 }

package/src/{provider.tsx → components/provider.tsx}

@@ -7,8 +7,8 @@ import {
   type ReactNode,
 } from 'react';
 import { TranslationProvider } from './runtime';
-import { LangScopeContext } from './hooks/use-resolved-lang';
-import type { LangProviderProps, LocaleItem } from './lang';
+import { LangScopeContext } from '@terrafirmagreg-team/translate/hooks/use-resolved-lang';
+import type { LangProviderProps, LocaleItem } from '@terrafirmagreg-team/translate/lang';
 
 export interface LangContextValue {
   locale?: string;
@@ -63,3 +63,4 @@ export function LangLocalesScope({
   );
   return <LangContext value={value}>{children}</LangContext>;
 }
+

package/src/components/runtime.tsx

@@ -0,0 +1,9 @@
+'use client';
+export {
+  T,
+  TranslationProvider,
+  fromTranslations,
+  useTranslations,
+  type TranslationsHook,
+} from '@fuma-translate/react';
+

package/src/config.ts

@@ -12,3 +12,4 @@ export function registerTranslateConfig(next: TranslateConfig): void {
 export function translateConfig(): TranslateConfig {
   return config;
 }
+

package/src/create.ts

@@ -6,7 +6,6 @@ import type {
 import type { LangConfig, LangProviderProps, LocaleItem } from './lang';
 import { nativeLanguageName } from './lib/code';
 
-
 export function localeItems(codes: readonly string[]): LocaleItem[] {
   return codes.map((code) => ({
     locale: code,
@@ -62,3 +61,4 @@ export function createLocaleSet(registry: LocaleRegistry) {
 }
 
 export type LocaleSet = ReturnType<typeof createLocaleSet>;
+

package/src/hooks/index.ts

@@ -8,3 +8,4 @@ export {
   LocaleRegistryContext,
   useLocaleRegistry,
 } from './use-locale-registry';
+

package/src/hooks/use-locale-registry.ts

@@ -9,3 +9,4 @@ export function useLocaleRegistry(): LocaleRegistry {
   if (!registry) throw new Error('Missing LocaleRegistryContext');
   return registry;
 }
+

package/src/hooks/use-resolved-lang.ts

@@ -34,3 +34,4 @@ export function useDefaultLang(): Lang {
   if (!ctx) throw new Error('Missing ResolvedLangContext');
   return ctx.defaultLang;
 }
+

package/src/hooks/use-translations.ts

@@ -1,12 +1,24 @@
 'use client';
+import { useMemo } from 'react';
 import { useTranslations as useFumaTranslations } from '@terrafirmagreg-team/translate/runtime';
 
 export function useTranslations<K extends string = string>(options?: {
   note?: string;
 }) {
   const base = useFumaTranslations(options);
-  return base as (key: K, opts?: {
-    note?: string;
-    variables?: Record<string, string>;
-  }) => string;
+  return useMemo(
+    () =>
+      ((key: K, opts?: {
+        note?: string;
+        variables?: Record<string, string>;
+      }) => {
+        const value = base(key, opts);
+        return opts?.note && value === key ? base(key) : value;
+      }) as (key: K, opts?: {
+        note?: string;
+        variables?: Record<string, string>;
+      }) => string,
+    [base],
+  );
 }
+

package/src/lang.ts

@@ -26,3 +26,4 @@ export interface LangProviderProps
   locales?: LocaleItem[];
   children?: ReactNode;
 }
+

package/src/lib/code.ts

@@ -48,3 +48,4 @@ export function nativeLanguageName(lang: Lang): string | undefined {
     return undefined;
   }
 }
+

package/src/lib/content.ts

@@ -1,8 +1,8 @@
 import 'server-only';
 import type { ReactNode } from 'react';
 import { loadLocaleRegistry } from './registry.server';
-import type { Lang } from '../types/locale';
-import type { LangContent } from '../types/content';
+import type { Lang } from '@terrafirmagreg-team/translate/types/locale';
+import type { LangContent } from '@terrafirmagreg-team/translate/types/content';
 
 type Resolve<P> = (
   slug: string[] | undefined,
@@ -17,19 +17,21 @@ export function langContent<P>(
   render: (page: P, lang: Lang) => ReactNode,
 ): LangContent | null {
   const { messages, defaultLanguage } = loadLocaleRegistry();
-  const content: LangContent = {};
+  const primary = resolve(slug, defaultLanguage);
+  if (primary && !primary.isFallback) {
+    return {
+      lang: defaultLanguage,
+      node: render(primary.page, defaultLanguage),
+    };
+  }
   for (const locale of Object.keys(messages)) {
     const resolved = resolve(slug, locale as Lang);
     if (!resolved || resolved.isFallback) continue;
-    content[locale] = { node: render(resolved.page, locale as Lang) };
-  }
-  if (!Object.keys(content).length) {
-    const resolved = resolve(slug, defaultLanguage);
-    if (resolved) {
-      content[defaultLanguage] = { node: render(resolved.page, defaultLanguage) };
-    }
+    return { lang: locale as Lang, node: render(resolved.page, locale as Lang) };
   }
-  return Object.keys(content).length ? content : null;
+  return primary
+    ? { lang: defaultLanguage, node: render(primary.page, defaultLanguage) }
+    : null;
 }
 
 export function firstLocalizedPage<P>(
@@ -48,3 +50,4 @@ export function firstLocalizedPage<P>(
   }
   return undefined;
 }
+

package/src/lib/coverage.ts

@@ -68,3 +68,4 @@ export function readPageSource(
     return undefined;
   }
 }
+

package/src/lib/flatten.ts

@@ -14,3 +14,4 @@ export function flattenMessages(
   }
   return out;
 }
+

package/src/lib/key-index.ts

@@ -0,0 +1,21 @@
+const NOTE_KEY = /^[a-z][a-z0-9_]*(\.[a-z0-9_]+)+$/;
+
+export function buildKeyIndex(
+  messages: Partial<Record<string, string>>,
+): Map<string, string> {
+  const index = new Map<string, string>();
+  for (const key of Object.keys(messages)) {
+    const end = key.lastIndexOf('(');
+    if (!key.endsWith(')') || end < 0) continue;
+    const note = key.slice(end + 1, -1);
+    if (NOTE_KEY.test(note)) index.set(note, key);
+  }
+  return index;
+}
+
+export function stripKeyNote(full: string, key: string): string {
+  return full !== key && full.endsWith(`(${key})`)
+    ? full.slice(0, -(key.length + 2))
+    : full;
+}
+

package/src/lib/locales.ts

@@ -8,3 +8,17 @@ export function createLocaleCatalog(
     ]),
   );
 }
+
+export function createLocaleCatalogs(
+  modules: Record<string, unknown>,
+): Record<string, Record<string, unknown>> {
+  const catalogs: Record<string, Record<string, unknown>> = {};
+  for (const [path, messages] of Object.entries(modules)) {
+    const dir = path.slice(0, path.lastIndexOf('/'));
+    const catalog = dir.slice(dir.lastIndexOf('/') + 1);
+    const lang = path.slice(path.lastIndexOf('/') + 1, -'.json'.length);
+    (catalogs[catalog] ??= {})[lang] = messages;
+  }
+  return catalogs;
+}
+

package/src/lib/registry.server.ts

@@ -1,9 +1,9 @@
 import 'server-only';
-import { createLocaleSet, type LocaleSet } from '../create';
-import { translateConfig } from '../config';
+import { createLocaleSet, type LocaleSet } from '@terrafirmagreg-team/translate/create';
+import { translateConfig } from '@terrafirmagreg-team/translate/config';
 import { flattenMessages } from './flatten';
 import { sortLangCodes } from './code';
-import type { LocaleMessages, LocaleRegistry } from '../types/locale';
+import type { LocaleMessages, LocaleRegistry } from '@terrafirmagreg-team/translate/types/locale';
 
 export { sortLangCodes };
 
@@ -56,3 +56,4 @@ export function loadLocaleSet(): LocaleSet {
   cachedSet ??= createLocaleSet(loadLocaleRegistry());
   return cachedSet;
 }
+

package/src/lib/slug.ts

@@ -27,3 +27,4 @@ export function toPublicSlug(
   if (!dataset || !languages.includes(maybeLang)) return slugs;
   return [dataset, ...rest];
 }
+

package/src/lib/tree.ts

@@ -1,6 +1,6 @@
 import { cloneElement, isValidElement } from 'react';
-import type * as PageTree from '../types/tree';
-import type { Lang } from '../types/locale';
+import type * as PageTree from '@terrafirmagreg-team/translate/types/tree';
+import type { Lang } from '@terrafirmagreg-team/translate/types/locale';
 import { isLang } from './code';
 import { loadLocaleRegistry } from './registry.server';
 import { stripLangFromUrl } from './slug';
@@ -246,3 +246,4 @@ export function localizePageTree(
     children: merged.map(keyTreeNode),
   };
 }
+

package/src/lib/url.ts

@@ -89,3 +89,4 @@ export function withLang(href: string, lang: Lang, fallback?: Lang): string {
   const frag = fragQuery ? `${anchor}&${fragQuery}` : anchor;
   return `${pathname}${q ? `?${q}` : ''}#${frag}`;
 }
+

package/src/server.ts

@@ -4,3 +4,4 @@ export * from './lib/content';
 export * from './lib/coverage';
 export * from './lib/registry.server';
 export * from './lib/tree';
+

package/src/types/content.ts

@@ -1,4 +1,5 @@
 import type { ReactNode } from 'react';
 import type { Lang } from './locale';
 
-export type LangContent = Partial<Record<Lang, { node: ReactNode }>>;
+export type LangContent = { lang: Lang; node: ReactNode };
+

package/src/types/locale.ts

@@ -7,3 +7,4 @@ export type LocaleRegistry = {
   defaultLanguage: string;
   messages: Record<string, LocaleMessages>;
 };
+

package/src/types/tree.ts

@@ -53,3 +53,4 @@ export interface Folder extends ID {
   icon?: ReactNode;
   children: Node[];
 }
+

package/src/runtime.tsx

@@ -1,247 +0,0 @@
-"use client";
-import {
-  cloneElement,
-  createContext,
-  isValidElement,
-  ReactElement,
-  use,
-  useMemo,
-  type ReactNode,
-} from "react";
-
-const Context = createContext<Partial<Record<string, string>>>({});
-
-
-export function TranslationProvider({
-  translations,
-  children,
-}: {
-  translations: Partial<Record<string, string>>;
-  children: ReactNode;
-}) {
-  const parent = use(Context);
-  return (
-    <Context value={useMemo(() => ({ ...parent, ...translations }), [parent, translations])}>
-      {children}
-    </Context>
-  );
-}
-
-type GetVariables<T extends string> = T extends `${infer Before}{${infer K}}${infer After}`
-  ? (Before extends `${string}\\` ? never : K) | GetVariables<After>
-  : never;
-
-type GetTags<T extends string> = T extends `${infer Before}<${infer K}>${infer After}`
-  ?
-      | (Before extends `${string}\\`
-          ? never
-          : K extends `/${string}`
-            ? never
-            : K extends `${infer Tag}/`
-              ? Tag
-              : K)
-      | GetTags<After>
-  : never;
-
-interface HookOptions {
-
-  note?: string;
-}
-
-export interface TranslationsHook {
-  translations: Partial<Record<string, string>>;
-
-  <Text extends string>(
-    text: Text,
-    opts?: {
-
-      note?: string;
-      variables?: Record<GetVariables<Text>, string>;
-    },
-  ): string;
-
-  jsx<Text extends string>(
-    text: Text,
-    opts?: {
-
-      note?: string;
-      variables?: Record<GetVariables<Text>, ReactNode>;
-      tags?: Record<GetTags<Text>, TagRenderer>;
-    },
-  ): ReactNode;
-}
-
-const REGEX_VAR = /\\?\{([^}]+)\}/g;
-
-export function useTranslations({ note }: HookOptions = {}): TranslationsHook {
-  const translations = use(Context);
-  return useMemo(() => fromTranslations(translations, { note }), [translations, note]);
-}
-
-
-export function fromTranslations(
-  translations: Partial<Record<string, string>>,
-  { note: hookNote }: HookOptions = {},
-): TranslationsHook {
-  const res: TranslationsHook = (rawText, opts = {}) => {
-    const { note, variables } = opts;
-    const notes: string[] = [];
-    if (hookNote) notes.push(hookNote);
-    if (note) notes.push(note);
-    const k = encodeKey(rawText, notes);
-    let text = translations[k] ?? rawText;
-
-    if (variables) {
-      text = text.replaceAll(REGEX_VAR, (m, name: string) => {
-        if (m[0] === "\\") return m.slice(1);
-        if (name in variables) return variables[name as never];
-        return m;
-      });
-    }
-
-    return text;
-  };
-
-  res.jsx = (rawText, opts = {}) => {
-    const { note, variables, tags } = opts;
-    const notes: string[] = [];
-    if (hookNote) notes.push(hookNote);
-    if (note) notes.push(note);
-    const k = encodeKey(rawText, notes);
-    const text = translations[k] ?? rawText;
-    if (tags) {
-      return onJsx(text, variables, tags);
-    }
-    if (variables) {
-      return onJsxVariables(text, variables);
-    }
-    return text;
-  };
-
-  res.translations = translations;
-  return res;
-}
-
-function encodeKey(text: string, notes: string[]): string {
-  return text + notes.map((n) => `(${n})`).join("");
-}
-
-function onJsxVariables(text: string, variables: Record<string, ReactNode>): ReactNode {
-  let idx = 0;
-  const out: ReactNode[] = [];
-  for (const match of text.matchAll(REGEX_VAR)) {
-    const [s, name] = match as unknown as [string, string];
-    if (idx < match.index) {
-      out.push(text.slice(idx, match.index));
-    }
-    idx = match.index + s.length;
-
-    if (s[0] === "\\") {
-      out.push(s.slice(1));
-    } else if (name in variables) {
-      out.push(enforceElementKey(variables[name], idx));
-    } else {
-      out.push(s);
-    }
-  }
-  out.push(text.slice(idx));
-  return out;
-}
-
-const REGEX_TAG = /\\?<([^>]+)>/g;
-
-function onJsx(
-  text: string,
-  variables: Record<string, ReactNode> | undefined,
-  tags: Record<string, TagRenderer>,
-) {
-  const stack: { children: ReactNode[]; tag?: string }[] = [{ children: [] }];
-  let idx = 0;
-  const closeTag = () => {
-    const current = stack.pop()!;
-
-    stack[stack.length - 1]!.children.push(
-      enforceElementKey(
-        current.tag && tags[current.tag]
-          ? renderTag(tags[current.tag]!, current.children)
-          : current.children,
-        idx,
-      ),
-    );
-  };
-
-  for (const match of text.matchAll(REGEX_TAG)) {
-    const current = stack[stack.length - 1]!;
-    const [s, content] = match as unknown as [string, string];
-
-    if (idx < match.index) {
-      const str = text.slice(idx, match.index);
-      current.children.push(variables ? onJsxVariables(str, variables) : str);
-    }
-    idx = match.index + s.length;
-
-    if (s[0] === "\\") {
-      const str = s.slice(1);
-      current.children.push(variables ? onJsxVariables(str, variables) : str);
-    } else if (content[0] === "/") {
-      const name = content.slice(1);
-
-      if (current.tag !== name) {
-        current.children.push(variables ? onJsxVariables(s, variables) : s);
-      } else {
-        closeTag();
-      }
-    } else if (content.at(-1) === "/") {
-      const name = content.slice(0, -1);
-
-      if (tags[name]) {
-        current.children.push(enforceElementKey(renderTag(tags[name]), idx));
-      }
-    } else {
-      stack.push({ children: [], tag: content });
-    }
-  }
-
-  if (idx < text.length) {
-    const str = text.slice(idx);
-    stack[stack.length - 1]!.children.push(variables ? onJsxVariables(str, variables) : str);
-  }
-
-  while (stack.length > 1) closeTag();
-  return stack[0]!.children;
-}
-
-interface TProps<Text extends string> {
-  text: Text;
-
-  note?: string;
-  variables?: Record<GetVariables<Text>, ReactNode>;
-  tags?: Record<GetTags<Text>, TagRenderer>;
-}
-
-export function T<const Text extends string>({
-  text,
-  note,
-  variables,
-  tags,
-}: TProps<Text>): ReactNode {
-  const translations = use(Context)!;
-  return useMemo(
-    () => fromTranslations(translations).jsx(text, { note, variables, tags }),
-    [translations, text, note, variables, tags],
-  );
-}
-
-
-type TagRenderer = ReactElement | ((children: ReactNode) => ReactNode);
-
-function renderTag(renderer: TagRenderer, child?: ReactNode) {
-  if (isValidElement(renderer))
-    return child === undefined ? renderer : cloneElement(renderer, undefined, child);
-  return renderer(child);
-}
-
-function enforceElementKey(value: ReactNode, key: number | string): ReactNode {
-  if (isValidElement(value)) return cloneElement(value, { key });
-  return value;
-}