@promptbook/remote-client 0.16.0 → 0.17.0

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.
@@ -1,3 +1,3 @@
1
- import { createRemoteServer } from '../execution/plugins/natural-execution-tools/remote/createRemoteServer';
2
1
  import { RemoteServerOptions } from '../execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions';
3
- export { createRemoteServer, RemoteServerOptions };
2
+ import { runRemoteServer } from '../execution/plugins/natural-execution-tools/remote/runRemoteServer';
3
+ export { RemoteServerOptions, runRemoteServer };
@@ -1,6 +1,11 @@
1
+ import { EMOJIS, EMOJIS_IN_CATEGORIES } from '../utils/emojis';
2
+ import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllListItemsFromMarkdown';
3
+ import { extractBlocksFromMarkdown } from '../utils/markdown/extractBlocksFromMarkdown';
4
+ import { extractOneBlockFromMarkdown } from '../utils/markdown/extractOneBlockFromMarkdown';
1
5
  import { removeContentComments } from '../utils/markdown/removeContentComments';
2
6
  import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
3
7
  import { removeEmojis } from '../utils/removeEmojis';
4
8
  import { removeQuotes } from '../utils/removeQuotes';
9
+ import { replaceParameters } from '../utils/replaceParameters';
5
10
  import { unwrapResult } from '../utils/unwrapResult';
6
- export { removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, unwrapResult };
11
+ export { EMOJIS, EMOJIS_IN_CATEGORIES, extractAllListItemsFromMarkdown, extractBlocksFromMarkdown, extractOneBlockFromMarkdown, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, unwrapResult, };
@@ -7,7 +7,7 @@ import { RemoteServerOptions } from './interfaces/RemoteServerOptions';
7
7
  *
8
8
  * @see https://github.com/webgptorg/promptbook#remote-server
9
9
  */
10
- export declare function createRemoteServer(options: RemoteServerOptions): void;
10
+ export declare function runRemoteServer(options: RemoteServerOptions): void;
11
11
  /**
12
12
  * TODO: !!! This should be name runRemoteServer OR startRemoteServer and return Destroyable OR Promise<Destroyable>
13
13
  * TODO: Handle progress - support streaming
@@ -1,5 +1,5 @@
1
1
  import { ExecutionType } from './ExecutionTypes';
2
- import { string_name, string_title } from './typeAliases';
2
+ import { string_markdown_text, string_name } from './typeAliases';
3
3
  /**
4
4
  * TaskProgress represents the progress of a PromptTemplatePipeline execution.
5
5
  */
