@promptbook/markdown-utils 0.61.0-10

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

@@ -0,0 +1,494 @@
+/**
+ * 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 `"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;
+/**
+ * Description of persona
+ *
+ * For example `"Skilled copywriter"`
+ */
+export type string_persona_description = string;
+/**
+ * Source of one knowledge
+ *
+ * It can be a link, a relative path to file or direct text
+ *
+ * For example `"https://pavolhejny.com/"`
+ * For example `"./pavol-hejny-cv.pdf"`
+ * For example `"Pavol Hejný has web https://pavolhejny.com/"`
+ * For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
+ */
+export type string_knowledge_source = string_url | string_file_path | 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 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. is allowed
+ *
+ * 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://promptbook.studio/webgpt/write-website-content-cs.ptbk.md"`
+ */
+export type string_pipeline_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords"`
+ */
+export type string_pipeline_url_with_hashtemplate = string;
+/**
+ * Semantic helper
+ *
+ * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
+ */
+export type string_data_url = `data:${string_mime_type};base64,${string_base64}`;
+/**
+ * Semantic helper
+ *
+ * For example `"SGVsbG8sIFdvcmxkIQ=="`
+ */
+export type string_base64 = 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
+ *
+ * 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
+ */
+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
+ */
+export type client_id = string & {
+    readonly _type: 'client_id';
+};
+/**
+ * Semantic helper
+ *
+ * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
+ */
+export type string_sha256 = string;
+/**
+ * Semantic helper
+ *
+ * For example `"4.2.4"`
+ */
+export type string_semantic_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;
+/**
+ * Semantic helper
+ *
+ * For example `"MIT"`
+ */
+export type string_license = string;
+/**
+ * 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
+ */
+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;
+/**
+ * Semantic helper for `Date.toISOString()` result
+ *
+ * @example "2011-10-05T14:48:00.000Z".
+ * @see https://en.wikipedia.org/wiki/ISO_8601
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
+ */
+export type string_date_iso8601 = `${number}-${number}-${number}${string}${number}:${number}:${number}${string}`;
+/**
+ * Semantic helper for US Dollars
+ */
+export type number_usd = number;
+/**
+ * Semantic helper for incremental IDs
+ */
+export type number_id = number_integer & (number_positive | 0);
+/**
+ * Semantic helper for number of rows and columns
+ */
+export type number_linecol_number = number_integer & number_positive;
+/**
+ * Semantic helper for number of tokens
+ */
+export type number_tokens = number_integer & (number_positive | 0);
+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_integer & number_positive;
+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: !!! Change "For example" to @example
+ * TODO: !! Cleanup
+ * TODO: !! Change to branded types
+ */

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

@@ -0,0 +1,19 @@
+/**
+ * Represents items which are compared to each other
+ */
+export type FromtoItems = Array<{
+    /**
+     * The title of the item
+     */
+    readonly title: string;
+    /**
+     * The start of the item
+     *
+     * This can mean anything, like seconds, milliseconds, dollars, etc.
+     */
+    readonly from: number;
+    /**
+     * The end of the item
+     */
+    readonly to: number;
+}>;

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/currentDate.d.ts

@@ -0,0 +1,7 @@
+import type { string_date_iso8601 } from '../types/typeAliases';
+/**
+ * Simple wrapper `new Date().toISOString()`
+ *
+ * @returns string_date branded type
+ */
+export declare function $currentDate(): string_date_iso8601;

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

@@ -0,0 +1,23 @@
+import type { 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/
+ *
+ * @private within the package
+ * @deprecated Use /\p{Extended_Pictographic}/ instead
+ */
+export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
+/**
+ *
+ * All possible emoji chars like "🍆", "🍡", "🍤"...
+ *
+ * @private within the package
+ * @deprecated Use /\p{Extended_Pictographic}/ instead
+ */
+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

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of characters in the text
+ */
+export declare function countCharacters(text: string): ExpectationAmount;

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

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

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

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of lines in the text
+ */
+export declare function countLines(text: string): ExpectationAmount;

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

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

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

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of pages in the text
+ */
+export declare function countPages(text: string): ExpectationAmount;

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

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

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

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of paragraphs in the text
+ */
+export declare function countParagraphs(text: string): ExpectationAmount;

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

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

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

@@ -0,0 +1,9 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Split text into sentences
+ */
+export declare function splitIntoSentences(text: string): Array<string>;
+/**
+ * Counts number of sentences in the text
+ */
+export declare function countSentences(text: string): ExpectationAmount;

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

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

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

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of words in the text
+ */
+export declare function countWords(text: string): ExpectationAmount;

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

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

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

@@ -0,0 +1,6 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
+/**
+ * Index of all counter functions
+ */
+export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;

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

@@ -0,0 +1,9 @@
+import type { string_name } from '../types/typeAliases';
+import type { string_template } from '../types/typeAliases';
+/**
+ * Parses the template and returns the list of all parameter names
+ *
+ * @param template the template with parameters in {curly} braces
+ * @returns the list of parameter names
+ */
+export declare function extractParameters(template: string_template): Set<string_name>;

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

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

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

@@ -0,0 +1,6 @@
+/**
+ * Format either small or big number
+ *
+ * @private within the package
+ */
+export declare function formatNumber(value: number): string;

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

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

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

@@ -0,0 +1,7 @@
+import type { string_date_iso8601 } from '../types/typeAliases';
+/**
+ * Get current date in ISO 8601 format
+ *
+ * @private This is internal util of the promptbook
+ */
+export declare function getCurrentIsoDate(): string_date_iso8601;

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

@@ -0,0 +1,12 @@
+/**
+ * Detects if the code is running in a browser environment in main thread (Not in a web worker)
+ */
+export declare const isRunningInBrowser: Function;
+/**
+ * Detects if the code is running in a Node.js environment
+ */
+export declare const isRunningInNode: Function;
+/**
+ * Detects if the code is running in a web worker
+ */
+export declare const isRunningInWebWorker: Function;

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

@@ -0,0 +1,11 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Add or modify an auto-generated section in a markdown file
+ *
+ * @private within the package
+ */
+export declare function addAutoGeneratedSection(content: string_markdown, options: {
+    readonly sectionName: string_name;
+    readonly sectionContent: string_markdown;
+}): string_markdown;