E/null dict

.changeset/eleven-monkeys-mate.md

@@ -0,0 +1,6 @@
+---
+'gt-react': patch
+'gt-next': patch
+---
+
+fix: return type for t.obj

packages/next/src/provider/GTProvider.tsx

@@ -68,7 +68,7 @@ export default async function GTProvider({
   }
 
   // Merge dictionary with dictionary translations
-  dictionary = mergeDictionaries(dictionary, dictionaryTranslations);
+  // dictionary = mergeDictionaries(dictionary, dictionaryTranslations);
 
   // Block until cache check resolves
   const translations = await cachedTranslationsPromise;

packages/next/src/server-dir/buildtime/getTranslations.tsx

@@ -192,6 +192,12 @@ export async function getTranslations(id?: string): Promise<
       return renderContent(entry, [defaultLocale]);
     }
 
+    // Don't translate non-string entries
+    if (typeof entry !== 'string') {
+      injectEntry(entry, dictionaryTranslations!, id, dictionary);
+      return renderContent(entry, [defaultLocale]);
+    }
+
     try {
       // Translate on demand
       I18NConfig.translateIcu({
@@ -306,6 +312,10 @@ export async function getTranslations(id?: string): Promise<
     for (const untranslatedEntry of untranslatedEntries) {
       const { source, metadata } = untranslatedEntry;
       const id = metadata?.$id;
+      if (typeof source !== 'string') {
+        injectEntry(source, dictionaryTranslations!, id, dictionary);
+        continue;
+      }
 
       // (3.a) Translate
       I18NConfig.translateIcu({

packages/react/rollup.base.config.mjs

@@ -24,7 +24,7 @@ export default {
     typescript({
       // Compiles TypeScript files
       tsconfig: './tsconfig.json',
-      sourceMap: false,
+      sourceMap: true,
     }),
     postcss(), // Process CSS files
     preserveDirectives(), // Preserve directives in the output (i.e., "use client")

packages/react/rollup.config.mjs

@@ -12,13 +12,13 @@ export default [
         file: './dist/index.cjs.min.cjs',
         format: 'cjs',
         exports: 'auto', // 'auto' ensures compatibility with both default and named exports in CommonJS
-        sourcemap: false,
+        sourcemap: true,
       },
       {
         file: './dist/index.esm.min.mjs',
         format: 'esm',
         exports: 'named', // Named exports for ES modules
-        sourcemap: false,
+        sourcemap: true,
       },
     ],
     plugins: [
@@ -47,13 +47,13 @@ export default [
         file: './dist/internal.cjs.min.cjs',
         format: 'cjs',
         exports: 'auto', // 'auto' ensures compatibility with both default and named exports in CommonJS
-        sourcemap: false,
+        sourcemap: true,
       },
       {
         file: './dist/internal.esm.min.mjs',
         format: 'esm',
         exports: 'named', // Named exports for ES modules
-        sourcemap: false,
+        sourcemap: true,
       },
     ],
     plugins: [
@@ -82,13 +82,13 @@ export default [
         file: './dist/client.cjs.min.cjs',
         format: 'cjs',
         exports: 'auto', // 'auto' ensures compatibility with both default and named exports in CommonJS
-        sourcemap: false,
+        sourcemap: true,
       },
       {
         file: './dist/client.esm.min.mjs',
         format: 'esm',
         exports: 'named', // Named exports for ES modules
-        sourcemap: false,
+        sourcemap: true,
       },
     ],
     plugins: [

packages/react/src/dictionaries/collectUntranslatedEntries.ts

@@ -1,4 +1,4 @@
-import { Dictionary } from '../types/types';
+import { Dictionary, DictionaryEntry } from '../types/types';
 import getEntryAndMetadata from './getEntryAndMetadata';
 import { get } from './indexDict';
 import { isDictionaryEntry } from './isDictionaryEntry';
@@ -15,19 +15,19 @@ export function collectUntranslatedEntries(
   translationsDictionary: Dictionary,
   id: string = ''
 ): {
-  source: string;
+  source: string | null;
   metadata: { $id: string; $context?: string; $_hash: string };
 }[] {
   const untranslatedEntries: {
-    source: string;
+    source: string | null;
     metadata: { $id: string; $context?: string; $_hash: string };
   }[] = [];
   Object.entries(dictionary).forEach(([key, value]) => {
     const wholeId = id ? `${id}.${key}` : key;
     if (isDictionaryEntry(value)) {
       const { entry, metadata } = getEntryAndMetadata(value);
 
-      if (!get(translationsDictionary, key)) {
+      if (get(translationsDictionary, key) === undefined) {
         untranslatedEntries.push({
           source: entry,
           metadata: {
@@ -38,11 +38,14 @@ export function collectUntranslatedEntries(
         });
       }
     } else {
+      let translationsValue = get(translationsDictionary, key);
+      if (translationsValue === undefined) {
+        translationsValue = Array.isArray(value) ? [] : {};
+      }
       untranslatedEntries.push(
         ...collectUntranslatedEntries(
           value,
-          (get(translationsDictionary, key) ||
-            (Array.isArray(value) ? [] : {})) as Dictionary,
+          translationsValue as Dictionary,
           wholeId
         )
       );

packages/react/src/dictionaries/getDictionaryEntry.ts

@@ -4,12 +4,12 @@ import { get } from './indexDict';
 export function isValidDictionaryEntry(
   value: unknown
 ): value is DictionaryEntry {
-  if (typeof value === 'string') {
+  if (typeof value !== 'object' || value === null) {
     return true;
   }
 
   if (Array.isArray(value)) {
-    if (typeof value?.[0] !== 'string') {
+    if (typeof value?.[0] === 'object' && value?.[0] !== null) {
       return false;
     }
     const provisionalMetadata = value?.[1];

packages/react/src/dictionaries/getEntryAndMetadata.ts

@@ -1,7 +1,7 @@
 import { DictionaryEntry, MetaEntry } from '../types/types';
 
 export default function getEntryAndMetadata(value: DictionaryEntry): {
-  entry: string;
+  entry: string | null;
   metadata?: MetaEntry;
 } {
   if (Array.isArray(value)) {

packages/react/src/dictionaries/getSubtree.ts

@@ -1,6 +1,12 @@
 import { Dictionary, DictionaryEntry } from '../types/types';
 import { get, set } from './indexDict';
 
+/**
+ * @description A function that gets a subtree from a dictionary
+ * @param dictionary - dictionary to get the subtree from
+ * @param id - id of the subtree to get
+ * @returns
+ */
 export function getSubtree<T extends Dictionary>({
   dictionary,
   id,

packages/react/src/dictionaries/indexDict.ts

@@ -5,7 +5,7 @@ import { Dictionary, DictionaryEntry } from '../types/types';
  * @param id - id of the value to get
  */
 export function get(dictionary: Dictionary, id: string | number) {
-  if (dictionary == null) {
+  if (dictionary === undefined) {
     throw new Error('Cannot index into an undefined dictionary');
   }
   if (Array.isArray(dictionary)) {

packages/react/src/dictionaries/injectEntry.ts

@@ -22,7 +22,7 @@ function isDangerousKey(key: string): boolean {
  * @param sourceDictionary - The source dictionary to model the new dictionary after
  */
 export function injectEntry(
-  dictionaryEntry: DictionaryEntry,
+  dictionaryEntry: DictionaryEntry | null,
   dictionary: Dictionary | DictionaryEntry,
   id: string,
   sourceDictionary: Dictionary | DictionaryEntry
@@ -42,7 +42,7 @@ export function injectEntry(
   dictionary ||= {};
   for (const key of keys.slice(0, -1)) {
     // Create new value if it doesn't exist
-    if (get(dictionary, key) == null) {
+    if (get(dictionary, key) === undefined) {
       set(
         dictionary,
         key,

packages/react/src/dictionaries/injectFallbacks.ts

@@ -15,7 +15,7 @@ export function injectFallbacks(
   dictionary: Dictionary,
   translationsDictionary: Dictionary,
   missingTranslations: {
-    source: string;
+    source: string | null;
     metadata: { $id: string; $context?: string; $_hash: string };
   }[],
   prefixToRemove: string = ''

packages/react/src/dictionaries/injectHashes.ts

@@ -22,7 +22,7 @@ export function injectHashes(
       if (!metadata?.$_hash) {
         metadata ||= {};
         metadata.$_hash = hashSource({
-          source: entry,
+          source: entry || '',
           ...(metadata?.$context && { context: metadata.$context }),
           id: wholeId,
           dataFormat: 'ICU',

packages/react/src/dictionaries/injectTranslations.ts

@@ -16,7 +16,7 @@ export function injectTranslations(
   translationsDictionary: Dictionary,
   translations: Translations,
   missingTranslations: {
-    source: string;
+    source: string | null;
     metadata: { $id: string; $context?: string; $_hash: string };
   }[],
   prefixToRemove: string = ''

packages/react/src/dictionaries/isDictionaryEntry.ts

@@ -12,8 +12,8 @@ export function isDictionaryEntry(
     return false;
   }
 
-  // Check if it's a string (Entry)
-  if (typeof value === 'string') {
+  // Check if it's an entry
+  if (value === null || typeof value !== 'object') {
     return true;
   }
 
@@ -25,7 +25,7 @@ export function isDictionaryEntry(
     }
 
     // First element must be a string (Entry)
-    if (typeof value[0] !== 'string') {
+    if (typeof value[0] === 'object' && value[0] !== null) {
       return false;
     }
 

packages/react/src/dictionaries/mergeDictionaries.ts

@@ -2,12 +2,6 @@ import { Dictionary, DictionaryEntry } from '../types/types';
 import { get } from './indexDict';
 import { isDictionaryEntry } from './isDictionaryEntry';
 
-const isPrimitiveOrArray = (value: unknown): boolean =>
-  typeof value === 'string' || Array.isArray(value);
-
-const isObjectDictionary = (value: unknown): boolean =>
-  typeof value === 'object' && value !== null && !Array.isArray(value);
-
 export default function mergeDictionaries(
   defaultLocaleDictionary: Dictionary,
   localeDictionary: Dictionary
@@ -31,23 +25,23 @@ export default function mergeDictionaries(
   const mergedDictionary: Dictionary = {
     ...Object.fromEntries(
       Object.entries(defaultLocaleDictionary).filter(([, value]) =>
-        isPrimitiveOrArray(value)
+        isDictionaryEntry(value)
       )
     ),
     ...Object.fromEntries(
       Object.entries(localeDictionary).filter(([, value]) =>
-        isPrimitiveOrArray(value)
+        isDictionaryEntry(value)
       )
     ),
   };
 
   // Get nested dictionaries
   const defaultDictionaryKeys = Object.entries(defaultLocaleDictionary)
-    .filter(([, value]) => isObjectDictionary(value))
+    .filter(([, value]) => !isDictionaryEntry(value))
     .map(([key]) => key);
 
   const localeDictionaryKeys = Object.entries(localeDictionary)
-    .filter(([, value]) => isObjectDictionary(value))
+    .filter(([, value]) => !isDictionaryEntry(value))
     .map(([key]) => key);
 
   // Merge nested dictionaries recursively

packages/react/src/provider/hooks/translation/useCreateInternalUseTranslationsFunction.ts

@@ -79,9 +79,8 @@ export default function useCreateInternalUseTranslationsFunction(
         isValidDictionaryEntry(dictionaryTranslation)
       ) {
         const { entry } = getEntryAndMetadata(dictionaryTranslation);
-        return renderMessage(entry, [locale, defaultLocale]);
+        return renderMessage(entry || '', [locale, defaultLocale]);
       }
-
       // ----- CHECK TRANSLATIONS ----- //
 
       let translationEntry = translations?.[id];
@@ -118,6 +117,11 @@ export default function useCreateInternalUseTranslationsFunction(
       // ----- TRANSLATE ON DEMAND ----- //
       // development only
 
+      // Don't translate non-string entries
+      if (typeof entry !== 'string') {
+        return renderMessage(entry, [defaultLocale]);
+      }
+
       // Translate Content
       registerIcuForTranslation({
         source: entry,

packages/react/src/provider/hooks/translation/useCreateInternalUseTranslationsObjFunction.ts

@@ -118,16 +118,18 @@ export function useCreateInternalUseTranslationsObjFunction(
         untranslatedEntries,
         idWithParent
       );
-
       // (3) For each untranslated entry, translate it
       if (developmentApiEnabled) {
         Promise.allSettled(
           untranslatedEntries.map(
             async (
               untranslatedEntry
-            ): Promise<[string, TranslatedChildren]> => {
+            ): Promise<[string, TranslatedChildren | null]> => {
               const { source, metadata } = untranslatedEntry;
               const id = metadata?.$id;
+              if (typeof source !== 'string') {
+                return [id, source];
+              }
               return [
                 id,
                 await registerIcuForTranslation({

packages/react/src/types/types.ts

@@ -28,7 +28,7 @@ export type TaggedChildren = TaggedChild[] | TaggedChild;
 /**
  * For dictionaries, we have Entry and MetaEntry
  */
-export type Entry = string;
+export type Entry = string | null;
 export type MetaEntry = {
   $context?: string;
   $_hash?: string;