@promptbook/openai 0.35.0 → 0.36.1

package/umd/typings/types/typeAliases.d.ts

@@ -179,15 +179,15 @@ export type string_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://ptbk.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15"`
+ * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15"`
  */
-export type string_ptbk_url = string;
+export type string_promptbook_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://ptbk.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords"`
+ * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords"`
  */
-export type string_ptbk_url_with_hashtemplate = string;
+export type string_promptbook_url_with_hashtemplate = string;
 /**
  * Semantic helper
  *

package/umd/typings/utils/expectation-counters/countCharacters.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
 /**
  * Counts number of characters in the text
  */

package/umd/typings/utils/expectation-counters/countLines.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
 /**
  * Counts number of lines in the text
  */

package/umd/typings/utils/expectation-counters/countPages.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
 /**
  * Counts number of pages in the text
  */

package/umd/typings/utils/expectation-counters/countParagraphs.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
 /**
  * Counts number of paragraphs in the text
  */

package/umd/typings/utils/expectation-counters/countSentences.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
 /**
  * Counts number of sentences in the text
  */

package/umd/typings/utils/expectation-counters/countWords.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
 /**
  * Counts number of words in the text
  */

package/umd/typings/utils/expectation-counters/index.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount, ExpectationUnit } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+import type { ExpectationAmount, ExpectationUnit } from '../../types/PromptbookJson/PromptTemplateJson';
 /**
  * Index of all counter functions
  */

package/umd/typings/utils/isRunningInWhatever.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Detects if the code is running in a browser environment in main thread (Not in a web worker)
+ */
+export declare const isRunningInBrowser: Function;
+/**
+ * Detects if the code is running in a Node.js environment
+ */
+export declare const isRunningInNode: Function;
+/**
+ * Detects if the code is running in a web worker
+ */
+export declare const isRunningInWebWorker: Function;

package/umd/typings/utils/markdown/addAutoGeneratedSection.d.ts

@@ -0,0 +1,10 @@
+import type { string_markdown, string_name } from '../../types/typeAliases';
+/**
+ * Add or modify an auto-generated section in a markdown file
+ *
+ * @private within the library
+ */
+export declare function addAutoGeneratedSection(content: string_markdown, options: {
+    sectionName: string_name;
+    sectionContent: string_markdown;
+}): string_markdown;

package/umd/typings/utils/markdown/addAutoGeneratedSection.test.d.ts

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

package/umd/typings/utils/markdown/createMarkdownChart.d.ts

