gt-react-native 0.0.0 → 0.0.1-alpha.2

package/lib/typescript/src/utils/getNativeLocales.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Get native device locales in preference order
+ * Returns an empty array if detection fails or is not supported
+ *
+ * iOS: Returns current locale first, followed by preferred languages
+ * Android: Returns user's preferred language list (LocaleList on API 24+, single locale on older versions)
+ * Web: Returns browser language preferences from navigator
+ */
+export declare function getNativeLocales(): string[];
+//# sourceMappingURL=getNativeLocales.d.ts.map

package/lib/typescript/src/utils/getNativeLocales.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getNativeLocales.d.ts","sourceRoot":"","sources":["../../../../src/utils/getNativeLocales.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,EAAE,CAa3C"}

package/lib/typescript/src/utils/nativeStore.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Native store interface, used to replace cookie behavior from gt-react
+ */
+/**
+ * Get a value from the native store
+ * @param key - The key to get the value for
+ * @returns The value for the key
+ */
+export declare function nativeStoreGet(key: string): string | null;
+/**
+ * Set a value in the native store
+ * @param key - The key to set the value for
+ * @param value - The value to set
+ */
+export declare function nativeStoreSet(key: string, value: string): void;
+//# sourceMappingURL=nativeStore.d.ts.map

package/lib/typescript/src/utils/nativeStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nativeStore.d.ts","sourceRoot":"","sources":["../../../../src/utils/nativeStore.ts"],"names":[],"mappings":"AAGA;;GAEG;AAEH;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAKzD;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAM/D"}

package/lib/typescript/src/utils/polyfill.d.ts

@@ -0,0 +1,28 @@
+import '@formatjs/intl-getcanonicallocales/polyfill';
+import '@formatjs/intl-locale/polyfill';
+import '@formatjs/intl-displaynames/polyfill';
+import '@formatjs/intl-displaynames/locale-data/en';
+import '@formatjs/intl-displaynames/locale-data/zh';
+import '@formatjs/intl-displaynames/locale-data/es';
+import '@formatjs/intl-listformat/polyfill';
+import '@formatjs/intl-listformat/locale-data/en';
+import '@formatjs/intl-listformat/locale-data/zh';
+import '@formatjs/intl-listformat/locale-data/es';
+import '@formatjs/intl-pluralrules/polyfill';
+import '@formatjs/intl-pluralrules/locale-data/en';
+import '@formatjs/intl-pluralrules/locale-data/zh';
+import '@formatjs/intl-pluralrules/locale-data/es';
+import '@formatjs/intl-numberformat/polyfill';
+import '@formatjs/intl-numberformat/locale-data/en';
+import '@formatjs/intl-numberformat/locale-data/zh';
+import '@formatjs/intl-numberformat/locale-data/es';
+import '@formatjs/intl-relativetimeformat/polyfill';
+import '@formatjs/intl-relativetimeformat/locale-data/en';
+import '@formatjs/intl-relativetimeformat/locale-data/zh';
+import '@formatjs/intl-relativetimeformat/locale-data/es';
+import '@formatjs/intl-datetimeformat/polyfill';
+import '@formatjs/intl-datetimeformat/add-all-tz';
+import '@formatjs/intl-datetimeformat/locale-data/en';
+import '@formatjs/intl-datetimeformat/locale-data/zh';
+import '@formatjs/intl-datetimeformat/locale-data/es';
+//# sourceMappingURL=polyfill.d.ts.map

