@treygrr/vjml 0.1.0

package/dist/types/runtime/manifest.generated.d.ts

@@ -0,0 +1,412 @@
+import type { VjmlComponentSlotKind } from '../metadata';
+export interface VjmlRuntimeComponentManifestEntry {
+    readonly tagName: string;
+    readonly componentBaseName: string;
+    readonly exportName: string;
+    readonly sourcePath: string;
+    readonly slotKind: VjmlComponentSlotKind;
+    readonly acceptsChildren: boolean;
+    readonly isLeaf: boolean;
+    readonly requiresRawContent: boolean;
+    readonly allowsArbitraryAttributes: boolean;
+    readonly propInterfaceName: string;
+}
+export declare const VJML_RUNTIME_COMPONENTS: readonly [{
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Accordion";
+    readonly exportName: "Accordion";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlAccordionProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Accordion";
+    readonly tagName: "mj-accordion";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "AccordionElement";
+    readonly exportName: "AccordionElement";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlAccordionElementProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/AccordionElement";
+    readonly tagName: "mj-accordion-element";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "AccordionText";
+    readonly exportName: "AccordionText";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlAccordionTextProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "html";
+    readonly sourcePath: "./runtime/components/AccordionText";
+    readonly tagName: "mj-accordion-text";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "AccordionTitle";
+    readonly exportName: "AccordionTitle";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlAccordionTitleProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "html";
+    readonly sourcePath: "./runtime/components/AccordionTitle";
+    readonly tagName: "mj-accordion-title";
+}, {
+    readonly acceptsChildren: false;
+    readonly allowsArbitraryAttributes: true;
+    readonly componentBaseName: "All";
+    readonly exportName: "All";
+    readonly isLeaf: true;
+    readonly propInterfaceName: "VjmlAllProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "none";
+    readonly sourcePath: "./runtime/components/All";
+    readonly tagName: "mj-all";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Attributes";
+    readonly exportName: "Attributes";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlAttributesProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Attributes";
+    readonly tagName: "mj-attributes";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Body";
+    readonly exportName: "Body";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlBodyProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Body";
+    readonly tagName: "mj-body";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Breakpoint";
+    readonly exportName: "Breakpoint";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlBreakpointProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "html";
+    readonly sourcePath: "./runtime/components/Breakpoint";
+    readonly tagName: "mj-breakpoint";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Button";
+    readonly exportName: "Button";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlButtonProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "html";
+    readonly sourcePath: "./runtime/components/Button";
+    readonly tagName: "mj-button";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Carousel";
+    readonly exportName: "Carousel";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlCarouselProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Carousel";
+    readonly tagName: "mj-carousel";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "CarouselImage";
+    readonly exportName: "CarouselImage";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlCarouselImageProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "html";
+    readonly sourcePath: "./runtime/components/CarouselImage";
+    readonly tagName: "mj-carousel-image";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: true;
+    readonly componentBaseName: "Class";
+    readonly exportName: "Class";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlClassProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Class";
+    readonly tagName: "mj-class";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Column";
+    readonly exportName: "Column";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlColumnProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Column";
+    readonly tagName: "mj-column";
+}, {
+    readonly acceptsChildren: false;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Divider";
+    readonly exportName: "Divider";
+    readonly isLeaf: true;
+    readonly propInterfaceName: "VjmlDividerProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "none";
+    readonly sourcePath: "./runtime/components/Divider";
+    readonly tagName: "mj-divider";
+}, {
+    readonly acceptsChildren: false;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Font";
+    readonly exportName: "Font";
+    readonly isLeaf: true;
+    readonly propInterfaceName: "VjmlFontProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "none";
+    readonly sourcePath: "./runtime/components/Font";
+    readonly tagName: "mj-font";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Group";
+    readonly exportName: "Group";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlGroupProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Group";
+    readonly tagName: "mj-group";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Head";
+    readonly exportName: "Head";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlHeadProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Head";
+    readonly tagName: "mj-head";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Hero";
+    readonly exportName: "Hero";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlHeroProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Hero";
+    readonly tagName: "mj-hero";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "HtmlAttribute";
+    readonly exportName: "HtmlAttribute";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlHtmlAttributeProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "text";
+    readonly sourcePath: "./runtime/components/HtmlAttribute";
+    readonly tagName: "mj-html-attribute";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "HtmlAttributes";
+    readonly exportName: "HtmlAttributes";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlHtmlAttributesProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/HtmlAttributes";
+    readonly tagName: "mj-html-attributes";
+}, {
+    readonly acceptsChildren: false;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Image";
+    readonly exportName: "Image";
+    readonly isLeaf: true;
+    readonly propInterfaceName: "VjmlImageProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "none";
+    readonly sourcePath: "./runtime/components/Image";
+    readonly tagName: "mj-image";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Mjml";
+    readonly exportName: "Mjml";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlMjmlProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Mjml";
+    readonly tagName: "mjml";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Navbar";
+    readonly exportName: "Navbar";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlNavbarProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Navbar";
+    readonly tagName: "mj-navbar";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "NavbarLink";
+    readonly exportName: "NavbarLink";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlNavbarLinkProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "html";
+    readonly sourcePath: "./runtime/components/NavbarLink";
+    readonly tagName: "mj-navbar-link";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Preview";
+    readonly exportName: "Preview";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlPreviewProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "text";
+    readonly sourcePath: "./runtime/components/Preview";
+    readonly tagName: "mj-preview";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Raw";
+    readonly exportName: "Raw";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlRawProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "html";
+    readonly sourcePath: "./runtime/components/Raw";
+    readonly tagName: "mj-raw";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Section";
+    readonly exportName: "Section";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlSectionProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Section";
+    readonly tagName: "mj-section";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Selector";
+    readonly exportName: "Selector";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlSelectorProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Selector";
+    readonly tagName: "mj-selector";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Social";
+    readonly exportName: "Social";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlSocialProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Social";
+    readonly tagName: "mj-social";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "SocialElement";
+    readonly exportName: "SocialElement";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlSocialElementProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "html";
+    readonly sourcePath: "./runtime/components/SocialElement";
+    readonly tagName: "mj-social-element";
+}, {
+    readonly acceptsChildren: false;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Spacer";
+    readonly exportName: "Spacer";
+    readonly isLeaf: true;
+    readonly propInterfaceName: "VjmlSpacerProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "none";
+    readonly sourcePath: "./runtime/components/Spacer";
+    readonly tagName: "mj-spacer";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Style";
+    readonly exportName: "Style";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlStyleProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "text";
+    readonly sourcePath: "./runtime/components/Style";
+    readonly tagName: "mj-style";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Table";
+    readonly exportName: "Table";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlTableProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "html";
+    readonly sourcePath: "./runtime/components/Table";
+    readonly tagName: "mj-table";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Text";
+    readonly exportName: "Text";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlTextProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "html";
+    readonly sourcePath: "./runtime/components/Text";
+    readonly tagName: "mj-text";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Title";
+    readonly exportName: "Title";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlTitleProps";
+    readonly requiresRawContent: true;
+    readonly slotKind: "text";
+    readonly sourcePath: "./runtime/components/Title";
+    readonly tagName: "mj-title";
+}, {
+    readonly acceptsChildren: true;
+    readonly allowsArbitraryAttributes: false;
+    readonly componentBaseName: "Wrapper";
+    readonly exportName: "Wrapper";
+    readonly isLeaf: false;
+    readonly propInterfaceName: "VjmlWrapperProps";
+    readonly requiresRawContent: false;
+    readonly slotKind: "mjml";
+    readonly sourcePath: "./runtime/components/Wrapper";
+    readonly tagName: "mj-wrapper";
+}];
+export declare const VJML_RUNTIME_COMPONENTS_BY_TAG_NAME: Readonly<Record<string, VjmlRuntimeComponentManifestEntry>>;
+export declare function getVjmlRuntimeComponentManifestEntry(tagName: string): VjmlRuntimeComponentManifestEntry | null;

