@promptbook/openai 0.112.0-64 → 0.112.0-66

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 (55) hide show
  1. package/esm/index.es.js +59 -21
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/src/_packages/components.index.d.ts +0 -2
  4. package/esm/src/_packages/core.index.d.ts +2 -2
  5. package/esm/src/_packages/types.index.d.ts +0 -2
  6. package/esm/src/avatars/types/AvatarVisualDefinition.d.ts +1 -1
  7. package/esm/src/avatars/visuals/minecraft2AvatarVisual.d.ts +7 -0
  8. package/esm/src/avatars/visuals/minecraftAvatarVisualShared.d.ts +48 -0
  9. package/esm/src/book-2.0/book-language-documentation/BookLanguageDocumentationExample.d.ts +27 -0
  10. package/esm/src/book-2.0/book-language-documentation/bookLanguageCommonPitfalls.d.ts +25 -0
  11. package/esm/src/book-2.0/book-language-documentation/bookLanguageDocumentationExamples.d.ts +10 -0
  12. package/esm/src/book-2.0/book-language-documentation/createStandaloneBookLanguageMarkdown.d.ts +14 -0
  13. package/esm/src/book-2.0/book-language-documentation/renderGroupedCommitmentDocumentationMarkdown.d.ts +43 -0
  14. package/esm/src/book-components/Chat/types/ChatMessage.d.ts +0 -34
  15. package/esm/src/cli/cli-commands/coder/ensureCoderGitignoreFile.d.ts +1 -1
  16. package/esm/src/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +0 -11
  17. package/esm/src/commitments/_common/toolRuntimeContext.d.ts +0 -6
  18. package/esm/src/config.d.ts +3 -3
  19. package/esm/src/formfactors/index.d.ts +2 -2
  20. package/esm/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +1 -1
  21. package/esm/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +1 -1
  22. package/esm/src/llm-providers/openai/OpenAiAgentKitExecutionTools.d.ts +0 -4
  23. package/esm/src/llm-providers/openai/OpenAiAgentKitExecutionToolsOptions.d.ts +0 -9
  24. package/esm/src/utils/files/getPromptbookTempPath.d.ts +24 -0
  25. package/esm/src/version.d.ts +1 -1
  26. package/package.json +2 -2
  27. package/umd/index.umd.js +59 -21
  28. package/umd/index.umd.js.map +1 -1
  29. package/umd/src/_packages/components.index.d.ts +0 -2
  30. package/umd/src/_packages/core.index.d.ts +2 -2
  31. package/umd/src/_packages/types.index.d.ts +0 -2
  32. package/umd/src/avatars/types/AvatarVisualDefinition.d.ts +1 -1
  33. package/umd/src/avatars/visuals/minecraft2AvatarVisual.d.ts +7 -0
  34. package/umd/src/avatars/visuals/minecraftAvatarVisualShared.d.ts +48 -0
  35. package/umd/src/book-2.0/book-language-documentation/BookLanguageDocumentationExample.d.ts +27 -0
  36. package/umd/src/book-2.0/book-language-documentation/bookLanguageCommonPitfalls.d.ts +25 -0
  37. package/umd/src/book-2.0/book-language-documentation/bookLanguageDocumentationExamples.d.ts +10 -0
  38. package/umd/src/book-2.0/book-language-documentation/createStandaloneBookLanguageMarkdown.d.ts +14 -0
  39. package/umd/src/book-2.0/book-language-documentation/renderGroupedCommitmentDocumentationMarkdown.d.ts +43 -0
  40. package/umd/src/book-2.0/book-language-documentation/renderGroupedCommitmentDocumentationMarkdown.test.d.ts +1 -0
  41. package/umd/src/book-components/Chat/types/ChatMessage.d.ts +0 -34
  42. package/umd/src/cli/cli-commands/coder/ensureCoderGitignoreFile.d.ts +1 -1
  43. package/umd/src/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +0 -11
  44. package/umd/src/commitments/_common/toolRuntimeContext.d.ts +0 -6
  45. package/umd/src/config.d.ts +3 -3
  46. package/umd/src/formfactors/index.d.ts +2 -2
  47. package/umd/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +1 -1
  48. package/umd/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +1 -1
  49. package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionTools.d.ts +0 -4
  50. package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionToolsOptions.d.ts +0 -9
  51. package/umd/src/utils/files/getPromptbookTempPath.d.ts +24 -0
  52. package/umd/src/utils/files/getPromptbookTempPath.test.d.ts +1 -0
  53. package/umd/src/version.d.ts +1 -1
  54. /package/esm/src/{commitments/KNOWLEDGE/KNOWLEDGE.test.d.ts → book-2.0/book-language-documentation/renderGroupedCommitmentDocumentationMarkdown.test.d.ts} +0 -0
  55. /package/{umd/src/commitments/KNOWLEDGE/KNOWLEDGE.test.d.ts → esm/src/utils/files/getPromptbookTempPath.test.d.ts} +0 -0
