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

package/esm/typings/src/pipeline/PipelineJson/{TaskJsonCommon.d.ts → CommonTaskJson.d.ts}

@@ -1,6 +1,6 @@
 import type { ForeachJson } from '../../commands/FOREACH/ForeachJson';
 import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
-import type { SectionType } from '../../commands/SECTION/SectionType';
+import type { SectionType } from '../../types/SectionType';
 import type { string_javascript } from '../../types/typeAliases';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
@@ -13,32 +13,32 @@ import type { Expectations } from './Expectations';
 /**
  * Common properties of all tasks
  */
-export type TaskJsonCommon = {
+export type CommonTaskJson = {
     /**
-     * Name of the template
+     * Name of the task
      * - It must be unique across the pipeline
      * - It should start uppercase and can contain letters and numbers
-     * - The pipelineUrl together with hash and name are used to identify the template in the pipeline
+     * - The pipelineUrl together with hash and name are used to identify the task in the pipeline
      */
     readonly name: string_name;
     /**
-     * Title of the template
+     * Title of the task
      * It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
     readonly title: string;
     /**
-     * Description of the template
+     * Description of the task
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
     readonly description?: string_markdown_text;
     /**
-     * List of parameter names that are used in the template and must be defined before the template is executed
+     * List of parameter names that are used in the task and must be defined before the task is executed
      *
      * Note: Joker is one of the dependent parameters
      */
     readonly dependentParameterNames: Array<string_parameter_name>;
     /**
-     * If theese parameters meet the expectations requirements, they are used instead of executing this template
+     * If theese parameters meet the expectations requirements, they are used instead of executing this task
      *
      * @see https://github.com/webgptorg/promptbook/discussions/66
      */
@@ -49,17 +49,17 @@ export type TaskJsonCommon = {
     readonly foreach?: ForeachJson;
     /**
      * Type of the execution
-     * This determines if the template is send to LLM, user or some scripting evaluation
+     * This determines if the task is send to LLM, user or some scripting evaluation
      */
     readonly taskType: SectionType;
     /**
-     * Content of the template with {placeholders} for parameters
+     * Content of the task with {placeholders} for parameters
      *
      * @@@ content vs preparedContent
      */
     readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
     /**
-     * @@@ Content of the template with {placeholders} for parameters
+     * @@@ Content of the task with {placeholders} for parameters
      *
      * @@@ content vs preparedContent
      *
@@ -67,7 +67,7 @@ export type TaskJsonCommon = {
      */
     readonly preparedContent?: (string_prompt | string_javascript | string_markdown) & string_template;
     /**
-     * List of postprocessing steps that are executed after the template
+     * List of postprocessing steps that are executed after the task
      *
      * @see https://github.com/webgptorg/promptbook/discussions/31
      */
@@ -90,7 +90,7 @@ export type TaskJsonCommon = {
      */
     readonly format?: FormatCommand['format'];
     /**
-     * Name of the parameter that is the result of the template
+     * Name of the parameter that is the result of the task
      */
     readonly resultingParameterName: string_name;
 };

package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts

@@ -1,11 +1,11 @@
-import type { TaskJsonCommon } from './TaskJsonCommon';
+import type { CommonTaskJson } from './CommonTaskJson';
 /**
  * Task for prompt to user
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/76
  */
-export type DialogTaskJson = TaskJsonCommon & {
+export type DialogTaskJson = CommonTaskJson & {
     readonly taskType: 'DIALOG_TASK';
 };
 /**

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

@@ -90,6 +90,8 @@ export type CommonParameterJson = {
     readonly exampleValues?: Array<string_parameter_value>;
 };
 /**
+ * TODO: [🧠][🛴][♈] Maybe add type + expectations into the intefrace, like "a person name"
+ *       [🛴] @see https://github.com/webgptorg/promptbook/discussions/53
  * TODO: [🧠] Should be here registered subparameters from foreach or not?
  * TODO: [♈] Probbably move expectations from tasks to parameters
  * TODO: [🍙] Make some standard order of json properties

package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts

@@ -11,7 +11,7 @@ import type { string_persona_description } from '../../types/typeAliases';
  */
 export type PersonaJson = {
     /**
-     * Name of the template
+     * Name of the persona
      * - It must be unique across the pipeline
      * - It should start uppercase and can contain letters and numbers
      */

package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts

@@ -14,7 +14,7 @@ import type { PreparationJson } from './PreparationJson';
 import type { TaskJson } from './TaskJson';
 /**
  * Promptbook is the **core concept of this package**.
- * It represents a series of tasks chained together to form a pipeline / one big template with input and result parameters.
+ * It represents a series of tasks chained together to form a pipeline / one big task with input and result parameters.
  *
  * Note: [🚉] This is fully serializable as JSON
  *
@@ -28,7 +28,7 @@ export type PipelineJson = {
      * Note: It must use HTTPs URL
      * Tip: You can do versioning in the URL
      *      For example: https://promptbook.studio/webgpt/write-website-content-cs.book.md@1.0.0
-     * Warning: Do not hash part of the URL, hash part is used for identification of the template in the pipeline
+     * Warning: Do not hash part of the URL, hash part is used for identification of the task in the pipeline
      */
     readonly pipelineUrl?: string_pipeline_url;
     /**

package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts

@@ -1,12 +1,12 @@
 import type { ModelRequirements } from '../../types/ModelRequirements';
 import type { string_name } from '../../types/typeAliases';
-import type { TaskJsonCommon } from './TaskJsonCommon';
+import type { CommonTaskJson } from './CommonTaskJson';
 /**
  * Task for prompt to LLM
  *
  * Note: [🚉] This is fully serializable as JSON
  */
-export type PromptTaskJson = TaskJsonCommon & {
+export type PromptTaskJson = CommonTaskJson & {
     readonly taskType: 'PROMPT_TASK';
     /**
      * Name of the persona who will be responding to this prompt

package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts

@@ -1,12 +1,12 @@
 import type { ScriptLanguage } from '../../types/ScriptLanguage';
-import type { TaskJsonCommon } from './TaskJsonCommon';
+import type { CommonTaskJson } from './CommonTaskJson';
 /**
  * Task for script execution
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/77
  */
-export type ScriptTaskJson = TaskJsonCommon & {
+export type ScriptTaskJson = CommonTaskJson & {
     readonly taskType: 'SCRIPT_TASK';
     /**
      * Language of the script

package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts

@@ -1,11 +1,11 @@
-import type { TaskJsonCommon } from './TaskJsonCommon';
+import type { CommonTaskJson } from './CommonTaskJson';
 /**
  * Task for simple concatenation of strings
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/17
  */
-export type SimpleTaskJson = TaskJsonCommon & {
+export type SimpleTaskJson = CommonTaskJson & {
     readonly taskType: 'SIMPLE_TASK';
 };
 /**

package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts

@@ -4,7 +4,7 @@ import type { PromptTaskJson } from './PromptTaskJson';
 import type { ScriptTaskJson } from './ScriptTaskJson';
 import type { SimpleTaskJson } from './SimpleTaskJson';
 /**
- * Describes one (prompt) template in the promptbook
+ * Describes one (prompt) task in the pipeline
  *
  * Note: [🚉] This is fully serializable as JSON
  */

package/esm/typings/src/pipeline/PipelineString.d.ts

@@ -1,6 +1,6 @@
 /**
  * Promptbook is the **core concept of this package**.
- * It represents a series of tasks chained together to form a pipeline / one big template with input and result parameters.
+ * It represents a series of tasks chained together to form a pipeline / one big task with input and result parameters.
  *
  * @see @@@ https://github.com/webgptorg/promptbook#promptbook
  */

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

@@ -10,7 +10,7 @@ export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
  * TODO: [🐠] Maybe base this on `makeValidator`
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
- *     - [🏍] ? Is context in each template
+ *     - [🏍] ? Is context in each task
  *     - [♨] Are examples prepared
  *     - [♨] Are tasks prepared
  */

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

@@ -2,13 +2,13 @@ import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
 import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
-type PrepareTemplateInput = Pick<PipelineJson, 'tasks' | 'parameters'> & {
+type PrepareTaskInput = Pick<PipelineJson, 'tasks' | 'parameters'> & {
     /**
      * @@@
      */
     readonly knowledgePiecesCount: number;
 };
-type PreparedTemplates = {
+type PreparedTasks = {
     /**
      * @@@ Sequence of tasks that are chained together to form a pipeline
      */
@@ -19,11 +19,11 @@ type PreparedTemplates = {
  *
  * @public exported from `@promptbook/core`
  */
-export declare function prepareTasks(pipeline: PrepareTemplateInput, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PreparedTemplates>;
+export declare function prepareTasks(pipeline: PrepareTaskInput, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PreparedTasks>;
 export {};
 /**
- * TODO: [🧠] Add context to each template (if missing)
- * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
+ * TODO: [🧠] Add context to each task (if missing)
+ * TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
  * TODO: [♨][main] !!! Prepare index the examples and maybe tasks
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch

package/esm/typings/src/types/Prompt.d.ts

@@ -5,7 +5,7 @@ import type { CompletionModelRequirements } from './ModelRequirements';
 import type { EmbeddingModelRequirements } from './ModelRequirements';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Parameters } from './typeAliases';
-import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
+import type { string_pipeline_url_with_task_hash } from './typeAliases';
 import type { string_postprocessing_function_name } from './typeAliases';
 import type { string_prompt } from './typeAliases';
 import type { string_template } from './typeAliases';
@@ -93,11 +93,11 @@ export type CommonPrompt = {
      */
     readonly format?: FormatCommand['format'];
     /**
-     * Unique identifier of the pipeline with specific template name as hash
+     * Unique identifier of the pipeline with specific task name as hash
      *
      * @example https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords
      */
-    readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
+    readonly pipelineUrl?: string_pipeline_url_with_task_hash;
     /**
      * Parameters used in the `content`
      */

package/esm/typings/src/types/SectionType.d.ts

@@ -0,0 +1,21 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Type of the section
+ */
+export type SectionType = TupleToUnion<typeof SectionTypes>;
+/**
+ * All available sections which are not tasks
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const NonTaskSectionTypes: readonly ["EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];
+/**
+ * All available section types
+ *
+ * There is is distinction between task types and section types
+ * - Every section in markdown has its SectionType
+ * - Some sections are tasks but other can be non-task sections
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const SectionTypes: readonly [...("PROMPT_TASK" | "SIMPLE_TASK" | "SCRIPT_TASK" | "DIALOG_TASK")[], "EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];

package/esm/typings/src/types/TaskProgress.d.ts

@@ -1,4 +1,4 @@
-import type { SectionType } from '../commands/SECTION/SectionType';
+import type { SectionType } from './SectionType';
 import type { string_markdown_text } from './typeAliases';
 import type { string_name } from './typeAliases';
 /**

package/esm/typings/src/types/TaskType.d.ts

@@ -0,0 +1,15 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Type of the task
+ */
+export type TaskType = TupleToUnion<typeof TaskTypes>;
+/**
+ * All available task types
+ *
+ * There is is distinction between task types and section types
+ * - Every section in markdown has its SectionType
+ * - Some sections are tasks but other can be non-task sections
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const TaskTypes: readonly ["PROMPT", "SIMPLE", "SCRIPT", "DIALOG"];

package/esm/typings/src/types/typeAliases.d.ts

@@ -306,7 +306,7 @@ export type string_pipeline_url = string;
  *
  * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords"`
  */
-export type string_pipeline_url_with_hashtemplate = string;
+export type string_pipeline_url_with_task_hash = string;
 /**
  * Semantic helper
  *

package/esm/typings/src/utils/organization/TODO_remove_as.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place is used as but should not be
+ *
+ * @private within the repository
+ */
+export type TODO_remove_as<T> = T;

package/esm/typings/src/utils/parameters/extractParameterNames.d.ts

@@ -3,7 +3,7 @@ import type { string_template } from '../../types/typeAliases';
 /**
  * Parses the task and returns the list of all parameter names
  *
- * @param template the task with parameters in {curly} braces
+ * @param template the string template with parameters in {curly} braces
  * @returns the list of parameter names
  * @public exported from `@promptbook/utils`
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.75.0-2",
+    "version": "0.75.0-4",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,