@uic-coe-connect/cli 0.10.0 → 0.11.0

package/dist/commands/directory.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The directory from the terminal.
+ *
+ * Two audiences. Somebody curating the directory wants `list`, `show` and
+ * `add`. Somebody *integrating* an app wants `version` and `changes`, which
+ * show exactly what that app's mirror polls and exactly what it would receive —
+ * the questions that are otherwise answered by adding console.log to the SDK.
+ */
+export declare function registerDirectoryCommands(): void;

package/dist/commands/directory.js

@@ -0,0 +1,173 @@
+import { details, emit, info, table } from "../output.js";
+import { register } from "../registry.js";
+const when = (iso) => (iso ? iso.slice(0, 16).replace("T", " ") : "—");
+/**
+ * The directory from the terminal.
+ *
+ * Two audiences. Somebody curating the directory wants `list`, `show` and
+ * `add`. Somebody *integrating* an app wants `version` and `changes`, which
+ * show exactly what that app's mirror polls and exactly what it would receive —
+ * the questions that are otherwise answered by adding console.log to the SDK.
+ */
+export function registerDirectoryCommands() {
+    register({
+        name: "directory list",
+        summary: "People in the shared directory",
+        usage: "directory list [--search <q>] [--org <code>] [--status <s>] [--source <s>] [--limit <n>]",
+        details: [
+            "  --search  Substring match on netid, name or email.",
+            "  --org     One of BME, CHE, CME, CS, ECE, MIE, COE. Repeatable as a comma list.",
+            "  --status  active (default) | inactive | all.",
+            "  --source  login | manual | app — how the record got here.",
+            "  --limit   Default 50.",
+        ],
+        async run({ args, client }) {
+            const params = new URLSearchParams();
+            for (const [flag, key] of [
+                ["search", "search"],
+                ["org", "organizations"],
+                ["status", "status"],
+                ["source", "source"],
+                ["limit", "limit"],
+            ]) {
+                const v = args.flag(flag);
+                if (v)
+                    params.set(key, v);
+            }
+            if (!params.has("limit"))
+                params.set("limit", "50");
+            const data = await client().request("GET", `/directory/users?${params}`);
+            emit(data, () => {
+                if (data.users.length === 0) {
+                    info("Nobody matches.");
+                    return;
+                }
+                table(data.users.map((u) => ({
+                    netid: u.netid,
+                    name: u.displayName,
+                    org: u.organization ?? "—",
+                    email: u.email ?? "—",
+                    status: u.active ? "active" : u.masked ? "inactive (masked)" : "inactive",
+                    from: u.source,
+                })), ["netid", "name", "org", "email", "status", "from"]);
+                info("");
+                info(`${data.users.length} of ${data.total}.`);
+            });
+        },
+    }, {
+        name: "directory show",
+        summary: "One person's full directory record",
+        usage: "directory show <netid>",
+        async run({ args, client }) {
+            const netid = args.arg(0, "netid");
+            const data = await client().request("GET", `/directory/users?search=${encodeURIComponent(netid)}&status=all&limit=50`);
+            const user = data.users.find((u) => u.netid === netid);
+            if (!user)
+                throw new Error(`${netid} is not in the directory`);
+            emit({ user }, () => {
+                details([
+                    ["NetID", user.netid],
+                    ["Name", user.displayName],
+                    ["Email", user.email ?? "—"],
+                    ["UIN", user.uin ?? "—"],
+                    ["Organization", user.organization ?? "—"],
+                    ["Affiliations", user.affiliations.length > 0 ? user.affiliations.join(", ") : "—"],
+                    ["Status", user.active ? "active" : "inactive"],
+                    ["Added", `${user.source}${user.createdByApp ? ` (${user.createdByApp})` : ""}`],
+                    ["Created", when(user.createdAt)],
+                    ["Updated", when(user.updatedAt)],
+                    ["Last seen", when(user.lastSeen)],
+                ]);
+                if (!user.active) {
+                    info("");
+                    info(user.masked
+                        ? `Masked: apps see "Disabled User", not ${user.displayName}.`
+                        : `Not masked: apps still see ${user.displayName}.`);
+                }
+                if (user.affiliations.length === 0) {
+                    info("");
+                    info("No affiliations — they have never signed in. Do not gate access on that field.");
+                }
+            });
+        },
+    }, {
+        name: "directory add",
+        summary: "Add somebody to the shared directory",
+        usage: "directory add <netid> --name <full name> [--email <e>] [--org <code>] [--uin <u>]",
+        details: [
+            "  --name   Required for somebody new. Ignored if they are already here.",
+            "  --org    One of BME, CHE, CME, CS, ECE, MIE, COE.",
+            "",
+            "  Adding somebody who already exists changes nothing and is not an error.",
+        ],
+        async run({ args, client }) {
+            const netid = args.arg(0, "netid");
+            const body = { netid };
+            for (const [flag, key] of [
+                ["name", "displayName"],
+                ["email", "email"],
+                ["org", "organization"],
+                ["uin", "uin"],
+            ]) {
+                const v = args.flag(flag);
+                if (v)
+                    body[key] = v;
+            }
+            const data = await client().request("POST", "/directory/users", body);
+            emit(data, () => info(`Added ${data.user.displayName} (${data.user.netid}).`));
+        },
+    }, {
+        name: "directory version",
+        summary: "What an app's mirror polls — generation, count, last change",
+        usage: "directory version",
+        details: [
+            "  The generation is opaque and changes whenever anything in the directory",
+            "  changes. A mirror that already holds this generation does no work.",
+        ],
+        async run({ client }) {
+            const data = await client().request("GET", "/directory/version");
+            emit(data, () => details([
+                ["Generation", data.generation],
+                ["People", String(data.count)],
+                ["Last change", when(data.updatedAt)],
+            ]));
+        },
+    }, {
+        name: "directory changes",
+        summary: "Exactly what a mirror would receive since a given time",
+        usage: "directory changes [--since <iso>] [--limit <n>]",
+        details: [
+            "  --since  ISO-8601. Omit it to see a first full sync.",
+            "",
+            "  This is the app-facing projection, so it is what actually lands in",
+            "  coe_users — no UIN, and deactivated people masked unless excepted.",
+            "  Use it to check an integration without instrumenting the SDK.",
+        ],
+        async run({ args, client }) {
+            const params = new URLSearchParams();
+            params.set("updatedSince", args.flag("since") ?? "");
+            params.set("limit", args.flag("limit") ?? "500");
+            const data = await client().request("GET", `/directory/changes?${params}`);
+            emit(data, () => {
+                if (data.users.length === 0) {
+                    info("Nothing has changed since then.");
+                }
+                else {
+                    table(data.users.map((u) => ({
+                        netid: u.netid,
+                        name: u.displayName,
+                        org: u.organization ?? "—",
+                        email: u.email ?? "—",
+                        active: u.active ? "yes" : "no",
+                        changed: when(u.updatedAt),
+                    })), ["netid", "name", "org", "email", "active", "changed"]);
+                    info("");
+                    info(`${data.users.length} of ${data.total} changed rows.`);
+                }
+                if (data.deleted.length > 0)
+                    info(`Removed: ${data.deleted.join(", ")}`);
+                info(`Generation ${data.version.generation}, ${data.version.count} people.`);
+            });
+        },
+    });
+}

package/dist/index.js

@@ -4,6 +4,7 @@ import { registerAccessCommands } from "./commands/access.js";
 import { registerAppCommands } from "./commands/apps.js";
 import { registerAuthCommands } from "./commands/auth.js";
 import { registerDeployCommands } from "./commands/deploy.js";
+import { registerDirectoryCommands } from "./commands/directory.js";
 import { registerEnvCommands } from "./commands/env.js";
 import { registerEventCommands } from "./commands/events.js";
 import { registerIntegrationCommands } from "./commands/integration.js";
@@ -26,6 +27,7 @@ registerResourceCommands();
 registerLogCommands();
 registerVmCommands();
 registerReportCommands();
+registerDirectoryCommands();
 function parseArgs(argv) {
     const positional = [];
     const flags = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uic-coe-connect/cli",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "The coe CLI \u2014 manage COEConnect apps (pipelines, deploys, access, env) from a terminal, with browser-approved auth. Designed to be driven by an AI agent.",
   "type": "module",
   "bin": {