@syncbridge/common 1.1.4 → 2.0.0

package/host-link/host-identity.js

@@ -0,0 +1,140 @@
+import { createHash, createPrivateKey, createPublicKey, generateKeyPairSync, randomBytes, sign, verify, } from 'node:crypto';
+/*
+ * A host's identity with SyncBridge Console: a key pair of its own, made on
+ * the host - its private key never leaves it. It is paired once, by a code
+ * Console gives (short-lived, taken once): the host sends its public key
+ * with the code. From then on it proves itself by tokens it signs, each
+ * short-lived: no secret travels, and a token seen is no key.
+ */
+/** Where a host pairs with Console, by a code: on its API's port */
+export const HOST_PAIR_PATH = '/hosts/pair';
+/**
+ * The header a host's token for Console's APIs comes in: a bearer token
+ * is a user's, there
+ */
+export const HOST_TOKEN_HEADER = 'x-sb-host-token';
+/** The longest a token is taken for, by what it is for */
+export const HOST_TOKEN_MAX_SECONDS = {
+    link: 60,
+    api: 15 * 60,
+};
+/** A token's first part: its kind and version */
+const TOKEN_PREFIX = 'sbh1';
+/** A key pair for a host: its public key told, its private key kept */
+export function generateHostKeys() {
+    const { publicKey, privateKey } = generateKeyPairSync('ed25519');
+    return {
+        publicKey: publicKey
+            .export({ type: 'spki', format: 'der' })
+            .toString('base64'),
+        privateKey: privateKey.export({ type: 'pkcs8', format: 'pem' }).toString(),
+    };
+}
+/** A public key, as sent: an Ed25519 key's SPKI, base64; undefined if not */
+export function readHostPublicKey(value) {
+    try {
+        const der = Buffer.from(String(value), 'base64');
+        const key = createPublicKey({ key: der, format: 'der', type: 'spki' });
+        return key.asymmetricKeyType === 'ed25519' ? der : undefined;
+    }
+    catch {
+        return;
+    }
+}
+/** A public key's fingerprint, to compare by eye: SHA256:<base64> */
+export function hostKeyFingerprint(publicKey) {
+    return ('SHA256:' +
+        createHash('sha256')
+            .update(Buffer.from(publicKey, 'base64'))
+            .digest('base64')
+            .replace(/=+$/, ''));
+}
+/** A token of the host's, signed with its private key */
+export function signHostToken(privateKey, input) {
+    const now = Math.floor(Date.now() / 1000);
+    const payload = {
+        h: input.hostId,
+        a: input.audience,
+        iat: now,
+        exp: now +
+            Math.min(input.seconds ?? HOST_TOKEN_MAX_SECONDS[input.audience], HOST_TOKEN_MAX_SECONDS[input.audience]),
+        n: randomBytes(12).toString('base64url'),
+    };
+    const body = `${TOKEN_PREFIX}.${Buffer.from(JSON.stringify(payload)).toString('base64url')}`;
+    const signature = sign(null, Buffer.from(body), createPrivateKey(privateKey));
+    return `${body}.${signature.toString('base64url')}`;
+}
+/** What a token says, not checked yet: whose it is, to find its key */
+export function readHostToken(token) {
+    const [prefix, body] = String(token || '').split('.');
+    if (prefix !== TOKEN_PREFIX || !body)
+        return;
+    try {
+        const p = JSON.parse(Buffer.from(body, 'base64url').toString());
+        return typeof p?.h === 'string' &&
+            (p.a === 'link' || p.a === 'api') &&
+            Number.isInteger(p.iat) &&
+            Number.isInteger(p.exp) &&
+            typeof p.n === 'string'
+            ? p
+            : undefined;
+    }
+    catch {
+        return;
+    }
+}
+/**
+ * What a token says, if it is signed with the host's key, for this, now:
+ * not ended, not made later than now (a minute's clock skew taken), and
+ * not lasting longer than its kind may
+ */
+export function verifyHostToken(token, publicKey, audience) {
+    const payload = readHostToken(token);
+    if (!payload || payload.a !== audience)
+        return;
+    const now = Math.floor(Date.now() / 1000);
+    if (payload.exp <= now ||
+        payload.iat > now + 60 ||
+        payload.exp - payload.iat > HOST_TOKEN_MAX_SECONDS[audience])
+        return;
+    const [prefix, body, signature] = token.split('.');
+    try {
+        const key = createPublicKey({
+            key: Buffer.from(publicKey, 'base64'),
+            format: 'der',
+            type: 'spki',
+        });
+        return verify(null, Buffer.from(`${prefix}.${body}`), key, Buffer.from(signature || '', 'base64url'))
+            ? payload
+            : undefined;
+    }
+    catch {
+        return;
+    }
+}
+/* A pairing code's letters: no 0/O, 1/I/L to mix up */
+const CODE_LETTERS = 'ABCDEFGHJKMNPQRSTUVWXYZ23456789';
+/** A new pairing code: 8 letters, as XXXX-XXXX (40 bits) */
+export function generatePairingCode() {
+    const bytes = randomBytes(8);
+    let code = '';
+    for (const b of bytes)
+        code += CODE_LETTERS[b % CODE_LETTERS.length];
+    return `${code.slice(0, 4)}-${code.slice(4)}`;
+}
+/**
+ * A pairing code as typed, taken as given: upper case, spaces and dashes
+ * left out; undefined if not a code
+ */
+export function normalizePairingCode(input) {
+    const code = String(input || '')
+        .toUpperCase()
+        .replace(/[\s-]/g, '');
+    if (code.length !== 8)
+        return;
+    for (const c of code)
+        if (!CODE_LETTERS.includes(c))
+            return;
+    return `${code.slice(0, 4)}-${code.slice(4)}`;
+}
+//# sourceMappingURL=host-identity.js.map

