@syncify/cli 1.0.0-alpha.1 → 1.0.0-unstable.0

package/dist/index.d.ts

@@ -1,19 +1,15 @@
 /// <reference path="../node_modules/@types/clean-css/index.d.ts" />
-/// <reference path="../node_modules/@types/svg-sprite/index.d.ts" />
 /// <reference path="../node_modules/svgo/lib/svgo.d.ts" />
 /// <reference path="../node_modules/postcss/lib/postcss.d.ts" />
 /// <reference path="../node_modules/tailwindcss/types/index.d.ts" />
 /// <reference path="../node_modules/esbuild/lib/main.d.ts" />
 /// <reference path="../node_modules/type-fest/index.d.ts" />
 
-import { LiteralUnion, Merge } from 'type-fest';
 import { BuildOptions } from 'esbuild';
 export { BuildOptions as ESBuildOptions } from 'esbuild';
 import { OptionsOutput } from 'clean-css';
 import { AcceptedPlugin, Plugin, Transformer, TransformCallback } from 'postcss';
 import { Config as Config$1 } from 'tailwindcss';
-import { Config as Config$3 } from 'svg-sprite';
-export { Config as SVGSpriteConfig } from 'svg-sprite';
 import { Config as Config$2 } from 'svgo';
 export { Config as SVGOConfig } from 'svgo';
 import { Options } from 'markdown-it';
@@ -22,11 +18,11 @@ import { Options } from 'markdown-it';
 /* BASE DIRECTORIES                             */
 /* -------------------------------------------- */
 
-interface Directories {
+type Directories = {
   /**
    * The resolved `input` directory path
    *
-   * @default 'source'
+   * @default 'source/'
    */
   input?: string;
   /**
@@ -36,26 +32,382 @@ interface Directories {
    */
   output?: string;
   /**
-   * The resolved `import` directory path for downloaded themes
+   * The resolved `config` directory path for build tool files
    *
-   * @default 'import/'
+   * @default '/'
    */
-  import?: string;
+  config?: string;
+}
+
+type Git = {
   /**
-   * The resolved `export` directory path for packaged `.zip` themes
+   * Specifies the default branch where your project exists. This branch will be be used to trigger
+   * the auto-merging behaviour when running `git pull`. Your `output` (theme) directory will not
+   * exist within this branch unless explicitly excluded from `.gitignore` file.
+   *
+   * > Please refer to the [Syncify Git Integration](https://syncify.sh/usage/git) for more information.
    *
-   * @default 'export'
+   * @default 'master'
    */
-  export?: string;
+  default?: string;
   /**
-   * The resolved `config` directory path for build tool files
+   * Specifies the production branch name, which is primary sync branch. This is the branch
+   * that Syncify will auto-publish the flat **output** directory too, and is not to be confused
+   * with the branch where your **input** (source) lives. Instead, this is the branch used by the
+   * [Shopify Github Integration](https://shopify.dev/docs/storefronts/themes/tools/github).
    *
-   * @default '/'
+   * > **PLEASE NOTE**
+   * >
+   * > Syncify assumes that the default branch of your respository is named `master` (as per the original
+   * > and correct naming convention for Git). The `main` branch is **NOT** considered the "main" branch
+   * > but instead it is used as the distributed flat-structure point of your theme as per the `role` name
+   * > used for live themes published in your store.
+   * >
+   * > Please refer to the [Syncify Git Integration](https://syncify.sh/usage/git) for more information.
+   *
+   * @default 'main'
    */
-  config?: string;
+  branch?: string;
+  /**
+   * A glob pattern of files (or directories) which apply conflict-free merging. These entires force-merge
+   * into **input** (source) upon `git pull` operations. You'd use the option for `.json` configuration
+   * specific files such as templates that auto-write settings from the editor.
+   *
+   * ```js
+   * {
+   *   // all templates will overwrite source.
+   *   force: ['templates/*.json' ]
+   * }
+   * ```
+   *
+   * @default []
+   */
+  force?: string[];
+  /**
+   * Defines branch relationships for mirroring. Each key is a branch name, and the value is an
+   * array of branches that will mirror content changes published via the Shopify Github Integration.
+   *
+   * Mirrors allow developers to define dynamic branch reflections, for example:
+   *
+   * ```js
+   * {
+   *   stage: ['pre']        // ensures the stage branch mirrors the pre branch.
+   *   dev: ['main','pre']  // ensures the dev branch mirrors both main and pre branches.
+   * }
+   * ```
+   *
+   * @default {}
+   */
+  mirror?: { [branch: string]: string[] }
+}
+
+/**
+Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
+
+@category Type
+*/
+type Primitive =
+	| null
+	| undefined
+	| string
+	| number
+	| boolean
+	| symbol
+	| bigint;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
 }
 
