@promptbook/cli 0.62.0 → 0.62.2

package/umd/typings/src/collection/SimplePipelineCollection.d.ts

@@ -1,38 +1,38 @@
-import type { PipelineJson } from '../types/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 use `createCollectionFromJson` instead
- * @see https://github.com/webgptorg/pipeline#pipeline-collection
- */
-export declare class SimplePipelineCollection implements PipelineCollection {
-    private collection;
-    /**
-     * Constructs a pipeline collection from pipelines
-     *
-     * @param pipelines @@@
-     *
-     * @private Use instead `createCollectionFromJson`
-     * 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
-     */
-    constructor(...pipelines: Array<PipelineJson>);
-    /**
-     * Gets all pipelines in the collection
-     */
-    listPipelines(): Array<string_pipeline_url>;
-    /**
-     * Gets pipeline by its URL
-     *
-     * 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 pipeline in the collection
-     */
-    isResponsibleForPrompt(prompt: Prompt): boolean;
-}
+import type { PipelineJson } from '../types/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 use `createCollectionFromJson` instead
+ * @see https://github.com/webgptorg/pipeline#pipeline-collection
+ */
+export declare class SimplePipelineCollection implements PipelineCollection {
+    private collection;
+    /**
+     * Constructs a pipeline collection from pipelines
+     *
+     * @param pipelines @@@
+     *
+     * @private Use instead `createCollectionFromJson`
+     * 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
+     */
+    constructor(...pipelines: Array<PipelineJson>);
+    /**
+     * Gets all pipelines in the collection
+     */
+    listPipelines(): Array<string_pipeline_url>;
+    /**
+     * Gets pipeline by its URL
+     *
+     * 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 pipeline in the collection
+     */
+    isResponsibleForPrompt(prompt: Prompt): boolean;
+}

package/umd/typings/src/collection/collectionToJson.d.ts

@@ -1,11 +1,11 @@
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { PipelineCollection } from './PipelineCollection';
-/**
- * Converts PipelineCollection to serialized JSON
- *
- * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
- */
-export declare function collectionToJson(collection: PipelineCollection): Promise<Array<PipelineJson>>;
-/**
- * TODO: [🧠] Maybe clear `sourceFile` or clear when exposing through API or remote server
- */
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineCollection } from './PipelineCollection';
+/**
+ * Converts PipelineCollection to serialized JSON
+ *
+ * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
+ */
+export declare function collectionToJson(collection: PipelineCollection): Promise<Array<PipelineJson>>;
+/**
+ * TODO: [🧠] Maybe clear `sourceFile` or clear when exposing through API or remote server
+ */

package/umd/typings/src/collection/collectionToJson.test.d.ts

@@ -1,7 +1,7 @@
-export {};
-/**
- * Note: [🐠] For example here URL https://example.com/pipeline.ptbk.md is not valid
- *       because it is on private network BUT its very hard to debug because
- *       there is no error message and false return (the error) happen deep in:
- *       `isValidPipelineUrl` -> `isValidPipelineUrl` -> `isUrlOnPrivateNetwork`
- */
+export {};
+/**
+ * Note: [🐠] For example here URL https://example.com/pipeline.ptbk.md is not valid
+ *       because it is on private network BUT its very hard to debug because
+ *       there is no error message and false return (the error) happen deep in:
+ *       `isValidPipelineUrl` -> `isValidPipelineUrl` -> `isUrlOnPrivateNetwork`
+ */

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

