@hayasaka7/haya-pet 0.2.8 → 0.3.0

package/CHANGELOG.md

@@ -7,6 +7,17 @@ All notable changes to HAYA Pet are documented here. This project adheres to
 > 0.2.0 npm publish; they are listed under 0.2.1, which is the first version that
 > ships them.
 
+## [0.3.0]
+
+### Fixed
+- **A fresh install now shows a real pet.** The package has always shipped a
+  ready-to-use pet (`assets/fallback-pet`), but discovery only scanned the
+  user's pet folders (`~/.codex/pets`, `~/.haya-pet/pets`), so a new user with
+  no pets got a blue "dev placeholder" box and an empty pet list instead. The
+  bundled pet is now composed into discovery as a last resort — appended after
+  any of the user's own pets (which still win and stay the default) and deduped
+  by id — so the overlay always renders a real character out of the box.
+
 ## [0.2.8]
 
 ### Fixed

package/apps/cli/src/haya-pet.js

@@ -14,7 +14,7 @@ import { watchCodexGuardianReviews as defaultWatchCodexGuardianReviews } from ".
 import { ensureCompanionConnection } from "../../../packages/cli-core/src/companion-launcher.js";
 import { createIpcClient as defaultCreateIpcClient } from "../../../packages/daemon-core/src/ipc-server.js";
 import { getDefaultPaths } from "../../../packages/platform-core/src/paths.js";
-import { discoverPets as defaultDiscoverPets } from "../../../packages/pet-core/src/discovery.js";
+import { discoverPetsWithFallback as defaultDiscoverPets } from "../../../packages/pet-core/src/discovery.js";
 import { createStateFile as defaultCreateStateFile } from "../../../packages/app-state/src/state-file.js";
 import { getSelectedPetId, setSelectedPet, getHooksEnabled, setHooksEnabled } from "../../../packages/app-state/src/state.js";
 import { checkForUpdate, UPDATE_COMMAND } from "../../../packages/app-state/src/update-check.js";

package/apps/companion/src/main/index.js

@@ -18,7 +18,7 @@ import { resolveSavedPosition } from "./display-manager.js";
 import { getPetScale, setPetScale, setSelectedPet, updateGlobalPetPosition } from "./position-store.js";
 import { buildTrayMenu, buildTrayTooltip } from "./tray-menu.js";
 import { createStateFile } from "./state-file.js";
-import { discoverPets } from "./pet-loader.js";
+import { discoverPetsWithFallback } from "./pet-loader.js";
 import { checkForUpdate, UPDATE_PAGE_URL } from "../../../../packages/app-state/src/update-check.js";
 
 const STALE_SWEEP_INTERVAL_MS = 10_000;
