@factory/droid-sdk 0.6.0 → 0.8.0

package/examples/spec-mode-new-session.ts

@@ -1,61 +0,0 @@
-/**
- * Spec mode: approve and hand off implementation to a new session.
- *
- * Usage:
- *   npx tsx examples/spec-mode-new-session.ts
- */
-
-import { mkdtemp, readFile, rm } from 'node:fs/promises';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-
-import {
-  DroidInteractionMode,
-  ReasoningEffort,
-  ToolConfirmationOutcome,
-  ToolConfirmationType,
-  createSession,
-} from '@factory/droid-sdk';
-
-const tempDir = await mkdtemp(join(tmpdir(), 'droid-sdk-spec-'));
-const outputPath = join(tempDir, 'hello.txt');
-
-try {
-  const session = await createSession({
-    apiKey: process.env.FACTORY_API_KEY!,
-    cwd: process.cwd(),
-    interactionMode: DroidInteractionMode.Spec,
-    specModeReasoningEffort: ReasoningEffort.High,
-    permissionHandler(params) {
-      const canExitSpec = params.toolUses.some(
-        (item) => item.details.type === ToolConfirmationType.ExitSpecMode
-      );
-      const onlyCreatesFile = params.toolUses.every(
-        (item) =>
-          item.details.type === ToolConfirmationType.Create &&
-          item.details.filePath === outputPath
-      );
-
-      if (canExitSpec) {
-        return ToolConfirmationOutcome.ProceedNewSessionHigh;
-      }
-      return onlyCreatesFile
-        ? ToolConfirmationOutcome.ProceedOnce
-        : ToolConfirmationOutcome.Cancel;
-    },
-  });
-
-  try {
-    for await (const _msg of session.stream(
-      `Plan then create ${outputPath} containing "Hello from Droid".`
-    )) {
-      // Consume the stream until the handoff implementation finishes.
-    }
-  } finally {
-    await session.close();
-  }
-
-  console.log(await readFile(outputPath, 'utf8'));
-} finally {
-  await rm(tempDir, { recursive: true, force: true });
-}

package/examples/spec-mode-same-session.ts

@@ -1,72 +0,0 @@
-/**
- * Spec mode: approve and implement in the same session.
- *
- * Usage:
- *   npx tsx examples/spec-mode-same-session.ts
- */
-
-import { mkdtemp, readFile, rm } from 'node:fs/promises';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-
-import {
-  DroidInteractionMode,
-  ReasoningEffort,
-  ToolConfirmationOutcome,
-  ToolConfirmationType,
-  createSession,
-} from '@factory/droid-sdk';
-
-const tempDir = await mkdtemp(join(tmpdir(), 'droid-sdk-spec-'));
-const outputPath = join(tempDir, 'hello.txt');
-
-try {
-  const session = await createSession({
-    apiKey: process.env.FACTORY_API_KEY!,
-    cwd: process.cwd(),
-    interactionMode: DroidInteractionMode.Spec,
-    specModeReasoningEffort: ReasoningEffort.High,
-    permissionHandler(params) {
-      const canExitSpec = params.toolUses.some(
-        (item) => item.details.type === ToolConfirmationType.ExitSpecMode
-      );
-      const onlyCreatesFile = params.toolUses.every(
-        (item) =>
-          item.details.type === ToolConfirmationType.Create &&
-          item.details.filePath === outputPath
-      );
-      const onlyEditsTempFile = params.toolUses.every(
-        (item) =>
-          item.details.type === ToolConfirmationType.ApplyPatch &&
-          item.details.filePath === outputPath
-      );
-      const onlyRunsTempCommand = params.toolUses.every(
-        (item) =>
-          item.details.type === ToolConfirmationType.Execute &&
-          item.details.fullCommand.includes(outputPath) &&
-          item.details.fullCommand.includes(tempDir)
-      );
-
-      return canExitSpec ||
-        onlyCreatesFile ||
-        onlyEditsTempFile ||
-        onlyRunsTempCommand
-        ? ToolConfirmationOutcome.ProceedOnce
-        : ToolConfirmationOutcome.Cancel;
-    },
-  });
-
-  try {
-    for await (const _msg of session.stream(
-      `Plan then create ${outputPath} containing "Hello from Droid".`
-    )) {
-      // Consume the stream until implementation finishes.
-    }
-  } finally {
-    await session.close();
-  }
-
-  console.log(await readFile(outputPath, 'utf8'));
-} finally {
-  await rm(tempDir, { recursive: true, force: true });
-}

