@matterfact/embed 0.8.0 → 0.9.0

package/dist/react.d.cts

@@ -24,6 +24,43 @@ interface PageEntity {
     text?: string;
     data?: Record<string, unknown>;
 }
+/**
+ * How a route's content is classified, for the annotated site map.
+ *
+ * The host DECORATES the site map we auto-derive (see `SiteMapEntry`) so the agent
+ * knows which routes carry MATTERFACT content and of what kind — app-wide awareness
+ * it can navigate toward. This is CLASSIFICATION only: no per-instance ids, and never
+ * a capability token. The concrete artifact/document on the CURRENT page still arrives
+ * via `host.context` entities / `host.artifactGrants`, resolved per page.
+ *
+ *  - `mf-artifact`  — a co-embedded matterfact artifact (its slug); the token stays on
+ *                     the live iframe / grant, never here.
+ *  - `mf-document`  — a matterfact document (dossier/report), resolved to an MF_DOC_ID
+ *                     host-side per page.
+ *  - `host-data`    — the host's own data; not a matterfact entity.
+ */
+type ContentClass = {
+    kind: 'mf-artifact';
+    slug: string;
+} | {
+    kind: 'mf-document';
+    doctype: string;
+} | {
+    kind: 'host-data';
+};
+/**
+ * One route in the annotated site map: the path pattern + label we derived, plus the
+ * host's content classification. `current` marks the route the user is on.
+ */
+interface SiteMapEntry {
+    /** Route pattern or path, e.g. '/app/company/:ticker/dossier'. */
+    path: string;
+    /** Human label for the route ('Company Dossier'). */
+    label?: string;
+    /** The host's classification of this route's content, when it annotated it. */
+    content?: ContentClass;
+    current?: boolean;
+}
 
 /**
  * The Hoist adapter — a pure transform from a `HoistRuntime` (already read out of
@@ -108,8 +145,19 @@ interface MatterfactAgentProps {
      * carry. See `writeActionsGlobal` below.
      */
     actions?: HoistActionsConfig;
+    /**
+     * The app's site map, annotated with each route's content class — so the agent knows
+     * which routes carry matterfact content (a co-embedded artifact, a document/report) or
+     * the host's own data, and can navigate toward them.
+     *
+     * Classification only: give the route pattern + label + a `content` tag; NEVER a
+     * capability token (the concrete artifact/document on the current page arrives via page
+     * context / the live iframe). Sugar over `window.matterfact.sitemap`, read by the loader
+     * on load and on navigation.
+     */
+    sitemap?: SiteMapEntry[];
 }
-declare function MatterfactAgent({ publishableKey, widgetOrigin, surface, theme, getAuthToken, getPageContext, inline, className, style, pageContext, dev, actions, }: MatterfactAgentProps): react_jsx_runtime.JSX.Element | null;
+declare function MatterfactAgent({ publishableKey, widgetOrigin, surface, theme, getAuthToken, getPageContext, inline, className, style, pageContext, dev, actions, sitemap, }: MatterfactAgentProps): react_jsx_runtime.JSX.Element | null;
 interface MatterfactArtifactProps {
     /** The artifact's slug/name. */
     slug: string;

package/dist/react.d.ts

@@ -24,6 +24,43 @@ interface PageEntity {
     text?: string;
     data?: Record<string, unknown>;
 }
+/**
+ * How a route's content is classified, for the annotated site map.
+ *
+ * The host DECORATES the site map we auto-derive (see `SiteMapEntry`) so the agent
+ * knows which routes carry MATTERFACT content and of what kind — app-wide awareness
+ * it can navigate toward. This is CLASSIFICATION only: no per-instance ids, and never
+ * a capability token. The concrete artifact/document on the CURRENT page still arrives
+ * via `host.context` entities / `host.artifactGrants`, resolved per page.
+ *
+ *  - `mf-artifact`  — a co-embedded matterfact artifact (its slug); the token stays on
+ *                     the live iframe / grant, never here.
+ *  - `mf-document`  — a matterfact document (dossier/report), resolved to an MF_DOC_ID
+ *                     host-side per page.
+ *  - `host-data`    — the host's own data; not a matterfact entity.
+ */
+type ContentClass = {
+    kind: 'mf-artifact';
+    slug: string;
+} | {
+    kind: 'mf-document';
+    doctype: string;
+} | {
+    kind: 'host-data';
+};
+/**
+ * One route in the annotated site map: the path pattern + label we derived, plus the
+ * host's content classification. `current` marks the route the user is on.
+ */
+interface SiteMapEntry {
+    /** Route pattern or path, e.g. '/app/company/:ticker/dossier'. */
+    path: string;
+    /** Human label for the route ('Company Dossier'). */
+    label?: string;
+    /** The host's classification of this route's content, when it annotated it. */
+    content?: ContentClass;
+    current?: boolean;
+}
 
 /**
  * The Hoist adapter — a pure transform from a `HoistRuntime` (already read out of
@@ -108,8 +145,19 @@ interface MatterfactAgentProps {
      * carry. See `writeActionsGlobal` below.
      */
     actions?: HoistActionsConfig;
+    /**
+     * The app's site map, annotated with each route's content class — so the agent knows
+     * which routes carry matterfact content (a co-embedded artifact, a document/report) or
+     * the host's own data, and can navigate toward them.
+     *
+     * Classification only: give the route pattern + label + a `content` tag; NEVER a
+     * capability token (the concrete artifact/document on the current page arrives via page
+     * context / the live iframe). Sugar over `window.matterfact.sitemap`, read by the loader
+     * on load and on navigation.
+     */
+    sitemap?: SiteMapEntry[];
 }
