@maizzle/framework 6.0.0-9 → 6.0.0-rc.1

package/types/index.d.ts

@@ -1,232 +0,0 @@
-import type Config from './config';
-import type MinifyConfig from './minify';
-import type PostHTMLConfig from './posthtml';
-import type { RenderOutput } from './render';
-import type MarkdownConfig from './markdown';
-import type PurgeCSSConfig from './css/purge';
-import type PlaintextConfig from './plaintext';
-import type CSSInlineConfig from './css/inline';
-import type WidowWordsConfig from './widowWords';
-import type { BaseURLConfig } from 'posthtml-base-url';
-import type { HTMLBeautifyOptions } from 'js-beautify'
-import type { Opts as PlaintextOptions } from 'string-strip-html';
-import type { URLParametersConfig } from 'posthtml-url-parameters';
-import type { AttributeToStyleSupportedAttributes } from './css/inline';
-
-declare namespace MaizzleFramework {
-  /**
-   * Compile an HTML string with Maizzle.
-   *
-   * @param {string} html The HTML string to render.
-   * @param {Config} [config] A Maizzle configuration object.
-   * @returns {Promise<RenderOutput>} The rendered HTML and the Maizzle configuration object.
-   */
-  function render(html: string, config?: Config): Promise<RenderOutput>;
-
-  /**
-   * Normalize escaped character class names like `\:` or `\/` by replacing them with email-safe alternatives.
-   *
-   * @param {string} html The HTML string to normalize.
-   * @param {Record<string, string>} replacements A dictionary of replacements to apply.
-   * @returns {string} The normalized HTML string.
-   * @see https://maizzle.com/docs/transformers/safe-class-names
-   */
-  function safeClassNames(html: string, replacements: Record<string, string>): string;
-
-  /**
-   * Compile Markdown to HTML.
-   *
-   * @param {string} input The Markdown string to compile.
-   * @param {MarkdownConfig} [options] A configuration object for the Markdown compiler.
-   * @param {PostHTMLConfig} [posthtmlOptions] A configuration object for PostHTML.
-   * @returns {Promise<string>} The compiled HTML string.
-   * @see https://maizzle.com/docs/markdown#api
-   */
-  function markdown(input: string, options?: MarkdownConfig, posthtmlOptions?: PostHTMLConfig): Promise<string>;
-
-  /**
-   * Prevent widow words inside a tag by adding a `&nbsp;` between its last two words.
-   *
-   * @param {string} html The HTML string to process.
-   * @param {WidowWordsConfig} [options] A configuration object for the widow words transformer.
-   * @returns {string} The processed HTML string.
-   * @see https://maizzle.com/docs/transformers/widows
-   */
-  function preventWidows(html: string, options?: WidowWordsConfig): string;
-
-  /**
-   * Duplicate HTML attributes to inline CSS.
-   *
-   * @param {string} html The HTML string to process.
-   * @param {AttributeToStyleSupportedAttributes[]} attributes An array of attributes to inline.
-   * @param {PostHTMLConfig} [posthtmlConfig] A configuration object for PostHTML.
-   * @returns {string} The processed HTML string.
-   * @see https://maizzle.com/docs/transformers/attribute-to-style
-   */
-  function attributeToStyle(
-    html: string,
-    attributes: AttributeToStyleSupportedAttributes[],
-    posthtmlConfig?: PostHTMLConfig
-  ): string;
-
-  /**
-   * Inline CSS styles in an HTML string.
-   *
-   * @param {string} html The HTML string to process.
-   * @param {CSSInlineConfig} [options] A configuration object for the CSS inliner.
-   * @returns {string} The processed HTML string.
-   * @see https://maizzle.com/docs/transformers/inline-css
-   */
-  function inlineCSS(html: string, options?: CSSInlineConfig): string;
-
-  /**
-   * Rewrite longhand CSS inside style attributes with shorthand syntax.
-   * Only works with margin, padding and border, and only when all sides are specified.
-   *
-   * @param {string} html The HTML string to process.
-   * @returns {string} The processed HTML string.
-   * @see https://maizzle.com/docs/transformers/shorthand-css
-   */
-  function shorthandCSS(html: string): string;
-
-  /**
-   * Remove unused CSS from `<style>` tags and HTML elements.
-   *
-   * @param {string} html The HTML string to process.
-   * @param {PurgeCSSConfig} [options] A configuration object for `email-comb`.
-   * @returns {string} The processed HTML string.
-   * @see https://maizzle.com/docs/transformers/remove-unused-css
-   */
-  function removeUnusedCSS(html: string, options?: PurgeCSSConfig): string;
-
-  /**
-   * Remove HTML attributes from an HTML string.
-   *
-   * @param {string} html The HTML string to process.
-   * @param {string[] | Array<{ name: string; value: string | RegExp }>} [options] An array of attribute names to remove, or an array of objects with `name` and `value` properties.
-   * @returns {string} The processed HTML string.
-   * @see https://maizzle.com/docs/transformers/remove-attributes
-   */
-  function removeAttributes(
-    html: string,
-    options?:
-    | string[]
-    | Array<{
-      name: string;
-      value: string | RegExp;
-    }>
-  ): string;
-
-  /**
-   * Add attributes to elements in an HTML string.
-   *
-   * @param {string} html The HTML string to process.
-   * @param {Record<string, unknown>} [options] A dictionary of attributes to add.
-   * @returns {string} The processed HTML string.
-   * @see https://maizzle.com/docs/transformers/add-attributes
-   */
-  function addAttributes(html: string, options?: Record<string, unknown>): string;
-
-  /**
-   * Pretty-print an HTML string.
-   *
-   * @param {string} html The HTML string to prettify.
-   * @param {HTMLBeautifyOptions} [options] A configuration object for `js-beautify`.
-   * @returns {string} The prettified HTML string.
-   * @see https://maizzle.com/docs/transformers/prettify
-   */
-  function prettify(html: string, options?: HTMLBeautifyOptions): string;
-
-  /**
-   * Prepend a string to sources and hrefs in an HTML string.
-   *
-   * @param {string} html The HTML string to process.
-   * @param {string | BaseURLConfig} [options] A string to prepend to sources and hrefs, or a configuration object for `posthtml-base-url`.
-   * @returns {string} The processed HTML string.
-   * @see https://maizzle.com/docs/transformers/base-url
-   */
-  function applyBaseURL(html: string, options?: string | BaseURLConfig): string;
-
-  /**
-   * Append parameters to URLs in an HTML string.
-   *
-   * @param {string} html The HTML string to process.
-   * @param {URLParametersConfig} [options] A configuration object for `posthtml-url-parameters`.
-   * @returns {string} The processed HTML string.
-   * @see https://maizzle.com/docs/transformers/url-parameters
-   */
-  function addURLParameters(html: string, options?: URLParametersConfig): string;
-
-  /**
-   * Ensure that all HEX colors inside `bgcolor` and `color` attributes are defined with six digits.
-   *
-   * @param {string} html The HTML string to process.
-   * @returns {string} The processed HTML string.
-   * @see https://maizzle.com/docs/transformers/six-hex
-   */
-  function sixHEX(html: string): string;
-
-  /**
-   * Minify an HTML string, with email client considerations.
-   *
-   * @param {string} html The HTML string to minify.
-   * @param {MinifyConfig} [options] A configuration object for `html-minifier`.
-   * @returns {string} The minified HTML string.
-   * @see https://maizzle.com/docs/transformers/minify
-   */
-  function minify(html: string, options?: MinifyConfig): string;
-
-  /**
-   * Batch-replace strings in an HTML string.
-   *
-   * @param {string} html The HTML string to process.
-   * @param {Record<string, string>} [replacements] A dictionary of strings to replace.
-   * @returns {string} The processed HTML string.
-   * @see https://maizzle.com/docs/transformers/replace-strings
-   */
-  function replaceStrings(html: string, replacements?: Record<string, string>): string;
-
-  /**
-   * Generate a plaintext version of an HTML string.
-   * @param {string} html - The HTML string to convert to plaintext.
-   * @param {Object} [config={}] - Configuration object.
-   * @param {PostHTMLConfig} [config.posthtml] - PostHTML options.
-   * @param {PlaintextOptions} [config.strip] - Options for `string-strip-html`.
-   * @returns {Promise<string>} A string representing the HTML converted to plaintext.
-   * @see https://maizzle.com/docs/plaintext
-   */
-  function generatePlaintext(
-    html: string,
-    config?: {
-      /**
-       * Configure PostHTML options.
-       */
-      posthtml?: PostHTMLConfig
-    }
-      & PlaintextOptions,
-  ): Promise<string>;
-
-  export {
-    Config,
-    render,
-    safeClassNames,
-    markdown,
-    preventWidows,
-    attributeToStyle,
-    inlineCSS,
-    shorthandCSS,
-    removeUnusedCSS,
-    removeUnusedCSS as purgeCSS,
-    removeAttributes,
-    addAttributes,
-    prettify,
-    applyBaseURL,
-    addURLParameters as addUrlParams,
-    sixHEX,
-    minify,
-    replaceStrings,
-    generatePlaintext,
-  }
-}
-
-export = MaizzleFramework;

