@promptbook/javascript 0.112.0-36 → 0.112.0-39

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

@@ -0,0 +1,7 @@
+import type { InitializationStatus } from './boilerplateTemplates';
+/**
+ * Ensures `.gitignore` contains the standalone Promptbook coder cache entry.
+ *
+ * @private function of `initializeCoderProjectConfiguration`
+ */
+export declare function ensureCoderGitignoreFile(projectPath: string): Promise<InitializationStatus>;

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

@@ -0,0 +1,7 @@
+import type { InitializationStatus } from './boilerplateTemplates';
+/**
+ * Ensures one coder markdown file exists with the provided default boilerplate.
+ *
+ * @private function of `initializeCoderProjectConfiguration`
+ */
+export declare function ensureCoderMarkdownFile(projectPath: string, relativeFilePath: string, fileContent: string): Promise<InitializationStatus>;

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

@@ -0,0 +1,7 @@
+import type { InitializationStatus } from './boilerplateTemplates';
+/**
+ * Ensures `package.json` contains the standalone Promptbook coder helper scripts.
+ *
+ * @private function of `initializeCoderProjectConfiguration`
+ */
+export declare function ensureCoderPackageJsonFile(projectPath: string): Promise<InitializationStatus>;

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

@@ -0,0 +1,7 @@
+import type { InitializationStatus } from './boilerplateTemplates';
+/**
+ * Ensures VS Code routes pasted prompt images into `prompts/screenshots`.
+ *
+ * @private function of `initializeCoderProjectConfiguration`
+ */
+export declare function ensureCoderVscodeSettingsFile(projectPath: string): Promise<InitializationStatus>;

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

@@ -0,0 +1,7 @@
+import type { InitializationStatus } from './boilerplateTemplates';
+/**
+ * Ensures a relative directory exists in the project root.
+ *
+ * @private function of `initializeCoderProjectConfiguration`
+ */
+export declare function ensureDirectory(projectPath: string, relativeDirectoryPath: string): Promise<InitializationStatus>;

package/esm/src/cli/cli-commands/coder/find-refactor-candidates.d.ts

@@ -1,4 +1,4 @@
-import type { Command as Program } from 'commander';
+import { Command as Program } from 'commander';
 import type { $side_effect } from '../../../utils/organization/$side_effect';
 /**
  * Initializes `coder find-refactor-candidates` command for Promptbook CLI utilities

package/esm/src/cli/cli-commands/coder/find-refactor-candidates.test.d.ts

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

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

@@ -0,0 +1,6 @@
+/**
+ * Normalizes one project-relative path for human-readable CLI output and markdown.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function formatDisplayPath(relativePath: string): string;

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

@@ -0,0 +1,6 @@
+/**
+ * Lists the default npm scripts initialized by `ptbk coder init`.
+ *
+ * @private internal utility of `coder init` command
+ */
+export declare function getDefaultCoderPackageJsonScripts(): Readonly<Record<string, string>>;

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

@@ -0,0 +1,6 @@
+/**
+ * Lists the default VS Code settings initialized by `ptbk coder init`.
+ *
+ * @private internal utility of `coder init` command
+ */
+export declare function getDefaultCoderVscodeSettings(): Readonly<Record<string, Readonly<Record<string, string>>>>;

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

@@ -1,24 +1,8 @@
 import type { Command as Program } from 'commander';
 import type { $side_effect } from '../../../utils/organization/$side_effect';
-import { type EnsuredCoderPromptTemplateFile, type InitializationStatus } from './boilerplateTemplates';
-/**
- * Generic JSON object used for standalone coder configuration files.
- */
-type JsonObject = Record<string, unknown>;
-/**
- * Result summary returned after coder configuration initialization.
- */
-type CoderInitializationSummary = {
-    readonly promptsDirectoryStatus: InitializationStatus;
-    readonly promptsDoneDirectoryStatus: InitializationStatus;
-    readonly promptsTemplatesDirectoryStatus: InitializationStatus;
-    readonly promptTemplateFileStatuses: ReadonlyArray<EnsuredCoderPromptTemplateFile>;
-    readonly envFileStatus: InitializationStatus;
-    readonly gitignoreFileStatus: InitializationStatus;
-    readonly packageJsonFileStatus: InitializationStatus;
-    readonly vscodeSettingsFileStatus: InitializationStatus;
-    readonly initializedEnvVariableNames: ReadonlyArray<string>;
-};
+export { getDefaultCoderPackageJsonScripts } from './getDefaultCoderPackageJsonScripts';
+export { getDefaultCoderVscodeSettings } from './getDefaultCoderVscodeSettings';
+export { initializeCoderProjectConfiguration } from './initializeCoderProjectConfiguration';
 /**
  * Initializes `coder init` command for Promptbook CLI utilities.
  *
@@ -27,22 +11,3 @@ type CoderInitializationSummary = {
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeCoderInitCommand(program: Program): $side_effect;
-/**
- * Lists the default npm scripts initialized by `ptbk coder init`.
- *
- * @private internal utility of `coder init` command
- */
-export declare function getDefaultCoderPackageJsonScripts(): Readonly<Record<string, string>>;
-/**
- * Lists the default VS Code settings initialized by `ptbk coder init`.
- *
- * @private internal utility of `coder init` command
- */
-export declare function getDefaultCoderVscodeSettings(): Readonly<JsonObject>;
-/**
- * Creates or updates all coder configuration artifacts required in the current project.
- *
- * @private internal utility of `coder init` command
- */
-export declare function initializeCoderProjectConfiguration(projectPath: string): Promise<CoderInitializationSummary>;
-export {};

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

