shoplazza-cli 1.0.6 → 1.0.7-beta.2

package/bin/shoplazza

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 
 process.noDeprecation = true; // 全局禁用废弃警告
+require('../lib/check');
 const { program } = require('commander');
 const updateNotifier = require('update-notifier');
 const Sentry = require('@sentry/node');
@@ -11,6 +12,7 @@ require('../lib/tracing');
 
 const { makeCheckoutCommand } = require('../lib/checkout');
 const { initThemeAppCommand } = require('../lib/app');
+const { makeFunctionCommand } = require('../lib/function');
 
 Sentry.init({
   dsn: 'https://89964605acaf4db8839f2d5237396d6c@sentry.shoplazza.com/730',
@@ -29,6 +31,7 @@ updateNotifier({ pkg }).notify({
   isGlobal: true
 });
 program.usage('[command] [options]');
+program.option('--debug <ent>', 'debug mode')
 
 program.command('version').description('Welcome to the Shoplazza CLI').action(require('../lib/commands/version'));
 program.description('Welcome to the Shoplazza CLI').option('-v --version').action(require('../lib/commands/version'));
@@ -112,11 +115,12 @@ theme
   .option('-t, --theme <theme>', 'The ID of the theme that you want to delete.')
   .action(require('../lib/commands/theme/delete'));
 
-
 // checkout cli
 makeCheckoutCommand(program);
 // theme app cli
 initThemeAppCommand(program);
+// function cli
+makeFunctionCommand(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');
+const request = require('../../partner-api/axios');
+
+/**
+ * 获取主题列表
+ */
+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,59 +1,83 @@
 const chalk = require('chalk');
 const inquirer = require('inquirer');
-const path = require('path');
-const { getThemeAppConfig, compareVersions } = require('../utils');
-const { getThemeAppVersionList, toCreateThemeAppVersion } = require('../api/api');
+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(appId, version, description) {
-  const themeAppPath = path.resolve(WORKSPACE_PATH, 'theme-app');
-  const { zipPath, zipName } = await compress(themeAppPath);
+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);
-  const taskId = await toCreateThemeAppVersion({
-    extension_id: appId,
+  // 上传完成删除压缩包
+  fsExtra.removeSync(zipPath);
+  const res = await toCreateThemeAppVersion({
+    extension_id: extensionId,
     version,
-    description,
+    exts: description,
     resource_url: zipOssUrl
   });
-  while (true) {
-    const res = await getTaskStatus({ taskId });
-    if (res.data?.task?.state === 1) {
-      console.log(chalk.green(`[SUCCESS] Theme app pushed successfully.`));
-      break;
-    } else if (res.data?.task?.state === 2) {
-      console.error(chalk.red(`[ERROR] Theme app push failed: ${res.data?.task?.error_message}`));
-      break;
-    } else {
-      console.log(chalk.yellow(`[WAITING] Theme app push in progress...`));
-      await new Promise((resolve) => setTimeout(resolve, 1000));
-    }
+  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() {
-  const versionList = await getThemeAppVersionList();
-  const latestVersion = versionList[versionList.length - 1];
+async function usePrompt(extensionId) {
+  const res = await getThemeAppVersionList(extensionId);
 
-  console.log(
-    chalk.cyanBright(`\n🔍 Latest version: `) +
-      chalk.yellow(`${latestVersion.version} `) +
-      chalk.white(`(${latestVersion.description})`) +
-      chalk.gray(` [Released on: ${latestVersion.date}]`)
-  );
+  const latestVersion = res.data?.data?.[0];
+
+  if (latestVersion) {
+    console.log(
+      chalk.cyanBright(`\n🔍 Latest version: `) +
+        chalk.yellow(`${latestVersion.version} `) +
+        chalk.white(`(${latestVersion.description})`) +
+        chalk.gray(` [Released on: ${latestVersion.created_at}]`)
+    );
+  }
 
   return inquirer.prompt([
     {
       type: 'input',
       name: 'newVersion',
-      message: 'Enter the new version number:',
+      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 (compareVersions(newVersion, latestVersion.version) !== 1) {
-          return chalk.red('❌ Version must be greater than the latest version.');
+        if (latestVersion) {
+          if (compareVersions(newVersion, latestVersion.version) !== 1) {
+            return chalk.red('❌ Version must be greater than the latest version.');
+          }
         }
         return true;
       }
@@ -74,9 +98,12 @@ async function usePrompt() {
 
 async function build() {
   try {
-    const { appId } = await getThemeAppConfig();
-    const { newVersion, description } = await usePrompt();
-    await createNewVersion(appId, newVersion, description);
+    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}`));
   }

package/lib/app/commands/connect.js

@@ -0,0 +1,73 @@
+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/app/commands/create.js

@@ -13,14 +13,14 @@ async function usePrompt() {
     {
       type: 'list',
       name: 'themeAppType',
-      message: 'Select theme app type:',
+      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 app project name:',
+      message: 'Please enter the theme extension project name:',
       prefix: '*',
       validate: (projectName) => {
         if (!projectName.trim()) {
@@ -35,12 +35,12 @@ async function usePrompt() {
 /**
  * 初始化项目
  */
-async function initProj(projectPath, projectName) {
+async function initProj(projectPath, projectName, isBasicApp = false) {
   // 替换占位符 key文件相对路径 value替换的内容
   const replacementConfig = {
     'package.json': { projectName },
     'theme-app/blocks/index.liquid': { projectName },
-    'theme-app.config.json': { projectName }
+    'extension.config.json': { projectName }
   };
   for (const [filePath, replacements] of Object.entries(replacementConfig)) {
     const fullPath = path.resolve(projectPath, filePath);
@@ -48,10 +48,14 @@ async function initProj(projectPath, projectName) {
   }
 
   // 重命名文件
-  const filesToRename = ['assets/index.css', 'blocks/index.liquid', 'snippets/index.liquid'];
+  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}${file.includes('snippets') ? '_snippet' : ''}`);
+    await renameFile(filePath, `${projectName}${filePath.includes('_css') ? '_css' : ''}`);
   }
 }
 
@@ -59,7 +63,7 @@ async function initProj(projectPath, projectName) {
  * 控制台提示信息
  */
 function consoleTips(projectName) {
-  console.log(chalk.green(`Theme app project "${projectName}" has been successfully created.`));
+  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`);
@@ -71,18 +75,15 @@ function consoleTips(projectName) {
  */
 async function _create(themeAppDescription, projectName) {
   const projectPath = path.resolve(WORKSPACE_PATH, projectName);
-  const projectExists = await fsExtra.pathExists(projectPath);
 
-  if (projectExists) {
+  if (fsExtra.pathExistsSync(projectPath)) {
     throw new Error(`Project directory "${projectName}" already exists.`);
   }
   await fsExtra.ensureDir(projectPath);
-  const templatePath =
-    THEME_APP_TYPE.BASIC_APP.description === themeAppDescription
-      ? THEME_APP_TYPE.BASIC_APP.templatePath
-      : THEME_APP_TYPE.EMBEDS_APP.templatePath;
+  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);
+  await initProj(projectPath, projectName, isBasicApp);
   consoleTips(projectName);
 }
 

package/lib/app/commands/deploy.js

@@ -1,43 +1,51 @@
 const inquirer = require('inquirer');
 const chalk = require('chalk');
 const ora = require('ora');
-const { getThemeAppConfig } = require('../utils');
-const { getThemeAppVersionList, toDeployThemeApp } = require('../api/api');
+const { getThemeExtensionConfig } = require('../utils');
+const { getThemeAppVersionList, toDeployThemeApp } = require('../api');
 
-// 调用后端 API 进行部署
-async function deployVersion(appId, version) {
-  // await new Promise((resolve) => setTimeout(resolve, 2000));
+async function deployVersion(extensionId, versionInfo) {
   await toDeployThemeApp({
-    extension_id: appId,
-    version,
+    extension_id: extensionId,
+    version_id: versionInfo.version_id,
     type: 'enable'
   });
-  console.log(chalk.green(`Version ${version} has been deployed successfully.`));
+  console.log(chalk.green(`Version ${versionInfo.version} has been deployed successfully.`));
 }
 
 async function usePrompt(versionList) {
   const choices = versionList.map((v) => ({
-    name: `${v.version} (${v.date}) - ${v.description}`,
-    value: v.version
+    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
+      choices,
+      loop: false
     }
   ]);
 }
 
 async function deploy() {
   try {
-    const { appId } = await getThemeAppConfig();
+    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 versionList = await getThemeAppVersionList();
+    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);
-    await deployVersion(appId, selectedVersion);
+    const versionInfo = versionList.find((v) => v.version_id === selectedVersion);
+    await deployVersion(extensionId, versionInfo);
   } catch (error) {
     console.error(chalk.red(`[ERROR IN DEPLOY] ${error.message}`));
   }

package/lib/app/commands/list.js

@@ -1,25 +1,29 @@
 const chalk = require('chalk');
 const ora = require('ora');
-const { getThemeAppConfig, renderTable } = require('../utils');
-const { getThemeAppList } = require('../api/api');
+const { renderTable } = require('../utils');
+const { getThemeAppList } = require('../api');
 
 /**
  * 控制台提示
  */
 function consoleTips(versionList) {
-  console.log(chalk.green('\n📜 Available Theme Apps:'));
-  console.log(
-    renderTable(versionList, [
-      { label: 'Name', filed: 'name' },
-      { label: 'Version', filed: 'version', color: 'yellowBright' },
-      { label: 'Description', filed: 'description' }
-    ])
-  );
+  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 themeAppList = await getThemeAppList();
+    const res = await getThemeAppList();
+    const themeAppList = res.data?.data || [];
     consoleTips(themeAppList);
   } catch (error) {
     console.error(chalk.red(`[ERROR IN LIST] ${error.message}`));

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
+};