shoplazza-cli 1.0.7 → 1.0.9

package/lib/function/commands/create.js

@@ -0,0 +1,77 @@
+const { consoleError, consoleSuccess } = require('../../utils/console');
+const path = require('path');
+const fs = require('fs');
+const inquirer = require('inquirer');
+const { copy } = require('../../utils/file');
+
+const cwd = process.cwd();
+
+const templateDir = path.resolve(__dirname, '../template');
+
+const renameFiles = {
+  _gitignore: '.gitignore'
+};
+
+/**
+ * 使用cli创建一个项目
+ * @param {} command 项目名
+ * @returns
+ */
+async function createFuncExtension(command) {
+  const { language, extensionName } = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'extensionName',
+      message: 'Enter the extension name:',
+      prefix: '*'
+    },
+    {
+      type: 'list',
+      name: 'language',
+      message: 'Select a language:',
+      choices: [
+        {
+          name: 'javascript',
+          value: 'js'
+        }
+      ],
+      prefix: '*'
+    }
+  ]);
+  const projectDir = extensionName.replace(/\/+$/g, '');
+  const fullTempDir = path.join(templateDir, language);
+  const root = path.join(cwd, projectDir);
+  if (fs.existsSync(root)) {
+    consoleError(`the directory '${projectDir}' is exist.`);
+    return;
+  }
+  fs.mkdirSync(root, { recursive: true });
+
+  const write = (file, content) => {
+    const targetPath = path.join(root, renameFiles[file] ?? file);
+    if (content) {
+      fs.writeFileSync(targetPath, content);
+    } else {
+      copy(path.join(fullTempDir, file), targetPath);
+    }
+  };
+
+  const files = fs.readdirSync(fullTempDir);
+  for (const file of files.filter((f) => !['package.json'].includes(f))) {
+    write(file);
+  }
+
+  const pkg = JSON.parse(fs.readFileSync(path.join(fullTempDir, `package.json`), 'utf-8'));
+  pkg.name = projectDir;
+  write('package.json', JSON.stringify(pkg, null, 2) + '\n');
+
+  const config = JSON.parse(fs.readFileSync(path.join(fullTempDir, `extension.config.json`), 'utf-8'));
+  config.extensionName = extensionName;
+  write('extension.config.json', JSON.stringify(config, null, 2) + '\n');
+
+  consoleSuccess(`Successfully created extension project '${extensionName}'.`);
+}
+
+module.exports = {
+  createFuncExtension
+};

package/lib/function/commands/list.js

@@ -0,0 +1,18 @@
+const partnerAPI = require('../../partner-api');
+const { requestAppSecretWhenNotExist } = require('../utils');
+
+async function getFunctions() {
+  const data = await partnerAPI.getFunctionList();
+  return data.functions;
+}
+
+async function listFunctionExtension() {
+  await requestAppSecretWhenNotExist();
+  const list = await getFunctions();
+  console.log(list.map(({ source_code, ...other }) => other));
+}
+
+module.exports = {
+  getFunctions,
+  listFunctionExtension
+};

package/lib/function/commands/release.js

@@ -0,0 +1,69 @@
+const inquirer = require('inquirer');
+const chalk = require('chalk');
+const fs = require('fs-extra');
+const path = require('path');
+const loadingCli = require('loading-cli');
+const { requestAppSecretWhenNotExist } = require('../utils');
+const { compileJsToWasm } = require('./compile');
+const { getConfigJson, updateConfigJson } = require('../../utils/file');
+const partnerAPI = require('../../partner-api');
+const { consoleError } = require('../../utils/console');
+const FormData = require('form-data');
+
+async function createOrUpdateFuncExtension() {
+  const config = getConfigJson();
+  const functionId = config.extensionId;
+  const formData = new FormData();
+  formData.append('namespace', 'cart_transform');
+  formData.append('name', config.extensionName);
+  formData.append('source_code', fs.readFileSync(path.resolve(process.cwd(), 'src/index.js'), { encoding: 'utf-8' }));
+  formData.append('source_code', 'hello');
+  formData.append(
+    'file',
+    fs.createReadStream(path.resolve(process.cwd(), 'dist', `${config.extensionName}.wasm`), {
+      filename: `${config.extensionName}.wasm`,
+      contentType: 'application/wasm'
+    })
+  );
+
+  let data;
+  if (!functionId) {
+    const loading = loadingCli('create an new function extension');
+    loading.start();
+    data = await partnerAPI
+      .createFunctionExtension(formData)
+      .then((res) => {
+        loading.succeed();
+        return res;
+      })
+      .catch((err) => {
+        loading.fail();
+        consoleError(err, err.response.data);
+      });
+  } else {
+    const loading = loadingCli('update function extension');
+    loading.start();
+    formData.append('function_id', functionId);
+    data = await partnerAPI
+      .updateFunctionExtension(functionId, formData)
+      .then((res) => {
+        loading.succeed();
+        return res;
+      })
+      .catch((err) => {
+        loading.fail();
+        consoleError(err, err.response);
+      });
+  }
+  data && updateConfigJson({ extensionId: data.function_id, version: data.version });
+}
+
+async function releaseFunctionExtension(command) {
+  await requestAppSecretWhenNotExist();
+  await compileJsToWasm();
+  await createOrUpdateFuncExtension();
+}
+
+module.exports = {
+  releaseFunctionExtension
+};

