@promptbook/core 0.35.1 → 0.36.2

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 {
     /**

package/esm/typings/types/execution-report/ExecutionReportJson.d.ts

@@ -1,6 +1,6 @@
 import type { PromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../Prompt';
-import type { string_ptbk_url, string_version } from '../typeAliases';
+import type { string_promptbook_url, string_version } from '../typeAliases';
 /**
  * ExecutionReport is result of executing one promptbook
  * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
@@ -13,23 +13,23 @@ import type { string_ptbk_url, string_version } from '../typeAliases';
  */
 export type ExecutionReportJson = {
     /**
-     * Unique identifier of the ptp from ptp which was executed
+     * Unique identifier of the promptbook from promptbook which was executed
      */
-    readonly ptbkUrl?: string_ptbk_url;
+    readonly promptbookUrl?: string_promptbook_url;
     /**
-     * Title of from ptp which was executed
+     * Title of from promptbook which was executed
      */
     readonly title?: string;
     /**
-     * Version from ptp which was executed
+     * Version from promptbook which was executed
      */
-    readonly ptbkUsedVersion: string_version;
+    readonly promptbookUsedVersion: string_version;
     /**
-     * Version from ptp which was requested by promptbook
+     * Version from promptbook which was requested by promptbook
      */
-    readonly ptbkRequestedVersion?: string_version;
+    readonly promptbookRequestedVersion?: string_version;
     /**
-     * Description of the ptp which was executed
+     * Description of the promptbook which was executed
      */
     readonly description?: string;
     /**
@@ -39,7 +39,7 @@ export type ExecutionReportJson = {
         /**
          * The prompt wich was executed
          */
-        prompt: Omit<Prompt, 'ptbkUrl' | 'parameters'>;
+        prompt: Omit<Prompt, 'promptbookUrl' | 'parameters'>;
         /**
          * Result of the prompt execution (if not failed during LLM execution)
          */

package/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.35.1",
+    "version": "0.36.2",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,