@discord/intl 0.0.6-rc.0 → 0.0.6-rc.2

package/dist/intl-manager.d.ts

@@ -1,6 +1,6 @@
 import { IntlShape } from '@formatjs/intl';
-import { LocaleImportMap, LocaleId, MessageLoader } from './message-loader';
-import type { TypedIntlMessageGetter, FormatValuesFor, RichTextElementMap } from './types';
+import { LocaleId, LocaleImportMap, MessageLoader } from './message-loader';
+import type { FormatValuesFor, RichTextElementMap, TypedIntlMessageGetter } from './types';
 /**
  * Fallback locale used for all internationalization when an operation in the
  * requested locale is not possible.
@@ -44,6 +44,16 @@ export declare class IntlManager<DefaultElements extends RichTextElementMap, Def
      */
     formatToParts<T extends TypedIntlMessageGetter<object | undefined>>(message: T): Array<string | any>;
     formatToParts<T extends TypedIntlMessageGetter<object | undefined>>(message: T, values: Omit<FormatValuesFor<T>, DefaultValues>): Array<string | any>;
+    /**
+     * For messages with no formatting values (i.e., plain strings, they can skip
+     * a majority of the processing work and just resolve the message itself for
+     * the current locale, then return the plain string directly.
+     *
+     * This is separate from `formatToPlainString`, which still allows for
+     * formatting variables and other elements but reduces the output to only
+     * include textual elements in a plain string.
+     */
+    string(message: TypedIntlMessageGetter<undefined>): string;
     /**
      * Format the given message with the provided values, removing any styling
      * and non-textual content from the message, returning a plain string.

package/dist/intl-manager.js

@@ -115,6 +115,19 @@ var IntlManager = /** @class */ (function () {
         }
         return result;
     };
