@omochi-ui/utils 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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/README.md

@@ -1,3 +1,202 @@
-# Temporary Holding Version
+# @omochi-ui/utils
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Publish command controls, development observations, and agent-created A2UI
+surfaces through the existing Omochi gateway. Requires a Unix-like environment,
+like the discovery transport. Build with `bun install && bun run build` from the
+repository root.
+
+## Turn a command into a button
+
+```sh
+bun run omochi-utils button --service-id build --name "Build" -- bun run build
+# In another terminal:
+bun run omochi-ui hub
+```
+
+Open the hub's printed URL, then use **Add view** to add `Build · main` to a
+dashboard. The command runs only when clicked. The surface shows live combined
+stdout/stderr, running status and the exit code. Only one execution can run at
+a time, including when multiple browsers are connected. After completion or a
+startup failure the button can be used again.
+
+```sh
+bun run omochi-utils button --name "Tests" --cwd /path/to/project -- bun run test
+bun run omochi-utils button --name "Pipeline" -- sh -c 'printf hello | wc -c'
+```
+
+Arguments after `--` are passed literally without a shell. Commands inherit the
+environment and current directory unless `--cwd` is supplied; stdin is closed.
+Output keeps the latest 64 KiB, marks truncation, and resets on each run. It is
+displayed as literal code, not interpreted as Markdown. Ctrl+C or SIGTERM stops
+child process groups (TERM, then KILL within one second) and retracts the service.
+
+## Watch a command
+
+```sh
+bun run omochi-utils watch --interval 2s -- git status --short
+bun run omochi-utils watch --diff --on-change --history 10 -- bun run test
+bun run omochi-utils watch --timeout 30s --cwd /path/to/project -- command args
+```
+
+`watch` runs immediately, waits for the command to finish, then waits for the
+interval before running again. Runs never overlap. The surface can pause future
+runs, resume immediately, or run once now. `--timeout` stops a hung process group.
+`--diff` shows the current output and a line diff from the previous run;
+`--on-change` suppresses completed updates whose output and exit result are
+unchanged. `--history N` retains 1–100 short execution records without retaining
+old full output.
+
+## Control a long-running process
+
+```sh
+bun run omochi-utils process --name "Dev server" -- bun run dev
+bun run omochi-utils process --restart on-failure --restart-delay 2s -- worker
+```
+
+Processes start only when **Start** is clicked. The surface provides **Stop** and
+**Restart**, retains the latest 64 KiB of logs across restarts, and records exit
+reasons. `--restart` accepts `never` (the default), `on-failure`, or `always`.
+Manual stops and CLI shutdown never trigger automatic restart.
+
+## Follow a log file or stdin
+
+```sh
+bun run omochi-utils tail --lines 200 ./logs/api.log
+journalctl -f | bun run omochi-utils stream --name "System log"
+```
+
+`tail` waits if the path does not exist and follows the name across truncation
+and log rotation, like `tail -F`. It treats the file as UTF-8 and never writes to
+it. `stream` displays stdin as UTF-8. When stdin reaches EOF, it leaves the final
+surface visible until SIGINT or SIGTERM instead of exiting immediately.
+
+## Monitor HTTP
+
+```sh
+bun run omochi-utils http http://127.0.0.1:3000/health
+bun run omochi-utils http --interval 30s --timeout 5s \
+  --expect-status 200 --expect-body '"ready":true' https://example.test/health
+```
+
+`http` sends non-overlapping GET requests and provides the same pause, resume,
+and run-now controls as `watch`. It shows status, latency, final URL, content
+type, size, consecutive failures, and health transitions. The default expected
+status is 200–299. Text responses are shown up to 64 KiB; JSON media types are
+parsed and pretty-printed. Binary response bodies are not displayed. For custom
+methods, headers, authentication, or request bodies, use `watch -- curl ...`.
+
+## Let an agent publish surfaces over MCP
+
+Configure a stdio MCP server in your agent. For a source checkout, point Node to
+the absolute path of the built CLI:
+
+```json
+{
+  "mcpServers": {
+    "omochi": {
+      "command": "bun",
+      "args": ["/absolute/path/to/omochi-ui/packages/utils/bin/omochi-utils.js", "mcp", "--name", "Agent"]
+    }
+  }
+}
+```
+
+The process publishes through `UnixSocketServerTransport`; an existing gateway
+discovers it automatically. Start `omochi-ui hub` separately to view surfaces.
+The agent, gateway and hub must share the same user and `XDG_RUNTIME_DIR` for
+local discovery. Existing SSH/paired-gateway routing works without changes.
+
+| Tool | Arguments | Result |
+| --- | --- | --- |
+| `publish_messages` | `messages`: nonempty A2UI v0.9 message array | `accepted`, `serviceId`, `surfaceIds` |
+| `list_surfaces` | none | `serviceId`, `surfaceIds` |
+| `read_events` | `after` (default 0), `timeoutMs` (default 0, max 30000) | `events`, `nextCursor`, `dropped`, `closed` |
+
+`publish_messages` accepts standard `createSurface`, `updateComponents`,
+`updateDataModel`, and `deleteSurface` messages. It validates the entire batch
+against the current state before sending anything. Errors report the failing
+array index, leaving the published state intact. Concurrent calls are serialized.
+Use surface-local IDs; gateway/hub prefixes are applied by the existing routers.
+Validation checks wire shape and surface lifecycle; catalog-specific component
+validation is still performed by the renderer.
+
+For example, pass this to `publish_messages` to publish an interactive form:
+
+```json
+{
+  "messages": [
+    {
+      "version": "v0.9",
+      "createSurface": {
+        "surfaceId": "main",
+        "catalogId": "https://a2ui.org/specification/v0_9/catalogs/basic/catalog.json",
+        "sendDataModel": true
+      }
+    },
+    {
+      "version": "v0.9",
+      "updateComponents": {
+        "surfaceId": "main",
+        "components": [
+          { "id": "root", "component": "Column", "children": ["title", "request", "submit"] },
+          { "id": "title", "component": "Text", "text": "What should we build?" },
+          { "id": "request", "component": "TextField", "label": "Request", "value": { "path": "/request" } },
+          { "id": "submit", "component": "Button", "child": "label", "action": { "event": { "name": "submit", "context": { "request": { "path": "/request" } } } } },
+          { "id": "label", "component": "Text", "text": "Send" }
+        ]
+      }
+    },
+    { "version": "v0.9", "updateDataModel": { "surfaceId": "main", "path": "/", "value": { "request": "" } } }
+  ]
+}
+```
+
+Call `read_events` with `{ "after": 0, "timeoutMs": 30000 }`. Each returned event
+contains `sequence`, `receivedAt` (ISO timestamp), and the original A2UI client
+`message`, including `action.context` and any client data model metadata. The
+example's submitted text is in `message.action.context.request`. Respond by
+publishing another message batch:
+
+```json
+{
+  "messages": [{
+    "version": "v0.9",
+    "updateComponents": {
+      "surfaceId": "main",
+      "components": [{ "id": "title", "component": "Text", "text": "Working…" }]
+    }
+  }]
+}
+```
+
+Use the returned `nextCursor` as `after` for the next read. Reads do not consume
+events, so retrying a cursor is safe. The latest 1,000 events are retained;
+`dropped` reports how many events since the requested cursor have expired. A
+timeout returns an empty array. Pending reads support MCP cancellation and are
+woken on shutdown. Button clicks do not automatically wake an idle agent: it
+must call `read_events`. These tools do not execute shell commands or callbacks.
+
+To remove a surface, publish
+`{"version":"v0.9","deleteSurface":{"surfaceId":"main"}}`.
+There is no persistence: stdin EOF, SIGINT or SIGTERM closes the MCP server and
+retracts its service. A gateway connecting later receives current surface state.
+
+## Shared options and lifetime
+
+All subcommands accept `--service-id ID` and `--name NAME`. IDs default to a
+unique `utils-<uuid>`; use an explicit stable ID if saving a dashboard layout.
+Starting a second process with a live ID fails without replacing the first.
+Durations accept `ms`, `s`, and `m` suffixes. Each process has its own surfaces
+and event buffer. Service registration does not start the gateway or
+automatically place panels on a dashboard.
+
+Use `bun run omochi-utils --help` for usage. No new TCP listener, dashboard API,
+or transport protocol is introduced. Runtime directory permissions and existing
+gateway access controls apply to these services as to other Omochi apps.
+
+## Tests
+
+`bun run build` then `bun run --filter @omochi-ui/utils test`
+runs command execution, watch/diff, process restart, tail/stream, HTTP, shutdown,
+event cursor, stdio MCP, and gateway integration tests. Temporary runtime
+directories keep tests separate from real services.

