@promptbook/markdown-utils 0.75.0-1 → 0.75.0-4

package/esm/typings/src/commands/TEMPLATE/TemplateCommand.d.ts

@@ -1,11 +0,0 @@
-import type { TemplateType } from './TemplateTypes';
-/**
- * Parsed TEMPLATE command
- *
- * @see ./templateCommandParser.ts for more details
- * @private within the commands folder
- */
-export type TemplateCommand = {
-    readonly type: 'TEMPLATE';
-    readonly templateType: TemplateType;
-};

package/esm/typings/src/commands/TEMPLATE/TemplateTypes.d.ts

@@ -1,15 +0,0 @@
-import type { TupleToUnion } from 'type-fest';
-/**
- * Template type describes the way how the template is templated
- *
- * @see https://github.com/webgptorg/promptbook#template-type
- * @public exported from `@promptbook/core`
- */
-export type TemplateType = TupleToUnion<typeof TemplateTypes>;
-/**
- * Template type describes the way how the template is templated
- *
- * @see https://github.com/webgptorg/promptbook#template-type
- * @public exported from `@promptbook/core`
- */
-export declare const TemplateTypes: readonly ["PROMPT_TEMPLATE", "SIMPLE_TEMPLATE", "SCRIPT_TEMPLATE", "DIALOG_TEMPLATE", "EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];

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

@@ -1,15 +0,0 @@
-import type { ReadonlyDeep } from 'type-fest';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
-import type { string_parameter_name } from '../../types/typeAliases';
-/**
- * Parses the template and returns the set of all used parameters
- *
- * @param template the template with used parameters
- * @returns the set of parameter names
- * @throws {ParseError} if the script is invalid
- * @public exported from `@promptbook/utils`
- */
-export declare function extractParameterNamesFromTemplate(template: ReadonlyDeep<Pick<TemplateJson, 'title' | 'description' | 'templateType' | 'content' | 'preparedContent' | 'jokerParameterNames' | 'foreach'>>): Set<string_parameter_name>;
-/**
- * TODO: [🔣] If script require contentLanguage
- */

package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTemplate.d.ts

@@ -1,27 +0,0 @@
-import type { ReadonlyDeep } from 'type-fest';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_parameter_value } from '../../types/typeAliases';
-/**
- * @@@
- *
- * @private internal type of `getKnowledgeForTemplate`
- */
-type GetKnowledgeForTemplateOptions = {
-    /**
-     * @@@
-     */
-    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
-    /**
-     * @@@
-     */
-    readonly template: ReadonlyDeep<TemplateJson>;
-};
-/**
- * @@@
- *
- * @private internal utility of `createPipelineExecutor`
- */
-export declare function getKnowledgeForTemplate(options: GetKnowledgeForTemplateOptions): Promise<string_parameter_value & string_markdown>;
-export {};

package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTemplate.d.ts

@@ -1,30 +0,0 @@
-import type { ReadonlyDeep } from 'type-fest';
-import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
-import type { ReservedParameters } from '../../types/typeAliases';
-/**
- * @@@
- *
- * @private internal type of `getReservedParametersForTemplate`
- */
-type GetReservedParametersForTemplateOptions = {
-    /**
-     * @@@
-     */
-    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
-    /**
-     * @@@
-     */
-    readonly template: ReadonlyDeep<TemplateJson>;
-    /**
-     * @@@
-     */
-    readonly pipelineIdentification: string;
-};
-/**
- * @@@
- *
- * @private internal utility of `createPipelineExecutor`
- */
-export declare function getReservedParametersForTemplate(options: GetReservedParametersForTemplateOptions): Promise<Readonly<ReservedParameters>>;
-export {};

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

@@ -1,15 +0,0 @@
-/**
- * @@@
- *
- * @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/pipeline/pipeline-interface/PipelineInterface.d.ts

@@ -1,22 +0,0 @@
-import type { string_parameter_name } from '../../types/typeAliases';
-/**
- * @@@
- */
-export type PipelineInterface = {
-    /**
-     * @@@
-     *
-     * Note: Sorted alphabetically
-     */
-    readonly inputParameterNames: ReadonlyArray<string_parameter_name>;
-    /**
-     * @@@
-     *
-     * Note: Sorted alphabetically
-     */
-    readonly outputParameterNames: ReadonlyArray<string_parameter_name>;
-};
-/**
- * TODO: !!!!!! Change inputParameterNames to inputParameters<InputParameter>
- * TODO: [🧠] Better name than `PipelineInterface` to avoid confusion with typescript `interface`
- */

package/esm/typings/src/pipeline/pipeline-interface/constants.d.ts

@@ -1,9 +0,0 @@
-/**
- * @@@
- *
- * @public exported from `@promptbook/core`
- */
-export declare const GENERIC_PIPELINE_INTERFACE: {
-    readonly inputParameterNames: readonly [];
-    readonly outputParameterNames: readonly [];
-};

package/esm/typings/src/prepare/prepareTemplates.d.ts

