@promptbook/javascript 0.111.0-2 → 0.111.0-4
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.
- package/esm/index.es.js +1 -1
- package/esm/typings/src/_packages/utils.index.d.ts +2 -0
- package/esm/typings/src/book-components/Chat/Chat/ChatMessageMap.d.ts +1 -1
- package/esm/typings/src/book-components/Chat/utils/citationHelpers.d.ts +1 -1
- package/esm/typings/src/book-components/Chat/utils/sanitizeStreamingMessageContent.d.ts +19 -0
- package/esm/typings/src/book-components/Chat/utils/sanitizeStreamingMessageContent.test.d.ts +1 -0
- package/esm/typings/src/commitments/USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR.d.ts +2 -2
- package/esm/typings/src/commitments/index.d.ts +1 -1
- package/esm/typings/src/utils/clientVersion.d.ts +14 -0
- package/esm/typings/src/version.d.ts +1 -1
- package/package.json +2 -2
- package/umd/index.umd.js +1 -1
package/esm/index.es.js
CHANGED
|
@@ -18,7 +18,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
|
|
|
18
18
|
* @generated
|
|
19
19
|
* @see https://github.com/webgptorg/promptbook
|
|
20
20
|
*/
|
|
21
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.111.0-
|
|
21
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.111.0-4';
|
|
22
22
|
/**
|
|
23
23
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
24
24
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -16,6 +16,7 @@ import { CLIENT_VERSION_HEADER } from '../utils/clientVersion';
|
|
|
16
16
|
import { CLIENT_LATEST_VERSION } from '../utils/clientVersion';
|
|
17
17
|
import { isClientVersionCompatible } from '../utils/clientVersion';
|
|
18
18
|
import { formatClientVersionMismatchMessage } from '../utils/clientVersion';
|
|
19
|
+
import { ClientVersionMismatchError } from '../utils/clientVersion';
|
|
19
20
|
import { attachClientVersionHeader } from '../utils/clientVersion';
|
|
20
21
|
import { getClientVersionFromHeaders } from '../utils/clientVersion';
|
|
21
22
|
import { $detectRuntimeEnvironment } from '../utils/environment/$detectRuntimeEnvironment';
|
|
@@ -113,6 +114,7 @@ export { CLIENT_VERSION_HEADER };
|
|
|
113
114
|
export { CLIENT_LATEST_VERSION };
|
|
114
115
|
export { isClientVersionCompatible };
|
|
115
116
|
export { formatClientVersionMismatchMessage };
|
|
117
|
+
export { ClientVersionMismatchError };
|
|
116
118
|
export { attachClientVersionHeader };
|
|
117
119
|
export { getClientVersionFromHeaders };
|
|
118
120
|
export { $detectRuntimeEnvironment };
|
|
@@ -9,7 +9,7 @@ type ChatMessageMapProps = {
|
|
|
9
9
|
data: GeoJsonObject;
|
|
10
10
|
};
|
|
11
11
|
/**
|
|
12
|
-
* Renders a Leaflet map for GeoJSON data inside the chat bubble.
|
|
12
|
+
* Renders a Leaflet map for GeoJSON data inside the chat bubble and exposes a modal control for a larger view.
|
|
13
13
|
*
|
|
14
14
|
* @private internal helper of `<ChatMessageItem/>`
|
|
15
15
|
*/
|
|
@@ -35,4 +35,4 @@ export declare function getCitationLabel(citation: ParsedCitation): string;
|
|
|
35
35
|
export declare function resolveCitationPreviewUrl(citation: ParsedCitation, participants: ReadonlyArray<ChatParticipant>): string | null;
|
|
36
36
|
/**
|
|
37
37
|
* TODO: [💞] Spread into multiple files
|
|
38
|
-
*/
|
|
38
|
+
*/
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Options that customize how streaming message content is sanitized.
|
|
3
|
+
*/
|
|
4
|
+
type SanitizeStreamingMessageContentOptions = {
|
|
5
|
+
/**
|
|
6
|
+
* Whether the chat message has finished streaming.
|
|
7
|
+
*/
|
|
8
|
+
isComplete?: boolean;
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Trims trailing rich-feature markup from streaming messages so users do not see raw source while the feature is being generated.
|
|
12
|
+
*
|
|
13
|
+
* @param content - Full markdown text produced by the assistant.
|
|
14
|
+
* @param options - Sanitization options (streaming state).
|
|
15
|
+
* @returns Text that is safe to render during streaming.
|
|
16
|
+
* @private internal helper of <ChatMessageItem/>
|
|
17
|
+
*/
|
|
18
|
+
export declare function sanitizeStreamingMessageContent(content: string, options?: SanitizeStreamingMessageContentOptions): string;
|
|
19
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -15,8 +15,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
|
15
15
|
*
|
|
16
16
|
* @private [🪔] Maybe export the commitments through some package
|
|
17
17
|
*/
|
|
18
|
-
export declare class UseImageGeneratorCommitmentDefinition extends BaseCommitmentDefinition<'USE IMAGE GENERATOR'
|
|
19
|
-
constructor(type?: 'USE IMAGE GENERATOR'
|
|
18
|
+
export declare class UseImageGeneratorCommitmentDefinition extends BaseCommitmentDefinition<'USE IMAGE GENERATOR'> {
|
|
19
|
+
constructor(type?: 'USE IMAGE GENERATOR');
|
|
20
20
|
get requiresContent(): boolean;
|
|
21
21
|
/**
|
|
22
22
|
* Short one-line description of USE IMAGE GENERATOR.
|
|
@@ -44,7 +44,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
|
|
|
44
44
|
*
|
|
45
45
|
* @private Use functions to access commitments instead of this array directly
|
|
46
46
|
*/
|
|
47
|
-
export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, UseEmailCommitmentDefinition, UseImageGeneratorCommitmentDefinition,
|
|
47
|
+
export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, UseEmailCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
|
|
48
48
|
/**
|
|
49
49
|
* TODO: [🧠] Maybe create through standardized $register
|
|
50
50
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -28,6 +28,20 @@ export declare function isClientVersionCompatible(version: unknown): version is
|
|
|
28
28
|
* @public exported from `@promptbook/utils`
|
|
29
29
|
*/
|
|
30
30
|
export declare function formatClientVersionMismatchMessage(clientVersion?: string | null): string;
|
|
31
|
+
/**
|
|
32
|
+
* Error thrown when the client version does not match the server requirements.
|
|
33
|
+
*
|
|
34
|
+
* @param requiredVersion - Version enforced by the server.
|
|
35
|
+
* @param reportedVersion - Version reported by the client (optional).
|
|
36
|
+
* @param message - Optional human-readable message describing the mismatch.
|
|
37
|
+
*
|
|
38
|
+
* @public exported from `@promptbook/utils`
|
|
39
|
+
*/
|
|
40
|
+
export declare class ClientVersionMismatchError extends Error {
|
|
41
|
+
readonly requiredVersion: string;
|
|
42
|
+
readonly reportedVersion: string | null;
|
|
43
|
+
constructor(requiredVersion: string, reportedVersion: string | null, message?: string);
|
|
44
|
+
}
|
|
31
45
|
/**
|
|
32
46
|
* Creates a headers object that includes the client version header.
|
|
33
47
|
*
|
|
@@ -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.111.0-
|
|
18
|
+
* It follows semantic versioning (e.g., `0.111.0-3`).
|
|
19
19
|
*
|
|
20
20
|
* @generated
|
|
21
21
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promptbook/javascript",
|
|
3
|
-
"version": "0.111.0-
|
|
3
|
+
"version": "0.111.0-4",
|
|
4
4
|
"description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
"module": "./esm/index.es.js",
|
|
98
98
|
"typings": "./esm/typings/src/_packages/javascript.index.d.ts",
|
|
99
99
|
"peerDependencies": {
|
|
100
|
-
"@promptbook/core": "0.111.0-
|
|
100
|
+
"@promptbook/core": "0.111.0-4"
|
|
101
101
|
},
|
|
102
102
|
"dependencies": {
|
|
103
103
|
"crypto": "1.0.1",
|
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.111.0-
|
|
25
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.111.0-4';
|
|
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
|