@promptbook/markdown-utils 0.74.0-8 → 0.75.0-1

package/esm/typings/promptbook-collection/index.d.ts

@@ -1,6 +1,7 @@
 declare const _default: ({
     title: string;
     pipelineUrl: string;
+    formfactorName: string;
     parameters: {
         name: string;
         description: string;
@@ -23,6 +24,7 @@ declare const _default: ({
 } | {
     title: string;
     pipelineUrl: string;
+    formfactorName: string;
     parameters: {
         name: string;
         description: string;
@@ -51,6 +53,7 @@ declare const _default: ({
 } | {
     title: string;
     pipelineUrl: string;
+    formfactorName: string;
     parameters: {
         name: string;
         description: string;

package/esm/typings/src/_packages/core.index.d.ts

@@ -7,6 +7,7 @@ import { createSubcollection } from '../collection/constructors/createSubcollect
 import type { TemplateType } from '../commands/TEMPLATE/TemplateTypes';
 import { TemplateTypes } from '../commands/TEMPLATE/TemplateTypes';
 import { CLAIM } from '../config';
+import { DEFAULT_TITLE } from '../config';
 import { MAX_FILENAME_LENGTH } from '../config';
 import { DEFAULT_INTERMEDIATE_FILES_STRATEGY } from '../config';
 import { DEFAULT_MAX_PARALLEL_COUNT } from '../config';
@@ -58,6 +59,12 @@ import { CsvFormatDefinition } from '../formats/csv/CsvFormatDefinition';
 import { CsvFormatError } from '../formats/csv/CsvFormatError';
 import { MANDATORY_CSV_SETTINGS } from '../formats/csv/CsvSettings';
 import { TextFormatDefinition } from '../formats/text/TextFormatDefinition';
+import { BoilerplateFormfactorDefinition } from '../formfactors/_boilerplate/BoilerplateFormfactorDefinition';
+import { ChatFormfactorDefinition } from '../formfactors/chat/ChatFormfactorDefinition';
+import { GenericFormfactorDefinition } from '../formfactors/generic/GenericFormfactorDefinition';
+import { FORMFACTOR_DEFINITIONS } from '../formfactors/index';
+import { SheetsFormfactorDefinition } from '../formfactors/sheets/SheetsFormfactorDefinition';
+import { TranslatorFormfactorDefinition } from '../formfactors/translator/TranslatorFormfactorDefinition';
 import { $llmToolsMetadataRegister } from '../llm-providers/_common/register/$llmToolsMetadataRegister';
 import { $llmToolsRegister } from '../llm-providers/_common/register/$llmToolsRegister';
 import { createLlmToolsFromConfiguration } from '../llm-providers/_common/register/createLlmToolsFromConfiguration';
@@ -71,6 +78,10 @@ import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlm
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { preparePersona } from '../personas/preparePersona';
+import { GENERIC_PIPELINE_INTERFACE } from '../pipeline/pipeline-interface/constants';
+import { getPipelineInterface } from '../pipeline/pipeline-interface/getPipelineInterface';
+import { isPipelineImplementingInterface } from '../pipeline/pipeline-interface/isPipelineImplementingInterface';
+import { isPipelineInterfacesEqual } from '../pipeline/pipeline-interface/isPipelineInterfacesEqual';
 import { isPipelinePrepared } from '../prepare/isPipelinePrepared';
 import { preparePipeline } from '../prepare/preparePipeline';
 import { prepareTemplates } from '../prepare/prepareTemplates';
@@ -84,8 +95,9 @@ import { _DocumentScraperMetadataRegistration } from '../scrapers/document/regis
 import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
 import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
+import { BlackholeStorage } from '../storage/blackhole/BlackholeStorage';
 import { MemoryStorage } from '../storage/memory/MemoryStorage';
-import { PrefixStorage } from '../storage/memory/utils/PrefixStorage';
+import { PrefixStorage } from '../storage/utils/PrefixStorage';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
 import { ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
@@ -100,6 +112,7 @@ export { createSubcollection };
 export type { TemplateType };
 export { TemplateTypes };
 export { CLAIM };
+export { DEFAULT_TITLE };
 export { MAX_FILENAME_LENGTH };
 export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };
 export { DEFAULT_MAX_PARALLEL_COUNT };
@@ -151,6 +164,12 @@ export { CsvFormatDefinition };
 export { CsvFormatError };
 export { MANDATORY_CSV_SETTINGS };
 export { TextFormatDefinition };
+export { BoilerplateFormfactorDefinition };
+export { ChatFormfactorDefinition };
+export { GenericFormfactorDefinition };
+export { FORMFACTOR_DEFINITIONS };
+export { SheetsFormfactorDefinition };
+export { TranslatorFormfactorDefinition };
 export { $llmToolsMetadataRegister };
 export { $llmToolsRegister };
 export { createLlmToolsFromConfiguration };
@@ -164,6 +183,10 @@ export { MultipleLlmExecutionTools };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
 export { preparePersona };
+export { GENERIC_PIPELINE_INTERFACE };
+export { getPipelineInterface };
+export { isPipelineImplementingInterface };
+export { isPipelineInterfacesEqual };
 export { isPipelinePrepared };
 export { preparePipeline };
 export { prepareTemplates };
@@ -177,6 +200,7 @@ export { _DocumentScraperMetadataRegistration };
 export { _MarkdownScraperMetadataRegistration };
 export { _PdfScraperMetadataRegistration };
 export { _WebsiteScraperMetadataRegistration };
+export { BlackholeStorage };
 export { MemoryStorage };
 export { PrefixStorage };
 export { executionReportJsonToString };

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

@@ -39,6 +39,9 @@ import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
 import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
 import type { FormatSubvalueDefinition } from '../formats/_common/FormatSubvalueDefinition';
 import type { CsvSettings } from '../formats/csv/CsvSettings';
+import type { AbstractFormfactorDefinition } from '../formfactors/_common/AbstractFormfactorDefinition';
+import type { FormfactorDefinition } from '../formfactors/_common/FormfactorDefinition';
+import type { string_formfactor_name } from '../formfactors/_common/string_formfactor_name';
 import type { LlmToolsConfiguration } from '../llm-providers/_common/register/LlmToolsConfiguration';
 import type { LlmToolsMetadata } from '../llm-providers/_common/register/LlmToolsMetadata';
 import type { LlmToolsOptions } from '../llm-providers/_common/register/LlmToolsOptions';
@@ -67,6 +70,8 @@ import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/Rem
 import type { AnonymousRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
 import type { CollectionRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
 import type { CollectionRemoteServerClientOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
+import type { IsPipelineImplementingInterfaceOptions } from '../pipeline/pipeline-interface/isPipelineImplementingInterface';
+import type { PipelineInterface } from '../pipeline/pipeline-interface/PipelineInterface';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
 import type { Converter } from '../scrapers/_common/Converter';
 import type { ScraperAndConverterMetadata } from '../scrapers/_common/register/ScraperAndConverterMetadata';
@@ -283,6 +288,9 @@ export type { UserInterfaceTools };
 export type { UserInterfaceToolsPromptDialogOptions };
 export type { FormatSubvalueDefinition };
 export type { CsvSettings };
+export type { AbstractFormfactorDefinition };
+export type { FormfactorDefinition };
+export type { string_formfactor_name };
 export type { LlmToolsConfiguration };
 export type { LlmToolsMetadata };
 export type { LlmToolsOptions };
@@ -311,6 +319,8 @@ export type { RemoteServerOptions };
 export type { AnonymousRemoteServerOptions };
 export type { CollectionRemoteServerOptions };
 export type { CollectionRemoteServerClientOptions };
+export type { IsPipelineImplementingInterfaceOptions };
+export type { PipelineInterface };
 export type { PrepareAndScrapeOptions };
 export type { Converter };
 export type { ScraperAndConverterMetadata };

package/esm/typings/src/_packages/utils.index.d.ts

@@ -12,6 +12,8 @@ import { $currentDate } from '../utils/$currentDate';
 import { $isRunningInBrowser } from '../utils/environment/$isRunningInBrowser';
 import { $isRunningInNode } from '../utils/environment/$isRunningInNode';
 import { $isRunningInWebWorker } from '../utils/environment/$isRunningInWebWorker';
+import { CHARACTERS_PER_STANDARD_LINE } from '../utils/expectation-counters/constants';
+import { LINES_PER_STANDARD_PAGE } from '../utils/expectation-counters/constants';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
 import { countPages } from '../utils/expectation-counters/countPages';
@@ -83,6 +85,8 @@ export { $currentDate };
 export { $isRunningInBrowser };
 export { $isRunningInNode };
 export { $isRunningInWebWorker };
+export { CHARACTERS_PER_STANDARD_LINE };
+export { LINES_PER_STANDARD_PAGE };
 export { countCharacters };
 export { countLines };
 export { countPages };

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

@@ -6,7 +6,7 @@ import type { Command as Program } from 'commander';
  */
 export declare function initializeRunCommand(program: Program): void;
 /**
- * TODO: !!!!!! Catch and wrap all errors from CLI
+ * TODO: !!!!! Catch and wrap all errors from CLI
  * TODO: [🧠] Pass `maxExecutionAttempts`, `csvSettings`
  * TODO: [🥃][main] !!! Allow `ptbk run` without configuring any llm tools
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/main.d.ts

@@ -1,11 +1,14 @@
 import { promptbookCli } from './promptbookCli';
+/**
+ * Note: [🔺] Purpose of this file is to export CLI for production environment
+ */
 /**
  * Hidden utilities which should not be used by external consumers.
  *
  * @public exported from `@promptbook/cli`
  */
 export declare const _CLI: {
-    _initialize: typeof promptbookCli;
+    _initialize_promptbookCli: typeof promptbookCli;
 };
 /**
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/promptbookCli.d.ts

@@ -5,7 +5,7 @@
  */
 export declare function promptbookCli(): Promise<void>;
 /**
- * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.ptbk.md` -> `ptbk ./foo.ptbk.md`
+ * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.book.md` -> `ptbk ./foo.book.md`
  * TODO: [🥠] Do not export, its just for CLI script
  * TODO: [🕌] When more functionalities, rename
  * Note: 11:11

package/esm/typings/src/cli/test/ptbk.d.ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env ts-node
 /**
- * Note: Purpose of this file !!!!!!! vs other place
+ * Note: [🔺] Purpose of this file is to test the CLI in development environment
  */
 import '../../_packages/cli.index.ts';

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

@@ -1,6 +1,6 @@
 export {};
 /**
- * Note: [🐠] For example here URL https://example.com/pipeline.ptbk.md is not valid
+ * Note: [🐠] For example here URL https://example.com/pipeline.book.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/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts

@@ -5,7 +5,7 @@ import type { PipelineCollection } from '../PipelineCollection';
 /**
  * Options for `createCollectionFromDirectory` function
  *
- * Note: `rootDirname` is not needed because it is the folder in which `.ptbk.md` file is located
+ * Note: `rootDirname` is not needed because it is the folder in which `.book.md` file is located
  *       This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
  */
 type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {

package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts

@@ -7,5 +7,5 @@ import type { string_semantic_version } from '../../types/typeAliases';
  */
 export type BookVersionCommand = {
     readonly type: 'BOOK_VERSION';
-    readonly promptbookVersion: string_semantic_version;
+    readonly bookVersion: string_semantic_version;
 };

package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts

@@ -3,12 +3,12 @@ import type { ForeachCommand } from './ForeachCommand';
 /**
  * Parses the foreach command
  *
- * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.ptbk.md` file
+ * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book.md` file
  *
  * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
 /**
- * TODO: [🍭] Make .ptbk.md file with examples of the FOREACH with wrong parsing and logic
+ * TODO: [🍭] Make .book.md file with examples of the FOREACH with wrong parsing and logic
  */

package/esm/typings/src/commands/FORMFACTOR/FormfactorCommand.d.ts

@@ -0,0 +1,11 @@
+import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
+/**
+ * Parsed FORMFACTOR command
+ *
+ * @see ./formfactorCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type FormfactorCommand = {
+    readonly type: 'FORMFACTOR';
+    readonly formfactorName: string_formfactor_name;
+};

package/esm/typings/src/commands/FORMFACTOR/formfactorCommand.test.d.ts

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

package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts

@@ -0,0 +1,11 @@
+import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
+import type { FormfactorCommand } from './FormfactorCommand';
+/**
+ * Parses the formfactor command
+ *
+ * Note: @@@ This command is used as formfactor for new commands - it should NOT be used in any `.book.md` file
+ *
+ * @see `documentationUrl` for more details
+ * @private within the commands folder
+ */
+export declare const formfactorCommandParser: PipelineHeadCommandParser<FormfactorCommand>;

package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
 /**
  * Parses the boilerplate command
  *
- * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.ptbk.md` file
+ * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book.md` file
  *
  * @see `documentationUrl` for more details
  * @private within the commands folder

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

@@ -99,6 +99,8 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
 };
 /**
  * @@@
+ *
+ * TODO: !!!!!! Rename to PipelineTaskCommandParser, applyToTaskJson, TaskJson, isUsedInPipelineTask,...
  */
 export type PipelineTemplateCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
     /**

package/esm/typings/src/commands/index.d.ts

@@ -3,4 +3,4 @@
  *
  * @private internal index of `parseCommand`
  */
-export declare const COMMANDS: readonly [import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./TEMPLATE/TemplateCommand").TemplateCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./FORMAT/FormatCommand").FormatCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./BOOK_VERSION/BookVersionCommand").BookVersionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./FOREACH/ForeachCommand").ForeachCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];
+export declare const COMMANDS: readonly [import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./TEMPLATE/TemplateCommand").TemplateCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./FORMAT/FormatCommand").FormatCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./BOOK_VERSION/BookVersionCommand").BookVersionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./FORMFACTOR/FormfactorCommand").FormfactorCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").PipelineTemplateCommandParser<import("./FOREACH/ForeachCommand").ForeachCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];

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

@@ -14,6 +14,12 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
  * @public exported from `@promptbook/core`
  */
 export declare const CLAIM = "Build responsible, controlled and transparent applications on top of LLM models!";
+/**
+ * When the title is not provided, the default title is used
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_TITLE = "Untitled";
 /**
  * Warning message for the generated sections and files files
  *
@@ -186,5 +192,6 @@ export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
  */
 export declare const IS_COST_PREVENTED: boolean;
 /**
+ * TODO: Extract `constants.ts` from `config.ts`
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */

package/esm/typings/src/conversion/pipelineJsonToString.d.ts

@@ -3,8 +3,8 @@ import type { PipelineString } from '../types/PipelineString';
 /**
  * Converts promptbook in JSON format to string format
  *
- * @param pipelineJson Promptbook in JSON format (.ptbk.json)
- * @returns Promptbook in string format (.ptbk.md)
+ * @param pipelineJson Promptbook in JSON format (.book.json)
+ * @returns Promptbook in string format (.book.md)
  * @public exported from `@promptbook/core`
  */
 export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
@@ -13,5 +13,5 @@ export declare function pipelineJsonToString(pipelineJson: PipelineJson): Pipeli
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
  * TODO: [🏛] Maybe make some markdown builder
  * TODO: [🏛] Escape all
- * TODO: [🧠] Should be in generated .ptbk.md file GENERATOR_WARNING
+ * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
  */

package/esm/typings/src/conversion/pipelineStringToJson.d.ts

@@ -13,10 +13,10 @@ import type { PipelineString } from '../types/PipelineString';
  * Note: This function does not validate logic of the pipeline only the parsing
  * Note: This function acts as compilation process
  *
- * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
  * @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
  * @param options - Options and tools for the compilation
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @returns {Promptbook} compiled in JSON format (.book.json)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -11,8 +11,8 @@ import type { PipelineString } from '../types/PipelineString';
  * Note: This function does not validate logic of the pipeline only the parsing
  * Note: This function acts as compilation process
  *
- * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
+ * @returns {Promptbook} compiled in JSON format (.book.json)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/conversion/utils/stringifyPipelineJson.d.ts

@@ -9,7 +9,7 @@ import type { string_json } from '../../types/typeAliases';
  */
 export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
 /**
- * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.ptbk.md
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
  * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
  * TODO: [🧠] Maybe more elegant solution than replacing via regex
  * TODO: [🍙] Make some standard order of json properties

package/esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -2,7 +2,7 @@ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { PipelineString } from '../../types/PipelineString';
 import type { string_json } from '../../types/typeAliases';
 /**
- * Import the pipeline.ptbk.md or pipeline.ptbk.json file
+ * Import the pipeline.book.md or pipeline.book.json file
  *
  * Note: Using here custom import to work in jest tests
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
@@ -10,20 +10,20 @@ import type { string_json } from '../../types/typeAliases';
  * @param path - The path to the file relative to examples/pipelines directory
  * @private internal function of tests
  */
-export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
-export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.json`): PipelineJson;
+export declare function importPipelineWithoutPreparation(path: `${string}.book.md`): PipelineString;
+export declare function importPipelineWithoutPreparation(path: `${string}.book.json`): PipelineJson;
 /**
- * Import the pipeline.ptbk.json file as parsed JSON
+ * Import the pipeline.book.json file as parsed JSON
  *
  * @private internal function of tests
  */
-export declare function importPipelineJson(path: `${string}.ptbk.json`): PipelineJson;
+export declare function importPipelineJson(path: `${string}.book.json`): PipelineJson;
 /**
- * Import the pipeline.ptbk.json file as string
+ * Import the pipeline.book.json file as string
  *
  * @private internal function of tests
  */
-export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;
+export declare function importPipelineJsonAsString(path: `${string}.book.json`): string_json<PipelineJson>;
 /**
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/formats/_common/FormatDefinition.d.ts

@@ -13,7 +13,7 @@ import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
  */
 export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
     /**
-     * The name of the format used in .ptbk.md files
+     * The name of the format used in .book.md files
      *
      * @example "JSON"
      */

package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts

@@ -9,7 +9,7 @@ import type { empty_object } from '../../utils/organization/empty_object';
  */
 export type FormatSubvalueDefinition<TValue extends string, TSettings extends empty_object> = {
     /**
-     * The name of the format used in .ptbk.md files
+     * The name of the format used in .book.md files
      *
      * @example "CELL"
      */

package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Boilerplate is form of app that @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const BoilerplateFormfactorDefinition: {
+    readonly name: "BOILERPLATE";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly [];
+        readonly outputParameterNames: readonly [];
+    };
+};

package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts

@@ -0,0 +1,34 @@
+import type { PipelineInterface } from '../../pipeline/pipeline-interface/PipelineInterface';
+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_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
+/**
+ * @@@
+ */
+export type AbstractFormfactorDefinition = {
+    /**
+     * @@@
+     */
+    readonly name: string_name & string_SCREAMING_CASE;
+    /**
+     * @@@
+     */
+    readonly aliasNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    /**
+     * @@@
+     */
+    readonly deprecatedNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    /**
+     * @@@
+     */
+    readonly description: string_markdown_text;
+    /**
+     * @@@
+     */
+    readonly documentationUrl: string_promptbook_documentation_url;
+    /**
+     * @@@
+     */
+    readonly pipelineInterface: PipelineInterface;
+};

package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts

@@ -0,0 +1,5 @@
+import { FORMFACTOR_DEFINITIONS } from '../index';
+/**
+ * @@@
+ */
+export type FormfactorDefinition = typeof FORMFACTOR_DEFINITIONS[number];

package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts

@@ -0,0 +1,5 @@
+import type { FormfactorDefinition } from './FormfactorDefinition';
+/**
+ * @@@
+ */
+export type string_formfactor_name = FormfactorDefinition['name'];

package/esm/typings/src/formfactors/chat/ChatFormfactorDefinition.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ChatFormfactorDefinition: {
+    readonly name: "CHATBOT";
+    readonly aliasNames: readonly ["CHAT"];
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly ["previousTitle", "previousConversationSummary", "userMessage"];
+        readonly outputParameterNames: readonly ["title", "conversationSummary", "chatbotResponse"];
+    };
+};

package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const GenericFormfactorDefinition: {
+    readonly name: "GENERIC";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly [];
+        readonly outputParameterNames: readonly [];
+    };
+};

package/esm/typings/src/formfactors/index.d.ts

@@ -0,0 +1,39 @@
+/**
+ * All available formfactor definitions
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const FORMFACTOR_DEFINITIONS: readonly [{
+    readonly name: "GENERIC";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly [];
+        readonly outputParameterNames: readonly [];
+    };
+}, {
+    readonly name: "CHATBOT";
+    readonly aliasNames: readonly ["CHAT"];
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly ["previousTitle", "previousConversationSummary", "userMessage"];
+        readonly outputParameterNames: readonly ["title", "conversationSummary", "chatbotResponse"];
+    };
+}, {
+    readonly name: "TRANSLATOR";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly ["inputMessage"];
+        readonly outputParameterNames: readonly ["outputMessage"];
+    };
+}, {
+    readonly name: "SHEETS";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly ["inputSheet"];
+        readonly outputParameterNames: readonly ["outputSheet"];
+    };
+}];

package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Sheets is form of app that @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const SheetsFormfactorDefinition: {
+    readonly name: "SHEETS";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly ["inputSheet"];
+        readonly outputParameterNames: readonly ["outputSheet"];
+    };
+};

package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Translator is form of app that @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const TranslatorFormfactorDefinition: {
+    readonly name: "TRANSLATOR";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly ["inputMessage"];
+        readonly outputParameterNames: readonly ["outputMessage"];
+    };
+};