@promptbook/openai 0.60.0 → 0.61.0-0

package/umd/typings/src/types/PipelineJson/PromptTemplateJsonCommon.d.ts

@@ -0,0 +1,77 @@
+import type { BlockType } from '../../commands/BLOCK/BlockTypes';
+import type { ExpectFormatCommand } from '../../commands/EXPECT/ExpectFormatCommand';
+import type { string_javascript } from '../typeAliases';
+import type { string_javascript_name } from '../typeAliases';
+import type { string_markdown } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+import type { string_prompt } from '../typeAliases';
+import type { string_template } from '../typeAliases';
+import type { Expectations } from './Expectations';
+/**
+ * Common properties of all prompt templates
+ */
+export interface PromptTemplateJsonCommon {
+    /**
+     * Name of the template
+     * - It must be unique across the pipeline
+     * - It should start uppercase and contain letters and numbers
+     * - The pipelineUrl together with hash and name are used to identify the prompt template in the pipeline
+     */
+    readonly name: string_name;
+    /**
+     * Title of the prompt template
+     * It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly title: string;
+    /**
+     * Description of the prompt template
+     * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly description?: string_markdown_text;
+    /**
+     * List of parameter names that are used in the prompt template and must be defined before the prompt template is executed
+     *
+     * Note: Joker is one of the dependent parameters
+     */
+    readonly dependentParameterNames: Array<string_name>;
+    /**
+     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
+     */
+    readonly jokers?: Array<string>;
+    /**
+     * Type of the execution
+     * This determines if the prompt template is send to LLM, user or some scripting evaluation
+     */
+    readonly blockType: BlockType;
+    /**
+     * Content of the template with {placeholders} for parameters
+     */
+    readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * List of postprocessing steps that are executed after the prompt template
+     */
+    readonly postprocessing?: Array<string_javascript_name>;
+    /**
+     * Expect this amount of each unit in the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     */
+    readonly expectations?: Expectations;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @deprecated [💝]
+     */
+    readonly expectFormat?: ExpectFormatCommand['format'];
+    /**
+     * Name of the parameter that is the result of the prompt template
+     */
+    readonly resultingParameterName: string_name;
+}
+/**
+ * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
+ */

package/umd/typings/src/types/PipelineJson/ScriptJson.d.ts

@@ -0,0 +1,14 @@
+import type { ScriptLanguage } from '../ScriptLanguage';
+import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+/**
+ * Template for script execution
+ */
+export interface ScriptJson extends PromptTemplateJsonCommon {
+    readonly blockType: 'SCRIPT';
+    /**
+     * Language of the script
+     * - This is required only for blockType SCRIPT
+     *
+     */
+    readonly contentLanguage?: ScriptLanguage;
+}

package/umd/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts

@@ -0,0 +1,7 @@
+import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+/**
+ * Template for simple concatenation of strings
+ */
+export interface SimpleTemplateJson extends PromptTemplateJsonCommon {
+    readonly blockType: 'SIMPLE_TEMPLATE';
+}

package/umd/typings/src/types/Prompt.d.ts

@@ -1,7 +1,7 @@
+import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { ExpectFormatCommand } from './Command';
 import type { ModelRequirements } from './ModelRequirements';
-import type { Expectations } from './PipelineJson/PromptTemplateJson';
+import type { Expectations } from './PipelineJson/Expectations';
 import type { string_name } from './typeAliases';
 import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
 import type { string_prompt } from './typeAliases';