package/examples/structured-output.ts

@@ -1,60 +0,0 @@
-/**
- * Structured output example.
- *
- * Runs a prompt with the actual Droid CLI and requests a JSON object
- * matching the provided schema.
- *
- * Usage:
- *   npx tsx examples/structured-output.ts
- *   npx tsx examples/structured-output.ts "Pick a favorite number between 1 and 42"
- */
-
-import assert from 'node:assert/strict';
-
-import { OutputFormatType, run } from '@factory/droid-sdk';
-
-type FavoriteNumber = { favoriteNumber: number };
-
-async function main(): Promise<void> {
-  const prompt =
-    process.argv.slice(2).join(' ') ||
-    'Pick a favorite number between 1 and 42.';
-
-  const outputFormat = {
-    type: OutputFormatType.JsonSchema,
-    schema: {
-      type: 'object',
-      properties: {
-        favoriteNumber: {
-          type: 'number',
-          minimum: 1,
-          maximum: 42,
-        },
-      },
-      required: ['favoriteNumber'],
-    },
-  };
-
-  console.log(`Sending prompt: "${prompt}"\n`);
-
-  const result = await run(prompt, {
-    apiKey: process.env.FACTORY_API_KEY!,
-    cwd: process.cwd(),
-    outputFormat,
-  });
-
-  const structuredOutput = result.structuredOutput as FavoriteNumber | null;
-
-  assert.ok(structuredOutput, 'Expected structuredOutput to be set');
-  assert.equal(typeof structuredOutput.favoriteNumber, 'number');
-
-  console.log('=== Structured output ===');
-  console.log(JSON.stringify(structuredOutput, null, 2));
-
-  console.log('\nStructured output example passed');
-}
-
-main().catch((error: unknown) => {
-  console.error('Structured output example failed:', error);
-  process.exit(1);
-});

package/examples/test-compact.ts

@@ -1,65 +0,0 @@
-/**
- * Compact session example.
- *
- * Demonstrates `session.compactSession()` to summarize and compact
- * session history. Creates a session, sends several messages to build
- * up conversation history, then compacts and verifies newSessionId
- * and removedCount.
- *
- * Usage:
- *   npx tsx examples/test-compact.ts
- */
-
-import { createSession, DroidMessageType } from '@factory/droid-sdk';
-
-async function main(): Promise<void> {
-  const session = await createSession({
-    apiKey: process.env.FACTORY_API_KEY!,
-    cwd: process.cwd(),
-  });
-  try {
-    console.log(`Session created: ${session.sessionId}\n`);
-
-    const prompts = [
-      'Say "one" and nothing else',
-      'Say "two" and nothing else',
-      'Say "three" and nothing else',
-    ];
-
-    for (let i = 0; i < prompts.length; i++) {
-      console.log(`=== Turn ${i + 1} ===`);
-      console.log(`Prompt: "${prompts[i]}"\n`);
-
-      for await (const msg of session.stream(prompts[i], {
-        includePartialMessages: true,
-      })) {
-        if (msg.type === DroidMessageType.AssistantTextDelta) {
-          process.stdout.write(msg.text);
-        }
-        if (msg.type === DroidMessageType.Result) {
-          console.log('\n');
-        }
-      }
-    }
-
-    console.log('=== Compacting session ===');
-    const compactResult = await session.compactSession({});
-    console.log(`Original session: ${session.sessionId}`);
-    console.log(`New session:      ${compactResult.newSessionId}`);
-    console.log(`Removed messages: ${compactResult.removedCount}`);
-
-    if (compactResult.newSessionId && compactResult.removedCount > 0) {
-      console.log('\nCompaction succeeded.');
-    } else {
-      console.log('\nCompaction returned unexpected results.');
-    }
-  } finally {
-    await session.close();
-    console.log('Session closed.');
-  }
-}
-
-main().catch((err: unknown) => {
-  console.error('Error:', err);
-  process.exit(1);
-});

