@syncify/cli 0.1.0-beta

package/types/misc/errors.d.ts

@@ -0,0 +1,101 @@
+export type ErrorTypes = (
+  | 'request'
+  | 'syntax'
+  | 'transform'
+  | 'esbuild'
+  | 'sass'
+  | 'postcss'
+  | 'minify'
+  | 'json'
+  | 'liquid'
+  | 'shopify'
+  | 'sharp'
+  | 'svgo'
+  | 'sprite'
+  | 'resolve'
+)
+
+export interface RequestError {
+  /**
+   * An error code number - Typically used in request errors
+   *
+   * @default false
+   */
+  code?: number;
+  /**
+   * The error message to be printed
+   */
+  message: string;
+  /**
+   *
+   */
+  detail?: string;
+  /**
+   *
+   */
+  info?: string[];
+  /**
+   * The stack trace
+   */
+  stack?: string;
+  /**
+   * Additional notes or suggestions
+   */
+  notes?: string;
+}
+
+export interface Error {
+  /**
+   * The error type - This can one of many issues
+   */
+  type: ErrorTypes
+  /**
+   * An error code number - Typically used in request errors
+   *
+   * @default false
+   */
+  code?: number;
+  /**
+   * The error message to be printed
+   */
+  message: string | string[];
+  /**
+   *
+   */
+  data?: { details: string[]; line?: number }[]
+  /**
+   * Error details, typically used in request failures
+   */
+  details?: string | string[];
+  /**
+   * Whether or not to throw
+   *
+   * @default false
+   */
+  throw?: boolean;
+  /**
+   * The stack trace
+   */
+  stack?: string;
+  /**
+   * Additional notes or suggestions
+   */
+  notes?: string | string[];
+  /**
+   * The line number and column (if any)
+   */
+  location?: {
+    /**
+     * Line number
+     */
+    line: number;
+    /**
+     * Column number (ie: character)
+     */
+    column?: number;
+    /**
+     * Code sample indicating where the error occurs
+     */
+    sample?: string
+  }
+}

package/types/misc/markdown.d.ts

@@ -0,0 +1,104 @@
+/**
+ * **Markdown > HTML**
+ *
+ * Syncify uses [markdown-it](https://github.com/markdown-it/markdown-it) when
+ * converting markdown to HTML (export).
+ *
+ * **HTML > Markdown**
+ *
+ * Syncify uses [Turndown](https://github.com/mixmark-io/turndown) when
+ * converting HTML to HTML (import).
+ */
+export namespace Markdown {
+  /**
+   * Syncify uses [markdown-it](https://github.com/markdown-it/markdown-it) under
+   * the hood for transforming markdown pages into HTML. The options provided here
+   * will be passed onto markdown-it.
+   */
+  export interface Export {
+    /**
+     * Enable HTML tags in source, defaults to `true`
+     */
+    html: boolean;
+    /**
+     * // Use `/` to close single tags (<br />), defaults to `false`.
+     * This is only for full CommonMark compatibility.
+     */
+    xhtmlOut: boolean;
+    /**
+     * Convert '\n' in paragraphs into `<br>`, defaults to `true`
+     */
+    breaks: boolean;
+    /**
+     * CSS language prefix for fenced blocks. Can be useful for external
+     * highlighters, defaults to `language-`
+     */
+    langPrefix: string;
+    /**
+     * Autoconvert URL-like text to links, defaults to `false`
+     */
+    linkify: boolean;
+
+    /**
+     * Enable some language-neutral replacement + quotes beautification (defaults to `false`)
+     * For the full list of replacements, see;
+     * https://github.com/markdown-it/markdown-it/blob/master/lib/rules_core/replacements.js
+     */
+    typographer: boolean;
+    /**
+     * Double + single quotes replacement pairs, when typographer enabled,
+     * and smartquotes on. Could be either a String or an Array.
+     * For example, you can use '«»„“' for Russian, '„“‚‘' for German,
+     * and ['«\xA0', '\xA0»', '‹\xA0', '\xA0›'] for French (including nbsp).
+     */
+    quotes: string;
+  }
+
+  /**
+   * Syncify uses [Turndown](https://github.com/mixmark-io/turndown) under
+   * the hood to convert pages imported from stores into Markdown. The
+   * `language` option **MUST** be set to `markdown`.
+   */
+  export interface Import {
+    /**
+     * Heading style for conversion. This defaults to `atx`.
+     */
+    headingStyle?: 'setext' | 'atx';
+    /**
+     * Horizontal Rules, defaults to `***`
+     */
+    hr?: '***' | '---' | '___';
+    /**
+     * Bullet list markers, defaults to `-`
+     */
+    bulletListMarker?: '-' | '+' | '*'
+    /**
+     * Code blocks, defaults to `fenced`
+     */
+    codeBlockStyle?: 'indented' | 'fenced';
+    /**
+     * EM Delimiter (ie: Italic), defaults to `_`
+     */
+    emDelimiter?: '_' | '*';
+    /**
+     * Code block fence style, defaults to ```
+     */
+    fence?: '```' | '~~~' | undefined;
+    /**
+     * Strong Delimiter (ie: bold), defaults to `**`
+     */
+    strongDelimiter?: '__' | '**' | undefined;
+    /**
+     * Link style, defaults to `inlined`
+     *
+     * _Don't fuck around with this and leave it as `inlined`_
+     */
+    linkStyle?: 'inlined' | 'referenced' | undefined;
+    /**
+     * Link style reference, defaults to `full`
+     *
+     * _Don't fuck around with this and leave it as `full`_
+     */
+    linkReferenceStyle?: 'full' | 'collapsed' | 'shortcut' | undefined;
+  }
+}

