@promptbook/types 0.114.0-30 → 0.114.0-31

package/esm/src/cli/cli-commands/coder/$ensureCoderHarnessGitignoreRules.d.ts

@@ -0,0 +1,9 @@
+import type { PromptRunnerHarnessName } from '../common/promptRunnerCliOptions';
+/**
+ * Offers to add missing project-local ignore rules for the selected coding harness.
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it may ask the user and update `.gitignore`.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function $ensureCoderHarnessGitignoreRules(projectPath: string, harnessName: PromptRunnerHarnessName | undefined): Promise<void>;

package/esm/src/cli/cli-commands/coder/$ensureCoderHarnessGitignoreRules.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/cli/cli-commands/coder/ensureCoderGitignoreFile.d.ts

@@ -1,7 +1,20 @@
+import { type PromptRunnerHarnessName } from '../common/promptRunnerCliOptions';
 import type { InitializationStatus } from './boilerplateTemplates';
 /**
- * Ensures `.gitignore` contains the standalone Promptbook temp entry.
+ * Ensures `.gitignore` contains Promptbook Coder's local artifacts and every supported harness's local artifacts.
  *
  * @private function of `initializeCoderProjectConfiguration`
  */
 export declare function ensureCoderGitignoreFile(projectPath: string): Promise<InitializationStatus>;
+/**
+ * Lists missing project-local ignore rules for the selected harnesses.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function getMissingCoderHarnessGitignoreRules(projectPath: string, harnessNames: ReadonlyArray<PromptRunnerHarnessName>): Promise<ReadonlyArray<string>>;
+/**
+ * Adds the given Promptbook Coder rules to a project's `.gitignore` file.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function ensureCoderGitignoreRules(projectPath: string, rules: ReadonlyArray<string>): Promise<InitializationStatus>;

package/esm/src/cli/cli-commands/coder/server.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/cli/cli-commands/common/$askForConfirmation.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Asks the user in the terminal to confirm one optional change.
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it reads the answer from stdin.
+ *
+ * @returns `true` when the user confirms, `false` when the user declines or the terminal is not interactive.
+ * @private internal utility of `promptbookCli`
+ */
+export declare function $askForConfirmation(question: string): Promise<boolean>;

package/esm/src/cli/cli-commands/common/harness/HarnessDefinition.d.ts

