shoplazza-cli 0.0.10 → 0.1.8

package/lib/checkout/dev/index.js

@@ -0,0 +1,142 @@
+const inquirer = require('inquirer');
+const {
+  getExtensionPathById,
+  getExtensionInfo,
+  copy,
+  getDistPath,
+  getExtensionsPath,
+  getExtensionConfig
+} = require('../util');
+const { cwd } = require('../config');
+const path = require('path');
+const chokidar = require('chokidar');
+const fs = require('fs');
+const { viteBuild } = require('../build');
+const { consoleError, consoleBlue, consoleSuccess } = require('../console');
+
+async function buildExtension(id) {
+  return viteBuild({ id })
+    .catch(consoleError)
+    .then(() => {
+      const { distName } = getExtensionInfo(id);
+      return distName;
+    });
+}
+
+let webSocket = undefined;
+
+function handleWsConnection(ws) {
+  webSocket = ws;
+  ws.on('error', console.error);
+  ws.on('message', function message(data) {
+    console.log(`Received message ${data} from user `);
+  });
+
+  const extensionList = [];
+  fs.readdirSync(getExtensionsPath()).forEach((ext) => {
+    extensionList.push(generateExtensionData(ext));
+  });
+  ws.send(JSON.stringify({ event: 'init', data: extensionList }));
+
+}
+
+async function createWsServer(httpServer) {
+  const { WebSocketServer } = require('ws');
+  const wss = new WebSocketServer({ noServer: true });
+  wss.on('connection', handleWsConnection);
+
+  httpServer.on('upgrade', function upgrade(request, socket, head) {
+    wss.handleUpgrade(request, socket, head, function done(ws) {
+      wss.emit('connection', ws, request);
+    });
+  });
+  return wss;
+}
+
+function createServer(dir) {
+  const connect = require('connect');
+  const http = require('http');
+  const app = connect();
+
+  const serveStatic = require('serve-static');
+  app.use(
+    serveStatic(dir, {
+      setHeaders: function (res) {
+        res.setHeader('Access-Control-Allow-Origin', '*');
+        res.setHeader('Access-Control-Allow-Methods', 'GET');
+        res.setHeader('Access-Control-Allow-Headers', 'Content-Type');
+      }
+    })
+  );
+  const httpServer = http.createServer(app);
+
+  return httpServer;
+}
+
+function generateExtensionData(id) {
+  const info = getExtensionInfo(id);
+  const config = getExtensionConfig(id);
+  const data = {
+    extensionId: info.id,
+    resourceUrl: `http://localhost:8888/${info.distName}`,
+    status: 'draft',
+    version: config.version,
+    fields: JSON.stringify(config)
+  };
+  return data;
+}
+
+async function startDev() {
+  if (fs.existsSync(getDistPath())) {
+    fs.rmdirSync(getDistPath(), { recursive: true });
+  }
+
+  const extensionPath = path.resolve(cwd, './extensions');
+  const files = fs.readdirSync(extensionPath);
+  const choices = files.filter((file) => {
+    return fs.statSync(path.resolve(extensionPath, file)).isDirectory();
+  });
+  const { extensionNameList } = await inquirer.prompt([
+    {
+      type: 'checkbox',
+      name: 'extensionNameList',
+      message: 'Please select one or more extensions to develop:',
+      prefix: '*',
+      loop: false,
+      choices,
+      validate(answer) {
+        if (answer.length === 0) {
+          return 'You must choose at least one extension.';
+        }
+        return true;
+      },
+    }
+  ]);
+
+  // build
+  const willBuildExts = extensionNameList;
+  await Promise.all(willBuildExts.map((id) => buildExtension(id)));
+
+  // 复制index.js文件
+  copy(path.join(__dirname, 'client.js'), path.join(getDistPath(), 'index.js'));
+
+  // 监听文件改变
+  chokidar.watch(getExtensionsPath()).on('change', async (event) => {
+    const id = event.split('extensions/').pop().split('/').shift();
+    if (id) {
+      consoleBlue(`update extension: ${id}`);
+      await buildExtension(id);
+      webSocket && webSocket.send(JSON.stringify({ event: 'update', data: generateExtensionData(id) }));
+    }
+  });
+
+  // 启动服务
+  const httpServer = createServer(getDistPath());
+  createWsServer(httpServer, willBuildExts);
+  httpServer.listen(8888);
+  consoleSuccess('started server on url: http://localhost:8888/index.js');
+}
+
+module.exports = {
+  startDev
+};

