E/react core/add use sync external store1

.changeset/separate-external-store-conditions.md

@@ -0,0 +1,9 @@
+---
+"@generaltranslation/react-core": major
+"gt-react": major
+"gt-i18n": major
+"gt-tanstack-start": major
+"gt-next": major
+---
+
+useSyncExternalStore refactor

packages/i18n/src/condition-store/ReadonlyConditionStore.ts

@@ -0,0 +1,47 @@
+import type {
+  LocaleResolverConfig,
+  ReadonlyConditionStoreInterface as ReadonlyConditionStoreContract,
+} from "../i18n-manager/types";
+import { createLocaleResolver, type LocaleCandidates } from "./localeResolver";
+
+export type ReadonlyConditionStoreParams = LocaleResolverConfig & {
+  locale: LocaleCandidates;
+  enableI18n?: boolean;
+};
+
+export class ReadonlyConditionStore implements ReadonlyConditionStoreContract {
+  /**
+   * @deprecated use getI18nManager().determineLocale() instead
+   */
+  protected readonly resolveLocale: (candidates?: LocaleCandidates) => string;
+  protected locale: string;
+  protected enableI18n: boolean;
+
+  constructor({
+    locale,
+    enableI18n = true,
+    ...localeConfig
+  }: ReadonlyConditionStoreParams) {
+    /**
+     * TODO: change this to getI18nManager().determineLocale() but this
+     * currently creates a circular dependency
+     */
+    this.resolveLocale = createLocaleResolver(localeConfig);
+    this.locale = this.resolveLocale(locale);
+    this.enableI18n = enableI18n;
+  }
+
+  getLocale = (): string => {
+    return this.locale;
+  };
+
+  getEnableI18n = (): boolean => {
+    return this.enableI18n;
+  };
+
+  // --- no-op methods --- //
+
+  setLocale = (locale: LocaleCandidates): void => {};
+
+  setEnableI18n = (enableI18n: boolean): void => {};
+}

packages/i18n/src/condition-store/WritableConditionStore.ts

@@ -0,0 +1,22 @@
+import type { LocaleCandidates } from "../i18n-manager";
+import type { WritableConditionStoreInterface as WritableConditionStoreContract } from "../i18n-manager/types";
+import {
+  ReadonlyConditionStore,
+  type ReadonlyConditionStoreParams,
+} from "./ReadonlyConditionStore";
+
+export type WritableConditionStoreParams = ReadonlyConditionStoreParams;
+
+export class WritableConditionStore
+  extends ReadonlyConditionStore
+  implements WritableConditionStoreContract
+{
+  setLocale = (locale: LocaleCandidates): void => {
+    console.log("WritableConditionStore.setLocale", locale);
+    this.locale = this.resolveLocale(locale);
+  };
+
+  setEnableI18n = (enableI18n: boolean): void => {
+    this.enableI18n = enableI18n;
+  };
+}

packages/i18n/src/condition-store/createConditionStoreSingleton.ts

@@ -0,0 +1,31 @@
+import type { ReadonlyConditionStoreInterface } from "../i18n-manager/types";
+
+let conditionStore: ReadonlyConditionStoreInterface | undefined;
+
+export function createConditionStoreSingleton<
+  T extends ReadonlyConditionStoreInterface,
+>(notInitializedMessage: string) {
+  function getConditionStore(): T {
+    /**
+     * TODO: each package throws a different error message
+     */
+    if (!conditionStore) {
+      throw new Error(notInitializedMessage);
+    }
+    return conditionStore as T;
+  }
+
+  function setConditionStore(nextConditionStore: T): void {
+    conditionStore = nextConditionStore;
+  }
+
+  function isConditionStoreInitialized(): boolean {
+    return conditionStore !== undefined;
+  }
+
+  return {
+    getConditionStore,
+    setConditionStore,
+    isConditionStoreInitialized,
+  };
+}

