@g9tm/lynxcontrols-pilot 0.0.0-stage → 2.4.1
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 +159 -2
- package/catalog/cards/G9PilotHost.md +16 -0
- package/catalog/cards/G9PilotMask.md +10 -0
- package/catalog/cards/G9PilotPanel.md +10 -0
- package/catalog/catalog.json +420 -0
- package/catalog/index.md +7 -0
- package/check/cli.mjs +5 -0
- package/check/index.mjs +137 -0
- package/check/index.test.mjs +180 -0
- package/config/cli.mjs +31 -0
- package/config/index.d.ts +62 -0
- package/config/index.mjs +380 -0
- package/config/index.test.mjs +406 -0
- package/dist/.tsbuildinfo +1 -0
- package/dist/anchors.d.ts +39 -0
- package/dist/anchors.d.ts.map +1 -0
- package/dist/anchors.jsx +103 -0
- package/dist/bridge.d.ts +4 -0
- package/dist/bridge.d.ts.map +1 -0
- package/dist/bridge.jsx +143 -0
- package/dist/busy.d.ts +4 -0
- package/dist/busy.d.ts.map +1 -0
- package/dist/busy.jsx +43 -0
- package/dist/commands.d.ts +24 -0
- package/dist/commands.d.ts.map +1 -0
- package/dist/commands.jsx +286 -0
- package/dist/consent.d.ts +51 -0
- package/dist/consent.d.ts.map +1 -0
- package/dist/consent.jsx +131 -0
- package/dist/explore.d.ts +36 -0
- package/dist/explore.d.ts.map +1 -0
- package/dist/explore.jsx +133 -0
- package/dist/flags.d.ts +69 -0
- package/dist/flags.d.ts.map +1 -0
- package/dist/flags.jsx +81 -0
- package/dist/host-core.d.ts +36 -0
- package/dist/host-core.d.ts.map +1 -0
- package/dist/host-core.jsx +90 -0
- package/dist/host-sink.d.ts +43 -0
- package/dist/host-sink.d.ts.map +1 -0
- package/dist/host-sink.jsx +87 -0
- package/dist/index-marks.d.ts +33 -0
- package/dist/index-marks.d.ts.map +1 -0
- package/dist/index-marks.jsx +40 -0
- package/dist/index-observe.d.ts +17 -0
- package/dist/index-observe.d.ts.map +1 -0
- package/dist/index-observe.jsx +14 -0
- package/dist/index.d.ts +18 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.jsx +11 -0
- package/dist/info.d.ts +10 -0
- package/dist/info.d.ts.map +1 -0
- package/dist/info.jsx +9 -0
- package/dist/kit.d.ts +67 -0
- package/dist/kit.d.ts.map +1 -0
- package/dist/kit.jsx +1 -0
- package/dist/layer.d.ts +4 -0
- package/dist/layer.d.ts.map +1 -0
- package/dist/layer.jsx +10 -0
- package/dist/layers.d.ts +4 -0
- package/dist/layers.d.ts.map +1 -0
- package/dist/layers.jsx +146 -0
- package/dist/mask.d.ts +20 -0
- package/dist/mask.d.ts.map +1 -0
- package/dist/mask.jsx +35 -0
- package/dist/net.d.ts +17 -0
- package/dist/net.d.ts.map +1 -0
- package/dist/net.jsx +60 -0
- package/dist/observe.d.ts +99 -0
- package/dist/observe.d.ts.map +1 -0
- package/dist/observe.jsx +194 -0
- package/dist/off.d.ts +45 -0
- package/dist/off.d.ts.map +1 -0
- package/dist/off.jsx +81 -0
- package/dist/otlp.d.ts +61 -0
- package/dist/otlp.d.ts.map +1 -0
- package/dist/otlp.jsx +141 -0
- package/dist/panel.d.ts +13 -0
- package/dist/panel.d.ts.map +1 -0
- package/dist/panel.jsx +182 -0
- package/dist/session.d.ts +42 -0
- package/dist/session.d.ts.map +1 -0
- package/dist/session.jsx +115 -0
- package/dist/types.d.ts +47 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.jsx +1 -0
- package/dist/watch.d.ts +17 -0
- package/dist/watch.d.ts.map +1 -0
- package/dist/watch.jsx +165 -0
- package/doctor/cli.mjs +5 -0
- package/doctor/index.mjs +214 -0
- package/doctor/index.test.mjs +174 -0
- package/gradle/g9pilot.app.gradle +55 -0
- package/gradle/g9pilot.settings.gradle +27 -0
- package/ios/g9pilot.rb +47 -0
- package/package.json +66 -4
- package/rspeedy/index.d.ts +40 -0
- package/rspeedy/index.mjs +100 -0
- package/rspeedy/index.test.mjs +192 -0
package/README.md
CHANGED
|
@@ -1,3 +1,160 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @g9tm/lynxcontrols-pilot
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
G9AppPilot for a G9LynxControls app, in exactly as much of it as each build asks for: signed remote control for agents,
|
|
4
|
+
test runners and support, and an always-awake watch for problems, from nothing at all to everything. One file says it per
|
|
5
|
+
build environment; the page's bundle, the Android project and the proof on the artifact all read that file.
|
|
6
|
+
|
|
7
|
+
| Profile | In the build | For |
|
|
8
|
+
| --- | --- | --- |
|
|
9
|
+
| `off` | nothing (an empty twin, 0 bytes of G9AppPilot) | store builds, the default |
|
|
10
|
+
| `marks` | test ids, the kit's layers on them, busy reasons (~2 KB gzip) | store builds that support or field diagnostics refer to by id |
|
|
11
|
+
| `observe` | marks + the watch: oracles, vitals, black box, traces, findings, `g9.report`; no transport | test, staging, and store builds that choose it |
|
|
12
|
+
| `support` | observe + the signed bridge; badge always on, consent per session (60 min) | test, staging, testers, support |
|
|
13
|
+
| `full` | support with the QA defaults: no consent, DevTool, self-drive | QA, devices, CI |
|
|
14
|
+
|
|
15
|
+
Every module of a profile can be switched on or off (`modules`), and the bridge's scopes have a build ceiling
|
|
16
|
+
(`maxScopes`): a staging build can grant every scope, a support build only `observe` and `drive`. A build environment
|
|
17
|
+
marked `"distribution": "store"` can never carry the bridge — resolving one fails the build.
|
|
18
|
+
|
|
19
|
+
## Use it
|
|
20
|
+
|
|
21
|
+
```jsonc
|
|
22
|
+
// g9pilot.config.json, next to the app (keys: public halves only; publicKeyFile keeps a per-machine key out of git)
|
|
23
|
+
{
|
|
24
|
+
"keys": [{ "kid": "qa-2026", "publicKeyFile": ".keys/qa.pub", "scopes": ["*"] }],
|
|
25
|
+
"environments": {
|
|
26
|
+
"store": { "profile": "off", "distribution": "store" },
|
|
27
|
+
"staging": { "profile": "support", "consent": "none" },
|
|
28
|
+
"help": { "profile": "support", "maxScopes": ["observe", "drive"], "lan": false },
|
|
29
|
+
"qa": { "profile": "full", "port": 8791 }
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
// lynx.config.ts — the environment comes from G9_PILOT_ENV (none: off)
|
|
36
|
+
import { pluginG9Pilot } from '@g9tm/lynxcontrols-pilot/rspeedy';
|
|
37
|
+
plugins: [pluginReactLynx(), pluginG9Lynx(), pluginG9Pilot()];
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
```tsx
|
|
41
|
+
// inside the app's G9Host, around the page content — the same line in every build
|
|
42
|
+
import { G9_PILOT_BRIDGE, G9PilotHost } from '@g9tm/lynxcontrols-pilot';
|
|
43
|
+
|
|
44
|
+
<G9PilotHost commands={G9_PILOT_BRIDGE ? shopCommands : undefined} bottomBarPrefix="Shop.Tabs_" notes={['The shop app.']}>
|
|
45
|
+
<Shell />
|
|
46
|
+
</G9PilotHost>;
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
`commands` receives the registry and the black box's doors (`registerCommand`, `emit`, `PilotError`, `recordLog`,
|
|
50
|
+
`recordNet`, `registerStore`, …): the app writes its own commands without importing G9AppPilot, and guarding the
|
|
51
|
+
function with `G9_PILOT_BRIDGE` lets a store bundle drop the code too.
|
|
52
|
+
|
|
53
|
+
**Android**, with the same environment (`-Pg9pilot.env=qa`, or `G9_PILOT_ENV`):
|
|
54
|
+
|
|
55
|
+
```kotlin
|
|
56
|
+
// settings.gradle.kts — includes G9AppPilot's native project only when the environment carries the bridge
|
|
57
|
+
apply(from = "<node_modules>/@g9tm/lynxcontrols-pilot/gradle/g9pilot.settings.gradle")
|
|
58
|
+
// app/build.gradle.kts, after the Android plugin — dependencies (DevTool with its module), BuildConfig
|
|
59
|
+
// G9PILOT_PROFILE / G9PILOT_BRIDGE / G9PILOT_CONFIG (the host's PilotConfig as JSON), src/pilot/on|off/java
|
|
60
|
+
apply(from = "<node_modules>/@g9tm/lynxcontrols-pilot/gradle/g9pilot.app.gradle")
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
The host keeps two twins of its G9Pilot install: `src/pilot/on/java` (reads `BuildConfig.G9PILOT_CONFIG`, installs the
|
|
64
|
+
bridge) and `src/pilot/off/java` (empty). G9 Atelier's `apps/atelier/android` is the example.
|
|
65
|
+
|
|
66
|
+
A key may be short-lived: `"notAfter": "2026-12-31T18:00:00Z"` (or ms since the epoch) — a support engineer's key for
|
|
67
|
+
one day; after that moment the Android and iOS gates refuse it (`KEY_EXPIRED`), before reading its signature.
|
|
68
|
+
|
|
69
|
+
An environment says, besides `profile` and `distribution`: `modules` (each on or off), `keys` and `maxScopes`,
|
|
70
|
+
`signatureRequired`, `port`, `lan` (false: the bridge listens on loopback only — adb forward, a relay inside the app,
|
|
71
|
+
self-drive), `badge`, `mask` (`secret`: screenshots black out secret targets; the default of `support`), `consent` (`none` · `session` · `escalation`), `session.maxMinutes` (how long a consent lasts),
|
|
72
|
+
`selfDrive.maxSeconds`, and `observe` (`rules`, `sampling`, `buffer`, `report {via, consent, endpoint, service,
|
|
73
|
+
auto}`). Any other key fails the build: a setting nothing reads is never silently ignored.
|
|
74
|
+
|
|
75
|
+
The host reads `BuildConfig.G9PILOT_CONFIG` (Android) or the JSON `G9PilotConfig.native_json` gives (iOS) and passes
|
|
76
|
+
`port`, `keys`, `signatureRequired`, `lan`, `consent` and `selfDrive` to G9Pilot's install: the native commands (real
|
|
77
|
+
touch, screenshots, the host's own) then follow the same consent from the first request, before the page loads.
|
|
78
|
+
|
|
79
|
+
## What it adds for every app
|
|
80
|
+
|
|
81
|
+
- **The kit as the bridge's layer model**: sheets (modal, full-screen, stacked), popups (buttons by test id, the footer
|
|
82
|
+
mirrored right to left, form fields), popovers, menus, action sheets and the command palette; `ui.dismissOverlay`
|
|
83
|
+
closes them in order.
|
|
84
|
+
- **Every control with an `id` is a test target** (the provider's anchors), on its layer, with its own paths (activate,
|
|
85
|
+
value, set value, items, select); no `useTestId` in the app.
|
|
86
|
+
- **`g9.*` commands**: `g9.pilot` (what this build carries), `g9.where` / `g9.go` / `g9.places` (the library's router),
|
|
87
|
+
`g9.explore` (every place that opens by itself, visited with the oracles on — a smoke test of the whole app without a
|
|
88
|
+
written test), `g9.renders` / `g9.profileTheme` / `g9.profileVars` (render and paint costs), `g9.consent`, `g9.report`,
|
|
89
|
+
`g9.summary` (the watch in one glance: findings by rule and severity, stalls and memory, failure traces, log levels)
|
|
90
|
+
and `g9.session` (who has talked to this device: each controller's first and last request, counts and top commands,
|
|
91
|
+
the lease; `{export: true}` adds the audit log — command names and outcomes, never arguments).
|
|
92
|
+
- **Several controllers at once**: reads need no lease, so an agent, a dashboard and a person's live view
|
|
93
|
+
(`g9pilot studio`) can all watch while one lease holder drives; `g9.session` and `lease.status` say who is who.
|
|
94
|
+
- **Consent** (`consent`): `none`, `session` (the person accepts a controller once, in the culture's language) or
|
|
95
|
+
`escalation` (watching is free, changing asks); a refusal is the answer `CONSENT` with a hint, nothing runs — page
|
|
96
|
+
commands and the native ones alike (the page hands its decision down, `G9Pilot.admit`). One prompt per controller.
|
|
97
|
+
A controller may ask up front instead: `g9.consent.request {reason, reading, waitMs}` is always admitted, shows the
|
|
98
|
+
prompt with its reason quoted as its own words, and answers `{granted, pending}` once the person decided.
|
|
99
|
+
- **The person's panel**: `<G9PilotPanel>` (for a settings or about page) or `openG9PilotPanel()` (a sheet) shows, in
|
|
100
|
+
the culture's language, what this build carries, whom the person let in — **Stop sharing** takes every grant back,
|
|
101
|
+
native commands included — who has connected, the newest findings and **Send report**. Nothing in `off` and `marks`.
|
|
102
|
+
- **Masked screenshots** (`mask: secret`, the default of `support`): a G9 password field, and anything the app wraps in
|
|
103
|
+
`<G9PilotMask>` (a card number, a private note), is a secret target. The native `ui.screenshot` asks the page for their
|
|
104
|
+
boxes (`pilot.maskRects`) and blacks them out before the picture leaves the device (`masked`: how many); `ui.snapshot`
|
|
105
|
+
and `ui.find` read a secret's value as dots in every profile. Without the bridge `<G9PilotMask>` is a plain box.
|
|
106
|
+
- **Reports** (`observe.report`): `via` local, diagnostic (`onReport`), hub or otlp; `consent: user` asks the person
|
|
107
|
+
before each one leaves the device, `never` keeps it there. `otlp` posts OpenTelemetry logs (OTLP/HTTP, JSON) to the
|
|
108
|
+
`endpoint` your collector listens on (`…/v1/logs`; https in a store build), one record per finding, trace and log line,
|
|
109
|
+
under `service` (`service.name`). `auto: <seconds>` sends a report on each new finding, at most once per window, and
|
|
110
|
+
only where the build's consent covers it (`consent: build`) — staging, a test lab. The bundle is public: a collector
|
|
111
|
+
that wants a token sits behind your own proxy.
|
|
112
|
+
- **The watch**: the oracles in the culture's language — a Latin number in Persian text is a finding, a field's own ASCII
|
|
113
|
+
value is not (it draws the culture's digits); the black box hears the provider's diagnostics; findings are sampled per
|
|
114
|
+
kind, bounded, kept across a restart, and handed over as one report (`onReport`, the hub, or kept on the device).
|
|
115
|
+
- **The watch in a browser** (LC-08): Lynx for Web has no bridge, so the watch hands its findings to the page through
|
|
116
|
+
`G9HostModule.pilotFindings` (only a host with that method gets them: `@g9tm/lynxcontrols-web`), runs the screen
|
|
117
|
+
rules when the page sends `g9:pilot-check`, and turns the runtime's errors the page forwards (`g9:lynx-error`) into
|
|
118
|
+
`js.error`. The rules that read only the page run there — measured in Chromium: `js.error`, `a11y.unlabeled`,
|
|
119
|
+
`i18n.rawKey` and `layout.offScreen`, each from a planted fault (the web smoke, step 8); what needs the native host
|
|
120
|
+
comes back as `unsupported` with the reason (`perf.memoryGrowth`, the UI thread's frames).
|
|
121
|
+
|
|
122
|
+
## Moving an app's own G9AppPilot wiring here
|
|
123
|
+
|
|
124
|
+
An app that wired G9AppPilot by hand has the same pieces each time. What each becomes:
|
|
125
|
+
|
|
126
|
+
| The app had | Now |
|
|
127
|
+
| --- | --- |
|
|
128
|
+
| an alias (`#qa` → `bridge.ts` / `off.ts`) and a define in `lynx.config` | `pluginG9Pilot()`; the app imports `@g9tm/lynxcontrols-pilot` unguarded |
|
|
129
|
+
| `startQa()` calling `installLease`, `installBlackbox`, `installStage`, `installPilotConfig`, `installLynxOracles`, `registerUiCommands`, `registerDevtoolCommands`, `registerInspectorCommands`, `startPilot` | `<G9PilotHost>` inside the G9Host; the environment's modules decide |
|
|
130
|
+
| its own commands registered in the bridge file | `commands={G9_PILOT_BRIDGE ? appCommands : undefined}` with the `G9PilotApi` it receives |
|
|
131
|
+
| a wrapper around its API client (shaping, busy, `recordNet`) | `aroundRequest(method, url, run, { answer, longPoll })` — in every build (a plain call where nothing watches) |
|
|
132
|
+
| `configureTestIds({ confirmTouches: true })` | automatic with the bridge's `ui` module |
|
|
133
|
+
| `useTarget` / `useEntry` hooks on its own components | a G9 control with an `id` is a target already; a custom element keeps `useTestId`, `Testable`, `PilotLayer`, `ScrolledStrip` |
|
|
134
|
+
| a module replacement for the bridge's `./native.ts` | `pluginG9Pilot({ nativeTransport: 'src/qa/native.ts' })` |
|
|
135
|
+
| `-PqaBridge=true`, a manual `include`, the kapt argument, DevTool dependencies, a `src/qa/{on,off}` source set | the two Gradle helpers and `src/pilot/{on,off}` (the host registers `G9PilotModule` itself, so the Autolink provider name is not needed) |
|
|
136
|
+
| `perf.startupMarks`, `perf.frameStats`, `perf.memory`, `ui.screenshot` written in the host | the bridge's own since G9AppPilot 0.2.0: delete them, call `G9Pilot.mark(name)` for start-up moments |
|
|
137
|
+
| `devtool.attach`, `dev.server`, `dev.status` in the host (DevTool's service, the dev-server preference, the fetcher) | the bridge's own (`PilotDev.kt`, `G9PilotDev.m`) when the environment carries `devtool`: the host calls `G9Pilot.devBeforeInit(app)` / `devAfterInit()`, gives its builder `G9Pilot.devFetcher()`, loads `G9Pilot.devServerUrl(context) ?: packaged` and asks `G9Pilot.devFetchBundle(uri)` in its template provider; `rebuildScreen` in the config if recreating the activity is not enough |
|
|
138
|
+
| the controller's file (`g9pilot.json`: url, kid, where the private key lives) | unchanged: it belongs to the controller, not to the build |
|
|
139
|
+
|
|
140
|
+
**One rule from the move:** import G9AppPilot's packages through their main entries (`@g9tm/app-pilot`,
|
|
141
|
+
`@g9tm/app-pilot-lynx`), never a subpath such as `/testid` or `/idle`, from outside them. A bundler can instantiate a module
|
|
142
|
+
twice when it is reached both ways, and the copies keep two registries: controls registered in one, `ui.snapshot`
|
|
143
|
+
reading the other (found on a device; `@g9tm/app-pilot-lynx/testid` now keeps one registry per JS context whatever the
|
|
144
|
+
path, the other modules rely on the rule).
|
|
145
|
+
|
|
146
|
+
## Check the wiring
|
|
147
|
+
|
|
148
|
+
`npx g9pilot-doctor [app folder]` reads the app and says, line by line, what is right and what is not: every environment
|
|
149
|
+
of `g9pilot.config.json` resolves (key files, short-lived keys about to expire), `lynx.config` adds `pluginG9Pilot()`,
|
|
150
|
+
the Gradle helpers and both `src/pilot` twins are there, the Podfile requires the helper, the code imports only the main
|
|
151
|
+
entries, no private key sits outside an ignored folder, and every `dist*` folder with a receipt holds what its profile
|
|
152
|
+
says. Exit 1 on any problem; `--json` for a machine.
|
|
153
|
+
|
|
154
|
+
## Prove it on the artifact
|
|
155
|
+
|
|
156
|
+
`pilot-receipt.json` is written beside every bundle (profile, entry, modules, native parts). Build each environment and
|
|
157
|
+
check that a store build holds no bridge code — see `apps/atelier` for the matrix and `.agents/skills/g9-app-pilot/` for the bridge,
|
|
158
|
+
the protocol, the commands and the controllers.
|
|
159
|
+
|
|
160
|
+
Every export: [docs/api.md](docs/api.md).
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# G9PilotHost
|
|
2
|
+
|
|
3
|
+
`import { G9PilotHost } from '@g9tm/lynxcontrols-pilot';`
|
|
4
|
+
|
|
5
|
+
Renders its children: this build carries no G9AppPilot.
|
|
6
|
+
|
|
7
|
+
Props:
|
|
8
|
+
- `children?`: ReactNode
|
|
9
|
+
- `askConsent?`: (request: { readonly kid: string; readonly reading: boolean; readonly reason?: string; }) => void
|
|
10
|
+
- `commands?`: (api: G9PilotApi) => void
|
|
11
|
+
- `onReport?`: (report: G9PilotReport) => void
|
|
12
|
+
- `badgeLabel?`: string
|
|
13
|
+
- `bottomBarPrefix?`: string
|
|
14
|
+
- `notes?`: string[]
|
|
15
|
+
|
|
16
|
+
Example: `<G9PilotHost />`
|
|
@@ -0,0 +1,420 @@
|
|
|
1
|
+
{
|
|
2
|
+
"catalogVersion": 1,
|
|
3
|
+
"package": "@g9tm/lynxcontrols-pilot",
|
|
4
|
+
"version": "2.4.1",
|
|
5
|
+
"generatedBy": "node scripts/check-docs.mjs --write",
|
|
6
|
+
"components": [
|
|
7
|
+
{
|
|
8
|
+
"id": "pilot.pilot.G9PilotHost",
|
|
9
|
+
"export": "G9PilotHost",
|
|
10
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
11
|
+
"kind": "component",
|
|
12
|
+
"family": "pilot",
|
|
13
|
+
"summary": "Renders its children: this build carries no G9AppPilot.",
|
|
14
|
+
"since": null,
|
|
15
|
+
"props": [
|
|
16
|
+
{
|
|
17
|
+
"name": "askConsent",
|
|
18
|
+
"type": {
|
|
19
|
+
"kind": "event",
|
|
20
|
+
"payload": "request: { readonly kid: string; readonly reading: boolean; readonly reason?: string; }",
|
|
21
|
+
"returns": "Promise<boolean>"
|
|
22
|
+
},
|
|
23
|
+
"required": false,
|
|
24
|
+
"serializable": false,
|
|
25
|
+
"role": "event",
|
|
26
|
+
"doc": "How consent is asked (default: a G9 confirm in the culture's language)."
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"name": "badgeLabel",
|
|
30
|
+
"type": {
|
|
31
|
+
"kind": "string"
|
|
32
|
+
},
|
|
33
|
+
"required": false,
|
|
34
|
+
"serializable": true,
|
|
35
|
+
"role": "content",
|
|
36
|
+
"doc": "The «under automation» badge in the app's words (default by the culture's language)."
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "bottomBarPrefix",
|
|
40
|
+
"type": {
|
|
41
|
+
"kind": "string"
|
|
42
|
+
},
|
|
43
|
+
"required": false,
|
|
44
|
+
"serializable": true,
|
|
45
|
+
"role": "behaviour",
|
|
46
|
+
"doc": "Test ids of the bottom bar (ui.tap scrolls a control out from under it)."
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"name": "children",
|
|
50
|
+
"type": {
|
|
51
|
+
"kind": "slot",
|
|
52
|
+
"accepts": "any"
|
|
53
|
+
},
|
|
54
|
+
"required": false,
|
|
55
|
+
"serializable": false,
|
|
56
|
+
"role": "slot"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "commands",
|
|
60
|
+
"type": {
|
|
61
|
+
"kind": "event",
|
|
62
|
+
"payload": "api: G9PilotApi",
|
|
63
|
+
"returns": "(() => void) | undefined"
|
|
64
|
+
},
|
|
65
|
+
"required": false,
|
|
66
|
+
"serializable": false,
|
|
67
|
+
"role": "event",
|
|
68
|
+
"doc": "The app's own commands: called once in a bridge build (never in another), returns the uninstaller."
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"name": "notes",
|
|
72
|
+
"type": {
|
|
73
|
+
"kind": "array",
|
|
74
|
+
"items": {
|
|
75
|
+
"kind": "string"
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
"required": false,
|
|
79
|
+
"serializable": true,
|
|
80
|
+
"role": "behaviour",
|
|
81
|
+
"doc": "What this app is, for the bridge's manifest (an agent reads it first)."
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"name": "onReport",
|
|
85
|
+
"type": {
|
|
86
|
+
"kind": "event",
|
|
87
|
+
"payload": "report: G9PilotReport",
|
|
88
|
+
"returns": "void | Promise<void>"
|
|
89
|
+
},
|
|
90
|
+
"required": false,
|
|
91
|
+
"serializable": false,
|
|
92
|
+
"role": "event",
|
|
93
|
+
"doc": "Where a report goes (observe `report.via: diagnostic`): G9AppDiagnostic, a file, the app's own channel."
|
|
94
|
+
}
|
|
95
|
+
],
|
|
96
|
+
"anchor": null,
|
|
97
|
+
"accessibility": {
|
|
98
|
+
"labelFrom": [],
|
|
99
|
+
"labelRequired": false
|
|
100
|
+
},
|
|
101
|
+
"targets": {
|
|
102
|
+
"android": "unmeasured",
|
|
103
|
+
"ios": "pending",
|
|
104
|
+
"windows": "unmeasured",
|
|
105
|
+
"macos": "unmeasured",
|
|
106
|
+
"web": "unsupported"
|
|
107
|
+
},
|
|
108
|
+
"evidence": {
|
|
109
|
+
"ledger": [
|
|
110
|
+
"N-088",
|
|
111
|
+
"N-137"
|
|
112
|
+
]
|
|
113
|
+
},
|
|
114
|
+
"tokens": [],
|
|
115
|
+
"example": {
|
|
116
|
+
"line": "<G9PilotHost />",
|
|
117
|
+
"from": "generated"
|
|
118
|
+
}
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"id": "pilot.pilot.G9PilotMask",
|
|
122
|
+
"export": "G9PilotMask",
|
|
123
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
124
|
+
"kind": "component",
|
|
125
|
+
"family": "pilot",
|
|
126
|
+
"summary": "The masked box, as a plain box: this build takes no screenshots.",
|
|
127
|
+
"since": null,
|
|
128
|
+
"props": [
|
|
129
|
+
{
|
|
130
|
+
"name": "children",
|
|
131
|
+
"type": {
|
|
132
|
+
"kind": "slot",
|
|
133
|
+
"accepts": "any"
|
|
134
|
+
},
|
|
135
|
+
"required": false,
|
|
136
|
+
"serializable": false,
|
|
137
|
+
"role": "slot"
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
"name": "className",
|
|
141
|
+
"type": {
|
|
142
|
+
"kind": "string"
|
|
143
|
+
},
|
|
144
|
+
"required": false,
|
|
145
|
+
"serializable": true,
|
|
146
|
+
"role": "appearance"
|
|
147
|
+
},
|
|
148
|
+
{
|
|
149
|
+
"name": "id",
|
|
150
|
+
"type": {
|
|
151
|
+
"kind": "string"
|
|
152
|
+
},
|
|
153
|
+
"required": false,
|
|
154
|
+
"serializable": true,
|
|
155
|
+
"role": "identity"
|
|
156
|
+
}
|
|
157
|
+
],
|
|
158
|
+
"anchor": null,
|
|
159
|
+
"accessibility": {
|
|
160
|
+
"labelFrom": [],
|
|
161
|
+
"labelRequired": false
|
|
162
|
+
},
|
|
163
|
+
"targets": {
|
|
164
|
+
"android": "unmeasured",
|
|
165
|
+
"ios": "pending",
|
|
166
|
+
"windows": "unmeasured",
|
|
167
|
+
"macos": "unmeasured",
|
|
168
|
+
"web": "unsupported"
|
|
169
|
+
},
|
|
170
|
+
"evidence": {
|
|
171
|
+
"ledger": [
|
|
172
|
+
"N-088",
|
|
173
|
+
"N-137"
|
|
174
|
+
]
|
|
175
|
+
},
|
|
176
|
+
"tokens": [],
|
|
177
|
+
"example": {
|
|
178
|
+
"line": "<G9PilotMask />",
|
|
179
|
+
"from": "generated"
|
|
180
|
+
}
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"id": "pilot.pilot.G9PilotPanel",
|
|
184
|
+
"export": "G9PilotPanel",
|
|
185
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
186
|
+
"kind": "component",
|
|
187
|
+
"family": "pilot",
|
|
188
|
+
"summary": "Nothing: this build carries no watch to show.",
|
|
189
|
+
"since": null,
|
|
190
|
+
"props": [
|
|
191
|
+
{
|
|
192
|
+
"name": "findings",
|
|
193
|
+
"type": {
|
|
194
|
+
"kind": "number"
|
|
195
|
+
},
|
|
196
|
+
"required": false,
|
|
197
|
+
"serializable": true,
|
|
198
|
+
"role": "behaviour"
|
|
199
|
+
}
|
|
200
|
+
],
|
|
201
|
+
"anchor": null,
|
|
202
|
+
"accessibility": {
|
|
203
|
+
"labelFrom": [],
|
|
204
|
+
"labelRequired": false
|
|
205
|
+
},
|
|
206
|
+
"targets": {
|
|
207
|
+
"android": "unmeasured",
|
|
208
|
+
"ios": "pending",
|
|
209
|
+
"windows": "unmeasured",
|
|
210
|
+
"macos": "unmeasured",
|
|
211
|
+
"web": "unsupported"
|
|
212
|
+
},
|
|
213
|
+
"evidence": {
|
|
214
|
+
"ledger": [
|
|
215
|
+
"N-088",
|
|
216
|
+
"N-137"
|
|
217
|
+
]
|
|
218
|
+
},
|
|
219
|
+
"tokens": [],
|
|
220
|
+
"example": {
|
|
221
|
+
"line": "<G9PilotPanel />",
|
|
222
|
+
"from": "generated"
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
],
|
|
226
|
+
"exports": [
|
|
227
|
+
{
|
|
228
|
+
"id": "pilot.pilot.aroundRequest",
|
|
229
|
+
"export": "aroundRequest",
|
|
230
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
231
|
+
"kind": "function",
|
|
232
|
+
"signature": "<T>(_method: string, _url: string, run: () => Promise<T>, _options?: G9AroundRequestOptions<T> | undefined): Promise<T>",
|
|
233
|
+
"summary": "The request itself: this build does not watch requests (no shaping, no busy reason, no black box)."
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
"id": "pilot.pilot.G9_PILOT_BRIDGE",
|
|
237
|
+
"export": "G9_PILOT_BRIDGE",
|
|
238
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
239
|
+
"kind": "constant",
|
|
240
|
+
"signature": "boolean",
|
|
241
|
+
"summary": "False: this build carries no G9AppPilot (an app guards its own command code with it)."
|
|
242
|
+
},
|
|
243
|
+
{
|
|
244
|
+
"id": "pilot.pilot.G9AroundRequestOptions",
|
|
245
|
+
"export": "G9AroundRequestOptions",
|
|
246
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
247
|
+
"kind": "interface",
|
|
248
|
+
"signature": "G9AroundRequestOptions<T>",
|
|
249
|
+
"summary": "How the app's own response looks to `aroundRequest`."
|
|
250
|
+
},
|
|
251
|
+
{
|
|
252
|
+
"id": "pilot.pilot.G9ConsentAsk",
|
|
253
|
+
"export": "G9ConsentAsk",
|
|
254
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
255
|
+
"kind": "type",
|
|
256
|
+
"signature": "G9ConsentAsk",
|
|
257
|
+
"summary": "How the person is asked (the host shows a G9 confirm). Resolves whether they accepted."
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
"id": "pilot.pilot.G9FindingsBuffer",
|
|
261
|
+
"export": "G9FindingsBuffer",
|
|
262
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
263
|
+
"kind": "interface",
|
|
264
|
+
"signature": "G9FindingsBuffer",
|
|
265
|
+
"summary": "The bounded, sampled, persisted buffer of findings."
|
|
266
|
+
},
|
|
267
|
+
{
|
|
268
|
+
"id": "pilot.pilot.g9Pilot",
|
|
269
|
+
"export": "g9Pilot",
|
|
270
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
271
|
+
"kind": "function",
|
|
272
|
+
"signature": "(): G9PilotInfo",
|
|
273
|
+
"summary": "Always `off`: this build carries no G9AppPilot."
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"id": "pilot.pilot.G9PilotApi",
|
|
277
|
+
"export": "G9PilotApi",
|
|
278
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
279
|
+
"kind": "interface",
|
|
280
|
+
"signature": "G9PilotApi",
|
|
281
|
+
"summary": "What the app's own commands get: the registry and the black box's doors, nothing to import."
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
"id": "pilot.pilot.G9PilotAuditEntry",
|
|
285
|
+
"export": "G9PilotAuditEntry",
|
|
286
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
287
|
+
"kind": "interface",
|
|
288
|
+
"signature": "G9PilotAuditEntry",
|
|
289
|
+
"summary": "One answered request, as the audit log keeps it."
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
"id": "pilot.pilot.G9PilotController",
|
|
293
|
+
"export": "G9PilotController",
|
|
294
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
295
|
+
"kind": "interface",
|
|
296
|
+
"signature": "G9PilotController",
|
|
297
|
+
"summary": "A controller this session has seen."
|
|
298
|
+
},
|
|
299
|
+
{
|
|
300
|
+
"id": "pilot.pilot.G9PilotFinding",
|
|
301
|
+
"export": "G9PilotFinding",
|
|
302
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
303
|
+
"kind": "interface",
|
|
304
|
+
"signature": "G9PilotFinding",
|
|
305
|
+
"summary": "One finding the watch kept (an `oracle.violation`, or an error line)."
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
"id": "pilot.pilot.g9PilotFindings",
|
|
309
|
+
"export": "g9PilotFindings",
|
|
310
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
311
|
+
"kind": "function",
|
|
312
|
+
"signature": "(): null",
|
|
313
|
+
"summary": "Always null: this build keeps no findings."
|
|
314
|
+
},
|
|
315
|
+
{
|
|
316
|
+
"id": "pilot.pilot.G9PilotHostProps",
|
|
317
|
+
"export": "G9PilotHostProps",
|
|
318
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
319
|
+
"kind": "interface",
|
|
320
|
+
"signature": "G9PilotHostProps",
|
|
321
|
+
"summary": "Props of `G9PilotHost`."
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"id": "pilot.pilot.G9PilotInfo",
|
|
325
|
+
"export": "G9PilotInfo",
|
|
326
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
327
|
+
"kind": "interface",
|
|
328
|
+
"signature": "G9PilotInfo",
|
|
329
|
+
"summary": "What this build carries of G9AppPilot."
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
"id": "pilot.pilot.G9PilotMaskProps",
|
|
333
|
+
"export": "G9PilotMaskProps",
|
|
334
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
335
|
+
"kind": "interface",
|
|
336
|
+
"signature": "G9PilotMaskProps",
|
|
337
|
+
"summary": "Props of G9PilotMask (the same in every build)."
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
"id": "pilot.pilot.G9PilotModule",
|
|
341
|
+
"export": "G9PilotModule",
|
|
342
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
343
|
+
"kind": "type",
|
|
344
|
+
"signature": "G9PilotModule",
|
|
345
|
+
"summary": "Every module a profile can carry."
|
|
346
|
+
},
|
|
347
|
+
{
|
|
348
|
+
"id": "pilot.pilot.G9PilotPanelProps",
|
|
349
|
+
"export": "G9PilotPanelProps",
|
|
350
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
351
|
+
"kind": "interface",
|
|
352
|
+
"signature": "G9PilotPanelProps",
|
|
353
|
+
"summary": "Props of G9PilotPanel (this build shows none)."
|
|
354
|
+
},
|
|
355
|
+
{
|
|
356
|
+
"id": "pilot.pilot.G9PilotProfile",
|
|
357
|
+
"export": "G9PilotProfile",
|
|
358
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
359
|
+
"kind": "type",
|
|
360
|
+
"signature": "G9PilotProfile",
|
|
361
|
+
"summary": "The profiles, from nothing to everything (`g9pilot.config.json`)."
|
|
362
|
+
},
|
|
363
|
+
{
|
|
364
|
+
"id": "pilot.pilot.G9PilotReport",
|
|
365
|
+
"export": "G9PilotReport",
|
|
366
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
367
|
+
"kind": "interface",
|
|
368
|
+
"signature": "G9PilotReport",
|
|
369
|
+
"summary": "What the app hands to its diagnostics channel (G9AppDiagnostic, a hub, a file)."
|
|
370
|
+
},
|
|
371
|
+
{
|
|
372
|
+
"id": "pilot.pilot.g9PilotSession",
|
|
373
|
+
"export": "g9PilotSession",
|
|
374
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
375
|
+
"kind": "function",
|
|
376
|
+
"signature": "(): null",
|
|
377
|
+
"summary": "Always null: only a bridge build keeps a session (who talked to this device)."
|
|
378
|
+
},
|
|
379
|
+
{
|
|
380
|
+
"id": "pilot.pilot.G9PilotSession",
|
|
381
|
+
"export": "G9PilotSession",
|
|
382
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
383
|
+
"kind": "interface",
|
|
384
|
+
"signature": "G9PilotSession",
|
|
385
|
+
"summary": "What the bridge keeps of who has talked to this device (`g9PilotSession()`; the panel's «who has connected»)."
|
|
386
|
+
},
|
|
387
|
+
{
|
|
388
|
+
"id": "pilot.pilot.G9PilotSettings",
|
|
389
|
+
"export": "G9PilotSettings",
|
|
390
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
391
|
+
"kind": "interface",
|
|
392
|
+
"signature": "G9PilotSettings",
|
|
393
|
+
"summary": "What the page needs to know of its build's configuration (the keys stay with the native gate)."
|
|
394
|
+
},
|
|
395
|
+
{
|
|
396
|
+
"id": "pilot.pilot.G9PilotSummary",
|
|
397
|
+
"export": "G9PilotSummary",
|
|
398
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
399
|
+
"kind": "interface",
|
|
400
|
+
"signature": "G9PilotSummary",
|
|
401
|
+
"summary": "g9.summary: what this device's watch saw, in one glance (counts, never the whole buffer)."
|
|
402
|
+
},
|
|
403
|
+
{
|
|
404
|
+
"id": "pilot.pilot.G9ShapedRequestError",
|
|
405
|
+
"export": "G9ShapedRequestError",
|
|
406
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
407
|
+
"kind": "class",
|
|
408
|
+
"signature": "typeof G9ShapedRequestError",
|
|
409
|
+
"summary": "A request net.shape failed (never thrown in this build: nothing is shaped)."
|
|
410
|
+
},
|
|
411
|
+
{
|
|
412
|
+
"id": "pilot.pilot.openG9PilotPanel",
|
|
413
|
+
"export": "openG9PilotPanel",
|
|
414
|
+
"from": "@g9tm/lynxcontrols-pilot",
|
|
415
|
+
"kind": "function",
|
|
416
|
+
"signature": "(_props?: G9PilotPanelProps | undefined): boolean",
|
|
417
|
+
"summary": "False: this build has no panel to open."
|
|
418
|
+
}
|
|
419
|
+
]
|
|
420
|
+
}
|
package/catalog/index.md
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# Catalog index: `@g9tm/lynxcontrols-pilot` 2.4.1
|
|
2
|
+
|
|
3
|
+
One line per component; the card (`cards/<Export>.md`) has its props and an example.
|
|
4
|
+
|
|
5
|
+
- G9PilotHost — Renders its children: this build carries no G9AppPilot.
|
|
6
|
+
- G9PilotMask — The masked box, as a plain box: this build takes no screenshots.
|
|
7
|
+
- G9PilotPanel — Nothing: this build carries no watch to show.
|