package/host-link/host-identity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host-identity.js","sourceRoot":"","sources":["../../src/host-link/host-identity.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,WAAW,EACX,IAAI,EACJ,MAAM,GACP,MAAM,aAAa,CAAC;AAErB;;;;;;GAMG;AAEH,oEAAoE;AACpE,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;AAE5C;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,iBAAiB,CAAC;AAKnD,0DAA0D;AAC1D,MAAM,CAAC,MAAM,sBAAsB,GAAsC;IACvE,IAAI,EAAE,EAAE;IACR,GAAG,EAAE,EAAE,GAAG,EAAE;CACb,CAAC;AAEF,iDAAiD;AACjD,MAAM,YAAY,GAAG,MAAM,CAAC;AAe5B,uEAAuE;AACvE,MAAM,UAAU,gBAAgB;IAC9B,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;IACjE,OAAO;QACL,SAAS,EAAE,SAAS;aACjB,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;aACvC,QAAQ,CAAC,QAAQ,CAAC;QACrB,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE;KAC3E,CAAC;AACJ,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC7C,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;QACjD,MAAM,GAAG,GAAG,eAAe,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACvE,OAAO,GAAG,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO;IACT,CAAC;AACH,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,kBAAkB,CAAC,SAAiB;IAClD,OAAO,CACL,SAAS;QACT,UAAU,CAAC,QAAQ,CAAC;aACjB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;aACxC,MAAM,CAAC,QAAQ,CAAC;aAChB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CACtB,CAAC;AACJ,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,aAAa,CAC3B,UAAkB,EAClB,KAAwE;IAExE,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAqB;QAChC,CAAC,EAAE,KAAK,CAAC,MAAM;QACf,CAAC,EAAE,KAAK,CAAC,QAAQ;QACjB,GAAG,EAAE,GAAG;QACR,GAAG,EACD,GAAG;YACH,IAAI,CAAC,GAAG,CACN,KAAK,CAAC,OAAO,IAAI,sBAAsB,CAAC,KAAK,CAAC,QAAQ,CAAC,EACvD,sBAAsB,CAAC,KAAK,CAAC,QAAQ,CAAC,CACvC;QACH,CAAC,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;KACzC,CAAC;IACF,MAAM,IAAI,GAAG,GAAG,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;IAC7F,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC9E,OAAO,GAAG,IAAI,IAAI,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;AACtD,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtD,IAAI,MAAM,KAAK,YAAY,IAAI,CAAC,IAAI;QAAE,OAAO;IAC7C,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAChE,OAAO,OAAO,CAAC,EAAE,CAAC,KAAK,QAAQ;YAC7B,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC;YACjC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC;YACvB,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC;YACvB,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ;YACvB,CAAC,CAAE,CAAsB;YACzB,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO;IACT,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAC7B,KAAa,EACb,SAAiB,EACjB,QAA2B;IAE3B,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IACrC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,CAAC,KAAK,QAAQ;QAAE,OAAO;IAC/C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1C,IACE,OAAO,CAAC,GAAG,IAAI,GAAG;QAClB,OAAO,CAAC,GAAG,GAAG,GAAG,GAAG,EAAE;QACtB,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,GAAG,sBAAsB,CAAC,QAAQ,CAAC;QAE5D,OAAO;IACT,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,eAAe,CAAC;YAC1B,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC;YACrC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;QACH,OAAO,MAAM,CACX,IAAI,EACJ,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC,EAChC,GAAG,EACH,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,WAAW,CAAC,CAC1C;YACC,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO;IACT,CAAC;AACH,CAAC;AAED,uDAAuD;AACvD,MAAM,YAAY,GAAG,iCAAiC,CAAC;AAEvD,4DAA4D;AAC5D,MAAM,UAAU,mBAAmB;IACjC,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAC7B,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,KAAK,MAAM,CAAC,IAAI,KAAK;QAAE,IAAI,IAAI,YAAY,CAAC,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACrE,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAChD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAa;IAChD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;SAC7B,WAAW,EAAE;SACb,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACzB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IAC9B,KAAK,MAAM,CAAC,IAAI,IAAI;QAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;YAAE,OAAO;IAC5D,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAChD,CAAC"}

