@promptbook/types 0.59.0 → 0.60.0-3

package/umd/typings/src/types/Command.d.ts

@@ -1,10 +1,10 @@
+import type { ExecutionType } from './ExecutionTypes';
+import type { ModelRequirements } from './ModelRequirements';
+import type { ExpectationAmount } from './PipelineJson/PromptTemplateJson';
+import type { ExpectationUnit } from './PipelineJson/PromptTemplateJson';
 import type { string_markdown_text } from './typeAliases';
 import type { string_name } from './typeAliases';
 import type { string_version } from './typeAliases';
-import type { ExecutionType } from './ExecutionTypes';
-import type { ModelRequirements } from './ModelRequirements';
-import type { ExpectationAmount } from './PromptbookJson/PromptTemplateJson';
-import type { ExpectationUnit } from './PromptbookJson/PromptTemplateJson';
 /**
  * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.

package/umd/typings/src/types/Parameters.d.ts

@@ -1,5 +1,5 @@
 /**
- * Parameters of the prompt template (pipeline)
+ * Parameters of the pipeline
  *
  * There are three types of parameters:
  * - **INPUT PARAMETERs** are required to execute the pipeline.

package/umd/typings/src/types/{PromptbookJson/PromptbookJson.d.ts → PipelineJson/PipelineJson.d.ts}

@@ -1,5 +1,5 @@
 import type { string_markdown_text } from '../typeAliases';
-import type { string_promptbook_url } from '../typeAliases';
+import type { string_pipeline_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
 import type { KnowledgeJson } from './KnowledgeJson';
 import type { PromptTemplateJson } from './PromptTemplateJson';
@@ -8,9 +8,9 @@ import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson'
  * Promptbook is the **core concept of this library**.
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
  *
- * @see https://github.com/webgptorg/promptbook#promptbook
+ * @see !!! https://github.com/webgptorg/promptbook#promptbook
  */
