@meilisearch/cli 0.0.0-stage → 0.1.0

package/dist/commands/update/keys.js

@@ -0,0 +1,42 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+import { readBodyWithFields } from "../../lib/input.js";
+import { asText } from "../../lib/values.js";
+export default class UpdateKeys extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["PATCH /keys/{key}"];
+    static keyActions = ["keys.update"];
+    static description = "Change the name or the description of an API key, the two fields the route takes, and reset one with the value null.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod --id 52787ccd-48ff-48e5-9c4b-03cd76978a60 --name 'CI indexer'",
+        "<%= config.bin %> <%= command.id %> --project prod --id 52787ccd-48ff-48e5-9c4b-03cd76978a60 --description 'Indexes the catalog nightly' --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --id 52787ccd-48ff-48e5-9c4b-03cd76978a60 --description null",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        id: Flags.string({
+            required: true,
+            description: "The key to update, by its uid or by its key value.",
+            helpValue: "<key>",
+        }),
+        name: Flags.string({
+            description: "New name of the key. The value null removes the one it has.",
+            helpValue: "<name>",
+        }),
+        description: Flags.string({
+            description: "New description of the key. The value null removes the one it has.",
+            helpValue: "<text>",
+        }),
+        ...BaseCommand.bodyInputFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(UpdateKeys);
+        const fromFlags = {
+            name: asText(flags.name),
+            description: asText(flags.description),
+        };
+        const update = readBodyWithFields(flags, fromFlags);
+        await this.output(await this.meilisearch.updateKey(flags.id, update));
+    }
+}
+//# sourceMappingURL=keys.js.map

package/dist/commands/update/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../../../src/commands/update/keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,WAAW;IACjD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAEtC,MAAM,CAAC,UAAU,GAAG,CAAC,aAAa,CAAC,CAAC;IAEpC,MAAM,CAAU,WAAW,GACzB,sHAAsH,CAAC;IAEzH,MAAM,CAAU,QAAQ,GAAG;QACzB,kHAAkH;QAClH,wJAAwJ;QACxJ,iHAAiH;KAClH,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,oDAAoD;YACjE,SAAS,EAAE,OAAO;SACnB,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,WAAW,EAAE,6DAA6D;YAC1E,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;YACxB,WAAW,EAAE,oEAAoE;YACjF,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;KAC9B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,SAAS,GAA4B;YACzC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;YACxB,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;SACvC,CAAC;QACF,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAc,CAAC;QACjE,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;IACxE,CAAC;CACF"}

package/dist/commands/update/projects.js

