@promptbook/remote-server 0.47.0 → 0.48.0-1

package/README.md

@@ -5,13 +5,13 @@ Library to supercharge your use of large language models
 
 
 
-
 [![NPM Version of ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook](https://badge.fury.io/js/promptbook.svg)](https://www.npmjs.com/package/promptbook)
 [![Quality of package ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook](https://packagequality.com/shield/promptbook.svg)](https://packagequality.com/#?package=promptbook)
 [![Known Vulnerabilities](https://snyk.io/test/github/webgptorg/promptbook/badge.svg)](https://snyk.io/test/github/webgptorg/promptbook)
 [![Issues](https://img.shields.io/github/issues/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/issues)
 [![Socket](https://socket.dev/api/badge/npm/package/promptbook)](https://socket.dev/npm/package/promptbook)
 
+
 [![Socket Badge](https://socket.dev/api/badge/npm/package/@promptbook/remote-server)](https://socket.dev/npm/package/@promptbook/remote-server)
 
 
@@ -651,6 +651,17 @@ GPTs are chat assistants that can be assigned to specific tasks and materials. B
 
 
 
+
+
+
+
+
+
+
+
+
+
+
 ### Where should I store my promptbooks?
 
 If you use raw SDKs, you just put prompts in the sourcecode, mixed in with typescript, javascript, python or whatever programming language you use.

package/esm/index.es.js

@@ -89,7 +89,7 @@ var PromptbookExecutionError = /** @class */ (function (_super) {
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.47.0-0';
+var PROMPTBOOK_VERSION = '0.48.0-0';
 
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.

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

@@ -1,4 +1,5 @@
 import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
+import { promptbookJsonToString } from '../conversion/promptbookJsonToString';
 import { validatePromptbookJson } from '../conversion/validation/validatePromptbookJson';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { CallbackInterfaceTools } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools';
@@ -13,6 +14,6 @@ import { PROMPTBOOK_VERSION } from '../version';
 export { ExecutionTypes, PROMPTBOOK_VERSION };
 export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
-export { promptbookStringToJson, validatePromptbookJson };
+export { promptbookStringToJson, promptbookJsonToString, validatePromptbookJson };
 export { createPromptbookExecutor };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };

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

@@ -2,6 +2,7 @@ import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
 import { parseNumber } from '../conversion/utils/parseNumber';
+import { titleToName } from '../conversion/utils/titleToName';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
 import { replaceParameters } from '../execution/utils/replaceParameters';
@@ -56,7 +57,7 @@ export declare const normalizeTo: {
     snake_case: typeof normalizeTo_snake_case;
     'kebab-case': typeof normalizeToKebabCase;
 };
-export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, };
+export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, titleToName, };
 export { renderPromptbookMermaid };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities

package/esm/typings/conversion/prettify/prettifyPromptbookStringCli.d.ts

@@ -1,5 +1,5 @@
 /**
- * !!! Initialize
+ * Runs CLI script for prettifying promptbooks
  */
 export declare function prettifyPromptbookStringCli(): Promise<void>;
 /**

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

@@ -0,0 +1,8 @@
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookString } from '../types/PromptbookString';
+export declare function promptbookJsonToString(promptbookJson: PromptbookJson): PromptbookString;
+/**
+ * TODO: !!!!! Implement
+ * TODO: !!!!! Annotate and warn
+ * TODO: !!!!! Test + test together with promptbookStringToJson
+ */

package/esm/typings/conversion/utils/titleToName.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Function normalizes title to name which can be used as identifier
+ */
+export declare function titleToName(value: string): string;

package/esm/typings/conversion/utils/titleToName.test.d.ts

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

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

@@ -24,5 +24,5 @@ export type ExecutionTools = {
     userInterface: UserInterfaceTools;
 };
 /**
- * TODO: !!!! Allow more
+ * TODO: [🍓] !!!! Allow to have more LlmExecutionTools
  */

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

@@ -18,6 +18,7 @@ export type LlmExecutionTools = {
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
 };
 /**
+ * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: [🏳] gptChat -> chat, gptComplete -> complete, translate
  * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat
  */

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

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

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

@@ -27,7 +27,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
 }
 /**
-
+ * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

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

@@ -1,8 +1,11 @@
 import type OpenAI from 'openai';
 import type { PromptResult } from '../../../PromptResult';
 /**
- * !!!
+ * Computes the usage of the OpenAI API based on the response from OpenAI
  *
  * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
  */
 export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];
+/**
+ * TODO: [🍓] Make better
+ */

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

@@ -31,5 +31,6 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     private gptCommon;
 }
 /**
+ * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  */

package/esm/typings/library/SimplePromptbookLibrary.d.ts

@@ -10,7 +10,8 @@ import { PromptbookLibrary } from './PromptbookLibrary';
  */
 export declare class SimplePromptbookLibrary implements PromptbookLibrary {
     private library;
-    /**!!!
+    /**
+     * Constructs a promptbook library from promptbooks
      *
      * @param promptbooks !!!
      *

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

@@ -1,5 +1,14 @@
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * 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
+ *
+ * @returns PromptbookLibrary
+ */
 export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
 /***
- * TODO: !!! Annotate all + all to README and samples
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

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

@@ -1,7 +1,26 @@
 import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
 import { PromptbookString } from '../../types/PromptbookString';
 import { 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
+ *       `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ *       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
+ *
+ *
+ * @param promptbookSourcesPromiseOrFactory
+ * @returns PromptbookLibrary
+ *
+ * @deprecated Consider using `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ */
 export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
 /***
- * TODO: !!! Annotate all + all to README and samples
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

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

@@ -1,16 +1,15 @@
 import { PromptbookJson, PromptbookString } from '../../_packages/types.index';
 import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
-export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
 /**
- * Constructs Promptbook from any sources
+ * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
  *
+ * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
  * 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
+ * @param promptbookSources
  * @returns PromptbookLibrary
  */
+export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
 /***
- * TODO: !!! Annotate all + all to README and samples
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

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

@@ -0,0 +1,13 @@
+import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * 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;
+/***
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
+ */

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

@@ -1,6 +1,15 @@
 import type { string_promptbook_url } from '../../types/typeAliases';
 import { 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 createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
 /***
- * TODO: !!! Annotate all + all to README and samples
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

package/esm/typings/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -15,5 +15,5 @@ import { CodeBlock } from './extractAllBlocksFromMarkdown';
  */
 export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***
- * TODO: [🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+ * TODO: [🍓][🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-server",
-    "version": "0.47.0",
+    "version": "0.48.0-1",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -49,7 +49,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.47.0"
+        "@promptbook/core": "0.48.0-1"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -95,7 +95,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.47.0-0';
+    var PROMPTBOOK_VERSION = '0.48.0-0';
 
     /**
      * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.

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

@@ -1,4 +1,5 @@
 import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
+import { promptbookJsonToString } from '../conversion/promptbookJsonToString';
 import { validatePromptbookJson } from '../conversion/validation/validatePromptbookJson';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { CallbackInterfaceTools } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools';
@@ -13,6 +14,6 @@ import { PROMPTBOOK_VERSION } from '../version';
 export { ExecutionTypes, PROMPTBOOK_VERSION };
 export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
-export { promptbookStringToJson, validatePromptbookJson };
+export { promptbookStringToJson, promptbookJsonToString, validatePromptbookJson };
 export { createPromptbookExecutor };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };

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

@@ -2,6 +2,7 @@ import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
 import { parseNumber } from '../conversion/utils/parseNumber';
+import { titleToName } from '../conversion/utils/titleToName';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
 import { replaceParameters } from '../execution/utils/replaceParameters';
@@ -56,7 +57,7 @@ export declare const normalizeTo: {
     snake_case: typeof normalizeTo_snake_case;
     'kebab-case': typeof normalizeToKebabCase;
 };
-export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, };
+export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, titleToName, };
 export { renderPromptbookMermaid };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities

package/umd/typings/conversion/prettify/prettifyPromptbookStringCli.d.ts

@@ -1,5 +1,5 @@
 /**
- * !!! Initialize
+ * Runs CLI script for prettifying promptbooks
  */
 export declare function prettifyPromptbookStringCli(): Promise<void>;
 /**

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

@@ -0,0 +1,8 @@
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookString } from '../types/PromptbookString';
+export declare function promptbookJsonToString(promptbookJson: PromptbookJson): PromptbookString;
+/**
+ * TODO: !!!!! Implement
+ * TODO: !!!!! Annotate and warn
+ * TODO: !!!!! Test + test together with promptbookStringToJson
+ */

package/umd/typings/conversion/utils/titleToName.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Function normalizes title to name which can be used as identifier
+ */
+export declare function titleToName(value: string): string;

package/umd/typings/conversion/utils/titleToName.test.d.ts

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

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

@@ -24,5 +24,5 @@ export type ExecutionTools = {
     userInterface: UserInterfaceTools;
 };
 /**
- * TODO: !!!! Allow more
+ * TODO: [🍓] !!!! Allow to have more LlmExecutionTools
  */

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

@@ -18,6 +18,7 @@ export type LlmExecutionTools = {
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
 };
 /**
+ * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: [🏳] gptChat -> chat, gptComplete -> complete, translate
  * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat
  */

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

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

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

@@ -27,7 +27,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
 }
 /**
-
+ * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/umd/typings/execution/plugins/llm-execution-tools/openai/computeOpenaiUsage.d.ts

@@ -1,8 +1,11 @@
 import type OpenAI from 'openai';
 import type { PromptResult } from '../../../PromptResult';
 /**
- * !!!
+ * Computes the usage of the OpenAI API based on the response from OpenAI
  *
  * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
  */
 export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];
+/**
+ * TODO: [🍓] Make better
+ */

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

@@ -31,5 +31,6 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     private gptCommon;
 }
 /**
+ * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  */

package/umd/typings/library/SimplePromptbookLibrary.d.ts

@@ -10,7 +10,8 @@ import { PromptbookLibrary } from './PromptbookLibrary';
  */
 export declare class SimplePromptbookLibrary implements PromptbookLibrary {
     private library;
-    /**!!!
+    /**
+     * Constructs a promptbook library from promptbooks
      *
      * @param promptbooks !!!
      *

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

@@ -1,5 +1,14 @@
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * 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
+ *
+ * @returns PromptbookLibrary
+ */
 export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
 /***
- * TODO: !!! Annotate all + all to README and samples
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

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

@@ -1,7 +1,26 @@
 import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
 import { PromptbookString } from '../../types/PromptbookString';
 import { 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
+ *       `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ *       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
+ *
+ *
+ * @param promptbookSourcesPromiseOrFactory
+ * @returns PromptbookLibrary
+ *
+ * @deprecated Consider using `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ */
 export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
 /***
- * TODO: !!! Annotate all + all to README and samples
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

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

@@ -1,16 +1,15 @@
 import { PromptbookJson, PromptbookString } from '../../_packages/types.index';
 import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
-export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
 /**
- * Constructs Promptbook from any sources
+ * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
  *
+ * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
  * 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
+ * @param promptbookSources
  * @returns PromptbookLibrary
  */
+export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
 /***
- * TODO: !!! Annotate all + all to README and samples
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

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

@@ -0,0 +1,13 @@
+import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * 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;
+/***
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
+ */

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

@@ -1,6 +1,15 @@
 import type { string_promptbook_url } from '../../types/typeAliases';
 import { 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 createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
 /***
- * TODO: !!! Annotate all + all to README and samples
+ * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

package/umd/typings/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -15,5 +15,5 @@ import { CodeBlock } from './extractAllBlocksFromMarkdown';
  */
 export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***
- * TODO: [🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+ * TODO: [🍓][🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
  */

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

@@ -1,5 +0,0 @@
-import { PromptbookLibrary } from '../PromptbookLibrary';
-export declare function createPromptbookLibraryFromList(): PromptbookLibrary;
-/***
- * TODO: !!! Annotate all + all to README and samples
- */

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

@@ -1,5 +0,0 @@
-import { PromptbookLibrary } from '../PromptbookLibrary';
-export declare function createPromptbookLibraryFromList(): PromptbookLibrary;
-/***
- * TODO: !!! Annotate all + all to README and samples
- */