package/types/misc/modes.d.ts

@@ -0,0 +1,72 @@
+import { File } from 'types/bundle';
+
+export interface BuildModeReport {
+  /**
+   * The file name that was build (including extension)
+   *
+   * @example
+   * 'index.liquid'
+   */
+  name: string;
+  /**
+   * The processing time it took to build
+   *
+   * @example
+   * '1ms'
+   */
+  time: string;
+  /**
+   * The output directory the file written.
+   *
+   * @example
+   * 'templates' // if file is something like index.json
+   */
+  output: string;
+  /**
+   * A readable error string inferring any issues which may have occured.
+   *
+   * @example
+   * 'skipped file'
+   * @default
+   * null
+   */
+  error: string;
+  /**
+   * Output size stack
+   *
+   * _Undefined if `error` exists._
+   */
+  size?: {
+    /**
+     * Before transformation, returns ansi string
+     */
+    before: string;
+    /**
+     * After transformation, returns ansi string
+     */
+    after: string;
+    /**
+     * The saving amount, returns ansi string
+     */
+    saved: string;
+    /**
+     * The gzipped size, returns ansi string
+     */
+    gzip: string;
+  }
+}
+
+export interface BuildReport {
+  /**
+   * List of files in the transform group
+   */
+  files: File[]
+  /**
+   * The amount of time the transform group took to process.
+   */
+  time: string;
+  /**
+   * The build report of each file transform
+   */
+  report: BuildModeReport[]
+}

package/types/misc/requests.d.ts

