@promptbook/remote-client 0.101.0-0 → 0.101.0-2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/esm/index.es.js +13 -1
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/typings/src/_packages/components.index.d.ts +12 -0
  4. package/esm/typings/src/book-components/Chat/Chat/Chat.d.ts +0 -5
  5. package/esm/typings/src/book-components/Chat/Chat/ChatProps.d.ts +8 -2
  6. package/esm/typings/src/book-components/Chat/Chat/constants.d.ts +8 -0
  7. package/esm/typings/src/book-components/Chat/examples/ChatMarkdownDemo.d.ts +16 -0
  8. package/esm/typings/src/book-components/Chat/utils/renderMarkdown.d.ts +21 -0
  9. package/esm/typings/src/book-components/Chat/utils/renderMarkdown.test.d.ts +1 -0
  10. package/esm/typings/src/book-components/icons/ArrowIcon.d.ts +9 -0
  11. package/esm/typings/src/book-components/icons/ResetIcon.d.ts +6 -0
  12. package/esm/typings/src/book-components/icons/SendIcon.d.ts +8 -0
  13. package/esm/typings/src/book-components/icons/TemplateIcon.d.ts +8 -0
  14. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +2 -0
  15. package/esm/typings/src/utils/markdown/humanizeAiText.d.ts +1 -0
  16. package/esm/typings/src/utils/markdown/humanizeAiTextEllipsis.d.ts +1 -0
  17. package/esm/typings/src/utils/markdown/humanizeAiTextEmdashed.d.ts +1 -0
  18. package/esm/typings/src/utils/markdown/humanizeAiTextQuotes.d.ts +1 -0
  19. package/esm/typings/src/utils/markdown/humanizeAiTextWhitespace.d.ts +1 -0
  20. package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +8 -0
  21. package/esm/typings/src/utils/markdown/promptbookifyAiText.d.ts +1 -0
  22. package/esm/typings/src/utils/normalization/capitalize.d.ts +2 -0
  23. package/esm/typings/src/utils/normalization/decapitalize.d.ts +3 -1
  24. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +2 -0
  25. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +2 -0
  26. package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts +2 -0
  27. package/esm/typings/src/utils/normalization/removeDiacritics.d.ts +2 -0
  28. package/esm/typings/src/utils/parseNumber.d.ts +1 -0
  29. package/esm/typings/src/utils/removeEmojis.d.ts +2 -0
  30. package/esm/typings/src/utils/removeQuotes.d.ts +1 -0
  31. package/esm/typings/src/utils/serialization/deepClone.d.ts +1 -0
  32. package/esm/typings/src/utils/trimCodeBlock.d.ts +1 -0
  33. package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +1 -0
  34. package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +2 -0
  35. package/esm/typings/src/version.d.ts +1 -1
  36. package/package.json +2 -2
  37. package/umd/index.umd.js +13 -1
  38. package/umd/index.umd.js.map +1 -1
@@ -16,6 +16,12 @@ import { LlmChat } from '../book-components/Chat/LlmChat/LlmChat';
16
16
  import type { LlmChatProps } from '../book-components/Chat/LlmChat/LlmChatProps';
17
17
  import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
18
18
  import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
19
+ import { renderMarkdown } from '../book-components/Chat/utils/renderMarkdown';
20
+ import { isMarkdownContent } from '../book-components/Chat/utils/renderMarkdown';
21
+ import { ArrowIcon } from '../book-components/icons/ArrowIcon';
22
+ import { ResetIcon } from '../book-components/icons/ResetIcon';
23
+ import { SendIcon } from '../book-components/icons/SendIcon';
24
+ import { TemplateIcon } from '../book-components/icons/TemplateIcon';
19
25
  export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
20
26
  export type { AvatarChipProps };
21
27
  export { AvatarChip };
@@ -34,3 +40,9 @@ export { LlmChat };
34
40
  export type { LlmChatProps };
