shoplazza-cli 0.0.4 → 0.0.6

package/README.md

@@ -9,6 +9,11 @@
 ---
 
 Shoplazza CLI is a cross-platform command line tool that you can use to build Shoplazza themes.
+
+## Node Version
+
+use 14.18.2
+
 ## Features
 
 Shoplazza CLI accelerates your theme development process with the following features:
@@ -22,7 +27,8 @@ Shoplazza CLI accelerates your theme development process with the following feat
 - Work on Linux, macOS, and Windows.
 
 ## Installation [shoplazza-cli](https://www.npmjs.com/package/shoplazza-themekit)
-``` terminal
+
+```terminal
 $ npm install shoplazza-cli -g
 ```
 
@@ -37,150 +43,235 @@ Before you start using Shoplazza CLI to develop themes, make sure that you do th
 - Make sure that you're connected to the internet. Most Shoplazza CLI commands need an internet connection to run.
 
 ## Getting started
+
 ### Authenticate
-``` terminal
+
+```terminal
 $ shoplazza login --store developer.myshoplaza.com
 ```
+
 > In your browser window, log into the account that's attached to the store that you want to use for development.
 
 ### Create a new theme
-``` terminal
+
+```terminal
 $ shoplazza theme init
 ```
+
 > Use `shoplazza theme init` to create a new theme on your local machine. This command clones a Git repository to your local machine to use as the starting point for building a theme.
 
 ### Connect to existing theme
-``` terminal
+
+```terminal
 $ shoplazza theme pull
 ```
+
 > Pull the theme onto your local machine using `shoplazza theme pull`. You're prompted to select a theme from the list of themes on the store.
 
 ### Preview, test, and share your theme
-``` terminal
+
+```terminal
 $ shoplazza theme serve
 ```
+
 > After you create or navigate to your theme, you can run `shoplazza theme serve` to interact with the theme in a browser.
 
 ### Push your theme to your store
-``` terminal
+
+```terminal
 $ shoplazza theme push
 ```
+
 > Use `shoplazza theme push` to upload your local theme files to Shoplazza, overwriting the remote versions.
 
 ### Publish your theme
-``` terminal
+
+```terminal
 $ shoplazza theme publish
 ```
+
 > Use `shoplazza theme publish` to select and publish an unpublished theme from your theme library. If you want to publish your local theme, then you need to run `shoplazza theme push` first.
 
 ### Find your theme ID
-``` terminal
+
+```terminal
 $ shoplazza theme list
 ```
-> You might want to use a theme's ID to pull, push, publish, or delete a theme using Shoplazza CLI.
 
+> You might want to use a theme's ID to pull, push, publish, or delete a theme using Shoplazza CLI.
 
 ## Core commands
 
 ### help
-``` terminal
+
+```terminal
 $ shoplazza help
 ```
+
 > Lists the available commands and describes what they do.
 
 ### login
-``` terminal
+
+```terminal
 $ shoplazza login --store developer.myshoplaza.com
+
+$ shoplazza login --partner
 ```
-> Authenticates and logs you into the specified store with Shoplazza CLI.
+
+> --store: Authenticates and logs you into the specified store with Shoplazza CLI.
+> --partner: Authenticates and logs you into the partner with Shoplazza CLI.
 
 ### logout
-``` terminal
+
+```terminal
 $ shoplazza logout
+
+$ shoplazza logout --partner
 ```
-> Logs you out of the Shoplazza account and store, the logout command clears credentials. You need to reauthenticate the next time that you connect to a store.
+
+> Default to logout your store, logs you out of the Shoplazza account and store, the logout command clears credentials. You need to reauthenticate the next time that you connect to a store.
+> --partner: Clear your partner info, and you need to reauthenticate the next time.
+
 
 ### switch
-``` terminal
+
+```terminal
 $ shoplazza switch --store developer.myshoplaza.com
 ```
+
 > Switches between stores without logging out and logging in again.
 
 ### store
-``` terminal
+
+```terminal
 $ shoplazza store
 ```
+
 > Displays the store that you're currently connected to.
 
 ### version
-``` terminal
+
+```terminal
 $ shoplazza version
 ```
+
 > Displays the version of Shoplazza CLI that you're running.
 
 ## Theme commands
 
 ### init