@@ -45,6 +45,10 @@ export type HarnessDefinition = {
      * Extra environment variables required by the global npm installation of this harness.
      */
     readonly npmInstallEnvironment?: Readonly<Record<string, string>>;
+    /**
+     * Project-local files or directories which this harness can create and which should not be committed.
+     */
+    readonly projectGitignoreRules: ReadonlyArray<string>;
     /**
      * How a standalone installation of this harness is recognized and updated.
      *
@@ -64,3 +68,9 @@ export declare const HARNESS_DEFINITIONS: Readonly<Record<PromptRunnerHarnessNam
  * @private internal utility of `promptbookCli`
  */
 export declare function getHarnessDefinition(harnessName: PromptRunnerHarnessName): HarnessDefinition;
+/**
+ * Lists the unique project ignore rules required by the selected harnesses, in selection order.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export declare function getHarnessProjectGitignoreRules(harnessNames: ReadonlyArray<PromptRunnerHarnessName>): ReadonlyArray<string>;

package/esm/src/cli/cli-commands/common/projectInitialization.d.ts

@@ -50,6 +50,12 @@ export declare function ensureProjectEnvFile<TEnvVariable extends ProjectEnvVari
  * @private internal utility of Promptbook CLI project initialization
  */
 export declare function ensureProjectGitignoreFile({ projectPath, blockHeader, rules, }: EnsureProjectGitignoreFileOptions): Promise<ProjectInitializationStatus>;
+/**
+ * Lists the ignore rules which are not yet present in a project's `.gitignore` file.
+ *
+ * @private internal utility of Promptbook CLI project initialization
+ */
+export declare function getMissingProjectGitignoreRules(projectPath: string, rules: ReadonlyArray<string>): Promise<ReadonlyArray<string>>;
 /**
  * Reads one text file when it exists, otherwise returns `undefined`.
  *

package/esm/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.114.0-29`).
+ * It follows semantic versioning (e.g., `0.114.0-30`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.114.0-30",
+    "version": "0.114.0-31",
     "description": "Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action",
     "private": false,
     "sideEffects": false,
@@ -96,6 +96,6 @@
     "types": "./esm/src/_packages/types.index.d.ts",
     "typings": "./esm/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.114.0-30"
+        "@promptbook/core": "0.114.0-31"
     }
 }

package/umd/src/cli/cli-commands/coder/$ensureCoderHarnessGitignoreRules.d.ts

@@ -0,0 +1,9 @@
+import type { PromptRunnerHarnessName } from '../common/promptRunnerCliOptions';
+/**
+ * Offers to add missing project-local ignore rules for the selected coding harness.
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it may ask the user and update `.gitignore`.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function $ensureCoderHarnessGitignoreRules(projectPath: string, harnessName: PromptRunnerHarnessName | undefined): Promise<void>;

package/umd/src/cli/cli-commands/coder/$ensureCoderHarnessGitignoreRules.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/cli/cli-commands/coder/ensureCoderGitignoreFile.d.ts

@@ -1,7 +1,20 @@
+import { type PromptRunnerHarnessName } from '../common/promptRunnerCliOptions';
 import type { InitializationStatus } from './boilerplateTemplates';
 /**
- * Ensures `.gitignore` contains the standalone Promptbook temp entry.
+ * Ensures `.gitignore` contains Promptbook Coder's local artifacts and every supported harness's local artifacts.
  *
  * @private function of `initializeCoderProjectConfiguration`
  */
 export declare function ensureCoderGitignoreFile(projectPath: string): Promise<InitializationStatus>;
+/**
+ * Lists missing project-local ignore rules for the selected harnesses.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function getMissingCoderHarnessGitignoreRules(projectPath: string, harnessNames: ReadonlyArray<PromptRunnerHarnessName>): Promise<ReadonlyArray<string>>;
+/**
+ * Adds the given Promptbook Coder rules to a project's `.gitignore` file.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function ensureCoderGitignoreRules(projectPath: string, rules: ReadonlyArray<string>): Promise<InitializationStatus>;

package/umd/src/cli/cli-commands/coder/server.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/cli/cli-commands/common/$askForConfirmation.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Asks the user in the terminal to confirm one optional change.
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it reads the answer from stdin.
+ *
+ * @returns `true` when the user confirms, `false` when the user declines or the terminal is not interactive.
+ * @private internal utility of `promptbookCli`
+ */
+export declare function $askForConfirmation(question: string): Promise<boolean>;

package/umd/src/cli/cli-commands/common/harness/HarnessDefinition.d.ts

@@ -45,6 +45,10 @@ export type HarnessDefinition = {
      * Extra environment variables required by the global npm installation of this harness.
      */
     readonly npmInstallEnvironment?: Readonly<Record<string, string>>;
+    /**
+     * Project-local files or directories which this harness can create and which should not be committed.
+     */
+    readonly projectGitignoreRules: ReadonlyArray<string>;
     /**
      * How a standalone installation of this harness is recognized and updated.
      *
@@ -64,3 +68,9 @@ export declare const HARNESS_DEFINITIONS: Readonly<Record<PromptRunnerHarnessNam
  * @private internal utility of `promptbookCli`
  */
 export declare function getHarnessDefinition(harnessName: PromptRunnerHarnessName): HarnessDefinition;
+/**
+ * Lists the unique project ignore rules required by the selected harnesses, in selection order.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export declare function getHarnessProjectGitignoreRules(harnessNames: ReadonlyArray<PromptRunnerHarnessName>): ReadonlyArray<string>;

package/umd/src/cli/cli-commands/common/projectInitialization.d.ts

@@ -50,6 +50,12 @@ export declare function ensureProjectEnvFile<TEnvVariable extends ProjectEnvVari
  * @private internal utility of Promptbook CLI project initialization
  */
 export declare function ensureProjectGitignoreFile({ projectPath, blockHeader, rules, }: EnsureProjectGitignoreFileOptions): Promise<ProjectInitializationStatus>;
+/**
+ * Lists the ignore rules which are not yet present in a project's `.gitignore` file.
+ *
+ * @private internal utility of Promptbook CLI project initialization
+ */
+export declare function getMissingProjectGitignoreRules(projectPath: string, rules: ReadonlyArray<string>): Promise<ReadonlyArray<string>>;
 /**
  * Reads one text file when it exists, otherwise returns `undefined`.
  *

package/umd/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.114.0-29`).
+ * It follows semantic versioning (e.g., `0.114.0-30`).
  *
  * @generated
  */