@@ -52,7 +52,7 @@ export type Prompt = {
      *
      * @example https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords
      */
-    readonly pipelineUrl: string_pipeline_url_with_hashtemplate;
+    readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
     /**
      * Parameters used in the prompt
      *

package/umd/typings/src/types/TaskProgress.d.ts

@@ -1,4 +1,4 @@
-import type { ExecutionType } from './ExecutionTypes';
+import type { BlockType } from '../commands/BLOCK/BlockTypes';
 import type { string_markdown_text } from './typeAliases';
 import type { string_name } from './typeAliases';
 /**
@@ -31,7 +31,7 @@ export type TaskProgress = {
      * The type of the execution.
      * Note: The pipeline executor reports everything, in the app level you can filter out the execution types that you don't want to show to the user.
      */
-    readonly executionType: ExecutionType;
+    readonly blockType: BlockType;
     /**
      * The parameter name that is being processed.
      */

package/umd/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -2,7 +2,7 @@ import type { PromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../Prompt';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_pipeline_url } from '../typeAliases';
-import type { string_version } from '../typeAliases';
+import type { string_semantic_version } from '../typeAliases';
 /**
  * ExecutionReport is result of executing one promptbook
  * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
@@ -25,11 +25,11 @@ export type ExecutionReportJson = {
     /**
      * Version from promptbook which was executed
      */
-    readonly promptbookUsedVersion: string_version;
+    readonly promptbookUsedVersion: string_semantic_version;
     /**
      * Version from promptbook which was requested by promptbook
      */
-    readonly promptbookRequestedVersion?: string_version;
+    readonly promptbookRequestedVersion?: string_semantic_version;
     /**
      * Description of the promptbook which was executed
      */

package/umd/typings/src/types/typeAliases.d.ts

@@ -101,11 +101,24 @@ export type string_xml = string;
  * For example `"**Hello** World!"`
  */
 export type string_markdown = string;
+/**
+ * Semantic helper
+ *
+ * Markdown text with exactly ONE heading on first line NO less NO more
+ */
+export type string_markdown_section = string;
+/**
+ * Semantic helper
+ *
+ * Markdown without any headings like h1, h2
+ * BUT with formatting, lists, blockquotes, blocks, etc. is allowed
+ */
+export type string_markdown_section_content = string;
 /**
  * Semantic helper
  *
  * Markdown text without any structure like h1, h2, lists, blockquotes, blocks, etc.
- * BUT with bold, italic, etc.
+ * BUT with bold, italic, etc. is allowed
  *
  * For example `"**Hello** World!"`
  */
@@ -230,10 +243,6 @@ export type string_uri_part = string;
  * For example `"9SeSQTupmQHwuSrLi"` <- TODO: !! Update
  */
 export type string_uriid = string_uri_part;
-/**
- * Semantic helper
- */
-export type string_protocol = 'http:' | 'https:';
 /**
  * Semantic helper
  *
@@ -246,12 +255,35 @@ export type string_hostname = string;
  * For example `"localhost:9977"` or `"collboard.com"`
  */
 export type string_host = string;
+/**
+ * Semantic helper
+ */
+export type string_protocol = 'http:' | 'https:';
 /**
  * Semantic helper
  *
  * For example `"pavol@hejny.org"`
  */
 export type string_email = string;
+/**
+ * Semantic helper
+ *
+ * For example `"pavol@hejny.org, jirka@webgpt.cz"`
+ */
+export type string_emails = string;
+/**
+ * Branded type for UUIDs version 4
+ * This will not allow to pass some random string where should be only a valid UUID
+ *
+ * Use utils:
+ *   - `randomUuid` to generate
+ *   - `isValidUuid  to check validity
+ *
+ * For example `"5a0a153d-7be9-4018-9eda-e0e2e2b89bd9"`
+ */
+export type string_uuid = string & {
+    readonly _type: 'uuid';
+};
 /**
  * Branded type client id
  */
@@ -269,7 +301,7 @@ export type string_sha256 = string;
  *
  * For example `"4.2.4"`
  */
-export type string_version = string;
+export type string_semantic_version = string;
 /**
  * Semantic helper
  *
@@ -430,6 +462,18 @@ export type number_kilobytes = number_positive;
 export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;
 export type number_terabytes = number_positive;
+/**
+ * Formatting helper to put void to keep longer version of prettier
+ */
+export type ___ = never;
+/**
+ * Organizational helper to better mark the place where the type is missing
+ */
+export type TODO = any;
+/**
+ * Organizational helper to mark a place where to really use any
+ */
+export type really_any = any;
 /**
  * TODO: !! Cleanup
  * TODO: !! Change to branded types

package/umd/typings/src/utils/arrayableToArray.d.ts

@@ -0,0 +1,11 @@
+import type { Arrayable } from '../types/Arrayable';
+/**
+ * Takes an item or an array of items and returns an array of items
+ *
+ * 1) Any item except array and undefined returns array with that one item (also null)
+ * 2) Undefined returns empty array
+ * 3) Array returns itself
+ *
+ * @private Internal utility
+ */
+export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): Array<TItem>;

package/umd/typings/src/utils/arrayableToArray.test.d.ts

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

package/umd/typings/src/utils/emojis.d.ts

@@ -18,5 +18,6 @@ export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoj
  */
 export declare const EMOJIS: Set<string_char_emoji>;
 /**
+ * TODO: [💴] DRY - just one version of emojis.ts
  * TODO: Mirror from Collboard or some common package
  */

package/umd/typings/src/utils/expectation-counters/countCharacters.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of characters in the text
  */

package/umd/typings/src/utils/expectation-counters/countLines.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of lines in the text
  */

package/umd/typings/src/utils/expectation-counters/countPages.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of pages in the text
  */

package/umd/typings/src/utils/expectation-counters/countParagraphs.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of paragraphs in the text
  */

package/umd/typings/src/utils/expectation-counters/countSentences.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Split text into sentences
  */

package/umd/typings/src/utils/expectation-counters/countWords.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of words in the text
  */

package/umd/typings/src/utils/expectation-counters/index.d.ts

@@ -1,5 +1,5 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
-import type { ExpectationUnit } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
 /**
  * Index of all counter functions
  */

package/umd/typings/src/utils/markdown/flattenMarkdown.d.ts

@@ -0,0 +1,14 @@
+import type { string_markdown } from '../../types/typeAliases';
+/**
+ * Normalizes the markdown by flattening the structure
+ *
+ * - It always have h1 - if there is no h1 in the markdown, it will be added "# Untitled"
+ * - All other headings are normalized to h2
+ */
+export declare function flattenMarkdown<TContent extends string_markdown>(markdown: TContent): TContent;
+/**
+ * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
+ *       sophisticated implementation of this function through parsing markdown into JSON structure
+ *       and flattening the actual structure
+ *       NOW we are working just with markdown string and its good enough
+ */

package/umd/typings/src/utils/markdown/flattenMarkdown.test.d.ts

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

package/umd/typings/src/utils/markdown/parseMarkdownSection.d.ts

@@ -0,0 +1,30 @@
+import type { string_markdown_section } from '../../types/typeAliases';
+import type { string_markdown_section_content } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Parsed markdown section
+ */
+export type MarkdownSection = {
+    /**
+     * Title of the section
+     */
+    title: string_markdown_text;
+    /**
+     * Level of the section like h1, h2, h3, h4, h5, h6
+     */
+    level: 1 | 2 | 3 | 4 | 5 | 6;
+    /**
+     * Content of the section with markdown formatting, blocks, lists, etc.
+     */
+    content: string_markdown_section_content;
+};
+/**
+ * Parses markdown section to title its level and content
+ */
+export declare function parseMarkdownSection(value: string_markdown_section): MarkdownSection;
+/**
+ * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
+ *       sophisticated implementation of this function through parsing markdown into JSON structure
+ *       and flattening the actual structure
+ *       NOW we are working just with markdown string and its good enough
+ */

package/umd/typings/src/utils/markdown/parseMarkdownSection.test.d.ts

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

package/umd/typings/src/utils/markdown/prettifyMarkdown.d.ts

@@ -4,5 +4,6 @@ import type { string_html } from '../../types/typeAliases';
  *
  * @param content raw html code
  * @returns formatted html code
+ * @private withing the package because of HUGE size of prettier dependency
  */
 export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;

package/umd/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts

@@ -0,0 +1,12 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_section } from '../../types/typeAliases';
+/**
+ * Splits the markdown into sections by headings
+ */
+export declare function splitMarkdownIntoSections(markdown: string_markdown): Array<string_markdown_section>;
+/**
+ * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
+ *       sophisticated implementation of this function through parsing markdown into JSON structure
+ *       and flattening the actual structure
+ *       NOW we are working just with markdown string and its good enough
+ */

