shoplazza-cli 1.0.5 → 1.0.6

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

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

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

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

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

@@ -0,0 +1,4 @@
+/* css code */
+.container {
+  color: red;
+}

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

@@ -0,0 +1,15 @@
+<div id="{{projectName}}" class="container">
+  <p>Hello world</p>
+</div>
+{% include "{{projectName}}_snippet" %}
+
+{% schema %} 
+{
+  "name": {
+    "en-US": "default name",
+    "zh-CN": "默认名称"
+  },
+  "target":"body",
+  "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": {}
+}

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

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

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

@@ -0,0 +1,8 @@
+<div>
+    Shoplazza theme APP
+</div>
+
+
+
+
+

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

@@ -0,0 +1,4 @@
+{
+  "appId": "",
+  "appName": ""
+}

package/lib/app/utils/config.js

@@ -0,0 +1,29 @@
+const path = require('path');
+const { get } = require('../../db/user');
+
+const WORKSPACE_PATH = process.cwd();
+
+const THEME_APP_PATH = path.resolve(WORKSPACE_PATH, 'theme-app');
+
+const STORE_DOMAIN = get('store_domain');
+
+const EXCHANGE_TOKEN = get('exchange_token');
+
+const THEME_APP_TYPE = {
+  BASIC_APP: {
+    description: 'basic app(just an basic app)',
+    templatePath: path.resolve(__dirname, '../template/basic-app')
+  },
+  EMBEDS_APP: {
+    description: 'embed app(embed in a theme)',
+    templatePath: path.resolve(__dirname, '../template/embed-app')
+  }
+};
+
+module.exports = {
+  WORKSPACE_PATH,
+  THEME_APP_PATH,
+  STORE_DOMAIN,
+  EXCHANGE_TOKEN,
+  THEME_APP_TYPE,
+};

package/lib/app/utils/index.js

