@samva/markup 0.8.0 → 0.9.0

package/generated/sml-language-reference.md

@@ -1,195 +0,0 @@
-# Executable email authoring reference
-
-Email entries default-export `defineEmail({ id, schema, fixtures, render })` from
-`@samva/markup/template`. Set `jsxImportSource: "@samva/markup/email"`.
-The schema accepts a Standard JSON Schema v1 converter, such as Effect's
-`Schema.toStandardJSONSchemaV1` or Zod 4. Render receives actual validated JSON.
-Return subject, optional preheader, body and optional text; omitted text is derived.
-
-Use ordinary synchronous TypeScript helpers, conditions and mapped arrays. Template identity is
-stable and unique within the project. Helper modules are excluded from the template catalog.
-Declare fixtures for each meaningful input shape; fixtures do not prove every possible branch.
-
-## Email components
-
-Import from `@samva/markup/email/components`: `Button`, `Column`, `Columns`, `Divider`, `Email`, `Image`, `Link`, `Section`, `Spacer`.
-Use supported ordinary HTML for content. Email primitives generate layout tables and Outlook
-fallbacks while preserving authoring origins. Scripts, event handlers and unsafe URLs fail.
-Strings are escaped content, never interpreted as markup.
-
-## HTML elements
-
-- `html`: flow content; attributes: `xmlns`, `xmlns:o`, `xmlns:v`, `xmlns:w`.
-- `head`: flow content; attributes: global attributes only.
-- `title`: text content; attributes: global attributes only.
-- `style`: raw content; attributes: `type`.
-- `meta`: void content; attributes: `name`, `content`, `charset`, `http-equiv`.
-- `body`: flow content; attributes: `bgcolor`.
-- `div`: flow content; attributes: `align`.
-- `section`: flow content; attributes: `align`.
-- `article`: flow content; attributes: `align`.
-- `header`: flow content; attributes: `align`.
-- `footer`: flow content; attributes: `align`.
-- `main`: flow content; attributes: `align`.
-- `center`: flow content; attributes: global attributes only.
-- `p`: flow content; attributes: `align`.
-- `blockquote`: flow content; attributes: `align`.
-- `pre`: flow content; attributes: global attributes only.
-- `h1`: flow content; attributes: `align`.
-- `h2`: flow content; attributes: `align`.
-- `h3`: flow content; attributes: `align`.
-- `h4`: flow content; attributes: `align`.
-- `h5`: flow content; attributes: `align`.
-- `h6`: flow content; attributes: `align`.
-- `span`: flow content; attributes: global attributes only.
-- `strong`: flow content; attributes: global attributes only.
-- `b`: flow content; attributes: global attributes only.
-- `em`: flow content; attributes: global attributes only.
-- `i`: flow content; attributes: global attributes only.
-- `u`: flow content; attributes: global attributes only.
-- `s`: flow content; attributes: global attributes only.
-- `small`: flow content; attributes: global attributes only.
-- `code`: flow content; attributes: global attributes only.
-- `a`: flow content; attributes: `href`, `target`, `rel`, `name`.
-- `img`: void content; attributes: `src`, `alt`, `width`, `height`, `border`, `align`.
-- `table`: flow content; attributes: `width`, `height`, `border`, `cellpadding`, `cellspacing`, `align`, `bgcolor`.
-- `caption`: flow content; attributes: `align`.
-- `colgroup`: flow content; attributes: `span`, `width`.
-- `col`: void content; attributes: `span`, `width`.
-- `thead`: flow content; attributes: `align`, `valign`, `bgcolor`.
-- `tbody`: flow content; attributes: `align`, `valign`, `bgcolor`.
-- `tfoot`: flow content; attributes: `align`, `valign`, `bgcolor`.
-- `tr`: flow content; attributes: `align`, `valign`, `bgcolor`, `height`.
-- `td`: flow content; attributes: `align`, `valign`, `width`, `height`, `bgcolor`, `colspan`, `rowspan`.
-- `th`: flow content; attributes: `align`, `valign`, `width`, `height`, `bgcolor`, `colspan`, `rowspan`.
-- `ul`: flow content; attributes: global attributes only.
-- `ol`: flow content; attributes: `start`, `type`.
-- `li`: flow content; attributes: global attributes only.
-- `br`: void content; attributes: global attributes only.
-- `hr`: void content; attributes: `width`, `size`, `align`.
-
-Global attributes: `id`, `title`, `lang`, `dir`, `role`.
-
-## CSS and assets
-
-Imported CSS follows cascade and specificity; applicable declarations inline and supported media/head rules remain.
-Uses the Tailwind compiler and discoverable source classes; dynamic classes may produce diagnostics.
-Use email layout primitives for table and Outlook fallbacks; no general flex/grid conversion.
-Imported assets are content-addressed. Delivery needs their actual HTTPS serving base; local export may use relative URLs. External HTTPS references are not fetched.
-
-## Execution and publication
-
-Isolated hosted rendering has no I/O. Clock and entropy require declared fixed runtime values; locale is en-US and timezone UTC.
-Hosted builds consume Bun text lockfile v2 or npm lockfile v3. Exact immutable publication is the default send pin; contract-latest is explicit and resolves at acceptance.
-Local preview, build and export do not require Samva credentials. Build executes named fixtures;
-export writes template/fixture HTML and text plus assets and a catalog manifest.
-
-## Quality bar
-
-- Validate all declared fixtures and inspect structured diagnostics and source origins.
-- Repair fatal compile/render failures before delivery.
-- Check representative empty, nested, repeated and conditional inputs.
-- Inspect HTML and text, light/dark styling and responsive layouts.
-- Distinguish static compatibility findings and browser previews from actual inbox evidence.
-- Keep source canonical; source edits and fixture data edits are separate operations.
-
-## Structured channels
-
-SMS and WhatsApp retain their structured channel grammar and the `@samva/markup` JSX runtime.
-
-```json
-{
-  "sms": {
-    "Sms": {
-      "attributes": {
-        "category": {
-          "type": "string",
-          "values": ["transactional", "promotional", "service_implicit"]
-        }
-      },
-      "content": "verbatim"
-    },
-    "If": {
-      "attributes": {
-        "test": {
-          "type": "string",
-          "required": true
-        }
-      },
-      "content": "verbatim-if"
-    },
-    "Else": {
-      "attributes": {},
-      "content": "verbatim"
-    }
-  },
-  "whatsapp": {
-    "WhatsApp": {
-      "attributes": {
-        "name": {
-          "type": "string"
-        },
-        "language": {
-          "type": "string"
-        },
-        "category": {
-          "type": "string",
-          "required": true,
-          "values": ["marketing", "utility", "authentication", "service"]
-        }
-      },
-      "content": "whatsapp"
-    },
-    "Header": {
-      "attributes": {
-        "type": {
-          "type": "string",
-          "values": ["text", "image", "video", "document"]
-        }
-      },
-      "content": "verbatim"
-    },
-    "Body": {
-      "attributes": {},
-      "content": "verbatim"
-    },
-    "Footer": {
-      "attributes": {},
-      "content": "verbatim"
-    },
-    "Buttons": {
-      "attributes": {},
-      "content": "buttons"
-    },
-    "Button": {
-      "attributes": {
-        "type": {
-          "type": "string",
-          "required": true,
-          "values": ["quick-reply", "url", "phone", "copy-code"]
-        },
-        "url": {
-          "type": "string"
-        },
-        "phone": {
-          "type": "string"
-        }
-      },
-      "content": "verbatim"
-    },
-    "If": {
-      "attributes": {
-        "test": {
-          "type": "string",
-          "required": true
-        }
-      },
-      "content": "verbatim-if"
-    },
-    "Else": {
-      "attributes": {},
-      "content": "verbatim"
-    }
-  }
-}
-```