shoplazza-cli 1.1.2 → 2.0.0

package/lib/checkout/util.js

@@ -1,201 +0,0 @@
-const AdmZip = require('adm-zip');
-const { cwd, configFile } = require('./config');
-const fs = require('fs');
-const path = require('path');
-const { consoleError, consoleBlue } = require('../utils/console');
-const inquirer = require('inquirer');
-
-const walkSync = (currentDirPath, callback) => {
-  fs.readdirSync(currentDirPath, { withFileTypes: true }).forEach(function (dirent) {
-    var filePath = path.join(currentDirPath, dirent.name);
-    if (dirent.isFile()) {
-      callback(filePath, dirent);
-    } else if (dirent.isDirectory()) {
-      walkSync(filePath, callback);
-    }
-  });
-};
-
-function getExtensionPathById(extensionId) {
-  return path.join(cwd, !cwd.includes('/extensions') ? 'extensions' : '', extensionId);
-}
-
-/**
- * 根据id获取当前extension信息
- * @param {*} extensionId
- * @returns
- */
-function getExtensionInfo(extensionId) {
-  let result = {};
-  const currentPath = path.resolve(cwd);
-  const isInExtensionDir = !!fs.readdirSync(currentPath).find((f) => f === configFile);
-  // 已经在一个extension内部
-  if (isInExtensionDir) {
-    const extensionId = currentPath.split('/').pop();
-    result = {
-      path: currentPath,
-      id: extensionId
-    };
-  } else if (extensionId) {
-    const extensionPath = path.join(cwd, !cwd.includes('/extensions') ? 'extensions' : '', extensionId);
-    if (!fs.existsSync(extensionPath)) {
-      throw `The extension '${extensionId}' does not exist in your local project.`;
-    }
-
-    result = {
-      id: extensionId,
-      path: extensionPath
-    };
-  } else {
-    let dirPath = path.resolve(cwd);
-
-    if (!dirPath.includes('extensions')) {
-      consoleError('Please specify Extension id through --id.');
-      throw 'not_id';
-    }
-    const extensionId = dirPath.split('/').pop();
-    result = {
-      id: extensionId,
-      path: dirPath
-    };
-  }
-  result.distPath = getDistPath();
-  if (fs.existsSync(result.distPath)) {
-    result.distName = fs.readdirSync(result.distPath).find((f) => f.includes(result.id));
-  }
-  return result;
-}
-
-function getExtensionConfig(id) {
-  const info = getExtensionInfo(id);
-  const config = path.join(info.path, configFile);
-
-  if (!fs.existsSync(config)) {
-    consoleError(`Extension '${info.id}' not exist ${configFile}.`);
-    throw 'not_exist_config_file';
-  }
-  return JSON.parse(fs.readFileSync(config, 'utf-8'));
-}
-
-function getRootPath() {
-  return cwd;
-}
-
-function getExtensionsPath() {
-  return path.join(getRootPath(), 'extensions');
-}
-
-function getDistPath() {
-  return path.join(getRootPath(), 'dist');
-}
-
-function getProjectConfig() {
-  return require(path.join(getRootPath(), 'extension.config.js'));
-}
-
-function copy(src, dest) {
-  const stat = fs.statSync(src);
-  if (stat.isDirectory()) {
-    copyDir(src, dest);
-  } else {
-    fs.copyFileSync(src, dest);
-  }
-}
-
-function copyDir(srcDir, destDir) {
-  fs.mkdirSync(destDir, { recursive: true });
-  for (const file of fs.readdirSync(srcDir)) {
-    const srcFile = path.resolve(srcDir, file);
-    const destFile = path.resolve(destDir, file);
-    copy(srcFile, destFile);
-  }
-}
-
-/**
- * 选择模式，返回所选extension信息
- * @param {Array} extensionList extension列表
- * @param {String} type 类型：push | deploy | undeploy | preview
- * @returns {Object} 所选extension信息
- */
-async function useSelectExtensionMode(extensionList = [], type = 'push') {
-  const choices = extensionList.map((item, index) => ({
-    name: (type === 'push' && index === 0) ? item.name : `${item.name || item.extension_id}(${item.extension_id})`,
-    value: item.extension_id
-  }))
-  if (!choices.length) {
-    consoleBlue(`No extensions available to ${type}.`);
-    process.exit(1);
-  }
-  const { extensionId } = await inquirer
-    .prompt([
-      {
-        type: 'list',
-        name: 'extensionId',
-        message: `Please select an extension to ${type}:`,
-        prefix: '*',
-        loop: false,
-        choices,
-      },
-    ])
-  return extensionList.find((item) => item.extension_id === extensionId);
-}
-
-/**
- * 重写指定extension的extension.json文件内容
- * @param {String} extensionName extension名称
- * @param {*} extensionConfig extension配置
- */
-function setExtensionConfig(extensionName, extensionConfig) {
-  const info = getExtensionInfo(extensionName);
-  const configFilePath = path.join(info.path, configFile);
-  if (!fs.existsSync(configFilePath)) {
-    consoleError(`Extension '${extensionName}' does not exist in ${configFile}.`);
-    throw 'Config file does not exist';
-  } else {
-    fs.writeFile(configFilePath, JSON.stringify(extensionConfig, null, 2), (err) => {
-      if (err) {
-        consoleError(`Error writing file to disk: ${err}`);
-      }
-    });
-  }
-}
-
-/**
- * 判断是否为本地extension
- * @param {String} extensionInfo extension信息
- */
-function checkLocalExtension(extensionInfo) {
-  const extensionPath = path.resolve(cwd, './extensions', extensionInfo.name || extensionInfo.extension_id); // todo: 此处extension_id兼容已存在extension，可考虑去掉
-  if (fs.existsSync(extensionPath)) {
-    const extensionJsonPath = path.resolve(extensionPath, './extension.json');
-    const localExtensionInfo = JSON.parse(fs.readFileSync(extensionJsonPath, 'utf8'));
-    if (localExtensionInfo.extensionId !== extensionInfo.extension_id) {
-      throw `The extension ${extensionInfo.name}(${extensionInfo.extension_id}) does not exist in your local project.`;
-    }
-  } else {
-    throw `The extension ${extensionInfo.name}(${extensionInfo.extension_id}) does not exist in your local project.`;
-  }
-}
-
-module.exports = {
-  copy,
-  getRootPath,
-  getDistPath,
-  getExtensionsPath,
-  getProjectConfig,
-  getExtensionInfo,
-  getExtensionConfig,
-  getExtensionPathById,
-  getFileJson: async (path) => JSON.parse(await fs.readFileSync(path)),
-  debug: async (...log) => {
-    ~process.argv.indexOf('--debug') && console.log(`${log.join('  ')}`);
-  },
-  zip: (filePath, uuid) => {
-    const zip = new AdmZip();
-    zip.addLocalFolder(filePath, uuid);
-    zip.writeZip(`${cwd}/${uuid}.zip`);
-  },
-  useSelectExtensionMode,
-  setExtensionConfig,
-  checkLocalExtension
-};

