@zumino/cli 2.1.0 → 2.2.0

package/src/users.js

@@ -0,0 +1,38 @@
+import { api } from "./client.js";
+import { CliError } from "./errors.js";
+import { assertUserRef } from "./flags.js";
+
+/*
+ * Turning what a person typed into a user id.
+ *
+ * The shape check — an email refused, `me` and `-` recognised — is
+ * `assertUserRef` in `flags.js`, because it is about the argument and needs no
+ * credential. What is left here is the one part that does: resolving `me`
+ * against `GET /me`, so a script never needs a second command and a `jq`
+ * expression to name its own user.
+ */
+
+/**
+ * @param {any} ctx
+ * @param {string} value  a user id, `me`, or `-`/`none` to clear
+ * @param {{flag: string, allowClear?: boolean}} opts
+ * @returns {Promise<string|null>} `null` only when clearing is allowed and asked for
+ */
+export async function resolveUser(ctx, value, opts) {
+  return resolveUserRef(ctx, assertUserRef(value, opts));
+}
+
+/** The same, for a caller that has already classified the value. */
+export async function resolveUserRef(ctx, ref) {
+  if (ref.kind === "clear") return null;
+  if (ref.kind === "id") return ref.id;
+
+  const me = await api(ctx, "GET", "/me");
+  const id = me?.user?.id;
+  if (!id) {
+    throw new CliError(`This token's owner could not be read, so "me" has no id.`, {
+      hint: "Check the credential with: zumino auth status",
+    });
+  }
+  return id;
+}