@maizzle/framework 4.7.5 → 4.7.6

package/types/layouts.d.ts

@@ -0,0 +1,39 @@
+export default interface LayoutsConfig {
+  /**
+  Encoding to be used when reading a layout file from disk.
+
+  @default 'utf8'
+  */
+  encoding?: string;
+
+  /**
+  Name of the slot tag, where the content will be injected.
+  This is typically used in a Layout file, to define the place where to inject a Template.
+
+  @default 'block'
+  */
+  slotTagName?: string;
+
+  /**
+  Name of the fill tag, inside of which content that will be injected is defined.
+  This is typically used in a Template file, to extend a Layout.
+
+  @default 'block'
+  */
+  fillTagName?: string;
+
+  /**
+  Path to the layouts folder, relative to the project root.
+
+  @default 'src/layouts'
+  */
+  root?: string;
+
+  /**
+  Tag name to be used in HTML when extending a layout.
+
+  @default 'extends'
+  */
+  tagName?: string;
+
+}

package/types/markdown.d.ts

@@ -0,0 +1,31 @@
+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?: any[];
+}

package/types/minify.d.ts

@@ -0,0 +1,136 @@
+export default interface MinifyConfig {
+  /**
+  Maximum line length. Works only when `removeLineBreaks` is `true`.
+
+  @default 500
+  */
+  lineLengthLimit?: number;
+
+  /**
+  Remove all line breaks from HTML when minifying.
+
+  @default true
+  */
+  removeLineBreaks?: boolean;
+
+  /**
+  Remove code indentation when minifying HTML.
+
+  @default true
+  */
+  removeIndentations?: boolean;
+
+  /**
+  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?: boolean | number;
+
+  /**
+  Remove CSS comments when minifying HTML.
+
+  @default true
+  */
+  removeCSSComments?: boolean;
+
+  /**
+  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?: string[] | boolean | null;
+
+  /**
+  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?: string[] | boolean | null;
+}

package/types/plaintext.d.ts

@@ -0,0 +1,62 @@
+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?: {
+    /**
+    Directory where Maizzle should output compiled Plaintext files.
+
+    @default 'build_{env}'
+
+    @example
+    ```
+    module.exports = {
+      build: {
+        plaintext: {
+          destination: {
+            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'
+          }
+        }
+      }
+    }
+    ```
+    */
+    extension: string;
+  };
+}

package/types/posthtml.d.ts

@@ -0,0 +1,195 @@
+import type PostHTMLFetchConfig from './fetch';
+import type ExpressionsConfig from './expressions';
+
+export interface PostHTMLOptions {
+  /**
+  Configure the PostHTML parser to process custom directives.
+
+  @default []
+  */
+  directives?: any[];
+
+  /**
+  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;
+
+  /**
+  Tell 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 expressions.
+  */
+  expressions?: ExpressionsConfig;
+
+  /**
+  Configure PostHTML options.
+   */
+  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?: {
+    /**
+    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;
+}

package/types/removeUnusedCss.d.ts

@@ -0,0 +1,115 @@
+export default interface RemoveUnusedCSSConfig {
+  /**
+  Classes or IDs that you don't want removed.
+
+  @default []
+
+  @example
+  ```
+  module.exports = {
+    removeUnusedCSS: {
+      whitelist: ['.some-class', '.Mso*', '#*'],
+    }
+  }
+  ```
+  */
+  whitelist?: string[];
+
+  /**
+  Start and end delimiters for computed classes that you don't want removed.
+
+  @default [{heads: '{{', tails: '}}'}, {heads: '{%', tails: '%}'}]
+
+  @example
+  ```
+  module.exports = {
+    removeUnusedCSS: {
+      backend: [
+        { heads: '[[', tails: ']]' },
+      ]
+    }
+  }
+  ```
+  */
+  backend?: Array<Record<string, string>>;
+
+  /**
+  Whether to remove `<!-- HTML comments -->`.
+
+  @default true
+
+  @example
+  ```
+  module.exports = {
+    removeUnusedCSS: {
+      removeHTMLComments: false
+    }
+  }
+  ```
+  */
+  removeHTMLComments?: boolean;
+
+  /**
+  Whether to remove `/* CSS comments *\/`.
+
+  @default true
+
+  @example
+  ```
+  module.exports = {
+    removeUnusedCSS: {
+      removeCSSComments: false
+    }
+  }
+  ```
+  */
+  removeCSSComments?: boolean;
+
+  /**
+  Whether to remove classes that have been inlined.
+
+  @default undefined
+
+  @example
+  ```
+  module.exports = {
+    removeUnusedCSS: {
+      removeInlinedSelectors: false,
+    }
+  }
+  ```
+  */
+  removeInlinedSelectors?: boolean;
+
+  /**
+  List of strings representing start of a conditional comment that should not be removed.
+
+  @default ['[if', '[endif']
+
+  @example
+  ```
+  module.exports = {
+    removeUnusedCSS: {
+      doNotRemoveHTMLCommentsWhoseOpeningTagContains: ['[if', '[endif']
+    }
+  }
+  ```
+  */
+  doNotRemoveHTMLCommentsWhoseOpeningTagContains: string[];
+
+  /**
+  Rename all classes and IDs in both your `<style>` tags and your body HTML elements, to be as few characters as possible.
+
+  @default false
+
+  @example
+  ```
+  module.exports = {
+    removeUnusedCSS: {
+      uglify: true
+    }
+  }
+  ```
+  */
+  uglify?: boolean;
+}

package/types/render.d.ts

@@ -0,0 +1,130 @@
+import {
+  beforeRenderType,
+  afterRenderType,
+  afterTransformersType
+} from './events';
+import type Config from './config';
+import type TailwindConfig from './tailwind';
+
+export type RenderOutput = {
+  /**
+  The rendered HTML.
+  */
+  html: string;
+
+  /**
+  The Maizzle configuration object.
+  */
+  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;
+}