@syncify/cli 0.1.0-beta

package/schema/syncify.env.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "syncify",
+  "version": 1.1,
+  "definitions": {
+    "schema": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "domain": {
+              "description": "The shop domain",
+              "type": "string",
+              "default": "your-store.myshopify.com"
+            },
+            "key": {
+              "description": "The shop key",
+              "type": "string"
+            },
+            "secret": {
+              "description": "The shop secret",
+              "type": "string"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "domain": {
+              "description": "The shop domain",
+              "type": "string",
+              "default": "your-store.myshopify.com"
+            },
+            "token": {
+              "description": "The shop token",
+              "type": "string"
+            }
+          }
+        }
+      ]
+    }
+  },
+  "oneOf": [
+    {
+      "type": "object",
+      "$ref": "#/definitions/schema"
+    },
+    {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "$ref": "#/definitions/schema"
+      }
+    }
+  ]
+}

package/schema/syncify.package.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "syncify",
+  "version": 1.1,
+  "type": "object",
+  "properties": {
+    "syncify": {
+      "$ref": "./syncify.config.json"
+    }
+  }
+}

package/types/api.d.ts

@@ -0,0 +1,319 @@
+import { PartialDeep } from 'type-fest';
+import { Config } from './config';
+import { Asset } from './misc/requests';
+import { File } from './bundle/file';
+
+type Download = (
+  this: {
+    /**
+     * The Shopify asset resource response
+     */
+    asset: Asset
+    /**
+     * The destination directory of the asset
+     */
+    output: string;
+  },
+  /**
+   * The asset contents as Buffer.
+   *
+   * > Convert to a string using `content.toString()`
+   */
+  content: Buffer
+) => (
+  string |
+  Buffer |
+  void |
+  {
+    /**
+     * Output the asset file to a new location
+     */
+    output: string;
+    /**
+     * Updated content of the asset
+     */
+    asset?: (
+      string |
+      Buffer |
+      object |
+      void
+    )
+  }
+)
+
+type Upload = (
+  this: File,
+  /**
+   * The file contents as Buffer.
+   *
+   * > Convert to a string using `content.toString()`
+   */
+  content: Buffer
+) => (
+  string |
+  Buffer |
+  void |
+  object
+)
+
+type Watch = (
+  this: File,
+  /**
+   * The file contents as Buffer.
+   *
+   * > Convert to a string using `content.toString()`
+   */
+  content: Buffer
+) => (
+  string |
+  Buffer |
+  void |
+  object
+)
+
+type Build = (
+  this: File,
+  /**
+   * The file contents as Buffer.
+   *
+   * > Convert to a string using `content.toString()`
+   */
+  content: Buffer
+) => (
+  string |
+  Buffer |
+  void |
+  object
+)
+
+export declare interface Resources {
+  /**
+   * Download
+   *
+   * Invoked for every asset that is downloaded from
+   * store theme. Use the `this` scope to access file
+   * information.
+   */
+  download(callback: Download): void
+   /**
+   * Upload
+   *
+   * Invoked before each file is downloaded to the
+   * specified store theme. Use the `this` scope to
+   * access file information.
+   */
+  upload(callback: Upload): void
+  /**
+   * Watch
+   *
+   * Invoked each time a file changes, after the transform
+   * operation has completed but before it uploaded
+   * to the specified store theme. Use the `this` scope to
+   * access file information.
+   */
+  watch(callback: Watch): void
+  /**
+   * Build
+   *
+   * Invoked after transform operation has completed in build
+   * mode. Use the `this` scope to access file information.
+   */
+  build(callback: Build): void
+}
+
+/**
+ * Syncify Utilities
+ *
+ * A couple  of utilities which are helpful when working
+ * with external build tools or using Syncify within a script.
+ */
+export namespace utils {
+
+  /**
+   * Conditional check of the current environment.
+   */
+  export function env(env: 'dev' | 'prod'): boolean
+
+  /**
+   * Condition check of the current running resource.
+   */
+  export function resource(resource: 'watch' | 'upload' | 'download'): boolean
+
+}
+
+/**
+ * **Syncify**
+ *
+ * The function returns a function with parameter
+ * Buffer value and a `this` holding file context.
+ * You can apply modifications to the file in pipeline by
+ * returning a type `string` or `Buffer`.
+ *
+ * If you return a `boolean` value `false` syncify will not
+ * process the file. An `undefined`, `void` or `true` return value
+ * will allow the file to pass through without modification.
+ * If the file extension is `.json` you can return an `object`.
+ *
+ * @example
+ *
+ * import syncify from '@liquify/syncify'
+ *
+ * // USING CURRY
+ *
+ * // Returns a function
+ * const watch = syncify('watch', {})
+ *
+ * // Hook into the transform
+ * watch(function (content){
+ *
+ *  console.log(this) // Prints the file context to CLI
+ *  console.log(content) // Buffer of the file
+ *  console.log(content.toString()) // Convert the buffer to string
+ *
+ *  // Update the content of the file
+ *  return 'new value'
+ *
+ * })
+ *
+ * // USING INSTANCE
+ *
+ * // Create an instance
+ * const sync = syncify({})
+ *
+ * // Invoke watch mode
+ * sync.watch(function(content) {})
+ *
+ * // Invoke build mode
+ * sync.build(function(content) {})
+ *
+ * // Invoke download mode
+ * sync.download(function(content) {})
+ *
+ * // Invoke upload mode
+ * sync.upload(function(content) {})
+ *
+ * // ADDITIONAL METHODS
+ *
+ * syncify.clean()
+ * syncify.vsc()
+ * syncify.metafields()
+ * syncify.pages()
+ */
+export interface Syncify {
+  /**
+   * Download
+   *
+   * Invoked for every asset that is downloaded from
+   * store theme. Use the `this` scope to access file
+   * information.
+   */
+  (resource: 'download', options?: PartialDeep<Config>): (callback: Download) => void
+   /**
+   * Upload
+   *
+   * Invoked before each file is downloaded to the
+   * specified store theme. Use the `this` scope to
+   * access file information.
+   */
+  (resource: 'upload', options?: PartialDeep<Config>): (callback: Upload) => void
+  /**
+   * Watch
+   *
+   * Invoked each time a file changes, after the transform
+   * operation has completed but before it uploaded
+   * to the specified store theme. Use the `this` scope to
+   * access file information.
+   */
+  (resource: 'watch', options?: PartialDeep<Config>): (callback: Watch) => void
+  /**
+   * Build
+   *
+   * Invoked after transform operation has completed in build
+   * mode. Use the `this` scope to access file information.
+   */
+  (resource: 'build', options?: PartialDeep<Config>): (callback: Build) => void
+  /**
+   * Usage via instance
+   *
+   * **NOT YET AVAILABLE**
+   */
+  (options?: PartialDeep<Config>): Resources
+  /**
+   * Theme resource
+   *
+   * **NOT YET AVAILABLE**
+   */
+  themes: {
+    push(file: string, options?: any): Promise<any>;
+    pull(file: string, options?: any): Promise<any>;
+    merge(file: string, options?: any): Promise<any>;
+    delete(file: string, options?: any): Promise<any>;
+    query(file: string, options?: any): Promise<any>
+  };
+  /**
+   * Assets resource
+   *
+   * **NOT YET AVAILABLE**
+   */
+  assets: {
+    push(file: string, options?: any): Promise<any>;
+    pull(file: string, options?: any): Promise<any>;
+    merge(file: string, options?: any): Promise<any>;
+    delete(file: string, options?: any): Promise<any>;
+    query(file: string, options?: any): Promise<any>
+  };
+  /**
+   * Files resource
+   *
+   * **NOT YET AVAILABLE**
+   */
+  files: {
+    push(file: string, options?: any): Promise<any>;
+    pull(file: string, options?: any): Promise<any>;
+    merge(file: string, options?: any): Promise<any>;
+    delete(file: string, options?: any): Promise<any>;
+    query(file: string, options?: any): Promise<any>
+  };
+  /**
+   * Metafields resource
+   *
+   * **NOT YET AVAILABLE**
+   */
+  metafields: {
+    push(file: string, options?: any): Promise<any>;
+    pull(file: string, options?: any): Promise<any>;
+    merge(file: string, options?: any): Promise<any>;
+    delete(file: string, options?: any): Promise<any>;
+    query(file: string, options?: any): Promise<any>
+  };
+  /**
+   * Pages resource
+   *
+   * **NOT YET AVAILABLE**
+   */
+  pages: {
+    push(file: string, options?: any): Promise<any>;
+    pull(file: string, options?: any): Promise<any>;
+    merge(file: string, options?: any): Promise<any>;
+    delete(file: string, options?: any): Promise<any>;
+    query(file: string, options?: any): Promise<any>
+  };
+  /**
+   * Update the configuration
+   *
+   * **NOT YET AVAILABLE**
+   */
+  config(options: Config): void
+  /**
+   * Clean the output directory
+   *
+   * **NOT YET AVAILABLE**
+   */
+  clean(): Promise<void>
+  /**
+   * VS Code Schema Store generation
+   *
+   * **NOT YET AVAILABLE**
+   */
+  vsc(): Promise<void>
+}