package/host-link/host-link.d.ts

@@ -0,0 +1,43 @@
+/** Where Console takes the hosts' links, on its API's port */
+export declare const HOST_LINK_PATH = "/hosts/link";
+/**
+ * The close code Console closes a link with when the host is not to
+ * connect again: its key changed, it was removed, or another host
+ * connected with the key. Any other close is a drop: it connects again.
+ */
+export declare const HOST_LINK_CLOSED = 4001;
+/** A worker as a host tells of it */
+export interface HostWorker {
+    id: string;
+    name?: string;
+    status?: string;
+}
+/** A host's workers, counted: and those needing a look, by name */
+export interface HostWorkerSummary {
+    total: number;
+    started: number;
+    stopped: number;
+    /** Unhealthy, invalid, or needing an init */
+    problem: number;
+    /** Starting, stopping, initializing */
+    other: number;
+    /** The workers with a problem, the first of them */
+    problems: HostWorker[];
+}
+/** What a host tells of itself: sent when it connects, and as it changes */
+export interface HostStatusMessage {
+    type: 'status';
+    /** The SyncBridge version */
+    version: string;
+    /** When SyncBridge started, ISO */
+    startTime: string;
+    workers: HostWorkerSummary;
+}
+/** The problems named at most: the counts tell the rest */
+export declare const MAX_NAMED_PROBLEMS = 10;
+/** A host's workers, counted, as it tells Console */
+export declare function summarizeWorkers(workers: Iterable<HostWorker>): HostWorkerSummary;
+export type HostLinkMessage = HostStatusMessage;
+export declare const CONSOLE_USER_HEADER = "x-sb-console-user";
+export declare const CONSOLE_USER_NAME_HEADER = "x-sb-console-user-name";
+export declare const CONSOLE_ROLE_HEADER = "x-sb-console-role";

package/host-link/host-link.js

@@ -0,0 +1,54 @@
+/*
+ * The link of a SyncBridge server (a host) to SyncBridge Console: a
+ * WebSocket the host opens - so it may be behind any firewall - with its
+ * key (`Authorization: Bearer <key>`), its binary messages the frames of a
+ * Multiplexer. Console opens streams on it to the host's own HTTP
+ * server; the link's control messages are below.
+ */
+/** Where Console takes the hosts' links, on its API's port */
+export const HOST_LINK_PATH = '/hosts/link';
+/**
+ * The close code Console closes a link with when the host is not to
+ * connect again: its key changed, it was removed, or another host
+ * connected with the key. Any other close is a drop: it connects again.
+ */
+export const HOST_LINK_CLOSED = 4001;
+/** The statuses of a worker needing a look */
+const PROBLEM_STATUSES = new Set(['unhealthy', 'invalid', 'needs-init']);
+/** The problems named at most: the counts tell the rest */
+export const MAX_NAMED_PROBLEMS = 10;
+/** A host's workers, counted, as it tells Console */
+export function summarizeWorkers(workers) {
+    const summary = {
+        total: 0,
+        started: 0,
+        stopped: 0,
+        problem: 0,
+        other: 0,
+        problems: [],
+    };
+    for (const worker of workers) {
+        summary.total++;
+        if (worker.status === 'started')
+            summary.started++;
+        else if (worker.status === 'stopped')
+            summary.stopped++;
+        else if (PROBLEM_STATUSES.has(worker.status || '')) {
+            summary.problem++;
+            if (summary.problems.length < MAX_NAMED_PROBLEMS)
+                summary.problems.push(worker);
+        }
+        else
+            summary.other++;
+    }
+    return summary;
+}
+/*
+ * The headers a request Console passes on to the host carries: who it
+ * is for. The host takes them only from a stream of its link: what comes
+ * any other way is not Console.
+ */
+export const CONSOLE_USER_HEADER = 'x-sb-console-user';
+export const CONSOLE_USER_NAME_HEADER = 'x-sb-console-user-name';
+export const CONSOLE_ROLE_HEADER = 'x-sb-console-role';
+//# sourceMappingURL=host-link.js.map

