shoplazza-cli 1.0.5 → 1.0.6

package/lib/oss.js

@@ -0,0 +1,102 @@
+const axios = require('axios');
+const fs = require('fs');
+const path = require('path');
+const FormData = require('form-data');
+const chalk = require('chalk');
+const loading = require('loading-cli');
+
+/**
+ * 获取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) {
+    console.log(chalk.green('正在上传文件到OSS...',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}`;
+    });
+    loading('succeed upload').succeed();
+    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.initWatcher = (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.6",
   "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
-};

package/lib/app/commands/publish.js

@@ -1,52 +0,0 @@
-const { default: axios } = require('axios');
-const { selectVersion } = require('../inquirers/version');
-const { PARNTER_URL } = require('../constants');
-const { get, getValue, PARTNER_KEYS } = require('../db/partner');
-const ora = require('ora');
-const chalk = require('chalk');
-const { getZipName } = require('./build');
-const { done, line } = require('../log');
-
-const publishVersion = async ({ version, appId, versionId, extensionId }) => {
-  const spinner = ora(chalk.cyan('Waiting publish ...'));
-
-  try {
-    const partnerId = getValue(PARTNER_KEYS.PARTNER_ID);
-    if (!partnerId) {
-      spinner.fail(chalk.red('Please choose a partner first!'));
-      return;
-    }
-
-    const url = `${PARNTER_URL}/api/partner/apps/${appId}/theme_extensions/${extensionId}/publications`;
-    await axios.post(
-      url,
-      {
-        name: getZipName(),
-        version_id: versionId,
-        type: 'enable'
-      },
-      {
-        headers: {
-          cookie: `awesomev2=${getValue(PARTNER_KEYS.SESSION_ID)};`,
-          'x-shoplazza-partner-id': partnerId
-        }
-      }
-    );
-
-    spinner.succeed();
-    return true;
-  } catch (e) {
-    spinner.fail(e.message || e);
-  }
-};
-
-const publish = async () => {
-  const versionData = await selectVersion();
-  await publishVersion(versionData);
-  done();
-  line();
-};
-
-module.exports = {
-  publish
-};

package/lib/app/extensions/index.js

@@ -1,13 +0,0 @@
-const { generateThemeDirectory } = require('./theme-app');
-const { done } = require('../log');
-
-const themeAppHandler = async (dirname = './') => {
-  (await generateThemeDirectory(dirname)) && done();
-};
-
-const checkoutUIHandler = async () => {};
-
-module.exports = {
-  themeAppHandler,
-  checkoutUIHandler
-};

package/lib/app/extensions/theme-app.js

@@ -1,103 +0,0 @@
-const chalk = require('chalk');
-const ora = require('ora');
-const fs = require('fs-extra');
-const glob = require('glob');
-const repo = require('download-git-repo');
-const CleanCSS = require('clean-css');
-const UglifyJS = require('uglify-js');
-
-const crypto = require('crypto');
-const path = require('path');
-const { line } = require('../log');
-
-const rev = (input) => crypto.createHash('md5').update(input).digest('hex').slice(0, 8);
-const cleanCSS = new CleanCSS({
-  advanced: false,
-  aggressiveMerging: false
-});
-
-const generateThemeDirectory = async (dirname = './') => {
-  const spinner = ora(chalk.cyan(`Waiting generate your theme app project...`)).start();
-  try {
-    await new Promise((resolve, reject) => {
-      repo('Shoplazza/theme-extension-template', dirname, {}, (err) => {
-        if (err) {
-          reject(JSON.stringify(err));
-        } else {
-          resolve(true);
-        }
-      });
-    });
-
-    spinner.succeed(chalk.cyan(`Generate app successfully`));
-    return true;
-  } catch (e) {
-    spinner.fail();
-    console.log(chalk.red(e));
-  }
-};
-
-const buildThemeAssets = async (outputDir = './dist', pathPrefix = '.') => {
-  line();
-  ora(chalk.cyan(`Prepare Build assets ...`)).succeed();
-
-  const manifest = {};
-
-  // build assets css
-  const spinner = ora(chalk.cyan(`Build assets ...`)).start();
-  try {
-    const cssPathnames = glob.sync('./assets/*.css');
-    const jsPathnames = glob.sync('./assets/*.js');
-
-    const pathnames = [...cssPathnames, ...jsPathnames];
-    for (const pathname of pathnames) {
-      const filename = path.basename(pathname);
-      const extname = path.extname(pathname);
-      const fileContent = fs.readFileSync(pathname, 'utf8');
-      const hash = rev(fileContent);
-
-      let minified = '';
-      let filenameWithHash = '';
-      if (extname.includes('css')) {
-        minified = cleanCSS.minify(fileContent);
-        if (minified.errors.length) {
-          spinner.fail(minified.errors);
-          process.exit(-1);
-        }
-        filenameWithHash = `${filename.split('.')[0]}-${hash}.css`;
-        const assetsPath = `${outputDir}/${filenameWithHash}`;
-        fs.ensureFileSync(assetsPath);
-        fs.writeFileSync(assetsPath, minified.styles);
-      } else if (extname.includes('js')) {
-        minified = UglifyJS.minify(fileContent);
-        if (minified.error) {
-          log.error(minified.error);
-          process.exit(-1);
-        }
-        filenameWithHash = `${filename.split('.')[0]}-${hash}.js`;
-        const assetsPath = `${outputDir}/${filenameWithHash}`;
-        fs.ensureFileSync(assetsPath);
-        fs.writeFileSync(assetsPath, minified.code);
-      }
-
-      manifest[filename] = pathPrefix + '/assets/' + filenameWithHash;
-    }
-
-    fs.writeFileSync(`./assets-manifest.json`, JSON.stringify(manifest));
-    spinner.succeed(chalk.cyan(`Build assets done`));
-    return true;
-  } catch (e) {
-    spinner.fail(chalk.red(e.message));
-  }
-
-  // build assets js
-  const jsSpinner = ora(chalk.cyan(`Build js ...`)).start();
-  try {
-    jsSpinner.succeed(chalk.cyan(`Build js done`));
-  } catch (e) {}
-};
-
-module.exports = {
-  generateThemeDirectory,
-  buildThemeAssets
-};

package/lib/app/inquirers/version.js

@@ -1,131 +0,0 @@
-const axios = require('axios');
-const chalk = require('chalk');
-const inquirer = require('inquirer');
-
-const { PARNTER_URL } = require('../constants');
-const { getApp, getValue, PARTNER_KEYS } = require('../db/partner');
-const { line } = require('../log');
-
-const requestLastVersion = async () => {
-  try {
-    const app = getApp();
-    if (!app) {
-      return;
-    }
-    const extensionId = getValue(PARTNER_KEYS.EXTENSION_ID);
-    const partnerId = getValue(PARTNER_KEYS.PARTNER_ID);
-
-    const url = `${PARNTER_URL}/api/partner/apps/${app.uid}/theme_extensions/${extensionId}/last_version`;
-    const res = await axios.get(url, {
-      headers: {
-        cookie: `awesomev2=${getValue(PARTNER_KEYS.SESSION_ID)};`,
-        'x-shoplazza-partner-id': partnerId
-      },
-      validateStatus(status) {
-        if (status === 404) {
-          return true;
-        }
-        return status >= 200 && status < 299;
-      }
-    });
-
-    if (res.data.errors) {
-      return;
-    }
-
-    return res.data.version;
-  } catch (e) {
-    console.log(chalk.red(e.message || e));
-    console.log(chalk.red(JSON.stringify(e.response?.data)));
-  }
-};
-
-const requestVersionsData = async (params = {}) => {
-  try {
-    const app = getApp();
-    if (!app) {
-      return;
-    }
-    const extensionId = getValue(PARTNER_KEYS.EXTENSION_ID);
-    const partnerId = getValue(PARTNER_KEYS.PARTNER_ID);
-
-    const url = `${PARNTER_URL}/api/partner/apps/${app.uid}/theme_extensions/${extensionId}/versions`;
-    const res = await axios.get(url, {
-      params,
-      headers: {
-        cookie: `awesomev2=${getValue(PARTNER_KEYS.SESSION_ID)};`,
-        'x-shoplazza-partner-id': partnerId
-      },
-      validateStatus(status) {
-        if (status === 404) {
-          return true;
-        }
-        return status >= 200 && status < 299;
-      }
-    });
-
-    if (res.data.errors) {
-      throw new Error(JSON.stringify(res.data.errors));
-    }
-
-    return res.data.data;
-  } catch (e) {
-    console.log(chalk.red(e.message || e));
-    console.log(chalk.red(JSON.stringify(e.response?.data)));
-  }
-};
-
-const inputVersion = async () => {
-  line();
-  const lastVersionData = await requestLastVersion({ limit: 1 });
-  const hint = lastVersionData ? chalk.gray(`(last version: ${lastVersionData.version})`) : '';
-
-  const answer = await inquirer.prompt([
-    {
-      type: 'input',
-      name: 'extensionVersion',
-      message: `${chalk.blue('Input your extension version')} ${hint}:`,
-      prefix: `${chalk.green('⭐️')}`
-    }
-  ]);
-
-  return answer['extensionVersion'];
-};
-
-const selectVersion = async () => {
-  line();
-
-  const versionDataList = await requestVersionsData();
-  if (!versionDataList) {
-    console.log(chalk.red('Please deploy a version first!'));
-    line();
-  }
-
-  const answer = await inquirer.prompt([
-    {
-      type: 'list',
-      name: 'versionData',
-      message: `${chalk.blue('Choose a version to publish:')}`,
-      default: versionDataList[0].version,
-      prefix: `${chalk.blue('🐱')}`,
-      choices: versionDataList.map((v) => {
-        return {
-          name: `${v.version} ${v.published ? chalk.green('published') : ''}`,
-          value: {
-            version: v.version,
-            appId: v.app_id,
-            versionId: v.version_id,
-            extensionId: v.extension_id
-          }
-        };
-      })
-    }
-  ]);
-
-  return answer['versionData'];
-};
-
-module.exports = {
-  inputVersion,
-  selectVersion
-};