@promptbook/utils 0.112.0-65 → 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.
@@ -0,0 +1,48 @@
1
+ import type { AvatarPalette } from '../types/AvatarVisualDefinition';
2
+ /**
3
+ * One Minecraft-style pixel texture sampled on a cuboid face.
4
+ *
5
+ * @private helper of the Minecraft avatar visuals
6
+ */
7
+ export type MinecraftTexture = ReadonlyArray<ReadonlyArray<string>>;
8
+ /**
9
+ * Full six-face texture pack for one rendered cuboid.
10
+ *
11
+ * @private helper of the Minecraft avatar visuals
12
+ */
13
+ export type MinecraftCuboidTextures = {
14
+ readonly front: MinecraftTexture;
15
+ readonly back: MinecraftTexture;
16
+ readonly left: MinecraftTexture;
17
+ readonly right: MinecraftTexture;
18
+ readonly top: MinecraftTexture;
19
+ readonly bottom: MinecraftTexture;
20
+ };
21
+ /**
22
+ * Shared subset of avatar colors used by the Minecraft avatar helpers.
23
+ *
24
+ * @private helper of the Minecraft avatar visuals
25
+ */
26
+ type MinecraftTexturePalette = Pick<AvatarPalette, 'primary' | 'secondary' | 'accent' | 'highlight' | 'ink' | 'shadow'>;
27
+ /**
28
+ * Builds the seeded six-face texture pack used by the Minecraft-style head cuboid.
29
+ *
30
+ * @param random Seeded random generator.
31
+ * @param palette Derived avatar palette.
32
+ * @param hasHeadband Whether the generated avatar should include a colored headband.
33
+ * @returns Head cuboid textures.
34
+ *
35
+ * @private helper of the Minecraft avatar visuals
36
+ */
37
+ export declare function createMinecraftHeadTextures(random: () => number, palette: MinecraftTexturePalette, hasHeadband: boolean): MinecraftCuboidTextures;
38
+ /**
39
+ * Builds the seeded six-face texture pack used by the Minecraft-style torso cuboid.
40
+ *
41
+ * @param random Seeded random generator.
42
+ * @param palette Derived avatar palette.
43
+ * @returns Torso cuboid textures.
44
+ *
45
+ * @private helper of the Minecraft avatar visuals
46
+ */
47
+ export declare function createMinecraftTorsoTextures(random: () => number, palette: MinecraftTexturePalette): MinecraftCuboidTextures;
48
+ export {};
@@ -1,6 +1,6 @@
1
1
  import type { InitializationStatus } from './boilerplateTemplates';
2
2
  /**
3
- * Ensures `.gitignore` contains the standalone Promptbook coder temp and cache entries.
3
+ * Ensures `.gitignore` contains the shared Promptbook working-directory entry.
4
4
  *
5
5
  * @private function of `initializeCoderProjectConfiguration`
6
6
  */
@@ -270,7 +270,7 @@ export declare const DEFAULT_AGENTS_DIRNAME = "./agents";
270
270
  *
271
271
  * @public exported from `@promptbook/core`
272
272
  */
273
- export declare const DEFAULT_DOWNLOAD_CACHE_DIRNAME = "./.promptbook/download-cache";
273
+ export declare const DEFAULT_DOWNLOAD_CACHE_DIRNAME: string;
274
274
  /**
275
275
  * Where to store the cache of executions for promptbook CLI
276
276
  *
@@ -278,7 +278,7 @@ export declare const DEFAULT_DOWNLOAD_CACHE_DIRNAME = "./.promptbook/download-ca
278
278
  *
279
279
  * @public exported from `@promptbook/core`
280
280
  */
281
- export declare const DEFAULT_EXECUTION_CACHE_DIRNAME = "./.promptbook/execution-cache";
281
+ export declare const DEFAULT_EXECUTION_CACHE_DIRNAME: string;
282
282
  /**
283
283
  * Where to store the scrape cache
284
284
  *
@@ -286,7 +286,7 @@ export declare const DEFAULT_EXECUTION_CACHE_DIRNAME = "./.promptbook/execution-
286
286
  *
287
287
  * @public exported from `@promptbook/core`
288
288
  */
