shoplazza-cli 1.0.5 → 1.0.7-beta.1

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/serve.js

@@ -0,0 +1,171 @@
+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, getThemeAppConfig, setThemeAppConfig, getFileInfo } = require('../utils');
+const {
+  toCreateThemeApp,
+  toUploadThemeApp,
+  getTaskStatus,
+  getThemeList,
+  toCreateFile,
+  toUpdateFile,
+  toDeleteFile
+} = require('../api');
+const { watchWorkspace } = require('../../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
+      }))
+    }
+  ]);
+  return selectedThemeId;
+}
+
+/**
+ * 创建主题插件
+ */
+async function createThemeApp(themeAppConfig) {
+  const data = {
+    title: themeAppConfig.extensionName || '' // 插件显示名称
+  };
+  if (themeAppConfig.extensionId) {
+    data.extension_id = themeAppConfig.extensionId;
+  }
+  const res = await toCreateThemeApp(data);
+  const extensionId = res.data?.extension_id;
+  await setThemeAppConfig({ 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 themeAppConfig = await getThemeAppConfig();
+    let extensionId = themeAppConfig.extensionId;
+    if (!extensionId) {
+      extensionId = await createThemeApp(themeAppConfig);
+    }
+    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,52 @@
+const chalk = require('chalk');
+const ora = require('ora');
+const { getThemeAppConfig, renderTable } = require('../utils');
+const { getThemeAppVersionList } = require('../api');
+
+/**
+ * 控制台提示
+ */
+function consoleTips(versionList) {
+  if (versionList.length) {
+    console.log(chalk.green('\n📜 Available Versions:'));
+    console.log(
+      renderTable(versionList, [
+        {
+          label: 'Version',
+          filed: 'version',
+          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 getThemeAppConfig();
+    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,26 @@
-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);
+
+}
 
 module.exports = {
-  generateExtension,
-  deployExtension,
-  publishExtension,
-  buildExtension: build,
-  retry
+  initThemeAppCommand
 };

package/lib/app/template/basic-app/README.md

@@ -0,0 +1,98 @@
+# Theme Basic App
+
+## 概览
+
+一个基础的主题插件项目
+
+## 安装
+
+首先，确保您安装了“Shoplazza CLI”。如果没有，您可以使用以下命令全局安装它：
+
+```bash
+npm install -g shoplazza-cli
+```
+
+## 可用的脚本
+
+### `create`
+
+创建主题插件项目模版
+
+```bash
+shoplazza te create
+```
+
+---
+
+进入项目目录后，即可使用以下命令：
+
+### `start`
+
+启动开发模式
+
+```bash
+npm start
+```
+
+或者
+
+```bash
+shoplazza te serve
+```
+
+### `build`
+
+基于当前的草稿生成对应正式版本的主题插件
+
+```bash
+npm run build
+```
+
+或者
+
+```bash
+shoplazza te build
+```
+
+### `deploy`
+
+部署正式版本的主题插件（部署后插件在店铺的主题编辑器的app列表中可见）
+
+```bash
+npm run deploy
+```
+
+或者
+
+```bash
+shoplazza te deploy
+```
+
+### `versions`
+
+查询主题插件的历史正式版本列表
+
+```bash
+npm run versions
+```
+
+或者
+
+```bash
+shoplazza te versions
+```
+
+### `list`
+
+查询店铺的私有主题插件列表
+
+```bash
+npm run list
+```
+
+或者
+
+```bash
+shoplazza te list
+```
+

package/lib/app/template/basic-app/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "{{projectName}}",
+  "version": "1.0.0",
+  "description": "theme basic extension",
+  "main": "null",
+  "scripts": {
+    "start": "shoplazza te serve",
+    "build": "shoplazza te build",
+    "deploy": "shoplazza te deploy",
+    "versions": "shoplazza te versions",
+    "list": "shoplazza te list"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}

package/lib/app/template/basic-app/theme-app/assets/index.css

@@ -0,0 +1,4 @@
+.container {
+  color: #da534d;
+  text-align: center;
+}

package/lib/app/template/basic-app/theme-app/assets-manifest.json

@@ -0,0 +1 @@
+{}

package/lib/app/template/basic-app/theme-app/blocks/index.liquid

@@ -0,0 +1,16 @@
+{% use "{{projectName}}.css" %}
+
+<div id="{{projectName}}" class="container">
+  <h1>SHOPLAZZA THEME EXTENSION</h1>
+  {% include "{{projectName}}" %}
+</div>
+
+{% schema %} 
+{
+  "name": {
+    "en-US": "{{projectName}}-US",
+    "zh-CN": "{{projectName}}-CN"
+  },
+  "settings": []
+}
+{% endschema %}

package/lib/app/template/basic-app/theme-app/snippets/index.liquid

@@ -0,0 +1,8 @@
+<div>
+    <h3>BASIC TYPE</h3>
+</div>
+
+
+
+
+

package/lib/app/template/basic-app/theme-extension.config.json

@@ -0,0 +1,4 @@
+{
+  "extensionId": "",
+  "extensionName": "{{projectName}}"
+}

package/lib/app/template/embed-app/README.md

@@ -0,0 +1,97 @@
+# Theme Embed App
+
+## 概览
+
+一个 embed 的主题插件项目
+
+## 安装
+
+首先，确保您安装了“Shoplazza CLI”。如果没有，您可以使用以下命令全局安装它：
+
+```bash
+npm install -g shoplazza-cli
+```
+
+## 可用的脚本
+
+### `create`
+
+创建主题插件项目模版
+
+```bash
+shoplazza te create
+```
+
+---
+
+进入项目目录后，即可使用以下命令：
+
+### `start`
+
+启动开发模式
+
+```bash
+npm start
+```
+
+或者
+
+```bash
+shoplazza te serve
+```
+
+### `build`
+
+基于当前的草稿生成对应正式版本的主题插件
+
+```bash
+npm run build
+```
+
+或者
+
+```bash
+shoplazza te build
+```
+
+### `deploy`
+
+部署正式版本的主题插件
+
+```bash
+npm run deploy
+```
+
+或者
+
+```bash
+shoplazza te deploy
+```
+
+### `versions`
+
+查询主题插件的历史正式版本列表
+
+```bash
+npm run versions
+```
+
+或者
+
+```bash
+shoplazza te versions
+```
+
+### `list`
+
+查询店铺的私有主题插件列表
+
+```bash
+npm run list
+```
+
+或者
+
+```bash
+shoplazza te list
+```

package/lib/app/template/embed-app/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "{{projectName}}",
+  "version": "1.0.0",
+  "description": "theme embed extension",
+  "main": "null",
+  "scripts": {
+    "start": "shoplazza te serve",
+    "build": "shoplazza te build",
+    "deploy": "shoplazza te deploy",
+    "versions": "shoplazza te versions",
+    "list": "shoplazza te list"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}

package/lib/app/template/embed-app/theme-app/assets-manifest.json

@@ -0,0 +1 @@
+{}

package/lib/app/template/embed-app/theme-app/blocks/index.liquid

@@ -0,0 +1,18 @@
+{% include "{{projectName}}_css" %}
+
+<div id="{{projectName}}" class="container">
+  <h1>SHOPLAZZA THEME EXTENSION</h1>
+  {% include "{{projectName}}" %}
+</div>
+
+{% schema %} 
+{
+  "name": {
+    "en-US": "{{projectName}}-US",
+    "zh-CN": "{{projectName}}-CN"
+  },
+  "target":"body",
+  "icon":"https://cdn.shoplazza.com/oss/operation/0aee0d0cff21440e95a08ec4c560c691.svg",
+  "settings": []
+}
+{% endschema %}

package/lib/app/template/embed-app/theme-app/locales/ar-SA.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/de-DE.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/en-US.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/es-ES.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/fr-FR.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/id-ID.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/it-IT.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/ja-JP.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/ko-KR.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/nl-NL.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/pl-PL.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/pt-PT.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/ru-RU.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/th-TH.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}

package/lib/app/template/embed-app/theme-app/locales/zh-CN.json

@@ -0,0 +1,3 @@
+{
+  "general": {}
+}