@@ -35,3 +35,7 @@ type CreateMarkdownChartOptions = {
  */
 export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
 export {};
+/**
+ * TODO: Maybe use Mermain Gant Diagrams
+ *       @see https://jojozhuang.github.io/tutorial/mermaid-cheat-sheet/
+ */

package/umd/typings/version.d.ts

@@ -2,4 +2,4 @@ import type { string_version } from './types/typeAliases';
 /**
  * The version of the Promptbook library
  */
-export declare const PTBK_VERSION: string_version;
+export declare const PROMPTBOOK_VERSION: string_version;

package/esm/typings/classes/PromptTemplatePipelineLibrary.d.ts

@@ -1,71 +0,0 @@
-import { string_name } from '.././types/typeAliases';
-import { CreatePtpExecutorSettings } from '../execution/createPtpExecutor';
-import { ExecutionTools } from '../execution/ExecutionTools';
-import { PtpExecutor } from '../execution/PtpExecutor';
-import { Prompt } from '../types/Prompt';
-import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
-/**
- * Options for PromptTemplatePipelineLibrary
- */
-type PromptTemplatePipelineLibraryOptions = {
-    /**
-     * The library of prompt template pipelines
-     */
-    readonly library: Record<string_name, PromptTemplatePipelineJson>;
-    /**
-     * Optional settings for creating a PromptTemplatePipelineExecutor
-     */
-    readonly settings?: Partial<CreatePtpExecutorSettings>;
-};
-/**
- * Library of prompt template pipelines that groups together prompt template pipelines for an application. This is a very thin wrapper around the Array / Set of prompt template pipelines.
- *
- * Prompt Template Pipeline library is a useful helper in execution, it can be shared between execution and consumer parts of the app and make common knowledge about prompt template pipelines.
- *
- * It allows to create executor functions from prompt template pipelines in the library.
- *
- * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline-library
- */
-export declare class PromptTemplatePipelineLibrary {
-    readonly options: PromptTemplatePipelineLibraryOptions;
-    /**
-     * Constructs PromptTemplatePipeline from any sources
-     *
-     * Note: During the construction syntax and logic of all sources are validated
-     * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
-     *
-     * @param ptbkSources contents of .ptbk.md or .ptbk.json files
-     * @param settings settings for creating executor functions
-     * @returns PromptTemplatePipelineLibrary
-     */
-    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>, settings?: Partial<CreatePtpExecutorSettings>): PromptTemplatePipelineLibrary;
-    private constructor();
-    /**
-     * Gets prompt template pipeline by name
-     */
-    getPtp(name: string_name): PromptTemplatePipelineJson;
-    /**
-     * Checks whether prompt is in the library
-     */
-    isPromptInLibrary(prompt: Prompt): boolean;
-    /**
-     * Gets executor function for given prompt template pipeline
-     */
-    createExecutor(name: string_name, tools: ExecutionTools): PtpExecutor;
-}
-export {};
-/**
- * TODO: !!! This should be renamed to Promptbook
- * TODO: !! [👐][🧠] Split of PromptTemplatePipeline,PromptTemplatePipelineLibrary between interface and class
- * TODO: !! [👐] Make promptTemplatePipelines private WHEN split between interface and class
- * TODO: [🧠] Maybe isPromptInLibrary should be separate utility function
- * TODO: [🧠] Maybe createExecutor should be separate utility function
- * TODO: Static method fromDirectory
- * TODO: [🤜] Add generic type for entry and result parameters
- * TODO: [🧠] Is it better to ptbkLibrary.executePtp('writeXyz',{...}) OR ptbkLibrary.createExecutor('writeXyz')({...}) OR createExecutor(ptbkLibrary.getPtp('writeXyz'))
- * TODO: [🧠] Formarly (before commit 62229afce7668a5b85077cc18becf798b583bf8d) there were two classes PromptTemplatePipelineLibrary+PtpLibraryExecutor (maybe it was better?)
- * TODO: [🧠] Is it better to pass tools into getExecutor or into constructor
- *             Maybe it is not a good idea to cache executors when they are can be created with different tools
- * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
- */

package/esm/typings/config.d.ts

@@ -1,12 +0,0 @@
-import { ModelRequirements } from './types/ModelRequirements';
-/**
- * Default model requirements for the pipeline
- *
- * Note: As default, we use the chat model gpt-3.5-turbo. For most tasks, this is the best model with most intuitive usage.
- *       GPT-4 is overkill for most tasks so keeping it as opt-in option.
- */
-export declare const DEFAULT_MODEL_REQUIREMENTS: ModelRequirements;
-/**
- * TODO: !!! Different default model for different model variant
- * TODO: [🧠] What should be the default model?
- */

package/esm/typings/conversion/_importPtp.d.ts

@@ -1,12 +0,0 @@
-import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
-/**
- * Import the text file
- *
- * Note: Using here custom import to work in jest tests
- * Note: Using sync version is 💩 in the production code, but it's ok here in tests
- *
- * @private
- */
-export declare function importPtp(path: `${string}.ptbk.md`): PromptTemplatePipelineString;
-export declare function importPtp(path: `${string}.ptbk.json`): PromptTemplatePipelineJson;

package/esm/typings/conversion/promptTemplatePipelineStringToJson.d.ts