@@ -1,47 +1,47 @@
-import type { PipelineStringToJsonOptions } from '../../conversion/pipelineStringToJson';
-import type { string_folder_path } from '../../types/typeAliases';
-import type { PipelineCollection } from '../PipelineCollection';
-/**
- * Options for `createCollectionFromDirectory` function
- */
-type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions & {
-    /**
-     * If true, the directory is searched recursively for pipelines
-     *
-     * @default true
-     */
-    isRecursive?: boolean;
-    /**
-     * If true, the collection creation outputs information about each file it reads
-     *
-     * @default false
-     */
-    isVerbose?: 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;
-};
-/**
- * Constructs Pipeline from given directory
- *
- * Note: Works only in Node.js environment because it reads the file system
- *
- * @param path - path to the directory with pipelines
- * @param options - Misc options for the collection
- * @returns PipelineCollection
- */
-export declare function createCollectionFromDirectory(path: string_folder_path, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
-export {};
-/**
- * Note: [🟢] This code should never be published outside of `@pipeline/node`
- */
+import type { PipelineStringToJsonOptions } from '../../conversion/pipelineStringToJson';
+import type { string_folder_path } from '../../types/typeAliases';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Options for `createCollectionFromDirectory` function
+ */
+type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions & {
+    /**
+     * If true, the directory is searched recursively for pipelines
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+    /**
+     * If true, the collection creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    isVerbose?: 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;
+};
+/**
+ * Constructs Pipeline from given directory
+ *
+ * Note: Works only in Node.js environment because it reads the file system
+ *
+ * @param path - path to the directory with pipelines
+ * @param options - Misc options for the collection
+ * @returns PipelineCollection
+ */
+export declare function createCollectionFromDirectory(path: string_folder_path, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
+export {};
+/**
+ * Note: [🟢] This code should never be published outside of `@pipeline/node`
+ */

package/umd/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

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

@@ -1,12 +1,12 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { PipelineCollection } from '../PipelineCollection';
-/**
- * Creates PipelineCollection from array of PipelineJson or PipelineString
- *
- * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
- * Note: During the construction syntax and logic of all sources are validated
- *
- * @param promptbookSources
- * @returns PipelineCollection
- */
-export declare function createCollectionFromJson(...promptbooks: Array<PipelineJson>): PipelineCollection;
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Creates PipelineCollection from array of PipelineJson or PipelineString
+ *
+ * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
+ * Note: During the construction syntax and logic of all sources are validated
+ *
+ * @param promptbookSources
+ * @returns PipelineCollection
+ */
+export declare function createCollectionFromJson(...promptbooks: Array<PipelineJson>): PipelineCollection;

package/umd/typings/src/collection/constructors/createCollectionFromJson.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

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

@@ -1,22 +1,22 @@
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { PipelineCollection } from '../PipelineCollection';
-/**
- * Constructs Promptbook 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`
- *       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`
- *
- * @param promptbookSourcesPromiseOrFactory
- * @returns PipelineCollection
- * @deprecated Do not use, it will became internal tool for other constructor functions
- */
-export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PipelineJson>> | (() => Promise<Array<PipelineJson>>)): PipelineCollection;
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Constructs Promptbook 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`
+ *       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`
+ *
+ * @param promptbookSourcesPromiseOrFactory
+ * @returns PipelineCollection
+ * @deprecated Do not use, it will became internal tool for other constructor functions
+ */
+export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PipelineJson>> | (() => Promise<Array<PipelineJson>>)): PipelineCollection;

package/umd/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

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

@@ -1,29 +1,29 @@
-import type { string_url } from '../../types/typeAliases';
-import type { PipelineCollection } from '../PipelineCollection';
-/**
- * Options for `createCollectionFromDirectory` function
- */
-type CreatePipelineCollectionFromUrlyOptions = {
-    /**
-     * If true, the collection creation outputs information about each file it reads
-     *
-     * @default false
-     */
-    readonly isVerbose?: boolean;
-    /**
-     * If true, directory will be scanned only when needed not during the construction
-     *
-     * @default false
-     */
-    readonly isLazyLoaded?: boolean;
-};
-/**
- * Constructs Promptbook from remote Promptbase URL
-
- * @returns PipelineCollection
- */
-export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
-export {};
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */
+import type { string_url } from '../../types/typeAliases';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Options for `createCollectionFromDirectory` function
+ */
+type CreatePipelineCollectionFromUrlyOptions = {
+    /**
+     * If true, the collection creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    readonly isLazyLoaded?: boolean;
+};
+/**
+ * Constructs Promptbook from remote Promptbase URL
+
+ * @returns PipelineCollection
+ */
+export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
+export {};
+/**
+ * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
+ */

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

@@ -1,12 +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;
+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/commands/BLOCK/BlockCommand.d.ts

@@ -1,11 +1,11 @@
-import type { BlockType } from './BlockTypes';
-/**
- * Parsed BLOCK command
- *
- * @see ./blockCommandParser.ts for more details
- * @private within the commands folder
- */
-export type BlockCommand = {
-    readonly type: 'BLOCK';
-    readonly blockType: BlockType;
-};
+import type { BlockType } from './BlockTypes';
+/**
+ * Parsed BLOCK command
+ *
+ * @see ./blockCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type BlockCommand = {
+    readonly type: 'BLOCK';
+    readonly blockType: BlockType;
+};

package/umd/typings/src/commands/BLOCK/BlockTypes.d.ts

@@ -1,13 +1,13 @@
-import type { TupleToUnion } from 'type-fest';
-/**
- * Block type describes the way how the block is blockd
- *
- * @see https://github.com/webgptorg/promptbook#block-type
- */
-export type BlockType = TupleToUnion<typeof BlockTypes>;
-/**
- * Block type describes the way how the block is blockd
- *
- * @see https://github.com/webgptorg/promptbook#block-type
- */
-export declare const BlockTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT", "PROMPT_DIALOG", "SAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Block type describes the way how the block is blockd
+ *
+ * @see https://github.com/webgptorg/promptbook#block-type
+ */
+export type BlockType = TupleToUnion<typeof BlockTypes>;
+/**
+ * Block type describes the way how the block is blockd
+ *
+ * @see https://github.com/webgptorg/promptbook#block-type
+ */
+export declare const BlockTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT", "PROMPT_DIALOG", "SAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];

package/umd/typings/src/commands/BLOCK/blockCommand.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/umd/typings/src/commands/BLOCK/blockCommandParser.d.ts

@@ -1,9 +1,9 @@
-import type { CommandParser } from '../_common/types/CommandParser';
-import type { BlockCommand } from './BlockCommand';
-/**
- * Parses the block command
- *
- * @see ./BLOCK-README.md for more details
- * @private within the commands folder
- */
-export declare const blockCommandParser: CommandParser<BlockCommand>;
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { BlockCommand } from './BlockCommand';
+/**
+ * Parses the block command
+ *
+ * @see ./BLOCK-README.md for more details
+ * @private within the commands folder
+ */
+export declare const blockCommandParser: CommandParser<BlockCommand>;

package/umd/typings/src/commands/EXPECT/ExpectAmountCommand.d.ts

@@ -1,14 +1,14 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
-import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
-/**
- * Expect amount command describes the desired output of the prompt template (after post-processing)
- * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
- *
- * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
- */
-export type ExpectAmountCommand = {
-    readonly type: 'EXPECT_AMOUNT';
-    readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
-    readonly unit: ExpectationUnit;
-    readonly amount: ExpectationAmount;
-};
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
+/**
+ * Expect amount command describes the desired output of the prompt template (after post-processing)
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
+ *
+ * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
+ */
+export type ExpectAmountCommand = {
+    readonly type: 'EXPECT_AMOUNT';
+    readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
+    readonly unit: ExpectationUnit;
+    readonly amount: ExpectationAmount;
+};

package/umd/typings/src/commands/EXPECT/ExpectCommand.d.ts

@@ -1,9 +1,9 @@
-import type { ExpectAmountCommand } from "./ExpectAmountCommand";
-import type { ExpectFormatCommand } from "./ExpectFormatCommand";
-/**
- * Parsed EXPECT command
- *
- * @see ./expectCommandParser.ts for more details
- * @private within the commands folder
- */
-export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;
+import type { ExpectAmountCommand } from "./ExpectAmountCommand";
+import type { ExpectFormatCommand } from "./ExpectFormatCommand";
+/**
+ * Parsed EXPECT command
+ *
+ * @see ./expectCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;

package/umd/typings/src/commands/EXPECT/ExpectFormatCommand.d.ts

@@ -1,7 +1,7 @@
-/**
- * Represents a command that expects a specific format.
- */
-export type ExpectFormatCommand = {
-    readonly type: 'EXPECT_FORMAT';
-    readonly format: 'JSON';
-};
+/**
+ * Represents a command that expects a specific format.
+ */
+export type ExpectFormatCommand = {
+    readonly type: 'EXPECT_FORMAT';
+    readonly format: 'JSON';
+};

package/umd/typings/src/commands/EXPECT/expectCommand.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/umd/typings/src/commands/EXPECT/expectCommandParser.d.ts

@@ -1,9 +1,9 @@
-import type { CommandParser } from '../_common/types/CommandParser';
-import type { ExpectCommand } from './ExpectCommand';
-/**
- * Parses the expect command
- *
- * @see ./EXPECT-README.md for more details
- * @private within the commands folder
- */
-export declare const expectCommandParser: CommandParser<ExpectCommand>;
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { ExpectCommand } from './ExpectCommand';
+/**
+ * Parses the expect command
+ *
+ * @see ./EXPECT-README.md for more details
+ * @private within the commands folder
+ */
+export declare const expectCommandParser: CommandParser<ExpectCommand>;

package/umd/typings/src/commands/JOKER/JokerCommand.d.ts

@@ -1,11 +1,11 @@
-import type { string_name } from '../../types/typeAliases';
-/**
- * Parsed JOKER command
- *
- * @see ./jokerCommandParser.ts for more details
- * @private within the commands folder
- */
-export type JokerCommand = {
-    readonly type: 'JOKER';
-    readonly parameterName: string_name;
-};
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Parsed JOKER command
+ *
+ * @see ./jokerCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type JokerCommand = {
+    readonly type: 'JOKER';
+    readonly parameterName: string_name;
+};

package/umd/typings/src/commands/JOKER/jokerCommand.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/umd/typings/src/commands/JOKER/jokerCommandParser.d.ts

@@ -1,9 +1,9 @@
-import type { CommandParser } from '../_common/types/CommandParser';
-import type { JokerCommand } from './JokerCommand';
-/**
- * Parses the joker command
- *
- * @see ./JOKER-README.md for more details
- * @private within the commands folder
- */
-export declare const jokerCommandParser: CommandParser<JokerCommand>;
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { JokerCommand } from './JokerCommand';
+/**
+ * Parses the joker command
+ *
+ * @see ./JOKER-README.md for more details
+ * @private within the commands folder
+ */
+export declare const jokerCommandParser: CommandParser<JokerCommand>;

package/umd/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts

@@ -1,11 +1,11 @@
-import type { string_knowledge_source } from '../../types/typeAliases';
-/**
- * Parsed KNOWLEDGE command
- *
- * @see ./knowledgeCommandParser.ts for more details
- * @private within the commands folder
- */
-export type KnowledgeCommand = {
-    readonly type: 'KNOWLEDGE';
-    readonly source: string_knowledge_source;
-};
+import type { string_knowledge_source } from '../../types/typeAliases';
+/**
+ * Parsed KNOWLEDGE command
+ *
+ * @see ./knowledgeCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type KnowledgeCommand = {
+    readonly type: 'KNOWLEDGE';
+    readonly source: string_knowledge_source;
+};

package/umd/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts

@@ -1 +1 @@
-export {};
+export {};