@promptbook/types 0.114.0-41 → 0.114.0-47

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (99) hide show
  1. package/esm/src/book-2.0/agent-source/CreateAgentModelRequirementsOptions.d.ts +2 -0
  2. package/esm/src/cli/cli-commands/coder/add.d.ts +16 -0
  3. package/esm/src/cli/cli-commands/coder/agentCliOptions.d.ts +3 -2
  4. package/esm/src/cli/cli-commands/coder/augmentCoderAgentTeam.d.ts +7 -0
  5. package/esm/src/cli/cli-commands/coder/coderAgentRole.d.ts +16 -0
  6. package/esm/src/cli/cli-commands/coder/coderReferencedArtifacts.d.ts +8 -7
  7. package/esm/src/cli/cli-commands/coder/ensureCoderDefaultAgentFiles.d.ts +8 -0
  8. package/esm/src/cli/cli-commands/coder/ensureCoderDefaultAgentFiles.test.d.ts +1 -0
  9. package/esm/src/cli/cli-commands/coder/ensureCoderRoleAgentFile.d.ts +12 -0
  10. package/esm/src/cli/cli-commands/coder/generate-boilerplates.d.ts +1 -1
  11. package/esm/src/cli/cli-commands/coder/getCoderInitializationCommitPaths.d.ts +9 -0
  12. package/esm/src/cli/cli-commands/coder/initializeCoderProjectConfiguration.d.ts +7 -5
  13. package/esm/src/cli/cli-commands/coder/plan.d.ts +7 -0
  14. package/esm/src/cli/cli-commands/coder/planning/assertPlanningCommitSafe.d.ts +6 -0
  15. package/esm/src/cli/cli-commands/coder/planning/assertPlanningPrdCommitScope.d.ts +7 -0
  16. package/esm/src/cli/cli-commands/coder/planning/assertPlanningRuntimePath.d.ts +6 -0
  17. package/esm/src/cli/cli-commands/coder/planning/createPlanningTerminal.d.ts +8 -0
  18. package/esm/src/cli/cli-commands/coder/planning/createPlanningTerminal.test.d.ts +1 -0
  19. package/esm/src/cli/cli-commands/coder/planning/createPlanningWorkspace.d.ts +11 -0
  20. package/esm/src/cli/cli-commands/coder/planning/discussPlanningTurn.d.ts +15 -0
  21. package/esm/src/cli/cli-commands/coder/planning/fixtures/snapshotPlanningProject.d.ts +5 -0
  22. package/esm/src/cli/cli-commands/coder/planning/planningGitSync.test.d.ts +1 -0
  23. package/esm/src/cli/cli-commands/coder/planning/planningPackagedCli.test.d.ts +1 -0
  24. package/esm/src/cli/cli-commands/coder/planning/planningProtocol.d.ts +152 -0
  25. package/esm/src/cli/cli-commands/coder/planning/planningTeam.test.d.ts +1 -0
  26. package/esm/src/cli/cli-commands/coder/planning/preparePlanningChanges.d.ts +16 -0
  27. package/esm/src/cli/cli-commands/coder/planning/readPlanningContext.d.ts +6 -0
  28. package/esm/src/cli/cli-commands/coder/planning/resolvePlanningPath.d.ts +7 -0
  29. package/esm/src/cli/cli-commands/coder/planning/runPlanningHarness.d.ts +30 -0
  30. package/esm/src/cli/cli-commands/coder/planning/runPlanningHarness.test.d.ts +1 -0
  31. package/esm/src/cli/cli-commands/coder/planning/runPlanningSession.d.ts +21 -0
  32. package/esm/src/cli/cli-commands/coder/planning/runPlanningSession.test.d.ts +1 -0
  33. package/esm/src/cli/cli-commands/coder/planning/savePlanningChanges.d.ts +7 -0
  34. package/esm/src/cli/cli-commands/coder/printInitializationSummary.d.ts +2 -1
  35. package/esm/src/cli/cli-commands/coder/promptsReadmeTemplate.d.ts +13 -0
  36. package/esm/src/cli/cli-commands/coder/promptsReadmeTemplate.test.d.ts +1 -0
  37. package/esm/src/cli/cli-commands/coder/readCoderAgentBook.d.ts +8 -0
  38. package/esm/src/cli/cli-commands/coder/workspacePreflight.test.d.ts +1 -0
  39. package/esm/src/cli/cli-commands/coder.d.ts +1 -0
  40. package/esm/src/cli/cli-commands/common/LocalAgentBookCollection.d.ts +4 -2
  41. package/esm/src/cli/cli-commands/common/coderGitSyncCliOptions.d.ts +1 -1
  42. package/esm/src/cli/cli-commands/common/resolveLocalAgentSource.d.ts +8 -1
  43. package/esm/src/cli/cli-commands/common/validateCoderRunOptions.d.ts +6 -0
  44. package/esm/src/cli/cli-commands/common/workspaceRepository.d.ts +36 -0
  45. package/esm/src/cli/cli-commands/common/workspaceRepository.test.d.ts +1 -0
  46. package/esm/src/cli/cli-commands/common/workspaceRepositoryCliOptions.d.ts +11 -0
  47. package/esm/src/commitments/TEAM/TEAM.test.d.ts +1 -0
  48. package/esm/src/conversion/archive/loadJsZipModule.d.ts +10 -0
  49. package/esm/src/version.d.ts +1 -1
  50. package/package.json +2 -2
  51. package/umd/src/book-2.0/agent-source/CreateAgentModelRequirementsOptions.d.ts +2 -0
  52. package/umd/src/cli/cli-commands/coder/add.d.ts +16 -0
  53. package/umd/src/cli/cli-commands/coder/agentCliOptions.d.ts +3 -2
  54. package/umd/src/cli/cli-commands/coder/augmentCoderAgentTeam.d.ts +7 -0
  55. package/umd/src/cli/cli-commands/coder/coderAgentRole.d.ts +16 -0
  56. package/umd/src/cli/cli-commands/coder/coderReferencedArtifacts.d.ts +8 -7
  57. package/umd/src/cli/cli-commands/coder/ensureCoderDefaultAgentFiles.d.ts +8 -0
  58. package/umd/src/cli/cli-commands/coder/ensureCoderDefaultAgentFiles.test.d.ts +1 -0
  59. package/umd/src/cli/cli-commands/coder/ensureCoderRoleAgentFile.d.ts +12 -0
  60. package/umd/src/cli/cli-commands/coder/generate-boilerplates.d.ts +1 -1
  61. package/umd/src/cli/cli-commands/coder/getCoderInitializationCommitPaths.d.ts +9 -0
  62. package/umd/src/cli/cli-commands/coder/initializeCoderProjectConfiguration.d.ts +7 -5
  63. package/umd/src/cli/cli-commands/coder/plan.d.ts +7 -0
  64. package/umd/src/cli/cli-commands/coder/planning/assertPlanningCommitSafe.d.ts +6 -0
  65. package/umd/src/cli/cli-commands/coder/planning/assertPlanningPrdCommitScope.d.ts +7 -0
  66. package/umd/src/cli/cli-commands/coder/planning/assertPlanningRuntimePath.d.ts +6 -0
  67. package/umd/src/cli/cli-commands/coder/planning/createPlanningTerminal.d.ts +8 -0
  68. package/umd/src/cli/cli-commands/coder/planning/createPlanningTerminal.test.d.ts +1 -0
  69. package/umd/src/cli/cli-commands/coder/planning/createPlanningWorkspace.d.ts +11 -0
  70. package/umd/src/cli/cli-commands/coder/planning/discussPlanningTurn.d.ts +15 -0
  71. package/umd/src/cli/cli-commands/coder/planning/fixtures/snapshotPlanningProject.d.ts +5 -0
  72. package/umd/src/cli/cli-commands/coder/planning/planningGitSync.test.d.ts +1 -0
  73. package/umd/src/cli/cli-commands/coder/planning/planningPackagedCli.test.d.ts +1 -0
  74. package/umd/src/cli/cli-commands/coder/planning/planningProtocol.d.ts +152 -0
  75. package/umd/src/cli/cli-commands/coder/planning/planningTeam.test.d.ts +1 -0
  76. package/umd/src/cli/cli-commands/coder/planning/preparePlanningChanges.d.ts +16 -0
  77. package/umd/src/cli/cli-commands/coder/planning/readPlanningContext.d.ts +6 -0
  78. package/umd/src/cli/cli-commands/coder/planning/resolvePlanningPath.d.ts +7 -0
  79. package/umd/src/cli/cli-commands/coder/planning/runPlanningHarness.d.ts +30 -0
  80. package/umd/src/cli/cli-commands/coder/planning/runPlanningHarness.test.d.ts +1 -0
  81. package/umd/src/cli/cli-commands/coder/planning/runPlanningSession.d.ts +21 -0
  82. package/umd/src/cli/cli-commands/coder/planning/runPlanningSession.test.d.ts +1 -0
  83. package/umd/src/cli/cli-commands/coder/planning/savePlanningChanges.d.ts +7 -0
  84. package/umd/src/cli/cli-commands/coder/printInitializationSummary.d.ts +2 -1
  85. package/umd/src/cli/cli-commands/coder/promptsReadmeTemplate.d.ts +13 -0
  86. package/umd/src/cli/cli-commands/coder/promptsReadmeTemplate.test.d.ts +1 -0
  87. package/umd/src/cli/cli-commands/coder/readCoderAgentBook.d.ts +8 -0
  88. package/umd/src/cli/cli-commands/coder/workspacePreflight.test.d.ts +1 -0
  89. package/umd/src/cli/cli-commands/coder.d.ts +1 -0
  90. package/umd/src/cli/cli-commands/common/LocalAgentBookCollection.d.ts +4 -2
  91. package/umd/src/cli/cli-commands/common/coderGitSyncCliOptions.d.ts +1 -1
  92. package/umd/src/cli/cli-commands/common/resolveLocalAgentSource.d.ts +8 -1
  93. package/umd/src/cli/cli-commands/common/validateCoderRunOptions.d.ts +6 -0
  94. package/umd/src/cli/cli-commands/common/workspaceRepository.d.ts +36 -0
  95. package/umd/src/cli/cli-commands/common/workspaceRepository.test.d.ts +1 -0
  96. package/umd/src/cli/cli-commands/common/workspaceRepositoryCliOptions.d.ts +11 -0
  97. package/umd/src/commitments/TEAM/TEAM.test.d.ts +1 -0
  98. package/umd/src/conversion/archive/loadJsZipModule.d.ts +10 -0
  99. package/umd/src/version.d.ts +1 -1
