@sukramj/fabric-ui 0.1.2 → 0.2.0

package/README.md

@@ -43,11 +43,20 @@ Pages: `NodeStatus`, `NodePair`, `NodeFabrics` (with maintenance),
 context; none names a host concept. The selection page is driven by the
 provider's schema (see the repository's `docs/provider.md`).
 
+Controller pages (v0.2.0): `ControllerNodes`, `ControllerCommission`,
+`ControllerSettings`, and `ControllerNode` with the props `nodeId` (the
+16-digit hex `node_id_hex`) and an optional first `tab` (`overview`,
+`endpoints`, `attributes`, `acl`, `bindings`, `window`, `icd`, `fabrics`,
+`updates`). They read `ui.controller` (`createControllerStore`); the
+routes `controllerNodes`, `controllerCommission`, `controllerSettings` and
+the prefix `controllerNode` link them. `ui.controller.loadStatus()` sets
+`present` to false on a 404: the host serves no controller.
+
 ### Translator
 
 `t(key, vars)` is the host's. `createTranslator(locale, extra)` builds one
 over the package's catalogues (`catalogs.en`, `catalogs.de`, keys
-`node.*`, `common.*`) plus the host's own; a `locale` getter that reads
+`node.*`, `controller.*`, `shell.*`, `common.*`) plus the host's own; a `locale` getter that reads
 reactive state re-renders the pages on a language switch.
 
 ### Stylesheet
@@ -80,6 +89,10 @@ createFabricUI({ client, subscribe: (onEvent) => hub.on("fabric-ui", onEvent) })
 const close = subscribeStream(client.streamUrl(), (ev) => hub.publish(ev.type, ev.data));
 ```
 
+`ui.controller.connect()` opens `GET /controller/stream` the same way;
+`subscribeControllerStream` and the `subscribeController` option of
+`createFabricUI` are its twins.
+
 ## Developing
 
 ```sh

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sukramj/fabric-ui",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "The web interface of go-fabric nodes: Svelte 5 pages, UI kit, design tokens with a Home Assistant theme bridge, and the generated API client.",
   "license": "Apache-2.0",
   "author": "SukramJ",

package/src/lib/api/client.ts

@@ -1,4 +1,4 @@
-// The client of the node routes, typed from contract/openapi.yaml
+// The client of the node and controller routes, typed from contract/openapi.yaml
 // (schema.gen.ts). It is the TypeScript half of the contract: the tests in
 // client.test.ts read the same golden fixtures as the Go handler tests.
 // Mirrors the matter* functions of openccu-loom
@@ -40,6 +40,49 @@ export type FabricEvent = S["FabricEvent"];
 export type WindowEvent = S["WindowEvent"];
 export type ExposureEvent = S["ExposureEvent"];
 
+// The controller family (contract 0.2.0).
+export type ControllerStatus = S["ControllerStatus"];
+export type ControllerCapabilities = S["ControllerCapabilities"];
+export type ConnectionState = S["ConnectionState"];
+export type ControllerNodeSummary = S["ControllerNodeSummary"];
+export type ControllerNodeList = S["ControllerNodeList"];
+export type ControllerNodeDetail = S["ControllerNodeDetail"];
+export type NodeRecord = S["NodeRecord"];
+export type NodeProperties = S["NodeProperties"];
+export type NodeEndpoint = S["NodeEndpoint"];
+export type NodeCluster = S["NodeCluster"];
+export type NodeDeviceType = S["NodeDeviceType"];
+export type NodeWindow = S["NodeWindow"];
+export type AttributePath = S["AttributePath"];
+export type AttributeValue = S["AttributeValue"];
+export type AttributeValueList = S["AttributeValueList"];
+export type WriteRequest = S["WriteRequest"];
+export type WriteResult = S["WriteResult"];
+export type InvokeRequest = S["InvokeRequest"];
+export type InvokeResult = S["InvokeResult"];
+export type AclEntry = S["AclEntry"];
+export type AclTarget = S["AclTarget"];
+export type BindingTarget = S["BindingTarget"];
+export type EndpointBindings = S["EndpointBindings"];
+export type BindingList = S["BindingList"];
+export type IcdState = S["IcdState"];
+export type NodeFabric = S["NodeFabric"];
+export type NodeFabricList = S["NodeFabricList"];
+export type CommissionRequest = S["CommissionRequest"];
+export type Discovered = S["Discovered"];
+export type DiscoveredList = S["DiscoveredList"];
+export type Credential = S["Credential"];
+export type CredentialList = S["CredentialList"];
+export type CredentialRequest = S["CredentialRequest"];
+export type PendingUpdate = S["PendingUpdate"];
+export type UpdateQueue = S["UpdateQueue"];
+export type UpdateConsentRequest = S["UpdateConsentRequest"];
+export type AvailableUpdate = S["AvailableUpdate"];
+export type AvailableUpdateList = S["AvailableUpdateList"];
+export type ControllerEvent = S["ControllerEvent"];
+/** What GET /controller/discovery selects by. */
+export type DiscoverFilter = { filter?: "any" | "long_discriminator" | "short_discriminator" | "vendor" | "device_type"; value?: number; timeout?: number };
+
 /** The header the admin token travels in (token mode). */
 export const TOKEN_HEADER = "X-Fabric-UI-Token";
 