289
- export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "./.promptbook/scrape-cache";
289
+ export declare const DEFAULT_SCRAPE_CACHE_DIRNAME: string;
290
290
  /**
291
291
  * Id of application for the CLI when using remote server
292
292
  *
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Builds one project-relative path inside the shared Promptbook working directory.
3
+ *
4
+ * @private internal utility for Promptbook-owned temp files
5
+ */
6
+ export declare function getPromptbookTempPath(...pathSegments: ReadonlyArray<string>): string;
7
+ /**
8
+ * Builds one absolute filesystem path inside the shared Promptbook working directory for a project root.
9
+ *
10
+ * @private internal utility for Promptbook-owned temp files
11
+ */
12
+ export declare function resolvePromptbookTempPath(projectPath: string, ...pathSegments: ReadonlyArray<string>): string;
13
+ /**
14
+ * Builds one POSIX path fragment inside the shared Promptbook working directory for globs and generated text files.
15
+ *
16
+ * @private internal utility for Promptbook-owned temp files
17
+ */
18
+ export declare function getPromptbookTempPosixPath(...pathSegments: ReadonlyArray<string>): string;
19
+ /**
20
+ * Builds one rooted `.gitignore` rule targeting a path inside the shared Promptbook working directory.
21
+ *
22
+ * @private internal utility for Promptbook-owned temp files
23
+ */
24
+ export declare function getPromptbookTempGitignoreRule(...pathSegments: ReadonlyArray<string>): string;
@@ -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.112.0-64`).
18
+ * It follows semantic versioning (e.g., `0.112.0-65`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/utils",
3
- "version": "0.112.0-65",
3
+ "version": "0.112.0-66",
4
4
  "description": "Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action",
5
5
  "private": false,
6
6
  "sideEffects": false,
package/umd/index.umd.js CHANGED
@@ -22,7 +22,7 @@
22
22
  * @generated
23
23
  * @see https://github.com/webgptorg/promptbook
24
24
  */
25
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-65';
25
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-66';
26
26
  /**
27
27
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
28
28
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -941,6 +941,29 @@
941
941
  }
942
942
  // TODO: Maybe implement by mix+hsl
943
943
 
944
+ /**
945
+ * Relative directory name without the `./` prefix for Git ignore rules and glob patterns.
946
+ *
947
+ * @private internal utility for Promptbook-owned temp files
948
+ */
949
+ const PROMPTBOOK_TEMP_DIRECTORY_NAME = '.promptbook';
950
+ /**
951
+ * Builds one project-relative path inside the shared Promptbook working directory.
952
+ *
953
+ * @private internal utility for Promptbook-owned temp files
954
+ */
955
+ function getPromptbookTempPath(...pathSegments) {
956
+ return `./${getPromptbookTempPosixPath(...pathSegments)}`;
957
+ }
958
+ /**
959
+ * Builds one POSIX path fragment inside the shared Promptbook working directory for globs and generated text files.
960
+ *
961
+ * @private internal utility for Promptbook-owned temp files
962
+ */
963
+ function getPromptbookTempPosixPath(...pathSegments) {
964
+ return path.posix.join(PROMPTBOOK_TEMP_DIRECTORY_NAME, ...pathSegments);
965
+ }
966
+
944
967
  /**
945
968
  * Name for the Promptbook
946
969
  *
@@ -1035,6 +1058,31 @@
1035
1058
  * @public exported from `@promptbook/utils`
1036
1059
  */
1037
1060
  const SMALL_NUMBER = 0.001;
1061
+ // <- TODO: [🕝] Make also `AGENTS_DIRNAME_ALTERNATIVES`
1062
+ /**
1063
+ * Where to store the temporary downloads
1064
+ *
1065
+ * Note: When the folder does not exist, it is created recursively
1066
+ *
1067
+ * @public exported from `@promptbook/core`
1068
+ */
1069
+ getPromptbookTempPath('download-cache');
1070
+ /**
1071
+ * Where to store the cache of executions for promptbook CLI
1072
+ *
1073
+ * Note: When the folder does not exist, it is created recursively
1074
+ *
1075
+ * @public exported from `@promptbook/core`
1076
+ */
1077
+ getPromptbookTempPath('execution-cache');
1078
+ /**
1079
+ * Where to store the scrape cache
1080
+ *
1081
+ * Note: When the folder does not exist, it is created recursively
1082
+ *
1083
+ * @public exported from `@promptbook/core`
1084
+ */
1085
+ getPromptbookTempPath('scrape-cache');
1038
1086
  // <- TODO: [🧜‍♂️]
1039
1087
  /**
1040
1088
  * Default settings for parsing and generating CSV files in Promptbook.