+    /**
+     * For messages with no formatting values (i.e., plain strings, they can skip
+     * a majority of the processing work and just resolve the message itself for
+     * the current locale, then return the plain string directly.
+     *
+     * This is separate from `formatToPlainString`, which still allows for
+     * formatting variables and other elements but reduces the output to only
+     * include textual elements in a plain string.
+     */
+    IntlManager.prototype.string = function (message) {
+        // TODO(faulty): Optimize this so that plain strings are hotpathed even faster.
+        return this.formatToPlainString(message);
+    };
     IntlManager.prototype.formatToPlainString = function (message, values) {
         if (typeof message === 'string')
             return message;

package/dist/message.js

@@ -43,12 +43,6 @@ var InternalIntlMessage = /** @class */ (function () {
     function InternalIntlMessage(messageOrAst, locale) {
         this.locale = locale;
         if (typeof messageOrAst === 'string') {
-            // TODO: This part should pre-parse our Markdown shorthand, too, so that
-            // the AST that comes out of this is a standardized format, and we don't
-            // have to do any special handling after calling `format`. That also
-            // removes the need for handling "unsafe" values, since they'll be
-            // parsed before values get interpolated. We can actually do that in the
-            // loader, too, and avoid any runtime cost for it.
             this.message = messageOrAst;
             this.ast = (0, icu_messageformat_parser_1.parse)(messageOrAst);
         }

package/dist/react.d.ts

@@ -10,7 +10,7 @@ export declare class IntlManagerReact<DefaultElements extends RichTextElementMap
     IntlMessage: <T extends TypedIntlMessageGetter<object | undefined>>(props: {
         message: T;
         values?: Omit<FormatValuesFor<T>, DefaultValues> | never;
-    }) => React.FunctionComponentElement<{
+    }) => string | React.FunctionComponentElement<{
         children?: React.ReactNode | undefined;
     }>;
     /**

package/dist/react.js

@@ -57,15 +57,18 @@ var IntlManagerReact = /** @class */ (function (_super) {
             // Use the locale from this point in the application, which may be
             // different from the global locale.
             var locale = React.useSyncExternalStore(_this.onLocaleChange, function () { return _this.currentLocale; });
-            // Source the actual message to render for that locale from its loader.
             // TODO(faulty): This can and should be replaced by a
             // `use(messagesLoadedPromise)` once `use` is shipped to stable.
+            // Source the actual message to render for that locale from its loader.
             React.useSyncExternalStore(message.onChange, function () { return message(locale); });
             // If there are no object parts in the message, it has no formatting and can just be returned as
             // a plain string.
-            return typeof message === 'string'
-                ? message
-                : React.createElement(React.Fragment, undefined, _this.formatToParts(message, values));
+            if (typeof message === 'string')
+                return message;
+            var parts = _this.formatToParts(message, values);
+            if (parts.length === 1 && typeof parts[0] === 'string')
+                return parts[0];
+            return React.createElement(React.Fragment, undefined, _this.formatToParts(message, values));
         };
         return _this;
     }

package/dist/types.d.ts

@@ -36,7 +36,7 @@ type TypedIntlMessage<FormatValues extends object> = InternalIntlMessage & {
 };
 
 type AnyIntlMessage<FormatValues extends object | undefined = undefined> =
-  FormatValues extends object ? TypedIntlMessage<FormatValues> : PlainIntlMessage;
+  FormatValues extends undefined ? PlainIntlMessage : TypedIntlMessage<FormatValues>;
 
 /**
  * Getter function that retrieves a message that best matches the requested
@@ -45,10 +45,10 @@ type AnyIntlMessage<FormatValues extends object | undefined = undefined> =
  * represent that there are no values required and the message is a plain
  * string.
  */
-export type TypedIntlMessageGetter<FormatValues extends object | undefined> =
-  IntlMessageGetterAdditions & {
-    (locale: string): AnyIntlMessage<FormatValues>;
-  };
+export interface TypedIntlMessageGetter<FormatValues extends object | undefined>
+  extends IntlMessageGetterAdditions {
+  (locale: string): AnyIntlMessage<FormatValues>;
+}
 
 /**
  * Common utility type for converting a union type to an intersection of all

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@discord/intl",
-  "version": "0.0.6-rc.0",
+  "version": "0.0.6-rc.2",
   "license": "MIT",
   "description": "Client runtime for managing messages and translations in a React project.",
   "main": "./dist/index.js",
@@ -38,6 +38,7 @@
     }
   },
   "scripts": {
-    "build": "tsc && cp -r ./src/*.d.ts dist/"
+    "build": "tsc",
+    "build:release": "tsc && cp ./src/*.d.ts dist/"
   }
 }

package/src/intl-manager.ts

@@ -1,14 +1,14 @@
-import { IntlShape, createIntl } from '@formatjs/intl';
+import { createIntl, IntlShape } from '@formatjs/intl';
 import {
-  PART_TYPE as FormatPartType,
   Formats,
   Formatters,
   IntlMessageFormat,
+  PART_TYPE as FormatPartType,
 } from 'intl-messageformat';
 
-import { LocaleImportMap, LocaleId, MessageLoader } from './message-loader';
+import { LocaleId, LocaleImportMap, MessageLoader } from './message-loader';
 
-import type { TypedIntlMessageGetter, FormatValuesFor, RichTextElementMap } from './types';
+import type { FormatValuesFor, RichTextElementMap, TypedIntlMessageGetter } from './types';
 
 /**
  * Fallback locale used for all internationalization when an operation in the
@@ -129,6 +129,20 @@ export class IntlManager<
     return result;
   }
 
+  /**
+   * For messages with no formatting values (i.e., plain strings, they can skip
+   * a majority of the processing work and just resolve the message itself for
+   * the current locale, then return the plain string directly.
+   *
+   * This is separate from `formatToPlainString`, which still allows for
+   * formatting variables and other elements but reduces the output to only
+   * include textual elements in a plain string.
+   */
+  string(message: TypedIntlMessageGetter<undefined>): string {
+    // TODO(faulty): Optimize this so that plain strings are hotpathed even faster.
+    return this.formatToPlainString(message);
+  }
+
   /**
    * Format the given message with the provided values, removing any styling
    * and non-textual content from the message, returning a plain string.

package/src/message.ts

@@ -26,13 +26,6 @@ export class InternalIntlMessage {
     this.locale = locale;
 
     if (typeof messageOrAst === 'string') {
-      // TODO: This part should pre-parse our Markdown shorthand, too, so that
-      // the AST that comes out of this is a standardized format, and we don't
-      // have to do any special handling after calling `format`. That also
-      // removes the need for handling "unsafe" values, since they'll be
-      // parsed before values get interpolated. We can actually do that in the
-      // loader, too, and avoid any runtime cost for it.
-
       this.message = messageOrAst;
       this.ast = parseMessageFormat(messageOrAst);
     } else {

package/src/react.ts

@@ -21,19 +21,21 @@ export class IntlManagerReact<
     // Use the locale from this point in the application, which may be
     // different from the global locale.
     const locale = React.useSyncExternalStore(this.onLocaleChange, () => this.currentLocale);
-    // Source the actual message to render for that locale from its loader.
     // TODO(faulty): This can and should be replaced by a
     // `use(messagesLoadedPromise)` once `use` is shipped to stable.
+    // Source the actual message to render for that locale from its loader.
     React.useSyncExternalStore(message.onChange, () => message(locale));
     // If there are no object parts in the message, it has no formatting and can just be returned as
     // a plain string.
-    return typeof message === 'string'
-      ? message
-      : React.createElement(
-          React.Fragment,
-          undefined,
-          this.formatToParts(message, values as Omit<FormatValuesFor<T>, DefaultValues>),
-        );
+    if (typeof message === 'string') return message;
+
+    const parts = this.formatToParts(message, values as Omit<FormatValuesFor<T>, DefaultValues>);
+    if (parts.length === 1 && typeof parts[0] === 'string') return parts[0];
+    return React.createElement(
+      React.Fragment,
+      undefined,
+      this.formatToParts(message, values as Omit<FormatValuesFor<T>, DefaultValues>),
+    );
   };
 
   /**

package/src/types.d.ts

@@ -36,7 +36,7 @@ type TypedIntlMessage<FormatValues extends object> = InternalIntlMessage & {
 };
 
 type AnyIntlMessage<FormatValues extends object | undefined = undefined> =
-  FormatValues extends object ? TypedIntlMessage<FormatValues> : PlainIntlMessage;
+  FormatValues extends undefined ? PlainIntlMessage : TypedIntlMessage<FormatValues>;
 
 /**
  * Getter function that retrieves a message that best matches the requested
@@ -45,10 +45,10 @@ type AnyIntlMessage<FormatValues extends object | undefined = undefined> =
  * represent that there are no values required and the message is a plain
  * string.
  */
-export type TypedIntlMessageGetter<FormatValues extends object | undefined> =
-  IntlMessageGetterAdditions & {
-    (locale: string): AnyIntlMessage<FormatValues>;
-  };
+export interface TypedIntlMessageGetter<FormatValues extends object | undefined>
+  extends IntlMessageGetterAdditions {
+  (locale: string): AnyIntlMessage<FormatValues>;
+}
 
 /**
  * Common utility type for converting a union type to an intersection of all