@algolia/cli 4.0.7 → 5.10.0

package/commands/SetSettings.js

@@ -1,72 +0,0 @@
-const fs = require('fs');
-const algolia = require('algoliasearch');
-const Base = require('./Base.js');
-
-class SetSettingsScript extends Base {
-  constructor() {
-    super();
-    // Bind class methods
-    this.getSource = this.getSource.bind(this);
-    this.parseSetSettingsOptions = this.parseSetSettingsOptions.bind(this);
-    this.start = this.start.bind(this);
-    // Define validation constants
-    this.message =
-      '\nExample: $ algolia setsettings -a algoliaappid -k algoliaapikey -n algoliaindexname -s sourcefilepath -p setsettingsparams\n\n';
-    this.params = [
-      'algoliaappid',
-      'algoliaapikey',
-      'algoliaindexname',
-      'sourcefilepath',
-    ];
-  }
-
-  getSource(path) {
-    const filepath = this.normalizePath(path);
-    if (!fs.lstatSync(filepath).isFile())
-      throw new Error('Source filepath must target valid settings file.');
-    return filepath;
-  }
-
-  parseSetSettingsOptions(params) {
-    try {
-      const options = { forwardToReplicas: false };
-      if (params === null) return options;
-      else return JSON.parse(params);
-    } catch (e) {
-      throw e;
-    }
-  }
-
-  async start(program) {
-    try {
-      // Validate command; if invalid display help text and exit
-      this.validate(program, this.message, this.params);
-
-      // Config params
-      const appId = program.algoliaappid;
-      const apiKey = program.algoliaapikey;
-      const indexName = program.algoliaindexname;
-      const sourceFilepath = program.sourcefilepath;
-      const params = program.params || null;
-
-      // Get index settings
-      const settingsPath = this.getSource(sourceFilepath);
-      const settingsFile = await fs.readFileSync(settingsPath);
-      const settings = JSON.parse(settingsFile);
-      // Get options
-      const settingsOptions = this.parseSetSettingsOptions(params);
-
-      // Instantiate Algolia index
-      const client = algolia(appId, apiKey);
-      const index = client.initIndex(indexName);
-      // Set index settings
-      const result = await index.setSettings(settings, settingsOptions);
-      return console.log(result);
-    } catch (e) {
-      throw e;
-    }
-  }
-}
-
-const setSettingsScript = new SetSettingsScript();
-module.exports = setSettingsScript;

package/commands/TransferIndex.js

