@madebyseed/seed-cli-tools 2.3.2 → 3.0.0

package/src/types.ts

@@ -0,0 +1,84 @@
+import { SpawnSyncReturns } from "child_process";
+import type { ChildProcess } from "child_process";
+
+export interface Config {
+  gulpFile: string;
+  gulp: string;
+  themeRoot: string;
+  seedConfig: string;
+  seedConfigDelimiter: string;
+}
+
+export interface ShopifyCLI {
+  login: (store: string) => SpawnSyncReturns<Buffer>;
+  serve: (store: string, options?: Record<string, unknown>) => ChildProcess;
+  pull: (
+    store: string,
+    themeId?: string | undefined,
+    dir?: string,
+    nodelete?: boolean,
+  ) => ChildProcess;
+  push: (
+    store: string,
+    themeId?: string | undefined,
+    nodelete?: boolean,
+  ) => ChildProcess;
+  package: () => ChildProcess;
+  list: (
+    store: string,
+    options?: { role?: string; json?: boolean },
+  ) => ChildProcess;
+  duplicate: (
+    store: string,
+    themeId: string,
+    name?: string,
+    json?: boolean,
+  ) => ChildProcess;
+}
+
+export interface SeedConfig {
+  store?: string;
+  stores?: {
+    [key: string]: {
+      domain: string;
+      themes: {
+        [key: string]: string;
+      };
+    };
+  };
+  themes?: {
+    [key: string]: string;
+  };
+  __developmentThemeId?: string;
+}
+
+export interface SeedProjectConfig {
+  // Store Configuration
+  stores: {
+    [key: string]: {
+      domain: string; // mystore.myshopify.com
+      password?: string; // store password if needed
+    };
+  };
+
+  pull: {
+    ignoreFiles: string[];
+  };
+
+  // Build Configuration
+  build: {
+    js: {
+      type: "legacy" | "bundle";
+    };
+  };
+}
+
+// Re-export build config types
+export type {
+  BuildConfig,
+  PathConfig,
+  TmpPathConfig,
+  DistPathConfig,
+  RootsConfig,
+  PluginsConfig,
+} from "./tasks/includes/config";

package/src/utils.ts

