arketix 0.1.0 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # arketix
 
-The command line of the Arketix control room (https://crm.admin.acredix.cl), for founders and agents. Its commands come from the CRM's operations, so a new operation is a new command with no new release.
+The command line of Arketix ERP (https://erp.arketix.cl), for founders and agents. Its commands come from Arketix ERP's operations, so a new operation is a new command with no new release.
 
 ```sh
 npm i -g arketix
@@ -16,7 +16,7 @@ arketix help crm opportunities
 
 - **Flags come from each operation's input.** `ownerId` is `--owner-id`, enums are choices, objects and arrays take JSON, `--input '<json>'` passes the whole input. An operation with exactly one required id also takes it as one trailing word.
 - **Output.** People get a table for a list and `key: value` lines otherwise. `--json` prints one line: the output, or `{"error":{"code","message","retryable"}}`.
-- **Sign-in.** `login` keeps the token in the OS keychain. `ARKETIX_TOKEN` overrides it. `--env prod` (default) or `local` (http://localhost:3417); `ARKETIX_URL` points anywhere else.
-- **Catalogue.** The list of operations is cached per server version in `~/.cache/arketix`, so help works offline.
+- **Sign-in.** `login` keeps the token in the OS keychain. `ARKETIX_TOKEN` overrides it. `--env prod` (default, https://erp.arketix.cl) or `local` (http://localhost:3417); `ARKETIX_URL` points anywhere else. A token kept by 0.1.x for https://crm.admin.acredix.cl still signs in to prod; `logout` forgets both.
+- **Catalogue.** Every command, and help for one, asks Arketix ERP for its list of operations. The list is cached per server version and CLI release in `~/.cache/arketix`, which only saves the `tools/list` call while the server's version is unchanged. Nothing falls back to it: when the server can't be reached or gives no usable answer, the command exits 9, and a refused token exits with its code. `arketix`, `arketix help` and the built-ins' help need no token and no connection, so they list only the built-ins; `arketix help crm` lists the CRM module's commands.
 
-Exit codes: 0 ok, 1 other CRM error, 2 usage, 3 unauthenticated, 4 read-only token, 6 confirmation required, 7 not in catalogue, 8 rate limited, 9 connection lost (a write may have run), 10 forbidden, 12 input invalid.
+Exit codes: 0 ok, 1 other error, 2 usage, 3 unauthenticated, 4 read-only token, 6 confirmation required, 7 not in catalogue, 8 rate limited, 9 connection lost (a write may have run), 10 forbidden, 12 input invalid.

package/dist/arketix.js

@@ -17266,6 +17266,17 @@ function _array(Class, element, params) {
     ...normalizeParams(params)
   });
 }
+function _custom(Class, fn, _params) {
+  const norm = normalizeParams(_params);
+  norm.abort ?? (norm.abort = true);
+  const schema = new Class({
+    type: "custom",
+    check: "custom",
+    fn,
+    ...norm
+  });
+  return schema;
+}
 function _refine(Class, fn, _params) {
   const schema = new Class({
     type: "custom",
@@ -19569,6 +19580,9 @@ var ZodCustom = /* @__PURE__ */ $constructor("ZodCustom", (inst, def) => {
   ZodType.init(inst, def);
   inst._zod.processJSONSchema = (ctx, json, params) => customProcessor(inst, ctx, json, params);
 });
+function custom(fn, _params) {
+  return _custom(ZodCustom, fn ?? (() => true), _params);
+}
 function refine(fn, _params = {}) {
   return _refine(ZodCustom, fn, _params);
 }
@@ -36485,12 +36499,13 @@ var fail9 = (code, message, retryable = false) => {
 var exitCodes = EXIT_CODES;
 var exitCodeFor = (code) => exitCodes[code] ?? 1;
 // package.json
-var version2 = "0.1.0";
+var version2 = "0.2.0";
 
 // src/version.ts
 var VERSION = version2;
 
 // src/crm.ts
+var Catalogue = object({ cli: literal(VERSION), server: string4(), tools: array2(custom()) });
 var Output = record2(string4(), unknown2());
 
 class ConnectionLost extends Error {
@@ -36508,10 +36523,12 @@ function noAnswer(url, error, read) {
       retryable: false
     };
   }
+  if (status === 403)
+    return { code: "FORBIDDEN", message: `${url} refused this token access.`, retryable: false };
   if (status === 429)
     return { code: "RATE_LIMITED", message: `${url} is rate limiting this token. Wait and retry.`, retryable: true };
   const lost = error instanceof ConnectionLost || error instanceof Error && error.cause instanceof ConnectionLost;
-  const what = lost ? `The connection to ${url} failed` : `${url} gave no answer (${error instanceof Error ? error.message : String(error)})`;
+  const what = lost ? `The connection to ${url} failed` : `${url} gave no usable answer (${error instanceof Error ? error.message : String(error)})`;
   return read ? { code: "CONNECTION_LOST", message: `${what}. Nothing changed: retry.`, retryable: true } : { code: "CONNECTION_LOST", message: `${what}, so the call may have run. Check the current state before trying again.`, retryable: false };
 }
 function toolError(text) {
@@ -36535,40 +36552,41 @@ async function connect({ url, token, fetch: fetch2, catalogues }) {
         throw new ConnectionLost(error instanceof Error ? error.message : String(error));
       }
     },
-    requestInit: { headers: { authorization: `Bearer ${token}`, "x-arketix-channel": "cli" } }
+    requestInit: { headers: { ...token && { authorization: `Bearer ${token}` }, "x-arketix-channel": "cli" } }
   });
   const answered = async (request, read) => {
     try {
       return await request;
     } catch (error) {
-      throw new CliFailure(noAnswer(url, error, read));
+      const failure = noAnswer(url, error, read);
+      if (!token && failure.code === "UNAUTHENTICATED")
+        notSignedIn(url);
+      throw new CliFailure(failure);
     }
   };
   await answered(client.connect(transport), true);
-  const version = client.getServerVersion()?.version ?? "";
+  const server = client.getServerVersion()?.version ?? "";
   return {
     catalogue: async () => {
       const all = await catalogues.read();
-      const cached = all[url];
-      if (cached && cached.version === version)
+      const cached = Catalogue.safeParse(all[url]).data;
+      if (cached?.server === server)
         return cached;
-      const fresh = { version, tools: (await answered(client.listTools(), true)).tools };
+      const fresh = { cli: VERSION, server, tools: (await answered(client.listTools(), true)).tools };
       await catalogues.write({ ...all, [url]: fresh });
       return fresh;
     },
     call: async (name, args, { read }) => {
-      const result = await answered(client.callTool({ name, arguments: args }), read);
+      const unusable = (why) => new CliFailure(noAnswer(url, new Error(why), read));
+      const result = await answered(client.callTool({ name, arguments: args }).catch((error) => {
+        throw error instanceof ProtocolError ? unusable(error.message) : error;
+      }), read);
       if (result.isError)
         throw new CliFailure(toolError(textOf(result.content)));
-      if (result.structuredContent)
-        return Output.parse(result.structuredContent);
-      const text = textOf(result.content);
-      try {
-        const value = JSON.parse(text);
-        return Output.safeParse(value).data ?? { value };
-      } catch {
-        return { text };
-      }
+      const output = Output.safeParse(result.structuredContent);
+      if (!output.success)
+        throw unusable(`${name}: no structured content object`);
+      return output.data;
     },
     close: () => client.close()
   };
@@ -36604,26 +36622,31 @@ function human(output, columns = Infinity) {
 }
 
 // src/cli.ts
-var URLS = { prod: "https://crm.admin.acredix.cl", local: "http://localhost:3417" };
+var URLS = { prod: "https://erp.arketix.cl", local: "http://localhost:3417" };
 var isEnv = (value) => (value in URLS);
-function flagValue(argv, name) {
-  for (const [index, token] of argv.entries()) {
-    if (token === `--${name}`)
-      return argv[index + 1];
-    if (token.startsWith(`--${name}=`))
-      return token.slice(name.length + 3);
-  }
-}
-function targetOf(argv, io) {
-  const env = flagValue(argv, "env") ?? "prod";
+var OLD_PROD = "https://crm.admin.acredix.cl";
+function preParse(argv) {
+  let env;
+  const words = [];
+  for (let index = 0;index < argv.length; index++) {
+    const token = argv[index];
+    if (token === "--env")
+      env = argv[++index];
+    else if (token.startsWith("--env="))
+      env = token.slice("--env=".length);
+    else if (!token.startsWith("-"))
+      words.push(token);
+  }
+  return { env, words };
+}
+function targetOf(env, io) {
   if (!isEnv(env))
     return fail9("USAGE", "--env is prod or local; ARKETIX_URL points anywhere else.");
   const url = new URL(io.env.ARKETIX_URL ?? URLS[env]).origin;
-  return { url, token: io.env.ARKETIX_TOKEN?.trim() || io.secrets.get(url) };
+  return { url, token: io.env.ARKETIX_TOKEN?.trim() || io.secrets.get(url) || (url === URLS.prod ? io.secrets.get(OLD_PROD) : undefined) };
 }
 var opIdOf = (tool) => tool.name.replaceAll("_", ".");
 var kebab = (name) => name.replace(/[A-Z]/g, (c) => `-${c.toLowerCase()}`);
-var operationsOf = (tools) => tools.filter((tool) => !tool.description?.startsWith("Deprecated:"));
 var Property = looseObject({
   type: union2([string4(), array2(string4())]).optional(),
   anyOf: array2(looseObject({ type: string4().optional() })).optional(),
@@ -36656,7 +36679,7 @@ var InputSchema = object({ properties: record2(string4(), Property).optional(),
 var print = (run, value, text) => run.io.stdout(`${run.json ? JSON.stringify(value) : text}
 `);
 var needCrm = (run) => run.crm ?? notSignedIn(run.url);
-var operation = (run, id) => operationsOf(run.catalogue).find((tool) => opIdOf(tool) === id) ?? fail9("NOT_IN_CATALOGUE", `${id} is not an operation of ${run.url}. \`arketix help\` lists them.`);
+var operation = (run, id) => run.catalogue.find((tool) => opIdOf(tool) === id) ?? fail9("NOT_IN_CATALOGUE", `${id} is not an operation of ${run.url}. \`arketix help\` lists them.`);
 async function callOperation(run, tool, input, confirmed) {
   if (tool.annotations?.destructiveHint && !confirmed) {
     fail9("CONFIRMATION_REQUIRED", `${opIdOf(tool)} deletes or cancels. Nothing changed: repeat the command with --confirm to go ahead.`);
@@ -36695,7 +36718,7 @@ function operationCommand(run, tool, word) {
 }
 function operationCommands(run) {
   const root = { children: new Map };
-  for (const tool of operationsOf(run.catalogue)) {
+  for (const tool of run.catalogue) {
     let node = root;
     for (const word of opIdOf(tool).split(".").map(kebab)) {
       const next = node.children.get(word) ?? { children: new Map };
@@ -36711,7 +36734,7 @@ var JsonFlag = Setting("json")({
   flag: Boolean6("json").pipe(withDescription3("One line of JSON on stdout, errors included"), withDefault4(false))
 });
 var EnvFlag = Setting("env")({
-  flag: Literals3("env", ["prod", "local"]).pipe(withDescription3("Which CRM: prod is crm.admin.acredix.cl, local is localhost:3417. ARKETIX_URL points anywhere else"), withDefault4("prod"))
+  flag: Literals3("env", ["prod", "local"]).pipe(withDescription3("Which server: prod is erp.arketix.cl, local is localhost:3417. ARKETIX_URL points anywhere else"), withDefault4("prod"))
 });
 var Me = object({
   member: object({ name: string4(), email: string4(), role: string4() }),
@@ -36734,8 +36757,10 @@ function builtIns(run) {
       await crm.close();
     }
   })));
-  const logout = make12("logout").pipe(withDescription4("Forget the token for this CRM."), withHandler(handle(async () => {
+  const logout = make12("logout").pipe(withDescription4("Forget the token for this server."), withHandler(handle(async () => {
     run.io.secrets.delete(run.url);
+    if (run.url === URLS.prod)
+      run.io.secrets.delete(OLD_PROD);
     print(run, { signedOut: run.url }, `Signed out of ${run.url}.`);
   })));
   const whoami = make12("whoami").pipe(withDescription4("Who the token belongs to, and whether it may write."), withHandler(handle(async () => {
@@ -36757,28 +36782,27 @@ function builtIns(run) {
 }
 var readInputFile = (io, path) => io.readFile(path).catch(() => fail9("USAGE", `Can't read ${path}.`));
 var BUILT_IN_ONLY = new Set(["login", "logout", "version"]);
+var BUILT_INS = new Set([...BUILT_IN_ONLY, "whoami", "help", "call"]);
 async function runCli(args, io) {
   const json = args.includes("--json");
-  const argv = args[0] === "help" ? [...args.slice(1), "--help"] : [...args];
-  const wantsHelp = argv.length === 0 || argv.includes("--help") || argv.includes("-h");
+  const { env = "prod", words } = preParse(args);
+  const helpWord = words[0] === "help";
+  const argv = helpWord ? [...args.toSpliced(args.indexOf("help"), 1), "--help"] : [...args];
+  const command = words[helpWord ? 1 : 0];
+  const wantsHelp = command === undefined || argv.includes("--help") || argv.includes("-h");
+  const builtInHelp = wantsHelp && (command === undefined || BUILT_INS.has(command));
   let crm;
   try {
-    const { url, token } = targetOf(argv, io);
-    let catalogue = (await io.catalogues.read())[url]?.tools ?? [];
-    if (!BUILT_IN_ONLY.has(argv[0] ?? "") && !argv.includes("--version")) {
-      if (token) {
-        try {
-          crm = await connect({ url, token, fetch: io.fetch, catalogues: io.catalogues });
-          catalogue = (await crm.catalogue()).tools;
-        } catch (error) {
-          if (!wantsHelp)
-            throw error;
-        }
-      } else if (!wantsHelp)
+    const { url, token } = targetOf(env, io);
+    let catalogue = [];
+    if (!builtInHelp && !BUILT_IN_ONLY.has(command ?? "") && !argv.includes("--version")) {
+      if (!token && !wantsHelp)
         notSignedIn(url);
+      crm = await connect({ url, token, fetch: io.fetch, catalogues: io.catalogues });
+      catalogue = (await crm.catalogue()).tools;
     }
     const run = { io, json, url, crm, catalogue };
-    const cli = make12("arketix").pipe(withDescription4(`The Arketix control room (${url}) for people and agents. Commands come from the CRM's operations. ` + "Exit codes: 0 ok, 1 other CRM error, 2 usage, 3 unauthenticated, 4 read-only token, 6 confirmation required, " + "7 not in catalogue, 8 rate limited, 9 connection lost, 10 forbidden, 12 input invalid."), withSubcommands([...builtIns(run), ...operationCommands(run)]), withGlobalFlags([JsonFlag, EnvFlag]));
+    const cli = make12("arketix").pipe(withDescription4(`Arketix ERP (${url}) for people and agents. Commands come from its operations: ` + "`arketix help crm`, `arketix help metrics`, `arketix help settings`, `arketix help account`. " + "Exit codes: 0 ok, 1 other error, 2 usage, 3 unauthenticated, 4 read-only token, 6 confirmation required, " + "7 not in catalogue, 8 rate limited, 9 connection lost, 10 forbidden, 12 input invalid."), withSubcommands([...builtIns(run), ...operationCommands(run)]), withGlobalFlags([JsonFlag, EnvFlag]));
     const exit = await runPromiseExit2(runWith2(cli, { version: VERSION, renderErrors: false })(argv).pipe(provide3(services(io, json))));
     if (isSuccess3(exit))
       return 0;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "arketix",
-  "version": "0.1.0",
-  "description": "Command line for the Arketix control room: every CRM operation, for founders and agents.",
+  "version": "0.2.0",
+  "description": "Command line for Arketix ERP: every operation, for founders and agents.",
   "private": false,
   "type": "module",
   "bin": {