-export type PromptbookJson = {
+export type PipelineJson = {
     /**
      * Unique identifier of the promptbook
      *
@@ -20,7 +20,7 @@ export type PromptbookJson = {
      *      For example: https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@1.0.0
      * Warning: Do not hash part of the URL, hash part is used for identification of the prompt template in the pipeline
      */
-    readonly promptbookUrl?: string_promptbook_url;
+    readonly promptbookUrl?: string_pipeline_url;
     /**
      * Title of the promptbook
      * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure

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

@@ -2,11 +2,11 @@
  * Promptbook is the **core concept of this library**.
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
  *
- * @see https://github.com/webgptorg/promptbook#promptbook
+ * @see !!! https://github.com/webgptorg/promptbook#promptbook
  */
-export type PromptbookString = string & {
+export type PipelineString = string & {
     readonly _type: 'Promptbook';
 };
 /**
- * TODO: !! Better validation (validatePromptbookString) or remove branded type and make it just string
+ * TODO: !! Better validation (validatePipelineString) or remove branded type and make it just string
  */

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

@@ -1,10 +1,10 @@
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
 import type { ExpectFormatCommand } from './Command';
 import type { ModelRequirements } from './ModelRequirements';
-import type { Expectations } from './PromptbookJson/PromptTemplateJson';
+import type { Expectations } from './PipelineJson/PromptTemplateJson';
 import type { string_name } from './typeAliases';
+import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
 import type { string_prompt } from './typeAliases';
-import type { string_promptbook_url_with_hashtemplate } from './typeAliases';
 import type { string_title } from './typeAliases';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
@@ -52,7 +52,7 @@ export type Prompt = {
      *
      * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md#keywords
      */
-    readonly promptbookUrl: string_promptbook_url_with_hashtemplate;
+    readonly promptbookUrl: string_pipeline_url_with_hashtemplate;
     /**
      * Parameters used in the prompt
      *

package/umd/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -1,7 +1,7 @@
 import type { PromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../Prompt';
 import type { string_markdown_text } from '../typeAliases';
-import type { string_promptbook_url } from '../typeAliases';
+import type { string_pipeline_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
 /**
  * ExecutionReport is result of executing one promptbook
@@ -17,7 +17,7 @@ export type ExecutionReportJson = {
     /**
      * Unique identifier of the promptbook from promptbook which was executed
      */
-    readonly promptbookUrl?: string_promptbook_url;
+    readonly promptbookUrl?: string_pipeline_url;
     /**
      * Title of from promptbook which was executed
      */

package/umd/typings/src/types/execution-report/countWorkingDuration.d.ts

@@ -2,6 +2,6 @@ import type { FromtoItems } from '../../utils/FromtoItems';
 /**
  * Count the duration of working time
  *
- * @private within the library
+ * @private within the package
  */
 export declare function countWorkingDuration(items: FromtoItems): number;

package/umd/typings/src/types/typeAliases.d.ts

@@ -181,13 +181,13 @@ export type string_url = string;
  *
  * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md"`
  */
-export type string_promptbook_url = string;
+export type string_pipeline_url = string;
 /**
  * Semantic helper
  *
  * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md#keywords"`
  */
-export type string_promptbook_url_with_hashtemplate = string;
+export type string_pipeline_url_with_hashtemplate = string;
 /**
  * Semantic helper
  *

package/umd/typings/src/utils/emojis.d.ts

@@ -5,7 +5,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
  *
  * @see https://getemoji.com/
  *
- * @private within the library
+ * @private within the package
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
 export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
@@ -13,7 +13,7 @@ export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoj
  *
  * All possible emoji chars like "🍆", "🍡", "🍤"...
  *
- * @private within the library
+ * @private within the package
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
 export declare const EMOJIS: Set<string_char_emoji>;

package/umd/typings/src/utils/expectation-counters/countCharacters.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of characters in the text
  */

package/umd/typings/src/utils/expectation-counters/countLines.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of lines in the text
  */

package/umd/typings/src/utils/expectation-counters/countPages.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of pages in the text
  */

package/umd/typings/src/utils/expectation-counters/countParagraphs.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of paragraphs in the text
  */

package/umd/typings/src/utils/expectation-counters/countSentences.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Split text into sentences
  */

package/umd/typings/src/utils/expectation-counters/countWords.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of words in the text
  */

package/umd/typings/src/utils/expectation-counters/index.d.ts

@@ -1,5 +1,5 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
-import type { ExpectationUnit } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationUnit } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Index of all counter functions
  */

package/umd/typings/src/utils/formatNumber.d.ts

@@ -1,6 +1,6 @@
 /**
  * Format either small or big number
  *
- * @private within the library
+ * @private within the package
  */
 export declare function formatNumber(value: number): string;

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

@@ -3,7 +3,7 @@ import type { string_name } from '../../types/typeAliases';
 /**
  * Add or modify an auto-generated section in a markdown file
  *
- * @private within the library
+ * @private within the package
  */
 export declare function addAutoGeneratedSection(content: string_markdown, options: {
     sectionName: string_name;

package/umd/typings/src/utils/markdown/createMarkdownChart.d.ts

@@ -31,7 +31,7 @@ type CreateMarkdownChartOptions = {
 /**
  * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
  *
- * @private within the library
+ * @private within the package
  */
 export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
 export {};

package/umd/typings/src/utils/markdown/createMarkdownTable.d.ts

@@ -3,6 +3,6 @@ import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Create a markdown table from a 2D array of strings
  *
- * @private within the library
+ * @private within the package
  */
 export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;

package/umd/typings/src/utils/markdown-json/MarkdownStructure.d.ts

@@ -1,7 +1,7 @@
 /**
  * Represents the structure of a markdown file.
  *
- * @private within the library
+ * @private within the package
  */
 export type MarkdownStructure = {
     /**

package/umd/typings/src/utils/markdown-json/countMarkdownStructureDeepness.d.ts

@@ -2,6 +2,6 @@ import type { MarkdownStructure } from './MarkdownStructure';
 /**
  * Computes the deepness of the markdown structure.
  *
- * @private within the library
+ * @private within the package
  */
 export declare function countMarkdownStructureDeepness(markdownStructure: MarkdownStructure): number;

package/umd/typings/src/utils/markdown-json/markdownToMarkdownStructure.d.ts

@@ -8,6 +8,6 @@ import type { MarkdownStructure } from './MarkdownStructure';
  * @param markdown The markdown string to parse.
  * @returns The MarkdownStructure object.
  *
- * @private within the library
+ * @private within the package
  */
 export declare function markdownToMarkdownStructure(markdown: string): MarkdownStructure;

package/esm/typings/src/conversion/promptbookJsonToString.d.ts

@@ -1,12 +0,0 @@
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
-/**
- * Converts promptbook in JSON format to string format
- *
- * @param promptbookJson Promptbook in JSON format (.ptbk.json)
- * @returns Promptbook in string format (.ptbk.md)
- */
-export declare function promptbookJsonToString(promptbookJson: PromptbookJson): PromptbookString;
-/**
- * TODO: Escape all
- */

package/esm/typings/src/conversion/promptbookStringToJson.d.ts

@@ -1,32 +0,0 @@
-import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
-/**
- * Options for promptbookStringToJson
- */
-type PromptbookStringToJsonOptions = {
-    /**
-     * Tools for processing required for knowledge processing *(not for actual execution)*
-     */
-    llmTools?: LlmExecutionTools;
-};
-/**
- * Compile promptbook from string (markdown) format to JSON format
- *
- * Note: There are two similar functions:
- * - `promptbookStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `promptbookStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
- *
- * @param promptbookString {Promptbook} in string markdown format (.ptbk.md)
- * @param options - Options and tools for the compilation
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
- * @throws {PromptbookSyntaxError} if the promptbook string is not valid
- *
- * Note: This function does not validate logic of the pipeline only the syntax
- * Note: This function acts as compilation process
- */
-export declare function promptbookStringToJson(promptbookString: PromptbookString, options?: PromptbookStringToJsonOptions): Promise<PromptbookJson>;
-export {};
-/**
- * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
- */

package/esm/typings/src/conversion/promptbookStringToJsonSync.d.ts

@@ -1,23 +0,0 @@
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
-/**
- * Compile promptbook from string (markdown) format to JSON format synchronously
- *
- * Note: There are two similar functions:
- * - `promptbookStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `promptbookStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
- *
- * @param promptbookString {Promptbook} in string markdown format (.ptbk.md)
- * @param options - Options and tools for the compilation
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
- * @throws {PromptbookSyntaxError} if the promptbook string is not valid
- *
- * Note: This function does not validate logic of the pipeline only the syntax
- * Note: This function acts as compilation process
- */
-export declare function promptbookStringToJsonSync(promptbookString: PromptbookString): PromptbookJson;
-/**
- * TODO: Report here line/column of error
- * TODO: Use spaceTrim more effectively
- * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
- */

package/esm/typings/src/conversion/validation/_importPromptbook.d.ts

@@ -1,13 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../../types/PromptbookString';
-/**
- * Import the text file
- *
- * Note: Using here custom import to work in jest tests
- * Note: Using sync version is 💩 in the production code, but it's ok here in tests
- *
- * @param path - The path to the file relative to samples/templates directory
- * @private
- */
-export declare function importPromptbook(path: `${string}.ptbk.md`): PromptbookString;
-export declare function importPromptbook(path: `${string}.ptbk.json`): PromptbookJson;

package/esm/typings/src/conversion/validation/validatePromptbook.d.ts

@@ -1,27 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-/**
- * Validates PromptbookJson if it is logically valid
- *
- * It checks:
- * -   if it has correct parameters dependency
- *
- * It does NOT check:
- * -   if it is valid json
- * -   if it is meaningful
- *
- * @param promptbook valid or invalid PromptbookJson
- * @returns the same promptbook if it is logically valid
- * @throws {PromptbookLogicError} on logical error in the promptbook
- */
-export declare function validatePromptbook(promptbook: PromptbookJson): PromptbookJson;
-/**
- * TODO: [🧠] Work with promptbookVersion
- * TODO: Use here some json-schema, Zod or something similar and change it to:
- *     > /**
- *     >  * Validates PromptbookJson if it is logically valid.
- *     >  *
- *     >  * It checks:
- *     >  * -   it has a valid structure
- *     >  * -   ...
- *     >  ex port function validatePromptbook(promptbook: unknown): asserts promptbook is PromptbookJson {
- */

package/esm/typings/src/library/PromptbookLibrary.d.ts

@@ -1,25 +0,0 @@
-import type { Promisable } from 'type-fest';
-import type { Prompt } from '../types/Prompt';
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { string_promptbook_url } from '../types/typeAliases';
-/**
- * Library of promptbooks that groups together promptbooks for an application.
- *
- * @see https://github.com/webgptorg/promptbook#promptbook-library
- */
-export type PromptbookLibrary = {
-    /**
-     * Gets all promptbooks in the library
-     */
-    listPromptbooks(): Promisable<Array<string_promptbook_url>>;
-    /**
-     * Gets promptbook by its URL
-     *
-     * Note: This is not a direct fetching from the URL, but a lookup in the library
-     */
-    getPromptbookByUrl(url: string_promptbook_url): Promisable<PromptbookJson>;
-    /**
-     * Checks whether given prompt was defined in any promptbook in the library
-     */
-    isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
-};

package/esm/typings/src/library/constructors/createLibraryFromJson.d.ts

@@ -1,12 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookLibrary } from '../PromptbookLibrary';
-/**
- * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
- *
- * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
- * Note: During the construction syntax and logic of all sources are validated
- *
- * @param promptbookSources
- * @returns PromptbookLibrary
- */
-export declare function createLibraryFromJson(...promptbooks: Array<PromptbookJson>): PromptbookLibrary;

package/esm/typings/src/library/constructors/createLibraryFromPromise.d.ts

@@ -1,22 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookLibrary } from '../PromptbookLibrary';
-/**
- * Constructs Promptbook from async sources
- * It can be one of the following:
- * - Promise of array of PromptbookJson or PromptbookString
- * - Factory function that returns Promise of array of PromptbookJson or PromptbookString
- *
- * Note: This is useful as internal tool for other constructor functions like
- *       `createLibraryFromUrl` or `createLibraryFromDirectory`
- *       Consider using those functions instead of this one
- *
- * Note: The function does NOT return promise it returns the library directly which waits for the sources to be resolved
- *       when error occurs in given promise or factory function, it is thrown during `listPromptbooks` or `getPromptbookByUrl` call
- *
- * Note: Consider using  `createLibraryFromDirectory` or `createLibraryFromUrl`
- *
- * @param promptbookSourcesPromiseOrFactory
- * @returns PromptbookLibrary
- * @deprecated Do not use, it will became internal tool for other constructor functions
- */
-export declare function createLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson>> | (() => Promise<Array<PromptbookJson>>)): PromptbookLibrary;

package/esm/typings/src/library/constructors/createSublibrary.d.ts

@@ -1,12 +0,0 @@
-import type { string_promptbook_url } from '../../types/typeAliases';
-import type { PromptbookLibrary } from '../PromptbookLibrary';
-/**
- * Creates PromptbookLibrary as a subset of another PromptbookLibrary
- *
- * Note: You can use any type of library as a parent library - local, remote, etc.
- * Note: This is just a thin wrapper / proxy around the parent library
- *
- * @param promptbookSources
- * @returns PromptbookLibrary
- */
-export declare function createSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;

package/umd/typings/src/conversion/promptbookJsonToString.d.ts

@@ -1,12 +0,0 @@
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
-/**
- * Converts promptbook in JSON format to string format
- *
- * @param promptbookJson Promptbook in JSON format (.ptbk.json)
- * @returns Promptbook in string format (.ptbk.md)
- */
-export declare function promptbookJsonToString(promptbookJson: PromptbookJson): PromptbookString;
-/**
- * TODO: Escape all
- */

package/umd/typings/src/conversion/promptbookStringToJson.d.ts

@@ -1,32 +0,0 @@
-import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
-/**
- * Options for promptbookStringToJson
- */
-type PromptbookStringToJsonOptions = {
-    /**
-     * Tools for processing required for knowledge processing *(not for actual execution)*
-     */
-    llmTools?: LlmExecutionTools;
-};
-/**
- * Compile promptbook from string (markdown) format to JSON format
- *
- * Note: There are two similar functions:
- * - `promptbookStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `promptbookStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
- *
- * @param promptbookString {Promptbook} in string markdown format (.ptbk.md)
- * @param options - Options and tools for the compilation
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
- * @throws {PromptbookSyntaxError} if the promptbook string is not valid
- *
- * Note: This function does not validate logic of the pipeline only the syntax
- * Note: This function acts as compilation process
- */
-export declare function promptbookStringToJson(promptbookString: PromptbookString, options?: PromptbookStringToJsonOptions): Promise<PromptbookJson>;
-export {};
-/**
- * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
- */

package/umd/typings/src/conversion/promptbookStringToJsonSync.d.ts

@@ -1,23 +0,0 @@
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
-/**
- * Compile promptbook from string (markdown) format to JSON format synchronously
- *
- * Note: There are two similar functions:
- * - `promptbookStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `promptbookStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
- *
- * @param promptbookString {Promptbook} in string markdown format (.ptbk.md)
- * @param options - Options and tools for the compilation
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
- * @throws {PromptbookSyntaxError} if the promptbook string is not valid
- *
- * Note: This function does not validate logic of the pipeline only the syntax
- * Note: This function acts as compilation process
- */
-export declare function promptbookStringToJsonSync(promptbookString: PromptbookString): PromptbookJson;
-/**
- * TODO: Report here line/column of error
- * TODO: Use spaceTrim more effectively
- * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
- */

package/umd/typings/src/conversion/validation/_importPromptbook.d.ts

@@ -1,13 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../../types/PromptbookString';
-/**
- * Import the text file
- *
- * Note: Using here custom import to work in jest tests
- * Note: Using sync version is 💩 in the production code, but it's ok here in tests
- *
- * @param path - The path to the file relative to samples/templates directory
- * @private
- */
-export declare function importPromptbook(path: `${string}.ptbk.md`): PromptbookString;
-export declare function importPromptbook(path: `${string}.ptbk.json`): PromptbookJson;

package/umd/typings/src/conversion/validation/validatePromptbook.d.ts

@@ -1,27 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-/**
- * Validates PromptbookJson if it is logically valid
- *
- * It checks:
- * -   if it has correct parameters dependency
- *
- * It does NOT check:
- * -   if it is valid json
- * -   if it is meaningful
- *
- * @param promptbook valid or invalid PromptbookJson
- * @returns the same promptbook if it is logically valid
- * @throws {PromptbookLogicError} on logical error in the promptbook
- */
-export declare function validatePromptbook(promptbook: PromptbookJson): PromptbookJson;
-/**
- * TODO: [🧠] Work with promptbookVersion
- * TODO: Use here some json-schema, Zod or something similar and change it to:
- *     > /**
- *     >  * Validates PromptbookJson if it is logically valid.
- *     >  *
- *     >  * It checks:
- *     >  * -   it has a valid structure
- *     >  * -   ...
- *     >  ex port function validatePromptbook(promptbook: unknown): asserts promptbook is PromptbookJson {
- */

package/umd/typings/src/library/PromptbookLibrary.d.ts

@@ -1,25 +0,0 @@
-import type { Promisable } from 'type-fest';
-import type { Prompt } from '../types/Prompt';
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { string_promptbook_url } from '../types/typeAliases';
-/**
- * Library of promptbooks that groups together promptbooks for an application.
- *
- * @see https://github.com/webgptorg/promptbook#promptbook-library
- */
-export type PromptbookLibrary = {
-    /**
-     * Gets all promptbooks in the library
-     */
-    listPromptbooks(): Promisable<Array<string_promptbook_url>>;
-    /**
-     * Gets promptbook by its URL
-     *
-     * Note: This is not a direct fetching from the URL, but a lookup in the library
-     */
-    getPromptbookByUrl(url: string_promptbook_url): Promisable<PromptbookJson>;
-    /**
-     * Checks whether given prompt was defined in any promptbook in the library
-     */
-    isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
-};

package/umd/typings/src/library/constructors/createLibraryFromJson.d.ts

@@ -1,12 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookLibrary } from '../PromptbookLibrary';
-/**
- * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
- *
- * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
- * Note: During the construction syntax and logic of all sources are validated
- *
- * @param promptbookSources
- * @returns PromptbookLibrary
- */
-export declare function createLibraryFromJson(...promptbooks: Array<PromptbookJson>): PromptbookLibrary;