package/types/markdown.d.ts

@@ -1,33 +0,0 @@
-import type { Options as MarkdownItOptions } from 'markdown-it';
-
-export default interface MarkdownConfig {
-  /**
-   *  Path relative to which markdown files are imported.
-   *
-   *  @default './'
-   */
-  root?: string;
-
-  /**
-   *  Encoding for imported Markdown files.
-   *
-   *  @default 'utf8'
-   */
-  encoding?: string;
-
-  /**
-   *  Options to pass to the `markdown-it` library.
-   *
-   *  @default {}
-   */
-  markdownit?: MarkdownItOptions;
-
-  /**
-   *  Plugins for the `markdown-it` library.
-   *  @default []
-   */
-  plugins?: Array<{
-    plugin: string;
-    options: Record<string, unknown>;
-  }>;
-}

package/types/minify.d.ts

@@ -1,138 +0,0 @@
-import type { Opts } from 'html-crush';
-
-export default interface MinifyConfig {
-  /**
-   * Maximum line length. Works only when `removeLineBreaks` is `true`.
-   *
-   * @default 500
-   */
-  lineLengthLimit?: Opts['lineLengthLimit'];
-
-  /**
-   * Remove all line breaks from HTML when minifying.
-   *
-   * @default true
-   */
-  removeLineBreaks?: Opts['removeLineBreaks'];
-
-  /**
-   * Remove code indentation when minifying HTML.
-   *
-   * @default true
-  */
-  removeIndentations?: Opts['removeIndentations'];
-
-  /**
-   * Remove `<!-- HTML comments -->` when minifying HTML.
-   *
-   * `0` - don't remove any HTML comments
-   *
-   * `1` - remove all comments except Outlook conditional comments
-   *
-   * `2` - remove all comments, including Outlook conditional comments
-   *
-   * @default false
-   */
-  removeHTMLComments?: Opts['removeHTMLComments'];
-
-  /**
-   * Remove CSS comments when minifying HTML.
-   *
-   * @default true
-   */
-  removeCSSComments?: Opts['removeCSSComments'];
-
-  /**
-   * When any of given strings are encountered and `removeLineBreaks` is true, current line will be terminated.
-   *
-   * @default
-   * [
-   *   '</td',
-   *   '<html',
-   *   '</html',
-   *   '<head',
-   *   '</head',
-   *   '<meta',
-   *   '<link',
-   *   '<table',
-   *   '<script',
-   *   '</script',
-   *   '<!DOCTYPE',
-   *   '<style',
-   *   '</style',
-   *   '<title',
-   *   '<body',
-   *   '@media',
-   *   '</body',
-   *   '<!--[if',
-   *   '<!--<![endif',
-   *   '<![endif]'
-   * ]
-   */
-  breakToTheLeftOf?: Opts['breakToTheLeftOf'];
-
-  /**
-   * Some inline tags can accidentally introduce extra text.
-   * The minifier will take extra precaution when minifying around these tags.
-   *
-   * @default
-   * [
-   *   'a',
-   *   'abbr',
-   *   'acronym',
-   *   'audio',
-   *   'b',
-   *   'bdi',
-   *   'bdo',
-   *   'big',
-   *   'br',
-   *   'button',
-   *   'canvas',
-   *   'cite',
-   *   'code',
-   *   'data',
-   *   'datalist',
-   *   'del',
-   *   'dfn',
-   *   'em',
-   *   'embed',
-   *   'i',
-   *   'iframe',
-   *   'img',
-   *   'input',
-   *   'ins',
-   *   'kbd',
-   *   'label',
-   *   'map',
-   *   'mark',
-   *   'meter',
-   *   'noscript',
-   *   'object',
-   *   'output',
-   *   'picture',
-   *   'progress',
-   *   'q',
-   *   'ruby',
-   *   's',
-   *   'samp',
-   *   'script',
-   *   'select',
-   *   'slot',
-   *   'small',
-   *   'span',
-   *   'strong',
-   *   'sub',
-   *   'sup',
-   *   'svg',
-   *   'template',
-   *   'textarea',
-   *   'time',
-   *   'u',
-   *   'tt',
-   *   'var',
-   *   'video',
-   *   'wbr'
-   * ]
-   */
-  mindTheInlineTags?: Opts['mindTheInlineTags'];
-}