@@ -0,0 +1,220 @@
+const fsExtra = require('fs-extra');
+const path = require('path');
+const chalk = require('chalk');
+const AdmZip = require('adm-zip');
+const md5 = require('md5');
+const { table } = require('table');
+const { WORKSPACE_PATH } = require('./config');
+
+/**
+ * 通用的占位符替换函数
+ */
+const replacePlaceholders = async (filePath, replacements) => {
+  if (!(await fsExtra.pathExists(filePath))) {
+    console.warn(`File "${filePath}" does not exist, skipping replacement.`);
+    return;
+  }
+  let content = await fsExtra.readFile(filePath, 'utf-8');
+  // 替换占位符
+  for (const [placeholder, value] of Object.entries(replacements)) {
+    const regex = new RegExp(`\\{\\{${placeholder}\\}\\}`, 'g'); // 匹配占位符格式：{{placeholder}}
+    content = content.replace(regex, value);
+  }
+  // 写回文件
+  await fsExtra.writeFile(filePath, content, 'utf-8');
+};
+
+/**
+ * 重命名指定文件
+ * @param {string} filePath - 原始文件的完整路径
+ * @param {string} targetName - 新的文件名
+ */
+const renameFile = async (filePath, targetName) => {
+  if (!(await fsExtra.pathExists(filePath))) {
+    console.warn(`File "${filePath}" does not exist, skipping.`);
+    return;
+  }
+  const targetFilePath = path.resolve(path.dirname(filePath), `${targetName}${path.extname(filePath)}`);
+  await fsExtra.rename(filePath, targetFilePath);
+};
+
+/**
+ * 获取themeApp配置（信息）
+ * @returns {Promise<string>}
+ */
+async function getThemeAppConfig() {
+  const configFilePath = path.join(WORKSPACE_PATH, 'theme-app.config.json');
+  if (!(await fsExtra.pathExists(configFilePath))) {
+    throw new Error(
+      `The current workspace is not a valid theme app project, because "${WORKSPACE_PATH}" is missing the required "theme-app.config.json" file.`
+    );
+  }
+  return fsExtra.readJson(configFilePath);
+}
+
+/**
+ * 更新themeApp配置（信息）
+ * @param {Object} config 待更新的配置信息
+ */
+async function setThemeAppConfig(config) {
+  const oldThemeAppConfig = await getThemeAppConfig();
+  const newThemeAppConfig = { ...oldThemeAppConfig, ...config };
+  await fsExtra.writeJson(configFilePath, newThemeAppConfig, { spaces: 2 });
+}
+
+/**
+ * 计算文件夹内容的哈希值
+ * @param {string} dirPath - 文件夹路径
+ * @returns {Promise<string>} 返回基于文件夹内容的哈希值
+ */
+async function calculateFolderHash(dirPath) {
+  if (!(await fsExtra.pathExists(dirPath))) {
+    throw new Error(chalk.red(`Calculate folder hash path does not exist: ${dirPath}`));
+  }
+  const files = await fsExtra.readdir(dirPath);
+  let contentHash = '';
+  for (const file of files) {
+    const filePath = path.join(dirPath, file);
+    const fileStats = await fsExtra.stat(filePath);
+
+    if (fileStats.isDirectory()) {
+      // 如果是目录，递归计算文件夹内容的哈希值
+      contentHash += await calculateFolderHash(filePath);
+    } else {
+      // 如果是文件，读取文件内容并计算哈希
+      const fileContent = await fsExtra.readFile(filePath);
+      contentHash += md5(fileContent);
+    }
+  }
+
+  return md5(contentHash);
+}
+
+/**
+ * 通用的压缩函数（同目录生成zip压缩文件）
+ * @param {string} sourcePath - 需要压缩的目录或文件路径
+ * @returns {Promise<Object>} 返回压缩文件的生成路径&压碎文件名
+ */
+async function compress(sourcePath) {
+  if (!(await fsExtra.pathExists(sourcePath))) {
+    throw new Error(chalk.red(`Compress path does not exist: ${sourcePath}`));
+  }
+  const sourceName = path.basename(sourcePath);
+  const outputDir = path.dirname(sourcePath);
+  const sourceHash = await calculateFolderHash(sourcePath);
+  const fileName = `${sourceName}-${sourceHash.substring(0, 8)}${Date.now().toString(16).substring(0, 8)}.zip`;
+  const outputPath = path.resolve(outputDir, fileName);
+
+  return new Promise((resolve, reject) => {
+    const zip = new AdmZip();
+    if (fsExtra.statSync(sourcePath).isDirectory()) {
+      zip.addLocalFolder(sourcePath, sourceName);
+    } else {
+      zip.addLocalFile(sourcePath);
+    }
+
+    zip.writeZip(outputPath, (err) => {
+      if (err) {
+        reject(err);
+      } else {
+        console.log(chalk.green(`Source path compressed successfully. File saved at: ${outputPath}`));
+        resolve({
+          zipPath: outputPath,
+          zipName: fileName
+        });
+      }
+    });
+  });
+}
+
+/**
+ * 比较两个版本号的大小
+ * @param {String} version1 版本号1
+ * @param {String} version2 版本号2
+ * @returns version1 < version2 返回 -1，version1 > version2 返回 1，相等返回 0
+ */
+function compareVersions(version1, version2) {
+  const v1 = version1.split('.').map(Number);
+  const v2 = version2.split('.').map(Number);
+
+  for (let i = 0; i < Math.max(v1.length, v2.length); i++) {
+    const num1 = v1[i] || 0;
+    const num2 = v2[i] || 0;
+
+    if (num1 < num2) {
+      return -1;
+    }
+    if (num1 > num2) {
+      return 1;
+    }
+  }
+  return 0;
+}
+
+/**
+ * 获取文件名及其直接父目录名
+ * @param {string} filePath - 文件的绝对路径
+ * @returns {{ fileName: string, parentDirName: string }} 返回包含文件名和父目录名的对象
+ */
+async function getFileInfo(filePath) {
+  if (!(await fsExtra.pathExists(filePath))) {
+    throw new Error(chalk.red(`File path does not exist: ${filePath}`));
+  }
+  const fileName = path.basename(filePath);
+  const parentDirName = path.basename(path.dirname(filePath));
+  return { fileName, parentDirName };
+}
+
+// 表格配置
+const TABLE_CONFIG = {
+  border: {
+    topBody: '═',
+    topJoin: '╤',
+    topLeft: '╔',
+    topRight: '╗',
+    bottomBody: '═',
+    bottomJoin: '╧',
+    bottomLeft: '╚',
+    bottomRight: '╝',
+    bodyLeft: '║',
+    bodyRight: '║',
+    bodyJoin: '│',
+    joinBody: '─',
+    joinLeft: '╟',
+    joinRight: '╢',
+    joinJoin: '┼'
+  }
+};
+
+/**
+ * 图像化表格渲染数据
+ * @param {Array} data - 数据
+ * @param {Array} options - 配置项 [{ label:string, filed:string, color?:string}, ...]
+ * @example
+ * renderTable([{name:'Jack',age:20},{name:'Tom',age:30}],
+ * [{label:'姓名',filed:'name',color:''},{label:'年龄',filed:'age',color:''}]
+ * )
+ */
+function renderTable(data, options) {
+  const header = options.map((item) => chalk.bold(item.label));
+  const rows = data.map((item) => options.map((opt) => chalk[opt.color || 'whiteBright'](item[opt.filed])));
+  const tableData = [header, ...rows];
+  return table(tableData, {
+    border: Object.fromEntries(
+      Object.entries(TABLE_CONFIG.border).map(([key, val]) => [key, chalk.blueBright.bold(val)])
+    )
+  });
+}
+
+
+
+module.exports = {
+  replacePlaceholders,
+  renameFile,
+  getThemeAppConfig,
+  setThemeAppConfig,
+  compress,
+  compareVersions,
+  getFileInfo,
+  renderTable
+};

