@promptbook/remote-server 0.8.0

package/esm/typings/types/typeAliases.d.ts

@@ -0,0 +1,477 @@
+/**
+ * Semantic helper
+ */
+export type string_business_category_name = 'restaurant' | 'grocery' | 'person' | 'conference' | string;
+/**
+ * Semantic helper
+ *
+ * For example `"gpt-4"`
+ */
+export type string_model_name = 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-16k-0613' | string;
+/**
+ * Semantic helper
+ *
+ * For example `"A cat wearing a hat"`
+ */
+export type string_prompt = string;
+/**
+ * Semantic helper
+ *
+ * For example `"A cat wearing a {ITEM}"`
+ */
+export type string_template = string;
+/**
+ * Semantic helper
+ *
+ * For example `"A cat wearing a hat"`
+ */
+export type string_image_prompt = string_prompt;
+/**
+ * Semantic helper
+ *
+ * For example `"A cat wearing a hat --wallpaper --v 5.2"`
+ */
+export type string_midjourney_prompt = string_image_prompt;
+/**
+ * Semantic helper
+ *
+ * For example `"How many hats does the cat wear?"`
+ */
+export type string_text_prompt = string_prompt;
+/**
+ * Semantic helper
+ *
+ * For example `"How many hats does the cat wear?"`
+ */
+export type string_chat_prompt = string_text_prompt;
+/**
+ * Semantic helper
+ *
+ * For example `"Following is a text about cats: Once upon a time there was a cat"`
+ */
+export type string_completion_prompt = string_text_prompt;
+/**
+ * Semantic helper
+ *
+ * For example `"index"` or `"explanation"`
+ * Always in kebab-case
+ */
+export type string_page = 'index' | string;
+/**
+ * Semantic helper
+ *
+ * For example `"text/plain"` or `"application/collboard"`
+ */
+export type string_mime_type = string;
+/**
+ * Semantic helper
+ *
+ * For example `"text/*"` or `"image/*"`
+ *
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#unique_file_type_specifiers
+ */
+export type string_mime_type_with_wildcard = string;
+/**
+ * Semantic helper
+ *
+ * For example `"a"`
+ */
+export type string_char = string;
+/**
+ * Semantic helper
+ * Unique identifier of anything
+ *
+ * For example `"ainautes"`
+ */
+export type string_name = string;
+/**
+ * Semantic helper
+ * Title of anything
+ *
+ * For example `"Ai*nautes"`
+ */
+export type string_title = string;
+/**
+ * Semantic helper
+ *
+ * For example `"<div>Hello World!</div>"`
+ */
+export type string_html = string;
+/**
+ * Semantic helper
+ *
+ * For example `"<foo>bar</foo>"`
+ *
+ *
+ * TODO: [🎞️] Probbably use some object-based method for working with XMLs
+ */
+export type string_xml = string;
+/**
+ * Semantic helper
+ *
+ * For example `"**Hello** World!"`
+ */
+export type string_markdown = string;
+/**
+ * Semantic helper
+ *
+ * Markdown text without any structure like h1, h2, lists, blockquotes, blocks, etc.
+ * BUT with bold, italic, etc.
+ *
+ * For example `"**Hello** World!"`
+ */
+export type string_markdown_text = string;
+/**
+ * Semantic helper
+ *
+ * For example `"towns.cz"`
+ */
+export type string_domain = string;
+/**
+ * Semantic helper
+ *
+ * For example `"com"`
+ */
+export type string_tdl = string;
+/**
+ * Semantic helper
+ *
+ * For example `.foo{border: 1px solid red}`
+ */
+export type string_css = string;
+/**
+ * Semantic helper
+ *
+ * For example `"<svg><circle cx="50" cy="50" r="40" stroke="green" stroke-width="4" fill="yellow" /></svg>"`
+ */
+export type string_svg = string;
+/**
+ * Semantic helper
+ *
+ * For example `console.info("Hello World!")` or `print("Hello World!")`
+ */
+export type string_script = string;
+/**
+ * Semantic helper
+ *
+ * For example `console.info("Hello World!")`
+ */
+export type string_javascript = string;
+/**
+ * Semantic helper
+ *
+ * For example `menu`
+ */
+export type string_css_class = string;
+/**
+ * Semantic helper
+ *
+ * For example `border`
+ */
+export type string_css_property = string;
+/**
+ * Semantic helper
+ *
+ * For example `13px`
+ */
+export type string_css_value = string;
+/**
+ * Semantic helper
+ *
+ * For example `.foo`
+ */
+export type string_css_selector = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"`
+ */
+export type string_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://ptp.webgpt.com/cs/write-wallpaper-content.ptp.md@v2.4.15"`
+ */
+export type string_ptp_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://ptp.webgpt.com/cs/write-wallpaper-content.ptp.md@v2.4.15#keywords"`
+ */
+export type string_ptp_url_with_hashtemplate = string;
+/**
+ * Semantic helper
+ *
+ * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
+ */
+export type string_data_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"` OR `/9SeSQTupmQHwuSrLi`
+ */
+export type string_href = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi.png?width=1200&height=630"`
+ */
+export type string_url_image = string;
+/**
+ * Semantic helper
+ *
+ * For example `"/9SeSQTupmQHwuSrLi"`
+ */
+export type string_uri = string;
+/**
+ * Semantic helper
+ *
+ * For example `"9SeSQTupmQHwuSrLi"`
+ */
+export type string_uri_part = string;
+/**
+ * Semantic helper, ID of the board used in URL and API
+ *
+ * For example `"9SeSQTupmQHwuSrLi"` <- TODO: !! Update
+ */
+export type string_uriid = string_uri_part;
+/**
+ * Semantic helper
+ */
+export type string_protocol = 'http:' | 'https:';
+/**
+ * Semantic helper
+ *
+ * For example `"localhost"` or `"collboard.com"`
+ */
+export type string_hostname = string;
+/**
+ * Semantic helper
+ *
+ * For example `"localhost:9977"` or `"collboard.com"`
+ */
+export type string_host = string;
+/**
+ * Semantic helper
+ *
+ * For example `"pavol@hejny.org"`
+ */
+export type string_email = 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 uuid = string & {
+    readonly __type: 'UUID';
+};
+/**
+ * Semantic helper
+ *
+ * For example `"5a0a153d-7be9-4018-9eda-e0e2e2b89bd9"`
+ */
+export type string_wallpaper_id = uuid | string_uriid;
+/**
+ * Semantic helper
+ * UUID with only the first part of the UUID
+ *
+ *
+ * For example `"5a0a153d"`
+ */
+export type uuid_first_segment = string;
+/**
+ * Semantic helper
+ *
+ * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
+ */
+export type string_sha256 = string;
+/**
+ * Semantic helper
+ *
+ * For example `"4.2.4"`
+ */
+export type string_version = string;
+/**
+ * Semantic helper
+ *
+ * For example `"^4.2.4"`
+ */
+export type string_version_dependency = string;
+/**
+ * Semantic helper
+ *
+ * For example `"png"`
+ */
+export type string_file_extension = string;
+/**
+ * Semantic helper
+ *
+ * For example `"C:/Users/me/work/collboard/modules-sdk/src/colldev/commands/develop/ColldevDevelop.tsx"`
+ */
+export type string_file_absolute_path = string;
+/**
+ * Semantic helper
+ *
+ * For example `"./src/colldev/commands/develop/ColldevDevelop.tsx"`
+ */
+export type string_file_relative_path = string;
+/**
+ * Semantic helper
+ */
+export type string_file_path = string_file_absolute_path | string_file_relative_path;
+/**
+ * Semantic helper
+ *
+ * For example `"C:/Users/me/work/collboard/modules-sdk/src/colldev/commands/develop/ColldevDevelop.tsx"`
+ */
+export type string_folder_absolute_path = string;
+/**
+ * Semantic helper
+ *
+ * For example `"./src/colldev/commands/develop/ColldevDevelop.tsx"`
+ */
+export type string_folder_relative_path = string;
+/**
+ * Semantic helper
+ */
+export type string_folder_path = string_file_absolute_path | string_file_relative_path;
+/**
+ * Semantic helper
+ */
+export type string_filename = string;
+/**
+ * Semantic helper
+ *
+ * For example `"John Smith"`
+ */
+export type string_person_fullname = string;
+/**
+ * Semantic helper
+ * Full profile of the person with his email and web (like in package.json)
+ *
+ * For example `"Pavol Hejný <pavol@hejny.org> (https://pavolhejny.com)"`
+ */
+export type string_person_profile = string;
+/**
+ * Full profile of the person with his email and web (like in package.json)
+ */
+export interface IPersonProfile {
+    readonly name?: string_person_fullname;
+    /**
+     * Note: Photos are taken from Gravatar by email
+     */
+    readonly email?: string_email;
+    readonly url?: string_url;
+}
+/**
+ * Semantic helper
+ *
+ * For example `"MIT"`
+ */
+export type string_license = string;
+/**
+ * License with its type and url like in package.json
+ */
+export interface ILicense {
+    readonly type?: string_license;
+    readonly url?: string;
+}
+/**
+ * Repository with its type and url like in package.json
+ */
+export interface IRepository {
+    readonly type?: string | 'git';
+    readonly url?: string;
+}
+/**
+ * CSS cursor type
+ */
+export type string_css_cursor = 'alias' | 'all-scroll' | 'auto' | 'cell' | 'context-menu' | 'col-resize' | 'copy' | 'crosshair' | 'default' | 'e-resize' | 'ew-resize' | 'grab' | 'grabbing' | 'help' | 'move' | 'n-resize' | 'ne-resize' | 'nesw-resize' | 'ns-resize' | 'nw-resize' | 'nwse-resize' | 'no-drop' | 'none' | 'not-allowed' | 'pointer' | 'progress' | 'row-resize' | 's-resize' | 'se-resize' | 'sw-resize' | 'text' | 'w-resize' | 'wait' | 'zoom-in' | 'zoom-out';
+/**
+ * Semantic helper for attributes
+ *
+ * - case insensitive
+ *
+ * For example `"color"`
+ */
+export type string_attribute = string;
+/**
+ * Semantic helper for attributes context
+ * Each attribute value scope with a attribute name has its own current value
+ *
+ * - case insensitive
+ *
+ * For example `"tools"`
+ */
+export type string_attribute_value_scope = string;
+/**
+ * Semantic helper for css/html colors
+ *
+ * For example `"white"` or `"#009edd"`
+ */
+export type string_color = string;
+/**
+ * Semantic helper; For example "SHARE_ICON/EDIT_LINK"
+ */
+export type string_translate_name = string;
+/**
+ * Semantic helper; For example "ShareIcon/ edit link"
+ */
+export type string_translate_name_not_normalized = string;
+/**
+ * Semantic helper; For example "cs" or "en"
+ * Implementing ISO 639-1
+ *
+ * TODO: Probably use enum
+ * TODO: Rename - remove string_ prefix like ITranslateLanguageCode
+ */
+export type string_translate_language = 'en' | 'cs';
+/**
+ * Semantic helper; For example "callbackName" or "renderMe"
+ */
+export type string_javascript_name = string;
+export type string_token = string;
+export type string_license_token = string_token;
+export type string_password = string;
+export type string_ssh_key = string;
+export type string_pgp_key = string;
+export type number_positive = number;
+export type number_negative = number;
+export type number_integer = number;
+/**
+ * Semantic helper;
+ * Percentage from 0 to 1 (100%)
+ */
+export type number_percent = number;
+/**
+ * Likeness of the wallpaper
+ *
+ * - 👍 is eqivalent for 1
+ * - 👎 is eqivalent for -1
+ * - ❤ is eqivalent for more than 1
+ * - etc
+ */
+export type number_likeness = number;
+export type number_miliseconds = number_integer;
+export type number_seconds = number;
+export type number_minutes = number;
+export type number_hours = number;
+export type number_days = number;
+export type number_weeks = number;
+export type number_months = number;
+export type number_years = number;
+export type number_bytes = number_positive & number_integer;
+export type number_kilobytes = number_positive;
+export type number_megabytes = number_positive;
+export type number_gigabytes = number_positive;
+export type number_terabytes = number_positive;
+/**
+ * TODO: !! Cleanup
+ * TODO: !! Change to branded types
+ */

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

