@syncify/cli 0.2.4-beta → 0.3.0-beta

package/types/api.d.ts

@@ -1,7 +1,7 @@
 import { PartialDeep } from 'type-fest';
 import { Config } from './config';
-import { Asset } from './internal/requests';
-import { File } from './internal/file';
+import { Asset } from './bundle/requests';
+import { File } from './bundle/file';
 
 type Download = (
   this: {

package/types/bundle/cache.d.ts

@@ -0,0 +1,101 @@
+import { Requests, Resource } from './requests';
+
+export interface Cache {
+  /**
+   * The Syncify version - cache will be purged and reset when changed
+   */
+  version?: string;
+  /**
+   * The last time cache was updated at (timestamp)
+   */
+  updated?: number;
+  /**
+   * The last time a build was executed
+   */
+  lastBuild?: number;
+  /**
+   * The last time a build was executed
+   */
+  lastResource?: Resource;
+ /**
+  * Cache Build File
+  *
+  * @default 'node_modules/.syncify/build.map'
+  */
+  uri?: string;
+  /**
+   * Sourcemap directories for transforms
+   */
+  sourcemaps?: {
+     /**
+     * JavaScript sourcemaps
+     *
+     * @default 'node_modules/.syncify/sourcemaps/script/'
+     */
+     script: string;
+     /**
+      * Stylesheet sourcemaps
+      *
+      * @default 'node_modules/.syncify/sourcemaps/script/'
+      */
+     style: string;
+  }
+  /**
+   * Output > Input Source Path Mapping
+   *
+   * Holds reverse references between input and output
+   * directories. Used when executing `upload` mode.
+   *
+   * > **NOTE**
+   * >
+   * > This cache reference will update each time build mode runs.
+   */
+  maps?: {
+    /**
+     * The output path pointing to input path
+     *
+     * `key`
+     * - _The output path_
+     *
+     * `value`
+     * - _The input path_
+     */
+    [outputFileURI: string]: string;
+  },
+  /**
+   * Page related cache records, this reference typically
+   * holds `path > id` object references. Page ids are
+   * cached for lookup when changes occur.
+   */
+  pages?: {
+    /**
+     * The store domain name containing the pages, eg: `syncify` would
+     * equate to `syncify.myshopify.com`.
+     */
+    [myshopifyDomain: string]: {
+      /**
+       * The page id, as property and the page payload reference as value.
+       */
+      [pageId: number]: Requests.Page
+    }
+  },
+  /**
+   * Metafields related cache records. Metafield source maps
+   * are `path > id` object references. Metafield ids are
+   * cached for lookup when changes occur. The `map` object
+   * holds the references and applied to model on initialization.
+   */
+  metafields?: {
+    /**
+     * The store domain name containing the pages, eg: `syncify` would
+     * equate to `syncify.myshopify.com`.
+     */
+    [myshopifyDomain: string]: {
+      /**
+       * Metafield pathname > id cache references..
+       */
+      [inputFileUri: string]: Requests.Page
+    }
+  }
+
+}

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

@@ -114,6 +114,29 @@ export interface HOTBundle {
    * @default 'hot'
    */
   method?: 'hot' | 'refresh';
+  /**
+   * The HOT strategy to use. Syncify supports 2 different
+   * replacement strategies and you will need choose which one
+   * to use depending on your project type.
+   *
+   *
+   * **hydrate**
+   *
+   * _The hydrate strategy will execute morph replacements. This is what Syncify
+   * will default to, however it is not always perfect and in cases where you leverage
+   * frameworks that use DOM Mutation observers, it probably better to use `replace`_
+   *
+   * **replace**
+   *
+   * _The replace strategy will execute fragment swaps use `replaceWith` instead of morphs
+   * when executing HOT reloads. It works almost identical to `hydrate` but respects DOM
+   * mutations. If you are leveraging a framework like Stimulus or Alpine, then choose this
+   * strategy._
+   *
+   *
+   * @default 'hydrate'
+   */
+  strategy?: 'hydrate' | 'replace';
   /**
    * Scroll position between reloads
    *
@@ -131,7 +154,7 @@ export interface HOTBundle {
    * The hot reload inline snippet script URI location
    *
    * @default
-   * 'node_modules/@syncify/syncify/hot.js.liquid'
+   * 'node_modules/@syncify/cli/hot.js.liquid'
    */
   snippet?: string;
   /**
@@ -155,6 +178,7 @@ export type HOTConfig = Pick<HOTBundle,
   | 'label'
   | 'layouts'
   | 'method'
+  | 'strategy'
   | 'server'
   | 'socket'
   | 'scroll'

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

@@ -3,10 +3,9 @@
 import type { Tester } from 'anymatch';
 import type { Config as TailwindProcessor } from 'tailwindcss';
 import type { Merge } from 'type-fest';
-import type { Markdown } from './markdown';
 import type { AxiosRequestConfig } from 'axios';
-import type { ESBuildProcesser, ScriptBundle } from '../transforms/script';
-import type { SASSProcesser, PostCSSProcesser, StyleBundle } from '../transforms/style';
+import type { ESBuildProcesser } from '../transforms/script';
+import type { SASSProcesser, PostCSSProcesser } from '../transforms/style';
 import type { SVGOProcesser, SVGSpriteProcesser } from '../transforms/svg';
 import type { JSONBundle } from '../transforms/json';
 import type { FSWatcher } from 'chokidar';
@@ -394,6 +393,12 @@ export interface ConfigFile {
 export type SectionBundle = Merge<Config.Views['sections'], {
   global: RegExp;
   paths?: Tester;
+  /**
+   * Base directory name used for matching on directory prefixes
+   * The base directory name will equate to the last known directory
+   * before a glob pattern or file reference.
+   */
+  baseDir: Set<string>;
 }>
 
 /* -------------------------------------------- */
@@ -408,6 +413,12 @@ export type SectionBundle = Merge<Config.Views['sections'], {
 export type SnippetBundle = Merge<Config.Views['snippets'], {
   global: RegExp;
   paths?: Tester;
+ /**
+  * Base directory name used for matching on directory prefixes
+  * The base directory name will equate to the last known directory
+  * before a glob pattern or file reference.
+  */
+  baseDir: Set<string>;
 }>
 
 /* -------------------------------------------- */
@@ -423,19 +434,97 @@ export type PathsBundle = Merge<Config.Paths<Tester>, {
   transforms?: Map<string, 7 | 8 | 9>
 }>;
 
-/* -------------------------------------------- */
-/* PAGES                                        */
-/* -------------------------------------------- */
+export type PathsRef = {
+  /**
+   * Set of all resolved paths;
+   */
+  input: Set<string>;
+  /**
+   * Anymatch tester of all resolved paths
+   */
+  match: Tester;
+};
 
-/**
- * **INTERNAL USE**
- *
- * Page configuration
- */
-export type PagesBundle = Merge<Config.Views['pages'], {
-  import: Markdown.Import;
-  export: Markdown.Export
-}>
+export interface PathBundle {
+  /**
+   * Resolved match and path references uploaded as assets
+   *
+   * @default 'source/assets'
+   */
+  assets?: PathsRef
+  /**
+   * Resolved match and path references uploaded as snippets
+   *
+   * @default 'source/snippets'
+   */
+  snippets?: PathsRef
+  /**
+   * Resolved match and path references uploaded as sections
+   *
+   * @default 'source/sections'
+   */
+  sections?: PathsRef
+  /**
+   * Resolved match and path references uploaded as layouts
+   *
+   * @default 'source/layout'
+   */
+  layout?: PathsRef
+  /**
+   * Resolved match and path references uploaded as templates
+   *
+   * @default 'source/templates'
+   */
+  templates?: PathsRef
+  /**
+   * Resolved match and path references uploaded as template/metaobject
+   *
+   * @default 'source/templates/metaobjects'
+   */
+  metaobject?: PathsRef
+  /**
+   * Resolved match and path references uploaded as template/customers
+   *
+   * @default 'source/templates/customers'
+   */
+  customers?: PathsRef
+  /**
+   * Resolved match and path references uploaded as configs
+   *
+   * @default 'source/config'
+   */
+  config?: PathsRef
+  /**
+   * Resolved match and path references uploaded as locales
+   *
+   * @default 'source/locales'
+   */
+  locales?: PathsRef
+  /**
+   * The resolved `metafields` directory path
+   *
+   * @default 'source/metafields'
+   */
+  metafields?: PathsRef
+  /**
+   * The resolved `pages` directory path
+   *
+   * @default 'source/pages'
+   */
+  pages?: PathsRef
+  /**
+   * The resolved `redirects` yaml file
+   *
+   * @default 'redirects.yaml'
+   */
+  redirects?: PathsRef
+  /**
+   * Special Transforms reference
+   *
+   * @default 'source/assets'
+   */
+  transforms?: Map<string, 7 | 8 | 9>
+}
 
 /* -------------------------------------------- */
 /* WATCH                                        */
@@ -465,6 +554,7 @@ export type WatchBundle = Merge<FSWatcher, {
    * Returns all watched paths
    */
   get paths (): string[]
+
 }>;
 
 /* -------------------------------------------- */
@@ -481,33 +571,33 @@ export interface ProcessorsBundle {
   /**
    * JSON processing
    */
-  json: JSONBundle;
+  json?: JSONBundle;
   /**
    * [PostCSS](https://postcss.org/) Pre-Processor
    */
-  postcss: PostCSSProcesser;
+  postcss?: PostCSSProcesser;
   /**
    * [SASS Dart](https://sass-lang.com/documentation/js-api/) Pre-Processor
    */
-  sass: SASSProcesser;
+  sass?: SASSProcesser;
   /**
    * [TailwindCSS](https://tailwindcss.com/) Pre-Processor
    */
-  tailwind: TailwindProcessor;
+  tailwind?: TailwindProcessor;
   /**
    * [Sharp](https://sharp.pixelplumbing.com) Pre-Processor
    */
-  sharp: any;
+  sharp?: any;
   /**
    * [SVG Sprite](https://github.com/svg-sprite) Pre-Processor
    */
-  sprite: SVGSpriteProcesser;
+  sprite?: SVGSpriteProcesser;
   /**
    * [SVGO](https://github.com/svg/svgo) Pre-Processor
    */
-  svgo: SVGOProcesser
+  svgo?: SVGOProcesser
   /**
    * [ESBuild](https://esbuild.github.io/) Pre-Processor
    */
-  esbuild: ESBuildProcesser
+  esbuild?: ESBuildProcesser
 }

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

@@ -1,5 +1,28 @@
 import { AxiosRequestConfig } from 'axios';
 import { File, FileKeys } from './file';
+import { LiteralUnion } from 'type-fest';
+
+/**
+ * Metafield Types
+ */
+export type MetafieldTypes = LiteralUnion<(
+  | 'boolean'
+  | 'color'
+  | 'date'
+  | 'date_time'
+  | 'dimension'
+  | 'json'
+  | 'money'
+  | 'multi_line_text_field'
+  | 'number_decimal'
+  | 'number_integer'
+  | 'rating'
+  | 'rich_text_field'
+  | 'single_line_text_field'
+  | 'url'
+  | 'volume'
+  | 'weight'
+), string>
 
 /**
  * Axios Request Methods
@@ -33,6 +56,7 @@ export type ChokidorEvents = 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir
 export type GetAsset = (
   `templates/${string}${'.liquid' | '.json'}` |
   `templates/customer/${string}${'.liquid' | '.json'}` |
+  `templates/metaobject/${string}${'.liquid' | '.json'}` |
   `assets/${string}` |
   `sections/${string}${'-group.json' | '.liquid'}` |
   `snippets/${string}${'.liquid'}` |
@@ -137,6 +161,30 @@ export interface Asset {
   theme_id?: number;
 }
 
+export interface PageMetafield {
+  /**
+   * An identifier for the metafield. (maximum: 30 characters)
+   */
+  key: string;
+  /**
+   * The information to be stored as metadata.
+   */
+  type: MetafieldTypes;
+  /**
+   * The information to be stored as metadata.
+   */
+  value: string;
+  /**
+   * A container for a set of metadata. Namespaces help distinguish
+   * between metadata created by different apps. (maximum: 20 characters)
+   */
+  namespace:string;
+  /**
+   * Additional information about the metafield.
+   */
+  description?: string;
+}
+
 export namespace Requests {
 
   /**
@@ -168,23 +216,61 @@ export namespace Requests {
   /* -------------------------------------------- */
 
   export interface Page {
+    /**
+     * The name of the person who created the page.
+     */
     author?: string;
+    /**
+     * The text content of the page, complete with HTML markup.
+     */
     body_html?: string;
-    created_at?: string;
+    /**
+     * The date and time (ISO 8601 format) when the page was created.
+     */
+    readonly created_at?: string;
+    /**
+     * A unique, human-friendly string for the page,
+     * generated automatically from its title. In themes, the Liquid templating language refers to a page by its handle.
+     */
     handle?: string;
+    /**
+     * The unique numeric identifier for the page.
+     */
     id?: number;
-    metafield?: {
-      key: string;
-      type: string;
-      value: string;
-      namespace:string;
-    },
+    /**
+     * Additional information attached to the Page object.
+     */
+    metafields?: PageMetafield | PageMetafield[];
+    /**
+     * The date and time (ISO 8601 format) when the page was published.
+     * Returns null when the page is hidden.
+     */
     published_at?:string;
+    /**
+     * Published boolean
+     */
+    published?: boolean;
+    /**
+     * The ID of the shop to which the page belongs.
+     */
     shop_id?: number
+    /**
+     * The suffix of the template that is used to render the page.
+     * If the value is an empty string or null, then the default page template is used.
+     */
     template_suffix?: string;
+    /**
+     * The title of the page.
+     */
     title?: string;
+    /**
+     * The date and time (ISO 8601 format) when the page was last updated.
+     */
     updated_at?: string;
-
+    /**
+     * The GraphQL GID of the page.
+     */
+    readonly admin_graphql_api_id?: string
   }
   /* -------------------------------------------- */
   /* METAFIELDS                                   */
@@ -213,7 +299,7 @@ export namespace Requests {
     /**
      * Type is JSON
      */
-    type?: 'json';
+    type?: MetafieldTypes;
     /**
      * Value Type (this is legacy but we assert it anyway)
      */

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

@@ -96,7 +96,7 @@ export namespace ENV {
   export type RCSecrets = RCSecret[]
 
   /**
-   * Auth using `token` in `.syncifyrc` file
+   * Auth using `token` in `.env.syncify.json` file
    *
    * > _Single store_
    */

package/types/cli.d.ts

@@ -190,6 +190,12 @@ export interface Commands {
    * ```
    */
   export?: boolean;
+  /**
+   * Triggers a resource mode
+   *
+   * @default ''
+   */
+  resource?: string;
    /**
    * Download a theme from a store. Will be place in `import` driectory. Requires a store
    * target and theme target to be passed.

package/types/config/index.d.ts

@@ -1,11 +1,12 @@
 /* eslint-disable no-unused-vars */
 
-import type { Pages, Sections, Snippets } from './views';
-import type { HOTConfig } from '../internal/hot';
-import type { ScriptTerse, JSONTerse, ViewTerse } from './terser';
-import type { PluginHooks } from '../internal/plugin';
+import type { Sections, Snippets } from './views';
+import type { HOTConfig } from '../bundle/hot';
+import type { ScriptTerse, JSONTerse, MarkupTerse, LiquidTerse } from './terser';
+import type { PluginHooks } from '../bundle/plugin';
 import type { JSONConfig } from '../transforms/json';
 import type { SharpConfig } from '../transforms/image';
+import type { PagesConfig } from '../transforms/pages';
 import type { ScriptTransformer, ESBuildConfig } from '../transforms/script';
 import type { StyleTransformer, SASSConfig, PostCSSConfig } from '../transforms/style';
 import type { SVGTransformer, SVGOConfig, SVGSpriteConfig } from '../transforms/svg';
@@ -69,7 +70,7 @@ export interface Views {
   /**
    * Static page handling
    */
-  pages?: Pages;
+  pages?: PagesConfig;
   /**
    * Snippet file handling (ie: sub-directory grouping)
    */
@@ -245,7 +246,17 @@ export interface Terser {
    * of options are exposed in order to prevent invalid or broken
    * output from being generated.
    */
-  views?: boolean | ViewTerse;
+  liquid?: boolean | LiquidTerse;
+  /**
+   * View minification options. You can disable all views from
+   * being minified by passing a boolean `false`.
+   *
+   * Syncify uses HTML Minifier Terser under the hood, it has been
+   * configured to work with Liquid files so only a limited number
+   * of options are exposed in order to prevent invalid or broken
+   * output from being generated.
+   */
+  markup?: boolean | MarkupTerse;
   /**
    * JavaScript minification options. Script minification is only
    * available for projects with `esbuild` installed and configured
@@ -301,7 +312,7 @@ export interface Stores {
    * structure. The `key` values represent target names that
    * will be used in the CLI.
    */
-  themes: { [target: string]: number; }
+  themes: { [target: string]: number }
 }
 
 /* -------------------------------------------- */
@@ -340,19 +351,11 @@ export interface Directories {
    */
   config?: string;
   /**
-   * The resolved `pages` directory path, if multiple paths
-   * are defined the value will be an array list.
+   * The resolved `cache` directory path for build tool files
    *
-   * @default '/source/pages/'
+   * @default 'node_modules/.syncify/'
    */
-  pages?: string;
-  /**
-   * The resolved `metafields` directory path, if multiple paths
-   * are defined the value will be an array list.
-   *
-   * @default '/source/metafields/'
-   */
-  metafields?: string | string[]
+  cache?: string;
 }
 
 /* -------------------------------------------- */
@@ -390,6 +393,12 @@ export interface Paths<T = string | string[]> {
    * @default 'source/templates'
    */
   templates?: T
+  /**
+   * An array list of files to be uploaded as metaobject templates
+   *
+   * @default 'source/templates/metaobject'
+   */
+  metaobject?: T
   /**
    * An array list of files to be uploaded as template/customers
    *
@@ -409,6 +418,12 @@ export interface Paths<T = string | string[]> {
    */
   locales?: T
   /**
+   * **NOT YET AVAILABLE**
+   *
+   * > **This option will be available in later versions**
+   *
+   * ---
+   *
    * The resolved `metafields` directory path
    *
    * @default 'source/metafields'
@@ -421,7 +436,11 @@ export interface Paths<T = string | string[]> {
    */
   pages?: T
   /**
-   * The resolved `redirects` yaml file
+   * **NOT YET AVAILABLE**
+   *
+   * > **This option will be available in later versions**
+   *
+   * ---
    *
    * @default 'redirects.yaml'
    */
@@ -435,11 +454,11 @@ export interface Paths<T = string | string[]> {
 /**
  * The Configuration model
  */
-export interface Config extends Directories {
+export interface Config<T = Stores> extends Directories {
   /**
    * Define your Shopify store/s and thier theme/s
    */
-  stores: Stores | Stores[];
+  stores: T | Stores | Stores[];
   /**
    * Define customize input structures - Paths resolve to `input`
    */
@@ -524,7 +543,8 @@ export interface Config extends Directories {
   terser?: boolean | Terser;
   /**
    * @deprecated
-   *  Use `terser` option instead
+   *
+   * Use `terser` option instead
    */
   minify?: undefined;
 }