package/lib/checkout/api.js

@@ -8,6 +8,7 @@ const { isDebug } = require('./console');
 const { getProjectConfig } = require('./util');
 const chalk = require('chalk');
 const { consoleWarn } = require('./console');
+const { useOss } = require('../oss');
 
 const FILE_SIGN_URL = '/checkout_extensions/file/sign';
 const CREATE_URL = '/checkout_extensions/create';
@@ -19,6 +20,7 @@ const UNDEPLOY_URL = '/checkout_extensions/undeploy';
 const PREVIEW_URL = '/checkout_extensions/preview';
 
 let configJson = undefined;
+let uploadOss = null;
 
 const request = new Axios.create();
 
@@ -64,9 +66,6 @@ request.interceptors.response.use(
     if (isDebug()) {
       console.log(`\n<== error ${error.response.status}: ${error.response.config.url}`);
     }
-    if (!error.response) {
-      throw chalk.red('Network error, please check your connection.');
-    }
     if (error.response?.status == 403) {
       return Promise.reject(new Error('Token permission failure'));
     }
@@ -74,42 +73,20 @@ request.interceptors.response.use(
   }
 );
 
-async function upload(path, name) {
-  const form = new FormData();
-  const url = await request(`${FILE_SIGN_URL}?key=${name}`)
-    .then((data) => {
-      return data.data;
-    })
-    .then(async (data) => {
-      const url = data.write_host;
-      form.append('policy', data.policy);
-      form.append('OSSAccessKeyId', data.access_id);
-      form.append('success_action_status', 200);
-      form.append('signature', data.sign);
-      form.append('x-oss-forbid-overwrite', 'true');
-      form.append('key', name);
-      form.append('file', fs.createReadStream(path));
-      await request.post(`https:${url}`, form, { headers: form.getHeaders() }).catch((error) => {
-        if (error.response?.data.includes('<Code>FileAlreadyExists</Code>')) {
-          consoleWarn('The current file already exists, not need to upload.');
-          return;
-        } else {
-          return Promise.reject(error);
-        }
-      });
-      return `${data.read_host}${data.read_host.endsWith('/') ? '' : '/'}${name}`;
-    });
-  loading('succeed upload').succeed();
-  return url;
-}
-
 async function uploadFile(dirPath, file) {
-  return upload(`${dirPath}/${file}`, `chick-extension/${file}`);
+  if (!uploadOss) {
+    uploadOss = useOss(
+      configJson.token,
+      new URL(configJson.store).hostname,
+      `✗ No store found. Please check your "extension.config.js" file.`
+    ).uploadOss;
+  }
+  return uploadOss(`${dirPath}/${file}`);
 }
 async function uploadDir(dirPath, files) {
   return Promise.all(
     files.map((file) => {
-      return upload(`${dirPath}/${file}`, `chick-extension/${file}`);
+      return uploadOss(`${dirPath}/${file}`);
     })
   );
 }