@@ -0,0 +1,287 @@
+import { AxiosRequestConfig } from 'axios';
+import { File, FileKeys } from '../bundle/file';
+
+/**
+ * Axios Request Methods
+ */
+export type Methods = 'get' | 'post' | 'put' | 'delete'
+
+/**
+ * Client Request
+ */
+export type Client = (method: Methods, file: File, content?: string) => Promise<void>
+
+/**
+ * Client Request as parameter
+ */
+export type ClientParam<T> = (method: Methods, file: File<T>, content?: string) => Promise<void>
+
+/**
+ * Resources
+ */
+export type Resource = 'build' | 'watch' | 'upload' |'download'
+
+/**
+ * Chokidor Event Names
+ */
+export type ChokidorEvents = 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir'
+
+/**
+ * Shopify theme asset paths, we use this to when re-pathing
+ * custom directories.
+ */
+export type GetAsset = (
+  `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'}`
+)
+
+/* -------------------------------------------- */
+/* ASSETS                                       */
+/* -------------------------------------------- */
+
+/**
+ * Return response for Shopify theme assets
+ */
+export interface AssetResource {
+  /**
+   * The asset path
+   */
+  key: string;
+  /**
+   * The public-facing URL of the asset.
+   */
+  public_url: string;
+  /**
+   * The date and time (ISO 8601 format) when the
+   * asset was created.
+   */
+  created_at: string;
+  /**
+   * The date and time (ISO 8601 format) when an
+   * asset was last updated.
+   */
+  updated_at: string;
+  /**
+   * The MIME representation of the content, consisting
+   * of the type and subtype of the asset.
+   */
+  content_type: string;
+  /**
+   * The asset size in bytes.
+   */
+  size: number;
+  /**
+   * The MD5 representation of the content, consisting
+   * of a string of 32 hexadecimal digits. May be null
+   * if an asset has not been updated recently.
+   */
+  checksum: string;
+  /**
+   * The ID for the theme that an asset belongs to.
+   */
+  theme_id: number;
+  /**
+   * The text content of the asset, such as the HTML
+   * and Liquid markup of a template file.
+   */
+  value?: string;
+}
+
+export interface Asset {
+  /**
+   * The asset path
+   */
+  key?: string;
+  /**
+   * Base64 Encoded File
+   */
+  attachment?: string;
+  /**
+   * Value file string
+   */
+  value?: string;
+  /**
+   * The date and time (ISO 8601 format) when the
+   * asset was created.
+   */
+  created_at?: string;
+   /**
+    * The date and time (ISO 8601 format) when an
+    * asset was last updated.
+    */
+  updated_at?: string;
+  /**
+   * The MIME representation of the content, consisting
+   * of the type and subtype of the asset.
+   */
+  content_type?: string;
+  /**
+   * The asset size in bytes.
+   */
+  size?: number;
+  /**
+   * The MD5 representation of the content, consisting of a
+   * string of 32 hexadecimal digits. May be null if an asset
+   * has not been updated recently.
+   */
+  checksum?: string;
+  /**
+   * The ID for the theme that an asset belongs to.
+   */
+  theme_id?: number;
+}
+
+export namespace Requests {
+
+  /**
+   * Return response for Shopify theme asset resources
+   */
+  export interface Assets {
+    /**
+     * The assets resource
+     */
+    assets: AssetResource[]
+  }
+
+  /**
+   * The request body for Shopify theme assets
+   */
+  export interface Asset {
+    /**
+     * The theme asset
+     */
+    asset: {
+      key: FileKeys,
+      value: string
+    }
+  }
+
+  /* -------------------------------------------- */
+  /* PAGES                                        */
+  /* -------------------------------------------- */
+
+  export interface Page {
+    author?: string;
+    body_html?: string;
+    created_at?: string;
+    handle?: string;
+    id?: number;
+    metafield?: {
+      key: string;
+      type: string;
+      value: string;
+      namespace:string;
+    },
+    published_at?:string;
+    shop_id?: number
+    template_suffix?: string;
+    title?: string;
+    updated_at?: string;
+
+  }
+  /* -------------------------------------------- */
+  /* METAFIELDS                                   */
+  /* -------------------------------------------- */
+
+  /**
+   * The request body for Shopify metafields
+   */
+  export interface Metafield {
+    /**
+     * The metafield ID
+     */
+    id?: number;
+    /**
+     * The parent directory name
+     */
+    namespace?: string;
+    /**
+     * The JSON file name with extension
+     */
+    key?: string;
+    /**
+     * The stringified JSON value
+     */
+    value?: string;
+    /**
+     * Type is JSON
+     */
+    type?: 'json';
+    /**
+     * Value Type (this is legacy but we assert it anyway)
+     */
+    value_type?: 'json_string';
+    /**
+     * Last updated date
+     */
+    updated_at?: string;
+  }
+
+  /* -------------------------------------------- */
+  /* REDIRECTS                                    */
+  /* -------------------------------------------- */
+
+  export interface Redirect {
+    /**
+     * Redirect ID
+     */
+    id?: number;
+    /**
+     * The redirect from path
+     */
+    path?: string;
+    /**
+     * The redirect to path
+     */
+    target?: string;
+  }
+
+  export interface File {
+    /**
+     * File ID
+     */
+    id?: number;
+    /**
+     * The filename
+     */
+    filename?: string;
+    /**
+     * The mimeType of the file
+     */
+    mimeType?: string;
+    /**
+     * The file content type.
+     */
+    contentType?: string;
+    /**
+     * An external URL or a signed upload URL of the file object.
+     */
+    originalSource?: string;
+  }
+}
+
+/**
+ * Extended request options passed to axios when
+ * uploading, downloading or interfacing with the Shopify
+ * API themes, metafields or other endpoints.
+ */
+export interface Request extends AxiosRequestConfig {
+  url?: string;
+  method?: Methods;
+  responseType?: 'json',
+  data?: (
+    Requests.Asset |
+    { metafield?: Requests.Metafield } |
+    { redirect?: Requests.Redirect }
+  )
+  params?: {
+    'asset[key]'?: string;
+    fields?: string
+  }
+}

