@saykit/react 0.8.0 → 0.9.0

package/dist/client.mjs

@@ -4,17 +4,6 @@ import { Say } from "saykit";
 //#region src/runtime/client.ts
 const SayContext = createContext({ current: null });
 SayContext.displayName = "SayContext";
-/**
-* Provide a localised {@link runtime.Say} instance to descendant **client** components via context.
-* Must wrap any component tree using {@link useSay} or {@link Say}.
-*
-* The instance is rebuilt whenever `locale` or `messages` changes, so keep `messages`
-* referentially stable (module scope, or memoised) rather than passing a fresh object
-* literal on every render.
-*
-* @param props.locale The current locale
-* @param props.messages The current messages for the locale
-*/
 function SayProvider({ locale, messages, children }) {
 	const ref = useMemo(() => {
 		const instance = new Say({
@@ -27,13 +16,6 @@ function SayProvider({ locale, messages, children }) {
 	}, [locale, messages]);
 	return createElement(SayContext.Provider, { value: ref }, children);
 }
-/**
-* Get the current {@link Say} **client** instance.
-* Must be called within a {@link SayProvider}.
-*
-* @returns The current {@link Say} instance
-* @throws If no provider is in the component tree
-*/
 function useSay() {
 	const ref = useContext(SayContext);
 	if (!ref.current) throw new Error("'useSay' must be used within a 'SayProvider'");

package/dist/index.d.mts

@@ -100,10 +100,12 @@ declare namespace Say {
    * ```tsx
    * <Say>You have <Say.Number _={items.length} /> items</Say>
    * <Say>Battery at <Say.Number _={level} style="percent" /></Say>
+   * <Say>Total <Say.Number _={total} style="::currency/EUR" /></Say>
    * ```
    *
    * @param props._ Number to format
-   * @param props.style Formatting style, either a named style or a literal number pattern
+   * @param props.style Formatting style: a named style, an ICU skeleton such as
+   *   `::currency/EUR`, or a literal number pattern such as `#,##0.00`
    * @returns The formatted number, as a React node
    * @remark This is a macro and must be used with the relevant saykit plugin
    */
@@ -116,10 +118,12 @@ declare namespace Say {
    * @example
    * ```tsx
    * <Say>Published <Say.Date _={post.publishedAt} style="medium" /></Say>
+   * <Say>Published <Say.Date _={post.publishedAt} style="::yMMMM" /></Say>
    * ```
    *
    * @param props._ Date to format
-   * @param props.style Formatting style
+   * @param props.style Formatting style, either a named style or an ICU
+   *   skeleton such as `::yyyyMMdd`
    * @returns The formatted date, as a React node
    * @remark This is a macro and must be used with the relevant saykit plugin
    */
@@ -132,10 +136,12 @@ declare namespace Say {
    * @example
    * ```tsx
    * <Say>Doors open at <Say.Time _={opensAt} style="short" /></Say>
+   * <Say>Doors open at <Say.Time _={opensAt} style="::Hm" /></Say>
    * ```
    *
    * @param props._ Date to format
-   * @param props.style Formatting style
+   * @param props.style Formatting style, either a named style or an ICU
+   *   skeleton such as `::Hm`
    * @returns The formatted time, as a React node
    * @remark This is a macro and must be used with the relevant saykit plugin
    */

package/dist/index.mjs

@@ -47,17 +47,6 @@ function Renderer({ html, components, whitespace = true }) {
 }
 //#endregion
 //#region src/types.ts
-/**
-* Map the props the transform compiled a message's values into back to the
-* identifiers they carry. Every value is emitted with one underscore in front,
-* which is what keeps a numbered identifier a valid prop name and what keeps
-* any name a message chooses out of `Say`'s own namespace, so stripping exactly
-* one is the whole inverse — `_0` is `0`, and `__link` is a tag named `_link`.
-*
-* The result is deliberately not typed as the props that went in: renaming the
-* keys is the point, so claiming they survived would be a lie the only caller
-* cannot use anyway, it looks tags up by a name that comes from a translation.
-*/
 function resolveValuePropKeys(props) {
 	const result = {};
 	for (const key in props) if (key.startsWith("_")) result[key.slice(1)] = props[key];

package/dist/index.server.mjs

@@ -47,17 +47,6 @@ function Renderer({ html, components, whitespace = true }) {
 }
 //#endregion
 //#region src/types.ts
-/**
-* Map the props the transform compiled a message's values into back to the
-* identifiers they carry. Every value is emitted with one underscore in front,
-* which is what keeps a numbered identifier a valid prop name and what keeps
-* any name a message chooses out of `Say`'s own namespace, so stripping exactly
-* one is the whole inverse — `_0` is `0`, and `__link` is a tag named `_link`.
-*
-* The result is deliberately not typed as the props that went in: renaming the
-* keys is the point, so claiming they survived would be a lie the only caller
-* cannot use anyway, it looks tags up by a name that comes from a translation.
-*/
 function resolveValuePropKeys(props) {
 	const result = {};
 	for (const key in props) if (key.startsWith("_")) result[key.slice(1)] = props[key];

package/dist/server.mjs

@@ -3,40 +3,17 @@ import { Say } from "saykit";
 import "server-only";
 //#region src/runtime/server.ts
 const serverContext = cache(() => ({ current: null }));
-/**
-* Set the current {@link Say} **server** instance.
-* Must be called before any {@link getSay} calls.
-*
-* @param say The current {@link Say} instance
-*/
 function setSay(say) {
 	const ref = serverContext();
 	if (say instanceof Say) ref.current = say.clone().freeze();
 	else ref.current = say().clone().freeze();
 }
-/**
-* Get the current {@link Say} **server** instance.
-* Must only be called after any {@link setSay} calls.
-*
-* @returns The current {@link Say} instance
-* @throws If no {@link Say} instance has been set
-*/
 function getSay() {
 	const ref = serverContext();
 	if (!ref.current) throw new Error("Attempt to access the server-only Say instance before initialisation", { cause: /* @__PURE__ */ new Error("'getSay' must be called after 'setSay'") });
 	return ref.current;
 }
-/**
-* Create a {@link withSay} higher-order component factory bound to a specific {@link Say} instance.
-*
-* @param say The {@link Say} instance to bind into the server context
-*
-* @returns A {@link withSay} higher-order component factory
-*/
 function unstable_createWithSay(say) {
-	/**
-	* Wrap a server component so that a {@link Say} instance is initialised before render.
-	*/
 	return function withSay(Component, getLocale) {
 		return async function WithSay(props) {
 			const guess = await getLocale(props);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saykit/react",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "React integration for saykit, i18n hooks and components",
   "keywords": [
     "i18n",
@@ -52,7 +52,7 @@
     "jsdom": "^29.1.1",
     "react": "^19.2.8",
     "react-dom": "^19.2.8",
-    "saykit": "^0.8.0"
+    "saykit": "^0.9.0"
   },
   "peerDependencies": {
     "react": "*",