aurival 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

@@ -0,0 +1,195 @@
+<p align="center">
+  <a href="https://bots.aurival.com/docs"><img src="https://raw.githubusercontent.com/Nullspire-LLC/aurival-sdk/main/assets/aurival-banner.png" alt="Aurival" width="100%"></a>
+</p>
+<p align="center">Write a bot for Aurival. Declare commands, call <code>run()</code>, and the SDK holds the socket.</p>
+<p align="center">
+  <a href="https://pypi.org/project/aurival/"><img src="https://img.shields.io/pypi/v/aurival.svg" alt="PyPI version"></a>
+  <a href="https://www.npmjs.com/package/aurival"><img src="https://img.shields.io/npm/v/aurival.svg" alt="npm version"></a>
+  <a href="https://github.com/Nullspire-LLC/aurival-sdk/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-blue.svg" alt="License: Apache-2.0"></a>
+</p>
+
+```ts
+import { Bot } from 'aurival';
+
+const bot = new Bot();
+
+bot.command('ping', 'Check that the bot is alive', async (ctx) => {
+  await ctx.reply('pong');
+});
+
+bot.run();
+```
+
+Node 22+. ESM. TypeScript source, shipping plain JS plus `.d.ts`, so you get types whether
+or not you use TypeScript.
+
+Node 22.0–22.10 print `[UNDICI-WS] Warning: WebSockets are experimental` on every start —
+that line is expected, comes from Node's own `WebSocket` implementation, and does not mean
+anything is wrong. Node 22.11+ is silent. The floor stays 22.
+
+This is the same package as [`aurival` on PyPI](../python), file for file and name for name.
+Learn one and you have learned the other.
+
+## Start from nothing
+
+```
+npm install aurival
+npx aurival init
+node bot.js
+```
+
+`init` pairs this machine and writes a starter bot that already answers `/ping`. It writes
+`bot.ts` when the folder already has TypeScript (a `tsconfig.json`), `bot.js` otherwise, so
+the file it names is one you can run as it stands. It never overwrites an existing bot
+file, and it refuses before it pairs rather than after.
+
+`init` is a convenience, not a requirement: `bot.run()` still pairs on its first run.
+
+## First run
+
+There is nothing to configure. The first `run()` pairs this machine:
+
+```
+aurival: pairing code    K7QP-2M4X
+aurival: fingerprint     018R-6WAC
+Compare the fingerprint in the app, then approve. Waiting...
+```
+
+Compare the fingerprint in the app before you approve — it is what makes a stolen code
+useless. The key lands in `./.aurival/machine.json` (mode `0600`, in a `0700` directory,
+with a `.gitignore` beside it so it can never be committed). Every later run just starts.
+
+The key deploys with the project, like a `.env`. Each bot has its own. A leaked key is one
+machine you revoke; a leaked token would be the bot.
+
+## What a handler gets
+
+```ts
+bot.command('say', async (ctx) => {
+  ctx.command; // "say"
+  ctx.arguments; // the raw rest of the line, unparsed, possibly ""
+  ctx.chat; // { id, type, name }
+  ctx.sender; // { id, handle, name }
+  ctx.message; // the id of the message that invoked you, or null
+  await ctx.reply('…');
+});
+```
+
+`ctx.reply()` quotes the message that invoked the command, so an answer never floats free
+in a busy chat. There is no flag: on the rare event that carries no message id it sends a
+plain message instead.
+
+Handlers run concurrently, and an event is acked only after its handler settles — so a
+crash mid-handler redelivers rather than loses. **Do not block inside a handler.** A
+synchronous call (a busy loop, `execSync`, a long CPU pass) starves the heartbeat on the
+same event loop, and the server reaps a socket that has gone quiet for three intervals.
+Use `await`, or hand the work to a worker thread.
+
+An exception in a handler is logged with its stack, the bot stays up, and the event is
+still acked:
+
+```ts
+bot.onError((error, ctx) => {
+  // ctx is null for anything that did not come from a handler
+});
+```
+
+The hook also sees the two things that are not a handler's fault: a `problem` frame from
+the server (your socket stays open), and a `backlog.overflowed` event telling you how many
+events you missed while you were away and where delivery resumed. Neither reaches a
+command handler.
+
+## Shadowed commands
+
+Every `run()` syncs your command list, and the server answers with the chats where another
+bot already holds one of your names. Yours never fires there. The SDK prints one warning
+line per shadowed chat:
+
+```
+aurival warn: /ping is shadowed by another bot in chat_01j…, so it will not reach you there
+```
+
+Rename the command, or get the other bot out of that chat. Nothing else in the SDK reacts
+to it — a shadowed command in one chat is still live in every other.
+
+## Environment
+
+| variable           | what it does                                                                                                                                              |
+| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `AURIVAL_API`      | point at another host. Must be `https://` unless it is loopback. The SDK prints the host it is using, so a redirect is visible.                           |
+| `AURIVAL_KEY_PATH` | put `machine.json` somewhere else. No `.gitignore` is written beside an override — that is your directory, not ours.                                      |
+| `AURIVAL_DEBUG`    | Node has no stdlib logger, so the default one mirrors an unconfigured Python `logging`: warnings and errors to stderr, debug and info only with this set. |
+
+## Errors
+
+One class per error type, one subclass per code the SDK acts on, and `code` and `doc_url`
+on every instance:
+
+```ts
+import { RateLimitError, KeyRevoked } from 'aurival';
+
+try {
+  await ctx.reply('…');
+} catch (error) {
+  if (error instanceof RateLimitError) {
+    console.log(error.code, error.retry_after, error.doc_url);
+  }
+}
+```
+
+`KeyRevoked`, `SessionSuperseded` and `BotSuspended` end the process on purpose — each one
+means something a reconnect cannot fix. Everything else the SDK handles for you: token
+expiry, deploys, network faults, redelivery.
+
+`KeyRevoked` names the file to remove, since pairing again is the only way back:
+
+```
+KeyRevoked: The key on this machine was revoked. Generate a new keypair and pair the
+machine again — a revoked key cannot be re-paired. Remove .aurival/machine.json and run
+the bot again to pair a new key.
+```
+
+## Dependencies
+
+**None.** `fetch`, `WebSocket` and Ed25519 signing are all built into Node 22, which is why
+the floor is 22 rather than 20 — Node 20 has no unflagged `WebSocket` client, and "Node 20"
+and "zero runtime dependencies" could not both be true.
+
+```
+$ npm ls --omit=dev
+aurival@0.1.0
+└── (empty)
+```
+
+Development only, and each earns its place:
+
+| package                                                    | version   | why                                                                                                                                                           |
+| ---------------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [`typescript`](https://www.npmjs.com/package/typescript)   | `7.0.2`   | The source is TypeScript; this compiles it to the plain JS and `.d.ts` the package ships.                                                                     |
+| [`vitest`](https://www.npmjs.com/package/vitest)           | `5.0.0`   | The test runner. Runs TypeScript directly, so the suite tests the source rather than a build artefact.                                                        |
+| [`@types/node`](https://www.npmjs.com/package/@types/node) | `22.20.1` | Types for the built-ins the package leans on. Pinned to the **22** line on purpose: a later major would type APIs Node 22 does not have, and the floor is 22. |
+| [`prettier`](https://www.npmjs.com/package/prettier)       | `3.9.6`   | Formatting, so a diff is about the change.                                                                                                                    |
+
+Every version was resolved from npm at build time (2026-09-05) with `npm view <pkg> version`
+and pinned exactly. None came from memory.
+
+`vitest` itself wants Node `>=22.12`; the package's own floor stays Node 22.0 (SDK-20). Run
+the suite on a 22.12+ (or newer) Node. `package.json`'s `devEngines` warns rather than
+fails on an older Node, since the runtime floor and the dev-toolchain floor are not the
+same number.
+
+## Tests
+
+```
+npm test
+```
+
+The end-to-end test runs a real bot against the real Go service through
+`backend-go/cmd/bot-api-testbed`, which needs a throwaway Postgres:
+
+```
+MIGRATE_TEST_DATABASE_URL='postgres://postgres@127.0.0.1:5432/postgres?sslmode=disable' npm test
+```
+
+**Without that variable the end-to-end test announces that it skipped.** It never passes
+quietly — a suite reporting green when it never reached the service is worse than no suite.

package/dist/auth.d.ts

@@ -0,0 +1,67 @@
+/**
+ * The key file, first-run pairing, assertion signing, access-token exchange.
+ *
+ * SDK-33: the seed lives in exactly one object (`MachineKey`) and never leaves
+ * it — not a property anywhere else, not a local in dispatch, not in a log line
+ * or thrown message. Node's `KeyObject` keeps the bytes out of reach; the only
+ * path the b64 seed travels is `KeyFile.load` -> `MachineKey.fromSeedB64`
+ * (decoded immediately) and `MachineKey.seedB64ForSave` -> `KeyFile.save`
+ * (encoded only at the moment of writing).
+ */
+import { inspect } from 'node:util';
+import type { HttpClient, Logger } from './http.js';
+export { DEFAULT_HOST } from './http.js';
+/** The ONLY object that holds the seed (SDK-33). */
+export declare class MachineKey {
+    #private;
+    private constructor();
+    static generate(): MachineKey;
+    static fromSeedB64(seedB64: string): MachineKey;
+    sign(payload: Uint8Array): Uint8Array;
+    get publicKeyB64(): string;
+    get fingerprint(): string;
+    /** The seed's one legitimate exit. Called ONLY by `KeyFile.save`. */
+    seedB64ForSave(): string;
+    toString(): string;
+    [inspect.custom](): string;
+}
+/** machine.json minus the seed. Safe to log. */
+export interface Machine {
+    bot: string;
+    machine: string;
+    host: string;
+    created: string;
+}
+export declare class KeyFile {
+    readonly path: string;
+    readonly isDefault: boolean;
+    constructor(filePath?: string | null);
+    static defaultPath(): string;
+    load(): Promise<{
+        key: MachineKey;
+        machine: Machine;
+    } | null>;
+    save(key: MachineKey, machine: Machine): Promise<void>;
+}
+export declare class Auth {
+    #private;
+    readonly bot: string;
+    constructor(http: HttpClient, key: MachineKey, machine: Machine, logger?: Logger, keyPath?: string | null);
+    token(): Promise<string>;
+    refresh(): Promise<string>;
+    buildAssertion(now?: number): string;
+}
+export declare function machineLabel(): string;
+export declare function resolveHost(): string;
+export interface PairOptions {
+    machineLabel?: string | undefined;
+    host: string;
+    out?: ((line: string) => void) | undefined;
+    logger?: Logger | undefined;
+    signal?: AbortSignal | undefined;
+}
+export declare function pair(http: HttpClient, options: PairOptions): Promise<{
+    key: MachineKey;
+    machine: Machine;
+}>;
+//# sourceMappingURL=auth.d.ts.map

package/dist/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAWH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAMpC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAIpD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAoEzC,oDAAoD;AACpD,qBAAa,UAAU;;IAGrB,OAAO,eAEN;IAED,MAAM,CAAC,QAAQ,IAAI,UAAU,CAG5B;IAED,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,CAQ9C;IAED,IAAI,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU,CAEpC;IAED,IAAI,YAAY,IAAI,MAAM,CAGzB;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,qEAAqE;IACrE,cAAc,IAAI,MAAM,CAGvB;IAED,QAAQ,IAAI,MAAM,CAEjB;IAED,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAEzB;CACF;AAED,gDAAgD;AAChD,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAUD,qBAAa,OAAO;IAClB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,YAAY,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,EAcnC;IAED,MAAM,CAAC,WAAW,IAAI,MAAM,CAE3B;IAEK,IAAI,IAAI,OAAO,CAAC;QAAE,GAAG,EAAE,UAAU,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC,CAiBlE;IAEK,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CA0B3D;CACF;AAMD,qBAAa,IAAI;;IACf,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAcrB,YACE,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,UAAU,EACf,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,EAQxB;IAUK,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,CAK7B;IAEK,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,CAU/B;IAwCD,cAAc,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAcnC;CACF;AAID,wBAAgB,YAAY,IAAI,MAAM,CAErC;AAYD,wBAAgB,WAAW,IAAI,MAAM,CAuBpC;AAED,MAAM,WAAW,WAAW;IAC1B,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAC3C,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CAClC;AA4DD,wBAAsB,IAAI,CACxB,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,WAAW,GACnB,OAAO,CAAC;IAAE,GAAG,EAAE,UAAU,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC,CAqDhD"}