@@ -1,13 +0,0 @@
-import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
-/**
- * Parse prompt template pipeline from string format to JSON format
- *
- * Note: This function does not validate logic of the pipeline only the syntax
- */
-export declare function promptTemplatePipelineStringToJson(promptTemplatePipelineString: PromptTemplatePipelineString): PromptTemplatePipelineJson;
-/**
- * TODO: Report here line/column of error
- * TODO: Use spaceTrim more effectively
- * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
- */

package/esm/typings/conversion/validatePromptTemplatePipelineJson.d.ts

@@ -1,26 +0,0 @@
-import type { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-/**
- * Validates PromptTemplatePipelineJson if it is logically valid.
- *
- * It checks:
- * -   if it has correct parameters dependency
- *
- * It does NOT check:
- * -   if it is valid json
- * -   if it is meaningful
- *
- * @param ptp valid or invalid PromptTemplatePipelineJson
- * @throws {Error} if invalid
- */
-export declare function validatePromptTemplatePipelineJson(ptp: PromptTemplatePipelineJson): void;
-/**
- * TODO: [🧠] Work with ptbkVersion
- * TODO: Use here some json-schema, Zod or something similar and change it to:
- *     > /**
- *     >  * Validates PromptTemplatePipelineJson if it is logically valid.
- *     >  *
- *     >  * It checks:
- *     >  * -   it has a valid structure
- *     >  * -   ...
- *     >  ex port function validatePromptTemplatePipelineJson(ptp: unknown): asserts ptp is PromptTemplatePipelineJson {
- */

package/esm/typings/execution/createPtpExecutor.d.ts

@@ -1,40 +0,0 @@
-import { PromptTemplatePipelineJson } from '../_packages/types.index';
-import { ExecutionTools } from './ExecutionTools';
-import { PtpExecutor } from './PtpExecutor';
-export interface CreatePtpExecutorSettings {
-    /**
-     * When executor does not satisfy expectations it will be retried this amount of times
-     *
-     * @default 3
-     */
-    readonly maxExecutionAttempts: number;
-}
-/**
- * Options for creating a PTP (Prompt Template Pipeline) executor
- */
-interface CreatePtpExecutorOptions {
-    /**
-     * The Prompt Template Pipeline (PTP) to be executed
-     */
-    readonly ptp: PromptTemplatePipelineJson;
-    /**
-     * The execution tools to be used during the execution of the PTP
-     */
-    readonly tools: ExecutionTools;
-    /**
-     * Optional settings for the PTP executor
-     */
-    readonly settings?: Partial<CreatePtpExecutorSettings>;
-}
-/**
- * Creates executor function from prompt template pipeline and execution tools.
- *
- * Note: Consider using getExecutor method of the library instead of using this function
- */
-export declare function createPtpExecutor(options: CreatePtpExecutorOptions): PtpExecutor;
-export {};
-/**
- * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
- * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
- * Note: CreatePtpExecutorOptions are just connected to PtpExecutor so do not extract to types folder
- */

package/esm/typings/types/PromptTemplatePipelineString.d.ts

@@ -1,16 +0,0 @@
-/**
- * Prompt template pipeline is the **core concept of this library**.
- * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
- *
- * It can have 3 formats:
- * -   _(this)_ **.ptbk.md file** in custom markdown format described above
- * -   **JSON** format, parsed from the .ptbk.md file
- *
- * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline
- */
-export type PromptTemplatePipelineString = string & {
-    readonly _type: 'PromptTemplatePipeline';
-};
-/**
- * TODO: !! Better validation (validatePromptTemplatePipelineString) or remove branded type and make it just string
- */ 

package/umd/typings/classes/PromptTemplatePipelineLibrary.d.ts

@@ -1,71 +0,0 @@
-import { string_name } from '.././types/typeAliases';
-import { CreatePtpExecutorSettings } from '../execution/createPtpExecutor';
-import { ExecutionTools } from '../execution/ExecutionTools';
-import { PtpExecutor } from '../execution/PtpExecutor';
-import { Prompt } from '../types/Prompt';
-import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
-/**
- * Options for PromptTemplatePipelineLibrary
- */
-type PromptTemplatePipelineLibraryOptions = {
-    /**
-     * The library of prompt template pipelines
-     */
-    readonly library: Record<string_name, PromptTemplatePipelineJson>;
-    /**
-     * Optional settings for creating a PromptTemplatePipelineExecutor
-     */
-    readonly settings?: Partial<CreatePtpExecutorSettings>;
-};
-/**
- * Library of prompt template pipelines that groups together prompt template pipelines for an application. This is a very thin wrapper around the Array / Set of prompt template pipelines.
- *
- * Prompt Template Pipeline library is a useful helper in execution, it can be shared between execution and consumer parts of the app and make common knowledge about prompt template pipelines.
- *
- * It allows to create executor functions from prompt template pipelines in the library.
- *
- * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline-library
- */
-export declare class PromptTemplatePipelineLibrary {
-    readonly options: PromptTemplatePipelineLibraryOptions;
-    /**
-     * Constructs PromptTemplatePipeline from any sources
-     *
-     * Note: During the construction syntax and logic of all sources are validated
-     * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
-     *
-     * @param ptbkSources contents of .ptbk.md or .ptbk.json files
-     * @param settings settings for creating executor functions
-     * @returns PromptTemplatePipelineLibrary
-     */
-    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>, settings?: Partial<CreatePtpExecutorSettings>): PromptTemplatePipelineLibrary;
-    private constructor();
-    /**
-     * Gets prompt template pipeline by name
-     */
-    getPtp(name: string_name): PromptTemplatePipelineJson;
-    /**
-     * Checks whether prompt is in the library
-     */
-    isPromptInLibrary(prompt: Prompt): boolean;
-    /**
-     * Gets executor function for given prompt template pipeline
-     */
-    createExecutor(name: string_name, tools: ExecutionTools): PtpExecutor;
-}
-export {};
-/**
- * TODO: !!! This should be renamed to Promptbook
- * TODO: !! [👐][🧠] Split of PromptTemplatePipeline,PromptTemplatePipelineLibrary between interface and class
- * TODO: !! [👐] Make promptTemplatePipelines private WHEN split between interface and class
- * TODO: [🧠] Maybe isPromptInLibrary should be separate utility function
- * TODO: [🧠] Maybe createExecutor should be separate utility function
- * TODO: Static method fromDirectory
- * TODO: [🤜] Add generic type for entry and result parameters
- * TODO: [🧠] Is it better to ptbkLibrary.executePtp('writeXyz',{...}) OR ptbkLibrary.createExecutor('writeXyz')({...}) OR createExecutor(ptbkLibrary.getPtp('writeXyz'))
- * TODO: [🧠] Formarly (before commit 62229afce7668a5b85077cc18becf798b583bf8d) there were two classes PromptTemplatePipelineLibrary+PtpLibraryExecutor (maybe it was better?)
- * TODO: [🧠] Is it better to pass tools into getExecutor or into constructor
- *             Maybe it is not a good idea to cache executors when they are can be created with different tools
- * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
- */