@@ -1,126 +0,0 @@
-const algolia = require('algoliasearch');
-const Base = require('./Base.js');
-
-class TransferIndexScript extends Base {
-  constructor() {
-    super();
-    // Bind class methods
-    this.getIndices = this.getIndices.bind(this);
-    this.getTransformations = this.getTransformations.bind(this);
-    this.transferIndexConfig = this.transferIndexConfig.bind(this);
-    this.transferData = this.transferData.bind(this);
-    this.start = this.start.bind(this);
-    // Define validation constants
-    this.message =
-      '\nExample: $ algolia transferindex -a sourcealgoliaappid -k sourcealgoliaapikey -n sourcealgoliaindexname -d destinationalgoliaappid -y destinationalgoliaapikey -i destinationindexname -t transformationfilepath -e true\n\n';
-    this.params = [
-      'sourcealgoliaappid',
-      'sourcealgoliaapikey',
-      'sourcealgoliaindexname',
-      'destinationalgoliaappid',
-      'destinationalgoliaapikey',
-    ];
-  }
-
-  getIndices(options) {
-    // Instantiate Algolia indices
-    const sourceClient = algolia(options.sourceAppId, options.sourceApiKey);
-    const sourceIndex = sourceClient.initIndex(options.sourceIndexName);
-    const destinationClient = algolia(
-      options.destinationAppId,
-      options.destinationApiKey
-    );
-    const destinationIndex = destinationClient.initIndex(
-      options.destinationIndexName
-    );
-
-    return { sourceIndex, destinationIndex };
-  }
-
-  getTransformations(options) {
-    // Set JSON record transformations
-    const transformations = options.transformations
-      ? require(options.transformations)
-      : null;
-    // Validate transformations function input param
-    const valid = transformations && typeof transformations === 'function';
-    // Return provided transformation function if exists
-    return valid ? transformations : null;
-  }
-
-  async transferIndexConfig(indices, options) {
-    // Transfer settings, synonyms, and query rules
-    const settings = await indices.sourceIndex.getSettings();
-    const synonyms = await indices.sourceIndex.exportSynonyms();
-    const rules = await indices.sourceIndex.exportRules();
-    if (options.excludeReplicas) delete settings.replicas;
-    await indices.destinationIndex.setSettings(settings);
-    await indices.destinationIndex.batchSynonyms(synonyms);
-    await indices.destinationIndex.batchRules(rules);
-  }
-
-  transferData(indices, formatRecord) {
-    return new Promise((resolve, reject) => {
-      // Export index
-      const browse = indices.sourceIndex.browseAll('', {
-        attributesToRetrieve: ['*'],
-      });
-      let hitsCount = 0;
-      // Set browseAll event handlers
-      browse.on('result', async result => {
-        // Push hits to destination index
-        try {
-          const hits = formatRecord
-            ? result.hits.map(formatRecord)
-            : result.hits;
-          await indices.destinationIndex.addObjects(hits);
-          hitsCount += result.hits.length;
-          this.writeProgress(`Records transferred: ${hitsCount}`);
-        } catch (e) {
-          throw e;
-        }
-      });
-      browse.on('end', () => resolve('\nDone transferring index.\n'));
-      browse.on('error', err => reject(err));
-    });
-  }
-
-  async start(program) {
-    try {
-      // Validate command; if invalid display help text and exit
-      this.validate(program, this.message, this.params);
-
-      // Config params
-      const options = {
-        sourceAppId: program.sourcealgoliaappid,
-        sourceApiKey: program.sourcealgoliaapikey,
-        sourceIndexName: program.sourcealgoliaindexname,
-        destinationAppId: program.destinationalgoliaappid,
-        destinationApiKey: program.destinationalgoliaapikey,
-        destinationIndexName:
-          program.destinationindexname || program.sourcealgoliaindexname,
-        transformations: program.transformationfilepath || null,
-        excludeReplicas:
-          program.excludereplicas !== undefined
-            ? program.excludereplicas === 'true'
-            : false,
-      };
-
-      // Configure Algolia clients/indices
-      const indices = this.getIndices(options);
-      // Configure transformations
-      const formatRecord = this.getTransformations(options);
-      // Transfer index configuration
-      await this.transferIndexConfig(indices, options);
-      // Transfer data
-      const result = await this.transferData(indices, formatRecord);
-
-      return console.log(result);
-    } catch (e) {
-      throw e;
-    }
-  }
-}
-
-const transferIndexScript = new TransferIndexScript();
-module.exports = transferIndexScript;

package/commands/TransferIndexConfig.js

