@promptbook/remote-client 0.112.0-44 → 0.112.0-45
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/src/avatars/Avatar.d.ts +7 -0
- package/esm/src/avatars/avatarRenderingUtils.d.ts +117 -0
- package/esm/src/avatars/index.d.ts +6 -0
- package/esm/src/avatars/renderAvatarVisual.d.ts +9 -0
- package/esm/src/avatars/types/AvatarDefinition.d.ts +20 -0
- package/esm/src/avatars/types/AvatarVisualDefinition.d.ts +96 -0
- package/esm/src/avatars/visuals/avatarVisualRegistry.d.ts +16 -0
- package/esm/src/avatars/visuals/minecraftAvatarVisual.d.ts +7 -0
- package/esm/src/avatars/visuals/octopusAvatarVisual.d.ts +7 -0
- package/esm/src/avatars/visuals/pixelArtAvatarVisual.d.ts +7 -0
- package/esm/src/commitments/STYLE/STYLE.d.ts +9 -2
- package/esm/src/version.d.ts +1 -1
- package/package.json +2 -2
- package/umd/index.umd.js +1 -1
- package/umd/src/avatars/Avatar.d.ts +7 -0
- package/umd/src/avatars/avatarRenderingUtils.d.ts +117 -0
- package/umd/src/avatars/index.d.ts +6 -0
- package/umd/src/avatars/renderAvatarVisual.d.ts +9 -0
- package/umd/src/avatars/types/AvatarDefinition.d.ts +20 -0
- package/umd/src/avatars/types/AvatarVisualDefinition.d.ts +96 -0
- package/umd/src/avatars/visuals/avatarVisualRegistry.d.ts +16 -0
- package/umd/src/avatars/visuals/minecraftAvatarVisual.d.ts +7 -0
- package/umd/src/avatars/visuals/octopusAvatarVisual.d.ts +7 -0
- package/umd/src/avatars/visuals/pixelArtAvatarVisual.d.ts +7 -0
- package/umd/src/commitments/STYLE/STYLE.d.ts +9 -2
- package/umd/src/version.d.ts +1 -1
package/esm/index.es.js
CHANGED
|
@@ -20,7 +20,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
|
|
|
20
20
|
* @generated
|
|
21
21
|
* @see https://github.com/webgptorg/promptbook
|
|
22
22
|
*/
|
|
23
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.112.0-
|
|
23
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.112.0-45';
|
|
24
24
|
/**
|
|
25
25
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
26
26
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { AvatarProps } from './types/AvatarVisualDefinition';
|
|
2
|
+
/**
|
|
3
|
+
* Canvas-based deterministic avatar component.
|
|
4
|
+
*
|
|
5
|
+
* @private shared component for in-repository avatar previews
|
|
6
|
+
*/
|
|
7
|
+
export declare function Avatar(props: AvatarProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import type { AgentBasicInformation } from '../book-2.0/agent-source/AgentBasicInformation';
|
|
2
|
+
import type { string_color } from '../types/typeAliases';
|
|
3
|
+
import type { AvatarDefinition } from './types/AvatarDefinition';
|
|
4
|
+
import type { AvatarPalette } from './types/AvatarVisualDefinition';
|
|
5
|
+
/**
|
|
6
|
+
* Default square size used by avatar renderers.
|
|
7
|
+
*
|
|
8
|
+
* @private utility of the avatar rendering system
|
|
9
|
+
*/
|
|
10
|
+
export declare const DEFAULT_AVATAR_SIZE = 192;
|
|
11
|
+
/**
|
|
12
|
+
* Normalizes arbitrary agent colors into a stable non-empty color list.
|
|
13
|
+
*
|
|
14
|
+
* @param colors Raw color list.
|
|
15
|
+
* @returns Stable list of usable colors.
|
|
16
|
+
*
|
|
17
|
+
* @private utility of the avatar rendering system
|
|
18
|
+
*/
|
|
19
|
+
export declare function normalizeAvatarColors(colors: ReadonlyArray<string_color>): ReadonlyArray<string_color>;
|
|
20
|
+
/**
|
|
21
|
+
* Normalizes the avatar input so visuals can rely on consistent data.
|
|
22
|
+
*
|
|
23
|
+
* @param avatarDefinition Raw avatar input.
|
|
24
|
+
* @returns Normalized avatar definition.
|
|
25
|
+
*
|
|
26
|
+
* @private utility of the avatar rendering system
|
|
27
|
+
*/
|
|
28
|
+
export declare function normalizeAvatarDefinition(avatarDefinition: AvatarDefinition): AvatarDefinition;
|
|
29
|
+
/**
|
|
30
|
+
* Extracts avatar colors from the flexible `META COLOR` agent field.
|
|
31
|
+
*
|
|
32
|
+
* @param colorValue Raw `META COLOR` value.
|
|
33
|
+
* @returns Parsed avatar colors.
|
|
34
|
+
*
|
|
35
|
+
* @private utility of the avatar rendering system
|
|
36
|
+
*/
|
|
37
|
+
export declare function parseAvatarColors(colorValue: string | undefined): ReadonlyArray<string_color>;
|
|
38
|
+
/**
|
|
39
|
+
* Creates a reusable avatar definition from parsed agent information.
|
|
40
|
+
*
|
|
41
|
+
* @param agentBasicInformation Parsed agent information.
|
|
42
|
+
* @returns Avatar definition ready for canvas rendering.
|
|
43
|
+
*
|
|
44
|
+
* @private shared helper for app-level avatar previews
|
|
45
|
+
*/
|
|
46
|
+
export declare function createAvatarDefinitionFromAgentBasicInformation(agentBasicInformation: Pick<AgentBasicInformation, 'agentName' | 'agentHash' | 'meta'>): AvatarDefinition;
|
|
47
|
+
/**
|
|
48
|
+
* Creates the shared derived palette used by every avatar visual.
|
|
49
|
+
*
|
|
50
|
+
* @param avatarDefinition Stable avatar definition.
|
|
51
|
+
* @returns Derived palette.
|
|
52
|
+
*
|
|
53
|
+
* @private utility of the avatar rendering system
|
|
54
|
+
*/
|
|
55
|
+
export declare function createAvatarPalette(avatarDefinition: AvatarDefinition): AvatarPalette;
|
|
56
|
+
/**
|
|
57
|
+
* Draws the common rounded background frame used by most visuals.
|
|
58
|
+
*
|
|
59
|
+
* @param context Canvas 2D context.
|
|
60
|
+
* @param size Canvas size in CSS pixels.
|
|
61
|
+
* @param palette Derived avatar palette.
|
|
62
|
+
*
|
|
63
|
+
* @private utility of the avatar rendering system
|
|
64
|
+
*/
|
|
65
|
+
export declare function drawAvatarFrame(context: CanvasRenderingContext2D, size: number, palette: AvatarPalette): void;
|
|
66
|
+
/**
|
|
67
|
+
* Creates a rounded rectangle path on the current canvas context.
|
|
68
|
+
*
|
|
69
|
+
* @param context Canvas 2D context.
|
|
70
|
+
* @param x Left coordinate.
|
|
71
|
+
* @param y Top coordinate.
|
|
72
|
+
* @param width Rectangle width.
|
|
73
|
+
* @param height Rectangle height.
|
|
74
|
+
* @param radius Corner radius.
|
|
75
|
+
*
|
|
76
|
+
* @private utility of the avatar rendering system
|
|
77
|
+
*/
|
|
78
|
+
export declare function createRoundedRectPath(context: CanvasRenderingContext2D, x: number, y: number, width: number, height: number, radius: number): void;
|
|
79
|
+
/**
|
|
80
|
+
* Creates a stable pseudo-random number generator from a string seed.
|
|
81
|
+
*
|
|
82
|
+
* @param seedSource String seed.
|
|
83
|
+
* @returns Generator producing values in `[0, 1)`.
|
|
84
|
+
*
|
|
85
|
+
* @private utility of the avatar rendering system
|
|
86
|
+
*/
|
|
87
|
+
export declare function createSeededRandom(seedSource: string): () => number;
|
|
88
|
+
/**
|
|
89
|
+
* Creates a deterministic random factory scoped to the avatar definition.
|
|
90
|
+
*
|
|
91
|
+
* @param avatarDefinition Stable avatar definition.
|
|
92
|
+
* @returns Random factory that can be re-seeded per visual part.
|
|
93
|
+
*
|
|
94
|
+
* @private utility of the avatar rendering system
|
|
95
|
+
*/
|
|
96
|
+
export declare function createAvatarRandomFactory(avatarDefinition: AvatarDefinition): (salt: string) => () => number;
|
|
97
|
+
/**
|
|
98
|
+
* Clears and scales the canvas for crisp avatar rendering on high DPI displays.
|
|
99
|
+
*
|
|
100
|
+
* @param canvas Canvas element to prepare.
|
|
101
|
+
* @param context Canvas 2D context.
|
|
102
|
+
* @param size Canvas size in CSS pixels.
|
|
103
|
+
* @param devicePixelRatio Device pixel ratio.
|
|
104
|
+
*
|
|
105
|
+
* @private utility of the avatar rendering system
|
|
106
|
+
*/
|
|
107
|
+
export declare function prepareAvatarCanvas(canvas: HTMLCanvasElement, context: CanvasRenderingContext2D, size: number, devicePixelRatio: number): void;
|
|
108
|
+
/**
|
|
109
|
+
* Picks one deterministic element from a non-empty collection.
|
|
110
|
+
*
|
|
111
|
+
* @param items Candidate items.
|
|
112
|
+
* @param random Seeded random generator.
|
|
113
|
+
* @returns Picked item.
|
|
114
|
+
*
|
|
115
|
+
* @private utility of the avatar rendering system
|
|
116
|
+
*/
|
|
117
|
+
export declare function pickRandomItem<T>(items: ReadonlyArray<T>, random: () => number): T;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export { Avatar } from './Avatar';
|
|
2
|
+
export { renderAvatarVisual } from './renderAvatarVisual';
|
|
3
|
+
export { createAvatarDefinitionFromAgentBasicInformation } from './avatarRenderingUtils';
|
|
4
|
+
export { AVATAR_VISUALS, getAvatarVisualById } from './visuals/avatarVisualRegistry';
|
|
5
|
+
export type { AvatarDefinition } from './types/AvatarDefinition';
|
|
6
|
+
export type { AvatarPalette, AvatarProps, AvatarVisual, AvatarVisualDefinition, AvatarVisualId, AvatarVisualRenderContext, RenderAvatarVisualOptions, } from './types/AvatarVisualDefinition';
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { RenderAvatarVisualOptions } from './types/AvatarVisualDefinition';
|
|
2
|
+
/**
|
|
3
|
+
* Renders one deterministic avatar frame into the provided canvas.
|
|
4
|
+
*
|
|
5
|
+
* @param options Rendering options.
|
|
6
|
+
*
|
|
7
|
+
* @private shared helper for canvas avatar rendering
|
|
8
|
+
*/
|
|
9
|
+
export declare function renderAvatarVisual(options: RenderAvatarVisualOptions): void;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { string_agent_hash, string_agent_name, string_color } from '../../types/typeAliases';
|
|
2
|
+
/**
|
|
3
|
+
* Normalized identity payload used by all canvas avatar visuals.
|
|
4
|
+
*
|
|
5
|
+
* @private shared contract for the avatar rendering system
|
|
6
|
+
*/
|
|
7
|
+
export type AvatarDefinition = {
|
|
8
|
+
/**
|
|
9
|
+
* Human-readable name of the agent.
|
|
10
|
+
*/
|
|
11
|
+
readonly agentName: string_agent_name;
|
|
12
|
+
/**
|
|
13
|
+
* Stable hash of the agent.
|
|
14
|
+
*/
|
|
15
|
+
readonly agentHash: string_agent_hash;
|
|
16
|
+
/**
|
|
17
|
+
* Ordered list of agent colors used to derive a palette.
|
|
18
|
+
*/
|
|
19
|
+
readonly colors: ReadonlyArray<string_color>;
|
|
20
|
+
};
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import type { string_color, string_css_class } from '../../types/typeAliases';
|
|
2
|
+
import type { AvatarDefinition } from './AvatarDefinition';
|
|
3
|
+
/**
|
|
4
|
+
* Supported built-in avatar visual identifiers.
|
|
5
|
+
*
|
|
6
|
+
* @private shared contract for the avatar rendering system
|
|
7
|
+
*/
|
|
8
|
+
export type AvatarVisualId = 'pixel-art' | 'octopus' | 'minecraft';
|
|
9
|
+
/**
|
|
10
|
+
* Derived color palette used by avatar visuals.
|
|
11
|
+
*
|
|
12
|
+
* @private shared contract for the avatar rendering system
|
|
13
|
+
*/
|
|
14
|
+
export type AvatarPalette = {
|
|
15
|
+
readonly background: string_color;
|
|
16
|
+
readonly backgroundSecondary: string_color;
|
|
17
|
+
readonly primary: string_color;
|
|
18
|
+
readonly secondary: string_color;
|
|
19
|
+
readonly accent: string_color;
|
|
20
|
+
readonly highlight: string_color;
|
|
21
|
+
readonly shadow: string_color;
|
|
22
|
+
readonly ink: string_color;
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* Rendering context forwarded to a single avatar visual.
|
|
26
|
+
*
|
|
27
|
+
* @private shared contract for the avatar rendering system
|
|
28
|
+
*/
|
|
29
|
+
export type AvatarVisualRenderContext = {
|
|
30
|
+
readonly canvas: HTMLCanvasElement;
|
|
31
|
+
readonly context: CanvasRenderingContext2D;
|
|
32
|
+
readonly size: number;
|
|
33
|
+
readonly devicePixelRatio: number;
|
|
34
|
+
readonly timeMs: number;
|
|
35
|
+
readonly avatarDefinition: AvatarDefinition;
|
|
36
|
+
readonly palette: AvatarPalette;
|
|
37
|
+
readonly createRandom: (salt: string) => () => number;
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* Signature of one canvas-based avatar visual renderer.
|
|
41
|
+
*
|
|
42
|
+
* @private shared contract for the avatar rendering system
|
|
43
|
+
*/
|
|
44
|
+
export type AvatarVisual = (context: AvatarVisualRenderContext) => void;
|
|
45
|
+
/**
|
|
46
|
+
* Metadata and renderer for one built-in avatar visual.
|
|
47
|
+
*
|
|
48
|
+
* @private shared contract for the avatar rendering system
|
|
49
|
+
*/
|
|
50
|
+
export type AvatarVisualDefinition = {
|
|
51
|
+
readonly id: AvatarVisualId;
|
|
52
|
+
readonly title: string;
|
|
53
|
+
readonly description: string;
|
|
54
|
+
readonly isAnimated: boolean;
|
|
55
|
+
readonly render: AvatarVisual;
|
|
56
|
+
};
|
|
57
|
+
/**
|
|
58
|
+
* Props of the shared `<Avatar/>` component.
|
|
59
|
+
*
|
|
60
|
+
* @private shared contract for the avatar rendering system
|
|
61
|
+
*/
|
|
62
|
+
export type AvatarProps = {
|
|
63
|
+
/**
|
|
64
|
+
* Stable visual identity for the rendered avatar.
|
|
65
|
+
*/
|
|
66
|
+
readonly avatarDefinition: AvatarDefinition;
|
|
67
|
+
/**
|
|
68
|
+
* Selected visual style.
|
|
69
|
+
*/
|
|
70
|
+
readonly visualId: AvatarVisualId;
|
|
71
|
+
/**
|
|
72
|
+
* Output size in CSS pixels.
|
|
73
|
+
*/
|
|
74
|
+
readonly size?: number;
|
|
75
|
+
/**
|
|
76
|
+
* Optional canvas title.
|
|
77
|
+
*/
|
|
78
|
+
readonly title?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Optional CSS class name applied to the canvas.
|
|
81
|
+
*/
|
|
82
|
+
readonly className?: string_css_class;
|
|
83
|
+
};
|
|
84
|
+
/**
|
|
85
|
+
* Low-level rendering options for a single canvas frame.
|
|
86
|
+
*
|
|
87
|
+
* @private shared contract for the avatar rendering system
|
|
88
|
+
*/
|
|
89
|
+
export type RenderAvatarVisualOptions = {
|
|
90
|
+
readonly canvas: HTMLCanvasElement;
|
|
91
|
+
readonly avatarDefinition: AvatarDefinition;
|
|
92
|
+
readonly visualId: AvatarVisualId;
|
|
93
|
+
readonly size: number;
|
|
94
|
+
readonly timeMs: number;
|
|
95
|
+
readonly devicePixelRatio?: number;
|
|
96
|
+
};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { AvatarVisualDefinition, AvatarVisualId } from '../types/AvatarVisualDefinition';
|
|
2
|
+
/**
|
|
3
|
+
* Built-in avatar visuals available to the app.
|
|
4
|
+
*
|
|
5
|
+
* @private shared registry for the avatar rendering system
|
|
6
|
+
*/
|
|
7
|
+
export declare const AVATAR_VISUALS: ReadonlyArray<AvatarVisualDefinition>;
|
|
8
|
+
/**
|
|
9
|
+
* Returns one avatar visual by its identifier.
|
|
10
|
+
*
|
|
11
|
+
* @param visualId Requested visual identifier.
|
|
12
|
+
* @returns Matching visual definition.
|
|
13
|
+
*
|
|
14
|
+
* @private shared registry for the avatar rendering system
|
|
15
|
+
*/
|
|
16
|
+
export declare function getAvatarVisualById(visualId: AvatarVisualId): AvatarVisualDefinition;
|
|
@@ -3,8 +3,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
|
3
3
|
/**
|
|
4
4
|
* STYLE commitment definition
|
|
5
5
|
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
6
|
+
* Deprecated legacy writing-style commitment kept for backward compatibility.
|
|
7
|
+
* New books should prefer `WRITING RULES` for writing-only constraints.
|
|
8
8
|
*
|
|
9
9
|
* Example usage in agent source:
|
|
10
10
|
*
|
|
@@ -21,6 +21,13 @@ export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<
|
|
|
21
21
|
* Short one-line description of STYLE.
|
|
22
22
|
*/
|
|
23
23
|
get description(): string;
|
|
24
|
+
/**
|
|
25
|
+
* Optional UI/docs-only deprecation metadata.
|
|
26
|
+
*/
|
|
27
|
+
get deprecation(): {
|
|
28
|
+
readonly message: "Use `WRITING RULES` for writing-only constraints such as tone, length, formatting, or emoji usage.";
|
|
29
|
+
readonly replacedBy: readonly ["WRITING RULES"];
|
|
30
|
+
};
|
|
24
31
|
/**
|
|
25
32
|
* Icon for this commitment.
|
|
26
33
|
*/
|
package/esm/src/version.d.ts
CHANGED
|
@@ -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-
|
|
18
|
+
* It follows semantic versioning (e.g., `0.112.0-44`).
|
|
19
19
|
*
|
|
20
20
|
* @generated
|
|
21
21
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promptbook/remote-client",
|
|
3
|
-
"version": "0.112.0-
|
|
3
|
+
"version": "0.112.0-45",
|
|
4
4
|
"description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
"module": "./esm/index.es.js",
|
|
104
104
|
"typings": "./esm/typings/src/_packages/remote-client.index.d.ts",
|
|
105
105
|
"peerDependencies": {
|
|
106
|
-
"@promptbook/core": "0.112.0-
|
|
106
|
+
"@promptbook/core": "0.112.0-45"
|
|
107
107
|
},
|
|
108
108
|
"dependencies": {
|
|
109
109
|
"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.112.0-
|
|
25
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.112.0-45';
|
|
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
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { AvatarProps } from './types/AvatarVisualDefinition';
|
|
2
|
+
/**
|
|
3
|
+
* Canvas-based deterministic avatar component.
|
|
4
|
+
*
|
|
5
|
+
* @private shared component for in-repository avatar previews
|
|
6
|
+
*/
|
|
7
|
+
export declare function Avatar(props: AvatarProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import type { AgentBasicInformation } from '../book-2.0/agent-source/AgentBasicInformation';
|
|
2
|
+
import type { string_color } from '../types/typeAliases';
|
|
3
|
+
import type { AvatarDefinition } from './types/AvatarDefinition';
|
|
4
|
+
import type { AvatarPalette } from './types/AvatarVisualDefinition';
|
|
5
|
+
/**
|
|
6
|
+
* Default square size used by avatar renderers.
|
|
7
|
+
*
|
|
8
|
+
* @private utility of the avatar rendering system
|
|
9
|
+
*/
|
|
10
|
+
export declare const DEFAULT_AVATAR_SIZE = 192;
|
|
11
|
+
/**
|
|
12
|
+
* Normalizes arbitrary agent colors into a stable non-empty color list.
|
|
13
|
+
*
|
|
14
|
+
* @param colors Raw color list.
|
|
15
|
+
* @returns Stable list of usable colors.
|
|
16
|
+
*
|
|
17
|
+
* @private utility of the avatar rendering system
|
|
18
|
+
*/
|
|
19
|
+
export declare function normalizeAvatarColors(colors: ReadonlyArray<string_color>): ReadonlyArray<string_color>;
|
|
20
|
+
/**
|
|
21
|
+
* Normalizes the avatar input so visuals can rely on consistent data.
|
|
22
|
+
*
|
|
23
|
+
* @param avatarDefinition Raw avatar input.
|
|
24
|
+
* @returns Normalized avatar definition.
|
|
25
|
+
*
|
|
26
|
+
* @private utility of the avatar rendering system
|
|
27
|
+
*/
|
|
28
|
+
export declare function normalizeAvatarDefinition(avatarDefinition: AvatarDefinition): AvatarDefinition;
|
|
29
|
+
/**
|
|
30
|
+
* Extracts avatar colors from the flexible `META COLOR` agent field.
|
|
31
|
+
*
|
|
32
|
+
* @param colorValue Raw `META COLOR` value.
|
|
33
|
+
* @returns Parsed avatar colors.
|
|
34
|
+
*
|
|
35
|
+
* @private utility of the avatar rendering system
|
|
36
|
+
*/
|
|
37
|
+
export declare function parseAvatarColors(colorValue: string | undefined): ReadonlyArray<string_color>;
|
|
38
|
+
/**
|
|
39
|
+
* Creates a reusable avatar definition from parsed agent information.
|
|
40
|
+
*
|
|
41
|
+
* @param agentBasicInformation Parsed agent information.
|
|
42
|
+
* @returns Avatar definition ready for canvas rendering.
|
|
43
|
+
*
|
|
44
|
+
* @private shared helper for app-level avatar previews
|
|
45
|
+
*/
|
|
46
|
+
export declare function createAvatarDefinitionFromAgentBasicInformation(agentBasicInformation: Pick<AgentBasicInformation, 'agentName' | 'agentHash' | 'meta'>): AvatarDefinition;
|
|
47
|
+
/**
|
|
48
|
+
* Creates the shared derived palette used by every avatar visual.
|
|
49
|
+
*
|
|
50
|
+
* @param avatarDefinition Stable avatar definition.
|
|
51
|
+
* @returns Derived palette.
|
|
52
|
+
*
|
|
53
|
+
* @private utility of the avatar rendering system
|
|
54
|
+
*/
|
|
55
|
+
export declare function createAvatarPalette(avatarDefinition: AvatarDefinition): AvatarPalette;
|
|
56
|
+
/**
|
|
57
|
+
* Draws the common rounded background frame used by most visuals.
|
|
58
|
+
*
|
|
59
|
+
* @param context Canvas 2D context.
|
|
60
|
+
* @param size Canvas size in CSS pixels.
|
|
61
|
+
* @param palette Derived avatar palette.
|
|
62
|
+
*
|
|
63
|
+
* @private utility of the avatar rendering system
|
|
64
|
+
*/
|
|
65
|
+
export declare function drawAvatarFrame(context: CanvasRenderingContext2D, size: number, palette: AvatarPalette): void;
|
|
66
|
+
/**
|
|
67
|
+
* Creates a rounded rectangle path on the current canvas context.
|
|
68
|
+
*
|
|
69
|
+
* @param context Canvas 2D context.
|
|
70
|
+
* @param x Left coordinate.
|
|
71
|
+
* @param y Top coordinate.
|
|
72
|
+
* @param width Rectangle width.
|
|
73
|
+
* @param height Rectangle height.
|
|
74
|
+
* @param radius Corner radius.
|
|
75
|
+
*
|
|
76
|
+
* @private utility of the avatar rendering system
|
|
77
|
+
*/
|
|
78
|
+
export declare function createRoundedRectPath(context: CanvasRenderingContext2D, x: number, y: number, width: number, height: number, radius: number): void;
|
|
79
|
+
/**
|
|
80
|
+
* Creates a stable pseudo-random number generator from a string seed.
|
|
81
|
+
*
|
|
82
|
+
* @param seedSource String seed.
|
|
83
|
+
* @returns Generator producing values in `[0, 1)`.
|
|
84
|
+
*
|
|
85
|
+
* @private utility of the avatar rendering system
|
|
86
|
+
*/
|
|
87
|
+
export declare function createSeededRandom(seedSource: string): () => number;
|
|
88
|
+
/**
|
|
89
|
+
* Creates a deterministic random factory scoped to the avatar definition.
|
|
90
|
+
*
|
|
91
|
+
* @param avatarDefinition Stable avatar definition.
|
|
92
|
+
* @returns Random factory that can be re-seeded per visual part.
|
|
93
|
+
*
|
|
94
|
+
* @private utility of the avatar rendering system
|
|
95
|
+
*/
|
|
96
|
+
export declare function createAvatarRandomFactory(avatarDefinition: AvatarDefinition): (salt: string) => () => number;
|
|
97
|
+
/**
|
|
98
|
+
* Clears and scales the canvas for crisp avatar rendering on high DPI displays.
|
|
99
|
+
*
|
|
100
|
+
* @param canvas Canvas element to prepare.
|
|
101
|
+
* @param context Canvas 2D context.
|
|
102
|
+
* @param size Canvas size in CSS pixels.
|
|
103
|
+
* @param devicePixelRatio Device pixel ratio.
|
|
104
|
+
*
|
|
105
|
+
* @private utility of the avatar rendering system
|
|
106
|
+
*/
|
|
107
|
+
export declare function prepareAvatarCanvas(canvas: HTMLCanvasElement, context: CanvasRenderingContext2D, size: number, devicePixelRatio: number): void;
|
|
108
|
+
/**
|
|
109
|
+
* Picks one deterministic element from a non-empty collection.
|
|
110
|
+
*
|
|
111
|
+
* @param items Candidate items.
|
|
112
|
+
* @param random Seeded random generator.
|
|
113
|
+
* @returns Picked item.
|
|
114
|
+
*
|
|
115
|
+
* @private utility of the avatar rendering system
|
|
116
|
+
*/
|
|
117
|
+
export declare function pickRandomItem<T>(items: ReadonlyArray<T>, random: () => number): T;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export { Avatar } from './Avatar';
|
|
2
|
+
export { renderAvatarVisual } from './renderAvatarVisual';
|
|
3
|
+
export { createAvatarDefinitionFromAgentBasicInformation } from './avatarRenderingUtils';
|
|
4
|
+
export { AVATAR_VISUALS, getAvatarVisualById } from './visuals/avatarVisualRegistry';
|
|
5
|
+
export type { AvatarDefinition } from './types/AvatarDefinition';
|
|
6
|
+
export type { AvatarPalette, AvatarProps, AvatarVisual, AvatarVisualDefinition, AvatarVisualId, AvatarVisualRenderContext, RenderAvatarVisualOptions, } from './types/AvatarVisualDefinition';
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { RenderAvatarVisualOptions } from './types/AvatarVisualDefinition';
|
|
2
|
+
/**
|
|
3
|
+
* Renders one deterministic avatar frame into the provided canvas.
|
|
4
|
+
*
|
|
5
|
+
* @param options Rendering options.
|
|
6
|
+
*
|
|
7
|
+
* @private shared helper for canvas avatar rendering
|
|
8
|
+
*/
|
|
9
|
+
export declare function renderAvatarVisual(options: RenderAvatarVisualOptions): void;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { string_agent_hash, string_agent_name, string_color } from '../../types/typeAliases';
|
|
2
|
+
/**
|
|
3
|
+
* Normalized identity payload used by all canvas avatar visuals.
|
|
4
|
+
*
|
|
5
|
+
* @private shared contract for the avatar rendering system
|
|
6
|
+
*/
|
|
7
|
+
export type AvatarDefinition = {
|
|
8
|
+
/**
|
|
9
|
+
* Human-readable name of the agent.
|
|
10
|
+
*/
|
|
11
|
+
readonly agentName: string_agent_name;
|
|
12
|
+
/**
|
|
13
|
+
* Stable hash of the agent.
|
|
14
|
+
*/
|
|
15
|
+
readonly agentHash: string_agent_hash;
|
|
16
|
+
/**
|
|
17
|
+
* Ordered list of agent colors used to derive a palette.
|
|
18
|
+
*/
|
|
19
|
+
readonly colors: ReadonlyArray<string_color>;
|
|
20
|
+
};
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import type { string_color, string_css_class } from '../../types/typeAliases';
|
|
2
|
+
import type { AvatarDefinition } from './AvatarDefinition';
|
|
3
|
+
/**
|
|
4
|
+
* Supported built-in avatar visual identifiers.
|
|
5
|
+
*
|
|
6
|
+
* @private shared contract for the avatar rendering system
|
|
7
|
+
*/
|
|
8
|
+
export type AvatarVisualId = 'pixel-art' | 'octopus' | 'minecraft';
|
|
9
|
+
/**
|
|
10
|
+
* Derived color palette used by avatar visuals.
|
|
11
|
+
*
|
|
12
|
+
* @private shared contract for the avatar rendering system
|
|
13
|
+
*/
|
|
14
|
+
export type AvatarPalette = {
|
|
15
|
+
readonly background: string_color;
|
|
16
|
+
readonly backgroundSecondary: string_color;
|
|
17
|
+
readonly primary: string_color;
|
|
18
|
+
readonly secondary: string_color;
|
|
19
|
+
readonly accent: string_color;
|
|
20
|
+
readonly highlight: string_color;
|
|
21
|
+
readonly shadow: string_color;
|
|
22
|
+
readonly ink: string_color;
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* Rendering context forwarded to a single avatar visual.
|
|
26
|
+
*
|
|
27
|
+
* @private shared contract for the avatar rendering system
|
|
28
|
+
*/
|
|
29
|
+
export type AvatarVisualRenderContext = {
|
|
30
|
+
readonly canvas: HTMLCanvasElement;
|
|
31
|
+
readonly context: CanvasRenderingContext2D;
|
|
32
|
+
readonly size: number;
|
|
33
|
+
readonly devicePixelRatio: number;
|
|
34
|
+
readonly timeMs: number;
|
|
35
|
+
readonly avatarDefinition: AvatarDefinition;
|
|
36
|
+
readonly palette: AvatarPalette;
|
|
37
|
+
readonly createRandom: (salt: string) => () => number;
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* Signature of one canvas-based avatar visual renderer.
|
|
41
|
+
*
|
|
42
|
+
* @private shared contract for the avatar rendering system
|
|
43
|
+
*/
|
|
44
|
+
export type AvatarVisual = (context: AvatarVisualRenderContext) => void;
|
|
45
|
+
/**
|
|
46
|
+
* Metadata and renderer for one built-in avatar visual.
|
|
47
|
+
*
|
|
48
|
+
* @private shared contract for the avatar rendering system
|
|
49
|
+
*/
|
|
50
|
+
export type AvatarVisualDefinition = {
|
|
51
|
+
readonly id: AvatarVisualId;
|
|
52
|
+
readonly title: string;
|
|
53
|
+
readonly description: string;
|
|
54
|
+
readonly isAnimated: boolean;
|
|
55
|
+
readonly render: AvatarVisual;
|
|
56
|
+
};
|
|
57
|
+
/**
|
|
58
|
+
* Props of the shared `<Avatar/>` component.
|
|
59
|
+
*
|
|
60
|
+
* @private shared contract for the avatar rendering system
|
|
61
|
+
*/
|
|
62
|
+
export type AvatarProps = {
|
|
63
|
+
/**
|
|
64
|
+
* Stable visual identity for the rendered avatar.
|
|
65
|
+
*/
|
|
66
|
+
readonly avatarDefinition: AvatarDefinition;
|
|
67
|
+
/**
|
|
68
|
+
* Selected visual style.
|
|
69
|
+
*/
|
|
70
|
+
readonly visualId: AvatarVisualId;
|
|
71
|
+
/**
|
|
72
|
+
* Output size in CSS pixels.
|
|
73
|
+
*/
|
|
74
|
+
readonly size?: number;
|
|
75
|
+
/**
|
|
76
|
+
* Optional canvas title.
|
|
77
|
+
*/
|
|
78
|
+
readonly title?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Optional CSS class name applied to the canvas.
|
|
81
|
+
*/
|
|
82
|
+
readonly className?: string_css_class;
|
|
83
|
+
};
|
|
84
|
+
/**
|
|
85
|
+
* Low-level rendering options for a single canvas frame.
|
|
86
|
+
*
|
|
87
|
+
* @private shared contract for the avatar rendering system
|
|
88
|
+
*/
|
|
89
|
+
export type RenderAvatarVisualOptions = {
|
|
90
|
+
readonly canvas: HTMLCanvasElement;
|
|
91
|
+
readonly avatarDefinition: AvatarDefinition;
|
|
92
|
+
readonly visualId: AvatarVisualId;
|
|
93
|
+
readonly size: number;
|
|
94
|
+
readonly timeMs: number;
|
|
95
|
+
readonly devicePixelRatio?: number;
|
|
96
|
+
};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { AvatarVisualDefinition, AvatarVisualId } from '../types/AvatarVisualDefinition';
|
|
2
|
+
/**
|
|
3
|
+
* Built-in avatar visuals available to the app.
|
|
4
|
+
*
|
|
5
|
+
* @private shared registry for the avatar rendering system
|
|
6
|
+
*/
|
|
7
|
+
export declare const AVATAR_VISUALS: ReadonlyArray<AvatarVisualDefinition>;
|
|
8
|
+
/**
|
|
9
|
+
* Returns one avatar visual by its identifier.
|
|
10
|
+
*
|
|
11
|
+
* @param visualId Requested visual identifier.
|
|
12
|
+
* @returns Matching visual definition.
|
|
13
|
+
*
|
|
14
|
+
* @private shared registry for the avatar rendering system
|
|
15
|
+
*/
|
|
16
|
+
export declare function getAvatarVisualById(visualId: AvatarVisualId): AvatarVisualDefinition;
|
|
@@ -3,8 +3,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
|
3
3
|
/**
|
|
4
4
|
* STYLE commitment definition
|
|
5
5
|
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
6
|
+
* Deprecated legacy writing-style commitment kept for backward compatibility.
|
|
7
|
+
* New books should prefer `WRITING RULES` for writing-only constraints.
|
|
8
8
|
*
|
|
9
9
|
* Example usage in agent source:
|
|
10
10
|
*
|
|
@@ -21,6 +21,13 @@ export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<
|
|
|
21
21
|
* Short one-line description of STYLE.
|
|
22
22
|
*/
|
|
23
23
|
get description(): string;
|
|
24
|
+
/**
|
|
25
|
+
* Optional UI/docs-only deprecation metadata.
|
|
26
|
+
*/
|
|
27
|
+
get deprecation(): {
|
|
28
|
+
readonly message: "Use `WRITING RULES` for writing-only constraints such as tone, length, formatting, or emoji usage.";
|
|
29
|
+
readonly replacedBy: readonly ["WRITING RULES"];
|
|
30
|
+
};
|
|
24
31
|
/**
|
|
25
32
|
* Icon for this commitment.
|
|
26
33
|
*/
|
package/umd/src/version.d.ts
CHANGED
|
@@ -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-
|
|
18
|
+
* It follows semantic versioning (e.g., `0.112.0-44`).
|
|
19
19
|
*
|
|
20
20
|
* @generated
|
|
21
21
|
*/
|