package/umd/typings/config.d.ts

@@ -1,12 +0,0 @@
-import { ModelRequirements } from './types/ModelRequirements';
-/**
- * Default model requirements for the pipeline
- *
- * Note: As default, we use the chat model gpt-3.5-turbo. For most tasks, this is the best model with most intuitive usage.
- *       GPT-4 is overkill for most tasks so keeping it as opt-in option.
- */
-export declare const DEFAULT_MODEL_REQUIREMENTS: ModelRequirements;
-/**
- * TODO: !!! Different default model for different model variant
- * TODO: [🧠] What should be the default model?
- */

package/umd/typings/conversion/_importPtp.d.ts

@@ -1,12 +0,0 @@
-import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
-/**
- * Import the text file
- *
- * Note: Using here custom import to work in jest tests
- * Note: Using sync version is 💩 in the production code, but it's ok here in tests
- *
- * @private
- */
-export declare function importPtp(path: `${string}.ptbk.md`): PromptTemplatePipelineString;
-export declare function importPtp(path: `${string}.ptbk.json`): PromptTemplatePipelineJson;

package/umd/typings/conversion/promptTemplatePipelineStringToJson.d.ts

@@ -1,13 +0,0 @@
-import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
-/**
- * Parse prompt template pipeline from string format to JSON format
- *
- * Note: This function does not validate logic of the pipeline only the syntax
- */
-export declare function promptTemplatePipelineStringToJson(promptTemplatePipelineString: PromptTemplatePipelineString): PromptTemplatePipelineJson;
-/**
- * TODO: Report here line/column of error
- * TODO: Use spaceTrim more effectively
- * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
- */

