kourou 0.28.1 → 1.0.1

package/README.md

@@ -27,7 +27,7 @@ $ npm install -g kourou
 $ kourou COMMAND
 running command...
 $ kourou (-v|--version|version)
-kourou/0.28.1 darwin-arm64 node-v20.10.0
+kourou/1.0.1 linux-x64 node-v22.12.0
 $ kourou --help [COMMAND]
 USAGE
   $ kourou COMMAND
@@ -161,14 +161,7 @@ All other arguments and options will be passed as-is to the `sdk:query` method.
 * [`kourou instance:list`](#kourou-instancelist)
 * [`kourou instance:logs`](#kourou-instancelogs)
 * [`kourou instance:spawn`](#kourou-instancespawn)
-* [`kourou paas:deploy ENVIRONMENT APPLICATIONID IMAGE`](#kourou-paasdeploy-environment-applicationid-image)
-* [`kourou paas:elasticsearch:dump ENVIRONMENT APPLICATIONID DUMPDIRECTORY`](#kourou-paaselasticsearchdump-environment-applicationid-dumpdirectory)
-* [`kourou paas:init PROJECT`](#kourou-paasinit-project)
 * [`kourou paas:login`](#kourou-paaslogin)
-* [`kourou paas:logs ENVIRONMENT APPLICATION`](#kourou-paaslogs-environment-application)
-* [`kourou paas:snapshots:cat ENVIRONMENT APPLICATIONID`](#kourou-paassnapshotscat-environment-applicationid)
-* [`kourou paas:snapshots:dump ENVIRONMENT APPLICATIONID`](#kourou-paassnapshotsdump-environment-applicationid)
-* [`kourou paas:snapshots:restore ENVIRONMENT APPLICATIONID SNAPSHOTID`](#kourou-paassnapshotsrestore-environment-applicationid-snapshotid)
 * [`kourou profile:export`](#kourou-profileexport)
 * [`kourou profile:import PATH`](#kourou-profileimport-path)
 * [`kourou realtime:subscribe INDEX COLLECTION [FILTERS]`](#kourou-realtimesubscribe-index-collection-filters)
@@ -813,6 +806,8 @@ OPTIONS
   --help           show CLI help
 ```
 
+_See code: [lib/commands/es/snapshot/restore.js](lib/commands/es/snapshot/restore.js)_
+
 ## `kourou file:decrypt FILE`
 
 Decrypts an encrypted file.
@@ -1062,63 +1057,6 @@ OPTIONS
 
 _See code: [lib/commands/instance/spawn.js](lib/commands/instance/spawn.js)_
 
-## `kourou paas:deploy ENVIRONMENT APPLICATIONID IMAGE`
-
-Deploy a new version of the application in the PaaS
-
-```
-USAGE
-  $ kourou paas:deploy ENVIRONMENT APPLICATIONID IMAGE
-
-ARGUMENTS
-  ENVIRONMENT    Project environment name
-  APPLICATIONID  Application Identifier
-  IMAGE          Image name and hash as myimage:mytag
-
-OPTIONS
-  --help             show CLI help
-  --project=project  Current PaaS project
-  --token=token      Authentication token
-```
-
-_See code: [lib/commands/paas/deploy.js](lib/commands/paas/deploy.js)_
-
-## `kourou paas:elasticsearch:dump ENVIRONMENT APPLICATIONID DUMPDIRECTORY`
-
-Dump data from the Elasticsearch of a PaaS application
-
-```
-USAGE
-  $ kourou paas:elasticsearch:dump ENVIRONMENT APPLICATIONID DUMPDIRECTORY
-
-ARGUMENTS
-  ENVIRONMENT    Project environment name
-  APPLICATIONID  Application Identifier
-  DUMPDIRECTORY  Directory where to store dump files
-
-OPTIONS
-  --batch-size=batch-size  [default: 2000] Maximum batch size
-  --help                   show CLI help
-  --project=project        Current PaaS project
-```
-
-## `kourou paas:init PROJECT`
-
-Initialize a PaaS project in current directory
-
-```
-USAGE
-  $ kourou paas:init PROJECT
-
-ARGUMENTS
-  PROJECT  Kuzzle PaaS project name
-
-OPTIONS
-  --help  show CLI help
-```
-
-_See code: [lib/commands/paas/init.js](lib/commands/paas/init.js)_
-
 ## `kourou paas:login`
 
 Login for a PaaS project
@@ -1136,101 +1074,6 @@ OPTIONS
 
 _See code: [lib/commands/paas/login.js](lib/commands/paas/login.js)_
 
-## `kourou paas:logs ENVIRONMENT APPLICATION`
-
-Show logs of the targeted application
-
-```
-USAGE
-  $ kourou paas:logs ENVIRONMENT APPLICATION
-
-ARGUMENTS
-  ENVIRONMENT  Kuzzle PaaS environment
-  APPLICATION  Kuzzle PaaS application
-
-OPTIONS
-  -f, --follow       Follow log output
-  -n, --tail=tail    Number of lines to show from the end of the logs
-  -t, --timestamp    Show timestamp
-  --help             show CLI help
-  --podName=podName  Name of the pod to show logs from
-  --project=project  Current PaaS project
-  --since=since      Display logs from a specific absolute (e.g. 2022/12/02 09:41) or relative (e.g. a minute ago) time
-  --until=until      Display logs until a specific absolute (e.g. 2022/12/02 09:41) or relative (e.g. a minute ago) time
-```
-
-_See code: [lib/commands/paas/logs.js](lib/commands/paas/logs.js)_
-
-## `kourou paas:snapshots:cat ENVIRONMENT APPLICATIONID`
-
-List all snapshots for a given kuzzle application in a environment
-
-```
-USAGE
-  $ kourou paas:snapshots:cat ENVIRONMENT APPLICATIONID
-
-ARGUMENTS
-  ENVIRONMENT    Project environment name
-  APPLICATIONID  Application Identifier
-
-OPTIONS
-  --help             show CLI help
-  --project=project  Current PaaS project
-  --token=token      Authentication token
-
-EXAMPLE
-  kourou paas:snapshots:cat --project paas-project-myproject api main
-```
-
-_See code: [lib/commands/paas/snapshots/cat.js](lib/commands/paas/snapshots/cat.js)_
-
-## `kourou paas:snapshots:dump ENVIRONMENT APPLICATIONID`
-
-Create a new snapshot of the current application state
-
-```
-USAGE
-  $ kourou paas:snapshots:dump ENVIRONMENT APPLICATIONID
-
-ARGUMENTS
-  ENVIRONMENT    Project environment name
-  APPLICATIONID  Application Identifier
-
-OPTIONS
-  --help             show CLI help
-  --project=project  Current PaaS project
-  --token=token      Authentication token
-
-EXAMPLE
-  kourou paas:snapshots:dump --project paas-project-myproject api main
-```
-
-_See code: [lib/commands/paas/snapshots/dump.js](lib/commands/paas/snapshots/dump.js)_
-
-## `kourou paas:snapshots:restore ENVIRONMENT APPLICATIONID SNAPSHOTID`
-
-Restore a snapshot of the current application state
-
-```
-USAGE
-  $ kourou paas:snapshots:restore ENVIRONMENT APPLICATIONID SNAPSHOTID
-
-ARGUMENTS
-  ENVIRONMENT    Project environment name
-  APPLICATIONID  Application Identifier
-  SNAPSHOTID     Snapshot Identifier
-
-OPTIONS
-  --help             show CLI help
-  --project=project  Current PaaS project
-  --token=token      Authentication token
-
-EXAMPLE
-  kourou paas:snapshots:restore --project paas-project-myproject api main snapshot-id
-```
-
-_See code: [lib/commands/paas/snapshots/restore.js](lib/commands/paas/snapshots/restore.js)_
-
 ## `kourou profile:export`
 
 Exports profiles

package/lib/commands/app/scaffold.d.ts

@@ -19,5 +19,5 @@ export default class AppScaffold extends Kommand {
     prepareTemplate(): Promise<void>;
     cloneTemplate(flavor: string): Promise<void>;
     copyTemplate(destination: string): Promise<void>;
-    cleanup(): Promise<void>;
+    cleanup(destination: string): Promise<void>;
 }

package/lib/commands/app/scaffold.js

@@ -32,7 +32,7 @@ class AppScaffold extends common_1.Kommand {
             },
             {
                 title: "Cleaning up",
-                task: async () => this.cleanup()
+                task: async () => this.cleanup(destination)
             }
         ]);
         await tasks.run();
@@ -41,7 +41,6 @@ class AppScaffold extends common_1.Kommand {
         this.logOk(`Use ${chalk_1.default.blue.bold(`cd ${destination} && docker compose up -d`)} to start your Kuzzle stack.`);
     }
     getRepo(flavor) {
-        console.log(flavor);
         switch (flavor) {
             case "generic":
                 return "template-kuzzle-project";
@@ -76,8 +75,9 @@ class AppScaffold extends common_1.Kommand {
     async copyTemplate(destination) {
         await (0, execute_1.execute)("cp", "-r", `${this.templatesDir}/`, `${destination}/`);
     }
-    async cleanup() {
+    async cleanup(destination) {
         await (0, execute_1.execute)("rm", "-rf", this.templatesDir);
+        await (0, execute_1.execute)("rm", "-rf", `${destination}/.git`);
     }
 }
 exports.default = AppScaffold;

package/lib/commands/app/start-services.js

@@ -10,8 +10,6 @@ const common_1 = require("../../common");
 const execute_1 = require("../../support/execute");
 const checkPrerequisites_1 = require("../../support/docker/checkPrerequisites");
 const kuzzleServicesFile = `
-version: '3'
-
 services:
   redis:
     image: redis:5

package/lib/commands/instance/spawn.js

@@ -15,8 +15,6 @@ const checkPrerequisites_1 = require("../../support/docker/checkPrerequisites");
 const MIN_MAX_MAP_COUNT = 262144;
 const MIN_DOCO_VERSION = "2.0.0";
 const kuzzleStackV1 = (increment) => `
-version: '3'
-
 services:
   kuzzle:
     image: kuzzleio/kuzzle:1
@@ -50,8 +48,6 @@ services:
       - "ES_JAVA_OPTS=-Xms1024m -Xmx1024m"
 `;
 const kuzzleStackV2 = (increment) => `
-version: '3'
-
 services:
   kuzzle:
     image: kuzzleio/kuzzle:2

package/lib/common.d.ts

@@ -22,8 +22,8 @@ export declare abstract class Kommand extends Command {
     logOk(message: string): void;
     logInfo(message: string): void;
     logKo(message?: string): void;
-    run(): Promise<number>;
-    beforeConnect(): void;
+    run(): Promise<void>;
+    beforeConnect(): Promise<void>;
     runSafe(): Promise<void>;
     /**
      * Reads a value from STDIN.

package/lib/common.js

@@ -129,9 +129,8 @@ class Kommand extends command_1.Command {
             this.sdk.disconnect();
             process.exit(this.exitCode);
         }
-        return this.exitCode;
     }
-    beforeConnect() {
+    async beforeConnect() {
         // will be called before connecting to Kuzzle
     }
     async runSafe() {

package/lib/support/PaasKommand.d.ts

@@ -19,6 +19,5 @@ export declare class PaasKommand extends Kommand {
      * Retrieve the current project name from the command line or current package.json
      */
     getProject(): any;
-    getCredentials(): Promise<any>;
 }
 export {};

package/lib/support/PaasKommand.js

@@ -56,16 +56,6 @@ class PaasKommand extends common_1.Kommand {
         }
         return this.flags.project;
     }
-    async getCredentials() {
-        const project = this.getProject();
-        const projectFile = this.fileProjectCredentials(project);
-        if (!fs_1.default.existsSync(projectFile)) {
-            this.logKo("You are not logged in. You should run paas:login first. Aborting.");
-            process.exit(1);
-        }
-        const credentials = JSON.parse(fs_1.default.readFileSync(projectFile, "utf8"));
-        return credentials.apiKey;
-    }
 }
 exports.PaasKommand = PaasKommand;
 PaasKommand.initSdk = false;

package/lib/support/dump-collection.js

@@ -245,7 +245,12 @@ async function dumpCollectionMappings(sdk, index, collection, destPath, format =
         type: "mappings",
         content: {
             [index]: {
-                [collection]: mappings,
+                [collection]: {
+                    mappings
+                    // For later use, we could add the settings here
+                    // eg: "settings": { "index.mapping.total_fields.limit": 10000 }
+                    // This can be added after the dump and it will work with kourou:import command
+                },
             },
         },
     };

package/lib/support/kuzzle.d.ts

@@ -40,7 +40,7 @@ export declare class KuzzleSDK {
         (): Promise<void>;
     }): Promise<void>;
     disconnect(): void;
-    query(request: any): Promise<import("kuzzle-sdk").ResponsePayload<unknown>>;
+    query(request: any): Promise<import("kuzzle-sdk").ResponsePayload<JSONObject>>;
     /**
      * Query the Kuzzle API and return a streamed response.
      * @param request The request to send to Kuzzle

package/lib/support/kuzzle.js

@@ -116,7 +116,7 @@ class KuzzleSDK {
         const currentToken = this.sdk.jwt;
         let apiKey;
         try {
-            apiKey = await this.security.createApiKey(userKuid, "Kourou impersonation token", { expiresIn: "2h", refresh: false });
+            apiKey = await this.security.createApiKey(userKuid, "Kourou impersonation token", { expiresIn: "2h", refresh: "wait_for" });
             this.sdk.jwt = apiKey._source.token;
             await callback();
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kourou",
   "description": "The CLI that helps you manage your Kuzzle instances",
-  "version": "0.28.1",
+  "version": "1.0.1",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "bin": {
     "kourou": "./bin/run"
@@ -19,64 +19,70 @@
     "test:functional:cucumber": "./node_modules/.bin/cucumber-js --fail-fast"
   },
   "dependencies": {
-    "@elastic/elasticsearch": "^7.12.0",
+    "@elastic/elasticsearch": "7.12.0",
     "@oclif/command": "1.8.*",
     "@oclif/config": "1.18.*",
     "@oclif/plugin-autocomplete": "1.3.*",
     "@oclif/plugin-help": "3.2.2",
-    "bluebird": "^3.7.2",
-    "chalk": "^4.1.0",
-    "chrono-node": "^2.4.2",
-    "cli-ux": "^5.5.1",
-    "inquirer": "^8.0.0",
-    "kepler-companion": "^1.1.3",
-    "kuzzle-sdk": "^7.10.1",
-    "kuzzle-vault": "^2.0.4",
-    "listr": "^0.14.3",
-    "lodash": "^4.17.21",
-    "ndjson": "^2.0.0",
-    "node-emoji": "^1.10.0",
-    "node-fetch": "^2.6.7",
-    "production": "^0.0.2",
-    "strip-json-comments": "^3.1.1",
-    "tar": "^6.1.11",
-    "tmp": "^0.2.1",
-    "tslib": "^2.3.1",
-    "typescript": "4.4.*",
-    "ws": "^8.8.0"
+    "bluebird": "3.7.2",
+    "chalk": "4.1.0",
+    "chrono-node": "2.4.2",
+    "cli-ux": "5.5.1",
+    "inquirer": "8.0.0",
+    "kepler-companion": "1.1.3",
+    "kuzzle-sdk": "7.14.0",
+    "kuzzle-vault": "2.0.4",
+    "listr": "0.14.3",
+    "lodash": "4.17.21",
+    "ndjson": "2.0.0",
+    "node-emoji": "1.10.0",
+    "node-fetch": "2.6.7",
+    "production": "0.0.2",
+    "strip-json-comments": "3.1.1",
+    "tar": "6.1.11",
+    "tmp": "0.2.1",
+    "tslib": "2.3.1",
+    "ws": "8.8.0",
+    "typescript": "4.4.*"
   },
   "devDependencies": {
-    "@istanbuljs/nyc-config-typescript": "^1.0.1",
-    "@oclif/dev-cli": "^1.26.0",
-    "@oclif/test": "^1.2.8",
-    "@types/bluebird": "^3.5.33",
-    "@types/chai": "^4.2.16",
-    "@types/compare-version": "^0.1.31",
-    "@types/inquirer": "^7.3.3",
-    "@types/listr": "^0.14.2",
-    "@types/mocha": "^8.2.2",
-    "@types/ndjson": "^2.0.0",
-    "@types/node": "^18.19.0",
-    "@types/node-emoji": "^1.8.1",
-    "@types/node-fetch": "^2.6.1",
-    "@types/tar": "^6.1.3",
-    "@types/tmp": "^0.2.0",
-    "@types/ws": "^8.5.3",
-    "@typescript-eslint/eslint-plugin": "^4.22.0",
-    "@typescript-eslint/parser": "^4.22.0",
-    "chai": "^4.3.4",
-    "cucumber": "^6.0.7",
-    "eslint": "^7.24.0",
-    "globby": "^11.0.3",
-    "mocha": "^8.3.2",
-    "nyc": "^15.1.0",
-    "prettier-eslint": "^12.0.0",
-    "should": "^13.2.3",
-    "source-map-support": "^0.5.19",
-    "ts-node": "10.9.*"
+    "@istanbuljs/nyc-config-typescript": "1.0.1",
+    "@oclif/dev-cli": "1.26.0",
+    "@oclif/test": "1.2.8",
+    "@types/bluebird": "3.5.33",
+    "@types/chai": "4.2.16",
+    "@types/compare-version": "0.1.31",
+    "@types/inquirer": "7.3.3",
+    "@types/listr": "0.14.2",
+    "@types/mocha": "8.2.2",
+    "@types/ndjson": "2.0.0",
+    "@types/node": "18.19.0",
+    "@types/node-emoji": "1.8.1",
+    "@types/node-fetch": "2.6.1",
+    "@types/tar": "6.1.3",
+    "@types/tmp": "0.2.0",
+    "@types/ws": "8.5.3",
+    "@typescript-eslint/eslint-plugin": "4.22.0",
+    "@typescript-eslint/parser": "4.22.0",
+    "chai": "4.3.4",
+    "cucumber": "6.0.7",
+    "eslint": "7.24.0",
+    "globby": "11.0.3",
+    "mocha": "8.3.2",
+    "nyc": "15.1.0",
+    "prettier-eslint": "12.0.0",
+    "should": "13.2.3",
+    "source-map-support": "0.5.19",
+    "ts-node": "10.9.*",
+    "semantic-release-config-kuzzle": "1.0.0",
+    "semantic-release-slack-bot": "4.0.2",
+    "@semantic-release/changelog": "6.0.3",
+    "@semantic-release/commit-analyzer": "13.0.0",
+    "@semantic-release/git": "10.0.1",
+    "@semantic-release/release-notes-generator": "14.0.1"
   },
   "engines": {
-    "node": ">=10.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "/bin",

package/lib/commands/paas/deploy.d.ts

@@ -1,17 +0,0 @@
-import { flags } from "@oclif/command";
-import { PaasKommand } from "../../support/PaasKommand";
-declare class PaasDeploy extends PaasKommand {
-    static description: string;
-    static flags: {
-        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-        token: flags.IOptionFlag<string | undefined>;
-        project: flags.IOptionFlag<string | undefined>;
-    };
-    static args: {
-        name: string;
-        description: string;
-        required: boolean;
-    }[];
-    runSafe(): Promise<void>;
-}
-export default PaasDeploy;

package/lib/commands/paas/deploy.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const PaasKommand_1 = require("../../support/PaasKommand");
-class PaasDeploy extends PaasKommand_1.PaasKommand {
-    async runSafe() {
-        const apiKey = await this.getCredentials();
-        await this.initPaasClient({ apiKey });
-        const user = await this.paas.auth.getCurrentUser();
-        this.logInfo(`Logged as "${user._id}" for project "${this.flags.project || this.getProject()}"`);
-        const [image, tag] = this.args.image.split(":");
-        this.logInfo(`Deploy application with image "${image}:${tag}"`);
-        await this.paas.query({
-            controller: "application",
-            action: "deploy",
-            environmentId: this.args.environment,
-            projectId: this.flags.project || this.getProject(),
-            applicationId: this.args.applicationId,
-            body: {
-                image: {
-                    name: image,
-                    tag,
-                },
-            },
-        });
-        this.logOk("Deployment in progress");
-    }
-}
-PaasDeploy.description = "Deploy a new version of the application in the PaaS";
-PaasDeploy.flags = {
-    help: command_1.flags.help(),
-    token: command_1.flags.string({
-        default: process.env.KUZZLE_PAAS_TOKEN,
-        description: "Authentication token",
-    }),
-    project: command_1.flags.string({
-        description: "Current PaaS project",
-    }),
-};
-PaasDeploy.args = [
-    {
-        name: "environment",
-        description: "Project environment name",
-        required: true,
-    },
-    {
-        name: "applicationId",
-        description: "Application Identifier",
-        required: true,
-    },
-    {
-        name: "image",
-        description: "Image name and hash as myimage:mytag",
-        required: true,
-    },
-];
-exports.default = PaasDeploy;

package/lib/commands/paas/elasticsearch/dump.d.ts

@@ -1,35 +0,0 @@
-import { flags } from "@oclif/command";
-import { PaasKommand } from "../../../support/PaasKommand";
-declare class PaasEsDump extends PaasKommand {
-    static description: string;
-    static flags: {
-        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-        project: flags.IOptionFlag<string | undefined>;
-        "batch-size": import("@oclif/parser/lib/flags").IOptionFlag<number>;
-    };
-    static args: {
-        name: string;
-        description: string;
-        required: boolean;
-    }[];
-    runSafe(): Promise<void>;
-    /**
-      * @description Get all indexes from the Elasticsearch of the PaaS application.
-      * @returns The indexes.
-      */
-    private getAllIndexes;
-    /**
-      * @description Dump documents from the Elasticsearch of the PaaS application.
-      * @param pitId ID of the PIT opened on Elasticsearch.
-      * @param searchAfter Cursor for dumping documents after a certain one.
-      * @returns The dumped documents.
-      */
-    private dumpDocuments;
-    private dumpAllDocuments;
-    /**
-      * @description Finish the document dumping session.
-      * @param pitId ID of the PIT opened on Elasticsearch.
-      */
-    private finishDump;
-}
-export default PaasEsDump;

package/lib/commands/paas/elasticsearch/dump.js

@@ -1,172 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const promises_1 = (0, tslib_1.__importDefault)(require("node:fs/promises"));
-const ndjson_1 = (0, tslib_1.__importDefault)(require("ndjson"));
-const command_1 = require("@oclif/command");
-const PaasKommand_1 = require("../../../support/PaasKommand");
-class PaasEsDump extends PaasKommand_1.PaasKommand {
-    async runSafe() {
-        // Check that the batch size is positive
-        if (this.flags["batch-size"] <= 0) {
-            this.logKo(`The batch size must be greater than zero. (Specified batch size: ${this.flags["batch-size"]})`);
-            process.exit(1);
-        }
-        // Log in to the PaaS
-        const apiKey = await this.getCredentials();
-        await this.initPaasClient({ apiKey });
-        const user = await this.paas.auth.getCurrentUser();
-        this.logInfo(`Logged as "${user._id}" for project "${this.flags.project || this.getProject()}"`);
-        // Create the dump directory
-        await promises_1.default.mkdir(this.args.dumpDirectory, { recursive: true });
-        // Dump the indexes
-        this.logInfo("Dumping Elasticsearch indexes...");
-        const indexesResult = await this.getAllIndexes();
-        await promises_1.default.writeFile(path_1.default.join(this.args.dumpDirectory, "indexes.json"), JSON.stringify(indexesResult));
-        this.logOk("Elasticsearch indexes dumped!");
-        // Dump all the documents
-        this.logInfo("Dumping Elasticsearch documents...");
-        await this.dumpAllDocuments();
-        this.logOk("Elasticsearch documents dumped!");
-        this.logOk(`The dumped files are available under "${path_1.default.resolve(this.args.dumpDirectory)}"`);
-    }
-    /**
-      * @description Get all indexes from the Elasticsearch of the PaaS application.
-      * @returns The indexes.
-      */
-    async getAllIndexes() {
-        const { result } = await this.paas.query({
-            controller: "application/storage",
-            action: "getIndexes",
-            environmentId: this.args.environment,
-            projectId: this.flags.project || this.getProject(),
-            applicationId: this.args.applicationId,
-            body: {},
-        });
-        return result;
-    }
-    /**
-      * @description Dump documents from the Elasticsearch of the PaaS application.
-      * @param pitId ID of the PIT opened on Elasticsearch.
-      * @param searchAfter Cursor for dumping documents after a certain one.
-      * @returns The dumped documents.
-      */
-    async dumpDocuments(pitId, searchAfter) {
-        const { result } = await this.paas.query({
-            controller: "application/storage",
-            action: "dumpDocuments",
-            environmentId: this.args.environment,
-            projectId: this.flags.project || this.getProject(),
-            applicationId: this.args.applicationId,
-            body: {
-                pitId,
-                searchAfter: JSON.stringify(searchAfter),
-                size: this.flags["batch-size"],
-            },
-        });
-        return result;
-    }
-    async dumpAllDocuments() {
-        // Prepare dumping all documents
-        let pitId = "";
-        let searchAfter = [];
-        let dumpedDocuments = 0;
-        let totalDocuments = 0;
-        const fd = await promises_1.default.open(path_1.default.join(this.args.dumpDirectory, "documents.jsonl"), "w");
-        const writeStream = fd.createWriteStream();
-        const ndjsonStream = ndjson_1.default.stringify();
-        writeStream.on("error", (error) => {
-            throw error;
-        });
-        ndjsonStream.on("data", (line) => {
-            writeStream.write(line);
-        });
-        const teardown = async () => {
-            // Finish the dump session if a PIT ID is set
-            if (pitId.length > 0) {
-                await this.finishDump(pitId);
-            }
-            // Close the open streams/file
-            writeStream.close();
-            await fd.close();
-        };
-        try {
-            // Dump the first batch
-            let result = await this.dumpDocuments(pitId, searchAfter);
-            let hits = result.hits.hits;
-            while (hits.length > 0) {
-                // Update the PIT ID and the cursor for the next dump
-                pitId = result.pit_id;
-                searchAfter = hits[hits.length - 1].sort;
-                // Save the documents
-                for (let i = 0; i < hits.length; ++i) {
-                    ndjsonStream.write(hits[i]);
-                }
-                dumpedDocuments += hits.length;
-                totalDocuments = result.hits.total.value;
-                this.logInfo(`Dumping Elasticsearch documents: ${Math.floor(dumpedDocuments / totalDocuments * 100)}% (${dumpedDocuments}/${totalDocuments})`);
-                // Dump the next batch
-                result = await this.dumpDocuments(pitId, searchAfter);
-                hits = result.hits.hits;
-            }
-        }
-        catch (error) {
-            teardown();
-            this.logKo(`Error while dumping the documents: ${error}`);
-            process.exit(1);
-        }
-        // Finish the dump
-        teardown();
-    }
-    /**
-      * @description Finish the document dumping session.
-      * @param pitId ID of the PIT opened on Elasticsearch.
-      */
-    async finishDump(pitId) {
-        try {
-            await this.paas.query({
-                controller: "application/storage",
-                action: "finishDumpDocuments",
-                environmentId: this.args.environment,
-                projectId: this.flags.project || this.getProject(),
-                applicationId: this.args.applicationId,
-                body: {
-                    pitId,
-                },
-            });
-        }
-        catch (error) {
-            this.logInfo(`Unable to cleanly finish the dump session: ${error}`);
-        }
-    }
-}
-PaasEsDump.description = "Dump data from the Elasticsearch of a PaaS application";
-PaasEsDump.flags = {
-    help: command_1.flags.help(),
-    project: command_1.flags.string({
-        description: "Current PaaS project",
-    }),
-    "batch-size": command_1.flags.integer({
-        description: "Maximum batch size",
-        default: 2000,
-    }),
-};
-PaasEsDump.args = [
-    {
-        name: "environment",
-        description: "Project environment name",
-        required: true,
-    },
-    {
-        name: "applicationId",
-        description: "Application Identifier",
-        required: true,
-    },
-    {
-        name: "dumpDirectory",
-        description: "Directory where to store dump files",
-        required: true,
-    }
-];
-exports.default = PaasEsDump;

package/lib/commands/paas/init.d.ts

@@ -1,14 +0,0 @@
-import { PaasKommand } from "../../support/PaasKommand";
-declare class PaasInit extends PaasKommand {
-    static description: string;
-    static flags: {
-        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-    };
-    static args: {
-        name: string;
-        description: string;
-        required: boolean;
-    }[];
-    runSafe(): Promise<void>;
-}
-export default PaasInit;

package/lib/commands/paas/init.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const fs_1 = (0, tslib_1.__importDefault)(require("fs"));
-const command_1 = require("@oclif/command");
-const PaasKommand_1 = require("../../support/PaasKommand");
-class PaasInit extends PaasKommand_1.PaasKommand {
-    async runSafe() {
-        const packageJsonPath = path_1.default.join(process.cwd(), "package.json");
-        if (!fs_1.default.existsSync(packageJsonPath)) {
-            throw new Error(`Cannot find package json in current directory. (${packageJsonPath})`);
-        }
-        const packageJson = JSON.parse(fs_1.default.readFileSync(packageJsonPath, "utf8"));
-        this.logInfo('Add the "kuzzle" property inside project package.json.');
-        packageJson.kuzzle = {
-            paas: {
-                project: this.args.project,
-            },
-        };
-        fs_1.default.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
-    }
-}
-PaasInit.description = "Initialize a PaaS project in current directory";
-PaasInit.flags = {
-    help: command_1.flags.help(),
-};
-PaasInit.args = [
-    {
-        name: "project",
-        description: "Kuzzle PaaS project name",
-        required: true,
-    },
-];
-exports.default = PaasInit;

package/lib/commands/paas/logs.d.ts

@@ -1,42 +0,0 @@
-import { flags } from "@oclif/command";
-import chalk from "chalk";
-import { PaasKommand } from "../../support/PaasKommand";
-declare class PaasLogs extends PaasKommand {
-    static description: string;
-    static flags: {
-        follow: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        timestamp: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-        project: flags.IOptionFlag<string | undefined>;
-        tail: import("@oclif/parser/lib/flags").IOptionFlag<number | undefined>;
-        podName: flags.IOptionFlag<string | undefined>;
-        since: flags.IOptionFlag<string | undefined>;
-        until: flags.IOptionFlag<string | undefined>;
-    };
-    static args: {
-        name: string;
-        description: string;
-        required: boolean;
-    }[];
-    /**
-     * Allowed colors for pod names.
-     */
-    private readonly allColors;
-    /**
-     * Available colors for pod names.
-     */
-    private availableColors;
-    /**
-     * The color to use for pod names.
-     * @private
-     */
-    private podsColor;
-    runSafe(): Promise<void>;
-    /**
-     * Returns the color to use for a pod name.
-     * @param podName Name of the pod.
-     * @returns The color to use.
-     */
-    getPodColor(podName: string): chalk.Chalk;
-}
-export default PaasLogs;

package/lib/commands/paas/logs.js

@@ -1,181 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const readline = (0, tslib_1.__importStar)(require("readline"));
-const command_1 = require("@oclif/command");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
-const chrono = (0, tslib_1.__importStar)(require("chrono-node"));
-const PaasKommand_1 = require("../../support/PaasKommand");
-class PaasLogs extends PaasKommand_1.PaasKommand {
-    constructor() {
-        super(...arguments);
-        /**
-         * Allowed colors for pod names.
-         */
-        this.allColors = [
-            chalk_1.default.red,
-            chalk_1.default.green,
-            chalk_1.default.yellow,
-            chalk_1.default.blue,
-            chalk_1.default.magenta,
-            chalk_1.default.cyan,
-            chalk_1.default.gray,
-        ];
-        /**
-         * Available colors for pod names.
-         */
-        this.availableColors = [...this.allColors];
-        /**
-         * The color to use for pod names.
-         * @private
-         */
-        this.podsColor = new Map();
-    }
-    async runSafe() {
-        var e_1, _a;
-        const apiKey = await this.getCredentials();
-        await this.initPaasClient({ apiKey });
-        const user = await this.paas.auth.getCurrentUser();
-        this.logInfo(`Logged as "${user._id}" for project "${this.flags.project || this.getProject()}"`);
-        const separator = "\t";
-        // Parse the time arguments
-        const since = this.flags.since
-            ? chrono.parseDate(this.flags.since).toISOString()
-            : undefined;
-        const until = this.flags.until
-            ? chrono.parseDate(this.flags.until).toISOString()
-            : undefined;
-        // Perform the streamed request
-        const incomingMessage = await this.paas.queryHttpStream({
-            controller: "application",
-            action: "logs",
-            environmentId: this.args.environment,
-            projectId: this.flags.project || this.getProject(),
-            applicationId: this.args.application,
-            follow: this.flags.follow,
-            tailLines: this.flags.tail,
-            podName: this.flags.podName,
-            since,
-            until,
-        });
-        // Don't continue if an error occurred
-        if (incomingMessage.statusCode !== 200) {
-            return new Promise((_, reject) => {
-                // Collect the whole response body
-                let responseBody = "";
-                incomingMessage.on("data", (buffer) => {
-                    responseBody += buffer.toString();
-                });
-                incomingMessage.on("end", () => {
-                    let response;
-                    try {
-                        response = JSON.parse(responseBody);
-                    }
-                    catch (error) {
-                        reject(new Error("An error occurred while parsing the error response body from Kuzzle"));
-                        return;
-                    }
-                    reject(response.error);
-                });
-            });
-        }
-        // Read the response line by line
-        const lineStream = readline.createInterface({
-            input: incomingMessage,
-            crlfDelay: Infinity,
-            terminal: false,
-        });
-        try {
-            // Display the response
-            for (var lineStream_1 = (0, tslib_1.__asyncValues)(lineStream), lineStream_1_1; lineStream_1_1 = await lineStream_1.next(), !lineStream_1_1.done;) {
-                const line = lineStream_1_1.value;
-                try {
-                    const data = JSON.parse(line);
-                    // Exclude logs that are empty or that are not from a pod
-                    if (!data.content || !data.podName) {
-                        continue;
-                    }
-                    // Get the pod color
-                    const podColor = this.getPodColor(data.podName);
-                    // Display the log
-                    const timestamp = this.flags.timestamp
-                        ? `[${new Date(data.timeStamp).toLocaleString()}] `
-                        : "";
-                    const name = podColor(`${data.podName}${separator}`);
-                    this.log(`${timestamp}${name}| ${data.content}`);
-                }
-                catch (error) {
-                    this.logKo(`Error while parsing log: ${error} (Received: "${line}")`);
-                }
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (lineStream_1_1 && !lineStream_1_1.done && (_a = lineStream_1.return)) await _a.call(lineStream_1);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-    }
-    /**
-     * Returns the color to use for a pod name.
-     * @param podName Name of the pod.
-     * @returns The color to use.
-     */
-    getPodColor(podName) {
-        // Attempt to get the color from the list
-        let podColor = this.podsColor.get(podName);
-        if (!podColor) {
-            // Get a random color
-            const index = Math.floor(Math.random() * this.availableColors.length);
-            [podColor] = this.availableColors.splice(index, 1);
-            this.podsColor.set(podName, podColor);
-            // If all colors are used, reset the available colors
-            if (this.availableColors.length === 0) {
-                this.availableColors = [...this.allColors];
-            }
-        }
-        return podColor;
-    }
-}
-PaasLogs.description = "Show logs of the targeted application";
-PaasLogs.flags = {
-    follow: command_1.flags.boolean({
-        char: "f",
-        description: "Follow log output",
-    }),
-    timestamp: command_1.flags.boolean({
-        char: "t",
-        description: "Show timestamp",
-    }),
-    help: command_1.flags.help(),
-    project: command_1.flags.string({
-        description: "Current PaaS project",
-    }),
-    tail: command_1.flags.integer({
-        char: "n",
-        description: "Number of lines to show from the end of the logs",
-    }),
-    podName: command_1.flags.string({
-        description: "Name of the pod to show logs from",
-    }),
-    since: command_1.flags.string({
-        description: "Display logs from a specific absolute (e.g. 2022/12/02 09:41) or relative (e.g. a minute ago) time",
-    }),
-    until: command_1.flags.string({
-        description: "Display logs until a specific absolute (e.g. 2022/12/02 09:41) or relative (e.g. a minute ago) time",
-    }),
-};
-PaasLogs.args = [
-    {
-        name: "environment",
-        description: "Kuzzle PaaS environment",
-        required: true,
-    },
-    {
-        name: "application",
-        description: "Kuzzle PaaS application",
-        required: true,
-    },
-];
-exports.default = PaasLogs;

package/lib/commands/paas/snapshots/cat.d.ts

@@ -1,18 +0,0 @@
-import { flags } from "@oclif/command";
-import { PaasKommand } from "../../../support/PaasKommand";
-declare class PaasSnapshotsCat extends PaasKommand {
-    static description: string;
-    static flags: {
-        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-        token: flags.IOptionFlag<string | undefined>;
-        project: flags.IOptionFlag<string | undefined>;
-    };
-    static args: {
-        name: string;
-        description: string;
-        required: boolean;
-    }[];
-    static examples: string[];
-    runSafe(): Promise<void>;
-}
-export default PaasSnapshotsCat;

package/lib/commands/paas/snapshots/cat.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const PaasKommand_1 = require("../../../support/PaasKommand");
-class PaasSnapshotsCat extends PaasKommand_1.PaasKommand {
-    async runSafe() {
-        const apiKey = await this.getCredentials();
-        await this.initPaasClient({ apiKey });
-        const user = await this.paas.auth.getCurrentUser();
-        this.logInfo(`Logged as "${user._id}" for project "${this.flags.project || this.getProject()}"`);
-        const { result } = await this.paas.query({
-            controller: "application",
-            action: "snapshots",
-            environmentId: this.args.environment,
-            projectId: this.flags.project || this.getProject(),
-            applicationId: this.args.applicationId,
-            body: {},
-        });
-        this.logInfo(JSON.stringify(result, null, 2));
-    }
-}
-PaasSnapshotsCat.description = "List all snapshots for a given kuzzle application in a environment";
-PaasSnapshotsCat.flags = {
-    help: command_1.flags.help(),
-    token: command_1.flags.string({
-        default: process.env.KUZZLE_PAAS_TOKEN,
-        description: "Authentication token",
-    }),
-    project: command_1.flags.string({
-        description: "Current PaaS project",
-    }),
-};
-PaasSnapshotsCat.args = [
-    {
-        name: "environment",
-        description: "Project environment name",
-        required: true,
-    },
-    {
-        name: "applicationId",
-        description: "Application Identifier",
-        required: true,
-    }
-];
-PaasSnapshotsCat.examples = ["kourou paas:snapshots:cat --project paas-project-myproject api main"];
-exports.default = PaasSnapshotsCat;

package/lib/commands/paas/snapshots/dump.d.ts

@@ -1,18 +0,0 @@
-import { flags } from "@oclif/command";
-import { PaasKommand } from "../../../support/PaasKommand";
-declare class PaasSnapshotsDump extends PaasKommand {
-    static description: string;
-    static flags: {
-        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-        token: flags.IOptionFlag<string | undefined>;
-        project: flags.IOptionFlag<string | undefined>;
-    };
-    static args: {
-        name: string;
-        description: string;
-        required: boolean;
-    }[];
-    static examples: string[];
-    runSafe(): Promise<void>;
-}
-export default PaasSnapshotsDump;

package/lib/commands/paas/snapshots/dump.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const PaasKommand_1 = require("../../../support/PaasKommand");
-class PaasSnapshotsDump extends PaasKommand_1.PaasKommand {
-    async runSafe() {
-        const apiKey = await this.getCredentials();
-        await this.initPaasClient({ apiKey });
-        const user = await this.paas.auth.getCurrentUser();
-        this.logInfo(`Logged as "${user._id}" for project "${this.flags.project || this.getProject()}"`);
-        const { result } = await this.paas.query({
-            controller: "application",
-            action: "dump",
-            environmentId: this.args.environment,
-            projectId: this.flags.project || this.getProject(),
-            applicationId: this.args.applicationId,
-            body: {},
-        });
-        this.logOk(result.body);
-    }
-}
-PaasSnapshotsDump.description = "Create a new snapshot of the current application state";
-PaasSnapshotsDump.flags = {
-    help: command_1.flags.help(),
-    token: command_1.flags.string({
-        default: process.env.KUZZLE_PAAS_TOKEN,
-        description: "Authentication token",
-    }),
-    project: command_1.flags.string({
-        description: "Current PaaS project",
-    }),
-};
-PaasSnapshotsDump.args = [
-    {
-        name: "environment",
-        description: "Project environment name",
-        required: true,
-    },
-    {
-        name: "applicationId",
-        description: "Application Identifier",
-        required: true,
-    }
-];
-PaasSnapshotsDump.examples = ["kourou paas:snapshots:dump --project paas-project-myproject api main"];
-exports.default = PaasSnapshotsDump;

package/lib/commands/paas/snapshots/restore.d.ts

@@ -1,18 +0,0 @@
-import { flags } from "@oclif/command";
-import { PaasKommand } from "../../../support/PaasKommand";
-declare class PaasSnapshotsRestore extends PaasKommand {
-    static description: string;
-    static flags: {
-        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-        token: flags.IOptionFlag<string | undefined>;
-        project: flags.IOptionFlag<string | undefined>;
-    };
-    static args: {
-        name: string;
-        description: string;
-        required: boolean;
-    }[];
-    static examples: string[];
-    runSafe(): Promise<void>;
-}
-export default PaasSnapshotsRestore;

package/lib/commands/paas/snapshots/restore.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const PaasKommand_1 = require("../../../support/PaasKommand");
-class PaasSnapshotsRestore extends PaasKommand_1.PaasKommand {
-    async runSafe() {
-        const apiKey = await this.getCredentials();
-        await this.initPaasClient({ apiKey });
-        const user = await this.paas.auth.getCurrentUser();
-        this.logInfo(`Logged as "${user._id}" for project "${this.flags.project || this.getProject()}"`);
-        await this.paas.query({
-            controller: "application",
-            action: "restore",
-            environmentId: this.args.environment,
-            projectId: this.flags.project || this.getProject(),
-            applicationId: this.args.applicationId,
-            snapshotId: this.args.snapshotId
-        });
-        this.logInfo("Ok");
-    }
-}
-PaasSnapshotsRestore.description = "Restore a snapshot of the current application state";
-PaasSnapshotsRestore.flags = {
-    help: command_1.flags.help(),
-    token: command_1.flags.string({
-        default: process.env.KUZZLE_PAAS_TOKEN,
-        description: "Authentication token",
-    }),
-    project: command_1.flags.string({
-        description: "Current PaaS project",
-    }),
-};
-PaasSnapshotsRestore.args = [
-    {
-        name: "environment",
-        description: "Project environment name",
-        required: true,
-    },
-    {
-        name: "applicationId",
-        description: "Application Identifier",
-        required: true,
-    },
-    {
-        name: "snapshotId",
-        description: "Snapshot Identifier",
-        required: true,
-    }
-];
-PaasSnapshotsRestore.examples = ["kourou paas:snapshots:restore --project paas-project-myproject api main snapshot-id"];
-exports.default = PaasSnapshotsRestore;