@openchamber/sdk 2.4.0 → 2.5.1

package/dist/service-providers.js

@@ -15,12 +15,14 @@ export const BROWSER_CONTROL_ACTIONS = [
     'browser.snapshot',
     'browser.click',
     'browser.type',
+    'browser.select',
     'browser.scroll',
     'browser.back',
     'browser.forward',
     'browser.inspect',
     'browser.capture',
     'browser.resize',
+    'browser.close',
 ];
 export const BROWSER_VIEWPORT_MODES = ['mobile', 'tablet', 'desktop', 'fill'];
 export const BROWSER_SCROLL_DIRECTIONS = ['up', 'down', 'top', 'bottom'];
@@ -71,3 +73,218 @@ export const readBrowserProviderRequest = (body) => {
     // and the host validated the parameters for this action before posting.
     return { requestId, action, parameters, context: readContext(context) };
 };
+/*
+ * Source control: a service with `provides: ["source-control"]` is the Git
+ * host `contributes.sourceControl` describes. OpenChamber keeps the user's
+ * accounts and tokens, the bindings, the idempotent mutation records and the
+ * caches; it forwards the resource reads and the three mutation steps to the
+ * service at `SOURCE_CONTROL_PROVIDER_PATH`. The service never sees a token: it
+ * reaches the forge through OpenChamber's outbound proxy
+ * (`createSourceControlForge`), which pins the instance origin and adds the
+ * stored token itself.
+ */
+/** Route on the service loopback OpenChamber posts every source-control call to. */
+export const SOURCE_CONTROL_PROVIDER_PATH = '/source-control';
+/** The `v` of every request; a service answers a version it does not know with HTTP 400. */
+export const SOURCE_CONTROL_PROVIDER_WIRE_VERSION = 1;
+/**
+ * Every call OpenChamber forwards. `auth.verify` reads who a candidate token
+ * belongs to and `auth.probe` whether the instance is this forge; the fifteen
+ * reads take the shell's own input without the session; the three
+ * `mutation.*` steps are the part of a write the service owns, while
+ * OpenChamber owns the kind, the normalized input, its digest, the
+ * idempotency record and when each step runs.
+ */
+export const SOURCE_CONTROL_PROVIDER_METHODS = [
+    'auth.verify',
+    'auth.probe',
+    'changeRequestStatus',
+    'listChangeRequests',
+    'changeRequestContext',
+    'listIssues',
+    'getIssue',
+    'issueComments',
+    'projectUpstream',
+    'projectBranches',
+    'listLabels',
+    'listReviewerCandidates',
+    'readChangeRequestPatch',
+    'readChangeRequestFile',
+    'liveSummaries',
+    'readChangeRequestHead',
+    'resolveChangeRequestSource',
+    'mutation.resolveTarget',
+    'mutation.perform',
+    'mutation.reconcile',
+];
+/** `changeRequestStatus` answers within the badge's own deadline; past it the last known status shows. */
+export const SOURCE_CONTROL_PROVIDER_STATUS_TIMEOUT_MS = 12_000;
+export const SOURCE_CONTROL_PROVIDER_READ_TIMEOUT_MS = 20_000;
+export const SOURCE_CONTROL_PROVIDER_MUTATION_TIMEOUT_MS = 30_000;
+export const SOURCE_CONTROL_PROVIDER_AUTH_TIMEOUT_MS = 15_000;
+/** Answers are read up to this many bytes, enough for a change request's patch or one file. */
+export const SOURCE_CONTROL_PROVIDER_RESPONSE_MAX = 8_000_000;
+/** Characters of `error.message` OpenChamber reads. */
+export const SOURCE_CONTROL_PROVIDER_ERROR_MESSAGE_MAX = 2_000;
+/** No call for this long stops the service; the next call starts it again. */
+export const SOURCE_CONTROL_PROVIDER_IDLE_MS = 10 * 60_000;
+/** Characters of a mutation's `providerTarget` JSON, which OpenChamber stores with the record. */
+export const SOURCE_CONTROL_PROVIDER_TARGET_MAX = 4_096;
+/** How long OpenChamber waits for the service to answer `method`. */
+export const sourceControlProviderTimeoutMs = (method) => {
+    if (method === 'changeRequestStatus')
+        return SOURCE_CONTROL_PROVIDER_STATUS_TIMEOUT_MS;
+    if (method === 'auth.verify' || method === 'auth.probe')
+        return SOURCE_CONTROL_PROVIDER_AUTH_TIMEOUT_MS;
+    if (method.startsWith('mutation.'))
+        return SOURCE_CONTROL_PROVIDER_MUTATION_TIMEOUT_MS;
+    return SOURCE_CONTROL_PROVIDER_READ_TIMEOUT_MS;
+};
+/**
+ * Environment variable with the base URL of OpenChamber's callback listener
+ * (`http://127.0.0.1:<port>`). Set only for a service that provides
+ * `source-control`; `createSourceControlForge` reads it.
+ */
+export const OPENCHAMBER_HOST_CALLBACK_URL = 'OPENCHAMBER_HOST_CALLBACK_URL';
+/** Route on the callback listener a service sends a forge request to. */
+export const SOURCE_CONTROL_OUTBOUND_PATH = '/source-control/outbound';
+export const SOURCE_CONTROL_OUTBOUND_METHODS = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'];
+/** Request headers OpenChamber passes to the forge; it sets every other header itself. */
+export const SOURCE_CONTROL_OUTBOUND_REQUEST_HEADERS = ['accept', 'content-type', 'if-none-match', 'range'];
+/** Response headers OpenChamber hands back, plus any starting with `SOURCE_CONTROL_OUTBOUND_RESPONSE_HEADER_PREFIX`. */
+export const SOURCE_CONTROL_OUTBOUND_RESPONSE_HEADERS = ['content-type', 'link', 'etag', 'x-total-count', 'x-total', 'retry-after'];
+export const SOURCE_CONTROL_OUTBOUND_RESPONSE_HEADER_PREFIX = 'x-ratelimit-';
+/** Characters of an outbound request body. */
+export const SOURCE_CONTROL_OUTBOUND_BODY_MAX = 1_000_000;
+/** Bytes of a forge answer OpenChamber reads; a longer one is refused whole. */
+export const SOURCE_CONTROL_OUTBOUND_RESPONSE_MAX = 8_000_000;
+/** One forge request may take this long; the call's own deadline may end it sooner. */
+export const SOURCE_CONTROL_OUTBOUND_TIMEOUT_MS = 20_000;
+export const isSourceControlProviderMethod = (value) => (SOURCE_CONTROL_PROVIDER_METHODS.some((method) => method === value));
+/** `undefined` is a user that is neither `null` nor `{ id, login }`. */
+const readSessionUser = (user) => {
+    if (user === null)
+        return null;
+    if (Object(user) !== user || user === undefined)
+        return undefined;
+    const { id, login } = user;
+    if (!Number.isSafeInteger(id) || String(login) !== login || login.length === 0)
+        return undefined;
+    return { id: Number(id), login };
+};
+/** `undefined` is a session that is neither `null` nor `{ instance, handle, user }`. */
+const readSession = (session) => {
+    if (session === null)
+        return null;
+    if (Object(session) !== session || session === undefined)
+        return undefined;
+    const { instance, handle } = session;
+    if (String(instance) !== instance || instance.length === 0 || String(handle) !== handle || handle.length === 0)
+        return undefined;
+    const user = readSessionUser(session.user);
+    if (user === undefined)
+        return undefined;
+    return { instance, handle, user };
+};
+/**
+ * A service's read of the body OpenChamber posted to
+ * `SOURCE_CONTROL_PROVIDER_PATH`. OpenChamber built and validated `input`, so
+ * this checks the envelope, not every field, and the service bundle needs no
+ * schema library. `null` is a body that is not a source-control call of this
+ * wire version; answer it with HTTP 400.
+ */
+export const readSourceControlProviderRequest = (body) => {
+    let wire;
+    try {
+        const parsed = JSON.parse(body);
+        if (Object(parsed) !== parsed || parsed === null)
+            return null;
+        wire = parsed;
+    }
+    catch {
+        return null;
+    }
+    const { v, requestId, method, provider, input } = wire;
+    if (v !== SOURCE_CONTROL_PROVIDER_WIRE_VERSION)
+        return null;
+    if (String(requestId) !== requestId || requestId.length === 0)
+        return null;
+    if (String(provider) !== provider || provider.length === 0)
+        return null;
+    if (String(method) !== method || !isSourceControlProviderMethod(method))
+        return null;
+    if (Object(input) !== input || Array.isArray(input))
+        return null;
+    const session = readSession(wire.session);
+    if (session === undefined)
+        return null;
+    // SAFETY: `input` is a plain object parsed from JSON, so every value in it is JSON.
+    return { v: SOURCE_CONTROL_PROVIDER_WIRE_VERSION, requestId, method, provider, session, input: input };
+};
+/**
+ * OpenChamber refused the request (an expired handle, a path off the
+ * instance, a body too large), could not reach the forge, or did not answer.
+ * `status` is the callback listener's HTTP status, `0` when it gave none;
+ * `code` is its error code (`HOST_UNAVAILABLE` when there was no usable answer).
+ */
+export class SourceControlForgeError extends Error {
+    code;
+    status;
+    constructor(message, code, status) {
+        super(message);
+        this.name = 'SourceControlForgeError';
+        this.code = code;
+        this.status = status;
+    }
+}
+/**
+ * The service's way to the forge: OpenChamber's callback listener
+ * (`OPENCHAMBER_HOST_CALLBACK_URL`), which checks the handle, keeps the request
+ * on the instance origin and adds the token. Plain `fetch`, no dependencies.
+ * Throws `SourceControlForgeError` when OpenChamber refuses the request; a
+ * forge answer of any status, 401 included, resolves.
+ */
+export const createSourceControlForge = ({ env }) => {
+    const base = env[OPENCHAMBER_HOST_CALLBACK_URL];
+    if (!base)
+        throw new Error(`${OPENCHAMBER_HOST_CALLBACK_URL} is not set: only a service that provides "source-control" can reach a forge.`);
+    const url = `${base.replace(/\/+$/, '')}${SOURCE_CONTROL_OUTBOUND_PATH}`;
+    return {
+        async request(handle, request) {
+            let response;
+            try {
+                response = await fetch(url, {
+                    method: 'POST',
+                    headers: { authorization: `Bearer ${handle}`, 'content-type': 'application/json' },
+                    body: JSON.stringify(request),
+                    // A little past OpenChamber's own deadline, so its answer wins.
+                    signal: AbortSignal.timeout(SOURCE_CONTROL_OUTBOUND_TIMEOUT_MS + 5_000),
+                });
+            }
+            catch (error) {
+                throw new SourceControlForgeError(`OpenChamber did not answer: ${error instanceof Error ? error.message : String(error)}`, 'HOST_UNAVAILABLE', 0);
+            }
+            let answer;
+            try {
+                answer = Object(await response.json());
+            }
+            catch {
+                throw new SourceControlForgeError('OpenChamber answered with something other than JSON', 'HOST_UNAVAILABLE', response.status);
+            }
+            if (!response.ok) {
+                const message = answer.error?.message;
+                const code = answer.error?.code;
+                throw new SourceControlForgeError(String(message) === message && message.length > 0 ? message : `OpenChamber refused the request (${response.status})`, String(code) === code && code.length > 0 ? code : 'OUTBOUND_REFUSED', response.status);
+            }
+            if (!Number.isSafeInteger(answer.status) || String(answer.body) !== answer.body) {
+                throw new SourceControlForgeError('OpenChamber relayed a malformed forge answer', 'HOST_UNAVAILABLE', response.status);
+            }
+            const headers = {};
+            for (const [name, text] of Object.entries(Object(answer.headers ?? {}))) {
+                if (String(text) === text)
+                    headers[name] = text;
+            }
+            return { status: Number(answer.status), headers, body: answer.body };
+        },
+    };
+};

