@promptbook/cli 0.41.109

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

@@ -0,0 +1,6 @@
+import { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Function escapeMarkdownBlock will escape markdown block if needed
+ * It is useful when you want have block in block
+ */
+export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;

package/esm/typings/utils/markdown/escapeMarkdownBlock.test.d.ts

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

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

@@ -0,0 +1,27 @@
+import { string_markdown } from '../../types/typeAliases';
+/**
+ * Single code block inside markdown.
+ */
+export type CodeBlock = {
+    /**
+     * Language of the code block OR null if the language is not specified in opening ```
+     */
+    language: string | null;
+    /**
+     * Content of the code block (unescaped)
+     */
+    content: string;
+};
+/**
+ * Extracts all code blocks from markdown.
+ *
+ * Note: There are 3 simmilar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
+ *
+ * @param markdown any valid markdown
+ * @returns code blocks with language and content
+ *
+ */
+export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;

package/esm/typings/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts

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

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

@@ -0,0 +1,13 @@
+import { string_markdown, string_markdown_text } from '../.././types/typeAliases';
+/**
+ * Utility function to extract all list items from markdown
+ *
+ * Note: It works with both ul and ol
+ * Note: It omits list items in code blocks
+ * Note: It flattens nested lists
+ * Note: It can not work with html syntax and comments
+ *
+ * @param markdown any valid markdown
+ * @returns
+ */
+export declare function extractAllListItemsFromMarkdown(markdown: string_markdown): string_markdown_text[];

package/esm/typings/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts

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

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

@@ -0,0 +1,19 @@
+import { string_markdown } from '../.././types/typeAliases';
+import { CodeBlock } from './extractAllBlocksFromMarkdown';
+/**
+ * Extracts exactly ONE code block from markdown.
+ *
+ * Note: If there are multiple or no code blocks the function throws an error
+ *
+ * Note: There are 3 simmilar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
+ *
+ * @param markdown any valid markdown
+ * @returns code block with language and content
+ */
+export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
+/***
+ * TODO: [🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+ */

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

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

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

@@ -0,0 +1,8 @@
+import type { string_html } from '../../types/typeAliases';
+/**
+ * Prettify the html code
+ *
+ * @param html raw html code
+ * @returns formatted html code
+ */
+export declare function prettifyMarkdown(html: string_html): string_html;

package/esm/typings/utils/markdown/prettifyMarkdown.test.d.ts

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

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

@@ -0,0 +1,8 @@
+import { string_html, string_markdown } from '../../types/typeAliases';
+/**
+ * Removes HTML or Markdown comments from a string.
+ *
+ * @param {string} content - The string to remove comments from.
+ * @returns {string} The input string with all comments removed.
+ */
+export declare function removeContentComments<TContent extends string_html | string_markdown>(content: TContent): TContent;

package/esm/typings/utils/markdown/removeContentComments.test.d.ts

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

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

@@ -0,0 +1,8 @@
+import { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Removes Markdown formatting tags from a string.
+ *
+ * @param {string} str - The string to remove Markdown tags from.
+ * @returns {string} The input string with all Markdown tags removed.
+ */
+export declare function removeMarkdownFormatting(str: string_markdown_text): string;

package/esm/typings/utils/markdown/removeMarkdownFormatting.test.d.ts

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

package/esm/typings/utils/markdown-json/MarkdownStructure.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Represents the structure of a markdown file.
+ *
+ * @private within the library
+ */
+export type MarkdownStructure = {
+    /**
+     * The section level of the markdown file.
+     * h1 is level 1, h2 is level 2, etc.
+     */
+    level: number;
+    /**
+     * The title of the markdown file.
+     */
+    title: string;
+    /**
+     * Content of the section.
+     * It contains text, images, formatting, ul, ol, hr, blockquotes, etc. BUT not headings and sub-sections
+     */
+    content: string;
+    /**
+     * The sub-sections of current section which are recursively structured.
+     */
+    sections: MarkdownStructure[];
+};

package/esm/typings/utils/markdown-json/countMarkdownStructureDeepness.d.ts

@@ -0,0 +1,7 @@
+import { MarkdownStructure } from './MarkdownStructure';
+/**
+ * Computes the deepness of the markdown structure.
+ *
+ * @private within the library
+ */
+export declare function countMarkdownStructureDeepness(markdownStructure: MarkdownStructure): number;

package/esm/typings/utils/markdown-json/countMarkdownStructureDeepness.test.d.ts

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

package/esm/typings/utils/markdown-json/markdownToMarkdownStructure.d.ts

@@ -0,0 +1,13 @@
+import { MarkdownStructure } from './MarkdownStructure';
+/**
+ * Parse a markdown string into a MarkdownStructure object.
+ *
+ * Note: This function does work with code blocks
+ * Note: This function does not work with markdown comments
+ *
+ * @param markdown The markdown string to parse.
+ * @returns The MarkdownStructure object.
+ *
+ * @private within the library
+ */
+export declare function markdownToMarkdownStructure(markdown: string): MarkdownStructure;

package/esm/typings/utils/markdown-json/markdownToMarkdownStructure.test.d.ts

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

package/esm/typings/utils/postprocessing/extractBlock.d.ts

@@ -0,0 +1,12 @@
+import { string_markdown } from '../../types/typeAliases';
+/**
+ * Extracts code block from markdown.
+ *
+ * Note: If there are multiple or no code blocks the function throws an error
+ *
+ * Note: There are 3 simmilar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
+ */
+export declare function extractBlock(markdown: string_markdown): string;

package/esm/typings/utils/removeEmojis.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Removes emojis from a string and fix whitespaces
+ *
+ * @param text with emojis
+ * @returns text without emojis
+ */
+export declare function removeEmojis(text: string): string;

package/esm/typings/utils/removeEmojis.test.d.ts

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

package/esm/typings/utils/removeQuotes.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Removes quotes from a string
+ *
+ * Tip: This is very usefull for post-processing of the result of the LLM model
+ * Note: This function removes only the same quotes from the beginning and the end of the string
+ * Note: There are two simmilar functions:
+ * - `removeQuotes` which removes only bounding quotes
+ * - `unwrapResult` which removes whole introduce sentence
+ *
+ * @param text optionally quoted text
+ * @returns text without quotes
+ */
+export declare function removeQuotes(text: string): string;

package/esm/typings/utils/removeQuotes.test.d.ts

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

package/esm/typings/utils/trimCodeBlock.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
+ *
+ * Note: This is usefull for post-processing of the result of the chat LLM model
+ *       when the model wraps the result in the (markdown) code block.
+ *
+ */
+export declare function trimCodeBlock(value: string): string;

package/esm/typings/utils/trimCodeBlock.test.d.ts

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

package/esm/typings/utils/trimEndOfCodeBlock.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Function trimEndOfCodeBlock will remove ending code block from the string if it is present.
+ *
+ * Note: This is usefull for post-processing of the result of the completion LLM model
+ *       if you want to start code block in the prompt but you don't want to end it in the result.
+ */
+export declare function trimEndOfCodeBlock(value: string): string;

package/esm/typings/utils/trimEndOfCodeBlock.test.d.ts

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

package/esm/typings/utils/unwrapResult.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Additional options for `unwrapResult`
+ */
+interface UnwrapResultOptions {
+    /**
+     * If true, the text is trimmed before processing
+     */
+    isTrimmed?: boolean;
+    /**
+     * If true, the introduce sentence is removed
+     *
+     * For example:
+     * - If `true`>  'Hello, "world"' -> 'world'
+     * - If `false`> 'Hello, "world"' -> 'Hello, "world"'
+     *
+     * @default true
+     */
+    isIntroduceSentenceRemoved?: boolean;
+}
+/**
+ * Removes quotes and optional introduce text from a string
+ *
+ * Tip: This is very usefull for post-processing of the result of the LLM model
+ * Note: This function trims the text and removes whole introduce sentence if it is present
+ * Note: There are two simmilar functions:
+ * - `removeQuotes` which removes only bounding quotes
+ * - `unwrapResult` which removes whole introduce sentence
+ *
+ * @param text optionally quoted text
+ * @returns text without quotes
+ */
+export declare function unwrapResult(text: string, options?: UnwrapResultOptions): string;
+export {};
+/**
+ * TODO: [🧠] Should this also unwrap the (parenthesis)
+ */

package/esm/typings/utils/unwrapResult.test.d.ts

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

package/esm/typings/utils/validators/url/isValidUrl.d.ts

@@ -0,0 +1,7 @@
+import type { string_url } from '../../../types/typeAliases';
+/**
+ * Tests if given string is valid URL.
+ *
+ * Note: Dataurl are considered perfectly valid.
+ */
+export declare function isValidUrl(url: unknown): url is string_url;

package/esm/typings/utils/validators/url/isValidUrl.test.d.ts

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

package/esm/typings/version.d.ts

@@ -0,0 +1,5 @@
+import type { string_version } from './types/typeAliases';
+/**
+ * The version of the Promptbook library
+ */
+export declare const PROMPTBOOK_VERSION: string_version;

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

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

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

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

package/package.json

@@ -0,0 +1,54 @@
+{
+    "name": "@promptbook/cli",
+    "version": "0.41.109",
+    "description": "Library to supercharge your use of large language models",
+    "private": false,
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/webgptorg/promptbook"
+    },
+    "contributors": [
+        "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
+    ],
+    "keywords": [
+        "autogpt",
+        "openai",
+        "gpt-3",
+        "gpt-4",
+        "chatgpt",
+        "ai",
+        "machine-learning",
+        "natural-language-processing",
+        "nlp",
+        "prompt",
+        "template",
+        "pipeline",
+        "automation",
+        "text-generation",
+        "language-model"
+    ],
+    "license": "SEE LICENSE IN LICENSE",
+    "bugs": {
+        "url": "https://github.com/webgptorg/promptbook/issues"
+    },
+    "homepage": "https://www.npmjs.com/package/@promptbook/core",
+    "dependencies": {
+        "glob-promise": "6.0.5",
+        "colors": "1.4.0",
+        "commander": "12.0.0",
+        "n12": "1.8.18",
+        "prettier": "2.8.1",
+        "spacetrim": "0.11.2",
+        "waitasecond": "1.11.33"
+    },
+    "peerDependencies": {
+        "@promptbook/core": "0.41.109"
+    },
+    "main": "./umd/index.umd.js",
+    "module": "./esm/index.es.js",
+    "typings": "./esm/typings/_packages/cli.index.d.ts",
+    "bin": {
+        "promptbook": "bin/promptbook-cli.js"
+    }
+}