@@ -0,0 +1,16 @@
+import { string_char_emoji } from '../types/typeAliasEmoji';
+/**
+ * All possible emoji chars like "🍆", "🍡", "🍤"...
+ * Note: this will be needed to update annually - now updated at 2022-01-19
+ *
+ * @see https://getemoji.com/
+ */
+export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
+/**
+ *
+ * All possible emoji chars like "🍆", "🍡", "🍤"...
+ */
+export declare const EMOJIS: Set<string_char_emoji>;
+/**
+ * TODO: Mirror from Collboard or some common library
+ */

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

@@ -0,0 +1,10 @@
+/**
+ * Returns the same value that is passed as argument.
+ * No side effects.
+ *
+ * Note: It can be usefull for leveling indentation
+ *
+ * @param value any values
+ * @returns the same values
+ */
+export declare function just<T>(value?: T): T;

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

@@ -0,0 +1,15 @@
+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
+ *
+ * @private within the library
+ */
+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/extractBlocksFromMarkdown.d.ts

@@ -0,0 +1,13 @@
+import { string_markdown } from '../.././types/typeAliases';
+/**
+ * Extracts all code blocks from markdown.
+ *
+ * @param markdown any valid markdown
+ * @returns code blocks with language and content
+ *
+ * @private within the library
+ */
+export declare function extractBlocksFromMarkdown(markdown: string_markdown): Array<{
+    language: string | null;
+    content: string;
+}>;

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

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

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