35
41
  export type { ChatMessage };
36
42
  export type { ChatParticipant };
43
+ export { renderMarkdown };
44
+ export { isMarkdownContent };
45
+ export { ArrowIcon };
46
+ export { ResetIcon };
47
+ export { SendIcon };
48
+ export { TemplateIcon };
@@ -1,9 +1,4 @@
1
1
  import type { ChatProps } from './ChatProps';
2
- /**
3
- * @deprecated use `isComplete` instead
4
- * @private util of `<Chat />`
5
- */
6
- export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
7
2
  /**
8
3
  * Renders a chat with messages and input for new messages
9
4
  *
@@ -23,10 +23,16 @@ export type ChatProps = {
23
23
  * Called when user sends a message
24
24
  *
25
25
  * Note: You must handle the message yourself and add it to the `messages` array
26
+ *
27
+ * - When set, the send textarea and button will be shown
28
+ * - When undefined, the chat has no input and is read-only showing only the messages
26
29
  */
27
- onMessage(messageContent: string): Promisable<void>;
30
+ onMessage?(messageContent: string): Promisable<void>;
28
31
  /**
29
- * Optional callback, when set, button for resetting chat will be shown
32
+ * Optional callback
33
+ *
34
+ * - When set, button for resetting chat will be shown
35
+ * - When undefined, no reset button will be shown
30
36
  */
31
37
  onReset?(): Promisable<void>;
32
38
  /**
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @deprecated use `isComplete` instead
3
+ * @private util of `<Chat />`
4
+ */
5
+ export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
6
+ /**
7
+ * Note: [💞] Ignore a discrepancy between file name and entity name
8
+ */
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Demo component showing Chat with markdown rendering capabilities
3
+ *
4
+ * This example demonstrates various markdown features supported by the Chat component:
5
+ * - Headers
6
+ * - Bold and italic text
7
+ * - Code blocks and inline code
8
+ * - Lists (ordered and unordered)
9
+ * - Links
10
+ * - Blockquotes
11
+ * - Tables
12
+ * - Strikethrough text
13
+ *
14
+ * @private temporary for testing purposes
15
+ */
16
+ export declare function ChatMarkdownDemo(): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,21 @@
1
+ import type { string_html, string_markdown } from '../../../types/typeAliases';
2
+ /**
3
+ * Convert markdown content to HTML for display in chat messages
4
+ *
5
+ * @param markdown - The markdown content to convert
6
+ * @returns HTML string ready for rendering
7
+ *
8
+ * @public exported from `@promptbook/components`
9
+ * <- TODO: [🧠] Maybe export from `@promptbook/markdown-utils`
10
+ */
11
+ export declare function renderMarkdown(markdown: string_markdown): string_html;
12
+ /**
13
+ * Check if content appears to be markdown (contains markdown syntax)
14
+ *
15
+ * @param content - Content to check
16
+ * @returns true if content appears to contain markdown syntax
17
+ *
18
+ * @public exported from `@promptbook/components`
19
+ * <- TODO: [🧠] Maybe export from `@promptbook/markdown-utils`
20
+ */
21
+ export declare function isMarkdownContent(content: string): boolean;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Shows simple arrow icon pointing up or down
3
+ *
4
+ * @public exported from `@promptbook/components`
5
+ */
6
+ export declare const ArrowIcon: ({ direction, size }: {
7
+ direction: string;
8
+ size: number;
9
+ }) => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Shows simple reset icon
3
+ *
4
+ * @public exported from `@promptbook/components`
5
+ */
6
+ export declare const ResetIcon: () => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Shows simple send icon
3
+ *
4
+ * @public exported from `@promptbook/components`
5
+ */
6
+ export declare const SendIcon: ({ size }: {
7
+ size: number;
8
+ }) => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Shows simple template icon
3
+ *
4
+ * @public exported from `@promptbook/components`
5
+ */
6
+ export declare const TemplateIcon: ({ size }: {
7
+ size: number;
8
+ }) => import("react/jsx-runtime").JSX.Element;
@@ -3,6 +3,8 @@ import type { string_markdown_text } from '../../types/typeAliases';
3
3
  * Function escapeMarkdownBlock will escape markdown block if needed
