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

package/types/css/inline.d.ts

@@ -1,218 +0,0 @@
-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
-   * ```
-   * export default {
-   *   css: {
-   *     inline: {
-   *       styleToAttribute: {
-   *         'background-color': 'bgcolor',
-   *       }
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  styleToAttribute?: Record<string, string>;
-
-  /**
-   * Duplicate HTML attributes to inline CSS.
-   *
-   * @default false
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     inline: {
-   *       attributeToStyle: ['width', 'bgcolor', 'background']
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  attributeToStyle?: boolean | AttributeToStyleSupportedAttributes[];
-
-  /**
-   * Use any CSS pixel widths to create `width` attributes on elements set in `widthElements`.
-   *
-   * @default true
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     inline: {
-   *       applyWidthAttributes: true,
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  applyWidthAttributes?: boolean;
-
-  /**
-   * Use any CSS pixel widths to create `height` attributes on elements set in `heightElements`.
-   *
-   * @default true
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     inline: {
-   *       applyHeightAttributes: true,
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  applyHeightAttributes?: boolean;
-
-  /**
-   * Prefer HTML `width` and `height` attributes over inline CSS.
-   * The inline CSS `width` and `height` will be removed.
-   *
-   * Applies to elements set in `widthElements` and `heightElements`.
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     inline: {
-   *       useAttributeSizes: true
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  useAttributeSizes?: boolean;
-
-  /**
-   * Array of CSS property names that should be excluded from the CSS inlining process.
-   *
-   * @default []
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     inline: {
-   *       excludedProperties: ['padding', 'padding-left']
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  excludedProperties?: string[];
-
-  /**
-   * Fenced code blocks that should be ignored during CSS inlining.
-   *
-   * @default
-   * {
-   *   EJS: { start: '<%', end: '%>' },
-   *   HBS: { start: '{{', end: '}}' }
-   * }
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     inline: {
-   *       codeBlocks: {
-   *         EJS: { start: '<%', end: '%>' },
-   *         HBS: { start: '{{', end: '}}' },
-   *       }
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  codeBlocks?: Record<string, { start: string; end: 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 false
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     inline: {
-   *       customCSS: `.custom-class { color: red }`
-   *     }
-   *   }
-   * }
-   * ```
-   */
-  customCSS?: string | false;
-
-  /**
-   * Remove inlined CSS selectors from the `<style>` tag.
-   *
-   * @default true
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *    inline: {
-   *      removeInlinedSelectors: true
-   *    }
-   * }
-   * ```
-   */
-  removeInlinedSelectors?: boolean;
-
-  /**
-   * Prefer unitless CSS values
-   *
-   * @default true
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     inline: {
-   *       preferUnitless: true
-   *     }
-   *   }
-   * }
-   * ```
-   */
-  preferUnitlessValues?: boolean;
-
-  /**
-   * Array of CSS selectors that should be preserved after inlining.
-   *
-   * @default [] // array of email-client targeting selectors
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     inline: {
-   *       safelist: ['.line', '.bg-red-200']
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  safelist?: string[];
-}

package/types/css/purge.d.ts

@@ -1,125 +0,0 @@
-import type { Opts } from 'email-comb';
-
-export default interface PurgeCSSConfig {
-  /**
-   * Classes or IDs that you don't want removed.
-   *
-   * @default []
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     purge: {
-   *       safelist: ['.some-class', '.Mso*', '#*'],
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  safelist?: Opts['whitelist'];
-
-  /**
-   * Start and end delimiters for computed classes that you don't want removed.
-   *
-   * @default
-   * [
-   *   {
-   *     heads: '{{',
-   *     tails: '}}',
-   *   },
-   *   {
-   *     heads: '{%',
-   *     tails: '%}',
-   *   }
-   * ]
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     purge: {
-   *       backend: [
-   *         { heads: '[[', tails: ']]' },
-   *       ]
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  backend?: Opts['backend'];
-
-  /**
-   * Whether to remove `<!-- HTML comments -->`.
-   *
-   * @default true
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     purge: {
-   *       removeHTMLComments: false,
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  removeHTMLComments?: Opts['removeHTMLComments'];
-
-  /**
-   * Whether to remove `/* CSS comments *\/`.
-   *
-   * @default true
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     purge: {
-   *       removeCSSComments: false,
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  removeCSSComments?: Opts['removeCSSComments'];
-
-  /**
-   * List of strings representing start of a conditional comment that should not be removed.
-   *
-   * @default
-   * ['[if', '[endif']
-   *
-   * @example
-   * ```
-   * export default {
-   *   css: {
-   *     purge: {
-   *       doNotRemoveHTMLCommentsWhoseOpeningTagContains: ['[if', '[endif'],
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  doNotRemoveHTMLCommentsWhoseOpeningTagContains?: Opts['doNotRemoveHTMLCommentsWhoseOpeningTagContains'];
-
-  /**
-   * 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
-   * ```
-   * export default {
-   *   css: {
-   *     purge: {
-   *       uglify: true,
-   *     }
-   *   }
-   * }
-   * ```
-  */
-  uglify?: Opts['uglify'];
-}