package/types/misc/shared.d.ts

@@ -0,0 +1,128 @@
+import { Config } from '../config';
+
+export type Namespacing = (
+  | '[dir]'
+  | '[file]'
+  | '[ext]'
+)
+
+/**
+ * Namespaced Paths
+ */
+export type NamespacePaths = `${'assets' | 'snippets'}/${Namespacing}${string}${Namespacing}`
+
+/**
+ * Directory Paths
+ */
+export type DirPaths = `${'assets' | 'snippets'}/${string}`
+
+/**
+ * Rename Paths
+ */
+export type RenamePaths = NamespacePaths | DirPaths
+
+/**
+ * Rename input type
+ */
+export type RenameInput = {
+  [filename: string]: string | string[]
+}
+
+/**
+ * Rename input paths type
+ */
+export type RenameInputPaths = {
+  [filename: RenamePaths]: string | string[]
+}
+
+/**
+ * Rename config type
+ */
+export type RenameConfig<T> = {
+  [filename: RenamePaths]: string | string[] | T
+}
+
+/**
+ * Processor Configuration
+ */
+export type GetProcessorConfigs<T> = {
+  /**
+   * Whether or not the processor is installed
+   */
+  installed: boolean;
+  /**
+   * Whether or not the module was loaded, ie: imported.
+   * This will be `false` until the the import was loaded.
+   */
+  loaded: boolean;
+  /**
+   * Whether or not a config file exists for the processor,
+   * When one exists the URI path location to the file will
+   * applied as the value.
+   */
+  file: false | string;
+  /**
+   * Configuration of the processor, Initialized with defaults
+   */
+  config: T;
+}
+
+/**
+ * Picked `package.json` fields
+ */
+export interface Package {
+  version?: string;
+  syncify?: Config;
+  dependencies?: { [module: string]: string; };
+  devDependencies?: { [module: string]: string };
+  peerDependencies?: { [module: string]: string };
+  optionalDependencies?: { [module: string]: string };
+}
+
+export namespace ENV {
+
+  /**
+   * Auth using `key` and `secret` in `.syncifyrc` file
+   *
+   * > _Single store_
+   */
+  export interface RCSecret {
+    domain: string,
+    key: string,
+    secret: string
+  }
+
+  /**
+   *  Auth using `key` and `secret` in `.syncifyrc` File
+   *
+   *  > _Array of stores_
+   */
+  export type RCSecrets = RCSecret[]
+
+  /**
+   * Auth using `token` in `.syncifyrc` file
+   *
+   * > _Single store_
+   */
+  export interface RCToken {
+    domain: string,
+    token: string
+  }
+
+  /**
+   *  Auth using `token` in `.syncifyrc` file
+   *
+   *  > _Array of stores_
+   */
+  export type RCTokens = RCToken[]
+
+  /**
+   * Using a `.syncifyrc` file for authorizations
+   */
+  export type RCFile =
+    | RCSecret
+    | RCSecret[]
+    | RCToken
+    | RCToken[]
+
+}

package/types/transforms/image.d.ts

@@ -0,0 +1,15 @@
+import type { SharpOptions as SharpConfig } from 'sharp';
+import type { GetProcessorConfigs } from '../misc/shared';
+
+export type { SharpConfig };
+
+/* -------------------------------------------- */
+/* INTERNAL USE                                 */
+/* -------------------------------------------- */
+
+/**
+ * **INTERNAL USE**
+ *
+ * Processor Configuration
+ */
+export type SharpProcesser = GetProcessorConfigs<SharpConfig>