@hearthscale/app 0.1.0 → 0.2.1

package/dist/view.d.ts

@@ -0,0 +1,66 @@
+import { McpUiUpdateModelContextRequest, McpUiMessageRequest, McpUiDownloadFileRequest, McpUiDownloadFileResult, App } from '@modelcontextprotocol/ext-apps';
+import { CallOf, ViewMethods, ModelContextOptions, ModelContextAnswer, MessageOptions } from './index.js';
+
+/**
+ * `@hearthscale/app/view`: the one runtime part of the package, for a
+ * view, which bundles it.
+ */
+
+/** An embedded resource whose bytes are a `Blob`, which `ui/download-file`
+ *  streams into the file the person picks, at any size. */
+interface BlobResource {
+    type: 'resource';
+    resource: {
+        uri: string;
+        mimeType?: string;
+        blob: Blob;
+    };
+}
+/** The MCP Apps requests whose params take Hearthscale's own fields, which
+ *  the SDK's `App` methods refuse by type: the slot of
+ *  `ui/update-model-context`, the target of `ui/message`, and a `Blob` as
+ *  the bytes of `ui/download-file`. */
+interface ViewStandardMethods {
+    'ui/update-model-context': {
+        params: McpUiUpdateModelContextRequest['params'] & {
+            _meta?: {
+                'hearthscale/modelContext'?: ModelContextOptions;
+            };
+        };
+        result: {
+            _meta?: {
+                'openai/modelContext'?: ModelContextAnswer;
+            };
+        };
+    };
+    'ui/message': {
+        params: McpUiMessageRequest['params'] & {
+            _meta?: {
+                'openai/message'?: MessageOptions;
+            };
+        };
+        result: {
+            isError?: boolean;
+        };
+    };
+    'ui/download-file': {
+        params: {
+            contents: (McpUiDownloadFileRequest['params']['contents'][number] | BlobResource)[];
+        };
+        result: McpUiDownloadFileResult;
+    };
+}
+/** The typed call of a view's requests through its `App`. */
+type ViewCall = CallOf<ViewMethods & ViewStandardMethods>;
+/**
+ * The typed call of every request beyond MCP Apps through a view's `App`,
+ * and of the MCP Apps requests that take Hearthscale's own fields: the
+ * `hearthscale/*` methods every view may call and the extensions its
+ * app's `uses` opens, `openai/resources/write` and `openai/files/open`,
+ * and `ViewStandardMethods`; the method's params in, its result out. A
+ * refusal rejects with the MCP SDK's `McpError`.
+ */
+declare function hostCall(app: App): ViewCall;
+
+export { hostCall };
+export type { BlobResource, ViewCall, ViewStandardMethods };

package/dist/view.js

@@ -0,0 +1,20 @@
+/**
+ * `@hearthscale/app/view`: the one runtime part of the package, for a
+ * view, which bundles it.
+ */
+import { McpUiMessageResultSchema, } from '@modelcontextprotocol/ext-apps';
+/**
+ * The typed call of every request beyond MCP Apps through a view's `App`,
+ * and of the MCP Apps requests that take Hearthscale's own fields: the
+ * `hearthscale/*` methods every view may call and the extensions its
+ * app's `uses` opens, `openai/resources/write` and `openai/files/open`,
+ * and `ViewStandardMethods`; the method's params in, its result out. A
+ * refusal rejects with the MCP SDK's `McpError`.
+ */
+export function hostCall(app) {
+    // The SDK types the requests of the MCP Apps methods alone, with their
+    // standard params; these are requests of the same protocol with
+    // methods or fields of their own.
+    const request = app.request.bind(app);
+    return ((method, params) => request({ method, params: params ?? {} }, McpUiMessageResultSchema));
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hearthscale/app",
-  "version": "0.1.0",
-  "description": "The types a Hearthscale app's backend and views import: the backend's exports and context, the view's host methods, extensions and slots.",
+  "version": "0.2.1",
+  "description": "The types a Hearthscale app's backend and views import: the backend's exports and context, the view's host methods, extensions and slots; and the typed call of a view's requests.",
   "license": "MIT",
   "type": "module",
   "types": "./dist/index.d.ts",
@@ -9,6 +9,10 @@
     ".": {
       "types": "./dist/index.d.ts"
     },
+    "./view": {
+      "types": "./dist/view.d.ts",
+      "default": "./dist/view.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -22,7 +26,16 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "@modelcontextprotocol/ext-apps": "^1.7.5"
+  },
+  "peerDependenciesMeta": {
+    "@modelcontextprotocol/ext-apps": {
+      "optional": true
+    }
+  },
   "devDependencies": {
+    "@modelcontextprotocol/ext-apps": "1.7.5",
     "rollup": "^4.62.2",
     "rollup-plugin-dts": "^6.5.1",
     "typescript": "^5.6.3",