@adminforth/i18n 1.0.0-next.1

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@adminforth/i18n",
+  "version": "1.0.0-next.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc && rsync -av --exclude 'node_modules' custom dist/",
+    "rollout": "npm run build && npm version patch && npm publish --access public && npm run rollout-next",
+    "rollout-next": "npm run build && npm version prerelease --preid=next && npm publish --tag next",
+    "prepare": "npm link adminforth"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "dependencies": {
+    "@aws-sdk/client-ses": "^3.654.0",
+    "@sapphire/async-queue": "^1.5.5",
+    "chokidar": "^4.0.1",
+    "iso-639-1": "^3.1.3"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.7",
+    "i18n-iso-countries": "^7.13.0",
+    "semantic-release": "^24.2.1",
+    "semantic-release-slack-bot": "^4.0.2",
+    "typescript": "^5.7.3"
+  },
+  "release": {
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      [
+        "semantic-release-slack-bot",
+        {
+          "notifyOnSuccess": true,
+          "notifyOnFail": true,
+          "slackIcon": ":package:",
+          "markdownReleaseNotes": true
+        }
+      ]
+    ],
+    "branches": [
+      "main",
+      {
+        "name": "next",
+        "prerelease": true
+      }
+    ]
+  }
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include*/ 
+    "module": "node16",                                /* Specify what module code is generated. */
+    "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. */
+    "strict": false,                                     /* Enable all strict type-checking options. */
+    "skipLibCheck": true,                                 /* Skip type checking all .d.ts files. */
+  },
+  "exclude": ["node_modules", "dist", "custom"],           /* Exclude files from compilation. */
+}

package/types.ts

@@ -0,0 +1,39 @@
+import { CompletionAdapter, EmailAdapter } from 'adminforth';
+import type { LanguageCode } from 'iso-639-1';
+
+
+export interface PluginOptions {
+
+  /* List of ISO 639-1 language codes which you want to tsupport*/
+  supportedLanguages: LanguageCode[];
+
+  /**
+   * 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<LanguageCode, 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;
+
+  /**
+   * 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
+}