@promptbook/remote-server 0.75.0-1 → 0.75.0-2

package/esm/typings/src/{types → pipeline}/PipelineJson/PersonaJson.d.ts

@@ -1,7 +1,7 @@
-import type { ChatModelRequirements } from '../ModelRequirements';
-import type { number_id } from '../typeAliases';
-import type { string_name } from '../typeAliases';
-import type { string_persona_description } from '../typeAliases';
+import type { ChatModelRequirements } from '../../types/ModelRequirements';
+import type { number_id } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+import type { string_persona_description } from '../../types/typeAliases';
 /**
  * Defines a persona in the pipeline
  *

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

@@ -1,9 +1,9 @@
 import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
-import type { ModelRequirements } from '../ModelRequirements';
-import type { string_filename } from '../typeAliases';
-import type { string_markdown_text } from '../typeAliases';
-import type { string_pipeline_url } from '../typeAliases';
-import type { string_semantic_version } from '../typeAliases';
+import type { ModelRequirements } from '../../types/ModelRequirements';
+import type { string_filename } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_pipeline_url } from '../../types/typeAliases';
+import type { string_semantic_version } from '../../types/typeAliases';
 import type { KnowledgePiecePreparedJson } from './KnowledgePieceJson';
 import type { KnowledgeSourceJson } from './KnowledgeSourceJson';
 import type { KnowledgeSourcePreparedJson } from './KnowledgeSourceJson';
@@ -11,10 +11,10 @@ import type { ParameterJson } from './ParameterJson';
 import type { PersonaJson } from './PersonaJson';
 import type { PersonaPreparedJson } from './PersonaJson';
 import type { PreparationJson } from './PreparationJson';
-import type { TemplateJson } from './TemplateJson';
+import type { TaskJson } from './TaskJson';
 /**
  * Promptbook is the **core concept of this package**.
- * It represents a series of templates 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 template with input and result parameters.
  *
  * Note: [🚉] This is fully serializable as JSON
  *
@@ -60,13 +60,13 @@ export type PipelineJson = {
      */
     readonly parameters: Array<ParameterJson>;
     /**
-     * Default model requirements for the model for all `templates`
+     * Default model requirements for the model for all `tasks`
      */
     readonly defaultModelRequirements?: Partial<ModelRequirements>;
     /**
-     * Sequence of templates that are chained together to form a pipeline
+     * Sequence of tasks that are chained together to form a pipeline
      */
-    readonly templates: Array<TemplateJson>;
+    readonly tasks: Array<TaskJson>;
     /**
      * Set of information that are used as external knowledge in the pipeline
      *

package/esm/typings/src/{types → pipeline}/PipelineJson/PreparationJson.d.ts

@@ -1,6 +1,6 @@
 import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { number_id } from '../../types/typeAliases';
 import type { string_promptbook_version } from '../../version';
-import type { number_id } from '../typeAliases';
 export type PreparationJson = {
     /**
      * Incremental ID of the preparation

package/esm/typings/src/{types/PipelineJson/PromptTemplateJson.d.ts → pipeline/PipelineJson/PromptTaskJson.d.ts}

@@ -1,25 +1,25 @@
-import type { ModelRequirements } from '../ModelRequirements';
-import type { string_name } from '../typeAliases';
-import type { TemplateJsonCommon } from './TemplateJsonCommon';
+import type { ModelRequirements } from '../../types/ModelRequirements';
+import type { string_name } from '../../types/typeAliases';
+import type { TaskJsonCommon } from './TaskJsonCommon';
 /**
- * Template for prompt to LLM
+ * Task for prompt to LLM
  *
  * Note: [🚉] This is fully serializable as JSON
  */
-export type PromptTemplateJson = TemplateJsonCommon & {
-    readonly templateType: 'PROMPT_TEMPLATE';
+export type PromptTaskJson = TaskJsonCommon & {
+    readonly taskType: 'PROMPT_TASK';
     /**
      * Name of the persona who will be responding to this prompt
      */
     readonly personaName?: string_name;
     /**
      * Requirements for the model
-     * - This is required only for templateType PROMPT_TEMPLATE
+     * - This is required only for taskType PROMPT_TASK
      */
     readonly modelRequirements?: Partial<ModelRequirements>;
 };
 /**
- * TODO: [👙][🧠] Maybe add `knowledge`, `actions` and `instruments` to be available granularly for each template
+ * TODO: [👙][🧠] Maybe add `knowledge`, `actions` and `instruments` to be available granularly for each task
  *       @see https://github.com/webgptorg/promptbook/discussions/79
  * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
  * TODO: [🍙] Make some standard order of json properties

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

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

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

@@ -0,0 +1,13 @@
+import type { TaskJsonCommon } from './TaskJsonCommon';
+/**
+ * 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 & {
+    readonly taskType: 'SIMPLE_TASK';
+};
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ */

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

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

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

@@ -1,19 +1,19 @@
 import type { ForeachJson } from '../../commands/FOREACH/ForeachJson';
 import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
-import type { TemplateType } from '../../commands/TEMPLATE/TemplateTypes';
-import type { string_javascript } from '../typeAliases';
-import type { string_markdown } from '../typeAliases';
-import type { string_markdown_text } from '../typeAliases';
-import type { string_name } from '../typeAliases';
-import type { string_parameter_name } from '../typeAliases';
-import type { string_postprocessing_function_name } from '../typeAliases';
-import type { string_prompt } from '../typeAliases';
-import type { string_template } from '../typeAliases';
+import type { SectionType } from '../../commands/SECTION/SectionType';
+import type { string_javascript } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_postprocessing_function_name } from '../../types/typeAliases';
+import type { string_prompt } from '../../types/typeAliases';
+import type { string_template } from '../../types/typeAliases';
 import type { Expectations } from './Expectations';
 /**
- * Common properties of all templates
+ * Common properties of all tasks
  */
