@discord/intl 0.0.2-rc.1 → 0.0.3-canary.dae5431

package/dist/message-loader.d.ts

@@ -3,7 +3,6 @@ import type { MessageFormatElement } from '@formatjs/icu-messageformat-parser';
 type AnyRawMessage = string | MessageFormatElement[];
 type MessagesData = Record<string, AnyRawMessage>;
 export interface IntlMessageGetterAdditions {
-    isLocaleLoaded(locale: LocaleId): boolean;
     onChange(callback: () => void): () => void;
 }
 export interface IntlMessageGetter extends IntlMessageGetterAdditions {

package/dist/react.d.ts

@@ -9,7 +9,7 @@ export declare class IntlManagerReact<DefaultElements extends RichTextElementMap
      */
     IntlMessage: <T extends TypedIntlMessageGetter<object | undefined>>(props: {
         message: T;
-        values?: Omit<FormatValuesFor<T>, DefaultValues>;
+        values?: Omit<FormatValuesFor<T>, DefaultValues> | never;
     }) => React.FunctionComponentElement<{
         children?: React.ReactNode | undefined;
     }>;
@@ -18,7 +18,6 @@ export declare class IntlManagerReact<DefaultElements extends RichTextElementMap
      * and respond to updates about the current locale and other relevant
      * information.
      */
-    format<T extends TypedIntlMessageGetter<object | undefined>>(message: T): JSX.Element;
-    format<T extends TypedIntlMessageGetter<object | undefined>>(message: T, values: Omit<FormatValuesFor<T>, DefaultValues>): JSX.Element;
-    format(message: any): JSX.Element;
+    format<T extends TypedIntlMessageGetter<object | undefined>>(message: T): React.ReactElement;
+    format<T extends TypedIntlMessageGetter<object | undefined>>(message: T, values: Omit<FormatValuesFor<T>, DefaultValues>): React.ReactElement;
 }

package/dist/react.js

@@ -61,19 +61,16 @@ var IntlManagerReact = /** @class */ (function (_super) {
             // TODO(faulty): This can and should be replaced by a
             // `use(messagesLoadedPromise)` once `use` is shipped to stable.
             React.useSyncExternalStore(message.onChange, function () { return message(locale); });
-            // The return the formatted version of that string.
-            if (typeof message === 'string')
-                return message;
-            return React.createElement(React.Fragment, undefined, _this.formatToParts(message, values));
+            // 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));
         };
         return _this;
     }
     IntlManagerReact.prototype.format = function (message, values) {
-        // A string literal means there's no locale dependency, so it can just be
-        // formatted directly without any subscription.
-        if (typeof message === 'string')
-            return this.formatToParts(message);
-        return React.createElement(this.IntlMessage, { message: message, values: values });
+        return React.createElement((this.IntlMessage), { message: message, values: values });
     };
     return IntlManagerReact;
 }(intl_manager_1.IntlManager));

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 import type { InternalIntlMessage } from './message';
 import type { IntlMessageGetterAdditions } from './message-loader';
+
 /**
  * Use this function to define messages as part of the `@discord/intl`
  * system, with type checking support.
@@ -60,7 +61,7 @@ type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
 /**
  * Given a message getter of type `T` (which may be a union of multiple message
  * types), return a combined type representing the intersection of all values
- * needed to satisfy the mix of values.
+ * needed to satisfy the mix of values defined in any of the messages.
  *
  * For example, given a variable representing one of two message getters, where
  * one requires a single value to be formatted, but the other requires an
@@ -123,7 +124,7 @@ type FormatValuesFor<T> =
   // formatter to optimize a little more on each call.
   [T] extends [TypedIntlMessageGetter<undefined>]
     ? never
-    : // The `never` conditino needs to be repeated here, but this time _without_
+    : // The `never` condition needs to be repeated here, but this time _without_
       // the `[]` syntax, so that only the union elements with actual values are
       // included in the union. Without this, the `infer U` on the latter side
       // fails to resolve and the type just becomes `never`.
@@ -134,25 +135,3 @@ type FormatValuesFor<T> =
             ? U
             : never
       >;
-
-/**
- * A generic definition of a `format*` function that accepts any message
- * argument as the first parameter, and the required values object for that
- * message as the second parameter. The second parameter
- *
- * An optional third parameter for additional options can be specified as the
- * second generic type parameter.
- */
-export interface IntlFormatFn<
-  T extends object | undefined,
-  DefaultValues extends string | number | symbol,
-  OptionsType,
-  ResultType,
-> {
-  (message: TypedIntlMessageGetter<T>, options?: OptionsType): ResultType;
-  (
-    message: TypedIntlMessageGetter<T>,
-    values: Omit<FormatValuesFor<T>, DefaultValues>,
-    options?: OptionsType,
-  ): ResultType;
-}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@discord/intl",
-  "version": "0.0.2-rc.1",
+  "version": "0.0.3-canary.dae5431",
   "license": "MIT",
   "description": "Client runtime for managing messages and translations in a React project.",
