librebot-tools 0.4.4 → 0.4.6
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/README.md +38 -13
- package/package.json +6 -2
- package/schema/v1/bot-yaml-schema.json +3 -3
- package/src/contract.d.ts +34 -0
- package/src/contract.js +50 -0
- package/src/index.d.ts +4 -8
- package/src/index.js +16 -1
- package/src/parse.js +1 -1
- package/src/validate.js +11 -26
- package/test/custom-roles.test.mjs +93 -0
- package/test/gitlab-triggers.test.mjs +1 -1
package/README.md
CHANGED
|
@@ -64,7 +64,18 @@ Rules:
|
|
|
64
64
|
bindings belong to instances. Connectors retain unique labels and platform
|
|
65
65
|
identities. Knowledge source IDs remain portable references.
|
|
66
66
|
- `modelRoles[]` accepts optional `requirements: { tools?, vision?,
|
|
67
|
-
|
|
67
|
+
- reasoning?, minContextWindow? }`, validated and preserved end to end.
|
|
68
|
+
- Role ids are `default` (required), the reserved OMP built-ins `smol`,
|
|
69
|
+
- `slow`, `plan`, or custom ids such as `frontend_dev_model`: start with a
|
|
70
|
+
- letter or digit, then letters/digits with `-`/`_` only, max 64 chars.
|
|
71
|
+
- Custom ids must avoid all reserved ids: the four built-ins plus the OMP
|
|
72
|
+
- built-in names `vision`, `commit`, `tiny`, `memory`, `task`, `advisor`,
|
|
73
|
+
- `widget`, `image`, `web`, `speech`, `dictation`, `judge` and the unsafe
|
|
74
|
+
- object keys `__proto__`, `constructor`, `prototype` (no dots).
|
|
75
|
+
- Up to 8 roles may be declared. A trigger `deciderRole` may name any
|
|
76
|
+
- declared role. Custom roles never inherit workspace model defaults: every
|
|
77
|
+
- custom role needs an explicit instance model binding, while defaults cover
|
|
78
|
+
- the built-ins only.
|
|
68
79
|
- `knowledge/README.md` is the index, not an entry. Every other file under
|
|
69
80
|
`knowledge/` is one knowledge asset: UTF-8 text inlines as `content`;
|
|
70
81
|
anything else is returned as an `assets[]` entry
|
|
@@ -122,6 +133,17 @@ import {
|
|
|
122
133
|
throws for invalid source (filesystem failures throw natively).
|
|
123
134
|
`parseBotSource(dir)` throws `BotSourceError` (with `.errors[]` /
|
|
124
135
|
`.warnings[]`) instead. Same contract for `validateFiles` / `parseBotFiles`.
|
|
136
|
+
- `librebot-tools/contract` exports the portable vocabulary with no Node
|
|
137
|
+
dependencies, so browsers can import it too: `FORMAT_VERSION`,
|
|
138
|
+
`MODEL_ROLES` (reserved OMP built-ins `default`, `smol`, `slow`, `plan`),
|
|
139
|
+
`BUILT_IN_MODEL_ROLES` (alias), `MAX_MODEL_ROLES` (8),
|
|
140
|
+
`CUSTOM_MODEL_ROLE_ID_RE`, `isBuiltInModelRole`, `isCustomModelRoleId`,
|
|
141
|
+
`isModelRoleId`, plus `REPO_CAPABILITIES`, `GITREPO_TRIGGER_EVENT_TYPES`,
|
|
142
|
+
`WHATSAPP_CAPABILITIES`, `WHATSAPP_TRIGGER_EVENT_TYPES` (frozen arrays), and
|
|
143
|
+
the derived `ModelRoleId` (generic string: built-in or custom),
|
|
144
|
+
`BuiltInModelRoleId`, `RepoCapability`, `WhatsAppCapability`,
|
|
145
|
+
`GitrepoTriggerEventType`, and `WhatsAppTriggerEventType` types. The root
|
|
146
|
+
entry re-exports the same values.
|
|
125
147
|
- No author-configured shell commands are executed. Standard skill
|
|
126
148
|
installation uses fixed CLI arguments only after explicit local
|
|
127
149
|
`--network --vendor` consent; source locators are passed as arguments,
|
|
@@ -215,15 +237,13 @@ through `npx --package=... librebot`.
|
|
|
215
237
|
|
|
216
238
|
## Platform integration
|
|
217
239
|
|
|
218
|
-
- The platform consumes
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
Authoring environments must receive this exact local bundle rather than
|
|
226
|
-
substituting an older public CLI pin, `main`, or `latest`.
|
|
240
|
+
- The platform consumes an exact public source archive of this checkout,
|
|
241
|
+
- `https://codeload.github.com/librebot-work/tools/tar.gz/<40-char-SHA>`,
|
|
242
|
+
- never a local path or a `git+https` spec (minimal validator images lack
|
|
243
|
+
- git). Refresh the pin to the commit that carries the needed contract and
|
|
244
|
+
- update the platform dependency and lockfile against that archive URL.
|
|
245
|
+
- Authoring environments must receive this exact archive rather than
|
|
246
|
+
- substituting an older public CLI pin, `main`, or `latest`.
|
|
227
247
|
- Portable `actions` also accept `kind: whatsapp` with only `read_messages`,
|
|
228
248
|
`send_text`, `set_reaction`, and `remove_reaction`. Repository capabilities
|
|
229
249
|
remain exclusive to `gitrepo`. Exact sender-phone bindings, independent read
|
|
@@ -232,8 +252,11 @@ through `npx --package=... librebot`.
|
|
|
232
252
|
contract; 0.4.2 replaces the scaffold README with a user-manual skeleton;
|
|
233
253
|
0.4.3 adds the `publish_attachments` repository capability; 0.4.4 adds the
|
|
234
254
|
`merge_change_request` repository capability and the
|
|
235
|
-
`change_request.checks_updated` trigger event.
|
|
236
|
-
|
|
255
|
+
`change_request.checks_updated` trigger event; 0.4.6 adds custom model role
|
|
256
|
+
ids (up to 8 roles including `default`; workspace defaults stay built-in-only
|
|
257
|
+
while custom roles require explicit instance bindings).
|
|
258
|
+
Custom-role sources require tooling at 0.4.6 or newer; 0.4.5 accepts only
|
|
259
|
+
`default`, `smol`, `slow`, `plan`.
|
|
237
260
|
- Portable WhatsApp triggers use `kind: whatsapp`, semantic `message.created`
|
|
238
261
|
and/or `reaction.changed`, and the existing keyed decider definition fields.
|
|
239
262
|
Event namespaces are checked against the selected trigger kind.
|
|
@@ -265,7 +288,9 @@ export round-trips, and skill-lock reproducibility.
|
|
|
265
288
|
|
|
266
289
|
750 KB draft cap (UTF-8 bytes); knowledge <= 100 entries (files + `knowledgeSources`
|
|
267
290
|
combined); skills <= 100; connectors <= 50; triggers <= 20; workspace
|
|
268
|
-
mounts <= 10; model roles 1-
|
|
291
|
+
mounts <= 10; model roles 1-8 including `default` (reserved built-ins
|
|
292
|
+
`default`, `smol`, `slow`, `plan` plus custom ids such as `frontend_dev_model`);
|
|
293
|
+
SKILL.md <= 50,000 bytes
|
|
269
294
|
and non-empty; text knowledge <= 100,000 chars inline (empty files inline
|
|
270
295
|
as empty content, matching platform acceptance); knowledge assets
|
|
271
296
|
<= 10 MiB; skill supporting files <= 1 MiB each.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "librebot-tools",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.6",
|
|
4
4
|
"description": "Public source-format tooling for Librebot bots: parse, validate, preview, scaffold, and skill-lock resolution.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"scripts": {
|
|
@@ -14,11 +14,15 @@
|
|
|
14
14
|
".": {
|
|
15
15
|
"types": "./src/index.d.ts",
|
|
16
16
|
"default": "./src/index.js"
|
|
17
|
+
},
|
|
18
|
+
"./contract": {
|
|
19
|
+
"types": "./src/contract.d.ts",
|
|
20
|
+
"default": "./src/contract.js"
|
|
17
21
|
}
|
|
18
22
|
},
|
|
19
23
|
"types": "./src/index.d.ts",
|
|
20
24
|
"bin": {
|
|
21
|
-
"librebot": "
|
|
25
|
+
"librebot": "bin/librebot.js"
|
|
22
26
|
},
|
|
23
27
|
"files": [
|
|
24
28
|
"src/",
|
|
@@ -20,13 +20,13 @@
|
|
|
20
20
|
"modelRoles": {
|
|
21
21
|
"type": "array",
|
|
22
22
|
"minItems": 1,
|
|
23
|
-
"maxItems":
|
|
23
|
+
"maxItems": 8,
|
|
24
24
|
"items": {
|
|
25
25
|
"type": "object",
|
|
26
26
|
"additionalProperties": false,
|
|
27
27
|
"required": ["role", "label"],
|
|
28
28
|
"properties": {
|
|
29
|
-
"role": { "enum": ["default", "smol", "slow", "plan"] },
|
|
29
|
+
"role": { "anyOf": [{ "enum": ["default", "smol", "slow", "plan"] }, { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "not": { "enum": ["vision", "commit", "tiny", "memory", "task", "advisor", "widget", "image", "web", "speech", "dictation", "judge", "__proto__", "constructor", "prototype"] } }], "description": "Built-in roles default, smol, slow, plan or a custom id (letters/digits with -/_, max 64 chars). Reserved OMP built-in names and object keys are rejected; a default role is always required." },
|
|
30
30
|
"label": { "type": "string", "minLength": 1, "maxLength": 100 },
|
|
31
31
|
"requirements": {
|
|
32
32
|
"type": "object",
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
}
|
|
97
97
|
}
|
|
98
98
|
},
|
|
99
|
-
"deciderRole": { "enum": ["default", "smol", "slow", "plan"] },
|
|
99
|
+
"deciderRole": { "anyOf": [{ "enum": ["default", "smol", "slow", "plan"] }, { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "not": { "enum": ["vision", "commit", "tiny", "memory", "task", "advisor", "widget", "image", "web", "speech", "dictation", "judge", "__proto__", "constructor", "prototype"] } }], "description": "Any role declared in modelRoles: a built-in or a custom role id. Custom roles need an explicit instance binding." },
|
|
100
100
|
"deciderInstructions": { "type": "string", "minLength": 1, "maxLength": 20000 },
|
|
101
101
|
"enabledByDefault": { "type": "boolean" }
|
|
102
102
|
},
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
export const FORMAT_VERSION: 1;
|
|
2
|
+
export const MODEL_ROLES: readonly ["default", "smol", "slow", "plan"];
|
|
3
|
+
export const BUILT_IN_MODEL_ROLES: readonly ["default", "smol", "slow", "plan"];
|
|
4
|
+
export const MAX_MODEL_ROLES: 8;
|
|
5
|
+
export const RESERVED_MODEL_ROLE_IDS: readonly string[];
|
|
6
|
+
export const CUSTOM_MODEL_ROLE_ID_RE: RegExp;
|
|
7
|
+
export function isReservedModelRoleId(role: string): boolean;
|
|
8
|
+
export function isBuiltInModelRole(role: string): role is BuiltInModelRoleId;
|
|
9
|
+
export function isCustomModelRoleId(role: string): boolean;
|
|
10
|
+
export function isModelRoleId(role: string): role is ModelRoleId;
|
|
11
|
+
export const REPO_CAPABILITIES: readonly [
|
|
12
|
+
"read_issue", "push_branch", "propose_change", "comment_issue",
|
|
13
|
+
"search_issues", "read_change_request", "read_repository",
|
|
14
|
+
"update_issue_labels", "react_issue", "update_issue_body", "update_issue_title",
|
|
15
|
+
"publish_attachments", "merge_change_request",
|
|
16
|
+
];
|
|
17
|
+
export const GITREPO_TRIGGER_EVENT_TYPES: readonly [
|
|
18
|
+
"issue.opened", "issue.updated", "issue.closed", "issue.reopened",
|
|
19
|
+
"issue.comment.created", "issue.comment.updated",
|
|
20
|
+
"change_request.opened", "change_request.updated", "change_request.closed",
|
|
21
|
+
"change_request.reopened", "change_request.merged", "change_request.commits_updated",
|
|
22
|
+
"change_request.checks_updated",
|
|
23
|
+
"change_request.comment.created", "change_request.comment.updated",
|
|
24
|
+
"change_request.approval_changed", "repository.pushed",
|
|
25
|
+
];
|
|
26
|
+
export const WHATSAPP_CAPABILITIES: readonly ["read_messages", "send_text", "set_reaction", "remove_reaction"];
|
|
27
|
+
export const WHATSAPP_TRIGGER_EVENT_TYPES: readonly ["message.created", "reaction.changed"];
|
|
28
|
+
|
|
29
|
+
export type BuiltInModelRoleId = typeof MODEL_ROLES[number];
|
|
30
|
+
export type ModelRoleId = string;
|
|
31
|
+
export type RepoCapability = typeof REPO_CAPABILITIES[number];
|
|
32
|
+
export type GitrepoTriggerEventType = typeof GITREPO_TRIGGER_EVENT_TYPES[number];
|
|
33
|
+
export type WhatsAppCapability = typeof WHATSAPP_CAPABILITIES[number];
|
|
34
|
+
export type WhatsAppTriggerEventType = typeof WHATSAPP_TRIGGER_EVENT_TYPES[number];
|
package/src/contract.js
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
// Portable source-contract vocabulary. Dependency-free and browser-safe so
|
|
2
|
+
// platform UIs and servers can import it (`librebot-tools/contract`) instead
|
|
3
|
+
// of keeping their own copies of these lists.
|
|
4
|
+
|
|
5
|
+
export const FORMAT_VERSION = 1;
|
|
6
|
+
export const MODEL_ROLES = Object.freeze(["default", "smol", "slow", "plan"]);
|
|
7
|
+
export const BUILT_IN_MODEL_ROLES = MODEL_ROLES;
|
|
8
|
+
export const MAX_MODEL_ROLES = 8;
|
|
9
|
+
// Reserved ids beyond the four portable built-ins: OMP built-in agent/model
|
|
10
|
+
// role names plus dangerous object keys. Custom ids must avoid all of these;
|
|
11
|
+
// only default/smol/slow/plan are portable workspace defaults.
|
|
12
|
+
export const RESERVED_MODEL_ROLE_IDS = Object.freeze([
|
|
13
|
+
"default", "smol", "slow", "plan",
|
|
14
|
+
"vision", "commit", "tiny", "memory", "task", "advisor", "widget",
|
|
15
|
+
"image", "web", "speech", "dictation", "judge",
|
|
16
|
+
"__proto__", "constructor", "prototype",
|
|
17
|
+
]);
|
|
18
|
+
export function isReservedModelRoleId(role) {
|
|
19
|
+
return RESERVED_MODEL_ROLE_IDS.includes(role);
|
|
20
|
+
}
|
|
21
|
+
// Custom model role ids: safe slugs that never collide with reserved OMP
|
|
22
|
+
// built-in names. Dots are excluded so role ids stay usable as binding keys
|
|
23
|
+
// and selectors.
|
|
24
|
+
export const CUSTOM_MODEL_ROLE_ID_RE = /^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$/;
|
|
25
|
+
export function isBuiltInModelRole(role) {
|
|
26
|
+
return MODEL_ROLES.includes(role);
|
|
27
|
+
}
|
|
28
|
+
export function isCustomModelRoleId(role) {
|
|
29
|
+
return typeof role === "string" && CUSTOM_MODEL_ROLE_ID_RE.test(role) && !isReservedModelRoleId(role);
|
|
30
|
+
}
|
|
31
|
+
export function isModelRoleId(role) {
|
|
32
|
+
return isBuiltInModelRole(role) || isCustomModelRoleId(role);
|
|
33
|
+
}
|
|
34
|
+
export const REPO_CAPABILITIES = Object.freeze([
|
|
35
|
+
"read_issue", "push_branch", "propose_change", "comment_issue",
|
|
36
|
+
"search_issues", "read_change_request", "read_repository",
|
|
37
|
+
"update_issue_labels", "react_issue", "update_issue_body", "update_issue_title",
|
|
38
|
+
"publish_attachments", "merge_change_request",
|
|
39
|
+
]);
|
|
40
|
+
export const GITREPO_TRIGGER_EVENT_TYPES = Object.freeze([
|
|
41
|
+
"issue.opened", "issue.updated", "issue.closed", "issue.reopened",
|
|
42
|
+
"issue.comment.created", "issue.comment.updated",
|
|
43
|
+
"change_request.opened", "change_request.updated", "change_request.closed",
|
|
44
|
+
"change_request.reopened", "change_request.merged", "change_request.commits_updated",
|
|
45
|
+
"change_request.checks_updated",
|
|
46
|
+
"change_request.comment.created", "change_request.comment.updated",
|
|
47
|
+
"change_request.approval_changed", "repository.pushed",
|
|
48
|
+
]);
|
|
49
|
+
export const WHATSAPP_CAPABILITIES = Object.freeze(["read_messages", "send_text", "set_reaction", "remove_reaction"]);
|
|
50
|
+
export const WHATSAPP_TRIGGER_EVENT_TYPES = Object.freeze(["message.created", "reaction.changed"]);
|
package/src/index.d.ts
CHANGED
|
@@ -1,10 +1,6 @@
|
|
|
1
|
-
export type RepoCapability = "read_issue" | "push_branch" | "propose_change" | "comment_issue" | "search_issues" | "read_change_request" | "read_repository" | "update_issue_labels" | "react_issue" | "update_issue_body" | "update_issue_title" | "publish_attachments" | "merge_change_request";
|
|
2
|
-
export type WhatsAppCapability = "read_messages" | "send_text" | "set_reaction" | "remove_reaction";
|
|
3
|
-
export const FORMAT_VERSION: 1;
|
|
4
|
-
export const MODEL_ROLES: string[];
|
|
5
|
-
export const REPO_CAPABILITIES: RepoCapability[];
|
|
6
|
-
export const GITREPO_TRIGGER_EVENT_TYPES: string[];
|
|
7
1
|
// Type definitions for librebot-tools (hand-written; no build step).
|
|
2
|
+
import type { ModelRoleId, RepoCapability, WhatsAppCapability } from "./contract.js";
|
|
3
|
+
export * from "./contract.js";
|
|
8
4
|
|
|
9
5
|
export interface SourceIssue {
|
|
10
6
|
file: string;
|
|
@@ -20,7 +16,7 @@ export interface ModelRequirements {
|
|
|
20
16
|
}
|
|
21
17
|
|
|
22
18
|
export interface BotModelRole {
|
|
23
|
-
role:
|
|
19
|
+
role: ModelRoleId;
|
|
24
20
|
label: string;
|
|
25
21
|
requirements: ModelRequirements;
|
|
26
22
|
}
|
|
@@ -62,7 +58,7 @@ export interface BotDraft {
|
|
|
62
58
|
knowledge: BotKnowledge[];
|
|
63
59
|
skills: BotSkill[];
|
|
64
60
|
connectors: BotConnector[];
|
|
65
|
-
triggers: Array<{ key: string; label: string; kind: "gitrepo" | "whatsapp"; eventTypes: string[]; description?: string; inputs?: Array<{ key: string; label?: string; type: "string" | "number" | "boolean" | "select"; required?: boolean; options?: string[]; help?: string }>; deciderRole?:
|
|
61
|
+
triggers: Array<{ key: string; label: string; kind: "gitrepo" | "whatsapp"; eventTypes: string[]; description?: string; inputs?: Array<{ key: string; label?: string; type: "string" | "number" | "boolean" | "select"; required?: boolean; options?: string[]; help?: string }>; deciderRole?: ModelRoleId; deciderInstructions: string; enabledByDefault?: boolean }>;
|
|
66
62
|
workspace: Array<{ key: string; label?: string; path: string }>;
|
|
67
63
|
actions: Array<{ key: string; kind: "gitrepo"; label?: string; capabilities: RepoCapability[] } | { key: string; kind: "whatsapp"; label?: string; capabilities: WhatsAppCapability[] }>;
|
|
68
64
|
icon?: string;
|
package/src/index.js
CHANGED
|
@@ -46,5 +46,20 @@ export {
|
|
|
46
46
|
} from "./scaffold.js";
|
|
47
47
|
export { SCHEMA_VERSIONS, loadSchema } from "./schema.js";
|
|
48
48
|
export { canonicalJson, sha256Hex, toBytes } from "./util.js";
|
|
49
|
-
export {
|
|
49
|
+
export {
|
|
50
|
+
BUILT_IN_MODEL_ROLES,
|
|
51
|
+
CUSTOM_MODEL_ROLE_ID_RE,
|
|
52
|
+
FORMAT_VERSION,
|
|
53
|
+
MAX_MODEL_ROLES,
|
|
54
|
+
MODEL_ROLES,
|
|
55
|
+
REPO_CAPABILITIES,
|
|
56
|
+
RESERVED_MODEL_ROLE_IDS,
|
|
57
|
+
GITREPO_TRIGGER_EVENT_TYPES,
|
|
58
|
+
WHATSAPP_CAPABILITIES,
|
|
59
|
+
WHATSAPP_TRIGGER_EVENT_TYPES,
|
|
60
|
+
isBuiltInModelRole,
|
|
61
|
+
isCustomModelRoleId,
|
|
62
|
+
isModelRoleId,
|
|
63
|
+
isReservedModelRoleId,
|
|
64
|
+
} from "./contract.js";
|
|
50
65
|
export { validateKnowledgeSources, validateRequirements } from "./validate.js";
|
package/src/parse.js
CHANGED
|
@@ -11,8 +11,8 @@ import { checkSourcesLock, parseSourcesYaml } from "./skills-lock.js";
|
|
|
11
11
|
import { sha256Hex, toBytes } from "./util.js";
|
|
12
12
|
import { vendorContentHash } from "./skills-import.js";
|
|
13
13
|
import { iconPath, validateIcon } from "./icon.js";
|
|
14
|
+
import { FORMAT_VERSION } from "./contract.js";
|
|
14
15
|
import {
|
|
15
|
-
FORMAT_VERSION,
|
|
16
16
|
entryId,
|
|
17
17
|
requiredString,
|
|
18
18
|
validateConnectors,
|
package/src/validate.js
CHANGED
|
@@ -7,24 +7,11 @@
|
|
|
7
7
|
|
|
8
8
|
import { isRecord } from "./errors.js";
|
|
9
9
|
import { sha256Hex } from "./util.js";
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
"search_issues", "read_change_request", "read_repository",
|
|
16
|
-
"update_issue_labels", "react_issue", "update_issue_body", "update_issue_title",
|
|
17
|
-
"publish_attachments", "merge_change_request",
|
|
18
|
-
];
|
|
19
|
-
export const GITREPO_TRIGGER_EVENT_TYPES = [
|
|
20
|
-
"issue.opened", "issue.updated", "issue.closed", "issue.reopened",
|
|
21
|
-
"issue.comment.created", "issue.comment.updated",
|
|
22
|
-
"change_request.opened", "change_request.updated", "change_request.closed",
|
|
23
|
-
"change_request.reopened", "change_request.merged", "change_request.commits_updated",
|
|
24
|
-
"change_request.checks_updated",
|
|
25
|
-
"change_request.comment.created", "change_request.comment.updated",
|
|
26
|
-
"change_request.approval_changed", "repository.pushed",
|
|
27
|
-
];
|
|
10
|
+
import {
|
|
11
|
+
MAX_MODEL_ROLES, REPO_CAPABILITIES, GITREPO_TRIGGER_EVENT_TYPES,
|
|
12
|
+
WHATSAPP_CAPABILITIES, WHATSAPP_TRIGGER_EVENT_TYPES,
|
|
13
|
+
isModelRoleId,
|
|
14
|
+
} from "./contract.js";
|
|
28
15
|
|
|
29
16
|
const ENTRY_ID_RE = /^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$/;
|
|
30
17
|
const INPUT_KEY_RE = /^[A-Za-z_][A-Za-z0-9_]{0,63}$/;
|
|
@@ -196,8 +183,8 @@ function stringList(value, field, sink, file) {
|
|
|
196
183
|
}
|
|
197
184
|
|
|
198
185
|
export function validateModelRoles(input, sink, file) {
|
|
199
|
-
if (!Array.isArray(input) || input.length === 0 || input.length >
|
|
200
|
-
err(sink, file, "modelRoles",
|
|
186
|
+
if (!Array.isArray(input) || input.length === 0 || input.length > MAX_MODEL_ROLES) {
|
|
187
|
+
err(sink, file, "modelRoles", `must declare 1-${MAX_MODEL_ROLES} roles including default`);
|
|
201
188
|
return [];
|
|
202
189
|
}
|
|
203
190
|
const seen = {};
|
|
@@ -209,8 +196,8 @@ export function validateModelRoles(input, sink, file) {
|
|
|
209
196
|
return;
|
|
210
197
|
}
|
|
211
198
|
checkKeys(entry, ["role", "label", "requirements"], field, sink, file);
|
|
212
|
-
if (typeof entry.role !== "string" || !
|
|
213
|
-
err(sink, file, `${field}.role`, "must be
|
|
199
|
+
if (typeof entry.role !== "string" || !isModelRoleId(entry.role)) {
|
|
200
|
+
err(sink, file, `${field}.role`, "must be default, smol, slow, plan, or a custom id of letters/digits with -/_ (max 64 chars, starting alphanumeric, not a reserved OMP or object key)");
|
|
214
201
|
return;
|
|
215
202
|
}
|
|
216
203
|
if (seen[entry.role]) {
|
|
@@ -549,8 +536,6 @@ export function validateWorkspaceMounts(input, sink, file) {
|
|
|
549
536
|
return mounts;
|
|
550
537
|
}
|
|
551
538
|
|
|
552
|
-
export const WHATSAPP_CAPABILITIES = ["read_messages", "send_text", "set_reaction", "remove_reaction"];
|
|
553
|
-
export const WHATSAPP_TRIGGER_EVENT_TYPES = ["message.created", "reaction.changed"];
|
|
554
539
|
export function validateActions(input, sink, file) {
|
|
555
540
|
if (input === undefined) return [];
|
|
556
541
|
if (!Array.isArray(input) || input.length > 20) {
|
|
@@ -823,12 +808,12 @@ export function validateTriggerDefinitions(input, sink, file) {
|
|
|
823
808
|
definition.inputs = inputs;
|
|
824
809
|
}
|
|
825
810
|
if (entry.deciderRole !== undefined) {
|
|
826
|
-
if (typeof entry.deciderRole !== "string" || !
|
|
811
|
+
if (typeof entry.deciderRole !== "string" || !isModelRoleId(entry.deciderRole)) {
|
|
827
812
|
err(
|
|
828
813
|
sink,
|
|
829
814
|
file,
|
|
830
815
|
`${field}.deciderRole`,
|
|
831
|
-
"must be
|
|
816
|
+
"must be a declared model role: default, smol, slow, plan, or a custom role id",
|
|
832
817
|
);
|
|
833
818
|
return;
|
|
834
819
|
}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import { describe, it } from "node:test";
|
|
2
|
+
import assert from "node:assert/strict";
|
|
3
|
+
import { validateFiles } from "../src/index.js";
|
|
4
|
+
import {
|
|
5
|
+
BUILT_IN_MODEL_ROLES,
|
|
6
|
+
CUSTOM_MODEL_ROLE_ID_RE,
|
|
7
|
+
MAX_MODEL_ROLES,
|
|
8
|
+
MODEL_ROLES,
|
|
9
|
+
RESERVED_MODEL_ROLE_IDS,
|
|
10
|
+
isBuiltInModelRole,
|
|
11
|
+
isCustomModelRoleId,
|
|
12
|
+
isModelRoleId,
|
|
13
|
+
isReservedModelRoleId,
|
|
14
|
+
} from "../src/contract.js";
|
|
15
|
+
|
|
16
|
+
const base = (yaml) =>
|
|
17
|
+
validateFiles({
|
|
18
|
+
"bot.yaml":
|
|
19
|
+
"formatVersion: 1\nname: T\ndescription: D\nmodelRoles:\n - role: default\n label: Main\n" +
|
|
20
|
+
yaml,
|
|
21
|
+
"instructions.md": "Be helpful.",
|
|
22
|
+
"README.md": "# T",
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
describe("custom model roles", () => {
|
|
26
|
+
it("accepts a safe custom role id alongside default", async () => {
|
|
27
|
+
const result = await base(" - role: frontend_dev_model\n label: Frontend dev\n");
|
|
28
|
+
assert.equal(result.ok, true);
|
|
29
|
+
assert.deepEqual(
|
|
30
|
+
result.draft.modelRoles.map((r) => r.role),
|
|
31
|
+
["default", "frontend_dev_model"],
|
|
32
|
+
);
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
it("keeps built-ins reserved and default mandatory", async () => {
|
|
36
|
+
assert.deepEqual([...MODEL_ROLES], ["default", "smol", "slow", "plan"]);
|
|
37
|
+
assert.equal(BUILT_IN_MODEL_ROLES, MODEL_ROLES);
|
|
38
|
+
assert.equal(MAX_MODEL_ROLES, 8);
|
|
39
|
+
assert.equal(isBuiltInModelRole("default"), true);
|
|
40
|
+
assert.equal(isCustomModelRoleId("default"), false);
|
|
41
|
+
assert.equal(isCustomModelRoleId("frontend_dev_model"), true);
|
|
42
|
+
assert.equal(isModelRoleId("frontend_dev_model"), true);
|
|
43
|
+
assert.equal(isModelRoleId("has.dot"), false);
|
|
44
|
+
assert.match("frontend_dev_model", CUSTOM_MODEL_ROLE_ID_RE);
|
|
45
|
+
const missing = await validateFiles({
|
|
46
|
+
"bot.yaml":
|
|
47
|
+
"formatVersion: 1\nname: T\ndescription: D\nmodelRoles:\n - role: frontend_dev_model\n label: Frontend dev\n",
|
|
48
|
+
"instructions.md": "Be helpful.",
|
|
49
|
+
"README.md": "# T",
|
|
50
|
+
});
|
|
51
|
+
assert.equal(missing.ok, false);
|
|
52
|
+
assert.ok(missing.errors.some((e) => e.field === "modelRoles" && /default/.test(e.message)));
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
it("rejects dotted or oversized role ids", async () => {
|
|
56
|
+
for (const role of ["has.dot", "x".repeat(65), "9-ok_but_long_" + "x".repeat(60)]) {
|
|
57
|
+
const result = await base(` - role: ${role}\n label: Bad\n`);
|
|
58
|
+
assert.equal(result.ok, false, role);
|
|
59
|
+
}
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
it("rejects reserved OMP names and unsafe object keys", async () => {
|
|
63
|
+
for (const reserved of RESERVED_MODEL_ROLE_IDS) assert.equal(isReservedModelRoleId(reserved), true);
|
|
64
|
+
for (const role of ["task", "commit", "vision", "constructor", "prototype", "__proto__"]) {
|
|
65
|
+
assert.equal(isCustomModelRoleId(role), false, role);
|
|
66
|
+
assert.equal(isModelRoleId(role) && !isBuiltInModelRole(role), false, role);
|
|
67
|
+
const result = await base(` - role: ${role}\n label: Reserved\n`);
|
|
68
|
+
assert.equal(result.ok, false, role);
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
it("rejects duplicate roles and more than the role cap", async () => {
|
|
73
|
+
const dup = await base(" - role: smol\n label: S\n - role: smol\n label: S2\n");
|
|
74
|
+
assert.equal(dup.ok, false);
|
|
75
|
+
const many = await base(
|
|
76
|
+
["smol", "slow", "plan", "a", "b", "c", "d", "e"]
|
|
77
|
+
.map((r) => ` - role: ${r}\n label: ${r}\n`)
|
|
78
|
+
.join(""),
|
|
79
|
+
);
|
|
80
|
+
assert.equal(many.ok, false);
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
it("accepts a declared custom deciderRole and rejects undeclared ones", async () => {
|
|
84
|
+
const ok = await base(
|
|
85
|
+
" - role: frontend_dev_model\n label: Frontend dev\ntriggers:\n - key: t\n label: T\n kind: gitrepo\n eventTypes: [issue.opened]\n deciderRole: frontend_dev_model\n deciderInstructions: Decide.\n",
|
|
86
|
+
);
|
|
87
|
+
assert.equal(ok.ok, true);
|
|
88
|
+
const bad = await base(
|
|
89
|
+
"triggers:\n - key: t\n label: T\n kind: gitrepo\n eventTypes: [issue.opened]\n deciderRole: ghost_role\n deciderInstructions: Decide.\n",
|
|
90
|
+
);
|
|
91
|
+
assert.equal(bad.ok, false);
|
|
92
|
+
});
|
|
93
|
+
});
|
|
@@ -6,7 +6,7 @@ import { join } from "node:path";
|
|
|
6
6
|
import { promisify } from "node:util";
|
|
7
7
|
import { execFile } from "node:child_process";
|
|
8
8
|
import { parseBotFiles, scaffoldBotFiles, exportBotFiles } from "../src/index.js";
|
|
9
|
-
import { GITREPO_TRIGGER_EVENT_TYPES } from "../src/
|
|
9
|
+
import { GITREPO_TRIGGER_EVENT_TYPES } from "../src/contract.js";
|
|
10
10
|
|
|
11
11
|
const trigger = (overrides = {}) => ({ key: "project-events", label: "Project events", kind: "gitrepo", eventTypes: ["change_request.opened"], deciderInstructions: "Decide whether to act", ...overrides });
|
|
12
12
|
const source = (triggers) => ({ ...scaffoldBotFiles({ name: "Triggers" }), "bot.yaml": `formatVersion: 1\nname: Triggers\ndescription: D\nmodelRoles: [{role: default, label: Main}]\ntriggers: ${JSON.stringify(triggers)}\n` });
|