@genesislcap/foundation-i18n 14.408.0 → 14.409.0

package/README.md

@@ -1,308 +1,21 @@
-# Genesis Foundation i18n
+# @genesislcap/foundation-i18n
 
-The `@genesislcap/foundation-i18n` package provides a collection of i18n services and utilities for Genesis applications. It leverages the power of [i18next](https://www.i18next.com/) to enable seamless internationalization and localization.
+Documentation for this package is published on the Genesis docs site:
 
-### API Documentation
+**Docs: [Internationalization](https://docs.genesis.global/docs/develop/client-capabilities/internationalization/)**
 
-For more detailed information on API and configurations, please refer to the [API documentation](docs/api/index.md) in the `docs/api` directory.
+## Installation
 
-## Features
-
-- **Easy integration**: Quick setup with modern JavaScript frameworks and libraries.
-- **Dynamic language switching**: Change languages on the fly without reloading the application.
-- **Module federation support**: Share and load translations across different micro-frontends or modules dynamically.
-- **Dependency injection**: Integrate i18n services into your components using dependency injection.
-
-## Project Structure
-
-- `src/`: Source code for the library, including the core `i18n` functionality and utility functions.
-  - `i18n/`: Core internationalization logic and configurations.
-  - `utils/`: Utility functions supporting the core features.
-- `docs/`: Documentation, including API details and usage guides.
-
-## Getting Started
-
-### Installation
-
-To enable this module in your application, follow the steps below.
-
-1. Add `@genesislcap/foundation-i18n` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 
 ```json
 {
   "dependencies": {
     "@genesislcap/foundation-i18n": "latest"
-  },
-}
-```
-
-### I18n Setup
-
-Import the necessary modules from `@genesislcap/foundation-i18n` and configure your internationalization settings.
-
-```typescript
-import { defaultI18nextConfig, I18nextConfig } from '@genesislcap/foundation-i18n';
-
-// Tip: Extend or modify the defaultI18nextConfig as needed.
-Registration.instance<I18nextConfig>(I18nextConfig, {
-  ...defaultI18nextConfig,
-  lng: 'pt', // en is the default language but you can change it here or by tweaking the defaultI18nextConfig
-  resources: {
-    en: {
-      translation: {
-        Home: 'Home',
-        Admin: 'Admin',
-        Reporting: 'Reporting',
-        Notifications: 'Notifications',
-        ['Features Lab']: 'Features Lab',
-      },
-    },
-    pt: {
-      translation: {
-        Home: 'Início',
-        Admin: 'Administração',
-        Reporting: 'Relatórios',
-        Notifications: 'Notificações',
-        ['Features Lab']: 'Laboratório de Funcionalidades',
-      },
-    },
-  },
-});
-```
-
-This could live in your application’s entry point, such as `main.ts` or a similar file.
-
-### I18n Setup (JSON)
-
-You can also use a JSON file to store your translations and load them dynamically:
-
-```json
-{
-  "en": {
-    "translation": {
-      "Home": "Home",
-      "Admin": "Admin",
-      "Reporting": "Reporting",
-      "Notifications": "Notifications",
-      "Features Lab": "Features Lab"
-    }
-  },
-  "pt": {
-    "translation": {
-      "Home": "Início",
-      "Admin": "Administração",
-      "Reporting": "Relatórios",
-      "Notifications": "Notificações",
-      "Features Lab": "Laboratório de Funcionalidades"
-    }
   }
 }
 ```
 
-Then, import the JSON file and use it in your configuration:
-
-```typescript
-import { defaultI18nextConfig, I18nextConfig } from '@genesislcap/foundation-i18n';
-import translations from './translations.json';
-
-Registration.instance<I18nextConfig>(I18nextConfig, {
-  ...defaultI18nextConfig,
-  lng: 'en',
-  resources: translations,
-});
-```
-
-### `addResources` 
-
-> :warning: **This will overwrite previously set resources.**
-
-You can also add resources dynamically and when necessary. 
-
-This is useful when you have a large number of translations or when you need to load translations from a different source or at a different time from the initial setup.
-
-```typescript
-import { I18next } from '@genesislcap/foundation-i18n';
-import translations from './translations.json';
-
-export class MyExampleClass {
-  @I18next i18next!: I18next;
-
-  addResources() {
-    this.i18next.addResources(translations);
-  }
-}
-```
-
-### Usage
-
-`foundation-i18n` also supports changing languages dynamically, allowing your application to switch languages without needing to reload:
-
-```typescript
-import { I18next } from '@genesislcap/foundation-i18n';
-import { customElement, FASTElement, html } from '@microsoft/fast-element';
-import translations from './translations.json';
-
-@customElement({
-  name: 'my-example-component',
-  template: html`
-    <zero-button @click=${() => addResources()}>Add Translation Resources</zero-button>
-    <zero-button @click=${() => switchLanguage()}>Switch between PT and EN</zero-button>
-    <zero-button @click=${() => translateWords()}>Translate i18n Resource Words</zero-button>
-  `,
-})
-export class MyExampleComponent extends FASTElement {
-  @I18next i18next!: I18next;
-
-  addResources() {
-    this.i18next.addResources(translations);
-  }
-
-  switchLanguage() {
-    if (this.i18next.language === 'pt') {
-      this.i18next.changeLanguage('en');
-    } else {
-      this.i18next.changeLanguage('pt');
-    }
-  }
-
-  translateWords() {
-    console.log(this.i18next.t('Home')); // if pt, it will log Início, if en, it will log Home
-    console.log(this.i18next.t('Admin')); // if pt, it will log Administração, if en, it will log Admin
-    console.log(this.i18next.t('Reporting')); // if pt, it will log Relatórios, if en, it will log Reporting
-    console.log(this.i18next.t('Notifications')); // if pt, it will log Notificações, if en, it will log Notifications
-    console.log(this.i18next.t('Features Lab')); // if pt, it will log Laboratório de Funcionalidades, if en, it will log Features Lab
-  }
-}
-```
-
-### Integrating with Other Libraries
-
-#### Angular Example
-
-To integrate `@genesislcap/foundation-i18n` with an Angular application, you can configure `i18next` in a service and use it throughout your components.
-
-**i18n.service.ts**
-
-```typescript
-import { Injectable } from '@angular/core';
-import { defaultI18nextConfig, I18next } from '@genesislcap/foundation-i18n';
-import translations from './translations.json';
-import { DI } from '@microsoft/fast-element';
-
-@Injectable({
-  providedIn: 'root',
-})
-export class I18nService {
-  private container = DI.getOrCreateDOMContainer();
-  private i18n = this.container.get(I18nService);
-
-  constructor() {
-    this.i18n.init({
-      ...defaultI18nextConfig,
-      lng: 'en',
-      resources: translations,
-    });
-  }
-
-  switchLanguage() {
-    const newLanguage = this.i18n.language === 'en' ? 'pt' : 'en';
-    this.i18n.changeLanguage(newLanguage);
-  }
-
-  translate(key: string): string {
-    return this.i18n.t(key);
-  }
-}
-```
-
-**app.component.ts**
-
-```typescript
-import { Component } from '@angular/core';
-import { I18nService } from './i18n.service';
-
-@Component({
-  selector: 'app-root',
-  template: `
-    <button (click)="switchLanguage()">Switch Language</button>
-    <p>{{ translate('Home') }}</p>
-    <p>{{ translate('Admin') }}</p>
-    <p>{{ translate('Reporting') }}</p>
-  `,
-})
-export class AppComponent {
-  constructor(private i18nService: I18nService) {}
-
-  switchLanguage() {
-    this.i18nService.switchLanguage();
-  }
-
-  translate(key: string): string {
-    return this.i18nService.translate(key);
-  }
-}
-```
-
-#### React Example
-
-To integrate `@genesislcap/foundation-i18n` with a React application, you can create a separate service for handling `i18next` similar to how you would create other services.
-
-**i18nService.js**
-
-```javascript
-import { defaultI18nextConfig, I18next } from '@genesislcap/foundation-i18n';
-import { DI } from '@microsoft/fast-foundation';
-import translations from './translations.json';
-
-class I18nService {
-  private container = DI.getOrCreateDOMContainer();
-  private i18n: Connect = this.container.get(I18next);
-
-  constructor() {
-    this.i18n.init({
-      ...defaultI18nextConfig,
-      lng: 'en',
-      resources: translations,
-    });
-  }
-
-  switchLanguage() {
-    const newLanguage = this.i18n.language === 'en' ? 'pt' : 'en';
-    this.i18n.changeLanguage(newLanguage);
-  }
-
-  translate(key) {
-    return this.i18n.t(key);
-  }
-}
-
-export const i18nService = new I18nService();
-```
-
-**App.js**
-
-```jsx
-import React from 'react';
-import { i18nService } from './i18nService';
-
-const App = () => {
-  const switchLanguage = () => {
-    i18nService.switchLanguage();
-  };
-
-  return (
-    <div>
-      <button onClick={switchLanguage}>Switch Language</button>
-      <p>{i18nService.translate('Home')}</p>
-      <p>{i18nService.translate('Admin')}</p>
-      <p>{i18nService.translate('Reporting')}</p>
-    </div>
-  );
-};
-
-export default App;
-```
-
 ## License
 
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-i18n",
   "description": "Foundation components and services for Internationalization (i18n) support",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -33,15 +33,15 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0"
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.408.0",
+    "@genesislcap/foundation-logger": "14.409.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.50.0",
     "i18next": "^20.3.0"
@@ -54,5 +54,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

package/docs/api/foundation-i18n.defaulti18next._constructor_.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-i18n](./foundation-i18n.md) &gt; [DefaultI18next](./foundation-i18n.defaulti18next.md) &gt; [(constructor)](./foundation-i18n.defaulti18next._constructor_.md)
-
-## DefaultI18next.(constructor)
-
-Constructs a new instance of the `DefaultI18next` class
-
-**Signature:**
-
-```typescript
-constructor();
-```

package/docs/api/foundation-i18n.defaulti18next.addresources.md

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-i18n](./foundation-i18n.md) &gt; [DefaultI18next](./foundation-i18n.defaulti18next.md) &gt; [addResources](./foundation-i18n.defaulti18next.addresources.md)
-
-## DefaultI18next.addResources() method
-
-**Signature:**
-
-```typescript
-addResources(resources: Resource): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-resources
-
-
-</td><td>
-
-Resource
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-i18n.defaulti18next.changelanguageto.md

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-i18n](./foundation-i18n.md) &gt; [DefaultI18next](./foundation-i18n.defaulti18next.md) &gt; [changeLanguageTo](./foundation-i18n.defaulti18next.changelanguageto.md)
-
-## DefaultI18next.changeLanguageTo() method
-
-**Signature:**
-
-```typescript
-changeLanguageTo(language: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-language
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-i18n.defaulti18next.config.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-i18n](./foundation-i18n.md) &gt; [DefaultI18next](./foundation-i18n.defaulti18next.md) &gt; [config](./foundation-i18n.defaulti18next.config.md)
-
-## DefaultI18next.config property
-
-**Signature:**
-
-```typescript
-config: I18nextConfig;
-```

package/docs/api/foundation-i18n.defaulti18next.init.md

@@ -1,66 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-i18n](./foundation-i18n.md) &gt; [DefaultI18next](./foundation-i18n.defaulti18next.md) &gt; [init](./foundation-i18n.defaulti18next.init.md)
-
-## DefaultI18next.init() method
-
-**Signature:**
-
-```typescript
-init(options: InitOptions, callback?: Callback): Promise<TFunction>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-options
-
-
-</td><td>
-
-InitOptions
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-callback
-
-
-</td><td>
-
-Callback
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;TFunction&gt;
-

package/docs/api/foundation-i18n.defaulti18next.language.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-i18n](./foundation-i18n.md) &gt; [DefaultI18next](./foundation-i18n.defaulti18next.md) &gt; [language](./foundation-i18n.defaulti18next.language.md)
-
-## DefaultI18next.language property
-
-**Signature:**
-
-```typescript
-language: string;
-```