package/types/bundle/cache.d.ts

@@ -0,0 +1,97 @@
+export interface Cache {
+  /**
+   * The last time cache was updated at (timestamp)
+   */
+  updated: number;
+  /**
+   * When the cache was created (timestamp)
+   */
+  created: number;
+  /**
+   * Page related cache records, this reference typically
+   * holds `path > id` object references. Page ids are
+   * cached for lookup when changes occur. The `map` object
+   * holds the references and applied to model on initialization.
+   */
+  pages: {
+    /**
+     * The URI cache map location
+     *
+     * @default 'node_modules/.syncify/pages'
+     */
+    uri: string;
+    /**
+     * Page output name and Buffer
+     */
+    data: { [outputName: string]: Buffer }
+  },
+   /**
+    * Section related cache records, this reference typically
+    * holds output filename reference and used to prevent
+    * duplicated sections from being written.
+    */
+  sections: string[];
+  /**
+   * JavaScript related cache records, typically source maps
+   */
+  script: {
+    /**
+     * The URI cache map location
+     *
+     * @default 'node_modules/.syncify/script'
+     */
+    uri: string;
+    /**
+     * Metafield pathname > id cache references.
+     */
+    data: { [outputName: string]: Buffer }
+  },
+  /**
+   * Stylesheet related cache records, typically source maps
+   */
+  style: {
+    /**
+     * The URI cache map location
+     *
+     * @default 'node_modules/.syncify/styles'
+     */
+    uri: string;
+    /**
+     * Stylesheet output name and Buffer
+     */
+    data: { [outputName: string]: Buffer }
+  },
+  /**
+   * 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 URI cache reference location
+     *
+     * @default 'node_modules/.syncify/metafields'
+     */
+    uri: string,
+    /**
+     * Metafield pathname > id cache references.
+     */
+    data: { [path: string]: number }
+  },
+  /**
+   * Specification JSON for vscode
+   */
+  vscode: {
+    /**
+     * The URI vscode reference location
+     *
+     * @default 'node_modules/.syncify/vscode'
+     */
+     uri: string;
+     /**
+      * vscode file maps
+      */
+     data: { icons?: string; }
+   }
+}