package/host-link/host-link.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host-link.js","sourceRoot":"","sources":["../../src/host-link/host-link.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,8DAA8D;AAC9D,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;AAE5C;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAgCrC,8CAA8C;AAC9C,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;AACzE,2DAA2D;AAC3D,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAErC,qDAAqD;AACrD,MAAM,UAAU,gBAAgB,CAC9B,OAA6B;IAE7B,MAAM,OAAO,GAAsB;QACjC,KAAK,EAAE,CAAC;QACR,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;QACV,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,EAAE;KACb,CAAC;IACF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;YAAE,OAAO,CAAC,OAAO,EAAE,CAAC;aAC9C,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;YAAE,OAAO,CAAC,OAAO,EAAE,CAAC;aACnD,IAAI,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,kBAAkB;gBAC9C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC;;YAAM,OAAO,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAID;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,mBAAmB,CAAC;AACvD,MAAM,CAAC,MAAM,wBAAwB,GAAG,wBAAwB,CAAC;AACjE,MAAM,CAAC,MAAM,mBAAmB,GAAG,mBAAmB,CAAC"}

package/host-link/host-packages.d.ts

@@ -0,0 +1,25 @@
+/** Where, under Console's API, a host's packages are planned */
+export declare const HOST_PACKAGES_PATH = "host/packages";
+/** What a host asks to install */
+export interface HostPackagesResolveRequest {
+    /** "@org/name" */
+    name: string;
+    /** Its versions taken: "^2.0.0"; none, the newest */
+    range?: string;
+    /** What it has: each package's versions installed */
+    installed?: Record<string, string[]>;
+}
+/** A package of the plan, to be installed in its turn */
+export interface HostPackagePlanItem {
+    name: string;
+    version: string;
+    size: number;
+    /** SHA-256 of its archive, hex: checked before it is installed */
+    sha256: string;
+    /** Where it is read, relative to Console's API; a few minutes good */
+    url: string;
+}
+/** What to install, in order: the packages needed first */
+export interface HostPackagesResolveResponse {
+    items: HostPackagePlanItem[];
+}

package/host-link/host-packages.js

@@ -0,0 +1,10 @@
+/*
+ * Packages a host installs from the registry: it asks Console for a plan -
+ * the version of what it wants, the registry packages it needs that it
+ * has not - each one it may download (public, or its workspace's), each
+ * with its size, its hash and a short-lived link to it. Asked by the host,
+ * with a token it signs (HOST_TOKEN_HEADER).
+ */
+/** Where, under Console's API, a host's packages are planned */
+export const HOST_PACKAGES_PATH = 'host/packages';
+//# sourceMappingURL=host-packages.js.map

package/host-link/host-packages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host-packages.js","sourceRoot":"","sources":["../../src/host-link/host-packages.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,gEAAgE;AAChE,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC"}

package/host-link/host-workers.d.ts