package/umd/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts

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

package/umd/typings/src/utils/normalization/normalize-to-kebab-case.d.ts

@@ -1 +1,8 @@
-export declare function normalizeToKebabCase(sentence: string): string;
+/**
+ * Semantic helper for kebab-case strings
+ *
+ * @example 'hello-world'
+ * @example 'i-love-promptbook'
+ */
+export type string_kebab_case = string;
+export declare function normalizeToKebabCase(text: string): string_kebab_case;

package/umd/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts

@@ -1 +1,8 @@
-export declare function normalizeTo_PascalCase(sentence: string): string;
+/**
+ * Semantic helper for PascalCase strings
+ *
+ * @example 'HelloWorld'
+ * @example 'ILovePromptbook'
+ */
+export type string_PascalCase = string;
+export declare function normalizeTo_PascalCase(text: string): string_PascalCase;

package/umd/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts

@@ -1,4 +1,16 @@
-export declare function normalizeTo_SCREAMING_CASE(sentence: string): string;
 /**
+ * Semantic helper for SCREAMING_CASE strings
+ *
+ * @example 'HELLO_WORLD'
+ * @example 'I_LOVE_PROMPTBOOK'
+ */
+export type string_SCREAMING_CASE = string;
+export declare function normalizeTo_SCREAMING_CASE(text: string): string_SCREAMING_CASE;
+/**
+ * TODO: Tests
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'Moje tabule' })).toEqual('/VtG7sR9rRJqwNEdM2/Moje tabule');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'ěščřžžýáíúů' })).toEqual('/VtG7sR9rRJqwNEdM2/escrzyaieuu');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj_ahojAhoj    ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj-ahoj-ahoj-ahoj');
  * TODO: [🌺] Use some intermediate util splitWords
  */