package/types/plaintext.d.ts

@@ -1,56 +0,0 @@
-import type { Opts as PlaintextOptions } from 'string-strip-html';
-
-export default interface PlaintextConfig extends PlaintextOptions {
-  /**
-   * Configure where plaintext files should be output.
-   *
-   * @example
-   * ```
-   * export default {
-   *   plaintext: {
-   *     output: {
-   *       path: 'dist/brand/plaintext',
-   *       extension: 'rtxt'
-   *     }
-   *   }
-   * }
-   * ```
-   */
-  output?: {
-    /**
-     * Directory where Maizzle should output compiled Plaintext files.
-     *
-     * @default 'build_{env}'
-     *
-     * @example
-     * ```
-     * export default {
-     *   plaintext: {
-     *     output: {
-     *       path: 'dist/brand/plaintext'
-     *     }
-     *   }
-     * }
-     * ```
-     */
-    path?: string;
-
-    /**
-     * File extension to be used for compiled Plaintext files.
-     *
-     * @default 'txt'
-     *
-     * @example
-     * ```
-     * export default {
-     *   plaintext: {
-     *     output: {
-     *       extension: 'rtxt'
-     *     }
-     *   }
-     * }
-     * ```
-     */
-    extension: string;
-  };
-}

package/types/posthtml.d.ts

