@promptbook/types 0.67.9 → 0.68.0-1

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

@@ -1,15 +1,26 @@
-import type { ___ } from '../../utils/organization/___';
-import type { LlmTemplateJson } from './LlmTemplateJson';
-import type { PromptDialogJson } from './PromptDialogJson';
-import type { ScriptJson } from './ScriptJson';
-import type { SimpleTemplateJson } from './SimpleTemplateJson';
+import type { ModelRequirements } from '../ModelRequirements';
+import type { string_name } from '../typeAliases';
+import type { TemplateJsonCommon } from './TemplateJsonCommon';
 /**
- * Describes one prompt template in the promptbook
+ * Template for prompt to LLM
  *
  * Note: [🚉] This is fully serializable as JSON
  */
-export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson | ___ | ___ | ___ | ___;
+export type PromptTemplateJson = TemplateJsonCommon & {
+    readonly blockType: 'PROMPT_TEMPLATE';
+    /**
+     * Name of the persona who will be responding to this prompt
+     */
+    readonly personaName?: string_name;
+    /**
+     * Requirements for the model
+     * - This is required only for blockType PROMPT_TEMPLATE
+     */
+    readonly modelRequirements?: Partial<ModelRequirements>;
+};
 /**
- * TODO: [🧠][🥜] What is propper name for this - "Template", "Prompt template",...
- * TODO: [🧠][🥜] Reduce confusion of `PromptTemplateJson` vs (`LlmTemplateJson` which is 'PROMPT_TEMPLATE')
+ * TODO: [👙][🧠] Maybe add `knowledge`, `actions` and `instruments` to be available granularly for each template
+ *       @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/types/PipelineJson/{ScriptJson.d.ts → ScriptTemplateJson.d.ts}

@@ -1,13 +1,13 @@
 import type { ScriptLanguage } from '../ScriptLanguage';
-import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+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 ScriptJson = PromptTemplateJsonCommon & {
-    readonly blockType: 'SCRIPT';
+export type ScriptTemplateJson = TemplateJsonCommon & {
+    readonly blockType: 'SCRIPT_TEMPLATE';
     /**
      * Language of the script
      * - This is required only for blockType SCRIPT
@@ -16,5 +16,5 @@ export type ScriptJson = PromptTemplateJsonCommon & {
     readonly contentLanguage?: ScriptLanguage;
 };
 /**
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

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

@@ -1,13 +1,13 @@
-import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+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 = PromptTemplateJsonCommon & {
+export type SimpleTemplateJson = TemplateJsonCommon & {
     readonly blockType: 'SIMPLE_TEMPLATE';
 };
 /**
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

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

@@ -0,0 +1,11 @@
+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___;

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

@@ -1,5 +1,5 @@
 import type { BlockType } from '../../commands/BLOCK/BlockTypes';
-import type { ExpectFormatCommand } from '../../commands/EXPECT/ExpectFormatCommand';
+import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
 import type { string_javascript } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
@@ -12,7 +12,7 @@ import type { Expectations } from './Expectations';
 /**
  * Common properties of all prompt templates
  */