package/types/events.d.ts

@@ -1,153 +0,0 @@
-import type Config from "./config";
-
-export default interface Events {
-  /**
-  * Runs after the Environment config has been computed, but before Templates are processed.
-  * Exposes the `config` object so you can further customize it.
-  *
-  * @default undefined
-  *
-  * @example
-  * ```
-  * export default {
-  *   beforeCreate: async ({config}) => {
-  *     // do something with `config`
-  *   }
-  * }
-  * ```
-  */
-  beforeCreate?: (params: {
-    /**
-     * The computed Maizzle config object.
-     */
-    config: Config
-  }) => void | Promise<void>;
-
-  /**
-  * Runs after the Template's config has been computed, but just before it is compiled.
-  *
-  * Must return the `html` string, otherwise the original will be used.
-  *
-  * @default undefined
-  *
-  * @example
-  * ```
-  * export default {
-  *   beforeRender: async ({html, matter, config}) => {
-  *     // do something...
-  *     return html;
-  *   }
-  * }
-  * ```
-  */
-  beforeRender?: (params: {
-    /**
-     * The Template's HTML string.
-     */
-    html: string;
-    /**
-     * The Template's Front Matter data.
-     */
-    matter: { [key: string]: string };
-    /**
-     * The Template's computed config.
-     *
-     * This is the Environment config merged with the Template's Front Matter.
-     */
-    config: Config;
-  }) => string | Promise<string>;
-
-  /**
-  * Runs after the Template has been compiled, but before any Transformers have been applied.
-  *
-  * Must return the `html` string, otherwise the original will be used.
-  *
-  * @default undefined
-  *
-  * @example
-  * ```
-  * export default {
-  *   afterRender: async async ({html, matter, config}) => {
-  *     // do something...
-  *     return html;
-  *   }
-  * }
-  * ```
-  */
-  afterRender?: (params: {
-    /**
-     * The Template's HTML string.
-     */
-    html: string;
-    /**
-     * The Template's Front Matter data.
-     */
-    matter: { [key: string]: string };
-    /**
-     * The Template's computed config.
-     *
-     * This is the Environment config merged with the Template's Front Matter.
-     */
-    config: Config;
-  }) => string | Promise<string>;
-
-  /**
-  * Runs after all Transformers have been applied, just before the final HTML is returned.
-  *
-  * Must return the `html` string, otherwise the original will be used.
-  *
-  * @default undefined
-  *
-  * @example
-  * ```
-  * export default {
-  *   afterTransformers: async ({html, matter, config}) => {
-  *     // do something...
-  *     return html;
-  *   }
-  * }
-  * ```
-  */
-  afterTransformers?: (params: {
-    /**
-     * The Template's HTML string.
-     */
-    html: string;
-    /**
-     * The Template's Front Matter data.
-     */
-    matter: { [key: string]: string };
-    /**
-     * The Template's computed config.
-     *
-     * This is the Environment config merged with the Template's Front Matter.
-     */
-    config: Config;
-  }) => string | Promise<string>;
-
-  /**
-  * Runs after all Templates have been compiled and output to disk.
-  * `files` will contain the paths to all the files inside the `build.output.path` directory.
-  *
-  * @default undefined
-  *
-  * @example
-  * ```
-  * export default {
-  *   afterBuild: async ({config, files}) => {
-  *     // do something...
-  *   }
-  * }
-  * ```
-  */
-  afterBuild?: (params: {
-    /**
-     * The computed Maizzle config object.
-     */
-    config: Config;
-    /**
-     * An array of paths to all the files inside the `build.output.path` directory.
-     */
-    files: string[];
-  }) => string | Promise<string>;
-}