shoplazza-cli 1.0.5 → 1.0.7-beta.1

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>
+    <h3>EMBED TYPE</h3>
+</div>
+
+
+
+
+

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

@@ -0,0 +1,6 @@
+<style>
+.container {
+  color: #da534d;
+  text-align: center;
+}
+</style>

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

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

package/lib/app/utils/config.js

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

package/lib/app/utils/index.js

@@ -0,0 +1,213 @@
+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, THEME_APP_CONFIG_PATH } = require('./config');
+
+/**
+ * 通用的占位符替换函数
+ */
+const replacePlaceholders = async (filePath, replacements) => {
+  if (!fsExtra.pathExistsSync(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 (!fsExtra.pathExistsSync(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() {
+  if (!fsExtra.pathExistsSync(THEME_APP_CONFIG_PATH)) {
+    throw new Error(
+      `The current workspace is not a valid theme extension project, because "${WORKSPACE_PATH}" is missing the required "theme-extension.config.json" file.`
+    );
+  }
+  return fsExtra.readJson(THEME_APP_CONFIG_PATH);
+}
+
+/**
+ * 更新themeApp配置（信息）
+ * @param {Object} config 待更新的配置信息
+ */
+async function setThemeAppConfig(config) {
+  const oldThemeAppConfig = await getThemeAppConfig();
+  const newThemeAppConfig = { ...oldThemeAppConfig, ...config };
+  await fsExtra.writeJson(THEME_APP_CONFIG_PATH, newThemeAppConfig, { spaces: 2 });
+}
+
+/**
+ * 计算文件夹内容的哈希值
+ * @param {string} dirPath - 文件夹路径
+ * @returns {Promise<string>} 返回基于文件夹内容的哈希值
+ */
+async function calculateFolderHash(dirPath) {
+  if (!fsExtra.pathExistsSync(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 (!fsExtra.pathExistsSync(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 {
+        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 }} 返回包含文件名和父目录名的对象
+ */
+function getFileInfo(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);
   }
 );

package/lib/oss.js

@@ -0,0 +1,99 @@
+const axios = require('axios');
+const fs = require('fs');
+const path = require('path');
+const FormData = require('form-data');
+const chalk = require('chalk');
+
+/**
+ * 获取OSS上传功能，适用于上传文件到店铺的OSS服务器
+ * @param {string} accessToken - 用于认证的token
+ * @param {string} storeDomain - 店铺域名
+ * @param {string} storeDomainTips - 店铺域名为空时的提示信息
+ * @returns {{ uploadOss: (filePath: string) => Promise<string> }} 返回一个对象，包含上传文件到OSS的函数
+ * @example
+ * const { uploadOss } = useOss('your-access-token', 'your-store-domain', 'Store domain is required');
+ * const ossUrl = await uploadOss('/path/to/file.txt');
+ * console.log(ossUrl);  // 输出文件的 OSS 地址
+ */
+function useOss(accessToken, storeDomain, storeDomainTips) {
+  const ins = axios.create({
+    headers: { 'Access-Token': accessToken }
+  });
+
+  ins.interceptors.request.use(
+    (config) => {
+      if (!storeDomain) {
+        console.error(
+          //   chalk.red(`\n\n`)
+          chalk.red(`\n${storeDomainTips}\n`)
+        );
+        process.exit(-1);
+      }
+      if (config.url.startsWith('/checkout_extensions')) {
+        config.baseURL = `https://${storeDomain}/openapi`;
+      }
+      return config;
+    },
+    (error) => {
+      console.error(chalk.red(`[REQUEST ERROR] ${error.message}`));
+      return Promise.reject(error);
+    }
+  );
+
+  ins.interceptors.response.use(
+    (response) => {
+      return response.data;
+    },
+    (error) => {
+      console.log(error);
+      
+      console.error(
+        chalk.red(
+          `[RESPONSE ERROR] ${error.response.status} ${error.response.config.baseURL}${error.response.config.url}`
+        )
+      );
+      return Promise.reject(error);
+    }
+  );
+
+  /**
+   * 上传文件到OSS
+   * @param {string} filePath - 要上传的文件路径
+   * @returns {Promise<string>} 返回文件的 OSS 地址
+   * @throws {Error} 如果上传失败或发生未知错误，抛出错误
+   * @example
+   * const ossUrl = await uploadOss('/path/to/file.txt');
+   * console.log(ossUrl);  // 输出文件的 OSS 地址
+   */
+  async function uploadOss(filePath) {
+    let fileName = path.basename(filePath);
+    const key = 'chick-extension/' + fileName;
+    const form = new FormData();
+    const url = await ins.get(`/checkout_extensions/file/sign?key=${key}`).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', key);
+      form.append('file', fs.createReadStream(filePath));
+      await ins.post(`https:${url}`, form, { headers: form.getHeaders() }).catch((error) => {
+        if (error.response?.data.includes('<Code>FileAlreadyExists</Code>')) {
+          console.log(chalk.yellow('[WARN] The current file already exists, not need to upload.'));
+          return;
+        } else {
+          return Promise.reject(error);
+        }
+      });
+      return `${data.read_host}${data.read_host.endsWith('/') ? '' : '/'}${key}`;
+    });
+    return url;
+  }
+
+  return { uploadOss };
+}
+
+module.exports = {
+  useOss
+};

package/lib/utils.js

@@ -2,6 +2,8 @@ const path = require('path');
 const fs = require('fs-extra');
 const AdmZip = require('adm-zip');
 const chalk = require('chalk');
+const chokidar = require('chokidar');
+const fsExtra = require('fs-extra');
 
 const {
   SSO_AUTH_URL,
@@ -111,3 +113,53 @@ const SSO_AUTH_URL_MAP = {
 exports.getSSOAuthUrl = (store) => {
   return SSO_AUTH_URL_MAP[getEnv(store)];
 };
+
+/**
+ * 监听文件夹变化
+ * @param {string} workspace - 需要监听的文件夹路径
+ * @param {Object} options - 配置项
+ * @param {Function} [options.onAdd] - 文件添加时的回调函数，接收文件路径作为参数
+ * @param {Function} [options.onChange] - 文件更改时的回调函数，接收文件路径作为参数
+ * @param {Function} [options.onDelete] - 文件删除时的回调函数，接收文件路径作为参数
+ * @param {any} [options.xxx] - 其他chokidar.watch配置项
+ * @returns {Function} - 取消监听的函数
+ */
+exports.watchWorkspace = (workspace, options = {}) => {
+  if (!fsExtra.pathExistsSync(workspace)) {
+    console.error(chalk.red(`[ERROR] "${workspace}" does not exist.`));
+    return;
+  }
+  const defaultOptions = {
+    persistent: true,
+    ignoreInitial: true
+  };
+  const { onAdd = () => {}, onChange = () => {}, onDelete = () => {}, ...restOptions } = options;
+  const watcherOptions = { ...defaultOptions, ...restOptions };
+  const watcher = chokidar.watch(workspace, watcherOptions);
+
+  watcher.on('add', (filePath) => {
+    console.log(chalk.cyan(`[ADD] ${filePath}`));
+    onAdd(filePath);
+  });
+
+  watcher.on('change', (filePath) => {
+    console.log(chalk.yellow(`[CHANGE] ${filePath}`));
+    onChange(filePath);
+  });
+
+  watcher.on('unlink', (filePath) => {
+    console.log(chalk.red(`[DELETE] ${filePath}`));
+    onDelete(filePath);
+  });
+
+  watcher.on('error', (error) => {
+    console.error(chalk.red(`[ERROR] ${error}`));
+  });
+
+  const stopWatcher = () => {
+    console.log(chalk.green('[INFO] Stopping watcher...'));
+    watcher.close();
+  };
+
+  return stopWatcher;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shoplazza-cli",
-  "version": "1.0.5",
+  "version": "1.0.7-beta.1",
   "description": "",
   "main": "bin/shoplazza",
   "engines": {
@@ -26,7 +26,6 @@
     "@sentry/tracing": "^6.19.7",
     "adm-zip": "^0.5.9",
     "ali-oss": "^6.17.1",
-    "archiver": "^5.3.1",
     "axios": "^1.6.8",
     "better-sqlite3": "^11.5.0",
     "chalk": "^4.1.2",
@@ -64,6 +63,7 @@
     "semver": "~7.3.5",
     "serve-static": "^1.15.0",
     "spark-md5": "^3.0.2",
+    "table": "^6.9.0",
     "uglify-js": "^3.17.4",
     "update-notifier": "^5.1.0",
     "vite": "~4.3.1",

package/lib/app/commands/generate.js

@@ -1,50 +0,0 @@
-const inquirer = require('inquirer');
-const { set, PARTNER_KEYS } = require('../db/partner');
-const { themeAppHandler, checkoutUIHandler } = require('../extensions');
-const { line } = require('../log');
-
-const EXTENSION_TYPES = {
-  CHECKOUT_UI: 'checkout_ui',
-  THEME_APP: 'theme_app'
-};
-
-const generate = async () => {
-  line();
-  const answer = await inquirer.prompt([
-    {
-      type: 'list',
-      name: 'extensionType',
-      message: 'Choose your extension type ↓',
-      default: EXTENSION_TYPES.THEME_APP,
-      prefix: '*',
-      choices: [
-        {
-          name: 'Theme App Extension',
-          value: EXTENSION_TYPES.THEME_APP
-        }
-      ]
-    },
-    {
-      type: 'input',
-      name: 'extensionName',
-      message: 'Input your extesion name: ',
-      default: 'my-extension',
-      prefix: '*'
-    }
-  ]);
-  line();
-
-  set({ [PARTNER_KEYS.EXTENSION_TYPE]: answer.extensionType });
-
-  if (answer.extensionType === EXTENSION_TYPES.THEME_APP) {
-    await themeAppHandler(answer.extensionName);
-  } else if (answer.extensionType === EXTENSION_TYPES.CHECKOUT_UI) {
-    await checkoutUIHandler(answer.extensionName);
-  }
-
-  line();
-};
-
-module.exports = {
-  generate
-};