@promptbook/openai 0.60.0-4 → 0.60.0-6

package/umd/typings/src/_packages/types.index.d.ts

@@ -1,12 +1,12 @@
+import type { PipelineCollection } from '../collection/PipelineCollection';
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
 import { EmbeddingVector } from '../execution/EmbeddingVector';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { AvailableModel, LlmExecutionTools } from '../execution/LlmExecutionTools';
+import type { PipelineExecutor } from '../execution/PipelineExecutor';
 import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, UncertainNumber } from '../execution/PromptResult';
-import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
 import type { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
-import type { PipelineCollection } from '../library/PipelineCollection';
 import type { ExecutionType } from '../types/ExecutionTypes';
 import type { ModelRequirements, ModelVariant } from '../types/ModelRequirements';
 import type { Parameters } from '../types/Parameters';
@@ -27,7 +27,7 @@ import type { FromtoItems } from '../utils/FromtoItems';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { EXPECTATION_UNITS };
-export type { AvailableModel, CommonExecutionToolsOptions, EmbeddingVector, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, ExpectationUnit, Expectations, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, PipelineCollection, PipelineJson, PipelineString, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, PromptbookExecutor, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, TaskProgress, UncertainNumber, 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_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, 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, };
+export type { AvailableModel, CommonExecutionToolsOptions, EmbeddingVector, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, ExpectationUnit, Expectations, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, PipelineCollection, PipelineExecutor, PipelineJson, PipelineString, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, TaskProgress, UncertainNumber, 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_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, 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: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

package/{esm/typings/src/library → umd/typings/src/collection}/PipelineCollection.d.ts

@@ -5,21 +5,21 @@ import type { string_pipeline_url } from '../types/typeAliases';
 /**
  * Collection that groups together pipelines, knowledge, personas, tools and actions
  *
- * @see !!! https://github.com/webgptorg/pipeline#pipeline-library
+ * @see !!! https://github.com/webgptorg/pipeline#pipeline-collection
  */
 export type PipelineCollection = {
     /**
-     * Gets all pipelines in the library
+     * Gets all pipelines in the collection
      */
     listPipelines(): Promisable<Array<string_pipeline_url>>;
     /**
      * Gets pipeline by its URL
      *
-     * Note: This is not a direct fetching from the URL, but a lookup in the library
+     * Note: This is not a direct fetching from the URL, but a lookup in the collection
      */
     getPipelineByUrl(url: string_pipeline_url): Promisable<PipelineJson>;
     /**
-     * Checks whether given prompt was defined in any pipeline in the library
+     * Checks whether given prompt was defined in any pipeline in the collection
      */
     isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
 };

package/{esm/typings/src/library → umd/typings/src/collection}/SimplePipelineCollection.d.ts

@@ -10,9 +10,9 @@ import type { PipelineCollection } from './PipelineCollection';
  * @see https://github.com/webgptorg/promptbook#promptbook-collection
  */
 export declare class SimplePipelineCollection implements PipelineCollection {
-    private library;
+    private collection;
     /**
-     * Constructs a promptbook library from promptbooks
+     * Constructs a pipeline collection from promptbooks
      *
      * @param promptbooks !!!
      *
@@ -22,17 +22,17 @@ export declare class SimplePipelineCollection implements PipelineCollection {
      */
     constructor(...promptbooks: Array<PipelineJson>);
     /**
-     * Gets all promptbooks in the library
+     * Gets all promptbooks in the collection
      */
     listPipelines(): Array<string_pipeline_url>;
     /**
      * Gets promptbook by its URL
      *
-     * Note: This is not a direct fetching from the URL, but a lookup in the library
+     * Note: This is not a direct fetching from the URL, but a lookup in the collection
      */
     getPipelineByUrl(url: string_pipeline_url): PipelineJson;
     /**
-     * Checks whether given prompt was defined in any promptbook in the library
+     * Checks whether given prompt was defined in any promptbook in the collection
      */
     isResponsibleForPrompt(prompt: Prompt): boolean;
 }

package/{esm/typings/src/library/libraryToJson.d.ts → umd/typings/src/collection/collectionToJson.d.ts}

@@ -3,6 +3,6 @@ import type { PipelineCollection } from './PipelineCollection';
 /**
  * Converts PipelineCollection to serialized JSON
  *
- * Note: Functions `libraryToJson` and `createCollectionFromJson` are complementary
+ * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
  */
-export declare function libraryToJson(library: PipelineCollection): Promise<Array<PipelineJson>>;
+export declare function collectionToJson(collection: PipelineCollection): Promise<Array<PipelineJson>>;

package/umd/typings/src/{library → collection}/constructors/createCollectionFromDirectory.d.ts

@@ -11,7 +11,7 @@ type CreatePipelineCollectionFromDirectoryOptions = {
      */
     isRecursive?: boolean;
     /**
-     * If true, the library creation outputs information about each file it reads
+     * If true, the collection creation outputs information about each file it reads
      *
      * @default false
      */
@@ -23,7 +23,7 @@ type CreatePipelineCollectionFromDirectoryOptions = {
      */
     isLazyLoaded?: boolean;
     /**
-     * If true, whole library creation crashes on error in any promptbook
+     * If true, whole collection creation crashes on error in any promptbook
      * If true and isLazyLoaded is true, the error is thrown on first access to the promptbook
      *
      * @default true
@@ -36,7 +36,7 @@ type CreatePipelineCollectionFromDirectoryOptions = {
  * Note: Works only in Node.js environment because it reads the file system
  *
  * @param path - path to the directory with promptbooks
- * @param options - Misc options for the library
+ * @param options - Misc options for the collection
  * @returns PipelineCollection
  */
 export declare function createCollectionFromDirectory(path: string_folder_path, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;

package/umd/typings/src/{library → collection}/constructors/createCollectionFromJson.d.ts

@@ -3,7 +3,7 @@ import type { PipelineCollection } from '../PipelineCollection';
 /**
  * Creates PipelineCollection from array of PipelineJson or PipelineString
  *
- * Note: Functions `libraryToJson` and `createCollectionFromJson` are complementary
+ * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
  * Note: During the construction syntax and logic of all sources are validated
  *
  * @param promptbookSources

package/{esm/typings/src/library → umd/typings/src/collection}/constructors/createCollectionFromPromise.d.ts

@@ -10,7 +10,7 @@ import type { PipelineCollection } from '../PipelineCollection';
  *       `createCollectionFromUrl` or `createCollectionFromDirectory`
  *       Consider using those functions instead of this one
  *
- * Note: The function does NOT return promise it returns the library directly which waits for the sources to be resolved
+ * Note: The function does NOT return promise it returns the collection directly which waits for the sources to be resolved
  *       when error occurs in given promise or factory function, it is thrown during `listPipelines` or `getPipelineByUrl` call
  *
  * Note: Consider using  `createCollectionFromDirectory` or `createCollectionFromUrl`

package/umd/typings/src/{library → collection}/constructors/createCollectionFromUrl.d.ts

@@ -5,7 +5,7 @@ import type { PipelineCollection } from '../PipelineCollection';
  */
 type CreatePipelineCollectionFromUrlyOptions = {
     /**
-     * If true, the library creation outputs information about each file it reads
+     * If true, the collection creation outputs information about each file it reads
      *
      * @default false
      */

package/umd/typings/src/collection/constructors/createSubcollection.d.ts

@@ -0,0 +1,12 @@
+import type { string_pipeline_url } from '../../types/typeAliases';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Creates PipelineCollection as a subset of another PipelineCollection
+ *
+ * Note: You can use any type of collection as a parent collection - local, remote, etc.
+ * Note: This is just a thin wrapper / proxy around the parent collection
+ *
+ * @param promptbookSources
+ * @returns PipelineCollection
+ */
+export declare function createSubcollection(collection: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;

package/umd/typings/src/config.d.ts

@@ -7,6 +7,6 @@ export declare const LOOP_LIMIT = 1000;
  */
 export declare const CHARACTER_LOOP_LIMIT = 100000;
 /**
- * The name of the builded promptbook library made by CLI `promptbook make` and for lookup in `createCollectionFromDirectory`
+ * The name of the builded pipeline collection made by CLI `promptbook make` and for lookup in `createCollectionFromDirectory`
  */
-export declare const PROMPTBOOK_MAKED_BASE_FILENAME = "index";
+export declare const PIPELINE_COLLECTION_BASE_FILENAME = "index";

package/umd/typings/src/conversion/prettify/prettifyPipelineString.d.ts

@@ -5,6 +5,6 @@ import type { PrettifyOptions } from './PrettifyOptions';
  */
 export declare function prettifyPipelineString(pipelineString: PipelineString, options: PrettifyOptions): Promise<PipelineString>;
 /**
- * TODO: Maybe use some Mermaid library instead of string templating
+ * TODO: Maybe use some Mermaid package instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions
  */

package/umd/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts

@@ -20,6 +20,6 @@ export type renderPipelineMermaidOptions = {
  */
 export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
 /**
- * TODO: Maybe use some Mermaid library instead of string templating
+ * TODO: Maybe use some Mermaid package instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions
  */

package/umd/typings/src/errors/CollectionError.d.ts

@@ -1,5 +1,5 @@
 /**
- * This error indicates that the promptbook library cannot be propperly loaded
+ * This error indicates that the pipeline collection cannot be propperly loaded
  */
 export declare class CollectionError extends Error {
     readonly name = "CollectionError";

package/umd/typings/src/errors/ExecutionError.d.ts

@@ -1,5 +1,5 @@
 /**
- * This error indicates errors during the execution of the promptbook
+ * This error indicates errors during the execution of the pipeline
  */
 export declare class ExecutionError extends Error {
     readonly name = "ExecutionError";

package/umd/typings/src/errors/NotFoundError.d.ts

@@ -1,5 +1,5 @@
 /**
- * This error indicates that promptbook not found in the library
+ * This error indicates that promptbook not found in the collection
  */
 export declare class NotFoundError extends Error {
     readonly name = "NotFoundError";

package/umd/typings/src/execution/EmbeddingVector.d.ts

@@ -3,6 +3,6 @@
  */
 export type EmbeddingVector = Array<number>;
 /**
- * TODO: Figure out how to use library xyzt
+ * TODO: Figure out how to use NPM package xyzt
  *       Not using IVectorData due to HUGE dimensionality
  */

package/umd/typings/src/execution/{PromptbookExecutor.d.ts → PipelineExecutor.d.ts}

@@ -5,13 +5,13 @@ import type { string_name } from '../types/typeAliases';
 import type { PromptResultUsage } from './PromptResult';
 /**
  * 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 promptbook library.
+ * Executor is made by combining execution tools and pipeline collection.
  *
- * It can be created with `createPromptbookExecutor` function.
+ * It can be created with `createPipelineExecutor` function.
  *
  * @see https://github.com/webgptorg/promptbook#executor
  */
-export type PromptbookExecutor = {
+export type PipelineExecutor = {
     (inputParameters: Record<string_name, string>, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
         /**
          * Whether the execution was successful, details are aviable in `executionReport`

package/umd/typings/src/execution/assertsExecutionSuccessful.d.ts

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

package/{esm/typings/src/execution/createPromptbookExecutor.d.ts → umd/typings/src/execution/createPipelineExecutor.d.ts}

@@ -1,7 +1,7 @@
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import type { ExecutionTools } from './ExecutionTools';
-import type { PromptbookExecutor } from './PromptbookExecutor';
-type CreatePromptbookExecutorSettings = {
+import type { PipelineExecutor } from './PipelineExecutor';
+type CreatePipelineExecutorSettings = {
     /**
      * When executor does not satisfy expectations it will be retried this amount of times
      *
@@ -10,33 +10,33 @@ type CreatePromptbookExecutorSettings = {
     readonly maxExecutionAttempts: number;
 };
 /**
- * Options for creating a promptbook executor
+ * Options for creating a pipeline executor
  */
-interface CreatePromptbookExecutorOptions {
+interface CreatePipelineExecutorOptions {
     /**
-     * The promptbook to be executed
+     * The pipeline to be executed
      */
-    readonly promptbook: PipelineJson;
+    readonly pipeline: PipelineJson;
     /**
-     * The execution tools to be used during the execution of the PROMPTBOOK
+     * The execution tools to be used during the execution of the pipeline
      */
     readonly tools: ExecutionTools;
     /**
-     * Optional settings for the PROMPTBOOK executor
+     * Optional settings for the pipeline executor
      */
-    readonly settings?: Partial<CreatePromptbookExecutorSettings>;
+    readonly settings?: Partial<CreatePipelineExecutorSettings>;
 }
 /**
- * Creates executor function from promptbook and execution tools.
+ * Creates executor function from pipeline and execution tools.
  *
  * @returns The executor function
- * @throws {PipelineLogicError} on logical error in the promptbook
+ * @throws {PipelineLogicError} on logical error in the pipeline
  */
-export declare function createPromptbookExecutor(options: CreatePromptbookExecutorOptions): PromptbookExecutor;
+export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
 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
+ * Note: CreatePipelineExecutorOptions are just connected to PipelineExecutor so do not extract to types folder
  * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
  */

package/umd/typings/src/execution/utils/replaceParameters.d.ts

@@ -8,6 +8,6 @@ import type { string_template } from '../../types/typeAliases';
  * @returns the template with replaced parameters
  * @throws {TemplateError} if parameter is not defined, not closed, or not opened
  *
- * @private within the createPromptbookExecutor
+ * @private within the createPipelineExecutor
  */
 export declare function replaceParameters(template: string_template, parameters: Parameters): string;

package/umd/typings/src/llm-providers/mocked/joker.test.d.ts

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

package/umd/typings/src/llm-providers/mocked/mocked-chat.test.d.ts

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

package/umd/typings/src/llm-providers/mocked/mocked-completion.test.d.ts

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

package/umd/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts

@@ -1,6 +1,6 @@
+import type { PipelineCollection } from '../../../collection/PipelineCollection';
 import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { PipelineCollection } from '../../../library/PipelineCollection';
 import type { client_id } from '../../../types/typeAliases';
 import type { string_uri } from '../../../types/typeAliases';
 export type RemoteServerOptions = CommonExecutionToolsOptions & {
@@ -16,11 +16,11 @@ export type RemoteServerOptions = CommonExecutionToolsOptions & {
      */
     readonly path: string_uri;
     /**
-     * Promptbook library to use
+     * Promptbook collection to use
      *
-     * This is used to checkl validity of the prompt to prevent DDoS
+     * This is used to check validity of the prompt to prevent DDoS
      */
-    readonly library: PipelineCollection;
+    readonly collection: PipelineCollection;
     /**
      * Creates llm execution tools for each client
      */

package/umd/typings/src/llm-providers/remote/startRemoteServer.d.ts

@@ -10,7 +10,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
 /**
- * TODO: [⚖] Expose the library to be able to connect to same library via createCollectionFromUrl
+ * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
  * 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/umd/typings/src/types/Command.d.ts

@@ -17,8 +17,8 @@ export type Command = PromptbookUrlCommand | PromptbookVersionCommand | ExecuteC
  * - It is defined per whole .promptbook file in the header
  */
 export type PromptbookUrlCommand = {
-    readonly type: 'PROMPTBOOK_URL';
-    readonly promptbookUrl: URL;
+    readonly type: 'PIPELINE_URL';
+    readonly pipelineUrl: URL;
 };
 /**
  * PromptbookVersion command tells which version is .promptbook file using

package/umd/typings/src/types/PipelineJson/PipelineJson.d.ts

@@ -5,22 +5,22 @@ import type { KnowledgeJson } from './KnowledgeJson';
 import type { PromptTemplateJson } from './PromptTemplateJson';
 import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
 /**
- * Promptbook is the **core concept of this library**.
+ * Promptbook is the **core concept of this package**.
  * 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 PipelineJson = {
     /**
-     * Unique identifier of the promptbook
+     * Unique identifier of the pipeline
      *
-     * Note: It must be unique across all promptbooks libraries
+     * Note: It must be unique across all pipeline collections
      * Note: It must use HTTPs URL
      * Tip: You can do versioning in the URL
      *      For example: https://promptbook.studio/webgpt/write-website-content-cs.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 promptbookUrl?: string_pipeline_url;
+    readonly pipelineUrl?: string_pipeline_url;
     /**
      * Title of the promptbook
      * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
@@ -51,5 +51,5 @@ export type PipelineJson = {
 /**
  * Note: There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
  *       But then immediately reverted back to the single type
- *       With knowledge as part of the promptbook and library just as a collection of promptbooks
+ *       With knowledge as part of the promptbook and collection just as a collection of promptbooks
  */

package/umd/typings/src/types/PipelineJson/PromptTemplateJson.d.ts

@@ -81,7 +81,7 @@ interface PromptTemplateJsonCommon {
      * Name of the template
      * - It must be unique across the pipeline
      * - It should start uppercase and contain letters and numbers
-     * - The promptbookUrl together with hash and name are used to identify the prompt template in the pipeline
+     * - The pipelineUrl together with hash and name are used to identify the prompt template in the pipeline
      */
     readonly name: string_name;
     /**

package/umd/typings/src/types/PipelineString.d.ts

@@ -1,5 +1,5 @@
 /**
- * Promptbook is the **core concept of this library**.
+ * Promptbook is the **core concept of this package**.
  * 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

package/umd/typings/src/types/Prompt.d.ts

@@ -48,15 +48,15 @@ export type Prompt = {
      */
     readonly expectFormat?: ExpectFormatCommand['format'];
     /**
-     * Unique identifier of the promptbook with specific template name as hash
+     * Unique identifier of the pipeline with specific template name as hash
      *
      * @example https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords
      */
-    readonly promptbookUrl: string_pipeline_url_with_hashtemplate;
+    readonly pipelineUrl: string_pipeline_url_with_hashtemplate;
     /**
      * Parameters used in the prompt
      *
-     * Note: This is redundant (same information is in promptbookUrl+content) but useful for logging and debugging
+     * Note: This is redundant (same information is in pipelineUrl+content) but useful for logging and debugging
      */
     readonly parameters: Record<string_name, string>;
 };

package/umd/typings/src/types/TaskProgress.d.ts

@@ -29,7 +29,7 @@ export type TaskProgress = {
     readonly isDone: boolean;
     /**
      * The type of the execution.
-     * Note: The Promptbook library reports everything, in the app level you can filter out the execution types that you don't want to show to the user.
+     * Note: The pipeline executor reports everything, in the app level you can filter out the execution types that you don't want to show to the user.
      */
     readonly executionType: ExecutionType;
     /**

package/umd/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -15,9 +15,9 @@ import type { string_version } from '../typeAliases';
  */
 export type ExecutionReportJson = {
     /**
-     * Unique identifier of the promptbook from promptbook which was executed
+     * Unique identifier of the pipeline from promptbook which was executed
      */
-    readonly promptbookUrl?: string_pipeline_url;
+    readonly pipelineUrl?: string_pipeline_url;
     /**
      * Title of from promptbook which was executed
      */
@@ -41,7 +41,7 @@ export type ExecutionReportJson = {
         /**
          * The prompt wich was executed
          */
-        prompt: Omit<Prompt, 'promptbookUrl' | 'parameters'>;
+        prompt: Omit<Prompt, 'pipelineUrl' | 'parameters'>;
         /**
          * Result of the prompt execution (if not failed during LLM execution)
          */

package/umd/typings/src/types/execution-report/config.d.ts

@@ -1,5 +1,5 @@
 /**
- * The thresholds for the relative time in the `moment` library.
+ * The thresholds for the relative time in the `moment` NPM package.
  *
  * @see https://momentjscom.readthedocs.io/en/latest/moment/07-customization/13-relative-time-threshold/
  */

package/umd/typings/src/utils/emojis.d.ts

@@ -18,5 +18,5 @@ export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoj
  */
 export declare const EMOJIS: Set<string_char_emoji>;
 /**
- * TODO: Mirror from Collboard or some common library
+ * TODO: Mirror from Collboard or some common package
  */

package/esm/typings/src/library/constructors/createSubcollection.d.ts

@@ -1,12 +0,0 @@
-import type { string_pipeline_url } from '../../types/typeAliases';
-import type { PipelineCollection } from '../PipelineCollection';
-/**
- * Creates PipelineCollection as a subset of another PipelineCollection
- *
- * Note: You can use any type of library as a parent library - local, remote, etc.
- * Note: This is just a thin wrapper / proxy around the parent library
- *
- * @param promptbookSources
- * @returns PipelineCollection
- */
-export declare function createSubcollection(library: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;

package/umd/typings/src/library/constructors/createSubcollection.d.ts

@@ -1,12 +0,0 @@
-import type { string_pipeline_url } from '../../types/typeAliases';
-import type { PipelineCollection } from '../PipelineCollection';
-/**
- * Creates PipelineCollection as a subset of another PipelineCollection
- *
- * Note: You can use any type of library as a parent library - local, remote, etc.
- * Note: This is just a thin wrapper / proxy around the parent library
- *
- * @param promptbookSources
- * @returns PipelineCollection
- */
-export declare function createSubcollection(library: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;