@promptbook/openai 0.52.0-19 → 0.52.0-24

package/README.md

@@ -145,7 +145,7 @@ File `write-website-content.ptbk.md`:
 >
 > Instructions for creating web page content.
 >
-> -   PROMPTBOOK URL https://promptbook.webgpt.com/en/write-website-content.ptbk.md@v0.1.0
+> -   PROMPTBOOK URL https://promptbook.webgpt.com/en/write-website-content.ptbk.md
 > -   PROMPTBOOK VERSION 0.0.1
 > -   INPUT  PARAM `{rawTitle}` Automatically suggested a site name or empty text
 > -   INPUT  PARAM `{rawAssigment}` Automatically generated site entry from image recognition

package/esm/typings/_packages/core.index.d.ts

@@ -10,7 +10,6 @@ import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interfa
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
 import { createPromptbookLibraryFromDirectory } from '../library/constructors/createPromptbookLibraryFromDirectory';
-import { createPromptbookLibraryFromPromise } from '../library/constructors/createPromptbookLibraryFromPromise';
 import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
 import { createPromptbookLibraryFromUrl } from '../library/constructors/createPromptbookLibraryFromUrl';
 import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
@@ -23,7 +22,7 @@ import { PROMPTBOOK_VERSION } from '../version';
 export { justTestFsImport };
 export { ExecutionTypes, PROMPTBOOK_VERSION };
 export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
-export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
+export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };

package/esm/typings/execution/ExecutionTools.d.ts

@@ -9,6 +9,9 @@ import type { UserInterfaceTools } from './UserInterfaceTools';
 export type ExecutionTools = {
     /**
      * Tools for executing prompts to large language models like GPT-4
+     *
+     * Tip: Combine multiple LLM execution tools with `MultipleLlmExecutionTools`
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
      */
     llm: LlmExecutionTools;
     /**
@@ -16,15 +19,14 @@ export type ExecutionTools = {
      *
      * Note: You can pass multiple ScriptExecutionTools, they will be tried one by one until one of them supports the script
      *       If none of them supports the script, an error is thrown
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
      */
     script: Array<ScriptExecutionTools>;
     /**
      * Tools for interacting with the user
      *
      * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
      */
     userInterface?: UserInterfaceTools;
 };
-/**
- * TODO: [🍓] !!!! Allow to have more LlmExecutionTools
- */

package/esm/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts

