shoplazza-cli 1.0.7-beta.4 → 1.0.8

package/README.md

@@ -56,9 +56,9 @@ You  can use Shoplazza CLI  to develop checkout, customized checkout page as you
 #### Step 1: 创建一个项目模板
 
 创建过程会要求你输入店铺地址和token，token可以在后台中应用->管理私有应用->创建应用 获得。创建过程还要求你输入一个extension名字，一个项目下支持存在多个extension，这是为了方便管理，它们互不影响。
-```
+```bash
 shoplazza checkout create
-// 安装依赖
+# 安装依赖
 npm i
 ```
 
@@ -164,6 +164,87 @@ $ shoplazza theme list
 
 > You might want to use a theme's ID to pull, push, publish, or delete a theme using Shoplazza CLI.
 
+
+
+## Theme Extension Develop
+
+### Overview
+
+Theme Extension is a method provided by Shoplazza for extending and customizing themes. Developers can use Theme Extensions to enhance and tailor theme pages.
+
+### Create an Extension
+
+```bash
+shoplazza te create  
+```
+
+When creating a new Theme Extension, you will be prompted to choose between two types: **Basic Extension** and **Embed Extension**.
+
+- **Basic Extension**: Allows modifying insertion positions via the theme editor.
+- **Embed Extension**: Insertion positions are hard-coded within the Extension.
+
+### Start Development
+
+```bash
+cd your-project  # Navigate to the project directory
+shoplazza te serve  
+```
+
+Since the Extension is displayed on theme pages, so you need to select a theme for preview. A preview link will be provided after selection.
+
+- **First link**: Redirects to the theme editor. You can add the Extension to theme pages here. After adding, save the changes to preview on the client side.
+- **Second link**: Redirects to the storefront preview page. After adding the Extension via the editor, any local code updates will take effect upon refreshing the storefront page.
+
+### Build for Production
+
+```bash
+shoplazza te build  
+```
+
+Generates a deployable production build from the current project code. Multiple builds can be created, and one can be selected during deployment.
+
+### Deploy an Extension
+
+To deploy an Extension to your store:
+
+```bash
+shoplazza te deploy  
+```
+
+Once deployed, the Extension will be live in the store.
+
+### Connect Extension to an APP
+
+An APP is the primary extension method of Shoplazza platform. A Theme Extension is part of an APP, and one APP can connect multiple Theme Extensions. To conect your Extension to an APP:
+
+```bash
+shoplazza te connect
+```
+
+You will be prompted to enter the APP's `client_id` and `client_secret`, which can be obtained from the Shoplazza Partner Dashboard.
+
+### Release an Extension
+To update the Extension version connected to your app, run the release command:
+
+```bash
+shoplazza te release  
+```
+
+The release will be based on the current production version of your store. Once published, the changes will take effect for **all stores that have installed your app**.
+
+### CLI Command Guide
+
+|                Command                |                  Description                   |
+| :-----------------------------------: | :--------------------------------------------: |
+|         `shoplazza te create`         |      Create a new Theme Extension project      |
+|         `shoplazza te serve`          |        Start a local development server        |
+|         `shoplazza te build`          |  Build a production version of the Extension   |
+|        `shoplazza te versions`        |  View production version list of an Extension  |
+|          `shoplazza te list`          |      List private Extensions in the store      |
+|         `shoplazza te deploy`         | Deploy a production build to the current store |
+| `shoplazza te connect <extension-id>` |          Bind an Extension to an APP           |
+|        `shoplazza te release`         |     Publish an Extension to its bound APP      |
+
 ## Core commands
 
 ### help

package/lib/app/commands/build.js

@@ -60,7 +60,7 @@ async function usePrompt(extensionId) {
     console.log(
       chalk.cyanBright(`\n🔍 Latest version: `) +
         chalk.yellow(`${latestVersion.version} `) +
-        chalk.white(`(${latestVersion.description})`) +
+        chalk.white(`(${latestVersion.exts})`) +
         chalk.gray(` [Released on: ${latestVersion.created_at}]`)
     );
   }

package/lib/app/commands/create.js

@@ -26,6 +26,10 @@ async function usePrompt() {
         if (!projectName.trim()) {
           return 'Project name cannot be empty';
         }
+        // 禁止包含空格
+        if (projectName.includes(' ')) {
+          return 'Project name cannot contain spaces';
+        }
         return true;
       }
     }

package/lib/app/template/basic-app/README.md

@@ -1,22 +1,22 @@
 # Theme Basic App
 
-## 概览
+## Overview
 
-一个基础的主题插件项目
+Basic Extension (a card that allows store owners to decide where to add it)
 
-## 安装
+## Installation
 
-首先，确保您安装了“Shoplazza CLI”。如果没有，您可以使用以下命令全局安装它：
+First, ensure you have "Shoplazza CLI" installed. If not, you can install it globally using the following command:
 
 ```bash
 npm install -g shoplazza-cli
 ```
 
-## 可用的脚本
+## Available Scripts
 
 ### `create`
 
-创建主题插件项目模版
+Create a theme Extension project
 
 ```bash
 shoplazza te create
@@ -24,17 +24,17 @@ shoplazza te create
 
 ---
 
-进入项目目录后，即可使用以下命令：
+After entering the project directory, you can use the following commands:
 
 ### `start`
 
-启动开发模式
+Start development mode
 
 ```bash
 npm start
 ```
 
