@promptbook/remote-client 0.61.0-11 → 0.61.0-13

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 (157) hide show
  1. package/esm/index.es.js +1 -1
  2. package/esm/typings/src/_packages/execute-javascript.index.d.ts +1 -1
  3. package/esm/typings/src/_packages/utils.index.d.ts +1 -1
  4. package/esm/typings/src/cli/cli-commands/hello.d.ts +3 -0
  5. package/esm/typings/src/cli/cli-commands/make.d.ts +3 -0
  6. package/esm/typings/src/cli/cli-commands/prettify.d.ts +3 -0
  7. package/esm/typings/src/cli/promptbookCli.d.ts +1 -0
  8. package/esm/typings/src/collection/PipelineCollection.d.ts +1 -1
  9. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +1 -1
  10. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +1 -0
  11. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -0
  12. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +1 -1
  13. package/esm/typings/src/config.d.ts +1 -1
  14. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +1 -1
  15. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +4 -2
  16. package/esm/typings/src/errors/LimitReachedError.d.ts +7 -0
  17. package/esm/typings/src/execution/CommonExecutionToolsOptions.d.ts +1 -0
  18. package/esm/typings/src/execution/utils/addUsage.d.ts +57 -1
  19. package/esm/typings/src/formats/csv/ListFormatDefinition.d.ts +1 -0
  20. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +1 -0
  21. package/esm/typings/src/formats/list/ListFormatDefinition.d.ts +1 -0
  22. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +1 -0
  23. package/esm/typings/src/knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +3 -0
  24. package/esm/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.d.ts +1 -1
  25. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +1 -0
  26. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +1 -0
  27. package/{umd/typings/src/llm-providers/utils → esm/typings/src/llm-providers/_common}/createLlmToolsFromEnv.d.ts +3 -2
  28. package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +10 -0
  29. package/esm/typings/src/llm-providers/_common/getLlmToolsForTestingAndScriptsAndPlayground.d.ts +10 -0
  30. package/{umd/typings/src/llm-providers → esm/typings/src/llm-providers/_common}/utils/cache/CacheItem.d.ts +4 -4
  31. package/{umd/typings/src/llm-providers → esm/typings/src/llm-providers/_common}/utils/cache/CacheLlmToolsOptions.d.ts +1 -1
  32. package/esm/typings/src/llm-providers/{utils → _common/utils}/cache/cacheLlmTools.d.ts +3 -4
  33. package/esm/typings/src/llm-providers/{utils → _common/utils}/count-total-cost/LlmExecutionToolsWithTotalCost.d.ts +2 -2
  34. package/{umd/typings/src/llm-providers → esm/typings/src/llm-providers/_common}/utils/count-total-cost/countTotalCost.d.ts +2 -2
  35. package/esm/typings/src/llm-providers/_common/utils/count-total-cost/limitTotalCost.d.ts +32 -0
  36. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -0
  37. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  38. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +1 -0
  39. package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +3 -0
  40. package/esm/typings/src/llm-providers/langtail/LangtailExecutionToolsOptions.d.ts +1 -1
  41. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +1 -1
  42. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +1 -1
  43. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +1 -0
  44. package/esm/typings/src/llm-providers/openai/computeUsage.d.ts +2 -2
  45. package/esm/typings/src/personas/preparePersona.d.ts +6 -1
  46. package/esm/typings/src/prepare/preparePipeline.d.ts +2 -1
  47. package/esm/typings/src/prepare/unpreparePipeline.d.ts +1 -0
  48. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +1 -0
  49. package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +1 -1
  50. package/esm/typings/src/storage/files-storage/FilesStorage.d.ts +2 -0
  51. package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +3 -0
  52. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +2 -1
  53. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +2 -1
  54. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +3 -0
  55. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +3 -0
  56. package/esm/typings/src/storage/utils/makePromptbookStorageFromWebStorage.d.ts +0 -1
  57. package/esm/typings/src/types/ModelRequirements.d.ts +1 -1
  58. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +1 -1
  59. package/esm/typings/src/types/PipelineString.d.ts +1 -1
  60. package/esm/typings/src/types/execution-report/countWorkingDuration.d.ts +1 -1
  61. package/esm/typings/src/utils/deepClone.d.ts +9 -0
  62. package/esm/typings/src/utils/deepFreeze.d.ts +13 -0
  63. package/esm/typings/src/utils/emojis.d.ts +2 -2
  64. package/esm/typings/src/utils/formatNumber.d.ts +1 -1
  65. package/esm/typings/src/utils/isRunningInWhatever.d.ts +3 -0
  66. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +1 -1
  67. package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +1 -1
  68. package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +1 -1
  69. package/esm/typings/src/utils/organization/TODO.d.ts +2 -0
  70. package/esm/typings/src/utils/organization/TODO_USE.d.ts +1 -0
  71. package/esm/typings/src/utils/organization/___.d.ts +2 -0
  72. package/esm/typings/src/utils/organization/just.d.ts +5 -1
  73. package/esm/typings/src/utils/organization/keepUnused.d.ts +16 -0
  74. package/esm/typings/src/utils/organization/really_any.d.ts +2 -0
  75. package/package.json +2 -2
  76. package/umd/index.umd.js +1 -1
  77. package/umd/typings/src/_packages/execute-javascript.index.d.ts +1 -1
  78. package/umd/typings/src/_packages/utils.index.d.ts +1 -1
  79. package/umd/typings/src/cli/cli-commands/hello.d.ts +3 -0
  80. package/umd/typings/src/cli/cli-commands/make.d.ts +3 -0
  81. package/umd/typings/src/cli/cli-commands/prettify.d.ts +3 -0
  82. package/umd/typings/src/cli/promptbookCli.d.ts +1 -0
  83. package/umd/typings/src/collection/PipelineCollection.d.ts +1 -1
  84. package/umd/typings/src/collection/SimplePipelineCollection.d.ts +1 -1
  85. package/umd/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +1 -0
  86. package/umd/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -0
  87. package/umd/typings/src/commands/_common/types/CommandParser.d.ts +1 -1
  88. package/umd/typings/src/config.d.ts +1 -1
  89. package/umd/typings/src/conversion/pipelineJsonToString.d.ts +1 -1
  90. package/umd/typings/src/conversion/validation/validatePipeline.d.ts +4 -2
  91. package/umd/typings/src/errors/LimitReachedError.d.ts +7 -0
  92. package/umd/typings/src/execution/CommonExecutionToolsOptions.d.ts +1 -0
  93. package/umd/typings/src/execution/utils/addUsage.d.ts +57 -1
  94. package/umd/typings/src/formats/csv/ListFormatDefinition.d.ts +1 -0
  95. package/umd/typings/src/formats/json/JsonFormatDefinition.d.ts +1 -0
  96. package/umd/typings/src/formats/list/ListFormatDefinition.d.ts +1 -0
  97. package/umd/typings/src/formats/xml/XmlFormatDefinition.d.ts +1 -0
  98. package/umd/typings/src/knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +3 -0
  99. package/umd/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.d.ts +1 -1
  100. package/umd/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +1 -0
  101. package/umd/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +1 -0
  102. package/{esm/typings/src/llm-providers/utils → umd/typings/src/llm-providers/_common}/createLlmToolsFromEnv.d.ts +3 -2
  103. package/umd/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +10 -0
  104. package/umd/typings/src/llm-providers/_common/getLlmToolsForTestingAndScriptsAndPlayground.d.ts +10 -0
  105. package/{esm/typings/src/llm-providers → umd/typings/src/llm-providers/_common}/utils/cache/CacheItem.d.ts +4 -4
  106. package/{esm/typings/src/llm-providers → umd/typings/src/llm-providers/_common}/utils/cache/CacheLlmToolsOptions.d.ts +1 -1
  107. package/umd/typings/src/llm-providers/{utils → _common/utils}/cache/cacheLlmTools.d.ts +3 -4
  108. package/umd/typings/src/llm-providers/{utils → _common/utils}/count-total-cost/LlmExecutionToolsWithTotalCost.d.ts +2 -2
  109. package/{esm/typings/src/llm-providers → umd/typings/src/llm-providers/_common}/utils/count-total-cost/countTotalCost.d.ts +2 -2
  110. package/umd/typings/src/llm-providers/_common/utils/count-total-cost/limitTotalCost.d.ts +32 -0
  111. package/umd/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -0
  112. package/umd/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  113. package/umd/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +1 -0
  114. package/umd/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +3 -0
  115. package/umd/typings/src/llm-providers/langtail/LangtailExecutionToolsOptions.d.ts +1 -1
  116. package/umd/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +1 -1
  117. package/umd/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +1 -1
  118. package/umd/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +1 -0
  119. package/umd/typings/src/llm-providers/openai/computeUsage.d.ts +2 -2
  120. package/umd/typings/src/personas/preparePersona.d.ts +6 -1
  121. package/umd/typings/src/prepare/preparePipeline.d.ts +2 -1
  122. package/umd/typings/src/prepare/unpreparePipeline.d.ts +1 -0
  123. package/umd/typings/src/storage/_common/PromptbookStorage.d.ts +1 -0
  124. package/umd/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +1 -1
  125. package/umd/typings/src/storage/files-storage/FilesStorage.d.ts +2 -0
  126. package/umd/typings/src/storage/files-storage/FilesStorageOptions.d.ts +3 -0
  127. package/umd/typings/src/storage/local-storage/getLocalStorage.d.ts +2 -1
  128. package/umd/typings/src/storage/local-storage/getSessionStorage.d.ts +2 -1
  129. package/umd/typings/src/storage/memory/MemoryStorage.d.ts +3 -0
  130. package/umd/typings/src/storage/utils/PrefixStorage.d.ts +3 -0
  131. package/umd/typings/src/storage/utils/makePromptbookStorageFromWebStorage.d.ts +0 -1
  132. package/umd/typings/src/types/ModelRequirements.d.ts +1 -1
  133. package/umd/typings/src/types/PipelineJson/PipelineJson.d.ts +1 -1
  134. package/umd/typings/src/types/PipelineString.d.ts +1 -1
  135. package/umd/typings/src/types/execution-report/countWorkingDuration.d.ts +1 -1
  136. package/umd/typings/src/utils/deepClone.d.ts +9 -0
  137. package/umd/typings/src/utils/deepFreeze.d.ts +13 -0
  138. package/umd/typings/src/utils/emojis.d.ts +2 -2
  139. package/umd/typings/src/utils/formatNumber.d.ts +1 -1
  140. package/umd/typings/src/utils/isRunningInWhatever.d.ts +3 -0
  141. package/umd/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +1 -1
  142. package/umd/typings/src/utils/markdown/createMarkdownChart.d.ts +1 -1
  143. package/umd/typings/src/utils/markdown/createMarkdownTable.d.ts +1 -1
  144. package/umd/typings/src/utils/organization/TODO.d.ts +2 -0
  145. package/umd/typings/src/utils/organization/TODO_USE.d.ts +1 -0
  146. package/umd/typings/src/utils/organization/___.d.ts +2 -0
  147. package/umd/typings/src/utils/organization/just.d.ts +5 -1
  148. package/umd/typings/src/utils/organization/keepUnused.d.ts +16 -0
  149. package/umd/typings/src/utils/organization/really_any.d.ts +2 -0
  150. package/esm/typings/src/execution/addPromptResultUsage.test.d.ts +0 -1
  151. package/esm/typings/src/knowledge/prepare-knowledge/_common/utils/getLlmToolsForTestingAndScriptsAndPlayground.d.ts +0 -10
  152. package/esm/typings/src/utils/organization/notUsing.d.ts +0 -11
  153. package/umd/typings/src/execution/addPromptResultUsage.test.d.ts +0 -1
  154. package/umd/typings/src/knowledge/prepare-knowledge/_common/utils/getLlmToolsForTestingAndScriptsAndPlayground.d.ts +0 -10
  155. package/umd/typings/src/utils/organization/notUsing.d.ts +0 -11
  156. /package/esm/typings/src/{utils/postprocessing → postprocessing/utils}/extractBlock.d.ts +0 -0
  157. /package/umd/typings/src/{utils/postprocessing → postprocessing/utils}/extractBlock.d.ts +0 -0
