kourou 0.19.3 → 0.20.1

package/README.md

@@ -25,7 +25,7 @@ $ npm install -g kourou
 $ kourou COMMAND
 running command...
 $ kourou (-v|--version|version)
-kourou/0.19.3 linux-x64 node-v14.17.0
+kourou/0.20.1 linux-x64 node-v12.22.9
 $ kourou --help [COMMAND]
 USAGE
   $ kourou COMMAND
@@ -130,6 +130,7 @@ All other arguments and options will be passed as-is to the `sdk:query` method.
 * [`kourou api-key:search USER`](#kourou-api-keysearch-user)
 * [`kourou app:scaffold NAME`](#kourou-appscaffold-name)
 * [`kourou app:start-services`](#kourou-appstart-services)
+* [`kourou autocomplete [SHELL]`](#kourou-autocomplete-shell)
 * [`kourou collection:create INDEX COLLECTION [BODY]`](#kourou-collectioncreate-index-collection-body)
 * [`kourou collection:export INDEX COLLECTION`](#kourou-collectionexport-index-collection)
 * [`kourou collection:import PATH`](#kourou-collectionimport-path)
@@ -142,7 +143,6 @@ All other arguments and options will be passed as-is to the `sdk:query` method.
 * [`kourou es:snapshot:create REPOSITORY NAME`](#kourou-essnapshotcreate-repository-name)
 * [`kourou es:snapshot:create-repository REPOSITORY LOCATION`](#kourou-essnapshotcreate-repository-repository-location)
 * [`kourou es:snapshot:list REPOSITORY`](#kourou-essnapshotlist-repository)
-* [`kourou es:snapshot:restore REPOSITORY NAME`](#kourou-essnapshotrestore-repository-name)
 * [`kourou file:decrypt FILE`](#kourou-filedecrypt-file)
 * [`kourou file:encrypt FILE`](#kourou-fileencrypt-file)
 * [`kourou file:test FILE`](#kourou-filetest-file)
@@ -315,6 +315,29 @@ OPTIONS
 
 _See code: [src/commands/app/start-services.ts](src/commands/app/start-services.ts)_
 
+## `kourou autocomplete [SHELL]`
+
+display autocomplete installation instructions
+
+```
+USAGE
+  $ kourou autocomplete [SHELL]
+
+ARGUMENTS
+  SHELL  shell type
+
+OPTIONS
+  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
+
+EXAMPLES
+  $ kourou autocomplete
+  $ kourou autocomplete bash
+  $ kourou autocomplete zsh
+  $ kourou autocomplete --refresh-cache
+```
+
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.3.0/src/commands/autocomplete/index.ts)_
+
 ## `kourou collection:create INDEX COLLECTION [BODY]`
 
 Creates a collection
@@ -355,31 +378,58 @@ ARGUMENTS
   COLLECTION  Collection name
 
 OPTIONS
-  --api-key=api-key        Kuzzle user api-key
-  --as=as                  Impersonate a user
-  --batch-size=batch-size  [default: 2000] Maximum batch size (see limits.documentsFetchCount config)
-  --editor                 Open an editor (EDITOR env variable) to edit the query before sending
+  --api-key=api-key
+      Kuzzle user api-key
 
-  --format=format          [default: JSONL] "jsonl or kuzzle - kuzzle will export in Kuzzle format usable for internal
-                           fixtures and jsonl allows to import that data back with kourou
+  --as=as
+      Impersonate a user
 
-  --help                   show CLI help
+  --batch-size=batch-size
+      [default: 2000] Maximum batch size (see limits.documentsFetchCount config)
 
-  --host=host              [default: localhost] Kuzzle server host
+  --editor
+      Open an editor (EDITOR env variable) to edit the query before sending
 
-  --password=password      Kuzzle user password
+  --fields=fields
+      [CSV format only] The list of fields to be included in the CSV export in dot-path format.
 
-  --path=path              Dump root directory
+      Example:
+      --fields oneField,anotherField,yetAnotherOne.nested.moarNested
 
-  --port=port              [default: 7512] Kuzzle server port
+      Note that the '_id' field is always included in the CSV export. Leaving this option empty implies that all
+      exportable fields in the mapping will be exported.
 
-  --protocol=protocol      [default: ws] Kuzzle protocol (http or websocket)
+  --format=jsonl|kuzzle|csv
+      [default: jsonl] "kuzzle" will export in Kuzzle format usable for internal fixtures,
+      "jsonl" allows to import that data back with kourou,
+      "csv" allows to import data into Excel (please, specify the fields to export using the --fields option).
 
-  --query=query            [default: {}] Only dump documents matching the query (JS or JSON format)
+  --help
+      show CLI help
 
-  --ssl                    Use SSL to connect to Kuzzle
+  --host=host
+      [default: localhost] Kuzzle server host
 
-  --username=username      [default: anonymous] Kuzzle username (local strategy)
+  --password=password
+      Kuzzle user password
+
+  --path=path
+      Dump root directory
+
+  --port=port
+      [default: 7512] Kuzzle server port
+
+  --protocol=protocol
+      [default: ws] Kuzzle protocol (http or websocket)
+
+  --query=query
+      [default: {}] Only dump documents matching the query (JS or JSON format)
+
+  --ssl
+      Use SSL to connect to Kuzzle
+
+  --username=username
+      [default: anonymous] Kuzzle username (local strategy)
 
 EXAMPLES
   kourou collection:export nyc-open-data yellow-taxi
@@ -613,25 +663,6 @@ OPTIONS
 
 _See code: [src/commands/es/snapshot/list.ts](src/commands/es/snapshot/list.ts)_
 
-## `kourou es:snapshot:restore REPOSITORY NAME`
-
-Restore a snapshot into an ES instance
-
-```
-USAGE
-  $ kourou es:snapshot:restore REPOSITORY NAME
-
-ARGUMENTS
-  REPOSITORY  ES repository name
-  NAME        ES snapshot name
-
-OPTIONS
-  -n, --node=node  [default: http://localhost:9200] Elasticsearch server URL
-  --help           show CLI help
-```
-
-_See code: [src/commands/es/snapshot/restore.ts](src/commands/es/snapshot/restore.ts)_
-
 ## `kourou file:decrypt FILE`
 
 Decrypts an encrypted file.
@@ -713,7 +744,7 @@ OPTIONS
   --all  see all commands in CLI
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.3/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_
 
 ## `kourou import PATH`
 
@@ -1087,29 +1118,29 @@ DESCRIPTION
 
   Code Execution
 
-     Provided code will be executed in an async method.
-     You can access a connected and authenticated SDK with the "sdk" variable.
-     Templated variable passed as the command arguments are also accessible within the same name.
-     Returned value will be printed on the standard output (e.g. 'return await sdk.server.now();').
-     Errors will be caught and printed on the error output (e.g. 'throw new Error("failure");').
+    Provided code will be executed in an async method.
+    You can access a connected and authenticated SDK with the "sdk" variable.
+    Templated variable passed as the command arguments are also accessible within the same name.
+    Returned value will be printed on the standard output (e.g. 'return await sdk.server.now();').
+    Errors will be caught and printed on the error output (e.g. 'throw new Error("failure");').
 
   Provide code
 
-     code can be passed as an argument
-     code will be read from STDIN if available
+    code can be passed as an argument
+    code will be read from STDIN if available
 
-     Examples:
-       - kourou sdk:execute 'return await sdk.server.now()'
-       - kourou sdk:execute 'return await sdk.index.exists(index)' --var 'index="iot-data"'
-       - kourou sdk:execute < snippet.js
-       - echo 'return await sdk.server.now()' | kourou sdk:execute
+    Examples:
+      - kourou sdk:execute 'return await sdk.server.now()'
+      - kourou sdk:execute 'return await sdk.index.exists(index)' --var 'index="iot-data"'
+      - kourou sdk:execute < snippet.js
+      - echo 'return await sdk.server.now()' | kourou sdk:execute
 
   Other
 
-     use the --editor flag to modify the code before executing it
+    use the --editor flag to modify the code before executing it
 
-     Examples:
-       - kourou sdk:execute 'return await sdk.server.now()' --editor
+    Examples:
+      - kourou sdk:execute 'return await sdk.server.now()' --editor
 ```
 
 _See code: [src/commands/sdk/execute.ts](src/commands/sdk/execute.ts)_
@@ -1160,55 +1191,55 @@ DESCRIPTION
 
   Query arguments
 
-     Arguments can be passed and repeated using the --arg or -a flag.
-     Index and collection names can be passed with --index (-i) and --collection (-c) flags
-     ID can be passed with the --id flag.
+    Arguments can be passed and repeated using the --arg or -a flag.
+    Index and collection names can be passed with --index (-i) and --collection (-c) flags
+    ID can be passed with the --id flag.
 
-     Examples:
-       - kourou sdk:query document:delete -i iot -c sensors -a refresh=wait_for
+    Examples:
+      - kourou sdk:query document:delete -i iot -c sensors -a refresh=wait_for
 
   Query body
 
-     Body can be passed with the --body flag with either a JSON or JS string.
-     Body will be read from STDIN if available
+    Body can be passed with the --body flag with either a JSON or JS string.
+    Body will be read from STDIN if available
 
-     Examples:
-       - kourou sdk:query document:create -i iot -c sensors --body '{creation: Date.now())}'
-       - kourou sdk:query admin:loadMappings < mappings.json
-       - echo '{dynamic: "strict"}' | kourou sdk:query collection:create -i iot -c sensors
+    Examples:
+      - kourou sdk:query document:create -i iot -c sensors --body '{creation: Date.now())}'
+      - kourou sdk:query admin:loadMappings < mappings.json
+      - echo '{dynamic: "strict"}' | kourou sdk:query collection:create -i iot -c sensors
 
   Other
 
-     Use the --editor flag to modify the query before sending it to Kuzzle
-     Use the --display flag to display a specific property of the response
+    Use the --editor flag to modify the query before sending it to Kuzzle
+    Use the --display flag to display a specific property of the response
 
-     Examples:
-       - kourou sdk:query document:create -i iot -c sensors --editor
-       - kourou sdk:query server:now --display 'result.now'
+    Examples:
+      - kourou sdk:query document:create -i iot -c sensors --editor
+      - kourou sdk:query server:now --display 'result.now'
 
   Default fallback to API action
 
-     It's possible to use the "sdk:query" command by only specifying the corresponding controller
-     and action as first argument.
+    It's possible to use the "sdk:query" command by only specifying the corresponding controller
+    and action as first argument.
 
-     Kourou will try to infer the first arguments to one the following pattern:
-       - <command> <index>
-       - <command> <body>
-       - <command> <index> <collection>
-       - <command> <index> <collection> <id>
-       - <command> <index> <collection> <body>
-       - <command> <index> <collection> <id> <body>
+    Kourou will try to infer the first arguments to one the following pattern:
+      - <command> <index>
+      - <command> <body>
+      - <command> <index> <collection>
+      - <command> <index> <collection> <id>
+      - <command> <index> <collection> <body>
+      - <command> <index> <collection> <id> <body>
 
-     If a flag is given (-i, -c, --body or --id), then the flag value has priority over
-     argument infering.
+    If a flag is given (-i, -c, --body or --id), then the flag value has priority over
+    argument infering.
 
-     Examples:
-       - kourou collection:list iot
-       - kourou security:createUser '{ "content": { "profileIds": ["default"] } }' --id yagmur
-       - kourou collection:delete iot sensors
-       - kourou document:createOrReplace iot sensors sigfox-1 '{}'
-       - kourou bulk:import iot sensors '{ bulkData: [...] }'
-       - kourou admin:loadMappings < mappings.json
+    Examples:
+      - kourou collection:list iot
+      - kourou security:createUser '{ "content": { "profileIds": ["default"] } }' --id yagmur
+      - kourou collection:delete iot sensors
+      - kourou document:createOrReplace iot sensors sigfox-1 '{}'
+      - kourou bulk:import iot sensors '{ bulkData: [...] }'
+      - kourou admin:loadMappings < mappings.json
 ```
 
 _See code: [src/commands/sdk/query.ts](src/commands/sdk/query.ts)_
@@ -1243,24 +1274,24 @@ DESCRIPTION
   The users will be exported WITHOUT their credentials since Kuzzzle can't access them.
 
   You can either:
-     - Manually re-create credentials for your users
-     - Use the "mustChangePasswordIfSetByAdmin" option Kuzzle password policies (see 
+    - Manually re-create credentials for your users
+    - Use the "mustChangePasswordIfSetByAdmin" option Kuzzle password policies (see 
   https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local/#optional-properties)
-     - Use the "--generate-credentials" flag to auto-generate credentials for your users
+    - Use the "--generate-credentials" flag to auto-generate credentials for your users
 
   Auto-generation of credentials
 
-     With the "--generate-credentials" flag, Kourou will add credentials for the "local" strategy.
-     By default, the username will be the user ID.
-     Use the "generated-username" flag to use an other property than the user ID for the generated username
-     The password will be a strong random 40 characters string
+    With the "--generate-credentials" flag, Kourou will add credentials for the "local" strategy.
+    By default, the username will be the user ID.
+    Use the "generated-username" flag to use an other property than the user ID for the generated username
+    The password will be a strong random 40 characters string
 
   Examples:
 
-     - kourou user:export
-     - kourou user:export --exclude '.*admin.*' --exclude 'supervisor.*'
-     - kourou user:export --generate-credentials
-     - kourou user:export --generate-credentials --generated-username content.email
+    - kourou user:export
+    - kourou user:export --exclude '.*admin.*' --exclude 'supervisor.*'
+    - kourou user:export --generate-credentials
+    - kourou user:export --generate-credentials --generated-username content.email
 ```
 
 _See code: [src/commands/user/export.ts](src/commands/user/export.ts)_
@@ -1422,11 +1453,11 @@ DESCRIPTION
 
   Example:
   {
-     aws: {
-       s3: {
-         keyId: 'b61e267676660c314b006b06'
-       }
-     }
+    aws: {
+      s3: {
+        keyId: 'b61e267676660c314b006b06'
+      }
+    }
   }
 
   Encrypted secrets are meant to be loaded inside an application with Kuzzle Vault.
@@ -1459,8 +1490,8 @@ DESCRIPTION
   Prints an encrypted secrets file content.
 
   This method can display either:
-    - the entire content of the secrets file
-    - a single key value
+   - the entire content of the secrets file
+   - a single key value
 
   See https://github.com/kuzzleio/kuzzle-vault/ for more information.
 

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

@@ -10,6 +10,8 @@ export default class AppScaffold extends Kommand {
         description: string;
         required: boolean;
     }[];
+    checkKebabCase(name: string): boolean;
+    convertToKebabCase(name: string): string;
     runSafe(): Promise<void>;
     renderTemplates(directory: string, templatePath: string): Promise<void>;
 }

package/lib/commands/app/scaffold.js

@@ -7,6 +7,7 @@ const command_1 = require("@oclif/command");
 const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 const listr_1 = (0, tslib_1.__importDefault)(require("listr"));
+const inquirer_1 = (0, tslib_1.__importDefault)(require("inquirer"));
 const common_1 = require("../../common");
 const execute_1 = require("../../support/execute");
 const templatesDir = path_1.default.join(__dirname, '..', '..', '..', 'templates');
@@ -15,8 +16,30 @@ const TEMPLATED_ENTRIES = [
     'app.ts',
     'README.md'
 ];
+const KEBAB_CASE_REGEX = /^[a-z-\d]+$/;
 class AppScaffold extends common_1.Kommand {
+    checkKebabCase(name) {
+        return KEBAB_CASE_REGEX.test(name);
+    }
+    convertToKebabCase(name) {
+        return name.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
+    }
     async runSafe() {
+        if (!this.checkKebabCase(this.args.name)) {
+            this.logKo(`The application name must be in kebab-case`);
+            const kebabCasedName = this.convertToKebabCase(this.args.name);
+            const response = await inquirer_1.default.prompt([
+                {
+                    name: 'kebabCaseConversion',
+                    type: 'confirm',
+                    message: `Would you like to convert "${this.args.name}" to "${kebabCasedName}"`
+                }
+            ]);
+            if (!response.kebabCaseConversion) {
+                process.exit(0);
+            }
+            this.args.name = kebabCasedName;
+        }
         const templatePath = path_1.default.join(templatesDir, 'app-scaffold', 'ts');
         const tasks = new listr_1.default([
             {

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

@@ -17,6 +17,7 @@ export default class CollectionExport extends Kommand {
         query: flags.IOptionFlag<string>;
         editor: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         format: flags.IOptionFlag<string>;
+        fields: flags.IOptionFlag<string | undefined>;
     };
     static args: {
         name: string;

package/lib/commands/collection/export.js

@@ -12,16 +12,22 @@ class CollectionExport extends common_1.Kommand {
         const exportPath = this.flags.path
             ? path_1.default.join(this.flags.path, this.args.index)
             : this.args.index;
+        const fields = this.flags.fields
+            ? this.flags.fields.split(',')
+            : [];
+        if (this.flags.format === 'csv' && fields.length === 0) {
+            this.logInfo('It looks like you are exporting to CSV but you did not select any field. All exportable fields in the mapping will be exported.');
+        }
         let query = this.parseJs(this.flags.query);
         if (this.flags.editor) {
             query = this.fromEditor(query, { json: true });
         }
         const countAll = await this.sdk.document.count(this.args.index, this.args.collection);
         const count = await this.sdk.document.count(this.args.index, this.args.collection, { query });
-        this.logInfo(`Dumping ${count} of ${countAll} documents from collection "${this.args.index}:${this.args.collection}" in ${path_1.default} ...`);
+        this.logInfo(`Dumping ${count} of ${countAll} documents from collection "${this.args.index}:${this.args.collection}" in ${exportPath} ...`);
         fs_1.default.mkdirSync(exportPath, { recursive: true });
         await (0, dump_collection_1.dumpCollectionMappings)(this.sdk, this.args.index, this.args.collection, exportPath, this.flags.format);
-        await (0, dump_collection_1.dumpCollectionData)(this.sdk, this.args.index, this.args.collection, Number(this.flags['batch-size']), exportPath, query, this.flags.format);
+        await (0, dump_collection_1.dumpCollectionData)(this.sdk, this.args.index, this.args.collection, Number(this.flags['batch-size']), exportPath, query, this.flags.format, fields);
         this.logOk(`Collection ${this.args.index}:${this.args.collection} dumped`);
     }
 }
@@ -38,8 +44,19 @@ CollectionExport.flags = Object.assign(Object.assign({ help: command_1.flags.hel
     }), editor: command_1.flags.boolean({
         description: 'Open an editor (EDITOR env variable) to edit the query before sending'
     }), format: command_1.flags.string({
-        description: '"jsonl or kuzzle - kuzzle will export in Kuzzle format usable for internal fixtures and jsonl allows to import that data back with kourou',
-        default: 'JSONL'
+        description: `"kuzzle" will export in Kuzzle format usable for internal fixtures,
+"jsonl" allows to import that data back with kourou,
+"csv" allows to import data into Excel (please, specify the fields to export using the --fields option).`,
+        options: ['jsonl', 'kuzzle', 'csv'],
+        default: 'jsonl'
+    }), fields: command_1.flags.string({
+        description: `[CSV format only] The list of fields to be included in the CSV export in dot-path format.
+
+Example:
+--fields oneField,anotherField,yetAnotherOne.nested.moarNested
+
+Note that the '_id' field is always included in the CSV export. Leaving this option empty implies that all
+exportable fields in the mapping will be exported.`
     }) }, kuzzle_1.kuzzleFlags), { protocol: command_1.flags.string({
         description: 'Kuzzle protocol (http or websocket)',
         default: 'ws',

package/lib/commands/document/search.js

@@ -24,7 +24,7 @@ class DocumentSearch extends common_1.Kommand {
             request = this.fromEditor(request, { json: true });
         }
         const { result } = await this.sdk.query(request);
-        for (const document of result === null || result === void 0 ? void 0 : result.hits) {
+        for (const document of (result === null || result === void 0 ? void 0 : result.hits) || []) {
             this.logInfo(`Document ID: ${document._id}`);
             this.log(`Content: ${JSON.stringify(document._source, null, 2)}`);
         }

package/lib/commands/role/export.js

@@ -21,7 +21,6 @@ class RoleDump extends common_1.Kommand {
     }
     async _dumpRoles() {
         const options = {
-            scroll: '3s',
             size: 100
         };
         let result = await this.sdk.security.searchRoles({}, options);

package/lib/common.d.ts

@@ -27,3 +27,20 @@ export declare abstract class Kommand extends Command {
     fromEditor(defaultContent: Record<string, unknown> | string, options?: EditorParams): Record<string, unknown>;
     parseJs(input?: string): any;
 }
+/**
+ * An iteration-order-safe version of lodash.values
+ *
+ * @param object The object containing the values
+ * @param fields The field names to pick in the right order
+ * @returns The values in the same order as the fields
+ * @see https://lodash.com/docs/4.17.15#values
+ */
+export declare function pickValues(object: any, fields: string[]): any[];
+/**
+ * Formats the value for correct CSV output, avoiding to return
+ * values that would badly serialize in CSV.
+ *
+ * @param value The value to format
+ * @returns The value or a string telling the value is not scalar
+ */
+export declare function formatValueForCSV(value: any): any;

package/lib/common.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Kommand = void 0;
+exports.formatValueForCSV = exports.pickValues = exports.Kommand = void 0;
 const tslib_1 = require("tslib");
 const command_1 = require("@oclif/command");
 const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 const node_emoji_1 = (0, tslib_1.__importDefault)(require("node-emoji"));
 const fs_1 = (0, tslib_1.__importDefault)(require("fs"));
+const get_1 = (0, tslib_1.__importDefault)(require("lodash/get"));
+const isObject_1 = (0, tslib_1.__importDefault)(require("lodash/isObject"));
 const kuzzle_1 = require("./support/kuzzle");
 const editor_1 = require("./support/editor");
 class Kommand extends command_1.Command {
@@ -86,6 +88,9 @@ class Kommand extends command_1.Command {
                 ? ` (https://docs.kuzzle.io/core/2/api/errors/error-codes/${error.id.split('.')[0]})`
                 : '';
             this.logKo(`Error stack: \n${stack || error.message}\n\nError status: ${error.status}\n\nError id: ${error.id}${errorLink}`);
+            for (const err of error.errors) {
+                this.logKo(`${err.document._id} : ${err.reason}`);
+            }
         }
         finally {
             this.sdk.disconnect();
@@ -131,3 +136,29 @@ class Kommand extends command_1.Command {
 exports.Kommand = Kommand;
 Kommand.initSdk = true;
 Kommand.readStdin = false;
+/**
+ * An iteration-order-safe version of lodash.values
+ *
+ * @param object The object containing the values
+ * @param fields The field names to pick in the right order
+ * @returns The values in the same order as the fields
+ * @see https://lodash.com/docs/4.17.15#values
+ */
+function pickValues(object, fields) {
+    return fields.map(f => formatValueForCSV((0, get_1.default)(object, f)));
+}
+exports.pickValues = pickValues;
+/**
+ * Formats the value for correct CSV output, avoiding to return
+ * values that would badly serialize in CSV.
+ *
+ * @param value The value to format
+ * @returns The value or a string telling the value is not scalar
+ */
+function formatValueForCSV(value) {
+    if ((0, isObject_1.default)(value)) {
+        return '[NOT_SCALAR]';
+    }
+    return value;
+}
+exports.formatValueForCSV = formatValueForCSV;

package/lib/support/dump-collection.d.ts

@@ -1,2 +1,2 @@
-export declare function dumpCollectionData(sdk: any, index: string, collection: string, batchSize: number, destPath: string, query?: any, format?: string): Promise<unknown>;
+export declare function dumpCollectionData(sdk: any, index: string, collection: string, batchSize: number, destPath: string, query?: any, format?: string, fields?: string[]): Promise<void>;
 export declare function dumpCollectionMappings(sdk: any, index: string, collection: string, destPath: string, format?: string): Promise<void>;