shoplazza-cli 0.1.8 → 1.0.3

package/README.md

@@ -21,6 +21,7 @@ Shoplazza CLI accelerates your theme development process with the following feat
 - Upload themes to your store.
 - Watch for local changes and upload them automatically to Shoplazza.
 - Work on Linux, macOS, and Windows.
+- Support customized Checkout page.
 
 ## Installation [shoplazza-cli](https://www.npmjs.com/package/shoplazza-themekit)
 
@@ -38,7 +39,74 @@ Before you start using Shoplazza CLI to develop themes, make sure that you do th
 - Note the URL of the store that you want to work on.
 - Make sure that you're connected to the internet. Most Shoplazza CLI commands need an internet connection to run.
 
-## Getting started
+
+## Checkout Develop
+
+You  can use Shoplazza CLI  to develop checkout, customized checkout page as you want.
+
+### Feature
+
+- 支持本地开发和调试，支持热更新。
+- 支持预览，在推送到店铺之后，通过预览链接进入可以进行预览。
+- 支持部署extension，部署后所有用户都能看到变更。
+- 支持下线extension，下线之后extension将不在店铺中生效。
+
+### Get Started
+
+#### Step 1: 创建一个项目模板
+
+创建过程会要求你输入店铺地址和token，token可以在后台中应用->管理私有应用->创建应用 获得。创建过程还要求你输入一个extension名字，一个项目下支持存在多个extension，这是为了方便管理，它们互不影响。
+```
+shoplazza checkout create
+// 安装依赖
+npm i
+```
+
+#### Step2: 本地开发
+extension支持本地开发，支持在线上店铺Checkout页面插入本地的extension代码，这仅在你的浏览器生效。
+首先，先启动本地开发服务器：
+```
+shoplazza checkout dev
+```
+然后在checkout页面打开控制台切换为开发模式：
+```
+CheckoutAPI.extension.DEV_switchDevMode()
+```
+在checkout页面即可看到extension变更。
+
+#### Step3: 预览extension
+在完成本地开发之后，我们可以将extension推送到店铺进行预览。
+```
+shoplazza checkout push
+```
+访问预览url即可看到效果。
+#### Step4: 部署Extension
+在预览测试完成之后，可以在店铺发布extension，发布之后所有用户都可以看到。
+```
+shoplazza checkout deploy
+```
+或者对将已发布的extension下线：
+```
+shoplazza checkout undeploy
+
+```
+
+### Other command
+
+#### 查看已部署的extension
+```
+shoplazza checkout list
+
+// 查看所有
+shoplazza checkout list -a
+```
+
+#### 预览extension
+```
+shoplazza checkout preview
+```
+
+## Theme Develop
 
 ### Authenticate
 

package/examples/checkout-extension/extensions/add-shipping-desc/src/index.js