packages/i18n/src/i18n-manager/condition-store/localeResolver.ts → packages/i18n/src/condition-store/localeResolver.ts

@@ -1,14 +1,14 @@
-import { LocaleConfig } from '@generaltranslation/format';
-import { libraryDefaultLocale } from 'generaltranslation/internal';
-import type { ConditionStoreConfig } from '../types';
+import { LocaleConfig } from "@generaltranslation/format";
+import { libraryDefaultLocale } from "generaltranslation/internal";
+import type { LocaleResolverConfig } from "../i18n-manager/types";
 
 export type LocaleCandidates = string | string[] | undefined;
 
 function normalizeConditionStoreConfig({
   defaultLocale,
   locales,
   customMapping,
-}: ConditionStoreConfig = {}) {
+}: LocaleResolverConfig = {}) {
   const fallbackLocale = defaultLocale || libraryDefaultLocale;
   return {
     defaultLocale: fallbackLocale,
@@ -26,17 +26,17 @@ type NormalizedConditionStoreConfig = ReturnType<
  */
 export function determineSupportedLocale(
   candidates: LocaleCandidates,
-  config: ConditionStoreConfig = {}
+  config: LocaleResolverConfig = {},
 ): string | undefined {
   return determineSupportedLocaleWithConfig(
     candidates,
-    normalizeConditionStoreConfig(config)
+    normalizeConditionStoreConfig(config),
   );
 }
 
 function determineSupportedLocaleWithConfig(
   candidates: LocaleCandidates,
-  config: NormalizedConditionStoreConfig
+  config: NormalizedConditionStoreConfig,
 ): string | undefined {
   if (
     candidates == null ||
@@ -54,7 +54,7 @@ function determineSupportedLocaleWithConfig(
  */
 export function resolveSupportedLocale(
   candidates: LocaleCandidates,
-  config: ConditionStoreConfig = {}
+  config: LocaleResolverConfig = {},
 ): string {
   const normalizedConfig = normalizeConditionStoreConfig(config);
   return (
@@ -63,7 +63,7 @@ export function resolveSupportedLocale(
   );
 }
 
-export function createLocaleResolver(config: ConditionStoreConfig = {}) {
+export function createLocaleResolver(config: LocaleResolverConfig = {}) {
   const normalizedConfig = normalizeConditionStoreConfig(config);
   return (candidates?: LocaleCandidates): string =>
     determineSupportedLocaleWithConfig(candidates, normalizedConfig) ||

packages/i18n/src/condition-store/singleton-operations.ts

@@ -0,0 +1,9 @@
+import { createConditionStoreSingleton } from "./createConditionStoreSingleton";
+import { WritableConditionStore } from "./WritableConditionStore";
+
+export const {
+  getConditionStore: getWritableConditionStore,
+  setConditionStore: setWritableConditionStore,
+} = createConditionStoreSingleton<WritableConditionStore>(
+  "WritableConditionStore is not initialized.",
+);

packages/i18n/src/helpers/locale.ts

@@ -1,7 +1,5 @@
-import {
-  getCurrentLocale,
-  getI18nManager,
-} from '../i18n-manager/singleton-operations';
+import { getWritableConditionStore } from "../condition-store/singleton-operations";
+import { getI18nManager } from "../i18n-manager/singleton-operations";
 
 /**
  * Get the current locale
@@ -12,7 +10,7 @@ import {
  * console.log(locale); // 'en-US'
  */
 export function getLocale() {
-  return getCurrentLocale();
+  return getWritableConditionStore().getLocale();
 }
 
 /**
@@ -52,7 +50,7 @@ export function getDefaultLocale() {
  * @example
  * const localeProperties = getLocaleProperties('en-US');
  */
-export function getLocaleProperties(locale = getCurrentLocale()) {
+export function getLocaleProperties(locale = getLocale()) {
   const i18nManager = getI18nManager();
   const gtInstance = i18nManager.getGTClass();
   return gtInstance.getLocaleProperties(locale);