@elizaos/prompts 2.0.0-beta.1 → 2.0.11-beta.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shaw Walters and elizaOS Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -4,18 +4,15 @@ Shared prompt templates and action specs for elizaOS.
 
 ## Overview
 
-This package is the single source of truth for prompt templates used by the runtime. Prompts are authored directly as TypeScript modules under `src/` and re-exported from `src/index.ts`.
+This package is the single source of truth for prompt templates used by the runtime. Prompts are authored directly in `src/index.ts`.
 
 ## Structure
 
 ```
 packages/prompts/
-├── src/              # TypeScript prompt template modules (source of truth)
-│   ├── reply.ts
-│   ├── choose_option.ts
-│   ├── image_generation.ts
-│   └── ...
-├── specs/            # Canonical merged action/provider specs (JSON) + generated plugins.generated.json
+├── src/
+│   └── index.ts      # TypeScript prompt template exports
+├── specs/            # Merged action/provider specs (JSON) + generated plugins.generated.json
 └── scripts/          # Spec + docs generators
     ├── generate-action-docs.js
     ├── generate-plugin-action-spec.js
@@ -46,8 +43,10 @@ bun run build
 
 ## Usage
 
+Runtime code imports the templates through `@elizaos/core`, which re-exports them and provides `composePrompt` to fill the `{{...}}` placeholders:
+
 ```typescript