package/lib/typescript/src/utils/polyfill.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polyfill.d.ts","sourceRoot":"","sources":["../../../../src/utils/polyfill.ts"],"names":[],"mappings":"AAEA,OAAO,6CAA6C,CAAC;AAErD,OAAO,gCAAgC,CAAC;AAExC,OAAO,sCAAsC,CAAC;AAC9C,OAAO,4CAA4C,CAAC;AACpD,OAAO,4CAA4C,CAAC;AACpD,OAAO,4CAA4C,CAAC;AAEpD,OAAO,oCAAoC,CAAC;AAC5C,OAAO,0CAA0C,CAAC;AAClD,OAAO,0CAA0C,CAAC;AAClD,OAAO,0CAA0C,CAAC;AAElD,OAAO,qCAAqC,CAAC;AAC7C,OAAO,2CAA2C,CAAC;AACnD,OAAO,2CAA2C,CAAC;AACnD,OAAO,2CAA2C,CAAC;AAEnD,OAAO,sCAAsC,CAAC;AAC9C,OAAO,4CAA4C,CAAC;AACpD,OAAO,4CAA4C,CAAC;AACpD,OAAO,4CAA4C,CAAC;AAEpD,OAAO,4CAA4C,CAAC;AACpD,OAAO,kDAAkD,CAAC;AAC1D,OAAO,kDAAkD,CAAC;AAC1D,OAAO,kDAAkD,CAAC;AAE1D,OAAO,wCAAwC,CAAC;AAChD,OAAO,0CAA0C,CAAC;AAClD,OAAO,8CAA8C,CAAC;AACtD,OAAO,8CAA8C,CAAC;AACtD,OAAO,8CAA8C,CAAC"}

package/lib/typescript/src/utils/utils.d.ts

@@ -0,0 +1,3 @@
+import type { AuthFromEnvParams, AuthFromEnvReturn } from '@generaltranslation/react-core/types';
+export declare function readAuthFromEnv(params: AuthFromEnvParams): AuthFromEnvReturn;
+//# sourceMappingURL=utils.d.ts.map

package/lib/typescript/src/utils/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/utils/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,sCAAsC,CAAC;AAE9C,wBAAgB,eAAe,CAAC,MAAM,EAAE,iBAAiB,GAAG,iBAAiB,CAM5E"}

package/package.json

@@ -1,12 +1,158 @@
 {
   "name": "gt-react-native",
-  "version": "0.0.0",
-  "description": "",
-  "license": "UNLICENSED",
-  "author": "",
-  "type": "commonjs",
-  "main": "index.js",
+  "version": "0.0.1-alpha.2",
+  "description": "An i18n package for React Native",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "example": "yarn workspace gt-react-native-example",
+    "test": "jest",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "release": "yarn clean && yarn npm publish --tag latest",
+    "release:alpha": "yarn clean && npm publish --tag alpha"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/generaltranslation/gt-react-native.git"
+  },
+  "author": "General Translation, Inc. <support@generaltranslation.com> (https://generaltranslation.com)",
+  "license": "FSL-1.1-ALv2",
+  "bugs": {
+    "url": "https://github.com/generaltranslation/gt-react-native/issues"
+  },
+  "homepage": "https://github.com/generaltranslation/gt-react-native#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.8.1",
+    "@eslint/compat": "^1.3.2",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.35.0",
+    "@evilmartians/lefthook": "^1.12.3",
+    "@react-native-community/cli": "20.0.1",
+    "@react-native/babel-preset": "0.81.1",
+    "@react-native/eslint-config": "^0.81.1",
+    "@release-it/conventional-changelog": "^10.0.1",
+    "@types/jest": "^29.5.14",
+    "@types/react": "^19.1.0",
+    "commitlint": "^19.8.1",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jest": "^29.7.0",
+    "prettier": "^3.6.2",
+    "react": "19.1.0",
+    "react-native": "0.81.1",
+    "react-native-builder-bob": "^0.40.13",
+    "turbo": "^2.5.6",
+    "typescript": "^5.9.2"
+  },
+  "dependencies": {
+    "@formatjs/intl-datetimeformat": "^6.18.2",
+    "@formatjs/intl-displaynames": "^6.8.13",
+    "@formatjs/intl-getcanonicallocales": "^2.5.6",
+    "@formatjs/intl-listformat": "^7.7.13",
+    "@formatjs/intl-locale": "^4.2.13",
+    "@formatjs/intl-numberformat": "^8.15.6",
+    "@formatjs/intl-pluralrules": "^5.4.6",
+    "@formatjs/intl-relativetimeformat": "^11.4.13",
+    "@generaltranslation/react-core": "^1.0.0",
+    "@generaltranslation/supported-locales": "^2.0.16",
+    "generaltranslation": "^7.7.0"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@3.6.1",
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "codegenConfig": {
+    "name": "GtReactNativeSpec",
+    "type": "modules",
+    "jsSrcsDir": "./src",
+    "android": {
+      "javaPackageName": "com.gtreactnative"
+    }
+  },
+  "create-react-native-library": {
+    "languages": "kotlin-objc",
+    "type": "turbo-module",
+    "version": "0.54.5"
   }
 }