-``` terminal
+
+```terminal
 $ shoplazza theme init [--name]
 ```
+
 > Clones a Git repository to your local machine to use as the starting point for building a theme.
 
 ### serve
-``` terminal
+
+```terminal
 $ shoplazza theme serve [--theme]
 ```
+
 > Uploads the current theme to the store that you're connected to, and returns the preview link.
 
 ### list
-``` terminal
+
+```terminal
 $ shoplazza theme list
 ```
+
 > Lists the themes in your store, along with their IDs and statuses.
 
 ### pull
-``` terminal
+
+```terminal
 $ shoplazza theme pull [--theme]
 ```
+
 > Retrieves theme files from Shoplazza, if no theme is specified, then you're prompted to select the theme to pull from the list of the themes in your store.
 
 ### push
-``` terminal
+
+```terminal
 $ shoplazza theme push [--theme]
 ```
+
 > Uploads your local theme files to Shoplazza, overwriting the remote theme if specified, if no theme is specified, then you're prompted to select the theme to overwrite from the list of the themes in your store.
 
 ### share
-``` terminal
+
+```terminal
 $ shoplazza theme share
 ```
+
 > Uploads your theme as a new, unpublished theme in your theme library. The command return a preview link that you can share with others.
 
 ### publish
-``` terminal
+
+```terminal
 $ shoplazza theme publish [--theme]
 ```
+
 > Publishes an unpublished theme from your theme library, if no theme ID is specified, then you're prompted to select the theme that you want to publish from the list of themes in your store.
 
 ### package
-``` terminal
+
+```terminal
 $ shoplazza theme package
 ```
+
 > Packages your local theme files into a ZIP file that can be uploaded to Shoplazza. The ZIP file uses the name theme_name-theme_version.zip, based on parameters in your `settings_schema.json` file.
 
 ### delete
