npm - @maizzle/framework - Versions diffs - 4.7.4 → 4.7.6 - Mend

@maizzle/framework 4.7.4 → 4.7.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

package/package.json +5 -3
package/src/generators/output/to-disk.js +10 -6
package/types/baseUrl.d.ts +79 -0
package/types/build.d.ts +74 -0
package/types/components.d.ts +177 -0
package/types/config.d.ts +341 -0
package/types/events.d.ts +105 -0
package/types/expressions.d.ts +78 -0
package/types/fetch.d.ts +143 -0
package/types/index.d.ts +187 -0
package/types/inlineCss.d.ts +207 -0
package/types/layouts.d.ts +39 -0
package/types/markdown.d.ts +31 -0
package/types/minify.d.ts +136 -0
package/types/plaintext.d.ts +62 -0
package/types/posthtml.d.ts +195 -0
package/types/removeUnusedCss.d.ts +115 -0
package/types/render.d.ts +130 -0
package/types/tailwind.d.ts +22 -0
package/types/templates.d.ts +167 -0
package/types/urlParameters.d.ts +39 -0
package/types/widowWords.d.ts +56 -0
package/src/index.d.ts +0 -2141

package/types/index.d.ts ADDED Viewed

@@ -0,0 +1,187 @@
+import type {AttributeToStyleSupportedAttributes} from './inlineCss';
+import type BaseURLConfig from './baseURL';
+import type Config from './config';
+import type {CoreBeautifyOptions} from 'js-beautify';
+import type InlineCSSConfig from './inlineCss';
+import type {Options as MarkdownItOptions} from 'markdown-it';
+import type MinifyConfig from './minify';
+import type PlaintextConfig from './plaintext';
+import type RenderOptions from './render';
+import type {RenderOutput} from './render';
+import type RemoveUnusedCSSConfig from './removeUnusedCss';
+import type URLParametersConfig from './urlParameters';
+import type WidowWordsConfig from './widowWords';
+declare namespace MaizzleFramework {
+  /**
+  Compile an HTML string with Maizzle.
+  @param {string} html The HTML string to render.
+  @param {RenderOptions} [options] Options to pass to the renderer.
+  */
+  function render(html: string, options?: RenderOptions): Promise<RenderOutput>;
+  /**
+  Normalize escaped character class names like `\:` or `\/` by replacing them with email-safe alternatives.
+  @param {string} html The HTML string to render.
+  @param {object} replacements Customize replacements strategy.
+   */
+  function safeClassNames(html: string, replacements: Record<string, string>): string;
+  /**
+  Compile Markdown to HTML.
+  @param {string} input String to compile with Markdown.
+  @param {Options} [options] markdown-it options.
+   */
+  function markdown(input: string, options?: MarkdownItOptions): string;
+  /**
+  Prevent widow words inside a tag by adding a `&nbsp;` between its last two words.
+  @param {string} html The HTML string to render.
+  @param {WidowWordsConfig} [options] Options to pass to the transformer.
+  */
+  function preventWidows(html: string, options?: WidowWordsConfig): string;
+  /**
+  Duplicate HTML attributes to inline CSS.
+  @param {string} html The HTML string to render.
+  @param {AttributeToStyleSupportedAttributes} [options] Options to pass to the transformer.
+  */
+  function attributeToStyle(
+    html: string,
+    options?: AttributeToStyleSupportedAttributes[]
+  ): string;
+  /**
+  Inline CSS styles from `<style>` tags found in `<head>`.
+  @param {string} html The HTML string to render.
+  @param {InlineCSSConfig} [options] Options to pass to the transformer.
+  */
+  function inlineCSS(html: string, options?: InlineCSSConfig): 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 render.
+  */
+  function shorthandCSS(html: string): string;
+  /**
+  Remove unused CSS from `<style>` tags and HTML elements.
+  @param {string} html The HTML string to use.
+  @param {RemoveUnusedCSSConfig} [options] Options to pass to the transformer.
+  */
+  function removeUnusedCSS(html: string, options?: RemoveUnusedCSSConfig): string;
+  /**
+  Automatically remove HTML attributes.
+  @param {string} html The HTML string to use.
+  @param options Either an array of attribute names, or an array of objects with `name` and `value` properties.
+  */
+  function removeAttributes(
+    html: string,
+    options?:
+    | string[]
+    | Array<{
+      name: string;
+      value: string | RegExp;
+    }>
+  ): string;
+  /**
+  Add attributes to elements in your HTML.
+  @param {string} html The HTML string to use.
+  @param {object} options Attributes to add.
+  */
+  function addAttributes(html: string, options?: Record<string, unknown>): string;
+  /**
+  Pretty print HTML code so that it's nicely indented and more human-readable.
+  @param {string} html The HTML string to prettify.
+  @param {CoreBeautifyOptions} [options] Options to pass to the prettifier.
+  */
+  function prettify(html: string, options?: CoreBeautifyOptions): string;
+  /**
+  Prepend a string to sources and hrefs in an HTML string.
+  @param {string} html The HTML string to use.
+  @param {BaseURLConfig} [options] Options to pass to the transformer.
+  */
+  function applyBaseURL(html: string, options?: string | BaseURLConfig): string;
+  /**
+  Append parameters to URLs in an HTML string.
+  @param {string} html The HTML string to use.
+  @param {URLParametersConfig} [options] Options to pass to the transformer.
+  */
+  function addURLParameters(html: string, options?: URLParametersConfig): string;
+  /**
+  Ensure that all your HEX colors inside `bgcolor` and `color` attributes are defined with six digits.
+  @param {string} html The HTML string to use.
+  */
+  function ensureSixHex(html: string): string;
+  /**
+  Minify a string of HTML code.
+  @param {string} html The HTML string to minify.
+  @param {MinifyConfig} [options] Options to pass to the minifier.
+  */
+  function minify(html: string, options?: MinifyConfig): string;
+  /**
+  Batch-replace strings in an HTML string.
+  @param {string} html The HTML string to use.
+  @param {object} replacements Strings to find and replace.
+  */
+  function replaceStrings(html: string, replacements?: Record<string, string>): string;
+  /**
+  Generate a plaintext version of an HTML string.
+  @param {string} html The HTML string to use.
+  @param {PlaintextConfig} [options] Options to pass to the plaintext generator.
+  */
+  function plaintext(html: string, options?: PlaintextConfig): Promise<{
+    html: string;
+    plaintext: string;
+    destination: string;
+  }>;
+  export {
+    Config,
+    RenderOptions,
+    // Functions
+    addAttributes,
+    addURLParameters,
+    applyBaseURL,
+    attributeToStyle,
+    ensureSixHex,
+    inlineCSS,
+    markdown,
+    minify,
+    plaintext,
+    preventWidows,
+    prettify,
+    removeAttributes,
+    removeUnusedCSS,
+    render,
+    replaceStrings,
+    safeClassNames,
+    shorthandCSS
+  };
+}
+export = MaizzleFramework;