@@ -0,0 +1,30 @@
1
+ import type { Usage } from '../../../../execution/Usage';
2
+ import type { NormalizedPromptRunnerSelectionCliOptions } from '../../common/promptRunnerCliOptions';
3
+ /**
4
+ * Parameters for one tool-restricted inference. Repository reads and PRD writes are host operations.
5
+ * @private internal type of `coder plan`
6
+ */
7
+ export type PlanningHarnessOptions = NormalizedPromptRunnerSelectionCliOptions & {
8
+ readonly workspacePath: string;
9
+ readonly prompt: string;
10
+ readonly signal: AbortSignal;
11
+ /** Reports available usage from this inference once, including turns whose final answer is malformed. */
12
+ readonly onUsage?: (usage: Usage) => void;
13
+ };
14
+ /**
15
+ * Rejects harnesses without a planning execution policy before any Git sync or process launch.
16
+ * @private internal utility of `coder plan`
17
+ */
18
+ export declare function assertPlanningHarnessSupported(harness: string | undefined): void;
19
+ /**
20
+ * Constructs a fail-closed Codex invocation. User config, rules, project config discovery, native shell,
21
+ * connectors, hooks and delegation cannot expand the planning tool set. Read-only sandboxing also denies patches.
22
+ * Older Codex versions that do not support these switches fail instead of using the implementation runner.
23
+ * @private internal utility of `coder plan`
24
+ */
25
+ export declare function buildPlanningHarnessArguments(options: PlanningHarnessOptions): string[];
26
+ /**
27
+ * Runs a bounded inference with no shell interpolation and consumes only its final JSON answer.
28
+ * @private internal utility of `coder plan`
29
+ */
30
+ export declare function runPlanningHarness(options: PlanningHarnessOptions): Promise<string>;
@@ -0,0 +1,21 @@
1
+ import type { NormalizedPromptRunnerSelectionCliOptions } from '../../common/promptRunnerCliOptions';
2
+ import { runPlanningHarness } from './runPlanningHarness';
3
+ /**
4
+ * Terminal interface also used by deterministic conversation fixtures.
5
+ * @private internal type of `coder plan`
6
+ */
7
+ export type PlanningSessionIo = {
8
+ readonly readMessage: () => Promise<string | undefined>;
9
+ readonly write: (message: string) => void;
10
+ readonly signal: AbortSignal;
11
+ };
12
+ /**
13
+ * Runs one multi-topic planning conversation; only explicit save commands cross the PRD write boundary.
14
+ * @private internal utility of `coder plan`
15
+ */
16
+ export declare function runPlanningSession(options: NormalizedPromptRunnerSelectionCliOptions & {
17
+ readonly projectPath: string;
18
+ readonly agent?: string;
19
+ readonly template?: string;
20
+ readonly preexistingChangedPaths?: ReadonlySet<string>;
21
+ }, io: PlanningSessionIo, harness?: typeof runPlanningHarness): Promise<ReadonlyMap<string, string>>;
@@ -0,0 +1,7 @@
1
+ import type { PlanningChange } from './preparePlanningChanges';
2
+ /**
3
+ * Validates the entire batch before writing, stages outside the queue, then atomically replaces each file.
4
+ * The synchronous commit region cannot be interrupted by a SIGINT callback halfway through a save.
5
+ * @private internal execution boundary of `coder plan`
6
+ */
7
+ export declare function savePlanningChanges(projectPath: string, workspacePath: string, changes: ReadonlyArray<PlanningChange>, isDraft: boolean): string[];
@@ -1,7 +1,8 @@
1
+ import type { WorkspaceRepositoryContext } from '../common/workspaceRepository';
1
2
  import type { CoderInitializationSummary } from './initializeCoderProjectConfiguration';
