@promptbook/remote-server 0.37.0 → 0.39.0

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
@@ -22,4 +22,4 @@ export interface PromptTemplateParameterJson {
      * - 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/esm/typings/classes/PromptbookLibrary.d.ts

@@ -1,75 +0,0 @@
-import { string_name } from '.././types/typeAliases';
-import { CreatePromptbookExecutorSettings } from '../execution/createPromptbookExecutor';
-import { ExecutionTools } from '../execution/ExecutionTools';
-import { PromptbookExecutor } from '../execution/PromptbookExecutor';
-import { Prompt } from '../types/Prompt';
-import { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import { PromptbookString } from '../types/PromptbookString';
-/**
- * Options for PromptbookLibrary
- */
-type PromptbookLibraryOptions = {
-    /**
-     * The library of promptbooks
-     */
-    readonly library: Record<string_name, PromptbookJson>;
-    /**
-     * Optional settings for creating a PromptbookExecutor
-     */
-    readonly settings?: Partial<CreatePromptbookExecutorSettings>;
-};
-/**
- * Library of promptbooks that groups together promptbooks for an application. This is a very thin wrapper around the Array / Set of promptbooks.
- *
- * Promptbook library is a useful helper in execution, it can be shared between execution and consumer parts of the app and make common knowledge about promptbooks.
- *
- * It allows to create executor functions from promptbooks in the library.
- *
- * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline-library
- */
-export declare class PromptbookLibrary {
-    readonly options: PromptbookLibraryOptions;
-    /**
-     * Constructs Promptbook from any sources
-     *
-     * Note: During the construction syntax and logic of all sources are validated
-     * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
-     *
-     * @param promptbookSources contents of .ptbk.md or .ptbk.json files
-     * @param settings settings for creating executor functions
-     * @returns PromptbookLibrary
-     */
-    static fromSources(promptbookSources: Record<string_name, PromptbookJson | PromptbookString>, settings?: Partial<CreatePromptbookExecutorSettings>): PromptbookLibrary;
-    private constructor();
-    /**
-     * Gets all promptbooks in the library
-     */
-    get promptbookNames(): Array<string_name>;
-    /**
-     * Gets promptbook by name
-     */
-    getPromptbookByName(name: string_name): PromptbookJson;
-    /**
-     * Checks whether prompt is in the library
-     */
-    isPromptInLibrary(prompt: Prompt): boolean;
-    /**
-     * Gets executor function for given promptbook
-     */
-    createExecutor(name: string_name, tools: ExecutionTools): PromptbookExecutor;
-}
-export {};
-/**
- * TODO: [🈴] Identify promptbooks by url `promptbookUrls` + `getPromptbookByUrl`
- * TODO: !! [👐][🧠] Split of Promptbook,PromptbookLibrary between interface and class
- * TODO: !! [👐] Make promptbooks private WHEN split between interface and class
- * TODO: [🧠] Maybe isPromptInLibrary should be separate utility function
- * TODO: [🧠] Maybe createExecutor should be separate utility function
- * TODO: Static method fromDirectory
- * TODO: [🤜] Add generic type for entry and result parameters
- * TODO: [🧠] Is it better to promptbookLibrary.executePromptbook('writeXyz',{...}) OR promptbookLibrary.createExecutor('writeXyz')({...}) OR createExecutor(promptbookLibrary.getPromptbook('writeXyz'))
- * TODO: [🧠] Formarly (before commit 62229afce7668a5b85077cc18becf798b583bf8d) there were two classes PromptbookLibrary+PromptbookLibraryExecutor (maybe it was better?)
- * TODO: [🧠] Is it better to pass tools into getExecutor or into constructor
- *             Maybe it is not a good idea to cache executors when they are can be created with different tools
- * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
- */

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/classes/PromptbookLibrary.d.ts

@@ -1,75 +0,0 @@
-import { string_name } from '.././types/typeAliases';
-import { CreatePromptbookExecutorSettings } from '../execution/createPromptbookExecutor';
-import { ExecutionTools } from '../execution/ExecutionTools';
-import { PromptbookExecutor } from '../execution/PromptbookExecutor';
-import { Prompt } from '../types/Prompt';
-import { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import { PromptbookString } from '../types/PromptbookString';
-/**
- * Options for PromptbookLibrary
- */
-type PromptbookLibraryOptions = {
-    /**
-     * The library of promptbooks
-     */
-    readonly library: Record<string_name, PromptbookJson>;
-    /**
-     * Optional settings for creating a PromptbookExecutor
-     */
-    readonly settings?: Partial<CreatePromptbookExecutorSettings>;
-};
-/**
- * Library of promptbooks that groups together promptbooks for an application. This is a very thin wrapper around the Array / Set of promptbooks.
- *
- * Promptbook library is a useful helper in execution, it can be shared between execution and consumer parts of the app and make common knowledge about promptbooks.
- *
- * It allows to create executor functions from promptbooks in the library.
- *
- * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline-library
- */
-export declare class PromptbookLibrary {
-    readonly options: PromptbookLibraryOptions;
-    /**
-     * Constructs Promptbook from any sources
-     *
-     * Note: During the construction syntax and logic of all sources are validated
-     * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
-     *
-     * @param promptbookSources contents of .ptbk.md or .ptbk.json files
-     * @param settings settings for creating executor functions
-     * @returns PromptbookLibrary
-     */
-    static fromSources(promptbookSources: Record<string_name, PromptbookJson | PromptbookString>, settings?: Partial<CreatePromptbookExecutorSettings>): PromptbookLibrary;
-    private constructor();
-    /**
-     * Gets all promptbooks in the library
-     */
-    get promptbookNames(): Array<string_name>;
-    /**
-     * Gets promptbook by name
-     */
-    getPromptbookByName(name: string_name): PromptbookJson;
-    /**
-     * Checks whether prompt is in the library
-     */
-    isPromptInLibrary(prompt: Prompt): boolean;
-    /**
-     * Gets executor function for given promptbook
-     */
-    createExecutor(name: string_name, tools: ExecutionTools): PromptbookExecutor;
-}
-export {};
-/**
- * TODO: [🈴] Identify promptbooks by url `promptbookUrls` + `getPromptbookByUrl`
- * TODO: !! [👐][🧠] Split of Promptbook,PromptbookLibrary between interface and class
- * TODO: !! [👐] Make promptbooks private WHEN split between interface and class
- * TODO: [🧠] Maybe isPromptInLibrary should be separate utility function
- * TODO: [🧠] Maybe createExecutor should be separate utility function
- * TODO: Static method fromDirectory
- * TODO: [🤜] Add generic type for entry and result parameters
- * TODO: [🧠] Is it better to promptbookLibrary.executePromptbook('writeXyz',{...}) OR promptbookLibrary.createExecutor('writeXyz')({...}) OR createExecutor(promptbookLibrary.getPromptbook('writeXyz'))
- * TODO: [🧠] Formarly (before commit 62229afce7668a5b85077cc18becf798b583bf8d) there were two classes PromptbookLibrary+PromptbookLibraryExecutor (maybe it was better?)
- * TODO: [🧠] Is it better to pass tools into getExecutor or into constructor
- *             Maybe it is not a good idea to cache executors when they are can be created with different tools
- * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
- */

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

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