@promptbook/utils 0.103.0-4 → 0.103.0-40

package/esm/typings/src/book-components/icons/CloseIcon.d.ts

@@ -1,11 +1,7 @@
-type CloseIconProps = {
-    size?: number;
-    color?: string;
-};
+import { JSX } from 'react';
 /**
- * @@@
+ * Renders an icon that represents the close action
  *
- * @public exported from `@promptbook/components`
+ * @private
  */
-export declare function CloseIcon({ size, color }: CloseIconProps): import("react/jsx-runtime").JSX.Element;
-export {};
+export declare function CloseIcon(): JSX.Element;

package/esm/typings/src/book-components/icons/DownloadIcon.d.ts

@@ -0,0 +1,9 @@
+import { SVGProps } from 'react';
+/**
+ * @@@
+ *
+ * @private internal subcomponent used by various components
+ */
+export declare function DownloadIcon(props: SVGProps<SVGSVGElement> & {
+    size?: number;
+}): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/icons/ExitFullscreenIcon.d.ts

@@ -0,0 +1,7 @@
+import { JSX } from 'react';
+/**
+ * Renders an icon that represents the exit fullscreen action
+ *
+ * @private
+ */
+export declare function ExitFullscreenIcon(): JSX.Element;

package/esm/typings/src/book-components/icons/FullscreenIcon.d.ts

@@ -0,0 +1,7 @@
+import { JSX } from 'react';
+/**
+ * Renders an icon that represents the fullscreen action
+ *
+ * @private
+ */
+export declare function FullscreenIcon(): JSX.Element;

package/esm/typings/src/book-components/icons/MenuIcon.d.ts

