@stim-cli/core 1.13.0 → 1.15.0

package/dist/protocol.d.mts

@@ -0,0 +1,2 @@
+import { $ as FrameDelayedEvent, $n as VIDEO_CODECS, $t as NotificationSuppression, A as Capability, An as SERVER_UPDATE_METHODS, At as LogRecord, B as DeviceFrameArtwork, Bn as SettingsResult, Bt as MachineUpdateStatus, C as BuildRequestAuth, Cn as ReplayKeyframeParams, Ct as KeyframeParams, D as BuildToolchain, Dn as ReplayTarget, Dt as LegacyPushEvent, E as BuildSyncResult, En as ReplaySpan, Et as LOG_SOURCES, F as ControlEndedEvent, Fn as ServerUpdateOutcome, Ft as MAX_LOG_TAIL, G as DuoFramePose, Gn as SubscribeResult, Gt as MemoryPressure, H as DeviceHostRequestAuth, Hn as SimulatorOptions, Ht as MachineVolume, I as ControlPlatform, In as ServerUpdatePackage, It as METHODS, J as ErrorEvent, Jn as UnsubscribeParams, Jt as NOTIFICATION_LEVELS, K as ERROR_CODES, Kn as TOUCH_PHASES, Kt as Method, L as DEVICE_HOST_METHODS, Ln as ServerUpdateProgress, Lt as MachineDetails, M as ControlBeginParams, Mn as ServerEvent, Mt as LogsEvent, N as ControlBeginResult, Nn as ServerMessage, Nt as LogsQueryResult, O as CAPABILITIES, On as RequestId, Ot as LogFilter, P as ControlEndParams, Pn as ServerResponse, Pt as MAX_INPUT_TEXT, Q as Feature, Qn as VIDEO_ARTWORK, Qt as NotificationLevel, R as DEVICE_POSTURES, Rn as ServerUpdateStartParams, Rt as MachineHistory, S as BuildProgressEvent, Sn as ReplayKeyframe, St as KeyModifier, T as BuildSyncParams, Tn as ReplayRange, Tt as LOG_LEVELS, U as DevicePosture, Un as StatsResult, Ut as MacosWindow, V as DeviceFrameEvent, Vn as SimulatorCommand, Vt as MachineUsage, W as DeviceUsageSeries, Wn as StatusEvent, Wt as MacosWindowsEvent, X as FRAME_EDGE, Xn as UsageSample, Xt as NotificationEntry, Y as FEATURES, Yn as UsageHistory, Yt as NOTIFICATION_SUPPRESSIONS, Z as FRAME_FPS, Zn as UsageSeries, Zt as NotificationEvent, _ as BuildOfferParams, _n as ROTATE_DIRECTIONS, _t as InputSimulatorParams, a as BUILD_METHODS, an as PROTOCOL_VERSION, ar as VideoPacket, at as FramesSubscribeResult, b as BuildPlanResult, bn as ReloadPlatform, bt as InputWindowParams, c as BuildArtifactResult, cn as PairingAuth, cr as WorkspaceFiles, ct as INPUT_BUTTONS, d as BuildClientSummary, dn as PushEvent, dt as InputButtonParams, en as NotificationTarget, er as VIDEO_FOLDED, et as FrameEvent, f as BuildFile, fn as PushRegisterParams, ft as InputKey, g as BuildMachineReport, gn as REPLAY_RATES, gt as InputScrollParams, h as BuildMachineCapacity, hn as REPLAY_MARKER_KINDS, ht as InputRotateParams, i as ActionResult, in as PROTOCOL_SCHEMA_FILE, ir as VideoCodec, it as FramesSeekResult, j as ClientRequest, jn as ServeRoute, jt as LogSource, k as CONTROL_END_REASONS, kn as RotateDirection, kt as LogLevel, l as BuildAttachResult, ln as Platform, lr as WorkspaceParams, lt as INPUT_KEYS, m as BuildJobParams, mn as RELOAD_PLATFORMS, mt as InputPostureParams, n as ActionName, nn as NotificationsListResult, nr as VIDEO_KEYFRAME, nt as FramesLiveParams, o as BUILD_REPO_PATTERN, on as PUSH_EVENTS, or as WorkspaceDiff, ot as HelloParams, p as BuildJobOutcome, pn as QuietHours, pt as InputKeyParams, q as ErrorCode, qn as TouchPhase, qt as Methods, r as ActionParams, rn as PLATFORMS, rr as VIDEO_UNFOLDED, rt as FramesSeekParams, s as BuildAndroidOptions, sn as PUSH_TOKEN_PATTERN, sr as WorkspaceFile, st as HelloResult, t as ACTIONS, tn as NotificationsListParams, tr as VIDEO_HEADER_VERSION, tt as FrameTarget, u as BuildCapacity, un as ProtocolError, ur as WorkspacePatch, ut as InputButton, v as BuildOfferResult, vn as RecordingSetParams, vt as InputTextParams, w as BuildStartParams, wn as ReplayMarker, wt as LEGACY_PUSH_EVENTS, x as BuildPlatform, xn as ReplayEndedEvent, xt as KEY_MODIFIERS, y as BuildPlanParams, yn as RecordingSetResult, yt as InputTouchParams, z as DeviceAuth, zn as ServerUpdateStatus, zt as MachineHistoryParams } from "./protocol-BjnE921M.mjs";
+export { ACTIONS, ActionName, ActionParams, ActionResult, BUILD_METHODS, BUILD_REPO_PATTERN, BuildAndroidOptions, BuildArtifactResult, BuildAttachResult, BuildCapacity, BuildClientSummary, BuildFile, BuildJobOutcome, BuildJobParams, BuildMachineCapacity, BuildMachineReport, BuildOfferParams, BuildOfferResult, BuildPlanParams, BuildPlanResult, BuildPlatform, BuildProgressEvent, BuildRequestAuth, BuildStartParams, BuildSyncParams, BuildSyncResult, BuildToolchain, CAPABILITIES, CONTROL_END_REASONS, Capability, ClientRequest, ControlBeginParams, ControlBeginResult, ControlEndParams, ControlEndedEvent, ControlPlatform, DEVICE_HOST_METHODS, DEVICE_POSTURES, DeviceAuth, DeviceFrameArtwork, DeviceFrameEvent, DeviceHostRequestAuth, DevicePosture, DeviceUsageSeries, DuoFramePose, ERROR_CODES, ErrorCode, ErrorEvent, FEATURES, FRAME_EDGE, FRAME_FPS, Feature, FrameDelayedEvent, FrameEvent, FrameTarget, FramesLiveParams, FramesSeekParams, FramesSeekResult, FramesSubscribeResult, HelloParams, HelloResult, INPUT_BUTTONS, INPUT_KEYS, InputButton, InputButtonParams, InputKey, InputKeyParams, InputPostureParams, InputRotateParams, InputScrollParams, InputSimulatorParams, InputTextParams, InputTouchParams, InputWindowParams, KEY_MODIFIERS, KeyModifier, KeyframeParams, LEGACY_PUSH_EVENTS, LOG_LEVELS, LOG_SOURCES, LegacyPushEvent, LogFilter, LogLevel, LogRecord, LogSource, LogsEvent, LogsQueryResult, MAX_INPUT_TEXT, MAX_LOG_TAIL, METHODS, MachineDetails, MachineHistory, MachineHistoryParams, MachineUpdateStatus, MachineUsage, MachineVolume, MacosWindow, MacosWindowsEvent, MemoryPressure, Method, Methods, NOTIFICATION_LEVELS, NOTIFICATION_SUPPRESSIONS, NotificationEntry, NotificationEvent, NotificationLevel, NotificationSuppression, NotificationTarget, NotificationsListParams, NotificationsListResult, PLATFORMS, PROTOCOL_SCHEMA_FILE, PROTOCOL_VERSION, PUSH_EVENTS, PUSH_TOKEN_PATTERN, PairingAuth, Platform, ProtocolError, PushEvent, PushRegisterParams, QuietHours, RELOAD_PLATFORMS, REPLAY_MARKER_KINDS, REPLAY_RATES, ROTATE_DIRECTIONS, RecordingSetParams, RecordingSetResult, ReloadPlatform, ReplayEndedEvent, ReplayKeyframe, ReplayKeyframeParams, ReplayMarker, ReplayRange, ReplaySpan, ReplayTarget, RequestId, RotateDirection, SERVER_UPDATE_METHODS, ServeRoute, ServerEvent, ServerMessage, ServerResponse, ServerUpdateOutcome, ServerUpdatePackage, ServerUpdateProgress, ServerUpdateStartParams, ServerUpdateStatus, SettingsResult, SimulatorCommand, SimulatorOptions, StatsResult, StatusEvent, SubscribeResult, TOUCH_PHASES, TouchPhase, UnsubscribeParams, UsageHistory, UsageSample, UsageSeries, VIDEO_ARTWORK, VIDEO_CODECS, VIDEO_FOLDED, VIDEO_HEADER_VERSION, VIDEO_KEYFRAME, VIDEO_UNFOLDED, VideoCodec, VideoPacket, WorkspaceDiff, WorkspaceFile, WorkspaceFiles, WorkspaceParams, WorkspacePatch };

