saykit 0.10.0 → 0.11.0

package/README.md

@@ -6,7 +6,7 @@
 
 The core runtime for [SayKit](https://saykit.js.org). Exports `createCatalogue`, which holds your locales and where each one's messages come from, `createView`, which binds one locale and formats messages using ICU MessageFormat, and `createStore`, which holds the current view and swaps it when you switch locale.
 
-You author messages with the `` say`...` `` tagged template (and `say.plural`, `say.ordinal`, `say.select`); a SayKit build-tool plugin rewrites them at build time into small runtime calls.
+You author messages with the `` say`...` `` tagged template (and `say.plural`, `say.ordinal`, `say.select`), and format numbers, dates and times for the locale with `say.number`, `say.date` and `say.time`; a SayKit build-tool plugin rewrites them at build time into small runtime calls.
 
 ## Install
 
@@ -29,6 +29,8 @@ const say = catalogue.locale('en');
 
 say`Hello, ${name}!`;
 say.plural(count, { one: '1 item', other: `${count} items` });
+say`Total: ${say.number(total, { style: '::currency/EUR' })}`;
+say.date(new Date(), { style: 'long' });
 ```
 
 In a browser, where the locale can change, hold a store instead of a view:

package/dist/index.d.mts

@@ -58,6 +58,18 @@ declare namespace View {
   type Messages = {
     [key: string]: string;
   };
+  /**
+   * What the transform compiles a message down to: the id it was extracted
+   * under, or the ICU message itself when there was nothing to extract, with
+   * its values behind one underscore each.
+   */
+  type Descriptor = ({
+    id: string;
+  } | {
+    message: string;
+  }) & {
+    [match: string | number]: unknown;
+  };
 }
 /**
  * One locale, bound to the messages it formats against.
@@ -104,16 +116,17 @@ interface View<Locale extends string = string> {
   /** The messages this view formats against. */
   readonly messages: Readonly<View.Messages>;
   /**
-   * Format the message a descriptor names.
+   * Format the message a descriptor names, or the message it carries.
+   *
+   * A message with nothing to translate, a lone `say.date(x)` with no text
+   * around it, is never extracted: the transform writes the ICU into the call
+   * instead of an id.
    *
    * @param descriptor Descriptor to format
    * @returns The formatted message
    * @throws If the id has no message
    */
-  call(descriptor: {
-    id: string;
-    [match: string | number]: unknown;
-  }): string;
+  call(descriptor: View.Descriptor): string;
   /**
    * Define a pluralised message.
    *
@@ -268,13 +281,6 @@ declare namespace Catalogue {
   type Produced = View.Messages | {
     default: View.Messages;
   };
-  /**
-   * Where each locale's messages come from, keyed by locale.
-   *
-   * The keys are the catalogue's locales, in the order they are written, and
-   * the first of them is the default locale.
-   */
-  type Options<Locale extends string> = Record<Locale, Source>;
 }
 /**
  * Everything an application knows how to say: its locales and where their
@@ -356,10 +362,12 @@ interface Catalogue<Locale extends string = string> {
  * const say = catalogue.locale('en');
  * ```
  *
- * @param messages Where each locale's messages come from, keyed by locale
+ * @param messages Where each locale's messages come from, keyed by locale. The
+ *   keys are the catalogue's locales, in the order they are written, and the
+ *   first of them is the default locale
  * @returns The catalogue
  */
-declare function createCatalogue<const Locale extends string = string>(messages: Catalogue.Options<Locale>): Catalogue<Locale>;
+declare function createCatalogue<const Locale extends string = string>(messages: Record<Locale, Catalogue.Source>): Catalogue<Locale>;
 //#endregion
 //#region src/store.d.ts
 declare namespace Store {

package/dist/index.mjs

@@ -426,7 +426,7 @@ function compile(locale, source) {
 //#endregion
 //#region src/view.ts
 function resolveDescriptorValues(descriptor) {
-	return Object.fromEntries(Object.entries(descriptor).filter(([key]) => key !== "id").map(([key, value]) => [key.startsWith("_") ? key.slice(1) : key, value]));
+	return Object.fromEntries(Object.entries(descriptor).filter(([key]) => key !== "id" && key !== "message").map(([key, value]) => [key.startsWith("_") ? key.slice(1) : key, value]));
 }
 function macro(name) {
 	throw new Error(`'say.${name}' is a macro and must be used with the relevant saykit plugin`);
@@ -438,10 +438,10 @@ function createView(locale, messages) {
 		throw new Error("'say' is a macro and must be used with the relevant saykit plugin");
 	});
 	function call(descriptor) {
-		const message = own[descriptor.id];
-		if (typeof message !== "string") throw new Error(`Message for ${descriptor.id} is not a string`);
-		let format = formats.get(descriptor.id);
-		if (!format) formats.set(descriptor.id, format = compile(locale, message));
+		const { id, message = own[id] } = descriptor;
+		if (typeof message !== "string") throw new Error(`Message for ${id} is not a string`);
+		let format = formats.get(message);
+		if (!format) formats.set(message, format = compile(locale, message));
 		return String(format.format(resolveDescriptorValues(descriptor)));
 	}
 	return Object.freeze(Object.defineProperties(say, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "saykit",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Type-safe i18n library with compile-time macro transforms",
   "keywords": [
     "i18n",