@ethisyscore/plugin-ui 1.94.1 → 1.95.0

package/dist/platform-react/index.d.cts

@@ -298,6 +298,33 @@ declare const ORGANISATION_SETTINGS_URI = "ethisys:organisation-settings";
  */
 declare function useOrgFormatSync(): void;
 
+/**
+ * Reads the caller organisation's reporting currency from the host
+ * {@link REPORTING_CURRENCY_TOOL} and stamps it into the core-utils reporting-currency
+ * ref (`@ethisyscore/core-utils/money`), so THIS plugin bundle's pure
+ * `formatMoney(amount)` renders reporting-currency amounts in the org's currency
+ * without threading a code.
+ *
+ * The org-currency sibling of {@link useOrgFormatSync}. Each plugin bundle owns its
+ * own copy of the module ref, so this must run per bundle —
+ * `definePlatformReactPluginPage` and `definePlatformReactPluginOverlay` auto-call
+ * it once per surface mount, so plugins wire nothing.
+ *
+ * Reactive: the currency arrives asynchronously, after the surface has already
+ * rendered on the GBP fallback. The module ref is non-React, so a `useState` bump
+ * re-renders the surface once the currency resolves. Keyed on the active
+ * organisation id so switching organisation without a remount refetches.
+ *
+ * Fails open in both directions, mirroring {@link useOrgFormatSync}:
+ * - No TRANSPORT (standalone/mock run, unit test) — resolved via the OPTIONAL
+ *   accessor, degrades to a no-op and `formatMoney` uses the GBP fallback.
+ * - No ACCESSOR (host realm older than SDK 1.88.0) — see the module-scope
+ *   resolution above.
+ * On a rejected/failed fetch the ref is reset to the GBP fallback rather than left
+ * holding a previous organisation's currency.
+ */
+declare function useReportingCurrencySync(): void;
+
 /** Host tool that resolves the caller org's reporting currency (default, else GBP). */
 declare const REPORTING_CURRENCY_TOOL = "settings:get-organisation-reporting-currency";
 /** Host tool that lists the currency catalogue. */
