@mercury-fw/channel-http 0.13.2 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @mercury-fw/channel-http
 
+## 0.14.0
+
+### Minor Changes
+
+- 7a76257: - `GET /version` also answers the app's own version when its config declares one: `{ ok: true, version, app: { version } }`. Still no token; without one the body is the same as before.
+  - Needs the framework at 0.65 or later (peer range raised).
+
 ## 0.13.2
 
 ### Patch Changes

package/README.md

@@ -4,7 +4,7 @@ Gives a [Mercury](https://github.com/lucabro81/mercury-fw) agent an HTTP surface
 
 On Mercury's documentation site: [its page](https://lucabro81.github.io/mercury-fw/plugins/channel-http/).
 
-This version is written for version 6 of the channel contract, the one that brings the channels' texts in the person's language, and needs the framework at 0.61 or later, the first whose core says when a resumed turn's answer is no longer available (`resume` below); since 0.59 the core gives channels its version (`GET /version`). A core with an older contract skips it, and the log says why.
+This version is written for version 6 of the channel contract, the one that brings the channels' texts in the person's language, and needs the framework at 0.65 or later, the first whose core gives channels the app's version (`GET /version`); since 0.61 the core says when a resumed turn's answer is no longer available (`resume` below). A core with an older contract skips it, and the log says why.
 
 ```bash
 bun add @mercury-fw/channel-http
@@ -117,11 +117,11 @@ All `GET`, all JSON, all reporting state already held in-process. They need an a
 | `GET /wiki/list` | `{ files: [...] }` — `curated/...` and `personal/...` paths |
 | `GET /wiki/read?path=<path>` | `{ content }` — a path as `/wiki/list` gives it; `400` if `path` is missing, `404` if it isn't among yours |
 | `GET /wiki/grep?pattern=<regex>` | `{ matches: [...] }` — `400` if `pattern` is missing |
-| `GET /memory/scroll?collection=<name>&limit=<n>&offset=<cursor>` | one page of your points in a collection kept per person (verbatim archive, episodic memory, semantic facts); `400` for any other collection |
+| `GET /memory/scroll?collection=<name>&limit=<n>&offset=<cursor>` | one page of your points in a collection kept per person (verbatim archive, episodic memory, semantic facts), each with its whole payload (a verbatim answer's `displays` and `calls` included); `400` for any other collection |
 | `GET /openapi.yaml` | the OpenAPI document for this surface (`text/yaml`) |
 
 Conversation history and the conversation list are backed by the durable verbatim archive; they degrade to empty when the vector store is unreachable.
 
 ## `GET /version`
 
-Which Mercury this is, for a UI to show: `{ ok: true, version }`, the framework's version as `major.minor.patch` (`"0.59.0"`), the one of `@mercury-fw/core`, not this channel's own. It needs no token.
+Which Mercury this is, for a UI to show: `{ ok: true, version }`, the framework's version as `major.minor.patch` (`"0.59.0"`), the one of `@mercury-fw/core`, not this channel's own. When the app's config declares its own version (`version` in `mercury.config.ts`, its `package.json`'s, as a scaffolded app does), it comes too, as it is: `{ ok: true, version: "0.65.0", app: { version: "1.2.0" } }`. The app moves that number itself, and a new one shows once the app is rebuilt. It needs no token, so anyone who reaches the port sees both.

package/dist/http-provider.d.ts

@@ -44,6 +44,8 @@ export type HttpProviderDeps = {
     i18n?: ChannelI18n;
     /** The framework's version, served on `/version` (`ctx.frameworkVersion`). */
     version?: string;
+    /** The app's own version, served on `/version` next to it (`ctx.appVersion`). */
+    appVersion?: string;
 };
 export declare function createHttpProvider(deps: HttpProviderDeps): Provider & {
     stop(): Promise<void>;

package/dist/http-server.d.ts

@@ -159,6 +159,8 @@ export type HttpServerDeps = TurnRequestDeps & {
     assistantName?: string;
     /** The framework's version; `/version` is mounted only with it. */
     version?: string;
+    /** The app's own version, served on `/version` next to the framework's. */
+    appVersion?: string;
 };
 /** Starts the HTTP surface: `POST /turn` (4a) plus the read-only routes (4b)
  * when `reads` is supplied. */

package/http-provider.ts

@@ -41,6 +41,8 @@ export type HttpProviderDeps = {
   i18n?: ChannelI18n;
   /** The framework's version, served on `/version` (`ctx.frameworkVersion`). */
   version?: string;
+  /** The app's own version, served on `/version` next to it (`ctx.appVersion`). */
+  appVersion?: string;
 };
 
 export function createHttpProvider(deps: HttpProviderDeps): Provider & { stop(): Promise<void> } {
@@ -63,6 +65,7 @@ export function createHttpProvider(deps: HttpProviderDeps): Provider & { stop():
         ...(deps.assistantName === undefined ? {} : { assistantName: deps.assistantName }),
         ...(deps.i18n === undefined ? {} : { i18n: deps.i18n }),
         ...(deps.version === undefined ? {} : { version: deps.version }),
+        ...(deps.appVersion === undefined ? {} : { appVersion: deps.appVersion }),
       });
       deps.logins?.accept(deps.logins.callbackUrl);
     },

package/http-server.ts

@@ -580,13 +580,15 @@ export function readRoutes(
 }
 
 /**
- * `GET /version`: which Mercury this is (the framework's version), for any
- * front end to show. Nobody is asked who they are, like `/openapi.yaml`.
+ * `GET /version`: which Mercury this is (the framework's version, and the
+ * app's own when it declares one), for any front end to show. Nobody is asked
+ * who they are, like `/openapi.yaml`.
  */
-function versionRoutes(version: string, corsOrigin = "*"): Record<string, ReadRoute> {
+function versionRoutes(version: string, appVersion: string | undefined, corsOrigin = "*"): Record<string, ReadRoute> {
+  const body = appVersion === undefined ? { ok: true, version } : { ok: true, version, app: { version: appVersion } };
   return {
     "/version": {
-      GET: () => Response.json({ ok: true, version }, { headers: corsHeaders(corsOrigin) }),
+      GET: () => Response.json(body, { headers: corsHeaders(corsOrigin) }),
       OPTIONS: () => preflight(corsOrigin),
     },
   };
@@ -607,6 +609,8 @@ export type HttpServerDeps = TurnRequestDeps & {
   assistantName?: string;
   /** The framework's version; `/version` is mounted only with it. */
   version?: string;
+  /** The app's own version, served on `/version` next to the framework's. */
+  appVersion?: string;
 };
 
 /** Starts the HTTP surface: `POST /turn` (4a) plus the read-only routes (4b)
@@ -638,7 +642,7 @@ export function startHttpServer(deps: HttpServerDeps): ReturnType<typeof Bun.ser
         OPTIONS: () => preflight(origin),
       },
       "/openapi.yaml": { GET: () => openApiResponse(origin), OPTIONS: () => preflight(origin) },
-      ...(deps.version === undefined ? {} : versionRoutes(deps.version, origin)),
+      ...(deps.version === undefined ? {} : versionRoutes(deps.version, deps.appVersion, origin)),
       ...(deps.reads ? readRoutes(deps.reads, deps.authenticate, origin, deps.admit, deps.settings) : {}),
       ...(deps.completeLogin ? loginRoutes(deps.completeLogin, deps.assistantName, deps.i18n) : {}),
       ...(deps.linking ? linkRoutes({ ...deps, start: deps.linking.start, corsOrigin: origin }) : {}),

package/index.ts

@@ -52,6 +52,7 @@ export const httpChannel: ChannelPlugin = {
       ...(resumeMaxChars === undefined ? {} : { resumeMaxChars }),
       ...(ctx.assistantName === undefined ? {} : { assistantName: ctx.assistantName }),
       ...(ctx.frameworkVersion === undefined ? {} : { version: ctx.frameworkVersion }),
+      ...(ctx.appVersion === undefined ? {} : { appVersion: ctx.appVersion }),
       ...(logins ? { logins: { callbackUrl: `${publicUrl}/login/callback`, accept: logins.accept, complete: logins.complete } } : {}),
     });
   },

package/openapi.yaml

@@ -595,12 +595,13 @@ paths:
     get:
       summary: Which Mercury this is
       description: >
-        The framework's version, `major.minor.patch`, for a UI to show. Needs
-        no bearer token.
+        The framework's version, `major.minor.patch`, for a UI to show, and
+        the app's own when its config declares one (`app.version`, its
+        `package.json`'s, shown as the app has it). Needs no bearer token.
       security: []
       responses:
         "200":
-          description: The framework's version.
+          description: The framework's version, and the app's when it declares one.
           content:
             application/json:
               schema:
@@ -612,6 +613,15 @@ paths:
                     type: string
                     pattern: '^\d+\.\d+\.\d+$'
                     examples: ["0.59.0"]
+                  app:
+                    type: object
+                    description: The app's own version; absent when the app declares none.
+                    required: [version]
+                    properties:
+                      version:
+                        type: string
+                        description: As the app's `package.json` has it, not checked.
+                        examples: ["1.2.0"]
   /openapi.yaml:
     get:
       summary: This OpenAPI document

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mercury-fw/channel-http",
-  "version": "0.13.2",
+  "version": "0.14.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -18,11 +18,11 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@mercury-fw/channel-types": ">=0.61.0 <1.0.0"
+    "@mercury-fw/channel-types": ">=0.65.0 <1.0.0"
   },
   "devDependencies": {
-    "@mercury-fw/channel-types": "0.61.0",
-    "@mercury-fw/plugin-types": "0.61.0",
+    "@mercury-fw/channel-types": "0.65.0",
+    "@mercury-fw/plugin-types": "0.65.0",
     "@mercury-fw/typescript-config": "*",
     "@types/bun": "^1.4.2",
     "typescript": "^6.0.3"