2
3
  /**
3
4
  * Prints a readable summary of what was initialized for the user.
4
5
  *
5
6
  * @private function of `coder init` command
6
7
  */
7
- export declare function printInitializationSummary(summary: CoderInitializationSummary): void;
8
+ export declare function printInitializationSummary(summary: CoderInitializationSummary, workspace?: WorkspaceRepositoryContext): void;
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Project-relative location of the offline guide, reserved from prompt discovery.
3
+ *
4
+ * @private internal constant of `coder init`
5
+ */
6
+ export declare const PROMPTS_README_FILE_PATH: string;
7
+ /**
8
+ * Maintained project-independent guide, bundled as text in the published CLI.
9
+ * Keep examples executable against the parser and command registry in the accompanying tests.
10
+ *
11
+ * @private internal template of `coder init`
12
+ */
13
+ export declare const PROMPTS_README_TEMPLATE: string;
@@ -0,0 +1,8 @@
1
+ import type { string_book } from '../../../book-2.0/agent-source/string_book';
2
+ /**
3
+ * Reads a project-owned Book before initialization, refusing unsafe edits while preserving its original bytes.
4
+ * Unknown commitments remain supported, as in the normal Book parser.
5
+ *
6
+ * @private internal utility of `coder init`
7
+ */
8
+ export declare function readCoderAgentBook(filePath: string): Promise<string_book>;
@@ -6,6 +6,7 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
6
6
  * The coder command provides utilities for automated coding:
