@palgroup/simstream 0.9.0 → 0.10.0

package/dist/index.d.ts

@@ -301,6 +301,17 @@ export declare class SimStream {
      * because the server is the one that knows how quickly the queue is moving.
      */
     startSession(opts?: StartOptions): Promise<Session>;
+    /**
+     * Claim a simulator, or take a place in line and hand the ticket back rather than wait on it.
+     *
+     * startSession({ wait: true }) waits inside the call, which suits a script and not a service: a server that answers a
+     * person while they wait keeps the TICKET — in its own store, across its own restarts — and collects it with
+     * pollTicket. The session request is the same one startSession sends, with a place in line always asked for.
+     */
+    requestSession(opts?: Omit<StartOptions, 'wait' | 'timeoutMs' | 'signal' | 'onQueue'>): Promise<Session | {
+        ticket: string;
+        position: number;
+    }>;
     /** Where a queued session got to, without waiting for it. */
     pollTicket(ticket: string): Promise<Session | {
         position: number;

package/dist/index.js

@@ -73,6 +73,31 @@ class SimStream {
         }
         throw await this.errorFor(res);
     }
+    /**
+     * Claim a simulator, or take a place in line and hand the ticket back rather than wait on it.
+     *
+     * startSession({ wait: true }) waits inside the call, which suits a script and not a service: a server that answers a
+     * person while they wait keeps the TICKET — in its own store, across its own restarts — and collects it with
+     * pollTicket. The session request is the same one startSession sends, with a place in line always asked for.
+     */
+    async requestSession(opts = {}) {
+        const res = await this.request('POST', this.sessionUrl(opts.ttl), {
+            app: opts.app,
+            build: opts.build,
+            channel: opts.channel,
+            launch: opts.launch,
+            mode: opts.mode,
+            queue: true,
+            device: opts.device,
+        });
+        if (res.status === 200)
+            return (await res.json());
+        if (res.status === 202) {
+            const queued = (await res.json());
+            return { ticket: queued.ticket, position: queued.position };
+        }
+        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)}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palgroup/simstream",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Start and drive remote iOS simulator sessions.",
   "license": "Apache-2.0",
   "main": "dist/index.js",