@awsless/i18n 0.0.9 → 0.0.10

package/README.MD

@@ -1,18 +1,15 @@
 # AI-generated internationalization made easy
 
-The `@awsless/i18n` package is a Vite plugin that automatically translates your text during build time using AI or any other tool you prefer. The plugin will inline the translations so you don't have to worry about loading the translations at the right time.
+The `@awsless/i18n` package is a Vite plugin that automatically translates your text during build time using AI or any other tool you prefer. The plugin will inline the translations so you don't have to worry about loading the translations at the right time. This means, switching the locale will instantly switch all your translated text on the page.
 
 ## Features
 
 - Automatic text translation
 - Inlines translations
-- Extremely lightweight (373 bytes uncompressed 🔥)
+- Extremely lightweight (431 bytes uncompressed 🔥)
+- Instant locale switch
 - Svelte 5 support
 
-## Todo's
-
-- Create a CLI command to find the text that needs to be translated & translate it, so that we can remove that part from the vite plugin.
-
 ## Setup
 
 Install with (NPM):
@@ -25,6 +22,7 @@ npm i @awsless/i18n
 
 ```ts
 import { i18n, ai } from '@awsless/i18n'
+import { openai } from '@ai-sdk/openai'
 
 export defineConfig({
   plugins: [
@@ -65,7 +63,7 @@ lang.t.get(`${count} count`, {
 })
 ```
 