4
4
  * It is useful when you want have block in block
5
5
  *
6
+ * Note: [🔂] This function is idempotent.
7
+ *
6
8
  * @public exported from `@promptbook/markdown-utils`
7
9
  */
8
10
  export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;
@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
2
2
  /**
3
3
  * Function `humanizeAiText` will remove traces of AI text generation artifacts
4
4
  *
5
+ * Note: [🔂] This function is idempotent.
5
6
  * Tip: If you want more control, look for other functions for example `humanizeAiTextEmdashed` exported `@promptbook/markdown-utils`
6
7
  *
7
8
  * @public exported from `@promptbook/markdown-utils`
@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
2
2
  /**
3
3
  * Change ellipsis character to three dots `…` -> `...`
4
4
  *
5
+ * Note: [🔂] This function is idempotent.
5
6
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
6
7
  *
7
8
  * @public exported from `@promptbook/markdown-utils`
@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
2
2
  /**
3
3
  * Change em-dashes to regular dashes `—` -> `-`
4
4
  *
5
+ * Note: [🔂] This function is idempotent.
5
6
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
6
7
  *
7
8
  * @public exported from `@promptbook/markdown-utils`
@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
2
2
  /**
3
3
  * Change smart quotes to regular quotes
4
4
  *
5
+ * Note: [🔂] This function is idempotent.
5
6
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
6
7
  *
7
8
  * @public exported from `@promptbook/markdown-utils`
@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
2
2
  /**
3
3
  * Change unprintable hard spaces to regular spaces
4
4
  *
5
+ * Note: [🔂] This function is idempotent.
5
6
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
6
7
  *
7
8
  * @public exported from `@promptbook/markdown-utils`
@@ -7,3 +7,11 @@ import type { string_html } from '../../types/typeAliases';
7
7
  * @private withing the package because of HUGE size of prettier dependency
8
8
  */
9
9
  export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;
10
+ /**
11
+ * Async version of prettifyMarkdown using dynamic imports
12
+ *
13
+ * @param content raw html code
14
+ * @returns formatted html code
15
+ * @private withing the package because of HUGE size of prettier dependency
16
+ */
17
+ export declare function prettifyMarkdownAsync<TContent extends string_html>(content: TContent): Promise<TContent>;
@@ -6,6 +6,7 @@ import { string_markdown } from '../../types/typeAliases';
6
6
  */
7
7
  export declare function promptbookifyAiText(text: string_markdown): string_markdown;
8
8
  /**
9
+ * TODO: !!!!! Make the function idempotent and add "Note: [🔂] This function is idempotent."
9
10
  * TODO: [🅾️]!!! Use this across the project where AI text is involved
10
11
  * TODO: [🧠][✌️] Make some Promptbook-native token system
11
12
  */
@@ -1,6 +1,8 @@
1
1
  /**
2
2
  * Makes first letter of a string uppercase
3
3
  *
4
+ * Note: [🔂] This function is idempotent.
5
+ *
4
6
  * @public exported from `@promptbook/utils`
5
7
  */
6
8
  export declare function capitalize(word: string): string;
@@ -1,5 +1,7 @@
1
1
  /**
2
- * Makes first letter of a string uppercase
2
+ * Makes first letter of a string lowercase
3
+ *
4
+ * Note: [🔂] This function is idempotent.
3
5
  *
4
6
  * @public exported from `@promptbook/utils`
5
7
  */
