@promptbook/core 0.36.4 → 0.38.0

package/esm/typings/types/Command.d.ts

@@ -13,43 +13,43 @@ export type Command = PromptbookUrlCommand | PromptbookVersionCommand | ExecuteC
  * - It is used for backward compatibility
  * - It is defined per whole .promptbook file in the header
  */
-export interface PromptbookUrlCommand {
+export type PromptbookUrlCommand = {
     readonly type: 'PROMPTBOOK_URL';
     readonly promptbookUrl: URL;
-}
+};
 /**
  * PromptbookVersion command tells which version is .promptbook file using
  *
  * - It is used for backward compatibility
  * - It is defined per whole .promptbook file in the header
  */
-export interface PromptbookVersionCommand {
+export type PromptbookVersionCommand = {
     readonly type: 'PROMPTBOOK_VERSION';
     readonly promptbookVersion: string_version;
-}
+};
 /**
  * Execute command tells how to execute the section
  * It can be either prompt template, script or SIMPLE TEMPLATE etc.
  */
-export interface ExecuteCommand {
+export type ExecuteCommand = {
     readonly type: 'EXECUTE';
     readonly executionType: ExecutionType;
-}
+};
 /**
  * Model command tells which model and modelRequirements to use for the prompt template. execution
  */
-export interface ModelCommand {
+export type ModelCommand = {
     readonly type: 'MODEL';
     readonly key: keyof ModelRequirements;
     readonly value: any;
-}
+};
 /**
  * Joker parameter is used instead of executing the prompt template if it meet the expectations requirements
  */
-export interface JokerCommand {
+export type JokerCommand = {
     readonly type: 'JOKER';
     readonly parameterName: string_name;
-}
+};
 /**
  * Parameter command describes one parameter of the prompt template
  *
@@ -57,20 +57,21 @@ export interface JokerCommand {
  * - It can have description
  * - In description it can have simple formatting BUT not markdown structure or reference to other parameters
  */
-export interface ParameterCommand {
+export type ParameterCommand = {
     readonly type: 'PARAMETER';
-    readonly isInputParameter: boolean;
+    readonly isInput: boolean;
+    readonly isOutput: boolean;
     readonly parameterName: string_name;
     readonly parameterDescription: string_markdown_text | null;
-}
+};
 /**
  * Postprocess command describes which function to use for postprocessing
  * This will be created as separate EXECUTE SCRIPT block bellow
  */
-export interface PostprocessCommand {
+export type PostprocessCommand = {
     readonly type: 'POSTPROCESS';
     readonly functionName: string_name;
-}
+};
 /**
  * Expect 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 or some other shape of the output.
@@ -82,16 +83,16 @@ export type ExpectCommand = ExpectAmountCommand | ExpectFormatCommand;
  *
  * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
  */
-export interface ExpectAmountCommand {
+export type ExpectAmountCommand = {
     readonly type: 'EXPECT_AMOUNT';
     readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
     readonly unit: ExpectationUnit;
     readonly amount: ExpectationAmount;
-}
+};
 /**
  * Represents a command that expects a specific format.
  */
-export interface ExpectFormatCommand {
+export type ExpectFormatCommand = {
     readonly type: 'EXPECT_FORMAT';
     readonly format: 'JSON';
-}
+};

package/esm/typings/types/ModelRequirements.d.ts

@@ -7,13 +7,13 @@ export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
  * - **COMPLETION** - model that takes prompt and writes the rest of the text
  * - **CHAT** - model that takes prompt and previous messages and returns response
  */
-export type ModelVariant = (typeof MODEL_VARIANTS)[number];
+export type ModelVariant = typeof MODEL_VARIANTS[number];
 /**
  * Abstract way to specify the LLM. It does not specify the LLM with concrete version itself, only the requirements for the LLM.
  *
  * @see https://github.com/webgptorg/promptbook#model-requirements
  */
-export interface ModelRequirements {
+export type ModelRequirements = {
     /**
      * Model variant describes the very general type of the model
      *
@@ -34,7 +34,7 @@ export interface ModelRequirements {
      * Maximum number of tokens that can be generated by the model
      */
     readonly maxTokens?: number;
-}
+};
 /**
  * TODO: Maybe figure out better word than "variant"
  * TODO: Add here more requirement options like max context size, max tokens, etc.

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

@@ -5,7 +5,7 @@ import type { ModelRequirements } from './ModelRequirements';
  *
  * @see https://github.com/webgptorg/promptbook#prompt
  */
-export interface Prompt {
+export type Prompt = {
     /**
      * The title of the prompt
      *
@@ -35,7 +35,7 @@ export interface Prompt {
      * Note: This is redundant (same information is in promptbookUrl+content) but useful for logging and debugging
      */
     readonly parameters: Record<string_name, string>;
-}
+};
 /**
  * TODO: [✔] Check ModelRequirements in runtime
  */

