@discord/intl-loader-core 0.22.0-rc.0 → 0.22.0

package/index.js

@@ -3,6 +3,7 @@ const {
   isMessageDefinitionsFile,
   isMessageTranslationsFile,
   IntlCompiledMessageFormat,
+  IntlDatabaseInsertStrategy,
 } = require('@discord/intl-message-database');
 
 const { database } = require('./src/database');
@@ -24,6 +25,9 @@ module.exports = {
   // @ts-expect-error This is a const enum, which TypeScript doesn't like letting you export, even
   // though it's a tangible object that can be accessed just fine from normal JS.
   IntlCompiledMessageFormat,
+  // @ts-expect-error This is a const enum, which TypeScript doesn't like letting you export, even
+  // though it's a tangible object that can be accessed just fine from normal JS.
+  IntlDatabaseInsertStrategy,
   MessageDefinitionsTransformer,
   database,
   findAllTranslationFiles,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@discord/intl-loader-core",
-  "version": "0.22.0-rc.0",
+  "version": "0.22.0",
   "license": "MIT",
   "description": "Core utilities for writing loaders and transformers using @discord/intl",
   "author": "Jon Egeland",
@@ -28,7 +28,7 @@
   "dependencies": {
     "chokidar": "^3.6.0",
     "debug": "^4.3.6",
-    "@discord/intl-message-database": "0.22.0-rc.0"
+    "@discord/intl-message-database": "0.22.0"
   },
   "devDependencies": {
     "@types/debug": "^4.1.12",

package/src/processing.js

@@ -1,7 +1,10 @@
 const path = require('node:path');
 
 const debug = require('debug')('intl:loader-core');
-const { IntlCompiledMessageFormat } = require('@discord/intl-message-database');
+const {
+  IntlCompiledMessageFormat,
+  IntlDatabaseInsertStrategy,
+} = require('@discord/intl-message-database');
 
 const { database } = require('./database');
 const { findAllTranslationFiles, getLocaleFromTranslationsFileName } = require('./util');
@@ -111,10 +114,11 @@ function filterAllMessagesFiles(files, defaultLocale = 'en-US') {
  * with a `sourceContent` argument.
  *
  * @param {IntlMessagesFileDescriptor[]} files
+ * @param {IntlDatabaseInsertStrategy} [strategy]
  * @returns {IntlSourceFileInsertionData[]}
  */
-function processAllMessagesFiles(files) {
-  return database.processAllMessagesFiles(files);
+function processAllMessagesFiles(files, strategy = IntlDatabaseInsertStrategy.Update) {
+  return database.processAllMessagesFiles(files, strategy);
 }
 
 /**
@@ -123,6 +127,7 @@ function processAllMessagesFiles(files) {
  * @param {{
  *   processTranslations?: boolean,
  *   locale?: string
+ *   strategy?: IntlDatabaseInsertStrategy
  * }=} options
  * @returns {ProcessDefinitionsResult}
  */
@@ -131,15 +136,16 @@ function processDefinitionsFile(sourcePath, sourceContent, options = {}) {
     processTranslations = false,
     // TODO: Make this more configurable/automatically determined.
     locale = 'en-US',
+    strategy = IntlDatabaseInsertStrategy.Update,
   } = options;
   debug(`[${sourcePath}] Processing definitions with locale "${locale}"`);
 
   /** @type {IntlSourceFileInsertionData} */
   let result;
   if (sourceContent != null) {
-    result = database.processDefinitionsFileContent(sourcePath, sourceContent, locale);
+    result = database.processDefinitionsFileContent(sourcePath, sourceContent, locale, strategy);
   } else {
-    result = database.processDefinitionsFile(sourcePath, locale);
+    result = database.processDefinitionsFile(sourcePath, locale, strategy);
   }
   if (result.errors.length > 0) {
     return { succeeded: false, errors: result.errors };
@@ -162,7 +168,7 @@ function processDefinitionsFile(sourcePath, sourceContent, options = {}) {
   );
 
   if (processTranslations) {
-    const translationsResult = database.processAllTranslationFiles(translationsLocaleMap);
+    const translationsResult = database.processAllTranslationFiles(translationsLocaleMap, strategy);
     const allErrors = translationsResult.flatMap((result) => result.errors);
     if (allErrors.length > 0) {
       return { succeeded: false, errors: allErrors };
@@ -186,18 +192,22 @@ function processDefinitionsFile(sourcePath, sourceContent, options = {}) {
  * @param {string=} sourceContent
  * @param {{
  *   locale?: string,
+ *   strategy?: IntlDatabaseInsertStrategy
  * }=} options
  * @returns {ProcessTranslationsResult}
  */
 function processTranslationsFile(sourcePath, sourceContent, options = {}) {
-  const { locale = getLocaleFromTranslationsFileName(sourcePath) } = options;
+  const {
+    locale = getLocaleFromTranslationsFileName(sourcePath),
+    strategy = IntlDatabaseInsertStrategy.Update,
+  } = options;
 
   /** @type {IntlSourceFileInsertionData} */
   let result;
   if (sourceContent) {
-    result = database.processTranslationFileContent(sourcePath, locale, sourceContent);
+    result = database.processTranslationFileContent(sourcePath, locale, sourceContent, strategy);
   } else {
-    result = database.processTranslationFile(sourcePath, locale);
+    result = database.processTranslationFile(sourcePath, locale, strategy);
   }
   if (result.errors.length > 0) {
     return { succeeded: false, errors: result.errors };

package/src/watcher.js

@@ -7,7 +7,6 @@ const {
   IntlCompiledMessageFormat,
 } = require('@discord/intl-message-database');
 
-const { database } = require('./database');
 const {
   processDefinitionsFile,
   precompileFileForLocale,
@@ -49,7 +48,7 @@ const DEFAULT_LOCALE = 'en-US';
  */
 async function watchMessagesFiles(
   watchedFolders,
-  { ignore = [], skipInitial = false, once = true } = {}
+  { ignore = [], skipInitial = false, once = true } = {},
 ) {
   debug('Pre-initializing database with all discoverable messages files');
   const files = findAllMessagesFiles(watchedFolders);
@@ -75,7 +74,7 @@ async function watchMessagesFiles(
 
   const ignoredPatterns = ignore.concat(ALWAYS_IGNORE_PATTERNS);
   const globs = watchedFolders.flatMap((folder) =>
-    MESSAGES_FILE_PATTERNS.map((pattern) => path.join(folder, pattern))
+    MESSAGES_FILE_PATTERNS.map((pattern) => path.join(folder, pattern)),
   );
 
   debug(`Initializing watch for patterns:\n- ${globs.join('\n- ')}`);
@@ -94,7 +93,7 @@ async function watchMessagesFiles(
     const [result] = processAllMessagesFiles(files);
     const failed = result.errors.length > 0 ? [result.fileKey] : [];
     const secondResult = processAllMessagesFiles(
-      filterAllMessagesFiles([...reprocessQueue, ...failed])
+      filterAllMessagesFiles([...reprocessQueue, ...failed]),
     );
     // For any files that are still failing, keep them in the queue for next time.
     const secondFailures = secondResult
@@ -144,7 +143,7 @@ async function generateMessageTypes(watcher) {
  */
 async function precompileMessageDefinitionsFiles(
   watcher,
-  { assetExtension = 'json', precompileOptions = {} } = {}
+  { assetExtension = 'json', precompileOptions = {} } = {},
 ) {
   watcher.on('all', (_, filePath) => {
     const { format = IntlCompiledMessageFormat.KeylessJson, bundleSecrets = false } =
@@ -156,7 +155,7 @@ async function precompileMessageDefinitionsFiles(
       // Convert the file name from `.messages.js` to `.compiled.messages.jsona` for output.
       const outputPath = filePath.replace(
         /\.messages\.js$/,
-        `.compiled.messages.${assetExtension}`
+        `.compiled.messages.${assetExtension}`,
       );
       const result = processDefinitionsFile(filePath);
       if (!result.succeeded) {
@@ -165,7 +164,7 @@ async function precompileMessageDefinitionsFiles(
         return;
       }
 
-      precompileFileForLocale(filePath, result.locale, undefined, {
+      precompileFileForLocale(filePath, result.locale, outputPath, {
         format,
         bundleSecrets,
       });

package/types/index.d.ts

@@ -1,4 +1,5 @@
 import { IntlCompiledMessageFormat } from "@discord/intl-message-database";
+import { IntlDatabaseInsertStrategy } from "@discord/intl-message-database";
 import { MessageDefinitionsTransformer } from "./src/transformer";
 import { database } from "./src/database";
 import { findAllTranslationFiles } from "./src/util";
@@ -15,4 +16,4 @@ import { findAllMessagesFiles } from "./src/processing";
 import { filterAllMessagesFiles } from "./src/processing";
 import { processAllMessagesFiles } from "./src/processing";
 import watcher = require("./src/watcher");
-export { IntlCompiledMessageFormat, MessageDefinitionsTransformer, database, findAllTranslationFiles, findAllDefinitionsFilesForTranslations, getLocaleFromTranslationsFileName, generateTypeDefinitions, hashMessageKey, isMessageDefinitionsFile, isMessageTranslationsFile, processDefinitionsFile, processTranslationsFile, precompileFileForLocale, findAllMessagesFiles, filterAllMessagesFiles, processAllMessagesFiles, watcher };
+export { IntlCompiledMessageFormat, IntlDatabaseInsertStrategy, MessageDefinitionsTransformer, database, findAllTranslationFiles, findAllDefinitionsFilesForTranslations, getLocaleFromTranslationsFileName, generateTypeDefinitions, hashMessageKey, isMessageDefinitionsFile, isMessageTranslationsFile, processDefinitionsFile, processTranslationsFile, precompileFileForLocale, findAllMessagesFiles, filterAllMessagesFiles, processAllMessagesFiles, watcher };

package/types/src/processing.d.ts

@@ -45,9 +45,10 @@ export function filterAllMessagesFiles(files: string[], defaultLocale?: string):
  * with a `sourceContent` argument.
  *
  * @param {IntlMessagesFileDescriptor[]} files
+ * @param {IntlDatabaseInsertStrategy} [strategy]
  * @returns {IntlSourceFileInsertionData[]}
  */
-export function processAllMessagesFiles(files: IntlMessagesFileDescriptor[]): IntlSourceFileInsertionData[];
+export function processAllMessagesFiles(files: IntlMessagesFileDescriptor[], strategy?: IntlDatabaseInsertStrategy | undefined): IntlSourceFileInsertionData[];
 /**
  * Generate a `.d.ts` file containing TypeScript type definitions for all of the messages defined in
  * `sourcePath`. This method does not process `sourcePath` at all, meaning it expects the database
@@ -93,12 +94,14 @@ export function precompileFileForLocale(sourcePath: string, locale: string, outp
  * @param {{
  *   processTranslations?: boolean,
  *   locale?: string
+ *   strategy?: IntlDatabaseInsertStrategy
  * }=} options
  * @returns {ProcessDefinitionsResult}
  */
 export function processDefinitionsFile(sourcePath: string, sourceContent?: string | undefined, options?: {
     processTranslations?: boolean;
     locale?: string;
+    strategy?: IntlDatabaseInsertStrategy;
 } | undefined): ProcessDefinitionsResult;
 /**
  *
@@ -106,14 +109,17 @@ export function processDefinitionsFile(sourcePath: string, sourceContent?: strin
  * @param {string=} sourceContent
  * @param {{
  *   locale?: string,
+ *   strategy?: IntlDatabaseInsertStrategy
  * }=} options
  * @returns {ProcessTranslationsResult}
  */
 export function processTranslationsFile(sourcePath: string, sourceContent?: string | undefined, options?: {
     locale?: string;
+    strategy?: IntlDatabaseInsertStrategy;
 } | undefined): ProcessTranslationsResult;
 import { IntlCompiledMessageFormat } from "@discord/intl-message-database";
 import type { IntlMessagesFileDescriptor } from '../types';
+import { IntlDatabaseInsertStrategy } from "@discord/intl-message-database";
 import type { IntlSourceFileInsertionData } from '../types';
 import type { ProcessDefinitionsResult } from '../types';
 import type { ProcessTranslationsResult } from '../types';