@@ -83,6 +126,42 @@ export interface FabricClient {
   factoryReset(): Promise<void>;
   /** The URL of the event stream. */
   streamUrl(): string;
+
+  // The controller family. Every node id is the 16-digit hex of node_id_hex.
+  /** The controller's status; it sets the admin token from csrf_token, as status() does. 404 when the host serves no controller. */
+  controllerStatus(): Promise<ControllerStatus>;
+  controllerNodes(): Promise<ControllerNodeList>;
+  controllerNode(id: string): Promise<ControllerNodeDetail>;
+  decommissionNode(id: string): Promise<void>;
+  interviewNode(id: string): Promise<void>;
+  enableNode(id: string): Promise<void>;
+  disableNode(id: string): Promise<void>;
+  setNodeAutoSubscribe(id: string, enabled: boolean): Promise<void>;
+  openNodeWindow(id: string, timeoutSeconds?: number): Promise<NodeWindow>;
+  closeNodeWindow(id: string): Promise<void>;
+  readAttributes(id: string, paths: AttributePath[], fabricFiltered?: boolean): Promise<AttributeValueList>;
+  writeAttribute(id: string, req: WriteRequest): Promise<WriteResult>;
+  invokeCommand(id: string, req: InvokeRequest): Promise<InvokeResult>;
+  nodeAcl(id: string): Promise<{ entries: AclEntry[] }>;
+  setNodeAcl(id: string, entries: AclEntry[]): Promise<WriteResult>;
+  nodeBindings(id: string): Promise<BindingList>;
+  setNodeBindings(id: string, endpoint: number, bindings: BindingTarget[]): Promise<WriteResult>;
+  nodeIcd(id: string): Promise<IcdState>;
+  registerNodeIcd(id: string, allowMultiAdmin?: boolean): Promise<IcdState>;
+  unregisterNodeIcd(id: string, force?: boolean): Promise<IcdState>;
+  nodeFabrics(id: string): Promise<NodeFabricList>;
+  removeNodeFabric(id: string, fabricIndex: number): Promise<void>;
+  commission(req: CommissionRequest): Promise<ControllerNodeDetail>;
+  discover(filter?: DiscoverFilter): Promise<DiscoveredList>;
+  credentials(): Promise<CredentialList>;
+  setCredential(req: CredentialRequest): Promise<void>;
+  removeCredential(kind: Credential["kind"], id: string): Promise<void>;
+  setFabricLabel(label: string): Promise<void>;
+  updates(): Promise<UpdateQueue>;
+  consentUpdate(req: UpdateConsentRequest): Promise<void>;
+  checkUpdates(): Promise<AvailableUpdateList>;
+  /** The URL of the controller's event stream. */
+  controllerStreamUrl(): string;
 }
 
 type Fetch = (input: string, init?: RequestInit) => Promise<Response>;