package/dist/ui/style.js

@@ -61,9 +61,14 @@ const focusFill = `background-image: linear-gradient(${hover}, ${hover});`;
  * top line and one short shadow, and wash a field halfway toward the page so it
  * sits a tone below the buttons beside it. Without the attribute (a preview
  * outside the host) the light form applies.
+ *
+ * Buttons, triggers, tabs and popups keep a 1px border in their geometry so a
+ * tinted variant, whose border is coloured, has the same size. Their hairline
+ * is that border: an inset ring would paint inside it, 1px in from the edge,
+ * with a strip of fill around it. Fields have no border and keep the ring.
  */
 const field = (edge) => `box-shadow: inset 0 0 0 1px ${edge}, var(--oc-sdk-field-lift);`;
-const raised = 'box-shadow: inset 0 0 0 1px var(--oc-sdk-edge), var(--oc-sdk-raised-lift);';
+const raised = 'border-color: var(--oc-sdk-edge); box-shadow: var(--oc-sdk-raised-lift);';
 const litButton = 'box-shadow: var(--oc-sdk-lit);';
 const darkLift = `inset 0 1px 0 0 ${mix(fg, 1.5)}, 0 1px 1px 0 rgb(0 0 0 / 0.28), 0 2px 3px -2px rgb(0 0 0 / 0.2)`;
 const THEME_VARS = `
@@ -74,7 +79,8 @@ const THEME_VARS = `
   --oc-sdk-field-lift: inset 0 1px 2px 0 rgb(0 0 0 / 0.04);
   --oc-sdk-raised-lift: 0 1px 2px 0 rgb(0 0 0 / 0.06);
   --oc-sdk-lit: inset 0 1px 0 0 rgb(255 255 255 / 0.45), 0 1px 2px 0 rgb(0 0 0 / 0.08);
