@seasketch/geoprocessing/src/i18n/bin/importTerms.ts

Geoprocessing and reporting framework for SeaSketch 2.0

#!/usr/bin/env node
import fs from "fs-extra";
import path from "node:path";
import { Translations } from "./publishTerms.js";
import languages from "../languages.json" with { type: "json" };
import { LangDetails } from "../languages.js";

if (!process.env.POEDITOR_API_TOKEN) {
  throw new Error("POEDITOR_API_TOKEN is not defined");
}
if (!process.env.POEDITOR_PROJECT) {
  throw new Error("POEDITOR_PROJECT is not defined");
}

const installedProjectPath = "./project"; // assumes script running from top-level
const monoProjectPath = path.join("packages/geoprocessing/src/project");

const projectPath = (() => {
  if (fs.existsSync(installedProjectPath)) {
    console.log(`Found project path at ${installedProjectPath}`);
    return installedProjectPath;
  } else if (fs.existsSync(monoProjectPath)) {
    console.log(`Found project path at ${monoProjectPath}`);
    return monoProjectPath;
  }
  throw new Error(
    `Could not find path to project dir, tried ${installedProjectPath} and ${monoProjectPath}`,
  );
})();

// read languages.  Start with all and if project has a basic.json file, use those languages
let projectLanguages: string[] = languages.map(
  (lang: LangDetails) => lang.code,
);
if (fs.existsSync(`${projectPath}/basic.json`)) {
  const basic = fs.readJsonSync(`${projectPath}/basic.json`);
  if (
    basic.languages &&
    Array.isArray(basic.languages) &&
    basic.languages.length > 0
  ) {
    projectLanguages = basic.languages;
  } else {
    console.error(
      `Missing language codes in ${projectPath}/basic.json, run upgrade command to add`,
    );
    process.exit(1);
  }

  if (!basic.languages.includes("EN")) {
    console.error(
      'Expected "EN" to be included in the languages array in basic.json',
    );
    process.exit(1);
  }

  if (basic.languages.length < 2) {
    console.log(
      `No languages found to import in ${projectPath}/basic.json, add more languages codes to basic.json`,
    );
    process.exit(1);
  }
}

const config = await fs.readJSON(`${projectPath}/i18n.json`);

/**
 * Pulls all terms for all languages from POEditor and writes them to the local translation files.
 * This will overwrite any existing translations.
 */

const enTermsForm = new FormData();
enTermsForm.append("api_token", process.env.POEDITOR_API_TOKEN!);
enTermsForm.append("id", process.env.POEDITOR_PROJECT!);
enTermsForm.append("language", "en");
enTermsForm.append("context", config.remoteContext);

const enTermsResponse = await fetch("https://api.poeditor.com/v2/terms/list", {
  method: "POST",
  body: enTermsForm,
});

const enTermsResult = await enTermsResponse.json();

if (enTermsResult.response.status !== "success") {
  throw new Error(`API response was ${enTermsResult.response.status}`);
}
const enTerms: {
  term: string;
  context: string;
  plural: string;
  created: string;
  updated: string;
  translation: {
    content: string;
    fuzzy: number;
    updated: string;
  };
  reference: string;
  tags: string[];
  comment: string;
  obsolete?: boolean;
}[] = enTermsResult.result.terms;
enTerms.sort((a, b) => a.term.localeCompare(b.term));

const numNonEngLanguages = projectLanguages ? projectLanguages.length - 1 : 0;
if (numNonEngLanguages > 0) {
  console.log(
    `Importing terms from remote context '${config.remoteContext}' ${
      projectLanguages ? "for " + numNonEngLanguages + " languages" : ""
    } `,
  );
  console.log();
} else {
  process.exit(1);
}

const langForm = new FormData();
langForm.append("api_token", process.env.POEDITOR_API_TOKEN!);
langForm.append("id", process.env.POEDITOR_PROJECT!);

const langResponse = await fetch(`https://api.poeditor.com/v2/languages/list`, {
  method: "POST",
  body: langForm,
});

const langResult = await langResponse.json();
if (langResult.response.status !== "success") {
  throw new Error(`API response was ${langResult.response.status}`);
}
const remoteLanguages = langResult.result.languages as {
  name: string;
  code: string;
  percentage: number;
}[];

for (const curLang of remoteLanguages.filter(
  (curLang) =>
    curLang.code !== "en" &&
    projectLanguages &&
    projectLanguages.includes(curLang.code),
)) {
  if (curLang.percentage === 0) {
    console.log(
      `${curLang.code}: skipping ${curLang.name} (${curLang.percentage}% translated)`,
    );
    continue;
  }
  console.log(
    `${curLang.code}: importing ${curLang.name} (${curLang.percentage}% translated)`,
  );

  const curLangInfoForm = new FormData();
  curLangInfoForm.append("api_token", process.env.POEDITOR_API_TOKEN!);
  curLangInfoForm.append("id", process.env.POEDITOR_PROJECT!);
  curLangInfoForm.append("language", curLang.code);
  curLangInfoForm.append("type", "key_value_json");
  curLangInfoForm.append("filters", "translated");
  curLangInfoForm.append("order", "terms");

  const curLangInfoResponse = await fetch(
    `https://api.poeditor.com/v2/projects/export`,
    {
      method: "POST",
      body: curLangInfoForm,
    },
  );

  const projectsResult = await curLangInfoResponse.json();

  if (projectsResult.response.status !== "success") {
    throw new Error(`API response was ${projectsResult.response.status}`);
  }
  const translationsResponse = await fetch(projectsResult.result.url);
  const remoteTranslations = await translationsResponse.json();

  const localePath = path.join(import.meta.dirname, "../lang", curLang.code);

  const localTranslationsPath = `${localePath}/${config.localNamespace}.json`;
  const localTranslations: Translations = (() => {
    if (fs.existsSync(localTranslationsPath)) {
      const transTerms = fs.readJsonSync(localTranslationsPath);
      return transTerms;
    } else {
      if (fs.existsSync(path.dirname(localTranslationsPath)) === false) {
        fs.mkdirSync(path.dirname(localTranslationsPath));
      }
      fs.writeJsonSync(localTranslationsPath, {});
      return {};
    }
  })();

  for (const enTerm of enTerms) {
    // Overwrite local translation with remote if one exists
    if (
      remoteTranslations[config.remoteContext] &&
      remoteTranslations[config.remoteContext][enTerm.term] &&
      enTerm.context === config.remoteContext
    ) {
      localTranslations[enTerm.term] =
        remoteTranslations[config.remoteContext][enTerm.term];
    }
  }
  if (Object.keys(localTranslations).length > 0) {
    fs.rmSync(localePath, { recursive: true, force: true });
    fs.mkdirSync(localePath);
    // console.log("translated terms", translatedTerms);
    fs.writeJsonSync(localTranslationsPath, localTranslations, {
      spaces: 2,
    });
  }
}