@meilisearch/cli 0.0.0-stage → 0.1.0

package/dist/lib/help.js

@@ -0,0 +1,37 @@
+/**
+ * Root and topic help with two extra sections: the global flags of every
+ * command and the environment variables of docs/contract/config.md, so that
+ * `meili --help` alone documents how to configure the CLI.
+ */
+import { Help } from "@oclif/core";
+import { BaseCommand } from "./base-command.js";
+import { ENV_VARS } from "./config.js";
+export default class MeiliHelp extends Help {
+    formatRoot() {
+        const variables = ENV_VARS.map((variable) => [
+            variable.name,
+            variable.description,
+        ]);
+        return [
+            super.formatRoot(),
+            this.section("GLOBAL FLAGS", globalFlagRows()),
+            this.section("ENVIRONMENT VARIABLES", variables),
+        ].join("\n\n");
+    }
+    formatTopic(topic) {
+        // `super` ends with a blank line, and oclif prints the commands of the topic
+        // right after this: the section is joined to the trimmed text and keeps the
+        // one trailing newline that separates it from them.
+        const topicHelp = super.formatTopic(topic).trimEnd();
+        return `${topicHelp}\n\n${this.section("GLOBAL FLAGS", globalFlagRows())}\n`;
+    }
+}
+/** `-o, --output=<mode>` and its description, in the order of the contract table. */
+function globalFlagRows() {
+    return Object.entries(BaseCommand.baseFlags).map(([name, flag]) => {
+        const short = flag.char === undefined ? "" : `-${flag.char}, `;
+        const value = flag.type === "option" ? `=${flag.helpValue}` : "";
+        return [`${short}--${name}${value}`, flag.description ?? ""];
+    });
+}
+//# sourceMappingURL=help.js.map