-To change the locale that is being rendered simply set the `lang.locale` property.
+To change the locale that is being rendered simply change the `lang.locale` property.
 
 ```ts
 import { lang } from '@awsless/i18n/svelte'

package/dist/index.cjs

@@ -55,32 +55,32 @@ var Cache = class {
   constructor(data = {}) {
     this.data = data;
   }
-  set(original, locale, translation) {
-    if (!this.data[original]) {
-      this.data[original] = {};
+  set(source, locale, translation) {
+    if (!this.data[source]) {
+      this.data[source] = {};
     }
-    if (!this.data[original][locale]) {
-      this.data[original][locale] = translation;
+    if (!this.data[source][locale]) {
+      this.data[source][locale] = translation;
     }
   }
-  get(original, locale) {
-    return this.data[original]?.[locale];
+  get(source, locale) {
+    return this.data[source]?.[locale];
   }
-  has(original, locale) {
-    return typeof this.get(original, locale) === "string";
+  has(source, locale) {
+    return typeof this.get(source, locale) === "string";
   }
-  delete(original, locale) {
-    if (this.data[original]?.[locale]) {
-      delete this.data[original][locale];
+  delete(source, locale) {
+    if (this.data[source]?.[locale]) {
+      delete this.data[source][locale];
     }
-    if (this.data[original] && Object.keys(this.data[original]).length === 0) {
-      delete this.data[original];
+    if (this.data[source] && Object.keys(this.data[source]).length === 0) {
+      delete this.data[source];
     }
   }
   *entries() {
-    for (const [original, locales] of Object.entries(this.data)) {
+    for (const [source, locales] of Object.entries(this.data)) {
       for (const [locale, translation] of Object.entries(locales)) {
-        yield { original, locale, translation };
+        yield { source, locale, translation };
       }
     }
   }
@@ -90,21 +90,21 @@ var Cache = class {
 };
 
 // src/diff.ts
-var findNewTranslations = (cache, originals, locales) => {
+var findNewTranslations = (cache, sources, locales) => {
   const list = [];
-  for (const original of originals) {
+  for (const source of sources) {
     for (const locale of locales) {
-      if (!cache.has(original, locale)) {
-        list.push({ original, locale });
+      if (!cache.has(source, locale)) {
+        list.push({ source, locale });
       }
     }
   }
   return list;
 };
-var removeUnusedTranslations = (cache, originals, locales) => {
+var removeUnusedTranslations = (cache, sources, locales) => {
   for (const item of cache.entries()) {
-    if (!locales.includes(item.locale) || !originals.includes(item.original)) {
-      cache.delete(item.original, item.locale);
+    if (!locales.includes(item.locale) || !sources.includes(item.source)) {
+      cache.delete(item.source, item.locale);
     }
   }
 };
@@ -125,10 +125,7 @@ var findSvelteTranslatable = (code) => {
     css: false
   });
   const enter = (node) => {
-    if (
-      //
-      node.type === "TaggedTemplateExpression" && node.tag.type === "MemberExpression" && node.tag.object.type === "Identifier" && node.tag.object.name === "lang" && node.tag.property.type === "Identifier" && node.tag.property.name === "t" && node.quasi.type === "TemplateLiteral" && node.quasi.loc
-    ) {
+    if (node.type === "TaggedTemplateExpression" && node.tag.type === "MemberExpression" && node.tag.object.type === "Identifier" && node.tag.object.name === "lang" && node.tag.property.type === "Identifier" && node.tag.property.name === "t" && node.quasi.type === "TemplateLiteral" && node.quasi.loc) {
       const start = node.quasi.loc.start;
       const end = node.quasi.loc.end;
       const content = code.substring(
@@ -204,16 +201,16 @@ var createI18nPlugin = (props) => {
     async buildStart() {
       const cwd = process.cwd();
       this.info("Finding all translatable text...");
-      const originals = await findTranslatable(cwd);
+      const sourceTexts = await findTranslatable(cwd);
       cache = await loadCache(cwd);
-      removeUnusedTranslations(cache, originals, props.locales);
-      const newOriginals = findNewTranslations(cache, originals, props.locales);
-      if (newOriginals.length > 0) {
-        this.info(`Translating ${newOriginals.length} new texts.`);
-        const translations = await props.translate(props.default ?? "en", newOriginals);
+      removeUnusedTranslations(cache, sourceTexts, props.locales);
+      const newSourceTexts = findNewTranslations(cache, sourceTexts, props.locales);
+      if (newSourceTexts.length > 0) {
+        this.info(`Translating ${newSourceTexts.length} new texts.`);
+        const translations = await props.translate(props.default ?? "en", newSourceTexts);
         this.info(`Translated ${translations.length} texts.`);
         for (const item of translations) {
-          cache.set(item.original, item.locale, item.translation);
+          cache.set(item.source, item.locale, item.translation);
         }
       }
       await saveCache(cwd, cache);
@@ -223,10 +220,10 @@ var createI18nPlugin = (props) => {
       let replaced = false;
       if (code.includes("lang.t`")) {
         for (const item of cache.entries()) {
-          code = code.replaceAll(`lang.t\`${item.original}\``, () => {
+          code = code.replaceAll(`lang.t\`${item.source}\``, () => {
             replaced = true;
-            return `lang.t.get(\`${item.original}\`, {${props.locales.map((locale) => {
-              return `"${locale}":\`${cache.get(item.original, locale)}\``;
+            return `lang.t.get(\`${item.source}\`, {${props.locales.map((locale) => {
+              return `"${locale}":\`${cache.get(item.source, locale)}\``;
             }).join(",")}})`;
           });
         }
@@ -255,7 +252,7 @@ var ai = (props) => {
           maxTokens: props.maxTokens,
           schema: import_zod.z.object({
             translations: import_zod.z.object({
-              original: import_zod.z.string(),
+              source: import_zod.z.string(),
               locale: import_zod.z.string(),
               translation: import_zod.z.string()
             }).array()

package/dist/index.d.cts

@@ -2,32 +2,36 @@ import { Plugin } from 'vite';
 import { LanguageModel } from 'ai';
 
 type Translator = (defaultLocale: string, list: {
-    original: string;
+    source: string;
     locale: string;
 }[]) => TranslationResponse[] | Promise<TranslationResponse[]>;
 type TranslationResponse = {
-    original: string;
+    source: string;
     locale: string;
     translation: string;
 };
 type I18nPluginProps = {
-    /** The default locale that your original text is writen in. */
+    /** The original language your source text is written in.
+     * @default "en"
+     */
     default?: string;
-    /** A list of locales that you want your text translated too. */
+    /** The list of target locales to translate your text into. */
     locales: string[];
-    /** The callback that is responsible for translating the text. */
+    /** Function that performs the translation of a given text. */
     translate: Translator;
 };
 declare const createI18nPlugin: (props: I18nPluginProps) => Plugin;
 
 type AiTranslationProps = {
-    /** The maximum number of tokens that can be generated in the chat completion. */
+    /** The maximum number of tokens allowed in the AI's response. */
     maxTokens: number;
-    /** ID of the model to use. */
+    /** The language model to use for translations (e.g., gpt-4, gpt-3.5-turbo). */
     model: LanguageModel;
-    /**  */
+    /** Number of text entries to translate in a single batch.
+     * @default 1000
+     */
     batchSize?: number;
-    /** The rules that the ai should follow. It will be added to the prompt. */
+    /** Custom translation guidelines for the AI. These are injected into the prompt. */
     rules?: string[];
 };
 declare const ai: (props: AiTranslationProps) => Translator;

package/dist/index.d.ts

@@ -2,32 +2,36 @@ import { Plugin } from 'vite';
 import { LanguageModel } from 'ai';
 
 type Translator = (defaultLocale: string, list: {
-    original: string;
+    source: string;
     locale: string;
 }[]) => TranslationResponse[] | Promise<TranslationResponse[]>;
 type TranslationResponse = {
-    original: string;
+    source: string;
     locale: string;
     translation: string;
 };
 type I18nPluginProps = {
-    /** The default locale that your original text is writen in. */
+    /** The original language your source text is written in.
+     * @default "en"
+     */
     default?: string;
-    /** A list of locales that you want your text translated too. */
+    /** The list of target locales to translate your text into. */
     locales: string[];
-    /** The callback that is responsible for translating the text. */
+    /** Function that performs the translation of a given text. */
     translate: Translator;
 };
 declare const createI18nPlugin: (props: I18nPluginProps) => Plugin;
 
 type AiTranslationProps = {
-    /** The maximum number of tokens that can be generated in the chat completion. */
+    /** The maximum number of tokens allowed in the AI's response. */
     maxTokens: number;
-    /** ID of the model to use. */
+    /** The language model to use for translations (e.g., gpt-4, gpt-3.5-turbo). */
     model: LanguageModel;
-    /**  */
+    /** Number of text entries to translate in a single batch.
+     * @default 1000
+     */
     batchSize?: number;
-    /** The rules that the ai should follow. It will be added to the prompt. */
+    /** Custom translation guidelines for the AI. These are injected into the prompt. */
     rules?: string[];
 };
 declare const ai: (props: AiTranslationProps) => Translator;

package/dist/index.js

@@ -18,32 +18,32 @@ var Cache = class {
   constructor(data = {}) {
     this.data = data;
   }
-  set(original, locale, translation) {
-    if (!this.data[original]) {
-      this.data[original] = {};
+  set(source, locale, translation) {
+    if (!this.data[source]) {
+      this.data[source] = {};
     }
-    if (!this.data[original][locale]) {
-      this.data[original][locale] = translation;
+    if (!this.data[source][locale]) {
+      this.data[source][locale] = translation;
     }
   }
-  get(original, locale) {
-    return this.data[original]?.[locale];
+  get(source, locale) {
+    return this.data[source]?.[locale];
   }
-  has(original, locale) {
-    return typeof this.get(original, locale) === "string";
+  has(source, locale) {
+    return typeof this.get(source, locale) === "string";
   }
-  delete(original, locale) {
-    if (this.data[original]?.[locale]) {
-      delete this.data[original][locale];
+  delete(source, locale) {
+    if (this.data[source]?.[locale]) {
+      delete this.data[source][locale];
     }
-    if (this.data[original] && Object.keys(this.data[original]).length === 0) {
-      delete this.data[original];
+    if (this.data[source] && Object.keys(this.data[source]).length === 0) {
+      delete this.data[source];
     }
   }
   *entries() {
-    for (const [original, locales] of Object.entries(this.data)) {
+    for (const [source, locales] of Object.entries(this.data)) {
       for (const [locale, translation] of Object.entries(locales)) {
-        yield { original, locale, translation };
+        yield { source, locale, translation };
       }
     }
   }
@@ -53,21 +53,21 @@ var Cache = class {
 };
 
 // src/diff.ts
-var findNewTranslations = (cache, originals, locales) => {
+var findNewTranslations = (cache, sources, locales) => {
   const list = [];
-  for (const original of originals) {
+  for (const source of sources) {
     for (const locale of locales) {
-      if (!cache.has(original, locale)) {
-        list.push({ original, locale });
+      if (!cache.has(source, locale)) {
+        list.push({ source, locale });
       }
     }
   }
   return list;
 };
-var removeUnusedTranslations = (cache, originals, locales) => {
+var removeUnusedTranslations = (cache, sources, locales) => {
   for (const item of cache.entries()) {
-    if (!locales.includes(item.locale) || !originals.includes(item.original)) {
-      cache.delete(item.original, item.locale);
+    if (!locales.includes(item.locale) || !sources.includes(item.source)) {
+      cache.delete(item.source, item.locale);
     }
   }
 };
@@ -88,10 +88,7 @@ var findSvelteTranslatable = (code) => {
     css: false
   });
   const enter = (node) => {
-    if (
-      //
-      node.type === "TaggedTemplateExpression" && node.tag.type === "MemberExpression" && node.tag.object.type === "Identifier" && node.tag.object.name === "lang" && node.tag.property.type === "Identifier" && node.tag.property.name === "t" && node.quasi.type === "TemplateLiteral" && node.quasi.loc
-    ) {
+    if (node.type === "TaggedTemplateExpression" && node.tag.type === "MemberExpression" && node.tag.object.type === "Identifier" && node.tag.object.name === "lang" && node.tag.property.type === "Identifier" && node.tag.property.name === "t" && node.quasi.type === "TemplateLiteral" && node.quasi.loc) {
       const start = node.quasi.loc.start;
       const end = node.quasi.loc.end;
       const content = code.substring(
@@ -167,16 +164,16 @@ var createI18nPlugin = (props) => {
     async buildStart() {
       const cwd = process.cwd();
       this.info("Finding all translatable text...");
-      const originals = await findTranslatable(cwd);
+      const sourceTexts = await findTranslatable(cwd);
       cache = await loadCache(cwd);
-      removeUnusedTranslations(cache, originals, props.locales);
-      const newOriginals = findNewTranslations(cache, originals, props.locales);
-      if (newOriginals.length > 0) {
-        this.info(`Translating ${newOriginals.length} new texts.`);
-        const translations = await props.translate(props.default ?? "en", newOriginals);
+      removeUnusedTranslations(cache, sourceTexts, props.locales);
+      const newSourceTexts = findNewTranslations(cache, sourceTexts, props.locales);
+      if (newSourceTexts.length > 0) {
+        this.info(`Translating ${newSourceTexts.length} new texts.`);
+        const translations = await props.translate(props.default ?? "en", newSourceTexts);
         this.info(`Translated ${translations.length} texts.`);
         for (const item of translations) {
-          cache.set(item.original, item.locale, item.translation);
+          cache.set(item.source, item.locale, item.translation);
         }
       }
       await saveCache(cwd, cache);
@@ -186,10 +183,10 @@ var createI18nPlugin = (props) => {
       let replaced = false;
       if (code.includes("lang.t`")) {
         for (const item of cache.entries()) {
-          code = code.replaceAll(`lang.t\`${item.original}\``, () => {
+          code = code.replaceAll(`lang.t\`${item.source}\``, () => {
             replaced = true;
-            return `lang.t.get(\`${item.original}\`, {${props.locales.map((locale) => {
-              return `"${locale}":\`${cache.get(item.original, locale)}\``;
+            return `lang.t.get(\`${item.source}\`, {${props.locales.map((locale) => {
+              return `"${locale}":\`${cache.get(item.source, locale)}\``;
             }).join(",")}})`;
           });
         }
@@ -218,7 +215,7 @@ var ai = (props) => {
           maxTokens: props.maxTokens,
           schema: z.object({
             translations: z.object({
-              original: z.string(),
+              source: z.string(),
               locale: z.string(),
               translation: z.string()
             }).array()

package/dist/svelte.svelte.cjs

@@ -34,12 +34,29 @@ var t = $derived.by(() => {
   return api;
 });
 var lang = {
-  set locale(v) {
-    locale = v;
-  },
+  /** Get the current locale.
+   *
+   * @example
+   * console.log(lang.locale)
+   */
   get locale() {
     return locale;
   },
+  /** To change the locale that is being rendered simply change this property.
+   *
+   * @example
+   * lang.locale = 'jp'
+   */
+  set locale(v) {
+    locale = v;
+  },
+  /** Translate helper for translating template strings.
+   * The i18n Vite plugin will find all instances where you want text
+   * to be translated and automatically translate your text during build time.
+   *
+   * @example
+   * lang.t`Hello world!`
+   */
   get t() {
     return t;
   }

package/dist/svelte.svelte.d.cts

@@ -1,5 +1,17 @@
 declare const lang: {
+    /** Get the current locale.
+     *
+     * @example
+     * console.log(lang.locale)
+     */
     locale: string;
+    /** Translate helper for translating template strings.
+     * The i18n Vite plugin will find all instances where you want text
+     * to be translated and automatically translate your text during build time.
+     *
+     * @example
+     * lang.t`Hello world!`
+     */
     readonly t: (template: TemplateStringsArray, ...args: Array<string | number | {
         toString(): string;
     }>) => string;

package/dist/svelte.svelte.d.ts

@@ -1,5 +1,17 @@
 declare const lang: {
+    /** Get the current locale.
+     *
+     * @example
+     * console.log(lang.locale)
+     */
     locale: string;
+    /** Translate helper for translating template strings.
+     * The i18n Vite plugin will find all instances where you want text
+     * to be translated and automatically translate your text during build time.
+     *
+     * @example
+     * lang.t`Hello world!`
+     */
     readonly t: (template: TemplateStringsArray, ...args: Array<string | number | {
         toString(): string;
     }>) => string;

package/dist/svelte.svelte.js

@@ -10,12 +10,29 @@ var t = $derived.by(() => {
   return api;
 });
 var lang = {
-  set locale(v) {
-    locale = v;
-  },
+  /** Get the current locale.
+   *
+   * @example
+   * console.log(lang.locale)
+   */
   get locale() {
     return locale;
   },
+  /** To change the locale that is being rendered simply change this property.
+   *
+   * @example
+   * lang.locale = 'jp'
+   */
+  set locale(v) {
+    locale = v;
+  },
+  /** Translate helper for translating template strings.
+   * The i18n Vite plugin will find all instances where you want text
+   * to be translated and automatically translate your text during build time.
+   *
+   * @example
+   * lang.t`Hello world!`
+   */
   get t() {
     return t;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awsless/i18n",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "license": "MIT",
   "type": "module",
   "keywords": [