@promptbook/utils 0.60.0-4 → 0.60.0-5

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;