package/esm/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -10,14 +10,14 @@ export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | Scri
 /**
  * Template for prompt to LLM
  */
-export interface NaturalTemplateJson extends PromptTemplateJsonCommon {
+export type NaturalTemplateJson = PromptTemplateJsonCommon & {
     readonly executionType: 'PROMPT_TEMPLATE';
     /**
      * Requirements for the model
      * - This is required only for executionType PROMPT_TEMPLATE
      */
     readonly modelRequirements: ModelRequirements;
-}
+};
 /**
  * Units of text measurement
  */

package/esm/typings/types/PromptbookJson/PromptTemplateParameterJson.d.ts

@@ -2,7 +2,7 @@ import { string_name } from '../typeAliases';
 /**
  * Describes one parameter of the promptbook
  */
-export interface PromptTemplateParameterJson {
+export type PromptTemplateParameterJson = {
     /**
      * Name of the parameter
      * - It must be unique across the pipeline
@@ -11,13 +11,15 @@ export interface PromptTemplateParameterJson {
     readonly name: string_name;
     /**
      * The parameter is input of the pipeline
-     *
-     * Note: OUTPUT PARAMETER is every parameter including input one
      */
     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;
-}
+};

package/esm/typings/types/PromptbookJson/PromptbookJson.d.ts

@@ -7,7 +7,7 @@ import { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
  *
  * @see https://github.com/webgptorg/promptbook#promptbook
  */
-export interface PromptbookJson {
+export type PromptbookJson = {
     /**
      * Unique identifier of the promptbook
      *
@@ -40,7 +40,7 @@ export interface PromptbookJson {
      * Sequence of prompt templates that are chained together to form a pipeline
      */
     readonly promptTemplates: Array<PromptTemplateJson>;
-}
+};
 /**
  * TODO: [🧠] Best format of this code?
  *             There must be possible to make

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

@@ -3,7 +3,7 @@ import { string_markdown_text, string_name } from './typeAliases';
 /**
  * TaskProgress represents the progress of a Promptbook execution.
  */
-export interface TaskProgress {
+export type TaskProgress = {
     /**
      * The unique name of the task.
      *
@@ -39,4 +39,4 @@ export interface TaskProgress {
      * The parameter value or null if the parameter is not yet processed.
      */
     readonly parameterValue: string | null;
-}
+};

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

@@ -325,37 +325,12 @@ export type string_person_fullname = string;
  * For example `"Pavol Hejný <pavol@hejny.org> (https://pavolhejny.com)"`
  */
 export type string_person_profile = string;
-/**
- * Full profile of the person with his email and web (like in package.json)
- */
-export interface IPersonProfile {
-    readonly name?: string_person_fullname;
-    /**
-     * Note: Photos are taken from Gravatar by email
-     */
-    readonly email?: string_email;
-    readonly url?: string_url;
-}
 /**
  * Semantic helper
  *
  * For example `"MIT"`
  */
 export type string_license = string;
-/**
- * License with its type and url like in package.json
- */
-export interface ILicense {
-    readonly type?: string_license;
-    readonly url?: string;
-}
-/**
- * Repository with its type and url like in package.json
- */
-export interface IRepository {
-    readonly type?: string | 'git';
-    readonly url?: string;
-}
 /**
  * Semantic helper for attributes
  *
@@ -392,7 +367,6 @@ export type string_translate_name_not_normalized = string;
  * Implementing ISO 639-1
  *
  * TODO: Probably use enum
- * TODO: Rename - remove string_ prefix like ITranslateLanguageCode
  */
 export type string_translate_language = 'en' | 'cs';
 /**

package/esm/typings/utils/markdown-json/MarkdownStructure.d.ts

@@ -3,7 +3,7 @@
  *
  * @private within the library
  */
-export interface MarkdownStructure {
+export type MarkdownStructure = {
     /**
      * The section level of the markdown file.
      * h1 is level 1, h2 is level 2, etc.
@@ -22,4 +22,4 @@ export interface MarkdownStructure {
      * The sub-sections of current section which are recursively structured.
      */
     sections: MarkdownStructure[];
-}
+};

package/esm/typings/wizzard/Wizzard.d.ts

@@ -1 +1,4 @@
 export declare const Wizzard: any;
+/**
+ * TODO: [🧙‍♂️]
+ */ 

package/esm/typings/wizzard/sample.d.ts

@@ -1,5 +1,6 @@
 export {};
 /**
+ * TODO: [🧙‍♂️]
 url, sources nebo folder
  * TODO: [🧠] OpenAi apiKey vs token
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.36.4",
+    "version": "0.38.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,