@@ -1,32 +0,0 @@
-import type { ExecutionTools } from '../execution/ExecutionTools';
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../types/PipelineJson/TemplateJson';
-import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
-type PrepareTemplateInput = Pick<PipelineJson, 'templates' | 'parameters'> & {
-    /**
-     * @@@
-     */
-    readonly knowledgePiecesCount: number;
-};
-type PreparedTemplates = {
-    /**
-     * @@@ Sequence of templates that are chained together to form a pipeline
-     */
-    readonly templatesPrepared: ReadonlyArray<TemplateJson>;
-};
-/**
- * @@@
- *
- * @public exported from `@promptbook/core`
- */
-export declare function prepareTemplates(pipeline: PrepareTemplateInput, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PreparedTemplates>;
-export {};
-/**
- * TODO: [🧠] Add context to each template (if missing)
- * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
- * TODO: [♨][main] !!! Prepare index the examples and maybe templates
- * TODO: Write tests for `preparePipeline`
- * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
- * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
- * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
- */

package/esm/typings/src/types/PipelineJson/DialogTemplateJson.d.ts

@@ -1,13 +0,0 @@
-import type { TemplateJsonCommon } from './TemplateJsonCommon';
-/**
- * Template for prompt to user
- *
- * Note: [🚉] This is fully serializable as JSON
- * @see https://github.com/webgptorg/promptbook/discussions/76
- */
-export type DialogTemplateJson = TemplateJsonCommon & {
-    readonly templateType: 'DIALOG_TEMPLATE';
-};
-/**
- * TODO: [🍙] Make some standard order of json properties
- */

package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts

@@ -1,39 +0,0 @@
-import type { string_markdown_text } from '../typeAliases';
-import type { string_parameter_name } from '../typeAliases';
-import type { string_parameter_value } from '../typeAliases';
-/**
- * Describes one parameter of the promptbook
- *
- * Note: [🚉] This is fully serializable as JSON
- */
-export type ParameterJson = {
-    /**
-     * Name of the parameter
-     * - It must be unique across the pipeline
-     * - It should start lowercase and contain letters and numbers
-     */
-    readonly name: string_parameter_name;
-    /**
-     * The parameter is input of the pipeline
-     */
-    readonly isInput: boolean;
-    /**
-     * The parameter is output of the pipeline
-     */
-    readonly isOutput: boolean;
-    /**
-     * Description of the parameter
-     * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
-     */
-    readonly description?: string_markdown_text;
-    /**
-     * Example values of the parameter
-     * Note: This values won't be actually used as some default values, but they are just for better understanding of the parameter
-     */
-    readonly exampleValues?: Array<string_parameter_value>;
-};
-/**
- * TODO: [🧠] Should be here registered subparameters from foreach or not?
- * TODO: [♈] Probbably move expectations from templates to parameters
- * TODO: [🍙] Make some standard order of json properties
- */

package/esm/typings/src/types/PipelineJson/ScriptTemplateJson.d.ts

@@ -1,20 +0,0 @@
-import type { ScriptLanguage } from '../ScriptLanguage';
-import type { TemplateJsonCommon } from './TemplateJsonCommon';
-/**
- * Template for script execution
- *
- * Note: [🚉] This is fully serializable as JSON
- * @see https://github.com/webgptorg/promptbook/discussions/77
- */
-export type ScriptTemplateJson = TemplateJsonCommon & {
-    readonly templateType: 'SCRIPT_TEMPLATE';
-    /**
-     * Language of the script
-     * - This is required only for templateType SCRIPT
-     *
-     */
-    readonly contentLanguage?: ScriptLanguage;
-};
-/**
- * TODO: [🍙] Make some standard order of json properties
- */

package/esm/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts

@@ -1,13 +0,0 @@
-import type { TemplateJsonCommon } from './TemplateJsonCommon';
-/**
- * Template for simple concatenation of strings
- *
- * Note: [🚉] This is fully serializable as JSON
- * @see https://github.com/webgptorg/promptbook/discussions/17
- */
-export type SimpleTemplateJson = TemplateJsonCommon & {
-    readonly templateType: 'SIMPLE_TEMPLATE';
-};
-/**
- * TODO: [🍙] Make some standard order of json properties
- */

package/esm/typings/src/types/PipelineJson/TemplateJson.d.ts

@@ -1,11 +0,0 @@
-import type { ___or___ } from '../../utils/organization/___or___';
-import type { DialogTemplateJson } from './DialogTemplateJson';
-import type { PromptTemplateJson } from './PromptTemplateJson';
-import type { ScriptTemplateJson } from './ScriptTemplateJson';
-import type { SimpleTemplateJson } from './SimpleTemplateJson';
-/**
- * Describes one (prompt) template in the promptbook
- *
- * Note: [🚉] This is fully serializable as JSON
- */
-export type TemplateJson = PromptTemplateJson | SimpleTemplateJson | ScriptTemplateJson | DialogTemplateJson | ___or___ | ___or___;