-export interface PromptTemplateJsonCommon {
+export interface TemplateJsonCommon {
     /**
      * Name of the template
      * - It must be unique across the pipeline
@@ -83,14 +83,13 @@ export interface PromptTemplateJsonCommon {
      * @see https://github.com/webgptorg/promptbook/discussions/30
      * @deprecated [💝]
      */
-    readonly expectFormat?: ExpectFormatCommand['format'];
+    readonly format?: FormatCommand['format'];
     /**
      * Name of the parameter that is the result of the prompt template
      */
     readonly resultingParameterName: string_name;
 }
 /**
- * TODO: [🧠][🥜]
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
  * TODO: [♈] Probbably move expectations from templates to parameters
  */

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

@@ -1,4 +1,4 @@
-import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
+import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
 import type { ChatModelRequirements } from './ModelRequirements';
 import type { CompletionModelRequirements } from './ModelRequirements';
 import type { EmbeddingModelRequirements } from './ModelRequirements';
@@ -54,6 +54,8 @@ export type EmbeddingPrompt = CommonPrompt & {
  * Common properties for all prompt results
  *
  * Note: [🚉] This is fully serializable as JSON
+ *
+ * @private just abstract the common properties of the prompts
  */
 export type CommonPrompt = {
     /**
@@ -89,7 +91,7 @@ export type CommonPrompt = {
      * Note: Expectations are performed after all postprocessing steps
      * @deprecated [💝]
      */
-    readonly expectFormat?: ExpectFormatCommand['format'];
+    readonly format?: FormatCommand['format'];
     /**
      * Unique identifier of the pipeline with specific template name as hash
      *

package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts

@@ -10,5 +10,6 @@ export declare function addAutoGeneratedSection(content: string_markdown, option
     readonly sectionContent: string_markdown;
 }): string_markdown;
 /**
+ * TODO: !!!!!! Somw way how to connect this with commands
  * TODO: [🏛] This can be part of markdown builder
  */

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -27,7 +27,7 @@ export type CodeBlock = {
  *
  * @param markdown any valid markdown
  * @returns code blocks with language and content
- * @throws {ParsingError} if block is not closed properly
+ * @throws {ParseError} if block is not closed properly
  * @public exported from `@promptbook/markdown-utils`
  */
 export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;

package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -3,7 +3,7 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
 /**
  * Extracts exactly ONE code block from markdown.
  *
- * - When there are multiple or no code blocks the function throws a `ParsingError`
+ * - When there are multiple or no code blocks the function throws a `ParseError`
  *
  * Note: There are multiple simmilar function:
  * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
@@ -14,7 +14,7 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
  * @param markdown any valid markdown
  * @returns code block with language and content
  * @public exported from `@promptbook/markdown-utils`
- * @throws {ParsingError} if there is not exactly one code block in the markdown
+ * @throws {ParseError} if there is not exactly one code block in the markdown
  */
 export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***

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

@@ -0,0 +1,7 @@
+import type { really_unknown } from './really_unknown';
+/**
+ * Formatting helper to put void to keep longer version of prettier
+ *
+ * @private within the repository
+ */
+export type ___and___ = really_unknown;

package/esm/typings/src/utils/organization/{___.d.ts → ___or___.d.ts}

@@ -3,4 +3,4 @@
  *
  * @private within the repository
  */
-export type ___ = never;
+export type ___or___ = never;

package/esm/typings/src/utils/parseNumber.d.ts

@@ -5,7 +5,7 @@
  * Note: it also works only with decimal numbers
  *
  * @returns parsed number
- * @throws {ParsingError} if the value is not a number
+ * @throws {ParseError} if the value is not a number
  *
  * @public exported from `@promptbook/utils`
  */

package/esm/typings/src/utils/serialization/clonePipeline.d.ts

@@ -9,5 +9,5 @@ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
  */
 export declare function clonePipeline(pipeline: PipelineJson): PipelineJson;
 /**
- * TODO: [🍙] Make some standart order of json properties
+ * TODO: [🍙] Make some standard order of json properties
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.67.9",
+    "version": "0.68.0-1",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -45,6 +45,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.67.9"
+        "@promptbook/core": "0.68.0-1"
     }
 }

package/esm/typings/src/commands/EXPECT/ExpectAmountCommand.d.ts

@@ -1,17 +0,0 @@
-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;
-};
-/**
- * TODO: [🍋] Allow to `EXPECT` relative amounts like `EXPECT MAX 130% {foo} Words`
- */ 

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

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

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

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

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

@@ -1,14 +0,0 @@
-import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
-/**
- * Template for prompt to user
- *
- * Note: [🚉] This is fully serializable as JSON
- * @see https://github.com/webgptorg/promptbook/discussions/76
- */
-export type PromptDialogJson = PromptTemplateJsonCommon & {
-    readonly blockType: 'PROMPT_DIALOG';
-};
-/**
- * TODO: [🧠][🥜]
- * TODO: [🍙] Make some standart order of json properties
- */