package/src/NativeGtReactNative.ts

@@ -0,0 +1,10 @@
+import { TurboModuleRegistry, type TurboModule } from 'react-native';
+
+export interface Spec extends TurboModule {
+  multiply(a: number, b: number): number;
+  getNativeLocales(): string[];
+  nativeStoreGet(key: string): string | null;
+  nativeStoreSet(key: string, value: string): void;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('GtReactNative');

package/src/errors-dir/constants.ts

@@ -0,0 +1 @@
+export const PACKAGE_NAME = 'gt-react';

package/src/index.tsx

@@ -0,0 +1,68 @@
+import './utils/polyfill';
+import GtReactNative from './NativeGtReactNative';
+
+import { GTProvider } from './provider/GTProvider';
+export function multiply(a: number, b: number): number {
+  return GtReactNative.multiply(a, b);
+}
+
+import {
+  T,
+  useGT,
+  useTranslations,
+  useDefaultLocale,
+  useLocale,
+  useRegion,
+  Var,
+  Num,
+  Currency,
+  DateTime,
+  Plural,
+  Branch,
+  useLocales,
+  useLocaleSelector,
+  useSetLocale,
+  useGTClass,
+  useLocaleProperties,
+  useRegionSelector,
+  useLocaleDirection,
+  useMessages,
+  msg,
+  decodeMsg,
+  decodeOptions,
+} from '@generaltranslation/react-core';
+import type {
+  DictionaryTranslationOptions,
+  InlineTranslationOptions,
+  RuntimeTranslationOptions,
+} from '@generaltranslation/react-core/types';
+
+export {
+  Var,
+  Num,
+  Currency,
+  DateTime,
+  T,
+  GTProvider,
+  Plural,
+  Branch,
+  useGT,
+  useTranslations,
+  useDefaultLocale,
+  useLocale,
+  useLocales,
+  useSetLocale,
+  useLocaleSelector,
+  useRegion,
+  useRegionSelector,
+  useGTClass,
+  useLocaleProperties,
+  useLocaleDirection,
+  type DictionaryTranslationOptions,
+  type InlineTranslationOptions,
+  type RuntimeTranslationOptions,
+  msg,
+  decodeMsg,
+  decodeOptions,
+  useMessages,
+};

package/src/provider/GTProvider.tsx

@@ -0,0 +1,20 @@
+import { useDetermineLocale } from './hooks/locale/useDetermineLocale';
+import type { GTProviderProps } from '../types/config';
+import { GTProvider as _GTProvider } from '@generaltranslation/react-core';
+import { readAuthFromEnv } from '../utils/utils';
+import { useRegionState } from './hooks/useRegionState';
+
+export function GTProvider(props: GTProviderProps): React.JSX.Element {
+  return (
+    <_GTProvider
+      ssr={false}
+      environment={__DEV__ ? 'development' : 'production'}
+      {...props}
+      readAuthFromEnv={readAuthFromEnv}
+      useDetermineLocale={useDetermineLocale}
+      useRegionState={useRegionState}
+    />
+  );
+}
+
+export default GTProvider;

package/src/provider/hooks/locale/useDetermineLocale.ts

@@ -0,0 +1,192 @@
+import { useEffect, useState } from 'react';
+import { determineLocale, resolveAliasLocale } from 'generaltranslation';
+import { libraryDefaultLocale } from 'generaltranslation/internal';
+import type { CustomMapping } from 'generaltranslation/types';
+import type {
+  UseDetermineLocaleParams,
+  UseDetermineLocaleReturn,
+} from '@generaltranslation/react-core/types';
+import { getNativeLocales } from '../../../utils/getNativeLocales';
+import { nativeStoreGet, nativeStoreSet } from '../../../utils/nativeStore';
+import { LOCALE_KEY } from '../../../utils/constants';
+
+export function useDetermineLocale({
+  locale: _locale = '',
+  defaultLocale = libraryDefaultLocale,
+  locales = [],
+  localeCookieName = 'generaltranslation.locale',
+  ssr = true, // when false, breaks server side rendering by accessing document and navigator on first render
+  customMapping,
+}: UseDetermineLocaleParams): UseDetermineLocaleReturn {
+  // resolve alias locale
+  _locale = resolveAliasLocale(_locale, customMapping);
+  locales = locales.map((locale) => resolveAliasLocale(locale, customMapping));
+
+  const initializeLocale = () => {
+    const result = resolveAliasLocale(
+      ssr
+        ? _locale
+          ? determineLocale(_locale, locales, customMapping) || ''
+          : ''
+        : getNewLocale({
+            _locale,
+            locale: _locale,
+            locales,
+            defaultLocale,
+            localeCookieName,
+            customMapping,
+          }),
+      customMapping
+    );
+    return result;
+  };
+
+  // maintaining the state of locale
+  const [locale, _setLocale] = useState<string>(initializeLocale());
+
+  // Functions for setting internal locale state
+  const [setLocale, setLocaleWithoutSettingCookie] = createSetLocale({
+    locale,
+    locales,
+    defaultLocale,
+    localeCookieName,
+    _setLocale,
+    customMapping,
+  });
+
+  // check browser for locales
+  useEffect(() => {
+    const newLocale = getNewLocale({
+      _locale,
+      locale,
+      locales,
+      defaultLocale,
+      localeCookieName,
+      customMapping,
+    });
+    setLocaleWithoutSettingCookie(newLocale);
+  }, [
+    _locale,
+    locale,
+    locales,
+    defaultLocale,
+    localeCookieName,
+    customMapping,
+    setLocaleWithoutSettingCookie,
+  ]);
+
+  return [locale, setLocale];
+}
+
+// ----- HELPER FUNCTIONS ---- //
+
+/**
+ * Choose a locale to use
+ * (1) use provided locale
+ * (2) use cookie locale
+ * (3) use preferred locale
+ * (5) fallback to defaultLocale
+ * Update the cookie locale to be correct
+ */
+function getNewLocale({
+  _locale,
+  locale,
+  locales,
+  defaultLocale,
+  customMapping,
+}: {
+  _locale: string;
+  locale: string;
+  locales: string[];
+  defaultLocale: string;
+  localeCookieName: string;
+  customMapping?: CustomMapping;
+}): string {
+  // No change, return
+  if (
+    _locale &&
+    _locale === locale &&
+    determineLocale(_locale, locales, customMapping) === locale
+  ) {
+    return resolveAliasLocale(_locale, customMapping);
+  }
+
+  // Check for locale in native store
+  let storedLocale = nativeStoreGet(LOCALE_KEY);
+  if (storedLocale) {
+    storedLocale = resolveAliasLocale(storedLocale, customMapping);
+  }
+
+  // check user's configured locales
+  let preferredLocales = getNativeLocales();
+  if (preferredLocales.length === 0) preferredLocales = [defaultLocale];
+  preferredLocales = preferredLocales.map((l) =>
+    resolveAliasLocale(l, customMapping)
+  );
+
+  // determine locale
+  let newLocale =
+    determineLocale(
+      [
+        ...(_locale ? [_locale] : []), // prefer user passed locale
+        ...(storedLocale ? [storedLocale] : []), // then prefer stored locale
+        ...preferredLocales, // then prefer browser locale
+      ],
+      locales,
+      customMapping
+    ) || defaultLocale;
+  if (newLocale) {
+    newLocale = resolveAliasLocale(newLocale, customMapping);
+  }
+
+  // if stored locale not valid, change it back to whatever we use for fallback
+  if (storedLocale && storedLocale !== newLocale) {
+    nativeStoreSet(LOCALE_KEY, newLocale);
+  }
+
+  // return new locale
+  return newLocale;
+}
+
+function createSetLocale({
+  locale,
+  locales,
+  defaultLocale,
+  _setLocale,
+  customMapping,
+}: {
+  locale: string;
+  locales: string[];
+  defaultLocale: string;
+  localeCookieName: string;
+  _setLocale: any;
+  customMapping?: CustomMapping;
+}): [(newLocale: string) => void, (newLocale: string) => void] {
+  locale = resolveAliasLocale(locale, customMapping);
+  const setLocaleWithoutSettingCookie = (newLocale: string): string => {
+    // validate locale
+    const validatedLocale = resolveAliasLocale(
+      determineLocale(newLocale, locales, customMapping) ||
+        locale ||
+        defaultLocale,
+      customMapping
+    );
+    if (validatedLocale !== newLocale) {
+      console.warn(
+        `[gt-react-native] Unsupported locale: ${validatedLocale} -> ${newLocale}`
+      );
+    }
+    // persist locale
+    _setLocale(validatedLocale);
+
+    return validatedLocale;
+  };
+  // update locale and store it in cookie
+  const setLocale = (newLocale: string): void => {
+    newLocale = resolveAliasLocale(newLocale, customMapping);
+    setLocaleWithoutSettingCookie(newLocale);
+    const validatedLocale = setLocaleWithoutSettingCookie(newLocale);
+    nativeStoreSet(LOCALE_KEY, validatedLocale);
+  };
+  return [setLocale, setLocaleWithoutSettingCookie];
+}

package/src/provider/hooks/useRegionState.ts

@@ -0,0 +1,63 @@
+import { useEffect, useState } from 'react';
+import type {
+  UseRegionStateParams,
+  UseRegionStateReturn,
+} from '@generaltranslation/react-core/types';
+
+function getNewRegion({
+  _region,
+}: {
+  _region: string | undefined;
+  regionCookieName: string;
+}) {
+  // Check for region in cookie
+  // const cookieRegion =
+  //   typeof document !== 'undefined'
+  //     ? document.cookie
+  //         .split('; ')
+  //         .find((row) => row.startsWith(`${regionCookieName}=`))
+  //         ?.split('=')[1]
+  //     : undefined;
+  const cookieRegion = undefined;
+
+  const newRegion = _region || cookieRegion;
+
+  // // if cookie not valid, change it to newRegion
+  // if (
+  //   cookieRegion &&
+  //   cookieRegion !== newRegion &&
+  //   typeof document !== 'undefined'
+  // ) {
+  //   document.cookie = `${regionCookieName}=${newRegion};path=/`;
+  // }
+
+  return newRegion;
+}
+
+export function useRegionState({
+  _region,
+  ssr,
+  regionCookieName,
+}: UseRegionStateParams): UseRegionStateReturn {
+  const [region, _setRegion] = useState<string | undefined>(
+    ssr
+      ? undefined
+      : getNewRegion({
+          _region,
+          regionCookieName,
+        })
+  );
+  const setRegion = (newRegion: string | undefined) => {
+    _setRegion(newRegion);
+    // if (typeof document !== 'undefined') {
+    //   document.cookie = `${regionCookieName}=${newRegion || ''};path=/`;
+    // }
+  };
+  useEffect(() => {
+    _setRegion(getNewRegion({ _region, regionCookieName }));
+  }, [_region, regionCookieName]);
+  return {
+    region,
+    setRegion,
+  };
+}

package/src/types/config.ts

@@ -0,0 +1,35 @@
+import type {
+  RenderMethod,
+  Translations,
+  CustomLoader,
+  GTConfig,
+} from '@generaltranslation/react-core/types';
+import type { CustomMapping } from 'generaltranslation/types';
+
+export type GTProviderProps = {
+  children?: React.ReactNode;
+  projectId?: string;
+  devApiKey?: string;
+  dictionary?: any;
+  locales?: string[];
+  defaultLocale?: string;
+  locale?: string;
+  region?: string;
+  cacheUrl?: string;
+  runtimeUrl?: string;
+  renderSettings?: {
+    method: RenderMethod;
+    timeout?: number;
+  };
+  _versionId?: string;
+  ssr?: boolean;
+  localeCookieName?: string;
+  translations?: Translations | null;
+  loadDictionary?: CustomLoader;
+  loadTranslations?: CustomLoader;
+  config?: GTConfig;
+  fallback?: React.ReactNode;
+  customMapping?: CustomMapping;
+  modelProvider?: string;
+  [key: string]: any;
+};

package/src/utils/constants.ts

@@ -0,0 +1,5 @@
+// Locale key used for lookups
+export const LOCALE_KEY = 'generaltranslation.locale';
+
+// Region key used for lookups
+export const REGION_KEY = 'generaltranslation.region';