7
7
  * - init: Initialize coder configuration in current project
8
8
  * - add: Add one ready-to-run prompt file to the queue
9
+ * - plan: Discuss features with Planner and author reviewed PRDs
9
10
  * - generate-boilerplates: Generate prompt boilerplate files
10
11
  * - find-refactor-candidates: Find files that need refactoring
11
12
  * - list: List ready prompts in priority order without running them
@@ -19,6 +19,8 @@ export type LocalAgentBook = {
19
19
  export declare class LocalAgentBookCollection {
20
20
  private readonly agentDirectoryPath;
21
21
  private readonly currentWorkingDirectory;
22
+ private readonly isInitializationAllowed;
23
+ private readonly signal?;
22
24
  private readonly booksByUrl;
23
25
  private readonly booksByName;
24
26
  /** Stable default ancestor selected from the initial repository scan. */
@@ -26,7 +28,7 @@ export declare class LocalAgentBookCollection {
26
28
  /** Files initialized by this collection, for the coder's normal commit handling. */
27
29
  readonly createdAgentBookPaths: string[];
28
30
  /** Creates a collection rooted at the primary book's directory. */
29
- constructor(agentDirectoryPath: string, currentWorkingDirectory: string);
31
+ constructor(agentDirectoryPath: string, currentWorkingDirectory: string, isInitializationAllowed?: boolean, signal?: AbortSignal | undefined);
30
32
  /** Discovers nested books, including the hidden `.core` directory. */
31
33
  initialize(): Promise<void>;
32
34
  /** Identifies the default ancestor without creating an unused book for FROM null/void. */
@@ -38,7 +40,7 @@ export declare class LocalAgentBookCollection {
38
40
  /** Reads a local book once, canonicalizing symlinks so aliases cannot bypass cycle detection. */
39
41
  readBook(filePath: string): Promise<LocalAgentBook>;
40
42
  /** Loads a referenced remote book, while keeping local identifiers entirely inside the collection. */
41
- getBook(url: string): Promise<LocalAgentBook>;
43
+ getBook(url: string, signal?: AbortSignal | undefined): Promise<LocalAgentBook>;
42
44
  /** Adds a book under its normalized first-line name and preserves the display name for TEAM. */
43
45
  private registerBook;
44
46
  /** Walks real directories in deterministic order without following directory symlink loops. */
@@ -21,7 +21,7 @@ export declare const CODER_GIT_SYNC_DESCRIPTION: string;
21
21
  * Registers the shared `--commit`, `--auto-push` and `--auto-pull` flags on a `ptbk coder` command.
22
22
  *
23
23
  * Note: Unlike `ptbk coder run`, which commits by default and opts out through `--no-commit`,
24
- * these commands never touch git unless the flags are used explicitly.
24
+ * these commands only mutate Git when the flags are used explicitly. Workspace detection always runs.
25
25
  *
26
26
  * @private internal utility of `promptbookCli`
27
27
  */
@@ -6,8 +6,12 @@ import type { string_book } from '../../../book-2.0/agent-source/string_book';
6
6
  * @private internal type of CLI agent resolution
7
7
  */
8
8
  export type ResolvedLocalAgentSource = {
9
+ /** Canonical identity used to bound recursive TEAM consultations. */
10
+ readonly agentUrl: string;
9
11
  readonly agentSource: string_book;
10
12
  readonly agentReferenceResolver: AgentReferenceResolver;
13
+ /** Resolves another Book in this collection, retaining its own inheritance and reference locations. */
14
+ readonly resolveAgentSource: (url: string, signal?: AbortSignal) => Promise<ResolvedLocalAgentSource>;
11
15
  /** Newly created books which the coder may include in its initialization commit. */
12
16
  readonly createdAgentBookPaths: ReadonlyArray<string>;
13
17
  };
@@ -16,4 +20,7 @@ export type ResolvedLocalAgentSource = {
16
20
  *
17
21
  * @private internal utility of CLI agent resolution
18
22
  */
19
- export declare function resolveLocalAgentSource(agentBookPath: string, currentWorkingDirectory: string): Promise<ResolvedLocalAgentSource>;
23
+ export declare function resolveLocalAgentSource(agentBookPath: string, currentWorkingDirectory: string, options?: {
24
+ readonly isInitializationAllowed?: boolean;
25
+ readonly signal?: AbortSignal;
26
+ }): Promise<ResolvedLocalAgentSource>;
@@ -0,0 +1,6 @@
1
+ import type { RunOptions } from '../../../../scripts/run-codex-prompts/cli/RunOptions';
2
+ /**
3
+ * Validates cross-flag constraints before workspace setup or the run starts.
4
+ * @private shared validation for Coder execution commands
5
+ */
6
+ export declare function validateCoderRunOptions(options: RunOptions): void;
@@ -0,0 +1,36 @@
1
+ import type { NormalizedQuestionsCliOptions } from './questionsCliOptions';
2
+ /**
3
+ * Resolved project directory and its enclosing working tree. Project artifacts belong to `projectPath`;
4
+ * Git paths and synchronization belong to `repositoryRoot`, which may be an enclosing monorepo.
5
+ *
6
+ * @private shared workspace context for Coder and workspace server commands
7
+ */
8
+ export type WorkspaceRepositoryContext = {
9
+ readonly projectPath: string;
10
+ readonly repositoryRoot?: string;
11
+ readonly gitDirectory?: string;
12
+ readonly repositoryStatus: 'missing' | 'reused' | 'initialized';
13
+ };
14
+ /**
15
+ * Command policy is separate from discovery: previews never initialize; explicit init needs no confirmation.
16
+ *
17
+ * @private shared workspace policy for Coder and workspace server commands
18
+ */
19
+ export type WorkspaceRepositoryPolicy = 'initialize' | 'mutate' | 'read-only';
20
+ /**
21
+ * Resolves the requested project once and discovers Git using Git itself, without requiring `HEAD`.
22
+ * Broken metadata, bare repositories, ownership errors and unavailable Git are failures, not missing repositories.
23
+ *
24
+ * @private shared workspace discovery for CLI commands
25
+ */
26
+ export declare function $resolveWorkspaceRepository(projectDirectory?: string): Promise<WorkspaceRepositoryContext>;
27
+ /**
28
+ * Checks the shared prerequisite before any project writes, Git synchronization, installation or startup.
29
+ * Only an affirmative interactive answer or an explicit initializer authorizes `git init`.
30
+ *
31
+ * @private shared workspace preflight for Coder and workspace server commands
32
+ */
33
+ export declare function $preflightWorkspaceRepository(options: {
34
+ readonly projectDirectory?: string;
35
+ readonly policy: WorkspaceRepositoryPolicy;
36
+ } & Partial<NormalizedQuestionsCliOptions>): Promise<WorkspaceRepositoryContext>;
@@ -0,0 +1,11 @@
1
+ import type { Command } from 'commander';
2
+ /**
3
+ * Shared explanation of the workspace prerequisite, independent of commit and synchronization settings.
4
+ * @private internal CLI help text
5
+ */
6
+ export declare const WORKSPACE_REPOSITORY_DESCRIPTION: string;
7
+ /**
8
+ * Adds shared Git help and the questions switch to every workspace command without duplicating existing options.
9
+ * @private internal registration helper for workspace CLI commands
10
+ */
11
+ export declare function addWorkspaceRepositoryOptions(command: Command): void;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,10 @@
1
+ /**
2
+ * Loads the ZIP archive library (`jszip`) on demand
3
+ *
4
+ * Note: [🐌] Loaded lazily to keep the startup of the `ptbk` CLI utility fast
5
+ *
6
+ * @private internal utility of `loadArchive` and `saveArchive`
7
+ */
8
+ export declare const loadJsZipModule: () => Promise<{
9
+ default: typeof import('jszip');
10
+ }>;
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.114.0-40`).
18
+ * It follows semantic versioning (e.g., `0.114.0-47`).
19
19
  *
20
20
  * @generated
21
21
  */