@contentstack/cli-migration 1.10.3 → 1.11.0

package/src/utils/modules.js

@@ -1,134 +0,0 @@
-const fs = require('fs');
-const { spawnSync } = require('child_process');
-const path = require('path');
-const { sanitizePath } = require('@contentstack/cli-utilities');
-const os = require('os');
-const { builtinModules } = require('module');
-
-const internalModules = new Set(builtinModules);
-
-function checkWritePermissionToDirectory(directory) {
-  try {
-    fs.accessSync(directory, fs.constants.W_OK);
-    return true;
-  } catch (err) {
-    console.log(`Permission denied. You do not have the necessary write access for this directory.`);
-    return false;
-  }
-}
-
-function doesPackageJsonExist(directory) {
-  return fs.existsSync(path.join(sanitizePath(directory), 'package.json'));
-}
-
-function scanDirectory(directory) {
-  return fs.readdirSync(directory);
-}
-
-function scanFileForDependencies(directory, files) {
-  const dependencies = new Set();
-
-  files.forEach((file) => {
-    const filePath = path.join(sanitizePath(directory), sanitizePath(file));
-    if (path.extname(filePath) === '.js') {
-      const fileContent = fs.readFileSync(filePath, 'utf-8');
-      findModulesSync(fileContent).forEach((dep) => dependencies.add(dep));
-    }
-  });
-
-  return [...dependencies];
-}
-
-function createPackageJson(directory) {
-  const templateString = `{
-    "name": "MigrationPackage",
-    "version": "1.0.0",
-    "main": "",
-    "scripts": {},
-    "keywords": [],
-    "author": "",
-    "license": "ISC",
-    "description": ""
-  }`;
-
-  fs.writeFileSync(path.join(sanitizePath(directory), 'package.json'), templateString);
-}
-
-function installDependencies(dependencies, directory) {
-  const installedDependencies = new Set();
-
-  dependencies.forEach((dep) => {
-    if (!internalModules.has(dep)) {
-      const pkg = dep.startsWith('@') ? dep : dep.split('/')[0];
-      if (!installedDependencies.has(pkg)) {
-        executeShellCommand(pkg, directory);
-        installedDependencies.add(pkg);
-      }
-    }
-  });
-}
-
-function executeShellCommand(pkg, directory = '') {
-  try {
-    const result = spawnSync(`npm`, ['i', pkg], { stdio: 'inherit', cwd: directory, shell: false });
-    if (result?.error) throw result.error;
-    console.log(`Command executed successfully`);
-  } catch (error) {
-    console.error(`Command execution failed. Error: ${error?.message}`);
-  }
-}
-async function installModules(filePath, multiple) {
-  const files = multiple ? [] : [path.basename(filePath)];
-  const dirPath = multiple ? filePath : path.dirname(filePath);
-
-  if (checkWritePermissionToDirectory(dirPath)) {
-    if (multiple) {
-      files.push(...scanDirectory(dirPath));
-    }
-
-    if (files.length === 0) {
-      console.log(`Error: Could not locate files needed to create package.json. Exiting the process.`);
-      return true;
-    }
-
-    const dependencies = scanFileForDependencies(dirPath, files);
-
-    if (!doesPackageJsonExist(dirPath)) {
-      console.log(`package.json not found. Creating a new package.json...`);
-      createPackageJson(dirPath);
-    }
-
-    installDependencies(dependencies, dirPath);
-  } else {
-    console.log(`You don't have write permission to the directory`);
-    return false;
-  }
-
-  console.log(`All dependencies installed successfully.`);
-  return true;
-}
-
-function findModulesSync(data) {
-  try {
-    const requireRegex = /require\(['"`](.*?)['"`]\)/g;
-    const importRegex = /import\s+(?:(?:[\w*\s{},]*)\s+from\s+)?['"`](.*?)['"`]/g;
-
-    const modules = new Set();
-    let match;
-
-    while ((match = requireRegex.exec(data)) !== null) {
-      modules.add(match[1]);
-    }
-
-    while ((match = importRegex.exec(data)) !== null) {
-      modules.add(match[1]);
-    }
-
-    return [...modules];
-  } catch (error) {
-    console.error(`Error reading file: ${error.message}`);
-    return [];
-  }
-}
-
-module.exports = installModules;

package/src/utils/object-helper.js

@@ -1,9 +0,0 @@
-'use strict';
-
-exports.getEntryObj = (fields, obj) => {
-  let entryObj = {};
-  fields.forEach((field) => {
-    entryObj[field] = obj[field];
-  });
-  return entryObj;
-};

package/src/utils/request.js

@@ -1,95 +0,0 @@
-'use strict'
-
-// Dependencies
-const {request} = require('https')
-const {stringify, parse} = JSON
-
-// Map helper
-const {getMapInstance, getDataWithAction} = require('./map')
-
-// constants
-const {actions, nonWritableMethods} = require('./constants')
-
-// Properties
-const {DELETE_CT} = actions
-
-module.exports = ({
-  hostname,
-  path,
-  headers,
-  method,
-  id,
-  action,
-}) => {
-  let options = {
-    hostname,
-    path,
-    headers,
-    method,
-    id,
-    action,
-  }
-  return _data => {
-    // get data here using id and action
-    let data = getData(_data, id, action, method)
-    // Special handling for non writable methods
-    options = getNewOptions(options, data, action, method)
-
-    return new Promise((resolve, reject) => {
-      const req = request(options, res => {
-        let response = ''
-
-        res.on('data', _res => {
-          response += _res.toString()
-        })
-
-        res.on('end', () => {
-          try {
-            response = parse(response)
-            resolve(response)
-          } catch (err) {
-            reject('Error while parsing response!')
-            // throw new Error('Error while parsing response!');
-          }
-        })
-      })
-
-      req.on('error', err => {
-        reject(err)
-      })
-
-      !nonWritableMethods.includes(method) && req.write(data)
-      req.end()
-    })
-  }
-}
-
-function getData(_data, id, action, method) {
-  if (method === 'GET') return
-  // if (!nonWritableMethods.includes(method)) {
-  let mapInstance = getMapInstance()
-
-  let data = _data ? _data : getDataWithAction(id, mapInstance, action)
-  return stringify(data)
-}
-
-function getNewOptions(options, data, action, method) {
-  // Special handling for delete method
-  if (action === DELETE_CT) {
-    try {
-      data = parse(data)
-    } catch (err) {
-      throw 'Error while parsing data for delete operation'
-    }
-    options.path = `${options.path}?force=${data.content_type.force}`
-  }
-
-  if (!nonWritableMethods.includes(method)) {
-    options.headers['Content-Length'] = data.length
-  } else {
-    delete options.headers['Content-Type']
-    delete options.headers['Content-Length']
-  }
-
-  return options
-}

package/src/utils/safe-promise.js

@@ -1,3 +0,0 @@
-'use strict';
-
-module.exports = (promise) => promise.then((res) => [null, res]).catch((err) => [err]);

package/src/utils/schema-helper.js

@@ -1,35 +0,0 @@
-/* eslint-disable camelcase */
-'use strict';
-
-const { version, defaultDataType, actions } = require('./constants');
-
-exports.getSchema = (field, subAction) => {
-  const { EDIT_FIELD, DELETE_FIELD } = actions;
-
-  const schema = {
-    display_name: field,
-    uid: this.getUid(field),
-    data_type: defaultDataType, // This will be overridden if user specifies data type
-    mandatory: this.getMandatoryVal(field),
-    unique: this.getUniqueVal(field),
-    field_metadata: this.getFieldMetaData(field),
-    non_localizable: false,
-    // isDelete: !!isDelete,
-    isDelete: subAction === DELETE_FIELD,
-    isEdit: subAction === EDIT_FIELD,
-  };
-  return schema;
-};
-
-exports.getUid = (data) => data.split(' ').join('_').toLowerCase();
-
-exports.getMandatoryVal = (data) => data.toLowerCase() === 'title' || data.toLowerCase() === 'url';
-
-exports.getUniqueVal = (data) => data.toLowerCase() === 'title' || data.toLowerCase() === 'url';
-
-exports.getFieldMetaData = (data) => {
-  return {
-    _default: this.getMandatoryVal(data),
-    version,
-  };
-};

package/src/utils/success-handler.js

@@ -1,12 +0,0 @@
-'use strict';
-
-const { success } = require('./logger');
-const { successMessageHandler } = require('./constants');
-
-module.exports = (data, type, method) => {
-  if (data && type && method) {
-    //success(`Successfully ${successMessageHandler[method]} ${type}: ${data}`);
-  } else {
-    success(`${type} successfully completed`);
-  }
-};

package/src/validators/api-error.js

@@ -1,20 +0,0 @@
-'use strict';
-
-class ApiError {
-  validate(data) {
-    if (data.payload.apiError) {
-      return [
-        {
-          ...data,
-          message: `${data.payload.apiError.error_message}`,
-        },
-      ];
-    }
-    return [];
-  }
-
-  isApplicable(action) {
-    return action.type === 'apiError';
-  }
-}
-module.exports = ApiError;

package/src/validators/base-validator.js

@@ -1,39 +0,0 @@
-'use strict';
-
-const { keys } = Object;
-class BaseValidator {
-  commonValidate(properties, data) {
-    const errors = [];
-    const opts = data.payload.options;
-    const dataKeys = keys(opts);
-
-    for (let i = 0; i < properties.length; i++) {
-      let prop = properties[i];
-      // Check if property is mandatory but not present in user specified params
-      if (prop.mandatory && !dataKeys.includes(prop.name)) {
-        errors.push({ ...data, message: `${prop.name} is required.` });
-      }
-
-      if (prop.name in opts) {
-        const dataType = this.getDataType(opts[prop.name]);
-        if (dataType !== prop.type) {
-          errors.push({ ...data, message: `${prop.name} is a ${dataType} type` });
-        }
-
-        if (prop.dependsOn && !(prop.dependsOn in opts) && opts[prop.name]) {
-          errors.push({ ...data, message: `${prop.dependsOn} is required with ${prop.name}` });
-        }
-      }
-    }
-
-    return errors;
-  }
-
-  getDataType(data) {
-    if (Array.isArray(data)) {
-      return 'array';
-    }
-    return typeof data;
-  }
-}
-module.exports = BaseValidator;

package/src/validators/create-content-type-validator.js

@@ -1,54 +0,0 @@
-'use strict';
-
-const { keys } = Object;
-// Utils
-const { map: _map, constants } = require('../utils');
-// Properties
-const { getMapInstance, get } = _map;
-const { contentTypeProperties } = constants;
-
-const mandatoryKeys = ['uid', 'title', 'description'];
-
-class CreateContentTypeValidator {
-  constructor() {
-    // super();
-    this.errors = [];
-  }
-
-  validate(data) {
-    // Validate the latest updated object in the global map object
-    const mapInstance = getMapInstance();
-    const mapObj = get(data.payload.contentTypeId, mapInstance);
-    const actionObj = mapObj[data.payload.action].content_type;
-    const userProvidedFields = keys(actionObj);
-
-    for (const key of mandatoryKeys) {
-      if (!keys(actionObj).includes(key) || !actionObj[key]) {
-        data = { ...data, message: `${key} is missing.` };
-        this.errors.push(data);
-      }
-    }
-
-    // TODO: Fix error messages
-    const propertyNames = this.getPropertyNames();
-
-    for (let i = 0; i < userProvidedFields.length; i++) {
-      let key = userProvidedFields[i];
-      if (!propertyNames.includes(key)) {
-        data = { ...data, message: `${key} is not valid property.` };
-        this.errors.push(data);
-      }
-    }
-    return this.errors;
-  }
-
-  isApplicable(action) {
-    return action.type === 'create';
-  }
-
-  getPropertyNames() {
-    return contentTypeProperties;
-  }
-}
-
-module.exports = CreateContentTypeValidator;

package/src/validators/edit-content-type-validator.js

@@ -1,53 +0,0 @@
-'use strict';
-
-const { keys } = Object;
-
-// Utils
-const { map: _map, constants } = require('../utils');
-// Properties
-const { getMapInstance, get } = _map;
-const { contentTypeProperties } = constants;
-
-const mandatoryKeys = ['uid', 'title'];
-
-class EditContentTypeValidator {
-  constructor() {
-    this.errors = [];
-  }
-
-  validate(data) {
-    // Validate the latest updated object in the global map object
-    const mapInstance = getMapInstance();
-    const mapObj = get(data.payload.contentTypeId, mapInstance);
-    const actionObj = mapObj[data.payload.action].content_type;
-    const userProvidedFields = keys(actionObj);
-
-    for (const key of mandatoryKeys) {
-      if (!userProvidedFields.includes(key)) {
-        data = { ...data, message: `${key} is missing.` };
-        this.errors.push(data);
-      }
-    }
-    // TODO: Fix error messages
-    const propertyNames = this.getPropertyNames();
-
-    for (let i = 0; i < userProvidedFields.length; i++) {
-      let key = userProvidedFields[i];
-      if (!propertyNames.includes(key)) {
-        data = { ...data, message: `${key} is not valid property.` };
-        this.errors.push(data);
-      }
-    }
-    return this.errors;
-  }
-
-  isApplicable(action) {
-    return action.type === 'edit';
-  }
-
-  getPropertyNames() {
-    return contentTypeProperties;
-  }
-}
-
-module.exports = EditContentTypeValidator;

package/src/validators/field-validator.js

@@ -1,21 +0,0 @@
-'use strict';
-
-class FieldValidator {
-  validate(data) {
-    if (data.payload.field) {
-      return [
-        {
-          ...data,
-          message: data.payload.field.message,
-        },
-      ];
-    }
-    return [];
-  }
-
-  isApplicable(action) {
-    return action.type === 'field';
-  }
-}
-
-module.exports = FieldValidator;

package/src/validators/index.js

@@ -1,11 +0,0 @@
-'use strict';
-
-module.exports = {
-  CreateContentTypeValidator: require('./create-content-type-validator'),
-  EditContentTypeValidator: require('./edit-content-type-validator'),
-  SchemaValidator: require('./schema-validator'),
-  FieldValidator: require('./field-validator'),
-  _TypeError: require('./type-error'),
-  ApiError: require('./api-error'),
-  MigrationError: require('./migration-error'),
-};

package/src/validators/migration-error.js

@@ -1,20 +0,0 @@
-'use strict';
-
-class MigrationError {
-  validate(data) {
-    if (data.payload.migrationError) {
-      return [
-        {
-          ...data,
-          message: `${data.payload.migrationError.migrationError.message}`,
-        },
-      ];
-    }
-  }
-
-  isApplicable(action) {
-    return action.type === 'migrationError';
-  }
-}
-
-module.exports = MigrationError;

package/src/validators/schema-validator.js

@@ -1,23 +0,0 @@
-'use strict';
-
-class SchemaValidator {
-  validate(data) {
-    const { fromField, toField, toReferenceField, deriveField } = data.payload;
-    // const fieldsToValidate = [payload]
-    if (fromField || toField || toReferenceField || deriveField) {
-      return [
-        {
-          ...data,
-          message: `${fromField || toField || toReferenceField || deriveField} does not exist on schema.`,
-        },
-      ];
-    }
-    return [];
-  }
-
-  isApplicable(action) {
-    return action.type === 'schema';
-  }
-}
-
-module.exports = SchemaValidator;

package/src/validators/type-error.js

@@ -1,22 +0,0 @@
-'use strict';
-
-class _TypeError {
-  constructor() {}
-
-  validate(data) {
-    if (data.payload.typeErrors) {
-      return [
-        {
-          ...data,
-          message: `${data.payload.typeErrors[0]} is not a valid function`,
-        },
-      ];
-    }
-    return [];
-  }
-
-  isApplicable(action) {
-    return action.type === 'typeError';
-  }
-}
-module.exports = _TypeError;