@promptbook/markdown-utils 0.61.0-7

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

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

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

@@ -0,0 +1,10 @@
+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/umd/typings/src/utils/validators/url/isValidUrl.test.d.ts

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

package/umd/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/umd/typings/src/utils/validators/uuid/isValidUuid.test.d.ts

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

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

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