package/lib/checkout/verify.js

@@ -1,16 +0,0 @@
-const api = require('./api');
-const { consoleError } = require('../utils/console');
-const {  getProjectConfig } = require('./util');
-
-async function verifyConfig(commands) {
-  const configJson = getProjectConfig();
-  if (!configJson.token || !configJson.store) {
-    consoleError(`Must provide the token and store of the shop in extension.config.js config file.`);
-    throw 'not_exist_token_or_store';
-  }
-  return configJson;
-}
-
-module.exports = {
-  verifyConfig
-};

package/lib/checkout/version.js

@@ -1,7 +0,0 @@
-const semver = require("semver");
-const { engines } = require("../../package");
-const version = engines.node;
-if (!semver.satisfies(process.version, version)) {
-  console.error(`Required node version ${version}`);
-  process.exit(1);
-}

package/lib/commands/__tests__/login.test.js

@@ -1,77 +0,0 @@
-const { login } = require('../login');
-const axios = require('axios');
-const { get, empty } = require('../../db/user');
-const MockAdapter = require('axios-mock-adapter');
-const { SSO_AUTH_URL, ACCOUNT_URL } = require('../../config');
-
-jest.mock('../../db');
-jest.mock('../../auth/getCode');
-jest.mock('inquirer', () => ({
-  prompt: () => Promise.resolve({ confirm: 'Yes' })
-}));
-jest.mock('ora', () => () => ({
-  start: () => ({
-    stop: () => {}
-  })
-}));
-
-describe('login', () => {
-  let mock;
-
-  beforeEach(() => {
-    mock = new MockAdapter(axios);
-    empty();
-  });
-
-  afterEach(() => {
-    mock.reset();
-    empty();
-  });
-
-  it('success', async () => {
-    mock.onPost(`${SSO_AUTH_URL}/api/oauth/token`).replyOnce(200, {
-      access_token: 'access_token',
-      session_id: 'session_id'
-    });
-
-    mock.onGet(`${SSO_AUTH_URL}/api/sso/current/users`).replyOnce(200, {
-      users: [
-        {
-          user_id: 'user_id'
-        }
-      ]
-    });
-
-    mock.onPost(`${ACCOUNT_URL}/api/accounts/store/token`).replyOnce(200, {
-      access_token: 'exchange_token'
-    });
-
-    console.log = jest.fn;
-    await login({
-      store: 'developer.myshoplaza.com'
-    });
-    expect(get('access_token')).toBe('access_token');
-    expect(get('session_id')).toBe('session_id');
-    expect(get('user_id')).toBe('user_id');
-    expect(get('exchange_token')).toBe('exchange_token');
-    expect(get('store_domain')).toBe('developer.myshoplaza.com');
-  });
-
-  it('failed', async () => {
-    const mockExit = jest.spyOn(process, 'exit').mockImplementation((number) => {
-      throw new Error('process.exit: ' + number);
-    });
-
-    mock.onPost(`${SSO_AUTH_URL}/api/oauth/token`).replyOnce(500, {});
-    await login({
-      store: 'developer-failed.myshoplaza.com'
-    });
-    expect(mockExit).toHaveBeenCalledWith(-1);
-
-    expect(get('access_token')).toBe(null);
-    expect(get('session_id')).toBe(null);
-    expect(get('user_id')).toBe(null);
-    expect(get('exchange_token')).toBe(null);
-    expect(get('store_domain')).toBe(null);
-  });
-});

