shoplazza-cli 1.1.2 → 2.0.0

package/lib/theme-extension/commands/build.js

@@ -1,114 +0,0 @@
-const chalk = require('chalk');
-const inquirer = require('inquirer');
-const ora = require('ora');
-const fsExtra = require('fs-extra');
-const { getThemeExtensionConfig, 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');
-
-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;
-
-  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 build 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);
-  });
-}
-
-/**
- * 交互式命令行
- */
-async function usePrompt(extensionId) {
-  const res = await getThemeAppVersionList(extensionId);
-
-  const latestVersion = res.data?.data?.[0];
-
-  if (latestVersion) {
-    console.log(
-      chalk.cyanBright(`\n🔍 Latest version: `) +
-        chalk.yellow(`${latestVersion.version} `) +
-        chalk.white(`(${latestVersion.exts})`) +
-        chalk.gray(` [Released on: ${latestVersion.created_at}]`)
-    );
-  }
-
-  return inquirer.prompt([
-    {
-      type: 'input',
-      name: 'newVersion',
-      message: 'Enter the new version number(e.g., 1.0.0):',
-      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 getThemeExtensionConfig();
-    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
-};

package/lib/theme-extension/commands/connect.js

@@ -1,73 +0,0 @@
-const chalk = require('chalk');
-const inquirer = require('inquirer');
-const { getThemeExtensionConfig, setThemeExtensionConfig } = require('../utils');
-const { toConnectApp } = require('../../partner-api/index');
-
-/**
- * 交互式命令行
- */
-async function usePrompt() {
-  return await inquirer.prompt([
-    {
-      type: 'input',
-      name: 'clientId',
-      message: 'Please enter the shoplazza app Client ID:',
-      prefix: '*',
-      validate: (clientId) => {
-        if (!clientId.trim()) {
-          return 'Client ID cannot be empty';
-        }
-        return true;
-      }
-    },
-    {
-      type: 'input',
-      name: 'clientSecret',
-      message: 'Please enter the shoplazza app Client Secret:',
-      prefix: '*',
-      validate: (clientSecret) => {
-        if (!clientSecret.trim()) {
-          return 'Client Secret cannot be empty';
-        }
-        return true;
-      }
-    }
-  ]);
-}
-
-async function connectToApp() {
-  try {
-    let { extensionId, appId, accessToken } = await getThemeExtensionConfig();
-    if (!extensionId) {
-      throw new Error('ExtensionId is empty, please use `serve` command first.');
-    }
-
-    if (!accessToken) {
-      const result = await usePrompt();
-      appId = result.clientId;
-      appSecret = result.clientSecret;
-      await setThemeExtensionConfig({
-        appId,
-        appSecret
-      });
-    }
-
-    const res = await toConnectApp({
-      extensionId,
-      appId
-    });
-
-    if (+res.data?.code === 200) {
-      console.log(chalk.green('Connected to the Shoplazza app successfully!'));
-      console.log(chalk.cyan('You can use the `release` command to release a specific version to the Shoplazza app.'));
-    } else if (+res.data?.code === 400) {
-      console.log(chalk.green(res.data?.message));
-    }
-  } catch (error) {
-    console.error(chalk.red(`[ERROR IN CONNECT] ${error.message}`));
-  }
-}
-
-module.exports = {
-  connect: connectToApp
-};

package/lib/theme-extension/commands/create.js

@@ -1,105 +0,0 @@
-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';
-        }
-        // 禁止包含空格
-        if (projectName.includes(' ')) {
-          return 'Project name cannot contain spaces';
-        }
-        return true;
-      }
-    }
-  ]);
-}
-
-/**
- * 初始化项目
- */
-async function initProj(projectPath, projectName, isBasicApp = false) {
-  // 替换占位符 key文件相对路径 value替换的内容
-  const replacementConfig = {
-    'package.json': { projectName },
-    'theme-app/blocks/index.liquid': { projectName },
-    '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/theme-extension/commands/deploy.js

@@ -1,56 +0,0 @@
-const inquirer = require('inquirer');
-const chalk = require('chalk');
-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
-    }
-  ]);
-}
-
-async function deploy() {
-  try {
-    const { extensionId } = await getThemeExtensionConfig();
-    if (!extensionId) {
-      throw new Error('ExtensionId is empty, please use `serve` 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 deployVersion(extensionId, versionInfo);
-  } catch (error) {
-    console.error(chalk.red(`[ERROR IN DEPLOY] ${error.message}`));
-  }
-}
-
-module.exports = {
-  deploy
-};

package/lib/theme-extension/commands/list.js

@@ -1,35 +0,0 @@
-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/theme-extension/commands/release.js

@@ -1,59 +0,0 @@
-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/theme-extension/commands/serve.js

@@ -1,179 +0,0 @@
-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 spinner = ora('Fetching theme list...').start();
-  const res = await getThemeList();
-  const themeList = res.data?.data?.themes || [];
-  if (!themeList.length) {
-    spinner.succeed('Theme list loaded.');
-    throw new Error('Your store has no unpublished themes. Please add themes and try again.');
-  } else {
-    spinner.succeed('Theme list loaded.');
-    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/theme-extension/commands/versions.js

@@ -1,55 +0,0 @@
-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
-};