@@ -0,0 +1,75 @@
+/** Where, under Console's API, a host's workers are kept */
+export declare const HOST_WORKERS_PATH = "host/workers";
+/** A worker as a host tells of it: its id, its profile's hash */
+export interface HostWorkerDigest {
+    id: string;
+    hash: string;
+}
+/** What a host tells of its workers: all of them, so those gone go */
+export interface HostWorkersSyncRequest {
+    workers: HostWorkerDigest[];
+}
+/** What Console answers: whether it keeps them; if so, which to send */
+export interface HostWorkersSyncResponse {
+    /** Its workspace keeps its hosts' workers: off, none are sent */
+    enabled: boolean;
+    /** Why not, when not */
+    reason?: string;
+    /** Those it has not, or not as they are: to be sent */
+    need: string[];
+    /** The key secret values are sealed for, on the way to Console */
+    sealKey?: string;
+    /**
+     * The host was reinstalled: the workers Console keeps are to be taken
+     * back (HOST_WORKERS_RESTORE_PATH). None is forgotten meanwhile.
+     */
+    restore?: boolean;
+}
+/** A worker's profile, as sent: its secret values sealed for Console */
+export interface HostWorkerProfile {
+    id: string;
+    hash: string;
+    profile: Record<string, any>;
+    /** The version of its app's package it runs: taken again on restore */
+    packageVersion?: string;
+}
+/** The profiles sent at once: their secrets sealed for Console */
+export interface HostWorkersPutRequest {
+    workers: HostWorkerProfile[];
+}
+/**
+ * A profile with each of its string values passed through `fn` - its
+ * secret values found by what they start with - the rest as they are
+ */
+export declare function mapProfileStrings<T>(value: T, fn: (text: string) => string): T;
+/** Where, under Console's API, a host reinstalled takes its workers back */
+export declare const HOST_WORKERS_RESTORE_PATH = "host/workers/restore";
+/** A worker to take back: its secret values sealed for the host */
+export interface HostRestoreWorker {
+    id: string;
+    /** Its profile's hash, as Console keeps it: told back while it waits */
+    hash: string;
+    profile: Record<string, any>;
+    /** Its app's package, and the version of it it ran */
+    packageName?: string;
+    packageVersion?: string;
+}
+/** The workers a host reinstalled takes back */
+export interface HostWorkersRestoreResponse {
+    workers: HostRestoreWorker[];
+}
+/**
+ * Where a worker taken back is: restored; waiting for its package - one
+ * not in the registry, or its workspace may not use - or failed
+ */
+export type HostWorkerRestoreState = 'restored' | 'waiting' | 'failed';
+/** What a host tells of the workers it takes back */
+export interface HostWorkersRestoreStatusRequest {
+    workers: {
+        id: string;
+        state: HostWorkerRestoreState;
+        message?: string;
+    }[];
+    /** Each one tried: the reinstall is over, those waiting wait on the host */
+    done?: boolean;
+}

package/host-link/host-workers.js

@@ -0,0 +1,29 @@
+/*
+ * A host's workers' configurations (profiles), kept by Console: a host
+ * reinstalled gets them back. The host tells Console what it has - each
+ * worker by a hash of its profile - and sends those Console asks for;
+ * Console keeps them, their secret values sealed on the way and kept
+ * enciphered. Asked by the host, with a token it signs (HOST_TOKEN_HEADER).
+ */
+/** Where, under Console's API, a host's workers are kept */
+export const HOST_WORKERS_PATH = 'host/workers';
+/**
+ * A profile with each of its string values passed through `fn` - its
+ * secret values found by what they start with - the rest as they are
+ */
+export function mapProfileStrings(value, fn) {
+    if (typeof value === 'string')
+        return fn(value);
+    if (Array.isArray(value))
+        return value.map(item => mapProfileStrings(item, fn));
+    if (value && typeof value === 'object') {
+        const out = {};
+        for (const [key, item] of Object.entries(value))
+            out[key] = mapProfileStrings(item, fn);
+        return out;
+    }
+    return value;
+}
+/** Where, under Console's API, a host reinstalled takes its workers back */
+export const HOST_WORKERS_RESTORE_PATH = 'host/workers/restore';
+//# sourceMappingURL=host-workers.js.map

package/host-link/host-workers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host-workers.js","sourceRoot":"","sources":["../../src/host-link/host-workers.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,4DAA4D;AAC5D,MAAM,CAAC,MAAM,iBAAiB,GAAG,cAAc,CAAC;AA4ChD;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAQ,EACR,EAA4B;IAE5B,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC,KAAK,CAAM,CAAC;IACrD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACtB,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAM,CAAC;IAC7D,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,GAAG,GAA4B,EAAE,CAAC;QACxC,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;YAC7C,GAAG,CAAC,GAAG,CAAC,GAAG,iBAAiB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACzC,OAAO,GAAQ,CAAC;IAClB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,4EAA4E;AAC5E,MAAM,CAAC,MAAM,yBAAyB,GAAG,sBAAsB,CAAC"}

package/host-link/multiplexer.d.ts

