@madebyseed/seed-cli-tools 2.3.2 → 3.0.0

package/lib/types.d.ts

@@ -0,0 +1,53 @@
+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 {
+    stores: {
+        [key: string]: {
+            domain: string;
+            password?: string;
+        };
+    };
+    pull: {
+        ignoreFiles: string[];
+    };
+    build: {
+        js: {
+            type: "legacy" | "bundle";
+        };
+    };
+}
+export type { BuildConfig, PathConfig, TmpPathConfig, DistPathConfig, RootsConfig, PluginsConfig, } from "./tasks/includes/config";

package/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/lib/utils.d.ts

@@ -0,0 +1,102 @@
+import type { ChildProcess } from "child_process";
+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 declare function getProjectConfig(themeRoot: string): SeedProjectConfig | null;
+/**
+ * Get seed.config.js from project root dir
+ *
+ * @param {string} themeRoot - the path to theme root dir
+ * @returns {SeedConfig} - seed config object
+ */
+export declare function getSeedConfig(themeRoot: string): SeedConfig;
+/**
+ * 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 declare function getStoreName(themeRoot: string, store?: string): string | undefined;
+/**
+ * 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 declare function getStorePassword(themeRoot: string, store?: string): string | undefined;
+/**
+ * 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 declare const shopifyCLI: ShopifyCLI;
+/**
+ * Get the live theme ID from a store
+ */
+export declare function getLiveThemeId(store: string): Promise<string>;
+/**
+ * Duplicate a theme and return the new theme ID
+ */
+export declare function duplicateTheme(store: string, sourceThemeId: string, name?: string): Promise<string>;
+/**
+ * Duplicate a theme from live theme
+ */
+export declare function duplicateFromLive(store: string, name?: string): Promise<string>;
+/**
+ * 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 declare function getThemeID(themeRoot: string, environment: string, store?: string): string | undefined;
+/**
+ * Get dev theme ID from seed.config.js
+ *
+ * @param {string} themeRoot - the path to theme root dir
+ * @returns {string} - development store theme ID
+ */
+export declare function getDevThemeID(themeRoot: string): string | undefined;
+/**
+ * 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 declare function extractThemeId(string: string): string | false;
+/**
+ * Logs out to terminal the output of a piped child process
+ *
+ * @param {child_process} serveProcess shopify cli serve spawned child process
+ */
+export declare function logChildProcessOutput(process: ChildProcess): void;
+/**
+ * Writes the development theme ID as a key to seed config file
+ *
+ * @param {string} themeID - development theme ID
+ */
+export declare function setDevThemeID(themeID: string): void;
+/**
+ * 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 declare function login(store?: string): boolean;
+/**
+ * Outputs error message if there's no store field in seed config
+ *
+ * @param {string} [store] - optional store name that was not found
+ */
+export declare function storeErrorMessage(store?: string): void;