@@ -9,6 +9,8 @@ export type string_SCREAMING_CASE = string;
9
9
  /**
10
10
  * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
11
11
  *
12
+ * Note: [🔂] This function is idempotent.
13
+ *
12
14
  * @param text The text string to be converted to SCREAMING_CASE format.
13
15
  * @returns The normalized text in SCREAMING_CASE format.
14
16
  * @example 'HELLO_WORLD'
@@ -8,6 +8,8 @@ export type string_snake_case = string;
8
8
  /**
9
9
  * Normalizes a text string to snake_case format.
10
10
  *
11
+ * Note: [🔂] This function is idempotent.
12
+ *
11
13
  * @param text The text string to be converted to snake_case format.
12
14
  * @returns The normalized text in snake_case format.
13
15
  * @example 'hello_world'
@@ -1,6 +1,8 @@
1
1
  /**
2
2
  * Take every whitespace (space, new line, tab) and replace it with a single space
3
3
  *
4
+ * Note: [🔂] This function is idempotent.
5
+ *
4
6
  * @public exported from `@promptbook/utils`
5
7
  */
6
8
  export declare function normalizeWhitespaces(sentence: string): string;
@@ -1,6 +1,8 @@
1
1
  /**
2
2
  * Removes diacritic marks (accents) from characters in a string.
3
3
  *
4
+ * Note: [🔂] This function is idempotent.
5
+ *
4
6
  * @param input The string containing diacritics to be normalized.
5
7
  * @returns The string with diacritics removed or normalized.
6
8
  * @public exported from `@promptbook/utils`
@@ -1,6 +1,7 @@
1
1
  /**
2
2
  * Function parseNumber will parse number from string
3
3
  *
4
+ * Note: [🔂] This function is idempotent.
4
5
  * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
5
6
  * Note: it also works only with decimal numbers
6
7
  *
@@ -1,6 +1,8 @@
1
1
  /**
2
2
  * Removes emojis from a string and fix whitespaces
3
3
  *
4
+ * Note: [🔂] This function is idempotent.
5
+ *
4
6
  * @param text with emojis
5
7
  * @returns text without emojis
6
8
  * @public exported from `@promptbook/utils`
@@ -1,6 +1,7 @@
1
1
  /**
2
2
  * Removes quotes from a string
3
3
  *
4
+ * Note: [🔂] This function is idempotent.
4
5
  * Tip: This is very useful for post-processing of the result of the LLM model
5
6
  * Note: This function removes only the same quotes from the beginning and the end of the string
6
7
  * Note: There are two similar functions:
@@ -2,6 +2,7 @@ import type { WritableDeep } from 'type-fest';
2
2
  /**
3
3
  * Creates a deep clone of the given object
4
4
  *
5
+ * Note: [🔂] This function is idempotent.
5
6
  * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
6
7
  *
7
8
  * @param objectValue The object to clone.
@@ -1,6 +1,7 @@
1
1
  /**
2
2
  * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
3
3
  *
4
+ * Note: [🔂] This function is idempotent.
4
5
  * Note: This is useful for post-processing of the result of the chat LLM model
5
6
  * when the model wraps the result in the (markdown) code block.
6
7
  *
@@ -3,6 +3,7 @@ import type { really_unknown } from '../../organization/really_unknown';
3
3
  /**
4
4
  * Tests if given string is valid URL.
5
5
  *
6
+ * Note: [🔂] This function is idempotent.
6
7
  * Note: Dataurl are considered perfectly valid.
7
8
  * Note: There are two similar functions:
8
9
  * - `isValidUrl` which tests any URL
@@ -3,6 +3,8 @@ import type { really_unknown } from '../../organization/really_unknown';
3
3
  /**
4
4
  * Checks if value is valid uuid
5
5
  *
6
+ * Note: [🔂] This function is idempotent.
7
+ *
6
8
  * @public exported from `@promptbook/utils`
7
9
  */