package/dist/types/runtime/types.d.ts

@@ -0,0 +1 @@
+export type { RenderVjmlToHtmlOptions, VjmlDebugDocumentState, VjmlDebugNode, VjmlDebugRenderResult, VjmlFontMap, VjmlRenderMode, VjmlRenderOptions, VjmlRenderResult, VjmlRuntimeConfig, VjmlRuntimeConfigInput, VjmlValidationIssue, VjmlValidationMode, VjmlValidationSeverity, } from '../vjml';

package/dist/types/vjml.d.ts

@@ -0,0 +1,93 @@
+export type VjmlFontMap = Record<string, string>;
+export type VjmlRenderMode = 'poc' | 'strict';
+export type VjmlValidationMode = 'off' | 'warn' | 'strict';
+export type VjmlValidationSeverity = 'warning' | 'error';
+export interface VjmlValidationIssue {
+    code: string;
+    message: string;
+    severity: VjmlValidationSeverity;
+    path?: string;
+    tagName?: string;
+}
+export interface VjmlDebugElementNode {
+    type: 'element';
+    tagName: string;
+    attributes: Record<string, string>;
+    children: VjmlDebugNode[];
+}
+export interface VjmlDebugTextNode {
+    type: 'text';
+    value: string;
+}
+export interface VjmlDebugCommentNode {
+    type: 'comment';
+    value: string;
+}
+export type VjmlDebugNode = VjmlDebugCommentNode | VjmlDebugElementNode | VjmlDebugTextNode;
+export interface VjmlDebugDocumentState {
+    backgroundColor: string;
+    beforeDoctype: string[];
+    breakpoint: string;
+    classes: Record<string, Record<string, string>>;
+    classesDefault: Record<string, Record<string, string>>;
+    componentsHeadStyle: string[];
+    defaultAttributes: Record<string, Record<string, string>>;
+    dir: string;
+    fonts: VjmlFontMap;
+    forceOWADesktop: boolean;
+    headRaw: string[];
+    headStyle: Record<string, string>;
+    htmlAttributes: Record<string, Record<string, string>>;
+    inlineStyle: string[];
+    lang: string;
+    mediaQueries: Record<string, string>;
+    preview: string;
+    printerSupport: boolean;
+    style: string[];
+    title: string;
+    wrapWithDocument: boolean;
+}
+export interface VjmlRenderOptions {
+    breakpoint: string;
+    fonts: VjmlFontMap;
+    minify: boolean;
+    mode: VjmlRenderMode;
+    validation: VjmlValidationMode;
+}
+export interface VjmlRuntimeConfigInput {
+    prefix?: string;
+    render?: Partial<VjmlRenderOptions>;
+}
+export interface VjmlRuntimeConfig {
+    prefix: string;
+    render: VjmlRenderOptions;
+}
+export interface RenderVjmlToHtmlOptions {
+    props?: Record<string, unknown>;
+    runtime?: VjmlRuntimeConfigInput;
+}
+export interface VjmlRenderResult {
+    html: string;
+    warnings: string[];
+    issues: VjmlValidationIssue[];
+    config: VjmlRuntimeConfig;
+}
+export interface VjmlDebugRenderResult extends VjmlRenderResult {
+    document: VjmlDebugDocumentState;
+    tree: VjmlDebugNode[];
+}
+export declare const DEFAULT_VJML_PREFIX = "VJ";
+export declare const DEFAULT_VJML_FONTS: VjmlFontMap;
+export declare const DEFAULT_VJML_RENDER_OPTIONS: VjmlRenderOptions;
+export declare const VJML_COMPONENT_NAME_EXAMPLES: {
+    mjml: string;
+    'mj-body': string;
+    'mj-section': string;
+    'mj-text': string;
+    'mj-html-attribute': string;
+};
+export declare function toVjmlComponentBaseName(tagName: string): string;
+export declare function toVjmlComponentName(tagName: string, prefix?: string): string;
+export declare function resolveVjmlRenderOptions(options?: Partial<VjmlRenderOptions>): VjmlRenderOptions;
+export declare function mergeVjmlRuntimeConfig(base?: VjmlRuntimeConfigInput | Partial<VjmlRuntimeConfig>, overrides?: VjmlRuntimeConfigInput): VjmlRuntimeConfig;
+export declare function resolveVjmlRuntimeConfig(options?: VjmlRuntimeConfigInput): VjmlRuntimeConfig;