shoplazza-cli 1.0.5 → 1.0.7-beta.1

package/bin/shoplazza

@@ -10,8 +10,7 @@ const report = require('../lib/report');
 require('../lib/tracing');
 
 const { makeCheckoutCommand } = require('../lib/checkout');
-
-const { generateExtension, deployExtension, publishExtension, buildExtension, retry } = require('../lib/app');
+const { initThemeAppCommand } = require('../lib/app');
 
 Sentry.init({
   dsn: 'https://89964605acaf4db8839f2d5237396d6c@sentry.shoplazza.com/730',
@@ -113,21 +112,11 @@ theme
   .option('-t, --theme <theme>', 'The ID of the theme that you want to delete.')
   .action(require('../lib/commands/theme/delete'));
 
-const app = program.command('app').description('Shoplazza app extensions cli');
-
-app.command('generate').command('extension').description('Generate your extension').action(generateExtension);
-app.command('deploy').command('extension').description('Deploy your extension to cdn').action(deployExtension);
-app.command('publish').command('extension').description('Publish your extension').action(publishExtension);
-app.command('build').description('Build your extension').action(buildExtension);
-app
-  .command('retry')
-  .description('Retry to do some tasks.')
-  .option('-p, --partner', 'Retry get and choose your partner list.')
-  .option('-a, --app', 'Retry get and choose your app list.')
-  .action(retry);
 
 // checkout cli
 makeCheckoutCommand(program);
+// theme app cli
+initThemeAppCommand(program);
 
 program.parse(process.argv);
 !program.args.length && program.help();

package/lib/app/api/index.js

@@ -0,0 +1,96 @@
+const instance = require('../../openAPI/index');
+
+
+/**
+ * 获取主题列表
+ */
+async function getThemeList() {
+  return instance.get('/themes');
+}
+
+/**
+ * 获取店铺私有主题插件列表
+ * @returns
+ */
+async function getThemeAppList() {
+  return instance.get('/theme-extensions');
+}
+
+/**
+ * 创建主题插件 or 更新主题插件信息
+ */
+async function toCreateThemeApp(data) {
+  return instance.put('/theme-extensions', data);
+}
+
+/**
+ * 上传主题插件
+ */
+async function toUploadThemeApp(extension_id, data) {
+  return instance.patch(`/theme-extensions/${extension_id}/dev-doctree`, data);
+}
+
+/**
+ * 新增文件
+ */
+async function toCreateFile(extension_id, data) {
+  return instance.post(`/theme-extensions/${extension_id}/dev-doc`, data);
+}
+
+/**
+ * 更新文件
+ */
+async function toUpdateFile(extension_id, data) {
+  return instance.patch(`/theme-extensions/${extension_id}/dev-doc`, data);
+}
+
+/**
+ * 删除文件
+ */
+async function toDeleteFile(extension_id, params) {
+  return instance.delete(`/theme-extensions/${extension_id}/dev-doc`, {
+    params
+  });
+}
+
+/**
+ * 获取任务状态
+ */
+async function getTaskStatus(data) {
+  return instance.get(`/theme-extensions/version-tasks/${data.taskId}`);
+}
+
+/**
+ * 获取主题插件版本列表
+ */
+async function getThemeAppVersionList(extension_id) {
+  return instance.get(`/theme-extensions/${extension_id}/versions`);
+}
+
+/**
+ * 创建主题插件版本
+ */
+async function toCreateThemeAppVersion(data) {
+  return instance.post(`/theme-extensions/version-tasks`, data);
+}
+
+/**
+ * 部署主题插件
+ */
+async function toDeployThemeApp(data) {
+  return instance.post(`/theme-extensions/publications`, data);
+}
+
+module.exports = {
+  getThemeList,
+  getThemeAppList,
+  toCreateThemeApp,
+  toCreateFile,
+  toUpdateFile,
+  toDeleteFile,
+  toUploadThemeApp,
+  getThemeAppVersionList,
+  toCreateThemeAppVersion,
+  toDeployThemeApp,
+  getTaskStatus
+};

package/lib/app/commands/build.js

@@ -1,66 +1,114 @@
 const chalk = require('chalk');
+const inquirer = require('inquirer');
 const ora = require('ora');
-const fs = require('fs-extra');
-const path = require('path');
+const fsExtra = require('fs-extra');
+const { getThemeAppConfig, compareVersions, compress } = require('../utils');
+const { THEME_APP_DIR_PATH, EXCHANGE_TOKEN, STORE_DOMAIN } = require('../utils/config');
+const { getThemeAppVersionList, toCreateThemeAppVersion, getTaskStatus } = require('../api');
+const { useOss } = require('../../oss');
 
-const { zipTheme } = require('../../utils');
-const { line, done } = require('../log');
-const { buildThemeAssets } = require('../extensions/theme-app');
+async function createNewVersion(extensionId, version, description) {
+  const spinner = ora('Start building a new version...').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 toCreateThemeAppVersion({
+    extension_id: extensionId,
+    version,
+    exts: description,
+    resource_url: zipOssUrl
+  });
+  const taskId = res.data?.task_id;
 
-const isFileExist = (path) => {
-  return fs.existsSync(path);
-};
-
-const clearManifest = async () => {
-  try {
-    if (isFileExist('./assets-manifest.json') && isFileExist('./assets')) {
-      const mainfest = JSON.parse(fs.readFileSync('./assets-manifest.json', { encoding: 'utf-8' }));
-      await Promise.all(
-        Object.values(mainfest).map((path) => {
-          if (isFileExist(path)) {
-            return fs.unlink(path);
-          }
-          return Promise.resolve(true);
-        })
-      );
-      await fs.unlink('./assets-manifest.json');
-    }
-    return true;
-  } catch (e) {
-    console.log(e);
+  if (!taskId) {
+    spinner.fail(chalk.red(`Failed to build a new version!`));
+    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 built a new version(v${version})!`));
+        resolve();
+      } else if (res.data?.state === 2) {
+        clearInterval(timer);
+        spinner.fail(chalk.red(`Failed to build a new version!`));
+        reject(new Error(res.data?.message));
+      } else {
+        spinner.text = chalk.blue(`[WAITING] Building a new version...`);
+      }
+    }, 1000);
+  });
+}
 
-const getZipName = () => {
-  return path.basename(process.cwd());
-};
+/**
+ * 交互式命令行
+ */
+async function usePrompt(extensionId) {
+  const res = await getThemeAppVersionList(extensionId);
 
-const generateZip = async (name) => {
-  const zipPath = `${process.cwd()}/${name}.zip`;
-  isFileExist(zipPath) && (await fs.unlink(zipPath));
-  zipTheme(process.cwd(), name);
-};
+  const latestVersion = res.data?.data?.[0];
 
-const zipApp = async () => {
-  const spinner = ora(chalk.cyan('Building your app and generate zip package ...')).start();
-  try {
-    const zipName = getZipName();
-    await generateZip(zipName);
-    spinner.succeed(chalk.cyan(`Success to build your app and generate zip package: ${chalk.green(`${zipName}.zip`)}`));
-    return true;
-  } catch (e) {
-    spinner.fail(e.message);
+  if (latestVersion) {
+    console.log(
+      chalk.cyanBright(`\n🔍 Latest version: `) +
+        chalk.yellow(`${latestVersion.version} `) +
+        chalk.white(`(${latestVersion.description})`) +
+        chalk.gray(` [Released on: ${latestVersion.created_at}]`)
+    );
   }
-};
 
-const build = async () => {
-  line();
-  (await clearManifest()) && (await buildThemeAssets('./assets')) && (await zipApp());
-  done();
-  line();
-};
+  return inquirer.prompt([
+    {
+      type: 'input',
+      name: 'newVersion',
+      message: 'Enter the new version number:',
+      validate: (newVersion) => {
+        if (!/^[0-9]+\.[0-9]+\.[0-9]+$/.test(newVersion)) {
+          return chalk.red('❌ Version must follow the format X.Y.Z (e.g., 1.0.0).');
+        }
+        if (latestVersion) {
+          if (compareVersions(newVersion, latestVersion.version) !== 1) {
+            return chalk.red('❌ Version must be greater than the latest version.');
+          }
+        }
+        return true;
+      }
+    },
+    {
+      type: 'input',
+      name: 'description',
+      message: 'Enter the description for this version:',
+      validate: (description) => {
+        if (!description.trim()) {
+          return chalk.red('❌ Description cannot be empty.');
+        }
+        return true;
+      }
+    }
+  ]);
+}
+
+async function build() {
+  try {
+    const { extensionId } = await getThemeAppConfig();
+    if (!extensionId) {
+      throw new Error('ExtensionId is empty, please use `serve` command first.');
+    }
+    const { newVersion, description } = await usePrompt(extensionId);
+    await createNewVersion(extensionId, newVersion, description);
+  } catch (error) {
+    console.error(chalk.red(`[ERROR IN BUILD] ${error.message}`));
+  }
+}
 
 module.exports = {
-  build,
-  getZipName
+  build
 };

package/lib/app/commands/create.js

@@ -0,0 +1,101 @@
+const inquirer = require('inquirer');
+const path = require('path');
+const fsExtra = require('fs-extra');
+const chalk = require('chalk');
+const { WORKSPACE_PATH, THEME_APP_TYPE } = require('../utils/config');
+const { replacePlaceholders, renameFile } = require('../utils');
+
+/**
+ * 交互式命令行
+ */
+async function usePrompt() {
+  return await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'themeAppType',
+      message: 'Select theme extension type:',
+      choices: [THEME_APP_TYPE.BASIC_APP.description, THEME_APP_TYPE.EMBEDS_APP.description],
+      prefix: '*'
+    },
+    {
+      type: 'input',
+      name: 'projectName',
+      message: 'Please enter the theme extension project name:',
+      prefix: '*',
+      validate: (projectName) => {
+        if (!projectName.trim()) {
+          return 'Project name cannot be empty';
+        }
+        return true;
+      }
+    }
+  ]);
+}
+
+/**
+ * 初始化项目
+ */
+async function initProj(projectPath, projectName, isBasicApp = false) {
+  // 替换占位符 key文件相对路径 value替换的内容
+  const replacementConfig = {
+    'package.json': { projectName },
+    'theme-app/blocks/index.liquid': { projectName },
+    'theme-extension.config.json': { projectName }
+  };
+  for (const [filePath, replacements] of Object.entries(replacementConfig)) {
+    const fullPath = path.resolve(projectPath, filePath);
+    await replacePlaceholders(fullPath, replacements);
+  }
+
+  // 重命名文件
+  const filesToRename = [
+    isBasicApp ? 'assets/index.css' : 'snippets/index_css.liquid',
+    'blocks/index.liquid',
+    'snippets/index.liquid'
+  ];
+  for (const file of filesToRename) {
+    const filePath = path.resolve(projectPath, 'theme-app', file);
+    await renameFile(filePath, `${projectName}${filePath.includes('_css') ? '_css' : ''}`);
+  }
+}
+
+/**
+ * 控制台提示信息
+ */
+function consoleTips(projectName) {
+  console.log(chalk.green(`Theme extension project "${projectName}" has been successfully created.`));
+  console.log(chalk.bold(`To get started:\n`));
+  console.log(`  ${chalk.cyan(`cd ${projectName}`)}`);
+  console.log(`  ${chalk.cyan(`npm start`)}\n`);
+  console.log(chalk.greenBright(`Happy coding! 🎉🎉🎉`));
+}
+
+/**
+ * 创建项目
+ */
+async function _create(themeAppDescription, projectName) {
+  const projectPath = path.resolve(WORKSPACE_PATH, projectName);
+
+  if (fsExtra.pathExistsSync(projectPath)) {
+    throw new Error(`Project directory "${projectName}" already exists.`);
+  }
+  await fsExtra.ensureDir(projectPath);
+  const isBasicApp = themeAppDescription === THEME_APP_TYPE.BASIC_APP.description;
+  const templatePath = isBasicApp ? THEME_APP_TYPE.BASIC_APP.templatePath : THEME_APP_TYPE.EMBEDS_APP.templatePath;
+  await fsExtra.copy(templatePath, projectPath);
+  await initProj(projectPath, projectName, isBasicApp);
+  consoleTips(projectName);
+}
+
+async function create() {
+  try {
+    const { themeAppType, projectName } = await usePrompt();
+    await _create(themeAppType, projectName);
+  } catch (error) {
+    console.error(chalk.red(`[ERROR IN CREATE] ${error.message}`));
+  }
+}
+
+module.exports = {
+  create
+};

package/lib/app/commands/deploy.js

@@ -1,218 +1,54 @@
-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 { getThemeAppConfig } = 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
     }
+  ]);
+}
 
-    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 getThemeAppConfig();
+    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