@discord/intl 0.0.6-rc.2 → 0.0.8

package/dist/intl-manager.d.ts

@@ -60,6 +60,15 @@ export declare class IntlManager<DefaultElements extends RichTextElementMap, Def
      */
     formatToPlainString<T extends TypedIntlMessageGetter<object | undefined>>(message: T): string;
     formatToPlainString<T extends TypedIntlMessageGetter<object | undefined>>(message: T, values: Omit<FormatValuesFor<T>, DefaultValues>): string;
+    /**
+     * Similar to `formatToPlainString`, format the given message with the provided
+     * values, but convert all rich text formatting back to Markdown syntax rather
+     * than rendering the actual rich content. The result is a plain string that
+     * can be sent through a separate Markdown renderer to get an equivalent
+     * result to formatting this message directly.
+     */
+    formatToMarkdownString<T extends TypedIntlMessageGetter<object | undefined>>(message: T): string;
+    formatToMarkdownString<T extends TypedIntlMessageGetter<object | undefined>>(message: T, values: Omit<FormatValuesFor<T>, DefaultValues>): string;
 }
 /**
  * Create a new MessageLoader, which handles lazily loading messages for

package/dist/intl-manager.js

@@ -138,6 +138,17 @@ var IntlManager = /** @class */ (function () {
         // will be removed from the string anyway.
         return resolvedMessage.formatToPlainString(this.intl.formatters, this.intl.formats, values);
     };
+    IntlManager.prototype.formatToMarkdownString = function (message, values) {
+        // TODO(faulty): Implement the markdown syntax conversion here.
+        if (typeof message === 'string')
+            return message;
+        var resolvedMessage = message(this.currentLocale);
+        if (typeof resolvedMessage === 'string')
+            return resolvedMessage;
+        // No need to pass in `defaultRichTextElements`, since the stylistic tags
+        // will be removed from the string anyway.
+        return resolvedMessage.formatToPlainString(this.intl.formatters, this.intl.formats, values);
+    };
     return IntlManager;
 }());
 exports.IntlManager = IntlManager;

package/dist/message-loader.d.ts

@@ -53,7 +53,7 @@ export declare class MessageLoader {
      *
      * @private
      */
-    _debugKeyMap: Record<string, string>;
+    _debugKeyMap?: Record<string, string>;
     /**
      * Map of locale names to source file names, used to provide context for where messages are
      * imported from during development.
@@ -62,7 +62,7 @@ export declare class MessageLoader {
      *
      * @private
      */
-    _localeFileMap: Record<string, string>;
+    _localeFileMap?: Record<string, string>;
     constructor(messageKeys: string[], localeImportMap: LocaleImportMap, defaultLocale: LocaleId);
     /**
      * Provide additional debug information to use during development, providing additional context

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@discord/intl",
-  "version": "0.0.6-rc.2",
+  "version": "0.0.8",
   "license": "MIT",
   "description": "Client runtime for managing messages and translations in a React project.",
   "main": "./dist/index.js",

package/src/intl-manager.ts

@@ -168,6 +168,36 @@ export class IntlManager<
       values,
     );
   }
+
+  /**
+   * Similar to `formatToPlainString`, format the given message with the provided
+   * values, but convert all rich text formatting back to Markdown syntax rather
+   * than rendering the actual rich content. The result is a plain string that
+   * can be sent through a separate Markdown renderer to get an equivalent
+   * result to formatting this message directly.
+   */
+  formatToMarkdownString<T extends TypedIntlMessageGetter<object | undefined>>(message: T): string;
+  formatToMarkdownString<T extends TypedIntlMessageGetter<object | undefined>>(
+    message: T,
+    values: Omit<FormatValuesFor<T>, DefaultValues>,
+  ): string;
+  formatToMarkdownString<T extends TypedIntlMessageGetter<object | undefined>>(
+    message: T,
+    values?: Omit<FormatValuesFor<T>, DefaultValues>,
+  ) {
+    // TODO(faulty): Implement the markdown syntax conversion here.
+    if (typeof message === 'string') return message;
+    const resolvedMessage = message(this.currentLocale);
+    if (typeof resolvedMessage === 'string') return resolvedMessage;
+
+    // No need to pass in `defaultRichTextElements`, since the stylistic tags
+    // will be removed from the string anyway.
+    return resolvedMessage.formatToPlainString(
+      this.intl.formatters as Formatters,
+      this.intl.formats as Formats,
+      values,
+    );
+  }
 }
 
 /**

package/src/message-loader.ts

@@ -64,7 +64,7 @@ export class MessageLoader {
    *
    * @private
    */
-  _debugKeyMap: Record<string, string>;
+  _debugKeyMap?: Record<string, string>;
   /**
    * Map of locale names to source file names, used to provide context for where messages are
    * imported from during development.
@@ -73,7 +73,7 @@ export class MessageLoader {
    *
    * @private
    */
-  _localeFileMap: Record<string, string>;
+  _localeFileMap?: Record<string, string>;
 
   constructor(messageKeys: string[], localeImportMap: LocaleImportMap, defaultLocale: LocaleId) {
     this.messageKeys = messageKeys;