@progress/kendo-react-common 14.5.0-develop.13 → 14.5.0-develop.14

package/WebMcpProvider.d.ts

@@ -0,0 +1,110 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * WebMcpProvider – Generic React Context Provider for Web MCP configuration.
+ *
+ * Wraps a section of the component tree so that any KendoReact component
+ * (Grid, Form, Scheduler, etc.) inside it automatically registers
+ * browser-native AI agent tools via `navigator.modelContext.registerTool()` (Chrome 146+).
+ *
+ * Lives in `@progress/kendo-react-common` so every component package can
+ * consume the context without cross-package imports.
+ *
+ * @example
+ * ```tsx
+ * import { WebMcpProvider } from '@progress/kendo-react-common';
+ *
+ * <WebMcpProvider>
+ *     <Grid data={dataResult} sortable webMcp={{ dataName: 'employees' }} />
+ * </WebMcpProvider>
+ * ```
+ */
+import * as React from 'react';
+/** @internal Result returned by a registered Web MCP tool. */
+export interface WebMcpToolResult {
+    content: Array<{
+        type: 'text';
+        text: string;
+    }>;
+    isError?: boolean;
+}
+/** @internal Handle returned by `navigator.modelContext.registerTool()`. */
+export interface WebMcpToolRegistration {
+    unregister: () => void;
+}
+/** @internal The `navigator.modelContext` surface in Chrome 146+. */
+export interface WebMcpModelContext {
+    registerTool: (config: {
+        name: string;
+        description: string;
+        inputSchema: Record<string, unknown>;
+        execute: (args: Record<string, unknown>) => Promise<WebMcpToolResult>;
+    }) => WebMcpToolRegistration;
+}
+/** Describes a single tool to register via WebMcpProvider. */
+export interface McpToolOption {
+    /** Short identifier used as suffix in the tool name. */
+    name: string;
+    /** Human-readable description shown to AI agents. */
+    description: string;
+    /** Internal command identifier used by the component's execution router. */
+    commandType: string;
+    /** Whether this tool should be registered (typically derived from component props). */
+    enabled: boolean;
+}
+/** Configuration object for the `webMcp` prop on individual components. */
+export interface WebMcpProps {
+    /** Human-readable data name exposed to AI agents. Overrides the provider's `dataName`. */
+    dataName?: string;
+    /** Called after every tool invocation. */
+    onToolExecute?: (toolName: string, args: Record<string, unknown>) => void;
+}
+/** Shared Web MCP configuration propagated via React Context. */
+export interface WebMcpContextValue {
+    /** Human-readable data name exposed to AI agents. Any language works. Optional when each component provides its own via `webMcp={{ dataName }}`. */
+    dataName?: string;
+    /** Called after every tool invocation. */
+    onToolExecute?: (toolName: string, args: Record<string, unknown>) => void;
+    /**
+     * Registration callback provided by a smart provider.
+     * Components call this to announce themselves so the provider can
+     * create tools on their behalf. Returns an unregister function.
+     *
+     * @param componentType - Identifier string, e.g. 'textbox', 'grid'.
+     * @param handle        - The imperative handle exposed via forwardRef.
+     * @param props         - The current React props of the component.
+     * @param webMcpConfig  - Component-level webMcp config (when object), or undefined (when boolean).
+     * @returns A cleanup function that removes the registration.
+     */
+    register?: (componentType: string, handle: unknown, propsRef: {
+        current: unknown;
+    }, webMcpConfig?: Record<string, unknown>) => () => void;
+}
+/** Props accepted by `<WebMcpProvider>`. */
+export interface WebMcpProviderProps extends WebMcpContextValue {
+    children: React.ReactNode;
+}
+/** @internal */
+export declare const WebMcpContext: React.Context<WebMcpContextValue | null>;
+/** Provides Web MCP configuration to all descendant KendoReact components. */
+export declare const WebMcpProvider: React.FC<WebMcpProviderProps>;
+/** Returns the `navigator.modelContext` if available (Chrome 146+), or `null`. */
+export declare function getModelContext(): WebMcpModelContext | null;
+/**
+ * Tiny hook that components call to register themselves with a parent
+ * `WebMcpProvider`. Only runs when `webMcp` is truthy — zero cost otherwise.
+ *
+ * The component package only needs this single call — all tool creation
+ * logic lives in the provider's adapter (in `@progress/kendo-react-webmcp`).
+ *
+ * @param componentType - Identifier string, e.g. 'textbox', 'grid'.
+ * @param handle        - Ref to the component's imperative handle.
+ * @param props         - The current React props.
+ * @param webMcp        - The component's `webMcp` prop. `true` for defaults, object for config.
+ */
+export declare function useWebMcpRegister(componentType: string, handle: React.RefObject<unknown>, props: unknown, webMcp?: boolean | WebMcpProps): void;

package/WebMcpProvider.js

@@ -0,0 +1,9 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use client";
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("react");function l(t){const r=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(t){for(const n in t)if(n!=="default"){const e=Object.getOwnPropertyDescriptor(t,n);Object.defineProperty(r,n,e.get?e:{enumerable:!0,get:()=>t[n]})}}return r.default=t,Object.freeze(r)}const o=l(a),i=o.createContext(null);i.displayName="WebMcpContext";const g=({children:t,dataName:r,onToolExecute:n})=>{const e=o.useMemo(()=>({dataName:r,onToolExecute:n}),[r,n]);return o.createElement(i.Provider,{value:e},t)};function d(){return typeof navigator!="undefined"&&navigator.modelContext?navigator.modelContext:null}function b(t,r,n,e){const c=o.useContext(i),u=o.useRef(n);u.current=n;const s=o.useMemo(()=>typeof e=="object"?JSON.stringify(e):String(!!e),[e]);o.useEffect(()=>{if(!e||!(c!=null&&c.register))return;const f=typeof e=="object"?e:void 0;return c.register(t,r.current,u,f)},[s,c,t,r])}exports.WebMcpContext=i;exports.WebMcpProvider=g;exports.getModelContext=d;exports.useWebMcpRegister=b;

package/WebMcpProvider.mjs

@@ -0,0 +1,41 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use client";
+import * as t from "react";
+const s = t.createContext(null);
+s.displayName = "WebMcpContext";
+const g = ({ children: i, dataName: n, onToolExecute: r }) => {
+  const e = t.useMemo(() => ({ dataName: n, onToolExecute: r }), [n, r]);
+  return /* @__PURE__ */ t.createElement(s.Provider, { value: e }, i);
+};
+function a() {
+  return typeof navigator != "undefined" && navigator.modelContext ? navigator.modelContext : null;
+}
+function l(i, n, r, e) {
+  const o = t.useContext(s), u = t.useRef(r);
+  u.current = r;
+  const f = t.useMemo(
+    () => typeof e == "object" ? JSON.stringify(e) : String(!!e),
+    // webMcp is intentionally listed as the only dep — we want a stable key
+    // based on the serialised value, not the object reference.
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [e]
+  );
+  t.useEffect(() => {
+    if (!e || !(o != null && o.register))
+      return;
+    const c = typeof e == "object" ? e : void 0;
+    return o.register(i, n.current, u, c);
+  }, [f, o, i, n]);
+}
+export {
+  s as WebMcpContext,
+  g as WebMcpProvider,
+  a as getModelContext,
+  l as useWebMcpRegister
+};