@vellumai/assistant 0.4.17 → 0.4.18

package/src/__tests__/onboarding-starter-tasks.test.ts

@@ -1,35 +1,37 @@
-import { existsSync,mkdirSync, rmSync, writeFileSync } from 'node:fs';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
+import { existsSync, mkdirSync, rmSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import { afterEach, beforeEach, describe, expect, test } from "bun:test";
 
-import { afterEach,beforeEach, describe, expect, test } from 'bun:test';
+const TEST_DIR = join(
+  tmpdir(),
+  `vellum-starter-tasks-test-${crypto.randomUUID()}`,
+);
 
-const TEST_DIR = join(tmpdir(), `vellum-starter-tasks-test-${crypto.randomUUID()}`);
+import { mock } from "bun:test";
 
-import { mock } from 'bun:test';
-
-mock.module('../util/platform.js', () => ({
+mock.module("../util/platform.js", () => ({
   getRootDir: () => TEST_DIR,
   getDataDir: () => TEST_DIR,
   getWorkspaceDir: () => TEST_DIR,
-  getWorkspaceConfigPath: () => join(TEST_DIR, 'config.json'),
-  getWorkspaceSkillsDir: () => join(TEST_DIR, 'skills'),
-  getWorkspaceHooksDir: () => join(TEST_DIR, 'hooks'),
+  getWorkspaceConfigPath: () => join(TEST_DIR, "config.json"),
+  getWorkspaceSkillsDir: () => join(TEST_DIR, "skills"),
+  getWorkspaceHooksDir: () => join(TEST_DIR, "hooks"),
   getWorkspacePromptPath: (file: string) => join(TEST_DIR, file),
   ensureDataDir: () => {},
-  getSocketPath: () => join(TEST_DIR, 'vellum.sock'),
-  getPidPath: () => join(TEST_DIR, 'vellum.pid'),
-  getDbPath: () => join(TEST_DIR, 'data', 'assistant.db'),
-  getLogPath: () => join(TEST_DIR, 'logs', 'vellum.log'),
-  getHistoryPath: () => join(TEST_DIR, 'history'),
-  getHooksDir: () => join(TEST_DIR, 'hooks'),
-  getIpcBlobDir: () => join(TEST_DIR, 'ipc-blobs'),
-  getSandboxRootDir: () => join(TEST_DIR, 'sandbox'),
+  getSocketPath: () => join(TEST_DIR, "vellum.sock"),
+  getPidPath: () => join(TEST_DIR, "vellum.pid"),
+  getDbPath: () => join(TEST_DIR, "data", "assistant.db"),
+  getLogPath: () => join(TEST_DIR, "logs", "vellum.log"),
+  getHistoryPath: () => join(TEST_DIR, "history"),
+  getHooksDir: () => join(TEST_DIR, "hooks"),
+  getIpcBlobDir: () => join(TEST_DIR, "ipc-blobs"),
+  getSandboxRootDir: () => join(TEST_DIR, "sandbox"),
   getSandboxWorkingDir: () => TEST_DIR,
-  getInterfacesDir: () => join(TEST_DIR, 'interfaces'),
-  isMacOS: () => process.platform === 'darwin',
-  isLinux: () => process.platform === 'linux',
-  isWindows: () => process.platform === 'win32',
+  getInterfacesDir: () => join(TEST_DIR, "interfaces"),
+  isMacOS: () => process.platform === "darwin",
+  isLinux: () => process.platform === "linux",
+  isWindows: () => process.platform === "win32",
   getPlatformName: () => process.platform,
   getClipboardCommand: () => null,
   removeSocketFile: () => {},
@@ -38,95 +40,97 @@ mock.module('../util/platform.js', () => ({
   migrateToDataLayout: () => {},
 }));
 
-mock.module('../util/logger.js', () => ({
-  getLogger: () => new Proxy({} as Record<string, unknown>, {
-    get: () => () => {},
-  }),
+mock.module("../util/logger.js", () => ({
+  getLogger: () =>
+    new Proxy({} as Record<string, unknown>, {
+      get: () => () => {},
+    }),
   isDebug: () => false,
   truncateForLog: (v: string) => v,
 }));
 
-const { buildStarterTaskPlaybookSection, buildSystemPrompt } = await import('../config/system-prompt.js');
+const { buildStarterTaskPlaybookSection, buildSystemPrompt } =
+  await import("../config/system-prompt.js");
 
-describe('buildStarterTaskPlaybookSection', () => {
-  test('returns a string with the section heading', () => {
+describe("buildStarterTaskPlaybookSection", () => {
+  test("returns a string with the section heading", () => {
     const section = buildStarterTaskPlaybookSection();
-    expect(section).toContain('## Starter Task Playbooks');
+    expect(section).toContain("## Starter Task Playbooks");
   });
 
-  test('documents all three kickoff intents', () => {
+  test("documents all three kickoff intents", () => {
     const section = buildStarterTaskPlaybookSection();
-    expect(section).toContain('[STARTER_TASK:make_it_yours]');
-    expect(section).toContain('[STARTER_TASK:research_topic]');
-    expect(section).toContain('[STARTER_TASK:research_to_ui]');
+    expect(section).toContain("[STARTER_TASK:make_it_yours]");
+    expect(section).toContain("[STARTER_TASK:research_topic]");
+    expect(section).toContain("[STARTER_TASK:research_to_ui]");
   });
 
-  test('includes the make_it_yours playbook', () => {
+  test("includes the make_it_yours playbook", () => {
     const section = buildStarterTaskPlaybookSection();
-    expect(section).toContain('### Playbook: make_it_yours');
-    expect(section).toContain('accent color');
-    expect(section).toContain('Dashboard Color Preference');
-    expect(section).toContain('user_selected');
+    expect(section).toContain("### Playbook: make_it_yours");
+    expect(section).toContain("accent color");
+    expect(section).toContain("Dashboard Color Preference");
+    expect(section).toContain("user_selected");
   });
 
-  test('make_it_yours uses app_file_edit instead of invalid ui_show config_update', () => {
+  test("make_it_yours uses app_file_edit instead of invalid ui_show config_update", () => {
     const section = buildStarterTaskPlaybookSection();
-    expect(section).toContain('app_file_edit');
-    expect(section).not.toContain('config_update');
+    expect(section).toContain("app_file_edit");
+    expect(section).not.toContain("config_update");
     expect(section).not.toContain('surface_type: "config_update"');
   });
 
-  test('includes the research_topic playbook', () => {
+  test("includes the research_topic playbook", () => {
     const section = buildStarterTaskPlaybookSection();
-    expect(section).toContain('### Playbook: research_topic');
-    expect(section).toContain('web search');
+    expect(section).toContain("### Playbook: research_topic");
+    expect(section).toContain("web search");
   });
 
-  test('includes the research_to_ui playbook', () => {
+  test("includes the research_to_ui playbook", () => {
     const section = buildStarterTaskPlaybookSection();
-    expect(section).toContain('### Playbook: research_to_ui');
-    expect(section).toContain('app_create');
+    expect(section).toContain("### Playbook: research_to_ui");
+    expect(section).toContain("app_create");
   });
 
-  test('includes general rules section', () => {
+  test("includes general rules section", () => {
     const section = buildStarterTaskPlaybookSection();
-    expect(section).toContain('### General rules for all starter tasks');
+    expect(section).toContain("### General rules for all starter tasks");
   });
 
-  test('enforces trust gating in general rules', () => {
+  test("enforces trust gating in general rules", () => {
     const section = buildStarterTaskPlaybookSection();
-    expect(section).toContain('trust gating');
-    expect(section).toContain('do NOT ask for elevated permissions');
+    expect(section).toContain("trust gating");
+    expect(section).toContain("do NOT ask for elevated permissions");
   });
 
-  test('references USER.md onboarding tasks for status tracking', () => {
+  test("references USER.md onboarding tasks for status tracking", () => {
     const section = buildStarterTaskPlaybookSection();
-    expect(section).toContain('## Onboarding Tasks');
-    expect(section).toContain('in_progress');
-    expect(section).toContain('done');
-    expect(section).toContain('deferred_to_dashboard');
+    expect(section).toContain("## Onboarding Tasks");
+    expect(section).toContain("in_progress");
+    expect(section).toContain("done");
+    expect(section).toContain("deferred_to_dashboard");
   });
 
-  test('make_it_yours playbook handles locale confirmation', () => {
+  test("make_it_yours playbook handles locale confirmation", () => {
     const section = buildStarterTaskPlaybookSection();
-    expect(section).toContain('locale');
-    expect(section).toContain('confidence: low');
+    expect(section).toContain("locale");
+    expect(section).toContain("confidence: low");
   });
 
-  test('make_it_yours playbook includes confirmation step', () => {
+  test("make_it_yours playbook includes confirmation step", () => {
     const section = buildStarterTaskPlaybookSection();
-    expect(section).toContain('Confirm the selection');
-    expect(section).toContain('Sound good?');
+    expect(section).toContain("Confirm the selection");
+    expect(section).toContain("Sound good?");
   });
 
-  test('research_to_ui playbook references dynamic UI quality standards', () => {
+  test("research_to_ui playbook references dynamic UI quality standards", () => {
     const section = buildStarterTaskPlaybookSection();
-    expect(section).toContain('Dynamic UI quality standards');
-    expect(section).toContain('anti-AI-slop');
+    expect(section).toContain("Dynamic UI quality standards");
+    expect(section).toContain("anti-AI-slop");
   });
 });
 
-describe('starter task playbook integration with buildSystemPrompt', () => {
+describe("starter task playbook integration with buildSystemPrompt", () => {
   beforeEach(() => {
     mkdirSync(TEST_DIR, { recursive: true });
   });
@@ -137,41 +141,41 @@ describe('starter task playbook integration with buildSystemPrompt', () => {
     }
   });
 
-  test('buildSystemPrompt includes the starter task playbook section when BOOTSTRAP.md exists', () => {
-    writeFileSync(join(TEST_DIR, 'IDENTITY.md'), 'I am Vellum.');
-    writeFileSync(join(TEST_DIR, 'BOOTSTRAP.md'), '# First run');
+  test("buildSystemPrompt includes the starter task playbook section when BOOTSTRAP.md exists", () => {
+    writeFileSync(join(TEST_DIR, "IDENTITY.md"), "I am Vellum.");
+    writeFileSync(join(TEST_DIR, "BOOTSTRAP.md"), "# First run");
     const result = buildSystemPrompt();
-    expect(result).toContain('## Starter Task Playbooks');
+    expect(result).toContain("## Starter Task Playbooks");
   });
 
-  test('buildSystemPrompt omits starter task playbooks after onboarding is complete', () => {
-    writeFileSync(join(TEST_DIR, 'IDENTITY.md'), 'I am Vellum.');
+  test("buildSystemPrompt omits starter task playbooks after onboarding is complete", () => {
+    writeFileSync(join(TEST_DIR, "IDENTITY.md"), "I am Vellum.");
     // No BOOTSTRAP.md → onboarding complete
     const result = buildSystemPrompt();
-    expect(result).not.toContain('## Starter Task Playbooks');
+    expect(result).not.toContain("## Starter Task Playbooks");
   });
 
-  test('starter task playbook and channel awareness both present during onboarding', () => {
-    writeFileSync(join(TEST_DIR, 'IDENTITY.md'), 'I am Vellum.');
-    writeFileSync(join(TEST_DIR, 'BOOTSTRAP.md'), '# First run');
+  test("starter task playbook and channel awareness both present during onboarding", () => {
+    writeFileSync(join(TEST_DIR, "IDENTITY.md"), "I am Vellum.");
+    writeFileSync(join(TEST_DIR, "BOOTSTRAP.md"), "# First run");
     const result = buildSystemPrompt();
-    const starterIdx = result.indexOf('## Starter Task Playbooks');
-    const channelIdx = result.indexOf('## Channel Awareness & Trust Gating');
+    const starterIdx = result.indexOf("## Starter Task Playbooks");
+    const channelIdx = result.indexOf("## Channel Awareness & Trust Gating");
     expect(starterIdx).toBeGreaterThan(-1);
     expect(channelIdx).toBeGreaterThan(-1);
   });
 
-  test('all three kickoff intents present in full system prompt during onboarding', () => {
-    writeFileSync(join(TEST_DIR, 'IDENTITY.md'), 'I am Vellum.');
-    writeFileSync(join(TEST_DIR, 'BOOTSTRAP.md'), '# First run');
+  test("all three kickoff intents present in full system prompt during onboarding", () => {
+    writeFileSync(join(TEST_DIR, "IDENTITY.md"), "I am Vellum.");
+    writeFileSync(join(TEST_DIR, "BOOTSTRAP.md"), "# First run");
     const result = buildSystemPrompt();
-    expect(result).toContain('[STARTER_TASK:make_it_yours]');
-    expect(result).toContain('[STARTER_TASK:research_topic]');
-    expect(result).toContain('[STARTER_TASK:research_to_ui]');
+    expect(result).toContain("[STARTER_TASK:make_it_yours]");
+    expect(result).toContain("[STARTER_TASK:research_topic]");
+    expect(result).toContain("[STARTER_TASK:research_to_ui]");
   });
 
-  test('system prompt does not contain invalid config_update surface type (bare)', () => {
-    writeFileSync(join(TEST_DIR, 'IDENTITY.md'), 'I am Vellum.');
+  test("system prompt does not contain invalid config_update surface type (bare)", () => {
+    writeFileSync(join(TEST_DIR, "IDENTITY.md"), "I am Vellum.");
     const result = buildSystemPrompt();
     // voice_config_update is a valid tool name; only bare 'config_update' surface type is invalid
     expect(result).not.toContain('surface_type: "config_update"');

package/src/__tests__/onboarding-template-contract.test.ts

@@ -1,169 +1,168 @@
-import { readFileSync } from 'node:fs';
-import { join } from 'node:path';
-
-import { describe, expect,test } from 'bun:test';
-
-const templatesDir = join(import.meta.dirname, '..', 'config', 'templates');
-const bootstrap = readFileSync(join(templatesDir, 'BOOTSTRAP.md'), 'utf-8');
-const identity = readFileSync(join(templatesDir, 'IDENTITY.md'), 'utf-8');
-const user = readFileSync(join(templatesDir, 'USER.md'), 'utf-8');
-
-describe('onboarding template contracts', () => {
-  describe('BOOTSTRAP.md', () => {
-    test('contains identity question prompts', () => {
+import { readFileSync } from "node:fs";
+import { join } from "node:path";
+import { describe, expect, test } from "bun:test";
+
+const templatesDir = join(import.meta.dirname, "..", "config", "templates");
+const bootstrap = readFileSync(join(templatesDir, "BOOTSTRAP.md"), "utf-8");
+const identity = readFileSync(join(templatesDir, "IDENTITY.md"), "utf-8");
+const user = readFileSync(join(templatesDir, "USER.md"), "utf-8");
+
+describe("onboarding template contracts", () => {
+  describe("BOOTSTRAP.md", () => {
+    test("contains identity question prompts", () => {
       const lower = bootstrap.toLowerCase();
-      expect(lower).toContain('who am i');
+      expect(lower).toContain("who am i");
     });
 
-    test('infers personality indirectly instead of asking directly', () => {
+    test("infers personality indirectly instead of asking directly", () => {
       const lower = bootstrap.toLowerCase();
       // Personality step must instruct indirect/organic discovery
-      expect(lower).toContain('personality');
-      expect(lower).toContain('indirectly');
-      expect(lower).toContain('vibe');
+      expect(lower).toContain("personality");
+      expect(lower).toContain("indirectly");
+      expect(lower).toContain("vibe");
     });
 
-    test('contains emoji auto-selection with change-later instruction', () => {
+    test("contains emoji auto-selection with change-later instruction", () => {
       const lower = bootstrap.toLowerCase();
-      expect(lower).toContain('emoji');
-      expect(lower).toContain('change it later');
+      expect(lower).toContain("emoji");
+      expect(lower).toContain("change it later");
     });
 
-    test('creates Home Base silently in the background', () => {
+    test("creates Home Base silently in the background", () => {
       const lower = bootstrap.toLowerCase();
-      expect(lower).toContain('app_create');
-      expect(lower).toContain('set_as_home_base');
+      expect(lower).toContain("app_create");
+      expect(lower).toContain("set_as_home_base");
       // Must NOT open or announce it
-      expect(lower).toContain('do not open it with `app_open`');
-      expect(lower).toContain('do not announce it');
+      expect(lower).toContain("do not open it with `app_open`");
+      expect(lower).toContain("do not announce it");
     });
 
-    test('contains naming intent markers so the first reply includes naming cues', () => {
+    test("contains naming intent markers so the first reply includes naming cues", () => {
       const lower = bootstrap.toLowerCase();
       // The template must prompt the assistant to ask about names.
-      expect(lower).toContain('name');
+      expect(lower).toContain("name");
       // The first step should be about locking in the assistant's name
-      expect(lower).toContain('lock in your name');
+      expect(lower).toContain("lock in your name");
       // The conversation sequence must include identity/naming
-      expect(lower).toContain('who am i');
+      expect(lower).toContain("who am i");
     });
 
-    test('asks user name AFTER assistant identity is established', () => {
+    test("asks user name AFTER assistant identity is established", () => {
       // Step 1 is locking in the assistant's name, step 3 is asking the user's name
-      const assistantNameIdx = bootstrap.indexOf('Lock in your name.');
-      const userNameIdx = bootstrap.indexOf('who am I talking to?');
+      const assistantNameIdx = bootstrap.indexOf("Lock in your name.");
+      const userNameIdx = bootstrap.indexOf("who am I talking to?");
       expect(assistantNameIdx).toBeGreaterThan(-1);
       expect(userNameIdx).toBeGreaterThan(-1);
       expect(assistantNameIdx).toBeLessThan(userNameIdx);
     });
 
-    test('gathers user context: work role, hobbies, daily tools', () => {
+    test("gathers user context: work role, hobbies, daily tools", () => {
       const lower = bootstrap.toLowerCase();
-      expect(lower).toContain('work');
-      expect(lower).toContain('hobbies');
-      expect(lower).toContain('tools');
+      expect(lower).toContain("work");
+      expect(lower).toContain("hobbies");
+      expect(lower).toContain("tools");
     });
 
-    test('shows exactly 2 suggestions via ui_show card with relay_prompt actions', () => {
-      expect(bootstrap).toContain('ui_show');
-      expect(bootstrap).toContain('exactly 2');
+    test("shows exactly 2 suggestions via ui_show card with relay_prompt actions", () => {
+      expect(bootstrap).toContain("ui_show");
+      expect(bootstrap).toContain("exactly 2");
       // Must use card surface with relay_prompt action buttons
       expect(bootstrap).toContain('surface_type: "card"');
-      expect(bootstrap).toContain('relay_prompt');
+      expect(bootstrap).toContain("relay_prompt");
     });
 
-    test('contains completion gate with all required conditions', () => {
+    test("contains completion gate with all required conditions", () => {
       const lower = bootstrap.toLowerCase();
-      expect(lower).toContain('completion gate');
-      expect(lower).toContain('do not delete this file');
+      expect(lower).toContain("completion gate");
+      expect(lower).toContain("do not delete this file");
       // Assistant name is hard-required
-      expect(lower).toContain('you have a name');
-      expect(lower).toContain('hard requirement');
-      expect(lower).toContain('vibe');
+      expect(lower).toContain("you have a name");
+      expect(lower).toContain("hard requirement");
+      expect(lower).toContain("vibe");
       // User detail fields must be resolved (provided, inferred, or declined)
-      expect(lower).toContain('resolved');
-      expect(lower).toContain('work role');
-      expect(lower).toContain('2 suggestions shown');
-      expect(lower).toContain('selected one, deferred both');
-      expect(lower).toContain('home base');
+      expect(lower).toContain("resolved");
+      expect(lower).toContain("work role");
+      expect(lower).toContain("2 suggestions shown");
+      expect(lower).toContain("selected one, deferred both");
+      expect(lower).toContain("home base");
     });
 
-    test('contains privacy/refusal policy', () => {
+    test("contains privacy/refusal policy", () => {
       const lower = bootstrap.toLowerCase();
       // Must have a privacy section
-      expect(lower).toContain('privacy');
+      expect(lower).toContain("privacy");
       // Assistant name is hard-required, user details are best-effort
-      expect(lower).toContain('hard-required');
-      expect(lower).toContain('best-effort');
+      expect(lower).toContain("hard-required");
+      expect(lower).toContain("best-effort");
       // Refusal is a valid resolution
-      expect(lower).toContain('declined');
-      expect(lower).toContain('do not push');
+      expect(lower).toContain("declined");
+      expect(lower).toContain("do not push");
     });
 
-    test('defines resolved as provided, inferred, or declined', () => {
+    test("defines resolved as provided, inferred, or declined", () => {
       const lower = bootstrap.toLowerCase();
       // The template must define what "resolved" means
-      expect(lower).toContain('resolved');
-      expect(lower).toContain('inferred');
-      expect(lower).toContain('declined');
+      expect(lower).toContain("resolved");
+      expect(lower).toContain("inferred");
+      expect(lower).toContain("declined");
     });
 
-    test('preserves no em dashes instruction', () => {
+    test("preserves no em dashes instruction", () => {
       const lower = bootstrap.toLowerCase();
-      expect(lower).toContain('em dashes');
+      expect(lower).toContain("em dashes");
     });
 
-    test('preserves no technical jargon instruction', () => {
+    test("preserves no technical jargon instruction", () => {
       const lower = bootstrap.toLowerCase();
-      expect(lower).toContain('technical jargon');
-      expect(lower).toContain('system internals');
+      expect(lower).toContain("technical jargon");
+      expect(lower).toContain("system internals");
     });
 
-    test('preserves comment line format instruction', () => {
+    test("preserves comment line format instruction", () => {
       // The template must start with the comment format explanation
       expect(bootstrap).toMatch(/^_ Lines starting with _/);
     });
 
-    test('instructs saving to IDENTITY.md, USER.md, and SOUL.md via file_edit', () => {
-      expect(bootstrap).toContain('IDENTITY.md');
-      expect(bootstrap).toContain('USER.md');
-      expect(bootstrap).toContain('SOUL.md');
-      expect(bootstrap).toContain('file_edit');
+    test("instructs saving to IDENTITY.md, USER.md, and SOUL.md via file_edit", () => {
+      expect(bootstrap).toContain("IDENTITY.md");
+      expect(bootstrap).toContain("USER.md");
+      expect(bootstrap).toContain("SOUL.md");
+      expect(bootstrap).toContain("file_edit");
     });
   });
 
-  describe('IDENTITY.md', () => {
-    test('contains canonical fields: Name, Nature, Personality, Emoji', () => {
-      expect(identity).toContain('**Name:**');
-      expect(identity).toContain('**Nature:**');
-      expect(identity).toContain('**Personality:**');
-      expect(identity).toContain('**Emoji:**');
+  describe("IDENTITY.md", () => {
+    test("contains canonical fields: Name, Nature, Personality, Emoji", () => {
+      expect(identity).toContain("**Name:**");
+      expect(identity).toContain("**Nature:**");
+      expect(identity).toContain("**Personality:**");
+      expect(identity).toContain("**Emoji:**");
     });
 
-    test('contains the emoji overwrite instruction', () => {
+    test("contains the emoji overwrite instruction", () => {
       const lower = identity.toLowerCase();
-      expect(lower).toContain('change their emoji');
+      expect(lower).toContain("change their emoji");
     });
 
-    test('contains the style tendency field', () => {
-      expect(identity).toContain('**Style tendency:**');
+    test("contains the style tendency field", () => {
+      expect(identity).toContain("**Style tendency:**");
     });
   });
 
-  describe('USER.md', () => {
-    test('contains onboarding snapshot with all required fields', () => {
-      expect(user).toContain('Preferred name/reference:');
-      expect(user).toContain('Goals:');
-      expect(user).toContain('Locale:');
-      expect(user).toContain('Work role:');
-      expect(user).toContain('Hobbies/fun:');
-      expect(user).toContain('Daily tools:');
+  describe("USER.md", () => {
+    test("contains onboarding snapshot with all required fields", () => {
+      expect(user).toContain("Preferred name/reference:");
+      expect(user).toContain("Goals:");
+      expect(user).toContain("Locale:");
+      expect(user).toContain("Work role:");
+      expect(user).toContain("Hobbies/fun:");
+      expect(user).toContain("Daily tools:");
     });
 
-    test('documents resolved-field status conventions', () => {
+    test("documents resolved-field status conventions", () => {
       const lower = user.toLowerCase();
-      expect(lower).toContain('declined_by_user');
-      expect(lower).toContain('resolved');
+      expect(lower).toContain("declined_by_user");
+      expect(lower).toContain("resolved");
     });
   });
 });