shoplazza-cli 1.0.7-beta.1 → 1.0.7-beta.3

package/bin/shoplazza

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 
 process.noDeprecation = true; // 全局禁用废弃警告
+require('../lib/check');
 const { program } = require('commander');
 const updateNotifier = require('update-notifier');
 const Sentry = require('@sentry/node');
@@ -11,6 +12,7 @@ require('../lib/tracing');
 
 const { makeCheckoutCommand } = require('../lib/checkout');
 const { initThemeAppCommand } = require('../lib/app');
+const { makeFunctionCommand } = require('../lib/function');
 
 Sentry.init({
   dsn: 'https://89964605acaf4db8839f2d5237396d6c@sentry.shoplazza.com/730',
@@ -29,6 +31,7 @@ updateNotifier({ pkg }).notify({
   isGlobal: true
 });
 program.usage('[command] [options]');
+program.option('--debug <ent>', 'debug mode')
 
 program.command('version').description('Welcome to the Shoplazza CLI').action(require('../lib/commands/version'));
 program.description('Welcome to the Shoplazza CLI').option('-v --version').action(require('../lib/commands/version'));
@@ -112,11 +115,12 @@ theme
   .option('-t, --theme <theme>', 'The ID of the theme that you want to delete.')
   .action(require('../lib/commands/theme/delete'));
 
-
 // checkout cli
 makeCheckoutCommand(program);
 // theme app cli
 initThemeAppCommand(program);
+// function cli
+makeFunctionCommand(program);
 
 program.parse(process.argv);
 !program.args.length && program.help();

package/lib/app/api/index.js

@@ -1,5 +1,5 @@
 const instance = require('../../openAPI/index');
-
+const request = require('../../partner-api/axios');
 
 /**
  * 获取主题列表
@@ -92,5 +92,5 @@ module.exports = {
   getThemeAppVersionList,
   toCreateThemeAppVersion,
   toDeployThemeApp,
-  getTaskStatus
+  getTaskStatus,
 };

package/lib/app/commands/build.js

@@ -2,7 +2,7 @@ const chalk = require('chalk');
 const inquirer = require('inquirer');
 const ora = require('ora');
 const fsExtra = require('fs-extra');
-const { getThemeAppConfig, compareVersions, compress } = require('../utils');
+const { getThemeExtensionConfig, compareVersions, compress } = require('../utils');
 const { THEME_APP_DIR_PATH, EXCHANGE_TOKEN, STORE_DOMAIN } = require('../utils/config');
 const { getThemeAppVersionList, toCreateThemeAppVersion, getTaskStatus } = require('../api');
 const { useOss } = require('../../oss');
@@ -35,7 +35,7 @@ async function createNewVersion(extensionId, version, description) {
       const res = await getTaskStatus({ taskId });
       if (res.data?.state === 1) {
         clearInterval(timer);
-        spinner.succeed(chalk.green(`Successfully built a new version(v${version})!`));
+        spinner.succeed(chalk.green(`Successfully build a new version(v${version})!`));
         resolve();
       } else if (res.data?.state === 2) {
         clearInterval(timer);
@@ -69,7 +69,7 @@ async function usePrompt(extensionId) {
     {
       type: 'input',
       name: 'newVersion',
-      message: 'Enter the new version number:',
+      message: 'Enter the new version number(e.g., 1.0.0):',
       validate: (newVersion) => {
         if (!/^[0-9]+\.[0-9]+\.[0-9]+$/.test(newVersion)) {
           return chalk.red('❌ Version must follow the format X.Y.Z (e.g., 1.0.0).');
@@ -98,7 +98,7 @@ async function usePrompt(extensionId) {
 
 async function build() {
   try {
-    const { extensionId } = await getThemeAppConfig();
+    const { extensionId } = await getThemeExtensionConfig();
     if (!extensionId) {
       throw new Error('ExtensionId is empty, please use `serve` command first.');
     }

package/lib/app/commands/connect.js

@@ -0,0 +1,73 @@
+const chalk = require('chalk');
+const inquirer = require('inquirer');
+const { getThemeExtensionConfig, setThemeExtensionConfig } = require('../utils');
+const { toConnectApp } = require('../../partner-api/index');
+
+/**
+ * 交互式命令行
+ */
+async function usePrompt() {
+  return await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'clientId',
+      message: 'Please enter the shoplazza app Client ID:',
+      prefix: '*',
+      validate: (clientId) => {
+        if (!clientId.trim()) {
+          return 'Client ID cannot be empty';
+        }
+        return true;
+      }
+    },
+    {
+      type: 'input',
+      name: 'clientSecret',
+      message: 'Please enter the shoplazza app Client Secret:',
+      prefix: '*',
+      validate: (clientSecret) => {
+        if (!clientSecret.trim()) {
+          return 'Client Secret cannot be empty';
+        }
+        return true;
+      }
+    }
+  ]);
+}
+
+async function connectToApp() {
+  try {
+    let { extensionId, appId, accessToken } = await getThemeExtensionConfig();
+    if (!extensionId) {
+      throw new Error('ExtensionId is empty, please use `serve` command first.');
+    }
+
+    if (!accessToken) {
+      const result = await usePrompt();
+      appId = result.clientId;
+      appSecret = result.clientSecret;
+      await setThemeExtensionConfig({
+        appId,
+        appSecret
+      });
+    }
+
+    const res = await toConnectApp({
+      extensionId,
+      appId
+    });
+
+    if (+res.data?.code === 200) {
+      console.log(chalk.green('Connected to the Shoplazza app successfully!'));
+      console.log(chalk.cyan('You can use the `release` command to release a specific version to the Shoplazza app.'));
+    } else if (+res.data?.code === 400) {
+      console.log(chalk.green(res.data?.message));
+    }
+  } catch (error) {
+    console.error(chalk.red(`[ERROR IN CONNECT] ${error.message}`));
+  }
+}
+
+module.exports = {
+  connect: connectToApp
+};

