@palgroup/simstream 0.6.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,74 @@
+# @palgroup/simstream
+
+Start and drive remote iOS simulator sessions.
+
+```bash
+npm install @palgroup/simstream
+```
+
+```ts
+import { SimStream, SimStreamError } from '@palgroup/simstream';
+
+const sim = new SimStream({
+  baseUrl: process.env.SIMSTREAM_URL!,   // the coordinator
+  apiKey:  process.env.SIMSTREAM_KEY!,   // your customer key
+});
+
+// A simulator, and your app installed onto it in parallel. The answer comes back before the
+// download starts: the device is already booted and waiting, and making somebody watch a
+// download undoes the reason it was.
+const session = await sim.startSession({
+  app: 'https://your-bucket/App.zip',    // a .app, zipped. Simulator builds, not .ipa.
+  wait: true,                            // queue instead of failing when the fleet is busy
+  onQueue: (position) => console.log(`waiting, ${position} ahead`),
+});
+
+// Open it. That is the whole client — a page that streams the simulator and sends touches
+// back. Treat the URL like a password: it carries a grant scoped to one device.
+console.log(session.url);
+```
+
+## A new build lands
+
+Somebody is already looking at a simulator and their app should be replaced under them,
+without reconnecting:
+
+```ts
+await sim.pushBuild('https://your-bucket/App.zip');
+```
+
+It goes only to hosts holding *your* sessions.
+
+## When there is nothing free
+
+`startSession()` throws a `SimStreamError`. The `code` says what to do about it:
+
+| code | meaning | what to do |
+|---|---|---|
+| `quota` | you are at your own concurrent limit | wait, or raise the limit |
+| `capacity` | the whole fleet is busy | pass `wait: true` |
+| `unauthorized` | the key is not recognised | check `apiKey` |
+| `timeout` | `timeoutMs` elapsed while queued | the ticket is gone; ask again |
+| `gone` | the ticket was already collected, or abandoned | ask again |
+
+With `wait: true` the client keeps its place and honours the server's own `retry-after`
+rather than choosing an interval — the server is the one that knows how fast the queue is
+moving. `pollTicket()` is there if you would rather drive the waiting yourself.
+
+## What you used
+
+```ts
+await sim.usage();
+// [{ customer: 'palcore', sessions: 12, seconds: 4210, live: 2 }]
+```
+
+Sessions running right now are counted at their length so far. It is a measurement, not an
+invoice: what a second is worth is not a decision this system makes.
+
+## Notes
+
+Needs `fetch` — Node 18+, or pass your own in the options. No other dependencies.
+
+The full HTTP surface is in `docs/api.md`; this package is only the part that is easy to get
+subtly wrong: waiting without hammering, telling "still waiting" apart from "gone", and not
+mistaking a viewer link for something you can log.

package/dist/admin.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Creating and revoking customers.
+ *
+ * Separate from the customer client on purpose, and behind a separate token: a customer must
+ * never be able to create a customer, and a single credential for both would mean exactly
+ * that. Nothing in an application should import this.
+ */
+export interface AdminOptions {
+    baseUrl: string;
+    /** The coordinator's -admin-token. Not a customer key. */
+    adminToken: string;
+    fetch?: typeof fetch;
+}
+export interface Customer {
+    id: string;
+    maxConcurrent: number;
+    ratePerMinute: number;
+    /** Key prefixes only — the keys themselves are stored hashed and cannot be read back. */
+    keys: string[];
+    note?: string;
+}
+export declare class SimStreamAdmin {
+    private readonly base;
+    private readonly token;
+    private readonly fetchImpl;
+    constructor(opts: AdminOptions);
+    /**
+     * Creates a customer and its first key.
+     *
+     * The key is returned here and never again: it is stored hashed, so there is nothing to
+     * read back. Put it somewhere before you drop the response.
+     */
+    createCustomer(input: {
+        id: string;
+        maxConcurrent: number;
+        ratePerMinute?: number;
+        note?: string;
+    }): Promise<{
+        customer: Customer;
+        key: string;
+    }>;
+    listCustomers(): Promise<Customer[]>;
+    /** Issues another key. Rotation without downtime: both work until the old one is removed. */
+    issueKey(id: string, label?: string): Promise<string>;
+    /** Revokes by prefix, because the prefix is the only part of a key anybody still has. */
+    revokeKey(id: string, prefix: string): Promise<void>;
+    private req;
+}