@@ -1,108 +0,0 @@
-const algolia = require('algoliasearch');
-const Base = require('./Base.js');
-
-class TransferIndexConfigScript extends Base {
-  constructor() {
-    super();
-    // Bind class methods
-    this.start = this.start.bind(this);
-    this.getIndices = this.getIndices.bind(this);
-    this.getConfigOptions = this.getConfigOptions.bind(this);
-    this.transferIndexConfig = this.transferIndexConfig.bind(this);
-    // Define validation constants
-    this.message =
-      '\nExample: $ algolia transferindexconfig -a sourcealgoliaappid -k sourcealgoliaapikey -n sourcealgoliaindexname -d destinationalgoliaappid -y destinationalgoliaapikey -i destinationindexname -p configParams -e true\n\n';
-    this.params = [
-      'sourcealgoliaappid',
-      'sourcealgoliaapikey',
-      'sourcealgoliaindexname',
-      'destinationalgoliaappid',
-      'destinationalgoliaapikey',
-    ];
-  }
-
-  getIndices(options) {
-    // Instantiate Algolia indices
-    const sourceClient = algolia(options.sourceAppId, options.sourceApiKey);
-    const sourceIndex = sourceClient.initIndex(options.sourceIndexName);
-    const destinationClient = algolia(
-      options.destinationAppId,
-      options.destinationApiKey
-    );
-    const destinationIndex = destinationClient.initIndex(
-      options.destinationIndexName
-    );
-
-    return { sourceIndex, destinationIndex };
-  }
-
-  getConfigOptions(options) {
-    // Default config
-    const config = {
-      sOptions: {},
-      rOptions: {},
-    };
-    // No params provided, exit early
-    if (!options.configParams) return config;
-
-    const params = JSON.parse(options.configParams);
-
-    // Set provided batchSynonyms and batchRules options
-    if (params.batchSynonymsParams)
-      config.sOptions = Object.assign({}, params.batchSynonymsParams);
-    if (params.batchRulesParams)
-      config.rOptions = Object.assign({}, params.batchRulesParams);
-
-    return config;
-  }
-
-  async transferIndexConfig(indices, config, options) {
-    // Transfer settings, synonyms, and query rules
-    const settings = await indices.sourceIndex.getSettings();
-    const synonyms = await indices.sourceIndex.exportSynonyms();
-    const rules = await indices.sourceIndex.exportRules();
-    if (options.excludeReplicas) delete settings.replicas;
-    await indices.destinationIndex.setSettings(settings);
-    await indices.destinationIndex.batchSynonyms(synonyms, config.sOptions);
-    await indices.destinationIndex.batchRules(rules, config.rOptions);
-  }
-
-  async start(program) {
-    try {
-      // Validate command; if invalid display help text and exit
-      this.validate(program, this.message, this.params);
-
-      // Config params
-      const options = {
-        sourceAppId: program.sourcealgoliaappid,
-        sourceApiKey: program.sourcealgoliaapikey,
-        sourceIndexName: program.sourcealgoliaindexname,
-        destinationAppId: program.destinationalgoliaappid,
-        destinationApiKey: program.destinationalgoliaapikey,
-        destinationIndexName:
-          program.destinationindexname || program.sourcealgoliaindexname,
-        configParams: program.params || null,
-        excludeReplicas:
-          program.excludereplicas !== undefined
-            ? program.excludereplicas === 'true'
-            : false,
-      };
-
-      // Configure Algolia clients/indices
-      const indices = this.getIndices(options);
-      // Configure batchSynonyms and batchRules options
-      const config = this.getConfigOptions(options);
-      // Transfer index configuration
-      await this.transferIndexConfig(indices, config, options);
-
-      return console.log(
-        'Index settings, synonyms, and query rules transferred successfully.'
-      );
-    } catch (e) {
-      throw e;
-    }
-  }
-}
-
-const transferIndexConfigScript = new TransferIndexConfigScript();
-module.exports = transferIndexConfigScript;

package/commands/TransformLines.js

