fix: i18next typings (close #25) (#29)

.changeset/honest-lizards-nail.md

@@ -0,0 +1,5 @@
+---
+"@astrolicious/i18n": patch
+---
+
+Fixes an case where i18next typings would not be correct

docs/src/content/docs/getting-started/installation.mdx

@@ -4,8 +4,9 @@ title: Installation
 
 import { Tabs, TabItem } from '@astrojs/starlight/components';
 
-:::caution
-This package requires `astro` to be at least on version `4.4.11`.
+:::caution[Prerequisites]
+- `astro` must be at least on version `4.4.11`
+- `tsconfig.json` `compilerOptions.strict` should be set to `true`. If you're using Astro tsconfig presets, use either `astro/tsconfigs/strict` or `astro/tsconfigs/strictest`
 :::
 
 ## Automatic installation

package/package.json

@@ -38,10 +38,7 @@
 		"./components/I18nClient.astro": "./assets/components/I18nClient.astro",
 		"./components/I18nHead.astro": "./assets/components/I18nHead.astro"
 	},
-	"files": [
-		"dist",
-		"assets"
-	],
+	"files": ["dist", "assets"],
 	"scripts": {
 		"dev": "tsup --watch",
 		"build": "tsup"

package/src/i18next/index.ts

@@ -33,13 +33,13 @@ export const handleI18next = defineUtility("astro:config:setup")(
 			)}" directory`,
 		);
 
-		const { namespaces, importsData } = getNamespaces(
+		const { namespaces } = getNamespaces(
 			paths.defaultLocalesDir,
 			options.defaultNamespace,
 			logger,
 		);
 		const resources = getResources(logger, options, paths.localesDir);
-		injectTypes(params, options, importsData, paths.defaultLocalesDir);
+		injectTypes(params, options, resources[options.defaultLocale] ?? {});
 
 		return {
 			namespaces,

package/src/i18next/namespaces.ts

@@ -33,7 +33,6 @@ export const getNamespaces = (
 	}
 
 	return {
-		importsData,
 		namespaces,
 	};
 };

package/src/i18next/types.ts

@@ -1,38 +1,20 @@
-import { join, relative } from "node:path";
-import { fileURLToPath } from "node:url";
 import { addDts, defineUtility } from "astro-integration-kit";
-import { normalizePath } from "vite";
 import type { Options } from "../options.js";
-import type { getNamespaces } from "./namespaces.js";
+import type { I18nextConfig } from "../types.js";
 
 export const injectTypes = defineUtility("astro:config:setup")(
 	(
 		params,
 		{ defaultNamespace }: Options,
-		importsData: ReturnType<typeof getNamespaces>["importsData"],
-		defaultLocalesDir: string,
+		resources: I18nextConfig["resources"][string],
 	) => {
-		const relativeLocalesPrefix = `${normalizePath(
-			relative(
-				fileURLToPath(new URL("./.astro/", params.config.root)),
-				defaultLocalesDir,
-			),
-		)}/`;
-
 		const content = `
+	type Resources = ${JSON.stringify(resources)}
+	
     declare module "i18next" {
       interface CustomTypeOptions {
         defaultNS: "${defaultNamespace}";
-        resources: {
-          ${importsData
-						.map(
-							({ namespaceName, fileName }) =>
-								`"${namespaceName}": typeof import("${normalizePath(
-									join(relativeLocalesPrefix, fileName),
-								)}");`,
-						)
-						.join("\n")}
-        }
+        resources: Resources;
       }
     }
     export {}

playground/src/locales/en/home.json

@@ -1,4 +1,5 @@
 {
 	"title": "Home",
-	"description": "This is the home, see {{ value }}"
+	"description": "This is the home, see {{value}}",
+	"array": ["a", "b", "c"]
 }

playground/src/locales/fr/home.json

@@ -1,4 +1,5 @@
 {
 	"title": "Accueil",
-	"description": "Voici l'accueil, voir {{ value }}"
+	"description": "Voici l'accueil, voir {{value}}",
+	"array": ["a", "b", "c"]
 }

playground/src/routes/index.astro

@@ -6,6 +6,7 @@ const title = t("home:title");
 console.log(getLocalePath("/about", null, "fr"));
 console.log(getLocalePath("/abc", null, "en"));
 console.log(getLocalePath("/def", null, "fr"));
+console.log(t("home:array", { returnObjects: true }));
 ---
 
 <Layout {title}>