-  "main": "./src/index.ts",
+  "main": "./dist/index.js",
   "exports": {
     ".": {
       "default": "./dist/index.js",

package/src/intl-manager.ts

@@ -94,7 +94,7 @@ export class IntlManager<
   formatToParts<T extends TypedIntlMessageGetter<object | undefined>>(
     message: T,
     values?: Omit<FormatValuesFor<T>, DefaultValues>,
-  ) {
+  ): Array<string | any> {
     if (typeof message === 'string') return [message];
     const resolvedMessage = typeof message === 'function' ? message(this.currentLocale) : message;
     if (typeof resolvedMessage === 'string') return [resolvedMessage];

package/src/message-loader.ts

@@ -5,7 +5,6 @@ import type { MessageFormatElement } from '@formatjs/icu-messageformat-parser';
 type AnyRawMessage = string | MessageFormatElement[];
 type MessagesData = Record<string, AnyRawMessage>;
 export interface IntlMessageGetterAdditions {
-  isLocaleLoaded(locale: LocaleId): boolean;
   onChange(callback: () => void): () => void;
 }
 

package/src/react.ts

@@ -15,7 +15,7 @@ export class IntlManagerReact<
    */
   IntlMessage = <T extends TypedIntlMessageGetter<object | undefined>>(props: {
     message: T;
-    values?: Omit<FormatValuesFor<T>, DefaultValues>;
+    values?: Omit<FormatValuesFor<T>, DefaultValues> | never;
   }) => {
     const { message, values } = props;
     // Use the locale from this point in the application, which may be
@@ -25,14 +25,15 @@ export class IntlManagerReact<
     // TODO(faulty): This can and should be replaced by a
     // `use(messagesLoadedPromise)` once `use` is shipped to stable.
     React.useSyncExternalStore(message.onChange, () => message(locale));
-    // The return the formatted version of that string.
-    if (typeof message === 'string') return message;
-
-    return React.createElement(
-      React.Fragment,
-      undefined,
-      this.formatToParts(message, values as Omit<FormatValuesFor<T>, DefaultValues> | never),
-    );
+    // 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>),
+        );
   };
 
   /**
@@ -40,20 +41,15 @@ export class IntlManagerReact<
    * and respond to updates about the current locale and other relevant
    * information.
    */
-  format<T extends TypedIntlMessageGetter<object | undefined>>(message: T): JSX.Element;
+  format<T extends TypedIntlMessageGetter<object | undefined>>(message: T): React.ReactElement;
   format<T extends TypedIntlMessageGetter<object | undefined>>(
     message: T,
     values: Omit<FormatValuesFor<T>, DefaultValues>,
-  ): JSX.Element;
-  format(message: any): JSX.Element;
+  ): React.ReactElement;
   format<T extends TypedIntlMessageGetter<object | undefined>>(
     message: T,
     values?: Omit<FormatValuesFor<T>, DefaultValues>,
-  ) {
-    // A string literal means there's no locale dependency, so it can just be
-    // formatted directly without any subscription.
-    if (typeof message === 'string') return this.formatToParts(message);
-
-    return React.createElement(this.IntlMessage, { message, values });
+  ): React.ReactElement {
+    return React.createElement(this.IntlMessage<T>, { message, values });
   }
 }

package/src/types.d.ts

@@ -1,5 +1,6 @@
 import type { InternalIntlMessage } from './message';
 import type { IntlMessageGetterAdditions } from './message-loader';
+
 /**
  * Use this function to define messages as part of the `@discord/intl`
  * system, with type checking support.
@@ -60,7 +61,7 @@ type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
 /**
  * Given a message getter of type `T` (which may be a union of multiple message
  * types), return a combined type representing the intersection of all values
- * needed to satisfy the mix of values.
+ * needed to satisfy the mix of values defined in any of the messages.
  *
  * For example, given a variable representing one of two message getters, where
  * one requires a single value to be formatted, but the other requires an
@@ -123,7 +124,7 @@ type FormatValuesFor<T> =
   // formatter to optimize a little more on each call.
   [T] extends [TypedIntlMessageGetter<undefined>]
     ? never
-    : // The `never` conditino needs to be repeated here, but this time _without_
+    : // The `never` condition needs to be repeated here, but this time _without_
       // the `[]` syntax, so that only the union elements with actual values are
       // included in the union. Without this, the `infer U` on the latter side
       // fails to resolve and the type just becomes `never`.
@@ -134,25 +135,3 @@ type FormatValuesFor<T> =
             ? U
             : never
       >;
-
-/**
- * A generic definition of a `format*` function that accepts any message
- * argument as the first parameter, and the required values object for that
- * message as the second parameter. The second parameter
- *
- * An optional third parameter for additional options can be specified as the
- * second generic type parameter.
- */
-export interface IntlFormatFn<
-  T extends object | undefined,
-  DefaultValues extends string | number | symbol,
-  OptionsType,
-  ResultType,
-> {
-  (message: TypedIntlMessageGetter<T>, options?: OptionsType): ResultType;
-  (
-    message: TypedIntlMessageGetter<T>,
-    values: Omit<FormatValuesFor<T>, DefaultValues>,
-    options?: OptionsType,
-  ): ResultType;
-}