@palgroup/simstream 0.10.0 → 0.12.0

package/README.md

@@ -53,6 +53,10 @@ Completing an upload publishes the build and moves its app's `latest` channel to
 `runBuild({ channel: 'com.example.app:latest' })` always opens the newest one. `setChannel(id, 'beta')`
 names others.
 
+A session that is already open takes another build without being restarted:
+`installBuild(session.session, { build: other.id })` puts it on that one simulator only — unlike `pushBuild`, which
+goes to every session the key holds.
+
 ## When there is nothing free
 
 `startSession()` throws a `SimStreamError`. The `code` says what to do about it:

package/dist/index.d.ts

@@ -383,6 +383,17 @@ export declare class SimStream {
      * link follows, so a demo and a tester see the same build without anybody reissuing anything.
      */
     runBuild(ref: BuildRef, opts?: StartOptions): Promise<Session>;
+    /**
+     * Put a registry build on ONE session that is already open — by id to pin it, or by channel to follow it.
+     *
+     * ‼️ THIS IS NOT pushBuild. A push goes to every session the key holds, which is right for "a new build landed, show
+     * it to whoever is looking" and wrong for a key that serves several people: one of them choosing yesterday's build
+     * would replace the app under all the others. The install runs after the answer; watch it land with appStatus.
+     */
+    installBuild(session: string, ref: BuildRef, opts?: {
+        launch?: boolean;
+        mode?: SimMode;
+    }): Promise<void>;
     /**
      * A fresh link to a session that is already running.
      *
@@ -553,4 +564,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;
@@ -218,6 +218,18 @@ class SimStream {
     async runBuild(ref, opts = {}) {
         return this.startSession({ ...opts, ...ref });
     }
+    /**
+     * Put a registry build on ONE session that is already open — by id to pin it, or by channel to follow it.
+     *
+     * ‼️ THIS IS NOT pushBuild. A push goes to every session the key holds, which is right for "a new build landed, show
+     * it to whoever is looking" and wrong for a key that serves several people: one of them choosing yesterday's build
+     * would replace the app under all the others. The install runs after the answer; watch it land with appStatus.
+     */
+    async installBuild(session, ref, opts = {}) {
+        const res = await this.request('POST', '/api/session/build', { session, ...ref, mode: opts.mode, launch: opts.launch });
+        if (res.status !== 200)
+            throw await this.errorFor(res);
+    }
     /**
      * A fresh link to a session that is already running.
      *
@@ -506,3 +518,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.10.0",
+  "version": "0.12.0",
   "description": "Start and drive remote iOS simulator sessions.",
   "license": "Apache-2.0",
   "main": "dist/index.js",