kourou 0.24.2 → 0.25.0

package/lib/commands/collection/import.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const fs_1 = tslib_1.__importDefault(require("fs"));
+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 common_1 = require("../../common");
 const kuzzle_1 = require("../../support/kuzzle");
@@ -10,31 +10,31 @@ const restore_collection_1 = require("../../support/restore-collection");
 class CollectionImport extends common_1.Kommand {
     async runSafe() {
         this.logInfo(`Start importing dump from ${this.args.path}`);
-        if (!this.flags['no-mappings']) {
-            const mappingsPath = path_1.default.join(this.args.path, 'mappings.json');
-            const dump = JSON.parse(fs_1.default.readFileSync(mappingsPath, 'utf8'));
+        if (!this.flags["no-mappings"]) {
+            const mappingsPath = path_1.default.join(this.args.path, "mappings.json");
+            const dump = JSON.parse(fs_1.default.readFileSync(mappingsPath, "utf8"));
             await (0, restore_collection_1.restoreCollectionMappings)(this.sdk, dump, this.flags.index, this.flags.collection);
         }
-        const { index, collection, total } = await (0, restore_collection_1.restoreCollectionData)(this.sdk, this.log.bind(this), Number(this.flags['batch-size']), path_1.default.join(this.args.path, 'documents.jsonl'), this.flags.index, this.flags.collection);
+        const { index, collection, total } = await (0, restore_collection_1.restoreCollectionData)(this.sdk, this.log.bind(this), Number(this.flags["batch-size"]), path_1.default.join(this.args.path, "documents.jsonl"), this.flags.index, this.flags.collection);
         this.logOk(`Successfully imported ${total} documents from "${this.args.path}" in "${index}:${collection}"`);
     }
 }
 exports.default = CollectionImport;
 CollectionImport.keepAuth = true;
-CollectionImport.description = 'Imports a collection';
-CollectionImport.flags = Object.assign(Object.assign({ help: command_1.flags.help({}), 'batch-size': command_1.flags.string({
-        description: 'Maximum batch size (see limits.documentsWriteCount config)',
-        default: '200'
+CollectionImport.description = "Imports a collection";
+CollectionImport.flags = Object.assign(Object.assign({ help: command_1.flags.help({}), "batch-size": command_1.flags.string({
+        description: "Maximum batch size (see limits.documentsWriteCount config)",
+        default: "200",
     }), index: command_1.flags.string({
-        description: 'If set, override the index destination name',
+        description: "If set, override the index destination name",
     }), collection: command_1.flags.string({
-        description: 'If set, override the collection destination name',
-    }), 'no-mappings': command_1.flags.boolean({
-        description: 'Skip collection mappings'
+        description: "If set, override the collection destination name",
+    }), "no-mappings": command_1.flags.boolean({
+        description: "Skip collection mappings",
     }) }, kuzzle_1.kuzzleFlags), { protocol: command_1.flags.string({
-        description: 'Kuzzle protocol (http or websocket)',
-        default: 'ws',
+        description: "Kuzzle protocol (http or websocket)",
+        default: "ws",
     }) });
 CollectionImport.args = [
-    { name: 'path', description: 'Dump directory path', required: true },
+    { name: "path", description: "Dump directory path", required: true },
 ];

package/lib/commands/collection/migrate.d.ts

@@ -0,0 +1,27 @@
+import { flags } from "@oclif/command";
+import { Kommand } from "../../common";
+export default class CollectionMigrate extends Kommand {
+    static keepAuth: boolean;
+    static description: string;
+    static flags: {
+        protocol: flags.IOptionFlag<string>;
+        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>;
+        as: flags.IOptionFlag<string | undefined>;
+        "api-key": flags.IOptionFlag<string | undefined>;
+        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+        "batch-size": flags.IOptionFlag<string>;
+        index: flags.IOptionFlag<string | undefined>;
+        collection: flags.IOptionFlag<string | undefined>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    runSafe(): Promise<void>;
+    private getMigrationFunction;
+}

package/lib/commands/collection/migrate.js

@@ -0,0 +1,43 @@
+"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 common_1 = require("../../common");
+const kuzzle_1 = require("../../support/kuzzle");
+const restore_collection_1 = require("../../support/restore-collection");
+class CollectionMigrate extends common_1.Kommand {
+    async runSafe() {
+        this.logInfo(`Start migration documents with ${this.args.script} from ${this.args.path}`);
+        const migrateDocument = this.getMigrationFunction();
+        const { index, collection, total } = await (0, restore_collection_1.restoreCollectionData)(this.sdk, this.log.bind(this), Number(this.flags["batch-size"]), path_1.default.join(this.args.path, "documents.jsonl"), this.flags.index, this.flags.collection, migrateDocument);
+        this.logOk(`Successfully migrated ${total} documents from "${this.args.path}" in "${index}:${collection}"`);
+    }
+    getMigrationFunction() {
+        const migrationScript = fs_1.default.readFileSync(this.args.script, "utf8");
+        let migrationFunction;
+        {
+            migrationFunction = eval(`var f = ${migrationScript}; f`);
+        }
+        return migrationFunction;
+    }
+}
+exports.default = CollectionMigrate;
+CollectionMigrate.keepAuth = true;
+CollectionMigrate.description = "Migrate a collection";
+CollectionMigrate.flags = Object.assign(Object.assign({ help: command_1.flags.help({}), "batch-size": command_1.flags.string({
+        description: "Maximum batch size (see limits.documentsWriteCount config)",
+        default: "200",
+    }), index: command_1.flags.string({
+        description: "If set, override the index destination name",
+    }), collection: command_1.flags.string({
+        description: "If set, override the collection destination name",
+    }) }, kuzzle_1.kuzzleFlags), { protocol: command_1.flags.string({
+        description: "Kuzzle protocol (http or websocket)",
+        default: "ws",
+    }) });
+CollectionMigrate.args = [
+    { name: "script", description: "Migration script path", required: true },
+    { name: "path", description: "Collection dump path", required: true },
+];

package/lib/commands/config/diff.d.ts

@@ -1,4 +1,4 @@
-import { Kommand } from '../../common';
+import { Kommand } from "../../common";
 export declare class ConfigKeyDiff extends Kommand {
     static initSdk: boolean;
     static description: string;

package/lib/commands/config/diff.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigKeyDiff = void 0;
 const tslib_1 = require("tslib");
 const command_1 = require("@oclif/command");
-const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const fs_1 = tslib_1.__importDefault(require("fs"));
-const strip_json_comments_1 = tslib_1.__importDefault(require("strip-json-comments"));
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
+const fs_1 = (0, tslib_1.__importDefault)(require("fs"));
+const strip_json_comments_1 = (0, tslib_1.__importDefault)(require("strip-json-comments"));
 const common_1 = require("../../common");
 class ConfigKeyDiff extends common_1.Kommand {
     async runSafe() {
@@ -15,19 +15,19 @@ class ConfigKeyDiff extends common_1.Kommand {
         if (!fs_1.default.existsSync(this.args.second)) {
             throw new Error(`File "${this.args.second}" does not exists`);
         }
-        const first = JSON.parse((0, strip_json_comments_1.default)(fs_1.default.readFileSync(this.args.first, 'utf8')));
-        const second = JSON.parse((0, strip_json_comments_1.default)(fs_1.default.readFileSync(this.args.second, 'utf8')));
+        const first = JSON.parse((0, strip_json_comments_1.default)(fs_1.default.readFileSync(this.args.first, "utf8")));
+        const second = JSON.parse((0, strip_json_comments_1.default)(fs_1.default.readFileSync(this.args.second, "utf8")));
         const changes = this._keyChanges(first, second);
         if (lodash_1.default.isEmpty(changes)) {
-            this.logOk('No differences between keys in the provided configurations');
+            this.logOk("No differences between keys in the provided configurations");
             return;
         }
-        this.logInfo('Found differences between keys in the provided configurations. In the second file:');
+        this.logInfo("Found differences between keys in the provided configurations. In the second file:");
         for (const [path, change] of Object.entries(changes)) {
             this.log(` - key "${path}" ${change}`);
         }
         if (this.flags.strict) {
-            throw new Error('Provided configuration contains different keys');
+            throw new Error("Provided configuration contains different keys");
         }
     }
     // Returns path who had changed between two objects (inspired by https://gist.github.com/Yimiprod/7ee176597fef230d1451)
@@ -39,18 +39,20 @@ class ConfigKeyDiff extends common_1.Kommand {
                     const ar = [];
                     const ar2 = [];
                     ar.concat(ar2);
-                    changes[[...path, key].join('.')] = 'was removed';
+                    changes[[...path, key].join(".")] = "was removed";
                 }
             }
             for (const key of Object.keys(_object)) {
                 if (_base[key] === undefined) {
-                    changes[[...path, key].join('.')] = 'was added';
+                    changes[[...path, key].join(".")] = "was added";
                 }
-                else if (!lodash_1.default.isEqual(_object[key], _base[key]) && lodash_1.default.isObject(_object[key]) && lodash_1.default.isObject(_base[key])) {
+                else if (!lodash_1.default.isEqual(_object[key], _base[key]) &&
+                    lodash_1.default.isObject(_object[key]) &&
+                    lodash_1.default.isObject(_base[key])) {
                     walkObject(_base[key], _object[key], [...path, key]);
                 }
                 else if (this.flags.values && _base[key] !== _object[key]) {
-                    changes[[...path, key].join('.')] = `value is "${_object[key]}" and was "${_base[key]}"`;
+                    changes[[...path, key].join(".")] = `value is "${_object[key]}" and was "${_base[key]}"`;
                 }
             }
         };
@@ -60,21 +62,25 @@ class ConfigKeyDiff extends common_1.Kommand {
 }
 exports.ConfigKeyDiff = ConfigKeyDiff;
 ConfigKeyDiff.initSdk = false;
-ConfigKeyDiff.description = 'Returns differences between two Kuzzle configuration files (kuzzlerc)';
+ConfigKeyDiff.description = "Returns differences between two Kuzzle configuration files (kuzzlerc)";
 ConfigKeyDiff.examples = [
-    'kourou config:diff config/local/kuzzlerc config/production/kuzzlerc'
+    "kourou config:diff config/local/kuzzlerc config/production/kuzzlerc",
 ];
 ConfigKeyDiff.flags = {
     strict: command_1.flags.boolean({
-        description: 'Exit with an error if differences are found',
-        default: false
+        description: "Exit with an error if differences are found",
+        default: false,
     }),
     values: command_1.flags.boolean({
-        description: 'Also displays value changes',
-        default: false
-    })
+        description: "Also displays value changes",
+        default: false,
+    }),
 };
 ConfigKeyDiff.args = [
-    { name: 'first', description: 'First configuration file', required: true },
-    { name: 'second', description: 'Second configuration file', required: true },
+    { name: "first", description: "First configuration file", required: true },
+    {
+        name: "second",
+        description: "Second configuration file",
+        required: true,
+    },
 ];

package/lib/commands/document/search.d.ts

@@ -1,5 +1,5 @@
-import { flags } from '@oclif/command';
-import { Kommand } from '../../common';
+import { flags } from "@oclif/command";
+import { Kommand } from "../../common";
 export default class DocumentSearch extends Kommand {
     static description: string;
     static examples: string[];
@@ -11,7 +11,7 @@ export default class DocumentSearch extends Kommand {
         password: flags.IOptionFlag<string | undefined>;
         protocol: flags.IOptionFlag<string>;
         as: flags.IOptionFlag<string | undefined>;
-        'api-key': flags.IOptionFlag<string | undefined>;
+        "api-key": flags.IOptionFlag<string | undefined>;
         sort: flags.IOptionFlag<string>;
         from: flags.IOptionFlag<string | undefined>;
         size: flags.IOptionFlag<string | undefined>;

package/lib/commands/document/search.js

@@ -6,8 +6,8 @@ const kuzzle_1 = require("../../support/kuzzle");
 class DocumentSearch extends common_1.Kommand {
     async runSafe() {
         let request = {
-            controller: 'document',
-            action: 'search',
+            controller: "document",
+            action: "search",
             index: this.args.index,
             collection: this.args.collection,
             from: this.flags.from,
@@ -15,9 +15,9 @@ class DocumentSearch extends common_1.Kommand {
             scroll: this.flags.scroll,
             lang: this.flags.lang,
             body: {
-                query: this.parseJs(this.args.query || '{}'),
-                sort: this.parseJs(this.flags.sort)
-            }
+                query: this.parseJs(this.args.query || "{}"),
+                sort: this.parseJs(this.flags.sort),
+            },
         };
         // allow to edit request before send
         if (this.flags.editor) {
@@ -32,29 +32,29 @@ class DocumentSearch extends common_1.Kommand {
     }
 }
 exports.default = DocumentSearch;
-DocumentSearch.description = 'Searches for documents';
+DocumentSearch.description = "Searches for documents";
 DocumentSearch.examples = [
-    'kourou document:search iot sensors \'{ equals: { name: "corona" } }\'',
-    'kourou document:search iot sensors \'{ match: { name: "cOrOnna" } }\' -a lang=elasticsearch',
-    'kourou document:search iot sensors --editor',
+    "kourou document:search iot sensors '{ equals: { name: \"corona\" } }'",
+    "kourou document:search iot sensors '{ match: { name: \"cOrOnna\" } }' -a lang=elasticsearch",
+    "kourou document:search iot sensors --editor",
 ];
 DocumentSearch.flags = Object.assign({ sort: command_1.flags.string({
-        description: 'Sort in JS or JSON format.',
-        default: '{}'
+        description: "Sort in JS or JSON format.",
+        default: "{}",
     }), from: command_1.flags.string({
-        description: 'Optional offset'
+        description: "Optional offset",
     }), size: command_1.flags.string({
-        description: 'Optional page size',
+        description: "Optional page size",
     }), scroll: command_1.flags.string({
-        description: 'Optional scroll TTL'
+        description: "Optional scroll TTL",
     }), lang: command_1.flags.string({
-        description: 'Specify the query language to use',
-        default: 'koncorde'
+        description: "Specify the query language to use",
+        default: "koncorde",
     }), editor: command_1.flags.boolean({
-        description: 'Open an editor (EDITOR env variable) to edit the request before sending'
+        description: "Open an editor (EDITOR env variable) to edit the request before sending",
     }), help: command_1.flags.help() }, kuzzle_1.kuzzleFlags);
 DocumentSearch.args = [
-    { name: 'index', description: 'Index name', required: true },
-    { name: 'collection', description: 'Collection name', required: true },
-    { name: 'query', description: 'Search query in JS or JSON format.' },
+    { name: "index", description: "Index name", required: true },
+    { name: "collection", description: "Collection name", required: true },
+    { name: "query", description: "Search query in JS or JSON format." },
 ];

package/lib/commands/es/aliases/cat.d.ts

@@ -0,0 +1,12 @@
+import { flags } from '@oclif/command';
+import { Kommand } from '../../../common';
+export default class EsListAliases extends Kommand {
+    static initSdk: boolean;
+    static description: string;
+    static flags: {
+        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+        node: flags.IOptionFlag<string>;
+        grep: flags.IOptionFlag<string | undefined>;
+    };
+    runSafe(): Promise<void>;
+}

package/lib/commands/es/aliases/cat.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = require("@oclif/command");
+const elasticsearch_1 = require("@elastic/elasticsearch");
+const common_1 = require("../../../common");
+class EsListAliases extends common_1.Kommand {
+    async runSafe() {
+        const esClient = new elasticsearch_1.Client({ node: this.flags.node });
+        try {
+            const { body } = await esClient.cat.aliases({ format: 'json' });
+            const elements = body
+                .map((e) => ({ index: e.index, alias: e.alias }))
+                .filter((e) => (this.flags.grep ? e.alias.match(new RegExp(this.flags.grep)) : true))
+                .sort();
+            this.log(JSON.stringify(elements, null, 2));
+        }
+        catch (error) {
+            console.log(error);
+        }
+    }
+}
+exports.default = EsListAliases;
+EsListAliases.initSdk = false;
+EsListAliases.description = 'Lists available ES aliases';
+EsListAliases.flags = {
+    help: command_1.flags.help(),
+    node: command_1.flags.string({
+        char: 'n',
+        description: 'Elasticsearch server URL',
+        default: 'http://localhost:9200',
+    }),
+    grep: command_1.flags.string({
+        char: 'g',
+        description: 'Match output with pattern',
+    }),
+};

package/lib/commands/es/indices/cat.d.ts

@@ -1,5 +1,5 @@
-import { flags } from '@oclif/command';
-import { Kommand } from '../../../common';
+import { flags } from "@oclif/command";
+import { Kommand } from "../../../common";
 export default class EsListIndex extends Kommand {
     static initSdk: boolean;
     static description: string;

package/lib/commands/es/indices/cat.js

@@ -7,11 +7,11 @@ class EsListIndex extends common_1.Kommand {
     async runSafe() {
         const esClient = new elasticsearch_1.Client({ node: this.flags.node });
         try {
-            const { body } = await esClient.cat.indices({ format: 'json' });
+            const { body } = await esClient.cat.indices({ format: "json" });
             // nice typescript destructuring syntax (:
             const indexes = body
                 .map(({ index }) => index)
-                .filter((index) => (this.flags.grep ? index.match(new RegExp(this.flags.grep)) : true))
+                .filter((index) => this.flags.grep ? index.match(new RegExp(this.flags.grep)) : true)
                 .sort();
             this.log(JSON.stringify(indexes, null, 2));
         }
@@ -22,16 +22,16 @@ class EsListIndex extends common_1.Kommand {
 }
 exports.default = EsListIndex;
 EsListIndex.initSdk = false;
-EsListIndex.description = 'Lists available ES indexes';
+EsListIndex.description = "Lists available ES indexes";
 EsListIndex.flags = {
     help: command_1.flags.help(),
     node: command_1.flags.string({
-        char: 'n',
-        description: 'Elasticsearch server URL',
-        default: 'http://localhost:9200',
+        char: "n",
+        description: "Elasticsearch server URL",
+        default: "http://localhost:9200",
     }),
     grep: command_1.flags.string({
-        char: 'g',
-        description: 'Match output with pattern',
+        char: "g",
+        description: "Match output with pattern",
     }),
 };

package/lib/commands/es/indices/get.d.ts

@@ -1,5 +1,5 @@
-import { flags } from '@oclif/command';
-import { Kommand } from '../../../common';
+import { flags } from "@oclif/command";
+import { Kommand } from "../../../common";
 export default class EsGet extends Kommand {
     static initSdk: boolean;
     static description: string;

package/lib/commands/es/indices/get.js

@@ -8,7 +8,7 @@ class EsGet extends common_1.Kommand {
         const esClient = new elasticsearch_1.Client({ node: this.flags.node });
         const esRequest = {
             index: this.args.index,
-            id: this.args.id
+            id: this.args.id,
         };
         const { body } = await esClient.get(esRequest);
         this.log(JSON.stringify(body, null, 2));
@@ -16,16 +16,16 @@ class EsGet extends common_1.Kommand {
 }
 exports.default = EsGet;
 EsGet.initSdk = false;
-EsGet.description = 'Gets a document from ES';
+EsGet.description = "Gets a document from ES";
 EsGet.flags = {
     help: command_1.flags.help(),
     node: command_1.flags.string({
-        char: 'n',
-        description: 'Elasticsearch server URL',
-        default: 'http://localhost:9200',
+        char: "n",
+        description: "Elasticsearch server URL",
+        default: "http://localhost:9200",
     }),
 };
 EsGet.args = [
-    { name: 'index', description: 'ES Index name', required: true },
-    { name: 'id', description: 'Document ID', required: true }
+    { name: "index", description: "ES Index name", required: true },
+    { name: "id", description: "Document ID", required: true },
 ];

package/lib/commands/es/indices/insert.d.ts

@@ -1,5 +1,5 @@
-import { flags } from '@oclif/command';
-import { Kommand } from '../../../common';
+import { flags } from "@oclif/command";
+import { Kommand } from "../../../common";
 export default class EsInsert extends Kommand {
     static initSdk: boolean;
     static description: string;

package/lib/commands/es/indices/insert.js

@@ -12,27 +12,27 @@ class EsInsert extends common_1.Kommand {
             body: this.flags.body,
         };
         await esClient.index(esRequest);
-        this.logOk('Document successfully inserted.');
+        this.logOk("Document successfully inserted.");
     }
 }
 exports.default = EsInsert;
 EsInsert.initSdk = false;
-EsInsert.description = 'Inserts a document directly into ES (will replace if exists)';
+EsInsert.description = "Inserts a document directly into ES (will replace if exists)";
 EsInsert.flags = {
     body: command_1.flags.string({
-        description: 'Document body in JSON',
-        default: '{}'
+        description: "Document body in JSON",
+        default: "{}",
     }),
     id: command_1.flags.string({
-        description: 'Document ID'
+        description: "Document ID",
     }),
     node: command_1.flags.string({
-        char: 'n',
-        description: 'Elasticsearch server URL',
-        default: 'http://localhost:9200',
+        char: "n",
+        description: "Elasticsearch server URL",
+        default: "http://localhost:9200",
     }),
     help: command_1.flags.help(),
 };
 EsInsert.args = [
-    { name: 'index', description: 'ES Index name', required: true },
+    { name: "index", description: "ES Index name", required: true },
 ];

package/lib/commands/es/migrate.d.ts

@@ -1,6 +1,5 @@
-import { flags } from '@oclif/command';
-import { Client } from '@elastic/elasticsearch';
-import { Kommand } from '../../common';
+import { flags } from "@oclif/command";
+import { Kommand } from "../../common";
 export default class EsMigrate extends Kommand {
     static initSdk: boolean;
     static description: string;
@@ -9,15 +8,18 @@ export default class EsMigrate extends Kommand {
         src: flags.IOptionFlag<string>;
         dest: flags.IOptionFlag<string>;
         reset: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'batch-size': import("@oclif/parser/lib/flags").IOptionFlag<number>;
-        'no-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        'dry-run': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+        "batch-size": import("@oclif/parser/lib/flags").IOptionFlag<number>;
+        "no-interactive": import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+        "dry-run": import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         pattern: flags.IOptionFlag<string | undefined>;
         scroll: flags.IOptionFlag<string>;
     };
     static examples: string[];
-    private migrateMappings;
+    private src;
+    private dest;
+    private detectProviderType;
+    private migrateIndex;
     private migrateData;
-    runMigrate(index: string, src: Client, dest: Client): Promise<void>;
+    runMigrate(index: string): Promise<void>;
     runSafe(): Promise<void>;
 }