package/lib/commands/__tests__/logout.test.js

@@ -1,29 +0,0 @@
-const logout = require('../logout');
-const { get, set, empty } = require('../../db/user');
-
-jest.mock('../../db');
-
-describe('logout', () => {
-  beforeEach(() => {
-    empty();
-  });
-
-  it('success', async () => {
-    set({
-      user_id: 'user_id',
-      session_id: 'session_id',
-      access_token: 'access_token',
-      exchange_token: 'exchange_token'
-    });
-    expect(get('access_token')).toBe('access_token');
-    expect(get('session_id')).toBe('session_id');
-    expect(get('user_id')).toBe('user_id');
-    expect(get('exchange_token')).toBe('exchange_token');
-    console.log = jest.fn;
-    logout();
-    expect(get('access_token')).toBe(null);
-    expect(get('session_id')).toBe(null);
-    expect(get('user_id')).toBe(null);
-    expect(get('exchange_token')).toBe(null);
-  });
-});

package/lib/commands/__tests__/store.test.js

@@ -1,44 +0,0 @@
-const store = require('../store');
-const chalk = require('chalk');
-const { set, empty } = require('../../db/user');
-const MockAdapter = require('axios-mock-adapter');
-const openAPI = require('../../openAPI');
-
-jest.mock('../../db');
-jest.mock('../../openAPI');
-
-describe('store', () => {
-  let mock;
-
-  beforeEach(() => {
-    set({
-      store_domain: 'developer.myshoplaza.com'
-    });
-    mock = new MockAdapter(openAPI);
-  });
-
-  afterEach(() => {
-    mock.reset();
-    empty();
-  });
-
-  it('success', async () => {
-    mock.onGet(`https://developer.myshoplaza.com/openapi/2020-07/shop`).replyOnce(200, {
-      shop: {
-        domain: 'developer.myshoplaza.com'
-      }
-    });
-    console.log = jest.fn();
-    await store();
-    expect(console.log.mock.calls[0][0]).toBe(
-      `You're currently logged into ${chalk.green('developer.myshoplaza.com')}`
-    );
-  });
-
-  it('failed', async () => {
-    mock.onGet(`https://developer.myshoplaza.com/openapi/2020-07/shop`).replyOnce(500);
-    console.log = jest.fn();
-    await store();
-    expect(console.log.mock.calls[0][0]).toBe(chalk.red(`✗ Failed to get store`));
-  });
-});