@@ -21,3 +21,6 @@ export declare class PrefixStorage<TItem> implements PromptbookStorage<TItem> {
21
21
  */
22
22
  removeItem(key: string): void;
23
23
  }
24
+ /**
25
+ * TODO: [🔼] !!! Export via `@promptbook/core`
26
+ */
@@ -6,7 +6,6 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
6
6
  */
7
7
  export declare function makePromptbookStorageFromWebStorage<TValue>(webStorage: Storage): PromptbookStorage<TValue>;
8
8
  /**
9
- * TODO: !!!! Export through `@promptbook/browser`
10
9
  * TODO: [🧠] Should this be named `makePromptbookStorageFromWebStorage` vs `createPromptbookStorageFromWebStorage`
11
10
  * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
12
11
  */
@@ -54,7 +54,7 @@ export type ModelRequirements = {
54
54
  readonly maxTokens?: number;
55
55
  };
56
56
  /**
57
- * TODO: [🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
57
+ * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
58
58
  * TODO: [🧠][💱] Add more model options: `stop_token`, `logit_bias`, `logprobs` (`top_logprobs`), `top_k`, `top_p`, `presence_penalty`, `frequency_penalty`, `bestOf`, `logitBias`, `logitBiasType`,...
59
59
  * [💱] Probbably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)
60
60
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
@@ -14,7 +14,7 @@ import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson'
14
14
  * Promptbook is the **core concept of this package**.
15
15
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
16
16
  *
17
- * @see !!! https://github.com/webgptorg/promptbook#promptbook
17
+ * @see @@@ https://github.com/webgptorg/promptbook#promptbook
18
18
  */
