@syncify/cli 0.3.0-beta → 1.0.0-unstable.0

package/types/bundle/processors.d.ts

@@ -1,54 +0,0 @@
-import type { JSONConfig } from '../transforms/json';
-import type { SharpConfig } from '../transforms/image';
-import type { BuildOptions } from 'esbuild';
-import type { SASSConfig, PostCSSConfig } from '../transforms/style';
-import type { SVGOConfig, SVGSpriteConfig } from '../transforms/svg';
-
-/**
- * **Internal Use**
- *
- * Processor Default Configurations
- *
- * Holds reference to default config options for
- * each supported processor.
- */
-export interface ProcessorsBundle {
-  /**
-   * JSON File processing - Options defined here are used when
-   * writing to the file system. Typically in operations like
-   * `--merge`, `--pull` and `--download`.
-   *
-   * > The options will also be used in **development** (`dev`)
-   * mode when uploading `.json` files to stores/themes.
-   */
-  json?: JSONConfig;
-  /**
-   * [ESBuild](https://esbuild.github.io/) Config
-   *
-   * Syncify uses ESBuild under the hood for JS/TS transpilation.
-   * Some native ESBuild options are omitted from processing and
-   * handled internally by Syncify.
-   */
-  esbuild?: BuildOptions;
-  /**
-   * [PostCSS](https://postcss.org/) Plugins
-   */
-  postcss?: PostCSSConfig[]
-  /**
-   * [SASS Dart](https://sass-lang.com/documentation/js-api/) Config
-   */
-  sass?: SASSConfig
-  /**
-   * [Sharp](https://sharp.pixelplumbing.com) Config
-   */
-  sharp?: SharpConfig;
-  /**
-   * [SVGO](https://github.com/svg/svgo) Config
-   *
-   */
-  svgo?: SVGOConfig;
-  /**
-   * [SVG Sprite](https://github.com/svg-sprite) Config
-   */
-  sprite?: SVGSpriteConfig
-}

package/types/bundle/reports.d.ts

@@ -1,123 +0,0 @@
-import { File } from './file';
-
-export interface UploadModeReport {
-  /**
-   * The file name that was build (including extension)
-   *
-   * @example
-   * 'index.liquid'
-   */
-  name: string;
-  /**
-   * The upload time for this specific file
-   *
-   * @example
-   * '1ms'
-   */
-  time: string;
-  /**
-   * The upload error (if occurred)
-   *
-   * @default
-   * null
-   */
-  error: any;
-}
-
-export interface UploadReport {
-  /**
-   * List of files in the upload group
-   */
-  files: File[];
-  /**
-   * The amount of time the group took to upload
-   */
-  time: string;
-  /**
-   * The upload report for each file handled
-   */
-  report: UploadModeReport[]
-}
-
-/* -------------------------------------------- */
-/* BUILD MODE REPORTING                         */
-/* -------------------------------------------- */
-
-export interface BuildModeReport {
-  /**
-   * The file name that was build (including extension)
-   *
-   * @example
-   * 'index.liquid'
-   */
-  name: string;
-  /**
-   * The relative input path of the file
-   *
-   * @example
-   * 'src/template/index.liquid'
-   */
-  input: string;
-  /**
-   * The relative output directory path of the file
-   *
-   * @example
-   * 'templates/index.liquid'
-   */
-   output: string;
-  /**
-   * The processing time it took to build
-   *
-   * @example
-   * '1ms'
-   */
-  time: 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/bundle/requests.d.ts

@@ -1,374 +0,0 @@
-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
- */
-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 = any> = (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'}` |
-  `templates/metaobject/${string}${'.liquid' | '.json'}` |
-  `assets/${string}` |
-  `sections/${string}${'-group.json' | '.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 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 {
-
-  /**
-   * 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,
-      attachment?: string;
-    }
-  }
-
-  /* -------------------------------------------- */
-  /* PAGES                                        */
-  /* -------------------------------------------- */
-
-  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;
-    /**
-     * 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;
-    /**
-     * 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                                   */
-  /* -------------------------------------------- */
-
-  /**
-   * 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?: MetafieldTypes;
-    /**
-     * 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/bundle/shared.d.ts

@@ -1,124 +0,0 @@
-import { Config } from '../config';
-
-export type Namespacing = (
-  | '[dir]'
-  | '[file]'
-  | '[ext]'
-)
-
-/**
- * Namespaced Paths
- */
-export type NamespacePaths = `${'assets' | 'snippets'}/${string}`
-
-/**
- * Directory Paths
- */
-export type DirPaths = `${'assets' | 'snippets'}/${string}`
-
-/**
- * Rename Paths
- */
-export type RenamePaths = NamespacePaths;
-
-/**
- * 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
-   * be applied as the value.
-   */
-  file: boolean | 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 `.env.syncify.json` 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[]
-
-}