@adminforth/i18n 2.0.21 → 2.0.22

package/dist/index.d.ts

@@ -0,0 +1,80 @@
+import { AdminForthPlugin } from "adminforth";
+import type { IAdminForth, IHttpServer, AdminForthResourceColumn, AdminForthResource, AdminUser } from "adminforth";
+import type { PluginOptions, SupportedLanguage } from './types.js';
+interface IFailedTranslation {
+    lang: SupportedLanguage;
+    en_string: string;
+    failedReason: string;
+}
+interface ICachingAdapter {
+    get(key: string): Promise<any>;
+    set(key: string, value: any): Promise<void>;
+    clear(key: string): Promise<void>;
+}
+export default class I18nPlugin extends AdminForthPlugin {
+    options: PluginOptions;
+    emailField: AdminForthResourceColumn;
+    passwordField: AdminForthResourceColumn;
+    authResource: AdminForthResource;
+    emailConfirmedField?: AdminForthResourceColumn;
+    trFieldNames: Partial<Record<SupportedLanguage, string>>;
+    enFieldName: string;
+    cache: ICachingAdapter;
+    primaryKeyFieldName: string;
+    menuItemWithBadgeId: string;
+    adminforth: IAdminForth;
+    externalAppOnly: boolean;
+    fullCompleatedFieldValue: string;
+    primaryLanguage: SupportedLanguage;
+    constructor(options: PluginOptions);
+    computeCompletedFieldValue(record: any): Promise<string>;
+    updateUntranslatedMenuBadge(): Promise<void>;
+    modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource): Promise<void>;
+    generateAndSaveBunch(prompt: string, strings: {
+        en_string: string;
+        category: string;
+        schemaKey?: string;
+    }[], translations: any[], updateStrings: Record<string, {
+        updates: any;
+        category: string;
+        strId: string;
+        enStr: string;
+        translatedStr: string;
+    }>, lang: string, failedToTranslate: IFailedTranslation[], needToTranslateByLang: Record<string, any>, jobId: string, promptCost: number): Promise<void>;
+    getTranslateToLangTasks(langIsoCode: SupportedLanguage, strings: {
+        id: string;
+        en_string: string;
+        category: string;
+    }[], plurals: boolean, translations: any[], updateStrings: Record<string, {
+        updates: any;
+        category: string;
+        strId: string;
+        enStr: string;
+        translatedStr: string;
+    }>, needToTranslateByLang: Record<string, any>, adminUser: AdminUser): Promise<any>;
+    bulkTranslate({ selectedIds, selectedLanguages, adminUser }: {
+        selectedIds: string[];
+        selectedLanguages?: SupportedLanguage[];
+        adminUser: AdminUser;
+    }): Promise<string>;
+    processExtractedMessages(adminforth: IAdminForth, filePath: string): Promise<void>;
+    tryProcessAndWatch(adminforth: IAdminForth): Promise<void>;
+    validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource): void;
+    applyPluralization(str: string, number: number, lang: string): string;
+    slavicPluralRule(choice: any, choicesLength: any): 0 | 2 | 1 | 3;
+    instanceUniqueRepresentation(pluginOptions: any): string;
+    getCategoryTranslations(category: string, lang: string): Promise<Record<string, string>>;
+    languagesList(): Promise<{
+        code: SupportedLanguage;
+        nameOnNative: string;
+        nameEnglish: string;
+        emojiFlag: string;
+        svgFlagB64: string;
+    }[]>;
+    feedCategoryTranslations(messages: {
+        en_string: string;
+        source: string;
+    }[], category: string): Promise<void>;
+    setupEndpoints(server: IHttpServer): void;
+}
+export {};

package/dist/types.d.ts

@@ -0,0 +1,74 @@
+import { CompletionAdapter } from 'adminforth';
+import type { LanguageCode } from 'iso-639-1';
+import { iso31661Alpha2ToAlpha3 } from 'iso-3166';
+import { type PluginsCommonOptions } from "adminforth";
+type Alpha2Code = keyof typeof iso31661Alpha2ToAlpha3;
+type Bcp47LanguageTag = `${LanguageCode}-${Alpha2Code}`;
+export type SupportedLanguage = LanguageCode | Bcp47LanguageTag;
+export interface PluginOptions extends PluginsCommonOptions {
+    supportedLanguages: SupportedLanguage[];
+    /**
+     * Each translation string will be stored in a separate field, you can remap it to existing columns  using this option
+     * By default it will assume field are named like `${lang_code}_string` (e.g. 'en_string', 'uk_string', 'ja_string', 'fr_string')
+     */
+    translationFieldNames: Partial<Record<SupportedLanguage, string>>;
+    /**
+     * Each string has a category, e.g. it might come from 'frontend' or some message from backend or column name on backend
+     * To deliver translations efficiently we need to store the category of each string.
+     * We recommend to put index on this column
+     */
+    categoryFieldName: string;
+    /**
+     * Language selector on login page order
+     */
+    loginPageLanguageSelectorOrder?: number;
+    /**
+     * Optional source field to store e.g. file name where it first was captured
+     */
+    sourceFieldName?: string;
+    /**
+     * Optional field to save list of completed translations
+     * Helps to filter out strings which are not translated. If you define this field plugin will automatically
+     */
+    completedFieldName?: string;
+    /**
+     * Optionally translation plugin supports LLM completion adapter (like OpenAI) for generating translations
+     * semiautomatically (creates a bulk action for generating translations)
+     */
+    completeAdapter?: CompletionAdapter;
+    /**
+     * Optionally translation plugin available to translate only external applications (like SEO-facing or user-facing services),
+     *  not AdminForth applications
+     */
+    externalAppOnly?: boolean;
+    /**
+     * You can enable "Reviewed" checkbox for each translation string by defing this field,
+     * it should be a JSON field (underlyng database type should be TEXT or JSON)
+     */
+    reviewedCheckboxesFieldName?: string;
+    /**
+     * Primary language for the application. This is the default language shown to users.
+     * English is always used as the source language for translations, even if primaryLanguage is different.
+     * When a translation is missing for the primaryLanguage, English will be shown as fallback.
+     * Defaults to 'en' if not specified.
+     */
+    primaryLanguage?: SupportedLanguage;
+    /**
+      *  Ask translator to treat some code from supportedLanguages as exact BCP47 tag. Read docs for details.
+      *  key - one of the values form supportedLanguages, value -BCP47 tag
+      */
+    translateLangAsBCP47Code?: Partial<Record<LanguageCode, Bcp47LanguageTag>>;
+    /**
+     *  Batch size of one translation generation request.
+     *  This is an optional parameter that can be used to control the size of strings sent in a single request to the completion adapter.
+     *  Default value is 30000 tokens
+     */
+    inputTokensPerBatch?: number;
+    /**
+     *  Limit of parallel translation generation requests.
+     *  This is an optional parameter that can be used to control the number of concurrent requests sent to the completion adapter.
+     *  Default value is 20
+     */
+    parallelTranslationLimit?: number;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/i18n",
-  "version": "2.0.21",
+  "version": "2.0.22",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",

package/tsconfig.json

@@ -2,6 +2,7 @@
   "compilerOptions": {
     "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include*/ 
     "module": "node16",                                /* Specify what module code is generated. */
+    "declaration": true,
     "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
     "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules.  */
     "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */