@promptbook/cli 0.62.2 → 0.63.0-0

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

@@ -1,22 +1,23 @@
-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
+ * @public exported from `@promptbook/core`
+ */
+export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PipelineJson>> | (() => Promise<Array<PipelineJson>>)): PipelineCollection;

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

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

package/esm/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
+ * @public exported from `@promptbook/core`
+ */
+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/esm/typings/src/collection/constructors/createSubcollection.d.ts

@@ -1,12 +1,13 @@
-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
+ * @public exported from `@promptbook/core`
+ */
+export declare function createSubcollection(collection: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;

package/esm/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/esm/typings/src/commands/BLOCK/BlockTypes.d.ts

@@ -1,13 +1,15 @@
-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
+ * @public exported from `@promptbook/core`
+ */
+export type BlockType = TupleToUnion<typeof BlockTypes>;
+/**
+ * Block type describes the way how the block is blockd
+ *
+ * @see https://github.com/webgptorg/promptbook#block-type
+ * @public exported from `@promptbook/core`
+ */
+export declare const BlockTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT", "PROMPT_DIALOG", "SAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];

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

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

package/esm/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/esm/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/esm/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/esm/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/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts

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

package/esm/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/esm/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/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts

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

package/esm/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/esm/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/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts

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

package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts

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

package/esm/typings/src/commands/MODEL/ModelCommand.d.ts

@@ -1,13 +1,13 @@
-import type { ModelRequirements } from '../../types/ModelRequirements';
-import type { TODO_any } from '../../utils/organization/TODO_any';
-/**
- * Parsed MODEL command
- *
- * @see ./modelCommandParser.ts for more details
- * @private within the commands folder
- */
-export type ModelCommand = {
-    readonly type: 'MODEL';
-    readonly key: keyof ModelRequirements;
-    readonly value: TODO_any;
-};
+import type { ModelRequirements } from '../../types/ModelRequirements';
+import type { TODO_any } from '../../utils/organization/TODO_any';
+/**
+ * Parsed MODEL command
+ *
+ * @see ./modelCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ModelCommand = {
+    readonly type: 'MODEL';
+    readonly key: keyof ModelRequirements;
+    readonly value: TODO_any;
+};

package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts

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

package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts

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

package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts

@@ -1,15 +1,15 @@
-import type { string_markdown_text } from '../../types/typeAliases';
-import type { string_name } from '../../types/typeAliases';
-/**
- * Parsed PARAMETER command
- *
- * @see ./parameterCommandParser.ts for more details
- * @private within the commands folder
- */
-export type ParameterCommand = {
-    readonly type: 'PARAMETER';
-    readonly isInput: boolean;
-    readonly isOutput: boolean;
-    readonly parameterName: string_name;
-    readonly parameterDescription: string_markdown_text | null;
-};
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Parsed PARAMETER command
+ *
+ * @see ./parameterCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ParameterCommand = {
+    readonly type: 'PARAMETER';
+    readonly isInput: boolean;
+    readonly isOutput: boolean;
+    readonly parameterName: string_name;
+    readonly parameterDescription: string_markdown_text | null;
+};

package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts

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

package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts

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

package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts

@@ -1,13 +1,13 @@
-import type { string_name } from '../../types/typeAliases';
-import type { string_persona_description } from '../../types/typeAliases';
-/**
- * Parsed PERSONA command
- *
- * @see ./personaCommandParser.ts for more details
- * @private within the commands folder
- */
-export type PersonaCommand = {
-    readonly type: 'PERSONA';
-    readonly personaName: string_name;
-    readonly personaDescription: string_persona_description | null;
-};
+import type { string_name } from '../../types/typeAliases';
+import type { string_persona_description } from '../../types/typeAliases';
+/**
+ * Parsed PERSONA command
+ *
+ * @see ./personaCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type PersonaCommand = {
+    readonly type: 'PERSONA';
+    readonly personaName: string_name;
+    readonly personaDescription: string_persona_description | null;
+};

package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts

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

package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts

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

package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts

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

package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts

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

package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts

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

package/esm/typings/src/commands/PROMPTBOOK_VERSION/PromptbookVersionCommand.d.ts

@@ -1,11 +1,11 @@
-import type { string_semantic_version } from '../../types/typeAliases';
-/**
- * Parsed PROMPTBOOK_VERSION command
- *
- * @see ./promptbookVersionCommandParser.ts for more details
- * @private within the commands folder
- */
-export type PromptbookVersionCommand = {
-    readonly type: 'PROMPTBOOK_VERSION';
-    readonly promptbookVersion: string_semantic_version;
-};
+import type { string_semantic_version } from '../../types/typeAliases';
+/**
+ * Parsed PROMPTBOOK_VERSION command
+ *
+ * @see ./promptbookVersionCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type PromptbookVersionCommand = {
+    readonly type: 'PROMPTBOOK_VERSION';
+    readonly promptbookVersion: string_semantic_version;
+};

package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommand.test.d.ts

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