package/lib/checkout/build/plugin/vite-plugin-transform-extension-html.js

@@ -99,7 +99,7 @@ const handleHtmlDeps = (htmlStr, curPath) => {
           cachedHtmlStr[importedHtmlAbsolutePath] = handleHtmlDeps(importedHtmlStr, curPath);
         }
 
-        str = str.replace(importReg, cachedHtmlStr[importedHtmlAbsolutePath]);
+        str = str.replace(importReg, () => cachedHtmlStr[importedHtmlAbsolutePath]);
       } catch (e) {
         console.error(e);
       }

package/lib/checkout/dev/index.js

@@ -32,10 +32,11 @@ function handleWsConnection(ws) {
     console.log(`Received message ${data} from user `);
   });
 
-  const extensionList = [];
+  let extensionList = [];
   fs.readdirSync(getExtensionsPath()).forEach((ext) => {
     extensionList.push(generateExtensionData(ext));
   });
+  extensionList = extensionList.filter((ext) => !ext.resourceUrl.endsWith('undefined'));
   ws.send(JSON.stringify({ event: 'init', data: extensionList }));
 
 }

package/lib/commands/login.js

@@ -8,7 +8,7 @@ const log = require('../log');
 const { getShopDetail } = require('../openAPI/api');
 const getCode = require('../auth/getCode');
 const { postAccessToken, getUserInfo, postExchangeToken, postStoreToken } = require('../auth');
-const { loginIntoPartner } = require('../app/login');
+const { loginIntoPartner } = require('../common/login');
 
 let spinner;
 

package/lib/commands/logout.js

@@ -1,7 +1,7 @@
 const Sentry = require('@sentry/node');
 const chalk = require('chalk');
 const { empty: emptyUser } = require('../db/user');
-const { logoutPartner } = require('../app/logout');
+const { logoutPartner } = require('../common/logout');
 const log = require('../log');
 
 const logoutStore = () => {

package/lib/openAPI/index.js

@@ -12,17 +12,23 @@ const openAPI = axios.create({
   headers: { 'Access-Token': get('exchange_token') }
 });
 
-openAPI.interceptors.request.use((config) => {
-  if (!get('store_domain')) {
-    log.error(
-      chalk.red(
-        `\n✗ No store found. Please run ${chalk.cyan('shoplazza login --store STORE')} to login to a specific store`
-      )
-    );
-    process.exit(-1);
+openAPI.interceptors.request.use(
+  (config) => {
+    if (!get('store_domain')) {
+      log.error(
+        chalk.red(
+          `\n✗ No store found. Please run ${chalk.cyan('shoplazza login --store STORE')} to login to a specific store`
+        )
+      );
+      process.exit(-1);
+    }
+    return config;
+  },
+  (error) => {
+    console.error(chalk.red(`[REQUEST ERROR] ${error.message}`));
+    return Promise.reject(error);
   }
-  return config;
-});
+);
 
 openAPI.interceptors.response.use(
   function (response) {
@@ -39,6 +45,11 @@ openAPI.interceptors.response.use(
         return openAPI(error.config);
       });
     }
+    error.response && console.error(
+      chalk.red(
+        `[RESPONSE ERROR] ${error.response.status} ${error.response.config.baseURL}${error.response.config.url}`
+      )
+    );
     return Promise.reject(error);
   }
 );