@meilisearch/cli 0.0.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -11
- package/dist/commands/auth/login.js +5 -4
- package/dist/commands/auth/login.js.map +1 -1
- package/dist/commands/auth/logout.js +9 -6
- package/dist/commands/auth/logout.js.map +1 -1
- package/dist/commands/auth/refresh.js +4 -5
- package/dist/commands/auth/refresh.js.map +1 -1
- package/dist/commands/auth/status.js +6 -6
- package/dist/commands/auth/status.js.map +1 -1
- package/dist/commands/{get/batches.js → batch/list.js} +6 -6
- package/dist/commands/batch/list.js.map +1 -0
- package/dist/commands/batch/view.js +18 -0
- package/dist/commands/batch/view.js.map +1 -0
- package/dist/commands/config/list.js +3 -2
- package/dist/commands/config/list.js.map +1 -1
- package/dist/commands/config/set.js +3 -4
- package/dist/commands/config/set.js.map +1 -1
- package/dist/commands/config/sync-with-cloud.js +5 -5
- package/dist/commands/config/sync-with-cloud.js.map +1 -1
- package/dist/commands/config/unset.js +3 -8
- package/dist/commands/config/unset.js.map +1 -1
- package/dist/commands/config/update.js +4 -4
- package/dist/commands/config/update.js.map +1 -1
- package/dist/commands/{add/documents.js → document/add.js} +6 -5
- package/dist/commands/document/add.js.map +1 -0
- package/dist/commands/{delete/documents.js → document/delete.js} +7 -6
- package/dist/commands/document/delete.js.map +1 -0
- package/dist/commands/{get/documents.js → document/list.js} +7 -8
- package/dist/commands/document/list.js.map +1 -0
- package/dist/commands/{update/documents.js → document/update.js} +6 -5
- package/dist/commands/document/update.js.map +1 -0
- package/dist/commands/document/view.js +42 -0
- package/dist/commands/document/view.js.map +1 -0
- package/dist/commands/export.js +3 -2
- package/dist/commands/export.js.map +1 -1
- package/dist/commands/facet-search.js +3 -2
- package/dist/commands/facet-search.js.map +1 -1
- package/dist/commands/{get/health.js → health.js} +3 -4
- package/dist/commands/health.js.map +1 -0
- package/dist/commands/{add/indexes.js → index/add.js} +7 -5
- package/dist/commands/index/add.js.map +1 -0
- package/dist/commands/{delete/indexes.js → index/delete.js} +6 -5
- package/dist/commands/index/delete.js.map +1 -0
- package/dist/commands/index/list.js +21 -0
- package/dist/commands/index/list.js.map +1 -0
- package/dist/commands/{update/indexes.js → index/update.js} +6 -5
- package/dist/commands/index/update.js.map +1 -0
- package/dist/commands/index/view.js +18 -0
- package/dist/commands/index/view.js.map +1 -0
- package/dist/commands/info.js +15 -0
- package/dist/commands/info.js.map +1 -0
- package/dist/commands/{add/keys.js → key/add.js} +9 -7
- package/dist/commands/key/add.js.map +1 -0
- package/dist/commands/{delete/keys.js → key/delete.js} +6 -5
- package/dist/commands/key/delete.js.map +1 -0
- package/dist/commands/key/list.js +24 -0
- package/dist/commands/key/list.js.map +1 -0
- package/dist/commands/{update/keys.js → key/update.js} +7 -5
- package/dist/commands/key/update.js.map +1 -0
- package/dist/commands/key/view.js +26 -0
- package/dist/commands/key/view.js.map +1 -0
- package/dist/commands/multi-search.js +4 -2
- package/dist/commands/multi-search.js.map +1 -1
- package/dist/commands/organization/delete.js +24 -0
- package/dist/commands/organization/delete.js.map +1 -0
- package/dist/commands/organization/list.js +15 -0
- package/dist/commands/organization/list.js.map +1 -0
- package/dist/commands/organization/update.js +32 -0
- package/dist/commands/organization/update.js.map +1 -0
- package/dist/commands/organization/view.js +21 -0
- package/dist/commands/organization/view.js.map +1 -0
- package/dist/commands/{add/projects.js → project/add.js} +7 -6
- package/dist/commands/project/add.js.map +1 -0
- package/dist/commands/{delete/projects.js → project/delete.js} +6 -5
- package/dist/commands/project/delete.js.map +1 -0
- package/dist/commands/project/list.js +28 -0
- package/dist/commands/project/list.js.map +1 -0
- package/dist/commands/{update/projects.js → project/update.js} +3 -4
- package/dist/commands/project/update.js.map +1 -0
- package/dist/commands/project/view.js +29 -0
- package/dist/commands/project/view.js.map +1 -0
- package/dist/commands/region/list.js +15 -0
- package/dist/commands/region/list.js.map +1 -0
- package/dist/commands/resource/list.js +28 -0
- package/dist/commands/resource/list.js.map +1 -0
- package/dist/commands/schema.js +4 -3
- package/dist/commands/schema.js.map +1 -1
- package/dist/commands/search.js +3 -2
- package/dist/commands/search.js.map +1 -1
- package/dist/commands/{delete/settings.js → settings/delete.js} +7 -6
- package/dist/commands/settings/delete.js.map +1 -0
- package/dist/commands/{update/settings.js → settings/update.js} +7 -5
- package/dist/commands/settings/update.js.map +1 -0
- package/dist/commands/{get/settings.js → settings/view.js} +7 -8
- package/dist/commands/settings/view.js.map +1 -0
- package/dist/commands/similar.js +3 -2
- package/dist/commands/similar.js.map +1 -1
- package/dist/commands/{get/stats.js → stats.js} +7 -6
- package/dist/commands/stats.js.map +1 -0
- package/dist/commands/{cancel/tasks.js → task/cancel.js} +7 -5
- package/dist/commands/task/cancel.js.map +1 -0
- package/dist/commands/{delete/tasks.js → task/delete.js} +7 -5
- package/dist/commands/{delete/tasks.js.map → task/delete.js.map} +1 -1
- package/dist/commands/{get/tasks.js → task/list.js} +6 -6
- package/dist/commands/task/list.js.map +1 -0
- package/dist/commands/task/view.js +20 -0
- package/dist/commands/task/view.js.map +1 -0
- package/dist/commands/team/add.js +32 -0
- package/dist/commands/team/add.js.map +1 -0
- package/dist/commands/team/delete.js +20 -0
- package/dist/commands/team/delete.js.map +1 -0
- package/dist/commands/team/list.js +15 -0
- package/dist/commands/team/list.js.map +1 -0
- package/dist/commands/team/update.js +32 -0
- package/dist/commands/team/update.js.map +1 -0
- package/dist/commands/team/view.js +17 -0
- package/dist/commands/team/view.js.map +1 -0
- package/dist/commands/teleport.js +37 -29
- package/dist/commands/teleport.js.map +1 -1
- package/dist/commands/version.js +11 -0
- package/dist/commands/version.js.map +1 -0
- package/dist/lib/analytics.js +135 -0
- package/dist/lib/analytics.js.map +1 -0
- package/dist/lib/api-naming.js +73 -62
- package/dist/lib/api-naming.js.map +1 -1
- package/dist/lib/base-command.js +46 -33
- package/dist/lib/base-command.js.map +1 -1
- package/dist/lib/clients/analytics.js +24 -0
- package/dist/lib/clients/analytics.js.map +1 -0
- package/dist/lib/clients/meilisearch.js +2 -2
- package/dist/lib/clients/oauth.js +1 -1
- package/dist/lib/clients/oauth.js.map +1 -1
- package/dist/lib/cloud-sync.js +1 -1
- package/dist/lib/config.js +13 -4
- package/dist/lib/config.js.map +1 -1
- package/dist/lib/errors.js +51 -16
- package/dist/lib/errors.js.map +1 -1
- package/dist/lib/help.js +67 -14
- package/dist/lib/help.js.map +1 -1
- package/dist/lib/login.js +10 -6
- package/dist/lib/login.js.map +1 -1
- package/dist/lib/output.js +5 -29
- package/dist/lib/output.js.map +1 -1
- package/dist/lib/session.js +12 -1
- package/dist/lib/session.js.map +1 -1
- package/dist/lib/task-filters.js +4 -4
- package/dist/lib/task-filters.js.map +1 -1
- package/dist/lib/tasks.js +1 -1
- package/dist/lib/tasks.js.map +1 -1
- package/dist/lib/terminal.js +29 -7
- package/dist/lib/terminal.js.map +1 -1
- package/oclif.manifest.json +5787 -3133
- package/package.json +50 -31
- package/dist/commands/add/documents.js.map +0 -1
- package/dist/commands/add/indexes.js.map +0 -1
- package/dist/commands/add/keys.js.map +0 -1
- package/dist/commands/add/projects.js.map +0 -1
- package/dist/commands/cancel/tasks.js.map +0 -1
- package/dist/commands/delete/documents.js.map +0 -1
- package/dist/commands/delete/indexes.js.map +0 -1
- package/dist/commands/delete/keys.js.map +0 -1
- package/dist/commands/delete/projects.js.map +0 -1
- package/dist/commands/delete/settings.js.map +0 -1
- package/dist/commands/get/batches.js.map +0 -1
- package/dist/commands/get/documents.js.map +0 -1
- package/dist/commands/get/health.js.map +0 -1
- package/dist/commands/get/indexes.js +0 -33
- package/dist/commands/get/indexes.js.map +0 -1
- package/dist/commands/get/keys.js +0 -36
- package/dist/commands/get/keys.js.map +0 -1
- package/dist/commands/get/projects.js +0 -40
- package/dist/commands/get/projects.js.map +0 -1
- package/dist/commands/get/settings.js.map +0 -1
- package/dist/commands/get/stats.js.map +0 -1
- package/dist/commands/get/tasks.js.map +0 -1
- package/dist/commands/get/version.js +0 -16
- package/dist/commands/get/version.js.map +0 -1
- package/dist/commands/update/documents.js.map +0 -1
- package/dist/commands/update/indexes.js.map +0 -1
- package/dist/commands/update/keys.js.map +0 -1
- package/dist/commands/update/projects.js.map +0 -1
- package/dist/commands/update/settings.js.map +0 -1
package/dist/lib/help.js
CHANGED
|
@@ -1,19 +1,58 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Root and topic help
|
|
3
|
-
*
|
|
4
|
-
*
|
|
2
|
+
* Root and topic help. The root help is the tour of the CLI (ADR 0018): every
|
|
3
|
+
* resource with its commands, grouped by the API they talk to, then the global
|
|
4
|
+
* flags of every command and the environment variables of
|
|
5
|
+
* docs/contract/config.md, so that `meili --help` alone shows what exists and
|
|
6
|
+
* how to configure it.
|
|
5
7
|
*/
|
|
6
8
|
import { Help } from "@oclif/core";
|
|
7
9
|
import { BaseCommand } from "./base-command.js";
|
|
8
10
|
import { ENV_VARS } from "./config.js";
|
|
11
|
+
/** A command without a route of its own belongs to the CLI, whatever it calls. */
|
|
12
|
+
const SECTIONS = [
|
|
13
|
+
["CLI COMMANDS", "none"],
|
|
14
|
+
["MEILISEARCH COMMANDS", "meilisearch"],
|
|
15
|
+
["CLOUD MANAGEMENT COMMANDS", "management"],
|
|
16
|
+
];
|
|
17
|
+
/** The verbs of a resource in this order, then the others. */
|
|
18
|
+
const VERB_ORDER = ["list", "view", "add", "update", "delete"];
|
|
9
19
|
export default class MeiliHelp extends Help {
|
|
20
|
+
/** The description and the usage. `meili version` and `meili --version` give the version. */
|
|
10
21
|
formatRoot() {
|
|
11
|
-
const variables = ENV_VARS.map((variable) => [
|
|
12
|
-
variable.name,
|
|
13
|
-
variable.description,
|
|
14
|
-
]);
|
|
15
22
|
return [
|
|
16
|
-
|
|
23
|
+
this.config.pjson.description ?? "",
|
|
24
|
+
this.section("USAGE", `$ ${this.config.bin} <command> <subcommand> [flags]`),
|
|
25
|
+
].join("\n\n");
|
|
26
|
+
}
|
|
27
|
+
/** No topic has subtopics, and the root help lists the topics in its sections. */
|
|
28
|
+
get sortedTopics() {
|
|
29
|
+
return [];
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* oclif calls this with the commands of a topic, whose ids hold a ":", and
|
|
33
|
+
* at the root with the commands that have no topic. The root gets the tour
|
|
34
|
+
* instead: every command, by section.
|
|
35
|
+
*/
|
|
36
|
+
formatCommands(commands) {
|
|
37
|
+
if (commands.some((command) => command.id.includes(":")))
|
|
38
|
+
return super.formatCommands(commands);
|
|
39
|
+
const byName = new Map();
|
|
40
|
+
for (const command of this.sortedCommands) {
|
|
41
|
+
const name = command.id.split(":")[0] ?? command.id;
|
|
42
|
+
byName.set(name, [...(byName.get(name) ?? []), command]);
|
|
43
|
+
}
|
|
44
|
+
const sections = SECTIONS.map(([title, api]) => {
|
|
45
|
+
const rows = [...byName]
|
|
46
|
+
.filter(([, group]) => sectionOf(group) === api)
|
|
47
|
+
.map(([name, group]) => [
|
|
48
|
+
name,
|
|
49
|
+
group[0]?.id === name ? (this.summary(group[0]) ?? "") : verbs(group),
|
|
50
|
+
]);
|
|
51
|
+
return this.section(title, this.renderList(rows, { indentation: 2, spacer: "\n" }));
|
|
52
|
+
});
|
|
53
|
+
const variables = ENV_VARS.filter((variable) => variable.development !== true).map((variable) => [variable.name, variable.description]);
|
|
54
|
+
return [
|
|
55
|
+
...sections,
|
|
17
56
|
this.section("GLOBAL FLAGS", globalFlagRows()),
|
|
18
57
|
this.section("ENVIRONMENT VARIABLES", variables),
|
|
19
58
|
].join("\n\n");
|
|
@@ -26,12 +65,26 @@ export default class MeiliHelp extends Help {
|
|
|
26
65
|
return `${topicHelp}\n\n${this.section("GLOBAL FLAGS", globalFlagRows())}\n`;
|
|
27
66
|
}
|
|
28
67
|
}
|
|
29
|
-
/**
|
|
68
|
+
/** The section of a resource: the API of its commands, or the CLI when they have no route. */
|
|
69
|
+
function sectionOf(group) {
|
|
70
|
+
return group.some((command) => command.routes.length > 0) ? (group[0]?.api ?? "none") : "none";
|
|
71
|
+
}
|
|
72
|
+
/** `list, view, add, update, delete, swap`: the commands of a resource. */
|
|
73
|
+
function verbs(commands) {
|
|
74
|
+
const rank = (verb) => {
|
|
75
|
+
const index = VERB_ORDER.indexOf(verb);
|
|
76
|
+
return index === -1 ? VERB_ORDER.length : index;
|
|
77
|
+
};
|
|
78
|
+
return commands
|
|
79
|
+
.map((command) => command.id.split(":")[1] ?? "")
|
|
80
|
+
.sort((a, b) => rank(a) - rank(b) || a.localeCompare(b))
|
|
81
|
+
.join(", ");
|
|
82
|
+
}
|
|
83
|
+
/** `--debug` and its description, in the order of the contract table. */
|
|
30
84
|
function globalFlagRows() {
|
|
31
|
-
return Object.entries(BaseCommand.baseFlags).map(([name, flag]) =>
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
});
|
|
85
|
+
return Object.entries(BaseCommand.baseFlags).map(([name, flag]) => [
|
|
86
|
+
`--${name}`,
|
|
87
|
+
flag.description ?? "",
|
|
88
|
+
]);
|
|
36
89
|
}
|
|
37
90
|
//# sourceMappingURL=help.js.map
|
package/dist/lib/help.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help.js","sourceRoot":"","sources":["../../src/lib/help.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"help.js","sourceRoot":"","sources":["../../src/lib/help.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAgB,IAAI,EAAmB,MAAM,aAAa,CAAC;AAClE,OAAO,EAAY,WAAW,EAAwB,MAAM,mBAAmB,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,kFAAkF;AAClF,MAAM,QAAQ,GAAoB;IAChC,CAAC,cAAc,EAAE,MAAM,CAAC;IACxB,CAAC,sBAAsB,EAAE,aAAa,CAAC;IACvC,CAAC,2BAA2B,EAAE,YAAY,CAAC;CAC5C,CAAC;AAEF,8DAA8D;AAC9D,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAE/D,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,IAAI;IACzC,6FAA6F;IACpF,UAAU;QACjB,OAAO;YACL,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,IAAI,EAAE;YACnC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,iCAAiC,CAAC;SAC7E,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjB,CAAC;IAED,kFAAkF;IAClF,IAAuB,YAAY;QACjC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACgB,cAAc,CAAC,QAA4B;QAC5D,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAChG,MAAM,MAAM,GAAG,IAAI,GAAG,EAA6B,CAAC;QACpD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAmC,EAAE,CAAC;YAC/D,MAAM,IAAI,GAAG,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,EAAE,CAAC;YACpD,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;QAC3D,CAAC;QACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,EAAE;YAC7C,MAAM,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC;iBACrB,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC;iBAC/C,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAoB,EAAE,CAAC;gBACxC,IAAI;gBACJ,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC;aACtE,CAAC,CAAC;YACL,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACtF,CAAC,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,GAAG,CAChF,CAAC,QAAQ,EAAoB,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC,CACtE,CAAC;QACF,OAAO;YACL,GAAG,QAAQ;YACX,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,8FAA8F;AAC9F,SAAS,SAAS,CAAC,KAAwB;IACzC,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AACjG,CAAC;AAED,2EAA2E;AAC3E,SAAS,KAAK,CAAC,QAA2B;IACxC,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE;QAC5B,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACvC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IAClD,CAAC,CAAC;IACF,OAAO,QAAQ;SACZ,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SAChD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;SACvD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,yEAAyE;AACzE,SAAS,cAAc;IACrB,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;QACjE,KAAK,IAAI,EAAE;QACX,IAAI,CAAC,WAAW,IAAI,EAAE;KACvB,CAAC,CAAC;AACL,CAAC"}
|
package/dist/lib/login.js
CHANGED
|
@@ -3,26 +3,30 @@
|
|
|
3
3
|
* when nobody is logged in. See ADR 0009.
|
|
4
4
|
*/
|
|
5
5
|
import { spawn } from "node:child_process";
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
6
|
+
import { identify } from "./analytics.js";
|
|
7
|
+
import { logIn } from "./clients/oauth.js";
|
|
8
|
+
import { credentialsFilePath, resolveOauthClient, sessionUser, writeCredentialsFile, } from "./session.js";
|
|
8
9
|
/** How long the human has to approve before the login gives up. */
|
|
9
10
|
const TIMEOUT_MS = 300_000;
|
|
10
11
|
/**
|
|
11
|
-
* Runs the OAuth flow, writes the session to the credentials file,
|
|
12
|
-
*
|
|
12
|
+
* Runs the OAuth flow, writes the session to the credentials file, with the
|
|
13
|
+
* Cloud user the usage events use from now on (ADR 0016), and returns both.
|
|
14
|
+
* `say` writes a line for the human: an interactive command draws it in its margin.
|
|
13
15
|
*/
|
|
14
|
-
export async function logInWithBrowser(env, browser, say = (line) => process.stderr.write(`${line}\n`)) {
|
|
16
|
+
export async function logInWithBrowser(env, browser, userAgent, say = (line) => process.stderr.write(`${line}\n`)) {
|
|
15
17
|
const client = resolveOauthClient(env);
|
|
16
18
|
const tokens = await logIn(client, {
|
|
17
19
|
timeoutMs: TIMEOUT_MS,
|
|
18
20
|
onAuthorizationUrl: (url) => {
|
|
19
|
-
say(`Approve the login for \`${SCOPES}\` at:`);
|
|
20
21
|
say(url);
|
|
21
22
|
if (browser)
|
|
22
23
|
openInBrowser(url);
|
|
23
24
|
},
|
|
24
25
|
});
|
|
25
26
|
const session = { ...client, ...tokens };
|
|
27
|
+
const userId = await identify(env, async () => (await sessionUser(session, userAgent)).id);
|
|
28
|
+
if (userId !== undefined)
|
|
29
|
+
session.userId = userId;
|
|
26
30
|
const path = credentialsFilePath(env);
|
|
27
31
|
writeCredentialsFile(path, session);
|
|
28
32
|
return { path, session };
|
package/dist/lib/login.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAE3C,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAElB,WAAW,EACX,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,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,CAAC,CAAC,MAAM,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3F,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
CHANGED
|
@@ -4,36 +4,12 @@
|
|
|
4
4
|
* This file, errors.ts and config.ts implement the contract. They change only
|
|
5
5
|
* through a contract pull request.
|
|
6
6
|
*/
|
|
7
|
-
|
|
8
|
-
export
|
|
9
|
-
|
|
10
|
-
return typeof value === "string" && OUTPUT_MODES.includes(value);
|
|
11
|
-
}
|
|
12
|
-
/** `--output` wins, then `MEILI_OUTPUT`, then `json`. */
|
|
13
|
-
export function resolveOutputMode(options) {
|
|
14
|
-
if (isOutputMode(options.flag))
|
|
15
|
-
return options.flag;
|
|
16
|
-
const fromEnv = options.env.MEILI_OUTPUT;
|
|
17
|
-
if (fromEnv !== undefined && fromEnv !== "") {
|
|
18
|
-
if (isOutputMode(fromEnv))
|
|
19
|
-
return fromEnv;
|
|
20
|
-
throw new MeiliCliError("cli_usage", `MEILI_OUTPUT must be one of ${OUTPUT_MODES.join(", ")}, got \`${fromEnv}\`.`);
|
|
21
|
-
}
|
|
22
|
-
return "json";
|
|
23
|
-
}
|
|
24
|
-
/** Formats a value for stdout in the selected mode. Pure, so tests can snapshot it. */
|
|
25
|
-
export function formatData(value, options) {
|
|
26
|
-
if (options.mode === "json") {
|
|
27
|
-
return `${options.stdoutIsTTY ? JSON.stringify(value, null, 2) : JSON.stringify(value)}\n`;
|
|
28
|
-
}
|
|
29
|
-
if (options.supportsNdjson !== true) {
|
|
30
|
-
throw new MeiliCliError("cli_usage", "The `ndjson` output mode is only available on list commands. Use `--output json`.");
|
|
31
|
-
}
|
|
32
|
-
const items = Array.isArray(value) ? value : [value];
|
|
33
|
-
return items.map((item) => `${JSON.stringify(item)}\n`).join("");
|
|
7
|
+
/** JSON, indented when stdout is a terminal, compact when it is piped. Pure, so tests can snapshot it. */
|
|
8
|
+
export function formatData(value, stdoutIsTTY) {
|
|
9
|
+
return `${stdoutIsTTY ? JSON.stringify(value, null, 2) : JSON.stringify(value)}\n`;
|
|
34
10
|
}
|
|
35
11
|
/** Writes one result on stdout. Data only, nothing else, ever. */
|
|
36
|
-
export function writeData(value
|
|
37
|
-
process.stdout.write(formatData(value,
|
|
12
|
+
export function writeData(value) {
|
|
13
|
+
process.stdout.write(formatData(value, process.stdout.isTTY === true));
|
|
38
14
|
}
|
|
39
15
|
//# sourceMappingURL=output.js.map
|
package/dist/lib/output.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"output.js","sourceRoot":"","sources":["../../src/lib/output.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;
|
|
1
|
+
{"version":3,"file":"output.js","sourceRoot":"","sources":["../../src/lib/output.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,0GAA0G;AAC1G,MAAM,UAAU,UAAU,CAAC,KAAc,EAAE,WAAoB;IAC7D,OAAO,GAAG,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;AACrF,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC;AACzE,CAAC"}
|
package/dist/lib/session.js
CHANGED
|
@@ -7,6 +7,8 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import { rmSync } from "node:fs";
|
|
9
9
|
import { dirname, join } from "node:path";
|
|
10
|
+
import { getApiV2Me } from "./clients/management/generated/sdk.gen.js";
|
|
11
|
+
import { createManagementClient } from "./clients/management.js";
|
|
10
12
|
import { refreshAccessToken } from "./clients/oauth.js";
|
|
11
13
|
import { configFilePath, DEFAULT_MANAGEMENT_CLIENT_ID, DEFAULT_MANAGEMENT_DASHBOARD_URL, DEFAULT_MANAGEMENT_URL, ENV, nonEmpty, readOwnerOnly, writeSecretFile, } from "./config.js";
|
|
12
14
|
import { isRecord, MeiliCliError } from "./errors.js";
|
|
@@ -70,7 +72,7 @@ export function readCredentialsFile(path, warn) {
|
|
|
70
72
|
if (!isRecord(parsed) || !fields.every((field) => typeof parsed[field] === "string")) {
|
|
71
73
|
throw malformed();
|
|
72
74
|
}
|
|
73
|
-
if (
|
|
75
|
+
if (["refreshToken", "userId"].some((field) => parsed[field] !== undefined && typeof parsed[field] !== "string")) {
|
|
74
76
|
throw malformed();
|
|
75
77
|
}
|
|
76
78
|
const session = parsed;
|
|
@@ -146,4 +148,13 @@ export function ensureFreshSession(path, session) {
|
|
|
146
148
|
return Promise.resolve(session);
|
|
147
149
|
return refreshSession(path, session);
|
|
148
150
|
}
|
|
151
|
+
/** The Cloud user of a session: the body of `GET /api/v2/me`. */
|
|
152
|
+
export function sessionUser(session, userAgent) {
|
|
153
|
+
const client = createManagementClient({
|
|
154
|
+
url: session.managementUrl,
|
|
155
|
+
token: session.accessToken,
|
|
156
|
+
userAgent,
|
|
157
|
+
});
|
|
158
|
+
return getApiV2Me({ client });
|
|
159
|
+
}
|
|
149
160
|
//# sourceMappingURL=session.js.map
|
package/dist/lib/session.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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;
|
|
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,EAAE,UAAU,EAAE,MAAM,2CAA2C,CAAC;AACvE,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACjE,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;AAED,iEAAiE;AACjE,MAAM,UAAU,WAAW,CAAC,OAAqB,EAAE,SAAiB;IAClE,MAAM,MAAM,GAAG,sBAAsB,CAAC;QACpC,GAAG,EAAE,OAAO,CAAC,aAAa;QAC1B,KAAK,EAAE,OAAO,CAAC,WAAW;QAC1B,SAAS;KACV,CAAC,CAAC;IACH,OAAO,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;AAChC,CAAC"}
|
package/dist/lib/task-filters.js
CHANGED
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
* `DELETE /tasks` and `GET /batches` take the same query parameters, so the
|
|
4
4
|
* four commands spread the same flags and build the same query. Only the two
|
|
5
5
|
* identifier flags differ: named by what they identify, bare `uids` are task
|
|
6
|
-
* uids everywhere, so `
|
|
7
|
-
* `--batch-ids`, and `
|
|
6
|
+
* uids everywhere, so `task list` reads them as `--ids` and the batches as
|
|
7
|
+
* `--batch-ids`, and `batch list` the other way round
|
|
8
8
|
* (docs/contract/commands.md, rule 5). The API spelling stays an alias.
|
|
9
9
|
*/
|
|
10
10
|
import { Flags } from "@oclif/core";
|
|
@@ -54,7 +54,7 @@ const queueFilterFlags = {
|
|
|
54
54
|
};
|
|
55
55
|
export const taskFilterFlags = {
|
|
56
56
|
ids: Flags.string({
|
|
57
|
-
aliases: ["uids"
|
|
57
|
+
aliases: ["uids"],
|
|
58
58
|
description: "Task uids to match, comma-separated. `*` matches every one.",
|
|
59
59
|
helpValue: "<uids>",
|
|
60
60
|
}),
|
|
@@ -67,7 +67,7 @@ export const taskFilterFlags = {
|
|
|
67
67
|
};
|
|
68
68
|
export const batchFilterFlags = {
|
|
69
69
|
ids: Flags.string({
|
|
70
|
-
aliases: ["batch-uids"
|
|
70
|
+
aliases: ["batch-uids"],
|
|
71
71
|
description: "Batch uids to match, comma-separated. `*` matches every one.",
|
|
72
72
|
helpValue: "<uids>",
|
|
73
73
|
}),
|
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,CAAC;QACjB,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,CAAC;QACvB,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
CHANGED
|
@@ -56,7 +56,7 @@ export async function pollUntil(poll, isFinal, timeoutError, options) {
|
|
|
56
56
|
* `cli_timeout` when the deadline passes; the task keeps running on the server.
|
|
57
57
|
*/
|
|
58
58
|
export function waitForTask(client, uid, options) {
|
|
59
|
-
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
|
|
59
|
+
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 task view --id ${uid}\` to check its status.` }), options);
|
|
60
60
|
}
|
|
61
61
|
function defaultSleep(ms) {
|
|
62
62
|
return new Promise((resolve) => setTimeout(resolve, ms));
|
package/dist/lib/tasks.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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
|
|
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,8BAA8B,GAAG,yBAAyB,EAAE,CACrE,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"}
|
package/dist/lib/terminal.js
CHANGED
|
@@ -3,11 +3,33 @@
|
|
|
3
3
|
* questions answered with the arrow keys, lines for the human, and a status
|
|
4
4
|
* block that animates while the command waits. Everything goes to stderr:
|
|
5
5
|
* stdout stays for data. Colors follow `NO_COLOR` and `FORCE_COLOR`.
|
|
6
|
+
*
|
|
7
|
+
* Every question has a `prompt` id, and every option may have an `id`: the
|
|
8
|
+
* analytics record them (ADR 0016), never the text of a free answer. A renamed
|
|
9
|
+
* id breaks the funnels that use it.
|
|
6
10
|
*/
|
|
7
11
|
import { stripVTControlCharacters, styleText } from "node:util";
|
|
8
12
|
import { input, password, Separator, select } from "@inquirer/prompts";
|
|
13
|
+
import { track } from "./analytics.js";
|
|
9
14
|
/** Where the questions are drawn. A function: tests replace `process.stderr.write`. The answer becomes a `step` line. */
|
|
10
15
|
const context = () => ({ output: process.stderr, clearPromptOnDone: true });
|
|
16
|
+
/** True for the error of a question the human left with Ctrl-C. */
|
|
17
|
+
export function isPromptExit(error) {
|
|
18
|
+
return error instanceof Error && error.name === "ExitPromptError";
|
|
19
|
+
}
|
|
20
|
+
/** The answer to the question `prompt`, recorded as answered or as left. */
|
|
21
|
+
async function answer(prompt, question, choice) {
|
|
22
|
+
try {
|
|
23
|
+
const value = await question;
|
|
24
|
+
track("cli_prompt_answered", { prompt, choice: choice(value) });
|
|
25
|
+
return value;
|
|
26
|
+
}
|
|
27
|
+
catch (error) {
|
|
28
|
+
if (isPromptExit(error))
|
|
29
|
+
track("cli_prompt_aborted", { prompt });
|
|
30
|
+
throw error;
|
|
31
|
+
}
|
|
32
|
+
}
|
|
11
33
|
/** The left margin of every line, questions included. */
|
|
12
34
|
const MARGIN = " ";
|
|
13
35
|
/** The look of the questions: inquirer's, in the margin. */
|
|
@@ -25,28 +47,28 @@ const theme = () => ({
|
|
|
25
47
|
},
|
|
26
48
|
});
|
|
27
49
|
/** One answer out of a list, picked with the arrow keys. A `heading` starts a group of answers. */
|
|
28
|
-
export function choose(message, choices) {
|
|
50
|
+
export function choose(prompt, message, choices) {
|
|
29
51
|
clearStatus();
|
|
30
|
-
return select({
|
|
52
|
+
return answer(prompt, select({
|
|
31
53
|
message,
|
|
32
54
|
choices: choices.map((choice) => Separator.isSeparator(choice) ? choice : { ...choice, name: `${MARGIN}${choice.name}` }),
|
|
33
55
|
pageSize: 15,
|
|
34
56
|
theme: theme(),
|
|
35
|
-
}, context());
|
|
57
|
+
}, context()), (value) => choices.find((each) => !Separator.isSeparator(each) && each.value === value)?.id);
|
|
36
58
|
}
|
|
37
59
|
/** The title of a group of answers of `choose`, which the arrow keys skip. Its answers are indented. */
|
|
38
60
|
export function heading(title) {
|
|
39
61
|
return new Separator(`${MARGIN} ${paint("bold", title)}`);
|
|
40
62
|
}
|
|
41
63
|
/** A line of text, `default` when the human presses Enter. */
|
|
42
|
-
export function ask(message, options = {}) {
|
|
64
|
+
export function ask(prompt, message, options = {}) {
|
|
43
65
|
clearStatus();
|
|
44
|
-
return input({ message, ...options, theme: theme() }, context());
|
|
66
|
+
return answer(prompt, input({ message, ...options, theme: theme() }, context()), (value) => value === options.default ? "default" : "custom");
|
|
45
67
|
}
|
|
46
68
|
/** A line of text that is never echoed. */
|
|
47
|
-
export function askSecret(message) {
|
|
69
|
+
export function askSecret(prompt, message) {
|
|
48
70
|
clearStatus();
|
|
49
|
-
return password({ message, mask: true, theme: theme() }, context());
|
|
71
|
+
return answer(prompt, password({ message, mask: true, theme: theme() }, context()), (value) => value === "" ? "empty" : "custom");
|
|
50
72
|
}
|
|
51
73
|
/** `text` in `style`, when stderr shows colors. */
|
|
52
74
|
export function paint(style, text) {
|
package/dist/lib/terminal.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"terminal.js","sourceRoot":"","sources":["../../src/lib/terminal.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"terminal.js","sourceRoot":"","sources":["../../src/lib/terminal.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,wBAAwB,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAChE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACvE,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEvC,yHAAyH;AACzH,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;AAE5E,mEAAmE;AACnE,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,OAAO,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,CAAC;AACpE,CAAC;AAED,4EAA4E;AAC5E,KAAK,UAAU,MAAM,CACnB,MAAc,EACd,QAAoB,EACpB,MAAwC;IAExC,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC;QAC7B,KAAK,CAAC,qBAAqB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,YAAY,CAAC,KAAK,CAAC;YAAE,KAAK,CAAC,oBAAoB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QACjE,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,yDAAyD;AACzD,MAAM,MAAM,GAAG,IAAI,CAAC;AAEpB,4DAA4D;AAC5D,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,CAAC;IACnB,MAAM,EAAE,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;IACxC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE;IACrB,KAAK,EAAE;QACL,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,KAAK,EAAE,KAAK,IAAI,EAAE,CAAC,EAAE;QAChE,0GAA0G;QAC1G,SAAS,EAAE,CAAC,IAAY,EAAE,EAAE,CAC1B,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/E,WAAW,EAAE,CAAC,IAAwB,EAAE,EAAE,CACxC,MAAM;YACN,IAAI;iBACD,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;iBACvE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;KAC/B;CACF,CAAC,CAAC;AAIH,mGAAmG;AACnG,MAAM,UAAU,MAAM,CACpB,MAAc,EACd,OAAe,EACf,OAAqC;IAErC,WAAW,EAAE,CAAC;IACd,OAAO,MAAM,CACX,MAAM,EACN,MAAM,CACJ;QACE,OAAO;QACP,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAC9B,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,CACxF;QACD,QAAQ,EAAE,EAAE;QACZ,KAAK,EAAE,KAAK,EAAE;KACf,EACD,OAAO,EAAE,CACV,EACD,CAAC,KAAK,EAAE,EAAE,CACR,OAAO,CAAC,IAAI,CACV,CAAC,IAAI,EAAqB,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAClF,EAAE,EAAE,CACR,CAAC;AACJ,CAAC;AAED,wGAAwG;AACxG,MAAM,UAAU,OAAO,CAAC,KAAa;IACnC,OAAO,IAAI,SAAS,CAAC,GAAG,MAAM,IAAI,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;AAC5D,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,GAAG,CACjB,MAAc,EACd,OAAe,EACf,OAAO,GAAsE,EAAE;IAE/E,WAAW,EAAE,CAAC;IACd,OAAO,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CACzF,KAAK,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CACjD,CAAC;AACJ,CAAC;AAED,2CAA2C;AAC3C,MAAM,UAAU,SAAS,CAAC,MAAc,EAAE,OAAe;IACvD,WAAW,EAAE,CAAC;IACd,OAAO,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAC5F,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAClC,CAAC;AACJ,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,KAAK,CAAC,KAAsC,EAAE,IAAY;IACxE,OAAO,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;AAC5D,CAAC;AAED,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB,mGAAmG;AACnG,MAAM,UAAU,GAAG,CAAC,IAAI,GAAG,EAAE;IAC3B,SAAS,EAAE,CAAC;IACZ,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,IAAI,IAAI,CAAC,CAAC;AAClE,CAAC;AAED,kDAAkD;AAClD,MAAM,UAAU,MAAM,CAAC,IAAY;IACjC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;AACnB,CAAC;AAED,yFAAyF;AACzF,MAAM,UAAU,IAAI,CAAC,KAAa,EAAE,IAAY,EAAE,KAAc;IAC9D,WAAW,EAAE,CAAC;IACd,MAAM,IAAI,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;IAC5E,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC;AAC1F,CAAC;AAED,uCAAuC;AACvC,MAAM,UAAU,OAAO,CAAC,IAAY;IAClC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;AACtC,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,KAAK,CAAC,KAAa,EAAE,KAAa;IAChD,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,MAAM,GAAG,YAAY,CAAC;AAE5B,iGAAiG;AACjG,IAAI,MAAkC,CAAC;AACvC,IAAI,KAAK,GAAG,CAAC,CAAC;AACd,IAAI,KAAK,GAAG,CAAC,CAAC;AACd,IAAI,KAAiC,CAAC;AAEtC;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAC,IAAkB;IACvC,MAAM,GAAG,IAAI,CAAC;IACd,KAAK,KAAK,WAAW,CAAC,GAAG,EAAE;QACzB,KAAK,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC;QACpC,IAAI,EAAE,CAAC;IACT,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;IACf,IAAI,EAAE,CAAC;AACT,CAAC;AAED,SAAS,IAAI;IACX,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO;IACjC,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC9C,MAAM,KAAK,GAAG;QACZ,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAW,CAAC,IAAI,KAAK,EAAE;QAC7D,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,MAAM,KAAK,IAAI,EAAE,CAAC;KAC5C,CAAC;IACF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,aAAa,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9D,qDAAqD;IACrD,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;IAC7C,KAAK,GAAG,KAAK,CAAC,MAAM,CAClB,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC,EAC9F,CAAC,CACF,CAAC;AACJ,CAAC;AAED,kEAAkE;AAClE,SAAS,aAAa;IACpB,OAAO,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;AAC5D,CAAC;AAED,sEAAsE;AACtE,SAAS,WAAW,CAAC,IAAY;IAC/B,aAAa,CAAC,KAAK,CAAC,CAAC;IACrB,KAAK,GAAG,SAAS,CAAC;IAClB,MAAM,GAAG,SAAS,CAAC;IACnB,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO;IACxB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3B,KAAK,GAAG,CAAC,CAAC;AACZ,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,SAAS;IACvB,IAAI,EAAE,CAAC;IACP,WAAW,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC;AAED,+BAA+B;AAC/B,SAAS,WAAW;IAClB,WAAW,CAAC,aAAa,EAAE,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,SAAS,GAAG,EAAE,CAAC;AAErB,6EAA6E;AAC7E,MAAM,UAAU,GAAG,CAAC,QAAgB;IAClC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;IAChD,OAAO,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC;AAClJ,CAAC;AAED,kDAAkD;AAClD,MAAM,UAAU,OAAO,CAAC,KAAa;IACnC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IACxD,OAAO,OAAO,GAAG,EAAE;QACjB,CAAC,CAAC,GAAG,OAAO,GAAG;QACf,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC;AAC9E,CAAC"}
|