package/types/inlineCss.d.ts ADDED Viewed

@@ -0,0 +1,207 @@
+export type AttributeToStyleSupportedAttributes =
+  | 'width'
+  | 'height'
+  | 'bgcolor'
+  | 'background'
+  | 'align'
+  | 'valign';
+export default interface InlineCSSConfig {
+  /**
+  Which CSS properties should be duplicated as what HTML attributes.
+  @default {}
+  @example
+  ```
+  module.exports = {
+    build: {
+      inlineCSS: {
+        styleToAttribute: {
+          'background-color': 'bgcolor',
+        }
+      }
+    }
+  }
+  ```
+  */
+  styleToAttribute?: Record<string, string>;
+  /**
+  Duplicate HTML attributes to inline CSS.
+  @default false
+  @example
+  ```
+  module.exports = {
+    build: {
+      inlineCSS: {
+        attributeToStyle: ['width', 'bgcolor', 'background']
+      }
+    }
+  }
+  ```
+  */
+  attributeToStyle?: boolean | AttributeToStyleSupportedAttributes[];
+  /**
+  HTML elements that will receive `width` attributes based on inline CSS width.
+  @default []
+  @example
+  ```
+  module.exports = {
+    build: {
+      inlineCSS: {
+        applyWidthAttributes: ['td', 'th']
+      }
+    }
+  }
+  ```
+  */
+  applyWidthAttributes?: string[];
+  /**
+  HTML elements that will receive `height` attributes based on inline CSS height.
+  @default []
+  @example
+  ```
+  module.exports = {
+    build: {
+      inlineCSS: {
+        applyHeightAttributes: ['td', 'th']
+      }
+    }
+  }
+  ```
+  */
+  applyHeightAttributes?: string[];
+  /**
+  List of elements that should only use `width` and `height`. Their inline CSS `width` and `height` will be removed.
+  @example
+  ```
+  module.exports = {
+    inlineCSS: {
+      keepOnlyAttributeSizes: {
+        width: ['img', 'video'],
+        height: ['img', 'video']
+      }
+    }
+  }
+  ```
+  */
+  keepOnlyAttributeSizes?: {
+    /**
+    List of elements that should only use the `width` HTML attribute (inline CSS width will be removed).
+    @default []
+    @example
+    ```
+    module.exports = {
+      inlineCSS: {
+        keepOnlyAttributeSizes: {
+          width: ['img', 'video'],
+        }
+      }
+    }
+    ```
+    */
+    width?: string[];
+    /**
+    List of elements that should only use the `height` HTML attribute (inline CSS height will be removed).
+    @default []
+    @example
+    ```
+    module.exports = {
+      inlineCSS: {
+        keepOnlyAttributeSizes: {
+          height: ['img', 'video']
+        }
+      }
+    }
+    ```
+    */
+    height?: string[];
+  };
+  /**
+  Remove inlined `background-color` CSS on elements containing a `bgcolor` HTML attribute.
+  @default false
+  @example
+  ```
+  module.exports = {
+    inlineCSS: {
+      preferBgColorAttribute: ['td'] // default: ['body', 'marquee', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr']
+    }
+  }
+  ```
+  */
+  preferBgColorAttribute?: boolean | string[];
+  /**
+  Array of CSS property names that should be excluded from the CSS inlining process. `--tw-shadow` is excluded by default.
+  @default []
+  @example
+  ```
+  module.exports = {
+    inlineCSS: {
+      excludedProperties: ['padding', 'padding-left']
+    }
+  }
+  ```
+  */
+  excludedProperties?: string[];
+  /**
+  An object where each value has a `start` and `end` to specify fenced code blocks that should be ignored during CSS inlining.
+  @default {EJS: {}, HBS: {}}
+  @example
+  ```
+  module.exports = {
+    EJS: { start: '<%', end: '%>' },
+    HBS: { start: '{{', end: '}}' },
+  }
+  ```
+  */
+  codeBlocks?: {
+    EJS?: Record<string, string>;
+    HBS?: Record<string, string>;
+  };
+  /**
+  Provide your own CSS to be inlined. Must be vanilla or pre-compiled CSS.
+  Existing `<style>` in your HTML tags will be ignored and their contents won't be inlined.
+  @default undefined
+  @example
+  ```
+  module.exports = {
+    inlineCSS: {
+      customCSS: `
+        .custom-class {
+          color: red;
+        }
+      `
+    }
+  }
+  ```
+   */
+  customCSS?: string;
+}

package/types/layouts.d.ts ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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;
+  };
+}