package/lib/checkout/fields.js

@@ -0,0 +1,29 @@
+const api = require('./api');
+const { consoleError } = require('./console');
+const { verifyConfig } = require('./verify');
+const { getExtensionInfo, getExtensionConfig } = require('./util');
+
+async function updateConfig(commands = {}) {
+  await verifyConfig(commands);
+  const info = getExtensionInfo(commands.id);
+  const config = getExtensionConfig(commands.id);
+  const data = {
+    extension_id: info.id,
+    fields: JSON.stringify(config),
+    version: config.version
+  };
+  try {
+    if (commands.update) {
+      await api.updateFields(data);
+    } else {
+      await api.pushFields(data);
+    }
+  } catch (err) {
+    consoleError('update config fail.');
+    throw 'update_fields_error';
+  }
+}
+
+module.exports = {
+  updateConfig
+};

package/lib/checkout/index.js

@@ -0,0 +1,63 @@
+function makeCheckoutCommand(_program) {
+  const program = _program.command('checkout').description('Shoplazza checkout cli');
+
+  program.command('create').description('create a extension project').action(require('./create').createProject);
+
+  program.command('extension').description('create a new  extension').action(require('./create').createExtension);
+
+  program
+    .command('build')
+    .description('Some commands related to the build')
+    .option('-i, --id <token>', 'extension id (option)')
+    .option('-d, --debug', 'debug mode')
+    .action(require('./build').cliBuild);
+
+  program
+    .command('config')
+    .description('update config')
+    .option('-i, --id <token>', 'extension id')
+    .option('-u --update', 'is update extension?')
+    .action(require('./fields').updateConfig);
+
+  program
+    .command('list')
+    .description('fetch extension list.')
+    .option('-i, --id <token>', 'extension id')
+    .action(require('./pull'));
+
+  program
+    .command('delete')
+    .description('delete extension')
+    .option('-i, --id <token>', 'extension id')
+    .action(require('./delete'));
+
+  program
+    .command('dev')
+    .description('dev mode')
+    .option('-i, --id <token>', 'extension id')
+    .action(require('./dev').startDev);
+
+  program
+    .command('preview')
+    .description('preview extension')
+    .action(require('./preview'));
+
+  program
+    .command('push')
+    .description('push extension.')
+    .action(require('./push'));
+
+  program
+    .command('deploy')
+    .description('deploy extension')
+    .action(require('./deploy'));
+
+  program
+    .command('undeploy')
+    .description('undeploy extension')
+    .action(require('./undeploy'));
+}
+
+module.exports = {
+  makeCheckoutCommand
+};

package/lib/checkout/preview.js

@@ -0,0 +1,52 @@
+const inquirer = require('inquirer');
+const api = require('./api');
+const { verifyConfig } = require('./verify');
+const { useSelectExtensionMode, getProjectConfig } = require('./util');
+const { consoleSuccess, consoleError } = require('./console');
+
+module.exports = async () => {
+  try {
+    await verifyConfig();
+    const extensionInfo = await initSelectedExtensionInfo();
+    await previewExtension(extensionInfo);
+  } catch (error) {
+    error.response ? consoleError(`Error: ${error.response.status}-${error.response.config.url}`) : consoleError(error);
+  }
+};
+
+async function initSelectedExtensionInfo() {
+  const res = await api.getExtensionList();
+  const extensionList = res.data?.data?.extensions || [];
+  return useSelectExtensionMode(extensionList, 'preview');
+}
+
+async function previewExtension(extensionInfo) {
+  const resp = await api.getVersionList({
+    extension_id: extensionInfo.extension_id
+  });
+  const versionList = resp.data?.data?.extensions || [];
+  const choices = versionList.map((item) => ({
+    name: `v${item.version}${item.publish_status === 'published' ? '(Published)' : ''}`,
+    value: item.id
+  }));
+  const { versionId } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'versionId',
+      message: `Please select a version`,
+      prefix: '*',
+      loop: false,
+      choices
+    }
+  ]);
+  const versionInfo = versionList.find((item) => item.id === versionId);
+  const res = await api.previewExtension({
+    extension_id: versionInfo.extension_id,
+    id: versionInfo.id
+  });
+  const checkoutUrl = res.data?.data?.checkout_url;
+  const { store: baseUrl } = getProjectConfig();
+  const url = new URL(checkoutUrl, baseUrl);
+  url.searchParams.append('step', 'contact_information');
+  consoleSuccess(`Your extension's preview URL: ${url.toString()}`);
+}