package/lib/function/index.js

@@ -0,0 +1,24 @@
+function makeFunctionCommand(_program) {
+  const program = _program.command('function').description('Shoplazza function cli');
+
+  program
+    .command('create')
+    .description('create a extension project')
+    .action(require('./commands/create').createFuncExtension);
+
+  program
+    .command('list')
+    .description('list all function of current app')
+    .action(require('./commands/list').listFunctionExtension);
+
+  program.command('compile').description('compile js to wasm').action(require('./commands/compile').compileJsToWasm);
+
+  program
+    .command('release')
+    .description('release a version of function extension')
+    .action(require('./commands/release').releaseFunctionExtension);
+}
+
+module.exports = {
+  makeFunctionCommand
+};

package/lib/function/template/js/README.md

@@ -0,0 +1,37 @@
+# Checkout Extension
+## Getting started
+
+1. 安装依赖
+
+    ```
+    npm i
+    ```
+2. 绑定app
+    ```
+    npm run connect
+    ```
+3. release extension
+    ```
+    npm run release
+    ```
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

package/lib/function/template/js/_gitignore

@@ -0,0 +1,4 @@
+node_modules/
+pnpm-lock.yaml
+dist
+.history/

package/lib/function/template/js/extension.config.json

@@ -0,0 +1,5 @@
+{
+  "extensionName": "",
+  "extensionId": "",
+  "version": "1.0"
+}

package/lib/function/template/js/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "hello",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "dependencies": {},
+  "devDependencies": {},
+  "scripts": {
+    "dev": "shoplazza function dev",
+    "connect": "shoplazza function connect",
+    "release": "shoplazza function release",
+    "list": "shoplazza function list"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}

package/lib/function/template/js/src/index.js

@@ -0,0 +1,64 @@
+const input = readInput();
+const result = run(input);
+writeOutput(result);
+
+function run(input) {
+  const runResult = {
+    operations: {
+      update: []
+    }
+  };
+
+  input.cart.line_items.forEach((lineItem) => {
+    lineItem.product.metafields.forEach((metafield) => {
+      // key是自己定义的metafield名。如果有同名的key，可用namespace用于区分
+      if (metafield.namespace === 'custom-option' && metafield.key === 'adjust-10-price') {
+        runResult.operations.update.push({
+          id: lineItem.id,
+          price: {
+            adjustment_fixed_price: '10' // 设置定制的价格10元
+          }
+        });
+      }
+    });
+  });
+  return runResult;
+}
+
+function readInput() {
+  const chunkSize = 1024;
+  const inputChunks = [];
+  let totalBytes = 0;
+  // Read all the available bytes
+  while (1) {
+    const buffer = new Uint8Array(chunkSize);
+    // Stdin file descriptor
+    const fd = 0;
+    const bytesRead = Javy.IO.readSync(fd, buffer);
+    totalBytes += bytesRead;
+    if (bytesRead === 0) {
+      break;
+    }
+    inputChunks.push(buffer.subarray(0, bytesRead));
+  }
+  // Assemble input into a single Uint8Array
+  const { finalBuffer } = inputChunks.reduce(
+    (context, chunk) => {
+      context.finalBuffer.set(chunk, context.bufferOffset);
+      context.bufferOffset += chunk.length;
+      return context;
+    },
+    { bufferOffset: 0, finalBuffer: new Uint8Array(totalBytes) }
+  );
+
+  return JSON.parse(new TextDecoder().decode(finalBuffer));
+}
+
+// Write output to stdout
+function writeOutput(output) {
+  const encodedOutput = new TextEncoder().encode(JSON.stringify(output));
+  const buffer = new Uint8Array(encodedOutput);
+  // Stdout file descriptor
+  const fd = 1;
+  Javy.IO.writeSync(fd, buffer);
+}

package/lib/function/utils.js

@@ -0,0 +1,29 @@
+const inquirer = require('inquirer');
+const { getConfigJson, updateConfigJson } = require('../utils/file');
+
+async function requestAppSecretWhenNotExist() {
+  const config = getConfigJson();
+  if (!config.appId || !config.appSecret) {
+    const { appId, appSecret } = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'appId',
+        message: 'Enter client id of app:',
+        prefix: '*'
+      },
+      {
+        type: 'input',
+        name: 'appSecret',
+        message: 'Enter client secret of app:',
+        prefix: '*'
+      }
+    ]);
+    config.appId = appId;
+    config.appSecret = appSecret;
+    updateConfigJson(config);
+  }
+}
+
+module.exports = {
+  requestAppSecretWhenNotExist
+};

package/lib/openAPI/api.js

@@ -1,6 +1,6 @@
 const fs = require('fs-extra');
 const FormData = require('form-data');