@@ -0,0 +1,62 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+import { patchApiV2ProjectsById } from "../../lib/clients/management/generated/sdk.gen.js";
+import { cloudOf, readTeamNames } from "../../lib/cloud-sync.js";
+import { assertNoProject, cloudProjectEntry, writeConfigFile, } from "../../lib/config.js";
+import { MeiliCliError } from "../../lib/errors.js";
+import { readBodyWithFields } from "../../lib/input.js";
+export default class UpdateProjects extends BaseCommand {
+    static api = "management";
+    static routes = ["PATCH /api/v2/projects/{id}"];
+    static description = "Rename a Meilisearch Cloud project.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --id 343 --name renamed",
+        "<%= config.bin %> <%= command.id %> --id 343 --name renamed --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --name renamed",
+        "<%= config.bin %> <%= command.id %> --project prod --name renamed --sync-config",
+        '<%= config.bin %> <%= command.id %> --id 343 --data \'{"name":"renamed"}\'',
+    ];
+    static flags = {
+        ...BaseCommand.cloudProjectFlags,
+        id: Flags.integer({
+            description: "The project to update, or give --project <name> and its cloud.id from the config file.",
+            helpValue: "<id>",
+        }),
+        name: Flags.string({ description: "New name of the project.", helpValue: "<name>" }),
+        "sync-config": Flags.boolean({
+            description: "Rename the project's entry of the config file after it: the entry --project names, or the one whose cloud.id is --id. Refreshes its cloud identifiers.",
+        }),
+        ...BaseCommand.bodyInputFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(UpdateProjects);
+        const id = this.cloudProjectId(flags.id);
+        const body = readBodyWithFields(flags, { name: flags.name });
+        // The entry takes the name checked here, whatever name the API answers.
+        let sync;
+        if (flags["sync-config"]) {
+            if (typeof body.name !== "string" || body.name === "") {
+                throw new MeiliCliError("cli_usage", "`--sync-config` renames the entry after the project: give `--name`.");
+            }
+            const file = this.configFile();
+            const entry = cloudProjectEntry(file, flags.project, id, ": nothing was renamed.");
+            if (body.name !== entry)
+                assertNoProject(file, body.name, ": nothing was renamed.");
+            sync = { file, entry, name: body.name };
+        }
+        const project = await patchApiV2ProjectsById({
+            client: this.managementClient,
+            path: { id },
+            body,
+        });
+        await this.output(project);
+        if (sync === undefined)
+            return;
+        const cloud = cloudOf(project, await readTeamNames(this.managementClient));
+        writeConfigFile({
+            path: sync.file.path,
+            projects: Object.fromEntries(Object.entries(sync.file.projects).map(([name, entry]) => name === sync.entry ? [sync.name, { ...entry, cloud }] : [name, entry])),
+        });
+    }
+}
+//# sourceMappingURL=projects.js.map

package/dist/commands/update/projects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projects.js","sourceRoot":"","sources":["../../../src/commands/update/projects.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mDAAmD,CAAC;AAE3F,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EACL,eAAe,EAEf,iBAAiB,EACjB,eAAe,GAChB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,WAAW;IACrD,MAAM,CAAC,GAAG,GAAQ,YAAY,CAAC;IAE/B,MAAM,CAAC,MAAM,GAAG,CAAC,6BAA6B,CAAC,CAAC;IAEhD,MAAM,CAAU,WAAW,GAAG,qCAAqC,CAAC;IAEpE,MAAM,CAAU,QAAQ,GAAG;QACzB,6DAA6D;QAC7D,2EAA2E;QAC3E,mEAAmE;QACnE,iFAAiF;QACjF,4EAA4E;KAC7E,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,iBAAiB;QAChC,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC;YAChB,WAAW,EACT,wFAAwF;YAC1F,SAAS,EAAE,MAAM;SAClB,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,0BAA0B,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;QACpF,aAAa,EAAE,KAAK,CAAC,OAAO,CAAC;YAC3B,WAAW,EACT,wJAAwJ;SAC3J,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;KAC9B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACnD,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzC,MAAM,IAAI,GAAG,kBAAkB,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAE1D,CAAC;QAEF,wEAAwE;QACxE,IAAI,IAAmE,CAAC;QACxE,IAAI,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;YACzB,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,EAAE,CAAC;gBACtD,MAAM,IAAI,aAAa,CACrB,WAAW,EACX,qEAAqE,CACtE,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,EAAE,wBAAwB,CAAC,CAAC;YACnF,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK;gBAAE,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;YACpF,IAAI,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QAC1C,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,sBAAsB,CAAC;YAC3C,MAAM,EAAE,IAAI,CAAC,gBAAgB;YAC7B,IAAI,EAAE,EAAE,EAAE,EAAE;YACZ,IAAI;SACL,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC3B,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO;QAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,MAAM,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAC3E,eAAe,CAAC;YACd,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;YACpB,QAAQ,EAAE,MAAM,CAAC,WAAW,CAC1B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CACvD,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CACvE,CACF;SACF,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/commands/update/settings.js