@@ -11,24 +11,28 @@ type CreatePromptbookLibraryFromDirectoryOptions = {
      */
     isRecursive?: boolean;
     /**
-     * If true, the library ceation outputs information about each file it reads
+     * If true, the library creation outputs information about each file it reads
      *
      * @default false
      */
     isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
 };
 /**
  * Constructs Promptbook from given directory
  *
  * Note: Works only in Node.js environment because it reads the file system
- * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
- *       SO during the construction syntax and logic sources IS NOT validated
  *
  * @param path - path to the directory with promptbooks
  * @param options - Misc options for the library
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): PromptbookLibrary;
+export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
 export {};
 /***
  * TODO: [🧠] Maybe do not do hacks like [1] and just create package @promptbook/node

package/esm/typings/library/constructors/createPromptbookLibraryFromPromise.d.ts

@@ -18,6 +18,7 @@ import { PromptbookLibrary } from '../PromptbookLibrary';
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PromptbookLibrary
+ * @private Just internal tool for other constructor functions
  */
 export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
 /***

package/esm/typings/library/constructors/createPromptbookLibraryFromUrl.d.ts

@@ -1,13 +1,29 @@
+import { string_url } from '../../types/typeAliases';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Options for `createPromptbookLibraryFromDirectory` function
+ */
+type CreatePromptbookLibraryFromUrlyOptions = {
+    /**
+     * If true, the library creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+};
 /**
  * Constructs Promptbook from remote Promptbase URL
- *
- * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
- *       SO during the construction syntax and logic sources IS NOT validated
- *
+
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromUrl(): PromptbookLibrary;
+export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
+export {};
 /***
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

package/esm/typings/library/constructors/justTestFsImport.d.ts

@@ -2,3 +2,6 @@
  * Just testing imports and compatibility
  */
 export declare function justTestFsImport(): Promise<void>;
+/**
+ * TODO: !!! Remove this file
+ */ 

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

@@ -39,7 +39,7 @@ export type Prompt = {
     /**
      * Unique identifier of the promptbook with specific template name as hash
      *
-     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords
+     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md#keywords
      */
     readonly promptbookUrl: string_promptbook_url_with_hashtemplate;
     /**

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.52.0-19",
+    "version": "0.52.0-24",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -48,7 +48,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.52.0-19"
+        "@promptbook/core": "0.52.0-24"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/typings/_packages/core.index.d.ts

@@ -10,7 +10,6 @@ import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interfa
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
 import { createPromptbookLibraryFromDirectory } from '../library/constructors/createPromptbookLibraryFromDirectory';
-import { createPromptbookLibraryFromPromise } from '../library/constructors/createPromptbookLibraryFromPromise';
 import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
 import { createPromptbookLibraryFromUrl } from '../library/constructors/createPromptbookLibraryFromUrl';
 import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
@@ -23,7 +22,7 @@ import { PROMPTBOOK_VERSION } from '../version';
 export { justTestFsImport };
 export { ExecutionTypes, PROMPTBOOK_VERSION };
 export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
-export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
+export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };

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

@@ -9,6 +9,9 @@ import type { UserInterfaceTools } from './UserInterfaceTools';
 export type ExecutionTools = {
     /**
      * Tools for executing prompts to large language models like GPT-4
+     *
+     * Tip: Combine multiple LLM execution tools with `MultipleLlmExecutionTools`
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
      */
     llm: LlmExecutionTools;
     /**
@@ -16,15 +19,14 @@ export type ExecutionTools = {
      *
      * Note: You can pass multiple ScriptExecutionTools, they will be tried one by one until one of them supports the script
      *       If none of them supports the script, an error is thrown
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
      */
     script: Array<ScriptExecutionTools>;
     /**
      * Tools for interacting with the user
      *
      * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
      */
     userInterface?: UserInterfaceTools;
 };
-/**
- * TODO: [🍓] !!!! Allow to have more LlmExecutionTools
- */

package/umd/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts

@@ -11,24 +11,28 @@ type CreatePromptbookLibraryFromDirectoryOptions = {
      */
     isRecursive?: boolean;
     /**
-     * If true, the library ceation outputs information about each file it reads
+     * If true, the library creation outputs information about each file it reads
      *
      * @default false
      */
     isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
 };
 /**
  * Constructs Promptbook from given directory
  *
  * Note: Works only in Node.js environment because it reads the file system
- * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
- *       SO during the construction syntax and logic sources IS NOT validated
  *
  * @param path - path to the directory with promptbooks
  * @param options - Misc options for the library
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): PromptbookLibrary;
+export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
 export {};
 /***
  * TODO: [🧠] Maybe do not do hacks like [1] and just create package @promptbook/node

package/umd/typings/library/constructors/createPromptbookLibraryFromPromise.d.ts

@@ -18,6 +18,7 @@ import { PromptbookLibrary } from '../PromptbookLibrary';
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PromptbookLibrary
+ * @private Just internal tool for other constructor functions
  */
 export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
 /***

package/umd/typings/library/constructors/createPromptbookLibraryFromUrl.d.ts

@@ -1,13 +1,29 @@
+import { string_url } from '../../types/typeAliases';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Options for `createPromptbookLibraryFromDirectory` function
+ */
+type CreatePromptbookLibraryFromUrlyOptions = {
+    /**
+     * If true, the library creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+};
 /**
  * Constructs Promptbook from remote Promptbase URL
- *
- * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
- *       SO during the construction syntax and logic sources IS NOT validated
- *
+
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromUrl(): PromptbookLibrary;
+export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
+export {};
 /***
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

package/umd/typings/library/constructors/justTestFsImport.d.ts

@@ -2,3 +2,6 @@
  * Just testing imports and compatibility
  */
 export declare function justTestFsImport(): Promise<void>;
+/**
+ * TODO: !!! Remove this file
+ */ 

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

@@ -39,7 +39,7 @@ export type Prompt = {
     /**
      * Unique identifier of the promptbook with specific template name as hash
      *
-     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords
+     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md#keywords
      */
     readonly promptbookUrl: string_promptbook_url_with_hashtemplate;
     /**

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

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

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

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

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

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

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

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

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

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