package/lib/checkout/pull.js

@@ -0,0 +1,10 @@
+const api = require('./api');
+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) {}
+};

package/lib/checkout/push.js

@@ -0,0 +1,140 @@
+const fs = require('fs');
+const inquirer = require('inquirer');
+const api = require('./api');
+const loading = require('loading-cli');
+const {
+  getExtensionInfo,
+  getExtensionConfig,
+  getDistPath,
+  useSelectExtensionMode,
+  setExtensionConfig,
+  checkLocalExtension,
+  getProjectConfig
+} = require('./util');
+const fsExtra = require('fs-extra');
+const { consoleBlue, consoleSuccess, consoleError, consoleWarn } = require('./console');
+const { viteBuild } = require('./build');
+const { verifyConfig } = require('./verify');
+
+module.exports = async () => {
+  try {
+    await verifyConfig();
+    const extensionInfo = await initSelectedExtensionInfo();
+    consoleBlue('Starting to build:');
+    const composeCommands = {
+      id: extensionInfo.name
+    }; // 兼容旧代码处理
+    await viteBuild(composeCommands);
+    consoleBlue('Starting to upload:');
+    await uploadOSS(composeCommands);
+    consoleBlue('Starting to push:');
+    await pushExtension(composeCommands);
+  } catch (error) {
+    error.response ? consoleError(`Error: ${error.response.status}-${error.response.config.url}`) : consoleError(error);
+  }
+};
+
+/**
+ * 上传至oss
+ */
+async function uploadOSS(command) {
+  const info = getExtensionInfo(command.id);
+  const dir = getDistPath();
+  if (!fs.existsSync(dir)) {
+    consoleError('The dist directory does not exist.');
+    throw 'not_exist_dist';
+  }
+  const files = fsExtra.readdirSync(dir).filter((name) => name.includes(info.id));
+  try {
+    await api.uploadDir(dir, files);
+  } catch (error) {
+    if (error.response?.data.includes('<Code>FileAlreadyExists</Code>')) {
+      consoleWarn('The current file already exists, not need to upload.');
+      return;
+    } else {
+      consoleError('Failed to upload to OSS:', error);
+      throw 'upload_failed';
+    }
+  }
+  consoleSuccess('Successfully uploaded to OSS.');
+}
+
+/**
+ * 发布
+ * @returns
+ */
+async function pushExtension(command) {
+  const info = getExtensionInfo(command.id);
+  const load = loading(`start push the extension ${info.id}.`).start();
+  try {
+    const config = getExtensionConfig(command.id);
+    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
+    };
+    const isFirstPush = !config.extensionId; // 非首次推送
+    if (!isFirstPush) {
+      data.extension_id = config.extensionId;
+    }
+    const res = await api.pushExtension(data, isFirstPush);
+    const extensionInfo = res.data?.data?.extension || {};
+
+    // 填充本地extensionId
+    if (isFirstPush) {
+      setExtensionConfig(command.id, {
+        ...config,
+        extensionId: extensionInfo.extension_id
+      });
+    }
+
+    // 预览
+    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');
+
+    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();
+  }
+}
+
+/**
+ * 初始化需要push的extension信息
+ */
+async function initSelectedExtensionInfo() {
+  const PUSH_NEW_EXTENSION = 'Push new extension';
+  const res = await api.getExtensionList();
+  const extensionList = res.data?.data.extensions || [];
+  extensionList.unshift({ extension_id: PUSH_NEW_EXTENSION, name: 'Push new extension' });
+  let extensionInfo = await useSelectExtensionMode(extensionList);
+  if (extensionInfo.extension_id === PUSH_NEW_EXTENSION) {
+    const { extensionName } = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'extensionName',
+        message: 'Please enter the extension name:',
+        prefix: '*'
+      }
+    ]);
+    return {
+      name: extensionName
+    };
+  } else {
+    checkLocalExtension(extensionInfo);
+    return extensionInfo;
+  }
+}

