@promptbook/utils 0.47.0-0 → 0.48.0-0

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
- */