-declare function MatterfactAgent({ publishableKey, widgetOrigin, surface, theme, getAuthToken, getPageContext, inline, className, style, pageContext, dev, actions, }: MatterfactAgentProps): react_jsx_runtime.JSX.Element | null;
+declare function MatterfactAgent({ publishableKey, widgetOrigin, surface, theme, getAuthToken, getPageContext, inline, className, style, pageContext, dev, actions, sitemap, }: MatterfactAgentProps): react_jsx_runtime.JSX.Element | null;
 interface MatterfactArtifactProps {
     /** The artifact's slug/name. */
     slug: string;

package/dist/react.js

@@ -5,7 +5,7 @@
 import { useEffect, useRef } from "react";
 
 // src/protocol.ts
-var PROTOCOL_VERSION = 2;
+var PROTOCOL_VERSION = 3;
 var CHANNEL = "mf-embed";
 function envelope(payload, id) {
   return {
@@ -575,6 +575,9 @@ var EmbedHost = class {
       case "widget.needsAuth":
         void this.provideAuth();
         break;
+      case "widget.navigate":
+        void this.loadContext().then((m) => m.navigateHost(msg.href));
+        break;
     }
   }
   /**
@@ -691,7 +694,7 @@ var EmbedHost = class {
     }
   }
   loadContext() {
-    this.context ?? (this.context = import("./context-MVGSYIMB.js").then((m) => {
+    this.context ?? (this.context = import("./context-U2HJJN2S.js").then((m) => {
       m.start(
         this.send,
         this.config.origin,
@@ -739,6 +742,11 @@ function writeActionsGlobal(actions) {
   const mf = w.matterfact ?? (w.matterfact = {});
   mf.hoist = { ...mf.hoist, actions: actions ?? { navigate: "off" } };
 }
+function writeSitemapGlobal(sitemap) {
+  if (typeof window === "undefined" || sitemap === void 0) return;
+  const w = window;
+  (w.matterfact ?? (w.matterfact = {})).sitemap = sitemap;
+}
 function MatterfactAgent({
   publishableKey,
   widgetOrigin,
@@ -751,7 +759,8 @@ function MatterfactAgent({
   style,
   pageContext,
   dev,
-  actions
+  actions,
+  sitemap
 }) {
   const authRef = useRef(getAuthToken);
   authRef.current = getAuthToken;
@@ -761,6 +770,10 @@ function MatterfactAgent({
   actionsRef.current = actions;
   const actionsKey = JSON.stringify(actions ?? null);
   const slot = useRef(null);
+  const sitemapKey = JSON.stringify(sitemap ?? null);
+  useEffect(() => {
+    writeSitemapGlobal(sitemap);
+  }, [sitemapKey]);
   useEffect(() => {
     if (typeof window === "undefined") return;
     if (inline && !slot.current) return;