@openmarket/rooms-client 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 [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

@@ -0,0 +1,25 @@
+# @openmarket/rooms-client
+
+The OM Rooms protocol client: wire types and frame schemas, the WebSocket client, the REST social client, endpoint resolution, and the chat view-models (sidebar, topics, lanes) shared by every OM Chat surface (TUI, GUI, bots).
+
+## Browser-safety contract
+
+Everything in this package runs unmodified in a browser: no `node:` or `bun:` imports, no filesystem or OS access, static imports only. Environment reads go through `envString()` in `endpoints.ts`, which returns `undefined` where `process` does not exist. The repo's boundary gate enforces this on every CI run; if you need daemon-side facilities (SQLite, vault, HTTP server), they live in the `om` CLI, not here.
+
+## Usage
+
+There is no root export; import the surface you need by subpath:
+
+```ts
+import { createRoomSpace } from "@openmarket/rooms-client/social-client";
+import { RoomClientMessageType, SUPPORTED_ROOM_PROTOCOL_VERSION } from "@openmarket/rooms-client/shared/rooms-protocol";
+import type { RoomSpaceSummary } from "@openmarket/rooms-client/social-types";
+```
+
+Subpaths: `client`, `ws-client`, `social-client`, `social-types`, `library-publisher`, `doc-reconcile`, `topic-uri`, `doc-uri`, `endpoints`, `jwt`, `names`, `suggestion-attribution`, `merge3`, `types`, `version`, `agent/{armed-mode, lane-draft, lane-prompts, library-context, library-model, room-context, sidebar-model, topic-inbox, topic-view-batcher}`, `agent/clients/common`, `shared/{rooms-protocol, mentions, emoji-data}`.
+
+Bun consumers resolve raw TypeScript via the `bun` export condition; Node and bundlers get compiled JS plus `.d.ts` from `dist/`.
+
+## Versioning
+
+The npm version is managed by hand: bump `package.json` here, `npm publish`, then bump the consumers' pins. The monorepo's release script deliberately skips this package's `package.json`. `src/version.ts` is the exception: it carries the wire/runner version and is auto-bumped with every `om` release so the WebSocket handshake tracks the daemon.

package/dist/agent/armed-mode.d.ts

@@ -0,0 +1,187 @@
+import { mentionsHandleExplicit as mentionsAgentExplicit, normalizeHandle } from "../shared/mentions.js";
+import type { RoomLedgerEntry } from "../types.js";
+export { mentionsAgentExplicit, normalizeHandle };
+/**
+ * ARMED MODE rules of engagement (RoE), the guardrails for autonomous in-room
+ * posting under the user's identity. These are the named, easy-to-change
+ * defaults. The whole point of armed mode is that the agent posts on its OWN
+ * initiative as the user, so every gate here is a SAFETY limit, not a nicety:
+ * each one independently blocks an autonomous post, and a post happens only when
+ * ALL of them allow it (see `canPostAutonomously`).
+ *
+ * Defaults DISARMED: with nothing armed there is zero autonomous posting and the
+ * TUI behaves exactly as before. Arming is in-memory per session, never
+ * persisted (a fresh launch is always disarmed).
+ */
+export declare const ARMED_RULES: {
+    /** Minimum gap between two autonomous posts in the SAME room. */
+    readonly cooldownMs: 30000;
+    /** Max autonomous posts per room in any rolling 60-minute window. When hit
+     *  the loop PAUSES (skips) until the window frees; it does NOT disarm. */
+    readonly hourlyCap: 10;
+    /** Rolling window the hourly cap is measured over. */
+    readonly hourlyWindowMs: number;
+    /** Max autonomous posts in a row with no intervening human message. When hit
+     *  the loop PAUSES until a human speaks; it does NOT disarm. */
+    readonly chainLimit: 3;
+    /** Hard per-armed-session TOKEN budget across all armed turns in a room.
+     *  Token spend is read from turn-reported usage when the provider supplies it.
+     *  Exceeding this AUTO-DISARMS the room (this is the cost guard). */
+    readonly tokenBudget: 200000;
+    /** Fallback hard cap on autonomous posts per armed session, used as the cost
+     *  guard when the provider reports no token usage (most providers don't on
+     *  streaming turns). Exceeding this ALSO auto-disarms. So the cost guard is
+     *  always effective: whichever of tokens / posts trips first disarms. */
+    readonly maxPostsPerSession: 40;
+    /** Settle window before deciding, so a burst of messages is judged once with
+     *  full context (reuses the room-monitor settle idea). */
+    readonly settleMs: 2500;
+    /** Hard cap on an autonomous post's length. Longer drafts are skipped, not
+     *  truncated (a half-sentence posted as the user is worse than silence). */
+    readonly maxPostChars: 600;
+    /** Consecutive turn/post errors that auto-disarm the room (kill switch). */
+    readonly maxConsecutiveErrors: 3;
+};
+/**
+ * Per-verb grants for armed mode. Some verbs are too consequential to ride the
+ * default armed toolset (which is otherwise market/research reads only): they
+ * are OFF unless the operator explicitly grants them for the session. `secrets_send`
+ * lets an armed agent seal-and-post autonomously; default DENY, since an
+ * untrusted @mention must never be able to make the agent exfiltrate a sealed
+ * value. Grants are in-memory per session, never persisted (a fresh launch
+ * grants nothing).
+ */
+export declare const ARMED_GRANTABLE_VERBS: readonly ["secrets_send"];
+export type ArmedGrantableVerb = (typeof ARMED_GRANTABLE_VERBS)[number];
+export declare function grantArmedVerb(verb: ArmedGrantableVerb): void;
+export declare function revokeArmedVerb(verb: ArmedGrantableVerb): void;
+export declare function isArmedVerbGranted(verb: ArmedGrantableVerb): boolean;
+/** The extra verb names an armed turn may advertise given the current grants.
+ *  Appended to `armedSafeToolNames()` at the armed call site. */
+export declare function grantedArmedVerbNames(): string[];
+/** Test/lifecycle helper: drop every grant (a fresh session grants nothing). */
+export declare function clearArmedVerbGrants(): void;
+/**
+ * Mutable per-room armed state. Lives only in memory and only while the room is
+ * armed; `disarm` drops it. Caps are tracked here and checked BEFORE every
+ * autonomous post.
+ */
+export interface ArmedRoomState {
+    /** Room id (e.g. "room:btc") this state guards. */
+    readonly roomId: string;
+    /** Timestamps (ms) of autonomous posts this session, used for the cooldown
+     *  and the rolling hourly cap. */
+    postTimes: number[];
+    /** Autonomous posts in a row with no intervening human message. Reset to 0
+     *  whenever a human speaks in the room. */
+    consecutiveAutoPosts: number;
+    /** Total autonomous posts this armed session (cost-guard fallback counter). */
+    postsThisSession: number;
+    /** Total tokens spent by armed turns this session (cost guard, when the
+     *  provider reports usage; otherwise stays 0 and the post counter governs). */
+    tokensThisSession: number;
+    /** Consecutive turn/post errors; resets on any clean turn. At
+     *  `maxConsecutiveErrors` the room auto-disarms. */
+    consecutiveErrors: number;
+    /** The highest room seq this loop has already evaluated, so re-entry doesn't
+     *  re-trigger on already-seen messages. */
+    lastEvaluatedSeq: number;
+}
+/** A fresh armed state for a newly armed room. */
+export declare function makeArmedRoomState(roomId: string, lastSeq?: number): ArmedRoomState;
+/**
+ * Whether a single incoming entry is a qualifying TRIGGER: a NEW human POST in
+ * the room that @mentions the user's own handle. Agent posts, system entries,
+ * the user's own posts, and non-mentions never trigger. Pure.
+ */
+export declare function isTriggeringEntry(entry: RoomLedgerEntry, ownHandle: string, ownUserId: string): boolean;
+/**
+ * The newest qualifying trigger among entries strictly newer than
+ * `afterSeq`, or null if none. Used by the loop to decide whether the latest
+ * batch of room messages contains a reason to act. Pure.
+ */
+export declare function findTrigger(entries: ReadonlyArray<RoomLedgerEntry>, ownHandle: string, ownUserId: string, afterSeq: number): RoomLedgerEntry | null;
+/** Autonomous posts inside the rolling hourly window as of `now`. */
+export declare function postsInWindow(state: ArmedRoomState, now?: number): number;
+/** Remaining cooldown (ms) before the next autonomous post is allowed; 0 when
+ *  free. */
+export declare function cooldownRemaining(state: ArmedRoomState, now?: number): number;
+export type CapBlock = "cooldown" | "hourly" | "chain" | "budget";
+/**
+ * Which cap (if any) blocks an autonomous post RIGHT NOW, or null when every
+ * cap allows it. Order matters only for the reported reason; all are hard. Pure
+ * and exported so each gate is unit-testable in isolation.
+ *
+ * - cooldown: < cooldownMs since the last autonomous post.
+ * - hourly:   >= hourlyCap autonomous posts in the rolling window (PAUSE).
+ * - chain:    >= chainLimit autonomous posts with no human between (PAUSE).
+ * - budget:   token spend OR post count over the session cost guard (DISARM).
+ */
+export declare function capBlocking(state: ArmedRoomState, now?: number): CapBlock | null;
+/**
+ * Whether the session cost guard is spent: token spend over budget OR (the
+ * provider-agnostic fallback) post count over the per-session max. Either
+ * tripping AUTO-DISARMS the room. Pure.
+ */
+export declare function budgetExceeded(state: ArmedRoomState): boolean;
+export type ContentVerdict = {
+    ok: true;
+    text: string;
+} | {
+    ok: false;
+    reason: string;
+};
+/**
+ * CONTENT GUARD applied to a candidate autonomous post BEFORE it is sent.
+ * Rejects: empty/whitespace, anything matching a secret/credential pattern,
+ * anything containing a link/URL, and anything over the length cap. On pass,
+ * returns the trimmed text to post. Pure and exported for unit testing: this
+ * is the last line of defense before text goes out as the user.
+ */
+export declare function guardAutonomousContent(raw: string): ContentVerdict;
+export type PostDecision = {
+    post: true;
+    text: string;
+} | {
+    post: false;
+    reason: string;
+    disarm: boolean;
+};
+/**
+ * THE single gate in front of every autonomous post. Returns `{ post: true }`
+ * ONLY when ALL hold:
+ *   1. the room is armed (the caller only invokes this for an armed room, and
+ *      passes its live state),
+ *   2. there is a qualifying trigger (own-handle @mention in a new human msg),
+ *   3. every cap allows it (cooldown AND hourly AND chain AND budget), and
+ *   4. the content guard passes.
+ * Any failure returns `{ post: false }` with a reason; `disarm` is true only
+ * when the failure is the cost-guard (budget), the one cap that auto-disarms
+ * rather than pausing. Pure, so the full && chain is unit-testable end to end
+ * without a TUI or network.
+ */
+export declare function canPostAutonomously(input: {
+    state: ArmedRoomState;
+    trigger: RoomLedgerEntry | null;
+    candidate: string;
+    now?: number;
+}): PostDecision;
+/**
+ * Record a completed autonomous post against the caps: stamp the time (cooldown
+ * + hourly), bump the consecutive-chain and session counters. Call AFTER a
+ * successful `post()`. Mutates `state`.
+ */
+export declare function recordAutonomousPost(state: ArmedRoomState, now?: number): void;
+/** Record token spend from an armed turn against the session cost guard. Reads
+ *  `totalTokens` from a turn's `usage` (pi-ai shape) when present; a no-op when
+ *  the provider reported nothing (the post counter is the fallback guard). */
+export declare function recordArmedTurnUsage(state: ArmedRoomState, usage: Record<string, unknown> | undefined): void;
+/** A human (non-agent) POST that is NOT our own resets the consecutive-chain
+ *  counter, freeing a chain-limit pause. Pure. */
+export declare function isHumanResetEntry(entry: RoomLedgerEntry, ownHandle: string, ownUserId: string): boolean;
+/** Note a turn/post error against the kill switch; returns true once the room
+ *  should auto-disarm (>= maxConsecutiveErrors in a row). Mutates `state`. */
+export declare function noteArmedError(state: ArmedRoomState): boolean;
+/** Reset the consecutive-error counter after a clean armed turn. */
+export declare function clearArmedErrors(state: ArmedRoomState): void;
+export declare function countConsecutiveAgentPosts(entries: RoomLedgerEntry[]): number;