@promptbook/core 0.52.0-9 → 0.52.0

package/esm/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools.d.ts

@@ -5,6 +5,3 @@ import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
  */
 export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
 }
-/**
- * TODO: [🍓][♐] Allow to list the available prompts in Langtail
- */

package/esm/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -39,7 +39,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/esm/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts

@@ -35,6 +35,6 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🍓] Allow to list compatible models with each variant
  * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  */

package/esm/typings/execution/plugins/llm-execution-tools/remote/startRemoteServer.d.ts

@@ -10,6 +10,7 @@ import { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
 /**
+ * TODO: [⚖] Expose the library to be able to connect to same library via createPromptbookLibraryFromUrl
  * TODO: Handle progress - support streaming
  * TODO: [🤹‍♂️] Do not hang up immediately but wait until client closes OR timeout
  * TODO: [🤹‍♂️] Timeout on chat to free up resources

package/esm/typings/execution/utils/forEachAsync.d.ts

@@ -0,0 +1,18 @@
+import type { Promisable } from 'type-fest';
+type ForEachAsyncOptions = {
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default Infinity
+     */
+    inParallelCount?: number;
+};
+/**
+ * Async version of Array.forEach
+ *
+ * @param array - Array to iterate over
+ * @param options - Options for the function
+ * @param callbackfunction - Function to call for each item
+ */
+export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
+export {};

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

@@ -10,20 +10,44 @@ type CreatePromptbookLibraryFromDirectoryOptions = {
      * @default true
      */
     isRecursive?: boolean;
+    /**
+     * 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;
+    /**
+     * If true, whole library creation crashes on error in any promptbook
+     * If true and isLazyLoaded is true, the error is thrown on first access to the promptbook
+     *
+     * @default true
+     */
+    isCrashOnError?: 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: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
+ * TODO: [🧠] Maybe do not do hacks like [1] and just create package @promptbook/node
+ *       [🍓][🚯] maybe make `@promptbook/library` package
+ * TODO: Fix the dynamic import issue in Webpack (! Not working !)
+ *     > ./node_modules/@promptbook/core/esm/index.es.js
+ *     > Critical dependency: the request of a dependency is an expression
+ *
+ * Note: [1] Using require(just('fs/promises')) to allow
+ *     the `@promptbook/core` work for both Node.js and browser environments
  */

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

@@ -0,0 +1 @@
+export {};

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

@@ -14,11 +14,11 @@ import { PromptbookLibrary } from '../PromptbookLibrary';
  * 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  `createPromptbookLibraryFromDirectory` or `createPromptbookLibraryFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PromptbookLibrary
- *
- * @deprecated Consider using `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ * @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/createPromptbookLibraryFromPromise.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/library/constructors/createPromptbookLibraryFromSources.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,13 +1,30 @@
+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: [⚖] Compatible with remote server
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

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

@@ -0,0 +1,7 @@
+/**
+ * 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/core",
-    "version": "0.52.0-9",
+    "version": "0.52.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -36,7 +36,7 @@
     "dependencies": {
         "moment": "2.30.1",
         "prettier": "2.8.1",
-        "spacetrim": "0.11.25"
+        "spacetrim": "0.11.27"
     },
     "funding": [
         {