package/esm/index.es.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import colors from 'colors';
2
2
  import { spaceTrim as spaceTrim$1 } from 'spacetrim';
3
- import 'path';
3
+ import { posix } from 'path';
4
4
  import { randomBytes } from 'crypto';
5
5
  import 'crypto-js';
6
6
  import 'crypto-js/enc-hex';
@@ -23,7 +23,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
23
23
  * @generated
24
24
  * @see https://github.com/webgptorg/promptbook
25
25
  */
26
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-64';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-66';
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
@@ -979,6 +979,29 @@ function saturate(amount) {
979
979
  }
980
980
  // TODO: Maybe implement by mix+hsl
981
981
 
982
+ /**
983
+ * Relative directory name without the `./` prefix for Git ignore rules and glob patterns.
984
+ *
985
+ * @private internal utility for Promptbook-owned temp files
986
+ */
987
+ const PROMPTBOOK_TEMP_DIRECTORY_NAME = '.promptbook';
988
+ /**
989
+ * Builds one project-relative path inside the shared Promptbook working directory.
990
+ *
991
+ * @private internal utility for Promptbook-owned temp files
992
+ */
993
+ function getPromptbookTempPath(...pathSegments) {
994
+ return `./${getPromptbookTempPosixPath(...pathSegments)}`;
995
+ }
996
+ /**
997
+ * Builds one POSIX path fragment inside the shared Promptbook working directory for globs and generated text files.
998
+ *
999
+ * @private internal utility for Promptbook-owned temp files
1000
+ */
1001
+ function getPromptbookTempPosixPath(...pathSegments) {
1002
+ return posix.join(PROMPTBOOK_TEMP_DIRECTORY_NAME, ...pathSegments);
1003
+ }
1004
+
982
1005
  /**
983
1006
  * Name for the Promptbook
984
1007
  *
@@ -1086,6 +1109,31 @@ const CONNECTION_TIMEOUT_MS = 7 * 1000;
1086
1109
  * @private within the repository - too low-level in comparison with other `MAX_...`
1087
1110
  */
1088
1111
  const CONNECTION_RETRIES_LIMIT = 5;
1112
+ // <- TODO: [🕝] Make also `AGENTS_DIRNAME_ALTERNATIVES`
1113
+ /**
1114
+ * Where to store the temporary downloads
1115
+ *
1116
+ * Note: When the folder does not exist, it is created recursively
1117
+ *
1118
+ * @public exported from `@promptbook/core`
1119
+ */
1120
+ getPromptbookTempPath('download-cache');
1121
+ /**
1122
+ * Where to store the cache of executions for promptbook CLI
1123
+ *
1124
+ * Note: When the folder does not exist, it is created recursively
1125
+ *
1126
+ * @public exported from `@promptbook/core`
1127
+ */
1128
+ getPromptbookTempPath('execution-cache');
1129
+ /**
1130
+ * Where to store the scrape cache
1131
+ *
1132
+ * Note: When the folder does not exist, it is created recursively
1133
+ *
1134
+ * @public exported from `@promptbook/core`
1135
+ */
1136
+ getPromptbookTempPath('scrape-cache');
1089
1137
  // <- TODO: [🧜‍♂️]