@@ -0,0 +1,145 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+import { readBodyWithFields } from "../../lib/input.js";
+import { asJson, asList, asNumber, asText } from "../../lib/values.js";
+export default class UpdateSettings extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["PATCH /indexes/{index_uid}/settings"];
+    static keyActions = ["settings.update"];
+    static description = "Change the settings given, leave the others as they are, and reset one with the value null.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --searchable-attributes title,overview",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --filterable-attributes genres,release_date --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --stop-words null",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --typo-tolerance '{\"enabled\":false}' --wait",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --file settings.json",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        index: Flags.string({
+            required: true,
+            description: "The index to update the settings of.",
+            helpValue: "<index>",
+        }),
+        "displayed-attributes": Flags.string({
+            description: "Fields returned in search results, comma-separated.",
+            helpValue: "<fields>",
+        }),
+        "searchable-attributes": Flags.string({
+            description: "Fields searched for query words, comma-separated, in order of importance for the ranking.",
+            helpValue: "<fields>",
+        }),
+        "filterable-attributes": Flags.string({
+            description: "Attributes usable as filters and facets, comma-separated. Their rule form goes through --data.",
+            helpValue: "<fields>",
+        }),
+        "sortable-attributes": Flags.string({
+            description: "Attributes usable to sort the search results, comma-separated.",
+            helpValue: "<fields>",
+        }),
+        "foreign-keys": Flags.string({
+            description: 'Foreign keys for cross-index filtering, as JSON: `[{"foreignIndexUid":"products","fieldName":"productId"}]`.',
+            helpValue: "<json>",
+        }),
+        "ranking-rules": Flags.string({
+            description: "Ranking rules in order of importance, comma-separated, built-in or `attribute:asc` and `:desc`.",
+            helpValue: "<rules>",
+        }),
+        "stop-words": Flags.string({
+            description: "Words ignored when they appear in a search query, comma-separated.",
+            helpValue: "<words>",
+        }),
+        "non-separator-tokens": Flags.string({
+            description: "Characters removed from the default separators, comma-separated, so that they no longer split words.",
+            helpValue: "<tokens>",
+        }),
+        "separator-tokens": Flags.string({
+            description: "Characters added to the default separators, comma-separated.",
+            helpValue: "<tokens>",
+        }),
+        dictionary: Flags.string({
+            description: "Strings parsed as a single term, comma-separated, such as names.",
+            helpValue: "<words>",
+        }),
+        synonyms: Flags.string({
+            description: 'Words treated as equivalent, as JSON: `{"phone":["iPhone"]}`.',
+            helpValue: "<json>",
+        }),
+        "distinct-attribute": Flags.string({
+            description: "Field whose value must be unique in the returned documents.",
+            helpValue: "<attribute>",
+        }),
+        "proximity-precision": Flags.string({
+            description: "Precision of the proximity ranking rule, `byWord` or `byAttribute`, which indexes faster.",
+            helpValue: "<precision>",
+        }),
+        "typo-tolerance": Flags.string({
+            description: 'Typo tolerance as JSON, for example `{"enabled":false}`.',
+            helpValue: "<json>",
+        }),
+        faceting: Flags.string({
+            description: 'Faceting as JSON, for example `{"maxValuesPerFacet":200}`.',
+            helpValue: "<json>",
+        }),
+        pagination: Flags.string({
+            description: 'Pagination as JSON, for example `{"maxTotalHits":2000}`.',
+            helpValue: "<json>",
+        }),
+        embedders: Flags.string({
+            description: 'Embedders as JSON, a map of name to configuration: `{"default":{"source":"openAi"}}`.',
+            helpValue: "<json>",
+        }),
+        "search-cutoff-ms": Flags.string({
+            description: "Maximum duration of a search in milliseconds, 1500 when it is null.",
+            helpValue: "<ms>",
+        }),
+        "localized-attributes": Flags.string({
+            description: 'Locales of the attributes, as JSON: `[{"locales":["jpn"],"attributePatterns":["*_ja"]}]`.',
+            helpValue: "<json>",
+        }),
+        "facet-search": Flags.string({
+            description: "Whether the facet-search route is enabled on this index, `true` or `false`.",
+            helpValue: "<boolean>",
+        }),
+        "prefix-search": Flags.string({
+            description: "When prefix matches are computed, `indexingTime` or `disabled`, which indexes faster.",
+            helpValue: "<mode>",
+        }),
+        chat: Flags.string({
+            description: 'Chat settings as JSON, for example `{"description":"A movie database"}`, which the LLM reads.',
+            helpValue: "<json>",
+        }),
+        ...BaseCommand.bodyInputFlags,
+        ...BaseCommand.waitFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(UpdateSettings);
+        const fromFlags = {
+            displayedAttributes: asList(flags["displayed-attributes"]),
+            searchableAttributes: asList(flags["searchable-attributes"]),
+            filterableAttributes: asList(flags["filterable-attributes"]),
+            sortableAttributes: asList(flags["sortable-attributes"]),
+            foreignKeys: asJson(flags["foreign-keys"]),
+            rankingRules: asList(flags["ranking-rules"]),
+            stopWords: asList(flags["stop-words"]),
+            nonSeparatorTokens: asList(flags["non-separator-tokens"]),
+            separatorTokens: asList(flags["separator-tokens"]),
+            dictionary: asList(flags.dictionary),
+            synonyms: asJson(flags.synonyms),
+            distinctAttribute: asText(flags["distinct-attribute"]),
+            proximityPrecision: asText(flags["proximity-precision"]),
+            typoTolerance: asJson(flags["typo-tolerance"]),
+            faceting: asJson(flags.faceting),
+            pagination: asJson(flags.pagination),
+            embedders: asJson(flags.embedders),
+            searchCutoffMs: asNumber(flags["search-cutoff-ms"]),
+            localizedAttributes: asJson(flags["localized-attributes"]),
+            facetSearch: asJson(flags["facet-search"]),
+            prefixSearch: asText(flags["prefix-search"]),
+            chat: asJson(flags.chat),
+        };
+        const settings = readBodyWithFields(flags, fromFlags);
+        await this.outputTask(await this.meilisearch.index(flags.index).updateSettings(settings), flags);
+    }
+}
+//# sourceMappingURL=settings.js.map