package/examples/test-rewind.ts

@@ -1,87 +0,0 @@
-/**
- * Low-level rewind API example.
- *
- * Usage:
- *   npx tsx examples/test-rewind.ts
- */
-
-import { randomUUID } from 'node:crypto';
-
-import {
-  AutonomyLevel,
-  DroidClient,
-  DroidWorkingState,
-  ProcessTransport,
-  SessionNotificationType,
-} from '@factory/droid-sdk';
-
-function waitForTurn(client: DroidClient): Promise<void> {
-  return new Promise((resolve) => {
-    let started = false;
-    const unsubscribe = client.onNotification((notification) => {
-      const params = notification['params'];
-      if (typeof params !== 'object' || params === null) {
-        return;
-      }
-
-      const event = (params as Record<string, unknown>)['notification'];
-      if (typeof event !== 'object' || event === null) {
-        return;
-      }
-
-      if (
-        (event as Record<string, unknown>)['type'] !==
-        SessionNotificationType.DROID_WORKING_STATE_CHANGED
-      ) {
-        return;
-      }
-
-      const newState = (event as Record<string, unknown>)['newState'];
-      started ||= newState !== DroidWorkingState.Idle;
-      if (started && newState === DroidWorkingState.Idle) {
-        unsubscribe();
-        resolve();
-      }
-    });
-  });
-}
-
-const transport = new ProcessTransport({ cwd: process.cwd() });
-await transport.connect();
-
-const client = new DroidClient({ transport });
-
-try {
-  await client.initializeSession({
-    machineId: 'default',
-    cwd: process.cwd(),
-    autonomyLevel: AutonomyLevel.High,
-  });
-
-  const messageId = randomUUID();
-  const done = waitForTurn(client);
-  await client.addUserMessage({
-    messageId,
-    text: 'Say "hello" and nothing else.',
-  });
-  await done;
-
-  try {
-    const rewindInfo = await client.getRewindInfo({ messageId });
-    console.log(
-      `Files available to restore: ${rewindInfo.availableFiles.length}`
-    );
-
-    const rewind = await client.executeRewind({
-      messageId,
-      filesToRestore: [],
-      filesToDelete: [],
-      forkTitle: 'Rewind example',
-    });
-    console.log(`Rewound into session: ${rewind.newSessionId}`);
-  } catch (error) {
-    console.log(`Rewind unavailable: ${String(error)}`);
-  }
-} finally {
-  await client.close();
-}

package/examples/tool-controls.ts

@@ -1,37 +0,0 @@
-/**
- * Tool controls example.
- *
- * Usage:
- *   npx tsx examples/tool-controls.ts
- */
-
-import { createSession } from '@factory/droid-sdk';
-
-const session = await createSession({
-  apiKey: process.env.FACTORY_API_KEY!,
-  cwd: process.cwd(),
-  enabledToolIds: ['Read', 'Grep'],
-  disabledToolIds: ['Execute'],
-});
-
-try {
-  const before = await session.listTools();
-  console.log(
-    before.tools
-      .filter((tool) => ['Read', 'Execute'].includes(tool.llmId))
-      .map((tool) => `${tool.llmId}: ${String(tool.currentlyAllowed)}`)
-      .join('\n')
-  );
-
-  await session.updateSettings({ disabledToolIds: ['Read', 'Execute'] });
-
-  const after = await session.listTools();
-  console.log(
-    after.tools
-      .filter((tool) => ['Read', 'Execute'].includes(tool.llmId))
-      .map((tool) => `${tool.llmId}: ${String(tool.currentlyAllowed)}`)
-      .join('\n')
-  );
-} finally {
-  await session.close();
-}