-或者
+or
 
 ```bash
 shoplazza te serve
@@ -42,13 +42,13 @@ shoplazza te serve
 
 ### `build`
 
-基于当前的草稿生成对应正式版本的主题插件
+Build a production version of the current Extension
 
 ```bash
 npm run build
 ```
 
-或者
+or
 
 ```bash
 shoplazza te build
@@ -56,13 +56,13 @@ shoplazza te build
 
 ### `deploy`
 
-部署正式版本的主题插件（部署后插件在店铺的主题编辑器的app列表中可见）
+Deploy a production version of an Extension to the current store
 
 ```bash
 npm run deploy
 ```
 
-或者
+or
 
 ```bash
 shoplazza te deploy
@@ -70,13 +70,13 @@ shoplazza te deploy
 
 ### `versions`
 
-查询主题插件的历史正式版本列表
+View the production version list of an Extension
 
 ```bash
 npm run versions
 ```
 
-或者
+or
 
 ```bash
 shoplazza te versions
@@ -84,15 +84,42 @@ shoplazza te versions
 
 ### `list`
 
-查询店铺的私有主题插件列表
+Query the list of private Extensions in the store
 
 ```bash
 npm run list
 ```
 
-或者
+or
 
 ```bash
 shoplazza te list
 ```
 
+### `connect`
+
+Bind an Extension to a specific APP
+
+```bash
+npm run connect
+```
+
+or
+
+```bash
+shoplazza te connect
+```
+
+### `release`
+
+Release a production version of an Extension to the bound APP
+
+```bash
+npm run release
+```
+
+or
+
+```bash
+shoplazza te release
+```

package/lib/app/template/basic-app/package.json

@@ -8,7 +8,9 @@
     "build": "shoplazza te build",
     "deploy": "shoplazza te deploy",
     "versions": "shoplazza te versions",
-    "list": "shoplazza te list"
+    "list": "shoplazza te list",
+    "connect": "shoplazza te connect",
+    "release": "shoplazza te release"
   },
   "keywords": [],
   "author": "",

package/lib/app/template/embed-app/README.md

@@ -1,22 +1,22 @@
-# Theme Embed App
+# Theme Embed App  
 
-## 概览
+## Overview  
 
-一个 embed 的主题插件项目
+Embed Extension (a card that does not require manual addition)  
 
-## 安装
+## Installation
 
-首先，确保您安装了“Shoplazza CLI”。如果没有，您可以使用以下命令全局安装它：
+First, ensure you have "Shoplazza CLI" installed. If not, you can install it globally using the following command:
 
 ```bash
 npm install -g shoplazza-cli
 ```
 
-## 可用的脚本
+## Available Scripts
 
 ### `create`
 
-创建主题插件项目模版
+Create a theme Extension project
 
 ```bash
 shoplazza te create
@@ -24,17 +24,17 @@ shoplazza te create
 
 ---
 
-进入项目目录后，即可使用以下命令：
+After entering the project directory, you can use the following commands:
 
 ### `start`
 
-启动开发模式
+Start development mode
 
 ```bash
 npm start
 ```
 
-或者
+or
 
 ```bash
 shoplazza te serve
@@ -42,13 +42,13 @@ shoplazza te serve
 
 ### `build`
 
-基于当前的草稿生成对应正式版本的主题插件
+Build a production version of the current Extension
 
 ```bash
 npm run build
 ```
 
-或者
+or
 
 ```bash
 shoplazza te build
@@ -56,13 +56,13 @@ shoplazza te build
 
 ### `deploy`
 
-部署正式版本的主题插件
+Deploy a production version of an Extension to the current store
 
 ```bash
 npm run deploy
 ```
 
-或者
+or
 
 ```bash
 shoplazza te deploy
@@ -70,13 +70,13 @@ shoplazza te deploy
 
 ### `versions`
 
-查询主题插件的历史正式版本列表
+View the production version list of an Extension
 
 ```bash
 npm run versions
 ```
 
-或者
+or
 
 ```bash
 shoplazza te versions
@@ -84,14 +84,42 @@ shoplazza te versions
 
 ### `list`
 
-查询店铺的私有主题插件列表
+Query the list of private Extensions in the store
 
 ```bash
 npm run list
 ```
 
-或者
+or
 
 ```bash
 shoplazza te list
 ```
+
+### `connect`
+
+Bind an Extension to a specific APP
+
+```bash
+npm run connect
+```
+
+or
+
+```bash
+shoplazza te connect
+```
+
+### `release`
+
+Release a production version of an Extension to the bound APP
+
+```bash
+npm run release
+```
+
+or
+
+```bash
+shoplazza te release
+```

package/lib/app/template/embed-app/package.json

@@ -8,7 +8,9 @@
     "build": "shoplazza te build",
     "deploy": "shoplazza te deploy",
     "versions": "shoplazza te versions",
-    "list": "shoplazza te list"
+    "list": "shoplazza te list",
+    "connect": "shoplazza te connect",
+    "release": "shoplazza te release"
   },
   "keywords": [],
   "author": "",

package/lib/checkout/pull.js

@@ -1,5 +1,6 @@
 const api = require('./api');
 const { verifyConfig } = require('./verify');
+const { consoleError } = require('../utils/console');
 
 module.exports = async (commands = {}) => {
   try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shoplazza-cli",
-  "version": "1.0.7-beta.4",
+  "version": "1.0.8",
   "description": "",
   "main": "bin/shoplazza",
   "engines": {