package/dist/commands/update/settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../../src/commands/update/settings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAEvE,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,WAAW;IACrD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,qCAAqC,CAAC,CAAC;IAExD,MAAM,CAAC,UAAU,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAExC,MAAM,CAAU,WAAW,GACzB,6FAA6F,CAAC;IAEhG,MAAM,CAAU,QAAQ,GAAG;QACzB,0GAA0G;QAC1G,6HAA6H;QAC7H,qFAAqF;QACrF,iHAAiH;QACjH,wFAAwF;KACzF,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,sCAAsC;YACnD,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,sBAAsB,EAAE,KAAK,CAAC,MAAM,CAAC;YACnC,WAAW,EAAE,qDAAqD;YAClE,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,uBAAuB,EAAE,KAAK,CAAC,MAAM,CAAC;YACpC,WAAW,EACT,2FAA2F;YAC7F,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,uBAAuB,EAAE,KAAK,CAAC,MAAM,CAAC;YACpC,WAAW,EACT,gGAAgG;YAClG,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,qBAAqB,EAAE,KAAK,CAAC,MAAM,CAAC;YAClC,WAAW,EAAE,gEAAgE;YAC7E,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC;YAC3B,WAAW,EACT,8GAA8G;YAChH,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC;YAC5B,WAAW,EACT,iGAAiG;YACnG,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC;YACzB,WAAW,EAAE,oEAAoE;YACjF,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,sBAAsB,EAAE,KAAK,CAAC,MAAM,CAAC;YACnC,WAAW,EACT,sGAAsG;YACxG,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC;YAC/B,WAAW,EAAE,8DAA8D;YAC3E,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC;YACvB,WAAW,EAAE,kEAAkE;YAC/E,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,WAAW,EAAE,+DAA+D;YAC5E,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC;YACjC,WAAW,EAAE,6DAA6D;YAC1E,SAAS,EAAE,aAAa;SACzB,CAAC;QACF,qBAAqB,EAAE,KAAK,CAAC,MAAM,CAAC;YAClC,WAAW,EACT,2FAA2F;YAC7F,SAAS,EAAE,aAAa;SACzB,CAAC;QACF,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC;YAC7B,WAAW,EAAE,0DAA0D;YACvE,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,WAAW,EAAE,4DAA4D;YACzE,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC;YACvB,WAAW,EAAE,0DAA0D;YACvE,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC;YACtB,WAAW,EACT,uFAAuF;YACzF,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC;YAC/B,WAAW,EAAE,qEAAqE;YAClF,SAAS,EAAE,MAAM;SAClB,CAAC;QACF,sBAAsB,EAAE,KAAK,CAAC,MAAM,CAAC;YACnC,WAAW,EACT,2FAA2F;YAC7F,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC;YAC3B,WAAW,EAAE,6EAA6E;YAC1F,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC;YAC5B,WAAW,EACT,uFAAuF;YACzF,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,WAAW,EACT,+FAA+F;YACjG,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;QAC7B,GAAG,WAAW,CAAC,SAAS;KACzB,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACnD,MAAM,SAAS,GAA4B;YACzC,mBAAmB,EAAE,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAC1D,oBAAoB,EAAE,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC5D,oBAAoB,EAAE,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC5D,kBAAkB,EAAE,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACxD,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YAC1C,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;YAC5C,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACtC,kBAAkB,EAAE,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;YACzD,eAAe,EAAE,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YAClD,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;YACpC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;YAChC,iBAAiB,EAAE,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;YACtD,kBAAkB,EAAE,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACxD,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;YAC9C,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;YAChC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;YACpC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;YAClC,cAAc,EAAE,QAAQ,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACnD,mBAAmB,EAAE,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAC1D,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YAC1C,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;YAC5C,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;SACzB,CAAC;QAEF,MAAM,QAAQ,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAa,CAAC;QAElE,MAAM,IAAI,CAAC,UAAU,CACnB,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,EAClE,KAAK,CACN,CAAC;IACJ,CAAC;CACF"}