package/umd/typings/src/utils/normalization/normalizeTo_camelCase.d.ts

@@ -1,4 +1,11 @@
-export declare function normalizeTo_camelCase(sentence: string, __firstLetterCapital?: boolean): string;
+/**
+ * Semantic helper for camelCase strings
+ *
+ * @example 'helloWorld'
+ * @example 'iLovePromptbook'
+ */
+export type string_camelCase = string;
+export declare function normalizeTo_camelCase(text: string, _isFirstLetterCapital?: boolean): string_camelCase;
 /**
  * TODO: [🌺] Use some intermediate util splitWords
  */

package/umd/typings/src/utils/normalization/normalizeTo_snake_case.d.ts

@@ -1 +1,8 @@
-export declare function normalizeTo_snake_case(sentence: string): string;
+/**
+ * Semantic helper for snake_case strings
+ *
+ * @example 'hello_world'
+ * @example 'i_love_promptbook'
+ */
+export type string_snake_case = string;
+export declare function normalizeTo_snake_case(text: string): string_snake_case;

package/umd/typings/src/{conversion/utils → utils}/parseNumber.d.ts

@@ -5,7 +5,7 @@
  * Note: it also works only with decimal numbers
  *
  * @returns parsed number
- * @throws {SyntaxError} if the value is not a number
+ * @throws {ParsingError} if the value is not a number
  *
  * @private within the parseCommand
  */

package/umd/typings/src/utils/parseNumber.test.d.ts

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

package/umd/typings/src/utils/sets/difference.d.ts

@@ -1,4 +1,6 @@
 /**
  * Create difference set of two sets.
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  */
 export declare function difference<TItem>(a: Set<TItem>, b: Set<TItem>, isEqual?: (a: TItem, b: TItem) => boolean): Set<TItem>;

package/umd/typings/src/utils/sets/intersection.d.ts

@@ -1,4 +1,6 @@
 /**
  * Creates a new set with all elements that are present in all sets
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  */
 export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/umd/typings/src/utils/sets/union.d.ts

@@ -1,4 +1,6 @@
 /**
  * Creates a new set with all elements that are present in either set
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  */
 export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/umd/typings/src/utils/validators/email/isValidEmail.d.ts

@@ -0,0 +1,5 @@
+import type { string_email } from '../../../types/typeAliases';
+/**
+ * Checks if value is valid email
+ */
+export declare function isValidEmail(email: unknown): email is string_email;

