@maizzle/framework 4.8.8 → 5.0.0-beta.0

package/types/plaintext.d.ts

@@ -1,62 +1,56 @@
-import type {Opts as PlaintextOptions} from 'string-strip-html';
+import type { Opts as PlaintextOptions } from 'string-strip-html';
 
 export default interface PlaintextConfig extends PlaintextOptions {
   /**
-  Configure where plaintext files should be output.
-
-  @example
-  ```
-  module.exports = {
-    build: {
-      plaintext: {
-        destination: {
-          path: 'dist/brand/plaintext',
-          extension: 'rtxt'
-        }
-      }
-    }
-  }
-  ```
-  */
-  destination?: {
+   * 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
-    ```
-    module.exports = {
-      build: {
-        plaintext: {
-          destination: {
-            path: 'dist/brand/plaintext'
-          }
-        }
-      }
-    }
-    ```
-    */
+     * 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
-    ```
-    module.exports = {
-      build: {
-        plaintext: {
-          destination: {
-            extension: 'rtxt'
-          }
-        }
-      }
-    }
-    ```
-    */
+     * 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,128 +1,128 @@
-import type PostHTMLFetchConfig from './fetch';
+import type { Directive } from 'posthtml-parser';
 import type ExpressionsConfig from './expressions';
 
 export interface PostHTMLOptions {
   /**
-  Configure the PostHTML parser to process custom directives.
-
-  @default []
-  */
-  directives?: any[];
+   * 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
-  */
+   * 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
-  */
+   * Decode entities in the HTML.
+   *
+   * @default false
+   */
   decodeEntities?: boolean;
 
   /**
-  Output all tags in lowercase. Works only when `xmlMode` is disabled.
-
-  @default false
-  */
+   * Output all tags in lowercase. Works only when `xmlMode` is disabled.
+   *
+   * @default false
+    */
   lowerCaseTags?: boolean;
 
   /**
-  Output all attribute names in lowercase.
-
-  @default false
-  */
+   * Output all attribute names in lowercase.
+   *
+   * @default false
+   */
   lowerCaseAttributeNames?: boolean;
 
   /**
-  Recognize CDATA sections as text even if the `xmlMode` option is disabled.
-
-  @default false
-  */
+   * 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
-  */
+   * 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
-  */
+   * 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
-  */
+   * Whether attributes with no values should render exactly as they were written, without `=""` appended.
+   *
+   * @default true
+   */
   recognizeNoValueAttribute?: boolean;
 
   /**
-  Tell PostHTML to treat custom tags as self-closing.
-
-  @default []
-  */
+   * Make PostHTML to treat custom tags as self-closing.
+   *
+   * @default []
+   */
   singleTags?: string[] | RegExp[];
 
   /**
-  Define the closing format for single tags.
-
-  @default 'default'
-  */
+   * Define the closing format for single tags.
+   *
+   * @default 'default'
+   */
   closingSingleTag?: 'tag' | 'slash';
 
   /**
-  Whether to quote all attribute values.
-
-  @default true
-  */
+   * Whether to quote all attribute values.
+   *
+   * @default true
+   */
   quoteAllAttributes?: boolean;
 
   /**
-  Replaces quotes in attribute values with `&quote;`.
-
-  @default true
-  */
+   * 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")">
-  ```
-  */
+   * 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;
 }
 
@@ -138,58 +138,25 @@ export default interface PostHTMLConfig {
   options?: PostHTMLOptions;
 
   /**
-  Additional PostHTML plugins that you would like to use.
-
-  These will run last, after components.
-
-  @default []
-
-  @example
-  ```
-  const spaceless = require('posthtml-spaceless')
-  module.exports = {
-    build: {
-      posthtml: {
-        plugins: [
-          spaceless()
-        ]
-      }
-    }
-  }
-  ```
-  */
-  plugins?: any[];
-
-  /**
-  Configure the `posthtml-mso` plugin.
-  */
-  outlook?: {
+   * 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>;
     /**
-    The tag name to use for Outlook conditional comments.
-
-    @default 'outlook'
-
-    @example
-    ```
-    module.exports = {
-      build: {
-        posthtml: {
-          outlook: {
-            tag: 'mso'
-          }
-        }
-      }
-    }
-    // You now write <mso>...</mso> instead of <outlook>...</outlook>
-    ```
-    */
-    tag?: string;
-  };
-
-  /**
-  Configure the `<fetch>` tag behavior.
-
-  @default {}
-  */
-  fetch?: PostHTMLFetchConfig;
+     * Plugins to apply after Maizzle's own plugins.
+     */
+    after: Array<() => void>;
+  } | (() => void)[];
 }

package/types/render.d.ts

@@ -1,10 +1,4 @@
-import {
-  beforeRenderType,
-  afterRenderType,
-  afterTransformersType
-} from './events';
 import type Config from './config';
-import type TailwindConfig from './tailwind';
 
 export type RenderOutput = {
   /**
@@ -17,114 +11,3 @@ export type RenderOutput = {
   */
   config: Config;
 };
-
-export default interface RenderOptions {
-  /**
-  A Maizzle configuration object.
-
-  @default {}
-
-  @example
-  ```
-  const Maizzle = require('@maizzle/framework');
-
-  Maizzle
-    .render(`html string`, {
-      maizzle: {
-        inlineCSS: true,
-      }
-    })
-    .then(({html, config}) => console.log(html, config))
-  ```
-  */
-  maizzle: Config;
-
-  /**
-  Tailwind CSS configuration object.
-
-  @default {}
-
-  @example
-  ```
-  const Maizzle = require('@maizzle/framework');
-
-  Maizzle
-    .render(`html string`, {
-      tailwind: {
-        config: './tailwind-custom.config.js',
-      },
-    })
-    .then(({html, config}) => console.log(html, config))
-  ```
-   */
-  tailwind?: TailwindConfig;
-
-  /**
-  A function that runs after the Template's config has been computed, but just before it is compiled.
-
-  It exposes the Template's config, as well as the HTML.
-
-  @default undefined
-
-  @example
-  ```
-  const Maizzle = require('@maizzle/framework');
-
-  Maizzle
-    .render(`html string`, {
-      beforeRender: (html, config) => {
-        // do something with html and config
-        return html;
-      },
-    })
-    .then(({html, config}) => console.log(html, config))
-  ```
-  */
-  beforeRender?: beforeRenderType;
-
-  /**
-  A function that runs after the Template has been compiled, but before any Transformers have been applied.
-
-  Exposes the rendered html string and the Templates' config.
-
-  @default undefined
-
-  @example
-  ```
-  const Maizzle = require('@maizzle/framework');
-
-  Maizzle
-    .render(`html string`, {
-      afterRender: (html, config) => {
-        // do something with html and config
-        return html;
-      },
-    })
-    .then(({html, config}) => console.log(html, config))
-  ```
-  */
-  afterRender?: afterRenderType;
-
-  /**
-  A function that runs after all Transformers have been applied, just before the final HTML is returned.
-
-  It exposes the Template's config, as well as the HTML.
-
-  @default undefined
-
-  @example
-  ```
-  const Maizzle = require('@maizzle/framework');
-
-  Maizzle
-    .render(`html string`, {
-      afterTransformers: (html, config) => {
-        // do something with html and config
-        return html;
-      },
-    })
-    .then(({html, config}) => console.log(html, config))
-  ```
-  */
-  afterTransformers?: afterTransformersType;
-}

package/types/urlParameters.d.ts

@@ -1,27 +1,28 @@
-import type {StringifyOptions} from 'query-string';
+import type { URLParametersConfig as URLParamsConfig } from 'posthtml-url-parameters';
 
 export default interface URLParametersConfig {
-  [key: string]: any;
+  [key: string]: any; // eslint-disable-line
 
   _options?: {
     /**
-    Array of tag names to process. Only URLs inside `href` attributes of tags in this array will be processed.
-
-    @default ['a']
-
-    @example
-    ```
-    module.exports = {
-      urlParameters: {
-        _options: {
-          tags: ['a[href*="example.com"]'],
-        },
-        utm_source: 'maizzle',
-      }
-    }
-    ```
-    */
-    tags?: string[];
+     * 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.
@@ -34,6 +35,6 @@ export default interface URLParametersConfig {
     /**
     Options to pass to the `query-string` library.
     */
-    qs?: StringifyOptions;
+    qs?: URLParamsConfig['qs'];
   };
 }

package/types/widowWords.d.ts

@@ -1,3 +1,5 @@
+import type { Opts } from 'string-remove-widows';
+
 export default interface WidowWordsConfig {
   /**
   The attribute name to use.
@@ -12,45 +14,45 @@ export default interface WidowWordsConfig {
 
   @default false
   */
-  removeWindowPreventionMeasures?: boolean;
+  removeWidowPreventionMeasures?: Opts['removeWidowPreventionMeasures'];
 
   /**
   Convert the space entity to the `targetLanguage`.
 
   @default true
   */
-  convertEntities?: boolean;
+  convertEntities?: Opts['convertEntities'];
 
   /**
   Language to encode non-breaking spaces in.
 
   @default 'html'
   */
-  targetLanguage?: 'html' | 'css' | 'js';
+  targetLanguage?: Opts['targetLanguage'];
 
   /**
   Should whitespace in front of dashes (-), n-dashes (–) or m-dashes (—) be replaced with a ` `.
 
   @default true
   */
-  hyphens?: boolean;
+  hyphens?: Opts['hyphens'];
 
   /**
   The minimum amount of words in a target string, in order to trigger the transformer.
 
   @default 3
   */
-  minWordCount?: number;
+  minWordCount?: Opts['minWordCount'];
 
   /**
   The minimum amount non-whitespace characters in a target string, in order to trigger the transformer.
 
   @default 20
   */
-  minCharCount?: number;
+  minCharCount?: Opts['minCharCount'];
 
   /**
   Start/end pairs of strings that will prevent the transformer from removing widow words inside them.
   */
-  ignore?: string | string[];
+  ignore?: Opts['ignore'];
 }

package/src/functions/plaintext.js

@@ -1,5 +0,0 @@
-const Plaintext = require('../generators/plaintext')
-
-const toPlaintext = async (html, config = {}) => Plaintext.generate(html, false, config)
-
-module.exports = toPlaintext

package/src/functions/render.js

@@ -1,5 +0,0 @@
-const Output = require('../generators/output')
-
-const render = async (html, options) => Output.toString(html, options)
-
-module.exports = render