-  --oc-sdk-float: inset 0 1px 0 0 rgb(255 255 255 / 0.8), inset 0 0 0 1px rgb(0 0 0 / 0.04), 0 0 0 1px rgb(0 0 0 / 0.1), 0 1px 2px -0.5px rgb(0 0 0 / 0.08), 0 4px 8px -2px rgb(0 0 0 / 0.08), 0 12px 20px -4px rgb(0 0 0 / 0.08);
+  --oc-sdk-float-edge: rgb(0 0 0 / 0.1);
+  --oc-sdk-float: inset 0 1px 0 0 rgb(255 255 255 / 0.8), inset 0 0 0 1px rgb(0 0 0 / 0.04), 0 1px 2px -0.5px rgb(0 0 0 / 0.08), 0 4px 8px -2px rgb(0 0 0 / 0.08), 0 12px 20px -4px rgb(0 0 0 / 0.08);
 }
 :root[data-oc-theme="dark"] {
   --oc-sdk-edge: ${mix(fg, 6)};
@@ -83,7 +89,8 @@ const THEME_VARS = `
   --oc-sdk-field-lift: ${darkLift};
   --oc-sdk-raised-lift: ${darkLift};
   --oc-sdk-lit: inset 0 1px 0 0 ${mix(fg, 1.5)}, 0 1px 1px 0 rgb(0 0 0 / 0.28), 0 2px 3px -2px rgb(0 0 0 / 0.2);
-  --oc-sdk-float: inset 0 1px 0 0 rgb(255 255 255 / 0.06), inset 0 0 0 1px rgb(255 255 255 / 0.08), 0 0 0 1px rgb(0 0 0 / 0.36), 0 1px 1px -0.5px rgb(0 0 0 / 0.22), 0 3px 3px -1.5px rgb(0 0 0 / 0.2), 0 6px 6px -3px rgb(0 0 0 / 0.16);
+  --oc-sdk-float-edge: rgb(0 0 0 / 0.36);
+  --oc-sdk-float: inset 0 1px 0 0 rgb(255 255 255 / 0.06), inset 0 0 0 1px rgb(255 255 255 / 0.08), 0 1px 1px -0.5px rgb(0 0 0 / 0.22), 0 3px 3px -1.5px rgb(0 0 0 / 0.2), 0 6px 6px -3px rgb(0 0 0 / 0.16);
 }`;
 const tone = (name) => {
     const color = v(`status-${name}`, 'currentColor');
@@ -216,9 +223,9 @@ ${tone('success')}${tone('warning')}${tone('error')}${tone('info')}
 .oc-sdk-btn[data-variant="secondary"] { background: ${secondary}; color: var(--oc-fg); }
 .oc-sdk-btn[data-variant="secondary"]:hover { background-image: linear-gradient(${hover}, ${hover}); }
 .oc-sdk-btn[data-variant="secondary"]:active { background-image: linear-gradient(${active}, ${active}); }
-.oc-sdk-btn[data-variant="outline"] { background: var(--oc-sdk-raised-bg); color: ${elevatedFg}; border-color: transparent; ${raised} }
+.oc-sdk-btn[data-variant="outline"] { background: var(--oc-sdk-raised-bg); color: ${elevatedFg}; ${raised} }
 .oc-sdk-btn[data-variant="outline"]:hover { background-image: linear-gradient(${hover}, ${hover}); }
-.oc-sdk-btn[data-variant="outline"]:active { background-image: linear-gradient(${active}, ${active}); box-shadow: inset 0 0 0 1px var(--oc-sdk-edge); }
+.oc-sdk-btn[data-variant="outline"]:active { background-image: linear-gradient(${active}, ${active}); box-shadow: none; }
 .oc-sdk-btn[data-variant="ghost"] { background: transparent; }
 .oc-sdk-btn[data-variant="ghost"]:hover { background: ${hover}; }
 .oc-sdk-btn[data-variant="ghost"]:active { background: ${active}; }
@@ -240,13 +247,13 @@ ${tone('success')}${tone('warning')}${tone('error')}${tone('info')}
 .oc-sdk-search-clear { border-radius: ${smallRadius}; color: ${muted}; }
 .oc-sdk-search-clear:hover { background: ${hover}; color: ${fg}; }
 
-.oc-sdk-trigger { border-color: transparent; border-radius: ${controlRadius}; background: var(--oc-sdk-raised-bg); color: ${elevatedFg}; ${raised} transition: background 150ms ease-out; }
+.oc-sdk-trigger { border-radius: ${controlRadius}; background: var(--oc-sdk-raised-bg); color: ${elevatedFg}; ${raised} transition: background 150ms ease-out; }
 .oc-sdk-trigger:hover { background-image: linear-gradient(${hover}, ${hover}); }
 .oc-sdk-trigger[aria-expanded="true"] { background-image: linear-gradient(${active}, ${active}); }
 .oc-sdk-trigger-value[data-empty="true"] { color: ${muted}; }
 .oc-sdk-trigger-chevron { color: ${muted}; }
-/* The app's dropdown light: lit top, hairline rings and a layered shadow, no border. */
-.oc-sdk-popup { --surface-foreground: ${elevatedFg}; border-color: transparent; border-radius: 12px; background: ${elevated}; color: ${elevatedFg}; box-shadow: var(--oc-sdk-float); }
+/* The app's dropdown light: lit top, hairline rings and a layered shadow. Its outer ring is the border, over the page like the app's. */
+.oc-sdk-popup { --surface-foreground: ${elevatedFg}; border-color: var(--oc-sdk-float-edge); border-radius: 12px; background: ${elevated}; background-clip: padding-box; color: ${elevatedFg}; box-shadow: var(--oc-sdk-float); }
 .oc-sdk-option { border-radius: 8px; }
 .oc-sdk-option[data-active="true"] { background: ${hover}; }
 /* A selected option shows a check mark in the text colour, like the app's own pickers. Options without the mark come
@@ -274,7 +281,7 @@ ${tone('success')}${tone('warning')}${tone('error')}${tone('info')}
 .oc-sdk-tab { border-radius: 8px; color: ${muted}; transition: color 150ms ease-out, background 150ms ease-out; }
 .oc-sdk-tab:hover { color: ${fg}; }
 .oc-sdk-tab[aria-selected="true"] { color: ${selectionFg}; background: ${selection}; border-color: ${border}; }
-.oc-sdk-tabs[data-track="true"] .oc-sdk-tab[aria-selected="true"] { color: ${elevatedFg}; background: var(--oc-sdk-raised-bg); border-color: transparent; ${raised} }
+.oc-sdk-tabs[data-track="true"] .oc-sdk-tab[aria-selected="true"] { color: ${elevatedFg}; background: var(--oc-sdk-raised-bg); ${raised} }
 .oc-sdk-tab-count { color: ${muted}; }
 
 .oc-sdk-badge { border-radius: 9999px; background: ${hover}; color: ${muted}; }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openchamber/sdk",
-  "version": "2.4.0",
+  "version": "2.5.1",
   "description": "Contract for OpenChamber guests: manifest parse and iframe host bridge.",
   "private": false,
   "license": "MIT",
@@ -34,7 +34,7 @@
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
-    "type-check": "tsc --noEmit",
+    "type-check": "bun check",
     "lint": "oxlint -c ../../oxlint.config.ts --report-unused-disable-directives src examples",
     "bundle": "bun scripts/bundle-guest.ts",
     "test": "node ../../scripts/run-isolated-tests.mjs src scripts",