@syncify/cli 0.3.0-beta → 1.0.0-alpha.1

package/types/bundle/file.d.ts

@@ -1,285 +0,0 @@
-/* eslint-disable no-unused-vars */
-
-import { LiteralUnion, Merge } from 'type-fest';
-
-/**
- * File types are represented as numeric values.
- * The infer the following:
- */
-export enum FileTypes {
-  Template = 1,
-  Layout,
-  Snippet,
-  Section,
-  Config,
-  Locale,
-  Style,
-  Script,
-  Svg,
-  Redirect,
-  File,
-  Asset,
-  Metafield,
-  Page,
-  Spawn
-}
-
-/**
- * File Kinds
- *
- * Applied to `file.kind` context. The is a text value
- * 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 and required in theme asset
- * requests. The `key` represents to the file and directory
- * structure.
- *
- * > Used in REST API request payload
- *
- * @example
- *
- * 'snippets/filename.liquid'
- *
- */
-export type FileKeys = LiteralUnion<
-  | `templates/${string}${'.liquid' | '.json'}`
-  | `templates/customer/${string}${'.liquid' | '.json'}`
-  | `assets/${string}`
-  | `sections/${string}${'.liquid' | '-group.json'}`
-  | `snippets/${string}${'.liquid'}`
-  | `layout/${string}${'.liquid'}`
-  | `locales/${string}${'.json'}`
-  | `config/settings_${'data' | 'schema'}${'.json'}`
-  , string
->
-
-/**
- * File Namespace
- *
- * Applied to `file.namespace` context. This value represents the
- * the output theme directory where a file should be written, but
- * may also represent an endpoint.
- *
- * > 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
- *
- * Applied to `file.resource` context. Infers the REST API endpoint
- * excluding `files` which will use the insufferable Shopify GraphQL endpoint.
- */
-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> {
-  /**
-   * A unique UUID reference for this file - This option can change
-   * where required and when dealing with multiple stores at the request level.
-   *
-   * @example
-   *
-   * 'ABD41WX'
-   */
-  uuid: string;
-  /**
-   * The file type that was intercepted. This is an enum number value.
-   * The number value will infer on how the file should be handled and uses
-   * the `FileType` enum for checks.
-   *
-   * @example
-   *
-   * file.type === FileType.Template
-   *
-   */
-  type: number;
-  /**
-   * The resource API endpoint to which the file will be synced.
-   * This will be passed to the request client.
-   *
-   * @example
-   *
-   * 'assets'
-   * 'redirects'
-   */
-  resource: FileResources;
-  /**
-   * The root of the file path
-   *
-   * > Value is obtained via the native `path.parse()` method
-   *
-   * @example
-   *
-   * '/' OR 'c:\'
-   */
-  root: string;
-  /**
-   * The full directory path such.
-   *
-   * > Value is obtained via the native `path.parse()` method
-   *
-   * @example
-   *
-   * '/home/user/dir' OR 'c:\path\dir'
-   */
-  dir: string;
-  /**
-   * The file name without extension (if any).
-   *
-   * > Value is obtained via the native `path.parse()` method
-   *
-   * @example
-   *
-   * 'filename' // filename.ext
-   */
-  name: string;
-  /**
-   * The filename extension including the dot, eg: `.liquid`
-   *
-   * > Value is obtained via the native `path.parse()` method
-   *
-   * @example
-   *
-   * '.ext'
-   */
-  ext: string;
-  /**
-   * The input base filename including file extension.
-   *
-   * > Value is obtained via the native `path.parse()` method
-   *
-   * @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 writes from its source (like a metafield) or
-   * if the file is handled in an asset pipeline transform then 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. This
-   * value will assigned post-context, typically in a transform.
-   *
-   * @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
-   */
-  get data(): T
-}

package/types/bundle/filters.d.ts

@@ -1,81 +0,0 @@
-export interface Filters {
-  /**
-   * Theme Asset filters
-   *
-   * @example
-   * '--filter assets/*'
-   */
-  assets?: string[];
-  /**
-   * Theme Config filters
-   *
-   * @example
-   * '--filter config/*'
-   */
-  config?: string[];
-  /**
-   * Theme Layout filters
-   *
-   * @example
-   * '--filter layout/*'
-   */
-  layout?: string[];
-  /**
-   * Theme Locales filters
-   *
-   * @example
-   * '--filter locales/*'
-   */
-  locales?: string[];
-  /**
-   * Theme Templates filters
-   *
-   * @example
-  * '--filter assets/*'
-  */
-  templates?: string[];
-  /**
-   * Theme Customers filters
-   *
-   * @example
-   * '--filter assets/*'
-   */
-  customers?: string[];
-  /**
-   * Theme Snippets filters
-   *
-   * @example
-   * '--filter snippets/*'
-   */
-  snippets?: string[];
-  /**
-   * Theme sections filters
-   *
-   * @example
-   * '--filter sections/*'
-   */
-  sections?: string[];
-  /**
-   * Store Metafields filters
-   *
-   * @example
-   * '--filter assets/*'
-   */
-  metafields?: string[];
-  /**
-   * Store pages filters
-   *
-   * @example
-   * '--filter pages/*'
-   */
-  pages?: string[];
-  /**
-   * Terse filters
-   *
-   * @example
-   * '--filter terse:script'
-   * '--filter terse:style'
-   * '--filter terse:views'
-   */
-  terse?: string[];
-}

