kourou 1.4.0-dev.4 → 1.5.0-dev.1

package/lib/index.d.ts

@@ -1 +1 @@
-export { run } from "@oclif/command";
+export { run } from "@oclif/core";

package/lib/index.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var command_1 = require("@oclif/command");
-Object.defineProperty(exports, "run", { enumerable: true, get: function () { return command_1.run; } });
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/lib/support/dump-collection.js

@@ -5,8 +5,8 @@ exports.dumpCollectionMappings = dumpCollectionMappings;
 const tslib_1 = require("tslib");
 const fs_1 = tslib_1.__importDefault(require("fs"));
 const path_1 = tslib_1.__importDefault(require("path"));
-const cli_ux_1 = tslib_1.__importDefault(require("cli-ux"));
 const ndjson_1 = tslib_1.__importDefault(require("ndjson"));
+const progressBar_1 = require("./progressBar");
 const common_1 = require("../common");
 /**
  * Flatten an object transform:
@@ -89,7 +89,7 @@ class AbstractDumper {
         await this.setup();
         await this.writeHeader();
         let results = await this.sdk.document.search(this.index, this.collection, { query: this.query }, this.options);
-        const progressBar = cli_ux_1.default.progress({
+        const progressBar = (0, progressBar_1.createProgressBar)({
             format: `Dumping ${this.collection} |{bar}| {percentage}% || {value}/{total} documents`,
         });
         progressBar.start(results.total, 0);

package/lib/support/kuzzle.d.ts

@@ -1,15 +1,14 @@
 import http from "http";
-import { flags } from "@oclif/command";
 import { Kuzzle, JSONObject } from "kuzzle-sdk";
 export declare const kuzzleFlags: {
-    host: flags.IOptionFlag<string>;
-    port: flags.IOptionFlag<string>;
-    ssl: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-    username: flags.IOptionFlag<string>;
-    password: flags.IOptionFlag<string | undefined>;
-    protocol: flags.IOptionFlag<string>;
-    as: flags.IOptionFlag<string | undefined>;
-    "api-key": flags.IOptionFlag<string | undefined>;
+    host: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    port: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    ssl: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    username: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    password: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    protocol: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    as: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    "api-key": import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
 };
 export declare class KuzzleSDK {
     sdk: Kuzzle;

package/lib/support/kuzzle.js

@@ -4,38 +4,38 @@ exports.KuzzleSDK = exports.kuzzleFlags = void 0;
 const tslib_1 = require("tslib");
 const http_1 = tslib_1.__importDefault(require("http"));
 const https_1 = tslib_1.__importDefault(require("https"));
-const command_1 = require("@oclif/command");
+const core_1 = require("@oclif/core");
 const kuzzle_sdk_1 = require("kuzzle-sdk");
 const SECOND = 1000;
 exports.kuzzleFlags = {
-    host: command_1.flags.string({
+    host: core_1.Flags.string({
         description: "Kuzzle server host",
         default: process.env.KUZZLE_HOST || "localhost",
     }),
-    port: command_1.flags.string({
+    port: core_1.Flags.string({
         description: "Kuzzle server port",
         default: process.env.KUZZLE_PORT || "7512",
     }),
-    ssl: command_1.flags.boolean({
+    ssl: core_1.Flags.boolean({
         description: "Use SSL to connect to Kuzzle",
         default: Boolean(process.env.KUZZLE_SSL) || undefined,
     }),
-    username: command_1.flags.string({
+    username: core_1.Flags.string({
         description: "Kuzzle username (local strategy)",
         default: process.env.KUZZLE_USERNAME || "anonymous",
     }),
-    password: command_1.flags.string({
+    password: core_1.Flags.string({
         description: "Kuzzle user password",
         default: process.env.KUZZLE_PASSWORD || undefined,
     }),
-    protocol: command_1.flags.string({
+    protocol: core_1.Flags.string({
         description: "Kuzzle protocol (http or ws)",
         default: process.env.KUZZLE_PROTOCOL || "ws",
     }),
-    as: command_1.flags.string({
+    as: core_1.Flags.string({
         description: "Impersonate a user",
     }),
-    "api-key": command_1.flags.string({
+    "api-key": core_1.Flags.string({
         description: "Kuzzle user api-key",
         default: process.env.KUZZLE_API_KEY || undefined,
     }),

package/lib/support/progressBar.d.ts

@@ -0,0 +1,10 @@
+import { SingleBar, Options } from "cli-progress";
+/**
+ * Creates a progress bar behaving like the one cli-ux used to provide.
+ *
+ * cli-ux wrapped cli-progress and forced `noTTYOutput` whenever the terminal
+ * is dumb or stdin is not a TTY, which is what keeps the output readable when
+ * it is piped or captured, as the functional tests do. Reproduced here so the
+ * output stays identical now that cli-ux is gone.
+ */
+export declare function createProgressBar(options?: Options): SingleBar;

