@promptbook/openai 0.35.1 → 0.36.2

package/README.md

@@ -1,4 +1,4 @@
-# 📖 Prompt template pipelines
+# 📖 Promptbook
 
 Library to supercharge your use of large language models
 

package/esm/index.es.js

@@ -93,7 +93,7 @@ function computeOpenaiUsage(rawResponse) {
             completion: 0.002,
         },
         'gpt-4-0613': {
-            // TODO: !!! Not sure if this is correct
+            // TODO: Not sure if this is correct
             prompt: 0.01,
             completion: 0.03,
         },

package/esm/typings/_packages/core.index.d.ts

@@ -1,16 +1,16 @@
-import { PromptTemplatePipelineLibrary } from '../classes/PromptTemplatePipelineLibrary';
-import { PTBK_VERSION } from '../version';
-import { promptTemplatePipelineStringToJson } from '../conversion/promptTemplatePipelineStringToJson';
-import { validatePromptTemplatePipelineJson } from '../conversion/validatePromptTemplatePipelineJson';
-import { createPtpExecutor } from '../execution/createPtpExecutor';
+import { PromptbookLibrary } from '../classes/PromptbookLibrary';
+import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
+import { validatePromptbookJson } from '../conversion/validatePromptbookJson';
+import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { MockedEchoNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools';
 import { CallbackInterfaceTools } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools';
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
 import { ExecutionTypes } from '../types/ExecutionTypes';
-export { ExecutionTypes, PTBK_VERSION, PromptTemplatePipelineLibrary };
+import { PROMPTBOOK_VERSION } from '../version';
+export { ExecutionTypes, PROMPTBOOK_VERSION, PromptbookLibrary };
 export { SimplePromptInterfaceTools };
-export { promptTemplatePipelineStringToJson, validatePromptTemplatePipelineJson };
+export { promptbookStringToJson, validatePromptbookJson };
 export { MockedEchoNaturalExecutionTools };
-export { createPtpExecutor };
+export { createPromptbookExecutor };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };

package/esm/typings/_packages/remote-server.index.d.ts

@@ -1,3 +1,3 @@
 import { RemoteServerOptions } from '../execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions';
-import { runRemoteServer } from '../execution/plugins/natural-execution-tools/remote/runRemoteServer';
-export { RemoteServerOptions, runRemoteServer };
+import { startRemoteServer } from '../execution/plugins/natural-execution-tools/remote/startRemoteServer';
+export { RemoteServerOptions, startRemoteServer };

package/esm/typings/_packages/types.index.d.ts

@@ -2,24 +2,24 @@ import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionTo
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { NaturalExecutionTools } from '../execution/NaturalExecutionTools';
 import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult } from '../execution/PromptResult';