package/lib/commands/__tests__/switch.test.js

@@ -1,45 +0,0 @@
-const axios = require('axios');
-const chalk = require('chalk');
-const switchCommand = require('../switch');
-const { get, set, empty } = require('../../db/user');
-const MockAdapter = require('axios-mock-adapter');
-const { ACCOUNT_URL } = require('../../config');
-
-jest.mock('../../db');
-
-describe('switch', () => {
-  let mock;
-
-  beforeEach(() => {
-    mock = new MockAdapter(axios);
-    empty();
-    set({ access_token: 'access_token' });
-  });
-
-  afterEach(() => {
-    mock.reset();
-    empty();
-  });
-
-  it('switch success', async () => {
-    mock.onPost(`${ACCOUNT_URL}/api/accounts/store/token`).replyOnce(200, {
-      access_token: 'exchange_token'
-    });
-    console.log = jest.fn;
-    await switchCommand({
-      store: 'developer.myshoplaza.com'
-    });
-    expect(get('access_token')).toBe('access_token');
-    expect(get('exchange_token')).toBe('exchange_token');
-  });
-
-  it('switch failed', async () => {
-    mock.onPost(`${ACCOUNT_URL}/api/accounts/store/token`).replyOnce(500, {});
-    console.log = jest.fn;
-    await switchCommand({
-      store: 'developer-failed.myshoplaza.com'
-    });
-    expect(get('access_token')).toBe(null);
-    expect(get('exchange_token')).toBe(null);
-  });
-});

package/lib/commands/login.js