@@ -1359,4 +1386,4 @@ interface MenuConfigHostSidebarOptions {
  */
 declare function menuConfigToHostSidebarInput(config: HeaderMenuItem[], opts: MenuConfigHostSidebarOptions): HostSidebarHookInput;
 
-export { type AuthenticatedQueryResult, type CurrencyInfo, type CurrencySelector, DEFAULT_MAX_UPLOAD_BYTES, type DefinePlatformReactPluginOverlayOptions, type DefinePlatformReactPluginPageOptions, EHX_PLUGIN_PORTAL_ATTR, EHX_PLUGIN_PORTAL_CLASS, EHX_PLUGIN_ROOT_CLASS, HostSidebarHookInput, HostSidebarInput, type InsetLease, LIST_CURRENCIES_TOOL, type ManagedLifecycle, type McpToolArgs, type McpToolContract, type McpToolContracts, type McpToolResult, type MenuConfigHostSidebarOptions, MissingViewFallback, ORGANISATION_SETTINGS_URI, OVERLAY_HOST_CONTRACT_VERSION, type OverlayHostApi, type OverlayHostCapabilities, OverlayHostContext, type PlatformReactOverlayProps, type PluginOverlayDefinerConfig, type PluginPageDefinerConfig, PluginPortalScope, PluginStyleScope, REPORTING_CURRENCY_TOOL, type ReactRouterShimOptions, SurfaceBaseContext, type SurfaceBaseValue, TemplateContext, type TemplateManifest, type ToHostSidebarInputOptions, ToolInvoker, TypedMcpService, type UseCurrencyResult, type UseMcpUploadOptions, type UseMcpUploadResult, type UseMcpUploadTarget, type ViewComponent, buildSurfaceUrl, createPluginOverlayDefiner, createPluginPageDefiner, createReactRouterShim, createUseView, definePlatformReactPluginOverlay, definePlatformReactPluginPage, deriveHostEntityToken, injectPluginStyles, isComponent, mcpTool, menuConfigToHostSidebarInput, normaliseSlug, resolveSurfaceBase, surfacePathFor, toHostSidebarInput, useAuthenticatedQueries, useAuthenticatedQuery, useCurrency, useManagedLifecycle, useMcpUpload, useOrgFormatSync, useOverlayHost, usePluginRealtime, useSurfaceUrl, useTypedToolInvokerMap, useView };
+export { type AuthenticatedQueryResult, type CurrencyInfo, type CurrencySelector, DEFAULT_MAX_UPLOAD_BYTES, type DefinePlatformReactPluginOverlayOptions, type DefinePlatformReactPluginPageOptions, EHX_PLUGIN_PORTAL_ATTR, EHX_PLUGIN_PORTAL_CLASS, EHX_PLUGIN_ROOT_CLASS, HostSidebarHookInput, HostSidebarInput, type InsetLease, LIST_CURRENCIES_TOOL, type ManagedLifecycle, type McpToolArgs, type McpToolContract, type McpToolContracts, type McpToolResult, type MenuConfigHostSidebarOptions, MissingViewFallback, ORGANISATION_SETTINGS_URI, OVERLAY_HOST_CONTRACT_VERSION, type OverlayHostApi, type OverlayHostCapabilities, OverlayHostContext, type PlatformReactOverlayProps, type PluginOverlayDefinerConfig, type PluginPageDefinerConfig, PluginPortalScope, PluginStyleScope, REPORTING_CURRENCY_TOOL, type ReactRouterShimOptions, SurfaceBaseContext, type SurfaceBaseValue, TemplateContext, type TemplateManifest, type ToHostSidebarInputOptions, ToolInvoker, TypedMcpService, type UseCurrencyResult, type UseMcpUploadOptions, type UseMcpUploadResult, type UseMcpUploadTarget, type ViewComponent, buildSurfaceUrl, createPluginOverlayDefiner, createPluginPageDefiner, createReactRouterShim, createUseView, definePlatformReactPluginOverlay, definePlatformReactPluginPage, deriveHostEntityToken, injectPluginStyles, isComponent, mcpTool, menuConfigToHostSidebarInput, normaliseSlug, resolveSurfaceBase, surfacePathFor, toHostSidebarInput, useAuthenticatedQueries, useAuthenticatedQuery, useCurrency, useManagedLifecycle, useMcpUpload, useOrgFormatSync, useOverlayHost, usePluginRealtime, useReportingCurrencySync, useSurfaceUrl, useTypedToolInvokerMap, useView };

package/dist/platform-react/index.d.ts

@@ -298,6 +298,33 @@ declare const ORGANISATION_SETTINGS_URI = "ethisys:organisation-settings";
  */
 declare function useOrgFormatSync(): void;
 
+/**
+ * Reads the caller organisation's reporting currency from the host
+ * {@link REPORTING_CURRENCY_TOOL} and stamps it into the core-utils reporting-currency
+ * ref (`@ethisyscore/core-utils/money`), so THIS plugin bundle's pure
+ * `formatMoney(amount)` renders reporting-currency amounts in the org's currency
+ * without threading a code.
+ *
+ * The org-currency sibling of {@link useOrgFormatSync}. Each plugin bundle owns its
+ * own copy of the module ref, so this must run per bundle —
+ * `definePlatformReactPluginPage` and `definePlatformReactPluginOverlay` auto-call
+ * it once per surface mount, so plugins wire nothing.
+ *
+ * Reactive: the currency arrives asynchronously, after the surface has already
+ * rendered on the GBP fallback. The module ref is non-React, so a `useState` bump
+ * re-renders the surface once the currency resolves. Keyed on the active
+ * organisation id so switching organisation without a remount refetches.
+ *
+ * Fails open in both directions, mirroring {@link useOrgFormatSync}:
+ * - No TRANSPORT (standalone/mock run, unit test) — resolved via the OPTIONAL
+ *   accessor, degrades to a no-op and `formatMoney` uses the GBP fallback.
+ * - No ACCESSOR (host realm older than SDK 1.88.0) — see the module-scope
+ *   resolution above.
+ * On a rejected/failed fetch the ref is reset to the GBP fallback rather than left
+ * holding a previous organisation's currency.
+ */
+declare function useReportingCurrencySync(): void;
+
 /** Host tool that resolves the caller org's reporting currency (default, else GBP). */
 declare const REPORTING_CURRENCY_TOOL = "settings:get-organisation-reporting-currency";
 /** Host tool that lists the currency catalogue. */
@@ -1359,4 +1386,4 @@ interface MenuConfigHostSidebarOptions {
  */
 declare function menuConfigToHostSidebarInput(config: HeaderMenuItem[], opts: MenuConfigHostSidebarOptions): HostSidebarHookInput;
 
-export { type AuthenticatedQueryResult, type CurrencyInfo, type CurrencySelector, DEFAULT_MAX_UPLOAD_BYTES, type DefinePlatformReactPluginOverlayOptions, type DefinePlatformReactPluginPageOptions, EHX_PLUGIN_PORTAL_ATTR, EHX_PLUGIN_PORTAL_CLASS, EHX_PLUGIN_ROOT_CLASS, HostSidebarHookInput, HostSidebarInput, type InsetLease, LIST_CURRENCIES_TOOL, type ManagedLifecycle, type McpToolArgs, type McpToolContract, type McpToolContracts, type McpToolResult, type MenuConfigHostSidebarOptions, MissingViewFallback, ORGANISATION_SETTINGS_URI, OVERLAY_HOST_CONTRACT_VERSION, type OverlayHostApi, type OverlayHostCapabilities, OverlayHostContext, type PlatformReactOverlayProps, type PluginOverlayDefinerConfig, type PluginPageDefinerConfig, PluginPortalScope, PluginStyleScope, REPORTING_CURRENCY_TOOL, type ReactRouterShimOptions, SurfaceBaseContext, type SurfaceBaseValue, TemplateContext, type TemplateManifest, type ToHostSidebarInputOptions, ToolInvoker, TypedMcpService, type UseCurrencyResult, type UseMcpUploadOptions, type UseMcpUploadResult, type UseMcpUploadTarget, type ViewComponent, buildSurfaceUrl, createPluginOverlayDefiner, createPluginPageDefiner, createReactRouterShim, createUseView, definePlatformReactPluginOverlay, definePlatformReactPluginPage, deriveHostEntityToken, injectPluginStyles, isComponent, mcpTool, menuConfigToHostSidebarInput, normaliseSlug, resolveSurfaceBase, surfacePathFor, toHostSidebarInput, useAuthenticatedQueries, useAuthenticatedQuery, useCurrency, useManagedLifecycle, useMcpUpload, useOrgFormatSync, useOverlayHost, usePluginRealtime, useSurfaceUrl, useTypedToolInvokerMap, useView };
+export { type AuthenticatedQueryResult, type CurrencyInfo, type CurrencySelector, DEFAULT_MAX_UPLOAD_BYTES, type DefinePlatformReactPluginOverlayOptions, type DefinePlatformReactPluginPageOptions, EHX_PLUGIN_PORTAL_ATTR, EHX_PLUGIN_PORTAL_CLASS, EHX_PLUGIN_ROOT_CLASS, HostSidebarHookInput, HostSidebarInput, type InsetLease, LIST_CURRENCIES_TOOL, type ManagedLifecycle, type McpToolArgs, type McpToolContract, type McpToolContracts, type McpToolResult, type MenuConfigHostSidebarOptions, MissingViewFallback, ORGANISATION_SETTINGS_URI, OVERLAY_HOST_CONTRACT_VERSION, type OverlayHostApi, type OverlayHostCapabilities, OverlayHostContext, type PlatformReactOverlayProps, type PluginOverlayDefinerConfig, type PluginPageDefinerConfig, PluginPortalScope, PluginStyleScope, REPORTING_CURRENCY_TOOL, type ReactRouterShimOptions, SurfaceBaseContext, type SurfaceBaseValue, TemplateContext, type TemplateManifest, type ToHostSidebarInputOptions, ToolInvoker, TypedMcpService, type UseCurrencyResult, type UseMcpUploadOptions, type UseMcpUploadResult, type UseMcpUploadTarget, type ViewComponent, buildSurfaceUrl, createPluginOverlayDefiner, createPluginPageDefiner, createReactRouterShim, createUseView, definePlatformReactPluginOverlay, definePlatformReactPluginPage, deriveHostEntityToken, injectPluginStyles, isComponent, mcpTool, menuConfigToHostSidebarInput, normaliseSlug, resolveSurfaceBase, surfacePathFor, toHostSidebarInput, useAuthenticatedQueries, useAuthenticatedQuery, useCurrency, useManagedLifecycle, useMcpUpload, useOrgFormatSync, useOverlayHost, usePluginRealtime, useReportingCurrencySync, useSurfaceUrl, useTypedToolInvokerMap, useView };

package/dist/platform-react/index.js

@@ -1,4 +1,4 @@
-import { createContext, useEffect, useContext, useState, useMemo, createElement, useCallback, useRef, useSyncExternalStore } from 'react';
+import { createContext, useEffect, useContext, useState, useMemo, useRef, createElement, useCallback, useSyncExternalStore } from 'react';
 import { QueryClient, useQuery, useQueries, QueryClientProvider } from '@tanstack/react-query';
 import { definePlatformReactPage, emitNavigation } from '@ethisyscore/components-react';
 import * as extensionRuntime from '@ethisyscore/extension-runtime/plugin';
@@ -6,7 +6,7 @@ import { useHostIdentity, useMcpTool, useOptionalExtensionRuntimeTransport, useP
 import { useTheme, ThemeProvider } from '@mui/material';
 import { jsxs, jsx } from 'react/jsx-runtime';
 import { setOrgFormats } from '@ethisyscore/core-utils/date/org-format';
-import { MONEY_FALLBACK_LOCALE, formatMoney } from '@ethisyscore/core-utils/money';
+import { setOrgReportingCurrency, MONEY_FALLBACK_LOCALE, formatMoney } from '@ethisyscore/core-utils/money';
 
 // src/platform-react/definePlatformReactPluginPage.tsx
 var TemplateContext = createContext(null);
@@ -182,6 +182,50 @@ function useOrgFormatSync() {
     return () => controller.abort();
   }, [transport, organisationId]);
 }
+var warnedAboutMissingAccessor2 = false;
+var useOptionalExtensionRuntimeTransport4 = typeof extensionRuntime.useOptionalExtensionRuntimeTransport === "function" ? extensionRuntime.useOptionalExtensionRuntimeTransport : () => {
+  if (!warnedAboutMissingAccessor2) {
+    warnedAboutMissingAccessor2 = true;
+    console.warn(
+      "[plugin-ui] The host realm does not expose useOptionalExtensionRuntimeTransport (host SDK predates 1.88.0). The organisation reporting currency falls back to GBP for this bundle. Bump the host's @ethisyscore/extension-runtime pin to restore it."
+    );
+  }
+  return null;
+};
+var REPORTING_CURRENCY_TOOL = "settings:get-organisation-reporting-currency";
+function useReportingCurrencySync() {
+  const transport = useOptionalExtensionRuntimeTransport4();
+  const organisationId = extensionRuntime.useHostIdentity()?.organisationId ?? null;
+  const [, bumpVersion] = useState(0);
+  const previousOrganisationId = useRef(void 0);
+  if (previousOrganisationId.current !== organisationId) {
+    previousOrganisationId.current = organisationId;
+    setOrgReportingCurrency(null);
+  }
+  useEffect(() => {
+    setOrgReportingCurrency(null);
+    bumpVersion((v) => v + 1);
+    if (!transport) return;
+    const controller = new AbortController();
+    transport.invokeTool(
+      REPORTING_CURRENCY_TOOL,
+      {},
+      controller.signal
+    ).then((result) => {
+      if (controller.signal.aborted) return;
+      const currency = result?.currency ?? null;
+      setOrgReportingCurrency(
+        currency ? { code: currency.code, decimalPlaces: currency.decimalPlaces } : null
+      );
+      bumpVersion((v) => v + 1);
+    }).catch(() => {
+      if (controller.signal.aborted) return;
+      setOrgReportingCurrency(null);
+      bumpVersion((v) => v + 1);
+    });
+    return () => controller.abort();
+  }, [transport, organisationId]);
+}
 
 // src/platform-react/definePlatformReactPluginPage.tsx
 function makeDefaultQueryClient() {
@@ -208,6 +252,7 @@ function definePlatformReactPluginPage(Page, options) {
   } = options;
   function PluginPage(props) {
     useOrgFormatSync();
+    useReportingCurrencySync();
     const page = createElement(Page, props);
     const body = wrapPage ? wrapPage(page) : page;
     const surfaceTree = createElement(
@@ -369,7 +414,7 @@ function useAuthenticatedQuery(options) {
 function useAuthenticatedQueries(queries) {
   return useQueries({ queries });
 }
-var REPORTING_CURRENCY_TOOL = "settings:get-organisation-reporting-currency";
+var REPORTING_CURRENCY_TOOL2 = "settings:get-organisation-reporting-currency";
 var LIST_CURRENCIES_TOOL = "settings:list-currencies";
 var emptyCatalogue = () => /* @__PURE__ */ new Map();
 var SETTLED_FULFILLED = "fulfilled";
@@ -390,7 +435,7 @@ function useCurrency() {
     const controller = new AbortController();
     Promise.allSettled([
       transport.invokeTool(
-        REPORTING_CURRENCY_TOOL,
+        REPORTING_CURRENCY_TOOL2,
         {},
         controller.signal
       ),
@@ -402,7 +447,8 @@ function useCurrency() {
     ]).then(([reporting, list]) => {
       if (controller.signal.aborted) return;
       if (reporting.status === SETTLED_FULFILLED) {
-        setReportingCurrency(reporting.value?.currency ?? null);
+        const resolved = reporting.value?.currency ?? null;
+        setReportingCurrency(resolved);
       }
       if (list.status === SETTLED_FULFILLED && Array.isArray(list.value)) {
         setCurrencies(new Map(list.value.map((currency) => [currency.id, currency])));
@@ -700,6 +746,7 @@ function definePlatformReactPluginOverlay(Overlay, options) {
   const { rootClassName, styleId, css, manifest = {}, queryClient = defaultQueryClient2, wrapOverlay } = options;
   return function MountedOverlay(props) {
     useOrgFormatSync();
+    useReportingCurrencySync();
     const tree = createElement(
       OverlayHostContext.Provider,
       { value: props.overlayHost },
@@ -1022,6 +1069,6 @@ function menuConfigToHostSidebarInput(config, opts) {
   return { mode: "actions", actions };
 }
 
-export { BaseMcpService, DEFAULT_MAX_UPLOAD_BYTES, EHX_PLUGIN_PORTAL_ATTR, EHX_PLUGIN_PORTAL_CLASS, EHX_PLUGIN_ROOT_CLASS, HOST_CHROME_CONTRACT_VERSION, HostSidebarActionsContext, LIST_CURRENCIES_TOOL, MissingViewFallback, ORGANISATION_SETTINGS_URI, OVERLAY_HOST_CONTRACT_VERSION, OverlayHostContext, PluginPortalScope, PluginStyleScope, REPORTING_CURRENCY_TOOL, SIDEBAR_MODE, SurfaceBaseContext, TemplateContext, TypedMcpService, buildSurfaceUrl, createPluginOverlayDefiner, createPluginPageDefiner, createReactRouterShim, createUseView, definePlatformReactPluginOverlay, definePlatformReactPluginPage, deriveHostEntityToken, injectPluginStyles, isComponent, isHostChromeCompatible, mcpTool, menuConfigToHostSidebarInput, normaliseSlug, notViaMcp, reportHostChromeDiagnostic, resolveSurfaceBase, setHostChromeDiagnosticSink, surfacePathFor, toHostSidebarInput, useAuthenticatedQueries, useAuthenticatedQuery, useCurrency, useHostSidebarActions, useManagedLifecycle, useMcpUpload, useOrgFormatSync, useOverlayHost, usePluginRealtime, useSurfaceUrl, useToolInvoker, useToolInvokerMap, useTypedToolInvokerMap, useView };
+export { BaseMcpService, DEFAULT_MAX_UPLOAD_BYTES, EHX_PLUGIN_PORTAL_ATTR, EHX_PLUGIN_PORTAL_CLASS, EHX_PLUGIN_ROOT_CLASS, HOST_CHROME_CONTRACT_VERSION, HostSidebarActionsContext, LIST_CURRENCIES_TOOL, MissingViewFallback, ORGANISATION_SETTINGS_URI, OVERLAY_HOST_CONTRACT_VERSION, OverlayHostContext, PluginPortalScope, PluginStyleScope, REPORTING_CURRENCY_TOOL2 as REPORTING_CURRENCY_TOOL, SIDEBAR_MODE, SurfaceBaseContext, TemplateContext, TypedMcpService, buildSurfaceUrl, createPluginOverlayDefiner, createPluginPageDefiner, createReactRouterShim, createUseView, definePlatformReactPluginOverlay, definePlatformReactPluginPage, deriveHostEntityToken, injectPluginStyles, isComponent, isHostChromeCompatible, mcpTool, menuConfigToHostSidebarInput, normaliseSlug, notViaMcp, reportHostChromeDiagnostic, resolveSurfaceBase, setHostChromeDiagnosticSink, surfacePathFor, toHostSidebarInput, useAuthenticatedQueries, useAuthenticatedQuery, useCurrency, useHostSidebarActions, useManagedLifecycle, useMcpUpload, useOrgFormatSync, useOverlayHost, usePluginRealtime, useReportingCurrencySync, useSurfaceUrl, useToolInvoker, useToolInvokerMap, useTypedToolInvokerMap, useView };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map