@@ -1,162 +0,0 @@
-import type { Directive } from 'posthtml-parser';
-import type { PostHTMLExpressions } from 'posthtml-expressions';
-
-export interface PostHTMLOptions {
-  /**
-   * Configure the PostHTML parser to process custom directives.
-   *
-   * @default []
-   */
-  directives?: Directive[];
-
-  /**
-   * Enable `xmlMode` if you're using Maizzle to output XML content, and not actual HTML.
-  *
-   * @default false
-   */
-  xmlMode?: boolean;
-
-  /**
-   * Decode entities in the HTML.
-   *
-   * @default false
-   */
-  decodeEntities?: boolean;
-
-  /**
-   * Output all tags in lowercase. Works only when `xmlMode` is disabled.
-   *
-   * @default false
-    */
-  lowerCaseTags?: boolean;
-
-  /**
-   * Output all attribute names in lowercase.
-   *
-   * @default false
-   */
-  lowerCaseAttributeNames?: boolean;
-
-  /**
-   * Recognize CDATA sections as text even if the `xmlMode` option is disabled.
-   *
-   * @default false
-   */
-  recognizeCDATA?: boolean;
-
-  /**
-   * Recognize self-closing tags.
-   * Disabling this will cause rendering to stop at the first self-closing custom (non-HTML) tag.
-   *
-   * @default true
-   */
-  recognizeSelfClosing?: boolean;
-
-  /**
-   * If enabled, AST nodes will have a location property containing the `start` and `end` line and column position of the node.
-   *
-   * @default false
-   */
-  sourceLocations?: boolean;
-
-  /**
-   * Whether attributes with no values should render exactly as they were written, without `=""` appended.
-   *
-   * @default true
-   */
-  recognizeNoValueAttribute?: boolean;
-
-  /**
-   * Make PostHTML to treat custom tags as self-closing.
-   *
-   * @default []
-   */
-  singleTags?: string[] | RegExp[];
-
-  /**
-   * Define the closing format for single tags.
-   *
-   * @default 'default'
-   */
-  closingSingleTag?: 'tag' | 'slash';
-
-  /**
-   * Whether to quote all attribute values.
-   *
-   * @default true
-   */
-  quoteAllAttributes?: boolean;
-
-  /**
-   * Replaces quotes in attribute values with `&quote;`.
-   *
-   * @default true
-   */
-  replaceQuote?: boolean;
-
-  /**
-   * Specify the style of quote around the attribute values.
-   *
-   * @default 2
-   *
-   * @example
-   *
-   * `0` - Quote style is based on attribute values (an alternative for `replaceQuote` option)
-   *
-   *  ```
-   *  <img src="example.jpg" onload='testFunc("test")'>
-   *  ```
-   *
-   *  @example
-   *
-   *  `1` - Attribute values are wrapped in single quotes
-   *
-   *  ```
-   *  <img src='example.jpg' onload='testFunc("test")'>
-   *  ```
-   *
-   *  @example
-   *
-   *  `2` - Attribute values are wrapped in double quotes
-   *
-   *  ```
-   *  <img src="example.jpg" onload="testFunc("test")">
-   *  ```
-   */
-  quoteStyle?: 0 | 1 | 2;
-}
-
-export default interface PostHTMLConfig {
-  /**
-  Configure [posthtml-expressions](https://github.com/posthtml/posthtml-expressions) options.
-  */
-  expressions?: PostHTMLExpressions;
-
-  /**
-  Configure PostHTML options.
-   */
-  options?: PostHTMLOptions;
-
-  /**
-   * PostHTML plugins to apply before or after Maizzle's own plugins.
-   *
-   * @example
-   * ```
-   * import spaceless from 'posthtml-spaceless'
-   * export default {
-   *   posthtml: {
-   *     plugins: [
-   *       spaceless()
-   *     ]
-   *   }
-   * }
-   * ```
-   */
-  plugins?: {
-    before: Array<() => void>;
-    /**
-     * Plugins to apply after Maizzle's own plugins.
-     */
-    after: Array<() => void>;
-  } | (() => void)[];
-}