@@ -1,120 +0,0 @@
-const chalk = require('chalk');
-const inquirer = require('inquirer');
-const Sentry = require('@sentry/node');
-const ora = require('ora');
-const { get } = require('../db/user');
-const { hasBeenSetAnalytics, setAnalyticsConfig } = require('../db/analytics');
-const log = require('../log');
-const { getShopDetail } = require('../openAPI/api');
-const getCode = require('../auth/getCode');
-const { postAccessToken, getUserInfo, postExchangeToken, postStoreToken } = require('../auth');
-const { loginIntoPartner } = require('../common/login');
-
-let spinner;
-
-const checkAndLogin = async (store) => {
-  if (get('exchange_token')) {
-    if (get('store_domain') === store) {
-      try {
-        await getShopDetail({ ignoreLogError: true });
-        log.info(`${chalk.green('✓')} Already logged in to ${chalk.green(store)}`);
-        return;
-      } catch (err) {
-        // Ignore
-      }
-    } else {
-      try {
-        await postExchangeToken(store, { ignoreLogError: true });
-        log.info(`Logged into ${chalk.green(get('store_domain'))}`);
-        return;
-      } catch (err) {
-        // Ignore
-      }
-    }
-  }
-
-  const code = await getCode(store);
-  spinner = ora(`Logging in to ${chalk.green(store)}`).start();
-  log.info(`${chalk.green('✓')} Initiating authentication`);
-  await postAccessToken(code, store);
-  await getUserInfo(store);
-  await postExchangeToken(store);
-  await postStoreToken(store);
-  spinner?.stop?.();
-  log.info(`${chalk.green('✓')} Finalizing authentication`);
-  log.info(`Logged into ${chalk.green(get('store_domain'))}`);
-  requestAnalyticsIfNeeded();
-};
-
-const requestAnalyticsIfNeeded = async () => {
-  const user_id = get('user_id');
-  if (hasBeenSetAnalytics(user_id)) return;
-  try {
-    const answers = await inquirer.prompt([
-      {
-        name: 'confirm',
-        type: 'list',
-        message: `Are you sure you want to enable usage reporting?`,
-        choices: ['Yes', 'No']
-      }
-    ]);
-    setAnalyticsConfig({
-      user_id,
-      enabled: answers.confirm === 'Yes' ? 1 : 0
-    });
-  } catch (error) {
-    log.error(chalk.red('✗ Failed to authenticate'));
-    Sentry.captureException(err);
-  }
-};
-
-const handleStoreUrl = (url) => {
-  const ERROR_MESSAGE =
-    'Invalid store domain. Please provide the store domain in the following format: developer.myshoplaza.com';
-  try {
-    if (!url.includes('myshoplaza.com')) {
-      throw new Error(ERROR_MESSAGE);
-    }
-    !url.startsWith('https://') && (url = `https://${url}`);
-    return new URL(url).host;
-  } catch (error) {
-    log.error(chalk.red(`✗ ${ERROR_MESSAGE}`));
-  }
-};
-
-const loginIntoStore = async (store) => {
-  try {
-    if (store) {
-      const storeUrl = handleStoreUrl(store);
-      storeUrl && (await checkAndLogin(storeUrl));
-    } else {
-      const answers = await inquirer.prompt([
-        {
-          name: 'store',
-          type: 'input',
-          message: 'The store domain (Eg: developer.myshoplaza.com)'
-        }
-      ]);
-      if (answers.store) {
-        const storeUrl = handleStoreUrl(answers.store);
-        storeUrl && (await checkAndLogin(storeUrl));
-      } else {
-        log.error(chalk.red(`✗ Please input the store domain.`));
-        return;
-      }
-    }
-  } catch (error) {
-    spinner?.stop?.();
-    log.error(chalk.red(`✗ Failed to authenticate`));
-    Sentry.captureException(error);
-  }
-};
-
-exports.login = async (options) => {
-  if (options.partner) {
-    await loginIntoPartner();
-    return;
-  } else {
-    await loginIntoStore(options.store);
-  }
-};

package/lib/commands/logout.js

@@ -1,23 +0,0 @@
-const Sentry = require('@sentry/node');
-const chalk = require('chalk');
-const { empty: emptyUser } = require('../db/user');
-const { logoutPartner } = require('../common/logout');
-const log = require('../log');
-
-const logoutStore = () => {
-  try {
-    emptyUser();
-    log.info('Successfully logged out of your store account');
-  } catch (error) {
-    log.error(chalk.red(`✗ Failed to logout your store account`));
-    Sentry.captureException(error);
-  }
-};
-
-module.exports = (options) => {
-  if (options.partner) {
-    logoutPartner();
-  } else {
-    logoutStore();
-  }
-};

package/lib/commands/store.js

