@promptbook/types 0.72.0-32 → 0.72.0-34

package/README.md

@@ -77,15 +77,15 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 
 
-If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 2, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
+If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 3, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
 
-But often you will struggle with the limitations of LLMs, such as hallucinations, off-topic responses, poor quality output, language drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses. When this happens, you generally have three options:
+But often you will struggle with the **limitations of LLMs**, such as **hallucinations, off-topic responses, poor quality output, language and prompt drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses**. When this happens, you generally have three options:
 
 1. **Fine-tune** the model to your specifications or even train your own.
 2. **Prompt-engineer** the prompt to the best shape you can achieve.
 3. Orchestrate **multiple prompts** in a [pipeline](https://github.com/webgptorg/promptbook/discussions/64) to get the best result.
 
-In all of these situations, but especially in 3., the Promptbook library can make your life easier.
+In all of these situations, but especially in 3., the **✨ Promptbook can make your life waaaaaaaaaay easier**.
 
 -   [**Separates concerns**](https://github.com/webgptorg/promptbook/discussions/32) between prompt-engineer and programmer, between code files and prompt files, and between prompts and their execution logic.
 -   Establishes a [**common format `.ptbk.md`**](https://github.com/webgptorg/promptbook/discussions/85) that can be used to describe your prompt business logic without having to write code or deal with the technicalities of LLMs.

package/esm/typings/src/executables/apps/locateLibreoffice.d.ts

@@ -4,7 +4,7 @@ import type { string_executable_path } from '../../types/typeAliases';
  *
  * @private within the repository
  */
-export declare function locateLibreoffice(): Promise<string_executable_path>;
+export declare function locateLibreoffice(): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/apps/locatePandoc.d.ts

@@ -4,7 +4,7 @@ import type { string_executable_path } from '../../types/typeAliases';
  *
  * @private within the repository
  */
-export declare function locatePandoc(): Promise<string_executable_path>;
+export declare function locatePandoc(): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/locateApp.d.ts

@@ -26,7 +26,7 @@ export interface LocateAppOptions {
  *
  * @private within the repository
  */
-export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path>;
+export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts

@@ -1,11 +1,11 @@
-import type { LocateAppOptions } from '../locateApp';
 import type { string_executable_path } from '../../types/typeAliases';
+import type { LocateAppOptions } from '../locateApp';
 /**
  * @@@
  *
  * @private within the repository
  */
-export declare function locateAppOnLinux({ appName, linuxWhich, }: Pick<Required<LocateAppOptions>, 'appName' | 'linuxWhich'>): Promise<string_executable_path>;
+export declare function locateAppOnLinux({ appName, linuxWhich, }: Pick<Required<LocateAppOptions>, 'appName' | 'linuxWhich'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts

@@ -5,7 +5,7 @@ import type { LocateAppOptions } from '../locateApp';
  *
  * @private within the repository
  */
-export declare function locateAppOnMacOs({ appName, macOsName, }: Pick<Required<LocateAppOptions>, 'appName' | 'macOsName'>): Promise<string_executable_path>;
+export declare function locateAppOnMacOs({ appName, macOsName, }: Pick<Required<LocateAppOptions>, 'appName' | 'macOsName'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts

@@ -5,7 +5,7 @@ import type { LocateAppOptions } from '../locateApp';
  *
  * @private within the repository
  */
-export declare function locateAppOnWindows({ appName, windowsSuffix, }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path>;
+export declare function locateAppOnWindows({ appName, windowsSuffix, }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/utils/execCommand/$execCommand.d.ts

@@ -2,9 +2,11 @@ import type { ExecCommandOptions } from './ExecCommandOptions';
 /**
  * Run one command in a shell
  *
+ *
  * Note: There are 2 similar functions in the codebase:
  * - `$execCommand` which runs a single command
  * - `$execCommands` which runs multiple commands
+ * Note: `$` is used to indicate that this function is not a pure function - it runs a command in a shell
  *
  * @public exported from `@promptbook/node`
  */

package/esm/typings/src/utils/execCommand/{execCommandNormalizeOptions.d.ts → $execCommandNormalizeOptions.d.ts}

@@ -3,8 +3,10 @@ import type { ExecCommandOptionsAdvanced } from './ExecCommandOptions';
 /**
  * Normalize options for `execCommand` and `execCommands`
  *
+ * Note: `$` is used to indicate that this function behaves differently according to `process.platform`
+ *
  * @private internal utility of `execCommand` and `execCommands`
  */
-export declare function execCommandNormalizeOptions(options: ExecCommandOptions): Pick<ExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout'> & {
+export declare function $execCommandNormalizeOptions(options: ExecCommandOptions): Pick<ExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'> & {
     humanReadableCommand: string;
 };

package/esm/typings/src/utils/execCommand/$execCommands.d.ts

@@ -4,6 +4,7 @@
  * Note: There are 2 similar functions in the codebase:
  * - `$execCommand` which runs a single command
  * - `$execCommands` which runs multiple commands
+ * Note: `$` is used to indicate that this function is not a pure function - it runs a commands in a shell
  *
  * @public exported from `@promptbook/node`
  */

package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts

@@ -5,15 +5,41 @@ type RequiredAndOptional<TBase, TRequired extends keyof TBase, TOptional extends
 /**
  * Simple options for `execCommand`
  */
-export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout'>;
+export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'>;
 /**
  * Advanced options for `execCommand`
  */
 export type ExecCommandOptionsAdvanced = {
+    /**
+     * Command to run
+     */
     readonly command: string;
+    /**
+     * Arguments for the command
+     */
     readonly args: string[];
+    /**
+     * Current working directory
+     *
+     * @default process.cwd()
+     */
     readonly cwd: string;
+    /**
+     * If `true` then the command will throw an error if the return code is not `0`
+     */
     readonly crashOnError: boolean;
+    /**
+     * Timeout in milliseconds
+     */
     readonly timeout: number;
+    /**
+     * If `true` then the command and entire CLI output will be logged to the console
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
 };
 export {};
+/**
+ * TODO: [⏳] Make DEFAULT_TIMEOUT_MS as global constant
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.72.0-32",
+    "version": "0.72.0-34",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -50,6 +50,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.72.0-32"
+        "@promptbook/core": "0.72.0-34"
     }
 }