@@ -1,4 +1,4 @@
-import { extend } from "@shoplazza/extension-ui";
+import { extend } from "shoplazza-extension-ui";
 
 extend({
   extensionPoint: "Checkout::ShippingLinesTitle::RenderAfter",

package/examples/checkout-extension/extensions/ext-1/src/index.js

@@ -1,4 +1,4 @@
-import { extend } from '@shoplazza/extension-ui';
+import { extend } from 'shoplazza-extension-ui';
 import index from './index.html';
 
 function App() {

package/examples/checkout-extension/extensions/product-list/extension.json

@@ -0,0 +1,10 @@
+{
+  "version": "1.0",
+  "deleteTarget": [],
+  "placeholder": {},
+  "templateName": "checkout",
+  "themeName": "",
+  "extensionId": "",
+  "extensionName": "product-list",
+  "extensionDescription": ""
+}

package/examples/checkout-extension/extensions/product-list/src/index.js

@@ -0,0 +1,5 @@
+const productList = CheckoutAPI.summary.getProductList();
+
+console.debug('productList', productList);
+
+//  do something, such as report

package/examples/checkout-extension/extensions/rewrite-navigate/src/index.js

@@ -1,4 +1,4 @@
-import { extend } from '@shoplazza/extension-ui';
+import { extend } from 'shoplazza-extension-ui';
 import index from './index.html';
 
 function App() {

package/examples/checkout-extension/package-lock.json

@@ -0,0 +1,121 @@
+{
+  "name": "checkout-extension",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "checkout-extension",
+      "version": "1.0.0",
+      "license": "ISC",
+      "dependencies": {
+        "fs-extra": "11.1.1",
+        "shoplazza-extension-ui": "1.0.0"
+      },
+      "devDependencies": {}
+    },
+    "node_modules/fs-extra": {
+      "version": "11.1.1",
+      "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.1.1.tgz",
+      "integrity": "sha512-MGIE4HOvQCeUCzmlHs0vXpih4ysz4wg9qiSAu6cd42lVwPbTM1TjV7RusoyQqMmk/95gdQZX72u+YW+c3eEpFQ==",
+      "license": "MIT",
+      "dependencies": {
+        "graceful-fs": "^4.2.0",
+        "jsonfile": "^6.0.1",
+        "universalify": "^2.0.0"
+      },
+      "engines": {
+        "node": ">=14.14"
+      }
+    },
+    "node_modules/graceful-fs": {
+      "version": "4.2.11",
+      "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz",
+      "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==",
+      "license": "ISC"
+    },
+    "node_modules/js-tokens": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
+      "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==",
+      "license": "MIT"
+    },
+    "node_modules/jsonfile": {
+      "version": "6.1.0",
+      "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz",
+      "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==",
+      "license": "MIT",
+      "dependencies": {
+        "universalify": "^2.0.0"
+      },
+      "optionalDependencies": {
+        "graceful-fs": "^4.1.6"
+      }
+    },
+    "node_modules/loose-envify": {
+      "version": "1.4.0",
+      "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz",
+      "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==",
+      "license": "MIT",
+      "dependencies": {
+        "js-tokens": "^3.0.0 || ^4.0.0"
+      },
+      "bin": {
+        "loose-envify": "cli.js"
+      }
+    },
+    "node_modules/react": {
+      "version": "18.3.1",
+      "resolved": "https://registry.npmjs.org/react/-/react-18.3.1.tgz",
+      "integrity": "sha512-wS+hAgJShR0KhEvPJArfuPVN1+Hz1t0Y6n5jLrGQbkb4urgPE/0Rve+1kMB1v/oWgHgm4WIcV+i7F2pTVj+2iQ==",
+      "license": "MIT",
+      "dependencies": {
+        "loose-envify": "^1.1.0"
+      },
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/react-dom": {
+      "version": "18.3.1",
+      "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.3.1.tgz",
+      "integrity": "sha512-5m4nQKp+rZRb09LNH59GM4BxTh9251/ylbKIbpe7TpGxfJ+9kv6BLkLBXIjjspbgbnIBNqlI23tRnTWT0snUIw==",
+      "license": "MIT",
+      "dependencies": {
+        "loose-envify": "^1.1.0",
+        "scheduler": "^0.23.2"
+      },
+      "peerDependencies": {
+        "react": "^18.3.1"
+      }
+    },
+    "node_modules/scheduler": {
+      "version": "0.23.2",
+      "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.2.tgz",
+      "integrity": "sha512-UOShsPwz7NrMUqhR6t0hWjFduvOzbtv7toDH1/hIrfRNIDBnnBWd0CwJTGvTpngVlmwGCdP9/Zl/tVrDqcuYzQ==",
+      "license": "MIT",
+      "dependencies": {
+        "loose-envify": "^1.1.0"
+      }
+    },
+    "node_modules/shoplazza-extension-ui": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/shoplazza-extension-ui/-/shoplazza-extension-ui-1.0.0.tgz",
+      "integrity": "sha512-gW2sWnfyEXwbWfi9Sje4K+r0ECCHjF7lID/igWplMi8opOiTI+88JurPHuwtBAhC3V0T2WZvBlcykHWjNQzYBA==",
+      "license": "MIT",
+      "dependencies": {
+        "react": "^18.2.0",
+        "react-dom": "^18.2.0"
+      }
+    },
+    "node_modules/universalify": {
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz",
+      "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==",
+      "license": "MIT",
+      "engines": {
+        "node": ">= 10.0.0"
+      }
+    }
+  }
+}

package/examples/checkout-extension/package.json

@@ -5,7 +5,7 @@
   "main": "index.js",
   "dependencies": {
     "fs-extra": "11.1.1",
-    "@shoplazza/extension-ui": "2.0.8"
+    "shoplazza-extension-ui": "1.0.0"
   },
   "devDependencies": {},
   "scripts": {

package/lib/checkout/api.js

@@ -39,11 +39,20 @@ request.interceptors.request.use((config) => {
   return config;
 });
 
+const handleResponseError = (response)=>{
+  if (response.data?.status === 3 && response.data?.message === 'INVALID_ARGUMENT') {
+    throw `Invalid argument at ${response.config.url}`;
+  }else if(response.data?.status === 13 && response.data?.message === 'INTERNAL_ERROR'){
+    throw `Internal error at ${response.config.url}`;
+  }
+}
+
 request.interceptors.response.use(
   (response) => {
     if (isDebug()) {
       console.log(`\n<== ${response.status}: ${response.config.url}`);
     }
+    handleResponseError(response);
     return response;
   },
   (error) => {
@@ -151,6 +160,10 @@ module.exports = {
         ...data
       }
     };
-    return request({ url: PREVIEW_URL, method: 'POST', data });
+    const res = await request({ url: PREVIEW_URL, method: 'POST', data });
+    if (res.data?.status === 14 && res.data?.message === 'ITEM_UNAVAILABLE') {
+      throw 'Failed to generate a preview URL because your store currently has no available items.';
+    }
+    return res;
   }
 };

