@promptbook/utils 0.46.0 → 0.47.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.
Files changed (74) hide show
  1. package/README.md +18 -8
  2. package/esm/index.es.js +53 -39
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/_packages/langtail.index.d.ts +2 -2
  5. package/esm/typings/_packages/mock.index.d.ts +3 -3
  6. package/esm/typings/_packages/openai.index.d.ts +2 -2
  7. package/esm/typings/_packages/remote-client.index.d.ts +4 -4
  8. package/esm/typings/_packages/remote-server.index.d.ts +2 -2
  9. package/esm/typings/_packages/types.index.d.ts +2 -2
  10. package/esm/typings/_packages/utils.index.d.ts +2 -0
  11. package/esm/typings/conversion/prettify/PrettifyOptions.d.ts +9 -3
  12. package/esm/typings/conversion/prettify/prettifyPromptbookString.d.ts +1 -1
  13. package/esm/typings/conversion/prettify/renderPromptbookMermaid.d.ts +11 -0
  14. package/esm/typings/execution/ExecutionTools.d.ts +5 -2
  15. package/esm/typings/execution/{NaturalExecutionTools.d.ts → LlmExecutionTools.d.ts} +2 -2
  16. package/{umd/typings/execution/plugins/natural-execution-tools → esm/typings/execution/plugins/llm-execution-tools}/langtail/LangtailExecutionTools.d.ts +2 -2
  17. package/{umd/typings/execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools.d.ts → esm/typings/execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools.d.ts} +2 -2
  18. package/{umd/typings/execution/plugins/natural-execution-tools/mocked/MockedFackedNaturalExecutionTools.d.ts → esm/typings/execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools.d.ts} +2 -2
  19. package/{umd/typings/execution/plugins/natural-execution-tools → esm/typings/execution/plugins/llm-execution-tools}/mocked/fakeTextToExpectations.d.ts +1 -1
  20. package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/openai/OpenAiExecutionTools.d.ts +2 -2
  21. package/esm/typings/execution/plugins/{natural-execution-tools/remote/RemoteNaturalExecutionTools.d.ts → llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts} +5 -5
  22. package/esm/typings/execution/plugins/{natural-execution-tools/remote/RemoteNaturalExecutionToolsOptions.d.ts → llm-execution-tools/remote/RemoteLlmExecutionToolsOptions.d.ts} +3 -3
  23. package/{umd/typings/execution/plugins/natural-execution-tools → esm/typings/execution/plugins/llm-execution-tools}/remote/interfaces/RemoteServerOptions.d.ts +3 -3
  24. package/esm/typings/types/PromptbookJson/PromptTemplateJson.d.ts +2 -2
  25. package/package.json +13 -3
  26. package/umd/index.umd.js +53 -38
  27. package/umd/index.umd.js.map +1 -1
  28. package/umd/typings/_packages/langtail.index.d.ts +2 -2
  29. package/umd/typings/_packages/mock.index.d.ts +3 -3
  30. package/umd/typings/_packages/openai.index.d.ts +2 -2
  31. package/umd/typings/_packages/remote-client.index.d.ts +4 -4
  32. package/umd/typings/_packages/remote-server.index.d.ts +2 -2
  33. package/umd/typings/_packages/types.index.d.ts +2 -2
  34. package/umd/typings/_packages/utils.index.d.ts +2 -0
  35. package/umd/typings/conversion/prettify/PrettifyOptions.d.ts +9 -3
  36. package/umd/typings/conversion/prettify/prettifyPromptbookString.d.ts +1 -1
  37. package/umd/typings/conversion/prettify/renderPromptbookMermaid.d.ts +11 -0
  38. package/umd/typings/execution/ExecutionTools.d.ts +5 -2
  39. package/umd/typings/execution/{NaturalExecutionTools.d.ts → LlmExecutionTools.d.ts} +2 -2
  40. package/{esm/typings/execution/plugins/natural-execution-tools → umd/typings/execution/plugins/llm-execution-tools}/langtail/LangtailExecutionTools.d.ts +2 -2
  41. package/{esm/typings/execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools.d.ts → umd/typings/execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools.d.ts} +2 -2
  42. package/{esm/typings/execution/plugins/natural-execution-tools/mocked/MockedFackedNaturalExecutionTools.d.ts → umd/typings/execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools.d.ts} +2 -2
  43. package/{esm/typings/execution/plugins/natural-execution-tools → umd/typings/execution/plugins/llm-execution-tools}/mocked/fakeTextToExpectations.d.ts +1 -1
  44. package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/openai/OpenAiExecutionTools.d.ts +2 -2
  45. package/umd/typings/execution/plugins/{natural-execution-tools/remote/RemoteNaturalExecutionTools.d.ts → llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts} +5 -5
  46. package/umd/typings/execution/plugins/{natural-execution-tools/remote/RemoteNaturalExecutionToolsOptions.d.ts → llm-execution-tools/remote/RemoteLlmExecutionToolsOptions.d.ts} +3 -3
  47. package/{esm/typings/execution/plugins/natural-execution-tools → umd/typings/execution/plugins/llm-execution-tools}/remote/interfaces/RemoteServerOptions.d.ts +3 -3
  48. package/umd/typings/types/PromptbookJson/PromptTemplateJson.d.ts +2 -2
  49. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/langtail/LangtailExecutionToolsOptions.d.ts +0 -0
  50. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/mocked/fakeTextToExpectations.test.d.ts +0 -0
  51. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/mocked/faked-completion.test.d.ts +0 -0
  52. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/mocked/joker.test.d.ts +0 -0
  53. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/mocked/mocked-chat.test.d.ts +0 -0
  54. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/mocked/mocked-completion.test.d.ts +0 -0
  55. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/openai/OpenAiExecutionToolsOptions.d.ts +0 -0
  56. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/openai/computeOpenaiUsage.d.ts +0 -0
  57. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/remote/interfaces/Promptbook_Server_Error.d.ts +0 -0
  58. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/remote/interfaces/Promptbook_Server_Progress.d.ts +0 -0
  59. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/remote/interfaces/Promptbook_Server_Request.d.ts +0 -0
  60. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/remote/interfaces/Promptbook_Server_Response.d.ts +0 -0
  61. /package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/remote/startRemoteServer.d.ts +0 -0
  62. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/langtail/LangtailExecutionToolsOptions.d.ts +0 -0
  63. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/mocked/fakeTextToExpectations.test.d.ts +0 -0
  64. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/mocked/faked-completion.test.d.ts +0 -0
  65. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/mocked/joker.test.d.ts +0 -0
  66. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/mocked/mocked-chat.test.d.ts +0 -0
  67. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/mocked/mocked-completion.test.d.ts +0 -0
  68. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/openai/OpenAiExecutionToolsOptions.d.ts +0 -0
  69. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/openai/computeOpenaiUsage.d.ts +0 -0
  70. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/remote/interfaces/Promptbook_Server_Error.d.ts +0 -0
  71. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/remote/interfaces/Promptbook_Server_Progress.d.ts +0 -0
  72. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/remote/interfaces/Promptbook_Server_Request.d.ts +0 -0
  73. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/remote/interfaces/Promptbook_Server_Response.d.ts +0 -0
  74. /package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/remote/startRemoteServer.d.ts +0 -0