@@ -147,9 +226,63 @@ export function createClient(baseUrl: string, fetchImpl: Fetch = (i, init) => fe
     factoryReset: () =>
       call("POST", "/node/maintenance/factory-reset", { admin: true, body: { confirm: FACTORY_RESET_CONFIRMATION } }),
     streamUrl: () => base + "/node/stream",
+
+    async controllerStatus() {
+      const s = await call<ControllerStatus>("GET", "/controller/status");
+      if (s.csrf_token) token = s.csrf_token;
+      return s;
+    },
+    controllerNodes: () => call("GET", "/controller/nodes"),
+    controllerNode: (id) => call("GET", node(id)),
+    decommissionNode: (id) => call("DELETE", node(id), { admin: true }),
+    interviewNode: (id) => call("POST", node(id) + "/interview", { admin: true }),
+    enableNode: (id) => call("POST", node(id) + "/enable", { admin: true }),
+    disableNode: (id) => call("POST", node(id) + "/disable", { admin: true }),
+    setNodeAutoSubscribe: (id, enabled) => call("POST", node(id) + "/auto-subscribe", { admin: true, body: { enabled } }),
+    openNodeWindow: (id, timeoutSeconds) =>
+      call("POST", node(id) + "/window", { admin: true, body: timeoutSeconds === undefined ? {} : { timeout_seconds: timeoutSeconds } }),
+    closeNodeWindow: (id) => call("POST", node(id) + "/window/close", { admin: true }),
+    readAttributes: (id, paths, fabricFiltered) =>
+      call("POST", node(id) + "/attributes", { body: fabricFiltered === undefined ? { paths } : { paths, fabric_filtered: fabricFiltered } }),
+    writeAttribute: (id, req) => call("PUT", node(id) + "/attributes", { admin: true, body: req }),
+    invokeCommand: (id, req) => call("POST", node(id) + "/commands", { admin: true, body: req }),
+    nodeAcl: (id) => call("GET", node(id) + "/acl"),
+    setNodeAcl: (id, entries) => call("PUT", node(id) + "/acl", { admin: true, body: { entries } }),
+    nodeBindings: (id) => call("GET", node(id) + "/bindings"),
+    setNodeBindings: (id, endpoint, bindings) => call("PUT", node(id) + "/bindings", { admin: true, body: { endpoint, bindings } }),
+    nodeIcd: (id) => call("GET", node(id) + "/icd"),
+    registerNodeIcd: (id, allowMultiAdmin) =>
+      call("POST", node(id) + "/icd/register", { admin: true, body: allowMultiAdmin === undefined ? {} : { allow_multi_admin: allowMultiAdmin } }),
+    unregisterNodeIcd: (id, force) =>
+      call("POST", node(id) + "/icd/unregister", { admin: true, body: force === undefined ? {} : { force } }),
+    nodeFabrics: (id) => call("GET", node(id) + "/fabrics"),
+    removeNodeFabric: (id, i) => call("DELETE", `${node(id)}/fabrics/${encodeURIComponent(String(i))}`, { admin: true }),
+    commission: (req) => call("POST", "/controller/commission", { admin: true, body: req }),
+    discover(f = {}) {
+      const q = new URLSearchParams();
+      if (f.filter) q.set("filter", f.filter);
+      if (f.value !== undefined) q.set("value", String(f.value));
+      if (f.timeout !== undefined) q.set("timeout", String(f.timeout));
+      const qs = q.toString();
+      return call("GET", "/controller/discovery" + (qs ? "?" + qs : ""), { admin: true });
+    },
+    credentials: () => call("GET", "/controller/credentials"),
+    setCredential: (req) => call("PUT", "/controller/credentials", { admin: true, body: req }),
+    removeCredential: (kind, id) =>
+      call("DELETE", `/controller/credentials?${new URLSearchParams({ kind, id }).toString()}`, { admin: true }),
+    setFabricLabel: (label) => call("PUT", "/controller/fabric/label", { admin: true, body: { label } }),
+    updates: () => call("GET", "/controller/updates"),
+    consentUpdate: (req) => call("POST", "/controller/updates/consent", { admin: true, body: req }),
+    checkUpdates: () => call("POST", "/controller/updates/check", { admin: true }),
+    controllerStreamUrl: () => base + "/controller/stream",
   };
 }
 
+/** The path of a controller node. */
+function node(id: string): string {
+  return `/controller/nodes/${encodeURIComponent(id)}`;
+}
+
 function isProblem(v: unknown): v is Problem {
   return typeof v === "object" && v !== null && "code" in v && "title" in v;
 }