@promptbook/openai 0.60.0-0 → 0.60.0-3

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;

package/umd/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/umd/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;