package/lib/checkout/build.js

@@ -22,8 +22,7 @@ async function viteBuild(command) {
     });
     await build(viteConfig(pageEntry));
   } catch (err) {
-    consoleError('build error: ', err);
-    throw 'build_error';
+    throw 'build_error: ' + err;
   }
 }
 

package/lib/checkout/deploy.js

@@ -41,7 +41,7 @@ async function deployExtension(extensionInfo) {
     {
       type: 'confirm',
       name: 'confirm',
-      message: 'Are you sure you want to deploy?',
+      message: 'Are you sure you want to deploy?(After deployed, all users will be able to see this extension in the store.)',
       default: false
     }
   ]);

package/lib/checkout/index.js

@@ -22,7 +22,7 @@ function makeCheckoutCommand(_program) {
   program
     .command('list')
     .description('fetch extension list.')
-    .option('-i, --id <token>', 'extension id')
+    .option('-a, --all', 'show all extensions')
     .action(require('./pull'));
 
   program

package/lib/checkout/pull.js

@@ -4,7 +4,18 @@ const { verifyConfig } = require('./verify');
 module.exports = async (commands = {}) => {
   try {
     await verifyConfig(commands);
-    const res = await api.getExtension();
-    console.log(res.data?.extension_lists);
-  } catch (err) {}
+    let data;
+    if (!commands.all) {
+      data = {
+        status: 'published'
+      };
+    }
+    const res = await api.getExtensionList(data);
+    const extensionList = res.data?.data?.extensions || [];
+    extensionList.forEach((extension) => {
+      console.log(`${extension.name || extension.extension_id}(${extension.publish_status}/${extension.extension_id})`);
+    });
+  } catch (error) {
+    error.response ? consoleError(`Error: ${error.response.status}-${error.response.config.url}`) : consoleError(error);
+  }
 };

package/lib/checkout/push.js

@@ -22,13 +22,13 @@ module.exports = async () => {
     const extensionInfo = await initSelectedExtensionInfo();
     consoleBlue('Starting to build:');
     const composeCommands = {
-      id: extensionInfo.name
+      id: extensionInfo.name || extensionInfo.extension_id
     }; // 兼容旧代码处理
     await viteBuild(composeCommands);
     consoleBlue('Starting to upload:');
     await uploadOSS(composeCommands);
     consoleBlue('Starting to push:');
-    await pushExtension(composeCommands);
+    await pushExtension(composeCommands, extensionInfo);
   } catch (error) {
     error.response ? consoleError(`Error: ${error.response.status}-${error.response.config.url}`) : consoleError(error);
   }