@@ -0,0 +1,12 @@
+import { SVGProps } from 'react';
+/**
+ * @@@
+ *
+ * @private internal subcomponent used by various components
+ */
+export declare function MenuIcon(props: SVGProps<SVGSVGElement> & {
+    size?: number;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * TODO: !!! Mark all components to not be used outside of browser
+ */

package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `boilerplate` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeBoilerplateCommand(program: Program): void;
+export declare function $initializeBoilerplateCommand(program: Program): $side_effect;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/cli-commands/about.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `about` command for Promptbook CLI utilities
  *
@@ -6,8 +7,9 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeAboutCommand(program: Program): void;
+export declare function $initializeAboutCommand(program: Program): $side_effect;
 /**
+ * TODO: [🕋] Use here `aboutPromptbookInformation`
  * TODO: [🗽] Unite branding and make single place for it
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/cli-commands/hello.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes testing `hello` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeHelloCommand(program: Program): void;
+export declare function $initializeHelloCommand(program: Program): $side_effect;
 /**
  * TODO: [🧠][🐣] Make here some easter egg with generated hello greeting via LLM models
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/cli/cli-commands/list-models.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `list-models` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeListModelsCommand(program: Program): void;
+export declare function $initializeListModelsCommand(program: Program): $side_effect;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `list-scrapers` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeListScrapersCommand(program: Program): void;
+export declare function $initializeListScrapersCommand(program: Program): $side_effect;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/cli-commands/login.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `login` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeLoginCommand(program: Program): void;
+export declare function $initializeLoginCommand(program: Program): $side_effect;
 /**
  * TODO: Implement non-interactive login
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/cli/cli-commands/make.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `make` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeMakeCommand(program: Program): void;
+export declare function $initializeMakeCommand(program: Program): $side_effect;
 /**
  * TODO: [🥃][main] !!3 Allow `ptbk make` without configuring any llm tools
  * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types

package/esm/typings/src/cli/cli-commands/prettify.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `prettify` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializePrettifyCommand(program: Program): void;
+export declare function $initializePrettifyCommand(program: Program): $side_effect;
 /**
  * TODO: [😶] Unite folder listing
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/cli/cli-commands/run.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `run` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeRunCommand(program: Program): void;
+export declare function $initializeRunCommand(program: Program): $side_effect;
 /**
  * TODO: !!5 Catch and wrap all errors from CLI
  * TODO: [🧠] Pass `maxExecutionAttempts`, `csvSettings`

package/esm/typings/src/cli/cli-commands/{start-server.d.ts → start-agents-server.d.ts}

@@ -1,12 +1,13 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
- * Initializes `start-server` command for Promptbook CLI utilities
+ * Initializes `start-agents-server` command for Promptbook CLI utilities
  *
  * Note: `$` is used to indicate that this function is not a pure function - it registers a command in the CLI
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeStartServerCommand(program: Program): void;
+export declare function $initializeStartAgentsServerCommand(program: Program): $side_effect;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/cli-commands/start-pipelines-server.d.ts

@@ -0,0 +1,15 @@
+import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
+/**
+ * Initializes `start-pipelines-server` command for Promptbook CLI utilities
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it registers a command in the CLI
+ *
+ * @private internal function of `promptbookCli`
+ */
+export declare function $initializeStartPipelinesServerCommand(program: Program): $side_effect;
+/**
+ * TODO: [🕋] Use here `aboutPromptbookInformation`
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ */

package/esm/typings/src/cli/cli-commands/test-command.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `test` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeTestCommand(program: Program): void;
+export declare function $initializeTestCommand(program: Program): $side_effect;
 /**
  * TODO: [😶] Unite folder listing
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts

@@ -1,7 +1,8 @@
 import { Command } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Note: `$` is used to indicate that this function is not a pure function - it registers an option in the CLI
  *
  * @private utility of CLI
  */
-export declare function $addGlobalOptionsToCommand(command: Command): void;
+export declare function $addGlobalOptionsToCommand(command: Command): $side_effect;

package/esm/typings/src/collection/agent-collection/AgentCollection.d.ts

@@ -0,0 +1,36 @@
+import type { Promisable } from 'type-fest';
+import { Agent } from '../../_packages/core.index';
+import { string_book } from '../../_packages/types.index';
+import type { string_agent_name } from '../../types/typeAliases';
+/**
+ * Collection that groups together multiple AI Agents
+ *
+ * Note: [🧸] There are two types of collections:
+ * - `AgentCollection` - which groups together AI Agents
+ * - `PipelineCollection` - which groups together *(deprecated)* pipelines
+ */
+export type AgentCollection = {
+    /**
+     * Gets all agents in the collection
+     */
+    listAgents(): Promisable<ReadonlyArray<string_agent_name>>;
+    /**
+     * Get one agent by its name
+     *
+     * Note: Agents are existing independently of you getting them or not, you can get the same agent multiple times.
+     * Note: Agents are changed by interacting with `Agent` objects directly. Only creation and deletion is done via the collection.
+     */
+    getAgentByName(agentName: string_agent_name): Promisable<Agent>;
+    /**
+     * Deletes an agent from the collection
+     *
+     * Note: When you want delete an agent by name, first get the agent using `getAgentByName` and then pass it to `deleteAgent`.
+     */
+    deleteAgent(agent: Agent): Promisable<void>;
+    /**
+     * Creates a new agent in the collection
+     *
+     * Note: You can set 'PARENT' in the agent source to inherit from another agent in the collection.
+     */
+    createAgent(agentSource: string_book): Promisable<Agent>;
+};

package/esm/typings/src/collection/agent-collection/constructors/AgentCollectionInDirectory.d.ts

@@ -0,0 +1,88 @@
+import { Agent } from '../../../_packages/core.index';
+import { CommonToolsOptions, string_book } from '../../../_packages/types.index';
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { string_agent_name, string_dirname } from '../../../types/typeAliases';
+import type { AgentCollection } from '../AgentCollection';
+/**
+ * Options for `createAgentCollectionFromDirectory` function
+ *
+ * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book` file is located
+ *       This is not same as `path` which is the first argument of `createAgentCollectionFromDirectory` - it can be a subfolder
+ */
+type CreateAgentCollectionInDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & CommonToolsOptions & {
+    /**
+     * If true, the directory is searched recursively for pipelines
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+    /**
+     * If true, whole collection creation crashes on error in any pipeline
+     * If true and isLazyLoaded is true, the error is thrown on first access to the pipeline
+     *
+     * @default true
+     */
+    isCrashedOnError?: boolean;
+};
+/**
+ * Agent collection stored in directory
+ *
+ * Note: Works only in Node.js environment because it reads the file system
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare class AgentCollectionInDirectory implements AgentCollection {
+    readonly rootPath: string_dirname;
+    private readonly tools?;
+    readonly options?: CreateAgentCollectionInDirectoryOptions | undefined;
+    /**
+     * @param rootPath - path to the directory with agents
+     * @param tools - Execution tools to be used in `Agent` itself and listing the agents
+     * @param options - Options for the collection creation
+     */
+    constructor(rootPath: string_dirname, tools?: Pick<ExecutionTools, "llm" | "fs" | "scrapers"> | undefined, options?: CreateAgentCollectionInDirectoryOptions | undefined);
+    /**
+     * Cached defined execution tools
+     */
+    private _definedTools;
+    /**
+     * Gets or creates execution tools for the collection
+     */
+    private getTools;
+    /**
+     * Gets all agents in the collection
+     */
+    listAgents(): Promise<ReadonlyArray<string_agent_name>>;
+    /**
+     * Get one agent by its name
+     *
+     * Note: Agents are existing independently of you getting them or not, you can get the same agent multiple times.
+     * Note: Agents are changed by interacting with `Agent` objects directly. Only creation and deletion is done via the collection.
+     */
+    getAgentByName(agentName: string_agent_name): Promise<Agent>;
+    /**
+     * Deletes an agent from the collection
+     *
+     * Note: When you want delete an agent by name, first get the agent using `getAgentByName` and then pass it to `deleteAgent`.
+     */
+    deleteAgent(agent: Agent): Promise<void>;
+    /**
+     * Creates a new agent in the collection
+     *
+     * Note: You can set 'PARENT' in the agent source to inherit from another agent in the collection.
+     */
+    createAgent(agentSource: string_book): Promise<Agent>;
+}
+export {};
+/**
+ * TODO: [🖇] What about symlinks? Maybe option `isSymlinksFollowed`
+ * TODO: [🧠] Maybe add option `isImmutable`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/collection/{PipelineCollection.d.ts → pipeline-collection/PipelineCollection.d.ts}

@@ -1,9 +1,13 @@
 import type { Promisable } from 'type-fest';
-import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
-import type { Prompt } from '../types/Prompt';
-import type { string_pipeline_url } from '../types/typeAliases';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { Prompt } from '../../types/Prompt';
+import type { string_pipeline_url } from '../../types/typeAliases';
 /**
  * Collection that groups together pipelines, knowledge, personas, tools and actions
+ *
+ * Note: [🧸] There are two types of collections:
+ * - `AgentCollection` - which groups together AI Agents
+ * - `PipelineCollection` - which groups together *(deprecated)* pipelines
  */
 export type PipelineCollection = {
     /**

package/esm/typings/src/collection/{SimplePipelineCollection.d.ts → pipeline-collection/SimplePipelineCollection.d.ts}

@@ -1,12 +1,12 @@
-import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
-import type { Prompt } from '../types/Prompt';
-import type { string_pipeline_url } from '../types/typeAliases';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { Prompt } from '../../types/Prompt';
+import type { string_pipeline_url } from '../../types/typeAliases';
 import type { PipelineCollection } from './PipelineCollection';
 /**
  * Library of pipelines that groups together pipelines for an application.
  * This implementation is a very thin wrapper around the Array / Map of pipelines.
  *
- * @private internal function of `createCollectionFromJson`, use `createCollectionFromJson` instead
+ * @private internal function of `createPipelineCollectionFromJson`, use `createPipelineCollectionFromJson` instead
  * @see https://github.com/webgptorg/pipeline#pipeline-collection
  */
 export declare class SimplePipelineCollection implements PipelineCollection {
@@ -17,7 +17,7 @@ export declare class SimplePipelineCollection implements PipelineCollection {
      * @param pipelines Array of pipeline JSON objects to include in the collection
      *
      * Note: During the construction logic of all pipelines are validated
-     * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
+     * Note: It is not recommended to use this constructor directly, use `createPipelineCollectionFromJson` *(or other variant)* instead
      */
     constructor(...pipelines: ReadonlyArray<PipelineJson>);
     /**

package/esm/typings/src/collection/{constructors/createCollectionFromDirectory.d.ts → pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts}

@@ -1,13 +1,12 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import type { string_dirname } from '../../types/typeAliases';
-import type { string_pipeline_root_url } from '../../types/typeAliases';
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { string_dirname, string_pipeline_root_url } from '../../../types/typeAliases';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Options for `createCollectionFromDirectory` function
+ * Options for `createPipelineCollectionFromDirectory` function
  *
  * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book` file is located
- *       This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
+ *       This is not same as `path` which is the first argument of `createPipelineCollectionFromDirectory` - it can be a subfolder
  */
 type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
     /**
@@ -28,8 +27,6 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
      * It has 2 purposes:
      * 1) Every pipeline in the collection is checked if it is a child of `rootUrl`
      * 2) If the pipeline does not have a URL, it is created from the `rootUrl` and path to the pipeline
-     *
-     * @default false
      */
     rootUrl?: string_pipeline_root_url;
     /**
@@ -47,7 +44,7 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
     isCrashedOnError?: boolean;
 };
 /**
- * Constructs Pipeline from given directory
+ * Constructs `PipelineCollection` from given directory
  *
  * Note: Works only in Node.js environment because it reads the file system
  *
@@ -57,9 +54,9 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
  * @returns PipelineCollection
  * @public exported from `@promptbook/node`
  */
-export declare function createCollectionFromDirectory(rootPath: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
+export declare function createPipelineCollectionFromDirectory(rootPath: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
 export {};
 /**
- * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
+ * TODO: [🖇] What about symlinks? Maybe option `isSymlinksFollowed`
  * TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
  */

package/esm/typings/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Creates `PipelineCollection` from array of PipelineJson or PipelineString
+ *
+ * Note: Functions `pipelineCollectionToJson` and `createPipelineCollectionFromJson` are complementary
+ * Note: Syntax, parsing, and logic consistency checks are performed on all sources during build
+ *
+ * @param promptbookSources
+ * @returns PipelineCollection
+ * @public exported from `@promptbook/core`
+ */
+export declare function createPipelineCollectionFromJson(...promptbooks: ReadonlyArray<PipelineJson>): PipelineCollection;

package/esm/typings/src/collection/{constructors/createCollectionFromPromise.d.ts → pipeline-collection/constructors/createPipelineCollectionFromPromise.d.ts}

@@ -1,23 +1,24 @@
-import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Constructs Promptbook from async sources
+ * Constructs `PipelineCollection` from async sources
+ *
  * It can be one of the following:
  * - Promise of array of PipelineJson or PipelineString
  * - Factory function that returns Promise of array of PipelineJson or PipelineString
  *
  * Note: This is useful as internal tool for other constructor functions like
- *       `createCollectionFromUrl` or `createCollectionFromDirectory`
+ *       `createPipelineCollectionFromUrl` or `createPipelineCollectionFromDirectory`
  *       Consider using those functions instead of this one
  *
  * 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`
+ * Note: Consider using  `createPipelineCollectionFromDirectory` or `createPipelineCollectionFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PipelineCollection
  * @deprecated Do not use, it will became internal tool for other constructor functions
  * @public exported from `@promptbook/core`
  */
-export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;
+export declare function createPipelineCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;

package/esm/typings/src/collection/{constructors/createCollectionFromUrl.d.ts → pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts}

@@ -1,7 +1,7 @@
-import type { string_url } from '../../types/typeAliases';
+import type { string_url } from '../../../types/typeAliases';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Options for `createCollectionFromDirectory` function
+ * Options for `createPipelineCollectionFromDirectory` function
  */
 type CreatePipelineCollectionFromUrlyOptions = {
     /**
@@ -22,7 +22,7 @@ type CreatePipelineCollectionFromUrlyOptions = {
  * @returns PipelineCollection
  * @public exported from `@promptbook/core`
  */
-export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
+export declare function createPipelineCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
 export {};
 /**
  * TODO: [main] !!4 [🧠] Library precompilation and do not mix markdown and json promptbooks

package/esm/typings/src/collection/{constructors/createSubcollection.d.ts → pipeline-collection/constructors/createPipelineSubcollection.d.ts}

@@ -1,7 +1,7 @@
-import type { string_pipeline_url } from '../../types/typeAliases';
+import type { string_pipeline_url } from '../../../types/typeAliases';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Creates PipelineCollection as a subset of another 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
@@ -10,4 +10,4 @@ import type { PipelineCollection } from '../PipelineCollection';
  * @returns PipelineCollection
  * @public exported from `@promptbook/core`
  */
-export declare function createSubcollection(collection: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;
+export declare function createPipelineSubcollection(collection: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;

package/esm/typings/src/collection/pipeline-collection/pipelineCollectionToJson.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineCollection } from './PipelineCollection';
+/**
+ * Converts PipelineCollection to serialized JSON
+ *
+ * Note: Functions `pipelineCollectionToJson` and `createPipelineCollectionFromJson` are complementary
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function pipelineCollectionToJson(collection: PipelineCollection): Promise<ReadonlyArray<PipelineJson>>;
+/**
+ * TODO: [🧠] Maybe clear `sourceFile` or clear when exposing through API or remote server
+ */

package/esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -1,10 +1,9 @@
 import type { SetOptional, WritableDeep } from 'type-fest';
 import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../../pipeline/PipelineJson/TaskJson';
-import type { string_markdown_text } from '../../../types/typeAliases';
-import type { string_name } from '../../../types/typeAliases';
-import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
+import type { string_markdown_text, string_name, string_promptbook_documentation_url } from '../../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import { $side_effect } from '../../../utils/organization/$side_effect';
 import type { ___and___ } from '../../../utils/organization/___and___';
 import type { CommandUsagePlace } from './CommandUsagePlaces';
 /**
@@ -98,7 +97,7 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
      *
      * Note: `$` is used to indicate that this function mutates given `pipelineJson`
      */
-    $applyToPipelineJson(command: TCommand, $pipelineJson: $PipelineJson): void;
+    $applyToPipelineJson(command: TCommand, $pipelineJson: $PipelineJson): $side_effect;
     /**
      * Reads the command from the `PipelineJson`
      *
@@ -126,7 +125,7 @@ export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonComm
      *
      * Note: `$` is used to indicate that this function mutates given `taskJson` and/or `pipelineJson`
      */
-    $applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): void;
+    $applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): $side_effect;
     /**
      * Reads the command from the `TaskJson`
      *