-export type TemplateJsonCommon = {
+export type TaskJsonCommon = {
     /**
      * Name of the template
      * - It must be unique across the pipeline
@@ -51,7 +51,7 @@ export type TemplateJsonCommon = {
      * Type of the execution
      * This determines if the template is send to LLM, user or some scripting evaluation
      */
-    readonly templateType: TemplateType;
+    readonly taskType: SectionType;
     /**
      * Content of the template with {placeholders} for parameters
      *
@@ -96,5 +96,5 @@ export type TemplateJsonCommon = {
 };
 /**
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
- * TODO: [♈] Probbably move expectations from templates to parameters
+ * TODO: [♈] Probbably move expectations from tasks to parameters
  */

package/esm/typings/src/{types → pipeline}/PipelineString.d.ts

@@ -1,6 +1,6 @@
 /**
  * Promptbook is the **core concept of this package**.
- * It represents a series of templates 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 template with input and result parameters.
  *
  * @see @@@ https://github.com/webgptorg/promptbook#promptbook
  */

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

@@ -1,4 +1,4 @@
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 /**
  * Determine if the pipeline is fully prepared
  *
@@ -12,5 +12,5 @@ export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
  *     - [🏍] ? Is context in each template
  *     - [♨] Are examples prepared
- *     - [♨] Are templates prepared
+ *     - [♨] Are tasks prepared
  */

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

@@ -1,5 +1,5 @@
 import type { ExecutionTools } from '../execution/ExecutionTools';
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
 /**
  * Prepare pipeline from string (markdown) format to JSON format

package/esm/typings/src/prepare/{prepareTemplates.d.ts → prepareTasks.d.ts}

@@ -1,8 +1,8 @@
 import type { ExecutionTools } from '../execution/ExecutionTools';
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
-import type { TemplateJson } from '../types/PipelineJson/TemplateJson';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
 import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
-type PrepareTemplateInput = Pick<PipelineJson, 'templates' | 'parameters'> & {
+type PrepareTemplateInput = Pick<PipelineJson, 'tasks' | 'parameters'> & {
     /**
      * @@@
      */
@@ -10,21 +10,21 @@ type PrepareTemplateInput = Pick<PipelineJson, 'templates' | 'parameters'> & {
 };
 type PreparedTemplates = {
     /**
-     * @@@ Sequence of templates that are chained together to form a pipeline
+     * @@@ Sequence of tasks that are chained together to form a pipeline
      */
-    readonly templatesPrepared: ReadonlyArray<TemplateJson>;
+    readonly tasksPrepared: ReadonlyArray<TaskJson>;
 };
 /**
  * @@@
  *
  * @public exported from `@promptbook/core`
  */
-export declare function prepareTemplates(pipeline: PrepareTemplateInput, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PreparedTemplates>;
+export declare function prepareTasks(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: [♨][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
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time

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

@@ -1,4 +1,4 @@
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 /**
  * Unprepare just strips the preparation data of the pipeline
  *

package/esm/typings/src/scrapers/_common/Scraper.d.ts

@@ -1,5 +1,5 @@
 import type { Promisable } from 'type-fest';
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
 import type { string_filename } from '../../types/typeAliases';
 import type { string_knowledge_source_link } from '../../types/typeAliases';
 import type { string_mime_type } from '../../types/typeAliases';

package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts

@@ -1,6 +1,6 @@
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
+import type { KnowledgeSourceJson } from '../../pipeline/PipelineJson/KnowledgeSourceJson';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
-import type { KnowledgeSourceJson } from '../../types/PipelineJson/KnowledgeSourceJson';
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 /**
  * Prepares the knowle

package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts

@@ -1,7 +1,7 @@
 import type { SetOptional } from 'type-fest';
 import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { KnowledgeSourceJson } from '../../../pipeline/PipelineJson/KnowledgeSourceJson';
 import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
-import type { KnowledgeSourceJson } from '../../../types/PipelineJson/KnowledgeSourceJson';
 import type { ScraperSourceHandler } from '../Scraper';
 /**
  * @@@

package/esm/typings/src/scrapers/document/DocumentScraper.d.ts

@@ -1,4 +1,4 @@
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import type { Converter } from '../_common/Converter';

package/esm/typings/src/scrapers/document/register-constructor.d.ts

@@ -10,4 +10,5 @@ import type { Registration } from '../../utils/$Register';
 export declare const _DocumentScraperRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/scrapers/document/register-metadata.d.ts

@@ -22,3 +22,6 @@ export declare const documentScraperMetadata: import("type-fest/source/readonly-
  * @public exported from `@promptbook/cli`
  */
 export declare const _DocumentScraperMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts

@@ -1,4 +1,4 @@
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import type { Converter } from '../_common/Converter';

package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts

@@ -10,4 +10,5 @@ import type { Registration } from '../../utils/$Register';
 export declare const _LegacyDocumentScraperRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts

@@ -22,3 +22,6 @@ export declare const legacyDocumentScraperMetadata: import("type-fest/source/rea
  * @public exported from `@promptbook/cli`
  */
 export declare const _LegacyDocumentScraperMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts

@@ -1,4 +1,4 @@
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
 import type { Scraper } from '../_common/Scraper';
 import type { ScraperSourceHandler } from '../_common/Scraper';
 import type { ExecutionTools } from '../../execution/ExecutionTools';

package/esm/typings/src/scrapers/markdown/register-constructor.d.ts

@@ -10,4 +10,5 @@ import type { Registration } from '../../utils/$Register';
 export declare const _MarkdownScraperRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/scrapers/markdown/register-metadata.d.ts

@@ -22,3 +22,6 @@ export declare const markdownScraperMetadata: import("type-fest/source/readonly-
  * @public exported from `@promptbook/cli`
  */
 export declare const _MarkdownScraperMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts

@@ -1,4 +1,4 @@
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
 import type { Scraper } from '../_common/Scraper';
 import type { ScraperSourceHandler } from '../_common/Scraper';
 import type { ExecutionTools } from '../../execution/ExecutionTools';

package/esm/typings/src/scrapers/pdf/register-constructor.d.ts

@@ -10,4 +10,5 @@ import type { Registration } from '../../utils/$Register';
 export declare const _PdfScraperRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/scrapers/pdf/register-metadata.d.ts

@@ -22,3 +22,6 @@ export declare const pdfScraperMetadata: import("type-fest/source/readonly-deep"
  * @public exported from `@promptbook/cli`
  */
 export declare const _PdfScraperMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts

@@ -1,4 +1,4 @@
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { Converter } from '../_common/Converter';
 import type { Scraper } from '../_common/Scraper';

package/esm/typings/src/scrapers/website/register-constructor.d.ts

@@ -10,4 +10,5 @@ import type { Registration } from '../../utils/$Register';
 export declare const _WebsiteScraperRegistration: Registration;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/scrapers/website/register-metadata.d.ts

@@ -22,3 +22,6 @@ export declare const websiteScraperMetadata: import("type-fest/source/readonly-d
  * @public exported from `@promptbook/cli`
  */
 export declare const _WebsiteScraperMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts

@@ -48,4 +48,5 @@ export declare const POSTPROCESSING_FUNCTIONS: {
 };
 /**
  * TODO: DRY [🍯], [🧠] Where should be POSTPROCESSING_FUNCTIONS located and how it should be named
+ * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -1,9 +1,9 @@
 import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
+import type { Expectations } from '../pipeline/PipelineJson/Expectations';
 import type { ChatModelRequirements } from './ModelRequirements';
 import type { CompletionModelRequirements } from './ModelRequirements';
 import type { EmbeddingModelRequirements } from './ModelRequirements';
 import type { ModelRequirements } from './ModelRequirements';
-import type { Expectations } from './PipelineJson/Expectations';
 import type { Parameters } from './typeAliases';
 import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
 import type { string_postprocessing_function_name } from './typeAliases';

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

@@ -1,4 +1,4 @@
-import type { TemplateType } from '../commands/TEMPLATE/TemplateTypes';
+import type { SectionType } from '../commands/SECTION/SectionType';
 import type { string_markdown_text } from './typeAliases';
 import type { string_name } from './typeAliases';
 /**
@@ -31,7 +31,7 @@ export type TaskProgress = {
      * The type of the execution.
      * Note: The pipeline executor reports everything, in the app level you can filter out the execution types that you don't want to show to the user.
      */
-    readonly templateType: TemplateType;
+    readonly taskType: SectionType;
     /**
      * The parameter name that is being processed.
      */