19
19
  export type PipelineJson = {
20
20
  /**
@@ -2,7 +2,7 @@
2
2
  * Promptbook is the **core concept of this package**.
3
3
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
4
4
  *
5
- * @see !!! https://github.com/webgptorg/promptbook#promptbook
5
+ * @see @@@ https://github.com/webgptorg/promptbook#promptbook
6
6
  */
7
7
  export type PipelineString = string & {
8
8
  readonly _type: 'Promptbook';
@@ -2,6 +2,6 @@ import type { FromtoItems } from '../../utils/FromtoItems';
2
2
  /**
3
3
  * Count the duration of working time
4
4
  *
5
- * @private within the package
5
+ * @private within the repository
6
6
  */
7
7
  export declare function countWorkingDuration(items: FromtoItems): number;
@@ -0,0 +1,9 @@
1
+ import type { WritableDeep } from 'type-fest';
2
+ /**
3
+ * @@@
4
+ */
5
+ export declare function deepClone<TObject>(objectValue: TObject): WritableDeep<TObject>;
6
+ /**
7
+ * TODO: [🔼] Export from `@promptbook/utils`
8
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
9
+ */
@@ -0,0 +1,13 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ /**
3
+ * @@@
4
+ *
5
+ * @returns The same object as the input, but deeply frozen
6
+ *
7
+ * Note: This function mutates the object
8
+ */
9
+ export declare function deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
10
+ /**
11
+ * TODO: [🔼] Export from `@promptbook/utils`
12
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
13
+ */
@@ -5,7 +5,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
5
5
  *
6
6
  * @see https://getemoji.com/
7
7
  *
8
- * @private within the package
8
+ * @private within the repository
9
9
  * @deprecated Use /\p{Extended_Pictographic}/ instead
10
10
  */
11
11
  export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
@@ -13,7 +13,7 @@ export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoj
13
13
  *
14
14
  * All possible emoji chars like "🍆", "🍡", "🍤"...
15
15
  *
16
- * @private within the package
16
+ * @private within the repository
17
17
  * @deprecated Use /\p{Extended_Pictographic}/ instead
18
18
  */
19
19
  export declare const EMOJIS: Set<string_char_emoji>;
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Format either small or big number
3
3
  *
4
- * @private within the package
4
+ * @private within the repository
5
5
  */
6
6
  export declare function formatNumber(value: number): string;
@@ -10,3 +10,6 @@ export declare const isRunningInNode: Function;
10
10
  * Detects if the code is running in a web worker
11
11
  */
12
12
  export declare const isRunningInWebWorker: Function;
13
+ /**
14
+ * TODO: [🔼] !!! Export via `@promptbook/utils`
15
+ */
@@ -3,7 +3,7 @@ import type { string_name } from '../../types/typeAliases';
3
3
  /**
4
4
  * Add or modify an auto-generated section in a markdown file
5
5
  *
6
- * @private within the package
6
+ * @private within the repository
7
7
  */
8
8
  export declare function addAutoGeneratedSection(content: string_markdown, options: {
9
9
  readonly sectionName: string_name;
@@ -28,7 +28,7 @@ type CreateMarkdownChartOptions = {
28
28
  /**
29
29
  * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
30
30
  *
31
- * @private within the package
31
+ * @private within the repository
32
32
  */
33
33
  export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
34
34
  export {};
@@ -3,6 +3,6 @@ import type { string_markdown_text } from '../../types/typeAliases';
3
3
  /**
4
4
  * Create a markdown table from a 2D array of strings
5
5
  *
6
- * @private within the package
6
+ * @private within the repository
7
7
  */
8
8
  export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;
@@ -1,4 +1,6 @@
1
1
  /**
2
2
  * Organizational helper to better mark the place where the type is missing
3
+ *
4
+ * @private within the repository
3
5
  */
4
6
  export type TODO = any;
@@ -7,5 +7,6 @@ import type { really_any } from './really_any';
7
7
  *
8
8
  * @param value any values
9
9
  * @returns void
10
+ * @private within the repository
10
11
  */
11
12
  export declare function TODO_USE(...value: Array<really_any>): void;
@@ -1,4 +1,6 @@
1
1
  /**
2
2
  * Formatting helper to put void to keep longer version of prettier
3
+ *
4
+ * @private within the repository
3
5
  */
4
6
  export type ___ = never;
@@ -2,9 +2,13 @@
2
2
  * Returns the same value that is passed as argument.
3
3
  * No side effects.
4
4
  *
5
- * Note: It can be usefull for leveling indentation
5
+ * Note: It can be usefull for:
6
+ *
7
+ * 1) Leveling indentation
8
+ * 2) Putting always-true or always-false conditions without getting eslint errors
6
9
  *
7
10
  * @param value any values
8
11
  * @returns the same values
12
+ * @private within the repository
9
13
  */
10
14
  export declare function just<T>(value?: T): T;
@@ -0,0 +1,16 @@
1
+ import type { really_any } from './really_any';
2
+ /**
3
+ * Just says that the variable is not used but should be kept
4
+ * No side effects.
5
+ *
6
+ * Note: It can be usefull for:
7
+ *
8
+ * 1) Suppressing eager optimization of unused imports
9
+ * 2) Suppressing eslint errors of unused variables in the tests
10
+ * 3) Keeping the type of the variable for type testing
11
+ *
12
+ * @param value any values
13
+ * @returns void
14
+ * @private within the repository
15
+ */
16
+ export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: Array<really_any>): void;
@@ -1,4 +1,6 @@
1
1
  /**
2
2
  * Organizational helper to mark a place where to really use any
3
+ *
4
+ * @private within the repository
3
5
  */
4
6
  export type really_any = any;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/remote-client",
3
- "version": "0.61.0-11",
3
+ "version": "0.61.0-13",
4
4
  "description": "Supercharge your use of large language models",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -47,7 +47,7 @@
47
47
  }
48
48
  ],