-import { REPLY_TEMPLATE, CHOOSE_OPTION_TEMPLATE } from "@elizaos/prompts";
+import { REPLY_TEMPLATE, composePrompt } from "@elizaos/core";
 
 const prompt = composePrompt({
   state: { agentName: "Alice" },
@@ -55,10 +54,12 @@ const prompt = composePrompt({
 });
 ```
 
+Import directly from `@elizaos/prompts` only inside this package's tooling and tests.
+
 ## Adding New Prompts
 
-1. Create a new `.ts` file in `src/` exporting a `*_TEMPLATE` constant.
-2. Re-export it from `src/index.ts`.
+1. Add a `camelCaseTemplate` string export in `src/index.ts`.
+2. Add the paired `UPPER_SNAKE_CASE_TEMPLATE` export.
 
 ## Template Guidelines
 
@@ -77,7 +78,7 @@ const prompt = composePrompt({
 ### Secret scan
 
 ```bash
-npm run check:secrets
+bun run check:secrets
 ```
 
 Scans `packages/prompts/src/**/*.ts`, plugin prompt TS modules (paths matching `prompts/**/*.ts`, `workflow-prompts/**/*.ts`, etc.), and a few explicit files — see `scripts/check-secrets.js`.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elizaos/prompts",
   "private": false,
-  "version": "2.0.0-beta.1",
+  "version": "2.0.11-beta.7",
   "description": "Shared prompt templates for elizaOS across TypeScript, Python, and Rust",
   "type": "module",
   "main": "./src/index.ts",
@@ -10,6 +10,12 @@
     ".": {
       "types": "./src/index.ts",
       "import": "./src/index.ts"
+    },
+    "./*.css": "./dist/*.css",
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "import": "./dist/*.js",
+      "default": "./dist/*.js"
     }
   },
   "scripts": {
@@ -20,7 +26,9 @@
     "clean": "rm -rf dist",
     "lint": "bunx @biomejs/biome check --write .",
     "lint:check": "bunx @biomejs/biome check .",
-    "typecheck": "echo 'No TypeScript source files to check'"
+    "format:check": "bunx @biomejs/biome format .",
+    "typecheck": "echo 'No TypeScript source files to check'",
+    "test": "bun test ./test"
   },
   "files": [
     "src/",
@@ -38,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "cb192f7b21c441e9463d1af2f890c145814baad2"
+  "gitHead": "cdbc876f793d96073d7eb0d09715a031ce0cd32e"
 }

package/scripts/check-secrets.js

@@ -1,23 +1,4 @@
 #!/usr/bin/env node
-/**
- * Secret/credential scanner for prompt templates.
- *
- * This is intentionally conservative: it only fails on patterns that strongly
- * resemble real credentials (or private key material) to avoid false positives.
- *
- * Wave 1 of the prompt migration moved every prompt body from a sibling
- * `.txt` file to a TypeScript template-literal export. The scanner now walks
- * those TS prompt-source locations directly.
- *
- * Scans:
- * - packages/prompts/src/**\/*.ts
- * - packages/core/src/prompts.ts and packages/core/src/services/message.ts
- * - plugins/* TS modules whose path matches `prompts.ts`,
- *   `prompts/<name>.ts`, `workflow-prompts/<name>.ts`, or `templates.ts`
- *
- * Generated mirrors and test files are skipped.
- */
-
 import fs from "node:fs/promises";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
@@ -28,15 +9,12 @@ const __dirname = path.dirname(__filename);
 const PROMPTS_PKG_DIR = path.resolve(__dirname, "..");
 const REPO_ROOT = path.resolve(PROMPTS_PKG_DIR, "..", "..");
 
-// Roots under which to look for prompt-bearing TS files.
 const PROMPT_SCAN_TS_ROOTS = [
   "packages/prompts/src",
   "packages/core/src",
   "plugins",
 ];
 
-// Always include these high-traffic prompt modules even if they don't match
-// the heuristic file-name patterns above.
 const PROMPT_SCAN_FILES = [
   "packages/core/src/prompts.ts",
   "packages/core/src/services/message.ts",
@@ -69,7 +47,7 @@ const SKIP_DIR_NAMES = new Set([
  * @param {(absPath: string, relPath: string) => boolean} predicate
  * @returns {Promise<string[]>}
  */
-async function walkFiles(root, predicate) {
+export async function walkFiles(root, predicate) {
   /** @type {string[]} */
   const out = [];
 
@@ -102,7 +80,7 @@ async function walkFiles(root, predicate) {
 /**
  * @returns {Promise<string[]>}
  */
-async function listPromptTsFiles() {
+export async function listPromptTsFiles() {
   /** @type {Set<string>} */
   const set = new Set();
   for (const file of PROMPT_SCAN_FILES) {
@@ -126,7 +104,7 @@ async function listPromptTsFiles() {
  * @param {string} content
  * @returns {{errors: string[], warnings: string[]}}
  */
-function scanContent(filePath, content) {
+export function scanContent(filePath, content) {
   /** @type {string[]} */
   const errors = [];
   /** @type {string[]} */
@@ -181,13 +159,21 @@ function scanContent(filePath, content) {
 
   for (let i = 0; i < lines.length; i++) {
     const line = lines[i];
+    let hasError = false;
+    /** @type {string[]} */
+    const lineWarnings = [];
     for (const rule of rules) {
       if (rule.re.test(line)) {
         const msg = `${filePath}:${i + 1}  ${rule.name}: ${line.trim()}`;
-        if (rule.severity === "error") errors.push(msg);
-        else warnings.push(msg);
+        if (rule.severity === "error") {
+          errors.push(msg);
+          hasError = true;
+        } else {
+          lineWarnings.push(msg);
+        }
       }
     }
+    if (!hasError) warnings.push(...lineWarnings);
   }
 
   return { errors, warnings };
@@ -229,7 +215,9 @@ async function main() {
   }
 }
 
-main().catch((err) => {
-  console.error(err);
-  process.exit(2);
-});
+if (process.argv[1] && path.resolve(process.argv[1]) === __filename) {
+  main().catch((err) => {
+    console.error(err);
+    process.exit(2);
+  });
+}

package/scripts/file-utils.js

@@ -0,0 +1,13 @@
+import fs from "node:fs";
+
+export function readText(filePath) {
+  return fs.readFileSync(filePath, "utf-8");
+}
+
+export function readJson(filePath) {
+  return JSON.parse(readText(filePath));
+}
+
+export function ensureDirectory(dir) {
+  fs.mkdirSync(dir, { recursive: true });
+}

package/scripts/generate-action-docs.js

@@ -1,17 +1,9 @@
 #!/usr/bin/env node
-/**
- * Action/Provider Docs Generator
- *
- * Reads canonical specs from packages/prompts/specs/** and generates
- * TypeScript docs modules under packages/core/src/generated.
- *
- * This is intentionally dependency-free (no zod/yup) to keep builds lightweight.
- */
-
 import { execFileSync } from "node:child_process";
 import fs from "node:fs";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
+import { ensureDirectory, readJson } from "./file-utils.js";
 import { compressPromptDescription } from "./prompt-compression.js";
 
 const __filename = fileURLToPath(import.meta.url);
@@ -238,15 +230,6 @@ function assertProviderDoc(provider, name) {
   }
 }
 
-/**
- * @param {string} filePath
- * @returns {unknown}
- */
-function readJson(filePath) {
-  const raw = fs.readFileSync(filePath, "utf-8");
-  return JSON.parse(raw);
-}
-
 /**
  * Recursively list .json files in a directory.
  * @param {string} rootDir
@@ -335,10 +318,7 @@ function assertUniqueNames(docs, label) {
  */
 function loadSpecs(dir, corePath, kind) {
   if (!fs.existsSync(corePath)) {
-    return {
-      core: { version: "1.0.0", items: [] },
-      all: { version: "1.0.0", items: [] },
-    };
+    throw new Error(`Missing ${kind} core spec: ${corePath}`);
   }
 
   const coreRoot = readJson(corePath);
@@ -388,26 +368,14 @@ function loadSpecs(dir, corePath, kind) {
   };
 }
 
-/**
- * Ensures a directory exists, creating it and parent directories if necessary.
- * @param {string} dir - The directory path to ensure exists
- * @throws {Error} If the directory path is empty or whitespace-only
- */
-function ensureDir(dir) {
-  if (!dir || dir.trim() === "") {
-    throw new Error("Directory path cannot be empty");
-  }
-  fs.mkdirSync(dir, { recursive: true });
-}
-
 /**
  * @param {Record<string, unknown>} doc
  * @returns {string | undefined}
  */
 function getCompressedAlias(doc) {
-  const canonical = doc.descriptionCompressed;
-  if (typeof canonical === "string" && canonical.trim()) {
-    return canonical;
+  const preferred = doc.descriptionCompressed;
+  if (typeof preferred === "string" && preferred.trim()) {
+    return preferred;
   }
   const alias = doc.compressedDescription;
   if (typeof alias === "string" && alias.trim()) {
@@ -475,7 +443,7 @@ function normalizeSpecsInPlace(actionsSpec, providersSpec) {
 
 function generateTypeScript(actionsSpec, providersSpec) {
   const outDir = path.join(REPO_ROOT, "packages", "core", "src", "generated");
-  ensureDir(outDir);
+  ensureDirectory(outDir);
 
   const actionsJson = JSON.stringify(
     { version: actionsSpec.core.version, actions: actionsSpec.core.items },
@@ -502,7 +470,7 @@ function generateTypeScript(actionsSpec, providersSpec) {
   );
 
   const content = `/**
- * Auto-generated canonical action/provider docs.
+ * Auto-generated action/provider docs.
  * DO NOT EDIT - Generated from packages/prompts/specs/**.
  */
 
@@ -596,8 +564,8 @@ export const allProviderDocs: readonly ProviderDoc[] = allProvidersSpec.provider
       ["@biomejs/biome", "check", "--write", actionDocsPath],
       { cwd: REPO_ROOT, stdio: "pipe" },
     );
-  } catch {
-    // Biome may be unavailable in stripped-down environments.
+  } catch (error) {
+    throw new Error(`Failed to format ${actionDocsPath}`, { cause: error });
   }
 }