@@ -0,0 +1,115 @@
+import { Buffer } from 'node:buffer';
+import { EventEmitter } from 'node:events';
+import { Duplex } from 'node:stream';
+declare const FrameType: {
+    /** Opens a stream; payload: its meta, JSON */
+    readonly OPEN: 1;
+    readonly DATA: 2;
+    /** Lets the peer send that many more bytes on the stream; payload: u32 */
+    readonly CREDIT: 3;
+    /** The sender writes no more on the stream */
+    readonly END: 4;
+    /** The stream is gone, both ways; payload: why, utf8 */
+    readonly RESET: 5;
+    /** A message of the link itself, on no stream (id 0); payload: JSON */
+    readonly CONTROL: 6;
+};
+type FrameType = (typeof FrameType)[keyof typeof FrameType];
+export declare namespace Multiplexer {
+    interface Options {
+        /** Sends a frame over the link */
+        send: (frame: Buffer) => void;
+        /**
+         * The side it is: the streams one side opens have odd ids, the other's
+         * even, so both open without asking
+         */
+        side: 'console' | 'host';
+    }
+    interface Events {
+        /** The peer opened a stream */
+        stream: [stream: MuxStream, meta: Record<string, any>];
+        /** The peer sent a message of the link */
+        control: [message: Record<string, any>];
+    }
+}
+/**
+ * Streams over one link: each a Duplex, with its own flow control - a
+ * sender sends no more than its receiver has room for, so a slow stream
+ * holds back itself, not the link or the others.
+ */
+export declare class Multiplexer extends EventEmitter<Multiplexer.Events> {
+    readonly options: Multiplexer.Options;
+    protected _streams: Map<number, MuxStream>;
+    protected _nextId: number;
+    protected _closed: boolean;
+    constructor(options: Multiplexer.Options);
+    get closed(): boolean;
+    /** Opens a stream to the peer, with what it is for */
+    open(meta?: Record<string, any>): MuxStream;
+    /** Sends a message of the link itself */
+    control(message: Record<string, any>): void;
+    /** Takes a frame the link received */
+    receive(frame: Buffer): void;
+    /** The link is gone: its streams too */
+    close(reason?: string): void;
+    /** @internal */
+    _send(type: FrameType, id: number, payload?: Buffer): void;
+    /** @internal */
+    _sendCredit(id: number, bytes: number): void;
+    /** @internal */
+    _sendData(id: number, data: Buffer): void;
+    /** @internal */
+    _sendEnd(id: number): void;
+    /** @internal */
+    _sendReset(id: number, reason: string): void;
+    /** @internal */
+    _forget(id: number): void;
+}
+/**
+ * A stream of a Multiplexer. It passes for a socket where a Node HTTP
+ * server or client takes one: it has what they call on a socket.
+ */
+export declare class MuxStream extends Duplex {
+    protected _mux: Multiplexer;
+    readonly id: number;
+    /** Bytes it may send: what the peer has room for */
+    protected _credit: number;
+    /** Bytes taken in but not yet given back as credit: the reader is slow */
+    protected _owed: number;
+    /** A write waiting for credit */
+    protected _pending?: {
+        data: Buffer;
+        callback: (e?: Error) => void;
+    };
+    protected _ended: boolean;
+    protected _peerEnded: boolean;
+    protected _timeout?: NodeJS.Timeout;
+    protected _timeoutMs: number;
+    /** Where it comes from, for a server's request: the link */
+    readonly remoteAddress = "tunnel";
+    readonly remotePort = 0;
+    constructor(_mux: Multiplexer, id: number);
+    setTimeout(ms: number, callback?: () => void): this;
+    setNoDelay(): this;
+    setKeepAlive(): this;
+    ref(): this;
+    unref(): this;
+    address(): {};
+    /** @internal */
+    _receiveData(data: Buffer): void;
+    /** @internal */
+    _receiveCredit(bytes: number): void;
+    /** @internal */
+    _receiveEnd(): void;
+    /** @internal */
+    _receiveReset(reason: string): void;
+    _read(): void;
+    _write(chunk: Buffer, _encoding: BufferEncoding, callback: (e?: Error) => void): void;
+    _final(callback: (e?: Error) => void): void;
+    _destroy(error: Error | null, callback: (e: Error | null) => void): void;
+    /** Done both ways: it is let go */
+    protected _settle(): void;
+    /** Activity: the idle timeout starts over */
+    protected _touch(): void;
+}
+export {};