@@ -17,7 +17,7 @@ export interface TaskProgress {
17
17
  * Note: This is supposed to be displayed to the user.
18
18
  * Note: This is trimmed and stripped of HTML tags and emojis
19
19
  */
20
- readonly title: string_title;
20
+ readonly title: string_markdown_text;
21
21
  /**
22
22
  * Does the task started?
23
23
  */
@@ -9,7 +9,5 @@ import { string_markdown, string_markdown_text } from '../.././types/typeAliases
9
9
  *
10
10
  * @param markdown any valid markdown
11
11
  * @returns
12
- *
13
- * @private within the library
14
12
  */
15
13
  export declare function extractAllListItemsFromMarkdown(markdown: string_markdown): string_markdown_text[];
@@ -4,8 +4,6 @@ import { string_markdown } from '../.././types/typeAliases';
4
4
  *
5
5
  * @param markdown any valid markdown
6
6
  * @returns code blocks with language and content
7
- *
8
- * @private within the library
9
7
  */
10
8
  export declare function extractBlocksFromMarkdown(markdown: string_markdown): Array<{
11
9
  language: string | null;
@@ -7,8 +7,6 @@ import { string_markdown } from '../.././types/typeAliases';
7
7
  *
8
8
  * @param markdown any valid markdown
9
9
  * @returns code block with language and content
10
- *
11
- * @private within the library
12
10
  */
13
11
  export declare function extractOneBlockFromMarkdown(markdown: string_markdown): {
14
12
  language: string | null;
@@ -6,8 +6,6 @@ import { Parameters } from '../types/Parameters';
6
6
  * @param template the template with parameters in {curly} braces
7
7
  * @param parameters the object with parameters
8
8
  * @returns the template with replaced parameters
9
- *
10
- * @private within the library
11
9
  */
12
10
  export declare function replaceParameters(template: string_template, parameters: Parameters): string;
13
11
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/remote-client",
3
- "version": "0.16.0",
3
+ "version": "0.17.0",
4
4
  "description": "Library to supercharge your use of large language models",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -37,7 +37,7 @@
37
37
  "socket.io-client": "4.7.2"
38
38
  },
39
39
  "peerDependencies": {
40
- "@promptbook/core": "0.16.0"
40
+ "@promptbook/core": "0.17.0"
41
41
  },
42
42
  "main": "./umd/index.umd.js",
43
43
  "module": "./esm/index.es.js",
@@ -1,3 +1,3 @@
1
- import { createRemoteServer } from '../execution/plugins/natural-execution-tools/remote/createRemoteServer';
2
1
  import { RemoteServerOptions } from '../execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions';
3
- export { createRemoteServer, RemoteServerOptions };
2
+ import { runRemoteServer } from '../execution/plugins/natural-execution-tools/remote/runRemoteServer';
3
+ export { RemoteServerOptions, runRemoteServer };
@@ -1,6 +1,11 @@
1
+ import { EMOJIS, EMOJIS_IN_CATEGORIES } from '../utils/emojis';
2
+ import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllListItemsFromMarkdown';
3
+ import { extractBlocksFromMarkdown } from '../utils/markdown/extractBlocksFromMarkdown';
4
+ import { extractOneBlockFromMarkdown } from '../utils/markdown/extractOneBlockFromMarkdown';
1
5
  import { removeContentComments } from '../utils/markdown/removeContentComments';
2
6
  import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
3
7
  import { removeEmojis } from '../utils/removeEmojis';
4
8
  import { removeQuotes } from '../utils/removeQuotes';
9
+ import { replaceParameters } from '../utils/replaceParameters';
5
10
  import { unwrapResult } from '../utils/unwrapResult';
6
- export { removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, unwrapResult };
11
+ export { EMOJIS, EMOJIS_IN_CATEGORIES, extractAllListItemsFromMarkdown, extractBlocksFromMarkdown, extractOneBlockFromMarkdown, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, unwrapResult, };
@@ -7,7 +7,7 @@ import { RemoteServerOptions } from './interfaces/RemoteServerOptions';
7
7
  *
8
8
  * @see https://github.com/webgptorg/promptbook#remote-server
9
9
  */
10
- export declare function createRemoteServer(options: RemoteServerOptions): void;
10
+ export declare function runRemoteServer(options: RemoteServerOptions): void;
11
11
  /**
12
12
  * TODO: !!! This should be name runRemoteServer OR startRemoteServer and return Destroyable OR Promise<Destroyable>
13
13
  * TODO: Handle progress - support streaming
@@ -1,5 +1,5 @@
1
1
  import { ExecutionType } from './ExecutionTypes';
2
- import { string_name, string_title } from './typeAliases';
2
+ import { string_markdown_text, string_name } from './typeAliases';
3
3
  /**
4
4
  * TaskProgress represents the progress of a PromptTemplatePipeline execution.
5
5
  */
@@ -17,7 +17,7 @@ export interface TaskProgress {
17
17
  * Note: This is supposed to be displayed to the user.
18
18
  * Note: This is trimmed and stripped of HTML tags and emojis
19
19
  */
20
- readonly title: string_title;
20
+ readonly title: string_markdown_text;
21
21
  /**
22
22
  * Does the task started?
23
23
  */
@@ -9,7 +9,5 @@ import { string_markdown, string_markdown_text } from '../.././types/typeAliases
9
9
  *
10
10
  * @param markdown any valid markdown
11
11
  * @returns
12
- *
13
- * @private within the library
14
12
  */
15
13
  export declare function extractAllListItemsFromMarkdown(markdown: string_markdown): string_markdown_text[];
@@ -4,8 +4,6 @@ import { string_markdown } from '../.././types/typeAliases';
4
4
  *
5
5
  * @param markdown any valid markdown
6
6
  * @returns code blocks with language and content
7
- *
8
- * @private within the library
9
7
  */
10
8
  export declare function extractBlocksFromMarkdown(markdown: string_markdown): Array<{
11
9
  language: string | null;
@@ -7,8 +7,6 @@ import { string_markdown } from '../.././types/typeAliases';
7
7
  *
8
8
  * @param markdown any valid markdown
9
9
  * @returns code block with language and content
10
- *
11
- * @private within the library
12
10
  */
13
11
  export declare function extractOneBlockFromMarkdown(markdown: string_markdown): {
14
12
  language: string | null;
@@ -6,8 +6,6 @@ import { Parameters } from '../types/Parameters';
6
6
  * @param template the template with parameters in {curly} braces
7
7
  * @param parameters the object with parameters
8
8
  * @returns the template with replaced parameters
9
- *
10
- * @private within the library
11
9
  */
12
10
  export declare function replaceParameters(template: string_template, parameters: Parameters): string;
13
11
  /**