@@ -0,0 +1,16 @@
+import { string_markdown } from '../.././types/typeAliases';
+/**
+ * Extracts exactly ONE code block from markdown.
+ *
+ * Note: This function is similar to extractBlocksFromMarkdown but it validates that there is exactly one code block.
+ * Note: If there are multiple or no code blocks the function throws an error
+ *
+ * @param markdown any valid markdown
+ * @returns code block with language and content
+ *
+ * @private within the library
+ */
+export declare function extractOneBlockFromMarkdown(markdown: string_markdown): {
+    language: string | null;
+    content: string;
+};

package/esm/typings/utils/markdown/extractOneBlockFromMarkdown.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 interface 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/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/replaceParameters.d.ts

@@ -0,0 +1,16 @@
+import { string_template } from '.././types/typeAliases';
+import { Parameters } from '../types/Parameters';
+/**
+ * Replaces parameters in template with values from parameters object
+ *
+ * @param template the template with parameters in {curly} braces
+ * @param parameters the object with parameters
+ * @returns the template with replaced parameters
+ *
+ * @private within the library
+ */
+export declare function replaceParameters(template: string_template, parameters: Parameters): string;
+/**
+ * TODO: [🧠] More advanced templating
+ * TODO: [🧠] Maybe use some template engine / library not own simple implementation
+ */

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

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