package/dist/protocol.mjs

@@ -0,0 +1,372 @@
+//#region protocol.ts
+const PROTOCOL_VERSION = 1;
+const PROTOCOL_SCHEMA_FILE = "protocol.schema.json";
+/**
+* `read` serves state. `control` also runs {@link ACTIONS}; only the Mac grants it. `build` lets another Mac run
+* project code here to build for it; it never comes with `read` or `control`, and only the Mac approves it.
+* `device-host` permits a client's native app code in its own hosted sessions, and grants no other capability.
+*/
+const CAPABILITIES = [
+	"read",
+	"control",
+	"build",
+	"device-host"
+];
+/**
+* What this server serves beyond protocol version 1's base, so a client can tell before it asks. `physical-ios` and
+* `physical-android` are `physical: true` on `frames.subscribe` for that platform's leased device, and for an
+* Android phone also on `control.begin`. An older server ignores `physical` on `frames.subscribe` and would stream
+* the slot's Stim-owned device instead. `notifications` is `notifications.list` and the `notification` event.
+* `macos-hosted` relays `frames.subscribe` and control for a workspace whose macOS app
+* `stim macos --remote` placed on another Mac.
+* `macos-windows` is the `macos-windows` event on a macOS `frames.subscribe`, naming the window capture follows
+* and the app's other windows.
+* `hosted-congestion` is `device-host.frames.congested`, which lowers the bitrate of a hosted video subscription
+* whose client is behind.
+* `macos-window-select` is `input.window`, which pins the view to a macOS app window named by `macos-windows`,
+* bringing it to the front, or with null resumes following the front window.
+* `server-update` is `server.update.status`, `server.update.start` and `server.update.chunk`.
+*/
+const FEATURES = [
+	"physical-ios",
+	"physical-android",
+	"notifications",
+	"macos-window",
+	"macos-windows",
+	"macos-window-select",
+	"macos-window-control",
+	"macos-keyboard-extended",
+	"device-frames",
+	"macos-hosted",
+	"duo-frames",
+	"workspace-diff",
+	"hosted-congestion",
+	"server-update"
+];
+const METHODS = [
+	"hello",
+	"route.setup",
+	"status.subscribe",
+	"logs.query",
+	"logs.subscribe",
+	"stats.get",
+	"settings.get",
+	"workspace.files",
+	"workspace.diff",
+	"frames.subscribe",
+	"frames.keyframe",
+	"frames.seek",
+	"frames.live",
+	"replay.range",
+	"replay.keyframe",
+	"recording.set",
+	"build.plan",
+	"machine.get",
+	"machine.history",
+	"machine.details",
+	"unsubscribe",
+	"action",
+	"control.begin",
+	"control.end",
+	"input.touch",
+	"input.text",
+	"input.button",
+	"input.rotate",
+	"input.posture",
+	"input.simulator",
+	"input.scroll",
+	"input.key",
+	"input.window",
+	"push.register",
+	"push.unregister",
+	"notifications.list",
+	"build.offer",
+	"build.sync",
+	"build.start",
+	"build.cancel",
+	"build.artifact",
+	"build.attach",
+	"device-host.offer",
+	"device-host.reserve",
+	"device-host.attach",
+	"device-host.stop",
+	"device-host.app.offer",
+	"device-host.app.chunk",
+	"device-host.app.handoff",
+	"device-host.app.launch",
+	"device-host.app.attach",
+	"device-host.logs.query",
+	"device-host.metro.open",
+	"device-host.metro.close",
+	"device-host.frames.subscribe",
+	"device-host.frames.keyframe",
+	"device-host.frames.congested",
+	"device-host.unsubscribe",
+	"device-host.control.begin",
+	"device-host.control.end",
+	"device-host.input.touch",
+	"device-host.input.text",
+	"device-host.input.scroll",
+	"device-host.input.key",
+	"device-host.input.button",
+	"device-host.input.rotate",
+	"device-host.input.posture",
+	"device-host.input.window",
+	"server.update.status",
+	"server.update.start",
+	"server.update.chunk",
+	"machines.update.start",
+	"machines.update.status"
+];
+/**
+* The methods that update this server's `stim-server service`. A Mac this one approved for `build` or
+* `device-host` may call them; they need neither `read` nor `control`.
+*/
+const SERVER_UPDATE_METHODS = [
+	"server.update.status",
+	"server.update.start",
+	"server.update.chunk"
+];
+/** The methods a connection with the `build` capability may call; they need `build`, not `read`. */
+const BUILD_METHODS = [
+	"build.offer",
+	"build.sync",
+	"build.start",
+	"build.cancel",
+	"build.artifact",
+	"build.attach"
+];
+/** Methods restricted to explicitly approved device-host clients. */
+const DEVICE_HOST_METHODS = [
+	"device-host.offer",
+	"device-host.reserve",
+	"device-host.attach",
+	"device-host.stop",
+	"device-host.app.offer",
+	"device-host.app.chunk",
+	"device-host.app.handoff",
+	"device-host.app.launch",
+	"device-host.app.attach",
+	"device-host.logs.query",
+	"device-host.metro.open",
+	"device-host.metro.close",
+	"device-host.frames.subscribe",
+	"device-host.frames.keyframe",
+	"device-host.frames.congested",
+	"device-host.unsubscribe",
+	"device-host.control.begin",
+	"device-host.control.end",
+	"device-host.input.touch",
+	"device-host.input.text",
+	"device-host.input.scroll",
+	"device-host.input.key",
+	"device-host.input.button",
+	"device-host.input.rotate",
+	"device-host.input.posture",
+	"device-host.input.window"
+];
+const PUSH_TOKEN_PATTERN = "^(Expo|Exponent)PushToken\\[[^\\]\\s]{1,256}\\]$";
+/**
+* `unauthorized`, `pairing-expired` and `protocol-unsupported` refuse the client until it pairs again or
+* updates; `approval-pending` refuses a build client until the Mac approves it; clients retry the others.
+*/
+const ERROR_CODES = [
+	"unauthorized",
+	"pairing-expired",
+	"protocol-unsupported",
+	"approval-pending",
+	"identity-unavailable",
+	"bad-request",
+	"unknown-method",
+	"already-authenticated",
+	"unknown-subscription",
+	"unknown-workspace",
+	"limit-exceeded",
+	"slow-client",
+	"status-failed",
+	"logs-failed",
+	"stim-failed",
+	"frames-failed",
+	"forbidden",
+	"unknown-action",
+	"action-busy",
+	"action-failed",
+	"device-busy",
+	"unknown-session",
+	"no-recording",
+	"build-refused",
+	"build-busy"
+];
+const LOG_SOURCES = [
+	"metro",
+	"client",
+	"device",
+	"build",
+	"agent"
+];
+const LOG_LEVELS = [
+	"debug",
+	"info",
+	"warn",
+	"error",
+	"fatal"
+];
+const MAX_LOG_TAIL = 5e3;
+/** `web` is the workspace's Stim-owned Chrome page, from `stim web`; it has only the default slot. */
+const PLATFORMS = [
+	"ios",
+	"android",
+	"web",
+	"macos"
+];
+/** `reload` also reaches the workspace's Stim-owned Chrome page. */
+const RELOAD_PLATFORMS = [
+	"ios",
+	"android",
+	"web"
+];
+const FRAME_FPS = {
+	default: 5,
+	max: 30,
+	video: 60
+};
+const FRAME_EDGE = {
+	min: 240,
+	default: 1280,
+	max: 2048
+};
+const VIDEO_CODECS = ["h264"];
+const REPLAY_RATES = [
+	0,
+	1,
+	2
+];
+/** Kinds of timeline marker: an agent `action` on the device, an app or build `error`, and a `crash`. */
+const REPLAY_MARKER_KINDS = [
+	"action",
+	"error",
+	"crash"
+];
+const VIDEO_HEADER_VERSION = 1;
+/** The keyframe bit of a {@link VideoPacket}'s flags. */
+const VIDEO_KEYFRAME = 1;
+/** The flag bits of a {@link VideoPacket} that carry an iPhone Duo's posture, as `posture` on a `frame` event. */
+const VIDEO_FOLDED = 2;
+const VIDEO_UNFOLDED = 4;
+/** Bit 5 marks clockwise artwork quarter-turns in bits 3-4; absent on recordings and unsupported sources. */
+const VIDEO_ARTWORK = 32;
+/** Each action runs one fixed `stim` command in the workspace. */
+const ACTIONS = ["reload", "stop"];
+const TOUCH_PHASES = [
+	"down",
+	"move",
+	"up"
+];
+const INPUT_KEYS = [
+	"escape",
+	"tab",
+	"return",
+	"backspace",
+	"left",
+	"right",
+	"up",
+	"down",
+	"a",
+	"b",
+	"c",
+	"d",
+	"e",
+	"f",
+	"g",
+	"h",
+	"i",
+	"j",
+	"k",
+	"l",
+	"m",
+	"n",
+	"o",
+	"p",
+	"q",
+	"r",
+	"s",
+	"t",
+	"u",
+	"v",
+	"w",
+	"x",
+	"y",
+	"z",
+	"0",
+	"1",
+	"2",
+	"3",
+	"4",
+	"5",
+	"6",
+	"7",
+	"8",
+	"9"
+];
+const KEY_MODIFIERS = [
+	"command",
+	"shift",
+	"option",
+	"control"
+];
+const MAX_INPUT_TEXT = 256;
+/** `home` and `lock` on iOS and Android; `back` on Android and web, where it goes back in the page's history; `app-switch` on Android only. */
+const INPUT_BUTTONS = [
+	"home",
+	"lock",
+	"back",
+	"app-switch"
+];
+/** `left` turns the device a quarter turn counterclockwise, `right` clockwise. */
+const ROTATE_DIRECTIONS = ["left", "right"];
+const DEVICE_POSTURES = [
+	"folded",
+	"half-open",
+	"unfolded"
+];
+/** A client's repository on a build machine: letters, digits, `.`, `_` and `-`, at most 80. */
+const BUILD_REPO_PATTERN = "^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$";
+/**
+* What stim-server can push, named like the phone's notification settings: work `started` (a workspace began
+* warming or an agent first drove its device), an agent that looks `stuck`, one that is `looping` on the same
+* failure, work `finished` (the agent stopped after a green build, or the workspace's pull request became ready for
+* review or merged), a `machine` in trouble, and a `control` conflict over a device this phone controls.
+*/
+const PUSH_EVENTS = [
+	"started",
+	"stuck",
+	"looping",
+	"finished",
+	"machine",
+	"control",
+	"attention"
+];
+/** Events phones registered before `PUSH_EVENTS`: `disk` stands for `machine`, and the others no longer push. */
+const LEGACY_PUSH_EVENTS = [
+	"build-failed",
+	"log-errors",
+	"disk",
+	"app-stopped",
+	"slow-build"
+];
+/**
+* How a pushed event is delivered: `alert` with a banner and sound, `silent` to the notification list only (iOS
+* `interruptionLevel` `passive`, the Android `updates` channel). An event the device leaves out of `events` is off.
+*/
+const NOTIFICATION_LEVELS = ["alert", "silent"];
+/** Why the registered phones did not get a logged notification when it happened. */
+const NOTIFICATION_SUPPRESSIONS = ["muted", "quiet-hours"];
+const CONTROL_END_REASONS = [
+	"idle",
+	"taken-over",
+	"device-gone",
+	"forbidden",
+	"failed"
+];
+//#endregion
+export { ACTIONS, BUILD_METHODS, BUILD_REPO_PATTERN, CAPABILITIES, CONTROL_END_REASONS, DEVICE_HOST_METHODS, DEVICE_POSTURES, ERROR_CODES, FEATURES, FRAME_EDGE, FRAME_FPS, INPUT_BUTTONS, INPUT_KEYS, KEY_MODIFIERS, LEGACY_PUSH_EVENTS, LOG_LEVELS, LOG_SOURCES, MAX_INPUT_TEXT, MAX_LOG_TAIL, METHODS, NOTIFICATION_LEVELS, NOTIFICATION_SUPPRESSIONS, PLATFORMS, PROTOCOL_SCHEMA_FILE, PROTOCOL_VERSION, PUSH_EVENTS, PUSH_TOKEN_PATTERN, RELOAD_PLATFORMS, REPLAY_MARKER_KINDS, REPLAY_RATES, ROTATE_DIRECTIONS, SERVER_UPDATE_METHODS, TOUCH_PHASES, VIDEO_ARTWORK, VIDEO_CODECS, VIDEO_FOLDED, VIDEO_HEADER_VERSION, VIDEO_KEYFRAME, VIDEO_UNFOLDED };

package/dist/receive-protocol.d.mts

@@ -0,0 +1,12 @@
+import { Method as PhoneMethod, Methods as PhoneMethods, PhoneProtocolError, PhoneServerEvent } from "./phone-protocol.mjs";
+//#region receive-protocol.d.ts
+/** Validates a result against the method of its pending request without changing the payload. */
+declare function isRpcResult<M extends PhoneMethod>(method: M, value: unknown): value is PhoneMethods[M]["result"];
+/** Validates a known phone event, including its nested payload. */
+declare function isRpcEvent(value: unknown): value is PhoneServerEvent;
+/** Accepts future error codes while requiring a usable code and message. */
+declare function isRpcError(value: unknown): value is PhoneProtocolError;
+/** Unknown future events can be ignored without reconnecting to a newer server. */
+declare function isRpcEventName(value: string): boolean;
+//#endregion
+export { isRpcError, isRpcEvent, isRpcEventName, isRpcResult };