package/dist/lib/analytics.js

@@ -0,0 +1,135 @@
+/**
+ * Anonymous usage analytics (ADR 0016): when nothing is sent, the anonymous id,
+ * and the events a command collects while it runs. `BaseCommand` sends them
+ * when the command ends, through `clients/analytics.ts`.
+ */
+import { randomUUID } from "node:crypto";
+import { readFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { sendEvents } from "./clients/analytics.js";
+import { configFilePath, DEFAULT_MANAGEMENT_URL, ENV, nonEmpty, writeSecretFile, } from "./config.js";
+import { isRecord, writeNotice } from "./errors.js";
+import { credentialsFilePath, readCredentialsFile } from "./session.js";
+const NOTICE = "meili sends anonymous usage data to Meilisearch: the commands you run, the names of their flags, and their errors. Never the values of the flags, your data or your keys. To turn it off, set MEILI_NO_ANALYTICS=true.";
+const collected = [];
+/** Adds an event to the ones the command sends when it ends. */
+export function track(event, properties) {
+    collected.push({ event, properties, timestamp: new Date().toISOString() });
+}
+const isOn = (value) => value === "1" || value?.toLowerCase() === "true";
+/**
+ * Off when the human asks, in CI, and against a Cloud other than Meilisearch
+ * Cloud, whose users do not belong in its PostHog project.
+ */
+function enabled(env) {
+    const managementUrl = nonEmpty(env[ENV.MANAGEMENT_URL]);
+    return !(isOn(env[ENV.NO_ANALYTICS]) ||
+        isOn(env.DO_NOT_TRACK) ||
+        env.CI !== undefined ||
+        (managementUrl !== undefined && managementUrl !== DEFAULT_MANAGEMENT_URL));
+}
+const analyticsFilePath = (env) => join(dirname(configFilePath(env)), "analytics.json");
+/**
+ * The id of `analytics.json`, next to the config file. The first time, the
+ * file is written and the notice shown. When the file cannot be written, each
+ * process has its own id, and the notice is not repeated on every command.
+ */
+function anonymousId(env) {
+    const path = analyticsFilePath(env);
+    try {
+        const parsed = JSON.parse(readFileSync(path, "utf8"));
+        if (isRecord(parsed) && typeof parsed.anonymousId === "string")
+            return parsed.anonymousId;
+    }
+    catch {
+        // No file yet, or not ours: a new id replaces it.
+    }
+    const id = randomUUID();
+    try {
+        writeSecretFile(path, { anonymousId: id });
+        writeNotice(NOTICE);
+    }
+    catch {
+        // A read-only mount, for example.
+    }
+    return id;
+}
+/** The Cloud user of the session of `auth login`, if any. */
+function sessionUserId(env) {
+    try {
+        return readCredentialsFile(credentialsFilePath(env), () => { })?.userId;
+    }
+    catch {
+        // A malformed file: the next management command says so.
+        return undefined;
+    }
+}
+/**
+ * After a login, when usage data is sent: the id of the Cloud user, to store
+ * in the session, and one `$identify` that joins the anonymous id to it.
+ * Undefined when nothing is sent or `fetchUserId` fails: the CLI stays anonymous.
+ */
+export async function identify(env, fetchUserId) {
+    if (!enabled(env))
+        return undefined;
+    let userId;
+    try {
+        userId = await fetchUserId();
+    }
+    catch {
+        return undefined;
+    }
+    track("$identify", { $anon_distinct_id: anonymousId(env) });
+    return userId;
+}
+/** After a logout: a new anonymous id, so the next person on the machine is not joined to the previous one. */
+export function resetAnonymousId(env) {
+    if (!enabled(env))
+        return;
+    try {
+        writeSecretFile(analyticsFilePath(env), { anonymousId: randomUUID() });
+    }
+    catch {
+        // A read-only mount, for example.
+    }
+}
+/** Sends the events the command collected, each with `common`, then forgets them. */
+export async function sendAnalytics(env, common) {
+    const events = collected.splice(0);
+    if (!enabled(env))
+        return;
+    const userId = sessionUserId(env);
+    const distinctId = userId ?? anonymousId(env);
+    const properties = {
+        ...common,
+        site: "cli",
+        os: process.platform,
+        arch: process.arch,
+        node_version: process.versions.node,
+        tty: process.stdin.isTTY === true && process.stderr.isTTY === true,
+        $lib: "meili-cli",
+        ...(userId === undefined && { $process_person_profile: false }),
+    };
+    await sendEvents(events.map((event) => ({
+        ...event,
+        distinct_id: distinctId,
+        properties: { ...properties, ...event.properties },
+    })));
+}
+/**
+ * The names of the flags on the command line, never their values. Only the
+ * names the command declares: an argument that only looks like a flag is a value.
+ */
+export function flagNames(argv, flags) {
+    const known = new Map();
+    for (const [name, flag] of Object.entries(flags)) {
+        known.set(`--${name}`, name);
+        if (flag.char !== undefined)
+            known.set(`-${flag.char}`, name);
+        if (flag.allowNo === true)
+            known.set(`--no-${name}`, `no-${name}`);
+    }
+    const names = argv.flatMap((arg) => known.get(arg.split("=")[0] ?? "") ?? []);
+    return [...new Set(names)];
+}
+//# sourceMappingURL=analytics.js.map

package/dist/lib/analytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../src/lib/analytics.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAuB,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,GAAG,EAEH,QAAQ,EACR,eAAe,GAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAExE,MAAM,MAAM,GACV,wNAAwN,CAAC;AAE3N,MAAM,SAAS,GAA+C,EAAE,CAAC;AAEjE,gEAAgE;AAChE,MAAM,UAAU,KAAK,CAAC,KAAa,EAAE,UAAmC;IACtE,SAAS,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AAC7E,CAAC;AAED,MAAM,IAAI,GAAG,CAAC,KAAyB,EAAW,EAAE,CAClD,KAAK,KAAK,GAAG,IAAI,KAAK,EAAE,WAAW,EAAE,KAAK,MAAM,CAAC;AAEnD;;;GAGG;AACH,SAAS,OAAO,CAAC,GAAQ;IACvB,MAAM,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;IACxD,OAAO,CAAC,CACN,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC3B,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC;QACtB,GAAG,CAAC,EAAE,KAAK,SAAS;QACpB,CAAC,aAAa,KAAK,SAAS,IAAI,aAAa,KAAK,sBAAsB,CAAC,CAC1E,CAAC;AACJ,CAAC;AAED,MAAM,iBAAiB,GAAG,CAAC,GAAQ,EAAU,EAAE,CAC7C,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;AAEvD;;;;GAIG;AACH,SAAS,WAAW,CAAC,GAAQ;IAC3B,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QAC/D,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ;YAAE,OAAO,MAAM,CAAC,WAAW,CAAC;IAC5F,CAAC;IAAC,MAAM,CAAC;QACP,kDAAkD;IACpD,CAAC;IACD,MAAM,EAAE,GAAG,UAAU,EAAE,CAAC;IACxB,IAAI,CAAC;QACH,eAAe,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QAC3C,WAAW,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IAAC,MAAM,CAAC;QACP,kCAAkC;IACpC,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,6DAA6D;AAC7D,SAAS,aAAa,CAAC,GAAQ;IAC7B,IAAI,CAAC;QACH,OAAO,mBAAmB,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,EAAE,MAAM,CAAC;IACzE,CAAC;IAAC,MAAM,CAAC;QACP,yDAAyD;QACzD,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,GAAQ,EACR,WAAkC;IAElC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IACpC,IAAI,MAAc,CAAC;IACnB,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,WAAW,EAAE,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,KAAK,CAAC,WAAW,EAAE,EAAE,iBAAiB,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC5D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,+GAA+G;AAC/G,MAAM,UAAU,gBAAgB,CAAC,GAAQ;IACvC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,OAAO;IAC1B,IAAI,CAAC;QACH,eAAe,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;IACzE,CAAC;IAAC,MAAM,CAAC;QACP,kCAAkC;IACpC,CAAC;AACH,CAAC;AAED,qFAAqF;AACrF,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAQ,EAAE,MAA+B;IAC3E,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACnC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,OAAO;IAC1B,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,UAAU,GAAG,MAAM,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC;IAC9C,MAAM,UAAU,GAAG;QACjB,GAAG,MAAM;QACT,IAAI,EAAE,KAAK;QACX,EAAE,EAAE,OAAO,CAAC,QAAQ;QACpB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,YAAY,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;QACnC,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI;QAClE,IAAI,EAAE,WAAW;QACjB,GAAG,CAAC,MAAM,KAAK,SAAS,IAAI,EAAE,uBAAuB,EAAE,KAAK,EAAE,CAAC;KAChE,CAAC;IACF,MAAM,UAAU,CACd,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACrB,GAAG,KAAK;QACR,WAAW,EAAE,UAAU;QACvB,UAAU,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,KAAK,CAAC,UAAU,EAAE;KACnD,CAAC,CAAC,CACJ,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CACvB,IAAuB,EACvB,KAA2D;IAE3D,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,KAAK,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;QAC7B,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;QAC9D,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI;YAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;IACrE,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;IAC9E,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7B,CAAC"}