@promptbook/openai 0.36.4 → 0.38.0

package/umd/typings/execution/NaturalExecutionTools.d.ts

@@ -7,7 +7,7 @@ import { PromptChatResult, PromptCompletionResult } from './PromptResult';
  *
  * @see https://github.com/webgptorg/promptbook#natural-execution-tools
  */
-export interface NaturalExecutionTools {
+export type NaturalExecutionTools = {
     /**
      * Use a chat model
      */
@@ -16,7 +16,7 @@ export interface NaturalExecutionTools {
      * Use a completion model
      */
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
-}
+};
 /**
  * TODO: [🏳] gptChat -> chat, gptComplete -> complete, translate
  * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat

package/umd/typings/execution/PromptResult.d.ts

@@ -14,9 +14,8 @@ export type PromptCompletionResult = PromptCommonResult;
 /**
  * Prompt chat result
  */
-export interface PromptChatResult extends PromptCommonResult {
-}
-export interface PromptCommonResult {
+export type PromptChatResult = PromptCommonResult & {};
+export type PromptCommonResult = {
     /**
      * Exact text response from the model
      */
@@ -65,7 +64,7 @@ export interface PromptCommonResult {
      * Raw response from the model
      */
     readonly rawResponse: object;
-}
+};
 /**
  * TODO: [🧠] Maybe timing more accurate then seconds?
  * TODO: [🧠] Should here be link to the prompt?

package/umd/typings/execution/PromptbookExecutor.d.ts

@@ -12,7 +12,7 @@ import type { string_name } from '../types/typeAliases';
  *
  * @see https://github.com/webgptorg/promptbook#executor
  */
-export interface PromptbookExecutor {
+export type PromptbookExecutor = {
     (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
         /**
          * Whether the execution was successful
@@ -33,7 +33,7 @@ export interface PromptbookExecutor {
          */
         outputParameters: Record<string_name, string>;
     }>;
-}
+};
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?
  */

package/umd/typings/execution/ScriptExecutionTools.d.ts

@@ -5,13 +5,13 @@ import { ScriptLanguage } from '../types/ScriptLanguage';
  *
  * @see https://github.com/webgptorg/promptbook#script-execution-tools
  */
-export interface ScriptExecutionTools {
+export type ScriptExecutionTools = {
     execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}
+};
 /**
  * Input for the script execution
  */
-export interface ScriptExecutionToolsExecuteOptions {
+export type ScriptExecutionToolsExecuteOptions = {
     /**
      * Language of the script
      */
@@ -31,7 +31,7 @@ export interface ScriptExecutionToolsExecuteOptions {
      * - It can use the parameters as variables and functions from global scope
      */
     script: string_script;
-}
+};
 /**
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
- */ 
+ */

package/umd/typings/execution/UserInterfaceTools.d.ts

@@ -4,7 +4,7 @@ import { number_integer, number_positive } from '../types/typeAliases';
  *
  * @see https://github.com/webgptorg/promptbook#user-interface-tools
  */
-export interface UserInterfaceTools {
+export type UserInterfaceTools = {
     /**
      * Asks the user to answer a free-text (multiline) question
      *
@@ -12,8 +12,8 @@ export interface UserInterfaceTools {
      * @returns the answer from the user
      */
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
-}
-export interface UserInterfaceToolsPromptDialogOptions {
+};
+export type UserInterfaceToolsPromptDialogOptions = {
     /**
      * Prompt title
      *
@@ -42,4 +42,4 @@ export interface UserInterfaceToolsPromptDialogOptions {
      * Note: This would be reflected for example into the UI z-index of the prompt modal
      */
     priority: number_integer & number_positive;
-}
+};

package/umd/typings/execution/createPromptbookExecutor.d.ts

@@ -1,14 +1,14 @@
 import { PromptbookJson } from '../_packages/types.index';
 import { ExecutionTools } from './ExecutionTools';
 import { PromptbookExecutor } from './PromptbookExecutor';
-export interface CreatePromptbookExecutorSettings {
+export type CreatePromptbookExecutorSettings = {
     /**
      * When executor does not satisfy expectations it will be retried this amount of times
      *
      * @default 3
      */
     readonly maxExecutionAttempts: number;
-}
+};
 /**
  * Options for creating a promptbook executor
  */
@@ -37,4 +37,5 @@ export {};
  * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
  * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
  * Note: CreatePromptbookExecutorOptions are just connected to PromptbookExecutor so do not extract to types folder
+ * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
  */

package/umd/typings/execution/plugins/natural-execution-tools/openai/OpenAiExecutionToolsOptions.d.ts

@@ -3,7 +3,7 @@ import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOption
 /**
  * Options for OpenAiExecutionTools
  */
-export interface OpenAiExecutionToolsOptions extends CommonExecutionToolsOptions {
+export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & {
     /**
      * OpenAI API key
      */
@@ -13,4 +13,4 @@ export interface OpenAiExecutionToolsOptions extends CommonExecutionToolsOptions
      * and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
      */
     user?: string_token;
-}
+};

package/umd/typings/execution/plugins/natural-execution-tools/remote/RemoteNaturalExecutionToolsOptions.d.ts

@@ -3,7 +3,7 @@ import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOption
 /**
  * Options for RemoteNaturalExecutionTools
  */
-export interface RemoteNaturalExecutionToolsOptions extends CommonExecutionToolsOptions {
+export type RemoteNaturalExecutionToolsOptions = CommonExecutionToolsOptions & {
     /**
      * URL of the remote PROMPTBOOK server
      * On this server will be connected to the socket.io server
@@ -20,4 +20,4 @@ export interface RemoteNaturalExecutionToolsOptions extends CommonExecutionTools
      * Your client ID
      */
     readonly clientId: client_id;
-}
+};

package/umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions.d.ts

@@ -2,7 +2,7 @@ import type { PromptbookLibrary } from '../../../../../classes/PromptbookLibrary
 import type { client_id, string_uri } from '../../../../../types/typeAliases';
 import type { CommonExecutionToolsOptions } from '../../../../CommonExecutionToolsOptions';
 import type { NaturalExecutionTools } from '../../../../NaturalExecutionTools';
-export interface RemoteServerOptions extends CommonExecutionToolsOptions {
+export type RemoteServerOptions = CommonExecutionToolsOptions & {
     /**
      * Port on which the server will listen
      */
@@ -24,4 +24,4 @@ export interface RemoteServerOptions extends CommonExecutionToolsOptions {
      * Creates natural execution tools for each client
      */
     createNaturalExecutionTools(clientId: client_id): NaturalExecutionTools;
-}
+};

package/umd/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions.d.ts

@@ -4,9 +4,9 @@ import { UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceToo
 /**
  * Options for CallbackInterfaceTools
  */
-export interface CallbackInterfaceToolsOptions extends CommonExecutionToolsOptions {
+export type CallbackInterfaceToolsOptions = CommonExecutionToolsOptions & {
     /**
      * The callback function to be called when promptDialog is called
      */
     callback(prompt: UserInterfaceToolsPromptDialogOptions): Promisable<string>;
-}
+};

package/umd/typings/execution/translation/automatic-translate/automatic-translators/{IAutomaticTranslator.d.ts → AutomaticTranslator.d.ts}

@@ -1,4 +1,4 @@
 import { Promisable } from 'type-fest';
-export interface IAutomaticTranslator {
+export type AutomaticTranslator = {
     translate(message: string): Promisable<string>;
-}
+};

package/umd/typings/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts

@@ -1,9 +1,9 @@
-import { IAutomaticTranslator } from './IAutomaticTranslator';
+import { AutomaticTranslator } from './AutomaticTranslator';
 /**
  * This will wrap an automatic translator and log each translation into the console
  */
-export declare class DebugAutomaticTranslator implements IAutomaticTranslator {
+export declare class DebugAutomaticTranslator implements AutomaticTranslator {
     private readonly automaticTranslator;
-    constructor(automaticTranslator: IAutomaticTranslator);
+    constructor(automaticTranslator: AutomaticTranslator);
     translate(message: string): Promise<string>;
 }

package/umd/typings/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts

@@ -1,5 +1,5 @@
-import { IAutomaticTranslator } from './IAutomaticTranslator';
-export declare class FakeAutomaticTranslator implements IAutomaticTranslator {
+import { AutomaticTranslator } from './AutomaticTranslator';
+export declare class FakeAutomaticTranslator implements AutomaticTranslator {
     constructor();
     translate(message: string): string;
 }

package/umd/typings/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts

@@ -1,11 +1,11 @@
-import { IAutomaticTranslator } from './IAutomaticTranslator';
-import { ITranslatorOptions } from './ITranslatorOptions';
-interface ILindatAutomaticTranslatorOptions extends ITranslatorOptions {
+import { AutomaticTranslator } from './AutomaticTranslator';
+import { TranslatorOptions } from './TranslatorOptions';
+interface LindatAutomaticTranslatorOptions extends TranslatorOptions {
     apiUrl: URL;
 }
-export declare class LindatAutomaticTranslator implements IAutomaticTranslator {
+export declare class LindatAutomaticTranslator implements AutomaticTranslator {
     private readonly options;
-    constructor(options: ILindatAutomaticTranslatorOptions);
+    constructor(options: LindatAutomaticTranslatorOptions);
     translate(message: string): Promise<string>;
 }
 export {};

package/umd/typings/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts

@@ -0,0 +1,4 @@
+export type TranslatorOptions = {
+    from: string;
+    to: string;
+};

package/umd/typings/execution/translation/automatic-translate/translateMessages.d.ts

@@ -1,5 +1,5 @@
-import { IAutomaticTranslator } from './automatic-translators/IAutomaticTranslator';
-import { ITranslatorOptions } from './automatic-translators/ITranslatorOptions';
+import { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
+import { TranslatorOptions } from './automatic-translators/TranslatorOptions';
 export declare function translateMessages({ automaticTranslator, from, to, }: {
-    automaticTranslator: IAutomaticTranslator;
-} & ITranslatorOptions): Promise<void>;
+    automaticTranslator: AutomaticTranslator;
+} & TranslatorOptions): Promise<void>;

package/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/typings/wizzard/Wizzard.d.ts

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

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

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

package/esm/typings/execution/translation/automatic-translate/automatic-translators/ITranslatorOptions.d.ts

@@ -1,4 +0,0 @@
-export interface ITranslatorOptions {
-    from: string;
-    to: string;
-}

package/umd/typings/execution/translation/automatic-translate/automatic-translators/ITranslatorOptions.d.ts

@@ -1,4 +0,0 @@
-export interface ITranslatorOptions {
-    from: string;
-    to: string;
-}