@@ -0,0 +1,25 @@
+import { type EnsuredCoderPromptTemplateFile, type InitializationStatus } from './boilerplateTemplates';
+/**
+ * Result summary returned after coder configuration initialization.
+ *
+ * @private internal utility of `coder init` command
+ */
+export type CoderInitializationSummary = {
+    readonly promptsDirectoryStatus: InitializationStatus;
+    readonly promptsDoneDirectoryStatus: InitializationStatus;
+    readonly promptsTemplatesDirectoryStatus: InitializationStatus;
+    readonly promptTemplateFileStatuses: ReadonlyArray<EnsuredCoderPromptTemplateFile>;
+    readonly agentsFileStatus: InitializationStatus;
+    readonly agentCodingFileStatus: InitializationStatus;
+    readonly envFileStatus: InitializationStatus;
+    readonly gitignoreFileStatus: InitializationStatus;
+    readonly packageJsonFileStatus: InitializationStatus;
+    readonly vscodeSettingsFileStatus: InitializationStatus;
+    readonly initializedEnvVariableNames: ReadonlyArray<string>;
+};
+/**
+ * Creates or updates all coder configuration artifacts required in the current project.
+ *
+ * @private internal utility of `coder init` command
+ */
+export declare function initializeCoderProjectConfiguration(projectPath: string): Promise<CoderInitializationSummary>;

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

@@ -0,0 +1,18 @@
+import type { InitializationStatus } from './boilerplateTemplates';
+/**
+ * Parameters controlling one string-record merge into a JSON file.
+ */
+type MergeStringRecordJsonFileOptions = {
+    readonly projectPath: string;
+    readonly relativeFilePath: string;
+    readonly fieldPath: string;
+    readonly nextEntries: Readonly<Record<string, string>>;
+    readonly ensureParentDirectoryPath?: string;
+};
+/**
+ * Ensures one JSON object field contains the provided string-record entries.
+ *
+ * @private function of `initializeCoderProjectConfiguration`
+ */
+export declare function mergeStringRecordJsonFile({ projectPath, relativeFilePath, fieldPath, nextEntries, ensureParentDirectoryPath, }: MergeStringRecordJsonFileOptions): Promise<InitializationStatus>;
+export {};

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

@@ -0,0 +1,7 @@
+import type { CoderInitializationSummary } from './initializeCoderProjectConfiguration';
+/**
+ * Prints a readable summary of what was initialized for the user.
+ *
+ * @private function of `coder init` command
+ */
+export declare function printInitializationSummary(summary: CoderInitializationSummary): void;

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

@@ -0,0 +1,6 @@
+/**
+ * Reads one text file when it exists, otherwise returns `undefined`.
+ *
+ * @private function of `initializeCoderProjectConfiguration`
+ */
+export declare function readTextFileIfExists(path: string): Promise<string | undefined>;

package/esm/src/types/string_agent_url.d.ts

@@ -0,0 +1,7 @@
+import type { string_agent_url_private } from './string_agent_url_private';
+/**
+ * Semantic helper
+ *
+ * For example `"https://s6.ptbk.io/agents/agent-007"`
+ */
+export type string_agent_url = string_agent_url_private;

package/esm/src/types/string_agent_url_private.d.ts

@@ -0,0 +1,9 @@
+import type { string_url_private } from './string_url_private';
+/**
+ * Semantic helper
+ *
+ * For example `"https://s6.ptbk.io/agents/agent-007"`
+ *
+ * @private internal utility of `string_agent_url.ts`
+ */
+export type string_agent_url_private = string_url_private;

package/esm/src/types/string_base64.d.ts

@@ -0,0 +1,13 @@
+import type { string_base64_private, string_data_url_private } from './string_base64_private';
+/**
+ * Semantic helper
+ *
+ * For example `"SGVsbG8sIFdvcmxkIQ=="`
+ */
+export type string_base64 = string_base64_private;
+/**
+ * Semantic helper
+ *
+ * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
+ */
+export type string_data_url = string_data_url_private;

