@syncify/cli 0.1.3-beta → 0.2.1-beta

package/types/{misc → internal}/commands.d.ts

@@ -1,4 +1,3 @@
-
 /* -------------------------------------------- */
 /* CLI OPTIONS                                  */
 /* -------------------------------------------- */
@@ -84,10 +83,10 @@ export interface Commands {
    * Example:
    *
    * ```bash
-   * $ syncify --prompt
+   * $ syncify --interactive
    * ```
    */
-  prompt?: boolean;
+  interactive?: boolean;
   /**
    * Run in watch mode (chokidar). This requires a store target be passed.
    *
@@ -204,20 +203,19 @@ export interface Commands {
    */
   pull?: boolean;
   /**
-   * Pushes a resource from local to remote shop. This is different from `-u` or `--upload`
-   * flags as it can be used to push targets assets, files or resources and can be used
-   * together with the `-f` filter flag.
+   * Force uploads a resource from local to remote shop. This will instruct
+   * syncify to overwrite any remote versions.
    *
    * ---
    *
    * Example:
    *
    * ```bash
-   * $ syncify store_1 -t dev_theme -f assets/file --push
-   * $ syncify store_1 -f metafields/namespace/*.json --push
+   * $ syncify store_1 -t dev_theme -f assets/file -u --force
+   * $ syncify store_1 -f metafields/namespace/*.json -u --force
    * ```
    */
-  push?: boolean;
+  force?: boolean;
   /**
    * Generator flag for automatically applying JSON schema specifications
    * for VS Code users.
@@ -294,19 +292,6 @@ export interface Commands {
    * ```
    */
   silent?: boolean;
-  /**
-   * Initialized Browser Sync in watch mode. Can only be used when
-   * targeting a single store and theme.
-   *
-   * ---
-   *
-   * Example:
-   *
-   * ```bash
-   * $ syncify store_1 --watch --server
-   * ```
-   */
-  server?: boolean;
   /**
    * Pulls in a Syncify theme strap environment.
    *
@@ -315,7 +300,7 @@ export interface Commands {
    * Example:
    *
    * ```bash
-   * $ syncify --strap dusk
+   * $ syncify --strap dawn
    * $ syncify --strap silk
    * ```
    */
@@ -378,7 +363,7 @@ export interface Commands {
    */
    input?: string;
   /**
-   * An optional output path. This will overwrite and configuration predefined
+   * An optional output path. This will overwrite any configuration predefined
    * in settings.
    *
    * ---
@@ -392,16 +377,19 @@ export interface Commands {
   output?: string;
   /**
    * Version control. The bump flag accepts 3 different arguments.
-   * Passing `--bump major` bumps main version, eg: `1.0.0` > `2.0,0`
-   * Passing `--bump minor` bumps minor version, eg: `1.0.0` > `1.1.0`
-   * Passing `--bump patch` bumps patch version, eg: `1.0.0` > `1.0.1`
+   *
+   * 1. Passing `--bump major` bumps main version, eg: `1.0.0` > `2.0,0`
+   * 2. Passing `--bump minor` bumps minor version, eg: `1.0.0` > `1.1.0`
+   * 3. Passing `--bump patch` bumps patch version, eg: `1.0.0` > `1.0.1`
    *
    * ---
    *
    * Example:
    *
    * ```bash
-   * $ syncify --clean -b -i some/directory
+   * $ syncify --bump major
+   * $ syncify --bump minor
+   * $ syncify --bump patch
    * ```
    */
   bump?: string;

package/types/{bundle → internal}/file.d.ts

@@ -1,13 +1,12 @@
 /* eslint-disable no-unused-vars */
 
-import { ParsedPath } from 'path';
-import { LiteralUnion } from 'type-fest';
+import { LiteralUnion, Merge } from 'type-fest';
 
 /**
  * File types are represented as numeric values.
  * The infer the following:
  */
-export enum Types {
+export enum FileTypes {
   Template = 1,
   Layout,
   Snippet,
@@ -16,9 +15,9 @@ export enum Types {
   Locale,
   Style,
   Script,
+  Svg,
   Redirect,
   File,
-  Svg,
   Asset,
   Metafield,
   Page,
@@ -26,9 +25,10 @@ export enum Types {
 }
 
 /**
- * File Kinds - Applied to `file.kind` context.
+ * File Kinds
  *
- * _Used to describe of file being handled._
+ * Applied to `file.kind` context. The is a text value
+ * Used to describe of file being handled.
  */
 export type FileKinds = LiteralUnion<
   | 'style'
@@ -47,26 +47,39 @@ export type FileKinds = LiteralUnion<
 >
 
 /**
- * Shopify Asset Key - Applied to `file.key` context
+ * Shopify Asset Key
+ *
+ * Applied to `file.key` context and required in theme asset
+ * requests. The `key` represents to the file and directory
+ * structure.
+ *
+ * > Used in REST API request payload
+ *
+ * @example
+ *
+ * 'snippets/filename.liquid'
  *
- *  _Used in REST API request payload_
  */
 export type FileKeys = LiteralUnion<
   | `templates/${string}${'.liquid' | '.json'}`
   | `templates/customer/${string}${'.liquid' | '.json'}`
   | `assets/${string}`
-  | `sections/${string}${'.liquid'}`
+  | `sections/${string}${'.liquid' | '-group.json'}`
   | `snippets/${string}${'.liquid'}`
   | `layout/${string}${'.liquid'}`
   | `locales/${string}${'.json'}`
   | `config/settings_${'data' | 'schema'}${'.json'}`
   , string
-  >
+>
 
 /**
- * File Namespace - Applied to `file.namespace` context
+ * File Namespace
  *
- *  _Used in logs, reports and other logic_
+ * Applied to `file.namespace` context. This value represents the
+ * the output theme directory where a file should be written, but
+ * may also represent an endpoint.
+ *
+ * > Used in logs, reports and other logic
  */
 export type FileNamespaces = LiteralUnion<
   | 'template'
@@ -87,8 +100,8 @@ export type FileNamespaces = LiteralUnion<
 /**
  * File Resource - Applied to `file.resource` context
  *
- * _Infers the REST API endpoint excepts for `files` which
- * will use the insufferable Shopify GraphQL endpoint (yuck 🤮)_
+ * Applied to `file.resource` context. Infers the REST API endpoint
+ * excluding `files` which will use the insufferable Shopify GraphQL endpoint.
  */
 export type FileResources = LiteralUnion<
   | 'pages'
@@ -101,22 +114,33 @@ export type FileResources = LiteralUnion<
 >
 
 /**
- * File context generated when passed to a sync
- * resource and used to dispatch to correct transform
- * process.
+ * File context generated when passed to a sync resource and used
+ * to dispatch to correct transform process.
  */
-interface File<T = any> extends ParsedPath {
+interface File<T = any> {
+  /**
+   * A unique UUID reference for this file - This option can change
+   * where required and when dealing with multiple stores at the request level.
+   *
+   * @example
+   *
+   * 'ABD41WX'
+   */
+  uuid: string;
   /**
    * The file type that was intercepted. This is an enum number value.
-   * The number value will infer on how the file should be handled.
+   * The number value will infer on how the file should be handled and uses
+   * the `FileType` enum for checks.
    *
    * @example
    *
-   * 1
+   * file.type === FileType.Template
+   *
    */
   type: number;
   /**
-   * The resource endpoint to which the file will be published
+   * The resource API endpoint to which the file will be synced.
+   * This will be passed to the request client.
    *
    * @example
    *
@@ -124,9 +148,41 @@ interface File<T = any> extends ParsedPath {
    * 'redirects'
    */
   resource: FileResources;
+  /**
+   * The root of the file path
+   *
+   * > Value is obtained via the native `path.parse()` method
+   *
+   * @example
+   *
+   * '/' OR 'c:\'
+   */
+  root: string;
+  /**
+   * The full directory path such.
+   *
+   * > Value is obtained via the native `path.parse()` method
+   *
+   * @example
+   *
+   * '/home/user/dir' OR 'c:\path\dir'
+   */
+  dir: string;
+  /**
+   * The file name without extension (if any).
+   *
+   * > Value is obtained via the native `path.parse()` method
+   *
+   * @example
+   *
+   * 'filename' // filename.ext
+   */
+  name: string;
   /**
    * The filename extension including the dot, eg: `.liquid`
    *
+   * > Value is obtained via the native `path.parse()` method
+   *
    * @example
    *
    * '.ext'
@@ -135,6 +191,8 @@ interface File<T = any> extends ParsedPath {
   /**
    * The input base filename including file extension.
    *
+   * > Value is obtained via the native `path.parse()` method
+   *
    * @example
    *
    * 'filename.ext'
@@ -195,10 +253,9 @@ interface File<T = any> extends ParsedPath {
    */
   input: string;
   /**
-   * The output path location which files will be written.
-   * Only theme specific files have an output path location,
-   * when a file write from source (like metafield) this will
-   * have a `null` value.
+   * The output path location which files will be written. Only theme specific files
+   * have an output path location, when a file writes from its source (like a metafield) or
+   * if the file is handled in an asset pipeline transform then this will have a `null` value.
    *
    * @example
    *
@@ -210,7 +267,8 @@ interface File<T = any> extends ParsedPath {
    */
   output: string;
   /**
-   * The file size in bytes before any augmentation is applied.
+   * The file size in bytes before any augmentation is applied. This
+   * value will assigned post-context, typically in a transform.
    *
    * @example
    *
@@ -218,11 +276,10 @@ interface File<T = any> extends ParsedPath {
    */
   size?: number;
   /**
-   * Configuration reference. This will hold a reference
-   * to additional data. Typically, this is used for
-   * transforms, wherein it holds the indexed config.
+   * Configuration reference. This will hold a reference to additional data.
+   * Typically, this is used for transforms, wherein it holds the indexed config.
    *
    * @default undefined // getter when required
    */
-  config: T
+  get data(): T
 }

package/types/internal/filters.d.ts

@@ -0,0 +1,81 @@
+export interface Filters {
+  /**
+   * Theme Asset filters
+   *
+   * @example
+   * '--filter assets/*'
+   */
+  assets?: string[];
+  /**
+   * Theme Config filters
+   *
+   * @example
+   * '--filter config/*'
+   */
+  config?: string[];
+  /**
+   * Theme Layout filters
+   *
+   * @example
+   * '--filter layout/*'
+   */
+  layout?: string[];
+  /**
+   * Theme Locales filters
+   *
+   * @example
+   * '--filter locales/*'
+   */
+  locales?: string[];
+  /**
+   * Theme Templates filters
+   *
+   * @example
+  * '--filter assets/*'
+  */
+  templates?: string[];
+  /**
+   * Theme Customers filters
+   *
+   * @example
+   * '--filter assets/*'
+   */
+  customers?: string[];
+  /**
+   * Theme Snippets filters
+   *
+   * @example
+   * '--filter snippets/*'
+   */
+  snippets?: string[];
+  /**
+   * Theme sections filters
+   *
+   * @example
+   * '--filter sections/*'
+   */
+  sections?: string[];
+  /**
+   * Store Metafields filters
+   *
+   * @example
+   * '--filter assets/*'
+   */
+  metafields?: string[];
+  /**
+   * Store pages filters
+   *
+   * @example
+   * '--filter pages/*'
+   */
+  pages?: string[];
+  /**
+   * Terse filters
+   *
+   * @example
+   * '--filter terse:script'
+   * '--filter terse:style'
+   * '--filter terse:views'
+   */
+  terse?: string[];
+}

package/types/{bundle → internal}/hot.d.ts

@@ -1,9 +1,15 @@
-
 /* -------------------------------------------- */
 /* LIVE RELOADS                                 */
 /* -------------------------------------------- */
 
-export interface HOTSockets {
+import type { Server, WebSocket } from 'ws';
+import type { IncomingMessage } from 'http';
+
+export interface WSS {
+  /**
+   * The `wss` instance
+   */
+  get http(): Server<typeof WebSocket, typeof IncomingMessage>
   /**
    * Hot Socket for `<script>` tags
    */
@@ -35,13 +41,24 @@ export interface HOTSockets {
 
 }
 
-export interface HOT {
+/**
+ * **INTERNAL USE**
+ */
+export interface HOTBundle {
   /**
    * Whether or not Syncify hot reloads UI labels should render.
    *
    * @default true
    */
   label?: 'visible' | 'hidden';
+  /**
+   * **NOT YET AVAILABLE**
+   *
+   * Whether or not to record changes. When enabled, Syncify
+   * will keep track of the last 25 changes applied and allow
+   * you to walk through the stack.
+   */
+  history?: boolean;
   /**
    * Whether or not Syncify should inject the required HOT snippet
    * at runtime layout/s. When `false` you will need to manually place
@@ -126,7 +143,7 @@ export interface HOT {
   alive?: { [template: string]: boolean; };
 }
 
-export type HOTConfig = Pick<HOT,
+export type HOTConfig = Pick<HOTBundle,
   | 'inject'
   | 'label'
   | 'layouts'