@promptbook/node 0.60.0 → 0.61.0-0

package/esm/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/esm/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/esm/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/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts

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

package/esm/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/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts

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

package/esm/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/esm/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/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts

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

package/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/typings/src/utils/parseNumber.test.d.ts

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

package/esm/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/esm/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/esm/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/esm/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/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts

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

package/esm/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/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts

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

package/esm/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/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts

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

package/esm/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/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts

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

package/esm/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/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts

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

package/esm/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/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts

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

package/esm/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/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts

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

package/esm/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/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts

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

package/esm/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;

package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts

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

package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts

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

package/esm/typings/src/version.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.60.0",
+    "version": "0.61.0-0",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -49,7 +49,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.60.0"
+        "@promptbook/core": "0.61.0-0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",