@promptbook/documents 0.103.0-45 → 0.103.0-46

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.
@@ -8,6 +8,8 @@ export declare const PADDING_LINES = 11;
8
8
  /**
9
9
  * A function that adds padding to the book content
10
10
  *
11
+ * Note: [🔂] This function is idempotent.
12
+ *
11
13
  * @public exported from `@promptbook/core`
12
14
  */
13
15
  export declare function padBook(content: string_book): string_book;
@@ -15,6 +15,8 @@ export declare function isValidBook(value: string): value is string_book;
15
15
  * This function should be used when you have a string that you know represents agent source
16
16
  * but need to convert it to the branded type for type safety
17
17
  *
18
+ * Note: [🔂] This function is idempotent.
19
+ *
18
20
  * @public exported from `@promptbook/core`
19
21
  */
20
22
  export declare function validateBook(source: string): string_book;
@@ -95,6 +95,10 @@ export declare class AgentCollectionInSupabase {
95
95
  * Note: You can set 'PARENT' in the agent source to inherit from another agent in the collection.
96
96
  */
97
97
  createAgent(agentSource: string_book): Promise<AgentBasicInformation>;
98
+ /**
99
+ * Updates an existing agent in the collection
100
+ */
101
+ updateAgentSource(agentName: string_agent_name, agentSource: string_book): Promise<void>;
98
102
  /**
99
103
  * Deletes an agent from the collection
100
104
  */
@@ -9,6 +9,8 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
9
9
  * - if it is valid json
10
10
  * - if it is meaningful
11
11
  *
12
+ * Note: [🔂] This function is idempotent.
13
+ *
12
14
  * @param pipeline valid or invalid PipelineJson
13
15
  * @returns the same pipeline if it is logically valid
14
16
  * @throws {PipelineLogicError} on logical error in the pipeline
@@ -46,6 +46,8 @@ export type ValidatePromptResultResult = {
46
46
  * This function provides a common abstraction for result validation that can be used
47
47
  * by both execution logic and caching logic to ensure consistency.
48
48
  *
49
+ * Note: [🔂] This function is idempotent.
50
+ *
49
51
  * @param options - The validation options including result string, expectations, and format
50
52
  * @returns Validation result with processed string and validity status
51
53
  * @private internal function of `createPipelineExecutor` and `cacheLlmTools`
@@ -3,6 +3,8 @@ import type { PipelineString } from './PipelineString';
3
3
  * Function `validatePipelineString` will validate the if the string is a valid pipeline string
4
4
  * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
5
5
  *
6
+ * Note: [🔂] This function is idempotent.
7
+ *
6
8
  * @param {string} pipelineString the candidate for a pipeline string
7
9
  * @returns {PipelineString} the same string as input, but validated as valid
8
10
  * @throws {ParseError} if the string is not a valid pipeline string
@@ -3,6 +3,8 @@ import type { string_parameter_name } from '../../../types/typeAliases';
3
3
  * Function `validateParameterName` will normalize and validate a parameter name for use in pipelines.
4
4
  * It removes diacritics, emojis, and quotes, normalizes to camelCase, and checks for reserved names and invalid characters.
5
5
  *
6
+ * Note: [🔂] This function is idempotent.
7
+ *
6
8
  * @param parameterName The parameter name to validate and normalize.
7
9
  * @returns The validated and normalized parameter name.
8
10
  * @throws {ParseError} If the parameter name is empty, reserved, or contains invalid characters.
@@ -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.103.0-44`).
18
+ * It follows semantic versioning (e.g., `0.103.0-45`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/documents",
3
- "version": "0.103.0-45",
3
+ "version": "0.103.0-46",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -95,7 +95,7 @@
95
95
  "module": "./esm/index.es.js",
96
96
  "typings": "./esm/typings/src/_packages/documents.index.d.ts",
97
97
  "peerDependencies": {
98
- "@promptbook/core": "0.103.0-45"
98
+ "@promptbook/core": "0.103.0-46"
99
99
  },
100
100
  "dependencies": {
101
101
  "colors": "^1.4.0",
package/umd/index.umd.js CHANGED
@@ -25,7 +25,7 @@
25
25
  * @generated
26
26
  * @see https://github.com/webgptorg/promptbook
27
27
  */
28
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-45';
28
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-46';
29
29
  /**
30
30
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
31
31
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2051,6 +2051,8 @@
2051
2051
  * Function `validatePipelineString` will validate the if the string is a valid pipeline string
2052
2052
  * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
2053
2053
  *
2054
+ * Note: [🔂] This function is idempotent.
2055
+ *
2054
2056
  * @param {string} pipelineString the candidate for a pipeline string
2055
2057
  * @returns {PipelineString} the same string as input, but validated as valid
2056
2058
  * @throws {ParseError} if the string is not a valid pipeline string
@@ -2640,6 +2642,8 @@
2640
2642
  * - if it is valid json
2641
2643
  * - if it is meaningful
2642
2644
  *
2645
+ * Note: [🔂] This function is idempotent.
2646
+ *
2643
2647
  * @param pipeline valid or invalid PipelineJson
2644
2648
  * @returns the same pipeline if it is logically valid
2645
2649
  * @throws {PipelineLogicError} on logical error in the pipeline
@@ -6075,6 +6079,8 @@
6075
6079
  * This function provides a common abstraction for result validation that can be used
6076
6080
  * by both execution logic and caching logic to ensure consistency.
6077
6081
  *
6082
+ * Note: [🔂] This function is idempotent.
6083
+ *
6078
6084
  * @param options - The validation options including result string, expectations, and format
6079
6085
  * @returns Validation result with processed string and validity status
6080
6086
  * @private internal function of `createPipelineExecutor` and `cacheLlmTools`