@syncbridge/common 2.1.0 → 2.3.0

package/constants.d.ts

@@ -1,4 +1,4 @@
-export declare const version = "2.1.0";
+export declare const version = "2.3.0";
 export declare const CLASS_METADATA: unique symbol;
 export declare const CLASS_TYPE: unique symbol;
 export declare const VARIABLE_CONTAINER: unique symbol;

package/constants.js

@@ -1,4 +1,4 @@
-export const version = '2.1.0';
+export const version = '2.3.0';
 export const CLASS_METADATA = Symbol.for('CLASS_METADATA');
 export const CLASS_TYPE = Symbol.for('CLASS_TYPE');
 export const VARIABLE_CONTAINER = Symbol.for('VARIABLE_CONTAINER');

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

@@ -41,3 +41,5 @@ 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";
+/** What the user may do inside the host: HostPermission values, comma-separated */
+export declare const CONSOLE_PERMISSIONS_HEADER = "x-sb-console-permissions";

package/host-link/host-link.js

@@ -51,3 +51,5 @@ export function summarizeWorkers(workers) {
 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';
+/** What the user may do inside the host: HostPermission values, comma-separated */
+export const CONSOLE_PERMISSIONS_HEADER = 'x-sb-console-permissions';

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

@@ -23,3 +23,47 @@ export interface HostPackagePlanItem {
 export interface HostPackagesResolveResponse {
     items: HostPackagePlanItem[];
 }
+/** Where, under Console's API, a host's packages' updates are asked */
+export declare const HOST_PACKAGE_UPDATES_PATH = "host/packages/updates";
+/** What a host asks of its packages' updates */
+export interface HostPackageUpdatesRequest {
+    /**
+     * check: what is newer of the versions it has; download: grants to read
+     * the versions it installs
+     */
+    mode: 'check' | 'download';
+    /** "@org/name" -> its newest version installed (check), or the one it installs (download) */
+    packages: Record<string, string>;
+}
+/** A version offered: what it needs of the registry's packages */
+export interface HostPackageOffer {
+    version: string;
+    /** Registry packages it depends on: name -> range */
+    dependencies: Record<string, string>;
+}
+/** What is newer of a package, or why it was not told */
+export interface HostPackageUpdate {
+    name: string;
+    /** The version sent */
+    version: string;
+    /**
+     * NOT_FOUND: not in the registry, or (download) no such version;
+     * NO_ACCESS: the host's workspace may not use it; SUSPENDED (download):
+     * the version is suspended
+     */
+    problem?: 'NOT_FOUND' | 'NO_ACCESS' | 'SUSPENDED';
+    /** check: the newest of its minor, newer than the one sent (a fix) */
+    patch?: HostPackageOffer;
+    /** check: the newest of its major, newer than the one sent */
+    minor?: HostPackageOffer;
+    /** check: a newer major's newest - told, never installed without asking */
+    major?: string;
+    /** download: the version sent, its grant in its link; a few minutes good */
+    download?: HostPackagePlanItem & {
+        dependencies: Record<string, string>;
+    };
+}
+/** Each package sent, answered */
+export interface HostPackageUpdatesResponse {
+    items: HostPackageUpdate[];
+}

package/host-link/host-packages.js

@@ -7,3 +7,15 @@
  */
 /** Where, under Console's API, a host's packages are planned */
 export const HOST_PACKAGES_PATH = 'host/packages';
+/*
+ * A host's packages' updates: what the registry has newer of each package
+ * it has, asked in one call. To check, its installed versions sent - each
+ * answered the newest of its minor (a fix), of its major (fixes and
+ * features) and a newer major, told apart; nothing signed. To install, the
+ * very versions it takes sent - each answered with a short-lived grant to
+ * read it: read by it without its access asked again, unless that version,
+ * its package or the host's workspace is suspended, or the access ended,
+ * since.
+ */
+/** Where, under Console's API, a host's packages' updates are asked */
+export const HOST_PACKAGE_UPDATES_PATH = 'host/packages/updates';

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

@@ -0,0 +1,44 @@
+/**
+ * What a user may do inside a host. Console grants them to an
+ * organization's members and passes them on with each request
+ * (CONSOLE_PERMISSIONS_HEADER); the host's own users have their role's.
+ */
+export declare enum HostPermission {
+    /** Seeing the workers, their logs and configuration, and the settings */
+    WorkersView = "host.workers.view",
+    /** Starting, stopping and initializing workers */
+    WorkersControl = "host.workers.control",
+    /** Changing a worker's configuration and its log channels */
+    WorkersConfigure = "host.workers.configure",
+    /** Adding workers */
+    WorkersCreate = "host.workers.create",
+    /** Removing workers */
+    WorkersDelete = "host.workers.delete",
+    /** Changing the host's settings, uploading packages */
+    Settings = "host.settings",
+    /** Updating SyncBridge */
+    Updates = "host.updates",
+    /** The host's own users */
+    Users = "host.users",
+    /** Pairing with Console, restoring, restarting SyncBridge */
+    System = "host.system",
+    /**
+     * Installing packages from the registry: Console's own permission, sent
+     * with its installs
+     */
+    Install = "hosts.install"
+}
+/** The roles inside a host, each a set of permissions */
+export type HostRole = 'viewer' | 'operator' | 'admin';
+/**
+ * The permissions of each role: a host's own users', and a user's whose
+ * Console sends a role alone (one older than the permissions)
+ */
+export declare const HOST_ROLE_PERMISSIONS: Readonly<Record<HostRole, readonly HostPermission[]>>;
+/** The permissions of a role; none for a role not known */
+export declare function hostRolePermissions(role: string | undefined | null): HostPermission[];
+/**
+ * The permissions a CONSOLE_PERMISSIONS_HEADER value gives: comma-separated,
+ * those not known dropped. No header, undefined: the role's to be taken.
+ */
+export declare function parseHostPermissions(value: string | undefined | null): HostPermission[] | undefined;

package/host-link/host-permissions.js

@@ -0,0 +1,66 @@
+/**
+ * What a user may do inside a host. Console grants them to an
+ * organization's members and passes them on with each request
+ * (CONSOLE_PERMISSIONS_HEADER); the host's own users have their role's.
+ */
+export var HostPermission;
+(function (HostPermission) {
+    /** Seeing the workers, their logs and configuration, and the settings */
+    HostPermission["WorkersView"] = "host.workers.view";
+    /** Starting, stopping and initializing workers */
+    HostPermission["WorkersControl"] = "host.workers.control";
+    /** Changing a worker's configuration and its log channels */
+    HostPermission["WorkersConfigure"] = "host.workers.configure";
+    /** Adding workers */
+    HostPermission["WorkersCreate"] = "host.workers.create";
+    /** Removing workers */
+    HostPermission["WorkersDelete"] = "host.workers.delete";
+    /** Changing the host's settings, uploading packages */
+    HostPermission["Settings"] = "host.settings";
+    /** Updating SyncBridge */
+    HostPermission["Updates"] = "host.updates";
+    /** The host's own users */
+    HostPermission["Users"] = "host.users";
+    /** Pairing with Console, restoring, restarting SyncBridge */
+    HostPermission["System"] = "host.system";
+    /**
+     * Installing packages from the registry: Console's own permission, sent
+     * with its installs
+     */
+    HostPermission["Install"] = "hosts.install";
+})(HostPermission || (HostPermission = {}));
+const VIEWER = [HostPermission.WorkersView];
+const OPERATOR = [
+    ...VIEWER,
+    HostPermission.WorkersControl,
+    HostPermission.WorkersConfigure,
+    HostPermission.WorkersCreate,
+    HostPermission.Install,
+];
+/**
+ * The permissions of each role: a host's own users', and a user's whose
+ * Console sends a role alone (one older than the permissions)
+ */
+export const HOST_ROLE_PERMISSIONS = {
+    viewer: VIEWER,
+    operator: OPERATOR,
+    admin: Object.values(HostPermission),
+};
+const KNOWN = new Set(Object.values(HostPermission));
+/** The permissions of a role; none for a role not known */
+export function hostRolePermissions(role) {
+    return [...(HOST_ROLE_PERMISSIONS[role] || [])];
+}
+/**
+ * The permissions a CONSOLE_PERMISSIONS_HEADER value gives: comma-separated,
+ * those not known dropped. No header, undefined: the role's to be taken.
+ */
+export function parseHostPermissions(value) {
+    if (value == null)
+        return;
+    const given = value
+        .split(',')
+        .map(s => s.trim())
+        .filter(s => KNOWN.has(s));
+    return [...new Set(given)];
+}

package/index.d.ts

@@ -16,6 +16,7 @@ export * from './decorators/log-channel.decorator.js';
 export * from './host-link/host-identity.js';
 export * from './host-link/host-link.js';
 export * from './host-link/host-packages.js';
+export * from './host-link/host-permissions.js';
 export * from './host-link/host-workers.js';
 export * from './host-link/multiplexer.js';
 export * from './host-link/sealed-box.js';

package/index.js

@@ -16,6 +16,7 @@ export * from './decorators/log-channel.decorator.js';
 export * from './host-link/host-identity.js';
 export * from './host-link/host-link.js';
 export * from './host-link/host-packages.js';
+export * from './host-link/host-permissions.js';
 export * from './host-link/host-workers.js';
 export * from './host-link/multiplexer.js';
 export * from './host-link/sealed-box.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncbridge/common",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "SyncBridge Common utilities",
   "author": "Panates Inc",
   "license": "MIT",