@@ -1,14 +0,0 @@
-const chalk = require('chalk');
-const Sentry = require('@sentry/node');
-const { getShopDetail } = require('../openAPI/api');
-const log = require('../log');
-
-module.exports = async () => {
-  try {
-    const { data } = await getShopDetail();
-    log.info(`You're currently logged into ${chalk.green(data.shop.domain)}`);
-  } catch (error) {
-    log.error(chalk.red(`✗ Failed to get store`));
-    Sentry.captureException(error);
-  }
-};

package/lib/commands/switch.js

@@ -1,52 +0,0 @@
-const chalk = require('chalk');
-const inquirer = require('inquirer');
-const Sentry = require('@sentry/node');
-const { get } = require('../db/user');
-const log = require('../log');
-const { postExchangeToken } = require('../auth');
-
-const switchStore = async (store) => {
-  if (!get('access_token')) {
-    log.error(chalk.red(`✗ Please login again with ${chalk.cyan('shoplazza login')}`));
-  } else {
-    try {
-      await postExchangeToken(store);
-      log.info(`Switched store to ${chalk.green(store)}`);
-    } catch (error) {
-      log.error(chalk.red(`✗ Failed to switch store`));
-      Sentry.captureException(error);
-    }
-  }
-};
-
-module.exports = async (options) => {
-  try {
-    if (options.store) {
-      return switchStore(options.store);
-    } else {
-      const answers = await inquirer.prompt([
-        {
-          name: 'store',
-          type: 'input',
-          message: 'The store domain (Eg: developer.myshoplaza.com )'
-        }
-      ]);
-      if (answers.store) {
-        if (!answers.store.includes('myshoplaza.com')) {
-          log.error(
-            chalk.red(
-              `✗ Invalid store provided ${answers.store}. Please provide the store in the following format: developer.myshoplaza.com`
-            )
-          );
-          process.exit(-1);
-        }
-        return switchStore(answers.store);
-      } else {
-        log.error(chalk.red(`✗ Please input the store domain.`));
-      }
-    }
-  } catch (error) {
-    log.error(chalk.red(`✗ Failed to switch store`));
-    Sentry.captureException(error);
-  }
-};

package/lib/commands/theme/__tests__/delete.test.js

@@ -1,49 +0,0 @@
-const MockAdapter = require('axios-mock-adapter');
-const chalk = require('chalk');
-const deleteCommand = require('../delete');
-const openAPI = require('../../../openAPI');
-const { set, empty } = require('../../../db/user');
-
-jest.mock('inquirer', () => ({
-  prompt: () => Promise.resolve({ confirm: 'Yes' })
-}));
-jest.mock('../../../db');
-jest.mock('../../../openAPI/index');
-
-describe('delete theme', () => {
-  let mock;
-
-  beforeEach(() => {
-    set({
-      store_domain: 'developer.myshoplaza.com'
-    });
-    mock = new MockAdapter(openAPI);
-  });
-
-  afterEach(() => {
-    mock.reset();
-    empty();
-  });
-
-  it('delete success', async () => {
-    mock.onGet(`https://developer.myshoplaza.com/openapi/2020-07/themes/theme_id`).replyOnce(200, {
-      data: { name: 'test' }
-    });
-    mock.onDelete(`https://developer.myshoplaza.com/openapi/2020-07/themes/theme_id`).replyOnce(200);
-
-    console.log = jest.fn();
-    await deleteCommand({ theme: 'theme_id' });
-    expect(console.log.mock.calls[0][0]).toBe(chalk.green(`✓ test (theme_id) theme deleted`));
-  });
-
-  it('delete failed', async () => {
-    mock.onGet(`https://developer.myshoplaza.com/openapi/2020-07/themes/theme_id`).replyOnce(200, {
-      data: { name: 'test' }
-    });
-    mock.onDelete(`https://developer.myshoplaza.com/openapi/2020-07/themes/theme_id`).replyOnce(500);
-
-    console.log = jest.fn();
-    await deleteCommand({ theme: 'theme_id' });
-    expect(console.log.mock.calls[0][0]).toBe(chalk.red(`✗ Failed to delete theme`));
-  });
-});