-``` terminal
+
+```terminal
 $ shoplazza theme delete [--theme]
 ```
+
 > Deletes a theme from your store, if no theme is specified, then you're prompted to select the theme that you want to delete from the list of themes in your store.
 
+## app
+
+### generate
+
+```terminal
+$ shoplazza app generate extension
+```
+
+> Choose Your app type and download template.
+
+### build
+
+```terminal
+$ shoplazza app build
+```
+
+> Minify css / js files and generate manifest.json and zip.
+
+### deploy
+
+```terminal
+$ shoplazza app deploy extension
+```
+
+> Deploy your zip to oss for publish.
+
+### pupblish
+
+```terminal
+$ shoplazza app publish extension
+```
+
+> Choose your extension version and publish to your store.
 
 ## Theme Directory
 
 You can run certain theme commands, such as shoplazza theme serve, only if the directory you're using matches the default Shoplazza theme directory structure. This structure represents a buildless theme, or a theme that has already gone through any necessary file transformations. If you use build tools to generate theme files, then you might need to run commands from the directory where the generated files are stored.
 
 The default Shoplazza theme directory structure is as follows:
-``` terminal
+
+```terminal
 └── project
     ├── assets
     ├── config

package/bin/shoplazza

@@ -8,6 +8,8 @@ const pkg = require('../package.json');
 const report = require('../lib/report');
 require('../lib/tracing');
 
+const { generateExtension, deployExtension, publishExtension, buildExtension, retry } = require('../lib/app');
+
 Sentry.init({
   dsn: 'https://89964605acaf4db8839f2d5237396d6c@sentry.shoplazza.com/730',
   integrations: [
@@ -32,11 +34,14 @@ program
   .command('login')
   .description('Authenticates and logs you into the specified store with Shoplazza CLI.')
   .option('-s, --store <store>', 'The store domain (Eg: developer.myshoplaza.com)')
+  .option('-p, --partner', 'Log into partner app')
   .action(require('../lib/commands/login').login);
 
 program
   .command('logout')
-  .description('Logs you out of the Shoplazza account.')
+  .description('Logs you out of the Shoplazza account, logs out your store account without any options.')
+  .option('-s, --store', 'Logs out your store account')
+  .option('-p, --partner', 'Logs out your partner account')
   .action(require('../lib/commands/logout'));
 
 program
@@ -104,6 +109,19 @@ theme
   .option('-t, --theme <theme>', 'The ID of the theme that you want to delete.')
   .action(require('../lib/commands/theme/delete'));
 
+const app = program.command('app').description('Shoplazza app extensions cli');
+
+app.command('generate').command('extension').description('Generate your extension').action(generateExtension);
+app.command('deploy').command('extension').description('Deploy your extension to cdn').action(deployExtension);
+app.command('publish').command('extension').description('Publish your extension').action(publishExtension);
+app.command('build').description('Build your extension').action(buildExtension);
+app
+  .command('retry')
+  .description('Retry to do some tasks.')
+  .option('-p, --partner', 'Retry get and choose your partner list.')
+  .option('-a, --app', 'Retry get and choose your app list.')
+  .action(retry);
+
 program.parse(process.argv);
 !program.args.length && program.help();
 

package/lib/app/commands/build.js

@@ -0,0 +1,66 @@
+const chalk = require('chalk');
+const ora = require('ora');
+const fs = require('fs-extra');
+const path = require('path');
+
+const { zipTheme } = require('../../utils');
+const { line, done } = require('../log');
+const { buildThemeAssets } = require('../extensions/theme-app');
+
+const isFileExist = (path) => {
+  return fs.existsSync(path);
+};
+
+const clearManifest = async () => {
+  try {
+    if (isFileExist('./assets-manifest.json') && isFileExist('./assets')) {
+      const mainfest = JSON.parse(fs.readFileSync('./assets-manifest.json', { encoding: 'utf-8' }));
+      await Promise.all(
+        Object.values(mainfest).map((path) => {
+          if (isFileExist(path)) {
+            return fs.unlink(path);
+          }
+          return Promise.resolve(true);
+        })
+      );
+      await fs.unlink('./assets-manifest.json');
+    }
+    return true;
+  } catch (e) {
+    console.log(e);
+  }
+};
+
+const getZipName = () => {
+  return path.basename(process.cwd());
+};
+
+const generateZip = async (name) => {
+  const zipPath = `${process.cwd()}/${name}.zip`;
+  isFileExist(zipPath) && (await fs.unlink(zipPath));
+  zipTheme(process.cwd(), name);
+};
+
+const zipApp = async () => {
+  const spinner = ora(chalk.cyan('Building your app and generate zip package ...')).start();
+  try {
+    const zipName = getZipName();
+    await generateZip(zipName);
+    spinner.succeed(chalk.cyan(`Success to build your app and generate zip package: ${chalk.green(`${zipName}.zip`)}`));
+    return true;
+  } catch (e) {
+    spinner.fail(e.message);
+  }
+};
+
+const build = async () => {
+  line();
+  (await clearManifest()) && (await buildThemeAssets('./assets')) && (await zipApp());
+  done();
+  line();
+};
+
+module.exports = {
+  build,
+  getZipName
+};

package/lib/app/commands/deploy.js

@@ -0,0 +1,213 @@
+const axios = require('axios');
+const ora = require('ora');
+const chalk = require('chalk');
+const fs = require('fs-extra');
+const SparkMD5 = require('spark-md5');
+const FormData = require('form-data');
+const path = require('path');
+
+const { PARNTER_URL } = require('../constants');
+const { getValue, PARTNER_KEYS, getApp, set } = require('../db/partner');
+const { getZipName } = require('./build');
+const { inputVersion } = require('../inquirers/version');
+const { line, done } = require('../log');
+
+const getZipPath = () => {
+  const spinner = ora(chalk.cyan('Finding your built zip ...')).start();
+  try {
+    const zipName = getZipName();
+    const filename = fs.readdirSync(process.cwd()).find((name) => {
+      const extname = path.extname(name).replace('.', '');
+      return extname === 'zip' && name.startsWith(zipName);
+    });
+
+    if (!filename) {
+      throw new Error('not zip');
+    }
+
+    const fileInfo = fs.statSync(`${process.cwd()}/${filename}`);
+
+    spinner.succeed(
+      chalk.cyan(
+        `Success to find your zip: ${chalk.green(`${filename} ${(fileInfo.size / (1024 * 1024)).toFixed(2)}M`)}`
+      )
+    );
+    return path.resolve(process.cwd(), filename);
+  } catch (e) {
+    spinner.fail(chalk.red('Failed to find your zip, be sure you have built app in root dir!'));
+  }
+};
+
+const getBufferAndMd5 = async (filePath) => {
+  const spinner = ora(chalk.cyan('Begin to read zip and generate md5 code ...')).start();
+
+  try {
+    return await new Promise((resolve, reject) => {
+      const spark = new SparkMD5.ArrayBuffer();
+      let buffers = [];
+
+      const rs = fs.createReadStream(filePath, { autoClose: true });
+      rs.on('data', (data) => {
+        buffers.push(data);
+        spark.append(data);
+      });
+
+      rs.on('end', () => {
+        const md5 = spark.end();
+        const completedBuffer = Buffer.concat(buffers);
+        spinner.succeed(chalk.cyan('Success to analyse zip'));
+        resolve([completedBuffer, md5 + '.zip']);
+      });
+
+      rs.on('error', (err) => {
+        reject(err);
+      });
+    });
+  } catch (e) {
+    spinner.fail(chalk.red('Failed to analyse zip, please try again!'));
+  }
+};
+
+const getSign = async () => {
+  const spinner = ora(chalk.cyan('Waiting get file sign ...')).start();
+
+  try {
+    const app = getApp();
+    const partnerId = getValue(PARTNER_KEYS.PARTNER_ID);
+    const sessionId = getValue(PARTNER_KEYS.SESSION_ID);
+
+    const url = `${PARNTER_URL}/api/partner/apps/${app.uid}/theme_extensions/file/sign`;
+    const res = await axios.get(url, {
+      headers: {
+        Cookie: `awesomev2=${sessionId}`,
+        'x-shoplazza-partner-id': partnerId
+      }
+    });
+    spinner.succeed(chalk.cyan('Success to get file sign'));
+    return res.data;
+  } catch (e) {
+    spinner.fail(chalk.red(e.message || e));
+  }
+};
+
+const deployOss = async () => {
+  const path = getZipPath();
+  if (path) {
+    const [buffer, md5] = await getBufferAndMd5(path);
+    const signData = await getSign();
+    if (!signData) {
+      return;
+    }
+
+    const spinner = ora(chalk.cyan('Deploying your zip to cdn ...')).start();
+
+    try {
+      const formData = new FormData();
+      formData.append('policy', signData.policy);
+      formData.append('OSSAccessKeyId', signData.access_id);
+      formData.append('success_action_status', 200);
+      formData.append('signature', signData.sign);
+      formData.append('key', md5);
+      formData.append('file', buffer);
+
+      const url = `https:${signData.write_host}/`;
+      const res = await axios.post(url, formData, {
+        global: true,
+        maxContentLength: 100000000,
+        maxBodyLength: 1000000000
+      });
+
+      if (res.status !== 200) {
+        throw new Error(`${res.status} ${resstatusText}`);
+      }
+      spinner.succeed();
+      return md5;
+    } catch (e) {
+      spinner.fail();
+      console.log(chalk.red(e.message || e));
+    }
+  }
+};
+
+const deployPartner = async () => {
+  const md5 = await deployOss();
+  if (!md5) {
+    return;
+  }
+
+  const spinner = ora(chalk.cyan('Deploying your zip to PARTNER ...')).start();
+  try {
+    const app = getApp();
+    if (!app) {
+      spinner.fail(chalk.red('Please choose your partner first!'));
+      return;
+    }
+
+    const partnerId = getValue(PARTNER_KEYS.PARTNER_ID);
+    const url = `${PARNTER_URL}/api/partner/apps/${app.uid}/theme_extensions`;
+    const res = await axios.put(
+      url,
+      {
+        title: getZipName(),
+        name: getZipName(),
+        file_name: md5
+      },
+      {
+        headers: {
+          cookie: `awesomev2=${getValue(PARTNER_KEYS.SESSION_ID)};`,
+          'x-shoplazza-partner-id': partnerId
+        }
+      }
+    );
+
+    set({ [PARTNER_KEYS.EXTENSION_ID]: res.data.extension_id });
+    spinner.succeed();
+    return true;
+  } catch (e) {
+    spinner.fail();
+    console.log(e.message || e);
+    console.log(chalk.red(JSON.stringify(e.response.data)));
+  }
+};
+
+const createVersion = async (version) => {
+  const spinner = ora(chalk.cyan('Creating your version task ...')).start();
+
+  try {
+    const app = getApp();
+    const extensionId = getValue(PARTNER_KEYS.EXTENSION_ID);
+    const partnerId = getValue(PARTNER_KEYS.PARTNER_ID);
+
+    const url = `${PARNTER_URL}/api/partner/apps/${app.uid}/theme_extensions/${extensionId}/version_tasks`;
+    await axios.post(
+      url,
+      {
+        version
+      },
+      {
+        headers: {
+          cookie: `awesomev2=${getValue(PARTNER_KEYS.SESSION_ID)};`,
+          'x-shoplazza-partner-id': partnerId
+        }
+      }
+    );
+    spinner.succeed();
+    return true;
+  } catch (e) {
+    spinner.fail();
+    console.log(chalk.red(e.message || e));
+    console.log(chalk.red(JSON.stringify(e.response?.data)));
+  }
+};
+
+const deploy = async () => {
+  line();
+  ora(chalk.cyan('Deploy Begin')).succeed();
+  let version;
+  (await deployPartner()) && (version = await inputVersion()) && (await createVersion(version)) && done();
+  line();
+};
+
+module.exports = {
+  deploy
+};

package/lib/app/commands/generate.js

@@ -0,0 +1,50 @@
+const inquirer = require('inquirer');
+const { set, PARTNER_KEYS } = require('../db/partner');
+const { themeAppHandler, checkoutUIHandler } = require('../extensions');
+const { line } = require('../log');
+
+const EXTENSION_TYPES = {
+  CHECKOUT_UI: 'checkout_ui',
+  THEME_APP: 'theme_app'
+};
+
+const generate = async () => {
+  line();
+  const answer = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'extensionType',
+      message: 'Choose your extension type ↓',
+      default: EXTENSION_TYPES.THEME_APP,
+      prefix: '*',
+      choices: [
+        {
+          name: 'Theme App Extension',
+          value: EXTENSION_TYPES.THEME_APP
+        }
+      ]
+    },
+    {
+      type: 'input',
+      name: 'extensionName',
+      message: 'Input your extesion name: ',
+      default: 'my-extension',
+      prefix: '*'
+    }
+  ]);
+  line();
+
+  set({ [PARTNER_KEYS.EXTENSION_TYPE]: answer.extensionType });
+
+  if (answer.extensionType === EXTENSION_TYPES.THEME_APP) {
+    await themeAppHandler(answer.extensionName);
+  } else if (answer.extensionType === EXTENSION_TYPES.CHECKOUT_UI) {
+    await checkoutUIHandler(answer.extensionName);
+  }
+
+  line();
+};
+
+module.exports = {
+  generate
+};

package/lib/app/commands/publish.js

@@ -0,0 +1,52 @@
+const { default: axios } = require('axios');
+const { selectVersion } = require('../inquirers/version');
+const { PARNTER_URL } = require('../constants');
+const { get, getValue, PARTNER_KEYS } = require('../db/partner');
+const ora = require('ora');
+const chalk = require('chalk');
+const { getZipName } = require('./build');
+const { done, line } = require('../log');
+
+const publishVersion = async ({ version, appId, versionId, extensionId }) => {
+  const spinner = ora(chalk.cyan('Waiting publish ...'));
+
+  try {
+    const partnerId = getValue(PARTNER_KEYS.PARTNER_ID);
+    if (!partnerId) {
+      spinner.fail(chalk.red('Please choose a partner first!'));
+      return;
+    }
+
+    const url = `${PARNTER_URL}/api/partner/apps/${appId}/theme_extensions/${extensionId}/publications`;
+    await axios.post(
+      url,
+      {
+        name: getZipName(),
+        version_id: versionId,
+        type: 'enable'
+      },
+      {
+        headers: {
+          cookie: `awesomev2=${getValue(PARTNER_KEYS.SESSION_ID)};`,
+          'x-shoplazza-partner-id': partnerId
+        }
+      }
+    );
+
+    spinner.succeed();
+    return true;
+  } catch (e) {
+    spinner.fail(e.message || e);
+  }
+};
+
+const publish = async () => {
+  const versionData = await selectVersion();
+  await publishVersion(versionData);
+  done();
+  line();
+};
+
+module.exports = {
+  publish
+};