@promptbook/markdown-utils 0.114.0-32 → 0.114.0-34

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 (97) hide show
  1. package/esm/index.es.js +1 -1
  2. package/esm/src/book-2.0/book-language-documentation/getSafeCodeBlock.d.ts +1 -1
  3. package/esm/src/book-components/Chat/MockedChat/MockedChat.test.d.ts +2 -0
  4. package/esm/src/cli/cli-commands/coder/$ensureCoderHarnessGitignoreRules.d.ts +2 -1
  5. package/esm/src/cli/cli-commands/coder/agentCliOptions.d.ts +21 -0
  6. package/esm/src/cli/cli-commands/coder/boilerplateTemplates.d.ts +8 -21
  7. package/esm/src/cli/cli-commands/coder/coderReferencedArtifacts.d.ts +33 -0
  8. package/esm/src/cli/cli-commands/coder/ensureCoderPackageJsonFile.d.ts +4 -2
  9. package/esm/src/cli/cli-commands/coder/ensureCoderVscodeSettingsFile.d.ts +2 -0
  10. package/esm/src/cli/cli-commands/coder/ensureDirectory.d.ts +6 -0
  11. package/esm/src/cli/cli-commands/coder/getDefaultCoderPackageJsonScripts.d.ts +6 -0
  12. package/esm/src/cli/cli-commands/coder/initializeCoderProjectConfiguration.d.ts +7 -5
  13. package/esm/src/cli/cli-commands/coder/list.d.ts +10 -0
  14. package/esm/src/cli/cli-commands/coder/mergeStringRecordJsonFile.d.ts +19 -1
  15. package/esm/src/cli/cli-commands/coder/printCoderRunFailure.d.ts +6 -0
  16. package/esm/src/cli/cli-commands/coder.d.ts +1 -0
  17. package/esm/src/cli/cli-commands/common/$askForConfirmation.d.ts +4 -2
  18. package/esm/src/cli/cli-commands/common/$askForConfirmation.test.d.ts +1 -0
  19. package/esm/src/cli/cli-commands/common/disk-space/$assertSufficientFreeDiskSpace.d.ts +12 -0
  20. package/esm/src/cli/cli-commands/common/disk-space/$assertSufficientFreeDiskSpace.test.d.ts +1 -0
  21. package/esm/src/cli/cli-commands/common/disk-space/$readFreeDiskSpaceStatus.d.ts +11 -0
  22. package/esm/src/cli/cli-commands/common/disk-space/$readFreeDiskSpaceStatus.test.d.ts +1 -0
  23. package/esm/src/cli/cli-commands/common/disk-space/FreeDiskSpaceStatus.d.ts +33 -0
  24. package/esm/src/cli/cli-commands/common/disk-space/formatFreeDiskSpaceBytes.d.ts +6 -0
  25. package/esm/src/cli/cli-commands/common/disk-space/formatFreeDiskSpaceBytes.test.d.ts +1 -0
  26. package/esm/src/cli/cli-commands/common/disk-space/formatLowFreeDiskSpaceWarning.d.ts +10 -0
  27. package/esm/src/cli/cli-commands/common/disk-space/freeDiskSpaceConstants.d.ts +28 -0
  28. package/esm/src/cli/cli-commands/common/disk-space/resolveFreeDiskSpaceLevel.d.ts +7 -0
  29. package/esm/src/cli/cli-commands/common/disk-space/resolveFreeDiskSpaceLevel.test.d.ts +1 -0
  30. package/esm/src/cli/cli-commands/common/harness/$applyHarnessInstallationStatus.d.ts +2 -1
  31. package/esm/src/cli/cli-commands/common/harness/$ensureHarnessInstallations.d.ts +3 -2
  32. package/esm/src/cli/cli-commands/common/harness/HarnessDefinition.d.ts +26 -0
  33. package/esm/src/cli/cli-commands/common/npm/$askForNpmPackageInstallationApproval.d.ts +4 -2
  34. package/esm/src/cli/cli-commands/common/promptPriorityCliOptions.d.ts +7 -0
  35. package/esm/src/cli/cli-commands/common/promptbook-cli/$ensurePromptbookCliInstallations.d.ts +2 -1
  36. package/esm/src/cli/cli-commands/common/questionsCliOptions.d.ts +45 -0
  37. package/esm/src/cli/cli-commands/common/questionsCliOptions.test.d.ts +1 -0
  38. package/esm/src/cli/common/$deprecateCliCommand.d.ts +3 -0
  39. package/esm/src/cli/common/$hideCliCommandFromHelp.d.ts +11 -0
  40. package/esm/src/cli/common/$hideCliCommandFromHelp.test.d.ts +1 -0
  41. package/esm/src/cli/common/$requireCliSubcommand.d.ts +18 -0
  42. package/esm/src/cli/common/$requireCliSubcommand.test.d.ts +1 -0
  43. package/esm/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts +5 -2
  44. package/esm/src/version.d.ts +1 -1
  45. package/package.json +1 -4
  46. package/umd/index.umd.js +1 -1
  47. package/umd/src/book-2.0/book-language-documentation/getSafeCodeBlock.d.ts +1 -1
  48. package/umd/src/book-components/Chat/MockedChat/MockedChat.test.d.ts +2 -0
  49. package/umd/src/cli/cli-commands/coder/$ensureCoderHarnessGitignoreRules.d.ts +2 -1
  50. package/umd/src/cli/cli-commands/coder/agentCliOptions.d.ts +21 -0
  51. package/umd/src/cli/cli-commands/coder/boilerplateTemplates.d.ts +8 -21
  52. package/umd/src/cli/cli-commands/coder/coderReferencedArtifacts.d.ts +33 -0
  53. package/umd/src/cli/cli-commands/coder/ensureCoderPackageJsonFile.d.ts +4 -2
  54. package/umd/src/cli/cli-commands/coder/ensureCoderVscodeSettingsFile.d.ts +2 -0
  55. package/umd/src/cli/cli-commands/coder/ensureDirectory.d.ts +6 -0
  56. package/umd/src/cli/cli-commands/coder/getDefaultCoderPackageJsonScripts.d.ts +6 -0
  57. package/umd/src/cli/cli-commands/coder/init.test.d.ts +1 -0
  58. package/umd/src/cli/cli-commands/coder/initializeCoderProjectConfiguration.d.ts +7 -5
  59. package/umd/src/cli/cli-commands/coder/list.d.ts +10 -0
  60. package/umd/src/cli/cli-commands/coder/list.test.d.ts +1 -0
  61. package/umd/src/cli/cli-commands/coder/mergeStringRecordJsonFile.d.ts +19 -1
  62. package/umd/src/cli/cli-commands/coder/printCoderRunFailure.d.ts +6 -0
  63. package/umd/src/cli/cli-commands/coder.d.ts +1 -0
  64. package/umd/src/cli/cli-commands/common/$askForConfirmation.d.ts +4 -2
  65. package/umd/src/cli/cli-commands/common/$askForConfirmation.test.d.ts +1 -0
  66. package/umd/src/cli/cli-commands/common/disk-space/$assertSufficientFreeDiskSpace.d.ts +12 -0
  67. package/umd/src/cli/cli-commands/common/disk-space/$assertSufficientFreeDiskSpace.test.d.ts +1 -0
  68. package/umd/src/cli/cli-commands/common/disk-space/$readFreeDiskSpaceStatus.d.ts +11 -0
  69. package/umd/src/cli/cli-commands/common/disk-space/$readFreeDiskSpaceStatus.test.d.ts +1 -0
  70. package/umd/src/cli/cli-commands/common/disk-space/FreeDiskSpaceStatus.d.ts +33 -0
  71. package/umd/src/cli/cli-commands/common/disk-space/formatFreeDiskSpaceBytes.d.ts +6 -0
  72. package/umd/src/cli/cli-commands/common/disk-space/formatFreeDiskSpaceBytes.test.d.ts +1 -0
  73. package/umd/src/cli/cli-commands/common/disk-space/formatLowFreeDiskSpaceWarning.d.ts +10 -0
  74. package/umd/src/cli/cli-commands/common/disk-space/freeDiskSpaceConstants.d.ts +28 -0
  75. package/umd/src/cli/cli-commands/common/disk-space/resolveFreeDiskSpaceLevel.d.ts +7 -0
  76. package/umd/src/cli/cli-commands/common/disk-space/resolveFreeDiskSpaceLevel.test.d.ts +1 -0
  77. package/umd/src/cli/cli-commands/common/harness/$applyHarnessInstallationStatus.d.ts +2 -1
  78. package/umd/src/cli/cli-commands/common/harness/$ensureHarnessInstallations.d.ts +3 -2
  79. package/umd/src/cli/cli-commands/common/harness/HarnessDefinition.d.ts +26 -0
  80. package/umd/src/cli/cli-commands/common/npm/$askForNpmPackageInstallationApproval.d.ts +4 -2
  81. package/umd/src/cli/cli-commands/common/promptPriorityCliOptions.d.ts +7 -0
  82. package/umd/src/cli/cli-commands/common/promptbook-cli/$ensurePromptbookCliInstallations.d.ts +2 -1
  83. package/umd/src/cli/cli-commands/common/questionsCliOptions.d.ts +45 -0
  84. package/umd/src/cli/cli-commands/common/questionsCliOptions.test.d.ts +1 -0
  85. package/umd/src/cli/common/$deprecateCliCommand.d.ts +3 -0
  86. package/umd/src/cli/common/$hideCliCommandFromHelp.d.ts +11 -0
  87. package/umd/src/cli/common/$hideCliCommandFromHelp.test.d.ts +1 -0
  88. package/umd/src/cli/common/$requireCliSubcommand.d.ts +18 -0
  89. package/umd/src/cli/common/$requireCliSubcommand.test.d.ts +1 -0
  90. package/umd/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts +5 -2
  91. package/umd/src/version.d.ts +1 -1
  92. package/esm/src/cli/cli-commands/coder/agentCodingFile.d.ts +0 -13
  93. package/esm/src/cli/cli-commands/common/harnessUpdateCliOptions.d.ts +0 -29
  94. package/umd/src/cli/cli-commands/coder/agentCodingFile.d.ts +0 -13
  95. package/umd/src/cli/cli-commands/common/harnessUpdateCliOptions.d.ts +0 -29
  96. /package/esm/src/cli/cli-commands/{common/harnessUpdateCliOptions.test.d.ts → coder/init.test.d.ts} +0 -0
  97. /package/{umd/src/cli/cli-commands/common/harnessUpdateCliOptions.test.d.ts → esm/src/cli/cli-commands/coder/list.test.d.ts} +0 -0
