@salesforce/core 6.2.3-qa.1 → 6.4.0

package/lib/messages.d.ts

@@ -78,6 +78,9 @@ export type StoredMessageMap = Map<string, StoredMessage>;
  * // Create loader functions for all files in the messages directory
  * Messages.importMessagesDirectory(__dirname);
  *
+ * // or, for ESM code
+ * Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+ *
  * // Now you can use the messages from anywhere in your code or file.
  * // If using importMessageDirectory, the bundle name is the file name.
  * const messages: Messages = Messages.loadMessages(packageName, bundleName);
@@ -146,6 +149,15 @@ export declare class Messages<T extends string> {
      * @param filePath The path of the file.
      */
     static importMessageFile(packageName: string, filePath: string): void;
+    /**
+     * Support ESM plugins who can't use __dirname
+     *
+     * @param metaUrl pass in `import.meta.url`
+     * @param truncateToProjectPath Will look for the messages directory in the project root (where the package.json file is located).
+     * i.e., the module is typescript and the messages folder is in the top level of the module directory.
+     * @param packageName The npm package name. Figured out from the root directory's package.json.
+     */
+    static importMessagesDirectoryFromMetaUrl(metaUrl: string, truncateToProjectPath?: boolean, packageName?: string): void;
     /**
      * Import all json and js files in a messages directory. Use the file name as the bundle key when
      * {@link Messages.loadMessages} is called. By default, we're assuming the moduleDirectoryPart is a

package/lib/messages.js

@@ -11,6 +11,7 @@ const fs = require("node:fs");
 const os = require("node:os");
 const path = require("node:path");
 const util = require("node:util");
+const node_url_1 = require("node:url");
 const ts_types_1 = require("@salesforce/ts-types");
 const kit_1 = require("@salesforce/kit");
 const sfError_1 = require("./sfError");
@@ -138,6 +139,9 @@ const jsAndJsonLoader = (filePath, fileContents) => {
  * // Create loader functions for all files in the messages directory
  * Messages.importMessagesDirectory(__dirname);
  *
+ * // or, for ESM code
+ * Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+ *
  * // Now you can use the messages from anywhere in your code or file.
  * // If using importMessageDirectory, the bundle name is the file name.
  * const messages: Messages = Messages.loadMessages(packageName, bundleName);
@@ -229,6 +233,17 @@ class Messages {
             this.setLoaderFunction(packageName, bundleName, Messages.generateFileLoaderFunction(bundleName, filePath));
         }
     }
+    /**
+     * Support ESM plugins who can't use __dirname
+     *
+     * @param metaUrl pass in `import.meta.url`
+     * @param truncateToProjectPath Will look for the messages directory in the project root (where the package.json file is located).
+     * i.e., the module is typescript and the messages folder is in the top level of the module directory.
+     * @param packageName The npm package name. Figured out from the root directory's package.json.
+     */
+    static importMessagesDirectoryFromMetaUrl(metaUrl, truncateToProjectPath = true, packageName) {
+        return Messages.importMessagesDirectory(path.dirname((0, node_url_1.fileURLToPath)(metaUrl)), truncateToProjectPath, packageName);
+    }
     /**
      * Import all json and js files in a messages directory. Use the file name as the bundle key when
      * {@link Messages.loadMessages} is called. By default, we're assuming the moduleDirectoryPart is a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "6.2.3-qa.1",
+  "version": "6.4.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",