server/project/src/services/LocalisationService.ts

import path from "node:path";
import { I18n } from "i18n";
import { inject, injectable } from "tsyringe";

import { ILocaleConfig } from "@spt-aki/models/spt/config/ILocaleConfig";
import { ILogger } from "@spt-aki/models/spt/utils/ILogger";
import { DatabaseServer } from "@spt-aki/servers/DatabaseServer";
import { LocaleService } from "@spt-aki/services/LocaleService";
import { RandomUtil } from "@spt-aki/utils/RandomUtil";

/**
 * Handles translating server text into different langauges
 */
@injectable()
export class LocalisationService
{
    protected localeConfig: ILocaleConfig;
    protected i18n: I18n;

    constructor(
        @inject("WinstonLogger") protected logger: ILogger,
        @inject("RandomUtil") protected randomUtil: RandomUtil,
        @inject("DatabaseServer") protected databaseServer: DatabaseServer,
        @inject("LocaleService") protected localeService: LocaleService,
    )
    {
        const localeFileDirectory = path.join(
            process.cwd(),
            globalThis.G_RELEASE_CONFIGURATION
                ? "Aki_Data/Server/database/locales/server"
                : "./assets/database/locales/server",
        );
        this.i18n = new I18n({
            locales: this.localeService.getServerSupportedLocales(),
            defaultLocale: "en",
            directory: localeFileDirectory,
            retryInDefaultLocale: true,
        });

        this.i18n.setLocale(this.localeService.getDesiredServerLocale());
    }

    /**
     * Get a localised value using the passed in key
     * @param key Key to loop up locale for
     * @param args optional arguments
     * @returns Localised string
     */
    public getText(key: string, args = undefined): string
    {
        return this.i18n.__(key.toLowerCase(), args);
    }

    /**
     * Get all locale keys
     * @returns string array of keys
     */
    public getKeys(): string[]
    {
        return Object.keys(this.databaseServer.getTables().locales.server.en);
    }

    /**
     * From the provided partial key, find all keys that start with text and choose a random match
     * @param partialKey Key to match locale keys on
     * @returns locale text
     */
    public getRandomTextThatMatchesPartialKey(partialKey: string): string
    {
        const filteredKeys = Object.keys(this.databaseServer.getTables().locales.server.en).filter((x) =>
            x.startsWith(partialKey)
        );
        const chosenKey = this.randomUtil.getArrayValue(filteredKeys);

        return this.getText(chosenKey);
    }
}