package/types/bundle/file.d.ts

@@ -0,0 +1,228 @@
+/* eslint-disable no-unused-vars */
+
+import { ParsedPath } from 'path';
+import { LiteralUnion } from 'type-fest';
+
+/**
+ * File types are represented as numeric values.
+ * The infer the following:
+ */
+export enum Types {
+  Template = 1,
+  Layout,
+  Snippet,
+  Section,
+  Config,
+  Locale,
+  Style,
+  Script,
+  Redirect,
+  File,
+  Svg,
+  Asset,
+  Metafield,
+  Page,
+  Spawn
+}
+
+/**
+ * File Kinds - Applied to `file.kind` context.
+ *
+ * _Used to describe of file being handled._
+ */
+export type FileKinds = LiteralUnion<
+  | 'style'
+  | 'script'
+  | 'liquid'
+  | 'json'
+  | 'image'
+  | 'svg'
+  | 'markdown'
+  | 'html'
+  | 'redirect'
+  | 'video'
+  | 'font'
+  | 'document'
+  , string
+>
+
+/**
+ * Shopify Asset Key - Applied to `file.key` context
+ *
+ *  _Used in REST API request payload_
+ */
+export type FileKeys = LiteralUnion<
+  | `templates/${string}${'.liquid' | '.json'}`
+  | `templates/customer/${string}${'.liquid' | '.json'}`
+  | `assets/${string}`
+  | `sections/${string}${'.liquid'}`
+  | `snippets/${string}${'.liquid'}`
+  | `layout/${string}${'.liquid'}`
+  | `locales/${string}${'.json'}`
+  | `config/settings_${'data' | 'schema'}${'.json'}`
+  , string
+  >
+
+/**
+ * File Namespace - Applied to `file.namespace` context
+ *
+ *  _Used in logs, reports and other logic_
+ */
+export type FileNamespaces = LiteralUnion<
+  | 'template'
+  | 'template/customer'
+  | 'snippet'
+  | 'section'
+  | 'locale'
+  | 'config'
+  | 'layout'
+  | 'asset'
+  | 'metafield'
+  | 'page'
+  | 'redirect'
+  | 'files'
+  , string
+>
+
+/**
+ * File Resource - Applied to `file.resource` context
+ *
+ * _Infers the REST API endpoint excepts for `files` which
+ * will use the insufferable Shopify GraphQL endpoint (yuck 🤮)_
+ */
+export type FileResources = LiteralUnion<
+  | 'pages'
+  | 'redirects'
+  | 'assets'
+  | 'themes'
+  | 'metafields'
+  | 'files'
+  , string
+>
+
+/**
+ * File context generated when passed to a sync
+ * resource and used to dispatch to correct transform
+ * process.
+ */
+interface File<T = any> extends ParsedPath {
+  /**
+   * The file type that was intercepted. This is an enum number value.
+   * The number value will infer on how the file should be handled.
+   *
+   * @example
+   *
+   * 1
+   */
+  type: number;
+  /**
+   * The resource endpoint to which the file will be published
+   *
+   * @example
+   *
+   * 'assets'
+   * 'redirects'
+   */
+  resource: FileResources;
+  /**
+   * The filename extension including the dot, eg: `.liquid`
+   *
+   * @example
+   *
+   * '.ext'
+   */
+  ext: string;
+  /**
+   * The input base filename including file extension.
+   *
+   * @example
+   *
+   * 'filename.ext'
+   */
+  base: string;
+  /**
+   * The input relative path location from current _root_ working directory
+   *
+   * @example
+   *
+   * 'source/views/sections/dir/file.liquid'
+   */
+  relative: string;
+  /**
+   * The `key` value will be passed into the sync request. This
+   * will contain the namespace and base name and is used for
+   * uploading to Shopify stores.
+   *
+   * @example
+   *
+   * 'sections/file.liquid'
+   * 'snippets/file.liquid'
+   * 'templates/index.liquid'
+   */
+  key: FileKeys;
+  /**
+   * The `namespace` value will typically refelect the output
+   * parent directory name reference, but sometimes this might
+   * be a unique value depending on the file type we are handling.
+   *
+   * @example
+   *
+   * 'snippets'
+   * 'sections'
+   * 'templates'
+   */
+  namespace: FileNamespaces;
+  /**
+   * The file kind grouping. This is used internally and describes
+   * the type of file we are working with.
+   *
+   * @example
+   *
+   * 'json'
+   * 'liquid'
+   * 'sass'
+   * 'css'
+   *
+   * // etc etc
+   */
+  kind: FileKinds
+  /**
+   * The chokidar passed path - this is full URI file path.
+   *
+   * @example
+   *
+   * 'User/name/project/source/dir/file.liquid'
+   */
+  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.
+   *
+   * @example
+   *
+   * // When file is theme specific
+   * 'User/name/project/theme/dir/filename.liquid'
+   *
+   * // When file is not theme specific
+   * null
+   */
+  output: string;
+  /**
+   * The file size in bytes before any augmentation is applied.
+   *
+   * @example
+   *
+   * 1024 // => 1.24kb
+   */
+  size?: number;
+  /**
+   * 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
+}