@kana-ai/edgar-ext-screenshots 0.0.0-stage → 0.1.0

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/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Kana.ai
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
202
+
package/README.md CHANGED
@@ -1,3 +1,115 @@
1
- # Temporary Holding Version
1
+ # @kana-ai/edgar-ext-screenshots
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ The screenshots extension of EDGAR. It captures a web page as a PNG file in the run's sandbox with the machine's Chrome or Chromium, and compares two PNG files pixel by pixel. Workflows call its tools as `screenshots__capture`, `screenshots__compare` and `screenshots__preview`. It also puts a picture of each service's preview page in the body of the pull request that `remediate` opens.
4
+
5
+ ## Tools
6
+
7
+ | Tool | Input | Output | Notes |
8
+ | --------- | ---------------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
9
+ | `capture` | `url`, `path`, `viewport` (`width`, `height`), `full_page`, `wait_for` | `path`, `width`, `height`, `bytes` | `url` is `http` or `https`. `path` is a relative path in the work folder that ends in `.png`. `viewport` is 1280 by 800 by default. `wait_for` is a CSS selector, or a number of milliseconds after the page loads. |
10
+ | `compare` | `before`, `after`, `threshold` | `differing_pixels`, `share`, `same` | `before` and `after` are PNG files of the work folder. A pixel differs when one channel differs. `same` is `share <= threshold`; `threshold` is 0 by default. Two sizes differ everywhere. |
11
+ | `preview` | `service` | `path`, `bytes`, `caption`; or `missing` | Captures the page that `[extensions.screenshots] previews` names for `service` into `/tmp/edgar-preview.png`, the run's temporary folder, which no commit holds. A service with no page is `skipped`. A page that does not load is `done` with `missing` and the reason. |
12
+
13
+ ## How it works
14
+
15
+ 1. The tool sends the source of `src/browser/session.ts` to the sandbox as `node --input-type=module-typescript -e <source> -- <job>`. The session imports only `node:` modules and types, which Node erases.
16
+ 2. Inside the sandbox, the session starts the first browser that exists, headless, with `--remote-debugging-pipe`, and drives it over the DevTools protocol on file descriptors 3 and 4. It needs no package, and it downloads no browser.
17
+ 3. The session writes the PNG file and prints one JSON line, which the tool reads.
18
+
19
+ The browser is the first that exists of:
20
+
21
+ 1. `[extensions.screenshots] browser`, when it is set. Only this path is tried.
22
+ 2. `google-chrome`, `google-chrome-stable`, `chromium`, `chromium-browser` and `chrome` in each `PATH` folder.
23
+ 3. The usual install paths: `/Applications/Google Chrome.app`, `/Applications/Chromium.app`, `/opt/google/chrome/chrome`, `/usr/lib/chromium/chromium` and `/snap/bin/chromium`.
24
+
25
+ `edgar check` refuses the project with `X008` when the extension is enabled and no browser is found. The extension also declares `node` in `executables.requires`, because `capture` runs the browser session on Node in the sandbox, so a machine with no `node` on `PATH` is `X008` too. The sandbox must see the browser: the `worktree` kind binds `/usr`, `/bin`, `/lib` and each `PATH` folder, so a browser under `/opt` must have its folder on `PATH`. The `container` kind needs the browser in `[sandbox] image`. On Debian, `/usr/bin/chromium` is a script that reads `/etc/chromium.d`, which the sandbox does not bind, so set `browser = "/usr/lib/chromium/chromium"`.
26
+
27
+ ## Enable and approve
28
+
29
+ 1. Add the package to the project, and enable it in `edgar/edgar.toml`:
30
+
31
+ ```toml
32
+ [extensions]
33
+ enabled = ["screenshots"]
34
+
35
+ [extensions.screenshots]
36
+ browser = "/usr/bin/chromium" # optional
37
+ previews = { api = "http://127.0.0.1:8080/" } # optional: the page of each service's stack
38
+ ```
39
+
40
+ 2. Approve its capabilities. The manifest declares `sandbox:read` and `sandbox:write`, no secret and no network:
41
+
42
+ ```sh
43
+ edgar extensions approve screenshots
44
+ ```
45
+
46
+ 3. Run `edgar check`.
47
+
48
+ ## The preview in the pull request
49
+
50
+ The extension adds the layer `workflows/remediate.toml` onto the built-in `remediate`:
51
+
52
+ 1. `preview` runs `screenshots__preview` after `final_checks` passes, with `stack = true`, so the service's environment starts its stack first.
53
+ 2. `attach_preview` runs `github__attach_screenshot` after `open_pr`. It stores the picture on the branch `edgar/screenshots` and puts it in the body. See the [GitHub extension](/packages/extensions/ext-github/README.md).
54
+
55
+ A service with no entry in `previews` gets no picture and no line in its body. The layer needs the `github` extension, as `remediate` does.
56
+
57
+ ## Network
58
+
59
+ The extension declares no network. A capture reaches the network only through the stage's `network` list, so name the url's host in the stage. A page that a command in the same sandbox serves on `localhost` needs no host.
60
+
61
+ ## Limits
62
+
63
+ The extension calls no vendor, so it reports no limit. A page it captures can answer 429, which is the page's own answer and is not a limit of EDGAR.
64
+
65
+ ## Call it from a stage
66
+
67
+ ```toml
68
+ [stages.shot]
69
+ needs = ["implement"]
70
+ tool = "screenshots__capture"
71
+ input = { url = "trigger.card.preview_url", path = "trigger.card.shot_path" }
72
+ network = ["preview.shop.example"]
73
+
74
+ [stages.diff]
75
+ needs = ["shot"]
76
+ tool = "screenshots__compare"
77
+ input = { before = "trigger.card.baseline_path", after = "stages.shot.output.path" }
78
+ ```
79
+
80
+ An agent role calls the tools when its `agent.toml` lists them: `tools = ["screenshots__capture", "screenshots__compare"]`.
81
+
82
+ ## Use it as a check
83
+
84
+ A service check is a command, and a command cannot call a tool. To gate a workflow on a comparison, run `compare` as a stage and put a `when` on its output:
85
+
86
+ ```toml
87
+ [stages.review]
88
+ needs = ["diff"]
89
+ when = { path = "stages.diff.output.same", equals = false }
90
+ agent = "review"
91
+ ```
92
+
93
+ ## Errors
94
+
95
+ Each tool returns a failure as its outcome and throws only for a bug:
96
+
97
+ - An input that does not match the tool's schema is a permanent `invalid_input`.
98
+ - A `[extensions.screenshots]` table that does not match its schema, such as `browser = ""` or an unknown key, is a permanent `invalid` with each schema message in `cause`. The tool does not fall back to the default browser, and it runs nothing in the sandbox.
99
+ - A sandbox port that refuses the call is a permanent `refused`. A payload over the port limit is `runtime_payload_too_large`, an unknown id is `not_found`, and an ended call is `cancelled`.
100
+ - An `engine_error` from the sandbox port is a temporary `runtime_crashed`, so the engine runs the step again.
101
+ - A session that prints no answer, or that answers with an error, is a permanent `tool_error`. Its `cause` holds the exit code and the end of the session's stderr.
102
+
103
+ ## Build and test
104
+
105
+ ```sh
106
+ pnpm build # writes edgar-extension.json and schemas/
107
+ pnpm test # unit tests: the schemas, the browser lookup, the session's arguments, the decoder and the comparison, with no browser
108
+ ```
109
+
110
+ `edgar-extension.json` and `schemas/` are committed: a change to them in a diff is a change to what a person approves.
111
+
112
+ ## Shortcuts
113
+
114
+ - shortcut: the decoder reads 8-bit RGB and RGBA images without interlace, which is what Chrome writes. Upgrade it when a baseline comes from another program.
115
+ - shortcut: the session reads and writes the images itself, because only `utf8` crosses the sandbox ports. Upgrade to the ports when `base64` crosses them.
@@ -0,0 +1,2 @@
1
+ /** The paths to try in order: the configured one alone, else each name in each `PATH` folder, then the install paths. The session inside the sandbox starts the first that exists. */
2
+ export declare function candidates(browser: string | undefined, path: string): readonly string[];
@@ -0,0 +1,18 @@
1
+ import { delimiter, join } from "node:path";
2
+ /** The browser names looked for on `PATH`; keep in step with `edgar check` in `commands/check.rs`. */
3
+ const NAMES = ["google-chrome", "google-chrome-stable", "chromium", "chromium-browser", "chrome"];
4
+ /** The usual install paths, after `PATH`. */
5
+ const INSTALLED = [
6
+ "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
7
+ "/Applications/Chromium.app/Contents/MacOS/Chromium",
8
+ "/opt/google/chrome/chrome",
9
+ "/usr/lib/chromium/chromium",
10
+ "/snap/bin/chromium",
11
+ ];
12
+ /** The paths to try in order: the configured one alone, else each name in each `PATH` folder, then the install paths. The session inside the sandbox starts the first that exists. */
13
+ export function candidates(browser, path) {
14
+ if (browser !== undefined)
15
+ return [browser];
16
+ const folders = path.split(delimiter).filter((folder) => folder.startsWith("/"));
17
+ return [...folders.flatMap((folder) => NAMES.map((name) => join(folder, name))), ...INSTALLED];
18
+ }
@@ -0,0 +1,51 @@
1
+ import type { Result } from "@kana-ai/edgar-sdk/result";
2
+ /** An answer of the session: the tool's output, or why there is none. */
3
+ export type Answer = Result<Readonly<Record<string, unknown>>, string>;
4
+ /** A decoded image: 4 bytes per pixel, red, green, blue and alpha. */
5
+ export interface Image {
6
+ readonly width: number;
7
+ readonly height: number;
8
+ readonly rgba: Uint8Array;
9
+ }
10
+ /** What the tools ask the session to do. */
11
+ export type Job = {
12
+ readonly kind: "capture";
13
+ readonly browsers: readonly string[];
14
+ readonly url: string;
15
+ readonly path: string;
16
+ readonly width: number;
17
+ readonly height: number;
18
+ readonly full_page: boolean;
19
+ readonly wait_for: string | number | null;
20
+ } | {
21
+ readonly kind: "compare";
22
+ readonly before: string;
23
+ readonly after: string;
24
+ readonly threshold: number;
25
+ };
26
+ /** The file of `path` on this machine: a path under `/tmp/` is in the run's temporary folder, `TMPDIR`, as the sandbox's ports read it, and any other path is in the work folder. */
27
+ export declare function placed(path: string): string;
28
+ /** The first of `browsers` that exists. */
29
+ export declare function pick(browsers: readonly string[], exists: (path: string) => boolean): string | undefined;
30
+ /** The flags Chrome starts with: headless, no sandbox of its own inside EDGAR's, the DevTools protocol on fds 3 and 4, and the sandbox's proxy when the stage names hosts. */
31
+ export declare function chromeArgs(profile: string, proxy: string | undefined, width: number, height: number): readonly string[];
32
+ /** The width and height a PNG file's header states. */
33
+ export declare function dimensions(png: Uint8Array): {
34
+ readonly width: number;
35
+ readonly height: number;
36
+ };
37
+ /** An 8-bit RGB or RGBA PNG file without interlace, as Chrome writes it, decoded. */
38
+ export declare function decode(png: Uint8Array): Result<Image, string>;
39
+ /** The pixels that differ in any channel, and their share; images of two sizes differ everywhere. */
40
+ export declare function compare(before: Image, after: Image, threshold: number): {
41
+ readonly differing_pixels: number;
42
+ readonly share: number;
43
+ readonly same: boolean;
44
+ };
45
+ /** Runs one job. */
46
+ export declare function run(job: Job): Promise<Answer>;
47
+ /**
48
+ * The job the tools wrote as the one argument; `undefined` when it is not one. Its `try` stays: the session imports
49
+ * only `node:` modules and types, so `attempt` cannot reach it in the sandbox.
50
+ */
51
+ export declare function parseJob(text: string | undefined): Job | undefined;