1090
1138
  /**
1091
1139
  * Default settings for parsing and generating CSV files in Promptbook.
@@ -3787,9 +3835,11 @@ class OpenAiCompatibleUnsupportedParameterRetrier {
3787
3835
  * Creates the retry-history error message shared by all OpenAI-compatible model variants.
3788
3836
  */
3789
3837
  createAttemptHistoryError(finalErrorMessage) {
3790
- return new PipelineExecutionError(`All attempts failed. Attempt history:\n` +
3791
- formatUnsupportedParameterAttemptHistory(this.attemptStack) +
3792
- `\nFinal error: ${finalErrorMessage}`);
3838
+ return new PipelineExecutionError(spaceTrim$1((block) => `
3839
+ All attempts failed. Attempt history:
3840
+ ${block(formatUnsupportedParameterAttemptHistory(this.attemptStack))}
3841
+ Final error: ${finalErrorMessage}
3842
+ `));
3793
3843
  }
3794
3844
  }
3795
3845
 
@@ -7903,7 +7953,7 @@ class OpenAiAgentKitExecutionTools extends OpenAiVectorStoreHandler {
7903
7953
  });
7904
7954
  }
7905
7955
  let vectorStoreId = cachedVectorStoreId;
7906
- if (this.isNativeKnowledgeSearchEnabled && !vectorStoreId && knowledgeSources && knowledgeSources.length > 0) {
7956
+ if (!vectorStoreId && knowledgeSources && knowledgeSources.length > 0) {
7907
7957
  const vectorStoreResult = await this.createVectorStoreWithKnowledgeSources({
7908
7958
  client: await this.getClient(),
7909
7959
  name,
@@ -7912,19 +7962,13 @@ class OpenAiAgentKitExecutionTools extends OpenAiVectorStoreHandler {
7912
7962
  });
7913
7963
  vectorStoreId = vectorStoreResult.vectorStoreId;
7914
7964
  }
7915
- else if (this.isNativeKnowledgeSearchEnabled && vectorStoreId && this.options.isVerbose) {
7965
+ else if (vectorStoreId && this.options.isVerbose) {
7916
7966
  console.info('[🤰]', 'Using cached vector store for AgentKit agent', {
7917
7967
  name,
7918
7968
  vectorStoreId,
7919
7969
  });
7920
7970
  }
7921
- if (!this.isNativeKnowledgeSearchEnabled) {
7922
- vectorStoreId = undefined;
7923
- }
7924
- const agentKitTools = this.buildAgentKitTools({
7925
- tools,
7926
- vectorStoreId,
7927
- });
7971
+ const agentKitTools = this.buildAgentKitTools({ tools, vectorStoreId });
7928
7972
  const openAiAgentKitAgent = new Agent({
7929
7973
  name,
7930
7974
  model: this.agentKitModelName,
@@ -7943,7 +7987,7 @@ class OpenAiAgentKitExecutionTools extends OpenAiVectorStoreHandler {
7943
7987
  name,
7944
7988
  model: this.agentKitModelName,
7945
7989
  toolCount: agentKitTools.length,
7946
- hasVectorStore: this.isNativeKnowledgeSearchEnabled && Boolean(vectorStoreId),
7990
+ hasVectorStore: Boolean(vectorStoreId),
7947
7991
  });
7948
7992
  }
7949
7993
  return preparedAgent;
@@ -8442,12 +8486,6 @@ class OpenAiAgentKitExecutionTools extends OpenAiVectorStoreHandler {
8442
8486
  get agentKitOptions() {
8443
8487
  return this.options;
8444
8488
  }
8445
- /**
8446
- * Returns true when hosted OpenAI vector-store search should back `knowledgeSources`.
8447
- */
8448
- get isNativeKnowledgeSearchEnabled() {
8449
- return this.agentKitOptions.isNativeKnowledgeSearchEnabled !== false;
8450
- }
8451
8489
  /**
8452
8490
  * Discriminant for type guards.
8453
8491
  */