package/dist/lib/help.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"help.js","sourceRoot":"","sources":["../../src/lib/help.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,IAAI,EAAmB,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,IAAI;IAChC,UAAU;QACjB,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAoB,EAAE,CAAC;YAC7D,QAAQ,CAAC,IAAI;YACb,QAAQ,CAAC,WAAW;SACrB,CAAC,CAAC;QACH,OAAO;YACL,KAAK,CAAC,UAAU,EAAE;YAClB,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,cAAc,EAAE,CAAC;YAC9C,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,SAAS,CAAC;SACjD,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjB,CAAC;IAEkB,WAAW,CAAC,KAAuB;QACpD,6EAA6E;QAC7E,4EAA4E;QAC5E,oDAAoD;QACpD,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;QACrD,OAAO,GAAG,SAAS,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,cAAc,EAAE,CAAC,IAAI,CAAC;IAC/E,CAAC;CACF;AAED,qFAAqF;AACrF,SAAS,cAAc;IACrB,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;QAChE,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC;QAC/D,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjE,OAAO,CAAC,GAAG,KAAK,KAAK,IAAI,GAAG,KAAK,EAAE,EAAE,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/lib/input.js

@@ -0,0 +1,76 @@
+import { readFileSync } from "node:fs";
+import { MeiliCliError } from "./errors.js";
+let stdin;
+/**
+ * Stdin to its end, without the trailing newline, read once per process: oclif
+ * parses the flags in `init` and again in `run`. Called only when a flag is
+ * given as `-`: a command never reads stdin otherwise (docs/contract/output.md).
+ */
+export function readStdin() {
+    stdin ??= readFileSync(0, "utf8").replace(/\r?\n$/, "");
+    return stdin;
+}
+/**
+ * The JSON body of `--file` or `--data`, undefined when neither is given.
+ * Read and parsed before anything is sent: a file that cannot be read and text
+ * that is not JSON are `cli_input_invalid`, exit 2 (docs/contract/output.md).
+ */
+export function readJsonBody(flags) {
+    const text = flags.data ?? (flags.file === undefined ? undefined : readBodyFile(flags.file));
+    if (text === undefined)
+        return undefined;
+    try {
+        return JSON.parse(text);
+    }
+    catch (cause) {
+        throw new MeiliCliError("cli_input_invalid", `${bodySource(flags)} is not valid JSON.`, {
+            cause,
+        });
+    }
+}
+/**
+ * The same body, for a route whose body is an object of named fields. A body
+ * that is not an object is `cli_input_invalid`, exit 2, before anything is sent.
+ */
+export function readJsonObjectBody(flags) {
+    const body = readJsonBody(flags);
+    if (body === undefined)
+        return {};
+    if (!isJsonObject(body)) {
+        throw new MeiliCliError("cli_input_invalid", `${bodySource(flags)} must be a JSON object.`);
+    }
+    return body;
+}
+/**
+ * The body a command sends on a route whose body is an object of named
+ * fields: the JSON of `--file` or `--data` first, then `fields`, the fields
+ * its own flags define, which override the ones the body carries (rule 8 of
+ * docs/contract/commands.md). A field left undefined is dropped rather than
+ * spread: an absent flag would otherwise erase the field the body carries,
+ * since JSON.stringify leaves an undefined value out.
+ */
+export function readBodyWithFields(flags, fields) {
+    return {
+        ...readJsonObjectBody(flags),
+        ...Object.fromEntries(Object.entries(fields).filter(([, value]) => value !== undefined)),
+    };
+}
+/** Which of the two flags carried the body, for the message of an error about it. */
+function bodySource(flags) {
+    return flags.data === undefined ? `\`${flags.file}\`` : "--data";
+}
+function readBodyFile(path) {
+    if (path === "-")
+        return readStdin();
+    try {
+        return readFileSync(path, "utf8");
+    }
+    catch (cause) {
+        throw new MeiliCliError("cli_input_invalid", `Cannot read \`${path}\`.`, { cause });
+    }
+}
+/** Narrows a parsed body to a JSON object, which an array and a scalar are not. */
+export function isJsonObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+//# sourceMappingURL=input.js.map

package/dist/lib/input.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"input.js","sourceRoot":"","sources":["../../src/lib/input.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,IAAI,KAAyB,CAAC;AAE9B;;;;GAIG;AACH,MAAM,UAAU,SAAS;IACvB,KAAK,KAAK,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACxD,OAAO,KAAK,CAAC;AACf,CAAC;AAQD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,KAA0B;IACrD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7F,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACzC,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,aAAa,CAAC,mBAAmB,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,qBAAqB,EAAE;YACtF,KAAK;SACN,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAA0B;IAC3D,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IAClC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,aAAa,CAAC,mBAAmB,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC9F,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,KAA0B,EAC1B,MAA+B;IAE/B,OAAO;QACL,GAAG,kBAAkB,CAAC,KAAK,CAAC;QAC5B,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;KACzF,CAAC;AACJ,CAAC;AAED,qFAAqF;AACrF,SAAS,UAAU,CAAC,KAA0B;IAC5C,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;AACnE,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,IAAI,IAAI,KAAK,GAAG;QAAE,OAAO,SAAS,EAAE,CAAC;IACrC,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,aAAa,CAAC,mBAAmB,EAAE,iBAAiB,IAAI,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACtF,CAAC;AACH,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC"}

package/dist/lib/login.js

@@ -0,0 +1,57 @@
+/**
+ * The browser login of `meili auth login`, which `meili teleport` runs too
+ * when nobody is logged in. See ADR 0009.
+ */
+import { spawn } from "node:child_process";
+import { identify } from "./analytics.js";
+import { getApiV2Me } from "./clients/management/generated/sdk.gen.js";
+import { createManagementClient } from "./clients/management.js";
+import { logIn, SCOPES } from "./clients/oauth.js";
+import { credentialsFilePath, resolveOauthClient, writeCredentialsFile, } from "./session.js";
+/** How long the human has to approve before the login gives up. */
+const TIMEOUT_MS = 300_000;
+/**
+ * Runs the OAuth flow, writes the session to the credentials file, with the
+ * Cloud user the usage events use from now on (ADR 0016), and returns both.
+ * `say` writes a line for the human: an interactive command draws it in its margin.
+ */
+export async function logInWithBrowser(env, browser, userAgent, say = (line) => process.stderr.write(`${line}\n`)) {
+    const client = resolveOauthClient(env);
+    const tokens = await logIn(client, {
+        timeoutMs: TIMEOUT_MS,
+        onAuthorizationUrl: (url) => {
+            say(`Approve the login for \`${SCOPES}\` at:`);
+            say(url);
+            if (browser)
+                openInBrowser(url);
+        },
+    });
+    const session = { ...client, ...tokens };
+    const userId = await identify(env, async () => {
+        const management = createManagementClient({
+            url: session.managementUrl,
+            token: session.accessToken,
+            userAgent,
+        });
+        return (await getApiV2Me({ client: management })).id;
+    });
+    if (userId !== undefined)
+        session.userId = userId;
+    const path = credentialsFilePath(env);
+    writeCredentialsFile(path, session);
+    return { path, session };
+}
+/** Hands the URL to the desktop. A failure is not one: the URL is on stderr. */
+function openInBrowser(url) {
+    // An argument array and no shell, on every platform: a consent URL always
+    // carries `&`, which `cmd` would read as a command separator.
+    const [command, args] = process.platform === "darwin"
+        ? ["open", [url]]
+        : process.platform === "win32"
+            ? ["rundll32", ["url.dll,FileProtocolHandler", url]]
+            : ["xdg-open", [url]];
+    const child = spawn(command, args, { stdio: "ignore", detached: true });
+    child.on("error", () => { });
+    child.unref();
+}
+//# sourceMappingURL=login.js.map

package/dist/lib/login.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"login.js","sourceRoot":"","sources":["../../src/lib/login.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,2CAA2C,CAAC;AACvE,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAElB,oBAAoB,GACrB,MAAM,cAAc,CAAC;AAEtB,mEAAmE;AACnE,MAAM,UAAU,GAAG,OAAO,CAAC;AAE3B;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,GAAQ,EACR,OAAgB,EAChB,SAAiB,EACjB,GAAG,GAA2B,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,IAAI,CAAC;IAEzE,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE;QACjC,SAAS,EAAE,UAAU;QACrB,kBAAkB,EAAE,CAAC,GAAG,EAAE,EAAE;YAC1B,GAAG,CAAC,2BAA2B,MAAM,QAAQ,CAAC,CAAC;YAC/C,GAAG,CAAC,GAAG,CAAC,CAAC;YACT,IAAI,OAAO;gBAAE,aAAa,CAAC,GAAG,CAAC,CAAC;QAClC,CAAC;KACF,CAAC,CAAC;IACH,MAAM,OAAO,GAAY,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAClD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,UAAU,GAAG,sBAAsB,CAAC;YACxC,GAAG,EAAE,OAAO,CAAC,aAAa;YAC1B,KAAK,EAAE,OAAO,CAAC,WAAW;YAC1B,SAAS;SACV,CAAC,CAAC;QACH,OAAO,CAAC,MAAM,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACvD,CAAC,CAAC,CAAC;IACH,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;IAClD,MAAM,IAAI,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACtC,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACpC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAC3B,CAAC;AAED,gFAAgF;AAChF,SAAS,aAAa,CAAC,GAAW;IAChC,0EAA0E;IAC1E,8DAA8D;IAC9D,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,GACnB,OAAO,CAAC,QAAQ,KAAK,QAAQ;QAC3B,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO;YAC5B,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAC;YACpD,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACxE,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IAC5B,KAAK,CAAC,KAAK,EAAE,CAAC;AAChB,CAAC"}

package/dist/lib/output.js

@@ -0,0 +1,39 @@
+/**
+ * Output contract: the only module that writes to stdout. See docs/contract/output.md.
+ *
+ * This file, errors.ts and config.ts implement the contract. They change only
+ * through a contract pull request.
+ */
+import { MeiliCliError } from "./errors.js";
+export const OUTPUT_MODES = ["json", "ndjson"];
+export function isOutputMode(value) {
+    return typeof value === "string" && OUTPUT_MODES.includes(value);
+}
+/** `--output` wins, then `MEILI_OUTPUT`, then `json`. */
+export function resolveOutputMode(options) {
+    if (isOutputMode(options.flag))
+        return options.flag;
+    const fromEnv = options.env.MEILI_OUTPUT;
+    if (fromEnv !== undefined && fromEnv !== "") {
+        if (isOutputMode(fromEnv))
+            return fromEnv;
+        throw new MeiliCliError("cli_usage", `MEILI_OUTPUT must be one of ${OUTPUT_MODES.join(", ")}, got \`${fromEnv}\`.`);
+    }
+    return "json";
+}
+/** Formats a value for stdout in the selected mode. Pure, so tests can snapshot it. */
+export function formatData(value, options) {
+    if (options.mode === "json") {
+        return `${options.stdoutIsTTY ? JSON.stringify(value, null, 2) : JSON.stringify(value)}\n`;
+    }
+    if (options.supportsNdjson !== true) {
+        throw new MeiliCliError("cli_usage", "The `ndjson` output mode is only available on list commands. Use `--output json`.");
+    }
+    const items = Array.isArray(value) ? value : [value];
+    return items.map((item) => `${JSON.stringify(item)}\n`).join("");
+}
+/** Writes one result on stdout. Data only, nothing else, ever. */
+export function writeData(value, options) {
+    process.stdout.write(formatData(value, options));
+}
+//# sourceMappingURL=output.js.map

package/dist/lib/output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.js","sourceRoot":"","sources":["../../src/lib/output.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAU,CAAC;AAIxD,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAK,YAAkC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC1F,CAAC;AAQD,yDAAyD;AACzD,MAAM,UAAU,iBAAiB,CAAC,OAAiC;IACjE,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,OAAO,CAAC,IAAI,CAAC;IACpD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;IACzC,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;QAC5C,IAAI,YAAY,CAAC,OAAO,CAAC;YAAE,OAAO,OAAO,CAAC;QAC1C,MAAM,IAAI,aAAa,CACrB,WAAW,EACX,+BAA+B,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,OAAO,KAAK,CAC9E,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAUD,uFAAuF;AACvF,MAAM,UAAU,UAAU,CAAC,KAAc,EAAE,OAAyB;IAClE,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC5B,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;IAC7F,CAAC;IACD,IAAI,OAAO,CAAC,cAAc,KAAK,IAAI,EAAE,CAAC;QACpC,MAAM,IAAI,aAAa,CACrB,WAAW,EACX,mFAAmF,CACpF,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACrD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnE,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,SAAS,CAAC,KAAc,EAAE,OAAyB;IACjE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AACnD,CAAC"}

package/dist/lib/pagination.js

@@ -0,0 +1,52 @@
+/**
+ * Pagination for list routes: `--limit`, `--offset` or `--from`, and `--all`.
+ * See docs/contract/output.md, section Pagination.
+ */
+/** The envelope fields that describe one page rather than the whole list. */
+const PAGE_FIELDS = ["limit", "offset", "from"];
+function numberField(page, name) {
+    const value = page[name];
+    return typeof value === "number" ? value : 0;
+}
+/** The query of the page after `page`, or undefined once `total` is reached. */
+export function nextOffsetQuery(query, page) {
+    const offset = numberField(page, "offset") + page.results.length;
+    const done = page.results.length === 0 || offset >= numberField(page, "total");
+    return done ? undefined : { ...query, offset };
+}
+/**
+ * The query of the page after `page` on a cursor route: the API answers the
+ * `from` of the next page in `next`, and a `next` that is not a number, null
+ * on the last page, ends the walk.
+ */
+export function nextFromQuery(query, page) {
+    const next = page.next;
+    return typeof next === "number" ? { ...query, from: next } : undefined;
+}
+/** The query of the page after `page` on a numbered route, or undefined past `totalPages`. */
+export function nextPageQuery(query, page) {
+    const current = numberField(page, "page");
+    const done = page.results.length === 0 || current >= numberField(page, "totalPages");
+    return done ? undefined : { ...query, page: current + 1 };
+}
+/** Fetches page after page until `nextQuery` says there is no page left. */
+export async function* iteratePages(fetchPage, query, nextQuery) {
+    let current = query;
+    while (current !== undefined) {
+        const page = await fetchPage(current);
+        yield page;
+        current = nextQuery(current, page);
+    }
+}
+/**
+ * The envelope of the last page with `results` replaced by every item and the
+ * fields that describe one page removed. The others, like `total`, stay. A
+ * route carries one pair or the other, so dropping all three is dropping its.
+ */
+export function mergePages(pages) {
+    const last = { ...(pages.at(-1) ?? { results: [] }) };
+    for (const field of PAGE_FIELDS)
+        delete last[field];
+    return { ...last, results: pages.flatMap((page) => page.results) };
+}
+//# sourceMappingURL=pagination.js.map

package/dist/lib/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../src/lib/pagination.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAgBH,6EAA6E;AAC7E,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAEhD,SAAS,WAAW,CAAC,IAAc,EAAE,IAAY;IAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,eAAe,CAAC,KAAkB,EAAE,IAAc;IAChE,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IACjE,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,IAAI,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/E,OAAO,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAgB,EAAE,IAAc;IAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AACzE,CAAC;AAOD,8FAA8F;AAC9F,MAAM,UAAU,aAAa,CAAsB,KAAQ,EAAE,IAAc;IACzE,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,IAAI,WAAW,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACrF,OAAO,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,OAAO,GAAG,CAAC,EAAE,CAAC;AAC5D,CAAC;AAED,4EAA4E;AAC5E,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,YAAY,CACjC,SAAmC,EACnC,KAAQ,EACR,SAAsD;IAEtD,IAAI,OAAO,GAAkB,KAAK,CAAC;IACnC,OAAO,OAAO,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAM,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,IAAI,CAAC;QACX,OAAO,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,KAA0B;IACnD,MAAM,IAAI,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;IACtD,KAAK,MAAM,KAAK,IAAI,WAAW;QAAE,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;IACpD,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;AACrE,CAAC"}

package/dist/lib/session.js

@@ -0,0 +1,149 @@
+/**
+ * The Management API session: the credentials file `meili auth login` writes,
+ * the resolution order of `docs/contract/config.md`, and the refresh that keeps
+ * an access token usable. See ADR 0009.
+ *
+ * It sits above `config.ts`, which stays a leaf, and below the commands.
+ */
+import { rmSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { refreshAccessToken } from "./clients/oauth.js";
+import { configFilePath, DEFAULT_MANAGEMENT_CLIENT_ID, DEFAULT_MANAGEMENT_DASHBOARD_URL, DEFAULT_MANAGEMENT_URL, ENV, nonEmpty, readOwnerOnly, writeSecretFile, } from "./config.js";
+import { isRecord, MeiliCliError } from "./errors.js";
+/**
+ * A token travels in the clear to anything but HTTPS, so only a loopback
+ * address, where nothing leaves the machine, may be plain HTTP.
+ */
+function requireSecureUrl(url, what) {
+    let parsed;
+    try {
+        parsed = new URL(url);
+    }
+    catch {
+        throw new MeiliCliError("cli_usage", `${what} is not a URL: ${url}`);
+    }
+    // `hostname` keeps the brackets of an IPv6 address and drops the port, `host` does not.
+    const loopback = ["localhost", "127.0.0.1", "[::1]"].includes(parsed.hostname);
+    if (parsed.protocol !== "https:" && !loopback) {
+        throw new MeiliCliError("cli_usage", `${what} must be HTTPS, or a loopback address: ${url} would send the token in the clear.`);
+    }
+}
+/**
+ * The OAuth application `auth login` identifies itself with: the environment,
+ * then the application of this CLI, which every Cloud registers with the same id.
+ */
+export function resolveOauthClient(env) {
+    // The two URLs name the same Cloud: one alone would send the human to the consent
+    // page of a Cloud and the code to the token endpoint of another.
+    const managementUrl = nonEmpty(env[ENV.MANAGEMENT_URL]);
+    const dashboardUrl = nonEmpty(env[ENV.MANAGEMENT_DASHBOARD_URL]);
+    if ((managementUrl === undefined) !== (dashboardUrl === undefined)) {
+        throw new MeiliCliError("cli_usage", "A Cloud is named by both of its URLs. Set `MEILI_MANAGEMENT_URL` and `MEILI_MANAGEMENT_DASHBOARD_URL` together, or neither to use Meilisearch Cloud.");
+    }
+    const client = {
+        clientId: nonEmpty(env[ENV.MANAGEMENT_CLIENT_ID]) ?? DEFAULT_MANAGEMENT_CLIENT_ID,
+        managementUrl: managementUrl ?? DEFAULT_MANAGEMENT_URL,
+        dashboardUrl: dashboardUrl ?? DEFAULT_MANAGEMENT_DASHBOARD_URL,
+    };
+    requireSecureUrl(client.managementUrl, ENV.MANAGEMENT_URL);
+    requireSecureUrl(client.dashboardUrl, ENV.MANAGEMENT_DASHBOARD_URL);
+    return client;
+}
+/** `credentials.json`, next to the config file: `MEILI_CONFIG` moves both. */
+export function credentialsFilePath(env) {
+    return join(dirname(configFilePath(env)), "credentials.json");
+}
+/** The session of `auth login`, undefined when nobody logged in. */
+export function readCredentialsFile(path, warn) {
+    const text = readOwnerOnly(path, "credentials", warn);
+    if (text === undefined)
+        return undefined;
+    const malformed = () => new MeiliCliError(`cli_config`, `The credentials file ${path} is not a session of \`meili auth login\`.`, { hint: "Run `meili auth login` to write it again." });
+    let parsed;
+    try {
+        parsed = JSON.parse(text);
+    }
+    catch {
+        throw malformed();
+    }
+    const fields = ["clientId", "managementUrl", "dashboardUrl", "accessToken", "expiresAt", "scope"];
+    if (!isRecord(parsed) || !fields.every((field) => typeof parsed[field] === "string")) {
+        throw malformed();
+    }
+    if (["refreshToken", "userId"].some((field) => parsed[field] !== undefined && typeof parsed[field] !== "string")) {
+        throw malformed();
+    }
+    const session = parsed;
+    requireSecureUrl(session.managementUrl, `the \`managementUrl\` of ${path}`);
+    return session;
+}
+/** Writes the session owner-only and atomically, like the config file. */
+export function writeCredentialsFile(path, session) {
+    writeSecretFile(path, session);
+}
+/** Forgets the session. Does nothing when there is none. */
+export function removeCredentialsFile(path) {
+    rmSync(path, { force: true });
+}
+/** A token with less than this left is refreshed before the command runs. */
+const EXPIRY_MARGIN_MS = 30_000;
+/**
+ * `MEILI_MANAGEMENT_TOKEN`, then the session of `auth login`, with
+ * `MEILI_MANAGEMENT_URL` and its default. Fails before any network call when
+ * none exists. An access token that is about to expire is refreshed here, and
+ * the new one is written back.
+ */
+export async function resolveManagementCredentials(env, warn) {
+    const chosen = nonEmpty(env[ENV.MANAGEMENT_URL]);
+    const token = nonEmpty(env[ENV.MANAGEMENT_TOKEN]);
+    if (token !== undefined) {
+        if (chosen !== undefined)
+            requireSecureUrl(chosen, ENV.MANAGEMENT_URL);
+        return { token, url: chosen ?? DEFAULT_MANAGEMENT_URL };
+    }
+    const path = credentialsFilePath(env);
+    const session = readCredentialsFile(path, warn);
+    if (session === undefined) {
+        throw new MeiliCliError("cli_auth_missing", "No Management API credentials.", {
+            hint: "Run `meili auth login` to log in with a browser.",
+        });
+    }
+    if (chosen !== undefined && chosen !== session.managementUrl) {
+        throw new MeiliCliError("cli_config", `The session of \`meili auth login\` was issued by ${session.managementUrl}, but the Management API URL given is ${chosen}. A token is never sent to another Cloud.`, {
+            hint: "Run `meili auth login` with `MEILI_MANAGEMENT_URL` and `MEILI_MANAGEMENT_DASHBOARD_URL` naming that Cloud, or unset `MEILI_MANAGEMENT_URL`.",
+        });
+    }
+    const fresh = await ensureFreshSession(path, session);
+    return { token: fresh.accessToken, url: fresh.managementUrl };
+}
+/**
+ * The session, with a new access token when the stored one is spent. Writes the
+ * new pair back, so the next command finds it fresh.
+ */
+/**
+ * Trades the refresh token for a new pair and writes it back, so the next
+ * command finds it fresh. A server that answers without a new refresh token
+ * keeps the one we have, rather than losing the session (RFC 6749, section 6).
+ */
+export async function refreshSession(path, session) {
+    if (session.refreshToken === undefined) {
+        throw new MeiliCliError("cli_auth_failed", "The session carries no refresh token.", {
+            hint: "Run `meili auth login` to log in again.",
+        });
+    }
+    const tokens = await refreshAccessToken(session, session.refreshToken);
+    const refreshed = {
+        ...session,
+        ...tokens,
+        refreshToken: tokens.refreshToken ?? session.refreshToken,
+    };
+    writeCredentialsFile(path, refreshed);
+    return refreshed;
+}
+/** The session, refreshed only when its access token is spent. */
+export function ensureFreshSession(path, session) {
+    if (Date.parse(session.expiresAt) - Date.now() > EXPIRY_MARGIN_MS)
+        return Promise.resolve(session);
+    return refreshSession(path, session);
+}
+//# sourceMappingURL=session.js.map

package/dist/lib/session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.js","sourceRoot":"","sources":["../../src/lib/session.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAuC,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAC7F,OAAO,EACL,cAAc,EACd,4BAA4B,EAC5B,gCAAgC,EAChC,sBAAsB,EACtB,GAAG,EAEH,QAAQ,EACR,aAAa,EACb,eAAe,GAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAOtD;;;GAGG;AACH,SAAS,gBAAgB,CAAC,GAAW,EAAE,IAAY;IACjD,IAAI,MAAW,CAAC;IAChB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,GAAG,IAAI,kBAAkB,GAAG,EAAE,CAAC,CAAC;IACvE,CAAC;IACD,wFAAwF;IACxF,MAAM,QAAQ,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/E,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9C,MAAM,IAAI,aAAa,CACrB,WAAW,EACX,GAAG,IAAI,0CAA0C,GAAG,qCAAqC,CAC1F,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAQ;IACzC,kFAAkF;IAClF,iEAAiE;IACjE,MAAM,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;IACxD,MAAM,YAAY,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,CAAC;IACjE,IAAI,CAAC,aAAa,KAAK,SAAS,CAAC,KAAK,CAAC,YAAY,KAAK,SAAS,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,aAAa,CACrB,WAAW,EACX,sJAAsJ,CACvJ,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAG;QACb,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,IAAI,4BAA4B;QACjF,aAAa,EAAE,aAAa,IAAI,sBAAsB;QACtD,YAAY,EAAE,YAAY,IAAI,gCAAgC;KAC/D,CAAC;IACF,gBAAgB,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;IAC3D,gBAAgB,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,wBAAwB,CAAC,CAAC;IACpE,OAAO,MAAM,CAAC;AAChB,CAAC;AAWD,8EAA8E;AAC9E,MAAM,UAAU,mBAAmB,CAAC,GAAQ;IAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC;AAChE,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,mBAAmB,CACjC,IAAY,EACZ,IAAsC;IAEtC,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;IACtD,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACzC,MAAM,SAAS,GAAG,GAAkB,EAAE,CACpC,IAAI,aAAa,CACf,YAAY,EACZ,wBAAwB,IAAI,4CAA4C,EACxE,EAAE,IAAI,EAAE,2CAA2C,EAAE,CACtD,CAAC;IAEJ,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,SAAS,EAAE,CAAC;IACpB,CAAC;IACD,MAAM,MAAM,GAAG,CAAC,UAAU,EAAE,eAAe,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IAClG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;QACrF,MAAM,SAAS,EAAE,CAAC;IACpB,CAAC;IACD,IACE,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,IAAI,CAC7B,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,SAAS,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,CAC5E,EACD,CAAC;QACD,MAAM,SAAS,EAAE,CAAC;IACpB,CAAC;IACD,MAAM,OAAO,GAAG,MAA4B,CAAC;IAC7C,gBAAgB,CAAC,OAAO,CAAC,aAAa,EAAE,4BAA4B,IAAI,EAAE,CAAC,CAAC;IAC5E,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,oBAAoB,CAAC,IAAY,EAAE,OAAgB;IACjE,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACjC,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,qBAAqB,CAAC,IAAY;IAChD,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAChC,CAAC;AAED,6EAA6E;AAC7E,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,GAAQ,EACR,IAAsC;IAEtC,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAClD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,IAAI,MAAM,KAAK,SAAS;YAAE,gBAAgB,CAAC,MAAM,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;QACvE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,IAAI,sBAAsB,EAAE,CAAC;IAC1D,CAAC;IAED,MAAM,IAAI,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAChD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,IAAI,aAAa,CAAC,kBAAkB,EAAE,gCAAgC,EAAE;YAC5E,IAAI,EAAE,kDAAkD;SACzD,CAAC,CAAC;IACL,CAAC;IACD,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,OAAO,CAAC,aAAa,EAAE,CAAC;QAC7D,MAAM,IAAI,aAAa,CACrB,YAAY,EACZ,qDAAqD,OAAO,CAAC,aAAa,yCAAyC,MAAM,2CAA2C,EACpK;YACE,IAAI,EAAE,6IAA6I;SACpJ,CACF,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtD,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE,GAAG,EAAE,KAAK,CAAC,aAAa,EAAE,CAAC;AAChE,CAAC;AAED;;;GAGG;AACH;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,IAAY,EAAE,OAAgB;IACjE,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACvC,MAAM,IAAI,aAAa,CAAC,iBAAiB,EAAE,uCAAuC,EAAE;YAClF,IAAI,EAAE,yCAAyC;SAChD,CAAC,CAAC;IACL,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IACvE,MAAM,SAAS,GAAY;QACzB,GAAG,OAAO;QACV,GAAG,MAAM;QACT,YAAY,EAAE,MAAM,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY;KAC1D,CAAC;IACF,oBAAoB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACtC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,kBAAkB,CAAC,IAAY,EAAE,OAAgB;IAC/D,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,gBAAgB;QAC/D,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAClC,OAAO,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACvC,CAAC"}

package/dist/lib/task-filters.js

@@ -0,0 +1,118 @@
+/**
+ * The selectors the task queue routes share: `GET /tasks`, `POST /tasks/cancel`,
+ * `DELETE /tasks` and `GET /batches` take the same query parameters, so the
+ * four commands spread the same flags and build the same query. Only the two
+ * identifier flags differ: named by what they identify, bare `uids` are task
+ * uids everywhere, so `get tasks` reads them as `--ids` and the batches as
+ * `--batch-ids`, and `get batches` the other way round
+ * (docs/contract/commands.md, rule 5). The API spelling stays an alias.
+ */
+import { Flags } from "@oclif/core";
+/** The selectors of the four routes but the two identifier flags of the resource. */
+const queueFilterFlags = {
+    "index-ids": Flags.string({
+        aliases: ["index-uids"],
+        description: "Match the tasks of these indexes, comma-separated. `*` matches every one.",
+        helpValue: "<indexes>",
+    }),
+    "canceled-by": Flags.string({
+        description: "Match the tasks canceled by these taskCancelation uids, comma-separated. `*` matches every one.",
+        helpValue: "<uids>",
+    }),
+    types: Flags.string({
+        description: "Task types to match, comma-separated, as the `type` field of a task spells them, for example `documentAdditionOrUpdate`. `*` matches every one.",
+        helpValue: "<types>",
+    }),
+    statuses: Flags.string({
+        description: "Task statuses to match, comma-separated: enqueued, processing, succeeded, failed or canceled. `*` matches every one.",
+        helpValue: "<statuses>",
+    }),
+    "after-enqueued-at": Flags.string({
+        description: "Match the tasks enqueued after this date, in RFC 3339 format.",
+        helpValue: "<date>",
+    }),
+    "before-enqueued-at": Flags.string({
+        description: "Match the tasks enqueued before this date, in RFC 3339 format.",
+        helpValue: "<date>",
+    }),
+    "after-started-at": Flags.string({
+        description: "Match the tasks started after this date, in RFC 3339 format.",
+        helpValue: "<date>",
+    }),
+    "before-started-at": Flags.string({
+        description: "Match the tasks started before this date, in RFC 3339 format.",
+        helpValue: "<date>",
+    }),
+    "after-finished-at": Flags.string({
+        description: "Match the tasks finished after this date, in RFC 3339 format.",
+        helpValue: "<date>",
+    }),
+    "before-finished-at": Flags.string({
+        description: "Match the tasks finished before this date, in RFC 3339 format.",
+        helpValue: "<date>",
+    }),
+};
+export const taskFilterFlags = {
+    ids: Flags.string({
+        aliases: ["uids", "id"],
+        description: "Task uids to match, comma-separated. `*` matches every one.",
+        helpValue: "<uids>",
+    }),
+    "batch-ids": Flags.string({
+        aliases: ["batch-uids"],
+        description: "Match the tasks of these batch uids, comma-separated. `*` matches every one.",
+        helpValue: "<uids>",
+    }),
+    ...queueFilterFlags,
+};
+export const batchFilterFlags = {
+    ids: Flags.string({
+        aliases: ["batch-uids", "id"],
+        description: "Batch uids to match, comma-separated. `*` matches every one.",
+        helpValue: "<uids>",
+    }),
+    "task-ids": Flags.string({
+        aliases: ["uids"],
+        description: "Match the batches of these task uids, comma-separated. `*` matches every one.",
+        helpValue: "<uids>",
+    }),
+    ...queueFilterFlags,
+};
+/**
+ * The filters of the queue routes but the two identifier flags. The
+ * comma-separated list a flag carries is already the API's own GET syntax, so
+ * the text travels as it is: meilisearch-js types the identifier lists as
+ * arrays of numbers, which it joins back into the same request line, hence the
+ * cast of the two functions below.
+ */
+function queueFilterQuery(flags) {
+    return {
+        indexUids: flags["index-ids"],
+        canceledBy: flags["canceled-by"],
+        types: flags.types,
+        statuses: flags.statuses,
+        afterEnqueuedAt: flags["after-enqueued-at"],
+        beforeEnqueuedAt: flags["before-enqueued-at"],
+        afterStartedAt: flags["after-started-at"],
+        beforeStartedAt: flags["before-started-at"],
+        afterFinishedAt: flags["after-finished-at"],
+        beforeFinishedAt: flags["before-finished-at"],
+    };
+}
+/** The filters of a task route, read from the flags the three commands share. */
+export function taskFilterQuery(flags) {
+    return {
+        uids: flags.ids,
+        batchUids: flags["batch-ids"],
+        ...queueFilterQuery(flags),
+    };
+}
+/** The same filters for `GET /batches`, whose two identifier parameters are swapped. */
+export function batchFilterQuery(flags) {
+    return {
+        batchUids: flags.ids,
+        uids: flags["task-ids"],
+        ...queueFilterQuery(flags),
+    };
+}
+//# sourceMappingURL=task-filters.js.map

package/dist/lib/task-filters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"task-filters.js","sourceRoot":"","sources":["../../src/lib/task-filters.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,KAAK,EAAmB,MAAM,aAAa,CAAC;AAGrD,qFAAqF;AACrF,MAAM,gBAAgB,GAAG;IACvB,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;QACxB,OAAO,EAAE,CAAC,YAAY,CAAC;QACvB,WAAW,EAAE,2EAA2E;QACxF,SAAS,EAAE,WAAW;KACvB,CAAC;IACF,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC;QAC1B,WAAW,EACT,iGAAiG;QACnG,SAAS,EAAE,QAAQ;KACpB,CAAC;IACF,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;QAClB,WAAW,EACT,iJAAiJ;QACnJ,SAAS,EAAE,SAAS;KACrB,CAAC;IACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;QACrB,WAAW,EACT,sHAAsH;QACxH,SAAS,EAAE,YAAY;KACxB,CAAC;IACF,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC;QAChC,WAAW,EAAE,+DAA+D;QAC5E,SAAS,EAAE,QAAQ;KACpB,CAAC;IACF,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC;QACjC,WAAW,EAAE,gEAAgE;QAC7E,SAAS,EAAE,QAAQ;KACpB,CAAC;IACF,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC;QAC/B,WAAW,EAAE,8DAA8D;QAC3E,SAAS,EAAE,QAAQ;KACpB,CAAC;IACF,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC;QAChC,WAAW,EAAE,+DAA+D;QAC5E,SAAS,EAAE,QAAQ;KACpB,CAAC;IACF,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC;QAChC,WAAW,EAAE,+DAA+D;QAC5E,SAAS,EAAE,QAAQ;KACpB,CAAC;IACF,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC;QACjC,WAAW,EAAE,gEAAgE;QAC7E,SAAS,EAAE,QAAQ;KACpB,CAAC;CACH,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC;QAChB,OAAO,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC;QACvB,WAAW,EAAE,6DAA6D;QAC1E,SAAS,EAAE,QAAQ;KACpB,CAAC;IACF,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;QACxB,OAAO,EAAE,CAAC,YAAY,CAAC;QACvB,WAAW,EAAE,8EAA8E;QAC3F,SAAS,EAAE,QAAQ;KACpB,CAAC;IACF,GAAG,gBAAgB;CACpB,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC;QAChB,OAAO,EAAE,CAAC,YAAY,EAAE,IAAI,CAAC;QAC7B,WAAW,EAAE,8DAA8D;QAC3E,SAAS,EAAE,QAAQ;KACpB,CAAC;IACF,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC;QACvB,OAAO,EAAE,CAAC,MAAM,CAAC;QACjB,WAAW,EAAE,+EAA+E;QAC5F,SAAS,EAAE,QAAQ;KACpB,CAAC;IACF,GAAG,gBAAgB;CACpB,CAAC;AAKF;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAwD;IAChF,OAAO;QACL,SAAS,EAAE,KAAK,CAAC,WAAW,CAAC;QAC7B,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC;QAChC,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,eAAe,EAAE,KAAK,CAAC,mBAAmB,CAAC;QAC3C,gBAAgB,EAAE,KAAK,CAAC,oBAAoB,CAAC;QAC7C,cAAc,EAAE,KAAK,CAAC,kBAAkB,CAAC;QACzC,eAAe,EAAE,KAAK,CAAC,mBAAmB,CAAC;QAC3C,eAAe,EAAE,KAAK,CAAC,mBAAmB,CAAC;QAC3C,gBAAgB,EAAE,KAAK,CAAC,oBAAoB,CAAC;KAC9C,CAAC;AACJ,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,eAAe,CAAC,KAA2B;IACzD,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,GAAG;QACf,SAAS,EAAE,KAAK,CAAC,WAAW,CAAC;QAC7B,GAAG,gBAAgB,CAAC,KAAK,CAAC;KACC,CAAC;AAChC,CAAC;AAED,wFAAwF;AACxF,MAAM,UAAU,gBAAgB,CAAC,KAA4B;IAC3D,OAAO;QACL,SAAS,EAAE,KAAK,CAAC,GAAG;QACpB,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC;QACvB,GAAG,gBAAgB,CAAC,KAAK,CAAC;KACJ,CAAC;AAC3B,CAAC"}

package/dist/lib/tasks.js

@@ -0,0 +1,64 @@
+import { MeiliCliError } from "./errors.js";
+export const DEFAULT_TIMEOUT = "10m";
+const INITIAL_INTERVAL_MS = 100;
+const MAX_INTERVAL_MS = 1000;
+const FINAL_STATUSES = new Set(["succeeded", "failed", "canceled"]);
+const FAILURE_STATUSES = new Set(["failed", "canceled"]);
+export function isTaskFinal(task) {
+    return FINAL_STATUSES.has(task.status);
+}
+/** True when the task ended with `failed` or `canceled`: exit code 7. */
+export function isTaskFailure(task) {
+    return FAILURE_STATUSES.has(task.status);
+}
+const DURATION = /^(\d+(?:\.\d+)?)(ms|s|m|h)$/;
+const UNIT_MS = { ms: 1, s: 1000, m: 60_000, h: 3_600_000 };
+/** Parses `500ms`, `30s`, `2m` into milliseconds. */
+export function parseDuration(input) {
+    const match = input.trim().match(DURATION);
+    const unit = match?.[2];
+    if (match === null || match === undefined || unit === undefined) {
+        throw new MeiliCliError("cli_usage", `Invalid duration \`${input}\`. Use a number followed by ms, s, m or h, for example 500ms, 30s, 2m.`);
+    }
+    return Math.round(Number(match[1]) * UNIT_MS[unit]);
+}
+/** Renders milliseconds with the largest exact unit: 60000 is `1m`, 1500 is `1500ms`. */
+export function formatDuration(ms) {
+    if (ms % 60_000 === 0)
+        return `${ms / 60_000}m`;
+    if (ms % 1000 === 0)
+        return `${ms / 1000}s`;
+    return `${ms}ms`;
+}
+/**
+ * Calls `poll` until `isFinal` holds, with a delay between calls that doubles
+ * from `initialIntervalMs` to `maxIntervalMs`. Throws `timeoutError()` when
+ * the deadline passes.
+ */
+export async function pollUntil(poll, isFinal, timeoutError, options) {
+    const sleep = options.sleep ?? defaultSleep;
+    const deadline = Date.now() + options.timeoutMs;
+    let interval = options.initialIntervalMs ?? INITIAL_INTERVAL_MS;
+    for (;;) {
+        const current = await poll();
+        if (isFinal(current))
+            return current;
+        options.onProgress?.(current);
+        const remaining = deadline - Date.now();
+        if (remaining <= 0)
+            throw timeoutError();
+        await sleep(Math.min(interval, remaining));
+        interval = Math.min(interval * 2, options.maxIntervalMs ?? MAX_INTERVAL_MS);
+    }
+}
+/**
+ * Polls `GET /tasks/{uid}` until `succeeded`, `failed` or `canceled`. Throws
+ * `cli_timeout` when the deadline passes; the task keeps running on the server.
+ */
+export function waitForTask(client, uid, options) {
+    return pollUntil(() => client.tasks.getTask(uid), isTaskFinal, () => new MeiliCliError("cli_timeout", `Task ${uid} did not reach a final status within ${formatDuration(options.timeoutMs)}. It keeps running on the server.`, { hint: `Run \`meili get tasks --ids ${uid}\` to check its status.` }), options);
+}
+function defaultSleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+//# sourceMappingURL=tasks.js.map

package/dist/lib/tasks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tasks.js","sourceRoot":"","sources":["../../src/lib/tasks.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,CAAC;AAErC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAChC,MAAM,eAAe,GAAG,IAAI,CAAC;AAE7B,MAAM,cAAc,GAAwB,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;AACzF,MAAM,gBAAgB,GAAwB,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;AAE9E,MAAM,UAAU,WAAW,CAAC,IAA0B;IACpD,OAAO,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACzC,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,aAAa,CAAC,IAA0B;IACtD,OAAO,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,QAAQ,GAAG,6BAA6B,CAAC;AAC/C,MAAM,OAAO,GAAG,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAW,CAAC;AAErE,qDAAqD;AACrD,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC3C,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC,CAAC,CAAqC,CAAC;IAC5D,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QAChE,MAAM,IAAI,aAAa,CACrB,WAAW,EACX,sBAAsB,KAAK,yEAAyE,CACrG,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AACtD,CAAC;AAED,yFAAyF;AACzF,MAAM,UAAU,cAAc,CAAC,EAAU;IACvC,IAAI,EAAE,GAAG,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,EAAE,GAAG,MAAM,GAAG,CAAC;IAChD,IAAI,EAAE,GAAG,IAAI,KAAK,CAAC;QAAE,OAAO,GAAG,EAAE,GAAG,IAAI,GAAG,CAAC;IAC5C,OAAO,GAAG,EAAE,IAAI,CAAC;AACnB,CAAC;AAaD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,IAAsB,EACtB,OAAgC,EAChC,YAAiC,EACjC,OAAuB;IAEvB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,YAAY,CAAC;IAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC;IAChD,IAAI,QAAQ,GAAG,OAAO,CAAC,iBAAiB,IAAI,mBAAmB,CAAC;IAChE,SAAS,CAAC;QACR,MAAM,OAAO,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7B,IAAI,OAAO,CAAC,OAAO,CAAC;YAAE,OAAO,OAAO,CAAC;QACrC,OAAO,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,CAAC;QAC9B,MAAM,SAAS,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACxC,IAAI,SAAS,IAAI,CAAC;YAAE,MAAM,YAAY,EAAE,CAAC;QACzC,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;QAC3C,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,EAAE,OAAO,CAAC,aAAa,IAAI,eAAe,CAAC,CAAC;IAC9E,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CACzB,MAAmB,EACnB,GAAW,EACX,OAA0B;IAE1B,OAAO,SAAS,CACd,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAC/B,WAAW,EACX,GAAG,EAAE,CACH,IAAI,aAAa,CACf,aAAa,EACb,QAAQ,GAAG,wCAAwC,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,mCAAmC,EACvH,EAAE,IAAI,EAAE,+BAA+B,GAAG,yBAAyB,EAAE,CACtE,EACH,OAAO,CACR,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,EAAU;IAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC"}