package/dist/admin.js

@@ -0,0 +1,58 @@
+"use strict";
+/**
+ * Creating and revoking customers.
+ *
+ * Separate from the customer client on purpose, and behind a separate token: a customer must
+ * never be able to create a customer, and a single credential for both would mean exactly
+ * that. Nothing in an application should import this.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimStreamAdmin = void 0;
+class SimStreamAdmin {
+    base;
+    token;
+    fetchImpl;
+    constructor(opts) {
+        this.base = opts.baseUrl.replace(/\/+$/, '');
+        this.token = opts.adminToken;
+        this.fetchImpl = opts.fetch ?? globalThis.fetch;
+    }
+    /**
+     * Creates a customer and its first key.
+     *
+     * The key is returned here and never again: it is stored hashed, so there is nothing to
+     * read back. Put it somewhere before you drop the response.
+     */
+    async createCustomer(input) {
+        const res = await this.req('POST', '/api/customers', input);
+        return (await res.json());
+    }
+    async listCustomers() {
+        const res = await this.req('GET', '/api/customers');
+        return (await res.json());
+    }
+    /** Issues another key. Rotation without downtime: both work until the old one is removed. */
+    async issueKey(id, label) {
+        const res = await this.req('POST', `/api/customers/${encodeURIComponent(id)}/keys`, { label });
+        return (await res.json()).key;
+    }
+    /** Revokes by prefix, because the prefix is the only part of a key anybody still has. */
+    async revokeKey(id, prefix) {
+        await this.req('DELETE', `/api/customers/${encodeURIComponent(id)}/keys/${encodeURIComponent(prefix)}`);
+    }
+    async req(method, path, body) {
+        const res = await this.fetchImpl(`${this.base}${path}`, {
+            method,
+            headers: {
+                'x-admin-token': this.token,
+                ...(body === undefined ? {} : { 'content-type': 'application/json' }),
+            },
+            body: body === undefined ? undefined : JSON.stringify(body),
+        });
+        if (res.status >= 400) {
+            throw new Error((await res.text().catch(() => '')).trim() || `HTTP ${res.status}`);
+        }
+        return res;
+    }
+}
+exports.SimStreamAdmin = SimStreamAdmin;

package/dist/index.d.ts

