@machinemetrics/mm-react-tools 5.3.0 → 5.4.0

package/dist/useMMAgent.d.ts

@@ -0,0 +1,69 @@
+/**
+ * App → Max, through the dashboard host. Use inside MMProvider.
+ *
+ *  - `report(kind, payload)`: background context for Max (`agent:event`).
+ *    Never the user's words.
+ *  - `ask(prompt, { newConversation })`: the user's own message to Max
+ *    (`agent:ask`), into the open conversation or a fresh one. It says
+ *    nothing about pages: an app that wants the page to the left of Max to
+ *    change asks, then navigates (in that order: the host only takes
+ *    messages from a frame that still exists, and navigating can unmount
+ *    it). The host holds the prompt until the new page is up.
+ *
+ * `ask` only works right after a user action (a click or key press): the
+ * browser's transient user activation. The host checks the same on its own
+ * window, so this check is for a clear error, not the security boundary.
+ */
+export declare const ASK_MAX_LENGTH = 4000;
+export declare const AGENT_ASK = "agent:ask";
+export declare const AGENT_ASK_CONSUMED = "agent:ask-consumed";
+export declare const AGENT_ASK_SOURCES: readonly ["app-gallery-builder", "app-gallery", "cml-renderer"];
+/** App-to-host request; the host supplies source and timestamp when forwarding. */
+export interface AgentAskPayload {
+    prompt: string;
+    newConversation?: boolean;
+}
+export interface AgentHostPrompt {
+    at: number;
+    prompt: string;
+    source: (typeof AGENT_ASK_SOURCES)[number];
+}
+export interface AgentAskConsumedPayload {
+    kind: 'newThreadPrompt' | 'agentAsk';
+    at: number;
+}
+export type AgentEventKind = 'app.error' | 'app.event' | 'app.context';
+/** Renderer event contract; threadId routes the event to its conversation. */
+export interface AgentEvent {
+    id: string;
+    kind: AgentEventKind;
+    at: string;
+    threadId: string;
+    app?: string;
+    /** Legacy alias; threadId is still required. */
+    thread?: string;
+    appId?: string;
+    surface?: 'page' | 'sidesheet' | 'widget' | 'tab' | 'tools';
+    message?: string;
+    summary?: string;
+    errors?: string[];
+    version?: number;
+    data?: unknown;
+}
+export type AgentEventPayload = Omit<AgentEvent, 'id' | 'kind' | 'at'>;
+export interface AskOptions {
+    /** Start a fresh conversation with this prompt as its first message. */
+    newConversation?: boolean;
+}
+export type AskResult = {
+    ok: true;
+} | {
+    ok: false;
+    reason: 'not-embedded' | 'no-user-action' | 'empty' | 'too-long';
+};
+export interface MMAgent {
+    report: (kind: AgentEventKind, payload: AgentEventPayload) => boolean;
+    ask: (prompt: string, options?: AskOptions) => AskResult;
+}
+export declare const useMMAgent: () => MMAgent;
+//# sourceMappingURL=useMMAgent.d.ts.map

package/dist/useMMAgent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMMAgent.d.ts","sourceRoot":"","sources":["../src/useMMAgent.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,cAAc,OAAO,CAAC;AACnC,eAAO,MAAM,SAAS,cAAc,CAAC;AACrC,eAAO,MAAM,kBAAkB,uBAAuB,CAAC;AACvD,eAAO,MAAM,iBAAiB,iEAIpB,CAAC;AAEX,mFAAmF;AACnF,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,iBAAiB,GAAG,UAAU,CAAC;IACrC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,WAAW,GAAG,aAAa,CAAC;AAEvE,8EAA8E;AAC9E,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,cAAc,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAC;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC;AASvE,MAAM,WAAW,UAAU;IACzB,wEAAwE;IACxE,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,MAAM,SAAS,GACjB;IAAE,EAAE,EAAE,IAAI,CAAA;CAAE,GACZ;IACE,EAAE,EAAE,KAAK,CAAC;IACV,MAAM,EAAE,cAAc,GAAG,gBAAgB,GAAG,OAAO,GAAG,UAAU,CAAC;CAClE,CAAC;AAEN,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC;IACtE,GAAG,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,KAAK,SAAS,CAAC;CAC1D;AAMD,eAAO,MAAM,UAAU,QAAO,OA6C7B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@machinemetrics/mm-react-tools",
-  "version": "5.3.0",
+  "version": "5.4.0",
   "description": "Components, hooks, and helper functions for writing React apps using MachineMetrics APIs.",
   "author": "machinemetrics",
   "license": "MIT",