superbee 0.4.3-pre.12 → 0.4.3-pre.15
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/superbee.mjs +21981 -21366
- package/package.json +1 -1
- package/references/author-an-integration.md +45 -7
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "superbee",
|
|
3
|
-
"version": "0.4.3-pre.
|
|
3
|
+
"version": "0.4.3-pre.15",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Agent-facing Superbee CLI for reading and writing local OKF knowledge bundles: context notes, docs, cross-links, and live bundle Views.",
|
|
6
6
|
"keywords": [
|
|
@@ -17,13 +17,13 @@ superbee recipe validate ./my-recipe --readme --json
|
|
|
17
17
|
|
|
18
18
|
The validator uses core's recipe parser, Kind and Connector mapping checks, profile validation and
|
|
19
19
|
pin digest. It reports all Connector refusals with file locations and JSON pointers. Source summaries
|
|
20
|
-
name the
|
|
20
|
+
name the available profile class, hosts, method, path and ownable fields. `--readme` includes a template
|
|
21
21
|
for the maintainer, compatibility, permissions, resource scope, support and test evidence; it does not
|
|
22
22
|
invent an official support commitment or managed admission.
|
|
23
23
|
|
|
24
|
-
Validation reads the selected
|
|
24
|
+
Validation reads the selected recipe directory and inert accepted plugin metadata. It never imports a module named by the recipe,
|
|
25
25
|
discovers a bundle, writes a document or makes a provider request. Unknown profiles are explicit
|
|
26
|
-
`PROFILE_NOT_AVAILABLE` refusals, not successful compatibility claims.
|
|
26
|
+
`PROFILE_NOT_AVAILABLE` refusals, not successful compatibility claims. Core supplies `rest-json`; `github-issues` requires explicit registration of the independently installed GitHub plugin. Registered plugin spec checks are deferred to source test/bind/run; validation never imports its module.
|
|
27
27
|
An explicitly selected test double does not establish compatibility for an unavailable profile.
|
|
28
28
|
|
|
29
29
|
The complete package is checked for core's secret-shaped text, including README files; `.env` and
|
|
@@ -112,10 +112,48 @@ ambient APIs. The static egress check and independent admission review lower tha
|
|
|
112
112
|
provide isolation. Neither a fixture nor a recipe can implicitly select a module for the CLI to
|
|
113
113
|
execute. Validation and installation never import one.
|
|
114
114
|
|
|
115
|
-
The
|
|
115
|
+
The public [superbee-plugins repository](https://github.com/Holaxis-ai/superbee-plugins) owns the
|
|
116
|
+
[GitHub integration](https://github.com/Holaxis-ai/superbee-plugins/tree/main/integrations/github),
|
|
117
|
+
[Work Item recipes](https://github.com/Holaxis-ai/superbee-plugins/tree/main/recipes) and
|
|
118
|
+
[GitHub/Linear examples](https://github.com/Holaxis-ai/superbee-plugins/tree/main/examples). Its synthetic fixtures
|
|
116
119
|
qualify mapping and observation behavior; live provider access and managed catalog admission remain
|
|
117
120
|
separate evidence.
|
|
118
121
|
|
|
122
|
+
## Register the GitHub integration from a source checkout
|
|
123
|
+
|
|
124
|
+
The GitHub integration is distributed through the public Git repository; no integration npm
|
|
125
|
+
publication is required. Follow the repository README's
|
|
126
|
+
[install from source](https://github.com/Holaxis-ai/superbee-plugins#install-the-github-integration-from-source)
|
|
127
|
+
steps: select and review a full 40-character Git commit, check it out detached, install development
|
|
128
|
+
tools and the exact compatible public Core version, then build. Review code before running its
|
|
129
|
+
installation or build commands. Core and the Superbee CLI retain their normal npm distribution
|
|
130
|
+
channels; this source checkout supplies the integration code.
|
|
131
|
+
|
|
132
|
+
With that built checkout at `./superbee-plugins`, select its integration directory explicitly:
|
|
133
|
+
|
|
134
|
+
```sh
|
|
135
|
+
superbee source plugin register ./superbee-plugins/integrations/github --json
|
|
136
|
+
superbee source plugin register ./superbee-plugins/integrations/github --accept <digest-from-preview> --json
|
|
137
|
+
superbee source plugin list --json
|
|
138
|
+
superbee recipe add github:source-feeds --dir ./bundle
|
|
139
|
+
superbee recipe add github:work-items --dir ./bundle
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Registration copies a bounded manifest, standalone module and inert recipe bytes into private
|
|
143
|
+
immutable generations. Preview, acceptance, listing, removal and recipe installation never import
|
|
144
|
+
plugin code. Acceptance trusts those local bytes as reviewed code executing with ambient process
|
|
145
|
+
authority. A package name and digest do not authenticate publisher origin or provide a sandbox.
|
|
146
|
+
A full Git commit identifies the selected source; it does not authenticate the publisher or make
|
|
147
|
+
that code safe. Superbee does not acquire or build integrations. Registration grants no feed binding
|
|
148
|
+
or credentials. Use the checkout's `recipes/source-feeds` and `recipes/work-items` folders for
|
|
149
|
+
`recipe validate` and its recorded fixtures for `source test`, following the repository examples.
|
|
150
|
+
|
|
151
|
+
Updates require reviewing another full Git commit, checking it out and rebuilding with the README's
|
|
152
|
+
compatible Core setup, then a new accepted registration and explicit feed rebind.
|
|
153
|
+
Rebinding changed consent resets observations and accepted tuples for reacquisition. Remove future
|
|
154
|
+
availability with `superbee source plugin remove github`; already selected runs may finish their
|
|
155
|
+
selected generation. Existing bundle content and retained generations are preserved.
|
|
156
|
+
|
|
119
157
|
## Bind and run a local Source Feed
|
|
120
158
|
|
|
121
159
|
After installing a recipe and creating its Source Feed in a local or Git bundle, preview consent:
|
|
@@ -127,8 +165,8 @@ superbee source run source-feeds/github --dir ./bundle --json
|
|
|
127
165
|
```
|
|
128
166
|
|
|
129
167
|
Binding previews make no provider request and read no credential. Acceptance pins the physical
|
|
130
|
-
bundle, feed, declaration/provider rules, resource, Kind/overlay policy,
|
|
131
|
-
and budgets in private user state. A changed pin refuses before network or credential reads;
|
|
168
|
+
bundle, feed, declaration/provider rules, resource, Kind/overlay policy, profile/version and accepted implementation identity
|
|
169
|
+
and budgets in private user state. A changed pin refuses before module import, factory/spec execution, network or credential reads;
|
|
132
170
|
preview and accept again. Copying or moving a bundle requires a new binding. `--complete` requests
|
|
133
171
|
a complete pass; an interrupted pass never claims completeness.
|
|
134
172
|
|
|
@@ -139,7 +177,7 @@ environment. Never put token values in arguments, recipes, fixtures or documents
|
|
|
139
177
|
GitHub App installation-token declarations are supported; no login, token exchange or credential
|
|
140
178
|
discovery is performed. A 401/403 is a normal credential-refused result.
|
|
141
179
|
|
|
142
|
-
Run admits
|
|
180
|
+
Run admits built-ins and explicitly registered plugins and uses bounded DNS-pinned HTTPS. It updates existing documents
|
|
143
181
|
linked by `sources` and existing overlay Signals; it does not create mirrored Work Items. A document
|
|
144
182
|
linked after a prior observation can adopt cached last-observed values on its next run, including a
|
|
145
183
|
304. A held invalid provider value needs a fresh observation; it is not retained as a retry queue.
|