package/umd/typings/conversion/validatePromptTemplatePipelineJson.d.ts

@@ -1,26 +0,0 @@
-import type { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-/**
- * Validates PromptTemplatePipelineJson if it is logically valid.
- *
- * It checks:
- * -   if it has correct parameters dependency
- *
- * It does NOT check:
- * -   if it is valid json
- * -   if it is meaningful
- *
- * @param ptp valid or invalid PromptTemplatePipelineJson
- * @throws {Error} if invalid
- */
-export declare function validatePromptTemplatePipelineJson(ptp: PromptTemplatePipelineJson): void;
-/**
- * TODO: [🧠] Work with ptbkVersion
- * TODO: Use here some json-schema, Zod or something similar and change it to:
- *     > /**
- *     >  * Validates PromptTemplatePipelineJson if it is logically valid.
- *     >  *
- *     >  * It checks:
- *     >  * -   it has a valid structure
- *     >  * -   ...
- *     >  ex port function validatePromptTemplatePipelineJson(ptp: unknown): asserts ptp is PromptTemplatePipelineJson {
- */

package/umd/typings/execution/createPtpExecutor.d.ts

@@ -1,40 +0,0 @@
-import { PromptTemplatePipelineJson } from '../_packages/types.index';
-import { ExecutionTools } from './ExecutionTools';
-import { PtpExecutor } from './PtpExecutor';
-export interface CreatePtpExecutorSettings {
-    /**
-     * When executor does not satisfy expectations it will be retried this amount of times
-     *
-     * @default 3
-     */
-    readonly maxExecutionAttempts: number;
-}
-/**
- * Options for creating a PTP (Prompt Template Pipeline) executor
- */
-interface CreatePtpExecutorOptions {
-    /**
-     * The Prompt Template Pipeline (PTP) to be executed
-     */
-    readonly ptp: PromptTemplatePipelineJson;
-    /**
-     * The execution tools to be used during the execution of the PTP
-     */
-    readonly tools: ExecutionTools;
-    /**
-     * Optional settings for the PTP executor
-     */
-    readonly settings?: Partial<CreatePtpExecutorSettings>;
-}
-/**
- * Creates executor function from prompt template pipeline and execution tools.
- *
- * Note: Consider using getExecutor method of the library instead of using this function
- */
-export declare function createPtpExecutor(options: CreatePtpExecutorOptions): PtpExecutor;
-export {};
-/**
- * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
- * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
- * Note: CreatePtpExecutorOptions are just connected to PtpExecutor so do not extract to types folder
- */

package/umd/typings/types/PromptTemplatePipelineString.d.ts

@@ -1,16 +0,0 @@
-/**
- * Prompt template pipeline is the **core concept of this library**.
- * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
- *
- * It can have 3 formats:
- * -   _(this)_ **.ptbk.md file** in custom markdown format described above
- * -   **JSON** format, parsed from the .ptbk.md file
- *
- * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline
- */
-export type PromptTemplatePipelineString = string & {
-    readonly _type: 'PromptTemplatePipeline';
-};
-/**
- * TODO: !! Better validation (validatePromptTemplatePipelineString) or remove branded type and make it just string
- */