@ordergroove/smi-serve 1.9.4 → 1.9.6

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.9.6](https://github.com/ordergroove/plush-toys/compare/@ordergroove/smi-serve@1.9.5...@ordergroove/smi-serve@1.9.6) (2024-11-13)
+
+**Note:** Version bump only for package @ordergroove/smi-serve
+
+
+
+
+
+## [1.9.5](https://github.com/ordergroove/plush-toys/compare/@ordergroove/smi-serve@1.9.4...@ordergroove/smi-serve@1.9.5) (2024-11-13)
+
+**Note:** Version bump only for package @ordergroove/smi-serve
+
+
+
+
+
 ## [1.9.4](https://github.com/ordergroove/plush-toys/compare/@ordergroove/smi-serve@1.9.3...@ordergroove/smi-serve@1.9.4) (2024-11-11)
 
 **Note:** Version bump only for package @ordergroove/smi-serve

package/README.md

@@ -12,7 +12,7 @@ To initialize the current directory for local Subscription Manager development,
 
 After initialization, you can restart the dev server with `npx @ordergroove/smi-serve`.
 
-When you are ready to push your changes to production, run `npx @ordergroove/smi-serve deploy` to deploy your changes to Ordergroove.
+When you are ready to push your changes, run `npx @ordergroove/smi-serve push-theme` to deploy your changes to Ordergroove. If the theme you're pushing is live, your changes will be published immediately!
 
 ## Configuration file
 
@@ -26,7 +26,7 @@ To see all available commands and flags, run `npx @ordergroove/smi-serve --help`
 
 ### init
 
-Initializes the current directory with the assets from your live Subscription Manager theme and starts a dev server. This only needs to be run when you need to retrieve the latest assets from Ordergroove; otherwise you can start the dev server directly with `npx @ordergroove/smi-serve serve`.
+Initializes the current directory with the assets from your live Subscription Manager theme and starts a dev server. This only needs to be run when you need to retrieve the latest assets from Ordergroove; otherwise you can start the dev server directly with `npx @ordergroove/smi-serve serve`. To pull new assets, use the `pull-theme` command.
 
 ### serve
 
@@ -34,9 +34,13 @@ Starts a development server. This is the default command, so it can also be run
 
 By default it will choose a random available port, but you can customize this with the `--port` flag.
 
-### deploy
+### pull-theme
 
-Publishes your template changes to your live Subscription Manager theme. Before publishing, it will summarize which files have changed and ask for confirmation.
+Presents you with a list of your Subscription Manager themes including your live theme. Selecting a theme will overwrite the files in your present working directory.
+
+### push-theme
+
+Publishes your template changes to your selected Subscription Manager theme. If the theme you're pushing is your live theme, your changes will be published to your live site immediately!
 
 ### select-merchant
 
@@ -52,7 +56,7 @@ Keep in mind that if you use this flag, _every command_ you run must also includ
 
 ### How do I integrate with source control?
 
-Once you run the `init` command, you can initialize the folder as a Git repository with `git init` and push to the source control provider of your choice. When you are ready to deploy the changes, run `npx @ordergroove/smi-serve deploy`.
+Once you run the `init` command, you can initialize the folder as a Git repository with `git init` and push to the source control provider of your choice. When you are ready to deploy the changes, run `npx @ordergroove/smi-serve push-theme`.
 
 Make sure to commit the autogenerated `.gitignore`, which prevents you from committing the `.ogrc.json` file to source control. The `ogrc` file contains authentication tokens and should not be committed.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ordergroove/smi-serve",
-  "version": "1.9.4",
+  "version": "1.9.6",
   "description": "Utility to serve a Subscription Manager template locally",
   "keywords": [],
   "author": "Eugenio Lattanzio <eugenio.lattanzio@ordergroove.com>",
@@ -35,5 +35,5 @@
   "devDependencies": {
     "memfs": "^4.8.2"
   },
-  "gitHead": "b395503cfeafe2043079a72bbb6365150d943280"
+  "gitHead": "c521e348e2da6908ba2e6daab6c6fe204a3953d6"
 }

