@standardagents/code-web 0.14.1-branch.02dea02c.1bc066

package/README.md

@@ -0,0 +1,102 @@
+# Standard viewer runtime for the browser
+
+`@standardagents/code-web` is the Standard TUI compiled to `wasm32-unknown-unknown`
+with its wasm-bindgen glue and the fonts it draws with. It is a viewer and
+controller for panes that live on native Standard hosts; it never hosts panes.
+The package ships the runtime only: the site owns the page, the canvas, and the
+event wiring.
+
+## Versions
+
+Every version is built from the exact commit of a native `@standardagents/code`
+build and publishes under that build's version and dist-tag (`canary`,
+`latest`, `issue-*`, `branch-*`), after the native packages are on npm. So
+`@standardagents/code-web@1.2.3-canary.abcdef` is the viewer for the fleet
+running `@standardagents/code@1.2.3-canary.abcdef`; the wire protocol has no
+negotiation, so a site pins the runtime that matches a fleet version exactly.
+The runtime is built in the publication workflow on GitHub Actions and is not
+yet signed by the native artifact key; depend on it by exact version.
+
+## Contents
+
+```
+dist/pkg/standard_web.js          wasm-bindgen glue (ES module, `--target web`)
+dist/pkg/standard_web.d.ts        its types
+dist/pkg/standard_web_bg.wasm     the module
+dist/fonts/*.ttf                  JetBrains Mono Nerd Font (Mono): Regular, Bold, Italic, BoldItalic
+dist/licenses/*.txt               font licenses (OFL 1.1; Nerd Fonts patch MIT)
+dist/build.json                   {schema, commit, version} of the native build
+```
+
+Exports:
+
+| Specifier | File |
+|---|---|
+| `@standardagents/code-web` | `dist/pkg/standard_web.js` (types alongside) |
+| `@standardagents/code-web/standard_web_bg.wasm` | `dist/pkg/standard_web_bg.wasm` |
+| `@standardagents/code-web/fonts/<file>.ttf` | `dist/fonts/<file>.ttf` |
+| `@standardagents/code-web/licenses/<file>.txt` | `dist/licenses/<file>.txt` |
+| `@standardagents/code-web/build.json` | `dist/build.json` |
+
+## Using it from a Vite app
+
+Import the glue, hand `init` the wasm URL, then drive the exported classes.
+The consumer declares the `@font-face` rules for the four bundled fonts and
+waits for them before the first frame, so the grid is measured with the right
+metrics.
+
+```js
+import init, { DeviceLogin, Session, forget_browser } from "@standardagents/code-web";
+import wasmUrl from "@standardagents/code-web/standard_web_bg.wasm?url";
+
+await init(wasmUrl);
+// Create a Session against the page's canvas and wire keyboard, pointer,
+// resize, and visibility events to it.
+```
+
+```css
+@font-face {
+  font-family: "JetBrainsMono Nerd Font Mono";
+  src: url("@standardagents/code-web/fonts/JetBrainsMonoNerdFontMono-Regular.ttf") format("truetype");
+  font-weight: 400;
+  font-style: normal;
+}
+/* Bold (700/normal), Italic (400/italic), BoldItalic (700/italic) likewise. */
+```
+
+`packages/web/viewer.js` and `viewer.css` in the repository are the reference
+wiring: the canvas and focus handling, input translation, the font preload,
+device-flow sign-in with `DeviceLogin`, the `Session` lifecycle, and the
+notices the runtime raises. They are the development preview only and are not
+part of the package.
+
+## Serving it
+
+The runtime needs wasm execution and same-origin fonts and scripts; the site
+plan (`docs/plans/standard-web-viewer.md`, E2) serves the terminal document
+with
+
+```
+default-src 'none'; script-src 'self' 'wasm-unsafe-eval'; style-src 'self';
+font-src 'self'; img-src 'self' data: blob:;
+connect-src 'self' wss://relay.standardcode.ai; worker-src 'self';
+object-src 'none'; base-uri 'none'; form-action 'none'; frame-ancestors 'none'
+```
+
+plus `Cross-Origin-Opener-Policy: same-origin`. `Session` takes the URL it
+reads the relay issuer keys from; the preview passes `/relay-keys` on its own
+origin and `scripts/serve.mjs` proxies it, so a site proxies that endpoint the
+same way.
+
+## Building locally
+
+`node scripts/build.mjs` runs `cargo build --locked --release --target
+wasm32-unknown-unknown -p standard-web`, `wasm-bindgen --target web`, fetches
+and verifies the pinned fonts, and copies the licenses and the preview page
+into `dist/`. The `wasm-bindgen` CLI must be the version `Cargo.lock` pins;
+`node scripts/build.mjs --check` verifies that and names the `cargo install`
+command otherwise. `node scripts/serve.mjs [host] [port]` serves `dist/` as
+the preview.
+
+The version in this package's `package.json` is a placeholder; the publisher
+sets the native build's version at publication time.

package/dist/build.json

@@ -0,0 +1 @@
+{"schema":1,"commit":"1bc066ab298b33cef2c14d660af424f6d71a8bb6","version":"0.14.1-branch.02dea02c.1bc066"}

package/dist/licenses/JetBrainsMono-OFL.txt

