@nettee/beacon 0.2.3 → 0.2.4

package/README.md

@@ -50,18 +50,25 @@ Copy the files under [`examples`](examples) into a private Beacon home and repla
 ├── config.yaml
 ├── runtime.env
 ├── secrets.json
-└── profiles/
-    └── example/
-        ├── profile.yaml
+├── profiles/
+│   └── example/
+│       └── profile.yaml
+└── workspace/
+    └── .beacon-profile/
         ├── persona.md
         └── task.md
 ```
 
-Each Profile directory must contain `persona.md` (identity) and `task.md`
-(process). Beacon prepends an English platform template for this Run: workspace
-limit, inbound vs Schedule vs manual capabilities, and the `reply` /
-`no_reply` / `notify_card` contract. It does not read yaml `prompt:` or
-`prompt.md`. Missing either Markdown file fails Profile load.
+yaml names the workspace directory only. Beacon then loads `persona.md`
+(identity) and `task.md` (process) as a pair: `{workspace}/.beacon-profile/`
+first; if that pair is missing, `{profileDir}/`. It never mixes the two
+places, never reads yaml `prompt:` / persona / task paths, and never falls
+back to `prompt.md`. If neither place has a complete pair, Profile load fails
+and lists the missing paths. Both pairs may exist; the workspace pair wins.
+
+Beacon prepends an English platform template for this Run: workspace limit,
+inbound vs Schedule vs manual capabilities, and the `reply` / `no_reply` /
+`notify_card` contract.
 
 Protect the home and secret file before running Beacon:
 
@@ -102,7 +109,7 @@ created by Beacon 0.1.2 and earlier; when omitted it defaults to `sessions/`
 beside `config.yaml`. When configured, it must be absolute. Beacon creates
 per-Run directories with mode `0700` when Pi starts.
 
-Configuration is strict: unknown YAML/JSON fields, YAML aliases or warnings, missing paths, duplicate Schedule IDs, invalid timezones/cron expressions, missing `persona.md` or `task.md`, escaped Profile markdown, permissive secret or runtime-environment permissions, and missing Profile credentials all fail startup. Beacon validates all Profiles before opening a Feishu connection.
+Configuration is strict: unknown YAML/JSON fields, YAML aliases or warnings, missing paths, duplicate Schedule IDs, invalid timezones/cron expressions, a missing complete `persona.md` + `task.md` pair, escaped Profile markdown, permissive secret or runtime-environment 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. Profile
 `admin.chat_id` is the private chat used for schedule `reply` / `no_reply` and

package/dist/config/profile.js

@@ -7,6 +7,7 @@ import { parseStrictYaml } from "./yaml.js";
 const profileIdPattern = /^[a-z0-9](?:[a-z0-9_-]{0,62})$/;
 export const profilePersonaFile = "persona.md";
 export const profileTaskFile = "task.md";
+export const workspaceProfileDirectoryName = ".beacon-profile";
 const scheduleSchema = z
     .object({
     id: z.string().regex(profileIdPattern),
@@ -61,8 +62,37 @@ function isWithin(parent, child) {
     const path = relative(parent, child);
     return path === "" || (!path.startsWith("..") && !isAbsolute(path));
 }
-async function loadRequiredMarkdown(canonicalProfileDirectory, filename) {
-    const filePath = join(canonicalProfileDirectory, filename);
+export function workspaceProfileDirectory(workspace) {
+    return join(workspace, workspaceProfileDirectoryName);
+}
+async function isExistingFile(path) {
+    try {
+        return (await stat(path)).isFile();
+    }
+    catch {
+        return false;
+    }
+}
+function markdownPairPaths(directory) {
+    return {
+        persona: join(directory, profilePersonaFile),
+        task: join(directory, profileTaskFile),
+    };
+}
+async function missingMarkdownPaths(directory) {
+    const paths = markdownPairPaths(directory);
+    const missing = [];
+    if (!(await isExistingFile(paths.persona)))
+        missing.push(paths.persona);
+    if (!(await isExistingFile(paths.task)))
+        missing.push(paths.task);
+    return missing;
+}
+async function markdownPairExists(directory) {
+    return (await missingMarkdownPaths(directory)).length === 0;
+}
+async function loadRequiredMarkdown(canonicalDirectory, filename) {
+    const filePath = join(canonicalDirectory, filename);
     let canonicalFilePath;
     try {
         canonicalFilePath = await realpath(filePath);
@@ -72,8 +102,8 @@ async function loadRequiredMarkdown(canonicalProfileDirectory, filename) {
             cause: error,
         });
     }
-    if (!isWithin(canonicalProfileDirectory, canonicalFilePath)) {
-        throw new Error(`Profile ${filename} must stay inside ${canonicalProfileDirectory}`);
+    if (!isWithin(canonicalDirectory, canonicalFilePath)) {
+        throw new Error(`Profile ${filename} must stay inside ${canonicalDirectory}`);
     }
     const text = (await readFile(canonicalFilePath, "utf8")).trim();
     if (!text) {
@@ -81,6 +111,39 @@ async function loadRequiredMarkdown(canonicalProfileDirectory, filename) {
     }
     return text;
 }
+async function loadMarkdownPair(directory, boundary) {
+    const canonicalBoundary = await realpath(boundary);
+    let canonicalDirectory;
+    try {
+        canonicalDirectory = await realpath(directory);
+    }
+    catch (error) {
+        throw new Error(`Cannot read Profile markdown at ${directory}`, {
+            cause: error,
+        });
+    }
+    if (!isWithin(canonicalBoundary, canonicalDirectory)) {
+        throw new Error(`Profile markdown must stay inside ${canonicalBoundary}`);
+    }
+    return {
+        persona: await loadRequiredMarkdown(canonicalDirectory, profilePersonaFile),
+        task: await loadRequiredMarkdown(canonicalDirectory, profileTaskFile),
+    };
+}
+async function loadPersonaAndTask(profileId, workspace, profileDirectory) {
+    const workspaceDirectory = workspaceProfileDirectory(workspace);
+    if (await markdownPairExists(workspaceDirectory)) {
+        return loadMarkdownPair(workspaceDirectory, workspace);
+    }
+    if (await markdownPairExists(profileDirectory)) {
+        return loadMarkdownPair(profileDirectory, profileDirectory);
+    }
+    const missing = [
+        ...(await missingMarkdownPaths(workspaceDirectory)),
+        ...(await missingMarkdownPaths(profileDirectory)),
+    ];
+    throw new Error(`Profile ${profileId} has no complete ${profilePersonaFile} + ${profileTaskFile} pair. Missing: ${missing.join(", ")}`);
+}
 export async function loadProfile(profileId, profilesDirectory = join(homedir(), ".beacon", "profiles")) {
     assertProfileId(profileId);
     const profileDirectory = join(profilesDirectory, profileId);
@@ -105,8 +168,6 @@ export async function loadProfile(profileId, profilesDirectory = join(homedir(),
         throw new Error(`Profile ${profileId} with schedules must declare admin.chat_id`);
     }
     const canonicalProfileDirectory = await realpath(profileDirectory);
-    const persona = await loadRequiredMarkdown(canonicalProfileDirectory, profilePersonaFile);
-    const task = await loadRequiredMarkdown(canonicalProfileDirectory, profileTaskFile);
     const workspace = isAbsolute(config.workspace)
         ? config.workspace
         : resolve(dirname(configPath), config.workspace);
@@ -122,6 +183,7 @@ export async function loadProfile(profileId, profilesDirectory = join(homedir(),
     if (!workspaceStat.isDirectory()) {
         throw new Error(`Profile workspace is not a directory: ${workspace}`);
     }
+    const { persona, task } = await loadPersonaAndTask(profileId, workspace, canonicalProfileDirectory);
     return {
         id: profileId,
         directory: canonicalProfileDirectory,

package/examples/profiles/example/profile.yaml

@@ -1,4 +1,4 @@
-workspace: /ABSOLUTE/PATH/TO/WORKSPACE
+workspace: ../../workspace
 runtime: pi
 model:
   provider: REPLACE_WITH_PI_PROVIDER

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nettee/beacon",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "A single-host bridge from messaging and schedules to isolated agent runs",
   "license": "Apache-2.0",
   "repository": {