@promptbook/utils 0.41.0 → 0.41.2

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

@@ -1,8 +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;
+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

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

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

@@ -1,8 +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;
+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

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

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

@@ -1,25 +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[];
-};
+/**
+ * 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

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

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

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

@@ -1,13 +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;
+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

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

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

@@ -1,12 +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;
+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

@@ -1,7 +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;
+/**
+ * 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

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

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

@@ -1,13 +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;
+/**
+ * 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

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

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

@@ -1,8 +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;
+/**
+ * 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

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

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

@@ -1,7 +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;
+/**
+ * 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

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

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

@@ -1,36 +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)
- */
+/**
+ * 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

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

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

@@ -1,7 +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;
+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

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

package/esm/typings/version.d.ts

@@ -1,5 +1,5 @@
-import type { string_version } from './types/typeAliases';
-/**
- * The version of the Promptbook library
- */
-export declare const PROMPTBOOK_VERSION: string_version;
+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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.41.0",
+    "version": "0.41.2",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -33,6 +33,9 @@
         "url": "https://github.com/webgptorg/promptbook/issues"
     },
     "homepage": "https://www.npmjs.com/package/@promptbook/core",
+    "bin": {
+        "promptbook": "bin/promptbook-cli.js"
+    },
     "dependencies": {
         "moment": "^2.30.1",
         "n12": "1.8.18",