8
10
  export declare function isValidUuid(value: really_unknown): value is string_uuid;
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.100.4-0`).
18
+ * It follows semantic versioning (e.g., `0.101.0-1`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/remote-client",
3
- "version": "0.101.0-0",
3
+ "version": "0.101.0-2",
4
4
  "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -100,7 +100,7 @@
100
100
  "module": "./esm/index.es.js",
101
101
  "typings": "./esm/typings/src/_packages/remote-client.index.d.ts",
102
102
  "peerDependencies": {
103
- "@promptbook/core": "0.101.0-0"
103
+ "@promptbook/core": "0.101.0-2"
104
104
  },
105
105
  "dependencies": {
106
106
  "crypto": "1.0.1",
package/umd/index.umd.js CHANGED
@@ -23,7 +23,7 @@
23
23
  * @generated
24
24
  * @see https://github.com/webgptorg/promptbook
25
25
  */
26
- const PROMPTBOOK_ENGINE_VERSION = '0.101.0-0';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.101.0-2';
27
27
  /**
28
28
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
29
29
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -565,6 +565,7 @@
565
565
  /**
566
566
  * Tests if given string is valid URL.
567
567
  *
568
+ * Note: [🔂] This function is idempotent.
568
569
  * Note: Dataurl are considered perfectly valid.
569
570
  * Note: There are two similar functions:
570
571
  * - `isValidUrl` which tests any URL
@@ -1012,6 +1013,8 @@
1012
1013
  /**
1013
1014
  * Removes diacritic marks (accents) from characters in a string.
1014
1015
  *
1016
+ * Note: [🔂] This function is idempotent.
1017
+ *
1015
1018
  * @param input The string containing diacritics to be normalized.
1016
1019
  * @returns The string with diacritics removed or normalized.
1017
1020
  * @public exported from `@promptbook/utils`
@@ -1634,6 +1637,7 @@
1634
1637
  /**
1635
1638
  * Function parseNumber will parse number from string
1636
1639
  *
1640
+ * Note: [🔂] This function is idempotent.
1637
1641
  * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
1638
1642
  * Note: it also works only with decimal numbers
1639
1643
  *
@@ -2160,6 +2164,8 @@
2160
2164
  /**
2161
2165
  * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
2162
2166
  *
2167
+ * Note: [🔂] This function is idempotent.
2168
+ *
2163
2169
  * @param text The text string to be converted to SCREAMING_CASE format.
2164
2170
  * @returns The normalized text in SCREAMING_CASE format.
2165
2171
  * @example 'HELLO_WORLD'
@@ -2395,6 +2401,7 @@
2395
2401
  /**
2396
2402
  * Creates a deep clone of the given object
2397
2403
  *
2404
+ * Note: [🔂] This function is idempotent.
2398
2405
  * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
2399
2406
  *
2400
2407
  * @param objectValue The object to clone.
@@ -2552,6 +2559,8 @@
2552
2559
  /**
2553
2560
  * Removes emojis from a string and fix whitespaces
2554
2561
  *
2562
+ * Note: [🔂] This function is idempotent.
2563
+ *
2555
2564
  * @param text with emojis
2556
2565
  * @returns text without emojis
2557
2566
  * @public exported from `@promptbook/utils`
@@ -2568,6 +2577,7 @@
2568
2577
  /**
2569
2578
  * Removes quotes from a string
2570
2579
  *
2580
+ * Note: [🔂] This function is idempotent.
2571
2581
  * Tip: This is very useful for post-processing of the result of the LLM model
2572
2582
  * Note: This function removes only the same quotes from the beginning and the end of the string
2573
2583
  * Note: There are two similar functions:
@@ -4756,6 +4766,8 @@
4756
4766
  /**
4757
4767
  * Makes first letter of a string uppercase
4758
4768
  *
4769
+ * Note: [🔂] This function is idempotent.
4770
+ *
4759
4771
  * @public exported from `@promptbook/utils`
4760
4772
  */
4761
4773
  function capitalize(word) {