-const { getThemeFilenameTypeAndLocation } = require('../utils');
+const { getThemeFilenameTypeAndLocation } = require('../utils/utils');
 const openAPI = require('./index');
 
 exports.getShopDetail = (config = {}) => {

package/lib/openAPI/index.js

@@ -3,7 +3,6 @@ const fs = require('fs-extra');
 const chalk = require('chalk');
 const Sentry = require('@sentry/node');
 const { get, set } = require('../db/user');
-const { getThemeFilenameTypeAndLocation } = require('../utils');
 const { postExchangeToken } = require('../auth');
 const log = require('../log');
 
@@ -12,17 +11,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 +44,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/partner-api/axios.js

@@ -0,0 +1,67 @@
+const axios = require('axios');
+const { isDevDebug, isStgDebug } = require('../utils/env');
+const { consoleError } = require('../utils/console');
+const { updateConfigJson, getConfigJson } = require('../utils/file');
+
+const baseUrl = `https://partners.${isDevDebug() ? 'dev.' : isStgDebug() ? 'stg.' : ''}shoplazza.com`;
+
+const instance = axios.create({
+  baseURL: baseUrl + '/openapi/2024-07'
+});
+
+instance.interceptors.request.use(
+  async (config) => {
+    const extConfig = getConfigJson();
+    let token = extConfig.accessToken;
+    if (!token) {
+      token = await refreshAccessToken();
+    }
+    config.headers['Access-Token'] = token;
+    config.headers['app-client-id'] = extConfig.appId;
+    return config;
+  },
+  (error) => {
+    consoleError(`[REQUEST ERROR] ${error.message}`);
+    return Promise.reject(error);
+  }
+);
+
+instance.interceptors.response.use(
+  function (response) {
+    return response;
+  },
+  async function (error) {
+    const { config, response } = error || {};
+    if (response?.status === 403 && !config._retry) {
+      config._retry = true;
+      await refreshAccessToken();
+      return instance(config);
+    }
+    error.response &&
+      consoleError(
+        `[RESPONSE ERROR] ${error.response.status} ${error.response.config.baseURL}${error.response.config.url}`
+      );
+    return Promise.reject(error);
+  }
+);
+
+function refreshAccessToken() {
+  const extensionConfig = getConfigJson();
+  if (!extensionConfig.appId || !extensionConfig.appSecret) {
+    consoleError(`must provide 'appId' and 'appSecret' in  extension.config.json `);
+    process.exit(-1);
+  }
+  return axios
+    .post(baseUrl + '/partner/oauth/token', {
+      client_id: extensionConfig.appId,
+      client_secret: extensionConfig.appSecret,
+      grant_type: 'client_credentials'
+    })
+    .then((res) => {
+      const token = res.data.access_token;
+      updateConfigJson({ accessToken: token });
+      return token;
+    });
+}
+
+module.exports = instance;

package/lib/partner-api/index.js

@@ -0,0 +1,79 @@
+const axios = require('./axios');
+// const Aaxios = require('axios');
+
+// const axios = Aaxios.create({
+//   baseURL: 'http://igw-traefik.internal.svc.cluster.local/service/functions-api/api/partner-openapi/2025-03',
+//   headers: {
+//     'x-rf': 'feature-ymq',
+//     'app-client-id': '123123'
+//   }
+// });
+
+function createFunctionExtension(form) {
+  return axios
+    .post('/functions', form, {
+      headers: {
+        ...form.getHeaders()
+      }
+    })
+    .then((res) => res.data?.data);
+}
+
+function updateFunctionExtension(functionId, form) {
+  return axios
+    .patch(`/functions/${functionId}`, form, {
+      headers: {
+        ...form.getHeaders()
+      }
+    })
+    .then((res) => res.data?.data);
+}
+
+function getFunctionList(params = { page: 1, limit: 1000 }) {
+  return axios
+    .get(
+      '/functions',
+      { params },
+      {
+        headers: {
+          'Content-Type': 'application/ x-www-form-urlencoded',
+        }
+      }
+    )
+    .then((res) => res.data?.data);
+}
+
+/**
+ * 连接App
+ */
+async function toConnectApp(data) {
+  return axios.post(
+    '/theme-extensions/connection',
+    {
+      extension_id: data.extensionId,
+      type: data.type || 'link'
+    }
+  );
+}
+
+/**
+ * 应用主题插件到App
+ */
+async function toReleaseApp(data) {
+  return axios.post(
+    '/theme-extensions/publications',
+    {
+      extension_id: data.extensionId,
+      version_id: data.versionId,
+      type: data.type || 'enable'
+    }
+  );
+}
+
+module.exports = {
+  createFunctionExtension,
+  updateFunctionExtension,
+  getFunctionList,
+  toConnectApp,
+  toReleaseApp
+};

package/lib/{checkout → utils}/console.js

@@ -6,9 +6,10 @@ function isDebug() {
 
 function consoleError(...args) {
   if (isDebug()) {
-    console.trace(args);
+    console.trace(colors.red(args));
+  } else {
+    console.log(colors.red(args.join(' ')));
   }
-  console.log(colors.red(args.join(' ')));
 }
 
 function consoleBlue(...args) {