49
49
  "peerDependencies": {
50
- "@promptbook/core": "0.61.0-11"
50
+ "@promptbook/core": "0.61.0-13"
51
51
  },
52
52
  "main": "./umd/index.umd.js",
53
53
  "module": "./esm/index.es.js",
package/umd/index.umd.js CHANGED
@@ -218,7 +218,7 @@
218
218
  /**
219
219
  * The version of the Promptbook library
220
220
  */
221
- var PROMPTBOOK_VERSION = '0.61.0-10';
221
+ var PROMPTBOOK_VERSION = '0.61.0-12';
222
222
  // TODO: !!!! List here all the versions and annotate + put into script
223
223
 
224
224
  exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;
@@ -1,4 +1,5 @@
1
1
  import spaceTrim from 'spacetrim';
2
+ import { extractBlock } from '../postprocessing/utils/extractBlock';
2
3
  import { JavascriptEvalExecutionTools } from '../scripting/javascript/JavascriptEvalExecutionTools';
3
4
  import { JavascriptExecutionTools } from '../scripting/javascript/JavascriptExecutionTools';
4
5
  import { prettifyMarkdown } from '../utils/markdown/prettifyMarkdown';
@@ -13,7 +14,6 @@ import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelC
13
14
  import { normalizeTo_snake_case } from '../utils/normalization/normalizeTo_snake_case';