@@ -3,6 +3,9 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
3
3
  /**
4
4
  * Marks one CLI command as deprecated while keeping it available for existing callers.
5
5
  *
6
+ * Deprecated commands are not advertised anymore - they are hidden from the list of commands in the help of their
7
+ * parent command, they warn when they are used and they explain the deprecation in their own help.
8
+ *
6
9
  * @private utility of CLI
7
10
  */
8
11
  export declare function $deprecateCliCommand(command: Command, deprecationMessage: string): $side_effect;
@@ -0,0 +1,11 @@
1
+ import type { Command } from 'commander';
2
+ import type { $side_effect } from '../../utils/organization/$side_effect';
3
+ /**
4
+ * Keeps one already registered CLI command out of the help of its parent command while the command itself stays
5
+ * fully usable - it can still be run, it still has its own help and it is still reachable through `ptbk help <command>`.
6
+ *
7
+ * Note: `$` is used to indicate that this function is not a pure function - it changes how the CLI renders its help
8
+ *
9
+ * @private utility of CLI
10
+ */
11
+ export declare function $hideCliCommandFromHelp(command: Command): $side_effect;
@@ -0,0 +1,18 @@
1
+ import type { Command } from 'commander';
2
+ import type { $side_effect } from '../../utils/organization/$side_effect';
3
+ /**
4
+ * Makes one CLI command which only groups subcommands ask for a subcommand instead of doing anything on its own.
5
+ *
6
+ * Note: `$` is used to indicate that this function is not a pure function - it registers an action in the CLI
7
+ *
8
+ * @private utility of CLI
9
+ */
10
+ export declare function $requireCliSubcommand(command: Command): $side_effect;
11
+ /**
12
+ * Asks for a subcommand of one CLI command, prints its help and exits the process.
13
+ *
14
+ * Note: `$` is used to indicate that this function is not a pure function - it writes to the console and exits the process
15
+ *
16
+ * @private utility of CLI
17
+ */
18
+ export declare function $reportMissingCliSubcommand(command: Command): never;
@@ -0,0 +1 @@
1
+ export {};
@@ -17,7 +17,10 @@ export type VercelExecutionToolsOptions = CommonToolsOptions & Pick<LlmExecution
17
17
  */
