@mcp-web/types 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Fritz Lekschas
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/apps.d.ts

@@ -0,0 +1,125 @@
+import type { ComponentType } from 'react';
+import { z } from 'zod';
+/**
+ * MIME type for MCP App resources, per the ext-apps specification (SEP-1865).
+ * @see https://github.com/modelcontextprotocol/ext-apps
+ */
+export declare const RESOURCE_MIME_TYPE = "text/html;profile=mcp-app";
+/**
+ * Handler function for an MCP App tool.
+ * Returns props that will be passed to the app component.
+ */
+export type AppToolHandler = (input?: any) => any | Promise<any>;
+/**
+ * Zod schema for app definition validation.
+ */
+export declare const AppDefinitionSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodString;
+    component: z.ZodCustom<ComponentType<any>, ComponentType<any>>;
+    inputSchema: z.ZodOptional<z.ZodCustom<z.ZodObject<Readonly<{
+        [k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+    }>, z.core.$strip> | Record<string, unknown>, z.ZodObject<Readonly<{
+        [k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+    }>, z.core.$strip> | Record<string, unknown>>>;
+    propsSchema: z.ZodOptional<z.ZodCustom<Record<string, unknown> | z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, Record<string, unknown> | z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+    handler: z.ZodCustom<AppToolHandler, AppToolHandler>;
+    url: z.ZodOptional<z.ZodString>;
+    resourceUri: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * App definition for registering MCP Apps with MCPWeb.
+ *
+ * An MCP App is a combination of:
+ * 1. A tool that AI can call (returns props)
+ * 2. A resource that provides the UI (HTML)
+ *
+ * When AI calls the tool, the handler returns props which are included
+ * in the tool response with `_meta.ui.resourceUri`. The host then fetches
+ * the resource HTML and renders it in an iframe, communicating via the
+ * ext-apps JSON-RPC protocol (`@modelcontextprotocol/ext-apps`).
+ *
+ * @example Basic App
+ * ```typescript
+ * mcp.addApp({
+ *   name: 'show_statistics',
+ *   description: 'Display statistics visualization',
+ *   handler: () => ({
+ *     completionRate: 0.75,
+ *     totalTasks: 100,
+ *     completedTasks: 75,
+ *   }),
+ *   url: '/mcp-web-apps/statistics.html',
+ * });
+ * ```
+ *
+ * @example With Input Schema
+ * ```typescript
+ * mcp.addApp({
+ *   name: 'show_chart',
+ *   description: 'Display a chart with the given data',
+ *   inputSchema: z.object({
+ *     chartType: z.enum(['bar', 'line', 'pie']).describe('Type of chart'),
+ *     title: z.string().describe('Chart title'),
+ *   }),
+ *   handler: ({ chartType, title }) => ({
+ *     chartType,
+ *     title,
+ *     data: getChartData(),
+ *   }),
+ * });
+ * ```
+ */
+export interface AppDefinition {
+    /** Unique name for the app (also used as tool name) */
+    name: string;
+    /** Description of what the app does (shown to AI) */
+    description: string;
+    /** React component to render in the app */
+    component: ComponentType<any>;
+    /** Input schema for the tool (Zod or JSON Schema) */
+    inputSchema?: z.ZodObject | Record<string, unknown>;
+    /** Props schema for validating handler output */
+    propsSchema?: z.ZodType | Record<string, unknown>;
+    /** Handler function that returns props for the app */
+    handler: AppToolHandler;
+    /** URL to fetch the app HTML from (defaults to /mcp-web-apps/{name}.html) */
+    url?: string;
+    /** Resource URI for the app (defaults to ui://{name}/app.html) */
+    resourceUri?: string;
+}
+/**
+ * Internal processed app definition with resolved defaults.
+ * @internal
+ */
+export interface ProcessedAppDefinition extends AppDefinition {
+    /** Resolved URL (with default applied) */
+    resolvedUrl: string;
+    /** Resolved resource URI (with default applied) */
+    resolvedResourceUri: string;
+}
+/**
+ * Get default URL for an app.
+ */
+export declare function getDefaultAppUrl(name: string): string;
+/**
+ * Get default resource URI for an app.
+ */
+export declare function getDefaultAppResourceUri(name: string): string;
+/**
+ * A created app that can be registered with MCPWeb.
+ *
+ * Created apps are validated at creation time but not yet registered.
+ * Use `mcpWeb.addApp(createdApp)` to register.
+ */
+export interface CreatedApp {
+    /** Marker to identify this as a created app */
+    readonly __brand: 'CreatedApp';
+    /** The app definition for registration */
+    readonly definition: AppDefinition;
+}
+/**
+ * Type guard to check if a value is a CreatedApp.
+ */
+export declare function isCreatedApp(value: unknown): value is CreatedApp;
+//# sourceMappingURL=apps.d.ts.map

package/dist/apps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apps.d.ts","sourceRoot":"","sources":["../src/apps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,kBAAkB,8BAA8B,CAAC;AAE9D;;;GAGG;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;AAEjE;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;iBA8B9B,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,WAAW,aAAa;IAC5B,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAE3C,SAAS,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IAC9B,qDAAqD;IACrD,WAAW,CAAC,EAAE,CAAC,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,iDAAiD;IACjD,WAAW,CAAC,EAAE,CAAC,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClD,sDAAsD;IACtD,OAAO,EAAE,cAAc,CAAC;IACxB,6EAA6E;IAC7E,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,aAAa;IAC3D,0CAA0C;IAC1C,WAAW,EAAE,MAAM,CAAC;IACpB,mDAAmD;IACnD,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAErD;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC;IAC/B,0CAA0C;IAC1C,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;CACpC;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,UAAU,CAOhE"}

package/dist/apps.js

@@ -0,0 +1,50 @@
+import { z } from 'zod';
+/**
+ * MIME type for MCP App resources, per the ext-apps specification (SEP-1865).
+ * @see https://github.com/modelcontextprotocol/ext-apps
+ */
+export const RESOURCE_MIME_TYPE = 'text/html;profile=mcp-app';
+/**
+ * Zod schema for app definition validation.
+ */
+export const AppDefinitionSchema = z.object({
+    /** Unique name for the app (also used as tool name) */
+    name: z.string().min(1, 'App name is required'),
+    /** Description of what the app does (shown to AI) */
+    description: z.string().min(1, 'App description is required'),
+    /** React component to render in the app */
+    // biome-ignore lint/suspicious/noExplicitAny: Component can have any props type
+    component: z.custom((val) => typeof val === 'function', { message: 'Component must be a React component' }),
+    /** Input schema for the tool (Zod or JSON Schema) */
+    inputSchema: z.custom((val) => val === undefined || (val && typeof val === 'object'), { message: 'Must be a Zod schema or JSON Schema object' }).optional(),
+    /** Props schema for validating handler output */
+    propsSchema: z.custom((val) => val === undefined || (val && typeof val === 'object'), { message: 'Must be a Zod schema or JSON Schema object' }).optional(),
+    /** Handler function that returns props for the app */
+    handler: z.custom((val) => typeof val === 'function', { message: 'Handler must be a function' }),
+    /** URL to fetch the app HTML from (defaults to /mcp-web-apps/{kebab-case-name}.html) */
+    url: z.string().optional(),
+    /** Resource URI for the app (defaults to ui://{name}/app.html) */
+    resourceUri: z.string().optional(),
+});
+/**
+ * Get default URL for an app.
+ */
+export function getDefaultAppUrl(name) {
+    return `/mcp-web-apps/${name}.html`;
+}
+/**
+ * Get default resource URI for an app.
+ */
+export function getDefaultAppResourceUri(name) {
+    return `ui://${name}/app.html`;
+}
+/**
+ * Type guard to check if a value is a CreatedApp.
+ */
+export function isCreatedApp(value) {
+    return (typeof value === 'object' &&
+        value !== null &&
+        '__brand' in value &&
+        value.__brand === 'CreatedApp');
+}
+//# sourceMappingURL=apps.js.map

package/dist/apps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apps.js","sourceRoot":"","sources":["../src/apps.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,2BAA2B,CAAC;AAS9D;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,uDAAuD;IACvD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,sBAAsB,CAAC;IAC/C,qDAAqD;IACrD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,6BAA6B,CAAC;IAC7D,2CAA2C;IAC3C,gFAAgF;IAChF,SAAS,EAAE,CAAC,CAAC,MAAM,CACjB,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,UAAU,EAClC,EAAE,OAAO,EAAE,qCAAqC,EAAE,CACnD;IACD,qDAAqD;IACrD,WAAW,EAAE,CAAC,CAAC,MAAM,CACnB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,SAAS,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC,EAC9D,EAAE,OAAO,EAAE,4CAA4C,EAAE,CAC1D,CAAC,QAAQ,EAAE;IACZ,iDAAiD;IACjD,WAAW,EAAE,CAAC,CAAC,MAAM,CACnB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,SAAS,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC,EAC9D,EAAE,OAAO,EAAE,4CAA4C,EAAE,CAC1D,CAAC,QAAQ,EAAE;IACZ,sDAAsD;IACtD,OAAO,EAAE,CAAC,CAAC,MAAM,CACf,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,UAAU,EAClC,EAAE,OAAO,EAAE,4BAA4B,EAAE,CAC1C;IACD,wFAAwF;IACxF,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,kEAAkE;IAClE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC;AA4EH;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,OAAO,iBAAiB,IAAI,OAAO,CAAC;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAY;IACnD,OAAO,QAAQ,IAAI,WAAW,CAAC;AACjC,CAAC;AAeD;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,SAAS,IAAI,KAAK;QACjB,KAAoB,CAAC,OAAO,KAAK,YAAY,CAC/C,CAAC;AACJ,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+/**
+ * Zod schema for MCPWeb configuration.
+ *
+ * Validates and transforms configuration options for MCPWeb instances.
+ * All URL fields are stripped of protocols as the protocol is determined
+ * automatically based on the page context (http/https).
+ */
+export declare const McpWebConfigSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodString;
+    bridgeUrl: z.ZodPipe<z.ZodDefault<z.ZodOptional<z.ZodString>>, z.ZodTransform<string, string>>;
+    icon: z.ZodOptional<z.ZodString>;
+    agentUrl: z.ZodPipe<z.ZodOptional<z.ZodString>, z.ZodTransform<string | undefined, string | undefined>>;
+    authToken: z.ZodOptional<z.ZodString>;
+    persistAuthToken: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    autoConnect: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    maxSessionsPerToken: z.ZodOptional<z.ZodNumber>;
+    onSessionLimitExceeded: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        reject: "reject";
+        close_oldest: "close_oldest";
+    }>>>;
+    maxInFlightQueriesPerToken: z.ZodOptional<z.ZodNumber>;
+    sessionMaxDurationMs: z.ZodOptional<z.ZodNumber>;
+    sessionName: z.ZodOptional<z.ZodString>;
+    debug: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>;
+/**
+ * Input type for MCPWeb configuration.
+ *
+ * Use this type when creating new MCPWeb instances. All fields except
+ * `name` and `description` have sensible defaults.
+ *
+ * @example
+ * ```typescript
+ * const config: MCPWebConfig = {
+ *   name: 'My App',
+ *   description: 'An AI-controllable web application',
+ *   bridgeUrl: 'localhost:3001',
+ * };
+ * ```
+ */
+export type MCPWebConfig = z.input<typeof McpWebConfigSchema>;
+/**
+ * Output type for parsed MCPWeb configuration.
+ *
+ * This type represents the configuration after validation and transformation,
+ * with all defaults applied. Used internally by MCPWeb instances.
+ */
+export type MCPWebConfigOutput = z.infer<typeof McpWebConfigSchema>;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;iBAsC7B,CAAC;AAEH;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC"}

package/dist/config.js

@@ -0,0 +1,48 @@
+import { z } from 'zod';
+/**
+ * Zod schema for MCPWeb configuration.
+ *
+ * Validates and transforms configuration options for MCPWeb instances.
+ * All URL fields are stripped of protocols as the protocol is determined
+ * automatically based on the page context (http/https).
+ */
+export const McpWebConfigSchema = z.object({
+    /** The name of the server. This is used to identify the server and is displayed in your AI App (e.g., Claude Desktop) */
+    name: z.string().min(1).describe('The name of the server. This is used to identify the server and is displayed in your AI App (e.g., Claude Desktop)'),
+    /** The description of the server. This should describe the web app you want the AI App to control. */
+    description: z.string().min(1).describe('The description of the server. This should describe the web app you want the AI App to control.'),
+    /** The bridge server address as host:port (e.g., 'localhost:3001' or 'bridge.example.com'). Protocol is determined automatically based on page context. */
+    bridgeUrl: z
+        .string()
+        .optional()
+        .default('localhost:3001')
+        .transform((url) => url.replace(/^(wss?|https?):\/\//, ''))
+        .describe('The bridge server address as host:port (e.g., \'localhost:3001\' or \'bridge.example.com\'). Protocol is determined automatically.'),
+    /** Either a URL or a data URI like "data:image/png;base64,...". This is shown in the AI App. */
+    icon: z.string().optional().describe('Either a URL or a data URI like "data:image/png;base64,...". This is shown in the AI App.'),
+    /** The agent server address with optional path (e.g., 'localhost:3000' or 'localhost:3000/api/v1/query'). Protocol is determined automatically. Required for query support. */
+    agentUrl: z
+        .string()
+        .optional()
+        .transform((url) => url?.replace(/^(wss?|https?):\/\//, ''))
+        .describe('The agent server address with optional path (e.g., \'localhost:3000\' or \'localhost:3000/api/v1/query\'). Protocol is determined automatically.'),
+    /** Authentication token for the agent. If not provided, will use auto-generated token. */
+    authToken: z.string().optional().describe('Authentication token for the agent. If not provided, will use auto-generated token.'),
+    /** Whether to persist the auth token in localStorage. */
+    persistAuthToken: z.boolean().optional().default(true).describe('Whether to persist the auth token in localStorage.'),
+    /** Whether to automatically connect to the MCP bridge on initialization. */
+    autoConnect: z.boolean().optional().default(true).describe('Whether to automatically connect to the MCP bridge on initialization.'),
+    /** Maximum sessions allowed per auth token. When exceeded, behavior is determined by `onSessionLimitExceeded`. */
+    maxSessionsPerToken: z.number().int().positive().optional().describe('Maximum sessions allowed per auth token.'),
+    /** Behavior when session limit is exceeded. "reject" rejects new connections, "close_oldest" closes the oldest session. */
+    onSessionLimitExceeded: z.enum(['reject', 'close_oldest']).optional().default('reject').describe('Behavior when session limit is exceeded.'),
+    /** Maximum concurrent in-flight queries across all sessions for a token. Prevents resource exhaustion. */
+    maxInFlightQueriesPerToken: z.number().int().positive().optional().describe('Maximum concurrent in-flight queries per token.'),
+    /** Maximum session duration in milliseconds. Sessions older than this are automatically closed. */
+    sessionMaxDurationMs: z.number().int().positive().optional().describe('Maximum session duration in milliseconds.'),
+    /** Optional human-readable name for the session. Must be unique per auth token. Used to identify specific sessions when multiple are connected. */
+    sessionName: z.string().min(1).optional().describe('Optional human-readable name for the session. Must be unique per auth token. Used to identify specific sessions when multiple are connected.'),
+    /** Enable debug logging for MCP requests and responses. */
+    debug: z.boolean().optional().default(false).describe('Enable debug logging for MCP requests and responses.'),
+});
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,yHAAyH;IACzH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,oHAAoH,CAAC;IACtJ,sGAAsG;IACtG,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,iGAAiG,CAAC;IAC1I,2JAA2J;IAC3J,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,OAAO,CAAC,gBAAgB,CAAC;SACzB,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;SAC1D,QAAQ,CAAC,oIAAoI,CAAC;IACjJ,gGAAgG;IAChG,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2FAA2F,CAAC;IACjI,+KAA+K;IAC/K,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;SAC3D,QAAQ,CAAC,kJAAkJ,CAAC;IAC/J,0FAA0F;IAC1F,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qFAAqF,CAAC;IAChI,yDAAyD;IACzD,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,oDAAoD,CAAC;IACrH,4EAA4E;IAC5E,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,uEAAuE,CAAC;IACnI,kHAAkH;IAClH,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,0CAA0C,CAAC;IAChH,2HAA2H;IAC3H,sBAAsB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,0CAA0C,CAAC;IAC5I,0GAA0G;IAC1G,0BAA0B,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iDAAiD,CAAC;IAC9H,mGAAmG;IACnG,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2CAA2C,CAAC;IAClH,mJAAmJ;IACnJ,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,8IAA8I,CAAC;IAClM,2DAA2D;IAC3D,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,sDAAsD,CAAC;CAC9G,CAAC,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,54 @@
+export declare const MissingAuthenticationErrorCode = "MissingAuthentication";
+export declare const InvalidAuthenticationErrorCode = "InvalidAuthentication";
+export declare const InvalidSessionErrorCode = "InvalidSession";
+export declare const NoSessionsFoundErrorCode = "NoSessionsFound";
+export declare const SessionNotFoundErrorCode = "SessionNotFound";
+export declare const QueryNotFoundErrorCode = "QueryNotFound";
+export declare const QueryNotActiveErrorCode = "QueryNotActive";
+export declare const QueryDoneErrorCode = "QueryCompleted";
+export declare const UnknownMethodErrorCode = "UnknownMethod";
+export declare const InternalErrorCode = "InternalError";
+export declare const ClientNotConextualizedErrorCode = "ClientNotConextualized";
+export declare const ToolNotFoundErrorCode = "ToolNotFound";
+export declare const SessionNotSpecifiedErrorCode = "SessionNotSpecified";
+export declare const ToolNameRequiredErrorCode = "ToolNameRequired";
+export declare const ToolNotAllowedErrorCode = "ToolNotAllowed";
+export declare const SessionLimitExceededErrorCode = "SessionLimitExceeded";
+export declare const QueryLimitExceededErrorCode = "QueryLimitExceeded";
+export declare const SessionExpiredErrorCode = "SessionExpired";
+export declare const SessionNameAlreadyInUseErrorCode = "SessionNameAlreadyInUse";
+export declare const ToolSchemaConflictErrorCode = "ToolSchemaConflict";
+/**
+ * Error details passed to the `onRegistrationError` callback when the bridge
+ * rejects a tool registration (e.g., due to a schema conflict with a sibling session).
+ */
+export interface ToolRegistrationError {
+    /** The name of the tool that was rejected. */
+    toolName: string;
+    /** Error code identifying the type of registration failure. */
+    code: string;
+    /** Human-readable description of why the registration was rejected. */
+    message: string;
+}
+/**
+ * Session information returned in errors
+ */
+export interface SessionInfo {
+    session_id: string;
+    session_name: string | undefined;
+    origin: string;
+    page_title: string;
+    connected_at: string;
+    last_activity: string;
+    available_tools: string[];
+}
+/**
+ * Error thrown when a session must be specified but wasn't provided.
+ * Contains structured information about available sessions.
+ */
+export declare class SessionNotSpecifiedError extends Error {
+    readonly availableSessions: SessionInfo[];
+    readonly code = "SessionNotSpecified";
+    constructor(message: string, availableSessions: SessionInfo[]);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,8BAA8B,0BAA0B,CAAC;AACtE,eAAO,MAAM,8BAA8B,0BAA0B,CAAC;AACtE,eAAO,MAAM,uBAAuB,mBAAmB,CAAC;AACxD,eAAO,MAAM,wBAAwB,oBAAoB,CAAC;AAC1D,eAAO,MAAM,wBAAwB,oBAAoB,CAAC;AAC1D,eAAO,MAAM,sBAAsB,kBAAkB,CAAC;AACtD,eAAO,MAAM,uBAAuB,mBAAmB,CAAC;AACxD,eAAO,MAAM,kBAAkB,mBAAmB,CAAC;AACnD,eAAO,MAAM,sBAAsB,kBAAkB,CAAC;AACtD,eAAO,MAAM,iBAAiB,kBAAkB,CAAC;AACjD,eAAO,MAAM,+BAA+B,2BAA2B,CAAC;AACxE,eAAO,MAAM,qBAAqB,iBAAiB,CAAC;AACpD,eAAO,MAAM,4BAA4B,wBAAwB,CAAC;AAClE,eAAO,MAAM,yBAAyB,qBAAqB,CAAC;AAC5D,eAAO,MAAM,uBAAuB,mBAAmB,CAAC;AACxD,eAAO,MAAM,6BAA6B,yBAAyB,CAAC;AACpE,eAAO,MAAM,2BAA2B,uBAAuB,CAAC;AAChE,eAAO,MAAM,uBAAuB,mBAAmB,CAAC;AAExD,eAAO,MAAM,gCAAgC,4BAA4B,CAAC;AAC1E,eAAO,MAAM,2BAA2B,uBAAuB,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAC;IACjB,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,uEAAuE;IACvE,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,KAAK;aAK/B,iBAAiB,EAAE,WAAW,EAAE;IAJlD,SAAgB,IAAI,yBAAgC;gBAGlD,OAAO,EAAE,MAAM,EACC,iBAAiB,EAAE,WAAW,EAAE;CAQnD"}

package/dist/errors.js

@@ -0,0 +1,35 @@
+export const MissingAuthenticationErrorCode = 'MissingAuthentication';
+export const InvalidAuthenticationErrorCode = 'InvalidAuthentication';
+export const InvalidSessionErrorCode = 'InvalidSession';
+export const NoSessionsFoundErrorCode = 'NoSessionsFound';
+export const SessionNotFoundErrorCode = 'SessionNotFound';
+export const QueryNotFoundErrorCode = 'QueryNotFound';
+export const QueryNotActiveErrorCode = 'QueryNotActive';
+export const QueryDoneErrorCode = 'QueryCompleted';
+export const UnknownMethodErrorCode = 'UnknownMethod';
+export const InternalErrorCode = 'InternalError';
+export const ClientNotConextualizedErrorCode = 'ClientNotConextualized';
+export const ToolNotFoundErrorCode = 'ToolNotFound';
+export const SessionNotSpecifiedErrorCode = 'SessionNotSpecified';
+export const ToolNameRequiredErrorCode = 'ToolNameRequired';
+export const ToolNotAllowedErrorCode = 'ToolNotAllowed';
+export const SessionLimitExceededErrorCode = 'SessionLimitExceeded';
+export const QueryLimitExceededErrorCode = 'QueryLimitExceeded';
+export const SessionExpiredErrorCode = 'SessionExpired';
+export const SessionNameAlreadyInUseErrorCode = 'SessionNameAlreadyInUse';
+export const ToolSchemaConflictErrorCode = 'ToolSchemaConflict';
+/**
+ * Error thrown when a session must be specified but wasn't provided.
+ * Contains structured information about available sessions.
+ */
+export class SessionNotSpecifiedError extends Error {
+    constructor(message, availableSessions) {
+        super(message);
+        this.availableSessions = availableSessions;
+        this.code = SessionNotSpecifiedErrorCode;
+        this.name = 'SessionNotSpecifiedError';
+        // Ensure proper prototype chain for instanceof checks
+        Object.setPrototypeOf(this, SessionNotSpecifiedError.prototype);
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,8BAA8B,GAAG,uBAAuB,CAAC;AACtE,MAAM,CAAC,MAAM,8BAA8B,GAAG,uBAAuB,CAAC;AACtE,MAAM,CAAC,MAAM,uBAAuB,GAAG,gBAAgB,CAAC;AACxD,MAAM,CAAC,MAAM,wBAAwB,GAAG,iBAAiB,CAAC;AAC1D,MAAM,CAAC,MAAM,wBAAwB,GAAG,iBAAiB,CAAC;AAC1D,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CAAC;AACtD,MAAM,CAAC,MAAM,uBAAuB,GAAG,gBAAgB,CAAC;AACxD,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AACnD,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CAAC;AACtD,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC;AACjD,MAAM,CAAC,MAAM,+BAA+B,GAAG,wBAAwB,CAAC;AACxE,MAAM,CAAC,MAAM,qBAAqB,GAAG,cAAc,CAAC;AACpD,MAAM,CAAC,MAAM,4BAA4B,GAAG,qBAAqB,CAAC;AAClE,MAAM,CAAC,MAAM,yBAAyB,GAAG,kBAAkB,CAAC;AAC5D,MAAM,CAAC,MAAM,uBAAuB,GAAG,gBAAgB,CAAC;AACxD,MAAM,CAAC,MAAM,6BAA6B,GAAG,sBAAsB,CAAC;AACpE,MAAM,CAAC,MAAM,2BAA2B,GAAG,oBAAoB,CAAC;AAChE,MAAM,CAAC,MAAM,uBAAuB,GAAG,gBAAgB,CAAC;AAExD,MAAM,CAAC,MAAM,gCAAgC,GAAG,yBAAyB,CAAC;AAC1E,MAAM,CAAC,MAAM,2BAA2B,GAAG,oBAAoB,CAAC;AA4BhE;;;GAGG;AACH,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IAGjD,YACE,OAAe,EACC,iBAAgC;QAEhD,KAAK,CAAC,OAAO,CAAC,CAAC;QAFC,sBAAiB,GAAjB,iBAAiB,CAAe;QAJlC,SAAI,GAAG,4BAA4B,CAAC;QAOlD,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;QAEvC,sDAAsD;QACtD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from './apps.js';
+export * from './config.js';
+export * from './errors.js';
+export * from './mcp.js';
+export * from './query.js';
+export * from './resources.js';
+export * from './tools.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+export * from './apps.js';
+export * from './config.js';
+export * from './errors.js';
+export * from './mcp.js';
+export * from './query.js';
+export * from './resources.js';
+export * from './tools.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC"}