-interface Shared {
+/**
+Useful to flatten the type output to improve type hints shown in editors. And also to transform an interface into a type to aide with assignability.
+
+@example
+```
+import type {Simplify} from 'type-fest';
+
+type PositionProps = {
+	top: number;
+	left: number;
+};
+
+type SizeProps = {
+	width: number;
+	height: number;
+};
+
+// In your editor, hovering over `Props` will show a flattened object with all the properties.
+type Props = Simplify<PositionProps & SizeProps>;
+```
+
+Sometimes it is desired to pass a value as a function argument that has a different type. At first inspection it may seem assignable, and then you discover it is not because the `value`'s type definition was defined as an interface. In the following example, `fn` requires an argument of type `Record<string, unknown>`. If the value is defined as a literal, then it is assignable. And if the `value` is defined as type using the `Simplify` utility the value is assignable.  But if the `value` is defined as an interface, it is not assignable because the interface is not sealed and elsewhere a non-string property could be added to the interface.
+
+If the type definition must be an interface (perhaps it was defined in a third-party npm package), then the `value` can be defined as `const value: Simplify<SomeInterface> = ...`. Then `value` will be assignable to the `fn` argument.  Or the `value` can be cast as `Simplify<SomeInterface>` if you can't re-declare the `value`.
+
+@example
+```
+import type {Simplify} from 'type-fest';
+
+interface SomeInterface {
+	foo: number;
+	bar?: string;
+	baz: number | undefined;
+}
+
+type SomeType = {
+	foo: number;
+	bar?: string;
+	baz: number | undefined;
+};
+
+const literal = {foo: 123, bar: 'hello', baz: 456};
+const someType: SomeType = literal;
+const someInterface: SomeInterface = literal;
+
+function fn(object: Record<string, unknown>): void {}
+
+fn(literal); // Good: literal object type is sealed
+fn(someType); // Good: type is sealed
+fn(someInterface); // Error: Index signature for type 'string' is missing in type 'someInterface'. Because `interface` can be re-opened
+fn(someInterface as Simplify<SomeInterface>); // Good: transform an `interface` into a `type`
+```
+
+@link https://github.com/microsoft/TypeScript/issues/15300
+@see SimplifyDeep
+@category Object
+*/
+type Simplify<T> = {[KeyType in keyof T]: T[KeyType]} & {};
+
+/**
+Omit any index signatures from the given object type, leaving only explicitly defined properties.
+
+This is the counterpart of `PickIndexSignature`.
+
+Use-cases:
+- Remove overly permissive signatures from third-party types.
+
+This type was taken from this [StackOverflow answer](https://stackoverflow.com/a/68261113/420747).
+
+It relies on the fact that an empty object (`{}`) is assignable to an object with just an index signature, like `Record<string, unknown>`, but not to an object with explicitly defined keys, like `Record<'foo' | 'bar', unknown>`.
+
+(The actual value type, `unknown`, is irrelevant and could be any type. Only the key type matters.)
+
+```
+const indexed: Record<string, unknown> = {}; // Allowed
+
+const keyed: Record<'foo', unknown> = {}; // Error
+// => TS2739: Type '{}' is missing the following properties from type 'Record<"foo" | "bar", unknown>': foo, bar
+```
+
+Instead of causing a type error like the above, you can also use a [conditional type](https://www.typescriptlang.org/docs/handbook/2/conditional-types.html) to test whether a type is assignable to another:
+
+```
+type Indexed = {} extends Record<string, unknown>
+	? '✅ `{}` is assignable to `Record<string, unknown>`'
+	: '❌ `{}` is NOT assignable to `Record<string, unknown>`';
+// => '✅ `{}` is assignable to `Record<string, unknown>`'
+
+type Keyed = {} extends Record<'foo' | 'bar', unknown>
+	? "✅ `{}` is assignable to `Record<'foo' | 'bar', unknown>`"
+	: "❌ `{}` is NOT assignable to `Record<'foo' | 'bar', unknown>`";
+// => "❌ `{}` is NOT assignable to `Record<'foo' | 'bar', unknown>`"
+```
+
+Using a [mapped type](https://www.typescriptlang.org/docs/handbook/2/mapped-types.html#further-exploration), you can then check for each `KeyType` of `ObjectType`...
+
+```
+import type {OmitIndexSignature} from 'type-fest';
+
+type OmitIndexSignature<ObjectType> = {
+	[KeyType in keyof ObjectType // Map each key of `ObjectType`...
+	]: ObjectType[KeyType]; // ...to its original value, i.e. `OmitIndexSignature<Foo> == Foo`.
+};
+```
+
+...whether an empty object (`{}`) would be assignable to an object with that `KeyType` (`Record<KeyType, unknown>`)...
+
+```
+import type {OmitIndexSignature} from 'type-fest';
+
+type OmitIndexSignature<ObjectType> = {
+	[KeyType in keyof ObjectType
+		// Is `{}` assignable to `Record<KeyType, unknown>`?
+		as {} extends Record<KeyType, unknown>
+			? ... // ✅ `{}` is assignable to `Record<KeyType, unknown>`
+			: ... // ❌ `{}` is NOT assignable to `Record<KeyType, unknown>`
+	]: ObjectType[KeyType];
+};
+```
+
+If `{}` is assignable, it means that `KeyType` is an index signature and we want to remove it. If it is not assignable, `KeyType` is a "real" key and we want to keep it.
+
+@example
+```
+import type {OmitIndexSignature} from 'type-fest';
+
+interface Example {
+	// These index signatures will be removed.
+	[x: string]: any
+	[x: number]: any
+	[x: symbol]: any
+	[x: `head-${string}`]: string
+	[x: `${string}-tail`]: string
+	[x: `head-${string}-tail`]: string
+	[x: `${bigint}`]: string
+	[x: `embedded-${number}`]: string
+
+	// These explicitly defined keys will remain.
+	foo: 'bar';
+	qux?: 'baz';
+}
+
+type ExampleWithoutIndexSignatures = OmitIndexSignature<Example>;
+// => { foo: 'bar'; qux?: 'baz' | undefined; }
+```
+
+@see PickIndexSignature
+@category Object
+*/
+type OmitIndexSignature<ObjectType> = {
+	[KeyType in keyof ObjectType as {} extends Record<KeyType, unknown>
+		? never
+		: KeyType]: ObjectType[KeyType];
+};
+
+/**
+Pick only index signatures from the given object type, leaving out all explicitly defined properties.
+
+This is the counterpart of `OmitIndexSignature`.
+
+@example
+```
+import type {PickIndexSignature} from 'type-fest';
+
+declare const symbolKey: unique symbol;
+
+type Example = {
+	// These index signatures will remain.
+	[x: string]: unknown;
+	[x: number]: unknown;
+	[x: symbol]: unknown;
+	[x: `head-${string}`]: string;
+	[x: `${string}-tail`]: string;
+	[x: `head-${string}-tail`]: string;
+	[x: `${bigint}`]: string;
+	[x: `embedded-${number}`]: string;
+
+	// These explicitly defined keys will be removed.
+	['kebab-case-key']: string;
+	[symbolKey]: string;
+	foo: 'bar';
+	qux?: 'baz';
+};
+
+type ExampleIndexSignature = PickIndexSignature<Example>;
+// {
+// 	[x: string]: unknown;
+// 	[x: number]: unknown;
+// 	[x: symbol]: unknown;
+// 	[x: `head-${string}`]: string;
+// 	[x: `${string}-tail`]: string;
+// 	[x: `head-${string}-tail`]: string;
+// 	[x: `${bigint}`]: string;
+// 	[x: `embedded-${number}`]: string;
+// }
+```
+
+@see OmitIndexSignature
+@category Object
+*/
+type PickIndexSignature<ObjectType> = {
+	[KeyType in keyof ObjectType as {} extends Record<KeyType, unknown>
+		? KeyType
+		: never]: ObjectType[KeyType];
+};
+
+// Merges two objects without worrying about index signatures.
+type SimpleMerge<Destination, Source> = {
+	[Key in keyof Destination as Key extends keyof Source ? never : Key]: Destination[Key];
+} & Source;
+
+/**
+Merge two types into a new type. Keys of the second type overrides keys of the first type.
+
+@example
+```
+import type {Merge} from 'type-fest';
+
+interface Foo {
+	[x: string]: unknown;
+	[x: number]: unknown;
+	foo: string;
+	bar: symbol;
+}
+
+type Bar = {
+	[x: number]: number;
+	[x: symbol]: unknown;
+	bar: Date;
+	baz: boolean;
+};
+
+export type FooBar = Merge<Foo, Bar>;
+// => {
+// 	[x: string]: unknown;
+// 	[x: number]: number;
+// 	[x: symbol]: unknown;
+// 	foo: string;
+// 	bar: Date;
+// 	baz: boolean;
+// }
+```
+
+@category Object
+*/
+type Merge<Destination, Source> =
+Simplify<
+SimpleMerge<PickIndexSignature<Destination>, PickIndexSignature<Source>>
+& SimpleMerge<OmitIndexSignature<Destination>, OmitIndexSignature<Source>>
+>;
+
+/**
+Allows creating a union type by combining primitive types and literal types without sacrificing auto-completion in IDEs for the literal type part of the union.
+
+Currently, when a union type of a primitive type is combined with literal types, TypeScript loses all information about the combined literals. Thus, when such type is used in an IDE with autocompletion, no suggestions are made for the declared literals.
+
+This type is a workaround for [Microsoft/TypeScript#29729](https://github.com/Microsoft/TypeScript/issues/29729). It will be removed as soon as it's not needed anymore.
+
+@example
+```
+import type {LiteralUnion} from 'type-fest';
+
+// Before
+
+type Pet = 'dog' | 'cat' | string;
+
+const pet: Pet = '';
+// Start typing in your TypeScript-enabled IDE.
+// You **will not** get auto-completion for `dog` and `cat` literals.
+
+// After
+
+type Pet2 = LiteralUnion<'dog' | 'cat', string>;
+
+const pet: Pet2 = '';
+// You **will** get auto-completion for `dog` and `cat` literals.
+```
+
+@category Type
+*/
+type LiteralUnion<
+	LiteralType,
+	BaseType extends Primitive,
+> = LiteralType | (BaseType & Record<never, never>);
+
+type HOTShared = {
  /**
    * Specify the static server port. By default, Syncify uses port `41001` to
    * avoid any conflicts with other running hosts of tools.
@@ -98,44 +450,15 @@ interface Shared {
    */
   label?: boolean;
   /**
-   * The theme roles in which HOT reloading can apply. By default, HOT modes will on
-   * apply to themes with an `unpublished` or `development` role. Themes which are
-   * published (the one which customers see when they visit the online store) requires
-   * you to explicitly enable.
+   * Controls whether ot the HOT Snippet injection is auto-removed from layout/s.
+   * When set to `false`, the HOT render snippet is persisted on process exit whereas
+   * the default behaviour is to remove it from layouts.
    *
-   * @default
-   * {
-   *   published: false, // set to true to enable on published themes
-   *   development: true,
-   *   unpublished: true
-   * }
+   * Setting this `false` will improve start-up runtime in `--hot` mode by a few hundred ms.
+   *
+   * @default true
    */
-  roles?: {
-    /**
-     * Whether or not HOT Reloading is enabled on published themes with a `main` role.
-     *
-     * > **NOTE ON DISTINCTION**
-     * >
-     * > Syncify considers `published` themes as those which are **live**. Shopify,
-     * > references **live** themes using `main` role but this is not really logical
-     * > so we instead use a more coherent naming convention.
-     *
-     * @default false
-     */
-    published?: boolean;
-    /**
-     * Whether or not HOT Reloading is enabled on unpublished role themes
-     *
-     * @default true
-     */
-    unpublished?: boolean;
-    /**
-     * Whether or not HOT Reloading is enabled on development role themes
-     *
-     * @default true
-     */
-    development?: boolean;
-  }
+  eject?: boolean
   /**
    * Accepts a string list of flags that enable Syncify to
    * wrangle CFH slop in development mode along with normalisation.
@@ -179,7 +502,7 @@ interface Shared {
   ];
 }
 
-interface Extension extends Shared {
+type HOTExtension = HOTShared & {
   /**
    * > **!! NOT YET AVAILABLE !!**
    * >
@@ -193,7 +516,7 @@ interface Extension extends Shared {
   client?: 'extension'
 }
 
-interface Inject extends Shared {
+type HOTInject = HOTShared & {
   /**
    * The type of client-side scripting method being used. If you are using the Syncify browser
    * extension then set this value to `extension`, otherwise use `inject`.
@@ -225,7 +548,7 @@ interface Inject extends Shared {
   layouts?: string[];
 }
 
-type HOT = Inject | Extension
+type HOT = HOTInject | HOTExtension
 
 /* -------------------------------------------- */
 /* LOGGER                                       */
@@ -260,10 +583,51 @@ interface Logger {
   clear?: boolean;
 }
 
+type StashType = string | number;
+
+/**
+ * Stash Reference
+ */
+type Stash = {
+  /**
+   * Set a stash import location for remote `pull` operations. Files which cannot
+   * be mapped to an existing project-level path location (relative to your `input`)
+   * will be written the provided stash destination defined here.
+   *
+   * > `*`
+   * >
+   * > asterisk value signals for stashes to be written within directory at index `0`
+   *
+   * > `number`
+   * >
+   * > number value will default to `*` and write within directories at that index.
+   *
+   * > `true`
+   * >
+   * > boolean `true` value signals for stashed to be written in `stash/` directory at index `0`
+   *
+   * ---
+   *
+   * You can optionally provide a sub-directory path.
+   *
+   */
+  stash: StashType;
+}
+
+/**
+ * String or Array of strings
+ */
+type Path = string | string[];
+
+/**
+ * Union join of accepted Path patterns
+ */
+type Pattern = Path | [ ...globs: string[], stash: Stash ];
+
 /**
  * Section and Snippet Rename Paths
  */
-interface RenamePaths$1<T = string | string[]> {
+type Rename = {
   /**
    * Uses the filename as per the source, idenitical behaviour as that of `[name]`.
    *
@@ -275,8 +639,9 @@ interface RenamePaths$1<T = string | string[]> {
    *      'sections/bar/*' // sections in this directory will prefix bar-
    *    ],
    *    '*': [
-   *      './sections/**'  // all other sections will use source name
-   *    ]
+   *      './sections/**',   // all other sections will use source name
+   *      { stash: 'files' } // stashes imports within sections/files
+   *    ],
    *   },
    *   snippets: {
    *    '[dir]-[name]': [
@@ -284,12 +649,13 @@ interface RenamePaths$1<T = string | string[]> {
    *      'snippets/bar/*' // snippets in this directory will prefix bar-
    *    ],
    *    '*': [
-   *      './snippets/**'  // all other snippets will use source name
+   *      './snippets/**',  // all other snippets will use source name
+   *      { stash: true }   // stashes will be written
    *    ]
    *   }
    * }
    */
-  '*'?: T;
+  '*'?: Pattern;
   /**
    * Use the filename as per the source. Passing `[name]` only will result in fallback
    * behaviour, as that of `'*'`.
@@ -321,38 +687,58 @@ interface RenamePaths$1<T = string | string[]> {
    *   }
    * }
    */
-  '[name]'?: T;
+  '[name]'?: Pattern;
   /**
    * Prefix directory name and suffix filename in **kebab-case** format.
    *
    * @example
    * 'layout/header.liquid' > 'layout-header.liquid'
    */
-  '[dir]-[name]'?: T;
+  '[dir]-[name]'?: Pattern;
   /**
    * Prefix directory name and suffix filename in **snake_case** format.
    *
    * @example
    * 'layout/header.liquid' > 'layout_header.liquid'
    */
-  '[dir]_[name]'?: T;
+  '[dir]_[name]'?: Pattern;
   /**
    * Prefix filename and suffix directory in **kebab-case** format.
    *
    * @example
    * 'layout/header.liquid' > 'header-layout.liquid'
    */
-  '[name]-[dir]'?: T;
+  '[name]-[dir]'?: Pattern;
   /**
    * Prefix filename and suffix directory in **snake_case** format.
    *
    * @example
    * 'layout/header.liquid' > 'header_layout.liquid'
    */
-  '[name]_[dir]'?: T;
+  '[name]_[dir]'?: Pattern;
+}
+
+/**
+ * Snippet Renames accept `.` separated values
+ */
+type RenameSnippets = Rename & {
+  /**
+   * Prefix filename and suffix directory with `.` dot separator.
+   *
+   * @example
+   * 'layout/header.liquid' > 'header.layout.liquid'
+   */
+  '[name].[dir]'?: Pattern;
+  /**
+   * Prefix directory and suffix filename with `.` dot separator.
+   *
+   * @example
+   * 'layout/header.liquid' > 'layout.header.liquid'
+   */
+  '[dir].[name]'?: Pattern;
 }
 
-interface Paths<T = string | string[]> {
+type Paths = {
   /**
    * A glob string, glob array or rename `output → input` key/value object of files to be uploaded as snippets.
    *
@@ -395,7 +781,7 @@ interface Paths<T = string | string[]> {
    *   }
    * }
    */
-  snippets?: T | Record<string, T> | RenamePaths$1<T>;
+  snippets?: Pattern | RenameSnippets
   /**
    * A glob string, glob array or rename `output → input` key/value object of files to be uploaded as sections.
    *
@@ -439,86 +825,129 @@ interface Paths<T = string | string[]> {
    *    ]
    *   }
    * }
+   *
+   * //OPTION 5 - Define a custom stash
+   * {
+   *   sections: [
+   *    'source/sections/*.liquid',
+   *    'source/sections/xxx/*',
+   *    { stash: '*' }  // pull stashes will write to source/sections/*
+   *   ]
+   * }
+   */
+  sections?: Pattern | Rename;
+  /**
+   * A glob string or glob array of files to be uploaded as blocks
+   *
+   * @default 'source/blocks/*.{liquid}'
    */
-  sections?: T | Record<string, T> | RenamePaths$1<T>;
+  blocks?: Pattern;
   /**
    * A glob string or glob array of files to be uploaded as templates.
    *
    * @default 'source/templates/*.{liquid,json}'
    */
-  templates?: T;
+  templates?: Pattern;
   /**
    * A glob string or glob array of files to be uploaded asas metaobject templates
    *
    * @default 'source/templates/metaobject/*.{liquid,json}'
    */
-  metaobject?: T;
+  metaobject?: Pattern;
   /**
    * A glob string or glob array of files to be uploaded as template/customers
    *
    * @default 'source/templates/customers/*.{liquid,json}'
    */
-  customers?: T;
+  customers?: Pattern;
   /**
    * A glob string or glob array of files to be uploaded as assets
    *
    * @default 'source/assets/*'
    */
-  assets?: T;
+  assets?: Pattern;
   /**
    * A glob string or glob array of files to be uploaded as layouts
    *
    * @default 'source/layout/*.liquid'
    */
-  layout?: T;
+  layout?: Pattern;
   /**
    * A glob string or glob array of files to be uploaded as configs, i.e, `settings_schema.json`
    *
    * @default 'source/config/.json'
    */
-  config?: T;
+  config?: Pattern;
   /**
    * A glob string or glob array of files to be uploaded as config, i.e, `en.default.json`
    *
    * @default 'source/locales/*.json'
    */
-  locales?: T;
+  locales?: Pattern;
   /**
    * A glob string or glob array of files to be uploaded as **shared schema** `.json` or `.schema` files.
    *
-   * @default 'source/schema/*.{json,schema}'
+   * @default 'source/+/schema/*.{json,schema}'
    */
-  schema?: T;
+  schema?: Path;
   /**
    * **NOT YET AVAILABLE**
    *
-   * > **This option will be available in later versions**
+   * **This option will be available in later versions**
    *
    * ---
    *
    * The resolved `metafields` directory path
    *
-   * @default 'source/metafields/'
+   * @default 'source/+/metafields/**'
    */
-  metafields?: T;
+  metafields?: Path;
   /**
+   * **NOT YET AVAILABLE**
+   *
+   * **This option will be available in later versions**
+   *
    * A glob string or glob array string to be uploaded, published and controlled as `pages`
    *
-   * @default 'source/pages/*.{md,html}'
+   * @default 'source/+/pages/*.{md,html}'
    */
-  pages?: T;
+  pages?: Path;
   /**
    * **NOT YET AVAILABLE**
    *
-   * > **This option will be available in later versions**
+   * **This option will be available in later versions**
    *
-   * ---
+   * @default 'source/+/blogs/*'
+   */
+  blogs?: Path;
+  /**
+   * **NOT YET AVAILABLE**
+   *
+   * **This option will be available in later versions**
+   *
+   * @default 'source/+/menus/*.json'
+   */
+  navigation?: Path;
+  /**
+   * **NOT YET AVAILABLE**
+   *
+   * **This option will be available in later versions**
+   *
+   * @default 'source/+/policies/*.{html,md}'
+   */
+  policies?: Path;
+  /**
+   * **NOT YET AVAILABLE**
+   *
+   * **This option will be available in later versions**
    *
-   * @default 'redirects.yaml'
+   * @default 'source/+/files/**'
    */
-  redirects?: `${string}.${'yaml' | 'yml'}`;
+  files?: Path;
 }
 
+type ScriptRename = `${'assets' | 'snippets'}/${string}`
+
 type TargetBrowser = (
   | 'chrome'
   | 'deno'
@@ -603,7 +1032,7 @@ type ESBuildAllowedOptions = Pick<BuildOptions, (
 )>
 
 
-type Target = (
+type ESBuildTarget = (
   | TargetBrowser
   | TargetBrowserVersion
   | TargetESVersion
@@ -636,7 +1065,7 @@ type ESBuildConfig = Merge<ESBuildAllowedOptions, {
 /* TRANSFORM                                    */
 /* -------------------------------------------- */
 
-interface ScriptSharedConfig {
+type ScriptSharedConfig = {
   /**
    * JS/TS input source paths. Accepts `string` or `string[]` glob patterns.
    * Resolution is relative to your defined `input` directory.
@@ -656,7 +1085,7 @@ interface ScriptSharedConfig {
    *
    * @default 'es2016'
    */
-  target?: Target | Target[];
+  target?: ESBuildTarget | ESBuildTarget[];
   /**
    * Instructs ESBuild to treat these modules as external. The import/s
    * will be preserved and evaluated at run time instead.
@@ -672,7 +1101,7 @@ interface ScriptSharedConfig {
   external?: string[];
   /**
    * Rename the JavaScript file/s. The same name as source file will be used
-   * when undefined. Accepts namespaces, `[file]`, `[dir]` and `[ext]`.
+   * when undefined. Accepts namespaces, `[file]` or `[name]`, `[dir]` and/or `[ext]`.
    *
    * ---
    *
@@ -744,7 +1173,7 @@ interface ScriptSharedConfig {
   esbuild?: boolean | ESBuildConfig;
 }
 
-interface ScriptFormatESM extends ScriptSharedConfig {
+type ScriptFormatESM = ScriptSharedConfig & {
 
   /**
    * The format to be generated. Because we are targeting
@@ -756,7 +1185,7 @@ interface ScriptFormatESM extends ScriptSharedConfig {
   format?: 'esm';
 }
 
-interface ScriptFormatIIFE extends ScriptSharedConfig {
+type ScriptFormatIIFE = ScriptSharedConfig & {
   /**
    * The format to be generated. Because we are targeting
    * browser environments, Syncify does not allow for CJS (commonjs)
@@ -787,13 +1216,11 @@ type ScriptTransformer = (
   | string[]
   | ScriptTransform
   | ScriptTransform[]
-  | { [rename: ScriptRename]: string | string[] | Omit<ScriptTransform, 'rename'> }
+  | Record<ScriptRename, string>
+  | Record<ScriptRename, string[]>
+  | Record<ScriptRename, Omit<ScriptTransform, 'rename'>>
 )
 
-/* eslint-disable no-unused-vars */
-
-
-
 /* -------------------------------------------- */
 /* PROCESSOR CONFIGS                            */
 /* -------------------------------------------- */
@@ -811,7 +1238,7 @@ type PostCSSConfig = (
 /**
  * Style Minification
  */
-interface StyleTerse extends OptionsOutput {
+type StyleTerse = OptionsOutput & {
  /**
   * Whether or not to purge unused CSS class names
   *
@@ -847,11 +1274,11 @@ interface StyleTerse extends OptionsOutput {
   exclude?: string[]
 }
 
-interface TailwindConfig extends Config$1 {
+type TailwindConfig = Config$1 & {
   config: string[]
 }
 
-interface SASSConfig {
+type SASSConfig = {
   /**
    * Whether or not to generate sourcemaps
    *
@@ -896,7 +1323,7 @@ interface SASSConfig {
 /* TRANSFORM                                    */
 /* -------------------------------------------- */
 
-interface StyleTransform<T = string | string[]> {
+type StyleTransform<T = string | string[]> = {
   /**
    * SVG input source paths. Accepts `string` or `string[]` glob patterns.
    * Resolution is relative to your defined `input` directory.
@@ -1019,7 +1446,7 @@ interface StyleTransform<T = string | string[]> {
    * > Uses [clean-css](https://github.com/clean-css/clean-css) minification
    * > Uses [purge-css](https://github.com/FullHuman/purgecss)
    */
-  terser?: boolean | SASSConfig;
+  terse?: boolean | SASSConfig;
 }
 
 /* -------------------------------------------- */
@@ -1031,33 +1458,18 @@ type StyleTransformer = (
   | string[]
   | StyleTransform
   | StyleTransform[]
-  | {
-    [K in StyleRename]: (
-      | string
-      | string[]
-      | Pick<StyleTransform,
-        | 'postcss'
-        | 'sass'
-        | 'tailwind'
-        | 'snippet'
-        | 'watch'
-        | 'input'
-      >
-    )
-  }
+  | Record<StyleRename, string>
+  | Record<StyleRename, string[]>
+  | Record<StyleRename, Pick<StyleTransform, 'postcss' | 'sass' | 'tailwind' | 'snippet' | 'watch' | 'input'>>
 )
 
-/* eslint-disable no-unused-vars */
-
-
-
 /* -------------------------------------------- */
 /* SHARED                                       */
 /* -------------------------------------------- */
 
 type RenamePaths = `${'assets' | 'snippets'}/${string}`
 
-interface SVGShared<T extends 'file' | 'sprite'> {
+type SVGFile = {
   /**
    * SVG input source paths. Accepts `string` or `string[]` glob patterns.
    * Resolution is relative to your defined `input` directory.
@@ -1065,6 +1477,24 @@ interface SVGShared<T extends 'file' | 'sprite'> {
    * @default ''
    */
   input: string | string[];
+  /**
+   * The SVG export format. Syncify can produce 2 different SVG formats.
+   * All SVG file types will pre-process and transform using [SVGO](https://github.com/svg/svgo).
+   * This option cannot be undefined and is required.
+   *
+   * ---
+   *
+   * > `file`
+   * >
+   * > SVG transforms using a `file` format will produce individual `.svg` files from
+   * that can be output as an`asset` or inlined into a `snippet`
+   *
+   * > `sprite`
+   * >
+   * > SVG transforms using a `sprite` format will produce an SVG Sprite that can be
+   * output as an `asset` or inlined into a `snippet`
+   */
+  format: 'file';
   /**
    * Rename the svg file/s. The same name as source file will be used
    * when undefined. Accepts namespaces, `[file]`, `[dir]` and `[ext]`.
@@ -1084,44 +1514,6 @@ interface SVGShared<T extends 'file' | 'sprite'> {
    * @default false
    */
   snippet?: boolean;
-  /**
-   * The SVG export format. Syncify can produce 2 different SVG formats:
-   *
-   * You can omit this option when you have only 1 pre-processor installed or
-   * if you are applying a per-transfrom configuration override as it will default
-   * to the format which the inferred pre-processor produces. If you are using
-   * both the supported processors ([SVGO](https://github.com/svg/svgo) &
-   * [SVG Sprite](https://github.com/svg-sprite)) then you will need
-   * to inform Syncify on which format it should produce.
-   *
-   * ---
-   *
-   * **File Format**
-   *
-   * _SVG transforms using a `file` format require SVGO to be installed. File
-   * formats will produce individual `.svg` files from that can be output as
-   * an`asset` or inlined into a `snippet`_
-   *
-   * ---
-   *
-   * **Sprite Format**
-   *
-   * _SVG transforms using a `sprite` format require SVG Sprite to be installed.
-   * Sprite formats will produce an SVG Sprite that can be output as an `asset`
-   * or inlined into a `snippet`_
-   *
-   * ---
-   *
-   * @default
-   * undefined   // When no SVG pre-processor is installed
-   * null        // When both SVGO and SVG Sprite are installed (required)
-   * 'file'      // When SVGO is the only processor installed
-   * 'sprite'    // When SVG Sprite is the only processor installed
-   */
-  format?: LiteralUnion<T, string>;
-}
-
-interface SVGFile extends SVGShared<'file'> {
   /**
    * [SVGO](https://github.com/svg/svgo) Override
    *
@@ -1133,35 +1525,125 @@ interface SVGFile extends SVGShared<'file'> {
    * @default
    * processor.svgo // When processor configuration is defined
    */
-  svgo?: Config$2
+  svgo?: Config$2;
 }
 
-interface SVGSprite extends SVGShared<'sprite'> {
+type SVGSprite = Omit<SVGFile, 'format'> & {
   /**
-   * [SVG Sprite](https://github.com/svg-sprite) Override
+   * The SVG export format. Syncify can produce 2 different SVG formats.
+   * All SVG file types will pre-process and transform using [SVGO](https://github.com/svg/svgo).
+   * This option cannot be undefined and is required.
    *
-   * SVG Sprite transforms will use the options provided to `processor.sprite`
-   * but you can optionally override those defaults on a per-transform
-   * basis. Any configuration options defined here will be merged with
-   * the options defined in `processor.sprite`.
+   * ---
    *
-   * @default
-   * processor.sprite // When processor configuration is defined
+   * > `file`
+   * >
+   * > SVG transforms using a `file` format will produce individual `.svg` files from
+   * that can be output as an`asset` or inlined into a `snippet`
+   *
+   * > `sprite`
+   * >
+   * > SVG transforms using a `sprite` format will produce an SVG Sprite that can be
+   * output as an `asset` or inlined into a `snippet`
    */
-  sprite?: Config$3
+  format: 'sprite';
+  /**
+   * Add a DOCTYPE declaration to SVG documents
+   *
+   * @type {boolean}
+   */
+  sprite?: {
+    /**
+     * Apply a custome set of sprite attributes on the
+     * parent `<svg>` element containing the `<symbol>` reference.
+     *
+     * **Example Definition**
+     *
+     * ```js
+     * // Attribute definitions
+     * {
+     *   attrs: [
+     *    ['id', 'foo']
+     *    ['data-attr', 'bar'],
+     *    ['{{ object.prop }}'],
+     *    ['{% if xxx %}', 'data-xxx', '{% endif %}']
+     *   ]
+     * }
+     * ```
+     *
+     * **Example Output**
+     *
+     * ```liquid
+     * <svg
+     *  id="foo"
+     *  data-attr="bar"
+     *  {{ object.prop }}
+     *  {% if xxx %}data-xxx{% endif %}>
+     *    <symbol id="a">....</symbol>
+     *    <symbol id="b">....</symbol>
+     *    <symbol id="c">....</symbol>
+     * </svg>
+     * ```
+     *
+     * // Output
+     * @default []
+     */
+    attrs?: Array<string[]>;
+    /**
+     * Additional optional to be applied on containing `<symbol>`
+     * elements in the sprite.
+     */
+    symbols?: {
+      /**
+       * The identifier applied to `<symbol>` elements. This
+       * value will be the `<use>` referenced via `xlink:href`.
+       * By default, Syncify prefixes `svg-` followed by SVG filename.
+       *
+       * > `[id]`
+       * >
+       * > Passing a value of `[id]` will instruct syncify to use the `id=""` value
+       * > already applied and when missing fallback to the default `svg-`
+       *
+       *
+       * **Example**
+       *
+       * ```liquid
+       * <!-- REFERENCING -->
+       * <svg><use xlink:href="#svg-a"></use></svg>
+       * <svg><use xlink:href="#svg-b"></use></svg>
+       * <svg><use xlink:href="#svg-c"></use></svg>
+       *
+       * <!-- EXAMPLE SPRITE -->
+       * <svg>
+       *  <symbol id="a">...</symbol>
+       *  <symbol id="b">...</symbol>
+       *  <symbol id="c">...</symbol>
+       * </svg>
+       * ```
+       */
+      id?: LiteralUnion<`${string}-[name]` | `[name]-${string}` | '[id]', string>;
+      /**
+       * Whether or not containing `<symbol>` elements should be annotated
+       * with `xmlns` attributes. Defaults to `false`.
+       *
+       * **Example Output**
+       *
+       * ```liquid
+       * <svg>
+       *  <symbol id="a" xmlns="http://www.w3.org/2000/svg">...</symbol>
+       *  <symbol id="b" xmlns="http://www.w3.org/2000/svg">...</symbol>
+       *  <symbol id="c" xmlns="http://www.w3.org/2000/svg">...</symbol>
+       * </svg>
+       * ```
+       *
+       * @default false
+       */
+      xmlns?: boolean;
+    }
+  }
 }
 
-/* -------------------------------------------- */
-/* TRANSFORM                                    */
-/* -------------------------------------------- */
-
-/**
- * SVG processing transforms
- */
-type SVGTransform = (
-  | SVGFile
-  | SVGSprite
-)
+type SVGTransform = SVGFile | SVGSprite
 
 /* -------------------------------------------- */
 /* TRANSFORMER                                  */
@@ -1172,14 +1654,9 @@ type SVGTransformer = (
   | string[]
   | SVGTransform
   | SVGTransform[]
-  | {
-    [K in RenamePaths]: (
-      | string
-      | string[]
-      | Pick<SVGFile, 'format' | 'input' | 'snippet' | 'svgo'>
-      | Pick<SVGSprite, 'format'| 'input'| 'snippet' | 'sprite'>
-    )
-  }
+  | Record<RenamePaths, string>
+  | Record<RenamePaths, string[]>
+  | Record<RenamePaths, SVGTransform>
 )
 
 /**
@@ -1187,7 +1664,7 @@ type SVGTransformer = (
  *
  * Holds reference to default config options for each supported processor.
  */
-interface Processors {
+type Processors = {
   /**
    * [ESBuild](https://esbuild.github.io/) Config
    */
@@ -1208,60 +1685,23 @@ interface Processors {
    * [SVGO](https://github.com/svg/svgo) Config
    */
   svgo?: Config$2;
-  /**
-   * [SVG Sprite](https://github.com/svg-sprite) Config
-   */
-  sprite?: Config$3;
   /**
    * [Markdown](https://github.com/markdown-it/markdown-it) Config
    */
   markdown?: Options;
-  /**
-   * [Turndown](https://github.com/mixmark-io/turndown) Config
-   */
-  turndown?: Config$3;
 }
 
 interface Publishing {
   /**
-   * Set the publishment role to use - This defaults to `unpublished`
-   * which means theme publishes will not be made pushed live.
-   *
-   * `main`
-   *
-   * The theme is published. Customers see it when they visit the online store.
-   *
-   * `unpublished`
-   *
-   * The theme is unpublished. Customers can't see it.
-   *
-   * `development`
-   *
-   * The theme is used for development. The theme can't be published, and is temporary.
-   *
-   * @default 'unpublished'
-   */
-  role?: 'main' | 'unpublished' | 'development';
-  /**
-   * **NOT YET AVAILABLE**
-   *
-   * Bind theme version with the `settings_schema.json` version.
-   *
-   * @default false
-   */
-  branches?: string[]
-  /**
-   * Limit the amount of new theme publishments.
-   *
-   * @default 3
+   * Git publish
    */
-  themeLimit?: number;
+  git: Git;
 }
 
 /**
  * JSON File Minification
  */
-interface JSONTerse {
+type JSONTerse = {
   /**
    * Minify `.json` files writing to `theme/assets`
    *
@@ -1312,7 +1752,7 @@ interface JSONTerse {
   exclude?: string[]
 }
 
-interface JSONTransform {
+type JSONTransform = {
   /**
    * If line termination should be Windows (CRLF) format.
    * Unix (LF) format is the default.
@@ -1344,17 +1784,40 @@ interface JSONTransform {
    * Whether or not Syncify should apply alpha-numeric sorting to object properties
    * or not. This will apply deep sorting, so all objects within a structure will adhere.
    *
+   * Apply object sorting on a specific list of entries in the JSON structure. Target deeply nested
+   * property objects and their values using dot `.` separated expressions by passing sting list.
+   *
+   * ```js
+   * { sortObjects: ['a.b'] } // sort only these objects
+   *
+   * // BEFORE
+   * { a: { b: { z: '2', x: '1' } }, c: { b: '2', a: '1' } }
+   *
+   * // AFTER
+   * { a: { b: { x: '1', z: '2', } }, c: { b: '2', a: '1' } }
+   * ```
+   *
+   * @default false
+   */
+  sortObjects?: boolean | string[];
+  /**
+   * Whether or not Syncify should apply alpha-numeric sorting to arrays in JSON.
+   * You should avoid setting this to `true` and use with caution.
+   *
+   * Apply array sorting on a specific list of entries in the JSON structure. Target deeply nested
+   * properties and their values using dot `.` separated expressions by passing sting list.
+   *
    * @default false
    */
-  sortObjects?: boolean;
+  sortArrays?: boolean | string[];
   /**
    * Define a list of property names with object values that should be excluded and skipped
-   * from sorting. This option only applies when `sortObjects` is set to `true` and will
-   * have no effect if `sortObjects` is not enabled.
+   * from sorting. This option only applies when `sortObjects` and/or `sortArrays` is set to
+   * `true` and will have no effect if `sortObjects` and/or `sortArrays` is not enabled.
    *
    * @default []
    */
-  sortExclude?: string[];
+  noSortList?: string[];
   /**
    * An optional string list of paths/filenames to exclude
    * from processing, ie: pass through
@@ -1375,11 +1838,11 @@ interface JSONTransform {
   terse?: boolean | JSONTerse;
 }
 
-interface LiquidTerse {
+type LiquidTerse = {
   /**
    * Removes redundant whitespace Liquid dash trims from Liquid tags and objects.
    *
-   * @default true
+   * @default false
    */
   stripTrims?: boolean;
   /**
@@ -1423,7 +1886,7 @@ interface LiquidTerse {
 /**
  * Liquid Minification
  */
-interface LiquidTransform {
+type LiquidTransform = {
   /**
    * Liquid and HTML minification options. By default, the option is set to `false`
    * which disables minification being applied to `.liquid` file types. Setting
@@ -1441,7 +1904,7 @@ interface LiquidTransform {
 /* TRANSFORMS                                   */
 /* -------------------------------------------- */
 
-interface Transforms {
+type Transforms = {
   /**
    * ###### [DOCUMENTATION](https://syncify.sh/options/transform/style/)
    *
@@ -1619,10 +2082,21 @@ interface Transforms {
    * > If this option is set to `false` then no minification will be applied to `.liquid` files.
    */
   liquid?: LiquidTransform;
+  /**
+   * ###### [DOCUMENTATION](https://syncify.sh/options/transform/svg/)
+   *
+   * **Markdown File Transforms**
+   *
+   * Supported markdown transforms accepted for resource specific operations.
+   */
+  markdown?: SVGTransformer;
 
 }
 
-interface Versioning {
+/**
+ * Version Control
+ */
+type VC = {
   /**
    * Sets the maximum patch number before incrementing the minor version. Passing a value of `0` will
    * result in **minor** version increments only.
@@ -1677,6 +2151,7 @@ interface Config extends Directories {
   editor?: LiteralUnion<
     | 'vscode'
     | 'sublime'
+    | 'cursor'
     | 'atom'
     | 'webstorm'
     | 'intellij'
@@ -1694,8 +2169,10 @@ interface Config extends Directories {
   paths?: Paths;
   /**
    * **NOT YET AVAILABLE**
+   *
+   * > Syncify plugins are planned in future releases!
    */
-  plugins?: any;
+  plugins?: never;
   /**
    * **Clean**
    *
@@ -1724,41 +2201,23 @@ interface Config extends Directories {
    */
   publish?: Publishing;
   /**
-   * **Spawn**
+   * **Git**
    *
-   * Spawn child process
+   * Git automation and workflow configuration for controlling the integration pipline. Settings
+   * defined here will be used to provide a streamlines tactic for theme publishing, version
+   * control and source control.
    */
-  spawn?: {
-    /**
-     * Processes to spawn when running **build** mode, ie: `--build` or `-b`
-     *
-     * @default {}
-     *
-     * @example
-     *
-     * {
-     *   build: {
-     *    rollup: 'rollup -c',
-     *    gulp: ['gulp', 'build-task'] // can also use arrays
-     *  }
-     * }
-     */
-    build?: { [target: string]: string | string[] };
-    /**
-     * Processes to spawn when running **watch** mode, ie: `--watch` or `-w`
-     *
-     * @default {}
-     *
-     * @example
-     * {
-     *   build: {
-     *    rollup: 'rollup -c --watch',
-     *    gulp: ['gulp', 'watch-task'], // can also use arrays
-     *  }
-     * }
-     */
-    watch?: { [target: string]: string | string[] }
-  };
+  git?: false | Git
+  /**
+   * **Version Control**
+   *
+   * Syncify introduces a strategic version control system based on the Modular Arithmetic Model (**MaM**),
+   * a unique approach inspired by, but distinct from, [SemVer](https://semver.org/). The MaM tactic in
+   * its appropriation by Syncify to Theme development is designed around the idea that progression should
+   * be predictive and controlled. The [Version Control](https://syncify.sh/usage/version-control/) documentation
+   * guide provides a strong overview for how Syncify applies versioning to themes.
+   */
+  vc?: false | VC
   /**
    * **Transform**
    *
@@ -1773,16 +2232,6 @@ interface Config extends Directories {
    * which syncify has pre-configured for optimal output.
    */
   processor?: Processors;
-  /**
-   * **Version Control**
-   *
-   * Syncify introduces a strategic version control system based on the Modular Arithmetic Model (**MaM**),
-   * a unique approach inspired by, but distinct from, [SemVer](https://semver.org/). The MaM tactic in
-   * its appropriation by Syncify to Theme development is designed around the idea that progression should
-   * be predictive and controlled. The [Version Control](https://syncify.sh/usage/version-control/) documentation
-   * guide provides a strong overview for how Syncify applies versioning to themes.
-   */
-  versioning?: Versioning
 }
 
 /**
@@ -1812,4 +2261,4 @@ declare const env: {
  */
 declare const defineConfig: (config: Config) => Config;
 
-export { type Config, type Directories, type ESBuildConfig, type HOT, type JSONTerse, type JSONTransform, type LiquidTerse, type LiquidTransform, type Logger, type Paths, type PostCSSConfig, type Processors, type Publishing, type RenamePaths$1 as RenamePaths, type SASSConfig, type SVGFile, type SVGSprite, type SVGTransform, type SVGTransformer, type ScriptTransform, type ScriptTransformer, type StyleTerse, type StyleTransform, type StyleTransformer, type TailwindConfig, type Target, type Transforms, type Versioning, defineConfig, env };
+export { type Config, type Directories, type ESBuildConfig, type ESBuildTarget, type Git, type HOT, type JSONTerse, type JSONTransform, type LiquidTerse, type LiquidTransform, type Logger, type Paths, type Pattern, type PostCSSConfig, type Processors, type Publishing, type Rename, type SASSConfig, type SVGFile, type SVGSprite, type SVGTransform, type SVGTransformer, type ScriptTransform, type ScriptTransformer, type Stash, type StyleTerse, type StyleTransform, type StyleTransformer, type TailwindConfig, type Transforms, type VC, defineConfig, env };