shoplazza-cli 1.0.7 → 1.0.8

package/lib/app/commands/deploy.js

@@ -1,218 +1,55 @@
-const axios = require('axios');
-const ora = require('ora');
+const inquirer = require('inquirer');
 const chalk = require('chalk');
-const fs = require('fs-extra');
-const SparkMD5 = require('spark-md5');
-const FormData = require('form-data');
-const path = require('path');
-
-const { PARNTER_URL } = require('../constants');
-const { getValue, PARTNER_KEYS, getApp, set } = require('../db/partner');
-const { getZipName } = require('./build');
-const { inputVersion } = require('../inquirers/version');
-const { line, done } = require('../log');
-
-const getZipPath = () => {
-  const spinner = ora(chalk.cyan('Finding your built zip ...')).start();
-  try {
-    const zipName = getZipName();
-    const filename = fs.readdirSync(process.cwd()).find((name) => {
-      const extname = path.extname(name).replace('.', '');
-      return extname === 'zip' && name.startsWith(zipName);
-    });
-
-    if (!filename) {
-      throw new Error('not zip');
+const ora = require('ora');
+const { getThemeExtensionConfig } = require('../utils');
+const { getThemeAppVersionList, toDeployThemeApp } = require('../api');
+
+async function deployVersion(extensionId, versionInfo) {
+  await toDeployThemeApp({
+    extension_id: extensionId,
+    version_id: versionInfo.version_id,
+    type: 'enable'
+  });
+  console.log(chalk.green(`Version ${versionInfo.version} has been deployed successfully.`));
+}
+
+async function usePrompt(versionList) {
+  const choices = versionList.map((v) => ({
+    name: `${v.version} (${v.exts}) - ${v.created_at}`,
+    value: v.version_id
+  }));
+  return inquirer.prompt([
+    {
+      type: 'list',
+      name: 'selectedVersion',
+      message: 'Select a version to deploy:',
+      choices,
+      loop: false
     }
+  ]);
+}
 
-    const fileInfo = fs.statSync(`${process.cwd()}/${filename}`);
-
-    spinner.succeed(
-      chalk.cyan(
-        `Success to find your zip: ${chalk.green(`${filename} ${(fileInfo.size / (1024 * 1024)).toFixed(2)}M`)}`
-      )
-    );
-    return path.resolve(process.cwd(), filename);
-  } catch (e) {
-    spinner.fail(chalk.red('Failed to find your zip, be sure you have built app in root dir!'));
-  }
-};
-
-const getBufferAndMd5 = async (filePath) => {
-  const spinner = ora(chalk.cyan('Begin to read zip and generate md5 code ...')).start();
-
+async function deploy() {
   try {
-    return await new Promise((resolve, reject) => {
-      const spark = new SparkMD5.ArrayBuffer();
-      let buffers = [];
-
-      const rs = fs.createReadStream(filePath, { autoClose: true });
-      rs.on('data', (data) => {
-        buffers.push(data);
-        spark.append(data);
-      });
-
-      rs.on('end', () => {
-        const md5 = spark.end();
-        const completedBuffer = Buffer.concat(buffers);
-        spinner.succeed(chalk.cyan('Success to analyse zip'));
-        resolve([completedBuffer, md5 + '.zip']);
-      });
-
-      rs.on('error', (err) => {
-        reject(err);
-      });
-    });
-  } catch (e) {
-    spinner.fail(chalk.red('Failed to analyse zip, please try again!'));
-  }
-};
-
-const getSign = async () => {
-  const spinner = ora(chalk.cyan('Waiting get file sign ...')).start();
-
-  try {
-    const app = getApp();
-    const partnerId = getValue(PARTNER_KEYS.PARTNER_ID);
-    const sessionId = getValue(PARTNER_KEYS.SESSION_ID);
-
-    const url = `${PARNTER_URL}/api/partner/apps/${app.uid}/theme_extensions/file/signv2`;
-    const res = await axios.get(url, {
-      headers: {
-        Cookie: `awesomev2=${sessionId}`,
-        'x-shoplazza-partner-id': partnerId
-      }
-    });
-    spinner.succeed(chalk.cyan('Success to get file sign'));
-    return res.data;
-  } catch (e) {
-    spinner.fail(chalk.red(e.message || e));
-  }
-};
-
-const deployOss = async () => {
-  const path = getZipPath();
-  if (path) {
-    const [buffer, md5] = await getBufferAndMd5(path);
-    const signData = await getSign();
-    if (!signData) {
-      return;
+    const { extensionId } = await getThemeExtensionConfig();
+    if (!extensionId) {
+      throw new Error('ExtensionId is empty, please use `serve` command first.');
     }
-
-    const spinner = ora(chalk.cyan('Deploying your zip to cdn ...')).start();
-
-    try {
-      const formData = new FormData();
-      formData.append('policy', signData.policy);
-      formData.append('OSSAccessKeyId', signData.access_id);
-      formData.append('success_action_status', 200);
-      formData.append('signature', signData.sign);
-      formData.append('x-oss-forbid-overwrite', 'true');
-      formData.append('key', md5);
-      formData.append('file', buffer);
-
-      const url = `https:${signData.write_host}/`;
-      const res = await axios.post(url, formData, {
-        global: true,
-        maxContentLength: 100000000,
-        maxBodyLength: 1000000000
-      });
-
-      if (res.status !== 200) {
-        throw new Error(`${res.status} ${resstatusText}`);
-      }
-      spinner.succeed();
-      return md5;
-    } catch (e) {
-      // 409 repeat filename
-      if (e?.response?.status === 409) {
-        spinner.succeed();
-        return md5;
-      }
-      spinner.fail();
-      console.log(chalk.red(e.message || e));
-    }
-  }
-};
-
-const deployPartner = async () => {
-  const md5 = await deployOss();
-  if (!md5) {
-    return;
-  }
-
-  const spinner = ora(chalk.cyan('Deploying your zip to PARTNER ...')).start();
-  try {
-    const app = getApp();
-    if (!app) {
-      spinner.fail(chalk.red('Please choose your partner first!'));
-      return;
+    const spinner = ora('Fetching version list...').start();
+    const res = await getThemeAppVersionList(extensionId);
+    const versionList = res.data?.data || [];
+    if (!versionList.length) {
+      spinner.succeed('Version list loaded.');
+      throw new Error('No version found, please use `build` command to upload a version first.');
     }
-
-    const partnerId = getValue(PARTNER_KEYS.PARTNER_ID);
-    const url = `${PARNTER_URL}/api/partner/apps/${app.uid}/theme_extensions`;
-    const res = await axios.put(
-      url,
-      {
-        title: getZipName(),
-        name: getZipName(),
-        file_name: md5
-      },
-      {
-        headers: {
-          cookie: `awesomev2=${getValue(PARTNER_KEYS.SESSION_ID)};`,
-          'x-shoplazza-partner-id': partnerId
-        }
-      }
-    );
-
-    set({ [PARTNER_KEYS.EXTENSION_ID]: res.data.extension_id });
-    spinner.succeed();
-    return true;
-  } catch (e) {
-    spinner.fail();
-    console.log(e.message || e);
-    console.log(chalk.red(JSON.stringify(e.response.data)));
+    spinner.succeed('Version list loaded.');
+    const { selectedVersion } = await usePrompt(versionList);
+    const versionInfo = versionList.find((v) => v.version_id === selectedVersion);
+    await deployVersion(extensionId, versionInfo);
+  } catch (error) {
+    console.error(chalk.red(`[ERROR IN DEPLOY] ${error.message}`));
   }
-};
-
-const createVersion = async (version) => {
-  const spinner = ora(chalk.cyan('Creating your version task ...')).start();
-
-  try {
-    const app = getApp();
-    const extensionId = getValue(PARTNER_KEYS.EXTENSION_ID);
-    const partnerId = getValue(PARTNER_KEYS.PARTNER_ID);
-
-    const url = `${PARNTER_URL}/api/partner/apps/${app.uid}/theme_extensions/${extensionId}/version_tasks`;
-    await axios.post(
-      url,
-      {
-        version
-      },
-      {
-        headers: {
-          cookie: `awesomev2=${getValue(PARTNER_KEYS.SESSION_ID)};`,
-          'x-shoplazza-partner-id': partnerId
-        }
-      }
-    );
-    spinner.succeed();
-    return true;
-  } catch (e) {
-    spinner.fail();
-    console.log(chalk.red(e.message || e));
-    console.log(chalk.red(JSON.stringify(e.response?.data)));
-  }
-};
-
-const deploy = async () => {
-  line();
-  ora(chalk.cyan('Deploy Begin')).succeed();
-  let version;
-  (await deployPartner()) && (version = await inputVersion()) && (await createVersion(version)) && done();
-  line();
-};
+}
 
 module.exports = {
   deploy

package/lib/app/commands/list.js

@@ -0,0 +1,35 @@
+const chalk = require('chalk');
+const ora = require('ora');
+const { renderTable } = require('../utils');
+const { getThemeAppList } = require('../api');
+
+/**
+ * 控制台提示
+ */
+function consoleTips(versionList) {
+  if (versionList.length) {
+    console.log(chalk.green(`\n📃 Your store has ${versionList.length} available theme extensions:`));
+    console.log(
+      renderTable(versionList, [
+        { label: 'App Name', filed: 'title' },
+        { label: 'CreateTime', filed: 'created_at', color: 'yellowBright' },
+      ])
+    );
+  } else {
+    console.log(chalk.green('Your store does not have any available theme extensions.'));
+  }
+}
+
+async function list() {
+  try {
+    const res = await getThemeAppList();
+    const themeAppList = res.data?.data || [];
+    consoleTips(themeAppList);
+  } catch (error) {
+    console.error(chalk.red(`[ERROR IN LIST] ${error.message}`));
+  }
+}
+
+module.exports = {
+  list
+};

package/lib/app/commands/release.js

@@ -0,0 +1,59 @@
+const inquirer = require('inquirer');
+const chalk = require('chalk');
+const ora = require('ora');
+const { getThemeExtensionConfig } = require('../utils');
+const { getThemeAppVersionList } = require('../api');
+const { toReleaseApp } = require('../../partner-api/index');
+
+async function releaseVersion(extensionId, versionInfo) {
+  const res = await toReleaseApp({
+    extensionId,
+    versionId: versionInfo.version_id
+  });
+  console.log(chalk.green(`Version ${versionInfo.version} has been released successfully.`));
+}
+
+async function usePrompt(versionList) {
+  const choices = versionList.map((v) => ({
+    name: `${v.version} (${v.exts}) - ${v.created_at}`,
+    value: v.version_id
+  }));
+  return inquirer.prompt([
+    {
+      type: 'list',
+      name: 'selectedVersion',
+      message: 'Select a version to release:',
+      choices,
+      loop: false
+    }
+  ]);
+}
+
+async function releaseToApp() {
+  try {
+    const { extensionId, appId } = await getThemeExtensionConfig();
+    if (!extensionId) {
+      throw new Error('ExtensionId is empty, please use `serve` command first.');
+    }
+    if (!appId) {
+      throw new Error('Missing appId, please use `connect` command first.');
+    }
+    const spinner = ora('Fetching version list...').start();
+    const res = await getThemeAppVersionList(extensionId);
+    const versionList = res.data?.data || [];
+    if (!versionList.length) {
+      spinner.succeed('Version list loaded.');
+      throw new Error('No version found, please use `build` command to upload a version first.');
+    }
+    spinner.succeed('Version list loaded.');
+    const { selectedVersion } = await usePrompt(versionList);
+    const versionInfo = versionList.find((v) => v.version_id === selectedVersion);
+    await releaseVersion(extensionId, versionInfo);
+  } catch (error) {
+    console.error(chalk.red(`[ERROR IN DEPLOY] ${error.message}`));
+  }
+}
+
+module.exports = {
+  release: releaseToApp
+};

package/lib/app/commands/serve.js

@@ -0,0 +1,172 @@
+const chalk = require('chalk');
+const inquirer = require('inquirer');
+const fsExtra = require('fs-extra');
+const ora = require('ora');
+const { STORE_DOMAIN, THEME_APP_DIR_PATH, EXCHANGE_TOKEN } = require('../utils/config');
+const { compress, getThemeExtensionConfig, setThemeExtensionConfig, getFileInfo } = require('../utils');
+const {
+  toCreateThemeApp,
+  toUploadThemeApp,
+  getTaskStatus,
+  getThemeList,
+  toCreateFile,
+  toUpdateFile,
+  toDeleteFile
+} = require('../api');
+const { watchWorkspace } = require('../../utils/utils');
+const { useOss } = require('../../oss');
+
+/**
+ * 控制台提示信息
+ */
+function consoleTips(selectedThemeId, extensionId) {
+  console.log(`\n======================================PREVIEW URLS======================================`);
+  console.log(chalk.cyan.bold('🔗 Admin Preview URL:'));
+  console.log(
+    chalk.blueBright(`  https://${STORE_DOMAIN}/admin/card?theme_id=${selectedThemeId}&ext_debug=${extensionId}\n`)
+  );
+  console.log(chalk.cyan.bold('🔗 Storefront Preview URL:'));
+  console.log(chalk.blueBright(`  https://${STORE_DOMAIN}?preview_theme_id=${selectedThemeId}&ext_debug=${extensionId}\n`));
+  console.log(`=====================================WATCHER RUNNING=====================================`);
+  console.log(chalk.green(`🎉 File watcher is now running!`));
+  console.log(chalk.green(`📂 Watching directory:`), chalk.blue(THEME_APP_DIR_PATH));
+  console.log(chalk.green(`✨ You can make changes to your files, and they will be processed automatically.`));
+  console.log(chalk.green(`🚀 Press Ctrl+C to stop.\n`));
+}
+
+/**
+ * 同步本地代码到远程服务器
+ */
+async function syncLocalFiles(extensionId) {
+  const spinner = ora('Start synchronizing local files to remote...').start();
+  const { zipPath, zipName } = await compress(THEME_APP_DIR_PATH);
+  const { uploadOss } = useOss(
+    EXCHANGE_TOKEN,
+    STORE_DOMAIN,
+    `✗ No store found. Please run ${chalk.cyan('shoplazza login')} to login to a specific store.`
+  );
+  const zipOssUrl = await uploadOss(zipPath, zipName);
+  // 上传完成删除压缩包
+  fsExtra.removeSync(zipPath);
+  const res = await toUploadThemeApp(extensionId, {
+    resource_url: zipOssUrl
+  });
+  const taskId = res.data?.task_id;
+  if (!taskId) {
+    spinner.fail(chalk.red(`Failed to synchronize local files to remote location!`));
+    throw new Error('taskId is required');
+  }
+  // 轮询查看任务是否完成
+  return new Promise((resolve, reject) => {
+    const timer = setInterval(async () => {
+      const res = await getTaskStatus({ taskId });
+      if (res.data?.state === 1) {
+        clearInterval(timer);
+        spinner.succeed(chalk.green(`Successfully synchronized local files to remote location!`));
+        resolve();
+      } else if (res.data?.state === 2) {
+        clearInterval(timer);
+        spinner.fail(chalk.red(`Failed to synchronize local files to remote location!`));
+        reject(new Error(res.data?.message));
+      } else {
+        spinner.text = chalk.blue(`[WAITING] Synchronizing local files to remote...`);
+      }
+    }, 1000);
+  });
+}
+
+/**
+ * 交互选择预览主题
+ */
+async function usePrompt() {
+  const res = await getThemeList();
+  const themeList = res.data?.data?.themes || [];
+  const { selectedThemeId } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'selectedThemeId',
+      message: 'Please select a theme to preview:',
+      choices: themeList.map((theme) => ({
+        name: theme.name,
+        value: theme.id
+      })),
+      loop: false
+    }
+  ]);
+  return selectedThemeId;
+}
+
+/**
+ * 创建主题插件
+ */
+async function createThemeApp(themeExtensionConfig) {
+  const data = {
+    title: themeExtensionConfig.extensionName || '' // 插件显示名称
+  };
+  if (themeExtensionConfig.extensionId) {
+    data.extension_id = themeExtensionConfig.extensionId;
+  }
+  const res = await toCreateThemeApp(data);
+  const extensionId = res.data?.extension_id;
+  await setThemeExtensionConfig({ extensionId });
+  return extensionId;
+}
+
+/**
+ * 启动监听
+ */
+function startWatcher(extensionId) {
+  const ACTION_MAP = {
+    ADD: 'add',
+    CHANGE: 'change',
+    DELETE: 'delete'
+  };
+  const actionToApiMap = {
+    [ACTION_MAP.ADD]: toCreateFile,
+    [ACTION_MAP.CHANGE]: toUpdateFile,
+    [ACTION_MAP.DELETE]: toDeleteFile
+  };
+  const funcCache = {};
+  const handleFileChange = (action) => {
+    if (funcCache[action]) {
+      return funcCache[action];
+    }
+    const func = (filePath) => {
+      const { fileName, parentDirName } = getFileInfo(filePath);
+      const data = {
+        type: parentDirName,
+        location: fileName
+      };
+      if ([ACTION_MAP.CHANGE, ACTION_MAP.ADD].includes(action)) {
+        data.content = fsExtra.readFileSync(filePath, 'utf-8');
+      }
+      actionToApiMap[action](extensionId, data);
+    };
+    funcCache[action] = func;
+    return func;
+  };
+  watchWorkspace(THEME_APP_DIR_PATH, {
+    onAdd: handleFileChange(ACTION_MAP.ADD),
+    onChange: handleFileChange(ACTION_MAP.CHANGE),
+    onDelete: handleFileChange(ACTION_MAP.DELETE),
+    ignored: '**/assets-manifest.json',
+  });
+}
+
+async function serve() {
+  try {
+    const themeExtensionConfig = await getThemeExtensionConfig();
+    let extensionId = themeExtensionConfig.extensionId;
+    if (!extensionId) {
+      extensionId = await createThemeApp(themeExtensionConfig);
+    }
+    await syncLocalFiles(extensionId);
+    const selectedThemeId = await usePrompt();
+    startWatcher(extensionId);
+    consoleTips(selectedThemeId, extensionId);
+  } catch (error) {
+    console.error(chalk.red(`[ERROR IN SERVE] ${error.message}`));
+  }
+}
+
+module.exports = { serve };

package/lib/app/commands/versions.js

@@ -0,0 +1,55 @@
+const chalk = require('chalk');
+const { getThemeExtensionConfig, renderTable } = require('../utils');
+const { getThemeAppVersionList } = require('../api');
+
+/**
+ * 控制台提示
+ */
+function consoleTips(versionList) {
+  if (versionList.length) {
+    const tempVersionList = versionList.map((item) => ({
+      ...item,
+      composeVersion: item.published === 1 ? `${item.version}(published)` : item.version
+    }));
+    console.log(chalk.green('\n📜 Available Versions:'));
+    console.log(
+      renderTable(tempVersionList, [
+        {
+          label: 'Version',
+          filed: 'composeVersion',
+          color: 'yellowBright'
+        },
+        {
+          label: 'CreateTime',
+          filed: 'created_at',
+          color: 'blackBright'
+        },
+        {
+          label: 'Description',
+          filed: 'exts',
+          color: 'whiteBright'
+        }
+      ])
+    );
+  } else {
+    console.log(chalk.green('Your current theme extension does not have an available version.'));
+  }
+}
+
+async function versions() {
+  try {
+    const { extensionId } = await getThemeExtensionConfig();
+    if (!extensionId) {
+      throw new Error('ExtensionId is empty, please use `serve` command first.');
+    }
+    const res = await getThemeAppVersionList(extensionId);
+    const versionList = res.data?.data || [];
+    consoleTips(versionList);
+  } catch (error) {
+    console.error(chalk.red(`[ERROR IN VERSIONS] ${error.message}`));
+  }
+}
+
+module.exports = {
+  versions
+};

package/lib/app/index.js

@@ -1,37 +1,29 @@
-const { checkAndLogin } = require('./login');
-const { build } = require('./commands/build');
-const { deploy } = require('./commands/deploy');
-const { generate } = require('./commands/generate');
-const { publish } = require('./commands/publish');
-const { choosePartner } = require('./inquirers/choose-partner');
-const { chooseApp } = require('./inquirers/choose-app');
-
-const generateExtension = async () => {
-  (await checkAndLogin()) && (await generate());
-};
+function initThemeAppCommand(_program) {
+  const program = _program.command('te').alias('theme_extension').description('Shoplazza theme extension CLI');
 
-const deployExtension = async () => {
-  (await checkAndLogin()) && (await deploy());
-};
+  program.command('create').description('Create a new theme extension').action(require('./commands/create').create);
 
-const publishExtension = async () => {
-  (await checkAndLogin()) && (await publish());
-};
+  program
+    .command('serve')
+    .description('Start a local development server for the theme extension')
+    .action(require('./commands/serve').serve);
 
-const retry = async (options) => {
-  if (options.partner) {
-    (await checkAndLogin()) && (await choosePartner()) && (await chooseApp());
-  }
+  program.command('build').description('Build the theme extension for production').action(require('./commands/build').build);
 
-  if (options.app) {
-    (await checkAndLogin()) && (await chooseApp());
-  }
-};
+  program
+    .command('versions')
+    .description('List all versions of the theme extension')
+    .action(require('./commands/versions').versions);
+
+  program.command('deploy').description('Deploy the theme extension').action(require('./commands/deploy').deploy);
+
+  program.command('list').description('List all theme extensions').action(require('./commands/list').list);
+
+  program.command('connect').description('Establish a connection between the theme extension and the shoplazza app').action(require('./commands/connect').connect);
+
+  program.command('release').description('Release a theme extension version to be applied in the shoplazza app').action(require('./commands/release').release);
+}
 
 module.exports = {
-  generateExtension,
-  deployExtension,
-  publishExtension,
-  buildExtension: build,
-  retry
+  initThemeAppCommand
 };