@@ -1,136 +0,0 @@
-const fs = require('fs');
-const readLine = require('readline');
-const Base = require('./Base.js');
-
-class TransformLinesScript extends Base {
-  constructor() {
-    super();
-    // Bind class methods
-    this.defaultLineTransformation = this.defaultLineTransformation.bind(this);
-    this.setOutput = this.setOutput.bind(this);
-    this.setTransformations = this.setTransformations.bind(this);
-    this.transformFile = this.transformFile.bind(this);
-    this.init = this.init.bind(this);
-    this.start = this.start.bind(this);
-    // Define validation constants
-    this.message =
-      '\nExample: $ algolia transformlines -s sourcefilepath -o outputpath -t transformationfilepath \n\n';
-    this.params = ['sourcefilepath'];
-  }
-
-  defaultLineTransformation(line) {
-    // Default line transformation method
-    /* eslint-disable no-control-regex */
-    const newLine = line.match(/\u001e/, 'i')
-      ? line.replace(/\u001e/, ',')
-      : line;
-    return newLine;
-    /* eslint-enable no-control-regex */
-  }
-
-  setOutput(outputPath) {
-    this.outputDir =
-      outputPath !== null ? this.normalizePath(outputPath) : process.cwd();
-
-    // Ensure outputpath is a directory
-    if (!fs.lstatSync(this.outputDir).isDirectory())
-      throw new Error('Output path must be a directory.');
-  }
-
-  setTransformations(transformationFilepath) {
-    try {
-      // Set JSON record transformations
-      const transformations = transformationFilepath
-        ? require(this.normalizePath(transformationFilepath))
-        : null;
-      // Validate transformations function input param
-      const valid = transformations && typeof transformations === 'function';
-      // Assign our transformations function using provided custom transformations file if exists
-      this.lineTransformation = valid
-        ? transformations
-        : this.defaultLineTransformation;
-    } catch (e) {
-      throw e;
-    }
-  }
-
-  // Method to transform an individual file line-by-line
-  transformFile(filename) {
-    return new Promise((resolve, reject) => {
-      try {
-        const writeStream = fs.createWriteStream(
-          `${this.outputDir}/${filename}`
-        );
-        let count = 0;
-
-        if (this.transformationFilepath === null) {
-          writeStream.write('['); // Comment this out to prevent injecting opening bracket at start of new output file
-        }
-
-        const lineReader = readLine.createInterface({
-          input: fs.createReadStream(`${this.directory}/${filename}`),
-        });
-
-        lineReader.on('line', line => {
-          count++;
-          const newLine = this.lineTransformation(line);
-          this.writeProgress(`Line ${count}...`);
-          writeStream.write(newLine);
-        });
-
-        lineReader.on('close', () => {
-          console.log('Done writing!');
-          if (this.transformationFilepath === null) {
-            writeStream.write(']'); // Comment this out to prevent injecting closing bracket at end of new output file
-          }
-          writeStream.end();
-          resolve(true);
-        });
-      } catch (e) {
-        reject(e);
-      }
-    });
-  }
-
-  // Start script
-  async init(filenames) {
-    for (const filename of filenames) {
-      try {
-        console.log(`Reading: ${this.directory}/${filename}`);
-        console.log(`Writing to: ${this.outputDir}/${filename}`);
-        await this.transformFile(filename);
-      } catch (e) {
-        console.log(`Error while processing ${filename}`);
-        throw new Error(e);
-      }
-    }
-  }
-
-  start(program) {
-    // Script reads a file or directory of files synchronously, line-by-line.
-    // Writes each file synchronously, line-by-line, to an output directory
-    // while optionally applying a provided transformation function to each line.
-
-    // Validate command; if invalid display help text and exit
-    this.validate(program, this.message, this.params);
-
-    // Config params
-    this.sourceFilepath = program.sourcefilepath;
-    this.outputpath = program.outputpath || null;
-    this.transformationFilepath = program.transformationfilepath || null;
-
-    // Configure source paths (this.directory, this.filenames)
-    this.setSource({ sourceFilepath: this.sourceFilepath });
-    // Configure output path (this.outputDir)
-    this.setOutput(this.outputpath);
-    // Configure transformations (this.lineTransformation)
-    this.setTransformations(this.transformationFilepath);
-
-    // Execute line transformations
-    this.init(this.filenames);
-    return false;
-  }
-}
-
-const transformLinesScript = new TransformLinesScript();
-module.exports = transformLinesScript;

package/commands.js

@@ -1,16 +0,0 @@
-module.exports = {
-  addrules: require('./commands/AddRules.js'),
-  addsynonyms: require('./commands/AddSynonyms.js'),
-  deleteindicespattern: require('./commands/DeleteIndicesPattern.js'),
-  export: require('./commands/Export.js'),
-  exportrules: require('./commands/ExportRules.js'),
-  exportsynonyms: require('./commands/ExportSynonyms.js'),
-  getsettings: require('./commands/GetSettings.js'),
-  import: require('./commands/Import.js'),
-  interactive: require('./commands/Interactive.js'),
-  search: require('./commands/Search.js'),
-  setsettings: require('./commands/SetSettings.js'),
-  transferindex: require('./commands/TransferIndex.js'),
-  transferindexconfig: require('./commands/TransferIndexConfig.js'),
-  transformlines: require('./commands/TransformLines.js'),
-};