@@ -0,0 +1,94 @@
+JetBrains Mono
+Copyright 2020 The JetBrains Mono Project Authors (https://github.com/JetBrains/JetBrainsMono)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/dist/licenses/NerdFonts-MIT.txt

@@ -0,0 +1,29 @@
+Nerd Fonts (the glyph patching applied to the JetBrains Mono files in fonts/)
+https://github.com/ryanoasis/nerd-fonts
+
+The patched font files remain under the JetBrains Mono license in
+JetBrainsMono-OFL.txt. The Nerd Fonts patcher and the added glyph sets are
+distributed under the MIT License below; the glyph sets carry their own
+upstream licenses, listed at the repository above.
+
+MIT License
+
+Copyright (c) 2014 Ryan L McIntyre
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/pkg/standard_web.d.ts

@@ -0,0 +1,156 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * One device login in progress.
+ */
+export class DeviceLogin {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Resolves to the credential once approved, or `undefined` while the
+     * login is still pending. Rejects when it was denied or has expired.
+     */
+    poll(): Promise<any>;
+    /**
+     * Starts a login against `api_origin`, e.g. `https://api.standardcode.ai`.
+     */
+    static start(api_origin: string): Promise<DeviceLogin>;
+    /**
+     * The code the person confirms on the verification page.
+     */
+    readonly code: string;
+    /**
+     * How long to wait between polls, in milliseconds.
+     */
+    readonly intervalMs: number;
+    /**
+     * Where the person approves this login.
+     */
+    readonly verificationUrl: string;
+}
+
+export class Session {
+    free(): void;
+    [Symbol.dispose](): void;
+    columns(): number;
+    focus(focused: boolean): void;
+    /**
+     * One animation frame. Returns `true` once the session has ended.
+     */
+    frame(): boolean;
+    /**
+     * A `keydown` or `keyup`. Returns whether the viewer consumed it, so
+     * the page can suppress the browser's default action.
+     */
+    key(key: string, code: string, ctrl: boolean, alt: boolean, shift: boolean, meta: boolean, repeat: boolean, release: boolean): boolean;
+    /**
+     * Starts the viewer on `canvas`, whose backing store is already sized in
+     * device pixels. `font_px` is the font size in device pixels.
+     * With an `api_origin` and a `token` the viewer shows that account;
+     * without them it runs on the built-in demo account. `relay_keys_url`
+     * is where the relay's public issuer keyset is read from: the issuer
+     * sends no CORS headers, so the site serves it from its own origin.
+     */
+    constructor(canvas: HTMLCanvasElement, family: string, font_px: number, api_origin?: string | null, token?: string | null, relay_keys_url?: string | null);
+    paste(text: string): void;
+    /**
+     * `action` is 0 down, 1 up, 2 move; `x` and `y` are device pixels
+     * relative to the canvas.
+     */
+    pointer(action: number, button: number, x: number, y: number, ctrl: boolean, alt: boolean, shift: boolean): void;
+    /**
+     * The page resized the canvas backing store or changed the font size
+     * (a device-pixel-ratio change does both).
+     */
+    resize(font_px: number): void;
+    rows(): number;
+    /**
+     * Text copied since the last call. The page writes it to the system
+     * clipboard from inside the event handler that produced it.
+     */
+    take_clipboard(): string | undefined;
+    /**
+     * Wheel deltas in device pixels.
+     */
+    wheel(delta_x: number, delta_y: number, x: number, y: number, ctrl: boolean, alt: boolean, shift: boolean): void;
+}
+
+/**
+ * Revokes this browser's machine in the account and discards its stored
+ * identity. The page clears the credential and reloads afterwards.
+ */
+export function forget_browser(api_origin: string, token: string): Promise<void>;
+
+/**
+ * Runs the secure link end to end inside this page and reports the result.
+ */
+export function link_check(): string;
+
+/**
+ * Panics reach the console with their message from the first call on, not
+ * only once a session exists.
+ */
+export function start(): void;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_devicelogin_free: (a: number, b: number) => void;
+    readonly devicelogin_code: (a: number, b: number) => void;
+    readonly devicelogin_intervalMs: (a: number) => number;
+    readonly devicelogin_poll: (a: number) => number;
+    readonly devicelogin_start: (a: number, b: number) => number;
+    readonly devicelogin_verificationUrl: (a: number, b: number) => void;
+    readonly forget_browser: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbg_session_free: (a: number, b: number) => void;
+    readonly link_check: (a: number) => void;
+    readonly session_columns: (a: number) => number;
+    readonly session_focus: (a: number, b: number, c: number) => void;
+    readonly session_frame: (a: number, b: number) => void;
+    readonly session_key: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number) => void;
+    readonly session_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number) => void;
+    readonly session_paste: (a: number, b: number, c: number, d: number) => void;
+    readonly session_pointer: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
+    readonly session_resize: (a: number, b: number, c: number) => void;
+    readonly session_rows: (a: number) => number;
+    readonly session_take_clipboard: (a: number, b: number) => void;
+    readonly session_wheel: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
+    readonly start: () => void;
+    readonly __wasm_bindgen_func_elem_9261: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_9263: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_586: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_586_2: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_586_3: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_export: (a: number, b: number) => number;
+    readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_export3: (a: number) => void;
+    readonly __wbindgen_export4: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_export5: (a: number, b: number) => void;
+    readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;