@@ -0,0 +1,444 @@
+import { red, yellow } from "chalk";
+import figures from "figures";
+import spawn from "cross-spawn";
+import type { ChildProcess } from "child_process";
+import { join } from "path";
+import { readFileSync, writeFileSync, existsSync } from "fs";
+import config from "./config";
+import { SeedConfig, ShopifyCLI, SeedProjectConfig } from "./types";
+
+/**
+ * Get seed.project.json from project root dir
+ *
+ * @param {string} themeRoot - the path to theme root dir
+ * @returns {SeedProjectConfig | null} - project config object or null if not found
+ */
+export function getProjectConfig(themeRoot: string): SeedProjectConfig | null {
+  console.log(require(join(themeRoot, "seed.project.json")));
+
+  return require(join(themeRoot, "seed.project.json"));
+}
+
+/**
+ * Get seed.config.js from project root dir
+ *
+ * @param {string} themeRoot - the path to theme root dir
+ * @returns {SeedConfig} - seed config object
+ */
+export function getSeedConfig(themeRoot: string): SeedConfig {
+  return require(join(themeRoot, "seed.config.js"));
+}
+
+/**
+ * Get store name from seed.project.json or seed.config.js
+ *
+ * @param {string} themeRoot - the path to theme root dir
+ * @param {string} [store] - optional store name, defaults to "main"
+ * @returns {string | undefined} - store domain or undefined if not found
+ */
+export function getStoreName(
+  themeRoot: string,
+  store?: string,
+): string | undefined {
+  // Default to "main" if no store specified
+  const storeKey = store || "main";
+
+  // Try to get from project config first
+  const projectConfig = getProjectConfig(themeRoot);
+  if (projectConfig?.stores?.[storeKey]) {
+    return projectConfig.stores[storeKey].domain;
+  }
+
+  // Fallback to legacy config
+  const legacyConfig = getSeedConfig(themeRoot);
+  return store && legacyConfig.stores?.[store]
+    ? legacyConfig.stores[store].domain
+    : legacyConfig.store;
+}
+
+/**
+ * Get store password from seed.project.json
+ *
+ * @param {string} themeRoot - the path to theme root dir
+ * @param {string} [store] - optional store name, defaults to "main"
+ * @returns {string | undefined} - store password or undefined if not found
+ */
+export function getStorePassword(
+  themeRoot: string,
+  store?: string,
+): string | undefined {
+  const storeKey = store || "main";
+  const projectConfig = getProjectConfig(themeRoot);
+  return projectConfig?.stores?.[storeKey]?.password;
+}
+
+/**
+ * Wrappers for Shopify CLI commands
+ *
+ * @summary a set of utility functions used to wrap shopify's CLI
+ * @namespace seed-cli.shopifyCLI
+ * @memberof seed-cli
+ */
+export const shopifyCLI: ShopifyCLI = {
+  /**
+   * shopify login
+   *
+   * @memberof seed-cli.shopifyCLI
+   * @param {string} store - store's myshopify domain name
+   * @returns {object} - spawnSync object or, node's <ChildProcess> object if async
+   */
+  login: (store: string) => {
+    const args = ["switch", "--store", store];
+    const options = {
+      env: process.env,
+      stdio: "inherit" as const,
+      shell: true,
+    };
+
+    return spawn.sync("shopify", args, options);
+  },
+
+  /**
+   * shopify theme serve
+   *
+   * @memberof seed-cli.shopifyCLI
+   * @param {string} store - store's myshopify domain name
+   * @param {object} options - node spawn options
+   * @returns {object} - node's ChildProcess
+   */
+  serve: (store: string, options = {}) => {
+    return spawn("shopify theme", ["dev", "--store", store, "--path", "dist"], {
+      env: process.env,
+      stdio: "inherit" as const,
+      shell: true,
+      ...options,
+    });
+  },
+
+  /**
+   * shopify theme pull
+   *
+   * @memberof seed-cli.shopifyCLI
+   * @param {string} store - store's myshopify domain name
+   * @param {string} themeId - shopify theme id to pull from
+   * @param {string} dir - directory to pull into
+   * @param {boolean} [nodelete = true] - run command with --no-delete flag
+   * @returns {object} - node's ChildProcess
+   */
+  pull: (store: string, themeId?: string, dir = "./src", nodelete = true) => {
+    let args = ["pull", "--store", store];
+    if (themeId) args = args.concat(["--theme", themeId, "--path", dir]);
+
+    if (nodelete) args.push("--nodelete");
+
+    return spawn("shopify theme", args, {
+      env: process.env,
+      stdio: "inherit" as const,
+      shell: true,
+    });
+  },
+
+  /**
+   * shopify theme push
+   *
+   * @memberof seed-cli.shopifyCLI
+   * @param {string} store - store's myshopify domain name
+   * @param {string} themeId - shopify theme id to push into
+   * @param {boolean} [nodelete = true] - run command with --no-delete flag
+   * @returns {ChildProcess} - node's ChildProcess
+   */
+  push: (store: string, themeId?: string, nodelete = true) => {
+    let args = ["push", "--store", store, "--path", "dist"];
+    if (themeId) args = args.concat(["--theme", themeId]);
+
+    if (nodelete) args.push("--nodelete");
+
+    return spawn("shopify theme", args, {
+      env: process.env,
+      stdio: "inherit" as const,
+      shell: true,
+    });
+  },
+
+  /**
+   * shopify theme package
+   *
+   * @memberof seed-cli.shopifyCLI
+   * @returns {ChildProcess} - node's ChildProcess
+   */
+  package: () => {
+    return spawn("shopify theme", ["package", "--path", "dist"], {
+      env: process.env,
+      stdio: "inherit" as const,
+      shell: true,
+    });
+  },
+
+  /**
+   * shopify theme list
+   *
+   * @memberof seed-cli.shopifyCLI
+   * @param {string} store - store's myshopify domain name
+   * @param {object} options - additional options (role, json, etc.)
+   * @returns {ChildProcess} - node's ChildProcess
+   */
+  list: (store: string, options: { role?: string; json?: boolean } = {}) => {
+    let args = ["list", "--store", store];
+
+    if (options.role) args = args.concat(["--role", options.role]);
+    if (options.json) args.push("--json");
+
+    return spawn("shopify theme", args, {
+      env: process.env,
+      stdio: options.json ? "pipe" : ("inherit" as const),
+      shell: true,
+    });
+  },
+
+  /**
+   * shopify theme duplicate
+   *
+   * @memberof seed-cli.shopifyCLI
+   * @param {string} store - store's myshopify domain name
+   * @param {string} themeId - theme ID to duplicate
+   * @param {string} [name] - optional name for the duplicated theme
+   * @param {boolean} [json] - return JSON output
+   * @returns {ChildProcess} - node's ChildProcess
+   */
+  duplicate: (store: string, themeId: string, name?: string, json = false) => {
+    let args = ["duplicate", "--store", store, "--theme", themeId, "--force"];
+
+    if (name) args = args.concat(["--name", name]);
+    if (json) args.push("--json");
+
+    return spawn("shopify theme", args, {
+      env: process.env,
+      stdio: json ? "pipe" : ("inherit" as const),
+      shell: true,
+    });
+  },
+};
+
+/**
+ * Get the live theme ID from a store
+ */
+export async function getLiveThemeId(store: string): Promise<string> {
+  return new Promise((resolve, reject) => {
+    const listProcess = shopifyCLI.list(store, { role: "live", json: true });
+    let output = "";
+    let errorOutput = "";
+
+    listProcess.stdout?.on("data", (data: Buffer) => {
+      output += data.toString();
+    });
+
+    listProcess.stderr?.on("data", (data: Buffer) => {
+      errorOutput += data.toString();
+    });
+
+    listProcess.on("close", (code: number) => {
+      if (code !== 0) {
+        reject(new Error(`Failed to get live theme: ${errorOutput}`));
+        return;
+      }
+
+      try {
+        const response = JSON.parse(output);
+        const liveTheme = response.themes?.find(
+          (theme: any) => theme.role === "live",
+        );
+
+        if (!liveTheme) {
+          reject(new Error("No live theme found"));
+          return;
+        }
+
+        resolve(liveTheme.id.toString());
+      } catch (error) {
+        reject(new Error(`Failed to parse theme list response: ${error}`));
+      }
+    });
+  });
+}
+
+/**
+ * Duplicate a theme and return the new theme ID
+ */
+export async function duplicateTheme(
+  store: string,
+  sourceThemeId: string,
+  name?: string,
+): Promise<string> {
+  return new Promise((resolve, reject) => {
+    const duplicateProcess = shopifyCLI.duplicate(
+      store,
+      sourceThemeId,
+      name,
+      true,
+    );
+    let output = "";
+    let errorOutput = "";
+
+    duplicateProcess.stdout?.on("data", (data: Buffer) => {
+      output += data.toString();
+    });
+
+    duplicateProcess.stderr?.on("data", (data: Buffer) => {
+      errorOutput += data.toString();
+    });
+
+    duplicateProcess.on("close", (code: number) => {
+      if (code !== 0) {
+        reject(new Error(`Failed to duplicate theme: ${errorOutput}`));
+        return;
+      }
+
+      try {
+        const response = JSON.parse(output);
+        resolve(response.theme.id.toString());
+      } catch (error) {
+        reject(new Error(`Failed to parse duplicate response: ${error}`));
+      }
+    });
+  });
+}
+
+/**
+ * Duplicate a theme from live theme
+ */
+export async function duplicateFromLive(
+  store: string,
+  name?: string,
+): Promise<string> {
+  const liveThemeId = await getLiveThemeId(store);
+  const newThemeId = await duplicateTheme(store, liveThemeId, name);
+  return newThemeId;
+}
+
+/**
+ * Get theme ID from seed.config.js
+ *
+ * @param {string} themeRoot - the path to theme root dir
+ * @param {string} environment - theme name/environment
+ * @param {string} [store] - optional store name
+ * @returns {string} themeID
+ */
+export function getThemeID(
+  themeRoot: string,
+  environment: string,
+  store?: string,
+): string | undefined {
+  const config = getSeedConfig(themeRoot);
+  return store && config.stores?.[store]
+    ? config.stores[store].themes[environment]
+    : config.themes?.[environment];
+}
+
+/**
+ * Get dev theme ID from seed.config.js
+ *
+ * @param {string} themeRoot - the path to theme root dir
+ * @returns {string} - development store theme ID
+ */
+export function getDevThemeID(themeRoot: string): string | undefined {
+  return getSeedConfig(themeRoot).__developmentThemeId;
+}
+
+/**
+ * Given a string, finds the first themeID and returns it, if no themeID found
+ * returns false.
+ *
+ * @param {string} string - string to extract theme id from
+ * @return {string|boolean} - themeID or false if not found
+ */
+export function extractThemeId(string: string): string | false {
+  const regex = /\d{12}/;
+  const match = string.match(regex);
+  return match && match.length ? match[0] : false;
+}
+
+/**
+ * Logs out to terminal the output of a piped child process
+ *
+ * @param {child_process} serveProcess shopify cli serve spawned child process
+ */
+export function logChildProcessOutput(process: ChildProcess): void {
+  process.stdout?.on("data", (data: Buffer | string) => {
+    console.log(data.toString());
+  });
+}
+
+/**
+ * Writes the development theme ID as a key to seed config file
+ *
+ * @param {string} themeID - development theme ID
+ */
+export function setDevThemeID(themeID: string): void {
+  const data = readFileSync(config.seedConfig, { encoding: "utf8" }).split(
+    config.seedConfigDelimiter,
+  );
+  data[1] = `\n  __developmentThemeId: '${themeID}'` + "\n};";
+  writeFileSync(config.seedConfig, data.join(config.seedConfigDelimiter));
+}
+
+/**
+ * Logs into seed config shopify store while logging useful messages
+ * and handling errors.
+ *
+ * @param {string} [store] - optional store name, defaults to "main"
+ * @returns {boolean} whether login was successful or not
+ */
+export function login(store?: string): boolean {
+  const domain = getStoreName(config.themeRoot, store);
+
+  if (!domain) {
+    storeErrorMessage(store);
+    return false;
+  }
+
+  console.log(`Logging into ${yellow(domain)} with Shopify CLI...`);
+  const loginProcess = shopifyCLI.login(domain);
+  if (loginProcess.error) {
+    console.log("");
+    console.log(
+      red(
+        `  ${figures.cross} Failed logging into ${domain}, are you sure you're using the correct account?`,
+      ),
+    );
+    console.log("");
+    return false;
+  }
+
+  return true;
+}
+
+/**
+ * Outputs error message if there's no store field in seed config
+ *
+ * @param {string} [store] - optional store name that was not found
+ */
+export function storeErrorMessage(store?: string): void {
+  if (store) {
+    console.log("");
+    console.log(
+      red(
+        `  The store ${store} does not exist in seed.project.json or seed.config.js`,
+      ),
+    );
+    console.log(
+      "    Check to see if you spelled the store correctly in your config files and when running the command.",
+    );
+    console.log("");
+  } else {
+    console.log("");
+    console.log(
+      red(
+        `  ${figures.cross} No 'main' store found in seed.project.json or seed.config.js`,
+      ),
+    );
+    console.log(
+      "    Add a 'main' store to your seed.project.json or specify which store to use with --store <store>",
+    );
+    console.log("");
+  }
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "composite": true,
+    "declaration": true,
+    "sourceMap": true,
+    "esModuleInterop": true,
+    "strict": true
+  },
+  "include": ["./**/*.ts"],
+  "exclude": ["node_modules", "lib"]
+}