@rudderhq/agent-runtime-opencode-local 0.7.2-canary.0 → 0.7.3
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/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -2
- package/dist/server/index.d.ts +1 -1
- package/dist/server/index.d.ts.map +1 -1
- package/dist/server/index.js +1 -1
- package/dist/server/index.js.map +1 -1
- package/dist/server/models.d.ts.map +1 -1
- package/dist/server/models.js +86 -4
- package/dist/server/models.js.map +1 -1
- package/dist/server/models.test.js +31 -0
- package/dist/server/models.test.js.map +1 -1
- package/package.json +2 -2
- package/skills/app-builder/SKILL.md +39 -9
- package/skills/app-builder/assets/scaffold/app/globals.css +109 -16
- package/skills/app-builder/assets/scaffold/components/contacts-workspace.tsx +176 -152
- package/skills/app-builder/assets/scaffold/components/ui/alert.tsx +12 -0
- package/skills/app-builder/assets/scaffold/components/ui/badge.tsx +27 -0
- package/skills/app-builder/assets/scaffold/components/ui/button.tsx +9 -7
- package/skills/app-builder/assets/scaffold/components/ui/card.tsx +15 -3
- package/skills/app-builder/assets/scaffold/components/ui/empty.tsx +18 -0
- package/skills/app-builder/assets/scaffold/components/ui/field.tsx +23 -0
- package/skills/app-builder/assets/scaffold/components/ui/input.tsx +1 -1
- package/skills/app-builder/assets/scaffold/components/ui/label.tsx +1 -1
- package/skills/app-builder/assets/scaffold/components/ui/separator.tsx +6 -0
- package/skills/app-builder/assets/scaffold/components/ui/skeleton.tsx +6 -0
- package/skills/app-builder/assets/scaffold/components/ui/table.tsx +30 -0
- package/skills/app-builder/assets/scaffold/components.json +20 -0
- package/skills/app-builder/assets/scaffold/next-env.d.ts +1 -1
- package/skills/app-builder/assets/scaffold/next.config.ts +19 -0
- package/skills/app-builder/assets/scaffold/package.json +2 -1
- package/skills/app-builder/assets/scaffold/rudder.app.json +1 -1
- package/skills/app-builder/assets/scaffold/rudder.ui.json +13 -0
- package/skills/app-builder/assets/scaffold/scripts/validate-rudder-ui.mjs +50 -0
- package/skills/app-builder/assets/scaffold/tests/e2e/app.spec.ts +35 -1
- package/skills/app-builder/evals/evals.json +2 -1
- package/skills/app-builder/references/design-guidelines.md +19 -2
- package/skills/app-builder/references/rudder-ui-preset.md +73 -0
- package/skills/app-builder/references/scaffold-contract.md +12 -0
- package/skills/app-builder/references/verification.md +6 -0
- package/skills/app-builder/scripts/report-build-status.mjs +83 -0
- package/skills/browser/SKILL.md +11 -4
- package/skills/browser/agents/openai.yaml +2 -2
- package/skills/browser/evals/trigger-evals.json +22 -0
- package/skills/rudder-docs/SKILL.md +2 -2
- package/skills/rudder-docs/evals/retrieval-authority-evals.json +40 -0
- package/skills/rudder-docs/evals/trigger-evals.json +2 -2
- package/skills/rudder-docs/references/api-reference.md +0 -2
- package/skills/rudder-docs/references/plugin-authoring.md +38 -114
- package/skills/rudder-docs/references/source-map.md +2 -0
|
@@ -1,116 +1,40 @@
|
|
|
1
1
|
# Plugin Authoring
|
|
2
2
|
|
|
3
|
-
Use this
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
`doc/engineering/
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
-
|
|
27
|
-
|
|
28
|
-
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
Use `create-rudder-plugin` instead of hand-writing boilerplate. In a Rudder
|
|
42
|
-
checkout, first build the scaffold package, then run its generated CLI for the
|
|
43
|
-
requested npm package name and output root. `--output` names the parent
|
|
44
|
-
directory; the CLI appends the package basename, and that destination must not
|
|
45
|
-
already exist. Verify the exact commands in
|
|
46
|
-
the current authoring guide before execution.
|
|
47
|
-
|
|
48
|
-
For a repository-local package, the scaffold uses `workspace:*` for
|
|
49
|
-
`@rudderhq/plugin-sdk`. For an external package, pass `--sdk-path` pointing to
|
|
50
|
-
the checkout's `packages/plugins/sdk`; the scaffold snapshots the SDK/shared
|
|
51
|
-
packages into `.rudder-sdk/` so the Plugin can build and test before an npm
|
|
52
|
-
publication exists.
|
|
53
|
-
|
|
54
|
-
The generated package should include:
|
|
55
|
-
|
|
56
|
-
- `src/manifest.ts`;
|
|
57
|
-
- `src/worker.ts`;
|
|
58
|
-
- `src/ui/index.tsx` when UI is used;
|
|
59
|
-
- `tests/plugin.spec.ts`;
|
|
60
|
-
- `package.json` and current build configuration.
|
|
61
|
-
|
|
62
|
-
Scaffold only under the explicit output root and confirm the derived package
|
|
63
|
-
directory before execution. Do not install the generated Plugin into a running
|
|
64
|
-
Rudder instance unless the user also requested that host mutation.
|
|
65
|
-
|
|
66
|
-
## Implement Within Current Boundaries
|
|
67
|
-
|
|
68
|
-
Review the manifest, worker, UI, and tests together:
|
|
69
|
-
|
|
70
|
-
- Declare only capabilities used by the worker-side host APIs.
|
|
71
|
-
- Keep tool names Plugin-namespaced; they must not shadow core or other Plugin
|
|
72
|
-
tools.
|
|
73
|
-
- Keep UI self-contained. Rudder does not provide a shared Plugin React
|
|
74
|
-
component kit yet.
|
|
75
|
-
- Do not use `ctx.assets`; it is not supported in the current runtime.
|
|
76
|
-
- Use `routePath` only for a `page` slot. It must be one lowercase slug and may
|
|
77
|
-
not collide with a reserved host route or another installed Plugin page.
|
|
78
|
-
- Use the SDK's declared worker, UI, testing, bundler, and dev-server surfaces
|
|
79
|
-
rather than undocumented application internals.
|
|
80
|
-
- Treat jobs and webhooks as namespaced external execution surfaces and keep
|
|
81
|
-
their capabilities, ownership, logs, and failure evidence explicit.
|
|
82
|
-
|
|
83
|
-
Local development installs must use an absolute filesystem path. The server
|
|
84
|
-
can watch a local-path Plugin and restart its worker after rebuilds, but that
|
|
85
|
-
does not make a repo-local checkout a production deployment artifact.
|
|
86
|
-
|
|
87
|
-
## Wire A Bundled Example Only When Requested
|
|
88
|
-
|
|
89
|
-
Only if the user explicitly asks for bundled example or discoverable host
|
|
90
|
-
wiring, update the host's bundled-example list and the documentation that
|
|
91
|
-
enumerates in-repo examples. A request to scaffold or develop a Plugin alone
|
|
92
|
-
does not authorize changing `server/src/routes/plugins.ts` or other host
|
|
93
|
-
registration surfaces.
|
|
94
|
-
|
|
95
|
-
If host runtime, SDK, capability validation, static UI serving, or lifecycle
|
|
96
|
-
code changes, follow the repository's Plugin engineering and Product Logic
|
|
97
|
-
rules in addition to the package workflow.
|
|
98
|
-
|
|
99
|
-
## Verify The Package And Host
|
|
100
|
-
|
|
101
|
-
At minimum, run the generated or existing Plugin package's:
|
|
102
|
-
|
|
103
|
-
- `typecheck`;
|
|
104
|
-
- `test`; and
|
|
105
|
-
- `build`.
|
|
106
|
-
|
|
107
|
-
Use the package scripts or the monorepo's `pnpm --filter <plugin-package>`
|
|
108
|
-
forms. For a new scaffold, execute them in a temporary or explicitly requested
|
|
109
|
-
target and confirm that its worker, manifest, UI bundle, and
|
|
110
|
-
`tests/plugin.spec.ts` compile against the selected SDK layout.
|
|
111
|
-
|
|
112
|
-
When host or SDK code changed, also run the relevant host integration tests,
|
|
113
|
-
repository typecheck, test suite, and build. If the user asked to install the
|
|
114
|
-
Plugin, verify the real host from its absolute local path and surface worker
|
|
115
|
-
health, logs, route behavior, and capability failures. Package creation alone
|
|
116
|
-
is not evidence that a Plugin is installed or active in Rudder.
|
|
3
|
+
Use this reference for explicit requests to create, inspect, import, or verify a
|
|
4
|
+
Rudder Plugin. Rudder V1 consumes the Codex Plugin package format and does not
|
|
5
|
+
provide a Plugin worker SDK or extension runtime.
|
|
6
|
+
|
|
7
|
+
## Before Writing
|
|
8
|
+
|
|
9
|
+
- Confirm the requested target directory and whether the package needs Skills,
|
|
10
|
+
MCP definitions, App aliases, or a combination.
|
|
11
|
+
- Read `doc/engineering/PLUGIN_AUTHORING_GUIDE.md` and the current upstream
|
|
12
|
+
Codex Plugin manifest specification.
|
|
13
|
+
- Keep the required manifest at `.codex-plugin/plugin.json` with a lower-case
|
|
14
|
+
hyphenated name and strict semantic version.
|
|
15
|
+
- Do not recreate legacy Rudder workers, jobs, webhooks, UI slots, generic
|
|
16
|
+
state, host tools, or SDK dependencies.
|
|
17
|
+
|
|
18
|
+
## Component Rules
|
|
19
|
+
|
|
20
|
+
- Put Skills at the default `skills/<slug>/SKILL.md` location or declare the
|
|
21
|
+
custom root in the manifest. Keep each Skill's scripts and references inside
|
|
22
|
+
its root.
|
|
23
|
+
- Declare MCP servers inline or through `.mcp.json`. Use environment references
|
|
24
|
+
for credentials; never embed tokens, passwords, authorization headers, or API
|
|
25
|
+
keys in the package.
|
|
26
|
+
- Treat `.app.json` as OpenAI registered App aliases only. It is not a Rudder
|
|
27
|
+
Local App definition or an MCP endpoint.
|
|
28
|
+
- Hooks, assets, and unknown fields may be preserved but are not executable in
|
|
29
|
+
Rudder V1.
|
|
30
|
+
|
|
31
|
+
## Rudder Verification
|
|
32
|
+
|
|
33
|
+
Import only when the user requested that Organization mutation. Use Plugins >
|
|
34
|
+
Import and review the compatibility report. Verify inspection executes nothing.
|
|
35
|
+
After installation, verify the public workflow relevant to the
|
|
36
|
+
package: Agent Skill assignment, Managed MCP setup, Local App launch,
|
|
37
|
+
disable/re-enable, and non-destructive uninstall.
|
|
38
|
+
|
|
39
|
+
Package creation is not evidence of installation. Installation is not evidence
|
|
40
|
+
that MCP credentials or Agent access are active. Keep those states explicit.
|
|
@@ -48,6 +48,8 @@ Other lookup pages are similarly narrow:
|
|
|
48
48
|
| Workspace and file placement | `https://docs.rudderhq.dev/reference/workspace-boundaries` | `https://docs.rudderhq.dev/zh/reference/workspace-boundaries` |
|
|
49
49
|
| Automation result destinations | `https://docs.rudderhq.dev/reference/automation-output-routing` | `https://docs.rudderhq.dev/zh/reference/automation-output-routing` |
|
|
50
50
|
| Deployment trust, credentials, Browser, and platform behavior | `https://docs.rudderhq.dev/reference/permissions-and-platforms` | `https://docs.rudderhq.dev/zh/reference/permissions-and-platforms` |
|
|
51
|
+
| Windows Desktop release signing policy | `https://docs.rudderhq.dev/reference/code-signing-policy` | `https://docs.rudderhq.dev/zh/reference/code-signing-policy` |
|
|
52
|
+
| Local data and optional service privacy | `https://docs.rudderhq.dev/reference/privacy` | `https://docs.rudderhq.dev/zh/reference/privacy` |
|
|
51
53
|
|
|
52
54
|
## Product Logic Registry
|
|
53
55
|
|