package/lib/checkout/template/README.md

@@ -0,0 +1,34 @@
+# Checkout Extension
+## Getting started
+
+1. 安装依赖
+
+    ```
+    npm i
+    ```
+2. 启动本地服务器
+    ```
+    shoplazza checkout dev
+    ```
+
+## lessJS组件库 
+
+当自定义UI比较复杂时可以使用 lessJS组件库 https://lessjs.shoplazza.com/latest/docs/introduction/
+
+lessJS已经被内置，无需引入，开箱即用。
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

package/lib/checkout/template/_gitignore

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

package/lib/checkout/template/extension.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  token: '{token}',
+  store: '{store}'
+};

package/lib/checkout/template/extensions/extension-template/extension.json

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

package/lib/checkout/template/extensions/extension-template/src/content.html

@@ -0,0 +1,3 @@
+<div>
+  <h2>hello world</h2>
+</div>

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

@@ -0,0 +1,5 @@
+<div>
+  import './style.html'
+  import './content.html'
+  import './script.html'
+</div>

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

@@ -0,0 +1,11 @@
+import { extend } from '@shoplazza/extension-ui';
+import index from './index.html';
+
+function App() {
+  return index;
+}
+
+extend({
+  extensionPoint: 'Checkout::Navigate::RenderBefore',
+  component: App()
+});

package/lib/checkout/template/extensions/extension-template/src/script.html

@@ -0,0 +1,3 @@
+<ljs-script layout="logic" type="application/javascript">
+ <!-- js代码 -->
+</ljs-script>

package/lib/checkout/template/extensions/extension-template/src/style.html

@@ -0,0 +1,3 @@
+<style>
+
+</style>

package/lib/checkout/template/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "chick-extension",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "dependencies": {
+    "fs-extra": "11.1.1",
+    "@shoplazza/extension-ui": "2.0.8"
+  },
+  "devDependencies": {},
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}

package/lib/checkout/undeploy.js

@@ -0,0 +1,40 @@
+const api = require('./api');
+const { verifyConfig } = require('./verify');
+const { useSelectExtensionMode } = require('./util');
+const inquirer = require('inquirer');
+const { consoleSuccess, consoleBlue, consoleError } = require('./console');
+
+module.exports = async () => {
+  try {
+    await verifyConfig();
+    const extensionInfo = await initSelectedExtensionInfo();
+    await undeployExtension(extensionInfo);
+  } catch (error) {
+    error.response ? consoleError(`Error: ${error.response.status}-${error.response.config.url}`) : consoleError(error);
+  }
+};
+
+async function initSelectedExtensionInfo() {
+  const res = await api.getExtensionList({
+    status: 'published'
+  });
+  const extensionList = res.data?.data?.extensions || [];
+  return useSelectExtensionMode(extensionList, 'undeploy');
+}
+
+async function undeployExtension(extensionInfo) {
+  const { confirm } = await inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'confirm',
+      message: 'Are you sure you want to undeploy?',
+      default: false
+    }
+  ]);
+  if (confirm) {
+    await api.undeployExtension({ extension_id: extensionInfo.extension_id });
+    consoleSuccess(`Successfully undeployed the extension '${extensionInfo.name}'.`);
+  } else {
+    consoleBlue('Undeploy cancelled');
+  }
+}