@@ -0,0 +1,225 @@
+/**
+ * Start and drive remote iOS simulator sessions.
+ *
+ * The API underneath is plain HTTP and documented in `docs/api.md`; this exists so that using
+ * it does not mean reimplementing the parts that are easy to get subtly wrong — waiting in a
+ * queue without hammering, telling "still waiting" apart from "gone", and never mistaking a
+ * viewer link for something you can put in a log.
+ *
+ * Nothing here knows who the caller is. That is the point: the same package serves the first
+ * customer and the tenth, and the day one of them needs a method the others cannot have, the
+ * separation has stopped being real.
+ */
+export interface SimStreamOptions {
+    /** Coordinator base URL, e.g. https://simstream.example */
+    baseUrl: string;
+    /** Customer API key. Sent as x-api-key. */
+    apiKey: string;
+    /** Defaults to global fetch; supply one for older Node or for tests. */
+    fetch?: typeof fetch;
+}
+export interface Session {
+    /**
+     * Open this in a browser. It carries a grant scoped to one device and expiring, so it is a
+     * capability rather than an address: treat it like a password, not like a URL.
+     */
+    url: string;
+    host: string;
+    device: string;
+    name: string;
+    expiresAt?: string;
+    /** This session's id. Needed to end it, and therefore to switch device without paying for two. */
+    session?: string;
+    /** Present when an app was supplied; poll it to watch the install. Carries no credential. */
+    appStatus?: string;
+    app?: string;
+}
+export interface DeviceKind {
+    /** What to pass as `device` when starting a session — a name, matched loosely. */
+    name: string;
+    runtime: string;
+    count: number;
+    free: number;
+}
+export interface AppStatus {
+    /** Empty when nothing has been pushed to this simulator yet. */
+    phase?: 'downloading' | 'installing' | 'launching' | 'ready' | 'failed';
+    bundle?: string;
+    /** Present only with phase 'failed', and it says what went wrong rather than that it did. */
+    error?: string;
+    elapsed?: string;
+}
+export interface StartOptions {
+    /** A .app directory, or a .zip/.tar.gz containing one. Simulator builds, not .ipa. */
+    app?: string;
+    /**
+     * The kind of device to open — "iPad", "iphone-17", or an exact udid.
+     *
+     * Matched loosely against the device's name, because a customer knows they want an iPad and has
+     * no idea which machine in which rack is holding one. Omitted means whatever is free.
+     */
+    device?: string;
+    /** Launch it once installed. Default true. */
+    launch?: boolean;
+    /**
+     * Wait for a device when the fleet is full or this customer is at its limit, instead of
+     * failing. The wait is usually seconds — a session ends every time somebody closes a tab.
+     */
+    wait?: boolean;
+    /** How long the returned link stays valid. Default is the server's, thirty minutes. */
+    ttl?: string;
+    /** Give up waiting. Rejects with SimStreamError code 'timeout'. */
+    timeoutMs?: number;
+    signal?: AbortSignal;
+    /** Called with the queue position while waiting, so a caller can show it. */
+    onQueue?: (position: number, reason: string) => void;
+}
+export interface UsageRecord {
+    customer: string;
+    session: string;
+    device: string;
+    host: string;
+    started: string;
+    ended: string;
+    seconds: number;
+    ratePerMinute: number;
+    /** What this session cost, at the rate in force when it ended. */
+    cost: number;
+}
+export interface CustomerUsage {
+    customer: string;
+    sessions: number;
+    seconds: number;
+    live: number;
+    cost: number;
+}
+export type SimStreamErrorCode = 'unauthorized' | 'quota' | 'capacity' | 'timeout' | 'gone' | 'http';
+export declare class SimStreamError extends Error {
+    readonly code: SimStreamErrorCode;
+    readonly status?: number | undefined;
+    constructor(message: string, code: SimStreamErrorCode, status?: number | undefined);
+}
+export declare class SimStream {
+    private readonly base;
+    private readonly key;
+    private readonly fetchImpl;
+    constructor(opts: SimStreamOptions);
+    /**
+     * Claim a simulator. With `wait`, keeps a place in line until one frees up rather than
+     * failing — and honours the server's own retry-after rather than choosing an interval,
+     * because the server is the one that knows how quickly the queue is moving.
+     */
+    startSession(opts?: StartOptions): Promise<Session>;
+    /** Where a queued session got to, without waiting for it. */
+    pollTicket(ticket: string): Promise<Session | {
+        position: number;
+    }>;
+    /**
+     * A new build has appeared; put it on the sessions this customer already has open.
+     *
+     * This is the other direction from `startSession({app})`: nobody is starting anything, the
+     * person is already looking at a simulator and their app should be replaced under them.
+     *
+     * Pass `version` whenever you have one — R2's etag, a git sha, a build number. A presigned
+     * URL cannot serve as the identity of a build: its signature changes every time it is
+     * generated, so the same object presigned twice looks like two different sources and every
+     * push re-downloads. With a version, an artifact already on the host costs nothing at all.
+     */
+    pushBuild(app: string, opts?: {
+        version?: string;
+        launch?: boolean;
+    }): Promise<{
+        hosts: number;
+        version?: string;
+    }>;
+    /**
+     * A fresh link to a session that is already running.
+     *
+     * ‼️ A GRANT EXPIRES AND A SESSION DOES NOT. The link handed back when a session was claimed
+     * carries a grant good for minutes; the session outlives it, so anything that stored that link and
+     * showed it later — a studio panel reopened an hour on — embeds a URL the Mac correctly refuses.
+     * Ask for a new one rather than holding the old one open for longer: a link that never expires is
+     * a link that still works after it leaks.
+     */
+    sessionLink(session: string, opts?: {
+        ttl?: string;
+    }): Promise<{
+        url: string;
+        expiresAt?: string;
+    }>;
+    /**
+     * The kinds of simulator this customer can ask for.
+     *
+     * ‼️ ASK RATHER THAN HARDCODE. What is on offer is whatever the fleet is running, and it changes
+     * when a Mac joins, when a runtime is installed, and when a new platform arrives. A menu written
+     * into a client goes stale without saying so — it offered an iPad while streaming an iPhone.
+     *
+     * `free` is how many could be claimed right now without crowding a host; `count` is how many exist.
+     */
+    devices(): Promise<DeviceKind[]>;
+    /**
+     * How far the app pushed to this session has got.
+     *
+     * ‼️ pushBuild ANSWERS "SENT", NOT "THERE". It returns as soon as the Macs have taken the job; the
+     * download, the install and the launch happen after, and until they finish the session is a live
+     * simulator showing a home screen. Poll this to tell that apart from a failure — `error` carries
+     * the reason, and `phase` is one of downloading, installing, launching, ready, failed.
+     */
+    appStatus(session: string): Promise<AppStatus>;
+    /**
+     * Show one of the app's screens on the simulator this session is watching.
+     *
+     * ‼️ NOTHING RESTARTS. An app built to host its own previews carries every screen it was compiled
+     * with and takes the choice live, so a person clicking through a list sees each screen arrive in a
+     * frame. Name the screen by its preview id, or by the screen and the state within it — whichever
+     * the catalogue gave you.
+     *
+     * Rejected with `unavailable` when the app on that simulator is not one that takes live changes;
+     * the message says which, because "the app was started outside this agent" and "no app is
+     * installed" send you to different places.
+     */
+    showPreview(session: string, target: {
+        previewId?: string;
+        screen?: string;
+        variant?: string;
+    }): Promise<void>;
+    /**
+     * The language and theme the app renders in, changed live.
+     *
+     * This is the APP's appearance, not the simulator's: two people watching two devices can read two
+     * languages, and neither setting survives into whatever runs there next.
+     */
+    setAppearance(session: string, look: {
+        lang?: string;
+        theme?: 'light' | 'dark' | 'system';
+    }): Promise<void>;
+    /**
+     * End a session now, rather than waiting for the viewer to close.
+     *
+     * Idempotent, and silent about sessions that are not this customer's: telling a caller apart
+     * from a stranger by which error they get is how session ids become a way to probe the fleet.
+     */
+    endSession(session: string): Promise<void>;
+    /**
+     * Move this customer to a different kind of device, keeping one simulator at a time.
+     *
+     * ‼️ THE OLD SESSION IS ENDED FIRST, AND THAT IS THE WHOLE DIFFERENCE. A customer entitled to one
+     * simulator who claims a second before releasing the first is over their own limit for the length
+     * of the switch — and on a fleet with one device free, refused the very thing they asked for.
+     */
+    switchDevice(session: string, device: string, opts?: StartOptions): Promise<Session>;
+    /** What this customer has used, in total. A measurement, not an invoice. */
+    usage(): Promise<CustomerUsage[]>;
+    /**
+     * The individual sessions, which is what you store against a project so you can bill for it
+     * later. Each carries the rate that was in force when it ended, so a price change does not
+     * rewrite what somebody already used.
+     */
+    sessions(): Promise<UsageRecord[]>;
+    private sessionUrl;
+    private collect;
+    private request;
+    private errorFor;
+}
+export { SimStreamAdmin } from './admin';
+export type { AdminOptions, Customer } from './admin';