package/esm/src/types/string_base64_private.d.ts

@@ -4,7 +4,7 @@ import type { string_mime_type_private } from './string_mime_type_private';
  *
  * For example `"SGVsbG8sIFdvcmxkIQ=="`
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_base64.ts`
  */
 export type string_base64_private = string;
 /**
@@ -12,6 +12,6 @@ export type string_base64_private = string;
  *
  * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_base64.ts`
  */
 export type string_data_url_private = `data:${string_mime_type_private};base64,${string_base64_private}`;

package/esm/src/types/string_base_url.d.ts

@@ -0,0 +1,7 @@
+import type { string_base_url_private } from './string_base_url_private';
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com"`
+ */
+export type string_base_url = string_base_url_private;

package/esm/src/types/string_base_url_private.d.ts

@@ -0,0 +1,9 @@
+import type { string_url_private } from './string_url_private';
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com"`
+ *
+ * @private internal utility of `string_base_url.ts`
+ */
+export type string_base_url_private = string_url_private;

package/esm/src/types/string_email.d.ts

@@ -0,0 +1,13 @@
+import type { string_email_private, string_emails_private } from './string_email_private';
+/**
+ * Semantic helper
+ *
+ * For example `"pavol@hejny.org"`
+ */
+export type string_email = string_email_private;
+/**
+ * Semantic helper
+ *
+ * For example `"pavol@hejny.org, jirka@webgpt.cz"`
+ */
+export type string_emails = string_emails_private;

package/esm/src/types/string_email_private.d.ts

@@ -3,7 +3,7 @@
  *
  * For example `"pavol@hejny.org"`
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_email.ts`
  */
 export type string_email_private = string;
 /**
@@ -11,6 +11,6 @@ export type string_email_private = string;
  *
  * For example `"pavol@hejny.org, jirka@webgpt.cz"`
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_email.ts`
  */
 export type string_emails_private = string;

package/esm/src/types/string_host.d.ts

@@ -0,0 +1,42 @@
+import type { string_domain_private, string_host_private, string_hostname_private, string_ip_address_private, string_origin_private, string_protocol_private, string_tdl_private } from './string_host_private';
+/**
+ * Semantic helper
+ *
+ * For example `"towns.cz"`
+ */
+export type string_domain = string_domain_private;
+/**
+ * Semantic helper
+ *
+ * For example `"https://*.pavolhejny.com/*"`
+ */
+export type string_origin = string_origin_private;
+/**
+ * Semantic helper
+ *
+ * For example `"com"`
+ */
+export type string_tdl = string_tdl_private;
+/**
+ * Semantic helper
+ *
+ * For example `"localhost"` or `"collboard.com"`
+ */
+export type string_hostname = string_hostname_private;
+/**
+ * Semantic helper
+ *
+ * For example `"localhost:9977"` or `"collboard.com"`
+ */
+export type string_host = string_host_private;
+/**
+ * Semantic helper
+ */
+export type string_protocol = string_protocol_private;
+/**
+ * Semantic helper
+ *
+ * For example `"192.168.1.1"` (IPv4)
+ * For example `"2001:0db8:85a3:0000:0000:8a2e:0370:7334"` (IPv6)
+ */
+export type string_ip_address = string_ip_address_private;

package/esm/src/types/string_host_private.d.ts

@@ -3,7 +3,7 @@
  *
  * For example `"towns.cz"`
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_host.ts`
  */
 export type string_domain_private = string;
 /**
@@ -11,7 +11,7 @@ export type string_domain_private = string;
  *
  * For example `"https://*.pavolhejny.com/*"`
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_host.ts`
  */
 export type string_origin_private = string;
 /**
@@ -19,7 +19,7 @@ export type string_origin_private = string;
  *
  * For example `"com"`
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_host.ts`
  */
 export type string_tdl_private = string;
 /**
@@ -27,7 +27,7 @@ export type string_tdl_private = string;
  *
  * For example `"localhost"` or `"collboard.com"`
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_host.ts`
  */
 export type string_hostname_private = string;
 /**
@@ -35,13 +35,13 @@ export type string_hostname_private = string;
  *
  * For example `"localhost:9977"` or `"collboard.com"`
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_host.ts`
  */
 export type string_host_private = string;
 /**
  * Semantic helper
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_host.ts`
  */
 export type string_protocol_private = 'http:' | 'https:';
 /**
@@ -50,6 +50,6 @@ export type string_protocol_private = 'http:' | 'https:';
  * For example `"192.168.1.1"` (IPv4)
  * For example `"2001:0db8:85a3:0000:0000:8a2e:0370:7334"` (IPv6)
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_host.ts`
  */
 export type string_ip_address_private = string;

