@nettee/beacon 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,163 @@
+# Beacon
+
+Beacon is a single-host service that turns Feishu messages and configured schedules into isolated Pi agent runs. Each accepted Trigger is durably claimed, produces exactly one explicit Final Outcome, and is delivered either as a quoted reply or to a configured Feishu `chat_id`.
+
+This repository currently implements the Feishu + Pi MVP described by the
+[Zest Dev Spec](https://github.com/nettee/beacon/blob/main/specs/change/20260913-beacon-feishu-pi-mvp/spec.md).
+
+## Runtime requirements
+
+- macOS with Node.js 22 or newer
+- npm
+- A Pi executable and Pi coding-agent directory
+- One Feishu self-built application per Profile, configured for persistent-connection message events and the APIs needed to read/reply/react/create messages
+
+## Install
+
+```sh
+npm install --global @nettee/beacon@latest
+beacon version
+```
+
+Install an exact version when the deployment must be reproducible, including
+when rolling back:
+
+```sh
+npm install --global @nettee/beacon@0.1.0
+```
+
+Upgrade to the current stable release with the same `latest` command. Run
+`beacon doctor` with the production configuration before restarting a running
+service. Beacon does not manage launchd installation, restart, or rollback in
+this release.
+
+Beacon only accepts an absolute path for the global configuration:
+
+```sh
+beacon doctor --config /Users/USERNAME/.beacon/config.yaml
+beacon serve --config /Users/USERNAME/.beacon/config.yaml
+```
+
+`doctor` validates every Profile and credential, obtains a Feishu tenant token, and runs a real Pi RPC smoke test. It does not create Beacon state records.
+
+## Configuration
+
+Copy the files under [`examples`](examples) into a private Beacon home and replace every placeholder. A minimal layout is:
+
+```text
+~/.beacon/
+├── config.yaml
+├── secrets.json
+└── profiles/
+    └── example/
+        ├── profile.yaml
+        └── prompt.md
+```
+
+Protect the home and secret file before running Beacon:
+
+```sh
+chmod 700 /Users/USERNAME/.beacon
+chmod 600 /Users/USERNAME/.beacon/secrets.json
+```
+
+Configuration is strict: unknown YAML/JSON fields, YAML aliases or warnings, missing paths, duplicate Schedule IDs, invalid timezones/cron expressions, unsafe Prompt paths, permissive secret permissions, and missing Profile credentials all fail startup. Beacon validates all Profiles before opening a Feishu connection.
+
+Each Schedule uses a five-field cron expression and an IANA timezone. Its `delivery.chat_id` may identify either a direct chat or a group chat; Beacon deliberately does not infer or fall back to another destination. A newly discovered Schedule starts at the current time. After sleep or restart, overdue occurrences are reconciled and coalesced to the most recent one.
+
+## Commands
+
+```text
+beacon serve --config <absolute-path>
+beacon doctor --config <absolute-path>
+beacon trigger --config <absolute-path> --profile <id> --input -
+beacon version
+```
+
+An operator can run one Profile without Feishu delivery by piping input to `trigger`; the Final Outcome is printed to stdout:
+
+```sh
+printf '%s\n' 'Summarize the workspace status.' | \
+  beacon trigger --config /Users/USERNAME/.beacon/config.yaml --profile example --input -
+```
+
+## State and failure behavior
+
+Per-Profile state lives below `profiles/<profile-id>/state/`. Trigger claims, normalized inputs, Run state, Final Outcomes, Delivery state, and Schedule cursors use durable JSON snapshots. Records do not expire, and Beacon has no automatic cleanup task. Manually deleting state also deletes its deduplication memory.
+
+Duplicate Feishu events and duplicate Schedule occurrences do not start a second Run. Active Runs interrupted by restart fail rather than rerun. Pending Delivery can resume, while a Delivery interrupted after its external call began fails without resending. Run and Delivery success are recorded independently. Beacon does not automatically retry either one.
+
+Secrets and ephemeral Run Capability tokens are excluded from persisted records and from the Pi environment except for the one Run-scoped Outcome capability.
+
+## launchd
+
+Edit [`deploy/io.nettee.beacon.plist.example`](deploy/io.nettee.beacon.plist.example) so every executable, config, working-directory, and log path is absolute. Create the log directory, copy the plist to `~/Library/LaunchAgents/io.nettee.beacon.plist`, then validate and load it:
+
+Use `command -v beacon` after the global npm installation to find the absolute
+CLI path for `ProgramArguments`. A Node version-manager upgrade can change that
+path, so re-check it when changing the installed Node version.
+
+```sh
+plutil -lint /Users/USERNAME/Library/LaunchAgents/io.nettee.beacon.plist
+launchctl bootstrap gui/$(id -u) /Users/USERNAME/Library/LaunchAgents/io.nettee.beacon.plist
+launchctl print gui/$(id -u)/io.nettee.beacon
+```
+
+The example uses a restrictive umask and asks launchd to restart only after abnormal exit. `SIGTERM` initiates an orderly shutdown: timers and Gateways stop, accepted intake work drains, and the local Outcome server closes.
+
+## Development checks
+
+Development requires pnpm 10.33.2. Install dependencies before running checks
+from a source checkout:
+
+```sh
+pnpm install --frozen-lockfile
+```
+
+```sh
+pnpm check
+pnpm typecheck
+pnpm test
+pnpm test:package
+pnpm e2e:message
+pnpm build
+plutil -lint deploy/io.nettee.beacon.plist.example
+```
+
+`pnpm test:package` builds a production tarball, checks its allowlisted
+contents, installs it under a temporary global npm prefix, and runs the
+installed `beacon` binary without using the source tree.
+
+`pnpm e2e:message` sends one synthetic Feishu direct message through an
+in-memory Gateway, the production message pipeline, and a real Pi model. The
+same in-memory Gateway captures the quoted reply without contacting Feishu. It defaults to
+`openai-codex/gpt-5.3-codex-spark`; override the runtime with
+`BEACON_E2E_MESSAGE_PROVIDER`, `BEACON_E2E_MESSAGE_MODEL`,
+`BEACON_E2E_MESSAGE_PI_EXECUTABLE`, or
+`BEACON_E2E_MESSAGE_PI_CODING_AGENT_DIRECTORY`.
+
+## Publishing
+
+Choose the next semantic version explicitly in `package.json` and
+`pnpm-lock.yaml`, then submit the release candidate through the normal pull
+request checks. After the initial package bootstrap, each push to `main` runs
+the npm publish workflow. It verifies the source and packaged installation,
+publishes a version that is not yet present, and explicitly skips a version
+that already exists.
+
+The first `@nettee/beacon` release is a one-time exception because npm requires
+a package to exist before Trusted Publishing can be configured. After the
+`0.1.0` pull request is merged:
+
+1. Review `npm pack --dry-run --json`, then publish `0.1.0` interactively with
+   npm 2FA using `npm publish --access public`.
+2. Configure `nettee/beacon` and `.github/workflows/publish-npm.yml` as the npm
+   Trusted Publisher with direct publish permission.
+3. Set the GitHub repository variable `NPM_TRUSTED_PUBLISHING_ENABLED` to
+   `true`.
+4. Install `@nettee/beacon@0.1.0` from the public registry in a clean temporary
+   prefix and verify `beacon version` before accepting the release.
+
+The repository variable deliberately keeps publishing disabled during the
+bootstrap merge. Subsequent versions publish from GitHub Actions with OIDC and
+do not use a long-lived npm write token.

package/deploy/io.nettee.beacon.plist.example

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>Label</key>
+  <string>io.nettee.beacon</string>
+  <key>ProgramArguments</key>
+  <array>
+    <string>/usr/local/bin/beacon</string>
+    <string>serve</string>
+    <string>--config</string>
+    <string>/Users/USERNAME/.beacon/config.yaml</string>
+  </array>
+  <key>WorkingDirectory</key>
+  <string>/Users/USERNAME/.beacon</string>
+  <key>RunAtLoad</key>
+  <true/>
+  <key>KeepAlive</key>
+  <dict>
+    <key>SuccessfulExit</key>
+    <false/>
+  </dict>
+  <key>ThrottleInterval</key>
+  <integer>10</integer>
+  <key>Umask</key>
+  <integer>63</integer>
+  <key>StandardOutPath</key>
+  <string>/Users/USERNAME/.beacon/logs/service.stdout.log</string>
+  <key>StandardErrorPath</key>
+  <string>/Users/USERNAME/.beacon/logs/service.stderr.log</string>
+</dict>
+</plist>

package/dist/cli-app.js

@@ -0,0 +1,71 @@
+import { isAbsolute } from "node:path";
+function usage() {
+    throw new Error(`Usage:
+  beacon serve --config <absolute-path>
+  beacon doctor --config <absolute-path>
+  beacon trigger --config <absolute-path> --profile <id> --input -
+  beacon version`);
+}
+function configOnly(args) {
+    if (args.length !== 2 || args[0] !== "--config" || !args[1])
+        usage();
+    if (!isAbsolute(args[1]))
+        throw new Error("Config path must be absolute");
+    return args[1];
+}
+export function parseCli(args) {
+    const [command, ...rest] = args;
+    if (command === "version") {
+        if (rest.length !== 0)
+            usage();
+        return { command: "version" };
+    }
+    if (command === "serve" || command === "doctor") {
+        return { command, config: configOnly(rest) };
+    }
+    if (command === "trigger") {
+        if (rest.length !== 6)
+            usage();
+        const values = new Map();
+        for (let index = 0; index < rest.length; index += 2) {
+            const key = rest[index];
+            const value = rest[index + 1];
+            if (!key?.startsWith("--") || !value || values.has(key))
+                usage();
+            values.set(key, value);
+        }
+        const config = values.get("--config");
+        const profile = values.get("--profile");
+        if (!config ||
+            !profile ||
+            values.get("--input") !== "-" ||
+            values.size !== 3)
+            usage();
+        if (!isAbsolute(config))
+            throw new Error("Config path must be absolute");
+        return { command: "trigger", config, profile };
+    }
+    if (command === "outcome" && rest.length === 1 && rest[0] === "submit") {
+        return { command: "outcome-submit" };
+    }
+    return usage();
+}
+async function readStdin() {
+    process.stdin.setEncoding("utf8");
+    let value = "";
+    for await (const chunk of process.stdin)
+        value += chunk;
+    return value;
+}
+export async function runCli(command, dependencies) {
+    if (command.command === "serve")
+        return dependencies.serve(command.config);
+    if (command.command === "doctor")
+        return dependencies.doctor(command.config);
+    if (command.command === "trigger") {
+        return dependencies.trigger(command.config, command.profile, await readStdin());
+    }
+    if (command.command === "outcome-submit")
+        return dependencies.submitOutcome();
+    console.log(dependencies.version);
+}

package/dist/cli.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+import { parseCli, runCli } from "./cli-app.js";
+import { runDoctor } from "./doctor.js";
+import { runManualTrigger } from "./manual-trigger.js";
+import { submitOutcomeFromCli } from "./outcome/submit.js";
+import { runBeacon } from "./service.js";
+import { packageVersion } from "./version.js";
+async function main() {
+    await runCli(parseCli(process.argv.slice(2)), {
+        serve: runBeacon,
+        doctor: runDoctor,
+        trigger: runManualTrigger,
+        submitOutcome: submitOutcomeFromCli,
+        version: packageVersion,
+    });
+}
+main().catch((error) => {
+    const message = error instanceof Error ? error.message : String(error);
+    console.error(`[beacon] fatal: ${message}`);
+    process.exitCode = 1;
+});

package/dist/config/global.js

@@ -0,0 +1,84 @@
+import { constants } from "node:fs";
+import { access, realpath, stat } from "node:fs/promises";
+import { dirname, isAbsolute, resolve } from "node:path";
+import { z } from "zod";
+import { parseStrictYaml } from "./yaml.js";
+const positiveInteger = z.number().int().positive().safe();
+const globalDocumentSchema = z
+    .object({
+    version: z.literal(1),
+    profiles_directory: z.string().min(1),
+    pi: z
+        .object({
+        executable: z.string().min(1),
+        coding_agent_directory: z.string().min(1),
+    })
+        .strict(),
+    runs: z
+        .object({
+        max_concurrent: positiveInteger,
+        max_queued: z.number().int().nonnegative().safe(),
+        timeout_seconds: positiveInteger,
+        terminate_grace_seconds: positiveInteger,
+    })
+        .strict(),
+    scheduler: z
+        .object({ max_occurrences_per_reconciliation: positiveInteger })
+        .strict(),
+})
+    .strict();
+async function assertFile(path, executable = false) {
+    const canonical = await realpath(path).catch((error) => {
+        throw new Error(`Required file does not exist: ${path}`, { cause: error });
+    });
+    const metadata = await stat(canonical);
+    if (!metadata.isFile())
+        throw new Error(`Required path is not a file: ${path}`);
+    if (executable)
+        await access(canonical, constants.X_OK);
+    return canonical;
+}
+async function assertDirectory(path) {
+    const canonical = await realpath(path).catch((error) => {
+        throw new Error(`Required directory does not exist: ${path}`, {
+            cause: error,
+        });
+    });
+    if (!(await stat(canonical)).isDirectory()) {
+        throw new Error(`Required path is not a directory: ${path}`);
+    }
+    return canonical;
+}
+export async function loadGlobalConfig(path) {
+    if (!isAbsolute(path))
+        throw new Error(`Global config path must be absolute: ${path}`);
+    const canonicalPath = await assertFile(path);
+    const document = globalDocumentSchema.parse(await parseStrictYaml(canonicalPath));
+    const homeDirectory = dirname(canonicalPath);
+    const resolveFromHome = (value) => isAbsolute(value) ? value : resolve(homeDirectory, value);
+    const profilesDirectory = await assertDirectory(resolveFromHome(document.profiles_directory));
+    if (!isAbsolute(document.pi.executable)) {
+        throw new Error("Pi executable path must be absolute");
+    }
+    if (!isAbsolute(document.pi.coding_agent_directory)) {
+        throw new Error("Pi coding agent directory must be absolute");
+    }
+    const executable = await assertFile(document.pi.executable, true);
+    const codingAgentDirectory = await assertDirectory(document.pi.coding_agent_directory);
+    return {
+        path: canonicalPath,
+        homeDirectory,
+        profilesDirectory,
+        secretsPath: resolve(homeDirectory, "secrets.json"),
+        pi: { executable, codingAgentDirectory },
+        runs: {
+            maxConcurrent: document.runs.max_concurrent,
+            maxQueued: document.runs.max_queued,
+            timeoutSeconds: document.runs.timeout_seconds,
+            terminateGraceSeconds: document.runs.terminate_grace_seconds,
+        },
+        scheduler: {
+            maxOccurrencesPerReconciliation: document.scheduler.max_occurrences_per_reconciliation,
+        },
+    };
+}