package/types/bundle/hot.d.ts

@@ -1,185 +0,0 @@
-/* -------------------------------------------- */
-/* LIVE RELOADS                                 */
-/* -------------------------------------------- */
-
-import type { Server, WebSocket } from 'ws';
-import type { IncomingMessage } from 'http';
-
-export interface WSS {
-  /**
-   * The `wss` instance
-   */
-  get http(): Server<typeof WebSocket, typeof IncomingMessage>
-  /**
-   * Hot Socket for `<script>` tags
-   */
-  script(src: string): boolean;
-  /**
-   * Hot Socket for `<link>` stylesheet tags
-   */
-  stylesheet(href: string): boolean;
-  /**
-   * Hot Socket for theme sections
-   */
-  section(id: string): boolean;
-  /**
-   * Hot Socket SVG tags or sprites
-   */
-  svg(id: string): boolean;
-  /**
-   * Hot Socket for other asset files
-   */
-  assets(): boolean;
-  /**
-   * Hot Socket for `refresh` mode
-   */
-  reload(): boolean;
-  /**
-   * Hot Socket for view replacement
-   */
-  replace(): boolean;
-  /**
-   * Connected message
-   */
-  connected(): boolean;
-  /**
-   * Disconnect message
-   */
-  disconnect(): boolean;
-}
-
-/**
- * **INTERNAL USE**
- */
-export interface HOTBundle {
-  /**
-   * Whether or not Syncify hot reloads UI labels should render.
-   *
-   * @default true
-   */
-  label?: 'visible' | 'hidden';
-  /**
-   * **NOT YET AVAILABLE**
-   *
-   * Whether or not to record changes. When enabled, Syncify
-   * will keep track of the last 25 changes applied and allow
-   * you to walk through the stack.
-   */
-  history?: boolean;
-  /**
-   * Whether or not Syncify should inject the required HOT snippet
-   * at runtime layout/s. When `false` you will need to manually place
-   * the `hot.js.liquid` snippet into your theme.
-   *
-   * _Please note that by default when running `--hot` Syncify will
-   * check your layout/s for the hot snippet and if it's not present then
-   * syncify will inject it and invoke an upload of the layouts._
-   *
-   * @default true
-   */
-  inject?: boolean;
-  /**
-   * A string list of Liquid template layout names used in your theme
-   * which should have the hot snippet injected.
-   *
-   * @default ['theme.liquid']
-   */
-  layouts?: string[];
-  /**
-   * The static server for assets - This will be written in the HOT snippet
-   *
-   * @default 3000
-   * @example 'http://localhost:3000/some-asset.js'
-   */
-  server?: number;
-  /**
-   * Websocket port - - This will be written in the HOT snippet
-   *
-   * @default 8089
-   * @example 'ws://localhost:8089/ws'
-   */
-  socket?: number;
-  /**
-   * Which live reload method should Syncify use?
-   *
-   * **hot**
-   *
-   * _Hot reloads assets and views with automatic refresh upon changes_
-   *
-   * **refresh**
-   *
-   * _Invokes a full page refresh after changes have been applied_
-   *
-   *
-   * @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
-   *
-   * @default 'preserved'
-   */
-  scroll?: 'preserved' | 'top';
-  /**
-   * The liquid render tag written to Layouts.
-   *
-   * @default
-   * {% render 'hot.js.liquid', server: 3000, socket: 8089 %}
-   */
-  renderer?: string;
-  /**
-   * The hot reload inline snippet script URI location
-   *
-   * @default
-   * 'node_modules/@syncify/cli/hot.js.liquid'
-   */
-  snippet?: string;
-  /**
-   * The resolved output uri the snippet will be written.
-   *
-   * @default
-   * 'theme/snippets/hot.js.liquid'
-   */
-  output?: string;
-  /**
-   * Which templates contain the hot snippet. The `key` value
-   * will hold the URI output path where to file.
-   *
-   * @default true
-   */
-  alive?: { [template: string]: boolean; };
-}
-
-export type HOTConfig = Pick<HOTBundle,
-  | 'inject'
-  | 'label'
-  | 'layouts'
-  | 'method'
-  | 'strategy'
-  | 'server'
-  | 'socket'
-  | 'scroll'
->