-import type { PtpExecutor } from '../execution/PtpExecutor';
+import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
 import type { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
 import type { ExecutionType } from '../types/ExecutionTypes';
 import type { ModelRequirements, ModelVariant } from '../types/ModelRequirements';
 import type { Parameters } from '../types/Parameters';
 import type { Prompt } from '../types/Prompt';
-import type { EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, PromptTemplateJson } from '../types/PromptTemplatePipelineJson/PromptTemplateJson';
-import type { PromptTemplateParameterJson } from '../types/PromptTemplatePipelineJson/PromptTemplateParameterJson';
-import type { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-import type { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
+import type { EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, PromptTemplateJson } from '../types/PromptbookJson/PromptTemplateJson';
+import type { PromptTemplateParameterJson } from '../types/PromptbookJson/PromptTemplateParameterJson';
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookString } from '../types/PromptbookString';
 import type { ScriptLanguage } from '../types/ScriptLanguage';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
 import type { string_char_emoji } from '../types/typeAliasEmoji';
-import type { ILicense, IPersonProfile, IRepository, client_id, number_bytes, number_days, number_gigabytes, number_hours, number_integer, number_kilobytes, number_likeness, number_megabytes, number_miliseconds, number_minutes, number_months, number_negative, number_percent, number_positive, number_seconds, number_terabytes, number_weeks, number_years, string_attribute, string_attribute_value_scope, string_business_category_name, string_char, string_chat_prompt, string_color, string_completion_prompt, string_css, string_css_class, string_css_property, string_css_selector, string_css_value, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_license_token, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_page, string_password, string_person_fullname, string_person_profile, string_pgp_key, string_prompt, string_protocol, string_ptbk_url, string_ptbk_url_with_hashtemplate, string_script, string_sha256, string_ssh_key, string_svg, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_translate_name, string_translate_name_not_normalized, string_uri, string_uri_part, string_uriid, string_url, string_url_image, string_version, string_version_dependency, string_xml } from '../types/typeAliases';
+import type { client_id, string_char, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version } from '../types/typeAliases';
 import { FromtoItems } from '../utils/FromtoItems';
-export { CommonExecutionToolsOptions, EXPECTATION_UNITS, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, ExpectationUnit, FromtoItems, ILicense, IPersonProfile, IRepository, ModelRequirements, ModelVariant, NaturalExecutionTools, Parameters, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, PromptTemplatePipelineJson, PromptTemplatePipelineString, PtpExecutor, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, number_bytes, number_days, number_gigabytes, number_hours, number_integer, number_kilobytes, number_likeness, number_megabytes, number_miliseconds, number_minutes, number_months, number_negative, number_percent, number_positive, number_seconds, number_terabytes, number_weeks, number_years, string_attribute, string_attribute_value_scope, string_business_category_name, string_char, string_char_emoji, string_chat_prompt, string_color, string_completion_prompt, string_css, string_css_class, string_css_property, string_css_selector, string_css_value, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_license_token, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_page, string_password, string_person_fullname, string_person_profile, string_pgp_key, string_prompt, string_protocol, string_ptbk_url, string_ptbk_url_with_hashtemplate, string_script, string_sha256, string_ssh_key, string_svg, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_translate_name, string_translate_name_not_normalized, string_uri, string_uri_part, string_uriid, string_url, string_url_image, string_version, string_version_dependency, string_xml, };
+export { CommonExecutionToolsOptions, EXPECTATION_UNITS, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, ExpectationUnit, FromtoItems, ModelRequirements, ModelVariant, NaturalExecutionTools, Parameters, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, PromptbookExecutor, PromptbookJson, PromptbookString, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, };
 /**
- * TODO: !!! Filter out all the types that are not used in the library
+ * TODO: Delete type aliases that are not exported here
  */

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

@@ -0,0 +1,61 @@
+import { string_name } from '.././types/typeAliases';
+import { CreatePromptbookExecutorSettings } from '../execution/createPromptbookExecutor';
+import { ExecutionTools } from '../execution/ExecutionTools';
+import { PromptbookExecutor } from '../execution/PromptbookExecutor';
+import { Prompt } from '../types/Prompt';
+import { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import { PromptbookString } from '../types/PromptbookString';
+/**
+ * Library of promptbooks that groups together promptbooks for an application. This is a very thin wrapper around the Array / Set of promptbooks.
+ *
+ * Promptbook library is a useful helper in execution, it can be shared between execution and consumer parts of the app and make common knowledge about promptbooks.
+ *
+ * It allows to create executor functions from promptbooks in the library.
+ *
+ * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline-library
+ */
+export declare class PromptbookLibrary {
+    private readonly options;
+    /**
+     * Constructs Promptbook 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 promptbookSources contents of .ptbk.md or .ptbk.json files
+     * @param settings settings for creating executor functions
+     * @returns PromptbookLibrary
+     */
+    static fromSources(promptbookSources: Record<string_name, PromptbookJson | PromptbookString>, settings?: Partial<CreatePromptbookExecutorSettings>): PromptbookLibrary;
+    private constructor();
+    /**
+     * Gets all promptbooks in the library
+     */
+    get promptbookNames(): Array<string_name>;
+    /**
+     * Gets promptbook by name
+     */
+    getPromptbookByName(name: string_name): PromptbookJson;
+    /**
+     * Checks whether prompt is in the library
+     */
+    isPromptInLibrary(prompt: Prompt): boolean;
+    /**
+     * Gets executor function for given promptbook
+     */
+    createExecutor(name: string_name, tools: ExecutionTools): PromptbookExecutor;
+}
+/**
+ * TODO: [🈴] Identify promptbooks by url `promptbookUrls` + `getPromptbookByUrl`
+ * TODO: !! [👐][🧠] Split of Promptbook,PromptbookLibrary between interface and class
+ * TODO: !! [👐] Make promptbooks 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 promptbookLibrary.executePromptbook('writeXyz',{...}) OR promptbookLibrary.createExecutor('writeXyz')({...}) OR createExecutor(promptbookLibrary.getPromptbook('writeXyz'))
+ * TODO: [🧠] Formarly (before commit 62229afce7668a5b85077cc18becf798b583bf8d) there were two classes PromptbookLibrary+PromptbookLibraryExecutor (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/conversion/_importPromptbook.d.ts

@@ -0,0 +1,12 @@
+import { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import { PromptbookString } from '../types/PromptbookString';
+/**
+ * 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 importPromptbook(path: `${string}.ptbk.md`): PromptbookString;
+export declare function importPromptbook(path: `${string}.ptbk.json`): PromptbookJson;

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

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

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

@@ -0,0 +1,26 @@
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+/**
+ * Validates PromptbookJson 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 promptbook valid or invalid PromptbookJson
+ * @throws {Error} if invalid
+ */
+export declare function validatePromptbookJson(promptbook: PromptbookJson): void;
+/**
+ * TODO: [🧠] Work with promptbookVersion
+ * TODO: Use here some json-schema, Zod or something similar and change it to:
+ *     > /**
+ *     >  * Validates PromptbookJson if it is logically valid.
+ *     >  *
+ *     >  * It checks:
+ *     >  * -   it has a valid structure
+ *     >  * -   ...
+ *     >  ex port function validatePromptbookJson(promptbook: unknown): asserts promptbook is PromptbookJson {
+ */

package/{umd/typings/execution/PtpExecutor.d.ts → esm/typings/execution/PromptbookExecutor.d.ts}

@@ -1,18 +1,18 @@
 import type { Promisable } from 'type-fest';
-import type { string_name } from '.././types/typeAliases';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
+import type { string_name } from '../types/typeAliases';
 /**
  * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
- * Executor is made by combining execution tools and prompt template pipeline library.
+ * Executor is made by combining execution tools and promptbook library.
  *
  * It can be done in two ways:
- * -   From `PromptTemplatePipelineLibrary.getExecutor` method
- * -   `createPtpExecutor` utility function
+ * -   From `PromptbookLibrary.getExecutor` method
+ * -   `createPromptbookExecutor` utility function
  *
  * @see https://github.com/webgptorg/promptbook#executor
  */
-export interface PtpExecutor {
+export interface PromptbookExecutor {
     (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
         /**
          * Whether the execution was successful

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

@@ -1,11 +1,11 @@
-import type { PtpExecutor } from './PtpExecutor';
+import type { PromptbookExecutor } from './PromptbookExecutor';
 /**
  * Asserts that the execution of a promptnook is successful
  *
  * @param executionResult - The partial result of the promptnook execution
  * @throws Error - If the execution is not successful or if multiple errors occurred
  */
-export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PtpExecutor>>, 'isSuccessful' | 'errors'>): void;
+export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PromptbookExecutor>>, 'isSuccessful' | 'errors'>): void;
 /**
  * TODO: [🧠] Can this return type be better typed than void
  */

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

@@ -0,0 +1,40 @@
+import { PromptbookJson } from '../_packages/types.index';
+import { ExecutionTools } from './ExecutionTools';
+import { PromptbookExecutor } from './PromptbookExecutor';
+export interface CreatePromptbookExecutorSettings {
+    /**
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * @default 3
+     */
+    readonly maxExecutionAttempts: number;
+}
+/**
+ * Options for creating a promptbook executor
+ */
+interface CreatePromptbookExecutorOptions {
+    /**
+     * The promptbook to be executed
+     */
+    readonly promptbook: PromptbookJson;
+    /**
+     * The execution tools to be used during the execution of the PROMPTBOOK
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * Optional settings for the PROMPTBOOK executor
+     */
+    readonly settings?: Partial<CreatePromptbookExecutorSettings>;
+}
+/**
+ * Creates executor function from promptbook and execution tools.
+ *
+ * Note: Consider using getExecutor method of the library instead of using this function
+ */
+export declare function createPromptbookExecutor(options: CreatePromptbookExecutorOptions): PromptbookExecutor;
+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: CreatePromptbookExecutorOptions are just connected to PromptbookExecutor so do not extract to types folder
+ */

package/esm/typings/execution/plugins/natural-execution-tools/mocked/joker.test.d.ts

@@ -1,4 +1,4 @@
 export {};
 /**
- * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPtpExecutor.test.ts"
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
  */

package/esm/typings/execution/plugins/natural-execution-tools/mocked/mocked-chat.test.d.ts

@@ -1,4 +1,4 @@
 export {};
 /**
- * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPtpExecutor.test.ts"
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
  */

package/esm/typings/execution/plugins/natural-execution-tools/mocked/mocked-completion.test.d.ts

@@ -1,4 +1,4 @@
 export {};
 /**
- * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPtpExecutor.test.ts"
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
  */

package/esm/typings/execution/plugins/natural-execution-tools/remote/RemoteNaturalExecutionToolsOptions.d.ts

@@ -5,7 +5,7 @@ import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOption
  */
 export interface RemoteNaturalExecutionToolsOptions extends CommonExecutionToolsOptions {
     /**
-     * URL of the remote PTP server
+     * URL of the remote PROMPTBOOK server
      * On this server will be connected to the socket.io server
      */
     readonly remoteUrl: URL;

package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/{Ptps_Error.d.ts → Promptbook_Server_Error.d.ts}

@@ -3,7 +3,7 @@
  *
  * This is sent from server to client when error occurs and stops the process
  */
-export interface Ptps_Error {
+export interface Promptbook_Server_Error {
     /**
      * The error message which caused the error
      */

package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/{Ptps_Progress.d.ts → Promptbook_Server_Progress.d.ts}

@@ -4,7 +4,7 @@ import { TaskProgress } from '../../../../../types/TaskProgress';
  *
  * This is sent from server to client arbitrarily and may be sent multiple times
  */
-export interface Ptps_Progress {
+export interface Promptbook_Server_Progress {
     /**
      * The progress of text generation
      */

package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/{Ptps_Request.d.ts → Promptbook_Server_Request.d.ts}

@@ -1,11 +1,11 @@
-import type { client_id } from '../../../../.././types/typeAliases';
+import type { client_id } from '../../../../../types/typeAliases';
 import type { Prompt } from '../../../../../types/Prompt';
 /**
  * Socket.io progress for remote text generation
  *
  * This is a request from client to server
  */
-export interface Ptps_Request {
+export interface Promptbook_Server_Request {
     /**
      * Client responsible for the requests
      */

package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/{Ptps_Response.d.ts → Promptbook_Server_Response.d.ts}

@@ -1,10 +1,10 @@
-import { PromptResult } from '../../../../../execution/PromptResult';
+import { PromptResult } from '../../../../PromptResult';
 /**
  * Socket.io error for remote text generation
  *
  * This is sent from server to client when the generated text is completed
  */
-export interface Ptps_Response {
+export interface Promptbook_Server_Response {
     /**
      * The result of the prompt
      */

package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions.d.ts

@@ -1,4 +1,4 @@
-import type { PromptTemplatePipelineLibrary } from '../../../../../classes/PromptTemplatePipelineLibrary';
+import type { PromptbookLibrary } from '../../../../../classes/PromptbookLibrary';
 import type { client_id, string_uri } from '../../../../../types/typeAliases';
 import type { CommonExecutionToolsOptions } from '../../../../CommonExecutionToolsOptions';
 import type { NaturalExecutionTools } from '../../../../NaturalExecutionTools';
@@ -15,11 +15,11 @@ export interface RemoteServerOptions extends CommonExecutionToolsOptions {
      */
     readonly path: string_uri;
     /**
-     * Prompt template pipeline library to use
+     * Promptbook library to use
      *
      * This is used to checkl validity of the prompt to prevent DDoS
      */
-    readonly ptbkLibrary: PromptTemplatePipelineLibrary;
+    readonly library: PromptbookLibrary;
     /**
      * Creates natural execution tools for each client
      */

package/{umd/typings/execution/plugins/natural-execution-tools/remote/runRemoteServer.d.ts → esm/typings/execution/plugins/natural-execution-tools/remote/startRemoteServer.d.ts}

@@ -1,3 +1,4 @@
+import type { IDestroyable } from 'destroyable';
 import { RemoteServerOptions } from './interfaces/RemoteServerOptions';
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
@@ -7,9 +8,8 @@ import { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  *
  * @see https://github.com/webgptorg/promptbook#remote-server
  */
-export declare function runRemoteServer(options: RemoteServerOptions): void;
+export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
 /**
- * TODO: !!! This should be name runRemoteServer OR startRemoteServer and return Destroyable OR Promise<Destroyable>
  * TODO: Handle progress - support streaming
  * TODO: [🤹‍♂️] Do not hang up immediately but wait until client closes OR timeout
  * TODO: [🤹‍♂️] Timeout on chat to free up resources

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

@@ -1,31 +1,31 @@
 import type { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
 import type { ExecutionType } from './ExecutionTypes';
 import type { ModelRequirements } from './ModelRequirements';
-import type { ExpectationAmount, ExpectationUnit } from './PromptTemplatePipelineJson/PromptTemplateJson';
+import type { ExpectationAmount, ExpectationUnit } from './PromptbookJson/PromptTemplateJson';
 /**
  * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.
  */
-export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
+export type Command = PromptbookUrlCommand | PromptbookVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
 /**
- * PtpVersion command tells which version is .ptp file using
+ * PromptbookVersion command tells which version is .promptbook file using
  *
  * - It is used for backward compatibility
- * - It is defined per whole .ptp file in the header
+ * - It is defined per whole .promptbook file in the header
  */
-export interface PtbkUrlCommand {
-    readonly type: 'PTBK_URL';
-    readonly ptbkUrl: URL;
+export interface PromptbookUrlCommand {
+    readonly type: 'PROMPTBOOK_URL';
+    readonly promptbookUrl: URL;
 }
 /**
- * PtpVersion command tells which version is .ptp file using
+ * PromptbookVersion command tells which version is .promptbook file using
  *
  * - It is used for backward compatibility
- * - It is defined per whole .ptp file in the header
+ * - It is defined per whole .promptbook file in the header
  */
-export interface PtbkVersionCommand {
-    readonly type: 'PTBK_VERSION';
-    readonly ptbkVersion: string_version;
+export interface PromptbookVersionCommand {
+    readonly type: 'PROMPTBOOK_VERSION';
+    readonly promptbookVersion: string_version;
 }
 /**
  * Execute command tells how to execute the section

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

@@ -2,9 +2,9 @@
  * Parameters of the prompt template (pipeline)
  *
  * There are three types of parameters:
- * - **INPUT  PARAMETERs** are required to execute the prompt template pipeline.
- * - **Intermediate parameters** are used internally in the prompt template pipeline.
- * - **OUTPUT PARAMETERs** are not used internally in the prompt template pipeline, but are returned as the result of the prompt template pipeline execution.
+ * - **INPUT PARAMETERs** are required to execute the pipeline.
+ * - **Intermediate parameters** are used internally in the pipeline.
+ * - **OUTPUT PARAMETERs** are not used internally in the pipeline, but are returned as the result of the pipeline execution.
  *
  * @see https://github.com/webgptorg/promptbook#parameters
  */

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

@@ -1,4 +1,4 @@
-import type { string_name, string_prompt, string_ptbk_url_with_hashtemplate, string_title } from '.././types/typeAliases';
+import type { string_name, string_prompt, string_promptbook_url_with_hashtemplate, string_title } from '.././types/typeAliases';
 import type { ModelRequirements } from './ModelRequirements';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
@@ -24,15 +24,15 @@ export interface Prompt {
      */
     readonly modelRequirements: ModelRequirements;
     /**
-     * Unique identifier of the prompt template pipeline with specific template name as hash
+     * Unique identifier of the promptbook with specific template name as hash
      *
-     * @example https://ptbk.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords
+     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords
      */
-    readonly ptbkUrl: string_ptbk_url_with_hashtemplate;
+    readonly promptbookUrl: string_promptbook_url_with_hashtemplate;
     /**
      * Parameters used in the prompt
      *
-     * Note: This is redundant (same information is in ptbkUrl+content) but useful for logging and debugging
+     * Note: This is redundant (same information is in promptbookUrl+content) but useful for logging and debugging
      */
     readonly parameters: Record<string_name, string>;
 }

package/{umd/typings/types/PromptTemplatePipelineJson → esm/typings/types/PromptbookJson}/PromptTemplateJson.d.ts

@@ -1,10 +1,10 @@
-import { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../.././types/typeAliases';
 import { ExpectFormatCommand } from '../Command';
 import { ExecutionType } from '../ExecutionTypes';
 import { ModelRequirements } from '../ModelRequirements';
 import { ScriptLanguage } from '../ScriptLanguage';
+import { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../typeAliases';
 /**
- * Describes one prompt template in the prompt template pipeline
+ * Describes one prompt template in the promptbook
  */
 export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | ScriptTemplateJson | PromptDialogJson;
 /**
@@ -16,7 +16,7 @@ export interface NaturalTemplateJson extends PromptTemplateJsonCommon {
      * Requirements for the model
      * - This is required only for executionType PROMPT_TEMPLATE
      */
-    readonly modelRequirements?: ModelRequirements;
+    readonly modelRequirements: ModelRequirements;
 }
 /**
  * Units of text measurement
@@ -62,7 +62,7 @@ interface PromptTemplateJsonCommon {
      * Name of the template
      * - It must be unique across the pipeline
      * - It should start uppercase and contain letters and numbers
-     * - The ptbkUrl together with hash and name are used to identify the prompt template in the pipeline
+     * - The promptbookUrl together with hash and name are used to identify the prompt template in the pipeline
      */
     readonly name: string_name;
     /**

package/esm/typings/types/{PromptTemplatePipelineJson → PromptbookJson}/PromptTemplateParameterJson.d.ts

@@ -1,6 +1,6 @@
-import { string_name } from '../.././types/typeAliases';
+import { string_name } from '../typeAliases';
 /**
- * Describes one parameter of the prompt template pipeline
+ * Describes one parameter of the promptbook
  */
 export interface PromptTemplateParameterJson {
     /**

package/{umd/typings/types/PromptTemplatePipelineJson/PromptTemplatePipelineJson.d.ts → esm/typings/types/PromptbookJson/PromptbookJson.d.ts}

@@ -1,38 +1,34 @@
-import { string_ptbk_url, string_version } from '../.././types/typeAliases';
+import { string_promptbook_url, string_version } from '../typeAliases';
 import { PromptTemplateJson } from './PromptTemplateJson';
 import { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
 /**
- * Prompt template pipeline is the **core concept of this library**.
+ * Promptbook 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:
- * -   **.ptbk.md file** in custom markdown format described above
- * -   _(this)_ **JSON** format, parsed from the .ptbk.md file
- *
- * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline
+ * @see https://github.com/webgptorg/promptbook#promptbook
  */
-export interface PromptTemplatePipelineJson {
+export interface PromptbookJson {
     /**
-     * Unique identifier of the prompt template pipeline
+     * Unique identifier of the promptbook
      *
-     * Note: It must be unique across all prompt template pipelines
+     * Note: It must be unique across all promptbooks libraries
      * Note: It must use HTTPs URL
      * Tip: You can do versioning in the URL
-     *      For example: https://ptbk.webgpt.com/cs/write-website-content.ptbk.md@1.0.0
+     *      For example: https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@1.0.0
      * Warning: Do not hash part of the URL, hash part is used for identification of the prompt template in the pipeline
      */
-    readonly ptbkUrl?: string_ptbk_url;
+    readonly promptbookUrl?: string_promptbook_url;
     /**
-     * Title of the prompt template pipeline
+     * Title of the promptbook
      * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
     readonly title: string;
     /**
      * Version of the .ptbk.json file
      */
-    readonly ptbkVersion: string_version;
+    readonly promptbookVersion: string_version;
     /**
-     * Description of the prompt template pipeline
+     * Description of the promptbook
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
     readonly description?: string;

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

@@ -0,0 +1,12 @@
+/**
+ * Promptbook 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.
+ *
+ * @see https://github.com/webgptorg/promptbook#promptbook
+ */
+export type PromptbookString = string & {
+    readonly _type: 'Promptbook';
+};
+/**
+ * TODO: !! Better validation (validatePromptbookString) or remove branded type and make it just string
+ */

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

@@ -1,7 +1,7 @@
 import { ExecutionType } from './ExecutionTypes';
 import { string_markdown_text, string_name } from './typeAliases';
 /**
- * TaskProgress represents the progress of a PromptTemplatePipeline execution.
+ * TaskProgress represents the progress of a Promptbook execution.
  */
 export interface TaskProgress {
     /**