package/dist/index.js

@@ -0,0 +1,262 @@
+"use strict";
+/**
+ * Start and drive remote iOS simulator sessions.
+ *
+ * The API underneath is plain HTTP and documented in `docs/api.md`; this exists so that using
+ * it does not mean reimplementing the parts that are easy to get subtly wrong — waiting in a
+ * queue without hammering, telling "still waiting" apart from "gone", and never mistaking a
+ * viewer link for something you can put in a log.
+ *
+ * Nothing here knows who the caller is. That is the point: the same package serves the first
+ * customer and the tenth, and the day one of them needs a method the others cannot have, the
+ * separation has stopped being real.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimStreamAdmin = exports.SimStream = exports.SimStreamError = void 0;
+class SimStreamError extends Error {
+    code;
+    status;
+    constructor(message, code, status) {
+        super(message);
+        this.code = code;
+        this.status = status;
+        this.name = 'SimStreamError';
+    }
+}
+exports.SimStreamError = SimStreamError;
+const sleep = (ms, signal) => new Promise((resolve, reject) => {
+    const t = setTimeout(resolve, ms);
+    signal?.addEventListener('abort', () => {
+        clearTimeout(t);
+        reject(new SimStreamError('aborted', 'timeout'));
+    }, { once: true });
+});
+class SimStream {
+    base;
+    key;
+    fetchImpl;
+    constructor(opts) {
+        if (!opts.baseUrl)
+            throw new SimStreamError('baseUrl is required', 'http');
+        if (!opts.apiKey)
+            throw new SimStreamError('apiKey is required', 'unauthorized');
+        this.base = opts.baseUrl.replace(/\/+$/, '');
+        this.key = opts.apiKey;
+        this.fetchImpl = opts.fetch ?? globalThis.fetch;
+        if (!this.fetchImpl) {
+            throw new SimStreamError('no fetch available; pass one in options', 'http');
+        }
+    }
+    /**
+     * Claim a simulator. With `wait`, keeps a place in line until one frees up rather than
+     * failing — and honours the server's own retry-after rather than choosing an interval,
+     * because the server is the one that knows how quickly the queue is moving.
+     */
+    async startSession(opts = {}) {
+        const body = {
+            app: opts.app,
+            launch: opts.launch,
+            queue: opts.wait === true,
+            device: opts.device,
+        };
+        const deadline = opts.timeoutMs ? Date.now() + opts.timeoutMs : Infinity;
+        const res = await this.request('POST', this.sessionUrl(opts.ttl), body);
+        if (res.status === 200)
+            return (await res.json());
+        if (res.status === 202) {
+            const first = (await res.json());
+            opts.onQueue?.(first.position, first.reason ?? '');
+            return this.collect(first.ticket, deadline, opts);
+        }
+        throw await this.errorFor(res);
+    }
+    /** Where a queued session got to, without waiting for it. */
+    async pollTicket(ticket) {
+        const res = await this.request('GET', `/api/session?ticket=${encodeURIComponent(ticket)}`);
+        if (res.status === 200)
+            return (await res.json());
+        if (res.status === 202)
+            return (await res.json());
+        throw await this.errorFor(res);
+    }
+    /**
+     * A new build has appeared; put it on the sessions this customer already has open.
+     *
+     * This is the other direction from `startSession({app})`: nobody is starting anything, the
+     * person is already looking at a simulator and their app should be replaced under them.
+     *
+     * Pass `version` whenever you have one — R2's etag, a git sha, a build number. A presigned
+     * URL cannot serve as the identity of a build: its signature changes every time it is
+     * generated, so the same object presigned twice looks like two different sources and every
+     * push re-downloads. With a version, an artifact already on the host costs nothing at all.
+     */
+    async pushBuild(app, opts = {}) {
+        const res = await this.request('POST', '/api/builds', {
+            app,
+            version: opts.version,
+            launch: opts.launch,
+        });
+        if (res.status !== 200)
+            throw await this.errorFor(res);
+        return (await res.json());
+    }
+    /**
+     * A fresh link to a session that is already running.
+     *
+     * ‼️ A GRANT EXPIRES AND A SESSION DOES NOT. The link handed back when a session was claimed
+     * carries a grant good for minutes; the session outlives it, so anything that stored that link and
+     * showed it later — a studio panel reopened an hour on — embeds a URL the Mac correctly refuses.
+     * Ask for a new one rather than holding the old one open for longer: a link that never expires is
+     * a link that still works after it leaks.
+     */
+    async sessionLink(session, opts = {}) {
+        const res = await this.request('POST', `/api/session/link${opts.ttl ? `?ttl=${encodeURIComponent(opts.ttl)}` : ''}`, {
+            session,
+        });
+        if (res.status !== 200)
+            throw await this.errorFor(res);
+        return (await res.json());
+    }
+    /**
+     * The kinds of simulator this customer can ask for.
+     *
+     * ‼️ ASK RATHER THAN HARDCODE. What is on offer is whatever the fleet is running, and it changes
+     * when a Mac joins, when a runtime is installed, and when a new platform arrives. A menu written
+     * into a client goes stale without saying so — it offered an iPad while streaming an iPhone.
+     *
+     * `free` is how many could be claimed right now without crowding a host; `count` is how many exist.
+     */
+    async devices() {
+        const res = await this.request('GET', '/api/devices');
+        if (res.status !== 200)
+            throw await this.errorFor(res);
+        return (await res.json()).devices ?? [];
+    }
+    /**
+     * How far the app pushed to this session has got.
+     *
+     * ‼️ pushBuild ANSWERS "SENT", NOT "THERE". It returns as soon as the Macs have taken the job; the
+     * download, the install and the launch happen after, and until they finish the session is a live
+     * simulator showing a home screen. Poll this to tell that apart from a failure — `error` carries
+     * the reason, and `phase` is one of downloading, installing, launching, ready, failed.
+     */
+    async appStatus(session) {
+        const res = await this.request('GET', `/api/session/app?session=${encodeURIComponent(session)}`);
+        if (res.status !== 200)
+            throw await this.errorFor(res);
+        return (await res.json());
+    }
+    /**
+     * Show one of the app's screens on the simulator this session is watching.
+     *
+     * ‼️ NOTHING RESTARTS. An app built to host its own previews carries every screen it was compiled
+     * with and takes the choice live, so a person clicking through a list sees each screen arrive in a
+     * frame. Name the screen by its preview id, or by the screen and the state within it — whichever
+     * the catalogue gave you.
+     *
+     * Rejected with `unavailable` when the app on that simulator is not one that takes live changes;
+     * the message says which, because "the app was started outside this agent" and "no app is
+     * installed" send you to different places.
+     */
+    async showPreview(session, target) {
+        const res = await this.request('POST', '/api/session/preview', { session, ...target });
+        if (res.status !== 200)
+            throw await this.errorFor(res);
+    }
+    /**
+     * The language and theme the app renders in, changed live.
+     *
+     * This is the APP's appearance, not the simulator's: two people watching two devices can read two
+     * languages, and neither setting survives into whatever runs there next.
+     */
+    async setAppearance(session, look) {
+        const res = await this.request('POST', '/api/session/appearance', { session, ...look });
+        if (res.status !== 200)
+            throw await this.errorFor(res);
+    }
+    /**
+     * End a session now, rather than waiting for the viewer to close.
+     *
+     * Idempotent, and silent about sessions that are not this customer's: telling a caller apart
+     * from a stranger by which error they get is how session ids become a way to probe the fleet.
+     */
+    async endSession(session) {
+        await this.request('POST', '/api/session/end', { session });
+    }
+    /**
+     * Move this customer to a different kind of device, keeping one simulator at a time.
+     *
+     * ‼️ THE OLD SESSION IS ENDED FIRST, AND THAT IS THE WHOLE DIFFERENCE. A customer entitled to one
+     * simulator who claims a second before releasing the first is over their own limit for the length
+     * of the switch — and on a fleet with one device free, refused the very thing they asked for.
+     */
+    async switchDevice(session, device, opts = {}) {
+        await this.endSession(session);
+        return this.startSession({ ...opts, device });
+    }
+    /** What this customer has used, in total. A measurement, not an invoice. */
+    async usage() {
+        const res = await this.request('GET', '/api/usage');
+        if (res.status !== 200)
+            throw await this.errorFor(res);
+        return (await res.json());
+    }
+    /**
+     * The individual sessions, which is what you store against a project so you can bill for it
+     * later. Each carries the rate that was in force when it ended, so a price change does not
+     * rewrite what somebody already used.
+     */
+    async sessions() {
+        const res = await this.request('GET', '/api/usage?detail=1');
+        if (res.status !== 200)
+            throw await this.errorFor(res);
+        return (await res.json());
+    }
+    sessionUrl(ttl) {
+        return ttl ? `/api/session?ttl=${encodeURIComponent(ttl)}` : '/api/session';
+    }
+    async collect(ticket, deadline, opts) {
+        for (;;) {
+            if (Date.now() > deadline) {
+                throw new SimStreamError('gave up waiting for a simulator', 'timeout');
+            }
+            const res = await this.request('GET', `/api/session?ticket=${encodeURIComponent(ticket)}`);
+            if (res.status === 200)
+                return (await res.json());
+            if (res.status === 202) {
+                const body = (await res.json());
+                opts.onQueue?.(body.position, body.reason ?? '');
+                // The server says how soon to come back; guessing an interval either hammers it or
+                // leaves somebody waiting after their turn came up.
+                const after = Number(res.headers.get('retry-after') ?? '2');
+                await sleep(Math.max(1, after) * 1000, opts.signal);
+                continue;
+            }
+            throw await this.errorFor(res);
+        }
+    }
+    request(method, path, body) {
+        return this.fetchImpl(`${this.base}${path}`, {
+            method,
+            headers: {
+                'x-api-key': this.key,
+                ...(body === undefined ? {} : { 'content-type': 'application/json' }),
+            },
+            body: body === undefined ? undefined : JSON.stringify(body),
+        });
+    }
+    async errorFor(res) {
+        const text = (await res.text().catch(() => '')).trim();
+        // The status is the fact; the body is what to tell somebody. Both are kept, because
+        // "429" alone does not say whose limit was reached.
+        const code = res.status === 401 ? 'unauthorized'
+            : res.status === 429 ? 'quota'
+                : res.status === 503 ? 'capacity'
+                    : res.status === 410 ? 'gone'
+                        : 'http';
+        return new SimStreamError(text || `HTTP ${res.status}`, code, res.status);
+    }
+}
+exports.SimStream = SimStream;
+var admin_1 = require("./admin");
+Object.defineProperty(exports, "SimStreamAdmin", { enumerable: true, get: function () { return admin_1.SimStreamAdmin; } });

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@palgroup/simstream",
+  "version": "0.6.0",
+  "description": "Start and drive remote iOS simulator sessions.",
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "tsc -p tsconfig.test.json && node --test dist-test/*.test.js"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.0",
+    "@types/node": "^22.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/palgroup/simstream.git",
+    "directory": "sdk/ts"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/palgroup/simstream#readme",
+  "keywords": [
+    "ios",
+    "simulator",
+    "webrtc",
+    "remote",
+    "preview",
+    "simstream"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}