package/bin/omochi-utils.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env bun
+import '../dist/cli.js';

package/dist/button.d.ts

@@ -0,0 +1,20 @@
+import { type UI } from "@omochi-ui/sdk";
+import { Publisher } from "./publisher.js";
+import { UtilitySurface } from "./surface.js";
+export interface ButtonOptions {
+    command: string[];
+    cwd?: string;
+    name: string;
+}
+export declare class CommandButton extends UtilitySurface {
+    private readonly output;
+    private readonly runner;
+    private running;
+    private status;
+    private closePromise?;
+    constructor(publisher: Publisher, options: ButtonOptions);
+    protected build(ui: UI): void;
+    protected onAction(name: string): void;
+    close(): Promise<void>;
+    private run;
+}

package/dist/button.js

@@ -0,0 +1,51 @@
+import { Action } from "@omochi-ui/sdk";
+import { ManagedCommand, describeResult } from "./command.js";
+import { OutputBuffer, fenced } from "./output.js";
+import { UtilitySurface } from "./surface.js";
+export class CommandButton extends UtilitySurface {
+    output = new OutputBuffer();
+    runner;
+    running = false;
+    status = "Ready";
+    closePromise;
+    constructor(publisher, options) {
+        super(publisher, options.name);
+        this.runner = new ManagedCommand({
+            command: options.command,
+            cwd: options.cwd,
+            onData: (chunk) => {
+                this.output.append(chunk);
+                this.scheduleRender();
+            },
+        });
+    }
+    build(ui) {
+        ui.text(this.name, { key: "title", variant: "h3" });
+        if (!this.running)
+            ui.button("Run", new Action("run").call(null), { key: "run", variant: "primary" });
+        ui.text(this.status, { key: "status" });
+        ui.text(fenced(this.output.text, this.output.truncated), { key: "output" });
+    }
+    onAction(name) {
+        if (name !== "run" || this.running || this.closing)
+            return;
+        void this.run();
+    }
+    close() {
+        if (this.closePromise)
+            return this.closePromise;
+        this.closeSurface();
+        this.closePromise = this.runner.close();
+        return this.closePromise;
+    }
+    async run() {
+        this.running = true;
+        this.output.reset();
+        this.status = "Running…";
+        this.scheduleRender();
+        const result = await this.runner.start();
+        this.running = false;
+        this.status = describeResult(result);
+        this.scheduleRender();
+    }
+}

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export {};