14
15
  import { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
15
16
  import { removeDiacritics } from '../utils/normalization/removeDiacritics';
16
- import { extractBlock } from '../utils/postprocessing/extractBlock';
17
17
  import { removeEmojis } from '../utils/removeEmojis';
18
18
  import { removeQuotes } from '../utils/removeQuotes';
19
19
  import { trimCodeBlock } from '../utils/trimCodeBlock';
@@ -7,6 +7,7 @@ import { titleToName } from '../conversion/utils/titleToName';
7
7
  import { forEachAsync } from '../execution/utils/forEachAsync';
8
8
  import { replaceParameters } from '../execution/utils/replaceParameters';
9
9
  import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
10
+ import { extractBlock } from '../postprocessing/utils/extractBlock';
10
11
  import { $currentDate } from '../utils/currentDate';
11
12
  import { countCharacters } from '../utils/expectation-counters/countCharacters';
12
13
  import { countLines } from '../utils/expectation-counters/countLines';
@@ -34,7 +35,6 @@ import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFro
34
35
  import { removeDiacritics } from '../utils/normalization/removeDiacritics';
35
36
  import { searchKeywords } from '../utils/normalization/searchKeywords';
36
37
  import { parseNumber } from '../utils/parseNumber';
37
- import { extractBlock } from '../utils/postprocessing/extractBlock';
38
38
  import { $randomSeed } from '../utils/random/randomSeed';
39
39
  import { removeEmojis } from '../utils/removeEmojis';
40
40
  import { removeQuotes } from '../utils/removeQuotes';
@@ -5,3 +5,6 @@ import type { Command as Program } from 'commander';
5
5
  * @private part of `promptbookCli`
6
6
  */
7
7
  export declare function initializeHelloCommand(program: Program): void;
8
+ /**
9
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
10
+ */
@@ -5,3 +5,6 @@ import type { Command as Program } from 'commander';
5
5
  * @private part of `promptbookCli`
6
6
  */
7
7
  export declare function initializeMakeCommand(program: Program): void;
8
+ /**
9
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
10
+ */
@@ -5,3 +5,6 @@ import type { Command as Program } from 'commander';
5
5
  * @private part of `promptbookCli`
6
6
  */
7
7
  export declare function initializePrettifyCommand(program: Program): void;
8
+ /**
9
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
10
+ */
@@ -6,4 +6,5 @@ export declare function promptbookCli(): Promise<void>;
6
6
  * TODO: [🥠] Do not export to utils directly, its just for CLI script
7
7
  * TODO: [🕌] When more functionalities, rename
8
8
  * Note: 11:11
9
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
9
10
  */
@@ -5,7 +5,7 @@ import type { string_pipeline_url } from '../types/typeAliases';
5
5
  /**
6
6
  * Collection that groups together pipelines, knowledge, personas, tools and actions
7
7
  *
8
- * @see !!! https://github.com/webgptorg/pipeline#pipeline-collection
8
+ * @see @@@ https://github.com/webgptorg/pipeline#pipeline-collection
9
9
  */
10
10
  export type PipelineCollection = {
11
11
  /**
@@ -14,7 +14,7 @@ export declare class SimplePipelineCollection implements PipelineCollection {
14
14
  /**
15
15
  * Constructs a pipeline collection from promptbooks
16
16
  *
17
- * @param promptbooks !!!
17
+ * @param promptbooks @@@
18
18
  *
19
19
  * @private Use instead `createCollectionFromJson`
20
20
  * Note: During the construction logic of all promptbooks are validated
@@ -44,4 +44,5 @@ export declare function createCollectionFromDirectory(path: string_folder_path,
44
44
  export {};
45
45
  /**
46
46
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
47
+ * Note: [🟢] This code should never be published outside of `@promptbook/node`
47
48
  */
@@ -9,4 +9,5 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
9
9
  export declare const boilerplateCommandParser: CommandParser<BoilerplateCommand>;
10
10
  /**
11
11
  * TODO: [💐] Implement BOILERPLATE command into `pipelineStringToJsonSync` function
12
+ * Note: [⚪] This should never be in any released package
12
13
  */
@@ -28,7 +28,7 @@ export type CommandParserInput = {
28
28
  readonly args: Array<string_name & string_SCREAMING_CASE>;
29
29
  };
30
30
  /**
31
- * TODO: !!!! Annotate
31
+ * TODO: @@@ Annotate all
32
32
  * TODO: [🧠] Maybe put flag if it is for whole `.ptbk.md` file of just one section
33
33
  * TODO: [🍧] CommandParser should have applyToPipelineJson method
34
34
  * which will apply parsed command to the pipeline JSON
@@ -21,4 +21,4 @@ export declare const PIPELINE_COLLECTION_BASE_FILENAME = "index";
21
21
  /**
22
22
  * The names of the parameters that are reserved for special purposes
23
23
  */
24
- export declare const RESERVED_PARAMETER_NAMES: string[];
24
+ export declare const RESERVED_PARAMETER_NAMES: readonly string[];
@@ -8,7 +8,7 @@ import type { PipelineString } from '../types/PipelineString';
8
8
  */
9
9
  export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
10
10
  /**
11
- * TODO: !!!!! Implement new features and commands into `promptTemplateParameterJsonToString`
11
+ * TODO: !!!! Implement new features and commands into `promptTemplateParameterJsonToString`
12
12
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
13
13
  * TODO: Escape all
14
14
  */
@@ -26,6 +26,8 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
26
26
  * > ex port function validatePipeline(promptbook: unknown): asserts promptbook is PipelineJson {
27
27
  */
28
28
  /**
29
- * TODO: [🧠] !!!!! Validate new things
29
+ * TODO: [🧠][🐣] !!!! Validate that all samples match expectations
30
+ * TODO: [🧠][🐣] !!!! Validate that knowledge is valid (non-void)
31
+ * TODO: [🧠] !!! Validationg not only logic itself but imports around - files and websites and rerefenced pipelines exists
30
32
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
31
- */
33
+ */
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This error type indicates that some limit was reached
3
+ */
4
+ export declare class LimitReachedError extends Error {
5
+ readonly name = "LimitReachedError";
6
+ constructor(message: string);
7
+ }
@@ -5,5 +5,6 @@ export type CommonExecutionToolsOptions = {
5
5
  readonly isVerbose?: boolean;
6
6
  };
7
7
  /**
8
+ * TODO: [🈁] Maybe add here `isDeterministic`
8
9
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
9
10
  */
@@ -1,7 +1,63 @@
1
1
  import type { PromptResultUsage } from '../PromptResult';
2
+ /**
3
+ * @@@
4
+ *
5
+ * TODO: [🔼] Export with addUsage
6
+ */
7
+ export declare const ZERO_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
8
+ readonly price: {
9
+ readonly value: 0;
10
+ };
11
+ readonly input: {
12
+ readonly tokensCount: {
13
+ readonly value: 0;
14
+ };
15
+ readonly charactersCount: {
16
+ readonly value: 0;
17
+ };
18
+ readonly wordsCount: {
19
+ readonly value: 0;
20
+ };
21
+ readonly sentencesCount: {
22
+ readonly value: 0;
23
+ };
24
+ readonly linesCount: {
25
+ readonly value: 0;
26
+ };
27
+ readonly paragraphsCount: {
28
+ readonly value: 0;
29
+ };
30
+ readonly pagesCount: {
31
+ readonly value: 0;
32
+ };
33
+ };
34
+ readonly output: {
35
+ readonly tokensCount: {
36
+ readonly value: 0;
37
+ };
38
+ readonly charactersCount: {
39
+ readonly value: 0;
40
+ };
41
+ readonly wordsCount: {
42
+ readonly value: 0;
43
+ };
44
+ readonly sentencesCount: {
45
+ readonly value: 0;
46
+ };
47
+ readonly linesCount: {
48
+ readonly value: 0;
49
+ };
50
+ readonly paragraphsCount: {
51
+ readonly value: 0;
52
+ };
53
+ readonly pagesCount: {
54
+ readonly value: 0;
55
+ };
56
+ };
57
+ }>;
2
58
  /**
3
59
  * Function `addUsage` will add multiple usages into one
4
60
  *
5
- * Note: If you provide 0 values, it returns void usage
61
+ * Note: If you provide 0 values, it returns ZERO_USAGE
6
62
  */
7
63
  export declare function addUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;
@@ -8,4 +8,5 @@ export declare const CsvFormatDefinition: FormatDefinition<string, string, objec
8
8
  * TODO: [🍓] In `CsvFormatDefinition` implement partial `canBeValid`
9
9
  * TODO: [🍓] In `CsvFormatDefinition` implement `heal
10
10
  * TODO: [🍓] In `CsvFormatDefinition` implement `extractValues`
11
+ * TODO: [🏢] Allow to expect something inside CSV objects and other formats
11
12
  */
@@ -12,4 +12,5 @@ export declare const JsonFormatDefinition: FormatDefinition<string, string, obje
12
12
  * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`
13
13
  * TODO: [🍓] In `JsonFormatDefinition` implement `heal
14
14
  * TODO: [🍓] In `JsonFormatDefinition` implement `extractValues`
15
+ * TODO: [🏢] Allow to expect something inside JSON objects and other formats
15
16
  */
@@ -10,4 +10,5 @@ export declare const ListFormatDefinition: FormatDefinition<string, string, obje
10
10
  * TODO: [🍓] In `ListFormatDefinition` implement partial `canBeValid`
11
11
  * TODO: [🍓] In `ListFormatDefinition` implement `heal
12
12
  * TODO: [🍓] In `ListFormatDefinition` implement `extractValues`
13
+ * TODO: [🏢] Allow to expect something inside each item of list and other formats
13
14
  */
@@ -12,4 +12,5 @@ export declare const XmlFormatDefinition: FormatDefinition<string, string, objec
12
12
  * TODO: [🍓] In `XmlFormatDefinition` implement partial `canBeValid`
13
13
  * TODO: [🍓] In `XmlFormatDefinition` implement `heal
14
14
  * TODO: [🍓] In `XmlFormatDefinition` implement `extractValues`
15
+ * TODO: [🏢] Allow to expect something inside XML and other formats
15
16
  */
@@ -15,3 +15,6 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
15
15
  */
16
16
  promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
17
17
  }
18
+ /**
19
+ * Note: [🔵] This code should never be published outside of `@promptbook/browser`
20
+ */
@@ -5,10 +5,10 @@ import type { KnowledgeSourceJson } from '../../../types/PipelineJson/KnowledgeS
5
5
  * Prepares the knowle
6
6
  *
7
7
  * @see https://github.com/webgptorg/promptbook/discussions/41
8
- * @private within the package
9
8
  */
10
9
  export declare function prepareKnowledgePieces(knowledgeSources: Array<KnowledgeSourceJson>, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
11
10
  /**
11
+ * TODO: [🔼] !!! Export via `@promptbook/core`
12
12
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
13
13
  * Put `knowledgePieces` into `PrepareKnowledgeOptions`
14
14
  * TODO: [🪂] More than max things can run in parallel by acident [1,[2a,2b,_],[3a,3b,_]]
@@ -6,6 +6,7 @@ import type { string_markdown } from '../../../types/typeAliases';
6
6
  */
7
7
  export declare function prepareKnowledgeFromMarkdown(content: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
8
8
  /**
9
+ * TODO: [🔼] !!! Export via `@promptbook/markdown`
9
10
  * TODO: [🪂] Do it in parallel 11:11
10
11
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
11
12
  */
@@ -6,6 +6,7 @@ import type { string_base64 } from '../../../types/typeAliases';
6
6
  */
7
7
  export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
8
8
  /**
9
+ * TODO: [🔼] !!! Export via `@promptbook/pdf`
9
10
  * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
10
11
  * @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
11
12
  * TODO: [🪂] Do it in parallel
@@ -12,10 +12,11 @@ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
12
12
  */
13
13
  export declare function createLlmToolsFromEnv(): LlmExecutionTools;
14
14
  /**
15
- * TODO: !!!!! Export this util
16
- * TODO: !!!! write discussion about this - wizzard
15
+ * TODO: [🔼] !!! Export via `@promptbook/node`
16
+ * TODO: @@@ write discussion about this - wizzard
17
17
  * TODO: Add Azure
18
18
  * TODO: [🧠] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
19
19
  * TODO: [🧠] Is there some meaningfull way how to test this util
20
20
  * TODO: [🧠] Maybe pass env as argument
21
+ * Note: [🟢] This code should never be published outside of `@promptbook/node`
21
22
  */
@@ -0,0 +1,10 @@
1
+ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
2
+ /**
3
+ * Returns LLM tools for CLI
4
+ *
5
+ * @private within the repository - for CLI utils
6
+ */
7
+ export declare function getLlmToolsForCli(): LlmExecutionTools;
8
+ /**
9
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
10
+ */
@@ -0,0 +1,10 @@
1
+ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
2
+ /**
3
+ * Returns LLM tools for testing purposes
4
+ *
5
+ * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
6
+ */
7
+ export declare function getLlmToolsForTestingAndScriptsAndPlayground(): LlmExecutionTools;
8
+ /**
9
+ * Note: [⚪] This should never be in any released package
10
+ */
@@ -1,7 +1,7 @@
1
- import type { PromptResult } from '../../../execution/PromptResult';
2
- import type { Prompt } from '../../../types/Prompt';
3
- import type { string_date_iso8601 } from '../../../types/typeAliases';
4
- import type { string_promptbook_version } from '../../../version';
1
+ import type { PromptResult } from '../../../../execution/PromptResult';
2
+ import type { Prompt } from '../../../../types/Prompt';
3
+ import type { string_date_iso8601 } from '../../../../types/typeAliases';
4
+ import type { string_promptbook_version } from '../../../../version';
5
5
  /**
6
6
  * @@@
7
7
  */
@@ -1,4 +1,4 @@
1
- import type { PromptbookStorage } from '../../../storage/_common/PromptbookStorage';
1
+ import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
2
2
  import type { CacheItem } from './CacheItem';
3
3
  export type CacheLlmToolsOptions = {
4
4
  /**
@@ -1,4 +1,4 @@
1
- import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
1
+ import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
2
2
  import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
3
3
  /**
4
4
  * Intercepts LLM tools and counts total usage of the tools
@@ -8,9 +8,8 @@ import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
8
8
  */
9
9
  export declare function cacheLlmTools(llmTools: LlmExecutionTools, options?: Partial<CacheLlmToolsOptions>): LlmExecutionTools;
10
10
  /**
11
- * TODO: !!!!! Export this util
12
- * TODO: !!!!! Use this for tests in promptbook project itself
13
- * TODO: !!!! write discussion about this and storages
11
+ * TODO: [🔼] !!! Export via `@promptbook/core`
12
+ * TODO: @@@ write discussion about this and storages
14
13
  * write how to combine multiple interceptors
15
14
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
16
15
  * TODO: [🧠] Is there some meaningfull way how to test this util
@@ -1,5 +1,5 @@
1
- import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
2
- import type { PromptResultUsage } from '../../../execution/PromptResult';
1
+ import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
2
+ import type { PromptResultUsage } from '../../../../execution/PromptResult';
3
3
  /**
4
4
  * LLM tools with option to get total cost of the execution
5
5
  */