package/esm/src/types/string_href.d.ts

@@ -0,0 +1,19 @@
+import type { string_href_private, string_uri_part_private, string_uri_private } from './string_href_private';
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"` OR `/9SeSQTupmQHwuSrLi`
+ */
+export type string_href = string_href_private;
+/**
+ * Semantic helper
+ *
+ * For example `"/9SeSQTupmQHwuSrLi"`
+ */
+export type string_uri = string_uri_private;
+/**
+ * Semantic helper
+ *
+ * For example `"9SeSQTupmQHwuSrLi"`
+ */
+export type string_uri_part = string_uri_part_private;

package/esm/src/types/string_href_private.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"` OR `/9SeSQTupmQHwuSrLi`
+ *
+ * @private internal utility of `string_href.ts`
+ */
+export type string_href_private = string;
+/**
+ * Semantic helper
+ *
+ * For example `"/9SeSQTupmQHwuSrLi"`
+ *
+ * @private internal utility of `string_href.ts`
+ */
+export type string_uri_private = string;
+/**
+ * Semantic helper
+ *
+ * For example `"9SeSQTupmQHwuSrLi"`
+ *
+ * @private internal utility of `string_href.ts`
+ */
+export type string_uri_part_private = string;

package/esm/src/types/string_mime_type.d.ts

@@ -0,0 +1,15 @@
+import type { string_mime_type_private, string_mime_type_with_wildcard_private } from './string_mime_type_private';
+/**
+ * Semantic helper
+ *
+ * For example `"text/plain"` or `"application/collboard"`
+ */
+export type string_mime_type = string_mime_type_private;
+/**
+ * Semantic helper
+ *
+ * For example `"text/*"` or `"image/*"`
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#unique_file_type_specifiers
+ */
+export type string_mime_type_with_wildcard = string_mime_type_with_wildcard_private;

package/esm/src/types/string_mime_type_private.d.ts

@@ -3,7 +3,7 @@
  *
  * For example `"text/plain"` or `"application/collboard"`
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_mime_type.ts`
  */
 export type string_mime_type_private = string;
 /**
@@ -13,6 +13,6 @@ export type string_mime_type_private = string;
  *
  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#unique_file_type_specifiers
  *
- * @private internal utility of `string_url.ts`
+ * @private internal utility of `string_mime_type.ts`
  */
 export type string_mime_type_with_wildcard_private = string;

package/esm/src/types/string_pipeline_root_url.d.ts

@@ -0,0 +1,7 @@
+import type { string_pipeline_root_url_private } from './string_pipeline_root_url_private';
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/"`
+ */
+export type string_pipeline_root_url = string_pipeline_root_url_private;

package/esm/src/types/string_pipeline_root_url_private.d.ts

@@ -0,0 +1,9 @@
+import type { string_url_private } from './string_url_private';
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/"`
+ *
+ * @private internal utility of `string_pipeline_root_url.ts`
+ */
+export type string_pipeline_root_url_private = string_url_private;

package/esm/src/types/string_pipeline_url.d.ts

@@ -0,0 +1,13 @@
+import type { string_pipeline_url_private, string_pipeline_url_with_task_hash_private } from './string_pipeline_url_private';
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book"`
+ */
+export type string_pipeline_url = string_pipeline_url_private;
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book#keywords"`
+ */
+export type string_pipeline_url_with_task_hash = string_pipeline_url_with_task_hash_private;

package/esm/src/types/string_pipeline_url_private.d.ts

@@ -0,0 +1,17 @@
+import type { string_url_private } from './string_url_private';
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book"`
+ *
+ * @private internal utility of `string_pipeline_url.ts`
+ */
+export type string_pipeline_url_private = string_url_private;
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book#keywords"`
+ *
+ * @private internal utility of `string_pipeline_url.ts`
+ */
+export type string_pipeline_url_with_task_hash_private = string_pipeline_url_private;

package/esm/src/types/string_promptbook_server_url.d.ts

@@ -0,0 +1,7 @@
+import type { string_promptbook_server_url_private } from './string_promptbook_server_url_private';
+/**
+ * Semantic helper
+ *
+ * For example `"https://s1.ptbk.io/promptbook"`
+ */
+export type string_promptbook_server_url = string_promptbook_server_url_private;

package/esm/src/types/string_promptbook_server_url_private.d.ts

@@ -0,0 +1,9 @@
+import type { string_url_private } from './string_url_private';
+/**
+ * Semantic helper
+ *
+ * For example `"https://s1.ptbk.io/promptbook"`
+ *
+ * @private internal utility of `string_promptbook_server_url.ts`
+ */
+export type string_promptbook_server_url_private = string_url_private;