package/lib/support/progressBar.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProgressBar = createProgressBar;
+const cli_progress_1 = require("cli-progress");
+/**
+ * Creates a progress bar behaving like the one cli-ux used to provide.
+ *
+ * cli-ux wrapped cli-progress and forced `noTTYOutput` whenever the terminal
+ * is dumb or stdin is not a TTY, which is what keeps the output readable when
+ * it is piped or captured, as the functional tests do. Reproduced here so the
+ * output stays identical now that cli-ux is gone.
+ */
+function createProgressBar(options = {}) {
+    return new cli_progress_1.SingleBar(Object.assign(Object.assign({}, options), { noTTYOutput: Boolean(process.env.TERM === "dumb" || !process.stdin.isTTY) }));
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kourou",
   "description": "The CLI that helps you manage your Kuzzle instances",
-  "version": "1.4.0-dev.4",
+  "version": "1.5.0-dev.1",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "bin": {
     "kourou": "./bin/run"
@@ -11,7 +11,7 @@
     "build": "tsc --build tsconfig.json",
     "dev": "./bin/run",
     "postpack": "rm -f oclif.manifest.json",
-    "version": "oclif-dev readme && git add README.md",
+    "version": "oclif readme && git add README.md",
     "test:lint": "eslint src/ test/",
     "test:lint:fix": "eslint src/ test/ --fix",
     "test:functional": "npm run build && npm run test:functional:stdout && npm run test:functional:cucumber",
@@ -21,12 +21,12 @@
   "dependencies": {
     "sdk-es7": "npm:@elastic/elasticsearch@7.17.14",
     "sdk-es8": "npm:@elastic/elasticsearch@8.19.2",
-    "@oclif/command": "1.8.*",
-    "@oclif/config": "1.18.*",
-    "@oclif/plugin-autocomplete": "1.3.*",
-    "@oclif/plugin-help": "3.2.2",
+    "@oclif/core": "5.0.0",
+    "@oclif/plugin-autocomplete": "4.0.0",
+    "@oclif/plugin-help": "7.0.0",
+    "@oclif/plugin-version": "3.0.0",
     "chalk": "4.1.2",
-    "cli-ux": "5.5.1",
+    "cli-progress": "3.12.0",
     "inquirer": "8.2.7",
     "kepler-companion": "1.1.6",
     "kuzzle-sdk": "7.17.1",
@@ -43,23 +43,22 @@
   "devDependencies": {
     "@cucumber/cucumber": "13.2.1",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
-    "@oclif/dev-cli": "1.26.10",
-    "@oclif/test": "1.2.8",
-    "@types/chai": "4.3.20",
+    "@types/cli-progress": "3.11.6",
     "@types/compare-version": "0.1.34",
     "@types/inquirer": "8.2.13",
     "@types/listr": "0.14.10",
+    "@types/lodash": "4.17.25",
     "@types/mocha": "10.0.10",
     "@types/ndjson": "2.0.4",
     "@types/node": "22.20.1",
     "@types/tmp": "0.2.6",
     "@types/ws": "8.18.1",
-    "chai": "4.5.0",
     "eslint": "9.32.0",
     "eslint-plugin-kuzzle": "1.0.0",
     "globby": "11.1.0",
     "mocha": "12.0.0",
     "nyc": "15.1.0",
+    "oclif": "5.0.1",
     "semantic-release": "25.0.8",
     "semantic-release-config-kuzzle": "1.7.0",
     "should": "13.2.3",
@@ -85,9 +84,11 @@
   "oclif": {
     "commands": "./lib/commands",
     "bin": "kourou",
+    "helpClass": "./lib/help",
     "plugins": [
       "@oclif/plugin-help",
-      "@oclif/plugin-autocomplete"
+      "@oclif/plugin-autocomplete",
+      "@oclif/plugin-version"
     ],
     "repositoryPrefix": "<%- commandPath %>",
     "topics": {