package/umd/typings/src/utils/validators/email/isValidEmail.test.d.ts

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

package/umd/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -0,0 +1,7 @@
+import type { string_file_path } from '../../../types/typeAliases';
+/**
+ * Tests if given string is valid URL.
+ *
+ * Note: This does not check if the file exists only if the path is valid
+ */
+export declare function isValidFilePath(filePath: unknown): filePath is string_file_path;

package/umd/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts

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

package/umd/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts

@@ -0,0 +1,2 @@
+import type { string_javascript_name } from '../../../types/typeAliases';
+export declare function isValidJavascriptName(javascriptName: unknown): javascriptName is string_javascript_name;

package/umd/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts

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

package/umd/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts

@@ -0,0 +1,12 @@
+import type { string_promptbook_version } from '../../../version';
+/**
+ * Tests if given string is valid promptbook version
+ * It looks into list of known promptbook versions.
+ *
+ * @see https://www.npmjs.com/package/promptbook?activeTab=versions
+ * Note: When you are using for example promptbook 2.0.0 and there already is promptbook 3.0.0 it don`t know about it.
+ * Note: There are two simmilar functions:
+ * - `isValidSemanticVersion` which tests any semantic version
+ * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
+ */
+export declare function isValidPromptbookVersion(version: unknown): version is string_promptbook_version;

package/umd/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts

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

package/umd/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts

@@ -0,0 +1,9 @@
+import type { string_semantic_version } from '../../../types/typeAliases';
+/**
+ * Tests if given string is valid semantic version
+ *
+ * Note: There are two simmilar functions:
+ * - `isValidSemanticVersion` which tests any semantic version
+ * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
+ */
+export declare function isValidSemanticVersion(version: unknown): version is string_semantic_version;

package/umd/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts

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

package/umd/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts

@@ -0,0 +1,9 @@
+import type { string_hostname } from '../../../types/typeAliases';
+/**
+ * Checks if an URL is reserved for private networks or localhost.
+ *
+ * Note: There are two simmilar functions:
+ * - `isUrlOnPrivateNetwork` which tests full URL
+ * - `isHostnameOnPrivateNetwork` *(this one)* which tests just hostname
+ */
+export declare function isHostnameOnPrivateNetwork(hostname: string_hostname): boolean;

package/umd/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts

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

package/umd/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts

@@ -0,0 +1,12 @@
+import type { string_url } from '../../../types/typeAliases';
+/**
+ * Checks if an IP address or hostname is reserved for private networks or localhost.
+ *
+ * Note: There are two simmilar functions:
+ * - `isUrlOnPrivateNetwork` *(this one)* which tests full URL
+ * - `isHostnameOnPrivateNetwork` which tests just hostname
+ *
+ * @param {string} ipAddress - The IP address to check.
+ * @returns {boolean} Returns true if the IP address is reserved for private networks or localhost, otherwise false.
+ */
+export declare function isUrlOnPrivateNetwork(url: URL | string_url): boolean;

package/umd/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts

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

package/umd/typings/src/utils/validators/url/isValidPipelineUrl.d.ts

@@ -0,0 +1,12 @@
+import type { string_pipeline_url } from '../../../types/typeAliases';
+/**
+ * Tests if given string is valid pipeline URL URL.
+ *
+ * Note: There are two simmilar functions:
+ * - `isValidUrl` which tests any URL
+ * - `isValidPipelineUrl` *(this one)* which tests just pipeline URL
+ */
+export declare function isValidPipelineUrl(url: unknown): url is string_pipeline_url;
+/**
+ * TODO: [🐠] Maybe more info why the URL is invalid
+ */

package/umd/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts

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

package/umd/typings/src/utils/validators/url/isValidUrl.d.ts

@@ -3,5 +3,8 @@ import type { string_url } from '../../../types/typeAliases';
  * Tests if given string is valid URL.
  *
  * Note: Dataurl are considered perfectly valid.
+ * Note: There are two simmilar functions:
+ * - `isValidUrl` which tests any URL
+ * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
  */
 export declare function isValidUrl(url: unknown): url is string_url;