package/types/render.d.ts

@@ -1,13 +0,0 @@
-import type Config from './config';
-
-export type RenderOutput = {
-  /**
-  The rendered HTML.
-  */
-  html: string;
-
-  /**
-  The Maizzle configuration object.
-  */
-  config: Config;
-};

package/types/urlParameters.d.ts

@@ -1,40 +0,0 @@
-import type { URLParametersConfig as URLParamsConfig } from 'posthtml-url-parameters';
-
-export default interface URLParametersConfig {
-  [key: string]: any;
-
-  _options?: {
-    /**
-     * Array of tag names to process. Only URLs inside `href` attributes
-     * of tags in this array will be processed.
-     *
-     * @default ['a']
-     *
-     * @example
-     * ```
-     * export default {
-     *   urlParameters: {
-     *     _options: {
-     *       tags: ['a[href*="example.com"]'],
-     *     },
-     *     utm_source: 'maizzle',
-     *   }
-     * }
-     * ```
-     */
-    tags?: URLParamsConfig['tags'];
-
-    /**
-    By default, query parameters are appended only to valid URLs.
-    Disable strict mode to append parameters to any string.
-
-    @default true
-    */
-    strict?: boolean;
-
-    /**
-    Options to pass to the `query-string` library.
-    */
-    qs?: URLParamsConfig['qs'];
-  };
-}