superbee 0.4.3-pre.10 → 0.4.3-pre.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "superbee",
-  "version": "0.4.3-pre.10",
+  "version": "0.4.3-pre.12",
   "type": "module",
   "description": "Agent-facing Superbee CLI for reading and writing local OKF knowledge bundles: context notes, docs, cross-links, and live bundle Views.",
   "keywords": [

package/references/author-an-integration.md

@@ -0,0 +1,154 @@
+# Author and test an integration
+
+A recipe carries definitions. Its Connector names a provider, permitted hosts, a source profile,
+record identities and mappings into the recipe's Kinds. Installing it does not create a connection,
+read a credential, fetch a provider or schedule a run.
+
+Authoring and recorded tests need only the public CLI and core packages. No Holaxis account or
+private repository is required. Local `source bind` / `source run` use explicit private consent;
+managed execution remains separate. Recorded tests never enable live execution.
+
+## Validate a recipe without executing it
+
+```sh
+superbee recipe validate ./my-recipe --json
+superbee recipe validate ./my-recipe --readme --json
+```
+
+The validator uses core's recipe parser, Kind and Connector mapping checks, profile validation and
+pin digest. It reports all Connector refusals with file locations and JSON pointers. Source summaries
+name the shipped profile class, hosts, method, path and ownable fields. `--readme` includes a template
+for the maintainer, compatibility, permissions, resource scope, support and test evidence; it does not
+invent an official support commitment or managed admission.
+
+Validation reads the selected local directory only. It never imports a module named by the recipe,
+discovers a bundle, writes a document or makes a provider request. Unknown profiles are explicit
+`PROFILE_NOT_AVAILABLE` refusals, not successful compatibility claims. The shipped `rest-json` and first-party `github-issues` profiles resolve through core.
+An explicitly selected test double does not establish compatibility for an unavailable profile.
+
+The complete package is checked for core's secret-shaped text, including README files; `.env` and
+`.env.*` containers are refused without opening them. Output names the offending location, never the
+secret value. This is a packaging tripwire, not a guarantee that arbitrary secrets can be recognized.
+Keep real credentials outside the recipe. Dot-prefixed entries are refused before traversal or
+opening, matching recipe acquisition. Symlinks, special files, malformed UTF-8 and inputs
+beyond the documented bounds are refused. Bounds are 512 directory entries, nesting depth 12,
+2 MiB per file and 8 MiB total. Select the recipe subdirectory rather than an entire repository.
+
+## Replay recorded source responses
+
+The distributed `references/integrations/rest-json-authoring/` example includes a recipe and a
+passing recorded fixture for every required scenario. Copy that directory somewhere outside the
+source checkout and run the two commands in its README. It needs no `--profile` executable module.
+
+```sh
+superbee source test ./my-recipe --fixture ./fixtures/my-source --json
+```
+
+The fixture directory contains `fixture.json`. The selected Connector and source must belong to the
+recipe. Core's public source harness runs every scenario through the same observation engine,
+mapping, record-overlay, conflict rules and in-memory storage that library consumers use. The CLI
+does not have its own observer or mapper, and it opens no live transport.
+
+The version-1 JSON shape is:
+
+```json
+{
+  "version": 1,
+  "connector": "connectors/example",
+  "source": "items",
+  "feed": "source-feeds/example",
+  "documents": [],
+  "scenarios": [
+    {
+      "name": "errors.server",
+      "runs": [{"exchanges": [{"request": {"url": "https://api.example.org/items"}, "response": {"status": 503}}]}],
+      "expect": [{
+        "receipt": {"outcome": "provider_unavailable", "reason": null, "pages": 0, "held": 0, "pending": 0, "pass": {}, "changes": {}},
+        "cursor": null,
+        "requests": [],
+        "changes": [],
+        "findings": []
+      }]
+    }
+  ]
+}
+```
+
+This illustrates the shape, **not passing expected values**. Populate `documents` with the Source
+Feed, its necessary conventions and any existing target documents; recipe conventions are already
+included and cannot be shadowed. Supply the real expected receipt fields, requests, cursor, changes
+and findings for every run. A recipe's definitions-only directory and recorded fixtures remain
+separate. Expected values are compared exactly; missing expectation keys, changed receipts, unused
+recorded exchanges, unscripted requests and failed core invariants fail the command.
+
+Each exchange records the method and URL expected by the public harness and a response (`status`,
+optional headers and body), `{ "fail": true }`, or `{ "hang": true }`. Runs may specify `mode`, `at`,
+`edits` and a bounded engine `budget`. Fixture records can include hostile URLs and other attack
+strings to test refusal. The report never echoes provider payloads, profile exception text or actual
+and expected field values. Echoed scenario names must not contain secret-shaped text; invalid
+presentation metadata is refused without printing its value even when attack payloads are allowed.
+
+The report lists required and missing scenarios. Cover authentication/rate/server/malformed errors,
+incomplete pages, cursor resume and hostile cursors, complete-observation disappearance, owned-field
+conflicts, unmapped and null values, missing identity, redirects and undeclared hosts. A subset may
+be useful during development, but missing required scenarios always makes the final command fail.
+Scenarios are bounded to 64, with at most 16 runs per scenario and 512 exchanges per run.
+
+## Explicitly test local profile code
+
+```sh
+superbee source test ./my-recipe --fixture ./fixtures/my-source --profile ./profile.mjs --json
+```
+
+`--profile` deliberately imports local JavaScript. Its default export (or named `profile`) must be a
+public `SourceProfile` with the same id as the declaration. The fixture may supply `spec`; otherwise
+the profile receives the parsed Connector source. A scenario can override its spec to exercise
+refusal cases. Core's `SourceProfile`, `runSourceScenario`, `runSourceFixture` and conformance tools
+are also available directly from `@superbee/core/source-engine` and `/source-harness` in `node:test`.
+
+**Run only code you trust.** A local extension runs in this Node process with its ordinary authority;
+this is not a sandbox, and using a recorded transport does not prevent arbitrary code from using
+ambient APIs. The static egress check and independent admission review lower that risk; they do not
+provide isolation. Neither a fixture nor a recipe can implicitly select a module for the CLI to
+execute. Validation and installation never import one.
+
+The Work Item example reexports the shipped first-party GitHub profile. Its synthetic fixtures
+qualify mapping and observation behavior; live provider access and managed catalog admission remain
+separate evidence.
+
+## Bind and run a local Source Feed
+
+After installing a recipe and creating its Source Feed in a local or Git bundle, preview consent:
+
+```sh
+superbee source bind source-feeds/github --anonymous --dir ./bundle --json
+superbee source bind source-feeds/github --anonymous --accept <digest-from-preview> --dir ./bundle --json
+superbee source run source-feeds/github --dir ./bundle --json
+```
+
+Binding previews make no provider request and read no credential. Acceptance pins the physical
+bundle, feed, declaration/provider rules, resource, Kind/overlay policy, built-in profile/version
+and budgets in private user state. A changed pin refuses before network or credential reads;
+preview and accept again. Copying or moving a bundle requires a new binding. `--complete` requests
+a complete pass; an interrupted pass never claims completeness.
+
+Anonymous public GitHub reads use the same read-path/resource guard and never discover credentials.
+For an explicitly authorized credentialed run, replace `--anonymous` with `--credential-env NAME`;
+the binding stores only that variable name. Supply the token separately through the process
+environment. Never put token values in arguments, recipes, fixtures or documents. GitHub token and
+GitHub App installation-token declarations are supported; no login, token exchange or credential
+discovery is performed. A 401/403 is a normal credential-refused result.
+
+Run admits shipped built-ins only and uses bounded DNS-pinned HTTPS. It updates existing documents
+linked by `sources` and existing overlay Signals; it does not create mirrored Work Items. A document
+linked after a prior observation can adopt cached last-observed values on its next run, including a
+304. A held invalid provider value needs a fresh observation; it is not retained as a retry queue.
+Private observation/accepted state persists with one lock and atomic envelope. A crash after a
+bundle write can replay through the same conflict rules; no exactly-once cross-store transaction
+is claimed. Corrupt private state refuses without reset. Summaries omit records, cursor, raw
+provider errors and credential values. Neither bind nor run synchronizes or publishes a bundle.
+
+Run receipts include fixed machine reason codes where available, never provider error text.
+A terminal unsuccessful run exits nonzero after its receipt: credential refusal 4, not found 6,
+guard/content/size refusal 2, and provider/runtime failure 1. Observed and deferred exit 0;
+deferred retains retry metadata for continuation and does not claim a complete observation.

package/references/integrations/rest-json-authoring/README.md

@@ -0,0 +1,24 @@
+# Recorded REST integration authoring
+
+This example uses a synthetic ticket board, not a live provider or a credential.
+
+From a copy of this directory, using a CLI release that includes integration authoring:
+
+```sh
+superbee recipe validate ./recipe --readme --json
+superbee source test ./recipe --fixture ./fixture --json
+```
+
+No checkout, account, environment variable or private source is required. The recorded fixture
+exercises all required source scenarios, including hostile provider URLs. Expected values are
+committed independently of the CLI run. Change one expected receipt or remove a required scenario:
+the second command exits nonzero. Neither command writes to the recipe or a real bundle.
+
+The Source Feed and Signal fixture conventions are the public source-feeds recipe definitions;
+the Ticket example and recorded scenario corpus reuse the source engine's synthetic ticket board.
+This tests the shipped declarative rest-json profile. It does not qualify a real provider, enable
+local live execution, grant credentials or establish managed admission.
+
+See `references/author-an-integration.md` in the CLI package (source:
+`examples/references/author-an-integration.md`) for the fixture format and explicit local-code
+execution boundary.