@@ -1,11 +1,11 @@
1
1
  import type { Prompt } from '../../../../types/Prompt';
2
- import type { NaturalExecutionTools } from '../../../NaturalExecutionTools';
2
+ import type { LlmExecutionTools } from '../../../LlmExecutionTools';
3
3
  import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
4
4
  import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
5
5
  /**
6
6
  * Execution Tools for calling OpenAI API.
7
7
  */
8
- export declare class OpenAiExecutionTools implements NaturalExecutionTools {
8
+ export declare class OpenAiExecutionTools implements LlmExecutionTools {
9
9
  private readonly options;
10
10
  /**
11
11
  * OpenAI API client.
@@ -1,7 +1,7 @@
1
1
  import { Prompt } from '../../../../types/Prompt';
2
- import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
2
+ import { LlmExecutionTools } from '../../../LlmExecutionTools';
3
3
  import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
4
- import { RemoteNaturalExecutionToolsOptions } from './RemoteNaturalExecutionToolsOptions';
4
+ import { RemoteLlmExecutionToolsOptions } from './RemoteLlmExecutionToolsOptions';
5
5
  /**
6
6
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
7
7
  *
@@ -10,9 +10,9 @@ import { RemoteNaturalExecutionToolsOptions } from './RemoteNaturalExecutionTool
10
10
  *
11
11
  * @see https://github.com/webgptorg/promptbook#remote-server
12
12
  */
13
- export declare class RemoteNaturalExecutionTools implements NaturalExecutionTools {
13
+ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
14
14
  private readonly options;
15
- constructor(options: RemoteNaturalExecutionToolsOptions);
15
+ constructor(options: RemoteLlmExecutionToolsOptions);
16
16
  /**
17
17
  * Creates a connection to the remote proxy server.
18
18
  */
@@ -31,5 +31,5 @@ export declare class RemoteNaturalExecutionTools implements NaturalExecutionTool
31
31
  private gptCommon;
32
32
  }
33
33
  /**
34
- * TODO: [🤹‍♂️] RemoteNaturalExecutionTools should extend Destroyable and implement IDestroyable
34
+ * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
35
35
  */
@@ -1,9 +1,9 @@
1
- import type { client_id, string_uri } from '../../../.././types/typeAliases';
1
+ import type { client_id, string_uri } from '../../../../types/typeAliases';
2
2
  import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
3
3
  /**
4
- * Options for RemoteNaturalExecutionTools
4
+ * Options for RemoteLlmExecutionTools
5
5
  */
6
- export type RemoteNaturalExecutionToolsOptions = CommonExecutionToolsOptions & {
6
+ export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
7
7
  /**
8
8
  * URL of the remote PROMPTBOOK server
9
9
  * On this server will be connected to the socket.io server
@@ -1,7 +1,7 @@
1
1
  import type { PromptbookLibrary } from '../../../../../library/PromptbookLibrary';
2
2
  import type { client_id, string_uri } from '../../../../../types/typeAliases';
3
3
  import type { CommonExecutionToolsOptions } from '../../../../CommonExecutionToolsOptions';
4
- import type { NaturalExecutionTools } from '../../../../NaturalExecutionTools';
4
+ import type { LlmExecutionTools } from '../../../../LlmExecutionTools';
5
5
  export type RemoteServerOptions = CommonExecutionToolsOptions & {
6
6
  /**
7
7
  * Port on which the server will listen
@@ -21,7 +21,7 @@ export type RemoteServerOptions = CommonExecutionToolsOptions & {
21
21
  */
22
22
  readonly library: PromptbookLibrary;
23
23
  /**
24
- * Creates natural execution tools for each client
24
+ * Creates llm execution tools for each client
25
25
  */
26
- createNaturalExecutionTools(clientId: client_id): NaturalExecutionTools;
26
+ createLlmExecutionTools(clientId: client_id): LlmExecutionTools;
27
27
  };
@@ -6,11 +6,11 @@ import type { number_integer, number_positive_or_zero, string_javascript, string
6
6
  /**
7
7
  * Describes one prompt template in the promptbook
8
8
  */
9
- export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | ScriptTemplateJson | PromptDialogJson;
9
+ export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptTemplateJson | PromptDialogJson;
10
10
  /**
11
11
  * Template for prompt to LLM
12
12
  */
13
- export type NaturalTemplateJson = PromptTemplateJsonCommon & {
13
+ export type LlmTemplateJson = PromptTemplateJsonCommon & {
14
14
  readonly executionType: 'PROMPT_TEMPLATE';
15
15
  /**
16
16
  * Requirements for the model