18
18
  readonly availableModels: ReadonlyArray<AvailableModel>;
19
19
  /**
20
- * Additional settings for chat models when calling `vercelProvider.chat('model-name', settings)`
20
+ * Additional settings for chat models, for example `temperature` or `providerOptions`
21
+ *
22
+ * Note: Since Vercel AI SDK v5 these settings belong to the model call, not to
23
+ * `vercelProvider.chat('model-name')` which takes just the model name
21
24
  */
22
- readonly additionalChatSettings?: Partial<Parameters<VercelProvider['chat']>[1]>;
25
+ readonly additionalChatSettings?: Partial<Omit<Parameters<ReturnType<VercelProvider['chat']>['doGenerate']>[0], 'prompt'>>;
23
26
  };
@@ -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-31`).
18
+ * It follows semantic versioning (e.g., `0.114.0-33`).
19
19
  *
20
20
  * @generated
21
21
  */
@@ -1,13 +0,0 @@
1
- import { string_markdown } from '../../../types/typeAliases';
2
- /**
3
- * Relative path to the Promptbook Coder quick-reference file initialized in project roots.
4
- *
5
- * @private internal utility of `ptbk coder`
6
- */
7
- export declare const AGENT_CODING_FILE_PATH = "AGENT_CODING.md";
8
- /**
9
- * Returns the default coder `AGENT_CODING.md` quick-reference content.
10
- *
11
- * @private internal utility of `ptbk coder`
12
- */
13
- export declare function getDefaultCoderAgentCodingFileContent(): string_markdown;
@@ -1,29 +0,0 @@
1
- import type { Command as Program } from 'commander';
2
- /**
3
- * Commander option bag for opting out of automatic coding-harness update checks.
4
- *
5
- * @private internal utility of `promptbookCli`
6
- */
7
- export type HarnessUpdateCliOptions = {
8
- readonly harnessUpdate: boolean;
9
- };
10
- /**
11
- * Normalized automatic coding-harness update-check option.
12
- *
13
- * @private internal utility of `promptbookCli`
14
- */
15
- export type NormalizedHarnessUpdateCliOptions = {
16
- readonly isHarnessUpdateCheckEnabled: boolean;
17
- };
18
- /**
19
- * Registers the shared `--no-harness-update` option on a `ptbk coder` command that uses a coding harness.
20
- *
21
- * @private internal utility of `promptbookCli`
22
- */
23
- export declare function addHarnessUpdateOption(command: Program): void;
24
- /**
25
- * Converts the Commander harness-update flag into the normalized harness-check option.
26
- *
27
- * @private internal utility of `promptbookCli`
28
- */
29
- export declare function normalizeHarnessUpdateCliOptions(cliOptions: HarnessUpdateCliOptions): NormalizedHarnessUpdateCliOptions;
@@ -1,13 +0,0 @@
1
- import { string_markdown } from '../../../types/typeAliases';
2
- /**
3
- * Relative path to the Promptbook Coder quick-reference file initialized in project roots.
4
- *
5
- * @private internal utility of `ptbk coder`
6
- */
7
- export declare const AGENT_CODING_FILE_PATH = "AGENT_CODING.md";
8
- /**
9
- * Returns the default coder `AGENT_CODING.md` quick-reference content.
10
- *
11
- * @private internal utility of `ptbk coder`
12
- */
13
- export declare function getDefaultCoderAgentCodingFileContent(): string_markdown;
@@ -1,29 +0,0 @@
1
- import type { Command as Program } from 'commander';
2
- /**
3
- * Commander option bag for opting out of automatic coding-harness update checks.
4
- *
5
- * @private internal utility of `promptbookCli`
6
- */
7
- export type HarnessUpdateCliOptions = {
8
- readonly harnessUpdate: boolean;
9
- };
10
- /**
11
- * Normalized automatic coding-harness update-check option.
12
- *
13
- * @private internal utility of `promptbookCli`
14
- */
15
- export type NormalizedHarnessUpdateCliOptions = {
16
- readonly isHarnessUpdateCheckEnabled: boolean;
17
- };
18
- /**
19
- * Registers the shared `--no-harness-update` option on a `ptbk coder` command that uses a coding harness.
20
- *
21
- * @private internal utility of `promptbookCli`
22
- */
23
- export declare function addHarnessUpdateOption(command: Program): void;
24
- /**
25
- * Converts the Commander harness-update flag into the normalized harness-check option.
26
- *
27
- * @private internal utility of `promptbookCli`
28
- */
29
- export declare function normalizeHarnessUpdateCliOptions(cliOptions: HarnessUpdateCliOptions): NormalizedHarnessUpdateCliOptions;