package/lib/app/commands/create.js

@@ -40,7 +40,7 @@ async function initProj(projectPath, projectName, isBasicApp = false) {
   const replacementConfig = {
     'package.json': { projectName },
     'theme-app/blocks/index.liquid': { projectName },
-    'theme-extension.config.json': { projectName }
+    'extension.config.json': { projectName }
   };
   for (const [filePath, replacements] of Object.entries(replacementConfig)) {
     const fullPath = path.resolve(projectPath, filePath);

package/lib/app/commands/deploy.js

@@ -1,7 +1,7 @@
 const inquirer = require('inquirer');
 const chalk = require('chalk');
 const ora = require('ora');
-const { getThemeAppConfig } = require('../utils');
+const { getThemeExtensionConfig } = require('../utils');
 const { getThemeAppVersionList, toDeployThemeApp } = require('../api');
 
 async function deployVersion(extensionId, versionInfo) {
@@ -23,14 +23,15 @@ async function usePrompt(versionList) {
       type: 'list',
       name: 'selectedVersion',
       message: 'Select a version to deploy:',
-      choices
+      choices,
+      loop: false
     }
   ]);
 }
 
 async function deploy() {
   try {
-    const { extensionId } = await getThemeAppConfig();
+    const { extensionId } = await getThemeExtensionConfig();
     if (!extensionId) {
       throw new Error('ExtensionId is empty, please use `serve` command first.');
     }

package/lib/app/commands/release.js

@@ -0,0 +1,59 @@
+const inquirer = require('inquirer');
+const chalk = require('chalk');
+const ora = require('ora');
+const { getThemeExtensionConfig } = require('../utils');
+const { getThemeAppVersionList } = require('../api');
+const { toReleaseApp } = require('../../partner-api/index');
+
+async function releaseVersion(extensionId, versionInfo) {
+  const res = await toReleaseApp({
+    extensionId,
+    versionId: versionInfo.version_id
+  });
+  console.log(chalk.green(`Version ${versionInfo.version} has been released successfully.`));
+}
+
+async function usePrompt(versionList) {
+  const choices = versionList.map((v) => ({
+    name: `${v.version} (${v.exts}) - ${v.created_at}`,
+    value: v.version_id
+  }));
+  return inquirer.prompt([
+    {
+      type: 'list',
+      name: 'selectedVersion',
+      message: 'Select a version to release:',
+      choices,
+      loop: false
+    }
+  ]);
+}
+
+async function releaseToApp() {
+  try {
+    const { extensionId, appId } = await getThemeExtensionConfig();
+    if (!extensionId) {
+      throw new Error('ExtensionId is empty, please use `serve` command first.');
+    }
+    if (!appId) {
+      throw new Error('Missing appId, please use `connect` command first.');
+    }
+    const spinner = ora('Fetching version list...').start();
+    const res = await getThemeAppVersionList(extensionId);
+    const versionList = res.data?.data || [];
+    if (!versionList.length) {
+      spinner.succeed('Version list loaded.');
+      throw new Error('No version found, please use `build` command to upload a version first.');
+    }
+    spinner.succeed('Version list loaded.');
+    const { selectedVersion } = await usePrompt(versionList);
+    const versionInfo = versionList.find((v) => v.version_id === selectedVersion);
+    await releaseVersion(extensionId, versionInfo);
+  } catch (error) {
+    console.error(chalk.red(`[ERROR IN DEPLOY] ${error.message}`));
+  }
+}
+
+module.exports = {
+  release: releaseToApp
+};

package/lib/app/commands/serve.js

@@ -3,7 +3,7 @@ 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 { compress, getThemeExtensionConfig, setThemeExtensionConfig, getFileInfo } = require('../utils');
 const {
   toCreateThemeApp,
   toUploadThemeApp,
@@ -13,7 +13,7 @@ const {
   toUpdateFile,
   toDeleteFile
 } = require('../api');
-const { watchWorkspace } = require('../../utils');
+const { watchWorkspace } = require('../../utils/utils');
 const { useOss } = require('../../oss');
 
 /**
@@ -89,7 +89,8 @@ async function usePrompt() {
       choices: themeList.map((theme) => ({
         name: theme.name,
         value: theme.id
-      }))
+      })),
+      loop: false
     }
   ]);
   return selectedThemeId;
@@ -98,16 +99,16 @@ async function usePrompt() {
 /**
  * 创建主题插件
  */
-async function createThemeApp(themeAppConfig) {
+async function createThemeApp(themeExtensionConfig) {
   const data = {
-    title: themeAppConfig.extensionName || '' // 插件显示名称
+    title: themeExtensionConfig.extensionName || '' // 插件显示名称
   };
-  if (themeAppConfig.extensionId) {
-    data.extension_id = themeAppConfig.extensionId;
+  if (themeExtensionConfig.extensionId) {
+    data.extension_id = themeExtensionConfig.extensionId;
   }
   const res = await toCreateThemeApp(data);
   const extensionId = res.data?.extension_id;
-  await setThemeAppConfig({ extensionId });
+  await setThemeExtensionConfig({ extensionId });
   return extensionId;
 }
 
@@ -154,10 +155,10 @@ function startWatcher(extensionId) {
 
 async function serve() {
   try {
-    const themeAppConfig = await getThemeAppConfig();
-    let extensionId = themeAppConfig.extensionId;
+    const themeExtensionConfig = await getThemeExtensionConfig();
+    let extensionId = themeExtensionConfig.extensionId;
     if (!extensionId) {
-      extensionId = await createThemeApp(themeAppConfig);
+      extensionId = await createThemeApp(themeExtensionConfig);
     }
     await syncLocalFiles(extensionId);
     const selectedThemeId = await usePrompt();

package/lib/app/commands/versions.js

@@ -1,6 +1,5 @@
 const chalk = require('chalk');
-const ora = require('ora');
-const { getThemeAppConfig, renderTable } = require('../utils');
+const { getThemeExtensionConfig, renderTable } = require('../utils');
 const { getThemeAppVersionList } = require('../api');
 
 /**
@@ -8,12 +7,16 @@ const { getThemeAppVersionList } = require('../api');
  */
 function consoleTips(versionList) {
   if (versionList.length) {
+    const tempVersionList = versionList.map((item) => ({
+      ...item,
+      composeVersion: item.published === 1 ? `${item.version}(published)` : item.version
+    }));
     console.log(chalk.green('\n📜 Available Versions:'));
     console.log(
-      renderTable(versionList, [
+      renderTable(tempVersionList, [
         {
           label: 'Version',
-          filed: 'version',
+          filed: 'composeVersion',
           color: 'yellowBright'
         },
         {
@@ -35,9 +38,9 @@ function consoleTips(versionList) {
 
 async function versions() {
   try {
-    const { extensionId } = await getThemeAppConfig();
-    if(!extensionId) {
-      throw new Error('ExtensionId is empty, please use `serve` command first.')
+    const { extensionId } = await getThemeExtensionConfig();
+    if (!extensionId) {
+      throw new Error('ExtensionId is empty, please use `serve` command first.');
     }
     const res = await getThemeAppVersionList(extensionId);
     const versionList = res.data?.data || [];

package/lib/app/index.js

@@ -19,6 +19,9 @@ function initThemeAppCommand(_program) {
 
   program.command('list').description('List all theme extensions').action(require('./commands/list').list);
 
+  program.command('connect').description('Establish a connection between the theme extension and the shoplazza app').action(require('./commands/connect').connect);
+
+  program.command('release').description('Release a theme extension version to be applied in the shoplazza app').action(require('./commands/release').release);
 }
 
 module.exports = {

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

@@ -1,15 +1,15 @@
 {% use "{{projectName}}.css" %}
 
 <div id="{{projectName}}" class="container">
-  <h1>SHOPLAZZA THEME EXTENSION</h1>
+  <h1>{{ 'i18n.initial.title' | t }}</h1>
   {% include "{{projectName}}" %}
 </div>
 
 {% schema %} 
 {
   "name": {
-    "en-US": "{{projectName}}-US",
-    "zh-CN": "{{projectName}}-CN"
+    "en-US": "{{projectName}}(dev)",
+    "zh-CN": "{{projectName}}(开发)"
   },
   "settings": []
 }

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

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

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

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

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

@@ -0,0 +1,6 @@
+{
+  "initial":{
+    "title": "SHOPLAZZA THEME EXTENSION",
+    "sub_title": "BASIC TYPE"
+  }
+}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,6 @@
+{
+  "initial": {
+    "title": "SHOPLAZZA 主题插件",
+    "sub_title": "BASIC 类型"
+  }
+}

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

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

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

@@ -1,5 +1,5 @@
 <div>
-    <h3>BASIC TYPE</h3>
+    <h3>{{ 'i18n.initial.sub_title' | t }}</h3>
 </div>
 
 

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

@@ -1,18 +1,18 @@
 {% include "{{projectName}}_css" %}
 
 <div id="{{projectName}}" class="container">
-  <h1>SHOPLAZZA THEME EXTENSION</h1>
+  <h1>{{ 'i18n.initial.title' | t }}</h1>
   {% include "{{projectName}}" %}
 </div>
 
 {% schema %} 
 {
   "name": {
-    "en-US": "{{projectName}}-US",
-    "zh-CN": "{{projectName}}-CN"
+    "en-US": "{{projectName}}(dev)",
+    "zh-CN": "{{projectName}}(开发)"
   },
+  "icon":"https://assets.shoplazza.com/oss/operation/a425c6e10e32f87a1e7271c9ed9347d8.svg",
   "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

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

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

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

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

@@ -1,3 +1,6 @@
 {
-  "general": {}
+  "initial":{
+    "title": "SHOPLAZZA THEME EXTENSION",
+    "sub_title": "EMBED TYPE"
+  }
 }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,3 +1,6 @@
 {
-  "general": {}
+  "initial": {
+    "title": "SHOPLAZZA 主题插件",
+    "sub_title": "EMBED 类型"
+  }
 }

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

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

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

@@ -1,5 +1,5 @@
 <div>
-    <h3>EMBED TYPE</h3>
+    <h3>{{ 'i18n.initial.sub_title' | t }}</h3>
 </div>
 
 

package/lib/app/utils/config.js

@@ -5,7 +5,7 @@ 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 THEME_APP_CONFIG_PATH = path.resolve(WORKSPACE_PATH, 'extension.config.json')
 
 const STORE_DOMAIN = get('store_domain');
 
@@ -13,11 +13,11 @@ const EXCHANGE_TOKEN = get('exchange_token');
 
 const THEME_APP_TYPE = {
   BASIC_APP: {
-    description: 'basic extension(just an basic extension)',
+    description: 'Basic Extension(a card storekeeper decide where it add)',
     templatePath: path.resolve(__dirname, '../template/basic-app')
   },
   EMBEDS_APP: {
-    description: 'embed extension(embed in a theme)',
+    description: 'Embed Extension(a card not need add)',
     templatePath: path.resolve(__dirname, '../template/embed-app')
   }
 };