package/smi-serve.js

@@ -9,11 +9,10 @@ const figures = require('figures');
 
 const { getcwd, getNetFreePort, readRcEnv } = require('./src/utils');
 const { cliCallSelectMerchant } = require('./src/select-merchant');
-const { cliPullTheme } = require('./src/pull-theme');
-const { deploy } = require('./src/deploy');
+const { cliPullTheme, getMerchantThemes } = require('./src/pull-theme');
+const { cliPushTheme } = require('./src/push-theme');
 const { init, DirNotEmpty, OG_RC_FILE } = require('./src/init');
 const { serve } = require('./src/serve');
-const { getMerchantThemes } = require('./src/pull-theme');
 
 function box(text) {
   return `\
@@ -60,7 +59,7 @@ function wrapHandler(fn) {
             ID: ${merchant.public_id}
       Platform: ${merchant.ecommerce_platform}      
            Env: ${args.env}
- .  Live theme: ${liveTheme.name}
+    Live theme: ${liveTheme.name}
 Selected theme: ${merchant.selectedTheme?.name || 'N/A'}\
     `)
       );
@@ -110,11 +109,6 @@ async function program() {
         describe: 'Start the dev server',
         handler: wrapHandler(initOrServe)
       })
-      .command({
-        command: 'deploy',
-        describe: 'Publish your template changes to your live theme',
-        handler: wrapHandler(deploy)
-      })
       .command({
         command: 'select-merchant',
         describe: 'Select a different Ordergroove merchant',
@@ -125,6 +119,11 @@ async function program() {
         describe: 'Pull the theme data for the selected merchant',
         handler: wrapHandler(cliPullTheme)
       })
+      .command({
+        command: 'push-theme',
+        describe: 'Push the theme data for the selected merchant',
+        handler: wrapHandler(cliPushTheme)
+      })
       .option('verbose', {
         alias: 'v',
         type: 'boolean',

package/smi-serve.spec.js

@@ -87,7 +87,6 @@ describe('smi-serve', () => {
           templatesVersion: '0.40.1'
         },
         scripts: {
-          deploy: 'smi-serve deploy',
           start: 'smi-serve'
         }
       },

package/src/init.js

@@ -159,8 +159,7 @@ node_modules/
 
   await updateJsonFile(path.join(args.cwd, 'package.json'), {
     scripts: {
-      start: 'smi-serve',
-      deploy: 'smi-serve deploy'
+      start: 'smi-serve'
     },
     description: `Ordergroove Subscription Manager for ${merchant.name} on ${merchant.ecommerce_platform} platform (${merchant.public_id})}`,
     author: getAuthorNameFromToken(token),

package/src/push-theme.js

@@ -0,0 +1,136 @@
+const fs = require('fs');
+const fetch = require('node-fetch');
+const util = require('util');
+const glob = util.promisify(require('glob'));
+const inquirer = require('inquirer');
+const { getMerchantThemes } = require('./pull-theme');
+const { getValidSettings } = require('./select-merchant');
+const { getRC3Url } = require('./auth');
+const { getcwd, readRcEnv } = require('./utils');
+
+// Function to push theme files to the selected theme
+async function pushTheme(args) {
+  try {
+    // Get the selected merchant and token based on the environment
+    let { token, merchant } = await getValidSettings(args);
+    const env = args.env;
+
+    // Read theme details from .ogrc.json for the selected environment
+    const config = await readRcEnv(args);
+    const { selectedTheme } = config.merchant;
+
+    if (!selectedTheme) {
+      console.error(`No theme selected for environment: ${env}. Please run pull-theme first.`);
+      return;
+    }
+
+    const { live: liveTheme } = await getMerchantThemes(args);
+    const isLiveTheme = liveTheme.id === selectedTheme.id;
+
+    console.log(`Pushing to Theme: ${selectedTheme.name} (ID: ${selectedTheme.id})`);
+
+    if (isLiveTheme) {
+      console.log('THIS IS YOUR LIVE THEME. CHANGES WILL BE PUBLISHED IMMEDIATELY.');
+    }
+
+    const fileList = await getThemeFiles(args);
+
+    const original = await fetchOriginalConfig(args, merchant, token, isLiveTheme);
+
+    const newRequest = buildRequestPayload(isLiveTheme, original, fileList, merchant, selectedTheme);
+
+    // Confirm with the user if they want to proceed
+    const { ok } = args.yes
+      ? { ok: true }
+      : await inquirer.prompt([
+          {
+            type: 'list',
+            name: 'ok',
+            message: 'Do you want to deploy your files to this theme?',
+            choices: [
+              { value: true, name: `Yes` },
+              { value: false, name: 'No' }
+            ]
+          }
+        ]);
+
+    if (!ok) return;
+
+    // Push the new theme files to the API
+    const requestUrl = isLiveTheme
+      ? `${getRC3Url(args)}configs/msi/?${new URLSearchParams([['merchant_public_id', merchant.public_id]])}`
+      : `${getRC3Url(args)}configs/msi/drafts/?${new URLSearchParams([
+          ['merchant_public_id', merchant.public_id],
+          ['main_theme', selectedTheme.id]
+        ])}`;
+
+    const response = await fetch(requestUrl, {
+      method: 'post',
+      headers: {
+        Authorization: `Bearer ${token}`,
+        'Content-Type': 'application/json'
+      },
+      body: JSON.stringify(newRequest)
+    });
+
+    if (response.status === 201) {
+      console.log('Theme files successfully pushed to the selected theme');
+    } else {
+      console.error(`Error pushing theme: ${response.status}`, await response.text());
+    }
+  } catch (error) {
+    console.error('Error pushing theme:', error.message);
+  }
+}
+
+async function fetchOriginalConfig(args, merchant, token, isLiveTheme) {
+  if (!isLiveTheme) return null;
+
+  try {
+    const response = await fetch(
+      `${getRC3Url(args)}configs/msi/?${new URLSearchParams([['merchant_public_id', merchant.public_id]])}`,
+      {
+        headers: { Authorization: `Bearer ${token}` }
+      }
+    );
+
+    if (response.status === 200) {
+      return await response.json().catch(() => ({ configs: {} }));
+    } else {
+      throw new Error(`Error fetching theme: ${response.status}`);
+    }
+  } catch (error) {
+    console.log(error);
+    return null;
+  }
+}
+
+async function cliPushTheme(args) {
+  return await pushTheme(args);
+}
+
+exports.cliPushTheme = cliPushTheme;
+
+async function getThemeFiles(args) {
+  const allowlistDirs = ['views', 'styles', 'scripts', 'locales', 'controls'];
+  const files = await glob(`${getcwd(args)}/+(${allowlistDirs.join('|')})/**/*.*`);
+  return Promise.all(
+    files.map(async file => ({
+      name: file.substring(getcwd(args).length),
+      content: await fs.promises.readFile(file, 'utf8')
+    }))
+  );
+}
+
+function buildRequestPayload(isLiveTheme, original, fileList, merchant, selectedTheme) {
+  if (isLiveTheme) {
+    original.configs.smi.files = fileList;
+    return original;
+  }
+
+  return {
+    configs: { smi: { files: fileList } },
+    merchant_public_id: merchant.public_id,
+    main_theme: selectedTheme.id
+  };
+}

package/src/deploy.js

@@ -1,143 +0,0 @@
-const fs = require('fs');
-const fetch = require('node-fetch');
-const util = require('util');
-const inquirer = require('inquirer');
-const glob = util.promisify(require('glob'));
-const { getRC3Url } = require('./auth');
-const { getcwd, readPackageJson, packageJsonKeys } = require('./utils');
-const { getValidSettings } = require('./select-merchant');
-
-function reportDiffFiles(original, newRequest) {
-  const originalFiles =
-    ((original.configs && original.configs.smi && original.configs.smi.files) || []).reduce(
-      (acc, cur) => ({ ...acc, [cur.name]: cur.content }),
-      {}
-    ) || {};
-
-  const newFiles =
-    ((newRequest.configs && newRequest.configs.smi && newRequest.configs.smi.files) || []).reduce(
-      (acc, cur) => ({ ...acc, [cur.name]: cur.content }),
-      {}
-    ) || {};
-
-  const diff = [...new Set([...Object.keys(newFiles), ...Object.keys(originalFiles)])].filter(
-    key => newFiles[key] !== originalFiles[key]
-  );
-
-  if (diff.length === 0) {
-    console.log('Nothing to push');
-    return;
-  }
-
-  const status = name => {
-    if (originalFiles[name] && newFiles[name]) {
-      return '[CHANGED]';
-    }
-    if (originalFiles[name]) {
-      return '[REMOVED]';
-    }
-    if (newFiles[name]) {
-      return '[ADDED]';
-    }
-    return '';
-  };
-
-  process.stdout.write(`\
-The following changed files will be pushed:
-`);
-
-  diff.forEach(name =>
-    process.stdout.write(`\
-  - ${name.padEnd(60, '.')} ${status(name)}
-`)
-  );
-}
-async function deploy(args) {
-  let { token, merchant } = await getValidSettings(args);
-
-  const ignoreFiles = [
-    '**/node_modules/**',
-    'node_modules/**',
-    '**/README.md',
-    '**/package.json',
-    '**/package-lock.json'
-  ];
-
-  const files = await glob(`${getcwd(args)}/**/*.*`, { ignore: ignoreFiles });
-
-  const fileList = await Promise.all(
-    files.map(async file => ({
-      name: file.substring(getcwd(args).length),
-      content: await fs.promises.readFile(file, 'utf8')
-    }))
-  );
-
-  let original;
-
-  try {
-    const res = await fetch(
-      `${getRC3Url(args)}configs/msi/?${new URLSearchParams([['merchant_public_id', merchant.public_id]])}`,
-      {
-        headers: { Authorization: `Bearer ${token}` }
-      }
-    );
-    if (res.status === 200) {
-      original = await res.json().catch(() => ({ configs: {} }));
-    } else {
-      original = { configs: {} };
-    }
-  } catch (err) {
-    console.log(err);
-  }
-
-  const packageJson = readPackageJson(getcwd(args));
-  const smiTemplatesVersion = packageJson[packageJsonKeys.OG_SECTION]?.[packageJsonKeys.TEMPLATES_VERSION];
-
-  const newRequest = {
-    ...original,
-    configs: {
-      ...original.configs,
-      smi: {
-        ...((original.configs && original.configs.smi) || {}),
-        files: fileList
-      },
-      ...(smiTemplatesVersion && { provisioned_with: { '@ordergroove/smi-templates': smiTemplatesVersion } })
-    }
-  };
-
-  reportDiffFiles(original, newRequest);
-
-  const { ok } = args.yes
-    ? { ok: true }
-    : await inquirer.prompt([
-        {
-          type: 'list',
-          name: 'ok',
-          message: 'Do you want to proceed?',
-          choices: [
-            { value: true, name: `Yes` },
-            { value: false, name: 'No' }
-          ]
-        }
-      ]);
-
-  if (!ok) return;
-
-  const response = await fetch(
-    `${getRC3Url(args)}/configs/msi/?${new URLSearchParams([['merchant_public_id', merchant.public_id]])}`,
-    {
-      method: 'post',
-      headers: {
-        Authorization: `Bearer ${token}`,
-        'Content-Type': 'application/json'
-      },
-      body: JSON.stringify(newRequest)
-    }
-  );
-  if (response.status === 201) {
-    console.log('Subscription Manager changes deployed');
-  } else {
-    console.error(response.status, await response.text());
-  }
-}
-exports.deploy = deploy;