@@ -63,21 +63,23 @@ async function uploadOSS(command) {
  * 发布
  * @returns
  */
-async function pushExtension(command) {
+async function pushExtension(command, extraInfo) {
   const info = getExtensionInfo(command.id);
   const load = loading(`start push the extension ${info.id}.`).start();
   try {
     const config = getExtensionConfig(command.id);
+    // 兼容低版本extension配置文件
     const data = {
       resource_url: `https://cn.static.shoplazza.com/chick-extension/${info.distName}`,
       version: config.version,
       scope: '',
-      template_name: config.templateName,
-      theme_name: config.themeName,
-      name: config.extensionName,
-      description: config.extensionDescription
+      template_name: config.templateName || config.template_name,
+      theme_name: config.themeName || config.theme_name,
+      name: config.extensionName || config.extensionId,
+      description: config.extensionDescription || '',
+      extends_fields: JSON.stringify(config)
     };
-    const isFirstPush = !config.extensionId; // 非首次推送
+    const isFirstPush = !extraInfo.extension_id; // 非首次推送
     if (!isFirstPush) {
       data.extension_id = config.extensionId;
     }
@@ -88,27 +90,31 @@ async function pushExtension(command) {
     if (isFirstPush) {
       setExtensionConfig(command.id, {
         ...config,
-        extensionId: extensionInfo.extension_id
+        extensionId: extensionInfo.extension_id,
+        extensionName: extensionInfo.name,
       });
     }
 
+    load.stop();
+    consoleSuccess('Successfully pushed the extension.');
     // 预览
-    const resp = await api.previewExtension({
-      extension_id: extensionInfo.extension_id,
-      id: extensionInfo.id
-    });
-    const checkoutUrl = resp.data?.data?.checkout_url;
-    const { store: baseUrl } = getProjectConfig();
-    const url = new URL(checkoutUrl, baseUrl);
-    url.searchParams.append('step', 'contact_information');
+    try {
+      const resp = await api.previewExtension({
+        extension_id: extensionInfo.extension_id,
+        id: extensionInfo.id
+      });
+      const checkoutUrl = resp.data?.data?.checkout_url;
+      const { store: baseUrl } = getProjectConfig();
+      const url = new URL(checkoutUrl, baseUrl);
+      url.searchParams.append('step', 'contact_information');
+      consoleBlue(`Your extension's preview URL: ${url.toString()}`);
+    } catch (error) {
+      consoleError(error);
+    }
 
-    consoleSuccess('\nSuccessfully pushed the extension.');
-    consoleBlue(`Your extension's preview URL: ${url.toString()}`);
   } catch (err) {
-    consoleError('\n Failed to push the extension: ', err);
-    throw 'push_failed';
-  } finally {
     load.stop();
+    throw '\nFailed to push the extension: ' + err;
   }
 }
 

package/lib/checkout/template/extensions/extension-template/src/index.js

@@ -1,4 +1,4 @@
-import { extend } from '@shoplazza/extension-ui';
+import { extend } from 'shoplazza-extension-ui';
 import index from './index.html';
 
 function App() {

package/lib/checkout/template/package.json

@@ -5,7 +5,7 @@
   "main": "index.js",
   "dependencies": {
     "fs-extra": "11.1.1",
-    "@shoplazza/extension-ui": "2.0.8"
+    "shoplazza-extension-ui": "1.0.0"
   },
   "devDependencies": {},
   "scripts": {

package/lib/checkout/undeploy.js

@@ -27,13 +27,13 @@ async function undeployExtension(extensionInfo) {
     {
       type: 'confirm',
       name: 'confirm',
-      message: 'Are you sure you want to undeploy?',
+      message: 'Are you sure you want to undeploy?(After undeployed, all users will not be able to see this extension in the store.)',
       default: false
     }
   ]);
   if (confirm) {
     await api.undeployExtension({ extension_id: extensionInfo.extension_id });
-    consoleSuccess(`Successfully undeployed the extension '${extensionInfo.name}'.`);
+    consoleSuccess(`Successfully undeployed the extension '${extensionInfo.name || extensionInfo.extension_id}'.`);
   } else {
     consoleBlue('Undeploy cancelled');
   }

package/lib/checkout/util.js

@@ -39,8 +39,7 @@ function getExtensionInfo(extensionId) {
   } else if (extensionId) {
     const extensionPath = path.join(cwd, !cwd.includes('/extensions') ? 'extensions' : '', extensionId);
     if (!fs.existsSync(extensionPath)) {
-      consoleError(`The extension '${extensionId}' does not exist.`);
-      throw `The extension '${extensionId}' does not exist.`;
+      throw `The extension '${extensionId}' does not exist in your local project.`;
     }
 
     result = {
@@ -120,7 +119,7 @@ function copyDir(srcDir, destDir) {
  */
 async function useSelectExtensionMode(extensionList = [], type = 'push') {
   const choices = extensionList.map((item, index) => ({
-    name: (type === 'push' && index === 0) ? item.name : `${item.name}(${item.extension_id})`,
+    name: (type === 'push' && index === 0) ? item.name : `${item.name || item.extension_id}(${item.extension_id})`,
     value: item.extension_id
   }))
   if (!choices.length) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shoplazza-cli",
-  "version": "0.1.8",
+  "version": "1.0.3",
   "description": "",
   "main": "bin/shoplazza",
   "engines": {
@@ -13,10 +13,6 @@
     "prettier": "prettier --write ./lib",
     "test": "jest --runInBand --forceExit"
   },
-  "repository": {
-    "type": "git",
-    "url": "git@gitlab.shoplazza.site:shoplaza/frontend/openapi/shoplazza-cli.git"
-  },
   "keywords": [],
   "author": "",
   "license": "ISC",
@@ -28,7 +24,6 @@
   "dependencies": {
     "@sentry/node": "^6.19.7",
     "@sentry/tracing": "^6.19.7",
-    "@shoplazza/extension-ui": "^1.0.0",
     "adm-zip": "^0.5.9",
     "ali-oss": "^6.17.1",
     "archiver": "^5.3.1",