@@ -67,7 +67,7 @@ if (!app.requestSingleInstanceLock()) {
 async function bootstrap() {
   positionState = await stateFile.load();
   petScale = clampScale(getPetScale(positionState));
-  pets = await discoverPets(paths.petSearchPaths);
+  pets = await discoverPetsWithFallback(paths.petSearchPaths);
 
   // Clients fire no event at the moment the user ACCEPTS a permission prompt
   // (only denial/finish are observable), so a waiting_approval session would

package/apps/companion/src/main/pet-loader.js

@@ -1,2 +1,6 @@
 // Re-exported from pet-core so the companion and CLI share one discovery path.
-export { discoverPets, loadPetFromDir } from "../../../../packages/pet-core/src/discovery.js";
+export {
+  discoverPets,
+  discoverPetsWithFallback,
+  loadPetFromDir
+} from "../../../../packages/pet-core/src/discovery.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hayasaka7/haya-pet",
-  "version": "0.2.8",
+  "version": "0.3.0",
   "type": "module",
   "description": "Generic AI CLI pet runtime foundation.",
   "keywords": [

package/packages/pet-core/src/discovery.js

@@ -1,6 +1,6 @@
 import { readdir as fsReaddir, readFile as fsReadFile, stat as fsStat } from "node:fs/promises";
-import { join } from "node:path";
-import { pathToFileURL } from "node:url";
+import { dirname, join } from "node:path";
+import { fileURLToPath, pathToFileURL } from "node:url";
 import { parsePetManifest } from "./manifest.js";
 
 // Scans pet search paths for Codex-compatible pets. Each pet is a directory
@@ -28,6 +28,33 @@ export async function discoverPets(searchPaths = [], deps = {}) {
   return pets;
 }
 
+// discoverPets only scans the user's pet folders (~/.codex/pets, ~/.haya-pet/pets),
+// so a fresh install with no pets renders the dev placeholder instead of a real
+// character. The package ships a ready-to-use pet; this composes it in as a
+// last resort — appended after the user's pets so a real install still wins for
+// the default selection, and deduped by id so a user who copied it in isn't
+// shown two. The bundled directory is injectable so this stays testable.
+export async function discoverPetsWithFallback(searchPaths = [], deps = {}) {
+  const pets = await discoverPets(searchPaths, deps);
+  const fallbackDir = deps.fallbackPetDir ?? getBundledFallbackPetDir();
+  const fallback = await loadPetFromDir(fallbackDir, deps);
+
+  if (!fallback || pets.some((pet) => pet.manifest.id === fallback.manifest.id)) {
+    return pets;
+  }
+
+  return [...pets, fallback];
+}
+
+// Absolute path to the bundled fallback pet, resolved relative to this module so
+// it works the same for global installs, npm link, and source checkouts. The
+// asset lives at the package root (assets/fallback-pet); this file sits three
+// levels below it (packages/pet-core/src).
+export function getBundledFallbackPetDir() {
+  const here = dirname(fileURLToPath(import.meta.url));
+  return join(here, "..", "..", "..", "assets", "fallback-pet");
+}
+
 export async function loadPetFromDir(petDir, deps = {}) {
   const { readFile, stat } = resolveFs(deps);
   const manifestPath = join(petDir, "pet.json");

package/packages/pet-core/test/discovery.test.mjs

@@ -1,7 +1,12 @@
 import assert from "node:assert/strict";
 import { join } from "node:path";
 import { test } from "../../../test/harness.mjs";
-import { discoverPets, loadPetFromDir } from "../src/discovery.js";
+import {
+  discoverPets,
+  discoverPetsWithFallback,
+  getBundledFallbackPetDir,
+  loadPetFromDir
+} from "../src/discovery.js";
 
 function manifest(id, name) {
   return JSON.stringify({ id, name, spritesheet: "spritesheet.webp" });
@@ -91,3 +96,60 @@ test("returns undefined for an invalid manifest", async () => {
 test("tolerates missing search directories", async () => {
   assert.deepEqual(await discoverPets([join("does-not-exist")], fakeFs()), []);
 });
+
+test("falls back to the bundled pet when the user has no pets", async () => {
+  const fallbackDir = join("bundled", "fallback-pet");
+  const fs = fakeFs({
+    files: {
+      [join(fallbackDir, "pet.json")]: manifest("fallback-pet", "Fallback"),
+      [join(fallbackDir, "spritesheet.webp")]: "x"
+    }
+  });
+
+  const pets = await discoverPetsWithFallback([join("empty")], { ...fs, fallbackPetDir: fallbackDir });
+  assert.equal(pets.length, 1);
+  assert.equal(pets[0].manifest.id, "fallback-pet");
+});
+
+test("appends the bundled pet after the user's own pets", async () => {
+  const root = join("petsdir");
+  const fallbackDir = join("bundled", "fallback-pet");
+  const fs = fakeFs({
+    dirs: { [root]: ["cat"] },
+    files: {
+      [join(root, "cat", "pet.json")]: manifest("cat", "Cat"),
+      [join(root, "cat", "spritesheet.webp")]: "x",
+      [join(fallbackDir, "pet.json")]: manifest("fallback-pet", "Fallback"),
+      [join(fallbackDir, "spritesheet.webp")]: "x"
+    }
+  });
+
+  const pets = await discoverPetsWithFallback([root], { ...fs, fallbackPetDir: fallbackDir });
+  assert.deepEqual(pets.map((pet) => pet.manifest.id), ["cat", "fallback-pet"]);
+});
+
+test("does not duplicate the bundled pet when the user already installed it", async () => {
+  const root = join("petsdir");
+  const fallbackDir = join("bundled", "fallback-pet");
+  const fs = fakeFs({
+    dirs: { [root]: ["fallback-pet"] },
+    files: {
+      [join(root, "fallback-pet", "pet.json")]: manifest("fallback-pet", "User Copy"),
+      [join(root, "fallback-pet", "spritesheet.webp")]: "x",
+      [join(fallbackDir, "pet.json")]: manifest("fallback-pet", "Bundled"),
+      [join(fallbackDir, "spritesheet.webp")]: "x"
+    }
+  });
+
+  const pets = await discoverPetsWithFallback([root], { ...fs, fallbackPetDir: fallbackDir });
+  assert.equal(pets.length, 1);
+  assert.equal(pets[0].manifest.name, "User Copy");
+});
+
+// Guards both the package-relative path resolution and that the asset actually
+// ships: if either breaks, a fresh install renders the dev placeholder again.
+test("ships a bundled fallback pet that loads from disk", async () => {
+  const pet = await loadPetFromDir(getBundledFallbackPetDir());
+  assert.ok(pet, "bundled fallback pet should load from the shipped package");
+  assert.equal(pet.manifest.id, "fallback-pet");
+});