@palgroup/simstream 0.9.0 → 0.11.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;
@@ -542,4 +553,6 @@ export declare class SimStream {
 export { resolveSource, isCertain } from './source';
 export type { SourceAnswer, SourceConfidence } from './source';
 export { SimStreamAdmin } from './admin';
+export { SimStreamOrganization } from './organization';
+export type { OrganizationOptions, CreatedProject } from './organization';
 export type { AdminOptions, Customer } from './admin';

package/dist/index.js

@@ -12,7 +12,7 @@
  * separation has stopped being real.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SimStreamAdmin = exports.isCertain = exports.resolveSource = exports.SimStream = exports.SimStreamError = void 0;
+exports.SimStreamOrganization = exports.SimStreamAdmin = exports.isCertain = exports.resolveSource = exports.SimStream = exports.SimStreamError = void 0;
 class SimStreamError extends Error {
     code;
     status;
@@ -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)}`);
@@ -481,3 +506,5 @@ Object.defineProperty(exports, "resolveSource", { enumerable: true, get: functio
 Object.defineProperty(exports, "isCertain", { enumerable: true, get: function () { return source_1.isCertain; } });
 var admin_1 = require("./admin");
 Object.defineProperty(exports, "SimStreamAdmin", { enumerable: true, get: function () { return admin_1.SimStreamAdmin; } });
+var organization_1 = require("./organization");
+Object.defineProperty(exports, "SimStreamOrganization", { enumerable: true, get: function () { return organization_1.SimStreamOrganization; } });

package/dist/organization.d.ts

@@ -0,0 +1,31 @@
+/**
+ * An organization's own hand: making the projects its keys belong to.
+ *
+ * Separate from the customer client for the reason the admin one is: a project's key can run simulators and upload
+ * builds for that project, and must never be able to make another project. The organization token can, and nothing
+ * but the service that owns the organization should hold it.
+ */
+export interface OrganizationOptions {
+    baseUrl: string;
+    /** The organization token the operator issued. Sent as x-org-token. */
+    token: string;
+    fetch?: typeof fetch;
+}
+/** A project the organization just made, with its first key — shown here and never again. */
+export interface CreatedProject {
+    id: string;
+    name: string;
+    key: string;
+}
+export declare class SimStreamOrganization {
+    private readonly base;
+    private readonly token;
+    private readonly fetchImpl;
+    constructor(opts: OrganizationOptions);
+    /**
+     * Makes a project and its first key (POST /api/projects, coordinator/dashboard.go). The key is stored hashed on the
+     * other side, so this answer is the only place it exists: keep it before dropping the response. A name is unique
+     * inside the organization; a second project under the same name is refused.
+     */
+    createProject(name: string): Promise<CreatedProject>;
+}

package/dist/organization.js

@@ -0,0 +1,43 @@
+"use strict";
+/**
+ * An organization's own hand: making the projects its keys belong to.
+ *
+ * Separate from the customer client for the reason the admin one is: a project's key can run simulators and upload
+ * builds for that project, and must never be able to make another project. The organization token can, and nothing
+ * but the service that owns the organization should hold it.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimStreamOrganization = void 0;
+class SimStreamOrganization {
+    base;
+    token;
+    fetchImpl;
+    constructor(opts) {
+        if (!opts.baseUrl)
+            throw new Error('baseUrl is required');
+        if (!opts.token)
+            throw new Error('token is required');
+        this.base = opts.baseUrl.replace(/\/+$/, '');
+        this.token = opts.token;
+        this.fetchImpl = opts.fetch ?? globalThis.fetch;
+    }
+    /**
+     * Makes a project and its first key (POST /api/projects, coordinator/dashboard.go). The key is stored hashed on the
+     * other side, so this answer is the only place it exists: keep it before dropping the response. A name is unique
+     * inside the organization; a second project under the same name is refused.
+     */
+    async createProject(name) {
+        const res = await this.fetchImpl(`${this.base}/api/projects`, {
+            method: 'POST',
+            headers: { 'x-org-token': this.token, 'content-type': 'application/json' },
+            body: JSON.stringify({ name }),
+        });
+        if (!res.ok)
+            throw new Error(`simstream: the project could not be made (${res.status}): ${(await res.text().catch(() => '')).trim()}`);
+        const made = (await res.json());
+        if (!made.id || !made.key)
+            throw new Error('simstream: the coordinator made a project with no id or key');
+        return { id: made.id, name: made.name ?? name, key: made.key };
+    }
+}
+exports.SimStreamOrganization = SimStreamOrganization;

package/package.json

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